* virt-top/virt_top_calendar.ml: Added --end-time option.
[virt-top.git] / virt-top / virt-top.1
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  | will give a
29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
32 .tr \(*W-|\(bv\*(Tr
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "VIRT-TOP 1"
132 .TH VIRT-TOP 1 "2007-10-19" "ocaml-libvirt-0.3.3.0" "Virtualization Support"
133 .SH "NAME"
134 virt\-top \- 'top'\-like utility for virtualization stats
135 .SH "SUMMARY"
136 .IX Header "SUMMARY"
137 virt-top [\-options]
138 .SH "DESCRIPTION"
139 .IX Header "DESCRIPTION"
140 virt-top is a \fItop\fR\|(1)\-like utility for showing stats of virtualized
141 domains.  Many keys and command line options are the same as for
142 ordinary \fItop\fR.
143 .PP
144 It uses libvirt so it is capable of showing stats across a variety of
145 different virtualization systems.
146 .SH "OPTIONS"
147 .IX Header "OPTIONS"
148 .IP "\fB\-1\fR" 4
149 .IX Item "-1"
150 Display physical CPUs by default (instead of domains).
151 When virt-top is running, use the \fI1\fR key to toggle
152 between physical CPUs and domains display.
153 .IP "\fB\-2\fR" 4
154 .IX Item "-2"
155 Display network interfaces by default (instead of domains).
156 When virt-top is running, use the \fI2\fR key to toggle
157 between network interfaces and domains display.
158 .IP "\fB\-3\fR" 4
159 .IX Item "-3"
160 Display block devices (virtual disks) by default (instead of domains).
161 When virt-top is running, use the \fI3\fR key to toggle
162 between block devices and domains display.
163 .IP "\fB\-b\fR" 4
164 .IX Item "-b"
165 Batch mode.  In this mode keypresses are ignored.
166 .IP "\fB\-c uri\fR or \fB\-\-connect uri\fR" 4
167 .IX Item "-c uri or --connect uri"
168 Connect to \s-1URI\s0 given.  The default is to connect to the Xen
169 hypervisor.
170 .IP "\fB\-d delay\fR" 4
171 .IX Item "-d delay"
172 Set the delay between screen updates in seconds.
173 The default is 3.0 seconds.  You can change this
174 while virt-top is running by pressing either \fIs\fR or \fId\fR key.
175 .IP "\fB\-n iterations\fR" 4
176 .IX Item "-n iterations"
177 Set the number of iterations to run.  The default
178 is to run continuously.
179 .IP "\fB\-o sort\fR" 4
180 .IX Item "-o sort"
181 Set the sort order to one of:
182 \&\fBcpu\fR (sort by \f(CW%CPU\fR used),
183 \&\fBmem\fR (sort by memory used),
184 \&\fBtime\fR (sort by total time),
185 \&\fBid\fR (sort by domain \s-1ID\s0),
186 \&\fBname\fR (sort by domain name),
187 \&\fBnetrx\fR (sort by network received bytes),
188 \&\fBnettx\fR (sort by network transmitted bytes),
189 \&\fBblockrdrq\fR (sort by block device [disk] read requests),
190 \&\fBblockwrrq\fR (sort by block device [disk] write requests).
191 .Sp
192 While virt-top is running you can change the sort
193 order using keys \fIP\fR (cpu), \fIM\fR (memory),
194 \&\fIT\fR (total time), \fIN\fR (domain \s-1ID\s0),
195 \&\fIF\fR (interactively select the sort field).
196 .IP "\fB\-s\fR" 4
197 .IX Item "-s"
198 Secure mode.  Currently this does nothing.
199 .IP "\fB\-\-hist\-cpu secs\fR" 4
200 .IX Item "--hist-cpu secs"
201 Set the time in seconds between updates of the historical
202 \&\f(CW%CPU\fR at the top right of the display.
203 .IP "\fB\-\-csv file.csv\fR" 4
204 .IX Item "--csv file.csv"
205 Write the statistics to file \fIfile.csv\fR.  First a header is written
206 showing the statistics being recorded in each column, then one line is
207 written for each screen update.  The \s-1CSV\s0 file can be loaded directly
208 by most spreadsheet programs.
209 .Sp
210 Currently the statistics which this records vary between releases of
211 virt-top (but the column headers will stay the same, so you can use
212 those to process the \s-1CSV\s0 file).
213 .Sp
214 Not every version of virt-top supports \s-1CSV\s0 output \- it depends how the
215 program was compiled (see \fI\s-1README\s0\fR file in the source distribution
216 for details).
217 .Sp
218 To save space you can compress your \s-1CSV\s0 files (if your shell supports
219 this feature, eg. \fIbash\fR):
220 .Sp
221 .Vb 1
222 \& virt-top --csv >(gzip -9 > output.csv.gz)
223 .Ve
224 .Sp
225 You can use a similar trick to split the \s-1CSV\s0 file up.  In this example
226 the \s-1CSV\s0 file is split every 1000 lines into files called
227 \&\fIoutput.csv.00\fR, \fIoutput.csv.01\fR etc.
228 .Sp
229 .Vb 1
230 \& virt-top --csv >(split -d -l 1000 - output.csv.)
231 .Ve
232 .IP "\fB\-\-no\-csv\-cpu\fR" 4
233 .IX Item "--no-csv-cpu"
234 Disable domain \s-1CPU\s0 stats in \s-1CSV\s0 output.
235 .IP "\fB\-\-no\-csv\-block\fR" 4
236 .IX Item "--no-csv-block"
237 Disable domain block device stats in \s-1CSV\s0 output.
238 .IP "\fB\-\-no\-csv\-net\fR" 4
239 .IX Item "--no-csv-net"
240 Disable domain network interface stats in \s-1CSV\s0 output.
241 .IP "\fB\-\-debug filename\fR" 4
242 .IX Item "--debug filename"
243 Send debug and error messages to \fIfilename\fR.
244 To send error messages to syslog you can do:
245 .Sp
246 .Vb 1
247 \& virt-top --debug >(logger -t virt-top)
248 .Ve
249 .Sp
250 See also \s-1REPORTING\s0 \s-1BUGS\s0 below.
251 .IP "\fB\-\-init\-file filename\fR" 4
252 .IX Item "--init-file filename"
253 Read \fIfilename\fR as the init file instead of the default which is
254 \&\fI$HOME/.virt\-toprc\fR.  See also \s-1INIT\s0 \s-1FILE\s0 below.
255 .IP "\fB\-\-no\-init\-file\fR" 4
256 .IX Item "--no-init-file"
257 Do not read any init file.
258 .IP "\fB\-\-script\fR" 4
259 .IX Item "--script"
260 Script mode.  There will be no user interface.  This is most useful
261 when used together with the \fI\-\-csv\fR and \fI\-n\fR options.
262 .IP "\fB\-\-end\-time time\fR" 4
263 .IX Item "--end-time time"
264 The program will exit at the \fItime\fR given.
265 .Sp
266 The time may be given in one of the following formats:
267 .RS 4
268 .IP "\fIYYYY-MM-DD \s-1HH:MM:SS\s0\fR" 4
269 .IX Item "YYYY-MM-DD HH:MM:SS"
270 End time is the date and time given.
271 .IP "\fI\s-1HH:MM:SS\s0\fR" 4
272 .IX Item "HH:MM:SS"
273 End time is the time given, today.
274 .IP "\fI+HH:MM:SS\fR" 4
275 .IX Item "+HH:MM:SS"
276 End time is \s-1HH\s0 hours, \s-1MM\s0 minutes, \s-1SS\s0 seconds in the future (counted
277 from the moment that program starts).
278 .IP "\fI+secs\fR" 4
279 .IX Item "+secs"
280 End time is \fIsecs\fR seconds in the future.
281 .RE
282 .RS 4
283 .Sp
284 For example to run the program for 3 minutes you could do:
285 .Sp
286 .Vb 1
287 \& virt-top --end-time +00:03:00
288 .Ve
289 .Sp
290 or:
291 .Sp
292 .Vb 1
293 \& virt-top --end-time +180
294 .Ve
295 .Sp
296 Not every version of virt-top supports this option \- it depends how the
297 program was compiled (see \fI\s-1README\s0\fR file in the source distribution
298 for details).
299 .RE
300 .IP "\fB\-\-help\fR" 4
301 .IX Item "--help"
302 Display usage summary.
303 .SH "KEYS"
304 .IX Header "KEYS"
305 Note that keys are case sensitive.  For example use upper-case \fIP\fR
306 (shift P) to sort by \f(CW%CPU\fR.  \fI^\fR before a key means a Ctrl key, so
307 \&\fI^L\fR is Ctrl L.
308 .IP "\fIspace\fR or \fI^L\fR" 4
309 .IX Item "space or ^L"
310 Updates the display.
311 .IP "\fIq\fR" 4
312 .IX Item "q"
313 Quits the program.
314 .IP "\fIh\fR" 4
315 .IX Item "h"
316 Displays help.
317 .IP "\fIs\fR or \fId\fR" 4
318 .IX Item "s or d"
319 Change the delay between screen updates.
320 .IP "\fI0\fR (number 0)" 4
321 .IX Item "0 (number 0)"
322 Show the normal list of domains display.
323 .IP "\fI1\fR (number 1)" 4
324 .IX Item "1 (number 1)"
325 Toggle into showing physical CPUs.  If pressed
326 again toggles back to showing domains (the normal
327 display).
328 .IP "\fI2\fR" 4
329 .IX Item "2"
330 Toggle into showing network interfaces.  If pressed
331 again toggles back to showing domains.
332 .IP "\fI3\fR" 4
333 .IX Item "3"
334 Toggle into showing block devices (virtual disks).  If pressed again
335 toggles back to showing domains.
336 .IP "\fIP\fR" 4
337 .IX Item "P"
338 Sort by \f(CW%CPU\fR.
339 .IP "\fIM\fR" 4
340 .IX Item "M"
341 Sort by memory.
342 .IP "\fIT\fR" 4
343 .IX Item "T"
344 Sort by total time.
345 .IP "\fIN\fR" 4
346 .IX Item "N"
347 Sort by domain \s-1ID\s0.
348 .IP "\fIF\fR" 4
349 .IX Item "F"
350 Select the sort field interactively (there are other
351 sort fields you can choose using this key).
352 .IP "\fIW\fR" 4
353 .IX Item "W"
354 This creates or overwrites the init file with the current settings.
355 .Sp
356 This key is disabled if \fI\-\-no\-init\-file\fR was specified on the
357 command line or if \fIoverwrite-init-file false\fR is given in
358 the init file.
359 .SH "INIT FILE"
360 .IX Header "INIT FILE"
361 When virt-top starts up, it reads initial settings from the
362 file \fI.virt\-toprc\fR in the user's home directory.
363 .PP
364 The name of this file may be overridden using the \fI\-\-init\-file
365 filename\fR command line option or may be disabled entirely using
366 \&\fI\-\-no\-init\-file\fR.
367 .PP
368 The init file has a simple format.  Blank lines and comments
369 beginning with \fI#\fR are ignored.  Everything else is a set of
370 \&\fIkey value\fR pairs, described below.
371 .IP "\fBdisplay\fR \fItask|pcpu|block|net\fR" 4
372 .IX Item "display task|pcpu|block|net"
373 Sets the major display mode to one of \fItask\fR (tasks, the
374 default), \fIpcpu\fR (physical CPUs), \fIblock\fR (block devices),
375 or \fInet\fR (network interfaces).
376 .IP "\fBdelay\fR \fIsecs\fR" 4
377 .IX Item "delay secs"
378 Sets the delay between display updates in seconds.
379 .IP "\fBhist-cpu\fR \fIsecs\fR" 4
380 .IX Item "hist-cpu secs"
381 Sets the historical \s-1CPU\s0 delay in seconds.
382 .IP "\fBiterations\fR \fIn\fR" 4
383 .IX Item "iterations n"
384 Sets the number of iterations to run before we exit.  Setting
385 this to \fI\-1\fR means to run continuously.
386 .IP "\fBsort\fR \fIcpu|mem|time|id|name|...\fR" 4
387 .IX Item "sort cpu|mem|time|id|name|..."
388 Sets the sort order.  The option names are the same as for
389 the command line \fI\-o\fR option.
390 .IP "\fBconnect\fR \fIuri\fR" 4
391 .IX Item "connect uri"
392 Sets the default connection \s-1URI\s0.
393 .IP "\fBdebug\fR \fIfilename\fR" 4
394 .IX Item "debug filename"
395 Sets the default filename to use for debug and error messages.
396 .IP "\fBcsv\fR \fIfilename\fR" 4
397 .IX Item "csv filename"
398 Enables \s-1CSV\s0 output to the named file.
399 .IP "\fBcsv-cpu\fR \fItrue|false\fR" 4
400 .IX Item "csv-cpu true|false"
401 Enable or disable domain \s-1CPU\s0 stats in \s-1CSV\s0 output.
402 .IP "\fBcsv-block\fR \fItrue|false\fR" 4
403 .IX Item "csv-block true|false"
404 Enable or disable domain block device stats in \s-1CSV\s0 output.
405 .IP "\fBcsv-net\fR \fItrue|false\fR" 4
406 .IX Item "csv-net true|false"
407 Enable or disable domain network interface stats in \s-1CSV\s0 output.
408 .IP "\fBbatch\fR \fItrue|false\fR" 4
409 .IX Item "batch true|false"
410 Sets batch mode.
411 .IP "\fBsecure\fR \fItrue|false\fR" 4
412 .IX Item "secure true|false"
413 Sets secure mode.
414 .IP "\fBscript\fR \fItrue|false\fR" 4
415 .IX Item "script true|false"
416 Sets script mode.
417 .IP "\fBend-time\fR \fItime\fR" 4
418 .IX Item "end-time time"
419 Set the time at which the program exits.  See above for the
420 time formats supported.
421 .IP "\fBoverwrite-init-file\fR \fIfalse\fR" 4
422 .IX Item "overwrite-init-file false"
423 If set to \fIfalse\fR then the \fIW\fR key will not overwrite the
424 init file.
425 .PP
426 Note that in the current implementation, options specified in
427 the init file override options specified on the command line.
428 This is a bug and this behaviour may change in the future.
429 .SH "SEE ALSO"
430 .IX Header "SEE ALSO"
431 \&\fItop\fR\|(1),
432 \&\fIvirsh\fR\|(1),
433 \&\fIxm\fR\|(1),
434 \&\fIxentop\fR\|(1),
435 <http://www.libvirt.org/>,
436 <http://et.redhat.com/~rjones/>,
437 <http://caml.inria.fr/>
438 .SH "AUTHORS"
439 .IX Header "AUTHORS"
440 Richard W.M. Jones <rjones @ redhat . com>
441 .SH "COPYRIGHT"
442 .IX Header "COPYRIGHT"
443 (C) Copyright 2007 Red Hat Inc., Richard W.M. Jones
444 http://libvirt.org/
445 .PP
446 This program is free software; you can redistribute it and/or modify
447 it under the terms of the \s-1GNU\s0 General Public License as published by
448 the Free Software Foundation; either version 2 of the License, or
449 (at your option) any later version.
450 .PP
451 This program is distributed in the hope that it will be useful,
452 but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
453 \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.  See the
454 \&\s-1GNU\s0 General Public License for more details.
455 .PP
456 You should have received a copy of the \s-1GNU\s0 General Public License
457 along with this program; if not, write to the Free Software
458 Foundation, Inc., 675 Mass Ave, Cambridge, \s-1MA\s0 02139, \s-1USA\s0.
459 .SH "REPORTING BUGS"
460 .IX Header "REPORTING BUGS"
461 Bugs can be viewed on the Red Hat Bugzilla page:
462 <https://bugzilla.redhat.com/>.
463 .PP
464 If you find a bug in virt\-top, please follow these steps to report it:
465 .IP "1. Check for existing bug reports" 4
466 .IX Item "1. Check for existing bug reports"
467 Go to <https://bugzilla.redhat.com/> and search for similar bugs.
468 Someone may already have reported the same bug, and they may even
469 have fixed it.
470 .IP "2. Capture debug and error messages" 4
471 .IX Item "2. Capture debug and error messages"
472 Run
473 .Sp
474 .Vb 1
475 \& virt-top --debug virt-top.log
476 .Ve
477 .Sp
478 and keep \fIvirt\-top.log\fR.  It contains error messages which you
479 should submit with your bug report.
480 .IP "3. Get version of virt-top and version of libvirt." 4
481 .IX Item "3. Get version of virt-top and version of libvirt."
482 In virt\-top, press the \fIh\fR (help) key, and write down the version of
483 virt-top and the version of libvirt.  They are shown in the first
484 line.
485 .IP "4. Submit a bug report." 4
486 .IX Item "4. Submit a bug report."
487 Go to <https://bugzilla.redhat.com/> and enter a new bug.
488 Please describe the problem in as much detail as possible.
489 .Sp
490 Remember to include the version numbers (step 3) and the debug
491 messages file (step 2).
492 .IP "5. Assign the bug to rjones @ redhat.com" 4
493 .IX Item "5. Assign the bug to rjones @ redhat.com"
494 Assign or reassign the bug to \fBrjones @ redhat.com\fR (without the
495 spaces).  You can also send me an email with the bug number if you
496 want a faster response.