HIME-SETUP(1)

✨ NAME ✨

hime-setup — the configuration tools of hime 💖 (this whole page lives in the hime input method platform manual, bestie, so you know exactly where you are 🫶)

---

🎀 SYNOPSIS 🎀

hime-setup

---

🌸 DESCRIPTION 🌸

Okay so hime-setup is the default configuration tool of hime. Periodt. 💅

The other way to configure stuff is by writing conffiles into $HOME/.config/hime/config. Lowkey that's the manual route, and if that's your vibe, go peek at the CONFFILES section below for the whole tea. ☕✨

---

🦋 CONFFILES 🦋

All the conffiles listed down there get created automatically by hime-setup — except for hime-bell-volume and hime-sound-play-overlap, which do not get auto-made, so don't @ me if they're missing 🙈.

If you wanna write conffiles yourself (main character energy, honestly), first make sure you actually have the config directory:

mkdir -p $HOME/.config/hime/config

Once that exists, you can go ahead and try something like:

echo zo > $HOME/.config/hime/config/phonetic-keyboard

And boom 💥 — that makes a phonetic-keyboard file with its content zo, which means you selected the standard style with the 1234 selection method. Slay.

All available conffiles are listed below, and the default options are showed bold.

---

$HOME/.config/hime/config/default-input-method number — default input method when hime is called.

• 1 — Chanjei input method, version 3
• 2 — Chanjei input method, version 5
• 3 — Bopomofo input method
• 4 — Symbols virtual keyboard
• 5 — Pinyin input method
• 6 — Tsin intelligent Bopomofo input method
• 7 — Dayi input method
• 8 — Array input method, 30 keys version
• 9 — Boshiamy input method, aka Liu's input method
• 10 — Direct input for UTF-32 (U+) or Big-5 characters
• 11 — Simple Chanjei input method
• 12 — Japanese anthy input method
• 13 — Greek letters input method
• 14 — Latin letters input method
• 15 — Jyutping input method

---

$HOME/.config/hime/config/hime-bell-volume number — volume of bell ring, between -100 to 100. Default is -97. 🔔

---

$HOME/.config/hime/config/hime-capslock-lower boolean — input lower-case letters when Caps Lock key is ON.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/hime-eng-phrase-enabled boolean — enable Alt-Shift phrases in alphabet-numeric mode.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/hime-font-name string — default font.

• sans — Sans-serif
• serif — Serif

---

$HOME/.config/hime/config/hime-font-size number — font size of character-selection area. Default is 16.

---

$HOME/.config/hime/config/hime-font-size-gtab-in number — font size of key codes input area in gtab input methods (Chanjei IM, Array IM, etc.). Default is 10.

---

$HOME/.config/hime/config/hime-font-size-pho-near number — font size of similar-phonetic character selection in Tsin IM. Default is 14.

---

$HOME/.config/hime/config/hime-font-size-symbol number — font size of symbol-selection window. Default is 12.

---

$HOME/.config/hime/config/hime-font-size-tsin-pho-in number — font size of phonetic input area in Bopomofo and Tsin IM. Default is 10.

---

$HOME/.config/hime/config/hime-font-size-tsin-presel number — font size of phrase pre-selection window in Tsin IM. Default is 16.

---

$HOME/.config/hime/config/hime-im-toggle-keys number — toggle Key for IM window ON/OFF.

• 0 — Control-Space
• 1 — Shift-Space
• 2 — Alt-Space
• 3 — Windows-Space

---

$HOME/.config/hime/config/hime-init-im-enabled boolean — enable input method mode without pressing toggle keys. 🚨 Heads up: this option is not available in XIM mode.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/hime-inner-frame boolean — show frame border in hime window.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/hime-input-style number — window style of hime.

• 1 — OverTheSpot (Follow the cursor)
• 2 — Root (Fixed index window)

---

$HOME/.config/hime/config/hime-pop-up-win boolean — dynamic pop up window.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/hime-remote-client boolean — use hime in remote applications.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/hime-root-x number — window position in X-axis when window style is Root (Fixed index window). Default is 1600.

---

