movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-14 13:39:15 +03:00
Code Issues Projects Releases Packages Wiki Activity

nixos/input-method: convert manual chapter to MD

Browse source
This commit is contained in:
pennae 2023-01-02 21:28:53 +01:00
parent 14cc405a69
commit 3395f41bd1
3 changed files with 395 additions and 253 deletions
Download patch file Download diff file Expand all files Collapse all files

158
nixos/modules/i18n/input-method/default.md Normal file
View file

@ -0,0 +1,158 @@
# Input Methods {#module-services-input-methods}
Input methods are an operating system component that allows any data, such as
keyboard strokes or mouse movements, to be received as input. In this way
users can enter characters and symbols not found on their input devices.
Using an input method is obligatory for any language that has more graphemes
than there are keys on the keyboard.
The following input methods are available in NixOS:
- IBus: The intelligent input bus.
- Fcitx: A customizable lightweight input method.
- Nabi: A Korean input method based on XIM.
- Uim: The universal input method, is a library with a XIM bridge.
- Hime: An extremely easy-to-use input method framework.
- Kime: Korean IME
## IBus {#module-services-input-methods-ibus}
IBus is an Intelligent Input Bus. It provides full featured and user
friendly input method user interface.
The following snippet can be used to configure IBus:
```
i18n.inputMethod = {
enabled = "ibus";
ibus.engines = with pkgs.ibus-engines; [ anthy hangul mozc ];
};
```
`i18n.inputMethod.ibus.engines` is optional and can be used
to add extra IBus engines.
Available extra IBus engines are:
- Anthy (`ibus-engines.anthy`): Anthy is a system for
Japanese input method. It converts Hiragana text to Kana Kanji mixed text.
- Hangul (`ibus-engines.hangul`): Korean input method.
- m17n (`ibus-engines.m17n`): m17n is an input method that
uses input methods and corresponding icons in the m17n database.
- mozc (`ibus-engines.mozc`): A Japanese input method from
Google.
- Table (`ibus-engines.table`): An input method that load
tables of input methods.
- table-others (`ibus-engines.table-others`): Various
table-based input methods. To use this, and any other table-based input
methods, it must appear in the list of engines along with
`table`. For example:
```
ibus.engines = with pkgs.ibus-engines; [ table table-others ];
```
To use any input method, the package must be added in the configuration, as
shown above, and also (after running `nixos-rebuild`) the
input method must be added from IBus' preference dialog.
### Troubleshooting {#module-services-input-methods-troubleshooting}
If IBus works in some applications but not others, a likely cause of this
is that IBus is depending on a different version of `glib`
to what the applications are depending on. This can be checked by running
`nix-store -q --requisites <path> | grep glib`,
where `<path>` is the path of either IBus or an
application in the Nix store. The `glib` packages must
match exactly. If they do not, uninstalling and reinstalling the
application is a likely fix.
## Fcitx {#module-services-input-methods-fcitx}
Fcitx is an input method framework with extension support. It has three
built-in Input Method Engine, Pinyin, QuWei and Table-based input methods.
The following snippet can be used to configure Fcitx:
```
i18n.inputMethod = {
enabled = "fcitx";
fcitx.engines = with pkgs.fcitx-engines; [ mozc hangul m17n ];
};
```
`i18n.inputMethod.fcitx.engines` is optional and can be
used to add extra Fcitx engines.
Available extra Fcitx engines are:
- Anthy (`fcitx-engines.anthy`): Anthy is a system for
Japanese input method. It converts Hiragana text to Kana Kanji mixed text.
- Chewing (`fcitx-engines.chewing`): Chewing is an
intelligent Zhuyin input method. It is one of the most popular input
methods among Traditional Chinese Unix users.
- Hangul (`fcitx-engines.hangul`): Korean input method.
- Unikey (`fcitx-engines.unikey`): Vietnamese input method.
- m17n (`fcitx-engines.m17n`): m17n is an input method that
uses input methods and corresponding icons in the m17n database.
- mozc (`fcitx-engines.mozc`): A Japanese input method from
Google.
- table-others (`fcitx-engines.table-others`): Various
table-based input methods.
## Nabi {#module-services-input-methods-nabi}
Nabi is an easy to use Korean X input method. It allows you to enter
phonetic Korean characters (hangul) and pictographic Korean characters
(hanja).
The following snippet can be used to configure Nabi:
```
i18n.inputMethod = {
enabled = "nabi";
};
```
## Uim {#module-services-input-methods-uim}
Uim (short for "universal input method") is a multilingual input method
framework. Applications can use it through so-called bridges.
The following snippet can be used to configure uim:
```
i18n.inputMethod = {
enabled = "uim";
};
```
Note: The [](#opt-i18n.inputMethod.uim.toolbar) option can be
used to choose uim toolbar.
## Hime {#module-services-input-methods-hime}
Hime is an extremely easy-to-use input method framework. It is lightweight,
stable, powerful and supports many commonly used input methods, including
Cangjie, Zhuyin, Dayi, Rank, Shrimp, Greek, Korean Pinyin, Latin Alphabet,
etc...
The following snippet can be used to configure Hime:
```
i18n.inputMethod = {
enabled = "hime";
};
```
## Kime {#module-services-input-methods-kime}
Kime is Korean IME. it's built with Rust language and let you get simple, safe, fast Korean typing
The following snippet can be used to configure Kime:
```
i18n.inputMethod = {
enabled = "kime";
};
```

2
nixos/modules/i18n/input-method/default.nix
View file

@ -66,6 +66,8 @@ in
meta = { meta = {
maintainers = with lib.maintainers; [ ericsagnes ]; maintainers = with lib.maintainers; [ ericsagnes ];
# Don't edit the docbook xml directly, edit the md and generate it:
# `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`
doc = ./default.xml; doc = ./default.xml;
}; };

488
nixos/modules/i18n/input-method/default.xml
View file

@ -1,291 +1,273 @@
<chapter xmlns="http://docbook.org/ns/docbook" <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="module-services-input-methods">
xmlns:xlink="http://www.w3.org/1999/xlink" <title>Input Methods</title>
xmlns:xi="http://www.w3.org/2001/XInclude" <para>
version="5.0" Input methods are an operating system component that allows any
xml:id="module-services-input-methods"> data, such as keyboard strokes or mouse movements, to be received as
<title>Input Methods</title> input. In this way users can enter characters and symbols not found
<para> on their input devices. Using an input method is obligatory for any
Input methods are an operating system component that allows any data, such as language that has more graphemes than there are keys on the
keyboard strokes or mouse movements, to be received as input. In this way keyboard.
users can enter characters and symbols not found on their input devices. </para>
Using an input method is obligatory for any language that has more graphemes <para>
than there are keys on the keyboard. The following input methods are available in NixOS:
</para> </para>
<para> <itemizedlist spacing="compact">
The following input methods are available in NixOS: <listitem>
</para> <para>
<itemizedlist> IBus: The intelligent input bus.
<listitem> </para>
<para> </listitem>
IBus: The intelligent input bus. <listitem>
</para> <para>
</listitem> Fcitx: A customizable lightweight input method.
<listitem> </para>
<para> </listitem>
Fcitx: A customizable lightweight input method. <listitem>
</para> <para>
</listitem> Nabi: A Korean input method based on XIM.
<listitem> </para>
<para> </listitem>
Nabi: A Korean input method based on XIM. <listitem>
</para> <para>
</listitem> Uim: The universal input method, is a library with a XIM bridge.
<listitem> </para>
<para> </listitem>
Uim: The universal input method, is a library with a XIM bridge. <listitem>
</para> <para>
</listitem> Hime: An extremely easy-to-use input method framework.
<listitem> </para>
<para> </listitem>
Hime: An extremely easy-to-use input method framework. <listitem>
</para> <para>
</listitem> Kime: Korean IME
<listitem> </para>
</listitem>
</itemizedlist>
<section xml:id="module-services-input-methods-ibus">
<title>IBus</title>
<para> <para>
Kime: Korean IME IBus is an Intelligent Input Bus. It provides full featured and
user friendly input method user interface.
</para> </para>
</listitem> <para>
</itemizedlist> The following snippet can be used to configure IBus:
<section xml:id="module-services-input-methods-ibus"> </para>
<title>IBus</title> <programlisting>
<para>
IBus is an Intelligent Input Bus. It provides full featured and user
friendly input method user interface.
</para>
<para>
The following snippet can be used to configure IBus:
</para>
<programlisting>
i18n.inputMethod = { i18n.inputMethod = {
enabled = "ibus"; enabled = &quot;ibus&quot;;
ibus.engines = with pkgs.ibus-engines; [ anthy hangul mozc ]; ibus.engines = with pkgs.ibus-engines; [ anthy hangul mozc ];
}; };
</programlisting> </programlisting>
<para>
<literal>i18n.inputMethod.ibus.engines</literal> is optional and can be used
to add extra IBus engines.
</para>
<para>
Available extra IBus engines are:
</para>
<itemizedlist>
<listitem>
<para> <para>
Anthy (<literal>ibus-engines.anthy</literal>): Anthy is a system for <literal>i18n.inputMethod.ibus.engines</literal> is optional and
Japanese input method. It converts Hiragana text to Kana Kanji mixed text. can be used to add extra IBus engines.
</para> </para>
</listitem>
<listitem>
<para> <para>
Hangul (<literal>ibus-engines.hangul</literal>): Korean input method. Available extra IBus engines are:
</para> </para>
</listitem> <itemizedlist>
<listitem> <listitem>
<para> <para>
m17n (<literal>ibus-engines.m17n</literal>): m17n is an input method that Anthy (<literal>ibus-engines.anthy</literal>): Anthy is a
uses input methods and corresponding icons in the m17n database. system for Japanese input method. It converts Hiragana text to
</para> Kana Kanji mixed text.
</listitem> </para>
<listitem> </listitem>
<para> <listitem>
mozc (<literal>ibus-engines.mozc</literal>): A Japanese input method from <para>
Google. Hangul (<literal>ibus-engines.hangul</literal>): Korean input
</para> method.
</listitem> </para>
<listitem> </listitem>
<para> <listitem>
Table (<literal>ibus-engines.table</literal>): An input method that load <para>
tables of input methods. m17n (<literal>ibus-engines.m17n</literal>): m17n is an input
</para> method that uses input methods and corresponding icons in the
</listitem> m17n database.
<listitem> </para>
<para> </listitem>
table-others (<literal>ibus-engines.table-others</literal>): Various <listitem>
table-based input methods. To use this, and any other table-based input <para>
methods, it must appear in the list of engines along with mozc (<literal>ibus-engines.mozc</literal>): A Japanese input
<literal>table</literal>. For example: method from Google.
<programlisting> </para>
</listitem>
<listitem>
<para>
Table (<literal>ibus-engines.table</literal>): An input method
that load tables of input methods.
</para>
</listitem>
<listitem>
<para>
table-others (<literal>ibus-engines.table-others</literal>):
Various table-based input methods. To use this, and any other
table-based input methods, it must appear in the list of
engines along with <literal>table</literal>. For example:
</para>
<programlisting>
ibus.engines = with pkgs.ibus-engines; [ table table-others ]; ibus.engines = with pkgs.ibus-engines; [ table table-others ];
</programlisting> </programlisting>
</listitem>
</itemizedlist>
<para>
To use any input method, the package must be added in the
configuration, as shown above, and also (after running
<literal>nixos-rebuild</literal>) the input method must be added
from IBus' preference dialog.
</para> </para>
</listitem> <section xml:id="module-services-input-methods-troubleshooting">
</itemizedlist> <title>Troubleshooting</title>
<para>
<para> If IBus works in some applications but not others, a likely
To use any input method, the package must be added in the configuration, as cause of this is that IBus is depending on a different version
shown above, and also (after running <literal>nixos-rebuild</literal>) the of <literal>glib</literal> to what the applications are
input method must be added from IBus' preference dialog. depending on. This can be checked by running
</para> <literal>nix-store -q --requisites &lt;path&gt; | grep glib</literal>,
where <literal>&lt;path&gt;</literal> is the path of either IBus
<simplesect xml:id="module-services-input-methods-troubleshooting"> or an application in the Nix store. The <literal>glib</literal>
<title>Troubleshooting</title> packages must match exactly. If they do not, uninstalling and
<para> reinstalling the application is a likely fix.
If IBus works in some applications but not others, a likely cause of this </para>
is that IBus is depending on a different version of <literal>glib</literal> </section>
to what the applications are depending on. This can be checked by running </section>
<literal>nix-store -q --requisites &lt;path&gt; | grep glib</literal>, <section xml:id="module-services-input-methods-fcitx">
where <literal>&lt;path&gt;</literal> is the path of either IBus or an <title>Fcitx</title>
application in the Nix store. The <literal>glib</literal> packages must <para>
match exactly. If they do not, uninstalling and reinstalling the Fcitx is an input method framework with extension support. It has
application is a likely fix. three built-in Input Method Engine, Pinyin, QuWei and Table-based
</para> input methods.
</simplesect> </para>
</section> <para>
<section xml:id="module-services-input-methods-fcitx"> The following snippet can be used to configure Fcitx:
<title>Fcitx</title> </para>
<programlisting>
<para>
Fcitx is an input method framework with extension support. It has three
built-in Input Method Engine, Pinyin, QuWei and Table-based input methods.
</para>
<para>
The following snippet can be used to configure Fcitx:
</para>
<programlisting>
i18n.inputMethod = { i18n.inputMethod = {
enabled = "fcitx"; enabled = &quot;fcitx&quot;;
fcitx.engines = with pkgs.fcitx-engines; [ mozc hangul m17n ]; fcitx.engines = with pkgs.fcitx-engines; [ mozc hangul m17n ];
}; };
</programlisting> </programlisting>
<para>
<literal>i18n.inputMethod.fcitx.engines</literal> is optional and can be
used to add extra Fcitx engines.
</para>
<para>
Available extra Fcitx engines are:
</para>
<itemizedlist>
<listitem>
<para> <para>
Anthy (<literal>fcitx-engines.anthy</literal>): Anthy is a system for <literal>i18n.inputMethod.fcitx.engines</literal> is optional and
Japanese input method. It converts Hiragana text to Kana Kanji mixed text. can be used to add extra Fcitx engines.
</para> </para>
</listitem>
<listitem>
<para> <para>
Chewing (<literal>fcitx-engines.chewing</literal>): Chewing is an Available extra Fcitx engines are:
intelligent Zhuyin input method. It is one of the most popular input
methods among Traditional Chinese Unix users.
</para> </para>
</listitem> <itemizedlist spacing="compact">
<listitem> <listitem>
<para>
Anthy (<literal>fcitx-engines.anthy</literal>): Anthy is a
system for Japanese input method. It converts Hiragana text to
Kana Kanji mixed text.
</para>
</listitem>
<listitem>
<para>
Chewing (<literal>fcitx-engines.chewing</literal>): Chewing is
an intelligent Zhuyin input method. It is one of the most
popular input methods among Traditional Chinese Unix users.
</para>
</listitem>
<listitem>
<para>
Hangul (<literal>fcitx-engines.hangul</literal>): Korean input
method.
</para>
</listitem>
<listitem>
<para>
Unikey (<literal>fcitx-engines.unikey</literal>): Vietnamese
input method.
</para>
</listitem>
<listitem>
<para>
m17n (<literal>fcitx-engines.m17n</literal>): m17n is an input
method that uses input methods and corresponding icons in the
m17n database.
</para>
</listitem>
<listitem>
<para>
mozc (<literal>fcitx-engines.mozc</literal>): A Japanese input
method from Google.
</para>
</listitem>
<listitem>
<para>
table-others (<literal>fcitx-engines.table-others</literal>):
Various table-based input methods.
</para>
</listitem>
</itemizedlist>
</section>
<section xml:id="module-services-input-methods-nabi">
<title>Nabi</title>
<para> <para>
Hangul (<literal>fcitx-engines.hangul</literal>): Korean input method. Nabi is an easy to use Korean X input method. It allows you to
enter phonetic Korean characters (hangul) and pictographic Korean
characters (hanja).
</para> </para>
</listitem>
<listitem>
<para> <para>
Unikey (<literal>fcitx-engines.unikey</literal>): Vietnamese input method. The following snippet can be used to configure Nabi:
</para> </para>
</listitem> <programlisting>
<listitem>
<para>
m17n (<literal>fcitx-engines.m17n</literal>): m17n is an input method that
uses input methods and corresponding icons in the m17n database.
</para>
</listitem>
<listitem>
<para>
mozc (<literal>fcitx-engines.mozc</literal>): A Japanese input method from
Google.
</para>
</listitem>
<listitem>
<para>
table-others (<literal>fcitx-engines.table-others</literal>): Various
table-based input methods.
</para>
</listitem>
</itemizedlist>
</section>
<section xml:id="module-services-input-methods-nabi">
<title>Nabi</title>
<para>
Nabi is an easy to use Korean X input method. It allows you to enter
phonetic Korean characters (hangul) and pictographic Korean characters
(hanja).
</para>
<para>
The following snippet can be used to configure Nabi:
</para>
<programlisting>
i18n.inputMethod = { i18n.inputMethod = {
enabled = "nabi"; enabled = &quot;nabi&quot;;
}; };
</programlisting> </programlisting>
</section> </section>
<section xml:id="module-services-input-methods-uim"> <section xml:id="module-services-input-methods-uim">
<title>Uim</title> <title>Uim</title>
<para>
<para> Uim (short for &quot;universal input method&quot;) is a
Uim (short for "universal input method") is a multilingual input method multilingual input method framework. Applications can use it
framework. Applications can use it through so-called bridges. through so-called bridges.
</para> </para>
<para>
<para> The following snippet can be used to configure uim:
The following snippet can be used to configure uim: </para>
</para> <programlisting>
<programlisting>
i18n.inputMethod = { i18n.inputMethod = {
enabled = "uim"; enabled = &quot;uim&quot;;
}; };
</programlisting> </programlisting>
<para>
<para> Note: The <xref linkend="opt-i18n.inputMethod.uim.toolbar"></xref>
Note: The <xref linkend="opt-i18n.inputMethod.uim.toolbar"/> option can be option can be used to choose uim toolbar.
used to choose uim toolbar. </para>
</para> </section>
</section> <section xml:id="module-services-input-methods-hime">
<section xml:id="module-services-input-methods-hime"> <title>Hime</title>
<title>Hime</title> <para>
Hime is an extremely easy-to-use input method framework. It is
<para> lightweight, stable, powerful and supports many commonly used
Hime is an extremely easy-to-use input method framework. It is lightweight, input methods, including Cangjie, Zhuyin, Dayi, Rank, Shrimp,
stable, powerful and supports many commonly used input methods, including Greek, Korean Pinyin, Latin Alphabet, etc...
Cangjie, Zhuyin, Dayi, Rank, Shrimp, Greek, Korean Pinyin, Latin Alphabet, </para>
etc... <para>
</para> The following snippet can be used to configure Hime:
</para>
<para> <programlisting>
The following snippet can be used to configure Hime:
</para>
<programlisting>
i18n.inputMethod = { i18n.inputMethod = {
enabled = "hime"; enabled = &quot;hime&quot;;
}; };
</programlisting> </programlisting>
</section> </section>
<section xml:id="module-services-input-methods-kime"> <section xml:id="module-services-input-methods-kime">
<title>Kime</title> <title>Kime</title>
<para>
<para> Kime is Korean IME. it's built with Rust language and let you get
Kime is Korean IME. it's built with Rust language and let you get simple, safe, fast Korean typing simple, safe, fast Korean typing
</para> </para>
<para>
<para> The following snippet can be used to configure Kime:
The following snippet can be used to configure Kime: </para>
</para> <programlisting>
<programlisting>
i18n.inputMethod = { i18n.inputMethod = {
enabled = "kime"; enabled = &quot;kime&quot;;
}; };
</programlisting> </programlisting>
</section> </section>
</chapter> </chapter>