.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH btm 1  "btm 0.14.8" 
.SH NAME
btm \- A customizable cross\-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows.
.SH SYNOPSIS
\fBbtm\fR [OPTIONS]
.SH DESCRIPTION
A customizable cross\-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows.
.SH "GENERAL OPTIONS"
.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 using \-\-hide_time then this will have no effect.
.TP
\fB\-b\fR, \fB\-\-basic\fR
Hides graphs and uses a more basic look, largely inspired by htop\*(Aqs design.
.TP
\fB\-C\fR, \fB\-\-config_location\fR \fI<PATH>\fR
Sets the location of the config file. Expects a config file in the TOML format. If it doesn\*(Aqt exist, a default config file is created at the path. If no path is provided, the default config location will be used.
.TP
\fB\-t\fR, \fB\-\-default_time_value\fR \fI<TIME>\fR
Default time value for graphs. Either a number in milliseconds or a \*(Aqhuman duration\*(Aq (e.g. 60s, 10m). Defaults to 60s, must be at least 30s.
.TP
\fB\-\-default_widget_count\fR \fI<N>\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 \fI<WIDGET>\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) |
+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+

Then, setting \*(Aq\-\-default_widget_type temperature\*(Aq will make the temperature widget selected by default.
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
cpu
.IP \(bu 2
mem
.IP \(bu 2
net
.IP \(bu 2
network
.IP \(bu 2
proc
.IP \(bu 2
process
.IP \(bu 2
processes
.IP \(bu 2
temp
.IP \(bu 2
temperature
.IP \(bu 2
disk
.IP \(bu 2
batt
.IP \(bu 2
battery
.RE
.TP
\fB\-\-disable_click\fR
Disables mouse clicks from interacting with bottom.
.TP
\fB\-\-disable_keys\fR
Disables keyboard shortcuts from interacting with bottom. Note this includes keyboard shortcuts to quit bottom.
.TP
\fB\-m\fR, \fB\-\-dot_marker\fR
Uses a dot marker for graphs as opposed to the default braille marker.
.TP
\fB\-e\fR, \fB\-\-expanded\fR
Expand the default widget upon starting the app. This flag has no effect in basic mode (\-\-basic).
.TP
\fB\-\-hide_time\fR
Hides the time scale from being shown.
.TP
\fB\-r\fR, \fB\-\-rate\fR \fI<TIME>\fR
Sets how often data is refreshed. Either a number in milliseconds or a \*(Aqhuman duration\*(Aq (e.g. 1s, 1m). Defaults to 1s, must be at least 250ms. Smaller values may result in higher system resource usage.
.TP
\fB\-\-retention\fR \fI<TIME>\fR
How far back data will be stored up to. Either a number in milliseconds or a \*(Aqhuman duration\*(Aq (e.g. 10m, 1h). Defaults to 10 minutes, and must be at least  1 minute. Larger values may result in higher memory usage.
.TP
\fB\-\-show_table_scroll_position\fR
Shows the list scroll position tracker in the widget title for table widgets.
.TP
\fB\-d\fR, \fB\-\-time_delta\fR \fI<TIME>\fR
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.
.SH "PROCESS OPTIONS"
.TP
\fB\-S\fR, \fB\-\-case_sensitive\fR
Enables case sensitivity by default when searching for a process.
.TP
\fB\-u\fR, \fB\-\-current_usage\fR
Calculates process CPU usage as a percentage of current usage rather than total usage.
.TP
\fB\-\-disable_advanced_kill\fR
Hides additional stopping options on Unix\-like systems. Signal 15 (TERM) will be sent when stopping a process.
.TP
\fB\-\-read_only\fR
Prevents performing any actions that affect the system. Disables operations such as stopping or sending signals to processes.
.TP
\fB\-\-hide_k_threads\fR
Hide kernel threads.
.TP
\fB\-\-get_threads\fR
Also gather process thread information.
.TP
\fB\-\-process_default_sort\fR \fI<COLUMN>\fR
Sets the default sort column for the process widget. Accepts any of the valid process column names (e.g. "cpu%", "mem", "pid", "name"). Overrides the [processes] default_sort setting in the config file.
.TP
\fB\-g\fR, \fB\-\-group_processes\fR
Groups processes with the same name by default when searching. Doesn\*(Aqt do anything if \-\-tree is also set, or tree=true in the config.
.TP
\fB\-\-process_memory_as_value\fR
Defaults to showing process memory usage by value. Otherwise, it defaults to showing it by percentage.
.TP
\fB\-\-process_command\fR
Shows the full command name instead of the process name by default.
.TP
\fB\-R\fR, \fB\-\-regex\fR
Enables regex by default while searching.
.TP
\fB\-T\fR, \fB\-\-tree\fR
Makes the process widget use tree mode by default.
.TP
\fB\-\-tree_collapse\fR
Collapse process tree by default.
.TP
\fB\-n\fR, \fB\-\-unnormalized_cpu\fR
Show process CPU% usage without averaging over the number of CPU cores.
.TP
\fB\-W\fR, \fB\-\-whole_word\fR
Enables whole\-word matching by default while searching.
.SH "TEMPERATURE OPTIONS"
.TP
\fB\-c\fR, \fB\-\-celsius\fR
Use Celsius as the temperature unit. This is the default option.
.TP
\fB\-f\fR, \fB\-\-fahrenheit\fR
Use Fahrenheit as the temperature unit.
.TP
\fB\-k\fR, \fB\-\-kelvin\fR
Use Kelvin as the temperature unit.
.SH "CPU OPTIONS"
.TP
\fB\-l\fR, \fB\-\-cpu_left_legend\fR
Puts the CPU chart legend on the left side.
.TP
\fB\-\-default_cpu_entry\fR \fI<ENTRY>\fR
Sets which CPU entry type is selected by default.
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
all
.IP \(bu 2
avg
.RE
.TP
\fB\-a\fR, \fB\-\-hide_avg_cpu\fR
Hides the average CPU usage entry.
.SH "MEMORY OPTIONS"
.TP
\fB\-\-memory_legend\fR \fI<POSITION>\fR
Where to place the legend for the memory chart widget.
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
none
.IP \(bu 2
top\-left
.IP \(bu 2
top
.IP \(bu 2
top\-right
.IP \(bu 2
left
.IP \(bu 2
right
.IP \(bu 2
bottom\-left
.IP \(bu 2
bottom
.IP \(bu 2
bottom\-right
.RE
.TP
\fB\-\-enable_cache_memory\fR
Enables collecting and displaying cache and buffer memory.
.TP
\fB\-\-free_arc\fR
Subtract reclaimable ARC from memory.
.TP
\fB\-\-short_gpu_names\fR
Use short GPU names (e.g. \*(AqGPU\*(Aq or \*(AqGPU0\*(Aq, \*(AqGPU1\*(Aq) in the memory widget instead of full GPU names.
.SH "NETWORK OPTIONS"
.TP
\fB\-\-network_legend\fR \fI<POSITION>\fR
Where to place the legend for the network chart widget.
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
none
.IP \(bu 2
top\-left
.IP \(bu 2
top
.IP \(bu 2
top\-right
.IP \(bu 2
left
.IP \(bu 2
right
.IP \(bu 2
bottom\-left
.IP \(bu 2
bottom
.IP \(bu 2
bottom\-right
.RE
.TP
\fB\-\-network_use_bytes\fR
Displays the network widget using bytes. Defaults to bits.
.TP
\fB\-\-network_use_binary_prefix\fR
Displays the network widget with binary prefixes (e.g. kibibits, mebibits) rather than a decimal prefixes (e.g. kilobits, megabits). Defaults to decimal prefixes.
.TP
\fB\-\-network_use_log\fR
Displays the network widget with a log scale. Defaults to a non\-log scale.
.TP
\fB\-\-use_old_network_legend\fR
(DEPRECATED) Uses separate network widget legend. This display is not tested and may be broken.
.TP
\fB\-\-show_packets\fR
Displays packets information including packet rate (packets per second) and average packet size in the network widget.
.SH "BATTERY OPTIONS"
.TP
\fB\-\-battery\fR
Shows the battery widget in default or basic mode, if there is as battery available. This has no effect on custom layouts; if the battery widget is desired for a custom layout, explicitly specify it.
.SH "GPU OPTIONS"
.TP
\fB\-\-disable_gpu\fR
Disable collecting and displaying NVIDIA and AMD GPU information.
.SH "STYLE OPTIONS"
.TP
\fB\-\-theme\fR \fI<SCHEME>\fR
Use a pre\-defined colour theme. Currently supported themes are:
\- default
\- default\-light (default but adjusted for lighter backgrounds)
\- gruvbox       (a bright theme with \*(Aqretro groove\*(Aq colours)
\- gruvbox\-light (gruvbox but adjusted for lighter backgrounds)
\- nord          (an arctic, north\-bluish colour palette)
\- nord\-light    (nord but adjusted for lighter backgrounds)
.SH "OTHER OPTIONS"
.TP
\fB\-h\fR, \fB\-\-help\fR
Prints help info (for more details use \*(Aq\-\-help\*(Aq.
.TP
\fB\-V\fR, \fB\-\-version\fR
Prints version information.
.SH VERSION
v0.14.8
.SH AUTHORS
Clement Tsang <cjhtsang@uwaterloo.ca>