1 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD. Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
53 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
65 . \" fudge factors for nroff and troff
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 . \" simple accents for nroff and troff
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
97 . \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 . \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 . \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
124 .\" ========================================================================
126 .IX Title "VIRT-TOP 1"
127 .TH VIRT-TOP 1 "2011-01-06" "virt-top-1.0.4" "Virtualization Support"
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
133 virt\-top \- 'top'\-like utility for virtualization stats
138 .IX Header "DESCRIPTION"
139 virt-top is a \fItop\fR\|(1)\-like utility for showing stats of virtualized
140 domains. Many keys and command line options are the same as for
143 It uses libvirt so it is capable of showing stats across a variety of
144 different virtualization systems.
149 Display physical CPUs by default (instead of domains).
150 When virt-top is running, use the \fI1\fR key to toggle
151 between physical CPUs and domains display.
154 Display network interfaces by default (instead of domains).
155 When virt-top is running, use the \fI2\fR key to toggle
156 between network interfaces and domains display.
159 Display block devices (virtual disks) by default (instead of domains).
160 When virt-top is running, use the \fI3\fR key to toggle
161 between block devices and domains display.
164 Batch mode. In this mode keypresses are ignored.
165 .IP "\fB\-c uri\fR or \fB\-\-connect uri\fR" 4
166 .IX Item "-c uri or --connect uri"
167 Connect to \s-1URI\s0 given. The default is to connect to the Xen
170 To connect to \s-1QEMU/KVM\s0 you would normally do \fI\-c qemu:///system\fR
172 To connect to libvirtd on a remote machine you would normally do
173 \&\fI\-c xen://host/\fR
175 Full details on connection URIs is available at
176 <http://libvirt.org/uri.html>
177 .IP "\fB\-d delay\fR" 4
179 Set the delay between screen updates in seconds.
180 The default is 3.0 seconds. You can change this
181 while virt-top is running by pressing either \fIs\fR or \fId\fR key.
182 .IP "\fB\-n iterations\fR" 4
183 .IX Item "-n iterations"
184 Set the number of iterations to run. The default
185 is to run continuously.
186 .IP "\fB\-o sort\fR" 4
188 Set the sort order to one of:
189 \&\fBcpu\fR (sort by \f(CW%CPU\fR used),
190 \&\fBmem\fR (sort by total memory),
191 \&\fBtime\fR (sort by total time),
192 \&\fBid\fR (sort by domain \s-1ID\s0),
193 \&\fBname\fR (sort by domain name),
194 \&\fBnetrx\fR (sort by network received bytes),
195 \&\fBnettx\fR (sort by network transmitted bytes),
196 \&\fBblockrdrq\fR (sort by block device [disk] read requests),
197 \&\fBblockwrrq\fR (sort by block device [disk] write requests).
199 While virt-top is running you can change the sort
200 order using keys \fIP\fR (cpu), \fIM\fR (memory),
201 \&\fIT\fR (total time), \fIN\fR (domain \s-1ID\s0),
202 \&\fIF\fR (interactively select the sort field).
205 Secure mode. Currently this does nothing.
206 .IP "\fB\-\-hist\-cpu secs\fR" 4
207 .IX Item "--hist-cpu secs"
208 Set the time in seconds between updates of the historical
209 \&\f(CW%CPU\fR at the top right of the display.
210 .IP "\fB\-\-csv file.csv\fR" 4
211 .IX Item "--csv file.csv"
212 Write the statistics to file \fIfile.csv\fR. First a header is written
213 showing the statistics being recorded in each column, then one line is
214 written for each screen update. The \s-1CSV\s0 file can be loaded directly
215 by most spreadsheet programs.
217 Currently the statistics which this records vary between releases of
218 virt-top (but the column headers will stay the same, so you can use
219 those to process the \s-1CSV\s0 file).
221 Not every version of virt-top supports \s-1CSV\s0 output \- it depends how the
222 program was compiled (see \fI\s-1README\s0\fR file in the source distribution
225 To save space you can compress your \s-1CSV\s0 files (if your shell supports
226 this feature, eg. \fIbash\fR):
229 \& virt\-top \-\-csv >(gzip \-9 > output.csv.gz)
232 You can use a similar trick to split the \s-1CSV\s0 file up. In this example
233 the \s-1CSV\s0 file is split every 1000 lines into files called
234 \&\fIoutput.csv.00\fR, \fIoutput.csv.01\fR etc.
237 \& virt\-top \-\-csv >(split \-d \-l 1000 \- output.csv.)
239 .IP "\fB\-\-no\-csv\-cpu\fR" 4
240 .IX Item "--no-csv-cpu"
241 Disable domain \s-1CPU\s0 stats in \s-1CSV\s0 output.
242 .IP "\fB\-\-no\-csv\-block\fR" 4
243 .IX Item "--no-csv-block"
244 Disable domain block device stats in \s-1CSV\s0 output.
245 .IP "\fB\-\-no\-csv\-net\fR" 4
246 .IX Item "--no-csv-net"
247 Disable domain network interface stats in \s-1CSV\s0 output.
248 .IP "\fB\-\-debug filename\fR" 4
249 .IX Item "--debug filename"
250 Send debug and error messages to \fIfilename\fR.
251 To send error messages to syslog you can do:
254 \& virt\-top \-\-debug >(logger \-t virt\-top)
257 See also \s-1REPORTING\s0 \s-1BUGS\s0 below.
258 .IP "\fB\-\-init\-file filename\fR" 4
259 .IX Item "--init-file filename"
260 Read \fIfilename\fR as the init file instead of the default which is
261 \&\fI\f(CI$HOME\fI/.virt\-toprc\fR. See also \s-1INIT\s0 \s-1FILE\s0 below.
262 .IP "\fB\-\-no\-init\-file\fR" 4
263 .IX Item "--no-init-file"
264 Do not read any init file.
265 .IP "\fB\-\-script\fR" 4
267 Script mode. There will be no user interface. This is most useful
268 when used together with the \fI\-\-csv\fR and \fI\-n\fR options.
269 .IP "\fB\-\-end\-time time\fR" 4
270 .IX Item "--end-time time"
271 The program will exit at the \fItime\fR given.
273 The time may be given in one of the following formats:
275 .IP "\fIYYYY-MM-DD \s-1HH:MM:SS\s0\fR" 4
276 .IX Item "YYYY-MM-DD HH:MM:SS"
277 End time is the date and time given.
278 .IP "\fI\s-1HH:MM:SS\s0\fR" 4
280 End time is the time given, today.
281 .IP "\fI+HH:MM:SS\fR" 4
283 End time is \s-1HH\s0 hours, \s-1MM\s0 minutes, \s-1SS\s0 seconds in the future (counted
284 from the moment that program starts).
287 End time is \fIsecs\fR seconds in the future.
291 For example to run the program for 3 minutes you could do:
294 \& virt\-top \-\-end\-time +00:03:00
300 \& virt\-top \-\-end\-time +180
303 Not every version of virt-top supports this option \- it depends how the
304 program was compiled (see \fI\s-1README\s0\fR file in the source distribution
307 .IP "\fB\-\-help\fR" 4
309 Display usage summary.
310 .IP "\fB\-\-version\fR" 4
312 Display version number and exit.
315 Note that keys are case sensitive. For example use upper-case \fIP\fR
316 (shift P) to sort by \f(CW%CPU\fR. \fI^\fR before a key means a Ctrl key, so
317 \&\fI^L\fR is Ctrl L.
318 .IP "\fIspace\fR or \fI^L\fR" 4
319 .IX Item "space or ^L"
327 .IP "\fIs\fR or \fId\fR" 4
329 Change the delay between screen updates.
330 .IP "\fI0\fR (number 0)" 4
331 .IX Item "0 (number 0)"
332 Show the normal list of domains display.
333 .IP "\fI1\fR (number 1)" 4
334 .IX Item "1 (number 1)"
335 Toggle into showing physical CPUs. If pressed
336 again toggles back to showing domains (the normal
340 Toggle into showing network interfaces. If pressed
341 again toggles back to showing domains.
344 Toggle into showing block devices (virtual disks). If pressed again
345 toggles back to showing domains.
348 Sort by \f(CW%CPU\fR.
351 Sort by total memory. Note that this shows the total memory
352 allocated to the guest, not the memory being used.
358 Sort by domain \s-1ID\s0.
361 Select the sort field interactively (there are other
362 sort fields you can choose using this key).
365 This creates or overwrites the init file with the current settings.
367 This key is disabled if \fI\-\-no\-init\-file\fR was specified on the
368 command line or if \fIoverwrite-init-file false\fR is given in
371 .IX Header "INIT FILE"
372 When virt-top starts up, it reads initial settings from the
373 file \fI.virt\-toprc\fR in the user's home directory.
375 The name of this file may be overridden using the \fI\-\-init\-file
376 filename\fR command line option or may be disabled entirely using
377 \&\fI\-\-no\-init\-file\fR.
379 The init file has a simple format. Blank lines and comments
380 beginning with \fI#\fR are ignored. Everything else is a set of
381 \&\fIkey value\fR pairs, described below.
382 .IP "\fBdisplay\fR \fItask|pcpu|block|net\fR" 4
383 .IX Item "display task|pcpu|block|net"
384 Sets the major display mode to one of \fItask\fR (tasks, the
385 default), \fIpcpu\fR (physical CPUs), \fIblock\fR (block devices),
386 or \fInet\fR (network interfaces).
387 .IP "\fBdelay\fR \fIsecs\fR" 4
388 .IX Item "delay secs"
389 Sets the delay between display updates in seconds.
390 .IP "\fBhist-cpu\fR \fIsecs\fR" 4
391 .IX Item "hist-cpu secs"
392 Sets the historical \s-1CPU\s0 delay in seconds.
393 .IP "\fBiterations\fR \fIn\fR" 4
394 .IX Item "iterations n"
395 Sets the number of iterations to run before we exit. Setting
396 this to \fI\-1\fR means to run continuously.
397 .IP "\fBsort\fR \fIcpu|mem|time|id|name|...\fR" 4
398 .IX Item "sort cpu|mem|time|id|name|..."
399 Sets the sort order. The option names are the same as for
400 the command line \fI\-o\fR option.
401 .IP "\fBconnect\fR \fIuri\fR" 4
402 .IX Item "connect uri"
403 Sets the default connection \s-1URI\s0.
404 .IP "\fBdebug\fR \fIfilename\fR" 4
405 .IX Item "debug filename"
406 Sets the default filename to use for debug and error messages.
407 .IP "\fBcsv\fR \fIfilename\fR" 4
408 .IX Item "csv filename"
409 Enables \s-1CSV\s0 output to the named file.
410 .IP "\fBcsv-cpu\fR \fItrue|false\fR" 4
411 .IX Item "csv-cpu true|false"
412 Enable or disable domain \s-1CPU\s0 stats in \s-1CSV\s0 output.
413 .IP "\fBcsv-block\fR \fItrue|false\fR" 4
414 .IX Item "csv-block true|false"
415 Enable or disable domain block device stats in \s-1CSV\s0 output.
416 .IP "\fBcsv-net\fR \fItrue|false\fR" 4
417 .IX Item "csv-net true|false"
418 Enable or disable domain network interface stats in \s-1CSV\s0 output.
419 .IP "\fBbatch\fR \fItrue|false\fR" 4
420 .IX Item "batch true|false"
422 .IP "\fBsecure\fR \fItrue|false\fR" 4
423 .IX Item "secure true|false"
425 .IP "\fBscript\fR \fItrue|false\fR" 4
426 .IX Item "script true|false"
428 .IP "\fBend-time\fR \fItime\fR" 4
429 .IX Item "end-time time"
430 Set the time at which the program exits. See above for the
431 time formats supported.
432 .IP "\fBoverwrite-init-file\fR \fIfalse\fR" 4
433 .IX Item "overwrite-init-file false"
434 If set to \fIfalse\fR then the \fIW\fR key will not overwrite the
437 Note that in the current implementation, options specified in
438 the init file override options specified on the command line.
439 This is a bug and this behaviour may change in the future.
441 .IX Header "SEE ALSO"
444 <http://www.libvirt.org/ocaml/>,
445 <http://www.libvirt.org/>,
446 <http://people.redhat.com/~rjones/>,
447 <http://caml.inria.fr/>
450 Richard W.M. Jones <rjones @ redhat . com>
452 .IX Header "COPYRIGHT"
453 (C) Copyright 2007\-2011 Red Hat Inc., Richard W.M. Jones
456 This program is free software; you can redistribute it and/or modify
457 it under the terms of the \s-1GNU\s0 General Public License as published by
458 the Free Software Foundation; either version 2 of the License, or
459 (at your option) any later version.
461 This program is distributed in the hope that it will be useful,
462 but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
463 \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. See the
464 \&\s-1GNU\s0 General Public License for more details.
466 You should have received a copy of the \s-1GNU\s0 General Public License
467 along with this program; if not, write to the Free Software
468 Foundation, Inc., 675 Mass Ave, Cambridge, \s-1MA\s0 02139, \s-1USA\s0.
470 .IX Header "REPORTING BUGS"
471 Bugs can be viewed on the Red Hat Bugzilla page:
472 <https://bugzilla.redhat.com/>.
474 If you find a bug in virt-top, please follow these steps to report it:
475 .IP "1. Check for existing bug reports" 4
476 .IX Item "1. Check for existing bug reports"
477 Go to <https://bugzilla.redhat.com/> and search for similar bugs.
478 Someone may already have reported the same bug, and they may even
480 .IP "2. Capture debug and error messages" 4
481 .IX Item "2. Capture debug and error messages"
485 \& virt\-top \-\-debug virt\-top.log
488 and keep \fIvirt\-top.log\fR. It contains error messages which you
489 should submit with your bug report.
490 .IP "3. Get version of virt-top and version of libvirt." 4
491 .IX Item "3. Get version of virt-top and version of libvirt."
495 \& virt\-top \-\-version
498 If you can get the precise version of libvirt you are using
499 then that too is helpful.
500 .IP "4. Submit a bug report." 4
501 .IX Item "4. Submit a bug report."
502 Go to <https://bugzilla.redhat.com/> and enter a new bug.
503 Please describe the problem in as much detail as possible.
505 Remember to include the version numbers (step 3) and the debug
506 messages file (step 2).
507 .IP "5. Assign the bug to rjones @ redhat.com" 4
508 .IX Item "5. Assign the bug to rjones @ redhat.com"
509 Assign or reassign the bug to \fBrjones @ redhat.com\fR (without the
510 spaces). You can also send me an email with the bug number if you
511 want a faster response.