Mirrors/home-manager
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

deploy: eb869521cb

Browse source
This commit is contained in:
sumnerevans 2024-03-27 15:06:11 +00:00
parent f71f301975
commit e560b2c552
5 changed files with 77 additions and 74 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

90
index.xhtml
View file

@ -34,7 +34,7 @@
<hr /> <hr />
</div> </div>
<div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="preface"> <a href="index.xhtml#preface">Preface</a> </span></dt><dt> <span class="part"> <a href="index.xhtml#ch-installation">Installing Home Manager</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-install-standalone">Standalone installation</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-install-nixos-module">NixOS module</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-install-nix-darwin-module">nix-darwin module</a> </span></dt></dl></dd><dt> <span class="part"> <a href="index.xhtml#ch-usage">Using Home Manager</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-usage-configuration">Configuration Example</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-usage-rollbacks">Rollbacks</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-usage-dotfiles">Keeping your ~ safe from harm</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-usage-graphical">Graphical services</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-updating">Updating</a> </span></dt></dl></dd><dt> <span class="part"> <a href="index.xhtml#ch-nix-flakes">Nix Flakes</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-flakes-prerequisites">Prerequisites</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-flakes-standalone">Standalone setup</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-flakes-nixos-module">NixOS module</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-flakes-nix-darwin-module">nix-darwin module</a> </span></dt></dl></dd><dt> <span class="part"> <a href="index.xhtml#ch-writing-modules">Writing Home Manager Modules</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-option-types">Option Types</a> </span></dt></dl></dd><dt> <span class="part"> <a href="index.xhtml#ch-contributing">Contributing</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-contrib-getting-started">Getting started</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines">Guidelines</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-news">News</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-tests">Tests</a> </span></dt></dl></dd><dt> <span class="part"> <a href="index.xhtml#ch-3rd-party">Third-Party Tools and Extensions</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-3rd-party-module-collections">Module Collections</a> </span></dt></dl></dd><dt> <span class="part"> <a href="index.xhtml#ch-faq">Frequently Asked Questions (FAQ)</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#_why_is_there_a_collision_error_when_switching_generation">Why is there a collision error when switching generation?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_why_are_the_session_variables_not_set">Why are the session variables not set?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_how_to_set_up_a_configuration_for_multiple_users_machines">How to set up a configuration for multiple users/machines?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_why_do_i_get_an_error_message_about_literal_ca_desrt_dconf_literal_or_literal_dconf_service_literal">Why do I get an error message about <code class="literal">ca.desrt.dconf</code> or <code class="literal">dconf.service</code>?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_how_do_i_install_packages_from_nixpkgs_unstable">How do I install packages from Nixpkgs unstable?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_how_do_i_change_the_package_used_by_a_module">How do I change the package used by a module?</a> </span></dt></dl></dd><dt> <span class="appendix"> <a href="options.xhtml">A. Home Manager Configuration Options</a> </span></dt><dt> <span class="appendix"> <a href="nixos-options.xhtml">B. NixOS Configuration Options</a> </span></dt><dt> <span class="appendix"> <a href="nix-darwin-options.xhtml">C. nix-darwin Configuration Options</a> </span></dt><dt> <span class="appendix"> <a href="release-notes.xhtml">D. Release Notes</a> </span></dt> </dl></div> <div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="preface"> <a href="index.xhtml#preface">Preface</a> </span></dt><dt> <span class="part"> <a href="index.xhtml#ch-installation">Installing Home Manager</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-install-standalone">Standalone installation</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-install-nixos-module">NixOS module</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-install-nix-darwin-module">nix-darwin module</a> </span></dt></dl></dd><dt> <span class="part"> <a href="index.xhtml#ch-usage">Using Home Manager</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-usage-configuration">Configuration Example</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-usage-rollbacks">Rollbacks</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-usage-dotfiles">Keeping your ~ safe from harm</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-usage-graphical">Graphical services</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-updating">Updating</a> </span></dt></dl></dd><dt> <span class="part"> <a href="index.xhtml#ch-nix-flakes">Nix Flakes</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-flakes-prerequisites">Prerequisites</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-flakes-standalone">Standalone setup</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-flakes-nixos-module">NixOS module</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-flakes-nix-darwin-module">nix-darwin module</a> </span></dt></dl></dd><dt> <span class="part"> <a href="index.xhtml#ch-writing-modules">Writing Home Manager Modules</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-option-types">Option Types</a> </span></dt></dl></dd><dt> <span class="part"> <a href="index.xhtml#ch-contributing">Contributing</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-contrib-getting-started">Getting started</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines">Guidelines</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-news">News</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-tests">Tests</a> </span></dt></dl></dd><dt> <span class="part"> <a href="index.xhtml#ch-3rd-party">Third-Party Tools and Extensions</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#sec-3rd-party-module-collections">Module Collections</a> </span></dt></dl></dd><dt> <span class="part"> <a href="index.xhtml#ch-faq">Frequently Asked Questions (FAQ)</a> </span></dt><dd><dl><dt> <span class="section"> <a href="index.xhtml#_why_is_there_a_collision_error_when_switching_generation">Why is there a collision error when switching generation?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_why_are_the_session_variables_not_set">Why are the session variables not set?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_how_to_set_up_a_configuration_for_multiple_users_machines">How to set up a configuration for multiple users/machines?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_why_do_i_get_an_error_message_about_literal_ca_desrt_dconf_literal_or_literal_dconf_service_literal">Why do I get an error message about <code class="literal">ca.desrt.dconf</code> or <code class="literal">dconf.service</code>?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_how_do_i_install_packages_from_nixpkgs_unstable">How do I install packages from Nixpkgs unstable?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_how_do_i_change_the_package_used_by_a_module">How do I change the package used by a module?</a> </span></dt></dl></dd><dt> <span class="appendix"> <a href="options.xhtml">A. Home Manager Configuration Options</a> </span></dt><dt> <span class="appendix"> <a href="nixos-options.xhtml">B. NixOS Configuration Options</a> </span></dt><dt> <span class="appendix"> <a href="nix-darwin-options.xhtml">C. nix-darwin Configuration Options</a> </span></dt><dt> <span class="appendix"> <a href="release-notes.xhtml">D. Release Notes</a> </span></dt> </dl></div>
<div class="preface"> <div class="titlepage"> <div> <div> <h1 class="title" > <span id="preface"></span>Preface </h1> </div> </div></div><p>This manual will eventually describe how to install, use, and extend Home <div class="preface"> <div class="titlepage"> <div> <div> <h1 id="preface" class="title" >Preface </h1> </div> </div></div><p>This manual will eventually describe how to install, use, and extend Home
Manager.</p><p>If you encounter problems then please reach out on the IRC channel Manager.</p><p>If you encounter problems then please reach out on the IRC channel
<a class="link" href="https://webchat.oftc.net/?channels=home-manager" target="_top">#home-manager</a> <a class="link" href="https://webchat.oftc.net/?channels=home-manager" target="_top">#home-manager</a>
hosted by <a class="link" href="https://oftc.net/" target="_top">OFTC</a>. hosted by <a class="link" href="https://oftc.net/" target="_top">OFTC</a>.
@ -45,7 +45,7 @@ be reported on the
<a class="link" href="https://github.com/nix-community/home-manager/issues" target="_top">Home Manager issue tracker</a>.</p><div class="note"><h3 class="title">Note</h3><p>Commands prefixed with <code class="literal">$ sudo</code> have to be run as root, either <a class="link" href="https://github.com/nix-community/home-manager/issues" target="_top">Home Manager issue tracker</a>.</p><div class="note"><h3 class="title">Note</h3><p>Commands prefixed with <code class="literal">$ sudo</code> have to be run as root, either
requiring to login as root user or temporarily switching to it using requiring to login as root user or temporarily switching to it using
<code class="literal">sudo</code> for example.</p></div> <code class="literal">sudo</code> for example.</p></div>
</div><div class="part"> <div class="titlepage"> <div> <div> <h1 class="title" > <span id="ch-installation"></span>Installing Home Manager </h1> </div> </div></div><div class="partintro"><p>Home Manager can be used in three primary ways:</p><div class="orderedlist"><ol class="orderedlist " type="1"><li class="listitem"><p>Using the standalone <code class="literal">home-manager</code> tool. For platforms other than </div><div class="part"> <div class="titlepage"> <div> <div> <h1 id="ch-installation" class="title" >Installing Home Manager </h1> </div> </div></div><div class="partintro"><p>Home Manager can be used in three primary ways:</p><div class="orderedlist"><ol class="orderedlist " type="1"><li class="listitem"><p>Using the standalone <code class="literal">home-manager</code> tool. For platforms other than
NixOS and Darwin, this is the only available choice. It is also NixOS and Darwin, this is the only available choice. It is also
recommended for people on NixOS or Darwin that want to manage their recommended for people on NixOS or Darwin that want to manage their
home directory independently of the system as a whole. See home directory independently of the system as a whole. See
@ -61,7 +61,7 @@ module</a> for a description of this
setup.</p></li></ol></div><div class="note"><h3 class="title">Note</h3><p>In this chapter we describe how to install Home Manager in the standard setup.</p></li></ol></div><div class="note"><h3 class="title">Note</h3><p>In this chapter we describe how to install Home Manager in the standard
way using channels. If you prefer to use <a class="link" href="https://nixos.wiki/wiki/Flakes" target="_top">Nix way using channels. If you prefer to use <a class="link" href="https://nixos.wiki/wiki/Flakes" target="_top">Nix
Flakes</a> then please see the instructions Flakes</a> then please see the instructions
in <a class="link" href="index.xhtml#ch-nix-flakes" title="Nix Flakes" >nix flakes</a>.</p></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-install-standalone">Standalone installation</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-install-nixos-module">NixOS module</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-install-nix-darwin-module">nix-darwin module</a> </span></dt> </dl></div></div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-install-standalone"></span>Standalone installation </h2> </div> </div></div><div class="orderedlist"><ol class="orderedlist " type="1"><li class="listitem"><p>Make sure you have a working Nix installation. Specifically, make in <a class="link" href="index.xhtml#ch-nix-flakes" title="Nix Flakes" >nix flakes</a>.</p></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-install-standalone">Standalone installation</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-install-nixos-module">NixOS module</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-install-nix-darwin-module">nix-darwin module</a> </span></dt> </dl></div></div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-install-standalone" class="title" style="clear: both">Standalone installation </h2> </div> </div></div><div class="orderedlist"><ol class="orderedlist " type="1"><li class="listitem"><p>Make sure you have a working Nix installation. Specifically, make
sure that your user is able to build and install Nix packages. For sure that your user is able to build and install Nix packages. For
example, you should be able to successfully run a command like example, you should be able to successfully run a command like
<code class="literal">nix-instantiate &#x27;&lt;nixpkgs&gt;&#x27; -A hello</code> without having to switch to <code class="literal">nix-instantiate &#x27;&lt;nixpkgs&gt;&#x27; -A hello</code> without having to switch to
@ -92,7 +92,7 @@ checkout of the repository then you can use the
<a class="link" href="options.xhtml#opt-programs.home-manager.path" >home-manager.path</a> option to specify the absolute <a class="link" href="options.xhtml#opt-programs.home-manager.path" >home-manager.path</a> option to specify the absolute
path to the repository.</p><p>Once installed you can see <a class="link" href="index.xhtml#ch-usage" title="Using Home Manager" >Using Home Manager</a> for a more detailed path to the repository.</p><p>Once installed you can see <a class="link" href="index.xhtml#ch-usage" title="Using Home Manager" >Using Home Manager</a> for a more detailed
description of Home Manager and how to use it.</p> description of Home Manager and how to use it.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-install-nixos-module"></span>NixOS module </h2> </div> </div></div><p>Home Manager provides a NixOS module that allows you to prepare user </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-install-nixos-module" class="title" style="clear: both">NixOS module </h2> </div> </div></div><p>Home Manager provides a NixOS module that allows you to prepare user
environments directly from the system configuration file, which often is environments directly from the system configuration file, which often is
more convenient than using the <code class="literal">home-manager</code> tool. It also opens up more convenient than using the <code class="literal">home-manager</code> tool. It also opens up
additional possibilities, for example, to automatically configure user additional possibilities, for example, to automatically configure user
@ -145,7 +145,7 @@ Nixpkgs.</p></div><div class="note"><h3 class="title">Note</h3><p>Home Manager w
you create. This contains the system’s NixOS configuration.</p><pre><code class="programlisting nix">{ lib, pkgs, osConfig, ... }: you create. This contains the system’s NixOS configuration.</p><pre><code class="programlisting nix">{ lib, pkgs, osConfig, ... }:
</code></pre></div><p>Once installed you can see <a class="link" href="index.xhtml#ch-usage" title="Using Home Manager" >Using Home Manager</a> for a more detailed </code></pre></div><p>Once installed you can see <a class="link" href="index.xhtml#ch-usage" title="Using Home Manager" >Using Home Manager</a> for a more detailed
description of Home Manager and how to use it.</p> description of Home Manager and how to use it.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-install-nix-darwin-module"></span>nix-darwin module </h2> </div> </div></div><p>Home Manager provides a module that allows you to prepare user </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-install-nix-darwin-module" class="title" style="clear: both">nix-darwin module </h2> </div> </div></div><p>Home Manager provides a module that allows you to prepare user
environments directly from the environments directly from the
<a class="link" href="https://github.com/LnL7/nix-darwin/" target="_top">nix-darwin</a> configuration file, <a class="link" href="https://github.com/LnL7/nix-darwin/" target="_top">nix-darwin</a> configuration file,
which often is more convenient than using the <code class="literal">home-manager</code> tool.</p><p>To make the NixOS module available for use you must <code class="literal">import</code> it into which often is more convenient than using the <code class="literal">home-manager</code> tool.</p><p>To make the NixOS module available for use you must <code class="literal">import</code> it into
@ -196,7 +196,7 @@ you create. This contains the system’s nix-darwin configuration.</p><pre><code
</code></pre></div><p>Once installed you can see <a class="link" href="index.xhtml#ch-usage" title="Using Home Manager" >Using Home Manager</a> for a more detailed </code></pre></div><p>Once installed you can see <a class="link" href="index.xhtml#ch-usage" title="Using Home Manager" >Using Home Manager</a> for a more detailed
description of Home Manager and how to use it.</p> description of Home Manager and how to use it.</p>
</div> </div>
</div><div class="part"> <div class="titlepage"> <div> <div> <h1 class="title" > <span id="ch-usage"></span>Using Home Manager </h1> </div> </div></div><div class="partintro"><p>Your use of Home Manager is centered around the configuration file, </div><div class="part"> <div class="titlepage"> <div> <div> <h1 id="ch-usage" class="title" >Using Home Manager </h1> </div> </div></div><div class="partintro"><p>Your use of Home Manager is centered around the configuration file,
which is typically found at <code class="literal">~/.config/home-manager/home.nix</code> in the which is typically found at <code class="literal">~/.config/home-manager/home.nix</code> in the
standard installation or <code class="literal">~/.config/home-manager/flake.nix</code> in a Nix standard installation or <code class="literal">~/.config/home-manager/flake.nix</code> in a Nix
flake based installation.</p><div class="note"><h3 class="title">Note</h3><p>The default configuration used to be placed in <code class="literal">~/.config/nixpkgs</code>¸ so flake based installation.</p><div class="note"><h3 class="title">Note</h3><p>The default configuration used to be placed in <code class="literal">~/.config/nixpkgs</code>¸ so
@ -223,7 +223,7 @@ the option. You can find the complete option documentation in
</code></pre><p>Once a configuration is successfully built, it can be activated. The </code></pre><p>Once a configuration is successfully built, it can be activated. The
activation performs the steps necessary to make the files, programs, and activation performs the steps necessary to make the files, programs, and
services available in your user environment. The <code class="literal">home-manager switch</code> services available in your user environment. The <code class="literal">home-manager switch</code>
command performs a combined build and activation.</p><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-usage-configuration">Configuration Example</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-usage-rollbacks">Rollbacks</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-usage-dotfiles">Keeping your ~ safe from harm</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-usage-graphical">Graphical services</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-updating">Updating</a> </span></dt> </dl></div></div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-usage-configuration"></span>Configuration Example </h2> </div> </div></div><p>A fresh install of Home Manager will generate a minimal command performs a combined build and activation.</p><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-usage-configuration">Configuration Example</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-usage-rollbacks">Rollbacks</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-usage-dotfiles">Keeping your ~ safe from harm</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-usage-graphical">Graphical services</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-updating">Updating</a> </span></dt> </dl></div></div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-usage-configuration" class="title" style="clear: both">Configuration Example </h2> </div> </div></div><p>A fresh install of Home Manager will generate a minimal
<code class="literal">~/.config/home-manager/home.nix</code> file containing something like</p><pre><code class="programlisting nix">{ config, pkgs, ... }: <code class="literal">~/.config/home-manager/home.nix</code> file containing something like</p><pre><code class="programlisting nix">{ config, pkgs, ... }:
{ {
@ -299,7 +299,7 @@ programs <span class="emphasis"><em>and</em></span> service options – Emacs is
</code></pre><p>or if you are not feeling so lucky,</p><pre><code class="programlisting shell">home-manager build </code></pre><p>or if you are not feeling so lucky,</p><pre><code class="programlisting shell">home-manager build
</code></pre><p>which will create a <code class="literal">result</code> link to a directory containing an </code></pre><p>which will create a <code class="literal">result</code> link to a directory containing an
activation script and the generated home directory files.</p> activation script and the generated home directory files.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-usage-rollbacks"></span>Rollbacks </h2> </div> </div></div><p>While the <code class="literal">home-manager</code> tool does not explicitly support rollbacks at </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-usage-rollbacks" class="title" style="clear: both">Rollbacks </h2> </div> </div></div><p>While the <code class="literal">home-manager</code> tool does not explicitly support rollbacks at
the moment it is relatively easy to perform one manually. The steps to the moment it is relatively easy to perform one manually. The steps to
do so are</p><div class="orderedlist"><ol class="orderedlist " type="1"><li class="listitem"><p>Run <code class="literal">home-manager generations</code> to determine which generation you do so are</p><div class="orderedlist"><ol class="orderedlist " type="1"><li class="listitem"><p>Run <code class="literal">home-manager generations</code> to determine which generation you
wish to rollback to:</p><pre><code class="programlisting shell">$ home-manager generations wish to rollback to:</p><pre><code class="programlisting shell">$ home-manager generations
@ -314,7 +314,7 @@ wish to rollback to:</p><pre><code class="programlisting shell">$ home-manager
Starting home manager activation Starting home manager activation
… …
</code></pre></li></ol></div> </code></pre></li></ol></div>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-usage-dotfiles"></span>Keeping your ~ safe from harm </h2> </div> </div></div><p>To configure programs and services Home Manager must write various </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-usage-dotfiles" class="title" style="clear: both">Keeping your ~ safe from harm </h2> </div> </div></div><p>To configure programs and services Home Manager must write various
things to your home directory. To prevent overwriting any existing files things to your home directory. To prevent overwriting any existing files
when switching to a new generation, Home Manager will attempt to detect when switching to a new generation, Home Manager will attempt to detect
collisions between existing files and generated files. If any such collisions between existing files and generated files. If any such
@ -338,7 +338,7 @@ Activating checkLinkTargets
Existing file &#x27;/home/jdoe/.config/git/config&#x27; is in the way Existing file &#x27;/home/jdoe/.config/git/config&#x27; is in the way
Please move the above files and try again Please move the above files and try again
</code></pre> </code></pre>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-usage-graphical"></span>Graphical services </h2> </div> </div></div><p>Home Manager includes a number of services intended to run in a </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-usage-graphical" class="title" style="clear: both">Graphical services </h2> </div> </div></div><p>Home Manager includes a number of services intended to run in a
graphical session, for example <code class="literal">xscreensaver</code> and <code class="literal">dunst</code>. graphical session, for example <code class="literal">xscreensaver</code> and <code class="literal">dunst</code>.
Unfortunately, such services will not be started automatically unless Unfortunately, such services will not be started automatically unless
you let Home Manager start your X session. That is, you have something you let Home Manager start your X session. That is, you have something
@ -358,7 +358,7 @@ like</p><pre><code class="programlisting nix">{
# … # …
} }
</code></pre><p>in your Home Manager configuration.</p> </code></pre><p>in your Home Manager configuration.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-updating"></span>Updating </h2> </div> </div></div><p>If you have installed Home Manager using the Nix channel method then </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-updating" class="title" style="clear: both">Updating </h2> </div> </div></div><p>If you have installed Home Manager using the Nix channel method then
updating Home Manager is done by first updating the channel. You can updating Home Manager is done by first updating the channel. You can
then switch to the updated Home Manager environment.</p><pre><code class="programlisting shell">$ nix-channel --update then switch to the updated Home Manager environment.</p><pre><code class="programlisting shell">$ nix-channel --update
… …
@ -366,7 +366,7 @@ unpacking channels...
$ home-manager switch $ home-manager switch
</code></pre> </code></pre>
</div> </div>
</div><div class="part"> <div class="titlepage"> <div> <div> <h1 class="title" > <span id="ch-nix-flakes"></span>Nix Flakes </h1> </div> </div></div><div class="partintro"><p>Home Manager is compatible with <a class="link" href="https://nixos.wiki/wiki/Flakes" target="_top">Nix </div><div class="part"> <div class="titlepage"> <div> <div> <h1 id="ch-nix-flakes" class="title" >Nix Flakes </h1> </div> </div></div><div class="partintro"><p>Home Manager is compatible with <a class="link" href="https://nixos.wiki/wiki/Flakes" target="_top">Nix
Flakes</a>. But please be aware that this Flakes</a>. But please be aware that this
support is still experimental and may change in backwards support is still experimental and may change in backwards
incompatible ways.</p><p>Just like in the standard installation you can use the Home Manager incompatible ways.</p><p>Just like in the standard installation you can use the Home Manager
@ -381,7 +381,7 @@ user profiles to be built together with the system when running
description of this setup.</p></li><li class="listitem"><p>This allows the user profiles to be built together with the system description of this setup.</p></li><li class="listitem"><p>This allows the user profiles to be built together with the system
when running <code class="literal">darwin-rebuild</code>. See <a class="link" href="index.xhtml#sec-flakes-nix-darwin-module" title="nix-darwin module" >nix-darwin when running <code class="literal">darwin-rebuild</code>. See <a class="link" href="index.xhtml#sec-flakes-nix-darwin-module" title="nix-darwin module" >nix-darwin
module</a> for a description of this module</a> for a description of this
setup.</p></li></ol></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-flakes-prerequisites">Prerequisites</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-flakes-standalone">Standalone setup</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-flakes-nixos-module">NixOS module</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-flakes-nix-darwin-module">nix-darwin module</a> </span></dt> </dl></div></div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-flakes-prerequisites"></span>Prerequisites </h2> </div> </div></div><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Install Nix 2.4 or later, or have it in <code class="literal">nix-shell</code>.</p></li><li class="listitem"><p>Enable experimental features <code class="literal">nix-command</code> and <code class="literal">flakes</code>.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: circle;"><li class="listitem"><p>When using NixOS, add the following to your <code class="literal">configuration.nix</code> setup.</p></li></ol></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-flakes-prerequisites">Prerequisites</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-flakes-standalone">Standalone setup</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-flakes-nixos-module">NixOS module</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-flakes-nix-darwin-module">nix-darwin module</a> </span></dt> </dl></div></div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-flakes-prerequisites" class="title" style="clear: both">Prerequisites </h2> </div> </div></div><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Install Nix 2.4 or later, or have it in <code class="literal">nix-shell</code>.</p></li><li class="listitem"><p>Enable experimental features <code class="literal">nix-command</code> and <code class="literal">flakes</code>.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: circle;"><li class="listitem"><p>When using NixOS, add the following to your <code class="literal">configuration.nix</code>
and rebuild your system.</p><pre><code class="programlisting nix">nix = { and rebuild your system.</p><pre><code class="programlisting nix">nix = {
package = pkgs.nixFlakes; package = pkgs.nixFlakes;
extraOptions = &#x27;&#x27; extraOptions = &#x27;&#x27;
@ -398,7 +398,7 @@ $ home-manager --extra-experimental-features &quot;nix-command flakes&quot; &lt;
the flake is built, so it must be present before bootstrap of Home the flake is built, so it must be present before bootstrap of Home
Manager from the flake. See <a class="link" href="index.xhtml#sec-usage-configuration" title="Configuration Example" >Configuration Example</a> for Manager from the flake. See <a class="link" href="index.xhtml#sec-usage-configuration" title="Configuration Example" >Configuration Example</a> for
introduction about writing a Home Manager configuration.</p></li></ul></div> introduction about writing a Home Manager configuration.</p></li></ul></div>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-flakes-standalone"></span>Standalone setup </h2> </div> </div></div><p>To prepare an initial Home Manager configuration for your logged in </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-flakes-standalone" class="title" style="clear: both">Standalone setup </h2> </div> </div></div><p>To prepare an initial Home Manager configuration for your logged in
user, you can run the Home Manager <code class="literal">init</code> command directly from its user, you can run the Home Manager <code class="literal">init</code> command directly from its
flake.</p><p>For example, if you are using the unstable version of Nixpkgs or NixOS, flake.</p><p>For example, if you are using the unstable version of Nixpkgs or NixOS,
then to generate and activate a basic configuration run the command</p><pre><code class="programlisting shell">$ nix run home-manager/master -- init --switch then to generate and activate a basic configuration run the command</p><pre><code class="programlisting shell">$ nix run home-manager/master -- init --switch
@ -421,7 +421,7 @@ to use the standard <code class="literal">nix flake update</code> command for th
or <code class="literal">--update-input &lt;input&gt;</code> to <code class="literal">home-manager</code> when building or or <code class="literal">--update-input &lt;input&gt;</code> to <code class="literal">home-manager</code> when building or
switching, and these options will be forwarded to <code class="literal">nix build</code>. See the switching, and these options will be forwarded to <code class="literal">nix build</code>. See the
<a class="link" href="https://nixos.wiki/wiki/Flakes" target="_top">NixOS Wiki page</a> for details.</p></div> <a class="link" href="https://nixos.wiki/wiki/Flakes" target="_top">NixOS Wiki page</a> for details.</p></div>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-flakes-nixos-module"></span>NixOS module </h2> </div> </div></div><p>To use Home Manager as a NixOS module, a bare-minimum <code class="literal">flake.nix</code> would </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-flakes-nixos-module" class="title" style="clear: both">NixOS module </h2> </div> </div></div><p>To use Home Manager as a NixOS module, a bare-minimum <code class="literal">flake.nix</code> would
be as follows:</p><pre><code class="programlisting nix">{ be as follows:</p><pre><code class="programlisting nix">{
description = &quot;NixOS configuration&quot;; description = &quot;NixOS configuration&quot;;
@ -456,7 +456,7 @@ and is automatically rebuilt with the system when using the appropriate
command for the system, such as command for the system, such as
<code class="literal">nixos-rebuild switch --flake &lt;flake-uri&gt;</code>.</p><p>You can use the above <code class="literal">flake.nix</code> as a template in <code class="literal">/etc/nixos</code> by</p><pre><code class="programlisting shell">$ nix flake new /etc/nixos -t github:nix-community/home-manager#nixos <code class="literal">nixos-rebuild switch --flake &lt;flake-uri&gt;</code>.</p><p>You can use the above <code class="literal">flake.nix</code> as a template in <code class="literal">/etc/nixos</code> by</p><pre><code class="programlisting shell">$ nix flake new /etc/nixos -t github:nix-community/home-manager#nixos
</code></pre> </code></pre>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-flakes-nix-darwin-module"></span>nix-darwin module </h2> </div> </div></div><p>The flake-based setup of the Home Manager nix-darwin module is similar </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-flakes-nix-darwin-module" class="title" style="clear: both">nix-darwin module </h2> </div> </div></div><p>The flake-based setup of the Home Manager nix-darwin module is similar
to that of NixOS. The <code class="literal">flake.nix</code> would be:</p><pre><code class="programlisting nix">{ to that of NixOS. The <code class="literal">flake.nix</code> would be:</p><pre><code class="programlisting nix">{
description = &quot;Darwin configuration&quot;; description = &quot;Darwin configuration&quot;;
@ -492,12 +492,12 @@ to that of NixOS. The <code class="literal">flake.nix</code> would be:</p><pre><
command here may be <code class="literal">darwin-rebuild switch --flake &lt;flake-uri&gt;</code>.</p><p>You can use the above <code class="literal">flake.nix</code> as a template in <code class="literal">~/.config/darwin</code> by</p><pre><code class="programlisting shell">$ nix flake new ~/.config/darwin -t github:nix-community/home-manager#nix-darwin command here may be <code class="literal">darwin-rebuild switch --flake &lt;flake-uri&gt;</code>.</p><p>You can use the above <code class="literal">flake.nix</code> as a template in <code class="literal">~/.config/darwin</code> by</p><pre><code class="programlisting shell">$ nix flake new ~/.config/darwin -t github:nix-community/home-manager#nix-darwin
</code></pre> </code></pre>
</div> </div>
</div><div class="part"> <div class="titlepage"> <div> <div> <h1 class="title" > <span id="ch-writing-modules"></span>Writing Home Manager Modules </h1> </div> </div></div><div class="partintro"><p>The module system in Home Manager is based entirely on the NixOS module </div><div class="part"> <div class="titlepage"> <div> <div> <h1 id="ch-writing-modules" class="title" >Writing Home Manager Modules </h1> </div> </div></div><div class="partintro"><p>The module system in Home Manager is based entirely on the NixOS module
system so we will here only highlight aspects that are specific for Home system so we will here only highlight aspects that are specific for Home
Manager. For information about the module system as such please refer to Manager. For information about the module system as such please refer to
the <a class="link" href="https://nixos.org/nixos/manual/index.html#sec-writing-modules" target="_top">Writing NixOS the <a class="link" href="https://nixos.org/nixos/manual/index.html#sec-writing-modules" target="_top">Writing NixOS
Modules</a> Modules</a>
chapter of the NixOS manual.</p><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-option-types">Option Types</a> </span></dt> </dl></div></div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-option-types"></span>Option Types </h2> </div> </div></div><p>Overall the basic option types are the same in Home Manager as NixOS. A chapter of the NixOS manual.</p><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-option-types">Option Types</a> </span></dt> </dl></div></div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-option-types" class="title" style="clear: both">Option Types </h2> </div> </div></div><p>Overall the basic option types are the same in Home Manager as NixOS. A
few Home Manager options, however, make use of custom types that are few Home Manager options, however, make use of custom types that are
worth describing in more detail. These are the option types <code class="literal">dagOf</code> and worth describing in more detail. These are the option types <code class="literal">dagOf</code> and
<code class="literal">gvariant</code> that are used, for example, by <code class="literal">gvariant</code> that are used, for example, by
@ -625,7 +625,7 @@ contains the value of a GVariant element.</p></dd><dt><span class="term"><span i
elements (GVariant format string <code class="literal">{${key.type}${value.type}}</code>), elements (GVariant format string <code class="literal">{${key.type}${value.type}}</code>),
where each element is a GVariant value.</p></dd></dl></div></dd></dl></div> where each element is a GVariant value.</p></dd></dl></div></dd></dl></div>
</div> </div>
</div><div class="part"> <div class="titlepage"> <div> <div> <h1 class="title" > <span id="ch-contributing"></span>Contributing </h1> </div> </div></div><div class="partintro"><p>Contributions to Home Manager are very welcome. To make the process as </div><div class="part"> <div class="titlepage"> <div> <div> <h1 id="ch-contributing" class="title" >Contributing </h1> </div> </div></div><div class="partintro"><p>Contributions to Home Manager are very welcome. To make the process as
smooth as possible for both you and the Home Manager maintainers we smooth as possible for both you and the Home Manager maintainers we
provide some guidelines that we ask you to follow. See <a class="link" href="index.xhtml#sec-contrib-getting-started" title="Getting started" >Getting provide some guidelines that we ask you to follow. See <a class="link" href="index.xhtml#sec-contrib-getting-started" title="Getting started" >Getting
started</a> for information on how to set up started</a> for information on how to set up
@ -640,7 +640,7 @@ to the <a class="link" href="https://github.com/nix-community/home-manager/issue
issue</a> page issue</a> page
and write a description of your problem. Include as much information as and write a description of your problem. Include as much information as
you can, ideally also include relevant excerpts from your Home Manager you can, ideally also include relevant excerpts from your Home Manager
configuration.</p><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-contrib-getting-started">Getting started</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines">Guidelines</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-news">News</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-tests">Tests</a> </span></dt> </dl></div></div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-contrib-getting-started"></span>Getting started </h2> </div> </div></div><p>If you have not previously forked Home Manager then you need to do that configuration.</p><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-contrib-getting-started">Getting started</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines">Guidelines</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-news">News</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-tests">Tests</a> </span></dt> </dl></div></div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-contrib-getting-started" class="title" style="clear: both">Getting started </h2> </div> </div></div><p>If you have not previously forked Home Manager then you need to do that
first. Have a look at GitHub’s <a class="link" href="https://help.github.com/articles/fork-a-repo/" target="_top">Fork a first. Have a look at GitHub’s <a class="link" href="https://help.github.com/articles/fork-a-repo/" target="_top">Fork a
repo</a> for instructions on repo</a> for instructions on
how to do this.</p><p>Once you have a fork of Home Manager you should create a branch starting how to do this.</p><p>Once you have a fork of Home Manager you should create a branch starting
@ -656,13 +656,13 @@ programs.home-manager.path = &quot;$HOME/devel/home-manager&quot;;
</code></pre><p>and running <code class="literal">home-manager switch</code> to activate the change. </code></pre><p>and running <code class="literal">home-manager switch</code> to activate the change.
Afterwards, <code class="literal">home-manager build</code> and <code class="literal">home-manager switch</code> will use Afterwards, <code class="literal">home-manager build</code> and <code class="literal">home-manager switch</code> will use
your cloned repository.</p></li></ol></div><p>The first option is good if you only temporarily want to use your clone.</p> your cloned repository.</p></li></ol></div><p>The first option is good if you only temporarily want to use your clone.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-guidelines"></span>Guidelines </h2> </div> </div></div><div class="toc"> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-guidelines-back-compat">Maintain backward compatibility</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-forward-compat">Keep forward compatibility in mind</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-valuable-options">Add only valuable options</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-add-tests">Add relevant tests</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-module-maintainer">Add relevant documentation</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_add_yourself_as_a_module_maintainer">Add yourself as a module maintainer</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-code-style">Format your code</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-commit-message-style">Format your commit messages</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-news-style">Format your news entries</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-conditional-modules">Use conditional modules and news</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-licensing">Mind the license</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-commit-style">Commits</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#ex-commit-message">Example commit</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-code-style">Code Style</a> </span></dt> </dl></div><p>If your contribution satisfy the following rules then there is a good </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-guidelines" class="title" style="clear: both">Guidelines </h2> </div> </div></div><div class="toc"> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-guidelines-back-compat">Maintain backward compatibility</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-forward-compat">Keep forward compatibility in mind</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-valuable-options">Add only valuable options</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-add-tests">Add relevant tests</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-module-maintainer">Add relevant documentation</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_add_yourself_as_a_module_maintainer">Add yourself as a module maintainer</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-code-style">Format your code</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-commit-message-style">Format your commit messages</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-news-style">Format your news entries</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-conditional-modules">Use conditional modules and news</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-guidelines-licensing">Mind the license</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-commit-style">Commits</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#ex-commit-message">Example commit</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#sec-code-style">Code Style</a> </span></dt> </dl></div><p>If your contribution satisfy the following rules then there is a good
chance it will be merged without too much trouble. The rules are chance it will be merged without too much trouble. The rules are
enforced by the Home Manager maintainers and to a lesser extent the Home enforced by the Home Manager maintainers and to a lesser extent the Home
Manager CI system.</p><p>If you are uncertain how these rules affect the change you would like to Manager CI system.</p><p>If you are uncertain how these rules affect the change you would like to
make then feel free to start a discussion in the make then feel free to start a discussion in the
<a class="link" href="https://webchat.oftc.net/?channels=home-manager" target="_top">#home-manager</a> IRC <a class="link" href="https://webchat.oftc.net/?channels=home-manager" target="_top">#home-manager</a> IRC
channel, ideally before you start developing.</p><div class="section"> <div class="titlepage"> <div> <div> <h3 class="title" > <span id="sec-guidelines-back-compat"></span>Maintain backward compatibility </h3> </div> </div></div><p>Your contribution should not cause another user’s existing configuration channel, ideally before you start developing.</p><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-guidelines-back-compat" class="title" >Maintain backward compatibility </h3> </div> </div></div><p>Your contribution should not cause another user’s existing configuration
to break unless there is a very good reason and the change should be to break unless there is a very good reason and the change should be
announced to the user through an announced to the user through an
<a class="link" href="https://nixos.org/manual/nixos/stable/index.html#sec-assertions" target="_top">assertion</a> <a class="link" href="https://nixos.org/manual/nixos/stable/index.html#sec-assertions" target="_top">assertion</a>
@ -670,12 +670,12 @@ or similar.</p><p>Remember that Home Manager is used in many different environme
you should consider how your change may effect others. For example,</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Does your change work for people that do not use NixOS? Consider you should consider how your change may effect others. For example,</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Does your change work for people that do not use NixOS? Consider
other GNU/Linux distributions and macOS.</p></li><li class="listitem"><p>Does your change work for people whose configuration is built on one other GNU/Linux distributions and macOS.</p></li><li class="listitem"><p>Does your change work for people whose configuration is built on one
system and deployed on another system?</p></li></ul></div> system and deployed on another system?</p></li></ul></div>
</div><div class="section"> <div class="titlepage"> <div> <div> <h3 class="title" > <span id="sec-guidelines-forward-compat"></span>Keep forward compatibility in mind </h3> </div> </div></div><p>The master branch of Home Manager tracks the unstable channel of </div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-guidelines-forward-compat" class="title" >Keep forward compatibility in mind </h3> </div> </div></div><p>The master branch of Home Manager tracks the unstable channel of
Nixpkgs, which may update package versions at any time. It is therefore Nixpkgs, which may update package versions at any time. It is therefore
important to consider how a package update may affect your code and try important to consider how a package update may affect your code and try
to reduce the risk of breakage.</p><p>The most effective way to reduce this risk is to follow the advice in to reduce the risk of breakage.</p><p>The most effective way to reduce this risk is to follow the advice in
<a class="link" href="index.xhtml#sec-guidelines-valuable-options" title="Add only valuable options" >Add only valuable options</a>.</p> <a class="link" href="index.xhtml#sec-guidelines-valuable-options" title="Add only valuable options" >Add only valuable options</a>.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h3 class="title" > <span id="sec-guidelines-valuable-options"></span>Add only valuable options </h3> </div> </div></div><p>When creating a new module it is tempting to include every option </div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-guidelines-valuable-options" class="title" >Add only valuable options </h3> </div> </div></div><p>When creating a new module it is tempting to include every option
supported by the software. This is <span class="emphasis"><em>strongly</em></span> discouraged. Providing supported by the software. This is <span class="emphasis"><em>strongly</em></span> discouraged. Providing
many options increases maintenance burden and risk of breakage many options increases maintenance burden and risk of breakage
considerably. This is why only the most <a class="link" href="https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md#valuable-options" target="_top">important software considerably. This is why only the most <a class="link" href="https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md#valuable-options" target="_top">important software
@ -689,11 +689,11 @@ require no explicit options at all.</p><p>If the software uses a structured conf
YAML, INI, TOML, or even a plain list of key/value pairs then consider YAML, INI, TOML, or even a plain list of key/value pairs then consider
using a <code class="literal">settings</code> option as described in <a class="link" href="https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md" target="_top">Nix RFC using a <code class="literal">settings</code> option as described in <a class="link" href="https://github.com/NixOS/rfcs/blob/master/rfcs/0042-config-option.md" target="_top">Nix RFC
42</a>.</p> 42</a>.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h3 class="title" > <span id="sec-guidelines-add-tests"></span>Add relevant tests </h3> </div> </div></div><p>If at all possible, make sure to add new tests and expand existing tests </div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-guidelines-add-tests" class="title" >Add relevant tests </h3> </div> </div></div><p>If at all possible, make sure to add new tests and expand existing tests
so that your change will keep working in the future. See so that your change will keep working in the future. See
<a class="link" href="index.xhtml#sec-tests" title="Tests" >Tests</a> for more information about the Home Manager test <a class="link" href="index.xhtml#sec-tests" title="Tests" >Tests</a> for more information about the Home Manager test
suite.</p><p>All contributed code <span class="emphasis"><em>must</em></span> pass the test suite.</p> suite.</p><p>All contributed code <span class="emphasis"><em>must</em></span> pass the test suite.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h3 class="title" > <span id="sec-guidelines-module-maintainer"></span>Add relevant documentation </h3> </div> </div></div><p>Many code changes require changing the documentation as well. The </div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-guidelines-module-maintainer" class="title" >Add relevant documentation </h3> </div> </div></div><p>Many code changes require changing the documentation as well. The
documentation is written in documentation is written in
<a class="link" href="https://nixos.org/manual/nixpkgs/unstable/#sec-contributing-markup" target="_top">Nixpkgs-flavoured Markdown</a>. <a class="link" href="https://nixos.org/manual/nixpkgs/unstable/#sec-contributing-markup" target="_top">Nixpkgs-flavoured Markdown</a>.
All text is hosted in Home Manager’s Git repository.</p><p>The HTML version of the manual containing both the module option All text is hosted in Home Manager’s Git repository.</p><p>The HTML version of the manual containing both the module option
@ -705,26 +705,26 @@ $ xdg-open ./result/share/doc/home-manager/index.html
the man page version of the module options looks good:</p><pre><code class="programlisting shell">$ nix-build -A docs.manPages the man page version of the module options looks good:</p><pre><code class="programlisting shell">$ nix-build -A docs.manPages
$ man ./result/share/man/man5/home-configuration.nix.5.gz $ man ./result/share/man/man5/home-configuration.nix.5.gz
</code></pre> </code></pre>
</div><div class="section"> <div class="titlepage"> <div> <div> <h3 class="title" > <span id="_add_yourself_as_a_module_maintainer"></span>Add yourself as a module maintainer </h3> </div> </div></div><p>Every new module <span class="emphasis"><em>must</em></span> include a named maintainer using the </div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="_add_yourself_as_a_module_maintainer" class="title" >Add yourself as a module maintainer </h3> </div> </div></div><p>Every new module <span class="emphasis"><em>must</em></span> include a named maintainer using the
<code class="literal">meta.maintainers</code> attribute. If you are a user of a module that <code class="literal">meta.maintainers</code> attribute. If you are a user of a module that
currently lacks a maintainer then please consider adopting it.</p><p>If you are present in the nixpkgs maintainer list then you can use that currently lacks a maintainer then please consider adopting it.</p><p>If you are present in the nixpkgs maintainer list then you can use that
entry. If you are not then you can add yourself to entry. If you are not then you can add yourself to
<code class="literal">modules/lib/maintainers.nix</code> in the Home Manager project.</p><p>As a maintainer you are expected to respond to issues and <code class="literal">modules/lib/maintainers.nix</code> in the Home Manager project.</p><p>As a maintainer you are expected to respond to issues and
pull-requests associated with your module.</p><p>Maintainers are encouraged to join the IRC or Matrix channel and pull-requests associated with your module.</p><p>Maintainers are encouraged to join the IRC or Matrix channel and
participate when they have opportunity.</p> participate when they have opportunity.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h3 class="title" > <span id="sec-guidelines-code-style"></span>Format your code </h3> </div> </div></div><p>Make sure your code is formatted as described in <a class="link" href="index.xhtml#sec-code-style" title="Code Style" >Code </div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-guidelines-code-style" class="title" >Format your code </h3> </div> </div></div><p>Make sure your code is formatted as described in <a class="link" href="index.xhtml#sec-code-style" title="Code Style" >Code
Style</a>. To maintain consistency throughout the project Style</a>. To maintain consistency throughout the project
you are encouraged to browse through existing code and adopt its style you are encouraged to browse through existing code and adopt its style
also in new code.</p> also in new code.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h3 class="title" > <span id="sec-guidelines-commit-message-style"></span>Format your commit messages </h3> </div> </div></div><p>Similar to <a class="link" href="index.xhtml#sec-guidelines-code-style" title="Format your code" >Format your code</a> we encourage a </div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-guidelines-commit-message-style" class="title" >Format your commit messages </h3> </div> </div></div><p>Similar to <a class="link" href="index.xhtml#sec-guidelines-code-style" title="Format your code" >Format your code</a> we encourage a
consistent commit message format as described in consistent commit message format as described in
<a class="link" href="index.xhtml#sec-commit-style" title="Commits" >Commits</a>.</p> <a class="link" href="index.xhtml#sec-commit-style" title="Commits" >Commits</a>.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h3 class="title" > <span id="sec-guidelines-news-style"></span>Format your news entries </h3> </div> </div></div><p>If your contribution includes a change that should be communicated to </div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-guidelines-news-style" class="title" >Format your news entries </h3> </div> </div></div><p>If your contribution includes a change that should be communicated to
users of Home Manager then you can add a news entry. The entry must be users of Home Manager then you can add a news entry. The entry must be
formatted as described in <a class="link" href="index.xhtml#sec-news" title="News" >News</a>.</p><p>When new modules are added a news entry should be included but you do formatted as described in <a class="link" href="index.xhtml#sec-news" title="News" >News</a>.</p><p>When new modules are added a news entry should be included but you do
not need to create this entry manually. The merging maintainer will not need to create this entry manually. The merging maintainer will
create the entry for you. This is to reduce the risk of merge conflicts.</p> create the entry for you. This is to reduce the risk of merge conflicts.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h3 class="title" > <span id="sec-guidelines-conditional-modules"></span>Use conditional modules and news </h3> </div> </div></div><p>Home Manager includes a number of modules that are only usable on some </div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-guidelines-conditional-modules" class="title" >Use conditional modules and news </h3> </div> </div></div><p>Home Manager includes a number of modules that are only usable on some
of the supported platforms. The most common example of platform specific of the supported platforms. The most common example of platform specific
modules are those that define systemd user services, which only works on modules are those that define systemd user services, which only works on
Linux systems.</p><p>If you add a module that is platform specific then make sure to include Linux systems.</p><p>If you add a module that is platform specific then make sure to include
@ -732,7 +732,7 @@ a condition in the <code class="literal">loadModule</code> function call. This w
accessible only on systems where the condition evaluates to <code class="literal">true</code>.</p><p>Similarly, if you are adding a news entry then it should be shown only accessible only on systems where the condition evaluates to <code class="literal">true</code>.</p><p>Similarly, if you are adding a news entry then it should be shown only
to users that may find it relevant, see <a class="link" href="index.xhtml#sec-news" title="News" >News</a> for a to users that may find it relevant, see <a class="link" href="index.xhtml#sec-news" title="News" >News</a> for a
description of conditional news.</p> description of conditional news.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h3 class="title" > <span id="sec-guidelines-licensing"></span>Mind the license </h3> </div> </div></div><p>The Home Manager project is covered by the MIT license and we can only </div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-guidelines-licensing" class="title" >Mind the license </h3> </div> </div></div><p>The Home Manager project is covered by the MIT license and we can only
accept contributions that fall under this license, or are licensed in a accept contributions that fall under this license, or are licensed in a
compatible way. When you contribute self written code and documentation compatible way. When you contribute self written code and documentation
it is assumed that you are doing so under the MIT license.</p><p>A potential gotcha with respect to licensing are option descriptions. it is assumed that you are doing so under the MIT license.</p><p>A potential gotcha with respect to licensing are option descriptions.
@ -740,7 +740,7 @@ Often it is convenient to copy from the upstream software documentation.
When this is done it is important to verify that the license of the When this is done it is important to verify that the license of the
upstream documentation allows redistribution under the terms of the MIT upstream documentation allows redistribution under the terms of the MIT
license.</p> license.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h3 class="title" > <span id="sec-commit-style"></span>Commits </h3> </div> </div></div><p>The commits in your pull request should be reasonably self-contained, </div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-commit-style" class="title" >Commits </h3> </div> </div></div><p>The commits in your pull request should be reasonably self-contained,
that is, each commit should make sense in isolation. In particular, you that is, each commit should make sense in isolation. In particular, you
will be asked to amend any commit that introduces syntax errors or will be asked to amend any commit that introduces syntax errors or
similar problems even if they are fixed in a later commit.</p><p>The commit messages should follow the <a class="link" href="https://chris.beams.io/posts/git-commit/#seven-rules" target="_top">seven similar problems even if they are fixed in a later commit.</p><p>The commit messages should follow the <a class="link" href="https://chris.beams.io/posts/git-commit/#seven-rules" target="_top">seven
@ -757,7 +757,7 @@ exception, if there is no clear component, or your change affects many
components, then the <code class="literal">{component}</code> part is optional. See components, then the <code class="literal">{component}</code> part is optional. See
<a class="link" href="index.xhtml#ex-commit-message" title="Example commit" >example_title</a> for a commit message that fulfills <a class="link" href="index.xhtml#ex-commit-message" title="Example commit" >example_title</a> for a commit message that fulfills
these requirements.</p> these requirements.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h3 class="title" > <span id="ex-commit-message"></span>Example commit </h3> </div> </div></div><p>The commit </div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="ex-commit-message" class="title" >Example commit </h3> </div> </div></div><p>The commit
<a class="link" href="https://github.com/nix-community/home-manager/commit/69f8e47e9e74c8d3d060ca22e18246b7f7d988ef" target="_top">69f8e47e9e74c8d3d060ca22e18246b7f7d988ef</a> <a class="link" href="https://github.com/nix-community/home-manager/commit/69f8e47e9e74c8d3d060ca22e18246b7f7d988ef" target="_top">69f8e47e9e74c8d3d060ca22e18246b7f7d988ef</a>
contains the commit message</p><pre><code class="programlisting"> contains the commit message</p><pre><code class="programlisting">
starship: allow running in Emacs if vterm is used starship: allow running in Emacs if vterm is used
@ -767,7 +767,7 @@ contains the commit message</p><pre><code class="programlisting">
</code></pre><p>which ticks all the boxes necessary to be accepted in Home Manager.</p><p>Finally, when adding a new module, say <code class="literal">programs/foo.nix</code>, we use the </code></pre><p>which ticks all the boxes necessary to be accepted in Home Manager.</p><p>Finally, when adding a new module, say <code class="literal">programs/foo.nix</code>, we use the
fixed commit format <code class="literal">foo: add module</code>. You can, of course, still include fixed commit format <code class="literal">foo: add module</code>. You can, of course, still include
a long description if you wish.</p> a long description if you wish.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h3 class="title" > <span id="sec-code-style"></span>Code Style </h3> </div> </div></div><p>The code in Home Manager is formatted by the </div><div class="section"> <div class="titlepage"> <div> <div> <h3 id="sec-code-style" class="title" >Code Style </h3> </div> </div></div><p>The code in Home Manager is formatted by the
<a class="link" href="https://github.com/serokell/nixfmt/" target="_top">nixfmt</a> tool and the formatting is <a class="link" href="https://github.com/serokell/nixfmt/" target="_top">nixfmt</a> tool and the formatting is
checked in the pull request tests. Run the <code class="literal">format</code> tool inside the checked in the pull request tests. Run the <code class="literal">format</code> tool inside the
project repository before submitting your pull request.</p><p>Keep lines at a reasonable width, ideally 80 characters or less. This project repository before submitting your pull request.</p><p>Keep lines at a reasonable width, ideally 80 characters or less. This
@ -778,7 +778,7 @@ which use a hyphenated style. For example, the Home Manager option
in Nixpkgs.</p> in Nixpkgs.</p>
</div> </div>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-news"></span>News </h2> </div> </div></div><p>Home Manager includes a system for presenting news to the user. When </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-news" class="title" style="clear: both">News </h2> </div> </div></div><p>Home Manager includes a system for presenting news to the user. When
making a change you, therefore, have the option to also include an making a change you, therefore, have the option to also include an
associated news entry. In general, a news entry should only be added for associated news entry. In general, a news entry should only be added for
truly noteworthy news. For example, a bug fix or new option does truly noteworthy news. For example, a bug fix or new option does
@ -804,7 +804,7 @@ has a message along the lines of</p><pre><code class="programlisting">A new modu
systemd, then a condition like</p><pre><code class="programlisting nix">condition = hostPlatform.isLinux; systemd, then a condition like</p><pre><code class="programlisting nix">condition = hostPlatform.isLinux;
</code></pre><p>should be added. If you contribute a module then you don’t need to </code></pre><p>should be added. If you contribute a module then you don’t need to
add this entry, the merger will create an entry for you.</p></li></ul></div> add this entry, the merger will create an entry for you.</p></li></ul></div>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-tests"></span>Tests </h2> </div> </div></div><p>Home Manager includes a basic test suite and it is highly recommended to </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-tests" class="title" style="clear: both">Tests </h2> </div> </div></div><p>Home Manager includes a basic test suite and it is highly recommended to
include at least one test when adding a module. Tests are typically in include at least one test when adding a module. Tests are typically in
the form of &quot;golden tests&quot; where, for example, a generated the form of &quot;golden tests&quot; where, for example, a generated
configuration file is compared to a known correct file.</p><p>It is relatively easy to create tests by modeling the existing tests, configuration file is compared to a known correct file.</p><p>It is relatively easy to create tests by modeling the existing tests,
@ -819,16 +819,16 @@ and may cause failures. To run against the nixpkgs from the flake.lock,
use instead e.g.</p><pre><code class="programlisting shell">$ nix develop --ignore-environment .#all use instead e.g.</p><pre><code class="programlisting shell">$ nix develop --ignore-environment .#all
</code></pre> </code></pre>
</div> </div>
</div><div class="part"> <div class="titlepage"> <div> <div> <h1 class="title" > <span id="ch-3rd-party"></span>Third-Party Tools and Extensions </h1> </div> </div></div><div class="partintro"><p>Here is a collection of tools and extensions that relate to Home </div><div class="part"> <div class="titlepage"> <div> <div> <h1 id="ch-3rd-party" class="title" >Third-Party Tools and Extensions </h1> </div> </div></div><div class="partintro"><p>Here is a collection of tools and extensions that relate to Home
Manager. Note, these are maintained outside the regular Home Manager Manager. Note, these are maintained outside the regular Home Manager
flow so quality and support may vary wildly. If you encounter problems flow so quality and support may vary wildly. If you encounter problems
then please raise them in the corresponding project, not as issues in then please raise them in the corresponding project, not as issues in
the Home Manager tracker.</p><p>If you have made something interesting related to Home Manager then you the Home Manager tracker.</p><p>If you have made something interesting related to Home Manager then you
are encouraged to create a PR that expands this chapter.</p><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-3rd-party-module-collections">Module Collections</a> </span></dt> </dl></div></div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-3rd-party-module-collections"></span>Module Collections </h2> </div> </div></div><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p><a class="link" href="https://github.com/schuelermine/xhmm" target="_top">xhmm — extra Home Manager are encouraged to create a PR that expands this chapter.</p><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#sec-3rd-party-module-collections">Module Collections</a> </span></dt> </dl></div></div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-3rd-party-module-collections" class="title" style="clear: both">Module Collections </h2> </div> </div></div><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p><a class="link" href="https://github.com/schuelermine/xhmm" target="_top">xhmm — extra Home Manager
modules</a></p><p>A collection of modules maintained by Anselm Schüler.</p></li><li class="listitem"><p><a class="link" href="https://github.com/danth/stylix/" target="_top">Stylix — System-wide colorscheming and modules</a></p><p>A collection of modules maintained by Anselm Schüler.</p></li><li class="listitem"><p><a class="link" href="https://github.com/danth/stylix/" target="_top">Stylix — System-wide colorscheming and
typography</a></p><p>Configure your applications to get coherent color scheme and font.</p></li></ul></div> typography</a></p><p>Configure your applications to get coherent color scheme and font.</p></li></ul></div>
</div> </div>
</div><div class="part"> <div class="titlepage"> <div> <div> <h1 class="title" > <span id="ch-faq"></span>Frequently Asked Questions (FAQ) </h1> </div> </div></div><div class="partintro"><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#_why_is_there_a_collision_error_when_switching_generation">Why is there a collision error when switching generation?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_why_are_the_session_variables_not_set">Why are the session variables not set?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_how_to_set_up_a_configuration_for_multiple_users_machines">How to set up a configuration for multiple users/machines?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_why_do_i_get_an_error_message_about_literal_ca_desrt_dconf_literal_or_literal_dconf_service_literal">Why do I get an error message about <code class="literal">ca.desrt.dconf</code> or <code class="literal">dconf.service</code>?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_how_do_i_install_packages_from_nixpkgs_unstable">How do I install packages from Nixpkgs unstable?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_how_do_i_change_the_package_used_by_a_module">How do I change the package used by a module?</a> </span></dt> </dl></div></div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="_why_is_there_a_collision_error_when_switching_generation"></span>Why is there a collision error when switching generation? </h2> </div> </div></div><p>Home Manager currently installs packages into the user environment, </div><div class="part"> <div class="titlepage"> <div> <div> <h1 id="ch-faq" class="title" >Frequently Asked Questions (FAQ) </h1> </div> </div></div><div class="partintro"><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="index.xhtml#_why_is_there_a_collision_error_when_switching_generation">Why is there a collision error when switching generation?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_why_are_the_session_variables_not_set">Why are the session variables not set?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_how_to_set_up_a_configuration_for_multiple_users_machines">How to set up a configuration for multiple users/machines?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_why_do_i_get_an_error_message_about_literal_ca_desrt_dconf_literal_or_literal_dconf_service_literal">Why do I get an error message about <code class="literal">ca.desrt.dconf</code> or <code class="literal">dconf.service</code>?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_how_do_i_install_packages_from_nixpkgs_unstable">How do I install packages from Nixpkgs unstable?</a> </span></dt><dt> <span class="section"> <a href="index.xhtml#_how_do_i_change_the_package_used_by_a_module">How do I change the package used by a module?</a> </span></dt> </dl></div></div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="_why_is_there_a_collision_error_when_switching_generation" class="title" style="clear: both">Why is there a collision error when switching generation? </h2> </div> </div></div><p>Home Manager currently installs packages into the user environment,
precisely as if the packages were installed through <code class="literal">nix-env --install</code>. precisely as if the packages were installed through <code class="literal">nix-env --install</code>.
This means that you will get a collision error if your Home Manager This means that you will get a collision error if your Home Manager
configuration attempts to install a package that you already have configuration attempts to install a package that you already have
@ -854,7 +854,7 @@ error: build of ‘/nix/store/b37x3s7pzxbasfqhaca5dqbf3pjjw0ip-user-environment.
using <code class="literal">nix-env --uninstall</code> and reattempt the Home Manager generation using <code class="literal">nix-env --uninstall</code> and reattempt the Home Manager generation
switch.</p><p>You could also opt to unistall <span class="emphasis"><em>all</em></span> of the packages from your profile switch.</p><p>You could also opt to unistall <span class="emphasis"><em>all</em></span> of the packages from your profile
with <code class="literal">nix-env --uninstall &#x27;*&#x27;</code>.</p> with <code class="literal">nix-env --uninstall &#x27;*&#x27;</code>.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="_why_are_the_session_variables_not_set"></span>Why are the session variables not set? </h2> </div> </div></div><p>Home Manager is only able to set session variables automatically if it </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="_why_are_the_session_variables_not_set" class="title" style="clear: both">Why are the session variables not set? </h2> </div> </div></div><p>Home Manager is only able to set session variables automatically if it
manages your Bash, Z shell, or fish shell configuration. To enable such manages your Bash, Z shell, or fish shell configuration. To enable such
management you use <a class="link" href="options.xhtml#opt-programs.bash.enable" >programs.bash.enable</a>, management you use <a class="link" href="options.xhtml#opt-programs.bash.enable" >programs.bash.enable</a>,
<a class="link" href="options.xhtml#opt-programs.zsh.enable" >programs.zsh.enable</a>, or <a class="link" href="options.xhtml#opt-programs.fish.enable" >programs.fish.enable</a>.</p><p>If you don’t want to let Home Manager manage your shell then you will <a class="link" href="options.xhtml#opt-programs.zsh.enable" >programs.zsh.enable</a>, or <a class="link" href="options.xhtml#opt-programs.fish.enable" >programs.fish.enable</a>.</p><p>If you don’t want to let Home Manager manage your shell then you will
@ -866,7 +866,7 @@ way. In Bash and Z shell this can be done by adding</p><pre><code class="program
fish shell, it is possible to source it using <a class="link" href="https://github.com/oh-my-fish/plugin-foreign-env" target="_top">the foreign-env fish shell, it is possible to source it using <a class="link" href="https://github.com/oh-my-fish/plugin-foreign-env" target="_top">the foreign-env
plugin</a></p><pre><code class="programlisting bash">fenv source &quot;$HOME/.nix-profile/etc/profile.d/hm-session-vars.sh&quot; &gt; /dev/null plugin</a></p><pre><code class="programlisting bash">fenv source &quot;$HOME/.nix-profile/etc/profile.d/hm-session-vars.sh&quot; &gt; /dev/null
</code></pre> </code></pre>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="_how_to_set_up_a_configuration_for_multiple_users_machines"></span>How to set up a configuration for multiple users/machines? </h2> </div> </div></div><p>A typical way to prepare a repository of configurations for multiple </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="_how_to_set_up_a_configuration_for_multiple_users_machines" class="title" style="clear: both">How to set up a configuration for multiple users/machines? </h2> </div> </div></div><p>A typical way to prepare a repository of configurations for multiple
logins and machines is to prepare one &quot;top-level&quot; file for each unique logins and machines is to prepare one &quot;top-level&quot; file for each unique
combination.</p><p>For example, if you have two machines, called &quot;kronos&quot; and &quot;rhea&quot; on combination.</p><p>For example, if you have two machines, called &quot;kronos&quot; and &quot;rhea&quot; on
which you want to configure your user &quot;jane&quot; then you could create the which you want to configure your user &quot;jane&quot; then you could create the
@ -884,13 +884,13 @@ logins. Of course, instead of just a single <code class="literal">common.nix</co
have multiple ones, even one per program or service.</p><p>You can get some inspiration from the <a class="link" href="https://www.reddit.com/r/NixOS/comments/9bb9h9/post_your_homemanager_homenix_file/" target="_top">Post your home-manager home.nix have multiple ones, even one per program or service.</p><p>You can get some inspiration from the <a class="link" href="https://www.reddit.com/r/NixOS/comments/9bb9h9/post_your_homemanager_homenix_file/" target="_top">Post your home-manager home.nix
file!</a> file!</a>
Reddit thread.</p> Reddit thread.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="_why_do_i_get_an_error_message_about_literal_ca_desrt_dconf_literal_or_literal_dconf_service_literal"></span>Why do I get an error message about <code class="literal">ca.desrt.dconf</code> or <code class="literal">dconf.service</code>? </h2> </div> </div></div><p>You are most likely trying to configure something that uses dconf but </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="_why_do_i_get_an_error_message_about_literal_ca_desrt_dconf_literal_or_literal_dconf_service_literal" class="title" style="clear: both">Why do I get an error message about <code class="literal">ca.desrt.dconf</code> or <code class="literal">dconf.service</code>? </h2> </div> </div></div><p>You are most likely trying to configure something that uses dconf but
the DBus session is not aware of the dconf service. The full error you the DBus session is not aware of the dconf service. The full error you
might get is</p><pre><code class="programlisting">error: GDBus.Error:org.freedesktop.DBus.Error.ServiceUnknown: The name ca.desrt.dconf was not provided by any .service files might get is</p><pre><code class="programlisting">error: GDBus.Error:org.freedesktop.DBus.Error.ServiceUnknown: The name ca.desrt.dconf was not provided by any .service files
</code></pre><p>or</p><pre><code class="programlisting">error: GDBus.Error:org.freedesktop.systemd1.NoSuchUnit: Unit dconf.service not found. </code></pre><p>or</p><pre><code class="programlisting">error: GDBus.Error:org.freedesktop.systemd1.NoSuchUnit: Unit dconf.service not found.
</code></pre><p>The solution on NixOS is to add</p><pre><code class="programlisting nix">programs.dconf.enable = true; </code></pre><p>The solution on NixOS is to add</p><pre><code class="programlisting nix">programs.dconf.enable = true;
</code></pre><p>to your system configuration.</p> </code></pre><p>to your system configuration.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="_how_do_i_install_packages_from_nixpkgs_unstable"></span>How do I install packages from Nixpkgs unstable? </h2> </div> </div></div><p>If you are using a stable version of Nixpkgs but would like to install </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="_how_do_i_install_packages_from_nixpkgs_unstable" class="title" style="clear: both">How do I install packages from Nixpkgs unstable? </h2> </div> </div></div><p>If you are using a stable version of Nixpkgs but would like to install
some particular packages from Nixpkgs unstable – or some other channel some particular packages from Nixpkgs unstable – or some other channel
– then you can import the unstable Nixpkgs and refer to its packages – then you can import the unstable Nixpkgs and refer to its packages
within your configuration. Something like</p><pre><code class="programlisting nix">{ pkgs, config, ... }: within your configuration. Something like</p><pre><code class="programlisting nix">{ pkgs, config, ... }:
@ -912,7 +912,7 @@ in
$ nix-channel --update $ nix-channel --update
</code></pre><p>Note, the package will not be affected by any package overrides, </code></pre><p>Note, the package will not be affected by any package overrides,
overlays, etc.</p> overlays, etc.</p>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="_how_do_i_change_the_package_used_by_a_module"></span>How do I change the package used by a module? </h2> </div> </div></div><p>By default Home Manager will install the package provided by your chosen </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="_how_do_i_change_the_package_used_by_a_module" class="title" style="clear: both">How do I change the package used by a module? </h2> </div> </div></div><p>By default Home Manager will install the package provided by your chosen
<code class="literal">nixpkgs</code> channel but occasionally you might end up needing to change <code class="literal">nixpkgs</code> channel but occasionally you might end up needing to change
this package. This can typically be done in two ways.</p><div class="orderedlist"><ol class="orderedlist " type="1"><li class="listitem"><p>If the module provides a <code class="literal">package</code> option, such as this package. This can typically be done in two ways.</p><div class="orderedlist"><ol class="orderedlist " type="1"><li class="listitem"><p>If the module provides a <code class="literal">package</code> option, such as
<code class="literal">programs.beets.package</code>, then this is the recommended way to <code class="literal">programs.beets.package</code>, then this is the recommended way to

2
nix-darwin-options.xhtml
View file

@ -24,7 +24,7 @@
</tr> </tr>
</table> </table>
<hr /> <hr />
</div><div class="appendix"> <div class="titlepage"> <div> <div> <h1 class="title" > <span id="ch-nix-darwin-options"></span>Appendix C. nix-darwin Configuration Options </h1> </div> </div></div><div class="variablelist"> </div><div class="appendix"> <div class="titlepage"> <div> <div> <h1 id="ch-nix-darwin-options" class="title" >Appendix C. nix-darwin Configuration Options </h1> </div> </div></div><div class="variablelist">
<a id="nix-darwin-options"></a> <a id="nix-darwin-options"></a>
<dl class="variablelist"> <dl class="variablelist">
<dt> <dt>

2
nixos-options.xhtml
View file

@ -24,7 +24,7 @@
</tr> </tr>
</table> </table>
<hr /> <hr />
</div><div class="appendix"> <div class="titlepage"> <div> <div> <h1 class="title" > <span id="ch-nixos-options"></span>Appendix B. NixOS Configuration Options </h1> </div> </div></div><div class="variablelist"> </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> <a id="nixos-options"></a>
<dl class="variablelist"> <dl class="variablelist">
<dt> <dt>

5
options.xhtml
View file

@ -24,7 +24,7 @@
</tr> </tr>
</table> </table>
<hr /> <hr />
</div><div class="appendix"> <div class="titlepage"> <div> <div> <h1 class="title" > <span id="ch-options"></span>Appendix A. Home Manager Configuration Options </h1> </div> </div></div><div class="variablelist"> </div><div class="appendix"> <div class="titlepage"> <div> <div> <h1 id="ch-options" class="title" >Appendix A. Home Manager Configuration Options </h1> </div> </div></div><div class="variablelist">
<a id="home-manager-options"></a> <a id="home-manager-options"></a>
<dl class="variablelist"> <dl class="variablelist">
<dt> <dt>
@ -56095,6 +56095,9 @@ attribute set of (path or strings concatenated with “\n”)</p>
<p><span class="emphasis"><em>Type:</em></span> <p><span class="emphasis"><em>Type:</em></span>
YAML value</p> YAML value</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">{ }</code></p>
<p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">{ <p><span class="emphasis"><em>Example:</em></span></p><pre><code class="programlisting">{
lat = 52.3; lat = 52.3;
lng = 4.8; lng = 4.8;

52
release-notes.xhtml
View file

@ -24,9 +24,9 @@
</tr> </tr>
</table> </table>
<hr /> <hr />
</div><div class="appendix"> <div class="titlepage"> <div> <div> <h1 class="title" > <span id="ch-release-notes"></span>Appendix D. Release Notes </h1> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-24.05">Release 24.05</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-23.11">Release 23.11</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-23.05">Release 23.05</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-22.11">Release 22.11</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-22.05">Release 22.05</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-21.11">Release 21.11</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-21.05">Release 21.05</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-20.09">Release 20.09</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-20.03">Release 20.03</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-19.09">Release 19.09</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-19.03">Release 19.03</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-18.09">Release 18.09</a> </span></dt> </dl></div><p>This section lists the release notes for stable versions of Home Manager </div><div class="appendix"> <div class="titlepage"> <div> <div> <h1 id="ch-release-notes" class="title" >Appendix D. Release Notes </h1> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-24.05">Release 24.05</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-23.11">Release 23.11</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-23.05">Release 23.05</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-22.11">Release 22.11</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-22.05">Release 22.05</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-21.11">Release 21.11</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-21.05">Release 21.05</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-20.09">Release 20.09</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-20.03">Release 20.03</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-19.09">Release 19.09</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-19.03">Release 19.03</a> </span></dt><dt> <span class="chapter"> <a href="release-notes.xhtml#sec-release-18.09">Release 18.09</a> </span></dt> </dl></div><p>This section lists the release notes for stable versions of Home Manager
and the current unstable version.</p><div class="chapter"> <div class="titlepage"> <div> <div> <h2 class="title" > <span id="sec-release-24.05"></span>Release 24.05 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-24.05-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-24.05-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>This is the current unstable branch and the information in this section and the current unstable version.</p><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-24.05" class="title" >Release 24.05 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-24.05-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-24.05-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>This is the current unstable branch and the information in this section
is therefore not final.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-24.05-highlights"></span>Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <code class="literal">.release</code> file in the Home Manager project root has been is therefore not final.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-24.05-highlights" class="title" style="clear: both">Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <code class="literal">.release</code> file in the Home Manager project root has been
removed. Please use the <code class="literal">release.json</code> file instead.</p></li><li class="listitem"><p>The <span class="command"><strong>home-manager uninstall</strong></span> command has been reworked to, removed. Please use the <code class="literal">release.json</code> file instead.</p></li><li class="listitem"><p>The <span class="command"><strong>home-manager uninstall</strong></span> command has been reworked to,
hopefully, be more robust. The new implementation makes use of a new hopefully, be more robust. The new implementation makes use of a new
Boolean configuration option <a class="link" href="options.xhtml#opt-uninstall" >uninstall</a> that can Boolean configuration option <a class="link" href="options.xhtml#opt-uninstall" >uninstall</a> that can
@ -66,12 +66,12 @@ deprecated. Instead use the new shell function
more. The deprecated variable will continue to work for now but its more. The deprecated variable will continue to work for now but its
use may in the future trigger a warning message and eventually it use may in the future trigger a warning message and eventually it
may be removed entirely.</p></li></ul></div> may be removed entirely.</p></li></ul></div>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-24.05-state-version-changes"></span>State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-24.05-state-version-changes" class="title" style="clear: both">State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These
changes are only active if the <code class="literal">home.stateVersion</code> option is set to changes are only active if the <code class="literal">home.stateVersion</code> option is set to
&quot;24.05&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Nothing, yet.</p></li></ul></div> &quot;24.05&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Nothing, yet.</p></li></ul></div>
</div> </div>
</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 class="title" > <span id="sec-release-23.11"></span>Release 23.11 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-23.11-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-23.11-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 23.11 release branch became stable in November, 2023.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-23.11-highlights"></span>Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>When using <a class="link" href="options.xhtml#opt-programs.fish.enable" >programs.fish.enable</a>, the setup code for </div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-23.11" class="title" >Release 23.11 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-23.11-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-23.11-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 23.11 release branch became stable in November, 2023.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-23.11-highlights" class="title" style="clear: both">Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>When using <a class="link" href="options.xhtml#opt-programs.fish.enable" >programs.fish.enable</a>, the setup code for
<a class="link" href="options.xhtml#opt-home.sessionVariables" >home.sessionVariables</a> is now translated with <a class="link" href="options.xhtml#opt-home.sessionVariables" >home.sessionVariables</a> is now translated with
<a class="link" href="https://github.com/bouk/babelfish" target="_top">babelfish</a>. This should result <a class="link" href="https://github.com/bouk/babelfish" target="_top">babelfish</a>. This should result
in significantly faster shell startup times but could theoretically in significantly faster shell startup times but could theoretically
@ -86,12 +86,12 @@ have any external Home Manager modules, their option descriptions
and literal examples should be translated to <a class="link" href="https://nixos.org/manual/nixpkgs/unstable/#sec-contributing-markup" target="_top">Nixpkgs-flavoured and literal examples should be translated to <a class="link" href="https://nixos.org/manual/nixpkgs/unstable/#sec-contributing-markup" target="_top">Nixpkgs-flavoured
Markdown</a>.</p></li><li class="listitem"><p>The <code class="literal">services.password-store-sync</code> module has been removed. Use Markdown</a>.</p></li><li class="listitem"><p>The <code class="literal">services.password-store-sync</code> module has been removed. Use
<code class="literal">services.git-sync</code> instead.</p></li></ul></div> <code class="literal">services.git-sync</code> instead.</p></li></ul></div>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-23.11-state-version-changes"></span>State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-23.11-state-version-changes" class="title" style="clear: both">State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These
changes are only active if the <code class="literal">home.stateVersion</code> option is set to changes are only active if the <code class="literal">home.stateVersion</code> option is set to
&quot;23.11&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Nothing, yet.</p></li></ul></div> &quot;23.11&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Nothing, yet.</p></li></ul></div>
</div> </div>
</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 class="title" > <span id="sec-release-23.05"></span>Release 23.05 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-23.05-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-23.05-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 23.05 release branch became the stable branch in May, 2023.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-23.05-highlights"></span>Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Firefox add-ons are now managed per-profile. That is, if you are </div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-23.05" class="title" >Release 23.05 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-23.05-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-23.05-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 23.05 release branch became the stable branch in May, 2023.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-23.05-highlights" class="title" style="clear: both">Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Firefox add-ons are now managed per-profile. That is, if you are
currently having</p><pre><code class="programlisting nix">programs.firefox.extensions = [ foo bar ]; currently having</p><pre><code class="programlisting nix">programs.firefox.extensions = [ foo bar ];
</code></pre><p>in your configuration then you must change it to</p><pre><code class="programlisting nix">programs.firefox.profiles.myprofile.extensions = [ foo bar ]; </code></pre><p>in your configuration then you must change it to</p><pre><code class="programlisting nix">programs.firefox.profiles.myprofile.extensions = [ foo bar ];
</code></pre></li><li class="listitem"><p>The default configuration location has been changed from </code></pre></li><li class="listitem"><p>The default configuration location has been changed from
@ -107,13 +107,13 @@ a standalone Home Manager setup with Nix flakes uses this new
command. The standard installation method remains the same but uses command. The standard installation method remains the same but uses
the new command internally. See <a class="link" href="index.xhtml#sec-flakes-standalone" title="Standalone setup" >sec-flakes-standalone</a> for the new command internally. See <a class="link" href="index.xhtml#sec-flakes-standalone" title="Standalone setup" >sec-flakes-standalone</a> for
more.</p></li></ul></div> more.</p></li></ul></div>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-23.05-state-version-changes"></span>State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-23.05-state-version-changes" class="title" style="clear: both">State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These
changes are only active if the <code class="literal">home.stateVersion</code> option is set to changes are only active if the <code class="literal">home.stateVersion</code> option is set to
&quot;23.05&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The options</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: circle;"><li class="listitem"><p><a class="link" href="options.xhtml#opt-xsession.windowManager.i3.config.window.titlebar" >xsession.windowManager.i3.config.window.titlebar</a></p></li><li class="listitem"><p><a class="link" href="options.xhtml#opt-xsession.windowManager.i3.config.floating.titlebar" >xsession.windowManager.i3.config.floating.titlebar</a></p></li><li class="listitem"><p><a class="link" href="options.xhtml#opt-wayland.windowManager.sway.config.window.titlebar" >wayland.windowManager.sway.config.window.titlebar</a></p></li><li class="listitem"><p><a class="link" href="options.xhtml#opt-wayland.windowManager.sway.config.floating.titlebar" >wayland.windowManager.sway.config.floating.titlebar</a></p></li></ul></div><p>now default to <code class="literal">true</code> which is consistent with the default values &quot;23.05&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The options</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: circle;"><li class="listitem"><p><a class="link" href="options.xhtml#opt-xsession.windowManager.i3.config.window.titlebar" >xsession.windowManager.i3.config.window.titlebar</a></p></li><li class="listitem"><p><a class="link" href="options.xhtml#opt-xsession.windowManager.i3.config.floating.titlebar" >xsession.windowManager.i3.config.floating.titlebar</a></p></li><li class="listitem"><p><a class="link" href="options.xhtml#opt-wayland.windowManager.sway.config.window.titlebar" >wayland.windowManager.sway.config.window.titlebar</a></p></li><li class="listitem"><p><a class="link" href="options.xhtml#opt-wayland.windowManager.sway.config.floating.titlebar" >wayland.windowManager.sway.config.floating.titlebar</a></p></li></ul></div><p>now default to <code class="literal">true</code> which is consistent with the default values
for those options used by <code class="literal">i3</code> and <code class="literal">sway</code>.</p></li></ul></div> for those options used by <code class="literal">i3</code> and <code class="literal">sway</code>.</p></li></ul></div>
</div> </div>
</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 class="title" > <span id="sec-release-22.11"></span>Release 22.11 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-22.11-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-22.11-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 22.11 release branch became the stable branch in November, 2022.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-22.11-highlights"></span>Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <a class="link" href="options.xhtml#opt-home.stateVersion" >home.stateVersion</a> option no longer has a default </div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-22.11" class="title" >Release 22.11 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-22.11-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-22.11-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 22.11 release branch became the stable branch in November, 2022.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-22.11-highlights" class="title" style="clear: both">Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <a class="link" href="options.xhtml#opt-home.stateVersion" >home.stateVersion</a> option no longer has a default
value. It used to default to “18.09”, which was the Home Manager value. It used to default to “18.09”, which was the Home Manager
version that introduced the option. If your configuration does not version that introduced the option. If your configuration does not
explicitly set this option then you need to add</p><pre><code class="programlisting nix">home.stateVersion = &quot;18.09&quot;; explicitly set this option then you need to add</p><pre><code class="programlisting nix">home.stateVersion = &quot;18.09&quot;;
@ -152,7 +152,7 @@ were removed since upstream changed the blur settings to be more
flexible. You can migrate the blur settings to use flexible. You can migrate the blur settings to use
<a class="link" href="options.xhtml#opt-services.picom.settings" >services.picom.settings</a> instead.</p></li><li class="listitem"><p>The <code class="literal">services.compton</code> module has been removed. It was deprecated in <a class="link" href="options.xhtml#opt-services.picom.settings" >services.picom.settings</a> instead.</p></li><li class="listitem"><p>The <code class="literal">services.compton</code> module has been removed. It was deprecated in
release 20.03. Use <code class="literal">services.picom</code> instead.</p></li></ul></div> release 20.03. Use <code class="literal">services.picom</code> instead.</p></li></ul></div>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-22.11-state-version-changes"></span>State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-22.11-state-version-changes" class="title" style="clear: both">State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These
changes are only active if the <code class="literal">home.stateVersion</code> option is set to changes are only active if the <code class="literal">home.stateVersion</code> option is set to
&quot;22.11&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <a class="link" href="options.xhtml#opt-services.mpd.musicDirectory" >services.mpd.musicDirectory</a> option now defaults to &quot;22.11&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <a class="link" href="options.xhtml#opt-services.mpd.musicDirectory" >services.mpd.musicDirectory</a> option now defaults to
the value of <a class="link" href="options.xhtml#opt-xdg.userDirs.music" >xdg.userDirs.music</a> if the value of <a class="link" href="options.xhtml#opt-xdg.userDirs.music" >xdg.userDirs.music</a> if
@ -168,7 +168,7 @@ refer to the command by its absolute command path, such as
<code class="literal">${pkgs.hello}/bin/hello</code>.</p></li></ul></div> <code class="literal">${pkgs.hello}/bin/hello</code>.</p></li></ul></div>
</div> </div>
</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 class="title" > <span id="sec-release-22.05"></span>Release 22.05 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-22.05-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-22.05-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 22.05 release branch became the stable branch in May, 2022.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-22.05-highlights"></span>Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <code class="literal">programs.waybar.settings.modules</code> option was removed. Waybar </div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-22.05" class="title" >Release 22.05 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-22.05-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-22.05-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 22.05 release branch became the stable branch in May, 2022.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-22.05-highlights" class="title" style="clear: both">Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <code class="literal">programs.waybar.settings.modules</code> option was removed. Waybar
modules should now be declared directly under modules should now be declared directly under
<code class="literal">programs.waybar.settings</code>.</p></li><li class="listitem"><p>Home Manager now partially support translation of texts into <code class="literal">programs.waybar.settings</code>.</p></li><li class="listitem"><p>Home Manager now partially support translation of texts into
different languages. Note, the support is quite limited at the different languages. Note, the support is quite limited at the
@ -178,7 +178,7 @@ and the activation script.</p><p>If you would like to contribute to the translat
can do so through the <a class="link" href="https://hosted.weblate.org/projects/home-manager/" target="_top">Home Manager Weblate can do so through the <a class="link" href="https://hosted.weblate.org/projects/home-manager/" target="_top">Home Manager Weblate
project</a>.</p></li><li class="listitem"><p>A new module, <code class="literal">launchd.agents</code> was added. Use this to enable project</a>.</p></li><li class="listitem"><p>A new module, <code class="literal">launchd.agents</code> was added. Use this to enable
services based on macOS LaunchAgents.</p></li></ul></div> services based on macOS LaunchAgents.</p></li></ul></div>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-22.05-state-version-changes"></span>State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-22.05-state-version-changes" class="title" style="clear: both">State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These
changes are only active if the <code class="literal">home.stateVersion</code> option is set to changes are only active if the <code class="literal">home.stateVersion</code> option is set to
&quot;22.05&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <a class="link" href="options.xhtml#opt-programs.waybar.settings" >programs.waybar.settings</a> option now allows defining &quot;22.05&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <a class="link" href="options.xhtml#opt-programs.waybar.settings" >programs.waybar.settings</a> option now allows defining
modules directly under <a class="link" href="options.xhtml#opt-programs.waybar.settings" >programs.waybar.settings</a>. modules directly under <a class="link" href="options.xhtml#opt-programs.waybar.settings" >programs.waybar.settings</a>.
@ -188,7 +188,7 @@ be an error. For example,</p><pre><code class="programlisting nix">programs.way
</code></pre></li></ul></div> </code></pre></li></ul></div>
</div> </div>
</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 class="title" > <span id="sec-release-21.11"></span>Release 21.11 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-21.11-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-21.11-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 21.11 release branch became the stable branch in November, 2021.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-21.11-highlights"></span>Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>All Home Manager modules are now loaded on all platforms. With this </div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-21.11" class="title" >Release 21.11 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-21.11-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-21.11-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 21.11 release branch became the stable branch in November, 2021.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-21.11-highlights" class="title" style="clear: both">Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>All Home Manager modules are now loaded on all platforms. With this
change you will get a more descriptive error message if you attempt change you will get a more descriptive error message if you attempt
to enable a module that is incompatible with the host platform.</p><p>Previously, modules that were platform specific would only be loaded to enable a module that is incompatible with the host platform.</p><p>Previously, modules that were platform specific would only be loaded
on that particular platform. For example, a module defining a on that particular platform. For example, a module defining a
@ -212,7 +212,7 @@ different so you may need to do some changes.</p></li><li class="listitem"><p>Ta
file now. Option <a class="link" href="options.xhtml#opt-programs.taskwarrior.config" >programs.taskwarrior.config</a> and friends file now. Option <a class="link" href="options.xhtml#opt-programs.taskwarrior.config" >programs.taskwarrior.config</a> and friends
now generate the config file at <code class="literal">$XDG_CONFIG_HOME/task/taskrc</code> now generate the config file at <code class="literal">$XDG_CONFIG_HOME/task/taskrc</code>
instead of <code class="literal">~/.taskrc</code>.</p></li></ul></div> instead of <code class="literal">~/.taskrc</code>.</p></li></ul></div>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-21.11-state-version-changes"></span>State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-21.11-state-version-changes" class="title" style="clear: both">State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These
changes are only active if the <code class="literal">home.stateVersion</code> option is set to changes are only active if the <code class="literal">home.stateVersion</code> option is set to
&quot;21.11&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <a class="link" href="options.xhtml#opt-home.keyboard" >home.keyboard</a> option now defaults to <code class="literal">null</code>, meaning &quot;21.11&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <a class="link" href="options.xhtml#opt-home.keyboard" >home.keyboard</a> option now defaults to <code class="literal">null</code>, meaning
that Home Manager won’t do any keyboard layout management. For that Home Manager won’t do any keyboard layout management. For
@ -226,7 +226,7 @@ example,</p><pre><code class="programlisting nix">programs.waybar.settings.modu
</code></pre></li></ul></div> </code></pre></li></ul></div>
</div> </div>
</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 class="title" > <span id="sec-release-21.05"></span>Release 21.05 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-21.05-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-21.05-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 21.05 release branch became the stable branch in May, 2021.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-21.05-highlights"></span>Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The ‘opt-programs.broot.verbs` option is now a list rather than an </div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-21.05" class="title" >Release 21.05 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-21.05-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-21.05-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 21.05 release branch became the stable branch in May, 2021.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-21.05-highlights" class="title" style="clear: both">Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The ‘opt-programs.broot.verbs` option is now a list rather than an
attribute set. To migrate, move the keys of the attrset into the attribute set. To migrate, move the keys of the attrset into the
list items’ <code class="literal">invocation</code> keys. For example,</p><pre><code class="programlisting nix">programs.broot.verbs = { list items’ <code class="literal">invocation</code> keys. For example,</p><pre><code class="programlisting nix">programs.broot.verbs = {
&quot;p&quot; = { execution = &quot;:parent&quot;; }; &quot;p&quot; = { execution = &quot;:parent&quot;; };
@ -342,15 +342,15 @@ example:</p><pre><code class="programlisting nix">programs.htop = {
}; };
}; };
</code></pre></li></ul></div> </code></pre></li></ul></div>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-21.05-state-version-changes"></span>State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-21.05-state-version-changes" class="title" style="clear: both">State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These
changes are only active if the <code class="literal">home.stateVersion</code> option is set to changes are only active if the <code class="literal">home.stateVersion</code> option is set to
&quot;21.05&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>The <code class="literal">newsboat</code> module now stores generated configuration in &quot;21.05&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>The <code class="literal">newsboat</code> module now stores generated configuration in
<code class="literal">$XDG_CONFIG_HOME/newsboat</code>.</p></li></ul></div> <code class="literal">$XDG_CONFIG_HOME/newsboat</code>.</p></li></ul></div>
</div> </div>
</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 class="title" > <span id="sec-release-20.09"></span>Release 20.09 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-20.09-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-20.09-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 20.09 release branch became the stable branch in late September, </div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-20.09" class="title" >Release 20.09 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-20.09-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-20.09-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 20.09 release branch became the stable branch in late September,
2020.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-20.09-highlights"></span>Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Nothing has happened.</p></li></ul></div> 2020.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-20.09-highlights" class="title" style="clear: both">Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>Nothing has happened.</p></li></ul></div>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-20.09-state-version-changes"></span>State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-20.09-state-version-changes" class="title" style="clear: both">State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These
changes are only active if the <code class="literal">home.stateVersion</code> option is set to changes are only active if the <code class="literal">home.stateVersion</code> option is set to
&quot;20.09&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The options <a class="link" href="options.xhtml#opt-home.homeDirectory" >home.homeDirectory</a> and &quot;20.09&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The options <a class="link" href="options.xhtml#opt-home.homeDirectory" >home.homeDirectory</a> and
<a class="link" href="options.xhtml#opt-home.username" >home.username</a> no longer have default values and must <a class="link" href="options.xhtml#opt-home.username" >home.username</a> no longer have default values and must
@ -412,7 +412,7 @@ the other hand, something like:</p><pre><code class="programlisting nix">bars =
</code></pre></li></ul></div> </code></pre></li></ul></div>
</div> </div>
</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 class="title" > <span id="sec-release-20.03"></span>Release 20.03 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-20.03-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-20.03-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 20.03 release branch became the stable branch in April, 2020.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-20.03-highlights"></span>Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Assigning a list to the <a class="link" href="options.xhtml#opt-home.file" >home.file</a>, </div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-20.03" class="title" >Release 20.03 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-20.03-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-20.03-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 20.03 release branch became the stable branch in April, 2020.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-20.03-highlights" class="title" style="clear: both">Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>Assigning a list to the <a class="link" href="options.xhtml#opt-home.file" >home.file</a>,
<a class="link" href="options.xhtml#opt-xdg.dataFile" >xdg.dataFile</a> options is <a class="link" href="options.xhtml#opt-xdg.dataFile" >xdg.dataFile</a> options is
now deprecated and will produce a warning message if used. now deprecated and will produce a warning message if used.
Specifically, if your configuration currently contains something Specifically, if your configuration currently contains something
@ -464,7 +464,7 @@ example, a configuration</p><pre><code class="programlisting nix">programs.ssh.
}; };
</code></pre><p>Support for the list form will be removed in Home Manager version </code></pre><p>Support for the list form will be removed in Home Manager version
20.09.</p></li></ul></div> 20.09.</p></li></ul></div>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-20.03-state-version-changes"></span>State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-20.03-state-version-changes" class="title" style="clear: both">State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These
changes are only active if the <code class="literal">home.stateVersion</code> option is set to changes are only active if the <code class="literal">home.stateVersion</code> option is set to
&quot;20.03&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <a class="link" href="options.xhtml#opt-programs.zsh.history.path" >programs.zsh.history.path</a> option is no longer &quot;20.03&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <a class="link" href="options.xhtml#opt-programs.zsh.history.path" >programs.zsh.history.path</a> option is no longer
prepended by <code class="literal">$HOME</code>, which allows specifying absolute paths, for prepended by <code class="literal">$HOME</code>, which allows specifying absolute paths, for
@ -475,12 +475,12 @@ anymore.</p></li><li class="listitem"><p>The newsboat module will now default in
a lot of URLs and few queries.</p></li></ul></div> a lot of URLs and few queries.</p></li></ul></div>
</div> </div>
</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 class="title" > <span id="sec-release-19.09"></span>Release 19.09 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-19.09-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-19.09-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 19.09 release branch became the stable branch in October, 2019.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-19.09-highlights"></span>Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <code class="literal">programs.firefox.enableGoogleTalk</code> and </div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-19.09" class="title" >Release 19.09 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-19.09-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-19.09-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 19.09 release branch became the stable branch in October, 2019.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-19.09-highlights" class="title" style="clear: both">Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <code class="literal">programs.firefox.enableGoogleTalk</code> and
<code class="literal">programs.firefox.enableIcedTea</code> options are now deprecated and will <code class="literal">programs.firefox.enableIcedTea</code> options are now deprecated and will
only work if Firefox ESR 52.x is used.</p></li><li class="listitem"><p>The <code class="literal">home-manager</code> tool now provides an <code class="literal">uninstall</code> sub-command that only work if Firefox ESR 52.x is used.</p></li><li class="listitem"><p>The <code class="literal">home-manager</code> tool now provides an <code class="literal">uninstall</code> sub-command that
can be used to uninstall Home Manager, if used in the standalone can be used to uninstall Home Manager, if used in the standalone
mode. That is, not as a NixOS module.</p></li></ul></div> mode. That is, not as a NixOS module.</p></li></ul></div>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-19.09-state-version-changes"></span>State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-19.09-state-version-changes" class="title" style="clear: both">State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These
changes are only active if the <code class="literal">home.stateVersion</code> option is set to changes are only active if the <code class="literal">home.stateVersion</code> option is set to
&quot;19.09&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <a class="link" href="options.xhtml#opt-programs.firefox.package" >programs.firefox.package</a> option now expects a &quot;19.09&quot; or later.</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <a class="link" href="options.xhtml#opt-programs.firefox.package" >programs.firefox.package</a> option now expects a
wrapped Firefox package and defaults to <code class="literal">pkgs.firefox</code>.</p></li><li class="listitem"><p>The options <a class="link" href="options.xhtml#opt-home.keyboard.layout" >home.keyboard.layout</a> and wrapped Firefox package and defaults to <code class="literal">pkgs.firefox</code>.</p></li><li class="listitem"><p>The options <a class="link" href="options.xhtml#opt-home.keyboard.layout" >home.keyboard.layout</a> and
@ -488,7 +488,7 @@ wrapped Firefox package and defaults to <code class="literal">pkgs.firefox</code
indicates that the system value should be used.</p></li></ul></div> indicates that the system value should be used.</p></li></ul></div>
</div> </div>
</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 class="title" > <span id="sec-release-19.03"></span>Release 19.03 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-19.03-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-19.03-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 19.03 release branch became the stable branch in April, 2019.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-19.03-highlights"></span>Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <a class="link" href="options.xhtml#opt-home.file._name_.source" >home.file.<span class="emphasis"><em>name</em></span>.source</a> option now allows source </div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-19.03" class="title" >Release 19.03 </h2> </div> </div></div><div class="toc"> <p><strong>Table of Contents</strong></p> <dl class="toc"> <dt> <span class="section"> <a href="release-notes.xhtml#sec-release-19.03-highlights">Highlights</a> </span></dt><dt> <span class="section"> <a href="release-notes.xhtml#sec-release-19.03-state-version-changes">State Version Changes</a> </span></dt> </dl></div><p>The 19.03 release branch became the stable branch in April, 2019.</p><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-19.03-highlights" class="title" style="clear: both">Highlights </h2> </div> </div></div><p>This release has the following notable changes:</p><div class="itemizedlist"><ul class="itemizedlist " style="list-style-type: disc;"><li class="listitem"><p>The <a class="link" href="options.xhtml#opt-home.file._name_.source" >home.file.<span class="emphasis"><em>name</em></span>.source</a> option now allows source
files to be hidden, that is, having a name starting with the <code class="literal">.</code> files to be hidden, that is, having a name starting with the <code class="literal">.</code>
character. It also allows the source file name to contain characters character. It also allows the source file name to contain characters
not typically allowed for Nix store paths. For example, your not typically allowed for Nix store paths. For example, your
@ -505,14 +505,14 @@ function. For example,</p><pre><code class="programlisting nix">systemd.user.se
</code></pre><p>becomes</p><pre><code class="programlisting nix">systemd.user.services.foo.Service.ExecStart = lib.mkForce &quot;/foo/bar&quot;; </code></pre><p>becomes</p><pre><code class="programlisting nix">systemd.user.services.foo.Service.ExecStart = lib.mkForce &quot;/foo/bar&quot;;
</code></pre><p>We had to make this change because the old merging was causing too </code></pre><p>We had to make this change because the old merging was causing too
many confusing situations for people.</p></li></ul></div> many confusing situations for people.</p></li></ul></div>
</div><div class="section"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"> <span id="sec-release-19.03-state-version-changes"></span>State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These </div><div class="section"> <div class="titlepage"> <div> <div> <h2 id="sec-release-19.03-state-version-changes" class="title" style="clear: both">State Version Changes </h2> </div> </div></div><p>The state version in this release includes the changes below. These
changes are only active if the <a class="link" href="options.xhtml#opt-home.stateVersion" >home.stateVersion</a> option is changes are only active if the <a class="link" href="options.xhtml#opt-home.stateVersion" >home.stateVersion</a> option is
set to “19.03” or later.</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>There is now an option <a class="link" href="options.xhtml#opt-programs.beets.enable" >programs.beets.enable</a> that set to “19.03” or later.</p><div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc;"><li class="listitem"><p>There is now an option <a class="link" href="options.xhtml#opt-programs.beets.enable" >programs.beets.enable</a> that
defaults to <code class="literal">false</code>. Before the module would be active if the defaults to <code class="literal">false</code>. Before the module would be active if the
<a class="link" href="options.xhtml#opt-programs.beets.settings" >programs.beets.settings</a> option was non-empty.</p></li></ul></div> <a class="link" href="options.xhtml#opt-programs.beets.settings" >programs.beets.settings</a> option was non-empty.</p></li></ul></div>
</div> </div>
</div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 class="title" > <span id="sec-release-18.09"></span>Release 18.09 </h2> </div> </div></div><p>The 18.09 release branch became the stable branch in September, 2018.</p> </div><div class="chapter"> <div class="titlepage"> <div> <div> <h2 id="sec-release-18.09" class="title" >Release 18.09 </h2> </div> </div></div><p>The 18.09 release branch became the stable branch in September, 2018.</p>
</div> </div>
</div> <div class="navfooter"> </div> <div class="navfooter">
<hr /> <hr />