From acd8c76703bccaf7c8cf52725e3367eef1b84ee5 Mon Sep 17 00:00:00 2001 From: teto Date: Tue, 13 Jun 2023 09:08:58 +0000 Subject: [PATCH] deploy: d9a97e8b33227a6086538ac2d3d1960b03ed940c --- options.html | 253 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 252 insertions(+), 1 deletion(-) diff --git a/options.html b/options.html index 8a785a0dd..b25d49ec5 100644 --- a/options.html +++ b/options.html @@ -1,5 +1,256 @@ -Appendix A. Configuration Options
Appendix A. Configuration Options
Prev   Next

Appendix A. Configuration Options

accounts.email.accounts

List of email accounts.

Type: attribute set of (submodule)

Default: { }

Declared by:

+Appendix A. Configuration Options
Appendix A. Configuration Options
Prev   Next

Appendix A. Configuration Options

accounts.calendar.accounts

List of calendars.

Type: attribute set of (submodule)

Default: { }

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.khal.enable

Whether to enable khal access.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.khal.color

Color in which events in this calendar are displayed.

Type: null or one of "black", "white", "brown", "yellow", "dark gray", "dark green", "dark blue", "light gray", "light green", "light blue", "dark magenta", "dark cyan", "dark red", "light magenta", "light cyan", "light red"

Default: null

Example: "light green"

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.khal.glob

The glob expansion to be searched for events or birthdays when +type is set to discover.

Type: string

Default: "*"

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.khal.priority

Priority of a calendar used for coloring.

Type: signed integer

Default: 10

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.khal.readOnly

Keep khal from making any changes to this account.

Type: boolean

Default: false

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.khal.type

There is no description of this option.

Type: null or one of "calendar", "discover"

Default: null

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.local

Local configuration for the calendar.

Type: null or (submodule)

Default: null

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.local.encoding

File encoding for items, both content and file name. +Defaults to UTF-8.

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.local.fileExt

The file extension to use.

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.local.path

The path of the storage.

Type: string

Default: "‹accounts.contact.basePath›/‹name›"

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.local.type

The type of the storage.

Type: one of "filesystem", "singlefile"

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.name

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

Type: string (read only)

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.primary

Whether this is the primary account. Only one account may be +set as primary.

Type: boolean

Default: false

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.primaryCollection

The primary collection of the account. Required when an +account has multiple collections.

Type: string

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.remote

Remote configuration for the calendar.

Type: null or (submodule)

Default: null

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.remote.passwordCommand

A command that prints the password to standard output.

Type: null or (list of string)

Default: null

Example: 

[
+  "pass"
+  "caldav"
+]

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.remote.type

The type of the storage.

Type: one of "caldav", "http", "google_calendar"

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.remote.url

The URL of the storage.

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.remote.userName

User name for authentication.

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.enable

Whether to enable synchronization using vdirsyncer.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.auth

Authentication settings. The default is basic.

Type: null or one of "basic", "digest", "guess"

Default: null

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.authCert

Either a path to a certificate with a client certificate and +the key or a list of paths to the files with them.

Type: null or string or list of string

Default: null

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.clientIdCommand

A command that prints the OAuth credentials to standard +output. +

+See +https://vdirsyncer.pimutils.org/en/stable/config.html#google +for more information.

Type: null or (list of string)

Default: null

Example: 

[
+  "pass"
+  "client_id"
+]

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.clientSecretCommand

A command that prints the OAuth credentials to standard +output. +

+See +https://vdirsyncer.pimutils.org/en/stable/config.html#google +for more information.

Type: null or (list of string)

Default: null

Example: 

[
+  "pass"
+  "client_secret"
+]

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.collections

The collections to synchronize between the storages.

Type: null or (list of (string or list of string))

Default: null

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.conflictResolution

What to do in case of a conflict between the storages. Either +remote wins or +local wins or +a list that contains a command to run. By default, an error +message is printed.

Type: null or one of "remote wins", "local wins" or list of string

Default: null

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.itemTypes

Kinds of items to show. The default is to show everything. +This depends on particular features of the server, the results +are not validated.

Type: null or (list of string)

Default: null

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.metadata

Metadata keys that should be synchronized when vdirsyncer +metasync is executed.

Type: list of string

Default: [ ]

Example: 

[
+  "color"
+  "displayname"
+]

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.partialSync

What should happen if synchronization in one direction +is impossible due to one storage being read-only. +Defaults to revert. +

+See +https://vdirsyncer.pimutils.org/en/stable/config.html#pair-section +for more information.

Type: null or one of "revert", "error", "ignore"

Default: null

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.postHook

Command to call for each item creation and modification. +The command will be called with the path of the new/updated +file.

Type: strings concatenated with "\n"

Default: ""

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.timeRange

A time range to synchronize. start and end can be any Python +expression that returns a datetime.datetime +object.

Type: null or (submodule)

Default: null

Example: 

{
+  end = "datetime.now() + timedelta(days=365)";
+  start = "datetime.now() - timedelta(days=365)";
+}

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.timeRange.end

End of time range to show.

Type: string

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.timeRange.start

