java: Add guestfs-java(3) man page.

[libguestfs.git] / java / examples / guestfs-java.pod

diff --git a/java/examples/guestfs-java.pod b/java/examples/guestfs-java.pod
new file mode 100644 (file)
index 0000000..abf62db
--- /dev/null
+++ b/java/examples/guestfs-java.pod
@@ -0,0 +1,80 @@
+=encoding utf8
+
+=head1 NAME
+
+guestfs-java - How to use libguestfs from Java
+
+=head1 SYNOPSIS
+
+ import com.redhat.et.libguestfs.*;
+ 
+ GuestFS g = new GuestFS ();
+ g.add_drive_opts ("disk.img", null);
+ g.launch ();
+
+=head1 DESCRIPTION
+
+This manual page documents how to call libguestfs from the Java
+programming language.  This page just documents the differences from
+the C API and gives some examples.  If you are not familiar with using
+libguestfs, you also need to read L<guestfs(3)>.
+
+=head2 CLOSING THE HANDLE
+
+The handle is closed when it is reaped by the garbage collector.
+Because libguestfs handles include a lot of state, it is also
+possible to close (and hence free) them explicitly by calling
+the C<close> method.
+
+=head2 EXCEPTIONS
+
+Errors from libguestfs functions are mapped into the
+C<LibGuestFSException> exception.  This has a single parameter which
+is the error message (a C<String>).
+
+Calling any method on a closed handle raises the same exception.
+
+=head1 EXAMPLE 1: CREATE A DISK IMAGE
+
+@EXAMPLE1@
+
+=head1 EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE
+
+@EXAMPLE2@
+
+=head1 SEE ALSO
+
+L<guestfs(3)>,
+L<guestfs-examples(3)>,
+L<guestfs-ocaml(3)>,
+L<guestfs-perl(3)>,
+L<guestfs-python(3)>,
+L<guestfs-recipes(1)>,
+L<guestfs-ruby(3)>,
+L<http://libguestfs.org/>,
+L<http://caml.inria.fr/>.
+
+=head1 AUTHORS
+
+Richard W.M. Jones (C<rjones at redhat dot com>)
+
+=head1 COPYRIGHT
+
+Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>
+
+The examples in this manual page may be freely copied, modified and
+distributed without any restrictions.
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA