1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-30 15:09:46 +01:00
This commit is contained in:
sumnerevans 2021-06-07 13:41:18 +00:00
parent 8a56f90268
commit f70e5068aa
3 changed files with 47 additions and 9 deletions

File diff suppressed because one or more lines are too long

View file

@ -6864,6 +6864,44 @@ substituting numeric shortcuts for files.</p><p><span class="emphasis"><em>Type:
pkgs.scmpuff pkgs.scmpuff
</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/scmpuff.nix#blob-path" target="_top"> </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/scmpuff.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/scmpuff.nix&gt; &lt;home-manager/modules/programs/scmpuff.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.senpai.enable"></a><a class="term" href="options.html#opt-programs.senpai.enable"><code class="option">programs.senpai.enable</code></a></span></dt><dd><p>Whether to enable senpai.</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/senpai.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/senpai.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.senpai.package"></a><a class="term" href="options.html#opt-programs.senpai.package"><code class="option">programs.senpai.package</code></a></span></dt><dd><p>The <code class="literal">senpai</code> 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.senpai
</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/senpai.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/senpai.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.senpai.config"></a><a class="term" href="options.html#opt-programs.senpai.config"><code class="option">programs.senpai.config</code></a></span></dt><dd><p>Configuration for senpai. For a complete list of options, see
<span class="citerefentry"><span class="refentrytitle">senpai</span>(5)</span>.
</p><p><span class="emphasis"><em>Type:</em></span> YAML value</p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
addr = "libera.chat:6697";
nick = "nicholas";
password = "verysecurepassword";
}
</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/senpai.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/senpai.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.senpai.config.addr"></a><a class="term" href="options.html#opt-programs.senpai.config.addr"><code class="option">programs.senpai.config.addr</code></a></span></dt><dd><p>The address (host[:port]) of the IRC server. senpai uses TLS
connections by default unless you specify no-tls option. TLS
connections default to port 6697, plain-text use port 6667.
</p><p><span class="emphasis"><em>Type:</em></span> string</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/senpai.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/senpai.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.senpai.config.nick"></a><a class="term" href="options.html#opt-programs.senpai.config.nick"><code class="option">programs.senpai.config.nick</code></a></span></dt><dd><p>Your nickname, sent with a NICK IRC message. It mustn't contain
spaces or colons (:).
</p><p><span class="emphasis"><em>Type:</em></span> string</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/senpai.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/senpai.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.senpai.config.no-tls"></a><a class="term" href="options.html#opt-programs.senpai.config.no-tls"><code class="option">programs.senpai.config.no-tls</code></a></span></dt><dd><p>Disables TLS encryption.</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>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/senpai.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/senpai.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.senpai.config.password"></a><a class="term" href="options.html#opt-programs.senpai.config.password"><code class="option">programs.senpai.config.password</code></a></span></dt><dd><p>Your password, used for SASL authentication. Note that it will
reside world-readable in the Nix store.
</p><p><span class="emphasis"><em>Type:</em></span> null or string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
null
</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/senpai.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/senpai.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.skim.enable"></a><a class="term" href="options.html#opt-programs.skim.enable"><code class="option">programs.skim.enable</code></a></span></dt><dd><p>Whether to enable skim - a command-line fuzzy finder.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal"> </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.skim.enable"></a><a class="term" href="options.html#opt-programs.skim.enable"><code class="option">programs.skim.enable</code></a></span></dt><dd><p>Whether to enable skim - a command-line fuzzy finder.</p><p><span class="emphasis"><em>Type:</em></span> boolean</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
false false
</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal"> </code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">

View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <?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#idm140737311257632"><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#idm140737311217904"><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="idm140737311257632"></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="idm140737311217904"></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> { — reconfigure a user environment</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">home-manager</code> {
build build
| |
@ -76,7 +76,7 @@
| |
--verbose --verbose
} }
]</p></div></div><div class="refsection"><a id="idm140737311222688"></a><h2>Description</h2><p> ]</p></div></div><div class="refsection"><a id="idm140737311183008"></a><h2>Description</h2><p>
This command updates the user environment so that it corresponds to the 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>. configuration specified in <code class="filename">~/.config/nixpkgs/home.nix</code> or <code class="filename">~/.config/nixpkgs/flake.nix</code>.
</p><p> </p><p>
@ -141,7 +141,7 @@
available for immediate garbage collection. available for immediate garbage collection.
</p></li></ul></div><p> </p></li></ul></div><p>
</p></dd></dl></div><p> </p></dd></dl></div><p>
</p></div><div class="refsection"><a id="idm140737311188576"></a><h2>Options</h2><p> </p></div><div class="refsection"><a id="idm140737311148896"></a><h2>Options</h2><p>
The tool accepts the options The tool accepts the options
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> </p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
<code class="option">-A <em class="replaceable"><code>attrPath</code></em></code> <code class="option">-A <em class="replaceable"><code>attrPath</code></em></code>
@ -240,15 +240,15 @@
<code class="option">--verbose</code> <code class="option">--verbose</code>
</span></dt><dd><p> </span></dt><dd><p>
Activates verbose output. Activates verbose output.
</p></dd></dl></div></div><div class="refsection"><a id="idm140737311131856"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"> </p></dd></dl></div></div><div class="refsection"><a id="idm140737311092032"></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> <code class="filename">~/.local/share/home-manager/news-read-ids</code>
</span></dt><dd><p> </span></dt><dd><p>
Identifiers of news items that have been shown. Can be deleted to reset Identifiers of news items that have been shown. Can be deleted to reset
the read news indicator. the read news indicator.
</p></dd></dl></div></div><div class="refsection"><a id="idm140737311128560"></a><h2>Bugs</h2><p> </p></dd></dl></div></div><div class="refsection"><a id="idm140737311088736"></a><h2>Bugs</h2><p>
Please report any bugs on the Please report any bugs on the
<a class="link" href="https://github.com/nix-community/home-manager/issues" target="_top">project <a class="link" href="https://github.com/nix-community/home-manager/issues" target="_top">project
issue tracker</a>. issue tracker</a>.
</p></div><div class="refsection"><a id="idm140737311126560"></a><h2>See also</h2><p> </p></div><div class="refsection"><a id="idm140737311086736"></a><h2>See also</h2><p>
<span class="citerefentry"><span class="refentrytitle">home-configuration.nix</span>(5)</span> <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> </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>