From e4e17ecdfe1d8b4b3001879b0a5d5ac54b540747 Mon Sep 17 00:00:00 2001 From: rycee Date: Fri, 4 Feb 2022 00:10:04 +0000 Subject: [PATCH] deploy: 63dccc4e60422c1db2c3929b2fd1541f36b7e664 --- index.html | 4 +- options.html | 112 +++++++++++++++++++++++++++++++++++++++++++++++++++ tools.html | 14 +++---- 3 files changed, 121 insertions(+), 9 deletions(-) diff --git a/index.html b/index.html index f51a7dcab..8794bff08 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. 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
   Next

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 2da020235..516a144d0 100644 --- a/options.html +++ b/options.html @@ -8756,6 +8756,118 @@ found at Declared by:

<home-manager/modules/services/trayer.nix> +
services.twmn.enable

Whether to enable twmn, a tiling window manager notification daemon.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.duration

The time each notification remains visible, in milliseconds. +

Type: unsigned integer, meaning >=0

Default: 3000

Example: 5000

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.extraConfig

Extra configuration options to add to the twmnd config file. See +https://github.com/sboli/twmn/blob/master/README.md +for details. +

Type: attribute set

Default: + { + + } +

Example: { main.activation_command = "\${pkgs.hello}/bin/hello"; }

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.host

Host address to listen on for notifications.

Type: string

Default: "127.0.0.1"

Example: "laptop.lan"

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.icons.critical

Path to the critical notifications' icon.

Type: null or path

Default: null

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.icons.info

Path to the informative notifications' icon.

Type: null or path

Default: null

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.icons.warning

Path to the warning notifications' icon.

Type: null or path

Default: null

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.port

UDP port to listen on for notifications.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 9797

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.screen

Screen number to display notifications on when using a multi-head +desktop. +

Type: null or signed integer

Default: null

Example: 0

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.soundCommand

Command to execute to play a notification's sound.

Type: string

Default: ""

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.text.color

Notification's text color. RGB hex and keywords (e.g. lightgray) +are supported. +

Type: string

Default: "#999999"

Example: "lightgray"

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.text.font.package

Notification text's font package. If null then +the font is assumed to already be available in your profile. +

Type: null or package

Default: null

Example: pkgs.dejavu_fonts

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.text.font.family

Notification text's font family.

Type: string

Default: "Sans"

Example: "Noto Sans"

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.text.font.size

Notification text's font size.

Type: unsigned integer, meaning >=0

Default: 13

Example: 42

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.text.font.variant

Notification text's font variant.

Type: one of "oblique", "italic", "ultra-light", "light", "medium", "semi-bold", "bold", "ultra-bold", "heavy", "ultra-condensed", "extra-condensed", "condensed", "semi-condensed", "semi-expanded", "expanded", "extra-expanded", "ultra-expanded"

Default: "medium"

Example: "heavy"

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.text.maxLength

Maximum length of the text before it is cut and suffixed with "...". +Never cuts if null. +

Type: null or unsigned integer, meaning >=0

Default: null

Example: 80

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.window.alwaysOnTop

Whether to enable forcing the notification window to always be on top.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.window.animation.bounce.enable

Whether to enable notification bounce when displaying next notification directly..

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.window.animation.bounce.duration

The bounce animation duration in milliseconds.

Type: unsigned integer, meaning >=0

Default: 500

Example: 618

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.window.animation.easeIn

Options for the notification appearance's animation.

Type: submodule

Default: + { + + } +

Example: 

{
+  curve = 19;
+  duration = 618;
+}
+

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.window.animation.easeIn.curve

The qt easing-curve animation to use for the animation. See + +QEasingCurve documentation. +

Type: integer between 0 and 40 (both inclusive)

Default: 38

Example: 19

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.window.animation.easeIn.duration

The animation duration in milliseconds.

Type: unsigned integer, meaning >=0

Default: 1000

Example: 618

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.window.animation.easeOut

Options for the notification disappearance's animation.

Type: submodule

Default: + { + + } +

Example: 

{
+  curve = 19;
+  duration = 618;
+}
+

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.window.animation.easeOut.curve

The qt easing-curve animation to use for the animation. See + +QEasingCurve documentation. +

Type: integer between 0 and 40 (both inclusive)

Default: 38

Example: 19

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.window.animation.easeOut.duration

The animation duration in milliseconds.

Type: unsigned integer, meaning >=0

Default: 1000

Example: 618

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.window.color

Notification's background color. RGB hex and keywords (e.g. +lightgray) are supported. +

Type: string

Default: "#000000"

Example: "lightgray"

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.window.height

Height of the slide bar. Useful to match your tiling window +manager's bar. +

Type: unsigned integer, meaning >=0

Default: 18

Example: 42

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.window.offset.x

Offset of the notification's slide starting point in pixels on the +horizontal axis (positive is rightward). +

Type: signed integer

Default: 0

Example: 50

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.window.offset.y

Offset of the notification's slide starting point in pixels on the +vertical axis (positive is upward). +

Type: signed integer

Default: 0

Example: -100

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.window.opacity

The notification window's opacity.

Type: integer between 0 and 100 (both inclusive)

Default: 100

Example: 80

Declared by:

+ <home-manager/modules/services/twmn.nix> +
services.twmn.window.position

Position of the notification slide. The notification will slide +in vertically from the border if placed in +top_center or bottom_center, +horizontally otherwise. +

Type: one of "tr", "top_right", "tl", "top_left", "br", "bottom_right", "bl", "bottom_left", "tc", "top_center", "bc", "bottom_center", "c", "center"

Default: "top_right"

Example: "bottom_left"

Declared by:

+ <home-manager/modules/services/twmn.nix>
services.udiskie.enable

Whether to enable udiskie mount daemon.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/udiskie.nix>
services.udiskie.automount

Whether to automatically mount new devices.

Type: boolean

Default: true

Declared by:

diff --git a/tools.html b/tools.html index e14aa3107..9f284f062 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 | @@ -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)

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