diff --git a/index.html b/index.html index 54df8e04f..74dc55061 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. Writing Home Manager Modules
2.1. Option Types
3. Contributing
3.1. Getting started
3.2. Guidelines
3.2.1. Maintain backward compatibility
3.2.2. Keep forward compatibility in mind
3.2.3. Add only valuable options
3.2.4. Add relevant tests
3.2.5. Add relevant documentation
3.2.6. Add yourself as a module maintainer
3.2.7. Format your code
3.2.8. Format your commit messages
3.2.9. Format your news entries
3.2.10. Use conditional modules and news
3.2.11. Mind the license
3.3. Commits
3.4. Code Style
3.5. News
3.6. Tests
4. Frequently Asked Questions (FAQ)
4.1. Why is there a collision error when switching generation?
4.2. Why are the session variables not set?
4.3. How to set up a configuration for multiple users/machines?
4.4. Why do I get an error message about ca.desrt.dconf?
4.5. How do I install packages from Nixpkgs unstable?
4.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 21.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.09
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.03
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. 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. Writing Home Manager Modules
2.1. Option Types
3. Contributing
3.1. Getting started
3.2. Guidelines
3.2.1. Maintain backward compatibility
3.2.2. Keep forward compatibility in mind
3.2.3. Add only valuable options
3.2.4. Add relevant tests
3.2.5. Add relevant documentation
3.2.6. Add yourself as a module maintainer
3.2.7. Format your code
3.2.8. Format your commit messages
3.2.9. Format your news entries
3.2.10. Use conditional modules and news
3.2.11. Mind the license
3.3. Commits
3.4. Code Style
3.5. News
3.6. Tests
4. Frequently Asked Questions (FAQ)
4.1. Why is there a collision error when switching generation?
4.2. Why are the session variables not set?
4.3. How to set up a configuration for multiple users/machines?
4.4. Why do I get an error message about ca.desrt.dconf?
4.5. How do I install packages from Nixpkgs unstable?
4.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 21.11
E.1.1. Highlights
E.1.2. State Version Changes
E.2. Release 21.05
E.2.1. Highlights
E.2.2. State Version Changes
E.3. Release 20.09
E.3.1. Highlights
E.3.2. State Version Changes
E.4. Release 20.03
E.4.1. Highlights
E.4.2. State Version Changes
E.5. Release 19.09
E.5.1. Highlights
E.5.2. State Version Changes
E.6. Release 19.03
E.6.1. Highlights
E.6.2. State Version Changes
E.7. Release 18.09

Preface

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

diff --git a/options.html b/options.html index 00ff18af1..2806cf279 100644 --- a/options.html +++ b/options.html @@ -3596,233 +3596,14 @@ attempted. false

Example: true -

Declared by:

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

Deprecated. Please use programs.htop.settings.enable_mouse instead. - -Enable mouse support. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.account_guest_in_cpu_meter instead. - -Add guest time in CPU meter percentage. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.color_scheme instead. - -Which color scheme to use. -

Type: null or one of 0, 1, 2, 3, 4, 5, 6

Default: - null -

Example: - 6 -

Declared by:

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

Deprecated. Please use programs.htop.settings.cpu_count_from_zero instead. - -Count CPUs from 0 instead of 1. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.delay instead. - -Set the delay between updates, in tenths of seconds. -

Type: null or signed integer

Default: - null -

Example: - 2 -

Declared by:

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

Deprecated. Please use programs.htop.settings.detailed_cpu_time instead. - -Detailed CPU time (System/IO-Wait/Hard-IRQ/Soft-IRQ/Steal/Guest). -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.fields instead. - -Active fields shown in the table. -

