Appendix A. Home Manager configuration options

for options under programs.emacs.init, or

for options under theme.base16 and enableBase16Theme options for various Home Manager modules.

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:

For NixOS, the default value for this option includes at least this argument:

Type: lazy attribute set of raw value

Declared by:

Enable Base16 theme.

Type: boolean

Default: true

Example: false

Declared by:

Enable Base16 theme.

Type: boolean

Default: true

Example: false

Declared by:

Build Base16 theme for Emacs. Note, this does not actually enable the theme.

Type: boolean

Default: true

Example: false

Declared by:

Whether to enable Emacs configuration.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable package-quickstart. This will make sure that package.el is activated and all autoloads are available.

If disabled you can save quite a few milliseconds on the startup time, but you will most likely have to tweak the command option of various packages.

As an example, running (emacs-init-time) on an Emacs configuration with this option enabled reported ~300ms. Disabling the option dropped the init time to ~200ms.

Type: boolean

Default: true

Declared by:

Configuration lines to add in early-init.el.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Configuration lines to add in the end of init.el.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Configuration lines to add in the beginning of init.el.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Whether to enable recommended garbage collection settings.

This will reduce garbage collection frequency during startup and while the minibuffer is active.

Type: boolean

Default: false

Example: true

Declared by:

Whether to enable Emacs startup duration timer.

Type: boolean

Default: false

Example: true

Declared by:

Attribute set of use-package configurations.

Type: attribute set of (submodule)

Default: { }

Example:

{
  dhall-mode = {
    mode = [ ''"\\.dhall\\'"'' ];
  };
}

Declared by:

Whether to enable Emacs package ‹name›.

Type: boolean

Default: false

Example: true

Declared by:

The package to use for this module. Either the package name within the Emacs package set or a function taking the Emacs package set and returning a package.

Type: name of package or (function from epkgs to package)

Default: "‹name›"

Declared by:

The entries to use for :after.

Type: list of string

Default: [ ]

Declared by:

The entries to use for :bind.

Type: attribute set of string

Default: { }

Example:

{
  "M-<down>" = "drag-stuff-down";
  "M-<up>" = "drag-stuff-up";
}

Declared by:

The entries to use for :bind-keymap.

Type: attribute set of string

Default: { }

Example:

{
  "C-c p" = "projectile-command-map";
}

Declared by:

The entries to use for local keymaps in :bind.

Type: attribute set of attribute set of string

Default: { }

Example:

{
  helm-command-map = {
    "C-c h" = "helm-execute-persistent-action";
  };
}

Declared by:

The entries to use for :chords.

Type: attribute set of string

Default: { }

Example:

{
  jj = "ace-jump-char-mode";
  jk = "ace-jump-word-mode";
}

Declared by:

The entries to use for :commands.

Type: list of string

Default: [ ]

Declared by:

Code to place in the :config section.

Type: strings concatenated with "\n"

Default: ""

Declared by:

The :defer setting.

Type: boolean or positive integer, meaning >0

Default: false

Declared by:

The entries to use for :defines.

Type: list of string

Default: [ ]

Declared by:

The :demand setting.

Type: boolean

Default: false

Declared by:

The entries to use for :diminish.

Type: list of string

Default: [ ]

Declared by:

Lines to add to programs.emacs.init.earlyInit when this package is enabled.

Note, the package is not automatically loaded so you will have to require the necessary features yourself.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Additional lines to place in the use-package configuration.

Type: strings concatenated with "\n"

Default: ""

Declared by:

Extra packages to add to home.packages.

Type: list of package

Default: [ ]

Declared by:

The entries to use for :functions.

Type: list of string

Default: [ ]

Declared by:

The entries to use for :hook.

Type: list of string

Default: [ ]

Declared by:

The entries to use for :init.

Type: strings concatenated with "\n"

Default: ""

Declared by:

The entries to use for :mode.

Type: list of string

Default: [ ]

Declared by:

Whether to enable verbose use-package mode.

Type: boolean

Default: false

Example: true

Declared by:

Enable Base16 theme.

Type: boolean

Default: true

Example: false

Declared by:

Enable Base16 theme.

Type: boolean

Default: true

Example: false

Declared by:

Enable Base16 theme.

Type: boolean

Default: true

Example: false

Declared by:

Enable Base16 theme.

Type: boolean

Default: true

Example: false

Declared by:

Enable Base16 theme.

Type: boolean

Default: true

Example: false

Declared by:

Enable Base16 theme.

Type: boolean

Default: true

Example: false

Declared by:

Enable Base16 theme.

Type: boolean

Default: true

Example: false

Declared by:

Color value. Either a hexadecimal or decimal RGB triplet must be given. If a hexadecimal triplet is given then the decimal triplet is automatically populated, and vice versa. That is, the example could be equivalently written

  { hex.r = "b1"; hex.g = "2a"; hex.b = "2a"; }

