Options Search

List of calendars.

Email addresses to be associated with this account. Used to check the participation status ("PARTSTAT"), refer to khal documentation.

Color in which events in this calendar are displayed. For instance 'light green' or an RGB color '#ff0000'

Whether to enable khal access.

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

Priority of a calendar used for coloring (calendar with highest priority is preferred).

Keep khal from making any changes to this account.

Either a single calendar (calendar which is the default) or a directory with multiple calendars (discover).

Local configuration for the calendar.

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

The file extension to use.

The path of the storage.

The type of the storage.

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

Whether to enable synchronization using pimsync.

Extra directives that should be added under this accounts local storage directive

Extra directives that should be added under this accounts pair directive

Extra directives that should be added under this accounts remote storage directive

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

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

Whether to enable qcal access.

Remote configuration for the calendar.

A command that prints the password to standard output.

The type of the storage.

The URL of the storage.

User name for authentication.

Display color of the calendar in hex

Whether to enable the Thunderbird mail client for this account.

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.

Mark calendar as read only

Authentication settings. The default is `basic`.

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

A command that prints the OAuth credentials to standard output. See <https://vdirsyncer.pimutils.org/en/stable/config.html#google> for more information.

A command that prints the OAuth credentials to standard output. See <https://vdirsyncer.pimutils.org/en/stable/config.html#google> for more information.

The collections to synchronize between the storages.

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.

Whether to enable synchronization using vdirsyncer.

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

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

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.

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

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

End of time range to show.

Start of time range to show.

A file path where access tokens are stored.

A command that prints the URL of the storage.

Specifies whether vdirsyncer should request vCards in version 4.0. If set to `false` then vdirsyncer will default to version 3.0.

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

A command that prints the user name to standard output.

Null or path to certificate to verify SSL against

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.

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

List of contacts.

Email addresses to be associated with this account. Used to check the participation status ("PARTSTAT"), refer to khal documentation.

VCARD collections to be searched for contact birthdays.

Color in which events in this calendar are displayed. For instance 'light green' or an RGB color '#ff0000'

Whether to enable khal access.

Priority of a calendar used for coloring (calendar with highest priority is preferred).

Keep khal from making any changes to this account.

If provided, each item on this list will generate an entry on khard configuration file as a separate addressbook (vdir). This is used for hardcoding sub-directories under the local storage path (accounts.contact.accounts.<name>.local.path) for khard. The default value will set the aforementioned path as a single vdir.

Whether to enable khard access.

The glob expansion to be searched for contacts when type is set to discover.

