diff options
| author | Twan Stok <twanstok@gmail.com> | 2023-04-13 04:51:41 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-12 22:51:41 -0400 |
| commit | 1b1e80ec3cf51804204982d6c39f0b64ac735a69 (patch) | |
| tree | 77bacd1b76000bc14ccc8fed26daf78aef4a4550 /docs | |
| parent | e61e5f2af6b5f533461e15bb04250e9ad94a6627 (diff) | |
feature: add buffer and cache memory (#1063)
* First implementation of cache memory data collection, mostly copied from RAM and swap implementations
* First implementation of cache memory display, copied from RAM and swap implementations. placed cache as second in the list as it is more similar to the RAM than any other item in the list
* expanded comment to explain method.
* rustfmt
* all cache-related code excluded on windows, in the process refactored src/data_conversion.rs convert_mem_label() to convert a single label instead of all at once
* better factoring-out of cache memory logic to allow individual disabling
* added --enable_cache_memory flag, disabled cache memory collection by default
* renamed CCH to CHE
not sure how i messed that up
* changelog updated
* Added command line flag documentation
* updated config file documentation
* specified that buffer and cache memory display does not work on windows
* resolved merge conflicts
* added documentation to cache memory data collection
* capitalized Windows
* implemented missing canvas styling logic
* fixed misplaced no-windows flag
* reduced colour collisions, as cache colour was the same as the first GPU colour
* made FIFTH_COLOUR constant windows-only
* Revert "made FIFTH_COLOUR constant windows-only"
This reverts commit 72698f1dd7e2de7dbda843708ece6a3dba66f94f.
* made FIFTH_COLOUR constant non-windows-only
* minor fix for basic mode row count
* Update src/app/data_harvester/memory/sysinfo.rs
Co-authored-by: Clement Tsang <34804052+ClementTsang@users.noreply.github.com>
* Update src/canvas/widgets/mem_basic.rs
Co-authored-by: Clement Tsang <34804052+ClementTsang@users.noreply.github.com>
* updated default_config.toml
* formatting
---------
Co-authored-by: ClementTsang <34804052+ClementTsang@users.noreply.github.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/configuration/command-line-flags.md | 83 | ||||
| -rw-r--r-- | docs/content/configuration/config-file/flags.md | 72 |
2 files changed, 79 insertions, 76 deletions
diff --git a/docs/content/configuration/command-line-flags.md b/docs/content/configuration/command-line-flags.md index 86fad044..6bf0abea 100644 --- a/docs/content/configuration/command-line-flags.md +++ b/docs/content/configuration/command-line-flags.md @@ -6,44 +6,45 @@ The following flags can be provided to bottom in the command line to change the behaviour of the program (run `btm --help` for more 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 supported values. | -| `-C <CONFIG PATH>`, `--config <CONFIG PATH>` | Sets the location of the config file. | -| `-u`, `--current_usage` | Sets process CPU% to be based on current CPU%. | -| `-t <MS>`, `--default_time_value <MS>` | Default time value for graphs in ms. | -| `--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 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 <MS>` | 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 <MS>`, `--time_delta <MS>` | 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. | -| `--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 <COLOR SCHEME>` | Use a color scheme, use --help for supported values. | +| `-C <CONFIG PATH>`, `--config <CONFIG PATH>` | Sets the location of the config file. | +| `-u`, `--current_usage` | Sets process CPU% to be based on current CPU%. | +| `-t <MS>`, `--default_time_value <MS>` | Default time value for graphs in ms. | +| `--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 more info. | +| `--disable_advanced_kill` | Hides advanced options to stop a process on Unix-like systems. | +| `--disable_click` | Disables mouse clicks. | +| `--enable_cache_memory` | Enable collecting and displaying cache and buffer memory (not available on Windows). | +| `-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 <MS>` | 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 <MS>`, `--time_delta <MS>` | 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. | +| `--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. | diff --git a/docs/content/configuration/config-file/flags.md b/docs/content/configuration/config-file/flags.md index af84fcbd..b3a6362c 100644 --- a/docs/content/configuration/config-file/flags.md +++ b/docs/content/configuration/config-file/flags.md @@ -4,39 +4,41 @@ This section is in progress, and is just copied from the old documentation. -Most of the [command line flags](../../command-line-flags) have config file equivalents to avoid having to type them out each time: +Most of the [command line flags](../../command-line-flags) have config file equivalents to avoid having to type them out +each time: -| Field | Type | Functionality | -| ---------------------------- | ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | -| `hide_avg_cpu` | Boolean | Hides the average CPU usage. | -| `dot_marker` | Boolean | Uses a dot marker for graphs. | -| `left_legend` | Boolean | Puts the CPU chart legend to the left side. | -| `current_usage` | Boolean | Sets process CPU% to be based on current CPU%. | -| `group_processes` | Boolean | Groups processes with the same name by default. | -| `case_sensitive` | Boolean | Enables case sensitivity by default. | -| `whole_word` | Boolean | Enables whole-word matching by default. | -| `regex` | Boolean | Enables regex by default. | -| `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. | -| `default_time_value` | Unsigned Int (represents milliseconds) | Default time value for graphs in ms. | -| `time_delta` | Unsigned Int (represents milliseconds) | The amount in ms changed upon zooming. | -| `hide_time` | Boolean | Hides the time scale. | -| `temperature_type` | String (one of ["k", "f", "c", "kelvin", "fahrenheit", "celsius"]) | Sets the temperature unit type. | -| `default_widget_type` | String (one of ["cpu", "proc", "net", "temp", "mem", "disk"], same as layout options) | Sets the default widget type, use --help for more info. | -| `default_widget_count` | Unsigned Int (represents which `default_widget_type`) | Sets the n'th selected widget type as the default. | -| `disable_click` | Boolean | Disables mouse clicks. | -| `color` | String (one of ["default", "default-light", "gruvbox", "gruvbox-light", "nord", "nord-light"]) | Use a color scheme, use --help for supported values. | -| `mem_as_value` | Boolean | Defaults to showing process memory usage by value. | -| `tree` | Boolean | Defaults to showing the process widget in tree mode. | -| `show_table_scroll_position` | Boolean | Shows the scroll position tracker in table widgets. | -| `process_command` | Boolean | Show processes as their commands by default. | -| `disable_advanced_kill` | Boolean | Hides advanced options to stop a process on Unix-like systems. | -| `network_use_binary_prefix` | Boolean | Displays the network widget with binary prefixes. | -| `network_use_bytes` | Boolean | Displays the network widget using bytes. | -| `network_use_log` | Boolean | Displays the network widget with a log scale. | -| `enable_gpu_memory` | Boolean | Shows the GPU memory widget. | -| `retention` | String (human readable time, such as "10m", "1h", etc.) | How much data is stored at once in terms of time. | -| `unnormalized_cpu` | Boolean | Show process CPU% without normalizing over the number of cores. | -| `expanded_on_startup` | Boolean | Expand the default widget upon starting the app. | +| Field | Type | Functionality | +|------------------------------|------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| +| `hide_avg_cpu` | Boolean | Hides the average CPU usage. | +| `dot_marker` | Boolean | Uses a dot marker for graphs. | +| `left_legend` | Boolean | Puts the CPU chart legend to the left side. | +| `current_usage` | Boolean | Sets process CPU% to be based on current CPU%. | +| `group_processes` | Boolean | Groups processes with the same name by default. | +| `case_sensitive` | Boolean | Enables case sensitivity by default. | +| `whole_word` | Boolean | Enables whole-word matching by default. | +| `regex` | Boolean | Enables regex by default. | +| `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. | +| `default_time_value` | Unsigned Int (represents milliseconds) | Default time value for graphs in ms. | +| `time_delta` | Unsigned Int (represents milliseconds) | The amount in ms changed upon zooming. | +| `hide_time` | Boolean | Hides the time scale. | +| `temperature_type` | String (one of ["k", "f", "c", "kelvin", "fahrenheit", "celsius"]) | Sets the temperature unit type. | +| `default_widget_type` | String (one of ["cpu", "proc", "net", "temp", "mem", "disk"], same as layout options) | Sets the default widget type, use --help for more info. | +| `default_widget_count` | Unsigned Int (represents which `default_widget_type`) | Sets the n'th selected widget type as the default. | +| `disable_click` | Boolean | Disables mouse clicks. | +| `color` | String (one of ["default", "default-light", "gruvbox", "gruvbox-light", "nord", "nord-light"]) | Use a color scheme, use --help for supported values. | +| `enable_cache_memory` | Boolean | Enable collecting and displaying cache and buffer memory (not available on Windows). | +| `mem_as_value` | Boolean | Defaults to showing process memory usage by value. | +| `tree` | Boolean | Defaults to showing the process widget in tree mode. | +| `show_table_scroll_position` | Boolean | Shows the scroll position tracker in table widgets. | +| `process_command` | Boolean | Show processes as their commands by default. | +| `disable_advanced_kill` | Boolean | Hides advanced options to stop a process on Unix-like systems. | +| `network_use_binary_prefix` | Boolean | Displays the network widget with binary prefixes. | +| `network_use_bytes` | Boolean | Displays the network widget using bytes. | +| `network_use_log` | Boolean | Displays the network widget with a log scale. | +| `enable_gpu_memory` | Boolean | Shows the GPU memory widget. | +| `retention` | String (human readable time, such as "10m", "1h", etc.) | How much data is stored at once in terms of time. | +| `unnormalized_cpu` | Boolean | Show process CPU% without normalizing over the number of cores. | +| `expanded_on_startup` | Boolean | Expand the default widget upon starting the app. | |