From 81a2809683ceda6475d6d42df644dce102dd290b Mon Sep 17 00:00:00 2001
From: Juraj Hercek <juhe_haskell@hck.sk>
Date: Sun, 23 Dec 2007 00:14:19 +0100
Subject: Added documentation.

  - added Thermal, CoreTemp, CpuFreq documentation to README file
  - added haddock documentation

darcs-hash:20071222231419-f49a6-beadaa214bd80a9eb12f568dbff8dcf0d88ecfe7.gz
---
 README | 35 +++++++++++++++++++++++++++++++++--
 1 file changed, 33 insertions(+), 2 deletions(-)

(limited to 'README')

diff --git a/README b/README
index 06785e7..42924b3 100644
--- a/README
+++ b/README
@@ -197,8 +197,8 @@ External Commands). All other commands are provided by plugins.
 [Xmobar] comes with some plugins, providing a set of system monitors,
 a standard input reader, an Unix named pipe reader, and a configurable
 date plugin. These plugins install the following internal commands:
-`Weather`, `Network`, `Memory`, `Swap`, `Cpu`, `Battery`, `Date`,
-`StdinReader`, and `PipeReader`.
+`Weather`, `Network`, `Memory`, `Swap`, `Cpu`, `Battery`, `Thermal`,
+`CpuFreq`, `CoreTemp`, `Date`, `StdinReader` and `PipeReader`.
 
 To remove them see below Installing/Removing a Plugin
 
@@ -263,6 +263,37 @@ Monitors have default aliases.
 	    `left`
 - Default template: `Batt: <left>`
 
+`Thermal Zone Args RefreshRate`
+
+- aliases to the Zone: so `Zone "THRM" []` can be used in template as `%THRM%`
+- Args: the argument list (see below)
+- Variables that can be used with the `-t`/`--template` argument:
+	    `temp`
+- Default template: `Thm: <temp>C`
+- This plugin works only on sytems with devices having thermal zone.
+  Check directories in /proc/acpi/thermal_zone for possible values.
+- Example: Run Thermal "THRM" ["-t","iwl4965-temp: \<temp\>C"]
+
+`CpuFreq Args RefreshRate`
+
+- aliases to `cpufreq`
+- Args: the argument list (see below)
+- Variables that can be used with the `-t`/`--template` argument:
+	    `core0`, `core1`, ..,  `coreN`
+- Default template: `Freq: <core0>GHz`
+- This monitor requires acpi_cpufreq module to be loaded in kernel
+- Example: Run CpuFreq ["-t","Freq:\<core0\>|\<core1\>GHz","-L","0","-H","2","-l","lightblue","-n","white","-h","red"] 50
+
+`CoreTemp Args RefreshRate`
+
+- aliases to `coretemp`
+- Args: the argument list (see below)
+- Variables that can be used with the `-t`/`--template` argument:
+	    `core0`, `core1`, ..,  `coreN`
+- Default template: `Temp: <core0>C`
+- This monitor requires coretemp module to be loaded in kernel
+- Example: Run CoreTemp ["-t","Temp:\<core0\>|\<core1\>C","-L","40","-H","60","-l","lightblue","-n","gray90","-h","red"] 50
+
 ### Monitor Plugins Commands Arguments
 
 These are the arguments that can be used for internal commands in the
-- 
cgit v1.2.3