aboutsummaryrefslogtreecommitdiffstats
path: root/tools/libxen/README
diff options
context:
space:
mode:
authorewan@linford.intra <ewan@linford.intra>2006-10-07 18:22:09 +0100
committerewan@linford.intra <ewan@linford.intra>2006-10-07 18:22:09 +0100
commit273a416d0390837723afa57b320b6e7085e3dc0e (patch)
treea29891674aa1253d91f330aeb5d00491f5d14131 /tools/libxen/README
parent7d5ba9b43007bd4c514c81d6310976a5a7f9b3d6 (diff)
downloadxen-273a416d0390837723afa57b320b6e7085e3dc0e.tar.gz
xen-273a416d0390837723afa57b320b6e7085e3dc0e.tar.bz2
xen-273a416d0390837723afa57b320b6e7085e3dc0e.zip
Import libxen-src-0.4.3-2.tar.bz2.
Signed-off-by: Ewan Mellor <ewan@xensource.com>
Diffstat (limited to 'tools/libxen/README')
-rw-r--r--tools/libxen/README54
1 files changed, 54 insertions, 0 deletions
diff --git a/tools/libxen/README b/tools/libxen/README
new file mode 100644
index 0000000000..4aa9450381
--- /dev/null
+++ b/tools/libxen/README
@@ -0,0 +1,54 @@
+Xen API C Bindings
+==================
+
+This distribution is the source code to the proposed Xen API C bindings.
+
+The Xen API project will define an XML-RPC protocol for remote and local
+management of Xen-based systems, and a set of bindings for these XML-RPC calls
+into a number of languages (this package contains those to the C language).
+
+The intention is to standardise these XML-RPC calls, and then the Xen project
+will guarantee that that wire protocol will be supported for the long term.
+The bindings will also be supported in the Xen tree, giving a stable
+foundation for Xen management tools and middlewares, in particular the Xen CIM
+providers and libvirt.
+
+THIS IS A WORK IN PROGRESS. The API and bindings are under active design and
+development, and this is a snapshot release for developers only. Both the API
+and the C bindings are scheduled to be stabilised by the Xen 3.0.4 release
+i.e. October 2006 at the earliest.
+
+These bindings are open-source (LGPL), and will be committed as libraries to
+the Xen trees for all to use after the Xen 3.0.3 release.
+
+We welcome any discussion about this library and the API in general. Please
+join the Xen-API mailing list if you are interested in this project. I (Ewan
+Mellor) will collate all the feedback from that list and push out new versions
+of the document and the bindings as and when.
+
+
+URLs
+----
+
+Xen-API wiki page:
+http://wiki.xensource.com/xenwiki/XenApi
+
+Xen-API mailing list:
+ http://lists.xensource.com/cgi-bin/mailman/listinfo/xen-api
+
+
+Usage
+-----
+
+The bindings depend upon libxml2, the XML toolkit from the GNOME project; the
+test program depends upon libcurl3 also. On Debian, you need the packages
+libxml2-dev and libcurl3-dev.
+
+To compile, type make.
+
+To run the test, do
+
+LD_LIBRARY_PATH=src ./test/test_bindings <url> <username> <password>
+
+where <url> is the fragment of the server URL that follows the http://, for
+example "localhost:8005/RPC2".