diff --git a/nixos/doc/manual/configuration/configuration.xml b/nixos/doc/manual/configuration/configuration.xml index caba8fb1f4a..fb3f1498a9b 100644 --- a/nixos/doc/manual/configuration/configuration.xml +++ b/nixos/doc/manual/configuration/configuration.xml @@ -28,6 +28,7 @@ effect after you run nixos-rebuild. + diff --git a/nixos/doc/manual/default.nix b/nixos/doc/manual/default.nix index 746ddc071b6..7d26dd73a2b 100644 --- a/nixos/doc/manual/default.nix +++ b/nixos/doc/manual/default.nix @@ -58,6 +58,7 @@ let cp ${../../modules/services/databases/postgresql.xml} configuration/postgresql.xml cp ${../../modules/services/misc/gitlab.xml} configuration/gitlab.xml cp ${../../modules/security/acme.xml} configuration/acme.xml + cp ${../../modules/i18n/input-method/default.xml} configuration/input-methods.xml ln -s ${optionsDocBook} options-db.xml echo "${version}" > version ''; diff --git a/nixos/doc/manual/release-notes/rl-1603.xml b/nixos/doc/manual/release-notes/rl-1603.xml index 1528c8a7246..620c3e362a6 100644 --- a/nixos/doc/manual/release-notes/rl-1603.xml +++ b/nixos/doc/manual/release-notes/rl-1603.xml @@ -63,11 +63,11 @@ has the following highlights: services/monitoring/longview.nix hardware/video/webcam/facetimehd.nix - i18n/inputMethod/default.nix - i18n/inputMethod/fcitx.nix - i18n/inputMethod/ibus.nix - i18n/inputMethod/nabi.nix - i18n/inputMethod/uim.nix + i18n/input-method/default.nix + i18n/input-method/fcitx.nix + i18n/input-method/ibus.nix + i18n/input-method/nabi.nix + i18n/input-method/uim.nix programs/fish.nix security/acme.nix security/audit.nix diff --git a/nixos/modules/i18n/inputMethod/default.nix b/nixos/modules/i18n/input-method/default.nix similarity index 100% rename from nixos/modules/i18n/inputMethod/default.nix rename to nixos/modules/i18n/input-method/default.nix diff --git a/nixos/modules/i18n/input-method/default.xml b/nixos/modules/i18n/input-method/default.xml new file mode 100644 index 00000000000..c55ac1ec245 --- /dev/null +++ b/nixos/modules/i18n/input-method/default.xml @@ -0,0 +1,131 @@ + + +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. + + +
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. + +
+ +
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. + 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 + +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 + +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 i18n.inputMethod.uim.toolbar option can be + used to choose uim toolbar. + +
+ diff --git a/nixos/modules/i18n/inputMethod/fcitx.nix b/nixos/modules/i18n/input-method/fcitx.nix similarity index 100% rename from nixos/modules/i18n/inputMethod/fcitx.nix rename to nixos/modules/i18n/input-method/fcitx.nix diff --git a/nixos/modules/i18n/inputMethod/ibus.nix b/nixos/modules/i18n/input-method/ibus.nix similarity index 100% rename from nixos/modules/i18n/inputMethod/ibus.nix rename to nixos/modules/i18n/input-method/ibus.nix diff --git a/nixos/modules/i18n/inputMethod/nabi.nix b/nixos/modules/i18n/input-method/nabi.nix similarity index 100% rename from nixos/modules/i18n/inputMethod/nabi.nix rename to nixos/modules/i18n/input-method/nabi.nix diff --git a/nixos/modules/i18n/inputMethod/uim.nix b/nixos/modules/i18n/input-method/uim.nix similarity index 100% rename from nixos/modules/i18n/inputMethod/uim.nix rename to nixos/modules/i18n/input-method/uim.nix diff --git a/nixos/modules/module-list.nix b/nixos/modules/module-list.nix index 65f0ea9b65d..a23e787bd08 100644 --- a/nixos/modules/module-list.nix +++ b/nixos/modules/module-list.nix @@ -41,11 +41,11 @@ ./hardware/video/nvidia.nix ./hardware/video/ati.nix ./hardware/video/webcam/facetimehd.nix - ./i18n/inputMethod/default.nix - ./i18n/inputMethod/fcitx.nix - ./i18n/inputMethod/ibus.nix - ./i18n/inputMethod/nabi.nix - ./i18n/inputMethod/uim.nix + ./i18n/input-method/default.nix + ./i18n/input-method/fcitx.nix + ./i18n/input-method/ibus.nix + ./i18n/input-method/nabi.nix + ./i18n/input-method/uim.nix ./installer/tools/auto-upgrade.nix ./installer/tools/nixos-checkout.nix ./installer/tools/tools.nix diff --git a/nixos/modules/rename.nix b/nixos/modules/rename.nix index 84eccfd5129..aaec13d6bea 100644 --- a/nixos/modules/rename.nix +++ b/nixos/modules/rename.nix @@ -63,7 +63,7 @@ with lib; (mkRenamedOptionModule [ "services" "tarsnap" "config" ] [ "services" "tarsnap" "archives" ]) # ibus - (mkRenamedOptionModule [ "programs" "ibus" "plugins" ] [ "i18n" "inputMethod" "ibus" "engines" ]) + (mkRenamedOptionModule [ "programs" "ibus" "plugins" ] [ "i18n" "input-method" "ibus" "engines" ]) # proxy (mkRenamedOptionModule [ "nix" "proxy" ] [ "networking" "proxy" "default" ])