diff --git a/index.html b/index.html index 2de62f7a8..178057da0 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. 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.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.09
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.03
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. 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. 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.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.09
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.03
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. 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 d8f39796f..a152b3333 100644 --- a/options.html +++ b/options.html @@ -7009,88 +7009,6 @@ now.

Declared by:

<home-manager/modules/programs/rofi.nix> -
programs.rofi.borderWidth

Border width

Type: null or signed integer

Default: - null -

Example: - 1 -

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors

Color scheme settings. Colors can be specified in CSS color -formats. This option may become deprecated in the future and -therefore the programs.rofi.theme option -should be used whenever possible. -

Type: null or submodule

Default: - null -

Example: - - { - _type = "literalExpression"; text = "colors = {\n window = {\n background = \"argb:583a4c54\";\n border = \"argb:582a373e\";\n separator = \"#c3c6c8\";\n };\n\n rows = {\n normal = {\n background = \"argb:58455a64\";\n foreground = \"#fafbfc\";\n backgroundAlt = \"argb:58455a64\";\n highlight = {\n background = \"#00bcd4\";\n foreground = \"#fafbfc\";\n };\n };\n };\n};\n"; - } - -

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows

Rows color settings.

Type: submodule

Default: - null -

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.active

Active row color settings.

Type: null or submodule

Default: - null -

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.active.background

Background color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.active.backgroundAlt

Alternative background color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.active.foreground

Foreground color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.active.highlight

Color settings for highlighted row.

Type: submodule

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.active.highlight.background

Highlight background color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.active.highlight.foreground

Highlight foreground color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.normal

Normal row color settings.

Type: null or submodule

Default: - null -

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.normal.background

Background color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.normal.backgroundAlt

Alternative background color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.normal.foreground

Foreground color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.normal.highlight

Color settings for highlighted row.

Type: submodule

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.normal.highlight.background

Highlight background color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.normal.highlight.foreground

Highlight foreground color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.urgent

Urgent row color settings.

Type: null or submodule

Default: - null -

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.urgent.background

Background color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.urgent.backgroundAlt

Alternative background color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.urgent.foreground

Foreground color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.urgent.highlight

Color settings for highlighted row.

Type: submodule

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.urgent.highlight.background

Highlight background color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.rows.urgent.highlight.foreground

Highlight foreground color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.window

Window color settings.

Type: submodule

Default: - null -

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.window.background

Window background color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.window.border

Window border color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.colors.window.separator

Separator color

Type: string

Declared by:

- <home-manager/modules/programs/rofi.nix>
programs.rofi.configPath

Path where to put generated configuration file.

Type: string

Default: "\$XDG_CONFIG_HOME/rofi/config.rasi"

Declared by:

@@ -7117,26 +7035,10 @@ should be used whenever possible. null

Example: "Droid Sans Mono 14" -

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.fullscreen

Whether to run rofi fullscreen.

Type: null or boolean

Default: - null -

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.lines

Number of lines

Type: null or signed integer

Default: - null -

Example: - 10

Declared by:

<home-manager/modules/programs/rofi.nix>
programs.rofi.location

The location rofi appears on the screen.

Type: one of "bottom", "bottom-left", "bottom-right", "center", "left", "right", "top", "top-left", "top-right"

Default: "center" -

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.padding

Padding

Type: null or signed integer

Default: - null -

Example: - 400

Declared by:

<home-manager/modules/programs/rofi.nix>
programs.rofi.pass.enable

Whether to enable rofi integration with password-store.

Type: boolean

Default: @@ -7178,22 +7080,6 @@ AUTOTYPE_field='autotype' _type = "literalExpression"; text = "[ pkgs.rofi-calc ]"; } -

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.rowHeight

Row height (in chars)

Type: null or signed integer

Default: - null -

Example: - 1 -

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.scrollbar

Whether to show a scrollbar.

Type: null or boolean

Default: - null -

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.separator

Separator style

Type: null or one of "none", "dash", "solid"

Default: - null -

Example: - "solid"

Declared by:

<home-manager/modules/programs/rofi.nix>
programs.rofi.terminal

Path to the terminal which will be used to run console applications @@ -7211,15 +7097,9 @@ theme configuration. Available named themes can be viewed using the

Example: { - _type = "literalExpression"; text = "let\n inherit (config.lib.formats.rasi) mkLiteral;\nin {\n \"*\" = {\n background-color = mkLiteral \"#000000\";\n foreground-color = mkLiteral \"rgba ( 250, 251, 252, 100 % )\";\n border-color = mkLiteral \"#FFFFFF\";\n width = 512;\n };\n\n \"#inputbar\" = {\n children = map mkLiteral [ \"prompt\" \"entry\" ];\n };\n\n \"#textbox-prompt-colon\" = {\n expand = false;\n str = \":\";\n margin = mkLiteral \"0px 0.3em 0em 0em\";\n text-color = mkLiteral \"@foreground-color\";\n };\n}\n"; + _type = "literalExpression"; text = "let\n # Use `mkLiteral` for string-like values that should show without\n # quotes, e.g.:\n # {\n # foo = \"abc\"; => foo: \"abc\";\n # bar = mkLiteral \"abc\"; => bar: abc;\n # };\n inherit (config.lib.formats.rasi) mkLiteral;\nin {\n \"*\" = {\n background-color = mkLiteral \"#000000\";\n foreground-color = mkLiteral \"rgba ( 250, 251, 252, 100 % )\";\n border-color = mkLiteral \"#FFFFFF\";\n width = 512;\n };\n\n \"#inputbar\" = {\n children = map mkLiteral [ \"prompt\" \"entry\" ];\n };\n\n \"#textbox-prompt-colon\" = {\n expand = false;\n str = \":\";\n margin = mkLiteral \"0px 0.3em 0em 0em\";\n text-color = mkLiteral \"@foreground-color\";\n };\n}\n"; } -

Declared by:

- <home-manager/modules/programs/rofi.nix> -
programs.rofi.width

Window width

Type: null or signed integer

Default: - null -

Example: - 100

Declared by:

<home-manager/modules/programs/rofi.nix>
programs.rofi.xoffset

Offset in the x-axis in pixels relative to the chosen location. diff --git a/release-notes.html b/release-notes.html index 43f55bd8a..455a726cb 100644 --- a/release-notes.html +++ b/release-notes.html @@ -18,7 +18,9 @@ are unavailable on some hosts. Finally, users who wish to use the same configuration file for different platforms cannot do so, even if the platform incompatible options are unused.

Ultimately, the benefits of loading all modules won and the behavior has now changed. For associated discussion see -issue #1906.

E.1.2. State Version Changes

The state version in this release includes the changes below. These +issue #1906.

  • +Rofi version 1.7.0 removed many options that were used by the module and replaced them with custom themes, which are more flexible and powerful. +

    You can replicate your old configuration by moving those options to programs.rofi.theme. Keep in mind that the syntax is different so you may need to do some changes.

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

    • Nothing has happened. diff --git a/tools.html b/tools.html index 3442a031e..d2f0b1333 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

    ~/.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)

    \ No newline at end of file