From 452b2ca05dda3afd812da7a2913a351956b270dc Mon Sep 17 00:00:00 2001 From: rycee Date: Fri, 10 Dec 2021 23:11:16 +0000 Subject: [PATCH] deploy: c7592b747b332eded1a1728e87abbc6e66b934f4 --- index.html | 4 ++-- options.html | 58 ++++++++++++++++++++++++++-------------------------- tools.html | 18 ++++++++-------- 3 files changed, 40 insertions(+), 40 deletions(-) diff --git a/index.html b/index.html index 557b1844..176319a2 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,6 @@ -Home Manager Manual
Home Manager Manual
   Next

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
3. Writing Home Manager Modules
3.1. Option Types
4. Contributing
4.1. Getting started
4.2. Guidelines
4.2.1. Maintain backward compatibility
4.2.2. Keep forward compatibility in mind
4.2.3. Add only valuable options
4.2.4. Add relevant tests
4.2.5. Add relevant documentation
4.2.6. Add yourself as a module maintainer
4.2.7. Format your code
4.2.8. Format your commit messages
4.2.9. Format your news entries
4.2.10. Use conditional modules and news
4.2.11. Mind the license
4.3. Commits
4.4. Code Style
4.5. News
4.6. Tests
5. Frequently Asked Questions (FAQ)
5.1. Why is there a collision error when switching generation?
5.2. Why are the session variables not set?
5.3. How to set up a configuration for multiple users/machines?
5.4. Why do I get an error message about ca.desrt.dconf?
5.5. How do I install packages from Nixpkgs unstable?
5.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.05
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.11
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.05
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.09
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.03
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.09
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.03
E.7.1. Highlights
E.7.2. State Version Changes
E.8. Release 18.09

Preface

+Home Manager Manual

Home Manager Manual
   Next

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
3. Writing Home Manager Modules
3.1. Option Types
4. Contributing
4.1. Getting started
4.2. Guidelines
4.2.1. Maintain backward compatibility
4.2.2. Keep forward compatibility in mind
4.2.3. Add only valuable options
4.2.4. Add relevant tests
4.2.5. Add relevant documentation
4.2.6. Add yourself as a module maintainer
4.2.7. Format your code
4.2.8. Format your commit messages
4.2.9. Format your news entries
4.2.10. Use conditional modules and news
4.2.11. Mind the license
4.3. Commits
4.4. Code Style
4.5. News
4.6. Tests
5. Frequently Asked Questions (FAQ)
5.1. Why is there a collision error when switching generation?
5.2. Why are the session variables not set?
5.3. How to set up a configuration for multiple users/machines?
5.4. Why do I get an error message about ca.desrt.dconf?
5.5. How do I install packages from Nixpkgs unstable?
5.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.05
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.11
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 21.05
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.09
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 20.03
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.09
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 19.03
E.7.1. Highlights
E.7.2. State Version Changes
E.8. 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 c9af1e95..642e3323 100644 --- a/options.html +++ b/options.html @@ -674,7 +674,7 @@ is assumed to already be available in your profile.

Declared by:

<home-manager/modules/misc/gtk.nix>
gtk.gtk3.extraConfig

Extra configuration options to add to -~/.config/gtk-3.0/settings.ini. +$XDG_CONFIG_HOME/gtk-3.0/settings.ini.

Type: attribute set of boolean or signed integer or strings

