mirror of
https://github.com/ClementTsang/bottom.git
synced 2026-05-29 10:10:53 +00:00
d08036f69a
<!-- Please use this template (unless you have a very good reason not to). PRs that do not use the template may be closed. --> ## Description _A description of the change, what it does, and why it was made. If relevant (e.g. UI changes), **please also provide screenshots/recordings**:_ Rename a bunch of code/struct field names to use "colour". Note this should have no functional change to config settings as I was already aliasing "colour" for "color" settings, this just flips it internally. As for why, I'm Canadian, I grew up spelling it this way, sorry. ## Issue _If applicable, what issue does this address?_ Closes: #<issue-number> ## Testing _If relevant, please state how this was tested (including steps):_ _If this change affects the program, please also indicate which platforms were tested:_ - [ ] _Windows_ - [ ] _macOS (specify version below)_ - [x] _Linux (specify distro below)_ - [ ] _Other (specify below)_ ## Checklist _Ensure **all** of these are met:_ - [x] _If this PR adds or changes a dependency, please justify this in the description_ - [x] _If this is a code change, areas your change affects have been linted using (`cargo fmt`)_ - [x] _If this is a code change, your changes pass `cargo clippy --all -- -D warnings`_ - [x] _If this is a code change, new tests were added if relevant_ - [x] _If this is a code change, your changes pass `cargo test`_ - [x] _The change has been tested to work (see above) and doesn't appear to break other things_ - [x] _Documentation has been updated if needed (`README.md`, help menu, docs, configs, etc.)_ - [x] _There are no merge conflicts_ - [x] _You have reviewed your changes first_ - [x] _The pull request passes the provided CI pipeline_ ## Other _Anything else that maintainers should know about this PR:_
7.1 KiB
7.1 KiB
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
| Option | Behaviour |
|---|---|
--autohide_time |
Temporarily shows the time scale in graphs. |
-b, --basic |
Hides 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_click |
Disables mouse clicks. |
--disable_keys |
Disables keyboard shortcuts, INCLUDING the ones that stop |
| bottom. | |
-m, --dot_marker |
Uses a dot marker for graphs. |
-e, --expanded |
Expand the default widget upon starting the app. |
--hide_time |
Hides 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_position |
Shows 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
| Option | Behaviour |
|---|---|
-S, --case_sensitive |
Enables case sensitivity by default when searching. |
-u, --current_usage |
Calculates process CPU usage as a percentage of current usage rather than total usage. |
--disable_advanced_kill |
Hides additional stopping options on Unix-like systems. |
--read_only |
Prevents performing any actions that affect the system (e.g. stopping processes). |
--get_threads |
Also gather process thread information. |
-g, --group_processes |
Groups processes with the same name by default. No effect if --tree is set. |
--hide_k_threads |
Hide kernel threads by default. |
--process_memory_as_value |
Defaults to showing process memory usage by value. |
--process_command |
Shows the full command name instead of the process name by default. |
-R, --regex |
Enables regex by default while searching. |
-T, --tree |
Makes the process widget use tree mode by default. |
--tree_collapse |
Collapse process tree by default. |
-n, --unnormalized_cpu |
Show process CPU% usage without averaging over the number of CPU cores. |
-W, --whole_word |
Enables whole-word matching by default while searching. |
Temperature Options
| Option | Behaviour |
|---|---|
-c, --celsius |
Use Celsius as the temperature unit. Default. |
-f, --fahrenheit |
Use Fahrenheit as the temperature unit. |
-k, --kelvin |
Use Kelvin as the temperature unit. |
CPU Options
| Option | Behaviour |
|---|---|
--cpu_left_legend |
Puts the CPU chart legend on the left side. |
--default_cpu_entry |
Sets which CPU entry type is selected by default. |
-a, --hide_avg_cpu |
Hides the average CPU usage entry. |
Memory Options
| Option | Behaviour |
|---|---|
--memory_legend <POSITION> |
Where to place the legend for the memory chart widget. |
--enable_cache_memory |
Enable collecting and displaying cache and buffer memory. |
--free_arc |
Subtract freeable ARC from memory. |
Network Options
| Option | Behaviour |
|---|---|
--network_legend <POSITION> |
Where to place the legend for the network chart widget. |
--network_use_bytes |
Displays the network widget using bytes. |
--network_use_binary_prefix |
Displays the network widget with binary prefixes. |
--network_use_log |
Displays the network widget with a log scale. |
--show_packets |
Displays packet rate and average packet size info. |
--use_old_network_legend |
(DEPRECATED) Uses a separate network legend. |
Battery Options
| Option | Behaviour |
|---|---|
--battery |
Shows the battery widget in non-custom layouts. |
GPU Options
| Option | Behaviour |
|---|---|
--disable_gpu |
Disable collecting and displaying NVIDIA and AMD GPU information. |
Style Options
| Option | Behaviour |
|---|---|
--theme <SCHEME> |
Use a built-in colour theme, use '--help' for info on the colours. |
Other Options
| Option | Behaviour |
|---|---|
-h, --help |
Prints help info (for more details use --help.) |
-V, --version |
Prints version information. |