From e0ea54d47d3f2e19be6665c5bccedba44deb2d35 Mon Sep 17 00:00:00 2001 From: rycee Date: Sun, 13 Nov 2022 09:19:06 +0000 Subject: [PATCH] deploy: 651db464dcbf86700dbb84bf7085702a82533aaa --- index.html | 4 +- options.html | 118 +++++++++++++++++++++++++-------------------------- tools.html | 14 +++--- 3 files changed, 68 insertions(+), 68 deletions(-) diff --git a/index.html b/index.html index e6bc74abd..ab83c943b 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -Home Manager Manual

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.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 22.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.11
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 21.05
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 20.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.09
E.7.1. Highlights
E.7.2. State Version Changes
E.8. Release 19.03
E.8.1. Highlights
E.8.2. State Version Changes
E.9. Release 18.09

Preface

+Home Manager Manual

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.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 22.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.11
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 21.05
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 20.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.09
E.7.1. Highlights
E.7.2. State Version Changes
E.8. Release 19.03
E.8.1. Highlights
E.8.2. State Version Changes
E.9. Release 18.09

Preface

This manual will eventually describe how to install, use, and extend Home Manager.

diff --git a/options.html b/options.html index 213b01d1c..23ba85611 100644 --- a/options.html +++ b/options.html @@ -227,7 +227,7 @@ account configuration. be used to validate the connection authenticity. If null then the system default is used. Note, if set then the system default may still be accepted. -

Type: null or (path)

Default: "config.accounts.email.certificatesFile"

Declared by:

+

Type: null or path

Default: "config.accounts.email.certificatesFile"

Declared by:

<home-manager/modules/accounts/email.nix>
accounts.email.accounts.<name>.imap.tls.useStartTls

Whether to use STARTTLS.

Type: boolean

Default: false

Declared by:

@@ -744,7 +744,7 @@ set as primary. }

Declared by:

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

A command that generates a signature.

Type: null or (path)

Default: null

Example:

pkgs.writeScript "signature" "echo This is my signature"
+                
accounts.email.accounts.<name>.signature.command

A command that generates a signature.

Type: null or path

Default: null

Example:

pkgs.writeScript "signature" "echo This is my signature"
 

Declared by:

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

Method to communicate the signature.

Type: one of "append", "attach", "none"

Default: "none"

Declared by:

@@ -780,7 +780,7 @@ May the force be with you. be used to validate the connection authenticity. If null then the system default is used. Note, if set then the system default may still be accepted. -

Type: null or (path)

Default: "config.accounts.email.certificatesFile"

Declared by:

+

Type: null or path

Default: "config.accounts.email.certificatesFile"

Declared by:

<home-manager/modules/accounts/email.nix>
accounts.email.accounts.<name>.smtp.tls.useStartTls

Whether to use STARTTLS.

Type: boolean

Default: false

Declared by:

@@ -813,7 +813,7 @@ the SMTP, IMAP, and JMAP user name.
accounts.email.certificatesFile

Path to default file containing certificate authorities that should be used to validate the connection authenticity. This path may be overridden on a per-account basis. -

Type: null or (path)

Default: "/etc/ssl/certs/ca-certificates.crt"

Declared by:

+

Type: null or path

Default: "/etc/ssl/certs/ca-certificates.crt"

Declared by:

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

The base directory for account maildir directories. May be a relative path, in which case it is relative the home @@ -1561,7 +1561,7 @@ resource limits to the job, throttling its CPU usage and I/O bandwidth. The foll

launchd.agents.<name>.config.Program

This key maps to the first argument of execvp(3). If this key is missing, then the first element of the array of strings provided to the ProgramArguments will be used instead. This key is required in the absence of the ProgramArguments key. -

Type: null or (path)

Default: null

Declared by:

+

Type: null or path

Default: null

Declared by:

<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! @@ -1622,7 +1622,7 @@ octal, so please convert the value to decimal. <home-manager/modules/launchd/default.nix>

launchd.agents.<name>.config.Sockets.<name>.SockPathName

