X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=src%2Fguestfs.pod;h=3b43b6549441f839c455f99252af5287616db838;hb=6cdd349e6964636c2b7ae71453dca33716dda486;hp=9d1e6afa78b31e4436ee99406770bd93a79c7eee;hpb=c7328142c93426fcb1c15431f592c8df2ce30e1f;p=libguestfs.git diff --git a/src/guestfs.pod b/src/guestfs.pod index 9d1e6af..3b43b65 100644 --- a/src/guestfs.pod +++ b/src/guestfs.pod @@ -99,7 +99,7 @@ this: * disk image. */ guestfs_touch (g, "/hello"); - + /* This is only needed for libguestfs < 1.5.24. Since then * it is done automatically when you close the handle. See * discussion of autosync in this page. @@ -352,13 +352,13 @@ descriptor N. For example, L writes its output to stdout by doing: - guestfs_download (filename, "/dev/stdout"); + guestfs_download (g, filename, "/dev/stdout"); and you can write tar output to a pipe C by doing: char devfd[64]; snprintf (devfd, sizeof devfd, "/dev/fd/%d", fd); - guestfs_tar_out ("/", devfd); + guestfs_tar_out (g, "/", devfd); =head2 LISTING FILES @@ -675,9 +675,9 @@ 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<$g-Emount($path)> in Perl, C in Python, -and C in OCaml. In other words, a +that the C call C is +C<$g-Eadd_drive_ro($file)> in Perl, C in Python, +and C in OCaml. In other words, a straightforward, predictable isomorphism between each language. Error messages are automatically transformed @@ -713,11 +713,11 @@ with libguestfs. =item B -For documentation see L. +See L. =item B -For documentation see L. +See L. =item B @@ -728,15 +728,15 @@ The PHP binding only works correctly on 64 bit machines. =item B -For documentation see L. +See L. =item B -For documentation see L. +See L. =item B -For documentation see L. +See L. =back @@ -912,8 +912,8 @@ architecture for multithreaded programs using libvirt and libguestfs. =head2 PATH -Libguestfs needs a kernel and initrd.img, which it finds by looking -along an internal path. +Libguestfs needs a supermin appliance, which it finds by looking along +an internal path. By default it looks for these in the directory C<$libdir/guestfs> (eg. C or C). @@ -1711,7 +1711,8 @@ indicator which shows the ratio of C:C. =item * If any progress notification is sent during a call, then a final -progress notification is always sent when C = C. +progress notification is always sent when C = C +(I the call fails with an error). This is to simplify caller code, so callers can easily set the progress indicator to "100%" at the end of the operation, without @@ -2457,8 +2458,8 @@ example: =item LIBGUESTFS_PATH -Set the path that libguestfs uses to search for kernel and initrd.img. -See the discussion of paths in section PATH above. +Set the path that libguestfs uses to search for a supermin appliance. +See the discussion of paths in section L above. =item LIBGUESTFS_QEMU