Either a single vdir located in [](#opt-accounts.contact.accounts._name_.local.path) or multiple automatically discovered vdirs in [](#opt-accounts.contact.accounts._name_.local.path)/[](#opt-accounts.contact.accounts._name_.khard.glob).

Local configuration for the contacts.

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

The file extension to use.

The path of the storage.

The type of the storage.

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

Whether to enable synchronization using pimsync.

Extra directives that should be added under this accounts local storage directive

Extra directives that should be added under this accounts pair directive

Extra directives that should be added under this accounts remote storage directive

Remote configuration for the contacts.

A command that prints the password to standard output.

The type of the storage.

The URL of the storage.

User name for authentication.

Whether to enable the Thunderbird mail client for this account.

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.

A token is generated when adding an address book manually to Thunderbird, this can be entered here.

Authentication settings. The default is `basic`.

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

A command that prints the OAuth credentials to standard output. See <https://vdirsyncer.pimutils.org/en/stable/config.html#google> for more information.

A command that prints the OAuth credentials to standard output. See <https://vdirsyncer.pimutils.org/en/stable/config.html#google> for more information.

The collections to synchronize between the storages.

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.

Whether to enable synchronization using vdirsyncer.

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

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

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.

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

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

End of time range to show.

Start of time range to show.

A file path where access tokens are stored.

A command that prints the URL of the storage.

Specifies whether vdirsyncer should request vCards in version 4.0. If set to `false` then vdirsyncer will default to version 3.0.

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

A command that prints the user name to standard output.

Null or path to certificate to verify SSL against

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.

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

List of email accounts.

The email address of this account.

Whether to enable aerc.

Extra config added to the configuration section for this account in {file}`$HOME/.config/aerc/accounts.conf`. See {manpage}`aerc-accounts(5)`.

Extra bindings specific to this account, added to {file}`$HOME/.config/aerc/binds.conf`. See {manpage}`aerc-binds(5)`.

Config specific to this account, added to {file}`$HOME/.config/aerc/aerc.conf`. Aerc only supports per-account UI configuration. For other sections of {file}`$HOME/.config/aerc/aerc.conf`, use `programs.aerc.extraConfig`. See {manpage}`aerc-config(5)`.

Sets the authentication mechanism if imap is used as the incoming method. See {manpage}`aerc-imap(5)`.

Sets the oauth2 params if authentication mechanism oauthbearer or xoauth2 is used. See {manpage}`aerc-imap(5)`.

The OAuth2 client identifier.

The OAuth2 client secret.

The OAuth2 requested scope.

The OAuth2 token endpoint.

Sets the authentication mechanism if smtp is used as the outgoing method. See {manpage}`aerc-smtp(5)`.

Sets the oauth2 params if authentication mechanism oauthbearer or xoauth2 is used. See {manpage}`aerc-imap(5)`.

The OAuth2 client identifier.

The OAuth2 client secret.

The OAuth2 requested scope.

The OAuth2 token endpoint.

Alternative identities of this account.

Contact completion configuration as expected per alot. See [alot's wiki](http://alot.readthedocs.io/en/latest/configuration/contacts_completion.html) for explanation about possible values.

Extra settings to add to this Alot account configuration.

Command to send a mail. If msmtp is enabled for the account, then this is set to {command}`msmtpq --read-envelope-from --read-recipients`.

Whether to enable Astroid.

Extra settings to add to this astroid account configuration.

Command to send a mail. If msmtp is enabled for the account, then this is set to {command}`msmtpq --read-envelope-from --read-recipients`.

Whether this account is enabled. Potentially useful to allow setting email configuration globally then enabling or disabling on specific systems.

Some email providers have peculiar behavior that require 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, SMTP, and JMAP server configuration may be set automatically.

Standard email folders.

Relative path of the drafts mail folder.

Relative path of the inbox mail.

Relative path of the sent mail folder.

Relative path of the deleted mail folder.

Enable if you want to delete read messages from the server. Most users should either enable `delete` or disable `readAll`.

Specify a command delivering the incoming mail to your maildir.

Whether to enable the getmail mail retriever for this account.

A non-empty list of mailboxes. To download all mail you can use the `ALL` mailbox.

Enable if you want to fetch all, even the read messages from the server. Most users should either enable `delete` or disable `readAll`.

GPG configuration.

Encrypt outgoing messages by default.

The key to use as listed in {command}`gpg --list-keys`.

Sign messages by default.

Whether to enable the email client Himalaya CLI for this email account.

Himalaya CLI configuration for this email account. See <https://github.com/pimalaya/himalaya/blob/master/config.sample.toml> for supported values.

The IMAP configuration to use for this account.

The authentication mechanism.

Hostname of IMAP server.

The port on which the IMAP server listens. If `null` then the default port is used.

Configuration for secure connections.

Path to file containing certificate authorities that should be used to validate the connection authenticity. If `null` then the system default is used. Note, if set then the system default may still be accepted.

Whether to enable TLS/SSL.

Whether to use STARTTLS.

IMAP folders to watch.

Whether to enable imapnotify.

Extra arguments to pass to goimapnotify.

Additional configuration to add for this account.

Shell commands to run on any event.

Shell commands to run after onNotify event.

The JMAP configuration to use for this account.

Hostname of JMAP server. If both this option and [](#opt-accounts.email.accounts._name_.jmap.sessionUrl) are specified, `host` is preferred by applications when establishing a session.

URL for the JMAP Session resource. If both this option and [](#opt-accounts.email.accounts._name_.jmap.host) are specified, `host` is preferred by applications when establishing a session.

Whether to enable lieer Gmail synchronization for notmuch.

Warn if Notmuch is not also enabled for this account. This can safely be disabled if {command}`notmuch init` has been used to configure this account outside of Home Manager.

Settings which are applied to {file}`.gmailieer.json` for the account. See the [lieer manual](https://github.com/gauteh/lieer/) for documentation of settings not explicitly covered by this module.

Allow missing labels on the Gmail side to be dropped.

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

Work around a Gmail API quirk where an empty change history is sometimes returned. See this [GitHub issue](https://github.com/gauteh/lieer/issues/120) for more details.

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

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

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

Remove local messages that have been deleted on the remote.

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

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

Whether to enable lieer synchronization service.

How often to synchronize the account. This value is passed to the systemd timer configuration as the onCalendar option. See {manpage}`systemd.time(7)` for more information about the format.

Maildir configuration for this account.

Path to maildir directory where mail for this account is stored. This is relative to the base maildir path.

Automatically create missing mailboxes within the given mail store.

Whether to enable synchronization using mbsync.

Permanently remove messages marked for deletion from the given mail store.

Account section extra configuration.

Per channel extra configuration.

Local store extra configuration.

Remote store extra configuration.

If set, flattens the hierarchy within the maildir by substituting the canonical hierarchy delimiter `/` with this value.

Some email providers (Gmail) have a different directory hierarchy for synchronized email messages. Namely, when using mbsync without specifying a set of channels into a group, all synchronized directories end up beneath the `[Gmail]/` directory. This option allows you to specify a group, and subsequently channels that will allow you to sync your mail into an arbitrary hierarchy.

List of channels that should be grouped together into this group. When performing a synchronization, the groups are synchronized, rather than the individual channels. Using these channels and then grouping them together allows for you to define the maildir hierarchy as you see fit.

Extra configuration lines to add to *THIS* channel's configuration.

IMAP4 patterns for which mailboxes on the remote mail server to sync. If `Patterns` are specified, `farPattern` is interpreted as a prefix which is not matched against the patterns, and is not affected by mailbox list overrides. If this is left as the default, then mbsync will default to the pattern `INBOX`.

The unique name for THIS channel in THIS group. The group will refer to this channel by this name. In addition, you can manually sync just this channel by specifying this name to mbsync on the command line.

Name for where mail coming from the remote (far) mail server will end up locally. The mailbox specified by the far pattern will be placed in this directory. If this is left as the default, then mbsync will default to the pattern `INBOX`.

Instead of synchronizing *just* the mailboxes that match the `farPattern`, use it as a prefix which is not matched against the patterns, and is not affected by mailbox list overrides.

The name of this group for this account. These names are different than some others, because they will hide channel names that are the same.

Pattern of mailboxes to synchronize.

Propagate mailbox deletions to the given mail store.

The on-disk folder naming style. This option has no effect when {option}`flatten` is used.

Whether to enable the meli mail client for this account. Requires SMTP settings..

Folder display name

Mailboxes to show in meli

Account specific meli configuration

Whether to enable msmtp. If enabled then it is possible to use the `--account` command line option to send a message for a given account using the {command}`msmtp` or {command}`msmtpq` tool. For example, {command}`msmtp --account=private` would send using the account defined in {option}`accounts.email.accounts.private`. If the `--account` option is not given then the primary account will be used.

Extra configuration options to add to {file}`~/.msmtprc`. See <https://marlam.de/msmtp/msmtprc.txt> for examples.

Fingerprint of a trusted TLS certificate. The fingerprint can be obtained by executing {command}`msmtp --serverinfo --tls --tls-certcheck=off`.

Whether to enable mu indexing.

Whether to enable mujmap JMAP synchronization for notmuch.

Warn if Notmuch is not also enabled for this account. This can safely be disabled if {file}`mujmap.toml` is managed outside of Home Manager.

Settings which are applied to {file}`mujmap.toml` for the account. See the [mujmap project](https://github.com/elizagamedev/mujmap) for documentation of settings not explicitly covered by this module.

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

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

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 [](#opt-accounts.email.accounts._name_.mujmap.settings.session_url). If `null`, defaults to [](#opt-accounts.email.accounts._name_.jmap.host).

Shell command which will print a password to stdout for basic HTTP authentication. If `null`, defaults to [](#opt-accounts.email.accounts._name_.passwordCommand).

Session URL to connect to. Mutually exclusive with [](#opt-accounts.email.accounts._name_.mujmap.settings.fqdn). If `null`, defaults to [](#opt-accounts.email.accounts._name_.jmap.sessionUrl).

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.

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.

Directory separator for mapping notmuch tags to maildirs.

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.

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.

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

Tag for notmuch to use for the IANA `$Phishing` keyword. If set to an empty string, this keyword is not synchronized with a tag.

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.

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.

Username for basic HTTP authentication. If `null`, defaults to [](#opt-accounts.email.accounts._name_.userName).

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

Whether to enable NeoMutt.

Extra lines to add to the folder hook for this account.

List of extra mailboxes

Name of mailbox folder to be included

Name to display

Whether this mailbox is a maildir folder or an IMAP mailbox

Use a different name as mailbox name

Whether this account uses maildir folders or IMAP mailboxes

Command to send a mail. If not set, neomutt will be in charge of sending mails.

Show the default mailbox (INBOX)

Whether to enable notmuch indexing.

Whether to enable Notmuch support in NeoMutt.

List of virtual mailboxes using Notmuch queries

Restricts number of messages/threads in the result.

Name to display

Notmuch query

Reads all matching messages or whole-threads. The default is 'messages' or nm_query_type.

Whether to enable OfflineIMAP.

Extra configuration options to add to the account section.

Extra configuration options to add to the local account section.

Extra configuration options to add to the remote account section.

Command to run after fetching new mails.

A command, which when run writes the account password on standard output.

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

Name displayed when sending mails.

Signature configuration.

A command that generates a signature.

The delimiter used between the document and the signature.

Method to communicate the signature.

Signature content.

The SMTP configuration to use for this account.

The authentication mechanism.

Hostname of SMTP server.

The port on which the SMTP server listens. If `null` then the default port is used.

Configuration for secure connections.

Path to file containing certificate authorities that should be used to validate the connection authenticity. If `null` then the system default is used. Note, if set then the system default may still be accepted.

Whether to enable TLS/SSL.

Whether to use STARTTLS.

Whether to enable the Thunderbird mail client for this account.

List of message filters to add to this Thunderbird account configuration.

Action to perform on matched messages.

Argument passed to the filter action, e.g. a folder path.

Condition to match messages against.

Whether this filter is currently active.

Extra settings to apply to the filter

Name for the filter.

The raw text of the filter. Note that this will override all other options.

Type for this filter.

Extra settings to add to each identity of this Thunderbird account configuration. The {var}`id` given as argument is an automatically generated identifier.

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.

Extra settings to add to this Thunderbird account configuration. The {var}`id` given as argument is an automatically generated account identifier.

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

Path to default file containing certificate authorities that should be used to validate the connection authenticity. This path may be overridden on a per-account basis.

The base directory for account maildir directories. May be a relative path (e.g. the user setting this value as "MyMaildir"), in which case it is relative the home directory (e.g. resulting in "~/MyMaildir").

Packages whose D-Bus configuration files should be included in the configuration of the D-Bus session-wide message bus. Specifically, files in «pkg»/share/dbus-1/services will be included in the user's $XDG_DATA_HOME/dbus-1/services directory.

Settings to write to specific dconf user databases. See [](#opt-dconf.settings) for details.

Settings to write to the dconf configuration system. Note that the database is strongly-typed so you need to use the same types as described in the GSettings schema. For example, if an option is of type `uint32` (`u`), you need to wrap the number using the `lib.hm.gvariant.mkUint32` constructor. Otherwise, since Nix integers are implicitly coerced to `int32` (`i`), it would get stored in the database as such, and GSettings might be confused when loading the setting. You might want to use [dconf2nix](https://github.com/gvolpe/dconf2nix) to convert dconf database dumps into compatible Nix expression.

Whether to enable EditorConfig home configuration file.

Configuration written to {file}`$HOME/.editorconfig`. `root = true` is automatically added to the file, it must not be added here. See <https://editorconfig.org> for documentation.

Whether to enable font antialiasing.

Extra font config files that will be added to `~/.config/fontconfig/conf.d/`. Files are named like `fontconfig/conf.d/{priority}-{label}.conf`.

Whether to enable Whether this font config file should be generated..

Label to use for the name of the config file.

Determines the order in which configs are loaded. Must be a value within the range of 0-99, where priority 0 is the highest priority and 99 is the lowest.

Config file to source. Alternatively, use the 'text' option instead.

Verbatim contents of the config file. If this option is null then the 'source' option must be set.

Per-user default emoji font(s). Multiple fonts may be listed in case a font does not support all emoji. Note that fontconfig matches color emoji fonts preferentially, so if you want to use a black and white font while having a color font installed (eg. Noto Color Emoji installed alongside Noto Emoji), fontconfig will still choose the color font even when it is later in the list.

Per-user default monospace font(s). Multiple fonts may be listed in case multiple languages must be supported.

Per-user default sans serif font(s). Multiple fonts may be listed in case multiple languages must be supported.

Per-user default serif font(s). Multiple fonts may be listed in case multiple languages must be supported.

Whether to enable fontconfig configuration. This will, for example, allow fontconfig to discover fonts and configurations installed through {var}`home.packages` and {command}`nix-env`.

The font hinting mode.

The sub-pixel rendering mode.

Default color scheme for all GTK versions

Default cursor theme for all GTK versions.

The name of the cursor theme within the package.

Package providing the cursor theme. This package will be installed to your profile. If `null` then the cursor theme is assumed to already be available in your profile.

The size of the cursor.

Whether to enable GTK theming and configuration.

Default font for all GTK versions.

The family name of the font within the package.

Package providing the font. This package will be installed to your profile. If `null` then the font is assumed to already be available in your profile.

The size of the font.

The location of the GTK 2 configuration file.

Cursor theme for GTK 2 applications.

The name of the cursor theme within the package.

Package providing the cursor theme. This package will be installed to your profile. If `null` then the cursor theme is assumed to already be available in your profile.

The size of the cursor.

Whether to enable GTK 2 configuration.

Extra lines to add to {file}`~/.gtkrc-2.0`.

Font for GTK 2 applications.

The family name of the font within the package.

Package providing the font. This package will be installed to your profile. If `null` then the font is assumed to already be available in your profile.

The size of the font.

Whether to enable GTK 2 config force overwrite without creating a backup.

Icon theme for GTK 2 applications.

The name of the icon theme within the package.

Package providing the icon theme. This package will be installed to your profile. If `null` then the icon theme is assumed to already be available in your profile.

Theme for GTK 2 applications.

The name of the theme within the package.

Package providing the theme. This package will be installed to your profile. If `null` then the theme is assumed to already be available in your profile. For the theme to apply to GTK 4, this option is mandatory.

File browser bookmarks.

Color scheme for GTK 3 applications.

Cursor theme for GTK 3 applications.

The name of the cursor theme within the package.

Package providing the cursor theme. This package will be installed to your profile. If `null` then the cursor theme is assumed to already be available in your profile.

The size of the cursor.

Whether to enable GTK 3 configuration.

Extra settings for {file}`$XDG_CONFIG_HOME/gtk-3.0/settings.ini`.

Extra CSS for {file}`$XDG_CONFIG_HOME/gtk-3.0/gtk.css`.

Font for GTK 3 applications.

The family name of the font within the package.

Package providing the font. This package will be installed to your profile. If `null` then the font is assumed to already be available in your profile.

The size of the font.

Icon theme for GTK 3 applications.

The name of the icon theme within the package.

Package providing the icon theme. This package will be installed to your profile. If `null` then the icon theme is assumed to already be available in your profile.

Theme for GTK 3 applications.

The name of the theme within the package.

Package providing the theme. This package will be installed to your profile. If `null` then the theme is assumed to already be available in your profile. For the theme to apply to GTK 4, this option is mandatory.

Color scheme for GTK 4 applications.

Cursor theme for GTK 4 applications.

The name of the cursor theme within the package.

Package providing the cursor theme. This package will be installed to your profile. If `null` then the cursor theme is assumed to already be available in your profile.

The size of the cursor.

Whether to enable GTK 4 configuration.

Extra settings for {file}`$XDG_CONFIG_HOME/gtk-4.0/settings.ini`.

Extra CSS for {file}`$XDG_CONFIG_HOME/gtk-4.0/gtk.css`.

Font for GTK 4 applications.

The family name of the font within the package.

Package providing the font. This package will be installed to your profile. If `null` then the font is assumed to already be available in your profile.

The size of the font.

Icon theme for GTK 4 applications.

The name of the icon theme within the package.

Package providing the icon theme. This package will be installed to your profile. If `null` then the icon theme is assumed to already be available in your profile.

Theme for GTK 4 applications. Warning: This is not officially supported and applied using a workaround. It may cause issues with some apps. For context, see [Please don’t theme our apps](https://stopthemingmy.app/) and [Restyling apps at scale](https://blogs.gnome.org/tbernard/2018/10/15/restyling-apps-at-scale/).

The name of the theme within the package.

Package providing the theme. This package will be installed to your profile. If `null` then the theme is assumed to already be available in your profile. For the theme to apply to GTK 4, this option is mandatory.

Default icon theme for all GTK versions.

The name of the icon theme within the package.

Package providing the icon theme. This package will be installed to your profile. If `null` then the icon theme is assumed to already be available in your profile.

Default theme for GTK 2/3.

The name of the theme within the package.

Package providing the theme. This package will be installed to your profile. If `null` then the theme is assumed to already be available in your profile. For the theme to apply to GTK 4, this option is mandatory.

The activation scripts blocks to run when activating a Home Manager generation. Any entry here should be idempotent, meaning running twice or more times produces the same result as running it once. If the script block produces any observable side effect, such as writing or deleting files, then it *must* be placed after the special `writeBoundary` script block. Prior to the write boundary one can place script blocks that verifies, but does not modify, the state of the system and exits if an unexpected state is found. For example, the `checkLinkTargets` script block checks for collisions between non-managed files and files defined in [](#opt-home.file). A script block should respect the {var}`DRY_RUN` variable. If it is set then the actions taken by the script should be logged to standard out and not actually performed. A convenient shell function {command}`run` is provided for activation script blocks. It is used as follows: {command}`run {command}` : Runs the given command on live run, otherwise prints the command to standard output. {command}`run --quiet {command}` : Runs the given command on live run and sends its standard output to {file}`/dev/null`, otherwise prints the command to standard output. {command}`run --silence {command}` : Runs the given command on live run and sends its standard and error output to {file}`/dev/null`, otherwise prints the command to standard output. The `--quiet` and `--silence` flags are mutually exclusive. A script block should also respect the {var}`VERBOSE` variable, and if set print information on standard out that may be useful for debugging any issue that may arise. The variable {var}`VERBOSE_ARG` is set to {option}`--verbose` if verbose output is enabled. You can also use the provided shell function {command}`verboseEcho`, which acts as {command}`echo` when verbose output is enabled.

Packages that are added as dependencies of the home's build, usually for the purpose of validating some part of the configuration. Unlike `home.extraDependencies`, these store paths do not become part of the built home configuration.

Some Nix packages provide debug symbols for {command}`gdb` in the `debug` output. This option ensures that those are automatically fetched from the binary cache if available and {command}`gdb` is configured to find those symbols.

Determines whether to check for release version mismatch between Home Manager and Nixpkgs. Using mismatched versions is likely to cause errors and unexpected behavior. It is therefore highly recommended to use a release of Home Manager that corresponds with your chosen release of Nixpkgs. When this option is enabled and a mismatch is detected then a warning will be printed when the user configuration is being built.

A list of paths that should be included in the home closure but generally not visible. For built-time checks the `home.checks` option is more appropriate for that purpose as checks should not leave a trace in the built home configuration.

List of additional package outputs of the packages {var}`home.packages` that should be installed into the user environment.

Attribute set of files to link into the user home.

Whether this file should be generated. This option allows specific files to be disabled.

Set the execute bit. If `null`, defaults to the mode of the {var}`source` file or to `false` for files created through the {var}`text` option.

Whether the target path should be unconditionally replaced by the managed file source. Warning, this will silently delete the target regardless of whether it is a file or link.

When `recursive` is enabled, adds `-ignorelinks` flag to lndir It causes lndir to not treat symbolic links in the source directory specially. The link created in the target directory will point back to the corresponding (symbolic link) file in the source directory. If the link is to a directory

Shell commands to run when file has changed between generations. The script will be run *after* the new files have been linked into place. Note, this code is always run when `recursive` is enabled.

If the file source is a directory, then this option determines whether the directory should be recursively linked to the target location. This option has no effect if the source is a file. If `false` (the default) then the target will be a symbolic link to the source directory. If `true` then the target will be a directory structure matching the source's but whose leafs are symbolic links to the files of the source directory.

Path of the source file or directory. If [](#opt-home.file._name_.text) is non-null then this option will automatically point to a file containing that text.

Path to target file relative to {env}`HOME`.

Text of the file. If this option is null then [](#opt-home.file._name_.source) must be set.

The user's home directory. Must be an absolute path.

Keyboard configuration. Set to `null` to disable Home Manager keyboard management.

Keyboard layout. If `null`, then the system configuration will be used. This defaults to `null` for state version ≥ 19.09 and `"us"` otherwise.

Keyboard model.

X keyboard options; layout switching goes here.

X keyboard variant. If `null`, then the system configuration will be used. This defaults to `null` for state version ≥ 19.09 and `""` otherwise.

Language configuration.

The language to use for addresses.

The language to use unless overridden by a more specific option.

The language to use for collation (alphabetical ordering).

Character classification category.

The language to use for measurement values.

The language to use for messages, application UI languages, etc.

The language to use for formatting currencies and money amounts.

The language to use for personal names.

The language to use for numerical values.

The language to use for paper sizes.

The language to use for telephone numbers.

The language to use for formatting times.

The set of packages to appear in the user environment.

Cursor configuration. Top-level options declared under this submodule are backend independent options. Options declared under namespaces such as `x11` are backend specific options. By default, only backend independent cursor configurations are generated. If you need configurations for specific backends, you can toggle them via the enable option. For example, [](#opt-home.pointerCursor.x11.enable) will enable x11 cursor configurations. Note that this will merely generate the cursor configurations. To apply the configurations, the relevant subsytems must also be configured. For example, [](#opt-home.pointerCursor.gtk.enable) will generate the gtk cursor configuration, but [](#opt-gtk.enable) needs to be set for it to be applied.

Whether to enable `.icons` config generation for {option}`home.pointerCursor` .

Whether to enable cursor config generation.

Whether to enable gtk config generation for {option}`home.pointerCursor` .

Whether to enable hyprcursor config generation.

The cursor size for hyprcursor.

The cursor name within the package.

Package providing the cursor theme.

The cursor size.

Whether to enable sway config generation for {option}`home.pointerCursor`.

The default cursor file to use within the package.

Whether to enable x11 config generation for {option}`home.pointerCursor` .

Whether to make programs use XDG directories whenever supported.

The profile directory where Home Manager generations are installed.

Extra directories to prepend to {env}`PATH`. These directories are added to the {env}`PATH` variable in a double-quoted context, so expressions like `$HOME` are expanded by the shell. However, since expressions like `~` or `*` are escaped, they will end up in the {env}`PATH` verbatim.

Extra directories to prepend to arbitrary PATH-like environment variables (e.g.: {env}`MANPATH`). The values will be concatenated by `:`. These directories are added to the environment variable in a double-quoted context, so expressions like `$HOME` are expanded by the shell. However, since expressions like `~` or `*` are escaped, they will end up in the environment verbatim.

Environment variables to always set at login. The values may refer to other environment variables using POSIX.2 style variable references. For example, a variable {var}`parameter` may be referenced as `$parameter` or `${parameter}`. A default value `foo` may be given as per `${parameter:-foo}` and, similarly, an alternate value `bar` can be given as per `${parameter:+bar}`. Note, these variables may be set in any order so no session variable may have a runtime dependency on another session variable. In particular code like ```nix home.sessionVariables = { FOO = "Hello"; BAR = "$FOO World!"; }; ``` may not work as expected. If you need to reference another session variable (even if it is declared by using other options like [](#opt-xdg.configHome)), then do so inside Nix instead. The above example then becomes ```nix home.sessionVariables = { FOO = "Hello"; BAR = "${config.home.sessionVariables.FOO} World!"; }; ```

Whether to enable Bash integration.

Whether to enable Fish integration.

Whether to enable Ion integration.

Whether to enable Nushell integration.

Whether to globally enable shell integration for all supported shells. Individual shell integrations can be overridden with their respective `shell.enable<SHELL>Integration` option. For example, the following declaration globally disables shell integration for Bash: ```nix home.shell.enableBashIntegration = false; ```

Whether to enable Zsh integration.

An attribute set that maps aliases (the top level attribute names in this option) to command strings or directly to build outputs. This option should only be used to manage simple aliases that are compatible across all shells. If you need to use a shell specific feature then make sure to use a shell specific option, for example [](#opt-programs.bash.shellAliases) for Bash.

It is occasionally necessary for Home Manager to change configuration defaults in a way that is incompatible with stateful data. This could, for example, include switching the default data format or location of a file. The *state version* indicates which default settings are in effect and will therefore help avoid breaking program configurations. Switching to a higher state version typically requires performing some manual steps, such as data conversion or moving files.

The user's uid.

The user's username.

Customized `glibcLocales` package providing the `LOCALE_ARCHIVE_*` environment variable. This option only applies to the Linux platform. When Home Manager is configured with NixOS, the default value will be set to {var}`i18n.glibcLocales` from the system configuration.

Whether to enable an additional input method type.

Deprecated - use `type` and `enable = true` instead

Enabled Fcitx5 addons.

The fcitx5 package to use.

Ignore the user configures. **Warning**: When this is enabled, the user config files are totally ignored and the user dict can't be saved and loaded.

Quick phrases.

Quick phrase files.

The addon configures in `conf` folder in ini format with global sections. Each item is written to the corresponding file.

global section of an INI file (attrs of INI atom (null, bool, int, float or string))

attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

The global options in `config` file in ini format.

The input method configure in `profile` file in ini format.

Themes to be written to {file}`$XDG_DATA_HOME/fcitx5/themes/${name}`

Path to the SVG of the highlight.

Path to the SVG of the panel.

The `theme.conf` file of the theme. See https://fcitx-im.org/wiki/Fcitx_5_Theme#Background_images for more information.

Use the Wayland input method frontend. See [Using Fcitx 5 on Wayland](https://fcitx-im.org/wiki/Using_Fcitx_5_on_Wayland).

kime configuration. Refer to <https://github.com/Riey/kime/blob/develop/docs/CONFIGURATION.md> for details on supported values.

Select the enabled input method. Input methods are software to input symbols that are not available on standard input devices. Input methods are especially used to input Chinese, Japanese and Korean characters. Currently the following input methods are available in Home Manager: `fcitx5` : A customizable lightweight input method. The next generation of fcitx. Addons (including engines, dictionaries, skins) can be added using [](#opt-i18n.inputMethod.fcitx5.addons). `nabi` : A Korean input method based on XIM. Nabi doesn't support Qt 5. `uim` : The "universal input method" is a library with an XIM bridge. uim mainly supports Chinese, Japanese and Korean. `hime` : An extremely easy-to-use input method framework. `kime` : A Korean IME.

Selected UIM toolbar.

Define LaunchAgents.

Define a launchd job. See {manpage}`launchd.plist(5)` for details.

When a job dies, launchd kills any remaining processes with the same process group ID as the job. Setting this key to true disables that behavior.

This optional key specifies that launchd should adjust its log mask temporarily to LOG_DEBUG while dealing with this job.

This optional key is used as a hint to `launchctl(1)` that it should not submit this job to launchd when loading a job or jobs. The value of this key does NOT reflect the current state of the job on the running system. If you wish to know whether a job is loaded in launchd, reading this key from a configuration file yourself is not a sufficient test. You should query launchd for the presence of the job using the `launchctl(1)` list subcommand or use the ServiceManagement framework's `SMJobCopyDictionary()` method. Note that as of Mac OS X v10.6, this key's value in a configuration file conveys a default value, which is changed with the [-w] option of the `launchctl(1)` load and unload subcommands. These subcommands no longer modify the configuration file, so the value displayed in the configuration file is not necessarily the value that `launchctl(1)` will apply. See `launchctl(1)` for more information. Please also be mindful that you should only use this key if the provided on-demand and KeepAlive criteria are insufficient to describe the conditions under which your job needs to run. The cost to have a job loaded in launchd is negligible, so there is no harm in loading a job which only runs once or very rarely.

This flag causes launchd to use the `glob(3)` mechanism to update the program arguments before invocation.

This flag instructs launchd that the job promises to use `vproc_transaction_begin(3)` and `vproc_transaction_end(3)` to track outstanding transactions that need to be reconciled before the process can safely terminate. If no outstanding transactions are in progress, then launchd is free to send the SIGKILL signal.

This optional key is used to specify additional environment variables to be set before running the job.

The amount of time launchd waits before sending a SIGKILL signal. The default value is 20 seconds. The value zero is interpreted as infinity.

This optional key specifies the group to run the job as. This key is only applicable when launchd is running as root. If UserName is set and GroupName is not, the the group will be set to the default group of the user.

Resource limits to be imposed on the job. These adjust variables set with `setrlimit(2)`. The following keys apply:

The maximum amount of cpu time (in seconds) to be used by each process.

The largest size (in bytes) core file that may be created.

The maximum size (in bytes) of the data segment for a process; this defines how far a program may extend its break with the `sbrk(2)` system call.

The largest size (in bytes) file that may be created.

The maximum size (in bytes) which a process may lock into memory using the `mlock(2)` function.

The maximum number of open files for this process. Setting this value in a system wide daemon will set the `sysctl(3)` kern.maxfiles (SoftResourceLimits) or kern.maxfilesperproc (HardResourceLimits) value in addition to the `setrlimit(2)` values.

The maximum number of simultaneous processes for this user id. Setting this value in a system wide daemon will set the `sysctl(3)` kern.maxproc (SoftResourceLimits) or kern.maxprocperuid (HardResourceLimits) value in addition to the `setrlimit(2)` values.

The maximum size (in bytes) to which a process's resident set size may grow. This imposes a limit on the amount of physical memory to be given to a process; if memory is tight, the system will prefer to take memory from processes that are exceeding their declared resident set size.

The maximum size (in bytes) of the stack segment for a process; this defines how far a program's stack segment may be extended. Stack extension is performed automatically by the system.

This optional key specifies whether `initgroups(3)` should be called before running the job. The default is true in 10.5 and false in 10.4. This key will be ignored if the UserName key is not set.

This optional key is used to control whether your job is to be kept continuously running or to let demand and conditions control the invocation. The default is false and therefore only demand will start the job. The value may be set to true to unconditionally keep the job alive. Alternatively, a dictionary of conditions may be specified to selectively control whether launchd keeps a job alive or not. If multiple keys are provided, launchd ORs them, thus providing maximum flexibility to the job to refine the logic and stall if necessary. If launchd finds no reason to restart the job, it falls back on demand based invocation. Jobs that exit quickly and frequently when configured to be kept alive will be throttled to converve system resources.

Whether to defer evaluating other `KeepAlive` conditions until the job has been started at least once by demand.

If true, the the job will be restarted as long as it exited due to a signal which is typically associated with a crash (SIGILL, SIGSEGV, etc.). If false, the job will be restarted in the inverse condition.

If true, the job will be kept alive as long as the network is up, where up is defined as at least one non-loopback interface being up and having IPv4 or IPv6 addresses assigned to them. If false, the job will be kept alive in the inverse condition.

Each key in this dictionary is the label of another job. If the value of the key is true, then this job is kept alive as long as that other job is enabled. Otherwise, if the value is false, then this job is kept alive as long as the other job is disabled. This feature should not be considered a substitute for the use of IPC.

Each key in this dictionary is a file-system path. If the value of the key is true, then the job will be kept alive as long as the path exists. If false, the job will be kept alive in the inverse condition. The intent of this feature is that two or more jobs may create semaphores in the file-system namespace.

If true, the job will be restarted as long as the program exits and with an exit status of zero. If false, the job will be restarted in the inverse condition. This key implies that "RunAtLoad" is set to true, since the job needs to run at least once before we can get an exit status.

This required key uniquely identifies the job to launchd.

Specifies higher-level event types to be used as launch-on-demand event sources. Each sub-dictionary defines events for a particular event subsystem, such as "com.apple.iokit.matching", which can be used to launch jobs based on the appearance of nodes in the IORegistry. Each dictionary within the sub-dictionary specifies an event descriptor that is specified to each event subsystem. With this key, the job promises to use the xpc_set_event_stream_handler(3) API to consume events. See xpc_events(3) for more details on event sources.

This optional key specifies whether the job can only be run once and only once. In other words, if the job cannot be safely respawned without a full machine reboot, then set this key to be true.

This configuration file only applies to hosts NOT listed with this key. Note: One should set kern.hostname in `sysctl.conf(5)` for this feature to work reliably.

This configuration file only applies to the hosts listed with this key. Note: One should set kern.hostname in `sysctl.conf(5)` for this feature to work reliably.

This configuration file only applies to sessions of the type specified. This key is used in concert with the -S flag to {command}`launchctl`.

This optional key specifies whether the kernel should consider this daemon to be low priority when doing file system I/O when the process is throttled with the Darwin-background classification.

This optional key specifies whether the kernel should consider this daemon to be low priority when doing file system I/O.

This optional key is used to specify Mach services to be registered with the Mach bootstrap sub-system. Each key in this dictionary should be the name of service to be advertised. The value of the key must be a boolean and set to true. Alternatively, a dictionary can be used instead of a simple true value. Finally, for the job itself, the values will be replaced with Mach ports at the time of check-in with launchd.

Reserve the name in the namespace, but cause bootstrap_look_up() to fail until the job has checked in with launchd.

If this boolean is false, the port is recycled, thus leaving clients to remain oblivious to the demand nature of job. If the value is set to true, clients receive port death notifications when the job lets go of the receive right. The port will be recreated atomically with respect to bootstrap_look_up() calls, so that clients can trust that after receiving a port death notification, the new port will have already been recreated. Setting the value to true should be done with care. Not all clients may be able to handle this behavior. The default value is false.

This optional key specifies what nice(3) value should be applied to the daemon.

This key was used in Mac OS X 10.4 to control whether a job was kept alive or not. The default was true. This key has been deprecated and replaced in Mac OS X 10.5 and later with the more powerful KeepAlive option.

This optional key describes, at a high level, the intended purpose of the job. The system will apply resource limits based on what kind of job it is. If left unspecified, the system will apply light resource limits to the job, throttling its CPU usage and I/O bandwidth. The following are valid values: Background : Background jobs are generally processes that do work that was not directly requested by the user. The resource limits applied to Background jobs are intended to prevent them from disrupting the user experience. Standard : Standard jobs are equivalent to no ProcessType being set. Adaptive : Adaptive jobs move between the Background and Interactive classifications based on activity over XPC connections. See `xpc_transaction_begin(3)` for details. Interactive : Interactive jobs run with the same resource limitations as apps, that is to say, none. Interactive jobs are critical to maintaining a responsive user experience, and this key should only be used if an app's ability to be responsive depends on it, and cannot be made Adaptive.

This key maps to the first argument of `execvp(3)`. If this key is missing, then the first element of the array of strings provided to the ProgramArguments will be used instead. This key is required in the absence of the ProgramArguments key.

This key maps to the second argument of `execvp(3)`. This key is required in the absence of the Program key. Please note: many people are confused by this key. Please read `execvp(3)` very carefully!

Much like the WatchPaths option, this key will watch the paths for modifications. The difference being that the job will only be started if the path is a directory and the directory is not empty.

This optional key is used to specify a directory to `chroot(2)` to before running the job.

This optional key is used to control whether your job is launched once at the time the job is loaded. The default is false.

This optional key specifies whether the job participates in advanced communication with launchd. The default is false. This flag is incompatible with the inetdCompatibility key.

This key specifies that the job should be spawned into a new security audit session rather than the default session for the context is belongs to. See auditon(2) for details.

This optional key is used to specify launch on demand sockets that can be used to let launchd know when to run the job. The job must check-in to get a copy of the file descriptors using APIs outlined in launch(3). The keys of the top level Sockets dictionary can be anything. They are meant for the application developer to use to differentiate which descriptors correspond to which application level protocols (e.g. http vs. ftp vs. DNS...). At check-in time, the value of each Sockets dictionary key will be an array of descriptors. Daemon/Agent writers should consider all descriptors of a given key to be to be effectively equivalent, even though each file descriptor likely represents a different networking protocol which conforms to the criteria specified in the job configuration file. The parameters below are used as inputs to call `getaddrinfo(3)`.

This optional key can be used to request that the service be registered with the `mDNSResponder(8)`. If the value is boolean, the service name is inferred from the SockServiceName.

This optional key can be used to request that the datagram socket join a multicast group. If the value is a hostname, then `getaddrinfo(3)` will be used to join the correct multicast address for a given socket family. If an explicit IPv4 or IPv6 address is given, it is required that the SockFamily family also be set, otherwise the results are undefined.

This optional key is a variant of SockPathName. Instead of binding to a known path, a securely generated socket is created and the path is assigned to the environment variable that is inherited by all jobs spawned by launchd.

This optional key can be used to specifically request that "IPv4" or "IPv6" socket(s) be created.

This optional key specifies the node to `connect(2)` or `bind(2)` to.

This optional key specifies whether `listen(2)` or `connect(2)` should be called on the created file descriptor. The default is true ("to listen").

This optional key specifies the mode of the socket. Known bug: Property lists don't support octal, so please convert the value to decimal.

This optional key implies SockFamily is set to "Unix". It specifies the path to `connect(2)` or `bind(2)` to.

This optional key specifies the protocol to be passed to `socket(2)`. The only value understood by this key at the moment is "TCP".

This optional key specifies the service on the node to `connect(2)` or `bind(2)` to.

This optional key tells launchctl what type of socket to create. The default is "stream" and other valid values for this key are "dgram" and "seqpacket" respectively.

Resource limits to be imposed on the job. These adjust variables set with `setrlimit(2)`. The following keys apply:

The maximum amount of cpu time (in seconds) to be used by each process.

The largest size (in bytes) core file that may be created.

The maximum size (in bytes) of the data segment for a process; this defines how far a program may extend its break with the `sbrk(2)` system call.

The largest size (in bytes) file that may be created.

The maximum size (in bytes) which a process may lock into memory using the mlock(2) function.

The maximum number of open files for this process. Setting this value in a system wide daemon will set the `sysctl(3)` kern.maxfiles (SoftResourceLimits) or kern.maxfilesperproc (HardResourceLimits) value in addition to the `setrlimit(2)` values.

The maximum number of simultaneous processes for this user id. Setting this value in a system wide daemon will set the `sysctl(3)` kern.maxproc (SoftResourceLimits) or kern.maxprocperuid (HardResourceLimits) value in addition to the `setrlimit(2)` values.

The maximum size (in bytes) to which a process's resident set size may grow. This imposes a limit on the amount of physical memory to be given to a process; if memory is tight, the system will prefer to take memory from processes that are exceeding their declared resident set size.

The maximum size (in bytes) of the stack segment for a process; this defines how far a program's stack segment may be extended. Stack extension is performed automatically by the system.

This optional key specifies what file should be used for data being sent to stderr when using `stdio(3)`.

This optional key specifies what file should be used for data being supplied to stdin when using `stdio(3)`.

This optional key specifies what file should be used for data being sent to stdout when using `stdio(3)`.

This optional key causes the job to be started every calendar interval as specified. The semantics are much like {manpage}`crontab(5)`: Missing attributes are considered to be wildcard. Unlike cron which skips job invocations when the computer is asleep, launchd will start the job the next time the computer wakes up. If multiple intervals transpire before the computer is woken, those events will be coalesced into one event upon waking from sleep. ::: {.important} The list must not be empty and must not contain duplicate entries (attrsets which compare equally). ::: ::: {.caution} Since missing attrs become wildcards, an empty attrset effectively means "every minute". :::

This optional key causes the job to be started every N seconds. If the system is asleep, the job will be started the next time the computer wakes up. If multiple intervals transpire before the computer is woken, those events will be coalesced into one event upon wake from sleep.

This optional key causes the job to be started every time a filesystem is mounted.

This key lets one override the default throttling policy imposed on jobs by launchd. The value is in seconds, and by default, jobs will not be spawned more than once every 10 seconds. The principle behind this is that jobs should linger around just in case they are needed again in the near future. This not only reduces the latency of responses, but it encourages developers to amortize the cost of program invocation.

The recommended idle time out (in seconds) to pass to the job. If no value is specified, a default time out will be supplied by launchd for use by the job at check in time.

This optional key specifies what value should be passed to `umask(2)` before running the job. Known bug: Property lists don't support octal, so please convert the value to decimal.

This optional key specifies the user to run the job as. This key is only applicable when launchd is running as root.

This optional key specifies that launchd should instruct the kernel to have the job wait for a debugger to attach before any code in the job is executed.

This optional key causes the job to be started if any one of the listed paths are modified.

This optional key is used to specify a directory to `chdir(2)` to before running the job.

The presence of this key specifies that the daemon expects to be run as if it were launched from inetd.

This flag corresponds to the "wait" or "nowait" option of inetd. If true, then the listening socket is passed via the standard in/out/error file descriptors. If false, then `accept(2)` is called on behalf of the job, and the result is passed via the standard in/out/error descriptors.

Whether to enable ‹name›.

Whether to enable Home Manager to define per-user daemons by making use of launchd's LaunchAgents.

This option allows modules to define helper functions, constants, etc.

Whether to install the HTML manual. This also installs the {command}`home-manager-help` tool, which opens a local copy of the Home Manager manual in the system web browser.

Whether to install a JSON formatted list of all Home Manager options. This can be located at {file}`<profile directory>/share/doc/home-manager/options.json`, and may be used for navigating definitions, auto-completing, and other miscellaneous tasks.

Whether to install the configuration manual page. The manual can be reached by {command}`man home-configuration.nix`. When looking at the manual page pretend that all references to NixOS stuff are actually references to Home Manager stuff. Thanks!

List of maintainers of each module. This option should be defined at most once per module. The option value is not a list of maintainers, but an attribute set that maps module file names to lists of maintainers.

How unread and relevant news should be presented when running {command}`home-manager build` and {command}`home-manager switch`. The options are `silent` : Do not print anything during build or switch. The {command}`home-manager news` command still works for viewing the entries. `notify` : The number of unread and relevant news entries will be printed to standard output. The {command}`home-manager news` command can later be used to view the entries. `show` : A pager showing unread news entries is opened.

Whether Home Manager should assume that Nix is configured to use XDG base directories. Note that this doesn't change the behavior of Nix. To do that, set nix.settings.use-xdg-base-directories instead. This option is intended for settings in which use-xdg-base-directories is set globally or nix.conf is unmanaged by Home Manager.

This option lists the machines to be used if distributed builds are enabled (see {option}`nix.distributedBuilds`). Nix will perform derivations on those machines via SSH by copying the inputs to the Nix store on the remote machine, starting the build, then copying the output back to the local Nix store.

The hostname of the build machine.

A list of features mandatory for this builder. The builder will be ignored for derivations that don't require all features in this list. All mandatory features are automatically included in {var}`supportedFeatures`.

The number of concurrent jobs the build machine supports. The build machine will enforce its own limits, but this allows hydra to schedule better since there is no work-stealing between build machines.

The protocol used for communicating with the build machine. Use `ssh-ng` if your remote builder and your local Nix version support that improved protocol. Use `null` when trying to change the special localhost builder without a protocol which is for example used by hydra.

The (base64-encoded) public host key of this builder. The field is calculated via {command}`base64 -w0 /etc/ssh/ssh_host_type_key.pub`. If null, SSH will use its regular known-hosts file when connecting.

The relative speed of this builder. This is an arbitrary integer that indicates the speed of this builder, relative to other builders. Higher is faster.

The path to the SSH private key with which to authenticate on the build machine. The private key must not have a passphrase. If null, the building user (root on NixOS machines) must have an appropriate ssh configuration to log in non-interactively. Note that for security reasons, this path must point to a file in the local filesystem, *not* to the nix store.

The username to log in as on the remote host. This user must be able to log in and run nix commands non-interactively. It must also be privileged to build derivations, so must be included in {option}`nix.settings.trusted-users`.

A list of features supported by this builder. The builder will be ignored for derivations that require features not in this list.

The system types the build machine can execute derivations on.

A declarative alternative to Nix channels. Whereas with stock channels, you would register URLs and fetch them into the Nix store with {manpage}`nix-channel(1)`, this option allows you to register the store path directly. One particularly useful example is registering flake inputs as channels. This option can coexist with stock Nix channels. If the same channel is defined in both, this option takes precedence.

If enabled (the default), checks for data type mismatches and that Nix can parse the generated nix.conf.

Whether to distribute builds to the machines listed in {option}`nix.buildMachines`.

Additional text appended to {file}`nix.conf`.

Automatically run the garbage collector at a specific time. Note: This will only garbage collect the current user's profiles.

When to run the Nix garbage collector. On Linux this is a string as defined by {manpage}`systemd.time(7)`. On Darwin, it must be one of: hourly, daily, weekly, monthly, semiannually, annually, which are implemented as defined in {manpage}`systemd.time(7)`.

Options given to {file}`nix-collect-garbage` when the garbage collector is run automatically.

If true, the time when the service unit was last triggered is stored on disk. When the timer is activated, the service unit is triggered immediately if it would have been triggered at least once during the time when the timer was inactive.

Add a randomized delay before each garbage collection. The delay will be chosen between zero and this value. This value must be a time span in the format specified by {manpage}`systemd.time(7)`

Whether {option}`nix.nixPath` should keep the previously set values in {env}`NIX_PATH`.

Adds new directories to the Nix expression search path. Used by Nix when looking up paths in angular brackets (e.g. `<nixpkgs>`).

The nix package to use.

User level flake registry.

Whether the {option}`from` reference needs to match exactly. If set, a {option}`from` reference like `nixpkgs` does not match with a reference like `nixpkgs/nixos-20.03`.

The flake input to which {option}`from>` is to be rewritten.

The flake reference to be rewritten.

The flake reference to which {option}`from>` is to be rewritten.

Configuration for Nix; see {manpage}`nix.conf(5)` for available options. The value declared here will be translated directly to the key-value pairs Nix expects. Configuration specified in [](#opt-nix.extraOptions) will be appended verbatim to the resulting config file.

The configuration of the Nix Packages collection. (For details, see the Nixpkgs documentation.) It allows you to set package configuration options. If `null`, then configuration is taken from the fallback location, for example, {file}`~/.config/nixpkgs/config.nix`. Note, this option will not apply outside your Home Manager configuration like when installing manually through {command}`nix-env`. If you want to apply it both inside and outside Home Manager you can put it in a separate file and include something like ```nix nixpkgs.config = import ./nixpkgs-config.nix; xdg.configFile."nixpkgs/config.nix".source = ./nixpkgs-config.nix; ``` in your Home Manager configuration.

List of overlays to use with the Nix Packages collection. (For details, see the Nixpkgs documentation.) It allows you to override packages globally. This is a function that takes as an argument the *original* Nixpkgs. The first argument should be used for finding dependencies, and the second should be used for overriding recipes. If `null`, then the overlays are taken from the fallback location, for example, {file}`~/.config/nixpkgs/overlays`. Like {var}`nixpkgs.config` this option only applies within the Home Manager configuration. See {var}`nixpkgs.config` for a suggested setup that works both internally and externally.

Environment variables that will be set for the PAM session. The variable values must be as described in {manpage}`pam_env.conf(5)`. Note, this option will become deprecated in the future and its use is therefore discouraged.

List of authorized YubiKey token IDs. Refer to <https://developers.yubico.com/yubico-pam> for details on how to obtain the token ID of a YubiKey.

File path to write the authorized YubiKeys, relative to {env}`HOME`.

Whether to enable abaddon.

The abaddon package to use.

Configuration settings for abaddon. All the available options can be found here: <https://github.com/uowuo/abaddon?tab=readme-ov-file#settings>

Whether to enable Abook.

Extra lines added to {file}`$HOME/.config/abook/abookrc`. Available configuration options are described in the abook repository: <https://sourceforge.net/p/abook/git/ci/master/tree/sample.abookrc>.

The abook package to use.

Cache configuration settings for acd-cli. All the available options can be found here: <https://acd-cli.readthedocs.io/en/latest/configuration.html#cache-ini>.

CLI configuration settings for acd-cli. All the available options can be found here: <https://acd-cli.readthedocs.io/en/latest/configuration.html#acd-cli-ini>.

Client configuration settings for acd-cli. All the available options can be found here: <https://acd-cli.readthedocs.io/en/latest/configuration.html#acd-client-ini>.

Whether to enable acd-cli.

FUSE configuration settings for acd-cli. All the available options can be found here: <https://acd-cli.readthedocs.io/en/latest/configuration.html#fuse-ini>.

The acd-cli package to use.

Whether to enable aerc.

Extra lines added to {file}`$HOME/.config/aerc/accounts.conf`. See {manpage}`aerc-config(5)`.

Extra lines added to {file}`$HOME/.config/aerc/binds.conf`. Global keybindings can be set in the `global` section. See {manpage}`aerc-config(5)`.

Extra lines added to {file}`$HOME/.config/aerc/aerc.conf`. See {manpage}`aerc-config(5)`.

The aerc package to use.

Stylesets added to {file}`$HOME/.config/aerc/stylesets/`. See {manpage}`aerc-stylesets(7)`.

Templates added to {file}`$HOME/.config/aerc/templates/`. See {manpage}`aerc-templates(7)`.

Whether to enable AeroSpace window manager.

Configure the launchd agent to manage the AeroSpace process. The first time this is enabled, macOS will prompt you to allow this background item in System Settings. You can verify the service is running correctly from your terminal. Run: `launchctl list | grep aerospace` - A running process will show a Process ID (PID) and a status of 0, for example: `12345 0 org.nix-community.home.aerospace` - If the service has crashed or failed to start, the PID will be a dash and the status will be a non-zero number, for example: `- 1 org.nix-community.home.aerospace` In case of failure, check the logs with `cat /tmp/aerospace.err.log`. For more detailed service status, run `launchctl print gui/$(id -u)/org.nix-community.home.aerospace`. NOTE: Enabling this option will configure AeroSpace to **not** manage its own launchd agent. Specifically, it will set `start-at-login = false` and `after-login-command = []` in the configuration file, as those are now handled by Home Manager and launchd instead.

Whether the launchd service should be kept alive.

The aerospace package to use.

AeroSpace configuration, see <https://nikitabobko.github.io/AeroSpace/guide#configuring-aerospace> for supported values.

Whether to enable the afew initial tagging script for Notmuch.

Extra lines added to afew configuration file. Available configuration options are described in the afew manual: <https://afew.readthedocs.io/en/latest/configuration.html>.

The afew package to use.

Configuration settings for ahoviewer. All the available options can be found editing the preferences in the GUI and looking at $XDG_CONFIG_HOME/ahoviewer/ahoviewer.cfg

Whether to enable ahoviewer.

The ahoviewer package to use.

List of plugins for ahoviewer.

Whether to enable aiac.

The aiac package to use.

Configuration settings for aiac. All the available options can be found here: <https://github.com/gofireflyio/aiac/?tab=readme-ov-file#configuration>.

Agent-specific configurations. See <https://github.com/sigoden/aichat/wiki/Configuration-Guide#agent-specific> for supported values.

Whether to enable aichat, an All-in-one LLM CLI tool.

The aichat package to use.

Configuration written to {file}`$XDG_CONFIG_HOME/aichat/config.yaml` on Linux or on Darwin if [](#opt-xdg.enable) is set, otherwise {file}`~/Library/Application Support/aichat/config.yaml`. See <https://github.com/sigoden/aichat/blob/main/config.example.yaml> for supported values.

Whether to enable aider-chat.

The aider-chat package to use.

Configuration settings for aider-chat. All the available options can be found here: <https://aider.chat/docs/config/aider_conf.html#sample-yaml-config-file>.

Whether to enable airlift.

The airlift package to use.

Configuration settings for airlift. All the available options can be found here: <https://artifacthub.io/packages/helm/apache-airflow/airflow?modal=values>.

Whether to enable Alacritty.

The alacritty package to use.

Configuration written to {file}`$XDG_CONFIG_HOME/alacritty/alacritty.yml` or {file}`$XDG_CONFIG_HOME/alacritty/alacritty.toml` (the latter being used for alacritty 0.13 and later). See <https://github.com/alacritty/alacritty/tree/master#configuration> for more info.

A theme from the [alacritty-theme](https://github.com/alacritty/alacritty-theme) repository to import in the configuration. See <https://github.com/alacritty/alacritty-theme/tree/master/themes> for a list of available themes. If you would like to import your own theme, use {option}`programs.alacritty.settings.general.import` or {option}`programs.alacritty.settings.colors` directly.

The alacritty-theme package to use.

Whether to enable algia.

The algia package to use.

Configuration settings for algia. All the available options can be found here: <https://github.com/mattn/algia?tab=readme-ov-file#configuration>

Path where aliae should look for its config file. This doesn't override where Home-Manager places the generated config file. Changing this option could prevent aliae from using the settings defined in your Home-Manager configuration.

Whether to enable aliae.

Whether to enable Bash integration.

Whether to enable Fish integration.

Whether to enable Nushell integration.

Whether to enable Zsh integration.

The aliae package to use.

Configuration settings for aliae. All the available options can be found here: <https://aliae.dev/docs/setup/configuration#example>.

Whether to enable alistral.

The alistral package to use.

Configuration settings for alistral. You can see the details here: <https://rustynova016.github.io/Alistral/config/config.html>.

Keybindings.

Bufferlist mode keybindings.

Envelope mode keybindings.

Global keybindings.

Search mode keybindings.

Taglist mode keybindings.

Thread mode keybindings.

Whether to enable the Alot mail user agent. Alot uses the Notmuch email system and will therefore be automatically enabled for each email account that is managed by Notmuch.

Extra lines added to alot configuration file.

Content of the hooks file.

The alot package to use.

Configuration options added to alot configuration file.

How to display the tags.

How to display the tag when focused.

How to display the tag when unfocused. See <https://alot.readthedocs.io/en/latest/configuration/theming.html#tagstring-formatting>.

Fixed string representation for this tag. The tag can be hidden from view, if the key translated is set to `""`, the empty string.

A pair of strings that define a regular substitution to compute the string representation on the fly using `re.sub`.

Config file for am2rlauncher in XML format. You can see the available options by modifying the settings in the GUI and looking at $XDG_CONFIG_HOME/AM2RLauncher/config.xml.

Whether to enable am2rlauncher.

The am2rlauncher package to use.

Configuration settings for amber's ambr tool. All the available options can be found here: <https://github.com/dalance/amber?tab=readme-ov-file#configurable-value>.

Configuration settings for amber's ambs tool. All the available options can be found here: <https://github.com/dalance/amber?tab=readme-ov-file#configurable-value>.

Whether to enable amber.

The amber package to use.

Bookmarks file for amfora. It's highly recommended that you edit this file through the program itself, and then look at $XDG_DATA_HOME/amfora/bookmarks.xml

Whether to enable amfora.

The amfora package to use.

Configuration settings for amfora. All available options can be found here: <https://github.com/makew0rld/amfora/blob/master/default-config.toml>.

Config file for amoco as a Python configuration module.

Whether to enable amoco.

The amoco package to use.

Whether to enable amp.

The amp package to use.

Configuration settings for amp. All the details can be found here: <https://amp.rs/docs/configuration/>.

Whether to enable andcli.

The andcli package to use.

Configuration settings for andcli. All the details can be found here: <https://github.com/tjblackheart/andcli/blob/7de13cc933eeb23d53558f76fefef226bd531c2c/internal/config/config.go#L16>

Whether to enable animdl.

The animdl package to use.

Configuration settings for animdl. All the available options can be found here: <https://github.com/justfoolingaround/animdl?tab=readme-ov-file#configurations>.

Whether to enable anime-downloader.

The anime-downloader package to use.

Configuration settings for anime-downloader. All available options can be found here: <https://anime-downlader.readthedocs.io/en/latest/usage/config.html#config-json>.

List of Anki add-on packages to install.

Overrides for choosing what keyboard shortcut activates each answer button. The Anki default will be used for ones without an override defined.

Number associated with an answer button. By default, 1 = Again, 2 = Hard, 3 = Good, and 4 = Easy.

Keyboard shortcut for this answer button. The shortcut should be in the string format used by <https://doc.qt.io/qt-6/qkeysequence.html>.

Whether to enable Anki.

Hide bottom bar during review.

When to hide the bottom bar when `hideBottomBar` is enabled.

Hide top bar during review.

When to hide the top bar when `hideTopBar` is enabled.

Display language. Should be an underscore separated language tag. See <https://github.com/ankitects/anki/blob/main/pylib/anki/lang.py> for supported tags.

Use legacy (pre 2.1.55) import/export handling code.

Minimalist user interface mode.

The anki package to use.

Anki profiles and their settings. Profiles are primarily intended to be one per person, and are not recommended for splitting up your own content.

Open this profile on startup.

Automatically sync on profile open/close.

Automatically sync media every X minutes. Set this to 0 to disable periodic media syncing.

Path to a file containing the sync account sync key. This is different from the account password. To get the sync key, follow these steps: - Enable this Home Manager module: `programs.anki.enable = true` - Open Anki. - Navigate to the sync settings page. (Tools > Preferences > Syncing) - Log in to your AnkiWeb account. - Select "Yes" to the prompt about saving preferences and syncing. - A Home Manager warning prompt will show. Select "Show details...". - Get your sync key from the message: "syncKey changed from \`None\` to \`<YOUR SYNC KEY WILL BE HERE>\`"

Network timeout in seconds (clamped between 30 and 99999).

Synchronize audio and images too.

Custom sync server URL. See <https://docs.ankiweb.net/sync-server.html>.

Sync account username.

Path to a file containing the sync account username.

Disable various animations and transitions of the user interface.

Spacebar (or enter) also answers card.

Widgets style.

Theme to use.

User interface scale.

Video driver to use.

Config file for anup in RON (Rusty Object Notation) format. Available options can be found by looking at ~/.config/anup/config.ron.

Whether to enable anup.

The anup package to use.

Whether to enable anvil-editor.

The anvil-editor package to use.

Configuration settings for anvil-editor. All available options can be found here: <https://anvil-editor.net/reference/config/#settingstoml>.

Style settings for anvil-editor. All available options can be found here: <https://anvil-editor.net/reference/config/#stylejs>.

Close window when a click outside the main box is received.

The minimum height of the runner, the runner will expand to fit all the entries. This is a numeric option - pass either `{ absolute = int; };` or `{ fraction = float; };`. when using `absolute` it sets the absolute value in pixels, when using `fraction`, it sets a fraction of the width or height of the full screen (depends on exclusive zones and the settings related to them) window

Absolute value in pixels.

Fraction of the screen.

Hide match and plugin info icons.

Hide the plugin info panel.

Ignore exclusive zones, eg. Waybar.

Layer shell layer (background, bottom, top or overlay).

Add a margin around the window to allow for CSS shadow styling.

Limit amount of entries shown in total.

List of anyrun plugins to use. Can either be packages, absolute plugin paths, or strings.

Show search results immediately when Anyrun starts.

The width of the runner. This is a numeric option - pass either `{ absolute = int; };` or `{ fraction = float; };`. when using `absolute` it sets the absolute value in pixels, when using `fraction`, it sets a fraction of the width or height of the full screen (depends on exclusive zones and the settings related to them) window

Absolute value in pixels.

Fraction of the screen.

The horizontal position, adjusted so that { relative = 0.5; } always centers the runner. This is a numeric option - pass either `{ absolute = int; };` or `{ fraction = float; };`. when using `absolute` it sets the absolute value in pixels, when using `fraction`, it sets a fraction of the width or height of the full screen (depends on exclusive zones and the settings related to them) window

Absolute value in pixels.

Fraction of the screen.

The vertical position, works the same as x. This is a numeric option - pass either `{ absolute = int; };` or `{ fraction = float; };`. when using `absolute` it sets the absolute value in pixels, when using `fraction`, it sets a fraction of the width or height of the full screen (depends on exclusive zones and the settings related to them) window

Absolute value in pixels.

Fraction of the screen.

Whether to enable anyrun.

Extra files to put in {file}`~/.config/anyrun`, a wrapper over {option}`xdg.configFile`.

Extra CSS lines to add to {file}`~/.config/anyrun/style.css`.

The anyrun package to use.

Whether to enable aperture.

The aperture package to use.

Configuration settings for aperture. All the available options can be found here: <https://github.com/lightninglabs/aperture/blob/master/sample-conf.yaml>

Whether to enable aphorme.

The aphorme package to use.

Configuration settings for aphorme. All the available options can be found here: <https://github.com/Iaphetes/aphorme_launcher?tab=readme-ov-file#configuration>

Whether to enable aria2.

Extra lines added to {file}`aria2.conf` file.

The aria2 package to use.

Options to add to {file}`aria2.conf` file. See {manpage}`aria2c(1)` for options.

Whether to enable Enable installing asciinema and writing configuration file.

The asciinema package to use.

Declare-able configurations for asciinema written to {file}`$XDG_CONFIG_HOME/asciinema/config.toml`. Check official docs for available configurations; https://docs.asciinema.org/manual/cli/configuration/v3/#config-file

Whether to enable ashell, a ready to go wayland status bar for hyprland.

The ashell package to use.

Ashell configuration written to {file}`$XDG_CONFIG_HOME/ashell/config.toml` (0.5.0+) or {file}`$XDG_CONFIG_HOME/ashell/config.yaml` (<0.5.0). For available settings see <https://github.com/MalpenZibo/ashell?tab=readme-ov-file#configuration>.

Whether to enable ashell systemd service.

The systemd target that will automatically start ashell. If you set this to a WM-specific target, make sure that systemd integration for that WM is enabled (for example, [](#opt-wayland.windowManager.hyprland.systemd.enable)). This is typically true by default.

Whether to enable Astroid.

You can use the following variables: `%1` : file name `%2` : server name `%3` : socket ID See [Customizing editor](https://github.com/astroidmail/astroid/wiki/Customizing-editor) on the Astroid wiki.

JSON config that will override the default Astroid configuration.

The astroid package to use.

Script to run to fetch/update mails.

Whether to enable Atuin daemon.

Verbosity of Atuin daemon logging.

Whether to enable atuin.

Whether to enable Bash integration. If enabled, this will bind `ctrl-r` to open the Atuin history.

Whether to enable Fish integration. If enabled, this will bind the up-arrow key to open the Atuin history.

Whether to enable Nushell integration.

Whether to enable Zsh integration. If enabled, this will bind `ctrl-r` and the up-arrow key to open the Atuin history.

Flags to append to the shell hook.

When enabled, force overwriting of the Atuin configuration file ({file}`$XDG_CONFIG_HOME/atuin/config.toml`). Any existing Atuin configuration will be lost. Enabling this is useful when adding settings for the first time because Atuin writes its default config file after every single shell command, which can make it difficult to manually remove.

The atuin package to use.

Configuration written to {file}`$XDG_CONFIG_HOME/atuin/config.toml`. See <https://docs.atuin.sh/configuration/config/> for the full list of options.

Each theme is written to {file}`$XDG_CONFIG_HOME/atuin/themes/theme-name.toml` where the name of each attribute is the theme-name See <https://docs.atuin.sh/guide/theming/> for the full list of options.

Whether to enable autojump.

Whether to enable Bash integration.

Whether to enable Fish integration.

Whether to enable Zsh integration.

The autojump package to use.

Whether to enable Autorandr.

Global hook scripts

Postswitch hook executed after mode switch.

Predetect hook executed before autorandr attempts to run xrandr.

Preswitch hook executed before mode switch.

The autorandr package to use.

Autorandr profiles specification.

Per output profile configuration.

Output video display controller.

Output DPI configuration.

Whether to enable the output.

Extra lines to append to this profile's config.

Interpolation method to be used for scaling the output.

Output gamma configuration.

Output resolution.

Output position

Whether output should be marked as primary

Output framerate.

Output rotate configuration.

Output scale configuration. Either configure by pixels or a scaling factor. When using pixel method the {manpage}`xrandr(1)` option `--scale-from` will be used; when using factor method the option `--scale` will be used. This option is a shortcut version of the transform option and they are mutually exclusive.

Output scaling method.

Horizontal scaling factor/pixels.

Vertical scaling factor/pixels.

Refer to {manpage}`xrandr(1)` for the documentation of the transform matrix.

Output name to EDID mapping. Use `autorandr --fingerprint` to get current setup values.

Profile hook scripts.

Postswitch hook executed after mode switch.

Predetect hook executed before autorandr attempts to run xrandr.

Preswitch hook executed before mode switch.

Configuration written to {file}`$HOME/.aws/credentials`. For security reasons, never store cleartext passwords here. We recommend that you use `credential_process` option to retrieve the IAM credentials from your favorite password manager during runtime, or use AWS IAM Identity Center to get short-term credentials. See <https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-authentication.html>.

Whether to enable AWS CLI tool.

The aws package to use.

Configuration written to {file}`$HOME/.aws/config`.

Whether to enable bacon, a background rust code checker.

The bacon package to use.

Bacon configuration written to either {file}`Library/Application Support/org.dystroy.bacon/prefs.toml` (darwin) or {file}`$XDG_CONFIG_HOME/bacon/prefs.toml`. For available settings see <https://dystroy.org/bacon/#global-preferences>.

Extra commands that should be placed in {file}`~/.bashrc`. Note that these commands will be run even in non-interactive shells.

Whether to enable GNU Bourne-Again SHell.

Whether to enable Bash completion for all interactive Bash shells. Note, if you use NixOS or nix-darwin and do not have Bash completion enabled in the system configuration, then make sure to add ```nix environment.pathsToLink = [ "/share/bash-completion" ]; ``` to your system configuration to get completion for system packages. Note, the legacy {file}`/etc/bash_completion.d` path is not supported by Home Manager.

Whether to enable integration with terminals using the VTE library. This will let the terminal track the current working directory.

Controlling how commands are saved on the history list.

Location of the bash history file.

Number of history lines to keep on file.

List of commands that should not be saved to the history list.

Number of history lines to keep in memory.

Extra commands that should be run when initializing an interactive shell.

Extra commands that should be run when logging out of an interactive shell.

The bash package to use.

Extra commands that should be run when initializing a login shell.

Environment variables that will be set for the Bash session.

An attribute set that maps aliases (the top level attribute names in this option) to command strings or directly to build outputs.

Shell options to set. Prefix an option with "`-`" to unset.

Whether to enable bashmount.

Configuration written to {file}`$XDG_CONFIG_HOME/bashmount/config`. Look at <https://github.com/jamielinux/bashmount/blob/master/bashmount.conf> for explanation about possible values.

The bashmount package to use.

Bat configuration.

Whether to enable bat, a cat clone with wings.

Additional bat packages to install.

The bat package to use.

Additional syntaxes to provide.

Subpath of the syntax file within the source, if needed.

Path to the syntax folder.

Additional themes to provide.

Subpath of the theme file within the source, if needed.

Path to the theme folder.

Whether to enable the beets music library manager. This defaults to `false` for state version ≥ 19.03. For earlier versions beets is enabled if {option}`programs.beets.settings` is non-empty.

Whether to enable mpdstats plugin and service.

Whether to enable mpdupdate plugin.

The host that mpdstats will connect to.

The port that mpdstats will connect to.

The beets package to use. Can be used to specify extensions.

Configuration written to {file}`$XDG_CONFIG_HOME/beets/config.yaml`

Whether to enable bemenu.

The bemenu package to use.

Configuration options for bemenu. See {manpage}`bemenu(1)`.

Whether to enable Bluetuith.

The bluetuith package to use.

Configuration written to {file}`$XDG_CONFIG_HOME/bluetuith/bluetuith.conf`. See <https://bluetuith-org.github.io/bluetuith/Configuration.html> for details.

Borgmatic allows for several named backup configurations, each with its own source directories and repositories.

Consistency checks to run

Frequency of this type of check

Name of consistency check to run.

Extra settings.

Extra settings.

Whether to exclude Home Manager generated symbolic links from the backups. This facilitates restoring the whole home directory when the Nix store doesn't contain the latest Home Manager generation.

Extra settings.

Patterns to include/exclude. See the output of `borg help patterns` for the syntax. Pattern paths are relative to `/` even when a different recursion root is set. Mutually exclusive with [](#opt-programs.borgmatic.backups._name_.location.sourceDirectories).

List of local or remote repositories with paths and optional labels.

Short text describing the repository. Can be used with the `--repository` flag to select a repository.

Path of the repository.

Directories to backup. Mutually exclusive with [](#opt-programs.borgmatic.backups._name_.location.patterns).

Extra settings.

Extra settings.