This optional key implies SockFamily is set to "Unix". It specifies the path to connect(2) or bind(2) to. -

Type: null or (path)

Default: null

Declared by:

+

Type: null or path

Default: null

Declared by:

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

This optional key specifies the protocol to be passed to socket(2). The only value understood by this key at the moment is "TCP". @@ -1675,14 +1675,14 @@ stack segment may be extended. Stack extension is performed automatically by th

Type: null or signed integer

Default: null

Declared by:

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

This optional key specifies what file should be used for data being sent to stderr when using stdio(3). -

Type: null or (path)

Default: null

Declared by:

+

Type: null or path

Default: null

Declared by:

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

This optional key specifies what file should be used for data being supplied to stdin when using stdio(3). -

Type: null or (path)

Default: null

Declared by:

+

Type: null or path

Default: null

Declared by:

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

This optional key specifies what file should be used for data being sent to stdout when using stdio(3). -

Type: null or (path)

Default: null

Declared by:

+

Type: null or path

Default: null

Declared by:

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

This optional key causes the job to be started every calendar interval as specified. Missing arguments are considered to be wildcard. The semantics are much like crontab(5). Unlike cron which skips job @@ -1742,7 +1742,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 (path))

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:

@@ -2601,13 +2601,13 @@ each with its own source directories and repositories. <home-manager/modules/programs/borgmatic.nix>
programs.borgmatic.backups.<name>.consistency.checks.*.name

Name of consistency check to run.

Type: one of "repository", "archives", "data", "extract"

Example: "repository"

Declared by:

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

Extra settings.

Type: attribute set of (string or boolean or (path) or signed integer)

Default: +

programs.borgmatic.backups.<name>.consistency.extraConfig

Extra settings.

Type: attribute set of (string or boolean or path or signed integer)

Default: { }

Declared by:

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

Extra settings.

Type: attribute set of (string or boolean or (path) or signed integer)

Default: +

programs.borgmatic.backups.<name>.location.extraConfig

Extra settings.

Type: attribute set of (string or boolean or path or signed integer)

Default: { } @@ -2617,7 +2617,7 @@ each with its own source directories and repositories. <home-manager/modules/programs/borgmatic.nix>

programs.borgmatic.backups.<name>.location.sourceDirectories

Directories to backup.

Type: list of string

Example: [config.home.homeDirectory]

Declared by:

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

Extra settings.

Type: attribute set of (string or boolean or (path) or signed integer)

Default: +

programs.borgmatic.backups.<name>.retention.extraConfig

Extra settings.

Type: attribute set of (string or boolean or path or signed integer)

Default: { } @@ -2641,7 +2641,7 @@ each with its own source directories and repositories. <home-manager/modules/programs/borgmatic.nix>

programs.borgmatic.backups.<name>.storage.encryptionPasscommand

Command writing the passphrase to standard output.

Type: null or string

Default: null

Example: "${pkgs.password-store}/bin/pass borg-repo"

Declared by:

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

Extra settings.

Type: attribute set of (string or boolean or (path) or signed integer)

Default: +

programs.borgmatic.backups.<name>.storage.extraConfig

Extra settings.

Type: attribute set of (string or boolean or path or signed integer)

Default: { } @@ -2835,7 +2835,7 @@ documentation.

Declared by:

<home-manager/modules/programs/chromium.nix>
programs.chromium.extensions.*.crxPath

Path to the extension's crx file. Linux only. -

Type: null or (path)

Default: null

Declared by:

+

Type: null or path

Default: null

Declared by:

<home-manager/modules/programs/chromium.nix>
programs.chromium.extensions.*.id

The extension's ID from the Chome Web Store url or the unpacked crx.

Type: string matching the pattern [a-zA-Z]{32}

Default: ""

Declared by:

@@ -3612,7 +3612,7 @@ deprecated and will be removed in the future.
programs.git.hooks

Configuration helper for Git hooks. See https://git-scm.com/docs/githooks for reference. -

Type: attribute set of (path)

Default: +

Type: attribute set of path

