From 9b3b6d25fd516364351fb54e1fbcaaa80b18869f Mon Sep 17 00:00:00 2001 From: rycee Date: Thu, 19 May 2022 21:45:29 +0000 Subject: [PATCH] deploy: e6869735d25bb2d33a93ac8e5fcc9a02bbbb5351 --- index.html | 4 +- nix-darwin-options.html | 4 +- nixos-options.html | 4 +- options.html | 768 ++++++++++++++++++++-------------------- tools.html | 14 +- 5 files changed, 397 insertions(+), 397 deletions(-) diff --git a/index.html b/index.html index 0b024ab52..9bbe3dec3 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -Home Manager Manual
Home Manager Manual
   Next

Home Manager Manual

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

Preface

+Home Manager Manual

Home Manager Manual
   Next

Home Manager Manual

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

-

Type: lazy attribute set of raw values

Declared by:

+

Type: lazy attribute set of raw value

Declared by:

<home-manager/lib/modules.nix>
home-manager.backupFileExtension

On activation move existing files by appending the given file extension rather than exiting with an error. @@ -65,7 +65,7 @@ option can be used to pass additional arguments to all modules.

Example: { inherit emacs-overlay; }

Declared by:

<home-manager/nix-darwin/default.nix>
home-manager.sharedModules

Extra modules added to all users. -

Type: list of Home Manager moduless

Default: +

Type: list of Home Manager modules

Default: [ ] diff --git a/nixos-options.html b/nixos-options.html index 5eadffa7f..385b5cf9a 100644 --- a/nixos-options.html +++ b/nixos-options.html @@ -50,7 +50,7 @@ For NixOS, the default value for this option includes at least this argument: pkgs: The nixpkgs package set according to the nixpkgs.pkgs option.

-

Type: lazy attribute set of raw values

Declared by:

+

Type: lazy attribute set of raw value

Declared by:

<home-manager/lib/modules.nix>
home-manager.backupFileExtension

On activation move existing files by appending the given file extension rather than exiting with an error. @@ -65,7 +65,7 @@ option can be used to pass additional arguments to all modules.

Example: { inherit emacs-overlay; }

Declared by:

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

Extra modules added to all users. -

Type: list of Home Manager moduless

Default: +

Type: list of Home Manager modules

Default: [ ] diff --git a/options.html b/options.html index dff87bb0c..55f884e72 100644 --- a/options.html +++ b/options.html @@ -50,9 +50,9 @@ For NixOS, the default value for this option includes at least this argument: pkgs: The nixpkgs package set according to the nixpkgs.pkgs option.

-

Type: lazy attribute set of raw values

Declared by:

+

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 submodules

Default: +

accounts.email.accounts

List of email accounts.

Type: attribute set of submodule

Default: { } @@ -84,7 +84,7 @@ For NixOS, the default value for this option includes at least this argument: <home-manager/modules/accounts/email.nix>

accounts.email.accounts.<name>.address

The email address of this account.

Type: string matching the pattern .*@.*

Example: "jane.doe@example.org"

Declared by:

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

Alternative email addresses of this account.

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

Default: +

accounts.email.accounts.<name>.aliases

Alternative email addresses of this account.

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

Default: [ ] @@ -97,7 +97,7 @@ For NixOS, the default value for this option includes at least this argument:

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 strings

Default: +

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"; } @@ -120,7 +120,7 @@ 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 anythings

Default: +

Type: attribute set of anything

Default: { } @@ -175,7 +175,7 @@ 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 strings

Default: +

Type: non-empty list of string

Default: [ ] @@ -245,7 +245,7 @@ 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 strings

Default: +

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

IMAP folders to watch.

Type: list of string

Default: [ ] @@ -255,7 +255,7 @@ Note, if set then the system default may still be accepted. ]

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 strings

Default: +

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

Additional configuration to add for this account.

Type: attribute set of boolean or signed integer or string

Default: { } @@ -265,9 +265,9 @@ Note, if set then the system default may still be accepted. }

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 strings

Default: ""

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

Declared by:

+
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 strings

Default: ""

Example: +

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'"; } @@ -310,7 +310,7 @@ 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 strings

Default: +

Type: list of string

Default: [ "CATEGORY_FORUMS" "CATEGORY_PROMOTIONS" "CATEGORY_UPDATES" "CATEGORY_SOCIAL" "CATEGORY_PERSONAL" ] @@ -318,7 +318,7 @@ local tags (before translations). <home-manager/modules/programs/lieer.nix>

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

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

Type: list of strings

Default: +

Type: list of string

Default: [ ] @@ -368,7 +368,7 @@ 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 booleans

Default: +

Type: attribute set of string or signed integer or boolean

Default: { } @@ -379,7 +379,7 @@ the given mail store.

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 booleans

Default: +

Type: attribute set of string or signed integer or boolean

Default: { } @@ -390,14 +390,14 @@ the given mail store.

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 booleans

Default: +

Type: attribute set of string or signed integer or boolean

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 booleans

Default: +

Type: attribute set of string or signed integer or boolean

Default: { } @@ -415,7 +415,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 submodules

Default: +

Type: attribute set of submodule

Default: { } @@ -427,7 +427,7 @@ 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 submodules

Default: +

Type: attribute set of submodule

Default: { } @@ -435,7 +435,7 @@ define the maildir hierarchy as you see fit. <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 booleans

Default: +

Type: attribute set of string or signed integer or boolean

Default: { } @@ -475,7 +475,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -490,7 +490,7 @@ 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 strings

Default: +

Type: list of string

Default: [ "*" ] @@ -519,7 +519,7 @@ 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 strings

Default: +

Type: attribute set of string

Default: { } @@ -545,7 +545,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 submodules

Default: +

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

List of extra mailboxes

Type: list of string or submodule

Default: [ ] @@ -565,7 +565,7 @@ 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 booleans

Default: +

Type: attribute set of string or signed integer or boolean

Default: { } @@ -577,7 +577,7 @@ else <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 booleans

Default: +

Type: attribute set of string or signed integer or boolean

Default: { } @@ -589,7 +589,7 @@ section. <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 booleans

Default: +

Type: attribute set of string or signed integer or boolean

Default: { } @@ -603,7 +603,7 @@ section. <home-manager/modules/programs/offlineimap.nix>

accounts.email.accounts.<name>.passwordCommand

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

Type: null or string or list of strings

Default: null

Example: "secret-tool lookup email me@example.org"

Declared by:

+

Type: null or string or list of string

Default: null

Example: "secret-tool lookup email me@example.org"

Declared by:

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

Whether this is the primary account. Only one account may be set as primary. @@ -674,7 +674,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 valuess

Default: +

Type: attribute set of attribute set of GVariant value

Default: { } @@ -731,7 +731,7 @@ 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 strings

Default: +

gtk.gtk3.bookmarks

Bookmarks in the sidebar of the GTK file browser

Type: list of string

Default: [ ] @@ -743,7 +743,7 @@ is assumed to already be available in your profile. <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 strings

Default: +

Type: attribute set of boolean or signed integer or string

Default: { } @@ -759,7 +759,7 @@ 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 strings

Default: +

Type: attribute set of boolean or signed integer or string

Default: { } @@ -804,7 +804,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 packages

Default: +

home.packages

The set of packages to appear in the user environment.

Type: list of package

Default: [ ] @@ -859,7 +859,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -869,7 +869,7 @@ the user environment. ]

Declared by:

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

Attribute set of files to link into the user home.

Type: attribute set of submodules

Default: +

home.file

Attribute set of files to link into the user home.

Type: attribute set of submodule

Default: { } @@ -936,7 +936,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -1034,7 +1034,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -1090,7 +1090,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 strings

Default: +

Type: attribute set of string

Default: { } @@ -1140,14 +1140,14 @@ 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 packages

Default: +

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 packages

Default: +

Type: list of package

Default: [ ] @@ -1184,7 +1184,7 @@ 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 submodules

Default: +

launchd.agents

Define LaunchAgents.

Type: attribute set of submodule

Default: { } @@ -1244,7 +1244,7 @@ send the SIGKILL signal. <home-manager/modules/launchd/default.nix>

launchd.agents.<name>.config.EnvironmentVariables

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

Type: null or attribute set of strings

Default: null

Declared by:

+

Type: null or attribute set of string

Default: null

Declared by:

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

The amount of time launchd waits before sending a SIGKILL signal. The default value is 20 seconds. The value zero is interpreted as infinity. @@ -1320,11 +1320,11 @@ job cannot be safely respawned without a full machine reboot, then set this key <home-manager/modules/launchd/default.nix>

launchd.agents.<name>.config.LimitLoadFromHosts

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

Type: null or list of strings

Default: null

Declared by:

+

Type: null or list of string

Default: null

Declared by:

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

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

Type: null or list of strings

Default: null

Declared by:

+

Type: null or list of string

Default: null

Declared by:

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

This configuration file only applies to sessions of the type specified. This key is used in concert with the -S flag to launchctl. @@ -1395,11 +1395,11 @@ the absence of the ProgramArguments key. <home-manager/modules/launchd/default.nix>

launchd.agents.<name>.config.ProgramArguments

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

Type: null or list of strings

Default: null

Declared by:

+

Type: null or list of string

Default: null

Declared by:

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

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

Type: null or list of strings

Default: null

Declared by:

+

Type: null or list of string

Default: null

Declared by:

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

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

Type: null or string

Default: null

Declared by:

@@ -1418,12 +1418,12 @@ to be effectively equivalent, even though each file descriptor likely represents protocol which conforms to the criteria specified in the job configuration file. The parameters below are used as inputs to call getaddrinfo(3). -

Type: null or attribute set of submodules

Default: null

Declared by:

+

Type: null or attribute set of submodule

Default: null

Declared by:

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

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

Type: null or boolean or list of strings

Default: null

Declared by:

+

Type: null or boolean or list of string

Default: null

Declared by:

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

This optional key can be used to request that the datagram socket join a multicast group. If the value is a hostname, then getaddrinfo(3) will be used to join the correct multicast address for a @@ -1519,7 +1519,7 @@ are considered to be wildcard. The semantics are much like

