Back to Bottom

Flags

docs/content/configuration/config-file/flags.md

0.14.615.1 KB
Original Source

Flags

!!! Warning

This section is in progress, and is just copied from the old documentation.

You can configure flags by putting them in [flags] table. Example:

toml
[flags]
hide_avg_cpu = true

Most of the command line flags have config file equivalents to avoid having to type them out each time:

FieldTypeFunctionality
hide_avg_cpuBooleanDeprecated - use cpu.hide_avg_cpu. Hides the average CPU usage.
dot_markerBooleanUses a dot marker for graphs.
cpu_left_legendBooleanDeprecated - use cpu.left_legend. Puts the CPU chart legend to the left side.
current_usageBooleanDeprecated - use processes.current_usage. Sets process CPU% to be based on current CPU%.
group_processesBooleanDeprecated - use processes.default_grouped. Groups processes with the same name by default.
case_sensitiveBooleanDeprecated - use processes.case_sensitive. Enables case sensitivity by default.
whole_wordBooleanDeprecated - use processes.whole_word. Enables whole-word matching by default.
regexBooleanDeprecated - use processes.regex. Enables regex by default.
basicBooleanHides graphs and uses a more basic look.
use_old_network_legendBooleanDEPRECATED - uses the older network legend.
batteryBooleanShows the battery widget.
rateUnsigned Int (represents milliseconds) or String (represents human time)Sets a refresh rate in ms.
default_time_valueUnsigned Int (represents milliseconds) or String (represents human time)Default time value for graphs in ms.
time_deltaUnsigned Int (represents milliseconds) or String (represents human time)The amount in ms changed upon zooming.
hide_timeBooleanHides the time scale.
temperature_typeString (one of ["k", "f", "c", "kelvin", "fahrenheit", "celsius"])Sets the temperature unit type.
default_widget_typeString (one of ["cpu", "proc", "net", "temp", "mem", "disk"], same as layout options)Sets the default widget type, use --help for more info.
default_widget_countUnsigned Int (represents which default_widget_type)Sets the n'th selected widget type as the default.
disable_clickBooleanDisables mouse clicks.
enable_cache_memoryBooleanDeprecated - use memory.cache_memory. Enable cache and buffer memory stats (not available on Windows).
process_memory_as_valueBooleanDeprecated - use processes.default_memory_value. Defaults to showing process memory usage by value.
treeBooleanDeprecated - use processes.default_tree. Defaults to showing the process widget in tree mode.
show_table_scroll_positionBooleanShows the scroll position tracker in table widgets.
show_table_scroll_barBooleanShows a scroll bar on the right edge of table widgets.
process_commandBooleanDeprecated - use processes.process_command. Show processes as their commands by default.
disable_advanced_killBooleanDeprecated - use processes.disable_advanced_kill. Disable being able to send signals to processes on supported Unix-like systems. Only available on Linux, macOS, and FreeBSD.
read_onlyBooleanPrevents performing any actions that affect the system (e.g. stopping processes).
network_use_binary_prefixBooleanDeprecated - use network_graph.use_binary_prefix. Displays the network widget with binary prefixes.
network_use_bytesBooleanDeprecated - use network_graph.use_bytes. Displays the network widget using bytes.
network_use_logBooleanDeprecated - use network_graph.use_log. Displays the network widget with a log scale.
disable_gpuBooleanDisable NVIDIA and AMD GPU data collection.
retentionString (human readable time, such as "10m", "1h", etc.)How much data is stored at once in terms of time.
unnormalized_cpuBooleanDeprecated - use processes.unnormalized_cpu. Show process CPU% without normalizing over the number of cores.
expandedBooleanExpand the default widget upon starting the app.
memory_legendString (one of ["none", "top-left", "top", "top-right", "left", "right", "bottom-left", "bottom", "bottom-right"])Deprecated - use memory_graph.legend_position or memory.legend_position; where to place the legend for the memory widget.
network_legendString (one of ["none", "top-left", "top", "top-right", "left", "right", "bottom-left", "bottom", "bottom-right"])Deprecated - use network_graph.legend_position or network.legend_position; where to place the legend for the network widget.
average_cpu_rowBooleanDeprecated - use cpu.basic_average_cpu_row. Moves the average CPU usage entry to its own row when using basic mode.
tree_collapseBooleanDeprecated - use processes.tree_collapse. Collapse process tree by default.
autohide_timeBooleanTemporarily shows the time scale in graphs.
table_gapString (one of ["none", "space", "line"])Controls the gap between table headers and data rows. Defaults to "space".
disable_keysBooleanDisables keyboard shortcuts, including the ones that stop bottom.
no_writeBooleanDisables writing to the config file.
hide_k_threadsBooleanDeprecated - use processes.hide_k_threads. Hide kernel threads from being shown.
free_arcBooleanDeprecated - use memory.free_arc. Subtract ARC memory that can be freed from memory usage.