Update generated man page files.

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

diff --git a/virt-top/virt-top.txt b/virt-top/virt-top.txt
old mode 100755 (executable)
new mode 100644 (file)
index d222451..91c8181
--- a/virt-top/virt-top.txt
+++ b/virt-top/virt-top.txt
@@ -50,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]
@@ -119,6 +119,14 @@ OPTIONS
         Script mode. There will be no user interface. This is most useful
         when used together with the *--csv* and *-n* options.
 
+    --stream
+        Stream mode. All output is sent to stdout. This can be used from
+        shell scripts etc. There is no user interface.
+
+    --block-in-bytes
+        Show I/O statistics in Bytes. Default is shown in the number of
+        Requests.
+
     --end-time time
         The program will exit at the *time* given.
 
@@ -152,6 +160,9 @@ OPTIONS
     --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
@@ -167,6 +178,9 @@ KEYS
     *s* or *d*
         Change the delay between screen updates.
 
+    *B* Toggle Block I/O statistics so they are shown in either bytes or
+        requests.
+
     *0* (number 0)
         Show the normal list of domains display.
 
@@ -182,7 +196,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.
 
@@ -254,6 +269,12 @@ INIT FILE
     script *true|false*
         Sets script mode.
 
+    stream *true|false*
+        Sets stream mode.
+
+    block-in-bytes *true|false*
+        Show block device statistics in bytes.
+
     end-time *time*
         Set the time at which the program exits. See above for the time
         formats supported.
@@ -265,16 +286,35 @@ INIT FILE
     file override options specified on the command line. This is a bug and
     this behaviour may change in the future.
 
+NOTES
+  Block I/O statistics
+    This I/O value is the amount of I/O since the previous iteration of
+    virt-top. To calculate speed of I/O, you should divide the number by
+    delay secs.
+
+  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/ocaml/>,
-    <http://www.libvirt.org/>, <http://et.redhat.com/~rjones/>,
+    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 Red Hat Inc., Richard W.M. Jones http://libvirt.org/
+    (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
@@ -310,9 +350,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