diff --git a/index.html b/index.html index e1938fcdb..2b8509b4d 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 197105a8b..2b28397f4 100644 --- a/options.html +++ b/options.html @@ -8781,9 +8781,7 @@ else pkgs.emacs "\${pkgs.soundfont-fluid}/share/soundfonts/FluidR3_GM2-2.sf2"

Declared by:

<home-manager/modules/services/fluidsynth.nix> -
services.gammastep.enable

Enable Gammastep to change your screen's colour temperature -depending on the time of day. -

Type: boolean

Default: +

services.gammastep.enable

Whether to enable Gammastep.

Type: boolean

Default: false

Example: true @@ -8794,45 +8792,33 @@ depending on the time of day. pkgs.gammastep

Declared by:

<home-manager/modules/services/redshift-gammastep/gammastep.nix> -
services.gammastep.brightness.day

Screen brightness to apply during the day, -between 0.1 and 1.0. -

Type: string

Default: - "1" -

Declared by:

- <home-manager/modules/services/redshift-gammastep/gammastep.nix> -
services.gammastep.brightness.night

Screen brightness to apply during the night, -between 0.1 and 1.0. -

Type: string

Default: - "1" -

Declared by:

- <home-manager/modules/services/redshift-gammastep/gammastep.nix> -
services.gammastep.extraOptions

Additional command-line arguments to pass to -redshift. -

Type: list of strings

Default: - - [ - - ] - +

services.gammastep.dawnTime

Set the time interval of dawn manually. +The times must be specified as HH:MM in 24-hour format. +

Type: null or string

Default: + null

Example: - - [ - "-v" "-m randr" - ] - + "6:00-7:45" +

Declared by:

+ <home-manager/modules/services/redshift-gammastep/gammastep.nix> +
services.gammastep.duskTime

Set the time interval of dusk manually. +The times must be specified as HH:MM in 24-hour format. +

Type: null or string

Default: + null +

Example: + "18:35-20:15"

Declared by:

<home-manager/modules/services/redshift-gammastep/gammastep.nix>
services.gammastep.latitude

Your current latitude, between -90.0 and 90.0. Must be provided along with longitude. -

Type: null or string

Default: +

Type: null or string or floating point number

Default: null

Declared by:

<home-manager/modules/services/redshift-gammastep/gammastep.nix>
services.gammastep.longitude

Your current longitude, between -180.0 and 180.0. Must be provided along with latitude. -

Type: null or string

Default: +

Type: null or string or floating point number

Default: null

Declared by:

<home-manager/modules/services/redshift-gammastep/gammastep.nix> @@ -8844,6 +8830,25 @@ geoclue2 service. "manual"

Declared by:

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

The configuration to pass to Gammastep. +Available options for Gammastep described in +gammastep(1). +

Type: attribute set of attribute set of INI atom (null, bool, int, float or string)ss

Default: + + { + + } + +

Example: 

{
+  general = {
+    adjustment-method = "randr";
+  };
+  randr = {
+    screen = 0;
+  };
+};
+

Declared by:

+ <home-manager/modules/services/redshift-gammastep/gammastep.nix>
services.gammastep.temperature.day

Colour temperature to use during the day, between 1000 and 25000 K.

Type: signed integer

Default: @@ -9917,9 +9922,7 @@ as a duration understood by systemd. "1h"

Declared by:

<home-manager/modules/services/random-background.nix> -
services.redshift.enable

Enable Redshift to change your screen's colour temperature -depending on the time of day. -

Type: boolean

Default: +

services.redshift.enable

Whether to enable Redshift.

Type: boolean

Default: false

Example: true @@ -9930,45 +9933,33 @@ depending on the time of day. pkgs.redshift

Declared by:

<home-manager/modules/services/redshift-gammastep/redshift.nix> -
services.redshift.brightness.day

Screen brightness to apply during the day, -between 0.1 and 1.0. -

Type: string

Default: - "1" -

Declared by:

- <home-manager/modules/services/redshift-gammastep/redshift.nix> -
services.redshift.brightness.night

Screen brightness to apply during the night, -between 0.1 and 1.0. -

Type: string

Default: - "1" -

Declared by:

- <home-manager/modules/services/redshift-gammastep/redshift.nix> -
services.redshift.extraOptions

Additional command-line arguments to pass to -redshift. -

Type: list of strings

Default: - - [ - - ] - +

services.redshift.dawnTime

Set the time interval of dawn manually. +The times must be specified as HH:MM in 24-hour format. +

Type: null or string

Default: + null

Example: - - [ - "-v" "-m randr" - ] - + "6:00-7:45" +

Declared by:

+ <home-manager/modules/services/redshift-gammastep/redshift.nix> +
services.redshift.duskTime

Set the time interval of dusk manually. +The times must be specified as HH:MM in 24-hour format. +

Type: null or string

Default: + null +

Example: + "18:35-20:15"

Declared by:

<home-manager/modules/services/redshift-gammastep/redshift.nix>
services.redshift.latitude

Your current latitude, between -90.0 and 90.0. Must be provided along with longitude. -

Type: null or string

Default: +

Type: null or string or floating point number

Default: null

Declared by:

<home-manager/modules/services/redshift-gammastep/redshift.nix>
services.redshift.longitude

Your current longitude, between -180.0 and 180.0. Must be provided along with latitude. -

Type: null or string

Default: +

Type: null or string or floating point number

Default: null

Declared by:

<home-manager/modules/services/redshift-gammastep/redshift.nix> @@ -9980,6 +9971,25 @@ geoclue2 service. "manual"

Declared by:

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

The configuration to pass to Redshift. +Available options for Redshift described in +redshift(1). +

Type: attribute set of attribute set of INI atom (null, bool, int, float or string)ss

Default: + + { + + } + +

Example: 

{
+  redshift = {
+    adjustment-method = "randr";
+  };
+  randr = {
+    screen = 0;
+  };
+};
+

Declared by:

+ <home-manager/modules/services/redshift-gammastep/redshift.nix>
services.redshift.temperature.day

Colour temperature to use during the day, between 1000 and 25000 K.

Type: signed integer

Default: diff --git a/release-notes.html b/release-notes.html index a06d01b5c..0bbbc2cc9 100644 --- a/release-notes.html +++ b/release-notes.html @@ -32,7 +32,29 @@ removing the rofi. prefix from the keys. For exampl '';

becomes

programs.rofi.extraConfig = {
   show-icons = true;
   modi = "drun,emoji,ssh";
-};

E.1.2. State Version Changes

The state version in this release includes the changes below. These +};

  • +The services.redshift.extraOptions and services.gammastep.extraOptions +options were removed in favor of services.redshift.settings and +services.gammastep.settings, that are now an attribute set rather +than a string. They also support new features not available before, for +example: +

    services.redshift = {
+  dawnTime = "6:00-7:45";
+  duskTime = "18:35-20:15";
+  settings = {
+    redshift = {
+      gamma = 0.8;
+      adjustment-method = "randr";
+    };
+
+    randr = {
+      screen = 0;
+    };
+  };
+};

    It is recommended to check either +redshift.conf.sample or +gammastep.conf.sample +for the available additional options in each program.

    • 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 "21.05" or later.

    • Nothing has happened. diff --git a/tools.html b/tools.html index 0196db6c8..f47dd35fd 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 | @@ -72,7 +72,7 @@ | --verbose } - ]

      Description

      + ]

      Description

      This command updates the user environment so that it corresponds to the configuration specified in ~/.config/nixpkgs/home.nix.

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

    -

    Options

    +

    Options

    The tool accepts the options

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