Skip to content

I18n

I18N

i18n.defaultLocale

The default locale. It determines the language for program messages, the format for dates and times, sort order, and so on. It also determines the character set, such as UTF-8.

Type: string

Default

"en_US.UTF-8"

Example

"nl_NL.UTF-8"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/config/i18n.nix

i18n.extraLocaleSettings

A set of additional system-wide locale settings other than LANG which can be configured with {option}i18n.defaultLocale.

Type: attribute set of string

Default

{ }

Example

{LC_MESSAGES = "en_US.UTF-8";LC_TIME = "de_DE.UTF-8";}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/config/i18n.nix

i18n.glibcLocales

Customized pkg.glibcLocales package.

Changing this option can disable handling of i18n.defaultLocale and supportedLocale.

Type: path

Default

pkgs.glibcLocales.override {allLocales = any (x: x == "all") config.i18n.supportedLocales;locales = config.i18n.supportedLocales;}

Example

pkgs.glibcLocales

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/config/i18n.nix

i18n.inputMethod.enable

Whether to enable an additional input method type. Type: boolean

Default

true if the deprecated option enabled is set, false otherwise

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/default.nix

i18n.inputMethod.enabled

Deprecated - use type and enable = true instead Type: null or one of "ibus", "fcitx5", "nabi", "uim", "hime", "kime"

Default

null

Example

"fcitx5"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/default.nix

i18n.inputMethod.fcitx5.addons

Enabled Fcitx5 addons.

Type: list of package

Default

[ ]

Example

with pkgs; [ fcitx5-rime ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/fcitx5.nix

i18n.inputMethod.fcitx5.ignoreUserConfig

Ignore the user configures. Warning: When this is enabled, the user config files are totally ignored and the user dict can't be saved and loaded.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/fcitx5.nix

i18n.inputMethod.fcitx5.plasma6Support

Use qt6 versions of fcitx5 packages. Required for configuring fcitx5 in KDE System Settings.

Type: boolean

Default

config.services.desktopManager.plasma6.enable

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/fcitx5.nix

i18n.inputMethod.fcitx5.quickPhrase

Quick phrases. Type: attribute set of string

Default

{ }

Example

{smile = "(・∀・)";angry = "( ̄ー ̄)";}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/fcitx5.nix

i18n.inputMethod.fcitx5.quickPhraseFiles

Quick phrase files. Type: attribute set of path

Default

{ }

Example

{words = ./words.mb;numbers = ./numbers.mb;}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/fcitx5.nix

i18n.inputMethod.fcitx5.settings.addons

The addon configures in conf folder in ini format with global sections. Each item is written to the corresponding file.

Type: attribute set of anything

Default

{ }

Example

{ pinyin.globalSection.EmojiEnabled = "True"; }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/fcitx5.nix

i18n.inputMethod.fcitx5.settings.globalOptions

The global options in config file in ini format.

Type: attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/fcitx5.nix

i18n.inputMethod.fcitx5.settings.inputMethod

The input method configure in profile file in ini format.

Type: attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/fcitx5.nix

i18n.inputMethod.fcitx5.waylandFrontend

Use the Wayland input method frontend. See Using Fcitx 5 on Wayland.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/fcitx5.nix

i18n.inputMethod.type

Select the enabled input method. Input methods is a software to input symbols that are not available on standard input devices.

Input methods are specially used to input Chinese, Japanese and Korean characters.

Currently the following input methods are available in NixOS:

  • ibus: The intelligent input bus, extra input engines can be added using i18n.inputMethod.ibus.engines.
  • fcitx5: The next generation of fcitx, addons (including engines, dictionaries, skins) can be added using i18n.inputMethod.fcitx5.addons.
  • nabi: A Korean input method based on XIM. Nabi doesn't support Qt 5.
  • uim: The universal input method, is a library with a XIM bridge. uim mainly support Chinese, Japanese and Korean.
  • hime: An extremely easy-to-use input method framework.
  • kime: Koream IME.

Type: null or one of "ibus", "fcitx5", "nabi", "uim", "hime", "kime"

Default

The value of the deprecated option enabled, defaulting to null

Example

"fcitx5"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/default.nix

i18n.inputMethod.uim.toolbar

selected UIM toolbar.

Type: one of "gtk", "gtk3", "gtk-systray", "gtk3-systray", "qt5"

Default

"gtk"

Example

"gtk-systray"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/uim.nix

i18n.supportedLocales

List of locales that the system should support. The value "all" means that all locales supported by Glibc will be installed. A full list of supported locales can be found at https://sourceware.org/git/?p=glibc.git;a=blob;f=localedata/SUPPORTED.

Type: list of string

Default

unique(builtins.map (l: (replaceStrings [ "utf8" "utf-8" "UTF8" ] [ "UTF-8" "UTF-8" "UTF-8" ] l) + "/UTF-8") (["C.UTF-8""en_US.UTF-8"config.i18n.defaultLocale] ++ (attrValues (filterAttrs (n: v: n != "LANGUAGE") config.i18n.extraLocaleSettings))))

Example

["en_US.UTF-8/UTF-8""nl_NL.UTF-8/UTF-8""nl_NL/ISO-8859-1"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/config/i18n.nix

i18n.inputMethod.ibus.engines

Enabled IBus engines. Available engines are: anthy, bamboo, cangjie, hangul, kkc, libpinyin, libthai, m17n, mozc, openbangla-keyboard, pinyin, rime, table, table-chinese, table-others, typing-booster, typing-booster-unwrapped, uniemoji. Type: list of ibus-engine

Default

[ ]

Example

with pkgs.ibus-engines; [ mozc hangul ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/ibus.nix

i18n.inputMethod.ibus.panel

Replace the IBus panel with another panel. Type: null or path

Default

null

Example

"${pkgs.plasma5Packages.plasma-desktop}/libexec/kimpanel-ibus-panel"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/ibus.nix

i18n.inputMethod.kime.daemonModules

List of enabled daemon modules

Type: list of (one of "Xim", "Wayland", "Indicator")

Default

["Xim""Wayland""Indicator"]

Example

["Xim""Indicator"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/kime.nix

i18n.inputMethod.kime.extraConfig

extra kime configuration. Refer to https://github.com/Riey/kime/blob/v3.0.2/docs/CONFIGURATION.md for details on supported values.

Type: strings concatenated with "\n"

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/kime.nix

i18n.inputMethod.kime.iconColor

Color of the indicator icon

Type: one of "Black", "White"

Default

"Black"

Example

"White"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/i18n/input-method/kime.nix