From 106ea3b306de3d58d37270f7ca2b49399f32146c Mon Sep 17 00:00:00 2001 From: berbiche Date: Tue, 13 Sep 2022 20:07:47 +0000 Subject: [PATCH] deploy: 60c6bfe322944d04bb38e76b64effcbd01258824 --- index.html | 4 +- nix-darwin-options.html | 53 +------------------------ nixos-options.html | 53 +------------------------ options.html | 85 ++++++++++++----------------------------- tools.html | 14 +++---- 5 files changed, 36 insertions(+), 173 deletions(-) diff --git a/index.html b/index.html index b65af731..1ad997f9 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -Home Manager Manual
Home Manager Manual
   Next

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
   Next

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 44d9b665..9118f267 100644 --- a/nix-darwin-options.html +++ b/nix-darwin-options.html @@ -1,56 +1,5 @@ -Appendix C. nix-darwin Module Options

Appendix C. nix-darwin Module Options
Prev   Next

Appendix C. nix-darwin Module Options

_module.args

Additional arguments passed to each module in addition to ones -like lib, config, -and pkgs, modulesPath. -

-This option is also available to all submodules. Submodules do not -inherit args from their parent module, nor do they provide args to -their parent module or sibling submodules. The sole exception to -this is the argument name which is provided by -parent modules to a submodule and contains the attribute name -the submodule is bound to, or a unique generated name if it is -not bound to an attribute. -

-Some arguments are already passed by default, of which the -following cannot be changed with this option: -

  • - lib: The nixpkgs library. -

  • - config: The results of all options after merging the values from all modules together. -

  • - options: The options declared in all modules. -

  • - specialArgs: The specialArgs argument passed to evalModules. -

  • - All attributes of specialArgs -

    - Whereas option values can generally depend on other option values - thanks to laziness, this does not apply to imports, which - must be computed statically before anything else. -

    - For this reason, callers of the module system can provide specialArgs - which are available during import resolution. -

    - For NixOS, specialArgs includes - modulesPath, which allows you to import - extra modules from the nixpkgs package tree without having to - somehow make the module aware of the location of the - nixpkgs or NixOS directories. -

    -{ modulesPath, ... }: {
-  imports = [
-    (modulesPath + "/profiles/minimal.nix")
-  ];
-}
-

    -

-

-For NixOS, the default value for this option includes at least this argument: -

  • - pkgs: The nixpkgs package set according to - the nixpkgs.pkgs option. -

-

Type: lazy attribute set of raw value

Declared by:

+Appendix C. nix-darwin Module Options
Appendix C. nix-darwin Module Options
Prev   Next

Appendix C. nix-darwin Module Options

_module.args

Type: lazy attribute set of raw value

Declared by:

<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. diff --git a/nixos-options.html b/nixos-options.html index 9d6b125b..25f4efc7 100644 --- a/nixos-options.html +++ b/nixos-options.html @@ -1,56 +1,5 @@ -Appendix B. NixOS Module Options

Appendix B. NixOS Module Options
Prev   Next

Appendix B. NixOS Module Options

_module.args

Additional arguments passed to each module in addition to ones -like lib, config, -and pkgs, modulesPath. -

-This option is also available to all submodules. Submodules do not -inherit args from their parent module, nor do they provide args to -their parent module or sibling submodules. The sole exception to -this is the argument name which is provided by -parent modules to a submodule and contains the attribute name -the submodule is bound to, or a unique generated name if it is -not bound to an attribute. -

-Some arguments are already passed by default, of which the -following cannot be changed with this option: -

  • - lib: The nixpkgs library. -

  • - config: The results of all options after merging the values from all modules together. -

  • - options: The options declared in all modules. -

  • - specialArgs: The specialArgs argument passed to evalModules. -

  • - All attributes of specialArgs -

    - Whereas option values can generally depend on other option values - thanks to laziness, this does not apply to imports, which - must be computed statically before anything else. -

    - For this reason, callers of the module system can provide specialArgs - which are available during import resolution. -

    - For NixOS, specialArgs includes - modulesPath, which allows you to import - extra modules from the nixpkgs package tree without having to - somehow make the module aware of the location of the - nixpkgs or NixOS directories. -

    -{ modulesPath, ... }: {
-  imports = [
-    (modulesPath + "/profiles/minimal.nix")
-  ];
-}
-

    -

