eeva/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-10 21:29:48 +01:00
Code Issues Releases Wiki Activity
home-manager/nixos-options.html
rycee 6bf6c82698 deploy: 7db6291d95
2023-12-09 08:36:28 +00:00

239 lines
No EOL
9.3 KiB
HTML
Raw 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="/nix/store/pxpsr0b80pfn3i5pvq8kqq3z1bwlqcig-source/static/style.css" /><link rel="stylesheet" type="text/css" href="/nix/store/nldgsy5s3zyr7dh964hbc9qg2ng9ja0y-home-manager-manual/share/doc/home-manager/highlightjs/tomorrow-night.min.css" /><link rel="stylesheet" type="text/css" href="/nix/store/nldgsy5s3zyr7dh964hbc9qg2ng9ja0y-home-manager-manual/share/doc/home-manager/highlightjs/highlight-style.css" />
<script src="/nix/store/nldgsy5s3zyr7dh964hbc9qg2ng9ja0y-home-manager-manual/share/doc/home-manager/highlightjs/highlight.pack.js" type="text/javascript"></script><script src="/nix/store/nldgsy5s3zyr7dh964hbc9qg2ng9ja0y-home-manager-manual/share/doc/home-manager/highlightjs/loader.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.html" title="Appendix A. Home Manager Configuration Options" /><link rel="next" href="nix-darwin-options.html" 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.html">Prev</a>&nbsp;</td>
<th width="60%" align="center">&nbsp;</th>
<td width="20%" align="right">&nbsp;<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 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.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.</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">&quot;backup&quot;</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="nixos-opt-home-manager.extraSpecialArgs"></a><a class="term" href="nixos-options.html#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>
<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="nixos-opt-home-manager.sharedModules"></a><a class="term" href="nixos-options.html#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>
<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="nixos-opt-home-manager.useGlobalPkgs"></a><a class="term" href="nixos-options.html#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>
<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="nixos-opt-home-manager.useUserPackages"></a><a class="term" href="nixos-options.html#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>
<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="nixos-opt-home-manager.users"></a><a class="term" href="nixos-options.html#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>
<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="nixos-opt-home-manager.verbose"></a><a class="term" href="nixos-options.html#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>
<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="options.html">Prev</a>&nbsp;</td>
<td width="20%" align="center">&nbsp;</td>
<td width="40%" align="right">&nbsp;<a accesskey="n" href="nix-darwin-options.html">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 a new issue View git blame Copy permalink