virt-top/README

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