mirror of
https://github.com/nix-community/home-manager
synced 2024-11-30 15:09:46 +01:00
deploy: 66ffa7a0a6
This commit is contained in:
parent
5749773023
commit
2261272c20
5 changed files with 171 additions and 12 deletions
File diff suppressed because one or more lines are too long
|
@ -1,5 +1,58 @@
|
||||||
<?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 C. nix-darwin Module Options</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="nixos-options.html" title="Appendix B. NixOS Module Options" /><link rel="next" href="tools.html" title="Appendix D. Tools" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix C. nix-darwin Module Options</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="nixos-options.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="tools.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="ch-nix-darwin-options"></a>Appendix C. nix-darwin Module Options</h1></div></div></div><div class="variablelist"><a id="nix-darwin-options"></a><dl class="variablelist"><dt><span class="term"><a id="nix-darwin-opt-home-manager.backupFileExtension"></a><a class="term" href="nix-darwin-options.html#nix-darwin-opt-home-manager.backupFileExtension"><code class="option">home-manager.backupFileExtension</code></a></span></dt><dd><p>On activation move existing files by appending the given
|
<!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 C. nix-darwin Module Options</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="nixos-options.html" title="Appendix B. NixOS Module Options" /><link rel="next" href="tools.html" title="Appendix D. Tools" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix C. nix-darwin Module Options</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="nixos-options.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="tools.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="ch-nix-darwin-options"></a>Appendix C. nix-darwin Module Options</h1></div></div></div><div class="variablelist"><a id="nix-darwin-options"></a><dl class="variablelist"><dt><span class="term"><a id="nix-darwin-opt-_module.args"></a><a class="term" href="nix-darwin-options.html#nix-darwin-opt-_module.args"><code class="option">_module.args</code></a></span></dt><dd><p>Additional arguments passed to each module in addition to ones
|
||||||
|
like <code class="literal">lib</code>, <code class="literal">config</code>,
|
||||||
|
and <code class="literal">pkgs</code>, <code class="literal">modulesPath</code>.
|
||||||
|
</p><p>
|
||||||
|
This option is also available to all submodules. Submodules do not
|
||||||
|
inherit args from their parent module, nor do they provide args to
|
||||||
|
their parent module or sibling submodules. The sole exception to
|
||||||
|
this is the argument <code class="literal">name</code> which is provided by
|
||||||
|
parent modules to a submodule and contains the attribute name
|
||||||
|
the submodule is bound to, or a unique generated name if it is
|
||||||
|
not bound to an attribute.
|
||||||
|
</p><p>
|
||||||
|
Some arguments are already passed by default, of which the
|
||||||
|
following <span class="emphasis"><em>cannot</em></span> be changed with this option:
|
||||||
|
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
|
||||||
|
<code class="varname">lib</code>: The nixpkgs library.
|
||||||
|
</p></li><li class="listitem"><p>
|
||||||
|
<code class="varname">config</code>: The results of all options after merging the values from all modules together.
|
||||||
|
</p></li><li class="listitem"><p>
|
||||||
|
<code class="varname">options</code>: The options declared in all modules.
|
||||||
|
</p></li><li class="listitem"><p>
|
||||||
|
<code class="varname">specialArgs</code>: The <code class="literal">specialArgs</code> argument passed to <code class="literal">evalModules</code>.
|
||||||
|
</p></li><li class="listitem"><p>
|
||||||
|
All attributes of <code class="varname">specialArgs</code>
|
||||||
|
</p><p>
|
||||||
|
Whereas option values can generally depend on other option values
|
||||||
|
thanks to laziness, this does not apply to <code class="literal">imports</code>, which
|
||||||
|
must be computed statically before anything else.
|
||||||
|
</p><p>
|
||||||
|
For this reason, callers of the module system can provide <code class="literal">specialArgs</code>
|
||||||
|
which are available during import resolution.
|
||||||
|
</p><p>
|
||||||
|
For NixOS, <code class="literal">specialArgs</code> includes
|
||||||
|
<code class="varname">modulesPath</code>, which allows you to import
|
||||||
|
extra modules from the nixpkgs package tree without having to
|
||||||
|
somehow make the module aware of the location of the
|
||||||
|
<code class="literal">nixpkgs</code> or NixOS directories.
|
||||||
|
</p><pre class="programlisting">
|
||||||
|
{ modulesPath, ... }: {
|
||||||
|
imports = [
|
||||||
|
(modulesPath + "/profiles/minimal.nix")
|
||||||
|
];
|
||||||
|
}
|
||||||
|
</pre><p>
|
||||||
|
</p></li></ul></div><p>
|
||||||
|
</p><p>
|
||||||
|
For NixOS, the default value for this option includes at least this argument:
|
||||||
|
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
|
||||||
|
<code class="varname">pkgs</code>: The nixpkgs package set according to
|
||||||
|
the <code class="option">nixpkgs.pkgs</code> option.
|
||||||
|
</p></li></ul></div><p>
|
||||||
|
</p><p><span class="emphasis"><em>Type:</em></span> lazy attribute set of raw values</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/lib/modules.nix#blob-path" target="_top">
|
||||||
|
<home-manager/lib/modules.nix>
|
||||||
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="nix-darwin-opt-home-manager.backupFileExtension"></a><a class="term" href="nix-darwin-options.html#nix-darwin-opt-home-manager.backupFileExtension"><code class="option">home-manager.backupFileExtension</code></a></span></dt><dd><p>On activation move existing files by appending the given
|
||||||
file extension rather than exiting with an error.
|
file extension rather than exiting with an error.
|
||||||
</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">"backup"</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/nix-darwin/default.nix#blob-path" target="_top">
|
</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">"backup"</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/nix-darwin/default.nix#blob-path" target="_top">
|
||||||
<home-manager/nix-darwin/default.nix>
|
<home-manager/nix-darwin/default.nix>
|
||||||
|
|
|
@ -1,5 +1,58 @@
|
||||||
<?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 B. NixOS Module Options</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="options.html" title="Appendix A. Configuration Options" /><link rel="next" href="nix-darwin-options.html" title="Appendix C. nix-darwin Module Options" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix B. NixOS Module Options</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="options.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="nix-darwin-options.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="ch-nixos-options"></a>Appendix B. NixOS Module Options</h1></div></div></div><div class="variablelist"><a id="nixos-options"></a><dl class="variablelist"><dt><span class="term"><a id="nixos-opt-home-manager.backupFileExtension"></a><a class="term" href="nixos-options.html#nixos-opt-home-manager.backupFileExtension"><code class="option">home-manager.backupFileExtension</code></a></span></dt><dd><p>On activation move existing files by appending the given
|
<!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 B. NixOS Module Options</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="options.html" title="Appendix A. Configuration Options" /><link rel="next" href="nix-darwin-options.html" title="Appendix C. nix-darwin Module Options" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix B. NixOS Module Options</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="options.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="nix-darwin-options.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="ch-nixos-options"></a>Appendix B. NixOS Module Options</h1></div></div></div><div class="variablelist"><a id="nixos-options"></a><dl class="variablelist"><dt><span class="term"><a id="nixos-opt-_module.args"></a><a class="term" href="nixos-options.html#nixos-opt-_module.args"><code class="option">_module.args</code></a></span></dt><dd><p>Additional arguments passed to each module in addition to ones
|
||||||
|
like <code class="literal">lib</code>, <code class="literal">config</code>,
|
||||||
|
and <code class="literal">pkgs</code>, <code class="literal">modulesPath</code>.
|
||||||
|
</p><p>
|
||||||
|
This option is also available to all submodules. Submodules do not
|
||||||
|
inherit args from their parent module, nor do they provide args to
|
||||||
|
their parent module or sibling submodules. The sole exception to
|
||||||
|
this is the argument <code class="literal">name</code> which is provided by
|
||||||
|
parent modules to a submodule and contains the attribute name
|
||||||
|
the submodule is bound to, or a unique generated name if it is
|
||||||
|
not bound to an attribute.
|
||||||
|
</p><p>
|
||||||
|
Some arguments are already passed by default, of which the
|
||||||
|
following <span class="emphasis"><em>cannot</em></span> be changed with this option:
|
||||||
|
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
|
||||||
|
<code class="varname">lib</code>: The nixpkgs library.
|
||||||
|
</p></li><li class="listitem"><p>
|
||||||
|
<code class="varname">config</code>: The results of all options after merging the values from all modules together.
|
||||||
|
</p></li><li class="listitem"><p>
|
||||||
|
<code class="varname">options</code>: The options declared in all modules.
|
||||||
|
</p></li><li class="listitem"><p>
|
||||||
|
<code class="varname">specialArgs</code>: The <code class="literal">specialArgs</code> argument passed to <code class="literal">evalModules</code>.
|
||||||
|
</p></li><li class="listitem"><p>
|
||||||
|
All attributes of <code class="varname">specialArgs</code>
|
||||||
|
</p><p>
|
||||||
|
Whereas option values can generally depend on other option values
|
||||||
|
thanks to laziness, this does not apply to <code class="literal">imports</code>, which
|
||||||
|
must be computed statically before anything else.
|
||||||
|
</p><p>
|
||||||
|
For this reason, callers of the module system can provide <code class="literal">specialArgs</code>
|
||||||
|
which are available during import resolution.
|
||||||
|
</p><p>
|
||||||
|
For NixOS, <code class="literal">specialArgs</code> includes
|
||||||
|
<code class="varname">modulesPath</code>, which allows you to import
|
||||||
|
extra modules from the nixpkgs package tree without having to
|
||||||
|
somehow make the module aware of the location of the
|
||||||
|
<code class="literal">nixpkgs</code> or NixOS directories.
|
||||||
|
</p><pre class="programlisting">
|
||||||
|
{ modulesPath, ... }: {
|
||||||
|
imports = [
|
||||||
|
(modulesPath + "/profiles/minimal.nix")
|
||||||
|
];
|
||||||
|
}
|
||||||
|
</pre><p>
|
||||||
|
</p></li></ul></div><p>
|
||||||
|
</p><p>
|
||||||
|
For NixOS, the default value for this option includes at least this argument:
|
||||||
|
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
|
||||||
|
<code class="varname">pkgs</code>: The nixpkgs package set according to
|
||||||
|
the <code class="option">nixpkgs.pkgs</code> option.
|
||||||
|
</p></li></ul></div><p>
|
||||||
|
</p><p><span class="emphasis"><em>Type:</em></span> lazy attribute set of raw values</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/lib/modules.nix#blob-path" target="_top">
|
||||||
|
<home-manager/lib/modules.nix>
|
||||||
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="nixos-opt-home-manager.backupFileExtension"></a><a class="term" href="nixos-options.html#nixos-opt-home-manager.backupFileExtension"><code class="option">home-manager.backupFileExtension</code></a></span></dt><dd><p>On activation move existing files by appending the given
|
||||||
file extension rather than exiting with an error.
|
file extension rather than exiting with an error.
|
||||||
</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">"backup"</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/nixos/default.nix#blob-path" target="_top">
|
</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">"backup"</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/nixos/default.nix#blob-path" target="_top">
|
||||||
<home-manager/nixos/default.nix>
|
<home-manager/nixos/default.nix>
|
||||||
|
|
55
options.html
55
options.html
|
@ -1,5 +1,58 @@
|
||||||
<?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 A. Configuration Options</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="index.html" title="Home Manager Manual" /><link rel="next" href="nixos-options.html" title="Appendix B. NixOS Module Options" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix A. Configuration Options</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="nixos-options.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="ch-options"></a>Appendix A. Configuration Options</h1></div></div></div><div class="variablelist"><a id="home-manager-options"></a><dl class="variablelist"><dt><span class="term"><a id="opt-accounts.email.accounts"></a><a class="term" href="options.html#opt-accounts.email.accounts"><code class="option">accounts.email.accounts</code></a></span></dt><dd><p>List of email accounts.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodules</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
<!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 A. Configuration Options</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="index.html" title="Home Manager Manual" /><link rel="next" href="nixos-options.html" title="Appendix B. NixOS Module Options" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix A. Configuration Options</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="nixos-options.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="ch-options"></a>Appendix A. Configuration Options</h1></div></div></div><div class="variablelist"><a id="home-manager-options"></a><dl class="variablelist"><dt><span class="term"><a id="opt-_module.args"></a><a class="term" href="options.html#opt-_module.args"><code class="option">_module.args</code></a></span></dt><dd><p>Additional arguments passed to each module in addition to ones
|
||||||
|
like <code class="literal">lib</code>, <code class="literal">config</code>,
|
||||||
|
and <code class="literal">pkgs</code>, <code class="literal">modulesPath</code>.
|
||||||
|
</p><p>
|
||||||
|
This option is also available to all submodules. Submodules do not
|
||||||
|
inherit args from their parent module, nor do they provide args to
|
||||||
|
their parent module or sibling submodules. The sole exception to
|
||||||
|
this is the argument <code class="literal">name</code> which is provided by
|
||||||
|
parent modules to a submodule and contains the attribute name
|
||||||
|
the submodule is bound to, or a unique generated name if it is
|
||||||
|
not bound to an attribute.
|
||||||
|
</p><p>
|
||||||
|
Some arguments are already passed by default, of which the
|
||||||
|
following <span class="emphasis"><em>cannot</em></span> be changed with this option:
|
||||||
|
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
|
||||||
|
<code class="varname">lib</code>: The nixpkgs library.
|
||||||
|
</p></li><li class="listitem"><p>
|
||||||
|
<code class="varname">config</code>: The results of all options after merging the values from all modules together.
|
||||||
|
</p></li><li class="listitem"><p>
|
||||||
|
<code class="varname">options</code>: The options declared in all modules.
|
||||||
|
</p></li><li class="listitem"><p>
|
||||||
|
<code class="varname">specialArgs</code>: The <code class="literal">specialArgs</code> argument passed to <code class="literal">evalModules</code>.
|
||||||
|
</p></li><li class="listitem"><p>
|
||||||
|
All attributes of <code class="varname">specialArgs</code>
|
||||||
|
</p><p>
|
||||||
|
Whereas option values can generally depend on other option values
|
||||||
|
thanks to laziness, this does not apply to <code class="literal">imports</code>, which
|
||||||
|
must be computed statically before anything else.
|
||||||
|
</p><p>
|
||||||
|
For this reason, callers of the module system can provide <code class="literal">specialArgs</code>
|
||||||
|
which are available during import resolution.
|
||||||
|
</p><p>
|
||||||
|
For NixOS, <code class="literal">specialArgs</code> includes
|
||||||
|
<code class="varname">modulesPath</code>, which allows you to import
|
||||||
|
extra modules from the nixpkgs package tree without having to
|
||||||
|
somehow make the module aware of the location of the
|
||||||
|
<code class="literal">nixpkgs</code> or NixOS directories.
|
||||||
|
</p><pre class="programlisting">
|
||||||
|
{ modulesPath, ... }: {
|
||||||
|
imports = [
|
||||||
|
(modulesPath + "/profiles/minimal.nix")
|
||||||
|
];
|
||||||
|
}
|
||||||
|
</pre><p>
|
||||||
|
</p></li></ul></div><p>
|
||||||
|
</p><p>
|
||||||
|
For NixOS, the default value for this option includes at least this argument:
|
||||||
|
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
|
||||||
|
<code class="varname">pkgs</code>: The nixpkgs package set according to
|
||||||
|
the <code class="option">nixpkgs.pkgs</code> option.
|
||||||
|
</p></li></ul></div><p>
|
||||||
|
</p><p><span class="emphasis"><em>Type:</em></span> lazy attribute set of raw values</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/lib/modules.nix#blob-path" target="_top">
|
||||||
|
<home-manager/lib/modules.nix>
|
||||||
|
</a></code></td></tr></table></dd><dt><span class="term"><a id="opt-accounts.email.accounts"></a><a class="term" href="options.html#opt-accounts.email.accounts"><code class="option">accounts.email.accounts</code></a></span></dt><dd><p>List of email accounts.</p><p><span class="emphasis"><em>Type:</em></span> attribute set of submodules</p><p><span class="emphasis"><em>Default:</em></span> <code class="literal">
|
||||||
{
|
{
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
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#idm140737308738784"><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#idm140737308670240"><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="idm140737308738784"></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="idm140737308670240"></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="idm140737308701392"></a><h2>Description</h2><p>
|
]</p></div></div><div class="refsection"><a id="idm140737308632752"></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="idm140737308663696"></a><h2>Options</h2><p>
|
</p></div><div class="refsection"><a id="idm140737308595104"></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="idm140737308597568"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term">
|
</p></dd></dl></div></div><div class="refsection"><a id="idm140737308529024"></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="idm140737308594272"></a><h2>Bugs</h2><p>
|
</p></dd></dl></div></div><div class="refsection"><a id="idm140737308525728"></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="idm140737308592272"></a><h2>See also</h2><p>
|
</p></div><div class="refsection"><a id="idm140737308523728"></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