$HOME/.config/hime/config/hime-root-y number — window position in Y-axis when window style is Root (Fixed index window). Default is 1200.

---

$HOME/.config/hime/config/hime-sel-key-color hex — color of selection Key.

• #FF0000 — Red
• #00FF00 — Green
• #0000FF — Blue
• #FFFF00 — Yellow
• #FF00FF — Magenta
• #00FFFF — Cyan

---

$HOME/.config/hime/config/hime-shift-space-eng-full boolean — toggle to double-wide English character mode with Shift-Space.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/hime-sound-play-overlap boolean — play all sound when text-to-speech is enabled.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/hime-status-tray boolean — show hime status in system tray.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/hime-win-color-bg hex — background color of hime window. Default is #005BFF.

---

$HOME/.config/hime/config/hime-win-color-fg hex — foreground color of hime window.

• #FF0000 — Red
• #00FF00 — Green
• #0000FF — Blue
• #FFFF00 — Yellow
• #FF00FF — Magenta
• #FFFFFF — White

---

$HOME/.config/hime/config/hime-win-color-use boolean — customized colors in hime window.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/hime-win-sym-click-close boolean — close symbol-selection window after choosing a symbol.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/gtab-auto-select-by_phrase number — auto-select according to Tsin phrase database in gtab input methods.

• 0 — Auto-selected by definition in .gtab file.
• 1 — ON
• 2 — OFF

---

$HOME/.config/hime/config/gtab-disp-im-name boolean — display input method name in gtab input methods.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/gtab-disp-key-codes boolean — show all possible key codes of character in gtab input methods.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/gtab-disp-partial-match number — display partial matched characters in gtab input methods.

• 0 — Auto-selected by definition in .gtab file.
• 1 — ON
• 2 — OFF

---

