eeva/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-13 06:39:44 +01:00
Code Issues Releases Wiki Activity

deploy: a8f5ca239f

Browse source
This commit is contained in:
rycee 2023-03-21 09:53:27 +00:00
parent 19789829f8
commit 7a1745bcd0
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
options.html
View file

@ -1914,15 +1914,20 @@ each with its own source directories and repositories.</p><p><span class="emphas
&lt;home-manager/modules/programs/borgmatic.nix&gt; &lt;home-manager/modules/programs/borgmatic.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.consistency.checks._.name"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.consistency.checks._.name"><code class="option">programs.borgmatic.backups.&lt;name&gt;.consistency.checks.*.name</code></a></span></dt><dd><p>Name of consistency check to run.</p><p><span class="emphasis"><em>Type:</em></span> one of "repository", "archives", "data", "extract"</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"repository"</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/borgmatic.nix#blob-path" target="_top"> </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.consistency.checks._.name"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.consistency.checks._.name"><code class="option">programs.borgmatic.backups.&lt;name&gt;.consistency.checks.*.name</code></a></span></dt><dd><p>Name of consistency check to run.</p><p><span class="emphasis"><em>Type:</em></span> one of "repository", "archives", "data", "extract"</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">"repository"</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/borgmatic.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/borgmatic.nix&gt; &lt;home-manager/modules/programs/borgmatic.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.consistency.extraConfig"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.consistency.extraConfig"><code class="option">programs.borgmatic.backups.&lt;name&gt;.consistency.extraConfig</code></a></span></dt><dd><p>Extra settings.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of (string or boolean or path or signed integer or list of string)</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/borgmatic.nix#blob-path" target="_top"> </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.consistency.extraConfig"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.consistency.extraConfig"><code class="option">programs.borgmatic.backups.&lt;name&gt;.consistency.extraConfig</code></a></span></dt><dd><p>Extra settings.</p><p><span class="emphasis"><em>Type:</em></span> YAML value</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/borgmatic.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/borgmatic.nix&gt; &lt;home-manager/modules/programs/borgmatic.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.location.extraConfig"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.location.extraConfig"><code class="option">programs.borgmatic.backups.&lt;name&gt;.location.extraConfig</code></a></span></dt><dd><p>Extra settings.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of (string or boolean or path or signed integer or list of string)</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/borgmatic.nix#blob-path" target="_top"> </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.location.excludeHomeManagerSymlinks"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.location.excludeHomeManagerSymlinks"><code class="option">programs.borgmatic.backups.&lt;name&gt;.location.excludeHomeManagerSymlinks</code></a></span></dt><dd><p>Whether to exclude Home Manager generated symbolic links from
the backups. This facilitates restoring the whole home
directory when the Nix store doesn't contain the latest
Home Manager generation.</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/borgmatic.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/borgmatic.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.location.extraConfig"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.location.extraConfig"><code class="option">programs.borgmatic.backups.&lt;name&gt;.location.extraConfig</code></a></span></dt><dd><p>Extra settings.</p><p><span class="emphasis"><em>Type:</em></span> YAML value</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/borgmatic.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/borgmatic.nix&gt; &lt;home-manager/modules/programs/borgmatic.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.location.repositories"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.location.repositories"><code class="option">programs.borgmatic.backups.&lt;name&gt;.location.repositories</code></a></span></dt><dd><p>Paths to repositories.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">["ssh://myuser@myrepo.myserver.com/./repo"]</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/borgmatic.nix#blob-path" target="_top"> </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.location.repositories"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.location.repositories"><code class="option">programs.borgmatic.backups.&lt;name&gt;.location.repositories</code></a></span></dt><dd><p>Paths to repositories.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">["ssh://myuser@myrepo.myserver.com/./repo"]</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/borgmatic.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/borgmatic.nix&gt; &lt;home-manager/modules/programs/borgmatic.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.location.sourceDirectories"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.location.sourceDirectories"><code class="option">programs.borgmatic.backups.&lt;name&gt;.location.sourceDirectories</code></a></span></dt><dd><p>Directories to backup.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[config.home.homeDirectory]</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/borgmatic.nix#blob-path" target="_top"> </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.location.sourceDirectories"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.location.sourceDirectories"><code class="option">programs.borgmatic.backups.&lt;name&gt;.location.sourceDirectories</code></a></span></dt><dd><p>Directories to backup.</p><p><span class="emphasis"><em>Type:</em></span> list of string</p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">[config.home.homeDirectory]</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/borgmatic.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/borgmatic.nix&gt; &lt;home-manager/modules/programs/borgmatic.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.retention.extraConfig"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.retention.extraConfig"><code class="option">programs.borgmatic.backups.&lt;name&gt;.retention.extraConfig</code></a></span></dt><dd><p>Extra settings.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of (string or boolean or path or signed integer or list of string)</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/borgmatic.nix#blob-path" target="_top"> </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.retention.extraConfig"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.retention.extraConfig"><code class="option">programs.borgmatic.backups.&lt;name&gt;.retention.extraConfig</code></a></span></dt><dd><p>Extra settings.</p><p><span class="emphasis"><em>Type:</em></span> YAML value</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/borgmatic.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/borgmatic.nix&gt; &lt;home-manager/modules/programs/borgmatic.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.retention.keepDaily"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.retention.keepDaily"><code class="option">programs.borgmatic.backups.&lt;name&gt;.retention.keepDaily</code></a></span></dt><dd><p>Number of daily archives to keep. Use -1 for no limit.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">3</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/borgmatic.nix#blob-path" target="_top"> </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.retention.keepDaily"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.retention.keepDaily"><code class="option">programs.borgmatic.backups.&lt;name&gt;.retention.keepDaily</code></a></span></dt><dd><p>Number of daily archives to keep. Use -1 for no limit.</p><p><span class="emphasis"><em>Type:</em></span> null or signed integer</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">null</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">3</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/borgmatic.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/borgmatic.nix&gt; &lt;home-manager/modules/programs/borgmatic.nix&gt;
@ -1942,7 +1947,7 @@ each with its own source directories and repositories.</p><p><span class="emphas
&lt;home-manager/modules/programs/borgmatic.nix&gt; &lt;home-manager/modules/programs/borgmatic.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.storage.encryptionPasscommand"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.storage.encryptionPasscommand"><code class="option">programs.borgmatic.backups.&lt;name&gt;.storage.encryptionPasscommand</code></a></span></dt><dd><p>Command writing the passphrase to standard output.</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>Example:</em></span> <code class="literal">"${pkgs.password-store}/bin/pass borg-repo"</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/borgmatic.nix#blob-path" target="_top"> </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.storage.encryptionPasscommand"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.storage.encryptionPasscommand"><code class="option">programs.borgmatic.backups.&lt;name&gt;.storage.encryptionPasscommand</code></a></span></dt><dd><p>Command writing the passphrase to standard output.</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>Example:</em></span> <code class="literal">"${pkgs.password-store}/bin/pass borg-repo"</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/borgmatic.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/borgmatic.nix&gt; &lt;home-manager/modules/programs/borgmatic.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.storage.extraConfig"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.storage.extraConfig"><code class="option">programs.borgmatic.backups.&lt;name&gt;.storage.extraConfig</code></a></span></dt><dd><p>Extra settings.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of (string or boolean or path or signed integer or list of string)</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/borgmatic.nix#blob-path" target="_top"> </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.storage.extraConfig"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.storage.extraConfig"><code class="option">programs.borgmatic.backups.&lt;name&gt;.storage.extraConfig</code></a></span></dt><dd><p>Extra settings.</p><p><span class="emphasis"><em>Type:</em></span> YAML value</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/borgmatic.nix#blob-path" target="_top">
&lt;home-manager/modules/programs/borgmatic.nix&gt; &lt;home-manager/modules/programs/borgmatic.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bottom.enable"></a><a class="term" href="options.html#opt-programs.bottom.enable"><code class="option">programs.bottom.enable</code></a></span></dt><dd><p>Whether to enable bottom, a cross-platform graphical process/system monitor with a </a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.bottom.enable"></a><a class="term" href="options.html#opt-programs.bottom.enable"><code class="option">programs.bottom.enable</code></a></span></dt><dd><p>Whether to enable bottom, a cross-platform graphical process/system monitor with a
customizable interface.</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/bottom.nix#blob-path" target="_top"> customizable interface.</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/bottom.nix#blob-path" target="_top">