diff --git a/nix-darwin-options.html b/nix-darwin-options.html index a6a69028d..77490d557 100644 --- a/nix-darwin-options.html +++ b/nix-darwin-options.html @@ -1,5 +1,53 @@ -Appendix C. nix-darwin Module Options
Appendix C. nix-darwin Module Options
Prev   Next

Appendix C. nix-darwin Module Options

_module.args

Type: lazy attribute set of raw value

Declared by:

+Appendix C. nix-darwin Module Options
Appendix C. nix-darwin Module Options
Prev   Next

Appendix C. nix-darwin Module Options

_module.args

Additional arguments passed to each module in addition to ones +like lib, config, +and pkgs, modulesPath. + +This option is also available to all submodules. Submodules do not +inherit args from their parent module, nor do they provide args to +their parent module or sibling submodules. The sole exception to +this is the argument name which is provided by +parent modules to a submodule and contains the attribute name +the submodule is bound to, or a unique generated name if it is +not bound to an attribute. + +Some arguments are already passed by default, of which the +following cannot be changed with this option: + +

  • lib: The nixpkgs library. + +

  • config: The results of all options after merging the values from all modules together. + +

  • options: The options declared in all modules. + +

  • specialArgs: The specialArgs argument passed to evalModules. + +

  • All attributes of specialArgs + +Whereas option values can generally depend on other option values +thanks to laziness, this does not apply to imports, which +must be computed statically before anything else. + +For this reason, callers of the module system can provide specialArgs +which are available during import resolution. + +For NixOS, specialArgs includes +modulesPath, which allows you to import +extra modules from the nixpkgs package tree without having to +somehow make the module aware of the location of the +nixpkgs or NixOS directories. + +

    +{ modulesPath, ... }: {
+  imports = [
+    (modulesPath + "/profiles/minimal.nix")
+  ];
+}
+

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 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. diff --git a/nixos-options.html b/nixos-options.html index c14e0a1f3..642c4f4bc 100644 --- a/nixos-options.html +++ b/nixos-options.html @@ -1,5 +1,53 @@ -Appendix B. NixOS Module Options

Appendix B. NixOS Module Options
Prev   Next

Appendix B. NixOS Module Options

_module.args

Type: lazy attribute set of raw value

Declared by:

+Appendix B. NixOS Module Options
Appendix B. NixOS Module Options
Prev   Next

Appendix B. NixOS Module Options

_module.args

Additional arguments passed to each module in addition to ones +like lib, config, +and pkgs, modulesPath. + +This option is also available to all submodules. Submodules do not +inherit args from their parent module, nor do they provide args to +their parent module or sibling submodules. The sole exception to +this is the argument name which is provided by +parent modules to a submodule and contains the attribute name +the submodule is bound to, or a unique generated name if it is +not bound to an attribute. + +Some arguments are already passed by default, of which the +following cannot be changed with this option: + +

  • lib: The nixpkgs library. + +

  • config: The results of all options after merging the values from all modules together. + +

  • options: The options declared in all modules. + +

  • specialArgs: The specialArgs argument passed to evalModules. + +

  • All attributes of specialArgs + +Whereas option values can generally depend on other option values +thanks to laziness, this does not apply to imports, which +must be computed statically before anything else. + +For this reason, callers of the module system can provide specialArgs +which are available during import resolution. + +For NixOS, specialArgs includes +modulesPath, which allows you to import +extra modules from the nixpkgs package tree without having to +somehow make the module aware of the location of the +nixpkgs or NixOS directories. + +

    +{ modulesPath, ... }: {
+  imports = [
+    (modulesPath + "/profiles/minimal.nix")
+  ];
+}
+

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 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. diff --git a/options.html b/options.html index 399ebe57b..2e147743c 100644 --- a/options.html +++ b/options.html @@ -1,5 +1,53 @@ -Appendix A. Configuration Options

Appendix A. Configuration Options
Prev   Next

Appendix A. Configuration Options

_module.args

Type: lazy attribute set of raw value

Declared by:

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

Appendix A. Configuration Options

_module.args

