From eb2ca47493358cc74077cb5247b57e48208fb7df Mon Sep 17 00:00:00 2001 From: rycee Date: Tue, 12 Jul 2022 09:40:52 +0000 Subject: [PATCH] deploy: 177f1887d4d4eb347c6a8328fbd8ca0f346887bc --- index.html | 4 +- options.html | 107 ++++++++++++++++++++------------------------- release-notes.html | 12 ++++- tools.html | 14 +++--- 4 files changed, 68 insertions(+), 69 deletions(-) diff --git a/index.html b/index.html index 00fc6a72..ef1cbb83 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
2.5. Updating
3. Nix Flakes
3.1. Prerequisties
3.2. Standalone setup
3.3. NixOS module
3.4. nix-darwin module
4. Writing Home Manager Modules
4.1. Option Types
5. Contributing
5.1. Getting started
5.2. Guidelines
5.2.1. Maintain backward compatibility
5.2.2. Keep forward compatibility in mind
5.2.3. Add only valuable options
5.2.4. Add relevant tests
5.2.5. Add relevant documentation
5.2.6. Add yourself as a module maintainer
5.2.7. Format your code
5.2.8. Format your commit messages
5.2.9. Format your news entries
5.2.10. Use conditional modules and news
5.2.11. Mind the license
5.3. Commits
5.4. Code Style
5.5. News
5.6. Tests
6. Frequently Asked Questions (FAQ)
6.1. Why is there a collision error when switching generation?
6.2. Why are the session variables not set?
6.3. How to set up a configuration for multiple users/machines?
6.4. Why do I get an error message about ca.desrt.dconf or dconf.service?
6.5. How do I install packages from Nixpkgs unstable?
6.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.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 22.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.11
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 21.05
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 20.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.09
E.7.1. Highlights
E.7.2. State Version Changes
E.8. Release 19.03
E.8.1. Highlights
E.8.2. State Version Changes
E.9. 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
2.5. Updating
3. Nix Flakes
3.1. Prerequisties
3.2. Standalone setup
3.3. NixOS module
3.4. nix-darwin module
4. Writing Home Manager Modules
4.1. Option Types
5. Contributing
5.1. Getting started
5.2. Guidelines
5.2.1. Maintain backward compatibility
5.2.2. Keep forward compatibility in mind
5.2.3. Add only valuable options
5.2.4. Add relevant tests
5.2.5. Add relevant documentation
5.2.6. Add yourself as a module maintainer
5.2.7. Format your code
5.2.8. Format your commit messages
5.2.9. Format your news entries
5.2.10. Use conditional modules and news
5.2.11. Mind the license
5.3. Commits
5.4. Code Style
5.5. News
5.6. Tests
6. Frequently Asked Questions (FAQ)
6.1. Why is there a collision error when switching generation?
6.2. Why are the session variables not set?
6.3. How to set up a configuration for multiple users/machines?
6.4. Why do I get an error message about ca.desrt.dconf or dconf.service?
6.5. How do I install packages from Nixpkgs unstable?
6.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.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 22.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.11
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 21.05
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 20.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.09
E.7.1. Highlights
E.7.2. State Version Changes
E.8. Release 19.03
E.8.1. Highlights
E.8.2. State Version Changes
E.9. 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 6b0b71f3..edeb8f9c 100644 --- a/options.html +++ b/options.html @@ -9348,51 +9348,25 @@ password are escaped. <home-manager/modules/services/pbgopy.nix>

services.picom.enable

Whether to enable Picom X11 compositor.

Type: boolean

Default: false

Example: true

Declared by:

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

picom derivation to use. +

services.picom.package

Picom derivation to use.

Type: package

Default: pkgs.picom

Example: pkgs.picom

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.activeOpacity

Opacity of active windows. -

Type: string

Default: "1.0"

Example: "0.8"

Declared by:

+

Type: a floating point number in range [0, 1]

Default:

Example:

Declared by:

<home-manager/modules/services/picom.nix> -
services.picom.backend

Backend to use: glx or xrender. -

Type: string

Default: "glx"

Declared by:

+
services.picom.backend

Backend to use: glx, xrender or xr_glx_hybrid. +

Type: one of "glx", "xrender", "xr_glx_hybrid"

Default: "xrender"

Declared by:

<home-manager/modules/services/picom.nix> -
services.picom.blur

Enable background blur on transparent windows. -

Type: boolean

Default: false

Declared by:

- <home-manager/modules/services/picom.nix> -
services.picom.blurExclude

List of windows to exclude background blur. -See the -picom(1) -man page for more examples. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "class_g = 'slop'" "class_i = 'polybar'" - ] -

Declared by:

- <home-manager/modules/services/picom.nix> -
services.picom.experimentalBackends

Whether to use the new experimental backends. -

Type: boolean

Default: false

Declared by:

- <home-manager/modules/services/picom.nix> -
services.picom.extraOptions

Additional Picom configuration. -

Type: strings concatenated with "\n"

Default: ""

Example: 

''
-unredir-if-possible = true;
-dbe = true;
-''

Declared by:

+
services.picom.experimentalBackends

Whether to enable the new experimental backends.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.fade

Fade windows in and out.

Type: boolean

Default: false

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.fadeDelta

Time between fade animation step (in ms). -

Type: signed integer

Default: 10

Example: 5

Declared by:

+

Type: positive integer, meaning >0

Default: 10

Example: 5

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.fadeExclude

List of conditions of windows that should not be faded. -See the -picom(1) -man page for more examples. +See picom(1) man page for more examples.

Type: list of string

Default: [ @@ -9404,52 +9378,56 @@ man page for more examples.

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.fadeSteps

Opacity change between fade steps (in and out). -

Type: list of string

Default: +

Type: pair of a floating point number in range [0.01, 1]

Default: [ - "0.028" "0.03" + ]

Example: [ - "0.04" "0.04" + ]

Declared by:

<home-manager/modules/services/picom.nix> -
services.picom.inactiveDim

Dim inactive windows. -

Type: string

Default: "0.0"

Example: "0.2"

Declared by:

- <home-manager/modules/services/picom.nix>
services.picom.inactiveOpacity

Opacity of inactive windows. -

Type: string

Default: "1.0"

Example: "0.8"

Declared by:

+

Type: a floating point number in range [0.1, 1]

Default:

Example:

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.menuOpacity

Opacity of dropdown and popup menu. -

Type: string

Default: "1.0"

Example: "0.8"

Declared by:

+

Type: a floating point number in range [0, 1]

Default:

Example:

Declared by:

<home-manager/modules/services/picom.nix> -
services.picom.noDNDShadow

Avoid shadow on drag-and-drop windows. -

Type: boolean

Default: true

Declared by:

- <home-manager/modules/services/picom.nix> -
services.picom.noDockShadow

Avoid shadow on docks. -

Type: boolean

Default: true

Declared by:

- <home-manager/modules/services/picom.nix> -
services.picom.opacityRule

List of opacity rules. -See the -picom(1) -man page for more examples. +

services.picom.opacityRules

Rules that control the opacity of windows, in format PERCENT:PATTERN.

Type: list of string

Default: [ ]

Example: [ - "87:class_i ?= 'scratchpad'" "91:class_i ?= 'xterm'" + "95:class_g = 'URxvt' && !_NET_WM_STATE@:32a" "0:_NET_WM_STATE@:32a *= '_NET_WM_STATE_HIDDEN'" ]

Declared by:

<home-manager/modules/services/picom.nix> +
services.picom.settings

Picom settings. Use this option to configure Picom settings not exposed +in a NixOS option or to bypass one. For the available options see the +CONFIGURATION FILES section at picom(1). +

Type: libconfig configuration. The format consists of an attributes +set (called a group) of settings. Each setting can be a scalar type +(boolean, integer, floating point number or string), a list of +scalars or a group itself +

Default: + { + + } +

Example: 

blur =
+  { method = "gaussian";
+    size = 10;
+    deviation = 5.0;
+  };
+

Declared by:

+ <home-manager/modules/services/picom.nix>
services.picom.shadow

Draw window shadows.

Type: boolean

Default: false

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.shadowExclude

List of conditions of windows that should have no shadow. -See the -picom(1) -man page for more examples. +See picom(1) man page for more examples.

Type: list of string

Default: [ @@ -9460,8 +9438,8 @@ man page for more examples. ]

Declared by:

<home-manager/modules/services/picom.nix> -
services.picom.shadowOffsets

Horizontal and vertical offsets for shadows (in pixels). -

Type: list of signed integer

Default: +

services.picom.shadowOffsets

Left and right offset for shadows (in pixels). +

Type: pair of signed integer

Default: [ -15 -15 ] @@ -9471,12 +9449,23 @@ man page for more examples. ]

Declared by:

<home-manager/modules/services/picom.nix> -
services.picom.shadowOpacity

Window shadows opacity (number in range 0 - 1). -

Type: string

Default: "0.75"

Example: "0.8"

Declared by:

+
services.picom.shadowOpacity

Window shadows opacity. +

Type: a floating point number in range [0, 1]

Default:

Example:

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.vSync

Enable vertical synchronization.

Type: boolean

Default: false

Declared by:

<home-manager/modules/services/picom.nix> +
services.picom.wintypes

Rules for specific window types. +

Type: attribute set

Default: 

{
+  popup_menu = { opacity = config.services.picom.menuOpacity; };
+  dropdown_menu = { opacity = config.services.picom.menuOpacity; };
+}
+

Example: + { + + } +

Declared by:

+ <home-manager/modules/services/picom.nix>
services.plan9port.fontsrv.enable

Whether to enable the Plan 9 file system access to host fonts.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/plan9port.nix>
services.plan9port.plumber.enable

Whether to enable the Plan 9 file system for interprocess messaging.

Type: boolean

Default: false

Example: true

Declared by:

diff --git a/release-notes.html b/release-notes.html index b5e9c8f1..bf4ca637 100644 --- a/release-notes.html +++ b/release-notes.html @@ -44,7 +44,17 @@ input of your choice.

For example, if your Flake currently ]; }

Of course, you can move the assignment of home.username, home.homeDirectory, and home.stateVersion to some -other file or simply place them in your home.nix.

E.1.2. State Version Changes

The state version in this release includes the changes below. +other file or simply place them in your home.nix.

  • +The services.picom module has been refactored to use structural +settings. +

    As a result services.picom.extraOptions has been removed in favor of +services.picom.settings. Also, services.picom.blur* were +removed since upstream changed the blur settings to be more flexible. +You can migrate the blur settings to use +services.picom.settings instead.

  • +The services.compton module has been removed. It was deprecated in +release 20.03. Use services.picom instead. +

    • E.1.2. State Version Changes

    The state version in this release includes the changes below. These changes are only active if the home.stateVersion option is set to "22.11" or later.

    • No changes.

    E.2. Release 22.05

    The 22.05 release branch became the stable branch in May, 2022.

    E.2.1. Highlights

    This release has the following notable changes:

    • diff --git a/tools.html b/tools.html index eb8b2cb6..0153cb7e 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