* virt-top/virt_top_calendar.ml: Added --end-time option.

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

diff --git a/virt-top/virt-top.txt b/virt-top/virt-top.txt
index 7eeb1cd..052b51a 100644 (file)
--- a/virt-top/virt-top.txt
+++ b/virt-top/virt-top.txt
@@ -72,6 +72,26 @@ 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.
+
+    --no-csv-block
+        Disable domain block device stats in CSV output.
+
+    --no-csv-net
+        Disable domain network interface stats in CSV output.
+
     --debug filename
         Send debug and error messages to *filename*. To send error messages
         to syslog you can do:
@@ -87,8 +107,42 @@ OPTIONS
     --no-init-file
         Do not read any init file.
 
+    --script
+        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.
+    Display usage summary.
 
 KEYS
     Note that keys are case sensitive. For example use upper-case *P* (shift
@@ -174,12 +228,28 @@ INIT FILE
     csv *filename*
         Enables CSV output to the named file.
 
+    csv-cpu *true|false*
+        Enable or disable domain CPU stats in CSV output.
+
+    csv-block *true|false*
+        Enable or disable domain block device stats in CSV output.
+
+    csv-net *true|false*
+        Enable or disable domain network interface stats in CSV output.
+
     batch *true|false*
         Sets batch mode.
 
     secure *true|false*
         Sets secure mode.
 
+    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.
 
@@ -194,6 +264,23 @@ SEE ALSO
 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/>.