diff options
| author | Clement Tsang <34804052+ClementTsang@users.noreply.github.com> | 2023-05-07 17:07:24 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-07 17:07:24 -0400 |
| commit | 1111bbe8317a97ae146fbfe022326dc2533d1b74 (patch) | |
| tree | eca522d8f6f52f7dbf86a1324659db5f4558dc60 /docs | |
| parent | e12ed777b7b4d5590d6b245ce073fcf534984ed2 (diff) | |
docs: update help section of docs (#1139)
* docs: update help section of docs a bit
* update
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/configuration/command-line-flags.md | 11 | ||||
| -rw-r--r-- | docs/content/usage/widgets/process.md | 2 |
2 files changed, 5 insertions, 8 deletions
diff --git a/docs/content/configuration/command-line-flags.md b/docs/content/configuration/command-line-flags.md index 6bf0abea..1e0af411 100644 --- a/docs/content/configuration/command-line-flags.md +++ b/docs/content/configuration/command-line-flags.md @@ -1,13 +1,10 @@ # Command-line Flags -!!! Warning - - 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): +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: | Flag | Behaviour | -|----------------------------------------------|--------------------------------------------------------------------------------------| +| -------------------------------------------- | ------------------------------------------------------------------------------------ | | `--autohide_time` | Temporarily shows the time scale in graphs. | | `-b`, `--basic` | Hides graphs and uses a more basic look. | | `--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. | | `--disable_advanced_kill` | Hides advanced options to stop a process on Unix-like systems. | | `--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. | | `-f`, `--fahrenheit` | Sets the temperature type to Fahrenheit. | | `-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. | | `-W`, `--whole_word` | Enables whole-word matching by default. | | `--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. | | `-n`, `--unnormalized_cpu` | Show process CPU% without normalizing over the number of cores. | | `-e`, `--expanded` | Expand the default widget upon starting the app. | diff --git a/docs/content/usage/widgets/process.md b/docs/content/usage/widgets/process.md index 6dd21daa..eea4cc0a 100644 --- a/docs/content/usage/widgets/process.md +++ b/docs/content/usage/widgets/process.md @@ -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: -- Process time +- Process running time See [the processes configuration page](../../configuration/config-file/processes.md) on how to customize which columns are shown. |