Back to Bottom

Flags

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

0.12.311.4 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_cpuBooleanHides the average CPU usage.
dot_markerBooleanUses a dot marker for graphs.
cpu_left_legendBooleanPuts the CPU chart legend to the left side.
current_usageBooleanSets process CPU% to be based on current CPU%.
group_processesBooleanGroups processes with the same name by default.
case_sensitiveBooleanEnables case sensitivity by default.
whole_wordBooleanEnables whole-word matching by default.
regexBooleanEnables 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_memoryBooleanEnable cache and buffer memory stats (not available on Windows).
process_memory_as_valueBooleanDefaults to showing process memory usage by value.
treeBooleanDefaults to showing the process widget in tree mode.
show_table_scroll_positionBooleanShows the scroll position tracker in table widgets.
process_commandBooleanShow processes as their commands by default.
disable_advanced_killBooleanDisable 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_prefixBooleanDisplays the network widget with binary prefixes.
network_use_bytesBooleanDisplays the network widget using bytes.
network_use_logBooleanDisplays 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_cpuBooleanShow 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"])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"])Where to place the legend for the network widget.
average_cpu_rowBooleanMoves the average CPU usage entry to its own row when using basic mode.
tree_collapseBooleanCollapse process tree by default.
hide_k_threadsBooleanHide kernel threads by default.
free_arcBooleanSubtract freeable ARC from memory.