From 8cf5a92b9fb6242be211adc08e100685b71654e2 Mon Sep 17 00:00:00 2001 From: Twan Stok Date: Sun, 19 Mar 2023 22:46:12 +0100 Subject: [PATCH] specified that buffer and cache memory display does not work on windows --- .../configuration/command-line-flags.md | 84 +++++++++---------- .../configuration/config-file/flags.md | 70 ++++++++-------- 2 files changed, 77 insertions(+), 77 deletions(-) diff --git a/docs/content/configuration/command-line-flags.md b/docs/content/configuration/command-line-flags.md index f79712d5..f2356af9 100644 --- a/docs/content/configuration/command-line-flags.md +++ b/docs/content/configuration/command-line-flags.md @@ -6,45 +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 ` | 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. | -| `--enable_cache_memory` | Enable collecting and displaying cache and buffer memory. | -| `-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. | -| `--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 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. | +| `--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 ` | 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. | +| `--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 2c687bae..704edb89 100644 --- a/docs/content/configuration/config-file/flags.md +++ b/docs/content/configuration/config-file/flags.md @@ -7,38 +7,38 @@ 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. | -| `enable_cache_memory` | Boolean | Enable collecting and displaying cache and buffer memory. | -| `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. |