diff --git a/index.html b/index.html index 7fcd69e5c..fbf5b82d6 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
3. Writing Home Manager Modules
3.1. Option Types
4. Contributing
4.1. Getting started
4.2. Guidelines
4.2.1. Maintain backward compatibility
4.2.2. Keep forward compatibility in mind
4.2.3. Add only valuable options
4.2.4. Add relevant tests
4.2.5. Add relevant documentation
4.2.6. Add yourself as a module maintainer
4.2.7. Format your code
4.2.8. Format your commit messages
4.2.9. Format your news entries
4.2.10. Use conditional modules and news
4.2.11. Mind the license
4.3. Commits
4.4. Code Style
4.5. News
4.6. Tests
5. Frequently Asked Questions (FAQ)
5.1. Why is there a collision error when switching generation?
5.2. Why are the session variables not set?
5.3. How to set up a configuration for multiple users/machines?
5.4. Why do I get an error message about ca.desrt.dconf?
5.5. How do I install packages from Nixpkgs unstable?
5.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
3. Writing Home Manager Modules
3.1. Option Types
4. Contributing
4.1. Getting started
4.2. Guidelines
4.2.1. Maintain backward compatibility
4.2.2. Keep forward compatibility in mind
4.2.3. Add only valuable options
4.2.4. Add relevant tests
4.2.5. Add relevant documentation
4.2.6. Add yourself as a module maintainer
4.2.7. Format your code
4.2.8. Format your commit messages
4.2.9. Format your news entries
4.2.10. Use conditional modules and news
4.2.11. Mind the license
4.3. Commits
4.4. Code Style
4.5. News
4.6. Tests
5. Frequently Asked Questions (FAQ)
5.1. Why is there a collision error when switching generation?
5.2. Why are the session variables not set?
5.3. How to set up a configuration for multiple users/machines?
5.4. Why do I get an error message about ca.desrt.dconf?
5.5. How do I install packages from Nixpkgs unstable?
5.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 30ac2b072..bd250f33c 100644 --- a/options.html +++ b/options.html @@ -8224,6 +8224,47 @@ background "#cccccc" <home-manager/modules/services/status-notifier-watcher.nix>

services.status-notifier-watcher.package

The package to use for the status notifier watcher binary.

Type: package

Default: pkgs.haskellPackages.status-notifier-item

Example: pkgs.haskellPackages.status-notifier-item

Declared by:

<home-manager/modules/services/status-notifier-watcher.nix> +
services.swayidle.enable

Whether to enable Idle manager for Wayland.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/modules/services/swayidle.nix> +
services.swayidle.package

Swayidle package to install.

Type: package

Default: pkgs.swayidle

Declared by:

+ <home-manager/modules/services/swayidle.nix> +
services.swayidle.events

Run command on occurence of a event

Type: list of submodules

Default: + [ + + ] +

Example:

''
+[
+  { event = "before-sleep"; command = "swaylock"; }
+  { event = "lock"; command = "lock"; }
+]
+''

Declared by:

+ <home-manager/modules/services/swayidle.nix> +
services.swayidle.events.*.command

Command to run when event occurs

Type: string

Declared by:

+ <home-manager/modules/services/swayidle.nix> +
services.swayidle.events.*.event

Event name

Type: one of "before-sleep", "after-resume", "lock", "unlock"

Declared by:

+ <home-manager/modules/services/swayidle.nix> +
services.swayidle.extraArgs

Extra arguments to pass to swayidle

Type: list of strings

Default: + [ + + ] +

Declared by:

+ <home-manager/modules/services/swayidle.nix> +
services.swayidle.timeouts

List of commands to run after idle timeout

Type: list of submodules

Default: + [ + + ] +

Example:

''
+[
+  { timeout = 60; command = "swaylock -fF"; }
+]
+''

Declared by:

+ <home-manager/modules/services/swayidle.nix> +
services.swayidle.timeouts.*.command

Command to run after timeout seconds of inactivity

Type: string

Declared by:

+ <home-manager/modules/services/swayidle.nix> +
services.swayidle.timeouts.*.resumeCommand

Command to run when there is activity again

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/services/swayidle.nix> +
services.swayidle.timeouts.*.timeout

Timeout in seconds

Type: positive integer, meaning >0

Example: 60

Declared by:

+ <home-manager/modules/services/swayidle.nix>
services.sxhkd.enable

Whether to enable simple X hotkey daemon.

Type: boolean

Default: false

Example: true

Declared by:

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

Package containing the sxhkd executable.

Type: package

Default: "pkgs.sxhkd"

Declared by:

diff --git a/tools.html b/tools.html index c330722e8..d6bc4dd4b 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