diff --git a/index.html b/index.html index 30fb8a793..4c963aa01 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 describes how to install, use, and extend Home Manager.

diff --git a/options.html b/options.html index 22ecf6e5f..0884d81e0 100644 --- a/options.html +++ b/options.html @@ -6864,6 +6864,44 @@ substituting numeric shortcuts for files.

Type: pkgs.scmpuff

Declared by:

<home-manager/modules/programs/scmpuff.nix> +
programs.senpai.enable

Whether to enable senpai.

Type: boolean

Default: + false +

Example: + true +

Declared by:

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

The senpai package to use.

Type: package

Default: + pkgs.senpai +

Declared by:

+ <home-manager/modules/programs/senpai.nix> +
programs.senpai.config

Configuration for senpai. For a complete list of options, see +senpai(5). +

Type: YAML value

Example:

{
+  addr = "libera.chat:6697";
+  nick = "nicholas";
+  password = "verysecurepassword";
+}
+

Declared by:

+ <home-manager/modules/programs/senpai.nix> +
programs.senpai.config.addr

The address (host[:port]) of the IRC server. senpai uses TLS +connections by default unless you specify no-tls option. TLS +connections default to port 6697, plain-text use port 6667. +

Type: string

Declared by:

+ <home-manager/modules/programs/senpai.nix> +
programs.senpai.config.nick

Your nickname, sent with a NICK IRC message. It mustn't contain +spaces or colons (:). +

Type: string

Declared by:

+ <home-manager/modules/programs/senpai.nix> +
programs.senpai.config.no-tls

Disables TLS encryption.

Type: boolean

Default: + false +

Declared by:

+ <home-manager/modules/programs/senpai.nix> +
programs.senpai.config.password

Your password, used for SASL authentication. Note that it will +reside world-readable in the Nix store. +

Type: null or string

Default: + null +

Declared by:

+ <home-manager/modules/programs/senpai.nix>
programs.skim.enable

Whether to enable skim - a command-line fuzzy finder.

Type: boolean

Default: false

Example: diff --git a/tools.html b/tools.html index d0b505f35..83314dbc4 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 | @@ -76,7 +76,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.

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

-

Options

+

Options

The tool accepts the options

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