Mirrors/bottom
2
0
Fork 0
mirror of https://github.com/ClementTsang/bottom synced 2024-12-13 14:12:31 +00:00
Code Issues Projects Releases Packages Wiki Activity
bottom/docs/content/usage/widgets/cpu.md

56 lines
2.2 KiB
Markdown
Raw Normal View History

docs: migrate documentation over to mkdocs (#506) 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.
2021-06-21 05:40:58 +00:00
# CPU Widget
The CPU widget displays a visual representation of CPU usage over a time range.
<figure>
docs: Switch to webp, fix some sections (#514) Switches to webp and fixes some typos/poor wording.
2021-06-22 02:53:25 +00:00
<img src="../../../assets/screenshots/cpu.webp" alt="A picture of an expanded CPU widget showing average CPU usage."/>
docs: migrate documentation over to mkdocs (#506) 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.
2021-06-21 05:40:58 +00:00
</figure>
## Features
The CPU widget is composed of two parts: the graph and the legend:
- The graph displays the usage data for the currently selected entry as a percentage
- The legend displays all available entries that can be displayed on the graph along with their last recorded use percentage (except for the "All" option)
Users can scroll through the legend using either the keyboard or mouse to select which entry to display on the graph. The "All" option shows every entry
at the same time, though this may get a bit hard to follow if you have a large number of cores/threads.
One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s.
## Key bindings
Note that key bindings are generally case-sensitive.
### Graph
| Binding | Action |
| --------- | --------------------------------------- |
| ++plus++ | Zoom in on chart (decrease time range) |
| ++minus++ | Zoom out on chart (increase time range) |
| ++equal++ | Reset zoom |
### Legend
| Binding | Action |
| ------------------ | ------------------------------------- |
| ++up++ , ++k++ | Move up within a widget |
| ++down++ , ++j++ | Move down within a widget |
| ++g+g++ , ++home++ | Jump to the first entry in the legend |
| ++G++ , ++end++ | Jump to the last entry in the legend |
## Mouse bindings
### Graph
| Binding | Action |
| ------------ | -------------------------------------------------------------- |
| ++"Scroll"++ | Scrolling up or down zooms in or out of the graph respectively |
### Legend
| Binding | Action |
| ------------ | ------------------------------------------------- |
| ++"Scroll"++ | Scroll through options to display in the graph |
| ++lbutton++ | Selects a CPU thread/average to show in the graph |
Reference in a new issue Copy permalink