From f65264e8856f0b702cca28a699e960ff0192a392 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Thu, 19 Apr 2012 22:54:55 +0200 Subject: move things to docs --- docs/HELP | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 docs/HELP (limited to 'docs/HELP') 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 - Num of samples for avg. (more fluent animations) +--barwidth - Set bar width +--cluster - Cluster name from /etc/clusters +--extended - Toggle extended display (0 or 1) +--factor - Set graph scale factor (1.0 means 100%) +--height - Set windows height +--hosts - Comma sep. list of hosts; optional: user@ in front to each host +--maxwidth - Set max width +--samples - Set number of samples until ssh reconnects +--showcores - Toggle core display (0 or 1) +--showmem - Toggle mem display (0 or 1) +--showtexthost - Toggle hostname/num text display (0 or 1) +--showtext - Toggle text display (0 or 1) +--sshopts - Set SSH options -- cgit v1.2.3