tyler.durden/bottom
1
0
Fork 0
mirror of https://github.com/ClementTsang/bottom.git synced 2025-07-28 16:14:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: update help section of docs (#1139)

Browse Source 
* docs: update help section of docs a bit

* update
This commit is contained in:
Clement Tsang 2023-05-07 17:07:24 -04:00 committed by GitHub
parent e12ed777b7
commit 1111bbe831
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/content/configuration/command-line-flags.md
View File

@ -1,13 +1,10 @@
# Command-line Flags # Command-line Flags
!!! Warning The following flags can be provided to bottom in the command line to change the behaviour of the program. You can also
see information on these flags by running `btm -h`, or run `btm --help` to display more detailed information on each flag:
This section is in progress, and is just copied from the old documentation.
The following flags can be provided to bottom in the command line to change the behaviour of the program (run `btm --help` for more information on each flag):
| Flag | Behaviour | | Flag | Behaviour |
|----------------------------------------------|--------------------------------------------------------------------------------------| | -------------------------------------------- | ------------------------------------------------------------------------------------ |
| `--autohide_time` | Temporarily shows the time scale in graphs. | | `--autohide_time` | Temporarily shows the time scale in graphs. |
| `-b`, `--basic` | Hides graphs and uses a more basic look. | | `-b`, `--basic` | Hides graphs and uses a more basic look. |
| `--battery` | Shows the battery widget. | | `--battery` | Shows the battery widget. |
@ -21,7 +18,6 @@ The following flags can be provided to bottom in the command line to change the
| `--default_widget_type <WIDGET TYPE>` | Sets the default widget type, use --help for more info. | | `--default_widget_type <WIDGET TYPE>` | Sets the default widget type, use --help for more info. |
| `--disable_advanced_kill` | Hides advanced options to stop a process on Unix-like systems. | | `--disable_advanced_kill` | Hides advanced options to stop a process on Unix-like systems. |
| `--disable_click` | Disables mouse clicks. | | `--disable_click` | Disables mouse clicks. |
| `--enable_cache_memory` | Enable collecting and displaying cache and buffer memory (not available on Windows). |
| `-m`, `--dot_marker` | Uses a dot marker for graphs. | | `-m`, `--dot_marker` | Uses a dot marker for graphs. |
| `-f`, `--fahrenheit` | Sets the temperature type to Fahrenheit. | | `-f`, `--fahrenheit` | Sets the temperature type to Fahrenheit. |
| `-g`, `--group` | Groups processes with the same name by default. | | `-g`, `--group` | Groups processes with the same name by default. |
@ -45,6 +41,7 @@ The following flags can be provided to bottom in the command line to change the
| `-V`, `--version` | Prints version information. | | `-V`, `--version` | Prints version information. |
| `-W`, `--whole_word` | Enables whole-word matching by default. | | `-W`, `--whole_word` | Enables whole-word matching by default. |
| `--enable_gpu_memory` | Enable collecting and displaying GPU memory usage. | | `--enable_gpu_memory` | Enable collecting and displaying GPU memory usage. |
| `--enable_cache_memory` | Enable collecting and displaying cache and buffer memory (not available on Windows). |
| `--retention` | How much data is stored at once in terms of time. | | `--retention` | How much data is stored at once in terms of time. |
| `-n`, `--unnormalized_cpu` | Show process CPU% without normalizing over the number of cores. | | `-n`, `--unnormalized_cpu` | Show process CPU% without normalizing over the number of cores. |
| `-e`, `--expanded` | Expand the default widget upon starting the app. | | `-e`, `--expanded` | Expand the default widget upon starting the app. |

2
docs/content/usage/widgets/process.md
View File

@ -30,7 +30,7 @@ By default, the main process table displays the following information for each p
It can also additionally display the following columns: It can also additionally display the following columns:
- Process time - Process running time
See [the processes configuration page](../../configuration/config-file/processes.md) on how to customize which columns See [the processes configuration page](../../configuration/config-file/processes.md) on how to customize which columns
are shown. are shown.