From d1c33b50aba7615927c53f5bd941d6778e21a4e7 Mon Sep 17 00:00:00 2001 From: rycee Date: Tue, 21 Jun 2022 22:58:17 +0000 Subject: [PATCH] deploy: d059b9448a04100cdd231872254283dc278a4ea0 --- index.html | 4 +- options.html | 148 ++++++++++++++++++++++++++++++++++++++++++++++++++- tools.html | 14 ++--- 3 files changed, 155 insertions(+), 11 deletions(-) diff --git a/index.html b/index.html index ae168265c..9175bfa07 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -Home Manager Manual
Home Manager Manual
   Next

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
   Next

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 8c7667140..4ac08aeab 100644 --- a/options.html +++ b/options.html @@ -64,6 +64,8 @@ For NixOS, the default value for this option includes at least this argument: <home-manager/modules/programs/notmuch.nix> <home-manager/modules/programs/neomutt.nix> + + <home-manager/modules/programs/mujmap.nix> <home-manager/modules/programs/mu.nix> @@ -140,7 +142,7 @@ special treatment. This option is therefore intended to indicate the nature of the provider.

When this indicates a specific provider then, for example, -the IMAP and SMTP server configuration may be set +the IMAP, SMTP, and JMAP server configuration may be set automatically.

Type: one of "plain", "gmail.com", "runbox.com", "fastmail.com"

Default: "plain"

Declared by:

<home-manager/modules/accounts/email.nix> @@ -273,6 +275,23 @@ Note, if set then the system default may still be accepted. }

Declared by:

<home-manager/modules/services/imapnotify.nix> +
accounts.email.accounts.<name>.jmap

The JMAP configuration to use for this account. +

Type: null or submodule

Default: null

Declared by:

+ <home-manager/modules/accounts/email.nix> +
accounts.email.accounts.<name>.jmap.host

Hostname of JMAP server. +

+If both this option and accounts.email.accounts.<name>.jmap.sessionUrl are specified, +host is preferred by applications when establishing a +session. +

Type: null or string

Default: null

Example: "jmap.example.org"

Declared by:

+ <home-manager/modules/accounts/email.nix> +
accounts.email.accounts.<name>.jmap.sessionUrl

URL for the JMAP Session resource. +

+If both this option and accounts.email.accounts.<name>.jmap.host are specified, +host is preferred by applications when establishing a +session. +

Type: null or string

Default: null

Example: "https://jmap.example.org:443/.well-known/jmap"

Declared by:

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

Whether to enable lieer Gmail synchronization for notmuch.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/lieer.nix>
accounts.email.accounts.<name>.lieer.notmuchSetupWarning

Warn if Notmuch is not also enabled for this account. @@ -536,6 +555,126 @@ The fingerprint can be obtained by executing <home-manager/modules/programs/msmtp.nix>

accounts.email.accounts.<name>.mu.enable

Whether to enable mu indexing.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/mu.nix> +
accounts.email.accounts.<name>.mujmap.enable

Whether to enable mujmap JMAP synchronization for notmuch.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/modules/programs/mujmap.nix> +
accounts.email.accounts.<name>.mujmap.notmuchSetupWarning

Warn if Notmuch is not also enabled for this account. +

+This can safely be disabled if mujmap.toml is managed +outside of Home Manager. +

Type: boolean

Default: true

Declared by:

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

Settings which are applied to mujmap.toml +for the account. +

+See the mujmap project +for documentation of settings not explicitly covered by this module. +

Type: TOML value

Default: + { + + } +

Declared by:

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

Whether to create new mailboxes automatically on the server from notmuch +tags. +

Type: boolean

Default: true

Declared by:

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

The cache directory in which to store mail files while they are being +downloaded. The default is operating-system specific. +

Type: null or string

Default: null

Declared by:

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

Fully qualified domain name of the JMAP service. +

+mujmap looks up the JMAP SRV record for this host to determine the JMAP session +URL. Mutually exclusive with +accounts.email.accounts.<name>.mujmap.settings.session_url. +

+If null, defaults to +accounts.email.accounts.<name>.jmap.host. +

Type: null or string

Default: null

Example: "example.com"

Declared by:

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

Shell command which will print a password to stdout for basic HTTP +authentication. +

+If null, defaults to +accounts.email.accounts.<name>.passwordCommand. +

Type: null or string or list of string

Default: null

Example: "pass alice@example.com"

Declared by:

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

Sesion URL to connect to. +

+Mutually exclusive with +accounts.email.accounts.<name>.mujmap.settings.fqdn. +

+If null, defaults to +accounts.email.accounts.<name>.jmap.sessionUrl. +

Type: null or string

Default: null

Example: "https://jmap.example.com/.well-known/jmap"

Declared by:

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

Tag configuration. +

