Back to Bottom

Command-line Options

docs/content/configuration/command-line-options.md

0.12.37.1 KB
Original Source

Command-line Options

The following options can be provided to bottom in the command line to change the behaviour of the program. You can also see information on these options by running btm -h, or run btm --help to display more detailed information on each option:

General Options

OptionBehaviour
--autohide_timeTemporarily shows the time scale in graphs.
-b, --basicHides graphs and uses a more basic look.
-C, --config_location <PATH>Sets the location of the config file.
-t, --default_time_value <TIME>Default time value for graphs.
--default_widget_count <N>Sets the N'th selected widget type as the default.
--default_widget_type <WIDGET>Sets the default widget type. Use --help for more info.
--disable_clickDisables mouse clicks.
--disable_keysDisables keyboard shortcuts, INCLUDING the ones that stop
bottom.
-m, --dot_markerUses a dot marker for graphs.
-e, --expandedExpand the default widget upon starting the app.
--hide_table_gapHides spacing between table headers and entries.
--hide_timeHides the time scale from being shown.
-r, --rate <TIME>Sets how often data is refreshed.
--retention <TIME>How far back data will be stored up to.
--show_table_scroll_positionShows the list scroll position tracker in the widget title
for table widgets.
-d, --time_delta <TIME>The amount of time changed upon zooming.

Process Options

OptionBehaviour
-S, --case_sensitiveEnables case sensitivity by default when searching.
-u, --current_usageCalculates process CPU usage as a percentage of current usage rather than total usage.
--disable_advanced_killHides additional stopping options on Unix-like systems.
--read_onlyPrevents performing any actions that affect the system (e.g. stopping processes).
--get_threadsAlso gather process thread information.
-g, --group_processesGroups processes with the same name by default. No effect if --tree is set.
--hide_k_threadsHide kernel threads by default.
--process_memory_as_valueDefaults to showing process memory usage by value.
--process_commandShows the full command name instead of the process name by default.
-R, --regexEnables regex by default while searching.
-T, --treeMakes the process widget use tree mode by default.
--tree_collapseCollapse process tree by default.
-n, --unnormalized_cpuShow process CPU% usage without averaging over the number of CPU cores.
-W, --whole_wordEnables whole-word matching by default while searching.

Temperature Options

OptionBehaviour
-c, --celsiusUse Celsius as the temperature unit. Default.
-f, --fahrenheitUse Fahrenheit as the temperature unit.
-k, --kelvinUse Kelvin as the temperature unit.

CPU Options

OptionBehaviour
--cpu_left_legendPuts the CPU chart legend on the left side.
--default_cpu_entrySets which CPU entry type is selected by default.
-a, --hide_avg_cpuHides the average CPU usage entry.

Memory Options

OptionBehaviour
--memory_legend <POSITION>Where to place the legend for the memory chart widget.
--enable_cache_memoryEnable collecting and displaying cache and buffer memory.
--free_arcSubtract freeable ARC from memory.

Network Options

OptionBehaviour
--network_legend <POSITION>Where to place the legend for the network chart widget.
--network_use_bytesDisplays the network widget using bytes.
--network_use_binary_prefixDisplays the network widget with binary prefixes.
--network_use_logDisplays the network widget with a log scale.
--use_old_network_legend(DEPRECATED) Uses a separate network legend.

Battery Options

OptionBehaviour
--batteryShows the battery widget in non-custom layouts.

GPU Options

OptionBehaviour
--disable_gpuDisable collecting and displaying NVIDIA and AMD GPU information.

Style Options

OptionBehaviour
--theme <SCHEME>Use a built-in color theme, use '--help' for info on the colors.

Other Options

OptionBehaviour
-h, --helpPrints help info (for more details use --help.)
-V, --versionPrints version information.