diff options
Diffstat (limited to 'docs/loadbars.1')
| -rw-r--r-- | docs/loadbars.1 | 75 |
1 files changed, 71 insertions, 4 deletions
diff --git a/docs/loadbars.1 b/docs/loadbars.1 index 30940cd..188295b 100644 --- a/docs/loadbars.1 +++ b/docs/loadbars.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== @@ -124,20 +124,87 @@ .\" ======================================================================== .\" .IX Title "LOADBARS 1" -.TH LOADBARS 1 "2012-04-20" "loadbars 0.5.3" "User Commands" +.TH LOADBARS 1 "2012-07-11" "loadbars 0.5.99+nmu3" "User Commands" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" -loadbars \- Small tool to observe server loads +loadbars \- A small and humble tool to observe server loads .SH "SYNOPSIS" .IX Header "SYNOPSIS" -For any program help check out \-\-help on command line or 'h' during program +.SS "I like flying elephants" +.IX Subsection "I like flying elephants" +For any startup params help check out \-\-help on command line or 'h' during program execution. +.SS "A few examples however" +.IX Subsection "A few examples however" +loadbars \-\-extended 1 \-\-showcores 1 \-\-height 300 \-\-hosts localhost +.PP +loadbars \-\-hosts localhost,server1.example.com,server2.example.com +.PP +loadbars \-\-cluster foocluster (foocluster is in /etc/clusters [ClusterSSH]) .SH "DESCRIPTION" .IX Header "DESCRIPTION" Loadbars is a small script that can be used to observe \s-1CPU\s0 loads of several remote servers at once in real time. It connects with \s-1SSH\s0 (using \s-1SSH\s0 public/private key auth) to several servers at once and vizualizes all server CPUs and memory statistics right next each other (either summarized or each core separately). Loadbars is not a tool for collecting \s-1CPU\s0 loads and drawing graphs for later analysis. However, since such tools require a significant amount of time before producing results, Loadbars lets you observe the current state immediately. Loadbars does not remember or record any load information. It just shows the current \s-1CPU\s0 usages like top or vmstat does. +.SH "INFO" +.IX Header "INFO" +.SS "\s-1CPU\s0 stuff" +.IX Subsection "CPU stuff" +st = Steal in % [see man proc] (extended), Color: Red +.PP +gt = Guest in % [see man proc] (extended), Color: Red +.PP +sr = Soft \s-1IRQ\s0 usage in % (extended), Color: White +.PP +ir = \s-1IRQ\s0 usage in % (extended), Color: White +.PP +io = IOwait cpu sage in %, Color: Purple +.PP +id = Idle cpu usage in % (extended), Color: Black +.PP +ni = Nice cpu usage in %, Color: Green +.PP +us = User cpu usage in %, Color: Yellow, dark yellow if to>50%, orange if to>50% +.PP +sy = System cpu sage in %, Color: Blue, lighter blue if >30% +.PP +to = Total \s-1CPU\s0 usage, which is (100% \- id) +.PP +pk = Max us+sy peak of last avg. samples (extended) +.PP +avg = System load average; desc. order: 1, 5 and 15 min. avg. +.PP +1px horizontal line: Maximum sy+us+io of last 'avg' samples (extended) +.PP +Extended means: text display only if extended mode is turned on +.SS "Memory stuff" +.IX Subsection "Memory stuff" +Ram: System ram usage in %, Color: Dark grey +.PP +Swp: System swap usage in %, Color: Grey +.SS "Network stuff" +.IX Subsection "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. +.PP +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. +.PP +When network bar is red: The interface does not exist on the specific remote host. +.PP +\fIConfig file support\fR +.IX Subsection "Config file support" +.PP +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: +.Sp +.RS 4 +showcores=1 # Always show cores on startup +.Sp +showtext=0 # Always don't display text on startup +.Sp +extended=1 # Always use extended mode on startup +.RE +.PP +will always show all \s-1CPU\s0 cores in extended mode but no text display. .SH "LICENSE" .IX Header "LICENSE" See package description or project website. |