diff --git a/index.html b/index.html index 2a4df6ab..bab887d2 100644 --- a/index.html +++ b/index.html @@ -1,14 +1,12 @@ -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

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

If you encounter problems then please reach out on the IRC channel - #home-manager - hosted by freenode. - The channel logs - are hosted courtesy of samueldr. + #home-manager + hosted by OFTC. If your problem is caused by a bug in Home Manager then it should be reported on the Home Manager issue tracker. @@ -243,7 +241,7 @@ overriding the default path by using the -I command

$ home-manager -I home-manager=$HOME/devel/home-manager

or

  • changing the default path by ensuring your configuration includes

    programs.home-manager.enable = true;
    -programs.home-manager.path = "$HOME/devel/home-manager";

    and running home-manager switch to activate the change. Afterwards, home-manager build and home-manager switch will use your cloned repository.

  • The first option is good if you only temporarily want to use your clone.

    3.2. Guidelines

    If your contribution satisfy the following rules then there is a good chance it will be merged without too much trouble. The rules are enforced by the Home Manager maintainers and to a lesser extent the Home Manager CI system.

    If you are uncertain how these rules affect the change you would like to make then feel free to start a discussion in the #home-manager IRC channel, ideally before you start developing.

    3.2.1. Maintain backward compatibility

    Your contribution should not cause another user’s existing configuration to break unless there is a very good reason and the change should be announced to the user through an assertion or similar.

    Remember that Home Manager is used in many different environments and you should consider how your change may effect others. For example,

    • +programs.home-manager.path = "$HOME/devel/home-manager";

      and running home-manager switch to activate the change. Afterwards, home-manager build and home-manager switch will use your cloned repository.

    The first option is good if you only temporarily want to use your clone.

    3.2. Guidelines

    If your contribution satisfy the following rules then there is a good chance it will be merged without too much trouble. The rules are enforced by the Home Manager maintainers and to a lesser extent the Home Manager CI system.

    If you are uncertain how these rules affect the change you would like to make then feel free to start a discussion in the #home-manager IRC channel, ideally before you start developing.

    3.2.1. Maintain backward compatibility

    Your contribution should not cause another user’s existing configuration to break unless there is a very good reason and the change should be announced to the user through an assertion or similar.

    Remember that Home Manager is used in many different environments and you should consider how your change may effect others. For example,

    • Does your change work for people that do not use NixOS? Consider other GNU/Linux distributions and macOS.
    • Does your change work for people whose configuration is built on one system and deployed on another system? diff --git a/tools.html b/tools.html index d18549a9..fcd98cba 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