diff --git a/index.html b/index.html index a6e04587..38062f39 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
2.5. Updating
3. Nix Flakes
3.1. Prerequisties
3.2. Standalone setup
3.3. NixOS module
3.4. nix-darwin module
4. Writing Home Manager Modules
4.1. Option Types
5. Contributing
5.1. Getting started
5.2. Guidelines
5.2.1. Maintain backward compatibility
5.2.2. Keep forward compatibility in mind
5.2.3. Add only valuable options
5.2.4. Add relevant tests
5.2.5. Add relevant documentation
5.2.6. Add yourself as a module maintainer
5.2.7. Format your code
5.2.8. Format your commit messages
5.2.9. Format your news entries
5.2.10. Use conditional modules and news
5.2.11. Mind the license
5.3. Commits
5.4. Code Style
5.5. News
5.6. Tests
6. Frequently Asked Questions (FAQ)
6.1. Why is there a collision error when switching generation?
6.2. Why are the session variables not set?
6.3. How to set up a configuration for multiple users/machines?
6.4. Why do I get an error message about ca.desrt.dconf or dconf.service?
6.5. How do I install packages from Nixpkgs unstable?
6.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.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 22.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.11
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 21.05
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 20.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.09
E.7.1. Highlights
E.7.2. State Version Changes
E.8. Release 19.03
E.8.1. Highlights
E.8.2. State Version Changes
E.9. 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
2.5. Updating
3. Nix Flakes
3.1. Prerequisties
3.2. Standalone setup
3.3. NixOS module
3.4. nix-darwin module
4. Writing Home Manager Modules
4.1. Option Types
5. Contributing
5.1. Getting started
5.2. Guidelines
5.2.1. Maintain backward compatibility
5.2.2. Keep forward compatibility in mind
5.2.3. Add only valuable options
5.2.4. Add relevant tests
5.2.5. Add relevant documentation
5.2.6. Add yourself as a module maintainer
5.2.7. Format your code
5.2.8. Format your commit messages
5.2.9. Format your news entries
5.2.10. Use conditional modules and news
5.2.11. Mind the license
5.3. Commits
5.4. Code Style
5.5. News
5.6. Tests
6. Frequently Asked Questions (FAQ)
6.1. Why is there a collision error when switching generation?
6.2. Why are the session variables not set?
6.3. How to set up a configuration for multiple users/machines?
6.4. Why do I get an error message about ca.desrt.dconf or dconf.service?
6.5. How do I install packages from Nixpkgs unstable?
6.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.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 22.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.11
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 21.05
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 20.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.09
E.7.1. Highlights
E.7.2. State Version Changes
E.8. Release 19.03
E.8.1. Highlights
E.8.2. State Version Changes
E.9. 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 a2dc2e4b..509efc7c 100644 --- a/options.html +++ b/options.html @@ -7,6 +7,8 @@ }

Declared by:

<home-manager/modules/services/imapnotify.nix> +
+ <home-manager/modules/programs/thunderbird.nix>
<home-manager/modules/programs/offlineimap.nix>
@@ -783,6 +785,27 @@ Note, if set then the system default may still be accepted.
accounts.email.accounts.<name>.smtp.tls.useStartTls

Whether to use STARTTLS.

Type: boolean

Default: false

Declared by:

<home-manager/modules/accounts/email.nix> +
accounts.email.accounts.<name>.thunderbird.enable

Whether to enable the Thunderbird mail client for this account.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/modules/programs/thunderbird.nix> +
accounts.email.accounts.<name>.thunderbird.profiles

List of Thunderbird profiles for which this account should be +enabled. If this list is empty (the default), this account will +be enabled for all declared profiles. +

Type: list of string

Default: + [ + + ] +

Example:

[ "profile1" "profile2" ]
+

Declared by:

+ <home-manager/modules/programs/thunderbird.nix> +
accounts.email.accounts.<name>.thunderbird.settings

Extra settings to add to this Thunderbird account configuration. +The id given as argument is an automatically +generated account identifier. +

Type: function that evaluates to a(n) attribute set of (boolean or signed integer or string)

Default: _: { }

Example:

id: {
+  "mail.identity.id_${id}.protectSubject" = false;
+  "mail.identity.id_${id}.autoEncryptDrafts" = false;
+};
+

Declared by:

+ <home-manager/modules/programs/thunderbird.nix>
accounts.email.accounts.<name>.userName

The server username of this account. This will be used as the SMTP, IMAP, and JMAP user name.

Type: null or string

Default: null

Declared by:

@@ -7735,6 +7758,43 @@ Requires a window manager that respects scroll hints.
programs.texlive.extraPackages

Extra packages available to TeX Live.

Type: unspecified value

Default: "tpkgs: { inherit (tpkgs) collection-basic; }"

Example:

tpkgs: { inherit (tpkgs) collection-fontsrecommended algorithms; }
 

Declared by:

<home-manager/modules/programs/texlive.nix> +
programs.thunderbird.enable

Whether to enable Thunderbird.

Type: boolean

Default: false

Example: true

Declared by:

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

The Thunderbird package to use.

Type: package

Default: pkgs.thunderbird

Example: pkgs.thunderbird-91

Declared by:

+ <home-manager/modules/programs/thunderbird.nix> +
programs.thunderbird.profiles

Type: attribute set of (submodule)

Declared by:

+ <home-manager/modules/programs/thunderbird.nix> +
programs.thunderbird.profiles.<name>.isDefault

Whether this is a default profile. There must be exactly one +default profile. +

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/modules/programs/thunderbird.nix> +
programs.thunderbird.profiles.<name>.name

This profile's name.

Type: string (read only)

Default: "‹name›"

Declared by:

+ <home-manager/modules/programs/thunderbird.nix> +
programs.thunderbird.profiles.<name>.settings

Preferences to add to this profile's +user.js. +

Type: attribute set of (boolean or signed integer or string)

Default: + { + + } +

Example:

{
+  "mail.spellcheck.inline" = false;
+}
+

Declared by:

+ <home-manager/modules/programs/thunderbird.nix> +
programs.thunderbird.profiles.<name>.withExternalGnupg

Allow using external GPG keys with GPGME.

Type: boolean

Default: false

Example: true

Declared by:

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

Attribute set of Thunderbird preferences to be added to +all profiles. +

Type: attribute set of (boolean or signed integer or string)

Default: + { + + } +

Example:

{
+  "general.useragent.override" = "";
+  "privacy.donottrackheader.enabled" = true;
+}
+

Declared by:

+ <home-manager/modules/programs/thunderbird.nix>
programs.timidity.enable

Whether to enable timidity, a software MIDI renderer.

Type: boolean

Default: false

Example: true

Declared by:

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

The timidity package to use.

Type: package

Default: pkgs.timidity

Declared by:

diff --git a/tools.html b/tools.html index 101bbfec..6647a21c 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