nathan/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2026-06-05 21:02:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
home-manager/nixos-options.xhtml
rycee 9cd4fd9793 deploy: 603626a8da
2026-02-22 09:01:44 +00:00

386 lines
15 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<?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 Configuration Options</title>
<link rel="stylesheet" type="text/css" href="style.css" />
<script src="highlightjs/highlight.pack.js" type="text/javascript"></script><script src="highlightjs/loader.js" type="text/javascript"></script><script src="anchor-links.js" type="text/javascript"></script>
<meta name="generator" content="nixos-render-docs" />
<link rel="home" href="index.xhtml" title="Home Manager Manual" />
<link rel="up" href="index.xhtml" title="Home Manager Manual" /><link rel="prev" href="options.xhtml" title="Appendix A. Home Manager Configuration Options" /><link rel="next" href="nix-darwin-options.xhtml" title="Appendix C. nix-darwin Configuration Options" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">Appendix B. NixOS Configuration Options</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="options.xhtml">Prev</a>&nbsp;</td>
<th width="60%" align="center">&nbsp;</th>
<td width="20%" align="right">&nbsp;<a accesskey="n" href="nix-darwin-options.xhtml">Next</a></td>
</tr>
</table>
<hr />
</div><div class="appendix"> <div class="titlepage"> <div> <div> <h1 id="ch-nixos-options" class="title" >Appendix B. NixOS Configuration 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.enableLegacyProfileManagement"></a><a class="term" href="nixos-options.xhtml#nixos-opt-home-manager.enableLegacyProfileManagement"><code class="option">home-manager.enableLegacyProfileManagement</code>
</a>
</span>
</dt>
<dd>
<p>Whether to enable legacy profile management during activation. When
enabled, the Home Manager activation will produce a per-user
<code class="literal">home-manager</code> Nix profile, just like in the standalone installation of
Home Manager. Typically, this is not desired when Home Manager is
embedded in the system configuration.</p>
<p><span class="emphasis"><em>Type:</em></span>
boolean</p>
<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting nix">false
</code></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/nixos/common.nix" target="_top">
&lt;home-manager/nixos/common.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="nixos-opt-home-manager.backupCommand"></a><a class="term" href="nixos-options.xhtml#nixos-opt-home-manager.backupCommand"><code class="option">home-manager.backupCommand</code>
</a>
</span>
</dt>
<dd>
<p>On activation run this command on each existing file
rather than exiting with an error.</p>
<p><span class="emphasis"><em>Type:</em></span>
null or string or absolute path</p>
<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting nix">null
</code></pre>
<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting nix">${pkgs.trash-cli}/bin/trash
</code></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/nixos/common.nix" target="_top">
&lt;home-manager/nixos/common.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="nixos-opt-home-manager.backupFileExtension"></a><a class="term" href="nixos-options.xhtml#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.</p>
<p><span class="emphasis"><em>Type:</em></span>
null or string</p>
<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting nix">null
</code></pre>
<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting nix">&quot;backup&quot;
</code></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/nixos/common.nix" target="_top">
&lt;home-manager/nixos/common.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="nixos-opt-home-manager.extraSpecialArgs"></a><a class="term" href="nixos-options.xhtml#nixos-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></p><pre><code class="programlisting nix">{ }
</code></pre>
<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting nix">{ inherit emacs-overlay; }
</code></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/nixos/common.nix" target="_top">
&lt;home-manager/nixos/common.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="nixos-opt-home-manager.minimal"></a><a class="term" href="nixos-options.xhtml#nixos-opt-home-manager.minimal"><code class="option">home-manager.minimal</code>
</a>
</span>
</dt>
<dd>
<p>Whether to enable only the necessary modules that allow home-manager to function.</p><p>This can be used to allow vendoring a minimal list of modules yourself, rather than
importing every single module.</p><p>THIS IS FOR ADVANCED USERS, AND WILL DISABLE ALMOST EVERY MODULE.
THIS SHOULD NOT BE ENABLED UNLESS YOU KNOW THE IMPLICATIONS.
.</p>
<p><span class="emphasis"><em>Type:</em></span>
boolean</p>
<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting nix">false
</code></pre>
<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting nix">true
</code></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/nixos/common.nix" target="_top">
&lt;home-manager/nixos/common.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="nixos-opt-home-manager.overwriteBackup"></a><a class="term" href="nixos-options.xhtml#nixos-opt-home-manager.overwriteBackup"><code class="option">home-manager.overwriteBackup</code>
</a>
</span>
</dt>
<dd>
<p>Whether to enable forced overwriting of existing backup files when using <code class="literal">backupFileExtension</code>
.</p>
<p><span class="emphasis"><em>Type:</em></span>
boolean</p>
<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting nix">false
</code></pre>
<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting nix">true
</code></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/nixos/common.nix" target="_top">
&lt;home-manager/nixos/common.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="nixos-opt-home-manager.sharedModules"></a><a class="term" href="nixos-options.xhtml#nixos-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></p><pre><code class="programlisting nix">[ ]
</code></pre>
<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting nix">[ { home.packages = [ nixpkgs-fmt ]; } ]
</code></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/nixos/common.nix" target="_top">
&lt;home-manager/nixos/common.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="nixos-opt-home-manager.startAsUserService"></a><a class="term" href="nixos-options.xhtml#nixos-opt-home-manager.startAsUserService"><code class="option">home-manager.startAsUserService</code>
</a>
</span>
</dt>
<dd>
<p>Whether to activate each user’s environment on demand, when
they log in, using a systemd user service. If this option is
off, all configured users’ environments are instead activated
during boot-up.</p><p>This option needs to be turned on in any situation where users’
home directories are not available until they log in; for
example, when using pam_mount.</p><p>Other usage scenarios are still experimental. It may speed up
boot when there are many users; this has not yet been confirmed.
It could break configurations where the configured users do not
(or do not always) run their processes within a complete
systemd-managed user context.</p>
<p><span class="emphasis"><em>Type:</em></span>
boolean</p>
<p><span class="emphasis"><em>Default:</em></span></p><pre><code class="programlisting nix">false
</code></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/nixos" target="_top">
&lt;home-manager/nixos&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="nixos-opt-home-manager.useGlobalPkgs"></a><a class="term" href="nixos-options.xhtml#nixos-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>
argument in Home Manager. This disables the Home Manager
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></p><pre><code class="programlisting nix">false
</code></pre>
<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting nix">true
</code></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/nixos/common.nix" target="_top">
&lt;home-manager/nixos/common.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="nixos-opt-home-manager.useUserPackages"></a><a class="term" href="nixos-options.xhtml#nixos-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></p><pre><code class="programlisting nix">false
</code></pre>
<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting nix">true
</code></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/nixos/common.nix" target="_top">
&lt;home-manager/nixos/common.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="nixos-opt-home-manager.users"></a><a class="term" href="nixos-options.xhtml#nixos-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></p><pre><code class="programlisting nix">{ }
</code></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/nixos/common.nix" target="_top">
&lt;home-manager/nixos/common.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="nixos-opt-home-manager.verbose"></a><a class="term" href="nixos-options.xhtml#nixos-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></p><pre><code class="programlisting nix">false
</code></pre>
<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting nix">true
</code></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/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="options.xhtml">Prev</a>&nbsp;</td>
<td width="20%" align="center">&nbsp;</td>
<td width="40%" align="right">&nbsp;<a accesskey="n" href="nix-darwin-options.xhtml">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">Appendix A. Home Manager Configuration Options&nbsp;</td>
<td width="20%" align="center"><a accesskey="h" href="index.xhtml">Home</a></td>
<td width="40%" align="right" valign="top">&nbsp;Appendix C. nix-darwin Configuration Options</td>
</tr>
</table>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink