diff --git a/index.html b/index.html index dc82554b..329a2244 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.05
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.11
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.05
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.09
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.03
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.09
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.03
E.7.1. Highlights
E.7.2. State Version Changes
E.8. 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.05
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.11
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.05
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.09
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.03
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.09
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.03
E.7.1. Highlights
E.7.2. State Version Changes
E.8. Release 18.09

Preface

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

diff --git a/options.html b/options.html index eeccb0c0..7b61ef60 100644 --- a/options.html +++ b/options.html @@ -995,6 +995,31 @@ version ≥ 19.09 and "" otherwise.

home.language.time

The language to use for formatting times.

Type: null or string

Default: null

Declared by:

<home-manager/modules/home-environment.nix> +
home.pointerCursor

Cursor configuration. Set to null to disable. +

+Top-level options declared under this submodule are backend indepedent +options. Options declared under namespaces such as x11 +are backend specific options. By default, only backend independent cursor +configurations are generated. If you need configurations for specific +backends, you can toggle them via the enable option. For example, +home.pointerCursor.x11.enable + will enable x11 cursor configurations. +

Type: null or submodule

Default: null

Declared by:

+ <home-manager/modules/config/home-cursor.nix> +
home.pointerCursor.package

Package providing the cursor theme.

Type: package

Example: pkgs.vanilla-dmz

Declared by:

+ <home-manager/modules/config/home-cursor.nix> +
home.pointerCursor.gtk.enable

Whether to enable gtk config generation for home.pointerCursor +.

Type: boolean

Default: false

Example: true

Declared by:

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

The cursor name within the package.

Type: string

Example: "Vanilla-DMZ"

Declared by:

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

The cursor size.

Type: signed integer

Default: 32

Example: 64

Declared by:

+ <home-manager/modules/config/home-cursor.nix> +
home.pointerCursor.x11.enable

Whether to enable x11 config generation for home.pointerCursor +.

Type: boolean

Default: false

Example: true

Declared by:

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

The default cursor file to use within the package.

Type: string

Default: "left_ptr"

Example: "X_cursor"

Declared by:

+ <home-manager/modules/config/home-cursor.nix>
home.profileDirectory

The profile directory where Home Manager generations are installed.

Type: path (read only)

Default:

"${home.homeDirectory}/.nix-profile"  or
 "/etc/profiles/per-user/${home.username}"
@@ -11374,22 +11399,14 @@ 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

The X cursor theme and settings. The package -xorg.xcursorthemes contains cursors named -whiteglass, redglass, and handhelds. The package -vanilla-dmz contains cursors named Vanilla-DMZ -and Vanilla-DMZ-AA. Note: handhelds does not seem to work at -custom sizes. -

Type: null or submodule

Default: null

Declared by:

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

Package providing the cursor theme.

Type: package

Example: pkgs.vanilla-dmz

Declared by:

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

The default cursor file to use within the package.

Type: string

Default: "left_ptr"

Example: "X_cursor"

Declared by:

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

The cursor name within the package.

Type: string

Example: "Vanilla-DMZ"

Declared by:

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

The cursor size.

Type: signed integer

Default: 32

Example: 64

Declared by:

- <home-manager/modules/xcursor.nix> +
xsession.pointerCursor.package

Alias of home.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:

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

Alias of home.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:

+ <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, not all tray applets or status bars support SNI. diff --git a/tools.html b/tools.html index c782c3d6..ea2a3991 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