README

   1 ocaml-libvirt
   2 ----------------------------------------------------------------------
   3
   4 Copyright (C) 2007-2009 Richard W.M. Jones, Red Hat Inc.
   5 http://libvirt.org/ocaml/
   6 http://libvirt.org/
   7
   8 This is a complete set of OCaml bindings around libvirt, exposing all
   9 known functionality to OCaml programs.
  10
  11 Building
  12 ----------------------------------------------------------------------
  13
  14   ./configure           # Checks that you have all the required bits.
  15
  16   make all              # Builds the bytecode version of libs/programs.
  17   make opt              # Builds the native code version of libs/programs.
  18
  19   make install          # Install in OCaml directory, and the binaries
  20                         # in $prefix/bin.
  21
  22   make doc              # Build HTML documentation in html/ subdirectory.
  23
  24
  25 Programming
  26 ----------------------------------------------------------------------
  27
  28 For documentation on these bindings, read libvirt.mli and/or 'make
  29 doc' and browse the HTML documentation in the html/ subdirectory.
  30
  31 For documentation on libvirt itself, see http://libvirt.org/html/
  32
  33
  34 License
  35 ----------------------------------------------------------------------
  36
  37 The library is distributed under the GNU LGPL, version 2 or above,
  38 with the OCaml linking exception.  Please see COPYING.LIB for details.
  39
  40 Examples are public domain.
  41
  42
  43 Subdirectories
  44 ----------------------------------------------------------------------
  45
  46 libvirt/                The OCaml bindings.
  47 examples/               Some example programs using the bindings.