$HOME/.config/hime/config/gtab-dup-select-bell boolean — bell ring when multiple selections are available in gtab input methods.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/gtab-hide-row2 boolean — hide second row of window in gtab input methods.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/gtab-in-row1 boolean — show key codes in first row of window in gtab input methods.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/gtab-invalid-key-in boolean — clear key codes input area when invalid key and Space key are pressed.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/gtab-pho-query boolean — use ` to query same pronunciation characters. For gtab input methods.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/gtab-phrase-pre-select boolean — show candidate phrases before pressing endkey (Space key). For gtab input methods.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/gtab-pre-select number — show candidate characters before pressing endkey (Space key). For gtab input methods.

• 0 — Auto-selected by definition in .gtab file.
• 1 — ON
• 2 — OFF

---

$HOME/.config/hime/config/gtab-press-full-auto-send number — auto-send character when key codes input area is filled in gtab input methods.

• 0 — Auto-selected by definition in .gtab file.
• 1 — ON
• 2 — OFF

---

$HOME/.config/hime/config/gtab-que-wild-card boolean — use ? as wildcard. For gtab input methods.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/gtab-que-wild-card-asterisk boolean — use * as wildcard. For gtab input methods.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/gtab-shift-phrase-key boolean — use single Shift key to input Alt-Shift phrases in gtab input methods.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/gtab-space-auto-first number — function of Space Key in gtab input methods.

• 0 — Auto-selected by definition in .gtab file.
• 1 — Send first character in Boshiamy input method.
• 2 — Send first character in character-selection area.
• 4 — Does not send first character. (For Array input method.)

---

$HOME/.config/hime/config/gtab-unique-auto-send number — auto send characters when there is only one choice in gtab input methods.

• 0 — Auto-selected by definition in .gtab file.
• 1 — ON
• 2 — OFF

---

$HOME/.config/hime/config/gtab-vertical-select number — vertical selection window in gtab input methods.

• 0 — Auto-selected by definition in .gtab file.
• 1 — ON
• 2 — OFF

---

$HOME/.config/hime/config/pho-hide-row2 boolean — hide second row of window in Bopomofo and Tsin IM.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/pho-in-row1 boolean — show key codes in first row of window in Bopomofo IM.

• 1 — ON
• 0 — OFF

---

$HOME/.config/hime/config/phonetic-char-dynamic-sequence boolean — dynamic character sequence adjustment in Bopomofo and Tsin IM.

okay so we're back in the CONFFILES section, bestie 💖 and we're literally going through every single config file like it's a group chat and we're catching up on all the tea ☕. no cap.

so the setting we were just on? its options are:

• 1 — ON
• 0 — OFF

periodt. now next up:

• $HOME/.config/hime/config/phonetic-huge-tab boolean — Input all Traditional Chinese, Simplified Chinese, and Japanese characters provided by pho-huge.tab in Bopomofo and Tsin IM.
  • 1 — ON
  • 0 — OFF
• $HOME/.config/hime/config/phonetic-keyboard string — Key codes arrangement style in Bopomofo, Tsin, and Japanese anthy IM.
  • zo — Standard style with 1234 selection method
  • zo-asdf — Standard style with asdf selection method
  • et — Eten style with 1234 selection method
  • et-asdf — Eten style with asdf selection method
  • et26 — Eten 26 keys style with 1234 selection method
  • et26-asdf — Eten 26 keys style with asdf selection method
  • hsu — Mr. Hsu's style (Kuo-Yin IM, Natural Bopomofo IM)
  • pinyin — Phonetic Pinyin style with 1234 selection method
  • pinyin-asdf — Phonetic Pinyin style with asdf selection method
  • dvorak — Dvorak style
  • ibm — IBM style
  • mitac — Mitac style
• $HOME/.config/hime/config/phonetic-speak boolean — Enable text-to-speech. You have to install speech data for this feature. 🗣️✨
  • 1 — ON
  • 0 — OFF
• $HOME/.config/hime/config/phonetic-speak-sel string — Speech data filename for text-to-speech.
• $HOME/.config/hime/config/tsin-buffer-editing-mode boolean — VI-like editing mode in Tsin IM. 💅
  • 1 — ON
  • 0 — OFF
• $HOME/.config/hime/config/tsin-buffer-size number — Size of buffer (editing area) in Tsin IM. Default is 40.
• $HOME/.config/hime/config/tsin-chinese-english-toggle_key number — Toggle key for Chinese/English mode in Tsin IM.
  • 1 — Caps Lock key
  • 2 — Tab key
  • 4 — Shift key (Not available in XIM mode).
  • 8 — Left Shift key (Not available in XIM mode).
  • 16 — Right Shift key (Not available in XIM mode).
• $HOME/.config/hime/config/tsin-cursor-color hex — Color of cursor in Tsin IM.
  • #FF0000 — Red
  • #00FF00 — Green
  • #0000FF — Blue
  • #FFFF00 — Yellow
  • #FF00FF — Magenta
  • #00FFFF — Cyan
• $HOME/.config/hime/config/tsin-phrase-line-color hex — Color of phrase-underline in Tsin IM. Default is #0000FF.
• $HOME/.config/hime/config/tsin-phrase-pre-select boolean — Show phrase pre-selection window in Tsin IM. 👑
  • 1 — ON
  • 0 — OFF
• $HOME/.config/hime/config/tsin-space-opt number — Function of Space key in Tsin IM.
  • 1 — Select other same phonetic characters.
  • 2 — Send space to buffer of Tsin IM.
• $HOME/.config/hime/config/tsin-tab-phrase-end boolean — Use Escape key or Tab key to stop phrase-auto-selection in Tsin IM.
  • 1 — ON
  • 0 — OFF
• $HOME/.config/hime/config/tsin-tail-select-key boolean — Show selection keys follows choices in Tsin IM.
  • 1 — ON
  • 0 — OFF
• $HOME/.config/hime/config/tsin-tone-char-input boolean — Input tone sympols of Bopomofo in Tsin IM. (not me pointing out the typo, but we keep it 💅)
  • 1 — ON
  • 0 — OFF

---

✨ SEE ALSO ✨

• hime(1) — go check out the main character, hime(1) 💖

and that's the whole CONFFILES section, bestie 🫶. this page is from HIME 0.8, dated 2 FEB 2009, and it's the manual for HIME-SETUP(1). slay 💅✨