diff options
author | Richard W.M. Jones <rjones@redhat.com> | 2010-11-24 18:49:37 +0000 |
---|---|---|
committer | Richard W.M. Jones <rjones@redhat.com> | 2010-11-24 20:13:13 +0000 |
commit | 37e632b7b8e1bd8c9893bb8e3c9a8691c78256a4 (patch) | |
tree | 7af132af80fbbc739a664620cc436d3345603566 /ruby/examples/guestfs-ruby.pod | |
parent | 472722a72df89895bb11a1244eafa7915b1af116 (diff) | |
download | libguestfs-37e632b7b8e1bd8c9893bb8e3c9a8691c78256a4.tar.gz libguestfs-37e632b7b8e1bd8c9893bb8e3c9a8691c78256a4.tar.xz libguestfs-37e632b7b8e1bd8c9893bb8e3c9a8691c78256a4.zip |
ruby: Translate C examples into Ruby and include documentation.
Diffstat (limited to 'ruby/examples/guestfs-ruby.pod')
-rw-r--r-- | ruby/examples/guestfs-ruby.pod | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/ruby/examples/guestfs-ruby.pod b/ruby/examples/guestfs-ruby.pod new file mode 100644 index 00000000..d3ce9287 --- /dev/null +++ b/ruby/examples/guestfs-ruby.pod @@ -0,0 +1,67 @@ +=encoding utf8 + +=head1 NAME + +guestfs-ruby - How to use libguestfs from Ruby + +=head1 SYNOPSIS + + require 'guestfs' + g = Guestfs::Guestfs.new() + g.add_drive_opts("disk.img", + :readonly => 1, :format => "raw") + g.launch() + +=head1 DESCRIPTION + +This manual page documents how to call libguestfs from the Ruby +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 EXCEPTIONS + +Errors from libguestfs functions are mapped into the C<Error> +exception. This has a single parameter which is the error message (a +string). + +=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-python(3)>, +L<http://libguestfs.org/>. + +=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 |