mirror of
https://github.com/nix-community/home-manager
synced 2024-11-10 21:29:48 +01:00
deploy: b00bdf59c0
This commit is contained in:
rycee
parent
db8c0b2743
commit
89fcc5e295
1 changed files with 209 additions and 0 deletions
209
options.xhtml
209
options.xhtml
|
|
@ -80820,6 +80820,215 @@ boolean</p>
|
||||||
</td></tr>
|
</td></tr>
|
||||||
</table>
|
</table>
|
||||||
</dd>
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<span class="term">
|
||||||
|
<a id="opt-xdg.stateFile"></a><a class="term" href="options.xhtml#opt-xdg.stateFile"><code class="option">xdg.stateFile</code>
|
||||||
|
</a>
|
||||||
|
</span>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
<p>Attribute set of files to link into the user’s XDG
|
||||||
|
state home.</p>
|
||||||
|
|
||||||
|
<p><span class="emphasis"><em>Type:</em></span>
|
||||||
|
attribute set of (submodule)</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/misc/xdg.nix" target="_top">
|
||||||
|
<home-manager/modules/misc/xdg.nix>
|
||||||
|
</a></code>
|
||||||
|
</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<span class="term">
|
||||||
|
<a id="opt-xdg.stateFile._name_.enable"></a><a class="term" href="options.xhtml#opt-xdg.stateFile._name_.enable"><code class="option">xdg.stateFile.<name>.enable</code>
|
||||||
|
</a>
|
||||||
|
</span>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
<p>Whether this file should be generated. This option allows specific
|
||||||
|
files to be disabled.</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/misc/xdg.nix" target="_top">
|
||||||
|
<home-manager/modules/misc/xdg.nix>
|
||||||
|
</a></code>
|
||||||
|
</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<span class="term">
|
||||||
|
<a id="opt-xdg.stateFile._name_.executable"></a><a class="term" href="options.xhtml#opt-xdg.stateFile._name_.executable"><code class="option">xdg.stateFile.<name>.executable</code>
|
||||||
|
</a>
|
||||||
|
</span>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
<p>Set the execute bit. If <code class="literal">null</code>, defaults to the mode
|
||||||
|
of the <code class="varname">source</code> file or to <code class="literal">false</code>
|
||||||
|
for files created through the <code class="varname">text</code> option.</p>
|
||||||
|
|
||||||
|
<p><span class="emphasis"><em>Type:</em></span>
|
||||||
|
null or boolean</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" target="_top">
|
||||||
|
<home-manager/modules/misc/xdg.nix>
|
||||||
|
</a></code>
|
||||||
|
</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<span class="term">
|
||||||
|
<a id="opt-xdg.stateFile._name_.onChange"></a><a class="term" href="options.xhtml#opt-xdg.stateFile._name_.onChange"><code class="option">xdg.stateFile.<name>.onChange</code>
|
||||||
|
</a>
|
||||||
|
</span>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
<p>Shell commands to run when file has changed between
|
||||||
|
generations. The script will be run
|
||||||
|
<span class="emphasis"><em>after</em></span> the new files have been linked
|
||||||
|
into place.</p><p>Note, this code is always run when <code class="literal">recursive</code> is
|
||||||
|
enabled.</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/misc/xdg.nix" target="_top">
|
||||||
|
<home-manager/modules/misc/xdg.nix>
|
||||||
|
</a></code>
|
||||||
|
</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<span class="term">
|
||||||
|
<a id="opt-xdg.stateFile._name_.recursive"></a><a class="term" href="options.xhtml#opt-xdg.stateFile._name_.recursive"><code class="option">xdg.stateFile.<name>.recursive</code>
|
||||||
|
</a>
|
||||||
|
</span>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
<p>If the file source is a directory, then this option
|
||||||
|
determines whether the directory should be recursively
|
||||||
|
linked to the target location. This option has no effect
|
||||||
|
if the source is a file.</p><p>If <code class="literal">false</code> (the default) then the target
|
||||||
|
will be a symbolic link to the source directory. If
|
||||||
|
<code class="literal">true</code> then the target will be a
|
||||||
|
directory structure matching the source’s but whose leafs
|
||||||
|
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" target="_top">
|
||||||
|
<home-manager/modules/misc/xdg.nix>
|
||||||
|
</a></code>
|
||||||
|
</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<span class="term">
|
||||||
|
<a id="opt-xdg.stateFile._name_.source"></a><a class="term" href="options.xhtml#opt-xdg.stateFile._name_.source"><code class="option">xdg.stateFile.<name>.source</code>
|
||||||
|
</a>
|
||||||
|
</span>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
<p>Path of the source file or directory. If
|
||||||
|
<a class="xref" href="options.xhtml#opt-xdg.stateFile._name_.text" ><code class="option">xdg.stateFile.<name>.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" target="_top">
|
||||||
|
<home-manager/modules/misc/xdg.nix>
|
||||||
|
</a></code>
|
||||||
|
</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<span class="term">
|
||||||
|
<a id="opt-xdg.stateFile._name_.target"></a><a class="term" href="options.xhtml#opt-xdg.stateFile._name_.target"><code class="option">xdg.stateFile.<name>.target</code>
|
||||||
|
</a>
|
||||||
|
</span>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
<p>Path to target file relative to <varname>xdg.stateHome</varname>.</p>
|
||||||
|
|
||||||
|
<p><span class="emphasis"><em>Type:</em></span>
|
||||||
|
string</p>
|
||||||
|
|
||||||
|
<p><span class="emphasis"><em>Default:</em></span>
|
||||||
|
<code class="literal">name</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" target="_top">
|
||||||
|
<home-manager/modules/misc/xdg.nix>
|
||||||
|
</a></code>
|
||||||
|
</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
|
<dt>
|
||||||
|
<span class="term">
|
||||||
|
<a id="opt-xdg.stateFile._name_.text"></a><a class="term" href="options.xhtml#opt-xdg.stateFile._name_.text"><code class="option">xdg.stateFile.<name>.text</code>
|
||||||
|
</a>
|
||||||
|
</span>
|
||||||
|
</dt>
|
||||||
|
<dd>
|
||||||
|
<p>Text of the file. If this option is null then
|
||||||
|
<a class="xref" href="options.xhtml#opt-xdg.stateFile._name_.source" ><code class="option">xdg.stateFile.<name>.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" target="_top">
|
||||||
|
<home-manager/modules/misc/xdg.nix>
|
||||||
|
</a></code>
|
||||||
|
</td></tr>
|
||||||
|
</table>
|
||||||
|
</dd>
|
||||||
<dt>
|
<dt>
|
||||||
<span class="term">
|
<span class="term">
|
||||||
<a id="opt-xdg.stateHome"></a><a class="term" href="options.xhtml#opt-xdg.stateHome"><code class="option">xdg.stateHome</code>
|
<a id="opt-xdg.stateHome"></a><a class="term" href="options.xhtml#opt-xdg.stateHome"><code class="option">xdg.stateHome</code>
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue