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

deploy: 0e2f7876d2

Browse source
This commit is contained in:
rycee 2022-07-27 12:33:43 +00:00
parent c575c9e300
commit 3294451c73
3 changed files with 47 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
index.html
View file

File diff suppressed because one or more lines are too long

38
options.html
View file

@ -9664,6 +9664,44 @@ to only set background when logging in. Should be formatted
as a duration understood by systemd.
</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">"1h"</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/random-background.nix#blob-path" target="_top">
&lt;home-manager/modules/services/random-background.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.recoll.enable"></a><a class="term" href="options.html#opt-services.recoll.enable"><code class="option">services.recoll.enable</code></a></span></dt><dd><p>Whether to enable Recoll file index 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/recoll.nix#blob-path" target="_top">
&lt;home-manager/modules/services/recoll.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.recoll.package"></a><a class="term" href="options.html#opt-services.recoll.package"><code class="option">services.recoll.package</code></a></span></dt><dd><p>Package providing the <code class="literal">recoll</code> binary.
</p><p><span class="emphasis"><em>Type:</em></span> package</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">pkgs.recoll</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">(pkgs.recoll.override { withGui = 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/services/recoll.nix#blob-path" target="_top">
&lt;home-manager/modules/services/recoll.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.recoll.configDir"></a><a class="term" href="options.html#opt-services.recoll.configDir"><code class="option">services.recoll.configDir</code></a></span></dt><dd><p>The directory to contain Recoll configuration files. This will be set
as <code class="literal">RECOLL_CONFDIR</code>.
</p><p><span class="emphasis"><em>Type:</em></span> string</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">${config.home.homeDirectory}/.recoll</code></p><p><span class="emphasis"><em>Example:</em></span> <code class="literal">${config.xdg.configHome}/recoll</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/recoll.nix#blob-path" target="_top">
&lt;home-manager/modules/services/recoll.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.recoll.settings"></a><a class="term" href="options.html#opt-services.recoll.settings"><code class="option">services.recoll.settings</code></a></span></dt><dd><p>The configuration to be written at
<code class="filename">${config.services.recoll.configDir}/recoll.conf</code>.
See
<span class="citerefentry"><span class="refentrytitle">recoll</span>(5)</span> for more details about the configuration.
</p><p><span class="emphasis"><em>Type:</em></span> attribute set of Recoll config value</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">{
nocjk = true;
loglevel = 5;
topdirs = [ "~/Downloads" "~/Documents" "~/projects" ];
"~/Downloads" = {
"skippedNames+" = [ "*.iso" ];
};
"~/projects" = {
"skippedNames+" = [ "node_modules" "target" "result" ];
};
}
</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/services/recoll.nix#blob-path" target="_top">
&lt;home-manager/modules/services/recoll.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.recoll.startAt"></a><a class="term" href="options.html#opt-services.recoll.startAt"><code class="option">services.recoll.startAt</code></a></span></dt><dd><p>When or how often the periodic update should run. Must be the format
described from
<span class="citerefentry"><span class="refentrytitle">systemd.time</span>(7)</span>.
</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>Example:</em></span> <code class="literal">"00/2:00"</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/recoll.nix#blob-path" target="_top">
&lt;home-manager/modules/services/recoll.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.redshift.enable"></a><a class="term" href="options.html#opt-services.redshift.enable"><code class="option">services.redshift.enable</code></a></span></dt><dd><p>Whether to enable Redshift.</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/redshift-gammastep/redshift.nix#blob-path" target="_top">
&lt;home-manager/modules/services/redshift-gammastep/redshift.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-services.redshift.package"></a><a class="term" href="options.html#opt-services.redshift.package"><code class="option">services.redshift.package</code></a></span></dt><dd><p>Redshift derivation to use.

14
tools.html
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#idm140737308189632"><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="idm140737308189632"></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#idm140737308154416"><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="idm140737308154416"></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="idm140737308152384"></a><h2>Description</h2><p>
]</p></div></div><div class="refsection"><a id="idm140737308117168"></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="idm140737308114688"></a><h2>Options</h2><p>
</p></div><div class="refsection"><a id="idm140737308079424"></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="idm140737308048560"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
</p></dd></dl></div></div><div class="refsection"><a id="idm140737308013152"></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="idm140737308045264"></a><h2>Bugs</h2><p>
</p></dd></dl></div></div><div class="refsection"><a id="idm140737308009856"></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="idm140737308043264"></a><h2>See also</h2><p>
</p></div><div class="refsection"><a id="idm140737308007856"></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>