home-manager/release-notes.html

440 lines
48 KiB
HTML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix E. Release Notes</title><link rel="stylesheet" type="text/css" href="style.css" /><script src="highlight.min.js" type="text/javascript"></script><script src="highlight.load.js" type="text/javascript"></script><meta name="generator" content="DocBook XSL Stylesheets V1.79.2" /><link rel="home" href="index.html" title="Home Manager Manual" /><link rel="up" href="index.html" title="Home Manager Manual" /><link rel="prev" href="tools.html" title="Appendix D. Tools" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix E. Release Notes</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="tools.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> </td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="ch-release-notes"></a>Appendix E. Release Notes</h1></div></div></div><div class="toc"><dl class="toc"><dt><span class="section"><a href="release-notes.html#sec-release-23.11">E.1. Release 23.11</a></span></dt><dd><dl><dt><span class="section"><a href="release-notes.html#sec-release-23.11-highlights">E.1.1. Highlights</a></span></dt><dt><span class="section"><a href="release-notes.html#sec-release-23.11-state-version-changes">E.1.2. State Version Changes</a></span></dt></dl></dd><dt><span class="section"><a href="release-notes.html#sec-release-23.05">E.2. Release 23.05</a></span></dt><dd><dl><dt><span class="section"><a href="release-notes.html#sec-release-23.05-highlights">E.2.1. Highlights</a></span></dt><dt><span class="section"><a href="release-notes.html#sec-release-23.05-state-version-changes">E.2.2. State Version Changes</a></span></dt></dl></dd><dt><span class="section"><a href="release-notes.html#sec-release-22.11">E.3. Release 22.11</a></span></dt><dd><dl><dt><span class="section"><a href="release-notes.html#sec-release-22.11-highlights">E.3.1. Highlights</a></span></dt><dt><span class="section"><a href="release-notes.html#sec-release-22.11-state-version-changes">E.3.2. State Version Changes</a></span></dt></dl></dd><dt><span class="section"><a href="release-notes.html#sec-release-22.05">E.4. Release 22.05</a></span></dt><dd><dl><dt><span class="section"><a href="release-notes.html#sec-release-22.05-highlights">E.4.1. Highlights</a></span></dt><dt><span class="section"><a href="release-notes.html#sec-release-22.05-state-version-changes">E.4.2. State Version Changes</a></span></dt></dl></dd><dt><span class="section"><a href="release-notes.html#sec-release-21.11">E.5. Release 21.11</a></span></dt><dd><dl><dt><span class="section"><a href="release-notes.html#sec-release-21.11-highlights">E.5.1. Highlights</a></span></dt><dt><span class="section"><a href="release-notes.html#sec-release-21.11-state-version-changes">E.5.2. State Version Changes</a></span></dt></dl></dd><dt><span class="section"><a href="release-notes.html#sec-release-21.05">E.6. Release 21.05</a></span></dt><dd><dl><dt><span class="section"><a href="release-notes.html#sec-release-21.05-highlights">E.6.1. Highlights</a></span></dt><dt><span class="section"><a href="release-notes.html#sec-release-21.05-state-version-changes">E.6.2. State Version Changes</a></span></dt></dl></dd><dt><span class="section"><a href="release-notes.html#sec-release-20.09">E.7. Release 20.09</a></span></dt><dd><dl><dt><span class="section"><a href="release-notes.html#sec-release-20.09-highlights">E.7.1. Highlights</a></span></dt><dt><span class="section"><a href="release-notes.html#sec-release-20.09-state-version-changes">E.7.2. State Version Changes</a></span></dt></dl></dd><dt><span class="section"><a href="release-notes.html#sec-release-20.03">E.8. Release 20.03</a></span></dt><
Nothing, yet.
</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-23.11-state-version-changes"></a>E.1.2. State Version Changes</h3></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 "23.11" or later.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
Nothing, yet.
</li></ul></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="sec-release-23.05"></a>E.2. Release 23.05</h2></div></div></div><p>The 23.05 release branch became the stable branch in May, 2023.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-23.05-highlights"></a>E.2.1. Highlights</h3></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 class="simpara">
Firefox add-ons are now managed per-profile.
That is, if you are currently having
</p><pre class="programlisting nix">programs.firefox.extensions = [ foo bar ];</pre><p class="simpara">in your configuration then you must change it to</p><pre class="programlisting nix">programs.firefox.profiles.myprofile.extensions = [ foo bar ];</pre></li><li class="listitem"><p class="simpara">
The default configuration location has been changed from
<code class="literal">~/.config/nixpkgs/home.nix</code> to <code class="literal">~/.config/home-manager/home.nix</code>.
</p><p class="simpara">Similarly, if you are using a Nix flake based setup
then the default flake file location has changed from
<code class="literal">~/.config/nixpkgs/flake.nix</code> to <code class="literal">~/.config/home-manager/flake.nix</code>.</p><p class="simpara">The old location will continue to work but using it will trigger a warning message.
We changed the default configuration location to avoid confusion about
which files belong to Home Manager and which belong to Nixpkgs.</p></li><li class="listitem">
The <code class="literal">home-manager</code> tool now offers an <code class="literal">init</code> command.
This command can be used to generate an initial Home Manager configuration,
and optionally also activate it.
The recommended installation method for a standalone Home Manager setup
with Nix flakes uses this new command.
The standard installation method remains the same but uses the new command internally.
See <a class="xref" href="index.html#sec-flakes-standalone" title="3.2. Standalone setup">Section 3.2, “Standalone setup”</a> for more.
</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-23.05-state-version-changes"></a>E.2.2. State Version Changes</h3></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 "23.05" or later.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p class="simpara">
The options
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem">
<a class="xref" href="options.html#opt-xsession.windowManager.i3.config.window.titlebar"><code class="option">xsession.windowManager.i3.config.window.titlebar</code></a>
</li><li class="listitem">
<a class="xref" href="options.html#opt-xsession.windowManager.i3.config.floating.titlebar"><code class="option">xsession.windowManager.i3.config.floating.titlebar</code></a>
</li><li class="listitem">
<a class="xref" href="options.html#opt-wayland.windowManager.sway.config.window.titlebar"><code class="option">wayland.windowManager.sway.config.window.titlebar</code></a>
</li><li class="listitem">
<a class="xref" href="options.html#opt-wayland.windowManager.sway.config.floating.titlebar"><code class="option">wayland.windowManager.sway.config.floating.titlebar</code></a>
</li></ul></div><p class="simpara">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></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="sec-release-22.11"></a>E.3. Release 22.11</h2></div></div></div><p>The 22.11 release branch became the stable branch in November, 2022.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-22.11-highlights"></a>E.3.1. Highlights</h3></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 class="simpara">
The <a class="xref" href="options.html#opt-home.stateVersion"><code class="option">home.stateVersion</code></a> option no longer has a default value.
It used to default to “18.09”, which was the Home Manager version
that introduced the option. If your configuration does not explicitly
set this option then you need to add
</p><pre class="programlisting nix">home.stateVersion = "18.09";</pre><p class="simpara">to your configuration.</p></li><li class="listitem"><p class="simpara">
The Flake function <code class="literal">homeManagerConfiguration</code> has been simplified.
Specifically, the arguments
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem">
<code class="literal">configuration</code>,
</li><li class="listitem">
<code class="literal">username</code>,
</li><li class="listitem">
<code class="literal">homeDirectory</code>,
</li><li class="listitem">
<code class="literal">stateVersion</code>,
</li><li class="listitem">
<code class="literal">extraModules</code>, and
</li><li class="listitem">
<code class="literal">system</code>
</li></ul></div><p class="simpara">have been removed. Instead use the new <code class="literal">modules</code> argument, which
accepts a list of NixOS modules.</p><p class="simpara">Further, the <code class="literal">pkgs</code> argument is now mandatory and should be set to
<code class="literal">nixpkgs.legacyPackages.${system}</code> where <code class="literal">nixpkgs</code> is the Nixpkgs
input of your choice.</p><p class="simpara">For example, if your Flake currently contains</p><pre class="programlisting nix">homeManagerConfiguration {
configuration = import ./home.nix;
system = "x86_64-linux";
username = "jdoe";
homeDirectory = "/home/jdoe";
stateVersion = "22.05";
extraModules = [ ./some-extra-module.nix ];
}</pre><p class="simpara">then you can change it to</p><pre class="programlisting nix">homeManagerConfiguration {
pkgs = nixpkgs.legacyPackages.${system};
modules = [
./home.nix
./some-extra-module.nix
{
home = {
username = "jdoe";
homeDirectory = "/home/jdoe";
stateVersion = "22.05";
};
}
];
}</pre><p class="simpara">Of course, you can move the assignment of <a class="xref" href="options.html#opt-home.username"><code class="option">home.username</code></a>,
<a class="xref" href="options.html#opt-home.homeDirectory"><code class="option">home.homeDirectory</code></a>, and <a class="xref" href="options.html#opt-home.stateVersion"><code class="option">home.stateVersion</code></a> to some
other file or simply place them in your <code class="literal">home.nix</code>.</p></li><li class="listitem"><p class="simpara">
The <code class="literal">services.picom</code> module has been refactored to use structural
settings.
</p><p class="simpara">As a result <code class="literal">services.picom.extraOptions</code> has been removed in favor of
<a class="xref" href="options.html#opt-services.picom.settings"><code class="option">services.picom.settings</code></a>. Also, <code class="literal">services.picom.blur*</code> were
removed since upstream changed the blur settings to be more flexible.
You can migrate the blur settings to use
<a class="xref" href="options.html#opt-services.picom.settings"><code class="option">services.picom.settings</code></a> instead.</p></li><li class="listitem">
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.
</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-22.11-state-version-changes"></a>E.3.2. State Version Changes</h3></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 "22.11" or later.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
The <a class="xref" href="options.html#opt-services.mpd.musicDirectory"><code class="option">services.mpd.musicDirectory</code></a> option now defaults to the
value of <a class="xref" href="options.html#opt-xdg.userDirs.music"><code class="option">xdg.userDirs.music</code></a> if <a class="xref" href="options.html#opt-xdg.userDirs.enable"><code class="option">xdg.userDirs.enable</code></a> is
enabled. Otherwise it is undefined and must be specified in the user
configuration.
</li><li class="listitem"><p class="simpara">
The activation script now resets <code class="literal">PATH</code> before running. Before, the
users <code class="literal">PATH</code> environment variable would be used in the script and
this made it possible for commands in the activation script to run
arbitrary commands accessible to the user. We now restrict the
activation script to commands that are explicitly specified.
</p><p class="simpara">There is no official way to restore the old behavior. We attempt to
make the activation script as reproducible as possible and honoring
the users <code class="literal">PATH</code> reduces reproducibility.</p><p class="simpara">If you need to run a command in an activation script block then refer
to the command by its absolute command path, such as
<code class="literal">${pkgs.hello}/bin/hello</code>.</p></li></ul></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="sec-release-22.05"></a>E.4. Release 22.05</h2></div></div></div><p>The 22.05 release branch became the stable branch in May, 2022.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-22.05-highlights"></a>E.4.1. Highlights</h3></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">
The <code class="literal">programs.waybar.settings.modules</code> option was removed.
Waybar modules should now be declared directly under <code class="literal">programs.waybar.settings</code>.
</li><li class="listitem"><p class="simpara">
Home Manager now partially support translation of texts into different languages.
Note, the support is quite limited at the moment.
Specifically, it only applies to parts of the system written in the Bash language,
such as the <code class="literal">home-manager</code> command line tool and the activation script.
</p><p class="simpara">If you would like to contribute to the translation effort
then you 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">
A new module, <code class="literal">launchd.agents</code> was added.
Use this to enable services based on macOS LaunchAgents.
</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-22.05-state-version-changes"></a>E.4.2. State Version Changes</h3></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 "22.05" or later.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p class="simpara">
The <a class="xref" href="options.html#opt-programs.waybar.settings"><code class="option">programs.waybar.settings</code></a> option now allows defining modules directly under <a class="xref" href="options.html#opt-programs.waybar.settings"><code class="option">programs.waybar.settings</code></a>.
Defining modules under <code class="literal">programs.waybar.settings.modules</code> will now be an error.
For example,
</p><pre class="programlisting nix">programs.waybar.settings.modules."custom/my-module" = { };</pre><p class="simpara">becomes</p><pre class="programlisting nix">programs.waybar.settings."custom/my-module" = { };</pre></li></ul></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="sec-release-21.11"></a>E.5. Release 21.11</h2></div></div></div><p>The 21.11 release branch became the stable branch in November, 2021.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-21.11-highlights"></a>E.5.1. Highlights</h3></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 class="simpara">
All Home Manager modules are now loaded on all platforms. With this
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 class="simpara">Previously, modules that were platform specific would only be loaded
on that particular platform. For example, a module defining a
<a class="link" href="https://systemd.io/" target="_top">systemd</a> service would only be loaded when the
host platform was Linux. This reduced evaluation times, simplified the
generated documentation, and made it impossible to accidentally use
modules that do not support the host platform.</p><p class="simpara">While the above benefits are quite nice, avoiding module loads also
brings a few problems. For example, the
<a class="link" href="https://nix-community.github.io/home-manager/" target="_top">public documentation</a>
will only show the options available for Linux hosts and the
documentation cannot make references to options within modules that
are unavailable on some hosts. Finally, users who wish to use the same
configuration file for different platforms cannot do so, even if the
platform incompatible options are unused.</p><p class="simpara">Ultimately, the benefits of loading all modules won and the behavior
has now changed. For associated discussion see
<a class="link" href="https://github.com/nix-community/home-manager/issues/1906" target="_top">issue #1906</a>.</p></li><li class="listitem"><p class="simpara">
Rofi version 1.7.0 removed many options that were used by the module and replaced them with custom themes, which are more flexible and powerful.
</p><p class="simpara">You can replicate your old configuration by moving those options to <a class="xref" href="options.html#opt-programs.rofi.theme"><code class="option">programs.rofi.theme</code></a>. Keep in mind that the syntax is different so you may need to do some changes.</p></li><li class="listitem">
Taskwarrior version 2.6.0 respects XDG Specification for the config file now.
Option <a class="xref" href="options.html#opt-programs.taskwarrior.config"><code class="option">programs.taskwarrior.config</code></a> and friends now generate the config file at
<code class="literal">$XDG_CONFIG_HOME/task/taskrc</code> instead of <code class="literal">~/.taskrc</code>.
</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-21.11-state-version-changes"></a>E.5.2. State Version Changes</h3></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
"21.11" or later.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
The <a class="xref" href="options.html#opt-home.keyboard"><code class="option">home.keyboard</code></a> option now defaults to <code class="literal">null</code>, meaning that Home Manager wont do any keyboard layout management. For example, <code class="literal">setxkbmap</code> wont be run in X sessions.
</li><li class="listitem"><p class="simpara">
The <a class="xref" href="options.html#opt-programs.pet.settings"><code class="option">programs.pet.settings</code></a> option no longer place its value inside a <code class="literal">General</code> attribute.
For example,
</p><pre class="programlisting nix">programs.pet.settings.editor = "nvim";</pre><p class="simpara">becomes</p><pre class="programlisting nix">programs.pet.settings.General.editor = "nvim";</pre></li><li class="listitem"><p class="simpara">
The <a class="xref" href="options.html#opt-programs.waybar.settings"><code class="option">programs.waybar.settings</code></a> option now allows defining modules directly under <a class="xref" href="options.html#opt-programs.waybar.settings"><code class="option">programs.waybar.settings</code></a>.
For example,
</p><pre class="programlisting nix">programs.waybar.settings.modules."custom/my-module" = { };</pre><p class="simpara">becomes</p><pre class="programlisting nix">programs.waybar.settings."custom/my-module" = { };</pre></li></ul></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="sec-release-21.05"></a>E.6. Release 21.05</h2></div></div></div><p>The 21.05 release branch became the stable branch in May, 2021.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-21.05-highlights"></a>E.6.1. Highlights</h3></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 class="simpara">
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 list
items <code class="literal">invocation</code> keys. For example,
</p><pre class="programlisting nix">programs.broot.verbs = {
"p" = { execution = ":parent"; };
};</pre><p class="simpara">becomes</p><pre class="programlisting nix">programs.broot.verbs = [
{
invocation = "p";
execution = ":parent";
}
];</pre></li><li class="listitem"><p class="simpara">
The <a class="xref" href="options.html#opt-programs.mpv.package"><code class="option">programs.mpv.package</code></a> option has been changed to allow custom
derivations. The following configuration is now possible:
</p><pre class="programlisting nix">programs.mpv.package = (pkgs.wrapMpv (pkgs.mpv-unwrapped.override {
vapoursynthSupport = true;
}) {
extraMakeWrapperArgs = [
"--prefix" "LD_LIBRARY_PATH" ":" "${pkgs.vapoursynth-mvtools}/lib/vapoursynth"
];
});</pre><p class="simpara">As a result of this change, <a class="xref" href="options.html#opt-programs.mpv.package"><code class="option">programs.mpv.package</code></a> is no longer the
resulting derivation. Use the newly introduced <code class="literal">programs.mpv.finalPackage</code>
instead.</p></li><li class="listitem"><p class="simpara">
The <a class="xref" href="options.html#opt-programs.rofi.extraConfig"><code class="option">programs.rofi.extraConfig</code></a> option is now an attribute set rather
than a string. To migrate, move each line into the attribute set,
removing the <code class="literal">rofi.</code> prefix from the keys. For example,
</p><pre class="programlisting nix">programs.rofi.extraConfig = ''
rofi.show-icons: true
rofi.modi: drun,emoji,ssh
'';</pre><p class="simpara">becomes</p><pre class="programlisting nix">programs.rofi.extraConfig = {
show-icons = true;
modi = "drun,emoji,ssh";
};</pre></li><li class="listitem"><p class="simpara">
The <a class="xref" href="options.html#opt-programs.rofi.theme"><code class="option">programs.rofi.theme</code></a> option now supports defining a theme
using an attribute set, the following configuration is now possible:
</p><pre class="programlisting nix">programs.rofi.theme = let
# Necessary to avoid quoting non-string values
inherit (config.lib.formats.rasi) mkLiteral;
in {
"@import" = "~/.config/rofi/theme.rasi";
"*" = {
background-color = mkLiteral "#000000";
foreground-color = mkLiteral "rgba ( 250, 251, 252, 100 % )";
border-color = mkLiteral "#FFFFFF";
width = 512;
};
"#textbox-prompt-colon" = {
expand = false;
str = ":";
margin = mkLiteral "0px 0.3em 0em 0em";
text-color = mkLiteral "@foreground-color";
};
};</pre></li><li class="listitem"><p class="simpara">
The <code class="literal">services.redshift.extraOptions</code> and <code class="literal">services.gammastep.extraOptions</code>
options were removed in favor of <a class="xref" href="options.html#opt-services.redshift.settings"><code class="option">services.redshift.settings</code></a> and
<code class="literal">services.gammastep.settings</code>, that are now an attribute set rather
than a string. They also support new features not available before, for
example:
</p><pre class="programlisting nix">services.redshift = {
dawnTime = "6:00-7:45";
duskTime = "18:35-20:15";
settings = {
redshift = {
gamma = 0.8;
adjustment-method = "randr";
};
randr = {
screen = 0;
};
};
};</pre><p class="simpara">It is recommended to check either
<a class="link" href="https://github.com/jonls/redshift/blob/master/redshift.conf.sample" target="_top">redshift.conf.sample</a> or
<a class="link" href="https://gitlab.com/chinstrap/gammastep/-/blob/master/gammastep.conf.sample" target="_top">gammastep.conf.sample</a>
for the available additional options in each program.</p></li><li class="listitem">
Specifying <code class="literal">programs.neomutt.binds.map</code> or <code class="literal">programs.neomutt.macros.map</code> as a
single string is now deprecated in favor of specfiying it as a list of
strings.
</li><li class="listitem"><p class="simpara">
The <code class="literal">programs.neovim.configure</code> is deprecated in favor of other <code class="literal">programs.neovim</code> options;
please use the other options at your disposal:
</p><pre class="programlisting nix">configure.packages.*.opt -&gt; programs.neovim.plugins = [ { plugin = ...; optional = true; }]
configure.packages.*.start -&gt; programs.neovim.plugins = [ { plugin = ...; }]
configure.customRC -&gt; programs.neovim.extraConfig</pre></li><li class="listitem">
Home Manager now respects the <code class="literal">NO_COLOR</code> environment variable as per
<a class="link" href="https://no-color.org/" target="_top">https://no-color.org/</a>.
</li><li class="listitem"><p class="simpara">
Qt module now supports <a class="xref" href="options.html#opt-qt.style.name"><code class="option">qt.style.name</code></a> to specify a theme name and
<a class="xref" href="options.html#opt-qt.style.package"><code class="option">qt.style.package</code></a> to specify a theme package. If you have set
<a class="xref" href="options.html#opt-qt.platformTheme"><code class="option">qt.platformTheme</code></a> to <code class="literal">gnome</code>, a <a class="xref" href="options.html#opt-qt.style.package"><code class="option">qt.style.package</code></a> compatible
with both Qt and Gtk is now required to be set. For instance:
</p><pre class="programlisting nix">qt = {
platformTheme = "gnome";
style = {
name = "adwaita-dark";
package = pkgs.adwaita-qt;
};
};</pre></li><li class="listitem"><p class="simpara">
The library type <code class="literal">fontType</code> now has a <code class="literal">size</code> attribute in addition to <code class="literal">name</code>. For example:
</p><pre class="programlisting nix">font = {
name = "DejaVu Sans";
size = 8;
};</pre></li><li class="listitem"><p class="simpara">
The <a class="xref" href="options.html#opt-programs.htop.settings"><code class="option">programs.htop.settings</code></a> option is introduced to replace individual
options in <code class="literal">programs.htop</code>. To migrate, set the htop options directly in
<a class="xref" href="options.html#opt-programs.htop.settings"><code class="option">programs.htop.settings</code></a>. For example:
</p><pre class="programlisting nix">programs.htop = {
enabled = true;
settings = {
color_scheme = 5;
delay = 15;
highlight_base_name = 1;
highlight_megabytes = 1;
highlight_threads = 1;
};
};</pre></li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-21.05-state-version-changes"></a>E.6.2. State Version Changes</h3></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
"21.05" or later.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
The <code class="literal">newsboat</code> module now stores generated configuration in
<code class="literal">$XDG_CONFIG_HOME/newsboat</code>.
</li></ul></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="sec-release-20.09"></a>E.7. Release 20.09</h2></div></div></div><p>The 20.09 release branch became the stable branch in late September, 2020.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-20.09-highlights"></a>E.7.1. Highlights</h3></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">
Nothing has happened.
</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-20.09-state-version-changes"></a>E.7.2. State Version Changes</h3></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
"20.09" or later.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p class="simpara">
The options <a class="xref" href="options.html#opt-home.homeDirectory"><code class="option">home.homeDirectory</code></a> and <a class="xref" href="options.html#opt-home.username"><code class="option">home.username</code></a> no
longer have default values and must therefore be provided in your
configuration. Previously their values would default to the content of
the environment variables <code class="literal">HOME</code> and <code class="literal">USER</code>, respectively.
</p><p class="simpara">Further, the options <a class="xref" href="options.html#opt-xdg.cacheHome"><code class="option">xdg.cacheHome</code></a>, <a class="xref" href="options.html#opt-xdg.configHome"><code class="option">xdg.configHome</code></a>,
and <a class="xref" href="options.html#opt-xdg.dataHome"><code class="option">xdg.dataHome</code></a> will no longer be affected by the
<code class="literal">XDG_CACHE_HOME</code>, <code class="literal">XDG_CONFIG_HOME</code>, and <code class="literal">XDG_DATA_HOME</code> environment
variables. They now unconditionally default to</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem">
<code class="literal">"${config.home.homeDirectory}/.cache"</code>,
</li><li class="listitem">
<code class="literal">"${config.home.homeDirectory}/.config"</code>, and
</li><li class="listitem">
<code class="literal">"${config.home.homeDirectory}/.local/share"</code>.
</li></ul></div><p class="simpara">If you choose to switch to state version 20.09 then you must set these
options if you use non-default XDG base directory paths.</p><p class="simpara">The initial configuration generated by</p><pre class="programlisting console">$ nix-shell '&lt;home-manager&gt;' -A install</pre><p class="simpara">will automatically include these options, when necessary.</p></li><li class="listitem">
Gits <code class="literal">smtpEncryption</code> option is now set to <code class="literal">tls</code> only if both <a class="xref" href="options.html#opt-accounts.email.accounts._name_.smtp.tls.enable"><code class="option">accounts.email.accounts.&lt;name&gt;.smtp.tls.enable</code></a> and <a class="xref" href="options.html#opt-accounts.email.accounts._name_.smtp.tls.useStartTls"><code class="option">accounts.email.accounts.&lt;name&gt;.smtp.tls.useStartTls</code></a> are <code class="literal">true</code>. If only <a class="xref" href="options.html#opt-accounts.email.accounts._name_.smtp.tls.enable"><code class="option">accounts.email.accounts.&lt;name&gt;.smtp.tls.enable</code></a> is <code class="literal">true</code>, <code class="literal">ssl</code> is used instead.
</li><li class="listitem"><p class="simpara">
The <code class="literal">nixpkgs</code> module no longer references <code class="literal">&lt;nixpkgs&gt;</code>. Before it would do so when building the <code class="literal">pkgs</code> module argument. Starting with state version 20.09, the <code class="literal">pkgs</code> argument is instead built from the same Nixpkgs that was used to initialize the Home Manager modules. This is useful, for example, when using Home Manager within a Nix Flake. If you want to keep using <code class="literal">&lt;nixpkgs&gt;</code> with state version ≥ 20.09 then add
</p><pre class="programlisting nix">_module.args.pkgsPath = &lt;nixpkgs&gt;;</pre><p class="simpara">to your Home Manager configuration.</p></li><li class="listitem"><p class="simpara">
The options <code class="literal">wayland.windowManager.sway.config.bars</code> and <code class="literal">opt-xsession.windowManager.i3.config.bars</code> have been changed so that most of the suboptions are now nullable and default to <code class="literal">null</code>. The default for these two options has been changed to manually set the old defaults for each suboption. The overall effect is that if the <code class="literal">bars</code> options is not set, then the default remains the same. On the other hand, something like:
</p><pre class="programlisting nix">bars = [ {
command = "waybar";
} ];</pre><p class="simpara">will now create the config:</p><pre class="literallayout">bar {
swaybar_command waybar
}</pre><p class="simpara">instead of</p><pre class="literallayout">bar {
font pango:monospace 8
mode dock
hidden_state hide
position bottom
status_command /nix/store/h7s6i9q1z5fxrlyyw5ls8vqxhf5bcs5a-i3status-2.13/bin/i3status
swaybar_command waybar
workspace_buttons yes
strip_workspace_numbers no
tray_output primary
colors {
background #000000
statusline #ffffff
separator #666666
focused_workspace #4c7899 #285577 #ffffff
active_workspace #333333 #5f676a #ffffff
inactive_workspace #333333 #222222 #888888
urgent_workspace #2f343a #900000 #ffffff
binding_mode #2f343a #900000 #ffffff
}
}</pre></li></ul></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="sec-release-20.03"></a>E.8. Release 20.03</h2></div></div></div><p>The 20.03 release branch became the stable branch in April, 2020.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-20.03-highlights"></a>E.8.1. Highlights</h3></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 class="simpara">
Assigning a list to the <a class="xref" href="options.html#opt-home.file"><code class="option">home.file</code></a>, <a class="xref" href="options.html#opt-xdg.configFile"><code class="option">xdg.configFile</code></a>,
and <a class="xref" href="options.html#opt-xdg.dataFile"><code class="option">xdg.dataFile</code></a> options is now deprecated and will produce a
warning message if used. Specifically, if your configuration currently
contains something like
</p><pre class="programlisting nix">home.file = [
{
target = ".config/foo.txt";
text = "bar";
}
]</pre><p class="simpara">then it should be updated to instead use the equivalent attribute set form</p><pre class="programlisting nix">home.file = {
".config/foo.txt".text = "bar";
}</pre><p class="simpara">Support for the list form will be removed in Home Manager version
20.09.</p></li><li class="listitem"><p class="simpara">
The <code class="literal">lib</code> function attribute given to modules is now enriched with
an attribute <code class="literal">hm</code> containing extra library functions specific for Home
Manager. More specifically, <code class="literal">lib.hm</code> is now the same as <code class="literal">config.lib</code>
and should be the preferred choice since it is more robust.
</p><p class="simpara">Therefore, if your configuration makes use of, for example,
<code class="literal">config.lib.dag</code> to create activation script blocks, it is recommended
to change to <code class="literal">lib.hm.dag</code>.</p><p class="simpara">Note, in the unlikely case that you are</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "><li class="listitem">
using Home Managers NixOS or nix-darwin module,
</li><li class="listitem">
have made your own Home Manager module containing an top-level
option named <code class="literal">config</code> or <code class="literal">options</code>, and
</li><li class="listitem">
assign to this option in your system configuration inside a plain
attribute set, i.e., without a function argument,
</li></ul></div><p class="simpara">then you must update your configuration to perform the option
assignment inside a <code class="literal">config</code> attribute. For example, instead of</p><pre class="programlisting nix">home-manager.users.jane = { config = "foo"; };</pre><p class="simpara">use</p><pre class="programlisting nix">home-manager.users.jane = { config.config = "foo"; };</pre></li><li class="listitem">
The <code class="literal">services.compton</code> module has been deprecated and instead the
new module <code class="literal">services.picom</code> should be used. This is because Nixpkgs no
longer packages compton, and instead packages the (mostly) compatible
fork called picom.
</li><li class="listitem"><p class="simpara">
The list form of the <a class="xref" href="options.html#opt-programs.ssh.matchBlocks"><code class="option">programs.ssh.matchBlocks</code></a> option has
been deprecated and configurations requiring match blocks in a defined
order should switch to using DAG entries instead. For example, a
configuration
</p><pre class="programlisting nix">programs.ssh.matchBlocks = [
{
host = "alpha.foo.com";
user = "jd";
}
{
host = "*.foo.com";
user = "john.doe";
}
];</pre><p class="simpara">can be expressed along the lines of</p><pre class="programlisting nix">programs.ssh.matchBlocks = {
"*.example.com" = {
user = "john.doe";
}
"alpha.example.com" = lib.hm.dag.entryBefore ["*.example.com"] {
user = "jd";
}
};</pre><p class="simpara">Support for the list form will be removed in Home Manager version
20.09.</p></li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-20.03-state-version-changes"></a>E.8.2. State Version Changes</h3></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
"20.03" or later.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
The <a class="xref" href="options.html#opt-programs.zsh.history.path"><code class="option">programs.zsh.history.path</code></a> option is no longer prepended
by <code class="literal">$HOME</code>, which allows specifying absolute paths, for example,
using the xdg module. Also, the default value is fixed to
<code class="literal">$HOME/.zsh_history</code> and <code class="literal">dotDir</code> path is not prepended to it
anymore.
</li><li class="listitem">
The newsboat module will now default in displaying <code class="literal">queries</code> before <code class="literal">urls</code> in
its main window. This makes sense in the case when one has a lot of URLs and
few queries.
</li></ul></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="sec-release-19.09"></a>E.9. Release 19.09</h2></div></div></div><p>The 19.09 release branch became the stable branch in October, 2019.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-19.09-highlights"></a>E.9.1. Highlights</h3></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">
The <code class="literal">programs.firefox.enableGoogleTalk</code> and
<code class="literal">programs.firefox.enableIcedTea</code> options are now deprecated
and will only work if Firefox ESR 52.x is used.
</li><li class="listitem">
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
mode. That is, not as a NixOS module.
</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-19.09-state-version-changes"></a>E.9.2. State Version Changes</h3></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
"19.09" or later.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
The <a class="xref" href="options.html#opt-programs.firefox.package"><code class="option">programs.firefox.package</code></a> option now expects a wrapped
Firefox package and defaults to <code class="literal">pkgs.firefox</code>.
</li><li class="listitem">
The options <a class="xref" href="options.html#opt-home.keyboard.layout"><code class="option">home.keyboard.layout</code></a> and
<a class="xref" href="options.html#opt-home.keyboard.variant"><code class="option">home.keyboard.variant</code></a> now default to <code class="literal">null</code>, which indicates
that the system value should be used.
</li></ul></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="sec-release-19.03"></a>E.10. Release 19.03</h2></div></div></div><p>The 19.03 release branch became the stable branch in April, 2019.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-19.03-highlights"></a>E.10.1. Highlights</h3></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 class="simpara">
The <a class="xref" href="options.html#opt-home.file._name_.source"><code class="option">home.file.&lt;name&gt;.source</code></a> option now allows source 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 not typically
allowed for Nix store paths. For example, your configuration can now
contain things such as
</p><pre class="programlisting nix">home.file."my file".source = ./. + "/file with spaces!";</pre></li><li class="listitem"><p class="simpara">
The type used for the systemd unit options under
<a class="xref" href="options.html#opt-systemd.user.services"><code class="option">systemd.user.services</code></a>, <a class="xref" href="options.html#opt-systemd.user.sockets"><code class="option">systemd.user.sockets</code></a>, etc. has
been changed to offer more robust merging of configurations. If you
dont override values within systemd units then you are not affected
by this change. Unfortunately, if you do override unit values you may
encounter errors.
</p><p class="simpara">In particular, if you get an error saying that a “unique option” is
“defined multiple times” then you need to use the
<a class="link" href="https://nixos.org/nixos/manual/#sec-option-definitions-setting-priorities" target="_top"><code class="literal">mkForce</code></a>
function. For example,</p><pre class="programlisting nix">systemd.user.services.foo.Service.ExecStart = "/foo/bar";</pre><p class="simpara">becomes</p><pre class="programlisting nix">systemd.user.services.foo.Service.ExecStart = lib.mkForce "/foo/bar";</pre><p class="simpara">We had to make this change because the old merging was causing too
many confusing situations for people.</p></li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="sec-release-19.03-state-version-changes"></a>E.10.2. State Version Changes</h3></div></div></div><p>The state version in this release includes the changes below. These
changes are only active if the <a class="xref" href="options.html#opt-home.stateVersion"><code class="option">home.stateVersion</code></a> option is set
to “19.03” or later.</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
There is now an option <a class="xref" href="options.html#opt-programs.beets.enable"><code class="option">programs.beets.enable</code></a> that defaults
to <code class="literal">false</code>. Before the module would be active if the
<a class="xref" href="options.html#opt-programs.beets.settings"><code class="option">programs.beets.settings</code></a> option was non-empty.
</li></ul></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="sec-release-18.09"></a>E.11. Release 18.09</h2></div></div></div><p>The 18.09 release branch became the stable branch in September, 2018.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="tools.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> </td></tr><tr><td width="40%" align="left" valign="top">Appendix D. Tools </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>