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.ml
   6
   7     This is the virt-top program.
   8
   9     The interesting function is called 'redraw', which is responsible
  10     for redrawing the display on each frame.  Another interesting
  11     function is 'start_up' which handles all start-up stuff, eg.
  12     command line arguments, connecting to the hypervisor, enabling
  13     curses.  The function 'main_loop' runs the main loop and has
  14     sub-functions to deal with keypresses, help screens and so on.
  15
  16   virt_top_xml.ml
  17
  18     Any code which needs the optional xml-light library goes
  19     in here.  Mainly for parsing domain XML descriptions to get
  20     the list of block devices and network interfaces.
  21
  22     The reason for having it in a separate file is so that we
  23     don't depend on xml-light.
  24
  25   virt_top_csv.ml
  26
  27     Any code which need the optional ocaml-csv library goes
  28     in here.  This implements the --csv command line option.
  29
  30   virt_top_main.ml
  31
  32     This is just a small bit of code to glue whatever modules
  33     (Virt_top + Virt_top_xml? + Virt_top_csv?) together.
  34
  35 The man-page is generated from the single file:
  36
  37   virt-top.pod
  38
  39 which generates (using perldoc) the following:
  40
  41   virt-top.1
  42   virt-top.txt