diff --git a/index.html b/index.html index 05fe7f631..cadd7ee91 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.

@@ -95,11 +95,7 @@ or an unstable channel, you can run

# nix
 # nix-channel --update

and if you follow a Nixpkgs version 21.05 channel, you can run

# nix-channel --add https://github.com/nix-community/home-manager/archive/release-21.05.tar.gz home-manager
 # nix-channel --update

It is then possible to add

imports = [ <home-manager/nix-darwin> ];

to your nix-darwin configuration.nix file, which will introduce a new NixOS option called home-manager whose type is an attribute set -that maps user names to Home Manager configurations.

For example, a nix-darwin configuration may include the lines

user.users.eve = {
-  name = "eve";
-  home = "/Users/eve";
-}
-home-manager.users.eve = { pkgs, ... }: {
+that maps user names to Home Manager configurations.

For example, a nix-darwin configuration may include the lines

home-manager.users.eve = { pkgs, ... }: {
   home.packages = [ pkgs.atool pkgs.httpie ];
   programs.bash.enable = true;
 };

and after a darwin-rebuild switch the user eve’s environment diff --git a/options.html b/options.html index 7d5d2e18c..4230f5a81 100644 --- a/options.html +++ b/options.html @@ -1,5 +1,10 @@ -Appendix A. Configuration Options

Appendix A. Configuration Options

accounts.email.accounts

List of email accounts.

Type: attribute set of submodules

Default: +Appendix A. Configuration Options

Appendix A. Configuration Options

package

Package containing the volnoti program. +

Type: package

Default: + pkgs.volnoti +

Declared by:

+ <home-manager/modules/services/volnoti.nix> +
accounts.email.accounts

List of email accounts.

Type: attribute set of submodules

Default: { @@ -5847,9 +5852,6 @@ list of Python 3 packages required for your plugins to work. "ps: []"

Example:

(ps: with ps; [ python-language-server ])

Declared by:

<home-manager/modules/programs/neovim.nix> -
programs.neovim.generatedConfigViml

Generated vimscript config. -

Type: strings concatenated with "\n" (read only)

Declared by:

- <home-manager/modules/programs/neovim.nix>
programs.neovim.plugins

List of vim plugins to install optionally associated with configuration to be placed in init.vim. @@ -9587,6 +9589,12 @@ See barrierc --help. Port defaults to 24800.

Type: string

Declared by:

<home-manager/modules/services/barrier.nix> +
services.barrier.client.tray

Whether to enable the system tray icon.

Type: boolean

Default: + true +

Example: + true +

Declared by:

+ <home-manager/modules/services/barrier.nix>
services.blueman-applet.enable

Whether to enable the Blueman applet.

Note, for the applet to work, the 'blueman' service should @@ -11580,11 +11588,6 @@ for a list of available options. false

Example: true -

Declared by:

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

Package containing the volnoti program. -

Type: package

Default: - pkgs.volnoti

Declared by:

<home-manager/modules/services/volnoti.nix>
services.wlsunset.enable

Whether to enable Whether to enable wlsunset..

Type: boolean

Default: diff --git a/tools.html b/tools.html index ae5a2b32c..9cd00175c 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 | @@ -72,15 +72,13 @@ --show-trace ] [ --(no-)substitute - ] [ - --no-out-link ] [ { -v | --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.

@@ -149,7 +147,7 @@ available for immediate garbage collection.

-

Options

+

Options

The tool accepts the options

-A attrPath @@ -243,25 +241,20 @@

Passed on to nix-build(1).

- --no-out-link -

- Passed on to nix-build(1) - when running home-manager build. -

-v , --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