From 14e5aa937865fc492276df33fdaea99d9c481a3b Mon Sep 17 00:00:00 2001 From: rycee Date: Tue, 13 Dec 2022 21:49:58 +0000 Subject: [PATCH] deploy: 263f6e4523168c770e21eee02def21d493c0f4b6 --- index.html | 4 +- nix-darwin-options.html | 18 +- nixos-options.html | 18 +- options.html | 4837 ++++++++++++--------------------------- tools.html | 14 +- 5 files changed, 1454 insertions(+), 3437 deletions(-) diff --git a/index.html b/index.html index bad21c2bb..485a0de88 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -Home Manager Manual

Home Manager Manual


Preface
1. Installing Home Manager
1.1. Standalone installation
1.2. NixOS module
1.3. nix-darwin module
2. Using Home Manager
2.1. Configuration Example
2.2. Rollbacks
2.3. Keeping your ~ safe from harm
2.4. Graphical services
2.5. Updating
3. Nix Flakes
3.1. Prerequisites
3.2. Standalone setup
3.3. NixOS module
3.4. nix-darwin module
4. Writing Home Manager Modules
4.1. Option Types
5. Contributing
5.1. Getting started
5.2. Guidelines
5.2.1. Maintain backward compatibility
5.2.2. Keep forward compatibility in mind
5.2.3. Add only valuable options
5.2.4. Add relevant tests
5.2.5. Add relevant documentation
5.2.6. Add yourself as a module maintainer
5.2.7. Format your code
5.2.8. Format your commit messages
5.2.9. Format your news entries
5.2.10. Use conditional modules and news
5.2.11. Mind the license
5.3. Commits
5.4. Code Style
5.5. News
5.6. Tests
6. Frequently Asked Questions (FAQ)
6.1. Why is there a collision error when switching generation?
6.2. Why are the session variables not set?
6.3. How to set up a configuration for multiple users/machines?
6.4. Why do I get an error message about ca.desrt.dconf or dconf.service?
6.5. How do I install packages from Nixpkgs unstable?
6.6. How do I override the package used by a module?
A. Configuration Options
B. NixOS Module Options
C. nix-darwin Module Options
D. Tools
home-manager - — reconfigure a user environment
E. Release Notes
E.1. Release 23.05
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 22.11
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 22.05
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 21.11
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 21.05
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 20.09
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 20.03
E.7.1. Highlights
E.7.2. State Version Changes
E.8. Release 19.09
E.8.1. Highlights
E.8.2. State Version Changes
E.9. Release 19.03
E.9.1. Highlights
E.9.2. State Version Changes
E.10. Release 18.09

Preface

+Home Manager Manual

Home Manager Manual


Preface
1. Installing Home Manager
1.1. Standalone installation
1.2. NixOS module
1.3. nix-darwin module
2. Using Home Manager
2.1. Configuration Example
2.2. Rollbacks
2.3. Keeping your ~ safe from harm
2.4. Graphical services
2.5. Updating
3. Nix Flakes
3.1. Prerequisites
3.2. Standalone setup
3.3. NixOS module
3.4. nix-darwin module
4. Writing Home Manager Modules
4.1. Option Types
5. Contributing
5.1. Getting started
5.2. Guidelines
5.2.1. Maintain backward compatibility
5.2.2. Keep forward compatibility in mind
5.2.3. Add only valuable options
5.2.4. Add relevant tests
5.2.5. Add relevant documentation
5.2.6. Add yourself as a module maintainer
5.2.7. Format your code
5.2.8. Format your commit messages
5.2.9. Format your news entries
5.2.10. Use conditional modules and news
5.2.11. Mind the license
5.3. Commits
5.4. Code Style
5.5. News
5.6. Tests
6. Frequently Asked Questions (FAQ)
6.1. Why is there a collision error when switching generation?
6.2. Why are the session variables not set?
6.3. How to set up a configuration for multiple users/machines?
6.4. Why do I get an error message about ca.desrt.dconf or dconf.service?
6.5. How do I install packages from Nixpkgs unstable?
6.6. How do I override the package used by a module?
A. Configuration Options
B. NixOS Module Options
C. nix-darwin Module Options
D. Tools
home-manager + — reconfigure a user environment
E. Release Notes
E.1. Release 23.05
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 22.11
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 22.05
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 21.11
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 21.05
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 20.09
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 20.03
E.7.1. Highlights
E.7.2. State Version Changes
E.8. Release 19.09
E.8.1. Highlights
E.8.2. State Version Changes
E.9. Release 19.03
E.9.1. Highlights
E.9.2. State Version Changes
E.10. Release 18.09

Preface

This manual will eventually describe how to install, use, and extend Home Manager.

diff --git a/nix-darwin-options.html b/nix-darwin-options.html index 39c0c3224..a6a69028d 100644 --- a/nix-darwin-options.html +++ b/nix-darwin-options.html @@ -7,18 +7,10 @@ file extension rather than exiting with an error. <home-manager/nixos/common.nix>

home-manager.extraSpecialArgs

Extra specialArgs passed to Home Manager. This option can be used to pass additional arguments to all modules. -

Type: attribute set

Default: - { - - } -

Example: { inherit emacs-overlay; }

Declared by:

+

Type: attribute set

Default: { }

Example: { inherit emacs-overlay; }

Declared by:

<home-manager/nixos/common.nix>
home-manager.sharedModules

Extra modules added to all users. -

Type: list of raw value

Default: - [ - - ] -

Example: [ { home.packages = [ nixpkgs-fmt ]; } ]

Declared by:

+

Type: list of raw value

Default: [ ]

Example: [ { home.packages = [ nixpkgs-fmt ]; } ]

Declared by:

<home-manager/nixos/common.nix>
home-manager.useGlobalPkgs

Whether to enable using the system configuration's pkgs argument in Home Manager. This disables the Home Manager @@ -30,11 +22,7 @@ options nixpkgs.* .

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/nixos/common.nix>
home-manager.users

Per-user Home Manager configuration. -

Type: attribute set of (Home Manager module)

Default: - { - - } -

Declared by:

+

Type: attribute set of (Home Manager module)

Default: { }

Declared by:

<home-manager/nixos/common.nix>
home-manager.verbose

Whether to enable verbose output on activation.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/nixos/common.nix> diff --git a/nixos-options.html b/nixos-options.html index 148a7d96a..c14e0a1f3 100644 --- a/nixos-options.html +++ b/nixos-options.html @@ -7,18 +7,10 @@ file extension rather than exiting with an error. <home-manager/nixos/common.nix>
home-manager.extraSpecialArgs

Extra specialArgs passed to Home Manager. This option can be used to pass additional arguments to all modules. -

Type: attribute set

Default: - { - - } -

Example: { inherit emacs-overlay; }

Declared by:

+

Type: attribute set

Default: { }

Example: { inherit emacs-overlay; }

Declared by:

<home-manager/nixos/common.nix>
home-manager.sharedModules

Extra modules added to all users. -

Type: list of raw value

Default: - [ - - ] -

Example: [ { home.packages = [ nixpkgs-fmt ]; } ]

Declared by:

+

Type: list of raw value

Default: [ ]

Example: [ { home.packages = [ nixpkgs-fmt ]; } ]

Declared by:

<home-manager/nixos/common.nix>
home-manager.useGlobalPkgs

Whether to enable using the system configuration's pkgs argument in Home Manager. This disables the Home Manager @@ -30,11 +22,7 @@ options nixpkgs.* .

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/nixos/common.nix>
home-manager.users

Per-user Home Manager configuration. -

Type: attribute set of (Home Manager module)

Default: - { - - } -

Declared by:

+

Type: attribute set of (Home Manager module)

Default: { }

Declared by:

<home-manager/nixos/common.nix>
home-manager.verbose

Whether to enable verbose output on activation.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/nixos/common.nix> diff --git a/options.html b/options.html index c132b8ae0..05f9b67d6 100644 --- a/options.html +++ b/options.html @@ -1,11 +1,7 @@ Appendix A. Configuration Options

Appendix A. Configuration Options

_module.args

Type: lazy attribute set of raw value

Declared by:

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

List of email accounts.

Type: attribute set of (submodule)

Default: - { - - } -

Declared by:

+
accounts.email.accounts

List of email accounts.

Type: attribute set of (submodule)

Default: { }

Declared by:

<home-manager/modules/services/imapnotify.nix>
<home-manager/modules/programs/thunderbird.nix> @@ -44,53 +40,37 @@
accounts.email.accounts.<name>.aerc.extraAccounts

Extra config added to the configuration of this account in $HOME/.config/aerc/accounts.conf. See aerc-config(5). -

Type: attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)

Default: - { - - } -

Example: { source = "maildir://~/Maildir/example"; }

Declared by:

+

Type: attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)

Default: { }

Example: { source = "maildir://~/Maildir/example"; }

Declared by:

<home-manager/modules/programs/aerc.nix>
accounts.email.accounts.<name>.aerc.extraBinds

Extra bindings specific to this account, added to $HOME/.config/aerc/accounts.conf. See aerc-config(5). -

Type: attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)

Default: - { - - } -

Example: { messages = { d = ":move ${folder.trash}<Enter>"; }; }

Declared by:

+

Type: attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)

Default: { }

Example: { messages = { d = ":move ${folder.trash}<Enter>"; }; }

Declared by:

<home-manager/modules/programs/aerc.nix>
accounts.email.accounts.<name>.aerc.extraConfig

Extra config specific to this account, added to $HOME/.config/aerc/aerc.conf. See aerc-config(5). -

Type: attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)

Default: - { - - } -

Example: { ui = { sidebar-width = 42; }; }

Declared by:

+

Type: attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)

Default: { }

Example: { ui = { sidebar-width = 42; }; }

Declared by:

<home-manager/modules/programs/aerc.nix>
accounts.email.accounts.<name>.aerc.smtpAuth

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

Type: null or one of "none", "plain", "login"

Default: "plain"

Example: "auth"

Declared by:

<home-manager/modules/programs/aerc.nix> -
accounts.email.accounts.<name>.aliases

Alternative email addresses of this account.

Type: list of string matching the pattern .*@.*

Default: - [ - - ] -

Example: - [ - "webmaster@example.org" "admin@example.org" - ] -

Declared by:

+
accounts.email.accounts.<name>.aliases

Alternative email addresses of this account.

Type: list of string matching the pattern .*@.*

Default: [ ]

Example:

[
+  "webmaster@example.org"
+  "admin@example.org"
+]

Declared by:

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

Contact completion configuration as expected per alot. See alot's wiki for explanation about possible values. -

Type: attribute set of string

Default: - { - command = "'\${pkgs.notmuch}/bin/notmuch address --format=json --output=recipients date:6M..'"; regexp = '''\[?{"name": "(?P<name>.*)", "address": "(?P<email>.+)", "name-addr": ".*"}[,\]]?'''; shellcommand_external_filtering = "False"; type = "shellcommand"; - } -

Example:

