diff --git a/index.html b/index.html index eceaf08b1..440213b00 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.

diff --git a/nix-darwin-options.html b/nix-darwin-options.html new file mode 100644 index 000000000..aca8d976d --- /dev/null +++ b/nix-darwin-options.html @@ -0,0 +1,33 @@ + +Appendix C. nix-darwin Module Options

Appendix C. nix-darwin Module Options

home-manager.backupFileExtension

On activation move existing files by appending the given +file extension rather than exiting with an error. +

Type: null or string

Default: + null +

Example: + "backup" +

Declared by:

+ <home-manager/nix-darwin/default.nix> +
home-manager.useGlobalPkgs

Whether to enable using the system configuration's pkgs +argument in Home Manager. This disables the Home Manager +options nixpkgs.* +.

Type: boolean

Default: + false +

Example: + true +

Declared by:

+ <home-manager/nix-darwin/default.nix> +
home-manager.useUserPackages

Whether to enable installation of user packages through the +users.users.<name?>.packages option. +.

Type: boolean

Default: + false +

Example: + true +

Declared by:

+ <home-manager/nix-darwin/default.nix> +
home-manager.verbose

Whether to enable verbose output on activation.

Type: boolean

Default: + false +

Example: + true +

Declared by:

+ <home-manager/nix-darwin/default.nix> +
\ No newline at end of file diff --git a/nixos-options.html b/nixos-options.html new file mode 100644 index 000000000..625563ffe --- /dev/null +++ b/nixos-options.html @@ -0,0 +1,33 @@ + +Appendix B. NixOS Module Options

Appendix B. NixOS Module Options

home-manager.backupFileExtension

On activation move existing files by appending the given +file extension rather than exiting with an error. +

Type: null or string

Default: + null +

Example: + "backup" +

Declared by:

+ <home-manager/nixos/default.nix> +
home-manager.useGlobalPkgs

Whether to enable using the system configuration's pkgs +argument in Home Manager. This disables the Home Manager +options nixpkgs.* +.

Type: boolean

Default: + false +

Example: + true +

Declared by:

+ <home-manager/nixos/default.nix> +
home-manager.useUserPackages

Whether to enable installation of user packages through the +users.users.<name>.packages option. +.

Type: boolean

Default: + false +

Example: + true +

Declared by:

+ <home-manager/nixos/default.nix> +
home-manager.verbose

Whether to enable verbose output on activation.

Type: boolean

Default: + false +

Example: + true +

Declared by:

+ <home-manager/nixos/default.nix> +
\ No newline at end of file diff --git a/options.html b/options.html index 9a25776bc..670c88c96 100644 --- a/options.html +++ b/options.html @@ -1,5 +1,5 @@ -Appendix A. Configuration Options

Appendix A. Configuration Options

accounts.email.accounts

List of email accounts.

Type: attribute set of submodules

Default: +Appendix A. Configuration Options

Appendix A. Configuration Options

accounts.email.accounts

List of email accounts.

Type: attribute set of submodules

Default: { @@ -12675,4 +12675,4 @@ version used to build xmonad and the packages listed in pkgs.haskellPackages

Example:

pkgs.haskell.packages.ghc784

Declared by:

<home-manager/modules/services/window-managers/xmonad.nix> -
\ No newline at end of file +
\ No newline at end of file diff --git a/release-notes.html b/release-notes.html index 6a7cd74c7..b47628a0d 100644 --- a/release-notes.html +++ b/release-notes.html @@ -1,6 +1,6 @@ -Appendix C. Release Notes

Release Notes

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

C.1. Release 21.03

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

C.1.1. Highlights

This release has the following notable changes:

E.1.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.03" or later.

  • Nothing has happened. -

C.2. Release 20.09

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

C.2.1. Highlights

This release has the following notable changes:

  • +

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:

  • Nothing has happened. -

C.2.2. State Version Changes

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

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 "20.09" or later.

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

C.3. Release 20.03

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

C.3.1. Highlights

This release has the following notable changes:

  • +}

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:

  • 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 @@ -122,7 +122,7 @@ configuration user = "jd"; } };

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

C.3.2. State Version Changes

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

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.03" or later.

C.4. Release 19.09

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

C.4.1. Highlights

This release has the following notable changes:

  • +

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:

  • The programs.firefox.enableGoogleTalk and programs.firefox.enableIcedTea options are now deprecated and will only work if Firefox ESR 52.x is used. @@ -142,7 +142,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. -

C.4.2. State Version Changes

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

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 "19.09" or later.

C.5. Release 19.03

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

C.5.1. Highlights

This release has the following notable changes:

  • +

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:

  • 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 @@ -168,10 +168,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.

C.5.2. State Version Changes

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

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.03” or later.

C.6. Release 18.09

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

\ No newline at end of file +

E.6. 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 832229cd2..10a5c3ebc 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 D. Tools

Appendix D. 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 +

\ No newline at end of file