And

  "red dec: ${dec.r}, red hex: ${hex.r}, rgb hex: ${hex.rgb}"

would expand to “red dec: 177, red hex: b1, rgb hex: b12a2a”.

Type: submodule

Example:

{
  dec = {
    b = 42;
    g = 42;
    r = 177;
  };
}

Declared by:

Color value. Either a hexadecimal or decimal RGB triplet must be given. If a hexadecimal triplet is given then the decimal triplet is automatically populated, and vice versa. That is, the example could be equivalently written

  { hex.r = "b1"; hex.g = "2a"; hex.b = "2a"; }

And

  "red dec: ${dec.r}, red hex: ${hex.r}, rgb hex: ${hex.rgb}"

would expand to “red dec: 177, red hex: b1, rgb hex: b12a2a”.

Type: submodule

Example:

{
  dec = {
    b = 42;
    g = 42;
    r = 177;
  };
}

Declared by:

Color value. Either a hexadecimal or decimal RGB triplet must be given. If a hexadecimal triplet is given then the decimal triplet is automatically populated, and vice versa. That is, the example could be equivalently written

  { hex.r = "b1"; hex.g = "2a"; hex.b = "2a"; }

And

  "red dec: ${dec.r}, red hex: ${hex.r}, rgb hex: ${hex.rgb}"

would expand to “red dec: 177, red hex: b1, rgb hex: b12a2a”.

Type: submodule

Example:

{
  dec = {
    b = 42;
    g = 42;
    r = 177;
  };
}

Declared by:

Color value. Either a hexadecimal or decimal RGB triplet must be given. If a hexadecimal triplet is given then the decimal triplet is automatically populated, and vice versa. That is, the example could be equivalently written

  { hex.r = "b1"; hex.g = "2a"; hex.b = "2a"; }

And

  "red dec: ${dec.r}, red hex: ${hex.r}, rgb hex: ${hex.rgb}"

would expand to “red dec: 177, red hex: b1, rgb hex: b12a2a”.

Type: submodule

Example:

{
  dec = {
    b = 42;
    g = 42;
    r = 177;
  };
}

Declared by:

Color value. Either a hexadecimal or decimal RGB triplet must be given. If a hexadecimal triplet is given then the decimal triplet is automatically populated, and vice versa. That is, the example could be equivalently written

  { hex.r = "b1"; hex.g = "2a"; hex.b = "2a"; }

And

  "red dec: ${dec.r}, red hex: ${hex.r}, rgb hex: ${hex.rgb}"

would expand to “red dec: 177, red hex: b1, rgb hex: b12a2a”.

Type: submodule

Example:

{
  dec = {
    b = 42;
    g = 42;
    r = 177;
  };
}

Declared by:

Color value. Either a hexadecimal or decimal RGB triplet must be given. If a hexadecimal triplet is given then the decimal triplet is automatically populated, and vice versa. That is, the example could be equivalently written

  { hex.r = "b1"; hex.g = "2a"; hex.b = "2a"; }

And

  "red dec: ${dec.r}, red hex: ${hex.r}, rgb hex: ${hex.rgb}"

would expand to “red dec: 177, red hex: b1, rgb hex: b12a2a”.

Type: submodule

Example:

{
  dec = {
    b = 42;
    g = 42;
    r = 177;
  };
}

Declared by:

Color value. Either a hexadecimal or decimal RGB triplet must be given. If a hexadecimal triplet is given then the decimal triplet is automatically populated, and vice versa. That is, the example could be equivalently written

  { hex.r = "b1"; hex.g = "2a"; hex.b = "2a"; }

And

  "red dec: ${dec.r}, red hex: ${hex.r}, rgb hex: ${hex.rgb}"

would expand to “red dec: 177, red hex: b1, rgb hex: b12a2a”.

Type: submodule

Example:

{
  dec = {
    b = 42;
    g = 42;
    r = 177;
  };
}

Declared by:

Color value. Either a hexadecimal or decimal RGB triplet must be given. If a hexadecimal triplet is given then the decimal triplet is automatically populated, and vice versa. That is, the example could be equivalently written

  { hex.r = "b1"; hex.g = "2a"; hex.b = "2a"; }

And

  "red dec: ${dec.r}, red hex: ${hex.r}, rgb hex: ${hex.rgb}"

would expand to “red dec: 177, red hex: b1, rgb hex: b12a2a”.

Type: submodule

Example:

{
  dec = {
    b = 42;
    g = 42;
    r = 177;
  };
}

Declared by:

Color value. Either a hexadecimal or decimal RGB triplet must be given. If a hexadecimal triplet is given then the decimal triplet is automatically populated, and vice versa. That is, the example could be equivalently written

  { hex.r = "b1"; hex.g = "2a"; hex.b = "2a"; }

