summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorClement Tsang <34804052+ClementTsang@users.noreply.github.com>2023-06-22 04:01:01 +0000
committerGitHub <noreply@github.com>2023-06-22 00:01:01 -0400
commit0b7f4c745dbf5ef93a0d1fbf185fd725995a74bb (patch)
treedfce690975ce6a8f8014cb0d3f2492bf04aa8e9e /docs
parent6f1a8f7e5b2dd2aad8913da4d1b60a9433779b6f (diff)
other: fix humantime-related documentation, add tests, support numbers + strings in toml (#1220)
* update documentation and support either numerical times or human times for time_delta and default_time_value * update docs * give more human times on error
Diffstat (limited to 'docs')
-rw-r--r--docs/content/configuration/command-line-flags.md84
-rw-r--r--docs/content/configuration/config-file/flags.md6
2 files changed, 45 insertions, 45 deletions
diff --git a/docs/content/configuration/command-line-flags.md b/docs/content/configuration/command-line-flags.md
index 1e0af411..cbaf6ee6 100644
--- a/docs/content/configuration/command-line-flags.md
+++ b/docs/content/configuration/command-line-flags.md
@@ -3,45 +3,45 @@
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. |
-| `-S`, `--case_sensitive` | Enables case sensitivity by default. |
-| `-c`, `--celsius` | Sets the temperature type to Celsius. |
-| `--color <COLOR SCHEME>` | Use a color scheme, use --help for supported values. |
-| `-C <CONFIG PATH>`, `--config <CONFIG PATH>` | Sets the location of the config file. |
-| `-u`, `--current_usage` | Sets process CPU% to be based on current CPU%. |
-| `-t <MS>`, `--default_time_value <MS>` | Default time value for graphs in ms. |
-| `--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 more info. |
-| `--disable_advanced_kill` | Hides advanced options to stop a process on Unix-like systems. |
-| `--disable_click` | Disables mouse clicks. |
-| `-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. |
-| `-h`, `--help` | Prints help information. Use --help for more info. |
-| `-a`, `--hide_avg_cpu` | Hides the average CPU usage. |
-| `--hide_table_gap` | Hides the spacing between table headers and entries. |
-| `--hide_time` | Hides the time scale. |
-| `-k`, `--kelvin` | Sets the temperature type to Kelvin. |
-| `-l`, `--left_legend` | Puts the CPU chart legend to the left side. |
-| `--mem_as_value` | Defaults to showing process memory usage by value. |
-| `--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. |
-| `--process_command` | Show processes as their commands by default. |
-| `-r`, `--rate <MS>` | Sets a refresh rate in ms. |
-| `-R`, `--regex` | Enables regex by default. |
-| `--show_table_scroll_position` | Shows the scroll position tracker in table widgets. |
-| `-d <MS>`, `--time_delta <MS>` | The amount in ms changed upon zooming. |
-| `-T`, `--tree` | Defaults to showing the process widget in tree mode. |
-| `--use_old_network_legend` | DEPRECATED - uses the older network legend. |
-| `-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. |
+| 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. |
+| -S, --case_sensitive | Enables case sensitivity by default. |
+| -c, --celsius | Sets the temperature type to Celsius. |
+| --color <COLOR SCHEME> | Use a color scheme, use --help for info. |
+| -C, --config <CONFIG PATH> | Sets the location of the config file. |
+| -u, --current_usage | Sets process CPU% to be based on current CPU%. |
+| -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_advanced_kill | Hides advanced process killing. |
+| --disable_click | Disables mouse clicks. |
+| -m, --dot_marker | Uses a dot marker for graphs. |
+| --enable_cache_memory | Enable collecting and displaying cache and buffer memory. |
+| --enable_gpu_memory | Enable collecting and displaying GPU memory usage. |
+| -e, --expanded | Expand the default widget upon starting the app. |
+| -f, --fahrenheit | Sets the temperature type to Fahrenheit. |
+| -g, --group | Groups processes with the same name by default. |
+| -a, --hide_avg_cpu | Hides the average CPU usage. |
+| --hide_table_gap | Hides spacing between table headers and entries. |
+| --hide_time | Hides the time scale. |
+| -k, --kelvin | Sets the temperature type to Kelvin. |
+| -l, --left_legend | Puts the CPU chart legend to the left side. |
+| --mem_as_value | Defaults to showing process memory usage by value. |
+| --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. |
+| --process_command | Show processes as their commands by default. |
+| -r, --rate <MS> | Sets a refresh rate in ms. |
+| -R, --regex | Enables regex by default. |
+| --retention <TIME> | The timespan of data kept. |
+| --show_table_scroll_position | Shows the scroll position tracker in table widgets. |
+| -d, --time_delta <TIME> | The amount of time changed upon zooming. |
+| -T, --tree | Defaults the process widget be in tree mode. |
+| -n, --unnormalized_cpu | Show process CPU% without normalizing over the number of cores. |
+| --use_old_network_legend | DEPRECATED - uses a separate network legend. |
+| -V, --version | Prints version information. |
+| -W, --whole_word | Enables whole-word matching by default. |
+| -h, --help | Print help (see more with '--help') |
diff --git a/docs/content/configuration/config-file/flags.md b/docs/content/configuration/config-file/flags.md
index b3a6362c..fd919bea 100644
--- a/docs/content/configuration/config-file/flags.md
+++ b/docs/content/configuration/config-file/flags.md
@@ -8,7 +8,7 @@ Most of the [command line flags](../../command-line-flags) have config file equi
each time:
| Field | Type | Functionality |
-|------------------------------|------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
+| ---------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `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. |
@@ -21,8 +21,8 @@ each time:
| `use_old_network_legend` | Boolean | DEPRECATED - uses the older network legend. |
| `battery` | Boolean | Shows the battery widget. |
| `rate` | Unsigned Int (represents milliseconds) | Sets a refresh rate in ms. |
-| `default_time_value` | Unsigned Int (represents milliseconds) | Default time value for graphs in ms. |
-| `time_delta` | Unsigned Int (represents milliseconds) | The amount in ms changed upon zooming. |
+| `default_time_value` | Unsigned Int (represents milliseconds) or String (represents human time) | Default time value for graphs in ms. |
+| `time_delta` | Unsigned Int (represents milliseconds) or String (represents human time) | The amount in ms changed upon zooming. |
| `hide_time` | Boolean | Hides the time scale. |
| `temperature_type` | String (one of ["k", "f", "c", "kelvin", "fahrenheit", "celsius"]) | Sets the temperature unit type. |
| `default_widget_type` | String (one of ["cpu", "proc", "net", "temp", "mem", "disk"], same as layout options) | Sets the default widget type, use --help for more info. |