-

-For NixOS, the default value for this option includes at least this argument: -

  • - pkgs: The nixpkgs package set according to - the nixpkgs.pkgs option. -

-

Type: lazy attribute set of raw value

Declared by:

+Appendix B. NixOS Module Options
Appendix B. NixOS Module Options
Prev   Next

Appendix B. NixOS Module Options

_module.args

Type: lazy attribute set of raw value

Declared by:

<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. diff --git a/options.html b/options.html index 0f203800..fb44aff7 100644 --- a/options.html +++ b/options.html @@ -1,56 +1,5 @@ -Appendix A. Configuration Options

Appendix A. Configuration Options
Prev   Next

Appendix A. Configuration Options

_module.args

Additional arguments passed to each module in addition to ones -like lib, config, -and pkgs, modulesPath. -

-This option is also available to all submodules. Submodules do not -inherit args from their parent module, nor do they provide args to -their parent module or sibling submodules. The sole exception to -this is the argument name which is provided by -parent modules to a submodule and contains the attribute name -the submodule is bound to, or a unique generated name if it is -not bound to an attribute. -

-Some arguments are already passed by default, of which the -following cannot be changed with this option: -

  • - lib: The nixpkgs library. -

  • - config: The results of all options after merging the values from all modules together. -

  • - options: The options declared in all modules. -

  • - specialArgs: The specialArgs argument passed to evalModules. -

  • - All attributes of specialArgs -

    - Whereas option values can generally depend on other option values - thanks to laziness, this does not apply to imports, which - must be computed statically before anything else. -

    - For this reason, callers of the module system can provide specialArgs - which are available during import resolution. -

    - For NixOS, specialArgs includes - modulesPath, which allows you to import - extra modules from the nixpkgs package tree without having to - somehow make the module aware of the location of the - nixpkgs or NixOS directories. -

    -{ modulesPath, ... }: {
-  imports = [
-    (modulesPath + "/profiles/minimal.nix")
-  ];
-}
-

    -

-

-For NixOS, the default value for this option includes at least this argument: -

  • - pkgs: The nixpkgs package set according to - the nixpkgs.pkgs option. -

-

Type: lazy attribute set of raw value

Declared by:

+Appendix A. Configuration Options
Appendix A. Configuration Options
Prev   Next

Appendix A. Configuration Options

_module.args

Type: lazy attribute set of raw value

Declared by:

<home-manager/lib/modules.nix>
accounts.email.accounts

List of email accounts.

Type: attribute set of submodule