And

  "red dec: ${dec.r}, red hex: ${hex.r}, rgb hex: ${hex.rgb}"

would expand to “red dec: 177, red hex: b1, rgb hex: b12a2a”.

Type: submodule

Example:

{
  dec = {
    b = 42;
    g = 42;
    r = 177;
  };
}

Declared by:

Color value. Either a hexadecimal or decimal RGB triplet must be given. If a hexadecimal triplet is given then the decimal triplet is automatically populated, and vice versa. That is, the example could be equivalently written

  { hex.r = "b1"; hex.g = "2a"; hex.b = "2a"; }

And

  "red dec: ${dec.r}, red hex: ${hex.r}, rgb hex: ${hex.rgb}"

would expand to “red dec: 177, red hex: b1, rgb hex: b12a2a”.

Type: submodule

Example:

{
  dec = {
    b = 42;
    g = 42;
    r = 177;
  };
}

Declared by:

Color value. Either a hexadecimal or decimal RGB triplet must be given. If a hexadecimal triplet is given then the decimal triplet is automatically populated, and vice versa. That is, the example could be equivalently written

  { hex.r = "b1"; hex.g = "2a"; hex.b = "2a"; }

And

  "red dec: ${dec.r}, red hex: ${hex.r}, rgb hex: ${hex.rgb}"

would expand to “red dec: 177, red hex: b1, rgb hex: b12a2a”.

Type: submodule

Example:

{
  dec = {
    b = 42;
    g = 42;
    r = 177;
  };
}

Declared by:

Color value. Either a hexadecimal or decimal RGB triplet must be given. If a hexadecimal triplet is given then the decimal triplet is automatically populated, and vice versa. That is, the example could be equivalently written

  { hex.r = "b1"; hex.g = "2a"; hex.b = "2a"; }

And

  "red dec: ${dec.r}, red hex: ${hex.r}, rgb hex: ${hex.rgb}"

would expand to “red dec: 177, red hex: b1, rgb hex: b12a2a”.

Type: submodule

Example:

{
  dec = {
    b = 42;
    g = 42;
    r = 177;
  };
}

Declared by:

Color value. Either a hexadecimal or decimal RGB triplet must be given. If a hexadecimal triplet is given then the decimal triplet is automatically populated, and vice versa. That is, the example could be equivalently written

  { hex.r = "b1"; hex.g = "2a"; hex.b = "2a"; }

And

  "red dec: ${dec.r}, red hex: ${hex.r}, rgb hex: ${hex.rgb}"

would expand to “red dec: 177, red hex: b1, rgb hex: b12a2a”.

Type: submodule

Example:

{
  dec = {
    b = 42;
    g = 42;
    r = 177;
  };
}

Declared by:

Color value. Either a hexadecimal or decimal RGB triplet must be given. If a hexadecimal triplet is given then the decimal triplet is automatically populated, and vice versa. That is, the example could be equivalently written

  { hex.r = "b1"; hex.g = "2a"; hex.b = "2a"; }

And

  "red dec: ${dec.r}, red hex: ${hex.r}, rgb hex: ${hex.rgb}"

would expand to “red dec: 177, red hex: b1, rgb hex: b12a2a”.

Type: submodule

Example:

{
  dec = {
    b = 42;
    g = 42;
    r = 177;
  };
}

Declared by:

Color value. Either a hexadecimal or decimal RGB triplet must be given. If a hexadecimal triplet is given then the decimal triplet is automatically populated, and vice versa. That is, the example could be equivalently written

  { hex.r = "b1"; hex.g = "2a"; hex.b = "2a"; }

And

  "red dec: ${dec.r}, red hex: ${hex.r}, rgb hex: ${hex.rgb}"

would expand to “red dec: 177, red hex: b1, rgb hex: b12a2a”.

Type: submodule

Example:

{
  dec = {
    b = 42;
    g = 42;
    r = 177;
  };
}

Declared by:

Color value. Either a hexadecimal or decimal RGB triplet must be given. If a hexadecimal triplet is given then the decimal triplet is automatically populated, and vice versa. That is, the example could be equivalently written

  { hex.r = "b1"; hex.g = "2a"; hex.b = "2a"; }

And

  "red dec: ${dec.r}, red hex: ${hex.r}, rgb hex: ${hex.rgb}"

would expand to “red dec: 177, red hex: b1, rgb hex: b12a2a”.

Type: submodule

Example:

{
  dec = {
    b = 42;
    g = 42;
    r = 177;
  };
}

Declared by:

Whether theme is dark or light. The default value is determined by a basic heuristic, if an incorrect value is found then this option must be set explicitly.

Type: one of "dark", "light"

Default:

"light", if sum of RGB components of base00 color ≥ 382,
"dark", otherwise

Example: "dark"

Declared by:

The theme name.

Type: string

Example: "My-Fine-Theme"

Declared by: