diff options
author | Clement Tsang <34804052+ClementTsang@users.noreply.github.com> | 2024-01-11 00:25:53 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-01-11 00:25:53 -0500 |
commit | bc2c363a49b185a629e2ce145c7cd94631af9ab2 (patch) | |
tree | 0ae612ee4521c524a9f5f308d05208dd6c25b70e /docs | |
parent | 6b6217655479df639c9ad7f6324939eae4f81cea (diff) |
refactor: clean up arg code more (#1377)
* fix sort function
* Try macros
* Revert "Try macros"
This reverts commit 93c7306f8ae8b906e0a66d1a4d758aad51efe3eb.
* use next_help_heading instead
* test
* Revert "test"
This reverts commit 017a1702b35dd7fd87c449e27a3bdb65bc858f72.
* Reapply "test"
This reverts commit 23c09d3828594d880ecf5e753e1fcdf5fd719e42.
* use foldl instead :)
* a word
* different conditionals
* update docs, change ordering
* more formatting stuff
Diffstat (limited to 'docs')
-rw-r--r-- | docs/content/configuration/command-line-flags.md | 47 | ||||
-rw-r--r-- | docs/content/configuration/command-line-options.md | 94 | ||||
-rw-r--r-- | docs/content/configuration/config-file/flags.md | 2 | ||||
-rw-r--r-- | docs/content/index.md | 2 | ||||
-rw-r--r-- | docs/content/usage/widgets/network.md | 2 | ||||
-rw-r--r-- | docs/mkdocs.yml | 2 |
6 files changed, 98 insertions, 51 deletions
diff --git a/docs/content/configuration/command-line-flags.md b/docs/content/configuration/command-line-flags.md deleted file mode 100644 index e2ab53ae..00000000 --- a/docs/content/configuration/command-line-flags.md +++ /dev/null @@ -1,47 +0,0 @@ -# Command-line Flags - -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 | Enable collecting and displaying GPU usage. | -| -e, --expanded | Expand the default widget upon starting the app. | -| -f, --fahrenheit | Sets the temperature type to Fahrenheit. | -| -g, --group_processes | 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/command-line-options.md b/docs/content/configuration/command-line-options.md new file mode 100644 index 00000000..2f3a2fd9 --- /dev/null +++ b/docs/content/configuration/command-line-options.md @@ -0,0 +1,94 @@ +# Command-line Options + +The following options can be provided to bottom in the command line to change the behaviour of the program. You can also +see information on these options by running `btm -h`, or run `btm --help` to display more detailed information on each option: + +## 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. | + +## 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. | + +## 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. | + +## CPU Options + +| 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. | + +## 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. | + +## Battery Options + +| Option | Behaviour | +| --------- | ------------------------- | +| --battery | Shows the battery widget. | + +## GPU Options + +| 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. | + +## Other Options + +| Option | Behaviour | +| ------------- | ------------------------------------------ | +| -h, --help | Prints help (see more info with '--help'). | +| -V, --version | Prints version information. | diff --git a/docs/content/configuration/config-file/flags.md b/docs/content/configuration/config-file/flags.md index ed9d0aef..c110af6d 100644 --- a/docs/content/configuration/config-file/flags.md +++ b/docs/content/configuration/config-file/flags.md @@ -4,7 +4,7 @@ This section is in progress, and is just copied from the old documentation. -Most of the [command line flags](../command-line-flags.md) have config file equivalents to avoid having to type them out +Most of the [command line flags](../command-line-options.md) have config file equivalents to avoid having to type them out each time: | Field | Type | Functionality | diff --git a/docs/content/index.md b/docs/content/index.md index 2977f67f..39969b9a 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -31,7 +31,7 @@ which contains a list of all the installation methods. You can refer to the [usage](usage/general-usage.md) pages on how to use bottom (e.g. keybinds, some features, a general overview of what each widget does). -To configure bottom, refer to the [configuration](configuration/command-line-flags.md) pages (e.g. how it behaves, how it looks). +To configure bottom, refer to the [configuration](configuration/command-line-options.md) pages (e.g. how it behaves, how it looks). ## Contribution diff --git a/docs/content/usage/widgets/network.md b/docs/content/usage/widgets/network.md index 96369f87..9cf1e9e2 100644 --- a/docs/content/usage/widgets/network.md +++ b/docs/content/usage/widgets/network.md @@ -12,7 +12,7 @@ received and transmitted. The legend displays the current reads and writes per second in bits, as well as the total amount read/written. The y-axis automatically scales based on shown read/write values, and by default, is a linear scale based on base-10 units (e.x. kilobit, gigabit, etc.). -Through [configuration](../../configuration/command-line-flags.md), the read/write per second unit can be changed to bytes, while the y-axis can be changed to a +Through [configuration](../../configuration/command-line-options.md), the read/write per second unit can be changed to bytes, while the y-axis can be changed to a log scale and/or use base-2 units (e.x. kibibit, gibibit, etc.). One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 81a484c1..f76d26cb 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -140,7 +140,7 @@ nav: - "Temperature Widget": usage/widgets/temperature.md - "Battery Widget": usage/widgets/battery.md - "Configuration": - - "Command-line Flags": configuration/command-line-flags.md + - "Command-line Flags": configuration/command-line-options.md - "Config File": - "Default Config": configuration/config-file/default-config.md - "Flags": configuration/config-file/flags.md |