diff --git a/index.html b/index.html index 22e89267..7d5a3efa 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -Home Manager Manual

Home Manager Manual


Preface
1. Installing Home Manager
1.1. Standalone installation
1.2. NixOS module
1.3. nix-darwin module
2. Writing Home Manager Modules
2.1. Option Types
3. Contributing
3.1. Getting started
3.2. Guidelines
3.2.1. Maintain backward compatibility
3.2.2. Keep forward compatibility in mind
3.2.3. Add only valuable options
3.2.4. Add relevant tests
3.2.5. Add relevant documentation
3.2.6. Add yourself as a module maintainer
3.2.7. Format your code
3.2.8. Format your commit messages
3.2.9. Format your news entries
3.2.10. Use conditional modules and news
3.2.11. Mind the license
3.3. Commits
3.4. Code Style
3.5. News
3.6. Tests
4. Frequently Asked Questions (FAQ)
4.1. Why is there a collision error when switching generation?
4.2. Why are the session variables not set?
4.3. How to set up a configuration for multiple users/machines?
4.4. Why do I get an error message about ca.desrt.dconf?
4.5. How do I install packages from Nixpkgs unstable?
4.6. How do I override the package used by a module?
A. Configuration Options
B. NixOS Module Options
C. nix-darwin Module Options
D. Tools
home-manager - — reconfigure a user environment
E. Release Notes
E.1. Release 21.05
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 20.09
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.03
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 19.09
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.03
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 18.09

Preface

+Home Manager Manual

Home Manager Manual


Preface
1. Installing Home Manager
1.1. Standalone installation
1.2. NixOS module
1.3. nix-darwin module
2. Writing Home Manager Modules
2.1. Option Types
3. Contributing
3.1. Getting started
3.2. Guidelines
3.2.1. Maintain backward compatibility
3.2.2. Keep forward compatibility in mind
3.2.3. Add only valuable options
3.2.4. Add relevant tests
3.2.5. Add relevant documentation
3.2.6. Add yourself as a module maintainer
3.2.7. Format your code
3.2.8. Format your commit messages
3.2.9. Format your news entries
3.2.10. Use conditional modules and news
3.2.11. Mind the license
3.3. Commits
3.4. Code Style
3.5. News
3.6. Tests
4. Frequently Asked Questions (FAQ)
4.1. Why is there a collision error when switching generation?
4.2. Why are the session variables not set?
4.3. How to set up a configuration for multiple users/machines?
4.4. Why do I get an error message about ca.desrt.dconf?
4.5. How do I install packages from Nixpkgs unstable?
4.6. How do I override the package used by a module?
A. Configuration Options
B. NixOS Module Options
C. nix-darwin Module Options
D. Tools
home-manager + — reconfigure a user environment
E. Release Notes
E.1. Release 21.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.09
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.03
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 18.09

Preface

This manual will eventually describes how to install, use, and extend Home Manager.

@@ -45,7 +45,7 @@ Add the Home Manager channel that you wish to follow. If you are following Nixpkgs master or an unstable channel then this is done by running

$ nix-channel --add https://github.com/nix-community/home-manager/archive/master.tar.gz home-manager
-$ nix-channel --update

and if you follow a Nixpkgs version 20.09 channel, you can run

$ nix-channel --add https://github.com/nix-community/home-manager/archive/release-20.09.tar.gz home-manager
+$ nix-channel --update

and if you follow a Nixpkgs version 21.05 channel, you can run

$ nix-channel --add https://github.com/nix-community/home-manager/archive/release-21.05.tar.gz home-manager
 $ nix-channel --update

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

export NIX_PATH=$HOME/.nix-defexpr/channels${NIX_PATH:+:}$NIX_PATH