Additional arguments passed to each module in addition to ones +like lib, config, +and pkgs, modulesPath. + +This option is also available to all submodules. Submodules do not +inherit args from their parent module, nor do they provide args to +their parent module or sibling submodules. The sole exception to +this is the argument name which is provided by +parent modules to a submodule and contains the attribute name +the submodule is bound to, or a unique generated name if it is +not bound to an attribute. + +Some arguments are already passed by default, of which the +following cannot be changed with this option: + +

  • lib: The nixpkgs library. + +

  • config: The results of all options after merging the values from all modules together. + +

  • options: The options declared in all modules. + +

  • specialArgs: The specialArgs argument passed to evalModules. + +

  • All attributes of specialArgs + +Whereas option values can generally depend on other option values +thanks to laziness, this does not apply to imports, which +must be computed statically before anything else. + +For this reason, callers of the module system can provide specialArgs +which are available during import resolution. + +For NixOS, specialArgs includes +modulesPath, which allows you to import +extra modules from the nixpkgs package tree without having to +somehow make the module aware of the location of the +nixpkgs or NixOS directories. + +

    +{ modulesPath, ... }: {
+  imports = [
+    (modulesPath + "/profiles/minimal.nix")
+  ];
+}
+

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 value

Declared by:

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

List of email accounts.

Type: attribute set of (submodule)

Default: { }

Declared by:

<home-manager/modules/services/imapnotify.nix> @@ -2170,7 +2218,7 @@ Can be used to specify extensions. <home-manager/modules/programs/beets.nix>
programs.borgmatic.enable

Whether to enable Borgmatic.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/borgmatic.nix> -
programs.borgmatic.package

Type: package

Default: pkgs.borgmatic

Declared by:

+
programs.borgmatic.package

The borgmatic package to use.

Type: package

Default: pkgs.borgmatic

Declared by:

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

Borgmatic allows for several named backup configurations, each with its own source directories and repositories. @@ -2346,7 +2394,7 @@ The possible attributes are: <home-manager/modules/programs/browserpass.nix>

programs.btop.enable

Whether to enable btop.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/btop.nix> -
programs.btop.package

Type: package

Default: pkgs.btop

Declared by:

+
programs.btop.package

The btop package to use.

Type: package

Default: pkgs.btop

Declared by:

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

Extra lines added to the btop.conf file.

Type: strings concatenated with "\n"

Default: ""

Declared by:

@@ -2483,13 +2531,13 @@ for the full list of options. <home-manager/modules/programs/direnv.nix>
programs.discocss.enable

Whether to enable discocss, a tiny Discord CSS injector for Linux and MacOS.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/discocss.nix> -
programs.discocss.package

Type: package

Default: pkgs.discocss

Declared by:

+
programs.discocss.package

The discocss package to use.

Type: package

Default: pkgs.discocss

Declared by:

<home-manager/modules/programs/discocss.nix>
programs.discocss.css

The custom CSS for discocss to use.

Type: string

Default: ""

Declared by:

<home-manager/modules/programs/discocss.nix>
programs.discocss.discordAlias

Whether to alias discocss to discord.

Type: boolean

Default: true

Declared by:

<home-manager/modules/programs/discocss.nix> -
programs.discocss.discordPackage

Type: package

Default: pkgs.discord

Declared by:

+
programs.discocss.discordPackage

The discord package to use.

Type: package

Default: pkgs.discord

Declared by:

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

Whether to enable Eclipse.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/eclipse.nix> @@ -2544,11 +2592,11 @@ available packages run: <home-manager/modules/programs/exa.nix>
programs.exa.enableAliases

Whether to enable recommended exa aliases.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/exa.nix> -
programs.exa.package

Type: package

Default: pkgs.exa

Declared by:

+
programs.exa.package

The exa package to use.

Type: package

Default: pkgs.exa

Declared by:

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

Whether to enable feh - a fast and light image viewer.

Type: boolean

Default: false

Example: true

Declared by:

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

Type: package

Default: pkgs.feh

Declared by:

+
programs.feh.package

The feh package to use.

Type: package

Default: pkgs.feh

Declared by:

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

Override feh's default mouse button mapping. If you want to disable an action, set its value to null. If you want to bind multiple buttons to @@ -3360,7 +3408,7 @@ Note that lists are converted to duplicate keys. <home-manager/modules/programs/gpg.nix>

programs.havoc.enable

Whether to enable Havoc terminal.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/havoc.nix> -
programs.havoc.package

Type: package

Default: pkgs.havoc

Declared by:

+
programs.havoc.package

The havoc package to use.

Type: package

Default: pkgs.havoc

Declared by:

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

Configuration written to $XDG_CONFIG_HOME/havoc.cfg. See https://raw.githubusercontent.com/ii8/havoc/master/havoc.cfg @@ -3690,7 +3738,7 @@ attempted. the default configuration.

Type: boolean

Default: true

Declared by:

<home-manager/modules/programs/i3status.nix> -
programs.i3status.package

Type: package

Default: pkgs.i3status

Declared by:

+
programs.i3status.package

The i3status package to use.

Type: package

Default: pkgs.i3status

Declared by:

<home-manager/modules/programs/i3status.nix>
programs.i3status.general