Start of time range to show.

Type: string

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.tokenFile

A file path where access tokens are stored.

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.userAgent

The user agent to report to the server. Defaults to +vdirsyncer.

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.verify

Verify SSL certificate.

Type: null or boolean

Default: null

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.accounts.<name>.vdirsyncer.verifyFingerprint

Optional. SHA1 or MD5 fingerprint of the expected server certificate. +

+See +https://vdirsyncer.pimutils.org/en/stable/ssl-tutorial.html#ssl-tutorial +for more information.

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.calendar.basePath

The base directory in which to save calendars. May be a +relative path, in which case it is relative the home +directory.

Type: string

Declared by:

+ <home-manager/modules/accounts/calendar.nix> +
accounts.contact.accounts

List of contacts.

Type: attribute set of (submodule)

Default: { }

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.khal.enable

Whether to enable khal access.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.khal.readOnly

Keep khal from making any changes to this account.

Type: boolean

Default: false

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.local

Local configuration for the contacts.

Type: null or (submodule)

Default: null

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.local.encoding

File encoding for items, both content and file name. +Defaults to UTF-8.

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.local.fileExt

The file extension to use.

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.local.path

The path of the storage.

Type: string

Default: "‹accounts.contact.basePath›/‹name›"

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.local.type

The type of the storage.

Type: one of "filesystem", "singlefile"

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.name

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

Type: string (read only)

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.remote

Remote configuration for the contacts.

Type: null or (submodule)

Default: null

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.remote.passwordCommand

A command that prints the password to standard output.

Type: null or (list of string)

Default: null

Example: 

[
+  "pass"
+  "caldav"
+]

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.remote.type

The type of the storage.

Type: one of "carddav", "http", "google_contacts"

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.remote.url

The URL of the storage.

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.remote.userName

User name for authentication.

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.enable

Whether to enable synchronization using vdirsyncer.

Type: boolean

Default: false

Example: true

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.auth

Authentication settings. The default is basic.

Type: null or one of "basic", "digest", "guess"

Default: null

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.authCert

Either a path to a certificate with a client certificate and +the key or a list of paths to the files with them.

Type: null or string or list of string

Default: null

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.clientIdCommand

A command that prints the OAuth credentials to standard +output. +

+See +https://vdirsyncer.pimutils.org/en/stable/config.html#google +for more information.

Type: null or (list of string)

Default: null

Example: 

[
+  "pass"
+  "client_id"
+]

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.clientSecretCommand

A command that prints the OAuth credentials to standard +output. +

+See +https://vdirsyncer.pimutils.org/en/stable/config.html#google +for more information.

Type: null or (list of string)

Default: null

Example: 

[
+  "pass"
+  "client_secret"
+]

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.collections

The collections to synchronize between the storages.

Type: null or (list of (string or list of string))

Default: null

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.conflictResolution

What to do in case of a conflict between the storages. Either +remote wins or +local wins or +a list that contains a command to run. By default, an error +message is printed.

Type: null or one of "remote wins", "local wins" or list of string

Default: null

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.itemTypes

Kinds of items to show. The default is to show everything. +This depends on particular features of the server, the results +are not validated.

Type: null or (list of string)

Default: null

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.metadata

Metadata keys that should be synchronized when vdirsyncer +metasync is executed.

Type: list of string

Default: [ ]

Example: 

[
+  "color"
+  "displayname"
+]

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.partialSync

What should happen if synchronization in one direction +is impossible due to one storage being read-only. +Defaults to revert. +

+See +https://vdirsyncer.pimutils.org/en/stable/config.html#pair-section +for more information.

Type: null or one of "revert", "error", "ignore"

Default: null

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.postHook

Command to call for each item creation and modification. +The command will be called with the path of the new/updated +file.

Type: strings concatenated with "\n"

Default: ""

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.timeRange

A time range to synchronize. start and end can be any Python +expression that returns a datetime.datetime +object.

Type: null or (submodule)

Default: null

Example: 

{
+  end = "datetime.now() + timedelta(days=365)";
+  start = "datetime.now() - timedelta(days=365)";
+}

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.timeRange.end

End of time range to show.

Type: string

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.timeRange.start

Start of time range to show.

Type: string

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.tokenFile

A file path where access tokens are stored.

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.userAgent

The user agent to report to the server. Defaults to +vdirsyncer.

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.verify

Verify SSL certificate.

Type: null or boolean

Default: null

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.accounts.<name>.vdirsyncer.verifyFingerprint

Optional. SHA1 or MD5 fingerprint of the expected server certificate. +

+See +https://vdirsyncer.pimutils.org/en/stable/ssl-tutorial.html#ssl-tutorial +for more information.

Type: null or string

Default: null

Declared by:

+ <home-manager/modules/accounts/contacts.nix> +
accounts.contact.basePath

The base directory in which to save contacts. May be a +relative path, in which case it is relative the home +directory.

Type: string

Declared by:

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

List of email accounts.

Type: attribute set of (submodule)

Default: { }

Declared by:

<home-manager/modules/services/imapnotify.nix>
<home-manager/modules/programs/thunderbird.nix>