Add Japanese to list of translations.
[virt-top.git] / virt-top / virt-top.pod
old mode 100644 (file)
new mode 100755 (executable)
index af31c27..4b57811
@@ -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,17 @@ 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-cpu>
 
 Disable domain CPU stats in CSV output.
@@ -134,6 +153,45 @@ Do not read any init file.
 Script mode.  There will be no user interface.  This is most useful
 when used together with the I<--csv> and I<-n> options.
 
 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.
@@ -290,6 +348,11 @@ Sets secure mode.
 
 Sets script mode.
 
 
 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
 =item B<overwrite-init-file> I<false>
 
 If set to I<false> then the I<W> key will not overwrite the
@@ -308,6 +371,7 @@ L<top(1)>,
 L<virsh(1)>,
 L<xm(1)>,
 L<xentop(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/>
@@ -380,5 +444,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