Remove extra spaces after s_ and f_ operators.

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

diff --git a/virt-top/virt-top.pod b/virt-top/virt-top.pod
old mode 100644 (file)
new mode 100755 (executable)
index fe8ba91..283185d
--- a/virt-top/virt-top.pod
+++ b/virt-top/virt-top.pod
@@ -46,6 +46,14 @@ Batch mode.  In this mode keypresses are ignored.
 Connect to URI given.  The default is to connect to the Xen
 hypervisor.
 
 Connect to URI given.  The default is to connect to the Xen
 hypervisor.
 

+To connect to QEMU/KVM you would normally do I<-c qemu:///system>
+
+To connect to libvirtd on a remote machine you would normally do
+I<-c xen://host/>
+
+Full details on connection URIs is available at
+L<http://libvirt.org/uri.html>
+

 =item B<-d delay>
 
 Set the delay between screen updates in seconds.
 =item B<-d delay>
 
 Set the delay between screen updates in seconds.


@@ -99,6 +107,29 @@ Not every version of virt-top supports CSV output - it depends how the
 program was compiled (see I<README> file in the source distribution
 for details).
 
 program was compiled (see I<README> file in the source distribution
 for details).
 

+To save space you can compress your CSV files (if your shell supports
+this feature, eg. I<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
+I<output.csv.00>, I<output.csv.01> etc.
+
+ virt-top --csv >(split -d -l 1000 - output.csv.)
+
+=item B<--no-csv-cpu>
+
+Disable domain CPU stats in CSV output.
+
+=item B<--no-csv-block>
+
+Disable domain block device stats in CSV output.
+
+=item B<--no-csv-net>
+
+Disable domain network interface stats in CSV output.
+

 =item B<--debug filename>
 
 Send debug and error messages to I<filename>.
 =item B<--debug filename>
 
 Send debug and error messages to I<filename>.


@@ -108,10 +139,67 @@ To send error messages to syslog you can do:
 
 See also REPORTING BUGS below.
 
 
 See also REPORTING BUGS below.
 

+=item B<--init-file filename>
+
+Read I<filename> as the init file instead of the default which is
+I<$HOME/.virt-toprc>.  See also INIT FILE below.
+
+=item B<--no-init-file>
+
+Do not read any init file.
+
+=item B<--script>
+
+Script mode.  There will be no user interface.  This is most useful
+when used together with the I<--csv> and I<-n> options.
+
+=item B<--end-time time>
+
+The program will exit at the I<time> given.
+
+The time may be given in one of the following formats:
+
+=over 4
+
+=item I<YYYY-MM-DD HH:MM:SS>
+
+End time is the date and time given.
+
+=item I<HH:MM:SS>
+
+End time is the time given, today.
+
+=item I<+HH:MM:SS>
+
+End time is HH hours, MM minutes, SS seconds in the future (counted
+from the moment that program starts).
+
+=item I<+secs>
+
+End time is I<secs> seconds in the future.
+
+=back
+
+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 I<README> file in the source distribution
+for details).
+

 =item B<--help>
 
 Display usage summary.
 
 =item B<--help>
 
 Display usage summary.
 

+=item B<--version>
+
+Display version number and exit.
+

 =back
 
 =head1 KEYS
 =back
 
 =head1 KEYS


@@ -179,14 +267,115 @@ Sort by domain ID.
 Select the sort field interactively (there are other
 sort fields you can choose using this key).
 
 Select the sort field interactively (there are other
 sort fields you can choose using this key).
 

+=item I<W>
+
+This creates or overwrites the init file with the current settings.
+
+This key is disabled if I<--no-init-file> was specified on the
+command line or if I<overwrite-init-file false> is given in
+the init file.
+
+=back
+
+=head1 INIT FILE
+
+When virt-top starts up, it reads initial settings from the
+file I<.virt-toprc> in the user's home directory.
+
+The name of this file may be overridden using the I<--init-file
+filename> command line option or may be disabled entirely using
+I<--no-init-file>.
+
+The init file has a simple format.  Blank lines and comments
+beginning with I<#> are ignored.  Everything else is a set of
+I<key value> pairs, described below.
+
+=over 4
+
+=item B<display> I<task|pcpu|block|net>
+
+Sets the major display mode to one of I<task> (tasks, the
+default), I<pcpu> (physical CPUs), I<block> (block devices),
+or I<net> (network interfaces).
+
+=item B<delay> I<secs>
+
+Sets the delay between display updates in seconds.
+
+=item B<hist-cpu> I<secs>
+
+Sets the historical CPU delay in seconds.
+
+=item B<iterations> I<n>
+
+Sets the number of iterations to run before we exit.  Setting
+this to I<-1> means to run continuously.
+
+=item B<sort> I<cpu|mem|time|id|name|...>
+
+Sets the sort order.  The option names are the same as for
+the command line I<-o> option.
+
+=item B<connect> I<uri>
+
+Sets the default connection URI.
+
+=item B<debug> I<filename>
+
+Sets the default filename to use for debug and error messages.
+
+=item B<csv> I<filename>
+
+Enables CSV output to the named file.
+
+=item B<csv-cpu> I<true|false>
+
+Enable or disable domain CPU stats in CSV output.
+
+=item B<csv-block> I<true|false>
+
+Enable or disable domain block device stats in CSV output.
+
+=item B<csv-net> I<true|false>
+
+Enable or disable domain network interface stats in CSV output.
+
+=item B<batch> I<true|false>
+
+Sets batch mode.
+
+=item B<secure> I<true|false>
+
+Sets secure mode.
+
+=item B<script> I<true|false>
+
+Sets script mode.
+
+=item B<end-time> I<time>
+
+Set the time at which the program exits.  See above for the
+time formats supported.
+
+=item B<overwrite-init-file> I<false>
+
+If set to I<false> then the I<W> key will not overwrite the
+init file.
+

 =back
 
 =back
 

+
+Note that in the current implementation, options specified in
+the init file override options specified on the command line.
+This is a bug and this behaviour may change in the future.
+

 =head1 SEE ALSO
 
 L<top(1)>,
 L<virsh(1)>,
 L<xm(1)>,
 L<xentop(1)>,
 =head1 SEE ALSO
 
 L<top(1)>,
 L<virsh(1)>,
 L<xm(1)>,
 L<xentop(1)>,

+L<http://www.libvirt.org/ocaml/>,

 L<http://www.libvirt.org/>,
 L<http://et.redhat.com/~rjones/>,
 L<http://caml.inria.fr/>
 L<http://www.libvirt.org/>,
 L<http://et.redhat.com/~rjones/>,
 L<http://caml.inria.fr/>


@@ -195,6 +384,25 @@ L<http://caml.inria.fr/>
 
 Richard W.M. Jones <rjones @ redhat . com>
 
 
 Richard W.M. Jones <rjones @ redhat . com>
 

+=head1 COPYRIGHT
+
+(C) Copyright 2007 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.
+

 =head1 REPORTING BUGS
 
 Bugs can be viewed on the Red Hat Bugzilla page:
 =head1 REPORTING BUGS
 
 Bugs can be viewed on the Red Hat Bugzilla page:


@@ -221,9 +429,12 @@ should submit with your bug report.
 
 =item 3. Get version of virt-top and version of libvirt.
 
 
 =item 3. Get version of virt-top and version of libvirt.
 

-In virt-top, press the I<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.

 
 =item 4. Submit a bug report.
 
 
 =item 4. Submit a bug report.
 


@@ -240,5 +451,3 @@ spaces).  You can also send me an email with the bug number if you
 want a faster response.
 
 =back
 want a faster response.
 
 =back

-
-=end