remove --factor switch

1 files changed, 73 insertions, 3 deletions

diff --git a/docs/loadbars.txt b/docs/loadbars.txt
index 4791cd5..aab011b 100644
--- a/docs/loadbars.txt
+++ b/docs/loadbars.txt
@@ -1,9 +1,18 @@
 NAME
-    loadbars - Small tool to observe server loads
+    loadbars - A small and humble tool to observe server loads
 
 SYNOPSIS
-    For any program help check out --help on command line or 'h' during
-    program execution.
+  I like flying elephants
+    For any startup params help check out --help on command line or 'h'
+    during program execution.
+
+  A few examples however
+    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])
 
 DESCRIPTION
     Loadbars is a small script that can be used to observe CPU loads of
@@ -17,6 +26,67 @@ DESCRIPTION
     Loadbars does not remember or record any load information. It just shows
     the current CPU usages like top or vmstat does.
 
+INFO
+  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 %, Color: 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
+
+  Network stuff
+    Rxb: Incoming (received) traffic in %, Color: Light green, normal green
+    if >100% while using low netlink reference. Bar comes from top and is
+    half width.
+
+    Txb: Outgoing (transmitted) traffic in %, Color: Light green, normal
+    green if >100% while using low netlink reference. Bar comes from bottom
+    and is half width.
+
+    When network bar is red: The interface does not exist on the specific
+    remote host.
+
+   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.
+
 LICENSE
     See package description or project website.