1 $Id: README,v 1.1 2007/08/30 13:52:40 rjones Exp $
3 The code is structured into these files:
7 String functions and other small utility functions. This is
8 included directly into virt_top.ml.
12 This is the virt-top program.
14 The interesting function is called 'redraw', which is responsible
15 for redrawing the display on each frame. Another interesting
16 function is 'start_up' which handles all start-up stuff, eg.
17 command line arguments, connecting to the hypervisor, enabling
18 curses. The function 'main_loop' runs the main loop and has
19 sub-functions to deal with keypresses, help screens and so on.
23 Any code which needs the optional xml-light library goes
24 in here. Mainly for parsing domain XML descriptions to get
25 the list of block devices and network interfaces.
27 The reason for having it in a separate file is so that we
28 don't depend on xml-light.
32 Any code which needs the optional ocaml-csv library goes
33 in here. This implements the --csv command line option.
37 This is just a small bit of code to glue whatever modules
38 (Virt_top + Virt_top_xml? + Virt_top_csv?) together.
40 The man-page is generated from the single file:
44 which generates (using perldoc) the following: