diff --git a/index.html b/index.html index 98c194211..173838be1 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -Home Manager Manual

Home Manager Manual


Preface
1. Installing Home Manager
1.1. Standalone installation
1.2. NixOS module
1.3. nix-darwin module
2. Writing Home Manager Modules
2.1. Option Types
3. Contributing
3.1. Getting started
3.2. Guidelines
3.2.1. Maintain backward compatibility
3.2.2. Keep forward compatibility in mind
3.2.3. Add only valuable options
3.2.4. Add relevant tests
3.2.5. Add relevant documentation
3.2.6. Add yourself as a module maintainer
3.2.7. Format your code
3.2.8. Format your commit messages
3.2.9. Format your news entries
3.2.10. Use conditional modules and news
3.2.11. Mind the license
3.3. Commits
3.4. Code Style
3.5. News
3.6. Tests
4. Frequently Asked Questions (FAQ)
4.1. Why is there a collision error when switching generation?
4.2. Why are the session variables not set?
4.3. How to set up a configuration for multiple users/machines?
4.4. Why do I get an error message about ca.desrt.dconf?
4.5. How do I install packages from Nixpkgs unstable?
4.6. How do I override the package used by a module?
A. Configuration Options
B. NixOS Module Options
C. nix-darwin Module Options
D. Tools
home-manager - — reconfigure a user environment
E. Release Notes
E.1. Release 21.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.09
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.03
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 18.09

Preface

+Home Manager Manual

Home Manager Manual


Preface
1. Installing Home Manager
1.1. Standalone installation
1.2. NixOS module
1.3. nix-darwin module
2. Writing Home Manager Modules
2.1. Option Types
3. Contributing
3.1. Getting started
3.2. Guidelines
3.2.1. Maintain backward compatibility
3.2.2. Keep forward compatibility in mind
3.2.3. Add only valuable options
3.2.4. Add relevant tests
3.2.5. Add relevant documentation
3.2.6. Add yourself as a module maintainer
3.2.7. Format your code
3.2.8. Format your commit messages
3.2.9. Format your news entries
3.2.10. Use conditional modules and news
3.2.11. Mind the license
3.3. Commits
3.4. Code Style
3.5. News
3.6. Tests
4. Frequently Asked Questions (FAQ)
4.1. Why is there a collision error when switching generation?
4.2. Why are the session variables not set?
4.3. How to set up a configuration for multiple users/machines?
4.4. Why do I get an error message about ca.desrt.dconf?
4.5. How do I install packages from Nixpkgs unstable?
4.6. How do I override the package used by a module?
A. Configuration Options
B. NixOS Module Options
C. nix-darwin Module Options
D. Tools
home-manager + — reconfigure a user environment
E. Release Notes
E.1. Release 21.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.09
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.03
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 18.09

Preface

This manual will eventually describes how to install, use, and extend Home Manager.

diff --git a/options.html b/options.html index d390d57f9..e485e9874 100644 --- a/options.html +++ b/options.html @@ -1292,6 +1292,84 @@ undefined for state version ≥ 20.09 "jane.doe"

Declared by:

<home-manager/modules/home-environment.nix> +
i18n.inputMethod.enabled

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 Home Manager: + +

fcitx

+ A customizable lightweight input method + extra input engines can be added using + i18n.inputMethod.fcitx.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

A Korean IME.

+

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

Default: + null +

Example: + "fcitx" +

Declared by:

+ <home-manager/modules/i18n/input-method/default.nix> +
i18n.inputMethod.fcitx.engines

Enabled Fcitx engines. Available engines are: anthy, chewing, cloudpinyin, hangul, libpinyin, m17n, mozc, rime, skk, table-extra, table-other, unikey.

Type: list of packages

Default: + + [ + + ] + +

Example:

with pkgs.fcitx-engines; [ mozc hangul ]

Declared by:

+ <home-manager/modules/i18n/input-method/fcitx.nix> +
i18n.inputMethod.fcitx5.addons

Enabled Fcitx5 addons. +

Type: list of packages

Default: + + [ + + ] + +

Example:

with pkgs; [ fcitx5-rime ]

Declared by:

+ <home-manager/modules/i18n/input-method/fcitx5.nix> +
i18n.inputMethod.kime.config

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

Type: YAML value

Default: + + { + + } + +

Example:

{
+  daemon = {
+    modules = ["Xim" "Indicator"];
+  };
+
+  indicator = {
+    icon_color = "White";
+  };
+
+  engine = {
+    hangul = {
+      layout = "dubeolsik";
+    };
+  };
+}
+

Declared by:

+ <home-manager/modules/i18n/input-method/kime.nix> +
i18n.inputMethod.uim.toolbar

Selected UIM toolbar. +

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

Default: + "gtk" +

Example: + "gtk-systray" +

Declared by:

+ <home-manager/modules/i18n/input-method/uim.nix>
lib

This option allows modules to define helper functions, constants, etc.

Type: attribute set of attribute sets

Default: diff --git a/tools.html b/tools.html index 18a2a4592..45cf60f16 100644 --- a/tools.html +++ b/tools.html @@ -1,6 +1,6 @@ -Appendix D. Tools

Appendix D. Tools

home-manager - — reconfigure a user environment

Name

home-manager +Appendix D. Tools

Appendix D. Tools

home-manager + — reconfigure a user environment

Name

home-manager — reconfigure a user environment

Synopsis

home-manager { build | @@ -78,7 +78,7 @@ | --verbose } - ]

Description

+ ]

Description

This command updates the user environment so that it corresponds to the configuration specified in ~/.config/nixpkgs/home.nix or ~/.config/nixpkgs/flake.nix.

@@ -147,7 +147,7 @@ available for immediate garbage collection.

-

Options

+

Options

The tool accepts the options

-A attrPath @@ -246,15 +246,15 @@ --verbose

Activates verbose output. -

Files

+

Files

~/.local/share/home-manager/news-read-ids

Identifiers of news items that have been shown. Can be deleted to reset the read news indicator. -

Bugs

+

Bugs

Please report any bugs on the project issue tracker. -

See also

+

See also

home-configuration.nix(5)

\ No newline at end of file