TRANS(1)

💖 TRANS(1) — the translate-shell glow-up 💖

ok so bestie. welcome to trans, the command-line translator that literally speaks every language. it's from the translate-shell manual (section 1, iykyk), and it's giving main character energy in your terminal. 🦋

---

✨ NAME ✨

trans — your command-line translator, slaying via Google Translate, Bing Translator, Yandex.Translate, etc. no cap. 🌈

---

✨ SYNOPSIS ✨

trans [OPTIONS] [SOURCE]:[TARGETS] [TEXT]...

---

✨ DESCRIPTION ✨

okay so. this tool translates text into literally any language, straight from the command line, using a translation engine like Google Translate, Bing Translator and Yandex.Translate. it's giving polyglot. 💅

every argument that isn't a valid option? that's treated as TEXT to be translated. periodt.

and if neither TEXT nor the input file is specified by command-line arguments, the program will read and translate from standard input. it just knows. 🔮

---

✨ OPTIONS ✨

🌸 Information options 🌸

• -V, -version — print version and exit. quick lil flex. ✨
• -H, -help — print help message and exit. 🫶
• -M, -man — show man page and exit. (hi, that's literally this one 🎀)
• -T, -reference — print reference table of all supported languages and codes, and exit. Names of languages are displayed in their endonyms (language name in the language itself). so fancy. 👑
• -R, -reference-english — same reference table energy, all supported languages and codes, and exit. but this time names of languages are displayed in English. 🇬🇧
• -S, -list-engines — list available translation engines and exit. 🔥
• -list-languages — list all supported languages (in endonyms) and exit. 🌍
• -list-languages-english — list all supported languages (in English names) and exit. 🌎
• -list-codes — list all supported codes and exit. 🔢
• -list-all — list all supported languages (endonyms and English names) and codes, and exit. the whole buffet. 🍓
• -L CODES, -linguist CODES — print details of languages and exit. When specifying two or more language codes, concatenate them by plus sign "+". 🧚
• -U, -upgrade — check for upgrade of this program. glow-up check. 💅

🌸 Translator options 🌸

• -e ENGINE, -engine ENGINE — specify the translation engine to use. (default: auto)

🌸 Display options 🌸

• -verbose — verbose mode.

Show the original text and its most relevant translation, then its phonetic notation (if any), then its alternative translations (if any) or its definition in the dictionary (if it is a word).

This option is unnecessary in most cases since verbose mode is enabled by default. so it's lowkey just vibing already. 🙈

• -b, -brief — brief mode.

Show the most relevant translation or its phonetic notation only. short & sweet. ✨

• -d, -dictionary — dictionary mode.

Show the definition of the original word in the dictionary. 📖

• -identify — language identification.

Show the identified language of the original text. detective era. 🔍

• -show-original Y/n — show original text or not. (default: yes)
• -show-original-phonetics Y/n — show phonetic notation of original text or not. (default: yes)
• -show-translation Y/n — show translation or not. (default: yes)
• -show-translation-phonetics Y/n — show phonetic notation of translation or not. (default: yes)
• -show-prompt-message Y/n — show prompt message or not. (default: yes)
• -show-languages Y/n — show source and target languages or not. (default: yes)
• -show-original-dictionary y/N — show dictionary entry of original text or not. (default: no)

This option is enabled in dictionary mode.

• -show-dictionary Y/n — show dictionary entry of translation or not. (default: yes)
• -show-alternatives Y/n — show alternative translations or not. (default: yes)
• -w NUM, -width NUM — specify the screen width for padding.

This option overrides the setting of environment variable $COLUMNS.

• -indent NUM — specify the size of indent (number of spaces). (default: 4)
• -theme FILENAME — specify the theme to use. (default: default)
• -no-theme — do not use any other theme than default.
• -no-ansi — do not use ANSI escape codes.
• -no-autocorrect — do not autocorrect. (if defaulted by the translation engine)
• -no-bidi — do not convert bidirectional texts.
• -bidi — always convert bidirectional texts.
• -no-warn — do not write warning messages to stderr.
• -dump — print raw API response instead. the raw tea. ☕

🌸 Audio options 🌸

• -p, -play — listen to the translation. 🔊

You must have at least one of the supported audio players (mplayer, mpv or mpg123) installed to stream from Google Text-to-Speech engine. Otherwise, a local speech synthesizer may be used instead (say on macOS, espeak on Linux or other platforms).

• -speak — listen to the original text.
• -n VOICE, -narrator VOICE — specify the narrator, and listen to the translation.

Common values for this option are male and female.

• -player PROGRAM — specify the audio player to use, and listen to the translation.

Option -play will try to use mplayer, mpv or mpg123 by default, since these players are known to work for streaming URLs. Not all command-line audio players can work this way. Use this option only when you have your own preference.

This option overrides the setting of environment variable $PLAYER.

• -no-play — do not listen to the translation.
• -no-translate — do not translate anything when using -speak.
• -download-audio — download the audio to the current directory.
• -download-audio-as FILENAME — download the audio to the specified file.

🌸 Terminal paging and browsing options 🌸

• -v, -view — view the translation in a terminal pager (less, more or most).
• -pager PROGRAM — specify the terminal pager to use, and view the translation.

This option overrides the setting of environment variable $PAGER.

• -no-view, -no-pager — do not view the translation in a terminal pager.
• -browser PROGRAM — specify the web browser to use.

This option overrides the setting of environment variable $BROWSER.

• -no-browser — do not open the web browser.

🌸 Networking options 🌸

• -x HOST:PORT, -proxy HOST:PORT — use HTTP proxy on given port.

This option overrides the setting of environment variables $HTTP_PROXY and $http_proxy.

• -u STRING, -user-agent STRING — specify the User-Agent to identify as.

This option overrides the setting of environment variables $USER_AGENT.

• -4, -ipv4, -inet4-only — connect only to IPv4 addresses.
• -6, -ipv6, -inet6-only — connect only to IPv6 addresses.

🌸 Interactive shell options 🌸

• -I, -interactive, -shell — start an interactive shell, invoking rlwrap whenever possible (unless -no-rlwrap is specified).
• -E, -emacs — start the GNU Emacs front-end for an interactive shell.

This option does not need to, and cannot be used along with -I or -no-rlwrap.

• -no-rlwrap — do not invoke rlwrap when starting an interactive shell.

This option is useful when your terminal type is not supported by rlwrap (e.g. emacs).

🌸 I/O options 🌸

• -i FILENAME, -input FILENAME — specify the input file.

Source text to be translated will be read from the input file, instead of standard input.

• -o FILENAME, -output FILENAME — specify the output file.

Translations will be written to the output file, instead of standard output.

🌸 Language preference options 🌸

• -hl CODE, -host CODE — specify your home language (the language you would like to see for displaying prompt messages in the translation).

This option affects only the display in verbose mode (anything other than source language and target language will be displayed in your home language). This option has no effect in brief mode.

This option is optional. When its setting is omitted, English will be used.

This option overrides the setting of environment variables $LC_ALL, $LANG, and $HOST_LANG.

• -s CODES, -sl CODES, -source CODES, -from CODES — specify the source language(s) (the language(s) of original text). When specifying two or more language codes, concatenate them by plus sign "+".

This option is optional. When its setting is omitted, the language of original text will be identified automatically (with a possibility of misidentification).

This option overrides the setting of environment variable $SOURCE_LANG.

• -t CODES, -tl CODES, -target CODES, -to CODES — specify the target language(s) (the language(s) of translated text). When specifying two or more language codes, concatenate them by plus sign "+".

This option is optional. When its setting is omitted, everything will be translated into English.

This option overrides the setting of environment variables $LC_ALL, $LANG, and $TARGET_LANG.

• [SOURCE]:[TARGETS] — a simpler, alternative way to specify the source language and target language(s) is to use a shortcut formatted string:
  • SOURCE-CODE:TARGET-CODE
  • SOURCE-CODE:TARGET-CODE1+TARGET-CODE2+...
  • SOURCE-CODE=TARGET-CODE
  • SOURCE-CODE=TARGET-CODE1+TARGET-CODE2+...

Delimiter ":" and "=" can be used interchangeably.

Either SOURCE or TARGETS may be omitted, but the delimiter character must be kept.

🌸 Text preprocessing options 🌸

• -j, -join-sentence — treat all arguments as one single sentence. glue them together fr fr. 🫶

🌸 Other options 🌸

• -no-init — do not load any initialization script.
• -- — end-of-options.

All arguments after this option are treated as TEXT to be translated.

---

✨ EXIT STATUS ✨

• 0 — successful translation. we ate. 💅
• 1 — error. 😭

---

✨ ENVIRONMENT ✨

• PAGER — equivalent to option setting -pager.
• BROWSER — equivalent to option setting -browser.
• PLAYER — equivalent to option setting -player.
• HTTP_PROXY — equivalent to option setting -proxy.
• USER_AGENT — equivalent to option setting -user-agent.
• HOST_LANG — equivalent to option setting -host.
• SOURCE_LANG — equivalent to option setting -source.
• TARGET_LANG — equivalent to option setting -target.

---

✨ FILES ✨

• /etc/translate-shell — initialization script. (system-wide) 🏠
• $HOME/.translate-shell/init.trans — initialization script. (user-specific)
• $XDG_CONFIG_HOME/translate-shell/init.trans — initialization script. (user-specific)
• ./.trans — initialization script. (current directory)

---

to be continued bestie… part 2 is coming 💜

💖 FURTHER DOCUMENTATION 💖

ok so you want more? valid. the wiki is right there and it's lowkey a whole vibe:

<https://github.com/soimort/translate-shell/wiki>

go read it bestie, it's giving "extra credit but make it cute" 🦋

---

🫶 REPORTING BUGS 🫶

found something broken? not me being dramatic but pls tell them. the issue tracker is literally right here:

<https://github.com/soimort/translate-shell/issues>

no gatekeeping, no "it's probably just me" — if it's weird, report it. the maintainers wanna know fr fr 🐛✨

---

👑 AUTHORS 👑

Mort Yao <soi@mort.ninja>.

that's the main character right there. show some respect 💅🌸

---

and that's the whole page, bestie!! 🎀

just so you know what you're reading: this is TRANS(1), version 0.9.7.1, dated 2023-02-08. go translate something iconic. iykyk 🌈⭐💜

bye babes!! 🦋✨