eeva/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-30 15:09:46 +01:00
Code Issues Releases Wiki Activity

deploy: 931e610552

Browse source
This commit is contained in:
rycee 2022-06-20 22:52:32 +00:00
parent 894e7a5e97
commit ef9e6148a5
3 changed files with 39 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
index.html
View file

File diff suppressed because one or more lines are too long

42
options.html
View file

@ -5610,24 +5610,40 @@ exclusion.
<home-manager/modules/programs/nushell.nix> <home-manager/modules/programs/nushell.nix>
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nushell.package"></a><a class="term" href="options.html#opt-programs.nushell.package"><code class="option">programs.nushell.package</code></a></span></dt><dd><p>The package to use for nushell.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.nushell</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/nushell.nix#blob-path" target="_top"> </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nushell.package"></a><a class="term" href="options.html#opt-programs.nushell.package"><code class="option">programs.nushell.package</code></a></span></dt><dd><p>The package to use for nushell.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.nushell</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/nushell.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/nushell.nix&gt; &lt;home-manager/modules/programs/nushell.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nushell.settings"></a><a class="term" href="options.html#opt-programs.nushell.settings"><code class="option">programs.nushell.settings</code></a></span></dt><dd><p>Configuration written to </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nushell.configFile"></a><a class="term" href="options.html#opt-programs.nushell.configFile"><code class="option">programs.nushell.configFile</code></a></span></dt><dd><p>The configuration file to be used for nushell.
<code class="filename">$XDG_CONFIG_HOME/nushell/config.toml</code>.
</p><p> </p><p>
See <a class="link" href="https://www.nushell.sh/book/configuration.html" target="_top">https://www.nushell.sh/book/configuration.html</a> for the full list See <a class="link" href="https://www.nushell.sh/book/configuration.html#configuration" target="_top">https://www.nushell.sh/book/configuration.html#configuration</a> for more information.
of options. </p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{ text = ''
</p><p><span class="emphasis"><em>Type:</em></span> Nushell configuration</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal"> let $config = {
{ filesize_metric: false
table_mode: rounded
use_ls_colors: true
} }
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{ '';
edit_mode = "vi";
startup = [ "alias la [] { ls -a }" "alias e [msg] { echo $msg }" ];
key_timeout = 10;
completion_mode = "circular";
no_auto_pivot = 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/nushell.nix#blob-path" target="_top"> </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/nushell.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/nushell.nix&gt; &lt;home-manager/modules/programs/nushell.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nushell.configFile.source"></a><a class="term" href="options.html#opt-programs.nushell.configFile.source"><code class="option">programs.nushell.configFile.source</code></a></span></dt><dd><p>Path of the nushell <code class="filename">config.nu</code> file to use.
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">file containing text</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/nushell.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/nushell.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nushell.configFile.text"></a><a class="term" href="options.html#opt-programs.nushell.configFile.text"><code class="option">programs.nushell.configFile.text</code></a></span></dt><dd><p>Text of the nushell <code class="filename">config.nu</code> file.
If unset then the source option will be preferred.
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</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/nushell.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/nushell.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nushell.envFile"></a><a class="term" href="options.html#opt-programs.nushell.envFile"><code class="option">programs.nushell.envFile</code></a></span></dt><dd><p>The environment variables file to be used for nushell.
</p><p>
See <a class="link" href="https://www.nushell.sh/book/configuration.html#configuration" target="_top">https://www.nushell.sh/book/configuration.html#configuration</a> for more information.
</p><p><span class="emphasis"><em>Type:</em></span> submodule</p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">''
let-env FOO = 'BAR'
''</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/nushell.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/nushell.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nushell.envFile.source"></a><a class="term" href="options.html#opt-programs.nushell.envFile.source"><code class="option">programs.nushell.envFile.source</code></a></span></dt><dd><p>Path of the nushell <code class="filename">env.nu</code> file to use.
</p><p><span class="emphasis"><em>Type:</em></span> null or path</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">file containing text</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/nushell.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/nushell.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.nushell.envFile.text"></a><a class="term" href="options.html#opt-programs.nushell.envFile.text"><code class="option">programs.nushell.envFile.text</code></a></span></dt><dd><p>Text of the nushell <code class="filename">env.nu</code> file.
If unset then the source option will be preferred.
</p><p><span class="emphasis"><em>Type:</em></span> strings concatenated with "\n"</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">""</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/nushell.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/nushell.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.obs-studio.enable"></a><a class="term" href="options.html#opt-programs.obs-studio.enable"><code class="option">programs.obs-studio.enable</code></a></span></dt><dd><p>Whether to enable obs-studio.</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/obs-studio.nix#blob-path" target="_top"> </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.obs-studio.enable"></a><a class="term" href="options.html#opt-programs.obs-studio.enable"><code class="option">programs.obs-studio.enable</code></a></span></dt><dd><p>Whether to enable obs-studio.</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/obs-studio.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/obs-studio.nix&gt; &lt;home-manager/modules/programs/obs-studio.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.obs-studio.package"></a><a class="term" href="options.html#opt-programs.obs-studio.package"><code class="option">programs.obs-studio.package</code></a></span></dt><dd><p>OBS Studio package to install. </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.obs-studio.package"></a><a class="term" href="options.html#opt-programs.obs-studio.package"><code class="option">programs.obs-studio.package</code></a></span></dt><dd><p>OBS Studio package to install.

14
tools.html
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#idm140737308436288"><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#idm140737308421008"><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="idm140737308436288"></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="idm140737308421008"></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
| |
@ -84,7 +84,7 @@
| |
--verbose --verbose
} }
]</p></div></div><div class="refsection"><a id="idm140737308398944"></a><h2>Description</h2><p> ]</p></div></div><div class="refsection"><a id="idm140737308383760"></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>
@ -153,7 +153,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="idm140737308361296"></a><h2>Options</h2><p> </p></div><div class="refsection"><a id="idm140737308346064"></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>
@ -265,15 +265,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="idm140737308295120"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"> </p></dd></dl></div></div><div class="refsection"><a id="idm140737308279936"></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> <code class="filename">$XDG_DATA_HOME/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="idm140737308291824"></a><h2>Bugs</h2><p> </p></dd></dl></div></div><div class="refsection"><a id="idm140737308276640"></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="idm140737308289824"></a><h2>See also</h2><p> </p></div><div class="refsection"><a id="idm140737308274640"></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>