diff --git a/index.html b/index.html index 1d0cd86d..af373894 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 do 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. Tools
home-manager - — reconfigure a user environment
C. Release Notes
C.1. Release 21.03
C.1.1. Highlights
C.1.2. State Version Changes
C.2. Release 20.09
C.2.1. Highlights
C.2.2. State Version Changes
C.3. Release 20.03
C.3.1. Highlights
C.3.2. State Version Changes
C.4. Release 19.09
C.4.1. Highlights
C.4.2. State Version Changes
C.5. Release 19.03
C.5.1. Highlights
C.5.2. State Version Changes
C.6. Release 18.09

Preface

+Home Manager Manual

Home Manager Manual


Preface

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

@@ -43,11 +43,12 @@ must be covered by the nix.allowedUsers system option.

  • -Add the Home Manager channel that you wish to follow. This is done -by running +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

    if you are following Nixpkgs master or an unstable channel and

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

    if you follow a Nixpkgs version 20.09 channel.

    On NixOS you may need to log out and back in for the channel to become +$ 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

    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).

  • Run the Home Manager installation command and create the first Home @@ -69,9 +70,10 @@ up additional possibilities, for example, to automatically configure user environments in NixOS declarative containers or on systems deployed through NixOps.

    To make the NixOS module available for use you must import it into your system configuration. This is most conveniently done by adding a -Home Manager channel, for example

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

    if you are following Nixpkgs master or an unstable channel and

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

    if you follow a Nixpkgs version 20.09 channel.

    It is then possible to add

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

    to your system configuration.nix file, which will introduce a new +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

    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;
     home-manager.users.eve = { pkgs, ... }: {
    @@ -91,9 +93,10 @@ environments directly from the home-manager
     tool.

    To make the NixOS module available for use you must import it into your system configuration. This is most conveniently done by adding a -Home Manager channel, for example

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

    if you are following Nixpkgs master or an unstable channel and

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

    if you follow a Nixpkgs version 20.09 channel.

    It is then possible to add

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

    to your nix-darwin configuration.nix file, which will introduce 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

    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, ... }: {
       home.packages = [ pkgs.atool pkgs.httpie ];
    diff --git a/tools.html b/tools.html
    index 3dc212de..0e21293a 100644
    --- a/tools.html
    +++ b/tools.html
    @@ -1,6 +1,6 @@
     
    -Appendix B. Tools

    Appendix B. Tools

    home-manager - — reconfigure a user environment

    Name

    home-manager +Appendix B. Tools

    Appendix B. Tools

    home-manager + — reconfigure a user environment

    Name

    home-manager — reconfigure a user environment

    Synopsis

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

    Description

    + ]

    Description

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

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

  • -

    Options

    +

    Options

    The tool accepts the options

    -A attrPath @@ -226,15 +226,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