File: guestfs-erlang.3

package info (click to toggle)
libguestfs 1%3A1.48.6-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 98,368 kB
  • sloc: ansic: 376,405; ml: 38,310; sh: 10,217; java: 9,578; cs: 6,328; haskell: 5,674; makefile: 5,165; python: 3,800; perl: 2,454; erlang: 2,446; ruby: 350; xml: 303; pascal: 257; javascript: 157; cpp: 10
file content (185 lines) | stat: -rw-r--r-- 7,037 bytes parent folder | download
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
.\" Automatically generated by Podwrapper::Man 1.48.6 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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-erlang 3"
.TH guestfs-erlang 3 "2022-11-28" "libguestfs-1.48.6" "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-erlang \- Erlang から libguestfs を使用する方法
.SH "書式"
.IX Header "書式"
.Vb 6
\& {ok, G} = guestfs:create(),
\& ok = guestfs:add_drive_opts(G, Disk,
\&                             [{format, "raw"}, {readonly, true}]),
\& ok = guestfs:launch(G),
\& [Device] = guestfs:list_devices(G),
\& ok = guestfs:close(G).
.Ve
.SH "説明"
.IX Header "説明"
This manual page documents how to call libguestfs from the Erlang programming language.  This page just documents the differences from the C \s-1API\s0 and gives some examples.  If you are not familiar with using libguestfs, you also need to read \fBguestfs\fR\|(3).
.SS "ハンドルのオープン方法およびクローズ方法"
.IX Subsection "ハンドルのオープン方法およびクローズ方法"
The Erlang bindings are implemented using an external program called \f(CW\*(C`erl\-guestfs\*(C'\fR.  This program must be on the current \s-1PATH,\s0 or else you should specify the full path to the program:
.PP
.Vb 1
\& {ok, G} = guestfs:create().
\&
\& {ok, G} = guestfs:create("/path/to/erl\-guestfs").
.Ve
.PP
\&\f(CW\*(C`G\*(C'\fR は他の関数に渡す libguestfs ハンドルです。
.PP
ハンドルを閉じるには:
.PP
.Vb 1
\& ok = guestfs:close(G).
.Ve
.SS "オプション引数を用いた機能"
.IX Subsection "オプション引数を用いた機能"
For functions that take optional arguments, the first arguments are the non-optional ones.  The last argument is a list of tuples supplying the remaining optional arguments.
.PP
.Vb 2
\& ok = guestfs:add_drive_opts(G, Disk,
\&                             [{format, "raw"}, {readonly, true}]).
.Ve
.PP
最後の引数が空の一覧ならば、それを省略できます:
.PP
.Vb 1
\& ok = guestfs:add_drive_opts(G, Disk).
.Ve
.SS "返り値およびエラー"
.IX Subsection "返り値およびエラー"
On success, most functions return a \f(CW\*(C`Result\*(C'\fR term (which could be a list, string, tuple etc.).  If there is nothing for the function to return, then the atom \f(CW\*(C`ok\*(C'\fR is returned.
.PP
エラーが発生すると、以下の組のどれかが表示されます:
.ie n .IP """{error, Msg, Errno}""" 4
.el .IP "\f(CW{error, Msg, Errno}\fR" 4
.IX Item "{error, Msg, Errno}"
これは関数からの通常のエラーを意味します。
.Sp
\&\f(CW\*(C`Msg\*(C'\fR はエラーメッセージ(文字列)です。\f(CW\*(C`Errno\*(C'\fR は Unix エラー(整数)です。
.Sp
\&\f(CW\*(C`Errno\*(C'\fR は 0 の可能性があります。 \*(L"guestfs_last_errno\*(R" in \fBguestfs\fR\|(3) 参照。
.ie n .IP """{unknown, Function}""" 4
.el .IP "\f(CW{unknown, Function}\fR" 4
.IX Item "{unknown, Function}"
This indicates that the function you called is not known.  Generally this means you are mixing \f(CW\*(C`erl\-guestfs\*(C'\fR from another version of libguestfs, which you should not do.
.Sp
\&\f(CW\*(C`Function\*(C'\fR は未知の関数の名前です。
.ie n .IP """{unknownarg, Arg}""" 4
.el .IP "\f(CW{unknownarg, Arg}\fR" 4
.IX Item "{unknownarg, Arg}"
This indicates that you called a function with optional arguments, with an unknown argument name.
.Sp
\&\f(CW\*(C`Arg\*(C'\fR は未知の引数の名前です。
.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\-gobject\fR\|(3), \fBguestfs\-golang\fR\|(3), \fBguestfs\-java\fR\|(3), \fBguestfs\-lua\fR\|(3), \fBguestfs\-ocaml\fR\|(3), \fBguestfs\-perl\fR\|(3), \fBguestfs\-python\fR\|(3), \fBguestfs\-recipes\fR\|(1), \fBguestfs\-ruby\fR\|(3), http://www.erlang.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) 2011\-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.