-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
.\"
.\" Standard preamble:
.\" ========================================================================
..
.\" 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-
. 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.
.\" ========================================================================
.\"
.IX Title "VIRT-TOP 1"
-.TH VIRT-TOP 1 "2007-09-24" "ocaml-libvirt-0.3.2.8" "Virtualization Support"
+.TH VIRT-TOP 1 "2008-04-17" "ocaml-libvirt-0.4.1.0" "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"
.IX Item "-c uri or --connect uri"
Connect to \s-1URI\s0 given. The default is to connect to the Xen
hypervisor.
+.Sp
+To connect to \s-1QEMU/KVM\s0 you would normally do \fI\-c qemu:///system\fR
+.Sp
+To connect to libvirtd on a remote machine you would normally do
+\&\fI\-c xen://host/\fR
+.Sp
+Full details on connection URIs is available at
+<http://libvirt.org/uri.html>
.IP "\fB\-d delay\fR" 4
.IX Item "-d delay"
Set the delay between screen updates in seconds.
Not every version of virt-top supports \s-1CSV\s0 output \- it depends how the
program was compiled (see \fI\s-1README\s0\fR file in the source distribution
for details).
+.Sp
+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)
+.Ve
+.Sp
+You can use a similar trick to split the \s-1CSV\s0 file up. In this example
+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.)
+.Ve
+.IP "\fB\-\-no\-csv\-cpu\fR" 4
+.IX Item "--no-csv-cpu"
+Disable domain \s-1CPU\s0 stats in \s-1CSV\s0 output.
+.IP "\fB\-\-no\-csv\-block\fR" 4
+.IX Item "--no-csv-block"
+Disable domain block device stats in \s-1CSV\s0 output.
+.IP "\fB\-\-no\-csv\-net\fR" 4
+.IX Item "--no-csv-net"
+Disable domain network interface stats in \s-1CSV\s0 output.
.IP "\fB\-\-debug filename\fR" 4
.IX Item "--debug filename"
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.
+.IP "\fB\-\-script\fR" 4
+.IX Item "--script"
+Script mode. There will be no user interface. This is most useful
+when used together with the \fI\-\-csv\fR and \fI\-n\fR options.
+.IP "\fB\-\-end\-time time\fR" 4
+.IX Item "--end-time time"
+The program will exit at the \fItime\fR given.
+.Sp
+The time may be given in one of the following formats:
+.RS 4
+.IP "\fIYYYY-MM-DD \s-1HH:MM:SS\s0\fR" 4
+.IX Item "YYYY-MM-DD HH:MM:SS"
+End time is the date and time given.
+.IP "\fI\s-1HH:MM:SS\s0\fR" 4
+.IX Item "HH:MM:SS"
+End time is the time given, today.
+.IP "\fI+HH:MM:SS\fR" 4
+.IX Item "+HH:MM:SS"
+End time is \s-1HH\s0 hours, \s-1MM\s0 minutes, \s-1SS\s0 seconds in the future (counted
+from the moment that program starts).
+.IP "\fI+secs\fR" 4
+.IX Item "+secs"
+End time is \fIsecs\fR seconds in the future.
+.RE
+.RS 4
+.Sp
+For example to run the program for 3 minutes you could do:
+.Sp
+.Vb 1
+\& virt\-top \-\-end\-time +00:03:00
+.Ve
+.Sp
+or:
+.Sp
+.Vb 1
+\& virt\-top \-\-end\-time +180
+.Ve
+.Sp
+Not every version of virt-top supports this option \- it depends how the
+program was compiled (see \fI\s-1README\s0\fR file in the source distribution
+for details).
+.RE
.IP "\fB\-\-help\fR" 4
.IX Item "--help"
Display usage summary.
.IP "\fBcsv\fR \fIfilename\fR" 4
.IX Item "csv filename"
Enables \s-1CSV\s0 output to the named file.
+.IP "\fBcsv-cpu\fR \fItrue|false\fR" 4
+.IX Item "csv-cpu true|false"
+Enable or disable domain \s-1CPU\s0 stats in \s-1CSV\s0 output.
+.IP "\fBcsv-block\fR \fItrue|false\fR" 4
+.IX Item "csv-block true|false"
+Enable or disable domain block device stats in \s-1CSV\s0 output.
+.IP "\fBcsv-net\fR \fItrue|false\fR" 4
+.IX Item "csv-net true|false"
+Enable or disable domain network interface stats in \s-1CSV\s0 output.
.IP "\fBbatch\fR \fItrue|false\fR" 4
.IX Item "batch true|false"
Sets batch mode.
.IP "\fBsecure\fR \fItrue|false\fR" 4
.IX Item "secure true|false"
Sets secure mode.
+.IP "\fBscript\fR \fItrue|false\fR" 4
+.IX Item "script true|false"
+Sets script mode.
+.IP "\fBend-time\fR \fItime\fR" 4
+.IX Item "end-time time"
+Set the time at which the program exits. See above for the
+time formats supported.
.IP "\fBoverwrite-init-file\fR \fIfalse\fR" 4
.IX Item "overwrite-init-file false"
If set to \fIfalse\fR then the \fIW\fR key will not overwrite the
\&\fIvirsh\fR\|(1),
\&\fIxm\fR\|(1),
\&\fIxentop\fR\|(1),
+<http://www.libvirt.org/ocaml/>,
<http://www.libvirt.org/>,
<http://et.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
+http://libvirt.org/
+.PP
+This program is free software; you can redistribute it and/or modify
+it under the terms of the \s-1GNU\s0 General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+.PP
+This program is distributed in the hope that it will be useful,
+but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
+\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. See the
+\&\s-1GNU\s0 General Public License for more details.
+.PP
+You should have received a copy of the \s-1GNU\s0 General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 675 Mass Ave, Cambridge, \s-1MA\s0 02139, \s-1USA\s0.
.SH "REPORTING BUGS"
.IX Header "REPORTING BUGS"
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.
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
+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.
.IP "4. Submit a bug report." 4