Type: null or list of one of "CGROUP", "CMAJFLT", "CMINFLT", "CNCLWB", "COMM", "CSTIME", "CTID", "CUTIME", "IO_PRIORITY", "IO_RATE", "IO_READ_RATE", "IO_WRITE_RATE", "MAJFLT", "MINFLT", "M_DRS", "M_DT", "M_LRS", "M_PSS", "M_PSSWP", "M_RESIDENT", "M_SHARE", "M_SIZE", "M_SWAP", "M_TRS", "NICE", "NLWP", "OOM", "PERCENT_CPU", "PERCENT_MEM", "PGRP", "PID", "PPID", "PRIORITY", "PROCESSOR", "RBYTES", "RCHAR", "SESSION", "STARTTIME", "STATE", "STIME", "ST_UID", "SYSCR", "SYSCW", "TGID", "TIME", "TPGID", "TTY_NR", "USER", "UTIME", "VPID", "VXID", "WBYTES", "WCHAR"s

Default: - null -

Example: - - [ - "PID" "USER" "PRIORITY" "PERCENT_CPU" "M_RESIDENT" "PERCENT_MEM" "TIME" "COMM" - ] - -

Declared by:

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

Deprecated. Please use programs.htop.settings.header_margin instead. - -Leave a margin around header. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.hide_kernel_threads instead. - -Hide kernel threads. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.hide_threads instead. - -Hide threads. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.hide_userland_threads instead. - -Hide userland process threads. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.highlight_base_name instead. - -Highlight program basename. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.highlight_megabytes instead. - -Highlight large numbers in memory counters. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.highlight_threads instead. - -Display threads in a different color. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.left_meters, -programs.htop.settings.left_meter_modes, -programs.htop.settings.right_meters and -programs.htop.settings.right_meter_modes instead. Or consider using -lib.htop.leftMeters and lib.htop.rightMeters. - -Meters shown in the header. -

Type: null or submodule

Default: - null -

Example: - - { - left = - [ - "Memory" "CPU" "LeftCPUs2" "RightCPUs2" - { - kind = "CPU"; mode = 3; - } - - ] - ; right = - [ - - { - kind = "Clock"; mode = 4; - } - "Uptime" "Tasks" "LoadAverage" - { - kind = "Battery"; mode = 1; - } - - ] - ; - } - -

Declared by:

- <home-manager/modules/programs/htop.nix> -
programs.htop.meters.left

Meters shown in the left header.

Type: list of submodule or one of "AllCPUs", "AllCPUs2", "AllCPUs4", "AllCPUs8", "Battery", "Blank", "CPU", "CPU(1)", "CPU(2)", "CPU(3)", "CPU(4)", "CPU(5)", "CPU(6)", "CPU(7)", "CPU(8)", "CPUs", "Clock", "Date", "DateTime", "DiskIO", "Hostname", "HugePages", "LeftCPUs", "LeftCPUs2", "LeftCPUs4", "LeftCPUs8", "Load", "LoadAverage", "Memory", "NetworkIO", "PressureStallCPUSome", "PressureStallIOFull", "PressureStallIOSome", "PressureStallMemoryFull", "PressureStallMemorySome", "Right", "RightCPUs", "RightCPUs2", "RightCPUs4", "RightCPUs8", "SELinux", "Swap", "Systemd", "Tasks", "Uptime", "ZFSARC", "ZFSCARC", "Zram" convertible to its

Default: - - [ - "AllCPUs" "Memory" "Swap" - ] - -

Example: - - [ - "Memory" "LeftCPUs2" "RightCPUs2" - { - kind = "CPU"; mode = 3; - } - - ] - -

Declared by:

- <home-manager/modules/programs/htop.nix> -
programs.htop.meters.left.*.kind

What kind of meter.

