Fixed to build virt-ctrl.
[virt-ctrl.git] / README
1 ocaml-libvirt
2 ----------------------------------------------------------------------
3
4 Copyright (C) 2007-2008 Richard W.M. Jones, Red Hat Inc.
5 http://libvirt.org/ocaml/
6 http://libvirt.org/
7
8 'virt-ctrl' (originally called 'mlvirtmanager') is a reimplementation
9 of virt-manager in OCaml.  It is not feature-complete by any means,
10 but does allow you to show the running domains and start and stop
11 defined domains.  The main functionality _missing_ is the ability to
12 define new virtual machines, change the resources allocated to
13 domains, or show the machine console.
14
15
16 Building
17 ----------------------------------------------------------------------
18
19   ./configure           # Checks that you have all the required bits.
20
21   make all              # Builds the bytecode version of libs/programs.
22   make opt              # Builds the native code version of libs/programs.
23
24   make install          # Install in OCaml directory, and the binaries
25                         # in $prefix/bin.
26
27 Then have a look at the program 'virt-ctrl.opt'.
28
29
30 Windows
31 ----------------------------------------------------------------------
32
33 I have built libvirt (the bindings), examples, mlvirsh and virt-ctrl
34 on Windows using the MinGW port of OCaml.  It's quite likely that it
35 will also work under VC++, but I have not tested this.
36
37 You should make sure that your $PATH (environment variable) contains
38 the names of the directories containing all required DLLs, in
39 particular you will require:
40
41   libvirt-*.dll         (from libvirt)
42   libgnutls-*.dll       (from GnuTLS)
43   libgcrypt-*.dll
44   libgpg-error-*.dll
45   libtasn1-*.dll
46   libxdr.dll            (from libxdr)
47   libxml2-*.dll         (from libxml2)
48   and, a multitude of DLLs from GTK if you want to run virt-ctrl
49
50 You can use a tool such as Dependency Walker to find/check the
51 locations of dependent libraries.
52
53 To build the Windows installer, you will need NSIS.  Then do:
54
55   ./configure --with-nsis=/c/Progra~1/NSIS
56   make all opt
57   make wininstaller
58
59 This should build a Windows binary installer called
60 ocaml-libvirt-$VERSION.exe which includes the bindings, all required
61 DLLs and all programs that can be built under Windows.