.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Podwrapper::Man 1.52.0 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "guestfs-lua 3"
.TH guestfs-lua 3 2024-01-05 libguestfs-1.52.0 "Virtualization Support"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH 名前
.IX Header "名前"
guestfs-lua \- How to use libguestfs from Lua
.SH 書式
.IX Header "書式"
.Vb 6
\& local G = require "guestfs"
\& g = G.create ()
\& g:add_drive ("test.img", { format = "raw", readonly = true })
\& g:launch ()
\& devices = g:list_devices ()
\& g:close ()
.Ve
.SH 説明
.IX Header "説明"
This manual page documents how to call libguestfs from the Lua 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 \fBguestfs\fR\|(3).
.SS "REQUIRING THE MODULE"
.IX Subsection "REQUIRING THE MODULE"
\&\f(CW\*(C`require "guestfs"\*(C'\fR returns the module, so you have to assign it to a local variable.  Typical usage is:
.PP
.Vb 1
\& local G = require "guestfs"
.Ve
.PP
(you can use any name you want instead of \f(CW\*(C`G\*(C'\fR, but in the examples in this man page we always use \f(CW\*(C`G\*(C'\fR).
.SS ハンドルのオープン方法およびクローズ方法
.IX Subsection "ハンドルのオープン方法およびクローズ方法"
To create a new handle, call:
.PP
.Vb 1
\& g = G.create ()
.Ve
.PP
You can also use the optional arguments:
.PP
.Vb 1
\& g = G.create { environment = 0, close_on_exit = 0 }
.Ve
.PP
to set the flags \f(CW\*(C`GUESTFS_CREATE_NO_ENVIRONMENT\*(C'\fR and/or \f(CW\*(C`GUESTFS_CREATE_NO_CLOSE_ON_EXIT\*(C'\fR.
.PP
The handle will be closed by the garbage collector, but you can also close it explicitly by doing:
.PP
.Vb 1
\& g:close ()
.Ve
.SS "CALLING METHODS"
.IX Subsection "CALLING METHODS"
Use the ordinary Lua convention for calling methods on the handle.  For example:
.PP
.Vb 1
\& g:set_verbose (true)
.Ve
.SS オプション引数を用いた機能
.IX Subsection "オプション引数を用いた機能"
For functions that take optional arguments, the first arguments are the non-optional ones.  The optional final argument is a table supplying the optional arguments.
.PP
.Vb 1
\& g:add_drive ("test.img")
.Ve
.PP
または:
.PP
.Vb 1
\& g:add_drive ("test.img", { format = "raw", readonly = true })
.Ve
.SS "64 BIT VALUES"
.IX Subsection "64 BIT VALUES"
Currently 64 bit values must be passed as strings, and are returned as strings.  This is because 32 bit Lua cannot handle 64 bit integers properly.  We hope to come up with a better solution later.
.SS エラー
.IX Subsection "エラー"
Most (but not all) errors are converted into objects (ie. tables) containing the following fields:
.IP msg 4
.IX Item "msg"
The error message (corresponding to "guestfs_last_error" in \fBguestfs\fR\|(3)).
.IP code 4
.IX Item "code"
The \f(CW\*(C`errno\*(C'\fR (corresponding to "guestfs_last_errno" in \fBguestfs\fR\|(3)).
.PP
These objects also have \f(CW\*(C`_\|_tostring\*(C'\fR functions attached to them so you can use \f(CW\*(C`tostring\*(C'\fR (or implicit conversion) to convert them into printable strings.
.PP
Note that the library also throws some errors as plain strings.  You may need to check the type.
.SS イベント
.IX Subsection "イベント"
Events can be registered by calling \f(CW\*(C`set_event_callback\*(C'\fR:
.PP
.Vb 1
\& eh = g:set_event_callback (cb, "close")
.Ve
.PP
or to register a single callback for multiple events make the second argument a list:
.PP
.Vb 1
\& eh = g:set_event_callback (cb, { "appliance", "library", "trace" })
.Ve
.PP
A list of all valid event types (strings) is in the global variable \f(CW\*(C`G.event_all\*(C'\fR.
.PP
The callback (\f(CW\*(C`cb\*(C'\fR) is called with the following parameters:
.PP
.Vb 8
\& function cb (g, event, eh, flags, buf, array)
\&   \-\- g is the guestfs handle
\&   \-\- event is a string which is the name of the event that fired
\&   \-\- flags is always zero
\&   \-\- buf is the data buffer (eg. log message etc)
\&   \-\- array is the array of 64 bit ints (eg. progress bar status etc)
\&   ...
\& end
.Ve
.PP
You can also remove a callback using the event handle (\f(CW\*(C`eh\*(C'\fR) that was returned when you registered the callback:
.PP
.Vb 1
\& g:delete_event_callback (eh)
.Ve
.SH "例 1: ディスクイメージの作成"
.IX Header "例 1: ディスクイメージの作成"
\&\f(CW@EXAMPLE1\fR@
.SH "例 2: 仮想マシンのディスクイメージの検査"
.IX Header "例 2: 仮想マシンのディスクイメージの検査"
\&\f(CW@EXAMPLE2\fR@
.SH 関連項目
.IX Header "関連項目"
\&\fBguestfs\fR\|(3), \fBguestfs\-examples\fR\|(3), \fBguestfs\-erlang\fR\|(3), \fBguestfs\-gobject\fR\|(3), \fBguestfs\-golang\fR\|(3), \fBguestfs\-java\fR\|(3), \fBguestfs\-ocaml\fR\|(3), \fBguestfs\-perl\fR\|(3), \fBguestfs\-python\fR\|(3), \fBguestfs\-recipes\fR\|(1), \fBguestfs\-ruby\fR\|(3), http://www.lua.org/, http://libguestfs.org/.
.SH 著者
.IX Header "著者"
Richard W.M. Jones (\f(CW\*(C`rjones at redhat dot com\*(C'\fR)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2012 Red Hat Inc.
.SH LICENSE
.IX Header "LICENSE"
.SH BUGS
.IX Header "BUGS"
To get a list of bugs against libguestfs, use this link:
https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools
.PP
To report a new bug against libguestfs, use this link:
https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools
.PP
When reporting a bug, please supply:
.IP \(bu 4
The version of libguestfs.
.IP \(bu 4
Where you got libguestfs (eg. which Linux distro, compiled from source, etc)
.IP \(bu 4
Describe the bug accurately and give a way to reproduce it.
.IP \(bu 4
Run \fBlibguestfs\-test\-tool\fR\|(1) and paste the \fBcomplete, unedited\fR
output into the bug report.