X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=README;h=38a190207ffd02c96481977b1adb95c5c327c6c8;hb=d7e0e6112db9411b0d7aaa8cbf5ce85c27e7d52d;hp=78a4df86abff6301483fd1c82c6466e9f52c1161;hpb=387659e02777e9098f58f1d4afaa6b8ce561663c;p=ocaml-libvirt.git diff --git a/README b/README index 78a4df8..38a1902 100644 --- a/README +++ b/README @@ -1,14 +1,13 @@ ocaml-libvirt ---------------------------------------------------------------------- -Copyright (C) 2007-2008 Richard W.M. Jones, Red Hat Inc. +Copyright (C) 2007-2009 Richard W.M. Jones, Red Hat Inc. http://libvirt.org/ocaml/ http://libvirt.org/ This is a complete set of OCaml bindings around libvirt, exposing all known functionality to OCaml programs. - Building ---------------------------------------------------------------------- @@ -22,75 +21,23 @@ Building make doc # Build HTML documentation in html/ subdirectory. -Then have a look at the program 'mlvirsh.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 -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 +Programming ---------------------------------------------------------------------- -'mlvirsh' is an almost complete reimplementation of virsh, which is -mostly command compatible (there are a very few commands missing, and -some commands have a slightly different syntax, but broadly speaking -they are equivalent programs except that one is written in C and the -other in OCaml). - -At the time of writing: - - wc -c wc -l - - virsh 126,056 4,641 - mlvirsh 19,427 598 +For documentation on these bindings, read libvirt.mli and/or 'make +doc' and browse the HTML documentation in the html/ subdirectory. - % size 15% 13% +For documentation on libvirt itself, see http://libvirt.org/html/ -Programming +License ---------------------------------------------------------------------- -For documentation on these bindings, read libvirt.mli and/or 'make -doc' and browse the HTML documentation in the html/ subdirectory. +The library is distributed under the GNU LGPL, version 2 or above, +with the OCaml linking exception. Please see COPYING.LIB for details. -For documentation on libvirt itself, see http://libvirt.org/html/ +Examples are public domain. Subdirectories @@ -98,4 +45,3 @@ Subdirectories libvirt/ The OCaml bindings. examples/ Some example programs using the bindings. -mlvirsh/ 'mlvirsh' command line tool.