Files
libguestfs/ruby/examples/guestfs-ruby.pod
Richard W.M. Jones a57f6b8e2c gobject: Mark the gobject bindings as deprecated
They will be removed in libguestfs 1.58 (the next but one version).
Currently they don't actually compile.  The larger problem is that
they don't handle 64 bit quantities properly (using floats instead),
meaning that any disk size or offset above a certain size will be
improperly passed through the API, usually rounded to the nearest
53 bits.
2025-06-10 11:57:55 +01:00

55 lines
1.1 KiB
Plaintext

=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 => true, :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-erlang(3)>,
L<guestfs-golang(3)>,
L<guestfs-java(3)>,
L<guestfs-lua(3)>,
L<guestfs-ocaml(3)>,
L<guestfs-perl(3)>,
L<guestfs-python(3)>,
L<guestfs-recipes(1)>,
L<http://libguestfs.org/>.
=head1 AUTHORS
Richard W.M. Jones (C<rjones at redhat dot com>)
=head1 COPYRIGHT
Copyright (C) 2010-2025 Red Hat Inc.