diff --git a/index.html b/index.html index f027d485c..d98954b60 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. Using Home Manager
2.1. Configuration Example
2.2. Rollbacks
2.3. Keeping your ~ safe from harm
2.4. Graphical services
2.5. Updating
3. Nix Flakes
3.1. Prerequisties
3.2. Standalone setup
3.3. NixOS module
3.4. nix-darwin module
4. Writing Home Manager Modules
4.1. Option Types
5. Contributing
5.1. Getting started
5.2. Guidelines
5.2.1. Maintain backward compatibility
5.2.2. Keep forward compatibility in mind
5.2.3. Add only valuable options
5.2.4. Add relevant tests
5.2.5. Add relevant documentation
5.2.6. Add yourself as a module maintainer
5.2.7. Format your code
5.2.8. Format your commit messages
5.2.9. Format your news entries
5.2.10. Use conditional modules and news
5.2.11. Mind the license
5.3. Commits
5.4. Code Style
5.5. News
5.6. Tests
6. Frequently Asked Questions (FAQ)
6.1. Why is there a collision error when switching generation?
6.2. Why are the session variables not set?
6.3. How to set up a configuration for multiple users/machines?
6.4. Why do I get an error message about ca.desrt.dconf or dconf.service?
6.5. How do I install packages from Nixpkgs unstable?
6.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 22.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 22.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.11
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 21.05
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 20.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.09
E.7.1. Highlights
E.7.2. State Version Changes
E.8. Release 19.03
E.8.1. Highlights
E.8.2. State Version Changes
E.9. 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. Using Home Manager
2.1. Configuration Example
2.2. Rollbacks
2.3. Keeping your ~ safe from harm
2.4. Graphical services
2.5. Updating
3. Nix Flakes
3.1. Prerequisties
3.2. Standalone setup
3.3. NixOS module
3.4. nix-darwin module
4. Writing Home Manager Modules
4.1. Option Types
5. Contributing
5.1. Getting started
5.2. Guidelines
5.2.1. Maintain backward compatibility
5.2.2. Keep forward compatibility in mind
5.2.3. Add only valuable options
5.2.4. Add relevant tests
5.2.5. Add relevant documentation
5.2.6. Add yourself as a module maintainer
5.2.7. Format your code
5.2.8. Format your commit messages
5.2.9. Format your news entries
5.2.10. Use conditional modules and news
5.2.11. Mind the license
5.3. Commits
5.4. Code Style
5.5. News
5.6. Tests
6. Frequently Asked Questions (FAQ)
6.1. Why is there a collision error when switching generation?
6.2. Why are the session variables not set?
6.3. How to set up a configuration for multiple users/machines?
6.4. Why do I get an error message about ca.desrt.dconf or dconf.service?
6.5. How do I install packages from Nixpkgs unstable?
6.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 22.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 22.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.11
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 21.05
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 20.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.09
E.7.1. Highlights
E.7.2. State Version Changes
E.8. Release 19.03
E.8.1. Highlights
E.8.2. State Version Changes
E.9. Release 18.09

Preface

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

diff --git a/nix-darwin-options.html b/nix-darwin-options.html index 53bc07f71..967f7611e 100644 --- a/nix-darwin-options.html +++ b/nix-darwin-options.html @@ -54,32 +54,39 @@ For NixOS, the default value for this option includes at least this argument: <home-manager/lib/modules.nix>

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> +

Type: null or string

Default: null

Example: "backup"

Declared by:

+ <home-manager/integration-common.nix>
home-manager.extraSpecialArgs

Extra specialArgs passed to Home Manager. This option can be used to pass additional arguments to all modules.

Type: attribute set

Default: { } -

Example: { inherit emacs-overlay; }

Declared by:

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

Example: { inherit emacs-overlay; }

Declared by:

+ <home-manager/integration-common.nix>
home-manager.sharedModules

Extra modules added to all users. -

Type: list of Home Manager modules

Default: +

Type: list of raw value

Default: [ ] -

Example: [ { home.packages = [ nixpkgs-fmt ]; } ]

Declared by:

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

Example: [ { home.packages = [ nixpkgs-fmt ]; } ]

Declared by:

+ <home-manager/integration-common.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> +.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/integration-common.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> +users.users.<name>.packages option +.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/integration-common.nix> +
home-manager.users

Per-user Home Manager configuration. +

Type: attribute set of Home Manager module

Default: + { + + } +

Declared by:

+ <home-manager/integration-common.nix> +
home-manager.verbose

Whether to enable verbose output on activation.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/integration-common.nix>
\ No newline at end of file diff --git a/nixos-options.html b/nixos-options.html index 385b5cf9a..e1032e6ef 100644 --- a/nixos-options.html +++ b/nixos-options.html @@ -54,32 +54,39 @@ For NixOS, the default value for this option includes at least this argument: <home-manager/lib/modules.nix>
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> +

Type: null or string

Default: null

Example: "backup"

Declared by:

+ <home-manager/integration-common.nix>
home-manager.extraSpecialArgs

Extra specialArgs passed to Home Manager. This option can be used to pass additional arguments to all modules.

Type: attribute set

Default: { } -

Example: { inherit emacs-overlay; }

Declared by:

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

Example: { inherit emacs-overlay; }

Declared by:

+ <home-manager/integration-common.nix>
home-manager.sharedModules

Extra modules added to all users. -

Type: list of Home Manager modules

Default: +

Type: list of raw value

Default: [ ] -

Example: [ { home.packages = [ nixpkgs-fmt ]; } ]

Declared by:

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

Example: [ { home.packages = [ nixpkgs-fmt ]; } ]

Declared by:

+ <home-manager/integration-common.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> +.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/integration-common.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> +.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/integration-common.nix> +
home-manager.users

Per-user Home Manager configuration. +

Type: attribute set of Home Manager module

Default: + { + + } +

Declared by:

+ <home-manager/integration-common.nix> +
home-manager.verbose

Whether to enable verbose output on activation.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/integration-common.nix>
\ No newline at end of file diff --git a/tools.html b/tools.html index 279e4b8ad..a553e6013 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 | @@ -84,7 +84,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.

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

-

Options

+

Options

The tool accepts the options

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

Activates verbose output. -

Files

+

Files

$XDG_DATA_HOME/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