pyrox.dev
1# Input Methods {#module-services-input-methods}
2
3Input methods are an operating system component that allows any data, such as
4keyboard strokes or mouse movements, to be received as input. In this way
5users can enter characters and symbols not found on their input devices.
6Using an input method is obligatory for any language that has more graphemes
7than there are keys on the keyboard.
8
9The following input methods are available in NixOS:
10
11 - IBus: The intelligent input bus.
12 - Fcitx5: The next generation of fcitx, addons (including engines, dictionaries, skins) can be added using `i18n.inputMethod.fcitx5.addons`.
13 - Nabi: A Korean input method based on XIM.
14 - Uim: The universal input method, is a library with a XIM bridge.
15 - Hime: An extremely easy-to-use input method framework.
16 - Kime: Korean IME
17
18## IBus {#module-services-input-methods-ibus}
19
20IBus is an Intelligent Input Bus. It provides full featured and user
21friendly input method user interface.
22
23The following snippet can be used to configure IBus:
24
25```
26i18n.inputMethod = {
27 enabled = "ibus";
28 ibus.engines = with pkgs.ibus-engines; [ anthy hangul mozc ];
29};
30```
31
32`i18n.inputMethod.ibus.engines` is optional and can be used
33to add extra IBus engines.
34
35Available extra IBus engines are:
36
37 - Anthy (`ibus-engines.anthy`): Anthy is a system for
38 Japanese input method. It converts Hiragana text to Kana Kanji mixed text.
39 - Hangul (`ibus-engines.hangul`): Korean input method.
40 - m17n (`ibus-engines.m17n`): m17n is an input method that
41 uses input methods and corresponding icons in the m17n database.
42 - mozc (`ibus-engines.mozc`): A Japanese input method from
43 Google.
44 - Table (`ibus-engines.table`): An input method that load
45 tables of input methods.
46 - table-others (`ibus-engines.table-others`): Various
47 table-based input methods. To use this, and any other table-based input
48 methods, it must appear in the list of engines along with
49 `table`. For example:
50
51 ```
52 ibus.engines = with pkgs.ibus-engines; [ table table-others ];
53 ```
54
55To use any input method, the package must be added in the configuration, as
56shown above, and also (after running `nixos-rebuild`) the
57input method must be added from IBus' preference dialog.
58
59### Troubleshooting {#module-services-input-methods-troubleshooting}
60
61If IBus works in some applications but not others, a likely cause of this
62is that IBus is depending on a different version of `glib`
63to what the applications are depending on. This can be checked by running
64`nix-store -q --requisites <path> | grep glib`,
65where `<path>` is the path of either IBus or an
66application in the Nix store. The `glib` packages must
67match exactly. If they do not, uninstalling and reinstalling the
68application is a likely fix.
69
70## Fcitx5 {#module-services-input-methods-fcitx}
71
72Fcitx5 is an input method framework with extension support. It has three
73built-in Input Method Engine, Pinyin, QuWei and Table-based input methods.
74
75The following snippet can be used to configure Fcitx:
76
77```
78i18n.inputMethod = {
79 enabled = "fcitx5";
80 fcitx5.addons = with pkgs; [ fcitx5-mozc fcitx5-hangul fcitx5-m17n ];
81};
82```
83
84`i18n.inputMethod.fcitx5.addons` is optional and can be
85used to add extra Fcitx5 addons.
86
87Available extra Fcitx5 addons are:
88
89 - Anthy (`fcitx5-anthy`): Anthy is a system for
90 Japanese input method. It converts Hiragana text to Kana Kanji mixed text.
91 - Chewing (`fcitx5-chewing`): Chewing is an
92 intelligent Zhuyin input method. It is one of the most popular input
93 methods among Traditional Chinese Unix users.
94 - Hangul (`fcitx5-hangul`): Korean input method.
95 - Unikey (`fcitx5-unikey`): Vietnamese input method.
96 - m17n (`fcitx5-m17n`): m17n is an input method that
97 uses input methods and corresponding icons in the m17n database.
98 - mozc (`fcitx5-mozc`): A Japanese input method from
99 Google.
100 - table-others (`fcitx5-table-other`): Various
101 table-based input methods.
102 - chinese-addons (`fcitx5-chinese-addons`): Various chinese input methods.
103 - rime (`fcitx5-rime`): RIME support for fcitx5.
104
105## Nabi {#module-services-input-methods-nabi}
106
107Nabi is an easy to use Korean X input method. It allows you to enter
108phonetic Korean characters (hangul) and pictographic Korean characters
109(hanja).
110
111The following snippet can be used to configure Nabi:
112
113```
114i18n.inputMethod = {
115 enabled = "nabi";
116};
117```
118
119## Uim {#module-services-input-methods-uim}
120
121Uim (short for "universal input method") is a multilingual input method
122framework. Applications can use it through so-called bridges.
123
124The following snippet can be used to configure uim:
125
126```
127i18n.inputMethod = {
128 enabled = "uim";
129};
130```
131
132Note: The [](#opt-i18n.inputMethod.uim.toolbar) option can be
133used to choose uim toolbar.
134
135## Hime {#module-services-input-methods-hime}
136
137Hime is an extremely easy-to-use input method framework. It is lightweight,
138stable, powerful and supports many commonly used input methods, including
139Cangjie, Zhuyin, Dayi, Rank, Shrimp, Greek, Korean Pinyin, Latin Alphabet,
140etc...
141
142The following snippet can be used to configure Hime:
143
144```
145i18n.inputMethod = {
146 enabled = "hime";
147};
148```
149
150## Kime {#module-services-input-methods-kime}
151
152Kime is Korean IME. it's built with Rust language and let you get simple, safe, fast Korean typing
153
154The following snippet can be used to configure Kime:
155
156```
157i18n.inputMethod = {
158 enabled = "kime";
159};
160```