Appendix B. NixOS Configuration Options

home-manager.enableLegacyProfileManagement

Whether to enable legacy profile management during activation. When enabled, the Home Manager activation will produce a per-user home-manager Nix profile, just like in the standalone installation of Home Manager. Typically, this is not desired when Home Manager is embedded in the system configuration.

Type: boolean

Default: false

Declared by:

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

On activation run this command on each existing file rather than exiting with an error.

Type: null or string or absolute path

Default: null

Example: ${pkgs.trash-cli}/bin/trash

Declared by:

<home-manager/nixos/common.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 option can be used to pass additional arguments to all modules.

Type: attribute set

Default: { }

Example: { inherit emacs-overlay; }

Declared by:

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

Whether to enable only the necessary modules that allow home-manager to function.

This can be used to allow vendoring a minimal list of modules yourself, rather than importing every single module.

THIS IS FOR ADVANCED USERS, AND WILL DISABLE ALMOST EVERY MODULE. THIS SHOULD NOT BE ENABLED UNLESS YOU KNOW THE IMPLICATIONS. .

Type: boolean

Default: false

Example: true

Declared by:

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

Whether to enable forced overwriting of existing backup files when using backupFileExtension .

Type: boolean

Default: false

Example: true

Declared by:

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

Extra modules added to all users.

Type: list of raw value

Default: [ ]

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

Declared by:

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

Whether to enable using the system configuration’s pkgs argument in Home Manager. This disables the Home Manager options nixpkgs.*.

Type: boolean

Default: false

Example: true

Declared by:

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

Whether to enable installation of user packages through the users.users.<name>.packages option.

Type: boolean

Default: false

Example: true

Declared by:

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

Per-user Home Manager configuration.

Type: attribute set of (Home Manager module)

Default: { }

Declared by:

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

Whether to enable verbose output on activation.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/nixos/common.nix>