X-Git-Url: http://git.annexia.org/?p=virt-top.git;a=blobdiff_plain;f=README;h=b5df0f59f81423d7d890c3f3bcdd938881597bd7;hp=67e5ab484dde823811460f029fee0ef7d9fb331d;hb=8a8008134e997330d61e0b9736e9067b5689b531;hpb=d445e4f54fcfd19a98451eb0b5b5b5237bf9df78 diff --git a/README b/README index 67e5ab4..b5df0f5 100644 --- a/README +++ b/README @@ -1,7 +1,7 @@ ocaml-libvirt ---------------------------------------------------------------------- -Copyright (C) 2007 Richard W.M. Jones, Red Hat Inc. +Copyright (C) 2007-2008 Richard W.M. Jones, Red Hat Inc. http://libvirt.org/ocaml/ http://libvirt.org/ @@ -152,33 +152,6 @@ domains, or show the machine console. Programming ---------------------------------------------------------------------- -The interface is described in 'libvirt.mli'. The main modules are -Libvirt.Connect, Libvirt.Domain and Libvirt.Network, corresponding -respectively to the virConnect*, virDomain*, and virNetwork* -functions. For brevity I usually rename these modules like this: - - module C = Libvirt.Connect - module D = Libvirt.Domain - module N = Libvirt.Network - -To get a connection handle, do: - - let name = "xen:///" - let conn = C.connect ~name () - -To list domains, do: - - let n = C.num_of_domains conn - let ids = C.list_domains conn n - let domains = Array.map (D.lookup_by_id conn) ids - let () = - Array.iter ( - fun dom -> - printf "%5d %s\n" (D.get_id dom) (D.get_name dom) - ) domains - -(See also the program list_domains.ml). - For documentation on these bindings, read libvirt.mli and/or 'make doc' and browse the HTML documentation in the html/ subdirectory. @@ -193,4 +166,4 @@ examples/ Some example programs using the bindings. mlvirsh/ 'mlvirsh' command line tool. virt-ctrl/ 'virt-ctrl' graphical tool. virt-top/ 'virt-top' tool. -virt-df/ 'virt-df' tool. \ No newline at end of file +virt-df/ 'virt-df' tool.