Type: null or list of submodules

Default: null

Example: +

Type: null or list of submodule

Default: null

Example: { Hour = 2; Minute = 30; } @@ -1572,7 +1572,7 @@ to attach before any code in the job is executed.

Type: null or boolean

Default: null

Declared by:

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

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

Type: null or list of paths

Default: null

Declared by:

+

Type: null or list of path

Default: null

Declared by:

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

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

Type: null or string

Default: null

Declared by:

@@ -1591,7 +1591,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 sets

Default: +

Type: attribute set of attribute set

Default: { } @@ -1652,7 +1652,7 @@ keep-derivations = true ''

Declared by:

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

User level flake registry. -

Type: attribute set of submodules

Default: +

Type: attribute set of submodule

Default: { } @@ -1666,13 +1666,13 @@ 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 packages

Example: +

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 packages

Example: +

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"; } @@ -1685,7 +1685,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)ss

Default: +

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: { } @@ -1745,7 +1745,7 @@ Like nixpkgs.config this option only applies within the Home Manager configuration. See nixpkgs.config for a suggested setup that works both internally and externally. -

Type: null or list of nixpkgs overlays

Default: null

Example: 

[ (self: super: {
+
Type: null or list of nixpkgs overlay
Default: null
Example: 
[ (self: super: {
     openssh = super.openssh.override {
       hpnSupport = true;
       withKerberos = true;
@@ -1774,7 +1774,7 @@ therefore discouraged.
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 12s

Default: +

Type: list of string of length 12

Default: [ ] @@ -1856,37 +1856,37 @@ enabled for each email account that is managed by Notmuch. }

Declared by:

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

Bufferlist mode keybindings.

Type: attribute set of strings

Default: +

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 strings

Default: +

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 strings

Default: +

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 strings

Default: +

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 strings

Default: +

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 strings

Default: +

programs.alot.bindings.thread

Thread mode keybindings.

Type: attribute set of string

Default: { } @@ -1899,7 +1899,7 @@ 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 numbers

Default: +

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; } @@ -1910,7 +1910,7 @@ enabled for each email account that is managed by Notmuch. }

Declared by:

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

How to display the tags.

Type: attribute set of submodules

Default: +

programs.alot.tags

How to display the tags.

Type: attribute set of submodule

Default: { } @@ -1941,7 +1941,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 strings

Default: +

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

Default: { } @@ -2054,26 +2054,26 @@ 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"s

Default: +

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"s

Default: +

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"s

Default: +

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 submodules

Default: +

programs.autorandr.profiles

Autorandr profiles specification.

Type: attribute set of submodule

Default: { } @@ -2101,7 +2101,7 @@ of options. }

Declared by:

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

Per output profile configuration.

Type: attribute set of submodules

Default: +

programs.autorandr.profiles.<name>.config

Per output profile configuration.

Type: attribute set of submodule

Default: { } @@ -2163,7 +2163,7 @@ 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 strings

Default: +

Type: attribute set of string

Default: { } @@ -2193,7 +2193,7 @@ 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"s

Default: +

programs.bash.historyControl

Controlling how commands are saved on the history list.

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

Default: [ ] @@ -2203,7 +2203,7 @@ Note that these commands will be run even in non-interactive shells. <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 strings

Default: +

programs.bash.historyIgnore

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

Type: list of string

Default: [ ] @@ -2240,7 +2240,7 @@ shell. <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 strings

Default: +

Type: attribute set of string

Default: { } @@ -2252,7 +2252,7 @@ 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 strings

Default: +

Type: list of string

Default: [ "histappend" "checkwinsize" "extglob" "globstar" "checkjobs" ] @@ -2265,7 +2265,7 @@ this option) to command strings or directly to build outputs.

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 stringss

Default: +

Type: attribute set of string or list of string

Default: { } @@ -2280,7 +2280,7 @@ this option) to command strings or directly to build outputs.

Declared by:

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

Additional themes to provide. -

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

Default: +

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

Default: { } @@ -2361,7 +2361,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 strings

Default: +

Type: attribute set of string

Default: { } @@ -2393,7 +2393,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 stringss

Default: +

Type: list of attribute set of boolean or string

Default: [ { @@ -2428,7 +2428,7 @@ 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"s

Default: +

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" ] @@ -2452,7 +2452,7 @@ For a list of common switches, see

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

Type: list of strings

Default: +

Type: list of string

Default: [ ] @@ -2471,7 +2471,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 its

Default: +

Type: list of submodule or string convertible to it

Default: [ ] @@ -2527,7 +2527,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 strings

Default: +

Type: attribute set of string

Default: { } @@ -2583,13 +2583,13 @@ 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 strings

Default: +

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 packages

Default: +

programs.eclipse.plugins

Plugins that should be added to Eclipse.

Type: list of package

Default: [ ] @@ -2638,7 +2638,7 @@ 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 integerss

Default: +

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

Default: { } @@ -2657,7 +2657,7 @@ 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 stringss

Default: +

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

Default: { } @@ -2716,7 +2716,7 @@ 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 packages

Default: +

Type: list of package

Default: [ ] @@ -2726,7 +2726,7 @@ handles extension side-loading. ]

Declared by:

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

Attribute set of Firefox profiles.

Type: attribute set of submodules

Default: +

programs.firefox.profiles

Attribute set of Firefox profiles.

Type: attribute set of submodule

Default: { } @@ -2734,7 +2734,7 @@ handles extension side-loading. <home-manager/modules/programs/firefox.nix>

programs.firefox.profiles.<name>.bookmarks

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

Type: attribute set of submodules

Default: +

Type: attribute set of submodule

Default: { } @@ -2767,7 +2767,7 @@ previously existing bookmarks! <home-manager/modules/programs/firefox.nix>

programs.firefox.profiles.<name>.path

Profile path.

Type: string

Default: "‹name›"

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 strings

Default: +

programs.firefox.profiles.<name>.settings

Attribute set of Firefox preferences.

Type: attribute set of boolean or signed integer or string

Default: { } @@ -2807,7 +2807,7 @@ previously existing bookmarks! <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 submodules

Default: +

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

Default: { } @@ -2831,7 +2831,7 @@ initialisation. <home-manager/modules/programs/fish.nix>

programs.fish.plugins

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

Type: list of submodules

Default: +

Type: list of submodule

Default: [ ] @@ -2874,7 +2874,7 @@ 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 strings

Default: +

Type: attribute set of string

Default: { } @@ -2886,7 +2886,7 @@ the longer phrase after they are entered. <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 strings

Default: +

Type: attribute set of string

Default: { } @@ -2909,7 +2909,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)ss

Default: +

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

Default: { } @@ -2945,7 +2945,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -2960,7 +2960,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -2975,7 +2975,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -2986,7 +2986,7 @@ CTRL-T keybinding.

Declared by:

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

Command line options for the CTRL-R keybinding. -

Type: list of strings

Default: +

Type: list of string

Default: [ ] @@ -3002,7 +3002,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 strings

Default: +

Type: list of string

Default: [ ] @@ -3031,7 +3031,7 @@ See fzf-tmux --help for available

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 strings

Default: +

Type: attribute set of string

Default: { } @@ -3054,7 +3054,7 @@ 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 strings

Default: +

programs.git.aliases

Git aliases to define.

Type: attribute set of string

Default: { } @@ -3064,7 +3064,7 @@ to gain access to git send-email f }

Declared by:

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

List of defining attributes set globally.

Type: list of strings

Default: +

programs.git.attributes

List of defining attributes set globally.

Type: list of string

Default: [ ] @@ -3079,7 +3079,7 @@ See htt

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 integerss

Default: +

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

Default: { } @@ -3130,7 +3130,7 @@ for syntax highlithing. <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 integers or attribute set of string or boolean or signed integer or list of string or boolean or signed integerssss

Default: +

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: { } @@ -3152,7 +3152,7 @@ deprecated and will be removed in the future. }

Declared by:

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

List of paths that should be globally ignored.

Type: list of strings

Default: +

programs.git.ignores

List of paths that should be globally ignored.

Type: list of string

Default: [ ] @@ -3162,7 +3162,7 @@ deprecated and will be removed in the future. ]

Declared by:

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

List of configuration files to include.

Type: list of submodules

Default: +

programs.git.includes

List of configuration files to include.

Type: list of submodule

Default: [ ] @@ -3184,7 +3184,7 @@ matches. Allowed conditions are described in This follows the configuration structure as described in git-config(1). -

Type: attribute set of anythings

Default: +

Type: attribute set of anything

Default: { } @@ -3263,7 +3263,7 @@ exit_popup: Some(( code: Esc, modifiers: ( bits: 0,),)), <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 submodules

Default: +

programs.gnome-terminal.profile

A set of Gnome Terminal profiles.

Type: attribute set of submodule

Default: { } @@ -3313,7 +3313,7 @@ presses the Backspace key. <home-manager/modules/programs/gnome-terminal.nix>

programs.gnome-terminal.profile.<name>.colors.highlight.foreground

The foreground color.

Type: string

Declared by:

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

The terminal palette.

Type: list of strings

Declared by:

+
programs.gnome-terminal.profile.<name>.colors.palette

The terminal palette.

Type: list of string

Declared by:

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

The cursor blink mode.

Type: one of "system", "on", "off"

Default: "system"

Declared by:

<home-manager/modules/programs/gnome-terminal.nix> @@ -3363,7 +3363,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 paths

Default: +

programs.go.packages

Packages to add to GOPATH.

Type: attribute set of path

Default: { } @@ -3377,7 +3377,7 @@ presses the Delete key. after programs.go.goPath, if that option is set. -

Type: list of strings

Default: +

Type: list of string

Default: [ ] @@ -3398,7 +3398,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -3436,7 +3436,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 submodules

Default: +

Type: list of submodule

Default: [ ] @@ -3460,7 +3460,7 @@ for more.

programs.gpg.scdaemonSettings

SCdaemon configuration options. Available options are described in the gpg scdaemon manpage: https://www.gnupg.org/documentation/manuals/gnupg/Scdaemon-Options.html. -

