diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/configuration/command-line-flags.md | 2 | ||||
| -rw-r--r-- | docs/content/configuration/config-file/flags.md | 2 | ||||
| -rw-r--r-- | docs/content/configuration/config-file/processes.md | 2 | ||||
| -rw-r--r-- | docs/content/usage/widgets/memory.md | 2 | ||||
| -rw-r--r-- | docs/content/usage/widgets/process.md | 11 | ||||
| -rw-r--r-- | docs/content/usage/widgets/temperature.md | 2 |
6 files changed, 17 insertions, 4 deletions
diff --git a/docs/content/configuration/command-line-flags.md b/docs/content/configuration/command-line-flags.md index e0a7192f..17f78f8a 100644 --- a/docs/content/configuration/command-line-flags.md +++ b/docs/content/configuration/command-line-flags.md @@ -20,7 +20,7 @@ see information on these flags by running `btm -h`, or run `btm --help` to displ | --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_memory | Enable collecting and displaying GPU memory usage. | +| --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 | Groups processes with the same name by default. | diff --git a/docs/content/configuration/config-file/flags.md b/docs/content/configuration/config-file/flags.md index eeca23a3..ed9d0aef 100644 --- a/docs/content/configuration/config-file/flags.md +++ b/docs/content/configuration/config-file/flags.md @@ -38,7 +38,7 @@ each time: | `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. | +| `enable_gpu` | Boolean | Shows the GPU widgets. | | `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. | diff --git a/docs/content/configuration/config-file/processes.md b/docs/content/configuration/config-file/processes.md index 2871e1cd..8a2c57b2 100644 --- a/docs/content/configuration/config-file/processes.md +++ b/docs/content/configuration/config-file/processes.md @@ -7,5 +7,5 @@ You can configure which columns are shown by the process widget by setting the ` ```toml [processes] # Pick which columns you want to use in any order. -columns = ["cpu%", "mem%", "pid", "name", "read", "write", "tread", "twrite", "state", "user", "time"] +columns = ["cpu%", "mem%", "pid", "name", "read", "write", "tread", "twrite", "state", "user", "time", "gmem%", "gpu%"] ``` diff --git a/docs/content/usage/widgets/memory.md b/docs/content/usage/widgets/memory.md index 5059d2bf..4304a3f7 100644 --- a/docs/content/usage/widgets/memory.md +++ b/docs/content/usage/widgets/memory.md @@ -13,7 +13,7 @@ If the total RAM or swap available is 0, then it is automatically hidden from th One can also adjust the displayed time range through either the keyboard or mouse, with a range of 30s to 600s. -This widget can also be configured to display Nvidia GPU memory usage (`--enable_gpu_memory`) or cache memory usage (`--enable_cache_memory`). +This widget can also be configured to display Nvidia GPU memory usage (`--enable_gpu` on Linux/Windows) or cache memory usage (`--enable_cache_memory`). ## Key bindings diff --git a/docs/content/usage/widgets/process.md b/docs/content/usage/widgets/process.md index 2a11e3a7..83139da1 100644 --- a/docs/content/usage/widgets/process.md +++ b/docs/content/usage/widgets/process.md @@ -32,6 +32,12 @@ It can also additionally display the following columns: - Process running time +With the feature flag (`--enable_gpu` on Linux/Windows) and gpu process columns enabled in the configuration: + +- GPU memory use percentage +- GPU core utilization percentage + + See [the processes configuration page](../../configuration/config-file/processes.md) on how to customize which columns are shown. @@ -147,6 +153,9 @@ Note all keywords are case-insensitive. To search for a process/command that col | `user` | `user=root` | Matches by user; supports regex | | `state` | `state=running` | Matches by state; supports regex | | `()` | `(<COND 1> AND <COND 2>) OR <COND 3>` | Group together a condition | +| `gmem` | `gmem > 1000 b` | Matches the gpu memory column in terms of bytes; supports comparison operators | +| `gmem%` | `gmem% < 0.5` | Matches the gpu memory column in terms of percent; supports comparison operators| +| `gpu%` | `gpu% > 0` | Matches the gpu usage column in terms of percent; supports comparison operators | #### Comparison operators @@ -207,6 +216,8 @@ Note that key bindings are generally case-sensitive. | ++I++ | Invert the current sort | | ++"%"++ | Toggle between values and percentages for memory usage | | ++t++ , ++f5++ | Toggle tree mode | +| ++M++ | Sort by gpu memory usage, press again to reverse sorting order | +| ++C++ | Sort by gpu usage, press again to reverse sorting order | ### Sort sub-widget diff --git a/docs/content/usage/widgets/temperature.md b/docs/content/usage/widgets/temperature.md index 34d28c98..3cadc9a8 100644 --- a/docs/content/usage/widgets/temperature.md +++ b/docs/content/usage/widgets/temperature.md @@ -10,6 +10,8 @@ The temperature widget provides a table of temperature sensors and their current The temperature widget provides the sensor name as well as its current temperature. +This widget can also be configured to display Nvidia GPU temperatures (`--enable_gpu` on Linux/Windows). + ## Key bindings Note that key bindings are generally case-sensitive. |