summaryrefslogtreecommitdiffstats
path: root/docs/devices.md
diff options
context:
space:
mode:
authorSean E. Russell <ser@ser1.net>2020-06-02 09:09:23 -0500
committerSean E. Russell <ser@ser1.net>2020-06-02 09:09:23 -0500
commitd6be10bcd88b45899fef9b66ead2ebf507743c39 (patch)
tree240f09c14a66274a9f4a856a70b15079b8219ccb /docs/devices.md
parentdcec8a53b748efa0f5eae0124a343d47541cae63 (diff)
Closes #100, breaks up the README
Diffstat (limited to 'docs/devices.md')
-rw-r--r--docs/devices.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/devices.md b/docs/devices.md
new file mode 100644
index 0000000..4f9e34c
--- /dev/null
+++ b/docs/devices.md
@@ -0,0 +1,37 @@
+# Device filtering
+
+Some devices have quite a number of data points; on OSX, for instance, there are dozens of temperature readings. These can be filtered through a configuration file. There is no command-line argument for this filter.
+
+The list will grow, but for now the only device that supports filtering is the temperature widget. The configuration entry is called `temperature`, and it contains an exact-match list of comma-separated values with no spaces. To see the list of valid values, run gotop with the `--list devices` command. Gotop will print out the type of device and the legal values. For example, on Linux:
+
+```
+$ gotop --list devices
+Temperatures:
+ acpitz
+ nvme_composite
+ nvme_sensor1
+ nvme_sensor2
+ pch_cannonlake
+ coretemp_packageid0
+ coretemp_core0
+ coretemp_core1
+ coretemp_core2
+ coretemp_core3
+ ath10k_hwmon
+```
+You might then add the following line to the config file. First, find where gotop looks for config files:
+```
+➜ gotop --list paths
+Loadable colorschemes & layouts, and the config file, are searched for, in order:
+/home/ser/workspace/gotop.d/gotop
+/home/ser/.config/gotop
+/etc/xdg/gotop
+
+The log file is in /home/ser/.cache/gotop/errors.log
+```
+So you might use `${HOME}/.config/gotop/gotop.conf`, and add (or modify) this line:
+```
+temperatures=acpitz,coretemp_core0,ath10k_hwmon
+```
+This will cause the temp widget to show only four of the eleven temps.
+