diff --git a/index.html b/index.html index 135b0f1f0..4a43a8ede 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 6dd38c6a1..53b9caaf3 100644 --- a/options.html +++ b/options.html @@ -7369,6 +7369,92 @@ key in $XDG_CONFIG_HOME/grobi.conf. ]

Declared by:

<home-manager/modules/services/grobi.nix> +
services.gromit-mpx.enable

Whether to enable Gromit-MPX annotation tool.

Type: boolean

Default: false

Example: true

Declared by:

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

The gromit-mpx package to use.

Type: package

Default: "pkgs.gromit-mpx"

Declared by:

+ <home-manager/modules/services/gromit-mpx.nix> +
services.gromit-mpx.hotKey

A keysym or raw keycode that toggles the activation state of +gromit-mpx. Set to null to disable the +hotkey in which case you'll have to activate gromit-mpx +manually using the command line. +

Type: null or string or positive integer, meaning >0

Default: "F9"

Example: "Insert"

Declared by:

+ <home-manager/modules/services/gromit-mpx.nix> +
services.gromit-mpx.opacity

Opacity of the drawing overlay.

Type: float between 0.0 and 1.0 (inclusive)

Default:

Example:

Declared by:

+ <home-manager/modules/services/gromit-mpx.nix> +
services.gromit-mpx.tools

Tool definitions for gromit-mpx to use. +

Type: list of submodules

Default: + [ + + { + color = "red"; device = "default"; size = 5; type = "pen"; + } + + { + color = "blue"; device = "default"; modifiers = + [ + "SHIFT" + ] + ; size = 5; type = "pen"; + } + + { + color = "yellow"; device = "default"; modifiers = + [ + "CONTROL" + ] + ; size = 5; type = "pen"; + } + + { + arrowSize = 1; color = "green"; device = "default"; modifiers = + [ + "2" + ] + ; size = 6; type = "pen"; + } + + { + device = "default"; modifiers = + [ + "3" + ] + ; size = 75; type = "eraser"; + } + + ] +

Declared by:

+ <home-manager/modules/services/gromit-mpx.nix> +
services.gromit-mpx.tools.*.arrowSize

If not null, automatically draw an arrow +at the end of a stroke with the given size. +

Type: null or positive integer, meaning >0

Default: null

Example: 2

Declared by:

+ <home-manager/modules/services/gromit-mpx.nix> +
services.gromit-mpx.tools.*.color

The stroke (or recolor) color of the tool.

Type: string

Default: "red"

Example: "#ff00ff"

Declared by:

+ <home-manager/modules/services/gromit-mpx.nix> +
services.gromit-mpx.tools.*.device

Use this tool with the given xinput device. The device with +the name default works with any input. +

Type: string

Example: "default"

Declared by:

+ <home-manager/modules/services/gromit-mpx.nix> +
services.gromit-mpx.tools.*.modifiers

Only activate this tool if the given modifiers are also active. +

Type: list of one of "1", "2", "3", "4", "5", "SHIFT", "CONTROL", "ALT", "META"s

Default: + [ + + ] +

Example: + [ + "SHIFT" + ] +

Declared by:

+ <home-manager/modules/services/gromit-mpx.nix> +
services.gromit-mpx.tools.*.size

The tool size.

Type: positive integer, meaning >0

Default: 5

Example: 3

Declared by:

+ <home-manager/modules/services/gromit-mpx.nix> +
services.gromit-mpx.tools.*.type

Which type of tool this is.

Type: one of "pen", "eraser", "recolor"

Default: "pen"

Example: "eraser"

Declared by:

+ <home-manager/modules/services/gromit-mpx.nix> +
services.gromit-mpx.undoKey

A keysym or raw keycode that causes gromit-mpx to undo the +last stroke. Use this key along with the shift key to redo an +undone stoke. Set to null to disable the +undo hotkey. +

Type: null or string or positive integer, meaning >0

Default: "F10"

Declared by:

+ <home-manager/modules/services/gromit-mpx.nix>
services.hound.enable

Whether to enable hound.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/hound.nix>
services.hound.databasePath

The Hound database path.

Type: path

Default: "$XDG_DATA_HOME/hound"

Declared by:

diff --git a/tools.html b/tools.html index c18db8b62..67935272f 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

$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