diff --git a/index.html b/index.html index 276b048bb..80204c8e3 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 692eef398..e36b99631 100644 --- a/options.html +++ b/options.html @@ -2810,6 +2810,116 @@ Note that lists are converted to duplicate keys. }

Declared by:

<home-manager/modules/programs/gpg.nix> +
programs.helix.enable

Whether to enable helix text editor.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/modules/programs/helix.nix> +
programs.helix.package

The package to use for helix.

Type: package

Default: pkgs.helix

Declared by:

+ <home-manager/modules/programs/helix.nix> +
programs.helix.languages

Language specific configuration at +$XDG_CONFIG_HOME/helix/languages.toml. +

+See https://docs.helix-editor.com/languages.html +for more information. +

Type: list of TOML values

Default: + [ + + ] +

Example: + [ + + { + auto-format = false; name = "rust"; + } + + ] +

Declared by:

+ <home-manager/modules/programs/helix.nix> +
programs.helix.settings

Configuration written to +$XDG_CONFIG_HOME/helix/config.toml. +

+See https://docs.helix-editor.com/configuration.html +for the full list of options. +

Type: TOML value

Default: + { + + } +

Example:

{
+  theme = "base16";
+  lsp.display-messages = true;
+  keys.normal = {
+    space.space = "file_picker";
+    space.w = ":w";
+    space.q = ":q";
+  };
+}
+

Declared by:

+ <home-manager/modules/programs/helix.nix> +
programs.helix.themes

Each theme is written to +$XDG_CONFIG_HOME/helix/themes/theme-name.toml. +Where the name of each attribute is the theme-name (in the example "base16"). +

+See https://docs.helix-editor.com/themes.html +for the full list of options. +

Type: attribute set of TOML values

Default: + { + + } +

Example:

{
+  base16 = let
+    transparent = "none";
+    gray = "#665c54";
+    dark-gray = "#3c3836";
+    white = "#fbf1c7";
+    black = "#282828";
+    red = "#fb4934";
+    green = "#b8bb26";
+    yellow = "#fabd2f";
+    orange = "#fe8019";
+    blue = "#83a598";
+    magenta = "#d3869b";
+    cyan = "#8ec07c";
+  in {
+    "ui.menu" = transparent;
+    "ui.menu.selected" = { modifiers = [ "reversed" ]; };
+    "ui.linenr" = { fg = gray; bg = dark-gray; };
+    "ui.popup" = { modifiers = [ "reversed" ]; };
+    "ui.linenr.selected" = { fg = white; bg = black; modifiers = [ "bold" ]; };
+    "ui.selection" = { fg = black; bg = blue; };
+    "ui.selection.primary" = { modifiers = [ "reversed" ]; };
+    "comment" = { fg = gray; };
+    "ui.statusline" = { fg = white; bg = dark-gray; };
+    "ui.statusline.inactive" = { fg = dark-gray; bg = white; };
+    "ui.help" = { fg = dark-gray; bg = white; };
+    "ui.cursor" = { modifiers = [ "reversed" ]; };
+    "variable" = red;
+    "variable.builtin" = orange;
+    "constant.numeric" = orange;
+    "constant" = orange;
+    "attributes" = yellow;
+    "type" = yellow;
+    "ui.cursor.match" = { fg = yellow; modifiers = [ "underlined" ]; };
+    "string" = green;
+    "variable.other.member" = red;
+    "constant.character.escape" = cyan;
+    "function" = blue;
+    "constructor" = blue;
+    "special" = blue;
+    "keyword" = magenta;
+    "label" = magenta;
+    "namespace" = blue;
+    "diff.plus" = green;
+    "diff.delta" = yellow;
+    "diff.minus" = red;
+    "diagnostic" = { modifiers = [ "underlined" ]; };
+    "ui.gutter" = { bg = black; };
+    "info" = blue;
+    "hint" = dark-gray;
+    "debug" = dark-gray;
+    "warning" = yellow;
+    "error" = red;
+  };
+}
+

Declared by:

+ <home-manager/modules/programs/helix.nix>
programs.hexchat.enable

Whether to enable HexChat, a graphical IRC client.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/hexchat.nix>
programs.hexchat.channels

Configures $XDG_CONFIG_HOME/hexchat/servlist.conf. @@ -6247,6 +6357,46 @@ overlay or set this option. Example overlay configuration: }

Declared by:

<home-manager/modules/programs/vscode.nix> +
programs.watson.enable

Whether to enable watson, a wonderful CLI to track your time.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/modules/programs/watson.nix> +
programs.watson.enableBashIntegration

Whether to enable watson's bash integration.

Type: boolean

Default: true

Example: true

Declared by:

+ <home-manager/modules/programs/watson.nix> +
programs.watson.enableFishIntegration

Whether to enable watson's fish integration.

Type: boolean

Default: true

Example: true

Declared by:

+ <home-manager/modules/programs/watson.nix> +
programs.watson.enableZshIntegration

Whether to enable watson's zsh integration.

Type: boolean

Default: true

Example: true

Declared by:

+ <home-manager/modules/programs/watson.nix> +
programs.watson.package

Package providing the watson.

Type: package

Default: pkgs.watson

Declared by:

+ <home-manager/modules/programs/watson.nix> +
programs.watson.settings

Configuration written to +$XDG_CONFIG_HOME/watson/config on Linux or +$HOME/Library/Application Support/watson/config on Darwin. +

+See https://github.com/TailorDev/Watson/blob/master/docs/user-guide/configuration.md +for an example configuration. +

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

Default: + { + + } +

Example:

{
+  backend = {
+    url = "https://api.crick.fr";
+    token = "yourapitoken";
+  };
+
+  options = {
+    stop_on_start = true;
+    stop_on_restart = false;
+    date_format = "%Y.%m.%d";
+    time_format = "%H:%M:%S%z";
+    week_start = "monday";
+    log_current = false;
+    pager = true;
+    report_current = false;
+    reverse_log = true;
+  };
+}
+

Declared by:

+ <home-manager/modules/programs/watson.nix>
programs.waybar.enable

Whether to enable Waybar.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/waybar.nix>
programs.waybar.package

Waybar package to use. Set to null to use the default package. diff --git a/tools.html b/tools.html index f9b9056cd..b2d004faf 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 | @@ -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)

\ No newline at end of file