diff --git a/index.html b/index.html index f4a49dc73..8f3a855a6 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. Writing Home Manager Modules
2.1. Option Types
3. Contributing
3.1. Getting started
3.2. Guidelines
3.2.1. Maintain backward compatibility
3.2.2. Keep forward compatibility in mind
3.2.3. Add only valuable options
3.2.4. Add relevant tests
3.2.5. Add relevant documentation
3.2.6. Add yourself as a module maintainer
3.2.7. Format your code
3.2.8. Format your commit messages
3.2.9. Format your news entries
3.2.10. Use conditional modules and news
3.2.11. Mind the license
3.3. Commits
3.4. Code Style
3.5. News
3.6. Tests
4. Frequently Asked Questions (FAQ)
4.1. Why is there a collision error when switching generation?
4.2. Why are the session variables not set?
4.3. How to set up a configuration for multiple users/machines?
4.4. Why do I get an error message about ca.desrt.dconf?
4.5. How do I install packages from Nixpkgs unstable?
4.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 21.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.09
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.03
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. 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. Writing Home Manager Modules
2.1. Option Types
3. Contributing
3.1. Getting started
3.2. Guidelines
3.2.1. Maintain backward compatibility
3.2.2. Keep forward compatibility in mind
3.2.3. Add only valuable options
3.2.4. Add relevant tests
3.2.5. Add relevant documentation
3.2.6. Add yourself as a module maintainer
3.2.7. Format your code
3.2.8. Format your commit messages
3.2.9. Format your news entries
3.2.10. Use conditional modules and news
3.2.11. Mind the license
3.3. Commits
3.4. Code Style
3.5. News
3.6. Tests
4. Frequently Asked Questions (FAQ)
4.1. Why is there a collision error when switching generation?
4.2. Why are the session variables not set?
4.3. How to set up a configuration for multiple users/machines?
4.4. Why do I get an error message about ca.desrt.dconf?
4.5. How do I install packages from Nixpkgs unstable?
4.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 21.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.09
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.03
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 18.09

Preface

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

diff --git a/options.html b/options.html index cbee19782..79f85499f 100644 --- a/options.html +++ b/options.html @@ -12359,7 +12359,7 @@ module to install Sway. <home-manager/modules/services/window-managers/i3-sway/sway.nix>

wayland.windowManager.sway.config.assigns

An attribute set that assigns applications to workspaces based on criteria. -

Type: attribute set of list of attribute set of stringsss

Default: +

Type: attribute set of list of attribute set of string or booleansss

Default: { @@ -12664,7 +12664,7 @@ This must to correspond to the value of the keybinding of the default workspace. 2

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> -
wayland.windowManager.sway.config.floating.criteria

List of criteria for windows that should be opened in a floating mode.

Type: list of attribute set of stringss

Default: +

wayland.windowManager.sway.config.floating.criteria

List of criteria for windows that should be opened in a floating mode.

Type: list of attribute set of string or booleanss

Default: [ @@ -13014,13 +13014,15 @@ See for_window swaywm option documentation. "border pixel 1"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> -
wayland.windowManager.sway.config.window.commands.*.criteria

Criteria of the windows on which command should be executed.

Type: attribute set of strings

Example: - - { - title = "x200: ~/work"; - } - -

Declared by:

+
wayland.windowManager.sway.config.window.commands.*.criteria

Criteria of the windows on which command should be executed. +

+A value of true is equivalent to using an empty +criteria (which is different from an empty string criteria). +

Type: attribute set of string or booleans

Example:

{
+  title = "x200: ~/work";
+  floating = true;
+};
+

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.window.hideEdgeBorders

Hide window borders adjacent to the screen edges.

Type: one of "none", "vertical", "horizontal", "both", "smart"

Default: "none" @@ -13887,7 +13889,7 @@ If 'i3.config.gaps' settings are specified, 'pkgs.i3-gaps' will be set as a defa <home-manager/modules/services/window-managers/i3-sway/i3.nix>

xsession.windowManager.i3.config.assigns

An attribute set that assigns applications to workspaces based on criteria. -

Type: attribute set of list of attribute set of stringsss

Default: +

Type: attribute set of list of attribute set of string or booleansss

Default: { @@ -14181,7 +14183,7 @@ This must to correspond to the value of the keybinding of the default workspace. 2

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> -
xsession.windowManager.i3.config.floating.criteria

List of criteria for windows that should be opened in a floating mode.

Type: list of attribute set of stringss

Default: +

xsession.windowManager.i3.config.floating.criteria

List of criteria for windows that should be opened in a floating mode.

Type: list of attribute set of string or booleanss

Default: [ @@ -14469,13 +14471,15 @@ See for_window i3wm option documentation. "border pixel 1"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> -
xsession.windowManager.i3.config.window.commands.*.criteria

Criteria of the windows on which command should be executed.

Type: attribute set of strings

Example: - - { - title = "x200: ~/work"; - } - -

Declared by:

+
xsession.windowManager.i3.config.window.commands.*.criteria

Criteria of the windows on which command should be executed. +

+A value of true is equivalent to using an empty +criteria (which is different from an empty string criteria). +

Type: attribute set of string or booleans

Example:

{
+  title = "x200: ~/work";
+  floating = true;
+};
+

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.window.hideEdgeBorders

Hide window borders adjacent to the screen edges.

Type: one of "none", "vertical", "horizontal", "both", "smart"

Default: "none" diff --git a/tools.html b/tools.html index a80752827..f72df2064 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 | @@ -82,7 +82,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.

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

-

Options

+

Options

The tool accepts the options

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

Activates verbose output. -

Files

+

Files

~/.local/share/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