move things to docs

1 files changed, 60 insertions, 0 deletions

diff --git a/docs/HELP b/docs/HELP
new file mode 100644
index 0000000..e077c51
--- /dev/null
+++ b/docs/HELP
@@ -0,0 +1,60 @@
+==> Reading configuration from /home/pb/.loadbarsrc
+==> Setting showcores=1, it might be overwritten by command line params.
+==> Setting showtext=0, it might be overwritten by command line params.
+==> Setting extended=1, it might be overwritten by command line params.
+==> Setting showmem=1, it might be overwritten by command line params.
+CPU stuff:
+    st = Steal in % [see man proc] (extended)
+        Color: Red
+    gt = Guest in % [see man proc] (extended)
+        Color: Red
+    sr = Soft IRQ usage in % (extended)
+        Color: White
+    ir = IRQ usage in % (extended)
+        Color: White
+    io = IOwait cpu sage in % 
+        Color: Purple
+    id = Idle cpu usage in % (extended)
+        Color: Black
+    ni = Nice cpu usage in % 
+        Color: Green
+    us = User cpu usage in % 
+        Color: Yellow, dark yellow if to>50%, orange if to>50%
+    sy = System cpu sage in % 
+        Blue, lighter blue if >30%
+    to = Total CPU usage, which is (100% - id)
+    pk = Max us+sy peak of last avg. samples (extended)
+    avg = System load average; desc. order: 1, 5 and 15 min. avg. 
+    1px horizontal line: Maximum sy+us+io of last 'avg' samples (extended)
+    Extended means: text display only if extended mode is turned on
+Memory stuff:
+    Ram: System ram usage in %
+        Color: Dark grey
+    Swp: System swap usage in %
+        Color: Grey
+Config file support:
+    Loadbars tries to read ~/.loadbarsrc and it's possible to configure any
+    option you find in --help but without leading '--'. For comments just use
+    the '#' sign. Sample config:
+        showcores=1 # Always show cores on startup
+        showtext=0 # Always don't display text on startup
+        extended=1 # Always use extended mode on startup
+    will always show all CPU cores in extended mode but no text display. 
+Examples:
+    loadbars --extended 1 --showcores 1 --height 300 --hosts localhost
+    loadbars --hosts localhost,server1.example.com,server2.example.com
+    loadbars --cluster foocluster (foocluster is in /etc/clusters [ClusterSSH])
+--average <ARG>	- Num of samples for avg. (more fluent animations)
+--barwidth <ARG>	- Set bar width
+--cluster <ARG>	- Cluster name from /etc/clusters
+--extended <ARG>	- Toggle extended display (0 or 1)
+--factor <ARG>	- Set graph scale factor (1.0 means 100%)
+--height <ARG>	- Set windows height
+--hosts <ARG>	- Comma sep. list of hosts; optional: user@ in front to each host
+--maxwidth <ARG>	- Set max width
+--samples <ARG>	- Set number of samples until ssh reconnects
+--showcores <ARG>	- Toggle core display (0 or 1)
+--showmem <ARG>	- Toggle mem display (0 or 1)
+--showtexthost <ARG>	- Toggle hostname/num text display (0 or 1)
+--showtext <ARG>	- Toggle text display (0 or 1)
+--sshopts <ARG>	- Set SSH options