btm(1) General Commands Manual btm(1)

btm - A customizable cross-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows.

btm [--autohide_time] [-b|--basic] [--battery] [-S|--case_sensitive] [-c|--celsius] [--color] [-C|--config] [-u|--current_usage] [-t|--default_time_value] [--default_widget_count] [--default_widget_type] [--disable_advanced_kill] [--disable_click] [-m|--dot_marker] [--enable_cache_memory] [--enable_gpu_memory] [-e|--expanded] [-f|--fahrenheit] [-g|--group] [-a|--hide_avg_cpu] [--hide_table_gap] [--hide_time] [-k|--kelvin] [-l|--left_legend] [--mem_as_value] [--network_use_binary_prefix] [--network_use_bytes] [--network_use_log] [--process_command] [-r|--rate] [-R|--regex] [--retention] [--show_table_scroll_position] [-d|--time_delta] [-T|--tree] [-n|--unnormalized_cpu] [--use_old_network_legend] [-V|--version] [-W|--whole_word] [-h|--help]

A customizable cross-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows.

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.
Hides graphs and uses a more basic look. Design is largely inspired by htop's.
Shows the battery widget in default or basic mode. No effect on custom layouts.
When searching for a process, enables case sensitivity by default.
Sets the temperature type to Celsius. This is the default option.
Use a pre-defined color scheme. Currently supported values are: +------------------------------------------------------------+ | default | +------------------------------------------------------------+ | default-light (default but for use with light backgrounds) | +------------------------------------------------------------+ | gruvbox (a bright theme with 'retro groove' colors) | +------------------------------------------------------------+ | gruvbox-light (gruvbox but for use with light backgrounds) | +------------------------------------------------------------+ | nord (an arctic, north-bluish color palette) | +------------------------------------------------------------+ | nord-light (nord but for use with light backgrounds) | +------------------------------------------------------------+ Defaults to "default".
Sets the location of the config file. Expects a config file in the TOML format. If it doesn't exist, one is created.
Sets process CPU% usage to be based on the current system CPU% usage rather than total CPU usage.
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.
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.

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.

Supported widget names: +--------------------------+ | cpu | +--------------------------+ | mem, memory | +--------------------------+ | net, network | +--------------------------+ | proc, process, processes | +--------------------------+ | temp, temperature | +--------------------------+ | disk | +--------------------------+ | batt, battery | +--------------------------+

Hides advanced options to stop a process on Unix-like systems. The only option shown is 15 (TERM).
Disables mouse clicks from interacting with the program.
Uses a dot marker for graphs as opposed to the default braille marker.
Enable collecting and displaying cache and buffer memory.
Enable collecting and displaying GPU memory usage.
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 desired expanded widget. This flag has no effect in basic mode (--basic)
Sets the temperature type to Fahrenheit.
Groups processes with the same name by default.
Hides the average CPU usage from being shown.
Hides the spacing between table headers and entries.
Completely hides the time scale from being shown.
Sets the temperature type to Kelvin.
Puts the CPU chart legend to the left side rather than the right side.
Defaults to showing process memory usage by value. Otherwise, it defaults to showing it by percentage.
Displays the network widget with binary prefixes (i.e. kibibits, mebibits) rather than a decimal prefix (i.e. kilobits, megabits). Defaults to decimal prefixes.
Displays the network widget using bytes. Defaults to bits.
Displays the network widget with a log scale. Defaults to a non-log scale.
Show processes as their commands by default in the process widget.
Sets the data refresh rate. Takes a number in milliseconds or a human duration (e.g. 5s). The minimum is 250ms, and defaults to 1000ms. Smaller values may take more computer resources.
When searching for a process, enables regex by default.
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 higher values will take up more memory. Defaults to 10 minutes.
Shows the list scroll position tracker in the widget title for table widgets.
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.
Defaults to showing the process widget in tree mode.
Shows all process CPU% usage without averaging over the number of CPU cores in the system.
DEPRECATED - uses an older (pre-0.4), separate network widget legend. This display is not tested anymore and could be broken.
Prints version information.
When searching for a process, return results that match the entire query by default.
Print help (see a summary with '-h')

v0.9.6

Clement Tsang <cjhtsang@uwaterloo.ca>

btm 0.9.6