2023-12-09 09:36:28 +01:00
|
|
|
|
<?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>
|
2024-02-01 08:08:35 +01:00
|
|
|
|
<link rel="stylesheet" type="text/css" href="style.css" />
|
2023-12-09 14:34:08 +01:00
|
|
|
|
<script src="highlightjs/highlight.pack.js" type="text/javascript"></script><script src="highlightjs/loader.js" type="text/javascript"></script>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
<meta name="generator" content="nixos-render-docs" />
|
|
|
|
|
|
<link rel="home" href="index.xhtml" title="Home Manager Manual" />
|
2023-12-16 11:04:33 +01:00
|
|
|
|
<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" />
|
2023-12-09 09:36:28 +01:00
|
|
|
|
</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>
|
2023-12-16 11:04:33 +01:00
|
|
|
|
<td width="20%" align="left"><a accesskey="p" href="options.xhtml">Prev</a> </td>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
<th width="60%" align="center"> </th>
|
2023-12-16 11:04:33 +01:00
|
|
|
|
<td width="20%" align="right"> <a accesskey="n" href="nix-darwin-options.xhtml">Next</a></td>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
<hr />
|
2024-03-27 16:06:11 +01:00
|
|
|
|
</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">
|
2023-12-09 09:36:28 +01:00
|
|
|
|
<a id="nixos-options"></a>
|
|
|
|
|
|
<dl class="variablelist">
|
|
|
|
|
|
<dt>
|
|
|
|
|
|
<span class="term">
|
2023-12-16 11:04:33 +01:00
|
|
|
|
<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>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
</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">
|
2023-07-19 18:10:38 +02:00
|
|
|
|
<home-manager/nixos/common.nix>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
</a></code>
|
|
|
|
|
|
</td></tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt>
|
|
|
|
|
|
<span class="term">
|
2023-12-16 11:04:33 +01:00
|
|
|
|
<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>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
</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">
|
2023-07-19 18:10:38 +02:00
|
|
|
|
<home-manager/nixos/common.nix>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
</a></code>
|
|
|
|
|
|
</td></tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt>
|
|
|
|
|
|
<span class="term">
|
2023-12-16 11:04:33 +01:00
|
|
|
|
<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>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
</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">
|
2023-07-19 18:10:38 +02:00
|
|
|
|
<home-manager/nixos/common.nix>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
</a></code>
|
|
|
|
|
|
</td></tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt>
|
|
|
|
|
|
<span class="term">
|
2023-12-16 11:04:33 +01:00
|
|
|
|
<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>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
</a>
|
|
|
|
|
|
</span>
|
|
|
|
|
|
</dt>
|
|
|
|
|
|
<dd>
|
|
|
|
|
|
<p>Whether to enable using the system configuration’s <code class="literal">pkgs</code>
|
2021-01-21 23:50:50 +01:00
|
|
|
|
argument in Home Manager. This disables the Home Manager
|
2023-12-09 09:36:28 +01: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">
|
2023-07-19 18:10:38 +02:00
|
|
|
|
<home-manager/nixos/common.nix>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
</a></code>
|
|
|
|
|
|
</td></tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt>
|
|
|
|
|
|
<span class="term">
|
2023-12-16 11:04:33 +01:00
|
|
|
|
<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>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
</a>
|
|
|
|
|
|
</span>
|
|
|
|
|
|
</dt>
|
|
|
|
|
|
<dd>
|
|
|
|
|
|
<p>Whether to enable installation of user packages through the
|
|
|
|
|
|
<code class="option">users.users.<name>.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">
|
2023-07-19 18:10:38 +02:00
|
|
|
|
<home-manager/nixos/common.nix>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
</a></code>
|
|
|
|
|
|
</td></tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt>
|
|
|
|
|
|
<span class="term">
|
2023-12-16 11:04:33 +01:00
|
|
|
|
<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>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
</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">
|
2023-07-19 18:10:38 +02:00
|
|
|
|
<home-manager/nixos/common.nix>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
</a></code>
|
|
|
|
|
|
</td></tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt>
|
|
|
|
|
|
<span class="term">
|
2023-12-16 11:04:33 +01:00
|
|
|
|
<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>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
</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">
|
2023-07-19 18:10:38 +02:00
|
|
|
|
<home-manager/nixos/common.nix>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
</a></code>
|
|
|
|
|
|
</td></tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div> <div class="navfooter">
|
|
|
|
|
|
<hr />
|
|
|
|
|
|
<table width="100%" summary="Navigation footer">
|
|
|
|
|
|
<tr>
|
2023-12-16 11:04:33 +01:00
|
|
|
|
<td width="40%" align="left"><a accesskey="p" href="options.xhtml">Prev</a> </td>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
<td width="20%" align="center"> </td>
|
2023-12-16 11:04:33 +01:00
|
|
|
|
<td width="40%" align="right"> <a accesskey="n" href="nix-darwin-options.xhtml">Next</a></td>
|
2023-12-09 09:36:28 +01:00
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td width="40%" align="left" valign="top">Appendix A. Home Manager Configuration Options </td>
|
|
|
|
|
|
<td width="20%" align="center"><a accesskey="h" href="index.xhtml">Home</a></td>
|
|
|
|
|
|
<td width="40%" align="right" valign="top"> Appendix C. nix-darwin Configuration Options</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
