htop: describe screen options

This commit is contained in:
Bart Bakker 2023-11-26 14:44:30 +01:00
parent 8e1ed125fe
commit 99d547a491
No known key found for this signature in database
GPG key ID: 8BC1D8F4C6C7B548

View file

@ -92,44 +92,55 @@ let
blank = text "Blank"; blank = text "Blank";
screenOptions = { screenOptions = {
name = mkOption { type = types.str; }; name = mkOption {
type = types.str;
description = "Name that shows on the screen tab.";
};
fields = mkOption { fields = mkOption {
type = types.oneOf [ types.str (types.listOf types.str) ]; type = types.oneOf [ types.str (types.listOf types.str) ];
default = "PID USER M_VIRT STATE PERCENT_CPU PERCENT_MEM TIME Command"; default = "PID USER M_VIRT STATE PERCENT_CPU PERCENT_MEM TIME Command";
description = "What fields to show in the screen.";
}; };
all_branches_collapsed = mkOption { all_branches_collapsed = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = "Whether to collapse all branches in the tree view.";
}; };
sort_direction = mkOption { sort_direction = mkOption {
type = types.enum [ (-1) 1 ]; type = types.enum [ (-1) 1 ];
default = -1; default = -1;
description = "Whether to sort ascending or descending.";
}; };
sort_key = mkOption { sort_key = mkOption {
type = types.str; type = types.str;
example = "PERCENT_MEM"; example = "PERCENT_MEM";
description = "Key to sort by.";
}; };
tree_sort_direction = mkOption { tree_sort_direction = mkOption {
type = types.enum [ (-1) 1 ]; type = types.enum [ (-1) 1 ];
default = -1; default = -1;
description = "Whether to sort the tree ascending or descending.";
}; };
tree_sort_key = mkOption { tree_sort_key = mkOption {
type = types.str; type = types.str;
example = "PERCENT_MEM"; example = "PERCENT_MEM";
description = "Key to sort the three by.";
}; };
tree_view = mkOption { tree_view = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = "Whether the use a tree view.";
}; };
tree_view_always_by_pid = mkOption { tree_view_always_by_pid = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = "Whther the tree view groups by pid.";
}; };
}; };
@ -212,6 +223,9 @@ in {
}; };
}; };
''; '';
description = ''
List of screens.
'';
}; };
package = mkOption { package = mkOption {