ClementTsang/bottom
1
1
Fork 0
mirror of https://github.com/ClementTsang/bottom.git synced 2024-11-09 12:58:21 +03:00
Code Issues Projects Releases Wiki Activity

docs: use consistent wording around command-line options (#1378)

Browse Source 
* docs: use consistent wording around command-line options

* fix missing code blocks
This commit is contained in:
Clement Tsang 2024-01-11 02:14:05 -05:00 committed by GitHub
parent bc2c363a49
commit a3541c9350
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 65 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -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. - [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 - Custom and built-in colour themes
- Customizing widget behaviour - Customizing widget behaviour

120
docs/content/configuration/command-line-options.md
View File

@ -5,90 +5,90 @@ see information on these options by running `btm -h`, or run `btm --help` to dis
## General Options ## General Options
| Option | Behaviour | | Option | Behaviour |
| ----------------------------------- | --------------------------------------------------- | | ------------------------------------- | --------------------------------------------------- |
| --autohide_time | Temporarily shows the time scale in graphs. | | `--autohide_time` | Temporarily shows the time scale in graphs. |
| -b, --basic | Hides graphs and uses a more basic look. | | `-b`, `--basic` | Hides graphs and uses a more basic look. |
| -C, --config <CONFIG PATH> | Sets the location of the config file. | | `-C`, `--config <CONFIG PATH>` | Sets the location of the config file. |
| -t, --default_time_value <TIME> | Default time value for graphs. | | `-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_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. | | `--default_widget_type <WIDGET TYPE>` | Sets the default widget type, use --help for info. |
| --disable_click | Disables mouse clicks. | | `--disable_click` | Disables mouse clicks. |
| -m, --dot_marker | Uses a dot marker for graphs. | | `-m`, `--dot_marker` | Uses a dot marker for graphs. |
| -e, --expanded | Expand the default widget upon starting the app. | | `-e`, `--expanded` | Expand the default widget upon starting the app. |
| --hide_table_gap | Hides spacing between table headers and entries. | | `--hide_table_gap` | Hides spacing between table headers and entries. |
| --hide_time | Hides the time scale. | | `--hide_time` | Hides the time scale. |
| -l, --left_legend | Puts the CPU chart legend to the left side. | | `-l`, `--left_legend` | Puts the CPU chart legend to the left side. |
| -r, --rate <TIME> | Sets the data refresh rate. | | `-r`, `--rate <TIME>` | Sets the data refresh rate. |
| --retention <TIME> | The timespan of data stored. | | `--retention <TIME>` | The timespan of data stored. |
| --show_table_scroll_position | Shows the scroll position tracker in table widgets. | | `--show_table_scroll_position` | Shows the scroll position tracker in table widgets. |
| -d, --time_delta <TIME> | The amount of time changed upon zooming. | | `-d`, `--time_delta <TIME>` | The amount of time changed upon zooming. |
## Process Options ## Process Options
| Option | Behaviour | | Option | Behaviour |
| ----------------------- | --------------------------------------------------------------------- | | -------------------------- | --------------------------------------------------------------------- |
| -S, --case_sensitive | Enables case sensitivity by default. | | `-S`, `--case_sensitive` | Enables case sensitivity by default. |
| -u, --current_usage | Sets process CPU% to be based on current CPU%. | | `-u`, `--current_usage` | Sets process CPU% to be based on current CPU%. |
| --disable_advanced_kill | Hides advanced process killing. | | `--disable_advanced_kill` | Hides advanced process killing. |
| -g, --group_processes | Groups processes with the same name by default. | | `-g`, `--group_processes` | Groups processes with the same name by default. |
| --process_command | Show processes as their commands by default. | | `--process_command` | Show processes as their commands by default. |
| -R, --regex | Enables regex by default. | | `-R`, `--regex` | Enables regex by default. |
| -T, --tree | Defaults the process widget be in tree mode. | | `-T`, `--tree` | Defaults the process widget be in tree mode. |
| -n, --unnormalized_cpu | Show process CPU% usage without normalizing over the number of cores. | | `-n`, `--unnormalized_cpu` | Show process CPU% usage without normalizing over the number of cores. |
| -W, --whole_word | Enables whole-word matching by default. | | `-W`, `--whole_word` | Enables whole-word matching by default. |
## Temperature Options ## Temperature Options
| Option | Behaviour | | Option | Behaviour |
| ---------------- | --------------------------------------- | | -------------------- | --------------------------------------- |
| -c, --celsius | Use Celsius as the temperature unit. | | `-c`, `--celsius` | Use Celsius as the temperature unit. |
| -f, --fahrenheit | Use Fahrenheit as the temperature unit. | | `-f`, `--fahrenheit` | Use Fahrenheit as the temperature unit. |
| -k, --kelvin | Use Kelvin as the temperature unit. | | `-k`, `--kelvin` | Use Kelvin as the temperature unit. |
## CPU Options ## CPU Options
| Option | Behaviour | | Option | Behaviour |
| ------------------ | ---------------------------- | | ---------------------- | ---------------------------- |
| -a, --hide_avg_cpu | Hides the average CPU usage. | | `-a`, `--hide_avg_cpu` | Hides the average CPU usage. |
## Memory Options ## Memory Options
| Option | Behaviour | | Option | Behaviour |
| --------------------- | --------------------------------------------------------- | | ----------------------- | --------------------------------------------------------- |
| --enable_cache_memory | Enable collecting and displaying cache and buffer memory. | | `--enable_cache_memory` | Enable collecting and displaying cache and buffer memory. |
| --mem_as_value | Defaults to showing process memory usage by value. | | `--mem_as_value` | Defaults to showing process memory usage by value. |
## Network Options ## Network Options
| Option | Behaviour | | Option | Behaviour |
| --------------------------- | ------------------------------------------------- | | ----------------------------- | ------------------------------------------------- |
| --network_use_binary_prefix | Displays the network widget with binary prefixes. | | `--network_use_binary_prefix` | Displays the network widget with binary prefixes. |
| --network_use_bytes | Displays the network widget using bytes. | | `--network_use_bytes` | Displays the network widget using bytes. |
| --network_use_log | Displays the network widget with a log scale. | | `--network_use_log` | Displays the network widget with a log scale. |
| --use_old_network_legend | DEPRECATED - uses a separate network legend. | | `--use_old_network_legend` | DEPRECATED - uses a separate network legend. |
## Battery Options ## Battery Options
| Option | Behaviour | | Option | Behaviour |
| --------- | ------------------------- | | ----------- | ------------------------- |
| --battery | Shows the battery widget. | | `--battery` | Shows the battery widget. |
## GPU Options ## GPU Options
| Option | Behaviour | | Option | Behaviour |
| ------------ | ------------------------------------------- | | -------------- | ------------------------------------------- |
| --enable_gpu | Enable collecting and displaying GPU usage. | | `--enable_gpu` | Enable collecting and displaying GPU usage. |
## Style Options ## Style Options
| Option | Behaviour | | Option | Behaviour |
| ---------------------- | ---------------------------------------- | | ------------------------ | ---------------------------------------- |
| --color <COLOR SCHEME> | Use a color scheme, use --help for info. | | `--color <COLOR SCHEME>` | Use a color scheme, use --help for info. |
## Other Options ## Other Options
| Option | Behaviour | | Option | Behaviour |
| ------------- | ------------------------------------------ | | ----------------- | ------------------------------------------ |
| -h, --help | Prints help (see more info with '--help'). | | `-h`, `--help` | Prints help (see more info with '--help'). |
| -V, --version | Prints version information. | | `-V`, `--version` | Prints version information. |

2
docs/content/usage/general-usage.md
View File

@ -6,7 +6,7 @@ You can run bottom with:
btm btm
``` ```
For help regarding the command-line flags, use: For help regarding the command-line options, use:
```bash ```bash
# For a simple overview of flags # For a simple overview of flags

2
sample_configs/default_config.toml
View File

@ -2,7 +2,7 @@
# out by default; if you wish to change them uncomment and modify as you see # out by default; if you wish to change them uncomment and modify as you see
# fit. # 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 # added when running (ie: btm -a) will override this config file if an option
# is also set here. # is also set here.

4
src/constants.rs
View File

@ -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 # out by default; if you wish to change them uncomment and modify as you see
# fit. # 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 # added when running (ie: btm -a) will override this config file if an option
# is also set here. # is also set here.
[flags] [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#" pub const CONFIG_DISPLAY_OPTIONS_HEAD: &str = r#"
# These options represent settings that affect how bottom functions. # 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. # the setting.
"#; "#;