X-Git-Url: http://git.annexia.org/?p=virt-top.git;a=blobdiff_plain;f=virt-top%2Fvirt-top.txt;h=d2224518588aabf24b38b6517f140c456f397252;hp=ee2a4268e9bb6da12d9364350c545b17b65ec0e8;hb=db4e80ee11a4e212a97efc1761ed237c7da72cb1;hpb=a8b837d5018c488a130fcbea425904817a862210 diff --git a/virt-top/virt-top.txt b/virt-top/virt-top.txt index ee2a426..d222451 100644 --- 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 + + -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,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: @@ -80,6 +108,47 @@ 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. + + --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. @@ -122,13 +191,105 @@ 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. + + 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. + + 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), , - , + top(1), virsh(1), xm(1), xentop(1), , + , , + AUTHORS Richard W.M. Jones +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: .