* virt-top/virt_top_calendar.ml: Added --end-time option.

[virt-top.git] / virt-top / README

diff --git a/virt-top/README b/virt-top/README
index 8618fad..3b64e88 100644 (file)
--- a/virt-top/README
+++ b/virt-top/README
@@ -1,22 +1,26 @@
-$Id: README,v 1.1 2007/08/30 13:52:40 rjones Exp $
-
 The code is structured into these files:
 
-  virt_top_utils.ml
+  virt_top_utils.mli / virt_top_utils.ml
 
     String functions and other small utility functions.  This is
     included directly into virt_top.ml.
 
-  virt_top.ml
+  virt_top.mli / virt_top.ml
 
     This is the virt-top program.
 
-    The interesting function is called 'redraw', which is responsible
-    for redrawing 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.
+    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
 
@@ -32,6 +36,12 @@ The code is structured into these files:
     Any code which needs the optional ocaml-csv library goes
     in here.  This implements the --csv command line option.
 
+  virt_top_calendar.ml
+
+    Any code which needs the optional ocaml-calendar library
+    goes in here.  This implements the --end-time command line
+    option.
+
   virt_top_main.ml
 
     This is just a small bit of code to glue whatever modules