diff options
author | Richard W.M. Jones <rjones@redhat.com> | 2009-11-13 16:36:04 +0000 |
---|---|---|
committer | Richard W.M. Jones <rjones@redhat.com> | 2009-11-13 16:45:07 +0000 |
commit | 5f9be62e68b120f51c948404e7f0cf3430962c68 (patch) | |
tree | ad4c56f51358b3c7e3f95f144b9dd2b3aa14a567 | |
parent | b296287daf9b884aa38646717725f5a389f96ca5 (diff) | |
download | libguestfs-5f9be62e68b120f51c948404e7f0cf3430962c68.tar.gz libguestfs-5f9be62e68b120f51c948404e7f0cf3430962c68.tar.xz libguestfs-5f9be62e68b120f51c948404e7f0cf3430962c68.zip |
Docs: Add documentation about other language bindings to API overview.
-rw-r--r-- | guestfs.pod | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/guestfs.pod b/guestfs.pod index ec073eed..3aa806ab 100644 --- a/guestfs.pod +++ b/guestfs.pod @@ -419,6 +419,60 @@ yourself, and then pass them to C<libhivex> functions. See also the programs L<hivexml(1)>, L<hivexget(1)> and L<virt-win-reg(1)> for more help on this issue. +=head2 USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES + +Although we don't want to discourage you from using the C API, we will +mention here that the same API is also available in other languages. + +The API is broadly identical in all supported languages. As an +example, in Python the handle itself is replaced by an object, but we +don't try to "object orientify" any other parts of the API. + +=over 4 + +=item B<C++> + +You can use the I<guestfs.h> header file from C++ programs. The C++ +API is identical to the C API. + +=item B<Haskell> + +This is the only language binding that is incomplete. Only calls +which return simple integers have been bound in Haskell, and we are +looking for help to complete this binding. + +=item B<Java> + +Full documentation is contained in the Javadoc which is distributed +with libguestfs. + +=item B<OCaml> + +For documentation see the file C<guestfs.mli>. + +=item B<Perl> + +For documentation see L<Sys::Guestfs(3)>. + +=item B<Python> + +For documentation do: + + $ python + >>> import guestfs + >>> help (guestfs) + +=item B<Ruby> + +Use the Guestfs module. There is no Ruby-specific documentation, but +you can find examples written in Ruby in the libguestfs source. + +=item B<shell scripts> + +For documentation see L<guestfish(1)>. + +=back + =head1 CONNECTION MANAGEMENT =head2 guestfs_h * |