Provided by: btm_0.9.6+20240202-2_amd64 
NAME
btm - A customizable cross-platform graphical process/system monitor for the terminal.
Supports Linux, macOS, and Windows.
SYNOPSIS
btm [--autohide_time] [-b|--basic] [-C|--config] [-t|--default_time_value]
[--default_widget_count] [--default_widget_type] [--disable_click] [-m|--dot_marker]
[-e|--expanded] [--hide_table_gap] [--hide_time] [-l|--left_legend] [-r|--rate]
[--retention] [--show_table_scroll_position] [-d|--time_delta] [-S|--case_sensitive]
[-u|--current_usage] [--disable_advanced_kill] [-g|--group_processes] [--process_command]
[-R|--regex] [-T|--tree] [-n|--unnormalized_cpu] [-W|--whole_word] [-c|--celsius]
[-f|--fahrenheit] [-k|--kelvin] [-a|--hide_avg_cpu] [--enable_cache_memory]
[--mem_as_value] [--network_use_binary_prefix] [--network_use_bytes] [--network_use_log]
[--use_old_network_legend] [--battery] [--enable_gpu] [--color] [-h|--help] [-V|--version]
DESCRIPTION
A customizable cross-platform graphical process/system monitor for the terminal. Supports
Linux, macOS, and Windows.
OPTIONS
--autohide_time
Automatically hides the time scale in graphs after being shown for a brief moment
when zoomed in/out. If time is disabled via --hide_time then this will have no
effect.
-b, --basic
Hides graphs and uses a more basic look. Design is largely inspired by htop's.
-C, --config=CONFIG PATH
Sets the location of the config file. Expects a config file in the TOML format.If
it doesn't exist, one is created.
-t, --default_time_value=TIME
Default time value for graphs. Takes a number in milliseconds or a human duration
(e.g. 60s). The minimum time is 30s, and the default is 60s.
--default_widget_count=INT
Sets the n'th selected widget type to use as the default widget. Requires
'default_widget_type' to also be set, and defaults to 1.
This reads from left to right, top to bottom. For example, suppose we have a layout
that looks like: +-------------------+-----------------------+ | CPU (1)
| CPU (2) | +---------+---------+-------------+---------+ | Process |
CPU (3) | Temperature | CPU (4) | +---------+---------+-------------+---------+
And we set our default widget type to 'CPU'. If we set '--default_widget_count 1',
then it would use the CPU (1) as the default widget. If we set
'--default_widget_count 3', it would use CPU (3) as the default instead.
--default_widget_type=WIDGET TYPE
Sets which widget type to use as the default widget. For the default layout, this
defaults to the 'process' widget. For a custom layout, it defaults to the first
widget it sees.
For example, suppose we have a layout that looks like:
+-------------------+-----------------------+ | CPU (1) | CPU (2)
| +---------+---------+-------------+---------+ | Process | CPU (3) | Temperature |
CPU (4) | +---------+---------+-------------+---------+
Setting '--default_widget_type Temp' will make the temperature widget selected by
default.
[possible values: cpu, mem, net, network, proc, process, processes, temp,
temperature, disk]
--disable_click
Disables mouse clicks from interacting with the program.
-m, --dot_marker
Uses a dot marker for graphs as opposed to the default braille marker.
-e, --expanded
Expand the default widget upon starting the app. Same as pressing "e" inside the
app. Use with "default_widget_type" and "default_widget_count" to select the
desired expanded widget. This flag has no effect in basic mode (--basic).
--hide_table_gap
Hides the spacing between table headers and entries.
--hide_time
Completely hides the time scale from being shown.
-l, --left_legend
Puts the CPU chart legend to the left side rather than the right side.
-r, --rate=TIME
Sets the data refresh rate. Takes a number in milliseconds or a humanduration (e.g.
5s). The minimum is 250ms, and defaults to 1000ms. Smaller values may take more
computer resources.
--retention=TIME
How much data is stored at once in terms of time. Takes a number in milliseconds or
a human duration (e.g. 20m), with a minimum of 1 minute. Note that higher values
will take up more memory. Defaults to 10 minutes.
--show_table_scroll_position
Shows the list scroll position tracker in the widget title for table widgets.
-d, --time_delta=TIME
The amount of time changed when zooming in/out. Takes a number in milliseconds or a
human duration (e.g. 30s). The minimum is 1s, and defaults to 15s.
-S, --case_sensitive
When searching for a process, enables case sensitivity by default.
-u, --current_usage
Sets process CPU% usage to be based on the current system CPU% usage rather than
total CPU usage.
--disable_advanced_kill
Hides advanced options to stop a process on Unix-like systems. The only option
shown is 15 (TERM).
-g, --group_processes
Groups processes with the same name by default.
--process_command
Show processes as their commands by default in the process widget.
-R, --regex
When searching for a process, enables regex by default.
-T, --tree
Defaults to showing the process widget in tree mode.
-n, --unnormalized_cpu
Shows all process CPU% usage without averaging over the number of CPU cores in the
system.
-W, --whole_word
When searching for a process, return results that match the entire query by
default.
-c, --celsius
Use Celsius as the temperature unit. This is the default option.
-f, --fahrenheit
Use Fahrenheit as the temperature unit.
-k, --kelvin
Use Kelvin as the temperature unit.
-a, --hide_avg_cpu
Hides the average CPU usage from being shown.
--enable_cache_memory
Enable collecting and displaying cache and buffer memory.
--mem_as_value
Defaults to showing process memory usage by value. Otherwise, it defaults to
showing it by percentage.
--network_use_binary_prefix
Displays the network widget with binary prefixes (i.e. kibibits, mebibits) rather
than a decimal prefix (i.e. kilobits, megabits). Defaults to decimal prefixes.
--network_use_bytes
Displays the network widget using bytes. Defaults to bits.
--network_use_log
Displays the network widget with a log scale. Defaults to a non-log scale.
--use_old_network_legend
DEPRECATED - uses an older (pre-0.4), separate network widget legend. This display
is not tested anymore and may be broken.
--battery
Shows the battery widget in default or basic mode. No effect on custom layouts.
--enable_gpu
Enable collecting and displaying GPU usage.
--color=COLOR SCHEME
Use a pre-defined color scheme. Currently supported values are: - default -
default-light (default but adjusted for lighter backgrounds) - gruvbox (a
bright theme with 'retro groove' colors) - gruvbox-light (gruvbox but adjusted for
lighter backgrounds) - nord (an arctic, north-bluish color palette) -
nord-light (nord but adjusted for lighter backgrounds)
-h, --help
Prints help (see more info with '--help').
-V, --version
Prints version information.
VERSION
v0.9.6
AUTHORS
Clement Tsang <cjhtsang@uwaterloo.ca>
btm 0.9.6 btm(1)