1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-27 21:49:48 +01:00
This commit is contained in:
rycee 2022-08-25 22:14:09 +00:00
parent 2a469e1cf3
commit ff5918d529
3 changed files with 23 additions and 25 deletions

File diff suppressed because one or more lines are too long

View file

@ -1001,7 +1001,7 @@ does not modify, the state of the system and exits if an
unexpected state is found. For example, the
<code class="literal">checkLinkTargets</code> script block checks for
collisions between non-managed files and files defined in
<code class="varname"><a class="link" href="options.html#opt-home.file">home.file</a></code>.
<a class="xref" href="options.html#opt-home.file"><code class="option">home.file</code></a>.
</p><p>
@ -1077,7 +1077,7 @@ are symbolic links to the files of the source directory.
</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/files.nix#blob-path" target="_top">
&lt;home-manager/modules/files.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.file._name_.source"></a><a class="term" href="options.html#opt-home.file._name_.source"><code class="option">home.file.&lt;name&gt;.source</code></a></span></dt><dd><p>Path of the source file or directory. If
<a class="link" href="options.html#opt-home.file._name_.text">home.file.&lt;name?&gt;.text</a>
<a class="xref" href="options.html#opt-home.file._name_.text"><code class="option">home.file.&lt;name&gt;.text</code></a>
is non-null then this option will automatically point to a file
containing that text.
</p><p><span class="emphasis"><em>Type:</em></span> path</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/files.nix#blob-path" target="_top">
@ -1086,7 +1086,7 @@ containing that text.
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">&lt;name&gt;</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/files.nix#blob-path" target="_top">
&lt;home-manager/modules/files.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.file._name_.text"></a><a class="term" href="options.html#opt-home.file._name_.text"><code class="option">home.file.&lt;name&gt;.text</code></a></span></dt><dd><p>Text of the file. If this option is null then
<a class="link" href="options.html#opt-home.file._name_.source">home.file.&lt;name?&gt;.source</a>
<a class="xref" href="options.html#opt-home.file._name_.source"><code class="option">home.file.&lt;name&gt;.source</code></a>
must be set.
</p><p><span class="emphasis"><em>Type:</em></span> null or strings concatenated with "\n"</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/files.nix#blob-path" target="_top">
&lt;home-manager/modules/files.nix&gt;
@ -1176,9 +1176,9 @@ Top-level options declared under this submodule are backend indepedent
options. Options declared under namespaces such as <code class="literal">x11</code>
are backend specific options. By default, only backend independent cursor
configurations are generated. If you need configurations for specific
backends, you can toggle them via the enable option. For example, <code class="varname">
<a class="link" href="options.html#opt-home.pointerCursor.x11.enable">home.pointerCursor.x11.enable</a>
</code> will enable x11 cursor configurations.
backends, you can toggle them via the enable option. For example,
<a class="xref" href="options.html#opt-home.pointerCursor.x11.enable"><code class="option">home.pointerCursor.x11.enable</code></a>
will enable x11 cursor configurations.
</p><p><span class="emphasis"><em>Type:</em></span> null or submodule</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/config/home-cursor.nix#blob-path" target="_top">
&lt;home-manager/modules/config/home-cursor.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-home.pointerCursor.package"></a><a class="term" href="options.html#opt-home.pointerCursor.package"><code class="option">home.pointerCursor.package</code></a></span></dt><dd><p>Package providing the cursor theme.</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">pkgs.vanilla-dmz</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/config/home-cursor.nix#blob-path" target="_top">
@ -2957,7 +2957,7 @@ extensions inside Firefox after the first installation.
Extensions listed here will only be available in Firefox
profiles managed through the
<a class="link" href="options.html#opt-programs.firefox.profiles">programs.firefox.profiles</a>
<a class="xref" href="options.html#opt-programs.firefox.profiles"><code class="option">programs.firefox.profiles</code></a>
option. This is due to recent changes in the way Firefox
handles extension side-loading.
</p><p><span class="emphasis"><em>Type:</em></span> list of package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
@ -3637,9 +3637,7 @@ presses the <span class="emphasis"><em>Delete</em></span> key.
</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/go.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/go.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.go.extraGoPaths"></a><a class="term" href="options.html#opt-programs.go.extraGoPaths"><code class="option">programs.go.extraGoPaths</code></a></span></dt><dd><p>Extra <code class="envar">GOPATH</code>s relative to <code class="envar">HOME</code> appended
after
<code class="varname"><a class="link" href="options.html#opt-programs.go.goPath">programs.go.goPath</a></code>,
if that option is set.
after <a class="xref" href="options.html#opt-programs.go.goPath"><code class="option">programs.go.goPath</code></a>, if that option is set.
</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
[
@ -8367,7 +8365,7 @@ this option) to command strings or directly to build outputs.
}
</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/zsh.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/zsh.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.shellGlobalAliases"></a><a class="term" href="options.html#opt-programs.zsh.shellGlobalAliases"><code class="option">programs.zsh.shellGlobalAliases</code></a></span></dt><dd><p>Similar to <code class="varname"><a class="link" href="options.html#opt-programs.zsh.shellAliases">opt-programs.zsh.shellAliases</a></code>,
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.zsh.shellGlobalAliases"></a><a class="term" href="options.html#opt-programs.zsh.shellGlobalAliases"><code class="option">programs.zsh.shellGlobalAliases</code></a></span></dt><dd><p>Similar to <a class="xref" href="options.html#opt-programs.zsh.shellAliases"><code class="option">programs.zsh.shellAliases</code></a>,
but are substituted anywhere on a line.
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
{
@ -11715,7 +11713,7 @@ are symbolic links to the files of the source directory.
</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/misc/xdg.nix#blob-path" target="_top">
&lt;home-manager/modules/misc/xdg.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.configFile._name_.source"></a><a class="term" href="options.html#opt-xdg.configFile._name_.source"><code class="option">xdg.configFile.&lt;name&gt;.source</code></a></span></dt><dd><p>Path of the source file or directory. If
<a class="link" href="options.html#opt-home.file._name_.text">home.file.&lt;name?&gt;.text</a>
<a class="xref" href="options.html#opt-home.file._name_.text"><code class="option">home.file.&lt;name&gt;.text</code></a>
is non-null then this option will automatically point to a file
containing that text.
</p><p><span class="emphasis"><em>Type:</em></span> path</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/misc/xdg.nix#blob-path" target="_top">
@ -11724,7 +11722,7 @@ containing that text.
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">&lt;name&gt;</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/misc/xdg.nix#blob-path" target="_top">
&lt;home-manager/modules/misc/xdg.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.configFile._name_.text"></a><a class="term" href="options.html#opt-xdg.configFile._name_.text"><code class="option">xdg.configFile.&lt;name&gt;.text</code></a></span></dt><dd><p>Text of the file. If this option is null then
<a class="link" href="options.html#opt-home.file._name_.source">home.file.&lt;name?&gt;.source</a>
<a class="xref" href="options.html#opt-home.file._name_.source"><code class="option">home.file.&lt;name&gt;.source</code></a>
must be set.
</p><p><span class="emphasis"><em>Type:</em></span> null or strings concatenated with "\n"</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/misc/xdg.nix#blob-path" target="_top">
&lt;home-manager/modules/misc/xdg.nix&gt;
@ -11766,7 +11764,7 @@ are symbolic links to the files of the source directory.
</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/misc/xdg.nix#blob-path" target="_top">
&lt;home-manager/modules/misc/xdg.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.dataFile._name_.source"></a><a class="term" href="options.html#opt-xdg.dataFile._name_.source"><code class="option">xdg.dataFile.&lt;name&gt;.source</code></a></span></dt><dd><p>Path of the source file or directory. If
<a class="link" href="options.html#opt-home.file._name_.text">home.file.&lt;name?&gt;.text</a>
<a class="xref" href="options.html#opt-home.file._name_.text"><code class="option">home.file.&lt;name&gt;.text</code></a>
is non-null then this option will automatically point to a file
containing that text.
</p><p><span class="emphasis"><em>Type:</em></span> path</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/misc/xdg.nix#blob-path" target="_top">
@ -11775,7 +11773,7 @@ containing that text.
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">&lt;name&gt;</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/misc/xdg.nix#blob-path" target="_top">
&lt;home-manager/modules/misc/xdg.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xdg.dataFile._name_.text"></a><a class="term" href="options.html#opt-xdg.dataFile._name_.text"><code class="option">xdg.dataFile.&lt;name&gt;.text</code></a></span></dt><dd><p>Text of the file. If this option is null then
<a class="link" href="options.html#opt-home.file._name_.source">home.file.&lt;name?&gt;.source</a>
<a class="xref" href="options.html#opt-home.file._name_.source"><code class="option">home.file.&lt;name&gt;.source</code></a>
must be set.
</p><p><span class="emphasis"><em>Type:</em></span> null or strings concatenated with "\n"</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/misc/xdg.nix#blob-path" target="_top">
&lt;home-manager/modules/misc/xdg.nix&gt;
@ -12569,7 +12567,7 @@ See <code class="option">--no-startup-id</code> option description in the i3 use
</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>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/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
&lt;home-manager/modules/services/window-managers/i3-sway/i3.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-xsession.windowManager.i3.config.startup._.workspace"></a><a class="term" href="options.html#opt-xsession.windowManager.i3.config.startup._.workspace"><code class="option">xsession.windowManager.i3.config.startup.*.workspace</code></a></span></dt><dd><p>Launch application on a particular workspace. DEPRECATED:
Use <code class="varname"><a class="link" href="options.html#opt-xsession.windowManager.i3.config.assigns">xsession.windowManager.i3.config.assigns</a></code>
Use <a class="xref" href="options.html#opt-xsession.windowManager.i3.config.assigns"><code class="option">xsession.windowManager.i3.config.assigns</code></a>
instead. See <a class="link" href="https://github.com/nix-community/home-manager/issues/265" target="_top">https://github.com/nix-community/home-manager/issues/265</a>.
</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/services/window-managers/i3-sway/i3.nix#blob-path" target="_top">
&lt;home-manager/modules/services/window-managers/i3-sway/i3.nix&gt;

View file

@ -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#idm140737307968336"><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="idm140737307968336"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p><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#idm140737307975776"><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="idm140737307975776"></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="idm140737307931088"></a><h2>Description</h2><p>
]</p></div></div><div class="refsection"><a id="idm140737307938480"></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="idm140737307893440"></a><h2>Options</h2><p>
</p></div><div class="refsection"><a id="idm140737307900832"></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="idm140737307827312"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
</p></dd></dl></div></div><div class="refsection"><a id="idm140737307834656"></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="idm140737307824016"></a><h2>Bugs</h2><p>
</p></dd></dl></div></div><div class="refsection"><a id="idm140737307831360"></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="idm140737307822016"></a><h2>See also</h2><p>
</p></div><div class="refsection"><a id="idm140737307829360"></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>