From 552d6f8baa1048ddb5fd22269efd50b90303ca4d Mon Sep 17 00:00:00 2001
From: jao <jao@gnu.org>
Date: Mon, 18 Apr 2022 18:55:04 +0100
Subject: CpuFreq: new template parameters max, min and avg.

Fixes #166.
---
 doc/plugins.org | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'doc/plugins.org')

diff --git a/doc/plugins.org b/doc/plugins.org
index 383207c..8abc461 100644
--- a/doc/plugins.org
+++ b/doc/plugins.org
@@ -382,7 +382,9 @@
       - Thresholds refer to frequency in GHz
 
       - Variables that can be used with the =-t/--template= argument:
-        =cpu0=, =cpu1=, .., =cpuN=
+        =cpu0=, =cpu1=, .., =cpuN=, give the current frequency of the
+        respective CPU core, and =max=, =min= and =avg= the maximum, minimum
+        and average frequency over all available cores.
 
       - Default template: =Freq: <cpu0>GHz=
 
@@ -393,6 +395,9 @@
         #+begin_src haskell
           Run CpuFreq ["-t", "Freq:<cpu0>|<cpu1>GHz", "-L", "0", "-H", "2",
                        "-l", "lightblue", "-n","white", "-h", "red"] 50
+
+          Run CpuFreq ["-t", "Freq:<avg> GHz", "-L", "0", "-H", "2",
+                       "-l", "lightblue", "-n","white", "-h", "red"] 50
         #+end_src
 
 ***** =CoreTemp Args RefreshRate=
-- 
cgit v1.2.3