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

46 lines
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
# Disk Widget
The disk widget provides a table of useful disk and partition information, like I/O per second and total usage.
<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/disk.webp" alt="A picture of an expanded disk widget."/>
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 disk widget provides the following information:
- Disk name
- Disk mount location
docs: update changelog and missing doc info (#1018)
2023-02-11 07:48:23 +00:00
- Amount of space used
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
- Amount of space left
- Total amount of space
docs: update changelog and missing doc info (#1018)
2023-02-11 07:48:23 +00:00
- Percentage of space used
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
- Read per second
- Write per second
## Key bindings
Note that key bindings are generally case-sensitive.
docs: update docs for disk sorting feature (#871) * update changelog * update mkdocs
2022-11-06 07:26:36 +00:00
| 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 |
| ++d++ | Sort by disk, press again to reverse sorting order |
| ++m++ | Sort by mount, press again to reverse sorting order |
| ++u++ | Sort by amount used, press again to reverse sorting order |
| ++n++ | Sort by amount free, press again to reverse sorting order |
| ++t++ | Sort by total space available, press again to reverse sorting order |
other: re-enable disk usage split, update help menu (#963) * Revert "other: revert disk usage change for now (#962)" This reverts commit d3661c23200a66c7dc01f4e534d8d7e97dc188d2. * some cleanup * update help menu * update screenshot * update changelog wording * Remove redundant newlines * Use type system to ensure help constants match in size
2023-01-19 10:40:34 +00:00
| ++p++ | Sort by percentage used, press again to reverse sorting order |
docs: update docs for disk sorting feature (#871) * update changelog * update mkdocs
2022-11-06 07:26:36 +00:00
| ++r++ | Sort by read rate, press again to reverse sorting order |
| ++w++ | Sort by write rate, press again to reverse sorting order |
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
## Mouse bindings
| Binding | Action |
| ----------- | ----------------------------- |
| ++lbutton++ | Selects an entry in the table |
Reference in a new issue Copy permalink