New API: mkfs_opts, mkfs with optional arguments.

[libguestfs.git] / src / guestfs.pod

diff --git a/src/guestfs.pod b/src/guestfs.pod
index fc58f4f..7cb05a6 100644 (file)
--- a/src/guestfs.pod
+++ b/src/guestfs.pod
@@ -52,6 +52,9 @@ need enough permissions to access the disk images.
 Libguestfs is a large API because it can do many things.  For a gentle
 introduction, please read the L</API OVERVIEW> section next.
 
 Libguestfs is a large API because it can do many things.  For a gentle
 introduction, please read the L</API OVERVIEW> section next.
 

+There are also some example programs in the L<guestfs-examples(3)>
+manual page.
+

 =head1 API OVERVIEW
 
 This section provides a gentler overview of the libguestfs API.  We
 =head1 API OVERVIEW
 
 This section provides a gentler overview of the libguestfs API.  We


@@ -654,7 +657,7 @@ with libguestfs.
 
 =item B<OCaml>
 
 
 =item B<OCaml>
 

-For documentation see the file C<guestfs.mli>.
+For documentation see L<guestfs-ocaml(3)>.

 
 =item B<Perl>
 
 
 =item B<Perl>
 


@@ -669,16 +672,11 @@ The PHP binding only works correctly on 64 bit machines.
 
 =item B<Python>
 
 
 =item B<Python>
 

-For documentation do:
-
- $ python
- >>> import guestfs
- >>> help (guestfs)
+For documentation see L<guestfs-python(3)>.

 
 =item B<Ruby>
 
 
 =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.
+For documentation see L<guestfs-ruby(3)>.

 
 =item B<shell scripts>
 
 
 =item B<shell scripts>
 


@@ -1857,6 +1855,14 @@ The header contains the procedure number (C<guestfs_proc>) which is
 how the receiver knows what type of args structure to expect, or none
 at all.
 
 how the receiver knows what type of args structure to expect, or none
 at all.
 

+For functions that take optional arguments, the optional arguments are
+encoded in the C<guestfs_I<foo>_args> structure in the same way as
+ordinary arguments.  A bitmask in the header indicates which optional
+arguments are meaningful.  The bitmask is also checked to see if it
+contains bits set which the daemon does not know about (eg. if more
+optional arguments were added in a later version of the library), and
+this causes the call to be rejected.
+

 The reply message for ordinary functions is:
 
  total length (header + ret,
 The reply message for ordinary functions is:
 
  total length (header + ret,


@@ -2083,11 +2089,16 @@ enough.
 
 =head1 SEE ALSO
 
 
 =head1 SEE ALSO
 

+L<guestfs-examples(3)>,
+L<guestfs-ocaml(3)>,
+L<guestfs-python(3)>,
+L<guestfs-ruby(3)>,

 L<guestfish(1)>,
 L<guestmount(1)>,
 L<virt-cat(1)>,
 L<virt-df(1)>,
 L<virt-edit(1)>,
 L<guestfish(1)>,
 L<guestmount(1)>,
 L<virt-cat(1)>,
 L<virt-df(1)>,
 L<virt-edit(1)>,

+L<virt-filesystems(1)>,

 L<virt-inspector(1)>,
 L<virt-list-filesystems(1)>,
 L<virt-list-partitions(1)>,
 L<virt-inspector(1)>,
 L<virt-list-filesystems(1)>,
 L<virt-list-partitions(1)>,