diff options
Diffstat (limited to 'perl/examples/guestfs-perl.pod')
-rw-r--r-- | perl/examples/guestfs-perl.pod | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/perl/examples/guestfs-perl.pod b/perl/examples/guestfs-perl.pod new file mode 100644 index 00000000..4840890a --- /dev/null +++ b/perl/examples/guestfs-perl.pod @@ -0,0 +1,72 @@ +=encoding utf8 + +=head1 NAME + +guestfs-perl - How to use libguestfs from Perl + +=head1 SYNOPSIS + + use Sys::Guestfs; + + my $h = Sys::Guestfs->new (); + $h->add_drive_opts ('guest.img', format => 'raw'); + $h->launch (); + $h->mount_options ('', '/dev/sda1', '/'); + $h->touch ('/hello'); + $h->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-ocaml(3)>, +L<guestfs-python(3)>, +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 |