news: add entry about support stopping as of May 1

(cherry picked from commit cb93316fed)

.travis.yml

@@ -6,8 +6,7 @@ os:
 
 before_script:
   - mkdir -m 0755 -p /nix/var/nix/{profiles,gcroots}/per-user/$USER
-  - mkdir -p ~/.config/nixpkgs
-  - echo "{}" > ~/.config/nixpkgs/home.nix
 
 script:
-  nix-shell . -A install
+  - nix-shell . -A install
+  - nix-shell tests -A run.all

FAQ.md

@@ -104,3 +104,18 @@ You can get some inspiration from the [Post your home-manager home.nix
 file!][1] Reddit thread.
 
 [1]: https://www.reddit.com/r/NixOS/comments/9bb9h9/post_your_homemanager_homenix_file/
+
+Why do I get an error message about `ca.desrt.dconf`?
+-----------------------------------------------------
+
+You are most likely trying to configure the GTK or Gnome Terminal but
+the DBus session is not aware of the dconf service. The full error you
+might get is
+
+    error: GDBus.Error:org.freedesktop.DBus.Error.ServiceUnknown: The name ca.desrt.dconf was not provided by any .service files
+
+The solution on NixOS is to add
+
+    services.dbus.packages = with pkgs; [ gnome3.dconf ];
+
+to your system configuration.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2018 Robert Helgesson
+Copyright (c) 2017-2019 Robert Helgesson and Home Manager contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -19,7 +19,7 @@ will write to your dconf store and cannot tell whether a configuration
 that it is about to be overwrite was from a previous Home Manager
 generation or from manual configuration.
 
