deploy: 7e2b1a42aa

options.html

@@ -1292,6 +1292,84 @@ undefined for state version ≥ 20.09
         "jane.doe"
       </code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/home-environment.nix#blob-path" target="_top">
                     &lt;home-manager/modules/home-environment.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-i18n.inputMethod.enabled"></a><a class="term" href="options.html#opt-i18n.inputMethod.enabled"><code class="option">i18n.inputMethod.enabled</code></a></span></dt><dd><p>Select the enabled input method. Input methods is a software to input
+symbols that are not available on standard input devices.
+</p><p>
+Input methods are specially used to input Chinese, Japanese and Korean
+characters.
+</p><p>
+Currently the following input methods are available in Home Manager:
+
+</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">fcitx</code></span></dt><dd><p>
+    A customizable lightweight input method
+    extra input engines can be added using
+    <code class="literal">i18n.inputMethod.fcitx.engines</code>.
+  </p></dd><dt><span class="term"><code class="literal">fcitx5</code></span></dt><dd><p>
+    The next generation of fcitx,
+    addons (including engines, dictionaries, skins) can be added using
+    <code class="literal">i18n.inputMethod.fcitx5.addons</code>.
+  </p></dd><dt><span class="term"><code class="literal">nabi</code></span></dt><dd><p>
+    A Korean input method based on XIM. Nabi doesn't support Qt 5.
+  </p></dd><dt><span class="term"><code class="literal">uim</code></span></dt><dd><p>
+    The universal input method, is a library with a XIM bridge.
+    uim mainly support Chinese, Japanese and Korean.
+  </p></dd><dt><span class="term"><code class="literal">hime</code></span></dt><dd><p>An extremely easy-to-use input method framework.</p></dd><dt><span class="term"><code class="literal">kime</code></span></dt><dd><p>A Korean IME.</p></dd></dl></div><p>
+</p><p><span class="emphasis"><em>Type:</em></span> null or one of "fcitx", "fcitx5", "nabi", "uim", "hime", "kime"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
+        null
+      </code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
+        "fcitx"
+      </code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/i18n/input-method/default.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/i18n/input-method/default.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-i18n.inputMethod.fcitx.engines"></a><a class="term" href="options.html#opt-i18n.inputMethod.fcitx.engines"><code class="option">i18n.inputMethod.fcitx.engines</code></a></span></dt><dd><p>Enabled Fcitx engines. Available engines are: <code class="literal">anthy</code>, <code class="literal">chewing</code>, <code class="literal">cloudpinyin</code>, <code class="literal">hangul</code>, <code class="literal">libpinyin</code>, <code class="literal">m17n</code>, <code class="literal">mozc</code>, <code class="literal">rime</code>, <code class="literal">skk</code>, <code class="literal">table-extra</code>, <code class="literal">table-other</code>, <code class="literal">unikey</code>.</p><p><span class="emphasis"><em>Type:</em></span> list of packages</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
+        
+        [
+        
+        ]
+    
+      </code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">with pkgs.fcitx-engines; [ mozc hangul ]</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/i18n/input-method/fcitx.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/i18n/input-method/fcitx.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-i18n.inputMethod.fcitx5.addons"></a><a class="term" href="options.html#opt-i18n.inputMethod.fcitx5.addons"><code class="option">i18n.inputMethod.fcitx5.addons</code></a></span></dt><dd><p>Enabled Fcitx5 addons.
+</p><p><span class="emphasis"><em>Type:</em></span> list of packages</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
+        
+        [
+        
+        ]
+    
+      </code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">with pkgs; [ fcitx5-rime ]</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/i18n/input-method/fcitx5.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/i18n/input-method/fcitx5.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-i18n.inputMethod.kime.config"></a><a class="term" href="options.html#opt-i18n.inputMethod.kime.config"><code class="option">i18n.inputMethod.kime.config</code></a></span></dt><dd><p>kime configuration. Refer to
+<a class="link" href="https://github.com/Riey/kime/blob/develop/docs/CONFIGURATION.md" target="_top">https://github.com/Riey/kime/blob/develop/docs/CONFIGURATION.md</a>
+for details on supported values.
+</p><p><span class="emphasis"><em>Type:</em></span> YAML value</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
+        
+        {
+        
+        }
+    
+      </code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
+  daemon = {
+    modules = ["Xim" "Indicator"];
+  };
+
+  indicator = {
+    icon_color = "White";
+  };
+
+  engine = {
+    hangul = {
+      layout = "dubeolsik";
+    };
+  };
+}
+</pre><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/i18n/input-method/kime.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/i18n/input-method/kime.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-i18n.inputMethod.uim.toolbar"></a><a class="term" href="options.html#opt-i18n.inputMethod.uim.toolbar"><code class="option">i18n.inputMethod.uim.toolbar</code></a></span></dt><dd><p>Selected UIM toolbar.
+</p><p><span class="emphasis"><em>Type:</em></span> one of "gtk", "gtk3", "gtk-systray", "gtk3-systray", "qt4"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
+        "gtk"
+      </code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">
+        "gtk-systray"
+      </code></p><p><span class="emphasis"><em>Declared by:</em></span></p><table border="0" summary="Simple list" class="simplelist"><tr><td><code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/i18n/input-method/uim.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/i18n/input-method/uim.nix&gt;
                 </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-lib"></a><a class="term" href="options.html#opt-lib"><code class="option">lib</code></a></span></dt><dd><p>This option allows modules to define helper functions,
 constants, etc.
 </p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute sets</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">

