commit 3395f41bd133a0b21a9b2e29cb62d865871cc86c · pyrox.dev/nixpkgs

+158

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
       +
         - Fcitx: A customizable lightweight input method.

     

       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
       +
       ```

     

       26
       +
       i18n.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

     

       33
       +
       to add extra IBus engines.

     

       34
       +
       

     

       35
       +
       Available 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
       +
       

     

       55
       +
       To use any input method, the package must be added in the configuration, as

     

       56
       +
       shown above, and also (after running `nixos-rebuild`) the

     

       57
       +
       input method must be added from IBus' preference dialog.

     

       58
       +
       

     

       59
       +
       ### Troubleshooting {#module-services-input-methods-troubleshooting}

     

       60
       +
       

     

       61
       +
       If IBus works in some applications but not others, a likely cause of this

     

       62
       +
       is that IBus is depending on a different version of `glib`

     

       63
       +
       to what the applications are depending on. This can be checked by running

     

       64
       +
       `nix-store -q --requisites <path> | grep glib`,

     

       65
       +
       where `<path>` is the path of either IBus or an

     

       66
       +
       application in the Nix store. The `glib` packages must

     

       67
       +
       match exactly. If they do not, uninstalling and reinstalling the

     

       68
       +
       application is a likely fix.

     

       69
       +
       

     

       70
       +
       ## Fcitx {#module-services-input-methods-fcitx}

     

       71
       +
       

     

       72
       +
       Fcitx is an input method framework with extension support. It has three

     

       73
       +
       built-in Input Method Engine, Pinyin, QuWei and Table-based input methods.

     

       74
       +
       

     

       75
       +
       The following snippet can be used to configure Fcitx:

     

       76
       +
       

     

       77
       +
       ```

     

       78
       +
       i18n.inputMethod = {

     

       79
       +
         enabled = "fcitx";

     

       80
       +
         fcitx.engines = with pkgs.fcitx-engines; [ mozc hangul m17n ];

     

       81
       +
       };

     

       82
       +
       ```

     

       83
       +
       

     

       84
       +
       `i18n.inputMethod.fcitx.engines` is optional and can be

     

       85
       +
       used to add extra Fcitx engines.

     

       86
       +
       

     

       87
       +
       Available extra Fcitx engines are:

     

       88
       +
       

     

       89
       +
         - Anthy (`fcitx-engines.anthy`): Anthy is a system for

     

       90
       +
           Japanese input method. It converts Hiragana text to Kana Kanji mixed text.

     

       91
       +
         - Chewing (`fcitx-engines.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 (`fcitx-engines.hangul`): Korean input method.

     

       95
       +
         - Unikey (`fcitx-engines.unikey`): Vietnamese input method.

     

       96
       +
         - m17n (`fcitx-engines.m17n`): m17n is an input method that

     

       97
       +
           uses input methods and corresponding icons in the m17n database.

     

       98
       +
         - mozc (`fcitx-engines.mozc`): A Japanese input method from

     

       99
       +
           Google.

     

       100
       +
         - table-others (`fcitx-engines.table-others`): Various

     

       101
       +
           table-based input methods.

     

       102
       +
       

     

       103
       +
       ## Nabi {#module-services-input-methods-nabi}

     

       104
       +
       

     

       105
       +
       Nabi is an easy to use Korean X input method. It allows you to enter

     

       106
       +
       phonetic Korean characters (hangul) and pictographic Korean characters

     

       107
       +
       (hanja).

     

       108
       +
       

     

       109
       +
       The following snippet can be used to configure Nabi:

     

       110
       +
       

     

       111
       +
       ```

     

       112
       +
       i18n.inputMethod = {

     

       113
       +
         enabled = "nabi";

     

       114
       +
       };

     

       115
       +
       ```

     

       116
       +
       

     

       117
       +
       ## Uim {#module-services-input-methods-uim}

     

       118
       +
       

     

       119
       +
       Uim (short for "universal input method") is a multilingual input method

     

       120
       +
       framework. Applications can use it through so-called bridges.

     

       121
       +
       

     

       122
       +
       The following snippet can be used to configure uim:

     

       123
       +
       

     

       124
       +
       ```

     

       125
       +
       i18n.inputMethod = {

     

       126
       +
         enabled = "uim";

     

       127
       +
       };

     

       128
       +
       ```

     

       129
       +
       

     

       130
       +
       Note: The [](#opt-i18n.inputMethod.uim.toolbar) option can be

     

       131
       +
       used to choose uim toolbar.

     

       132
       +
       

     

       133
       +
       ## Hime {#module-services-input-methods-hime}

     

       134
       +
       

     

       135
       +
       Hime is an extremely easy-to-use input method framework. It is lightweight,

     

       136
       +
       stable, powerful and supports many commonly used input methods, including

     

       137
       +
       Cangjie, Zhuyin, Dayi, Rank, Shrimp, Greek, Korean Pinyin, Latin Alphabet,

     

       138
       +
       etc...

     

       139
       +
       

     

       140
       +
       The following snippet can be used to configure Hime:

     

       141
       +
       

     

       142
       +
       ```

     

       143
       +
       i18n.inputMethod = {

     

       144
       +
         enabled = "hime";

     

       145
       +
       };

     

       146
       +
       ```

     

       147
       +
       

     

       148
       +
       ## Kime {#module-services-input-methods-kime}

     

       149
       +
       

     

       150
       +
       Kime is Korean IME. it's built with Rust language and let you get simple, safe, fast Korean typing

     

       151
       +
       

     

       152
       +
       The following snippet can be used to configure Kime:

     

       153
       +
       

     

       154
       +
       ```

     

       155
       +
       i18n.inputMethod = {

     

       156
       +
         enabled = "kime";

     

       157
       +
       };

     

       158
       +
       ```

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

···

       66
        
       

     

       67
        
         meta = {

     

       68
        
           maintainers = with lib.maintainers; [ ericsagnes ];

     

       0
        
       
     

       0
        
       
     

       69
        
           doc = ./default.xml;

     

       70
        
         };

     

       71

···

       66
        
       

     

       67
        
         meta = {

     

       68
        
           maintainers = with lib.maintainers; [ ericsagnes ];

     

       69
       +
           # Don't edit the docbook xml directly, edit the md and generate it:

     

       70
       +
           # `pandoc default.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > default.xml`

     

       71
        
           doc = ./default.xml;

     

       72
        
         };

     

       73

+229 -247

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

···

       1
       -
       <chapter xmlns="http://docbook.org/ns/docbook"

     

       2
       -
                xmlns:xlink="http://www.w3.org/1999/xlink"

     

       3
       -
                xmlns:xi="http://www.w3.org/2001/XInclude"

     

       4
       -
                version="5.0"

     

       5
       -
                xml:id="module-services-input-methods">

     

       6
       -
        <title>Input Methods</title>

     

       7
       -
        <para>

     

       8
       -
         Input methods are an operating system component that allows any data, such as

     

       9
       -
         keyboard strokes or mouse movements, to be received as input. In this way

     

       10
       -
         users can enter characters and symbols not found on their input devices.

     

       11
       -
         Using an input method is obligatory for any language that has more graphemes

     

       12
       -
         than there are keys on the keyboard.

     

       13
       -
        </para>

     

       14
       -
        <para>

     

       15
       -
         The following input methods are available in NixOS:

     

       16
       -
        </para>

     

       17
       -
        <itemizedlist>

     

       18
       -
         <listitem>

     

       19
       -
          <para>

     

       20
       -
           IBus: The intelligent input bus.

     

       21
       -
          </para>

     

       22
       -
         </listitem>

     

       23
       -
         <listitem>

     

       24
       -
          <para>

     

       25
       -
           Fcitx: A customizable lightweight input method.

     

       26
       -
          </para>

     

       27
       -
         </listitem>

     

       28
       -
         <listitem>

     

       29
       -
          <para>

     

       30
       -
           Nabi: A Korean input method based on XIM.

     

       31
       -
          </para>

     

       32
       -
         </listitem>

     

       33
       -
         <listitem>

     

       34
       -
          <para>

     

       35
       -
           Uim: The universal input method, is a library with a XIM bridge.

     

       36
       -
          </para>

     

       37
       -
         </listitem>

     

       38
       -
         <listitem>

     

       39
       -
          <para>

     

       40
       -
           Hime: An extremely easy-to-use input method framework.

     

       41
       -
          </para>

     

       42
       -
         </listitem>

     

       43
       -
         <listitem>

     

       44
       -
           <para>

     

       45
       -
            Kime: Korean IME

     

       46
       -
           </para>

     

       47
       -
         </listitem>

     

       48
       -
        </itemizedlist>

     

       49
       -
        <section xml:id="module-services-input-methods-ibus">

     

       50
       -
         <title>IBus</title>

     

       51
       -
       

     

       52
        
         <para>

     

       53
       -
          IBus is an Intelligent Input Bus. It provides full featured and user

     

       54
       -
          friendly input method user interface.

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       55
        
         </para>

     

       56
       -
       

     

       57
        
         <para>

     

       58
       -
          The following snippet can be used to configure IBus:

     

       59
        
         </para>

     

       60
       -
       

     

       61
       -
       <programlisting>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       62
        
       i18n.inputMethod = {

     

       63
       -
         enabled = "ibus";

     

       64
        
         ibus.engines = with pkgs.ibus-engines; [ anthy hangul mozc ];

     

       65
        
       };

     

       66
        
       </programlisting>

     

       67
       -
       

     

       68
       -
         <para>

     

       69
       -
          <literal>i18n.inputMethod.ibus.engines</literal> is optional and can be used

     

       70
       -
          to add extra IBus engines.

     

       71
       -
         </para>

     

       72
       -
       

     

       73
       -
         <para>

     

       74
       -
          Available extra IBus engines are:

     

       75
       -
         </para>

     

       76
       -
       

     

       77
       -
         <itemizedlist>

     

       78
       -
          <listitem>

     

       79
        
           <para>

     

       80
       -
            Anthy (<literal>ibus-engines.anthy</literal>): Anthy is a system for

     

       81
       -
            Japanese input method. It converts Hiragana text to Kana Kanji mixed text.

     

       82
        
           </para>

     

       83
       -
          </listitem>

     

       84
       -
          <listitem>

     

       85
        
           <para>

     

       86
       -
            Hangul (<literal>ibus-engines.hangul</literal>): Korean input method.

     

       87
        
           </para>

     

       88
       -
          </listitem>

     

       89
       -
          <listitem>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       90
        
           <para>

     

       91
       -
            m17n (<literal>ibus-engines.m17n</literal>): m17n is an input method that

     

       92
       -
            uses input methods and corresponding icons in the m17n database.

     

       0
        
       
     

       0
        
       
     

       93
        
           </para>

     

       94
       -
          </listitem>

     

       95
       -
          <listitem>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       96
        
           <para>

     

       97
       -
            mozc (<literal>ibus-engines.mozc</literal>): A Japanese input method from

     

       98
       -
            Google.

     

       0
        
       
     

       99
        
           </para>

     

       100
       -
          </listitem>

     

       101
       -
          <listitem>

     

       102
        
           <para>

     

       103
       -
            Table (<literal>ibus-engines.table</literal>): An input method that load

     

       104
       -
            tables of input methods.

     

       105
        
           </para>

     

       106
       -
          </listitem>

     

       107
       -
          <listitem>

     

       108
       -
           <para>

     

       109
       -
            table-others (<literal>ibus-engines.table-others</literal>): Various

     

       110
       -
            table-based input methods. To use this, and any other table-based input

     

       111
       -
            methods, it must appear in the list of engines along with

     

       112
       -
            <literal>table</literal>. For example:

     

       113
       -
       <programlisting>

     

       114
       -
       ibus.engines = with pkgs.ibus-engines; [ table table-others ];

     

       115
       -
       </programlisting>

     

       116
       -
           </para>

     

       117
       -
          </listitem>

     

       118
       -
         </itemizedlist>

     

       119
       -
       

     

       120
       -
         <para>

     

       121
       -
          To use any input method, the package must be added in the configuration, as

     

       122
       -
          shown above, and also (after running <literal>nixos-rebuild</literal>) the

     

       123
       -
          input method must be added from IBus' preference dialog.

     

       124
       -
         </para>

     

       125
       -
       

     

       126
       -
         <simplesect xml:id="module-services-input-methods-troubleshooting">

     

       127
       -
          <title>Troubleshooting</title>

     

       128
       -
          <para>

     

       129
       -
           If IBus works in some applications but not others, a likely cause of this

     

       130
       -
           is that IBus is depending on a different version of <literal>glib</literal>

     

       131
       -
           to what the applications are depending on. This can be checked by running

     

       132
       -
           <literal>nix-store -q --requisites &lt;path&gt; | grep glib</literal>,

     

       133
       -
           where <literal>&lt;path&gt;</literal> is the path of either IBus or an

     

       134
       -
           application in the Nix store. The <literal>glib</literal> packages must

     

       135
       -
           match exactly. If they do not, uninstalling and reinstalling the

     

       136
       -
           application is a likely fix.

     

       137
       -
          </para>

     

       138
       -
         </simplesect>

     

       139
       -
        </section>

     

       140
       -
        <section xml:id="module-services-input-methods-fcitx">

     

       141
       -
         <title>Fcitx</title>

     

       142
       -
       

     

       143
       -
         <para>

     

       144
       -
          Fcitx is an input method framework with extension support. It has three

     

       145
       -
          built-in Input Method Engine, Pinyin, QuWei and Table-based input methods.

     

       146
       -
         </para>

     

       147
       -
       

     

       148
       -
         <para>

     

       149
       -
          The following snippet can be used to configure Fcitx:

     

       150
       -
         </para>

     

       151
       -
       

     

       152
       -
       <programlisting>

     

       153
        
       i18n.inputMethod = {

     

       154
       -
         enabled = "fcitx";

     

       155
        
         fcitx.engines = with pkgs.fcitx-engines; [ mozc hangul m17n ];

     

       156
        
       };

     

       157
        
       </programlisting>

     

       158
       -
       

     

       159
       -
         <para>

     

       160
       -
          <literal>i18n.inputMethod.fcitx.engines</literal> is optional and can be

     

       161
       -
          used to add extra Fcitx engines.

     

       162
       -
         </para>

     

       163
       -
       

     

       164
       -
         <para>

     

       165
       -
          Available extra Fcitx engines are:

     

       166
       -
         </para>

     

       167
       -
       

     

       168
       -
         <itemizedlist>

     

       169
       -
          <listitem>

     

       170
        
           <para>

     

       171
       -
            Anthy (<literal>fcitx-engines.anthy</literal>): Anthy is a system for

     

       172
       -
            Japanese input method. It converts Hiragana text to Kana Kanji mixed text.

     

       173
        
           </para>

     

       174
       -
          </listitem>

     

       175
       -
          <listitem>

     

       176
        
           <para>

     

       177
       -
            Chewing (<literal>fcitx-engines.chewing</literal>): Chewing is an

     

       178
       -
            intelligent Zhuyin input method. It is one of the most popular input

     

       179
       -
            methods among Traditional Chinese Unix users.

     

       180
        
           </para>

     

       181
       -
          </listitem>

     

       182
       -
          <listitem>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       183
        
           <para>

     

       184
       -
            Hangul (<literal>fcitx-engines.hangul</literal>): Korean input method.

     

       0
        
       
     

       0
        
       
     

       185
        
           </para>

     

       186
       -
          </listitem>

     

       187
       -
          <listitem>

     

       188
        
           <para>

     

       189
       -
            Unikey (<literal>fcitx-engines.unikey</literal>): Vietnamese input method.

     

       190
       -
           </para>

     

       191
       -
          </listitem>

     

       192
       -
          <listitem>

     

       193
       -
           <para>

     

       194
       -
            m17n (<literal>fcitx-engines.m17n</literal>): m17n is an input method that

     

       195
       -
            uses input methods and corresponding icons in the m17n database.

     

       196
        
           </para>

     

       197
       -
          </listitem>

     

       198
       -
          <listitem>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       199
        
           <para>

     

       200
       -
            mozc (<literal>fcitx-engines.mozc</literal>): A Japanese input method from

     

       201
       -
            Google.

     

       0
        
       
     

       202
        
           </para>

     

       203
       -
          </listitem>

     

       204
       -
          <listitem>

     

       205
        
           <para>

     

       206
       -
            table-others (<literal>fcitx-engines.table-others</literal>): Various

     

       207
       -
            table-based input methods.

     

       208
        
           </para>

     

       209
       -
          </listitem>

     

       210
       -
         </itemizedlist>

     

       211
       -
        </section>

     

       212
       -
        <section xml:id="module-services-input-methods-nabi">

     

       213
       -
         <title>Nabi</title>

     

       214
       -
       

     

       215
       -
         <para>

     

       216
       -
          Nabi is an easy to use Korean X input method. It allows you to enter

     

       217
       -
          phonetic Korean characters (hangul) and pictographic Korean characters

     

       218
       -
          (hanja).

     

       219
       -
         </para>

     

       220
       -
       

     

       221
       -
         <para>

     

       222
       -
          The following snippet can be used to configure Nabi:

     

       223
       -
         </para>

     

       224
       -
       

     

       225
       -
       <programlisting>

     

       226
        
       i18n.inputMethod = {

     

       227
       -
         enabled = "nabi";

     

       228
        
       };

     

       229
        
       </programlisting>

     

       230
       -
        </section>

     

       231
       -
        <section xml:id="module-services-input-methods-uim">

     

       232
       -
         <title>Uim</title>

     

       233
       -
       

     

       234
       -
         <para>

     

       235
       -
          Uim (short for "universal input method") is a multilingual input method

     

       236
       -
          framework. Applications can use it through so-called bridges.

     

       237
       -
         </para>

     

       238
       -
       

     

       239
       -
         <para>

     

       240
       -
          The following snippet can be used to configure uim:

     

       241
       -
         </para>

     

       242
       -
       

     

       243
       -
       <programlisting>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       244
        
       i18n.inputMethod = {

     

       245
       -
         enabled = "uim";

     

       246
        
       };

     

       247
        
       </programlisting>

     

       248
       -
       

     

       249
       -
         <para>

     

       250
       -
          Note: The <xref linkend="opt-i18n.inputMethod.uim.toolbar"/> option can be

     

       251
       -
          used to choose uim toolbar.

     

       252
       -
         </para>

     

       253
       -
        </section>

     

       254
       -
        <section xml:id="module-services-input-methods-hime">

     

       255
       -
         <title>Hime</title>

     

       256
       -
       

     

       257
       -
         <para>

     

       258
       -
          Hime is an extremely easy-to-use input method framework. It is lightweight,

     

       259
       -
          stable, powerful and supports many commonly used input methods, including

     

       260
       -
          Cangjie, Zhuyin, Dayi, Rank, Shrimp, Greek, Korean Pinyin, Latin Alphabet,

     

       261
       -
          etc...

     

       262
       -
         </para>

     

       263
       -
       

     

       264
       -
         <para>

     

       265
       -
          The following snippet can be used to configure Hime:

     

       266
       -
         </para>

     

       267
       -
       

     

       268
       -
       <programlisting>

     

       269
        
       i18n.inputMethod = {

     

       270
       -
         enabled = "hime";

     

       271
        
       };

     

       272
        
       </programlisting>

     

       273
       -
        </section>

     

       274
       -
        <section xml:id="module-services-input-methods-kime">

     

       275
       -
         <title>Kime</title>

     

       276
       -
       

     

       277
       -
         <para>

     

       278
       -
          Kime is Korean IME. it's built with Rust language and let you get simple, safe, fast Korean typing

     

       279
       -
         </para>

     

       280
       -
       

     

       281
       -
         <para>

     

       282
       -
          The following snippet can be used to configure Kime:

     

       283
       -
         </para>

     

       284
       -
       

     

       285
       -
       <programlisting>

     

       286
       -
       i18n.inputMethod = {

     

       287
       -
         enabled = "kime";

     

       288
       -
       };

     

       289
       -
       </programlisting>

     

       290
       -
        </section>

     

       291
        
       </chapter>

···

       1
       +
       <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-services-input-methods">

     

       2
       +
         <title>Input Methods</title>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       3
        
         <para>

     

       4
       +
           Input methods are an operating system component that allows any

     

       5
       +
           data, such as keyboard strokes or mouse movements, to be received as

     

       6
       +
           input. In this way users can enter characters and symbols not found

     

       7
       +
           on their input devices. Using an input method is obligatory for any

     

       8
       +
           language that has more graphemes than there are keys on the

     

       9
       +
           keyboard.

     

       10
        
         </para>

     

       0
        
       
     

       11
        
         <para>

     

       12
       +
           The following input methods are available in NixOS:

     

       13
        
         </para>

     

       14
       +
         <itemizedlist spacing="compact">

     

       15
       +
           <listitem>

     

       16
       +
             <para>

     

       17
       +
               IBus: The intelligent input bus.

     

       18
       +
             </para>

     

       19
       +
           </listitem>

     

       20
       +
           <listitem>

     

       21
       +
             <para>

     

       22
       +
               Fcitx: A customizable lightweight input method.

     

       23
       +
             </para>

     

       24
       +
           </listitem>

     

       25
       +
           <listitem>

     

       26
       +
             <para>

     

       27
       +
               Nabi: A Korean input method based on XIM.

     

       28
       +
             </para>

     

       29
       +
           </listitem>

     

       30
       +
           <listitem>

     

       31
       +
             <para>

     

       32
       +
               Uim: The universal input method, is a library with a XIM bridge.

     

       33
       +
             </para>

     

       34
       +
           </listitem>

     

       35
       +
           <listitem>

     

       36
       +
             <para>

     

       37
       +
               Hime: An extremely easy-to-use input method framework.

     

       38
       +
             </para>

     

       39
       +
           </listitem>

     

       40
       +
           <listitem>

     

       41
       +
             <para>

     

       42
       +
               Kime: Korean IME

     

       43
       +
             </para>

     

       44
       +
           </listitem>

     

       45
       +
         </itemizedlist>

     

       46
       +
         <section xml:id="module-services-input-methods-ibus">

     

       47
       +
           <title>IBus</title>

     

       48
       +
           <para>

     

       49
       +
             IBus is an Intelligent Input Bus. It provides full featured and

     

       50
       +
             user friendly input method user interface.

     

       51
       +
           </para>

     

       52
       +
           <para>

     

       53
       +
             The following snippet can be used to configure IBus:

     

       54
       +
           </para>

     

       55
       +
           <programlisting>

     

       56
        
       i18n.inputMethod = {

     

       57
       +
         enabled = &quot;ibus&quot;;

     

       58
        
         ibus.engines = with pkgs.ibus-engines; [ anthy hangul mozc ];

     

       59
        
       };

     

       60
        
       </programlisting>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       61
        
           <para>

     

       62
       +
             <literal>i18n.inputMethod.ibus.engines</literal> is optional and

     

       63
       +
             can be used to add extra IBus engines.

     

       64
        
           </para>

     

       0
        
       
     

       0
        
       
     

       65
        
           <para>

     

       66
       +
             Available extra IBus engines are:

     

       67
        
           </para>

     

       68
       +
           <itemizedlist>

     

       69
       +
             <listitem>

     

       70
       +
               <para>

     

       71
       +
                 Anthy (<literal>ibus-engines.anthy</literal>): Anthy is a

     

       72
       +
                 system for Japanese input method. It converts Hiragana text to

     

       73
       +
                 Kana Kanji mixed text.

     

       74
       +
               </para>

     

       75
       +
             </listitem>

     

       76
       +
             <listitem>

     

       77
       +
               <para>

     

       78
       +
                 Hangul (<literal>ibus-engines.hangul</literal>): Korean input

     

       79
       +
                 method.

     

       80
       +
               </para>

     

       81
       +
             </listitem>

     

       82
       +
             <listitem>

     

       83
       +
               <para>

     

       84
       +
                 m17n (<literal>ibus-engines.m17n</literal>): m17n is an input

     

       85
       +
                 method that uses input methods and corresponding icons in the

     

       86
       +
                 m17n database.

     

       87
       +
               </para>

     

       88
       +
             </listitem>

     

       89
       +
             <listitem>

     

       90
       +
               <para>

     

       91
       +
                 mozc (<literal>ibus-engines.mozc</literal>): A Japanese input

     

       92
       +
                 method from Google.

     

       93
       +
               </para>

     

       94
       +
             </listitem>

     

       95
       +
             <listitem>

     

       96
       +
               <para>

     

       97
       +
                 Table (<literal>ibus-engines.table</literal>): An input method

     

       98
       +
                 that load tables of input methods.

     

       99
       +
               </para>

     

       100
       +
             </listitem>

     

       101
       +
             <listitem>

     

       102
       +
               <para>

     

       103
       +
                 table-others (<literal>ibus-engines.table-others</literal>):

     

       104
       +
                 Various table-based input methods. To use this, and any other

     

       105
       +
                 table-based input methods, it must appear in the list of

     

       106
       +
                 engines along with <literal>table</literal>. For example:

     

       107
       +
               </para>

     

       108
       +
               <programlisting>

     

       109
       +
       ibus.engines = with pkgs.ibus-engines; [ table table-others ];

     

       110
       +
       </programlisting>

     

       111
       +
             </listitem>

     

       112
       +
           </itemizedlist>

     

       113
        
           <para>

     

       114
       +
             To use any input method, the package must be added in the

     

       115
       +
             configuration, as shown above, and also (after running

     

       116
       +
             <literal>nixos-rebuild</literal>) the input method must be added

     

       117
       +
             from IBus' preference dialog.

     

       118
        
           </para>

     

       119
       +
           <section xml:id="module-services-input-methods-troubleshooting">

     

       120
       +
             <title>Troubleshooting</title>

     

       121
       +
             <para>

     

       122
       +
               If IBus works in some applications but not others, a likely

     

       123
       +
               cause of this is that IBus is depending on a different version

     

       124
       +
               of <literal>glib</literal> to what the applications are

     

       125
       +
               depending on. This can be checked by running

     

       126
       +
               <literal>nix-store -q --requisites &lt;path&gt; | grep glib</literal>,

     

       127
       +
               where <literal>&lt;path&gt;</literal> is the path of either IBus

     

       128
       +
               or an application in the Nix store. The <literal>glib</literal>

     

       129
       +
               packages must match exactly. If they do not, uninstalling and

     

       130
       +
               reinstalling the application is a likely fix.

     

       131
       +
             </para>

     

       132
       +
           </section>

     

       133
       +
         </section>

     

       134
       +
         <section xml:id="module-services-input-methods-fcitx">

     

       135
       +
           <title>Fcitx</title>

     

       136
        
           <para>

     

       137
       +
             Fcitx is an input method framework with extension support. It has

     

       138
       +
             three built-in Input Method Engine, Pinyin, QuWei and Table-based

     

       139
       +
             input methods.

     

       140
        
           </para>

     

       0
        
       
     

       0
        
       
     

       141
        
           <para>

     

       142
       +
             The following snippet can be used to configure Fcitx:

     

       0
        
       
     

       143
        
           </para>

     

       144
       +
           <programlisting>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       145
        
       i18n.inputMethod = {

     

       146
       +
         enabled = &quot;fcitx&quot;;

     

       147
        
         fcitx.engines = with pkgs.fcitx-engines; [ mozc hangul m17n ];

     

       148
        
       };

     

       149
        
       </programlisting>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       150
        
           <para>

     

       151
       +
             <literal>i18n.inputMethod.fcitx.engines</literal> is optional and

     

       152
       +
             can be used to add extra Fcitx engines.

     

       153
        
           </para>

     

       0
        
       
     

       0
        
       
     

       154
        
           <para>

     

       155
       +
             Available extra Fcitx engines are:

     

       0
        
       
     

       0
        
       
     

       156
        
           </para>

     

       157
       +
           <itemizedlist spacing="compact">

     

       158
       +
             <listitem>

     

       159
       +
               <para>

     

       160
       +
                 Anthy (<literal>fcitx-engines.anthy</literal>): Anthy is a

     

       161
       +
                 system for Japanese input method. It converts Hiragana text to

     

       162
       +
                 Kana Kanji mixed text.

     

       163
       +
               </para>

     

       164
       +
             </listitem>

     

       165
       +
             <listitem>

     

       166
       +
               <para>

     

       167
       +
                 Chewing (<literal>fcitx-engines.chewing</literal>): Chewing is

     

       168
       +
                 an intelligent Zhuyin input method. It is one of the most

     

       169
       +
                 popular input methods among Traditional Chinese Unix users.

     

       170
       +
               </para>

     

       171
       +
             </listitem>

     

       172
       +
             <listitem>

     

       173
       +
               <para>

     

       174
       +
                 Hangul (<literal>fcitx-engines.hangul</literal>): Korean input

     

       175
       +
                 method.

     

       176
       +
               </para>

     

       177
       +
             </listitem>

     

       178
       +
             <listitem>

     

       179
       +
               <para>

     

       180
       +
                 Unikey (<literal>fcitx-engines.unikey</literal>): Vietnamese

     

       181
       +
                 input method.

     

       182
       +
               </para>

     

       183
       +
             </listitem>

     

       184
       +
             <listitem>

     

       185
       +
               <para>

     

       186
       +
                 m17n (<literal>fcitx-engines.m17n</literal>): m17n is an input

     

       187
       +
                 method that uses input methods and corresponding icons in the

     

       188
       +
                 m17n database.

     

       189
       +
               </para>

     

       190
       +
             </listitem>

     

       191
       +
             <listitem>

     

       192
       +
               <para>

     

       193
       +
                 mozc (<literal>fcitx-engines.mozc</literal>): A Japanese input

     

       194
       +
                 method from Google.

     

       195
       +
               </para>

     

       196
       +
             </listitem>

     

       197
       +
             <listitem>

     

       198
       +
               <para>

     

       199
       +
                 table-others (<literal>fcitx-engines.table-others</literal>):

     

       200
       +
                 Various table-based input methods.

     

       201
       +
               </para>

     

       202
       +
             </listitem>

     

       203
       +
           </itemizedlist>

     

       204
       +
         </section>

     

       205
       +
         <section xml:id="module-services-input-methods-nabi">

     

       206
       +
           <title>Nabi</title>

     

       207
        
           <para>

     

       208
       +
             Nabi is an easy to use Korean X input method. It allows you to

     

       209
       +
             enter phonetic Korean characters (hangul) and pictographic Korean

     

       210
       +
             characters (hanja).

     

       211
        
           </para>

     

       0
        
       
     

       0
        
       
     

       212
        
           <para>

     

       213
       +
             The following snippet can be used to configure Nabi:

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       214
        
           </para>

     

       215
       +
           <programlisting>

     

       216
       +
       i18n.inputMethod = {

     

       217
       +
         enabled = &quot;nabi&quot;;

     

       218
       +
       };

     

       219
       +
       </programlisting>

     

       220
       +
         </section>

     

       221
       +
         <section xml:id="module-services-input-methods-uim">

     

       222
       +
           <title>Uim</title>

     

       223
        
           <para>

     

       224
       +
             Uim (short for &quot;universal input method&quot;) is a

     

       225
       +
             multilingual input method framework. Applications can use it

     

       226
       +
             through so-called bridges.

     

       227
        
           </para>

     

       0
        
       
     

       0
        
       
     

       228
        
           <para>

     

       229
       +
             The following snippet can be used to configure uim:

     

       0
        
       
     

       230
        
           </para>

     

       231
       +
           <programlisting>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       232
        
       i18n.inputMethod = {

     

       233
       +
         enabled = &quot;uim&quot;;

     

       234
        
       };

     

       235
        
       </programlisting>

     

       236
       +
           <para>

     

       237
       +
             Note: The <xref linkend="opt-i18n.inputMethod.uim.toolbar"></xref>

     

       238
       +
             option can be used to choose uim toolbar.

     

       239
       +
           </para>

     

       240
       +
         </section>

     

       241
       +
         <section xml:id="module-services-input-methods-hime">

     

       242
       +
           <title>Hime</title>

     

       243
       +
           <para>

     

       244
       +
             Hime is an extremely easy-to-use input method framework. It is

     

       245
       +
             lightweight, stable, powerful and supports many commonly used

     

       246
       +
             input methods, including Cangjie, Zhuyin, Dayi, Rank, Shrimp,

     

       247
       +
             Greek, Korean Pinyin, Latin Alphabet, etc...

     

       248
       +
           </para>

     

       249
       +
           <para>

     

       250
       +
             The following snippet can be used to configure Hime:

     

       251
       +
           </para>

     

       252
       +
           <programlisting>

     

       253
        
       i18n.inputMethod = {

     

       254
       +
         enabled = &quot;hime&quot;;

     

       255
        
       };

     

       256
        
       </programlisting>

     

       257
       +
         </section>

     

       258
       +
         <section xml:id="module-services-input-methods-kime">

     

       259
       +
           <title>Kime</title>

     

       260
       +
           <para>

     

       261
       +
             Kime is Korean IME. it's built with Rust language and let you get

     

       262
       +
             simple, safe, fast Korean typing

     

       263
       +
           </para>

     

       264
       +
           <para>

     

       265
       +
             The following snippet can be used to configure Kime:

     

       266
       +
           </para>

     

       267
       +
           <programlisting>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       268
        
       i18n.inputMethod = {

     

       269
       +
         enabled = &quot;kime&quot;;

     

       270
        
       };

     

       271
        
       </programlisting>

     

       272
       +
         </section>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       273
        
       </chapter>