From 0b7f4c745dbf5ef93a0d1fbf185fd725995a74bb Mon Sep 17 00:00:00 2001 From: Clement Tsang <34804052+ClementTsang@users.noreply.github.com> Date: Thu, 22 Jun 2023 04:01:01 +0000 Subject: 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 --- docs/content/configuration/command-line-flags.md | 84 ++++++++++++------------ docs/content/configuration/config-file/flags.md | 6 +- 2 files changed, 45 insertions(+), 45 deletions(-) (limited to 'docs') 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 ` | Use a color scheme, use --help for supported values. | -| `-C `, `--config ` | Sets the location of the config file. | -| `-u`, `--current_usage` | Sets process CPU% to be based on current CPU%. | -| `-t `, `--default_time_value ` | Default time value for graphs in ms. | -| `--default_widget_count ` | Sets the n'th selected widget type as the default. | -| `--default_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 ` | 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 `, `--time_delta ` | 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 | Use a color scheme, use --help for info. | +| -C, --config | Sets the location of the config file. | +| -u, --current_usage | Sets process CPU% to be based on current CPU%. | +| -t, --default_time_value