From e6f9f27cbe04bacaa56a01f1e2c45b071f612eed Mon Sep 17 00:00:00 2001 From: rycee Date: Tue, 14 Sep 2021 22:21:53 +0000 Subject: [PATCH] deploy: 514acaebb90dc18ccb577d91faef9089242c9ca0 --- index.html | 4 +- options.html | 116 +++++++++++++++++++++++++++++++++++---------------- tools.html | 14 +++---- 3 files changed, 89 insertions(+), 45 deletions(-) diff --git a/index.html b/index.html index 847d2349b..8d5416ba9 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 describe how to install, use, and extend Home Manager.

diff --git a/options.html b/options.html index 97aa59152..8c0090210 100644 --- a/options.html +++ b/options.html @@ -5,9 +5,7 @@ } -

Declared by:

- <home-manager/modules/services/lieer.nix> -
+

Declared by:

<home-manager/modules/services/imapnotify.nix>
<home-manager/modules/programs/offlineimap.nix> @@ -308,31 +306,6 @@ Note, if set then the system default may still be accepted. false

Example: true -

Declared by:

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

Allow missing labels on the Gmail side to be dropped. -

Type: boolean

Default: - false -

Declared by:

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

Set custom tags to ignore when syncing from local to -remote (after translations). -

Type: list of strings

Default: - - [ - - ] - -

Declared by:

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

Set custom tags to ignore when syncing from remote to -local (before translations). -

Type: list of strings

Default: - - [ - "CATEGORY_FORUMS" "CATEGORY_PROMOTIONS" "CATEGORY_UPDATES" "CATEGORY_SOCIAL" "CATEGORY_PERSONAL" - ] -

Declared by:

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

Warn if Notmuch is not also enabled for this account. @@ -344,17 +317,88 @@ Manager. true

Declared by:

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

Replace '/' with '.' in Gmail labels. +

accounts.email.accounts.<name>.lieer.settings

Settings which are applied to .gmailieer.json +for the account. +

+See the lieer manual +for documentation of settings not explicitly covered by this module. +

Type: JSON value

Default: + + { + + } + +

Declared by:

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

Allow missing labels on the Gmail side to be dropped.

Type: boolean

Default: false +

Declared by:

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

Extension to include in local file names, which can be useful +for indexing with third-party programs. +

Type: string

Default: + "" +

Example: + "mbox" +

Declared by:

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

Work around a Gmail API quirk where an empty change history +is sometimes returned. +

+See this +GitHub issue +for more details. +

Type: boolean

Default: + false +

Declared by:

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

Set Gmail labels to ignore when syncing from remote labels to +local tags (before translations). +

Type: list of strings

Default: + + [ + "CATEGORY_FORUMS" "CATEGORY_PROMOTIONS" "CATEGORY_UPDATES" "CATEGORY_SOCIAL" "CATEGORY_PERSONAL" + ] + +

Declared by:

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

Set labels to ignore when syncing from local tags to +remote labels (after translations). +

Type: list of strings

Default: + + [ + + ] + +

Declared by:

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

Local tag to which the remote Gmail 'TRASH' label is translated. +

Type: string

Default: + "trash" +

Declared by:

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

Remove local messages that have been deleted on the remote. +

Type: boolean

Default: + true +

Declared by:

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

Replace '/' with '.' in Gmail labels. +

Type: boolean

Default: + false +

Declared by:

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

HTTP timeout in seconds. 0 means forever or system timeout. +

Type: unsigned integer, meaning >=0

Default: + 600

Declared by:

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

Whether to enable lieer synchronization service.

Type: boolean

Default: false

Example: true -

Declared by:

- <home-manager/modules/services/lieer.nix> +

Declared by:

+ <home-manager/modules/programs/lieer.nix>
accounts.email.accounts.<name>.lieer.sync.frequency

How often to synchronize the account.

This value is passed to the systemd timer configuration as the @@ -363,11 +407,6 @@ onCalendar option. See for more information about the format.

Type: string

Default: "*:0/5" -

Declared by:

- <home-manager/modules/services/lieer.nix> -
accounts.email.accounts.<name>.lieer.timeout

HTTP timeout in seconds. 0 means forever or system timeout. -

Type: unsigned integer, meaning >=0

Default: - 0

Declared by:

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

Maildir configuration for this account. @@ -4759,6 +4798,11 @@ All string options are quoted with double quotes. false

Example: true +

Declared by:

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

lieer package to use. +

Type: package

Default: + "pkgs.gmailieer"

Declared by:

<home-manager/modules/programs/lieer.nix>
programs.lsd.enable

Whether to enable lsd.

Type: boolean

Default: diff --git a/tools.html b/tools.html index fc5e81b72..4bcb7b367 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 | @@ -82,7 +82,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.

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

-

Options

+

Options

The tool accepts the options

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