Configuration to add to i3status config general section. @@ -4033,7 +4081,7 @@ variable. <home-manager/modules/programs/jq.nix>

programs.k9s.enable

Whether to enable k9s - Kubernetes CLI To Manage Your Clusters In Style.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/k9s.nix> -
programs.k9s.package

Type: package

Default: pkgs.k9s

Declared by:

+
programs.k9s.package

The k9s package to use.

Type: package

Default: pkgs.k9s

Declared by:

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

Configuration written to $XDG_CONFIG_HOME/k9s/config.yml. See @@ -4057,7 +4105,7 @@ for supported values. <home-manager/modules/programs/k9s.nix>

programs.kakoune.enable

Whether to enable the kakoune text editor.

Type: boolean

Default: false

Example: true

Declared by:

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

Type: package

Default: pkgs.kakoune-unwrapped

Declared by:

+
programs.kakoune.package

The kakoune-unwrapped package to use.

Type: package

Default: pkgs.kakoune-unwrapped

Declared by:

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

kakoune configuration options.

Type: null or (submodule)

Default: { }

Declared by:

<home-manager/modules/programs/kakoune.nix> @@ -4388,7 +4436,7 @@ The innermost attributes must be of type str. <home-manager/modules/programs/kodi.nix>
programs.lazygit.enable

Whether to enable lazygit, a simple terminal UI for git commands.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/lazygit.nix> -
programs.lazygit.package

Type: package

Default: pkgs.lazygit

Declared by:

+
programs.lazygit.package

The lazygit package to use.

Type: package

Default: pkgs.lazygit

Declared by:

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

Configuration written to $XDG_CONFIG_HOME/lazygit/config.yml on Linux @@ -4407,7 +4455,7 @@ for supported values. <home-manager/modules/programs/lazygit.nix>

programs.ledger.enable

Whether to enable ledger, a double-entry accounting system.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/ledger.nix> -
programs.ledger.package

Type: package

Default: pkgs.ledger

Declared by:

+
programs.ledger.package

The ledger package to use.

Type: package

Default: pkgs.ledger

Declared by:

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

Configuration written to $XDG_CONFIG_HOME/ledger/ledgerrc. See https://www.ledger-cli.org/3.0/doc/ledger3.html#Detailed-Option-Description @@ -4512,7 +4560,7 @@ for details on supported values. <home-manager/modules/programs/lieer.nix>

programs.looking-glass-client.enable

Whether to enable looking-glass-client.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/looking-glass-client.nix> -
programs.looking-glass-client.package

Type: package

Default: pkgs.looking-glass-client

Declared by:

+
programs.looking-glass-client.package

The looking-glass-client package to use.

Type: package

Default: pkgs.looking-glass-client

Declared by:

<home-manager/modules/programs/looking-glass-client.nix>
programs.looking-glass-client.settings

looking-glass-client settings.

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

Default: { }

Example: 