to your shell (see nix#2033).

  • @@ -69,7 +69,7 @@ deployed through NixOps.

    To make the NixOS module available for use you mu your system configuration. This is most conveniently done by adding a Home Manager channel. For example, if you are following Nixpkgs master or an unstable channel, you can run

    # nix-channel --add https://github.com/nix-community/home-manager/archive/master.tar.gz home-manager
    -# nix-channel --update

    and if you follow a Nixpkgs version 20.09 channel, you can run

    # nix-channel --add https://github.com/nix-community/home-manager/archive/release-20.09.tar.gz home-manager
    +# nix-channel --update

    and if you follow a Nixpkgs version 21.05 channel, you can run

    # nix-channel --add https://github.com/nix-community/home-manager/archive/release-21.05.tar.gz home-manager
     # nix-channel --update

    It is then possible to add

    imports = [ <home-manager/nixos> ];

    to your system configuration.nix file, which will introduce a new NixOS option called home-manager.users whose type is an attribute set that maps user names to Home Manager configurations.

    For example, a NixOS configuration may include the lines

    users.users.eve.isNormalUser = true;
    @@ -92,7 +92,7 @@ tool.

    To make the NixOS module available for use you must # nix-channel --add https://github.com/nix-community/home-manager/archive/master.tar.gz home-manager -# nix-channel --update

    and if you follow a Nixpkgs version 20.09 channel, you can run

    # nix-channel --add https://github.com/nix-community/home-manager/archive/release-20.09.tar.gz home-manager
    +# nix-channel --update

    and if you follow a Nixpkgs version 21.05 channel, you can run

    # nix-channel --add https://github.com/nix-community/home-manager/archive/release-21.05.tar.gz home-manager
     # nix-channel --update

    It is then possible to add

    imports = [ <home-manager/nix-darwin> ];

    to your nix-darwin configuration.nix file, which will introduce a new NixOS option called home-manager whose type is an attribute set that maps user names to Home Manager configurations.

    For example, a nix-darwin configuration may include the lines

    home-manager.users.eve = { pkgs, ... }: {
    diff --git a/options.html b/options.html
    index 1f464355..55fef397 100644
    --- a/options.html
    +++ b/options.html
    @@ -1280,7 +1280,7 @@ settings are in effect and will therefore help avoid breaking
     program configurations. Switching to a higher state version
     typically requires performing some manual steps, such as data
     conversion or moving files.
    -

    Type: one of "18.09", "19.03", "19.09", "20.03", "20.09", "21.03", "21.05"

    Default: +

    Type: one of "18.09", "19.03", "19.09", "20.03", "20.09", "21.03", "21.05", "21.11"

    Default: "18.09"

    Declared by:

    <home-manager/modules/misc/version.nix> diff --git a/release-notes.html b/release-notes.html index 108849c5..e1c367a1 100644 --- a/release-notes.html +++ b/release-notes.html @@ -1,6 +1,12 @@ -Appendix E. Release Notes

    Release Notes

    This section lists the release notes for stable versions of Home Manager and the current unstable version.

    E.1. Release 21.05

    This is the current unstable branch and the information in this -section is therefore not final.

    E.1.1. Highlights

    This release has the following notable changes:

    E.2.2. State Version Changes

    The state version in this release includes the changes below. These changes are only active if the home.stateVersion option is set to "21.05" or later.

    • The newsboat module now stores generated configuration in $XDG_CONFIG_HOME/newsboat. -

    E.2. Release 20.09

    The 20.09 release branch became the stable branch in late September, 2020.

    E.2.1. Highlights

    This release has the following notable changes:

    • +

    E.3. Release 20.09

    The 20.09 release branch became the stable branch in late September, 2020.

    E.3.1. Highlights

    This release has the following notable changes:

    • Nothing has happened. -

    E.2.2. State Version Changes

    The state version in this release includes the changes below. These +

    E.3.2. State Version Changes

    The state version in this release includes the changes below. These changes are only active if the home.stateVersion option is set to "20.09" or later.

    • The options home.homeDirectory and home.username no @@ -173,7 +179,7 @@ The options wayland.windowManager.sway.config.bars binding_mode #2f343a #900000 #ffffff } -}

    E.3. Release 20.03

    The 20.03 release branch became the stable branch in April, 2020.

    E.3.1. Highlights

    This release has the following notable changes:

    • +}

    E.4. Release 20.03

    The 20.03 release branch became the stable branch in April, 2020.

    E.4.1. Highlights

    This release has the following notable changes:

    • Assigning a list to the home.file, xdg.configFile, and xdg.dataFile options is now deprecated and will produce a warning message if used. Specifically, if your configuration currently @@ -229,7 +235,7 @@ configuration user = "jd"; } };

      Support for the list form will be removed in Home Manager version -20.09.

    E.3.2. State Version Changes

    The state version in this release includes the changes below. These +20.09.

    E.4.2. State Version Changes

    The state version in this release includes the changes below. These changes are only active if the home.stateVersion option is set to "20.03" or later.

    E.4. Release 19.09

    The 19.09 release branch became the stable branch in October, 2019.

    E.4.1. Highlights

    This release has the following notable changes:

    • +

    E.5. Release 19.09

    The 19.09 release branch became the stable branch in October, 2019.

    E.5.1. Highlights

    This release has the following notable changes:

    • The programs.firefox.enableGoogleTalk and programs.firefox.enableIcedTea options are now deprecated and will only work if Firefox ESR 52.x is used. @@ -249,7 +255,7 @@ The programs.firefox.enableGoogleTalk and The home-manager tool now provides an uninstall sub-command that can be used to uninstall Home Manager, if used in the standalone mode. That is, not as a NixOS module. -

    E.4.2. State Version Changes

    The state version in this release includes the changes below. These +

    E.5.2. State Version Changes

    The state version in this release includes the changes below. These changes are only active if the home.stateVersion option is set to "19.09" or later.

    E.5. Release 19.03

    The 19.03 release branch became the stable branch in April, 2019.

    E.5.1. Highlights

    This release has the following notable changes:

    • +

    E.6. Release 19.03

    The 19.03 release branch became the stable branch in April, 2019.

    E.6.1. Highlights

    This release has the following notable changes:

    • The home.file.<name>.source option now allows source files to be hidden, that is, having a name starting with the . character. It also allows the source file name to contain characters not typically @@ -275,10 +281,10 @@ encounter errors. “defined multiple times” then you need to use the mkForce function. For example,

      systemd.user.services.foo.Service.ExecStart = "/foo/bar";

      becomes

      systemd.user.services.foo.Service.ExecStart = lib.mkForce "/foo/bar";

      We had to make this change because the old merging was causing too -many confusing situations for people.

    E.5.2. State Version Changes

    The state version in this release includes the changes below. These +many confusing situations for people.

    E.6.2. State Version Changes

    The state version in this release includes the changes below. These changes are only active if the home.stateVersion option is set to “19.03” or later.

    E.6. Release 18.09

    The 18.09 release branch became the stable branch in September, 2018.

    \ No newline at end of file +

    E.7. Release 18.09

    The 18.09 release branch became the stable branch in September, 2018.

    \ No newline at end of file diff --git a/tools.html b/tools.html index 21f90b51..9f7c3241 100644 --- a/tools.html +++ b/tools.html @@ -1,6 +1,6 @@ -Appendix D. Tools

    Appendix D. Tools

    home-manager - — reconfigure a user environment

    Name

    home-manager +Appendix D. Tools

    Appendix D. Tools

    home-manager + — reconfigure a user environment

    Name

    home-manager — reconfigure a user environment

    Synopsis

    home-manager { build | @@ -74,7 +74,7 @@ | --verbose } - ]

    Description

    + ]

    Description

    This command updates the user environment so that it corresponds to the configuration specified in ~/.config/nixpkgs/home.nix or ~/.config/nixpkgs/flake.nix.

    @@ -139,7 +139,7 @@ available for immediate garbage collection.

    -

    Options

    +

    Options

    The tool accepts the options

    -A attrPath @@ -234,15 +234,15 @@ --verbose

    Activates verbose output. -

    Files

    +

    Files

    ~/.local/share/home-manager/news-read-ids

    Identifiers of news items that have been shown. Can be deleted to reset the read news indicator. -

    Bugs

    +

    Bugs

    Please report any bugs on the project issue tracker. -

    See also

    +

    See also

    home-configuration.nix(5)

    \ No newline at end of file