From f1a630bc58d8996bcc8516f537975a15ffdd3f39 Mon Sep 17 00:00:00 2001 From: rycee Date: Fri, 23 Jun 2023 07:37:41 +0000 Subject: [PATCH] deploy: 491f74db894b5c5843a9e4b123aa773e1b21583f --- nix-darwin-options.html | 46 +++++++++++++++++++++++++++++- nixos-options.html | 46 +++++++++++++++++++++++++++++- options.html | 62 +++++++++++++++++++++++++++++++++++------ 3 files changed, 143 insertions(+), 11 deletions(-) diff --git a/nix-darwin-options.html b/nix-darwin-options.html index 5092abd5d..467306fff 100644 --- a/nix-darwin-options.html +++ b/nix-darwin-options.html @@ -1,5 +1,49 @@ -Appendix C. nix-darwin Module Options
Appendix C. nix-darwin Module Options
Prev   Next

Appendix C. nix-darwin Module Options

home-manager.backupFileExtension

On activation move existing files by appending the given +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: +- {var}`lib`: The nixpkgs library. +- {var}`config`: The results of all options after merging the values from all modules together. +- {var}`options`: The options declared in all modules. +- {var}`specialArgs`: The `specialArgs` argument passed to `evalModules`. +- All attributes of {var}`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 + {var}`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: +- {var}`pkgs`: The nixpkgs package set according to + the {option}`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.

Type: null or string

Default: null

Example: "backup"

Declared by:

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

Extra specialArgs passed to Home Manager. This diff --git a/nixos-options.html b/nixos-options.html index 65fa61d44..37a0f4a66 100644 --- a/nixos-options.html +++ b/nixos-options.html @@ -1,5 +1,49 @@ -Appendix B. NixOS Module Options

Appendix B. NixOS Module Options
Prev   Next

Appendix B. NixOS Module Options

home-manager.backupFileExtension

On activation move existing files by appending the given +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: +- {var}`lib`: The nixpkgs library. +- {var}`config`: The results of all options after merging the values from all modules together. +- {var}`options`: The options declared in all modules. +- {var}`specialArgs`: The `specialArgs` argument passed to `evalModules`. +- All attributes of {var}`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 + {var}`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: +- {var}`pkgs`: The nixpkgs package set according to + the {option}`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.

Type: null or string

Default: null

Example: "backup"

Declared by:

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

Extra specialArgs passed to Home Manager. This diff --git a/options.html b/options.html index 1a4b206df..237f57345 100644 --- a/options.html +++ b/options.html @@ -1,5 +1,49 @@ -Appendix A. Configuration Options

Appendix A. Configuration Options
Prev   Next

Appendix A. Configuration Options

accounts.calendar.accounts

List of calendars.

Type: attribute set of (submodule)

Default: { }

Declared by:

+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: +- {var}`lib`: The nixpkgs library. +- {var}`config`: The results of all options after merging the values from all modules together. +- {var}`options`: The options declared in all modules. +- {var}`specialArgs`: The `specialArgs` argument passed to `evalModules`. +- All attributes of {var}`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 + {var}`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: +- {var}`pkgs`: The nixpkgs package set according to + the {option}`nixpkgs.pkgs` option.

Type: lazy attribute set of raw value

Declared by:

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

List of calendars.

Type: attribute set of (submodule)

Default: { }

Declared by:

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

Whether to enable khal access.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/accounts/calendar.nix> @@ -6030,9 +6074,9 @@ substituting numeric shortcuts for files.

Type: <home-manager/modules/programs/scmpuff.nix>

programs.script-directory.enable

Whether to enable script-directory.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/script-directory.nix> -
programs.script-directory.package

The script-directory package to use.

Type: package

Default: pkgs.script-directory

Declared by:

+
programs.script-directory.package

The script-directory package to use.

Type: package

Default: pkgs.script-directory

Declared by:

<home-manager/modules/programs/script-directory.nix> -
programs.script-directory.settings

script-directory config, for options take a look at the documentation

Type: attribute set of string

Default: { }

Example: 

