blob: ebebbfa4930509082e50fba08f341ed67fda40aa (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
|
$Id: README,v 1.1 2007/08/30 13:52:40 rjones Exp $
The code is structured into these files:
virt_top_utils.ml
String functions and other small utility functions. This is
included directly into virt_top.ml.
virt_top.ml
This is the virt-top program.
The two interesting functions are called 'collect' and 'redraw'.
'collect' collects all the information about domains, etc.
'redraw' updates the display on each frame.
Another interesting function is 'start_up' which handles all
start-up stuff, eg. command line arguments, connecting to the
hypervisor, enabling curses.
The function 'main_loop' runs the main loop and has sub-functions
to deal with keypresses, help screens and so on.
virt_top_xml.ml
Any code which needs the optional xml-light library goes
in here. Mainly for parsing domain XML descriptions to get
the list of block devices and network interfaces.
The reason for having it in a separate file is so that we
don't depend on xml-light.
virt_top_csv.ml
Any code which needs the optional ocaml-csv library goes
in here. This implements the --csv command line option.
virt_top_main.ml
This is just a small bit of code to glue whatever modules
(Virt_top + Virt_top_xml? + Virt_top_csv?) together.
The man-page is generated from the single file:
virt-top.pod
which generates (using perldoc) the following:
virt-top.1
virt-top.txt
|