summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorClement Tsang <34804052+ClementTsang@users.noreply.github.com>2024-04-11 00:46:35 +0000
committerGitHub <noreply@github.com>2024-04-10 20:46:35 -0400
commit93d67187664fc43814955fbf94511bbfb2cf6eca (patch)
tree7a1a38d228025ef50b2770cd65866074725c2e0b /docs
parentbb0bc8a0b0efb92d6e99ec46ca08d7b2d9652e57 (diff)
other: update a bunch of argument descriptions and some arg/config names (#1441)
* other: update a bunch of argument descriptions and some arg/config names * update docs * changelog
Diffstat (limited to 'docs')
-rw-r--r--docs/content/configuration/command-line-options.md118
-rw-r--r--docs/content/configuration/config-file/flags.md4
2 files changed, 61 insertions, 61 deletions
diff --git a/docs/content/configuration/command-line-options.md b/docs/content/configuration/command-line-options.md
index e0c6286b..9d95fc96 100644
--- a/docs/content/configuration/command-line-options.md
+++ b/docs/content/configuration/command-line-options.md
@@ -5,76 +5,76 @@ see information on these options by running `btm -h`, or run `btm --help` to dis
## General Options
-| Option | Behaviour |
-| ------------------------------------- | --------------------------------------------------- |
-| `--autohide_time` | Temporarily shows the time scale in graphs. |
-| `-b`, `--basic` | Hides graphs and uses a more basic look. |
-| `-C`, `--config <CONFIG PATH>` | Sets the location of the config file. |
-| `-t`, `--default_time_value <TIME>` | Default time value for graphs. |
-| `--default_widget_count <INT>` | Sets the n'th selected widget type as the default. |
-| `--default_widget_type <WIDGET TYPE>` | Sets the default widget type, use --help for info. |
-| `--disable_click` | Disables mouse clicks. |
-| `-m`, `--dot_marker` | Uses a dot marker for graphs. |
-| `-e`, `--expanded` | Expand the default widget upon starting the app. |
-| `--hide_table_gap` | Hides spacing between table headers and entries. |
-| `--hide_time` | Hides the time scale. |
-| `-l`, `--left_legend` | Puts the CPU chart legend to the left side. |
-| `-r`, `--rate <TIME>` | Sets the data refresh rate. |
-| `--retention <TIME>` | The timespan of data stored. |
-| `--show_table_scroll_position` | Shows the scroll position tracker in table widgets. |
-| `-d`, `--time_delta <TIME>` | The amount of time changed upon zooming. |
+| Option | Behaviour |
+| --------------------------------- | ---------------------------------------------------- |
+| `--autohide_time` | Temporarily shows the time scale in graphs. |
+| `-b, --basic` | Hides graphs and uses a more basic look. |
+| `-C, --config <CONFIG PATH>` | Sets the location of the config file. |
+| `-t, --default_time_value <TIME>` | Default time value for graphs. |
+| `--default_widget_count <N>` | Sets the N'th selected widget type as the default. |
+| `--default_widget_type <WIDGET>` | Sets the default widget type, use `--help` for info. |
+| `--disable_click` | Disables mouse clicks. |
+| `-m, --dot_marker` | Uses a dot marker for graphs. |
+| `-e, --expanded` | Expand the default widget upon starting the app. |
+| `--hide_table_gap` | Hides spacing between table headers and entries. |
+| `--hide_time` | Hides the time scale from being shown. |
+| `-r, --rate <TIME>` | Sets how often data is refreshed. |
+| `--retention <TIME>` | How far back data will be stored up to. |
+| `--show_table_scroll_position` | Shows the scroll position tracker in table widgets. |
+| `-d, --time_delta <TIME>` | The amount of time changed upon zooming. |
## Process Options
-| Option | Behaviour |
-| -------------------------- | --------------------------------------------------------------------- |
-| `-S`, `--case_sensitive` | Enables case sensitivity by default. |
-| `-u`, `--current_usage` | Sets process CPU% to be based on current CPU%. |
-| `--disable_advanced_kill` | Hides advanced process killing. |
-| `-g`, `--group_processes` | Groups processes with the same name by default. |
-| `--process_command` | Show processes as their commands by default. |
-| `-R`, `--regex` | Enables regex by default. |
-| `-T`, `--tree` | Defaults the process widget be in tree mode. |
-| `-n`, `--unnormalized_cpu` | Show process CPU% usage without normalizing over the number of cores. |
-| `-W`, `--whole_word` | Enables whole-word matching by default. |
+| Option | Behaviour |
+| ------------------------- | -------------------------------------------------------------------------------------- |
+| `-S, --case_sensitive` | Enables case sensitivity by default. |
+| `-u, --current_usage` | Calculates process CPU usage as a percentage of current usage rather than total usage. |
+| `--disable_advanced_kill` | Hides additional stopping options Unix-like systems. |
+| `-g, --group_processes` | Groups processes with the same name by default. |
+| `--mem_as_value` | Defaults to showing process memory usage by value. |
+| `--process_command` | Shows the full command name instead of the process name by default. |
+| `-R, --regex` | Enables regex by default while searching. |
+| `-T, --tree` | Makes the process widget use tree mode by default. |
+| `-n, --unnormalized_cpu` | Show process CPU% usage without averaging over the number of CPU cores. |
+| `-W, --whole_word` | Enables whole-word matching by default while searching. |
## Temperature Options
-| Option | Behaviour |
-| -------------------- | --------------------------------------- |
-| `-c`, `--celsius` | Use Celsius as the temperature unit. |
-| `-f`, `--fahrenheit` | Use Fahrenheit as the temperature unit. |
-| `-k`, `--kelvin` | Use Kelvin as the temperature unit. |
+| Option | Behaviour |
+| ------------------ | --------------------------------------------- |
+| `-c, --celsius` | Use Celsius as the temperature unit. Default. |
+| `-f, --fahrenheit` | Use Fahrenheit as the temperature unit. |
+| `-k, --kelvin` | Use Kelvin as the temperature unit. |
## CPU Options
-| Option | Behaviour |
-| ---------------------- | ---------------------------- |
-| `-a`, `--hide_avg_cpu` | Hides the average CPU usage. |
+| Option | Behaviour |
+| -------------------- | ------------------------------------------- |
+| `--cpu_left_legend` | Puts the CPU chart legend on the left side. |
+| `-a, --hide_avg_cpu` | Hides the average CPU usage entry. |
## Memory Options
-| Option | Behaviour |
-| ----------------------- | --------------------------------------------------------- |
-| `--enable_cache_memory` | Enable collecting and displaying cache and buffer memory. |
-| `--mem_as_value` | Defaults to showing process memory usage by value. |
-| `--memory_legend` | Where to place the legend for the memory widget. |
+| Option | Behaviour |
+| ---------------------------- | --------------------------------------------------------- |
+| `--enable_cache_memory` | Enable collecting and displaying cache and buffer memory. |
+| `--memory_legend <POSITION>` | Where to place the legend for the memory chart widget. |
## Network Options
-| Option | Behaviour |
-| ----------------------------- | ------------------------------------------------- |
-| `--network_use_binary_prefix` | Displays the network widget with binary prefixes. |
-| `--network_use_bytes` | Displays the network widget using bytes. |
-| `--network_use_log` | Displays the network widget with a log scale. |
-| `--network_legend` | Where to place the legend for the network widget. |
-| `--use_old_network_legend` | DEPRECATED - uses a separate network legend. |
+| Option | Behaviour |
+| ----------------------------- | ------------------------------------------------------- |
+| `--network_legend <POSITION>` | Where to place the legend for the network chart widget. |
+| `--network_use_binary_prefix` | Displays the network widget with binary prefixes. |
+| `--network_use_bytes` | Displays the network widget using bytes. |
+| `--network_use_log` | Displays the network widget with a log scale. |
+| `--use_old_network_legend` | (DEPRECATED) Uses a separated network legend. |
## Battery Options
-| Option | Behaviour |
-| ----------- | ------------------------- |
-| `--battery` | Shows the battery widget. |
+| Option | Behaviour |
+| ----------- | ----------------------------------------------- |
+| `--battery` | Shows the battery widget in non-custom layouts. |
## GPU Options
@@ -84,13 +84,13 @@ see information on these options by running `btm -h`, or run `btm --help` to dis
## Style Options
-| Option | Behaviour |
-| ------------------------ | ---------------------------------------- |
-| `--color <COLOR SCHEME>` | Use a color scheme, use --help for info. |
+| Option | Behaviour |
+| ------------------------ | ------------------------------------------ |
+| `--color <COLOR SCHEME>` | Use a color scheme, use `--help` for info. |
## Other Options
-| Option | Behaviour |
-| ----------------- | ------------------------------------------ |
-| `-h`, `--help` | Prints help (see more info with '--help'). |
-| `-V`, `--version` | Prints version information. |
+| Option | Behaviour |
+| ----------------- | ------------------------------------------------- |
+| `-h`, `--help` | Prints help info (for more details use `--help`.) |
+| `-V`, `--version` | Prints version information. |
diff --git a/docs/content/configuration/config-file/flags.md b/docs/content/configuration/config-file/flags.md
index f8bacfbb..90a8d59f 100644
--- a/docs/content/configuration/config-file/flags.md
+++ b/docs/content/configuration/config-file/flags.md
@@ -11,7 +11,7 @@ each time:
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------- |
| `hide_avg_cpu` | Boolean | Hides the average CPU usage. |
| `dot_marker` | Boolean | Uses a dot marker for graphs. |
-| `left_legend` | Boolean | Puts the CPU chart legend to the left side. |
+| `cpu_left_legend` | Boolean | Puts the CPU chart legend to the left side. |
| `current_usage` | Boolean | Sets process CPU% to be based on current CPU%. |
| `group_processes` | Boolean | Groups processes with the same name by default. |
| `case_sensitive` | Boolean | Enables case sensitivity by default. |
@@ -41,6 +41,6 @@ each time:
| `enable_gpu` | Boolean | Shows the GPU widgets. |
| `retention` | String (human readable time, such as "10m", "1h", etc.) | How much data is stored at once in terms of time. |
| `unnormalized_cpu` | Boolean | Show process CPU% without normalizing over the number of cores. |
-| `expanded_on_startup` | Boolean | Expand the default widget upon starting the app. |
+| `expanded` | Boolean | Expand the default widget upon starting the app. |
| `memory_legend` | String (one of ["none", "top-left", "top", "top-right", "left", "right", "bottom-left", "bottom", "bottom-right"]) | Where to place the legend for the memory widget. |
| `network_legend` | String (one of ["none", "top-left", "top", "top-right", "left", "right", "bottom-left", "bottom", "bottom-right"]) | Where to place the legend for the network widget. |