Don't call curses endwin if we are in script mode.

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

diff --git a/virt-top/virt-top.txt b/virt-top/virt-top.txt
index ee2a426..f3f7ac5 100644 (file)
--- a/virt-top/virt-top.txt
+++ b/virt-top/virt-top.txt
@@ -72,6 +72,15 @@ OPTIONS
         the program was compiled (see *README* file in the source
         distribution for details).
 
+    --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:
@@ -80,6 +89,17 @@ OPTIONS
 
         See also REPORTING BUGS below.
 
+    --init-file filename
+        Read *filename* as the init file instead of the default which is
+        *$HOME/.virt-toprc*. See also INIT FILE below.
+
+    --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.
+
     --help
         Display usage summary.
 
@@ -122,6 +142,76 @@ KEYS
     *F* Select the sort field interactively (there are other sort fields you
         can choose using this key).
 
+    *W* This creates or overwrites the init file with the current settings.
+
+        This key is disabled if *--no-init-file* was specified on the
+        command line or if *overwrite-init-file false* is given in the init
+        file.
+
+INIT FILE
+    When virt-top starts up, it reads initial settings from the file
+    *.virt-toprc* in the user's home directory.
+
+    The name of this file may be overridden using the *--init-file filename*
+    command line option or may be disabled entirely using *--no-init-file*.
+
+    The init file has a simple format. Blank lines and comments beginning
+    with *#* are ignored. Everything else is a set of *key value* pairs,
+    described below.
+
+    display *task|pcpu|block|net*
+        Sets the major display mode to one of *task* (tasks, the default),
+        *pcpu* (physical CPUs), *block* (block devices), or *net* (network
+        interfaces).
+
+    delay *secs*
+        Sets the delay between display updates in seconds.
+
+    hist-cpu *secs*
+        Sets the historical CPU delay in seconds.
+
+    iterations *n*
+        Sets the number of iterations to run before we exit. Setting this to
+        *-1* means to run continuously.
+
+    sort *cpu|mem|time|id|name|...*
+        Sets the sort order. The option names are the same as for the
+        command line *-o* option.
+
+    connect *uri*
+        Sets the default connection URI.
+
+    debug *filename*
+        Sets the default filename to use for debug and error messages.
+
+    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.
+
+    overwrite-init-file *false*
+        If set to *false* then the *W* key will not overwrite the init file.
+
+    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.
+
 SEE ALSO
     top(1), virsh(1), xm(1), xentop(1), <http://www.libvirt.org/>,
     <http://et.redhat.com/~rjones/>, <http://caml.inria.fr/>
@@ -129,6 +219,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/>.