Mirrors/home-manager
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
home-manager/nix-darwin-options.html

66 lines
12 KiB
HTML
Raw Normal View History

deploy: 5280360d6ce04364b250f15a1863a7e4fc25b063
2021-01-21 23:50:50 +01:00
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
deploy: 75790441498b1ed64dca6511b28d99a7d170f645
2023-07-19 18:10:38 +02:00
<!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 name="viewport" content="width=device-width, initial-scale=1.0"><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" /><script src="highlight.min.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
deploy: 28b6c3670cbfab9ff78e6de8cd38f93ec42d253b
2023-06-24 13:34:44 +02:00
like <code class="literal">lib</code>, <code class="literal">config</code>,
deploy: 75790441498b1ed64dca6511b28d99a7d170f645
2023-07-19 18:10:38 +02:00
and <code class="literal">pkgs</code>, <code class="literal">modulesPath</code>.</p><p>This option is also available to all submodules. Submodules do not
deploy: 28b6c3670cbfab9ff78e6de8cd38f93ec42d253b
2023-06-24 13:34:44 +02:00
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
deploy: 75790441498b1ed64dca6511b28d99a7d170f645
2023-07-19 18:10:38 +02:00
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
deploy: 28b6c3670cbfab9ff78e6de8cd38f93ec42d253b
2023-06-24 13:34:44 +02:00
thanks to laziness, this does not apply to <code class="literal">imports</code>, which
deploy: 75790441498b1ed64dca6511b28d99a7d170f645
2023-07-19 18:10:38 +02:00
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
deploy: 28b6c3670cbfab9ff78e6de8cd38f93ec42d253b
2023-06-24 13:34:44 +02:00
<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
deploy: 75790441498b1ed64dca6511b28d99a7d170f645
2023-07-19 18:10:38 +02:00
<code class="literal">nixpkgs</code> or NixOS directories.</p><pre class="programlisting">{ modulesPath, ... }: {
deploy: 28b6c3670cbfab9ff78e6de8cd38f93ec42d253b
2023-06-24 13:34:44 +02:00
imports = [
(modulesPath + "/profiles/minimal.nix")
];
}
deploy: 75790441498b1ed64dca6511b28d99a7d170f645
2023-07-19 18:10:38 +02:00
</pre></li></ul></div><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><span class="emphasis"><em>Type:</em></span>
lazy attribute set of raw value</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/NixOS/nixpkgs/blob/master/lib/modules.nix" target="_top">
&lt;nixpkgs/lib/modules.nix&gt;
</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.</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/common.nix" target="_top">
&lt;home-manager/nixos/common.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="nix-darwin-opt-home-manager.extraSpecialArgs"></a><a class="term" href="nix-darwin-options.html#nix-darwin-opt-home-manager.extraSpecialArgs"><code class="option">home-manager.extraSpecialArgs</code></a></span></dt><dd><p>Extra <code class="literal">specialArgs</code> passed to Home Manager. This
option can be used to pass additional arguments to all modules.</p><p><span class="emphasis"><em>Type:</em></span>
attribute set</p><p><span class="emphasis"><em>Default:</em></span>
<code class="literal">{ }</code></p><p><span class="emphasis"><em>Example:</em></span>
<code class="literal">{ inherit emacs-overlay; }</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/common.nix" target="_top">
&lt;home-manager/nixos/common.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="nix-darwin-opt-home-manager.sharedModules"></a><a class="term" href="nix-darwin-options.html#nix-darwin-opt-home-manager.sharedModules"><code class="option">home-manager.sharedModules</code></a></span></dt><dd><p>Extra modules added to all users.</p><p><span class="emphasis"><em>Type:</em></span>
list of raw value</p><p><span class="emphasis"><em>Default:</em></span>
<code class="literal">[ ]</code></p><p><span class="emphasis"><em>Example:</em></span>
<code class="literal">[ { home.packages = [ nixpkgs-fmt ]; } ]</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/common.nix" target="_top">
&lt;home-manager/nixos/common.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="nix-darwin-opt-home-manager.useGlobalPkgs"></a><a class="term" href="nix-darwin-options.html#nix-darwin-opt-home-manager.useGlobalPkgs"><code class="option">home-manager.useGlobalPkgs</code></a></span></dt><dd><p>Whether to enable using the system configuration’s <code class="literal">pkgs</code>
deploy: 5280360d6ce04364b250f15a1863a7e4fc25b063
2021-01-21 23:50:50 +01:00
argument in Home Manager. This disables the Home Manager
deploy: 75790441498b1ed64dca6511b28d99a7d170f645
2023-07-19 18:10:38 +02:00
options <code class="option">nixpkgs.*</code>.</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/nixos/common.nix" target="_top">
&lt;home-manager/nixos/common.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="nix-darwin-opt-home-manager.useUserPackages"></a><a class="term" href="nix-darwin-options.html#nix-darwin-opt-home-manager.useUserPackages"><code class="option">home-manager.useUserPackages</code></a></span></dt><dd><p>Whether to enable installation of user packages through the
<code class="option">users.users.&lt;name&gt;.packages</code> option.</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/nixos/common.nix" target="_top">
&lt;home-manager/nixos/common.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="nix-darwin-opt-home-manager.users"></a><a class="term" href="nix-darwin-options.html#nix-darwin-opt-home-manager.users"><code class="option">home-manager.users</code></a></span></dt><dd><p>Per-user Home Manager configuration.</p><p><span class="emphasis"><em>Type:</em></span>
attribute set of (Home Manager module)</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/nixos/common.nix" target="_top">
&lt;home-manager/nixos/common.nix&gt;
</a></code></td></tr></table></dd><dt><span class="term"><a id="nix-darwin-opt-home-manager.verbose"></a><a class="term" href="nix-darwin-options.html#nix-darwin-opt-home-manager.verbose"><code class="option">home-manager.verbose</code></a></span></dt><dd><p>Whether to enable verbose output on activation.</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/nixos/common.nix" target="_top">
&lt;home-manager/nixos/common.nix&gt;
</a></code></td></tr></table></dd></dl></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="nixos-options.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="tools.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Appendix B. NixOS 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 D. Tools</td></tr></table></div></body></html>
Reference in a new issue Copy permalink