strans/README.md

strans

strans is a small, single-user input method for Korean, Japanese, English, emoji, and symbols. It provides one engine for IBus, XIM, and GTK 3. Vietnamese Telex is also available as a compatibility mode.

Input modes

Key	Mode
Ctrl+N	Japanese Hiragana and Kanji conversion
Ctrl+K	Japanese Katakana
Ctrl+S	Korean Hangul (2-beolsik)
Ctrl+T	English
Ctrl+V	Vietnamese Telex
Ctrl+E	Emoji and symbol search
Ctrl+H	One-shot Hanja search
Ctrl+P	Toggle popup preedit

Use Up/Down to move through candidates, Enter or 1-9 to select, Tab to cycle temporary search results, and Esc to cancel. 0 commits the current reading without conversion.

Hiragana mode composes a complete reading before offering Kanji candidates. Katakana mode does not perform Kanji conversion. Emoji and Hanja searches return to the previous mode after use. Hanja lookup currently supports one modern Hangul syllable at a time.

Build and test

Docker is the supported build environment:

git submodule update --init
make docker-image
make docker-build
make docker-check

Build output:

strans              daemon and IBus frontend
xim/strans-xim      XIM frontend
gtk/im-strans.so    GTK 3 frontend

Use make docker-check TESTARGS=hangul to run selected C tests. Native make all, make check, and make bench are also available when the dependencies listed in Dockerfile are installed.

Run

The popup uses the normal system fonts found by Pango and Fontconfig; no font file argument or system-wide strans installation is required. Run it directly from the build tree:

./run.sh
# daemon only
./strans map

Pango shapes the complete string and selects glyph fallback from the system font set.

The popup renderer requires Pango/PangoCairo 1.56 or newer and Cairo 1.18 or newer. run.sh starts the daemon and, when DISPLAY is set, the XIM frontend. It restarts existing strans processes owned by the current user.

Configure clients as needed:

# XIM
export XMODIFIERS=@im=strans

# GTK 3 module
doas make -C gtk install

# IBus client example
GLFW_IM_MODULE=ibus kitty

strans provides its own IBus endpoint; ibus-daemon and fcitx are not required. Without DISPLAY, the daemon and IBus frontend still work, but the popup is disabled.

Dictionary data

After changing an input source, regenerate and verify the dictionaries:

map/mkemoji >map/emoji.dict
map/mkhanja >map/hanja.dict
make verify-map

See map/README for Hanja import and Japanese dictionary generation.

Licensing

Data and third-party notices are in docs/PROVENANCE.md and font/PROVENANCE. The repository does not currently declare a license for the strans source as a whole.