From 6729bfb6fd6e004c980a7ab3d0b62dd91f887b31 Mon Sep 17 00:00:00 2001 From: Sam Kirby Date: Fri, 21 May 2021 15:06:02 +0100 Subject: Add documentation --- doc/plugins.org | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/doc/plugins.org b/doc/plugins.org index 4c6b2aa..76b4796 100644 --- a/doc/plugins.org +++ b/doc/plugins.org @@ -455,6 +455,39 @@ something like: "-l", "green", "-n", "yellow", "-h", "red", "--", "--mintemp", "20", "--maxtemp", "100"] 50 #+end_src + +*** =K10Temp Slot Args RefreshRate= + + - Aliases to =k10temp= + + - Slot: The PCI slot address of the k10temp device + + - Args: default monitor arguments + + - Thresholds refer to temperature in degrees + + - Variables that can be used with the =-t/--template= argument: + =Tctl=, =Tdie=, =Tccd1=, .., =Tccd8= + + - Default template: =Temp: C= + + - This monitor requires k10temp module to be loaded in kernel + + - It is important to note that not all measurements are available + on on all models of processor. Of particular importance - Tdie + (used in the default template) may not be present on processors + prior to Zen (17h). Tctl, however, may be offset from the real + temperature and so is not used by default. + + - Example: + + #+begin_src haskell + Run CoreTemp ["-t", "Temp: C|C", + "-L", "40", "-H", "60", + "-l", "lightblue", "-n", "gray90", "-h", "red"] 50 + #+end_src + + *** =Memory Args RefreshRate= - Aliases to =memory= -- cgit v1.2.3