-Home Manager targets [NixOS][] unstable and NixOS version 18.03 (the
+Home Manager targets [NixOS][] unstable and NixOS version 18.09 (the
 current stable version), it may or may not work on other Linux
 distributions and NixOS versions.
 
@@ -31,6 +31,13 @@ on how to manually perform a rollback.
 Now when your expectations have been built up and you are eager to try
 all this out you can go ahead and read the rest of this text.
 
+Contact
+-------
+
+You can chat with us on IRC in the channel [#home-manager][] on
+[freenode][]. The [channel logs][] are hosted courtesy of
+[samueldr][].
+
 Installation
 ------------
 
@@ -48,56 +55,57 @@ Currently the easiest way to install Home Manager is as follows:
 
     Also make sure that your user is able to build and install Nix
     packages. For example, you should be able to successfully run a
-    command like `nix-instantiate '<nixpkgs>' -A hello`. For a
+    command like `nix-instantiate '<nixpkgs>' -A hello` without having
-    multi-user install of Nix this means that your user must be
+    to switch to the root user. For a multi-user install of Nix this
-    covered by the [`allowed-users`][nixAllowedUsers] Nix option. On
+    means that your user must be covered by the
-    NixOS you can control this option using the
+    [`allowed-users`][nixAllowedUsers] Nix option. On NixOS you can
+    control this option using the
     [`nix.allowedUsers`][nixosAllowedUsers] system option.
 
-2.  Assign a temporary variable holding the URL to the appropriate
+2.  Add the appropriate Home Manager channel. Typically this is
-    archive. Typically this is
 
     ```console
-    $ HM_PATH=https://github.com/rycee/home-manager/archive/master.tar.gz
+    $ nix-channel --add https://github.com/rycee/home-manager/archive/master.tar.gz home-manager
+    $ nix-channel --update
     ```
 
     if you are following Nixpkgs master or an unstable channel and
 
     ```console
-    $ HM_PATH=https://github.com/rycee/home-manager/archive/release-18.03.tar.gz
+    $ nix-channel --add https://github.com/rycee/home-manager/archive/release-18.09.tar.gz home-manager
+    $ nix-channel --update
     ```
 
-    if you follow a Nixpkgs version 18.03 channel.
+    if you follow a Nixpkgs version 18.09 channel.
 
-3.  Create an initial Home Manager configuration file:
+    On NixOS you may need to log out and back in for the channel to
+    become available. On non-NixOS you may have to add
+
+    ```shell
+    export NIX_PATH=$HOME/.nix-defexpr/channels${NIX_PATH:+:}$NIX_PATH
+    ```
+
+    to your shell (see [nix#2033](https://github.com/NixOS/nix/issues/2033)).
+
+3.  Install Home Manager and create the first Home Manager generation:
 
     ```console
-    $ cat > ~/.config/nixpkgs/home.nix <<EOF
+    $ nix-shell '<home-manager>' -A install
-    {
-      programs.home-manager.enable = true;
-      programs.home-manager.path = $HM_PATH;
-    }
-    EOF
     ```
 
-4.  Install Home Manager and create the first Home Manager generation:
+    Once finished, Home Manager should be active and available in your
+    user environment.
 
-    ```console
+3.  If you do not plan on having Home Manager manage your shell
-    $ nix-shell $HM_PATH -A install
-    ```
-
-    Home Manager should now be active and available in your user
-    environment.
-
-5.  If you do not plan on having Home Manager manage your shell
     configuration then you must source the
 
     ```
-    "$HOME/.nix-profile/etc/profile.d/hm-session-vars.sh"
+    $HOME/.nix-profile/etc/profile.d/hm-session-vars.sh
     ```
 
-    file in your shell configuration. Unfortunately, we currently only
+    file in your shell configuration. Unfortunately, in this specific
-    support POSIX.2-like shells such as [Bash][] or [Z shell][].
+    case we currently only support POSIX.2-like shells such as
+    [Bash][] or [Z shell][].
 
     For example, if you use Bash then add
 
@@ -107,11 +115,10 @@ Currently the easiest way to install Home Manager is as follows:
 
     to your `~/.profile` file.
 
-Note, because the `HM_PATH` variable above points to the live Home
+If instead of using channels you want to run Home Manager from a Git
-Manager repository you will automatically get updates whenever you
+checkout of the repository then you can use the
-build a new generation. If you dislike automatic updates then perform
+`programs.home-manager.path` option to specify the absolute path to
-a Git clone of the desired branch and instead do the above steps with
+the repository.
-`HM_PATH` set to the _absolute path_ of your clone.
 
 Usage
 -----
@@ -232,7 +239,7 @@ such collision is detected the activation will terminate before
 changing anything on your computer.
 
 For example, suppose you have a wonderful, painstakingly created
-`~/.gitconfig` and add
+`~/.config/git/config` and add
 
 ```nix
 {
@@ -301,3 +308,7 @@ in your Home Manager configuration.
 [nixosAllowedUsers]: https://nixos.org/nixos/manual/options.html#opt-nix.allowedUsers
 [Z shell]: http://zsh.sourceforge.net/
 [configuration options]: https://rycee.gitlab.io/home-manager/options.html
+[#home-manager]: https://webchat.freenode.net/?url=irc%3A%2F%2Firc.freenode.net%2Fhome-manager
+[freenode]: https://freenode.net/
+[channel logs]: https://logs.nix.samueldr.com/home-manager/
+[samueldr]: https://github.com/samueldr/

doc/default.nix

@@ -119,6 +119,7 @@ let
       <toc role="chunk-toc">
         <d:tocentry xmlns:d="http://docbook.org/ns/docbook" linkend="book-home-manager-manual"><?dbhtml filename="index.html"?>
           <d:tocentry linkend="ch-options"><?dbhtml filename="options.html"?></d:tocentry>
+          <d:tocentry linkend="ch-release-notes"><?dbhtml filename="release-notes.html"?></d:tocentry>
         </d:tocentry>
       </toc>
     '';

doc/installation.xml

@@ -0,0 +1,236 @@
+<chapter xmlns="http://docbook.org/ns/docbook"
+      xmlns:xlink="http://www.w3.org/1999/xlink"
+      xmlns:xi="http://www.w3.org/2001/XInclude"
+      version="5.0"
+      xml:id="ch-installation">
+ <title>Installing Home Manager</title>
+ <para>
+  Home Manager can be used in three primary ways:
+  <orderedlist>
+   <listitem>
+    <para>
+     Using the standalone <command>home-manager</command> tool. For platforms
+     other than NixOS and Darwin, this is the only available choice. It is also
+     recommended for people on NixOS or Darwin that want to manage their home
+     directory independent of the system as a whole. See
+     <xref linkend="sec-install-standalone"/> for instructions on how to
+     perform this installation.
+    </para>
+   </listitem>
+   <listitem>
+    <para>
+     As a module within a NixOS system configuration. This allows the user
+     profiles to be built together with the system when running
+     <command>nixos-rebuild</command>. See
+     <xref linkend="sec-install-nixos-module"/> for a description of this
+     setup.
+    </para>
+   </listitem>
+   <listitem>
+    <para>
+     As a module within a
+     <link xlink:href="https://github.com/LnL7/nix-darwin/">nix-darwin</link>
+     system configuration. This allows the user profiles to be built together
+     with the system when running <command>darwin-rebuild</command>. See
+     <xref linkend="sec-install-nix-darwin-module"/> for a description of this
+     setup.
+    </para>
+   </listitem>
+  </orderedlist>
+ </para>
+ <section xml:id="sec-install-standalone">
+  <title>Standalone installation</title>
+
+  <orderedlist>
+   <listitem>
+    <para>
+     Make sure you have a working Nix installation. If you are not using NixOS
+     then it may be necessary to run
+    </para>
+<screen>
+<prompt>$</prompt> <userinput>mkdir -m 0755 -p /nix/var/nix/{profiles,gcroots}/per-user/$USER</userinput>
+</screen>
+    <para>
+     since Home Manager uses these directories to manage your profile
+     generations. On NixOS these should already be available.
+    </para>
+    <para>
+     Also make sure that your user is able to build and install Nix packages.
+     For example, you should be able to successfully run a command like
+     <literal>nix-instantiate '&lt;nixpkgs&gt;' -A hello</literal> without
+     having to switch to the root user. For a multi-user install of Nix this
+     means that your user must be covered by the
+     <link xlink:href="https://nixos.org/nix/manual/#conf-allowed-users"><literal>allowed-users</literal></link>
+     Nix option. On NixOS you can control this option using the
+     <link xlink:href="https://nixos.org/nixos/manual/options.html#opt-nix.allowedUsers"><literal>nix.allowedUsers</literal></link>
+     system option.
+    </para>
+   </listitem>
+   <listitem>
+    <para>
+     Add the Home Manager channel that you wish to follow. This is done by
+     running
+    </para>
+<screen>
+<prompt>$</prompt> <userinput>nix-channel --add https://github.com/rycee/home-manager/archive/master.tar.gz home-manager</userinput>
+<prompt>$</prompt> <userinput>nix-channel --update</userinput>
+</screen>
+    <para>
+     if you are following Nixpkgs master or an unstable channel and
+    </para>
+<screen>
+<prompt>$</prompt> <userinput>nix-channel --add https://github.com/rycee/home-manager/archive/release-18.09.tar.gz home-manager</userinput>
+<prompt>$</prompt> <userinput>nix-channel --update</userinput>
+</screen>
+    <para>
+     if you follow a Nixpkgs version 18.09 channel.
+    </para>
+    <para>
+     On NixOS you may need to log out and back in for the channel to become
+     available. On non-NixOS you may have to add
+<programlisting language="bash">
+export NIX_PATH=$HOME/.nix-defexpr/channels${NIX_PATH:+:}$NIX_PATH
+</programlisting>
+     to your shell (see
+     <link xlink:href="https://github.com/NixOS/nix/issues/2033">nix#2033</link>).
+    </para>
+   </listitem>
+   <listitem>
+    <para>
+     Run the Home Manager installation command and create the first Home
+     Manager generation:
+    </para>
+<screen>
+<prompt>$</prompt> <userinput>nix-shell '&lt;home-manager&gt;' -A install</userinput>
+</screen>
+    <para>
+     Once finished, Home Manager should be active and available in your user
+     environment.
+    </para>
+   </listitem>
+   <listitem>
+    <para>
+     If you do not plan on having Home Manager manage your shell configuration
+     then you must source the
+    </para>
+<programlisting language="bash">
+$HOME/.nix-profile/etc/profile.d/hm-session-vars.sh
+</programlisting>
+    <para>
+     file in your shell configuration. Unfortunately, we currently only support
+     POSIX.2-like shells such as
+     <link xlink:href="https://www.gnu.org/software/bash/">Bash</link> or
+     <link xlink:href="http://zsh.sourceforge.net/">Z shell</link>.
+    </para>
+    <para>
+     For example, if you use Bash then add
+    </para>
+<programlisting language="bash">
+. &quot;$HOME/.nix-profile/etc/profile.d/hm-session-vars.sh&quot;
+</programlisting>
+    <para>
+     to your <literal>~/.profile</literal> file.
+    </para>
+   </listitem>
+  </orderedlist>
+
+  <para>
+   If instead of using channels you want to run Home Manager from a Git
+   checkout of the repository then you can use the
+   <literal>programs.home-manager.path</literal> option to specify the absolute
+   path to the repository.
+  </para>
+ </section>
+ <section xml:id="sec-install-nixos-module">
+  <title>NixOS module</title>
+
+  <para>
+   Home Manager provides a NixOS module that allows you to prepare user
+   environments directly from the system configuration file, which often is
+   more convenient than using the <command>home-manager</command> tool. It also
+   opens up additional possibilities, for example, to automatically configure
+   user environments in NixOS declarative containers or on systems deployed
+   through NixOps.
+  </para>
+
+  <para>
+   To make the NixOS module available for use you must <option>import</option>
+   it into your system configuration. This is most conveniently done by adding
+   a Home Manager channel, for example
+  </para>
+
+<screen>
+<prompt>#</prompt> <userinput>nix-channel --add https://github.com/rycee/home-manager/archive/master.tar.gz home-manager</userinput>
+<prompt>#</prompt> <userinput>nix-channel --update</userinput>
+</screen>
+
+  <para>
+   if you are following Nixpkgs master or an unstable channel and
+  </para>
+
+<screen>
+<prompt>#</prompt> <userinput>nix-channel --add https://github.com/rycee/home-manager/archive/release-18.09.tar.gz home-manager</userinput>
+<prompt>#</prompt> <userinput>nix-channel --update</userinput>
+</screen>
+
+  <para>
+   if you follow a Nixpkgs version 18.09 channel.
+  </para>
+
+  <para>
+   It is then possible to add
+  </para>
+
+<programlisting language="nix">
+imports = [ &lt;home-manager/nixos&gt; ];
+</programlisting>
+
+  <para>
+   to your system <filename>configuration.nix</filename> file, which will
+   introduce a new NixOS option called <option>home-manager.users</option>
+   whose type is an attribute set that maps user names to Home Manager
+   configurations.
+  </para>
+
+  <para>
+   For example, a NixOS configuration may include the lines
+  </para>
+
+<programlisting language="nix">
+users.users.eve.isNormalUser = true;
+home-manager.users.eve = { pkgs, ... }: {
+  home.packages = [ pkgs.atool pkgs.httpie ];
+  programs.bash.enable = true;
+};
+</programlisting>
+
+  <para>
+   and after a <command>nixos-rebuild switch</command> the user eve's
+   environment should include a basic Bash configuration and the packages atool
+   and httpie.
+  </para>
+
+  <note>
+   <para>
+    By default packages will be installed to
+    <filename>$HOME/.nix-profile</filename> but they can be installed to
+    <filename>/etc/profiles</filename> if
+   </para>
+<programlisting language="nix">
+home-manager.useUserPackages = true;
+</programlisting>
+   <para>
+    is added to the system configuration. This is necessary if, for example,
+    you wish to use <command>nixos-rebuild build-vm</command>. This option may
+    become the default value in the future.
+   </para>
+  </note>
+ </section>
+ <section xml:id="sec-install-nix-darwin-module">
+  <title>nix-darwin module</title>
+
+  <para>
+   To be done.
+  </para>
+ </section>
+</chapter>

doc/man-configuration.xml

@@ -7,22 +7,19 @@
   <refmiscinfo class="source">Home Manager</refmiscinfo>
 <!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> -->
  </refmeta>
-
  <refnamediv>
   <refname><filename>home-configuration.nix</filename></refname>
   <refpurpose>Home Manager configuration specification</refpurpose>
  </refnamediv>
-
  <refsection>
   <title>Description</title>
   <para>
-   The file <filename>~/.config/nixpkgs/home.nix</filename> contains
+   The file <filename>~/.config/nixpkgs/home.nix</filename> contains the
-   the declarative specification of your Home Manager configuration.
+   declarative specification of your Home Manager configuration. The command
-   The command <command>home-manager</command> takes this file and
+   <command>home-manager</command> takes this file and realises the user
-   realises the user environment configuration specified therein.
+   environment configuration specified therein.
   </para>
  </refsection>
-
  <refsection>
   <title>Options</title>
   <para>
@@ -31,4 +28,13 @@
   </para>
   <xi:include href="./generated/options-db.xml" xpointer="configuration-variable-list" />
  </refsection>
+ <refsection>
+   <title>See also</title>
+   <para>
+     <citerefentry>
+       <refentrytitle>home-manager</refentrytitle>
+       <manvolnum>1</manvolnum>
+     </citerefentry>
+   </para>
+ </refsection>
 </refentry>

doc/man-home-manager.xml

@@ -3,60 +3,86 @@
           xmlns:xi="http://www.w3.org/2001/XInclude">
  <refmeta>
   <refentrytitle><command>home-manager</command></refentrytitle>
-  <manvolnum>8</manvolnum>
+  <manvolnum>1</manvolnum>
   <refmiscinfo class="source">Home Manager</refmiscinfo>
 <!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> -->
  </refmeta>
-
  <refnamediv>
   <refname><command>home-manager</command></refname>
   <refpurpose>reconfigure a user environment</refpurpose>
  </refnamediv>
-
  <refsynopsisdiv>
   <cmdsynopsis>
-   <command>home-manager</command>
+   <command>home-manager</command> <group choice="req"> 
-    <group choice='req'>
+   <arg choice="plain">
-     <arg choice='plain'><option>help</option></arg>
+    <option>help</option>
-     <arg choice='plain'><option>build</option></arg>
+   </arg>
-     <arg choice='plain'><option>switch</option></arg>
+    
-     <arg choice='plain'><option>generations</option></arg>
+   <arg choice="plain">
-     <arg choice='plain'><option>remove-generations</option></arg>
+    <option>build</option>
-     <arg choice='plain'><option>packages</option></arg>
+   </arg>
-     <arg choice='plain'><option>news</option></arg>
+    
+   <arg choice="plain">
+    <option>switch</option>
+   </arg>
+    
+   <arg choice="plain">
+    <option>generations</option>
+   </arg>
+    
+   <arg choice="plain">
+    <option>remove-generations</option>
+   </arg>
+    
+   <arg choice="plain">
+    <option>packages</option>
+   </arg>
+    
+   <arg choice="plain">
+    <option>news</option>
+   </arg>
     </group>
   </cmdsynopsis>
  </refsynopsisdiv>
-
  <refsection>
   <title>Description</title>
   <para>
-   This command updates the user environment so that it corresponds to the configuration
+   This command updates the user environment so that it corresponds to the
-   specified in <filename>~/.config/nixpkgs/home.nix</filename>.
+   configuration specified in <filename>~/.config/nixpkgs/home.nix</filename>.
   </para>
  </refsection>
-
  <refsection>
   <title>Files</title>
   <variablelist>
    <varlistentry>
-    <term><filename>~/.local/share/home-manager/news-read-ids</filename></term>
+    <term>
+     <filename>~/.local/share/home-manager/news-read-ids</filename>
+    </term>
     <listitem>
      <para>
-      Identifiers of news items that have been shown. Can be deleted
+      Identifiers of news items that have been shown. Can be deleted to reset
-      to reset the read news indicator.
+      the read news indicator.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </refsection>
-
  <refsection>
   <title>Bugs</title>
   <para>
-   Please report any bugs on the <link
+   Please report any bugs on the
+   <link
    xlink:href="https://github.com/rycee/home-manager/issues">project
    issue tracker</link>.
   </para>
  </refsection>
+ <refsection>
+   <title>See also</title>
+   <para>
+     <citerefentry>
+       <refentrytitle>home-configuration.nix</refentrytitle>
+       <manvolnum>5</manvolnum>
+     </citerefentry>
+   </para>
+ </refsection>
 </refentry>

doc/man-pages.xml

@@ -3,12 +3,8 @@
            xmlns:xi="http://www.w3.org/2001/XInclude">
  <title>Home Manager Reference Pages</title>
  <info>
-  <author>
+  <author><personname>Home Manager contributors</personname></author>
-   <personname>Home Manager contributors</personname>
+  <copyright><year>2017–2019</year><holder>Home Manager contributors</holder>
-   <contrib>Author</contrib>
-  </author>
-  <copyright>
-   <year>2017-2018</year><holder>Home Manager contributors</holder>
   </copyright>
  </info>
  <xi:include href="man-configuration.xml" />

doc/manual.xml

@@ -9,12 +9,13 @@
  <preface>
   <title>Preface</title>
   <para>
-   This manual will eventually describes how to install, use, and
+   This manual will eventually describes how to install, use, and extend Home
-   extend Home Manager.
+   Manager.
   </para>
   <para>
    If you encounter problems or bugs then please report them on the
-   <link xlink:href="https://github.com/rycee/home-manager/issues">Home Manager issue tracker</link>.
+   <link xlink:href="https://github.com/rycee/home-manager/issues">Home Manager
+   issue tracker</link>.
   </para>
   <note>
    <para>
@@ -24,8 +25,10 @@
    </para>
   </note>
  </preface>
+ <xi:include href="installation.xml" />
  <appendix xml:id="ch-options">
   <title>Configuration Options</title>
   <xi:include href="./generated/options-db.xml" xpointer="configuration-variable-list" />
  </appendix>
+ <xi:include href="./release-notes/release-notes.xml" />
 </book>

doc/release-notes/release-notes.xml

@@ -0,0 +1,13 @@
+<appendix xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          version="5.0"
+          xml:id="ch-release-notes">
+ <title>Release Notes</title>
+ <para>
+  This section lists the release notes for stable versions of Home Manager and
+  the current unstable version.
+ </para>
+ <xi:include href="rl-1903.xml" />
+ <xi:include href="rl-1809.xml" />
+</appendix>

doc/release-notes/rl-1809.xml

@@ -0,0 +1,11 @@
+<section xmlns="http://docbook.org/ns/docbook"
+         xmlns:xlink="http://www.w3.org/1999/xlink"
+         xmlns:xi="http://www.w3.org/2001/XInclude"
+         version="5.0"
+         xml:id="sec-release-18.09">
+ <title>Release 18.09</title>
+
+ <para>
+  The 18.09 release branch became the stable branch in September, 2018.
+ </para>
+</section>

doc/release-notes/rl-1903.xml

@@ -0,0 +1,67 @@
+<section xmlns="http://docbook.org/ns/docbook"
+         xmlns:xlink="http://www.w3.org/1999/xlink"
+         xmlns:xi="http://www.w3.org/2001/XInclude"
+         version="5.0"
+         xml:id="sec-release-19.03">
+ <title>Release 19.03 (unstable)</title>
+
+ <para>
+  This is the current unstable branch and the information in this section is
+  therefore not final.
+ </para>
+
+ <para>
+  Scheduled released is March, 2019.
+ </para>
+
+ <section xmlns="http://docbook.org/ns/docbook"
+         xmlns:xlink="http://www.w3.org/1999/xlink"
+         xmlns:xi="http://www.w3.org/2001/XInclude"
+         version="5.0"
+         xml:id="sec-release-19.03-highlights">
+  <title>Highlights</title>
+
+  <para>
+   This release has the following notable changes:
+  </para>
+
+  <itemizedlist>
+   <listitem>
+    <para>
+     The <option>home.file.&lt;name?&gt;.source</option> now allows source
+     files to be hidden, that is, having a name starting with the
+     <literal>.</literal> 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
+<programlisting>
+home.file."my file".source = ./. + "/file with spaces!";
+</programlisting>
+    </para>
+   </listitem>
+  </itemizedlist>
+ </section>
+
+ <section xmlns="http://docbook.org/ns/docbook"
+         xmlns:xlink="http://www.w3.org/1999/xlink"
+         xmlns:xi="http://www.w3.org/2001/XInclude"
+         version="5.0"
+         xml:id="sec-release-19.03-state-version-changes">
+  <title>State Version Changes</title>
+
+  <para>
+   The state version in this release includes the changes below. These changes
+   are only active if the <option>home.stateVersion</option> option is set to
+   "19.03" or later.
+  </para>
+
+  <itemizedlist>
+   <listitem>
+    <para>
+     There is now an option <option>programs.beets.enable</option> that
+     defaults to <literal>false</literal>. Before the module would be active if
+     the <option>programs.beets.settings</option> option was non-empty.
+    </para>
+   </listitem>
+  </itemizedlist>
+ </section>
+</section>

home-manager/default.nix

@@ -12,11 +12,20 @@ let
 
 in
 
-pkgs.stdenv.mkDerivation {
+pkgs.runCommand
-  name = "home-manager";
+  "home-manager"
-
+  {
-  buildCommand = ''
+    preferLocalBuild = true;
-    install -v -D -m755 ${./home-manager} $out/bin/home-manager
+    allowSubstitutes = false;
+    meta = with pkgs.stdenv.lib; {
+      description = "A user environment configurator";
+      maintainers = [ maintainers.rycee ];
+      platforms = platforms.unix;
+      license = licenses.mit;
+    };
+  }
+  ''
+    install -v -D -m755  ${./home-manager} $out/bin/home-manager
 
     substituteInPlace $out/bin/home-manager \
       --subst-var-by bash "${pkgs.bash}" \
@@ -25,12 +34,4 @@ pkgs.stdenv.mkDerivation {
       --subst-var-by gnused "${pkgs.gnused}" \
       --subst-var-by less "${pkgs.less}" \
       --subst-var-by HOME_MANAGER_PATH '${pathStr}'
-  '';
+  ''
-
-  meta = with pkgs.stdenv.lib; {
-    description = "A user environment configurator";
-    maintainers = [ maintainers.rycee ];
-    platforms = platforms.unix;
-    license = licenses.mit;
-  };
-}

home-manager/home-manager

@@ -129,6 +129,17 @@ function presentNews() {
     fi
 }
 
+function doEdit() {
+    if [[ ! -v EDITOR || -z $EDITOR ]]; then
+        errorEcho "Please set the \$EDITOR environment variable"
+        return 1
+    fi
+
+    setConfigFile
+
+    exec "$EDITOR" "$HOME_MANAGER_CONFIG"
+}
+
 function doBuild() {
     if [[ ! -w . ]]; then
         errorEcho "Cannot run build in read-only directory";
@@ -354,6 +365,8 @@ function doHelp() {
     echo
     echo "  help         Print this help"
     echo
+    echo "  edit         Open the home configuration in \$EDITOR"
+    echo
     echo "  build        Build configuration into result directory"
     echo
     echo "  switch       Build and activate configuration"
@@ -430,6 +443,9 @@ cmd="$1"
 shift 1
 
 case "$cmd" in
+    edit)
+        doEdit
+        ;;
     build)
         doBuild
         ;;

home-manager/home-manager.nix

@@ -9,7 +9,7 @@ with pkgs.lib;
 
 let
 
-  env = import <home-manager/modules> {
+  env = import ../modules {
     configuration =
       if confAttr == ""
       then confPath

home-manager/install.nix

@@ -7,6 +7,23 @@ pkgs.runCommand
     preferLocalBuild = true;
     allowSubstitutes = false;
     shellHook = ''
+      confFile="''${XDG_CONFIG_HOME:-$HOME/.config}/nixpkgs/home.nix"
+
+      if [[ ! -e $confFile ]]; then
+        echo
+        echo "Creating initial Home Manager configuration..."
+
+        mkdir -p "$(dirname "$confFile")"
+        cat > $confFile <<EOF
+      { config, pkgs, ... }:
+
+      {
+        # Let Home Manager install and manage itself.
+        programs.home-manager.enable = true;
+      }
+      EOF
+      fi
+
       echo
       echo "Creating initial Home Manager generation..."
       echo
@@ -17,7 +34,7 @@ pkgs.runCommand
       All done! The home-manager tool should now be installed and you
       can edit
 
-          ''${XDG_CONFIG_HOME:-~/.config}/nixpkgs/home.nix
+          $confFile
 
       to configure Home Manager. Run 'man home-configuration.nix' to
       see all available options.

modules/default.nix

@@ -23,6 +23,9 @@ let
     modules =
       [ configuration ]
       ++ (import ./modules.nix { inherit check lib pkgs; });
+    specialArgs = {
+      modulesPath = builtins.toString ./.;
+    };
   };
 
   module = showWarnings (

modules/files.nix

@@ -14,6 +14,15 @@ let
     inherit homeDirectory lib pkgs;
   }).fileType;
 
+  sourceStorePath = file:
+    let
+      sourcePath = toString file.source;
+      sourceName = config.lib.strings.storeFileName (baseNameOf sourcePath);
+    in
+      if builtins.hasContext sourcePath
+      then file.source
+      else builtins.path { path = file.source; name = sourceName; };
+
   # A symbolic link whose target path matches this pattern will be
   # considered part of a Home Manager generation.
   homeFilePattern = "${builtins.storeDir}/*-home-manager-files/*";
@@ -36,20 +45,6 @@ in
   };
 
   config = {
-    assertions = [
-      (let
-        badFiles =
-          filter (f: hasPrefix "." (baseNameOf f))
-          (map (v: toString v.source)
-          (attrValues cfg));
-        badFilesStr = toString badFiles;
-      in
-        {
-          assertion = badFiles == [];
-          message = "Source file names must not start with '.': ${badFilesStr}";
-        })
-    ];
-
     # This verifies that the links we are about to create will not
     # overwrite an existing file.
     home.activation.checkLinkTargets = dag.entryBefore ["writeBoundary"] (
@@ -201,7 +196,7 @@ in
       ''
         declare -A changedFiles
       '' + concatMapStrings (v: ''
-        cmp --quiet "${v.source}" "${config.home.homeDirectory}/${v.target}" \
+        cmp --quiet "${sourceStorePath v}" "${homeDirectory}/${v.target}" \
           && changedFiles["${v.target}"]=0 \
           || changedFiles["${v.target}"]=1
       '') (filter (v: v.onChange != "") (attrValues cfg))
@@ -215,17 +210,16 @@ in
       '') (filter (v: v.onChange != "") (attrValues cfg))
     );
 
-    home-files = pkgs.stdenv.mkDerivation {
+    # Symlink directories and files that have the right execute bit.
-      name = "home-manager-files";
+    # Copy files that need their execute bit changed.
-
+    home-files = pkgs.runCommand
-      nativeBuildInputs = [ pkgs.xlibs.lndir ];
+      "home-manager-files"
-
+      {
-      preferLocalBuild = true;
+        nativeBuildInputs = [ pkgs.xlibs.lndir ];
-      allowSubstitutes = false;
+        preferLocalBuild = true;
-
+        allowSubstitutes = false;
-      # Symlink directories and files that have the right execute bit.
+      }
-      # Copy files that need their execute bit changed.
+      (''
-      buildCommand = ''
         mkdir -p $out
 
         function insertFile() {
@@ -277,14 +271,13 @@ in
         }
       '' + concatStrings (
         mapAttrsToList (n: v: ''
-          insertFile "${v.source}" \
+          insertFile "${sourceStorePath v}" \
                      "${v.target}" \
                      "${if v.executable == null
                         then "inherit"
                         else builtins.toString v.executable}" \
                      "${builtins.toString v.recursive}"
         '') cfg
-      );
+      ));
-    };
   };
 }

modules/home-environment.nix

@@ -139,9 +139,12 @@ in
     };
 
     home.keyboard = mkOption {
-      type = keyboardSubModule;
+      type = types.nullOr keyboardSubModule;
       default = {};
-      description = "Keyboard configuration.";
+      description = ''
+        Keyboard configuration. Set to <literal>null</literal> to
+        disable Home Manager keyboard management.
+      '';
     };
 
     home.sessionVariables = mkOption {
@@ -163,7 +166,7 @@ in
         Note, these variables may be set in any order so no session
         variable may have a runtime dependency on another session
         variable. In particular code like
-        <programlisting>
+        <programlisting language="nix">
           home.sessionVariables = {
             FOO = "Hello";
             BAR = "$FOO World!";
@@ -172,7 +175,7 @@ in
         may not work as expected. If you need to reference another
         session variable, then do so inside Nix instead. The above
         example then becomes
-        <programlisting>
+        <programlisting language="nix">
           home.sessionVariables = {
             FOO = "Hello";
             BAR = "''${config.home.sessionVariables.FOO} World!";
@@ -269,7 +272,11 @@ in
     home.username = mkDefault (builtins.getEnv "USER");
     home.homeDirectory = mkDefault (builtins.getEnv "HOME");
 
-    home.profileDirectory = cfg.homeDirectory + "/.nix-profile";
+    home.profileDirectory =
+      if config.submoduleSupport.enable
+        && config.submoduleSupport.externalPackageInstall
+      then config.home.path
+      else cfg.homeDirectory + "/.nix-profile";
 
     home.sessionVariables =
       let
@@ -307,9 +314,33 @@ in
     home.activation.writeBoundary = dag.entryAnywhere "";
 
     # Install packages to the user environment.
-    home.activation.installPackages = dag.entryAfter ["writeBoundary"] ''
+    #
-      $DRY_RUN_CMD nix-env -i ${cfg.path}
+    # Note, sometimes our target may not allow modification of the Nix
-    '';
+    # store and then we cannot rely on `nix-env -i`. This is the case,
+    # for example, if we are running as a NixOS module and building a
+    # virtual machine. Then we must instead rely on an external
+    # mechanism for installing packages, which in NixOS is provided by
+    # the `users.users.<name?>.packages` option. The activation
+    # command is still needed since some modules need to run their
+    # activation commands after the packages are guaranteed to be
+    # installed.
+    #
+    # In case the user has moved from a user-install of Home Manager
+    # to a submodule managed one we attempt to uninstall the
+    # `home-manager-path` package if it is installed.
+    home.activation.installPackages = dag.entryAfter ["writeBoundary"] (
+      if config.submoduleSupport.externalPackageInstall
+      then
+        ''
+          if nix-env -q | grep '^home-manager-path$'; then
+            $DRY_RUN_CMD nix-env -e home-manager-path
+          fi
+        ''
+      else
+        ''
+          $DRY_RUN_CMD nix-env -i ${cfg.path}
+        ''
+    );
 
     home.activationPackage =
       let
@@ -355,13 +386,13 @@ in
           ${activationCmds}
         '';
       in
-        pkgs.stdenv.mkDerivation {
+        pkgs.runCommand
-          name = "home-manager-generation";
+          "home-manager-generation"
-
+          {
-          preferLocalBuild = true;
+            preferLocalBuild = true;
-          allowSubstitutes = false;
+            allowSubstitutes = false;
-
+          }
-          buildCommand = ''
+          ''
             mkdir -p $out
 
             cp ${activationScript} $out/activate
@@ -374,7 +405,6 @@ in
 
             ${cfg.extraBuilderCommands}
           '';
-        };
 
     home.path = pkgs.buildEnv {
       name = "home-manager-path";

modules/lib/default.nix

@@ -16,5 +16,8 @@
         entryBefore = d.dagEntryBefore;
       };
 
+  strings = import ./strings.nix { inherit lib; };
+
   shell = import ./shell.nix { inherit lib; };
+  zsh = import ./zsh.nix { inherit lib; };
 }

modules/lib/file-type.nix

@@ -4,27 +4,7 @@ with lib;
 
 let
 
-  # Figures out a valid Nix store name for the given path.
+  stringsExtra = import ./strings.nix { inherit lib; };
-  storeFileName = path:
-    let
-      # All characters that are considered safe. Note "-" is not
-      # included to avoid "-" followed by digit being interpreted as a
-      # version.
-      safeChars =
-        [ "+" "." "_" "?" "=" ]
-        ++ lowerChars
-        ++ upperChars
-        ++ stringToCharacters "0123456789";
-
-      empties = l: genList (x: "") (length l);
-
-      unsafeInName = stringToCharacters (
-        replaceStrings safeChars (empties safeChars) path
-      );
-
-      safeName = replaceStrings unsafeInName (empties unsafeInName) path;
-    in
-      "home_file_" + safeName;
 
 in
 
@@ -113,7 +93,7 @@ in
         source = mkIf (config.text != null) (
           mkDefault (pkgs.writeTextFile {
             inherit (config) executable text;
-            name = storeFileName name;
+            name = stringsExtra.storeFileName name;
           })
         );
       };

modules/lib/strings.nix

@@ -0,0 +1,27 @@
+{ lib }:
+
+with lib;
+
+{
+  # Figures out a valid Nix store name for the given path.
+  storeFileName = path:
+    let
+      # All characters that are considered safe. Note "-" is not
+      # included to avoid "-" followed by digit being interpreted as a
+      # version.
+      safeChars =
+        [ "+" "." "_" "?" "=" ]
+        ++ lowerChars
+        ++ upperChars
+        ++ stringToCharacters "0123456789";
+
+      empties = l: genList (x: "") (length l);
+
+      unsafeInName = stringToCharacters (
+        replaceStrings safeChars (empties safeChars) path
+      );
+
+      safeName = replaceStrings unsafeInName (empties unsafeInName) path;
+    in
+      "hm_" + safeName;
+}

modules/lib/zsh.nix

@@ -0,0 +1,28 @@
+{ lib }:
+
+rec {
+  # Produces a Zsh shell like value
+  toZshValue = v: if builtins.isBool v then
+                    if v then "true" else "false"
+                  else if builtins.isString v then
+                    "\"${v}\""
+                  else if builtins.isList v then
+                    "(${lib.concatStringsSep " " (map toZshValue v)})"
+                  else "\"${toString v}\"";
+
+  # Produces a Zsh shell like definition statement
+  define = n: v: "${n}=${toZshValue v}";
+
+  # Given an attribute set containing shell variable names and their
+  # assignments, this function produces a string containing a definition
+  # statement for each set entry.
+  defineAll = vars: lib.concatStringsSep "\n" (lib.mapAttrsToList define vars);
+
+  # Produces a Zsh shell like export statement
+  export = n: v: "export ${define n v}";
+
+  # Given an attribute set containing shell variable names and their
+  # assignments, this function produces a string containing an export
+  # statement for each set entry.
+  exportAll = vars: lib.concatStringsSep "\n" (lib.mapAttrsToList export vars);
+}

modules/manual.nix

@@ -36,7 +36,7 @@ let
 
   manualHtmlRoot = "${homeManagerManual.manual}/share/doc/home-manager/index.html";
 
-  helpScript = pkgs.writeScriptBin "home-manager-help" ''
+  helpScript = pkgs.writeShellScriptBin "home-manager-help" ''
     #!${pkgs.bash}/bin/bash -e
 
     if [ -z "$BROWSER" ]; then

modules/misc/dconf.nix

@@ -0,0 +1,83 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+let
+
+  cfg = config.dconf;
+  dag = config.lib.dag;
+
+  toDconfIni = generators.toINI { mkKeyValue = mkIniKeyValue; };
+
+  mkIniKeyValue = key: value:
+    let
+      tweakVal = v:
+        if isString v then "'${v}'"
+        else if isList v then "[" + concatMapStringsSep "," tweakVal v + "]"
+        else if isBool v then (if v then "true" else "false")
+        else toString v;
+    in
+      "${key}=${tweakVal value}";
+
+  primitive = with types; either bool (either int str);
+
+in
+
+{
+  meta.maintainers = [ maintainers.gnidorah maintainers.rycee ];
+
+  options = {
+    dconf = {
+      enable = mkOption {
+        type = types.bool;
+        default = true;
+        visible = false;
+        description = ''
+          Whether to enable dconf settings.
+        '';
+      };
+
+      settings = mkOption {
+        type = with types;
+          attrsOf (attrsOf (either primitive (listOf primitive)));
+        default = {};
+        example = literalExample ''
+          {
+            "org/gnome/calculator" = {
+              button-mode = "programming";
+              show-thousands = true;
+              base = 10;
+              word-size = 64;
+            };
+          }
+        '';
+        description = ''
+          Settings to write to the dconf configuration system.
+        '';
+      };
+    };
+  };
+
+  config = mkIf (cfg.enable && cfg.settings != {}) {
+    home.activation.dconfSettings = dag.entryAfter ["installPackages"] (
+      let
+        iniFile = pkgs.writeText "hm-dconf.ini" (toDconfIni cfg.settings);
+      in
+        ''
+          if [[ -v DBUS_SESSION_BUS_ADDRESS ]]; then
+            DCONF_DBUS_RUN_SESSION=""
+          else
+            DCONF_DBUS_RUN_SESSION="${pkgs.dbus}/bin/dbus-run-session"
+          fi
+
+          if [[ -v DRY_RUN ]]; then
+            echo $DCONF_DBUS_RUN_SESSION ${pkgs.gnome3.dconf}/bin/dconf load / "<" ${iniFile}
+          else
+            $DCONF_DBUS_RUN_SESSION ${pkgs.gnome3.dconf}/bin/dconf load / < ${iniFile}
+          fi
+
+          unset DCONF_DBUS_RUN_SESSION
+        ''
+    );
+  };
+}

modules/misc/gtk.nix

@@ -8,8 +8,6 @@ let
   cfg2 = config.gtk.gtk2;
   cfg3 = config.gtk.gtk3;
 
-  dag = config.lib.dag;
-
   toGtk3Ini = generators.toINI {
     mkKeyValue = key: value:
       let
@@ -29,16 +27,6 @@ let
     in
       "${n} = ${v'}";
 
-  toDconfIni = generators.toINI {
-    mkKeyValue = key: value:
-      let
-        tweakVal = v:
-          if isString v then "'${v}'"
-          else toString v;
-      in
-        "${key}=${tweakVal value}";
-  };
-
   fontType = types.submodule {
     options = {
       package = mkOption {
@@ -88,6 +76,12 @@ in
 {
   meta.maintainers = [ maintainers.rycee ];
 
+  imports = [
+    (mkRemovedOptionModule ["gtk" "gtk3" "waylandSupport"] ''
+      This options is not longer needed and can be removed.
+    '')
+  ];
+
   options = {
     gtk = {
       enable = mkEnableOption "GTK 2/3 configuration";
@@ -112,63 +106,36 @@ in
         description = "The GTK+2/3 theme to use.";
       };
 
-      gtk2 = mkOption {
+      gtk2 = {
-        description = "Options specific to GTK+ 2";
+        extraConfig = mkOption {
-        default = {};
+          type = types.lines;
-        type = types.submodule {
+          default = "";
-          options = {
+          example = "gtk-can-change-accels = 1";
-            extraConfig = mkOption {
+          description = ''
-              type = types.lines;
+            Extra configuration lines to add verbatim to
-              default = "";
+            <filename>~/.gtkrc-2.0</filename>.
-              example = "gtk-can-change-accels = 1";
+          '';
-              description = ''
-                Extra configuration lines to add verbatim to
-                <filename>~/.gtkrc-2.0</filename>.
-              '';
-            };
-          };
         };
       };
 
-      gtk3 = mkOption {
+      gtk3 = {
-        description = "Options specific to GTK+ 3";
+        extraConfig = mkOption {
-        default = {};
+          type = types.attrs;
-        type = types.submodule {
+          default = {};
-          options = {
+          example = { gtk-cursor-blink = false; gtk-recent-files-limit = 20; };
-            extraConfig = mkOption {
+          description = ''
-              type = types.attrs;
+            Extra configuration options to add to
-              default = {};
+            <filename>~/.config/gtk-3.0/settings.ini</filename>.
-              example = { gtk-cursor-blink = false; gtk-recent-files-limit = 20; };
+          '';
-              description = ''
+        };
-                Extra configuration options to add to
-                <filename>~/.config/gtk-3.0/settings.ini</filename>.
-              '';
-            };
 
-            extraCss = mkOption {
+        extraCss = mkOption {
-              type = types.lines;
+          type = types.lines;
-              default = "";
+          default = "";
-              description = ''
+          description = ''
-                Extra configuration lines to add verbatim to
+            Extra configuration lines to add verbatim to
-                <filename>~/.config/gtk-3.0/gtk.css</filename>.
+            <filename>~/.config/gtk-3.0/gtk.css</filename>.
-              '';
+          '';
-            };
-
-            waylandSupport = mkOption {
-              type = types.bool;
-              default = false;
-              description = ''
-                Support GSettings provider (dconf) in addition to
-                GtkSettings (INI file). This is needed for Wayland.
-                </para><para>
-                Note, on NixOS the following line must be in the
-                system configuration:
-                <programlisting>
-                services.dbus.packages = [ pkgs.gnome3.dconf ];
-                </programlisting>
-              '';
-            };
-          };
         };
       };
     };
@@ -200,7 +167,6 @@ in
         optional (opt != null && opt.package != null) opt.package;
     in
       {
-
         home.packages =
           optionalPackage cfg.font
           ++ optionalPackage cfg.theme
@@ -216,22 +182,7 @@ in
 
         xdg.configFile."gtk-3.0/gtk.css".text = cfg3.extraCss;
 
-        home.activation = mkIf cfg3.waylandSupport {
+        dconf.settings."org/gnome/desktop/interface" = dconfIni;
-          gtk3 = dag.entryAfter ["installPackages"] (
-            let
-              iniText = toDconfIni { "/" = dconfIni; };
-              iniFile = pkgs.writeText "gtk3.ini" iniText;
-              dconfPath = "/org/gnome/desktop/interface/";
-            in
-              ''
-                if [[ -v DRY_RUN ]]; then
-                  echo ${pkgs.gnome3.dconf}/bin/dconf load ${dconfPath} "<" ${iniFile}
-                else
-                  ${pkgs.gnome3.dconf}/bin/dconf load ${dconfPath} < ${iniFile}
-                fi
-              ''
-          );
-        };
       }
     );
 }

modules/misc/news.nix

@@ -6,6 +6,8 @@ let
 
   cfg = config.news;
 
+  hostPlatform = pkgs.stdenv.hostPlatform;
+
   entryModule = types.submodule ({ config, ... }: {
     options = {
       id = mkOption {
@@ -734,7 +736,7 @@ in
 
       {
         time = "2018-08-19T20:46:09+00:00";
-        condition = pkgs.stdenv.isLinux;
+        condition = hostPlatform.isLinux;
         message = ''
           A new modules is available: 'programs.chromium'.
         '';
@@ -871,6 +873,130 @@ in
           A new module is available: 'services.nextcloud-client'.
         '';
       }
+
+      {
+        time = "2018-12-04T21:54:38+00:00";
+        condition = config.programs.beets.settings != {};
+        message = ''
+          A new option 'programs.beets.enable' has been added.
+          Starting with state version 19.03 this option defaults to
+          false. For earlier versions it defaults to true if
+          'programs.beets.settings' is non-empty.
+
+          It is recommended to explicitly add
+
+              programs.beets.enable = true;
+
+          to your configuration.
+        '';
+      }
+
+      {
+        time = "2018-12-12T21:02:05+00:00";
+        message = ''
+          A new module is available: 'programs.jq'.
+        '';
+      }
+
+      {
+        time = "2019-01-07T17:35:19+00:00";
+        message = ''
+          A new module is available: 'programs.vscode'.
+        '';
+      }
+
+      {
+        time = "2019-01-14T17:37:23+00:00";
+        message = ''
+          A new module is available: 'dconf'.
+
+          Note, on NixOS you may need to add
+
+              services.dbus.packages = with pkgs; [ gnome3.dconf ];
+
+          to the system configuration for this module to work as
+          expected. In particular if you get the error message
+
+              The name ca.desrt.dconf was not provided by any .service files
+
+          when activating your Home Manager configuration.
+        '';
+      }
+
+      {
+        time = "2018-12-28T12:32:30+00:00";
+        message = ''
+          A new module is available: 'programs.opam'.
+        '';
+      }
+
+      {
+        time = "2019-01-18T00:21:56+00:00";
+        message = ''
+          A new module is available: 'programs.matplotlib'.
+        '';
+      }
+
+      {
+        time = "2019-01-26T13:20:37+00:00";
+        condition = hostPlatform.isLinux;
+        message = ''
+          A new module is available: 'services.xembed-sni-proxy'.
+        '';
+      }
+
+      {
+        time = "2019-01-28T23:36:10+00:00";
+        message = ''
+          A new module is available: 'programs.irssi'.
+        '';
+      }
+
+      {
+        time = "2019-02-09T14:09:58+00:00";
+        condition = hostPlatform.isLinux;
+        message = ''
+          A new module is available: 'services.emacs'.
+
+          This module provides a user service that runs the Emacs
+          configured in
+
+              programs.emacs
+
+          as an Emacs daemon.
+        '';
+      }
+
+      {
+        time = "2019-02-16T20:33:56+00:00";
+        condition = hostPlatform.isLinux;
+        message = ''
+          When using Home Manager as a NixOS submodule it is now
+          possible to install packages using the NixOS
+
+              users.users.<name?>.packages
+
+          option. This is enabled by adding
+
+              home-manager.useUserPackages = true;
+
+          to your NixOS system configuration. This mode of operation
+          is necessary if you want to use 'nixos-rebuild build-vm'.
+        '';
+      }
+
+      {
+        time = "2019-04-23T19:15:07+00:00";
+        message = ''
+          As of May 1, 2019 the release-18.09 branch of Home Manager
+          will no longer be supported. You are encouraged to switch to
+          the release-19.03 branch as soon as possible.
+
+          Some brief notes about the 19.03 branch is available at
+
+            https://rycee.gitlab.io/home-manager/release-notes.html#sec-release-19.03
+        '';
+      }
     ];
   };
 }

modules/misc/nixpkgs.nix

@@ -80,7 +80,7 @@ in
         inside and outside Home Manager you can put it in a separate
         file and include something like
 
-        <programlisting>
+        <programlisting language="nix">
           nixpkgs.config = import ./nixpkgs-config.nix;
           xdg.configFile."nixpkgs/config.nix".source =
               ./nixpkgs-config.nix;
@@ -144,7 +144,10 @@ in
   config = {
     _module.args = {
       pkgs = _pkgs;
-      pkgs_i686 = if _pkgs.stdenv.isLinux then _pkgs.pkgsi686Linux else {};
+      pkgs_i686 =
+        if _pkgs.stdenv.isLinux && _pkgs.stdenv.hostPlatform.isx86
+        then _pkgs.pkgsi686Linux
+        else { };
     };
   };
 }

modules/misc/pam.nix

@@ -30,7 +30,7 @@ in
   config = mkIf (vars != {}) {
     home.file.".pam_environment".text =
       concatStringsSep "\n" (
-        mapAttrsToList (n: v: "${n} OVERRIDE=${toString v}") vars
+        mapAttrsToList (n: v: "${n} OVERRIDE=\"${toString v}\"") vars
       ) + "\n";
   };
 }

modules/misc/qt.nix

@@ -35,7 +35,7 @@ in
 
     home.activation.useGtkThemeInQt4 = dag.entryAfter ["writeBoundary"] ''
       $DRY_RUN_CMD ${pkgs.crudini}/bin/crudini $VERBOSE_ARG \
-        --set $HOME/.config/Trolltech.conf Qt style GTK+
+        --set "${config.xdg.configHome}/Trolltech.conf" Qt style GTK+
     '';
   };
 }

modules/misc/submodule-support.nix

@@ -0,0 +1,32 @@
+{ lib, ... }:
+
+with lib;
+
+{
+  meta.maintainers = [ maintainers.rycee ];
+
+  options.submoduleSupport = {
+    enable = mkOption {
+      type = types.bool;
+      default = false;
+      internal = true;
+      description = ''
+        Whether the Home Manager module system is used as a submodule
+        in, for example, NixOS or nix-darwin.
+      '';
+    };
+
+    externalPackageInstall = mkOption {
+      type = types.bool;
+      default = false;
+      internal = true;
+      description = ''
+        Whether the packages of <option>home.packages</option> are
+        installed separately from the Home Manager activation script.
+        In NixOS, for example, this may be accomplished by installing
+        the packages through
+        <option>users.users.&lt;name?&gt;.packages</option>.
+      '';
+    };
+  };
+}

modules/modules.nix

@@ -3,126 +3,134 @@
 
   # Whether to enable module type checking.
 , check ? true
-
-  # Whether these modules are inside a NixOS submodule.
-, nixosSubmodule ? false
 }:
 
 with lib;
 
 let
 
-  modules = [
+  hostPlatform = pkgs.stdenv.hostPlatform;
-    ./accounts/email.nix
+
-    ./files.nix
+  checkPlatform = any (meta.platformMatch pkgs.stdenv.hostPlatform);
-    ./home-environment.nix
+
-    ./manual.nix
+  loadModule = file: { condition ? true }: {
-    ./misc/fontconfig.nix
+    inherit file condition;
-    ./misc/gtk.nix
+  };
-    ./misc/lib.nix
+
-    ./misc/news.nix
+  allModules = [
-    ./misc/nixpkgs.nix
+    (loadModule ./accounts/email.nix { })
-    ./misc/pam.nix
+    (loadModule ./files.nix { })
-    ./misc/qt.nix
+    (loadModule ./home-environment.nix { })
-    ./misc/version.nix
+    (loadModule ./manual.nix { })
-    ./misc/xdg.nix
+    (loadModule ./misc/dconf.nix { })
-    ./programs/afew.nix
+    (loadModule ./misc/fontconfig.nix { })
-    ./programs/alot.nix
+    (loadModule ./misc/gtk.nix { })
-    ./programs/astroid.nix
+    (loadModule ./misc/lib.nix { })
-    ./programs/autorandr.nix
+    (loadModule ./misc/news.nix { })
-    ./programs/bash.nix
+    (loadModule ./misc/nixpkgs.nix { })
-    ./programs/beets.nix
+    (loadModule ./misc/pam.nix { })
-    ./programs/browserpass.nix
+    (loadModule ./misc/qt.nix { })
-    ./programs/command-not-found/command-not-found.nix
+    (loadModule ./misc/submodule-support.nix { })
-    ./programs/direnv.nix
+    (loadModule ./misc/version.nix { })
-    ./programs/eclipse.nix
+    (loadModule ./misc/xdg.nix { })
-    ./programs/emacs.nix
+    (loadModule ./programs/afew.nix { })
-    ./programs/feh.nix
+    (loadModule ./programs/alot.nix { })
-    ./programs/firefox.nix
+    (loadModule ./programs/astroid.nix { })
-    ./programs/fish.nix
+    (loadModule ./programs/autorandr.nix { })
-    ./programs/fzf.nix
+    (loadModule ./programs/bash.nix { })
-    ./programs/git.nix
+    (loadModule ./programs/beets.nix { })
-    ./programs/gnome-terminal.nix
+    (loadModule ./programs/browserpass.nix { })
-    ./programs/go.nix
+    (loadModule ./programs/chromium.nix { condition = hostPlatform.isLinux; })
-    ./programs/home-manager.nix
+    (loadModule ./programs/command-not-found/command-not-found.nix { })
-    ./programs/htop.nix
+    (loadModule ./programs/direnv.nix { })
-    ./programs/info.nix
+    (loadModule ./programs/eclipse.nix { })
-    ./programs/lesspipe.nix
+    (loadModule ./programs/emacs.nix { })
-    ./programs/man.nix
+    (loadModule ./programs/feh.nix { })
-    ./programs/mbsync.nix
+    (loadModule ./programs/firefox.nix { })
-    ./programs/mercurial.nix
+    (loadModule ./programs/fish.nix { })
-    ./programs/msmtp.nix
+    (loadModule ./programs/fzf.nix { })
-    ./programs/neovim.nix
+    (loadModule ./programs/git.nix { })
-    ./programs/newsboat.nix
+    (loadModule ./programs/gnome-terminal.nix { })
-    ./programs/noti.nix
+    (loadModule ./programs/go.nix { })
-    ./programs/notmuch.nix
+    (loadModule ./programs/home-manager.nix { })
-    ./programs/obs-studio.nix
+    (loadModule ./programs/htop.nix { })
-    ./programs/offlineimap.nix
+    (loadModule ./programs/info.nix { })
-    ./programs/pidgin.nix
+    (loadModule ./programs/irssi.nix { })
-    ./programs/rofi.nix
+    (loadModule ./programs/jq.nix { })
-    ./programs/ssh.nix
+    (loadModule ./programs/lesspipe.nix { })
-    ./programs/taskwarrior.nix
+    (loadModule ./programs/man.nix { })
-    ./programs/termite.nix
+    (loadModule ./programs/matplotlib.nix { })
-    ./programs/texlive.nix
+    (loadModule ./programs/mbsync.nix { })
-    ./programs/tmux.nix
+    (loadModule ./programs/mercurial.nix { })
-    ./programs/urxvt.nix
+    (loadModule ./programs/msmtp.nix { })
-    ./programs/vim.nix
+    (loadModule ./programs/neovim.nix { })
-    ./programs/zathura.nix
+    (loadModule ./programs/newsboat.nix { })
-    ./programs/zsh.nix
+    (loadModule ./programs/noti.nix { })
-    ./services/blueman-applet.nix
+    (loadModule ./programs/notmuch.nix { })
-    ./services/compton.nix
+    (loadModule ./programs/obs-studio.nix { })
-    ./services/dunst.nix
+    (loadModule ./programs/offlineimap.nix { })
-    ./services/flameshot.nix
+    (loadModule ./programs/opam.nix { })
-    ./services/gnome-keyring.nix
+    (loadModule ./programs/pidgin.nix { })
-    ./services/gpg-agent.nix
+    (loadModule ./programs/rofi.nix { })
-    ./services/kbfs.nix
+    (loadModule ./programs/ssh.nix { })
-    ./services/kdeconnect.nix
+    (loadModule ./programs/taskwarrior.nix { })
-    ./services/keepassx.nix
+    (loadModule ./programs/termite.nix { })
-    ./services/keybase.nix
+    (loadModule ./programs/texlive.nix { })
-    ./services/mbsync.nix
+    (loadModule ./programs/tmux.nix { })
-    ./services/mpd.nix
+    (loadModule ./programs/urxvt.nix { })
-    ./services/network-manager-applet.nix
+    (loadModule ./programs/vim.nix { })
-    ./services/nextcloud-client.nix
+    (loadModule ./programs/vscode.nix { })
-    ./services/owncloud-client.nix
+    (loadModule ./programs/zathura.nix { })
-    ./services/parcellite.nix
+    (loadModule ./programs/zsh.nix { })
-    ./services/pasystray.nix
+    (loadModule ./services/blueman-applet.nix { })
-    ./services/polybar.nix
+    (loadModule ./services/compton.nix { })
-    ./services/random-background.nix
+    (loadModule ./services/dunst.nix { })
-    ./services/redshift.nix
+    (loadModule ./services/emacs.nix { condition = hostPlatform.isLinux; })
-    ./services/screen-locker.nix
+    (loadModule ./services/flameshot.nix { })
-    ./services/stalonetray.nix
+    (loadModule ./services/gnome-keyring.nix { })
-    ./services/status-notifier-watcher.nix
+    (loadModule ./services/gpg-agent.nix { })
-    ./services/syncthing.nix
+    (loadModule ./services/kbfs.nix { })
-    ./services/taffybar.nix
+    (loadModule ./services/kdeconnect.nix { })
-    ./services/tahoe-lafs.nix
+    (loadModule ./services/keepassx.nix { })
-    ./services/udiskie.nix
+    (loadModule ./services/keybase.nix { })
-    ./services/unclutter.nix
+    (loadModule ./services/mbsync.nix { })
-    ./services/window-managers/awesome.nix
+    (loadModule ./services/mpd.nix { })
-    ./services/window-managers/i3.nix
+    (loadModule ./services/network-manager-applet.nix { })
-    ./services/window-managers/xmonad.nix
+    (loadModule ./services/nextcloud-client.nix { })
-    ./services/xscreensaver.nix
+    (loadModule ./services/owncloud-client.nix { })
-    ./systemd.nix
+    (loadModule ./services/parcellite.nix { })
-    ./xcursor.nix
+    (loadModule ./services/pasystray.nix { })
-    ./xresources.nix
+    (loadModule ./services/polybar.nix { })
-    ./xsession.nix
+    (loadModule ./services/random-background.nix { })
-    <nixpkgs/nixos/modules/misc/assertions.nix>
+    (loadModule ./services/redshift.nix { })
-    <nixpkgs/nixos/modules/misc/meta.nix>
+    (loadModule ./services/screen-locker.nix { })
-  ]
+    (loadModule ./services/stalonetray.nix { })
-  ++
+    (loadModule ./services/status-notifier-watcher.nix { })
-  optional pkgs.stdenv.isLinux ./programs/chromium.nix;
+    (loadModule ./services/syncthing.nix { })
+    (loadModule ./services/taffybar.nix { })
+    (loadModule ./services/tahoe-lafs.nix { })
+    (loadModule ./services/udiskie.nix { })
+    (loadModule ./services/unclutter.nix { })
+    (loadModule ./services/window-managers/awesome.nix { })
+    (loadModule ./services/window-managers/i3.nix { })
+    (loadModule ./services/window-managers/xmonad.nix { })
+    (loadModule ./services/xembed-sni-proxy.nix { condition = hostPlatform.isLinux; })
+    (loadModule ./services/xscreensaver.nix { })
+    (loadModule ./systemd.nix { })
+    (loadModule ./xcursor.nix { })
+    (loadModule ./xresources.nix { })
+    (loadModule ./xsession.nix { })
+    (loadModule <nixpkgs/nixos/modules/misc/assertions.nix> { })
+    (loadModule <nixpkgs/nixos/modules/misc/meta.nix> { })
+  ];
+
+  modules = map (getAttr "file") (filter (getAttr "condition") allModules);
 
   pkgsModule = {
-    options.nixosSubmodule = mkOption {
-      type = types.bool;
-      internal = true;
-      readOnly = true;
-    };
-
     config._module.args.baseModules = modules;
     config._module.args.pkgs = lib.mkDefault pkgs;
     config._module.check = check;
     config.lib = import ./lib { inherit lib; };
-    config.nixosSubmodule = nixosSubmodule;
     config.nixpkgs.system = mkDefault pkgs.system;
   };
 

modules/programs/autorandr.nix

@@ -6,10 +6,25 @@ let
 
   cfg = config.programs.autorandr;
 
+  matrixOf = n: m: elemType: mkOptionType rec {
+    name = "matrixOf";
+    description = "${toString n}×${toString m} matrix of ${elemType.description}s";
+    check = xss:
+      let
+        listOfSize = l: xs: isList xs && length xs == l;
+      in
+        listOfSize n xss && all (xs: listOfSize m xs && all elemType.check xs) xss;
+    merge = mergeOneOption;
+    getSubOptions = prefix: elemType.getSubOptions (prefix ++ ["*" "*"]);
+    getSubModules = elemType.getSubModules;
+    substSubModules = mod: matrixOf n m (elemType.substSubModules mod);
+    functor = (defaultFunctor name) // { wrapped = elemType; };
+  };
+
   profileModule = types.submodule {
     options = {
       fingerprint = mkOption {
-        type = types.attrsOf types.string;
+        type = types.attrsOf types.str;
         description = ''
           Output name to EDID mapping.
           Use <code>autorandr --fingerprint</code> to get current setup values.
@@ -46,28 +61,28 @@ let
       };
 
       position = mkOption {
-        type = types.string;
+        type = types.str;
         description = "Output position";
         default = "";
         example = "5760x0";
       };
 
       mode = mkOption {
-        type = types.string;
+        type = types.str;
         description = "Output resolution.";
         default = "";
         example = "3840x2160";
       };
 
       rate = mkOption {
-        type = types.string;
+        type = types.str;
         description = "Output framerate.";
         default = "";
         example = "60.00";
       };
 
       gamma = mkOption {
-        type = types.string;
+        type = types.str;
         description = "Output gamma configuration.";
         default = "";
         example = "1.0:0.909:0.833";
@@ -79,6 +94,26 @@ let
         default = null;
         example = "left";
       };
+
+      transform = mkOption {
+        type = types.nullOr (matrixOf 3 3 types.float);
+        default = null;
+        example = literalExample ''
+          [
+            [ 0.6 0.0 0.0 ]
+            [ 0.0 0.6 0.0 ]
+            [ 0.0 0.0 1.0 ]
+          ]
+        '';
+        description = ''
+          Refer to
+          <citerefentry>
+            <refentrytitle>xrandr</refentrytitle>
+            <manvolnum>1</manvolnum>
+          </citerefentry>
+          for the documentation of the transform matrix.
+        '';
+      };
     };
   };
 
@@ -150,6 +185,9 @@ let
     ${optionalString (config.mode != "") "mode ${config.mode}"}
     ${optionalString (config.rate != "") "rate ${config.rate}"}
     ${optionalString (config.rotate != null) "rotate ${config.rotate}"}
+    ${optionalString (config.transform != null) (
+      "transform " + concatMapStringsSep "," toString (flatten config.transform)
+    )}
   '' else ''
     output ${name}
     off

modules/programs/beets.nix

@@ -13,6 +13,21 @@ in
 
   options = {
     programs.beets = {
+      enable = mkOption {
+        type = types.bool;
+        default =
+          if versionAtLeast config.home.stateVersion "19.03"
+          then false
+          else cfg.settings != {};
+        defaultText = "false";
+        description = ''
+          Whether to enable the beets music library manager. This
+          defaults to <literal>false</literal> for state
+          version ≥ 19.03. For earlier versions beets is enabled if
+          <option>programs.beets.settings</option> is non-empty.
+        '';
+      };
+
       settings = mkOption {
         type = types.attrs;
         default = {};
@@ -24,7 +39,7 @@ in
     };
   };
 
-  config = mkIf (cfg.settings != {}) {
+  config = mkIf cfg.enable {
     home.packages = [ pkgs.beets ];
 
     xdg.configFile."beets/config.yaml".text =

modules/programs/browserpass.nix

@@ -31,11 +31,11 @@ in {
           else ".config/google-chrome/NativeMessagingHosts";
         in [
           {
-            target = "${dir}/com.dannyvankooten.browserpass.json";
+            target = "${dir}/com.github.browserpass.native.json";
             source = "${pkgs.browserpass}/etc/chrome-host.json";
           }
           {
-            target = "${dir}/../policies/managed/com.dannyvankooten.browserpass.json";
+            target = "${dir}/../policies/managed/com.github.browserpass.native.json";
             source = "${pkgs.browserpass}/etc/chrome-policy.json";
           }
         ]
@@ -45,11 +45,11 @@ in {
           else ".config/chromium/NativeMessagingHosts";
         in [
           {
-            target = "${dir}/com.dannyvankooten.browserpass.json";
+            target = "${dir}/com.github.browserpass.native.json";
             source = "${pkgs.browserpass}/etc/chrome-host.json";
           }
           {
-            target = "${dir}/../policies/managed/com.dannyvankooten.browserpass.json";
+            target = "${dir}/../policies/managed/com.github.browserpass.native.json";
             source = "${pkgs.browserpass}/etc/chrome-policy.json";
           }
         ]
@@ -58,8 +58,8 @@ in {
           target = (if isDarwin
             then "Library/Application Support/Mozilla/NativeMessagingHosts"
             else ".mozilla/native-messaging-hosts")
-            + "/com.dannyvankooten.browserpass.json";
+            + "/com.github.browserpass.native.json";
-          source = "${pkgs.browserpass}/lib/mozilla/native-messaging-hosts/com.dannyvankooten.browserpass.json";
+          source = "${pkgs.browserpass}/lib/mozilla/native-messaging-hosts/com.github.browserpass.native.json";
         } ]
       else if x == "vivaldi" then
         let dir = if isDarwin
@@ -67,11 +67,11 @@ in {
           else ".config/vivaldi/NativeMessagingHosts";
         in [
           {
-            target = "${dir}/com.dannyvankooten.browserpass.json";
+            target = "${dir}/com.github.browserpass.native.json";
             source = "${pkgs.browserpass}/etc/chrome-host.json";
           }
           {
-            target = "${dir}/../policies/managed/com.dannyvankooten.browserpass.json";
+            target = "${dir}/../policies/managed/com.github.browserpass.native.json";
             source = "${pkgs.browserpass}/etc/chrome-policy.json";
           }
         ]

modules/programs/emacs.nix

@@ -6,8 +6,13 @@ let
 
   cfg = config.programs.emacs;
 
-  # Copied from all-packages.nix.
+  # Copied from all-packages.nix, with modifications to support
-  emacsPackages = pkgs.emacsPackagesNgGen cfg.package;
+  # overrides.
+  emacsPackages =
+    let
+      epkgs = pkgs.emacsPackagesNgGen cfg.package;
+    in
+      epkgs.overrideScope' cfg.overrides;
   emacsWithPackages = emacsPackages.emacsWithPackages;
 
 in
@@ -34,18 +39,33 @@ in
         description = "Extra packages available to Emacs.";
       };
 
+      overrides = mkOption {
+        default = self: super: {};
+        defaultText = "self: super: {}";
+        example = literalExample ''
+          self: super: rec {
+            haskell-mode = self.melpaPackages.haskell-mode;
+            # ...
+          };
+        '';
+        description = ''
+          Allows overriding packages within the Emacs package set.
+        '';
+      };
+
       finalPackage = mkOption {
         type = types.package;
-        internal = true;
+        visible = false;
         readOnly = true;
-        description = "The Emacs package including any extra packages.";
+        description = ''
+          The Emacs package including any overrides and extra packages.
+        '';
       };
     };
   };
 
   config = mkIf cfg.enable {
     home.packages = [ cfg.finalPackage ];
-
     programs.emacs.finalPackage = emacsWithPackages cfg.extraPackages;
   };
 }

modules/programs/firefox.nix

@@ -6,6 +6,8 @@ let
 
   cfg = config.programs.firefox;
 
+  extensionPath = "extensions/{ec8030f7-c20a-464f-9b0e-13a3a9e97384}";
+
 in
 
 {
@@ -22,6 +24,22 @@ in
         description = "The unwrapped Firefox package to use.";
       };
 
+      extensions = mkOption {
+        type = types.listOf types.package;
+        default = [];
+        example = literalExample ''
+          with pkgs.nur.repos.rycee.firefox-addons; [
+            https-everywhere
+            privacy-badger
+          ]
+        '';
+        description = ''
+          List of Firefox add-on packages to install. Note, it is
+          necessary to manually enable these extensions inside Firefox
+          after the first installation.
+        '';
+      };
+
       enableAdobeFlash = mkOption {
         type = types.bool;
         default = false;
@@ -60,5 +78,18 @@ in
         };
       in
         [ (wrapper cfg.package { }) ];
+
+    home.file.".mozilla/${extensionPath}" = mkIf (cfg.extensions != []) (
+      let
+        extensionsEnv = pkgs.buildEnv {
+          name = "hm-firefox-extensions";
+          paths = cfg.extensions;
+        };
+      in
+        {
+          source = "${extensionsEnv}/share/mozilla/${extensionPath}";
+          recursive = true;
+        }
+    );
   };
 }

modules/programs/fish.nix

@@ -21,6 +21,15 @@ in
     programs.fish = {
       enable = mkEnableOption "fish friendly interactive shell";
 
+      package = mkOption {
+        default = pkgs.fish;
+        defaultText = "pkgs.fish";
+        description = ''
+          The fish package to install. May be used to change the version.
+        '';
+        type = types.package;
+      };
+
       shellAliases = mkOption {
         default = {};
         description = ''
@@ -74,7 +83,70 @@ in
   };
 
   config = mkIf cfg.enable {
-    home.packages = [ pkgs.fish ];
+    home.packages = [ cfg.package ];
+
+    xdg.dataFile."fish/home-manager_generated_completions".source =
+      let
+        # paths later in the list will overwrite those already linked
+        destructiveSymlinkJoin =
+          args_@{ name
+              , paths
+              , preferLocalBuild ? true
+              , allowSubstitutes ? false
+              , postBuild ? ""
+              , ...
+              }:
+          let
+            args = removeAttrs args_ [ "name" "postBuild" ]
+              // { inherit preferLocalBuild allowSubstitutes; }; # pass the defaults
+          in pkgs.runCommand name args
+            ''
+              mkdir -p $out
+              for i in $paths; do
+                if [ -z "$(find $i -prune -empty)" ]; then
+                  cp -srf $i/* $out
+                fi
+              done
+              ${postBuild}
+            '';
+        generateCompletions = package: pkgs.runCommand
+          "${package.name}-fish-completions"
+          {
+            src = package;
+            nativeBuildInputs = [ pkgs.python2 ];
+            buildInputs = [ cfg.package ];
+            preferLocalBuild = true;
+            allowSubstitutes = false;
+          }
+          ''
+            mkdir -p $out
+            if [ -d $src/share/man ]; then
+              find $src/share/man -type f \
+                | xargs python ${cfg.package}/share/fish/tools/create_manpage_completions.py --directory $out \
+                > /dev/null
+            fi
+          '';
+      in
+        destructiveSymlinkJoin {
+          name = "${config.home.username}-fish-completions";
+          paths =
+            let
+              cmp = (a: b: (a.meta.priority or 0) > (b.meta.priority or 0));
+            in
+              map generateCompletions (sort cmp config.home.packages);
+        };
+
+    programs.fish.interactiveShellInit = ''
+      # add completions generated by Home Manager to $fish_complete_path
+      begin
+        set -l joined (string join " " $fish_complete_path)
+        set -l prev_joined (string replace --regex "[^\s]*generated_completions.*" "" $joined)
+        set -l post_joined (string replace $prev_joined "" $joined)
+        set -l prev (string split " " (string trim $prev_joined))
+        set -l post (string split " " (string trim $post_joined))
+        set fish_complete_path $prev "${config.xdg.dataHome}/fish/home-manager_generated_completions" $post
+      end
+    '';
 
     xdg.configFile."fish/config.fish".text = ''
       # ~/.config/fish/config.fish: DO NOT EDIT -- this file has been generated automatically.

modules/programs/git.nix

@@ -6,6 +6,12 @@ let
 
   cfg = config.programs.git;
 
+  gitIniType = with types;
+    let
+      primitiveType = either bool (either int str);
+    in
+      attrsOf (attrsOf primitiveType);
+
   signModule = types.submodule {
     options = {
       key = mkOption {
@@ -28,7 +34,7 @@ let
     };
   };
 
-  includeModule = types.submodule {
+  includeModule = types.submodule ({ config, ... }: {
     options = {
       condition = mkOption {
         type = types.nullOr types.str;
@@ -44,11 +50,23 @@ let
       };
 
       path = mkOption {
-        type = types.str;
+        type = with types; either str path;
         description = "Path of the configuration file to include.";
       };
+
+      contents = mkOption {
+        type = types.attrs;
+        default = {};
+        description = ''
+          Configuration to include. If empty then a path must be given.
+        '';
+      };
     };
-  };
+
+    config.path = mkIf (config.contents != {}) (
+      mkDefault (pkgs.writeText "contents" (generators.toINI {} config.contents))
+    );
+  });
 
 in
 
@@ -63,22 +81,28 @@ in
         type = types.package;
         default = pkgs.git;
         defaultText = "pkgs.git";
-        description = "Git package to install.";
+        description = ''
+          Git package to install. Use <varname>pkgs.gitAndTools.gitFull</varname>
+          to gain access to <command>git send-email</command> for instance.
+        '';
       };
 
       userName = mkOption {
-        type = types.str;
+        type = types.nullOr types.str;
+        default = null;
         description = "Default user name to use.";
       };
 
       userEmail = mkOption {
-        type = types.str;
+        type = types.nullOr types.str;
+        default = null;
         description = "Default user email to use.";
       };
 
       aliases = mkOption {
-        type = types.attrs;
+        type = types.attrsOf types.str;
         default = {};
+        example = { co = "checkout"; };
         description = "Git aliases to define.";
       };
 
@@ -89,13 +113,16 @@ in
       };
 
       extraConfig = mkOption {
-        type = types.either types.attrs types.lines;
+        type = types.either types.lines gitIniType;
         default = {};
+        example = {
+          core = { whitespace = "trailing-space,space-before-tab"; };
+        };
         description = "Additional configuration to add.";
       };
 
       iniContent = mkOption {
-        type = types.attrsOf types.attrs;
+        type = gitIniType;
         internal = true;
       };
 
@@ -120,6 +147,20 @@ in
         '';
         description = "List of configuration files to include.";
       };
+
+      lfs = {
+        enable = mkEnableOption "Git Large File Storage";
+
+        skipSmudge = mkOption {
+          type = types.bool;
+          default = false;
+          description = ''
+            Skip automatic downloading of objects on clone or pull.
+            This requires a manual <command>git lfs pull</command>
+            every time a new commit is checked out on your repository.
+          '';
+        };
+      };
     };
   };
 
@@ -129,8 +170,8 @@ in
         home.packages = [ cfg.package ];
 
         programs.git.iniContent.user = {
-          name = cfg.userName;
+          name = mkIf (cfg.userName != null) cfg.userName;
-          email = cfg.userEmail;
+          email = mkIf (cfg.userEmail != null) cfg.userEmail;
         };
 
         xdg.configFile = {
@@ -142,6 +183,26 @@ in
         };
       }
 
+      {
+        programs.git.iniContent =
+          let
+            hasSmtp = name: account: account.smtp != null;
+
+            genIdentity = name: account: with account;
+              nameValuePair "sendemail \"${name}\"" ({
+                smtpEncryption = if smtp.tls.enable then "tls" else "";
+                smtpServer = smtp.host;
+                smtpUser = userName;
+                from = address;
+              }
+              // optionalAttrs (smtp.port != null) {
+                smtpServerPort = smtp.port;
+              });
+          in
+            mapAttrs' genIdentity
+              (filterAttrs hasSmtp config.accounts.email.accounts);
+      }
+
       (mkIf (cfg.signing != null) {
         programs.git.iniContent = {
           user.signingKey = cfg.signing.key;
@@ -171,6 +232,25 @@ in
             '')
             cfg.includes);
       })
+
+      (mkIf cfg.lfs.enable {
+        home.packages = [ pkgs.git-lfs ];
+
+        programs.git.iniContent."filter \"lfs\"" =
+          let
+            skipArg = optional cfg.lfs.skipSmudge "--skip";
+          in
+            {
+              clean = "git-lfs clean -- %f";
+              process = concatStringsSep " " (
+                [ "git-lfs" "filter-process" ] ++ skipArg
+              );
+              required = true;
+              smudge = concatStringsSep " " (
+                [ "git-lfs" "smudge" ] ++ skipArg ++ [ "--" "%f" ]
+              );
+            };
+      })
     ]
   );
 }

modules/programs/gnome-terminal.nix

@@ -6,7 +6,10 @@ let
 
   cfg = config.programs.gnome-terminal;
 
-  dag = config.lib.dag;
+  vteInitStr = ''
+    # gnome-terminal: Show current directory in the terminal window title.
+    . ${pkgs.gnome3.vte}/etc/profile.d/vte.sh
+  '';
 
   profileColorsSubModule = types.submodule (
     { ... }: {
@@ -91,19 +94,6 @@ let
     }
   );
 
-  toDconfIni = generators.toINI { mkKeyValue = mkIniKeyValue; };
-
-  mkIniKeyValue = key: value:
-    let
-      tweakVal = v:
-        if isString v then "'${v}'"
-        else if isList v then "[" + concatStringsSep "," (map tweakVal v) + "]"
-        else if isBool v && v then "true"
-        else if isBool v && !v then "false"
-        else toString v;
-    in
-      "${key}=${tweakVal value}";
-
   buildProfileSet = pcfg:
     {
       visible-name = pcfg.visibleName;
@@ -136,25 +126,6 @@ let
       )
     );
 
-  buildIniSet = cfg:
-    {
-      "/" = {
-        default-show-menubar = cfg.showMenubar;
-        schema-version = 3;
-      };
-    }
-    //
-    {
-      "profiles:" = {
-        default = head (attrNames (filterAttrs (n: v: v.default) cfg.profile));
-        list = attrNames cfg.profile;
-      };
-    }
-    //
-    mapAttrs' (name: value:
-      nameValuePair ("profiles:/:${name}") (buildProfileSet value)
-    ) cfg.profile;
-
 in
 
 {
@@ -181,20 +152,26 @@ in
   config = mkIf cfg.enable {
     home.packages = [ pkgs.gnome3.gnome_terminal ];
 
-    # The dconf service needs to be installed and prepared.
+    dconf.settings =
-    home.activation.gnomeTerminal = dag.entryAfter ["installPackages"] (
       let
-        iniText = toDconfIni (buildIniSet cfg);
+        dconfPath = "org/gnome/terminal/legacy";
-        iniFile = pkgs.writeText "gnome-terminal.ini" iniText;
-        dconfPath = "/org/gnome/terminal/legacy/";
       in
-        ''
+        {
-          if [[ -v DRY_RUN ]]; then
+          "${dconfPath}" = {
-            echo ${pkgs.gnome3.dconf}/bin/dconf load ${dconfPath} "<" ${iniFile}
+            default-show-menubar = cfg.showMenubar;
-          else
+            schema-version = 3;
-            ${pkgs.gnome3.dconf}/bin/dconf load ${dconfPath} < ${iniFile}
+          };
-          fi
+
-        ''
+          "${dconfPath}/profiles:" = {
-    );
+            default = head (attrNames (filterAttrs (n: v: v.default) cfg.profile));
+            list = attrNames cfg.profile;
+          };
+        }
+        // mapAttrs' (n: v:
+          nameValuePair ("${dconfPath}/profiles:/:${n}") (buildProfileSet v)
+        ) cfg.profile;
+
+    programs.bash.initExtra = mkBefore vteInitStr;
+    programs.zsh.initExtra = vteInitStr;
   };
 }

modules/programs/home-manager.nix

@@ -32,7 +32,7 @@ in
     };
   };
 
-  config = mkIf (cfg.enable && !config.nixosSubmodule) {
+  config = mkIf (cfg.enable && !config.submoduleSupport.enable) {
     home.packages = [
       (import ../../home-manager {
         inherit pkgs;

modules/programs/irssi.nix

@@ -0,0 +1,211 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+let
+
+  cfg = config.programs.irssi;
+
+  boolStr = b: if b then "yes" else "no";
+  quoteStr = s: escape ["\""] s;
+
+  assignFormat = set:
+    concatStringsSep "\n"
+      (mapAttrsToList (k: v: "  ${k} = \"${quoteStr v}\";") set);
+
+  chatnetString =
+    concatStringsSep "\n"
+      (flip mapAttrsToList cfg.networks
+      (k: v: ''
+        ${k} = {
+          type = "${v.type}";
+          nick = "${quoteStr v.nick}";
+          autosendcmd = "${concatMapStringsSep ";" quoteStr v.autoCommands}";
+        };
+      ''));
+
+  serversString =
+    concatStringsSep ",\n"
+      (flip mapAttrsToList cfg.networks
+      (k: v: ''
+        {
+          chatnet = "${k}";
+          address = "${v.server.address}";
+          port = "${toString v.server.port}";
+          use_ssl = "${boolStr v.server.ssl.enable}";
+          ssl_verify = "${boolStr v.server.ssl.verify}";
+          autoconnect = "${boolStr v.server.autoConnect}";
+        }
+      ''));
+
+  channelString =
+    concatStringsSep ",\n"
+      (flip mapAttrsToList cfg.networks
+      (k: v:
+        concatStringsSep ",\n"
+          (flip mapAttrsToList v.channels
+          (c: cv: ''
+            {
+              chatnet = "${k}";
+              name = "${c}";
+              autojoin = "${boolStr cv.autoJoin}";
+            }
+          ''))));
+
+  channelType = types.submodule {
+    options = {
+      name = mkOption {
+        type = types.nullOr types.str;
+        visible = false;
+        default = null;
+        description = "Name of the channel.";
+      };
+
+      autoJoin = mkOption {
+        type = types.bool;
+        default = false;
+        description = "Whether to join this channel on connect.";
+      };
+    };
+  };
+
+  networkType = types.submodule ({ name, ...}: {
+    options = {
+      name = mkOption {
+        visible = false;
+        default = name;
+        type = types.str;
+      };
+
+      nick = mkOption {
+        type = types.str;
+        description = "Nickname in that network.";
+      };
+
+      type = mkOption {
+        type = types.str;
+        description = "Type of the network.";
+        default = "IRC";
+      };
+
+      autoCommands = mkOption {
+        type = types.listOf types.str;
+        default = [];
+        description = "List of commands to execute on connect.";
+      };
+
+      server = {
+        address = mkOption {
+          type = types.str;
+          description = "Address of the chat server.";
+        };
+
+        port = mkOption {
+          type = types.int;
+          default = 6667;
+          description = "Port of the chat server.";
+        };
+
+        ssl = {
+          enable = mkOption {
+            type = types.bool;
+            default = true;
+            description = "Whether SSL should be used.";
+          };
+
+          verify = mkOption {
+            type = types.bool;
+            default = true;
+            description = "Whether the SSL certificate should be verified.";
+          };
+        };
+
+        autoConnect = mkOption {
+          type = types.bool;
+          default = false;
+          description = "Whether Irssi connects to the server on launch.";
+        };
+      };
+
+      channels = mkOption {
+        description = "Channels for the given network.";
+        type = types.attrsOf channelType;
+        default = {};
+      };
+    };
+  });
+
+in
+
+{
+
+  options = {
+    programs.irssi = {
+      enable = mkEnableOption "the Irssi chat client";
+
+      extraConfig = mkOption {
+        default = "";
+        description = "These lines are appended to the Irssi configuration.";
+        type = types.str;
+      };
+
+      aliases = mkOption {
+        default = {};
+        example = { J = "join"; BYE = "quit";};
+        description = "An attribute set that maps aliases to commands.";
+        type = types.attrsOf types.str;
+      };
+
+      networks = mkOption {
+        default = {};
+        example = literalExample ''
+          {
+            freenode = {
+              nick = "hmuser";
+              server = {
+                address = "chat.freenode.net";
+                port = 6697;
+                autoConnect = true;
+              };
+              channels = {
+                nixos.autoJoin = true;
+              };
+            };
+          }
+        '';
+        description = "An attribute set of chat networks.";
+        type = types.attrsOf networkType;
+      };
+    };
+  };
+
+  config = mkIf cfg.enable {
+    home.packages = [ pkgs.irssi ];
+
+    home.file.".irssi/config".text = ''
+      settings = {
+        core = {
+          settings_autosave = "no";
+        };
+      };
+
+      aliases = {
+      ${assignFormat cfg.aliases}
+      };
+
+      chatnets = {
+      ${chatnetString}
+      };
+
+      servers = (
+      ${serversString}
+      );
+
+      channels = (
+      ${channelString}
+      );
+
+      ${cfg.extraConfig}
+    '';
+  };
+}

modules/programs/jq.nix

@@ -0,0 +1,76 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+let
+
+  cfg = config.programs.jq;
+
+  colorType = mkOption {
+    type = types.str;
+    description = "ANSI color definition";
+    example = "1;31";
+    visible = false;
+  };
+
+  colorsType = types.submodule {
+    options = {
+      null    = colorType;
+      false   = colorType;
+      true    = colorType;
+      numbers = colorType;
+      strings = colorType;
+      arrays  = colorType;
+      objects = colorType;
+    };
+  };
+
+in
+
+{
+  options = {
+    programs.jq = {
+      enable = mkEnableOption "the jq command-line JSON processor";
+
+      colors = mkOption {
+        description = ''
+          The colors used in colored JSON output.</para>
+
+          <para>See <link xlink:href="https://stedolan.github.io/jq/manual/#Colors"/>.
+        '';
+
+        example = literalExample ''
+          {
+            null    = "1;30";
+            false   = "0;31";
+            true    = "0;32";
+            numbers = "0;36";
+            strings = "0;33";
+            arrays  = "1;35";
+            objects = "1;37";
+          }
+        '';
+
+        default = {
+          null    = "1;30";
+          false   = "0;39";
+          true    = "0;39";
+          numbers = "0;39";
+          strings = "0;32";
+          arrays  = "1;39";
+          objects = "1;39";
+        };
+
+        type = colorsType;
+      };
+    };
+  };
+
+  config = mkIf cfg.enable {
+    home.packages = [ pkgs.jq ];
+
+    home.sessionVariables = let c = cfg.colors; in {
+      JQ_COLORS = "${c.null}:${c.false}:${c.true}:${c.numbers}:${c.strings}:${c.arrays}:${c.objects}";
+    };
+  };
+}

modules/programs/matplotlib.nix

@@ -0,0 +1,64 @@
+{ config, lib, ... }:
+
+with lib;
+
+let
+
+  cfg = config.programs.matplotlib;
+
+  formatLine = o: n: v:
+    let
+      formatValue = v:
+        if isBool v then (if v then "True" else "False")
+        else toString v;
+    in
+      if isAttrs v
+      then concatStringsSep "\n" (mapAttrsToList (formatLine "${o}${n}.") v)
+      else (if v == "" then "" else "${o}${n}: ${formatValue v}");
+
+in
+
+{
+  meta.maintainers = [ maintainers.rprospero ];
+
+  options.programs.matplotlib = {
+    enable = mkEnableOption "matplotlib, a plotting library for python";
+
+    config = mkOption {
+      default = { };
+      type = types.attrs;
+      description = ''
+        Add terms to the <filename>matplotlibrc</filename> file to
+        control the default matplotlib behavior.
+      '';
+      example = literalExample  ''
+        {
+          backend = "Qt5Agg";
+          axes = {
+            grid = true;
+            facecolor = "black";
+            edgecolor = "FF9900";
+          };
+          grid.color = "FF9900";
+        }
+      '';
+    };
+
+    extraConfig = mkOption {
+      type = types.lines;
+      default = "";
+      description = ''
+        Additional commands for matplotlib that will be added to the
+        <filename>matplotlibrc</filename> file.
+      '';
+    };
+  };
+
+  config = mkIf cfg.enable {
+    xdg.configFile."matplotlib/matplotlibrc".text =
+      concatStringsSep "\n" ([]
+        ++ mapAttrsToList (formatLine "") cfg.config
+        ++ optional (cfg.extraConfig != "") cfg.extraConfig
+      ) + "\n";
+  };
+}

modules/programs/mbsync.nix

@@ -34,24 +34,24 @@ let
     let
       escapeValue = escape [ "\"" ];
       hasSpace = v: builtins.match ".* .*" v != null;
-      genValue = v:
+      genValue = n: v:
         if isList v
-        then concatMapStringsSep " " genValue v
+        then concatMapStringsSep " " (genValue n) v
         else if isBool v then (if v then "yes" else "no")
         else if isInt v then toString v
-        else if hasSpace v then "\"${escapeValue v}\""
+        else if isString v && hasSpace v then "\"${escapeValue v}\""
-        else v;
+        else if isString v then v
+        else
+          let prettyV = lib.generators.toPretty {} v;
+          in  throw "mbsync: unexpected value for option ${n}: '${prettyV}'";
     in
       ''
         ${header}
         ${concatStringsSep "\n"
-          (mapAttrsToList (n: v: "${n} ${genValue v}") entries)}
+          (mapAttrsToList (n: v: "${n} ${genValue n v}") entries)}
       '';
 
   genAccountConfig = account: with account;
-    if (imap == null || maildir == null)
-    then ""
-    else
       genSection "IMAPAccount ${name}" (
         {
           Host = imap.host;
@@ -144,29 +144,23 @@ in
   };
 
   config = mkIf cfg.enable {
-    assertions = [
+    assertions =
-      (
+      let
-        let
+        checkAccounts = pred: msg:
-          badAccounts = filter (a: a.maildir == null) mbsyncAccounts;
+          let
-        in
+            badAccounts = filter pred mbsyncAccounts;
-          {
+          in {
             assertion = badAccounts == [];
-            message = "mbsync: Missing maildir configuration for accounts: "
+            message = "mbsync: ${msg} for accounts: "
               + concatMapStringsSep ", " (a: a.name) badAccounts;
-          }
+          };
-      )
+      in
-
+        [
-      (
+          (checkAccounts (a: a.maildir == null) "Missing maildir configuration")
-        let
+          (checkAccounts (a: a.imap == null) "Missing IMAP configuration")
-          badAccounts = filter (a: a.imap == null) mbsyncAccounts;
+          (checkAccounts (a: a.passwordCommand == null) "Missing passwordCommand")
-        in
+          (checkAccounts (a: a.userName == null) "Missing username")
-          {
+        ];
-            assertion = badAccounts == [];
-            message = "mbsync: Missing IMAP configuration for accounts: "
-              + concatMapStringsSep ", " (a: a.name) badAccounts;
-          }
-      )
-    ];
 
     home.packages = [ cfg.package ];
 
@@ -182,7 +176,7 @@ in
           ++ accountsConfig
           ++ groupsConfig
           ++ optional (cfg.extraConfig != "") cfg.extraConfig
-        );
+        ) + "\n";
 
     home.activation.createMaildir =
       dag.entryBetween [ "linkGeneration" ] [ "writeBoundary" ] ''

modules/programs/msmtp-accounts.nix

@@ -11,14 +11,25 @@ with lib;
         Whether to enable msmtp.
         </para><para>
         If enabled then it is possible to use the
-        <option>--account</option> command line option to send a
+        <parameter class="command">--account</parameter> command line
-        message for a given account using the <command>msmtp</command>
+        option to send a message for a given account using the
-        or <command>msmtpq</command> tool. For example,
+        <command>msmtp</command> or <command>msmtpq</command> tool.
-        <command>msmtp --account=private</command>
+        For example, <command>msmtp --account=private</command> would
-        would send using the account defined in
+        send using the account defined in
         <option>accounts.email.accounts.private</option>. If the
-        <option>--account</option> option is not given then the
+        <parameter class="command">--account</parameter> option is not
-        primary account will be used.
+        given then the primary account will be used.
+      '';
+    };
+
+    extraConfig = mkOption {
+      type = types.attrsOf types.str;
+      default = { };
+      example = { auth = "login"; };
+      description = ''
+        Extra configuration options to add to <filename>~/.msmtprc</filename>.
+        See <link xlink:href="https://marlam.de/msmtp/msmtprc.txt"/> for
+        examples.
       '';
     };
   };

modules/programs/msmtp.nix

@@ -31,6 +31,7 @@ let
           # msmtp requires the password to finish with a newline.
           passwordeval = ''${pkgs.bash}/bin/bash -c "${toString passwordCommand}; echo"'';
         }
+        // msmtp.extraConfig
       )
       ++ optional primary "\naccount default : ${name}"
     );
@@ -65,7 +66,7 @@ in
   config = mkIf cfg.enable {
     home.packages = [ pkgs.msmtp ];
 
-    home.file.".msmtprc".text = configFile msmtpAccounts;
+    xdg.configFile."msmtp/config".text = configFile msmtpAccounts;
 
     home.sessionVariables =  {
       MSMTP_QUEUE = "${config.xdg.dataHome}/msmtp/queue";

modules/programs/neovim.nix

@@ -95,6 +95,13 @@ in
         '';
       };
 
+      package = mkOption {
+        type = types.package;
+        default = pkgs.neovim-unwrapped;
+        defaultText = "pkgs.neovim-unwrapped";
+        description = "The package to use for the neovim binary.";
+      };
+
       configure = mkOption {
         type = types.attrs;
         default = {};
@@ -121,7 +128,7 @@ in
 
   config = mkIf cfg.enable {
     home.packages = [
-      (pkgs.neovim.override {
+      (pkgs.wrapNeovim cfg.package {
         inherit (cfg)
           extraPython3Packages withPython3
           extraPythonPackages withPython

modules/programs/newsboat.nix

@@ -45,13 +45,13 @@ in
       };
 
       browser = mkOption {
-        type = types.string;
+        type = types.str;
         default = "${pkgs.xdg_utils}/bin/xdg-open";
         description = "External browser to use.";
       };
 
       queries = mkOption {
-        type = types.attrsOf types.string;
+        type = types.attrsOf types.str;
         default = {};
         example = {
           "foo" = "rssurl =~ \"example.com\"";

modules/programs/opam.nix

@@ -0,0 +1,52 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+let
+
+  cfg = config.programs.opam;
+
+in
+
+{
+  meta.maintainers = [ maintainers.marsam ];
+
+  options.programs.opam = {
+    enable = mkEnableOption "Opam";
+
+    package = mkOption {
+      type = types.package;
+      default = pkgs.opam;
+      defaultText = "pkgs.opam";
+      description = "Opam package to install.";
+    };
+
+    enableBashIntegration = mkOption {
+      default = true;
+      type = types.bool;
+      description = ''
+        Whether to enable Bash integration.
+      '';
+    };
+
+    enableZshIntegration = mkOption {
+      default = true;
+      type = types.bool;
+      description = ''
+        Whether to enable Zsh integration.
+      '';
+    };
+  };
+
+  config = mkIf cfg.enable {
+    home.packages = [ cfg.package ];
+
+    programs.bash.initExtra = mkIf cfg.enableBashIntegration ''
+      eval "$(${cfg.package}/bin/opam env --shell=bash)"
+    '';
+
+    programs.zsh.initExtra = mkIf cfg.enableZshIntegration ''
+      eval "$(${cfg.package}/bin/opam env --shell=zsh)"
+    '';
+  };
+}

modules/programs/rofi.nix

@@ -8,7 +8,7 @@ let
   cfg = config.programs.rofi;
 
   colorOption = description: mkOption {
-    type = types.string;
+    type = types.str;
     description = description;
   };
 
@@ -175,7 +175,7 @@ in
 
     font = mkOption {
       default = null;
-      type = types.nullOr types.string;
+      type = types.nullOr types.str;
       example = "Droid Sans Mono 14";
       description = "Font to use.";
     };
@@ -188,7 +188,7 @@ in
 
     terminal = mkOption {
       default = null;
-      type = types.nullOr types.string;
+      type = types.nullOr types.str;
       description = ''
         Path to the terminal which will be used to run console applications
       '';
@@ -282,7 +282,7 @@ in
     configPath = mkOption {
       default = "${config.xdg.configHome}/rofi/config";
       defaultText = "$XDG_CONFIG_HOME/rofi/config";
-      type = types.string;
+      type = types.str;
       description = "Path where to put generated configuration file.";
     };
 

modules/programs/ssh.nix

@@ -66,10 +66,15 @@ let
       };
 
       identityFile = mkOption {
-        type = types.nullOr types.str;
+        type = with types; either (listOf str) (nullOr str);
-        default = null;
+        default = [];
+        apply = p:
+          if p == null then []
+          else if isString p then [p]
+          else p;
         description = ''
-          Specifies a file from which the user identity is read.
+          Specifies files from which the user identity is read.
+          Identities will be tried in the given order.
         '';
       };
 
@@ -125,6 +130,28 @@ let
         description = "The command to use to connect to the server.";
       };
 
+      proxyJump = mkOption {
+        type = types.nullOr types.str;
+        default = null;
+        description = "The proxy host to use to connect to the server.";
+      };
+
+      certificateFile = mkOption {
+        type = types.nullOr types.path;
+        default = null;
+        description = ''
+          Specifies a file from which the user certificate is read.
+        '';
+      };
+
+      addressFamily = mkOption {
+        default = null;
+        type = types.nullOr (types.enum ["any" "inet" "inet6"]);
+        description = ''
+          Specifies which address family to use when connecting.
+        '';
+      };
+
       extraOptions = mkOption {
         type = types.attrsOf types.str;
         default = {};
@@ -137,20 +164,23 @@ let
 
   matchBlockStr = cf: concatStringsSep "\n" (
     ["Host ${cf.host}"]
-    ++ optional (cf.port != null)         "  Port ${toString cf.port}"
+    ++ optional (cf.port != null)            "  Port ${toString cf.port}"
-    ++ optional (cf.forwardAgent != null) "  ForwardAgent ${yn cf.forwardAgent}"
+    ++ optional (cf.forwardAgent != null)    "  ForwardAgent ${yn cf.forwardAgent}"
-    ++ optional cf.forwardX11             "  ForwardX11 yes"
+    ++ optional cf.forwardX11                "  ForwardX11 yes"
-    ++ optional cf.forwardX11Trusted      "  ForwardX11Trusted yes"
+    ++ optional cf.forwardX11Trusted         "  ForwardX11Trusted yes"
-    ++ optional cf.identitiesOnly         "  IdentitiesOnly yes"
+    ++ optional cf.identitiesOnly            "  IdentitiesOnly yes"
-    ++ optional (cf.user != null)         "  User ${cf.user}"
+    ++ optional (cf.user != null)            "  User ${cf.user}"
-    ++ optional (cf.identityFile != null) "  IdentityFile ${cf.identityFile}"
+    ++ optional (cf.certificateFile != null) "  CertificateFile ${cf.certificateFile}"
-    ++ optional (cf.hostname != null)     "  HostName ${cf.hostname}"
+    ++ optional (cf.hostname != null)        "  HostName ${cf.hostname}"
-    ++ optional (cf.sendEnv != [])        "  SendEnv ${unwords cf.sendEnv}"
+    ++ optional (cf.addressFamily != null)   "  AddressFamily ${cf.addressFamily}"
+    ++ optional (cf.sendEnv != [])           "  SendEnv ${unwords cf.sendEnv}"
     ++ optional (cf.serverAliveInterval != 0)
          "  ServerAliveInterval ${toString cf.serverAliveInterval}"
-    ++ optional (cf.compression != null)  "  Compression ${yn cf.compression}"
+    ++ optional (cf.compression != null)     "  Compression ${yn cf.compression}"
-    ++ optional (!cf.checkHostIP)         "  CheckHostIP no"
+    ++ optional (!cf.checkHostIP)            "  CheckHostIP no"
-    ++ optional (cf.proxyCommand != null) "  ProxyCommand ${cf.proxyCommand}"
+    ++ optional (cf.proxyCommand != null)    "  ProxyCommand ${cf.proxyCommand}"
+    ++ optional (cf.proxyJump != null)       "  ProxyJump ${cf.proxyJump}"
+    ++ map (file: "  IdentityFile ${file}") cf.identityFile
     ++ mapAttrsToList (n: v: "  ${n} ${v}") cf.extraOptions
   );
 
@@ -219,7 +249,7 @@ in
 
     controlPath = mkOption {
       type = types.str;
-      default = "~/.ssh/master-%r@%h:%p";
+      default = "~/.ssh/master-%r@%n:%p";
       description = ''
         Specify path to the control socket used for connection sharing.
       '';

modules/programs/termite.nix

@@ -6,6 +6,13 @@ let
 
   cfg = config.programs.termite;
 
+  vteInitStr = ''
+    # See https://github.com/thestinger/termite#id1
+    if [[ $TERM == xterm-termite ]]; then
+      . ${pkgs.gnome3.vte-ng}/etc/profile.d/vte.sh
+    fi
+  '';
+
 in
 
 {
@@ -363,6 +370,9 @@ in
 
         ${cfg.hintsExtra}
       '';
+
+      programs.bash.initExtra = vteInitStr;
+      programs.zsh.initExtra = vteInitStr;
     }
   );
 }

modules/programs/texlive.nix

@@ -6,6 +6,8 @@ let
 
   cfg = config.programs.texlive;
 
+  texlivePkgs = cfg.extraPackages pkgs.texlive;
+
 in
 
 {
@@ -16,7 +18,8 @@ in
       enable = mkEnableOption "Texlive";
 
       extraPackages = mkOption {
-        default = self: {};
+        default = tpkgs: { inherit (tpkgs) collection-basic; };
+        defaultText = "tpkgs: { inherit (tpkgs) collection-basic; }";
         example = literalExample ''
           tpkgs: { inherit (tpkgs) collection-fontsrecommended algorithms; }
         '';
@@ -32,8 +35,16 @@ in
   };
 
   config = mkIf cfg.enable {
+    assertions = [
+      {
+        assertion = texlivePkgs != {};
+        message = "Must provide at least one extra package in"
+          + " 'programs.texlive.extraPackages'.";
+      }
+    ];
+
     home.packages = [ cfg.package ];
-    programs.texlive.package =
+
-      pkgs.texlive.combine (cfg.extraPackages pkgs.texlive);
+    programs.texlive.package = pkgs.texlive.combine texlivePkgs;
   };
 }

modules/programs/vscode.nix

@@ -0,0 +1,52 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+let
+
+  cfg = config.programs.vscode;
+
+in
+
+{
+  options = {
+    programs.vscode = {
+      enable = mkEnableOption "Visual Studio Code";
+
+      userSettings = mkOption {
+        type = types.attrs;
+        default = {};
+        example = literalExample ''
+          {
+            "update.channel" = "none";
+            "[nix]"."editor.tabSize" = 2;
+          }
+        '';
+        description = ''
+          Configuration written to
+          <filename>~/.config/Code/User/settings.json</filename>.
+        '';
+      };
+
+      extensions = mkOption {
+        type = types.listOf types.package;
+        default = [];
+        description = ''
+          The extensions Visual Studio Code should be started with.
+          These will override but not delete manually installed ones.
+        '';
+      };
+    };
+  };
+
+  config = mkIf cfg.enable {
+    home.packages = [
+      (pkgs.vscode-with-extensions.override {
+        vscodeExtensions = cfg.extensions;
+      })
+    ];
+
+    xdg.configFile."Code/User/settings.json".text =
+      builtins.toJSON cfg.userSettings;
+  };
+}

modules/programs/zsh.nix

@@ -11,14 +11,21 @@ let
   pluginsDir = if cfg.dotDir != null then
     relToDotDir "plugins" else ".zsh/plugins";
 
-  envVarsStr = config.lib.shell.exportAll cfg.sessionVariables;
+  envVarsStr = config.lib.zsh.exportAll cfg.sessionVariables;
+  localVarsStr = config.lib.zsh.defineAll cfg.localVariables;
 
   aliasesStr = concatStringsSep "\n" (
-    mapAttrsToList (k: v: "alias ${k}='${v}'") cfg.shellAliases
+    mapAttrsToList (k: v: "alias ${k}=${lib.escapeShellArg v}") cfg.shellAliases
   );
 
   zdotdir = "$HOME/" + cfg.dotDir;
 
+  bindkeyCommands = {
+    emacs = "bindkey -e";
+    viins = "bindkey -v";
+    vicmd = "bindkey -a";
+  };
+
   historyModule = types.submodule ({ config, ... }: {
     options = {
       size = mkOption {
@@ -167,7 +174,7 @@ in
         default = true;
         description = ''
           Enable zsh completion. Don't forget to add
-          <programlisting>
+          <programlisting language="nix">
             environment.pathsToLink = [ "/share/zsh" ];
           </programlisting>
           to your system configuration to get completion for system packages (e.g. systemd).
@@ -186,6 +193,13 @@ in
         description = "Options related to commands history configuration.";
       };
 
+      defaultKeymap = mkOption {
+        type = types.nullOr (types.enum (attrNames bindkeyCommands));
+        default = null;
+        example = "emacs";
+        description = "The default base keymap to use.";
+      };
+
       sessionVariables = mkOption {
         default = {};
         type = types.attrs;
@@ -252,6 +266,15 @@ in
         default = {};
         description = "Options to configure oh-my-zsh.";
       };
+
+      localVariables = mkOption {
+        type = types.attrs;
+        default = {};
+        example = { POWERLEVEL9K_LEFT_PROMPT_ELEMENTS=["dir" "vcs"]; };
+        description = ''
+          Extra local variables defined at the top of <filename>.zshrc</filename>.
+        '';
+      };
     };
   };
 
@@ -303,6 +326,13 @@ in
 
         HELPDIR="${pkgs.zsh}/share/zsh/$ZSH_VERSION/help"
 
+        ${optionalString (cfg.defaultKeymap != null) ''
+          # Use ${cfg.defaultKeymap} keymap as the default.
+          ${getAttr cfg.defaultKeymap bindkeyCommands}
+        ''}
+
+        ${localVarsStr}
+
         ${concatStrings (map (plugin: ''
           path+="$HOME/${pluginsDir}/${plugin.name}"
           fpath+="$HOME/${pluginsDir}/${plugin.name}"

modules/services/dunst.nix

@@ -5,6 +5,9 @@ with lib;
 let
 
   cfg = config.services.dunst;
+
+  eitherStrBoolIntList = with types; either str (either bool (either int (listOf str)));
+
   toDunstIni = generators.toINI {
     mkKeyValue = key: value:
     let
@@ -61,7 +64,7 @@ in
       };
 
       settings = mkOption {
-        type = types.attrsOf types.attrs;
+        type = with types; attrsOf (attrsOf eitherStrBoolIntList);
         default = {};
         description = "Configuration written to ~/.config/dunstrc";
         example = literalExample ''
@@ -90,7 +93,7 @@ in
         xdg.dataFile."dbus-1/services/org.knopwob.dunst.service".source =
           "${pkgs.dunst}/share/dbus-1/services/org.knopwob.dunst.service";
 
-        services.dunst.settings.global.icon_folders =
+        services.dunst.settings.global.icon_path =
           let
             useCustomTheme =
               cfg.iconTheme.package != hicolorTheme.package
@@ -152,7 +155,17 @@ in
       }
 
       (mkIf (cfg.settings != {}) {
-        xdg.configFile."dunst/dunstrc".text = toDunstIni cfg.settings;
+        xdg.configFile."dunst/dunstrc" = {
+          text = toDunstIni cfg.settings;
+          onChange = ''
+            pkillVerbose=""
+            if [[ -v VERBOSE ]]; then
+              pkillVerbose="-e"
+            fi
+            $DRY_RUN_CMD ${pkgs.procps}/bin/pkill -u $USER $pkillVerbose dunst || true
+            unset pkillVerbose
+          '';
+        };
       })
     ]
   );

modules/services/emacs.nix

@@ -0,0 +1,44 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+let
+
+  cfg = config.services.emacs;
+  emacsCfg = config.programs.emacs;
+  emacsBinPath = "${emacsCfg.finalPackage}/bin";
+
+in
+
+{
+  options.services.emacs = {
+    enable = mkEnableOption "the Emacs daemon";
+  };
+
+  config = mkIf cfg.enable {
+    assertions = [
+      {
+        assertion = emacsCfg.enable;
+        message = "The Emacs service module requires"
+          + " 'programs.emacs.enable = true'.";
+      }
+    ];
+
+    systemd.user.services.emacs = {
+      Unit = {
+        Description = "Emacs: the extensible, self-documenting text editor";
+        Documentation = "info:emacs man:emacs(1) https://gnu.org/software/emacs/";
+      };
+
+      Service = {
+        ExecStart = "${pkgs.stdenv.shell} -l -c 'exec ${emacsBinPath}/emacs --fg-daemon'";
+        ExecStop = "${emacsBinPath}/emacsclient --eval '(kill-emacs)'";
+        Restart = "on-failure";
+      };
+
+      Install = {
+        WantedBy = [ "default.target" ];
+      };
+    };
+  };
+}

modules/services/flameshot.nix

@@ -24,7 +24,12 @@ in
     systemd.user.services.flameshot = {
       Unit = {
         Description = "Powerful yet simple to use screenshot software";
-        After = [ "graphical-session-pre.target" ];
+        After = [
+          "graphical-session-pre.target"
+          "polybar.service"
+          "stalonetray.service"
+          "taffybar.service"
+        ];
         PartOf = [ "graphical-session.target" ];
       };
 

modules/services/keybase.nix

@@ -16,6 +16,8 @@ in
   };
 
   config = mkIf cfg.enable {
+    home.packages = [ pkgs.keybase ];
+
     systemd.user.services.keybase = {
       Unit = {
         Description = "Keybase service";

modules/services/pasystray.nix

@@ -24,6 +24,11 @@ with lib;
         };
 
         Service = {
+          Environment =
+            let
+              toolPaths = makeBinPath [ pkgs.paprefs pkgs.pavucontrol ];
+            in
+              [ "PATH=${toolPaths}" ];
           ExecStart = "${pkgs.pasystray}/bin/pasystray";
         };
     };

modules/services/polybar.nix

@@ -6,6 +6,8 @@ let
 
   cfg = config.services.polybar;
 
+  eitherStrBoolIntList = with types; either str (either bool (either int (listOf str)));
+
   toPolybarIni = generators.toINI {
     mkKeyValue = key: value:
       let
@@ -25,12 +27,6 @@ let
   configFile = pkgs.writeText "polybar.conf"
     (toPolybarIni cfg.config + "\n" + cfg.extraConfig);
 
-  script = ''
-    #!${pkgs.stdenv.shell}
-
-    ${cfg.script}
-  '';
-
 in
 
 {
@@ -57,7 +53,7 @@ in
         type = types.coercedTo
           types.path
           (p: { "section/base" = { include-file = "${p}"; }; })
-          (types.attrsOf types.attrs);
+          (types.attrsOf (types.attrsOf eitherStrBoolIntList));
         description = ''
           Polybar configuration. Can be either path to a file, or set of attributes
           that will be used to create the final configuration.
@@ -127,8 +123,12 @@ in
 
       Service = {
         Type = "forking";
-        Environment = "PATH=${cfg.package}/bin";
+        Environment = "PATH=${cfg.package}/bin:/run/wrappers/bin";
-        ExecStart = ''${pkgs.writeScriptBin "polybar-start" script}/bin/polybar-start'';
+        ExecStart =
+          let
+            scriptPkg = pkgs.writeShellScriptBin "polybar-start" cfg.script;
+          in
+            "${scriptPkg}/bin/polybar-start";
       };
 
       Install = {

modules/services/random-background.nix

@@ -17,22 +17,22 @@ in
 
       imageDirectory = mkOption {
         type = types.str;
-        description =
+        example = "%h/backgrounds";
-          ''
+        description = ''
-            The directory of images from which a background should be
+          The directory of images from which a background should be
-            chosen. Should be formatted in a way understood by
+          chosen. Should be formatted in a way understood by systemd,
-            systemd, e.g., '%h' is the home directory.
+          e.g., '%h' is the home directory.
-          '';
+        '';
       };
 
       interval = mkOption {
         default = null;
         type = types.nullOr types.str;
+        example = "1h";
         description = ''
           The duration between changing background image, set to null
-          to only set background when logging in.
+          to only set background when logging in. Should be formatted
-
+          as a duration understood by systemd.
-          Should be formatted as a duration understood by systemd.
         '';
       };
     };

modules/services/taffybar.nix

@@ -35,6 +35,7 @@ in
 
       Service = {
         ExecStart = "${cfg.package}/bin/taffybar";
+        Restart = "on-failure";
       };
 
       Install = {

modules/services/window-managers/i3.nix

@@ -8,7 +8,7 @@ let
 
   commonOptions = {
     fonts = mkOption {
-      type = types.listOf types.string;
+      type = types.listOf types.str;
       default = ["monospace 8"];
       description = ''
         Font list used for window titles. Only FreeType fonts are supported.
@@ -21,7 +21,7 @@ let
   startupModule = types.submodule {
     options = {
       command = mkOption {
-        type = types.string;
+        type = types.str;
         description = "Command that will be executed on startup.";
       };
 
@@ -41,7 +41,7 @@ let
       };
 
       workspace = mkOption {
-        type = types.nullOr types.string;
+        type = types.nullOr types.str;
         default = null;
         description = ''
           Launch application on a particular workspace. DEPRECATED:
@@ -55,17 +55,17 @@ let
   barColorSetModule = types.submodule {
     options = {
       border = mkOption {
-        type = types.string;
+        type = types.str;
         visible = false;
       };
 
       background = mkOption {
-        type = types.string;
+        type = types.str;
         visible = false;
       };
 
       text = mkOption {
-        type = types.string;
+        type = types.str;
         visible = false;
       };
     };
@@ -74,27 +74,27 @@ let
   colorSetModule = types.submodule {
     options = {
       border = mkOption {
-        type = types.string;
+        type = types.str;
         visible = false;
       };
 
       childBorder = mkOption {
-        type = types.string;
+        type = types.str;
         visible = false;
       };
 
       background = mkOption {
-        type = types.string;
+        type = types.str;
         visible = false;
       };
 
       text = mkOption {
-        type = types.string;
+        type = types.str;
         visible = false;
       };
 
       indicator = mkOption {
-        type = types.string;
+        type = types.str;
         visible = false;
       };
     };
@@ -104,8 +104,14 @@ let
     options = {
       inherit (commonOptions) fonts;
 
+      extraConfig = mkOption {
+        type = types.lines;
+        default = "";
+        description = "Extra configuration lines for this bar.";
+      };
+
       id = mkOption {
-        type = types.nullOr types.string;
+        type = types.nullOr types.str;
         default = null;
         description = ''
           Specifies the bar ID for the configured bar instance.
@@ -145,7 +151,7 @@ let
       };
 
       command = mkOption {
-        type = types.string;
+        type = types.str;
         default = "${cfg.package}/bin/i3bar";
         defaultText = "i3bar";
         description = "Command that will be used to start a bar.";
@@ -153,7 +159,7 @@ let
       };
 
       statusCommand = mkOption {
-        type = types.string;
+        type = types.str;
         default = "${pkgs.i3status}/bin/i3status";
         description = "Command that will be used to get status lines.";
       };
@@ -162,19 +168,19 @@ let
         type = types.submodule {
           options = {
             background = mkOption {
-              type = types.string;
+              type = types.str;
               default = "#000000";
               description = "Background color of the bar.";
             };
 
             statusline = mkOption {
-              type = types.string;
+              type = types.str;
               default = "#ffffff";
               description = "Text color to be used for the statusline.";
             };
 
             separator = mkOption {
-              type = types.string;
+              type = types.str;
               default = "#666666";
               description = "Text color to be used for the separator.";
             };
@@ -230,13 +236,19 @@ let
           See <link xlink:href="https://i3wm.org/docs/userguide.html#_colors"/>.
         '';
       };
+
+      trayOutput = mkOption {
+        type = types.str;
+        default = "primary";
+        description = "Where to output tray.";
+      };
     };
   };
 
   windowCommandModule = types.submodule {
     options = {
       command = mkOption {
-        type = types.string;
+        type = types.str;
         description = "i3wm command to execute.";
         example = "border pixel 1";
       };
@@ -249,7 +261,7 @@ let
     };
   };
 
-  criteriaModule = types.attrs;
+  criteriaModule = types.attrsOf types.str;
 
   configModule = types.submodule {
     options = {
@@ -394,9 +406,19 @@ let
         example = "Mod4";
       };
 
+      workspaceLayout = mkOption {
+        type = types.enum [ "default" "stacked" "tabbed" ];
+        default = "default";
+        example = "tabbed";
+        description = ''
+          The mode in which new containers on workspace level will
+          start.
+        '';
+      };
+
       keybindings = mkOption {
-        type = types.attrs;
+        type = types.attrsOf (types.nullOr types.str);
-        default = {
+        default = mapAttrs (n: mkOptionDefault) {
           "${cfg.config.modifier}+Return" = "exec i3-sensible-terminal";
           "${cfg.config.modifier}+Shift+q" = "kill";
           "${cfg.config.modifier}+d" = "exec ${pkgs.dmenu}/bin/dmenu_run";
@@ -470,7 +492,7 @@ let
       };
 
       keycodebindings = mkOption {
-        type = types.attrs;
+        type = types.attrsOf (types.nullOr types.str);
         default = {};
         description = ''
           An attribute set that assigns keypress to an action using key code.
@@ -483,7 +505,7 @@ let
         type = types.submodule {
           options = {
             background = mkOption {
-              type = types.string;
+              type = types.str;
               default = "#ffffff";
               description = ''
                 Background color of the window. Only applications which do not cover
@@ -555,7 +577,7 @@ let
       };
 
       modes = mkOption {
-        type = types.attrsOf types.attrs;
+        type = types.attrsOf (types.attrsOf types.str);
         default = {
           resize = {
             "Left" = "resize shrink width 10 px or 10 ppt";
@@ -671,7 +693,7 @@ let
 
   barStr = {
     id, fonts, mode, hiddenState, position, workspaceButtons,
-    workspaceNumbers, command, statusCommand, colors, ...
+    workspaceNumbers, command, statusCommand, colors, trayOutput, extraConfig, ...
   }: ''
     bar {
       ${optionalString (id != null) "id ${id}"}
@@ -683,6 +705,7 @@ let
       i3bar_command ${command}
       workspace_buttons ${if workspaceButtons then "yes" else "no"}
       strip_workspace_numbers ${if !workspaceNumbers then "yes" else "no"}
+      tray_output ${trayOutput}
       colors {
         background ${colors.background}
         statusline ${colors.statusline}
@@ -693,6 +716,7 @@ let
         urgent_workspace ${barColorSetStr colors.urgentWorkspace}
         binding_mode ${barColorSetStr colors.bindingMode}
       }
+      ${extraConfig}
     }
   '';
 
@@ -727,6 +751,7 @@ let
     focus_follows_mouse ${if focus.followMouse then "yes" else "no"}
     focus_on_window_activation ${focus.newWindow}
     mouse_warping ${if focus.mouseWarping then "output" else "none"}
+    workspace_layout ${workspaceLayout}
 
     client.focused ${colorSetStr colors.focused}
     client.focused_inactive ${colorSetStr colors.focusedInactive}

modules/services/xembed-sni-proxy.nix

@@ -0,0 +1,49 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+let
+
+  cfg = config.services.xembed-sni-proxy;
+
+in
+
+{
+  meta.maintainers = [ maintainers.rycee ];
+
+  options = {
+    services.xembed-sni-proxy = {
+      enable = mkEnableOption "XEmbed SNI Proxy";
+
+      package = mkOption {
+        type = types.package;
+        default = pkgs.plasma-workspace;
+        defaultText = "pkgs.plasma-workspace";
+        description = ''
+          Package containing the <command>xembedsniproxy</command>
+          program.
+        '';
+      };
+    };
+  };
+
+  config = mkIf cfg.enable {
+    systemd.user.services.xembed-sni-proxy = {
+      Unit = {
+        Description = "XEmbed SNI Proxy";
+        After = [ "graphical-session-pre.target" ];
+        PartOf = [ "graphical-session.target" ];
+      };
+
+      Install = {
+        WantedBy = [ "graphical-session.target" ];
+      };
+
+      Service = {
+        Environment = "PATH=${config.home.profileDirectory}/bin";
+        ExecStart = "${cfg.package}/bin/xembedsniproxy";
+        Restart = "on-abort";
+      };
+    };
+  };
+}

modules/systemd.nix

@@ -27,11 +27,17 @@ let
   buildService = style: name: serviceCfg:
     let
       filename = "${name}.${style}";
+      pathSafeName = lib.replaceChars ["@" ":" "\\" "[" "]"]
+                                      ["-" "-" "-"  ""  "" ]
+                                      filename;
 
       # Needed because systemd derives unit names from the ultimate
       # link target.
-      source = pkgs.writeTextDir filename (toSystemdIni serviceCfg)
+      source = pkgs.writeTextFile {
-        + "/" + filename;
+        name = pathSafeName;
+        text = toSystemdIni serviceCfg;
+        destination = "/${filename}";
+      } + "/${filename}";
 
       wantedBy = target:
         {

modules/xsession.nix

@@ -66,39 +66,43 @@ in
   };
 
   config = mkIf cfg.enable {
-    systemd.user.services.setxkbmap = {
+    systemd.user = {
-      Unit = {
+      services = mkIf (config.home.keyboard != null) {
-        Description = "Set up keyboard in X";
+        setxkbmap =  {
-        After = [ "graphical-session-pre.target" ];
+          Unit = {
-        PartOf = [ "graphical-session.target" ];
+            Description = "Set up keyboard in X";
+            After = [ "graphical-session-pre.target" ];
+            PartOf = [ "graphical-session.target" ];
+          };
+
+          Install = {
+            WantedBy = [ "graphical-session.target" ];
+          };
+
+          Service = {
+            Type = "oneshot";
+            ExecStart =
+              let
+                args = concatStringsSep " " (
+                  [
+                    "-layout '${config.home.keyboard.layout}'"
+                    "-variant '${config.home.keyboard.variant}'"
+                  ] ++
+                  (map (v: "-option '${v}'") config.home.keyboard.options)
+                );
+              in
+                "${pkgs.xorg.setxkbmap}/bin/setxkbmap ${args}";
+          };
+        };
       };
 
-      Install = {
+      # A basic graphical session target for Home Manager.
-        WantedBy = [ "graphical-session.target" ];
+      targets.hm-graphical-session = {
-      };
+        Unit = {
-
+          Description = "Home Manager X session";
-      Service = {
+          Requires = [ "graphical-session-pre.target" ];
-        Type = "oneshot";
+          BindsTo = [ "graphical-session.target" ];
-        ExecStart =
+        };
-          let
-            args = concatStringsSep " " (
-              [
-                "-layout '${config.home.keyboard.layout}'"
-                "-variant '${config.home.keyboard.variant}'"
-              ] ++
-              (map (v: "-option '${v}'") config.home.keyboard.options)
-            );
-          in
-            "${pkgs.xorg.setxkbmap}/bin/setxkbmap ${args}";
-      };
-    };
-
-    # A basic graphical session target for Home Manager.
-    systemd.user.targets.hm-graphical-session = {
-      Unit = {
-        Description = "Home Manager X session";
-        Requires = [ "graphical-session-pre.target" ];
-        BindsTo = [ "graphical-session.target" ];
       };
     };
 

nix-darwin/default.nix

@@ -7,12 +7,12 @@ let
   cfg = config.home-manager;
 
   hmModule = types.submodule ({name, ...}: {
-    imports = import ../modules/modules.nix {
+    imports = import ../modules/modules.nix { inherit lib pkgs; };
-      inherit lib pkgs;
-      nixosSubmodule = true;
-    };
 
     config = {
+      submoduleSupport.enable = true;
+      submoduleSupport.externalPackageInstall = cfg.useUserPackages;
+
       home.username = config.users.users.${name}.name;
       home.homeDirectory = config.users.users.${name}.home;
     };
@@ -22,20 +22,27 @@ in
 
 {
   options = {
-    home-manager.users = mkOption {
+    home-manager = {
-      type = types.attrsOf hmModule;
+      useUserPackages = mkEnableOption ''
-      default = {};
+        installation of user packages through the
-      description = ''
+        <option>users.users.&lt;name?&gt;.packages</option> option.
-        Per-user Home Manager configuration.
       '';
+
+      users = mkOption {
+        type = types.attrsOf hmModule;
+        default = {};
+        description = ''
+          Per-user Home Manager configuration.
+        '';
+      };
     };
   };
 
   config = mkIf (cfg.users != {}) {
-    system.activationScripts.extraActivation.text =
+    system.activationScripts.postActivation.text =
-      lib.concatStringsSep "\n" (lib.mapAttrsToList (username: usercfg: ''
+      concatStringsSep "\n" (mapAttrsToList (username: usercfg: ''
         echo Activating home-manager configuration for ${username}
-        sudo -u ${username} ${usercfg.home.activationPackage}/activate
+        sudo -u ${username} -i ${usercfg.home.activationPackage}/activate
       '') cfg.users);
   };
 }

nixos/default.nix

@@ -7,12 +7,17 @@ let
   cfg = config.home-manager;
 
   hmModule = types.submodule ({name, ...}: {
-    imports = import ../modules/modules.nix {
+    imports = import ../modules/modules.nix { inherit lib pkgs; };
-      inherit lib pkgs;
-      nixosSubmodule = true;
-    };
 
     config = {
+      submoduleSupport.enable = true;
+      submoduleSupport.externalPackageInstall = cfg.useUserPackages;
+
+      # The per-user directory inside /etc/profiles is not known by
+      # fontconfig by default.
+      fonts.fontconfig.enableProfileFonts =
+        cfg.useUserPackages && config.fonts.fontconfig.enable;
+
       home.username = config.users.users.${name}.name;
       home.homeDirectory = config.users.users.${name}.home;
     };
@@ -22,16 +27,39 @@ in
 
 {
   options = {
-    home-manager.users = mkOption {
+    home-manager = {
-      type = types.attrsOf hmModule;
+      useUserPackages = mkEnableOption ''
-      default = {};
+        installation of user packages through the
-      description = ''
+        <option>users.users.&lt;name?&gt;.packages</option> option.
-        Per-user Home Manager configuration.
       '';
+
+      users = mkOption {
+        type = types.attrsOf hmModule;
+        default = {};
+        description = ''
+          Per-user Home Manager configuration.
+        '';
+      };
     };
   };
 
   config = mkIf (cfg.users != {}) {
+    assertions =
+      flatten (flip mapAttrsToList cfg.users (user: config:
+        flip map config.assertions (assertion:
+          {
+            inherit (assertion) assertion;
+            message = "${user} profile: ${assertion.message}";
+          }
+        )
+      ));
+
+    users.users = mkIf cfg.useUserPackages (
+      mapAttrs (username: usercfg: {
+        packages = usercfg.home.packages;
+      }) cfg.users
+    );
+
     systemd.services = mapAttrs' (username: usercfg:
       nameValuePair ("home-manager-${utils.escapeSystemdPath username}") {
         description = "Home Manager environment for ${username}";
@@ -40,7 +68,7 @@ in
         after = [ "nix-daemon.socket" ];
 
         serviceConfig = {
-          User = username;
+          User = usercfg.home.username;
           Type = "oneshot";
           RemainAfterExit = "yes";
           SyslogIdentifier = "hm-activate-${username}";

tests/default.nix

@@ -0,0 +1,37 @@
+{ pkgs ? import <nixpkgs> {} }:
+
+let
+
+  nmt = pkgs.fetchFromGitLab {
+    owner = "rycee";
+    repo = "nmt";
+    rev = "b6ab61e707ec1ca3839fef42f9960a1179d543c4";
+    sha256 = "097fm1hmsyhy8chf73wwrvafcxny37414fna3haxf0q5fvpv4jfb";
+  };
+
+in
+
+import nmt {
+  inherit pkgs;
+  modules = import ../modules/modules.nix { inherit pkgs; lib = pkgs.lib; };
+  testedAttrPath = [ "home" "activationPackage" ];
+  tests = {
+    files-executable = ./modules/files/executable.nix;
+    files-hidden-source = ./modules/files/hidden-source.nix;
+    files-source-with-spaces = ./modules/files/source-with-spaces.nix;
+    files-text = ./modules/files/text.nix;
+    git-with-email = ./modules/programs/git-with-email.nix;
+    git-with-most-options = ./modules/programs/git.nix;
+    git-with-str-extra-config = ./modules/programs/git-with-str-extra-config.nix;
+    mbsync = ./modules/programs/mbsync.nix;
+    texlive-minimal = ./modules/programs/texlive-minimal.nix;
+    xresources = ./modules/xresources.nix;
+  }
+  // pkgs.lib.optionalAttrs pkgs.stdenv.hostPlatform.isLinux (
+    {
+      i3-keybindings = ./modules/services/window-managers/i3-keybindings.nix;
+    }
+    // import ./modules/systemd
+  )
+  // import ./modules/programs/ssh;
+}

tests/modules/accounts/email-test-accounts.nix

@@ -0,0 +1,27 @@
+{ ... }:
+
+{
+  accounts.email = {
+    maildirBasePath = "Mail";
+
+    accounts = {
+      "hm@example.com" = {
+        address = "hm@example.com";
+        userName = "home.manager";
+        realName = "H. M. Test";
+        passwordCommand = "password-command";
+        imap.host = "imap.example.com";
+        smtp.host = "smtp.example.com";
+      };
+
+      hm-account = {
+        address = "hm@example.org";
+        userName = "home.manager.jr";
+        realName = "H. M. Test Jr.";
+        passwordCommand = "password-command 2";
+        imap.host = "imap.example.org";
+        smtp.host = "smtp.example.org";
+      };
+    };
+  };
+}

tests/modules/files/.hidden

@@ -0,0 +1 @@
+The name of this file has a dot prefix.

tests/modules/files/executable.nix

@@ -0,0 +1,17 @@
+{ config, lib, ... }:
+
+with lib;
+
+{
+  config = {
+    home.file."executable" = {
+      text = "";
+      executable = true;
+    };
+
+    nmt.script = ''
+      assertFileExists home-files/executable
+      assertFileIsExecutable home-files/executable;
+    '';
+  };
+}

tests/modules/files/hidden-source.nix

@@ -0,0 +1,16 @@
+{ config, lib, ... }:
+
+with lib;
+
+{
+  config = {
+    home.file.".hidden".source = ./.hidden;
+
+    nmt.script = ''
+      assertFileExists home-files/.hidden;
+      assertFileContent home-files/.hidden ${
+        builtins.path { path = ./.hidden; name = "expected"; }
+      }
+    '';
+  };
+}

tests/modules/files/source with spaces!

@@ -0,0 +1 @@
+Source with spaces!

tests/modules/files/source-with-spaces.nix

@@ -0,0 +1,20 @@
+{ config, lib, ... }:
+
+with lib;
+
+{
+  config = {
+    home.file."source with spaces!".source = ./. + "/source with spaces!";
+
+    nmt.script = ''
+      assertFileExists 'home-files/source with spaces!';
+      assertFileContent 'home-files/source with spaces!' \
+        ${
+          builtins.path {
+            path = ./. + "/source with spaces!";
+            name = "source-with-spaces-expected";
+          }
+        }
+    '';
+  };
+}

tests/modules/files/text-expected.txt

@@ -0,0 +1,2 @@
+This is the
+expected text.

tests/modules/files/text.nix

@@ -0,0 +1,18 @@
+{ config, lib, ... }:
+
+with lib;
+
+{
+  config = {
+    home.file."using-text".text = ''
+      This is the
+      expected text.
+    '';
+
+    nmt.script = ''
+      assertFileExists home-files/using-text
+      assertFileIsNotExecutable home-files/using-text
+      assertFileContent home-files/using-text ${./text-expected.txt}
+    '';
+  };
+}

tests/modules/programs/git-expected.conf

@@ -0,0 +1,34 @@
+[alias]
+a1=foo
+a2=baz
+
+[commit]
+gpgSign=true
+
+[extra]
+boolean=true
+integer=38
+name=value
+
+[filter "lfs"]
+clean=git-lfs clean -- %f
+process=git-lfs filter-process
+required=true
+smudge=git-lfs smudge -- %f
+
+[gpg]
+program=path-to-gpg
+
+[user]
+email=user@example.org
+name=John Doe
+signingKey=00112233445566778899AABBCCDDEEFF
+
+[include]
+path = ~/path/to/config.inc
+
+[includeIf "gitdir:~/src/dir"]
+path = ~/path/to/conditional.inc
+
+[includeIf "gitdir:~/src/dir"]
+path = @git_include_path@

tests/modules/programs/git-with-email-expected.conf

@@ -0,0 +1,15 @@
+[sendemail "hm-account"]
+from=hm@example.org
+smtpEncryption=tls
+smtpServer=smtp.example.org
+smtpUser=home.manager.jr
+
+[sendemail "hm@example.com"]
+from=hm@example.com
+smtpEncryption=tls
+smtpServer=smtp.example.com
+smtpUser=home.manager
+
+[user]
+email=hm@example.com
+name=H. M. Test

tests/modules/programs/git-with-email.nix

@@ -0,0 +1,33 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+{
+  imports = [ ../accounts/email-test-accounts.nix ];
+
+  config = {
+    programs.git = {
+      enable = true;
+      userEmail = "hm@example.com";
+      userName = "H. M. Test";
+    };
+
+    nmt.script = ''
+      function assertGitConfig() {
+        local value
+        value=$(${pkgs.git}/bin/git config \
+          --file $TESTED/home-files/.config/git/config \
+          --get $1)
+        if [[ $value != $2 ]]; then
+          fail "Expected option '$1' to have value '$2' but it was '$value'"
+        fi
+      }
+
+      assertFileExists home-files/.config/git/config
+      assertFileContent home-files/.config/git/config ${./git-with-email-expected.conf}
+
+      assertGitConfig "sendemail.hm@example.com.from" "hm@example.com"
+      assertGitConfig "sendemail.hm-account.from" "hm@example.org"
+    '';
+  };
+}

tests/modules/programs/git-with-str-extra-config-expected.conf

@@ -0,0 +1,5 @@
+This can be anything.
+
+[user]
+email=user@example.org
+name=John Doe

tests/modules/programs/git-with-str-extra-config.nix

@@ -0,0 +1,22 @@
+{ config, lib, ... }:
+
+with lib;
+
+{
+  config = {
+    programs.git = {
+      enable = true;
+      extraConfig = ''
+        This can be anything.
+      '';
+      userEmail = "user@example.org";
+      userName = "John Doe";
+    };
+
+    nmt.script = ''
+      assertFileExists home-files/.config/git/config
+      assertFileContent home-files/.config/git/config \
+        ${./git-with-str-extra-config-expected.conf}
+    '';
+  };
+}

tests/modules/programs/git.nix

@@ -0,0 +1,70 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+let
+
+  gitInclude = {
+    user = {
+      name = "John Doe";
+      email = "user@example.org";
+    };
+  };
+
+  substituteExpected = path: pkgs.substituteAll {
+    src = path;
+
+    git_include_path = pkgs.writeText "contents" (generators.toINI {} gitInclude);
+  };
+
+in
+
+{
+  config = {
+    programs.git = mkMerge [
+      {
+        enable = true;
+        aliases = {
+          a1 = "foo";
+          a2 = "bar";
+        };
+        extraConfig = {
+          extra = {
+            name = "value";
+          };
+        };
+        ignores = [ "*~" "*.swp" ];
+        includes = [
+          { path = "~/path/to/config.inc"; }
+          {
+            path = "~/path/to/conditional.inc";
+            condition = "gitdir:~/src/dir";
+          }
+          {
+            condition = "gitdir:~/src/dir";
+            contents = gitInclude;
+          }
+        ];
+        signing = {
+          gpgPath = "path-to-gpg";
+          key = "00112233445566778899AABBCCDDEEFF";
+          signByDefault = true;
+        };
+        userEmail = "user@example.org";
+        userName = "John Doe";
+        lfs.enable = true;
+      }
+
+      {
+        aliases.a2 = mkForce "baz";
+        extraConfig.extra.boolean = true;
+        extraConfig.extra.integer = 38;
+      }
+    ];
+
+    nmt.script = ''
+      assertFileExists home-files/.config/git/config
+      assertFileContent home-files/.config/git/config ${substituteExpected ./git-expected.conf}
+    '';
+  };
+}

tests/modules/programs/mbsync-expected.conf

@@ -0,0 +1,55 @@
+# Generated by Home Manager.
+
+IMAPAccount hm-account
+CertificateFile /etc/ssl/certs/ca-certificates.crt
+Host imap.example.org
+PassCmd "password-command 2"
+SSLType IMAPS
+User home.manager.jr
+
+IMAPStore hm-account-remote
+Account hm-account
+
+MaildirStore hm-account-local
+Inbox /home/hm-user/Mail/hm-account/Inbox
+Path /home/hm-user/Mail/hm-account/
+SubFolders Verbatim
+
+Channel hm-account
+Create None
+Expunge None
+Master :hm-account-remote:
+Patterns *
+Remove None
+Slave :hm-account-local:
+SyncState *
+
+
+IMAPAccount hm@example.com
+CertificateFile /etc/ssl/certs/ca-certificates.crt
+Host imap.example.com
+PassCmd password-command
+SSLType IMAPS
+User home.manager
+
+IMAPStore hm@example.com-remote
+Account hm@example.com
+
+MaildirStore hm@example.com-local
+Inbox /home/hm-user/Mail/hm@example.com/Inbox
+Path /home/hm-user/Mail/hm@example.com/
+SubFolders Verbatim
+
+Channel hm@example.com
+Create None
+Expunge None
+Master :hm@example.com-remote:
+Patterns *
+Remove None
+Slave :hm@example.com-local:
+SyncState *
+
+
+Group inboxes
+Channel hm-account:Inbox
+Channel hm@example.com:Inbox1,Inbox2

tests/modules/programs/mbsync.nix

@@ -0,0 +1,35 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+{
+  imports = [ ../accounts/email-test-accounts.nix ];
+
+  config = {
+    home.username = "hm-user";
+    home.homeDirectory = "/home/hm-user";
+
+    programs.mbsync = {
+      enable = true;
+      groups.inboxes = {
+        "hm@example.com" = [ "Inbox1" "Inbox2" ];
+        hm-account = [ "Inbox" ];
+      };
+    };
+
+    accounts.email.accounts = {
+      "hm@example.com".mbsync = {
+        enable = true;
+      };
+
+      hm-account.mbsync = {
+        enable = true;
+      };
+    };
+
+    nmt.script = ''
+      assertFileExists home-files/.mbsyncrc
+      assertFileContent home-files/.mbsyncrc ${./mbsync-expected.conf}
+    '';
+  };
+}

tests/modules/programs/ssh/default-config-expected.conf

@@ -0,0 +1,15 @@
+
+
+
+
+Host *
+  ForwardAgent no
+  Compression no
+  ServerAliveInterval 0
+  HashKnownHosts no
+  UserKnownHostsFile ~/.ssh/known_hosts
+  ControlMaster no
+  ControlPath ~/.ssh/master-%r@%n:%p
+  ControlPersist no
+
+  

tests/modules/programs/ssh/default-config.nix

@@ -0,0 +1,16 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+{
+  config = {
+    programs.ssh = {
+      enable = true;
+    };
+
+    nmt.script = ''
+      assertFileExists home-files/.ssh/config
+      assertFileContent home-files/.ssh/config ${./default-config-expected.conf}
+    '';
+  };
+}

tests/modules/programs/ssh/default.nix

@@ -0,0 +1,4 @@
+{
+  ssh-defaults = ./default-config.nix;
+  ssh-match-blocks = ./match-blocks-attrs.nix;
+}

tests/modules/programs/ssh/match-blocks-attrs-expected.conf

@@ -0,0 +1,25 @@
+
+
+Host * !github.com
+  Port 516
+  IdentityFile file1
+  IdentityFile file2
+
+Host abc
+  ProxyJump jump-host
+
+Host xyz
+  ServerAliveInterval 60
+  IdentityFile file
+
+Host *
+  ForwardAgent no
+  Compression no
+  ServerAliveInterval 0
+  HashKnownHosts no
+  UserKnownHostsFile ~/.ssh/known_hosts
+  ControlMaster no
+  ControlPath ~/.ssh/master-%r@%n:%p
+  ControlPersist no
+
+  

tests/modules/programs/ssh/match-blocks-attrs.nix

@@ -0,0 +1,34 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+{
+  config = {
+    programs.ssh = {
+      enable = true;
+      matchBlocks = {
+        abc = {
+          identityFile = null;
+          proxyJump = "jump-host";
+        };
+
+        xyz = {
+          identityFile = "file";
+          serverAliveInterval = 60;
+        };
+
+        "* !github.com" = {
+          identityFile = ["file1" "file2"];
+          port = 516;
+        };
+      };
+    };
+
+    nmt.script = ''
+      assertFileExists home-files/.ssh/config
+      assertFileContent \
+        home-files/.ssh/config \
+        ${./match-blocks-attrs-expected.conf}
+    '';
+  };
+}

tests/modules/programs/texlive-minimal.nix

@@ -0,0 +1,13 @@
+{ config, lib, ... }:
+
+with lib;
+
+{
+  config = {
+    programs.texlive.enable = true;
+
+    nmt.script = ''
+      assertFileExists home-path/bin/tex
+    '';
+  };
+}

tests/modules/services/window-managers/i3-keybindings.nix

@@ -0,0 +1,34 @@
+{ config, lib, ... }:
+
+with lib;
+
+{
+  config = {
+    xsession.windowManager.i3 = {
+      enable = true;
+
+      config.keybindings =
+        let
+          modifier = config.xsession.windowManager.i3.config.modifier;
+        in
+          lib.mkOptionDefault {
+            "${modifier}+Left" = "overridden-command";
+            "${modifier}+Right" = null;
+            "${modifier}+Invented" = "invented-key-command";
+          };
+    };
+
+    nmt.script = ''
+      assertFileExists home-files/.config/i3/config
+
+      assertFileRegex home-files/.config/i3/config \
+        'bindsym Mod1+Left overridden-command'
+
+      assertFileNotRegex home-files/.config/i3/config \
+        'Mod1+Right'
+
+      assertFileRegex home-files/.config/i3/config \
+        'bindsym Mod1+Invented invented-key-command'
+    '';
+  };
+}

tests/modules/systemd/default.nix

@@ -0,0 +1,4 @@
+{
+  systemd-services = ./services.nix;
+  systemd-timers = ./timers.nix;
+}

tests/modules/systemd/services-expected.conf

@@ -0,0 +1,5 @@
+[Service]
+ExecStart=/some/exec/start/command --with-arguments "%i"
+
+[Unit]
+Description=A basic test service

tests/modules/systemd/services.nix

@@ -0,0 +1,23 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+{
+  config = {
+    systemd.user.services."test-service@" = {
+      Unit = {
+        Description = "A basic test service";
+      };
+
+      Service = {
+        ExecStart = ''/some/exec/start/command --with-arguments "%i"'';
+      };
+    };
+
+    nmt.script = ''
+      local serviceFile=home-files/.config/systemd/user/test-service@.service
+      assertFileExists $serviceFile
+      assertFileContent $serviceFile ${./services-expected.conf}
+    '';
+  };
+}

tests/modules/systemd/timers-expected.conf

@@ -0,0 +1,8 @@
+[Install]
+WantedBy=timers.target
+
+[Timer]
+OnUnitActiveSec=1h 30m
+
+[Unit]
+Description=A basic test timer

tests/modules/systemd/timers.nix

@@ -0,0 +1,31 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+{
+  config = {
+    systemd.user.timers.test-timer = {
+      Unit = {
+        Description = "A basic test timer";
+      };
+
+      Timer = {
+        OnUnitActiveSec = "1h 30m";
+      };
+
+      Install = {
+        WantedBy = [ "timers.target" ];
+      };
+    };
+
+    nmt.script = ''
+      local unitDir=home-files/.config/systemd/user
+      local timerFile=$unitDir/test-timer.timer
+
+      assertFileExists $timerFile
+      assertFileContent $timerFile ${./timers-expected.conf}
+
+      assertFileExists $unitDir/timers.target.wants/test-timer.timer
+    '';
+  };
+}