.ie \n(.g .ds Aq \(aq .el .ds Aq ' .TH btm 1 "btm 0.6.8" .SH NAME btm \- A customizable cross\-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows. .SH SYNOPSIS \fBbtm\fR [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fB\-k\fR|\fB\-\-kelvin\fR] [\fB\-f\fR|\fB\-\-fahrenheit\fR] [\fB\-c\fR|\fB\-\-celsius\fR] [\fB\-\-autohide_time\fR] [\fB\-b\fR|\fB\-\-basic\fR] [\fB\-S\fR|\fB\-\-case_sensitive\fR] [\fB\-\-process_command\fR] [\fB\-C\fR|\fB\-\-config\fR] [\fB\-\-color\fR] [\fB\-\-mem_as_value\fR] [\fB\-t\fR|\fB\-\-default_time_value\fR] [\fB\-\-default_widget_count\fR] [\fB\-\-default_widget_type\fR] [\fB\-\-disable_click\fR] [\fB\-m\fR|\fB\-\-dot_marker\fR] [\fB\-g\fR|\fB\-\-group\fR] [\fB\-a\fR|\fB\-\-hide_avg_cpu\fR] [\fB\-\-hide_table_gap\fR] [\fB\-\-hide_time\fR] [\fB\-\-show_table_scroll_position\fR] [\fB\-l\fR|\fB\-\-left_legend\fR] [\fB\-\-disable_advanced_kill\fR] [\fB\-r\fR|\fB\-\-rate\fR] [\fB\-R\fR|\fB\-\-regex\fR] [\fB\-d\fR|\fB\-\-time_delta\fR] [\fB\-T\fR|\fB\-\-tree\fR] [\fB\-\-network_use_bytes\fR] [\fB\-\-network_use_log\fR] [\fB\-\-network_use_binary_prefix\fR] [\fB\-u\fR|\fB\-\-current_usage\fR] [\fB\-\-use_old_network_legend\fR] [\fB\-W\fR|\fB\-\-whole_word\fR] [\fB\-\-battery\fR] .SH DESCRIPTION A customizable cross\-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows. .SH OPTIONS .TP \fB\-h\fR, \fB\-\-help\fR Prints help information. Use \-\-help for info. .TP \fB\-V\fR, \fB\-\-version\fR Prints version information. .TP \fB\-k\fR, \fB\-\-kelvin\fR Sets the temperature type to Kelvin. .TP \fB\-f\fR, \fB\-\-fahrenheit\fR Sets the temperature type to Fahrenheit. .TP \fB\-c\fR, \fB\-\-celsius\fR Sets the temperature type to Celsius. This is the default option. .TP \fB\-\-autohide_time\fR 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. .TP \fB\-b\fR, \fB\-\-basic\fR Hides graphs and uses a more basic look. Design is largely inspired by htop\*(Aqs. .TP \fB\-S\fR, \fB\-\-case_sensitive\fR When searching for a process, enables case sensitivity by default. .TP \fB\-\-process_command\fR Show processes as their commands by default in the process widget. .TP \fB\-C\fR, \fB\-\-config\fR=\fICONFIG PATH\fR Sets the location of the config file. Expects a config file in the TOML format. If it doesn\*(Aqt exist, one is created. .TP \fB\-\-color\fR=\fICOLOR SCHEME\fR 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 \*(Aqretro groove\*(Aq 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". .TP \fB\-\-mem_as_value\fR Defaults to showing process memory usage by value. Otherwise, it defaults to showing it by percentage. .TP \fB\-t\fR, \fB\-\-default_time_value\fR=\fIMS\fR Default time value for graphs in milliseconds. The minimum time is 30s (30000), and the default is 60s (60000). .TP \fB\-\-default_widget_count\fR=\fIINT\fR Sets the n\*(Aqth selected widget type to use as the default widget. Requires \*(Aqdefault_widget_type\*(Aq 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 \*(AqCPU\*(Aq. If we set \*(Aq\-\-default_widget_count 1\*(Aq, then it would use the CPU (1) as the default widget. If we set \*(Aq\-\-default_widget_count 3\*(Aq, it would use CPU (3) as the default instead. .TP \fB\-\-default_widget_type\fR=\fIWIDGET TYPE\fR Sets which widget type to use as the default widget. For the default layout, this defaults to the \*(Aqprocess\*(Aq 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 \*(Aq\-\-default_widget_type Temp\*(Aq will make the Temperature widget selected by default. Supported widget names: +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ | cpu | +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ | mem, memory | +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ | net, network | +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ | proc, process, processes | +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ | temp, temperature | +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ | disk | +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ | batt, battery | +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ .TP \fB\-\-disable_click\fR Disables mouse clicks from interacting with the program. .TP \fB\-m\fR, \fB\-\-dot_marker\fR Uses a dot marker for graphs as opposed to the default braille marker. .TP \fB\-g\fR, \fB\-\-group\fR Groups processes with the same name by default. .TP \fB\-a\fR, \fB\-\-hide_avg_cpu\fR Hides the average CPU usage from being shown. .TP \fB\-\-hide_table_gap\fR Hides the spacing between table headers and entries. .TP \fB\-\-hide_time\fR Completely hides the time scale from being shown. .TP \fB\-\-show_table_scroll_position\fR Shows the list scroll position tracker in the widget title for table widgets. .TP \fB\-l\fR, \fB\-\-left_legend\fR Puts the CPU chart legend to the left side rather than the right side. .TP \fB\-\-disable_advanced_kill\fR Hides advanced options to stop a process on Unix\-like systems. The only option shown is 15 (TERM). .TP \fB\-r\fR, \fB\-\-rate\fR=\fIMS\fR Sets a refresh rate in milliseconds. The minimum is 250ms, and defaults to 1000ms. Smaller values may take more computer resources. .TP \fB\-R\fR, \fB\-\-regex\fR When searching for a process, enables regex by default. .TP \fB\-d\fR, \fB\-\-time_delta\fR=\fIMS\fR The amount of time in milliseconds changed when zooming in/out. The minimum is 1s (1000), and defaults to 15s (15000). .TP \fB\-T\fR, \fB\-\-tree\fR Defaults to showing the process widget in tree mode. .TP \fB\-\-network_use_bytes\fR Displays the network widget using bytes. Defaults to bits. .TP \fB\-\-network_use_log\fR Displays the network widget with a log scale. Defaults to a non\-log scale. .TP \fB\-\-network_use_binary_prefix\fR Displays the network widget with binary prefixes (i.e. kibibits, mebibits) rather than a decimal prefix (i.e. kilobits, megabits). Defaults to decimal prefixes. .TP \fB\-u\fR, \fB\-\-current_usage\fR Sets process CPU% usage to be based on the current system CPU% usage rather than total CPU usage. .TP \fB\-\-use_old_network_legend\fR DEPRECATED \- uses an older (pre\-0.4), separate network widget legend. This display is not tested anymore and could be broken. .TP \fB\-W\fR, \fB\-\-whole_word\fR When searching for a process, return results that match the entire query by default. .TP \fB\-\-battery\fR Shows the battery widget in default or basic mode. No effect on custom layouts. .SH VERSION v0.6.8 .SH AUTHORS Clement Tsang