X-Git-Url: http://git.annexia.org/?p=virt-top.git;a=blobdiff_plain;f=virt-top%2FREADME;fp=virt-top%2FREADME;h=0000000000000000000000000000000000000000;hp=b594f951310e9c5fd5f40c9ba3701e6e978ad494;hb=2a8acd07005f2e8cdc43a6cc2a4e6f3d66f9fc4d;hpb=ec78262c21c9bb6ccfe52925471a58a2e360043c diff --git a/virt-top/README b/virt-top/README deleted file mode 100755 index b594f95..0000000 --- a/virt-top/README +++ /dev/null @@ -1,57 +0,0 @@ -The code is structured into these files: - - 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.mli / virt_top.ml - - This is the virt-top program. - - 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 - - Any code which needs the optional xml-light library goes - in here. Mainly for parsing domain XML descriptions to get - the list of block devices and network interfaces. - - The reason for having it in a separate file is so that we - don't depend on xml-light. - - virt_top_csv.ml - - 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 the modules together - Virt_top + Virt_top_xml? + Virt_top_csv? + Virt_top_calendar? - -The man-page is generated from the single file: - - virt-top.pod - -which generates (using perldoc) the following: - - virt-top.1 - virt-top.txt