tools.html

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix D. Tools</title><link rel="stylesheet" type="text/css" href="style.css" /><link rel="stylesheet" type="text/css" href="overrides.css" /><link rel="stylesheet" type="text/css" href="mono-blue.css" /><script src="highlight.pack.js" type="text/javascript"></script><script src="highlight.load.js" type="text/javascript"></script><meta name="generator" content="DocBook XSL Stylesheets V1.79.2" /><link rel="home" href="index.html" title="Home Manager Manual" /><link rel="up" href="index.html" title="Home Manager Manual" /><link rel="prev" href="nix-darwin-options.html" title="Appendix C. nix-darwin Module Options" /><link rel="next" href="release-notes.html" title="Appendix E. Release Notes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix D. Tools</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="nix-darwin-options.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="release-notes.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="ch-tools"></a>Appendix D. Tools</h1></div></div></div><div class="toc"><dl class="toc"><dt><span class="refentrytitle"><a href="tools.html#idm140737311005952"><span class="command"><strong>home-manager</strong></span>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix D. Tools</title><link rel="stylesheet" type="text/css" href="style.css" /><link rel="stylesheet" type="text/css" href="overrides.css" /><link rel="stylesheet" type="text/css" href="mono-blue.css" /><script src="highlight.pack.js" type="text/javascript"></script><script src="highlight.load.js" type="text/javascript"></script><meta name="generator" content="DocBook XSL Stylesheets V1.79.2" /><link rel="home" href="index.html" title="Home Manager Manual" /><link rel="up" href="index.html" title="Home Manager Manual" /><link rel="prev" href="nix-darwin-options.html" title="Appendix C. nix-darwin Module Options" /><link rel="next" href="release-notes.html" title="Appendix E. Release Notes" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix D. Tools</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="nix-darwin-options.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="release-notes.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="ch-tools"></a>Appendix D. Tools</h1></div></div></div><div class="toc"><dl class="toc"><dt><span class="refentrytitle"><a href="tools.html#idm140737310957840"><span class="command"><strong>home-manager</strong></span>
-  </a></span><span class="refpurpose"> — reconfigure a user environment</span></dt></dl></div><div class="refentry"><a id="idm140737311005952"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p><span class="command"><strong>home-manager</strong></span>
+  </a></span><span class="refpurpose"> — reconfigure a user environment</span></dt></dl></div><div class="refentry"><a id="idm140737310957840"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p><span class="command"><strong>home-manager</strong></span>
    — reconfigure a user environment</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">home-manager</code>  { 
     build
      |   
@@ -78,7 +78,7 @@
       |   
      --verbose
      }
-   ]</p></div></div><div class="refsection"><a id="idm140737310969904"></a><h2>Description</h2><p>
+   ]</p></div></div><div class="refsection"><a id="idm140737310921744"></a><h2>Description</h2><p>
    This command updates the user environment so that it corresponds to the
       configuration specified in <code class="filename">~/.config/nixpkgs/home.nix</code> or <code class="filename">~/.config/nixpkgs/flake.nix</code>.
   </p><p>
@@ -147,7 +147,7 @@
           available for immediate garbage collection.
          </p></li></ul></div><p>
       </p></dd></dl></div><p>
-  </p></div><div class="refsection"><a id="idm140737310932256"></a><h2>Options</h2><p>
+  </p></div><div class="refsection"><a id="idm140737310884096"></a><h2>Options</h2><p>
    The tool accepts the options
   </p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
      <code class="option">-A <em class="replaceable"><code>attrPath</code></em></code>
@@ -246,15 +246,15 @@
      <code class="option">--verbose</code>
     </span></dt><dd><p>
       Activates verbose output.
-     </p></dd></dl></div></div><div class="refsection"><a id="idm140737310875488"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
+     </p></dd></dl></div></div><div class="refsection"><a id="idm140737310827328"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
      <code class="filename">~/.local/share/home-manager/news-read-ids</code>
     </span></dt><dd><p>
       Identifiers of news items that have been shown. Can be deleted to reset
       the read news indicator.
-     </p></dd></dl></div></div><div class="refsection"><a id="idm140737310872192"></a><h2>Bugs</h2><p>
+     </p></dd></dl></div></div><div class="refsection"><a id="idm140737310824032"></a><h2>Bugs</h2><p>
    Please report any bugs on the
    <a class="link" href="https://github.com/nix-community/home-manager/issues" target="_top">project
    issue tracker</a>.
-  </p></div><div class="refsection"><a id="idm140737310870192"></a><h2>See also</h2><p>
+  </p></div><div class="refsection"><a id="idm140737310822032"></a><h2>See also</h2><p>
    <span class="citerefentry"><span class="refentrytitle">home-configuration.nix</span>(5)</span>
   </p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="nix-darwin-options.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="release-notes.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Appendix C. nix-darwin Module Options </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Appendix E. Release Notes</td></tr></table></div></body></html>