ca.desrt.dconf?+
ca.desrt.dconf?This manual will eventually describes how to install, use, and extend Home Manager.
diff --git a/options.html b/options.html index e2e558db0..0c6ec061c 100644 --- a/options.html +++ b/options.html @@ -3422,40 +3422,57 @@ attempted. true
Declared by:
<home-manager/modules/programs/htop.nix>
- |
programs.htop.enableMouseEnable mouse support.
Type: boolean
Default:
- true
+
programs.htop.enableMouseDeprecated. 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.accountGuestInCpuMeterAdd guest time in CPU meter percentage.
Type: boolean
Default:
- false
+
programs.htop.accountGuestInCpuMeterDeprecated. 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.colorSchemeWhich color scheme to use.
Type: one of 0, 1, 2, 3, 4, 5, 6
Default:
- 0
+
programs.htop.colorSchemeDeprecated. 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.cpuCountFromZeroCount CPUs from 0 instead of 1.
Type: boolean
Default:
- false
+
programs.htop.cpuCountFromZeroDeprecated. 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.delaySet the delay between updates, in tenths of seconds.
Type: signed integer
Default:
- 15
+
programs.htop.delayDeprecated. 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.detailedCpuTimeDetailed CPU time (System/IO-Wait/Hard-IRQ/Soft-IRQ/Steal/Guest).
Type: boolean
Default:
- false
+
programs.htop.detailedCpuTimeDeprecated. 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.fieldsActive fields shown in the table.
Type: 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:
-
- [
- "PID" "USER" "PRIORITY" "NICE" "M_SIZE" "M_RESIDENT" "M_SHARE" "STATE" "PERCENT_CPU" "PERCENT_MEM" "TIME" "COMM"
- ]
-
+
programs.htop.fieldsDeprecated. 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:
[
@@ -3464,48 +3481,64 @@ attempted.
Declared by:
<home-manager/modules/programs/htop.nix>
- |
programs.htop.headerMarginLeave a margin around header.
Type: boolean
Default:
- true
+
programs.htop.headerMarginDeprecated. 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.hideKernelThreadsHide kernel threads.
Type: boolean
Default:
- true
+
programs.htop.hideKernelThreadsDeprecated. 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.hideThreadsHide threads.
Type: boolean
Default:
- false
+
programs.htop.hideThreadsDeprecated. 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.hideUserlandThreadsHide userland process threads.
Type: boolean
Default:
- false
+
programs.htop.hideUserlandThreadsDeprecated. 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.highlightBaseNameHighlight program “basename”.
Type: boolean
Default:
- false
+
programs.htop.highlightBaseNameDeprecated. 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.highlightMegabytesHighlight large numbers in memory counters.
Type: boolean
Default:
- true
+
programs.htop.highlightMegabytesDeprecated. 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.highlightThreadsDisplay threads in a different color.
Type: boolean
Default:
- true
+
programs.htop.highlightThreadsDeprecated. 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.metersMeters shown in the header.
Type: submodule
Default:
-
- {
- left =
- [
- "AllCPUs" "Memory" "Swap"
- ]
- ; right =
- [
- "Tasks" "LoadAverage" "Uptime"
- ]
- ;
- }
-
+
programs.htop.metersDeprecated. 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:
{
@@ -3534,7 +3567,7 @@ attempted.
Declared by:
<home-manager/modules/programs/htop.nix>
- |
programs.htop.meters.leftMeters shown in the left header.
Type: list of submodule or one of "AllCPUs", "AllCPUs2", "AllCPUs4", "Battery", "Blank", "CPU", "CPU(1)", "CPU(2)", "CPU(3)", "CPU(4)", "CPU(5)", "CPU(6)", "CPU(7)", "CPU(8)", "CPUs", "Clock", "Hostname", "LeftCPUs", "LeftCPUs2", "LeftCPUs4", "Load", "LoadAverage", "Memory", "PressureStallCPUSome", "PressureStallIOFull", "PressureStallIOSome", "PressureStallMemoryFull", "PressureStallMemorySome", "Right", "RightCPUs", "RightCPUs2", "RightCPUs4", "Swap", "Tasks", "Uptime", "ZFSARC", "ZFSCARC" convertible to its
Default:
+
programs.htop.meters.leftMeters 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"
@@ -3552,7 +3585,7 @@ attempted.
Declared by:
<home-manager/modules/programs/htop.nix>
- |
programs.htop.meters.left.*.kindWhat kind of meter.
Type: one of "AllCPUs", "AllCPUs2", "AllCPUs4", "Battery", "Blank", "CPU", "CPU(1)", "CPU(2)", "CPU(3)", "CPU(4)", "CPU(5)", "CPU(6)", "CPU(7)", "CPU(8)", "CPUs", "Clock", "Hostname", "LeftCPUs", "LeftCPUs2", "LeftCPUs4", "Load", "LoadAverage", "Memory", "PressureStallCPUSome", "PressureStallIOFull", "PressureStallIOSome", "PressureStallMemoryFull", "PressureStallMemorySome", "Right", "RightCPUs", "RightCPUs2", "RightCPUs4", "Swap", "Tasks", "Uptime", "ZFSARC", "ZFSCARC"
Example:
+
programs.htop.meters.left.*.kindWhat 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>
@@ -3560,7 +3593,7 @@ attempted.
2
Declared by:
programs.htop.meters.rightMeters shown in the right header. Type: list of submodule or one of "AllCPUs", "AllCPUs2", "AllCPUs4", "Battery", "Blank", "CPU", "CPU(1)", "CPU(2)", "CPU(3)", "CPU(4)", "CPU(5)", "CPU(6)", "CPU(7)", "CPU(8)", "CPUs", "Clock", "Hostname", "LeftCPUs", "LeftCPUs2", "LeftCPUs4", "Load", "LoadAverage", "Memory", "PressureStallCPUSome", "PressureStallIOFull", "PressureStallIOSome", "PressureStallMemoryFull", "PressureStallMemorySome", "Right", "RightCPUs", "RightCPUs2", "RightCPUs4", "Swap", "Tasks", "Uptime", "ZFSARC", "ZFSCARC" convertible to its Default: |
programs.htop.meters.rightMeters 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"
@@ -3578,7 +3611,7 @@ attempted.
Declared by:
<home-manager/modules/programs/htop.nix>
- |
programs.htop.meters.right.*.kindWhat kind of meter.
Type: one of "AllCPUs", "AllCPUs2", "AllCPUs4", "Battery", "Blank", "CPU", "CPU(1)", "CPU(2)", "CPU(3)", "CPU(4)", "CPU(5)", "CPU(6)", "CPU(7)", "CPU(8)", "CPUs", "Clock", "Hostname", "LeftCPUs", "LeftCPUs2", "LeftCPUs4", "Load", "LoadAverage", "Memory", "PressureStallCPUSome", "PressureStallIOFull", "PressureStallIOSome", "PressureStallMemoryFull", "PressureStallMemorySome", "Right", "RightCPUs", "RightCPUs2", "RightCPUs4", "Swap", "Tasks", "Uptime", "ZFSARC", "ZFSCARC"
Example:
+
programs.htop.meters.right.*.kindWhat 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>
@@ -3586,46 +3619,140 @@ attempted.
2
Declared by:
programs.htop.shadowOtherUsersShadow other users' processes. Type: boolean Default: |
programs.htop.settingsConfiguration 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
+ ]
+ ; left_meters =
+ [
+ "AllCPUs" "Memory" "Swap"
+ ]
+ ; right_meter_modes =
+ [
+ 2 2 2
+ ]
+ ; right_meters =
+ [
+ "LoadAverage" "Tasks" "Uptime"
+ ]
+ ; 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:
{
+ color_scheme = 6;
+ cpu_count_from_one = 0;
+ delay = 15;
+ fields = with config.lib.htop.fields; [
+ PID
+ USER
+ PRIORITY
+ NICE
+ M_SIZE
+ M_RESIDENT
+ M_SHARE
+ STATE
+ PERCENT_CPU
+ PERCENT_MEM
+ TIME
+ COMM
+ ];
+ highlight_base_name = 1;
+ highlight_megabytes = 1;
+ highlight_threads = 1;
+} // (with config.lib.htop; leftMeters {
+ AllCPUs2 = modes.Bar;
+ Memory = modes.Bar;
+ Swap = modes.Bar;
+ Zram = modes.Text;
+}) // (with config.lib.htop; rightMeters {
+ Tasks = modes.Text;
+ LoadAverage = modes.Text;
+ Uptime = modes.Text;
+ Systemd = modes.Text;
+})
+Declared by:
+ <home-manager/modules/programs/htop.nix>
+ |
programs.htop.shadowOtherUsersDeprecated. 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.showCpuFrequencyShow CPU frequency.
Type: boolean
Default:
- false
+
programs.htop.showCpuFrequencyDeprecated. 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.showCpuUsageShow CPU usage frequency.
Type: boolean
Default:
- false
+
programs.htop.showCpuUsageDeprecated. 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.showProgramPathShow program path.
Type: boolean
Default:
- true
+
programs.htop.showProgramPathDeprecated. 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.showThreadNamesShow custom thread names.
Type: boolean
Default:
- false
+
programs.htop.showThreadNamesDeprecated. 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.sortDescendingWhether to sort descending or not.
Type: boolean
Default:
- true
+
programs.htop.sortDescendingDeprecated. 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.sortKeyWhich field to use for sorting.
Type: 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:
- "PERCENT_CPU"
+
programs.htop.sortKeyDeprecated. 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.treeViewTree view.
Type: boolean
Default:
- false
+
programs.htop.treeViewDeprecated. 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.updateProcessNamesUpdate process names on every refresh.
Type: boolean
Default:
- false
+
programs.htop.updateProcessNamesDeprecated. 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.vimModeVim key bindings.
Type: boolean
Default:
- false
+
programs.htop.vimModeDeprecated. 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.enableWhether to enable i3status.
Type: boolean
Default:
+The
diff --git a/release-notes.html b/release-notes.html
index e7ec751dc..108849c54 100644
--- a/release-notes.html
+++ b/release-notes.html
@@ -104,6 +104,19 @@ The library type fontType now has a font = {
name = "DejaVu Sans";
size = 8;
+};programs.htop.settings option is introduced to replace individual
+options in programs.htop. To migrate, set the htop options directly in
+programs.htop.settings. For example:
+programs.htop = {
+ enabled = true;
+ settings = {
+ color_scheme = 5;
+ delay = 15;
+ highlight_base_name = 1;
+ highlight_megabytes = 1;
+ highlight_threads = 1;
+ };
};
The state version in this release includes the changes below. These
changes are only active if the home.stateVersion option is set to
"21.05" or later.
home-manager +
home-manager — reconfigure a user environment
home-manager {
build
|
@@ -74,7 +74,7 @@
|
--verbose
}
- ]
This command updates the user environment so that it corresponds to the
configuration specified in ~/.config/nixpkgs/home.nix or ~/.config/nixpkgs/flake.nix.
@@ -139,7 +139,7 @@ available for immediate garbage collection.
-
The tool accepts the options
-A attrPath
@@ -234,15 +234,15 @@
--verbose
Activates verbose output. -