mirror of
https://github.com/ClementTsang/bottom.git
synced 2025-10-17 13:29:30 +02:00
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.
37 lines
1.0 KiB
Markdown
37 lines
1.0 KiB
Markdown
# Disk Widget
|
|
|
|
The disk widget provides a table of useful disk and partition information, like I/O per second and total usage.
|
|
|
|
<figure>
|
|
<img src="../../../assets/screenshots/disk.png" alt="A picture of an expanded disk widget."/>
|
|
</figure>
|
|
|
|
## Features
|
|
|
|
The disk widget provides the following information:
|
|
|
|
- Disk name
|
|
- Disk mount location
|
|
- Percentage of space used
|
|
- Amount of space left
|
|
- Total amount of space
|
|
- Read per second
|
|
- Write per second
|
|
|
|
## Key bindings
|
|
|
|
Note that key bindings are generally case-sensitive.
|
|
|
|
| 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 table |
|
|
| ++G++ , ++end++ | Jump to the last entry in the table |
|
|
|
|
## Mouse bindings
|
|
|
|
| Binding | Action |
|
|
| ----------- | ----------------------------- |
|
|
| ++lbutton++ | Selects an entry in the table |
|