Default: { @@ -2707,7 +2656,7 @@ The possible attributes are: <home-manager/modules/programs/browserpass.nix>

programs.btop.enable

Whether to enable btop.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/btop.nix> -
programs.btop.package

The btop package to use.

Type: package

Default: pkgs.btop

Declared by:

+
programs.btop.package

Type: package

Default: pkgs.btop

Declared by:

<home-manager/modules/programs/btop.nix>
programs.btop.extraConfig

Extra lines added to the btop.conf file.

Type: strings concatenated with "\n"

Default: ""

Declared by:

@@ -5815,7 +5764,7 @@ use Python 3 plugins. <home-manager/modules/programs/newsboat.nix>
programs.nheko.enable

Whether to enable Qt desktop client for Matrix.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/nheko.nix> -
programs.nheko.package

The nheko package to use.

Type: package

Default: pkgs.nheko

Declared by:

+
programs.nheko.package

Type: package

Default: pkgs.nheko

Declared by:

<home-manager/modules/programs/nheko.nix>
programs.nheko.settings

Attribute set of Nheko preferences (converted to an INI file). @@ -7693,7 +7642,7 @@ manually set any options not listed above.

programs.vscode.enable

Whether to enable Visual Studio Code.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/vscode.nix>
programs.vscode.package

Version of Visual Studio Code to install. -

Type: package

Default: (build of vscode-1.70.2)

Example: pkgs.vscodium

Declared by:

+

Type: package

Default: (build of vscode-1.71.0)

Example: pkgs.vscodium

Declared by:

<home-manager/modules/programs/vscode.nix>
programs.vscode.extensions

The extensions Visual Studio Code should be started with.

Type: list of package

Default: @@ -8181,6 +8130,22 @@ if the first character is a space. <home-manager/modules/programs/zsh.nix>

programs.zsh.history.size

Number of history lines to keep.

Type: signed integer

Default: 10000

Declared by:

<home-manager/modules/programs/zsh.nix> +
programs.zsh.historySubstringSearch

Options related to zsh-history-substring-search.

Type: submodule

Default: + { + + } +

Declared by:

+ <home-manager/modules/programs/zsh.nix> +
programs.zsh.historySubstringSearch.enable

Whether to enable history substring search.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/modules/programs/zsh.nix> +
programs.zsh.historySubstringSearch.searchDownKey

The key code to be used when searching down. +The default of ^[[B corresponds to the DOWN key. +

Type: string

Default: "^[[B"

Declared by:

+ <home-manager/modules/programs/zsh.nix> +
programs.zsh.historySubstringSearch.searchUpKey

The key code to be used when searching up. +The default of ^[[A corresponds to the UP key. +

Type: string

Default: "^[[A"

Declared by:

+ <home-manager/modules/programs/zsh.nix>
programs.zsh.initExtra

Extra commands that should be added to .zshrc.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/programs/zsh.nix>
programs.zsh.initExtraBeforeCompInit

Extra commands that should be added to .zshrc before compinit.

Type: strings concatenated with "\n"

Default: ""

Declared by:

@@ -9923,7 +9888,7 @@ click-right=pavucontrol & <home-manager/modules/services/poweralertd.nix>
services.pueue.enable

Whether to enable Pueue, CLI process scheduler and manager.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/pueue.nix> -
services.pueue.package

The pueue package to use.

Type: package

Default: pkgs.pueue

Declared by:

+
services.pueue.package

Type: package

Default: pkgs.pueue

Declared by:

<home-manager/modules/services/pueue.nix>
services.pueue.settings

Configuration written to $XDG_CONFIG_HOME/pueue/pueue.yml. @@ -12101,13 +12066,13 @@ If this and all other xresources options are <home-manager/modules/xsession.nix>

xsession.numlock.enable

Whether to enable Num Lock.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/misc/numlock.nix> -
xsession.pointerCursor.package

Alias of home.pointerCursor.package.

Type: submodule

Declared by:

+
xsession.pointerCursor.package

Type: submodule

Declared by:

<home-manager/modules/config/home-cursor.nix> -
xsession.pointerCursor.defaultCursor

Alias of home.pointerCursor.x11.defaultCursor.

Type: submodule

Declared by:

+
xsession.pointerCursor.defaultCursor

Type: submodule

Declared by:

<home-manager/modules/config/home-cursor.nix> -
xsession.pointerCursor.name

Alias of home.pointerCursor.name.

Type: submodule

Declared by:

+
xsession.pointerCursor.name

Type: submodule

Declared by:

<home-manager/modules/config/home-cursor.nix> -
xsession.pointerCursor.size

Alias of home.pointerCursor.size.

Type: submodule

Declared by:

+
xsession.pointerCursor.size

Type: submodule

Declared by:

<home-manager/modules/config/home-cursor.nix>
xsession.preferStatusNotifierItems

Whether tray applets should prefer using the Status Notifier Items (SNI) protocol, commonly called App Indicators. Note, diff --git a/tools.html b/tools.html index 90143336..08b41663 100644 --- a/tools.html +++ b/tools.html @@ -1,6 +1,6 @@ -Appendix D. Tools

Appendix D. Tools
Prev   Next

Appendix D. Tools

home-manager - — reconfigure a user environment

Name

home-manager +Appendix D. Tools

Appendix D. Tools
Prev   Next

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)

Prev   Next
Appendix C. nix-darwin Module Options Home Appendix E. Release Notes
\ No newline at end of file