Type: one of "AllCPUs", "AllCPUs2", "AllCPUs4", "AllCPUs8", "Battery", "Blank", "CPU", "CPU(1)", "CPU(2)", "CPU(3)", "CPU(4)", "CPU(5)", "CPU(6)", "CPU(7)", "CPU(8)", "CPUs", "Clock", "Date", "DateTime", "DiskIO", "Hostname", "HugePages", "LeftCPUs", "LeftCPUs2", "LeftCPUs4", "LeftCPUs8", "Load", "LoadAverage", "Memory", "NetworkIO", "PressureStallCPUSome", "PressureStallIOFull", "PressureStallIOSome", "PressureStallMemoryFull", "PressureStallMemorySome", "Right", "RightCPUs", "RightCPUs2", "RightCPUs4", "RightCPUs8", "SELinux", "Swap", "Systemd", "Tasks", "Uptime", "ZFSARC", "ZFSCARC", "Zram"

Example: - "AllCPUs" -

Declared by:

- <home-manager/modules/programs/htop.nix> -
programs.htop.meters.left.*.mode

Which mode the meter should use, one of 1(Bar) 2(Text) 3(Graph) 4(LED).

Type: one of 1, 2, 3, 4

Example: - 2 -

Declared by:

- <home-manager/modules/programs/htop.nix> -
programs.htop.meters.right

Meters shown in the right header.

Type: list of submodule or one of "AllCPUs", "AllCPUs2", "AllCPUs4", "AllCPUs8", "Battery", "Blank", "CPU", "CPU(1)", "CPU(2)", "CPU(3)", "CPU(4)", "CPU(5)", "CPU(6)", "CPU(7)", "CPU(8)", "CPUs", "Clock", "Date", "DateTime", "DiskIO", "Hostname", "HugePages", "LeftCPUs", "LeftCPUs2", "LeftCPUs4", "LeftCPUs8", "Load", "LoadAverage", "Memory", "NetworkIO", "PressureStallCPUSome", "PressureStallIOFull", "PressureStallIOSome", "PressureStallMemoryFull", "PressureStallMemorySome", "Right", "RightCPUs", "RightCPUs2", "RightCPUs4", "RightCPUs8", "SELinux", "Swap", "Systemd", "Tasks", "Uptime", "ZFSARC", "ZFSCARC", "Zram" convertible to its

Default: - - [ - "Tasks" "LoadAverage" "Uptime" - ] - -

Example: - - [ - - { - kind = "Clock"; mode = 4; - } - "Uptime" "Tasks" - ] - -

Declared by:

- <home-manager/modules/programs/htop.nix> -
programs.htop.meters.right.*.kind

What kind of meter.

Type: one of "AllCPUs", "AllCPUs2", "AllCPUs4", "AllCPUs8", "Battery", "Blank", "CPU", "CPU(1)", "CPU(2)", "CPU(3)", "CPU(4)", "CPU(5)", "CPU(6)", "CPU(7)", "CPU(8)", "CPUs", "Clock", "Date", "DateTime", "DiskIO", "Hostname", "HugePages", "LeftCPUs", "LeftCPUs2", "LeftCPUs4", "LeftCPUs8", "Load", "LoadAverage", "Memory", "NetworkIO", "PressureStallCPUSome", "PressureStallIOFull", "PressureStallIOSome", "PressureStallMemoryFull", "PressureStallMemorySome", "Right", "RightCPUs", "RightCPUs2", "RightCPUs4", "RightCPUs8", "SELinux", "Swap", "Systemd", "Tasks", "Uptime", "ZFSARC", "ZFSCARC", "Zram"

Example: - "AllCPUs" -

Declared by:

- <home-manager/modules/programs/htop.nix> -
programs.htop.meters.right.*.mode

Which mode the meter should use, one of 1(Bar) 2(Text) 3(Graph) 4(LED).

Type: one of 1, 2, 3, 4

Example: - 2

Declared by:

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

Configuration options to add to ~/.config/htop/htoprc. - -This superseedes any other (deprecated) settings in this module.

Type: attribute set