Default: { @@ -686,7 +686,7 @@ is assumed to already be available in your profile.

Declared by:

<home-manager/modules/misc/gtk.nix>
gtk.gtk3.extraCss

Extra configuration lines to add verbatim to -~/.config/gtk-3.0/gtk.css. +$XDG_CONFIG_HOME/gtk-3.0/gtk.css.

Type: strings concatenated with "\n"

Default: ""

Declared by:

<home-manager/modules/misc/gtk.nix>
gtk.iconTheme

The icon theme to use.

Type: null or submodule

Default: null

Declared by:

@@ -1238,7 +1238,7 @@ message = Message from above
programs.alacritty.package

The Alacritty package to install.

Type: package

Default: pkgs.alacritty

Declared by:

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

Configuration written to -~/.config/alacritty/alacritty.yml. See +$XDG_CONFIG_HOME/alacritty/alacritty.yml. See https://github.com/jwilm/alacritty/blob/master/alacritty.yml for the default configuration.

Type: YAML value

Default: @@ -1406,7 +1406,7 @@ key to open the Atuin history.

programs.atuin.package

The package to use for atuin.

Type: package

Default: pkgs.atuin

Declared by:

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

Configuration written to -~/.config/atuin/config.toml. +$XDG_CONFIG_HOME/atuin/config.toml.

See https://github.com/ellie/atuin/blob/main/docs/config.md for the full list of options. @@ -1714,7 +1714,7 @@ Can be used to specify extensions.

Type: package

Default: pkgs.beets

Example: (pkgs.beets.override { enableCheck = true; })

Declared by:

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

Configuration written to -~/.config/beets/config.yaml +$XDG_CONFIG_HOME/beets/config.yaml

Type: YAML value

Default: { @@ -1941,7 +1941,7 @@ automatically gets loaded in Fish.

Type: boolean

Default: true

Declared by:

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

Configuration written to -~/.config/direnv/config.toml. +$XDG_CONFIG_HOME/direnv/config.toml.

See direnv.toml(1). @@ -1956,7 +1956,7 @@ for the full list of options. a fast, persistent use_nix implementation for direnv.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/direnv.nix>
programs.direnv.stdlib

Custom stdlib written to -~/.config/direnv/direnvrc. +$XDG_CONFIG_HOME/direnv/direnvrc.

Type: strings concatenated with "\n"

Default: ""

Declared by:

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

Whether to enable Eclipse.

Type: boolean

Default: false

Example: true

Declared by:

@@ -2783,7 +2783,7 @@ Note that lists are converted to duplicate keys. <home-manager/modules/programs/gpg.nix>
programs.hexchat.enable

Whether to enable HexChat, a graphical IRC client.

Type: boolean

Default: false

Example: true

Declared by:

<home-manager/modules/programs/hexchat.nix> -
programs.hexchat.channels

Configures ~/.config/hexchat/servlist.conf. +

programs.hexchat.channels

Configures $XDG_CONFIG_HOME/hexchat/servlist.conf.

Type: attribute set of submodules

Default: { @@ -2907,7 +2907,7 @@ configuration files, causing:

Type: null or boolean

Default: false

Declared by:

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

Configuration for ~/.config/hexchat/hexchat.conf, see +

programs.hexchat.settings

Configuration for $XDG_CONFIG_HOME/hexchat/hexchat.conf, see https://hexchat.readthedocs.io/en/latest/settings.html#list-of-settings for supported values.

Type: null or attribute set of strings

Default: null

Example: 

{
@@ -2957,7 +2957,7 @@ attempted.
programs.htop.package

Package containing the htop program.

Type: package

Default: pkgs.htop

Declared by:

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

Configuration options to add to -~/.config/htop/htoprc. +$XDG_CONFIG_HOME/htop/htoprc.

Type: attribute set

Default: { @@ -3539,7 +3539,7 @@ the marker text will be displayed in the indentation if possible.

Type: boolean

Default: false

Declared by:

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

Extra configuration lines to add to -~/.config/kak/kakrc. +$XDG_CONFIG_HOME/kak/kakrc.

Type: strings concatenated with "\n"

Default: ""

Declared by:

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

List of kakoune plugins to install. To get a list of @@ -3636,7 +3636,7 @@ is assumed to already be available in your profile.

Declared by:

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

Configuration written to -~/.config/kitty/kitty.conf. See +$XDG_CONFIG_HOME/kitty/kitty.conf. See https://sw.kovidgoyal.net/kitty/conf.html for the documentation.

Type: attribute set of string or boolean or signed integers

Default: @@ -3653,7 +3653,7 @@ for the documentation.

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.settings

Configuration written to -~/.config/lazygit/config.yml on Linux +$XDG_CONFIG_HOME/lazygit/config.yml on Linux or ~/Library/Application Support/lazygit/config.yml on Darwin. See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md for supported values. @@ -3765,7 +3765,7 @@ All string options are quoted with double quotes.

Type: boolean

Default: false

Declared by:

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

Configuration written to -~/.config/lsd/config.yaml. See +$XDG_CONFIG_HOME/lsd/config.yaml. See https://github.com/Peltoche/lsd#config-file-content for supported values.

Type: YAML value

Default: @@ -3934,7 +3934,7 @@ MangoHud is started on any application that supports it.

programs.mangohud.package

The Mangohud package to install.

Type: package

Default: pkgs.mangohud

Declared by:

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

Configuration written to -~/.config/MangoHud/MangoHud.conf. See +$XDG_CONFIG_HOME/MangoHud/MangoHud.conf. See https://github.com/flightlessmango/MangoHud/blob/master/bin/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 stringss

Default: @@ -3949,7 +3949,7 @@ for the default configuration. <home-manager/modules/programs/mangohud.nix>

programs.mangohud.settingsPerApplication

Sets MangoHud settings per application. Configuration written to -~/.config/MangoHud/{application_name}.conf. See +$XDG_CONFIG_HOME/MangoHud/{application_name}.conf. See https://github.com/flightlessmango/MangoHud/blob/master/bin/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 stringsss

Default: @@ -4072,7 +4072,7 @@ control the default matplotlib behavior.

Type: package

Default: (build of mpv-with-scripts-0.34.0)

Example: pkgs.wrapMpv (pkgs.mpv-unwrapped.override { vapoursynthSupport = true; }) { youtubeSupport = true; }

Declared by:

<home-manager/modules/programs/mpv.nix>
programs.mpv.bindings

Input configuration written to -~/.config/mpv/input.conf. See +$XDG_CONFIG_HOME/mpv/input.conf. See mpv(1) for the full list of options.

Type: attribute set of strings

Default: @@ -4087,7 +4087,7 @@ for the full list of options.

Declared by:

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

Configuration written to -~/.config/mpv/mpv.conf. See +$XDG_CONFIG_HOME/mpv/mpv.conf. See mpv(1) for the full list of options.

Type: attribute set of string or signed integer or boolean or floating point number or list of string or signed integer or boolean or floating point numberss

Default: @@ -4115,7 +4115,7 @@ by options set in

Declared by:

<home-manager/modules/programs/mpv.nix>
programs.mpv.profiles

Sub-configuration options for specific profiles written to -~/.config/mpv/mpv.conf. See +$XDG_CONFIG_HOME/mpv/mpv.conf. See programs.mpv.config for more information.

Type: attribute set of attribute set of string or signed integer or boolean or floating point number or list of string or signed integer or boolean or floating point numbersss

Default: { @@ -4205,7 +4205,7 @@ see

programs.ncspot.package

The package to use for ncspot.

Type: package

Default: pkgs.ncspot

Declared by:

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

Configuration written to -~/.config/ncspot/config.toml. +$XDG_CONFIG_HOME/ncspot/config.toml.

See https://github.com/hrkfdn/ncspot#configuration for the full list of options. @@ -4567,7 +4567,7 @@ use Python 3 plugins.

programs.noti.enable

Whether to enable Noti.

Type: boolean

Default: false

Example: true

Declared by:

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

Configuration written to -~/.config/noti/noti.yaml. +$XDG_CONFIG_HOME/noti/noti.yaml.

See noti.yaml(5). @@ -4659,7 +4659,7 @@ exclusion.

programs.nushell.package

The package to use for nushell.

Type: package

Default: pkgs.nushell

Declared by:

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

Configuration written to -~/.config/nushell/config.toml. +$XDG_CONFIG_HOME/nushell/config.toml.

See https://www.nushell.sh/book/configuration.html for the full list of options. @@ -5220,7 +5220,7 @@ in {

programs.rtorrent.enable

Whether to enable rTorrent.

Type: boolean

Default: false

Example: true

Declared by:

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

Configuration written to -~/.config/rtorrent/rtorrent.rc. See +$XDG_CONFIG_HOME/rtorrent/rtorrent.rc. See https://github.com/rakshasa/rtorrent/wiki/Config-Guide for explanation about possible values.

Type: strings concatenated with "\n"

Default: ""

Declared by:

@@ -5403,7 +5403,7 @@ for more information.
programs.sm64ex.region

Your baserom's region. Note that only "us", "eu", and "jp" are supported.

Type: null or one of "us", "eu", "jp"

Default: us

Example: jp

Declared by:

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

Settings for sm64ex's ~/.local/share/sm64pc/sm64config.txt file.

Type: null or attribute set of string or signed integer or boolean or list of stringss

Default: null

Example: 

{
+
programs.sm64ex.settings

Settings for sm64ex's $XDG_DATA_HOME/sm64pc/sm64config.txt file.

Type: null or attribute set of string or signed integer or boolean or list of stringss

Default: null

Example: 

{
   fullscreen = false;
   window_x = 0;
   window_y = 0;
@@ -5667,7 +5667,7 @@ database, separated by whitespace. The default is
programs.starship.package

The package to use for the starship binary.

Type: package

Default: pkgs.starship

Declared by:

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

Configuration written to -~/.config/starship.toml. +$XDG_CONFIG_HOME/starship.toml.

See https://starship.rs/config/ for the full list of options. @@ -5951,7 +5951,7 @@ is possible to override the sensible settings using the

programs.topgrade.package

The package to use for the topgrade binary.

Type: package

Default: pkgs.topgrade

Declared by:

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

Configuration written to -~/.config/topgrade.toml. +$XDG_CONFIG_HOME/topgrade.toml.

See https://github.com/r-darwish/topgrade/wiki/Step-list for the full list of options. @@ -6784,7 +6784,7 @@ but are substituted anywhere on a line.

gnome

Use GNOME theme with qgnomeplatform

-

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

Default: null

Example: "gnome"

Related packages:

  • pkgs.qgnomeplatform (qgnomeplatform-0.8.0): 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

Declared by:

+

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

Default: null

Example: "gnome"

Related packages:

  • pkgs.qgnomeplatform (qgnomeplatform-0.8.3): 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

Declared by:

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

Theme package to be used in Qt5 applications.

Type: null or package

Default: null

Example: pkgs.adwaita-qt

Declared by:

<home-manager/modules/misc/qt.nix> @@ -7271,7 +7271,7 @@ now.
services.grobi.executeAfter

Commands to be run after an output configuration was changed. The Nix value declared here will be translated to JSON and written to the execute_after key -in ~/.config/grobi.conf. +in $XDG_CONFIG_HOME/grobi.conf.

Type: list of strings

Default: [ @@ -7288,7 +7288,7 @@ the first matching rule is applied and processing stops. See https://github.com/fd0/grobi/blob/master/doc/grobi.conf for more information. The Nix value declared here will be translated to JSON and written to the rules -key in ~/.config/grobi.conf. +key in $XDG_CONFIG_HOME/grobi.conf.

Type: list of attribute set of string or boolean or signed integer or list of stringsss

Default: [ diff --git a/tools.html b/tools.html index 72da1e0e..59f2dc6e 100644 --- a/tools.html +++ b/tools.html @@ -1,6 +1,6 @@ -Appendix D. Tools

Appendix D. Tools
Prev   Next

Appendix D. Tools

home-manager - — reconfigure a user environment

Name

home-manager +Appendix D. Tools

Appendix D. Tools
Prev   Next

Appendix D. Tools

home-manager + — reconfigure a user environment

Name

home-manager — reconfigure a user environment

Synopsis

home-manager { build | @@ -82,7 +82,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.

@@ -151,7 +151,7 @@ available for immediate garbage collection.

-

Options

+

Options

The tool accepts the options

-A attrPath @@ -196,7 +196,7 @@ --file path

Indicates the path to the Home Manager configuration file. If not given, - ~/.config/nixpkgs/home.nix is used. + $XDG_CONFIG_HOME/nixpkgs/home.nix is used.

-h , @@ -259,15 +259,15 @@ --verbose

Activates verbose output. -

Files

- ~/.local/share/home-manager/news-read-ids +

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)

Prev   Next
Appendix C. nix-darwin Module Options Home Appendix E. Release Notes
\ No newline at end of file