Default: { } @@ -3673,7 +3673,7 @@ This follows the configuration structure as described in };

Declared by:

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

Path of the configuration file to include.

Type: string or (path)

Declared by:

+
programs.git.includes.*.path

Path of the configuration file to include.

Type: string or path

Declared by:

<home-manager/modules/programs/git.nix>
programs.git.lfs.enable

Whether to enable Git Large File Storage.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/git.nix> @@ -3704,7 +3704,7 @@ to use depending on commit’s author. <home-manager/modules/programs/gitui.nix>
programs.gitui.keyConfig

Key config in Ron file format. This is written to $XDG_CONFIG_HOME/gitui/key_config.ron. -

Type: (path) or strings concatenated with "\n"

Default: ""

Example:

''
+

Type: path or strings concatenated with "\n"

Default: ""

Example:

''
 exit: Some(( code: Char('c'), modifiers: ( bits: 2,),)),
 quit: Some(( code: Char('q'), modifiers: ( bits: 0,),)),
 exit_popup: Some(( code: Esc, modifiers: ( bits: 0,),)),
@@ -3712,7 +3712,7 @@ exit_popup: Some(( code: Esc, modifiers: ( bits: 0,),)),
                     <home-manager/modules/programs/gitui.nix>
                 
programs.gitui.theme

Theme in Ron file format. This is written to $XDG_CONFIG_HOME/gitui/theme.ron. -

Type: (path) or strings concatenated with "\n"

Default:

''
+

Type: path or strings concatenated with "\n"

Default:

''
 (
   selected_tab: Reset,
   command_fg: White,
@@ -3836,7 +3836,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 (path)

Default: +

programs.go.packages

Packages to add to GOPATH.

Type: attribute set of path

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

programs.irssi.networks.<name>.server.ssl.certificateFile

Path to a file containing the certificate used for client authentication to the server. -

Type: null or (path)

Default: null

Declared by:

+

Type: null or path

Default: null

Declared by:

<home-manager/modules/programs/irssi.nix>
programs.irssi.networks.<name>.server.ssl.verify

Whether the SSL certificate should be verified.

Type: boolean

Default: true

Declared by:

<home-manager/modules/programs/irssi.nix> @@ -5189,7 +5189,7 @@ pipe through less. Setting to null will not bind any key. <home-manager/modules/programs/lf.nix>
programs.lf.previewer.source

Script or executable to use to preview files. Sets lf's previewer option. -

Type: null or (path)

Default: null

Example:

pkgs.writeShellScript "pv.sh" ''
+

Type: null or path

Default: null

Example:

pkgs.writeShellScript "pv.sh" ''
   #!/bin/sh
 
   case "$1" in
@@ -5459,7 +5459,7 @@ MangoHud is started on any application that supports it.
 $XDG_CONFIG_HOME/MangoHud/MangoHud.conf. See
 https://github.com/flightlessmango/MangoHud/blob/master/data/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 string))

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: { } @@ -5474,7 +5474,7 @@ Configuration written to $XDG_CONFIG_HOME/MangoHud/{application_name}.conf. See https://github.com/flightlessmango/MangoHud/blob/master/data/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 string))

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: { } @@ -5755,7 +5755,7 @@ for more information. value of services.mpd.musicDirectory is used as the default if services.mpd.enable is true. -

Type: null or (path)

Default:

if pkgs.stdenv.hostPlatform.isLinux && config.services.mpd.enable then
+

Type: null or path

Default:

if pkgs.stdenv.hostPlatform.isLinux && config.services.mpd.enable then
   config.services.mpd.musicDirectory
 else
   null
@@ -6161,7 +6161,7 @@ this happens, this will no longer be an issue.
 

Declared by:

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

Path to the plugin folder. -

Type: null or (path)

Default: null

Example:

(pkgs.fetchFromGitHub {
+

Type: null or path

Default: null

Example:

(pkgs.fetchFromGitHub {
   owner = "jarun";
   repo = "nnn";
   rev = "v4.0";
@@ -6277,7 +6277,7 @@ See Declared by:

<home-manager/modules/programs/nushell.nix>
programs.nushell.configFile.source

Path of the nushell config.nu file to use. -

Type: null or (path)

Default: file containing text

Declared by:

+

Type: null or path

Default: file containing text

Declared by:

<home-manager/modules/programs/nushell.nix>
programs.nushell.configFile.text

Text of the nushell config.nu file. If unset then the source option will be preferred. @@ -6291,7 +6291,7 @@ let-env FOO = 'BAR' ''

Declared by:

<home-manager/modules/programs/nushell.nix>
programs.nushell.envFile.source

Path of the nushell env.nu file to use. -

Type: null or (path)

Default: file containing text

Declared by:

+

Type: null or path

Default: file containing text

Declared by:

<home-manager/modules/programs/nushell.nix>
programs.nushell.envFile.text

Text of the nushell env.nu file. If unset then the source option will be preferred. @@ -6412,7 +6412,7 @@ is essentially a configuration file, this option is not used when a <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 (path)

Default: +

programs.pandoc.citationStyles

List of .csl files to install.

Type: list of path

Default: [ ] @@ -6438,7 +6438,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 (path)

Default: +

programs.pandoc.templates

Custom templates.

Type: attribute set of path

Default: { } @@ -6932,7 +6932,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 string)))) or string)

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.:
   # {
