diff --git a/index.html b/index.html index 64db637a9..3f2cb3acf 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. 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.05
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 20.09
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.03
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 19.09
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.03
E.5.1. Highlights
E.5.2. State Version Changes
E.6. 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. 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.05
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 20.09
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.03
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 19.09
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.03
E.5.1. Highlights
E.5.2. State Version Changes
E.6. 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 ae155ef98..09167ac44 100644 --- a/options.html +++ b/options.html @@ -11305,15 +11305,7 @@ on criteria. <home-manager/modules/services/window-managers/i3-sway/sway.nix>

wayland.windowManager.sway.config.bars

Sway bars settings blocks. Set to empty list to remove bars completely.

Type: list of submodules

Default: - - [ - - { - - } - - ] - + see code

Declared by:

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

Bar color settings. All color classes can be specified using submodules @@ -11331,57 +11323,85 @@ See Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.bars.*.colors.activeWorkspace

Border, background and text color for a workspace button when the workspace is active. -

Type: submodule

Default: - See code for state version < 20.09, -null for state version ≥ 20.09 +

Type: null or submodule

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + + { + background = "#5f676a"; border = "#333333"; text = "#ffffff"; + } +

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> -
wayland.windowManager.sway.config.bars.*.colors.background

Background color of the bar.

Type: string

Default: - #000000 for state version < 20.09, -null for state version ≥ 20.09 +

wayland.windowManager.sway.config.bars.*.colors.background

Background color of the bar.

Type: null or string

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + "#000000"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> -
wayland.windowManager.sway.config.bars.*.colors.bindingMode

Border, background and text color for the binding mode indicator

Type: submodule

Default: - See code for state version < 20.09, -null for state version ≥ 20.09 +

wayland.windowManager.sway.config.bars.*.colors.bindingMode

Border, background and text color for the binding mode indicator

Type: null or submodule

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + + { + background = "#900000"; border = "#2f343a"; text = "#ffffff"; + } +

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.bars.*.colors.focusedWorkspace

Border, background and text color for a workspace button when the workspace has focus. -

Type: submodule

Default: - See code for state version < 20.09, -null for state version ≥ 20.09 +

Type: null or submodule

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + + { + background = "#285577"; border = "#4c7899"; text = "#ffffff"; + } +

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.bars.*.colors.inactiveWorkspace

Border, background and text color for a workspace button when the workspace does not have focus and is not active. -

Type: submodule

Default: - See code for state version < 20.09, -null for state version ≥ 20.09 +

Type: null or submodule

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + + { + background = "#222222"; border = "#333333"; text = "#888888"; + } +

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> -
wayland.windowManager.sway.config.bars.*.colors.separator

Text color to be used for the separator.

Type: string

Default: - #666666 for state version < 20.09, -null for state version ≥ 20.09 +

wayland.windowManager.sway.config.bars.*.colors.separator

Text color to be used for the separator.

Type: null or string

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + "#666666"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> -
wayland.windowManager.sway.config.bars.*.colors.statusline

Text color to be used for the statusline.

Type: string

Default: - #ffffff for state version < 20.09, -null for state version ≥ 20.09 +

wayland.windowManager.sway.config.bars.*.colors.statusline

Text color to be used for the statusline.

Type: null or string

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + "#ffffff"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.bars.*.colors.urgentWorkspace

Border, background and text color for a workspace button when the workspace contains a window with the urgency hint set. -

Type: submodule

Default: - See code for state version < 20.09, -null for state version ≥ 20.09 +

Type: null or submodule

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + + { + background = "#900000"; border = "#2f343a"; text = "#ffffff"; + } +

Declared by:

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

Command that will be used to start a bar.

Type: string

Default: @@ -11407,10 +11427,11 @@ null for state version ≥ 20.09 }

Declared by:

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

The default bar mode when 'bar.mode' == 'hide'.

Type: one of "hide", "show"

Default: - hide for state version < 20.09, -null for state version ≥ 20.09 +

wayland.windowManager.sway.config.bars.*.hiddenState

The default bar mode when 'bar.mode' == 'hide'.

Type: null or one of "hide", "show"

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + "hide"

Declared by:

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

Specifies the bar ID for the configured bar instance. @@ -11420,40 +11441,46 @@ to the position of the embedding bar block in the config file. null

Declared by:

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

Bar visibility mode.

Type: one of "dock", "hide", "invisible"

Default: - dock for state version < 20.09, -null for state version ≥ 20.09 +

wayland.windowManager.sway.config.bars.*.mode

Bar visibility mode.

Type: null or one of "dock", "hide", "invisible"

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + "dock"

Declared by:

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

The edge of the screen swaybar should show up.

Type: one of "top", "bottom"

Default: - bottom for state version < 20.09, -null for state version ≥ 20.09 +

wayland.windowManager.sway.config.bars.*.position

The edge of the screen swaybar should show up.

Type: null or one of "top", "bottom"

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + "bottom"

Declared by:

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

Command that will be used to get status lines.

Type: null or string

Default: - "\${pkgs.i3status}/bin/i3status" + null for state version ≥ 20.09, as example otherwise +

Example: - "i3status" + "\${pkgs.i3status}/bin/i3status"

Declared by:

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

Where to output tray.

Type: string

Default: - primary for state version < 20.09, -null for state version ≥ 20.09 +

wayland.windowManager.sway.config.bars.*.trayOutput

Where to output tray.

Type: null or string

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + "primary"

Declared by:

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

Whether workspace buttons should be shown or not.

Type: boolean

Default: - See code for state version < 20.09, -null for state version ≥ 20.09 +

wayland.windowManager.sway.config.bars.*.workspaceButtons

Whether workspace buttons should be shown or not.

Type: null or boolean

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + true

Declared by:

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

Whether workspace numbers should be displayed within the workspace buttons.

Type: boolean

Default: - See code for state version < 20.09, -null for state version ≥ 20.09 +

wayland.windowManager.sway.config.bars.*.workspaceNumbers

Whether workspace numbers should be displayed within the workspace buttons.

Type: null or boolean

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + true

Declared by:

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

Whether to make use of --to-code in keybindings. @@ -12628,15 +12655,7 @@ on criteria. <home-manager/modules/services/window-managers/i3-sway/i3.nix>

xsession.windowManager.i3.config.bars

i3 bars settings blocks. Set to empty list to remove bars completely.

Type: list of submodules

Default: - - [ - - { - - } - - ] - + see code

Declared by:

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

Bar color settings. All color classes can be specified using submodules @@ -12654,57 +12673,85 @@ See Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.bars.*.colors.activeWorkspace

Border, background and text color for a workspace button when the workspace is active. -

Type: submodule

Default: - See code for state version < 20.09, -null for state version ≥ 20.09 +

Type: null or submodule

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + + { + background = "#5f676a"; border = "#333333"; text = "#ffffff"; + } +

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> -
xsession.windowManager.i3.config.bars.*.colors.background

Background color of the bar.

Type: string

Default: - #000000 for state version < 20.09, -null for state version ≥ 20.09 +

xsession.windowManager.i3.config.bars.*.colors.background

Background color of the bar.

Type: null or string

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + "#000000"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> -
xsession.windowManager.i3.config.bars.*.colors.bindingMode

Border, background and text color for the binding mode indicator

Type: submodule

Default: - See code for state version < 20.09, -null for state version ≥ 20.09 +

xsession.windowManager.i3.config.bars.*.colors.bindingMode

Border, background and text color for the binding mode indicator

Type: null or submodule

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + + { + background = "#900000"; border = "#2f343a"; text = "#ffffff"; + } +

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.bars.*.colors.focusedWorkspace

Border, background and text color for a workspace button when the workspace has focus. -

Type: submodule

Default: - See code for state version < 20.09, -null for state version ≥ 20.09 +

Type: null or submodule

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + + { + background = "#285577"; border = "#4c7899"; text = "#ffffff"; + } +

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.bars.*.colors.inactiveWorkspace

Border, background and text color for a workspace button when the workspace does not have focus and is not active. -

