deploy: cbc176010b

options.html

@@ -3817,6 +3817,57 @@ for the documentation.
 }
 </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/kitty.nix#blob-path" target="_top">
                     &lt;home-manager/modules/programs/kitty.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kodi.enable"></a><a class="term" href="options.html#opt-programs.kodi.enable"><code class="option">programs.kodi.enable</code></a></span></dt><dd><p>Whether to enable Kodi.</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/kodi.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/kodi.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kodi.package"></a><a class="term" href="options.html#opt-programs.kodi.package"><code class="option">programs.kodi.package</code></a></span></dt><dd><p>The <code class="literal">kodi</code> package to use.
+Can be used to specify extensions.
+</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.kodi</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{ pkgs.kodi.withPackages (exts: [ exts.pvr-iptvsimple ]) }
+</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/kodi.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/kodi.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kodi.addonSettings"></a><a class="term" href="options.html#opt-programs.kodi.addonSettings"><code class="option">programs.kodi.addonSettings</code></a></span></dt><dd><p>Attribute set with the plugin namespace as toplevel key and the plugins
+settings as lower level key/value pairs.
+</p><p>
+Kodi will still show the settings of plugins configured via this
+mechanism in the GUI and they appear to be mutable. This however is
+not the case and the settings will stay as specified via Home Manager.
+</p><p><span class="emphasis"><em>Type:</em></span> null or attribute set of attribute set of stringss</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{ "service.xbmc.versioncheck".versioncheck_enable = "false"; }
+</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/kodi.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/kodi.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kodi.datadir"></a><a class="term" href="options.html#opt-programs.kodi.datadir"><code class="option">programs.kodi.datadir</code></a></span></dt><dd><p>Directory to store configuration and metadata.</p><p><span class="emphasis"><em>Type:</em></span> path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"${config.home.homeDirectory}/.kodi"</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"${config.xdg.dataHome}/kodi"</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/kodi.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/kodi.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kodi.settings"></a><a class="term" href="options.html#opt-programs.kodi.settings"><code class="option">programs.kodi.settings</code></a></span></dt><dd><p>Configuration to write to the <code class="literal">advancedsettings.xml</code>
+file in kodis userdata directory. Settings specified here will be
+immutable from inside kodi and be hidden from the GUI settings dialog.
+</p><p>
+See <a class="link" href="https://kodi.wiki/view/Advancedsettings.xml" target="_top">https://kodi.wiki/view/Advancedsettings.xml</a> as
+reference for how settings need to be specified.
+</p><p>
+The innermost attributes must be of type str.
+</p><p><span class="emphasis"><em>Type:</em></span> null or attribute sets of strings</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{ videolibrary.showemptytvshows = "true"; }
+</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/kodi.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/kodi.nix&gt;
+                </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.kodi.sources"></a><a class="term" href="options.html#opt-programs.kodi.sources"><code class="option">programs.kodi.sources</code></a></span></dt><dd><p>Contents to populate the file <code class="literal">sources.xml</code> in kodis
+userdata directory.
+</p><p>
+See <a class="link" href="https://kodi.wiki/view/Sources.xml" target="_top">https://kodi.wiki/view/Sources.xml</a> as
+reference for how sources need to be specified.
+</p><p>
+Kodi will still show the dialogs to modify sources in the GUI and they
+appear to be mutable. This however is not the case and the sources will
+stay as specified via Home Manager.
+</p><p>
+The innermost attributes must be of type str.
+</p><p><span class="emphasis"><em>Type:</em></span> null or attribute sets or lists of strings</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
+  video = {
+    default = "movies";
+    source = [
+      { name = "videos"; path = "/path/to/videos"; allowsharing = "true"; }
+      { name = "movies"; path = "/path/to/movies"; allowsharing = "true"; }
+    ];
+  };
+}
+</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/kodi.nix#blob-path" target="_top">
+                    &lt;home-manager/modules/programs/kodi.nix&gt;
                 </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lazygit.enable"></a><a class="term" href="options.html#opt-programs.lazygit.enable"><code class="option">programs.lazygit.enable</code></a></span></dt><dd><p>Whether to enable lazygit, a simple terminal UI for git commands.</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/lazygit.nix#blob-path" target="_top">
                     &lt;home-manager/modules/programs/lazygit.nix&gt;
                 </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.lazygit.settings"></a><a class="term" href="options.html#opt-programs.lazygit.settings"><code class="option">programs.lazygit.settings</code></a></span></dt><dd><p>Configuration written to

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#idm140737309809776"><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#idm140737309781440"><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="idm140737309809776"></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="idm140737309781440"></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="idm140737309772336"></a><h2>Description</h2><p>
+   ]</p></div></div><div class="refsection"><a id="idm140737309744240"></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="idm140737309734640"></a><h2>Options</h2><p>
+  </p></div><div class="refsection"><a id="idm140737309706592"></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="idm140737309668464"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
+     </p></dd></dl></div></div><div class="refsection"><a id="idm140737309640320"></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="idm140737309665168"></a><h2>Bugs</h2><p>
+     </p></dd></dl></div></div><div class="refsection"><a id="idm140737309637024"></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="idm140737309663168"></a><h2>See also</h2><p>
+  </p></div><div class="refsection"><a id="idm140737309635024"></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>