X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=guestfs.pod;h=0e7079c231afcb8631d962671ca478fb1f1bc5a3;hb=dda10cd9357169d5c55d9d49e270a6202971b8c0;hp=d717595148ac94a68f82b1052be13a999ab782de;hpb=747eb7138ada2c999abc686fc5de18bcad96a1b7;p=libguestfs.git
diff --git a/guestfs.pod b/guestfs.pod
index d717595..0e7079c 100644
--- a/guestfs.pod
+++ b/guestfs.pod
@@ -81,7 +81,9 @@ libguestfs-using programs looks like this:
*/
guestfs_mount (handle, "/dev/sda1", "/");
- /* Now you can perform filesystem actions on the guest disk image. */
+ /* Now you can perform filesystem actions on the guest
+ * disk image.
+ */
guestfs_touch (handle, "/hello");
/* You only need to call guestfs_sync if you have made
@@ -103,8 +105,8 @@ return error indications.
=head2 DISK IMAGES
The image filename (C<"guest.img"> in the example above) could be a
-disk image from a virtual machine, a L
copy of a physical block
-device, an actual block device, or simply an empty file of zeroes that
+disk image from a virtual machine, a L copy of a physical hard
+disk, an actual block device, or simply an empty file of zeroes that
you have created through L. Libguestfs lets you
do useful things to all of these.
@@ -140,7 +142,7 @@ first disk image that we added (C). If the disk contains
Linux LVM2 logical volumes you could refer to those instead (eg. C).
If you are given a disk image and you don't know what it contains then
-you have to find out. Libguestfs can also do that: use
+you have to find out. Libguestfs can do that too: use
C and C to list possible
partitions and LVs, and either try mounting each to see what is
mountable, or else examine them with C. But you might
@@ -417,6 +419,70 @@ yourself, and then pass them to C functions. See also the
programs L, L and L 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. This means
+that the C call C is
+C<$handle-Emount($path)> in Perl, C in Python,
+and C in OCaml. In other words, a
+straightforward, predictable isomorphism between each language.
+
+Error messages are automatically transformed
+into exceptions if the language supports it.
+
+We don't try to "object orientify" parts of the API in OO languages,
+although contributors are welcome to write higher level APIs above
+what we provide in their favourite languages if they wish.
+
+=over 4
+
+=item B
+
+You can use the I header file from C++ programs. The C++
+API is identical to the C API. C++ classes and exceptions are
+not implemented.
+
+=item B
+
+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
+
+Full documentation is contained in the Javadoc which is distributed
+with libguestfs.
+
+=item B
+
+For documentation see the file C.
+
+=item B
+
+For documentation see L.
+
+=item B
+
+For documentation do:
+
+ $ python
+ >>> import guestfs
+ >>> help (guestfs)
+
+=item B
+
+Use the Guestfs module. There is no Ruby-specific documentation, but
+you can find examples written in Ruby in the libguestfs source.
+
+=item B
+
+For documentation see L.
+
+=back
+
=head1 CONNECTION MANAGEMENT
=head2 guestfs_h *