nix-community/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2025-11-08 19:46:05 +01:00
Code Activity

deploy: af119feb17

Browse source
This commit is contained in:
khaneliman 2025-11-05 18:27:41 +00:00
parent e4529bc7f6
commit 7c112243fa
1 changed files with 10 additions and 246 deletions
Download patch file Download diff file Expand all files Collapse all files

256
options.xhtml
View file

@ -119228,263 +119228,27 @@ null or string</p>
</dd> </dd>
<dt> <dt>
<span class="term"> <span class="term">
<a id="opt-systemd.user.tmpfiles.settings"></a><a class="term" href="options.xhtml#opt-systemd.user.tmpfiles.settings"><code class="option">systemd.user.tmpfiles.settings</code> <a id="opt-systemd.user.tmpfiles.rules"></a><a class="term" href="options.xhtml#opt-systemd.user.tmpfiles.rules"><code class="option">systemd.user.tmpfiles.rules</code>
</a> </a>
</span> </span>
</dt> </dt>
<dd> <dd>
<p>Declare systemd-tmpfiles rules to create, delete, and clean up volatile <p>Rules for creating and cleaning up temporary files
and temporary files and directories.</p><p>Even though the service is called <code class="literal">*tmp*files</code> you can also create automatically. See
persistent files.</p> <a class="link" href="https://www.freedesktop.org/software/systemd/man/tmpfiles.d.html" target="_top"><span class="citerefentry"><span class="refentrytitle">tmpfiles.d</span>(5)</span></a>
for the exact format.</p>
<p><span class="emphasis"><em>Type:</em></span> <p><span class="emphasis"><em>Type:</em></span>
attribute set of (submodule)</p> list of string</p>
<p><span class="emphasis"><em>Default:</em></span> <p><span class="emphasis"><em>Default:</em></span>
<code class="literal">{ }</code></p> <code class="literal">[ ]</code></p>
<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">{ <p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">[
cache = { &quot;L /home/user/Documents - - - - /mnt/data/Documents&quot;
rules = { ]
&quot;%C&quot; = {
d = {
age = &quot;4 weeks&quot;;
group = &quot;alice&quot;;
mode = &quot;0755&quot;;
user = &quot;alice&quot;;
};
};
};
};
}
</code></pre> </code></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/misc/tmpfiles.nix" target="_top">
&lt;home-manager/modules/misc/tmpfiles.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-systemd.user.tmpfiles.settings._config-name_.purgeOnChange"></a><a class="term" href="options.xhtml#opt-systemd.user.tmpfiles.settings._config-name_.purgeOnChange"><code class="option">systemd.user.tmpfiles.settings.&lt;config-name&gt;.purgeOnChange</code>
</a>
</span>
</dt>
<dd>
<p>Whether the rules that are marked for purging, will automatically
be purged when the set of rules changes.</p><p>See <span class="citerefentry"><span class="refentrytitle">systemd-tmpfiles</span>(8)</span> for details about purging.</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/tmpfiles.nix" target="_top">
&lt;home-manager/modules/misc/tmpfiles.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-systemd.user.tmpfiles.settings._config-name_.rules"></a><a class="term" href="options.xhtml#opt-systemd.user.tmpfiles.settings._config-name_.rules"><code class="option">systemd.user.tmpfiles.settings.&lt;config-name&gt;.rules</code>
</a>
</span>
</dt>
<dd>
<p>The rules contained in this configuration.</p>
<p><span class="emphasis"><em>Type:</em></span>
non-empty attribute set of non-empty attribute set of (submodule)</p>
<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">{
&quot;%C&quot; = {
d = {
age = &quot;4 weeks&quot;;
group = &quot;alice&quot;;
mode = &quot;0755&quot;;
user = &quot;alice&quot;;
};
};
}
</code></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/misc/tmpfiles.nix" target="_top">
&lt;home-manager/modules/misc/tmpfiles.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-systemd.user.tmpfiles.settings._config-name_.rules._path_._tmpfiles-type_.age"></a><a class="term" href="options.xhtml#opt-systemd.user.tmpfiles.settings._config-name_.rules._path_._tmpfiles-type_.age"><code class="option">systemd.user.tmpfiles.settings.&lt;config-name&gt;.rules.&lt;path&gt;.&lt;tmpfiles-type&gt;.age</code>
</a>
</span>
</dt>
<dd>
<p>Delete a file when it reaches a certain age.</p><p>If a file or directory is older than the current time minus the age
field, it is deleted.</p><p>If set to <code class="literal">&quot;-&quot;</code>, no automatic clean-up is done.</p>
<p><span class="emphasis"><em>Type:</em></span>
string</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">&quot;-&quot;</code></p>
<p><span class="emphasis"><em>Example:</em></span>
<code class="literal">&quot;10d&quot;</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/tmpfiles.nix" target="_top">
&lt;home-manager/modules/misc/tmpfiles.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-systemd.user.tmpfiles.settings._config-name_.rules._path_._tmpfiles-type_.argument"></a><a class="term" href="options.xhtml#opt-systemd.user.tmpfiles.settings._config-name_.rules._path_._tmpfiles-type_.argument"><code class="option">systemd.user.tmpfiles.settings.&lt;config-name&gt;.rules.&lt;path&gt;.&lt;tmpfiles-type&gt;.argument</code>
</a>
</span>
</dt>
<dd>
<p>An argument whose meaning depends on the type of operation.</p><p>Please see the upstream documentation for the meaning of this
parameter in different situations: <a class="link" href="https://www.freedesktop.org/software/systemd/man/tmpfiles.d.html" target="_top"><span class="citerefentry"><span class="refentrytitle">tmpfiles.d</span>(5)</span></a></p>
<p><span class="emphasis"><em>Type:</em></span>
string</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">&quot;&quot;</code></p>
<p><span class="emphasis"><em>Example:</em></span>
<code class="literal">&quot;&quot;</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/tmpfiles.nix" target="_top">
&lt;home-manager/modules/misc/tmpfiles.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-systemd.user.tmpfiles.settings._config-name_.rules._path_._tmpfiles-type_.group"></a><a class="term" href="options.xhtml#opt-systemd.user.tmpfiles.settings._config-name_.rules._path_._tmpfiles-type_.group"><code class="option">systemd.user.tmpfiles.settings.&lt;config-name&gt;.rules.&lt;path&gt;.&lt;tmpfiles-type&gt;.group</code>
</a>
</span>
</dt>
<dd>
<p>The group of the file.</p><p>This may either be a numeric ID or a user/group name.</p><p>If omitted or when set to <code class="literal">&quot;-&quot;</code>, the user and group of the user who
invokes systemd-tmpfiles is used.</p>
<p><span class="emphasis"><em>Type:</em></span>
string</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">&quot;-&quot;</code></p>
<p><span class="emphasis"><em>Example:</em></span>
<code class="literal">&quot;root&quot;</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/tmpfiles.nix" target="_top">
&lt;home-manager/modules/misc/tmpfiles.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-systemd.user.tmpfiles.settings._config-name_.rules._path_._tmpfiles-type_.mode"></a><a class="term" href="options.xhtml#opt-systemd.user.tmpfiles.settings._config-name_.rules._path_._tmpfiles-type_.mode"><code class="option">systemd.user.tmpfiles.settings.&lt;config-name&gt;.rules.&lt;path&gt;.&lt;tmpfiles-type&gt;.mode</code>
</a>
</span>
</dt>
<dd>
<p>The file access mode to use when creating this file or directory.</p>
<p><span class="emphasis"><em>Type:</em></span>
string</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">&quot;-&quot;</code></p>
<p><span class="emphasis"><em>Example:</em></span>
<code class="literal">&quot;0755&quot;</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/tmpfiles.nix" target="_top">
&lt;home-manager/modules/misc/tmpfiles.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-systemd.user.tmpfiles.settings._config-name_.rules._path_._tmpfiles-type_.type"></a><a class="term" href="options.xhtml#opt-systemd.user.tmpfiles.settings._config-name_.rules._path_._tmpfiles-type_.type"><code class="option">systemd.user.tmpfiles.settings.&lt;config-name&gt;.rules.&lt;path&gt;.&lt;tmpfiles-type&gt;.type</code>
</a>
</span>
</dt>
<dd>
<p>The type of operation to perform on the file.</p><p>The type consists of a single letter and optionally one or more
modifier characters.</p><p>Please see the upstream documentation for the available types and
more details: <a class="link" href="https://www.freedesktop.org/software/systemd/man/tmpfiles.d.html" target="_top"><span class="citerefentry"><span class="refentrytitle">tmpfiles.d</span>(5)</span></a></p>
<p><span class="emphasis"><em>Type:</em></span>
string <span class="emphasis"><em>(read only)</em></span></p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">&quot;‹tmpfiles-type›&quot;</code></p>
<p><span class="emphasis"><em>Example:</em></span>
<code class="literal">&quot;d&quot;</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/tmpfiles.nix" target="_top">
&lt;home-manager/modules/misc/tmpfiles.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-systemd.user.tmpfiles.settings._config-name_.rules._path_._tmpfiles-type_.user"></a><a class="term" href="options.xhtml#opt-systemd.user.tmpfiles.settings._config-name_.rules._path_._tmpfiles-type_.user"><code class="option">systemd.user.tmpfiles.settings.&lt;config-name&gt;.rules.&lt;path&gt;.&lt;tmpfiles-type&gt;.user</code>
</a>
</span>
</dt>
<dd>
<p>The user of the file.</p><p>This may either be a numeric ID or a user/group name.</p><p>If omitted or when set to <code class="literal">&quot;-&quot;</code>, the user and group of the user who
invokes systemd-tmpfiles is used.</p>
<p><span class="emphasis"><em>Type:</em></span>
string</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">&quot;-&quot;</code></p>
<p><span class="emphasis"><em>Example:</em></span>
<code class="literal">&quot;root&quot;</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p> <p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist"> <table border="0" summary="Simple list" class="simplelist">
<tr><td> <tr><td>