Change order of return values from getyx - fixes display of historical CPU.

[virt-top.git] / virt-top / virt-top.1

diff --git a/virt-top/virt-top.1 b/virt-top/virt-top.1
index 29610ed..0a49ce1 100755 (executable)
--- a/virt-top/virt-top.1
+++ b/virt-top/virt-top.1
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.07)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
@@ -25,11 +25,11 @@
 ..
 .\" Set up some character translations and predefined strings.  \*(-- will
 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote.  | will give a
-.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
-.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
-.\" expand to `' in nroff, nothing in troff, for use with C<>.
-.tr \(*W-|\(bv\*(Tr
+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 .ie n \{\
 .    ds -- \(*W-
@@ -48,22 +48,25 @@
 .    ds R" ''
 'br\}
 .\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
 .\" If the F register is turned on, we'll generate index entries on stderr for
 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
-.if \nF \{\
+.ie \nF \{\
 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
 ..
 .    nr % 0
 .    rr F
 .\}
-.\"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
-.if n .na
+.el \{\
+.    de IX
+..
+.\}
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
@@ -129,7 +132,11 @@
 .\" ========================================================================
 .\"
 .IX Title "VIRT-TOP 1"
-.TH VIRT-TOP 1 "2007-11-20" "ocaml-libvirt-0.3.3.3" "Virtualization Support"
+.TH VIRT-TOP 1 "2009-10-05" "virt-top-1.0.4" "Virtualization Support"
+.\" 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"
 virt\-top \- 'top'\-like utility for virtualization stats
 .SH "SUMMARY"
@@ -227,7 +234,7 @@ To save space you can compress your \s-1CSV\s0 files (if your shell supports
 this feature, eg. \fIbash\fR):
 .Sp
 .Vb 1
-\& virt-top --csv >(gzip -9 > output.csv.gz)
+\& virt\-top \-\-csv >(gzip \-9 > output.csv.gz)
 .Ve
 .Sp
 You can use a similar trick to split the \s-1CSV\s0 file up.  In this example
@@ -235,7 +242,7 @@ the \s-1CSV\s0 file is split every 1000 lines into files called
 \&\fIoutput.csv.00\fR, \fIoutput.csv.01\fR etc.
 .Sp
 .Vb 1
-\& virt-top --csv >(split -d -l 1000 - output.csv.)
+\& virt\-top \-\-csv >(split \-d \-l 1000 \- output.csv.)
 .Ve
 .IP "\fB\-\-no\-csv\-cpu\fR" 4
 .IX Item "--no-csv-cpu"
@@ -252,14 +259,14 @@ Send debug and error messages to \fIfilename\fR.
 To send error messages to syslog you can do:
 .Sp
 .Vb 1
-\& virt-top --debug >(logger -t virt-top)
+\& virt\-top \-\-debug >(logger \-t virt\-top)
 .Ve
 .Sp
 See also \s-1REPORTING\s0 \s-1BUGS\s0 below.
 .IP "\fB\-\-init\-file filename\fR" 4
 .IX Item "--init-file filename"
 Read \fIfilename\fR as the init file instead of the default which is
-\&\fI$HOME/.virt\-toprc\fR.  See also \s-1INIT\s0 \s-1FILE\s0 below.
+\&\fI\f(CI$HOME\fI/.virt\-toprc\fR.  See also \s-1INIT\s0 \s-1FILE\s0 below.
 .IP "\fB\-\-no\-init\-file\fR" 4
 .IX Item "--no-init-file"
 Do not read any init file.
@@ -292,13 +299,13 @@ End time is \fIsecs\fR seconds in the future.
 For example to run the program for 3 minutes you could do:
 .Sp
 .Vb 1
-\& virt-top --end-time +00:03:00
+\& virt\-top \-\-end\-time +00:03:00
 .Ve
 .Sp
 or:
 .Sp
 .Vb 1
-\& virt-top --end-time +180
+\& virt\-top \-\-end\-time +180
 .Ve
 .Sp
 Not every version of virt-top supports this option \- it depends how the
@@ -308,6 +315,9 @@ for details).
 .IP "\fB\-\-help\fR" 4
 .IX Item "--help"
 Display usage summary.
+.IP "\fB\-\-version\fR" 4
+.IX Item "--version"
+Display version number and exit.
 .SH "KEYS"
 .IX Header "KEYS"
 Note that keys are case sensitive.  For example use upper-case \fIP\fR
@@ -470,7 +480,7 @@ Foundation, Inc., 675 Mass Ave, Cambridge, \s-1MA\s0 02139, \s-1USA\s0.
 Bugs can be viewed on the Red Hat Bugzilla page:
 <https://bugzilla.redhat.com/>.
 .PP
-If you find a bug in virt\-top, please follow these steps to report it:
+If you find a bug in virt-top, please follow these steps to report it:
 .IP "1. Check for existing bug reports" 4
 .IX Item "1. Check for existing bug reports"
 Go to <https://bugzilla.redhat.com/> and search for similar bugs.
@@ -481,16 +491,21 @@ have fixed it.
 Run
 .Sp
 .Vb 1
-\& virt-top --debug virt-top.log
+\& virt\-top \-\-debug virt\-top.log
 .Ve
 .Sp
 and keep \fIvirt\-top.log\fR.  It contains error messages which you
 should submit with your bug report.
 .IP "3. Get version of virt-top and version of libvirt." 4
 .IX Item "3. Get version of virt-top and version of libvirt."
-In virt\-top, press the \fIh\fR (help) key, and write down the version of
-virt-top and the version of libvirt.  They are shown in the first
-line.
+Use:
+.Sp
+.Vb 1
+\& virt\-top \-\-version
+.Ve
+.Sp
+If you can get the precise version of libvirt you are using
+then that too is helpful.
 .IP "4. Submit a bug report." 4
 .IX Item "4. Submit a bug report."
 Go to <https://bugzilla.redhat.com/> and enter a new bug.