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 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
|
=encoding utf8
=head1 НАЗВА
guestfs-ocaml - How to use libguestfs from OCaml
=head1 КОРОТКИЙ ОПИС
Module style:
let g = Guestfs.create () in
Guestfs.add_drive_opts g ~format:"raw" ~readonly:true "disk.img";
Guestfs.launch g;
Object-oriented style:
let g = new Guestfs.guestfs () in
g#add_drive_opts ~format:"raw" ~readonly:true "disk.img";
g#launch ();
ocamlfind opt prog.ml -package guestfs -linkpkg -o prog
or:
ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog
=head1 ОПИС
This manual page documents how to call libguestfs from the OCaml 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 PROGRAMMING STYLES
There are two different programming styles supported by the OCaml bindings.
You can use a module style, with each C function mapped to an OCaml
function:
int guestfs_set_verbose (guestfs_h *g, int flag);
becomes:
val Guestfs.set_verbose : Guestfs.t -> bool -> unit
Alternately you can use an object-oriented style, calling methods on the
class C<Guestfs.guestfs>:
method set_verbose : bool -> unit
The object-oriented style is usually briefer, and the minor performance
penalty isn't noticeable in the general overhead of performing libguestfs
functions.
=head2 CLOSING THE HANDLE
The handle is closed when it is reaped by the garbage collector. Because
libguestfs handles include a lot of state, it is also possible to close (and
hence free) them explicitly by calling C<Guestfs.close> or the C<#close>
method.
=head2 ВИНЯТКИ
Errors from libguestfs functions are mapped into the C<Guestfs.Error>
exception. This has a single parameter which is the error message (a
string).
Calling any function/method on a closed handle raises
C<Guestfs.Handle_closed>. The single parameter is the name of the function
that you called.
=head1 ПРИКЛАД 1. СТВОРЕННЯ ОБРАЗУ ДИСКА
@EXAMPLE1@
=head1 ПРИКЛАД 2. ПЕРЕВІРКА ОБРАЗУ ДИСКА ВІРТУАЛЬНОЇ МАШИНИ
@EXAMPLE2@
=head1 ТАКОЖ ПЕРЕГЛЯНЬТЕ
L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>,
L<guestfs-java(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>,
L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>,
L<http://caml.inria.fr/>.
=head1 АВТОРИ
Richard W.M. Jones (C<rjones at redhat dot com>)
=head1 АВТОРСЬКІ ПРАВА
© Red Hat Inc. L<http://libguestfs.org/>, 2010
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.
Ця бібліотека поширюється у сподіванні, що вона буде корисною, але БЕЗ
БУДЬ-ЯКИХ ГАРАНТІЙНИХ ЗОБОВ’ЯЗАНЬ; навіть без очевидної гарантії
ПРАЦЕЗДАТНОСТІ або ПРИДАТНОСТІ ДЛЯ ВИКОРИСТАННЯ З ПЕВНОЮ МЕТОЮ. Докладніше
про це можна дізнатися з GNU General Public License.
Ви маєте отримати копію GNU Lesser General Public License разом з цією
бібліотекою; якщо це не так, повідомте про факт за адресою Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
USA
|