{
+

Type: attribute set of string

Default:

{
+  command = "'\${pkgs.notmuch}/bin/notmuch address --format=json --output=recipients  date:6M..'";
+  regexp = "'\\[?{\"name\": \"(?P<name>.*)\", \"address\": \"(?P<email>.+)\", \"name-addr\": \".*\"}[,\\]]?'";
+  shellcommand_external_filtering = "False";
+  type = "shellcommand";
+}

Example:

{
   type = "shellcommand";
   command = "abook --mutt-query";
   regexp = "'^(?P<email>[^@]+@[^\t]+)\t+(?P<name>[^\t]+)'";
@@ -109,15 +89,9 @@ then this is set to
                 
accounts.email.accounts.<name>.astroid.enable

Whether to enable Astroid.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/astroid.nix>
accounts.email.accounts.<name>.astroid.extraConfig

Extra settings to add to this astroid account configuration. -

Type: attribute set of anything

Default: - { - - } -

Example: - { - select_query = ""; - } -

Declared by:

+

Type: attribute set of anything

Default: { }

Example:

{
+  select_query = "";
+}

Declared by:

<home-manager/modules/programs/astroid.nix>
accounts.email.accounts.<name>.astroid.sendMailCommand

Command to send a mail. If msmtp is enabled for the account, then this is set to @@ -134,11 +108,7 @@ automatically.

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

Default: "plain"

Declared by:

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

Standard email folders. -

Type: submodule

Default: - { - - } -

Declared by:

+

Type: submodule

Default: { }

Declared by:

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

Relative path of the drafts mail folder.

Type: string

Default: "Drafts"

Declared by:

@@ -164,15 +134,10 @@ users should either enable delete or disable <home-manager/modules/programs/getmail.nix>
accounts.email.accounts.<name>.getmail.mailboxes

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

Type: non-empty (list of string)

Default: - [ - - ] -

Example: - [ - "INBOX" "INBOX.spam" - ] -

Declared by:

+

Type: non-empty (list of string)

Default: [ ]

Example:

[
+  "INBOX"
+  "INBOX.spam"
+]

Declared by:

<home-manager/modules/programs/getmail.nix>
accounts.email.accounts.<name>.getmail.readAll

Enable if you want to fetch all, even the read messages from the server. Most users should either enable delete or @@ -201,11 +166,7 @@ etc. mail. <home-manager/modules/programs/himalaya.nix>

accounts.email.accounts.<name>.himalaya.settings

Extra settings to add to this himalaya account configuration. -

Type: TOML value

Default: - { - - } -

Example:

{
+

Type: TOML value

Default: { }

Example:

{
   default-page-size = 50;
 }
 

Declared by:

@@ -221,11 +182,7 @@ account configuration.

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: null

Example: 993

Declared by:

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

Configuration for secure connections. -

Type: submodule

Default: - { - - } -

Declared by:

+

Type: submodule

Default: { }

Declared by:

<home-manager/modules/accounts/email.nix>
accounts.email.accounts.<name>.imap.tls.enable

Whether to enable TLS/SSL.

Type: boolean

Default: true

Declared by:

@@ -241,33 +198,20 @@ Note, if set then the system default may still be accepted. <home-manager/modules/accounts/email.nix>
accounts.email.accounts.<name>.imapnotify.enable

Whether to enable imapnotify.

Type: boolean

Default: false

Example: true

Declared by:

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

IMAP folders to watch.

Type: list of string

Default: - [ - - ] -

Example: - [ - "Inbox" "[Gmail]/MyLabel" - ] -

Declared by:

+
accounts.email.accounts.<name>.imapnotify.boxes

IMAP folders to watch.

Type: list of string

Default: [ ]

Example:

[
+  "Inbox"
+  "[Gmail]/MyLabel"
+]

Declared by:

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

Additional configuration to add for this account.

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

Default: - { - - } -

Example: - { - wait = 10; - } -

Declared by:

+
accounts.email.accounts.<name>.imapnotify.extraConfig

Additional configuration to add for this account.

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

Default: { }

Example:

{
+  wait = 10;
+}

Declared by:

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

Shell commands to run on any event.

Type: string or attribute set of string

Default: ""

Example: "\${pkgs.isync}/bin/mbsync test-%s"

Declared by:

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

Shell commands to run after onNotify event.

Type: string or attribute set of string

Default: ""

Example: - { - mail = "\${pkgs.notmuch}/bin/notmuch new && \${pkgs.libnotify}/bin/notify-send 'New mail arrived'"; - } -

Declared by:

+
accounts.email.accounts.<name>.imapnotify.onNotifyPost

Shell commands to run after onNotify event.

Type: string or attribute set of string

Default: ""

Example:

{
+  mail = "\${pkgs.notmuch}/bin/notmuch new && \${pkgs.libnotify}/bin/notify-send 'New mail arrived'";
+}

Declared by:

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

The JMAP configuration to use for this account.

Type: null or (submodule)

Default: null

Declared by:

@@ -300,11 +244,7 @@ for the account.

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

Type: JSON value

Default: - { - - } -

Declared by:

+

Type: JSON value

Default: { }

Declared by:

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

Allow missing labels on the Gmail side to be dropped.

Type: boolean

Default: false

Declared by:

@@ -323,19 +263,17 @@ for more details. <home-manager/modules/programs/lieer.nix>
accounts.email.accounts.<name>.lieer.settings.ignore_remote_labels

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

Type: list of string

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

Declared by:

+

Type: list of string

Default:

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

Declared by:

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

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

Type: list of string

Default: - [ - - ] -

Declared by:

+

Type: list of string

Default: [ ]

Declared by:

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

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

Type: string

Default: "trash"

Declared by:

@@ -360,11 +298,7 @@ for more information about the format.

Type: string

Default: "*:0/5"

Declared by:

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

Maildir configuration for this account. -

Type: null or (submodule)

Default: - { - path = "\${name}"; - } -

Declared by:

+

Type: null or (submodule)

Declared by:

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

Path to maildir directory where mail for this account is stored. This is relative to the base maildir path. @@ -381,40 +315,24 @@ the given mail store.

Type: one of "none", "maildir", "imap", "both"

Default: "none"

Example: "both"

Declared by:

<home-manager/modules/programs/mbsync.nix>
accounts.email.accounts.<name>.mbsync.extraConfig.account

Account section extra configuration. -

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

Default: - { - - } -

Example:

{
+

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

Default: { }

Example:

{
   PipelineDepth = 10;
   Timeout = 60;
 };
 

Declared by:

<home-manager/modules/programs/mbsync.nix>
accounts.email.accounts.<name>.mbsync.extraConfig.channel

Per channel extra configuration. -

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

Default: - { - - } -

Example:

{
+

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

Default: { }

Example:

{
   MaxMessages = 10000;
   MaxSize = "1m";
 };
 

Declared by:

<home-manager/modules/programs/mbsync.nix>
accounts.email.accounts.<name>.mbsync.extraConfig.local

Local store extra configuration. -

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

Default: - { - - } -

Declared by:

+

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

Default: { }

Declared by:

<home-manager/modules/programs/mbsync.nix>
accounts.email.accounts.<name>.mbsync.extraConfig.remote

Remote store extra configuration. -

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

Default: - { - - } -

Declared by:

+

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

Default: { }

Declared by:

<home-manager/modules/programs/mbsync.nix>
accounts.email.accounts.<name>.mbsync.flatten

If set, flattens the hierarchy within the maildir by substituting the canonical hierarchy delimiter @@ -428,11 +346,7 @@ 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. -

Type: attribute set of (submodule)

Default: - { - - } -

Declared by:

+

Type: attribute set of (submodule)

Default: { }

Declared by:

<home-manager/modules/programs/mbsync.nix>
accounts.email.accounts.<name>.mbsync.groups.<name>.channels

List of channels that should be grouped together into this group. When performing a synchronization, the groups are synchronized, rather than @@ -440,19 +354,11 @@ the individual channels.

Using these channels and then grouping them together allows for you to define the maildir hierarchy as you see fit. -

Type: attribute set of (submodule)

Default: - { - - } -

Declared by:

+

Type: attribute set of (submodule)

Default: { }

Declared by:

<home-manager/modules/programs/mbsync.nix>
accounts.email.accounts.<name>.mbsync.groups.<name>.channels.<name>.extraConfig

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

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

Default: - { - - } -

Example:

{
+

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

Default: { }

Example:

{
   Create = "both";
   CopyArrivalDate = "yes";
   MaxMessages = 10000;
@@ -488,26 +394,18 @@ If this is left as the default, then mbsync will default to the pattern
 match the farPattern, use it as a prefix which is
 not matched against the patterns, and is not affected by mailbox list
 overrides.
-

Type: list of string

Default: - [ - - ] -

Example: - [ - "INBOX" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "INBOX"
+]

Declared by:

<home-manager/modules/programs/mbsync.nix>
accounts.email.accounts.<name>.mbsync.groups.<name>.name

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.

Type: string (read only)

Default: "‹name›"

Declared by:

<home-manager/modules/programs/mbsync.nix>
accounts.email.accounts.<name>.mbsync.patterns

Pattern of mailboxes to synchronize. -

Type: list of string

Default: - [ - "*" - ] -

Declared by:

+

Type: list of string

Default:

[
+  "*"
+]

Declared by:

<home-manager/modules/programs/mbsync.nix>
accounts.email.accounts.<name>.mbsync.remove

Propagate mailbox deletions to the given mail store.

Type: one of "none", "maildir", "imap", "both"

Default: "none"

Example: "imap"

Declared by:

@@ -532,15 +430,9 @@ given then the primary account will be used.
accounts.email.accounts.<name>.msmtp.extraConfig

Extra configuration options to add to ~/.msmtprc. See https://marlam.de/msmtp/msmtprc.txt for examples. -

Type: attribute set of string

Default: - { - - } -

Example: - { - auth = "login"; - } -

Declared by:

+

Type: attribute set of string

Default: { }

Example:

{
+  auth = "login";
+}

Declared by:

<home-manager/modules/programs/msmtp.nix>
accounts.email.accounts.<name>.msmtp.tls.fingerprint

Fingerprint of a trusted TLS certificate. The fingerprint can be obtained by executing @@ -562,11 +454,7 @@ for the account.

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

Type: TOML value

Default: - { - - } -

Declared by:

+

Type: TOML value

Default: { }

Declared by:

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

Whether to create new mailboxes automatically on the server from notmuch tags. @@ -608,11 +496,7 @@ Beware that there are quirks that require manual consideration if changing the values of these files; please see https://github.com/elizagamedev/mujmap/blob/main/mujmap.toml.example for more details. -

Type: TOML value

Default: - { - - } -

Declared by:

+

Type: TOML value

Default: { }

Declared by:

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

Tag for notmuch to use for messages stored in the mailbox labeled with the Trash name attribute. @@ -678,11 +562,7 @@ attribute name of the account configuration.

accounts.email.accounts.<name>.neomutt.extraConfig

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

Type: strings concatenated with "\n"

Default: ""

Example: "color status cyan default"

Declared by:

<home-manager/modules/programs/neomutt.nix> -
accounts.email.accounts.<name>.neomutt.extraMailboxes

List of extra mailboxes

Type: list of (string or (submodule))

Default: - [ - - ] -

Declared by:

+
accounts.email.accounts.<name>.neomutt.extraMailboxes

List of extra mailboxes

Type: list of (string or (submodule))

Default: [ ]

Declared by:

<home-manager/modules/programs/neomutt.nix>
accounts.email.accounts.<name>.neomutt.mailboxName

Use a different name as mailbox name

Type: null or string

Default: null

Example: "==== <mailbox-name> ==="

Declared by:

<home-manager/modules/programs/neomutt.nix> @@ -698,39 +578,22 @@ else
accounts.email.accounts.<name>.offlineimap.enable

Whether to enable OfflineIMAP.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/offlineimap.nix>
accounts.email.accounts.<name>.offlineimap.extraConfig.account

Extra configuration options to add to the account section. -

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

Default: - { - - } -

Example: - { - autorefresh = 20; - } -

Declared by:

+

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

Default: { }

Example:

{
+  autorefresh = 20;
+}

Declared by:

<home-manager/modules/programs/offlineimap.nix>
accounts.email.accounts.<name>.offlineimap.extraConfig.local

Extra configuration options to add to the local account section. -

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

Default: - { - - } -

Example: - { - sync_deletes = true; - } -

Declared by:

+

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

Default: { }

Example:

{
+  sync_deletes = true;
+}

Declared by:

<home-manager/modules/programs/offlineimap.nix>
accounts.email.accounts.<name>.offlineimap.extraConfig.remote

Extra configuration options to add to the remote account section. -

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

Default: - { - - } -

Example: - { - expunge = false; maxconnections = 2; - } -

Declared by:

+

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

Default: { }

Example:

{
+  expunge = false;
+  maxconnections = 2;
+}

Declared by:

<home-manager/modules/programs/offlineimap.nix>
accounts.email.accounts.<name>.offlineimap.postSyncHookCommand

Command to run after fetching new mails.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/programs/offlineimap.nix> @@ -745,18 +608,14 @@ set as primary.
accounts.email.accounts.<name>.realName

Name displayed when sending mails.

Type: string

Example: "Jane Doe"

Declared by:

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

Signature configuration. -

Type: submodule

Default: - { - - } -

Declared by:

+

Type: submodule

Default: { }

Declared by:

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

A command that generates a signature.

Type: null or path

Default: null

Example:

pkgs.writeScript "signature" "echo This is my signature"
 

Declared by:

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

The delimiter used between the document and the signature.

Type: string

Default:

''
---
+  --
 ''

Example:

~*~*~*~*~*~*~*~*~*~*~*~
 

Declared by:

<home-manager/modules/accounts/email.nix> @@ -764,9 +623,9 @@ set as primary. <home-manager/modules/accounts/email.nix>
accounts.email.accounts.<name>.signature.text

Signature content.

Type: string

Default: ""

Example:

''
---
-Luke Skywalker
-May the force be with you.
+  --
+  Luke Skywalker
+  May the force be with you.
 ''

Declared by:

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

The SMTP configuration to use for this account. @@ -780,11 +639,7 @@ May the force be with you.

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: null

Example: 465

Declared by:

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

Configuration for secure connections. -

Type: submodule

Default: - { - - } -

Declared by:

+

Type: submodule

Default: { }

Declared by:

<home-manager/modules/accounts/email.nix>
accounts.email.accounts.<name>.smtp.tls.enable

Whether to enable TLS/SSL.

Type: boolean

Default: true

Declared by:

@@ -803,11 +658,7 @@ Note, if set then the system default may still be accepted.
accounts.email.accounts.<name>.thunderbird.profiles

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

Type: list of string

Default: - [ - - ] -

Example:

[ "profile1" "profile2" ]
+

Type: list of string

Default: [ ]

Example:

[ "profile1" "profile2" ]
 

Declared by:

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

Extra settings to add to this Thunderbird account configuration. @@ -834,11 +685,7 @@ directory.

Type: string

Default: "$HOME/Maildir"

Declared by:

<home-manager/modules/accounts/email.nix>
dconf.settings

Settings to write to the dconf configuration system. -

Type: attribute set of attribute set of (GVariant value)

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute set of (GVariant value)

Default: { }

Example:

{
   "org/gnome/calculator" = {
     button-mode = "programming";
     show-thousands = true;
@@ -855,11 +702,7 @@ directory.
 root = true is automatically added to the file,
 it must not be added here.
 See https://editorconfig.org for documentation.
-

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: { }

Example:

{
   "*" = {
     charset = "utf-8";
     end_of_line = "lf";
@@ -914,27 +757,16 @@ is assumed to already be available in your profile.
 ~/.gtkrc-2.0.
 

Type: strings concatenated with "\n"

Default: ""

Example: "gtk-can-change-accels = 1"

Declared by:

<home-manager/modules/misc/gtk.nix> -
gtk.gtk3.bookmarks

Bookmarks in the sidebar of the GTK file browser

Type: list of string

Default: - [ - - ] -

Example: - [ - "file:///home/jane/Documents" - ] -

Declared by:

+
gtk.gtk3.bookmarks

Bookmarks in the sidebar of the GTK file browser

Type: list of string

Default: [ ]

Example:

[
+  "file:///home/jane/Documents"
+]

Declared by:

<home-manager/modules/misc/gtk.nix>
gtk.gtk3.extraConfig

Extra configuration options to add to $XDG_CONFIG_HOME/gtk-3.0/settings.ini. -

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

Default: - { - - } -

Example: - { - gtk-cursor-blink = false; gtk-recent-files-limit = 20; - } -

Declared by:

+

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

Default: { }

Example:

{
+  gtk-cursor-blink = false;
+  gtk-recent-files-limit = 20;
+}

Declared by:

<home-manager/modules/misc/gtk.nix>
gtk.gtk3.extraCss

Extra configuration lines to add verbatim to $XDG_CONFIG_HOME/gtk-3.0/gtk.css. @@ -942,15 +774,10 @@ is assumed to already be available in your profile. <home-manager/modules/misc/gtk.nix>

gtk.gtk4.extraConfig

Extra configuration options to add to $XDG_CONFIG_HOME/gtk-4.0/settings.ini. -

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

Default: - { - - } -

Example: - { - gtk-cursor-blink = false; gtk-recent-files-limit = 20; - } -

Declared by:

+

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

Default: { }

Example:

{
+  gtk-cursor-blink = false;
+  gtk-recent-files-limit = 20;
+}

Declared by:

<home-manager/modules/misc/gtk.nix>
gtk.iconTheme

The icon theme to use.

Type: null or (submodule)

Default: null

Declared by:

<home-manager/modules/misc/gtk.nix> @@ -987,11 +814,7 @@ When this option is enabled and a mismatch is detected then a warning will be printed when the user configuration is being built.

Type: boolean

Default: false

Declared by:

<home-manager/modules/home-environment.nix> -
home.packages

The set of packages to appear in the user environment.

Type: list of package

Default: - [ - - ] -

Declared by:

+
home.packages

The set of packages to appear in the user environment.

Type: list of package

Default: [ ]

Declared by:

<home-manager/modules/home-environment.nix>
home.activation

The activation scripts blocks to run when activating a Home Manager generation. Any entry here should be idempotent, @@ -1027,11 +850,7 @@ information on standard out that may be useful for debugging any issue that may arise. The variable VERBOSE_ARG is set to --verbose if verbose output is enabled. -

Type: DAG of string

Default: - { - - } -

Example:

{
+

Type: DAG of string

Default: { }

Example:

{
   myActivationAction = lib.hm.dag.entryAfter ["writeBoundary"] ''
     $DRY_RUN_CMD ln -s $VERBOSE_ARG \
         ${builtins.toPath ./link-me-directly} $HOME
@@ -1042,21 +861,13 @@ any issue that may arise. The variable
                 
home.extraOutputsToInstall

List of additional package outputs of the packages home.packages that should be installed into the user environment. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "doc" "info" "devdoc" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "doc"
+  "info"
+  "devdoc"
+]

Declared by:

<home-manager/modules/home-environment.nix> -
home.file

Attribute set of files to link into the user home.

Type: attribute set of (submodule)

Default: - { - - } -

Declared by:

+
home.file

Attribute set of files to link into the user home.

Type: attribute set of (submodule)

Default: { }

Declared by:

<home-manager/modules/files.nix>
home.file.<name>.executable

Set the execute bit. If null, defaults to the mode of the source file or to false @@ -1091,16 +902,14 @@ containing that text.

Type: path

Declared by:

<home-manager/modules/files.nix>
home.file.<name>.target

Path to target file relative to HOME. -

Type: string

Default: <name>

Declared by:

+

Type: string

Declared by:

<home-manager/modules/files.nix>
home.file.<name>.text

Text of the file. If this option is null then home.file.<name>.source must be set.

Type: null or strings concatenated with "\n"

Default: null

Declared by:

<home-manager/modules/files.nix> -
home.homeDirectory

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

Type: path

Default:

"$HOME"   for state version < 20.09,
-undefined for state version ≥ 20.09
-

Example: "/home/jane.doe"

Declared by:

+
home.homeDirectory

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

Type: path

Example: "/home/jane.doe"

Declared by:

<home-manager/modules/home-environment.nix>
home.keyboard

Keyboard configuration. Set to null to disable Home Manager keyboard management. @@ -1119,15 +928,10 @@ version ≥ 19.09 and "us" otherwise.

Type: null or string

Default: null

Example: "presario"

Declared by:

<home-manager/modules/home-environment.nix>
home.keyboard.options

X keyboard options; layout switching goes here. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "grp:caps_toggle" "grp_led:scroll" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "grp:caps_toggle"
+  "grp_led:scroll"
+]

Declared by:

<home-manager/modules/home-environment.nix>
home.keyboard.variant

X keyboard variant. If null, then the system configuration will be used. @@ -1136,11 +940,7 @@ This defaults to null for state version ≥ 19.09 and "" otherwise.

Type: null or string

Default: null

Example: "colemak"

Declared by:

<home-manager/modules/home-environment.nix> -
home.language

Language configuration.

Type: submodule

Default: - { - - } -

Declared by:

+
home.language

Language configuration.

Type: submodule

Default: { }

Declared by:

<home-manager/modules/home-environment.nix>
home.language.address

The language to use for addresses.

Type: null or string

Default: null

Declared by:

@@ -1204,9 +1004,7 @@ will enable x11 cursor configurations.
home.pointerCursor.x11.defaultCursor

The default cursor file to use within the package.

Type: string

Default: "left_ptr"

Example: "X_cursor"

Declared by:

<home-manager/modules/config/home-cursor.nix>
home.profileDirectory

The profile directory where Home Manager generations are installed. -

Type: path (read only)

Default:

"${home.homeDirectory}/.nix-profile"  or
-"/etc/profiles/per-user/${home.username}"
-

Declared by:

+

Type: path (read only)

Declared by:

<home-manager/modules/home-environment.nix>
home.sessionPath

Extra directories to add to PATH. @@ -1217,15 +1015,11 @@ 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 PATH verbatim. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "$HOME/.local/bin" "\${xdg.configHome}/emacs/bin" ".git/safe/../../bin" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "$HOME/.local/bin"
+  "\${xdg.configHome}/emacs/bin"
+  ".git/safe/../../bin"
+]

Declared by:

<home-manager/modules/home-environment.nix>
home.sessionVariables

Environment variables to always set at login.

@@ -1256,15 +1050,10 @@ home.sessionVariables = { BAR = "${config.home.sessionVariables.FOO} World!"; };

-

Type: attribute set

Default: - { - - } -

Example: - { - EDITOR = "emacs"; GS_OPTIONS = "-sPAPERSIZE=a4"; - } -

Declared by:

+

Type: attribute set

Default: { }

Example:

{
+  EDITOR = "emacs";
+  GS_OPTIONS = "-sPAPERSIZE=a4";
+}

Declared by:

<home-manager/modules/home-environment.nix>
home.shellAliases

An attribute set that maps aliases (the top level attribute names in this option) to command strings or directly to build outputs. @@ -1273,11 +1062,7 @@ 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 programs.bash.shellAliases for Bash. -

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   g = "git";
   "..." = "cd ../..";
 }
@@ -1295,9 +1080,7 @@ typically requires performing some manual steps, such as data
 conversion or moving files.
 

Type: one of "18.09", "19.03", "19.09", "20.03", "20.09", "21.03", "21.05", "21.11", "22.05", "22.11", "23.05"

Declared by:

<home-manager/modules/misc/version.nix> -
home.username

The user's username.

Type: string

Default:

"$USER"   for state version < 20.09,
-undefined for state version ≥ 20.09
-

Example: "jane.doe"

Declared by:

+
home.username

The user's username.

Type: string

Example: "jane.doe"

Declared by:

<home-manager/modules/home-environment.nix>
i18n.inputMethod.enabled

Select the enabled input method. Input methods is a software to input symbols that are not available on standard input devices. @@ -1323,27 +1106,15 @@ Currently the following input methods are available in Home Manager:

hime

An extremely easy-to-use input method framework.

kime

A Korean IME.

Type: null or one of "fcitx", "fcitx5", "nabi", "uim", "hime", "kime"

Default: null

Example: "fcitx"

Declared by:

<home-manager/modules/i18n/input-method/default.nix> -
i18n.inputMethod.fcitx.engines

Enabled Fcitx engines. Available engines are: anthy, chewing, cloudpinyin, hangul, libpinyin, m17n, mozc, rime, skk, table-extra, table-other, unikey.

Type: list of package

Default: - [ - - ] -

Example: with pkgs.fcitx-engines; [ mozc hangul ]

Declared by:

+
i18n.inputMethod.fcitx.engines

Enabled Fcitx engines. Available engines are: anthy, chewing, cloudpinyin, hangul, libpinyin, m17n, mozc, rime, skk, table-extra, table-other, unikey.

Type: list of package

Default: [ ]

Example: with pkgs.fcitx-engines; [ mozc hangul ]

Declared by:

<home-manager/modules/i18n/input-method/fcitx.nix>
i18n.inputMethod.fcitx5.addons

Enabled Fcitx5 addons. -

Type: list of package

Default: - [ - - ] -

Example: with pkgs; [ fcitx5-rime ]

Declared by:

+

Type: list of package

Default: [ ]

Example: with pkgs; [ fcitx5-rime ]

Declared by:

<home-manager/modules/i18n/input-method/fcitx5.nix>
i18n.inputMethod.kime.config

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

Type: YAML value

Default: - { - - } -

Example:

{
+

Type: YAML value

Default: { }

Example:

{
   daemon = {
     modules = ["Xim" "Indicator"];
   };
@@ -1367,20 +1138,12 @@ for details on supported values.
 of launchd's LaunchAgents.
 

Type: boolean

Default: pkgs.stdenv.hostPlatform.isDarwin

Declared by:

<home-manager/modules/launchd/default.nix> -
launchd.agents

Define LaunchAgents.

Type: attribute set of (submodule)

Default: - { - - } -

Declared by:

+
launchd.agents

Define LaunchAgents.

Type: attribute set of (submodule)

Default: { }

Declared by:

<home-manager/modules/launchd/default.nix>
launchd.agents.<name>.enable

Whether to enable ‹name›.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/launchd/default.nix>
launchd.agents.<name>.config

Define a launchd job. See launchd.plist(5) for details. -

Type: submodule

Default: - { - - } -

Example:

{
+

Type: submodule

Default: { }

Example:

{
   ProgramArguments = [ "/usr/bin/say" "Good afternoon" ];
   StartCalendarInterval = {
     Hour = 12;
@@ -1439,11 +1202,9 @@ group of the user.
                     <home-manager/modules/launchd/default.nix>
                 
launchd.agents.<name>.config.HardResourceLimits

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

Type: null or (submodule)

Default: null

Example: - { - NumberOfFiles = 4096; - } -

Declared by:

+

Type: null or (submodule)

Default: null

Example:

{
+  NumberOfFiles = 4096;
+}

Declared by:

<home-manager/modules/launchd/default.nix>
launchd.agents.<name>.config.HardResourceLimits.CPU

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

Type: null or signed integer

Default: null

Declared by:

@@ -1522,11 +1283,9 @@ be a boolean and set to true. Alternatively, a dictionary can be used instead o Finally, for the job itself, the values will be replaced with Mach ports at the time of check-in with launchd. -

Type: null or (submodule)

Default: null

Example: - { - ResetAtClose = true; - } -

Declared by:

+

Type: null or (submodule)

Default: null

Example:

{
+  ResetAtClose = true;
+}

Declared by:

<home-manager/modules/launchd/default.nix>
launchd.agents.<name>.config.MachServices.HideUntilCheckIn

Reserve the name in the namespace, but cause bootstrap_look_up() to fail until the job has checked in with launchd. @@ -1701,11 +1460,10 @@ are considered to be wildcard. The semantics are much like

Type: null or (list of (submodule))

Default: null

Example: - { - Hour = 2; Minute = 30; - } -

Declared by:

+

Type: null or (list of (submodule))

Default: null

Example:

{
+  Hour = 2;
+  Minute = 30;
+}

Declared by:

<home-manager/modules/launchd/default.nix>
launchd.agents.<name>.config.StartCalendarInterval.*.Day

The day on which this job will be run.

Type: null or signed integer

Default: null

Declared by:

@@ -1760,11 +1518,9 @@ to attach before any code in the job is executed.

Type: null or string

Default: null

Declared by:

<home-manager/modules/launchd/default.nix>
launchd.agents.<name>.config.inetdCompatibility

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

Type: null or (submodule)

Default: null

Example: - { - Wait = true; - } -

Declared by:

+

Type: null or (submodule)

Default: null

Example:

{
+  Wait = true;
+}

Declared by:

<home-manager/modules/launchd/default.nix>
launchd.agents.<name>.config.inetdCompatibility.Wait

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 @@ -1773,11 +1529,7 @@ called on behalf of the job, and the result is passed via the standard in/out/er <home-manager/modules/launchd/default.nix>

lib

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

Type: attribute set of (attribute set)

Default: - { - - } -

Declared by:

+

Type: attribute set of (attribute set)

Default: { }

Declared by:

<home-manager/modules/misc/lib.nix>
manual.html.enable

Whether to install the HTML manual. This also installs the home-manager-help tool, which opens a local @@ -1829,16 +1581,12 @@ can parse the generated nix.conf.

Type: boolean

Default: true

Declared by:

<home-manager/modules/misc/nix.nix>
nix.extraOptions

Additional text appended to nix.conf.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-keep-outputs = true
-keep-derivations = true
+  keep-outputs = true
+  keep-derivations = true
 ''

Declared by:

<home-manager/modules/misc/nix.nix>
nix.registry

User level flake registry. -

Type: attribute set of (submodule)

Default: - { - - } -

Declared by:

+

Type: attribute set of (submodule)

Default: { }

Declared by:

<home-manager/modules/misc/nix.nix>
nix.registry.<name>.exact

Whether the from reference needs to match exactly. If set, a from reference like nixpkgs does not @@ -1848,17 +1596,16 @@ match with a reference like nixpkgs/nixos-20.03.

nix.registry.<name>.flake

The flake input to which from> is to be rewritten.

Type: null or (attribute set)

Default: null

Example: nixpkgs

Declared by:

<home-manager/modules/misc/nix.nix> -
nix.registry.<name>.from

The flake reference to be rewritten.

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

Example: - { - id = "nixpkgs"; type = "indirect"; - } -

Declared by:

+
nix.registry.<name>.from

The flake reference to be rewritten.

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

Example:

{
+  id = "nixpkgs";
+  type = "indirect";
+}

Declared by:

<home-manager/modules/misc/nix.nix> -
nix.registry.<name>.to

The flake reference to which from> is to be rewritten.

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

Example: - { - owner = "my-org"; repo = "my-nixpkgs"; type = "github"; - } -

Declared by:

+
nix.registry.<name>.to

The flake reference to which from> is to be rewritten.

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

Example:

{
+  owner = "my-org";
+  repo = "my-nixpkgs";
+  type = "github";
+}

Declared by:

<home-manager/modules/misc/nix.nix>
nix.settings

Configuration for Nix, see https://nixos.org/manual/nix/stable/#sec-conf-file or @@ -1867,11 +1614,7 @@ The value declared here will be translated directly to the key-value pairs Nix e

Configuration specified in nix.extraOptions which will be appended verbatim to the resulting config file. -

Type: attribute set of (Nix config atom (null, bool, int, float, str, path or package) or list of (Nix config atom (null, bool, int, float, str, path or package)))

Default: - { - - } -

Example:

{
+

Type: attribute set of (Nix config atom (null, bool, int, float, str, path or package) or list of (Nix config atom (null, bool, int, float, str, path or package)))

Default: { }

Example:

{
   use-sandbox = true;
   show-trace = true;
   system-features = [ "big-parallel" "kvm" "recursive-nix" ];
@@ -1902,11 +1645,9 @@ file and include something like
 

in your Home Manager configuration. -

Type: null or (nixpkgs config)

Default: null

Example: - { - allowBroken = true; - } -

Declared by:

+

Type: null or (nixpkgs config)

Default: null

Example:

{
+  allowBroken = true;
+}

Declared by:

<home-manager/modules/misc/nixpkgs.nix>
nixpkgs.overlays

List of overlays to use with the Nix Packages collection. (For details, see the Nixpkgs documentation.) It allows you to @@ -1943,24 +1684,14 @@ The variable values must be as described in

Note, this option will become deprecated in the future and its use is therefore discouraged. -

Type: attribute set

Default: - { - - } -

Example: - { - EDITOR = "vim"; - } -

Declared by:

+

Type: attribute set

Default: { }

Example:

{
+  EDITOR = "vim";
+}

Declared by:

<home-manager/modules/misc/pam.nix>
pam.yubico.authorizedYubiKeys.ids

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. -

Type: list of string of length 12

Default: - [ - - ] -

Declared by:

+

Type: list of string of length 12

Default: [ ]

Declared by:

<home-manager/modules/misc/pam.nix>
pam.yubico.authorizedYubiKeys.path

File path to write the authorized YubiKeys, relative to HOME. @@ -1972,54 +1703,34 @@ relative to HOME. Available configuration options are described in the abook repository: https://sourceforge.net/p/abook/git/ci/master/tree/sample.abookrc.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-field pager = Pager
-view CONTACT = name, email
-set autosave=true
+  field pager = Pager
+  view CONTACT = name, email
+  set autosave=true
 ''

Declared by:

<home-manager/modules/programs/abook.nix>
programs.aerc.enable

Whether to enable aerc.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/aerc.nix>
programs.aerc.extraAccounts

Extra lines added to $HOME/.config/aerc/accounts.conf. See aerc-config(5). -

Type: strings concatenated with "\n" or attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)

Default: - { - - } -

Example: { Work = { source = "maildir://~/Maildir/work"; }; }

Declared by:

+

Type: strings concatenated with "\n" or attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)

Default: { }

Example: { Work = { source = "maildir://~/Maildir/work"; }; }

Declared by:

<home-manager/modules/programs/aerc.nix>
programs.aerc.extraBinds

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

Type: strings concatenated with "\n" or attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)

Default: - { - - } -

Example: { messages = { q = ":quit<Enter>"; }; }

Declared by:

+

Type: strings concatenated with "\n" or attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)

Default: { }

Example: { messages = { q = ":quit<Enter>"; }; }

Declared by:

<home-manager/modules/programs/aerc.nix>
programs.aerc.extraConfig

Extra lines added to $HOME/.config/aerc/aerc.conf. See aerc-config(5). -

Type: strings concatenated with "\n" or attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)

Default: - { - - } -

Example: { ui = { sort = "-r date"; }; }

Declared by:

+

Type: strings concatenated with "\n" or attribute set of attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)

Default: { }

Example: { ui = { sort = "-r date"; }; }

Declared by:

<home-manager/modules/programs/aerc.nix>
programs.aerc.stylesets

Stylesets added to $HOME/.config/aerc/stylesets/. See aerc-stylesets(7). -

Type: attribute set of ((attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)) or strings concatenated with "\n")

Default: - { - - } -

Example:

{ default = { ui = { "tab.selected.reverse" = toggle; }; }; };
+

Type: attribute set of ((attribute set of (values (null, bool, int, string of float) or a list of values, that will be joined with a comma)) or strings concatenated with "\n")

Default: { }

Example:

{ default = { ui = { "tab.selected.reverse" = toggle; }; }; };
 

Declared by:

<home-manager/modules/programs/aerc.nix>
programs.aerc.templates

Templates added to $HOME/.config/aerc/templates/. See aerc-templates(7). -

Type: attribute set of strings concatenated with "\n"

Default: - { - - } -

Example:

{ new_message = "Hello!"; };
+

Type: attribute set of strings concatenated with "\n"

Default: { }

Example:

{ new_message = "Hello!"; };
 

Declared by:

<home-manager/modules/programs/aerc.nix>
programs.afew.enable

Whether to enable the afew initial tagging script for Notmuch.

Type: boolean

Default: false

Example: true

Declared by:

@@ -2028,20 +1739,20 @@ See aerc-templates(7). configuration options are described in the afew manual: https://afew.readthedocs.io/en/latest/configuration.html.

Type: strings concatenated with "\n"

Default:

''
-[SpamFilter]
-[KillThreadsFilter]
-[ListMailsFilter]
-[ArchiveSentMailsFilter]
-[InboxFilter]
+  [SpamFilter]
+  [KillThreadsFilter]
+  [ListMailsFilter]
+  [ArchiveSentMailsFilter]
+  [InboxFilter]
 ''

Example:

''
-[SpamFilter]
-
-[Filter.0]
-query = from:pointyheaded@boss.com
-tags = -new;+boss
-message = Message from above
-
-[InboxFilter]
+  [SpamFilter]
+  
+  [Filter.0]
+  query = from:pointyheaded@boss.com
+  tags = -new;+boss
+  message = Message from above
+  
+  [InboxFilter]
 ''

Declared by:

<home-manager/modules/programs/afew.nix>
programs.alacritty.enable

Whether to enable Alacritty.

Type: boolean

Default: false

Example: true

Declared by:

@@ -2052,11 +1763,7 @@ message = Message from above $XDG_CONFIG_HOME/alacritty/alacritty.yml. See https://github.com/alacritty/alacritty/blob/master/alacritty.yml for the default configuration. -

Type: YAML value

Default: - { - - } -

Example:

{
+

Type: YAML value

Default: { }

Example:

{
   window.dimensions = {
     lines = 3;
     columns = 200;
@@ -2077,47 +1784,19 @@ enabled for each email account that is managed by Notmuch.
 

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/alot.nix>
programs.alot.bindings

Keybindings. -

Type: submodule

Default: - { - - } -

Declared by:

+

Type: submodule

Default: { }

Declared by:

<home-manager/modules/programs/alot.nix> -
programs.alot.bindings.bufferlist

Bufferlist mode keybindings.

Type: attribute set of string

Default: - { - - } -

Declared by:

+
programs.alot.bindings.bufferlist

Bufferlist mode keybindings.

Type: attribute set of string

Default: { }

Declared by:

<home-manager/modules/programs/alot.nix> -
programs.alot.bindings.envelope

Envelope mode keybindings.

Type: attribute set of string

Default: - { - - } -

Declared by:

+
programs.alot.bindings.envelope

Envelope mode keybindings.

Type: attribute set of string

Default: { }

Declared by:

<home-manager/modules/programs/alot.nix> -
programs.alot.bindings.global

Global keybindings.

Type: attribute set of string

Default: - { - - } -

Declared by:

+
programs.alot.bindings.global

Global keybindings.

Type: attribute set of string

Default: { }

Declared by:

<home-manager/modules/programs/alot.nix> -
programs.alot.bindings.search

Search mode keybindings.

Type: attribute set of string

Default: - { - - } -

Declared by:

+
programs.alot.bindings.search

Search mode keybindings.

Type: attribute set of string

Default: { }

Declared by:

<home-manager/modules/programs/alot.nix> -
programs.alot.bindings.taglist

Taglist mode keybindings.

Type: attribute set of string

Default: - { - - } -

Declared by:

+
programs.alot.bindings.taglist

Taglist mode keybindings.

Type: attribute set of string

Default: { }

Declared by:

<home-manager/modules/programs/alot.nix> -
programs.alot.bindings.thread

Thread mode keybindings.

Type: attribute set of string

Default: - { - - } -

Declared by:

+
programs.alot.bindings.thread

Thread mode keybindings.

Type: attribute set of string

Default: { }

Declared by:

<home-manager/modules/programs/alot.nix>
programs.alot.extraConfig

Extra lines added to alot configuration file.

Type: strings concatenated with "\n"

Default: ""

Declared by:

@@ -2126,22 +1805,19 @@ enabled for each email account that is managed by Notmuch.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/programs/alot.nix>
programs.alot.settings

Configuration options added to alot configuration file. -

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

Default: - { - auto_remove_unread = true; handle_mouse = true; initial_command = "search tag:inbox AND NOT tag:killed"; prefer_plaintext = true; - } -

Example:

{
+

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

Default:

{
+  auto_remove_unread = true;
+  handle_mouse = true;
+  initial_command = "search tag:inbox AND NOT tag:killed";
+  prefer_plaintext = true;
+}

Example:

{
   auto_remove_unread = true;
   ask_subject = false;
   thread_indent_replies = 2;
 }
 

Declared by:

<home-manager/modules/programs/alot.nix> -
programs.alot.tags

How to display the tags.

Type: attribute set of (submodule)

Default: - { - - } -

Declared by:

+
programs.alot.tags

How to display the tags.

Type: attribute set of (submodule)

Default: { }

Declared by:

<home-manager/modules/programs/alot.nix>
programs.alot.tags.<name>.focus

How to display the tag when focused.

Type: null or string

Default: null

Declared by:

<home-manager/modules/programs/alot.nix> @@ -2168,11 +1844,7 @@ compute the string representation on the fly using See aria2c(1) for options. -

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

Default: - { - - } -

Example:

{
+

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

Default: { }

Example:

{
   listen-port = 60000;
   dht-listen-port = 60000;
   seed-ratio = 1.0;
@@ -2190,11 +1862,7 @@ See Type: null or string

Default: null

Example: "nvim-qt -- -c 'set ft=mail' '+set fileencoding=utf-8' '+set ff=unix' '+set enc=utf-8' '+set fo+=w' %1"

Declared by:

<home-manager/modules/programs/astroid.nix>
programs.astroid.extraConfig

JSON config that will override the default Astroid configuration. -

Type: JSON value

Default: - { - - } -

Example:

{
+

Type: JSON value

Default: { }

Example:

{
   poll.interval = 0;
 }
 

Declared by:

@@ -2226,11 +1894,7 @@ key to open the Atuin history.

See https://github.com/ellie/atuin/blob/main/docs/config.md for the full list of options. -

Type: Atuin configuration

Default: - { - - } -

Example:

{
+

Type: Atuin configuration

Default: { }

Example:

{
   auto_sync = true;
   sync_frequency = "5m";
   sync_address = "https://api.atuin.sh";
@@ -2251,11 +1915,7 @@ of options.
                     <home-manager/modules/programs/autojump.nix>
                 
programs.autorandr.enable

Whether to enable Autorandr.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/autorandr.nix> -
programs.autorandr.hooks

Global hook scripts

Type: submodule

Default: - { - - } -

Example:

{
+                
programs.autorandr.hooks

Global hook scripts

Type: submodule

Default: { }

Example:

{
   postswitch = {
     "notify-i3" = "${pkgs.i3}/bin/i3-msg restart";
     "change-background" = readFile ./change-background.sh;
@@ -2281,30 +1941,14 @@ of options.
 }
 

Declared by:

<home-manager/modules/programs/autorandr.nix> -
programs.autorandr.hooks.postswitch

Postswitch hook executed after mode switch.

Type: attribute set of strings concatenated with "\n"

Default: - { - - } -

Declared by:

+
programs.autorandr.hooks.postswitch

Postswitch hook executed after mode switch.

Type: attribute set of strings concatenated with "\n"

Default: { }

Declared by:

<home-manager/modules/programs/autorandr.nix>
programs.autorandr.hooks.predetect

Predetect hook executed before autorandr attempts to run xrandr. -

Type: attribute set of strings concatenated with "\n"

Default: - { - - } -

Declared by:

+

Type: attribute set of strings concatenated with "\n"

Default: { }

Declared by:

<home-manager/modules/programs/autorandr.nix> -
programs.autorandr.hooks.preswitch

Preswitch hook executed before mode switch.

Type: attribute set of strings concatenated with "\n"

Default: - { - - } -

Declared by:

+
programs.autorandr.hooks.preswitch

Preswitch hook executed before mode switch.

Type: attribute set of strings concatenated with "\n"

Default: { }

Declared by:

<home-manager/modules/programs/autorandr.nix> -
programs.autorandr.profiles

Autorandr profiles specification.

Type: attribute set of (submodule)

Default: - { - - } -

Example:

{
+                
programs.autorandr.profiles

Autorandr profiles specification.

Type: attribute set of (submodule)

Default: { }

Example:

{
   "work" = {
     fingerprint = {
       eDP1 = "<EDID>";
@@ -2328,11 +1972,7 @@ of options.
 }
 

Declared by:

<home-manager/modules/programs/autorandr.nix> -
programs.autorandr.profiles.<name>.config

Per output profile configuration.

Type: attribute set of (submodule)

Default: - { - - } -

Declared by:

+
programs.autorandr.profiles.<name>.config

Per output profile configuration.

Type: attribute set of (submodule)

Default: { }

Declared by:

<home-manager/modules/programs/autorandr.nix>
programs.autorandr.profiles.<name>.config.<name>.enable

Whether to enable the output.

Type: boolean

Default: true

Declared by:

<home-manager/modules/programs/autorandr.nix> @@ -2390,17 +2030,9 @@ for the documentation of the transform matrix. <home-manager/modules/programs/autorandr.nix>
programs.autorandr.profiles.<name>.fingerprint

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

Type: attribute set of string

Default: - { - - } -

Declared by:

+

Type: attribute set of string

Default: { }

Declared by:

<home-manager/modules/programs/autorandr.nix> -
programs.autorandr.profiles.<name>.hooks

Profile hook scripts.

Type: submodule

Default: - { - - } -

Declared by:

+
programs.autorandr.profiles.<name>.hooks

Profile hook scripts.

Type: submodule

Default: { }

Declared by:

<home-manager/modules/programs/autorandr.nix>
programs.autorandr.profiles.<name>.hooks.postswitch

Postswitch hook executed after mode switch.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/programs/autorandr.nix> @@ -2436,25 +2068,17 @@ directory. Note that these commands will be run even in non-interactive shells.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/programs/bash.nix> -
programs.bash.historyControl

Controlling how commands are saved on the history list.

Type: list of (one of "erasedups", "ignoredups", "ignorespace")

Default: - [ - - ] -

Declared by:

+
programs.bash.historyControl

Controlling how commands are saved on the history list.

Type: list of (one of "erasedups", "ignoredups", "ignorespace")

Default: [ ]

Declared by:

<home-manager/modules/programs/bash.nix>
programs.bash.historyFile

Location of the bash history file.

Type: null or string

Default: null

Declared by:

<home-manager/modules/programs/bash.nix>
programs.bash.historyFileSize

Number of history lines to keep on file.

Type: signed integer

Default: 100000

Declared by:

<home-manager/modules/programs/bash.nix> -
programs.bash.historyIgnore

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

Type: list of string

Default: - [ - - ] -

Example: - [ - "ls" "cd" "exit" - ] -

Declared by:

+
programs.bash.historyIgnore

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

Type: list of string

Default: [ ]

Example:

[
+  "ls"
+  "cd"
+  "exit"
+]

Declared by:

<home-manager/modules/programs/bash.nix>
programs.bash.historySize

Number of history lines to keep in memory.

Type: signed integer

Default: 10000

Declared by:

<home-manager/modules/programs/bash.nix> @@ -2471,23 +2095,13 @@ shell.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/programs/bash.nix>
programs.bash.sessionVariables

Environment variables that will be set for the Bash session. -

Type: attribute set

Default: - { - - } -

Example: - { - MAILCHECK = 30; - } -

Declared by:

+

Type: attribute set

Default: { }

Example:

{
+  MAILCHECK = 30;
+}

Declared by:

<home-manager/modules/programs/bash.nix>
programs.bash.shellAliases

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

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   ll = "ls -l";
   ".." = "cd ..";
 }
@@ -2495,15 +2109,16 @@ this option) to command strings or directly to build outputs.
                     <home-manager/modules/programs/bash.nix>
                 
programs.bash.shellOptions

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

Type: list of string

Default: - [ - "histappend" "checkwinsize" "extglob" "globstar" "checkjobs" - ] -

Example: - [ - "extglob" "-cdspell" - ] -

Declared by:

+

Type: list of string

Default:

[
+  "histappend"
+  "checkwinsize"
+  "extglob"
+  "globstar"
+  "checkjobs"
+]

Example:

[
+  "extglob"
+  "-cdspell"
+]

Declared by:

<home-manager/modules/programs/bash.nix>
programs.bashmount.enable

Whether to enable bashmount.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/bashmount.nix> @@ -2516,33 +2131,20 @@ for explanation about possible values.
programs.bat.enable

Whether to enable bat, a cat clone with wings.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/bat.nix>
programs.bat.config

Bat configuration. -

Type: attribute set of (string or list of string)

Default: - { - - } -

Example: - { - map-syntax = - [ - "*.jenkinsfile:Groovy" "*.props:Java Properties" - ] - ; pager = "less -FR"; theme = "TwoDark"; - } -

Declared by:

+

Type: attribute set of (string or list of string)

Default: { }

Example:

{
+  map-syntax = [
+    "*.jenkinsfile:Groovy"
+    "*.props:Java Properties"
+  ];
+  pager = "less -FR";
+  theme = "TwoDark";
+}

Declared by:

<home-manager/modules/programs/bat.nix>
programs.bat.extraPackages

Additional bat packages to install. -

Type: list of package

Default: - [ - - ] -

Example: with pkgs.bat-extras; [ batdiff batman batgrep batwatch ];

Declared by:

+

Type: list of package

Default: [ ]

Example: with pkgs.bat-extras; [ batdiff batman batgrep batwatch ];

Declared by:

<home-manager/modules/programs/bat.nix>
programs.bat.themes

Additional themes to provide. -

Type: attribute set of strings concatenated with "\n"

Default: - { - - } -

Example:

{
+

Type: attribute set of strings concatenated with "\n"

Default: { }

Example:

{
   dracula = builtins.readFile (pkgs.fetchFromGitHub {
     owner = "dracula";
     repo = "sublime"; # Bat uses sublime syntax for its themes
@@ -2564,11 +2166,7 @@ Can be used to specify extensions.
                     <home-manager/modules/programs/beets.nix>
                 
programs.beets.settings

Configuration written to $XDG_CONFIG_HOME/beets/config.yaml -

Type: YAML value

Default: - { - - } -

Declared by:

+

Type: YAML value

Default: { }

Declared by:

<home-manager/modules/programs/beets.nix>
programs.borgmatic.enable

Whether to enable Borgmatic.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/borgmatic.nix> @@ -2592,11 +2190,7 @@ each with its own source directories and repositories. };

Declared by:

<home-manager/modules/programs/borgmatic.nix> -
programs.borgmatic.backups.<name>.consistency.checks

Consistency checks to run

Type: list of (submodule)

Default: - [ - - ] -

Example:

[
+                
programs.borgmatic.backups.<name>.consistency.checks

Consistency checks to run

Type: list of (submodule)

Default: [ ]

Example:

[
   {
     name = "repository";
     frequency = "2 weeks";
@@ -2620,27 +2214,15 @@ each with its own source directories and repositories.
                     <home-manager/modules/programs/borgmatic.nix>
                 
programs.borgmatic.backups.<name>.consistency.checks.*.name

Name of consistency check to run.

Type: one of "repository", "archives", "data", "extract"

Example: "repository"

Declared by:

<home-manager/modules/programs/borgmatic.nix> -
programs.borgmatic.backups.<name>.consistency.extraConfig

Extra settings.

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

Default: - { - - } -

Declared by:

+
programs.borgmatic.backups.<name>.consistency.extraConfig

Extra settings.

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

Default: { }

Declared by:

<home-manager/modules/programs/borgmatic.nix> -
programs.borgmatic.backups.<name>.location.extraConfig

Extra settings.

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

Default: - { - - } -

Declared by:

+
programs.borgmatic.backups.<name>.location.extraConfig

Extra settings.

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

Default: { }

Declared by:

<home-manager/modules/programs/borgmatic.nix>
programs.borgmatic.backups.<name>.location.repositories

Paths to repositories.

Type: list of string

Example: ["ssh://myuser@myrepo.myserver.com/./repo"]

Declared by:

<home-manager/modules/programs/borgmatic.nix>
programs.borgmatic.backups.<name>.location.sourceDirectories

Directories to backup.

Type: list of string

Example: [config.home.homeDirectory]

Declared by:

<home-manager/modules/programs/borgmatic.nix> -
programs.borgmatic.backups.<name>.retention.extraConfig

Extra settings.

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

Default: - { - - } -

Declared by:

+
programs.borgmatic.backups.<name>.retention.extraConfig

Extra settings.

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

Default: { }

Declared by:

<home-manager/modules/programs/borgmatic.nix>
programs.borgmatic.backups.<name>.retention.keepDaily

Number of daily archives to keep. Use -1 for no limit.

Type: null or signed integer

Default: null

Example: 3

Declared by:

<home-manager/modules/programs/borgmatic.nix> @@ -2660,11 +2242,7 @@ each with its own source directories and repositories. <home-manager/modules/programs/borgmatic.nix>
programs.borgmatic.backups.<name>.storage.encryptionPasscommand

Command writing the passphrase to standard output.

Type: null or string

Default: null

Example: "${pkgs.password-store}/bin/pass borg-repo"

Declared by:

<home-manager/modules/programs/borgmatic.nix> -
programs.borgmatic.backups.<name>.storage.extraConfig

Extra settings.

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

Default: - { - - } -

Declared by:

+
programs.borgmatic.backups.<name>.storage.extraConfig

Extra settings.

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

Default: { }

Declared by:

<home-manager/modules/programs/borgmatic.nix>
programs.bottom.enable

Whether to enable bottom, a cross-platform graphical process/system monitor with a customizable interface.

Type: boolean

Default: false

Example: true

Declared by:

@@ -2677,11 +2255,7 @@ customizable interface.

Type: boole

See https://github.com/ClementTsang/bottom/blob/master/sample_configs/default_config.toml for the default configuration. -

Type: TOML value

Default: - { - - } -

Example:

{
+

Type: TOML value

Default: { }

Example:

{
   flags = {
     avg_cpu = true;
     temperature_type = "c";
@@ -2706,11 +2280,7 @@ for the default configuration.
                     <home-manager/modules/programs/broot.nix>
                 
programs.broot.package

Package providing broot

Type: package

Default: pkgs.broot

Declared by:

<home-manager/modules/programs/broot.nix> -
programs.broot.settings

Verbatim config entries

Type: TOML value

Default: - { - - } -

Declared by:

+
programs.broot.settings

Verbatim config entries

Type: TOML value

Default: { }

Declared by:

<home-manager/modules/programs/broot.nix>
programs.broot.settings.modal

Whether to enable modal (vim) mode.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/broot.nix> @@ -2721,11 +2291,7 @@ Complete list of keys (expected to change before the v1 of broot):

  • char_match

  • code

  • directory

  • exe

  • file

  • file_error

  • flag_label

  • flag_value

  • input

  • link

  • permissions

  • selected_line

  • size_bar_full

  • size_bar_void

  • size_text

  • spinner

  • status_error

  • status_normal

  • table_border

  • tree

  • unlisted

Add _fg for a foreground color and _bg for a background colors. -

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   status_normal_fg = "grayscale(18)";
   status_normal_bg = "grayscale(3)";
   status_error_fg = "red";
@@ -2753,11 +2319,7 @@ The possible attributes are:
     (default: true)

from_shell (optional)

whether the verb must be executed from the parent shell (default: false)

-

Type: list of attribute set of (boolean or string)

Default: - [ - - ] -

Example:

[
+

Type: list of attribute set of (boolean or string)

Default: [ ]

Example:

[
   { invocation = "p"; execution = ":parent"; }
   { invocation = "edit"; shortcut = "e"; execution = "$EDITOR {file}" ; }
   { invocation = "create {subpath}"; execution = "$EDITOR {directory}/{subpath}"; }
@@ -2772,15 +2334,15 @@ The possible attributes are:
                     <home-manager/modules/programs/broot.nix>
                 
programs.browserpass.enable

Whether to enable the browserpass extension host application.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/browserpass.nix> -
programs.browserpass.browsers

Which browsers to install browserpass for

Type: list of (one of "brave", "chrome", "chromium", "firefox", "vivaldi")

Default: - [ - "brave" "chrome" "chromium" "firefox" "vivaldi" - ] -

Example: - [ - "firefox" - ] -

Declared by:

+
programs.browserpass.browsers

Which browsers to install browserpass for

Type: list of (one of "brave", "chrome", "chromium", "firefox", "vivaldi")

Default:

[
+  "brave"
+  "chrome"
+  "chromium"
+  "firefox"
+  "vivaldi"
+]

Example:

[
+  "firefox"
+]

Declared by:

<home-manager/modules/programs/browserpass.nix>
programs.btop.enable

Whether to enable btop.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/btop.nix> @@ -2792,15 +2354,10 @@ The possible attributes are:
programs.btop.settings

Options to add to btop.conf file. See https://github.com/aristocratos/btop#configurability for options. -

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

Default: - { - - } -

Example: - { - color_theme = "Default"; theme_background = false; - } -

Declared by:

+

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

Default: { }

Example:

{
+  color_theme = "Default";
+  theme_background = false;
+}

Declared by:

<home-manager/modules/programs/btop.nix>
programs.chromium.enable

Whether to enable Chromium.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/chromium.nix> @@ -2816,15 +2373,10 @@ For a list of common switches, see

To search switches for other components, see Chromium codesearch. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "--enable-logging=stderr" "--ignore-gpu-blocklist" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "--enable-logging=stderr"
+  "--ignore-gpu-blocklist"
+]

Declared by:

<home-manager/modules/programs/chromium.nix>
programs.chromium.extensions

List of Chromium extensions to install. To find the extension ID, check its URL on the @@ -2835,11 +2387,7 @@ To install extensions outside of the Chrome Web Store set version as explained in the Chrome documentation. -

Type: list of ((submodule) or string convertible to it)

Default: - [ - - ] -

Example:

[
+

Type: list of ((submodule) or string convertible to it)

Default: [ ]

Example:

[
   { id = "cjpalhdlnbpafiamejdnhcphjbkeiagm"; } # ublock origin
   {
     id = "dcpihecpambacapedldabdbpakmachpb";
@@ -2891,11 +2439,7 @@ and set LS_COLORS.
                 
programs.dircolors.settings

Options to add to .dir_colors file. See dircolors --print-database for options. -

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   OTHER_WRITABLE = "30;46";
   ".sh" = "01;32";
   ".csh" = "01;32";
@@ -2925,11 +2469,7 @@ to the system configuration.
 See
 direnv.toml(1).
 for the full list of options.
-

Type: TOML value

Default: - { - - } -

Declared by:

+

Type: TOML value

Default: { }

Declared by:

<home-manager/modules/programs/direnv.nix>
programs.direnv.nix-direnv.enable

Whether to enable nix-direnv, a fast, persistent use_nix implementation for direnv.

Type: boolean

Default: false

Example: true

Declared by:

@@ -2957,17 +2497,9 @@ necessary to use the Lombok class annotations.
programs.eclipse.package

The Eclipse package to install.

Type: package

Default: pkgs.eclipses.eclipse-platform

Example: pkgs.eclipses.eclipse-java

Declared by:

<home-manager/modules/programs/eclipse.nix> -
programs.eclipse.jvmArgs

JVM arguments to use for the Eclipse process.

Type: list of string

Default: - [ - - ] -

Declared by:

+
programs.eclipse.jvmArgs

JVM arguments to use for the Eclipse process.

Type: list of string

Default: [ ]

Declared by:

<home-manager/modules/programs/eclipse.nix> -
programs.eclipse.plugins

Plugins that should be added to Eclipse.

Type: list of package

Default: - [ - - ] -

Declared by:

+
programs.eclipse.plugins

Plugins that should be added to Eclipse.

Type: list of package

Default: [ ]

Declared by:

<home-manager/modules/programs/eclipse.nix>
programs.emacs.enable

Whether to enable Emacs.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/emacs.nix> @@ -2981,7 +2513,7 @@ Note, the inhibit-startup-message Emacs option cannot be set here since Emacs disallows setting it from the default initialization file.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-(setq standard-indent 2)
+  (setq standard-indent 2)
 ''

Declared by:

<home-manager/modules/programs/emacs.nix>
programs.emacs.extraPackages

Extra packages available to Emacs. To get a list of @@ -3018,38 +2550,28 @@ action, set its value to null. If you want to bind multiple buttons to an action, set its value to a list. See https://man.finalrewind.org/1/feh/#x425554544f4e53 for default bindings and available commands. -

Type: attribute set of (null or string or signed integer or list of (string or signed integer))

Default: - { - - } -

Example: - { - prev_img = - [ - 3 "C-3" - ] - ; zoom_in = 4; zoom_out = "C-4"; - } -

Declared by:

+

Type: attribute set of (null or string or signed integer or list of (string or signed integer))

Default: { }

Example:

{
+  prev_img = [
+    3
+    "C-3"
+  ];
+  zoom_in = 4;
+  zoom_out = "C-4";
+}

Declared by:

<home-manager/modules/programs/feh.nix>
programs.feh.keybindings

Override feh's default keybindings. If you want to disable a keybinding set its value to null. If you want to bind multiple keys to an action, set its value to a list. See https://man.finalrewind.org/1/feh/#x4b455953 for default bindings and available commands. -

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

Default: - { - - } -

Example: - { - prev_img = - [ - "h" "Left" - ] - ; zoom_in = "plus"; zoom_out = "minus"; - } -

Declared by:

+

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

Default: { }

Example:

{
+  prev_img = [
+    "h"
+    "Left"
+  ];
+  zoom_in = "plus";
+  zoom_out = "minus";
+}

Declared by:

<home-manager/modules/programs/feh.nix>
programs.firefox.enable

Whether to enable Firefox.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/firefox.nix> @@ -3096,29 +2618,17 @@ profiles managed through the programs.firefox.profiles option. This is due to recent changes in the way Firefox handles extension side-loading. -

Type: list of package

Default: - [ - - ] -

Example:

with pkgs.nur.repos.rycee.firefox-addons; [
+

Type: list of package

Default: [ ]

Example:

with pkgs.nur.repos.rycee.firefox-addons; [
   https-everywhere
   privacy-badger
 ]
 

Declared by:

<home-manager/modules/programs/firefox.nix> -
programs.firefox.profiles

Attribute set of Firefox profiles.

Type: attribute set of (submodule)

Default: - { - - } -

Declared by:

+
programs.firefox.profiles

Attribute set of Firefox profiles.

Type: attribute set of (submodule)

Default: { }

Declared by:

<home-manager/modules/programs/firefox.nix>
programs.firefox.profiles.<name>.bookmarks

Preloaded bookmarks. Note, this may silently overwrite any previously existing bookmarks! -

Type: (list of ((bookmark submodule) or (directory submodule))) or (attribute set of ((bookmark submodule) or (directory submodule))) convertible to it

Default: - [ - - ] -

Example:

[
+

Type: (list of ((bookmark submodule) or (directory submodule))) or (attribute set of ((bookmark submodule) or (directory submodule))) convertible to it

Default: [ ]

Example:

[
   {
     name = "wikipedia";
     keyword = "wiki";
@@ -3172,11 +2682,7 @@ future options.
 Note, icon is also a special option
 added by Home Manager to make it convenient to specify
 absolute icon paths.
-

Type: attribute set of attribute set of (JSON value)

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute set of (JSON value)

Default: { }

Example:

{
   "Nix Packages" = {
     urls = [{
       template = "https://search.nixos.org/packages";
@@ -3212,21 +2718,12 @@ configuration by enabling this.
                 
programs.firefox.profiles.<name>.search.order

The order the search engines are listed in. Any engines that aren't included in this list will be listed after these in an unspecified order. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "DuckDuckGo" "Google" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "DuckDuckGo"
+  "Google"
+]

Declared by:

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

Attribute set of Firefox preferences.

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

Default: - { - - } -

Example:

{
+                
programs.firefox.profiles.<name>.settings

Attribute set of Firefox preferences.

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

Default: { }

Example:

{
   "browser.startup.homepage" = "https://nixos.org";
   "browser.search.region" = "GB";
   "browser.search.isUS" = false;
@@ -3237,22 +2734,22 @@ these in an unspecified order.
 

Declared by:

<home-manager/modules/programs/firefox.nix>
programs.firefox.profiles.<name>.userChrome

Custom Firefox user chrome CSS.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-/* Hide tab bar in FF Quantum */
-@-moz-document url("chrome://browser/content/browser.xul") {
-  #TabsToolbar {
-    visibility: collapse !important;
-    margin-bottom: 21px !important;
+  /* Hide tab bar in FF Quantum */
+  @-moz-document url("chrome://browser/content/browser.xul") {
+    #TabsToolbar {
+      visibility: collapse !important;
+      margin-bottom: 21px !important;
+    }
+  
+    #sidebar-box[sidebarcommand="treestyletab_piro_sakura_ne_jp-sidebar-action"] #sidebar-header {
+      visibility: collapse !important;
+    }
   }
-
-  #sidebar-box[sidebarcommand="treestyletab_piro_sakura_ne_jp-sidebar-action"] #sidebar-header {
-    visibility: collapse !important;
-  }
-}
 ''

Declared by:

<home-manager/modules/programs/firefox.nix>
programs.firefox.profiles.<name>.userContent

Custom Firefox user content CSS.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-/* Hide scrollbar in FF Quantum */
-*{scrollbar-width:none !important}
+  /* Hide scrollbar in FF Quantum */
+  *{scrollbar-width:none !important}
 ''

Declared by:

<home-manager/modules/programs/firefox.nix>
programs.fish.enable

Whether to enable fish, the friendly interactive shell.

Type: boolean

Default: false

Example: true

Declared by:

@@ -3262,11 +2759,7 @@ these in an unspecified order. <home-manager/modules/programs/fish.nix>
programs.fish.functions

Basic functions to add to fish. For more information see https://fishshell.com/docs/current/cmds/function.html. -

Type: attribute set of (strings concatenated with "\n" or (submodule))

Default: - { - - } -

Example:

{
+

Type: attribute set of (strings concatenated with "\n" or (submodule))

Default: { }

Example:

{
   __fish_command_not_found_handler = {
     body = "__fish_default_command_not_found_handler $argv[1]";
     onEvent = "fish_command_not_found";
@@ -3286,11 +2779,7 @@ initialisation.
                     <home-manager/modules/programs/fish.nix>
                 
programs.fish.plugins

The plugins to source in conf.d/99plugins.fish. -

Type: list of (submodule)

Default: - [ - - ] -

Example:

[
+

Type: list of (submodule)

Default: [ ]

Example:

[
   {
     name = "z";
     src = pkgs.fetchFromGitHub {
@@ -3329,23 +2818,14 @@ they exist.
                 
programs.fish.shellAbbrs

An attribute set that maps aliases (the top level attribute names in this option) to abbreviations. Abbreviations are expanded with the longer phrase after they are entered. -

Type: attribute set of string

Default: - { - - } -

Example: - { - gco = "git checkout"; l = "less"; - } -

Declared by:

+

Type: attribute set of string

Default: { }

Example:

{
+  gco = "git checkout";
+  l = "less";
+}

Declared by:

<home-manager/modules/programs/fish.nix>
programs.fish.shellAliases

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

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   g = "git";
   "..." = "cd ../..";
 }
@@ -3364,11 +2844,7 @@ initialisation.
                 
programs.foot.settings

Configuration written to $XDG_CONFIG_HOME/foot/foot.ini. See https://codeberg.org/dnkl/foot/src/branch/master/foot.ini for a list of available options. -

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: { }

Example:

{
   main = {
     term = "xterm-256color";
 
@@ -3400,24 +2876,14 @@ ALT-C keybinding.
 

Type: null or string

Default: null

Example: "fd --type d"

Declared by:

<home-manager/modules/programs/fzf.nix>
programs.fzf.changeDirWidgetOptions

Command line options for the ALT-C keybinding. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "--preview 'tree -C {} | head -200'" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "--preview 'tree -C {} | head -200'"
+]

Declared by:

<home-manager/modules/programs/fzf.nix>
programs.fzf.colors

Color scheme options added to FZF_DEFAULT_OPTS. See https://github.com/junegunn/fzf/wiki/Color-schemes for documentation. -

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   bg = "#1e1e1e";
   "bg+" = "#1e1e1e";
   fg = "#d4d4d4";
@@ -3430,41 +2896,25 @@ when running.
 

Type: null or string

Default: null

Example: "fd --type f"

Declared by:

<home-manager/modules/programs/fzf.nix>
programs.fzf.defaultOptions

Extra command line options given to fzf by default. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "--height 40%" "--border" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "--height 40%"
+  "--border"
+]

Declared by:

<home-manager/modules/programs/fzf.nix>
programs.fzf.fileWidgetCommand

The command that gets executed as the source for fzf for the CTRL-T keybinding.

Type: null or string

Default: null

Example: "fd --type f"

Declared by:

<home-manager/modules/programs/fzf.nix>
programs.fzf.fileWidgetOptions

Command line options for the CTRL-T keybinding. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "--preview 'head {}'" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "--preview 'head {}'"
+]

Declared by:

<home-manager/modules/programs/fzf.nix>
programs.fzf.historyWidgetOptions

Command line options for the CTRL-R keybinding. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "--sort" "--exact" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "--sort"
+  "--exact"
+]

Declared by:

<home-manager/modules/programs/fzf.nix>
programs.fzf.tmux.enableShellIntegration

Whether to enable setting FZF_TMUX=1 which causes shell integration to use fzf-tmux .

Type: boolean

Default: false

Example: true

Declared by:

@@ -3472,11 +2922,7 @@ CTRL-T keybinding.
programs.fzf.tmux.shellIntegrationOptions

If programs.fzf.tmux.enableShellIntegration is set to true, shell integration will use these options for fzf-tmux. See fzf-tmux --help for available options. -

Type: list of string

Default: - [ - - ] -

Example: [ "-d 40%" ]

Declared by:

+

Type: list of string

Default: [ ]

Example: [ "-d 40%" ]

Declared by:

<home-manager/modules/programs/fzf.nix>
programs.gallery-dl.enable

Whether to enable gallery-dl.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/gallery-dl.nix> @@ -3484,11 +2930,7 @@ See fzf-tmux --help for available $XDG_CONFIG_HOME/gallery-dl/config.json. See https://github.com/mikf/gallery-dl#configuration for supported values. -

Type: JSON value

Default: - { - - } -

Example:

{
+

Type: JSON value

Default: { }

Example:

{
   extractor.base-directory = "~/Downloads";
 }
 

Declared by:

@@ -3500,17 +2942,9 @@ for supported values.
programs.gh.package

Package providing gh.

Type: package

Default: pkgs.gh

Declared by:

<home-manager/modules/programs/gh.nix>
programs.gh.extensions

gh extensions, see https://cli.github.com/manual/gh_extension. -

Type: list of package

Default: - [ - - ] -

Example: [ pkgs.gh-eco ]

Declared by:

+

Type: list of package

Default: [ ]

Example: [ pkgs.gh-eco ]

Declared by:

<home-manager/modules/programs/gh.nix> -
programs.gh.settings

Configuration written to $XDG_CONFIG_HOME/gh/config.yml.

Type: YAML value

Default: - { - - } -

Example:

{
+                
programs.gh.settings

Configuration written to $XDG_CONFIG_HOME/gh/config.yml.

Type: YAML value

Default: { }

Example:

{
   git_protocol = "ssh";
 
   prompt = "enabled";
@@ -3523,11 +2957,7 @@ for supported values.
 

Declared by:

<home-manager/modules/programs/gh.nix>
programs.gh.settings.aliases

Aliases that allow you to create nicknames for gh commands. -

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   co = "pr checkout";
   pv = "pr view";
 }
@@ -3546,44 +2976,28 @@ If blank, will refer to environment.
 to gain access to git send-email for instance.
 

Type: package

Default: pkgs.git

Declared by:

<home-manager/modules/programs/git.nix> -
programs.git.aliases

Git aliases to define.

Type: attribute set of string

Default: - { - - } -

Example: - { - co = "checkout"; - } -

Declared by:

+
programs.git.aliases

Git aliases to define.

Type: attribute set of string

Default: { }

Example:

{
+  co = "checkout";
+}

Declared by:

<home-manager/modules/programs/git.nix> -
programs.git.attributes

List of defining attributes set globally.

Type: list of string

Default: - [ - - ] -

Example: - [ - "*.pdf diff=pdf" - ] -

Declared by:

+
programs.git.attributes

List of defining attributes set globally.

Type: list of string

Default: [ ]

Example:

[
+  "*.pdf diff=pdf"
+]

Declared by:

<home-manager/modules/programs/git.nix>
programs.git.delta.enable

Whether to enable the delta syntax highlighter. See https://github.com/dandavison/delta.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/git.nix>
programs.git.delta.options

Options to configure delta. -

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

Default: - { - - } -

Example: - { - decorations = - { - commit-decoration-style = "bold yellow box ul"; file-decoration-style = "none"; file-style = "bold yellow ul"; - } - ; features = "decorations"; whitespace-error-style = "22 reverse"; - } -

Declared by:

+

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

Default: { }

Example:

{
+  decorations = {
+    commit-decoration-style = "bold yellow box ul";
+    file-decoration-style = "none";
+    file-style = "bold yellow ul";
+  };
+  features = "decorations";
+  whitespace-error-style = "22 reverse";
+}

Declared by:

<home-manager/modules/programs/git.nix>
programs.git.diff-so-fancy.enable

Enable the diff-so-fancy diff colorizer. See https://github.com/so-fancy/diff-so-fancy. @@ -3625,55 +3039,31 @@ for syntax highlighting. <home-manager/modules/programs/git.nix>

programs.git.extraConfig

Additional configuration to add. The use of string values is deprecated and will be removed in the future. -

Type: strings concatenated with "\n" or attribute set of attribute set of (string or boolean or signed integer or list of (string or boolean or signed integer) or attribute set of (string or boolean or signed integer or list of (string or boolean or signed integer)))

Default: - { - - } -

Example: - { - core = - { - whitespace = "trailing-space,space-before-tab"; - } - ; url = - { - ssh://git@host = - { - insteadOf = "otherhost"; - } - ; - } - ; - } -

Declared by:

+

Type: strings concatenated with "\n" or attribute set of attribute set of (string or boolean or signed integer or list of (string or boolean or signed integer) or attribute set of (string or boolean or signed integer or list of (string or boolean or signed integer)))

Default: { }

Example:

{
+  core = {
+    whitespace = "trailing-space,space-before-tab";
+  };
+  url = {
+    "ssh://git@host" = {
+      insteadOf = "otherhost";
+    };
+  };
+}

Declared by:

<home-manager/modules/programs/git.nix>
programs.git.hooks

Configuration helper for Git hooks. See https://git-scm.com/docs/githooks for reference. -

Type: attribute set of path

Default: - { - - } -

Example:

{
+

Type: attribute set of path

Default: { }

Example:

{
   pre-commit = ./pre-commit-script;
 }
 

Declared by:

<home-manager/modules/programs/git.nix> -
programs.git.ignores

List of paths that should be globally ignored.

Type: list of string

Default: - [ - - ] -

Example: - [ - "*~" "*.swp" - ] -

Declared by:

+
programs.git.ignores

List of paths that should be globally ignored.

Type: list of string

Default: [ ]

Example:

[
+  "*~"
+  "*.swp"
+]

Declared by:

<home-manager/modules/programs/git.nix> -
programs.git.includes

List of configuration files to include.

Type: list of (submodule)

Default: - [ - - ] -

Example:

[
+                
programs.git.includes

List of configuration files to include.

Type: list of (submodule)

Default: [ ]

Example:

[
   { path = "~/path/to/config.inc"; }
   {
     path = "~/path/to/conditional.inc";
@@ -3695,11 +3085,7 @@ when generating the configuration text from nix options.
 
 This follows the configuration structure as described in
 git-config(1).
-

Type: attribute set of anything

Default: - { - - } -

Example:

{
+

Type: attribute set of anything

Default: { }

Example:

{
   user = {
     email = "bob@work.example.com";
     name = "Bob Work";
@@ -3743,42 +3129,38 @@ to use depending on commit’s author.
                 
programs.gitui.keyConfig

Key config in Ron file format. This is written to $XDG_CONFIG_HOME/gitui/key_config.ron.

Type: path or strings concatenated with "\n"

Default: ""

Example:

''
-exit: Some(( code: Char('c'), modifiers: ( bits: 2,),)),
-quit: Some(( code: Char('q'), modifiers: ( bits: 0,),)),
-exit_popup: Some(( code: Esc, modifiers: ( bits: 0,),)),
+  exit: Some(( code: Char('c'), modifiers: ( bits: 2,),)),
+  quit: Some(( code: Char('q'), modifiers: ( bits: 0,),)),
+  exit_popup: Some(( code: Esc, modifiers: ( bits: 0,),)),
 ''

Declared by:

<home-manager/modules/programs/gitui.nix>
programs.gitui.theme

Theme in Ron file format. This is written to $XDG_CONFIG_HOME/gitui/theme.ron.

Type: path or strings concatenated with "\n"

Default:

''
-(
-  selected_tab: Reset,
-  command_fg: White,
-  selection_bg: Blue,
-  cmdbar_extra_lines_bg: Blue,
-  disabled_fg: DarkGray,
-  diff_line_add: Green,
-  diff_line_delete: Red,
-  diff_file_added: LightGreen,
-  diff_file_removed: LightRed,
-  diff_file_moved: LightMagenta,
-  diff_file_modified: Yellow,
-  commit_hash: Magenta,
-  commit_time: LightCyan,
-  commit_author: Green,
-  danger_fg: Red,
-  push_gauge_bg: Blue,
-  push_gauge_fg: Reset,
-)
+  (
+    selected_tab: Reset,
+    command_fg: White,
+    selection_bg: Blue,
+    cmdbar_extra_lines_bg: Blue,
+    disabled_fg: DarkGray,
+    diff_line_add: Green,
+    diff_line_delete: Red,
+    diff_file_added: LightGreen,
+    diff_file_removed: LightRed,
+    diff_file_moved: LightMagenta,
+    diff_file_modified: Yellow,
+    commit_hash: Magenta,
+    commit_time: LightCyan,
+    commit_author: Green,
+    danger_fg: Red,
+    push_gauge_bg: Blue,
+    push_gauge_fg: Reset,
+  )
 ''

Declared by:

<home-manager/modules/programs/gitui.nix>
programs.gnome-terminal.enable

Whether to enable Gnome Terminal.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/gnome-terminal.nix> -
programs.gnome-terminal.profile

A set of Gnome Terminal profiles.

Type: attribute set of (submodule)

Default: - { - - } -

Declared by:

+
programs.gnome-terminal.profile

A set of Gnome Terminal profiles.

Type: attribute set of (submodule)

Default: { }

Declared by:

<home-manager/modules/programs/gnome-terminal.nix>
programs.gnome-terminal.profile.<name>.allowBold

If true, allow applications in the terminal to make text boldface. @@ -3874,11 +3256,7 @@ presses the Delete key. <home-manager/modules/programs/go.nix>

programs.go.package

The Go package to use.

Type: package

Default: pkgs.go

Declared by:

<home-manager/modules/programs/go.nix> -
programs.go.packages

Packages to add to GOPATH.

Type: attribute set of path

Default: - { - - } -

Example:

{
+                
programs.go.packages

Packages to add to GOPATH.

Type: attribute set of path

Default: { }

Example:

{
   "golang.org/x/text" = builtins.fetchGit "https://go.googlesource.com/text";
   "golang.org/x/time" = builtins.fetchGit "https://go.googlesource.com/time";
 }
@@ -3886,15 +3264,10 @@ presses the Delete key.
                     <home-manager/modules/programs/go.nix>
                 
programs.go.extraGoPaths

Extra GOPATHs relative to HOME appended after programs.go.goPath, if that option is set. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "extraGoPath1" "extraGoPath2" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "extraGoPath1"
+  "extraGoPath2"
+]

Declared by:

<home-manager/modules/programs/go.nix>
programs.go.goBin

GOBIN relative to HOME

Type: null or string

Default: null

Example: ".local/bin.go"

Declared by:

<home-manager/modules/programs/go.nix> @@ -3907,15 +3280,10 @@ used by default by the Go tooling. which modules the go command considers to be private (not available publicly) and should therefore not use the proxy or checksum database. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "*.corp.example.com" "rsc.io/private" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "*.corp.example.com"
+  "rsc.io/private"
+]

Declared by:

<home-manager/modules/programs/go.nix>
programs.gpg.enable

Whether to enable GnuPG.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/gpg.nix> @@ -3945,11 +3313,7 @@ any unmanaged keys. Be careful to make a backup of your old <home-manager/modules/programs/gpg.nix>
programs.gpg.publicKeys

A list of public keys to be imported into GnuPG. Note, these key files will be copied into the world-readable Nix store. -

Type: list of (submodule)

Default: - [ - - ] -

Example:

[ { source = ./pubkeys.txt; } ]
+

Type: list of (submodule)

Default: [ ]

Example:

[ { source = ./pubkeys.txt; } ]
 

Declared by:

<home-manager/modules/programs/gpg.nix>
programs.gpg.publicKeys.*.source

Path of an OpenPGP public key file. @@ -3992,11 +3356,7 @@ Note that lists are converted to duplicate keys.

programs.havoc.settings

Configuration written to $XDG_CONFIG_HOME/havoc.cfg. See https://raw.githubusercontent.com/ii8/havoc/master/havoc.cfg for a list of available options. -

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: { }

Example:

{
   child.program = "bash";
   window.opacity = 240;
   window.margin = no;
@@ -4029,30 +3389,19 @@ for a list of available options.
 

See https://docs.helix-editor.com/languages.html for more information. -

Type: list of (TOML value)

Default: - [ - - ] -

Example: - [ - - { - auto-format = false; name = "rust"; - } - - ] -

Declared by:

+

Type: list of (TOML value)

Default: [ ]

Example:

[
+  {
+    auto-format = false;
+    name = "rust";
+  }
+]

Declared by:

<home-manager/modules/programs/helix.nix>
programs.helix.settings

Configuration written to $XDG_CONFIG_HOME/helix/config.toml.

See https://docs.helix-editor.com/configuration.html for the full list of options. -

Type: TOML value

Default: - { - - } -

Example:

{
+

Type: TOML value

Default: { }

Example:

{
   theme = "base16";
   lsp.display-messages = true;
   keys.normal = {
@@ -4069,11 +3418,7 @@ Where the name of each attribute is the theme-name (in the example "base16").
 

See https://docs.helix-editor.com/themes.html for the full list of options. -

Type: attribute set of (TOML value)

Default: - { - - } -

Example:

{
+

Type: attribute set of (TOML value)

Default: { }

Example:

{
   base16 = let
     transparent = "none";
     gray = "#665c54";
@@ -4133,11 +3478,7 @@ for the full list of options.
                 
programs.hexchat.enable

Whether to enable HexChat, a graphical IRC client.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/hexchat.nix>
programs.hexchat.channels

Configures $XDG_CONFIG_HOME/hexchat/servlist.conf. -

Type: attribute set of (submodule)

Default: - { - - } -

Example:

{
+

Type: attribute set of (submodule)

Default: { }

Example:

{
   oftc = {
     autojoin = [
       "#home-manager"
@@ -4167,23 +3508,15 @@ for the full list of options.
   };
 }

Declared by:

<home-manager/modules/programs/hexchat.nix> -
programs.hexchat.channels.<name>.autojoin

Channels list to autojoin on connecting to server.

Type: list of string

Default: - [ - - ] -

Example: - [ - "#home-manager" "#linux" "#nix" - ] -

Declared by:

+
programs.hexchat.channels.<name>.autojoin

Channels list to autojoin on connecting to server.

Type: list of string

Default: [ ]

Example:

[
+  "#home-manager"
+  "#linux"
+  "#nix"
+]

Declared by:

<home-manager/modules/programs/hexchat.nix>
programs.hexchat.channels.<name>.charset

Character set.

Type: null or string

Default: null

Example: "UTF-8 (Unicode)"

Declared by:

<home-manager/modules/programs/hexchat.nix> -
programs.hexchat.channels.<name>.commands

Commands to be executed on connecting to server.

Type: list of string

Default: - [ - - ] -

Example: [ "ECHO Greetings fellow Nixer! ]

Declared by:

+
programs.hexchat.channels.<name>.commands

Commands to be executed on connecting to server.

Type: list of string

Default: [ ]

Example: [ "ECHO Greetings fellow Nixer! ]

Declared by:

<home-manager/modules/programs/hexchat.nix>
programs.hexchat.channels.<name>.loginMethod

The login method. The allowed options are:

null

Default

"nickServMsg"

NickServ (/MSG NickServ + password)

"nickServ"

NickServ (/NICKSERV + password)

"challengeAuth"

Challenge Auth (username + password)

"sasl"

SASL (username + password)

"serverPassword"

Server password (/PASS password)

"saslExternal"

SASL EXTERNAL (cert)

"customCommands"

Use "commands" field for auth. For example @@ -4197,11 +3530,10 @@ commands = [ "/msg NickServ IDENTIFY my_password" ] <home-manager/modules/programs/hexchat.nix>

programs.hexchat.channels.<name>.nickname2

Secondary nickname.

Type: null or string

Default: null

Declared by:

<home-manager/modules/programs/hexchat.nix> -
programs.hexchat.channels.<name>.options

Channel options.

Type: null or (submodule)

Default: null

Example: - { - autoconnect = true; useGlobalUserInformation = true; - } -

Declared by:

+
programs.hexchat.channels.<name>.options

Channel options.

Type: null or (submodule)

Default: null

Example:

{
+  autoconnect = true;
+  useGlobalUserInformation = true;
+}

Declared by:

<home-manager/modules/programs/hexchat.nix>
programs.hexchat.channels.<name>.options.acceptInvalidSSLCertificates

Accept invalid SSL certificates.

Type: null or boolean

Default: false

Declared by:

<home-manager/modules/programs/hexchat.nix> @@ -4223,15 +3555,9 @@ in the Nix store. someone uses the WHOIS command on your nick.

Type: null or string

Default: null

Declared by:

<home-manager/modules/programs/hexchat.nix> -
programs.hexchat.channels.<name>.servers

IRC Server Address List.

Type: list of string

Default: - [ - - ] -

Example: - [ - "irc.oftc.net" - ] -

Declared by:

+
programs.hexchat.channels.<name>.servers

IRC Server Address List.

Type: list of string

Default: [ ]

Example:

[
+  "irc.oftc.net"
+]

Declared by:

<home-manager/modules/programs/hexchat.nix>
programs.hexchat.channels.<name>.userName

User name. Part of your user@host hostmask that appears to other on IRC. @@ -4281,11 +3607,7 @@ as seen in example.

Type: package

Default: pkgs.himalaya

Declared by:

<home-manager/modules/programs/himalaya.nix>
programs.himalaya.settings

Global himalaya configuration values. -

Type: TOML value

Default: - { - - } -

Example:

{
+

Type: TOML value

Default: { }

Example:

{
   email-listing-page-size = 50;
   watch-cmds = [ "mbsync -a" ]
 }
@@ -4306,11 +3628,7 @@ attempted.
                     <home-manager/modules/programs/htop.nix>
                 
programs.htop.settings

Configuration options to add to $XDG_CONFIG_HOME/htop/htoprc. -

Type: attribute set

Default: - { - - } -

Example:

{
+

Type: attribute set

Default: { }

Example:

{
   color_scheme = 6;
   cpu_count_from_one = 0;
   delay = 15;
@@ -4348,11 +3666,7 @@ attempted.
                     <home-manager/modules/programs/hyfetch.nix>
                 
programs.hyfetch.package

The hyfetch package to use.

Type: package

Default: pkgs.hyfetch

Declared by:

<home-manager/modules/programs/hyfetch.nix> -
programs.hyfetch.settings

JSON config for HyFetch

Type: JSON value

Default: - { - - } -

Example:

{
+                
programs.hyfetch.settings

JSON config for HyFetch

Type: JSON value

Default: { }

Example:

{
   preset = "rainbow";
   mode = "rgb";
   color_align = {
@@ -4374,11 +3688,7 @@ the default configuration.
 See
 i3status(1)
 for options.
-

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

Default: - { - - } -

Example:

{
+

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

Default: { }

Example:

{
   colors = true;
   color_good = "#e0e0e0";
   color_degraded = "#d7ae00";
@@ -4391,11 +3701,7 @@ for options.
 See
 i3status(1)
 for options.
-

Type: attribute set of (submodule)

Default: - { - - } -

Example:

{
+

Type: attribute set of (submodule)

Default: { }

Example:

{
   "volume master" = {
     position = 1;
     settings = {
@@ -4423,11 +3729,7 @@ for options.
 See
 i3status(1)
 for options.
-

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

Default: - { - - } -

Example:

{
+

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

Default: { }

Example:

{
   format = "♪ %volume";
   format_muted = "♪ muted (%volume)";
   device = "pulse:1";
@@ -4449,43 +3751,45 @@ top and a bottom bar.
 See
 i3status-rust(1)
 for options.
-

Type: attribute set of (submodule)

Default: - { - default = - { - blocks = - [ - - { - alert = ; alias = "/"; block = "disk_space"; info_type = "available"; interval = 60; path = "/"; unit = "GB"; warning = ; - } - - { - block = "memory"; display_type = "memory"; format_mem = "{mem_used_percents}"; format_swap = "{swap_used_percents}"; - } - - { - block = "cpu"; interval = 1; - } - - { - block = "load"; format = "{1m}"; interval = 1; - } - - { - block = "sound"; - } - - { - block = "time"; format = "%a %d/%m %R"; interval = 60; - } - - ] - ; - } - ; - } -

Example:

bottom = {
+

Type: attribute set of (submodule)

Default:

{
+  default = {
+    blocks = [
+      {
+        alert = 10.0;
+        alias = "/";
+        block = "disk_space";
+        info_type = "available";
+        interval = 60;
+        path = "/";
+        unit = "GB";
+        warning = 20.0;
+      }
+      {
+        block = "memory";
+        display_type = "memory";
+        format_mem = "{mem_used_percents}";
+        format_swap = "{swap_used_percents}";
+      }
+      {
+        block = "cpu";
+        interval = 1;
+      }
+      {
+        block = "load";
+        format = "{1m}";
+        interval = 1;
+      }
+      {
+        block = "sound";
+      }
+      {
+        block = "time";
+        format = "%a %d/%m %R";
+        interval = 60;
+      }
+    ];
+  };
+}

Example:

bottom = {
   blocks = [
     {
        block = "disk_space";
@@ -4537,35 +3841,41 @@ for options.
 config. See
 https://github.com/greshake/i3status-rust/blob/master/blocks.md
 for block options.
-

Type: TOML value

Default: - [ - - { - alert = ; alias = "/"; block = "disk_space"; info_type = "available"; interval = 60; path = "/"; unit = "GB"; warning = ; - } - - { - block = "memory"; display_type = "memory"; format_mem = "{mem_used_percents}"; format_swap = "{swap_used_percents}"; - } - - { - block = "cpu"; interval = 1; - } - - { - block = "load"; format = "{1m}"; interval = 1; - } - - { - block = "sound"; - } - - { - block = "time"; format = "%a %d/%m %R"; interval = 60; - } - - ] -

Example:

[
+

Type: TOML value

Default:

[
+  {
+    alert = 10.0;
+    alias = "/";
+    block = "disk_space";
+    info_type = "available";
+    interval = 60;
+    path = "/";
+    unit = "GB";
+    warning = 20.0;
+  }
+  {
+    block = "memory";
+    display_type = "memory";
+    format_mem = "{mem_used_percents}";
+    format_swap = "{swap_used_percents}";
+  }
+  {
+    block = "cpu";
+    interval = 1;
+  }
+  {
+    block = "load";
+    format = "{1m}";
+    interval = 1;
+  }
+  {
+    block = "sound";
+  }
+  {
+    block = "time";
+    format = "%a %d/%m %R";
+    interval = 60;
+  }
+]

Example:

[
   {
     block = "disk_space";
     path = "/";
@@ -4595,11 +3905,7 @@ for a list of available icon sets.
                     <home-manager/modules/programs/i3status-rust.nix>
                 
programs.i3status-rust.bars.<name>.settings

Any extra options to add to i3status-rust config. -

Type: TOML value

Default: - { - - } -

Example:

{
+

Type: TOML value

Default: { }

Example:

{
   theme =  {
     name = "solarized-dark";
     overrides = {
@@ -4627,34 +3933,21 @@ for a list of available themes.
                     <home-manager/modules/programs/ion.nix>
                 
programs.ion.shellAliases

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

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   g = "git";
 }
 

Declared by:

<home-manager/modules/programs/ion.nix>
programs.irssi.enable

Whether to enable the Irssi chat client.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/irssi.nix> -
programs.irssi.aliases

An attribute set that maps aliases to commands.

Type: attribute set of string

Default: - { - - } -

Example: - { - BYE = "quit"; J = "join"; - } -

Declared by:

+
programs.irssi.aliases

An attribute set that maps aliases to commands.

Type: attribute set of string

Default: { }

Example:

{
+  BYE = "quit";
+  J = "join";
+}

Declared by:

<home-manager/modules/programs/irssi.nix>
programs.irssi.extraConfig

These lines are appended to the Irssi configuration.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/programs/irssi.nix> -
programs.irssi.networks

An attribute set of chat networks.

Type: attribute set of (submodule)

Default: - { - - } -

Example:

{
+                
programs.irssi.networks

An attribute set of chat networks.

Type: attribute set of (submodule)

Default: { }

Example:

{
   liberachat = {
     nick = "hmuser";
     server = {
@@ -4669,17 +3962,9 @@ in this option) to command strings or directly to build outputs.
 }
 

Declared by:

<home-manager/modules/programs/irssi.nix> -
programs.irssi.networks.<name>.autoCommands

List of commands to execute on connect.

Type: list of string

Default: - [ - - ] -

Declared by:

+
programs.irssi.networks.<name>.autoCommands

List of commands to execute on connect.

Type: list of string

Default: [ ]

Declared by:

<home-manager/modules/programs/irssi.nix> -
programs.irssi.networks.<name>.channels

Channels for the given network.

Type: attribute set of (submodule)

Default: - { - - } -

Declared by:

+
programs.irssi.networks.<name>.channels

Channels for the given network.

Type: attribute set of (submodule)

Default: { }

Declared by:

<home-manager/modules/programs/irssi.nix>
programs.irssi.networks.<name>.channels.<name>.autoJoin

Whether to join this channel on connect.

Type: boolean

Default: false

Declared by:

<home-manager/modules/programs/irssi.nix> @@ -4718,11 +4003,15 @@ variable.
programs.jq.package

jq package to use.

Type: package

Default: pkgs.jq

Declared by:

<home-manager/modules/programs/jq.nix>
programs.jq.colors

The colors used in colored JSON output.

See https://stedolan.github.io/jq/manual/#Colors. -

Type: submodule

Default: - { - arrays = "1;37"; false = "0;37"; null = "1;30"; numbers = "0;37"; objects = "1;37"; strings = "0;32"; true = "0;37"; - } -

Example:

{
+

Type: submodule

Default:

{
+  arrays = "1;37";
+  false = "0;37";
+  null = "1;30";
+  numbers = "0;37";
+  objects = "1;37";
+  strings = "0;32";
+  true = "0;37";
+}

Example:

{
   null    = "1;30";
   false   = "0;31";
   true    = "0;32";
@@ -4741,11 +4030,7 @@ variable.
 $XDG_CONFIG_HOME/k9s/config.yml. See
 https://k9scli.io/topics/config/
 for supported values.
-

Type: YAML value

Default: - { - - } -

Example:

k9s = {
+

Type: YAML value

Default: { }

Example:

k9s = {
   refreshRate = 2;
 };
 

Declared by:

@@ -4754,11 +4039,7 @@ for supported values. $XDG_CONFIG_HOME/k9s/skin.yml. See https://k9scli.io/topics/skins/ for supported values. -

Type: YAML value

Default: - { - - } -

Example:

k9s = {
+

Type: YAML value

Default: { }

Example:

k9s = {
   body = {
     fgColor = "dodgerblue";
   };
@@ -4769,11 +4050,7 @@ for supported values.
                     <home-manager/modules/programs/kakoune.nix>
                 
programs.kakoune.package

Type: package

Default: pkgs.kakoune-unwrapped

Declared by:

<home-manager/modules/programs/kakoune.nix> -
programs.kakoune.config

kakoune configuration options.

Type: null or (submodule)

Default: - { - - } -

Declared by:

+
programs.kakoune.config

kakoune configuration options.

Type: null or (submodule)

Default: { }

Declared by:

<home-manager/modules/programs/kakoune.nix>
programs.kakoune.config.alignWithTabs

Use tabs for the align command.

Type: boolean

Default: false

Declared by:

@@ -4784,11 +4061,10 @@ The kakoune default is [ "insert" "prompt" ]. <home-manager/modules/programs/kakoune.nix>
programs.kakoune.config.autoInfo

Contexts in which to display automatic information box. The kakoune default is [ "command" "onkey" ]. -

Type: null or (list of (one of "command", "onkey", "normal"))

Default: null

Example: - [ - "command" "normal" - ] -

Declared by:

+

Type: null or (list of (one of "command", "onkey", "normal"))

Default: null

Example:

[
+  "command"
+  "normal"
+]

Declared by:

<home-manager/modules/programs/kakoune.nix>
programs.kakoune.config.autoReload

Reload buffers when an external modification is detected. The kakoune default is "ask". @@ -4800,11 +4076,7 @@ The kakoune default is "ask". <home-manager/modules/programs/kakoune.nix>

programs.kakoune.config.hooks

Global hooks. For documentation, see https://github.com/mawww/kakoune/blob/master/doc/pages/hooks.asciidoc. -

Type: list of (submodule)

Default: - [ - - ] -

Declared by:

+

Type: list of (submodule)

Default: [ ]

Declared by:

<home-manager/modules/programs/kakoune.nix>
programs.kakoune.config.hooks.*.commands

Commands to run when the hook is activated.

Type: strings concatenated with "\n"

Default: ""

Example: "set-option window indentwidth 2"

Declared by:

@@ -4832,11 +4104,7 @@ If 0, a tab will be used instead. <home-manager/modules/programs/kakoune.nix>
programs.kakoune.config.keyMappings

User-defined key mappings. For documentation, see https://github.com/mawww/kakoune/blob/master/doc/pages/mapping.asciidoc. -

Type: list of (submodule)

Default: - [ - - ] -

Declared by:

+

Type: list of (submodule)

Default: [ ]

Declared by:

<home-manager/modules/programs/kakoune.nix>
programs.kakoune.config.keyMappings.*.docstring

Optional documentation text to display in info boxes.

Type: null or string

Default: null

Declared by:

@@ -4969,11 +4237,7 @@ the marker text will be displayed in the indentation if possible.
programs.kakoune.plugins

List of kakoune plugins to install. To get a list of supported plugins run: nix-env -f '<nixpkgs>' -qaP -A kakounePlugins. -

Type: list of package

Default: - [ - - ] -

Example: [ pkgs.kakounePlugins.kak-fzf ]

Declared by:

+

Type: list of package

Default: [ ]

Example: [ pkgs.kakounePlugins.kak-fzf ]

Declared by:

<home-manager/modules/programs/kakoune.nix>
programs.keychain.enable

Whether to enable keychain.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/keychain.nix> @@ -4993,28 +4257,20 @@ supported plugins run:

Type: package

Default: pkgs.keychain

Declared by:

<home-manager/modules/programs/keychain.nix>
programs.keychain.agents

Agents to add. -

Type: list of string

Default: - [ - - ] -

Declared by:

+

Type: list of string

Default: [ ]

Declared by:

<home-manager/modules/programs/keychain.nix>
programs.keychain.extraFlags

Extra flags to pass to keychain. -

Type: list of string

Default: - [ - "--quiet" - ] -

Declared by:

+

Type: list of string

Default:

[
+  "--quiet"
+]

Declared by:

<home-manager/modules/programs/keychain.nix>
programs.keychain.inheritType

Inherit type to attempt from agent variables from the environment.

Type: null or one of "local", "any", "local-once", "any-once"

Default: null

Declared by:

<home-manager/modules/programs/keychain.nix>
programs.keychain.keys

Keys to add to keychain. -

Type: list of string

Default: - [ - "id_rsa" - ] -

Declared by:

+

Type: list of string

Default:

[
+  "id_rsa"
+]

Declared by:

<home-manager/modules/programs/keychain.nix>
programs.kitty.enable

Whether to enable Kitty terminal emulator.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/kitty.nix> @@ -5028,11 +4284,7 @@ supported plugins run: ]

Declared by:

<home-manager/modules/programs/kitty.nix> -
programs.kitty.environment

Environment variables to set or override.

Type: attribute set of string

Default: - { - - } -

Example:

{
+                
programs.kitty.environment

Environment variables to set or override.

Type: attribute set of string

Default: { }

Example:

{
   "LS_COLORS" = "1";
 }
 

Declared by:

@@ -5052,11 +4304,7 @@ is assumed to already be available in your profile.
programs.kitty.font.size

The size of the font.

Type: null or signed integer or floating point number

Default: null

Example: "8"

Declared by:

<home-manager/modules/programs/kitty.nix> -
programs.kitty.keybindings

Mapping of keybindings to actions.

Type: attribute set of string

Default: - { - - } -

Example:

{
+                
programs.kitty.keybindings

Mapping of keybindings to actions.

Type: attribute set of string

Default: { }

Example:

{
   "ctrl+c" = "copy_or_interrupt";
   "ctrl+f>2" = "set_font_size 20";
 }
@@ -5066,11 +4314,7 @@ is assumed to already be available in your profile.
 $XDG_CONFIG_HOME/kitty/kitty.conf. See
 https://sw.kovidgoyal.net/kitty/conf.html
 for the documentation.
-

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

Default: - { - - } -

Example:

{
+

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

Default: { }

Example:

{
   scrollback_lines = 10000;
   enable_audio_bell = false;
   update_check_interval = 0;
@@ -5167,8 +4411,8 @@ for explanation about possible values.
                 
programs.less.keys

Extra configuration for less written to $XDG_CONFIG_HOME/lesskey.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-s        back-line
-t        forw-line
+  s        back-line
+  t        forw-line
 ''

Declared by:

<home-manager/modules/programs/less.nix>
programs.lesspipe.enable

Whether to enable lesspipe preprocessor for less.

Type: boolean

Default: false

Example: true

Declared by:

@@ -5180,37 +4424,26 @@ t forw-line <home-manager/modules/programs/lf.nix>
programs.lf.cmdKeybindings

Keys to bind to command line commands which can only be one of the builtin commands. Keys set to null or an empty string are deleted. -

Type: attribute set of (null or string)

Default: - { - - } -

Example: { "<c-g>" = "cmd-escape"; }

Declared by:

+

Type: attribute set of (null or string)

Default: { }

Example: { "<c-g>" = "cmd-escape"; }

Declared by:

<home-manager/modules/programs/lf.nix>
programs.lf.commands

Commands to declare. Commands set to null or an empty string are deleted. -

Type: attribute set of (null or string)

Default: - { - - } -

Example: - { - get-mime-type = ''%xdg-mime query filetype "$f"''; open = "$$OPENER $f"; - } -

Declared by:

+

Type: attribute set of (null or string)

Default: { }

Example:

{
+  get-mime-type = "%xdg-mime query filetype \"$f\"";
+  open = "$$OPENER $f";
+}

Declared by:

<home-manager/modules/programs/lf.nix>
programs.lf.extraConfig

Custom lfrc lines.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-$mkdir -p ~/.trash
+  $mkdir -p ~/.trash
 ''

Declared by:

<home-manager/modules/programs/lf.nix> -
programs.lf.keybindings

Keys to bind. Keys set to null or an empty string are deleted.

Type: attribute set of (null or string)

Default: - { - - } -

Example: - { - D = "trash"; U = "!du -sh"; gg = null; gh = "cd ~"; i = "$less $f"; - } -

Declared by:

+
programs.lf.keybindings

Keys to bind. Keys set to null or an empty string are deleted.

Type: attribute set of (null or string)

Default: { }

Example:

{
+  D = "trash";
+  U = "!du -sh";
+  gg = null;
+  gh = "cd ~";
+  i = "$less $f";
+}

Declared by:

<home-manager/modules/programs/lf.nix>
programs.lf.previewer.keybinding

Key to bind to the script at previewer.source and pipe through less. Setting to null will not bind any key. @@ -5242,15 +4475,11 @@ Note, use previewer to set lf's previewer option, and extraConfig for any other option not listed above. All string options are quoted with double quotes. -

Type: submodule

Default: - { - - } -

Example: - { - number = true; ratios = "1:1:2"; tabstop = 4; - } -

Declared by:

+

Type: submodule

Default: { }

Example:

{
+  number = true;
+  ratios = "1:1:2";
+  tabstop = 4;
+}

Declared by:

<home-manager/modules/programs/lf.nix>
programs.librewolf.enable

Whether to enable Librewolf browser, a privacy enhanced Firefox fork.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/librewolf.nix> @@ -5259,11 +4488,7 @@ All string options are quoted with double quotes.
programs.librewolf.settings

Attribute set of LibreWolf settings and overrides. Refer to https://librewolf.net/docs/settings/ for details on supported values. -

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

Default: - { - - } -

Example:

{
+

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

Default: { }

Example:

{
   "webgl.disabled" = false;
   "privacy.resistFingerprinting" = false;
 }
@@ -5278,11 +4503,7 @@ for details on supported values.
                     <home-manager/modules/programs/looking-glass-client.nix>
                 
programs.looking-glass-client.package

Type: package

Default: pkgs.looking-glass-client

Declared by:

<home-manager/modules/programs/looking-glass-client.nix> -
programs.looking-glass-client.settings

looking-glass-client settings.

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: - { - - } -

Example:

{
+                
programs.looking-glass-client.settings

looking-glass-client settings.

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: { }

Example:

{
   app = {
     allowDMA = true;
     shmFile = "/dev/kvmfr0";
@@ -5315,19 +4536,13 @@ for details on supported values.
 $XDG_CONFIG_HOME/lsd/config.yaml. See
 https://github.com/Peltoche/lsd#config-file-content
 for supported values.
-

Type: YAML value

Default: - { - - } -

Example: - { - date = "relative"; ignore-globs = - [ - ".git" ".hg" - ] - ; - } -

Declared by:

+

Type: YAML value

Default: { }

Example:

{
+  date = "relative";
+  ignore-globs = [
+    ".git"
+    ".hg"
+  ];
+}

Declared by:

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

Whether to enable Mako, lightweight notification daemon for Wayland .

Type: boolean

Default: false

Example: true

Declared by:

@@ -5371,7 +4586,7 @@ border-color=#b8bb26
programs.mako.format

Set notification format string to format. See FORMAT SPECIFIERS for more information. To change this for grouped notifications, set it within a grouped criteria. -

Type: null or string

Default: ''<b>%s</b>\n%b''

Declared by:

+

Type: null or string

Default: "<b>%s</b>\\n%b"

Declared by:

<home-manager/modules/services/mako.nix>
programs.mako.groupBy

A comma-separated list of criteria fields that will be compared to other visible notifications to determine if this one should form a @@ -5488,11 +4703,7 @@ MangoHud is started on any application that supports it. $XDG_CONFIG_HOME/MangoHud/MangoHud.conf. See https://github.com/flightlessmango/MangoHud/blob/master/data/MangoHud.conf for the default configuration. -

Type: attribute set of (boolean or signed integer or floating point number or string or path or list of (signed integer or string))

Default: - { - - } -

Example:

{
+

Type: attribute set of (boolean or signed integer or floating point number or string or path or list of (signed integer or string))

Default: { }

Example:

{
   output_folder = ~/Documents/mangohud/;
   full = true;
 }
@@ -5503,11 +4714,7 @@ Configuration written to
 $XDG_CONFIG_HOME/MangoHud/{application_name}.conf. See
 https://github.com/flightlessmango/MangoHud/blob/master/data/MangoHud.conf
 for the default configuration.
-

Type: attribute set of attribute set of (boolean or signed integer or floating point number or string or path or list of (signed integer or string))

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute set of (boolean or signed integer or floating point number or string or path or list of (signed integer or string))

Default: { }

Example:

{
   mpv = {
     no_display = true;
   }
@@ -5518,11 +4725,7 @@ for the default configuration.
                     <home-manager/modules/programs/matplotlib.nix>
                 
programs.matplotlib.config

Add terms to the matplotlibrc file to control the default matplotlib behavior. -

Type: attribute set of anything

Default: - { - - } -

Example:

{
+

Type: attribute set of anything

Default: { }

Example:

{
   backend = "Qt5Agg";
   axes = {
     grid = true;
@@ -5545,11 +4748,7 @@ control the default matplotlib behavior.
 

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/programs/mbsync.nix>
programs.mbsync.groups

Definition of groups. -

Type: attribute set of attribute set of list of string

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute set of list of string

Default: { }

Example:

{
   inboxes = {
     account1 = [ "Inbox" ];
     account2 = [ "Inbox" ];
@@ -5583,37 +4782,19 @@ Values in the 2-5 range get good results so far.
                     <home-manager/modules/programs/mercurial.nix>
                 
programs.mercurial.package

Mercurial package to install.

Type: package

Default: pkgs.mercurial

Declared by:

<home-manager/modules/programs/mercurial.nix> -
programs.mercurial.aliases

Mercurial aliases to define.

Type: attribute set of anything

Default: - { - - } -

Declared by:

+
programs.mercurial.aliases

Mercurial aliases to define.

Type: attribute set of anything

Default: { }

Declared by:

<home-manager/modules/programs/mercurial.nix> -
programs.mercurial.extraConfig

Additional configuration to add.

Type: (attribute set of anything) or strings concatenated with "\n"

Default: - { - - } -

Declared by:

+
programs.mercurial.extraConfig

Additional configuration to add.

Type: (attribute set of anything) or strings concatenated with "\n"

Default: { }

Declared by:

<home-manager/modules/programs/mercurial.nix> -
programs.mercurial.ignores

List of globs for files to be globally ignored.

Type: list of string

Default: - [ - - ] -

Example: - [ - "*~" "*.swp" - ] -

Declared by:

+
programs.mercurial.ignores

List of globs for files to be globally ignored.

Type: list of string

Default: [ ]

Example:

[
+  "*~"
+  "*.swp"
+]

Declared by:

<home-manager/modules/programs/mercurial.nix> -
programs.mercurial.ignoresRegexp

List of regular expressions for files to be globally ignored.

Type: list of string

Default: - [ - - ] -

Example: - [ - "^.*~$" ''^.*\.swp$'' - ] -

Declared by:

+
programs.mercurial.ignoresRegexp

List of regular expressions for files to be globally ignored.

Type: list of string

Default: [ ]

Example:

[
+  "^.*~$"
+  "^.*\\.swp$"
+]

Declared by:

<home-manager/modules/programs/mercurial.nix>
programs.mercurial.userEmail

Default user email to use.

Type: string

Declared by:

<home-manager/modules/programs/mercurial.nix> @@ -5625,11 +4806,7 @@ Values in the 2-5 range get good results so far. $XDG_CONFIG_HOME/micro/settings.json. See https://github.com/zyedidia/micro/blob/master/runtime/help/options.md for supported values. -

Type: JSON value

Default: - { - - } -

Example:

{
+

Type: JSON value

Default: { }

Example:

{
   autosu = false;
   cursorline = false;
 }
@@ -5638,17 +4815,13 @@ for supported values.
                 
programs.mpv.enable

Whether to enable mpv.

Type: boolean

Default: false

Example: true

Declared by:

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

Package providing mpv. -

Type: package

Default: (build of mpv-with-scripts-0.35.0)

Example: pkgs.wrapMpv (pkgs.mpv-unwrapped.override { vapoursynthSupport = true; }) { youtubeSupport = true; }

Declared by:

+

Type: package

Default: <derivation mpv-with-scripts-0.35.0>

Example: pkgs.wrapMpv (pkgs.mpv-unwrapped.override { vapoursynthSupport = true; }) { youtubeSupport = true; }

Declared by:

<home-manager/modules/programs/mpv.nix>
programs.mpv.bindings

Input configuration written to $XDG_CONFIG_HOME/mpv/input.conf. See mpv(1) for the full list of options. -

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   WHEEL_UP = "seek 10";
   WHEEL_DOWN = "seek -10";
   "Alt+0" = "set window-scale 0.5";
@@ -5659,11 +4832,7 @@ for the full list of options.
 $XDG_CONFIG_HOME/mpv/mpv.conf. See
 mpv(1)
 for the full list of options.
-

Type: attribute set of (string or signed integer or boolean or floating point number or list of (string or signed integer or boolean or floating point number))

Default: - { - - } -

Example:

{
+

Type: attribute set of (string or signed integer or boolean or floating point number or list of (string or signed integer or boolean or floating point number))

Default: { }

Example:

{
   profile = "gpu-hq";
   force-window = true;
   ytdl-format = "bestvideo+bestaudio";
@@ -5673,24 +4842,14 @@ for the full list of options.
                     <home-manager/modules/programs/mpv.nix>
                 
programs.mpv.defaultProfiles

Profiles to be applied by default. Options set by them are overridden by options set in programs.mpv.config. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "gpu-hq" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "gpu-hq"
+]

Declared by:

<home-manager/modules/programs/mpv.nix>
programs.mpv.profiles

Sub-configuration options for specific profiles written to $XDG_CONFIG_HOME/mpv/mpv.conf. See programs.mpv.config for more information. -

Type: attribute set of attribute set of (string or signed integer or boolean or floating point number or list of (string or signed integer or boolean or floating point number))

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute set of (string or signed integer or boolean or floating point number or list of (string or signed integer or boolean or floating point number))

Default: { }

Example:

{
   fast = {
     vo = "vdpau";
   };
@@ -5702,11 +4861,7 @@ by options set in 

Declared by:

<home-manager/modules/programs/mpv.nix>
programs.mpv.scripts

List of scripts to use with mpv. -

Type: list of package

Default: - [ - - ] -

Example: [ pkgs.mpvScripts.mpris ]

Declared by:

+

Type: list of package

Default: [ ]

Example: [ pkgs.mpvScripts.mpris ]

Declared by:

<home-manager/modules/programs/mpv.nix>
programs.msmtp.enable

Whether to enable msmtp.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/msmtp.nix> @@ -5746,11 +4901,7 @@ Account commands should be placed in on Darwin. See https://github.com/denisidoro/navi/blob/master/docs/config_file.md for more information. -

Type: YAML value

Default: - { - - } -

Example:

{
+

Type: YAML value

Default: { }

Example:

{
   cheats = {
     paths = [
       "~/cheats/"
@@ -5764,11 +4915,7 @@ for more information.
                 
programs.ncmpcpp.package

Package providing the ncmpcpp command.

Type: package

Default: pkgs.ncmpcpp

Example: pkgs.ncmpcpp.override { visualizerSupport = true; }

Declared by:

<home-manager/modules/programs/ncmpcpp.nix> -
programs.ncmpcpp.bindings

List of keybindings.

Type: list of (submodule)

Default: - [ - - ] -

Example:

[
+                
programs.ncmpcpp.bindings

List of keybindings.

Type: list of (submodule)

Default: [ ]

Example:

[
   { key = "j"; command = "scroll_down"; }
   { key = "k"; command = "scroll_up"; }
   { key = "J"; command = [ "select_item" "scroll_down" ]; }
@@ -5793,15 +4940,9 @@ else
                 
programs.ncmpcpp.settings

Attribute set from name of a setting to its value. For available options see ncmpcpp(1). -

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

Default: - { - - } -

Example: - { - ncmpcpp_directory = "~/.local/share/ncmpcpp"; - } -

Declared by:

+

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

Default: { }

Example:

{
+  ncmpcpp_directory = "~/.local/share/ncmpcpp";
+}

Declared by:

<home-manager/modules/programs/ncmpcpp.nix>
programs.ncspot.enable

Whether to enable ncspot.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/ncspot.nix> @@ -5812,11 +4953,7 @@ see

See https://github.com/hrkfdn/ncspot#configuration for the full list of options. -

Type: TOML value

Default: - { - - } -

Example:

{
+

Type: TOML value

Default: { }

Example:

{
   shuffle = true;
   gapless = true;
 }
@@ -5825,11 +4962,7 @@ for the full list of options.
                 
programs.ne.enable

Whether to enable ne.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/ne.nix>
programs.ne.automaticPreferences

Automatic preferences files for ne. -

Type: attribute set of strings concatenated with "\n"

Default: - { - - } -

Example:

{
+

Type: attribute set of strings concatenated with "\n"

Default: { }

Example:

{
   nix = ''
     TAB 0
     TS 2
@@ -5847,26 +4980,22 @@ Equivalent to programs.ne.automaticPreferences.".default"<
                     <home-manager/modules/programs/ne.nix>
                 
programs.ne.keybindings

Keybinding file for ne.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-KEY 7f BS
-SEQ "\x1b[1;5D" 7f
+  KEY 7f BS
+  SEQ "\x1b[1;5D" 7f
 ''

Declared by:

<home-manager/modules/programs/ne.nix>
programs.ne.menus

Menu configuration file for ne.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/programs/ne.nix>
programs.ne.virtualExtensions

Virtual extensions configuration file for ne.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-sh   1  ^#!\s*/.*\b(bash|sh|ksh|zsh)\s*
-csh  1  ^#!\s*/.*\b(csh|tcsh)\s*
+  sh   1  ^#!\s*/.*\b(bash|sh|ksh|zsh)\s*
+  csh  1  ^#!\s*/.*\b(csh|tcsh)\s*
 ''

Declared by:

<home-manager/modules/programs/ne.nix>
programs.neomutt.enable

Whether to enable the NeoMutt mail client.

Type: boolean

Default: false

Example: true

Declared by:

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

The neomutt package to use.

Type: package

Default: pkgs.neomutt

Declared by:

<home-manager/modules/programs/neomutt.nix> -
programs.neomutt.binds

List of keybindings.

Type: list of (submodule)

Default: - [ - - ] -

Declared by:

+
programs.neomutt.binds

List of keybindings.

Type: list of (submodule)

Default: [ ]

Declared by:

<home-manager/modules/programs/neomutt.nix>
programs.neomutt.binds.*.action

Specify the action to take.

Type: string

Example: "<enter-command>toggle sidebar_visible<enter><refresh>"

Declared by:

<home-manager/modules/programs/neomutt.nix> @@ -5882,11 +5011,7 @@ csh 1 ^#!\s*/.*\b(csh|tcsh)\s* <home-manager/modules/programs/neomutt.nix>
programs.neomutt.extraConfig

Extra configuration appended to the end.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/programs/neomutt.nix> -
programs.neomutt.macros

List of macros.

Type: list of (submodule)

Default: - [ - - ] -

Declared by:

+
programs.neomutt.macros

List of macros.

Type: list of (submodule)

Default: [ ]

Declared by:

<home-manager/modules/programs/neomutt.nix>
programs.neomutt.macros.*.action

Specify the action to take.

Type: string

Example: "<enter-command>toggle sidebar_visible<enter><refresh>"

Declared by:

<home-manager/modules/programs/neomutt.nix> @@ -5894,17 +5019,9 @@ csh 1 ^#!\s*/.*\b(csh|tcsh)\s* <home-manager/modules/programs/neomutt.nix>
programs.neomutt.macros.*.map

Select the menu to bind the command to.

Type: one of "alias", "attach", "browser", "compose", "editor", "generic", "index", "mix", "pager", "pgp", "postpone", "query", "smime" or list of (one of "alias", "attach", "browser", "compose", "editor", "generic", "index", "mix", "pager", "pgp", "postpone", "query", "smime")

Default: "index"

Declared by:

<home-manager/modules/programs/neomutt.nix> -
programs.neomutt.settings

Extra configuration appended to the end.

Type: attribute set of string

Default: - { - - } -

Declared by:

+
programs.neomutt.settings

Extra configuration appended to the end.

Type: attribute set of string

Default: { }

Declared by:

<home-manager/modules/programs/neomutt.nix> -
programs.neomutt.sidebar

Options related to the sidebar.

Type: submodule

Default: - { - - } -

Declared by:

+
programs.neomutt.sidebar

Options related to the sidebar.

Type: submodule

Default: { }

Declared by:

<home-manager/modules/programs/neomutt.nix>
programs.neomutt.sidebar.enable

Whether to enable sidebar support.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/neomutt.nix> @@ -5936,11 +5053,7 @@ with this enabled only the relative name is shown. See https://github.com/neoclide/coc.nvim/wiki/Using-the-configuration-file for options. -

Type: JSON value

Default: - { - - } -

Example:

{
+

Type: JSON value

Default: { }

Example:

{
   "suggest.noselect" = true;
   "suggest.enablePreview" = true;
   "suggest.enablePreselect" = false;
@@ -5964,18 +5077,14 @@ for options.
                     <home-manager/modules/programs/neovim.nix>
                 
programs.neovim.extraConfig

Custom vimrc lines.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-set nobackup
+  set nobackup
 ''

Declared by:

<home-manager/modules/programs/neovim.nix>
programs.neovim.extraLuaPackages

A function in lua5_1.withPackages format, which returns a list of Lua packages required for your plugins to work.

Type: (lua5.1 packages in lua5_1.withPackages format) or list of package

Default: [ ]

Example: (ps: with ps; [ luautf8 ])

Declared by:

<home-manager/modules/programs/neovim.nix> -
programs.neovim.extraPackages

Extra packages available to nvim.

Type: list of package

Default: - [ - - ] -

Example: [ pkgs.shfmt ]

Declared by:

+
programs.neovim.extraPackages

Extra packages available to nvim.

Type: list of package

Default: [ ]

Example: [ pkgs.shfmt ]

Declared by:

<home-manager/modules/programs/neovim.nix>
programs.neovim.extraPython3Packages

A function in python.withPackages format, which returns a list of Python 3 packages required for your plugins to work. @@ -6003,11 +5112,7 @@ configuration to be placed in init.vim.

This option is mutually exclusive with configure. -

Type: list of (package or (submodule))

Default: - [ - - ] -

Example:

with pkgs.vimPlugins; [
+

Type: list of (package or (submodule))

Default: [ ]

Example:

with pkgs.vimPlugins; [
   yankring
   vim-nix
   { plugin = vim-startify;
@@ -6048,15 +5153,9 @@ use Python 3 plugins.
                     <home-manager/modules/programs/newsboat.nix>
                 
programs.newsboat.maxItems

Maximum number of items per feed, 0 for infinite.

Type: signed integer

Default: 0

Declared by:

<home-manager/modules/programs/newsboat.nix> -
programs.newsboat.queries

A list of queries to use.

Type: attribute set of string

Default: - { - - } -

Example: - { - foo = ''rssurl =~ "example.com"''; - } -

Declared by:

+
programs.newsboat.queries

A list of queries to use.

Type: attribute set of string

Default: { }

Example:

{
+  foo = "rssurl =~ \"example.com\"";
+}

Declared by:

<home-manager/modules/programs/newsboat.nix>
programs.newsboat.reloadThreads

How many threads to use for updating the feeds.

Type: signed integer

Default: 5

Declared by:

<home-manager/modules/programs/newsboat.nix> @@ -6064,33 +5163,20 @@ use Python 3 plugins. <home-manager/modules/programs/newsboat.nix>
programs.newsboat.urls

List of news feeds. Leave it empty if you want to manage feeds imperatively, for example, using Syncthing. -

Type: list of (submodule)

Default: - [ - - ] -

Example: - [ - - { - tags = - [ - "foo" "bar" - ] - ; url = "http://example.com"; - } - - ] -

Declared by:

+

Type: list of (submodule)

Default: [ ]

Example:

[
+  {
+    tags = [
+      "foo"
+      "bar"
+    ];
+    url = "http://example.com";
+  }
+]

Declared by:

<home-manager/modules/programs/newsboat.nix> -
programs.newsboat.urls.*.tags

Feed tags.

Type: list of string

Default: - [ - - ] -

Example: - [ - "foo" "bar" - ] -

Declared by:

+
programs.newsboat.urls.*.tags

Feed tags.

Type: list of string

Default: [ ]

Example:

[
+  "foo"
+  "bar"
+]

Declared by:

<home-manager/modules/programs/newsboat.nix>
programs.newsboat.urls.*.title

Feed title.

Type: null or string

Default: null

Example: "ORF News"

Declared by:

<home-manager/modules/programs/newsboat.nix> @@ -6115,11 +5201,7 @@ correct functionality of the application. This a temporary inconvenience, however, as nheko has plans to move the authentication stuff into the local database they currently use. Once this happens, this will no longer be an issue. -

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: { }

Example:

{
   general.disableCertificateValidation = false;
   auth = {
     accessToken = "SECRET";
@@ -6153,11 +5235,7 @@ this happens, this will no longer be an issue.
 

Type: package

Default: pkgs.nnn

Example: pkgs.nnn.override ({ withNerdIcons = true; });

Declared by:

<home-manager/modules/programs/nnn.nix>
programs.nnn.bookmarks

Directory bookmarks. -

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   d = "~/Documents";
   D = "~/Downloads";
   p = "~/Pictures";
@@ -6166,25 +5244,13 @@ this happens, this will no longer be an issue.
 

Declared by:

<home-manager/modules/programs/nnn.nix>
programs.nnn.extraPackages

Extra packages available to nnn. -

Type: list of package

Default: - [ - - ] -

Example: with pkgs; [ ffmpegthumbnailer mediainfo sxiv ]

Declared by:

+

Type: list of package

Default: [ ]

Example: with pkgs; [ ffmpegthumbnailer mediainfo sxiv ]

Declared by:

<home-manager/modules/programs/nnn.nix>
programs.nnn.plugins

Manage nnn plugins. -

Type: submodule

Default: - { - - } -

Declared by:

+

Type: submodule

Default: { }

Declared by:

<home-manager/modules/programs/nnn.nix>
programs.nnn.plugins.mappings

Key mappings to the plugins. -

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   c = "fzcd";
   f = "finder";
   v = "imgview";
@@ -6208,11 +5274,7 @@ this happens, this will no longer be an issue.
 See
 noti.yaml(5).
 for the full list of options.
-

Type: attribute set of attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute set of string

Default: { }

Example:

{
   say = {
     voice = "Alex";
   };
@@ -6226,11 +5288,7 @@ for the full list of options.
                 
programs.notmuch.enable

Whether to enable Notmuch mail indexer.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/notmuch.nix>
programs.notmuch.extraConfig

Options that should be appended to the notmuch configuration file. -

Type: attribute set of attribute set of string

Default: - { - - } -

Declared by:

+

Type: attribute set of attribute set of string

Default: { }

Declared by:

<home-manager/modules/programs/notmuch.nix>
programs.notmuch.hooks.postInsert

Bash statements run after a message has been inserted into the database and initial tags have been applied. @@ -6239,7 +5297,7 @@ into the database and initial tags have been applied.

programs.notmuch.hooks.postNew

Bash statements run after new messages have been imported into the database and initial tags have been applied.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-notmuch tag +nixos -- tag:new and from:nixos1@discoursemail.com
+  notmuch tag +nixos -- tag:new and from:nixos1@discoursemail.com
 ''

Declared by:

<home-manager/modules/programs/notmuch.nix>
programs.notmuch.hooks.preNew

Bash statements run before scanning or importing new @@ -6251,44 +5309,31 @@ messages into the database. <home-manager/modules/programs/notmuch.nix>

programs.notmuch.new

Options related to email processing performed by notmuch new. -

Type: submodule

Default: - { - - } -

Declared by:

+

Type: submodule

Default: { }

Declared by:

<home-manager/modules/programs/notmuch.nix>
programs.notmuch.new.ignore

A list to specify files and directories that will not be searched for messages by notmuch new. -

Type: list of string

Default: - [ - - ] -

Declared by:

+

Type: list of string

Default: [ ]

Declared by:

<home-manager/modules/programs/notmuch.nix>
programs.notmuch.new.tags

A list of tags that will be added to all messages incorporated by notmuch new. -

Type: list of string

Default: - [ - "unread" "inbox" - ] -

Example: - [ - "new" - ] -

Declared by:

+

Type: list of string

Default:

[
+  "unread"
+  "inbox"
+]

Example:

[
+  "new"
+]

Declared by:

<home-manager/modules/programs/notmuch.nix>
programs.notmuch.search.excludeTags

A list of tags that will be excluded from search results by default. Using an excluded tag in a query will override that exclusion. -

Type: list of string

Default: - [ - "deleted" "spam" - ] -

Example: - [ - "trash" "spam" - ] -

Declared by:

+

Type: list of string

Default:

[
+  "deleted"
+  "spam"
+]

Example:

[
+  "trash"
+  "spam"
+]

Declared by:

<home-manager/modules/programs/notmuch.nix>
programs.nushell.enable

Whether to enable nushell.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/nushell.nix> @@ -6319,7 +5364,7 @@ If unset then the source option will be preferred.

See https://www.nushell.sh/book/configuration.html#configuration for more information.

Type: null or (submodule)

Default: null

Example:

''
-let-env FOO = 'BAR'
+  let-env FOO = 'BAR'
 ''

Declared by:

<home-manager/modules/programs/nushell.nix>
programs.nushell.envFile.source

Path of the nushell env.nu file to use. @@ -6341,55 +5386,32 @@ If unset then the source option will be preferred.

programs.obs-studio.package

OBS Studio package to install.

Type: package

Default: pkgs.obs-studio

Declared by:

<home-manager/modules/programs/obs-studio.nix> -
programs.obs-studio.plugins

Optional OBS plugins.

Type: list of package

Default: - [ - - ] -

Example: [ pkgs.obs-studio-plugins.wlrobs ]

Declared by:

+
programs.obs-studio.plugins

Optional OBS plugins.

Type: list of package

Default: [ ]

Example: [ pkgs.obs-studio-plugins.wlrobs ]

Declared by:

<home-manager/modules/programs/obs-studio.nix>
programs.octant.enable

Whether to enable octant.

Type: boolean

Default: false

Example: true

Declared by:

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

The Octant package to use.

Type: package

Default: pkgs.octant

Example: pkgs.octant-other

Declared by:

<home-manager/modules/programs/octant.nix> -
programs.octant.plugins

Optional Octant plugins.

Type: list of package

Default: - [ - - ] -

Example: [ pkgs.starboard-octant-plugin ]

Declared by:

+
programs.octant.plugins

Optional Octant plugins.

Type: list of package

Default: [ ]

Example: [ pkgs.starboard-octant-plugin ]

Declared by:

<home-manager/modules/programs/octant.nix>
programs.offlineimap.enable

Whether to enable OfflineIMAP.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/offlineimap.nix>
programs.offlineimap.extraConfig.default

Extra configuration options added to the DEFAULT section. -

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

Default: - { - - } -

Example: - { - gmailtrashfolder = "[Gmail]/Papierkorb"; - } -

Declared by:

+

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

Default: { }

Example:

{
+  gmailtrashfolder = "[Gmail]/Papierkorb";
+}

Declared by:

<home-manager/modules/programs/offlineimap.nix>
programs.offlineimap.extraConfig.general

Extra configuration options added to the general section. -

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

Default: - { - - } -

Example: - { - maxage = 30; ui = "blinkenlights"; - } -

Declared by:

+

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

Default: { }

Example:

{
+  maxage = 30;
+  ui = "blinkenlights";
+}

Declared by:

<home-manager/modules/programs/offlineimap.nix>
programs.offlineimap.extraConfig.mbnames

Extra configuration options added to the mbnames section. -

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

Default: - { - - } -

Example:

{
+

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

Default: { }

Example:

{
   filename = "~/.config/mutt/mailboxes";
   header = "'mailboxes '";
   peritem = "'+%(accountname)s/%(foldername)s'";
@@ -6401,10 +5423,10 @@ If unset then the source option will be preferred.
                 
programs.offlineimap.pythonFile

Python code that can then be used in other parts of the configuration.

Type: strings concatenated with "\n"

Default:

''
-import subprocess
-
-def get_pass(service, cmd):
-    return subprocess.check_output(cmd, )
+  import subprocess
+  
+  def get_pass(service, cmd):
+      return subprocess.check_output(cmd, )
 ''

Declared by:

<home-manager/modules/programs/offlineimap.nix>
programs.oh-my-posh.enable

Whether to enable oh-my-posh, a prompt theme engine for any shell.

Type: boolean

Default: false

Example: true

Declared by:

@@ -6425,11 +5447,7 @@ def get_pass(service, cmd): https://ohmyposh.dev/docs/configuration/overview for details. The useTheme option is ignored when this option is used. -

Type: JSON value

Default: - { - - } -

Example: builtins.fromJSON (builtins.unsafeDiscardStringContext (builtins.readFile "${pkgs.oh-my-posh}/share/oh-my-posh/themes/space.omp.json"))

Declared by:

+

Type: JSON value

Default: { }

Example: builtins.fromJSON (builtins.unsafeDiscardStringContext (builtins.readFile "${pkgs.oh-my-posh}/share/oh-my-posh/themes/space.omp.json"))

Declared by:

<home-manager/modules/programs/oh-my-posh.nix>
programs.oh-my-posh.useTheme

Use one of the official themes. This should be a name from this list: https://ohmyposh.dev/docs/themes. Because a theme @@ -6454,20 +5472,12 @@ is essentially a configuration file, this option is not used when a <home-manager/modules/programs/pandoc.nix>

programs.pandoc.package

The pandoc package to use.

Type: package

Default: pkgs.pandoc

Declared by:

<home-manager/modules/programs/pandoc.nix> -
programs.pandoc.citationStyles

List of .csl files to install.

Type: list of path

Default: - [ - - ] -

Example: [ path/to/file.csl ]

Declared by:

+
programs.pandoc.citationStyles

List of .csl files to install.

Type: list of path

Default: [ ]

Example: [ path/to/file.csl ]

Declared by:

<home-manager/modules/programs/pandoc.nix>
programs.pandoc.defaults

Options to set by default. These will be converted to JSON and written to a defaults file (see Default files in pandoc documentation). -

Type: JSON value

Default: - { - - } -

Example:

{
+

Type: JSON value

Default: { }

Example:

{
   metadata = {
     author = "John Doe";
   };
@@ -6480,11 +5490,7 @@ file (see Default files in pandoc documentation).
                     <home-manager/modules/programs/pandoc.nix>
                 
programs.pandoc.finalPackage

Resulting package.

Type: package (read only)

Declared by:

<home-manager/modules/programs/pandoc.nix> -
programs.pandoc.templates

Custom templates.

Type: attribute set of path

Default: - { - - } -

Example:

{
+                
programs.pandoc.templates

Custom templates.

Type: attribute set of path

Default: { }

Example:

{
   "default.latex" = path/to/your/template;
 }
 

Declared by:

@@ -6528,18 +5534,10 @@ available keys. <home-manager/modules/programs/pet.nix>
programs.pet.settings

Settings written to config.toml. See the pet documentation for details. -

Type: TOML value

Default: - { - - } -

Declared by:

+

Type: TOML value

Default: { }

Declared by:

<home-manager/modules/programs/pet.nix>
programs.pet.snippets

The snippets. -

Type: list of (submodule)

Default: - [ - - ] -

Declared by:

+

Type: list of (submodule)

Default: [ ]

Declared by:

<home-manager/modules/programs/pet.nix>
programs.pet.snippets.*.command

The command.

Type: string

Default: ""

Example: "git rev-list --count HEAD"

Declared by:

@@ -6551,32 +5549,20 @@ documentation for details.

Type: string

Default: ""

Example: "473"

Declared by:

<home-manager/modules/programs/pet.nix>
programs.pet.snippets.*.tag

List of tags attached to the command. -

Type: list of string

Default: - [ - - ] -

Example: ["git" "nixpkgs"]

Declared by:

+

Type: list of string

Default: [ ]

Example: ["git" "nixpkgs"]

Declared by:

<home-manager/modules/programs/pet.nix>
programs.pidgin.enable

Whether to enable Pidgin messaging client.

Type: boolean

Default: false

Example: true

Declared by:

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

The Pidgin package to use.

Type: package

Default: pkgs.pidgin

Declared by:

<home-manager/modules/programs/pidgin.nix> -
programs.pidgin.plugins

Plugins that should be available to Pidgin.

Type: unspecified value

Default: - [ - - ] -

Example: [ pkgs.pidgin-otr pkgs.pidgin-osd ]

Declared by:

+
programs.pidgin.plugins

Plugins that should be available to Pidgin.

Type: unspecified value

Default: [ ]

Example: [ pkgs.pidgin-otr pkgs.pidgin-osd ]

Declared by:

<home-manager/modules/programs/pidgin.nix>
programs.pistol.enable

Whether to enable Pistol, a general purpose file previewer designed for terminal file managers.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/pistol.nix>
programs.pistol.config

Pistol configuration written to $XDG_CONFIG_HOME/pistol/pistol.conf. -

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   "text/*" = "bat --paging=never --color=always %pistol-filename%";
   "inode/directory" = "ls -l --color %pistol-filename%";
 }
@@ -6588,11 +5574,7 @@ managers.

Type: boolean

programs.piston-cli.settings

Configuration written to $XDG_CONFIG_HOME/piston-cli/config.yml. -

Type: YAML value

Default: - { - - } -

Example:

{
+

Type: YAML value

Default: { }

Example:

{
   theme = "emacs";
   box_style = "MINIMAL_DOUBLE_HEAD";
   prompt_continuation = "...";
@@ -6609,27 +5591,30 @@ managers.

Type: boolean

programs.powerline-go.enable

Whether to enable Powerline-go, a beautiful and useful low-latency prompt for your shell.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/powerline-go.nix>
programs.powerline-go.extraUpdatePS1

Shell code to execute after the prompt is set.

Type: string

Default: ""

Example:

''
-PS1=$PS1"NixOS> ";
+  PS1=$PS1"NixOS> ";
 ''

Declared by:

<home-manager/modules/programs/powerline-go.nix>
programs.powerline-go.modules

List of module names to load. The list of all available modules as well as the choice of default ones are at https://github.com/justjanne/powerline-go. -

Type: null or (list of string)

Default: null

Example: - [ - "host" "ssh" "cwd" "gitlite" "jobs" "exit" - ] -

Declared by:

+

Type: null or (list of string)

Default: null

Example:

[
+  "host"
+  "ssh"
+  "cwd"
+  "gitlite"
+  "jobs"
+  "exit"
+]

Declared by:

<home-manager/modules/programs/powerline-go.nix>
programs.powerline-go.modulesRight

List of module names to load to be displayed on the right side. Currently not supported by bash. Specifying a value for this option will force powerline-go to use the eval format to set the prompt. -

Type: null or (list of string)

Default: null

Example: - [ - "host" "venv" "git" - ] -

Declared by:

+

Type: null or (list of string)

Default: null

Example:

[
+  "host"
+  "venv"
+  "git"
+]

Declared by:

<home-manager/modules/programs/powerline-go.nix>
programs.powerline-go.newline

Set to true if the prompt should be on a line of its own.

Type: boolean

Default: false

Example: true

Declared by:

@@ -6642,11 +5627,7 @@ protect it to avoid shell substitution. <home-manager/modules/programs/powerline-go.nix>
programs.powerline-go.settings

This can be any key/value pair as described in https://github.com/justjanne/powerline-go. -

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

Default: - { - - } -

Example:

{
+

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

Default: { }

Example:

{
   hostname-only-if-ssh = true;
   numeric-exit-codes = true;
   cwd-max-depth = 7;
@@ -6698,11 +5679,7 @@ force_color = False
                 
programs.qutebrowser.package

Qutebrowser package to install.

Type: package

Default: pkgs.qutebrowser

Declared by:

<home-manager/modules/programs/qutebrowser.nix>
programs.qutebrowser.aliases

Aliases for commands. -

Type: attribute set of string

Default: - { - - } -

Declared by:

+

Type: attribute set of string

Default: { }

Declared by:

<home-manager/modules/programs/qutebrowser.nix>
programs.qutebrowser.extraConfig

Extra lines added to qutebrowser config.py file.

Type: strings concatenated with "\n"

Default: ""

Declared by:

@@ -6769,11 +5746,7 @@ commands. The following modes are available: Entered when qutebrowser is waiting for a register name/key for commands like :set-mark.

-

Type: attribute set of attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute set of string

Default: { }

Example:

{
   normal = {
     "<Ctrl-v>" = "spawn mpv {url}";
     ",p" = "spawn --userscript qute-pass";
@@ -6791,22 +5764,14 @@ dictionary-value is invoked instead. This is useful for global
 remappings of keys, for example to map Ctrl-[ to Escape. Note that when
 a key is bound (via bindings.default or
 bindings.commands), the mapping is ignored.
-

Type: attribute set of string

Default: - { - - } -

Declared by:

+

Type: attribute set of string

Default: { }

Declared by:

<home-manager/modules/programs/qutebrowser.nix>
programs.qutebrowser.loadAutoconfig

Load settings configured via the GUI.

Type: boolean

Default: false

Declared by:

<home-manager/modules/programs/qutebrowser.nix>
programs.qutebrowser.quickmarks

Quickmarks to add to qutebrowser's quickmarks file. Note that when Home Manager manages your quickmarks, you cannot edit them at runtime. -

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   nixpkgs = "https://github.com/NixOS/nixpkgs";
   home-manager = "https://github.com/nix-community/home-manager";
 }
@@ -6823,11 +5788,7 @@ placeholder. The placeholder will be replaced by the search term, use
 a URL was entered to be opened. Other search engines can be used by
 prepending the search engine name to the search term, for example
 :open google qutebrowser.
-

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   w = "https://en.wikipedia.org/wiki/Special:Search?search={}&go=Go&ns0=1";
   aw = "https://wiki.archlinux.org/?search={}";
   nw = "https://nixos.wiki/index.php?search={}";
@@ -6838,11 +5799,7 @@ prepending the search engine name to the search term, for example
                 
programs.qutebrowser.settings

Options to add to qutebrowser config.py file. See https://qutebrowser.org/doc/help/settings.html for options. -

Type: attribute set of anything

Default: - { - - } -

Example:

{
+

Type: attribute set of anything

Default: { }

Example:

{
   colors = {
     hints = {
       bg = "#000000";
@@ -6891,11 +5848,7 @@ now.
                     <home-manager/modules/programs/rbw.nix>
                 
programs.readline.enable

Whether to enable readline.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/readline.nix> -
programs.readline.bindings

Readline bindings.

Type: attribute set of string

Default: - { - - } -

Example:

{ "\\C-h" = "backward-kill-word"; }
+                
programs.readline.bindings

Readline bindings.

Type: attribute set of string

Default: { }

Example:

{ "\\C-h" = "backward-kill-word"; }
 

Declared by:

<home-manager/modules/programs/readline.nix>
programs.readline.extraConfig

Configuration lines appended unchanged to the end of the @@ -6905,31 +5858,21 @@ now.

programs.readline.includeSystemConfig

Whether to include the system-wide configuration.

Type: boolean

Default: true

Declared by:

<home-manager/modules/programs/readline.nix>
programs.readline.variables

Readline customization variable assignments. -

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

Default: - { - - } -

Example: - { - expand-tilde = true; - } -

Declared by:

+

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

Default: { }

Example:

{
+  expand-tilde = true;
+}

Declared by:

<home-manager/modules/programs/readline.nix>
programs.rofi.enable

Whether to enable Rofi: A window switcher, application launcher and dmenu replacement.

Type: boolean

Default: false

Example: true

Declared by:

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

Package providing the rofi binary. -

Type: package

Default: (build of rofi-1.7.5)

Example:

pkgs.rofi.override { plugins = [ pkgs.rofi-emoji ]; };
+

Type: package

Default: <derivation rofi-1.7.5>

Example:

pkgs.rofi.override { plugins = [ pkgs.rofi-emoji ]; };
 

Declared by:

<home-manager/modules/programs/rofi.nix>
programs.rofi.configPath

Path where to put generated configuration file.

Type: string

Default: "$XDG_CONFIG_HOME/rofi/config.rasi"

Declared by:

<home-manager/modules/programs/rofi.nix>
programs.rofi.cycle

Whether to cycle through the results list.

Type: null or boolean

Default: null

Declared by:

<home-manager/modules/programs/rofi.nix> -
programs.rofi.extraConfig

Additional configuration to add.

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

Default: - { - - } -

Example:

{
+                
programs.rofi.extraConfig

Additional configuration to add.

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

Default: { }

Example:

{
   modi = "drun,emoji,ssh";
   kb-primary-paste = "Control+V,Shift+Insert";
   kb-secondary-paste = "Control+v,Insert";
@@ -6949,24 +5892,16 @@ now.
 Additional examples can be found at
 https://github.com/carnager/rofi-pass/blob/master/config.example.
 

Type: strings concatenated with "\n"

Default: ""

Example:

''
-URL_field='url'
-USERNAME_field='user'
-AUTOTYPE_field='autotype'
+  URL_field='url'
+  USERNAME_field='user'
+  AUTOTYPE_field='autotype'
 ''

Declared by:

<home-manager/modules/programs/rofi-pass.nix>
programs.rofi.pass.stores

Directory roots of your password-stores. -

Type: list of string

Default: - [ - - ] -

Declared by:

+

Type: list of string

Default: [ ]

Declared by:

<home-manager/modules/programs/rofi-pass.nix>
programs.rofi.plugins

List of rofi plugins to be installed. -

Type: list of package

Default: - [ - - ] -

Example: [ pkgs.rofi-calc ]

Declared by:

+

Type: list of package

Default: [ ]

Example: [ pkgs.rofi-calc ]

Declared by:

<home-manager/modules/programs/rofi.nix>
programs.rofi.terminal

Path to the terminal which will be used to run console applications

Type: null or string

Default: null

Example: "\${pkgs.gnome.gnome_terminal}/bin/gnome-terminal"

Declared by:

@@ -7043,11 +5978,7 @@ but our default is to follow XDG.

Type: string

Default: ".sbt"

Declared by:

<home-manager/modules/programs/sbt.nix>
programs.sbt.credentials

A list of credentials to define in the sbt configuration directory. -

Type: list of (submodule)

Default: - [ - - ] -

Example:

[{
+

Type: list of (submodule)

Default: [ ]

Example:

[{
   realm = "Sonatype Nexus Repository Manager";
   host = "example.com";
   user = "user";
@@ -7066,11 +5997,7 @@ the repository.
                 
programs.sbt.credentials.*.user

The user you're using to authenticate.

Type: string

Declared by:

<home-manager/modules/programs/sbt.nix>
programs.sbt.plugins

A list of plugins to place in the sbt configuration directory. -

Type: list of (submodule)

Default: - [ - - ] -

Example:

[
+

Type: list of (submodule)

Default: [ ]

Example:

[
   {
     org = "net.virtual-void";
     artifact = "sbt-dependency-graph";
@@ -7112,11 +6039,7 @@ See
 about this configuration section and
 https://www.scala-sbt.org/1.x/docs/Proxy-Repositories.html
 to read about proxy repositories.
-

Type: list of (one of "local", "maven-central", "maven-local" or attribute set of string)

Default: - [ - - ] -

Example:

[
+

Type: list of (one of "local", "maven-central", "maven-local" or attribute set of string)

Default: [ ]

Example:

[
   "local"
   { my-ivy-proxy-releases = "http://repo.company.com/ivy-releases/, [organization]/[module]/(scala_[scalaVersion]/)(sbt_[sbtVersion]/)[revision]/[type]s/[artifact](-[classifier]).[ext]" }
   { my-maven-proxy-releases = "http://repo.company.com/maven-releases/" }
@@ -7176,11 +6099,7 @@ See Type: attribute set of (string or list of string)

Default: - { - - } -

Example:

{
+

Type: attribute set of (string or list of string)

Default: { }

Example:

{
   "move_up" = "k";
   "move_down" = "j";
   "move_left" = "h";
@@ -7193,11 +6112,7 @@ bindings of the same command.
                 
programs.sioyek.config

Input configuration written to $XDG_CONFIG_HOME/sioyek/prefs_user.config. See https://github.com/ahrm/sioyek/blob/main/pdf_viewer/prefs.config. -

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   "background_color" = "1.0 1.0 1.0";
   "text_highlight_color" = "1.0 0.0 0.0";
 }
@@ -7221,60 +6136,38 @@ ALT-C keybinding.
 

Type: null or string

Default: null

Example: "fd --type d"

Declared by:

<home-manager/modules/programs/skim.nix>
programs.skim.changeDirWidgetOptions

Command line options for the ALT-C keybinding. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "--preview 'tree -C {} | head -200'" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "--preview 'tree -C {} | head -200'"
+]

Declared by:

<home-manager/modules/programs/skim.nix>
programs.skim.defaultCommand

The command that gets executed as the default source for skim when running.

Type: null or string

Default: null

Example: "fd --type f"

Declared by:

<home-manager/modules/programs/skim.nix>
programs.skim.defaultOptions

Extra command line options given to skim by default. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "--height 40%" "--prompt ⟫" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "--height 40%"
+  "--prompt ⟫"
+]

Declared by:

<home-manager/modules/programs/skim.nix>
programs.skim.fileWidgetCommand

The command that gets executed as the source for skim for the CTRL-T keybinding.

Type: null or string

Default: null

Example: "fd --type f"

Declared by:

<home-manager/modules/programs/skim.nix>
programs.skim.fileWidgetOptions

Command line options for the CTRL-T keybinding. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "--preview 'head {}'" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "--preview 'head {}'"
+]

Declared by:

<home-manager/modules/programs/skim.nix>
programs.skim.historyWidgetOptions

Command line options for the CTRL-R keybinding. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "--tac" "--exact" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "--tac"
+  "--exact"
+]

Declared by:

<home-manager/modules/programs/skim.nix>
programs.sm64ex.enable

Whether to enable sm64ex.

Type: boolean

Default: false

Example: true

Declared by:

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

The sm64ex package to use.

Type: package

Default: (build of sm64ex-0.pre+date=2021-11-30)

Declared by:

+
programs.sm64ex.package

The sm64ex package to use.

Type: package

Default: <derivation sm64ex-0.pre+date=2021-11-30>

Declared by:

<home-manager/modules/programs/sm64ex.nix>
programs.sm64ex.baserom

The path to the Super Mario 64 baserom to extract assets from.

Type: null or path

Default: null

Example: /home/foo/baserom.us.z64

Declared by:

<home-manager/modules/programs/sm64ex.nix> @@ -7328,11 +6221,7 @@ for more information. $XDG_CONFIG_HOME/sqls/config.yml. See https://github.com/lighttiger2505/sqls#db-configuration for supported values. -

Type: YAML value

Default: - { - - } -

Example:

{
+

Type: YAML value

Default: { }

Example:

{
    lowercaseKeywords = true;
    connections = [
      {
@@ -7361,11 +6250,7 @@ for supported values.
                     <home-manager/modules/programs/ssh.nix>
                 
programs.ssh.extraOptionOverrides

Extra SSH configuration options that take precedence over any host specific configuration. -

Type: attribute set of string

Default: - { - - } -

Declared by:

+

Type: attribute set of string

Default: { }

Declared by:

<home-manager/modules/programs/ssh.nix>
programs.ssh.forwardAgent

Whether the connection to the authentication agent (if any) will be forwarded to the remote machine. @@ -7383,11 +6268,7 @@ the known hosts file. See ssh_config(5) for more information. -

Type: list of string

Default: - [ - - ] -

Declared by:

+

Type: list of string

Default: [ ]

Declared by:

<home-manager/modules/programs/ssh.nix>
programs.ssh.matchBlocks

Specify per-host settings. Note, if the order of rules matter then use the DAG functions to express the dependencies as @@ -7396,11 +6277,7 @@ shown in the example. See ssh_config(5) for more information. -

Type: list or DAG of submodules

Default: - { - - } -

Example:

{
+

Type: list or DAG of submodules

Default: { }

Example:

{
   "john.example.com" = {
     hostname = "example.com";
     user = "john";
@@ -7416,11 +6293,7 @@ for more information.
 

Type: null or one of "any", "inet", "inet6"

Default: null

Declared by:

<home-manager/modules/programs/ssh.nix>
programs.ssh.matchBlocks.<name>.certificateFile

Specifies files from which the user certificate is read. -

Type: (list of string) or null or string

Default: - [ - - ] -

Declared by:

+

Type: (list of string) or null or string

Default: [ ]

Declared by:

<home-manager/modules/programs/ssh.nix>
programs.ssh.matchBlocks.<name>.checkHostIP

Check the host IP address in the known_hosts file. @@ -7432,22 +6305,14 @@ block when null. <home-manager/modules/programs/ssh.nix>

programs.ssh.matchBlocks.<name>.dynamicForwards

Specify dynamic port forwardings. See ssh_config(5) for DynamicForward. -

Type: list of (submodule)

Default: - [ - - ] -

Example:

[ { port = 8080; } ];
+

Type: list of (submodule)

Default: [ ]

Example:

[ { port = 8080; } ];
 

Declared by:

<home-manager/modules/programs/ssh.nix>
programs.ssh.matchBlocks.<name>.dynamicForwards.*.address

The address where to bind the port.

Type: string

Default: "localhost"

Example: "example.org"

Declared by:

<home-manager/modules/programs/ssh.nix>
programs.ssh.matchBlocks.<name>.dynamicForwards.*.port

Specifies port number to bind on bind address.

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: null

Example: 8080

Declared by:

<home-manager/modules/programs/ssh.nix> -
programs.ssh.matchBlocks.<name>.extraOptions

Extra configuration options for the host.

Type: attribute set of string

Default: - { - - } -

Declared by:

+
programs.ssh.matchBlocks.<name>.extraOptions

Extra configuration options for the host.

Type: attribute set of string

Default: { }

Declared by:

<home-manager/modules/programs/ssh.nix>
programs.ssh.matchBlocks.<name>.forwardAgent

Whether the connection to the authentication agent (if any) will be forwarded to the remote machine. @@ -7481,19 +6346,11 @@ offers more identities. <home-manager/modules/programs/ssh.nix>

programs.ssh.matchBlocks.<name>.identityFile

Specifies files from which the user identity is read. Identities will be tried in the given order. -

Type: (list of string) or null or string

Default: - [ - - ] -

Declared by:

+

Type: (list of string) or null or string

Default: [ ]

Declared by:

<home-manager/modules/programs/ssh.nix>
programs.ssh.matchBlocks.<name>.localForwards

Specify local port forwardings. See ssh_config(5) for LocalForward. -

Type: list of (submodule)

Default: - [ - - ] -

Example:

[
+

Type: list of (submodule)

Default: [ ]

Example:

[
   {
     bind.port = 8080;
     host.address = "10.0.0.13";
@@ -7517,8 +6374,8 @@ This option takes precedence over
 ssh.matchBlocks.*.host
 if defined.
 

Type: null or string

Default: null

Example:

''
-host <hostname> canonical
-host <hostname> exec "ping -c1 -q 192.168.17.1"''

Declared by:

+ host <hostname> canonical + host <hostname> exec "ping -c1 -q 192.168.17.1"''

Declared by:

<home-manager/modules/programs/ssh.nix>
programs.ssh.matchBlocks.<name>.port

Specifies port number to connect on remote host.

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: null

Declared by:

<home-manager/modules/programs/ssh.nix> @@ -7528,11 +6385,7 @@ host <hostname> exec "ping -c1 -q 192.168.17.1"''

programs.ssh.matchBlocks.<name>.remoteForwards

Specify remote port forwardings. See ssh_config(5) for RemoteForward. -

Type: list of (submodule)

Default: - [ - - ] -

Example:

[
+

Type: list of (submodule)

Default: [ ]

Example:

[
   {
     bind.port = 8080;
     host.address = "10.0.0.13";
@@ -7551,11 +6404,7 @@ host <hostname> exec "ping -c1 -q 192.168.17.1"''

programs.ssh.matchBlocks.<name>.sendEnv

Environment variables to send from the local host to the server. -

Type: list of string

Default: - [ - - ] -

Declared by:

+

Type: list of string

Default: [ ]

Declared by:

<home-manager/modules/programs/ssh.nix>
programs.ssh.matchBlocks.<name>.serverAliveCountMax

Sets the number of server alive messages which may be sent without SSH receiving any messages back from the server. @@ -7601,11 +6450,7 @@ database, separated by whitespace. The default is

See https://starship.rs/config/ for the full list of options. -

Type: Starship configuration

Default: - { - - } -

Example:

{
+

Type: Starship configuration

Default: { }

Example:

{
   add_newline = false;
   format = lib.concatStrings [
     "$line_break"
@@ -7623,15 +6468,14 @@ of options.
                     <home-manager/modules/programs/starship.nix>
                 
programs.swaylock.settings

Default arguments to swaylock. An empty set disables configuration generation. -

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

Default: - { - - } -

Example: - { - color = "808080"; font-size = 24; indicator-idle-visible = false; indicator-radius = 100; line-color = "ffffff"; show-failed-attempts = true; - } -

Declared by:

+

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

Default: { }

Example:

{
+  color = "808080";
+  font-size = 24;
+  indicator-idle-visible = false;
+  indicator-radius = 100;
+  line-color = "ffffff";
+  show-failed-attempts = true;
+}

Declared by:

<home-manager/modules/programs/swaylock.nix>
programs.taskwarrior.enable

Whether to enable Task Warrior.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/taskwarrior.nix> @@ -7641,11 +6485,7 @@ path to a theme configuration file. <home-manager/modules/programs/taskwarrior.nix>
programs.taskwarrior.config

Key-value configuration written to $XDG_CONFIG_HOME/task/taskrc. -

Type: attribute set of anything

Default: - { - - } -

Example:

{
+

Type: attribute set of anything

Default: { }

Example:

{
   confirmation = false;
   report.minimal.filter = "status:pending";
   report.active.columns = [ "id" "start" "entry.age" "priority" "project" "due" "description" ];
@@ -7690,18 +6530,14 @@ for more information.
                     <home-manager/modules/programs/tealdeer.nix>
                 
programs.terminator.enable

Whether to enable terminator, a tiling terminal emulator.

Type: boolean

Default: false

Example: true

Declared by:

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

terminator package to install.

Type: package

Default: (build of terminator-2.1.1)

Example: pkgs.terminator

Declared by:

+
programs.terminator.package

terminator package to install.

Type: package

Default: <derivation terminator-2.1.1>

Example: pkgs.terminator

Declared by:

<home-manager/modules/programs/terminator.nix>
programs.terminator.config

configuration for terminator.

For a list of all possible options refer to the terminator_config(5) man page. -

Type: attribute set of anything

Default: - { - - } -

Example:

{
+

Type: attribute set of anything

Default: { }

Example:

{
   global_config.borderless = true;
   profiles.default.background_color = "#002b36";
 }
@@ -7727,9 +6563,9 @@ Only enabled if a browser is configured or detected.
 

Type: null or boolean

Default: null

Declared by:

<home-manager/modules/programs/termite.nix>
programs.termite.colorsExtra

Extra colors options that should be added to [colors] section.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-color0 = #3f3f3f
-color1 = #705050
-color2 = #60b48a
+  color0 = #3f3f3f
+  color1 = #705050
+  color2 = #60b48a
 ''

Declared by:

<home-manager/modules/programs/termite.nix>
programs.termite.cursorBlink

Specify the how the terminal's cursor should behave. @@ -7835,11 +6671,7 @@ default profile. <home-manager/modules/programs/thunderbird.nix>

programs.thunderbird.profiles.<name>.settings

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

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

Default: - { - - } -

Example:

{
+

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

Default: { }

Example:

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

Declared by:

@@ -7848,11 +6680,7 @@ default profile. <home-manager/modules/programs/thunderbird.nix>
programs.thunderbird.settings

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

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

Default: - { - - } -

Example:

{
+

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

Default: { }

Example:

{
   "general.useragent.override" = "";
   "privacy.donottrackheader.enabled" = true;
 }
@@ -7958,11 +6786,7 @@ are running.
                 
programs.tmux.plugins

List of tmux plugins to be included at the end of your tmux configuration. The sensible plugin, however, is defaulted to run at the top of your configuration. -

Type: list of plugin packages or submodules

Default: - [ - - ] -

Example:

with pkgs; [
+

Type: list of plugin packages or submodules

Default: [ ]

Example:

with pkgs; [
   tmuxPlugins.cpu
   {
     plugin = tmuxPlugins.resurrect;
@@ -8033,43 +6857,23 @@ of options.
                     <home-manager/modules/programs/urxvt.nix>
                 
programs.urxvt.package

rxvt-unicode package to install.

Type: package

Default: pkgs.rxvt-unicode

Declared by:

<home-manager/modules/programs/urxvt.nix> -
programs.urxvt.extraConfig

Additional configuration to add.

Type: attribute set of anything

Default: - { - - } -

Example: - { - shading = 15; - } -

Declared by:

+
programs.urxvt.extraConfig

Additional configuration to add.

Type: attribute set of anything

Default: { }

Example:

{
+  shading = 15;
+}

Declared by:

<home-manager/modules/programs/urxvt.nix> -
programs.urxvt.fonts

List of fonts to be used.

Type: list of string

Default: - [ - - ] -

Example: - [ - "xft:Droid Sans Mono Nerd Font:size=9" - ] -

Declared by:

+
programs.urxvt.fonts

List of fonts to be used.

Type: list of string

Default: [ ]

Example:

[
+  "xft:Droid Sans Mono Nerd Font:size=9"
+]

Declared by:

<home-manager/modules/programs/urxvt.nix>
programs.urxvt.iso14755

ISO14755 support for viewing and entering unicode characters.

Type: boolean

Default: true

Declared by:

<home-manager/modules/programs/urxvt.nix> -
programs.urxvt.keybindings

Mapping of keybindings to actions

Type: attribute set of string

Default: - { - - } -

Example:

{
+                
programs.urxvt.keybindings

Mapping of keybindings to actions

Type: attribute set of string

Default: { }

Example:

{
   "Shift-Control-C" = "eval:selection_to_clipboard";
   "Shift-Control-V" = "eval:paste_clipboard";
 }
 

Declared by:

<home-manager/modules/programs/urxvt.nix> -
programs.urxvt.scroll.bar

Scrollbar settings.

Type: submodule

Default: - { - - } -

Declared by:

+
programs.urxvt.scroll.bar

Scrollbar settings.

Type: submodule

Default: { }

Declared by:

<home-manager/modules/programs/urxvt.nix>
programs.urxvt.scroll.bar.enable

Whether to enable the scrollbar

Type: boolean

Default: true

Declared by:

<home-manager/modules/programs/urxvt.nix> @@ -8100,8 +6904,8 @@ of options.
programs.vim.packageConfigurable

Configurable vim package

Type: package

Default: "pkgs.vim_configurable"

Declared by:

<home-manager/modules/programs/vim.nix>
programs.vim.extraConfig

Custom .vimrc lines

Type: strings concatenated with "\n"

Default: ""

Example:

''
-set nocompatible
-set nobackup
+  set nocompatible
+  set nobackup
 ''

Declared by:

<home-manager/modules/programs/vim.nix>
programs.vim.plugins

List of vim plugins to install. To get a list of supported plugins run: @@ -8110,11 +6914,9 @@ set nobackup

Note: String values are deprecated, please use actual packages. -

Type: list of (string or package)

Default: - [ - (build of vimplugin-vim-sensible-2022-08-26) - ] -

Example: [ pkgs.vimPlugins.YankRing ]

Declared by:

+

Type: list of (string or package)

Default:

[
+  <derivation vimplugin-vim-sensible-2022-12-03>
+]

Example: [ pkgs.vimPlugins.YankRing ]

Declared by:

<home-manager/modules/programs/vim.nix>
programs.vim.settings

At attribute set of Vim settings. The attribute names and corresponding values must be among the following supported @@ -8125,11 +6927,7 @@ options. See the Vim documentation for detailed descriptions of these options. Note, use extraConfig to manually set any options not listed above. -

Type: submodule

Default: - { - - } -

Example:

{
+

Type: submodule

Default: { }

Example:

{
   expandtab = true;
   history = 1000;
   background = "dark";
@@ -8145,14 +6943,10 @@ manually set any options not listed above.
 

Type: boolean

Default: true

Declared by:

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

Version of Visual Studio Code to install. -

Type: package

Default: (build of vscode-1.73.1)

Example: pkgs.vscodium

Declared by:

+

Type: package

Default: <derivation vscode-1.73.1>

Example: pkgs.vscodium

Declared by:

<home-manager/modules/programs/vscode.nix>
programs.vscode.extensions

The extensions Visual Studio Code should be started with. -

Type: list of package

Default: - [ - - ] -

Example: [ pkgs.vscode-extensions.bbenoist.nix ]

Declared by:

+

Type: list of package

Default: [ ]

Example: [ pkgs.vscode-extensions.bbenoist.nix ]

Declared by:

<home-manager/modules/programs/vscode.nix>
programs.vscode.haskell.enable

Whether to enable Haskell integration for Visual Studio Code.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/vscode/haskell.nix> @@ -8171,11 +6965,7 @@ overlay or set this option. Example overlay configuration: <home-manager/modules/programs/vscode/haskell.nix>
programs.vscode.keybindings

Keybindings written to Visual Studio Code's keybindings.json. -

Type: list of (submodule)

Default: - [ - - ] -

Example:

[
+

Type: list of (submodule)

Default: [ ]

Example:

[
   {
     key = "ctrl+c";
     command = "editor.action.clipboardCopyAction";
@@ -8184,11 +6974,9 @@ overlay or set this option. Example overlay configuration:
 ]
 

Declared by:

<home-manager/modules/programs/vscode.nix> -
programs.vscode.keybindings.*.args

Optional arguments for a command.

Type: null or JSON value

Default: null

Example: - { - direction = "up"; - } -

Declared by:

+
programs.vscode.keybindings.*.args

Optional arguments for a command.

Type: null or JSON value

Default: null

Example:

{
+  direction = "up";
+}

Declared by:

<home-manager/modules/programs/vscode.nix>
programs.vscode.keybindings.*.command

The VS Code command to execute.

Type: string

Example: "editor.action.clipboardCopyAction"

Declared by:

<home-manager/modules/programs/vscode.nix> @@ -8202,11 +6990,7 @@ or by Visual Studio Code. <home-manager/modules/programs/vscode.nix>
programs.vscode.userSettings

Configuration written to Visual Studio Code's settings.json. -

Type: JSON value

Default: - { - - } -

Example:

{
+

Type: JSON value

Default: { }

Example:

{
   "files.autoSave" = "off";
   "[nix]"."editor.tabSize" = 2;
 }
@@ -8214,11 +6998,7 @@ or by Visual Studio Code.
                     <home-manager/modules/programs/vscode.nix>
                 
programs.vscode.userTasks

Configuration written to Visual Studio Code's tasks.json. -

Type: JSON value

Default: - { - - } -

Example:

{
+

Type: JSON value

Default: { }

Example:

{
   version = "2.0.0";
   tasks = [
     {
@@ -8246,11 +7026,7 @@ or by Visual Studio Code.
 

See https://github.com/TailorDev/Watson/blob/master/docs/user-guide/configuration.md for an example configuration. -

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: { }

Example:

{
   backend = {
     url = "https://api.crick.fr";
     token = "yourapitoken";
@@ -8277,11 +7053,7 @@ for an example configuration.
                     <home-manager/modules/programs/waybar.nix>
                 
programs.waybar.settings

Configuration for Waybar, see https://github.com/Alexays/Waybar/wiki/Configuration for supported values. -

Type: (list of (JSON value)) or attribute set of (JSON value)

Default: - [ - - ] -

Example:

{
+

Type: (list of (JSON value)) or attribute set of (JSON value)

Default: [ ]

Example:

{
   mainBar = {
     layer = "top";
     position = "top";
@@ -8317,18 +7089,18 @@ for the documentation.
 

If the value is set to a path literal, then the path will be used as the css file.

Type: null or path or string

Default: null

Example:

''
-* {
-  border: none;
-  border-radius: 0;
-  font-family: Source Code Pro;
-}
-window#waybar {
-  background: #16191C;
-  color: #AAB2BF;
-}
-#workspaces button {
-  padding: 0 5px;
-}
+  * {
+    border: none;
+    border-radius: 0;
+    font-family: Source Code Pro;
+  }
+  window#waybar {
+    background: #16191C;
+    color: #AAB2BF;
+  }
+  #workspaces button {
+    padding: 0 5px;
+  }
 ''

Declared by:

<home-manager/modules/programs/waybar.nix>
programs.waybar.systemd.enable

Whether to enable Waybar systemd integration.

Type: boolean

Default: false

Example: true

Declared by:

@@ -8349,11 +7121,7 @@ otherwise the service may never be started. taken as the name of the corresponding color scheme. See https://wezfurlong.org/wezterm/config/appearance.html#defining-a-color-scheme-in-a-separate-file for more details of the TOML color scheme format. -

Type: attribute set of (TOML value)

Default: - { - - } -

Example:

myCoolTheme = {
+

Type: attribute set of (TOML value)

Default: { }

Example:

myCoolTheme = {
   ansi = [
     "#222222" "#D14949" "#48874F" "#AFA75A"
     "#599797" "#8F6089" "#5C9FA8" "#8C8C8C"
@@ -8377,7 +7145,7 @@ for more details of the TOML color scheme format.
 https://wezfurlong.org/wezterm/config/files.html
 how to configure.
 

Type: strings concatenated with "\n"

Default:

''
-return {}
+  return {}
 ''

Example:

-- Your lua code / config here
 local mylib = require 'mylib';
 return {
@@ -8431,8 +7199,8 @@ for options.
                 
programs.yt-dlp.extraConfig

Extra configuration to add to $XDG_CONFIG_HOME/yt-dlp/config.

Type: strings concatenated with "\n"

Default: ""

Example:

''
---update
--F
+  --update
+  -F
 ''

Declared by:

<home-manager/modules/programs/yt-dlp.nix>
programs.yt-dlp.settings

Configuration written to @@ -8443,11 +7211,7 @@ example, update = true; instead of Short options can be specified in the extraConfig option. See https://github.com/yt-dlp/yt-dlp#configuration for explanation about possible values. -

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

Default: - { - - } -

Example:

{
+

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

Default: { }

Example:

{
   embed-thumbnail = true;
   embed-subs = true;
   sub-langs = "all";
@@ -8471,15 +7235,11 @@ for explanation about possible values.
 

Type: boolean

Default: true

Declared by:

<home-manager/modules/programs/z-lua.nix>
programs.z-lua.options

List of options to pass to z.lua. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "enhanced" "once" "fzf" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "enhanced"
+  "once"
+  "fzf"
+]

Declared by:

<home-manager/modules/programs/z-lua.nix>
programs.zathura.enable

Whether to enable Zathura, a highly customizable and functional document viewer focused on keyboard interaction.

Type: boolean

Default: false

Example: true

Declared by:

@@ -8494,29 +7254,19 @@ focused on keyboard interaction.

Type:zathurarc(5) for the full list of possible mappings. -

Type: attribute set of string

Default: - { - - } -

Example: - { - <Right> = "navigate next"; D = "toggle_page_mode"; - } -

Declared by:

+

Type: attribute set of string

Default: { }

Example:

{
+  "<Right>" = "navigate next";
+  D = "toggle_page_mode";
+}

Declared by:

<home-manager/modules/programs/zathura.nix>
programs.zathura.options

Add :set command options to zathura and make them permanent. See zathurarc(5) for the full list of options. -

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

Default: - { - - } -

Example: - { - default-bg = "#000000"; default-fg = "#FFFFFF"; - } -

Declared by:

+

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

Default: { }

Example:

{
+  default-bg = "#000000";
+  default-fg = "#FFFFFF";
+}

Declared by:

<home-manager/modules/programs/zathura.nix>
programs.zellij.enable

Whether to enable zellij.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/zellij.nix> @@ -8528,11 +7278,7 @@ for the full list of options.

See https://zellij.dev/documentation for the full list of options. -

Type: YAML value

Default: - { - - } -

Example:

{
+

Type: YAML value

Default: { }

Example:

{
   theme = "custom";
   themes.custom.fg = 5;
 }
@@ -8553,15 +7299,9 @@ list of options.
 

Type: package

Default: pkgs.zoxide

Declared by:

<home-manager/modules/programs/zoxide.nix>
programs.zoxide.options

List of options to pass to zoxide. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "--no-aliases" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "--no-aliases"
+]

Declared by:

<home-manager/modules/programs/zoxide.nix>
programs.zsh.enable

Whether to enable Z shell (Zsh).

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/zsh.nix> @@ -8585,22 +7325,14 @@ directory.

Type: null or boolean

Default: null

Declared by:

<home-manager/modules/programs/zsh.nix>
programs.zsh.cdpath

List of paths to autocomplete calls to `cd`. -

Type: list of string

Default: - [ - - ] -

Declared by:

+

Type: list of string

Default: [ ]

Declared by:

<home-manager/modules/programs/zsh.nix>
programs.zsh.completionInit

Initialization commands to run when completion is enabled.

Type: strings concatenated with "\n"

Default: "autoload -U compinit && compinit"

Declared by:

<home-manager/modules/programs/zsh.nix>
programs.zsh.defaultKeymap

The default base keymap to use.

Type: null or one of "emacs", "vicmd", "viins"

Default: null

Example: "emacs"

Declared by:

<home-manager/modules/programs/zsh.nix>
programs.zsh.dirHashes

An attribute set that adds to named directory hash table. -

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   docs  = "$HOME/Documents";
   vids  = "$HOME/Videos";
   dl    = "$HOME/Downloads";
@@ -8614,11 +7346,7 @@ directory.
                     <home-manager/modules/programs/zsh.nix>
                 
programs.zsh.envExtra

Extra commands that should be added to .zshenv.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/programs/zsh.nix> -
programs.zsh.history

Options related to commands history configuration.

Type: submodule

Default: - { - - } -

Declared by:

+
programs.zsh.history

Options related to commands history configuration.

Type: submodule

Default: { }

Declared by:

<home-manager/modules/programs/zsh.nix>
programs.zsh.history.expireDuplicatesFirst

Expire duplicates first.

Type: boolean

Default: false

Declared by:

<home-manager/modules/programs/zsh.nix> @@ -8630,11 +7358,7 @@ if they are duplicates of the previous event. <home-manager/modules/programs/zsh.nix>
programs.zsh.history.ignorePatterns

Do not enter command lines into the history list if they match any one of the given shell patterns. -

Type: list of string

Default: - [ - - ] -

Example: [ "rm *" "pkill *" ]

Declared by:

+

Type: list of string

Default: [ ]

Example: [ "rm *" "pkill *" ]

Declared by:

<home-manager/modules/programs/zsh.nix>
programs.zsh.history.ignoreSpace

Do not enter command lines into the history list if the first character is a space. @@ -8650,11 +7374,7 @@ if the first character is a space. <home-manager/modules/programs/zsh.nix>

programs.zsh.history.size

Number of history lines to keep.

Type: signed integer

Default: 10000

Declared by:

<home-manager/modules/programs/zsh.nix> -
programs.zsh.historySubstringSearch

Options related to zsh-history-substring-search.

Type: submodule

Default: - { - - } -

Declared by:

+
programs.zsh.historySubstringSearch

Options related to zsh-history-substring-search.

Type: submodule

Default: { }

Declared by:

<home-manager/modules/programs/zsh.nix>
programs.zsh.historySubstringSearch.enable

Whether to enable history substring search.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/zsh.nix> @@ -8673,29 +7393,18 @@ The default of ^[[A corresponds to the UP key.
programs.zsh.initExtraFirst

Commands that should be added to top of .zshrc.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/programs/zsh.nix>
programs.zsh.localVariables

Extra local variables defined at the top of .zshrc. -

Type: attribute set

Default: - { - - } -

Example: - { - POWERLEVEL9K_LEFT_PROMPT_ELEMENTS = - [ - "dir" "vcs" - ] - ; - } -

Declared by:

+

Type: attribute set

Default: { }

Example:

{
+  POWERLEVEL9K_LEFT_PROMPT_ELEMENTS = [
+    "dir"
+    "vcs"
+  ];
+}

Declared by:

<home-manager/modules/programs/zsh.nix>
programs.zsh.loginExtra

Extra commands that should be added to .zlogin.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/programs/zsh.nix>
programs.zsh.logoutExtra

Extra commands that should be added to .zlogout.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/programs/zsh.nix> -
programs.zsh.oh-my-zsh

Options to configure oh-my-zsh.

Type: submodule

Default: - { - - } -

Declared by:

+
programs.zsh.oh-my-zsh

Options to configure oh-my-zsh.

Type: submodule

Default: { }

Declared by:

<home-manager/modules/programs/zsh.nix>
programs.zsh.oh-my-zsh.enable

Whether to enable oh-my-zsh.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/zsh.nix> @@ -8706,28 +7415,19 @@ for more information. <home-manager/modules/programs/zsh.nix>
programs.zsh.oh-my-zsh.extraConfig

Extra settings for plugins.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-zstyle :omz:plugins:ssh-agent identities id_rsa id_rsa2 id_github
+  zstyle :omz:plugins:ssh-agent identities id_rsa id_rsa2 id_github
 ''

Declared by:

<home-manager/modules/programs/zsh.nix>
programs.zsh.oh-my-zsh.plugins

List of oh-my-zsh plugins -

Type: list of string

Default: - [ - - ] -

Example: - [ - "git" "sudo" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "git"
+  "sudo"
+]

Declared by:

<home-manager/modules/programs/zsh.nix>
programs.zsh.oh-my-zsh.theme

Name of the theme to be used by oh-my-zsh.

Type: string

Default: ""

Example: "robbyrussell"

Declared by:

<home-manager/modules/programs/zsh.nix> -
programs.zsh.plugins

Plugins to source in .zshrc.

Type: list of (submodule)

Default: - [ - - ] -

Example:

[
+                
programs.zsh.plugins

Plugins to source in .zshrc.

Type: list of (submodule)

Default: [ ]

Example:

[
   {
     # will source zsh-autosuggestions.plugin.zsh
     name = "zsh-autosuggestions";
@@ -8764,11 +7464,7 @@ if the script name does not follow convention.
 Will be added to fpath and PATH.
 

Type: path

Declared by:

<home-manager/modules/programs/zsh.nix> -
programs.zsh.prezto

Options to configure prezto.

Type: submodule

Default: - { - - } -

Declared by:

+
programs.zsh.prezto

Options to configure prezto.

Type: submodule

Default: { }

Declared by:

<home-manager/modules/programs/zsh/prezto.nix>
programs.zsh.prezto.enable

Whether to enable prezto.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/zsh/prezto.nix> @@ -8778,15 +7474,10 @@ Will be added to fpath and PATH
programs.zsh.prezto.color

Color output (auto set to 'no' on dumb terminals)

Type: null or boolean

Default: true

Example: false

Declared by:

<home-manager/modules/programs/zsh/prezto.nix> -
programs.zsh.prezto.completions.ignoredHosts

Set the entries to ignore in static */etc/hosts* for host completion.

Type: list of string

Default: - [ - - ] -

Example: - [ - "0.0.0.0" "127.0.0.1" - ] -

Declared by:

+
programs.zsh.prezto.completions.ignoredHosts

Set the entries to ignore in static */etc/hosts* for host completion.

Type: list of string

Default: [ ]

Example:

[
+  "0.0.0.0"
+  "127.0.0.1"
+]

Declared by:

<home-manager/modules/programs/zsh/prezto.nix>
programs.zsh.prezto.editor.dotExpansion

Auto convert .... to ../..

Type: null or boolean

Default: null

Example: true

Declared by:

<home-manager/modules/programs/zsh/prezto.nix> @@ -8797,25 +7488,15 @@ Will be added to fpath and PATH
programs.zsh.prezto.extraConfig

Additional configuration to add to .zpreztorc.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/programs/zsh/prezto.nix> -
programs.zsh.prezto.extraFunctions

Set the Zsh functions to load (man zshcontrib).

Type: list of string

Default: - [ - - ] -

Example: - [ - "zargs" "zmv" - ] -

Declared by:

+
programs.zsh.prezto.extraFunctions

Set the Zsh functions to load (man zshcontrib).

Type: list of string

Default: [ ]

Example:

[
+  "zargs"
+  "zmv"
+]

Declared by:

<home-manager/modules/programs/zsh/prezto.nix> -
programs.zsh.prezto.extraModules

Set the Zsh modules to load (man zshmodules).

Type: list of string

Default: - [ - - ] -

Example: - [ - "attr" "stat" - ] -

Declared by:

+
programs.zsh.prezto.extraModules

Set the Zsh modules to load (man zshmodules).

Type: list of string

Default: [ ]

Example:

[
+  "attr"
+  "stat"
+]

Declared by:

<home-manager/modules/programs/zsh/prezto.nix>
programs.zsh.prezto.git.submoduleIgnore

Ignore submodules when they are 'dirty', 'untracked', 'all', or 'none'.

Type: null or one of "dirty", "untracked", "all", "none"

Default: null

Example: "all"

Declared by:

<home-manager/modules/programs/zsh/prezto.nix> @@ -8829,21 +7510,21 @@ Will be added to fpath and PATH
programs.zsh.prezto.macOS.dashKeyword

Set the keyword used by `mand` to open man pages in Dash.app

Type: null or string

Default: null

Example: "manpages"

Declared by:

<home-manager/modules/programs/zsh/prezto.nix> -
programs.zsh.prezto.pmoduleDirs

Add additional directories to load prezto modules from

Type: list of path

Default: - [ - - ] -

Example: - [ - "$HOME/.zprezto-contrib" - ] -

Declared by:

+
programs.zsh.prezto.pmoduleDirs

Add additional directories to load prezto modules from

Type: list of path

Default: [ ]

Example:

[
+  "$HOME/.zprezto-contrib"
+]

Declared by:

<home-manager/modules/programs/zsh/prezto.nix> -
programs.zsh.prezto.pmodules

Set the Prezto modules to load (browse modules). The order matters.

Type: list of string

Default: - [ - "environment" "terminal" "editor" "history" "directory" "spectrum" "utility" "completion" "prompt" - ] -

Declared by:

+
programs.zsh.prezto.pmodules

Set the Prezto modules to load (browse modules). The order matters.

Type: list of string

Default:

[
+  "environment"
+  "terminal"
+  "editor"
+  "history"
+  "directory"
+  "spectrum"
+  "utility"
+  "completion"
+  "prompt"
+]

Declared by:

<home-manager/modules/programs/zsh/prezto.nix>
programs.zsh.prezto.prompt.pwdLength

Set the working directory prompt display length. By default, it is set to 'short'. Set it to 'long' (without '~' expansion) for @@ -8865,46 +7546,31 @@ Will be added to fpath and PATH

programs.zsh.prezto.screen.autoStartRemote

Auto start a session when Zsh is launched in a SSH connection.

Type: null or boolean

Default: null

Example: true

Declared by:

<home-manager/modules/programs/zsh/prezto.nix> -
programs.zsh.prezto.ssh.identities

Set the SSH identities to load into the agent.

Type: list of string

Default: - [ - - ] -

Example: - [ - "id_rsa" "id_rsa2" "id_github" - ] -

Declared by:

+
programs.zsh.prezto.ssh.identities

Set the SSH identities to load into the agent.

Type: list of string

Default: [ ]

Example:

[
+  "id_rsa"
+  "id_rsa2"
+  "id_github"
+]

Declared by:

<home-manager/modules/programs/zsh/prezto.nix>
programs.zsh.prezto.syntaxHighlighting.highlighters

Set syntax highlighters. By default, only the main - highlighter is enabled.

Type: list of string

Default: - [ - - ] -

Example: - [ - "main" "brackets" "pattern" "line" "cursor" "root" - ] -

Declared by:

+ highlighter is enabled.

Type: list of string

Default: [ ]

Example:

[
+  "main"
+  "brackets"
+  "pattern"
+  "line"
+  "cursor"
+  "root"
+]

Declared by:

<home-manager/modules/programs/zsh/prezto.nix> -
programs.zsh.prezto.syntaxHighlighting.pattern

Set syntax pattern styles.

Type: attribute set of string

Default: - { - - } -

Example: - { - rm*-rf* = "fg=white,bold,bg=red"; - } -

Declared by:

+
programs.zsh.prezto.syntaxHighlighting.pattern

Set syntax pattern styles.

Type: attribute set of string

Default: { }

Example:

{
+  "rm*-rf*" = "fg=white,bold,bg=red";
+}

Declared by:

<home-manager/modules/programs/zsh/prezto.nix> -
programs.zsh.prezto.syntaxHighlighting.styles

Set syntax highlighting styles.

Type: attribute set of string

Default: - { - - } -

Example: - { - builtin = "bg=blue"; command = "bg=blue"; function = "bg=blue"; - } -

Declared by:

+
programs.zsh.prezto.syntaxHighlighting.styles

Set syntax highlighting styles.

Type: attribute set of string

Default: { }

Example:

{
+  builtin = "bg=blue";
+  command = "bg=blue";
+  function = "bg=blue";
+}

Declared by:

<home-manager/modules/programs/zsh/prezto.nix>
programs.zsh.prezto.terminal.autoTitle

Auto set the tab and window titles.

Type: null or boolean

Default: null

Example: true

Declared by:

<home-manager/modules/programs/zsh/prezto.nix> @@ -8928,23 +7594,13 @@ Will be added to fpath and PATH
programs.zsh.profileExtra

Extra commands that should be added to .zprofile.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/programs/zsh.nix> -
programs.zsh.sessionVariables

Environment variables that will be set for zsh session.

Type: attribute set

Default: - { - - } -

Example: - { - MAILCHECK = 30; - } -

Declared by:

+
programs.zsh.sessionVariables

Environment variables that will be set for zsh session.

Type: attribute set

Default: { }

Example:

{
+  MAILCHECK = 30;
+}

Declared by:

<home-manager/modules/programs/zsh.nix>
programs.zsh.shellAliases

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

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   ll = "ls -l";
   ".." = "cd ..";
 }
@@ -8952,11 +7608,7 @@ this option) to command strings or directly to build outputs.
                     <home-manager/modules/programs/zsh.nix>
                 
programs.zsh.shellGlobalAliases

Similar to programs.zsh.shellAliases, but are substituted anywhere on a line. -

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   UUID = "$(uuidgen | tr -d \\n)";
   G = "| grep";
 }
@@ -8964,19 +7616,11 @@ but are substituted anywhere on a line.
                     <home-manager/modules/programs/zsh.nix>
                 
programs.zsh.zplug.enable

Whether to enable zplug - a zsh plugin manager.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/zplug.nix> -
programs.zsh.zplug.plugins

List of zplug plugins.

Type: list of (submodule)

Default: - [ - - ] -

Declared by:

+
programs.zsh.zplug.plugins

List of zplug plugins.

Type: list of (submodule)

Default: [ ]

Declared by:

<home-manager/modules/programs/zplug.nix>
programs.zsh.zplug.plugins.*.name

The name of the plugin.

Type: string

Declared by:

<home-manager/modules/programs/zplug.nix> -
programs.zsh.zplug.plugins.*.tags

The plugin tags.

Type: list of string

Default: - [ - - ] -

Declared by:

+
programs.zsh.zplug.plugins.*.tags

The plugin tags.

Type: list of string

Default: [ ]

Declared by:

<home-manager/modules/programs/zplug.nix>
programs.zsh.zplug.zplugHome

Path to zplug home directory.

Type: path

Default: "~/.zplug"

Declared by:

<home-manager/modules/programs/zplug.nix> @@ -9022,11 +7666,7 @@ Port defaults to 24800. <home-manager/modules/services/betterlockscreen.nix>
services.betterlockscreen.package

Package providing betterlockscreen.

Type: package

Default: pkgs.betterlockscreen

Declared by:

<home-manager/modules/services/betterlockscreen.nix> -
services.betterlockscreen.arguments

List of arguments appended to ./betterlockscreen --lock [args]

Type: list of string

Default: - [ - - ] -

Declared by:

+
services.betterlockscreen.arguments

List of arguments appended to ./betterlockscreen --lock [args]

Type: list of string

Default: [ ]

Declared by:

<home-manager/modules/services/betterlockscreen.nix>
services.betterlockscreen.inactiveInterval

Value used for services.screen-locker.inactiveInterval.

Type: signed integer

Default: 10

Declared by:

@@ -9057,7 +7697,7 @@ for more information about the format. <home-manager/modules/services/cbatticon.nix>
services.cbatticon.commandCriticalLevel

Command to execute when the critical battery level is reached.

Type: null or strings concatenated with "\n"

Default: null

Example:

''
-notify-send "battery critical!"
+  notify-send "battery critical!"
 ''

Declared by:

<home-manager/modules/services/cbatticon.nix>
services.cbatticon.commandLeftClick

Command to execute when left clicking on the tray icon. @@ -9091,9 +7731,9 @@ perform scripted actions on windows as they are created.

services.devilspie2.config

Content of file placed in the devilspie2 config directory.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-if (get_window_class() == "Gnome-terminal") then
-    make_always_on_top();
-end
+  if (get_window_class() == "Gnome-terminal") then
+      make_always_on_top();
+  end
 ''

Declared by:

<home-manager/modules/services/devilspie2.nix>
services.dropbox.enable

Whether to enable Dropbox daemon.

Type: boolean

Default: false

Example: true

Declared by:

@@ -9113,11 +7753,11 @@ from the immutable one, useful in scenarios where live reloading is desired.

Type: string or path

Default: "$XDG_CONFIG_HOME/dunst/dunstrc"

Declared by:

<home-manager/modules/services/dunst.nix> -
services.dunst.iconTheme

Set the icon theme.

Type: submodule

Default: - { - name = "hicolor"; package = (build of hicolor-icon-theme-0.17); size = "32x32"; - } -

Declared by:

+
services.dunst.iconTheme

Set the icon theme.

Type: submodule

Default:

{
+  name = "hicolor";
+  package = <derivation hicolor-icon-theme-0.17>;
+  size = "32x32";
+}

Declared by:

<home-manager/modules/services/dunst.nix>
services.dunst.iconTheme.package

Package providing the theme.

Type: package

Example: pkgs.gnome.adwaita-icon-theme

Declared by:

<home-manager/modules/services/dunst.nix> @@ -9125,11 +7765,7 @@ desired. <home-manager/modules/services/dunst.nix>
services.dunst.iconTheme.size

The desired icon size.

Type: string

Default: "32x32"

Example: "16x16"

Declared by:

<home-manager/modules/services/dunst.nix> -
services.dunst.settings

Configuration written to $XDG_CONFIG_HOME/dunst/dunstrc.

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

Default: - { - - } -

Example:

{
+                
services.dunst.settings

Configuration written to $XDG_CONFIG_HOME/dunst/dunstrc.

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

Default: { }

Example:

{
   global = {
     width = 300;
     height = 300;
@@ -9156,11 +7792,7 @@ desired.
                     <home-manager/modules/services/dwm-status.nix>
                 
services.dwm-status.package

Which dwm-status package to use.

Type: package

Default: pkgs.dwm-status

Example: "pkgs.dwm-status.override { enableAlsaUtils = false; }"

Declared by:

<home-manager/modules/services/dwm-status.nix> -
services.dwm-status.extraConfig

Extra config of dwm-status.

Type: JSON value

Default: - { - - } -

Example:

{
+                
services.dwm-status.extraConfig

Extra config of dwm-status.

Type: JSON value

Default: { }

Example:

{
   separator = "#";
 
   battery = {
@@ -9195,26 +7827,19 @@ else pkgs.emacs
                 
services.emacs.client.enable

Whether to enable generation of Emacs client desktop file.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/emacs.nix>
services.emacs.client.arguments

Command-line arguments to pass to emacsclient. -

Type: list of string

Default: - [ - "-c" - ] -

Declared by:

+

Type: list of string

Default:

[
+  "-c"
+]

Declared by:

<home-manager/modules/services/emacs.nix>
services.emacs.defaultEditor

Whether to configure emacsclient as the default editor using the EDITOR environment variable.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/emacs.nix>
services.emacs.extraOptions

Extra command-line arguments to pass to emacs. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "-f" "exwm-enable" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "-f"
+  "exwm-enable"
+]

Declared by:

<home-manager/modules/services/emacs.nix>
services.emacs.socketActivation.enable

Whether to enable systemd socket activation for the Emacs service.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/emacs.nix> @@ -9228,15 +7853,9 @@ editor using the EDITOR environment variable.
services.espanso.settings

The Espanso configuration to use. See https://espanso.org/docs/configuration/ for a description of available options. -

Type: YAML value

Default: - { - matches = - [ - - ] - ; - } -

Example:

{
+

Type: YAML value

Default:

{
+  matches = [ ];
+}

Example:

{
   matches = [
     { # Simple text replacement
       trigger = ":espanso";
@@ -9271,11 +7890,7 @@ for a description of available options.
                 
services.etesync-dav.serverUrl

The URL to the etesync server.

Type: string

Default: "https://api.etesync.com/"

Declared by:

<home-manager/modules/services/etesync-dav.nix>
services.etesync-dav.settings

Settings for etesync-dav, passed as environment variables. -

Type: attribute set of (string or signed integer)

Default: - { - - } -

Example:

{
+

Type: attribute set of (string or signed integer)

Default: { }

Example:

{
   ETESYNC_LISTEN_ADDRESS = "localhost";
   ETESYNC_LISTEN_PORT = 37358;
 }
@@ -9288,33 +7903,20 @@ for a description of available options.
                 
services.flameshot.settings

Configuration to use for Flameshot. See https://github.com/flameshot-org/flameshot/blob/master/flameshot.example.ini for available options. -

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: - { - - } -

Example: - { - General = - { - disabledTrayIcon = true; showStartupLaunchMessage = false; - } - ; - } -

Declared by:

+

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: { }

Example:

{
+  General = {
+    disabledTrayIcon = true;
+    showStartupLaunchMessage = false;
+  };
+}

Declared by:

<home-manager/modules/services/flameshot.nix>
services.fluidsynth.enable

Whether to enable fluidsynth midi synthesizer.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/fluidsynth.nix>
services.fluidsynth.extraOptions

Extra arguments, added verbatim to the fluidsynth command. See fluidsynth.conf(1). -

Type: list of string

Default: - [ - - ] -

Example: - [ - "--sample-rate 96000" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "--sample-rate 96000"
+]

Declared by:

<home-manager/modules/services/fluidsynth.nix>
services.fluidsynth.soundFont

The soundfont file to use, in SoundFont 2 format.

Type: path

Default: "\${pkgs.soundfont-fluid}/share/soundfonts/FluidR3_GM2-2.sf2"

Declared by:

@@ -9339,15 +7941,9 @@ generated from the immutable one, useful in scenarios where live reloading is de

Type: string or path

Default: "$XDG_CONFIG_HOME/fnott/fnott.ini"

Declared by:

<home-manager/modules/services/fnott.nix>
services.fnott.extraFlags

Extra arguments to use for executing fnott. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "-s" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "-s"
+]

Declared by:

<home-manager/modules/services/fnott.nix>
services.fnott.settings

Configuration written to $XDG_CONFIG_HOME/fnott/fnott.ini. @@ -9355,11 +7951,7 @@ generated from the immutable one, useful in scenarios where live reloading is de See fnott.ini(5) for a list of available options and https://codeberg.org/dnkl/fnott/src/branch/master/fnott.ini for an example configuration. -

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: { }

Example:

{
   main = {
     notification-margin = 5;
   };
@@ -9433,11 +8025,7 @@ geoclue2 service.
                 
services.gammastep.settings

The configuration to pass to Gammastep. Available options for Gammastep described in gammastep(1). -

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: { }

Example:

{
   general = {
     adjustment-method = "randr";
   };
@@ -9492,11 +8080,7 @@ for the supported URIs.
                     <home-manager/modules/services/gnome-keyring.nix>
                 
services.gnome-keyring.components

The GNOME keyring components to start. If empty then the default set of components will be started. -

Type: list of (one of "pkcs11", "secrets", "ssh")

Default: - [ - - ] -

Declared by:

+

Type: list of (one of "pkcs11", "secrets", "ssh")

Default: [ ]

Declared by:

<home-manager/modules/services/gnome-keyring.nix>
services.gpg-agent.enable

Whether to enable GnuPG private key agent.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/gpg-agent.nix> @@ -9530,8 +8114,8 @@ given number of seconds.
services.gpg-agent.extraConfig

Extra configuration lines to append to the gpg-agent configuration file.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-allow-emacs-pinentry
-allow-loopback-pinentry
+  allow-emacs-pinentry
+  allow-loopback-pinentry
 ''

Declared by:

<home-manager/modules/services/gpg-agent.nix>
services.gpg-agent.grabKeyboardAndMouse

Tell the pinentry to grab the keyboard and mouse. This @@ -9578,15 +8162,9 @@ now. changed. The Nix value declared here will be translated to JSON and written to the execute_after key in $XDG_CONFIG_HOME/grobi.conf. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "setxkbmap dvorak" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "setxkbmap dvorak"
+]

Declared by:

<home-manager/modules/services/grobi.nix>
services.grobi.rules

These are the rules grobi tries to match to the current output configuration. The rules are evaluated top to bottom, @@ -9595,11 +8173,7 @@ the first matching rule is applied and processing stops. See for more information. The Nix value declared here will be translated to JSON and written to the rules key in $XDG_CONFIG_HOME/grobi.conf. -

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

Default: - [ - - ] -

Example:

[
+

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

Default: [ ]

Example:

[
   {
     name = "Home";
     outputs_connected = [ "DP-2" ];
@@ -9635,50 +8209,53 @@ hotkey in which case you'll have to activate gromit-mpx
 manually using the command line.
 

Type: null or string or positive integer, meaning >0

Default: "F9"

Example: "Insert"

Declared by:

<home-manager/modules/services/gromit-mpx.nix> -
services.gromit-mpx.opacity

Opacity of the drawing overlay.

Type: float between 0.0 and 1.0 (inclusive)

Default:

Example:

Declared by:

+
services.gromit-mpx.opacity

Opacity of the drawing overlay.

Type: float between 0.0 and 1.0 (inclusive)

Default: 0.75

Example: 1.0

Declared by:

<home-manager/modules/services/gromit-mpx.nix>
services.gromit-mpx.tools

Tool definitions for gromit-mpx to use. -

Type: list of (submodule)

Default: - [ - - { - color = "red"; device = "default"; size = 5; type = "pen"; - } - - { - color = "blue"; device = "default"; modifiers = - [ - "SHIFT" - ] - ; size = 5; type = "pen"; - } - - { - color = "yellow"; device = "default"; modifiers = - [ - "CONTROL" - ] - ; size = 5; type = "pen"; - } - - { - arrowSize = 1; color = "green"; device = "default"; modifiers = - [ - "2" - ] - ; size = 6; type = "pen"; - } - - { - device = "default"; modifiers = - [ - "3" - ] - ; size = 75; type = "eraser"; - } - - ] -

Declared by:

+

Type: list of (submodule)

Default:

[
+  {
+    color = "red";
+    device = "default";
+    size = 5;
+    type = "pen";
+  }
+  {
+    color = "blue";
+    device = "default";
+    modifiers = [
+      "SHIFT"
+    ];
+    size = 5;
+    type = "pen";
+  }
+  {
+    color = "yellow";
+    device = "default";
+    modifiers = [
+      "CONTROL"
+    ];
+    size = 5;
+    type = "pen";
+  }
+  {
+    arrowSize = 1;
+    color = "green";
+    device = "default";
+    modifiers = [
+      "2"
+    ];
+    size = 6;
+    type = "pen";
+  }
+  {
+    device = "default";
+    modifiers = [
+      "3"
+    ];
+    size = 75;
+    type = "eraser";
+  }
+]

Declared by:

<home-manager/modules/services/gromit-mpx.nix>
services.gromit-mpx.tools.*.arrowSize

If not null, automatically draw an arrow at the end of a stroke with the given size. @@ -9691,15 +8268,9 @@ the name default works with any input.

Type: string

Example: "default"

Declared by:

<home-manager/modules/services/gromit-mpx.nix>
services.gromit-mpx.tools.*.modifiers

Only activate this tool if the given modifiers are also active. -

Type: list of (one of "1", "2", "3", "4", "5", "SHIFT", "CONTROL", "ALT", "META")

Default: - [ - - ] -

Example: - [ - "SHIFT" - ] -

Declared by:

+

Type: list of (one of "1", "2", "3", "4", "5", "SHIFT", "CONTROL", "ALT", "META")

Default: [ ]

Example:

[
+  "SHIFT"
+]

Declared by:

<home-manager/modules/services/gromit-mpx.nix>
services.gromit-mpx.tools.*.size

The tool size.

Type: positive integer, meaning >0

Default: 5

Example: 3

Declared by:

<home-manager/modules/services/gromit-mpx.nix> @@ -9729,11 +8300,7 @@ The format is described in <home-manager/modules/services/hound.nix>
services.hound.maxConcurrentIndexers

Limit the amount of concurrent indexers.

Type: positive integer, meaning >0

Default: 2

Declared by:

<home-manager/modules/services/hound.nix> -
services.hound.repositories

The repository configuration.

Type: attribute set of (JSON value)

Default: - { - - } -

Example:

{
+                
services.hound.repositories

The repository configuration.

Type: attribute set of (JSON value)

Default: { }

Example:

{
   SomeGitRepo = {
     url = "https://www.github.com/YourOrganization/RepoOne.git";
     ms-between-poll = 10000;
@@ -9754,11 +8321,7 @@ configuration file.
 

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/services/kanshi.nix>
services.kanshi.profiles

List of profiles. -

Type: attribute set of (submodule)

Default: - { - - } -

Example:

undocked = {
+

Type: attribute set of (submodule)

Default: { }

Example:

undocked = {
   outputs = [
     {
       criteria = "eDP-1";
@@ -9781,18 +8344,10 @@ docked = {
                 
services.kanshi.profiles.<name>.exec

Commands executed after the profile is successfully applied. Note that if you provide multiple commands, they will be executed asynchronously with no guaranteed ordering. -

Type: (list of string) or string convertible to it

Default: - [ - - ] -

Example: "[ \${pkg.sway}/bin/swaymsg workspace 1, move workspace to eDP-1 ]"

Declared by:

+

Type: (list of string) or string convertible to it

Default: [ ]

Example: "[ \${pkg.sway}/bin/swaymsg workspace 1, move workspace to eDP-1 ]"

Declared by:

<home-manager/modules/services/kanshi.nix>
services.kanshi.profiles.<name>.outputs

Outputs configuration. -

Type: list of (submodule)

Default: - [ - - ] -

Declared by:

+

Type: list of (submodule)

Default: [ ]

Declared by:

<home-manager/modules/services/kanshi.nix>
services.kanshi.profiles.<name>.outputs.*.criteria

The criteria can either be an output name, an output description or "*". The latter can be used to match any output. @@ -9831,15 +8386,10 @@ space.

services.kbfs.enable

Whether to enable Keybase File System.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/kbfs.nix>
services.kbfs.extraFlags

Additional flags to pass to the Keybase filesystem on launch. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "-label kbfs" "-mount-type normal" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "-label kbfs"
+  "-mount-type normal"
+]

Declared by:

<home-manager/modules/services/kbfs.nix>
services.kbfs.mountPoint

Mount point for the Keybase filesystem, relative to HOME. @@ -9893,31 +8443,19 @@ useful for creating the directories mbsync is going to use.

services.mopidy.enable

Whether to enable Mopidy music player daemon.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/mopidy.nix>
services.mopidy.extensionPackages

Mopidy extensions that should be loaded by the service. -

Type: list of package

Default: - [ - - ] -

Example: with pkgs; [ mopidy-spotify mopidy-mpd mopidy-mpris ]

Declared by:

+

Type: list of package

Default: [ ]

Example: with pkgs; [ mopidy-spotify mopidy-mpd mopidy-mpris ]

Declared by:

<home-manager/modules/services/mopidy.nix>
services.mopidy.extraConfigFiles

Extra configuration files read by Mopidy when the service starts. Later files in the list override earlier configuration files and structured settings. -

Type: list of path

Default: - [ - - ] -

Declared by:

+

Type: list of path

Default: [ ]

Declared by:

<home-manager/modules/services/mopidy.nix>
services.mopidy.settings

Configuration written to $XDG_CONFIG_HOME/mopidy/mopidy.conf.

See https://docs.mopidy.com/en/latest/config/ for more details. -

Type: attribute set of attribute set of (Mopidy config value)

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute set of (Mopidy config value)

Default: { }

Example:

{
   file = {
     media_dirs = [
       "$XDG_MUSIC_DIR|Music"
@@ -9969,10 +8507,7 @@ beginning of the file. For available options see
 If xdg.userDirs.enable is
 true then the defined XDG music directory is used.
 Otherwise, you must explicitly specify a value.
-

Type: path or string

Default:

${home.homeDirectory}/music    if state version < 22.11
-${xdg.userDirs.music}          if xdg.userDirs.enable == true
-undefined                      otherwise
-

Declared by:

+

Type: path or string

Declared by:

<home-manager/modules/services/mpd.nix>
services.mpd.network.listenAddress

The address for the daemon to listen on. Use any to listen on all addresses. @@ -9993,11 +8528,7 @@ Use any to listen on all addresses. <home-manager/modules/services/mpd-discord-rpc.nix>

services.mpd-discord-rpc.settings

Configuration included in config.toml. For available options see https://github.com/JakeStanger/mpd-discord-rpc#configuration -

Type: TOML value

Default: - { - - } -

Example:

{
+

Type: TOML value

Default: { }

Example:

{
   hosts = [ "localhost:6600" ];
   format = {
     details = "$title";
@@ -10028,11 +8559,7 @@ For available options see services.mpris-proxy.enable

Whether to enable a proxy forwarding Bluetooth MIDI controls via MPRIS2 to control media players.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/mpris-proxy.nix>
services.muchsync.remotes

Muchsync remotes to synchronise with. -

Type: attribute set of (submodule)

Default: - { - - } -

Example:

{
+

Type: attribute set of (submodule)

Default: { }

Example:

{
   server = {
     frequency = "*:0/10";
     remote.host = "server.tld";
@@ -10182,17 +8709,13 @@ password are escaped.
 

Type: package

Default: pkgs.picom

Example: pkgs.picom

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.activeOpacity

Opacity of active windows. -

Type: integer or floating point number between 0 and 1 (both inclusive)

Default:

Example:

Declared by:

+

Type: integer or floating point number between 0 and 1 (both inclusive)

Default: 1.0

Example: 0.8

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.backend

Backend to use: egl, glx, xrender or xr_glx_hybrid.

Type: one of "egl", "glx", "xrender", "xr_glx_hybrid"

Default: "xrender"

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.extraArgs

Extra arguments to be passed to the picom executable. -

Type: list of string

Default: - [ - - ] -

Example: [ "--legacy-backends" ]

Declared by:

+

Type: list of string

Default: [ ]

Example: [ "--legacy-backends" ]

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.fade

Fade windows in and out.

Type: boolean

Default: false

Declared by:

@@ -10202,43 +8725,32 @@ password are escaped. <home-manager/modules/services/picom.nix>
services.picom.fadeExclude

List of conditions of windows that should not be faded. See picom(1) man page for more examples. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "window_type *= 'menu'" "name ~= 'Firefox$'" "focused = 1" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "window_type *= 'menu'"
+  "name ~= 'Firefox$'"
+  "focused = 1"
+]

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.fadeSteps

Opacity change between fade steps (in and out). -

Type: pair of integer or floating point number between 0.01 and 1 (both inclusive)

Default: - [ - - ] -

Example: - [ - - ] -

Declared by:

+

Type: pair of integer or floating point number between 0.01 and 1 (both inclusive)

Default:

[
+  0.028
+  0.03
+]

Example:

[
+  0.04
+  0.04
+]

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.inactiveOpacity

Opacity of inactive windows. -

Type: integer or floating point number between 0.1 and 1 (both inclusive)

Default:

Example:

Declared by:

+

Type: integer or floating point number between 0.1 and 1 (both inclusive)

Default: 1.0

Example: 0.8

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.menuOpacity

Opacity of dropdown and popup menu. -

Type: integer or floating point number between 0 and 1 (both inclusive)

Default:

Example:

Declared by:

+

Type: integer or floating point number between 0 and 1 (both inclusive)

Default: 1.0

Example: 0.8

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.opacityRules

Rules that control the opacity of windows, in format PERCENT:PATTERN. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "95:class_g = 'URxvt' && !_NET_WM_STATE@:32a" "0:_NET_WM_STATE@:32a *= '_NET_WM_STATE_HIDDEN'" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "95:class_g = 'URxvt' && !_NET_WM_STATE@:32a"
+  "0:_NET_WM_STATE@:32a *= '_NET_WM_STATE_HIDDEN'"
+]

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.settings

Picom settings. Use this option to configure Picom settings not exposed in a NixOS option or to bypass one. For the available options see the @@ -10247,11 +8759,7 @@ CONFIGURATION FILES section at picom(1). set (called a group) of settings. Each setting can be a scalar type (boolean, integer, floating point number or string), a list of scalars or a group itself -

Default: - { - - } -

Example:

blur =
+

Default: { }

Example:

blur =
   { method = "gaussian";
     size = 10;
     deviation = 5.0;
@@ -10263,29 +8771,23 @@ scalars or a group itself
                     <home-manager/modules/services/picom.nix>
                 
services.picom.shadowExclude

List of conditions of windows that should have no shadow. See picom(1) man page for more examples. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "window_type *= 'menu'" "name ~= 'Firefox$'" "focused = 1" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "window_type *= 'menu'"
+  "name ~= 'Firefox$'"
+  "focused = 1"
+]

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.shadowOffsets

Left and right offset for shadows (in pixels). -

Type: pair of signed integer

Default: - [ - -15 -15 - ] -

Example: - [ - -10 -15 - ] -

Declared by:

+

Type: pair of signed integer

Default:

[
+  -15
+  -15
+]

Example:

[
+  -10
+  -15
+]

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.shadowOpacity

Window shadows opacity. -

Type: integer or floating point number between 0 and 1 (both inclusive)

Default:

Example:

Declared by:

+

Type: integer or floating point number between 0 and 1 (both inclusive)

Default: 0.75

Example: 0.8

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.vSync

Enable vertical synchronization.

Type: boolean

Default: false

Declared by:

@@ -10295,11 +8797,7 @@ See picom(1) man page for more examples. popup_menu = { opacity = config.services.picom.menuOpacity; }; dropdown_menu = { opacity = config.services.picom.menuOpacity; }; } -

Example: - { - - } -

Declared by:

+

Example: { }

Declared by:

<home-manager/modules/services/picom.nix>
services.plan9port.fontsrv.enable

Whether to enable the Plan 9 file system access to host fonts.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/plan9port.nix> @@ -10317,11 +8815,7 @@ See picom(1) man page for more examples. $XDG_CONFIG_HOME/plex-mpv-shim/config.json. See https://github.com/iwalton3/plex-mpv-shim/blob/master/README.md for the configuration documentation. -

Type: JSON value

Default: - { - - } -

Example:

{
+

Type: JSON value

Default: { }

Example:

{
   adaptive_transcode = false;
   allow_http = false;
   always_transcode = false;
@@ -10345,11 +8839,7 @@ for the configuration documentation.
                 
services.polybar.config

Polybar configuration. Can be either path to a file, or set of attributes that will be used to create the final configuration. See also services.polybar.settings for a more nix-friendly format. -

Type: (attribute set of attribute set of (string or boolean or signed integer or list of string)) or path convertible to it

Default: - { - - } -

Example:

{
+

Type: (attribute set of attribute set of (string or boolean or signed integer or list of string)) or path convertible to it

Default: { }

Example:

{
   "bar/top" = {
     monitor = "\${env:MONITOR:eDP1}";
     width = "100%";
@@ -10369,13 +8859,13 @@ See also services.polybar.settings for a more nix-fr
 

Declared by:

<home-manager/modules/services/polybar.nix>
services.polybar.extraConfig

Additional configuration to add.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-[module/date]
-type = internal/date
-interval = 5
-date = "%d.%m.%y"
-time = %H:%M
-format-prefix-foreground = \''${colors.foreground-alt}
-label = %time%  %date%
+  [module/date]
+  type = internal/date
+  interval = 5
+  date = "%d.%m.%y"
+  time = %H:%M
+  format-prefix-foreground = \''${colors.foreground-alt}
+  label = %time%  %date%
 ''

Declared by:

<home-manager/modules/services/polybar.nix>
services.polybar.script

This script will be used to start the polybars. @@ -10416,11 +8906,7 @@ ramp-volume-1=🔉 ramp-volume-2=🔊 click-right=pavucontrol &

-

Type: attribute set of attribute sets

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute sets

Default: { }

Example:

{
   "module/volume" = {
     type = "internal/pulseaudio";
     format.volume = "<ramp-volume> <label-volume>";
@@ -10440,11 +8926,7 @@ click-right=pavucontrol &
                     <home-manager/modules/services/pueue.nix>
                 
services.pueue.settings

Configuration written to $XDG_CONFIG_HOME/pueue/pueue.yml. -

Type: YAML value

Default: - { - - } -

Example:

{
+

Type: YAML value

Default: { }

Example:

{
   daemon = {
     default_parallel_tasks = 2;
   };
@@ -10504,11 +8986,7 @@ as RECOLL_CONFDIR.
 
 See
 recoll(5) for more details about the configuration.
-

Type: attribute set of (Recoll config value)

Default: - { - - } -

Example:

{
+

Type: attribute set of (Recoll config value)

Default: { }

Example:

{
   nocjk = true;
   loglevel = 5;
   topdirs = [ "~/Downloads" "~/Documents" "~/projects" ];
@@ -10562,11 +9040,7 @@ geoclue2 service.
                 
services.redshift.settings

The configuration to pass to Redshift. Available options for Redshift described in redshift(1). -

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute set of (INI atom (null, bool, int, float or string))

Default: { }

Example:

{
   redshift = {
     adjustment-method = "randr";
   };
@@ -10608,7 +9082,7 @@ the X server's screensaver timeout.
                 
services.screen-locker.xautolock.enable

Use xautolock for time-based locking.

Type: boolean

Default: true

Declared by:

<home-manager/modules/services/screen-locker.nix>
services.screen-locker.xautolock.package

Package providing the xautolock binary. -

Type: package

Default: (build of xautolock-2.2-7-ga23dd5c)

Declared by:

+

Type: package

Default: <derivation xautolock-2.2-7-ga23dd5c>

Declared by:

<home-manager/modules/services/screen-locker.nix>
services.screen-locker.xautolock.detectSleep

Whether to reset xautolock timers when awaking from sleep. No effect if xautolock.enable is false. @@ -10616,21 +9090,13 @@ No effect if xautolock.enable is false. <home-manager/modules/services/screen-locker.nix>

services.screen-locker.xautolock.extraOptions

Extra command-line arguments to pass to xautolock. No effect if xautolock.enable is false. -

Type: list of string

Default: - [ - - ] -

Declared by:

+

Type: list of string

Default: [ ]

Declared by:

<home-manager/modules/services/screen-locker.nix>
services.screen-locker.xss-lock.package

Package providing the xss-lock binary. -

Type: package

Default: (build of xss-lock-unstable-2018-05-31)

Declared by:

+

Type: package

Default: <derivation xss-lock-unstable-2018-05-31>

Declared by:

<home-manager/modules/services/screen-locker.nix>
services.screen-locker.xss-lock.extraOptions

Extra command-line arguments to pass to xss-lock. -

Type: list of string

Default: - [ - - ] -

Declared by:

+

Type: list of string

Default: [ ]

Declared by:

<home-manager/modules/services/screen-locker.nix>
services.screen-locker.xss-lock.screensaverCycle

The X server's screensaver cycle value expressed as seconds. This will be used with xset to configure @@ -10651,11 +9117,7 @@ for more details. Can be used to specify extensions.

Type: package

Default: pkgs.spotifyd

Example: (pkgs.spotifyd.override { withKeyring = true; })

Declared by:

<home-manager/modules/services/spotifyd.nix> -
services.spotifyd.settings

Configuration for spotifyd

Type: TOML value

Default: - { - - } -

Example:

{
+                
services.spotifyd.settings

Configuration for spotifyd

Type: TOML value

Default: { }

Example:

{
   global = {
     username = "Alex";
     password = "foo";
@@ -10669,22 +9131,20 @@ Can be used to specify extensions.
                 
services.stalonetray.package

The package to use for the Stalonetray binary.

Type: package

Default: pkgs.stalonetray

Example: pkgs.stalonetray

Declared by:

<home-manager/modules/services/stalonetray.nix>
services.stalonetray.config

Stalonetray configuration as a set of attributes. -

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

Default: - { - - } -

Example: - { - background = "#cccccc"; decorations = null; geometry = "3x1-600+0"; icon_size = 30; sticky = true; - } -

Declared by:

+

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

Default: { }

Example:

{
+  background = "#cccccc";
+  decorations = null;
+  geometry = "3x1-600+0";
+  icon_size = 30;
+  sticky = true;
+}

Declared by:

<home-manager/modules/services/stalonetray.nix>
services.stalonetray.extraConfig

Additional configuration lines for stalonetrayrc.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-geometry 3x1-600+0
-decorations none
-icon_size 30
-sticky true
-background "#cccccc"
+  geometry 3x1-600+0
+  decorations none
+  icon_size 30
+  sticky true
+  background "#cccccc"
 ''

Declared by:

<home-manager/modules/services/stalonetray.nix>
services.status-notifier-watcher.enable

Whether to enable Status Notifier Watcher.

Type: boolean

Default: false

Example: true

Declared by:

@@ -10695,11 +9155,7 @@ background "#cccccc" <home-manager/modules/services/swayidle.nix>
services.swayidle.package

Swayidle package to install.

Type: package

Default: pkgs.swayidle

Declared by:

<home-manager/modules/services/swayidle.nix> -
services.swayidle.events

Run command on occurrence of a event.

Type: list of (submodule)

Default: - [ - - ] -

Example:

[
+                
services.swayidle.events

Run command on occurrence of a event.

Type: list of (submodule)

Default: [ ]

Example:

[
   { event = "before-sleep"; command = "${pkgs.swaylock}/bin/swaylock"; }
   { event = "lock"; command = "lock"; }
 ]
@@ -10709,20 +9165,12 @@ background "#cccccc"
                     <home-manager/modules/services/swayidle.nix>
                 
services.swayidle.events.*.event

Event name.

Type: one of "before-sleep", "after-resume", "lock", "unlock"

Declared by:

<home-manager/modules/services/swayidle.nix> -
services.swayidle.extraArgs

Extra arguments to pass to swayidle.

Type: list of string

Default: - [ - - ] -

Declared by:

+
services.swayidle.extraArgs

Extra arguments to pass to swayidle.

Type: list of string

Default: [ ]

Declared by:

<home-manager/modules/services/swayidle.nix>
services.swayidle.systemdTarget

Systemd target to bind to.

Type: string

Default: "sway-session.target"

Declared by:

<home-manager/modules/services/swayidle.nix> -
services.swayidle.timeouts

List of commands to run after idle timeout.

Type: list of (submodule)

Default: - [ - - ] -

Example:

[
+                
services.swayidle.timeouts

List of commands to run after idle timeout.

Type: list of (submodule)

Default: [ ]

Example:

[
   { timeout = 60; command = "${pkgs.swaylock}/bin/swaylock -fF"; }
 ]
 

Declared by:

@@ -10741,17 +9189,9 @@ background "#cccccc" i3-msg {workspace,move container to workspace} {1-10}

Declared by:

<home-manager/modules/services/sxhkd.nix> -
services.sxhkd.extraOptions

Command line arguments to invoke sxhkd with.

Type: list of string

Default: - [ - - ] -

Example: [ "-m 1" ]

Declared by:

+
services.sxhkd.extraOptions

Command line arguments to invoke sxhkd with.

Type: list of string

Default: [ ]

Example: [ "-m 1" ]

Declared by:

<home-manager/modules/services/sxhkd.nix> -
services.sxhkd.keybindings

An attribute set that assigns hotkeys to commands.

Type: attribute set of (null or string)

Default: - { - - } -

Example:

{
+                
services.sxhkd.keybindings

An attribute set that assigns hotkeys to commands.

Type: attribute set of (null or string)

Default: { }

Example:

{
   "super + shift + {r,c}" = "i3-msg {restart,reload}";
   "super + {s,w}"         = "i3-msg {stacking,tabbed}";
 }
@@ -10760,21 +9200,13 @@ background "#cccccc"
                 
services.syncthing.enable

Whether to enable Syncthing continuous file synchronization.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/syncthing.nix>
services.syncthing.extraOptions

Extra command-line arguments to pass to syncthing. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "--gui-apikey=apiKey" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "--gui-apikey=apiKey"
+]

Declared by:

<home-manager/modules/services/syncthing.nix> -
services.syncthing.tray

Syncthing tray service configuration.

Type: boolean or (submodule)

Default: - { - enable = false; - } -

Declared by:

+
services.syncthing.tray

Syncthing tray service configuration.

Type: boolean or (submodule)

Default:

{
+  enable = false;
+}

Declared by:

<home-manager/modules/services/syncthing.nix>
services.systembus-notify.enable

Whether to enable systembus-notify - system bus notification daemon.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/systembus-notify.nix> @@ -10801,11 +9233,7 @@ for more information about the format. found at https://github.com/sargon/trayer-srg.

Property NameTypeValuesDefault
SetDockTypebooleantrue|falsetrue
SetPartialStrutbooleantrue|falsetrue
alignstringleft|right|centercenter
alphasigned integernumber127
distancesigned integernumber0
distancefromstringleft|right|top|bottomtop
edgestringleft|right|top|bottom|nonebottom
expandbooleantrue|falsetrue
heightsigned integernumber26
heighttypestringrequest|pixelpixel
iconspacingsigned integernumber0
marginsigned integernumber0
monitorstringnumber|primary0
paddingsigned integernumber0
tintstringint0xFFFFFFFF
transparentbooleantrue|falsefalse
widthsigned integernumber100
widthtypestringrequest|pixel|percentpercent

-

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

Default: - { - - } -

Example:

{
+

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

Default: { }

Example:

{
   edge = "top";
   padding = 6;
   SetDockType = true;
@@ -10821,11 +9249,7 @@ found at services.twmn.extraConfig

Extra configuration options to add to the twmnd config file. See https://github.com/sboli/twmn/blob/master/README.md for details. -

Type: attribute set

Default: - { - - } -

Example: { main.activation_command = "\${pkgs.hello}/bin/hello"; }

Declared by:

+

Type: attribute set

Default: { }

Example: { main.activation_command = "\${pkgs.hello}/bin/hello"; }

Declared by:

<home-manager/modules/services/twmn.nix>
services.twmn.host

Host address to listen on for notifications.

Type: string

Default: "127.0.0.1"

Example: "laptop.lan"

Declared by:

<home-manager/modules/services/twmn.nix> @@ -10867,11 +9291,7 @@ Never cuts if null. <home-manager/modules/services/twmn.nix>
services.twmn.window.animation.bounce.duration

The bounce animation duration in milliseconds.

Type: unsigned integer, meaning >=0

Default: 500

Example: 618

Declared by:

<home-manager/modules/services/twmn.nix> -
services.twmn.window.animation.easeIn

Options for the notification appearance's animation.

Type: submodule

Default: - { - - } -

Example:

{
+                
services.twmn.window.animation.easeIn

Options for the notification appearance's animation.

Type: submodule

Default: { }

Example:

{
   curve = 19;
   duration = 618;
 }
@@ -10884,11 +9304,7 @@ QEasingCurve documentation.
                     <home-manager/modules/services/twmn.nix>
                 
services.twmn.window.animation.easeIn.duration

The animation duration in milliseconds.

Type: unsigned integer, meaning >=0

Default: 1000

Example: 618

Declared by:

<home-manager/modules/services/twmn.nix> -
services.twmn.window.animation.easeOut

Options for the notification disappearance's animation.

Type: submodule

Default: - { - - } -

Example:

{
+                
services.twmn.window.animation.easeOut

Options for the notification disappearance's animation.

Type: submodule

Default: { }

Example:

{
   curve = 19;
   duration = 618;
 }
@@ -10942,11 +9358,7 @@ the Udisk2 DBus service is not found.
 

See https://github.com/coldfix/udiskie/blob/master/doc/udiskie.8.txt#configuration for the full list of options. -

Type: YAML value

Default: - { - - } -

Example:

{
+

Type: YAML value

Default: { }

Example:

{
   program_options = {
     udisks_version = 2;
     tray = true;
@@ -10967,15 +9379,10 @@ The options are
                     <home-manager/modules/services/unclutter.nix>
                 
services.unclutter.package

unclutter derivation to use.

Type: package

Default: pkgs.unclutter-xfixes

Declared by:

<home-manager/modules/services/unclutter.nix> -
services.unclutter.extraOptions

More arguments to pass to the unclutter command.

Type: list of string

Default: - [ - - ] -

Example: - [ - "exclude-root" "ignore-scrolling" - ] -

Declared by:

+
services.unclutter.extraOptions

More arguments to pass to the unclutter command.

Type: list of string

Default: [ ]

Example:

[
+  "exclude-root"
+  "ignore-scrolling"
+]

Declared by:

<home-manager/modules/services/unclutter.nix>
services.unclutter.threshold

Minimum number of pixels considered cursor movement.

Type: signed integer

Default: 1

Declared by:

<home-manager/modules/services/unclutter.nix> @@ -10984,11 +9391,7 @@ The options are
services.unison.enable

Whether to enable Unison synchronisation.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/unison.nix>
services.unison.pairs

Unison root pairs to keep synchronised. -

Type: attribute set of (submodule)

Default: - { - - } -

Example:

{
+

Type: attribute set of (submodule)

Default: { }

Example:

{
   "my-documents" = {
     roots = [
       "/home/user/documents"
@@ -11004,11 +9407,14 @@ The options are
 See
 unison(1)
 for a list of available options.
-

Type: attribute set of string

Default: - { - auto = "true"; batch = "true"; log = "false"; repeat = "watch"; sshcmd = "\${pkgs.openssh}/bin/ssh"; ui = "text"; - } -

Declared by:

+

Type: attribute set of string

Default:

{
+  auto = "true";
+  batch = "true";
+  log = "false";
+  repeat = "watch";
+  sshcmd = "\${pkgs.openssh}/bin/ssh";
+  ui = "text";
+}

Declared by:

<home-manager/modules/services/unison.nix>
services.unison.pairs.<name>.roots

Pair of roots to synchronise.

Type: list of string of length 2

Example:

[
@@ -11068,15 +9474,10 @@ used (assuming that you have a key with "{" above "[").
 You can also specify keys in decimal (prefix #), octal (#0),
 or hexadecimal (#0x). They will be interpreted as keycodes
 unless no corresponding key name is found.
-

Type: attribute set of string

Default: - { - - } -

Example: - { - Control_L = "Control_L|O"; Shift_L = "Escape"; - } -

Declared by:

+

Type: attribute set of string

Default: { }

Example:

{
+  Control_L = "Control_L|O";
+  Shift_L = "Escape";
+}

Declared by:

<home-manager/modules/services/xcape.nix>
services.xcape.timeout

If you hold a key longer than this timeout, xcape will not generate a key event. Default is 500 ms. @@ -11096,11 +9497,7 @@ program. <home-manager/modules/services/xidlehook.nix>

services.xidlehook.environment

Extra environment variables to be exported in the script. These options are passed unescaped as export name=value. -

Type: attribute set of string

Default: - { - - } -

Example:

{
+

Type: attribute set of string

Default: { }

Example:

{
   "primary-display" = "$(xrandr | awk '/ primary/{print $1}')";
 }
 

Declared by:

@@ -11116,11 +9513,7 @@ The commands specified in command and environment section. -

Type: list of (submodule)

Default: - [ - - ] -

Example:

[
+

Type: list of (submodule)

Default: [ ]

Example:

[
   {
     delay = 60;
     command = "xrandr --output \"$PRIMARY_DISPLAY\" --brightness .1";
@@ -11153,15 +9546,11 @@ The command is automatically escaped.
                 
services.xscreensaver.enable

Whether to enable XScreenSaver.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/xscreensaver.nix>
services.xscreensaver.settings

The settings to use for XScreenSaver. -

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

Default: - { - - } -

Example: - { - fadeTicks = 20; lock = false; mode = "blank"; - } -

Declared by:

+

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

Default: { }

Example:

{
+  fadeTicks = 20;
+  lock = false;
+  mode = "blank";
+}

Declared by:

<home-manager/modules/services/xscreensaver.nix>
services.xsettingsd.enable

Whether to enable xsettingsd.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/xsettingsd.nix> @@ -11171,11 +9560,7 @@ The command is automatically escaped.
services.xsettingsd.settings

Xsettingsd options for configuration file. See https://github.com/derat/xsettingsd/wiki/Settings for documentation on these values. -

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

Default: - { - - } -

Example:

{
+

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

Default: { }

Example:

{
   "Net/ThemeName" = "Numix";
   "Xft/Antialias" = true;
   "Xft/Hinting" = true;
@@ -11187,11 +9572,7 @@ for documentation on these values.
                     <home-manager/modules/services/xsuspender.nix>
                 
services.xsuspender.debug

Whether to enable debug output.

Type: boolean

Default: false

Declared by:

<home-manager/modules/services/xsuspender.nix> -
services.xsuspender.defaults

XSuspender defaults.

Type: submodule

Default: - { - - } -

Declared by:

+
services.xsuspender.defaults

XSuspender defaults.

Type: submodule

Default: { }

Declared by:

<home-manager/modules/services/xsuspender.nix>
services.xsuspender.defaults.autoSuspendOnBattery

Whether to auto-apply rules when switching to battery power even if the window(s) didn't just lose focus. @@ -11207,7 +9588,7 @@ process regardless script failure. <home-manager/modules/services/xsuspender.nix>

services.xsuspender.defaults.execSuspend

Before suspending, execute this shell script. If it fails, abort suspension. -

Type: null or string

Default: null

Example: ''echo "suspending window $XID of process $PID"''

Declared by:

+

Type: null or string

Default: null

Example: "echo \"suspending window $XID of process $PID\""

Declared by:

<home-manager/modules/services/xsuspender.nix>
services.xsuspender.defaults.matchWmClassContains

Match windows that wm class contains string.

Type: null or string

Default: null

Declared by:

<home-manager/modules/services/xsuspender.nix> @@ -11229,19 +9610,13 @@ If false just the exec scripts are run. <home-manager/modules/services/xsuspender.nix>
services.xsuspender.defaults.suspendSubtreePattern

Also suspend descendant processes that match this regex.

Type: null or string

Default: null

Declared by:

<home-manager/modules/services/xsuspender.nix> -
services.xsuspender.rules

Attribute set of XSuspender rules.

Type: attribute set of (submodule)

Default: - { - - } -

Example: - { - Chromium = - { - matchWmClassContains = "chromium-browser"; suspendDelay = 10; suspendSubtreePattern = "chromium"; - } - ; - } -

Declared by:

+
services.xsuspender.rules

Attribute set of XSuspender rules.

Type: attribute set of (submodule)

Default: { }

Example:

{
+  Chromium = {
+    matchWmClassContains = "chromium-browser";
+    suspendDelay = 10;
+    suspendSubtreePattern = "chromium";
+  };
+}

Declared by:

<home-manager/modules/services/xsuspender.nix>
services.xsuspender.rules.<name>.autoSuspendOnBattery

Whether to auto-apply rules when switching to battery power even if the window(s) didn't just lose focus. @@ -11257,7 +9632,7 @@ process regardless script failure. <home-manager/modules/services/xsuspender.nix>

services.xsuspender.rules.<name>.execSuspend

Before suspending, execute this shell script. If it fails, abort suspension. -

Type: null or string

Default: null

Example: ''echo "suspending window $XID of process $PID"''

Declared by:

+

Type: null or string

Default: null

Example: "echo \"suspending window $XID of process $PID\""

Declared by:

<home-manager/modules/services/xsuspender.nix>
services.xsuspender.rules.<name>.matchWmClassContains

Match windows that wm class contains string.

Type: null or string

Default: null

Declared by:

<home-manager/modules/services/xsuspender.nix> @@ -11313,18 +9688,10 @@ then run WARNING! Since this option is experimental, the activation process may change in backwards incompatible ways. -

Type: attribute set of (submodule)

Default: - { - - } -

Declared by:

+

Type: attribute set of (submodule)

Default: { }

Declared by:

<home-manager/modules/misc/specialization.nix>
specialization.<name>.configuration

Arbitrary Home Manager configuration settings. -

Type: submodule

Default: - { - - } -

Declared by:

+

Type: submodule

Default: { }

Declared by:

<home-manager/modules/misc/specialization.nix>
systemd.user.automounts

Definition of systemd per-user automount units. Attributes are merged recursively. @@ -11332,11 +9699,7 @@ merged recursively. Note that the attributes follow the capitalization and naming used by systemd. More details can be found in systemd.automount(5). -

Type: systemd automount unit configuration

Default: - { - - } -

Example:

{
+

Type: systemd automount unit configuration

Default: { }

Example:

{
   automount-name = {
     Unit = {
       Description = "Example description";
@@ -11356,11 +9719,7 @@ merged recursively.
 Note that the attributes follow the capitalization and naming used
 by systemd. More details can be found in
 systemd.mount(5).
-

Type: systemd mount unit configuration

Default: - { - - } -

Example:

{
+

Type: systemd mount unit configuration

Default: { }

Example:

{
   mount-name = {
     Unit = {
       Description = "Example description";
@@ -11380,11 +9739,7 @@ merged recursively.
 Note that the attributes follow the capitalization and naming used
 by systemd. More details can be found in
 systemd.path(5).
-

Type: systemd path unit configuration

Default: - { - - } -

Example:

{
+

Type: systemd path unit configuration

Default: { }

Example:

{
   path-name = {
     Unit = {
       Description = "Example description";
@@ -11404,11 +9759,7 @@ merged recursively.
 Note that the attributes follow the capitalization and naming used
 by systemd. More details can be found in
 systemd.service(5).
-

Type: systemd service unit configuration

Default: - { - - } -

Example:

{
+

Type: systemd service unit configuration

Default: { }

Example:

{
   service-name = {
     Unit = {
       Description = "Example description";
@@ -11429,15 +9780,9 @@ considered successful. The value 0 indicates no timeout.
                 
systemd.user.sessionVariables

Environment variables that will be set for the user session. The variable values must be as described in environment.d(5). -

Type: attribute set of (signed integer or string)

Default: - { - - } -

Example: - { - EDITOR = "vim"; - } -

Declared by:

+

Type: attribute set of (signed integer or string)

Default: { }

Example:

{
+  EDITOR = "vim";
+}

Declared by:

<home-manager/modules/systemd.nix>
systemd.user.slices

Definition of systemd per-user slice units. Attributes are merged recursively. @@ -11445,11 +9790,7 @@ merged recursively. Note that the attributes follow the capitalization and naming used by systemd. More details can be found in systemd.slice(5). -

Type: systemd slice unit configuration

Default: - { - - } -

Example:

{
+

Type: systemd slice unit configuration

Default: { }

Example:

{
   slice-name = {
     Unit = {
       Description = "Example description";
@@ -11469,11 +9810,7 @@ merged recursively.
 Note that the attributes follow the capitalization and naming used
 by systemd. More details can be found in
 systemd.socket(5).
-

Type: systemd socket unit configuration

Default: - { - - } -

Example:

{
+

Type: systemd socket unit configuration

Default: { }

Example:

{
   socket-name = {
     Unit = {
       Description = "Example description";
@@ -11520,11 +9857,7 @@ merged recursively.
 Note that the attributes follow the capitalization and naming used
 by systemd. More details can be found in
 systemd.target(5).
-

Type: systemd target unit configuration

Default: - { - - } -

Example:

{
+

Type: systemd target unit configuration

Default: { }

Example:

{
   target-name = {
     Unit = {
       Description = "Example description";
@@ -11544,11 +9877,7 @@ merged recursively.
 Note that the attributes follow the capitalization and naming used
 by systemd. More details can be found in
 systemd.timer(5).
-

Type: systemd timer unit configuration

Default: - { - - } -

Example:

{
+

Type: systemd timer unit configuration

Default: { }

Example:

{
   timer-name = {
     Unit = {
       Description = "Example description";
@@ -11566,15 +9895,9 @@ by systemd. More details can be found in
 automatically. See
 tmpfiles.d(5)
 for the exact format.
-

Type: list of string

Default: - [ - - ] -

Example: - [ - "L /home/user/Documents - - - - /mnt/data/Documents" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "L /home/user/Documents - - - - /mnt/data/Documents"
+]

Declared by:

<home-manager/modules/misc/tmpfiles.nix>
targets.darwin.currentHostDefaults

Set macOS user defaults. Unlike targets.darwin.defaults, the preferences will only be applied to the currently logged-in host. This @@ -11585,19 +9908,11 @@ Values set to null are ignored.

Warning

Some settings might require a re-login to take effect.

-

Type: attribute set of attribute set of anything

Default: - { - - } -

Example: - { - com.apple.controlcenter = - { - BatteryShowPercentage = true; - } - ; - } -

Declared by:

+

Type: attribute set of attribute set of anything

Default: { }

Example:

{
+  "com.apple.controlcenter" = {
+    BatteryShowPercentage = true;
+  };
+}

Declared by:

<home-manager/modules/targets/darwin/user-defaults>
targets.darwin.currentHostDefaults."com.apple.controlcenter".BatteryShowPercentage

Whether to show battery percentage in the menu bar.

Type: null or boolean

Default: null

Example: true

Declared by:

@@ -11612,25 +9927,16 @@ ignored. Some settings are only read from targets.darwin.currentHostDefaults.

-

Type: attribute set of attribute set of anything

Default: - { - - } -

Example: - { - com.apple.desktopservices = - { - DSDontWriteNetworkStores = true; DSDontWriteUSBStores = true; - } - ; - } -

Declared by:

+

Type: attribute set of attribute set of anything

Default: { }

Example:

{
+  "com.apple.desktopservices" = {
+    DSDontWriteNetworkStores = true;
+    DSDontWriteUSBStores = true;
+  };
+}

Declared by:

<home-manager/modules/targets/darwin/user-defaults> -
targets.darwin.defaults.NSGlobalDomain.AppleLanguages

Sets the language to use in the preferred order.

Type: null or (list of string)

Default: null

Example: - [ - "en" - ] -

Declared by:

+
targets.darwin.defaults.NSGlobalDomain.AppleLanguages

Sets the language to use in the preferred order.

Type: null or (list of string)

Default: null

Example:

[
+  "en"
+]

Declared by:

<home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix>
targets.darwin.defaults.NSGlobalDomain.AppleLocale

Configures the user locale.

Type: null or string

Default: null

Example: "en_US"

Declared by:

<home-manager/modules/targets/darwin/user-defaults/opts-allhosts.nix> @@ -11726,15 +10032,10 @@ for more details. Existing keybinding configuration will be wiped when using this option.

-

Type: attribute set of anything

Default: - { - - } -

Example: - { - ^u = "deleteToBeginningOfLine:"; ^w = "deleteWordBackward:"; - } -

Declared by:

+

Type: attribute set of anything

Default: { }

Example:

{
+  "^u" = "deleteToBeginningOfLine:";
+  "^w" = "deleteWordBackward:";
+}

Declared by:

<home-manager/modules/targets/darwin/keybindings.nix>
targets.darwin.search

Default search engine.

Type: null or one of "Bing", "DuckDuckGo", "Ecosia", "Google", "Yahoo"

Default: null

Declared by:

<home-manager/modules/targets/darwin/search.nix> @@ -11751,19 +10052,11 @@ path. This should be done if you want to use the NixOS Sway module to install Sway.

Type: null or package

Default: ${pkgs.sway}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> -
wayland.windowManager.sway.config

Sway configuration options.

Type: null or (submodule)

Default: - { - - } -

Declared by:

+
wayland.windowManager.sway.config

Sway configuration options.

Type: null or (submodule)

Default: { }

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.assigns

An attribute set that assigns applications to workspaces based on criteria. -

Type: attribute set of list of attribute set of (string or boolean)

Default: - { - - } -

Example:

{
+

Type: attribute set of list of attribute set of (string or boolean)

Default: { }

Example:

{
 "1: web" = [{ class = "^Firefox$"; }];
 "0: extra" = [{ class = "^Firefox$"; window_role = "About"; }];
 }
@@ -11778,29 +10071,25 @@ See default values for the reference.
 Note that 'background', 'status', and 'separator' parameters take a single RGB value.
 
 See https://i3wm.org/docs/userguide.html#_colors.
-

Type: submodule

Default: - { - - } -

Declared by:

+

Type: submodule

Default: { }

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.bars.*.colors.activeWorkspace

Border, background and text color for a workspace button when the workspace is active.

Type: null or (submodule)

Default:

null for state version ≥ 20.09, as example otherwise
-

Example: - { - background = "#5f676a"; border = "#333333"; text = "#ffffff"; - } -

Declared by:

+

Example:

{
+  background = "#5f676a";
+  border = "#333333";
+  text = "#ffffff";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.bars.*.colors.background

Background color of the bar.

Type: null or string

Default:

null for state version ≥ 20.09, as example otherwise
 

Example: "#000000"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.bars.*.colors.bindingMode

Border, background and text color for the binding mode indicator

Type: null or (submodule)

Default:

null for state version ≥ 20.09, as example otherwise
-

Example: - { - background = "#900000"; border = "#2f343a"; text = "#ffffff"; - } -

Declared by:

+

Example:

{
+  background = "#900000";
+  border = "#2f343a";
+  text = "#ffffff";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.bars.*.colors.focusedBackground

Background color of the bar on the currently focused monitor output.

Type: null or string

Default: null

Example: "#000000"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> @@ -11810,20 +10099,20 @@ See wayland.windowManager.sway.config.bars.*.colors.focusedWorkspace

Border, background and text color for a workspace button when the workspace has focus.

Type: null or (submodule)

Default:

null for state version ≥ 20.09, as example otherwise
-

Example: - { - background = "#285577"; border = "#4c7899"; text = "#ffffff"; - } -

Declared by:

+

Example:

{
+  background = "#285577";
+  border = "#4c7899";
+  text = "#ffffff";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.bars.*.colors.inactiveWorkspace

Border, background and text color for a workspace button when the workspace does not have focus and is not active.

Type: null or (submodule)

Default:

null for state version ≥ 20.09, as example otherwise
-

Example: - { - background = "#222222"; border = "#333333"; text = "#888888"; - } -

Declared by:

+

Example:

{
+  background = "#222222";
+  border = "#333333";
+  text = "#888888";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.bars.*.colors.separator

Text color to be used for the separator.

Type: null or string

Default:

null for state version ≥ 20.09, as example otherwise
 

Example: "#666666"

Declared by:

@@ -11834,21 +10123,17 @@ have focus and is not active.
wayland.windowManager.sway.config.bars.*.colors.urgentWorkspace

Border, background and text color for a workspace button when the workspace contains a window with the urgency hint set.

Type: null or (submodule)

Default:

null for state version ≥ 20.09, as example otherwise
-

Example: - { - background = "#900000"; border = "#2f343a"; text = "#ffffff"; - } -

Declared by:

+

Example:

{
+  background = "#900000";
+  border = "#2f343a";
+  text = "#ffffff";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.bars.*.command

Command that will be used to start a bar.

Type: string

Default: "i3bar"

Example: "\${pkgs.waybar}/bin/waybar"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.bars.*.extraConfig

Extra configuration lines for this bar.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> -
wayland.windowManager.sway.config.bars.*.fonts

Font configuration for this bar.

Type: (list of string) or (submodule)

Default: - { - - } -

Example:

{
+                
wayland.windowManager.sway.config.bars.*.fonts

Font configuration for this bar.

Type: (list of string) or (submodule)

Default: { }

Example:

{
   names = [ "DejaVu Sans Mono" "FontAwesome5Free" ];
   style = "Bold Semi-Condensed";
   size = 11.0;
@@ -11890,49 +10175,55 @@ and RGB color hex-codes as values. See default values for the reference.
 Note that 'sway.config.colors.background' parameter takes a single RGB value.
 
 See https://i3wm.org/docs/userguide.html#_changing_colors.
-

Type: submodule

Default: - { - - } -

Declared by:

+

Type: submodule

Default: { }

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.colors.background

Background color of the window. Only applications which do not cover the whole area expose the color.

Type: string

Default: "#ffffff"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> -
wayland.windowManager.sway.config.colors.focused

A window which currently has the focus.

Type: submodule

Default: - { - background = "#285577"; border = "#4c7899"; childBorder = "#285577"; indicator = "#2e9ef4"; text = "#ffffff"; - } -

Declared by:

+
wayland.windowManager.sway.config.colors.focused

A window which currently has the focus.

Type: submodule

Default:

{
+  background = "#285577";
+  border = "#4c7899";
+  childBorder = "#285577";
+  indicator = "#2e9ef4";
+  text = "#ffffff";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.colors.focusedInactive

A window which is the focused one of its container, but it does not have the focus at the moment. -

Type: submodule

Default: - { - background = "#5f676a"; border = "#333333"; childBorder = "#5f676a"; indicator = "#484e50"; text = "#ffffff"; - } -

Declared by:

+

Type: submodule

Default:

{
+  background = "#5f676a";
+  border = "#333333";
+  childBorder = "#5f676a";
+  indicator = "#484e50";
+  text = "#ffffff";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.colors.placeholder

Background and text color are used to draw placeholder window contents (when restoring layouts). Border and indicator are ignored. -

Type: submodule

Default: - { - background = "#0c0c0c"; border = "#000000"; childBorder = "#0c0c0c"; indicator = "#000000"; text = "#ffffff"; - } -

Declared by:

+

Type: submodule

Default:

{
+  background = "#0c0c0c";
+  border = "#000000";
+  childBorder = "#0c0c0c";
+  indicator = "#000000";
+  text = "#ffffff";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> -
wayland.windowManager.sway.config.colors.unfocused

A window which is not focused.

Type: submodule

Default: - { - background = "#222222"; border = "#333333"; childBorder = "#222222"; indicator = "#292d2e"; text = "#888888"; - } -

Declared by:

+
wayland.windowManager.sway.config.colors.unfocused

A window which is not focused.

Type: submodule

Default:

{
+  background = "#222222";
+  border = "#333333";
+  childBorder = "#222222";
+  indicator = "#292d2e";
+  text = "#888888";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> -
wayland.windowManager.sway.config.colors.urgent

A window which has its urgency hint activated.

Type: submodule

Default: - { - background = "#900000"; border = "#2f343a"; childBorder = "#900000"; indicator = "#900000"; text = "#ffffff"; - } -

Declared by:

+
wayland.windowManager.sway.config.colors.urgent

A window which has its urgency hint activated.

Type: submodule

Default:

{
+  background = "#900000";
+  border = "#2f343a";
+  childBorder = "#900000";
+  indicator = "#900000";
+  text = "#ffffff";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.defaultWorkspace

The default workspace to show when sway is launched. This must to correspond to the value of the keybinding of the default workspace. @@ -11940,41 +10231,24 @@ This must to correspond to the value of the keybinding of the default workspace. <home-manager/modules/services/window-managers/i3-sway/sway.nix>

wayland.windowManager.sway.config.down

Home row direction key for moving down.

Type: string

Default: "j"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> -
wayland.windowManager.sway.config.floating

Floating window settings.

Type: submodule

Default: - { - - } -

Declared by:

+
wayland.windowManager.sway.config.floating

Floating window settings.

Type: submodule

Default: { }

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.floating.border

Floating windows border width.

Type: signed integer

Default: 2

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> -
wayland.windowManager.sway.config.floating.criteria

List of criteria for windows that should be opened in a floating mode.

Type: list of attribute set of (string or boolean)

Default: - [ - - ] -

Example: - [ - - { - title = "Steam - Update News"; - } - - { - class = "Pavucontrol"; - } - - ] -

Declared by:

+
wayland.windowManager.sway.config.floating.criteria

List of criteria for windows that should be opened in a floating mode.

Type: list of attribute set of (string or boolean)

Default: [ ]

Example:

[
+  {
+    title = "Steam - Update News";
+  }
+  {
+    class = "Pavucontrol";
+  }
+]

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.floating.modifier

Modifier key that can be used to drag floating windows.

Type: one of "Shift", "Control", "Mod1", "Mod2", "Mod3", "Mod4", "Mod5"

Default: "sway.config.modifier"

Example: "Mod4"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.floating.titlebar

Whether to show floating window titlebars.

Type: boolean

Default: "false"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> -
wayland.windowManager.sway.config.focus

Focus related settings.

Type: submodule

Default: - { - - } -

Declared by:

+
wayland.windowManager.sway.config.focus

Focus related settings.

Type: submodule

Default: { }

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.focus.followMouse

Whether focus should follow the mouse.

Type: one of "yes", "no", "always" or boolean

Default: "yes"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> @@ -11992,11 +10266,7 @@ to a window on a different output. See https://i3wm.org/docs/userguide.html#focus_on_window_activation

Type: one of "smart", "urgent", "focus", "none"

Default: "smart"

Example: "none"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> -
wayland.windowManager.sway.config.fonts

Font configuration for window titles, nagbar...

Type: (list of string) or (submodule)

Default: - { - - } -

Example:

{
+                
wayland.windowManager.sway.config.fonts

Font configuration for window titles, nagbar...

Type: (list of string) or (submodule)

Default: { }

Example:

{
   names = [ "DejaVu Sans Mono" "FontAwesome5Free" ];
   style = "Bold Semi-Condensed";
   size = 11.0;
@@ -12033,19 +10303,11 @@ on workspace with a single container.
                 
wayland.windowManager.sway.config.input

An attribute set that defines input modules. See sway-input(5) for options. -

Type: attribute set of attribute set of string

Default: - { - - } -

Example: - { - * = - { - xkb_variant = "dvorak"; - } - ; - } -

Declared by:

+

Type: attribute set of attribute set of string

Default: { }

Example:

{
+  "*" = {
+    xkb_variant = "dvorak";
+  };
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.keybindings

An attribute set that assigns a key press to an action using a key symbol. See https://i3wm.org/docs/userguide.html#keybindings. @@ -12063,15 +10325,9 @@ in lib.mkOptionDefault { <home-manager/modules/services/window-managers/i3-sway/sway.nix>

wayland.windowManager.sway.config.keycodebindings

An attribute set that assigns keypress to an action using key code. See https://i3wm.org/docs/userguide.html#keybindings. -

Type: attribute set of (null or string)

Default: - { - - } -

Example: - { - 214 = "exec /bin/script.sh"; - } -

Declared by:

+

Type: attribute set of (null or string)

Default: { }

Example:

{
+  "214" = "exec /bin/script.sh";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.left

Home row direction key for moving left.

Type: string

Default: "h"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> @@ -12082,62 +10338,47 @@ inside them Only basic keybinding is supported (bindsym keycomb action), for more advanced setup use 'sway.extraConfig'. -

Type: attribute set of attribute set of string

Default: - { - resize = - { - Down = "resize grow height 10 px"; Escape = "mode default"; Left = "resize shrink width 10 px"; Return = "mode default"; Right = "resize grow width 10 px"; Up = "resize shrink height 10 px"; h = "resize shrink width 10 px"; j = "resize grow height 10 px"; k = "resize shrink height 10 px"; l = "resize grow width 10 px"; - } - ; - } -

Declared by:

+

Type: attribute set of attribute set of string

Default:

{
+  resize = {
+    Down = "resize grow height 10 px";
+    Escape = "mode default";
+    Left = "resize shrink width 10 px";
+    Return = "mode default";
+    Right = "resize grow width 10 px";
+    Up = "resize shrink height 10 px";
+    h = "resize shrink width 10 px";
+    j = "resize grow height 10 px";
+    k = "resize shrink height 10 px";
+    l = "resize grow width 10 px";
+  };
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.modifier

Modifier key that is used for all default keybindings.

Type: one of "Shift", "Control", "Mod1", "Mod2", "Mod3", "Mod4", "Mod5"

Default: "Mod1"

Example: "Mod4"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.output

An attribute set that defines output modules. See sway-output(5) for options. -

Type: attribute set of attribute set of string

Default: - { - - } -

Example: - { - HDMI-A-2 = - { - bg = "~/path/to/background.png fill"; - } - ; - } -

Declared by:

+

Type: attribute set of attribute set of string

Default: { }

Example:

{
+  HDMI-A-2 = {
+    bg = "~/path/to/background.png fill";
+  };
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.right

Home row direction key for moving right.

Type: string

Default: "l"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.seat

An attribute set that defines seat modules. See sway-input(5) for options. -

Type: attribute set of attribute set of string

Default: - { - - } -

Example: - { - * = - { - hide_cursor = "when-typing enable"; - } - ; - } -

Declared by:

+

Type: attribute set of attribute set of string

Default: { }

Example:

{
+  "*" = {
+    hide_cursor = "when-typing enable";
+  };
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.startup

Commands that should be executed at startup. See https://i3wm.org/docs/userguide.html#_automatically_starting_applications_on_i3_startup. -

Type: list of (submodule)

Default: - [ - - ] -

Example:

[
+

Type: list of (submodule)

Default: [ ]

Example:

[
 { command = "systemctl --user restart waybar"; always = true; }
 { command = "dropbox start"; }
 { command = "firefox"; }
@@ -12152,33 +10393,20 @@ See wayland.windowManager.sway.config.up

Home row direction key for moving up.

Type: string

Default: "k"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> -
wayland.windowManager.sway.config.window

Window titlebar and border settings.

Type: submodule

Default: - { - - } -

Declared by:

+
wayland.windowManager.sway.config.window

Window titlebar and border settings.

Type: submodule

Default: { }

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.window.border

Window border width.

Type: signed integer

Default: 2

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.window.commands

List of commands that should be executed on specific windows. See for_window swaywm option documentation. -

Type: list of (submodule)

Default: - [ - - ] -

Example: - [ - - { - command = "border pixel 1"; criteria = - { - class = "XTerm"; - } - ; - } - - ] -

Declared by:

+

Type: list of (submodule)

Default: [ ]

Example:

[
+  {
+    command = "border pixel 1";
+    criteria = {
+      class = "XTerm";
+    };
+  }
+]

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.window.commands.*.command

Swaywm command to execute.

Type: string

Example: "border pixel 1"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> @@ -12206,11 +10434,7 @@ back to "1: www". start.

Type: one of "default", "stacking", "tabbed"

Default: "default"

Example: "tabbed"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix> -
wayland.windowManager.sway.config.workspaceOutputAssign

Assign workspaces to outputs.

Type: list of (submodule)

Default: - [ - - ] -

Declared by:

+
wayland.windowManager.sway.config.workspaceOutputAssign

Assign workspaces to outputs.

Type: list of (submodule)

Default: [ ]

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.workspaceOutputAssign.*.output

Name of the output from swaymsg -t get_outputs @@ -12226,25 +10450,22 @@ start. <home-manager/modules/services/window-managers/i3-sway/sway.nix>

wayland.windowManager.sway.extraOptions

Command line arguments passed to launch Sway. Please DO NOT report issues if you use an unsupported GPU (proprietary drivers). -

Type: list of string

Default: - [ - - ] -

Example: - [ - "--verbose" "--debug" "--unsupported-gpu" "--my-next-gpu-wont-be-nvidia" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "--verbose"
+  "--debug"
+  "--unsupported-gpu"
+  "--my-next-gpu-wont-be-nvidia"
+]

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.extraSessionCommands

Shell commands executed just before Sway is started.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-export SDL_VIDEODRIVER=wayland
-# needs qt5.qtwayland in systemPackages
-export QT_QPA_PLATFORM=wayland
-export QT_WAYLAND_DISABLE_WINDOWDECORATION="1"
-# Fix for some Java AWT applications (e.g. Android Studio),
-# use this if they aren't displayed properly:
-export _JAVA_AWT_WM_NONREPARENTING=1
+  export SDL_VIDEODRIVER=wayland
+  # needs qt5.qtwayland in systemPackages
+  export QT_QPA_PLATFORM=wayland
+  export QT_WAYLAND_DISABLE_WINDOWDECORATION="1"
+  # Fix for some Java AWT applications (e.g. Android Studio),
+  # use this if they aren't displayed properly:
+  export _JAVA_AWT_WM_NONREPARENTING=1
 ''

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.swaynag.enable

Whether to enable configuration of swaynag, a lightweight error bar for sway.

Type: boolean

Default: false

Example: true

Declared by:

@@ -12257,11 +10478,7 @@ See for a list of available options and an example configuration. Note, configurations declared under <config> will override the default type values of swaynag. -

Type: attribute set of attribute set of (Swaynag config atom (null, bool, int, float, str))

Default: - { - - } -

Example:

{
+

Type: attribute set of attribute set of (Swaynag config atom (null, bool, int, float, str))

Default: { }

Example:

{
   "<config>" = {
     edge = "bottom";
     font = "Dina 12";
@@ -12286,15 +10503,9 @@ and dbus user environment before reaching the target, including
 

Type: boolean

Default: true

Example: false

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.wrapperFeatures

Attribute set of features to enable in the wrapper. -

Type: submodule

Default: - { - - } -

Example: - { - gtk = true; - } -

Declared by:

+

Type: submodule

Default: { }

Example:

{
+  gtk = true;
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.wrapperFeatures.base

Whether to make use of the base wrapper to execute extra session commands and prepend a dbus-run-session to the sway command. @@ -12310,15 +10521,11 @@ variables for GTK applications.

xdg.enable

Whether to enable management of XDG base directories.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/misc/xdg.nix>
xdg.cacheHome

Absolute path to directory holding application caches. -

Type: path

Default: "~/.cache"

Declared by:

+

Type: path

Declared by:

<home-manager/modules/misc/xdg.nix>
xdg.configFile

Attribute set of files to link into the user's XDG configuration home. -

Type: attribute set of (submodule)

Default: - { - - } -

Declared by:

+

Type: attribute set of (submodule)

Default: { }

Declared by:

<home-manager/modules/misc/xdg.nix>
xdg.configFile.<name>.executable

Set the execute bit. If null, defaults to the mode of the source file or to false @@ -12353,7 +10560,7 @@ containing that text.

Type: path

Declared by:

<home-manager/modules/misc/xdg.nix>
xdg.configFile.<name>.target

Path to target file relative to xdg.configHome. -

Type: string

Default: <name>

Declared by:

+

Type: string

Declared by:

<home-manager/modules/misc/xdg.nix>
xdg.configFile.<name>.text

Text of the file. If this option is null then home.file.<name>.source @@ -12361,15 +10568,11 @@ must be set.

Type: null or strings concatenated with "\n"

Default: null

Declared by:

<home-manager/modules/misc/xdg.nix>
xdg.configHome

Absolute path to directory holding application configurations. -

Type: path

Default: "~/.config"

Declared by:

+

Type: path

Declared by:

<home-manager/modules/misc/xdg.nix>
xdg.dataFile

Attribute set of files to link into the user's XDG data home. -

Type: attribute set of (submodule)

Default: - { - - } -

Declared by:

+

Type: attribute set of (submodule)

Default: { }

Declared by:

<home-manager/modules/misc/xdg.nix>
xdg.dataFile.<name>.executable

Set the execute bit. If null, defaults to the mode of the source file or to false @@ -12404,7 +10607,7 @@ containing that text.

Type: path

Declared by:

<home-manager/modules/misc/xdg.nix>
xdg.dataFile.<name>.target

Path to target file relative to xdg.dataHome. -

Type: string

Default: <name>

Declared by:

+

Type: string

Declared by:

<home-manager/modules/misc/xdg.nix>
xdg.dataFile.<name>.text

Text of the file. If this option is null then home.file.<name>.source @@ -12412,16 +10615,12 @@ must be set.

Type: null or strings concatenated with "\n"

Default: null

Declared by:

<home-manager/modules/misc/xdg.nix>
xdg.dataHome

Absolute path to directory holding application data. -

Type: path

Default: "~/.local/share"

Declared by:

+

Type: path

Declared by:

<home-manager/modules/misc/xdg.nix>
xdg.desktopEntries

Desktop Entries allow applications to be shown in your desktop environment's app launcher.

You can define entries for programs without entries or override existing entries.

See https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#recognized-keys for more information on options. -

Type: attribute set of (submodule)

Default: - { - - } -

Example:

{
+

Type: attribute set of (submodule)

Default: { }

Example:

{
   firefox = {
     name = "Firefox";
     genericName = "Web Browser";
@@ -12469,11 +10668,7 @@ This can be useful to e.g. associate this application with MIME types.
                     <home-manager/modules/misc/xdg-desktop-entries.nix>
                 
xdg.desktopEntries.<name>.settings

Extra key-value pairs to add to the [Desktop Entry] section. This may override other values. -

Type: attribute set of Concatenated string

Default: - { - - } -

Example:

{
+

Type: attribute set of Concatenated string

Default: { }

Example:

{
   Keywords = "calc;math";
   DBusActivatable = "false";
 }
@@ -12505,11 +10700,7 @@ The generated file is read-only.
                 
xdg.mimeApps.associations.added

Defines additional associations of applications with mimetypes, as if the .desktop file was listing this mimetype in the first place. -

Type: attribute set of ((list of string) or ((list of string) or string) convertible to it)

Default: - { - - } -

Example:

{
+

Type: attribute set of ((list of string) or ((list of string) or string) convertible to it)

Default: { }

Example:

{
   "mimetype1" = [ "foo1.desktop" "foo2.desktop" "foo3.desktop" ];
   "mimetype2" = "foo4.desktop";
 }
@@ -12518,48 +10709,30 @@ in the first place.
                 
xdg.mimeApps.associations.removed

Removes associations of applications with mimetypes, as if the .desktop file was not listing this mimetype in the first place. -

Type: attribute set of ((list of string) or ((list of string) or string) convertible to it)

Default: - { - - } -

Example: - { - mimetype1 = "foo5.desktop"; - } -

Declared by:

+

Type: attribute set of ((list of string) or ((list of string) or string) convertible to it)

Default: { }

Example:

{
+  mimetype1 = "foo5.desktop";
+}

Declared by:

<home-manager/modules/misc/xdg-mime-apps.nix>
xdg.mimeApps.defaultApplications

The default application to be used for a given mimetype. This is, for instance, the one that will be started when double-clicking on a file in a file manager. If the application is no longer installed, the next application in the list is attempted, and so on. -

Type: attribute set of ((list of string) or ((list of string) or string) convertible to it)

Default: - { - - } -

Example:

{
+

Type: attribute set of ((list of string) or ((list of string) or string) convertible to it)

Default: { }

Example:

{
   "mimetype1" = [ "default1.desktop" "default2.desktop" ];
 }
 

Declared by:

<home-manager/modules/misc/xdg-mime-apps.nix>
xdg.stateHome

Absolute path to directory holding application states. -

Type: path

Default: "~/.local/state"

Declared by:

+

Type: path

Declared by:

<home-manager/modules/misc/xdg.nix>
xdg.systemDirs.config

Directory names to add to XDG_CONFIG_DIRS in the user session. -

Type: list of string

Default: - [ - - ] -

Example: [ "/etc/xdg" ]

Declared by:

+

Type: list of string

Default: [ ]

Example: [ "/etc/xdg" ]

Declared by:

<home-manager/modules/misc/xdg-system-dirs.nix>
xdg.systemDirs.data

Directory names to add to XDG_DATA_DIRS in the user session. -

Type: list of string

Default: - [ - - ] -

Example: [ "/usr/share" "/usr/local/share" ]

Declared by:

+

Type: list of string

Default: [ ]

Example: [ "/usr/share" "/usr/local/share" ]

Declared by:

<home-manager/modules/misc/xdg-system-dirs.nix>
xdg.userDirs.enable

Whether to manage $XDG_CONFIG_HOME/user-dirs.dirs.

@@ -12590,11 +10763,7 @@ The generated file is read-only.

xdg.userDirs.videos

The Videos directory.

Type: null or (string or path convertible to it)

Default: "${config.home.homeDirectory}/Videos"

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix>
xfconf.settings

Settings to write to the Xfconf configuration system. -

Type: xfconf settings

Default: - { - - } -

Example:

{
+

Type: xfconf settings

Default: { }

Example:

{
   xfce4-session = {
     "startup/ssh-agent/enabled" = false;
     "general/LockCommand" = "${pkgs.lightdm}/bin/dm-tool lock";
@@ -12672,11 +10841,7 @@ should write the X session script.
                     <home-manager/modules/services/window-managers/awesome.nix>
                 
xsession.windowManager.awesome.luaModules

List of lua packages available for being used in the Awesome configuration. -

Type: list of package

Default: - [ - - ] -

Example: [ pkgs.luaPackages.vicious ]

Declared by:

+

Type: list of package

Default: [ ]

Example: [ pkgs.luaPackages.vicious ]

Declared by:

<home-manager/modules/services/window-managers/awesome.nix>
xsession.windowManager.awesome.noArgb

Disable client transparency support, which can be greatly detrimental to performance in some setups @@ -12695,30 +10860,21 @@ re-run bspwmrc.

Type: boolean

Default: true

Declared by:

<home-manager/modules/services/window-managers/bspwm/default.nix>
xsession.windowManager.bspwm.extraConfig

Additional shell commands to be run at the end of the config file.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-bspc subscribe all > ~/bspc-report.log &
+  bspc subscribe all > ~/bspc-report.log &
 ''

Declared by:

<home-manager/modules/services/window-managers/bspwm/default.nix>
xsession.windowManager.bspwm.extraConfigEarly

Like extraConfig, except commands are run at the start of the config file.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/services/window-managers/bspwm/default.nix> -
xsession.windowManager.bspwm.monitors

Specifies the names of desktops to create on each monitor.

Type: attribute set of list of string

Default: - { - - } -

Example: - { - HDMI-0 = - [ - "web" "terminal" "III" "IV" - ] - ; - } -

Declared by:

+
xsession.windowManager.bspwm.monitors

Specifies the names of desktops to create on each monitor.

Type: attribute set of list of string

Default: { }

Example:

{
+  HDMI-0 = [
+    "web"
+    "terminal"
+    "III"
+    "IV"
+  ];
+}

Declared by:

<home-manager/modules/services/window-managers/bspwm/default.nix> -
xsession.windowManager.bspwm.rules

Rule configuration. The keys of the attribute set are the targets of the rules.

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

Default: - { - - } -

Example:

{
+                
xsession.windowManager.bspwm.rules

Rule configuration. The keys of the attribute set are the targets of the rules.

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

Default: { }

Example:

{
   "Gimp" = {
     desktop = "^8";
     state = "floating";
@@ -12772,38 +10928,29 @@ e.g. screenshot tools.
                     <home-manager/modules/services/window-managers/bspwm/default.nix>
                 
xsession.windowManager.bspwm.rules.<name>.splitRatio

The ratio between the new window and the previous existing window in the desktop. -

Type: null or floating point number

Default: null

Example:

Declared by:

+

Type: null or floating point number

Default: null

Example: 0.65

Declared by:

<home-manager/modules/services/window-managers/bspwm/default.nix>
xsession.windowManager.bspwm.rules.<name>.state

The state in which a new window should spawn.

Type: null or one of "tiled", "pseudo_tiled", "floating", "fullscreen"

Default: null

Example: "floating"

Declared by:

<home-manager/modules/services/window-managers/bspwm/default.nix>
xsession.windowManager.bspwm.rules.<name>.sticky

Whether the node should stay on the focused desktop.

Type: null or boolean

Default: null

Example: true

Declared by:

<home-manager/modules/services/window-managers/bspwm/default.nix> -
xsession.windowManager.bspwm.settings

General settings given to bspc config.

Type: attribute set of (boolean or signed integer or floating point number or string or list of (boolean or signed integer or floating point number or string))

Default: - { - - } -

Example: - { - border_width = 2; gapless_monocle = true; split_ratio = ; - } -

Declared by:

+
xsession.windowManager.bspwm.settings

General settings given to bspc config.

Type: attribute set of (boolean or signed integer or floating point number or string or list of (boolean or signed integer or floating point number or string))

Default: { }

Example:

{
+  border_width = 2;
+  gapless_monocle = true;
+  split_ratio = 0.52;
+}

Declared by:

<home-manager/modules/services/window-managers/bspwm/default.nix> -
xsession.windowManager.bspwm.startupPrograms

Programs to be executed during startup.

Type: list of string

Default: - [ - - ] -

Example: - [ - "numlockx on" "tilda" - ] -

Declared by:

+
xsession.windowManager.bspwm.startupPrograms

Programs to be executed during startup.

Type: list of string

Default: [ ]

Example:

[
+  "numlockx on"
+  "tilda"
+]

Declared by:

<home-manager/modules/services/window-managers/bspwm/default.nix>
xsession.windowManager.command

Command to use to start the window manager.

The default value allows integration with NixOS' generated xserver configuration.

Extra actions and commands can be specified in xsession.initExtra. -

Type: string

Default: ''test -n "$1" && eval "$@"''

Example:

let
+

Type: string

Default: "test -n \"$1\" && eval \"$@\""

Example:

let
   xmonad = pkgs.xmonad-with-packages.override {
     packages = self: [ self.xmonad-contrib self.taffybar ];
   };
@@ -12823,15 +10970,10 @@ in
                 
xsession.windowManager.fluxbox.extraCommandLineArgs

Extra command line arguments to pass to fluxbox. Look at the fluxbox(1) manpage for details. -

Type: list of string

Default: - [ - - ] -

Example: - [ - "-log" "/tmp/fluxbox.log" - ] -

Declared by:

+

Type: list of string

Default: [ ]

Example:

[
+  "-log"
+  "/tmp/fluxbox.log"
+]

Declared by:

<home-manager/modules/services/window-managers/fluxbox.nix>
xsession.windowManager.fluxbox.init

Init configuration for Fluxbox, written to ~/.fluxbox/init. Look at the @@ -12868,56 +11010,36 @@ manpage for details.

xsession.windowManager.herbstluftwm.extraConfig

Extra configuration lines to add verbatim to $XDG_CONFIG_HOME/herbstluftwm/autostart.

Type: strings concatenated with "\n"

Default: ""

Example:

''
-herbstclient set_layout max
-herbstclient detect_monitors
+  herbstclient set_layout max
+  herbstclient detect_monitors
 ''

Declared by:

<home-manager/modules/services/window-managers/herbstluftwm.nix> -
xsession.windowManager.herbstluftwm.keybinds

Herbstluftwm keybinds.

Type: attribute set of string

Default: - { - - } -

Example:

{
+                
xsession.windowManager.herbstluftwm.keybinds

Herbstluftwm keybinds.

Type: attribute set of string

Default: { }

Example:

{
   Mod4-o = "split right";
   Mod4-u = "split bottom";
 }
 

Declared by:

<home-manager/modules/services/window-managers/herbstluftwm.nix> -
xsession.windowManager.herbstluftwm.mousebinds

Herbstluftwm mousebinds.

Type: attribute set of string

Default: - { - - } -

Example:

{
+                
xsession.windowManager.herbstluftwm.mousebinds

Herbstluftwm mousebinds.

Type: attribute set of string

Default: { }

Example:

{
   Mod4-B1 = "move";
   Mod4-B3 = "resize";
 }
 

Declared by:

<home-manager/modules/services/window-managers/herbstluftwm.nix> -
xsession.windowManager.herbstluftwm.rules

Herbstluftwm rules.

Type: list of string

Default: - [ - - ] -

Example:

[
+                
xsession.windowManager.herbstluftwm.rules

Herbstluftwm rules.

Type: list of string

Default: [ ]

Example:

[
   "windowtype~'_NET_WM_WINDOW_TYPE_(DIALOG|UTILITY|SPLASH)' focus=on pseudotile=on"
   "windowtype~'_NET_WM_WINDOW_TYPE_(NOTIFICATION|DOCK|DESKTOP)' manage=off"
 ]
 

Declared by:

<home-manager/modules/services/window-managers/herbstluftwm.nix> -
xsession.windowManager.herbstluftwm.settings

Herbstluftwm settings.

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

Default: - { - - } -

Example:

{
+                
xsession.windowManager.herbstluftwm.settings

Herbstluftwm settings.

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

Default: { }

Example:

{
   gapless_grid = false;
   window_border_width = 1;
   window_border_active_color = "#FF0000";
 }
 

Declared by:

<home-manager/modules/services/window-managers/herbstluftwm.nix> -
xsession.windowManager.herbstluftwm.tags

Tags to create on startup.

Type: list of string

Default: - [ - - ] -

Example:

[ "work" "browser" "music" "gaming" ]
+                
xsession.windowManager.herbstluftwm.tags

Tags to create on startup.

Type: list of string

Default: [ ]

Example:

[ "work" "browser" "music" "gaming" ]
 

Declared by:

<home-manager/modules/services/window-managers/herbstluftwm.nix>
xsession.windowManager.i3.enable

Whether to enable i3 window manager.

Type: boolean

Default: false

Example: true

Declared by:

@@ -12926,19 +11048,11 @@ herbstclient detect_monitors If 'i3.config.gaps' settings are specified, 'pkgs.i3-gaps' will be set as a default package.

Type: package

Default: pkgs.i3

Example: pkgs.i3-gaps

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> -
xsession.windowManager.i3.config

i3 configuration options.

Type: null or (submodule)

Default: - { - - } -

Declared by:

+
xsession.windowManager.i3.config

i3 configuration options.

Type: null or (submodule)

Default: { }

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.assigns

An attribute set that assigns applications to workspaces based on criteria. -

Type: attribute set of list of attribute set of (string or boolean)

Default: - { - - } -

Example:

{
+

Type: attribute set of list of attribute set of (string or boolean)

Default: { }

Example:

{
 "1: web" = [{ class = "^Firefox$"; }];
 "0: extra" = [{ class = "^Firefox$"; window_role = "About"; }];
 }
@@ -12953,29 +11067,25 @@ See default values for the reference.
 Note that 'background', 'status', and 'separator' parameters take a single RGB value.
 
 See https://i3wm.org/docs/userguide.html#_colors.
-

Type: submodule

Default: - { - - } -

Declared by:

+

Type: submodule

Default: { }

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.bars.*.colors.activeWorkspace

Border, background and text color for a workspace button when the workspace is active.

Type: null or (submodule)

Default:

null for state version ≥ 20.09, as example otherwise
-

Example: - { - background = "#5f676a"; border = "#333333"; text = "#ffffff"; - } -

Declared by:

+

Example:

{
+  background = "#5f676a";
+  border = "#333333";
+  text = "#ffffff";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.bars.*.colors.background

Background color of the bar.

Type: null or string

Default:

null for state version ≥ 20.09, as example otherwise
 

Example: "#000000"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.bars.*.colors.bindingMode

Border, background and text color for the binding mode indicator

Type: null or (submodule)

Default:

null for state version ≥ 20.09, as example otherwise
-

Example: - { - background = "#900000"; border = "#2f343a"; text = "#ffffff"; - } -

Declared by:

+

Example:

{
+  background = "#900000";
+  border = "#2f343a";
+  text = "#ffffff";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.bars.*.colors.focusedBackground

Background color of the bar on the currently focused monitor output.

Type: null or string

Default: null

Example: "#000000"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> @@ -12985,20 +11095,20 @@ See xsession.windowManager.i3.config.bars.*.colors.focusedWorkspace

Border, background and text color for a workspace button when the workspace has focus.

Type: null or (submodule)

Default:

null for state version ≥ 20.09, as example otherwise
-

Example: - { - background = "#285577"; border = "#4c7899"; text = "#ffffff"; - } -

Declared by:

+

Example:

{
+  background = "#285577";
+  border = "#4c7899";
+  text = "#ffffff";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.bars.*.colors.inactiveWorkspace

Border, background and text color for a workspace button when the workspace does not have focus and is not active.

Type: null or (submodule)

Default:

null for state version ≥ 20.09, as example otherwise
-

Example: - { - background = "#222222"; border = "#333333"; text = "#888888"; - } -

Declared by:

+

Example:

{
+  background = "#222222";
+  border = "#333333";
+  text = "#888888";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.bars.*.colors.separator

Text color to be used for the separator.

Type: null or string

Default:

null for state version ≥ 20.09, as example otherwise
 

Example: "#666666"

Declared by:

@@ -13009,21 +11119,17 @@ have focus and is not active.
xsession.windowManager.i3.config.bars.*.colors.urgentWorkspace

Border, background and text color for a workspace button when the workspace contains a window with the urgency hint set.

Type: null or (submodule)

Default:

null for state version ≥ 20.09, as example otherwise
-

Example: - { - background = "#900000"; border = "#2f343a"; text = "#ffffff"; - } -

Declared by:

+

Example:

{
+  background = "#900000";
+  border = "#2f343a";
+  text = "#ffffff";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.bars.*.command

Command that will be used to start a bar.

Type: string

Default: "i3bar"

Example: "\${pkgs.i3-gaps}/bin/i3bar -t"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.bars.*.extraConfig

Extra configuration lines for this bar.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> -
xsession.windowManager.i3.config.bars.*.fonts

Font configuration for this bar.

Type: (list of string) or (submodule)

Default: - { - - } -

Example:

{
+                
xsession.windowManager.i3.config.bars.*.fonts

Font configuration for this bar.

Type: (list of string) or (submodule)

Default: { }

Example:

{
   names = [ "DejaVu Sans Mono" "FontAwesome5Free" ];
   style = "Bold Semi-Condensed";
   size = 11.0;
@@ -13062,89 +11168,78 @@ and RGB color hex-codes as values. See default values for the reference.
 Note that 'i3.config.colors.background' parameter takes a single RGB value.
 
 See https://i3wm.org/docs/userguide.html#_changing_colors.
-

Type: submodule

Default: - { - - } -

Declared by:

+

Type: submodule

Default: { }

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.colors.background

Background color of the window. Only applications which do not cover the whole area expose the color.

Type: string

Default: "#ffffff"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> -
xsession.windowManager.i3.config.colors.focused

A window which currently has the focus.

Type: submodule

Default: - { - background = "#285577"; border = "#4c7899"; childBorder = "#285577"; indicator = "#2e9ef4"; text = "#ffffff"; - } -

Declared by:

+
xsession.windowManager.i3.config.colors.focused

A window which currently has the focus.

Type: submodule

Default:

{
+  background = "#285577";
+  border = "#4c7899";
+  childBorder = "#285577";
+  indicator = "#2e9ef4";
+  text = "#ffffff";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.colors.focusedInactive

A window which is the focused one of its container, but it does not have the focus at the moment. -

Type: submodule

Default: - { - background = "#5f676a"; border = "#333333"; childBorder = "#5f676a"; indicator = "#484e50"; text = "#ffffff"; - } -

Declared by:

+

Type: submodule

Default:

{
+  background = "#5f676a";
+  border = "#333333";
+  childBorder = "#5f676a";
+  indicator = "#484e50";
+  text = "#ffffff";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.colors.placeholder

Background and text color are used to draw placeholder window contents (when restoring layouts). Border and indicator are ignored. -

Type: submodule

Default: - { - background = "#0c0c0c"; border = "#000000"; childBorder = "#0c0c0c"; indicator = "#000000"; text = "#ffffff"; - } -

Declared by:

+

Type: submodule

Default:

{
+  background = "#0c0c0c";
+  border = "#000000";
+  childBorder = "#0c0c0c";
+  indicator = "#000000";
+  text = "#ffffff";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> -
xsession.windowManager.i3.config.colors.unfocused

A window which is not focused.

Type: submodule

Default: - { - background = "#222222"; border = "#333333"; childBorder = "#222222"; indicator = "#292d2e"; text = "#888888"; - } -

Declared by:

+
xsession.windowManager.i3.config.colors.unfocused

A window which is not focused.

Type: submodule

Default:

{
+  background = "#222222";
+  border = "#333333";
+  childBorder = "#222222";
+  indicator = "#292d2e";
+  text = "#888888";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> -
xsession.windowManager.i3.config.colors.urgent

A window which has its urgency hint activated.

Type: submodule

Default: - { - background = "#900000"; border = "#2f343a"; childBorder = "#900000"; indicator = "#900000"; text = "#ffffff"; - } -

Declared by:

+
xsession.windowManager.i3.config.colors.urgent

A window which has its urgency hint activated.

Type: submodule

Default:

{
+  background = "#900000";
+  border = "#2f343a";
+  childBorder = "#900000";
+  indicator = "#900000";
+  text = "#ffffff";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.defaultWorkspace

The default workspace to show when i3 is launched. This must to correspond to the value of the keybinding of the default workspace.

Type: null or string

Default: null

Example: "workspace number 9"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> -
xsession.windowManager.i3.config.floating

Floating window settings.

Type: submodule

Default: - { - - } -

Declared by:

+
xsession.windowManager.i3.config.floating

Floating window settings.

Type: submodule

Default: { }

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.floating.border

Floating windows border width.

Type: signed integer

Default: 2

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> -
xsession.windowManager.i3.config.floating.criteria

List of criteria for windows that should be opened in a floating mode.

Type: list of attribute set of (string or boolean)

Default: - [ - - ] -

Example: - [ - - { - title = "Steam - Update News"; - } - - { - class = "Pavucontrol"; - } - - ] -

Declared by:

+
xsession.windowManager.i3.config.floating.criteria

List of criteria for windows that should be opened in a floating mode.

Type: list of attribute set of (string or boolean)

Default: [ ]

Example:

[
+  {
+    title = "Steam - Update News";
+  }
+  {
+    class = "Pavucontrol";
+  }
+]

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.floating.modifier

Modifier key that can be used to drag floating windows.

Type: one of "Shift", "Control", "Mod1", "Mod2", "Mod3", "Mod4", "Mod5"

Default: "i3.config.modifier"

Example: "Mod4"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.floating.titlebar

Whether to show floating window titlebars.

Type: boolean

Default: "xsession.windowManager.i3.package != nixpkgs.i3-gaps (titlebar should be disabled for i3-gaps)"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> -
xsession.windowManager.i3.config.focus

Focus related settings.

Type: submodule

Default: - { - - } -

Declared by:

+
xsession.windowManager.i3.config.focus

Focus related settings.

Type: submodule

Default: { }

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.focus.followMouse

Whether focus should follow the mouse.

Type: boolean

Default: true

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> @@ -13162,11 +11257,7 @@ to a window on a different output. See https://i3wm.org/docs/userguide.html#focus_on_window_activation

Type: one of "smart", "urgent", "focus", "none"

Default: "smart"

Example: "none"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> -
xsession.windowManager.i3.config.fonts

Font configuration for window titles, nagbar...

Type: (list of string) or (submodule)

Default: - { - - } -

Example:

{
+                
xsession.windowManager.i3.config.fonts

Font configuration for window titles, nagbar...

Type: (list of string) or (submodule)

Default: { }

Example:

{
   names = [ "DejaVu Sans Mono" "FontAwesome5Free" ];
   style = "Bold Semi-Condensed";
   size = 11.0;
@@ -13216,15 +11307,9 @@ in lib.mkOptionDefault {
                     <home-manager/modules/services/window-managers/i3-sway/i3.nix>
                 
xsession.windowManager.i3.config.keycodebindings

An attribute set that assigns keypress to an action using key code. See https://i3wm.org/docs/userguide.html#keybindings. -

Type: attribute set of (null or string)

Default: - { - - } -

Example: - { - 214 = "exec /bin/script.sh"; - } -

Declared by:

+

Type: attribute set of (null or string)

Default: { }

Example:

{
+  "214" = "exec /bin/script.sh";
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.menu

Default launcher to use.

Type: string

Default: "\${pkgs.dmenu}/bin/dmenu_run"

Example: "bemenu-run"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> @@ -13233,26 +11318,23 @@ inside them Only basic keybinding is supported (bindsym keycomb action), for more advanced setup use 'i3.extraConfig'. -

Type: attribute set of attribute set of string

Default: - { - resize = - { - Down = "resize grow height 10 px or 10 ppt"; Escape = "mode default"; Left = "resize shrink width 10 px or 10 ppt"; Return = "mode default"; Right = "resize grow width 10 px or 10 ppt"; Up = "resize shrink height 10 px or 10 ppt"; - } - ; - } -

Declared by:

+

Type: attribute set of attribute set of string

Default:

{
+  resize = {
+    Down = "resize grow height 10 px or 10 ppt";
+    Escape = "mode default";
+    Left = "resize shrink width 10 px or 10 ppt";
+    Return = "mode default";
+    Right = "resize grow width 10 px or 10 ppt";
+    Up = "resize shrink height 10 px or 10 ppt";
+  };
+}

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.modifier

Modifier key that is used for all default keybindings.

Type: one of "Shift", "Control", "Mod1", "Mod2", "Mod3", "Mod4", "Mod5"

Default: "Mod1"

Example: "Mod4"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.startup

Commands that should be executed at startup. See https://i3wm.org/docs/userguide.html#_automatically_starting_applications_on_i3_startup. -

Type: list of (submodule)

Default: - [ - - ] -

Example:

[
+

Type: list of (submodule)

Default: [ ]

Example:

[
 { command = "systemctl --user restart polybar"; always = true; notification = false; }
 { command = "dropbox start"; notification = false; }
 { command = "firefox"; workspace = "1: web"; }
@@ -13274,33 +11356,20 @@ instead. See xsession.windowManager.i3.config.terminal

Default terminal to run.

Type: string

Default: "i3-sensible-terminal"

Example: "alacritty"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> -
xsession.windowManager.i3.config.window

Window titlebar and border settings.

Type: submodule

Default: - { - - } -

Declared by:

+
xsession.windowManager.i3.config.window

Window titlebar and border settings.

Type: submodule

Default: { }

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.window.border

Window border width.

Type: signed integer

Default: 2

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.window.commands

List of commands that should be executed on specific windows. See for_window i3wm option documentation. -

Type: list of (submodule)

Default: - [ - - ] -

Example: - [ - - { - command = "border pixel 1"; criteria = - { - class = "XTerm"; - } - ; - } - - ] -

Declared by:

+

Type: list of (submodule)

Default: [ ]

Example:

[
+  {
+    command = "border pixel 1";
+    criteria = {
+      class = "XTerm";
+    };
+  }
+]

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.window.commands.*.command

i3wm command to execute.

Type: string

Example: "border pixel 1"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> @@ -13328,11 +11397,7 @@ back to "1: www". start.

Type: one of "default", "stacking", "tabbed"

Default: "default"

Example: "tabbed"

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix> -
xsession.windowManager.i3.config.workspaceOutputAssign

Assign workspaces to outputs.

Type: list of (submodule)

Default: - [ - - ] -

Declared by:

+
xsession.windowManager.i3.config.workspaceOutputAssign

Assign workspaces to outputs.

Type: list of (submodule)

Default: [ ]

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.workspaceOutputAssign.*.output

Name of the output from i3-msg -t get_outputs @@ -13349,42 +11414,26 @@ start.

xsession.windowManager.spectrwm.package

Package providing the spectrwm command.

Type: package

Default: pkgs.spectrwm

Declared by:

<home-manager/modules/services/window-managers/spectrwm.nix> -
xsession.windowManager.spectrwm.bindings

Spectrwm keybindings.

Type: attribute set of string

Default: - { - - } -

Example:

{
+                
xsession.windowManager.spectrwm.bindings

Spectrwm keybindings.

Type: attribute set of string

Default: { }

Example:

{
   term = "Mod+Return";
   restart = "Mod+Shift+r";
   quit = "Mod+Shift+q";
 }
 

Declared by:

<home-manager/modules/services/window-managers/spectrwm.nix> -
xsession.windowManager.spectrwm.programs

Spectrwm programs variables.

Type: attribute set of string

Default: - { - - } -

Example:

{
+                
xsession.windowManager.spectrwm.programs

Spectrwm programs variables.

Type: attribute set of string

Default: { }

Example:

{
   term = "alacritty";
   search = "dmenu -ip -p 'Window name/id:';
 }
 

Declared by:

<home-manager/modules/services/window-managers/spectrwm.nix> -
xsession.windowManager.spectrwm.quirks

Spectrwm quicks (custom window rules).

Type: attribute set of string

Default: - { - - } -

Example:

{
+                
xsession.windowManager.spectrwm.quirks

Spectrwm quicks (custom window rules).

Type: attribute set of string

Default: { }

Example:

{
   Matplotlib = "FLOAT";
   Pavucontrol = "FLOAT";
 }
 

Declared by:

<home-manager/modules/services/window-managers/spectrwm.nix> -
xsession.windowManager.spectrwm.settings

Spectrwm settings.

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

Default: - { - - } -

Example:

{
+                
xsession.windowManager.spectrwm.settings

Spectrwm settings.

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

Default: { }

Example:

{
   modkey = "Mod4";
   workspace_limit = 5;
   focus_mode = "manual";
@@ -13393,11 +11442,7 @@ start.
 

Declared by:

<home-manager/modules/services/window-managers/spectrwm.nix>
xsession.windowManager.spectrwm.unbindings

List of keybindings to disable from default Spectrwm configuration. -

Type: list of string

Default: - [ - - ] -

Example:

[
+

Type: list of string

Default: [ ]

Example:

[
   "MOD+e"
   "MOD+f"
   "MOD+m"
@@ -13449,11 +11494,7 @@ version used to build xmonad and the packages listed in
 ~/.xmonad/lib/ and included in the configuration
 build. The keys are the file names while the values are paths to the
 contents of the files.
-

Type: attribute set of path

Default: - { - - } -

Example:

{
+

Type: attribute set of path

Default: { }

Example:

{
   "Tools.hs" = pkgs.writeText "Tools.hs" ''
      module Tools where
      screenshot = "scrot"
diff --git a/tools.html b/tools.html
index f4315d64b..c680c176b 100644
--- a/tools.html
+++ b/tools.html
@@ -1,6 +1,6 @@
 
-Appendix D. Tools

Appendix D. Tools

home-manager - — reconfigure a user environment

Name

home-manager +Appendix D. Tools

Appendix D. Tools

home-manager + — reconfigure a user environment

Name

home-manager — reconfigure a user environment

Synopsis

home-manager { build | @@ -84,7 +84,7 @@ | --verbose } - ]

Description

+ ]

Description

This command updates the user environment so that it corresponds to the configuration specified in ~/.config/nixpkgs/home.nix or ~/.config/nixpkgs/flake.nix.

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

-

Options

+

Options

The tool accepts the options

-A attrPath @@ -265,15 +265,15 @@ --verbose

Activates verbose output. -

Files

+

Files

$XDG_DATA_HOME/home-manager/news-read-ids

Identifiers of news items that have been shown. Can be deleted to reset the read news indicator. -

Bugs

+

Bugs

Please report any bugs on the project issue tracker. -

See also

+

See also

home-configuration.nix(5)

\ No newline at end of file