Obey virt-top --end-time down to near millisecond accuracy (RHBZ#637964).
[virt-top.git] / virt-top / virt-top.txt
index 7eeb1cd..de0681e 100644 (file)
@@ -31,6 +31,14 @@ OPTIONS
         Connect to URI given. The default is to connect to the Xen
         hypervisor.
 
+        To connect to QEMU/KVM you would normally do *-c qemu:///system*
+
+        To connect to libvirtd on a remote machine you would normally do *-c
+        xen://host/*
+
+        Full details on connection URIs is available at
+        <http://libvirt.org/uri.html>
+
     -d delay
         Set the delay between screen updates in seconds. The default is 3.0
         seconds. You can change this while virt-top is running by pressing
@@ -42,7 +50,7 @@ OPTIONS
 
     -o sort
         Set the sort order to one of: cpu (sort by %CPU used), mem (sort by
-        memory used), time (sort by total time), id (sort by domain ID),
+        total memory), time (sort by total time), id (sort by domain ID),
         name (sort by domain name), netrx (sort by network received bytes),
         nettx (sort by network transmitted bytes), blockrdrq (sort by block
         device [disk] read requests), blockwrrq (sort by block device [disk]
@@ -72,6 +80,26 @@ OPTIONS
         the program was compiled (see *README* file in the source
         distribution for details).
 
+        To save space you can compress your CSV files (if your shell
+        supports this feature, eg. *bash*):
+
+         virt-top --csv >(gzip -9 > output.csv.gz)
+
+        You can use a similar trick to split the CSV file up. In this
+        example the CSV file is split every 1000 lines into files called
+        *output.csv.00*, *output.csv.01* etc.
+
+         virt-top --csv >(split -d -l 1000 - output.csv.)
+
+    --no-csv-cpu
+        Disable domain CPU stats in CSV output.
+
+    --no-csv-block
+        Disable domain block device stats in CSV output.
+
+    --no-csv-net
+        Disable domain network interface stats in CSV output.
+
     --debug filename
         Send debug and error messages to *filename*. To send error messages
         to syslog you can do:
@@ -87,9 +115,46 @@ OPTIONS
     --no-init-file
         Do not read any init file.
 
+    --script
+        Script mode. There will be no user interface. This is most useful
+        when used together with the *--csv* and *-n* options.
+
+    --end-time time
+        The program will exit at the *time* given.
+
+        The time may be given in one of the following formats:
+
+        *YYYY-MM-DD HH:MM:SS*
+            End time is the date and time given.
+
+        *HH:MM:SS*
+            End time is the time given, today.
+
+        *+HH:MM:SS*
+            End time is HH hours, MM minutes, SS seconds in the future
+            (counted from the moment that program starts).
+
+        *+secs*
+            End time is *secs* seconds in the future.
+
+        For example to run the program for 3 minutes you could do:
+
+         virt-top --end-time +00:03:00
+
+        or:
+
+         virt-top --end-time +180
+
+        Not every version of virt-top supports this option - it depends how
+        the program was compiled (see *README* file in the source
+        distribution for details).
+
     --help
         Display usage summary.
 
+    --version
+        Display version number and exit.
+
 KEYS
     Note that keys are case sensitive. For example use upper-case *P* (shift
     P) to sort by %CPU. *^* before a key means a Ctrl key, so *^L* is Ctrl
@@ -120,7 +185,8 @@ KEYS
 
     *P* Sort by %CPU.
 
-    *M* Sort by memory.
+    *M* Sort by total memory. Note that this shows the total memory
+        allocated to the guest, not the memory being used.
 
     *T* Sort by total time.
 
@@ -174,12 +240,28 @@ INIT FILE
     csv *filename*
         Enables CSV output to the named file.
 
+    csv-cpu *true|false*
+        Enable or disable domain CPU stats in CSV output.
+
+    csv-block *true|false*
+        Enable or disable domain block device stats in CSV output.
+
+    csv-net *true|false*
+        Enable or disable domain network interface stats in CSV output.
+
     batch *true|false*
         Sets batch mode.
 
     secure *true|false*
         Sets secure mode.
 
+    script *true|false*
+        Sets script mode.
+
+    end-time *time*
+        Set the time at which the program exits. See above for the time
+        formats supported.
+
     overwrite-init-file *false*
         If set to *false* then the *W* key will not overwrite the init file.
 
@@ -187,13 +269,45 @@ INIT FILE
     file override options specified on the command line. This is a bug and
     this behaviour may change in the future.
 
+NOTES
+  NETWORK RX BYTES AND PACKETS
+    Libvirt/virt-top has no way to know that a packet transmitted to a guest
+    was received (eg. if the guest is not listening). In the network RX
+    stats, virt-top reports the packets transmitted to the guest, on the
+    basis that the guest might receive them.
+
+    In particular this includes broadcast packets. Because of the way that
+    Linux bridges work, if the guest is connected to a bridge, it will
+    probably see a steady "background noise" of RX packets even when the
+    network interface is idle or down. These are caused by STP packets
+    generated by the bridge.
+
 SEE ALSO
-    top(1), virsh(1), xm(1), xentop(1), <http://www.libvirt.org/>,
-    <http://et.redhat.com/~rjones/>, <http://caml.inria.fr/>
+    top(1), virsh(1), <http://www.libvirt.org/ocaml/>,
+    <http://www.libvirt.org/>, <http://people.redhat.com/~rjones/>,
+    <http://caml.inria.fr/>
 
 AUTHORS
     Richard W.M. Jones <rjones @ redhat . com>
 
+COPYRIGHT
+    (C) Copyright 2007-2011 Red Hat Inc., Richard W.M. Jones
+    http://libvirt.org/
+
+    This program is free software; you can redistribute it and/or modify it
+    under the terms of the GNU General Public License as published by the
+    Free Software Foundation; either version 2 of the License, or (at your
+    option) any later version.
+
+    This program is distributed in the hope that it will be useful, but
+    WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
+    Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    675 Mass Ave, Cambridge, MA 02139, USA.
+
 REPORTING BUGS
     Bugs can be viewed on the Red Hat Bugzilla page:
     <https://bugzilla.redhat.com/>.
@@ -214,9 +328,12 @@ REPORTING BUGS
         submit with your bug report.
 
     3. Get version of virt-top and version of libvirt.
-        In virt-top, press the *h* (help) key, and write down the version of
-        virt-top and the version of libvirt. They are shown in the first
-        line.
+        Use:
+
+         virt-top --version
+
+        If you can get the precise version of libvirt you are using then
+        that too is helpful.
 
     4. Submit a bug report.
         Go to <https://bugzilla.redhat.com/> and enter a new bug. Please