src/README

   1 The code is structured into these files:
   2
   3   utils.mli, utils.ml
   4
   5     String functions and other small utility functions.  This is
   6     included directly into virt_top.ml.
   7
   8   types.mli, types.ml
   9
  10     Various internally used types and functions operating on those
  11     types.
  12
  13   collect.mli, collect.ml
  14
  15     Stats information is collected in these functions.
  16
  17   screen.mli, screen.ml
  18
  19     Various useful functions for drawing to the curses screen.
  20
  21   redraw.mli, redraw.ml
  22
  23     Redraw the main display.
  24
  25   csv_output.mli, csv_output.ml
  26
  27     Functions which implement --csv mode.
  28
  29   stream_output.mli, stream_output.ml
  30
  31     Functions which implement --stream mode.
  32
  33   top.mli, top.ml
  34
  35     This is the virt-top program.
  36
  37     'start_up' handles all start-up stuff, eg. command line arguments,
  38     connecting to the hypervisor, enabling curses.
  39
  40     The function 'main_loop' runs the main loop and has sub-functions
  41     to deal with keypresses, help screens and so on.
  42
  43   opt_gettext.ml
  44     A generated file which adds gettext support if ocaml-gettext
  45     was found at configure time, or else stubs it out.
  46
  47   opt_xml.ml
  48
  49     Any code which needs the optional xml-light library goes
  50     in here.  Mainly for parsing domain XML descriptions to get
  51     the list of block devices and network interfaces.
  52
  53     The reason for having it in a separate file is so that we
  54     don't depend on xml-light.
  55
  56   opt_csv.ml
  57
  58     Any code which needs the optional ocaml-csv library goes
  59     in here.
  60
  61   opt_calendar.ml
  62
  63     Any code which needs the optional ocaml-calendar library
  64     (v2) goes in here.  This implements the --end-time command
  65     line option.
  66
  67   main.ml
  68
  69     This is just a small bit of code to glue the modules together
  70     Top + Opt_xml? + Opt_csv? + Opt_calendar?
  71
  72 The man-page is generated from the single file:
  73
  74   virt-top.pod
  75
  76 which generates (using perldoc) the following:
  77
  78   virt-top.1
  79   virt-top.txt