+Beware that there are quirks that require manual consideration if changing the +values of these files; please see +https://github.com/elizagamedev/mujmap/blob/main/mujmap.toml.example +for more details. +

Type: TOML value

Default: + { + + } +

Declared by:

+ <home-manager/modules/programs/mujmap.nix> +
accounts.email.accounts.<name>.mujmap.settings.tags.deleted

Tag for notmuch to use for messages stored in the mailbox labeled with the +Trash name attribute. +

+If set to an empty string, this mailbox and its child +mailboxes are not synchronized with a tag. +

Type: string

Default: "deleted"

Declared by:

+ <home-manager/modules/programs/mujmap.nix> +
accounts.email.accounts.<name>.mujmap.settings.tags.directory_separator

Directory separator for mapping notmuch tags to maildirs. +

Type: string

Default: "/"

Example: "."

Declared by:

+ <home-manager/modules/programs/mujmap.nix> +
accounts.email.accounts.<name>.mujmap.settings.tags.important

Tag for notmuch to use for messages stored in the mailbox labeled with the +Important name attribute and/or with the $Important +keyword. +

+If set to an empty string, this mailbox, its child +mailboxes, and these keywords are not synchronized with a tag. +

Type: string

Default: "important"

Declared by:

+ <home-manager/modules/programs/mujmap.nix> +
accounts.email.accounts.<name>.mujmap.settings.tags.inbox

Tag for notmuch to use for messages stored in the mailbox labeled with the +Inbox name attribute. +

+If set to an empty string, this mailbox and its child +mailboxes are not synchronized with a tag. +

Type: string

Default: "inbox"

Declared by:

+ <home-manager/modules/programs/mujmap.nix> +
accounts.email.accounts.<name>.mujmap.settings.tags.lowercase

If true, translate all mailboxes to lowercase names when mapping to notmuch +tags. +

Type: boolean

Default: false

Declared by:

+ <home-manager/modules/programs/mujmap.nix> +
accounts.email.accounts.<name>.mujmap.settings.tags.phishing

Tag for notmuch to use for the IANA $Phishing keyword. +

+If set to an empty string, this keyword is not synchronized with a tag. +

Type: string

Default: "phishing"

Declared by:

+ <home-manager/modules/programs/mujmap.nix> +
accounts.email.accounts.<name>.mujmap.settings.tags.sent

Tag for notmuch to use for messages stored in the mailbox labeled with the +Sent name attribute. +

+If set to an empty string, this mailbox and its child +mailboxes are not synchronized with a tag. +

Type: string

Default: "sent"

Declared by:

+ <home-manager/modules/programs/mujmap.nix> +
accounts.email.accounts.<name>.mujmap.settings.tags.spam

Tag for notmuch to use for messages stored in the mailbox labeled with the +Junk name attribute and/or with the $Junk keyword, +except for messages with the $NotJunk keyword. +

+If set to an empty string, this mailbox, its child +mailboxes, and these keywords are not synchronized with a tag. +

Type: string

Default: "spam"

Declared by:

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

Username for basic HTTP authentication. +

+If null, defaults to +accounts.email.accounts.<name>.userName. +

Type: null or string

Default: null

Example: "alice@example.com"

Declared by:

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

Unique identifier of the account. This is set to the attribute name of the account configuration.

Type: string (read only)

Declared by:

@@ -660,7 +799,7 @@ Note, if set then the system default may still be accepted.

Type: boolean

Default: false

Declared by:

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

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

Type: null or string

Default: null

Declared by:

<home-manager/modules/accounts/email.nix>
accounts.email.certificatesFile

Path to default file containing certificate authorities that @@ -5057,6 +5196,11 @@ Account commands should be placed in <home-manager/modules/programs/msmtp.nix>

programs.mu.enable

Whether to enable mu, a maildir indexer and searcher.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/mu.nix> +
programs.mujmap.enable

Whether to enable mujmap Gmail synchronization for notmuch.

Type: boolean

Default: false

Example: true

Declared by:

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

mujmap package to use. +

Type: package

Default: "pkgs.mujmap"

Declared by:

+ <home-manager/modules/programs/mujmap.nix>
programs.navi.enable

Whether to enable Navi.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/navi.nix>
programs.navi.enableBashIntegration

Whether to enable Bash integration.

Type: boolean

Default: true

Example: true

Declared by:

diff --git a/tools.html b/tools.html index ae5d988a2..2494d91e0 100644 --- a/tools.html +++ b/tools.html @@ -1,6 +1,6 @@ -Appendix D. Tools
Appendix D. Tools
Prev   Next

Appendix D. Tools

home-manager - — reconfigure a user environment

Name

home-manager +Appendix D. Tools

Appendix D. Tools
Prev   Next

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)

Prev   Next
Appendix C. nix-darwin Module Options Home Appendix E. Release Notes
\ No newline at end of file