summaryrefslogtreecommitdiffstats
path: root/perl/examples/guestfs-perl.pod
blob: 9686a2f1dbbb7ff7853ac02e611289d73de90708 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
=encoding utf8

=head1 NAME

guestfs-perl - How to use libguestfs from Perl

=head1 SYNOPSIS

 use Sys::Guestfs;
 
 my $g = Sys::Guestfs->new ();
 $g->add_drive ('guest.img', format => 'raw');
 $g->launch ();
 $g->mount_options ('', '/dev/sda1', '/');
 $g->touch ('/hello');
 $g->sync ();

=head1 DESCRIPTION

This manual page documents how to call libguestfs from the Perl
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)>.  To read the
full Perl API, see L<Sys::Guestfs(3)>.

=head2 ERRORS

Errors from libguestfs functions turn into calls to
C<croak> (see L<Carp(3)>).

=head1 EXAMPLE 1: CREATE A DISK IMAGE

@EXAMPLE1@

=head1 EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE

@EXAMPLE2@

=head1 SEE ALSO

L<Sys::Guestfs(3)>,
L<guestfs(3)>,
L<guestfs-examples(3)>,
L<guestfs-erlang(3)>,
L<guestfs-java(3)>,
L<guestfs-ocaml(3)>,
L<guestfs-python(3)>,
L<guestfs-recipes(1)>,
L<guestfs-ruby(3)>,
L<http://libguestfs.org/>.

=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