{
   app = {
@@ -5203,7 +5251,7 @@ imperatively, for example, using Syncthing.
                     <home-manager/modules/programs/newsboat.nix>
programs.nheko.enable

Whether to enable Qt desktop client for Matrix.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/nheko.nix> -
programs.nheko.package

Type: package

Default: pkgs.nheko

Declared by:

+
programs.nheko.package

The nheko package to use.

Type: package

Default: pkgs.nheko

Declared by:

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

Attribute set of Nheko preferences (converted to an INI file). @@ -5459,7 +5507,7 @@ configuration.

programs.oh-my-posh.enableZshIntegration

Whether to enable Zsh integration.

Type: boolean

Default: true

Declared by:

<home-manager/modules/programs/oh-my-posh.nix> -
programs.oh-my-posh.package

Type: package

Default: pkgs.oh-my-posh

Declared by:

+
programs.oh-my-posh.package

The oh-my-posh package to use.

Type: package

Default: pkgs.oh-my-posh

Declared by:

<home-manager/modules/programs/oh-my-posh.nix>
programs.oh-my-posh.settings

Configuration written to $XDG_CONFIG_HOME/oh-my-posh/config.json. See @@ -5611,7 +5659,7 @@ documentation for details. <home-manager/modules/programs/pls.nix>

programs.pls.enableAliases

Whether to enable recommended pls aliases.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/pls.nix> -
programs.pls.package

Type: package

Default: pkgs.pls

Declared by:

+
programs.pls.package

The pls package to use.

Type: package

Default: pkgs.pls

Declared by:

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

Whether to enable Powerline-go, a beautiful and useful low-latency prompt for your shell.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/powerline-go.nix> @@ -7722,7 +7770,7 @@ for more information about the format. <home-manager/modules/services/borgmatic.nix>
services.cachix-agent.enable

Whether to enable Cachix Deploy Agent: https://docs.cachix.org/deploy/.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/cachix-agent.nix> -
services.cachix-agent.package

Type: package

Default: pkgs.cachix

Declared by:

+
services.cachix-agent.package

The cachix package to use.

Type: package

Default: pkgs.cachix

Declared by:

<home-manager/modules/services/cachix-agent.nix>
services.cachix-agent.credentialsFile

Required file that needs to contain CACHIX_AGENT_TOKEN=.... @@ -7766,7 +7814,7 @@ percent symbol). <home-manager/modules/services/cbatticon.nix>

services.clipman.enable

Whether to enable clipman, a simple clipboard manager for Wayland.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/clipman.nix> -
services.clipman.package

Type: package

Default: pkgs.clipman

Declared by:

+
services.clipman.package

The clipman package to use.

Type: package

Default: pkgs.clipman

Declared by:

<home-manager/modules/services/clipman.nix>
services.clipman.systemdTarget

The systemd target that will automatically start the Waybar service.

@@ -8501,7 +8549,7 @@ useful for creating the directories mbsync is going to use. <home-manager/modules/services/mbsync.nix>

services.megasync.enable

Whether to enable Megasync client.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/megasync.nix> -
services.megasync.package

Type: package

Default: pkgs.megasync

Declared by:

+
services.megasync.package

The megasync package to use.

Type: package

Default: pkgs.megasync

Declared by:

<home-manager/modules/services/megasync.nix>
services.mopidy.enable

Whether to enable Mopidy music player daemon.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/mopidy.nix> @@ -8990,7 +9038,7 @@ click-right=pavucontrol & <home-manager/modules/services/poweralertd.nix>
services.pueue.enable

Whether to enable Pueue, CLI process scheduler and manager.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/pueue.nix> -
services.pueue.package

Type: package

Default: pkgs.pueue

Declared by:

+
services.pueue.package

The pueue package to use.

Type: package

Default: pkgs.pueue

Declared by:

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

Configuration written to $XDG_CONFIG_HOME/pueue/pueue.yml. @@ -9133,7 +9181,7 @@ Available options for Redshift described in <home-manager/modules/services/rsibreak.nix>

services.safeeyes.enable

Whether to enable The Safe Eyes OSGI service.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/safeeyes.nix> -
services.safeeyes.package

Type: package

Default: pkgs.safeeyes

Declared by:

+
services.safeeyes.package

The safeeyes package to use.

Type: package

Default: pkgs.safeeyes

Declared by:

<home-manager/modules/services/safeeyes.nix>
services.screen-locker.enable

Whether to enable screen locker for X session.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/screen-locker.nix> @@ -10880,13 +10928,13 @@ If this and all other xresources options are <home-manager/modules/xsession.nix>
xsession.numlock.enable

Whether to enable Num Lock.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/misc/numlock.nix> -
xsession.pointerCursor.package

Type: submodule

Declared by:

+
xsession.pointerCursor.package

Alias of home.pointerCursor.package.

Type: submodule

Declared by:

<home-manager/modules/config/home-cursor.nix> -
xsession.pointerCursor.defaultCursor

Type: submodule

Declared by:

+
xsession.pointerCursor.defaultCursor

Alias of home.pointerCursor.x11.defaultCursor.

Type: submodule

Declared by:

<home-manager/modules/config/home-cursor.nix> -
xsession.pointerCursor.name

Type: submodule

Declared by:

+
xsession.pointerCursor.name

Alias of home.pointerCursor.name.

Type: submodule

Declared by:

<home-manager/modules/config/home-cursor.nix> -
xsession.pointerCursor.size

Type: submodule

Declared by:

+
xsession.pointerCursor.size

Alias of home.pointerCursor.size.

Type: submodule

Declared by:

<home-manager/modules/config/home-cursor.nix>
xsession.preferStatusNotifierItems

Whether tray applets should prefer using the Status Notifier Items (SNI) protocol, commonly called App Indicators. Note, @@ -11028,7 +11076,7 @@ in <home-manager/modules/xsession.nix>

xsession.windowManager.fluxbox.enable

Whether to enable Fluxbox window manager.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/services/window-managers/fluxbox.nix> -
xsession.windowManager.fluxbox.package

Type: package

Default: pkgs.fluxbox

Declared by:

+
xsession.windowManager.fluxbox.package

The fluxbox package to use.

Type: package

Default: pkgs.fluxbox

Declared by:

<home-manager/modules/services/window-managers/fluxbox.nix>
xsession.windowManager.fluxbox.apps

Apps configuration for Fluxbox, written to ~/.fluxbox/apps. Look at the