@@ -7231,7 +7231,7 @@ CTRL-T keybinding.
                     <home-manager/modules/programs/sm64ex.nix>
                 
programs.sm64ex.package

The sm64ex package to use.

Type: package

Default: (build of sm64ex-0.pre+date=2021-11-30)

Declared by:

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

The path to the Super Mario 64 baserom to extract assets from.

Type: null or (path)

Default: null

Example: /home/foo/baserom.us.z64

Declared by:

+
programs.sm64ex.baserom

The path to the Super Mario 64 baserom to extract assets from.

Type: null or path

Default: null

Example: /home/foo/baserom.us.z64

Declared by:

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

Extra flags to pass to the compiler. See https://github.com/sm64pc/sm64ex/wiki/Build-options @@ -7573,7 +7573,7 @@ disables configuration generation. <home-manager/modules/programs/taskwarrior.nix>

programs.taskwarrior.colorTheme

Either one of the default provided theme as string, or a path to a theme configuration file. -

Type: null or string or (path)

Default: null

Example: "dark-blue-256"

Declared by:

+

Type: null or string or path

Default: null

Example: "dark-blue-256"

Declared by:

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

Key-value configuration written to $XDG_CONFIG_HOME/task/taskrc. @@ -8081,7 +8081,7 @@ manually set any options not listed above.

Type: boolean

Default: true

Declared by:

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

Version of Visual Studio Code to install. -

Type: package

Default: (build of vscode-1.73.0)

Example: pkgs.vscodium

Declared by:

+

Type: package

