X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=guestfs.pod;h=4a477330f1b05bf89e2f38baea69a73ffb232071;hb=2d9953097b6d3b71122d444a4550047e97aee009;hp=3aa806abd9c2c8c77edd9562da377f2d6ff4e5c3;hpb=5f9be62e68b120f51c948404e7f0cf3430962c68;p=libguestfs.git diff --git a/guestfs.pod b/guestfs.pod index 3aa806a..4a47733 100644 --- a/guestfs.pod +++ b/guestfs.pod @@ -105,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. @@ -142,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 @@ -424,16 +424,26 @@ help on this issue. 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. +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. +API is identical to the C API. C++ classes and exceptions are +not implemented. =item B @@ -613,6 +623,13 @@ developer to program in confidence against libguestfs. @STRUCTS@ +=head1 AVAILABILITY + +Using L you can test availability of +the following groups of functions: + +@AVAILABILITY@ + =head1 STATE MACHINE AND LOW-LEVEL EVENT API Internally, libguestfs is implemented by running a virtual machine