diff --git a/index.html b/index.html index 10a61a871..1fb67568e 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/options.html b/options.html index 30b06c0eb..917673526 100644 --- a/options.html +++ b/options.html @@ -9431,7 +9431,14 @@ beginning of the file. For available options see

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/services/mpd.nix>
services.mpd.musicDirectory

The directory where mpd reads music from. -

Type: path or string

Default: "$HOME/music"

Declared by:

+

+If xdg.userDirs.enable is +true then the defined XDG music directory is used. +Otherwise, you must explicitly specify a value. +

Type: path or string

Default:

${home.homeDirectory}/music    if state version < 22.11
+${xdg.userDirs.music}          if xdg.userDirs.enable == true
+undefined                      otherwise
+

Declared by:

<home-manager/modules/services/mpd.nix>
services.mpd.network.listenAddress

The address for the daemon to listen on. Use any to listen on all addresses. @@ -12010,26 +12017,26 @@ The generated file is read-only. <home-manager/modules/misc/xdg-user-dirs.nix>

xdg.userDirs.createDirectories

Whether to enable automatic creation of the XDG user directories.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix> -
xdg.userDirs.desktop

The Desktop directory.

Type: string or path convertible to it

Default: "$HOME/Desktop"

Declared by:

+
xdg.userDirs.desktop

The Desktop directory.

Type: string or path convertible to it

Default: "${config.home.homeDirectory}/Desktop"

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix> -
xdg.userDirs.documents

The Documents directory.

Type: string or path convertible to it

Default: "$HOME/Documents"

Declared by:

+
xdg.userDirs.documents

The Documents directory.

Type: string or path convertible to it

Default: "${config.home.homeDirectory}/Documents"

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix> -
xdg.userDirs.download

The Downloads directory.

Type: string or path convertible to it

Default: "$HOME/Downloads"

Declared by:

+
xdg.userDirs.download

The Downloads directory.

Type: string or path convertible to it

Default: "${config.home.homeDirectory}/Downloads"

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix>
xdg.userDirs.extraConfig

Other user directories.

Type: attribute set of string or path convertible to it

Default: { }

Example:

{
-  XDG_MISC_DIR = "$HOME/Misc";
+  XDG_MISC_DIR = "${config.home.homeDirectory}/Misc";
 }
 

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix> -
xdg.userDirs.music

The Music directory.

Type: string or path convertible to it

Default: "$HOME/Music"

Declared by:

+
xdg.userDirs.music

The Music directory.

Type: string or path convertible to it

Default: "${config.home.homeDirectory}/Music"

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix> -
xdg.userDirs.pictures

The Pictures directory.

Type: string or path convertible to it

Default: "$HOME/Pictures"

Declared by:

+
xdg.userDirs.pictures

The Pictures directory.

Type: string or path convertible to it

Default: "${config.home.homeDirectory}/Pictures"

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix> -
xdg.userDirs.publicShare

The Public share directory.

Type: string or path convertible to it

Default: "$HOME/Public"

Declared by:

+
xdg.userDirs.publicShare

The Public share directory.

Type: string or path convertible to it

Default: "${config.home.homeDirectory}/Public"

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix> -
xdg.userDirs.templates

The Templates directory.

Type: string or path convertible to it

Default: "$HOME/Templates"

Declared by:

+
xdg.userDirs.templates

The Templates directory.

Type: string or path convertible to it

Default: "${config.home.homeDirectory}/Templates"

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix> -
xdg.userDirs.videos

The Videos directory.

Type: string or path convertible to it

Default: "$HOME/Videos"

Declared by:

+
xdg.userDirs.videos

The Videos directory.

Type: string or path convertible to it

Default: "${config.home.homeDirectory}/Videos"

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix>
xresources.extraConfig

Additional X server resources contents. If this and all other xresources options are diff --git a/release-notes.html b/release-notes.html index bf4ca6377..501259db1 100644 --- a/release-notes.html +++ b/release-notes.html @@ -56,7 +56,10 @@ The services.compton module has been removed. It wa release 20.03. Use services.picom instead.

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

E.2. Release 22.05

The 22.05 release branch became the stable branch in May, 2022.

E.2.1. Highlights

This release has the following notable changes:

  • The programs.waybar.settings.modules option was removed. Waybar modules should now be declared directly under programs.waybar.settings. diff --git a/tools.html b/tools.html index d9e053531..80d51fb4c 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