X-Git-Url: http://git.annexia.org/?p=virt-top.git;a=blobdiff_plain;f=README;h=67e5ab484dde823811460f029fee0ef7d9fb331d;hp=b56dc49f2f8ccd78cf6867669b89c27cf501189d;hb=6f3635fe4dc9989745d154c8b346c47e4d384121;hpb=3126bfee333b5c635dc60a54265936af06117f6a

diff --git a/README b/README
old mode 100755
new mode 100644
index b56dc49..67e5ab4
--- a/README
+++ b/README
@@ -12,22 +12,21 @@ known functionality to OCaml programs.
 Requirements
 ----------------------------------------------------------------------
 
-To build the bindings (required):
+To build the bindings, examples, and mlvirsh (required):
 
   GNU make, gcc
   libvirt >= 0.2.1 (from http://libvirt.org/,
   	     	    get the latest version if you can)
   ocaml >= 3.08 (from http://caml.inria.fr/)
+
+Optional, but highly recommended:
+
   findlib (from http://www.ocaml-programming.de/packages/)
 
 To build the OCaml interface documentation (optional):
 
   ocamldoc (part of OCaml itself)
 
-To build mlvirsh (optional):
-
-  Extlib (from http://ocaml-lib.sourceforge.net/)
-
 To build virt-top (optional):
 
   ocaml-curses (from http://www.nongnu.org/ocaml-tmk/)
@@ -40,7 +39,7 @@ To build virt-top (optional):
   The other packages are not required, but you will get reduced
   functionality].
 
-To build mlvirtmanager (optional):
+To build virt-ctrl (optional):
 
   GTK2 (from http://gtk.org/)
   lablgtk2 (from http://wwwfun.kurims.kyoto-u.ac.jp/soft/lsl/lablgtk.html)
@@ -49,6 +48,10 @@ To build the manpages (optional):
 
   perldoc (part of Perl)
 
+To build a Windows installer (optional):
+
+  NSIS (http://nsis.sf.net)
+
 OCaml packages are available for Fedora 7 and above (ocaml,
 ocaml-findlib, ocaml-findlib-devel, ocaml-ocamldoc, ocaml-extlib,
 ocaml-extlib-devel, ocaml-lablgtk, ocaml-lablgtk-devel, ocaml-curses,
@@ -73,7 +76,7 @@ Building
 
   make doc              # Build HTML documentation in html/ subdirectory.
 
-Then have a look at the programs 'mlvirsh.opt' and 'mlvirtmanager.opt'.
+Then have a look at the programs 'mlvirsh.opt' and 'virt-ctrl.opt'.
 
 Note: If you want to run the programs without first installing, you
 may need to set your $LD_LIBRARY_PATH environment variable so it
@@ -82,6 +85,40 @@ contains the build directory.  eg:
   LD_LIBRARY_PATH=libvirt/ mlvirsh/mlvirsh.opt
 
 
+Windows
+----------------------------------------------------------------------
+
+I have built libvirt (the bindings), examples, mlvirsh and virt-ctrl
+on Windows using the MinGW port of OCaml.  It's quite likely that it
+will also work under VC++, but I have not tested this.
+
+You should make sure that your $PATH (environment variable) contains
+the names of the directories containing all required DLLs, in
+particular you will require:
+
+  libvirt-*.dll		(from libvirt)
+  libgnutls-*.dll	(from GnuTLS)
+  libgcrypt-*.dll
+  libgpg-error-*.dll
+  libtasn1-*.dll
+  libxdr.dll		(from libxdr)
+  libxml2-*.dll		(from libxml2)
+  and, a multitude of DLLs from GTK if you want to run virt-ctrl
+
+You can use a tool such as Dependency Walker to find/check the
+locations of dependent libraries.
+
+To build the Windows installer, you will need NSIS.  Then do:
+
+  ./configure --with-nsis=/c/Progra~1/NSIS
+  make all opt
+  make wininstaller
+
+This should build a Windows binary installer called
+ocaml-libvirt-$VERSION.exe which includes the bindings, all required
+DLLs and all programs that can be built under Windows.
+
+
 mlvirsh
 ----------------------------------------------------------------------
 
@@ -101,15 +138,15 @@ At the time of writing:
   % size        15%    13%
 
 
-mlvirtmanager
+virt-ctrl
 ----------------------------------------------------------------------
 
-'mlvirtmanager' is a demonstration implementation of virt-manager in
-OCaml.  It is not feature-complete by any means, but does allow you to
-show the running domains and start and stop defined domains.  The main
-functionality _missing_ is the ability to define new virtual machines,
-change the resources allocated to domains, or show the machine
-console.
+'virt-ctrl' (originally called 'mlvirtmanager') is a reimplementation
+of virt-manager in OCaml.  It is not feature-complete by any means,
+but does allow you to show the running domains and start and stop
+defined domains.  The main functionality _missing_ is the ability to
+define new virtual machines, change the resources allocated to
+domains, or show the machine console.
 
 
 Programming
@@ -154,5 +191,6 @@ Subdirectories
 libvirt/		The OCaml bindings.
 examples/		Some example programs using the bindings.
 mlvirsh/		'mlvirsh' command line tool.
-mlvirtmanager/		'mlvirtmanager' graphical tool.
+virt-ctrl/		'virt-ctrl' graphical tool.
 virt-top/		'virt-top' tool.
+virt-df/		'virt-df' tool.
\ No newline at end of file