Default: { - account_guest_in_cpu_meter = false; color_scheme = 0; cpu_count_from_zero = false; delay = 15; detailed_cpu_time = false; enable_mouse = true; fields = - [ - 0 48 17 18 38 39 40 2 46 47 49 1 - ] - ; header_margin = true; hide_kernel_threads = true; hide_threads = false; hide_userland_threads = false; highlight_base_name = false; highlight_megabytes = true; highlight_threads = true; left_meter_modes = - [ - 1 1 1 2 - ] - ; left_meters = - [ - "AllCPUs2" "Memory" "Swap" "Zram" - ] - ; right_meter_modes = - [ - 2 2 2 2 - ] - ; right_meters = - [ - "Tasks" "LoadAverage" "Uptime" "Systemd" - ] - ; shadow_other_users = false; show_cpu_frequency = false; show_cpu_usage = false; show_program_path = true; show_thread_names = false; sort_direction = 1; sort_key = 46; tree_view = false; update_process_names = false; vim_mode = false; + }

Example:

{
@@ -3859,78 +3640,6 @@ This superseedes any other (deprecated) settings in this module.
 ]);
 

Declared by:

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

Deprecated. Please use programs.htop.settings.shadow_other_users instead. - -Shadow other users' processes. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.show_cpu_frequency instead. - -Show CPU frequency. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.show_cpu_usage instead. - -Show CPU usage frequency. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.show_program_path instead. - -Show program path. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.show_thread_names instead. - -Show custom thread names. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.sort_direction instead. - -Whether to sort descending or not. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.sort_key instead. - -Which field to use for sorting. -

Type: null or one of "CGROUP", "CMAJFLT", "CMINFLT", "CNCLWB", "COMM", "CSTIME", "CTID", "CUTIME", "IO_PRIORITY", "IO_RATE", "IO_READ_RATE", "IO_WRITE_RATE", "MAJFLT", "MINFLT", "M_DRS", "M_DT", "M_LRS", "M_PSS", "M_PSSWP", "M_RESIDENT", "M_SHARE", "M_SIZE", "M_SWAP", "M_TRS", "NICE", "NLWP", "OOM", "PERCENT_CPU", "PERCENT_MEM", "PGRP", "PID", "PPID", "PRIORITY", "PROCESSOR", "RBYTES", "RCHAR", "SESSION", "STARTTIME", "STATE", "STIME", "ST_UID", "SYSCR", "SYSCW", "TGID", "TIME", "TPGID", "TTY_NR", "USER", "UTIME", "VPID", "VXID", "WBYTES", "WCHAR"

Default: - null -

Example: - "TIME" -

Declared by:

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

Deprecated. Please use programs.htop.settings.tree_view instead. - -Tree view. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.update_process_names instead. - -Update process names on every refresh. -

Type: null or boolean

Default: - null -

Declared by:

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

Deprecated. Please use programs.htop.settings.vim_mode instead. - -Vim key bindings. -

Type: null or boolean

Default: - null -

Declared by:

- <home-manager/modules/programs/htop.nix>
programs.i3status.enable

Whether to enable i3status.

Type: boolean

Default: false

Example: @@ -6778,7 +6487,7 @@ services.dbus.packages = [ pkgs.gcr ];

For this reason, the default is gtk2 for now. -

Type: package or one of "curses", "tty", "gtk2", "qt", "emacs", "gnome3"

Default: +

Type: package or one of "curses", "tty", "gtk2", "emacs", "gnome3", "qt"

Default: "gtk2"

Example: "gnome3" @@ -10137,7 +9846,7 @@ services.dbus.packages = [ pkgs.gcr ];

For this reason, the default is gtk2 for now. -

Type: null or one of "curses", "tty", "gtk2", "qt", "emacs", "gnome3"

Default: +

Type: null or one of "curses", "tty", "gtk2", "emacs", "gnome3", "qt"

Default: "gtk2"

Example: "gnome3" diff --git a/tools.html b/tools.html index bacbafb71..6b80a2577 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 | @@ -80,7 +80,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.

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

-

Options

+

Options

The tool accepts the options

-A attrPath @@ -253,15 +253,15 @@ --verbose

Activates verbose output. -

Files

+

Files

~/.local/share/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