Type: submodule

Default: - See code for state version < 20.09, -null for state version ≥ 20.09 +

Type: null or submodule

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + + { + background = "#222222"; border = "#333333"; text = "#888888"; + } +

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> -
xsession.windowManager.i3.config.bars.*.colors.separator

Text color to be used for the separator.

Type: string

Default: - #666666 for state version < 20.09, -null for state version ≥ 20.09 +

xsession.windowManager.i3.config.bars.*.colors.separator

Text color to be used for the separator.

Type: null or string

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + "#666666"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> -
xsession.windowManager.i3.config.bars.*.colors.statusline

Text color to be used for the statusline.

Type: string

Default: - #ffffff for state version < 20.09, -null for state version ≥ 20.09 +

xsession.windowManager.i3.config.bars.*.colors.statusline

Text color to be used for the statusline.

Type: null or string

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + "#ffffff"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.bars.*.colors.urgentWorkspace

Border, background and text color for a workspace button when the workspace contains a window with the urgency hint set. -

Type: submodule

Default: - See code for state version < 20.09, -null for state version ≥ 20.09 +

Type: null or submodule

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + + { + background = "#900000"; border = "#2f343a"; text = "#ffffff"; + } +

Declared by:

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

Command that will be used to start a bar.

Type: string

Default: @@ -12730,10 +12777,11 @@ null for state version ≥ 20.09 }

Declared by:

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

The default bar mode when 'bar.mode' == 'hide'.

Type: one of "hide", "show"

Default: - hide for state version < 20.09, -null for state version ≥ 20.09 +

xsession.windowManager.i3.config.bars.*.hiddenState

The default bar mode when 'bar.mode' == 'hide'.

Type: null or one of "hide", "show"

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + "hide"

Declared by:

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

Specifies the bar ID for the configured bar instance. @@ -12743,40 +12791,46 @@ to the position of the embedding bar block in the config file. null

Declared by:

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

Bar visibility mode.

Type: one of "dock", "hide", "invisible"

Default: - dock for state version < 20.09, -null for state version ≥ 20.09 +

xsession.windowManager.i3.config.bars.*.mode

Bar visibility mode.

Type: null or one of "dock", "hide", "invisible"

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + "dock"

Declared by:

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

The edge of the screen i3bar should show up.

Type: one of "top", "bottom"

Default: - bottom for state version < 20.09, -null for state version ≥ 20.09 +

xsession.windowManager.i3.config.bars.*.position

The edge of the screen i3bar should show up.

Type: null or one of "top", "bottom"

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + "bottom"

Declared by:

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

Command that will be used to get status lines.

Type: null or string

Default: - "\${pkgs.i3status}/bin/i3status" + null for state version ≥ 20.09, as example otherwise +

Example: - "i3status" + "\${pkgs.i3status}/bin/i3status"

Declared by:

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

Where to output tray.

Type: string

Default: - primary for state version < 20.09, -null for state version ≥ 20.09 +

xsession.windowManager.i3.config.bars.*.trayOutput

Where to output tray.

Type: null or string

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + "primary"

Declared by:

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

Whether workspace buttons should be shown or not.

Type: boolean

Default: - See code for state version < 20.09, -null for state version ≥ 20.09 +

xsession.windowManager.i3.config.bars.*.workspaceButtons

Whether workspace buttons should be shown or not.

Type: null or boolean

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + true

Declared by:

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

Whether workspace numbers should be displayed within the workspace buttons.

Type: boolean

Default: - See code for state version < 20.09, -null for state version ≥ 20.09 +

xsession.windowManager.i3.config.bars.*.workspaceNumbers

Whether workspace numbers should be displayed within the workspace buttons.

Type: null or boolean

Default: + null for state version ≥ 20.09, as example otherwise +

Example: + true

Declared by:

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

Color settings. All color classes can be specified using submodules diff --git a/tools.html b/tools.html index 751c46655..9d82cf36a 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 | @@ -74,7 +74,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.

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

-

Options

+

Options

The tool accepts the options

-A attrPath @@ -234,15 +234,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)

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