diff options
author | Clement Tsang <34804052+ClementTsang@users.noreply.github.com> | 2023-06-24 05:36:36 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-06-24 01:36:36 -0400 |
commit | 4ac3b432602259efbd79efefbd016eebb7966675 (patch) | |
tree | 16a7c6f0e4e5ae8f6838f6fe8c7e01e82030aea6 /docs | |
parent | cc3833289fa5063efe30c2a16da56a9b04117e1b (diff) |
docs: update time-related documentation (#1222)
* docs: update time-related documentation
* fix retention too
Diffstat (limited to 'docs')
-rw-r--r-- | docs/content/configuration/command-line-flags.md | 84 | ||||
-rw-r--r-- | docs/content/configuration/config-file/flags.md | 2 |
2 files changed, 43 insertions, 43 deletions
diff --git a/docs/content/configuration/command-line-flags.md b/docs/content/configuration/command-line-flags.md index cbaf6ee6..e0a7192f 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 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') | +| 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 <TIME> | Sets the data refresh rate. | +| -R, --regex | Enables regex by default. | +| --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. | +| -T, --tree | Defaults the process widget be in tree mode. | +| -n, --unnormalized_cpu | Show process CPU% usage 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 fd919bea..d5466041 100644 --- a/docs/content/configuration/config-file/flags.md +++ b/docs/content/configuration/config-file/flags.md @@ -20,7 +20,7 @@ each time: | `basic` | Boolean | Hides graphs and uses a more basic look. | | `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. | +| `rate` | Unsigned Int (represents milliseconds) or String (represents human time) | Sets a refresh rate in ms. | | `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. | |