From e12ed777b7b4d5590d6b245ce073fcf534984ed2 Mon Sep 17 00:00:00 2001
From: Clement Tsang <34804052+ClementTsang@users.noreply.github.com>
Date: Sun, 7 May 2023 17:00:55 -0400
Subject: docs: update docs with processes column (#1138)

---
 docs/content/configuration/config-file/processes.md | 11 +++++++++++
 docs/content/usage/widgets/memory.md                |  2 ++
 docs/content/usage/widgets/process.md               |  7 +++++++
 docs/mkdocs.yml                                     |  1 +
 4 files changed, 21 insertions(+)
 create mode 100644 docs/content/configuration/config-file/processes.md

(limited to 'docs')

diff --git a/docs/content/configuration/config-file/processes.md b/docs/content/configuration/config-file/processes.md
new file mode 100644
index 00000000..55e5c2c6
--- /dev/null
+++ b/docs/content/configuration/config-file/processes.md
@@ -0,0 +1,11 @@
+# Processes
+
+## Columns
+
+You can configure which columns are shown by the process widget by setting the `columns` setting:
+
+```toml
+[processes]
+# Pick which columns you want to use.
+columns = ["cpu%", "mem", "mem%", "pid", "count", "name", "command", "read", "write", "Tread", "twrite", "state", "user", "time"]
+```
diff --git a/docs/content/usage/widgets/memory.md b/docs/content/usage/widgets/memory.md
index 59d36c9a..5059d2bf 100644
--- a/docs/content/usage/widgets/memory.md
+++ b/docs/content/usage/widgets/memory.md
@@ -13,6 +13,8 @@ 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`).
+
 ## Key bindings
 
 Note that key bindings are generally case-sensitive.
diff --git a/docs/content/usage/widgets/process.md b/docs/content/usage/widgets/process.md
index 0c5063f4..6dd21daa 100644
--- a/docs/content/usage/widgets/process.md
+++ b/docs/content/usage/widgets/process.md
@@ -28,6 +28,13 @@ By default, the main process table displays the following information for each p
 - User
 - Process state
 
+It can also additionally display the following columns:
+
+- Process time
+
+See [the processes configuration page](../../configuration/config-file/processes.md) on how to customize which columns
+are shown.
+
 ### Sorting
 
 The table can be sorted by clicking on the table headers, which will either sort the table by that column, or if already
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index a400c624..a58622b8 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -145,6 +145,7 @@ nav:
           - "Theming": configuration/config-file/theming.md
           - "Layout": configuration/config-file/layout.md
           - "Data Filtering": configuration/config-file/data-filtering.md
+          - "Processes": configuration/config-file/processes.md
   - "Contribution":
       - "Issues, Pull Requests, and Discussions": contribution/issues-and-pull-requests.md
       - "Documentation": contribution/documentation.md
-- 
cgit v1.2.3