docs: Fix documentation for virt-top -c option.

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

diff --git a/virt-top/virt-top.pod b/virt-top/virt-top.pod
index 9e1e228..225c5ea 100755 (executable)
--- a/virt-top/virt-top.pod
+++ b/virt-top/virt-top.pod
@@ -43,16 +43,21 @@ Batch mode.  In this mode keypresses are ignored.
 
 =item B<-c uri> or B<--connect uri>
 
 
 =item B<-c uri> or B<--connect uri>
 

-Connect to URI given.  The default is to connect to the Xen
-hypervisor.
+Connect to the libvirt URI given.

 
 To connect to QEMU/KVM you would normally do I<-c qemu:///system>
 
 
 To connect to QEMU/KVM you would normally do I<-c qemu:///system>
 

+To connect to Xen on the same host, do I<-c xen:///>
+

 To connect to libvirtd on a remote machine you would normally do
 To connect to libvirtd on a remote machine you would normally do

-I<-c xen://host/>
+I<-c qemu://host/system>
+
+If this option is not given then virt-top connects by default
+to whatever is the default hypervisor for libvirt, although
+this can be overridden by setting environment variables.

 
 

-Full details on connection URIs is available at
-L<http://libvirt.org/uri.html>
+See the libvirt documentation at L<http://libvirt.org/uri.html>
+for further information.

 
 =item B<-d delay>
 
 
 =item B<-d delay>
 


@@ -122,6 +127,10 @@ I<output.csv.00>, I<output.csv.01> etc.
 
 Disable domain CPU stats in CSV output.
 
 
 Disable domain CPU stats in CSV output.
 

+=item B<--no-csv-mem>
+
+Disable domain memory stats in CSV output.
+

 =item B<--no-csv-block>
 
 Disable domain block device stats in CSV output.
 =item B<--no-csv-block>
 
 Disable domain block device stats in CSV output.


@@ -158,6 +167,10 @@ when used together with the I<--csv> and I<-n> options.
 Stream mode.  All output is sent to stdout.  This can be used from
 shell scripts etc.  There is no user interface.
 
 Stream mode.  All output is sent to stdout.  This can be used from
 shell scripts etc.  There is no user interface.
 

+=item B<--block-in-bytes>
+
+Show I/O statistics in Bytes. Default is shown in the number of Requests.
+

 =item B<--end-time time>
 
 The program will exit at the I<time> given.
 =item B<--end-time time>
 
 The program will exit at the I<time> given.


@@ -231,6 +244,10 @@ Displays help.
 
 Change the delay between screen updates.
 
 
 Change the delay between screen updates.
 

+=item I<B>
+
+Toggle Block I/O statistics so they are shown in either bytes or requests.
+

 =item I<0> (number 0)
 
 Show the normal list of domains display.
 =item I<0> (number 0)
 
 Show the normal list of domains display.


@@ -338,6 +355,10 @@ Enables CSV output to the named file.
 
 Enable or disable domain CPU stats in CSV output.
 
 
 Enable or disable domain CPU stats in CSV output.
 

+=item B<csv-mem> I<true|false>
+
+Enable or disable domain memory stats in CSV output.
+

 =item B<csv-block> I<true|false>
 
 Enable or disable domain block device stats in CSV output.
 =item B<csv-block> I<true|false>
 
 Enable or disable domain block device stats in CSV output.


@@ -362,6 +383,10 @@ Sets script mode.
 
 Sets stream mode.
 
 
 Sets stream mode.
 

+=item B<block-in-bytes> I<true|false>
+
+Show block device statistics in bytes.
+

 =item B<end-time> I<time>
 
 Set the time at which the program exits.  See above for the
 =item B<end-time> I<time>
 
 Set the time at which the program exits.  See above for the


@@ -380,6 +405,12 @@ This is a bug and this behaviour may change in the future.
 
 =head1 NOTES
 
 
 =head1 NOTES
 

+=head2 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.
+

 =head2 NETWORK RX BYTES AND PACKETS
 
 Libvirt/virt-top has no way to know that a packet transmitted to a
 =head2 NETWORK RX BYTES AND PACKETS
 
 Libvirt/virt-top has no way to know that a packet transmitted to a