Default: (build of vscode-1.73.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 package

Default: @@ -8252,7 +8252,7 @@ See

If the value is set to a path literal, then the path will be used as the css file. -

Type: null or (path) or string

Default: null

Example:

''
+

Type: null or path or string

Default: null

Example:

''
 * {
   border: none;
   border-radius: 0;
@@ -8763,7 +8763,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 (path)

Default: +

programs.zsh.prezto.pmoduleDirs

Add additional directories to load prezto modules from

Type: list of path

Default: [ ] @@ -9045,7 +9045,7 @@ written to $XDG_CONFIG_HOME/dunst/dunstrc regardless. This allows using a mutable configuration file generated from the immutable one, useful in scenarios where live reloading is desired. -

Type: string or (path)

Default: "$XDG_CONFIG_HOME/dunst/dunstrc"

Declared by:

+

Type: string or path

Default: "$XDG_CONFIG_HOME/dunst/dunstrc"

Declared by:

<home-manager/modules/services/dunst.nix>
services.dunst.iconTheme

Set the icon theme.

Type: submodule

Default: { @@ -9270,7 +9270,7 @@ The configuration specified under written to $XDG_CONFIG_HOME/fnott/fnott.ini regardless of this option. This allows using a mutable configuration file generated from the immutable one, useful in scenarios where live reloading is desired. -

Type: string or (path)

Default: "$XDG_CONFIG_HOME/fnott/fnott.ini"

Declared by:

+

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 string

Default: @@ -9805,7 +9805,7 @@ space. <home-manager/modules/services/mbsync.nix>

services.mbsync.configFile

Optional configuration file to link to use instead of the default file (~/.mbsyncrc). -

Type: null or (path)

Default: null

Declared by:

+

Type: null or path

Default: null

Declared by:

<home-manager/modules/services/mbsync.nix>
services.mbsync.frequency

How often to run mbsync. This value is passed to the systemd timer configuration as the onCalendar option. See @@ -9836,7 +9836,7 @@ useful for creating the directories mbsync is going to use.

services.mopidy.extraConfigFiles

Extra configuration files read by Mopidy when the service starts. Later files in the list override earlier configuration files and structured settings. -

Type: list of (path)

Default: +

Type: list of path

Default: [ ] @@ -9903,7 +9903,7 @@ beginning of the file. For available options see If xdg.userDirs.enable is true then the defined XDG music directory is used. Otherwise, you must explicitly specify a value. -

Type: (path) or string

Default:

${home.homeDirectory}/music    if state version < 22.11
+

Type: path or string

Default:

${home.homeDirectory}/music    if state version < 22.11
 ${xdg.userDirs.music}          if xdg.userDirs.enable == true
 undefined                      otherwise
 

Declared by:

@@ -9947,7 +9947,7 @@ For available options see services.mpdris2.mpd.host

The address where MPD is listening for connections.

Type: string

Default: "config.services.mpd.network.listenAddress"

Example: "192.168.1.1"

Declared by:

<home-manager/modules/services/mpdris2.nix>
services.mpdris2.mpd.musicDirectory

If set, mpDris2 will use this directory to access music artwork. -

Type: null or (path)

Default: "config.services.mpd.musicDirectory"

Declared by:

+

Type: null or path

Default: "config.services.mpd.musicDirectory"

Declared by:

<home-manager/modules/services/mpdris2.nix>
services.mpdris2.mpd.password

The password to connect to MPD.

Type: null or string

Default: null

Declared by:

@@ -10274,7 +10274,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 string)) 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: { } @@ -10758,11 +10758,11 @@ for details. <home-manager/modules/services/twmn.nix>

services.twmn.host

Host address to listen on for notifications.

Type: string

Default: "127.0.0.1"

Example: "laptop.lan"

Declared by:

<home-manager/modules/services/twmn.nix> -
services.twmn.icons.critical

Path to the critical notifications' icon.

Type: null or (path)

Default: null

Declared by:

+
services.twmn.icons.critical

Path to the critical notifications' icon.

Type: null or path

Default: null

Declared by:

<home-manager/modules/services/twmn.nix> -
services.twmn.icons.info

Path to the informative notifications' icon.

Type: null or (path)

Default: null

Declared by:

+
services.twmn.icons.info

Path to the informative notifications' icon.

Type: null or path

Default: null

Declared by:

<home-manager/modules/services/twmn.nix> -
services.twmn.icons.warning

Path to the warning notifications' icon.

Type: null or (path)

Default: null

Declared by:

+
services.twmn.icons.warning

Path to the warning notifications' icon.

Type: null or path

Default: null

Declared by:

<home-manager/modules/services/twmn.nix>
services.twmn.port

UDP port to listen on for notifications.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 9797

Declared by:

<home-manager/modules/services/twmn.nix> @@ -12365,7 +12365,7 @@ See xdg.desktopEntries.<name>.actions.<name>.exec

Program to execute, possibly with arguments.

Type: null or string

Declared by:

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

Icon to display in file manager, menus, etc.

Type: null or string or (path)

Default: null

Declared by:

+
xdg.desktopEntries.<name>.actions.<name>.icon

Icon to display in file manager, menus, etc.

Type: null or string or path

Default: null

Declared by:

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

Name of the action.

Type: string

Default: <name>

Declared by:

<home-manager/modules/misc/xdg-desktop-entries.nix> @@ -12377,7 +12377,7 @@ See xdg.desktopEntries.<name>.genericName

Generic name of the application.

Type: null or string

Default: null

Declared by:

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

Icon to display in file manager, menus, etc.

Type: null or string or (path)

Default: null

Declared by:

+
xdg.desktopEntries.<name>.icon

Icon to display in file manager, menus, etc.

Type: null or string or path

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 string)

