diff options
Diffstat (limited to 'examples/guestfs-examples.pod')
-rw-r--r-- | examples/guestfs-examples.pod | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/examples/guestfs-examples.pod b/examples/guestfs-examples.pod new file mode 100644 index 00000000..858ac61e --- /dev/null +++ b/examples/guestfs-examples.pod @@ -0,0 +1,63 @@ +=encoding utf8 + +=head1 NAME + +guestfs-examples - Examples of using libguestfs from C + +=head1 SYNOPSIS + + #include <guestfs.h> + + guestfs_h *g = guestfs_create (); + guestfs_add_drive_ro (g, "disk.img"); + guestfs_launch (g); + + cc prog.c -o prog -lguestfs +or: + cc prog.c -o prog `pkg-config libguestfs --cflags --libs` + +=head1 DESCRIPTION + +This manual page contains examples of calling libguestfs from +the C programming language. If you are not familiar with using +libguestfs, you also need to read L<guestfs(3)>. + +=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-ocaml(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) 2010 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 |