Update generated man pages.
[virt-top.git] / virt-top / virt-top.1
index 1406317..1cd5843 100755 (executable)
@@ -1,15 +1,7 @@
-.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
+.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
-.de Sh \" Subsection heading
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
 .de Sp \" Vertical space (when we can't use .PP)
 .if t .sp .5v
 .if n .sp
@@ -53,7 +45,7 @@
 .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
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
 .ie \nF \{\
 .\" ========================================================================
 .\"
 .IX Title "VIRT-TOP 1"
-.TH VIRT-TOP 1 "2008-04-17" "ocaml-libvirt-0.4.1.0" "Virtualization Support"
+.TH VIRT-TOP 1 "2011-01-06" "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
@@ -195,7 +187,7 @@ is to run continuously.
 .IX Item "-o sort"
 Set the sort order to one of:
 \&\fBcpu\fR (sort by \f(CW%CPU\fR used),
-\&\fBmem\fR (sort by memory used),
+\&\fBmem\fR (sort by total memory),
 \&\fBtime\fR (sort by total time),
 \&\fBid\fR (sort by domain \s-1ID\s0),
 \&\fBname\fR (sort by domain name),
@@ -315,6 +307,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
@@ -353,7 +348,8 @@ toggles back to showing domains.
 Sort by \f(CW%CPU\fR.
 .IP "\fIM\fR" 4
 .IX Item "M"
-Sort by memory.
+Sort by total memory.  Note that this shows the total memory
+allocated to the guest, not the memory being used.
 .IP "\fIT\fR" 4
 .IX Item "T"
 Sort by total time.
@@ -445,18 +441,16 @@ This is a bug and this behaviour may change in the future.
 .IX Header "SEE ALSO"
 \&\fItop\fR\|(1),
 \&\fIvirsh\fR\|(1),
-\&\fIxm\fR\|(1),
-\&\fIxentop\fR\|(1),
 <http://www.libvirt.org/ocaml/>,
 <http://www.libvirt.org/>,
-<http://et.redhat.com/~rjones/>,
+<http://people.redhat.com/~rjones/>,
 <http://caml.inria.fr/>
 .SH "AUTHORS"
 .IX Header "AUTHORS"
 Richard W.M. Jones <rjones @ redhat . com>
 .SH "COPYRIGHT"
 .IX Header "COPYRIGHT"
-(C) Copyright 2007 Red Hat Inc., Richard W.M. Jones
+(C) Copyright 2007\-2011 Red Hat Inc., Richard W.M. Jones
 http://libvirt.org/
 .PP
 This program is free software; you can redistribute it and/or modify
@@ -495,9 +489,14 @@ 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.