НАЗВА¶

guestfs-ocaml - How to use libguestfs from OCaml

КОРОТКИЙ ОПИС¶

Стиль Module:

 let g = Guestfs.create () in
 Guestfs.add_drive_opts g ~format:"raw" ~readonly:true "disk.img";
 Guestfs.launch g;

Об’єктно-орієнтований стиль:

 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

ОПИС¶

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 guestfs(3).

СТИЛІ ПРОГРАМУВАННЯ¶

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);

перетворюється на:

 val Guestfs.set_verbose : Guestfs.t -> bool -> unit

Alternately you can use an object-oriented style, calling methods on the class "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.

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 "Guestfs.close" or the "#close" method.

ВИНЯТКИ¶

Errors from libguestfs functions are mapped into the "Guestfs.Error" exception. This has a single parameter which is the error message (a string). Calling any function/method on a closed handle raises "Guestfs.Handle_closed". The single parameter is the name of the function that you called.

ПРИКЛАД. СТВОРЕННЯ ОБРАЗУ ДИСКА¶

@CREATE_DISK@

ПРИКЛАД. ПЕРЕВІРКА ОБРАЗУ ДИСКА ВІРТУАЛЬНОЇ МАШИНИ¶

@INSPECT_VM@

EXAMPLE: ENABLE DEBUGGING AND LOGGING¶

@DEBUG_LOGGING@

ТАКОЖ ПЕРЕГЛЯНЬТЕ¶

guestfs(3), guestfs-examples(3), guestfs-erlang(3), guestfs-golang(3), guestfs-java(3), guestfs-lua(3), guestfs-perl(3), guestfs-python(3), guestfs-recipes(1), guestfs-ruby(3), http://libguestfs.org/, http://caml.inria.fr/.

АВТОРИ¶

Richard W.M. Jones ("rjones at redhat dot com")

АВТОРСЬКІ ПРАВА¶

© Red Hat Inc., 2010–2012

LICENSE¶

BUGS¶

To get a list of bugs against libguestfs, use this link: https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools To report a new bug against libguestfs, use this link: https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools When reporting a bug, please supply:

•

The version of libguestfs.

•

Where you got libguestfs (eg. which Linux distro, compiled from source, etc)

•

Describe the bug accurately and give a way to reproduce it.

•

Run libguestfs-test-tool(1) and paste the complete, unedited output into the bug report.