Default: null

Declared by:

<home-manager/modules/misc/xdg-desktop-entries.nix> @@ -12491,26 +12491,26 @@ The generated file is read-only. <home-manager/modules/misc/xdg-user-dirs.nix>
xdg.userDirs.createDirectories

Whether to enable automatic creation of the XDG user directories.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix> -
xdg.userDirs.desktop

The Desktop directory.

Type: string or (path) convertible to it

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

Declared by:

+
xdg.userDirs.desktop

The Desktop directory.

Type: string or path convertible to it

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

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix> -
xdg.userDirs.documents

The Documents directory.

Type: string or (path) convertible to it

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

Declared by:

+
xdg.userDirs.documents

The Documents directory.

Type: string or path convertible to it

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

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix> -
xdg.userDirs.download

The Downloads directory.

Type: string or (path) convertible to it

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

Declared by:

+
xdg.userDirs.download

The Downloads directory.

Type: string or path convertible to it

Default: "${config.home.homeDirectory}/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 it)

Default: { }

Example:

{
+                
xdg.userDirs.extraConfig

Other user directories.

Type: attribute set of (string or path convertible to it)

Default: { }

Example:

{
   XDG_MISC_DIR = "${config.home.homeDirectory}/Misc";
 }
 

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix> -
xdg.userDirs.music

The Music directory.

Type: string or (path) convertible to it

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

Declared by:

+
xdg.userDirs.music

The Music directory.

Type: string or path convertible to it

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

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix> -
xdg.userDirs.pictures

The Pictures directory.

Type: string or (path) convertible to it

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

Declared by:

+
xdg.userDirs.pictures

The Pictures directory.

Type: string or path convertible to it

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

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix> -
xdg.userDirs.publicShare

The Public share directory.

Type: string or (path) convertible to it

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

Declared by:

+
xdg.userDirs.publicShare

The Public share directory.

Type: string or path convertible to it

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

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix> -
xdg.userDirs.templates

The Templates directory.

Type: string or (path) convertible to it

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

Declared by:

+
xdg.userDirs.templates

The Templates directory.

Type: string or path convertible to it

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

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix> -
xdg.userDirs.videos

The Videos directory.

Type: string or (path) convertible to it

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

Declared by:

+
xdg.userDirs.videos

The Videos directory.

Type: string or path convertible to it

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

Declared by:

<home-manager/modules/misc/xdg-user-dirs.nix>
xfconf.settings

Settings to write to the Xfconf configuration system.

Type: xfconf settings

Default: @@ -13342,7 +13342,7 @@ by Home Manager. If this option is set to a non-null value, recompilation of xmonad outside of Home Manager (e.g. via xmonad --recompile) will fail. -

Type: null or (path)

Default: null

Example:

pkgs.writeText "xmonad.hs" ''
+

Type: null or path

Default: null

Example:

pkgs.writeText "xmonad.hs" ''
   import XMonad
   main = xmonad defaultConfig
       { terminal    = "urxvt"
@@ -13372,7 +13372,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 (path)

Default: +

Type: attribute set of path

Default: { } diff --git a/tools.html b/tools.html index 8ee96d993..5c10f70e5 100644 --- a/tools.html +++ b/tools.html @@ -1,6 +1,6 @@ -Appendix D. Tools

Appendix D. Tools

home-manager - — reconfigure a user environment

Name

home-manager +Appendix D. Tools

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)

\ No newline at end of file