{
+
programs.script-directory.settings

script-directory config, for options take a look at the [documentation](github.com/ianthehenry/sd#options)

Type: attribute set of string

Default: { }

Example: 

{
   SD_ROOT = "${config.home.homeDirectory}/.sd";
   SD_EDITOR = "nvim";
   SD_CAT = "lolcat";
@@ -7660,7 +7704,7 @@ but are substituted anywhere on a line.
Type:qt5ct
       and
       qt6ct
-    applications
kde

Use Qt settings from Plasma

Type: null or one of "gtk", "gnome", "qtct", "kde"

Default: null

Example: "gnome"

Related packages:

  • pkgs.qgnomeplatform (qgnomeplatform-0.8.4): QPlatformTheme for a better Qt application inclusion in GNOME

  • pkgs.libsForQt5.qtstyleplugins (qtstyleplugins-unstable-2017-03-11): Additional style plugins for Qt5, including BB10, GTK, Cleanlooks, Motif, Plastique

  • pkgs.libsForQt5.qt5ct (qt5ct-1.5): Qt5 Configuration Tool

  • pkgs.qt6Packages.qt6ct (qt6ct-0.8): Qt6 Configuration Tool

  • pkgs.libsForQt5.plasma-integration (plasma-integration-5.27.5): A set of plugins responsible for better integration of Qt applications when running on a KDE Plasma workspace

  • pkgs.libsForQt5.systemsettings (systemsettings-5.27.5)

Declared by:

+ applications

kde

Use Qt settings from Plasma

Type: null or one of "gtk", "gnome", "qtct", "kde"

Default: null

Example: "gnome"

Related packages:

  • pkgs.qgnomeplatform (qgnomeplatform-0.8.4): QPlatformTheme for a better Qt application inclusion in GNOME

  • pkgs.libsForQt5.qtstyleplugins (qtstyleplugins-unstable-2017-03-11): Additional style plugins for Qt5, including BB10, GTK, Cleanlooks, Motif, Plastique

  • pkgs.libsForQt5.qt5ct (qt5ct-1.5): Qt5 Configuration Tool

  • pkgs.qt6Packages.qt6ct (qt6ct-0.8): Qt6 Configuration Tool

  • pkgs.libsForQt5.plasma-integration (plasma-integration-5.27.6): A set of plugins responsible for better integration of Qt applications when running on a KDE Plasma workspace

  • pkgs.libsForQt5.systemsettings (systemsettings-5.27.6)

Declared by:

<home-manager/modules/misc/qt.nix>
qt.style.package

Theme package to be used in Qt5/Qt6 applications. Auto-detected from qt.style.name if possible.

Type: null or package or list of package

Default: null

Example: pkgs.adwaita-qt

Declared by:

@@ -7675,7 +7719,7 @@ Auto-detected from qt.style.name if possible.

qtstyleplugins

kvantum

Use styles from kvantum -

Type: null or string

Default: null

Example: "adwaita-dark"

Related packages:

  • pkgs.adwaita-qt (adwaita-qt-1.4.2): A style to bend Qt applications to look like they belong into GNOME Shell

  • pkgs.libsForQt5.breeze-qt5 (breeze-qt5-5.27.5)

  • pkgs.libsForQt5.qtstyleplugins (qtstyleplugins-unstable-2017-03-11): Additional style plugins for Qt5, including BB10, GTK, Cleanlooks, Motif, Plastique

  • pkgs.qtstyleplugin-kvantum-qt4 (qtstyleplugin-kvantum-qt4-1.0.10): SVG-based Qt4 theme engine

  • pkgs.libsForQt5.qtstyleplugin-kvantum (qtstyleplugin-kvantum-1.0.10): SVG-based Qt5 theme engine plus a config tool and extra themes

  • pkgs.qt6Packages.qtstyleplugin-kvantum (qtstyleplugin-kvantum-1.0.10): SVG-based Qt5 theme engine plus a config tool and extra themes

Declared by:

+

Type: null or string

Default: null

Example: "adwaita-dark"

Related packages:

  • pkgs.adwaita-qt (adwaita-qt-1.4.2): A style to bend Qt applications to look like they belong into GNOME Shell

  • pkgs.libsForQt5.breeze-qt5 (breeze-qt5-5.27.6)

  • pkgs.libsForQt5.qtstyleplugins (qtstyleplugins-unstable-2017-03-11): Additional style plugins for Qt5, including BB10, GTK, Cleanlooks, Motif, Plastique

  • pkgs.qtstyleplugin-kvantum-qt4 (qtstyleplugin-kvantum-qt4-1.0.10): SVG-based Qt4 theme engine

  • pkgs.libsForQt5.qtstyleplugin-kvantum (qtstyleplugin-kvantum-1.0.10): SVG-based Qt5 theme engine plus a config tool and extra themes

  • pkgs.qt6Packages.qtstyleplugin-kvantum (qtstyleplugin-kvantum-1.0.10): SVG-based Qt5 theme engine plus a config tool and extra themes

Declared by:

<home-manager/modules/misc/qt.nix>
services.autorandr.enable

Whether to enable the Autorandr systemd service. This module is complementary to programs.autorandr which handles the @@ -10848,13 +10892,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

Alias of home.pointerCursor.package.

Type: submodule

Declared by:

+
xsession.pointerCursor.package

Alias of {option}`home.pointerCursor.package`.

Type: submodule

Declared by:

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

Alias of home.pointerCursor.x11.defaultCursor.

Type: submodule

Declared by:

+
xsession.pointerCursor.defaultCursor

Alias of {option}`home.pointerCursor.x11.defaultCursor`.

Type: submodule

Declared by:

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

Alias of home.pointerCursor.name.

Type: submodule

Declared by:

+
xsession.pointerCursor.name

Alias of {option}`home.pointerCursor.name`.

Type: submodule

Declared by:

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

Alias of home.pointerCursor.size.

Type: submodule

Declared by:

+
xsession.pointerCursor.size

Alias of {option}`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,