06071d5abf
A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
3.6 KiB
General Usage
You can run bottom with:
btm
For help regarding the command-line flags, use:
# For a simple overview of flags
btm -h
# For more details
btm --help
Features
Expansion
By default, bottom is somewhat like a dashboard - a bunch of different widgets, all showing different things, and they all cram together to fit into one terminal.
If you instead just want to see one widget - maybe you want to look at a graph in more detail, for example - you can "expand" the currently selected widget using the ++e++ key, which will hide all other widgets and make that widget take up all available terminal space.
You can leave this state by either pressing ++e++ again or pressing ++esc++.
Widget selection
To allow for widget-specific keybindings and expansion, there is the idea of widget selection in bottom, where you can focus on a specific widget to work with it. This can be done with the mouse (just click on the widget of interest) or keyboard (ex: ++ctrl+"Direction"++, see Key bindings for alternatives).
Key bindings
These are global or common keyboard shortcuts for the application, which you can see in-app through the ++question++ shortcut. Note that key bindings are generally case-sensitive.
| Binding | Action |
|---|---|
| ++q++ , ++ctrl+c++ | Quit |
| ++esc++ | Close dialog windows, search, widgets, or exit expanded mode |
| ++ctrl+r++ | Reset display and any collected data |
| ++f++ | Freeze/unfreeze updating with new data |
| ++question++ | Open help menu |
| ++e++ | Toggle expanding the currently selected widget |
| ++ctrl+up++ ++shift+up++ ++K++ ++W++ |
Select the widget above |
| ++ctrl+down++ ++shift+down++ ++J++ ++S++ |
Select the widget below |
| ++ctrl+left++ ++shift+left++ ++H++ ++A++ |
Select the widget on the left |
| ++ctrl+right++ ++shift+right++ ++L++ ++D++ |
Select the widget on the right |
| ++up++ , ++k++ | Move up within a widget |
| ++down++ , ++j++ | Move down within a widget |
| ++left++ ++h++ ++alt+h++ |
Move left within a widget |
| ++right++ ++l++ ++alt+l++ |
Move right within a widget |
| ++g+g++ , ++home++ | Jump to the first entry |
| ++G++ , ++end++ | Jump to the last entry |
Mouse bindings
| Binding | Action |
|---|---|
| ++lbutton++ | Selects the widget |