nixos/modules/i18n/input-method/default.md

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