File: guestfs-erlang.3

package info (click to toggle)
libguestfs 1%3A1.44.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 118,932 kB
  • sloc: ansic: 458,017; ml: 51,424; sh: 13,191; java: 9,578; makefile: 7,931; cs: 6,328; haskell: 5,674; python: 3,871; perl: 3,528; erlang: 2,446; xml: 1,347; ruby: 350; pascal: 257; javascript: 157; lex: 135; yacc: 128; cpp: 10
file content (204 lines) | stat: -rw-r--r-- 8,922 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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
.\" Automatically generated by Podwrapper::Man 1.44.0 (Pod::Simple 3.40)
.\"
.\" 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 "2021-01-05" "libguestfs-1.44.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-erlang — як користуватися libguestfs з програми мовою Erlang
.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 "ОПИС"
На цій сторінці підручника наведено документацію щодо викликів libguestfs з
коду мовою програмування Erlang. На сторінці задокументовано відмінності від
програмного інтерфейсу C та подано декілька прикладів. Якщо ви не дуже
знайомі із користуванням libguestfs, вам також слід прочитати підручник з
\&\fBguestfs\fR\|(3).
.SS "ВІДКРИТТЯ І ЗАКРИТТЯ ДЕСКРИПТОРА"
.IX Subsection "ВІДКРИТТЯ І ЗАКРИТТЯ ДЕСКРИПТОРА"
Прив'язки до Erlang реалізовано за допомогою зовнішньої програми із назвою
\&\f(CW\*(C`erl\-guestfs\*(C'\fR. Ця програма має зберігатися у одному з каталогів \s-1PATH,\s0
інакше вам доведеться вказати повний шлях до програми:
.PP
.Vb 1
\& {ok, G} = guestfs:create().
\&
\& {ok, G} = guestfs:create("/шлях/до/erl\-guestfs").
.Ve
.PP
\&\f(CW\*(C`G\*(C'\fR є дескриптором libguestfs, який вам слід передавати іншим функціям.
.PP
Закриття обробника:
.PP
.Vb 1
\& ok = guestfs:close(G).
.Ve
.SS "ФУНКЦІЇ І НЕОБОВ'ЯЗКОВІ ПАРАМЕТРИ"
.IX Subsection "ФУНКЦІЇ І НЕОБОВ'ЯЗКОВІ ПАРАМЕТРИ"
Якщо функція приймає необов'язкові аргументи, першими слід вказувати
обов'язкові. Останнім аргументом є список кортежів, яким надається список
решти необов'язкових аргументів.
.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 "ЗНАЧЕННЯ, ЩО ПОВЕРТАЮТЬСЯ, І ПОМИЛКИ"
Якщо дію виконано успішно, більшість функцій повертають значення \f(CW\*(C`Result\*(C'\fR
(ним може бути список, рядок, кортеж тощо).  Якщо у функції немає чого
повернути, буде повернуто атом \f(CW\*(C`ok\*(C'\fR.
.PP
Якщо станеться помилка, ви маєте побачити один із таких кортежів:
.ie n .IP """{помилка, повідомлення, номер_помилки}""" 4
.el .IP "\f(CW{помилка, повідомлення, номер_помилки}\fR" 4
.IX Item "{помилка, повідомлення, номер_помилки}"
Позначає звичайну помилку у функції.
.Sp
\&\f(CW\*(C`Повідомлення\*(C'\fR — повідомлення про помилку (рядок), а \f(CW\*(C`номер_помилки\*(C'\fR —
номер помилки Unix (ціле число).
.Sp
\&\f(CW\*(C`Errno\*(C'\fR може бути нульовим. Див. \*(L"guestfs_last_errno\*(R" in \fBguestfs\fR\|(3).
.ie n .IP """{unknown, Функція}""" 4
.el .IP "\f(CW{unknown, Функція}\fR" 4
.IX Item "{unknown, Функція}"
Це означає, що викликана вами функція є невідомою. Загалом, таке
трапляється, якщо ви використовуєте \f(CW\*(C`erl\-guestfs\*(C'\fR з іншої версії
libguestfs. Не слід так робити.
.Sp
\&\f(CW\*(C`Функція\*(C'\fR — назва невідомої функції.
.ie n .IP """{unknownarg, Аргумент}""" 4
.el .IP "\f(CW{unknownarg, Аргумент}\fR" 4
.IX Item "{unknownarg, Аргумент}"
Це означає, що ви викликали функцію із необов'язковими аргументами,
використавши невідому назву аргументу.
.Sp
\&\f(CW\*(C`Аргумент\*(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 "АВТОРСЬКІ ПРАВА"
.IX Header "АВТОРСЬКІ ПРАВА"
© Red Hat Inc., 2011–2012
.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.