Add Erlang bindings.
[libguestfs.git] / examples / guestfs-examples.pod
1 =encoding utf8
2
3 =head1 NAME
4
5 guestfs-examples - Examples of using libguestfs from C
6
7 =head1 SYNOPSIS
8
9  #include <guestfs.h>
10  
11  guestfs_h *g = guestfs_create ();
12  guestfs_add_drive_ro (g, "disk.img");
13  guestfs_launch (g);
14
15  cc prog.c -o prog -lguestfs
16 or:
17  cc prog.c -o prog `pkg-config libguestfs --cflags --libs`
18
19 =head1 DESCRIPTION
20
21 This manual page contains examples of calling libguestfs from
22 the C programming language.  If you are not familiar with using
23 libguestfs, you also need to read L<guestfs(3)>.
24
25 =head1 EXAMPLE 1: CREATE A DISK IMAGE
26
27 @EXAMPLE1@
28
29 =head1 EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE
30
31 @EXAMPLE2@
32
33 =head1 SEE ALSO
34
35 L<guestfs(3)>,
36 L<guestfs-erlang(3)>,
37 L<guestfs-java(3)>,
38 L<guestfs-ocaml(3)>,
39 L<guestfs-perl(3)>,
40 L<guestfs-python(3)>,
41 L<guestfs-recipes(1)>,
42 L<guestfs-ruby(3)>,
43 L<http://libguestfs.org/>.
44
45 =head1 AUTHORS
46
47 Richard W.M. Jones (C<rjones at redhat dot com>)
48
49 =head1 COPYRIGHT
50
51 Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>
52
53 The examples in this manual page may be freely copied, modified and
54 distributed without any restrictions.
55
56 This library is free software; you can redistribute it and/or
57 modify it under the terms of the GNU Lesser General Public
58 License as published by the Free Software Foundation; either
59 version 2 of the License, or (at your option) any later version.
60
61 This library is distributed in the hope that it will be useful,
62 but WITHOUT ANY WARRANTY; without even the implied warranty of
63 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
64 Lesser General Public License for more details.
65
66 You should have received a copy of the GNU Lesser General Public
67 License along with this library; if not, write to the Free Software
68 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA