Add help file

3 files changed, 34 insertions, 19 deletions

diff --git a/CHANGELOG b/CHANGELOG
index 3c436c6..00f5d60 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -1,3 +1,6 @@
+Sat Jan 21 15:54:06 CET 2012
+* Add HELP file
+
 Tue Dec 27 13:04:43 CET 2011
 * Bugfix: Max system+user peak is never >100%
 
diff --git a/HELP b/HELP
new file mode 100644
index 0000000..ead04a7
--- /dev/null
+++ b/HELP
@@ -0,0 +1,30 @@
+Explanation colors:
+	Blue: System cpu usage 
+	Purple: System usage if system cpu is >30%
+	Yellow: User cpu usage 
+	Darker yellow: User usage if system & user cpu is >50%
+	Orange: User usage if system & user cpu is >70%
+	White: Usage usage if system & user cpu is >99%
+	Green: Nice cpu usage
+        1px horizontal line: Maximum sy+us cpu of last 'avg' samples
+Explanation text display:
+	ni = Nice cpu usage in %
+	us = User cpu usage in %
+	sy = System cpu sage in %
+	su = System & user cpu usage in %
+	pk = Max System & user cpu usage peak of last avg. samples in %
+	avg = System load average (desc. order: 1, 5 and 15 min. avg.)
+--togglecpu <ARG>	- Toggle CPUs (0 or 1)
+--average <ARG>	- Num of samples for avg. (more fluent animations)
+--cluster <ARG>	- Cluster name from /etc/clusters
+--factor <ARG>	- Set graph scale factor (1.0 means 100%)
+--height <ARG>	- Set windows height
+--hosts <ARG>	- Comma separated list of hosts
+--inter <ARG>	- Set update interval in seconds (default 0.1)
+--samples <ARG>	- Set number of samples until ssh reconnects
+--sshopts <ARG>	- Set SSH options
+--title <ARG>	- Set the window title
+--toggletxthost <ARG>	- Toggle hostname/num text display (0 or 1)
+--togglepeak <ARG>	- Toggle peak display (0 or 1)
+--toggletxt <ARG>	- Toggle text display (0 or 1)
+--width <ARG>	- Set windows width
diff --git a/README b/README
index 1553511..6b86bf3 100644
--- a/README
+++ b/README
@@ -22,22 +22,4 @@ Versioning schema: a.b.c[.d], where
 	It's not a release if there is a -devel suffix. It's a development 
 	version (in the trunk) then.
 
-Explanation colors:
-	Blue: System cpu usage 
-	Purple: System usage if it's >30%
-	Yellow: User cpu usage 
-	Darker yellow: User usage if system & user cpu is >50%
-	Orange: User usage if system & user cpu is >70%
-	White: Usage usage if system & user cpu is >99%
-	Green: Nice cpu usage
-
-Explanation text display:
-	ni = Nice cpu usage in %
-	us = User cpu usage in %
-	sy = System cpu sage in %
-	su = System & user cpu usage in %
-	avg = System load average (desc. order: 1, 5 and 15 min. avg.)
-
-
-
-
+For some help/usage please consult the HELP file.