Ignore config.cache (./configure -C)

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

diff --git a/virt-top/virt-top.txt b/virt-top/virt-top.txt
old mode 100644 (file)
new mode 100755 (executable)
index 85b003f..d222451
--- a/virt-top/virt-top.txt
+++ b/virt-top/virt-top.txt
@@ -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
@@ -72,6 +80,17 @@ 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.
 
@@ -100,6 +119,36 @@ OPTIONS
         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.
 
@@ -205,6 +254,10 @@ INIT FILE
     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.
 
@@ -213,12 +266,30 @@ INIT FILE
     this behaviour may change in the future.
 
 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), xm(1), xentop(1), <http://www.libvirt.org/ocaml/>,
+    <http://www.libvirt.org/>, <http://et.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/
+
+    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/>.