Merge remote-tracking branch 'weblate/master' into master
[virt-top.git] / README
1 virt-top
2 ----------------------------------------------------------------------
3
4 Copyright (C) 2007-2016 Richard W.M. Jones, Red Hat Inc.
5 http://et.redhat.com/~rjones/virt-top/
6 http://libvirt.org/ocaml/
7 http://libvirt.org/
8
9 virt-top is a top-like utility for showing stats of virtualized
10 domains. Many keys and command line options are the same as for
11 ordinary top.
12
13 It uses libvirt so it capable of showing stats across a variety of
14 different virtualization systems.
15
16
17 Requirements
18 ----------------------------------------------------------------------
19
20 OCaml >= 3.11.0
21 ocaml-libvirt >= 0.6.1.1 (for virDomainGetCPUStats support)
22 OCaml extlib
23 OCaml curses
24
25 Optional:
26 OCaml gettext
27 OCaml xml-light
28 OCaml CSV
29 OCaml Calendar, version 2 is preferred
30 perldoc
31 msgfmt
32
33
34 Building
35 ----------------------------------------------------------------------
36
37   ./configure           # Checks that you have all the required bits.
38
39   make all              # Builds the bytecode version of the program.
40   make opt              # Builds the native code version of the program.
41
42 Then have a look at the program 'virt-top/virt-top.opt'.