Type: attribute set of string or boolean or list of stringss

Example: 

{
+
Type: attribute set of string or boolean or list of string
Example: 
{
   disable-ccid = true;
 }
 
Declared by:

@@ -3470,7 +3470,7 @@ in the gpg manpage:
 https://gnupg.org/documentation/manpage.html.
 

 Note that lists are converted to duplicate keys.
-
Type: attribute set of string or boolean or list of stringss
Example: 
{
+
Type: attribute set of string or boolean or list of string
Example: 
{
   no-comments = false;
   s2k-cipher-algo = "AES128";
 }
@@ -3485,7 +3485,7 @@ Note that lists are converted to duplicate keys.
 

 See https://docs.helix-editor.com/languages.html
 for more information.
-
Type: list of TOML values
Default: 
+
Type: list of TOML value
Default: 
         [
         
         ]
@@ -3525,7 +3525,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 values
Default: 
+
Type: attribute set of TOML value
Default: 
         {
         
         }
@@ -3589,7 +3589,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 submodules

Default: +

Type: attribute set of submodule

Default: { } @@ -3625,7 +3625,7 @@ 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 strings

Default: +

programs.hexchat.channels.<name>.autojoin

Channels list to autojoin on connecting to server.

Type: list of string

Default: [ ] @@ -3637,7 +3637,7 @@ for the full list of options. <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 strings

Default: +

programs.hexchat.channels.<name>.commands

Commands to be executed on connecting to server.

Type: list of string

Default: [ ] @@ -3681,7 +3681,7 @@ 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 strings

Default: +

programs.hexchat.channels.<name>.servers

IRC Server Address List.

Type: list of string

Default: [ ] @@ -3715,7 +3715,7 @@ configuration files, causing:

programs.hexchat.settings

Configuration for $XDG_CONFIG_HOME/hexchat/hexchat.conf, see https://hexchat.readthedocs.io/en/latest/settings.html#list-of-settings for supported values. -

Type: null or attribute set of strings

Default: null

Example: 

{
+
Type: null or attribute set of string
Default: null
Example: 
{
   irc_nick1 = "mynick";
   irc_username = "bob";
   irc_realname = "Bart Simpson";
@@ -3812,7 +3812,7 @@ the default configuration.
 See
 i3status(1)
 for options.
-
Type: attribute set of boolean or signed integer or strings
Default: 
+
Type: attribute set of boolean or signed integer or string
Default: 
         {
         
         }
@@ -3829,7 +3829,7 @@ for options.
 See
 i3status(1)
 for options.
-
Type: attribute set of submodules
Default: 
+
Type: attribute set of submodule
Default: 
         {
         
         }
@@ -3861,7 +3861,7 @@ for options.
 See
 i3status(1)
 for options.
-
Type: attribute set of boolean or signed integer or strings
Default: 
+
Type: attribute set of boolean or signed integer or string
Default: 
         {
         
         }
@@ -3887,7 +3887,7 @@ top and a bottom bar.
 See
 i3status-rust(1)
 for options.
-
Type: attribute set of submodules
Default: 
+
Type: attribute set of submodule
Default: 
         {
         default = 
         {
@@ -4065,7 +4065,7 @@ 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 strings

Default: +

Type: attribute set of string

Default: { } @@ -4076,7 +4076,7 @@ in this option) to command strings or directly to build outputs. <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 strings

Default: +

programs.irssi.aliases

An attribute set that maps aliases to commands.

Type: attribute set of string

Default: { } @@ -4088,7 +4088,7 @@ in this option) to command strings or directly to build outputs. <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 submodules

Default: +

programs.irssi.networks

An attribute set of chat networks.

Type: attribute set of submodule

Default: { } @@ -4107,13 +4107,13 @@ 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 strings

Default: +

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 submodules

Default: +

programs.irssi.networks.<name>.channels

Channels for the given network.

Type: attribute set of submodule

Default: { } @@ -4190,11 +4190,11 @@ variable. <home-manager/modules/programs/kakoune.nix>

programs.kakoune.config.autoComplete

Modes in which to display possible completions. The kakoune default is [ "insert" "prompt" ]. -

Type: null or list of one of "insert", "prompt"s

Default: null

Declared by:

+

Type: null or list of one of "insert", "prompt"

Default: null

Declared by:

<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"s

Default: null

Example: +

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

Default: null

Example: [ "command" "normal" ] @@ -4210,7 +4210,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 submodules

Default: +

Type: list of submodule

Default: [ ] @@ -4242,7 +4242,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 submodules

Default: +

Type: list of submodule

Default: [ ] @@ -4379,7 +4379,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 packages

Default: +

Type: list of package

Default: [ ] @@ -4403,14 +4403,14 @@ 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 strings

Default: +

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 strings

Default: +

Type: list of string

Default: [ "--quiet" ] @@ -4420,7 +4420,7 @@ supported plugins run:

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 strings

Default: +

Type: list of string

Default: [ "id_rsa" ] @@ -4431,14 +4431,14 @@ supported plugins run:

programs.kitty.package

Kitty package to install.

Type: package

Default: pkgs.kitty

Declared by:

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

Command-line options to use when launched by Mac OS GUI

Type: null or list of strings

Default: null

Example: 

[
+
programs.kitty.darwinLaunchOptions

Command-line options to use when launched by Mac OS GUI

Type: null or list of string

Default: null

Example: 

[
   "--single-instance"
   "--directory=/tmp/my-dir"
   "--listen-on=unix:/tmp/my-socket"
 ]

Declared by:

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

Environment variables to set or override.

Type: attribute set of strings

Default: +

programs.kitty.environment

Environment variables to set or override.

Type: attribute set of string

Default: { } @@ -4462,7 +4462,7 @@ is assumed to already be available in your profile.

programs.kitty.font.size

The size of the font.

Type: null or signed integer

Default: null

Example: "8"

Declared by:

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

Mapping of keybindings to actions.

Type: attribute set of strings

Default: +

programs.kitty.keybindings

Mapping of keybindings to actions.

Type: attribute set of string

Default: { } @@ -4476,7 +4476,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 integers

Default: +

Type: attribute set of string or boolean or signed integer

Default: { } @@ -4506,7 +4506,7 @@ settings as lower level key/value pairs. Kodi will still show the settings of plugins configured via this mechanism in the GUI and they appear to be mutable. This however is not the case and the settings will stay as specified via Home Manager. -

Type: null or attribute set of attribute set of stringss

Default: null

Example: 

{ "service.xbmc.versioncheck".versioncheck_enable = "false"; }
+
Type: null or attribute set of attribute set of string
Default: null
Example: 
{ "service.xbmc.versioncheck".versioncheck_enable = "false"; }
 
Declared by:

                     <home-manager/modules/programs/kodi.nix>
programs.kodi.datadir

Directory to store configuration and metadata.

Type: path

Default: "${config.home.homeDirectory}/.kodi"

Example: "${config.xdg.dataHome}/kodi"

Declared by:

@@ -4579,7 +4579,7 @@ 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 strings

Default: +

Type: attribute set of null or string

Default: { } @@ -4587,7 +4587,7 @@ builtin commands. Keys set to null or an empty string are deleted. <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 strings

Default: +

Type: attribute set of null or string

Default: { } @@ -4601,7 +4601,7 @@ deleted. $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 strings

Default: +

programs.lf.keybindings

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

Type: attribute set of null or string

Default: { } @@ -4838,7 +4838,7 @@ MangoHud is started on any application that supports it. $XDG_CONFIG_HOME/MangoHud/MangoHud.conf. See https://github.com/flightlessmango/MangoHud/blob/master/bin/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 stringss

Default: +

Type: attribute set of boolean or signed integer or floating point number or string or path or list of signed integer or string

Default: { } @@ -4853,7 +4853,7 @@ Configuration written to $XDG_CONFIG_HOME/MangoHud/{application_name}.conf. See https://github.com/flightlessmango/MangoHud/blob/master/bin/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 stringsss

Default: +

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: { } @@ -4868,7 +4868,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 anythings

Default: +

Type: attribute set of anything

Default: { } @@ -4895,7 +4895,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 stringsss

Default: +

Type: attribute set of attribute set of list of string

Default: { } @@ -4931,19 +4931,19 @@ control the default matplotlib behavior. <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 anythings

Default: +

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 anythings or strings concatenated with "\n"

Default: +

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 strings

Default: +

programs.mercurial.ignores

List of globs for files to be globally ignored.

Type: list of string

Default: [ ] @@ -4953,7 +4953,7 @@ control the default matplotlib behavior. ]

Declared by:

<home-manager/modules/programs/mercurial.nix> -
programs.mercurial.ignoresRegexp

List of regular expressions for files to be globally ignored.

Type: list of strings

Default: +

programs.mercurial.ignoresRegexp

List of regular expressions for files to be globally ignored.

Type: list of string

Default: [ ] @@ -4976,7 +4976,7 @@ control the default matplotlib behavior. $XDG_CONFIG_HOME/mpv/input.conf. See mpv(1) for the full list of options. -

Type: attribute set of strings

Default: +

Type: attribute set of string

Default: { } @@ -4991,7 +4991,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 numberss

Default: +

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: { } @@ -5005,7 +5005,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -5018,7 +5018,7 @@ by options set in

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 numbersss

Default: +

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: { } @@ -5034,7 +5034,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 or strings

Default: +

Type: list of package or string

Default: [ ] @@ -5091,7 +5091,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 submodules

Default: +

programs.ncmpcpp.bindings

List of keybindings.

Type: list of submodule

Default: [ ] @@ -5103,7 +5103,7 @@ for more information. ]

Declared by:

<home-manager/modules/programs/ncmpcpp.nix> -
programs.ncmpcpp.bindings.*.command

Command or sequence of commands to be executed.

Type: string or list of strings

Example: "scroll_down"

Declared by:

+
programs.ncmpcpp.bindings.*.command

Command or sequence of commands to be executed.

Type: string or list of string

Example: "scroll_down"

Declared by:

<home-manager/modules/programs/ncmpcpp.nix>
programs.ncmpcpp.bindings.*.key

Key to bind.

Type: string

Example: "j"

Declared by:

<home-manager/modules/programs/ncmpcpp.nix> @@ -5120,7 +5120,7 @@ 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 strings

Default: +

Type: attribute set of boolean or signed integer or string

Default: { } @@ -5152,7 +5152,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"s

Default: +

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

Default: { } @@ -5189,7 +5189,7 @@ csh 1 ^#!\s*/.*\b(csh|tcsh)\s* <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 submodules

Default: +

programs.neomutt.binds

List of keybindings.

Type: list of submodule

Default: [ ] @@ -5199,7 +5199,7 @@ csh 1 ^#!\s*/.*\b(csh|tcsh)\s* <home-manager/modules/programs/neomutt.nix>

programs.neomutt.binds.*.key

The key to bind.

Type: string

Example: "<left>"

Declared by:

<home-manager/modules/programs/neomutt.nix> -
programs.neomutt.binds.*.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"s

Default: "index"

Declared by:

+
programs.neomutt.binds.*.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.changeFolderWhenSourcingAccount

Whether to enable changing the folder when sourcing an account.

Type: boolean

Default: true

Example: true

Declared by:

<home-manager/modules/programs/neomutt.nix> @@ -5209,7 +5209,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 submodules

Default: +

programs.neomutt.macros

List of macros.

Type: list of submodule

Default: [ ] @@ -5219,9 +5219,9 @@ csh 1 ^#!\s*/.*\b(csh|tcsh)\s* <home-manager/modules/programs/neomutt.nix>

programs.neomutt.macros.*.key

The key to bind.

Type: string

Example: "<left>"

Declared by:

<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"s

Default: "index"

Declared by:

+
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 strings

Default: +

programs.neomutt.settings

Extra configuration appended to the end.

Type: attribute set of string

Default: { } @@ -5296,7 +5296,7 @@ and loads it from the store via nvim -u /nix/store This option is mutually exclusive with extraConfig and plugins. -

Type: attribute set of anythings

Default: +

Type: attribute set of anything

Default: { } @@ -5325,9 +5325,9 @@ set nobackup <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 packages

Default: "[]"

Example: (ps: with ps; [ luautf8 ])

Declared by:

+

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 packages

Default: +

programs.neovim.extraPackages

Extra packages available to nvim.

Type: list of package

Default: [ ] @@ -5335,13 +5335,13 @@ list of Lua packages required for your plugins to work. <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. -

Type: python3 packages in python.withPackages format or list of packages

Default: "ps: []"

Example: (ps: with ps; [ python-language-server ])

Declared by:

+

Type: python3 packages in python.withPackages format or list of package

Default: "ps: []"

Example: (ps: with ps; [ python-language-server ])

Declared by:

<home-manager/modules/programs/neovim.nix>
programs.neovim.generatedConfigViml

Generated vimscript config.

Type: strings concatenated with "\n" (read only)

Declared by:

<home-manager/modules/programs/neovim.nix>
programs.neovim.generatedConfigs

Generated configurations with as key their language (set via type). -

Type: attribute set of strings concatenated with "\n"s (read only)

Example: 

{
+
Type: attribute set of strings concatenated with "\n" (read only)
Example: 
{
   viml = ''
     " Generated by home-manager
     set packpath^=/nix/store/cn8vvv4ymxjf8cfzg7db15b2838nqqib-vim-pack-dir
@@ -5360,7 +5360,7 @@ configuration to be placed in init.vim.
 

 
 This option is mutually exclusive with configure.
-
Type: list of package or submodules
Default: 
+
Type: list of package or submodule
Default: 
         [
         
         ]
@@ -5405,7 +5405,7 @@ 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 strings

Default: +

programs.newsboat.queries

A list of queries to use.

Type: attribute set of string

Default: { } @@ -5419,7 +5419,7 @@ use Python 3 plugins. <home-manager/modules/programs/newsboat.nix>

programs.newsboat.reloadTime

Time in minutes between reloads.

Type: null or signed integer

Default: 60

Declared by:

<home-manager/modules/programs/newsboat.nix> -
programs.newsboat.urls

List of news feeds.

Type: list of submodules

Default: +

programs.newsboat.urls

List of news feeds.

Type: list of submodule

Default: [ ] @@ -5437,7 +5437,7 @@ use Python 3 plugins. ]

Declared by:

<home-manager/modules/programs/newsboat.nix> -
programs.newsboat.urls.*.tags

Feed tags.

Type: list of strings

Default: +

programs.newsboat.urls.*.tags

Feed tags.

Type: list of string

Default: [ ] @@ -5467,7 +5467,7 @@ use Python 3 plugins.

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 strings

Default: +

Type: attribute set of string

Default: { } @@ -5480,7 +5480,7 @@ use Python 3 plugins.

Declared by:

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

Extra packages available to nnn. -

Type: list of packages

Default: +

Type: list of package

Default: [ ] @@ -5494,7 +5494,7 @@ use Python 3 plugins.

Declared by:

<home-manager/modules/programs/nnn.nix>
programs.nnn.plugins.mappings

Key mappings to the plugins. -

Type: attribute set of strings

Default: +

Type: attribute set of string

Default: { } @@ -5522,7 +5522,7 @@ use Python 3 plugins. See noti.yaml(5). for the full list of options. -

Type: attribute set of attribute set of stringss

Default: +

Type: attribute set of attribute set of string

Default: { } @@ -5540,7 +5540,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 stringss

Default: +

Type: attribute set of attribute set of string

Default: { } @@ -5573,7 +5573,7 @@ messages into the database. <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 strings

Default: +

Type: list of string

Default: [ ] @@ -5581,7 +5581,7 @@ searched for messages by notmuch new

programs.notmuch.new.tags

A list of tags that will be added to all messages incorporated by notmuch new. -

Type: list of strings

Default: +

Type: list of string

Default: [ "unread" "inbox" ] @@ -5594,7 +5594,7 @@ incorporated by notmuch new.

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 strings

Default: +

Type: list of string

Default: [ "deleted" "spam" ] @@ -5631,7 +5631,7 @@ of options.

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 packages

Default: +

programs.obs-studio.plugins

Optional OBS plugins.

Type: list of package

Default: [ ] @@ -5641,7 +5641,7 @@ of options. <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 packages

Default: +

programs.octant.plugins

Optional Octant plugins.

Type: list of package

Default: [ ] @@ -5651,7 +5651,7 @@ of options. <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 booleans

Default: +

Type: attribute set of string or signed integer or boolean

Default: { } @@ -5663,7 +5663,7 @@ of options. <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 booleans

Default: +

Type: attribute set of string or signed integer or boolean

Default: { } @@ -5675,7 +5675,7 @@ of options. <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 booleans

Default: +

Type: attribute set of string or signed integer or boolean

Default: { } @@ -5711,7 +5711,7 @@ def get_pass(service, cmd): <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 paths

Default: +

programs.pandoc.citationStyles

List of .csl files to install.

Type: list of path

Default: [ ] @@ -5737,7 +5737,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 paths

Default: +

programs.pandoc.templates

Custom templates.

Type: attribute set of path

Default: { } @@ -5759,7 +5759,7 @@ See the "Environment variables" section of pass(1) and the extension man pages for more information about the available keys. -

Type: attribute set of strings

Default: 

{ PASSWORD_STORE_DIR = "$XDG_DATA_HOME/password-store"; }
+
Type: attribute set of string
Default: 
{ PASSWORD_STORE_DIR = "$XDG_DATA_HOME/password-store"; }
 
Example: 
{
   PASSWORD_STORE_DIR = "/some/directory";
   PASSWORD_STORE_KEY = "12345678";
@@ -5792,7 +5792,7 @@ documentation for details.
     
Declared by:

                     <home-manager/modules/programs/pet.nix>
programs.pet.snippets

The snippets. -

Type: list of submodules

Default: +

Type: list of submodule

Default: [ ] @@ -5808,7 +5808,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -5851,7 +5851,7 @@ PS1=$PS1"NixOS> ";

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 strings

Default: null

Example: +

Type: null or list of string

Default: null

Example: [ "host" "ssh" "cwd" "gitlite" "jobs" "exit" ] @@ -5861,7 +5861,7 @@ modules as well as the choice of default ones are at 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 strings

Default: null

Example: +

Type: null or list of string

Default: null

Example: [ "host" "venv" "git" ] @@ -5873,12 +5873,12 @@ the prompt.

programs.powerline-go.pathAliases

Pairs of full-path and corresponding desired short name. You may use '~' to represent your home directory but you should protect it to avoid shell substitution. -

Type: null or attribute set of strings

Default: null

Example: 

{ "\\~/projects/home-manager" = "prj:home-manager"; }
+
Type: null or attribute set of string
Default: null
Example: 
{ "\\~/projects/home-manager" = "prj:home-manager"; }
 
Declared by:

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

Default: +

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

Default: { } @@ -5922,7 +5922,7 @@ force_color = False <home-manager/modules/programs/pylint.nix>

programs.pylint.package

The pylint package to use.

Type: package

Default: pkgs.python3Packages.pylint

Declared by:

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

The pylint configuration.

Type: attribute set of attribute set of INI atom (null, bool, int, float or string) or a non-empty list of themss

Default: {}

Declared by:

+
programs.pylint.settings

The pylint configuration.

Type: attribute set of attribute set of INI atom (null, bool, int, float or string) or a non-empty list of them

Default: {}

Declared by:

<home-manager/modules/programs/pylint.nix>
programs.qutebrowser.enable

Whether to enable qutebrowser.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/qutebrowser.nix> @@ -5932,7 +5932,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 strings

Default: +

Type: attribute set of string

Default: { } @@ -6003,7 +6003,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 stringss

Default: +

Type: attribute set of attribute set of string

Default: { } @@ -6025,7 +6025,7 @@ 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 strings

Default: +

Type: attribute set of string

Default: { } @@ -6036,7 +6036,7 @@ a key is bound (via bindings.default or <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 strings

Default: +

Type: attribute set of string

Default: { } @@ -6057,7 +6057,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 strings

Default: +

Type: attribute set of string

Default: { } @@ -6072,7 +6072,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 anythings

Default: +

Type: attribute set of anything

Default: { } @@ -6125,7 +6125,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 strings

Default: +

programs.readline.bindings

Readline bindings.

Type: attribute set of string

Default: { } @@ -6139,7 +6139,7 @@ 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 booleans

Default: +

Type: attribute set of string or signed integer or boolean

Default: { } @@ -6159,7 +6159,7 @@ now. <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 stringss or string

Default: +

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: { } @@ -6189,14 +6189,14 @@ 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 strings

Default: +

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 packages

Default: +

Type: list of package

Default: [ ] @@ -6208,7 +6208,7 @@ AUTOTYPE_field='autotype'

programs.rofi.theme

Name of theme or path to theme file in rasi format or attribute set with theme configuration. Available named themes can be viewed using the rofi-theme-selector tool. -

Type: null or string or path or attribute set of 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 stringss or strings

Default: null

Example: 

let
+
Type: null or string or path or attribute set of 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: null
Example: 
let
   # Use `mkLiteral` for string-like values that should show without
   # quotes, e.g.:
   # {
@@ -6275,7 +6275,7 @@ but our default is to follow XDG.
programs.sbt.baseConfigPath

Where the plugins and credentials should be located.

Type: string

Default: ".sbt/1.0"

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 submodules

Default: +

Type: list of submodule

Default: [ ] @@ -6298,7 +6298,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 submodules

Default: +

Type: list of submodule

Default: [ ] @@ -6368,7 +6368,7 @@ reside world-readable in the Nix store.

programs.sioyek.bindings

Input configuration written to $XDG_CONFIG_HOME/sioyek/keys_user.config. See https://github.com/ahrm/sioyek/blob/main/pdf_viewer/keys.config. -

Type: attribute set of strings

Default: +

Type: attribute set of string

Default: { } @@ -6383,7 +6383,7 @@ See 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 strings

Default: +

Type: attribute set of string

Default: { } @@ -6411,7 +6411,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -6426,7 +6426,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -6441,7 +6441,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -6452,7 +6452,7 @@ CTRL-T keybinding.

Declared by:

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

Command line options for the CTRL-R keybinding. -

Type: list of strings

Default: +

Type: list of string

Default: [ ] @@ -6471,7 +6471,7 @@ CTRL-T keybinding.

programs.sm64ex.extraCompileFlags

Extra flags to pass to the compiler. See https://github.com/sm64pc/sm64ex/wiki/Build-options for more information. -

Type: null or list of strings

Default: null

Example: 

[
+
Type: null or list of string
Default: null
Example: 
[
   "BETTERCAMERA=1"
   "NODRAWINGDISTANCE=1"
 ];
@@ -6480,7 +6480,7 @@ for more information.
programs.sm64ex.region

Your baserom's region. Note that only "us", "eu", and "jp" are supported.

Type: null or one of "us", "eu", "jp"

Default: us

Example: jp

Declared by:

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

Settings for sm64ex's $XDG_DATA_HOME/sm64pc/sm64config.txt file.

Type: null or attribute set of string or signed integer or boolean or list of stringss

Default: null

Example: 

{
+
programs.sm64ex.settings

Settings for sm64ex's $XDG_DATA_HOME/sm64pc/sm64config.txt file.

Type: null or attribute set of string or signed integer or boolean or list of string

Default: null

Example: 

{
   fullscreen = false;
   window_x = 0;
   window_y = 0;
@@ -6551,7 +6551,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 strings

Default: +

Type: attribute set of string

Default: { } @@ -6573,7 +6573,7 @@ the known hosts file. See ssh_config(5) for more information. -

Type: list of strings

Default: +

Type: list of string

Default: [ ] @@ -6606,7 +6606,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 strings or null or string

Default: +

Type: list of string or null or string

Default: [ ] @@ -6622,7 +6622,7 @@ 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 submodules

Default: +

Type: list of submodule

Default: [ ] @@ -6633,7 +6633,7 @@ block when null. <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 strings

Default: +

programs.ssh.matchBlocks.<name>.extraOptions

Extra configuration options for the host.

Type: attribute set of string

Default: { } @@ -6665,7 +6665,7 @@ 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 strings or null or string

Default: +

Type: list of string or null or string

Default: [ ] @@ -6673,7 +6673,7 @@ Identities will be tried in the given order. <home-manager/modules/programs/ssh.nix>

programs.ssh.matchBlocks.<name>.localForwards

Specify local port forwardings. See ssh_config(5) for LocalForward. -

Type: list of submodules

Default: +

Type: list of submodule

Default: [ ] @@ -6702,7 +6702,7 @@ Identities will be tried in the given order. <home-manager/modules/programs/ssh.nix>

programs.ssh.matchBlocks.<name>.remoteForwards

Specify remote port forwardings. See ssh_config(5) for RemoteForward. -

Type: list of submodules

Default: +

Type: list of submodule

Default: [ ] @@ -6725,7 +6725,7 @@ Identities will be tried in the given order. <home-manager/modules/programs/ssh.nix>

programs.ssh.matchBlocks.<name>.sendEnv

Environment variables to send from the local host to the server. -

Type: list of strings

Default: +

Type: list of string

Default: [ ] @@ -6800,7 +6800,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 anythings

Default: +

Type: attribute set of anything

Default: { } @@ -6856,7 +6856,7 @@ for more information. For a list of all possible options refer to the terminator_config(5) man page. -

Type: attribute set of anythings

Default: +

Type: attribute set of anything

Default: { } @@ -7139,7 +7139,7 @@ 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 anythings

Default: +

programs.urxvt.extraConfig

Additional configuration to add.

Type: attribute set of anything

Default: { } @@ -7149,7 +7149,7 @@ of options. }

Declared by:

<home-manager/modules/programs/urxvt.nix> -
programs.urxvt.fonts

List of fonts to be used.

Type: list of strings

Default: +

programs.urxvt.fonts

List of fonts to be used.

Type: list of string

Default: [ ] @@ -7161,7 +7161,7 @@ of options. <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 strings

Default: +

programs.urxvt.keybindings

Mapping of keybindings to actions

Type: attribute set of string

Default: { } @@ -7216,7 +7216,7 @@ set nobackup

Note: String values are deprecated, please use actual packages. -

Type: list of string or packages

Default: +

Type: list of string or package

Default: [ (build of vimplugin-vim-sensible-2022-04-11) ] @@ -7226,7 +7226,7 @@ Note: String values are deprecated, please use actual packages. corresponding values must be among the following supported options. -

backgroundone of "dark", "light"
backupdirlist of strings
copyindentboolean
directorylist of strings
expandtabboolean
hiddenboolean
historysigned integer
ignorecaseboolean
modelineboolean
mouseone of "n", "v", "i", "c", "h", "a", "r"
mousefocusboolean
mousehideboolean
mousemodelone of "extend", "popup", "popup_setpos"
numberboolean
relativenumberboolean
shiftwidthsigned integer
smartcaseboolean
tabstopsigned integer
undodirlist of strings
undofileboolean

+

backgroundone of "dark", "light"
backupdirlist of string
copyindentboolean
directorylist of string
expandtabboolean
hiddenboolean
historysigned integer
ignorecaseboolean
modelineboolean
mouseone of "n", "v", "i", "c", "h", "a", "r"
mousefocusboolean
mousehideboolean
mousemodelone of "extend", "popup", "popup_setpos"
numberboolean
relativenumberboolean
shiftwidthsigned integer
smartcaseboolean
tabstopsigned integer
undodirlist of string
undofileboolean

See the Vim documentation for detailed descriptions of these options. Note, use extraConfig to @@ -7248,7 +7248,7 @@ manually set any options not listed above.

Type: package

Default: (build of vscode-1.67.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 packages

Default: +

Type: list of package

Default: [ ] @@ -7271,7 +7271,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 submodules

Default: +

Type: list of submodule

Default: [ ] @@ -7346,7 +7346,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)ss

Default: +

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

Default: { } @@ -7377,7 +7377,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 values or attribute set of JSON values

Default: +

Type: list of JSON value or attribute set of JSON value

Default: [ ] @@ -7486,7 +7486,7 @@ for options.

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 strings

Default: +

Type: list of string

Default: [ ] @@ -7509,7 +7509,7 @@ focused on keyboard interaction.

Type:zathurarc(5) for the full list of options. -

Type: attribute set of string or boolean or signed integers

Default: +

Type: attribute set of string or boolean or signed integer

Default: { } @@ -7554,7 +7554,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -7586,7 +7586,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -7597,7 +7597,7 @@ directory.

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 strings

Default: +

Type: attribute set of string

Default: { } @@ -7631,7 +7631,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 strings

Default: +

Type: list of string

Default: [ ] @@ -7695,7 +7695,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -7708,7 +7708,7 @@ zstyle :omz:plugins:ssh-agent identities id_rsa id_rsa2 id_github

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 submodules

Default: +

programs.zsh.plugins

Plugins to source in .zshrc.

Type: list of submodule

Default: [ ] @@ -7763,7 +7763,7 @@ 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 strings

Default: +

programs.zsh.prezto.completions.ignoredHosts

Set the entries to ignore in static */etc/hosts* for host completion.

Type: list of string

Default: [ ] @@ -7782,7 +7782,7 @@ 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 strings

Default: +

programs.zsh.prezto.extraFunctions

Set the Zsh functions to load (man zshcontrib).

Type: list of string

Default: [ ] @@ -7792,7 +7792,7 @@ Will be added to fpath and PATH

Declared by:

<home-manager/modules/programs/zsh/prezto.nix> -
programs.zsh.prezto.extraModules

Set the Zsh modules to load (man zshmodules).

Type: list of strings

Default: +

programs.zsh.prezto.extraModules

Set the Zsh modules to load (man zshmodules).

Type: list of string

Default: [ ] @@ -7814,7 +7814,7 @@ 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 paths

Default: +

programs.zsh.prezto.pmoduleDirs

Add additional directories to load prezto modules from

Type: list of path

Default: [ ] @@ -7824,7 +7824,7 @@ Will be added to fpath and PATH

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 strings

Default: +

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" ] @@ -7850,7 +7850,7 @@ 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 strings

Default: +

programs.zsh.prezto.ssh.identities

Set the SSH identities to load into the agent.

Type: list of string

Default: [ ] @@ -7861,7 +7861,7 @@ Will be added to fpath and PATH

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 strings

Default: + highlighter is enabled.

Type: list of string

Default: [ ] @@ -7871,7 +7871,7 @@ Will be added to fpath and PATH

Declared by:

<home-manager/modules/programs/zsh/prezto.nix> -
programs.zsh.prezto.syntaxHighlighting.pattern

Set syntax pattern styles.

Type: attribute set of strings

Default: +

programs.zsh.prezto.syntaxHighlighting.pattern

Set syntax pattern styles.

Type: attribute set of string

Default: { } @@ -7881,7 +7881,7 @@ Will be added to fpath and PATH

Declared by:

<home-manager/modules/programs/zsh/prezto.nix> -
programs.zsh.prezto.syntaxHighlighting.styles

Set syntax highlighting styles.

Type: attribute set of strings

Default: +

programs.zsh.prezto.syntaxHighlighting.styles

Set syntax highlighting styles.

Type: attribute set of string

Default: { } @@ -7925,7 +7925,7 @@ Will be added to fpath and PATH

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 strings

Default: +

Type: attribute set of string

Default: { } @@ -7937,7 +7937,7 @@ this option) to command strings or directly to build outputs. <home-manager/modules/programs/zsh.nix>

programs.zsh.shellGlobalAliases

Similar to opt-programs.zsh.shellAliases, but are substituted anywhere on a line. -

Type: attribute set of strings

Default: +

Type: attribute set of string

Default: { } @@ -7949,7 +7949,7 @@ 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 submodules

Default: +

programs.zsh.zplug.plugins

List of zplug plugins.

Type: list of submodule

Default: [ ] @@ -7957,7 +7957,7 @@ but are substituted anywhere on a line. <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 strings

Default: +

programs.zsh.zplug.plugins.*.tags

The plugin tags.

Type: list of string

Default: [ ] @@ -7993,7 +7993,7 @@ but are substituted anywhere on a line. <home-manager/modules/services/barrier.nix>

services.barrier.client.extraFlags

Additional flags to pass to barrierc. See barrierc --help. -

Type: list of strings

Default: [ "-f" ]

Declared by:

+

Type: list of string

Default: [ "-f" ]

Declared by:

<home-manager/modules/services/barrier.nix>
services.barrier.client.name

Screen name of client. Defaults to hostname.

Type: null or string

Default: null

Declared by:

@@ -8007,7 +8007,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 strings

Default: +

services.betterlockscreen.arguments

List of arguments appended to ./betterlockscreen --lock [args]

Type: list of string

Default: [ ] @@ -8096,7 +8096,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 stringsss

Default: +

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: { } @@ -8141,7 +8141,7 @@ desired. }

Declared by:

<home-manager/modules/services/dwm-status.nix> -
services.dwm-status.order

List of enabled features in order.

Type: list of one of "audio", "backlight", "battery", "cpu_load", "network", "time"s

Declared by:

+
services.dwm-status.order

List of enabled features in order.

Type: list of one of "audio", "backlight", "battery", "cpu_load", "network", "time"

Declared by:

<home-manager/modules/services/dwm-status.nix>
services.easyeffects.enable

Whether to enable Easyeffects daemon. Note, it is necessary to add @@ -8163,7 +8163,7 @@ 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 strings

Default: +

Type: list of string

Default: [ "-c" ] @@ -8174,7 +8174,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -8236,7 +8236,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 integers

Default: +

Type: attribute set of string or signed integer

Default: { } @@ -8253,7 +8253,7 @@ 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)ss

Default: +

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

Default: { } @@ -8271,7 +8271,7 @@ for available options. <home-manager/modules/services/fluidsynth.nix>

services.fluidsynth.extraOptions

Extra arguments, added verbatim to the fluidsynth command. See fluidsynth.conf(1). -

Type: list of strings

Default: +

Type: list of string

Default: [ ] @@ -8304,7 +8304,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -8320,7 +8320,7 @@ generated from the immutable one, useful in scenarios where live reloading is de See fnott.ini(5) for a list of avaliable 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)ss

Default: +

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

Default: { } @@ -8342,7 +8342,7 @@ for an example configuration.

services.fusuma.package

Package providing fusuma.

Type: package

Default: pkgs.fusuma

Declared by:

<home-manager/modules/services/fusuma.nix>
services.fusuma.extraPackages

Extra packages needs to bring to the scope of fusuma service. -

Type: list of packages

Default: pkgs.coreutils

Example: 

with pkgs; [ coreutils xdotool ];
+
Type: list of package
Default: pkgs.coreutils
Example: 
with pkgs; [ coreutils xdotool ];
 
Declared by:

                     <home-manager/modules/services/fusuma.nix>
services.fusuma.settings

YAML config that will override the default fusuma configuration. @@ -8400,7 +8400,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)ss

Default: +

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

Default: { } @@ -8441,7 +8441,7 @@ permanently for a password.

Type: package

Default: pkgs.git-sync

Declared by:

<home-manager/modules/services/git-sync.nix>
services.git-sync.repositories

The repositories that should be synchronized. -

Type: attribute set of submodules

Declared by:

+

Type: attribute set of submodule

Declared by:

<home-manager/modules/services/git-sync.nix>
services.git-sync.repositories.<name>.interval

The interval, specified in seconds, at which the synchronization will be triggered even without filesystem changes. @@ -8459,7 +8459,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"s

Default: +

Type: list of one of "pkcs11", "secrets", "ssh"

Default: [ ] @@ -8534,7 +8534,7 @@ now.

Type: null or one of "curses", "tty", "gtk2", "emacs", "gnome3", "qt"

Default: "gtk2"

Example: "gnome3"

Declared by:

<home-manager/modules/services/gpg-agent.nix>
services.gpg-agent.sshKeys

Which GPG keys (by keygrip) to expose as SSH keys. -

Type: null or list of strings

Default: null

Declared by:

+

Type: null or list of string

Default: null

Declared by:

<home-manager/modules/services/gpg-agent.nix>
services.gpg-agent.verbose

Whether to produce verbose output.

Type: boolean

Default: false

Declared by:

@@ -8545,7 +8545,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -8562,7 +8562,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 stringsss

Default: +

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

Default: [ ] @@ -8605,7 +8605,7 @@ manually using the command line.

services.gromit-mpx.opacity

Opacity of the drawing overlay.

Type: float between 0.0 and 1.0 (inclusive)

Default:

Example:

Declared by:

<home-manager/modules/services/gromit-mpx.nix>
services.gromit-mpx.tools

Tool definitions for gromit-mpx to use. -

Type: list of submodules

Default: +

Type: list of submodule

Default: [ { @@ -8658,7 +8658,7 @@ 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"s

Default: +

Type: list of one of "1", "2", "3", "4", "5", "SHIFT", "CONTROL", "ALT", "META"

Default: [ ] @@ -8696,7 +8696,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 values

Default: +

services.hound.repositories

The repository configuration.

Type: attribute set of JSON value

Default: { } @@ -8721,7 +8721,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 submodules

Default: +

Type: attribute set of submodule

Default: { } @@ -8748,14 +8748,14 @@ docked = {

services.kanshi.profiles.<name>.exec

Commands executed after the profile is succesfully applied. Note that if you provide multiple commands, they will be executed asynchronously with no guaranteed ordering. -

Type: list of strings or string convertible to it

Default: +

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 submodules

Default: +

Type: list of submodule

Default: [ ] @@ -8798,7 +8798,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -8856,7 +8856,7 @@ 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 packages

Default: +

Type: list of package

Default: [ ] @@ -8867,7 +8867,7 @@ useful for creating the directories mbsync is going to use.

See https://docs.mopidy.com/en/latest/config/ for more details. -

Type: attribute set of attribute set of Mopidy config valuess

Default: +

Type: attribute set of attribute set of Mopidy config value

Default: { } @@ -8972,7 +8972,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 submodules

Default: +

Type: attribute set of submodule

Default: { } @@ -9075,7 +9075,7 @@ special characters including spaces may need to be escaped. See https://github.com/matrix-org/pantalaimon/blob/master/docs/manpantalaimon.5.md or pantalaimon(5) for options. -

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

Default: { }

Example: 

{
+
Type: attribute set of attribute set of INI atom (null, bool, int, float or string)
Default: { }
Example: 
{
   Default = {
     LogLevel = "Debug";
     SSL = true;
@@ -9138,7 +9138,7 @@ password are escaped.
 See the
 picom(1)
 man page for more examples.
-
Type: list of strings
Default: 
+
Type: list of string
Default: 
         [
         
         ]
@@ -9167,7 +9167,7 @@ dbe = true;
 See the
 picom(1)
 man page for more examples.
-
Type: list of strings
Default: 
+
Type: list of string
Default: 
         [
         
         ]
@@ -9178,7 +9178,7 @@ man page for more examples.
     
Declared by:

                     <home-manager/modules/services/picom.nix>
services.picom.fadeSteps

Opacity change between fade steps (in and out). -

Type: list of strings

Default: +

Type: list of string

Default: [ "0.028" "0.03" ] @@ -9207,7 +9207,7 @@ man page for more examples. See the picom(1) man page for more examples. -

Type: list of strings

Default: +

Type: list of string

Default: [ ] @@ -9224,7 +9224,7 @@ man page for more examples. See the picom(1) man page for more examples. -

Type: list of strings

Default: +

Type: list of string

Default: [ ] @@ -9235,7 +9235,7 @@ man page for more examples.

Declared by:

<home-manager/modules/services/picom.nix>
services.picom.shadowOffsets

Horizontal and vertical offsets for shadows (in pixels). -

Type: list of signed integers

Default: +

Type: list of signed integer

Default: [ -15 -15 ] @@ -9295,7 +9295,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 stringsss or path convertible to it

Default: +

Type: attribute set of attribute set of string or boolean or signed integer or list of string or path convertible to it

Default: { } @@ -9366,7 +9366,7 @@ ramp-volume-1=🔉 ramp-volume-2=🔊 click-right=pavucontrol &

-

Type: attribute set of attribute setss

Default: +

Type: attribute set of attribute sets

Default: { } @@ -9455,7 +9455,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)ss

Default: +

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

Default: { } @@ -9505,7 +9505,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -9515,7 +9515,7 @@ No effect if xautolock.enable is false.

Type: package

Default: (build of 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 strings

Default: +

Type: list of string

Default: [ ] @@ -9550,7 +9550,7 @@ 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 integers

Default: +

Type: attribute set of null or string or boolean or signed integer

Default: { } @@ -9576,7 +9576,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 occurence of a event.

Type: list of submodules

Default: +

services.swayidle.events

Run command on occurence of a event.

Type: list of submodule

Default: [ ] @@ -9590,13 +9590,13 @@ 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 strings

Default: +

services.swayidle.extraArgs

Extra arguments to pass to swayidle.

Type: list of string

Default: [ ]

Declared by:

<home-manager/modules/services/swayidle.nix> -
services.swayidle.timeouts

List of commands to run after idle timeout.

Type: list of submodules

Default: +

services.swayidle.timeouts

List of commands to run after idle timeout.

Type: list of submodule

Default: [ ] @@ -9619,13 +9619,13 @@ 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 strings

Default: +

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 strings

Default: +

services.sxhkd.keybindings

An attribute set that assigns hotkeys to commands.

Type: attribute set of null or string

Default: { } @@ -9638,7 +9638,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -9679,7 +9679,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 integers

Default: +

Type: attribute set of null or string or boolean or signed integer

Default: { } @@ -9821,7 +9821,7 @@ 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 strings

Default: +

services.unclutter.extraOptions

More arguments to pass to the unclutter command.

Type: list of string

Default: [ ] @@ -9838,7 +9838,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 submodules

Default: +

Type: attribute set of submodule

Default: { } @@ -9858,14 +9858,14 @@ The options are See unison(1) for a list of available options. -

Type: attribute set of strings

Default: +

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 strings of length 2

Example: 

[
+
Type: list of string of length 2
Example: 
[
   "/home/user/documents"
   "ssh://remote/documents"
 ]
@@ -9922,7 +9922,7 @@ 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 strings
Default: 
+
Type: attribute set of string
Default: 
         {
         
         }
@@ -9948,7 +9948,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 strings

Default: +

Type: attribute set of string

Default: { } @@ -9968,7 +9968,7 @@ The commands specified in command and environment section. -

Type: list of submodules

Default: +

Type: list of submodule

Default: [ ] @@ -10005,7 +10005,7 @@ 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 strings

Default: +

Type: attribute set of boolean or signed integer or string

Default: { } @@ -10023,7 +10023,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 strings

Default: +

Type: attribute set of boolean or signed integer or string

Default: { } @@ -10081,7 +10081,7 @@ 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 submodules

Default: +

services.xsuspender.rules

Attribute set of XSuspender rules.

Type: attribute set of submodule

Default: { } @@ -10165,7 +10165,7 @@ then run WARNING! Since this option is experimental, the activation process may change in backwards incompatible ways. -

Type: attribute set of submodules

Default: +

Type: attribute set of submodule

Default: { } @@ -10281,7 +10281,7 @@ 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 strings

Default: +

Type: attribute set of signed integer or string

Default: { } @@ -10418,7 +10418,7 @@ by systemd. More details can be found in automatically. See tmpfiles.d(5) for the exact format. -

Type: list of strings

Default: +

Type: list of string

Default: [ ] @@ -10434,7 +10434,7 @@ ignored.

Warning

Some settings might require a re-login to take effect.

-

Type: attribute set of attribute set of anythingss

Default: +

Type: attribute set of attribute set of anything

Default: { } @@ -10448,7 +10448,7 @@ ignored. }

Declared by:

<home-manager/modules/targets/darwin> -
targets.darwin.defaults.NSGlobalDomain.AppleLanguages

Sets the language to use in the preferred order.

Type: null or list of strings

Default: null

Example: +

targets.darwin.defaults.NSGlobalDomain.AppleLanguages

Sets the language to use in the preferred order.

Type: null or list of string

Default: null

Example: [ "en" ] @@ -10549,7 +10549,7 @@ for more details. Existing keybinding configuration will be wiped when using this option.

-

Type: attribute set of anythings

Default: +

Type: attribute set of anything

Default: { } @@ -10582,7 +10582,7 @@ module to install Sway. <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 booleansss

Default: +

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

Default: { } @@ -10593,7 +10593,7 @@ on criteria.

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.bars

Sway bars settings blocks. Set to empty list to remove bars completely. -

Type: list of submodules

Default: see code

Declared by:

+

Type: list of submodule

Default: see code

Declared by:

<home-manager/modules/services/window-managers/i3-sway/sway.nix>
wayland.windowManager.sway.config.bars.*.colors

Bar color settings. All color classes can be specified using submodules with 'border', 'background', 'text', fields and RGB color hex-codes as values. @@ -10667,7 +10667,7 @@ a window with the urgency hint set. <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 strings or submodule

Default: +

wayland.windowManager.sway.config.bars.*.fonts

Font configuration for this bar.

Type: list of string or submodule

Default: { } @@ -10771,7 +10771,7 @@ 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.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 booleanss

Default: +

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: [ ] @@ -10815,7 +10815,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 strings or submodule

Default: +

wayland.windowManager.sway.config.fonts

Font configuration for window titles, nagbar...

Type: list of string or submodule

Default: { } @@ -10856,7 +10856,7 @@ 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 stringss

Default: +

Type: attribute set of attribute set of string

Default: { } @@ -10875,7 +10875,7 @@ See

Consider to use lib.mkOptionDefault function to extend or override default keybindings instead of specifying all of them from scratch. -

Type: attribute set of null or strings

Default: "Default sway keybindings."

Example: 

let
+
Type: attribute set of null or string
Default: "Default sway keybindings."
Example: 
let
   modifier = config.wayland.windowManager.sway.config.modifier;
 in lib.mkOptionDefault {
   "${modifier}+Return" = "exec ${pkgs.rxvt-unicode-unwrapped}/bin/urxvt";
@@ -10886,7 +10886,7 @@ 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 strings

Default: +

Type: attribute set of null or string

Default: { } @@ -10905,7 +10905,7 @@ inside them Only basic keybinding is supported (bindsym keycomb action), for more advanced setup use 'sway.extraConfig'. -

Type: attribute set of attribute set of stringss

Default: +

Type: attribute set of attribute set of string

Default: { resize = { @@ -10920,7 +10920,7 @@ for more advanced setup use 'sway.extraConfig'.

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 stringss

Default: +

Type: attribute set of attribute set of string

Default: { } @@ -10939,7 +10939,7 @@ for options.

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 stringss

Default: +

Type: attribute set of attribute set of string

Default: { } @@ -10956,7 +10956,7 @@ for options.

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 submodules

Default: +

Type: list of submodule

Default: [ ] @@ -10985,7 +10985,7 @@ See 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 submodules

Default: +

Type: list of submodule

Default: [ ] @@ -11009,7 +11009,7 @@ See for_window swaywm option documentation.

A value of true is equivalent to using an empty criteria (which is different from an empty string criteria). -

Type: attribute set of string or booleans

Example: 

{
+
Type: attribute set of string or boolean
Example: 
{
   title = "x200: ~/work";
   floating = true;
 };
@@ -11029,7 +11029,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 submodules

Default: +

wayland.windowManager.sway.config.workspaceOutputAssign

Assign workspaces to outputs.

Type: list of submodule

Default: [ ] @@ -11047,7 +11047,7 @@ 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 strings

Default: +

Type: list of string

Default: [ ] @@ -11078,7 +11078,7 @@ See for a list of avaliable 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)ss

Default: +

Type: attribute set of attribute set of Swaynag config atom (null, bool, int, float, str)

Default: { } @@ -11132,7 +11132,7 @@ variables for GTK applications. <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 submodules

Default: +

Type: attribute set of submodule

Default: { } @@ -11183,7 +11183,7 @@ must be set. <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 submodules

Default: +

Type: attribute set of submodule

Default: { } @@ -11235,7 +11235,7 @@ must be set.

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 submodules

Default: +

Type: attribute set of submodule

Default: { } @@ -11251,7 +11251,7 @@ See Declared by:

<home-manager/modules/misc/xdg-desktop-entries.nix> -
xdg.desktopEntries.<name>.actions

The set of actions made available to application launchers.

Type: attribute set of submodules

Default: { }

Example: 

{
+
xdg.desktopEntries.<name>.actions

The set of actions made available to application launchers.

Type: attribute set of submodule

Default: { }

Example: 

{
   "New Window" = {
     exec = "${pkgs.firefox}/bin/firefox --new-window %u";
   };
@@ -11264,7 +11264,7 @@ See xdg.desktopEntries.<name>.actions.<name>.name
Name of the action.
Type: string
Default: <name>
Declared by:

                     <home-manager/modules/misc/xdg-desktop-entries.nix>
-                
xdg.desktopEntries.<name>.categories
Categories in which the entry should be shown in a menu.
Type: null or list of strings
Default: null
Declared by:

+                
xdg.desktopEntries.<name>.categories
Categories in which the entry should be shown in a menu.
Type: null or list of string
Default: null
Declared by:

                     <home-manager/modules/misc/xdg-desktop-entries.nix>
                 
xdg.desktopEntries.<name>.comment
Tooltip for the entry.
Type: null or string
Default: null
Declared by:

                     <home-manager/modules/misc/xdg-desktop-entries.nix>
@@ -11274,7 +11274,7 @@ See xdg.desktopEntries.<name>.icon
Icon to display in file manager, menus, etc.
Type: null or string
Default: null
Declared by:

                     <home-manager/modules/misc/xdg-desktop-entries.nix>
-                
xdg.desktopEntries.<name>.mimeType
The MIME type(s) supported by this application.
Type: null or list of strings
Default: null
Declared by:

+                
xdg.desktopEntries.<name>.mimeType
The MIME type(s) supported by this application.
Type: null or list of string
Default: null
Declared by:

                     <home-manager/modules/misc/xdg-desktop-entries.nix>
                 
xdg.desktopEntries.<name>.name
Specific name of the application.
Type: string
Declared by:

                     <home-manager/modules/misc/xdg-desktop-entries.nix>
@@ -11287,7 +11287,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 strings
Default: 
+
Type: attribute set of Concatenated string
Default: 
         {
         
         }
@@ -11323,7 +11323,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 strings or list of strings or string convertible to its
Default: 
+
Type: attribute set of list of string or list of string or string convertible to it
Default: 
         {
         
         }
@@ -11336,7 +11336,7 @@ 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 strings or list of strings or string convertible to its
Default: 
+
Type: attribute set of list of string or list of string or string convertible to it
Default: 
         {
         
         }
@@ -11351,7 +11351,7 @@ 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 strings or list of strings or string convertible to its
Default: 
+
Type: attribute set of list of string or list of string or string convertible to it
Default: 
         {
         
         }
@@ -11365,7 +11365,7 @@ the list is attempted, and so on.
                     <home-manager/modules/misc/xdg.nix>
                 
xdg.systemDirs.config
Directory names to add to XDG_CONFIG_DIRS
 in the user session.
-
Type: list of strings
Default: 
+
Type: list of string
Default: 
         [
         
         ]
@@ -11373,7 +11373,7 @@ in the user session.
                     <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 strings
Default: 
+
Type: list of string
Default: 
         [
         
         ]
@@ -11392,7 +11392,7 @@ The generated file is read-only.
                     <home-manager/modules/misc/xdg-user-dirs.nix>
                 
xdg.userDirs.download
The Downloads directory.
Type: string or path convertible to it
Default: "$HOME/Downloads"
Declared by:

                     <home-manager/modules/misc/xdg-user-dirs.nix>
-                
xdg.userDirs.extraConfig
Other user directories.
Type: attribute set of string or path convertible to its
Default: { }
Example: 
{
+                
xdg.userDirs.extraConfig
Other user directories.
Type: attribute set of string or path convertible to it
Default: { }
Example: 
{
   XDG_MISC_DIR = "$HOME/Misc";
 }
 
Declared by:

@@ -11431,7 +11431,7 @@ Note, that 2-dimensional lists are not supported and specifying one will throw a
 If this and all other xresources options are
 null, then this feature is disabled and no
 ~/.Xresources link is produced.
-
Type: null or attribute set of boolean or signed integer or string or list of boolean or signed integer or stringss
Default: null
Example: 
{
+
Type: null or attribute set of boolean or signed integer or string or list of boolean or signed integer or string
Default: null
Example: 
{
   "Emacs*toolBar" = 0;
   "XTerm*faceName" = "dejavu sans mono";
   "XTerm*charClass" = [ "37:48" "45-47:48" "58:48" "64:48" "126:48" ];
@@ -11473,7 +11473,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 packages
Default: 
+
Type: list of package
Default: 
         [
         
         ]
@@ -11499,7 +11499,7 @@ re-run bspwmrc.
 bspc subscribe all > ~/bspc-report.log &
 ''

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 stringss

Default: +

xsession.windowManager.bspwm.monitors

Specifies the names of desktops to create on each monitor.

Type: attribute set of list of string

Default: { } @@ -11513,7 +11513,7 @@ bspc subscribe all > ~/bspc-report.log & }

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 submodules

Default: +

xsession.windowManager.bspwm.rules

Rule configuration. The keys of the attribute set are the targets of the rules.

Type: attribute set of submodule

Default: { } @@ -11575,7 +11575,7 @@ the desktop. <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 stringss

Default: +

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: { } @@ -11585,7 +11585,7 @@ the desktop. }

Declared by:

<home-manager/modules/services/window-managers/bspwm/default.nix> -
xsession.windowManager.bspwm.startupPrograms

Programs to be executed during startup.

Type: list of strings

Default: +

xsession.windowManager.bspwm.startupPrograms

Programs to be executed during startup.

Type: list of string

Default: [ ] @@ -11621,7 +11621,7 @@ 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 strings

Default: +

xsession.windowManager.herbstluftwm.keybinds

Herbstluftwm keybinds.

Type: attribute set of string

Default: { } @@ -11631,7 +11631,7 @@ herbstclient detect_monitors }

Declared by:

<home-manager/modules/services/window-managers/herbstluftwm.nix> -
xsession.windowManager.herbstluftwm.mousebinds

Herbstluftwm mousebinds.

Type: attribute set of strings

Default: +

xsession.windowManager.herbstluftwm.mousebinds

Herbstluftwm mousebinds.

Type: attribute set of string

Default: { } @@ -11641,7 +11641,7 @@ herbstclient detect_monitors }

Declared by:

<home-manager/modules/services/window-managers/herbstluftwm.nix> -
xsession.windowManager.herbstluftwm.rules

Herbstluftwm rules.

Type: list of strings

Default: +

xsession.windowManager.herbstluftwm.rules

Herbstluftwm rules.

Type: list of string

Default: [ ] @@ -11651,7 +11651,7 @@ herbstclient detect_monitors ]

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 strings

Default: +

xsession.windowManager.herbstluftwm.settings

Herbstluftwm settings.

Type: attribute set of boolean or signed integer or string

Default: { } @@ -11662,7 +11662,7 @@ herbstclient detect_monitors }

Declared by:

<home-manager/modules/services/window-managers/herbstluftwm.nix> -
xsession.windowManager.herbstluftwm.tags

Tags to create on startup.

Type: list of strings

Default: +

xsession.windowManager.herbstluftwm.tags

Tags to create on startup.

Type: list of string

Default: [ ] @@ -11683,7 +11683,7 @@ If 'i3.config.gaps' settings are specified, 'pkgs.i3-gaps' will be set as a defa <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 booleansss

Default: +

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

Default: { } @@ -11694,7 +11694,7 @@ on criteria.

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.bars

i3 bars settings blocks. Set to empty list to remove bars completely. -

Type: list of submodules

Default: see code

Declared by:

+

Type: list of submodule

Default: see code

Declared by:

<home-manager/modules/services/window-managers/i3-sway/i3.nix>
xsession.windowManager.i3.config.bars.*.colors

Bar color settings. All color classes can be specified using submodules with 'border', 'background', 'text', fields and RGB color hex-codes as values. @@ -11768,7 +11768,7 @@ a window with the urgency hint set. <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 strings or submodule

Default: +

xsession.windowManager.i3.config.bars.*.fonts

Font configuration for this bar.

Type: list of string or submodule

Default: { } @@ -11867,7 +11867,7 @@ This must to correspond to the value of the keybinding of the default workspace. <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 booleanss

Default: +

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: [ ] @@ -11911,7 +11911,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 strings or submodule

Default: +

xsession.windowManager.i3.config.fonts

Font configuration for window titles, nagbar...

Type: list of string or submodule

Default: { } @@ -11954,7 +11954,7 @@ See

Consider to use lib.mkOptionDefault function to extend or override default keybindings instead of specifying all of them from scratch. -

Type: attribute set of null or strings

Default: "Default i3 keybindings."

Example: 

let
+
Type: attribute set of null or string
Default: "Default i3 keybindings."
Example: 
let
   modifier = config.xsession.windowManager.i3.config.modifier;
 in lib.mkOptionDefault {
   "${modifier}+Return" = "exec i3-sensible-terminal";
@@ -11965,7 +11965,7 @@ 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 strings

Default: +

Type: attribute set of null or string

Default: { } @@ -11982,7 +11982,7 @@ inside them Only basic keybinding is supported (bindsym keycomb action), for more advanced setup use 'i3.extraConfig'. -

Type: attribute set of attribute set of stringss

Default: +

Type: attribute set of attribute set of string

Default: { resize = { @@ -11997,7 +11997,7 @@ for more advanced setup use 'i3.extraConfig'.

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 submodules

Default: +

Type: list of submodule

Default: [ ] @@ -12033,7 +12033,7 @@ instead. See 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 submodules

Default: +

Type: list of submodule

Default: [ ] @@ -12057,7 +12057,7 @@ See for_window i3wm option documentation.

A value of true is equivalent to using an empty criteria (which is different from an empty string criteria). -

Type: attribute set of string or booleans

Example: 

{
+
Type: attribute set of string or boolean
Example: 
{
   title = "x200: ~/work";
   floating = true;
 };
@@ -12077,7 +12077,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 submodules

Default: +

xsession.windowManager.i3.config.workspaceOutputAssign

Assign workspaces to outputs.

Type: list of submodule

Default: [ ] @@ -12135,7 +12135,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 paths

Default: +

Type: attribute set of path

Default: { } diff --git a/tools.html b/tools.html index e4a57bb99..67f065a14 100644 --- a/tools.html +++ b/tools.html @@ -1,6 +1,6 @@ -Appendix D. Tools

Appendix D. Tools
Prev   Next

Appendix D. Tools

home-manager - — reconfigure a user environment

Name

home-manager +Appendix D. Tools

Appendix D. Tools
Prev   Next

Appendix D. Tools

home-manager + — reconfigure a user environment

Name

home-manager — reconfigure a user environment

Synopsis

home-manager { build | @@ -84,7 +84,7 @@ | --verbose } - ]

Description

+ ]

Description

This command updates the user environment so that it corresponds to the configuration specified in ~/.config/nixpkgs/home.nix or ~/.config/nixpkgs/flake.nix.

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

-

Options

+

Options

The tool accepts the options

-A attrPath @@ -265,15 +265,15 @@ --verbose

Activates verbose output. -

Files

+

Files

$XDG_DATA_HOME/home-manager/news-read-ids

Identifiers of news items that have been shown. Can be deleted to reset the read news indicator. -

Bugs

+

Bugs

Please report any bugs on the project issue tracker. -

See also

+

See also

home-configuration.nix(5)

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