← Back to branch summary

~ubuntu-branches/ubuntu/quantal/virt-top/quantal

« back to all changes in this revision

Viewing changes to virt-top/virt-top.pod

  • Committer: Package Import Robot
  • Author(s): Laurent Léonard
  • Date: 2011-08-15 23:19:06 UTC
  • mfrom: (3.1.4 sid)
  • Revision ID: package-import@ubuntu.com-20110815231906-rp38flx2z9jpx1gx
Tags: 1.0.6-1
* [7c3e6a1] Imported Upstream version 1.0.6
* [f0a771b] Redo patch
* [6629856] Bump Standards-Version to 3.9.2
* [930eafd] New patch 0002-Ensure-manpages-get-built-when-using-native-
  compiler.patch

Show diffs side-by-side

added added

removed removed

Lines of Context:
virt-top/virt-top.pod
43
43
 
44
44
=item B<-c uri> or B<--connect uri>
45
45
 
46
 
Connect to URI given.  The default is to connect to the Xen
47
 
hypervisor.
 
46
Connect to the libvirt URI given.
48
47
 
49
48
To connect to QEMU/KVM you would normally do I<-c qemu:///system>
50
49
 
 
50
To connect to Xen on the same host, do I<-c xen:///>
 
51
 
51
52
To connect to libvirtd on a remote machine you would normally do
52
 
I<-c xen://host/>
53
 
 
54
 
Full details on connection URIs is available at
55
 
L<http://libvirt.org/uri.html>
 
53
I<-c qemu://host/system>
 
54
 
 
55
If this option is not given then virt-top connects by default
 
56
to whatever is the default hypervisor for libvirt, although
 
57
this can be overridden by setting environment variables.
 
58
 
 
59
See the libvirt documentation at L<http://libvirt.org/uri.html>
 
60
for further information.
56
61
 
57
62
=item B<-d delay>
58
63
 
122
127
 
123
128
Disable domain CPU stats in CSV output.
124
129
 
 
130
=item B<--no-csv-mem>
 
131
 
 
132
Disable domain memory stats in CSV output.
 
133
 
125
134
=item B<--no-csv-block>
126
135
 
127
136
Disable domain block device stats in CSV output.
153
162
Script mode.  There will be no user interface.  This is most useful
154
163
when used together with the I<--csv> and I<-n> options.
155
164
 
 
165
=item B<--stream>
 
166
 
 
167
Stream mode.  All output is sent to stdout.  This can be used from
 
168
shell scripts etc.  There is no user interface.
 
169
 
 
170
=item B<--block-in-bytes>
 
171
 
 
172
Show I/O statistics in Bytes. Default is shown in the number of Requests.
 
173
 
156
174
=item B<--end-time time>
157
175
 
158
176
The program will exit at the I<time> given.
226
244
 
227
245
Change the delay between screen updates.
228
246
 
 
247
=item I<B>
 
248
 
 
249
Toggle Block I/O statistics so they are shown in either bytes or requests.
 
250
 
229
251
=item I<0> (number 0)
230
252
 
231
253
Show the normal list of domains display.
333
355
 
334
356
Enable or disable domain CPU stats in CSV output.
335
357
 
 
358
=item B<csv-mem> I<true|false>
 
359
 
 
360
Enable or disable domain memory stats in CSV output.
 
361
 
336
362
=item B<csv-block> I<true|false>
337
363
 
338
364
Enable or disable domain block device stats in CSV output.
353
379
 
354
380
Sets script mode.
355
381
 
 
382
=item B<stream> I<true|false>
 
383
 
 
384
Sets stream mode.
 
385
 
 
386
=item B<block-in-bytes> I<true|false>
 
387
 
 
388
Show block device statistics in bytes.
 
389
 
356
390
=item B<end-time> I<time>
357
391
 
358
392
Set the time at which the program exits.  See above for the
371
405
 
372
406
=head1 NOTES
373
407
 
 
408
=head2 Block I/O statistics
 
409
 
 
410
This I/O value is the amount of I/O since the previous iteration
 
411
of virt-top. To calculate speed of I/O, you should divide
 
412
the number by delay secs.
 
413
 
374
414
=head2 NETWORK RX BYTES AND PACKETS
375
415
 
376
416
Libvirt/virt-top has no way to know that a packet transmitted to a
384
424
the network interface is idle or down.  These are caused by STP
385
425
packets generated by the bridge.
386
426
 
 
427
=head2 DEBUGGING LIBVIRT ISSUES
 
428
 
 
429
virt-top tries to turn libvirt errors into informative messages.
 
430
However if libvirt initialization fails then this is not possible.
 
431
Instead you will get an obscure error like:
 
432
 
 
433
 libvir: error : Unknown failure
 
434
 Fatal error: exception Libvirt.Virterror(...)
 
435
 
 
436
To see the cause of libvirt errors in more detail, enable libvirt
 
437
debugging by setting this environment variable:
 
438
 
 
439
 export LIBVIRT_DEBUG=1
 
440
 
387
441
=head1 SEE ALSO
388
442
 
389
443
L<top(1)>,