diff options
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | docs/content/configuration/command-line-options.md | 120 | ||||
| -rw-r--r-- | docs/content/usage/general-usage.md | 2 | ||||
| -rw-r--r-- | sample_configs/default_config.toml | 2 | ||||
| -rw-r--r-- | src/constants.rs | 4 |
5 files changed, 65 insertions, 65 deletions
@@ -78,7 +78,7 @@ As (yet another) process/system visualization and management application, bottom - [Cross-platform support](https://github.com/ClementTsang/bottom#support) for Linux, macOS, and Windows, with more planned in the future. -- [Customizable behaviour](https://clementtsang.github.io/bottom/nightly/configuration/command-line-options/) that can be controlled with command-line flags or a config file, such as: +- [Customizable behaviour](https://clementtsang.github.io/bottom/nightly/configuration/command-line-options/) that can be controlled with command-line options or a config file, such as: - Custom and built-in colour themes - Customizing widget behaviour diff --git a/docs/content/configuration/command-line-options.md b/docs/content/configuration/command-line-options.md index 2f3a2fd9..2ce134b4 100644 --- a/docs/content/configuration/command-line-options.md +++ b/docs/content/configuration/command-line-options.md @@ -5,90 +5,90 @@ 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 <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. | ## 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` | 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. | ## 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. | +| `-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 | +| ---------------------- | ---------------------------- | +| `-a`, `--hide_avg_cpu` | Hides the average CPU usage. | ## 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. | +| Option | Behaviour | +| ----------------------- | --------------------------------------------------------- | +| `--enable_cache_memory` | Enable collecting and displaying cache and buffer memory. | +| `--mem_as_value` | Defaults to showing process memory usage by value. | ## 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. | -| --use_old_network_legend | DEPRECATED - uses a separate network legend. | +| 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. | +| `--use_old_network_legend` | DEPRECATED - uses a separate network legend. | ## Battery Options -| Option | Behaviour | -| --------- | ------------------------- | -| --battery | Shows the battery widget. | +| Option | Behaviour | +| ----------- | ------------------------- | +| `--battery` | Shows the battery widget. | ## GPU Options -| Option | Behaviour | -| ------------ | ------------------------------------------- | -| --enable_gpu | Enable collecting and displaying GPU usage. | +| Option | Behaviour | +| -------------- | ------------------------------------------- | +| `--enable_gpu` | Enable collecting and displaying GPU usage. | ## 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 (see more info with '--help'). | +| `-V`, `--version` | Prints version information. | diff --git a/docs/content/usage/general-usage.md b/docs/content/usage/general-usage.md index fa7f0c63..8b2ce96d 100644 --- a/docs/content/usage/general-usage.md +++ b/docs/content/usage/general-usage.md @@ -6,7 +6,7 @@ You can run bottom with: btm ``` -For help regarding the command-line flags, use: +For help regarding the command-line options, use: ```bash # For a simple overview of flags diff --git a/sample_configs/default_config.toml b/sample_configs/default_config.toml index a7731dd6..8524ea43 100644 --- a/sample_configs/default_config.toml +++ b/sample_configs/default_config.toml @@ -2,7 +2,7 @@ # out by default; if you wish to change them uncomment and modify as you see # fit. -# This group of options represents a command-line flag/option. Flags explicitly +# This group of options represents a command-line option. Flags explicitly # added when running (ie: btm -a) will override this config file if an option # is also set here. diff --git a/src/constants.rs b/src/constants.rs index f09a5d5b..eb185779 100644 --- a/src/constants.rs +++ b/src/constants.rs @@ -521,7 +521,7 @@ pub const CONFIG_TEXT: &str = r#"# This is a default config file for bottom. Al # out by default; if you wish to change them uncomment and modify as you see # fit. -# This group of options represents a command-line flag/option. Flags explicitly +# This group of options represents a command-line option. Flags explicitly # added when running (ie: btm -a) will override this config file if an option # is also set here. [flags] @@ -722,7 +722,7 @@ pub const CONFIG_TOP_HEAD: &str = r##"# This is bottom's config file. pub const CONFIG_DISPLAY_OPTIONS_HEAD: &str = r#" # These options represent settings that affect how bottom functions. -# If a setting here corresponds to command-line flag, then the flag will temporarily override +# If a setting here corresponds to command-line option, then the flag will temporarily override # the setting. "#; |