mirror of
https://github.com/nix-community/home-manager
synced 2024-11-24 03:59:46 +01:00
deploy: 04f5399978
This commit is contained in:
rycee
parent
4f0a03ab6a
commit
8058803f39
3 changed files with 115 additions and 9 deletions
File diff suppressed because one or more lines are too long
106
options.html
106
options.html
|
|
@ -2528,6 +2528,102 @@ Can be used to specify extensions.
|
||||||
}
|
}
|
||||||
</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/beets.nix#blob-path" target="_top">
|
</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/beets.nix#blob-path" target="_top">
|
||||||
<home-manager/modules/programs/beets.nix>
|
<home-manager/modules/programs/beets.nix>
|
||||||
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.enable"></a><a class="term" href="options.html#opt-programs.borgmatic.enable"><code class="option">programs.borgmatic.enable</code></a></span></dt><dd><p>Whether to enable Borgmatic.</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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.package"></a><a class="term" href="options.html#opt-programs.borgmatic.package"><code class="option">programs.borgmatic.package</code></a></span></dt><dd><p></p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.borgmatic</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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups"></a><a class="term" href="options.html#opt-programs.borgmatic.backups"><code class="option">programs.borgmatic.backups</code></a></span></dt><dd><p>Borgmatic allows for several named backup configurations,
|
||||||
|
each with its own source directories and repositories.
|
||||||
|
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of (submodule)</p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">{
|
||||||
|
personal = {
|
||||||
|
location = {
|
||||||
|
sourceDirectories = [ "/home/me/personal" ];
|
||||||
|
repositories = [ "ssh://myuser@myserver.com/./personal-repo" ];
|
||||||
|
};
|
||||||
|
};
|
||||||
|
work = {
|
||||||
|
location = {
|
||||||
|
sourceDirectories = [ "/home/me/work" ];
|
||||||
|
repositories = [ "ssh://myuser@myserver.com/./work-repo" ];
|
||||||
|
};
|
||||||
|
};
|
||||||
|
};
|
||||||
|
</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/borgmatic.nix#blob-path" target="_top">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.consistency.checks"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.consistency.checks"><code class="option">programs.borgmatic.backups.<name>.consistency.checks</code></a></span></dt><dd><p>Consistency checks to run</p><p><span class="emphasis"><em>Type:</em></span> list of (submodule)</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||||||
|
[
|
||||||
|
|
||||||
|
]
|
||||||
|
</code></p><p><span class="emphasis"><em>Example:</em></span> </p><pre class="programlisting">[
|
||||||
|
{
|
||||||
|
name = "repository";
|
||||||
|
frequency = "2 weeks";
|
||||||
|
}
|
||||||
|
{
|
||||||
|
name = "archives";
|
||||||
|
frequency = "4 weeks";
|
||||||
|
}
|
||||||
|
{
|
||||||
|
name = "data";
|
||||||
|
frequency = "6 weeks";
|
||||||
|
}
|
||||||
|
{
|
||||||
|
name = "extract";
|
||||||
|
frequency = "6 weeks";
|
||||||
|
}
|
||||||
|
];
|
||||||
|
</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/borgmatic.nix#blob-path" target="_top">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.consistency.checks._.frequency"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.consistency.checks._.frequency"><code class="option">programs.borgmatic.backups.<name>.consistency.checks.*.frequency</code></a></span></dt><dd><p>Frequency of this type of check</p><p><span class="emphasis"><em>Type:</em></span> null or string matching the pattern ([[:digit:]]+ .*)|always</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">"2 weeks"</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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</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.<name>.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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</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.<name>.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)</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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</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.<name>.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)</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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</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.<name>.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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</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.<name>.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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</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.<name>.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)</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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</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.<name>.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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.retention.keepHourly"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.retention.keepHourly"><code class="option">programs.borgmatic.backups.<name>.retention.keepHourly</code></a></span></dt><dd><p>Number of hourly 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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.retention.keepMinutely"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.retention.keepMinutely"><code class="option">programs.borgmatic.backups.<name>.retention.keepMinutely</code></a></span></dt><dd><p>Number of minutely 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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.retention.keepMonthly"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.retention.keepMonthly"><code class="option">programs.borgmatic.backups.<name>.retention.keepMonthly</code></a></span></dt><dd><p>Number of monthly 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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.retention.keepSecondly"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.retention.keepSecondly"><code class="option">programs.borgmatic.backups.<name>.retention.keepSecondly</code></a></span></dt><dd><p>Number of secondly 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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.retention.keepWeekly"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.retention.keepWeekly"><code class="option">programs.borgmatic.backups.<name>.retention.keepWeekly</code></a></span></dt><dd><p>Number of weekly 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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.retention.keepWithin"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.retention.keepWithin"><code class="option">programs.borgmatic.backups.<name>.retention.keepWithin</code></a></span></dt><dd><p>Keep all archives within this time interval.</p><p><span class="emphasis"><em>Type:</em></span> null or string matching the pattern [[:digit:]]+[Hdwmy]</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">"2d"</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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-programs.borgmatic.backups._name_.retention.keepYearly"></a><a class="term" href="options.html#opt-programs.borgmatic.backups._name_.retention.keepYearly"><code class="option">programs.borgmatic.backups.<name>.retention.keepYearly</code></a></span></dt><dd><p>Number of yearly 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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</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.<name>.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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
|
</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.<name>.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)</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">
|
||||||
|
<home-manager/modules/programs/borgmatic.nix>
|
||||||
</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">
|
||||||
<home-manager/modules/programs/bottom.nix>
|
<home-manager/modules/programs/bottom.nix>
|
||||||
|
|
@ -8648,6 +8744,16 @@ configuration using
|
||||||
</pre><p>
|
</pre><p>
|
||||||
</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/services/blueman-applet.nix#blob-path" target="_top">
|
</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/services/blueman-applet.nix#blob-path" target="_top">
|
||||||
<home-manager/modules/services/blueman-applet.nix>
|
<home-manager/modules/services/blueman-applet.nix>
|
||||||
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.borgmatic.enable"></a><a class="term" href="options.html#opt-services.borgmatic.enable"><code class="option">services.borgmatic.enable</code></a></span></dt><dd><p>Whether to enable Borgmatic service.</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/services/borgmatic.nix#blob-path" target="_top">
|
||||||
|
<home-manager/modules/services/borgmatic.nix>
|
||||||
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.borgmatic.frequency"></a><a class="term" href="options.html#opt-services.borgmatic.frequency"><code class="option">services.borgmatic.frequency</code></a></span></dt><dd><p>How often to run borgmatic when
|
||||||
|
<code class="code">services.borgmatic.enable = true</code>.
|
||||||
|
This value is passed to the systemd timer configuration as
|
||||||
|
the onCalendar option. See
|
||||||
|
<span class="citerefentry"><span class="refentrytitle">systemd.time</span>(7)</span>
|
||||||
|
for more information about the format.
|
||||||
|
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">"hourly"</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/borgmatic.nix#blob-path" target="_top">
|
||||||
|
<home-manager/modules/services/borgmatic.nix>
|
||||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.caffeine.enable"></a><a class="term" href="options.html#opt-services.caffeine.enable"><code class="option">services.caffeine.enable</code></a></span></dt><dd><p>Whether to enable Caffeine service.</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/services/caffeine.nix#blob-path" target="_top">
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.caffeine.enable"></a><a class="term" href="options.html#opt-services.caffeine.enable"><code class="option">services.caffeine.enable</code></a></span></dt><dd><p>Whether to enable Caffeine service.</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/services/caffeine.nix#blob-path" target="_top">
|
||||||
<home-manager/modules/services/caffeine.nix>
|
<home-manager/modules/services/caffeine.nix>
|
||||||
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.cbatticon.enable"></a><a class="term" href="options.html#opt-services.cbatticon.enable"><code class="option">services.cbatticon.enable</code></a></span></dt><dd><p>Whether to enable cbatticon.</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/services/cbatticon.nix#blob-path" target="_top">
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.cbatticon.enable"></a><a class="term" href="options.html#opt-services.cbatticon.enable"><code class="option">services.cbatticon.enable</code></a></span></dt><dd><p>Whether to enable cbatticon.</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/services/cbatticon.nix#blob-path" target="_top">
|
||||||
|
|
|
||||||
14
tools.html
14
tools.html
|
|
@ -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#idm140737307667856"><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#idm140737307550400"><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="idm140737307667856"></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="idm140737307550400"></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="idm140737307630608"></a><h2>Description</h2><p>
|
]</p></div></div><div class="refsection"><a id="idm140737307512864"></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="idm140737307592912"></a><h2>Options</h2><p>
|
</p></div><div class="refsection"><a id="idm140737307475264"></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="idm140737307526736"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
|
</p></dd></dl></div></div><div class="refsection"><a id="idm140737307409136"></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="idm140737307523440"></a><h2>Bugs</h2><p>
|
</p></dd></dl></div></div><div class="refsection"><a id="idm140737307405840"></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="idm140737307521440"></a><h2>See also</h2><p>
|
</p></div><div class="refsection"><a id="idm140737307403840"></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>
|
||||||
Loading…
Reference in a new issue