2 ----------------------------------------------------------------------
4 Copyright (C) 2007-2008 Richard W.M. Jones, Red Hat Inc.
5 http://libvirt.org/ocaml/
8 This is a complete set of OCaml bindings around libvirt, exposing all
9 known functionality to OCaml programs.
13 ----------------------------------------------------------------------
15 ./configure # Checks that you have all the required bits.
17 make all # Builds the bytecode version of libs/programs.
18 make opt # Builds the native code version of libs/programs.
20 make install # Install in OCaml directory, and the binaries
23 make doc # Build HTML documentation in html/ subdirectory.
25 Then have a look at the program 'mlvirsh.opt'.
27 Note: If you want to run the programs without first installing, you
28 may need to set your $LD_LIBRARY_PATH environment variable so it
29 contains the build directory. eg:
31 LD_LIBRARY_PATH=libvirt/ mlvirsh/mlvirsh.opt
35 ----------------------------------------------------------------------
37 I have built libvirt (the bindings), examples, mlvirsh and virt-ctrl
38 on Windows using the MinGW port of OCaml. It's quite likely that it
39 will also work under VC++, but I have not tested this.
41 You should make sure that your $PATH (environment variable) contains
42 the names of the directories containing all required DLLs, in
43 particular you will require:
45 libvirt-*.dll (from libvirt)
46 libgnutls-*.dll (from GnuTLS)
50 libxdr.dll (from libxdr)
51 libxml2-*.dll (from libxml2)
52 and, a multitude of DLLs from GTK if you want to run virt-ctrl
54 You can use a tool such as Dependency Walker to find/check the
55 locations of dependent libraries.
57 To build the Windows installer, you will need NSIS. Then do:
59 ./configure --with-nsis=/c/Progra~1/NSIS
63 This should build a Windows binary installer called
64 ocaml-libvirt-$VERSION.exe which includes the bindings, all required
65 DLLs and all programs that can be built under Windows.
69 ----------------------------------------------------------------------
71 'mlvirsh' is an almost complete reimplementation of virsh, which is
72 mostly command compatible (there are a very few commands missing, and
73 some commands have a slightly different syntax, but broadly speaking
74 they are equivalent programs except that one is written in C and the
77 At the time of writing:
88 ----------------------------------------------------------------------
90 For documentation on these bindings, read libvirt.mli and/or 'make
91 doc' and browse the HTML documentation in the html/ subdirectory.
93 For documentation on libvirt itself, see http://libvirt.org/html/
97 ----------------------------------------------------------------------
99 libvirt/ The OCaml bindings.
100 examples/ Some example programs using the bindings.
101 mlvirsh/ 'mlvirsh' command line tool.