deploy: 6ec6b2e362

options.html

@@ -5798,6 +5798,47 @@ use Python 3 plugins.
                     <home-manager/modules/programs/newsboat.nix>
                 </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.newsboat.urls._.url"></a><a class="term" href="options.html#opt-programs.newsboat.urls._.url"><code class="option">programs.newsboat.urls.*.url</code></a></span></dt><dd><p>Feed URL.</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"http://example.com"</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/programs/newsboat.nix#blob-path" target="_top">
                     &lt;home-manager/modules/programs/newsboat.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nheko.enable"></a><a class="term" href="options.html#opt-programs.nheko.enable"><code class="option">programs.nheko.enable</code></a></span></dt><dd><p>Whether to enable Qt desktop client for Matrix.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</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/programs/nheko.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/nheko.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nheko.package"></a><a class="term" href="options.html#opt-programs.nheko.package"><code class="option">programs.nheko.package</code></a></span></dt><dd><p>The nheko package to use.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.nheko</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/programs/nheko.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/nheko.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nheko.settings"></a><a class="term" href="options.html#opt-programs.nheko.settings"><code class="option">programs.nheko.settings</code></a></span></dt><dd><p>Attribute set of Nheko preferences (converted to an INI file).
+
+</p><p>
+
+For now, it is recommended to run nheko and sign-in before filling in
+the configuration settings in this module, as nheko writes the access
+token to <code class="filename">$XDG_CONFIG_HOME/nheko/nheko.conf</code> the
+first time we sign in, and we need that data into these settings for the
+correct functionality of the application.
+
+</p><p>
+
+This a temporary inconvenience, however, as nheko has plans to move the
+authentication stuff into the local database they currently use. Once
+this happens, this will no longer be an issue.
+</p><p><span class="emphasis"><em>Type:</em></span> attribute set of attribute set of INI atom (null, bool, int, float or string)</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">{
+  general.disableCertificateValidation = false;
+  auth = {
+    accessToken = "SECRET";
+    deviceId = "MY_DEVICE";
+    homeServer = "https://matrix-client.matrix.org:443";
+    userId = "@@user:matrix.org";
+  };
+  settings.scaleFactor = 1.0;
+  sidebar.width = 416;
+  user = {
+    alertOnNotification = true;
+    animateImagesOnHover = false;
+    "sidebar\\roomListWidth" = 308;
+  };
+}
+</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/programs/nheko.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/nheko.nix&gt;
                 </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nix-index.enable"></a><a class="term" href="options.html#opt-programs.nix-index.enable"><code class="option">programs.nix-index.enable</code></a></span></dt><dd><p>Whether to enable nix-index, a file database for nixpkgs.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">false</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</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/programs/nix-index.nix#blob-path" target="_top">
                     &lt;home-manager/modules/programs/nix-index.nix&gt;
                 </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nix-index.enableBashIntegration"></a><a class="term" href="options.html#opt-programs.nix-index.enableBashIntegration"><code class="option">programs.nix-index.enableBashIntegration</code></a></span></dt><dd><p>Whether to enable Bash integration.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">true</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">true</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/programs/nix-index.nix#blob-path" target="_top">

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#idm140737307913488"><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#idm140737307888608"><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="idm140737307913488"></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="idm140737307888608"></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
      |   
@@ -84,7 +84,7 @@
       |   
      --verbose
      }
-   ]</p></div></div><div class="refsection"><a id="idm140737307876096"></a><h2>Description</h2><p>
+   ]</p></div></div><div class="refsection"><a id="idm140737307851264"></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>
@@ -153,7 +153,7 @@
           available for immediate garbage collection.
          </p></li></ul></div><p>
       </p></dd></dl></div><p>
-  </p></div><div class="refsection"><a id="idm140737307838448"></a><h2>Options</h2><p>
+  </p></div><div class="refsection"><a id="idm140737307813664"></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>
@@ -265,15 +265,15 @@
      <code class="option">--verbose</code>
     </span></dt><dd><p>
       Activates verbose output.
-     </p></dd></dl></div></div><div class="refsection"><a id="idm140737307772176"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
+     </p></dd></dl></div></div><div class="refsection"><a id="idm140737307747488"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
      <code class="filename">$XDG_DATA_HOME/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="idm140737307768880"></a><h2>Bugs</h2><p>
+     </p></dd></dl></div></div><div class="refsection"><a id="idm140737307744192"></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="idm140737307766880"></a><h2>See also</h2><p>
+  </p></div><div class="refsection"><a id="idm140737307742192"></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>