Version 1.13.15.
[libguestfs.git] / po-docs / libguestfs-docs.pot
1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
5 #
6 #, fuzzy
7 msgid ""
8 msgstr ""
9 "Project-Id-Version: libguestfs 1.13.15\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-09-28 21:49+0200\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
15 "Language: \n"
16 "MIME-Version: 1.0\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
19
20 #. type: =head1
21 #: ../cat/virt-cat.pod:3 ../cat/virt-filesystems.pod:3 ../cat/virt-ls.pod:3 ../df/virt-df.pod:3 ../edit/virt-edit.pod:3 ../erlang/examples/guestfs-erlang.pod:3 ../examples/guestfs-examples.pod:3 ../examples/guestfs-recipes.pod:14 ../fish/guestfish.pod:3 ../fish/virt-copy-in.pod:3 ../fish/virt-copy-out.pod:3 ../fish/virt-tar-in.pod:3 ../fish/virt-tar-out.pod:3 ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pod:3 ../java/examples/guestfs-java.pod:3 ../ocaml/examples/guestfs-ocaml.pod:3 ../perl/examples/guestfs-perl.pod:3 ../python/examples/guestfs-python.pod:3 ../rescue/virt-rescue.pod:3 ../resize/virt-resize.pod:3 ../ruby/examples/guestfs-ruby.pod:3 ../src/guestfs.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../tools/virt-list-filesystems.pl:30 ../tools/virt-list-partitions.pl:30 ../tools/virt-make-fs.pl:35 ../tools/virt-tar.pl:31 ../tools/virt-win-reg.pl:35
22 msgid "NAME"
23 msgstr ""
24
25 #. type: textblock
26 #: ../cat/virt-cat.pod:5
27 msgid "virt-cat - Display files in a virtual machine"
28 msgstr ""
29
30 #. type: =head1
31 #: ../cat/virt-cat.pod:7 ../cat/virt-filesystems.pod:7 ../cat/virt-ls.pod:7 ../df/virt-df.pod:7 ../edit/virt-edit.pod:7 ../erlang/examples/guestfs-erlang.pod:7 ../examples/guestfs-examples.pod:7 ../fish/guestfish.pod:7 ../fish/virt-copy-in.pod:7 ../fish/virt-copy-out.pod:7 ../fish/virt-tar-in.pod:7 ../fish/virt-tar-out.pod:7 ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pod:7 ../java/examples/guestfs-java.pod:7 ../ocaml/examples/guestfs-ocaml.pod:7 ../perl/examples/guestfs-perl.pod:7 ../python/examples/guestfs-python.pod:7 ../rescue/virt-rescue.pod:7 ../resize/virt-resize.pod:7 ../ruby/examples/guestfs-ruby.pod:7 ../src/guestfs.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../tools/virt-list-filesystems.pl:34 ../tools/virt-list-partitions.pl:34 ../tools/virt-make-fs.pl:39 ../tools/virt-tar.pl:35 ../tools/virt-win-reg.pl:39
32 msgid "SYNOPSIS"
33 msgstr ""
34
35 #. type: verbatim
36 #: ../cat/virt-cat.pod:9
37 #, no-wrap
38 msgid ""
39 " virt-cat [--options] -d domname file [file ...]\n"
40 "\n"
41 msgstr ""
42
43 #. type: verbatim
44 #: ../cat/virt-cat.pod:11
45 #, no-wrap
46 msgid ""
47 " virt-cat [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
48 "\n"
49 msgstr ""
50
51 #. type: textblock
52 #: ../cat/virt-cat.pod:13 ../edit/virt-edit.pod:15 ../inspector/virt-inspector.pod:13
53 msgid "Old-style:"
54 msgstr ""
55
56 #. type: verbatim
57 #: ../cat/virt-cat.pod:15
58 #, no-wrap
59 msgid ""
60 " virt-cat domname file\n"
61 "\n"
62 msgstr ""
63
64 #. type: verbatim
65 #: ../cat/virt-cat.pod:17
66 #, no-wrap
67 msgid ""
68 " virt-cat disk.img file\n"
69 "\n"
70 msgstr ""
71
72 #. type: =head1
73 #: ../cat/virt-cat.pod:19 ../cat/virt-filesystems.pod:13 ../cat/virt-ls.pod:19 ../df/virt-df.pod:21 ../edit/virt-edit.pod:27 ../erlang/examples/guestfs-erlang.pod:16 ../examples/guestfs-examples.pod:19 ../examples/guestfs-recipes.pod:18 ../fish/guestfish.pod:30 ../fish/virt-copy-in.pod:19 ../fish/virt-copy-out.pod:13 ../fish/virt-tar-in.pod:21 ../fish/virt-tar-out.pod:15 ../fuse/guestmount.pod:20 ../inspector/virt-inspector.pod:19 ../java/examples/guestfs-java.pod:15 ../ocaml/examples/guestfs-ocaml.pod:25 ../perl/examples/guestfs-perl.pod:18 ../python/examples/guestfs-python.pod:14 ../rescue/virt-rescue.pod:29 ../resize/virt-resize.pod:13 ../ruby/examples/guestfs-ruby.pod:15 ../src/guestfs.pod:23 ../test-tool/libguestfs-test-tool.pod:11 ../tools/virt-list-filesystems.pl:40 ../tools/virt-list-partitions.pl:40 ../tools/virt-make-fs.pl:47 ../tools/virt-tar.pl:77 ../tools/virt-win-reg.pl:63
74 msgid "DESCRIPTION"
75 msgstr ""
76
77 #. type: textblock
78 #: ../cat/virt-cat.pod:21
79 msgid ""
80 "C<virt-cat> is a command line tool to display the contents of C<file> where "
81 "C<file> exists in the named virtual machine (or disk image)."
82 msgstr ""
83
84 #. type: textblock
85 #: ../cat/virt-cat.pod:24
86 msgid ""
87 "Multiple filenames can be given, in which case they are concatenated "
88 "together.  Each filename must be a full path, starting at the root directory "
89 "(starting with '/')."
90 msgstr ""
91
92 #. type: textblock
93 #: ../cat/virt-cat.pod:28
94 msgid ""
95 "C<virt-cat> can be used to quickly view a file.  To edit a file, use "
96 "C<virt-edit>.  For more complex cases you should look at the L<guestfish(1)> "
97 "tool (see L</USING GUESTFISH> below)."
98 msgstr ""
99
100 #. type: =head1
101 #: ../cat/virt-cat.pod:32 ../cat/virt-ls.pod:35 ../df/virt-df.pod:43 ../edit/virt-edit.pod:44 ../fish/guestfish.pod:41 ../fish/guestfish.pod:1018 ../fish/virt-copy-in.pod:29 ../fish/virt-copy-out.pod:21 ../fish/virt-tar-in.pod:30 ../fish/virt-tar-out.pod:24 ../fuse/guestmount.pod:39 ../resize/virt-resize.pod:27 ../tools/virt-tar.pl:50
102 msgid "EXAMPLES"
103 msgstr ""
104
105 #. type: textblock
106 #: ../cat/virt-cat.pod:34
107 msgid "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
108 msgstr ""
109
110 #. type: verbatim
111 #: ../cat/virt-cat.pod:37
112 #, no-wrap
113 msgid ""
114 " virt-cat -d mydomain /etc/fstab\n"
115 "\n"
116 msgstr ""
117
118 #. type: textblock
119 #: ../cat/virt-cat.pod:39
120 msgid "List syslog messages from a VM disk image file:"
121 msgstr ""
122
123 #. type: verbatim
124 #: ../cat/virt-cat.pod:41
125 #, no-wrap
126 msgid ""
127 " virt-cat -a disk.img /var/log/messages | tail\n"
128 "\n"
129 msgstr ""
130
131 #. type: textblock
132 #: ../cat/virt-cat.pod:43
133 msgid "Find out what DHCP IP address a VM acquired:"
134 msgstr ""
135
136 #. type: verbatim
137 #: ../cat/virt-cat.pod:45
138 #, no-wrap
139 msgid ""
140 " virt-cat -d mydomain /var/log/messages | \\\n"
141 "   grep 'dhclient: bound to' | tail\n"
142 "\n"
143 msgstr ""
144
145 #. type: textblock
146 #: ../cat/virt-cat.pod:48
147 msgid "Find out what packages were recently installed:"
148 msgstr ""
149
150 #. type: verbatim
151 #: ../cat/virt-cat.pod:50
152 #, no-wrap
153 msgid ""
154 " virt-cat -d mydomain /var/log/yum.log | tail\n"
155 "\n"
156 msgstr ""
157
158 #. type: textblock
159 #: ../cat/virt-cat.pod:52
160 msgid "Find out who is logged on inside a virtual machine:"
161 msgstr ""
162
163 #. type: verbatim
164 #: ../cat/virt-cat.pod:54
165 #, no-wrap
166 msgid ""
167 " virt-cat -d mydomain /var/run/utmp > /tmp/utmp\n"
168 " who /tmp/utmp\n"
169 "\n"
170 msgstr ""
171
172 #. type: textblock
173 #: ../cat/virt-cat.pod:57
174 msgid "or who was logged on:"
175 msgstr ""
176
177 #. type: verbatim
178 #: ../cat/virt-cat.pod:59
179 #, no-wrap
180 msgid ""
181 " virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp\n"
182 " last -f /tmp/wtmp\n"
183 "\n"
184 msgstr ""
185
186 #. type: =head1
187 #: ../cat/virt-cat.pod:62 ../cat/virt-filesystems.pod:91 ../cat/virt-ls.pod:261 ../df/virt-df.pod:59 ../edit/virt-edit.pod:62 ../fish/guestfish.pod:148 ../fish/virt-copy-in.pod:45 ../fish/virt-copy-out.pod:34 ../fish/virt-tar-in.pod:42 ../fish/virt-tar-out.pod:36 ../fuse/guestmount.pod:83 ../inspector/virt-inspector.pod:55 ../rescue/virt-rescue.pod:84 ../resize/virt-resize.pod:241 ../test-tool/libguestfs-test-tool.pod:36 ../tools/virt-list-filesystems.pl:53 ../tools/virt-list-partitions.pl:54 ../tools/virt-make-fs.pl:153 ../tools/virt-tar.pl:103 ../tools/virt-win-reg.pl:96
188 msgid "OPTIONS"
189 msgstr ""
190
191 #. type: =item
192 #: ../cat/virt-cat.pod:66 ../cat/virt-filesystems.pod:95 ../cat/virt-ls.pod:265 ../df/virt-df.pod:63 ../edit/virt-edit.pod:66 ../fish/guestfish.pod:152 ../fuse/guestmount.pod:151 ../inspector/virt-inspector.pod:59 ../rescue/virt-rescue.pod:88 ../resize/virt-resize.pod:245 ../test-tool/libguestfs-test-tool.pod:40 ../tools/virt-list-filesystems.pl:61 ../tools/virt-list-partitions.pl:62 ../tools/virt-make-fs.pl:161 ../tools/virt-tar.pl:111 ../tools/virt-win-reg.pl:104
193 msgid "B<--help>"
194 msgstr ""
195
196 #. type: textblock
197 #: ../cat/virt-cat.pod:68 ../cat/virt-filesystems.pod:97 ../cat/virt-ls.pod:267 ../df/virt-df.pod:65 ../edit/virt-edit.pod:68 ../inspector/virt-inspector.pod:61 ../rescue/virt-rescue.pod:90 ../tools/virt-list-filesystems.pl:63 ../tools/virt-list-partitions.pl:64 ../tools/virt-make-fs.pl:163 ../tools/virt-tar.pl:113 ../tools/virt-win-reg.pl:106
198 msgid "Display brief help."
199 msgstr ""
200
201 #. type: =item
202 #: ../cat/virt-cat.pod:70 ../cat/virt-filesystems.pod:99 ../cat/virt-ls.pod:269 ../df/virt-df.pod:67 ../edit/virt-edit.pod:70 ../inspector/virt-inspector.pod:63 ../rescue/virt-rescue.pod:92
203 msgid "B<-a> file"
204 msgstr ""
205
206 #. type: =item
207 #: ../cat/virt-cat.pod:72 ../cat/virt-filesystems.pod:101 ../cat/virt-ls.pod:271 ../df/virt-df.pod:69 ../edit/virt-edit.pod:72 ../inspector/virt-inspector.pod:65 ../rescue/virt-rescue.pod:94
208 msgid "B<--add> file"
209 msgstr ""
210
211 #. type: textblock
212 #: ../cat/virt-cat.pod:74 ../cat/virt-filesystems.pod:103 ../cat/virt-ls.pod:273 ../df/virt-df.pod:71 ../edit/virt-edit.pod:74 ../inspector/virt-inspector.pod:67 ../rescue/virt-rescue.pod:96
213 msgid ""
214 "Add I<file> which should be a disk image from a virtual machine.  If the "
215 "virtual machine has multiple block devices, you must supply all of them with "
216 "separate I<-a> options."
217 msgstr ""
218
219 #. type: textblock
220 #: ../cat/virt-cat.pod:78 ../cat/virt-filesystems.pod:107 ../cat/virt-ls.pod:277 ../df/virt-df.pod:75 ../edit/virt-edit.pod:78 ../fish/guestfish.pod:174 ../fuse/guestmount.pod:93 ../inspector/virt-inspector.pod:71 ../rescue/virt-rescue.pod:100
221 msgid ""
222 "The format of the disk image is auto-detected.  To override this and force a "
223 "particular format use the I<--format=..> option."
224 msgstr ""
225
226 #. type: =item
227 #: ../cat/virt-cat.pod:81 ../cat/virt-filesystems.pod:125 ../cat/virt-ls.pod:291 ../df/virt-df.pod:78 ../rescue/virt-rescue.pod:107
228 msgid "B<-c> URI"
229 msgstr ""
230
231 #. type: =item
232 #: ../cat/virt-cat.pod:83 ../cat/virt-filesystems.pod:127 ../cat/virt-ls.pod:293 ../df/virt-df.pod:80 ../rescue/virt-rescue.pod:109
233 msgid "B<--connect> URI"
234 msgstr ""
235
236 #. type: textblock
237 #: ../cat/virt-cat.pod:85 ../cat/virt-filesystems.pod:129 ../cat/virt-ls.pod:295 ../df/virt-df.pod:82 ../edit/virt-edit.pod:99 ../inspector/virt-inspector.pod:78 ../rescue/virt-rescue.pod:111 ../tools/virt-list-filesystems.pl:81 ../tools/virt-list-partitions.pl:82 ../tools/virt-tar.pl:131 ../tools/virt-win-reg.pl:132
238 msgid ""
239 "If using libvirt, connect to the given I<URI>.  If omitted, then we connect "
240 "to the default libvirt hypervisor."
241 msgstr ""
242
243 #. type: textblock
244 #: ../cat/virt-cat.pod:88 ../cat/virt-filesystems.pod:132 ../cat/virt-ls.pod:298 ../df/virt-df.pod:85 ../rescue/virt-rescue.pod:114
245 msgid ""
246 "If you specify guest block devices directly (I<-a>), then libvirt is not "
247 "used at all."
248 msgstr ""
249
250 #. type: =item
251 #: ../cat/virt-cat.pod:91 ../cat/virt-filesystems.pod:141 ../cat/virt-ls.pod:307 ../df/virt-df.pod:94 ../edit/virt-edit.pod:105 ../inspector/virt-inspector.pod:85 ../rescue/virt-rescue.pod:117
252 msgid "B<-d> guest"
253 msgstr ""
254
255 #. type: =item
256 #: ../cat/virt-cat.pod:93 ../cat/virt-filesystems.pod:143 ../cat/virt-ls.pod:309 ../df/virt-df.pod:96 ../edit/virt-edit.pod:107 ../inspector/virt-inspector.pod:87 ../rescue/virt-rescue.pod:119
257 msgid "B<--domain> guest"
258 msgstr ""
259
260 #. type: textblock
261 #: ../cat/virt-cat.pod:95 ../cat/virt-filesystems.pod:145 ../cat/virt-ls.pod:311 ../df/virt-df.pod:98 ../edit/virt-edit.pod:109 ../inspector/virt-inspector.pod:89 ../rescue/virt-rescue.pod:121
262 msgid ""
263 "Add all the disks from the named libvirt guest.  Domain UUIDs can be used "
264 "instead of names."
265 msgstr ""
266
267 #. type: =item
268 #: ../cat/virt-cat.pod:98 ../cat/virt-filesystems.pod:148 ../cat/virt-ls.pod:314 ../edit/virt-edit.pod:112 ../fish/guestfish.pod:217 ../fuse/guestmount.pod:126 ../inspector/virt-inspector.pod:92
269 msgid "B<--echo-keys>"
270 msgstr ""
271
272 #. type: textblock
273 #: ../cat/virt-cat.pod:100
274 msgid ""
275 "When prompting for keys and passphrases, virt-cat normally turns echoing off "
276 "so you cannot see what you are typing.  If you are not worried about Tempest "
277 "attacks and there is no one else in the room you can specify this flag to "
278 "see what you are typing."
279 msgstr ""
280
281 #. type: =item
282 #: ../cat/virt-cat.pod:105 ../cat/virt-filesystems.pod:170 ../cat/virt-ls.pod:328 ../df/virt-df.pod:101 ../fish/guestfish.pod:233 ../fuse/guestmount.pod:133 ../inspector/virt-inspector.pod:99 ../rescue/virt-rescue.pod:124
283 msgid "B<--format=raw|qcow2|..>"
284 msgstr ""
285
286 #. type: =item
287 #: ../cat/virt-cat.pod:107 ../cat/virt-filesystems.pod:172 ../cat/virt-ls.pod:330 ../df/virt-df.pod:103 ../edit/virt-edit.pod:134 ../fish/guestfish.pod:235 ../fuse/guestmount.pod:135 ../inspector/virt-inspector.pod:101 ../rescue/virt-rescue.pod:126
288 msgid "B<--format>"
289 msgstr ""
290
291 #. type: textblock
292 #: ../cat/virt-cat.pod:109 ../cat/virt-filesystems.pod:174 ../cat/virt-ls.pod:332 ../df/virt-df.pod:105 ../edit/virt-edit.pod:136 ../fish/guestfish.pod:237 ../fuse/guestmount.pod:137 ../rescue/virt-rescue.pod:128
293 msgid ""
294 "The default for the I<-a> option is to auto-detect the format of the disk "
295 "image.  Using this forces the disk format for I<-a> options which follow on "
296 "the command line.  Using I<--format> with no argument switches back to "
297 "auto-detection for subsequent I<-a> options."
298 msgstr ""
299
300 #. type: textblock
301 #: ../cat/virt-cat.pod:114 ../cat/virt-filesystems.pod:179 ../cat/virt-ls.pod:337 ../df/virt-df.pod:110 ../edit/virt-edit.pod:141 ../fish/guestfish.pod:242 ../fish/guestfish.pod:673 ../inspector/virt-inspector.pod:336 ../rescue/virt-rescue.pod:133 ../src/guestfs.pod:2788
302 msgid "For example:"
303 msgstr ""
304
305 #. type: verbatim
306 #: ../cat/virt-cat.pod:116
307 #, no-wrap
308 msgid ""
309 " virt-cat --format=raw -a disk.img file\n"
310 "\n"
311 msgstr ""
312
313 #. type: textblock
314 #: ../cat/virt-cat.pod:118 ../cat/virt-filesystems.pod:183 ../cat/virt-ls.pod:341 ../df/virt-df.pod:114 ../edit/virt-edit.pod:145 ../fish/guestfish.pod:246 ../rescue/virt-rescue.pod:137
315 msgid "forces raw format (no auto-detection) for C<disk.img>."
316 msgstr ""
317
318 #. type: verbatim
319 #: ../cat/virt-cat.pod:120
320 #, no-wrap
321 msgid ""
322 " virt-cat --format=raw -a disk.img --format -a another.img file\n"
323 "\n"
324 msgstr ""
325
326 #. type: textblock
327 #: ../cat/virt-cat.pod:122 ../cat/virt-filesystems.pod:187 ../cat/virt-ls.pod:345 ../df/virt-df.pod:118 ../edit/virt-edit.pod:149 ../fish/guestfish.pod:250 ../rescue/virt-rescue.pod:141
328 msgid ""
329 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
330 "auto-detection for C<another.img>."
331 msgstr ""
332
333 #. type: textblock
334 #: ../cat/virt-cat.pod:125 ../cat/virt-filesystems.pod:190 ../cat/virt-ls.pod:348 ../df/virt-df.pod:121 ../edit/virt-edit.pod:152 ../rescue/virt-rescue.pod:144
335 msgid ""
336 "If you have untrusted raw-format guest disk images, you should use this "
337 "option to specify the disk format.  This avoids a possible security problem "
338 "with malicious guests (CVE-2010-3851)."
339 msgstr ""
340
341 #. type: =item
342 #: ../cat/virt-cat.pod:129 ../cat/virt-filesystems.pod:200 ../cat/virt-ls.pod:361 ../edit/virt-edit.pod:156 ../fish/guestfish.pod:289 ../fuse/guestmount.pod:163 ../inspector/virt-inspector.pod:114
343 msgid "B<--keys-from-stdin>"
344 msgstr ""
345
346 #. type: textblock
347 #: ../cat/virt-cat.pod:131 ../cat/virt-filesystems.pod:202 ../cat/virt-ls.pod:363 ../edit/virt-edit.pod:158 ../fish/guestfish.pod:291 ../fuse/guestmount.pod:165 ../inspector/virt-inspector.pod:116
348 msgid ""
349 "Read key or passphrase parameters from stdin.  The default is to try to read "
350 "passphrases from the user by opening C</dev/tty>."
351 msgstr ""
352
353 #. type: =item
354 #: ../cat/virt-cat.pod:134 ../cat/virt-filesystems.pod:261 ../cat/virt-ls.pod:425 ../df/virt-df.pod:173 ../edit/virt-edit.pod:161 ../fish/guestfish.pod:390 ../fuse/guestmount.pod:257 ../inspector/virt-inspector.pod:119 ../rescue/virt-rescue.pod:182
355 msgid "B<-v>"
356 msgstr ""
357
358 #. type: =item
359 #: ../cat/virt-cat.pod:136 ../cat/virt-filesystems.pod:263 ../cat/virt-ls.pod:427 ../df/virt-df.pod:175 ../edit/virt-edit.pod:163 ../fish/guestfish.pod:392 ../fuse/guestmount.pod:259 ../inspector/virt-inspector.pod:121 ../rescue/virt-rescue.pod:184
360 msgid "B<--verbose>"
361 msgstr ""
362
363 #. type: textblock
364 #: ../cat/virt-cat.pod:138 ../cat/virt-filesystems.pod:265 ../cat/virt-ls.pod:429 ../df/virt-df.pod:177 ../edit/virt-edit.pod:165 ../inspector/virt-inspector.pod:123 ../rescue/virt-rescue.pod:186
365 msgid "Enable verbose messages for debugging."
366 msgstr ""
367
368 #. type: =item
369 #: ../cat/virt-cat.pod:140 ../cat/virt-filesystems.pod:267 ../cat/virt-ls.pod:431 ../df/virt-df.pod:179 ../edit/virt-edit.pod:167 ../fish/guestfish.pod:397 ../fuse/guestmount.pod:263 ../inspector/virt-inspector.pod:125 ../rescue/virt-rescue.pod:188 ../resize/virt-resize.pod:484
370 msgid "B<-V>"
371 msgstr ""
372
373 #. type: =item
374 #: ../cat/virt-cat.pod:142 ../cat/virt-filesystems.pod:269 ../cat/virt-ls.pod:433 ../df/virt-df.pod:181 ../edit/virt-edit.pod:169 ../fish/guestfish.pod:399 ../fuse/guestmount.pod:265 ../inspector/virt-inspector.pod:127 ../rescue/virt-rescue.pod:190 ../resize/virt-resize.pod:486 ../tools/virt-list-filesystems.pl:69 ../tools/virt-list-partitions.pl:70 ../tools/virt-make-fs.pl:169 ../tools/virt-tar.pl:119 ../tools/virt-win-reg.pl:112
375 msgid "B<--version>"
376 msgstr ""
377
378 #. type: textblock
379 #: ../cat/virt-cat.pod:144 ../cat/virt-filesystems.pod:271 ../cat/virt-ls.pod:435 ../df/virt-df.pod:183 ../edit/virt-edit.pod:171 ../inspector/virt-inspector.pod:129 ../rescue/virt-rescue.pod:192 ../resize/virt-resize.pod:488 ../tools/virt-list-filesystems.pl:71 ../tools/virt-list-partitions.pl:72 ../tools/virt-make-fs.pl:171 ../tools/virt-tar.pl:121 ../tools/virt-win-reg.pl:114
380 msgid "Display version number and exit."
381 msgstr ""
382
383 #. type: =item
384 #: ../cat/virt-cat.pod:146 ../cat/virt-filesystems.pod:281 ../cat/virt-ls.pod:437 ../df/virt-df.pod:185 ../edit/virt-edit.pod:173 ../fish/guestfish.pod:412 ../fuse/guestmount.pod:278 ../inspector/virt-inspector.pod:131 ../rescue/virt-rescue.pod:203 ../tools/virt-tar.pl:158
385 msgid "B<-x>"
386 msgstr ""
387
388 #. type: textblock
389 #: ../cat/virt-cat.pod:148 ../cat/virt-filesystems.pod:283 ../cat/virt-ls.pod:439 ../df/virt-df.pod:187 ../edit/virt-edit.pod:175 ../inspector/virt-inspector.pod:133 ../rescue/virt-rescue.pod:205
390 msgid "Enable tracing of libguestfs API calls."
391 msgstr ""
392
393 #. type: =head1
394 #: ../cat/virt-cat.pod:152 ../cat/virt-ls.pod:443 ../edit/virt-edit.pod:179 ../inspector/virt-inspector.pod:137 ../rescue/virt-rescue.pod:209
395 msgid "OLD-STYLE COMMAND LINE ARGUMENTS"
396 msgstr ""
397
398 #. type: textblock
399 #: ../cat/virt-cat.pod:154
400 msgid "Previous versions of virt-cat allowed you to write either:"
401 msgstr ""
402
403 #. type: verbatim
404 #: ../cat/virt-cat.pod:156
405 #, no-wrap
406 msgid ""
407 " virt-cat disk.img [disk.img ...] file\n"
408 "\n"
409 msgstr ""
410
411 #. type: textblock
412 #: ../cat/virt-cat.pod:158 ../cat/virt-ls.pod:449 ../edit/virt-edit.pod:185 ../inspector/virt-inspector.pod:143 ../rescue/virt-rescue.pod:215
413 msgid "or"
414 msgstr ""
415
416 #. type: verbatim
417 #: ../cat/virt-cat.pod:160
418 #, no-wrap
419 msgid ""
420 " virt-cat guestname file\n"
421 "\n"
422 msgstr ""
423
424 #. type: textblock
425 #: ../cat/virt-cat.pod:162 ../cat/virt-ls.pod:453 ../edit/virt-edit.pod:189 ../inspector/virt-inspector.pod:147 ../rescue/virt-rescue.pod:219
426 msgid ""
427 "whereas in this version you should use I<-a> or I<-d> respectively to avoid "
428 "the confusing case where a disk image might have the same name as a guest."
429 msgstr ""
430
431 #. type: textblock
432 #: ../cat/virt-cat.pod:166 ../cat/virt-ls.pod:457 ../edit/virt-edit.pod:193 ../inspector/virt-inspector.pod:151 ../rescue/virt-rescue.pod:223
433 msgid "For compatibility the old style is still supported."
434 msgstr ""
435
436 #. type: =head1
437 #: ../cat/virt-cat.pod:168 ../edit/virt-edit.pod:297
438 msgid "USING GUESTFISH"
439 msgstr ""
440
441 #. type: textblock
442 #: ../cat/virt-cat.pod:170
443 msgid ""
444 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
445 "C<virt-cat> doesn't work."
446 msgstr ""
447
448 #. type: textblock
449 #: ../cat/virt-cat.pod:173
450 msgid "Using C<virt-cat> is approximately equivalent to doing:"
451 msgstr ""
452
453 #. type: verbatim
454 #: ../cat/virt-cat.pod:175
455 #, no-wrap
456 msgid ""
457 " guestfish --ro -i -d domname download file -\n"
458 "\n"
459 msgstr ""
460
461 #. type: textblock
462 #: ../cat/virt-cat.pod:177
463 msgid ""
464 "where C<domname> is the name of the libvirt guest, and C<file> is the full "
465 "path to the file.  Note the final C<-> (meaning \"output to stdout\")."
466 msgstr ""
467
468 #. type: textblock
469 #: ../cat/virt-cat.pod:181
470 msgid ""
471 "The command above uses libguestfs's guest inspection feature and so does not "
472 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
473 "disk images that don't contain guests.  To display a file from a disk image "
474 "directly, use:"
475 msgstr ""
476
477 #. type: verbatim
478 #: ../cat/virt-cat.pod:186
479 #, no-wrap
480 msgid ""
481 " guestfish --ro -a disk.img -m /dev/sda1 download file -\n"
482 "\n"
483 msgstr ""
484
485 #. type: textblock
486 #: ../cat/virt-cat.pod:188
487 msgid ""
488 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
489 "the disk image, and C<file> is the full path to the file."
490 msgstr ""
491
492 #. type: =head1
493 #: ../cat/virt-cat.pod:191 ../cat/virt-filesystems.pod:365 ../cat/virt-ls.pod:483 ../df/virt-df.pod:215 ../edit/virt-edit.pod:342 ../inspector/virt-inspector.pod:352 ../rescue/virt-rescue.pod:266 ../resize/virt-resize.pod:601 ../tools/virt-list-filesystems.pl:188 ../tools/virt-list-partitions.pl:258 ../tools/virt-make-fs.pl:532 ../tools/virt-tar.pl:289 ../tools/virt-win-reg.pl:733
494 msgid "SHELL QUOTING"
495 msgstr ""
496
497 #. type: textblock
498 #: ../cat/virt-cat.pod:193 ../cat/virt-filesystems.pod:367 ../cat/virt-ls.pod:485 ../df/virt-df.pod:217 ../edit/virt-edit.pod:344 ../inspector/virt-inspector.pod:354 ../rescue/virt-rescue.pod:268 ../resize/virt-resize.pod:603 ../tools/virt-list-filesystems.pl:190 ../tools/virt-list-partitions.pl:260 ../tools/virt-make-fs.pl:534 ../tools/virt-tar.pl:291 ../tools/virt-win-reg.pl:741
499 msgid ""
500 "Libvirt guest names can contain arbitrary characters, some of which have "
501 "meaning to the shell such as C<#> and space.  You may need to quote or "
502 "escape these characters on the command line.  See the shell manual page "
503 "L<sh(1)> for details."
504 msgstr ""
505
506 #. type: =head1
507 #: ../cat/virt-cat.pod:198 ../cat/virt-filesystems.pod:372 ../cat/virt-ls.pod:490 ../df/virt-df.pod:222 ../edit/virt-edit.pod:349 ../fish/guestfish.pod:1081 ../fuse/guestmount.pod:303 ../inspector/virt-inspector.pod:375 ../resize/virt-resize.pod:608 ../test-tool/libguestfs-test-tool.pod:90
508 msgid "EXIT STATUS"
509 msgstr ""
510
511 #. type: textblock
512 #: ../cat/virt-cat.pod:200 ../cat/virt-filesystems.pod:374 ../cat/virt-ls.pod:492 ../df/virt-df.pod:224 ../edit/virt-edit.pod:351 ../fuse/guestmount.pod:305 ../inspector/virt-inspector.pod:377 ../resize/virt-resize.pod:610
513 msgid "This program returns 0 if successful, or non-zero if there was an error."
514 msgstr ""
515
516 #. type: =head1
517 #: ../cat/virt-cat.pod:203 ../cat/virt-filesystems.pod:377 ../cat/virt-ls.pod:495 ../df/virt-df.pod:227 ../edit/virt-edit.pod:354 ../erlang/examples/guestfs-erlang.pod:97 ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384 ../fish/guestfish.pod:1235 ../fish/virt-copy-in.pod:50 ../fish/virt-copy-out.pod:39 ../fish/virt-tar-in.pod:47 ../fish/virt-tar-out.pod:41 ../fuse/guestmount.pod:308 ../inspector/virt-inspector.pod:380 ../java/examples/guestfs-java.pod:45 ../ocaml/examples/guestfs-ocaml.pod:78 ../perl/examples/guestfs-perl.pod:39 ../python/examples/guestfs-python.pod:42 ../rescue/virt-rescue.pod:288 ../resize/virt-resize.pod:613 ../ruby/examples/guestfs-ruby.pod:36 ../src/guestfs.pod:3164 ../test-tool/libguestfs-test-tool.pod:100 ../tools/virt-list-filesystems.pl:195 ../tools/virt-list-partitions.pl:265 ../tools/virt-make-fs.pl:539 ../tools/virt-tar.pl:296 ../tools/virt-win-reg.pl:746
518 msgid "SEE ALSO"
519 msgstr ""
520
521 #. type: textblock
522 #: ../cat/virt-cat.pod:205
523 msgid ""
524 "L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
525 "L<virt-tar-out(1)>, L<http://libguestfs.org/>."
526 msgstr ""
527
528 #. type: =head1
529 #: ../cat/virt-cat.pod:212 ../cat/virt-filesystems.pod:388 ../cat/virt-ls.pod:507 ../df/virt-df.pod:235 ../edit/virt-edit.pod:368 ../rescue/virt-rescue.pod:296 ../resize/virt-resize.pod:634 ../tools/virt-list-filesystems.pl:208 ../tools/virt-list-partitions.pl:277 ../tools/virt-make-fs.pl:564 ../tools/virt-tar.pl:311 ../tools/virt-win-reg.pl:772
530 msgid "AUTHOR"
531 msgstr ""
532
533 #. type: textblock
534 #: ../cat/virt-cat.pod:214 ../cat/virt-filesystems.pod:390 ../cat/virt-ls.pod:509 ../df/virt-df.pod:237 ../edit/virt-edit.pod:370 ../inspector/virt-inspector.pod:395 ../rescue/virt-rescue.pod:298 ../resize/virt-resize.pod:636 ../tools/virt-list-filesystems.pl:210 ../tools/virt-list-partitions.pl:279 ../tools/virt-make-fs.pl:566 ../tools/virt-tar.pl:313 ../tools/virt-win-reg.pl:774
535 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
536 msgstr ""
537
538 #. type: =head1
539 #: ../cat/virt-cat.pod:216 ../cat/virt-filesystems.pod:392 ../cat/virt-ls.pod:511 ../df/virt-df.pod:239 ../edit/virt-edit.pod:372 ../erlang/examples/guestfs-erlang.pod:114 ../examples/guestfs-examples.pod:49 ../examples/guestfs-recipes.pod:401 ../fish/guestfish.pod:1264 ../fish/virt-copy-in.pod:64 ../fish/virt-copy-out.pod:53 ../fish/virt-tar-in.pod:62 ../fish/virt-tar-out.pod:55 ../fuse/guestmount.pod:323 ../inspector/virt-inspector.pod:403 ../java/examples/guestfs-java.pod:62 ../ocaml/examples/guestfs-ocaml.pod:95 ../perl/examples/guestfs-perl.pod:56 ../python/examples/guestfs-python.pod:58 ../rescue/virt-rescue.pod:300 ../resize/virt-resize.pod:638 ../ruby/examples/guestfs-ruby.pod:52 ../src/guestfs.pod:3241 ../test-tool/libguestfs-test-tool.pod:110 ../tools/virt-list-filesystems.pl:212 ../tools/virt-list-partitions.pl:281 ../tools/virt-make-fs.pl:568 ../tools/virt-tar.pl:315 ../tools/virt-win-reg.pl:776
540 msgid "COPYRIGHT"
541 msgstr ""
542
543 #. type: textblock
544 #: ../cat/virt-cat.pod:218 ../inspector/virt-inspector.pod:405 ../resize/virt-resize.pod:640
545 msgid "Copyright (C) 2010-2011 Red Hat Inc."
546 msgstr ""
547
548 #. type: textblock
549 #: ../cat/virt-cat.pod:220 ../cat/virt-filesystems.pod:396 ../cat/virt-ls.pod:515 ../df/virt-df.pod:243 ../edit/virt-edit.pod:376 ../fish/guestfish.pod:1269 ../fish/virt-copy-in.pod:69 ../fish/virt-copy-out.pod:58 ../fish/virt-tar-in.pod:67 ../fish/virt-tar-out.pod:60 ../fuse/guestmount.pod:328 ../inspector/virt-inspector.pod:407 ../rescue/virt-rescue.pod:304 ../resize/virt-resize.pod:642 ../test-tool/libguestfs-test-tool.pod:115 ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:285 ../tools/virt-make-fs.pl:572 ../tools/virt-tar.pl:319 ../tools/virt-win-reg.pl:780
550 msgid ""
551 "This program is free software; you can redistribute it and/or modify it "
552 "under the terms of the GNU General Public License as published by the Free "
553 "Software Foundation; either version 2 of the License, or (at your option) "
554 "any later version."
555 msgstr ""
556
557 #. type: textblock
558 #: ../cat/virt-cat.pod:225 ../cat/virt-filesystems.pod:401 ../cat/virt-ls.pod:520 ../df/virt-df.pod:248 ../edit/virt-edit.pod:381 ../fish/guestfish.pod:1274 ../fish/virt-copy-in.pod:74 ../fish/virt-copy-out.pod:63 ../fish/virt-tar-in.pod:72 ../fish/virt-tar-out.pod:65 ../fuse/guestmount.pod:333 ../inspector/virt-inspector.pod:412 ../rescue/virt-rescue.pod:309 ../resize/virt-resize.pod:647 ../test-tool/libguestfs-test-tool.pod:120 ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:290 ../tools/virt-make-fs.pl:577 ../tools/virt-tar.pl:324 ../tools/virt-win-reg.pl:785
559 msgid ""
560 "This program is distributed in the hope that it will be useful, but WITHOUT "
561 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
562 "FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for "
563 "more details."
564 msgstr ""
565
566 #. type: textblock
567 #: ../cat/virt-cat.pod:230 ../cat/virt-filesystems.pod:406 ../cat/virt-ls.pod:525 ../df/virt-df.pod:253 ../edit/virt-edit.pod:386 ../fish/guestfish.pod:1279 ../fish/virt-copy-in.pod:79 ../fish/virt-copy-out.pod:68 ../fish/virt-tar-in.pod:77 ../fish/virt-tar-out.pod:70 ../fuse/guestmount.pod:338 ../inspector/virt-inspector.pod:417 ../rescue/virt-rescue.pod:314 ../resize/virt-resize.pod:652 ../test-tool/libguestfs-test-tool.pod:125 ../tools/virt-list-filesystems.pl:226 ../tools/virt-list-partitions.pl:295 ../tools/virt-make-fs.pl:582 ../tools/virt-tar.pl:329 ../tools/virt-win-reg.pl:790
568 msgid ""
569 "You should have received a copy of the GNU General Public License along with "
570 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
571 "Ave, Cambridge, MA 02139, USA."
572 msgstr ""
573
574 #. type: textblock
575 #: ../cat/virt-filesystems.pod:5
576 msgid ""
577 "virt-filesystems - List filesystems, partitions, block devices, LVM in a "
578 "virtual machine or disk image"
579 msgstr ""
580
581 #. type: verbatim
582 #: ../cat/virt-filesystems.pod:9
583 #, no-wrap
584 msgid ""
585 " virt-filesystems [--options] -d domname\n"
586 "\n"
587 msgstr ""
588
589 #. type: verbatim
590 #: ../cat/virt-filesystems.pod:11
591 #, no-wrap
592 msgid ""
593 " virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
594 "\n"
595 msgstr ""
596
597 #. type: textblock
598 #: ../cat/virt-filesystems.pod:15
599 msgid ""
600 "This tool allows you to discover filesystems, partitions, logical volumes, "
601 "and their sizes in a disk image or virtual machine.  It is a replacement for "
602 "L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
603 msgstr ""
604
605 #. type: textblock
606 #: ../cat/virt-filesystems.pod:20
607 msgid ""
608 "One use for this tool is from shell scripts to iterate over all filesystems "
609 "from a disk image:"
610 msgstr ""
611
612 #. type: verbatim
613 #: ../cat/virt-filesystems.pod:23
614 #, no-wrap
615 msgid ""
616 " for fs in $(virt-filesystems -a disk.img); do\n"
617 "   # ...\n"
618 " done\n"
619 "\n"
620 msgstr ""
621
622 #. type: textblock
623 #: ../cat/virt-filesystems.pod:27
624 msgid ""
625 "Another use is to list partitions before using another tool to modify those "
626 "partitions (such as L<virt-resize(1)>).  If you are curious about what an "
627 "unknown disk image contains, use this tool along with L<virt-inspector(1)>."
628 msgstr ""
629
630 #. type: textblock
631 #: ../cat/virt-filesystems.pod:32
632 msgid ""
633 "Various command line options control what this program displays.  You need "
634 "to give either I<-a> or I<-d> options to specify the disk image or libvirt "
635 "guest respectively.  If you just specify that then the program shows "
636 "filesystems found, one per line, like this:"
637 msgstr ""
638
639 #. type: verbatim
640 #: ../cat/virt-filesystems.pod:37
641 #, no-wrap
642 msgid ""
643 " $ virt-filesystems -a disk.img\n"
644 " /dev/sda1\n"
645 " /dev/vg_guest/lv_root\n"
646 "\n"
647 msgstr ""
648
649 #. type: textblock
650 #: ../cat/virt-filesystems.pod:41
651 msgid "If you add I<-l> or I<--long> then the output includes extra information:"
652 msgstr ""
653
654 #. type: verbatim
655 #: ../cat/virt-filesystems.pod:44
656 #, no-wrap
657 msgid ""
658 " $ virt-filesystems -a disk.img -l\n"
659 " Name                   Type         VFS   Label  Size\n"
660 " /dev/sda1              filesystem   ext4  boot   524288000\n"
661 " /dev/vg_guest/lv_root  filesystem   ext4  root   10212081664\n"
662 "\n"
663 msgstr ""
664
665 #. type: textblock
666 #: ../cat/virt-filesystems.pod:49
667 msgid ""
668 "If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
669 "shown as well:"
670 msgstr ""
671
672 #. type: verbatim
673 #: ../cat/virt-filesystems.pod:52
674 #, no-wrap
675 msgid ""
676 " $ virt-filesystems -a disk.img --extra\n"
677 " /dev/sda1\n"
678 " /dev/vg_guest/lv_root\n"
679 " /dev/vg_guest/lv_swap\n"
680 " /dev/vg_guest/lv_data\n"
681 "\n"
682 msgstr ""
683
684 #. type: textblock
685 #: ../cat/virt-filesystems.pod:58
686 msgid "If you add I<--partitions> then partitions are shown instead of filesystems:"
687 msgstr ""
688
689 #. type: verbatim
690 #: ../cat/virt-filesystems.pod:60
691 #, no-wrap
692 msgid ""
693 " $ virt-filesystems -a disk.img --partitions\n"
694 " /dev/sda1\n"
695 " /dev/sda2\n"
696 "\n"
697 msgstr ""
698
699 #. type: textblock
700 #: ../cat/virt-filesystems.pod:64
701 msgid ""
702 "Similarly you can use I<--logical-volumes>, I<--volume-groups>, "
703 "I<--physical-volumes>, I<--block-devices> to list those items."
704 msgstr ""
705
706 #. type: textblock
707 #: ../cat/virt-filesystems.pod:67
708 msgid ""
709 "You can use these options in combination as well (if you want a combination "
710 "including filesystems, you have to add I<--filesystems>).  Notice that some "
711 "items fall into several categories (eg. C</dev/sda1> might be both a "
712 "partition and a filesystem).  These items are listed several times.  To get "
713 "a list which includes absolutely everything that virt-filesystems knows "
714 "about, use the I<--all> option."
715 msgstr ""
716
717 #. type: textblock
718 #: ../cat/virt-filesystems.pod:74
719 msgid ""
720 "UUIDs (because they are quite long) are not shown by default.  Add the "
721 "I<--uuid> option to display device and filesystem UUIDs in the long output."
722 msgstr ""
723
724 #. type: textblock
725 #: ../cat/virt-filesystems.pod:78
726 msgid ""
727 "I<--all --long --uuid> is a useful combination to display all possible "
728 "information about everything."
729 msgstr ""
730
731 #. type: verbatim
732 #: ../cat/virt-filesystems.pod:81
733 #, no-wrap
734 msgid ""
735 " $ virt-filesystems -a win.img --all --long --uuid -h\n"
736 " Name      Type       VFS  Label           Size Parent   UUID\n"
737 " /dev/sda1 filesystem ntfs System Reserved 100M -        F81C92571C92112C\n"
738 " /dev/sda2 filesystem ntfs -               20G  -        F2E8996AE8992E3B\n"
739 " /dev/sda1 partition  -    -               100M /dev/sda -\n"
740 " /dev/sda2 partition  -    -               20G  /dev/sda -\n"
741 " /dev/sda  device     -    -               20G  -        -\n"
742 "\n"
743 msgstr ""
744
745 #. type: textblock
746 #: ../cat/virt-filesystems.pod:89
747 msgid "For machine-readable output, use I<--csv> to get Comma-Separated Values."
748 msgstr ""
749
750 #. type: =item
751 #: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121
752 msgid "B<--all>"
753 msgstr ""
754
755 #. type: textblock
756 #: ../cat/virt-filesystems.pod:112
757 msgid ""
758 "Display everything.  This is currently the same as specifying these options: "
759 "I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, "
760 "I<--logical-volumes>, I<--volume-groups>, I<--physical-volumes>.  (More may "
761 "be added to this list in future)."
762 msgstr ""
763
764 #. type: textblock
765 #: ../cat/virt-filesystems.pod:117
766 msgid "See also I<--long>."
767 msgstr ""
768
769 #. type: =item
770 #: ../cat/virt-filesystems.pod:119
771 msgid "B<--blkdevs>"
772 msgstr ""
773
774 #. type: =item
775 #: ../cat/virt-filesystems.pod:121
776 msgid "B<--block-devices>"
777 msgstr ""
778
779 #. type: textblock
780 #: ../cat/virt-filesystems.pod:123
781 msgid "Display block devices."
782 msgstr ""
783
784 #. type: =item
785 #: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301 ../df/virt-df.pod:88
786 msgid "B<--csv>"
787 msgstr ""
788
789 #. type: textblock
790 #: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303 ../df/virt-df.pod:90
791 msgid ""
792 "Write out the results in CSV format (comma-separated values).  This format "
793 "can be imported easily into databases and spreadsheets, but read L</NOTE "
794 "ABOUT CSV FORMAT> below."
795 msgstr ""
796
797 #. type: textblock
798 #: ../cat/virt-filesystems.pod:150
799 msgid ""
800 "When prompting for keys and passphrases, virt-filesystems normally turns "
801 "echoing off so you cannot see what you are typing.  If you are not worried "
802 "about Tempest attacks and there is no one else in the room you can specify "
803 "this flag to see what you are typing."
804 msgstr ""
805
806 #. type: =item
807 #: ../cat/virt-filesystems.pod:155
808 msgid "B<--extra>"
809 msgstr ""
810
811 #. type: textblock
812 #: ../cat/virt-filesystems.pod:157
813 msgid ""
814 "This causes filesystems that are not ordinary, mountable filesystems to be "
815 "displayed.  This category includes swapspace, and filesystems that are empty "
816 "or contain unknown data."
817 msgstr ""
818
819 #. type: textblock
820 #: ../cat/virt-filesystems.pod:161
821 msgid "This option implies I<--filesystems>."
822 msgstr ""
823
824 #. type: =item
825 #: ../cat/virt-filesystems.pod:163
826 msgid "B<--filesystems>"
827 msgstr ""
828
829 #. type: textblock
830 #: ../cat/virt-filesystems.pod:165
831 msgid ""
832 "Display mountable filesystems.  If no display option was selected then this "
833 "option is implied."
834 msgstr ""
835
836 #. type: textblock
837 #: ../cat/virt-filesystems.pod:168
838 msgid "With I<--extra>, non-mountable filesystems are shown too."
839 msgstr ""
840
841 #. type: verbatim
842 #: ../cat/virt-filesystems.pod:181
843 #, no-wrap
844 msgid ""
845 " virt-filesystems --format=raw -a disk.img\n"
846 "\n"
847 msgstr ""
848
849 #. type: verbatim
850 #: ../cat/virt-filesystems.pod:185
851 #, no-wrap
852 msgid ""
853 " virt-filesystems --format=raw -a disk.img --format -a another.img\n"
854 "\n"
855 msgstr ""
856
857 #. type: =item
858 #: ../cat/virt-filesystems.pod:194 ../cat/virt-ls.pod:352 ../df/virt-df.pod:125 ../fish/guestfish.pod:156 ../tools/virt-list-partitions.pl:109
859 msgid "B<-h>"
860 msgstr ""
861
862 #. type: =item
863 #: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354 ../df/virt-df.pod:127 ../tools/virt-list-partitions.pl:111
864 msgid "B<--human-readable>"
865 msgstr ""
866
867 #. type: textblock
868 #: ../cat/virt-filesystems.pod:198
869 msgid "In I<--long> mode, display sizes in human-readable format."
870 msgstr ""
871
872 #. type: =item
873 #: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366 ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
874 msgid "B<-l>"
875 msgstr ""
876
877 #. type: =item
878 #: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368 ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
879 msgid "B<--long>"
880 msgstr ""
881
882 #. type: textblock
883 #: ../cat/virt-filesystems.pod:209
884 msgid "Display extra columns of data (\"long format\")."
885 msgstr ""
886
887 #. type: textblock
888 #: ../cat/virt-filesystems.pod:211
889 msgid "A title row is added unless you also specify I<--no-title>."
890 msgstr ""
891
892 #. type: textblock
893 #: ../cat/virt-filesystems.pod:213
894 msgid ""
895 "The extra columns displayed depend on what output you select, and the "
896 "ordering of columns may change in future versions.  Use the title row, "
897 "I<--csv> output and/or L<csvtool(1)> to match columns to data in external "
898 "programs."
899 msgstr ""
900
901 #. type: textblock
902 #: ../cat/virt-filesystems.pod:218
903 msgid ""
904 "Use I<-h> if you want sizes to be displayed in human-readable format.  The "
905 "default is to show raw numbers of I<bytes>."
906 msgstr ""
907
908 #. type: textblock
909 #: ../cat/virt-filesystems.pod:221
910 msgid "Use I<--uuid> to display UUIDs too."
911 msgstr ""
912
913 #. type: =item
914 #: ../cat/virt-filesystems.pod:223
915 msgid "B<--lvs>"
916 msgstr ""
917
918 #. type: =item
919 #: ../cat/virt-filesystems.pod:225
920 msgid "B<--logvols>"
921 msgstr ""
922
923 #. type: =item
924 #: ../cat/virt-filesystems.pod:227
925 msgid "B<--logical-volumes>"
926 msgstr ""
927
928 #. type: textblock
929 #: ../cat/virt-filesystems.pod:229
930 msgid ""
931 "Display LVM logical volumes.  In this mode, these are displayed irrespective "
932 "of whether the LVs contain filesystems."
933 msgstr ""
934
935 #. type: =item
936 #: ../cat/virt-filesystems.pod:232
937 msgid "B<--no-title>"
938 msgstr ""
939
940 #. type: textblock
941 #: ../cat/virt-filesystems.pod:234
942 msgid "In I<--long> mode, don't add a title row."
943 msgstr ""
944
945 #. type: textblock
946 #: ../cat/virt-filesystems.pod:236
947 msgid ""
948 "Note that the order of the columns is not fixed, and may change in future "
949 "versions of virt-filesystems, so using this option may give you unexpected "
950 "surprises."
951 msgstr ""
952
953 #. type: =item
954 #: ../cat/virt-filesystems.pod:240
955 msgid "B<--parts>"
956 msgstr ""
957
958 #. type: =item
959 #: ../cat/virt-filesystems.pod:242
960 msgid "B<--partitions>"
961 msgstr ""
962
963 #. type: textblock
964 #: ../cat/virt-filesystems.pod:244
965 msgid ""
966 "Display partitions.  In this mode, these are displayed irrespective of "
967 "whether the partitions contain filesystems."
968 msgstr ""
969
970 #. type: =item
971 #: ../cat/virt-filesystems.pod:247
972 msgid "B<--pvs>"
973 msgstr ""
974
975 #. type: =item
976 #: ../cat/virt-filesystems.pod:249
977 msgid "B<--physvols>"
978 msgstr ""
979
980 #. type: =item
981 #: ../cat/virt-filesystems.pod:251
982 msgid "B<--physical-volumes>"
983 msgstr ""
984
985 #. type: textblock
986 #: ../cat/virt-filesystems.pod:253
987 msgid "Display LVM physical volumes."
988 msgstr ""
989
990 #. type: =item
991 #: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:163
992 msgid "B<--uuid>"
993 msgstr ""
994
995 #. type: =item
996 #: ../cat/virt-filesystems.pod:257
997 msgid "B<--uuids>"
998 msgstr ""
999
1000 #. type: textblock
1001 #: ../cat/virt-filesystems.pod:259
1002 msgid "In I<--long> mode, display UUIDs as well."
1003 msgstr ""
1004
1005 #. type: =item
1006 #: ../cat/virt-filesystems.pod:273
1007 msgid "B<--vgs>"
1008 msgstr ""
1009
1010 #. type: =item
1011 #: ../cat/virt-filesystems.pod:275
1012 msgid "B<--volgroups>"
1013 msgstr ""
1014
1015 #. type: =item
1016 #: ../cat/virt-filesystems.pod:277
1017 msgid "B<--volume-groups>"
1018 msgstr ""
1019
1020 #. type: textblock
1021 #: ../cat/virt-filesystems.pod:279
1022 msgid "Display LVM volume groups."
1023 msgstr ""
1024
1025 #. type: =head1
1026 #: ../cat/virt-filesystems.pod:287
1027 msgid "COLUMNS"
1028 msgstr ""
1029
1030 #. type: textblock
1031 #: ../cat/virt-filesystems.pod:289
1032 msgid ""
1033 "Note that columns in the output are subject to reordering and change in "
1034 "future versions of this tool."
1035 msgstr ""
1036
1037 #. type: =item
1038 #: ../cat/virt-filesystems.pod:294
1039 msgid "B<Name>"
1040 msgstr ""
1041
1042 #. type: textblock
1043 #: ../cat/virt-filesystems.pod:296
1044 msgid "The filesystem, partition, block device or LVM name."
1045 msgstr ""
1046
1047 #. type: textblock
1048 #: ../cat/virt-filesystems.pod:298
1049 msgid ""
1050 "For device and partition names these are displayed as canonical libguestfs "
1051 "names, so that for example C</dev/sda2> is the second partition on the first "
1052 "device."
1053 msgstr ""
1054
1055 #. type: textblock
1056 #: ../cat/virt-filesystems.pod:302
1057 msgid ""
1058 "If the I<--long> option is B<not> specified, then only the name column is "
1059 "shown in the output."
1060 msgstr ""
1061
1062 #. type: =item
1063 #: ../cat/virt-filesystems.pod:305
1064 msgid "B<Type>"
1065 msgstr ""
1066
1067 #. type: textblock
1068 #: ../cat/virt-filesystems.pod:307
1069 msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
1070 msgstr ""
1071
1072 #. type: =item
1073 #: ../cat/virt-filesystems.pod:309
1074 msgid "B<VFS>"
1075 msgstr ""
1076
1077 #. type: textblock
1078 #: ../cat/virt-filesystems.pod:311
1079 msgid ""
1080 "If there is a filesystem, then this column displays the filesystem type if "
1081 "one could be detected, eg. C<ext4>."
1082 msgstr ""
1083
1084 #. type: =item
1085 #: ../cat/virt-filesystems.pod:314
1086 msgid "B<Label>"
1087 msgstr ""
1088
1089 #. type: textblock
1090 #: ../cat/virt-filesystems.pod:316
1091 msgid ""
1092 "If the object has a label (used for identifying and mounting filesystems) "
1093 "then this column contains the label."
1094 msgstr ""
1095
1096 #. type: =item
1097 #: ../cat/virt-filesystems.pod:319
1098 msgid "B<Size>"
1099 msgstr ""
1100
1101 #. type: textblock
1102 #: ../cat/virt-filesystems.pod:321
1103 msgid ""
1104 "The size of the object in bytes.  If the I<--human> option is used then the "
1105 "size is displayed in a human-readable form."
1106 msgstr ""
1107
1108 #. type: =item
1109 #: ../cat/virt-filesystems.pod:324
1110 msgid "B<Parent>"
1111 msgstr ""
1112
1113 #. type: textblock
1114 #: ../cat/virt-filesystems.pod:326
1115 msgid ""
1116 "The parent column records the parent relationship between objects.  For "
1117 "example, if the object is a partition, then this column contains the name of "
1118 "the containing device.  If the object is a logical volume, then this column "
1119 "is the name of the volume group."
1120 msgstr ""
1121
1122 #. type: =item
1123 #: ../cat/virt-filesystems.pod:331
1124 msgid "B<UUID>"
1125 msgstr ""
1126
1127 #. type: textblock
1128 #: ../cat/virt-filesystems.pod:333
1129 msgid ""
1130 "If the object has a UUID (used for identifying and mounting filesystems and "
1131 "block devices) then this column contains the UUID as a string."
1132 msgstr ""
1133
1134 #. type: textblock
1135 #: ../cat/virt-filesystems.pod:337
1136 msgid "The UUID is only displayed if the I<--uuid> option is given."
1137 msgstr ""
1138
1139 #. type: =head1
1140 #: ../cat/virt-filesystems.pod:341 ../cat/virt-ls.pod:459 ../df/virt-df.pod:191
1141 msgid "NOTE ABOUT CSV FORMAT"
1142 msgstr ""
1143
1144 #. type: textblock
1145 #: ../cat/virt-filesystems.pod:343 ../cat/virt-ls.pod:461 ../df/virt-df.pod:193
1146 msgid ""
1147 "Comma-separated values (CSV) is a deceptive format.  It I<seems> like it "
1148 "should be easy to parse, but it is definitely not easy to parse."
1149 msgstr ""
1150
1151 #. type: textblock
1152 #: ../cat/virt-filesystems.pod:346 ../cat/virt-ls.pod:464 ../df/virt-df.pod:196
1153 msgid ""
1154 "Myth: Just split fields at commas.  Reality: This does I<not> work "
1155 "reliably.  This example has two columns:"
1156 msgstr ""
1157
1158 #. type: verbatim
1159 #: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:467 ../df/virt-df.pod:199
1160 #, no-wrap
1161 msgid ""
1162 " \"foo,bar\",baz\n"
1163 "\n"
1164 msgstr ""
1165
1166 #. type: textblock
1167 #: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:469 ../df/virt-df.pod:201
1168 msgid ""
1169 "Myth: Read the file one line at a time.  Reality: This does I<not> work "
1170 "reliably.  This example has one row:"
1171 msgstr ""
1172
1173 #. type: verbatim
1174 #: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:472 ../df/virt-df.pod:204
1175 #, no-wrap
1176 msgid ""
1177 " \"foo\n"
1178 " bar\",baz\n"
1179 "\n"
1180 msgstr ""
1181
1182 #. type: textblock
1183 #: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:475 ../df/virt-df.pod:207
1184 msgid ""
1185 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
1186 "packaged in major Linux distributions)."
1187 msgstr ""
1188
1189 #. type: textblock
1190 #: ../cat/virt-filesystems.pod:360 ../cat/virt-ls.pod:478 ../df/virt-df.pod:210
1191 msgid ""
1192 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
1193 "or Python's built-in csv library)."
1194 msgstr ""
1195
1196 #. type: textblock
1197 #: ../cat/virt-filesystems.pod:363 ../cat/virt-ls.pod:481 ../df/virt-df.pod:213
1198 msgid "Most spreadsheets and databases can import CSV directly."
1199 msgstr ""
1200
1201 #. type: textblock
1202 #: ../cat/virt-filesystems.pod:379
1203 msgid ""
1204 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
1205 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, "
1206 "L<http://libguestfs.org/>."
1207 msgstr ""
1208
1209 #. type: textblock
1210 #: ../cat/virt-filesystems.pod:394 ../tools/virt-make-fs.pl:570 ../tools/virt-win-reg.pl:778
1211 msgid "Copyright (C) 2010 Red Hat Inc."
1212 msgstr ""
1213
1214 #. type: textblock
1215 #: ../cat/virt-ls.pod:5
1216 msgid "virt-ls - List files in a virtual machine"
1217 msgstr ""
1218
1219 #. type: verbatim
1220 #: ../cat/virt-ls.pod:9
1221 #, no-wrap
1222 msgid ""
1223 " virt-ls [--options] -d domname directory [directory ...]\n"
1224 "\n"
1225 msgstr ""
1226
1227 #. type: verbatim
1228 #: ../cat/virt-ls.pod:11
1229 #, no-wrap
1230 msgid ""
1231 " virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory "
1232 "...]\n"
1233 "\n"
1234 msgstr ""
1235
1236 #. type: textblock
1237 #: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:13
1238 msgid "Old style:"
1239 msgstr ""
1240
1241 #. type: verbatim
1242 #: ../cat/virt-ls.pod:15
1243 #, no-wrap
1244 msgid ""
1245 " virt-ls [--options] domname directory\n"
1246 "\n"
1247 msgstr ""
1248
1249 #. type: verbatim
1250 #: ../cat/virt-ls.pod:17
1251 #, no-wrap
1252 msgid ""
1253 " virt-ls [--options] disk.img [disk.img ...] directory\n"
1254 "\n"
1255 msgstr ""
1256
1257 #. type: textblock
1258 #: ../cat/virt-ls.pod:21
1259 msgid ""
1260 "C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
1261 "more from a virtual machine or disk image."
1262 msgstr ""
1263
1264 #. type: textblock
1265 #: ../cat/virt-ls.pod:24
1266 msgid ""
1267 "Multiple directory names can be given, in which case the output from each is "
1268 "concatenated."
1269 msgstr ""
1270
1271 #. type: textblock
1272 #: ../cat/virt-ls.pod:27
1273 msgid ""
1274 "To list directories from a libvirt guest use the I<-d> option to specify the "
1275 "name of the guest.  For a disk image, use the I<-a> option."
1276 msgstr ""
1277
1278 #. type: textblock
1279 #: ../cat/virt-ls.pod:31
1280 msgid ""
1281 "C<virt-ls> can do many simple file listings.  For more complicated cases you "
1282 "may need to use L<guestfish(1)>, or write a program directly to the "
1283 "L<guestfs(3)> API."
1284 msgstr ""
1285
1286 #. type: textblock
1287 #: ../cat/virt-ls.pod:37
1288 msgid "Get a list of all files and directories in a virtual machine:"
1289 msgstr ""
1290
1291 #. type: verbatim
1292 #: ../cat/virt-ls.pod:39
1293 #, no-wrap
1294 msgid ""
1295 " virt-ls -R -d guest /\n"
1296 "\n"
1297 msgstr ""
1298
1299 #. type: textblock
1300 #: ../cat/virt-ls.pod:41
1301 msgid "List all setuid or setgid programs in a Linux virtual machine:"
1302 msgstr ""
1303
1304 #. type: verbatim
1305 #: ../cat/virt-ls.pod:43
1306 #, no-wrap
1307 msgid ""
1308 " virt-ls -lR -d guest / | grep '^- [42]'\n"
1309 "\n"
1310 msgstr ""
1311
1312 #. type: textblock
1313 #: ../cat/virt-ls.pod:45
1314 msgid "List all public-writable directories in a Linux virtual machine:"
1315 msgstr ""
1316
1317 #. type: verbatim
1318 #: ../cat/virt-ls.pod:47
1319 #, no-wrap
1320 msgid ""
1321 " virt-ls -lR -d guest / | grep '^d ...7'\n"
1322 "\n"
1323 msgstr ""
1324
1325 #. type: textblock
1326 #: ../cat/virt-ls.pod:49
1327 msgid "List all Unix domain sockets in a Linux virtual machine:"
1328 msgstr ""
1329
1330 #. type: verbatim
1331 #: ../cat/virt-ls.pod:51
1332 #, no-wrap
1333 msgid ""
1334 " virt-ls -lR -d guest / | grep '^s'\n"
1335 "\n"
1336 msgstr ""
1337
1338 #. type: textblock
1339 #: ../cat/virt-ls.pod:53
1340 msgid "List all regular files with filenames ending in '.png':"
1341 msgstr ""
1342
1343 #. type: verbatim
1344 #: ../cat/virt-ls.pod:55
1345 #, no-wrap
1346 msgid ""
1347 " virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
1348 "\n"
1349 msgstr ""
1350
1351 #. type: textblock
1352 #: ../cat/virt-ls.pod:57
1353 msgid "To display files larger than 10MB in home directories:"
1354 msgstr ""
1355
1356 #. type: verbatim
1357 #: ../cat/virt-ls.pod:59
1358 #, no-wrap
1359 msgid ""
1360 " virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
1361 "\n"
1362 msgstr ""
1363
1364 #. type: textblock
1365 #: ../cat/virt-ls.pod:61
1366 msgid "Find everything modified in the last 7 days:"
1367 msgstr ""
1368
1369 #. type: verbatim
1370 #: ../cat/virt-ls.pod:63
1371 #, no-wrap
1372 msgid ""
1373 " virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
1374 "\n"
1375 msgstr ""
1376
1377 #. type: textblock
1378 #: ../cat/virt-ls.pod:65
1379 msgid "Find regular files modified in the last 24 hours:"
1380 msgstr ""
1381
1382 #. type: verbatim
1383 #: ../cat/virt-ls.pod:67
1384 #, no-wrap
1385 msgid ""
1386 " virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
1387 "\n"
1388 msgstr ""
1389
1390 #. type: =head2
1391 #: ../cat/virt-ls.pod:69
1392 msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
1393 msgstr ""
1394
1395 #. type: textblock
1396 #: ../cat/virt-ls.pod:71
1397 msgid ""
1398 "Find the differences between files in a guest and an earlier snapshot of the "
1399 "same guest."
1400 msgstr ""
1401
1402 #. type: verbatim
1403 #: ../cat/virt-ls.pod:74
1404 #, no-wrap
1405 msgid ""
1406 " virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
1407 " virt-ls -lR -a current.img / --uids --time-t > new\n"
1408 " diff -u old new | less\n"
1409 "\n"
1410 msgstr ""
1411
1412 #. type: textblock
1413 #: ../cat/virt-ls.pod:78
1414 msgid ""
1415 "The commands above won't find files where the content has changed but the "
1416 "metadata (eg. file size and modification date) is the same.  To do that, you "
1417 "need to add the I<--checksum> parameter to both C<virt-ls> commands.  "
1418 "I<--checksum> can be quite slow since it has to read and compute a checksum "
1419 "of every regular file in the virtual machine."
1420 msgstr ""
1421
1422 #. type: =head1
1423 #: ../cat/virt-ls.pod:84
1424 msgid "OUTPUT MODES"
1425 msgstr ""
1426
1427 #. type: textblock
1428 #: ../cat/virt-ls.pod:86
1429 msgid ""
1430 "C<virt-ls> has four output modes, controlled by different combinations of "
1431 "the I<-l> and I<-R> options."
1432 msgstr ""
1433
1434 #. type: =head2
1435 #: ../cat/virt-ls.pod:89
1436 msgid "SIMPLE LISTING"
1437 msgstr ""
1438
1439 #. type: textblock
1440 #: ../cat/virt-ls.pod:91
1441 msgid "A simple listing is like the ordinary L<ls(1)> command:"
1442 msgstr ""
1443
1444 #. type: verbatim
1445 #: ../cat/virt-ls.pod:93
1446 #, no-wrap
1447 msgid ""
1448 " $ virt-ls -d guest /\n"
1449 " bin\n"
1450 " boot\n"
1451 " [etc.]\n"
1452 "\n"
1453 msgstr ""
1454
1455 #. type: =head2
1456 #: ../cat/virt-ls.pod:98
1457 msgid "LONG LISTING"
1458 msgstr ""
1459
1460 #. type: textblock
1461 #: ../cat/virt-ls.pod:100
1462 msgid ""
1463 "With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
1464 "(more specifically, like the C<guestfs_ll> function)."
1465 msgstr ""
1466
1467 #. type: verbatim
1468 #: ../cat/virt-ls.pod:103
1469 #, no-wrap
1470 msgid ""
1471 " $ virt-ls -l -d guest /\n"
1472 " total 204\n"
1473 " dr-xr-xr-x.   2 root root   4096 2009-08-25 19:06 bin\n"
1474 " dr-xr-xr-x.   5 root root   3072 2009-08-25 19:06 boot\n"
1475 " [etc.]\n"
1476 "\n"
1477 msgstr ""
1478
1479 #. type: textblock
1480 #: ../cat/virt-ls.pod:109
1481 msgid ""
1482 "Note that while this is useful for displaying a directory, do not try "
1483 "parsing this output in another program.  Use L</RECURSIVE LONG LISTING> "
1484 "instead."
1485 msgstr ""
1486
1487 #. type: =head2
1488 #: ../cat/virt-ls.pod:113
1489 msgid "RECURSIVE LISTING"
1490 msgstr ""
1491
1492 #. type: textblock
1493 #: ../cat/virt-ls.pod:115
1494 msgid ""
1495 "With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
1496 "and directories recursively:"
1497 msgstr ""
1498
1499 #. type: verbatim
1500 #: ../cat/virt-ls.pod:118
1501 #, no-wrap
1502 msgid ""
1503 " $ virt-ls -R -d guest /tmp\n"
1504 " foo\n"
1505 " foo/bar\n"
1506 " [etc.]\n"
1507 "\n"
1508 msgstr ""
1509
1510 #. type: textblock
1511 #: ../cat/virt-ls.pod:123
1512 msgid ""
1513 "To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
1514 "converts C<\\0> characters to C<\\n>."
1515 msgstr ""
1516
1517 #. type: =head2
1518 #: ../cat/virt-ls.pod:126
1519 msgid "RECURSIVE LONG LISTING"
1520 msgstr ""
1521
1522 #. type: textblock
1523 #: ../cat/virt-ls.pod:128
1524 msgid ""
1525 "Using I<-lR> options together changes the output to display directories "
1526 "recursively, with file stats, and optionally other features such as "
1527 "checksums and extended attributes."
1528 msgstr ""
1529
1530 #. type: textblock
1531 #: ../cat/virt-ls.pod:132
1532 msgid ""
1533 "Most of the interesting features of C<virt-ls> are only available when using "
1534 "I<-lR> mode."
1535 msgstr ""
1536
1537 #. type: textblock
1538 #: ../cat/virt-ls.pod:135
1539 msgid ""
1540 "The fields are normally space-separated.  Filenames are B<not> quoted, so "
1541 "you cannot use the output in another program (because filenames can contain "
1542 "spaces and other unsafe characters).  If the guest was untrusted and someone "
1543 "knew you were using C<virt-ls> to analyze the guest, they could play tricks "
1544 "on you by creating filenames with embedded newline characters.  To B<safely> "
1545 "parse the output in another program, use the I<--csv> (Comma-Separated "
1546 "Values) option."
1547 msgstr ""
1548
1549 #. type: textblock
1550 #: ../cat/virt-ls.pod:143
1551 msgid ""
1552 "Note that this output format is completely unrelated to the C<ls -lR> "
1553 "command."
1554 msgstr ""
1555
1556 #. type: verbatim
1557 #: ../cat/virt-ls.pod:146
1558 #, no-wrap
1559 msgid ""
1560 " $ virt-ls -lR -d guest /bin\n"
1561 " d 0555       4096 /bin\n"
1562 " - 0755        123 /bin/alsaunmute\n"
1563 " - 0755      28328 /bin/arch\n"
1564 " l 0777          4 /bin/awk -> gawk\n"
1565 " - 0755      27216 /bin/basename\n"
1566 " - 0755     943360 /bin/bash\n"
1567 " [etc.]\n"
1568 "\n"
1569 msgstr ""
1570
1571 #. type: textblock
1572 #: ../cat/virt-ls.pod:155
1573 msgid "These basic fields are always shown:"
1574 msgstr ""
1575
1576 #. type: =item
1577 #: ../cat/virt-ls.pod:159
1578 msgid "type"
1579 msgstr ""
1580
1581 #. type: textblock
1582 #: ../cat/virt-ls.pod:161
1583 msgid ""
1584 "The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
1585 "(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
1586 "link), C<s> (socket) or C<u> (unknown)."
1587 msgstr ""
1588
1589 #. type: =item
1590 #: ../cat/virt-ls.pod:171
1591 msgid "permissions"
1592 msgstr ""
1593
1594 #. type: textblock
1595 #: ../cat/virt-ls.pod:173
1596 msgid "The Unix permissions, displayed as a 4 digit octal number."
1597 msgstr ""
1598
1599 #. type: =item
1600 #: ../cat/virt-ls.pod:175
1601 msgid "size"
1602 msgstr ""
1603
1604 #. type: textblock
1605 #: ../cat/virt-ls.pod:177
1606 msgid ""
1607 "The size of the file.  This is shown in bytes unless I<-h> or "
1608 "I<--human-readable> option is given, in which case this is shown as a "
1609 "human-readable number."
1610 msgstr ""
1611
1612 #. type: =head2
1613 #: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4255
1614 msgid "path"
1615 msgstr ""
1616
1617 #. type: textblock
1618 #: ../cat/virt-ls.pod:183
1619 msgid "The full path of the file or directory."
1620 msgstr ""
1621
1622 #. type: =item
1623 #: ../cat/virt-ls.pod:185
1624 msgid "link"
1625 msgstr ""
1626
1627 #. type: textblock
1628 #: ../cat/virt-ls.pod:187
1629 msgid "For symbolic links only, the link target."
1630 msgstr ""
1631
1632 #. type: textblock
1633 #: ../cat/virt-ls.pod:191
1634 msgid ""
1635 "In I<-lR> mode, additional command line options enable the display of more "
1636 "fields."
1637 msgstr ""
1638
1639 #. type: textblock
1640 #: ../cat/virt-ls.pod:194
1641 msgid ""
1642 "With the I<--uids> flag, these additional fields are displayed before the "
1643 "path:"
1644 msgstr ""
1645
1646 #. type: =item
1647 #: ../cat/virt-ls.pod:199
1648 msgid "uid"
1649 msgstr ""
1650
1651 #. type: =item
1652 #: ../cat/virt-ls.pod:201
1653 msgid "gid"
1654 msgstr ""
1655
1656 #. type: textblock
1657 #: ../cat/virt-ls.pod:203
1658 msgid ""
1659 "The UID and GID of the owner of the file (displayed numerically).  Note "
1660 "these only make sense in the context of a Unix-like guest."
1661 msgstr ""
1662
1663 #. type: textblock
1664 #: ../cat/virt-ls.pod:208
1665 msgid "With the I<--times> flag, these additional fields are displayed:"
1666 msgstr ""
1667
1668 #. type: =item
1669 #: ../cat/virt-ls.pod:212
1670 msgid "atime"
1671 msgstr ""
1672
1673 #. type: textblock
1674 #: ../cat/virt-ls.pod:214
1675 msgid "The time of last access."
1676 msgstr ""
1677
1678 #. type: =item
1679 #: ../cat/virt-ls.pod:216
1680 msgid "mtime"
1681 msgstr ""
1682
1683 #. type: textblock
1684 #: ../cat/virt-ls.pod:218
1685 msgid "The time of last modification."
1686 msgstr ""
1687
1688 #. type: =item
1689 #: ../cat/virt-ls.pod:220
1690 msgid "ctime"
1691 msgstr ""
1692
1693 #. type: textblock
1694 #: ../cat/virt-ls.pod:222
1695 msgid "The time of last status change."
1696 msgstr ""
1697
1698 #. type: textblock
1699 #: ../cat/virt-ls.pod:226
1700 msgid ""
1701 "The time fields are displayed as string dates and times, unless one of the "
1702 "I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
1703 msgstr ""
1704
1705 #. type: textblock
1706 #: ../cat/virt-ls.pod:229
1707 msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
1708 msgstr ""
1709
1710 #. type: =item
1711 #: ../cat/virt-ls.pod:233
1712 msgid "device"
1713 msgstr ""
1714
1715 #. type: textblock
1716 #: ../cat/virt-ls.pod:235
1717 msgid ""
1718 "The device containing the file (displayed as major:minor).  This may not "
1719 "match devices as known to the guest."
1720 msgstr ""
1721
1722 #. type: =item
1723 #: ../cat/virt-ls.pod:238
1724 msgid "inode"
1725 msgstr ""
1726
1727 #. type: textblock
1728 #: ../cat/virt-ls.pod:240
1729 msgid "The inode number."
1730 msgstr ""
1731
1732 #. type: =item
1733 #: ../cat/virt-ls.pod:242
1734 msgid "nlink"
1735 msgstr ""
1736
1737 #. type: textblock
1738 #: ../cat/virt-ls.pod:244
1739 msgid "The number of hard links."
1740 msgstr ""
1741
1742 #. type: =item
1743 #: ../cat/virt-ls.pod:246
1744 msgid "rdev"
1745 msgstr ""
1746
1747 #. type: textblock
1748 #: ../cat/virt-ls.pod:248
1749 msgid "For block and char special files, the device (displayed as major:minor)."
1750 msgstr ""
1751
1752 #. type: =item
1753 #: ../cat/virt-ls.pod:251
1754 msgid "blocks"
1755 msgstr ""
1756
1757 #. type: textblock
1758 #: ../cat/virt-ls.pod:253
1759 msgid "The number of 512 byte blocks allocated to the file."
1760 msgstr ""
1761
1762 #. type: textblock
1763 #: ../cat/virt-ls.pod:257
1764 msgid ""
1765 "With the I<--checksum> flag, the checksum of the file contents is shown "
1766 "(only for regular files).  Computing file checksums can take a considerable "
1767 "amount of time."
1768 msgstr ""
1769
1770 #. type: =item
1771 #: ../cat/virt-ls.pod:280
1772 msgid "B<--checksum>"
1773 msgstr ""
1774
1775 #. type: =item
1776 #: ../cat/virt-ls.pod:282
1777 msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
1778 msgstr ""
1779
1780 #. type: textblock
1781 #: ../cat/virt-ls.pod:284
1782 msgid ""
1783 "Display checksum over file contents for regular files.  With no argument, "
1784 "this defaults to using I<md5>.  Using an argument, you can select the "
1785 "checksum type to use."
1786 msgstr ""
1787
1788 #. type: textblock
1789 #: ../cat/virt-ls.pod:288 ../cat/virt-ls.pod:325 ../cat/virt-ls.pod:358 ../cat/virt-ls.pod:391 ../cat/virt-ls.pod:401 ../cat/virt-ls.pod:408 ../cat/virt-ls.pod:415 ../cat/virt-ls.pod:422
1790 msgid ""
1791 "This option only has effect in I<-lR> output mode.  See L</RECURSIVE LONG "
1792 "LISTING> above."
1793 msgstr ""
1794
1795 #. type: textblock
1796 #: ../cat/virt-ls.pod:316
1797 msgid ""
1798 "When prompting for keys and passphrases, virt-ls normally turns echoing off "
1799 "so you cannot see what you are typing.  If you are not worried about Tempest "
1800 "attacks and there is no one else in the room you can specify this flag to "
1801 "see what you are typing."
1802 msgstr ""
1803
1804 #. type: =item
1805 #: ../cat/virt-ls.pod:321
1806 msgid "B<--extra-stats>"
1807 msgstr ""
1808
1809 #. type: textblock
1810 #: ../cat/virt-ls.pod:323
1811 msgid "Display extra stats."
1812 msgstr ""
1813
1814 #. type: verbatim
1815 #: ../cat/virt-ls.pod:339
1816 #, no-wrap
1817 msgid ""
1818 " virt-ls --format=raw -a disk.img /dir\n"
1819 "\n"
1820 msgstr ""
1821
1822 #. type: verbatim
1823 #: ../cat/virt-ls.pod:343
1824 #, no-wrap
1825 msgid ""
1826 " virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
1827 "\n"
1828 msgstr ""
1829
1830 #. type: textblock
1831 #: ../cat/virt-ls.pod:356
1832 msgid "Display file sizes in human-readable format."
1833 msgstr ""
1834
1835 #. type: =item
1836 #: ../cat/virt-ls.pod:370
1837 msgid "B<-R>"
1838 msgstr ""
1839
1840 #. type: =item
1841 #: ../cat/virt-ls.pod:372
1842 msgid "B<--recursive>"
1843 msgstr ""
1844
1845 #. type: textblock
1846 #: ../cat/virt-ls.pod:374
1847 msgid ""
1848 "Select the mode.  With neither of these options, C<virt-ls> produces a "
1849 "simple, flat list of the files in the named directory.  See L</SIMPLE "
1850 "LISTING>."
1851 msgstr ""
1852
1853 #. type: textblock
1854 #: ../cat/virt-ls.pod:378
1855 msgid ""
1856 "C<virt-ls -l> produces a \"long listing\", which shows more detail.  See "
1857 "L</LONG LISTING>."
1858 msgstr ""
1859
1860 #. type: textblock
1861 #: ../cat/virt-ls.pod:381
1862 msgid ""
1863 "C<virt-ls -R> produces a recursive list of files starting at the named "
1864 "directory.  See L</RECURSIVE LISTING>."
1865 msgstr ""
1866
1867 #. type: textblock
1868 #: ../cat/virt-ls.pod:384
1869 msgid ""
1870 "C<virt-ls -lR> produces a recursive long listing which can be more easily "
1871 "parsed.  See L</RECURSIVE LONG LISTING>."
1872 msgstr ""
1873
1874 #. type: =item
1875 #: ../cat/virt-ls.pod:387
1876 msgid "B<--times>"
1877 msgstr ""
1878
1879 #. type: textblock
1880 #: ../cat/virt-ls.pod:389
1881 msgid "Display time fields."
1882 msgstr ""
1883
1884 #. type: =item
1885 #: ../cat/virt-ls.pod:394
1886 msgid "B<--time-days>"
1887 msgstr ""
1888
1889 #. type: textblock
1890 #: ../cat/virt-ls.pod:396
1891 msgid "Display time fields as days before now (negative if in the future)."
1892 msgstr ""
1893
1894 #. type: textblock
1895 #: ../cat/virt-ls.pod:398
1896 msgid ""
1897 "Note that C<0> in output means \"up to 1 day before now\", or that the age "
1898 "of the file is between 0 and 86399 seconds."
1899 msgstr ""
1900
1901 #. type: =item
1902 #: ../cat/virt-ls.pod:404
1903 msgid "B<--time-relative>"
1904 msgstr ""
1905
1906 #. type: textblock
1907 #: ../cat/virt-ls.pod:406
1908 msgid "Display time fields as seconds before now (negative if in the future)."
1909 msgstr ""
1910
1911 #. type: =item
1912 #: ../cat/virt-ls.pod:411
1913 msgid "B<--time-t>"
1914 msgstr ""
1915
1916 #. type: textblock
1917 #: ../cat/virt-ls.pod:413
1918 msgid "Display time fields as seconds since the Unix epoch."
1919 msgstr ""
1920
1921 #. type: =item
1922 #: ../cat/virt-ls.pod:418
1923 msgid "B<--uids>"
1924 msgstr ""
1925
1926 #. type: textblock
1927 #: ../cat/virt-ls.pod:420
1928 msgid "Display UID and GID fields."
1929 msgstr ""
1930
1931 #. type: textblock
1932 #: ../cat/virt-ls.pod:445
1933 msgid "Previous versions of virt-ls allowed you to write either:"
1934 msgstr ""
1935
1936 #. type: verbatim
1937 #: ../cat/virt-ls.pod:447
1938 #, no-wrap
1939 msgid ""
1940 " virt-ls disk.img [disk.img ...] /dir\n"
1941 "\n"
1942 msgstr ""
1943
1944 #. type: verbatim
1945 #: ../cat/virt-ls.pod:451
1946 #, no-wrap
1947 msgid ""
1948 " virt-ls guestname /dir\n"
1949 "\n"
1950 msgstr ""
1951
1952 #. type: textblock
1953 #: ../cat/virt-ls.pod:497
1954 msgid ""
1955 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, "
1956 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
1957 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
1958 msgstr ""
1959
1960 #. type: textblock
1961 #: ../cat/virt-ls.pod:513 ../df/virt-df.pod:241 ../edit/virt-edit.pod:374 ../rescue/virt-rescue.pod:302
1962 msgid "Copyright (C) 2009-2011 Red Hat Inc."
1963 msgstr ""
1964
1965 #. type: textblock
1966 #: ../df/virt-df.pod:5
1967 msgid "virt-df - Display free space on virtual filesystems"
1968 msgstr ""
1969
1970 #. type: verbatim
1971 #: ../df/virt-df.pod:9
1972 #, no-wrap
1973 msgid ""
1974 " virt-df [--options]\n"
1975 "\n"
1976 msgstr ""
1977
1978 #. type: verbatim
1979 #: ../df/virt-df.pod:11
1980 #, no-wrap
1981 msgid ""
1982 " virt-df [--options] -d domname\n"
1983 "\n"
1984 msgstr ""
1985
1986 #. type: verbatim
1987 #: ../df/virt-df.pod:13
1988 #, no-wrap
1989 msgid ""
1990 " virt-df [--options] -a disk.img [-a disk.img ...]\n"
1991 "\n"
1992 msgstr ""
1993
1994 #. type: verbatim
1995 #: ../df/virt-df.pod:17
1996 #, no-wrap
1997 msgid ""
1998 " virt-df [--options] domname\n"
1999 "\n"
2000 msgstr ""
2001
2002 #. type: verbatim
2003 #: ../df/virt-df.pod:19
2004 #, no-wrap
2005 msgid ""
2006 " virt-df [--options] disk.img [disk.img ...]\n"
2007 "\n"
2008 msgstr ""
2009
2010 #. type: textblock
2011 #: ../df/virt-df.pod:23
2012 msgid ""
2013 "C<virt-df> is a command line tool to display free space on virtual machine "
2014 "filesystems.  Unlike other tools, it doesn't just display the size of disk "
2015 "allocated to a virtual machine, but can look inside disk images to see how "
2016 "much space is really being used."
2017 msgstr ""
2018
2019 #. type: textblock
2020 #: ../df/virt-df.pod:28
2021 msgid ""
2022 "If used without any I<-a> or I<-d> arguments, C<virt-df> checks with libvirt "
2023 "to get a list of all active and inactive guests, and performs a C<df>-type "
2024 "operation on each one in turn, printing out the results."
2025 msgstr ""
2026
2027 #. type: textblock
2028 #: ../df/virt-df.pod:32
2029 msgid ""
2030 "If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a "
2031 "C<df>-type operation on either the single named libvirt domain, or on the "
2032 "disk image(s) listed on the command line (which must all belong to a single "
2033 "VM).  In this mode (with arguments), C<virt-df> will I<only work for a "
2034 "single guest>.  If you want to run on multiple guests, then you have to "
2035 "invoke C<virt-df> multiple times."
2036 msgstr ""
2037
2038 #. type: textblock
2039 #: ../df/virt-df.pod:39
2040 msgid ""
2041 "Use the I<--csv> option to get a format which can be easily parsed by other "
2042 "programs.  Other options are similar to the standard L<df(1)> command."
2043 msgstr ""
2044
2045 #. type: textblock
2046 #: ../df/virt-df.pod:45
2047 msgid ""
2048 "Show disk usage for a single libvirt guest called C<F14x64>.  Make the "
2049 "output human-readable:"
2050 msgstr ""
2051
2052 #. type: verbatim
2053 #: ../df/virt-df.pod:48
2054 #, no-wrap
2055 msgid ""
2056 " # virt-df -d F14x64 -h\n"
2057 " Filesystem                       Size     Used  Available  Use%\n"
2058 " F14x64:/dev/sda1                 484M      66M       393M   14%\n"
2059 " F14x64:/dev/vg_f13x64/lv_root    7.4G     3.4G       4.0G   46%\n"
2060 "\n"
2061 msgstr ""
2062
2063 #. type: textblock
2064 #: ../df/virt-df.pod:53
2065 msgid "Show disk usage for a disk image file called C<test.img>:"
2066 msgstr ""
2067
2068 #. type: verbatim
2069 #: ../df/virt-df.pod:55
2070 #, no-wrap
2071 msgid ""
2072 " $ virt-df -a test1.img\n"
2073 " Filesystem                  1K-blocks     Used  Available  Use%\n"
2074 " test1.img:/dev/sda1             99099     1551      92432    2%\n"
2075 "\n"
2076 msgstr ""
2077
2078 #. type: verbatim
2079 #: ../df/virt-df.pod:112
2080 #, no-wrap
2081 msgid ""
2082 " virt-df --format=raw -a disk.img\n"
2083 "\n"
2084 msgstr ""
2085
2086 #. type: verbatim
2087 #: ../df/virt-df.pod:116
2088 #, no-wrap
2089 msgid ""
2090 " virt-df --format=raw -a disk.img --format -a another.img\n"
2091 "\n"
2092 msgstr ""
2093
2094 #. type: textblock
2095 #: ../df/virt-df.pod:129
2096 msgid "Print sizes in human-readable format."
2097 msgstr ""
2098
2099 #. type: textblock
2100 #: ../df/virt-df.pod:131
2101 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
2102 msgstr ""
2103
2104 #. type: =item
2105 #: ../df/virt-df.pod:133 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:155
2106 msgid "B<-i>"
2107 msgstr ""
2108
2109 #. type: =item
2110 #: ../df/virt-df.pod:135
2111 msgid "B<--inodes>"
2112 msgstr ""
2113
2114 #. type: textblock
2115 #: ../df/virt-df.pod:137
2116 msgid "Print inodes instead of blocks."
2117 msgstr ""
2118
2119 #. type: =item
2120 #: ../df/virt-df.pod:139
2121 msgid "B<--one-per-guest>"
2122 msgstr ""
2123
2124 #. type: textblock
2125 #: ../df/virt-df.pod:141
2126 msgid ""
2127 "Run one libguestfs appliance per guest.  Normally C<virt-df> will add the "
2128 "disks from several guests to a single libguestfs appliance."
2129 msgstr ""
2130
2131 #. type: textblock
2132 #: ../df/virt-df.pod:144
2133 msgid "You might use this option in the following circumstances:"
2134 msgstr ""
2135
2136 #. type: =item
2137 #: ../df/virt-df.pod:148 ../df/virt-df.pod:154 ../edit/virt-edit.pod:266 ../edit/virt-edit.pod:271 ../edit/virt-edit.pod:276 ../edit/virt-edit.pod:287 ../edit/virt-edit.pod:291 ../examples/guestfs-recipes.pod:98 ../examples/guestfs-recipes.pod:102 ../examples/guestfs-recipes.pod:106 ../examples/guestfs-recipes.pod:132 ../examples/guestfs-recipes.pod:137 ../examples/guestfs-recipes.pod:227 ../examples/guestfs-recipes.pod:231 ../examples/guestfs-recipes.pod:235 ../examples/guestfs-recipes.pod:239 ../examples/guestfs-recipes.pod:243 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:390 ../fish/guestfish-actions.pod:398 ../fish/guestfish-actions.pod:405 ../fish/guestfish-actions.pod:412 ../fish/guestfish-actions.pod:1139 ../fish/guestfish-actions.pod:1143 ../fish/guestfish-actions.pod:1147 ../fish/guestfish-actions.pod:1151 ../fish/guestfish-actions.pod:1159 ../fish/guestfish-actions.pod:1163 ../fish/guestfish-actions.pod:1167 ../fish/guestfish-actions.pod:1177 ../fish/guestfish-actions.pod:1181 ../fish/guestfish-actions.pod:1185 ../fish/guestfish-actions.pod:1275 ../fish/guestfish-actions.pod:1279 ../fish/guestfish-actions.pod:1284 ../fish/guestfish-actions.pod:1289 ../fish/guestfish-actions.pod:1331 ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:1340 ../fish/guestfish-actions.pod:1596 ../fish/guestfish-actions.pod:1603 ../fish/guestfish-actions.pod:1610 ../fish/guestfish-actions.pod:2005 ../fish/guestfish-actions.pod:2011 ../fish/guestfish-actions.pod:2019 ../fish/guestfish-actions.pod:2026 ../fish/guestfish-actions.pod:2033 ../fish/guestfish.pod:445 ../fish/guestfish.pod:449 ../fish/guestfish.pod:453 ../fish/guestfish.pod:457 ../inspector/virt-inspector.pod:393 ../inspector/virt-inspector.pod:397 ../resize/virt-resize.pod:282 ../resize/virt-resize.pod:286 ../resize/virt-resize.pod:295 ../resize/virt-resize.pod:301 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:588 ../src/guestfs-actions.pod:596 ../src/guestfs-actions.pod:603 ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1774 ../src/guestfs-actions.pod:1778 ../src/guestfs-actions.pod:1782 ../src/guestfs-actions.pod:1786 ../src/guestfs-actions.pod:1794 ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:1802 ../src/guestfs-actions.pod:1812 ../src/guestfs-actions.pod:1816 ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1958 ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:1967 ../src/guestfs-actions.pod:1972 ../src/guestfs-actions.pod:2033 ../src/guestfs-actions.pod:2037 ../src/guestfs-actions.pod:2042 ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:2462 ../src/guestfs-actions.pod:2469 ../src/guestfs-actions.pod:3006 ../src/guestfs-actions.pod:3012 ../src/guestfs-actions.pod:3020 ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3034 ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398 ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411 ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1091 ../src/guestfs.pod:1095 ../src/guestfs.pod:1099 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112 ../src/guestfs.pod:1131 ../src/guestfs.pod:1139 ../src/guestfs.pod:1161 ../src/guestfs.pod:1165 ../src/guestfs.pod:1169 ../src/guestfs.pod:1173 ../src/guestfs.pod:1177 ../src/guestfs.pod:1181 ../src/guestfs.pod:1671 ../src/guestfs.pod:1676 ../src/guestfs.pod:1680 ../src/guestfs.pod:1782 ../src/guestfs.pod:1787 ../src/guestfs.pod:1791 ../src/guestfs.pod:1801 ../src/guestfs.pod:2090 ../src/guestfs.pod:2095 ../src/guestfs.pod:2101 ../src/guestfs.pod:2109 ../src/guestfs.pod:2556 ../src/guestfs.pod:2562 ../src/guestfs.pod:2567 ../src/guestfs.pod:2573 ../src/guestfs.pod:2956 ../src/guestfs.pod:2961 ../src/guestfs.pod:2965 ../src/guestfs.pod:2969 ../src/guestfs.pod:2973 ../src/guestfs.pod:2987 ../src/guestfs.pod:2992 ../src/guestfs.pod:3218 ../src/guestfs.pod:3222 ../src/guestfs.pod:3226 ../src/guestfs.pod:3230 ../tools/virt-win-reg.pl:197 ../tools/virt-win-reg.pl:202 ../tools/virt-win-reg.pl:208 ../tools/virt-win-reg.pl:710 ../tools/virt-win-reg.pl:716 ../tools/virt-win-reg.pl:722
2138 msgid "*"
2139 msgstr ""
2140
2141 #. type: textblock
2142 #: ../df/virt-df.pod:150
2143 msgid ""
2144 "If you think an untrusted guest might actively try to exploit the libguestfs "
2145 "appliance kernel, then this prevents one guest from interfering with the "
2146 "stats printed for another guest."
2147 msgstr ""
2148
2149 #. type: textblock
2150 #: ../df/virt-df.pod:156
2151 msgid ""
2152 "If the kernel has a bug which stops it from accessing a filesystem in one "
2153 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
2154 "and report stats for further guests."
2155 msgstr ""
2156
2157 #. type: textblock
2158 #: ../df/virt-df.pod:165
2159 msgid ""
2160 "Print UUIDs instead of names.  This is useful for following a guest even "
2161 "when the guest is migrated or renamed, or when two guests happen to have the "
2162 "same name."
2163 msgstr ""
2164
2165 #. type: textblock
2166 #: ../df/virt-df.pod:169
2167 msgid ""
2168 "Note that only domains that we fetch from libvirt come with UUIDs.  For disk "
2169 "images, we still print the disk image name even when this option is "
2170 "specified."
2171 msgstr ""
2172
2173 #. type: textblock
2174 #: ../df/virt-df.pod:229
2175 msgid ""
2176 "L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
2177 "L<http://libguestfs.org/>."
2178 msgstr ""
2179
2180 #. type: textblock
2181 #: ../edit/virt-edit.pod:5
2182 msgid "virt-edit - Edit a file in a virtual machine"
2183 msgstr ""
2184
2185 #. type: verbatim
2186 #: ../edit/virt-edit.pod:9
2187 #, no-wrap
2188 msgid ""
2189 " virt-edit [--options] -d domname file [file ...]\n"
2190 "\n"
2191 msgstr ""
2192
2193 #. type: verbatim
2194 #: ../edit/virt-edit.pod:11
2195 #, no-wrap
2196 msgid ""
2197 " virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
2198 "\n"
2199 msgstr ""
2200
2201 #. type: verbatim
2202 #: ../edit/virt-edit.pod:13
2203 #, no-wrap
2204 msgid ""
2205 " virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
2206 "\n"
2207 msgstr ""
2208
2209 #. type: verbatim
2210 #: ../edit/virt-edit.pod:17
2211 #, no-wrap
2212 msgid ""
2213 " virt-edit domname file\n"
2214 "\n"
2215 msgstr ""
2216
2217 #. type: verbatim
2218 #: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
2219 #, no-wrap
2220 msgid ""
2221 " virt-edit disk.img [disk.img ...] file\n"
2222 "\n"
2223 msgstr ""
2224
2225 #. type: =head1
2226 #: ../edit/virt-edit.pod:21 ../fish/guestfish.pod:23 ../fish/virt-copy-in.pod:13 ../fish/virt-tar-in.pod:15 ../fuse/guestmount.pod:15 ../rescue/virt-rescue.pod:19 ../tools/virt-tar.pl:64 ../tools/virt-win-reg.pl:51
2227 msgid "WARNING"
2228 msgstr ""
2229
2230 #. type: textblock
2231 #: ../edit/virt-edit.pod:23
2232 msgid ""
2233 "You must I<not> use C<virt-edit> on live virtual machines.  If you do this, "
2234 "you risk disk corruption in the VM.  C<virt-edit> tries to stop you from "
2235 "doing this, but doesn't catch all cases."
2236 msgstr ""
2237
2238 #. type: textblock
2239 #: ../edit/virt-edit.pod:29
2240 msgid ""
2241 "C<virt-edit> is a command line tool to edit C<file> where each C<file> "
2242 "exists in the named virtual machine (or disk image)."
2243 msgstr ""
2244
2245 #. type: textblock
2246 #: ../edit/virt-edit.pod:32
2247 msgid ""
2248 "Multiple filenames can be given, in which case they are each edited in "
2249 "turn.  Each filename must be a full path, starting at the root directory "
2250 "(starting with '/')."
2251 msgstr ""
2252
2253 #. type: textblock
2254 #: ../edit/virt-edit.pod:36
2255 msgid "If you want to just view a file, use L<virt-cat(1)>."
2256 msgstr ""
2257
2258 #. type: textblock
2259 #: ../edit/virt-edit.pod:38
2260 msgid ""
2261 "For more complex cases you should look at the L<guestfish(1)> tool (see "
2262 "L</USING GUESTFISH> below)."
2263 msgstr ""
2264
2265 #. type: textblock
2266 #: ../edit/virt-edit.pod:41
2267 msgid ""
2268 "C<virt-edit> cannot be used to create a new file.  L<guestfish(1)> can do "
2269 "that and much more."
2270 msgstr ""
2271
2272 #. type: textblock
2273 #: ../edit/virt-edit.pod:46
2274 msgid "Edit the named files interactively:"
2275 msgstr ""
2276
2277 #. type: verbatim
2278 #: ../edit/virt-edit.pod:48
2279 #, no-wrap
2280 msgid ""
2281 " virt-edit -d mydomain /boot/grub/grub.conf\n"
2282 "\n"
2283 msgstr ""
2284
2285 #. type: verbatim
2286 #: ../edit/virt-edit.pod:50
2287 #, no-wrap
2288 msgid ""
2289 " virt-edit -d mydomain /etc/passwd\n"
2290 "\n"
2291 msgstr ""
2292
2293 #. type: textblock
2294 #: ../edit/virt-edit.pod:52
2295 msgid "For Windows guests, some Windows paths are understood:"
2296 msgstr ""
2297
2298 #. type: verbatim
2299 #: ../edit/virt-edit.pod:54
2300 #, no-wrap
2301 msgid ""
2302 " virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
2303 "\n"
2304 msgstr ""
2305
2306 #. type: textblock
2307 #: ../edit/virt-edit.pod:56
2308 msgid ""
2309 "If Perl is installed, you can also edit files non-interactively (see "
2310 "L</NON-INTERACTIVE EDITING> below).  To change the init default level to 5:"
2311 msgstr ""
2312
2313 #. type: verbatim
2314 #: ../edit/virt-edit.pod:60
2315 #, no-wrap
2316 msgid ""
2317 " virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
2318 "\n"
2319 msgstr ""
2320
2321 #. type: =item
2322 #: ../edit/virt-edit.pod:81
2323 msgid "B<-b> extension"
2324 msgstr ""
2325
2326 #. type: =item
2327 #: ../edit/virt-edit.pod:83
2328 msgid "B<--backup> extension"
2329 msgstr ""
2330
2331 #. type: textblock
2332 #: ../edit/virt-edit.pod:85
2333 msgid ""
2334 "Create a backup of the original file I<in the guest disk image>.  The backup "
2335 "has the original filename with C<extension> added."
2336 msgstr ""
2337
2338 #. type: textblock
2339 #: ../edit/virt-edit.pod:88
2340 msgid ""
2341 "Usually the first character of C<extension> would be a dot C<.> so you would "
2342 "write:"
2343 msgstr ""
2344
2345 #. type: verbatim
2346 #: ../edit/virt-edit.pod:91
2347 #, no-wrap
2348 msgid ""
2349 " virt-edit -b .orig [etc]\n"
2350 "\n"
2351 msgstr ""
2352
2353 #. type: textblock
2354 #: ../edit/virt-edit.pod:93
2355 msgid "By default, no backup file is made."
2356 msgstr ""
2357
2358 #. type: =item
2359 #: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181 ../fuse/guestmount.pod:96 ../inspector/virt-inspector.pod:74 ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78 ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
2360 msgid "B<-c URI>"
2361 msgstr ""
2362
2363 #. type: =item
2364 #: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183 ../fuse/guestmount.pod:98 ../inspector/virt-inspector.pod:76 ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80 ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
2365 msgid "B<--connect URI>"
2366 msgstr ""
2367
2368 #. type: textblock
2369 #: ../edit/virt-edit.pod:102 ../tools/virt-list-filesystems.pl:84 ../tools/virt-list-partitions.pl:85 ../tools/virt-tar.pl:134 ../tools/virt-win-reg.pl:135
2370 msgid ""
2371 "If you specify guest block devices directly, then libvirt is not used at "
2372 "all."
2373 msgstr ""
2374
2375 #. type: textblock
2376 #: ../edit/virt-edit.pod:114
2377 msgid ""
2378 "When prompting for keys and passphrases, virt-edit normally turns echoing "
2379 "off so you cannot see what you are typing.  If you are not worried about "
2380 "Tempest attacks and there is no one else in the room you can specify this "
2381 "flag to see what you are typing."
2382 msgstr ""
2383
2384 #. type: =item
2385 #: ../edit/virt-edit.pod:119
2386 msgid "B<-e> EXPR"
2387 msgstr ""
2388
2389 #. type: =item
2390 #: ../edit/virt-edit.pod:121
2391 msgid "B<--expr> EXPR"
2392 msgstr ""
2393
2394 #. type: textblock
2395 #: ../edit/virt-edit.pod:123
2396 msgid ""
2397 "Instead of launching the external editor, non-interactively apply the Perl "
2398 "expression C<EXPR> to each line in the file.  See L</NON-INTERACTIVE "
2399 "EDITING> below."
2400 msgstr ""
2401
2402 #. type: textblock
2403 #: ../edit/virt-edit.pod:127
2404 msgid ""
2405 "Be careful to properly quote the expression to prevent it from being altered "
2406 "by the shell."
2407 msgstr ""
2408
2409 #. type: textblock
2410 #: ../edit/virt-edit.pod:130
2411 msgid "Note that this option is only available when Perl 5 is installed."
2412 msgstr ""
2413
2414 #. type: =item
2415 #: ../edit/virt-edit.pod:132
2416 msgid "B<--format> raw|qcow2|..."
2417 msgstr ""
2418
2419 #. type: verbatim
2420 #: ../edit/virt-edit.pod:143
2421 #, no-wrap
2422 msgid ""
2423 " virt-edit --format=raw -a disk.img file\n"
2424 "\n"
2425 msgstr ""
2426
2427 #. type: verbatim
2428 #: ../edit/virt-edit.pod:147
2429 #, no-wrap
2430 msgid ""
2431 " virt-edit --format=raw -a disk.img --format -a another.img file\n"
2432 "\n"
2433 msgstr ""
2434
2435 #. type: textblock
2436 #: ../edit/virt-edit.pod:181
2437 msgid "Previous versions of virt-edit allowed you to write either:"
2438 msgstr ""
2439
2440 #. type: verbatim
2441 #: ../edit/virt-edit.pod:187
2442 #, no-wrap
2443 msgid ""
2444 " virt-edit guestname file\n"
2445 "\n"
2446 msgstr ""
2447
2448 #. type: =head1
2449 #: ../edit/virt-edit.pod:195
2450 msgid "NON-INTERACTIVE EDITING"
2451 msgstr ""
2452
2453 #. type: textblock
2454 #: ../edit/virt-edit.pod:197
2455 msgid ""
2456 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
2457 "administrator can interactively edit the file."
2458 msgstr ""
2459
2460 #. type: textblock
2461 #: ../edit/virt-edit.pod:200
2462 msgid ""
2463 "There are two ways also to use C<virt-edit> from scripts in order to make "
2464 "automated edits to files.  (Note that although you I<can> use C<virt-edit> "
2465 "like this, it's less error-prone to write scripts directly using the "
2466 "libguestfs API and Augeas for configuration file editing.)"
2467 msgstr ""
2468
2469 #. type: textblock
2470 #: ../edit/virt-edit.pod:206
2471 msgid ""
2472 "The first method is to temporarily set C<$EDITOR> to any script or program "
2473 "you want to run.  The script is invoked as C<$EDITOR tmpfile> and it should "
2474 "update C<tmpfile> in place however it likes."
2475 msgstr ""
2476
2477 #. type: textblock
2478 #: ../edit/virt-edit.pod:210
2479 msgid ""
2480 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
2481 "short Perl snippet in the style of L<sed(1)>.  For example to replace all "
2482 "instances of C<foo> with C<bar> in a file:"
2483 msgstr ""
2484
2485 #. type: verbatim
2486 #: ../edit/virt-edit.pod:214
2487 #, no-wrap
2488 msgid ""
2489 " virt-edit -d domname filename -e 's/foo/bar/'\n"
2490 "\n"
2491 msgstr ""
2492
2493 #. type: textblock
2494 #: ../edit/virt-edit.pod:216
2495 msgid ""
2496 "The full power of Perl regular expressions can be used (see L<perlre(1)>).  "
2497 "For example to delete root's password you could do:"
2498 msgstr ""
2499
2500 #. type: verbatim
2501 #: ../edit/virt-edit.pod:219
2502 #, no-wrap
2503 msgid ""
2504 " virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
2505 "\n"
2506 msgstr ""
2507
2508 #. type: textblock
2509 #: ../edit/virt-edit.pod:221
2510 msgid ""
2511 "What really happens is that the snippet is evaluated as a Perl expression "
2512 "for each line of the file.  The line, including the final C<\\n>, is passed "
2513 "in C<$_> and the expression should update C<$_> or leave it unchanged."
2514 msgstr ""
2515
2516 #. type: textblock
2517 #: ../edit/virt-edit.pod:226
2518 msgid ""
2519 "To delete a line, set C<$_> to the empty string.  For example, to delete the "
2520 "C<apache> user account from the password file you can do:"
2521 msgstr ""
2522
2523 #. type: verbatim
2524 #: ../edit/virt-edit.pod:229
2525 #, no-wrap
2526 msgid ""
2527 " virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
2528 "\n"
2529 msgstr ""
2530
2531 #. type: textblock
2532 #: ../edit/virt-edit.pod:231
2533 msgid ""
2534 "To insert a line, prepend or append it to C<$_>.  However appending lines to "
2535 "the end of the file is rather difficult this way since there is no concept "
2536 "of \"last line of the file\" - your expression just doesn't get called "
2537 "again.  You might want to use the first method (setting C<$EDITOR>) if you "
2538 "want to do this."
2539 msgstr ""
2540
2541 #. type: textblock
2542 #: ../edit/virt-edit.pod:237
2543 msgid ""
2544 "The variable C<$lineno> contains the current line number.  As is "
2545 "traditional, the first line in the file is number C<1>."
2546 msgstr ""
2547
2548 #. type: textblock
2549 #: ../edit/virt-edit.pod:240
2550 msgid ""
2551 "The return value from the expression is ignored, but the expression may call "
2552 "C<die> in order to abort the whole program, leaving the original file "
2553 "untouched."
2554 msgstr ""
2555
2556 #. type: textblock
2557 #: ../edit/virt-edit.pod:244
2558 msgid ""
2559 "Remember when matching the end of a line that C<$_> may contain the final "
2560 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
2561 "newline then neither of these.  Thus to match or substitute some text at the "
2562 "end of a line, use this regular expression:"
2563 msgstr ""
2564
2565 #. type: verbatim
2566 #: ../edit/virt-edit.pod:249
2567 #, no-wrap
2568 msgid ""
2569 " /some text(\\r?\\n)?$/\n"
2570 "\n"
2571 msgstr ""
2572
2573 #. type: textblock
2574 #: ../edit/virt-edit.pod:251
2575 msgid ""
2576 "Alternately, use the perl C<chomp> function, being careful not to chomp "
2577 "C<$_> itself (since that would remove all newlines from the file):"
2578 msgstr ""
2579
2580 #. type: verbatim
2581 #: ../edit/virt-edit.pod:255
2582 #, no-wrap
2583 msgid ""
2584 " my $m = $_; chomp $m; $m =~ /some text$/\n"
2585 "\n"
2586 msgstr ""
2587
2588 #. type: =head1
2589 #: ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
2590 msgid "WINDOWS PATHS"
2591 msgstr ""
2592
2593 #. type: textblock
2594 #: ../edit/virt-edit.pod:259
2595 msgid ""
2596 "C<virt-edit> has a limited ability to understand Windows drive letters and "
2597 "paths (eg. C<E:\\foo\\bar.txt>)."
2598 msgstr ""
2599
2600 #. type: textblock
2601 #: ../edit/virt-edit.pod:262
2602 msgid "If and only if the guest is running Windows then:"
2603 msgstr ""
2604
2605 #. type: textblock
2606 #: ../edit/virt-edit.pod:268
2607 msgid ""
2608 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
2609 "to the correct filesystem."
2610 msgstr ""
2611
2612 #. type: textblock
2613 #: ../edit/virt-edit.pod:273
2614 msgid ""
2615 "Any backslash (C<\\>) characters in the path are replaced with forward "
2616 "slashes so that libguestfs can process it."
2617 msgstr ""
2618
2619 #. type: textblock
2620 #: ../edit/virt-edit.pod:278
2621 msgid ""
2622 "The path is resolved case insensitively to locate the file that should be "
2623 "edited."
2624 msgstr ""
2625
2626 #. type: textblock
2627 #: ../edit/virt-edit.pod:283
2628 msgid "There are some known shortcomings:"
2629 msgstr ""
2630
2631 #. type: textblock
2632 #: ../edit/virt-edit.pod:289
2633 msgid "Some NTFS symbolic links may not be followed correctly."
2634 msgstr ""
2635
2636 #. type: textblock
2637 #: ../edit/virt-edit.pod:293
2638 msgid "NTFS junction points that cross filesystems are not followed."
2639 msgstr ""
2640
2641 #. type: textblock
2642 #: ../edit/virt-edit.pod:299
2643 msgid ""
2644 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
2645 "C<virt-edit> doesn't work."
2646 msgstr ""
2647
2648 #. type: textblock
2649 #: ../edit/virt-edit.pod:302
2650 msgid "Using C<virt-edit> is approximately equivalent to doing:"
2651 msgstr ""
2652
2653 #. type: verbatim
2654 #: ../edit/virt-edit.pod:304
2655 #, no-wrap
2656 msgid ""
2657 " guestfish --rw -i -d domname edit /file\n"
2658 "\n"
2659 msgstr ""
2660
2661 #. type: textblock
2662 #: ../edit/virt-edit.pod:306
2663 msgid ""
2664 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
2665 "path to the file."
2666 msgstr ""
2667
2668 #. type: textblock
2669 #: ../edit/virt-edit.pod:309
2670 msgid ""
2671 "The command above uses libguestfs's guest inspection feature and so does not "
2672 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
2673 "disk images that don't contain guests.  To edit a file on a disk image "
2674 "directly, use:"
2675 msgstr ""
2676
2677 #. type: verbatim
2678 #: ../edit/virt-edit.pod:314
2679 #, no-wrap
2680 msgid ""
2681 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
2682 "\n"
2683 msgstr ""
2684
2685 #. type: textblock
2686 #: ../edit/virt-edit.pod:316
2687 msgid ""
2688 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
2689 "the disk image to edit, and C</file> is the full path to the file."
2690 msgstr ""
2691
2692 #. type: textblock
2693 #: ../edit/virt-edit.pod:320
2694 msgid ""
2695 "C<virt-edit> cannot create new files.  Use the guestfish commands C<touch>, "
2696 "C<write> or C<upload> instead:"
2697 msgstr ""
2698
2699 #. type: verbatim
2700 #: ../edit/virt-edit.pod:323
2701 #, no-wrap
2702 msgid ""
2703 " guestfish --rw -i -d domname touch /newfile\n"
2704 "\n"
2705 msgstr ""
2706
2707 #. type: verbatim
2708 #: ../edit/virt-edit.pod:325
2709 #, no-wrap
2710 msgid ""
2711 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
2712 "\n"
2713 msgstr ""
2714
2715 #. type: verbatim
2716 #: ../edit/virt-edit.pod:327
2717 #, no-wrap
2718 msgid ""
2719 " guestfish --rw -i -d domname upload localfile /newfile\n"
2720 "\n"
2721 msgstr ""
2722
2723 #. type: =head1
2724 #: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1086 ../rescue/virt-rescue.pod:261 ../src/guestfs.pod:3103 ../test-tool/libguestfs-test-tool.pod:95
2725 msgid "ENVIRONMENT VARIABLES"
2726 msgstr ""
2727
2728 #. type: =item
2729 #: ../edit/virt-edit.pod:333
2730 msgid "C<EDITOR>"
2731 msgstr ""
2732
2733 #. type: textblock
2734 #: ../edit/virt-edit.pod:335
2735 msgid ""
2736 "If set, this string is used as the editor.  It may contain arguments, "
2737 "eg. C<\"emacs -nw\">"
2738 msgstr ""
2739
2740 #. type: textblock
2741 #: ../edit/virt-edit.pod:338
2742 msgid "If not set, C<vi> is used."
2743 msgstr ""
2744
2745 #. type: textblock
2746 #: ../edit/virt-edit.pod:356
2747 msgid ""
2748 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
2749 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
2750 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
2751 msgstr ""
2752
2753 #. type: textblock
2754 #: ../erlang/examples/guestfs-erlang.pod:5
2755 msgid "guestfs-erlang - How to use libguestfs from Erlang"
2756 msgstr ""
2757
2758 #. type: verbatim
2759 #: ../erlang/examples/guestfs-erlang.pod:9
2760 #, no-wrap
2761 msgid ""
2762 " {ok, G} = guestfs:create(),\n"
2763 " ok = guestfs:add_drive_opts(G, Disk,\n"
2764 "                             [{format, \"raw\"}, {readonly, true}]),\n"
2765 " ok = guestfs:launch(G),\n"
2766 " [Device] = guestfs:list_devices(G),\n"
2767 " ok = guestfs:close(G).\n"
2768 "\n"
2769 msgstr ""
2770
2771 #. type: textblock
2772 #: ../erlang/examples/guestfs-erlang.pod:18
2773 msgid ""
2774 "This manual page documents how to call libguestfs from the Erlang "
2775 "programming language.  This page just documents the differences from the C "
2776 "API and gives some examples.  If you are not familiar with using libguestfs, "
2777 "you also need to read L<guestfs(3)>."
2778 msgstr ""
2779
2780 #. type: =head2
2781 #: ../erlang/examples/guestfs-erlang.pod:23
2782 msgid "OPENING AND CLOSING THE HANDLE"
2783 msgstr ""
2784
2785 #. type: textblock
2786 #: ../erlang/examples/guestfs-erlang.pod:25
2787 msgid ""
2788 "The Erlang bindings are implemented using an external program called "
2789 "C<erl-guestfs>.  This program must be on the current PATH, or else you "
2790 "should specify the full path to the program:"
2791 msgstr ""
2792
2793 #. type: verbatim
2794 #: ../erlang/examples/guestfs-erlang.pod:29
2795 #, no-wrap
2796 msgid ""
2797 " {ok, G} = guestfs:create().\n"
2798 "\n"
2799 msgstr ""
2800
2801 #. type: verbatim
2802 #: ../erlang/examples/guestfs-erlang.pod:31
2803 #, no-wrap
2804 msgid ""
2805 " {ok, G} = guestfs:create(\"/path/to/erl-guestfs\").\n"
2806 "\n"
2807 msgstr ""
2808
2809 #. type: textblock
2810 #: ../erlang/examples/guestfs-erlang.pod:33
2811 msgid "C<G> is the libguestfs handle which you should pass to other functions."
2812 msgstr ""
2813
2814 #. type: textblock
2815 #: ../erlang/examples/guestfs-erlang.pod:36
2816 msgid "To close the handle:"
2817 msgstr ""
2818
2819 #. type: verbatim
2820 #: ../erlang/examples/guestfs-erlang.pod:38
2821 #, no-wrap
2822 msgid ""
2823 " ok = guestfs:close(G).\n"
2824 "\n"
2825 msgstr ""
2826
2827 #. type: =head2
2828 #: ../erlang/examples/guestfs-erlang.pod:40
2829 msgid "FUNCTIONS WITH OPTIONAL ARGUMENTS"
2830 msgstr ""
2831
2832 #. type: textblock
2833 #: ../erlang/examples/guestfs-erlang.pod:42
2834 msgid ""
2835 "For functions that take optional arguments, the first arguments are the "
2836 "non-optional ones.  The last argument is a list of tuples supplying the "
2837 "remaining optional arguments."
2838 msgstr ""
2839
2840 #. type: verbatim
2841 #: ../erlang/examples/guestfs-erlang.pod:46
2842 #, no-wrap
2843 msgid ""
2844 " ok = guestfs:add_drive_opts(G, Disk,\n"
2845 "                             [{format, \"raw\"}, {readonly, true}]).\n"
2846 "\n"
2847 msgstr ""
2848
2849 #. type: textblock
2850 #: ../erlang/examples/guestfs-erlang.pod:49
2851 msgid "If the last argument would be an empty list, you can also omit it:"
2852 msgstr ""
2853
2854 #. type: verbatim
2855 #: ../erlang/examples/guestfs-erlang.pod:51
2856 #, no-wrap
2857 msgid ""
2858 " ok = guestfs:add_drive_opts(G, Disk).\n"
2859 "\n"
2860 msgstr ""
2861
2862 #. type: =head2
2863 #: ../erlang/examples/guestfs-erlang.pod:53
2864 msgid "RETURN VALUES AND ERRORS"
2865 msgstr ""
2866
2867 #. type: textblock
2868 #: ../erlang/examples/guestfs-erlang.pod:55
2869 msgid ""
2870 "On success, most functions return a C<Result> term (which could be a list, "
2871 "string, tuple etc.).  If there is nothing for the function to return, then "
2872 "the atom C<ok> is returned."
2873 msgstr ""
2874
2875 #. type: textblock
2876 #: ../erlang/examples/guestfs-erlang.pod:59
2877 msgid "On error, you would see one of the following tuples:"
2878 msgstr ""
2879
2880 #. type: =item
2881 #: ../erlang/examples/guestfs-erlang.pod:63
2882 msgid "C<{error, Msg, Errno}>"
2883 msgstr ""
2884
2885 #. type: textblock
2886 #: ../erlang/examples/guestfs-erlang.pod:65
2887 msgid "This indicates an ordinary error from the function."
2888 msgstr ""
2889
2890 #. type: textblock
2891 #: ../erlang/examples/guestfs-erlang.pod:67
2892 msgid ""
2893 "C<Msg> is the error message (string) and C<Errno> is the Unix error "
2894 "(integer)."
2895 msgstr ""
2896
2897 #. type: textblock
2898 #: ../erlang/examples/guestfs-erlang.pod:70
2899 msgid "C<Errno> can be zero.  See L<guestfs(3)/guestfs_last_errno>."
2900 msgstr ""
2901
2902 #. type: =item
2903 #: ../erlang/examples/guestfs-erlang.pod:72
2904 msgid "C<{unknown, Function}>"
2905 msgstr ""
2906
2907 #. type: textblock
2908 #: ../erlang/examples/guestfs-erlang.pod:74
2909 msgid ""
2910 "This indicates that the function you called is not known.  Generally this "
2911 "means you are mixing C<erl-guestfs> from another version of libguestfs, "
2912 "which you should not do."
2913 msgstr ""
2914
2915 #. type: textblock
2916 #: ../erlang/examples/guestfs-erlang.pod:78
2917 msgid "C<Function> is the name of the unknown function."
2918 msgstr ""
2919
2920 #. type: =item
2921 #: ../erlang/examples/guestfs-erlang.pod:80
2922 msgid "C<{unknownarg, Arg}>"
2923 msgstr ""
2924
2925 #. type: textblock
2926 #: ../erlang/examples/guestfs-erlang.pod:82
2927 msgid ""
2928 "This indicates that you called a function with optional arguments, with an "
2929 "unknown argument name."
2930 msgstr ""
2931
2932 #. type: textblock
2933 #: ../erlang/examples/guestfs-erlang.pod:85
2934 msgid "C<Arg> is the name of the unknown argument."
2935 msgstr ""
2936
2937 #. type: =head1
2938 #: ../erlang/examples/guestfs-erlang.pod:89 ../examples/guestfs-examples.pod:25 ../java/examples/guestfs-java.pod:37 ../ocaml/examples/guestfs-ocaml.pod:70 ../perl/examples/guestfs-perl.pod:31 ../python/examples/guestfs-python.pod:34 ../ruby/examples/guestfs-ruby.pod:28
2939 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
2940 msgstr ""
2941
2942 #. type: textblock
2943 #: ../erlang/examples/guestfs-erlang.pod:91 ../examples/guestfs-examples.pod:27 ../java/examples/guestfs-java.pod:39 ../ocaml/examples/guestfs-ocaml.pod:72 ../perl/examples/guestfs-perl.pod:33 ../python/examples/guestfs-python.pod:36 ../ruby/examples/guestfs-ruby.pod:30
2944 msgid "@EXAMPLE1@"
2945 msgstr ""
2946
2947 #. type: =head1
2948 #: ../erlang/examples/guestfs-erlang.pod:93 ../examples/guestfs-examples.pod:29 ../java/examples/guestfs-java.pod:41 ../ocaml/examples/guestfs-ocaml.pod:74 ../perl/examples/guestfs-perl.pod:35 ../python/examples/guestfs-python.pod:38 ../ruby/examples/guestfs-ruby.pod:32
2949 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
2950 msgstr ""
2951
2952 #. type: textblock
2953 #: ../erlang/examples/guestfs-erlang.pod:95 ../examples/guestfs-examples.pod:31 ../java/examples/guestfs-java.pod:43 ../ocaml/examples/guestfs-ocaml.pod:76 ../perl/examples/guestfs-perl.pod:37 ../python/examples/guestfs-python.pod:40 ../ruby/examples/guestfs-ruby.pod:34
2954 msgid "@EXAMPLE2@"
2955 msgstr ""
2956
2957 #. type: textblock
2958 #: ../erlang/examples/guestfs-erlang.pod:99
2959 msgid ""
2960 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
2961 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
2962 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://www.erlang.org/>.  "
2963 "L<http://libguestfs.org/>."
2964 msgstr ""
2965
2966 #. type: =head1
2967 #: ../erlang/examples/guestfs-erlang.pod:110 ../examples/guestfs-examples.pod:45 ../examples/guestfs-recipes.pod:397 ../fish/guestfish.pod:1260 ../fish/virt-copy-in.pod:60 ../fish/virt-copy-out.pod:49 ../fish/virt-tar-in.pod:58 ../fish/virt-tar-out.pod:51 ../fuse/guestmount.pod:319 ../inspector/virt-inspector.pod:389 ../java/examples/guestfs-java.pod:58 ../ocaml/examples/guestfs-ocaml.pod:91 ../perl/examples/guestfs-perl.pod:52 ../python/examples/guestfs-python.pod:54 ../ruby/examples/guestfs-ruby.pod:48 ../src/guestfs.pod:3237 ../test-tool/libguestfs-test-tool.pod:106
2968 msgid "AUTHORS"
2969 msgstr ""
2970
2971 #. type: textblock
2972 #: ../erlang/examples/guestfs-erlang.pod:112 ../examples/guestfs-examples.pod:47 ../examples/guestfs-recipes.pod:399 ../fish/guestfish.pod:1262 ../fish/virt-copy-in.pod:62 ../fish/virt-copy-out.pod:51 ../fish/virt-tar-in.pod:60 ../fish/virt-tar-out.pod:53 ../fuse/guestmount.pod:321 ../java/examples/guestfs-java.pod:60 ../ocaml/examples/guestfs-ocaml.pod:93 ../perl/examples/guestfs-perl.pod:54 ../python/examples/guestfs-python.pod:56 ../ruby/examples/guestfs-ruby.pod:50 ../src/guestfs.pod:3239 ../test-tool/libguestfs-test-tool.pod:108
2973 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
2974 msgstr ""
2975
2976 #. type: textblock
2977 #: ../erlang/examples/guestfs-erlang.pod:116 ../java/examples/guestfs-java.pod:64 ../perl/examples/guestfs-perl.pod:58
2978 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
2979 msgstr ""
2980
2981 #. type: textblock
2982 #: ../erlang/examples/guestfs-erlang.pod:118 ../examples/guestfs-examples.pod:53 ../examples/guestfs-recipes.pod:405 ../java/examples/guestfs-java.pod:66 ../ocaml/examples/guestfs-ocaml.pod:99 ../perl/examples/guestfs-perl.pod:60 ../python/examples/guestfs-python.pod:62 ../ruby/examples/guestfs-ruby.pod:56
2983 msgid ""
2984 "The examples in this manual page may be freely copied, modified and "
2985 "distributed without any restrictions."
2986 msgstr ""
2987
2988 #. type: textblock
2989 #: ../erlang/examples/guestfs-erlang.pod:121 ../examples/guestfs-examples.pod:56 ../examples/guestfs-recipes.pod:408 ../java/examples/guestfs-java.pod:69 ../ocaml/examples/guestfs-ocaml.pod:102 ../perl/examples/guestfs-perl.pod:63 ../python/examples/guestfs-python.pod:65 ../ruby/examples/guestfs-ruby.pod:59 ../src/guestfs.pod:3246
2990 msgid ""
2991 "This library is free software; you can redistribute it and/or modify it "
2992 "under the terms of the GNU Lesser General Public License as published by the "
2993 "Free Software Foundation; either version 2 of the License, or (at your "
2994 "option) any later version."
2995 msgstr ""
2996
2997 #. type: textblock
2998 #: ../erlang/examples/guestfs-erlang.pod:126 ../examples/guestfs-examples.pod:61 ../examples/guestfs-recipes.pod:413 ../java/examples/guestfs-java.pod:74 ../ocaml/examples/guestfs-ocaml.pod:107 ../perl/examples/guestfs-perl.pod:68 ../python/examples/guestfs-python.pod:70 ../ruby/examples/guestfs-ruby.pod:64 ../src/guestfs.pod:3251
2999 msgid ""
3000 "This library is distributed in the hope that it will be useful, but WITHOUT "
3001 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3002 "FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License "
3003 "for more details."
3004 msgstr ""
3005
3006 #. type: textblock
3007 #: ../erlang/examples/guestfs-erlang.pod:131 ../examples/guestfs-examples.pod:66 ../examples/guestfs-recipes.pod:418 ../java/examples/guestfs-java.pod:79 ../ocaml/examples/guestfs-ocaml.pod:112 ../perl/examples/guestfs-perl.pod:73 ../python/examples/guestfs-python.pod:75 ../ruby/examples/guestfs-ruby.pod:69 ../src/guestfs.pod:3256
3008 msgid ""
3009 "You should have received a copy of the GNU Lesser General Public License "
3010 "along with this library; if not, write to the Free Software Foundation, "
3011 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3012 msgstr ""
3013
3014 #. type: textblock
3015 #: ../examples/guestfs-examples.pod:5
3016 msgid "guestfs-examples - Examples of using libguestfs from C"
3017 msgstr ""
3018
3019 #. type: verbatim
3020 #: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9
3021 #, no-wrap
3022 msgid ""
3023 " #include <guestfs.h>\n"
3024 " \n"
3025 msgstr ""
3026
3027 #. type: verbatim
3028 #: ../examples/guestfs-examples.pod:11
3029 #, no-wrap
3030 msgid ""
3031 " guestfs_h *g = guestfs_create ();\n"
3032 " guestfs_add_drive_ro (g, \"disk.img\");\n"
3033 " guestfs_launch (g);\n"
3034 "\n"
3035 msgstr ""
3036
3037 #. type: verbatim
3038 #: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19
3039 #, no-wrap
3040 msgid ""
3041 " cc prog.c -o prog -lguestfs\n"
3042 "or:\n"
3043 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
3044 "\n"
3045 msgstr ""
3046
3047 #. type: textblock
3048 #: ../examples/guestfs-examples.pod:21
3049 msgid ""
3050 "This manual page contains examples of calling libguestfs from the C "
3051 "programming language.  If you are not familiar with using libguestfs, you "
3052 "also need to read L<guestfs(3)>."
3053 msgstr ""
3054
3055 #. type: textblock
3056 #: ../examples/guestfs-examples.pod:35
3057 msgid ""
3058 "L<guestfs(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, "
3059 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
3060 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
3061 msgstr ""
3062
3063 #. type: textblock
3064 #: ../examples/guestfs-examples.pod:51 ../ocaml/examples/guestfs-ocaml.pod:97 ../python/examples/guestfs-python.pod:60 ../ruby/examples/guestfs-ruby.pod:54
3065 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
3066 msgstr ""
3067
3068 #. type: =end
3069 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
3070 msgid "comment"
3071 msgstr ""
3072
3073 #. type: textblock
3074 #: ../examples/guestfs-recipes.pod:5
3075 msgid ""
3076 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
3077 "here.  The only way which works for both sorts of output is to just write "
3078 "the URL directly.  Do NOT use L<...> for URLs."
3079 msgstr ""
3080
3081 #. type: textblock
3082 #: ../examples/guestfs-recipes.pod:9
3083 msgid ""
3084 "We break with tradition here and don't use ALL CAPS for the section "
3085 "headings, as this makes them much easier to read."
3086 msgstr ""
3087
3088 #. type: textblock
3089 #: ../examples/guestfs-recipes.pod:16
3090 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
3091 msgstr ""
3092
3093 #. type: textblock
3094 #: ../examples/guestfs-recipes.pod:20
3095 msgid ""
3096 "This page contains recipes for and links to things you can do using "
3097 "libguestfs, L<guestfish(1)> and the virt tools."
3098 msgstr ""
3099
3100 #. type: =head1
3101 #: ../examples/guestfs-recipes.pod:23
3102 msgid "Audit a virtual machine for setuid files"
3103 msgstr ""
3104
3105 #. type: textblock
3106 #: ../examples/guestfs-recipes.pod:25
3107 msgid ""
3108 "The link below contains a small program which can be used to audit a Linux "
3109 "virtual machine to see what setuid and setgid files it contains."
3110 msgstr ""
3111
3112 #. type: textblock
3113 #: ../examples/guestfs-recipes.pod:28
3114 msgid "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-files/#content"
3115 msgstr ""
3116
3117 #. type: =head1
3118 #: ../examples/guestfs-recipes.pod:30
3119 msgid "Change the background image in a Windows XP VM"
3120 msgstr ""
3121
3122 #. type: textblock
3123 #: ../examples/guestfs-recipes.pod:32
3124 msgid ""
3125 "The links below explain how to use L<guestfish(1)> to change the background "
3126 "image for a user of a Windows XP VM.  Unfortunately the technique appears to "
3127 "be substantially different for each version of Windows."
3128 msgstr ""
3129
3130 #. type: textblock
3131 #: ../examples/guestfs-recipes.pod:37
3132 msgid ""
3133 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html "
3134 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
3135 msgstr ""
3136
3137 #. type: =head1
3138 #: ../examples/guestfs-recipes.pod:40
3139 msgid "Cloning a virtual machine (Linux)"
3140 msgstr ""
3141
3142 #. type: textblock
3143 #: ../examples/guestfs-recipes.pod:42
3144 msgid ""
3145 "The guestfish technique described in the link below works well for most "
3146 "Linux VMs.  Depending on the Linux distro you may need to change the paths "
3147 "slightly."
3148 msgstr ""
3149
3150 #. type: textblock
3151 #: ../examples/guestfs-recipes.pod:46
3152 msgid "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-vm/#content"
3153 msgstr ""
3154
3155 #. type: textblock
3156 #: ../examples/guestfs-recipes.pod:48
3157 msgid ""
3158 "Avoid L<virt-clone(1)>.  Currently what to do about virt-clone is under "
3159 "discussion."
3160 msgstr ""
3161
3162 #. type: textblock
3163 #: ../examples/guestfs-recipes.pod:51
3164 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
3165 msgstr ""
3166
3167 #. type: =head1
3168 #: ../examples/guestfs-recipes.pod:53
3169 msgid "Cloning a virtual machine (Windows)"
3170 msgstr ""
3171
3172 #. type: textblock
3173 #: ../examples/guestfs-recipes.pod:55
3174 msgid ""
3175 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
3176 "straightforward.  Currently there is code in the Aeolus Oz project which "
3177 "does this (using libguestfs).  As part of our review of the virt-clone tool, "
3178 "we may add sysprepping ability."
3179 msgstr ""
3180
3181 #. type: textblock
3182 #: ../examples/guestfs-recipes.pod:60
3183 msgid ""
3184 "https://github.com/clalancette/oz "
3185 "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
3186 msgstr ""
3187
3188 #. type: =head1
3189 #: ../examples/guestfs-recipes.pod:63
3190 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
3191 msgstr ""
3192
3193 #. type: textblock
3194 #: ../examples/guestfs-recipes.pod:65
3195 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
3196 msgstr ""
3197
3198 #. type: verbatim
3199 #: ../examples/guestfs-recipes.pod:67
3200 #, no-wrap
3201 msgid ""
3202 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
3203 "\n"
3204 msgstr ""
3205
3206 #. type: textblock
3207 #: ../examples/guestfs-recipes.pod:69
3208 msgid "To export just a subdirectory, eg. C</files>, do:"
3209 msgstr ""
3210
3211 #. type: verbatim
3212 #: ../examples/guestfs-recipes.pod:71
3213 #, no-wrap
3214 msgid ""
3215 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
3216 "\n"
3217 msgstr ""
3218
3219 #. type: =head1
3220 #: ../examples/guestfs-recipes.pod:73
3221 msgid "Create empty disk images"
3222 msgstr ""
3223
3224 #. type: textblock
3225 #: ../examples/guestfs-recipes.pod:75
3226 msgid ""
3227 "You can use the L<guestfish(1)> I<-N> option to create empty disk images.  "
3228 "The useful guide below explains the options available."
3229 msgstr ""
3230
3231 #. type: textblock
3232 #: ../examples/guestfs-recipes.pod:78
3233 msgid "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/#content"
3234 msgstr ""
3235
3236 #. type: =head1
3237 #: ../examples/guestfs-recipes.pod:80
3238 msgid "Dump raw filesystem content from inside a disk image or VM"
3239 msgstr ""
3240
3241 #. type: textblock
3242 #: ../examples/guestfs-recipes.pod:82
3243 msgid ""
3244 "You can use the L<guestfish(1)> C<download> command to extract the raw "
3245 "filesystem content from any filesystem in a disk image or a VM (even one "
3246 "which is encrypted or buried inside an LV):"
3247 msgstr ""
3248
3249 #. type: verbatim
3250 #: ../examples/guestfs-recipes.pod:86
3251 #, no-wrap
3252 msgid ""
3253 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
3254 "\n"
3255 msgstr ""
3256
3257 #. type: verbatim
3258 #: ../examples/guestfs-recipes.pod:88
3259 #, no-wrap
3260 msgid ""
3261 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
3262 "\n"
3263 msgstr ""
3264
3265 #. type: textblock
3266 #: ../examples/guestfs-recipes.pod:90
3267 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
3268 msgstr ""
3269
3270 #. type: =head1
3271 #: ../examples/guestfs-recipes.pod:92
3272 msgid "Edit grub configuration in a VM"
3273 msgstr ""
3274
3275 #. type: textblock
3276 #: ../examples/guestfs-recipes.pod:94
3277 msgid "You can use this to:"
3278 msgstr ""
3279
3280 #. type: textblock
3281 #: ../examples/guestfs-recipes.pod:100
3282 msgid "Fix a virtual machine that does not boot."
3283 msgstr ""
3284
3285 #. type: textblock
3286 #: ../examples/guestfs-recipes.pod:104
3287 msgid "Change which kernel is used to boot the VM."
3288 msgstr ""
3289
3290 #. type: textblock
3291 #: ../examples/guestfs-recipes.pod:108
3292 msgid "Change kernel command line options."
3293 msgstr ""
3294
3295 #. type: textblock
3296 #: ../examples/guestfs-recipes.pod:112
3297 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
3298 msgstr ""
3299
3300 #. type: verbatim
3301 #: ../examples/guestfs-recipes.pod:114
3302 #, no-wrap
3303 msgid ""
3304 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
3305 "\n"
3306 msgstr ""
3307
3308 #. type: textblock
3309 #: ../examples/guestfs-recipes.pod:116
3310 msgid ""
3311 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
3312 "this:"
3313 msgstr ""
3314
3315 #. type: verbatim
3316 #: ../examples/guestfs-recipes.pod:119
3317 #, no-wrap
3318 msgid ""
3319 " virt-rescue -d BrokenGuest\n"
3320 "\n"
3321 msgstr ""
3322
3323 #. type: =head1
3324 #: ../examples/guestfs-recipes.pod:121
3325 msgid "Export any directory from a VM"
3326 msgstr ""
3327
3328 #. type: textblock
3329 #: ../examples/guestfs-recipes.pod:123
3330 msgid "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
3331 msgstr ""
3332
3333 #. type: verbatim
3334 #: ../examples/guestfs-recipes.pod:126
3335 #, no-wrap
3336 msgid ""
3337 " virt-copy-out -d Guest /home .\n"
3338 "\n"
3339 msgstr ""
3340
3341 #. type: textblock
3342 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1327 ../fish/guestfish-actions.pod:1592 ../fish/guestfish-actions.pod:2001 ../src/guestfs-actions.pod:18 ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2451 ../src/guestfs-actions.pod:3002 ../src/guestfs.pod:1667 ../tools/virt-win-reg.pl:706
3343 msgid "Notes:"
3344 msgstr ""
3345
3346 #. type: textblock
3347 #: ../examples/guestfs-recipes.pod:134
3348 msgid ""
3349 "The final dot of the command is not a printing error.  It means we want to "
3350 "copy out to the current directory."
3351 msgstr ""
3352
3353 #. type: textblock
3354 #: ../examples/guestfs-recipes.pod:139
3355 msgid "This creates a directory called C<home> under the current directory."
3356 msgstr ""
3357
3358 #. type: textblock
3359 #: ../examples/guestfs-recipes.pod:143
3360 msgid ""
3361 "If the guest is a Windows guest then you can use drive letters and "
3362 "backslashes, but you must prefix the path with C<win:> and quote it to "
3363 "protect it from the shell, like this:"
3364 msgstr ""
3365
3366 #. type: verbatim
3367 #: ../examples/guestfs-recipes.pod:147
3368 #, no-wrap
3369 msgid ""
3370 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
3371 "\n"
3372 msgstr ""
3373
3374 #. type: textblock
3375 #: ../examples/guestfs-recipes.pod:149
3376 msgid "To get the output as a compressed tarball, do:"
3377 msgstr ""
3378
3379 #. type: verbatim
3380 #: ../examples/guestfs-recipes.pod:151
3381 #, no-wrap
3382 msgid ""
3383 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
3384 "\n"
3385 msgstr ""
3386
3387 #. type: textblock
3388 #: ../examples/guestfs-recipes.pod:153
3389 msgid ""
3390 "Although it sounds tempting, this is usually not a reliable way to get a "
3391 "backup from a running guest.  See the entry in the FAQ: "
3392 "http://libguestfs.org/FAQ.html#backup"
3393 msgstr ""
3394
3395 #. type: =head1
3396 #: ../examples/guestfs-recipes.pod:157
3397 msgid "Find out which user is using the most space"
3398 msgstr ""
3399
3400 #. type: textblock
3401 #: ../examples/guestfs-recipes.pod:159
3402 msgid ""
3403 "This simple script examines a Linux guest to find out which user is using "
3404 "the most space in their home directory:"
3405 msgstr ""
3406
3407 #. type: verbatim
3408 #: ../examples/guestfs-recipes.pod:162
3409 #, no-wrap
3410 msgid ""
3411 " #!/bin/sh -\n"
3412 " \n"
3413 msgstr ""
3414
3415 #. type: verbatim
3416 #: ../examples/guestfs-recipes.pod:164
3417 #, no-wrap
3418 msgid ""
3419 " set -e\n"
3420 " \n"
3421 msgstr ""
3422
3423 #. type: verbatim
3424 #: ../examples/guestfs-recipes.pod:166
3425 #, no-wrap
3426 msgid ""
3427 " vm=\"$1\"\n"
3428 " dir=/home\n"
3429 " \n"
3430 msgstr ""
3431
3432 #. type: verbatim
3433 #: ../examples/guestfs-recipes.pod:169
3434 #, no-wrap
3435 msgid ""
3436 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
3437 " \n"
3438 msgstr ""
3439
3440 #. type: verbatim
3441 #: ../examples/guestfs-recipes.pod:171
3442 #, no-wrap
3443 msgid ""
3444 " for d in $(guestfish --remote ls \"$dir\"); do\n"
3445 "     echo -n \"$dir/$d\"\n"
3446 "     echo -ne '\\t'\n"
3447 "     guestfish --remote du \"$dir/$d\";\n"
3448 " done | sort -nr -k 2\n"
3449 " \n"
3450 msgstr ""
3451
3452 #. type: verbatim
3453 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
3454 #, no-wrap
3455 msgid ""
3456 " guestfish --remote exit\n"
3457 "\n"
3458 msgstr ""
3459
3460 #. type: =head1
3461 #: ../examples/guestfs-recipes.pod:179
3462 msgid "Get DHCP address from a VM"
3463 msgstr ""
3464
3465 #. type: textblock
3466 #: ../examples/guestfs-recipes.pod:181
3467 msgid ""
3468 "The link below explains the many different possible techniques for getting "
3469 "the last assigned DHCP address of a virtual machine."
3470 msgstr ""
3471
3472 #. type: textblock
3473 #: ../examples/guestfs-recipes.pod:184
3474 msgid "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-a-virtual-machine-disk-image/#content"
3475 msgstr ""
3476
3477 #. type: textblock
3478 #: ../examples/guestfs-recipes.pod:186
3479 msgid ""
3480 "In the libguestfs source examples directory you will find the latest version "
3481 "of the C<virt-dhcp-address.c> program."
3482 msgstr ""
3483
3484 #. type: =head1
3485 #: ../examples/guestfs-recipes.pod:189
3486 msgid "Get the operating system product name string"
3487 msgstr ""
3488
3489 #. type: textblock
3490 #: ../examples/guestfs-recipes.pod:191
3491 msgid "Save the following script into a file called C<product-name.sh>:"
3492 msgstr ""
3493
3494 #. type: verbatim
3495 #: ../examples/guestfs-recipes.pod:193
3496 #, no-wrap
3497 msgid ""
3498 " #!/bin/sh -\n"
3499 " set -e\n"
3500 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3501 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3502 " guestfish --remote inspect-get-product-name \"$root\"\n"
3503 " guestfish --remote exit\n"
3504 "\n"
3505 msgstr ""
3506
3507 #. type: textblock
3508 #: ../examples/guestfs-recipes.pod:200
3509 msgid "Make the script executable and run it on a named guest:"
3510 msgstr ""
3511
3512 #. type: verbatim
3513 #: ../examples/guestfs-recipes.pod:202
3514 #, no-wrap
3515 msgid ""
3516 " # product-name.sh RHEL60x64\n"
3517 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
3518 "\n"
3519 msgstr ""
3520
3521 #. type: textblock
3522 #: ../examples/guestfs-recipes.pod:205
3523 msgid ""
3524 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
3525 "C<xpath> command line tool or from your favourite programming language:"
3526 msgstr ""
3527
3528 #. type: verbatim
3529 #: ../examples/guestfs-recipes.pod:209
3530 #, no-wrap
3531 msgid ""
3532 " # virt-inspector RHEL60x64 > xml\n"
3533 " # xpath '//product_name' < xml\n"
3534 " Found 1 nodes:\n"
3535 " -- NODE --\n"
3536 " <product_name>Red Hat Enterprise Linux Server release 6.0 "
3537 "(Santiago)</product_name>\n"
3538 "\n"
3539 msgstr ""
3540
3541 #. type: =head1
3542 #: ../examples/guestfs-recipes.pod:215
3543 msgid "Get the default boot kernel for a Linux VM"
3544 msgstr ""
3545
3546 #. type: textblock
3547 #: ../examples/guestfs-recipes.pod:217
3548 msgid ""
3549 "The link below contains a program to print the default boot kernel for a "
3550 "Linux VM."
3551 msgstr ""
3552
3553 #. type: textblock
3554 #: ../examples/guestfs-recipes.pod:220
3555 msgid "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-kernel-for-a-vm/#content"
3556 msgstr ""
3557
3558 #. type: textblock
3559 #: ../examples/guestfs-recipes.pod:222
3560 msgid ""
3561 "It uses Augeas, and the technique is generally applicable for many different "
3562 "tasks, such as:"
3563 msgstr ""
3564
3565 #. type: textblock
3566 #: ../examples/guestfs-recipes.pod:229
3567 msgid "listing the user accounts in the guest"
3568 msgstr ""
3569
3570 #. type: textblock
3571 #: ../examples/guestfs-recipes.pod:233
3572 msgid "what repositories is it configured to use"
3573 msgstr ""
3574
3575 #. type: textblock
3576 #: ../examples/guestfs-recipes.pod:237
3577 msgid "what NTP servers does it connect to"
3578 msgstr ""
3579
3580 #. type: textblock
3581 #: ../examples/guestfs-recipes.pod:241
3582 msgid "what were the boot messages last time it booted"
3583 msgstr ""
3584
3585 #. type: textblock
3586 #: ../examples/guestfs-recipes.pod:245
3587 msgid "listing who was logged in recently"
3588 msgstr ""
3589
3590 #. type: textblock
3591 #: ../examples/guestfs-recipes.pod:249
3592 msgid "http://augeas.net/"
3593 msgstr ""
3594
3595 #. type: =head1
3596 #: ../examples/guestfs-recipes.pod:251
3597 msgid "Install RPMs in a guest"
3598 msgstr ""
3599
3600 #. type: textblock
3601 #: ../examples/guestfs-recipes.pod:253
3602 msgid ""
3603 "The link below contains a method to install RPMs in a guest.  In fact the "
3604 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
3605 "installs them next time the guest is booted.  You could use this technique "
3606 "to install vital security updates in an offline guest."
3607 msgstr ""
3608
3609 #. type: textblock
3610 #: ../examples/guestfs-recipes.pod:259
3611 msgid "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
3612 msgstr ""
3613
3614 #. type: =head1
3615 #: ../examples/guestfs-recipes.pod:261
3616 msgid "List applications installed in a VM"
3617 msgstr ""
3618
3619 #. type: textblock
3620 #: ../examples/guestfs-recipes.pod:263
3621 msgid "Save the following to a file C<list-apps.sh>:"
3622 msgstr ""
3623
3624 #. type: verbatim
3625 #: ../examples/guestfs-recipes.pod:265
3626 #, no-wrap
3627 msgid ""
3628 " #!/bin/sh -\n"
3629 " set -e\n"
3630 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3631 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3632 " guestfish --remote inspect-list-applications \"$root\"\n"
3633 " guestfish --remote exit\n"
3634 "\n"
3635 msgstr ""
3636
3637 #. type: textblock
3638 #: ../examples/guestfs-recipes.pod:272
3639 msgid ""
3640 "Make the file executable and then you can run it on any named virtual "
3641 "machine:"
3642 msgstr ""
3643
3644 #. type: verbatim
3645 #: ../examples/guestfs-recipes.pod:275
3646 #, no-wrap
3647 msgid ""
3648 " # list-apps.sh WinGuest\n"
3649 " [0] = {\n"
3650 "   app_name: Mozilla Firefox (3.6.12)\n"
3651 "   app_display_name: Mozilla Firefox (3.6.12)\n"
3652 "   app_epoch: 0\n"
3653 "   app_version: 3.6.12 (en-GB)\n"
3654 "   app_release:\n"
3655 "   app_install_path: C:\\Program Files\\Mozilla Firefox\n"
3656 "   app_trans_path:\n"
3657 "   app_publisher: Mozilla\n"
3658 "   app_url: http://www.mozilla.com/en-GB/\n"
3659 "   app_source_package:\n"
3660 "   app_summary:\n"
3661 "   app_description: Mozilla Firefox\n"
3662 " }\n"
3663 " [1] = {\n"
3664 "   app_name: VLC media player\n"
3665 "   app_display_name: VLC media player 1.1.5\n"
3666 "   app_epoch: 0\n"
3667 "   app_version: 1.1.5\n"
3668 "   app_release:\n"
3669 "   app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
3670 "   app_trans_path:\n"
3671 "   app_publisher: VideoLAN\n"
3672 "   app_url: http://www.videolan.org/\n"
3673 "   app_source_package:\n"
3674 "   app_summary:\n"
3675 "   app_description:\n"
3676 " }\n"
3677 "\n"
3678 msgstr ""
3679
3680 #. type: textblock
3681 #: ../examples/guestfs-recipes.pod:305
3682 msgid ""
3683 "If you want to run the script on disk images (instead of libvirt virtual "
3684 "machines), change C<-d \"$1\"> to C<-a \"$1\">.  See also "
3685 "L<virt-inspector(1)>."
3686 msgstr ""
3687
3688 #. type: =head1
3689 #: ../examples/guestfs-recipes.pod:309
3690 msgid "List files and directories in a VM"
3691 msgstr ""
3692
3693 #. type: textblock
3694 #: ../examples/guestfs-recipes.pod:311
3695 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
3696 msgstr ""
3697
3698 #. type: verbatim
3699 #: ../examples/guestfs-recipes.pod:313
3700 #, no-wrap
3701 msgid ""
3702 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
3703 "\n"
3704 msgstr ""
3705
3706 #. type: =head1
3707 #: ../examples/guestfs-recipes.pod:315
3708 msgid "List services in a Windows VM"
3709 msgstr ""
3710
3711 #. type: textblock
3712 #: ../examples/guestfs-recipes.pod:317
3713 msgid ""
3714 "The link below contains a script that can be used to list out the services "
3715 "from a Windows VM, and whether those services run at boot time or are loaded "
3716 "on demand."
3717 msgstr ""
3718
3719 #. type: textblock
3720 #: ../examples/guestfs-recipes.pod:321
3721 msgid "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/#content"
3722 msgstr ""
3723
3724 #. type: =head1
3725 #: ../examples/guestfs-recipes.pod:323
3726 msgid "Make a disk image sparse"
3727 msgstr ""
3728
3729 #. type: textblock
3730 #: ../examples/guestfs-recipes.pod:325
3731 msgid ""
3732 "The link below contains some guides for making a disk image sparse (or "
3733 "reintroducing sparseness)."
3734 msgstr ""
3735
3736 #. type: textblock
3737 #: ../examples/guestfs-recipes.pod:328
3738 msgid "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
3739 msgstr ""
3740
3741 #. type: =head1
3742 #: ../examples/guestfs-recipes.pod:330
3743 msgid "Monitor disk usage over time"
3744 msgstr ""
3745
3746 #. type: textblock
3747 #: ../examples/guestfs-recipes.pod:332
3748 msgid ""
3749 "You can use L<virt-df(1)> to monitor disk usage of your guests over time.  "
3750 "The link below contains a guide."
3751 msgstr ""
3752
3753 #. type: textblock
3754 #: ../examples/guestfs-recipes.pod:335
3755 msgid "http://virt-tools.org/learning/advanced-virt-df/"
3756 msgstr ""
3757
3758 #. type: =head1
3759 #: ../examples/guestfs-recipes.pod:337
3760 msgid "Reading the Windows Event Log from Windows Vista (or later)"
3761 msgstr ""
3762
3763 #. type: textblock
3764 #: ../examples/guestfs-recipes.pod:339
3765 msgid ""
3766 "L<guestfish(1)> plus the tools described in the link below can be used to "
3767 "read out the Windows Event Log from any virtual machine running Windows "
3768 "Vista or a later version."
3769 msgstr ""
3770
3771 #. type: textblock
3772 #: ../examples/guestfs-recipes.pod:343
3773 msgid "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-guestfish/#content"
3774 msgstr ""
3775
3776 #. type: =head1
3777 #: ../examples/guestfs-recipes.pod:345
3778 msgid "Remove root password (Linux)"
3779 msgstr ""
3780
3781 #. type: textblock
3782 #: ../examples/guestfs-recipes.pod:347
3783 msgid ""
3784 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
3785 "files.  One use is to remove the root password from a Linux guest:"
3786 msgstr ""
3787
3788 #. type: verbatim
3789 #: ../examples/guestfs-recipes.pod:350
3790 #, no-wrap
3791 msgid ""
3792 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
3793 "\n"
3794 msgstr ""
3795
3796 #. type: =head1
3797 #: ../examples/guestfs-recipes.pod:352
3798 msgid "Remove Administrator password (Windows)"
3799 msgstr ""
3800
3801 #. type: textblock
3802 #: ../examples/guestfs-recipes.pod:354
3803 msgid ""
3804 "The link below contains one technique for removing the Administrator "
3805 "password from a Windows VM, or to be more precise, it gives you a command "
3806 "prompt the next time you log in which you can use to bypass any security:"
3807 msgstr ""
3808
3809 #. type: textblock
3810 #: ../examples/guestfs-recipes.pod:359
3811 msgid "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-administrator-password-with-guestfish/"
3812 msgstr ""
3813
3814 #. type: =head1
3815 #: ../examples/guestfs-recipes.pod:361
3816 msgid "Unpack a live CD"
3817 msgstr ""
3818
3819 #. type: textblock
3820 #: ../examples/guestfs-recipes.pod:363
3821 msgid ""
3822 "Linux live CDs often contain multiple layers of disk images wrapped like a "
3823 "Russian doll.  You can use L<guestfish(1)> to look inside these multiple "
3824 "layers, as outlined in the guide below."
3825 msgstr ""
3826
3827 #. type: textblock
3828 #: ../examples/guestfs-recipes.pod:367
3829 msgid "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-cd/#content"
3830 msgstr ""
3831
3832 #. type: =head1
3833 #: ../examples/guestfs-recipes.pod:369
3834 msgid "Uploading and downloading files"
3835 msgstr ""
3836
3837 #. type: textblock
3838 #: ../examples/guestfs-recipes.pod:371
3839 msgid ""
3840 "The link below contains general tips on uploading (copying in)  and "
3841 "downloading (copying out) files from VMs."
3842 msgstr ""
3843
3844 #. type: textblock
3845 #: ../examples/guestfs-recipes.pod:374
3846 msgid "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
3847 msgstr ""
3848
3849 #. type: =head1
3850 #: ../examples/guestfs-recipes.pod:376
3851 msgid "Use libguestfs tools on VMware ESX guests"
3852 msgstr ""
3853
3854 #. type: textblock
3855 #: ../examples/guestfs-recipes.pod:378
3856 msgid ""
3857 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
3858 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
3859 msgstr ""
3860
3861 #. type: textblock
3862 #: ../examples/guestfs-recipes.pod:382
3863 msgid "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-guests/#content"
3864 msgstr ""
3865
3866 #. type: textblock
3867 #: ../examples/guestfs-recipes.pod:386
3868 msgid ""
3869 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, "
3870 "L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, "
3871 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, "
3872 "L<http://libguestfs.org/>."
3873 msgstr ""
3874
3875 #. type: textblock
3876 #: ../examples/guestfs-recipes.pod:403
3877 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
3878 msgstr ""
3879
3880 #. type: =head2
3881 #: ../fish/guestfish-actions.pod:1
3882 msgid "add-cdrom"
3883 msgstr ""
3884
3885 #. type: verbatim
3886 #: ../fish/guestfish-actions.pod:3
3887 #, no-wrap
3888 msgid ""
3889 " add-cdrom filename\n"
3890 "\n"
3891 msgstr ""
3892
3893 #. type: textblock
3894 #: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:14
3895 msgid "This function adds a virtual CD-ROM disk image to the guest."
3896 msgstr ""
3897
3898 #. type: textblock
3899 #: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:16
3900 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
3901 msgstr ""
3902
3903 #. type: textblock
3904 #: ../fish/guestfish-actions.pod:15
3905 msgid ""
3906 "This call checks for the existence of C<filename>.  This stops you from "
3907 "specifying other types of drive which are supported by qemu such as C<nbd:> "
3908 "and C<http:> URLs.  To specify those, use the general L</config> call "
3909 "instead."
3910 msgstr ""
3911
3912 #. type: textblock
3913 #: ../fish/guestfish-actions.pod:22
3914 msgid ""
3915 "If you just want to add an ISO file (often you use this as an efficient way "
3916 "to transfer large files into the guest), then you should probably use "
3917 "L</add-drive-ro> instead."
3918 msgstr ""
3919
3920 #. type: textblock
3921 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
3922 msgid ""
3923 "I<This function is deprecated.> In new code, use the L</add_drive_opts> call "
3924 "instead."
3925 msgstr ""
3926
3927 #. type: textblock
3928 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:1026 ../fish/guestfish-actions.pod:1386 ../fish/guestfish-actions.pod:1400 ../fish/guestfish-actions.pod:3157 ../fish/guestfish-actions.pod:3364 ../fish/guestfish-actions.pod:3478 ../fish/guestfish-actions.pod:3526 ../fish/guestfish-actions.pod:4439 ../fish/guestfish-actions.pod:4462 ../fish/guestfish-actions.pod:4484 ../fish/guestfish-actions.pod:4522 ../fish/guestfish-actions.pod:5171 ../fish/guestfish-actions.pod:5277 ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:2114 ../src/guestfs-actions.pod:2135 ../src/guestfs-actions.pod:4765 ../src/guestfs-actions.pod:5068 ../src/guestfs-actions.pod:5297 ../src/guestfs-actions.pod:5397 ../src/guestfs-actions.pod:6677 ../src/guestfs-actions.pod:6721 ../src/guestfs-actions.pod:6755 ../src/guestfs-actions.pod:6818 ../src/guestfs-actions.pod:7750 ../src/guestfs-actions.pod:7859 ../src/guestfs-actions.pod:8042
3929 msgid ""
3930 "Deprecated functions will not be removed from the API, but the fact that "
3931 "they are deprecated indicates that there are problems with correct use of "
3932 "these functions."
3933 msgstr ""
3934
3935 #. type: =head2
3936 #: ../fish/guestfish-actions.pod:35
3937 msgid "add-domain"
3938 msgstr ""
3939
3940 #. type: =head2
3941 #: ../fish/guestfish-actions.pod:37
3942 msgid "domain"
3943 msgstr ""
3944
3945 #. type: verbatim
3946 #: ../fish/guestfish-actions.pod:39
3947 #, no-wrap
3948 msgid ""
3949 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] "
3950 "[allowuuid:..]\n"
3951 "\n"
3952 msgstr ""
3953
3954 #. type: textblock
3955 #: ../fish/guestfish-actions.pod:41
3956 msgid ""
3957 "This function adds the disk(s) attached to the named libvirt domain C<dom>.  "
3958 "It works by connecting to libvirt, requesting the domain and domain XML from "
3959 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
3960 msgstr ""
3961
3962 #. type: textblock
3963 #: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:64
3964 msgid ""
3965 "The number of disks added is returned.  This operation is atomic: if an "
3966 "error is returned, then no disks are added."
3967 msgstr ""
3968
3969 #. type: textblock
3970 #: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:67
3971 msgid ""
3972 "This function does some minimal checks to make sure the libvirt domain is "
3973 "not running (unless C<readonly> is true).  In a future version we will try "
3974 "to acquire the libvirt lock on each disk."
3975 msgstr ""
3976
3977 #. type: textblock
3978 #: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:71
3979 msgid ""
3980 "Disks must be accessible locally.  This often means that adding disks from a "
3981 "remote libvirt connection (see L<http://libvirt.org/remote.html>)  will fail "
3982 "unless those disks are accessible via the same device path locally too."
3983 msgstr ""
3984
3985 #. type: textblock
3986 #: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:76
3987 msgid ""
3988 "The optional C<libvirturi> parameter sets the libvirt URI (see "
3989 "L<http://libvirt.org/uri.html>).  If this is not set then we connect to the "
3990 "default libvirt URI (or one set through an environment variable, see the "
3991 "libvirt documentation for full details)."
3992 msgstr ""
3993
3994 #. type: textblock
3995 #: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:82
3996 msgid ""
3997 "The optional C<live> flag controls whether this call will try to connect to "
3998 "a running virtual machine C<guestfsd> process if it sees a suitable "
3999 "E<lt>channelE<gt> element in the libvirt XML definition.  The default (if "
4000 "the flag is omitted) is never to try.  See L<guestfs(3)/ATTACHING TO RUNNING "
4001 "DAEMONS> for more information."
4002 msgstr ""
4003
4004 #. type: textblock
4005 #: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:89
4006 msgid ""
4007 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
4008 "passed instead of the domain name.  The C<dom> string is treated as a UUID "
4009 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
4010 "as usual."
4011 msgstr ""
4012
4013 #. type: textblock
4014 #: ../fish/guestfish-actions.pod:76
4015 msgid ""
4016 "The other optional parameters are passed directly through to "
4017 "L</add-drive-opts>."
4018 msgstr ""
4019
4020 #. type: textblock
4021 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143 ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:784 ../fish/guestfish-actions.pod:805 ../fish/guestfish-actions.pod:2040 ../fish/guestfish-actions.pod:3206 ../fish/guestfish-actions.pod:3379 ../fish/guestfish-actions.pod:3514
4022 msgid ""
4023 "This command has one or more optional arguments.  See L</OPTIONAL "
4024 "ARGUMENTS>."
4025 msgstr ""
4026
4027 #. type: =head2
4028 #: ../fish/guestfish-actions.pod:81
4029 msgid "add-drive"
4030 msgstr ""
4031
4032 #. type: verbatim
4033 #: ../fish/guestfish-actions.pod:83
4034 #, no-wrap
4035 msgid ""
4036 " add-drive filename\n"
4037 "\n"
4038 msgstr ""
4039
4040 #. type: textblock
4041 #: ../fish/guestfish-actions.pod:85
4042 msgid ""
4043 "This function is the equivalent of calling L</add-drive-opts> with no "
4044 "optional parameters, so the disk is added writable, with the format being "
4045 "detected automatically."
4046 msgstr ""
4047
4048 #. type: textblock
4049 #: ../fish/guestfish-actions.pod:89
4050 msgid ""
4051 "Automatic detection of the format opens you up to a potential security hole "
4052 "when dealing with untrusted raw-format images.  See CVE-2010-3851 and "
4053 "RHBZ#642934.  Specifying the format closes this security hole.  Therefore "
4054 "you should think about replacing calls to this function with calls to "
4055 "L</add-drive-opts>, and specifying the format."
4056 msgstr ""
4057
4058 #. type: =head2
4059 #: ../fish/guestfish-actions.pod:96
4060 msgid "add-drive-opts"
4061 msgstr ""
4062
4063 #. type: =head2
4064 #: ../fish/guestfish-actions.pod:98
4065 msgid "add"
4066 msgstr ""
4067
4068 #. type: verbatim
4069 #: ../fish/guestfish-actions.pod:100
4070 #, no-wrap
4071 msgid ""
4072 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
4073 "\n"
4074 msgstr ""
4075
4076 #. type: textblock
4077 #: ../fish/guestfish-actions.pod:102 ../src/guestfs-actions.pod:160
4078 msgid ""
4079 "This function adds a virtual machine disk image C<filename> to libguestfs.  "
4080 "The first time you call this function, the disk appears as C</dev/sda>, the "
4081 "second time as C</dev/sdb>, and so on."
4082 msgstr ""
4083
4084 #. type: textblock
4085 #: ../fish/guestfish-actions.pod:107 ../src/guestfs-actions.pod:165
4086 msgid ""
4087 "You don't necessarily need to be root when using libguestfs.  However you "
4088 "obviously do need sufficient permissions to access the filename for whatever "
4089 "operations you want to perform (ie. read access if you just want to read the "
4090 "image or write access if you want to modify the image)."
4091 msgstr ""
4092
4093 #. type: textblock
4094 #: ../fish/guestfish-actions.pod:113 ../src/guestfs-actions.pod:171
4095 msgid "This call checks that C<filename> exists."
4096 msgstr ""
4097
4098 #. type: textblock
4099 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3168 ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4802
4100 msgid "The optional arguments are:"
4101 msgstr ""
4102
4103 #. type: =item
4104 #: ../fish/guestfish-actions.pod:119 ../src/guestfs-actions.pod:177
4105 msgid "C<readonly>"
4106 msgstr ""
4107
4108 #. type: textblock
4109 #: ../fish/guestfish-actions.pod:121 ../src/guestfs-actions.pod:179
4110 msgid ""
4111 "If true then the image is treated as read-only.  Writes are still allowed, "
4112 "but they are stored in a temporary snapshot overlay which is discarded at "
4113 "the end.  The disk that you add is not modified."
4114 msgstr ""
4115
4116 #. type: =item
4117 #: ../fish/guestfish-actions.pod:125 ../src/guestfs-actions.pod:183
4118 msgid "C<format>"
4119 msgstr ""
4120
4121 #. type: textblock
4122 #: ../fish/guestfish-actions.pod:127
4123 msgid ""
4124 "This forces the image format.  If you omit this (or use L</add-drive> or "
4125 "L</add-drive-ro>) then the format is automatically detected.  Possible "
4126 "formats include C<raw> and C<qcow2>."
4127 msgstr ""
4128
4129 #. type: textblock
4130 #: ../fish/guestfish-actions.pod:131 ../src/guestfs-actions.pod:189
4131 msgid ""
4132 "Automatic detection of the format opens you up to a potential security hole "
4133 "when dealing with untrusted raw-format images.  See CVE-2010-3851 and "
4134 "RHBZ#642934.  Specifying the format closes this security hole."
4135 msgstr ""
4136
4137 #. type: =item
4138 #: ../fish/guestfish-actions.pod:136 ../src/guestfs-actions.pod:194
4139 msgid "C<iface>"
4140 msgstr ""
4141
4142 #. type: textblock
4143 #: ../fish/guestfish-actions.pod:138
4144 msgid ""
4145 "This rarely-used option lets you emulate the behaviour of the deprecated "
4146 "L</add-drive-with-if> call (q.v.)"
4147 msgstr ""
4148
4149 #. type: =head2
4150 #: ../fish/guestfish-actions.pod:145
4151 msgid "add-drive-ro"
4152 msgstr ""
4153
4154 #. type: =head2
4155 #: ../fish/guestfish-actions.pod:147
4156 msgid "add-ro"
4157 msgstr ""
4158
4159 #. type: verbatim
4160 #: ../fish/guestfish-actions.pod:149
4161 #, no-wrap
4162 msgid ""
4163 " add-drive-ro filename\n"
4164 "\n"
4165 msgstr ""
4166
4167 #. type: textblock
4168 #: ../fish/guestfish-actions.pod:151
4169 msgid ""
4170 "This function is the equivalent of calling L</add-drive-opts> with the "
4171 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
4172 "is added read-only, with the format being detected automatically."
4173 msgstr ""
4174
4175 #. type: =head2
4176 #: ../fish/guestfish-actions.pod:156
4177 msgid "add-drive-ro-with-if"
4178 msgstr ""
4179
4180 #. type: verbatim
4181 #: ../fish/guestfish-actions.pod:158
4182 #, no-wrap
4183 msgid ""
4184 " add-drive-ro-with-if filename iface\n"
4185 "\n"
4186 msgstr ""
4187
4188 #. type: textblock
4189 #: ../fish/guestfish-actions.pod:160
4190 msgid ""
4191 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
4192 "interface emulation to use at run time."
4193 msgstr ""
4194
4195 #. type: =head2
4196 #: ../fish/guestfish-actions.pod:170
4197 msgid "add-drive-with-if"
4198 msgstr ""
4199
4200 #. type: verbatim
4201 #: ../fish/guestfish-actions.pod:172
4202 #, no-wrap
4203 msgid ""
4204 " add-drive-with-if filename iface\n"
4205 "\n"
4206 msgstr ""
4207
4208 #. type: textblock
4209 #: ../fish/guestfish-actions.pod:174
4210 msgid ""
4211 "This is the same as L</add-drive> but it allows you to specify the QEMU "
4212 "interface emulation to use at run time."
4213 msgstr ""
4214
4215 #. type: =head2
4216 #: ../fish/guestfish-actions.pod:184
4217 msgid "aug-clear"
4218 msgstr ""
4219
4220 #. type: verbatim
4221 #: ../fish/guestfish-actions.pod:186
4222 #, no-wrap
4223 msgid ""
4224 " aug-clear augpath\n"
4225 "\n"
4226 msgstr ""
4227
4228 #. type: textblock
4229 #: ../fish/guestfish-actions.pod:188 ../src/guestfs-actions.pod:290
4230 msgid ""
4231 "Set the value associated with C<path> to C<NULL>.  This is the same as the "
4232 "L<augtool(1)> C<clear> command."
4233 msgstr ""
4234
4235 #. type: =head2
4236 #: ../fish/guestfish-actions.pod:191
4237 msgid "aug-close"
4238 msgstr ""
4239
4240 #. type: verbatim
4241 #: ../fish/guestfish-actions.pod:193
4242 #, no-wrap
4243 msgid ""
4244 " aug-close\n"
4245 "\n"
4246 msgstr ""
4247
4248 #. type: textblock
4249 #: ../fish/guestfish-actions.pod:195
4250 msgid ""
4251 "Close the current Augeas handle and free up any resources used by it.  After "
4252 "calling this, you have to call L</aug-init> again before you can use any "
4253 "other Augeas functions."
4254 msgstr ""
4255
4256 #. type: =head2
4257 #: ../fish/guestfish-actions.pod:200
4258 msgid "aug-defnode"
4259 msgstr ""
4260
4261 #. type: verbatim
4262 #: ../fish/guestfish-actions.pod:202
4263 #, no-wrap
4264 msgid ""
4265 " aug-defnode name expr val\n"
4266 "\n"
4267 msgstr ""
4268
4269 #. type: textblock
4270 #: ../fish/guestfish-actions.pod:204 ../src/guestfs-actions.pod:319
4271 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4272 msgstr ""
4273
4274 #. type: textblock
4275 #: ../fish/guestfish-actions.pod:207
4276 msgid ""
4277 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4278 "calling L</aug-set> C<expr>, C<value>.  C<name> will be the nodeset "
4279 "containing that single node."
4280 msgstr ""
4281
4282 #. type: textblock
4283 #: ../fish/guestfish-actions.pod:211 ../src/guestfs-actions.pod:326
4284 msgid ""
4285 "On success this returns a pair containing the number of nodes in the "
4286 "nodeset, and a boolean flag if a node was created."
4287 msgstr ""
4288
4289 #. type: =head2
4290 #: ../fish/guestfish-actions.pod:215
4291 msgid "aug-defvar"
4292 msgstr ""
4293
4294 #. type: verbatim
4295 #: ../fish/guestfish-actions.pod:217
4296 #, no-wrap
4297 msgid ""
4298 " aug-defvar name expr\n"
4299 "\n"
4300 msgstr ""
4301
4302 #. type: textblock
4303 #: ../fish/guestfish-actions.pod:219 ../src/guestfs-actions.pod:343
4304 msgid ""
4305 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4306 "C<expr>.  If C<expr> is NULL, then C<name> is undefined."
4307 msgstr ""
4308
4309 #. type: textblock
4310 #: ../fish/guestfish-actions.pod:223 ../src/guestfs-actions.pod:347
4311 msgid ""
4312 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4313 "evaluates to something which is not a nodeset."
4314 msgstr ""
4315
4316 #. type: =head2
4317 #: ../fish/guestfish-actions.pod:226
4318 msgid "aug-get"
4319 msgstr ""
4320
4321 #. type: verbatim
4322 #: ../fish/guestfish-actions.pod:228
4323 #, no-wrap
4324 msgid ""
4325 " aug-get augpath\n"
4326 "\n"
4327 msgstr ""
4328
4329 #. type: textblock
4330 #: ../fish/guestfish-actions.pod:230 ../src/guestfs-actions.pod:360
4331 msgid ""
4332 "Look up the value associated with C<path>.  If C<path> matches exactly one "
4333 "node, the C<value> is returned."
4334 msgstr ""
4335
4336 #. type: =head2
4337 #: ../fish/guestfish-actions.pod:233
4338 msgid "aug-init"
4339 msgstr ""
4340
4341 #. type: verbatim
4342 #: ../fish/guestfish-actions.pod:235
4343 #, no-wrap
4344 msgid ""
4345 " aug-init root flags\n"
4346 "\n"
4347 msgstr ""
4348
4349 #. type: textblock
4350 #: ../fish/guestfish-actions.pod:237 ../src/guestfs-actions.pod:375
4351 msgid ""
4352 "Create a new Augeas handle for editing configuration files.  If there was "
4353 "any previous Augeas handle associated with this guestfs session, then it is "
4354 "closed."
4355 msgstr ""
4356
4357 #. type: textblock
4358 #: ../fish/guestfish-actions.pod:241
4359 msgid "You must call this before using any other L</aug-*> commands."
4360 msgstr ""
4361
4362 #. type: textblock
4363 #: ../fish/guestfish-actions.pod:244 ../src/guestfs-actions.pod:382
4364 msgid "C<root> is the filesystem root.  C<root> must not be NULL, use C</> instead."
4365 msgstr ""
4366
4367 #. type: textblock
4368 #: ../fish/guestfish-actions.pod:247 ../src/guestfs-actions.pod:385
4369 msgid ""
4370 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4371 "logical I<or> of the following integers:"
4372 msgstr ""
4373
4374 #. type: =item
4375 #: ../fish/guestfish-actions.pod:253 ../src/guestfs-actions.pod:391
4376 msgid "C<AUG_SAVE_BACKUP> = 1"
4377 msgstr ""
4378
4379 #. type: textblock
4380 #: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:393
4381 msgid "Keep the original file with a C<.augsave> extension."
4382 msgstr ""
4383
4384 #. type: =item
4385 #: ../fish/guestfish-actions.pod:257 ../src/guestfs-actions.pod:395
4386 msgid "C<AUG_SAVE_NEWFILE> = 2"
4387 msgstr ""
4388
4389 #. type: textblock
4390 #: ../fish/guestfish-actions.pod:259 ../src/guestfs-actions.pod:397
4391 msgid ""
4392 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4393 "original.  Overrides C<AUG_SAVE_BACKUP>."
4394 msgstr ""
4395
4396 #. type: =item
4397 #: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:400
4398 msgid "C<AUG_TYPE_CHECK> = 4"
4399 msgstr ""
4400
4401 #. type: textblock
4402 #: ../fish/guestfish-actions.pod:264 ../src/guestfs-actions.pod:402
4403 msgid "Typecheck lenses."
4404 msgstr ""
4405
4406 #. type: textblock
4407 #: ../fish/guestfish-actions.pod:266
4408 msgid ""
4409 "This option is only useful when debugging Augeas lenses.  Use of this option "
4410 "may require additional memory for the libguestfs appliance.  You may need to "
4411 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
4412 msgstr ""
4413
4414 #. type: =item
4415 #: ../fish/guestfish-actions.pod:271 ../src/guestfs-actions.pod:409
4416 msgid "C<AUG_NO_STDINC> = 8"
4417 msgstr ""
4418
4419 #. type: textblock
4420 #: ../fish/guestfish-actions.pod:273 ../src/guestfs-actions.pod:411
4421 msgid "Do not use standard load path for modules."
4422 msgstr ""
4423
4424 #. type: =item
4425 #: ../fish/guestfish-actions.pod:275 ../src/guestfs-actions.pod:413
4426 msgid "C<AUG_SAVE_NOOP> = 16"
4427 msgstr ""
4428
4429 #. type: textblock
4430 #: ../fish/guestfish-actions.pod:277 ../src/guestfs-actions.pod:415
4431 msgid "Make save a no-op, just record what would have been changed."
4432 msgstr ""
4433
4434 #. type: =item
4435 #: ../fish/guestfish-actions.pod:279 ../src/guestfs-actions.pod:417
4436 msgid "C<AUG_NO_LOAD> = 32"
4437 msgstr ""
4438
4439 #. type: textblock
4440 #: ../fish/guestfish-actions.pod:281
4441 msgid "Do not load the tree in L</aug-init>."
4442 msgstr ""
4443
4444 #. type: textblock
4445 #: ../fish/guestfish-actions.pod:285
4446 msgid "To close the handle, you can call L</aug-close>."
4447 msgstr ""
4448
4449 #. type: textblock
4450 #: ../fish/guestfish-actions.pod:287 ../src/guestfs-actions.pod:425
4451 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4452 msgstr ""
4453
4454 #. type: =head2
4455 #: ../fish/guestfish-actions.pod:289
4456 msgid "aug-insert"
4457 msgstr ""
4458
4459 #. type: verbatim
4460 #: ../fish/guestfish-actions.pod:291
4461 #, no-wrap
4462 msgid ""
4463 " aug-insert augpath label true|false\n"
4464 "\n"
4465 msgstr ""
4466
4467 #. type: textblock
4468 #: ../fish/guestfish-actions.pod:293 ../src/guestfs-actions.pod:439
4469 msgid ""
4470 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4471 "or after C<path> (depending on the boolean flag C<before>)."
4472 msgstr ""
4473
4474 #. type: textblock
4475 #: ../fish/guestfish-actions.pod:297 ../src/guestfs-actions.pod:443
4476 msgid ""
4477 "C<path> must match exactly one existing node in the tree, and C<label> must "
4478 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4479 msgstr ""
4480
4481 #. type: =head2
4482 #: ../fish/guestfish-actions.pod:301
4483 msgid "aug-load"
4484 msgstr ""
4485
4486 #. type: verbatim
4487 #: ../fish/guestfish-actions.pod:303
4488 #, no-wrap
4489 msgid ""
4490 " aug-load\n"
4491 "\n"
4492 msgstr ""
4493
4494 #. type: textblock
4495 #: ../fish/guestfish-actions.pod:305 ../src/guestfs-actions.pod:456
4496 msgid "Load files into the tree."
4497 msgstr ""
4498
4499 #. type: textblock
4500 #: ../fish/guestfish-actions.pod:307 ../src/guestfs-actions.pod:458
4501 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4502 msgstr ""
4503
4504 #. type: =head2
4505 #: ../fish/guestfish-actions.pod:310
4506 msgid "aug-ls"
4507 msgstr ""
4508
4509 #. type: verbatim
4510 #: ../fish/guestfish-actions.pod:312
4511 #, no-wrap
4512 msgid ""
4513 " aug-ls augpath\n"
4514 "\n"
4515 msgstr ""
4516
4517 #. type: textblock
4518 #: ../fish/guestfish-actions.pod:314
4519 msgid ""
4520 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
4521 "resulting nodes into alphabetical order."
4522 msgstr ""
4523
4524 #. type: =head2
4525 #: ../fish/guestfish-actions.pod:317
4526 msgid "aug-match"
4527 msgstr ""
4528
4529 #. type: verbatim
4530 #: ../fish/guestfish-actions.pod:319
4531 #, no-wrap
4532 msgid ""
4533 " aug-match augpath\n"
4534 "\n"
4535 msgstr ""
4536
4537 #. type: textblock
4538 #: ../fish/guestfish-actions.pod:321 ../src/guestfs-actions.pod:486
4539 msgid ""
4540 "Returns a list of paths which match the path expression C<path>.  The "
4541 "returned paths are sufficiently qualified so that they match exactly one "
4542 "node in the current tree."
4543 msgstr ""
4544
4545 #. type: =head2
4546 #: ../fish/guestfish-actions.pod:325
4547 msgid "aug-mv"
4548 msgstr ""
4549
4550 #. type: verbatim
4551 #: ../fish/guestfish-actions.pod:327
4552 #, no-wrap
4553 msgid ""
4554 " aug-mv src dest\n"
4555 "\n"
4556 msgstr ""
4557
4558 #. type: textblock
4559 #: ../fish/guestfish-actions.pod:329 ../src/guestfs-actions.pod:503
4560 msgid ""
4561 "Move the node C<src> to C<dest>.  C<src> must match exactly one node.  "
4562 "C<dest> is overwritten if it exists."
4563 msgstr ""
4564
4565 #. type: =head2
4566 #: ../fish/guestfish-actions.pod:332
4567 msgid "aug-rm"
4568 msgstr ""
4569
4570 #. type: verbatim
4571 #: ../fish/guestfish-actions.pod:334
4572 #, no-wrap
4573 msgid ""
4574 " aug-rm augpath\n"
4575 "\n"
4576 msgstr ""
4577
4578 #. type: textblock
4579 #: ../fish/guestfish-actions.pod:336 ../src/guestfs-actions.pod:516
4580 msgid "Remove C<path> and all of its children."
4581 msgstr ""
4582
4583 #. type: textblock
4584 #: ../fish/guestfish-actions.pod:338 ../src/guestfs-actions.pod:518
4585 msgid "On success this returns the number of entries which were removed."
4586 msgstr ""
4587
4588 #. type: =head2
4589 #: ../fish/guestfish-actions.pod:340
4590 msgid "aug-save"
4591 msgstr ""
4592
4593 #. type: verbatim
4594 #: ../fish/guestfish-actions.pod:342
4595 #, no-wrap
4596 msgid ""
4597 " aug-save\n"
4598 "\n"
4599 msgstr ""
4600
4601 #. type: textblock
4602 #: ../fish/guestfish-actions.pod:344 ../src/guestfs-actions.pod:529
4603 msgid "This writes all pending changes to disk."
4604 msgstr ""
4605
4606 #. type: textblock
4607 #: ../fish/guestfish-actions.pod:346
4608 msgid ""
4609 "The flags which were passed to L</aug-init> affect exactly how files are "
4610 "saved."
4611 msgstr ""
4612
4613 #. type: =head2
4614 #: ../fish/guestfish-actions.pod:349
4615 msgid "aug-set"
4616 msgstr ""
4617
4618 #. type: verbatim
4619 #: ../fish/guestfish-actions.pod:351
4620 #, no-wrap
4621 msgid ""
4622 " aug-set augpath val\n"
4623 "\n"
4624 msgstr ""
4625
4626 #. type: textblock
4627 #: ../fish/guestfish-actions.pod:353 ../src/guestfs-actions.pod:545
4628 msgid "Set the value associated with C<path> to C<val>."
4629 msgstr ""
4630
4631 #. type: textblock
4632 #: ../fish/guestfish-actions.pod:355
4633 msgid ""
4634 "In the Augeas API, it is possible to clear a node by setting the value to "
4635 "NULL.  Due to an oversight in the libguestfs API you cannot do that with "
4636 "this call.  Instead you must use the L</aug-clear> call."
4637 msgstr ""
4638
4639 #. type: =head2
4640 #: ../fish/guestfish-actions.pod:360
4641 msgid "available"
4642 msgstr ""
4643
4644 #. type: verbatim
4645 #: ../fish/guestfish-actions.pod:362
4646 #, no-wrap
4647 msgid ""
4648 " available 'groups ...'\n"
4649 "\n"
4650 msgstr ""
4651
4652 #. type: textblock
4653 #: ../fish/guestfish-actions.pod:364 ../src/guestfs-actions.pod:562
4654 msgid ""
4655 "This command is used to check the availability of some groups of "
4656 "functionality in the appliance, which not all builds of the libguestfs "
4657 "appliance will be able to provide."
4658 msgstr ""
4659
4660 #. type: textblock
4661 #: ../fish/guestfish-actions.pod:368
4662 msgid ""
4663 "The libguestfs groups, and the functions that those groups correspond to, "
4664 "are listed in L<guestfs(3)/AVAILABILITY>.  You can also fetch this list at "
4665 "runtime by calling L</available-all-groups>."
4666 msgstr ""
4667
4668 #. type: textblock
4669 #: ../fish/guestfish-actions.pod:373 ../src/guestfs-actions.pod:571
4670 msgid ""
4671 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
4672 "\"augeas\"]> would check for the availability of the Linux inotify functions "
4673 "and Augeas (configuration file editing) functions."
4674 msgstr ""
4675
4676 #. type: textblock
4677 #: ../fish/guestfish-actions.pod:378 ../src/guestfs-actions.pod:576
4678 msgid "The command returns no error if I<all> requested groups are available."
4679 msgstr ""
4680
4681 #. type: textblock
4682 #: ../fish/guestfish-actions.pod:380 ../src/guestfs-actions.pod:578
4683 msgid ""
4684 "It fails with an error if one or more of the requested groups is unavailable "
4685 "in the appliance."
4686 msgstr ""
4687
4688 #. type: textblock
4689 #: ../fish/guestfish-actions.pod:383 ../src/guestfs-actions.pod:581
4690 msgid ""
4691 "If an unknown group name is included in the list of groups then an error is "
4692 "always returned."
4693 msgstr ""
4694
4695 #. type: textblock
4696 #: ../fish/guestfish-actions.pod:386 ../src/guestfs-actions.pod:584
4697 msgid "I<Notes:>"
4698 msgstr ""
4699
4700 #. type: textblock
4701 #: ../fish/guestfish-actions.pod:392
4702 msgid "You must call L</launch> before calling this function."
4703 msgstr ""
4704
4705 #. type: textblock
4706 #: ../fish/guestfish-actions.pod:394 ../src/guestfs-actions.pod:592
4707 msgid ""
4708 "The reason is because we don't know what groups are supported by the "
4709 "appliance/daemon until it is running and can be queried."
4710 msgstr ""
4711
4712 #. type: textblock
4713 #: ../fish/guestfish-actions.pod:400 ../src/guestfs-actions.pod:598
4714 msgid ""
4715 "If a group of functions is available, this does not necessarily mean that "
4716 "they will work.  You still have to check for errors when calling individual "
4717 "API functions even if they are available."
4718 msgstr ""
4719
4720 #. type: textblock
4721 #: ../fish/guestfish-actions.pod:407 ../src/guestfs-actions.pod:605
4722 msgid ""
4723 "It is usually the job of distro packagers to build complete functionality "
4724 "into the libguestfs appliance.  Upstream libguestfs, if built from source "
4725 "with all requirements satisfied, will support everything."
4726 msgstr ""
4727
4728 #. type: textblock
4729 #: ../fish/guestfish-actions.pod:414
4730 msgid ""
4731 "This call was added in version C<1.0.80>.  In previous versions of "
4732 "libguestfs all you could do would be to speculatively execute a command to "
4733 "find out if the daemon implemented it.  See also L</version>."
4734 msgstr ""
4735
4736 #. type: =head2
4737 #: ../fish/guestfish-actions.pod:421
4738 msgid "available-all-groups"
4739 msgstr ""
4740
4741 #. type: verbatim
4742 #: ../fish/guestfish-actions.pod:423
4743 #, no-wrap
4744 msgid ""
4745 " available-all-groups\n"
4746 "\n"
4747 msgstr ""
4748
4749 #. type: textblock
4750 #: ../fish/guestfish-actions.pod:425
4751 msgid ""
4752 "This command returns a list of all optional groups that this daemon knows "
4753 "about.  Note this returns both supported and unsupported groups.  To find "
4754 "out which ones the daemon can actually support you have to call "
4755 "L</available> on each member of the returned list."
4756 msgstr ""
4757
4758 #. type: textblock
4759 #: ../fish/guestfish-actions.pod:431
4760 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
4761 msgstr ""
4762
4763 #. type: =head2
4764 #: ../fish/guestfish-actions.pod:433
4765 msgid "base64-in"
4766 msgstr ""
4767
4768 #. type: verbatim
4769 #: ../fish/guestfish-actions.pod:435
4770 #, no-wrap
4771 msgid ""
4772 " base64-in (base64file|-) filename\n"
4773 "\n"
4774 msgstr ""
4775
4776 #. type: textblock
4777 #: ../fish/guestfish-actions.pod:437 ../src/guestfs-actions.pod:649
4778 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
4779 msgstr ""
4780
4781 #. type: textblock
4782 #: ../fish/guestfish-actions.pod:440 ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:698 ../fish/guestfish-actions.pod:782 ../fish/guestfish-actions.pod:803 ../fish/guestfish-actions.pod:902 ../fish/guestfish-actions.pod:921 ../fish/guestfish-actions.pod:1295 ../fish/guestfish-actions.pod:4742 ../fish/guestfish-actions.pod:4754 ../fish/guestfish-actions.pod:4765 ../fish/guestfish-actions.pod:4776 ../fish/guestfish-actions.pod:4828 ../fish/guestfish-actions.pod:4837 ../fish/guestfish-actions.pod:4891 ../fish/guestfish-actions.pod:4914
4783 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
4784 msgstr ""
4785
4786 #. type: =head2
4787 #: ../fish/guestfish-actions.pod:442
4788 msgid "base64-out"
4789 msgstr ""
4790
4791 #. type: verbatim
4792 #: ../fish/guestfish-actions.pod:444
4793 #, no-wrap
4794 msgid ""
4795 " base64-out filename (base64file|-)\n"
4796 "\n"
4797 msgstr ""
4798
4799 #. type: textblock
4800 #: ../fish/guestfish-actions.pod:446 ../src/guestfs-actions.pod:663
4801 msgid ""
4802 "This command downloads the contents of C<filename>, writing it out to local "
4803 "file C<base64file> encoded as base64."
4804 msgstr ""
4805
4806 #. type: =head2
4807 #: ../fish/guestfish-actions.pod:451
4808 msgid "blockdev-flushbufs"
4809 msgstr ""
4810
4811 #. type: verbatim
4812 #: ../fish/guestfish-actions.pod:453
4813 #, no-wrap
4814 msgid ""
4815 " blockdev-flushbufs device\n"
4816 "\n"
4817 msgstr ""
4818
4819 #. type: textblock
4820 #: ../fish/guestfish-actions.pod:455 ../src/guestfs-actions.pod:676
4821 msgid "This tells the kernel to flush internal buffers associated with C<device>."
4822 msgstr ""
4823
4824 #. type: textblock
4825 #: ../fish/guestfish-actions.pod:458 ../fish/guestfish-actions.pod:469 ../fish/guestfish-actions.pod:478 ../fish/guestfish-actions.pod:488 ../fish/guestfish-actions.pod:500 ../fish/guestfish-actions.pod:513 ../fish/guestfish-actions.pod:521 ../fish/guestfish-actions.pod:532 ../fish/guestfish-actions.pod:540 ../fish/guestfish-actions.pod:548 ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:711 ../src/guestfs-actions.pod:727 ../src/guestfs-actions.pod:745 ../src/guestfs-actions.pod:764 ../src/guestfs-actions.pod:778 ../src/guestfs-actions.pod:796 ../src/guestfs-actions.pod:810 ../src/guestfs-actions.pod:824
4826 msgid "This uses the L<blockdev(8)> command."
4827 msgstr ""
4828
4829 #. type: =head2
4830 #: ../fish/guestfish-actions.pod:460
4831 msgid "blockdev-getbsz"
4832 msgstr ""
4833
4834 #. type: verbatim
4835 #: ../fish/guestfish-actions.pod:462
4836 #, no-wrap
4837 msgid ""
4838 " blockdev-getbsz device\n"
4839 "\n"
4840 msgstr ""
4841
4842 #. type: textblock
4843 #: ../fish/guestfish-actions.pod:464 ../src/guestfs-actions.pod:691
4844 msgid "This returns the block size of a device."
4845 msgstr ""
4846
4847 #. type: textblock
4848 #: ../fish/guestfish-actions.pod:466 ../fish/guestfish-actions.pod:529 ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:793
4849 msgid ""
4850 "(Note this is different from both I<size in blocks> and I<filesystem block "
4851 "size>)."
4852 msgstr ""
4853
4854 #. type: =head2
4855 #: ../fish/guestfish-actions.pod:471
4856 msgid "blockdev-getro"
4857 msgstr ""
4858
4859 #. type: verbatim
4860 #: ../fish/guestfish-actions.pod:473
4861 #, no-wrap
4862 msgid ""
4863 " blockdev-getro device\n"
4864 "\n"
4865 msgstr ""
4866
4867 #. type: textblock
4868 #: ../fish/guestfish-actions.pod:475 ../src/guestfs-actions.pod:708
4869 msgid ""
4870 "Returns a boolean indicating if the block device is read-only (true if "
4871 "read-only, false if not)."
4872 msgstr ""
4873
4874 #. type: =head2
4875 #: ../fish/guestfish-actions.pod:480
4876 msgid "blockdev-getsize64"
4877 msgstr ""
4878
4879 #. type: verbatim
4880 #: ../fish/guestfish-actions.pod:482
4881 #, no-wrap
4882 msgid ""
4883 " blockdev-getsize64 device\n"
4884 "\n"
4885 msgstr ""
4886
4887 #. type: textblock
4888 #: ../fish/guestfish-actions.pod:484 ../src/guestfs-actions.pod:723
4889 msgid "This returns the size of the device in bytes."
4890 msgstr ""
4891
4892 #. type: textblock
4893 #: ../fish/guestfish-actions.pod:486
4894 msgid "See also L</blockdev-getsz>."
4895 msgstr ""
4896
4897 #. type: =head2
4898 #: ../fish/guestfish-actions.pod:490
4899 msgid "blockdev-getss"
4900 msgstr ""
4901
4902 #. type: verbatim
4903 #: ../fish/guestfish-actions.pod:492
4904 #, no-wrap
4905 msgid ""
4906 " blockdev-getss device\n"
4907 "\n"
4908 msgstr ""
4909
4910 #. type: textblock
4911 #: ../fish/guestfish-actions.pod:494 ../src/guestfs-actions.pod:739
4912 msgid ""
4913 "This returns the size of sectors on a block device.  Usually 512, but can be "
4914 "larger for modern devices."
4915 msgstr ""
4916
4917 #. type: textblock
4918 #: ../fish/guestfish-actions.pod:497
4919 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
4920 msgstr ""
4921
4922 #. type: =head2
4923 #: ../fish/guestfish-actions.pod:502
4924 msgid "blockdev-getsz"
4925 msgstr ""
4926
4927 #. type: verbatim
4928 #: ../fish/guestfish-actions.pod:504
4929 #, no-wrap
4930 msgid ""
4931 " blockdev-getsz device\n"
4932 "\n"
4933 msgstr ""
4934
4935 #. type: textblock
4936 #: ../fish/guestfish-actions.pod:506 ../src/guestfs-actions.pod:757
4937 msgid ""
4938 "This returns the size of the device in units of 512-byte sectors (even if "
4939 "the sectorsize isn't 512 bytes ... weird)."
4940 msgstr ""
4941
4942 #. type: textblock
4943 #: ../fish/guestfish-actions.pod:509
4944 msgid ""
4945 "See also L</blockdev-getss> for the real sector size of the device, and "
4946 "L</blockdev-getsize64> for the more useful I<size in bytes>."
4947 msgstr ""
4948
4949 #. type: =head2
4950 #: ../fish/guestfish-actions.pod:515
4951 msgid "blockdev-rereadpt"
4952 msgstr ""
4953
4954 #. type: verbatim
4955 #: ../fish/guestfish-actions.pod:517
4956 #, no-wrap
4957 msgid ""
4958 " blockdev-rereadpt device\n"
4959 "\n"
4960 msgstr ""
4961
4962 #. type: textblock
4963 #: ../fish/guestfish-actions.pod:519 ../src/guestfs-actions.pod:776
4964 msgid "Reread the partition table on C<device>."
4965 msgstr ""
4966
4967 #. type: =head2
4968 #: ../fish/guestfish-actions.pod:523
4969 msgid "blockdev-setbsz"
4970 msgstr ""
4971
4972 #. type: verbatim
4973 #: ../fish/guestfish-actions.pod:525
4974 #, no-wrap
4975 msgid ""
4976 " blockdev-setbsz device blocksize\n"
4977 "\n"
4978 msgstr ""
4979
4980 #. type: textblock
4981 #: ../fish/guestfish-actions.pod:527 ../src/guestfs-actions.pod:791
4982 msgid "This sets the block size of a device."
4983 msgstr ""
4984
4985 #. type: =head2
4986 #: ../fish/guestfish-actions.pod:534
4987 msgid "blockdev-setro"
4988 msgstr ""
4989
4990 #. type: verbatim
4991 #: ../fish/guestfish-actions.pod:536
4992 #, no-wrap
4993 msgid ""
4994 " blockdev-setro device\n"
4995 "\n"
4996 msgstr ""
4997
4998 #. type: textblock
4999 #: ../fish/guestfish-actions.pod:538 ../src/guestfs-actions.pod:808
5000 msgid "Sets the block device named C<device> to read-only."
5001 msgstr ""
5002
5003 #. type: =head2
5004 #: ../fish/guestfish-actions.pod:542
5005 msgid "blockdev-setrw"
5006 msgstr ""
5007
5008 #. type: verbatim
5009 #: ../fish/guestfish-actions.pod:544
5010 #, no-wrap
5011 msgid ""
5012 " blockdev-setrw device\n"
5013 "\n"
5014 msgstr ""
5015
5016 #. type: textblock
5017 #: ../fish/guestfish-actions.pod:546 ../src/guestfs-actions.pod:822
5018 msgid "Sets the block device named C<device> to read-write."
5019 msgstr ""
5020
5021 #. type: =head2
5022 #: ../fish/guestfish-actions.pod:550
5023 msgid "btrfs-filesystem-resize"
5024 msgstr ""
5025
5026 #. type: verbatim
5027 #: ../fish/guestfish-actions.pod:552
5028 #, no-wrap
5029 msgid ""
5030 " btrfs-filesystem-resize mountpoint [size:..]\n"
5031 "\n"
5032 msgstr ""
5033
5034 #. type: textblock
5035 #: ../fish/guestfish-actions.pod:554 ../src/guestfs-actions.pod:844
5036 msgid "This command resizes a btrfs filesystem."
5037 msgstr ""
5038
5039 #. type: textblock
5040 #: ../fish/guestfish-actions.pod:556 ../src/guestfs-actions.pod:846
5041 msgid ""
5042 "Note that unlike other resize calls, the filesystem has to be mounted and "
5043 "the parameter is the mountpoint not the device (this is a requirement of "
5044 "btrfs itself)."
5045 msgstr ""
5046
5047 #. type: textblock
5048 #: ../fish/guestfish-actions.pod:560 ../fish/guestfish-actions.pod:3489 ../src/guestfs-actions.pod:850 ../src/guestfs-actions.pod:5336
5049 msgid "The optional parameters are:"
5050 msgstr ""
5051
5052 #. type: =item
5053 #: ../fish/guestfish-actions.pod:564 ../fish/guestfish-actions.pod:3493 ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:5340
5054 msgid "C<size>"
5055 msgstr ""
5056
5057 #. type: textblock
5058 #: ../fish/guestfish-actions.pod:566 ../src/guestfs-actions.pod:856
5059 msgid ""
5060 "The new size (in bytes) of the filesystem.  If omitted, the filesystem is "
5061 "resized to the maximum size."
5062 msgstr ""
5063
5064 #. type: textblock
5065 #: ../fish/guestfish-actions.pod:571 ../src/guestfs-actions.pod:861
5066 msgid "See also L<btrfs(8)>."
5067 msgstr ""
5068
5069 #. type: =head2
5070 #: ../fish/guestfish-actions.pod:575
5071 msgid "case-sensitive-path"
5072 msgstr ""
5073
5074 #. type: verbatim
5075 #: ../fish/guestfish-actions.pod:577
5076 #, no-wrap
5077 msgid ""
5078 " case-sensitive-path path\n"
5079 "\n"
5080 msgstr ""
5081
5082 #. type: textblock
5083 #: ../fish/guestfish-actions.pod:579 ../src/guestfs-actions.pod:895
5084 msgid ""
5085 "This can be used to resolve case insensitive paths on a filesystem which is "
5086 "case sensitive.  The use case is to resolve paths which you have read from "
5087 "Windows configuration files or the Windows Registry, to the true path."
5088 msgstr ""
5089
5090 #. type: textblock
5091 #: ../fish/guestfish-actions.pod:584 ../src/guestfs-actions.pod:900
5092 msgid ""
5093 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5094 "(and probably others), which is that although the underlying filesystem is "
5095 "case-insensitive, the driver exports the filesystem to Linux as "
5096 "case-sensitive."
5097 msgstr ""
5098
5099 #. type: textblock
5100 #: ../fish/guestfish-actions.pod:589 ../src/guestfs-actions.pod:905
5101 msgid ""
5102 "One consequence of this is that special directories such as C<c:\\windows> "
5103 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5104 "precise details of how they were created.  In Windows itself this would not "
5105 "be a problem."
5106 msgstr ""
5107
5108 #. type: textblock
5109 #: ../fish/guestfish-actions.pod:595 ../src/guestfs-actions.pod:911
5110 msgid ""
5111 "Bug or feature? You decide: "
5112 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
5113 msgstr ""
5114
5115 #. type: textblock
5116 #: ../fish/guestfish-actions.pod:598 ../src/guestfs-actions.pod:914
5117 msgid ""
5118 "This function resolves the true case of each element in the path and returns "
5119 "the case-sensitive path."
5120 msgstr ""
5121
5122 #. type: textblock
5123 #: ../fish/guestfish-actions.pod:601
5124 msgid ""
5125 "Thus L</case-sensitive-path> (\"/Windows/System32\")  might return "
5126 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5127 "how the directories were originally created under Windows)."
5128 msgstr ""
5129
5130 #. type: textblock
5131 #: ../fish/guestfish-actions.pod:606 ../src/guestfs-actions.pod:922
5132 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5133 msgstr ""
5134
5135 #. type: textblock
5136 #: ../fish/guestfish-actions.pod:609
5137 msgid "See also L</realpath>."
5138 msgstr ""
5139
5140 #. type: =head2
5141 #: ../fish/guestfish-actions.pod:611
5142 msgid "cat"
5143 msgstr ""
5144
5145 #. type: verbatim
5146 #: ../fish/guestfish-actions.pod:613
5147 #, no-wrap
5148 msgid ""
5149 " cat path\n"
5150 "\n"
5151 msgstr ""
5152
5153 #. type: textblock
5154 #: ../fish/guestfish-actions.pod:615 ../fish/guestfish-actions.pod:3909 ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:5979
5155 msgid "Return the contents of the file named C<path>."
5156 msgstr ""
5157
5158 #. type: textblock
5159 #: ../fish/guestfish-actions.pod:617
5160 msgid ""
5161 "Note that this function cannot correctly handle binary files (specifically, "
5162 "files containing C<\\0> character which is treated as end of string).  For "
5163 "those you need to use the L</read-file> or L</download> functions which have "
5164 "a more complex interface."
5165 msgstr ""
5166
5167 #. type: textblock
5168 #: ../fish/guestfish-actions.pod:622 ../fish/guestfish-actions.pod:757 ../fish/guestfish-actions.pod:769 ../fish/guestfish-actions.pod:980 ../fish/guestfish-actions.pod:990 ../fish/guestfish-actions.pod:1057 ../fish/guestfish-actions.pod:1067 ../fish/guestfish-actions.pod:1259 ../fish/guestfish-actions.pod:1572 ../fish/guestfish-actions.pod:1582 ../fish/guestfish-actions.pod:1632 ../fish/guestfish-actions.pod:1647 ../fish/guestfish-actions.pod:1657 ../fish/guestfish-actions.pod:1676 ../fish/guestfish-actions.pod:3779 ../fish/guestfish-actions.pod:3794 ../fish/guestfish-actions.pod:3870 ../fish/guestfish-actions.pod:3887 ../fish/guestfish-actions.pod:3902 ../fish/guestfish-actions.pod:4583 ../fish/guestfish-actions.pod:4629 ../fish/guestfish-actions.pod:4714 ../fish/guestfish-actions.pod:4729 ../fish/guestfish-actions.pod:5135 ../fish/guestfish-actions.pod:5147 ../fish/guestfish-actions.pod:5165 ../fish/guestfish-actions.pod:5182 ../fish/guestfish-actions.pod:5192 ../fish/guestfish-actions.pod:5249 ../fish/guestfish-actions.pod:5259 ../fish/guestfish-actions.pod:5288 ../fish/guestfish-actions.pod:5298 ../src/guestfs-actions.pod:948 ../src/guestfs-actions.pod:1127 ../src/guestfs-actions.pod:1147 ../src/guestfs-actions.pod:1550 ../src/guestfs-actions.pod:1569 ../src/guestfs-actions.pod:1672 ../src/guestfs-actions.pod:1691 ../src/guestfs-actions.pod:1937 ../src/guestfs-actions.pod:2417 ../src/guestfs-actions.pod:2436 ../src/guestfs-actions.pod:2501 ../src/guestfs-actions.pod:2525 ../src/guestfs-actions.pod:2542 ../src/guestfs-actions.pod:2571 ../src/guestfs-actions.pod:5761 ../src/guestfs-actions.pod:5787 ../src/guestfs-actions.pod:5918 ../src/guestfs-actions.pod:5944 ../src/guestfs-actions.pod:5968 ../src/guestfs-actions.pod:6933 ../src/guestfs-actions.pod:6988 ../src/guestfs-actions.pod:7134 ../src/guestfs-actions.pod:7158 ../src/guestfs-actions.pod:7823 ../src/guestfs-actions.pod:7843 ../src/guestfs-actions.pod:7876 ../src/guestfs-actions.pod:7895 ../src/guestfs-actions.pod:7914 ../src/guestfs-actions.pod:8008 ../src/guestfs-actions.pod:8027 ../src/guestfs-actions.pod:8073 ../src/guestfs-actions.pod:8092
5169 msgid ""
5170 "Because of the message protocol, there is a transfer limit of somewhere "
5171 "between 2MB and 4MB.  See L<guestfs(3)/PROTOCOL LIMITS>."
5172 msgstr ""
5173
5174 #. type: =head2
5175 #: ../fish/guestfish-actions.pod:625
5176 msgid "checksum"
5177 msgstr ""
5178
5179 #. type: verbatim
5180 #: ../fish/guestfish-actions.pod:627
5181 #, no-wrap
5182 msgid ""
5183 " checksum csumtype path\n"
5184 "\n"
5185 msgstr ""
5186
5187 #. type: textblock
5188 #: ../fish/guestfish-actions.pod:629 ../src/guestfs-actions.pod:960
5189 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5190 msgstr ""
5191
5192 #. type: textblock
5193 #: ../fish/guestfish-actions.pod:632 ../src/guestfs-actions.pod:963
5194 msgid ""
5195 "The type of checksum to compute is given by the C<csumtype> parameter which "
5196 "must have one of the following values:"
5197 msgstr ""
5198
5199 #. type: =item
5200 #: ../fish/guestfish-actions.pod:637 ../src/guestfs-actions.pod:968
5201 msgid "C<crc>"
5202 msgstr ""
5203
5204 #. type: textblock
5205 #: ../fish/guestfish-actions.pod:639 ../src/guestfs-actions.pod:970
5206 msgid ""
5207 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5208 "C<cksum> command."
5209 msgstr ""
5210
5211 #. type: =item
5212 #: ../fish/guestfish-actions.pod:642 ../src/guestfs-actions.pod:973
5213 msgid "C<md5>"
5214 msgstr ""
5215
5216 #. type: textblock
5217 #: ../fish/guestfish-actions.pod:644 ../src/guestfs-actions.pod:975
5218 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5219 msgstr ""
5220
5221 #. type: =item
5222 #: ../fish/guestfish-actions.pod:646 ../src/guestfs-actions.pod:977
5223 msgid "C<sha1>"
5224 msgstr ""
5225
5226 #. type: textblock
5227 #: ../fish/guestfish-actions.pod:648 ../src/guestfs-actions.pod:979
5228 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5229 msgstr ""
5230
5231 #. type: =item
5232 #: ../fish/guestfish-actions.pod:650 ../src/guestfs-actions.pod:981
5233 msgid "C<sha224>"
5234 msgstr ""
5235
5236 #. type: textblock
5237 #: ../fish/guestfish-actions.pod:652 ../src/guestfs-actions.pod:983
5238 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5239 msgstr ""
5240
5241 #. type: =item
5242 #: ../fish/guestfish-actions.pod:654 ../src/guestfs-actions.pod:985
5243 msgid "C<sha256>"
5244 msgstr ""
5245
5246 #. type: textblock
5247 #: ../fish/guestfish-actions.pod:656 ../src/guestfs-actions.pod:987
5248 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5249 msgstr ""
5250
5251 #. type: =item
5252 #: ../fish/guestfish-actions.pod:658 ../src/guestfs-actions.pod:989
5253 msgid "C<sha384>"
5254 msgstr ""
5255
5256 #. type: textblock
5257 #: ../fish/guestfish-actions.pod:660 ../src/guestfs-actions.pod:991
5258 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5259 msgstr ""
5260
5261 #. type: =item
5262 #: ../fish/guestfish-actions.pod:662 ../src/guestfs-actions.pod:993
5263 msgid "C<sha512>"
5264 msgstr ""
5265
5266 #. type: textblock
5267 #: ../fish/guestfish-actions.pod:664 ../src/guestfs-actions.pod:995
5268 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5269 msgstr ""
5270
5271 #. type: textblock
5272 #: ../fish/guestfish-actions.pod:668 ../src/guestfs-actions.pod:999
5273 msgid "The checksum is returned as a printable string."
5274 msgstr ""
5275
5276 #. type: textblock
5277 #: ../fish/guestfish-actions.pod:670
5278 msgid "To get the checksum for a device, use L</checksum-device>."
5279 msgstr ""
5280
5281 #. type: textblock
5282 #: ../fish/guestfish-actions.pod:672
5283 msgid "To get the checksums for many files, use L</checksums-out>."
5284 msgstr ""
5285
5286 #. type: =head2
5287 #: ../fish/guestfish-actions.pod:674
5288 msgid "checksum-device"
5289 msgstr ""
5290
5291 #. type: verbatim
5292 #: ../fish/guestfish-actions.pod:676
5293 #, no-wrap
5294 msgid ""
5295 " checksum-device csumtype device\n"
5296 "\n"
5297 msgstr ""
5298
5299 #. type: textblock
5300 #: ../fish/guestfish-actions.pod:678
5301 msgid ""
5302 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5303 "device named C<device>.  For the types of checksums supported see the "
5304 "L</checksum> command."
5305 msgstr ""
5306
5307 #. type: =head2
5308 #: ../fish/guestfish-actions.pod:682
5309 msgid "checksums-out"
5310 msgstr ""
5311
5312 #. type: verbatim
5313 #: ../fish/guestfish-actions.pod:684
5314 #, no-wrap
5315 msgid ""
5316 " checksums-out csumtype directory (sumsfile|-)\n"
5317 "\n"
5318 msgstr ""
5319
5320 #. type: textblock
5321 #: ../fish/guestfish-actions.pod:686 ../src/guestfs-actions.pod:1034
5322 msgid ""
5323 "This command computes the checksums of all regular files in C<directory> and "
5324 "then emits a list of those checksums to the local output file C<sumsfile>."
5325 msgstr ""
5326
5327 #. type: textblock
5328 #: ../fish/guestfish-actions.pod:690 ../src/guestfs-actions.pod:1038
5329 msgid ""
5330 "This can be used for verifying the integrity of a virtual machine.  However "
5331 "to be properly secure you should pay attention to the output of the checksum "
5332 "command (it uses the ones from GNU coreutils).  In particular when the "
5333 "filename is not printable, coreutils uses a special backslash syntax.  For "
5334 "more information, see the GNU coreutils info file."
5335 msgstr ""
5336
5337 #. type: =head2
5338 #: ../fish/guestfish-actions.pod:700
5339 msgid "chmod"
5340 msgstr ""
5341
5342 #. type: verbatim
5343 #: ../fish/guestfish-actions.pod:702
5344 #, no-wrap
5345 msgid ""
5346 " chmod mode path\n"
5347 "\n"
5348 msgstr ""
5349
5350 #. type: textblock
5351 #: ../fish/guestfish-actions.pod:704 ../src/guestfs-actions.pod:1057
5352 msgid ""
5353 "Change the mode (permissions) of C<path> to C<mode>.  Only numeric modes are "
5354 "supported."
5355 msgstr ""
5356
5357 #. type: textblock
5358 #: ../fish/guestfish-actions.pod:707 ../src/guestfs-actions.pod:1060
5359 msgid ""
5360 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5361 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5362 "C<700>."
5363 msgstr ""
5364
5365 #. type: textblock
5366 #: ../fish/guestfish-actions.pod:711 ../fish/guestfish-actions.pod:3132 ../fish/guestfish-actions.pod:3271 ../fish/guestfish-actions.pod:3281 ../fish/guestfish-actions.pod:3291 ../src/guestfs-actions.pod:1064 ../src/guestfs-actions.pod:4733 ../src/guestfs-actions.pod:4942 ../src/guestfs-actions.pod:4961 ../src/guestfs-actions.pod:4980
5367 msgid "The mode actually set is affected by the umask."
5368 msgstr ""
5369
5370 #. type: =head2
5371 #: ../fish/guestfish-actions.pod:713
5372 msgid "chown"
5373 msgstr ""
5374
5375 #. type: verbatim
5376 #: ../fish/guestfish-actions.pod:715
5377 #, no-wrap
5378 msgid ""
5379 " chown owner group path\n"
5380 "\n"
5381 msgstr ""
5382
5383 #. type: textblock
5384 #: ../fish/guestfish-actions.pod:717 ../src/guestfs-actions.pod:1078
5385 msgid "Change the file owner to C<owner> and group to C<group>."
5386 msgstr ""
5387
5388 #. type: textblock
5389 #: ../fish/guestfish-actions.pod:719 ../fish/guestfish-actions.pod:2567 ../src/guestfs-actions.pod:1080 ../src/guestfs-actions.pod:3804
5390 msgid ""
5391 "Only numeric uid and gid are supported.  If you want to use names, you will "
5392 "need to locate and parse the password file yourself (Augeas support makes "
5393 "this relatively easy)."
5394 msgstr ""
5395
5396 #. type: =head2
5397 #: ../fish/guestfish-actions.pod:723
5398 msgid "command"
5399 msgstr ""
5400
5401 #. type: verbatim
5402 #: ../fish/guestfish-actions.pod:725
5403 #, no-wrap
5404 msgid ""
5405 " command 'arguments ...'\n"
5406 "\n"
5407 msgstr ""
5408
5409 #. type: textblock
5410 #: ../fish/guestfish-actions.pod:727 ../src/guestfs-actions.pod:1094
5411 msgid ""
5412 "This call runs a command from the guest filesystem.  The filesystem must be "
5413 "mounted, and must contain a compatible operating system (ie. something "
5414 "Linux, with the same or compatible processor architecture)."
5415 msgstr ""
5416
5417 #. type: textblock
5418 #: ../fish/guestfish-actions.pod:732
5419 msgid ""
5420 "The single parameter is an argv-style list of arguments.  The first element "
5421 "is the name of the program to run.  Subsequent elements are parameters.  The "
5422 "list must be non-empty (ie. must contain a program name).  Note that the "
5423 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
5424 msgstr ""
5425
5426 #. type: textblock
5427 #: ../fish/guestfish-actions.pod:739 ../src/guestfs-actions.pod:1106
5428 msgid "The return value is anything printed to I<stdout> by the command."
5429 msgstr ""
5430
5431 #. type: textblock
5432 #: ../fish/guestfish-actions.pod:742 ../src/guestfs-actions.pod:1109
5433 msgid ""
5434 "If the command returns a non-zero exit status, then this function returns an "
5435 "error message.  The error message string is the content of I<stderr> from "
5436 "the command."
5437 msgstr ""
5438
5439 #. type: textblock
5440 #: ../fish/guestfish-actions.pod:746 ../src/guestfs-actions.pod:1113
5441 msgid ""
5442 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
5443 "C</bin>.  If you require a program from another location, you should provide "
5444 "the full path in the first parameter."
5445 msgstr ""
5446
5447 #. type: textblock
5448 #: ../fish/guestfish-actions.pod:751 ../src/guestfs-actions.pod:1118
5449 msgid ""
5450 "Shared libraries and data files required by the program must be available on "
5451 "filesystems which are mounted in the correct places.  It is the caller's "
5452 "responsibility to ensure all filesystems that are needed are mounted at the "
5453 "right locations."
5454 msgstr ""
5455
5456 #. type: =head2
5457 #: ../fish/guestfish-actions.pod:760
5458 msgid "command-lines"
5459 msgstr ""
5460
5461 #. type: verbatim
5462 #: ../fish/guestfish-actions.pod:762
5463 #, no-wrap
5464 msgid ""
5465 " command-lines 'arguments ...'\n"
5466 "\n"
5467 msgstr ""
5468
5469 #. type: textblock
5470 #: ../fish/guestfish-actions.pod:764
5471 msgid "This is the same as L</command>, but splits the result into a list of lines."
5472 msgstr ""
5473
5474 #. type: textblock
5475 #: ../fish/guestfish-actions.pod:767
5476 msgid "See also: L</sh-lines>"
5477 msgstr ""
5478
5479 #. type: =head2
5480 #: ../fish/guestfish-actions.pod:772
5481 msgid "compress-device-out"
5482 msgstr ""
5483
5484 #. type: verbatim
5485 #: ../fish/guestfish-actions.pod:774
5486 #, no-wrap
5487 msgid ""
5488 " compress-device-out ctype device (zdevice|-) [level:..]\n"
5489 "\n"
5490 msgstr ""
5491
5492 #. type: textblock
5493 #: ../fish/guestfish-actions.pod:776 ../src/guestfs-actions.pod:1168
5494 msgid ""
5495 "This command compresses C<device> and writes it out to the local file "
5496 "C<zdevice>."
5497 msgstr ""
5498
5499 #. type: textblock
5500 #: ../fish/guestfish-actions.pod:779
5501 msgid ""
5502 "The C<ctype> and optional C<level> parameters have the same meaning as in "
5503 "L</compress-out>."
5504 msgstr ""
5505
5506 #. type: =head2
5507 #: ../fish/guestfish-actions.pod:786
5508 msgid "compress-out"
5509 msgstr ""
5510
5511 #. type: verbatim
5512 #: ../fish/guestfish-actions.pod:788
5513 #, no-wrap
5514 msgid ""
5515 " compress-out ctype file (zfile|-) [level:..]\n"
5516 "\n"
5517 msgstr ""
5518
5519 #. type: textblock
5520 #: ../fish/guestfish-actions.pod:790 ../src/guestfs-actions.pod:1218
5521 msgid ""
5522 "This command compresses C<file> and writes it out to the local file "
5523 "C<zfile>."
5524 msgstr ""
5525
5526 #. type: textblock
5527 #: ../fish/guestfish-actions.pod:793 ../src/guestfs-actions.pod:1221
5528 msgid ""
5529 "The compression program used is controlled by the C<ctype> parameter.  "
5530 "Currently this includes: C<compress>, C<gzip>, C<bzip2>, C<xz> or C<lzop>.  "
5531 "Some compression types may not be supported by particular builds of "
5532 "libguestfs, in which case you will get an error containing the substring "
5533 "\"not supported\"."
5534 msgstr ""
5535
5536 #. type: textblock
5537 #: ../fish/guestfish-actions.pod:799 ../src/guestfs-actions.pod:1227
5538 msgid ""
5539 "The optional C<level> parameter controls compression level.  The meaning and "
5540 "default for this parameter depends on the compression program being used."
5541 msgstr ""
5542
5543 #. type: =head2
5544 #: ../fish/guestfish-actions.pod:807
5545 msgid "config"
5546 msgstr ""
5547
5548 #. type: verbatim
5549 #: ../fish/guestfish-actions.pod:809
5550 #, no-wrap
5551 msgid ""
5552 " config qemuparam qemuvalue\n"
5553 "\n"
5554 msgstr ""
5555
5556 #. type: textblock
5557 #: ../fish/guestfish-actions.pod:811 ../src/guestfs-actions.pod:1266
5558 msgid ""
5559 "This can be used to add arbitrary qemu command line parameters of the form "
5560 "I<-param value>.  Actually it's not quite arbitrary - we prevent you from "
5561 "setting some parameters which would interfere with parameters that we use."
5562 msgstr ""
5563
5564 #. type: textblock
5565 #: ../fish/guestfish-actions.pod:816 ../src/guestfs-actions.pod:1271
5566 msgid "The first character of C<param> string must be a C<-> (dash)."
5567 msgstr ""
5568
5569 #. type: textblock
5570 #: ../fish/guestfish-actions.pod:818 ../src/guestfs-actions.pod:1273
5571 msgid "C<value> can be NULL."
5572 msgstr ""
5573
5574 #. type: =head2
5575 #: ../fish/guestfish-actions.pod:820
5576 msgid "copy-size"
5577 msgstr ""
5578
5579 #. type: verbatim
5580 #: ../fish/guestfish-actions.pod:822
5581 #, no-wrap
5582 msgid ""
5583 " copy-size src dest size\n"
5584 "\n"
5585 msgstr ""
5586
5587 #. type: textblock
5588 #: ../fish/guestfish-actions.pod:824 ../src/guestfs-actions.pod:1287
5589 msgid ""
5590 "This command copies exactly C<size> bytes from one source device or file "
5591 "C<src> to another destination device or file C<dest>."
5592 msgstr ""
5593
5594 #. type: textblock
5595 #: ../fish/guestfish-actions.pod:827 ../src/guestfs-actions.pod:1290
5596 msgid ""
5597 "Note this will fail if the source is too short or if the destination is not "
5598 "large enough."
5599 msgstr ""
5600
5601 #. type: =head2
5602 #: ../fish/guestfish-actions.pod:830
5603 msgid "cp"
5604 msgstr ""
5605
5606 #. type: verbatim
5607 #: ../fish/guestfish-actions.pod:832
5608 #, no-wrap
5609 msgid ""
5610 " cp src dest\n"
5611 "\n"
5612 msgstr ""
5613
5614 #. type: textblock
5615 #: ../fish/guestfish-actions.pod:834 ../src/guestfs-actions.pod:1309
5616 msgid ""
5617 "This copies a file from C<src> to C<dest> where C<dest> is either a "
5618 "destination filename or destination directory."
5619 msgstr ""
5620
5621 #. type: =head2
5622 #: ../fish/guestfish-actions.pod:837
5623 msgid "cp-a"
5624 msgstr ""
5625
5626 #. type: verbatim
5627 #: ../fish/guestfish-actions.pod:839
5628 #, no-wrap
5629 msgid ""
5630 " cp-a src dest\n"
5631 "\n"
5632 msgstr ""
5633
5634 #. type: textblock
5635 #: ../fish/guestfish-actions.pod:841 ../src/guestfs-actions.pod:1323
5636 msgid ""
5637 "This copies a file or directory from C<src> to C<dest> recursively using the "
5638 "C<cp -a> command."
5639 msgstr ""
5640
5641 #. type: =head2
5642 #: ../fish/guestfish-actions.pod:844
5643 msgid "dd"
5644 msgstr ""
5645
5646 #. type: verbatim
5647 #: ../fish/guestfish-actions.pod:846
5648 #, no-wrap
5649 msgid ""
5650 " dd src dest\n"
5651 "\n"
5652 msgstr ""
5653
5654 #. type: textblock
5655 #: ../fish/guestfish-actions.pod:848 ../src/guestfs-actions.pod:1337
5656 msgid ""
5657 "This command copies from one source device or file C<src> to another "
5658 "destination device or file C<dest>.  Normally you would use this to copy to "
5659 "or from a device or partition, for example to duplicate a filesystem."
5660 msgstr ""
5661
5662 #. type: textblock
5663 #: ../fish/guestfish-actions.pod:853
5664 msgid ""
5665 "If the destination is a device, it must be as large or larger than the "
5666 "source file or device, otherwise the copy will fail.  This command cannot do "
5667 "partial copies (see L</copy-size>)."
5668 msgstr ""
5669
5670 #. type: =head2
5671 #: ../fish/guestfish-actions.pod:857
5672 msgid "df"
5673 msgstr ""
5674
5675 #. type: verbatim
5676 #: ../fish/guestfish-actions.pod:859
5677 #, no-wrap
5678 msgid ""
5679 " df\n"
5680 "\n"
5681 msgstr ""
5682
5683 #. type: textblock
5684 #: ../fish/guestfish-actions.pod:861 ../src/guestfs-actions.pod:1355
5685 msgid "This command runs the C<df> command to report disk space used."
5686 msgstr ""
5687
5688 #. type: textblock
5689 #: ../fish/guestfish-actions.pod:863 ../fish/guestfish-actions.pod:874
5690 msgid ""
5691 "This command is mostly useful for interactive sessions.  It is I<not> "
5692 "intended that you try to parse the output string.  Use L</statvfs> from "
5693 "programs."
5694 msgstr ""
5695
5696 #. type: =head2
5697 #: ../fish/guestfish-actions.pod:867
5698 msgid "df-h"
5699 msgstr ""
5700
5701 #. type: verbatim
5702 #: ../fish/guestfish-actions.pod:869
5703 #, no-wrap
5704 msgid ""
5705 " df-h\n"
5706 "\n"
5707 msgstr ""
5708
5709 #. type: textblock
5710 #: ../fish/guestfish-actions.pod:871 ../src/guestfs-actions.pod:1371
5711 msgid ""
5712 "This command runs the C<df -h> command to report disk space used in "
5713 "human-readable format."
5714 msgstr ""
5715
5716 #. type: =head2
5717 #: ../fish/guestfish-actions.pod:878
5718 msgid "dmesg"
5719 msgstr ""
5720
5721 #. type: verbatim
5722 #: ../fish/guestfish-actions.pod:880
5723 #, no-wrap
5724 msgid ""
5725 " dmesg\n"
5726 "\n"
5727 msgstr ""
5728
5729 #. type: textblock
5730 #: ../fish/guestfish-actions.pod:882 ../src/guestfs-actions.pod:1388
5731 msgid ""
5732 "This returns the kernel messages (C<dmesg> output) from the guest kernel.  "
5733 "This is sometimes useful for extended debugging of problems."
5734 msgstr ""
5735
5736 #. type: textblock
5737 #: ../fish/guestfish-actions.pod:886
5738 msgid ""
5739 "Another way to get the same information is to enable verbose messages with "
5740 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
5741 "before running the program."
5742 msgstr ""
5743
5744 #. type: =head2
5745 #: ../fish/guestfish-actions.pod:891
5746 msgid "download"
5747 msgstr ""
5748
5749 #. type: verbatim
5750 #: ../fish/guestfish-actions.pod:893
5751 #, no-wrap
5752 msgid ""
5753 " download remotefilename (filename|-)\n"
5754 "\n"
5755 msgstr ""
5756
5757 #. type: textblock
5758 #: ../fish/guestfish-actions.pod:895 ../fish/guestfish-actions.pod:908 ../src/guestfs-actions.pod:1409 ../src/guestfs-actions.pod:1434
5759 msgid ""
5760 "Download file C<remotefilename> and save it as C<filename> on the local "
5761 "machine."
5762 msgstr ""
5763
5764 #. type: textblock
5765 #: ../fish/guestfish-actions.pod:898 ../fish/guestfish-actions.pod:4887 ../src/guestfs-actions.pod:1412 ../src/guestfs-actions.pod:7393
5766 msgid "C<filename> can also be a named pipe."
5767 msgstr ""
5768
5769 #. type: textblock
5770 #: ../fish/guestfish-actions.pod:900
5771 msgid "See also L</upload>, L</cat>."
5772 msgstr ""
5773
5774 #. type: =head2
5775 #: ../fish/guestfish-actions.pod:904
5776 msgid "download-offset"
5777 msgstr ""
5778
5779 #. type: verbatim
5780 #: ../fish/guestfish-actions.pod:906
5781 #, no-wrap
5782 msgid ""
5783 " download-offset remotefilename (filename|-) offset size\n"
5784 "\n"
5785 msgstr ""
5786
5787 #. type: textblock
5788 #: ../fish/guestfish-actions.pod:911 ../src/guestfs-actions.pod:1437
5789 msgid ""
5790 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
5791 "region must be within the file or device)."
5792 msgstr ""
5793
5794 #. type: textblock
5795 #: ../fish/guestfish-actions.pod:914
5796 msgid ""
5797 "Note that there is no limit on the amount of data that can be downloaded "
5798 "with this call, unlike with L</pread>, and this call always reads the full "
5799 "amount unless an error occurs."
5800 msgstr ""
5801
5802 #. type: textblock
5803 #: ../fish/guestfish-actions.pod:919
5804 msgid "See also L</download>, L</pread>."
5805 msgstr ""
5806
5807 #. type: =head2
5808 #: ../fish/guestfish-actions.pod:923
5809 msgid "drop-caches"
5810 msgstr ""
5811
5812 #. type: verbatim
5813 #: ../fish/guestfish-actions.pod:925
5814 #, no-wrap
5815 msgid ""
5816 " drop-caches whattodrop\n"
5817 "\n"
5818 msgstr ""
5819
5820 #. type: textblock
5821 #: ../fish/guestfish-actions.pod:927 ../src/guestfs-actions.pod:1462
5822 msgid ""
5823 "This instructs the guest kernel to drop its page cache, and/or dentries and "
5824 "inode caches.  The parameter C<whattodrop> tells the kernel what precisely "
5825 "to drop, see L<http://linux-mm.org/Drop_Caches>"
5826 msgstr ""
5827
5828 #. type: textblock
5829 #: ../fish/guestfish-actions.pod:932 ../src/guestfs-actions.pod:1467
5830 msgid "Setting C<whattodrop> to 3 should drop everything."
5831 msgstr ""
5832
5833 #. type: textblock
5834 #: ../fish/guestfish-actions.pod:934 ../src/guestfs-actions.pod:1469
5835 msgid ""
5836 "This automatically calls L<sync(2)> before the operation, so that the "
5837 "maximum guest memory is freed."
5838 msgstr ""
5839
5840 #. type: =head2
5841 #: ../fish/guestfish-actions.pod:937
5842 msgid "du"
5843 msgstr ""
5844
5845 #. type: verbatim
5846 #: ../fish/guestfish-actions.pod:939
5847 #, no-wrap
5848 msgid ""
5849 " du path\n"
5850 "\n"
5851 msgstr ""
5852
5853 #. type: textblock
5854 #: ../fish/guestfish-actions.pod:941 ../src/guestfs-actions.pod:1482
5855 msgid ""
5856 "This command runs the C<du -s> command to estimate file space usage for "
5857 "C<path>."
5858 msgstr ""
5859
5860 #. type: textblock
5861 #: ../fish/guestfish-actions.pod:944 ../src/guestfs-actions.pod:1485
5862 msgid ""
5863 "C<path> can be a file or a directory.  If C<path> is a directory then the "
5864 "estimate includes the contents of the directory and all subdirectories "
5865 "(recursively)."
5866 msgstr ""
5867
5868 #. type: textblock
5869 #: ../fish/guestfish-actions.pod:948 ../src/guestfs-actions.pod:1489
5870 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
5871 msgstr ""
5872
5873 #. type: =head2
5874 #: ../fish/guestfish-actions.pod:951
5875 msgid "e2fsck-f"
5876 msgstr ""
5877
5878 #. type: verbatim
5879 #: ../fish/guestfish-actions.pod:953
5880 #, no-wrap
5881 msgid ""
5882 " e2fsck-f device\n"
5883 "\n"
5884 msgstr ""
5885
5886 #. type: textblock
5887 #: ../fish/guestfish-actions.pod:955 ../src/guestfs-actions.pod:1507
5888 msgid ""
5889 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
5890 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
5891 "clean (I<-f>)."
5892 msgstr ""
5893
5894 #. type: textblock
5895 #: ../fish/guestfish-actions.pod:959
5896 msgid ""
5897 "This command is only needed because of L</resize2fs> (q.v.).  Normally you "
5898 "should use L</fsck>."
5899 msgstr ""
5900
5901 #. type: =head2
5902 #: ../fish/guestfish-actions.pod:962
5903 msgid "echo-daemon"
5904 msgstr ""
5905
5906 #. type: verbatim
5907 #: ../fish/guestfish-actions.pod:964
5908 #, no-wrap
5909 msgid ""
5910 " echo-daemon 'words ...'\n"
5911 "\n"
5912 msgstr ""
5913
5914 #. type: textblock
5915 #: ../fish/guestfish-actions.pod:966 ../src/guestfs-actions.pod:1524
5916 msgid ""
5917 "This command concatenates the list of C<words> passed with single spaces "
5918 "between them and returns the resulting string."
5919 msgstr ""
5920
5921 #. type: textblock
5922 #: ../fish/guestfish-actions.pod:969 ../src/guestfs-actions.pod:1527
5923 msgid "You can use this command to test the connection through to the daemon."
5924 msgstr ""
5925
5926 #. type: textblock
5927 #: ../fish/guestfish-actions.pod:971
5928 msgid "See also L</ping-daemon>."
5929 msgstr ""
5930
5931 #. type: =head2
5932 #: ../fish/guestfish-actions.pod:973
5933 msgid "egrep"
5934 msgstr ""
5935
5936 #. type: verbatim
5937 #: ../fish/guestfish-actions.pod:975
5938 #, no-wrap
5939 msgid ""
5940 " egrep regex path\n"
5941 "\n"
5942 msgstr ""
5943
5944 #. type: textblock
5945 #: ../fish/guestfish-actions.pod:977 ../src/guestfs-actions.pod:1543
5946 msgid "This calls the external C<egrep> program and returns the matching lines."
5947 msgstr ""
5948
5949 #. type: =head2
5950 #: ../fish/guestfish-actions.pod:983
5951 msgid "egrepi"
5952 msgstr ""
5953
5954 #. type: verbatim
5955 #: ../fish/guestfish-actions.pod:985
5956 #, no-wrap
5957 msgid ""
5958 " egrepi regex path\n"
5959 "\n"
5960 msgstr ""
5961
5962 #. type: textblock
5963 #: ../fish/guestfish-actions.pod:987 ../src/guestfs-actions.pod:1562
5964 msgid "This calls the external C<egrep -i> program and returns the matching lines."
5965 msgstr ""
5966
5967 #. type: =head2
5968 #: ../fish/guestfish-actions.pod:993
5969 msgid "equal"
5970 msgstr ""
5971
5972 #. type: verbatim
5973 #: ../fish/guestfish-actions.pod:995
5974 #, no-wrap
5975 msgid ""
5976 " equal file1 file2\n"
5977 "\n"
5978 msgstr ""
5979
5980 #. type: textblock
5981 #: ../fish/guestfish-actions.pod:997 ../src/guestfs-actions.pod:1581
5982 msgid ""
5983 "This compares the two files C<file1> and C<file2> and returns true if their "
5984 "content is exactly equal, or false otherwise."
5985 msgstr ""
5986
5987 #. type: textblock
5988 #: ../fish/guestfish-actions.pod:1000 ../src/guestfs-actions.pod:1584
5989 msgid "The external L<cmp(1)> program is used for the comparison."
5990 msgstr ""
5991
5992 #. type: =head2
5993 #: ../fish/guestfish-actions.pod:1002
5994 msgid "exists"
5995 msgstr ""
5996
5997 #. type: verbatim
5998 #: ../fish/guestfish-actions.pod:1004
5999 #, no-wrap
6000 msgid ""
6001 " exists path\n"
6002 "\n"
6003 msgstr ""
6004
6005 #. type: textblock
6006 #: ../fish/guestfish-actions.pod:1006 ../src/guestfs-actions.pod:1596
6007 msgid ""
6008 "This returns C<true> if and only if there is a file, directory (or anything) "
6009 "with the given C<path> name."
6010 msgstr ""
6011
6012 #. type: textblock
6013 #: ../fish/guestfish-actions.pod:1009
6014 msgid "See also L</is-file>, L</is-dir>, L</stat>."
6015 msgstr ""
6016
6017 #. type: =head2
6018 #: ../fish/guestfish-actions.pod:1011
6019 msgid "fallocate"
6020 msgstr ""
6021
6022 #. type: verbatim
6023 #: ../fish/guestfish-actions.pod:1013
6024 #, no-wrap
6025 msgid ""
6026 " fallocate path len\n"
6027 "\n"
6028 msgstr ""
6029
6030 #. type: textblock
6031 #: ../fish/guestfish-actions.pod:1015 ../fish/guestfish-actions.pod:1034 ../src/guestfs-actions.pod:1619 ../src/guestfs-actions.pod:1638
6032 msgid ""
6033 "This command preallocates a file (containing zero bytes) named C<path> of "
6034 "size C<len> bytes.  If the file exists already, it is overwritten."
6035 msgstr ""
6036
6037 #. type: textblock
6038 #: ../fish/guestfish-actions.pod:1019 ../src/guestfs-actions.pod:1623
6039 msgid ""
6040 "Do not confuse this with the guestfish-specific C<alloc> command which "
6041 "allocates a file in the host and attaches it as a device."
6042 msgstr ""
6043
6044 #. type: textblock
6045 #: ../fish/guestfish-actions.pod:1023
6046 msgid ""
6047 "I<This function is deprecated.> In new code, use the L</fallocate64> call "
6048 "instead."
6049 msgstr ""
6050
6051 #. type: =head2
6052 #: ../fish/guestfish-actions.pod:1030
6053 msgid "fallocate64"
6054 msgstr ""
6055
6056 #. type: verbatim
6057 #: ../fish/guestfish-actions.pod:1032
6058 #, no-wrap
6059 msgid ""
6060 " fallocate64 path len\n"
6061 "\n"
6062 msgstr ""
6063
6064 #. type: textblock
6065 #: ../fish/guestfish-actions.pod:1038
6066 msgid ""
6067 "Note that this call allocates disk blocks for the file.  To create a sparse "
6068 "file use L</truncate-size> instead."
6069 msgstr ""
6070
6071 #. type: textblock
6072 #: ../fish/guestfish-actions.pod:1041
6073 msgid ""
6074 "The deprecated call L</fallocate> does the same, but owing to an oversight "
6075 "it only allowed 30 bit lengths to be specified, effectively limiting the "
6076 "maximum size of files created through that call to 1GB."
6077 msgstr ""
6078
6079 #. type: textblock
6080 #: ../fish/guestfish-actions.pod:1046 ../src/guestfs-actions.pod:1650
6081 msgid ""
6082 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6083 "commands which create a file in the host and attach it as a device."
6084 msgstr ""
6085
6086 #. type: =head2
6087 #: ../fish/guestfish-actions.pod:1050
6088 msgid "fgrep"
6089 msgstr ""
6090
6091 #. type: verbatim
6092 #: ../fish/guestfish-actions.pod:1052
6093 #, no-wrap
6094 msgid ""
6095 " fgrep pattern path\n"
6096 "\n"
6097 msgstr ""
6098
6099 #. type: textblock
6100 #: ../fish/guestfish-actions.pod:1054 ../src/guestfs-actions.pod:1665
6101 msgid "This calls the external C<fgrep> program and returns the matching lines."
6102 msgstr ""
6103
6104 #. type: =head2
6105 #: ../fish/guestfish-actions.pod:1060
6106 msgid "fgrepi"
6107 msgstr ""
6108
6109 #. type: verbatim
6110 #: ../fish/guestfish-actions.pod:1062
6111 #, no-wrap
6112 msgid ""
6113 " fgrepi pattern path\n"
6114 "\n"
6115 msgstr ""
6116
6117 #. type: textblock
6118 #: ../fish/guestfish-actions.pod:1064 ../src/guestfs-actions.pod:1684
6119 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
6120 msgstr ""
6121
6122 #. type: =head2
6123 #: ../fish/guestfish-actions.pod:1070
6124 msgid "file"
6125 msgstr ""
6126
6127 #. type: verbatim
6128 #: ../fish/guestfish-actions.pod:1072
6129 #, no-wrap
6130 msgid ""
6131 " file path\n"
6132 "\n"
6133 msgstr ""
6134
6135 #. type: textblock
6136 #: ../fish/guestfish-actions.pod:1074 ../src/guestfs-actions.pod:1702
6137 msgid ""
6138 "This call uses the standard L<file(1)> command to determine the type or "
6139 "contents of the file."
6140 msgstr ""
6141
6142 #. type: textblock
6143 #: ../fish/guestfish-actions.pod:1077 ../src/guestfs-actions.pod:1705
6144 msgid ""
6145 "This call will also transparently look inside various types of compressed "
6146 "file."
6147 msgstr ""
6148
6149 #. type: textblock
6150 #: ../fish/guestfish-actions.pod:1080 ../src/guestfs-actions.pod:1708
6151 msgid ""
6152 "The exact command which runs is C<file -zb path>.  Note in particular that "
6153 "the filename is not prepended to the output (the I<-b> option)."
6154 msgstr ""
6155
6156 #. type: textblock
6157 #: ../fish/guestfish-actions.pod:1084 ../src/guestfs-actions.pod:1712
6158 msgid ""
6159 "The output depends on the output of the underlying L<file(1)> command and it "
6160 "can change in future in ways beyond our control.  In other words, the output "
6161 "is not guaranteed by the ABI."
6162 msgstr ""
6163
6164 #. type: textblock
6165 #: ../fish/guestfish-actions.pod:1088
6166 msgid ""
6167 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
6168 "(etc), L</is-zero>."
6169 msgstr ""
6170
6171 #. type: =head2
6172 #: ../fish/guestfish-actions.pod:1091
6173 msgid "file-architecture"
6174 msgstr ""
6175
6176 #. type: verbatim
6177 #: ../fish/guestfish-actions.pod:1093
6178 #, no-wrap
6179 msgid ""
6180 " file-architecture filename\n"
6181 "\n"
6182 msgstr ""
6183
6184 #. type: textblock
6185 #: ../fish/guestfish-actions.pod:1095 ../src/guestfs-actions.pod:1730
6186 msgid ""
6187 "This detects the architecture of the binary C<filename>, and returns it if "
6188 "known."
6189 msgstr ""
6190
6191 #. type: textblock
6192 #: ../fish/guestfish-actions.pod:1098 ../src/guestfs-actions.pod:1733
6193 msgid "Currently defined architectures are:"
6194 msgstr ""
6195
6196 #. type: =item
6197 #: ../fish/guestfish-actions.pod:1102 ../src/guestfs-actions.pod:1737
6198 msgid "\"i386\""
6199 msgstr ""
6200
6201 #. type: textblock
6202 #: ../fish/guestfish-actions.pod:1104 ../src/guestfs-actions.pod:1739
6203 msgid ""
6204 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6205 "irrespective of the precise processor requirements of the binary."
6206 msgstr ""
6207
6208 #. type: =item
6209 #: ../fish/guestfish-actions.pod:1107 ../src/guestfs-actions.pod:1742
6210 msgid "\"x86_64\""
6211 msgstr ""
6212
6213 #. type: textblock
6214 #: ../fish/guestfish-actions.pod:1109 ../src/guestfs-actions.pod:1744
6215 msgid "64 bit x86-64."
6216 msgstr ""
6217
6218 #. type: =item
6219 #: ../fish/guestfish-actions.pod:1111 ../src/guestfs-actions.pod:1746
6220 msgid "\"sparc\""
6221 msgstr ""
6222
6223 #. type: textblock
6224 #: ../fish/guestfish-actions.pod:1113 ../src/guestfs-actions.pod:1748
6225 msgid "32 bit SPARC."
6226 msgstr ""
6227
6228 #. type: =item
6229 #: ../fish/guestfish-actions.pod:1115 ../src/guestfs-actions.pod:1750
6230 msgid "\"sparc64\""
6231 msgstr ""
6232
6233 #. type: textblock
6234 #: ../fish/guestfish-actions.pod:1117 ../src/guestfs-actions.pod:1752
6235 msgid "64 bit SPARC V9 and above."
6236 msgstr ""
6237
6238 #. type: =item
6239 #: ../fish/guestfish-actions.pod:1119 ../src/guestfs-actions.pod:1754
6240 msgid "\"ia64\""
6241 msgstr ""
6242
6243 #. type: textblock
6244 #: ../fish/guestfish-actions.pod:1121 ../src/guestfs-actions.pod:1756
6245 msgid "Intel Itanium."
6246 msgstr ""
6247
6248 #. type: =item
6249 #: ../fish/guestfish-actions.pod:1123 ../src/guestfs-actions.pod:1758
6250 msgid "\"ppc\""
6251 msgstr ""
6252
6253 #. type: textblock
6254 #: ../fish/guestfish-actions.pod:1125 ../src/guestfs-actions.pod:1760
6255 msgid "32 bit Power PC."
6256 msgstr ""
6257
6258 #. type: =item
6259 #: ../fish/guestfish-actions.pod:1127 ../src/guestfs-actions.pod:1762
6260 msgid "\"ppc64\""
6261 msgstr ""
6262
6263 #. type: textblock
6264 #: ../fish/guestfish-actions.pod:1129 ../src/guestfs-actions.pod:1764
6265 msgid "64 bit Power PC."
6266 msgstr ""
6267
6268 #. type: textblock
6269 #: ../fish/guestfish-actions.pod:1133 ../src/guestfs-actions.pod:1768
6270 msgid "Libguestfs may return other architecture strings in future."
6271 msgstr ""
6272
6273 #. type: textblock
6274 #: ../fish/guestfish-actions.pod:1135 ../src/guestfs-actions.pod:1770
6275 msgid "The function works on at least the following types of files:"
6276 msgstr ""
6277
6278 #. type: textblock
6279 #: ../fish/guestfish-actions.pod:1141 ../src/guestfs-actions.pod:1776
6280 msgid "many types of Un*x and Linux binary"
6281 msgstr ""
6282
6283 #. type: textblock
6284 #: ../fish/guestfish-actions.pod:1145 ../src/guestfs-actions.pod:1780
6285 msgid "many types of Un*x and Linux shared library"
6286 msgstr ""
6287
6288 #. type: textblock
6289 #: ../fish/guestfish-actions.pod:1149 ../src/guestfs-actions.pod:1784
6290 msgid "Windows Win32 and Win64 binaries"
6291 msgstr ""
6292
6293 #. type: textblock
6294 #: ../fish/guestfish-actions.pod:1153 ../src/guestfs-actions.pod:1788
6295 msgid "Windows Win32 and Win64 DLLs"
6296 msgstr ""
6297
6298 #. type: textblock
6299 #: ../fish/guestfish-actions.pod:1155 ../src/guestfs-actions.pod:1790
6300 msgid "Win32 binaries and DLLs return C<i386>."
6301 msgstr ""
6302
6303 #. type: textblock
6304 #: ../fish/guestfish-actions.pod:1157 ../src/guestfs-actions.pod:1792
6305 msgid "Win64 binaries and DLLs return C<x86_64>."
6306 msgstr ""
6307
6308 #. type: textblock
6309 #: ../fish/guestfish-actions.pod:1161 ../src/guestfs-actions.pod:1796
6310 msgid "Linux kernel modules"
6311 msgstr ""
6312
6313 #. type: textblock
6314 #: ../fish/guestfish-actions.pod:1165 ../src/guestfs-actions.pod:1800
6315 msgid "Linux new-style initrd images"
6316 msgstr ""
6317
6318 #. type: textblock
6319 #: ../fish/guestfish-actions.pod:1169 ../src/guestfs-actions.pod:1804
6320 msgid "some non-x86 Linux vmlinuz kernels"
6321 msgstr ""
6322
6323 #. type: textblock
6324 #: ../fish/guestfish-actions.pod:1173 ../src/guestfs-actions.pod:1808
6325 msgid "What it can't do currently:"
6326 msgstr ""
6327
6328 #. type: textblock
6329 #: ../fish/guestfish-actions.pod:1179 ../src/guestfs-actions.pod:1814
6330 msgid "static libraries (libfoo.a)"
6331 msgstr ""
6332
6333 #. type: textblock
6334 #: ../fish/guestfish-actions.pod:1183 ../src/guestfs-actions.pod:1818
6335 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6336 msgstr ""
6337
6338 #. type: textblock
6339 #: ../fish/guestfish-actions.pod:1187 ../src/guestfs-actions.pod:1822
6340 msgid "x86 Linux vmlinuz kernels"
6341 msgstr ""
6342
6343 #. type: textblock
6344 #: ../fish/guestfish-actions.pod:1189 ../src/guestfs-actions.pod:1824
6345 msgid ""
6346 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6347 "compressed code, and are horribly hard to unpack.  If you want to find the "
6348 "architecture of a kernel, use the architecture of the associated initrd or "
6349 "kernel module(s) instead."
6350 msgstr ""
6351
6352 #. type: =head2
6353 #: ../fish/guestfish-actions.pod:1196
6354 msgid "filesize"
6355 msgstr ""
6356
6357 #. type: verbatim
6358 #: ../fish/guestfish-actions.pod:1198
6359 #, no-wrap
6360 msgid ""
6361 " filesize file\n"
6362 "\n"
6363 msgstr ""
6364
6365 #. type: textblock
6366 #: ../fish/guestfish-actions.pod:1200 ../src/guestfs-actions.pod:1842
6367 msgid "This command returns the size of C<file> in bytes."
6368 msgstr ""
6369
6370 #. type: textblock
6371 #: ../fish/guestfish-actions.pod:1202
6372 msgid ""
6373 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
6374 "L</is-file> etc.  To get the size of block devices, use "
6375 "L</blockdev-getsize64>."
6376 msgstr ""
6377
6378 #. type: =head2
6379 #: ../fish/guestfish-actions.pod:1206
6380 msgid "fill"
6381 msgstr ""
6382
6383 #. type: verbatim
6384 #: ../fish/guestfish-actions.pod:1208
6385 #, no-wrap
6386 msgid ""
6387 " fill c len path\n"
6388 "\n"
6389 msgstr ""
6390
6391 #. type: textblock
6392 #: ../fish/guestfish-actions.pod:1210 ../src/guestfs-actions.pod:1860
6393 msgid ""
6394 "This command creates a new file called C<path>.  The initial content of the "
6395 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
6396 "C<[0..255]>."
6397 msgstr ""
6398
6399 #. type: textblock
6400 #: ../fish/guestfish-actions.pod:1214
6401 msgid ""
6402 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6403 "L</truncate-size>.  To create a file with a pattern of repeating bytes use "
6404 "L</fill-pattern>."
6405 msgstr ""
6406
6407 #. type: =head2
6408 #: ../fish/guestfish-actions.pod:1219
6409 msgid "fill-pattern"
6410 msgstr ""
6411
6412 #. type: verbatim
6413 #: ../fish/guestfish-actions.pod:1221
6414 #, no-wrap
6415 msgid ""
6416 " fill-pattern pattern len path\n"
6417 "\n"
6418 msgstr ""
6419
6420 #. type: textblock
6421 #: ../fish/guestfish-actions.pod:1223
6422 msgid ""
6423 "This function is like L</fill> except that it creates a new file of length "
6424 "C<len> containing the repeating pattern of bytes in C<pattern>.  The pattern "
6425 "is truncated if necessary to ensure the length of the file is exactly C<len> "
6426 "bytes."
6427 msgstr ""
6428
6429 #. type: =head2
6430 #: ../fish/guestfish-actions.pod:1228
6431 msgid "find"
6432 msgstr ""
6433
6434 #. type: verbatim
6435 #: ../fish/guestfish-actions.pod:1230
6436 #, no-wrap
6437 msgid ""
6438 " find directory\n"
6439 "\n"
6440 msgstr ""
6441
6442 #. type: textblock
6443 #: ../fish/guestfish-actions.pod:1232 ../src/guestfs-actions.pod:1906
6444 msgid ""
6445 "This command lists out all files and directories, recursively, starting at "
6446 "C<directory>.  It is essentially equivalent to running the shell command "
6447 "C<find directory -print> but some post-processing happens on the output, "
6448 "described below."
6449 msgstr ""
6450
6451 #. type: textblock
6452 #: ../fish/guestfish-actions.pod:1237 ../src/guestfs-actions.pod:1911
6453 msgid ""
6454 "This returns a list of strings I<without any prefix>.  Thus if the directory "
6455 "structure was:"
6456 msgstr ""
6457
6458 #. type: verbatim
6459 #: ../fish/guestfish-actions.pod:1240 ../src/guestfs-actions.pod:1914
6460 #, no-wrap
6461 msgid ""
6462 " /tmp/a\n"
6463 " /tmp/b\n"
6464 " /tmp/c/d\n"
6465 "\n"
6466 msgstr ""
6467
6468 #. type: textblock
6469 #: ../fish/guestfish-actions.pod:1244
6470 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
6471 msgstr ""
6472
6473 #. type: verbatim
6474 #: ../fish/guestfish-actions.pod:1247 ../src/guestfs-actions.pod:1921
6475 #, no-wrap
6476 msgid ""
6477 " a\n"
6478 " b\n"
6479 " c\n"
6480 " c/d\n"
6481 "\n"
6482 msgstr ""
6483
6484 #. type: textblock
6485 #: ../fish/guestfish-actions.pod:1252 ../src/guestfs-actions.pod:1926
6486 msgid "If C<directory> is not a directory, then this command returns an error."
6487 msgstr ""
6488
6489 #. type: textblock
6490 #: ../fish/guestfish-actions.pod:1255 ../src/guestfs-actions.pod:1929
6491 msgid "The returned list is sorted."
6492 msgstr ""
6493
6494 #. type: textblock
6495 #: ../fish/guestfish-actions.pod:1257
6496 msgid "See also L</find0>."
6497 msgstr ""
6498
6499 #. type: =head2
6500 #: ../fish/guestfish-actions.pod:1262
6501 msgid "find0"
6502 msgstr ""
6503
6504 #. type: verbatim
6505 #: ../fish/guestfish-actions.pod:1264
6506 #, no-wrap
6507 msgid ""
6508 " find0 directory (files|-)\n"
6509 "\n"
6510 msgstr ""
6511
6512 #. type: textblock
6513 #: ../fish/guestfish-actions.pod:1266 ../src/guestfs-actions.pod:1949
6514 msgid ""
6515 "This command lists out all files and directories, recursively, starting at "
6516 "C<directory>, placing the resulting list in the external file called "
6517 "C<files>."
6518 msgstr ""
6519
6520 #. type: textblock
6521 #: ../fish/guestfish-actions.pod:1270
6522 msgid "This command works the same way as L</find> with the following exceptions:"
6523 msgstr ""
6524
6525 #. type: textblock
6526 #: ../fish/guestfish-actions.pod:1277 ../src/guestfs-actions.pod:1960
6527 msgid "The resulting list is written to an external file."
6528 msgstr ""
6529
6530 #. type: textblock
6531 #: ../fish/guestfish-actions.pod:1281 ../src/guestfs-actions.pod:1964
6532 msgid ""
6533 "Items (filenames) in the result are separated by C<\\0> characters.  See "
6534 "L<find(1)> option I<-print0>."
6535 msgstr ""
6536
6537 #. type: textblock
6538 #: ../fish/guestfish-actions.pod:1286 ../src/guestfs-actions.pod:1969
6539 msgid "This command is not limited in the number of names that it can return."
6540 msgstr ""
6541
6542 #. type: textblock
6543 #: ../fish/guestfish-actions.pod:1291 ../src/guestfs-actions.pod:1974
6544 msgid "The result list is not sorted."
6545 msgstr ""
6546
6547 #. type: =head2
6548 #: ../fish/guestfish-actions.pod:1297
6549 msgid "findfs-label"
6550 msgstr ""
6551
6552 #. type: verbatim
6553 #: ../fish/guestfish-actions.pod:1299
6554 #, no-wrap
6555 msgid ""
6556 " findfs-label label\n"
6557 "\n"
6558 msgstr ""
6559
6560 #. type: textblock
6561 #: ../fish/guestfish-actions.pod:1301 ../src/guestfs-actions.pod:1988
6562 msgid ""
6563 "This command searches the filesystems and returns the one which has the "
6564 "given label.  An error is returned if no such filesystem can be found."
6565 msgstr ""
6566
6567 #. type: textblock
6568 #: ../fish/guestfish-actions.pod:1305
6569 msgid "To find the label of a filesystem, use L</vfs-label>."
6570 msgstr ""
6571
6572 #. type: =head2
6573 #: ../fish/guestfish-actions.pod:1307
6574 msgid "findfs-uuid"
6575 msgstr ""
6576
6577 #. type: verbatim
6578 #: ../fish/guestfish-actions.pod:1309
6579 #, no-wrap
6580 msgid ""
6581 " findfs-uuid uuid\n"
6582 "\n"
6583 msgstr ""
6584
6585 #. type: textblock
6586 #: ../fish/guestfish-actions.pod:1311 ../src/guestfs-actions.pod:2005
6587 msgid ""
6588 "This command searches the filesystems and returns the one which has the "
6589 "given UUID.  An error is returned if no such filesystem can be found."
6590 msgstr ""
6591
6592 #. type: textblock
6593 #: ../fish/guestfish-actions.pod:1315
6594 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
6595 msgstr ""
6596
6597 #. type: =head2
6598 #: ../fish/guestfish-actions.pod:1317
6599 msgid "fsck"
6600 msgstr ""
6601
6602 #. type: verbatim
6603 #: ../fish/guestfish-actions.pod:1319
6604 #, no-wrap
6605 msgid ""
6606 " fsck fstype device\n"
6607 "\n"
6608 msgstr ""
6609
6610 #. type: textblock
6611 #: ../fish/guestfish-actions.pod:1321 ../src/guestfs-actions.pod:2023
6612 msgid ""
6613 "This runs the filesystem checker (fsck) on C<device> which should have "
6614 "filesystem type C<fstype>."
6615 msgstr ""
6616
6617 #. type: textblock
6618 #: ../fish/guestfish-actions.pod:1324 ../src/guestfs-actions.pod:2026
6619 msgid ""
6620 "The returned integer is the status.  See L<fsck(8)> for the list of status "
6621 "codes from C<fsck>."
6622 msgstr ""
6623
6624 #. type: textblock
6625 #: ../fish/guestfish-actions.pod:1333 ../src/guestfs-actions.pod:2035
6626 msgid "Multiple status codes can be summed together."
6627 msgstr ""
6628
6629 #. type: textblock
6630 #: ../fish/guestfish-actions.pod:1337 ../src/guestfs-actions.pod:2039
6631 msgid ""
6632 "A non-zero return code can mean \"success\", for example if errors have been "
6633 "corrected on the filesystem."
6634 msgstr ""
6635
6636 #. type: textblock
6637 #: ../fish/guestfish-actions.pod:1342 ../src/guestfs-actions.pod:2044
6638 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
6639 msgstr ""
6640
6641 #. type: textblock
6642 #: ../fish/guestfish-actions.pod:1347 ../src/guestfs-actions.pod:2049
6643 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
6644 msgstr ""
6645
6646 #. type: =head2
6647 #: ../fish/guestfish-actions.pod:1349
6648 msgid "get-append"
6649 msgstr ""
6650
6651 #. type: verbatim
6652 #: ../fish/guestfish-actions.pod:1351
6653 #, no-wrap
6654 msgid ""
6655 " get-append\n"
6656 "\n"
6657 msgstr ""
6658
6659 #. type: textblock
6660 #: ../fish/guestfish-actions.pod:1353 ../src/guestfs-actions.pod:2060
6661 msgid ""
6662 "Return the additional kernel options which are added to the guest kernel "
6663 "command line."
6664 msgstr ""
6665
6666 #. type: textblock
6667 #: ../fish/guestfish-actions.pod:1356 ../src/guestfs-actions.pod:2063
6668 msgid "If C<NULL> then no options are added."
6669 msgstr ""
6670
6671 #. type: =head2
6672 #: ../fish/guestfish-actions.pod:1358
6673 msgid "get-attach-method"
6674 msgstr ""
6675
6676 #. type: verbatim
6677 #: ../fish/guestfish-actions.pod:1360
6678 #, no-wrap
6679 msgid ""
6680 " get-attach-method\n"
6681 "\n"
6682 msgstr ""
6683
6684 #. type: textblock
6685 #: ../fish/guestfish-actions.pod:1362
6686 msgid "Return the current attach method.  See L</set-attach-method>."
6687 msgstr ""
6688
6689 #. type: =head2
6690 #: ../fish/guestfish-actions.pod:1364
6691 msgid "get-autosync"
6692 msgstr ""
6693
6694 #. type: verbatim
6695 #: ../fish/guestfish-actions.pod:1366
6696 #, no-wrap
6697 msgid ""
6698 " get-autosync\n"
6699 "\n"
6700 msgstr ""
6701
6702 #. type: textblock
6703 #: ../fish/guestfish-actions.pod:1368 ../src/guestfs-actions.pod:2088
6704 msgid "Get the autosync flag."
6705 msgstr ""
6706
6707 #. type: =head2
6708 #: ../fish/guestfish-actions.pod:1370
6709 msgid "get-direct"
6710 msgstr ""
6711
6712 #. type: verbatim
6713 #: ../fish/guestfish-actions.pod:1372
6714 #, no-wrap
6715 msgid ""
6716 " get-direct\n"
6717 "\n"
6718 msgstr ""
6719
6720 #. type: textblock
6721 #: ../fish/guestfish-actions.pod:1374 ../src/guestfs-actions.pod:2099
6722 msgid "Return the direct appliance mode flag."
6723 msgstr ""
6724
6725 #. type: =head2
6726 #: ../fish/guestfish-actions.pod:1376
6727 msgid "get-e2label"
6728 msgstr ""
6729
6730 #. type: verbatim
6731 #: ../fish/guestfish-actions.pod:1378
6732 #, no-wrap
6733 msgid ""
6734 " get-e2label device\n"
6735 "\n"
6736 msgstr ""
6737
6738 #. type: textblock
6739 #: ../fish/guestfish-actions.pod:1380 ../src/guestfs-actions.pod:2118
6740 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
6741 msgstr ""
6742
6743 #. type: textblock
6744 #: ../fish/guestfish-actions.pod:1383
6745 msgid ""
6746 "I<This function is deprecated.> In new code, use the L</vfs_label> call "
6747 "instead."
6748 msgstr ""
6749
6750 #. type: =head2
6751 #: ../fish/guestfish-actions.pod:1390
6752 msgid "get-e2uuid"
6753 msgstr ""
6754
6755 #. type: verbatim
6756 #: ../fish/guestfish-actions.pod:1392
6757 #, no-wrap
6758 msgid ""
6759 " get-e2uuid device\n"
6760 "\n"
6761 msgstr ""
6762
6763 #. type: textblock
6764 #: ../fish/guestfish-actions.pod:1394 ../src/guestfs-actions.pod:2139
6765 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
6766 msgstr ""
6767
6768 #. type: textblock
6769 #: ../fish/guestfish-actions.pod:1397
6770 msgid ""
6771 "I<This function is deprecated.> In new code, use the L</vfs_uuid> call "
6772 "instead."
6773 msgstr ""
6774
6775 #. type: =head2
6776 #: ../fish/guestfish-actions.pod:1404
6777 msgid "get-memsize"
6778 msgstr ""
6779
6780 #. type: verbatim
6781 #: ../fish/guestfish-actions.pod:1406
6782 #, no-wrap
6783 msgid ""
6784 " get-memsize\n"
6785 "\n"
6786 msgstr ""
6787
6788 #. type: textblock
6789 #: ../fish/guestfish-actions.pod:1408 ../src/guestfs-actions.pod:2152
6790 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
6791 msgstr ""
6792
6793 #. type: textblock
6794 #: ../fish/guestfish-actions.pod:1411
6795 msgid ""
6796 "If L</set-memsize> was not called on this handle, and if "
6797 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
6798 "value for memsize."
6799 msgstr ""
6800
6801 #. type: textblock
6802 #: ../fish/guestfish-actions.pod:1415 ../fish/guestfish-actions.pod:1472 ../fish/guestfish-actions.pod:4235 ../fish/guestfish-actions.pod:4337 ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:2251 ../src/guestfs-actions.pod:6440 ../src/guestfs-actions.pod:6566
6803 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
6804 msgstr ""
6805
6806 #. type: =head2
6807 #: ../fish/guestfish-actions.pod:1418
6808 msgid "get-network"
6809 msgstr ""
6810
6811 #. type: verbatim
6812 #: ../fish/guestfish-actions.pod:1420
6813 #, no-wrap
6814 msgid ""
6815 " get-network\n"
6816 "\n"
6817 msgstr ""
6818
6819 #. type: textblock
6820 #: ../fish/guestfish-actions.pod:1422 ../src/guestfs-actions.pod:2171
6821 msgid "This returns the enable network flag."
6822 msgstr ""
6823
6824 #. type: =head2
6825 #: ../fish/guestfish-actions.pod:1424
6826 msgid "get-path"
6827 msgstr ""
6828
6829 #. type: verbatim
6830 #: ../fish/guestfish-actions.pod:1426
6831 #, no-wrap
6832 msgid ""
6833 " get-path\n"
6834 "\n"
6835 msgstr ""
6836
6837 #. type: textblock
6838 #: ../fish/guestfish-actions.pod:1428 ../src/guestfs-actions.pod:2182
6839 msgid "Return the current search path."
6840 msgstr ""
6841
6842 #. type: textblock
6843 #: ../fish/guestfish-actions.pod:1430 ../src/guestfs-actions.pod:2184
6844 msgid ""
6845 "This is always non-NULL.  If it wasn't set already, then this will return "
6846 "the default path."
6847 msgstr ""
6848
6849 #. type: =head2
6850 #: ../fish/guestfish-actions.pod:1433
6851 msgid "get-pgroup"
6852 msgstr ""
6853
6854 #. type: verbatim
6855 #: ../fish/guestfish-actions.pod:1435
6856 #, no-wrap
6857 msgid ""
6858 " get-pgroup\n"
6859 "\n"
6860 msgstr ""
6861
6862 #. type: textblock
6863 #: ../fish/guestfish-actions.pod:1437 ../src/guestfs-actions.pod:2197
6864 msgid "This returns the process group flag."
6865 msgstr ""
6866
6867 #. type: =head2
6868 #: ../fish/guestfish-actions.pod:1439
6869 msgid "get-pid"
6870 msgstr ""
6871
6872 #. type: =head2
6873 #: ../fish/guestfish-actions.pod:1441
6874 msgid "pid"
6875 msgstr ""
6876
6877 #. type: verbatim
6878 #: ../fish/guestfish-actions.pod:1443
6879 #, no-wrap
6880 msgid ""
6881 " get-pid\n"
6882 "\n"
6883 msgstr ""
6884
6885 #. type: textblock
6886 #: ../fish/guestfish-actions.pod:1445 ../src/guestfs-actions.pod:2208
6887 msgid ""
6888 "Return the process ID of the qemu subprocess.  If there is no qemu "
6889 "subprocess, then this will return an error."
6890 msgstr ""
6891
6892 #. type: textblock
6893 #: ../fish/guestfish-actions.pod:1448 ../src/guestfs-actions.pod:2211
6894 msgid "This is an internal call used for debugging and testing."
6895 msgstr ""
6896
6897 #. type: =head2
6898 #: ../fish/guestfish-actions.pod:1450
6899 msgid "get-qemu"
6900 msgstr ""
6901
6902 #. type: verbatim
6903 #: ../fish/guestfish-actions.pod:1452
6904 #, no-wrap
6905 msgid ""
6906 " get-qemu\n"
6907 "\n"
6908 msgstr ""
6909
6910 #. type: textblock
6911 #: ../fish/guestfish-actions.pod:1454 ../src/guestfs-actions.pod:2222
6912 msgid "Return the current qemu binary."
6913 msgstr ""
6914
6915 #. type: textblock
6916 #: ../fish/guestfish-actions.pod:1456 ../src/guestfs-actions.pod:2224
6917 msgid ""
6918 "This is always non-NULL.  If it wasn't set already, then this will return "
6919 "the default qemu binary name."
6920 msgstr ""
6921
6922 #. type: =head2
6923 #: ../fish/guestfish-actions.pod:1459
6924 msgid "get-recovery-proc"
6925 msgstr ""
6926
6927 #. type: verbatim
6928 #: ../fish/guestfish-actions.pod:1461
6929 #, no-wrap
6930 msgid ""
6931 " get-recovery-proc\n"
6932 "\n"
6933 msgstr ""
6934
6935 #. type: textblock
6936 #: ../fish/guestfish-actions.pod:1463 ../src/guestfs-actions.pod:2237
6937 msgid "Return the recovery process enabled flag."
6938 msgstr ""
6939
6940 #. type: =head2
6941 #: ../fish/guestfish-actions.pod:1465
6942 msgid "get-selinux"
6943 msgstr ""
6944
6945 #. type: verbatim
6946 #: ../fish/guestfish-actions.pod:1467
6947 #, no-wrap
6948 msgid ""
6949 " get-selinux\n"
6950 "\n"
6951 msgstr ""
6952
6953 #. type: textblock
6954 #: ../fish/guestfish-actions.pod:1469
6955 msgid ""
6956 "This returns the current setting of the selinux flag which is passed to the "
6957 "appliance at boot time.  See L</set-selinux>."
6958 msgstr ""
6959
6960 #. type: =head2
6961 #: ../fish/guestfish-actions.pod:1475
6962 msgid "get-smp"
6963 msgstr ""
6964
6965 #. type: verbatim
6966 #: ../fish/guestfish-actions.pod:1477
6967 #, no-wrap
6968 msgid ""
6969 " get-smp\n"
6970 "\n"
6971 msgstr ""
6972
6973 #. type: textblock
6974 #: ../fish/guestfish-actions.pod:1479 ../src/guestfs-actions.pod:2263
6975 msgid "This returns the number of virtual CPUs assigned to the appliance."
6976 msgstr ""
6977
6978 #. type: =head2
6979 #: ../fish/guestfish-actions.pod:1481
6980 msgid "get-state"
6981 msgstr ""
6982
6983 #. type: verbatim
6984 #: ../fish/guestfish-actions.pod:1483
6985 #, no-wrap
6986 msgid ""
6987 " get-state\n"
6988 "\n"
6989 msgstr ""
6990
6991 #. type: textblock
6992 #: ../fish/guestfish-actions.pod:1485 ../src/guestfs-actions.pod:2272
6993 msgid ""
6994 "This returns the current state as an opaque integer.  This is only useful "
6995 "for printing debug and internal error messages."
6996 msgstr ""
6997
6998 #. type: textblock
6999 #: ../fish/guestfish-actions.pod:1488 ../fish/guestfish-actions.pod:2434 ../fish/guestfish-actions.pod:2452 ../fish/guestfish-actions.pod:2490 ../fish/guestfish-actions.pod:2506 ../src/guestfs-actions.pod:2275 ../src/guestfs-actions.pod:3581 ../src/guestfs-actions.pod:3610 ../src/guestfs-actions.pod:3671 ../src/guestfs-actions.pod:3698
7000 msgid "For more information on states, see L<guestfs(3)>."
7001 msgstr ""
7002
7003 #. type: =head2
7004 #: ../fish/guestfish-actions.pod:1490
7005 msgid "get-trace"
7006 msgstr ""
7007
7008 #. type: verbatim
7009 #: ../fish/guestfish-actions.pod:1492
7010 #, no-wrap
7011 msgid ""
7012 " get-trace\n"
7013 "\n"
7014 msgstr ""
7015
7016 #. type: textblock
7017 #: ../fish/guestfish-actions.pod:1494 ../src/guestfs-actions.pod:2286
7018 msgid "Return the command trace flag."
7019 msgstr ""
7020
7021 #. type: =head2
7022 #: ../fish/guestfish-actions.pod:1496
7023 msgid "get-umask"
7024 msgstr ""
7025
7026 #. type: verbatim
7027 #: ../fish/guestfish-actions.pod:1498
7028 #, no-wrap
7029 msgid ""
7030 " get-umask\n"
7031 "\n"
7032 msgstr ""
7033
7034 #. type: textblock
7035 #: ../fish/guestfish-actions.pod:1500
7036 msgid ""
7037 "Return the current umask.  By default the umask is C<022> unless it has been "
7038 "set by calling L</umask>."
7039 msgstr ""
7040
7041 #. type: =head2
7042 #: ../fish/guestfish-actions.pod:1503
7043 msgid "get-verbose"
7044 msgstr ""
7045
7046 #. type: verbatim
7047 #: ../fish/guestfish-actions.pod:1505
7048 #, no-wrap
7049 msgid ""
7050 " get-verbose\n"
7051 "\n"
7052 msgstr ""
7053
7054 #. type: textblock
7055 #: ../fish/guestfish-actions.pod:1507 ../src/guestfs-actions.pod:2309
7056 msgid "This returns the verbose messages flag."
7057 msgstr ""
7058
7059 #. type: =head2
7060 #: ../fish/guestfish-actions.pod:1509
7061 msgid "getcon"
7062 msgstr ""
7063
7064 #. type: verbatim
7065 #: ../fish/guestfish-actions.pod:1511
7066 #, no-wrap
7067 msgid ""
7068 " getcon\n"
7069 "\n"
7070 msgstr ""
7071
7072 #. type: textblock
7073 #: ../fish/guestfish-actions.pod:1513 ../src/guestfs-actions.pod:2320
7074 msgid "This gets the SELinux security context of the daemon."
7075 msgstr ""
7076
7077 #. type: textblock
7078 #: ../fish/guestfish-actions.pod:1515
7079 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
7080 msgstr ""
7081
7082 #. type: =head2
7083 #: ../fish/guestfish-actions.pod:1518
7084 msgid "getxattr"
7085 msgstr ""
7086
7087 #. type: verbatim
7088 #: ../fish/guestfish-actions.pod:1520
7089 #, no-wrap
7090 msgid ""
7091 " getxattr path name\n"
7092 "\n"
7093 msgstr ""
7094
7095 #. type: textblock
7096 #: ../fish/guestfish-actions.pod:1522
7097 msgid ""
7098 "Get a single extended attribute from file C<path> named C<name>.  This call "
7099 "follows symlinks.  If you want to lookup an extended attribute for the "
7100 "symlink itself, use L</lgetxattr>."
7101 msgstr ""
7102
7103 #. type: textblock
7104 #: ../fish/guestfish-actions.pod:1526 ../fish/guestfish-actions.pod:2579
7105 msgid ""
7106 "Normally it is better to get all extended attributes from a file in one go "
7107 "by calling L</getxattrs>.  However some Linux filesystem implementations are "
7108 "buggy and do not provide a way to list out attributes.  For these "
7109 "filesystems (notably ntfs-3g)  you have to know the names of the extended "
7110 "attributes you want in advance and call this function."
7111 msgstr ""
7112
7113 #. type: textblock
7114 #: ../fish/guestfish-actions.pod:1533 ../fish/guestfish-actions.pod:2586 ../src/guestfs-actions.pod:2349 ../src/guestfs-actions.pod:3831
7115 msgid ""
7116 "Extended attribute values are blobs of binary data.  If there is no extended "
7117 "attribute named C<name>, this returns an error."
7118 msgstr ""
7119
7120 #. type: textblock
7121 #: ../fish/guestfish-actions.pod:1536
7122 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
7123 msgstr ""
7124
7125 #. type: =head2
7126 #: ../fish/guestfish-actions.pod:1538
7127 msgid "getxattrs"
7128 msgstr ""
7129
7130 #. type: verbatim
7131 #: ../fish/guestfish-actions.pod:1540
7132 #, no-wrap
7133 msgid ""
7134 " getxattrs path\n"
7135 "\n"
7136 msgstr ""
7137
7138 #. type: textblock
7139 #: ../fish/guestfish-actions.pod:1542 ../src/guestfs-actions.pod:2366
7140 msgid "This call lists the extended attributes of the file or directory C<path>."
7141 msgstr ""
7142
7143 #. type: textblock
7144 #: ../fish/guestfish-actions.pod:1545 ../src/guestfs-actions.pod:2369
7145 msgid ""
7146 "At the system call level, this is a combination of the L<listxattr(2)> and "
7147 "L<getxattr(2)> calls."
7148 msgstr ""
7149
7150 #. type: textblock
7151 #: ../fish/guestfish-actions.pod:1548
7152 msgid "See also: L</lgetxattrs>, L<attr(5)>."
7153 msgstr ""
7154
7155 #. type: =head2
7156 #: ../fish/guestfish-actions.pod:1550
7157 msgid "glob-expand"
7158 msgstr ""
7159
7160 #. type: verbatim
7161 #: ../fish/guestfish-actions.pod:1552
7162 #, no-wrap
7163 msgid ""
7164 " glob-expand pattern\n"
7165 "\n"
7166 msgstr ""
7167
7168 #. type: textblock
7169 #: ../fish/guestfish-actions.pod:1554 ../src/guestfs-actions.pod:2386
7170 msgid ""
7171 "This command searches for all the pathnames matching C<pattern> according to "
7172 "the wildcard expansion rules used by the shell."
7173 msgstr ""
7174
7175 #. type: textblock
7176 #: ../fish/guestfish-actions.pod:1558 ../src/guestfs-actions.pod:2390
7177 msgid "If no paths match, then this returns an empty list (note: not an error)."
7178 msgstr ""
7179
7180 #. type: textblock
7181 #: ../fish/guestfish-actions.pod:1561 ../src/guestfs-actions.pod:2393
7182 msgid ""
7183 "It is just a wrapper around the C L<glob(3)> function with flags "
7184 "C<GLOB_MARK|GLOB_BRACE>.  See that manual page for more details."
7185 msgstr ""
7186
7187 #. type: =head2
7188 #: ../fish/guestfish-actions.pod:1565
7189 msgid "grep"
7190 msgstr ""
7191
7192 #. type: verbatim
7193 #: ../fish/guestfish-actions.pod:1567
7194 #, no-wrap
7195 msgid ""
7196 " grep regex path\n"
7197 "\n"
7198 msgstr ""
7199
7200 #. type: textblock
7201 #: ../fish/guestfish-actions.pod:1569 ../src/guestfs-actions.pod:2410
7202 msgid "This calls the external C<grep> program and returns the matching lines."
7203 msgstr ""
7204
7205 #. type: =head2
7206 #: ../fish/guestfish-actions.pod:1575
7207 msgid "grepi"
7208 msgstr ""
7209
7210 #. type: verbatim
7211 #: ../fish/guestfish-actions.pod:1577
7212 #, no-wrap
7213 msgid ""
7214 " grepi regex path\n"
7215 "\n"
7216 msgstr ""
7217
7218 #. type: textblock
7219 #: ../fish/guestfish-actions.pod:1579 ../src/guestfs-actions.pod:2429
7220 msgid "This calls the external C<grep -i> program and returns the matching lines."
7221 msgstr ""
7222
7223 #. type: =head2
7224 #: ../fish/guestfish-actions.pod:1585
7225 msgid "grub-install"
7226 msgstr ""
7227
7228 #. type: verbatim
7229 #: ../fish/guestfish-actions.pod:1587
7230 #, no-wrap
7231 msgid ""
7232 " grub-install root device\n"
7233 "\n"
7234 msgstr ""
7235
7236 #. type: textblock
7237 #: ../fish/guestfish-actions.pod:1589 ../src/guestfs-actions.pod:2448
7238 msgid ""
7239 "This command installs GRUB 1 (the Grand Unified Bootloader) on C<device>, "
7240 "with the root directory being C<root>."
7241 msgstr ""
7242
7243 #. type: textblock
7244 #: ../fish/guestfish-actions.pod:1598 ../src/guestfs-actions.pod:2457
7245 msgid ""
7246 "There is currently no way in the API to install grub2, which is used by most "
7247 "modern Linux guests.  It is possible to run the grub2 command from the "
7248 "guest, although see the caveats in L<guestfs(3)/RUNNING COMMANDS>."
7249 msgstr ""
7250
7251 #. type: textblock
7252 #: ../fish/guestfish-actions.pod:1605 ../src/guestfs-actions.pod:2464
7253 msgid ""
7254 "This uses C<grub-install> from the host.  Unfortunately grub is not always "
7255 "compatible with itself, so this only works in rather narrow circumstances.  "
7256 "Careful testing with each guest version is advisable."
7257 msgstr ""
7258
7259 #. type: textblock
7260 #: ../fish/guestfish-actions.pod:1612 ../src/guestfs-actions.pod:2471
7261 msgid ""
7262 "If grub-install reports the error \"No suitable drive was found in the "
7263 "generated device map.\" it may be that you need to create a "
7264 "C</boot/grub/device.map> file first that contains the mapping between grub "
7265 "device names and Linux device names.  It is usually sufficient to create a "
7266 "file containing:"
7267 msgstr ""
7268
7269 #. type: verbatim
7270 #: ../fish/guestfish-actions.pod:1619 ../src/guestfs-actions.pod:2478
7271 #, no-wrap
7272 msgid ""
7273 " (hd0) /dev/vda\n"
7274 "\n"
7275 msgstr ""
7276
7277 #. type: textblock
7278 #: ../fish/guestfish-actions.pod:1621 ../src/guestfs-actions.pod:2480
7279 msgid "replacing C</dev/vda> with the name of the installation device."
7280 msgstr ""
7281
7282 #. type: =head2
7283 #: ../fish/guestfish-actions.pod:1625
7284 msgid "head"
7285 msgstr ""
7286
7287 #. type: verbatim
7288 #: ../fish/guestfish-actions.pod:1627
7289 #, no-wrap
7290 msgid ""
7291 " head path\n"
7292 "\n"
7293 msgstr ""
7294
7295 #. type: textblock
7296 #: ../fish/guestfish-actions.pod:1629 ../src/guestfs-actions.pod:2494
7297 msgid ""
7298 "This command returns up to the first 10 lines of a file as a list of "
7299 "strings."
7300 msgstr ""
7301
7302 #. type: =head2
7303 #: ../fish/guestfish-actions.pod:1635
7304 msgid "head-n"
7305 msgstr ""
7306
7307 #. type: verbatim
7308 #: ../fish/guestfish-actions.pod:1637
7309 #, no-wrap
7310 msgid ""
7311 " head-n nrlines path\n"
7312 "\n"
7313 msgstr ""
7314
7315 #. type: textblock
7316 #: ../fish/guestfish-actions.pod:1639 ../src/guestfs-actions.pod:2513
7317 msgid ""
7318 "If the parameter C<nrlines> is a positive number, this returns the first "
7319 "C<nrlines> lines of the file C<path>."
7320 msgstr ""
7321
7322 #. type: textblock
7323 #: ../fish/guestfish-actions.pod:1642 ../src/guestfs-actions.pod:2516
7324 msgid ""
7325 "If the parameter C<nrlines> is a negative number, this returns lines from "
7326 "the file C<path>, excluding the last C<nrlines> lines."
7327 msgstr ""
7328
7329 #. type: textblock
7330 #: ../fish/guestfish-actions.pod:1645 ../fish/guestfish-actions.pod:4727 ../src/guestfs-actions.pod:2519 ../src/guestfs-actions.pod:7152
7331 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7332 msgstr ""
7333
7334 #. type: =head2
7335 #: ../fish/guestfish-actions.pod:1650
7336 msgid "hexdump"
7337 msgstr ""
7338
7339 #. type: verbatim
7340 #: ../fish/guestfish-actions.pod:1652
7341 #, no-wrap
7342 msgid ""
7343 " hexdump path\n"
7344 "\n"
7345 msgstr ""
7346
7347 #. type: textblock
7348 #: ../fish/guestfish-actions.pod:1654 ../src/guestfs-actions.pod:2536
7349 msgid ""
7350 "This runs C<hexdump -C> on the given C<path>.  The result is the "
7351 "human-readable, canonical hex dump of the file."
7352 msgstr ""
7353
7354 #. type: =head2
7355 #: ../fish/guestfish-actions.pod:1660
7356 msgid "initrd-cat"
7357 msgstr ""
7358
7359 #. type: verbatim
7360 #: ../fish/guestfish-actions.pod:1662
7361 #, no-wrap
7362 msgid ""
7363 " initrd-cat initrdpath filename\n"
7364 "\n"
7365 msgstr ""
7366
7367 #. type: textblock
7368 #: ../fish/guestfish-actions.pod:1664 ../src/guestfs-actions.pod:2555
7369 msgid ""
7370 "This command unpacks the file C<filename> from the initrd file called "
7371 "C<initrdpath>.  The filename must be given I<without> the initial C</> "
7372 "character."
7373 msgstr ""
7374
7375 #. type: textblock
7376 #: ../fish/guestfish-actions.pod:1668 ../src/guestfs-actions.pod:2559
7377 msgid ""
7378 "For example, in guestfish you could use the following command to examine the "
7379 "boot script (usually called C</init>)  contained in a Linux initrd or "
7380 "initramfs image:"
7381 msgstr ""
7382
7383 #. type: verbatim
7384 #: ../fish/guestfish-actions.pod:1672 ../src/guestfs-actions.pod:2563
7385 #, no-wrap
7386 msgid ""
7387 " initrd-cat /boot/initrd-<version>.img init\n"
7388 "\n"
7389 msgstr ""
7390
7391 #. type: textblock
7392 #: ../fish/guestfish-actions.pod:1674
7393 msgid "See also L</initrd-list>."
7394 msgstr ""
7395
7396 #. type: =head2
7397 #: ../fish/guestfish-actions.pod:1679
7398 msgid "initrd-list"
7399 msgstr ""
7400
7401 #. type: verbatim
7402 #: ../fish/guestfish-actions.pod:1681
7403 #, no-wrap
7404 msgid ""
7405 " initrd-list path\n"
7406 "\n"
7407 msgstr ""
7408
7409 #. type: textblock
7410 #: ../fish/guestfish-actions.pod:1683 ../src/guestfs-actions.pod:2582
7411 msgid "This command lists out files contained in an initrd."
7412 msgstr ""
7413
7414 #. type: textblock
7415 #: ../fish/guestfish-actions.pod:1685 ../src/guestfs-actions.pod:2584
7416 msgid ""
7417 "The files are listed without any initial C</> character.  The files are "
7418 "listed in the order they appear (not necessarily alphabetical).  Directory "
7419 "names are listed as separate items."
7420 msgstr ""
7421
7422 #. type: textblock
7423 #: ../fish/guestfish-actions.pod:1689 ../src/guestfs-actions.pod:2588
7424 msgid ""
7425 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7426 "initrd.  We I<only> support the newer initramfs format (compressed cpio "
7427 "files)."
7428 msgstr ""
7429
7430 #. type: =head2
7431 #: ../fish/guestfish-actions.pod:1693
7432 msgid "inotify-add-watch"
7433 msgstr ""
7434
7435 #. type: verbatim
7436 #: ../fish/guestfish-actions.pod:1695
7437 #, no-wrap
7438 msgid ""
7439 " inotify-add-watch path mask\n"
7440 "\n"
7441 msgstr ""
7442
7443 #. type: textblock
7444 #: ../fish/guestfish-actions.pod:1697 ../src/guestfs-actions.pod:2605
7445 msgid "Watch C<path> for the events listed in C<mask>."
7446 msgstr ""
7447
7448 #. type: textblock
7449 #: ../fish/guestfish-actions.pod:1699 ../src/guestfs-actions.pod:2607
7450 msgid ""
7451 "Note that if C<path> is a directory then events within that directory are "
7452 "watched, but this does I<not> happen recursively (in subdirectories)."
7453 msgstr ""
7454
7455 #. type: textblock
7456 #: ../fish/guestfish-actions.pod:1703 ../src/guestfs-actions.pod:2611
7457 msgid ""
7458 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7459 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7460 msgstr ""
7461
7462 #. type: =head2
7463 #: ../fish/guestfish-actions.pod:1707
7464 msgid "inotify-close"
7465 msgstr ""
7466
7467 #. type: verbatim
7468 #: ../fish/guestfish-actions.pod:1709
7469 #, no-wrap
7470 msgid ""
7471 " inotify-close\n"
7472 "\n"
7473 msgstr ""
7474
7475 #. type: textblock
7476 #: ../fish/guestfish-actions.pod:1711 ../src/guestfs-actions.pod:2624
7477 msgid ""
7478 "This closes the inotify handle which was previously opened by inotify_init.  "
7479 "It removes all watches, throws away any pending events, and deallocates all "
7480 "resources."
7481 msgstr ""
7482
7483 #. type: =head2
7484 #: ../fish/guestfish-actions.pod:1715
7485 msgid "inotify-files"
7486 msgstr ""
7487
7488 #. type: verbatim
7489 #: ../fish/guestfish-actions.pod:1717
7490 #, no-wrap
7491 msgid ""
7492 " inotify-files\n"
7493 "\n"
7494 msgstr ""
7495
7496 #. type: textblock
7497 #: ../fish/guestfish-actions.pod:1719
7498 msgid ""
7499 "This function is a helpful wrapper around L</inotify-read> which just "
7500 "returns a list of pathnames of objects that were touched.  The returned "
7501 "pathnames are sorted and deduplicated."
7502 msgstr ""
7503
7504 #. type: =head2
7505 #: ../fish/guestfish-actions.pod:1723
7506 msgid "inotify-init"
7507 msgstr ""
7508
7509 #. type: verbatim
7510 #: ../fish/guestfish-actions.pod:1725
7511 #, no-wrap
7512 msgid ""
7513 " inotify-init maxevents\n"
7514 "\n"
7515 msgstr ""
7516
7517 #. type: textblock
7518 #: ../fish/guestfish-actions.pod:1727 ../src/guestfs-actions.pod:2653
7519 msgid ""
7520 "This command creates a new inotify handle.  The inotify subsystem can be "
7521 "used to notify events which happen to objects in the guest filesystem."
7522 msgstr ""
7523
7524 #. type: textblock
7525 #: ../fish/guestfish-actions.pod:1731
7526 msgid ""
7527 "C<maxevents> is the maximum number of events which will be queued up between "
7528 "calls to L</inotify-read> or L</inotify-files>.  If this is passed as C<0>, "
7529 "then the kernel (or previously set)  default is used.  For Linux 2.6.29 the "
7530 "default was 16384 events.  Beyond this limit, the kernel throws away events, "
7531 "but records the fact that it threw them away by setting a flag "
7532 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
7533 msgstr ""
7534
7535 #. type: textblock
7536 #: ../fish/guestfish-actions.pod:1741
7537 msgid ""
7538 "Before any events are generated, you have to add some watches to the "
7539 "internal watch list.  See: L</inotify-add-watch>, L</inotify-rm-watch> and "
7540 "L</inotify-watch-all>."
7541 msgstr ""
7542
7543 #. type: textblock
7544 #: ../fish/guestfish-actions.pod:1747
7545 msgid ""
7546 "Queued up events should be read periodically by calling L</inotify-read> (or "
7547 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>).  "
7548 "If you don't read the events out often enough then you risk the internal "
7549 "queue overflowing."
7550 msgstr ""
7551
7552 #. type: textblock
7553 #: ../fish/guestfish-actions.pod:1754
7554 msgid ""
7555 "The handle should be closed after use by calling L</inotify-close>.  This "
7556 "also removes any watches automatically."
7557 msgstr ""
7558
7559 #. type: textblock
7560 #: ../fish/guestfish-actions.pod:1758 ../src/guestfs-actions.pod:2684
7561 msgid ""
7562 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7563 "by the Linux kernel, which is roughly what we expose via libguestfs.  Note "
7564 "that there is one global inotify handle per libguestfs instance."
7565 msgstr ""
7566
7567 #. type: =head2
7568 #: ../fish/guestfish-actions.pod:1763
7569 msgid "inotify-read"
7570 msgstr ""
7571
7572 #. type: verbatim
7573 #: ../fish/guestfish-actions.pod:1765
7574 #, no-wrap
7575 msgid ""
7576 " inotify-read\n"
7577 "\n"
7578 msgstr ""
7579
7580 #. type: textblock
7581 #: ../fish/guestfish-actions.pod:1767 ../src/guestfs-actions.pod:2698
7582 msgid ""
7583 "Return the complete queue of events that have happened since the previous "
7584 "read call."
7585 msgstr ""
7586
7587 #. type: textblock
7588 #: ../fish/guestfish-actions.pod:1770 ../src/guestfs-actions.pod:2701
7589 msgid "If no events have happened, this returns an empty list."
7590 msgstr ""
7591
7592 #. type: textblock
7593 #: ../fish/guestfish-actions.pod:1772 ../src/guestfs-actions.pod:2703
7594 msgid ""
7595 "I<Note>: In order to make sure that all events have been read, you must call "
7596 "this function repeatedly until it returns an empty list.  The reason is that "
7597 "the call will read events up to the maximum appliance-to-host message size "
7598 "and leave remaining events in the queue."
7599 msgstr ""
7600
7601 #. type: =head2
7602 #: ../fish/guestfish-actions.pod:1778
7603 msgid "inotify-rm-watch"
7604 msgstr ""
7605
7606 #. type: verbatim
7607 #: ../fish/guestfish-actions.pod:1780
7608 #, no-wrap
7609 msgid ""
7610 " inotify-rm-watch wd\n"
7611 "\n"
7612 msgstr ""
7613
7614 #. type: textblock
7615 #: ../fish/guestfish-actions.pod:1782
7616 msgid "Remove a previously defined inotify watch.  See L</inotify-add-watch>."
7617 msgstr ""
7618
7619 #. type: =head2
7620 #: ../fish/guestfish-actions.pod:1785
7621 msgid "inspect-get-arch"
7622 msgstr ""
7623
7624 #. type: verbatim
7625 #: ../fish/guestfish-actions.pod:1787
7626 #, no-wrap
7627 msgid ""
7628 " inspect-get-arch root\n"
7629 "\n"
7630 msgstr ""
7631
7632 #. type: textblock
7633 #: ../fish/guestfish-actions.pod:1789
7634 msgid ""
7635 "This returns the architecture of the inspected operating system.  The "
7636 "possible return values are listed under L</file-architecture>."
7637 msgstr ""
7638
7639 #. type: textblock
7640 #: ../fish/guestfish-actions.pod:1793 ../src/guestfs-actions.pod:2738
7641 msgid ""
7642 "If the architecture could not be determined, then the string C<unknown> is "
7643 "returned."
7644 msgstr ""
7645
7646 #. type: textblock
7647 #: ../fish/guestfish-actions.pod:1796 ../fish/guestfish-actions.pod:1883 ../fish/guestfish-actions.pod:1962 ../fish/guestfish-actions.pod:1974 ../fish/guestfish-actions.pod:2058 ../fish/guestfish-actions.pod:2119 ../fish/guestfish-actions.pod:2140 ../fish/guestfish-actions.pod:2154 ../fish/guestfish-actions.pod:2194 ../fish/guestfish-actions.pod:2226 ../fish/guestfish-actions.pod:2239 ../fish/guestfish-actions.pod:2252 ../fish/guestfish-actions.pod:2262 ../fish/guestfish-actions.pod:2272 ../fish/guestfish-actions.pod:2284 ../fish/guestfish-actions.pod:2380 ../fish/guestfish-actions.pod:2414 ../src/guestfs-actions.pod:2741 ../src/guestfs-actions.pod:2835 ../src/guestfs-actions.pod:2939 ../src/guestfs-actions.pod:2958 ../src/guestfs-actions.pod:3089 ../src/guestfs-actions.pod:3172 ../src/guestfs-actions.pod:3200 ../src/guestfs-actions.pod:3221 ../src/guestfs-actions.pod:3274 ../src/guestfs-actions.pod:3314 ../src/guestfs-actions.pod:3334 ../src/guestfs-actions.pod:3354 ../src/guestfs-actions.pod:3371 ../src/guestfs-actions.pod:3387 ../src/guestfs-actions.pod:3405 ../src/guestfs-actions.pod:3507 ../src/guestfs-actions.pod:3548
7648 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
7649 msgstr ""
7650
7651 #. type: =head2
7652 #: ../fish/guestfish-actions.pod:1798
7653 msgid "inspect-get-distro"
7654 msgstr ""
7655
7656 #. type: verbatim
7657 #: ../fish/guestfish-actions.pod:1800
7658 #, no-wrap
7659 msgid ""
7660 " inspect-get-distro root\n"
7661 "\n"
7662 msgstr ""
7663
7664 #. type: textblock
7665 #: ../fish/guestfish-actions.pod:1802 ../src/guestfs-actions.pod:2754
7666 msgid "This returns the distro (distribution) of the inspected operating system."
7667 msgstr ""
7668
7669 #. type: textblock
7670 #: ../fish/guestfish-actions.pod:1805 ../src/guestfs-actions.pod:2757
7671 msgid "Currently defined distros are:"
7672 msgstr ""
7673
7674 #. type: =item
7675 #: ../fish/guestfish-actions.pod:1809 ../src/guestfs-actions.pod:2761
7676 msgid "\"archlinux\""
7677 msgstr ""
7678
7679 #. type: textblock
7680 #: ../fish/guestfish-actions.pod:1811 ../src/guestfs-actions.pod:2763
7681 msgid "Arch Linux."
7682 msgstr ""
7683
7684 #. type: =item
7685 #: ../fish/guestfish-actions.pod:1813 ../src/guestfs-actions.pod:2765
7686 msgid "\"centos\""
7687 msgstr ""
7688
7689 #. type: textblock
7690 #: ../fish/guestfish-actions.pod:1815 ../src/guestfs-actions.pod:2767
7691 msgid "CentOS."
7692 msgstr ""
7693
7694 #. type: =item
7695 #: ../fish/guestfish-actions.pod:1817 ../src/guestfs-actions.pod:2769
7696 msgid "\"debian\""
7697 msgstr ""
7698
7699 #. type: textblock
7700 #: ../fish/guestfish-actions.pod:1819 ../src/guestfs-actions.pod:2771
7701 msgid "Debian."
7702 msgstr ""
7703
7704 #. type: =item
7705 #: ../fish/guestfish-actions.pod:1821 ../src/guestfs-actions.pod:2773
7706 msgid "\"fedora\""
7707 msgstr ""
7708
7709 #. type: textblock
7710 #: ../fish/guestfish-actions.pod:1823 ../src/guestfs-actions.pod:2775
7711 msgid "Fedora."
7712 msgstr ""
7713
7714 #. type: =item
7715 #: ../fish/guestfish-actions.pod:1825 ../src/guestfs-actions.pod:2777
7716 msgid "\"gentoo\""
7717 msgstr ""
7718
7719 #. type: textblock
7720 #: ../fish/guestfish-actions.pod:1827 ../src/guestfs-actions.pod:2779
7721 msgid "Gentoo."
7722 msgstr ""
7723
7724 #. type: =item
7725 #: ../fish/guestfish-actions.pod:1829 ../src/guestfs-actions.pod:2781
7726 msgid "\"linuxmint\""
7727 msgstr ""
7728
7729 #. type: textblock
7730 #: ../fish/guestfish-actions.pod:1831 ../src/guestfs-actions.pod:2783
7731 msgid "Linux Mint."
7732 msgstr ""
7733
7734 #. type: =item
7735 #: ../fish/guestfish-actions.pod:1833 ../src/guestfs-actions.pod:2785
7736 msgid "\"mandriva\""
7737 msgstr ""
7738
7739 #. type: textblock
7740 #: ../fish/guestfish-actions.pod:1835 ../src/guestfs-actions.pod:2787
7741 msgid "Mandriva."
7742 msgstr ""
7743
7744 #. type: =item
7745 #: ../fish/guestfish-actions.pod:1837 ../src/guestfs-actions.pod:2789
7746 msgid "\"meego\""
7747 msgstr ""
7748
7749 #. type: textblock
7750 #: ../fish/guestfish-actions.pod:1839 ../src/guestfs-actions.pod:2791
7751 msgid "MeeGo."
7752 msgstr ""
7753
7754 #. type: =item
7755 #: ../fish/guestfish-actions.pod:1841 ../src/guestfs-actions.pod:2793
7756 msgid "\"pardus\""
7757 msgstr ""
7758
7759 #. type: textblock
7760 #: ../fish/guestfish-actions.pod:1843 ../src/guestfs-actions.pod:2795
7761 msgid "Pardus."
7762 msgstr ""
7763
7764 #. type: =item
7765 #: ../fish/guestfish-actions.pod:1845 ../src/guestfs-actions.pod:2797
7766 msgid "\"redhat-based\""
7767 msgstr ""
7768
7769 #. type: textblock
7770 #: ../fish/guestfish-actions.pod:1847 ../src/guestfs-actions.pod:2799
7771 msgid "Some Red Hat-derived distro."
7772 msgstr ""
7773
7774 #. type: =item
7775 #: ../fish/guestfish-actions.pod:1849 ../src/guestfs-actions.pod:2801
7776 msgid "\"rhel\""
7777 msgstr ""
7778
7779 #. type: textblock
7780 #: ../fish/guestfish-actions.pod:1851 ../src/guestfs-actions.pod:2803
7781 msgid "Red Hat Enterprise Linux."
7782 msgstr ""
7783
7784 #. type: =item
7785 #: ../fish/guestfish-actions.pod:1853 ../src/guestfs-actions.pod:2805
7786 msgid "\"scientificlinux\""
7787 msgstr ""
7788
7789 #. type: textblock
7790 #: ../fish/guestfish-actions.pod:1855 ../src/guestfs-actions.pod:2807
7791 msgid "Scientific Linux."
7792 msgstr ""
7793
7794 #. type: =item
7795 #: ../fish/guestfish-actions.pod:1857 ../src/guestfs-actions.pod:2809
7796 msgid "\"slackware\""
7797 msgstr ""
7798
7799 #. type: textblock
7800 #: ../fish/guestfish-actions.pod:1859 ../src/guestfs-actions.pod:2811
7801 msgid "Slackware."
7802 msgstr ""
7803
7804 #. type: =item
7805 #: ../fish/guestfish-actions.pod:1861 ../src/guestfs-actions.pod:2813
7806 msgid "\"ttylinux\""
7807 msgstr ""
7808
7809 #. type: textblock
7810 #: ../fish/guestfish-actions.pod:1863 ../src/guestfs-actions.pod:2815
7811 msgid "ttylinux."
7812 msgstr ""
7813
7814 #. type: =item
7815 #: ../fish/guestfish-actions.pod:1865 ../src/guestfs-actions.pod:2817
7816 msgid "\"ubuntu\""
7817 msgstr ""
7818
7819 #. type: textblock
7820 #: ../fish/guestfish-actions.pod:1867 ../src/guestfs-actions.pod:2819
7821 msgid "Ubuntu."
7822 msgstr ""
7823
7824 #. type: =item
7825 #: ../fish/guestfish-actions.pod:1869 ../fish/guestfish-actions.pod:1953 ../fish/guestfish-actions.pod:2217 ../src/guestfs-actions.pod:2821 ../src/guestfs-actions.pod:2930 ../src/guestfs-actions.pod:3305
7826 msgid "\"unknown\""
7827 msgstr ""
7828
7829 #. type: textblock
7830 #: ../fish/guestfish-actions.pod:1871 ../src/guestfs-actions.pod:2823
7831 msgid "The distro could not be determined."
7832 msgstr ""
7833
7834 #. type: =item
7835 #: ../fish/guestfish-actions.pod:1873 ../fish/guestfish-actions.pod:2209 ../src/guestfs-actions.pod:2825 ../src/guestfs-actions.pod:3297
7836 msgid "\"windows\""
7837 msgstr ""
7838
7839 #. type: textblock
7840 #: ../fish/guestfish-actions.pod:1875 ../src/guestfs-actions.pod:2827
7841 msgid ""
7842 "Windows does not have distributions.  This string is returned if the OS type "
7843 "is Windows."
7844 msgstr ""
7845
7846 #. type: textblock
7847 #: ../fish/guestfish-actions.pod:1880 ../fish/guestfish-actions.pod:1959 ../fish/guestfish-actions.pod:2223 ../src/guestfs-actions.pod:2832 ../src/guestfs-actions.pod:2936 ../src/guestfs-actions.pod:3311
7848 msgid ""
7849 "Future versions of libguestfs may return other strings here.  The caller "
7850 "should be prepared to handle any string."
7851 msgstr ""
7852
7853 #. type: =head2
7854 #: ../fish/guestfish-actions.pod:1885
7855 msgid "inspect-get-drive-mappings"
7856 msgstr ""
7857
7858 #. type: verbatim
7859 #: ../fish/guestfish-actions.pod:1887
7860 #, no-wrap
7861 msgid ""
7862 " inspect-get-drive-mappings root\n"
7863 "\n"
7864 msgstr ""
7865
7866 #. type: textblock
7867 #: ../fish/guestfish-actions.pod:1889 ../src/guestfs-actions.pod:2848
7868 msgid ""
7869 "This call is useful for Windows which uses a primitive system of assigning "
7870 "drive letters (like \"C:\") to partitions.  This inspection API examines the "
7871 "Windows Registry to find out how disks/partitions are mapped to drive "
7872 "letters, and returns a hash table as in the example below:"
7873 msgstr ""
7874
7875 #. type: verbatim
7876 #: ../fish/guestfish-actions.pod:1895 ../src/guestfs-actions.pod:2854
7877 #, no-wrap
7878 msgid ""
7879 " C      =>     /dev/vda2\n"
7880 " E      =>     /dev/vdb1\n"
7881 " F      =>     /dev/vdc1\n"
7882 "\n"
7883 msgstr ""
7884
7885 #. type: textblock
7886 #: ../fish/guestfish-actions.pod:1899 ../src/guestfs-actions.pod:2858
7887 msgid ""
7888 "Note that keys are drive letters.  For Windows, the key is case insensitive "
7889 "and just contains the drive letter, without the customary colon separator "
7890 "character."
7891 msgstr ""
7892
7893 #. type: textblock
7894 #: ../fish/guestfish-actions.pod:1903 ../src/guestfs-actions.pod:2862
7895 msgid ""
7896 "In future we may support other operating systems that also used drive "
7897 "letters, but the keys for those might not be case insensitive and might be "
7898 "longer than 1 character.  For example in OS-9, hard drives were named C<h0>, "
7899 "C<h1> etc."
7900 msgstr ""
7901
7902 #. type: textblock
7903 #: ../fish/guestfish-actions.pod:1908 ../src/guestfs-actions.pod:2867
7904 msgid ""
7905 "For Windows guests, currently only hard drive mappings are returned.  "
7906 "Removable disks (eg. DVD-ROMs) are ignored."
7907 msgstr ""
7908
7909 #. type: textblock
7910 #: ../fish/guestfish-actions.pod:1911 ../src/guestfs-actions.pod:2870
7911 msgid ""
7912 "For guests that do not use drive mappings, or if the drive mappings could "
7913 "not be determined, this returns an empty hash table."
7914 msgstr ""
7915
7916 #. type: textblock
7917 #: ../fish/guestfish-actions.pod:1914
7918 msgid ""
7919 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
7920 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
7921 msgstr ""
7922
7923 #. type: =head2
7924 #: ../fish/guestfish-actions.pod:1918
7925 msgid "inspect-get-filesystems"
7926 msgstr ""
7927
7928 #. type: verbatim
7929 #: ../fish/guestfish-actions.pod:1920
7930 #, no-wrap
7931 msgid ""
7932 " inspect-get-filesystems root\n"
7933 "\n"
7934 msgstr ""
7935
7936 #. type: textblock
7937 #: ../fish/guestfish-actions.pod:1922 ../src/guestfs-actions.pod:2891
7938 msgid ""
7939 "This returns a list of all the filesystems that we think are associated with "
7940 "this operating system.  This includes the root filesystem, other ordinary "
7941 "filesystems, and non-mounted devices like swap partitions."
7942 msgstr ""
7943
7944 #. type: textblock
7945 #: ../fish/guestfish-actions.pod:1927 ../src/guestfs-actions.pod:2896
7946 msgid ""
7947 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
7948 "to be shared between operating systems."
7949 msgstr ""
7950
7951 #. type: textblock
7952 #: ../fish/guestfish-actions.pod:1930
7953 msgid ""
7954 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
7955 "L</inspect-get-mountpoints>."
7956 msgstr ""
7957
7958 #. type: =head2
7959 #: ../fish/guestfish-actions.pod:1933
7960 msgid "inspect-get-format"
7961 msgstr ""
7962
7963 #. type: verbatim
7964 #: ../fish/guestfish-actions.pod:1935
7965 #, no-wrap
7966 msgid ""
7967 " inspect-get-format root\n"
7968 "\n"
7969 msgstr ""
7970
7971 #. type: textblock
7972 #: ../fish/guestfish-actions.pod:1937 ../src/guestfs-actions.pod:2914
7973 msgid ""
7974 "This returns the format of the inspected operating system.  You can use it "
7975 "to detect install images, live CDs and similar."
7976 msgstr ""
7977
7978 #. type: textblock
7979 #: ../fish/guestfish-actions.pod:1940 ../src/guestfs-actions.pod:2917
7980 msgid "Currently defined formats are:"
7981 msgstr ""
7982
7983 #. type: =item
7984 #: ../fish/guestfish-actions.pod:1944 ../src/guestfs-actions.pod:2921
7985 msgid "\"installed\""
7986 msgstr ""
7987
7988 #. type: textblock
7989 #: ../fish/guestfish-actions.pod:1946 ../src/guestfs-actions.pod:2923
7990 msgid "This is an installed operating system."
7991 msgstr ""
7992
7993 #. type: =item
7994 #: ../fish/guestfish-actions.pod:1948 ../src/guestfs-actions.pod:2925
7995 msgid "\"installer\""
7996 msgstr ""
7997
7998 #. type: textblock
7999 #: ../fish/guestfish-actions.pod:1950 ../src/guestfs-actions.pod:2927
8000 msgid ""
8001 "The disk image being inspected is not an installed operating system, but a "
8002 "I<bootable> install disk, live CD, or similar."
8003 msgstr ""
8004
8005 #. type: textblock
8006 #: ../fish/guestfish-actions.pod:1955 ../src/guestfs-actions.pod:2932
8007 msgid "The format of this disk image is not known."
8008 msgstr ""
8009
8010 #. type: =head2
8011 #: ../fish/guestfish-actions.pod:1964
8012 msgid "inspect-get-hostname"
8013 msgstr ""
8014
8015 #. type: verbatim
8016 #: ../fish/guestfish-actions.pod:1966
8017 #, no-wrap
8018 msgid ""
8019 " inspect-get-hostname root\n"
8020 "\n"
8021 msgstr ""
8022
8023 #. type: textblock
8024 #: ../fish/guestfish-actions.pod:1968 ../src/guestfs-actions.pod:2952
8025 msgid ""
8026 "This function returns the hostname of the operating system as found by "
8027 "inspection of the guest's configuration files."
8028 msgstr ""
8029
8030 #. type: textblock
8031 #: ../fish/guestfish-actions.pod:1971 ../src/guestfs-actions.pod:2955
8032 msgid ""
8033 "If the hostname could not be determined, then the string C<unknown> is "
8034 "returned."
8035 msgstr ""
8036
8037 #. type: =head2
8038 #: ../fish/guestfish-actions.pod:1976
8039 msgid "inspect-get-icon"
8040 msgstr ""
8041
8042 #. type: verbatim
8043 #: ../fish/guestfish-actions.pod:1978
8044 #, no-wrap
8045 msgid ""
8046 " inspect-get-icon root [favicon:..] [highquality:..]\n"
8047 "\n"
8048 msgstr ""
8049
8050 #. type: textblock
8051 #: ../fish/guestfish-actions.pod:1980 ../src/guestfs-actions.pod:2981
8052 msgid ""
8053 "This function returns an icon corresponding to the inspected operating "
8054 "system.  The icon is returned as a buffer containing a PNG image (re-encoded "
8055 "to PNG if necessary)."
8056 msgstr ""
8057
8058 #. type: textblock
8059 #: ../fish/guestfish-actions.pod:1984 ../src/guestfs-actions.pod:2985
8060 msgid ""
8061 "If it was not possible to get an icon this function returns a zero-length "
8062 "(non-NULL) buffer.  I<Callers must check for this case>."
8063 msgstr ""
8064
8065 #. type: textblock
8066 #: ../fish/guestfish-actions.pod:1987 ../src/guestfs-actions.pod:2988
8067 msgid ""
8068 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
8069 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
8070 "this file will be returned.  You can disable favicons by passing the "
8071 "optional C<favicon> boolean as false (default is true)."
8072 msgstr ""
8073
8074 #. type: textblock
8075 #: ../fish/guestfish-actions.pod:1993 ../src/guestfs-actions.pod:2994
8076 msgid ""
8077 "If finding the favicon fails, then we look in other places in the guest for "
8078 "a suitable icon."
8079 msgstr ""
8080
8081 #. type: textblock
8082 #: ../fish/guestfish-actions.pod:1996 ../src/guestfs-actions.pod:2997
8083 msgid ""
8084 "If the optional C<highquality> boolean is true then only high quality icons "
8085 "are returned, which means only icons of high resolution with an alpha "
8086 "channel.  The default (false) is to return any icon we can, even if it is of "
8087 "substandard quality."
8088 msgstr ""
8089
8090 #. type: textblock
8091 #: ../fish/guestfish-actions.pod:2007 ../src/guestfs-actions.pod:3008
8092 msgid ""
8093 "Unlike most other inspection API calls, the guest's disks must be mounted up "
8094 "before you call this, since it needs to read information from the guest "
8095 "filesystem during the call."
8096 msgstr ""
8097
8098 #. type: textblock
8099 #: ../fish/guestfish-actions.pod:2013 ../src/guestfs-actions.pod:3014
8100 msgid ""
8101 "B<Security:> The icon data comes from the untrusted guest, and should be "
8102 "treated with caution.  PNG files have been known to contain exploits.  "
8103 "Ensure that libpng (or other relevant libraries) are fully up to date before "
8104 "trying to process or display the icon."
8105 msgstr ""
8106
8107 #. type: textblock
8108 #: ../fish/guestfish-actions.pod:2021 ../src/guestfs-actions.pod:3022
8109 msgid ""
8110 "The PNG image returned can be any size.  It might not be square.  Libguestfs "
8111 "tries to return the largest, highest quality icon available.  The "
8112 "application must scale the icon to the required size."
8113 msgstr ""
8114
8115 #. type: textblock
8116 #: ../fish/guestfish-actions.pod:2028 ../src/guestfs-actions.pod:3029
8117 msgid ""
8118 "Extracting icons from Windows guests requires the external C<wrestool> "
8119 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
8120 "C<pnmtopng>, C<pamcut>)  from the C<netpbm> package.  These must be "
8121 "installed separately."
8122 msgstr ""
8123
8124 #. type: textblock
8125 #: ../fish/guestfish-actions.pod:2035 ../src/guestfs-actions.pod:3036
8126 msgid ""
8127 "Operating system icons are usually trademarks.  Seek legal advice before "
8128 "using trademarks in applications."
8129 msgstr ""
8130
8131 #. type: =head2
8132 #: ../fish/guestfish-actions.pod:2042
8133 msgid "inspect-get-major-version"
8134 msgstr ""
8135
8136 #. type: verbatim
8137 #: ../fish/guestfish-actions.pod:2044
8138 #, no-wrap
8139 msgid ""
8140 " inspect-get-major-version root\n"
8141 "\n"
8142 msgstr ""
8143
8144 #. type: textblock
8145 #: ../fish/guestfish-actions.pod:2046 ../src/guestfs-actions.pod:3077
8146 msgid "This returns the major version number of the inspected operating system."
8147 msgstr ""
8148
8149 #. type: textblock
8150 #: ../fish/guestfish-actions.pod:2049 ../src/guestfs-actions.pod:3080
8151 msgid ""
8152 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8153 "popular public names used by the operating system.  Notably the operating "
8154 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8155 "1).  You can find out the real versions corresponding to releases of Windows "
8156 "by consulting Wikipedia or MSDN."
8157 msgstr ""
8158
8159 #. type: textblock
8160 #: ../fish/guestfish-actions.pod:2056 ../fish/guestfish-actions.pod:2067 ../src/guestfs-actions.pod:3087 ../src/guestfs-actions.pod:3104
8161 msgid "If the version could not be determined, then C<0> is returned."
8162 msgstr ""
8163
8164 #. type: =head2
8165 #: ../fish/guestfish-actions.pod:2060
8166 msgid "inspect-get-minor-version"
8167 msgstr ""
8168
8169 #. type: verbatim
8170 #: ../fish/guestfish-actions.pod:2062
8171 #, no-wrap
8172 msgid ""
8173 " inspect-get-minor-version root\n"
8174 "\n"
8175 msgstr ""
8176
8177 #. type: textblock
8178 #: ../fish/guestfish-actions.pod:2064 ../src/guestfs-actions.pod:3101
8179 msgid "This returns the minor version number of the inspected operating system."
8180 msgstr ""
8181
8182 #. type: textblock
8183 #: ../fish/guestfish-actions.pod:2069
8184 msgid ""
8185 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
8186 "L</inspect-get-major-version>."
8187 msgstr ""
8188
8189 #. type: =head2
8190 #: ../fish/guestfish-actions.pod:2072
8191 msgid "inspect-get-mountpoints"
8192 msgstr ""
8193
8194 #. type: verbatim
8195 #: ../fish/guestfish-actions.pod:2074
8196 #, no-wrap
8197 msgid ""
8198 " inspect-get-mountpoints root\n"
8199 "\n"
8200 msgstr ""
8201
8202 #. type: textblock
8203 #: ../fish/guestfish-actions.pod:2076 ../src/guestfs-actions.pod:3119
8204 msgid ""
8205 "This returns a hash of where we think the filesystems associated with this "
8206 "operating system should be mounted.  Callers should note that this is at "
8207 "best an educated guess made by reading configuration files such as "
8208 "C</etc/fstab>.  I<In particular note> that this may return filesystems which "
8209 "are non-existent or not mountable and callers should be prepared to handle "
8210 "or ignore failures if they try to mount them."
8211 msgstr ""
8212
8213 #. type: textblock
8214 #: ../fish/guestfish-actions.pod:2085 ../src/guestfs-actions.pod:3128
8215 msgid ""
8216 "Each element in the returned hashtable has a key which is the path of the "
8217 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8218 "mounted there (eg. C</dev/sda1>)."
8219 msgstr ""
8220
8221 #. type: textblock
8222 #: ../fish/guestfish-actions.pod:2090 ../src/guestfs-actions.pod:3133
8223 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
8224 msgstr ""
8225
8226 #. type: textblock
8227 #: ../fish/guestfish-actions.pod:2093
8228 msgid ""
8229 "For operating systems like Windows which still use drive letters, this call "
8230 "will only return an entry for the first drive \"mounted on\" C</>.  For "
8231 "information about the mapping of drive letters to partitions, see "
8232 "L</inspect-get-drive-mappings>."
8233 msgstr ""
8234
8235 #. type: textblock
8236 #: ../fish/guestfish-actions.pod:2099
8237 msgid ""
8238 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
8239 "L</inspect-get-filesystems>."
8240 msgstr ""
8241
8242 #. type: =head2
8243 #: ../fish/guestfish-actions.pod:2102
8244 msgid "inspect-get-package-format"
8245 msgstr ""
8246
8247 #. type: verbatim
8248 #: ../fish/guestfish-actions.pod:2104
8249 #, no-wrap
8250 msgid ""
8251 " inspect-get-package-format root\n"
8252 "\n"
8253 msgstr ""
8254
8255 #. type: textblock
8256 #: ../fish/guestfish-actions.pod:2106
8257 msgid ""
8258 "This function and L</inspect-get-package-management> return the package "
8259 "format and package management tool used by the inspected operating system.  "
8260 "For example for Fedora these functions would return C<rpm> (package format) "
8261 "and C<yum> (package management)."
8262 msgstr ""
8263
8264 #. type: textblock
8265 #: ../fish/guestfish-actions.pod:2112 ../src/guestfs-actions.pod:3165
8266 msgid ""
8267 "This returns the string C<unknown> if we could not determine the package "
8268 "format I<or> if the operating system does not have a real packaging system "
8269 "(eg. Windows)."
8270 msgstr ""
8271
8272 #. type: textblock
8273 #: ../fish/guestfish-actions.pod:2116 ../src/guestfs-actions.pod:3169
8274 msgid ""
8275 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>.  "
8276 "Future versions of libguestfs may return other strings."
8277 msgstr ""
8278
8279 #. type: =head2
8280 #: ../fish/guestfish-actions.pod:2121
8281 msgid "inspect-get-package-management"
8282 msgstr ""
8283
8284 #. type: verbatim
8285 #: ../fish/guestfish-actions.pod:2123
8286 #, no-wrap
8287 msgid ""
8288 " inspect-get-package-management root\n"
8289 "\n"
8290 msgstr ""
8291
8292 #. type: textblock
8293 #: ../fish/guestfish-actions.pod:2125
8294 msgid ""
8295 "L</inspect-get-package-format> and this function return the package format "
8296 "and package management tool used by the inspected operating system.  For "
8297 "example for Fedora these functions would return C<rpm> (package format) and "
8298 "C<yum> (package management)."
8299 msgstr ""
8300
8301 #. type: textblock
8302 #: ../fish/guestfish-actions.pod:2131 ../src/guestfs-actions.pod:3191
8303 msgid ""
8304 "This returns the string C<unknown> if we could not determine the package "
8305 "management tool I<or> if the operating system does not have a real packaging "
8306 "system (eg. Windows)."
8307 msgstr ""
8308
8309 #. type: textblock
8310 #: ../fish/guestfish-actions.pod:2135 ../src/guestfs-actions.pod:3195
8311 msgid ""
8312 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
8313 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>.  Future versions of "
8314 "libguestfs may return other strings."
8315 msgstr ""
8316
8317 #. type: =head2
8318 #: ../fish/guestfish-actions.pod:2142
8319 msgid "inspect-get-product-name"
8320 msgstr ""
8321
8322 #. type: verbatim
8323 #: ../fish/guestfish-actions.pod:2144
8324 #, no-wrap
8325 msgid ""
8326 " inspect-get-product-name root\n"
8327 "\n"
8328 msgstr ""
8329
8330 #. type: textblock
8331 #: ../fish/guestfish-actions.pod:2146 ../src/guestfs-actions.pod:3213
8332 msgid ""
8333 "This returns the product name of the inspected operating system.  The "
8334 "product name is generally some freeform string which can be displayed to the "
8335 "user, but should not be parsed by programs."
8336 msgstr ""
8337
8338 #. type: textblock
8339 #: ../fish/guestfish-actions.pod:2151 ../src/guestfs-actions.pod:3218
8340 msgid ""
8341 "If the product name could not be determined, then the string C<unknown> is "
8342 "returned."
8343 msgstr ""
8344
8345 #. type: =head2
8346 #: ../fish/guestfish-actions.pod:2156
8347 msgid "inspect-get-product-variant"
8348 msgstr ""
8349
8350 #. type: verbatim
8351 #: ../fish/guestfish-actions.pod:2158
8352 #, no-wrap
8353 msgid ""
8354 " inspect-get-product-variant root\n"
8355 "\n"
8356 msgstr ""
8357
8358 #. type: textblock
8359 #: ../fish/guestfish-actions.pod:2160 ../src/guestfs-actions.pod:3234
8360 msgid "This returns the product variant of the inspected operating system."
8361 msgstr ""
8362
8363 #. type: textblock
8364 #: ../fish/guestfish-actions.pod:2163 ../src/guestfs-actions.pod:3237
8365 msgid ""
8366 "For Windows guests, this returns the contents of the Registry key "
8367 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
8368 "which is usually a string such as C<Client> or C<Server> (other values are "
8369 "possible).  This can be used to distinguish consumer and enterprise versions "
8370 "of Windows that have the same version number (for example, Windows 7 and "
8371 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
8372 "the latter is C<Server>)."
8373 msgstr ""
8374
8375 #. type: textblock
8376 #: ../fish/guestfish-actions.pod:2172 ../src/guestfs-actions.pod:3246
8377 msgid ""
8378 "For enterprise Linux guests, in future we intend this to return the product "
8379 "variant such as C<Desktop>, C<Server> and so on.  But this is not "
8380 "implemented at present."
8381 msgstr ""
8382
8383 #. type: textblock
8384 #: ../fish/guestfish-actions.pod:2176 ../src/guestfs-actions.pod:3250
8385 msgid ""
8386 "If the product variant could not be determined, then the string C<unknown> "
8387 "is returned."
8388 msgstr ""
8389
8390 #. type: textblock
8391 #: ../fish/guestfish-actions.pod:2179
8392 msgid ""
8393 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
8394 "L</inspect-get-product-name>, L</inspect-get-major-version>."
8395 msgstr ""
8396
8397 #. type: =head2
8398 #: ../fish/guestfish-actions.pod:2183
8399 msgid "inspect-get-roots"
8400 msgstr ""
8401
8402 #. type: verbatim
8403 #: ../fish/guestfish-actions.pod:2185
8404 #, no-wrap
8405 msgid ""
8406 " inspect-get-roots\n"
8407 "\n"
8408 msgstr ""
8409
8410 #. type: textblock
8411 #: ../fish/guestfish-actions.pod:2187
8412 msgid ""
8413 "This function is a convenient way to get the list of root devices, as "
8414 "returned from a previous call to L</inspect-os>, but without redoing the "
8415 "whole inspection process."
8416 msgstr ""
8417
8418 #. type: textblock
8419 #: ../fish/guestfish-actions.pod:2191
8420 msgid ""
8421 "This returns an empty list if either no root devices were found or the "
8422 "caller has not called L</inspect-os>."
8423 msgstr ""
8424
8425 #. type: =head2
8426 #: ../fish/guestfish-actions.pod:2196
8427 msgid "inspect-get-type"
8428 msgstr ""
8429
8430 #. type: verbatim
8431 #: ../fish/guestfish-actions.pod:2198
8432 #, no-wrap
8433 msgid ""
8434 " inspect-get-type root\n"
8435 "\n"
8436 msgstr ""
8437
8438 #. type: textblock
8439 #: ../fish/guestfish-actions.pod:2200 ../src/guestfs-actions.pod:3288
8440 msgid ""
8441 "This returns the type of the inspected operating system.  Currently defined "
8442 "types are:"
8443 msgstr ""
8444
8445 #. type: =item
8446 #: ../fish/guestfish-actions.pod:2205 ../src/guestfs-actions.pod:3293
8447 msgid "\"linux\""
8448 msgstr ""
8449
8450 #. type: textblock
8451 #: ../fish/guestfish-actions.pod:2207 ../src/guestfs-actions.pod:3295
8452 msgid "Any Linux-based operating system."
8453 msgstr ""
8454
8455 #. type: textblock
8456 #: ../fish/guestfish-actions.pod:2211 ../src/guestfs-actions.pod:3299
8457 msgid "Any Microsoft Windows operating system."
8458 msgstr ""
8459
8460 #. type: =item
8461 #: ../fish/guestfish-actions.pod:2213 ../src/guestfs-actions.pod:3301
8462 msgid "\"freebsd\""
8463 msgstr ""
8464
8465 #. type: textblock
8466 #: ../fish/guestfish-actions.pod:2215 ../src/guestfs-actions.pod:3303
8467 msgid "FreeBSD."
8468 msgstr ""
8469
8470 #. type: textblock
8471 #: ../fish/guestfish-actions.pod:2219 ../src/guestfs-actions.pod:3307
8472 msgid "The operating system type could not be determined."
8473 msgstr ""
8474
8475 #. type: =head2
8476 #: ../fish/guestfish-actions.pod:2228
8477 msgid "inspect-get-windows-current-control-set"
8478 msgstr ""
8479
8480 #. type: verbatim
8481 #: ../fish/guestfish-actions.pod:2230
8482 #, no-wrap
8483 msgid ""
8484 " inspect-get-windows-current-control-set root\n"
8485 "\n"
8486 msgstr ""
8487
8488 #. type: textblock
8489 #: ../fish/guestfish-actions.pod:2232 ../src/guestfs-actions.pod:3327
8490 msgid ""
8491 "This returns the Windows CurrentControlSet of the inspected guest.  The "
8492 "CurrentControlSet is a registry key name such as C<ControlSet001>."
8493 msgstr ""
8494
8495 #. type: textblock
8496 #: ../fish/guestfish-actions.pod:2235 ../src/guestfs-actions.pod:3330
8497 msgid ""
8498 "This call assumes that the guest is Windows and that the Registry could be "
8499 "examined by inspection.  If this is not the case then an error is returned."
8500 msgstr ""
8501
8502 #. type: =head2
8503 #: ../fish/guestfish-actions.pod:2241
8504 msgid "inspect-get-windows-systemroot"
8505 msgstr ""
8506
8507 #. type: verbatim
8508 #: ../fish/guestfish-actions.pod:2243
8509 #, no-wrap
8510 msgid ""
8511 " inspect-get-windows-systemroot root\n"
8512 "\n"
8513 msgstr ""
8514
8515 #. type: textblock
8516 #: ../fish/guestfish-actions.pod:2245 ../src/guestfs-actions.pod:3347
8517 msgid ""
8518 "This returns the Windows systemroot of the inspected guest.  The systemroot "
8519 "is a directory path such as C</WINDOWS>."
8520 msgstr ""
8521
8522 #. type: textblock
8523 #: ../fish/guestfish-actions.pod:2248 ../src/guestfs-actions.pod:3350
8524 msgid ""
8525 "This call assumes that the guest is Windows and that the systemroot could be "
8526 "determined by inspection.  If this is not the case then an error is "
8527 "returned."
8528 msgstr ""
8529
8530 #. type: =head2
8531 #: ../fish/guestfish-actions.pod:2254
8532 msgid "inspect-is-live"
8533 msgstr ""
8534
8535 #. type: verbatim
8536 #: ../fish/guestfish-actions.pod:2256
8537 #, no-wrap
8538 msgid ""
8539 " inspect-is-live root\n"
8540 "\n"
8541 msgstr ""
8542
8543 #. type: textblock
8544 #: ../fish/guestfish-actions.pod:2258
8545 msgid ""
8546 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8547 "then this returns true if a live image was detected on the disk."
8548 msgstr ""
8549
8550 #. type: =head2
8551 #: ../fish/guestfish-actions.pod:2264
8552 msgid "inspect-is-multipart"
8553 msgstr ""
8554
8555 #. type: verbatim
8556 #: ../fish/guestfish-actions.pod:2266
8557 #, no-wrap
8558 msgid ""
8559 " inspect-is-multipart root\n"
8560 "\n"
8561 msgstr ""
8562
8563 #. type: textblock
8564 #: ../fish/guestfish-actions.pod:2268
8565 msgid ""
8566 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8567 "then this returns true if the disk is part of a set."
8568 msgstr ""
8569
8570 #. type: =head2
8571 #: ../fish/guestfish-actions.pod:2274
8572 msgid "inspect-is-netinst"
8573 msgstr ""
8574
8575 #. type: verbatim
8576 #: ../fish/guestfish-actions.pod:2276
8577 #, no-wrap
8578 msgid ""
8579 " inspect-is-netinst root\n"
8580 "\n"
8581 msgstr ""
8582
8583 #. type: textblock
8584 #: ../fish/guestfish-actions.pod:2278
8585 msgid ""
8586 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8587 "then this returns true if the disk is a network installer, ie. not a "
8588 "self-contained install CD but one which is likely to require network access "
8589 "to complete the install."
8590 msgstr ""
8591
8592 #. type: =head2
8593 #: ../fish/guestfish-actions.pod:2286
8594 msgid "inspect-list-applications"
8595 msgstr ""
8596
8597 #. type: verbatim
8598 #: ../fish/guestfish-actions.pod:2288
8599 #, no-wrap
8600 msgid ""
8601 " inspect-list-applications root\n"
8602 "\n"
8603 msgstr ""
8604
8605 #. type: textblock
8606 #: ../fish/guestfish-actions.pod:2290 ../src/guestfs-actions.pod:3417
8607 msgid "Return the list of applications installed in the operating system."
8608 msgstr ""
8609
8610 #. type: textblock
8611 #: ../fish/guestfish-actions.pod:2292
8612 msgid ""
8613 "I<Note:> This call works differently from other parts of the inspection "
8614 "API.  You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
8615 "then mount up the disks, before calling this.  Listing applications is a "
8616 "significantly more difficult operation which requires access to the full "
8617 "filesystem.  Also note that unlike the other L</inspect-get-*> calls which "
8618 "are just returning data cached in the libguestfs handle, this call actually "
8619 "reads parts of the mounted filesystems during the call."
8620 msgstr ""
8621
8622 #. type: textblock
8623 #: ../fish/guestfish-actions.pod:2302 ../src/guestfs-actions.pod:3429
8624 msgid ""
8625 "This returns an empty list if the inspection code was not able to determine "
8626 "the list of applications."
8627 msgstr ""
8628
8629 #. type: textblock
8630 #: ../fish/guestfish-actions.pod:2305 ../src/guestfs-actions.pod:3432
8631 msgid "The application structure contains the following fields:"
8632 msgstr ""
8633
8634 #. type: =item
8635 #: ../fish/guestfish-actions.pod:2309 ../src/guestfs-actions.pod:3436
8636 msgid "C<app_name>"
8637 msgstr ""
8638
8639 #. type: textblock
8640 #: ../fish/guestfish-actions.pod:2311 ../src/guestfs-actions.pod:3438
8641 msgid ""
8642 "The name of the application.  For Red Hat-derived and Debian-derived Linux "
8643 "guests, this is the package name."
8644 msgstr ""
8645
8646 #. type: =item
8647 #: ../fish/guestfish-actions.pod:2314 ../src/guestfs-actions.pod:3441
8648 msgid "C<app_display_name>"
8649 msgstr ""
8650
8651 #. type: textblock
8652 #: ../fish/guestfish-actions.pod:2316 ../src/guestfs-actions.pod:3443
8653 msgid ""
8654 "The display name of the application, sometimes localized to the install "
8655 "language of the guest operating system."
8656 msgstr ""
8657
8658 #. type: textblock
8659 #: ../fish/guestfish-actions.pod:2319 ../src/guestfs-actions.pod:3446
8660 msgid ""
8661 "If unavailable this is returned as an empty string C<\"\">.  Callers needing "
8662 "to display something can use C<app_name> instead."
8663 msgstr ""
8664
8665 #. type: =item
8666 #: ../fish/guestfish-actions.pod:2322 ../src/guestfs-actions.pod:3449
8667 msgid "C<app_epoch>"
8668 msgstr ""
8669
8670 #. type: textblock
8671 #: ../fish/guestfish-actions.pod:2324 ../src/guestfs-actions.pod:3451
8672 msgid ""
8673 "For package managers which use epochs, this contains the epoch of the "
8674 "package (an integer).  If unavailable, this is returned as C<0>."
8675 msgstr ""
8676
8677 #. type: =item
8678 #: ../fish/guestfish-actions.pod:2327 ../src/guestfs-actions.pod:3454
8679 msgid "C<app_version>"
8680 msgstr ""
8681
8682 #. type: textblock
8683 #: ../fish/guestfish-actions.pod:2329 ../src/guestfs-actions.pod:3456
8684 msgid ""
8685 "The version string of the application or package.  If unavailable this is "
8686 "returned as an empty string C<\"\">."
8687 msgstr ""
8688
8689 #. type: =item
8690 #: ../fish/guestfish-actions.pod:2332 ../src/guestfs-actions.pod:3459
8691 msgid "C<app_release>"
8692 msgstr ""
8693
8694 #. type: textblock
8695 #: ../fish/guestfish-actions.pod:2334 ../src/guestfs-actions.pod:3461
8696 msgid ""
8697 "The release string of the application or package, for package managers that "
8698 "use this.  If unavailable this is returned as an empty string C<\"\">."
8699 msgstr ""
8700
8701 #. type: =item
8702 #: ../fish/guestfish-actions.pod:2338 ../src/guestfs-actions.pod:3465
8703 msgid "C<app_install_path>"
8704 msgstr ""
8705
8706 #. type: textblock
8707 #: ../fish/guestfish-actions.pod:2340 ../src/guestfs-actions.pod:3467
8708 msgid ""
8709 "The installation path of the application (on operating systems such as "
8710 "Windows which use installation paths).  This path is in the format used by "
8711 "the guest operating system, it is not a libguestfs path."
8712 msgstr ""
8713
8714 #. type: textblock
8715 #: ../fish/guestfish-actions.pod:2345 ../src/guestfs-actions.pod:3472
8716 msgid "If unavailable this is returned as an empty string C<\"\">."
8717 msgstr ""
8718
8719 #. type: =item
8720 #: ../fish/guestfish-actions.pod:2347 ../src/guestfs-actions.pod:3474
8721 msgid "C<app_trans_path>"
8722 msgstr ""
8723
8724 #. type: textblock
8725 #: ../fish/guestfish-actions.pod:2349 ../src/guestfs-actions.pod:3476
8726 msgid ""
8727 "The install path translated into a libguestfs path.  If unavailable this is "
8728 "returned as an empty string C<\"\">."
8729 msgstr ""
8730
8731 #. type: =item
8732 #: ../fish/guestfish-actions.pod:2352 ../src/guestfs-actions.pod:3479
8733 msgid "C<app_publisher>"
8734 msgstr ""
8735
8736 #. type: textblock
8737 #: ../fish/guestfish-actions.pod:2354 ../src/guestfs-actions.pod:3481
8738 msgid ""
8739 "The name of the publisher of the application, for package managers that use "
8740 "this.  If unavailable this is returned as an empty string C<\"\">."
8741 msgstr ""
8742
8743 #. type: =item
8744 #: ../fish/guestfish-actions.pod:2358 ../src/guestfs-actions.pod:3485
8745 msgid "C<app_url>"
8746 msgstr ""
8747
8748 #. type: textblock
8749 #: ../fish/guestfish-actions.pod:2360 ../src/guestfs-actions.pod:3487
8750 msgid ""
8751 "The URL (eg. upstream URL) of the application.  If unavailable this is "
8752 "returned as an empty string C<\"\">."
8753 msgstr ""
8754
8755 #. type: =item
8756 #: ../fish/guestfish-actions.pod:2363 ../src/guestfs-actions.pod:3490
8757 msgid "C<app_source_package>"
8758 msgstr ""
8759
8760 #. type: textblock
8761 #: ../fish/guestfish-actions.pod:2365 ../src/guestfs-actions.pod:3492
8762 msgid ""
8763 "For packaging systems which support this, the name of the source package.  "
8764 "If unavailable this is returned as an empty string C<\"\">."
8765 msgstr ""
8766
8767 #. type: =item
8768 #: ../fish/guestfish-actions.pod:2368 ../src/guestfs-actions.pod:3495
8769 msgid "C<app_summary>"
8770 msgstr ""
8771
8772 #. type: textblock
8773 #: ../fish/guestfish-actions.pod:2370 ../src/guestfs-actions.pod:3497
8774 msgid ""
8775 "A short (usually one line) description of the application or package.  If "
8776 "unavailable this is returned as an empty string C<\"\">."
8777 msgstr ""
8778
8779 #. type: =item
8780 #: ../fish/guestfish-actions.pod:2373 ../src/guestfs-actions.pod:3500
8781 msgid "C<app_description>"
8782 msgstr ""
8783
8784 #. type: textblock
8785 #: ../fish/guestfish-actions.pod:2375 ../src/guestfs-actions.pod:3502
8786 msgid ""
8787 "A longer description of the application or package.  If unavailable this is "
8788 "returned as an empty string C<\"\">."
8789 msgstr ""
8790
8791 #. type: =head2
8792 #: ../fish/guestfish-actions.pod:2382
8793 msgid "inspect-os"
8794 msgstr ""
8795
8796 #. type: verbatim
8797 #: ../fish/guestfish-actions.pod:2384
8798 #, no-wrap
8799 msgid ""
8800 " inspect-os\n"
8801 "\n"
8802 msgstr ""
8803
8804 #. type: textblock
8805 #: ../fish/guestfish-actions.pod:2386 ../src/guestfs-actions.pod:3520
8806 msgid ""
8807 "This function uses other libguestfs functions and certain heuristics to "
8808 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
8809 "for operating systems."
8810 msgstr ""
8811
8812 #. type: textblock
8813 #: ../fish/guestfish-actions.pod:2390 ../src/guestfs-actions.pod:3524
8814 msgid "The list returned is empty if no operating systems were found."
8815 msgstr ""
8816
8817 #. type: textblock
8818 #: ../fish/guestfish-actions.pod:2392 ../src/guestfs-actions.pod:3526
8819 msgid ""
8820 "If one operating system was found, then this returns a list with a single "
8821 "element, which is the name of the root filesystem of this operating system.  "
8822 "It is also possible for this function to return a list containing more than "
8823 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
8824 "element being the root filesystem of one of the operating systems."
8825 msgstr ""
8826
8827 #. type: textblock
8828 #: ../fish/guestfish-actions.pod:2399
8829 msgid ""
8830 "You can pass the root string(s) returned to other L</inspect-get-*> "
8831 "functions in order to query further information about each operating system, "
8832 "such as the name and version."
8833 msgstr ""
8834
8835 #. type: textblock
8836 #: ../fish/guestfish-actions.pod:2404
8837 msgid ""
8838 "This function uses other libguestfs features such as L</mount-ro> and "
8839 "L</umount-all> in order to mount and unmount filesystems and look at the "
8840 "contents.  This should be called with no disks currently mounted.  The "
8841 "function may also use Augeas, so any existing Augeas handle will be closed."
8842 msgstr ""
8843
8844 #. type: textblock
8845 #: ../fish/guestfish-actions.pod:2410 ../src/guestfs-actions.pod:3544
8846 msgid ""
8847 "This function cannot decrypt encrypted disks.  The caller must do that first "
8848 "(supplying the necessary keys) if the disk is encrypted."
8849 msgstr ""
8850
8851 #. type: textblock
8852 #: ../fish/guestfish-actions.pod:2416 ../fish/guestfish-actions.pod:2614 ../fish/guestfish-actions.pod:2673
8853 msgid "See also L</list-filesystems>."
8854 msgstr ""
8855
8856 #. type: =head2
8857 #: ../fish/guestfish-actions.pod:2418
8858 msgid "is-blockdev"
8859 msgstr ""
8860
8861 #. type: verbatim
8862 #: ../fish/guestfish-actions.pod:2420
8863 #, no-wrap
8864 msgid ""
8865 " is-blockdev path\n"
8866 "\n"
8867 msgstr ""
8868
8869 #. type: textblock
8870 #: ../fish/guestfish-actions.pod:2422 ../src/guestfs-actions.pod:3564
8871 msgid ""
8872 "This returns C<true> if and only if there is a block device with the given "
8873 "C<path> name."
8874 msgstr ""
8875
8876 #. type: textblock
8877 #: ../fish/guestfish-actions.pod:2425 ../fish/guestfish-actions.pod:2443 ../fish/guestfish-actions.pod:2462 ../fish/guestfish-actions.pod:2471 ../fish/guestfish-actions.pod:2481 ../fish/guestfish-actions.pod:2515 ../fish/guestfish-actions.pod:2524
8878 msgid "See also L</stat>."
8879 msgstr ""
8880
8881 #. type: =head2
8882 #: ../fish/guestfish-actions.pod:2427
8883 msgid "is-busy"
8884 msgstr ""
8885
8886 #. type: verbatim
8887 #: ../fish/guestfish-actions.pod:2429
8888 #, no-wrap
8889 msgid ""
8890 " is-busy\n"
8891 "\n"
8892 msgstr ""
8893
8894 #. type: textblock
8895 #: ../fish/guestfish-actions.pod:2431 ../src/guestfs-actions.pod:3578
8896 msgid ""
8897 "This returns true iff this handle is busy processing a command (in the "
8898 "C<BUSY> state)."
8899 msgstr ""
8900
8901 #. type: =head2
8902 #: ../fish/guestfish-actions.pod:2436
8903 msgid "is-chardev"
8904 msgstr ""
8905
8906 #. type: verbatim
8907 #: ../fish/guestfish-actions.pod:2438
8908 #, no-wrap
8909 msgid ""
8910 " is-chardev path\n"
8911 "\n"
8912 msgstr ""
8913
8914 #. type: textblock
8915 #: ../fish/guestfish-actions.pod:2440 ../src/guestfs-actions.pod:3593
8916 msgid ""
8917 "This returns C<true> if and only if there is a character device with the "
8918 "given C<path> name."
8919 msgstr ""
8920
8921 #. type: =head2
8922 #: ../fish/guestfish-actions.pod:2445
8923 msgid "is-config"
8924 msgstr ""
8925
8926 #. type: verbatim
8927 #: ../fish/guestfish-actions.pod:2447
8928 #, no-wrap
8929 msgid ""
8930 " is-config\n"
8931 "\n"
8932 msgstr ""
8933
8934 #. type: textblock
8935 #: ../fish/guestfish-actions.pod:2449 ../src/guestfs-actions.pod:3607
8936 msgid ""
8937 "This returns true iff this handle is being configured (in the C<CONFIG> "
8938 "state)."
8939 msgstr ""
8940
8941 #. type: =head2
8942 #: ../fish/guestfish-actions.pod:2454
8943 msgid "is-dir"
8944 msgstr ""
8945
8946 #. type: verbatim
8947 #: ../fish/guestfish-actions.pod:2456
8948 #, no-wrap
8949 msgid ""
8950 " is-dir path\n"
8951 "\n"
8952 msgstr ""
8953
8954 #. type: textblock
8955 #: ../fish/guestfish-actions.pod:2458 ../src/guestfs-actions.pod:3622
8956 msgid ""
8957 "This returns C<true> if and only if there is a directory with the given "
8958 "C<path> name.  Note that it returns false for other objects like files."
8959 msgstr ""
8960
8961 #. type: =head2
8962 #: ../fish/guestfish-actions.pod:2464
8963 msgid "is-fifo"
8964 msgstr ""
8965
8966 #. type: verbatim
8967 #: ../fish/guestfish-actions.pod:2466
8968 #, no-wrap
8969 msgid ""
8970 " is-fifo path\n"
8971 "\n"
8972 msgstr ""
8973
8974 #. type: textblock
8975 #: ../fish/guestfish-actions.pod:2468 ../src/guestfs-actions.pod:3638
8976 msgid ""
8977 "This returns C<true> if and only if there is a FIFO (named pipe)  with the "
8978 "given C<path> name."
8979 msgstr ""
8980
8981 #. type: =head2
8982 #: ../fish/guestfish-actions.pod:2473
8983 msgid "is-file"
8984 msgstr ""
8985
8986 #. type: verbatim
8987 #: ../fish/guestfish-actions.pod:2475
8988 #, no-wrap
8989 msgid ""
8990 " is-file path\n"
8991 "\n"
8992 msgstr ""
8993
8994 #. type: textblock
8995 #: ../fish/guestfish-actions.pod:2477 ../src/guestfs-actions.pod:3653
8996 msgid ""
8997 "This returns C<true> if and only if there is a regular file with the given "
8998 "C<path> name.  Note that it returns false for other objects like "
8999 "directories."
9000 msgstr ""
9001
9002 #. type: =head2
9003 #: ../fish/guestfish-actions.pod:2483
9004 msgid "is-launching"
9005 msgstr ""
9006
9007 #. type: verbatim
9008 #: ../fish/guestfish-actions.pod:2485
9009 #, no-wrap
9010 msgid ""
9011 " is-launching\n"
9012 "\n"
9013 msgstr ""
9014
9015 #. type: textblock
9016 #: ../fish/guestfish-actions.pod:2487 ../src/guestfs-actions.pod:3668
9017 msgid ""
9018 "This returns true iff this handle is launching the subprocess (in the "
9019 "C<LAUNCHING> state)."
9020 msgstr ""
9021
9022 #. type: =head2
9023 #: ../fish/guestfish-actions.pod:2492
9024 msgid "is-lv"
9025 msgstr ""
9026
9027 #. type: verbatim
9028 #: ../fish/guestfish-actions.pod:2494
9029 #, no-wrap
9030 msgid ""
9031 " is-lv device\n"
9032 "\n"
9033 msgstr ""
9034
9035 #. type: textblock
9036 #: ../fish/guestfish-actions.pod:2496 ../src/guestfs-actions.pod:3683
9037 msgid ""
9038 "This command tests whether C<device> is a logical volume, and returns true "
9039 "iff this is the case."
9040 msgstr ""
9041
9042 #. type: =head2
9043 #: ../fish/guestfish-actions.pod:2499
9044 msgid "is-ready"
9045 msgstr ""
9046
9047 #. type: verbatim
9048 #: ../fish/guestfish-actions.pod:2501
9049 #, no-wrap
9050 msgid ""
9051 " is-ready\n"
9052 "\n"
9053 msgstr ""
9054
9055 #. type: textblock
9056 #: ../fish/guestfish-actions.pod:2503 ../src/guestfs-actions.pod:3695
9057 msgid ""
9058 "This returns true iff this handle is ready to accept commands (in the "
9059 "C<READY> state)."
9060 msgstr ""
9061
9062 #. type: =head2
9063 #: ../fish/guestfish-actions.pod:2508
9064 msgid "is-socket"
9065 msgstr ""
9066
9067 #. type: verbatim
9068 #: ../fish/guestfish-actions.pod:2510
9069 #, no-wrap
9070 msgid ""
9071 " is-socket path\n"
9072 "\n"
9073 msgstr ""
9074
9075 #. type: textblock
9076 #: ../fish/guestfish-actions.pod:2512 ../src/guestfs-actions.pod:3710
9077 msgid ""
9078 "This returns C<true> if and only if there is a Unix domain socket with the "
9079 "given C<path> name."
9080 msgstr ""
9081
9082 #. type: =head2
9083 #: ../fish/guestfish-actions.pod:2517
9084 msgid "is-symlink"
9085 msgstr ""
9086
9087 #. type: verbatim
9088 #: ../fish/guestfish-actions.pod:2519
9089 #, no-wrap
9090 msgid ""
9091 " is-symlink path\n"
9092 "\n"
9093 msgstr ""
9094
9095 #. type: textblock
9096 #: ../fish/guestfish-actions.pod:2521 ../src/guestfs-actions.pod:3725
9097 msgid ""
9098 "This returns C<true> if and only if there is a symbolic link with the given "
9099 "C<path> name."
9100 msgstr ""
9101
9102 #. type: =head2
9103 #: ../fish/guestfish-actions.pod:2526
9104 msgid "is-zero"
9105 msgstr ""
9106
9107 #. type: verbatim
9108 #: ../fish/guestfish-actions.pod:2528
9109 #, no-wrap
9110 msgid ""
9111 " is-zero path\n"
9112 "\n"
9113 msgstr ""
9114
9115 #. type: textblock
9116 #: ../fish/guestfish-actions.pod:2530 ../src/guestfs-actions.pod:3740
9117 msgid ""
9118 "This returns true iff the file exists and the file is empty or it contains "
9119 "all zero bytes."
9120 msgstr ""
9121
9122 #. type: =head2
9123 #: ../fish/guestfish-actions.pod:2533
9124 msgid "is-zero-device"
9125 msgstr ""
9126
9127 #. type: verbatim
9128 #: ../fish/guestfish-actions.pod:2535
9129 #, no-wrap
9130 msgid ""
9131 " is-zero-device device\n"
9132 "\n"
9133 msgstr ""
9134
9135 #. type: textblock
9136 #: ../fish/guestfish-actions.pod:2537 ../src/guestfs-actions.pod:3753
9137 msgid "This returns true iff the device exists and contains all zero bytes."
9138 msgstr ""
9139
9140 #. type: textblock
9141 #: ../fish/guestfish-actions.pod:2539 ../src/guestfs-actions.pod:3755
9142 msgid "Note that for large devices this can take a long time to run."
9143 msgstr ""
9144
9145 #. type: =head2
9146 #: ../fish/guestfish-actions.pod:2541
9147 msgid "kill-subprocess"
9148 msgstr ""
9149
9150 #. type: verbatim
9151 #: ../fish/guestfish-actions.pod:2543
9152 #, no-wrap
9153 msgid ""
9154 " kill-subprocess\n"
9155 "\n"
9156 msgstr ""
9157
9158 #. type: textblock
9159 #: ../fish/guestfish-actions.pod:2545 ../src/guestfs-actions.pod:3766
9160 msgid "This kills the qemu subprocess.  You should never need to call this."
9161 msgstr ""
9162
9163 #. type: =head2
9164 #: ../fish/guestfish-actions.pod:2547
9165 msgid "launch"
9166 msgstr ""
9167
9168 #. type: =head2
9169 #: ../fish/guestfish-actions.pod:2549
9170 msgid "run"
9171 msgstr ""
9172
9173 #. type: verbatim
9174 #: ../fish/guestfish-actions.pod:2551
9175 #, no-wrap
9176 msgid ""
9177 " launch\n"
9178 "\n"
9179 msgstr ""
9180
9181 #. type: textblock
9182 #: ../fish/guestfish-actions.pod:2553 ../src/guestfs-actions.pod:3777
9183 msgid ""
9184 "Internally libguestfs is implemented by running a virtual machine using "
9185 "L<qemu(1)>."
9186 msgstr ""
9187
9188 #. type: textblock
9189 #: ../fish/guestfish-actions.pod:2556 ../src/guestfs-actions.pod:3780
9190 msgid ""
9191 "You should call this after configuring the handle (eg. adding drives) but "
9192 "before performing any actions."
9193 msgstr ""
9194
9195 #. type: =head2
9196 #: ../fish/guestfish-actions.pod:2559
9197 msgid "lchown"
9198 msgstr ""
9199
9200 #. type: verbatim
9201 #: ../fish/guestfish-actions.pod:2561
9202 #, no-wrap
9203 msgid ""
9204 " lchown owner group path\n"
9205 "\n"
9206 msgstr ""
9207
9208 #. type: textblock
9209 #: ../fish/guestfish-actions.pod:2563
9210 msgid ""
9211 "Change the file owner to C<owner> and group to C<group>.  This is like "
9212 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
9213 "the target."
9214 msgstr ""
9215
9216 #. type: =head2
9217 #: ../fish/guestfish-actions.pod:2571
9218 msgid "lgetxattr"
9219 msgstr ""
9220
9221 #. type: verbatim
9222 #: ../fish/guestfish-actions.pod:2573
9223 #, no-wrap
9224 msgid ""
9225 " lgetxattr path name\n"
9226 "\n"
9227 msgstr ""
9228
9229 #. type: textblock
9230 #: ../fish/guestfish-actions.pod:2575 ../src/guestfs-actions.pod:3820
9231 msgid ""
9232 "Get a single extended attribute from file C<path> named C<name>.  If C<path> "
9233 "is a symlink, then this call returns an extended attribute from the symlink."
9234 msgstr ""
9235
9236 #. type: textblock
9237 #: ../fish/guestfish-actions.pod:2589
9238 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
9239 msgstr ""
9240
9241 #. type: =head2
9242 #: ../fish/guestfish-actions.pod:2591
9243 msgid "lgetxattrs"
9244 msgstr ""
9245
9246 #. type: verbatim
9247 #: ../fish/guestfish-actions.pod:2593
9248 #, no-wrap
9249 msgid ""
9250 " lgetxattrs path\n"
9251 "\n"
9252 msgstr ""
9253
9254 #. type: textblock
9255 #: ../fish/guestfish-actions.pod:2595
9256 msgid ""
9257 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
9258 "it returns the extended attributes of the link itself."
9259 msgstr ""
9260
9261 #. type: =head2
9262 #: ../fish/guestfish-actions.pod:2599
9263 msgid "list-9p"
9264 msgstr ""
9265
9266 #. type: verbatim
9267 #: ../fish/guestfish-actions.pod:2601
9268 #, no-wrap
9269 msgid ""
9270 " list-9p\n"
9271 "\n"
9272 msgstr ""
9273
9274 #. type: textblock
9275 #: ../fish/guestfish-actions.pod:2603 ../src/guestfs-actions.pod:3863
9276 msgid ""
9277 "List all 9p filesystems attached to the guest.  A list of mount tags is "
9278 "returned."
9279 msgstr ""
9280
9281 #. type: =head2
9282 #: ../fish/guestfish-actions.pod:2606
9283 msgid "list-devices"
9284 msgstr ""
9285
9286 #. type: verbatim
9287 #: ../fish/guestfish-actions.pod:2608
9288 #, no-wrap
9289 msgid ""
9290 " list-devices\n"
9291 "\n"
9292 msgstr ""
9293
9294 #. type: textblock
9295 #: ../fish/guestfish-actions.pod:2610 ../src/guestfs-actions.pod:3877
9296 msgid "List all the block devices."
9297 msgstr ""
9298
9299 #. type: textblock
9300 #: ../fish/guestfish-actions.pod:2612 ../src/guestfs-actions.pod:3879
9301 msgid "The full block device names are returned, eg. C</dev/sda>."
9302 msgstr ""
9303
9304 #. type: =head2
9305 #: ../fish/guestfish-actions.pod:2616
9306 msgid "list-dm-devices"
9307 msgstr ""
9308
9309 #. type: verbatim
9310 #: ../fish/guestfish-actions.pod:2618
9311 #, no-wrap
9312 msgid ""
9313 " list-dm-devices\n"
9314 "\n"
9315 msgstr ""
9316
9317 #. type: textblock
9318 #: ../fish/guestfish-actions.pod:2620 ../src/guestfs-actions.pod:3894
9319 msgid "List all device mapper devices."
9320 msgstr ""
9321
9322 #. type: textblock
9323 #: ../fish/guestfish-actions.pod:2622
9324 msgid ""
9325 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
9326 "previous call to L</luks-open>."
9327 msgstr ""
9328
9329 #. type: textblock
9330 #: ../fish/guestfish-actions.pod:2625
9331 msgid ""
9332 "Device mapper devices which correspond to logical volumes are I<not> "
9333 "returned in this list.  Call L</lvs> if you want to list logical volumes."
9334 msgstr ""
9335
9336 #. type: =head2
9337 #: ../fish/guestfish-actions.pod:2629
9338 msgid "list-filesystems"
9339 msgstr ""
9340
9341 #. type: verbatim
9342 #: ../fish/guestfish-actions.pod:2631
9343 #, no-wrap
9344 msgid ""
9345 " list-filesystems\n"
9346 "\n"
9347 msgstr ""
9348
9349 #. type: textblock
9350 #: ../fish/guestfish-actions.pod:2633 ../src/guestfs-actions.pod:3914
9351 msgid ""
9352 "This inspection command looks for filesystems on partitions, block devices "
9353 "and logical volumes, returning a list of devices containing filesystems and "
9354 "their type."
9355 msgstr ""
9356
9357 #. type: textblock
9358 #: ../fish/guestfish-actions.pod:2637 ../src/guestfs-actions.pod:3918
9359 msgid ""
9360 "The return value is a hash, where the keys are the devices containing "
9361 "filesystems, and the values are the filesystem types.  For example:"
9362 msgstr ""
9363
9364 #. type: verbatim
9365 #: ../fish/guestfish-actions.pod:2641 ../src/guestfs-actions.pod:3922
9366 #, no-wrap
9367 msgid ""
9368 " \"/dev/sda1\" => \"ntfs\"\n"
9369 " \"/dev/sda2\" => \"ext2\"\n"
9370 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9371 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9372 "\n"
9373 msgstr ""
9374
9375 #. type: textblock
9376 #: ../fish/guestfish-actions.pod:2646 ../src/guestfs-actions.pod:3927
9377 msgid ""
9378 "The value can have the special value \"unknown\", meaning the content of the "
9379 "device is undetermined or empty.  \"swap\" means a Linux swap partition."
9380 msgstr ""
9381
9382 #. type: textblock
9383 #: ../fish/guestfish-actions.pod:2650
9384 msgid ""
9385 "This command runs other libguestfs commands, which might include L</mount> "
9386 "and L</umount>, and therefore you should use this soon after launch and only "
9387 "when nothing is mounted."
9388 msgstr ""
9389
9390 #. type: textblock
9391 #: ../fish/guestfish-actions.pod:2654
9392 msgid ""
9393 "Not all of the filesystems returned will be mountable.  In particular, swap "
9394 "partitions are returned in the list.  Also this command does not check that "
9395 "each filesystem found is valid and mountable, and some filesystems might be "
9396 "mountable but require special options.  Filesystems may not all belong to a "
9397 "single logical operating system (use L</inspect-os> to look for OSes)."
9398 msgstr ""
9399
9400 #. type: =head2
9401 #: ../fish/guestfish-actions.pod:2662
9402 msgid "list-partitions"
9403 msgstr ""
9404
9405 #. type: verbatim
9406 #: ../fish/guestfish-actions.pod:2664
9407 #, no-wrap
9408 msgid ""
9409 " list-partitions\n"
9410 "\n"
9411 msgstr ""
9412
9413 #. type: textblock
9414 #: ../fish/guestfish-actions.pod:2666 ../src/guestfs-actions.pod:3956
9415 msgid "List all the partitions detected on all block devices."
9416 msgstr ""
9417
9418 #. type: textblock
9419 #: ../fish/guestfish-actions.pod:2668 ../src/guestfs-actions.pod:3958
9420 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9421 msgstr ""
9422
9423 #. type: textblock
9424 #: ../fish/guestfish-actions.pod:2670
9425 msgid ""
9426 "This does not return logical volumes.  For that you will need to call "
9427 "L</lvs>."
9428 msgstr ""
9429
9430 #. type: =head2
9431 #: ../fish/guestfish-actions.pod:2675
9432 msgid "ll"
9433 msgstr ""
9434
9435 #. type: verbatim
9436 #: ../fish/guestfish-actions.pod:2677
9437 #, no-wrap
9438 msgid ""
9439 " ll directory\n"
9440 "\n"
9441 msgstr ""
9442
9443 #. type: textblock
9444 #: ../fish/guestfish-actions.pod:2679 ../src/guestfs-actions.pod:3977
9445 msgid ""
9446 "List the files in C<directory> (relative to the root directory, there is no "
9447 "cwd) in the format of 'ls -la'."
9448 msgstr ""
9449
9450 #. type: textblock
9451 #: ../fish/guestfish-actions.pod:2682 ../src/guestfs-actions.pod:3980
9452 msgid ""
9453 "This command is mostly useful for interactive sessions.  It is I<not> "
9454 "intended that you try to parse the output string."
9455 msgstr ""
9456
9457 #. type: =head2
9458 #: ../fish/guestfish-actions.pod:2685
9459 msgid "ln"
9460 msgstr ""
9461
9462 #. type: verbatim
9463 #: ../fish/guestfish-actions.pod:2687
9464 #, no-wrap
9465 msgid ""
9466 " ln target linkname\n"
9467 "\n"
9468 msgstr ""
9469
9470 #. type: textblock
9471 #: ../fish/guestfish-actions.pod:2689 ../src/guestfs-actions.pod:3995
9472 msgid "This command creates a hard link using the C<ln> command."
9473 msgstr ""
9474
9475 #. type: =head2
9476 #: ../fish/guestfish-actions.pod:2691
9477 msgid "ln-f"
9478 msgstr ""
9479
9480 #. type: verbatim
9481 #: ../fish/guestfish-actions.pod:2693
9482 #, no-wrap
9483 msgid ""
9484 " ln-f target linkname\n"
9485 "\n"
9486 msgstr ""
9487
9488 #. type: textblock
9489 #: ../fish/guestfish-actions.pod:2695 ../src/guestfs-actions.pod:4008
9490 msgid ""
9491 "This command creates a hard link using the C<ln -f> command.  The I<-f> "
9492 "option removes the link (C<linkname>) if it exists already."
9493 msgstr ""
9494
9495 #. type: =head2
9496 #: ../fish/guestfish-actions.pod:2698
9497 msgid "ln-s"
9498 msgstr ""
9499
9500 #. type: verbatim
9501 #: ../fish/guestfish-actions.pod:2700
9502 #, no-wrap
9503 msgid ""
9504 " ln-s target linkname\n"
9505 "\n"
9506 msgstr ""
9507
9508 #. type: textblock
9509 #: ../fish/guestfish-actions.pod:2702 ../src/guestfs-actions.pod:4022
9510 msgid "This command creates a symbolic link using the C<ln -s> command."
9511 msgstr ""
9512
9513 #. type: =head2
9514 #: ../fish/guestfish-actions.pod:2704
9515 msgid "ln-sf"
9516 msgstr ""
9517
9518 #. type: verbatim
9519 #: ../fish/guestfish-actions.pod:2706
9520 #, no-wrap
9521 msgid ""
9522 " ln-sf target linkname\n"
9523 "\n"
9524 msgstr ""
9525
9526 #. type: textblock
9527 #: ../fish/guestfish-actions.pod:2708 ../src/guestfs-actions.pod:4035
9528 msgid ""
9529 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
9530 "option removes the link (C<linkname>) if it exists already."
9531 msgstr ""
9532
9533 #. type: =head2
9534 #: ../fish/guestfish-actions.pod:2711
9535 msgid "lremovexattr"
9536 msgstr ""
9537
9538 #. type: verbatim
9539 #: ../fish/guestfish-actions.pod:2713
9540 #, no-wrap
9541 msgid ""
9542 " lremovexattr xattr path\n"
9543 "\n"
9544 msgstr ""
9545
9546 #. type: textblock
9547 #: ../fish/guestfish-actions.pod:2715
9548 msgid ""
9549 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
9550 "it removes an extended attribute of the link itself."
9551 msgstr ""
9552
9553 #. type: =head2
9554 #: ../fish/guestfish-actions.pod:2719
9555 msgid "ls"
9556 msgstr ""
9557
9558 #. type: verbatim
9559 #: ../fish/guestfish-actions.pod:2721
9560 #, no-wrap
9561 msgid ""
9562 " ls directory\n"
9563 "\n"
9564 msgstr ""
9565
9566 #. type: textblock
9567 #: ../fish/guestfish-actions.pod:2723 ../src/guestfs-actions.pod:4063
9568 msgid ""
9569 "List the files in C<directory> (relative to the root directory, there is no "
9570 "cwd).  The '.' and '..' entries are not returned, but hidden files are "
9571 "shown."
9572 msgstr ""
9573
9574 #. type: textblock
9575 #: ../fish/guestfish-actions.pod:2727
9576 msgid ""
9577 "This command is mostly useful for interactive sessions.  Programs should "
9578 "probably use L</readdir> instead."
9579 msgstr ""
9580
9581 #. type: =head2
9582 #: ../fish/guestfish-actions.pod:2730
9583 msgid "lsetxattr"
9584 msgstr ""
9585
9586 #. type: verbatim
9587 #: ../fish/guestfish-actions.pod:2732
9588 #, no-wrap
9589 msgid ""
9590 " lsetxattr xattr val vallen path\n"
9591 "\n"
9592 msgstr ""
9593
9594 #. type: textblock
9595 #: ../fish/guestfish-actions.pod:2734
9596 msgid ""
9597 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
9598 "sets an extended attribute of the link itself."
9599 msgstr ""
9600
9601 #. type: =head2
9602 #: ../fish/guestfish-actions.pod:2738
9603 msgid "lstat"
9604 msgstr ""
9605
9606 #. type: verbatim
9607 #: ../fish/guestfish-actions.pod:2740
9608 #, no-wrap
9609 msgid ""
9610 " lstat path\n"
9611 "\n"
9612 msgstr ""
9613
9614 #. type: textblock
9615 #: ../fish/guestfish-actions.pod:2742 ../fish/guestfish-actions.pod:4562 ../src/guestfs-actions.pod:4099 ../src/guestfs-actions.pod:6892
9616 msgid "Returns file information for the given C<path>."
9617 msgstr ""
9618
9619 #. type: textblock
9620 #: ../fish/guestfish-actions.pod:2744
9621 msgid ""
9622 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
9623 "the link is stat-ed, not the file it refers to."
9624 msgstr ""
9625
9626 #. type: textblock
9627 #: ../fish/guestfish-actions.pod:2748 ../src/guestfs-actions.pod:4105
9628 msgid "This is the same as the C<lstat(2)> system call."
9629 msgstr ""
9630
9631 #. type: =head2
9632 #: ../fish/guestfish-actions.pod:2750
9633 msgid "lstatlist"
9634 msgstr ""
9635
9636 #. type: verbatim
9637 #: ../fish/guestfish-actions.pod:2752
9638 #, no-wrap
9639 msgid ""
9640 " lstatlist path 'names ...'\n"
9641 "\n"
9642 msgstr ""
9643
9644 #. type: textblock
9645 #: ../fish/guestfish-actions.pod:2754
9646 msgid ""
9647 "This call allows you to perform the L</lstat> operation on multiple files, "
9648 "where all files are in the directory C<path>.  C<names> is the list of files "
9649 "from this directory."
9650 msgstr ""
9651
9652 #. type: textblock
9653 #: ../fish/guestfish-actions.pod:2758 ../src/guestfs-actions.pod:4124
9654 msgid ""
9655 "On return you get a list of stat structs, with a one-to-one correspondence "
9656 "to the C<names> list.  If any name did not exist or could not be lstat'd, "
9657 "then the C<ino> field of that structure is set to C<-1>."
9658 msgstr ""
9659
9660 #. type: textblock
9661 #: ../fish/guestfish-actions.pod:2763
9662 msgid ""
9663 "This call is intended for programs that want to efficiently list a directory "
9664 "contents without making many round-trips.  See also L</lxattrlist> for a "
9665 "similarly efficient call for getting extended attributes.  Very long "
9666 "directory listings might cause the protocol message size to be exceeded, "
9667 "causing this call to fail.  The caller must split up such requests into "
9668 "smaller groups of names."
9669 msgstr ""
9670
9671 #. type: =head2
9672 #: ../fish/guestfish-actions.pod:2771
9673 msgid "luks-add-key"
9674 msgstr ""
9675
9676 #. type: verbatim
9677 #: ../fish/guestfish-actions.pod:2773
9678 #, no-wrap
9679 msgid ""
9680 " luks-add-key device keyslot\n"
9681 "\n"
9682 msgstr ""
9683
9684 #. type: textblock
9685 #: ../fish/guestfish-actions.pod:2775 ../src/guestfs-actions.pod:4152
9686 msgid ""
9687 "This command adds a new key on LUKS device C<device>.  C<key> is any "
9688 "existing key, and is used to access the device.  C<newkey> is the new key to "
9689 "add.  C<keyslot> is the key slot that will be replaced."
9690 msgstr ""
9691
9692 #. type: textblock
9693 #: ../fish/guestfish-actions.pod:2780
9694 msgid ""
9695 "Note that if C<keyslot> already contains a key, then this command will "
9696 "fail.  You have to use L</luks-kill-slot> first to remove that key."
9697 msgstr ""
9698
9699 #. type: textblock
9700 #: ../fish/guestfish-actions.pod:2784 ../fish/guestfish-actions.pod:2806 ../fish/guestfish-actions.pod:2819 ../fish/guestfish-actions.pod:2833 ../fish/guestfish-actions.pod:2859 ../fish/guestfish-actions.pod:2869
9701 msgid ""
9702 "This command has one or more key or passphrase parameters.  Guestfish will "
9703 "prompt for these separately."
9704 msgstr ""
9705
9706 #. type: =head2
9707 #: ../fish/guestfish-actions.pod:2787
9708 msgid "luks-close"
9709 msgstr ""
9710
9711 #. type: verbatim
9712 #: ../fish/guestfish-actions.pod:2789
9713 #, no-wrap
9714 msgid ""
9715 " luks-close device\n"
9716 "\n"
9717 msgstr ""
9718
9719 #. type: textblock
9720 #: ../fish/guestfish-actions.pod:2791
9721 msgid ""
9722 "This closes a LUKS device that was created earlier by L</luks-open> or "
9723 "L</luks-open-ro>.  The C<device> parameter must be the name of the LUKS "
9724 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
9725 "underlying block device."
9726 msgstr ""
9727
9728 #. type: =head2
9729 #: ../fish/guestfish-actions.pod:2797
9730 msgid "luks-format"
9731 msgstr ""
9732
9733 #. type: verbatim
9734 #: ../fish/guestfish-actions.pod:2799
9735 #, no-wrap
9736 msgid ""
9737 " luks-format device keyslot\n"
9738 "\n"
9739 msgstr ""
9740
9741 #. type: textblock
9742 #: ../fish/guestfish-actions.pod:2801 ../src/guestfs-actions.pod:4193
9743 msgid ""
9744 "This command erases existing data on C<device> and formats the device as a "
9745 "LUKS encrypted device.  C<key> is the initial key, which is added to key "
9746 "slot C<slot>.  (LUKS supports 8 key slots, numbered 0-7)."
9747 msgstr ""
9748
9749 #. type: textblock
9750 #: ../fish/guestfish-actions.pod:2809 ../fish/guestfish-actions.pod:2822 ../fish/guestfish-actions.pod:2909 ../fish/guestfish-actions.pod:3570 ../fish/guestfish-actions.pod:4096 ../fish/guestfish-actions.pod:4433 ../fish/guestfish-actions.pod:4456 ../fish/guestfish-actions.pod:4478 ../fish/guestfish-actions.pod:5224 ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:4223 ../src/guestfs-actions.pod:4366 ../src/guestfs-actions.pod:5469 ../src/guestfs-actions.pod:6257 ../src/guestfs-actions.pod:6706 ../src/guestfs-actions.pod:6736 ../src/guestfs-actions.pod:6769 ../src/guestfs-actions.pod:7968
9751 msgid ""
9752 "B<This command is dangerous.  Without careful use you can easily destroy all "
9753 "your data>."
9754 msgstr ""
9755
9756 #. type: =head2
9757 #: ../fish/guestfish-actions.pod:2812
9758 msgid "luks-format-cipher"
9759 msgstr ""
9760
9761 #. type: verbatim
9762 #: ../fish/guestfish-actions.pod:2814
9763 #, no-wrap
9764 msgid ""
9765 " luks-format-cipher device keyslot cipher\n"
9766 "\n"
9767 msgstr ""
9768
9769 #. type: textblock
9770 #: ../fish/guestfish-actions.pod:2816
9771 msgid ""
9772 "This command is the same as L</luks-format> but it also allows you to set "
9773 "the C<cipher> used."
9774 msgstr ""
9775
9776 #. type: =head2
9777 #: ../fish/guestfish-actions.pod:2825
9778 msgid "luks-kill-slot"
9779 msgstr ""
9780
9781 #. type: verbatim
9782 #: ../fish/guestfish-actions.pod:2827
9783 #, no-wrap
9784 msgid ""
9785 " luks-kill-slot device keyslot\n"
9786 "\n"
9787 msgstr ""
9788
9789 #. type: textblock
9790 #: ../fish/guestfish-actions.pod:2829 ../src/guestfs-actions.pod:4240
9791 msgid ""
9792 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
9793 "device C<device>.  C<key> must be one of the I<other> keys."
9794 msgstr ""
9795
9796 #. type: =head2
9797 #: ../fish/guestfish-actions.pod:2836
9798 msgid "luks-open"
9799 msgstr ""
9800
9801 #. type: verbatim
9802 #: ../fish/guestfish-actions.pod:2838
9803 #, no-wrap
9804 msgid ""
9805 " luks-open device mapname\n"
9806 "\n"
9807 msgstr ""
9808
9809 #. type: textblock
9810 #: ../fish/guestfish-actions.pod:2840 ../src/guestfs-actions.pod:4260
9811 msgid ""
9812 "This command opens a block device which has been encrypted according to the "
9813 "Linux Unified Key Setup (LUKS) standard."
9814 msgstr ""
9815
9816 #. type: textblock
9817 #: ../fish/guestfish-actions.pod:2843 ../src/guestfs-actions.pod:4263
9818 msgid "C<device> is the encrypted block device or partition."
9819 msgstr ""
9820
9821 #. type: textblock
9822 #: ../fish/guestfish-actions.pod:2845 ../src/guestfs-actions.pod:4265
9823 msgid ""
9824 "The caller must supply one of the keys associated with the LUKS block "
9825 "device, in the C<key> parameter."
9826 msgstr ""
9827
9828 #. type: textblock
9829 #: ../fish/guestfish-actions.pod:2848 ../src/guestfs-actions.pod:4268
9830 msgid ""
9831 "This creates a new block device called C</dev/mapper/mapname>.  Reads and "
9832 "writes to this block device are decrypted from and encrypted to the "
9833 "underlying C<device> respectively."
9834 msgstr ""
9835
9836 #. type: textblock
9837 #: ../fish/guestfish-actions.pod:2852
9838 msgid ""
9839 "If this block device contains LVM volume groups, then calling L</vgscan> "
9840 "followed by L</vg-activate-all> will make them visible."
9841 msgstr ""
9842
9843 #. type: textblock
9844 #: ../fish/guestfish-actions.pod:2856
9845 msgid "Use L</list-dm-devices> to list all device mapper devices."
9846 msgstr ""
9847
9848 #. type: =head2
9849 #: ../fish/guestfish-actions.pod:2862
9850 msgid "luks-open-ro"
9851 msgstr ""
9852
9853 #. type: verbatim
9854 #: ../fish/guestfish-actions.pod:2864
9855 #, no-wrap
9856 msgid ""
9857 " luks-open-ro device mapname\n"
9858 "\n"
9859 msgstr ""
9860
9861 #. type: textblock
9862 #: ../fish/guestfish-actions.pod:2866
9863 msgid ""
9864 "This is the same as L</luks-open> except that a read-only mapping is "
9865 "created."
9866 msgstr ""
9867
9868 #. type: =head2
9869 #: ../fish/guestfish-actions.pod:2872
9870 msgid "lvcreate"
9871 msgstr ""
9872
9873 #. type: verbatim
9874 #: ../fish/guestfish-actions.pod:2874
9875 #, no-wrap
9876 msgid ""
9877 " lvcreate logvol volgroup mbytes\n"
9878 "\n"
9879 msgstr ""
9880
9881 #. type: textblock
9882 #: ../fish/guestfish-actions.pod:2876 ../src/guestfs-actions.pod:4314
9883 msgid ""
9884 "This creates an LVM logical volume called C<logvol> on the volume group "
9885 "C<volgroup>, with C<size> megabytes."
9886 msgstr ""
9887
9888 #. type: =head2
9889 #: ../fish/guestfish-actions.pod:2879
9890 msgid "lvm-canonical-lv-name"
9891 msgstr ""
9892
9893 #. type: verbatim
9894 #: ../fish/guestfish-actions.pod:2881
9895 #, no-wrap
9896 msgid ""
9897 " lvm-canonical-lv-name lvname\n"
9898 "\n"
9899 msgstr ""
9900
9901 #. type: textblock
9902 #: ../fish/guestfish-actions.pod:2883 ../src/guestfs-actions.pod:4327
9903 msgid ""
9904 "This converts alternative naming schemes for LVs that you might find to the "
9905 "canonical name.  For example, C</dev/mapper/VG-LV> is converted to "
9906 "C</dev/VG/LV>."
9907 msgstr ""
9908
9909 #. type: textblock
9910 #: ../fish/guestfish-actions.pod:2887 ../src/guestfs-actions.pod:4331
9911 msgid ""
9912 "This command returns an error if the C<lvname> parameter does not refer to a "
9913 "logical volume."
9914 msgstr ""
9915
9916 #. type: textblock
9917 #: ../fish/guestfish-actions.pod:2890
9918 msgid "See also L</is-lv>."
9919 msgstr ""
9920
9921 #. type: =head2
9922 #: ../fish/guestfish-actions.pod:2892
9923 msgid "lvm-clear-filter"
9924 msgstr ""
9925
9926 #. type: verbatim
9927 #: ../fish/guestfish-actions.pod:2894
9928 #, no-wrap
9929 msgid ""
9930 " lvm-clear-filter\n"
9931 "\n"
9932 msgstr ""
9933
9934 #. type: textblock
9935 #: ../fish/guestfish-actions.pod:2896
9936 msgid ""
9937 "This undoes the effect of L</lvm-set-filter>.  LVM will be able to see every "
9938 "block device."
9939 msgstr ""
9940
9941 #. type: textblock
9942 #: ../fish/guestfish-actions.pod:2899 ../fish/guestfish-actions.pod:2930 ../src/guestfs-actions.pod:4349 ../src/guestfs-actions.pod:4391
9943 msgid "This command also clears the LVM cache and performs a volume group scan."
9944 msgstr ""
9945
9946 #. type: =head2
9947 #: ../fish/guestfish-actions.pod:2902
9948 msgid "lvm-remove-all"
9949 msgstr ""
9950
9951 #. type: verbatim
9952 #: ../fish/guestfish-actions.pod:2904
9953 #, no-wrap
9954 msgid ""
9955 " lvm-remove-all\n"
9956 "\n"
9957 msgstr ""
9958
9959 #. type: textblock
9960 #: ../fish/guestfish-actions.pod:2906 ../src/guestfs-actions.pod:4361
9961 msgid ""
9962 "This command removes all LVM logical volumes, volume groups and physical "
9963 "volumes."
9964 msgstr ""
9965
9966 #. type: =head2
9967 #: ../fish/guestfish-actions.pod:2912
9968 msgid "lvm-set-filter"
9969 msgstr ""
9970
9971 #. type: verbatim
9972 #: ../fish/guestfish-actions.pod:2914
9973 #, no-wrap
9974 msgid ""
9975 " lvm-set-filter 'devices ...'\n"
9976 "\n"
9977 msgstr ""
9978
9979 #. type: textblock
9980 #: ../fish/guestfish-actions.pod:2916 ../src/guestfs-actions.pod:4377
9981 msgid ""
9982 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
9983 "block devices in the list C<devices>, and will ignore all other attached "
9984 "block devices."
9985 msgstr ""
9986
9987 #. type: textblock
9988 #: ../fish/guestfish-actions.pod:2920 ../src/guestfs-actions.pod:4381
9989 msgid ""
9990 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
9991 "get LVM to ignore the duplicates, otherwise LVM can get confused.  Note also "
9992 "there are two types of duplication possible: either cloned PVs/VGs which "
9993 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
9994 "same name.  In normal operation you cannot create this situation, but you "
9995 "can do it outside LVM, eg.  by cloning disk images or by bit twiddling "
9996 "inside the LVM metadata."
9997 msgstr ""
9998
9999 #. type: textblock
10000 #: ../fish/guestfish-actions.pod:2933 ../src/guestfs-actions.pod:4394
10001 msgid "You can filter whole block devices or individual partitions."
10002 msgstr ""
10003
10004 #. type: textblock
10005 #: ../fish/guestfish-actions.pod:2935 ../src/guestfs-actions.pod:4396
10006 msgid ""
10007 "You cannot use this if any VG is currently in use (eg.  contains a mounted "
10008 "filesystem), even if you are not filtering out that VG."
10009 msgstr ""
10010
10011 #. type: =head2
10012 #: ../fish/guestfish-actions.pod:2939
10013 msgid "lvremove"
10014 msgstr ""
10015
10016 #. type: verbatim
10017 #: ../fish/guestfish-actions.pod:2941
10018 #, no-wrap
10019 msgid ""
10020 " lvremove device\n"
10021 "\n"
10022 msgstr ""
10023
10024 #. type: textblock
10025 #: ../fish/guestfish-actions.pod:2943 ../src/guestfs-actions.pod:4410
10026 msgid ""
10027 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10028 "LV, such as C</dev/VG/LV>."
10029 msgstr ""
10030
10031 #. type: textblock
10032 #: ../fish/guestfish-actions.pod:2946 ../src/guestfs-actions.pod:4413
10033 msgid ""
10034 "You can also remove all LVs in a volume group by specifying the VG name, "
10035 "C</dev/VG>."
10036 msgstr ""
10037
10038 #. type: =head2
10039 #: ../fish/guestfish-actions.pod:2949
10040 msgid "lvrename"
10041 msgstr ""
10042
10043 #. type: verbatim
10044 #: ../fish/guestfish-actions.pod:2951
10045 #, no-wrap
10046 msgid ""
10047 " lvrename logvol newlogvol\n"
10048 "\n"
10049 msgstr ""
10050
10051 #. type: textblock
10052 #: ../fish/guestfish-actions.pod:2953 ../src/guestfs-actions.pod:4427
10053 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10054 msgstr ""
10055
10056 #. type: =head2
10057 #: ../fish/guestfish-actions.pod:2955
10058 msgid "lvresize"
10059 msgstr ""
10060
10061 #. type: verbatim
10062 #: ../fish/guestfish-actions.pod:2957
10063 #, no-wrap
10064 msgid ""
10065 " lvresize device mbytes\n"
10066 "\n"
10067 msgstr ""
10068
10069 #. type: textblock
10070 #: ../fish/guestfish-actions.pod:2959 ../src/guestfs-actions.pod:4440
10071 msgid ""
10072 "This resizes (expands or shrinks) an existing LVM logical volume to "
10073 "C<mbytes>.  When reducing, data in the reduced part is lost."
10074 msgstr ""
10075
10076 #. type: =head2
10077 #: ../fish/guestfish-actions.pod:2963
10078 msgid "lvresize-free"
10079 msgstr ""
10080
10081 #. type: verbatim
10082 #: ../fish/guestfish-actions.pod:2965
10083 #, no-wrap
10084 msgid ""
10085 " lvresize-free lv percent\n"
10086 "\n"
10087 msgstr ""
10088
10089 #. type: textblock
10090 #: ../fish/guestfish-actions.pod:2967 ../src/guestfs-actions.pod:4455
10091 msgid ""
10092 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10093 "remaining free space in the volume group.  Commonly you would call this with "
10094 "pc = 100 which expands the logical volume as much as possible, using all "
10095 "remaining free space in the volume group."
10096 msgstr ""
10097
10098 #. type: =head2
10099 #: ../fish/guestfish-actions.pod:2973
10100 msgid "lvs"
10101 msgstr ""
10102
10103 #. type: verbatim
10104 #: ../fish/guestfish-actions.pod:2975
10105 #, no-wrap
10106 msgid ""
10107 " lvs\n"
10108 "\n"
10109 msgstr ""
10110
10111 #. type: textblock
10112 #: ../fish/guestfish-actions.pod:2977 ../src/guestfs-actions.pod:4470
10113 msgid ""
10114 "List all the logical volumes detected.  This is the equivalent of the "
10115 "L<lvs(8)> command."
10116 msgstr ""
10117
10118 #. type: textblock
10119 #: ../fish/guestfish-actions.pod:2980 ../src/guestfs-actions.pod:4473
10120 msgid ""
10121 "This returns a list of the logical volume device names "
10122 "(eg. C</dev/VolGroup00/LogVol00>)."
10123 msgstr ""
10124
10125 #. type: textblock
10126 #: ../fish/guestfish-actions.pod:2983
10127 msgid "See also L</lvs-full>, L</list-filesystems>."
10128 msgstr ""
10129
10130 #. type: =head2
10131 #: ../fish/guestfish-actions.pod:2985
10132 msgid "lvs-full"
10133 msgstr ""
10134
10135 #. type: verbatim
10136 #: ../fish/guestfish-actions.pod:2987
10137 #, no-wrap
10138 msgid ""
10139 " lvs-full\n"
10140 "\n"
10141 msgstr ""
10142
10143 #. type: textblock
10144 #: ../fish/guestfish-actions.pod:2989 ../src/guestfs-actions.pod:4489
10145 msgid ""
10146 "List all the logical volumes detected.  This is the equivalent of the "
10147 "L<lvs(8)> command.  The \"full\" version includes all fields."
10148 msgstr ""
10149
10150 #. type: =head2
10151 #: ../fish/guestfish-actions.pod:2992
10152 msgid "lvuuid"
10153 msgstr ""
10154
10155 #. type: verbatim
10156 #: ../fish/guestfish-actions.pod:2994
10157 #, no-wrap
10158 msgid ""
10159 " lvuuid device\n"
10160 "\n"
10161 msgstr ""
10162
10163 #. type: textblock
10164 #: ../fish/guestfish-actions.pod:2996 ../src/guestfs-actions.pod:4504
10165 msgid "This command returns the UUID of the LVM LV C<device>."
10166 msgstr ""
10167
10168 #. type: =head2
10169 #: ../fish/guestfish-actions.pod:2998
10170 msgid "lxattrlist"
10171 msgstr ""
10172
10173 #. type: verbatim
10174 #: ../fish/guestfish-actions.pod:3000
10175 #, no-wrap
10176 msgid ""
10177 " lxattrlist path 'names ...'\n"
10178 "\n"
10179 msgstr ""
10180
10181 #. type: textblock
10182 #: ../fish/guestfish-actions.pod:3002 ../src/guestfs-actions.pod:4518
10183 msgid ""
10184 "This call allows you to get the extended attributes of multiple files, where "
10185 "all files are in the directory C<path>.  C<names> is the list of files from "
10186 "this directory."
10187 msgstr ""
10188
10189 #. type: textblock
10190 #: ../fish/guestfish-actions.pod:3006 ../src/guestfs-actions.pod:4522
10191 msgid ""
10192 "On return you get a flat list of xattr structs which must be interpreted "
10193 "sequentially.  The first xattr struct always has a zero-length C<attrname>.  "
10194 "C<attrval> in this struct is zero-length to indicate there was an error "
10195 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10196 "number (the number of following attributes for this file, which could be "
10197 "C<\"0\">).  Then after the first xattr struct are the zero or more "
10198 "attributes for the first named file.  This repeats for the second and "
10199 "subsequent files."
10200 msgstr ""
10201
10202 #. type: textblock
10203 #: ../fish/guestfish-actions.pod:3016
10204 msgid ""
10205 "This call is intended for programs that want to efficiently list a directory "
10206 "contents without making many round-trips.  See also L</lstatlist> for a "
10207 "similarly efficient call for getting standard stats.  Very long directory "
10208 "listings might cause the protocol message size to be exceeded, causing this "
10209 "call to fail.  The caller must split up such requests into smaller groups of "
10210 "names."
10211 msgstr ""
10212
10213 #. type: =head2
10214 #: ../fish/guestfish-actions.pod:3024
10215 msgid "mkdir"
10216 msgstr ""
10217
10218 #. type: verbatim
10219 #: ../fish/guestfish-actions.pod:3026
10220 #, no-wrap
10221 msgid ""
10222 " mkdir path\n"
10223 "\n"
10224 msgstr ""
10225
10226 #. type: textblock
10227 #: ../fish/guestfish-actions.pod:3028 ../src/guestfs-actions.pod:4552
10228 msgid "Create a directory named C<path>."
10229 msgstr ""
10230
10231 #. type: =head2
10232 #: ../fish/guestfish-actions.pod:3030
10233 msgid "mkdir-mode"
10234 msgstr ""
10235
10236 #. type: verbatim
10237 #: ../fish/guestfish-actions.pod:3032
10238 #, no-wrap
10239 msgid ""
10240 " mkdir-mode path mode\n"
10241 "\n"
10242 msgstr ""
10243
10244 #. type: textblock
10245 #: ../fish/guestfish-actions.pod:3034 ../src/guestfs-actions.pod:4565
10246 msgid ""
10247 "This command creates a directory, setting the initial permissions of the "
10248 "directory to C<mode>."
10249 msgstr ""
10250
10251 #. type: textblock
10252 #: ../fish/guestfish-actions.pod:3037 ../src/guestfs-actions.pod:4568
10253 msgid ""
10254 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10255 "~umask & 01777>.  Non-native-Linux filesystems may interpret the mode in "
10256 "other ways."
10257 msgstr ""
10258
10259 #. type: textblock
10260 #: ../fish/guestfish-actions.pod:3041
10261 msgid "See also L</mkdir>, L</umask>"
10262 msgstr ""
10263
10264 #. type: =head2
10265 #: ../fish/guestfish-actions.pod:3043
10266 msgid "mkdir-p"
10267 msgstr ""
10268
10269 #. type: verbatim
10270 #: ../fish/guestfish-actions.pod:3045
10271 #, no-wrap
10272 msgid ""
10273 " mkdir-p path\n"
10274 "\n"
10275 msgstr ""
10276
10277 #. type: textblock
10278 #: ../fish/guestfish-actions.pod:3047 ../src/guestfs-actions.pod:4584
10279 msgid ""
10280 "Create a directory named C<path>, creating any parent directories as "
10281 "necessary.  This is like the C<mkdir -p> shell command."
10282 msgstr ""
10283
10284 #. type: =head2
10285 #: ../fish/guestfish-actions.pod:3050
10286 msgid "mkdtemp"
10287 msgstr ""
10288
10289 #. type: verbatim
10290 #: ../fish/guestfish-actions.pod:3052
10291 #, no-wrap
10292 msgid ""
10293 " mkdtemp template\n"
10294 "\n"
10295 msgstr ""
10296
10297 #. type: textblock
10298 #: ../fish/guestfish-actions.pod:3054 ../src/guestfs-actions.pod:4597
10299 msgid ""
10300 "This command creates a temporary directory.  The C<template> parameter "
10301 "should be a full pathname for the temporary directory name with the final "
10302 "six characters being \"XXXXXX\"."
10303 msgstr ""
10304
10305 #. type: textblock
10306 #: ../fish/guestfish-actions.pod:3059 ../src/guestfs-actions.pod:4602
10307 msgid ""
10308 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10309 "being suitable for Windows filesystems."
10310 msgstr ""
10311
10312 #. type: textblock
10313 #: ../fish/guestfish-actions.pod:3062 ../src/guestfs-actions.pod:4605
10314 msgid "The name of the temporary directory that was created is returned."
10315 msgstr ""
10316
10317 #. type: textblock
10318 #: ../fish/guestfish-actions.pod:3065 ../src/guestfs-actions.pod:4608
10319 msgid "The temporary directory is created with mode 0700 and is owned by root."
10320 msgstr ""
10321
10322 #. type: textblock
10323 #: ../fish/guestfish-actions.pod:3068 ../src/guestfs-actions.pod:4611
10324 msgid ""
10325 "The caller is responsible for deleting the temporary directory and its "
10326 "contents after use."
10327 msgstr ""
10328
10329 #. type: textblock
10330 #: ../fish/guestfish-actions.pod:3071 ../src/guestfs-actions.pod:4614
10331 msgid "See also: L<mkdtemp(3)>"
10332 msgstr ""
10333
10334 #. type: =head2
10335 #: ../fish/guestfish-actions.pod:3073
10336 msgid "mke2fs-J"
10337 msgstr ""
10338
10339 #. type: verbatim
10340 #: ../fish/guestfish-actions.pod:3075
10341 #, no-wrap
10342 msgid ""
10343 " mke2fs-J fstype blocksize device journal\n"
10344 "\n"
10345 msgstr ""
10346
10347 #. type: textblock
10348 #: ../fish/guestfish-actions.pod:3077 ../src/guestfs-actions.pod:4630
10349 msgid ""
10350 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10351 "C<journal>.  It is equivalent to the command:"
10352 msgstr ""
10353
10354 #. type: verbatim
10355 #: ../fish/guestfish-actions.pod:3081 ../src/guestfs-actions.pod:4634
10356 #, no-wrap
10357 msgid ""
10358 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10359 "\n"
10360 msgstr ""
10361
10362 #. type: textblock
10363 #: ../fish/guestfish-actions.pod:3083
10364 msgid "See also L</mke2journal>."
10365 msgstr ""
10366
10367 #. type: =head2
10368 #: ../fish/guestfish-actions.pod:3085
10369 msgid "mke2fs-JL"
10370 msgstr ""
10371
10372 #. type: verbatim
10373 #: ../fish/guestfish-actions.pod:3087
10374 #, no-wrap
10375 msgid ""
10376 " mke2fs-JL fstype blocksize device label\n"
10377 "\n"
10378 msgstr ""
10379
10380 #. type: textblock
10381 #: ../fish/guestfish-actions.pod:3089 ../src/guestfs-actions.pod:4651
10382 msgid ""
10383 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10384 "the journal labeled C<label>."
10385 msgstr ""
10386
10387 #. type: textblock
10388 #: ../fish/guestfish-actions.pod:3092
10389 msgid "See also L</mke2journal-L>."
10390 msgstr ""
10391
10392 #. type: =head2
10393 #: ../fish/guestfish-actions.pod:3094
10394 msgid "mke2fs-JU"
10395 msgstr ""
10396
10397 #. type: verbatim
10398 #: ../fish/guestfish-actions.pod:3096
10399 #, no-wrap
10400 msgid ""
10401 " mke2fs-JU fstype blocksize device uuid\n"
10402 "\n"
10403 msgstr ""
10404
10405 #. type: textblock
10406 #: ../fish/guestfish-actions.pod:3098 ../src/guestfs-actions.pod:4669
10407 msgid ""
10408 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10409 "the journal with UUID C<uuid>."
10410 msgstr ""
10411
10412 #. type: textblock
10413 #: ../fish/guestfish-actions.pod:3101
10414 msgid "See also L</mke2journal-U>."
10415 msgstr ""
10416
10417 #. type: =head2
10418 #: ../fish/guestfish-actions.pod:3103
10419 msgid "mke2journal"
10420 msgstr ""
10421
10422 #. type: verbatim
10423 #: ../fish/guestfish-actions.pod:3105
10424 #, no-wrap
10425 msgid ""
10426 " mke2journal blocksize device\n"
10427 "\n"
10428 msgstr ""
10429
10430 #. type: textblock
10431 #: ../fish/guestfish-actions.pod:3107 ../src/guestfs-actions.pod:4685
10432 msgid ""
10433 "This creates an ext2 external journal on C<device>.  It is equivalent to the "
10434 "command:"
10435 msgstr ""
10436
10437 #. type: verbatim
10438 #: ../fish/guestfish-actions.pod:3110 ../src/guestfs-actions.pod:4688
10439 #, no-wrap
10440 msgid ""
10441 " mke2fs -O journal_dev -b blocksize device\n"
10442 "\n"
10443 msgstr ""
10444
10445 #. type: =head2
10446 #: ../fish/guestfish-actions.pod:3112
10447 msgid "mke2journal-L"
10448 msgstr ""
10449
10450 #. type: verbatim
10451 #: ../fish/guestfish-actions.pod:3114
10452 #, no-wrap
10453 msgid ""
10454 " mke2journal-L blocksize label device\n"
10455 "\n"
10456 msgstr ""
10457
10458 #. type: textblock
10459 #: ../fish/guestfish-actions.pod:3116 ../src/guestfs-actions.pod:4702
10460 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10461 msgstr ""
10462
10463 #. type: =head2
10464 #: ../fish/guestfish-actions.pod:3118
10465 msgid "mke2journal-U"
10466 msgstr ""
10467
10468 #. type: verbatim
10469 #: ../fish/guestfish-actions.pod:3120
10470 #, no-wrap
10471 msgid ""
10472 " mke2journal-U blocksize uuid device\n"
10473 "\n"
10474 msgstr ""
10475
10476 #. type: textblock
10477 #: ../fish/guestfish-actions.pod:3122 ../src/guestfs-actions.pod:4716
10478 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10479 msgstr ""
10480
10481 #. type: =head2
10482 #: ../fish/guestfish-actions.pod:3124
10483 msgid "mkfifo"
10484 msgstr ""
10485
10486 #. type: verbatim
10487 #: ../fish/guestfish-actions.pod:3126
10488 #, no-wrap
10489 msgid ""
10490 " mkfifo mode path\n"
10491 "\n"
10492 msgstr ""
10493
10494 #. type: textblock
10495 #: ../fish/guestfish-actions.pod:3128
10496 msgid ""
10497 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>.  It "
10498 "is just a convenient wrapper around L</mknod>."
10499 msgstr ""
10500
10501 #. type: =head2
10502 #: ../fish/guestfish-actions.pod:3134
10503 msgid "mkfs"
10504 msgstr ""
10505
10506 #. type: verbatim
10507 #: ../fish/guestfish-actions.pod:3136
10508 #, no-wrap
10509 msgid ""
10510 " mkfs fstype device\n"
10511 "\n"
10512 msgstr ""
10513
10514 #. type: textblock
10515 #: ../fish/guestfish-actions.pod:3138 ../src/guestfs-actions.pod:4746
10516 msgid ""
10517 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10518 "volume).  The filesystem type is C<fstype>, for example C<ext3>."
10519 msgstr ""
10520
10521 #. type: =head2
10522 #: ../fish/guestfish-actions.pod:3142
10523 msgid "mkfs-b"
10524 msgstr ""
10525
10526 #. type: verbatim
10527 #: ../fish/guestfish-actions.pod:3144
10528 #, no-wrap
10529 msgid ""
10530 " mkfs-b fstype blocksize device\n"
10531 "\n"
10532 msgstr ""
10533
10534 #. type: textblock
10535 #: ../fish/guestfish-actions.pod:3146
10536 msgid ""
10537 "This call is similar to L</mkfs>, but it allows you to control the block "
10538 "size of the resulting filesystem.  Supported block sizes depend on the "
10539 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10540 msgstr ""
10541
10542 #. type: textblock
10543 #: ../fish/guestfish-actions.pod:3151 ../fish/guestfish-actions.pod:3178 ../src/guestfs-actions.pod:4774 ../src/guestfs-actions.pod:4812
10544 msgid ""
10545 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10546 "cluster size."
10547 msgstr ""
10548
10549 #. type: textblock
10550 #: ../fish/guestfish-actions.pod:3154
10551 msgid ""
10552 "I<This function is deprecated.> In new code, use the L</mkfs_opts> call "
10553 "instead."
10554 msgstr ""
10555
10556 #. type: =head2
10557 #: ../fish/guestfish-actions.pod:3161
10558 msgid "mkfs-opts"
10559 msgstr ""
10560
10561 #. type: verbatim
10562 #: ../fish/guestfish-actions.pod:3163
10563 #, no-wrap
10564 msgid ""
10565 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] "
10566 "[sectorsize:..]\n"
10567 "\n"
10568 msgstr ""
10569
10570 #. type: textblock
10571 #: ../fish/guestfish-actions.pod:3165 ../src/guestfs-actions.pod:4799
10572 msgid ""
10573 "This function creates a filesystem on C<device>.  The filesystem type is "
10574 "C<fstype>, for example C<ext3>."
10575 msgstr ""
10576
10577 #. type: =item
10578 #: ../fish/guestfish-actions.pod:3172 ../src/guestfs-actions.pod:4806
10579 msgid "C<blocksize>"
10580 msgstr ""
10581
10582 #. type: textblock
10583 #: ../fish/guestfish-actions.pod:3174 ../src/guestfs-actions.pod:4808
10584 msgid ""
10585 "The filesystem block size.  Supported block sizes depend on the filesystem "
10586 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
10587 "filesystems."
10588 msgstr ""
10589
10590 #. type: textblock
10591 #: ../fish/guestfish-actions.pod:3181 ../src/guestfs-actions.pod:4815
10592 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
10593 msgstr ""
10594
10595 #. type: =item
10596 #: ../fish/guestfish-actions.pod:3183 ../src/guestfs-actions.pod:4817
10597 msgid "C<features>"
10598 msgstr ""
10599
10600 #. type: textblock
10601 #: ../fish/guestfish-actions.pod:3185 ../src/guestfs-actions.pod:4819
10602 msgid "This passes the I<-O> parameter to the external mkfs program."
10603 msgstr ""
10604
10605 #. type: textblock
10606 #: ../fish/guestfish-actions.pod:3187 ../src/guestfs-actions.pod:4821
10607 msgid ""
10608 "For certain filesystem types, this allows extra filesystem features to be "
10609 "selected.  See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
10610 msgstr ""
10611
10612 #. type: textblock
10613 #: ../fish/guestfish-actions.pod:3191 ../src/guestfs-actions.pod:4825
10614 msgid ""
10615 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
10616 "type."
10617 msgstr ""
10618
10619 #. type: =item
10620 #: ../fish/guestfish-actions.pod:3194 ../src/guestfs-actions.pod:4828
10621 msgid "C<inode>"
10622 msgstr ""
10623
10624 #. type: textblock
10625 #: ../fish/guestfish-actions.pod:3196 ../src/guestfs-actions.pod:4830
10626 msgid ""
10627 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
10628 "sets the inode size (only for ext2/3/4 filesystems at present)."
10629 msgstr ""
10630
10631 #. type: =item
10632 #: ../fish/guestfish-actions.pod:3199 ../src/guestfs-actions.pod:4833
10633 msgid "C<sectorsize>"
10634 msgstr ""
10635
10636 #. type: textblock
10637 #: ../fish/guestfish-actions.pod:3201 ../src/guestfs-actions.pod:4835
10638 msgid ""
10639 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
10640 "sets sector size for ufs filesystem."
10641 msgstr ""
10642
10643 #. type: =head2
10644 #: ../fish/guestfish-actions.pod:3208
10645 msgid "mkmountpoint"
10646 msgstr ""
10647
10648 #. type: verbatim
10649 #: ../fish/guestfish-actions.pod:3210
10650 #, no-wrap
10651 msgid ""
10652 " mkmountpoint exemptpath\n"
10653 "\n"
10654 msgstr ""
10655
10656 #. type: textblock
10657 #: ../fish/guestfish-actions.pod:3212
10658 msgid ""
10659 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
10660 "to create extra mountpoints before mounting the first filesystem."
10661 msgstr ""
10662
10663 #. type: textblock
10664 #: ../fish/guestfish-actions.pod:3216 ../src/guestfs-actions.pod:4878
10665 msgid ""
10666 "These calls are I<only> necessary in some very limited circumstances, mainly "
10667 "the case where you want to mount a mix of unrelated and/or read-only "
10668 "filesystems together."
10669 msgstr ""
10670
10671 #. type: textblock
10672 #: ../fish/guestfish-actions.pod:3220 ../src/guestfs-actions.pod:4882
10673 msgid ""
10674 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10675 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10676 "inside that.  You can unpack this as follows in guestfish:"
10677 msgstr ""
10678
10679 #. type: verbatim
10680 #: ../fish/guestfish-actions.pod:3225 ../src/guestfs-actions.pod:4887
10681 #, no-wrap
10682 msgid ""
10683 " add-ro Fedora-11-i686-Live.iso\n"
10684 " run\n"
10685 " mkmountpoint /cd\n"
10686 " mkmountpoint /sqsh\n"
10687 " mkmountpoint /ext3fs\n"
10688 " mount /dev/sda /cd\n"
10689 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10690 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10691 "\n"
10692 msgstr ""
10693
10694 #. type: textblock
10695 #: ../fish/guestfish-actions.pod:3234 ../src/guestfs-actions.pod:4896
10696 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10697 msgstr ""
10698
10699 #. type: textblock
10700 #: ../fish/guestfish-actions.pod:3236
10701 msgid ""
10702 "L</mkmountpoint> is not compatible with L</umount-all>.  You may get "
10703 "unexpected errors if you try to mix these calls.  It is safest to manually "
10704 "unmount filesystems and remove mountpoints after use."
10705 msgstr ""
10706
10707 #. type: textblock
10708 #: ../fish/guestfish-actions.pod:3240
10709 msgid ""
10710 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
10711 "for this to work for manual mountpoints, you must ensure that the innermost "
10712 "mountpoints have the longest pathnames, as in the example code above."
10713 msgstr ""
10714
10715 #. type: textblock
10716 #: ../fish/guestfish-actions.pod:3245 ../src/guestfs-actions.pod:4907
10717 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10718 msgstr ""
10719
10720 #. type: textblock
10721 #: ../fish/guestfish-actions.pod:3247
10722 msgid ""
10723 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
10724 "L</umount-all> to be called when the handle is closed which can also trigger "
10725 "these issues."
10726 msgstr ""
10727
10728 #. type: =head2
10729 #: ../fish/guestfish-actions.pod:3251
10730 msgid "mknod"
10731 msgstr ""
10732
10733 #. type: verbatim
10734 #: ../fish/guestfish-actions.pod:3253
10735 #, no-wrap
10736 msgid ""
10737 " mknod mode devmajor devminor path\n"
10738 "\n"
10739 msgstr ""
10740
10741 #. type: textblock
10742 #: ../fish/guestfish-actions.pod:3255 ../src/guestfs-actions.pod:4926
10743 msgid ""
10744 "This call creates block or character special devices, or named pipes "
10745 "(FIFOs)."
10746 msgstr ""
10747
10748 #. type: textblock
10749 #: ../fish/guestfish-actions.pod:3258 ../src/guestfs-actions.pod:4929
10750 msgid ""
10751 "The C<mode> parameter should be the mode, using the standard constants.  "
10752 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10753 "used when creating block and character special devices."
10754 msgstr ""
10755
10756 #. type: textblock
10757 #: ../fish/guestfish-actions.pod:3263
10758 msgid ""
10759 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10760 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10761 "regular file).  These constants are available in the standard Linux header "
10762 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
10763 "wrappers around this command which bitwise OR in the appropriate constant "
10764 "for you."
10765 msgstr ""
10766
10767 #. type: =head2
10768 #: ../fish/guestfish-actions.pod:3273
10769 msgid "mknod-b"
10770 msgstr ""
10771
10772 #. type: verbatim
10773 #: ../fish/guestfish-actions.pod:3275
10774 #, no-wrap
10775 msgid ""
10776 " mknod-b mode devmajor devminor path\n"
10777 "\n"
10778 msgstr ""
10779
10780 #. type: textblock
10781 #: ../fish/guestfish-actions.pod:3277
10782 msgid ""
10783 "This call creates a block device node called C<path> with mode C<mode> and "
10784 "device major/minor C<devmajor> and C<devminor>.  It is just a convenient "
10785 "wrapper around L</mknod>."
10786 msgstr ""
10787
10788 #. type: =head2
10789 #: ../fish/guestfish-actions.pod:3283
10790 msgid "mknod-c"
10791 msgstr ""
10792
10793 #. type: verbatim
10794 #: ../fish/guestfish-actions.pod:3285
10795 #, no-wrap
10796 msgid ""
10797 " mknod-c mode devmajor devminor path\n"
10798 "\n"
10799 msgstr ""
10800
10801 #. type: textblock
10802 #: ../fish/guestfish-actions.pod:3287
10803 msgid ""
10804 "This call creates a char device node called C<path> with mode C<mode> and "
10805 "device major/minor C<devmajor> and C<devminor>.  It is just a convenient "
10806 "wrapper around L</mknod>."
10807 msgstr ""
10808
10809 #. type: =head2
10810 #: ../fish/guestfish-actions.pod:3293
10811 msgid "mkswap"
10812 msgstr ""
10813
10814 #. type: verbatim
10815 #: ../fish/guestfish-actions.pod:3295
10816 #, no-wrap
10817 msgid ""
10818 " mkswap device\n"
10819 "\n"
10820 msgstr ""
10821
10822 #. type: textblock
10823 #: ../fish/guestfish-actions.pod:3297 ../src/guestfs-actions.pod:4992
10824 msgid "Create a swap partition on C<device>."
10825 msgstr ""
10826
10827 #. type: =head2
10828 #: ../fish/guestfish-actions.pod:3299
10829 msgid "mkswap-L"
10830 msgstr ""
10831
10832 #. type: verbatim
10833 #: ../fish/guestfish-actions.pod:3301
10834 #, no-wrap
10835 msgid ""
10836 " mkswap-L label device\n"
10837 "\n"
10838 msgstr ""
10839
10840 #. type: textblock
10841 #: ../fish/guestfish-actions.pod:3303 ../src/guestfs-actions.pod:5005
10842 msgid "Create a swap partition on C<device> with label C<label>."
10843 msgstr ""
10844
10845 #. type: textblock
10846 #: ../fish/guestfish-actions.pod:3305 ../src/guestfs-actions.pod:5007
10847 msgid ""
10848 "Note that you cannot attach a swap label to a block device "
10849 "(eg. C</dev/sda>), just to a partition.  This appears to be a limitation of "
10850 "the kernel or swap tools."
10851 msgstr ""
10852
10853 #. type: =head2
10854 #: ../fish/guestfish-actions.pod:3309
10855 msgid "mkswap-U"
10856 msgstr ""
10857
10858 #. type: verbatim
10859 #: ../fish/guestfish-actions.pod:3311
10860 #, no-wrap
10861 msgid ""
10862 " mkswap-U uuid device\n"
10863 "\n"
10864 msgstr ""
10865
10866 #. type: textblock
10867 #: ../fish/guestfish-actions.pod:3313 ../src/guestfs-actions.pod:5022
10868 msgid "Create a swap partition on C<device> with UUID C<uuid>."
10869 msgstr ""
10870
10871 #. type: =head2
10872 #: ../fish/guestfish-actions.pod:3315
10873 msgid "mkswap-file"
10874 msgstr ""
10875
10876 #. type: verbatim
10877 #: ../fish/guestfish-actions.pod:3317
10878 #, no-wrap
10879 msgid ""
10880 " mkswap-file path\n"
10881 "\n"
10882 msgstr ""
10883
10884 #. type: textblock
10885 #: ../fish/guestfish-actions.pod:3319 ../src/guestfs-actions.pod:5034
10886 msgid "Create a swap file."
10887 msgstr ""
10888
10889 #. type: textblock
10890 #: ../fish/guestfish-actions.pod:3321
10891 msgid ""
10892 "This command just writes a swap file signature to an existing file.  To "
10893 "create the file itself, use something like L</fallocate>."
10894 msgstr ""
10895
10896 #. type: =head2
10897 #: ../fish/guestfish-actions.pod:3324
10898 msgid "modprobe"
10899 msgstr ""
10900
10901 #. type: verbatim
10902 #: ../fish/guestfish-actions.pod:3326
10903 #, no-wrap
10904 msgid ""
10905 " modprobe modulename\n"
10906 "\n"
10907 msgstr ""
10908
10909 #. type: textblock
10910 #: ../fish/guestfish-actions.pod:3328 ../src/guestfs-actions.pod:5049
10911 msgid "This loads a kernel module in the appliance."
10912 msgstr ""
10913
10914 #. type: textblock
10915 #: ../fish/guestfish-actions.pod:3330 ../src/guestfs-actions.pod:5051
10916 msgid ""
10917 "The kernel module must have been whitelisted when libguestfs was built (see "
10918 "C<appliance/kmod.whitelist.in> in the source)."
10919 msgstr ""
10920
10921 #. type: =head2
10922 #: ../fish/guestfish-actions.pod:3333
10923 msgid "mount"
10924 msgstr ""
10925
10926 #. type: verbatim
10927 #: ../fish/guestfish-actions.pod:3335
10928 #, no-wrap
10929 msgid ""
10930 " mount device mountpoint\n"
10931 "\n"
10932 msgstr ""
10933
10934 #. type: textblock
10935 #: ../fish/guestfish-actions.pod:3337 ../src/guestfs-actions.pod:5072
10936 msgid ""
10937 "Mount a guest disk at a position in the filesystem.  Block devices are named "
10938 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest.  If "
10939 "those block devices contain partitions, they will have the usual names "
10940 "(eg. C</dev/sda1>).  Also LVM C</dev/VG/LV>-style names can be used."
10941 msgstr ""
10942
10943 #. type: textblock
10944 #: ../fish/guestfish-actions.pod:3343 ../src/guestfs-actions.pod:5078
10945 msgid ""
10946 "The rules are the same as for L<mount(2)>: A filesystem must first be "
10947 "mounted on C</> before others can be mounted.  Other filesystems can only be "
10948 "mounted on directories which already exist."
10949 msgstr ""
10950
10951 #. type: textblock
10952 #: ../fish/guestfish-actions.pod:3348 ../src/guestfs-actions.pod:5083
10953 msgid ""
10954 "The mounted filesystem is writable, if we have sufficient permissions on the "
10955 "underlying device."
10956 msgstr ""
10957
10958 #. type: textblock
10959 #: ../fish/guestfish-actions.pod:3351
10960 msgid ""
10961 "B<Important note:> When you use this call, the filesystem options C<sync> "
10962 "and C<noatime> are set implicitly.  This was originally done because we "
10963 "thought it would improve reliability, but it turns out that I<-o sync> has a "
10964 "very large negative performance impact and negligible effect on "
10965 "reliability.  Therefore we recommend that you avoid using L</mount> in any "
10966 "code that needs performance, and instead use L</mount-options> (use an empty "
10967 "string for the first parameter if you don't want any options)."
10968 msgstr ""
10969
10970 #. type: textblock
10971 #: ../fish/guestfish-actions.pod:3361
10972 msgid ""
10973 "I<This function is deprecated.> In new code, use the L</mount_options> call "
10974 "instead."
10975 msgstr ""
10976
10977 #. type: =head2
10978 #: ../fish/guestfish-actions.pod:3368
10979 msgid "mount-9p"
10980 msgstr ""
10981
10982 #. type: verbatim
10983 #: ../fish/guestfish-actions.pod:3370
10984 #, no-wrap
10985 msgid ""
10986 " mount-9p mounttag mountpoint [options:..]\n"
10987 "\n"
10988 msgstr ""
10989
10990 #. type: textblock
10991 #: ../fish/guestfish-actions.pod:3372 ../src/guestfs-actions.pod:5115
10992 msgid ""
10993 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
10994 "C<mountpoint>."
10995 msgstr ""
10996
10997 #. type: textblock
10998 #: ../fish/guestfish-actions.pod:3375 ../src/guestfs-actions.pod:5118
10999 msgid ""
11000 "If required, C<trans=virtio> will be automatically added to the options.  "
11001 "Any other options required can be passed in the optional C<options> "
11002 "parameter."
11003 msgstr ""
11004
11005 #. type: =head2
11006 #: ../fish/guestfish-actions.pod:3381
11007 msgid "mount-loop"
11008 msgstr ""
11009
11010 #. type: verbatim
11011 #: ../fish/guestfish-actions.pod:3383
11012 #, no-wrap
11013 msgid ""
11014 " mount-loop file mountpoint\n"
11015 "\n"
11016 msgstr ""
11017
11018 #. type: textblock
11019 #: ../fish/guestfish-actions.pod:3385 ../src/guestfs-actions.pod:5157
11020 msgid ""
11021 "This command lets you mount C<file> (a filesystem image in a file) on a "
11022 "mount point.  It is entirely equivalent to the command C<mount -o loop file "
11023 "mountpoint>."
11024 msgstr ""
11025
11026 #. type: =head2
11027 #: ../fish/guestfish-actions.pod:3389
11028 msgid "mount-options"
11029 msgstr ""
11030
11031 #. type: verbatim
11032 #: ../fish/guestfish-actions.pod:3391
11033 #, no-wrap
11034 msgid ""
11035 " mount-options options device mountpoint\n"
11036 "\n"
11037 msgstr ""
11038
11039 #. type: textblock
11040 #: ../fish/guestfish-actions.pod:3393
11041 msgid ""
11042 "This is the same as the L</mount> command, but it allows you to set the "
11043 "mount options as for the L<mount(8)> I<-o> flag."
11044 msgstr ""
11045
11046 #. type: textblock
11047 #: ../fish/guestfish-actions.pod:3397 ../src/guestfs-actions.pod:5177
11048 msgid ""
11049 "If the C<options> parameter is an empty string, then no options are passed "
11050 "(all options default to whatever the filesystem uses)."
11051 msgstr ""
11052
11053 #. type: =head2
11054 #: ../fish/guestfish-actions.pod:3401
11055 msgid "mount-ro"
11056 msgstr ""
11057
11058 #. type: verbatim
11059 #: ../fish/guestfish-actions.pod:3403
11060 #, no-wrap
11061 msgid ""
11062 " mount-ro device mountpoint\n"
11063 "\n"
11064 msgstr ""
11065
11066 #. type: textblock
11067 #: ../fish/guestfish-actions.pod:3405
11068 msgid ""
11069 "This is the same as the L</mount> command, but it mounts the filesystem with "
11070 "the read-only (I<-o ro>) flag."
11071 msgstr ""
11072
11073 #. type: =head2
11074 #: ../fish/guestfish-actions.pod:3408
11075 msgid "mount-vfs"
11076 msgstr ""
11077
11078 #. type: verbatim
11079 #: ../fish/guestfish-actions.pod:3410
11080 #, no-wrap
11081 msgid ""
11082 " mount-vfs options vfstype device mountpoint\n"
11083 "\n"
11084 msgstr ""
11085
11086 #. type: textblock
11087 #: ../fish/guestfish-actions.pod:3412
11088 msgid ""
11089 "This is the same as the L</mount> command, but it allows you to set both the "
11090 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
11091 msgstr ""
11092
11093 #. type: =head2
11094 #: ../fish/guestfish-actions.pod:3416
11095 msgid "mountpoints"
11096 msgstr ""
11097
11098 #. type: verbatim
11099 #: ../fish/guestfish-actions.pod:3418
11100 #, no-wrap
11101 msgid ""
11102 " mountpoints\n"
11103 "\n"
11104 msgstr ""
11105
11106 #. type: textblock
11107 #: ../fish/guestfish-actions.pod:3420
11108 msgid ""
11109 "This call is similar to L</mounts>.  That call returns a list of devices.  "
11110 "This one returns a hash table (map) of device name to directory where the "
11111 "device is mounted."
11112 msgstr ""
11113
11114 #. type: =head2
11115 #: ../fish/guestfish-actions.pod:3424
11116 msgid "mounts"
11117 msgstr ""
11118
11119 #. type: verbatim
11120 #: ../fish/guestfish-actions.pod:3426
11121 #, no-wrap
11122 msgid ""
11123 " mounts\n"
11124 "\n"
11125 msgstr ""
11126
11127 #. type: textblock
11128 #: ../fish/guestfish-actions.pod:3428 ../src/guestfs-actions.pod:5238
11129 msgid ""
11130 "This returns the list of currently mounted filesystems.  It returns the list "
11131 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11132 msgstr ""
11133
11134 #. type: textblock
11135 #: ../fish/guestfish-actions.pod:3431 ../src/guestfs-actions.pod:5241
11136 msgid "Some internal mounts are not shown."
11137 msgstr ""
11138
11139 #. type: textblock
11140 #: ../fish/guestfish-actions.pod:3433
11141 msgid "See also: L</mountpoints>"
11142 msgstr ""
11143
11144 #. type: =head2
11145 #: ../fish/guestfish-actions.pod:3435
11146 msgid "mv"
11147 msgstr ""
11148
11149 #. type: verbatim
11150 #: ../fish/guestfish-actions.pod:3437
11151 #, no-wrap
11152 msgid ""
11153 " mv src dest\n"
11154 "\n"
11155 msgstr ""
11156
11157 #. type: textblock
11158 #: ../fish/guestfish-actions.pod:3439 ../src/guestfs-actions.pod:5258
11159 msgid ""
11160 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11161 "destination filename or destination directory."
11162 msgstr ""
11163
11164 #. type: =head2
11165 #: ../fish/guestfish-actions.pod:3442
11166 msgid "ntfs-3g-probe"
11167 msgstr ""
11168
11169 #. type: verbatim
11170 #: ../fish/guestfish-actions.pod:3444
11171 #, no-wrap
11172 msgid ""
11173 " ntfs-3g-probe true|false device\n"
11174 "\n"
11175 msgstr ""
11176
11177 #. type: textblock
11178 #: ../fish/guestfish-actions.pod:3446 ../src/guestfs-actions.pod:5272
11179 msgid ""
11180 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11181 "C<device> for mountability.  (Not all NTFS volumes can be mounted "
11182 "read-write, and some cannot be mounted at all)."
11183 msgstr ""
11184
11185 #. type: textblock
11186 #: ../fish/guestfish-actions.pod:3450 ../src/guestfs-actions.pod:5276
11187 msgid ""
11188 "C<rw> is a boolean flag.  Set it to true if you want to test if the volume "
11189 "can be mounted read-write.  Set it to false if you want to test if the "
11190 "volume can be mounted read-only."
11191 msgstr ""
11192
11193 #. type: textblock
11194 #: ../fish/guestfish-actions.pod:3454 ../src/guestfs-actions.pod:5280
11195 msgid ""
11196 "The return value is an integer which C<0> if the operation would succeed, or "
11197 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11198 msgstr ""
11199
11200 #. type: =head2
11201 #: ../fish/guestfish-actions.pod:3458
11202 msgid "ntfsresize"
11203 msgstr ""
11204
11205 #. type: verbatim
11206 #: ../fish/guestfish-actions.pod:3460
11207 #, no-wrap
11208 msgid ""
11209 " ntfsresize device\n"
11210 "\n"
11211 msgstr ""
11212
11213 #. type: textblock
11214 #: ../fish/guestfish-actions.pod:3462 ../fish/guestfish-actions.pod:3486 ../src/guestfs-actions.pod:5301 ../src/guestfs-actions.pod:5333
11215 msgid ""
11216 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11217 "size of the underlying device."
11218 msgstr ""
11219
11220 #. type: textblock
11221 #: ../fish/guestfish-actions.pod:3465 ../src/guestfs-actions.pod:5304
11222 msgid ""
11223 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
11224 "consistency check (for safety).  You have to boot into Windows to perform "
11225 "this check and clear this condition.  Furthermore, ntfsresize refuses to "
11226 "resize filesystems which have been marked in this way.  So in effect it is "
11227 "not possible to call ntfsresize multiple times on a single filesystem "
11228 "without booting into Windows between each resize."
11229 msgstr ""
11230
11231 #. type: textblock
11232 #: ../fish/guestfish-actions.pod:3473 ../fish/guestfish-actions.pod:3512 ../src/guestfs-actions.pod:5312 ../src/guestfs-actions.pod:5359
11233 msgid "See also L<ntfsresize(8)>."
11234 msgstr ""
11235
11236 #. type: textblock
11237 #: ../fish/guestfish-actions.pod:3475 ../fish/guestfish-actions.pod:3523
11238 msgid ""
11239 "I<This function is deprecated.> In new code, use the L</ntfsresize_opts> "
11240 "call instead."
11241 msgstr ""
11242
11243 #. type: =head2
11244 #: ../fish/guestfish-actions.pod:3482
11245 msgid "ntfsresize-opts"
11246 msgstr ""
11247
11248 #. type: verbatim
11249 #: ../fish/guestfish-actions.pod:3484
11250 #, no-wrap
11251 msgid ""
11252 " ntfsresize-opts device [size:..] [force:..]\n"
11253 "\n"
11254 msgstr ""
11255
11256 #. type: textblock
11257 #: ../fish/guestfish-actions.pod:3495 ../src/guestfs-actions.pod:5342
11258 msgid ""
11259 "The new size (in bytes) of the filesystem.  If omitted, the filesystem is "
11260 "resized to fit the container (eg. partition)."
11261 msgstr ""
11262
11263 #. type: =item
11264 #: ../fish/guestfish-actions.pod:3498 ../src/guestfs-actions.pod:5345
11265 msgid "C<force>"
11266 msgstr ""
11267
11268 #. type: textblock
11269 #: ../fish/guestfish-actions.pod:3500 ../src/guestfs-actions.pod:5347
11270 msgid ""
11271 "If this option is true, then force the resize of the filesystem even if the "
11272 "filesystem is marked as requiring a consistency check."
11273 msgstr ""
11274
11275 #. type: textblock
11276 #: ../fish/guestfish-actions.pod:3503
11277 msgid ""
11278 "After the resize operation, the filesystem is always marked as requiring a "
11279 "consistency check (for safety).  You have to boot into Windows to perform "
11280 "this check and clear this condition.  If you I<don't> set the C<force> "
11281 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
11282 "a single filesystem without booting into Windows between each resize."
11283 msgstr ""
11284
11285 #. type: =head2
11286 #: ../fish/guestfish-actions.pod:3516
11287 msgid "ntfsresize-size"
11288 msgstr ""
11289
11290 #. type: verbatim
11291 #: ../fish/guestfish-actions.pod:3518
11292 #, no-wrap
11293 msgid ""
11294 " ntfsresize-size device size\n"
11295 "\n"
11296 msgstr ""
11297
11298 #. type: textblock
11299 #: ../fish/guestfish-actions.pod:3520
11300 msgid ""
11301 "This command is the same as L</ntfsresize> except that it allows you to "
11302 "specify the new size (in bytes) explicitly."
11303 msgstr ""
11304
11305 #. type: =head2
11306 #: ../fish/guestfish-actions.pod:3530
11307 msgid "part-add"
11308 msgstr ""
11309
11310 #. type: verbatim
11311 #: ../fish/guestfish-actions.pod:3532
11312 #, no-wrap
11313 msgid ""
11314 " part-add device prlogex startsect endsect\n"
11315 "\n"
11316 msgstr ""
11317
11318 #. type: textblock
11319 #: ../fish/guestfish-actions.pod:3534
11320 msgid ""
11321 "This command adds a partition to C<device>.  If there is no partition table "
11322 "on the device, call L</part-init> first."
11323 msgstr ""
11324
11325 #. type: textblock
11326 #: ../fish/guestfish-actions.pod:3537 ../src/guestfs-actions.pod:5420
11327 msgid ""
11328 "The C<prlogex> parameter is the type of partition.  Normally you should pass "
11329 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11330 "C<logical>) and C<e> (or C<extended>) partition types."
11331 msgstr ""
11332
11333 #. type: textblock
11334 #: ../fish/guestfish-actions.pod:3542 ../src/guestfs-actions.pod:5425
11335 msgid ""
11336 "C<startsect> and C<endsect> are the start and end of the partition in "
11337 "I<sectors>.  C<endsect> may be negative, which means it counts backwards "
11338 "from the end of the disk (C<-1> is the last sector)."
11339 msgstr ""
11340
11341 #. type: textblock
11342 #: ../fish/guestfish-actions.pod:3546
11343 msgid ""
11344 "Creating a partition which covers the whole disk is not so easy.  Use "
11345 "L</part-disk> to do that."
11346 msgstr ""
11347
11348 #. type: =head2
11349 #: ../fish/guestfish-actions.pod:3549
11350 msgid "part-del"
11351 msgstr ""
11352
11353 #. type: verbatim
11354 #: ../fish/guestfish-actions.pod:3551
11355 #, no-wrap
11356 msgid ""
11357 " part-del device partnum\n"
11358 "\n"
11359 msgstr ""
11360
11361 #. type: textblock
11362 #: ../fish/guestfish-actions.pod:3553 ../src/guestfs-actions.pod:5443
11363 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11364 msgstr ""
11365
11366 #. type: textblock
11367 #: ../fish/guestfish-actions.pod:3555 ../src/guestfs-actions.pod:5445
11368 msgid ""
11369 "Note that in the case of MBR partitioning, deleting an extended partition "
11370 "also deletes any logical partitions it contains."
11371 msgstr ""
11372
11373 #. type: =head2
11374 #: ../fish/guestfish-actions.pod:3559
11375 msgid "part-disk"
11376 msgstr ""
11377
11378 #. type: verbatim
11379 #: ../fish/guestfish-actions.pod:3561
11380 #, no-wrap
11381 msgid ""
11382 " part-disk device parttype\n"
11383 "\n"
11384 msgstr ""
11385
11386 #. type: textblock
11387 #: ../fish/guestfish-actions.pod:3563
11388 msgid ""
11389 "This command is simply a combination of L</part-init> followed by "
11390 "L</part-add> to create a single primary partition covering the whole disk."
11391 msgstr ""
11392
11393 #. type: textblock
11394 #: ../fish/guestfish-actions.pod:3567
11395 msgid ""
11396 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11397 "possible values are described in L</part-init>."
11398 msgstr ""
11399
11400 #. type: =head2
11401 #: ../fish/guestfish-actions.pod:3573
11402 msgid "part-get-bootable"
11403 msgstr ""
11404
11405 #. type: verbatim
11406 #: ../fish/guestfish-actions.pod:3575
11407 #, no-wrap
11408 msgid ""
11409 " part-get-bootable device partnum\n"
11410 "\n"
11411 msgstr ""
11412
11413 #. type: textblock
11414 #: ../fish/guestfish-actions.pod:3577 ../src/guestfs-actions.pod:5481
11415 msgid ""
11416 "This command returns true if the partition C<partnum> on C<device> has the "
11417 "bootable flag set."
11418 msgstr ""
11419
11420 #. type: textblock
11421 #: ../fish/guestfish-actions.pod:3580
11422 msgid "See also L</part-set-bootable>."
11423 msgstr ""
11424
11425 #. type: =head2
11426 #: ../fish/guestfish-actions.pod:3582
11427 msgid "part-get-mbr-id"
11428 msgstr ""
11429
11430 #. type: verbatim
11431 #: ../fish/guestfish-actions.pod:3584
11432 #, no-wrap
11433 msgid ""
11434 " part-get-mbr-id device partnum\n"
11435 "\n"
11436 msgstr ""
11437
11438 #. type: textblock
11439 #: ../fish/guestfish-actions.pod:3586 ../src/guestfs-actions.pod:5497
11440 msgid ""
11441 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11442 "partition C<partnum>."
11443 msgstr ""
11444
11445 #. type: textblock
11446 #: ../fish/guestfish-actions.pod:3589 ../fish/guestfish-actions.pod:3733
11447 msgid ""
11448 "Note that only MBR (old DOS-style) partitions have type bytes.  You will get "
11449 "undefined results for other partition table types (see "
11450 "L</part-get-parttype>)."
11451 msgstr ""
11452
11453 #. type: =head2
11454 #: ../fish/guestfish-actions.pod:3593
11455 msgid "part-get-parttype"
11456 msgstr ""
11457
11458 #. type: verbatim
11459 #: ../fish/guestfish-actions.pod:3595
11460 #, no-wrap
11461 msgid ""
11462 " part-get-parttype device\n"
11463 "\n"
11464 msgstr ""
11465
11466 #. type: textblock
11467 #: ../fish/guestfish-actions.pod:3597 ../src/guestfs-actions.pod:5514
11468 msgid ""
11469 "This command examines the partition table on C<device> and returns the "
11470 "partition table type (format) being used."
11471 msgstr ""
11472
11473 #. type: textblock
11474 #: ../fish/guestfish-actions.pod:3600
11475 msgid ""
11476 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11477 "table), C<gpt> (a GPT/EFI-style partition table).  Other values are "
11478 "possible, although unusual.  See L</part-init> for a full list."
11479 msgstr ""
11480
11481 #. type: =head2
11482 #: ../fish/guestfish-actions.pod:3605
11483 msgid "part-init"
11484 msgstr ""
11485
11486 #. type: verbatim
11487 #: ../fish/guestfish-actions.pod:3607
11488 #, no-wrap
11489 msgid ""
11490 " part-init device parttype\n"
11491 "\n"
11492 msgstr ""
11493
11494 #. type: textblock
11495 #: ../fish/guestfish-actions.pod:3609 ../src/guestfs-actions.pod:5534
11496 msgid ""
11497 "This creates an empty partition table on C<device> of one of the partition "
11498 "types listed below.  Usually C<parttype> should be either C<msdos> or C<gpt> "
11499 "(for large disks)."
11500 msgstr ""
11501
11502 #. type: textblock
11503 #: ../fish/guestfish-actions.pod:3613
11504 msgid ""
11505 "Initially there are no partitions.  Following this, you should call "
11506 "L</part-add> for each partition required."
11507 msgstr ""
11508
11509 #. type: textblock
11510 #: ../fish/guestfish-actions.pod:3616 ../src/guestfs-actions.pod:5541
11511 msgid "Possible values for C<parttype> are:"
11512 msgstr ""
11513
11514 #. type: =item
11515 #: ../fish/guestfish-actions.pod:3620 ../src/guestfs-actions.pod:5545
11516 msgid "B<efi>"
11517 msgstr ""
11518
11519 #. type: =item
11520 #: ../fish/guestfish-actions.pod:3622 ../src/guestfs-actions.pod:5547
11521 msgid "B<gpt>"
11522 msgstr ""
11523
11524 #. type: textblock
11525 #: ../fish/guestfish-actions.pod:3624 ../src/guestfs-actions.pod:5549
11526 msgid "Intel EFI / GPT partition table."
11527 msgstr ""
11528
11529 #. type: textblock
11530 #: ../fish/guestfish-actions.pod:3626 ../src/guestfs-actions.pod:5551
11531 msgid ""
11532 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11533 "and Intel-based Mac OS X.  It also has limited backwards compatibility with "
11534 "the C<mbr> format."
11535 msgstr ""
11536
11537 #. type: =item
11538 #: ../fish/guestfish-actions.pod:3630 ../src/guestfs-actions.pod:5555
11539 msgid "B<mbr>"
11540 msgstr ""
11541
11542 #. type: =item
11543 #: ../fish/guestfish-actions.pod:3632 ../src/guestfs-actions.pod:5557
11544 msgid "B<msdos>"
11545 msgstr ""
11546
11547 #. type: textblock
11548 #: ../fish/guestfish-actions.pod:3634 ../src/guestfs-actions.pod:5559
11549 msgid ""
11550 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11551 "Windows.  This partition type will B<only> work for device sizes up to 2 "
11552 "TB.  For large disks we recommend using C<gpt>."
11553 msgstr ""
11554
11555 #. type: textblock
11556 #: ../fish/guestfish-actions.pod:3641 ../src/guestfs-actions.pod:5566
11557 msgid "Other partition table types that may work but are not supported include:"
11558 msgstr ""
11559
11560 #. type: =item
11561 #: ../fish/guestfish-actions.pod:3646 ../src/guestfs-actions.pod:5571
11562 msgid "B<aix>"
11563 msgstr ""
11564
11565 #. type: textblock
11566 #: ../fish/guestfish-actions.pod:3648 ../src/guestfs-actions.pod:5573
11567 msgid "AIX disk labels."
11568 msgstr ""
11569
11570 #. type: =item
11571 #: ../fish/guestfish-actions.pod:3650 ../src/guestfs-actions.pod:5575
11572 msgid "B<amiga>"
11573 msgstr ""
11574
11575 #. type: =item
11576 #: ../fish/guestfish-actions.pod:3652 ../src/guestfs-actions.pod:5577
11577 msgid "B<rdb>"
11578 msgstr ""
11579
11580 #. type: textblock
11581 #: ../fish/guestfish-actions.pod:3654 ../src/guestfs-actions.pod:5579
11582 msgid "Amiga \"Rigid Disk Block\" format."
11583 msgstr ""
11584
11585 #. type: =item
11586 #: ../fish/guestfish-actions.pod:3656 ../src/guestfs-actions.pod:5581
11587 msgid "B<bsd>"
11588 msgstr ""
11589
11590 #. type: textblock
11591 #: ../fish/guestfish-actions.pod:3658 ../src/guestfs-actions.pod:5583
11592 msgid "BSD disk labels."
11593 msgstr ""
11594
11595 #. type: =item
11596 #: ../fish/guestfish-actions.pod:3660 ../src/guestfs-actions.pod:5585
11597 msgid "B<dasd>"
11598 msgstr ""
11599
11600 #. type: textblock
11601 #: ../fish/guestfish-actions.pod:3662 ../src/guestfs-actions.pod:5587
11602 msgid "DASD, used on IBM mainframes."
11603 msgstr ""
11604
11605 #. type: =item
11606 #: ../fish/guestfish-actions.pod:3664 ../src/guestfs-actions.pod:5589
11607 msgid "B<dvh>"
11608 msgstr ""
11609
11610 #. type: textblock
11611 #: ../fish/guestfish-actions.pod:3666 ../src/guestfs-actions.pod:5591
11612 msgid "MIPS/SGI volumes."
11613 msgstr ""
11614
11615 #. type: =item
11616 #: ../fish/guestfish-actions.pod:3668 ../src/guestfs-actions.pod:5593
11617 msgid "B<mac>"
11618 msgstr ""
11619
11620 #. type: textblock
11621 #: ../fish/guestfish-actions.pod:3670 ../src/guestfs-actions.pod:5595
11622 msgid "Old Mac partition format.  Modern Macs use C<gpt>."
11623 msgstr ""
11624
11625 #. type: =item
11626 #: ../fish/guestfish-actions.pod:3672 ../src/guestfs-actions.pod:5597
11627 msgid "B<pc98>"
11628 msgstr ""
11629
11630 #. type: textblock
11631 #: ../fish/guestfish-actions.pod:3674 ../src/guestfs-actions.pod:5599
11632 msgid "NEC PC-98 format, common in Japan apparently."
11633 msgstr ""
11634
11635 #. type: =item
11636 #: ../fish/guestfish-actions.pod:3676 ../src/guestfs-actions.pod:5601
11637 msgid "B<sun>"
11638 msgstr ""
11639
11640 #. type: textblock
11641 #: ../fish/guestfish-actions.pod:3678 ../src/guestfs-actions.pod:5603
11642 msgid "Sun disk labels."
11643 msgstr ""
11644
11645 #. type: =head2
11646 #: ../fish/guestfish-actions.pod:3682
11647 msgid "part-list"
11648 msgstr ""
11649
11650 #. type: verbatim
11651 #: ../fish/guestfish-actions.pod:3684
11652 #, no-wrap
11653 msgid ""
11654 " part-list device\n"
11655 "\n"
11656 msgstr ""
11657
11658 #. type: textblock
11659 #: ../fish/guestfish-actions.pod:3686 ../src/guestfs-actions.pod:5617
11660 msgid ""
11661 "This command parses the partition table on C<device> and returns the list of "
11662 "partitions found."
11663 msgstr ""
11664
11665 #. type: textblock
11666 #: ../fish/guestfish-actions.pod:3689 ../src/guestfs-actions.pod:5620
11667 msgid "The fields in the returned structure are:"
11668 msgstr ""
11669
11670 #. type: =item
11671 #: ../fish/guestfish-actions.pod:3693 ../src/guestfs-actions.pod:5624
11672 msgid "B<part_num>"
11673 msgstr ""
11674
11675 #. type: textblock
11676 #: ../fish/guestfish-actions.pod:3695 ../src/guestfs-actions.pod:5626
11677 msgid "Partition number, counting from 1."
11678 msgstr ""
11679
11680 #. type: =item
11681 #: ../fish/guestfish-actions.pod:3697 ../src/guestfs-actions.pod:5628
11682 msgid "B<part_start>"
11683 msgstr ""
11684
11685 #. type: textblock
11686 #: ../fish/guestfish-actions.pod:3699
11687 msgid ""
11688 "Start of the partition I<in bytes>.  To get sectors you have to divide by "
11689 "the device's sector size, see L</blockdev-getss>."
11690 msgstr ""
11691
11692 #. type: =item
11693 #: ../fish/guestfish-actions.pod:3702 ../src/guestfs-actions.pod:5633
11694 msgid "B<part_end>"
11695 msgstr ""
11696
11697 #. type: textblock
11698 #: ../fish/guestfish-actions.pod:3704 ../src/guestfs-actions.pod:5635
11699 msgid "End of the partition in bytes."
11700 msgstr ""
11701
11702 #. type: =item
11703 #: ../fish/guestfish-actions.pod:3706 ../src/guestfs-actions.pod:5637
11704 msgid "B<part_size>"
11705 msgstr ""
11706
11707 #. type: textblock
11708 #: ../fish/guestfish-actions.pod:3708 ../src/guestfs-actions.pod:5639
11709 msgid "Size of the partition in bytes."
11710 msgstr ""
11711
11712 #. type: =head2
11713 #: ../fish/guestfish-actions.pod:3712
11714 msgid "part-set-bootable"
11715 msgstr ""
11716
11717 #. type: verbatim
11718 #: ../fish/guestfish-actions.pod:3714
11719 #, no-wrap
11720 msgid ""
11721 " part-set-bootable device partnum true|false\n"
11722 "\n"
11723 msgstr ""
11724
11725 #. type: textblock
11726 #: ../fish/guestfish-actions.pod:3716 ../src/guestfs-actions.pod:5657
11727 msgid ""
11728 "This sets the bootable flag on partition numbered C<partnum> on device "
11729 "C<device>.  Note that partitions are numbered from 1."
11730 msgstr ""
11731
11732 #. type: textblock
11733 #: ../fish/guestfish-actions.pod:3719 ../src/guestfs-actions.pod:5660
11734 msgid ""
11735 "The bootable flag is used by some operating systems (notably Windows) to "
11736 "determine which partition to boot from.  It is by no means universally "
11737 "recognized."
11738 msgstr ""
11739
11740 #. type: =head2
11741 #: ../fish/guestfish-actions.pod:3723
11742 msgid "part-set-mbr-id"
11743 msgstr ""
11744
11745 #. type: verbatim
11746 #: ../fish/guestfish-actions.pod:3725
11747 #, no-wrap
11748 msgid ""
11749 " part-set-mbr-id device partnum idbyte\n"
11750 "\n"
11751 msgstr ""
11752
11753 #. type: textblock
11754 #: ../fish/guestfish-actions.pod:3727 ../src/guestfs-actions.pod:5676
11755 msgid ""
11756 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11757 "C<partnum> to C<idbyte>.  Note that the type bytes quoted in most "
11758 "documentation are in fact hexadecimal numbers, but usually documented "
11759 "without any leading \"0x\" which might be confusing."
11760 msgstr ""
11761
11762 #. type: =head2
11763 #: ../fish/guestfish-actions.pod:3737
11764 msgid "part-set-name"
11765 msgstr ""
11766
11767 #. type: verbatim
11768 #: ../fish/guestfish-actions.pod:3739
11769 #, no-wrap
11770 msgid ""
11771 " part-set-name device partnum name\n"
11772 "\n"
11773 msgstr ""
11774
11775 #. type: textblock
11776 #: ../fish/guestfish-actions.pod:3741 ../src/guestfs-actions.pod:5698
11777 msgid ""
11778 "This sets the partition name on partition numbered C<partnum> on device "
11779 "C<device>.  Note that partitions are numbered from 1."
11780 msgstr ""
11781
11782 #. type: textblock
11783 #: ../fish/guestfish-actions.pod:3744 ../src/guestfs-actions.pod:5701
11784 msgid ""
11785 "The partition name can only be set on certain types of partition table.  "
11786 "This works on C<gpt> but not on C<mbr> partitions."
11787 msgstr ""
11788
11789 #. type: =head2
11790 #: ../fish/guestfish-actions.pod:3747
11791 msgid "part-to-dev"
11792 msgstr ""
11793
11794 #. type: verbatim
11795 #: ../fish/guestfish-actions.pod:3749
11796 #, no-wrap
11797 msgid ""
11798 " part-to-dev partition\n"
11799 "\n"
11800 msgstr ""
11801
11802 #. type: textblock
11803 #: ../fish/guestfish-actions.pod:3751 ../src/guestfs-actions.pod:5714
11804 msgid ""
11805 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
11806 "partition number, returning the device name (eg. \"/dev/sdb\")."
11807 msgstr ""
11808
11809 #. type: textblock
11810 #: ../fish/guestfish-actions.pod:3755
11811 msgid ""
11812 "The named partition must exist, for example as a string returned from "
11813 "L</list-partitions>."
11814 msgstr ""
11815
11816 #. type: =head2
11817 #: ../fish/guestfish-actions.pod:3758
11818 msgid "ping-daemon"
11819 msgstr ""
11820
11821 #. type: verbatim
11822 #: ../fish/guestfish-actions.pod:3760
11823 #, no-wrap
11824 msgid ""
11825 " ping-daemon\n"
11826 "\n"
11827 msgstr ""
11828
11829 #. type: textblock
11830 #: ../fish/guestfish-actions.pod:3762 ../src/guestfs-actions.pod:5731
11831 msgid ""
11832 "This is a test probe into the guestfs daemon running inside the qemu "
11833 "subprocess.  Calling this function checks that the daemon responds to the "
11834 "ping message, without affecting the daemon or attached block device(s) in "
11835 "any other way."
11836 msgstr ""
11837
11838 #. type: =head2
11839 #: ../fish/guestfish-actions.pod:3767
11840 msgid "pread"
11841 msgstr ""
11842
11843 #. type: verbatim
11844 #: ../fish/guestfish-actions.pod:3769
11845 #, no-wrap
11846 msgid ""
11847 " pread path count offset\n"
11848 "\n"
11849 msgstr ""
11850
11851 #. type: textblock
11852 #: ../fish/guestfish-actions.pod:3771 ../src/guestfs-actions.pod:5749
11853 msgid ""
11854 "This command lets you read part of a file.  It reads C<count> bytes of the "
11855 "file, starting at C<offset>, from file C<path>."
11856 msgstr ""
11857
11858 #. type: textblock
11859 #: ../fish/guestfish-actions.pod:3774 ../fish/guestfish-actions.pod:3789 ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:5778
11860 msgid ""
11861 "This may read fewer bytes than requested.  For further details see the "
11862 "L<pread(2)> system call."
11863 msgstr ""
11864
11865 #. type: textblock
11866 #: ../fish/guestfish-actions.pod:3777
11867 msgid "See also L</pwrite>, L</pread-device>."
11868 msgstr ""
11869
11870 #. type: =head2
11871 #: ../fish/guestfish-actions.pod:3782
11872 msgid "pread-device"
11873 msgstr ""
11874
11875 #. type: verbatim
11876 #: ../fish/guestfish-actions.pod:3784
11877 #, no-wrap
11878 msgid ""
11879 " pread-device device count offset\n"
11880 "\n"
11881 msgstr ""
11882
11883 #. type: textblock
11884 #: ../fish/guestfish-actions.pod:3786 ../src/guestfs-actions.pod:5775
11885 msgid ""
11886 "This command lets you read part of a file.  It reads C<count> bytes of "
11887 "C<device>, starting at C<offset>."
11888 msgstr ""
11889
11890 #. type: textblock
11891 #: ../fish/guestfish-actions.pod:3792
11892 msgid "See also L</pread>."
11893 msgstr ""
11894
11895 #. type: =head2
11896 #: ../fish/guestfish-actions.pod:3797
11897 msgid "pvcreate"
11898 msgstr ""
11899
11900 #. type: verbatim
11901 #: ../fish/guestfish-actions.pod:3799
11902 #, no-wrap
11903 msgid ""
11904 " pvcreate device\n"
11905 "\n"
11906 msgstr ""
11907
11908 #. type: textblock
11909 #: ../fish/guestfish-actions.pod:3801 ../src/guestfs-actions.pod:5798
11910 msgid ""
11911 "This creates an LVM physical volume on the named C<device>, where C<device> "
11912 "should usually be a partition name such as C</dev/sda1>."
11913 msgstr ""
11914
11915 #. type: =head2
11916 #: ../fish/guestfish-actions.pod:3805
11917 msgid "pvremove"
11918 msgstr ""
11919
11920 #. type: verbatim
11921 #: ../fish/guestfish-actions.pod:3807
11922 #, no-wrap
11923 msgid ""
11924 " pvremove device\n"
11925 "\n"
11926 msgstr ""
11927
11928 #. type: textblock
11929 #: ../fish/guestfish-actions.pod:3809 ../src/guestfs-actions.pod:5812
11930 msgid ""
11931 "This wipes a physical volume C<device> so that LVM will no longer recognise "
11932 "it."
11933 msgstr ""
11934
11935 #. type: textblock
11936 #: ../fish/guestfish-actions.pod:3812 ../src/guestfs-actions.pod:5815
11937 msgid ""
11938 "The implementation uses the C<pvremove> command which refuses to wipe "
11939 "physical volumes that contain any volume groups, so you have to remove those "
11940 "first."
11941 msgstr ""
11942
11943 #. type: =head2
11944 #: ../fish/guestfish-actions.pod:3816
11945 msgid "pvresize"
11946 msgstr ""
11947
11948 #. type: verbatim
11949 #: ../fish/guestfish-actions.pod:3818
11950 #, no-wrap
11951 msgid ""
11952 " pvresize device\n"
11953 "\n"
11954 msgstr ""
11955
11956 #. type: textblock
11957 #: ../fish/guestfish-actions.pod:3820 ../src/guestfs-actions.pod:5829
11958 msgid ""
11959 "This resizes (expands or shrinks) an existing LVM physical volume to match "
11960 "the new size of the underlying device."
11961 msgstr ""
11962
11963 #. type: =head2
11964 #: ../fish/guestfish-actions.pod:3823
11965 msgid "pvresize-size"
11966 msgstr ""
11967
11968 #. type: verbatim
11969 #: ../fish/guestfish-actions.pod:3825
11970 #, no-wrap
11971 msgid ""
11972 " pvresize-size device size\n"
11973 "\n"
11974 msgstr ""
11975
11976 #. type: textblock
11977 #: ../fish/guestfish-actions.pod:3827
11978 msgid ""
11979 "This command is the same as L</pvresize> except that it allows you to "
11980 "specify the new size (in bytes) explicitly."
11981 msgstr ""
11982
11983 #. type: =head2
11984 #: ../fish/guestfish-actions.pod:3830
11985 msgid "pvs"
11986 msgstr ""
11987
11988 #. type: verbatim
11989 #: ../fish/guestfish-actions.pod:3832
11990 #, no-wrap
11991 msgid ""
11992 " pvs\n"
11993 "\n"
11994 msgstr ""
11995
11996 #. type: textblock
11997 #: ../fish/guestfish-actions.pod:3834 ../src/guestfs-actions.pod:5855
11998 msgid ""
11999 "List all the physical volumes detected.  This is the equivalent of the "
12000 "L<pvs(8)> command."
12001 msgstr ""
12002
12003 #. type: textblock
12004 #: ../fish/guestfish-actions.pod:3837 ../src/guestfs-actions.pod:5858
12005 msgid ""
12006 "This returns a list of just the device names that contain PVs "
12007 "(eg. C</dev/sda2>)."
12008 msgstr ""
12009
12010 #. type: textblock
12011 #: ../fish/guestfish-actions.pod:3840
12012 msgid "See also L</pvs-full>."
12013 msgstr ""
12014
12015 #. type: =head2
12016 #: ../fish/guestfish-actions.pod:3842
12017 msgid "pvs-full"
12018 msgstr ""
12019
12020 #. type: verbatim
12021 #: ../fish/guestfish-actions.pod:3844
12022 #, no-wrap
12023 msgid ""
12024 " pvs-full\n"
12025 "\n"
12026 msgstr ""
12027
12028 #. type: textblock
12029 #: ../fish/guestfish-actions.pod:3846 ../src/guestfs-actions.pod:5874
12030 msgid ""
12031 "List all the physical volumes detected.  This is the equivalent of the "
12032 "L<pvs(8)> command.  The \"full\" version includes all fields."
12033 msgstr ""
12034
12035 #. type: =head2
12036 #: ../fish/guestfish-actions.pod:3849
12037 msgid "pvuuid"
12038 msgstr ""
12039
12040 #. type: verbatim
12041 #: ../fish/guestfish-actions.pod:3851
12042 #, no-wrap
12043 msgid ""
12044 " pvuuid device\n"
12045 "\n"
12046 msgstr ""
12047
12048 #. type: textblock
12049 #: ../fish/guestfish-actions.pod:3853 ../src/guestfs-actions.pod:5889
12050 msgid "This command returns the UUID of the LVM PV C<device>."
12051 msgstr ""
12052
12053 #. type: =head2
12054 #: ../fish/guestfish-actions.pod:3855
12055 msgid "pwrite"
12056 msgstr ""
12057
12058 #. type: verbatim
12059 #: ../fish/guestfish-actions.pod:3857
12060 #, no-wrap
12061 msgid ""
12062 " pwrite path content offset\n"
12063 "\n"
12064 msgstr ""
12065
12066 #. type: textblock
12067 #: ../fish/guestfish-actions.pod:3859 ../src/guestfs-actions.pod:5905
12068 msgid ""
12069 "This command writes to part of a file.  It writes the data buffer C<content> "
12070 "to the file C<path> starting at offset C<offset>."
12071 msgstr ""
12072
12073 #. type: textblock
12074 #: ../fish/guestfish-actions.pod:3862 ../src/guestfs-actions.pod:5908
12075 msgid ""
12076 "This command implements the L<pwrite(2)> system call, and like that system "
12077 "call it may not write the full data requested.  The return value is the "
12078 "number of bytes that were actually written to the file.  This could even be "
12079 "0, although short writes are unlikely for regular files in ordinary "
12080 "circumstances."
12081 msgstr ""
12082
12083 #. type: textblock
12084 #: ../fish/guestfish-actions.pod:3868
12085 msgid "See also L</pread>, L</pwrite-device>."
12086 msgstr ""
12087
12088 #. type: =head2
12089 #: ../fish/guestfish-actions.pod:3873
12090 msgid "pwrite-device"
12091 msgstr ""
12092
12093 #. type: verbatim
12094 #: ../fish/guestfish-actions.pod:3875
12095 #, no-wrap
12096 msgid ""
12097 " pwrite-device device content offset\n"
12098 "\n"
12099 msgstr ""
12100
12101 #. type: textblock
12102 #: ../fish/guestfish-actions.pod:3877 ../src/guestfs-actions.pod:5932
12103 msgid ""
12104 "This command writes to part of a device.  It writes the data buffer "
12105 "C<content> to C<device> starting at offset C<offset>."
12106 msgstr ""
12107
12108 #. type: textblock
12109 #: ../fish/guestfish-actions.pod:3880 ../src/guestfs-actions.pod:5935
12110 msgid ""
12111 "This command implements the L<pwrite(2)> system call, and like that system "
12112 "call it may not write the full data requested (although short writes to disk "
12113 "devices and partitions are probably impossible with standard Linux kernels)."
12114 msgstr ""
12115
12116 #. type: textblock
12117 #: ../fish/guestfish-actions.pod:3885
12118 msgid "See also L</pwrite>."
12119 msgstr ""
12120
12121 #. type: =head2
12122 #: ../fish/guestfish-actions.pod:3890
12123 msgid "read-file"
12124 msgstr ""
12125
12126 #. type: verbatim
12127 #: ../fish/guestfish-actions.pod:3892
12128 #, no-wrap
12129 msgid ""
12130 " read-file path\n"
12131 "\n"
12132 msgstr ""
12133
12134 #. type: textblock
12135 #: ../fish/guestfish-actions.pod:3894 ../src/guestfs-actions.pod:5956
12136 msgid "This calls returns the contents of the file C<path> as a buffer."
12137 msgstr ""
12138
12139 #. type: textblock
12140 #: ../fish/guestfish-actions.pod:3897
12141 msgid ""
12142 "Unlike L</cat>, this function can correctly handle files that contain "
12143 "embedded ASCII NUL characters.  However unlike L</download>, this function "
12144 "is limited in the total size of file that can be handled."
12145 msgstr ""
12146
12147 #. type: =head2
12148 #: ../fish/guestfish-actions.pod:3905
12149 msgid "read-lines"
12150 msgstr ""
12151
12152 #. type: verbatim
12153 #: ../fish/guestfish-actions.pod:3907
12154 #, no-wrap
12155 msgid ""
12156 " read-lines path\n"
12157 "\n"
12158 msgstr ""
12159
12160 #. type: textblock
12161 #: ../fish/guestfish-actions.pod:3911 ../src/guestfs-actions.pod:5981
12162 msgid ""
12163 "The file contents are returned as a list of lines.  Trailing C<LF> and "
12164 "C<CRLF> character sequences are I<not> returned."
12165 msgstr ""
12166
12167 #. type: textblock
12168 #: ../fish/guestfish-actions.pod:3914
12169 msgid ""
12170 "Note that this function cannot correctly handle binary files (specifically, "
12171 "files containing C<\\0> character which is treated as end of line).  For "
12172 "those you need to use the L</read-file> function which has a more complex "
12173 "interface."
12174 msgstr ""
12175
12176 #. type: =head2
12177 #: ../fish/guestfish-actions.pod:3919
12178 msgid "readdir"
12179 msgstr ""
12180
12181 #. type: verbatim
12182 #: ../fish/guestfish-actions.pod:3921
12183 #, no-wrap
12184 msgid ""
12185 " readdir dir\n"
12186 "\n"
12187 msgstr ""
12188
12189 #. type: textblock
12190 #: ../fish/guestfish-actions.pod:3923 ../src/guestfs-actions.pod:6001
12191 msgid "This returns the list of directory entries in directory C<dir>."
12192 msgstr ""
12193
12194 #. type: textblock
12195 #: ../fish/guestfish-actions.pod:3925 ../src/guestfs-actions.pod:6003
12196 msgid ""
12197 "All entries in the directory are returned, including C<.> and C<..>.  The "
12198 "entries are I<not> sorted, but returned in the same order as the underlying "
12199 "filesystem."
12200 msgstr ""
12201
12202 #. type: textblock
12203 #: ../fish/guestfish-actions.pod:3929 ../src/guestfs-actions.pod:6007
12204 msgid ""
12205 "Also this call returns basic file type information about each file.  The "
12206 "C<ftyp> field will contain one of the following characters:"
12207 msgstr ""
12208
12209 #. type: =item
12210 #: ../fish/guestfish-actions.pod:3934 ../src/guestfs-actions.pod:6012
12211 msgid "'b'"
12212 msgstr ""
12213
12214 #. type: textblock
12215 #: ../fish/guestfish-actions.pod:3936 ../src/guestfs-actions.pod:6014
12216 msgid "Block special"
12217 msgstr ""
12218
12219 #. type: =item
12220 #: ../fish/guestfish-actions.pod:3938 ../src/guestfs-actions.pod:6016
12221 msgid "'c'"
12222 msgstr ""
12223
12224 #. type: textblock
12225 #: ../fish/guestfish-actions.pod:3940 ../src/guestfs-actions.pod:6018
12226 msgid "Char special"
12227 msgstr ""
12228
12229 #. type: =item
12230 #: ../fish/guestfish-actions.pod:3942 ../src/guestfs-actions.pod:6020
12231 msgid "'d'"
12232 msgstr ""
12233
12234 #. type: textblock
12235 #: ../fish/guestfish-actions.pod:3944 ../src/guestfs-actions.pod:6022
12236 msgid "Directory"
12237 msgstr ""
12238
12239 #. type: =item
12240 #: ../fish/guestfish-actions.pod:3946 ../src/guestfs-actions.pod:6024
12241 msgid "'f'"
12242 msgstr ""
12243
12244 #. type: textblock
12245 #: ../fish/guestfish-actions.pod:3948 ../src/guestfs-actions.pod:6026
12246 msgid "FIFO (named pipe)"
12247 msgstr ""
12248
12249 #. type: =item
12250 #: ../fish/guestfish-actions.pod:3950 ../src/guestfs-actions.pod:6028
12251 msgid "'l'"
12252 msgstr ""
12253
12254 #. type: textblock
12255 #: ../fish/guestfish-actions.pod:3952 ../src/guestfs-actions.pod:6030
12256 msgid "Symbolic link"
12257 msgstr ""
12258
12259 #. type: =item
12260 #: ../fish/guestfish-actions.pod:3954 ../src/guestfs-actions.pod:6032
12261 msgid "'r'"
12262 msgstr ""
12263
12264 #. type: textblock
12265 #: ../fish/guestfish-actions.pod:3956 ../src/guestfs-actions.pod:6034
12266 msgid "Regular file"
12267 msgstr ""
12268
12269 #. type: =item
12270 #: ../fish/guestfish-actions.pod:3958 ../src/guestfs-actions.pod:6036
12271 msgid "'s'"
12272 msgstr ""
12273
12274 #. type: textblock
12275 #: ../fish/guestfish-actions.pod:3960 ../src/guestfs-actions.pod:6038
12276 msgid "Socket"
12277 msgstr ""
12278
12279 #. type: =item
12280 #: ../fish/guestfish-actions.pod:3962 ../src/guestfs-actions.pod:6040
12281 msgid "'u'"
12282 msgstr ""
12283
12284 #. type: textblock
12285 #: ../fish/guestfish-actions.pod:3964 ../src/guestfs-actions.pod:6042
12286 msgid "Unknown file type"
12287 msgstr ""
12288
12289 #. type: =item
12290 #: ../fish/guestfish-actions.pod:3966 ../src/guestfs-actions.pod:6044
12291 msgid "'?'"
12292 msgstr ""
12293
12294 #. type: textblock
12295 #: ../fish/guestfish-actions.pod:3968 ../src/guestfs-actions.pod:6046
12296 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12297 msgstr ""
12298
12299 #. type: textblock
12300 #: ../fish/guestfish-actions.pod:3973
12301 msgid ""
12302 "This function is primarily intended for use by programs.  To get a simple "
12303 "list of names, use L</ls>.  To get a printable directory for human "
12304 "consumption, use L</ll>."
12305 msgstr ""
12306
12307 #. type: =head2
12308 #: ../fish/guestfish-actions.pod:3977
12309 msgid "readlink"
12310 msgstr ""
12311
12312 #. type: verbatim
12313 #: ../fish/guestfish-actions.pod:3979
12314 #, no-wrap
12315 msgid ""
12316 " readlink path\n"
12317 "\n"
12318 msgstr ""
12319
12320 #. type: textblock
12321 #: ../fish/guestfish-actions.pod:3981 ../src/guestfs-actions.pod:6067
12322 msgid "This command reads the target of a symbolic link."
12323 msgstr ""
12324
12325 #. type: =head2
12326 #: ../fish/guestfish-actions.pod:3983
12327 msgid "readlinklist"
12328 msgstr ""
12329
12330 #. type: verbatim
12331 #: ../fish/guestfish-actions.pod:3985
12332 #, no-wrap
12333 msgid ""
12334 " readlinklist path 'names ...'\n"
12335 "\n"
12336 msgstr ""
12337
12338 #. type: textblock
12339 #: ../fish/guestfish-actions.pod:3987 ../src/guestfs-actions.pod:6081
12340 msgid ""
12341 "This call allows you to do a C<readlink> operation on multiple files, where "
12342 "all files are in the directory C<path>.  C<names> is the list of files from "
12343 "this directory."
12344 msgstr ""
12345
12346 #. type: textblock
12347 #: ../fish/guestfish-actions.pod:3991 ../src/guestfs-actions.pod:6085
12348 msgid ""
12349 "On return you get a list of strings, with a one-to-one correspondence to the "
12350 "C<names> list.  Each string is the value of the symbolic link."
12351 msgstr ""
12352
12353 #. type: textblock
12354 #: ../fish/guestfish-actions.pod:3995 ../src/guestfs-actions.pod:6089
12355 msgid ""
12356 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12357 "result string is the empty string C<\"\">.  However the whole operation is "
12358 "completed even if there were C<readlink(2)> errors, and so you can call this "
12359 "function with names where you don't know if they are symbolic links already "
12360 "(albeit slightly less efficient)."
12361 msgstr ""
12362
12363 #. type: textblock
12364 #: ../fish/guestfish-actions.pod:4002 ../src/guestfs-actions.pod:6096
12365 msgid ""
12366 "This call is intended for programs that want to efficiently list a directory "
12367 "contents without making many round-trips.  Very long directory listings "
12368 "might cause the protocol message size to be exceeded, causing this call to "
12369 "fail.  The caller must split up such requests into smaller groups of names."
12370 msgstr ""
12371
12372 #. type: =head2
12373 #: ../fish/guestfish-actions.pod:4009
12374 msgid "realpath"
12375 msgstr ""
12376
12377 #. type: verbatim
12378 #: ../fish/guestfish-actions.pod:4011
12379 #, no-wrap
12380 msgid ""
12381 " realpath path\n"
12382 "\n"
12383 msgstr ""
12384
12385 #. type: textblock
12386 #: ../fish/guestfish-actions.pod:4013 ../src/guestfs-actions.pod:6115
12387 msgid ""
12388 "Return the canonicalized absolute pathname of C<path>.  The returned path "
12389 "has no C<.>, C<..> or symbolic link path elements."
12390 msgstr ""
12391
12392 #. type: =head2
12393 #: ../fish/guestfish-actions.pod:4016
12394 msgid "removexattr"
12395 msgstr ""
12396
12397 #. type: verbatim
12398 #: ../fish/guestfish-actions.pod:4018
12399 #, no-wrap
12400 msgid ""
12401 " removexattr xattr path\n"
12402 "\n"
12403 msgstr ""
12404
12405 #. type: textblock
12406 #: ../fish/guestfish-actions.pod:4020 ../src/guestfs-actions.pod:6130
12407 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
12408 msgstr ""
12409
12410 #. type: textblock
12411 #: ../fish/guestfish-actions.pod:4023
12412 msgid "See also: L</lremovexattr>, L<attr(5)>."
12413 msgstr ""
12414
12415 #. type: =head2
12416 #: ../fish/guestfish-actions.pod:4025
12417 msgid "resize2fs"
12418 msgstr ""
12419
12420 #. type: verbatim
12421 #: ../fish/guestfish-actions.pod:4027
12422 #, no-wrap
12423 msgid ""
12424 " resize2fs device\n"
12425 "\n"
12426 msgstr ""
12427
12428 #. type: textblock
12429 #: ../fish/guestfish-actions.pod:4029 ../src/guestfs-actions.pod:6145
12430 msgid ""
12431 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12432 "underlying device."
12433 msgstr ""
12434
12435 #. type: textblock
12436 #: ../fish/guestfish-actions.pod:4032
12437 msgid ""
12438 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
12439 "before calling this command.  For unknown reasons C<resize2fs> sometimes "
12440 "gives an error about this and sometimes not.  In any case, it is always safe "
12441 "to call L</e2fsck-f> before calling this function."
12442 msgstr ""
12443
12444 #. type: =head2
12445 #: ../fish/guestfish-actions.pod:4038
12446 msgid "resize2fs-M"
12447 msgstr ""
12448
12449 #. type: verbatim
12450 #: ../fish/guestfish-actions.pod:4040
12451 #, no-wrap
12452 msgid ""
12453 " resize2fs-M device\n"
12454 "\n"
12455 msgstr ""
12456
12457 #. type: textblock
12458 #: ../fish/guestfish-actions.pod:4042
12459 msgid ""
12460 "This command is the same as L</resize2fs>, but the filesystem is resized to "
12461 "its minimum size.  This works like the I<-M> option to the C<resize2fs> "
12462 "command."
12463 msgstr ""
12464
12465 #. type: textblock
12466 #: ../fish/guestfish-actions.pod:4046
12467 msgid ""
12468 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
12469 "and read the C<Block size> and C<Block count> values.  These two numbers, "
12470 "multiplied together, give the resulting size of the minimal filesystem in "
12471 "bytes."
12472 msgstr ""
12473
12474 #. type: =head2
12475 #: ../fish/guestfish-actions.pod:4051
12476 msgid "resize2fs-size"
12477 msgstr ""
12478
12479 #. type: verbatim
12480 #: ../fish/guestfish-actions.pod:4053
12481 #, no-wrap
12482 msgid ""
12483 " resize2fs-size device size\n"
12484 "\n"
12485 msgstr ""
12486
12487 #. type: textblock
12488 #: ../fish/guestfish-actions.pod:4055
12489 msgid ""
12490 "This command is the same as L</resize2fs> except that it allows you to "
12491 "specify the new size (in bytes) explicitly."
12492 msgstr ""
12493
12494 #. type: =head2
12495 #: ../fish/guestfish-actions.pod:4058
12496 msgid "rm"
12497 msgstr ""
12498
12499 #. type: verbatim
12500 #: ../fish/guestfish-actions.pod:4060
12501 #, no-wrap
12502 msgid ""
12503 " rm path\n"
12504 "\n"
12505 msgstr ""
12506
12507 #. type: textblock
12508 #: ../fish/guestfish-actions.pod:4062 ../src/guestfs-actions.pod:6197
12509 msgid "Remove the single file C<path>."
12510 msgstr ""
12511
12512 #. type: =head2
12513 #: ../fish/guestfish-actions.pod:4064
12514 msgid "rm-rf"
12515 msgstr ""
12516
12517 #. type: verbatim
12518 #: ../fish/guestfish-actions.pod:4066
12519 #, no-wrap
12520 msgid ""
12521 " rm-rf path\n"
12522 "\n"
12523 msgstr ""
12524
12525 #. type: textblock
12526 #: ../fish/guestfish-actions.pod:4068 ../src/guestfs-actions.pod:6209
12527 msgid ""
12528 "Remove the file or directory C<path>, recursively removing the contents if "
12529 "its a directory.  This is like the C<rm -rf> shell command."
12530 msgstr ""
12531
12532 #. type: =head2
12533 #: ../fish/guestfish-actions.pod:4072
12534 msgid "rmdir"
12535 msgstr ""
12536
12537 #. type: verbatim
12538 #: ../fish/guestfish-actions.pod:4074
12539 #, no-wrap
12540 msgid ""
12541 " rmdir path\n"
12542 "\n"
12543 msgstr ""
12544
12545 #. type: textblock
12546 #: ../fish/guestfish-actions.pod:4076 ../src/guestfs-actions.pod:6223
12547 msgid "Remove the single directory C<path>."
12548 msgstr ""
12549
12550 #. type: =head2
12551 #: ../fish/guestfish-actions.pod:4078
12552 msgid "rmmountpoint"
12553 msgstr ""
12554
12555 #. type: verbatim
12556 #: ../fish/guestfish-actions.pod:4080
12557 #, no-wrap
12558 msgid ""
12559 " rmmountpoint exemptpath\n"
12560 "\n"
12561 msgstr ""
12562
12563 #. type: textblock
12564 #: ../fish/guestfish-actions.pod:4082
12565 msgid ""
12566 "This calls removes a mountpoint that was previously created with "
12567 "L</mkmountpoint>.  See L</mkmountpoint> for full details."
12568 msgstr ""
12569
12570 #. type: =head2
12571 #: ../fish/guestfish-actions.pod:4086
12572 msgid "scrub-device"
12573 msgstr ""
12574
12575 #. type: verbatim
12576 #: ../fish/guestfish-actions.pod:4088
12577 #, no-wrap
12578 msgid ""
12579 " scrub-device device\n"
12580 "\n"
12581 msgstr ""
12582
12583 #. type: textblock
12584 #: ../fish/guestfish-actions.pod:4090 ../src/guestfs-actions.pod:6249
12585 msgid ""
12586 "This command writes patterns over C<device> to make data retrieval more "
12587 "difficult."
12588 msgstr ""
12589
12590 #. type: textblock
12591 #: ../fish/guestfish-actions.pod:4093 ../fish/guestfish-actions.pod:4108 ../fish/guestfish-actions.pod:4121 ../src/guestfs-actions.pod:6252 ../src/guestfs-actions.pod:6273 ../src/guestfs-actions.pod:6292
12592 msgid ""
12593 "It is an interface to the L<scrub(1)> program.  See that manual page for "
12594 "more details."
12595 msgstr ""
12596
12597 #. type: =head2
12598 #: ../fish/guestfish-actions.pod:4099
12599 msgid "scrub-file"
12600 msgstr ""
12601
12602 #. type: verbatim
12603 #: ../fish/guestfish-actions.pod:4101
12604 #, no-wrap
12605 msgid ""
12606 " scrub-file file\n"
12607 "\n"
12608 msgstr ""
12609
12610 #. type: textblock
12611 #: ../fish/guestfish-actions.pod:4103 ../src/guestfs-actions.pod:6268
12612 msgid ""
12613 "This command writes patterns over a file to make data retrieval more "
12614 "difficult."
12615 msgstr ""
12616
12617 #. type: textblock
12618 #: ../fish/guestfish-actions.pod:4106 ../src/guestfs-actions.pod:6271
12619 msgid "The file is I<removed> after scrubbing."
12620 msgstr ""
12621
12622 #. type: =head2
12623 #: ../fish/guestfish-actions.pod:4111
12624 msgid "scrub-freespace"
12625 msgstr ""
12626
12627 #. type: verbatim
12628 #: ../fish/guestfish-actions.pod:4113
12629 #, no-wrap
12630 msgid ""
12631 " scrub-freespace dir\n"
12632 "\n"
12633 msgstr ""
12634
12635 #. type: textblock
12636 #: ../fish/guestfish-actions.pod:4115
12637 msgid ""
12638 "This command creates the directory C<dir> and then fills it with files until "
12639 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
12640 "deletes them.  The intention is to scrub any free space on the partition "
12641 "containing C<dir>."
12642 msgstr ""
12643
12644 #. type: =head2
12645 #: ../fish/guestfish-actions.pod:4124
12646 msgid "set-append"
12647 msgstr ""
12648
12649 #. type: =head2
12650 #: ../fish/guestfish-actions.pod:4126
12651 msgid "append"
12652 msgstr ""
12653
12654 #. type: verbatim
12655 #: ../fish/guestfish-actions.pod:4128
12656 #, no-wrap
12657 msgid ""
12658 " set-append append\n"
12659 "\n"
12660 msgstr ""
12661
12662 #. type: textblock
12663 #: ../fish/guestfish-actions.pod:4130 ../src/guestfs-actions.pod:6305
12664 msgid ""
12665 "This function is used to add additional options to the guest kernel command "
12666 "line."
12667 msgstr ""
12668
12669 #. type: textblock
12670 #: ../fish/guestfish-actions.pod:4133 ../src/guestfs-actions.pod:6308
12671 msgid ""
12672 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12673 "environment variable."
12674 msgstr ""
12675
12676 #. type: textblock
12677 #: ../fish/guestfish-actions.pod:4136 ../src/guestfs-actions.pod:6311
12678 msgid ""
12679 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12680 "(libguestfs always adds a few of its own)."
12681 msgstr ""
12682
12683 #. type: =head2
12684 #: ../fish/guestfish-actions.pod:4139
12685 msgid "set-attach-method"
12686 msgstr ""
12687
12688 #. type: =head2
12689 #: ../fish/guestfish-actions.pod:4141
12690 msgid "attach-method"
12691 msgstr ""
12692
12693 #. type: verbatim
12694 #: ../fish/guestfish-actions.pod:4143
12695 #, no-wrap
12696 msgid ""
12697 " set-attach-method attachmethod\n"
12698 "\n"
12699 msgstr ""
12700
12701 #. type: textblock
12702 #: ../fish/guestfish-actions.pod:4145 ../src/guestfs-actions.pod:6324
12703 msgid ""
12704 "Set the method that libguestfs uses to connect to the back end guestfsd "
12705 "daemon.  Possible methods are:"
12706 msgstr ""
12707
12708 #. type: =item
12709 #: ../fish/guestfish-actions.pod:4150 ../src/guestfs-actions.pod:6329 ../src/guestfs.pod:2823
12710 msgid "C<appliance>"
12711 msgstr ""
12712
12713 #. type: textblock
12714 #: ../fish/guestfish-actions.pod:4152 ../src/guestfs-actions.pod:6331
12715 msgid ""
12716 "Launch an appliance and connect to it.  This is the ordinary method and the "
12717 "default."
12718 msgstr ""
12719
12720 #. type: =item
12721 #: ../fish/guestfish-actions.pod:4155 ../src/guestfs-actions.pod:6334
12722 msgid "C<unix:I<path>>"
12723 msgstr ""
12724
12725 #. type: textblock
12726 #: ../fish/guestfish-actions.pod:4157 ../src/guestfs-actions.pod:6336
12727 msgid "Connect to the Unix domain socket I<path>."
12728 msgstr ""
12729
12730 #. type: textblock
12731 #: ../fish/guestfish-actions.pod:4159 ../src/guestfs-actions.pod:6338
12732 msgid ""
12733 "This method lets you connect to an existing daemon or (using virtio-serial) "
12734 "to a live guest.  For more information, see L<guestfs(3)/ATTACHING TO "
12735 "RUNNING DAEMONS>."
12736 msgstr ""
12737
12738 #. type: =head2
12739 #: ../fish/guestfish-actions.pod:4165
12740 msgid "set-autosync"
12741 msgstr ""
12742
12743 #. type: =head2
12744 #: ../fish/guestfish-actions.pod:4167
12745 msgid "autosync"
12746 msgstr ""
12747
12748 #. type: verbatim
12749 #: ../fish/guestfish-actions.pod:4169
12750 #, no-wrap
12751 msgid ""
12752 " set-autosync true|false\n"
12753 "\n"
12754 msgstr ""
12755
12756 #. type: textblock
12757 #: ../fish/guestfish-actions.pod:4171 ../src/guestfs-actions.pod:6354
12758 msgid ""
12759 "If C<autosync> is true, this enables autosync.  Libguestfs will make a best "
12760 "effort attempt to make filesystems consistent and synchronized when the "
12761 "handle is closed (also if the program exits without closing handles)."
12762 msgstr ""
12763
12764 #. type: textblock
12765 #: ../fish/guestfish-actions.pod:4176 ../src/guestfs-actions.pod:6359
12766 msgid ""
12767 "This is enabled by default (since libguestfs 1.5.24, previously it was "
12768 "disabled by default)."
12769 msgstr ""
12770
12771 #. type: =head2
12772 #: ../fish/guestfish-actions.pod:4179
12773 msgid "set-direct"
12774 msgstr ""
12775
12776 #. type: =head2
12777 #: ../fish/guestfish-actions.pod:4181
12778 msgid "direct"
12779 msgstr ""
12780
12781 #. type: verbatim
12782 #: ../fish/guestfish-actions.pod:4183
12783 #, no-wrap
12784 msgid ""
12785 " set-direct true|false\n"
12786 "\n"
12787 msgstr ""
12788
12789 #. type: textblock
12790 #: ../fish/guestfish-actions.pod:4185 ../src/guestfs-actions.pod:6372
12791 msgid ""
12792 "If the direct appliance mode flag is enabled, then stdin and stdout are "
12793 "passed directly through to the appliance once it is launched."
12794 msgstr ""
12795
12796 #. type: textblock
12797 #: ../fish/guestfish-actions.pod:4189
12798 msgid ""
12799 "One consequence of this is that log messages aren't caught by the library "
12800 "and handled by L</set-log-message-callback>, but go straight to stdout."
12801 msgstr ""
12802
12803 #. type: textblock
12804 #: ../fish/guestfish-actions.pod:4193 ../src/guestfs-actions.pod:6380
12805 msgid "You probably don't want to use this unless you know what you are doing."
12806 msgstr ""
12807
12808 #. type: textblock
12809 #: ../fish/guestfish-actions.pod:4196 ../src/guestfs-actions.pod:6383
12810 msgid "The default is disabled."
12811 msgstr ""
12812
12813 #. type: =head2
12814 #: ../fish/guestfish-actions.pod:4198
12815 msgid "set-e2label"
12816 msgstr ""
12817
12818 #. type: verbatim
12819 #: ../fish/guestfish-actions.pod:4200
12820 #, no-wrap
12821 msgid ""
12822 " set-e2label device label\n"
12823 "\n"
12824 msgstr ""
12825
12826 #. type: textblock
12827 #: ../fish/guestfish-actions.pod:4202 ../src/guestfs-actions.pod:6396
12828 msgid ""
12829 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
12830 "C<label>.  Filesystem labels are limited to 16 characters."
12831 msgstr ""
12832
12833 #. type: textblock
12834 #: ../fish/guestfish-actions.pod:4206
12835 msgid ""
12836 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
12837 "label on a filesystem."
12838 msgstr ""
12839
12840 #. type: =head2
12841 #: ../fish/guestfish-actions.pod:4209
12842 msgid "set-e2uuid"
12843 msgstr ""
12844
12845 #. type: verbatim
12846 #: ../fish/guestfish-actions.pod:4211
12847 #, no-wrap
12848 msgid ""
12849 " set-e2uuid device uuid\n"
12850 "\n"
12851 msgstr ""
12852
12853 #. type: textblock
12854 #: ../fish/guestfish-actions.pod:4213 ../src/guestfs-actions.pod:6414
12855 msgid ""
12856 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
12857 "C<uuid>.  The format of the UUID and alternatives such as C<clear>, "
12858 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
12859 msgstr ""
12860
12861 #. type: textblock
12862 #: ../fish/guestfish-actions.pod:4218
12863 msgid ""
12864 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
12865 "UUID of a filesystem."
12866 msgstr ""
12867
12868 #. type: =head2
12869 #: ../fish/guestfish-actions.pod:4221
12870 msgid "set-memsize"
12871 msgstr ""
12872
12873 #. type: =head2
12874 #: ../fish/guestfish-actions.pod:4223
12875 msgid "memsize"
12876 msgstr ""
12877
12878 #. type: verbatim
12879 #: ../fish/guestfish-actions.pod:4225
12880 #, no-wrap
12881 msgid ""
12882 " set-memsize memsize\n"
12883 "\n"
12884 msgstr ""
12885
12886 #. type: textblock
12887 #: ../fish/guestfish-actions.pod:4227
12888 msgid ""
12889 "This sets the memory size in megabytes allocated to the qemu subprocess.  "
12890 "This only has any effect if called before L</launch>."
12891 msgstr ""
12892
12893 #. type: textblock
12894 #: ../fish/guestfish-actions.pod:4231 ../src/guestfs-actions.pod:6436
12895 msgid ""
12896 "You can also change this by setting the environment variable "
12897 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
12898 msgstr ""
12899
12900 #. type: =head2
12901 #: ../fish/guestfish-actions.pod:4238
12902 msgid "set-network"
12903 msgstr ""
12904
12905 #. type: =head2
12906 #: ../fish/guestfish-actions.pod:4240
12907 msgid "network"
12908 msgstr ""
12909
12910 #. type: verbatim
12911 #: ../fish/guestfish-actions.pod:4242
12912 #, no-wrap
12913 msgid ""
12914 " set-network true|false\n"
12915 "\n"
12916 msgstr ""
12917
12918 #. type: textblock
12919 #: ../fish/guestfish-actions.pod:4244 ../src/guestfs-actions.pod:6453
12920 msgid ""
12921 "If C<network> is true, then the network is enabled in the libguestfs "
12922 "appliance.  The default is false."
12923 msgstr ""
12924
12925 #. type: textblock
12926 #: ../fish/guestfish-actions.pod:4247 ../src/guestfs-actions.pod:6456
12927 msgid ""
12928 "This affects whether commands are able to access the network (see "
12929 "L<guestfs(3)/RUNNING COMMANDS>)."
12930 msgstr ""
12931
12932 #. type: textblock
12933 #: ../fish/guestfish-actions.pod:4250
12934 msgid "You must call this before calling L</launch>, otherwise it has no effect."
12935 msgstr ""
12936
12937 #. type: =head2
12938 #: ../fish/guestfish-actions.pod:4253
12939 msgid "set-path"
12940 msgstr ""
12941
12942 #. type: verbatim
12943 #: ../fish/guestfish-actions.pod:4257
12944 #, no-wrap
12945 msgid ""
12946 " set-path searchpath\n"
12947 "\n"
12948 msgstr ""
12949
12950 #. type: textblock
12951 #: ../fish/guestfish-actions.pod:4259 ../src/guestfs-actions.pod:6472
12952 msgid "Set the path that libguestfs searches for kernel and initrd.img."
12953 msgstr ""
12954
12955 #. type: textblock
12956 #: ../fish/guestfish-actions.pod:4261 ../src/guestfs-actions.pod:6474
12957 msgid ""
12958 "The default is C<$libdir/guestfs> unless overridden by setting "
12959 "C<LIBGUESTFS_PATH> environment variable."
12960 msgstr ""
12961
12962 #. type: textblock
12963 #: ../fish/guestfish-actions.pod:4264 ../src/guestfs-actions.pod:6477
12964 msgid "Setting C<path> to C<NULL> restores the default path."
12965 msgstr ""
12966
12967 #. type: =head2
12968 #: ../fish/guestfish-actions.pod:4266
12969 msgid "set-pgroup"
12970 msgstr ""
12971
12972 #. type: =head2
12973 #: ../fish/guestfish-actions.pod:4268
12974 msgid "pgroup"
12975 msgstr ""
12976
12977 #. type: verbatim
12978 #: ../fish/guestfish-actions.pod:4270
12979 #, no-wrap
12980 msgid ""
12981 " set-pgroup true|false\n"
12982 "\n"
12983 msgstr ""
12984
12985 #. type: textblock
12986 #: ../fish/guestfish-actions.pod:4272 ../src/guestfs-actions.pod:6489
12987 msgid ""
12988 "If C<pgroup> is true, child processes are placed into their own process "
12989 "group."
12990 msgstr ""
12991
12992 #. type: textblock
12993 #: ../fish/guestfish-actions.pod:4275 ../src/guestfs-actions.pod:6492
12994 msgid ""
12995 "The practical upshot of this is that signals like C<SIGINT> (from users "
12996 "pressing C<^C>) won't be received by the child process."
12997 msgstr ""
12998
12999 #. type: textblock
13000 #: ../fish/guestfish-actions.pod:4278 ../src/guestfs-actions.pod:6495
13001 msgid ""
13002 "The default for this flag is false, because usually you want C<^C> to kill "
13003 "the subprocess."
13004 msgstr ""
13005
13006 #. type: =head2
13007 #: ../fish/guestfish-actions.pod:4281
13008 msgid "set-qemu"
13009 msgstr ""
13010
13011 #. type: =head2
13012 #: ../fish/guestfish-actions.pod:4283
13013 msgid "qemu"
13014 msgstr ""
13015
13016 #. type: verbatim
13017 #: ../fish/guestfish-actions.pod:4285
13018 #, no-wrap
13019 msgid ""
13020 " set-qemu qemu\n"
13021 "\n"
13022 msgstr ""
13023
13024 #. type: textblock
13025 #: ../fish/guestfish-actions.pod:4287 ../src/guestfs-actions.pod:6508
13026 msgid "Set the qemu binary that we will use."
13027 msgstr ""
13028
13029 #. type: textblock
13030 #: ../fish/guestfish-actions.pod:4289 ../src/guestfs-actions.pod:6510
13031 msgid "The default is chosen when the library was compiled by the configure script."
13032 msgstr ""
13033
13034 #. type: textblock
13035 #: ../fish/guestfish-actions.pod:4292 ../src/guestfs-actions.pod:6513
13036 msgid ""
13037 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13038 "variable."
13039 msgstr ""
13040
13041 #. type: textblock
13042 #: ../fish/guestfish-actions.pod:4295 ../src/guestfs-actions.pod:6516
13043 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13044 msgstr ""
13045
13046 #. type: textblock
13047 #: ../fish/guestfish-actions.pod:4297 ../src/guestfs-actions.pod:6518
13048 msgid ""
13049 "Note that you should call this function as early as possible after creating "
13050 "the handle.  This is because some pre-launch operations depend on testing "
13051 "qemu features (by running C<qemu -help>).  If the qemu binary changes, we "
13052 "don't retest features, and so you might see inconsistent results.  Using the "
13053 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13054 "the qemu binary at the same time as the handle is created."
13055 msgstr ""
13056
13057 #. type: =head2
13058 #: ../fish/guestfish-actions.pod:4305
13059 msgid "set-recovery-proc"
13060 msgstr ""
13061
13062 #. type: =head2
13063 #: ../fish/guestfish-actions.pod:4307
13064 msgid "recovery-proc"
13065 msgstr ""
13066
13067 #. type: verbatim
13068 #: ../fish/guestfish-actions.pod:4309
13069 #, no-wrap
13070 msgid ""
13071 " set-recovery-proc true|false\n"
13072 "\n"
13073 msgstr ""
13074
13075 #. type: textblock
13076 #: ../fish/guestfish-actions.pod:4311
13077 msgid ""
13078 "If this is called with the parameter C<false> then L</launch> does not "
13079 "create a recovery process.  The purpose of the recovery process is to stop "
13080 "runaway qemu processes in the case where the main program aborts abruptly."
13081 msgstr ""
13082
13083 #. type: textblock
13084 #: ../fish/guestfish-actions.pod:4316
13085 msgid ""
13086 "This only has any effect if called before L</launch>, and the default is "
13087 "true."
13088 msgstr ""
13089
13090 #. type: textblock
13091 #: ../fish/guestfish-actions.pod:4319 ../src/guestfs-actions.pod:6544
13092 msgid ""
13093 "About the only time when you would want to disable this is if the main "
13094 "process will fork itself into the background (\"daemonize\" itself).  In "
13095 "this case the recovery process thinks that the main program has disappeared "
13096 "and so kills qemu, which is not very helpful."
13097 msgstr ""
13098
13099 #. type: =head2
13100 #: ../fish/guestfish-actions.pod:4325
13101 msgid "set-selinux"
13102 msgstr ""
13103
13104 #. type: =head2
13105 #: ../fish/guestfish-actions.pod:4327
13106 msgid "selinux"
13107 msgstr ""
13108
13109 #. type: verbatim
13110 #: ../fish/guestfish-actions.pod:4329
13111 #, no-wrap
13112 msgid ""
13113 " set-selinux true|false\n"
13114 "\n"
13115 msgstr ""
13116
13117 #. type: textblock
13118 #: ../fish/guestfish-actions.pod:4331 ../src/guestfs-actions.pod:6560
13119 msgid ""
13120 "This sets the selinux flag that is passed to the appliance at boot time.  "
13121 "The default is C<selinux=0> (disabled)."
13122 msgstr ""
13123
13124 #. type: textblock
13125 #: ../fish/guestfish-actions.pod:4334 ../src/guestfs-actions.pod:6563
13126 msgid ""
13127 "Note that if SELinux is enabled, it is always in Permissive mode "
13128 "(C<enforcing=0>)."
13129 msgstr ""
13130
13131 #. type: =head2
13132 #: ../fish/guestfish-actions.pod:4340
13133 msgid "set-smp"
13134 msgstr ""
13135
13136 #. type: =head2
13137 #: ../fish/guestfish-actions.pod:4342
13138 msgid "smp"
13139 msgstr ""
13140
13141 #. type: verbatim
13142 #: ../fish/guestfish-actions.pod:4344
13143 #, no-wrap
13144 msgid ""
13145 " set-smp smp\n"
13146 "\n"
13147 msgstr ""
13148
13149 #. type: textblock
13150 #: ../fish/guestfish-actions.pod:4346 ../src/guestfs-actions.pod:6579
13151 msgid ""
13152 "Change the number of virtual CPUs assigned to the appliance.  The default is "
13153 "C<1>.  Increasing this may improve performance, though often it has no "
13154 "effect."
13155 msgstr ""
13156
13157 #. type: textblock
13158 #: ../fish/guestfish-actions.pod:4350
13159 msgid "This function must be called before L</launch>."
13160 msgstr ""
13161
13162 #. type: =head2
13163 #: ../fish/guestfish-actions.pod:4352
13164 msgid "set-trace"
13165 msgstr ""
13166
13167 #. type: =head2
13168 #: ../fish/guestfish-actions.pod:4354
13169 msgid "trace"
13170 msgstr ""
13171
13172 #. type: verbatim
13173 #: ../fish/guestfish-actions.pod:4356
13174 #, no-wrap
13175 msgid ""
13176 " set-trace true|false\n"
13177 "\n"
13178 msgstr ""
13179
13180 #. type: textblock
13181 #: ../fish/guestfish-actions.pod:4358 ../src/guestfs-actions.pod:6593
13182 msgid ""
13183 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
13184 "return values are traced."
13185 msgstr ""
13186
13187 #. type: textblock
13188 #: ../fish/guestfish-actions.pod:4361 ../src/guestfs-actions.pod:6596
13189 msgid ""
13190 "If you want to trace C API calls into libguestfs (and other libraries) then "
13191 "possibly a better way is to use the external ltrace(1) command."
13192 msgstr ""
13193
13194 #. type: textblock
13195 #: ../fish/guestfish-actions.pod:4365 ../src/guestfs-actions.pod:6600
13196 msgid ""
13197 "Command traces are disabled unless the environment variable "
13198 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13199 msgstr ""
13200
13201 #. type: textblock
13202 #: ../fish/guestfish-actions.pod:4368
13203 msgid ""
13204 "Trace messages are normally sent to C<stderr>, unless you register a "
13205 "callback to send them somewhere else (see L</set-event-callback>)."
13206 msgstr ""
13207
13208 #. type: =head2
13209 #: ../fish/guestfish-actions.pod:4372
13210 msgid "set-verbose"
13211 msgstr ""
13212
13213 #. type: =head2
13214 #: ../fish/guestfish-actions.pod:4374
13215 msgid "verbose"
13216 msgstr ""
13217
13218 #. type: verbatim
13219 #: ../fish/guestfish-actions.pod:4376
13220 #, no-wrap
13221 msgid ""
13222 " set-verbose true|false\n"
13223 "\n"
13224 msgstr ""
13225
13226 #. type: textblock
13227 #: ../fish/guestfish-actions.pod:4378 ../src/guestfs-actions.pod:6617
13228 msgid "If C<verbose> is true, this turns on verbose messages."
13229 msgstr ""
13230
13231 #. type: textblock
13232 #: ../fish/guestfish-actions.pod:4380 ../src/guestfs-actions.pod:6619
13233 msgid ""
13234 "Verbose messages are disabled unless the environment variable "
13235 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13236 msgstr ""
13237
13238 #. type: textblock
13239 #: ../fish/guestfish-actions.pod:4383
13240 msgid ""
13241 "Verbose messages are normally sent to C<stderr>, unless you register a "
13242 "callback to send them somewhere else (see L</set-event-callback>)."
13243 msgstr ""
13244
13245 #. type: =head2
13246 #: ../fish/guestfish-actions.pod:4387
13247 msgid "setcon"
13248 msgstr ""
13249
13250 #. type: verbatim
13251 #: ../fish/guestfish-actions.pod:4389
13252 #, no-wrap
13253 msgid ""
13254 " setcon context\n"
13255 "\n"
13256 msgstr ""
13257
13258 #. type: textblock
13259 #: ../fish/guestfish-actions.pod:4391 ../src/guestfs-actions.pod:6636
13260 msgid ""
13261 "This sets the SELinux security context of the daemon to the string "
13262 "C<context>."
13263 msgstr ""
13264
13265 #. type: textblock
13266 #: ../fish/guestfish-actions.pod:4394 ../src/guestfs-actions.pod:6639
13267 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13268 msgstr ""
13269
13270 #. type: =head2
13271 #: ../fish/guestfish-actions.pod:4396
13272 msgid "setxattr"
13273 msgstr ""
13274
13275 #. type: verbatim
13276 #: ../fish/guestfish-actions.pod:4398
13277 #, no-wrap
13278 msgid ""
13279 " setxattr xattr val vallen path\n"
13280 "\n"
13281 msgstr ""
13282
13283 #. type: textblock
13284 #: ../fish/guestfish-actions.pod:4400 ../src/guestfs-actions.pod:6654
13285 msgid ""
13286 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13287 "the value C<val> (of length C<vallen>).  The value is arbitrary 8 bit data."
13288 msgstr ""
13289
13290 #. type: textblock
13291 #: ../fish/guestfish-actions.pod:4404
13292 msgid "See also: L</lsetxattr>, L<attr(5)>."
13293 msgstr ""
13294
13295 #. type: =head2
13296 #: ../fish/guestfish-actions.pod:4406
13297 msgid "sfdisk"
13298 msgstr ""
13299
13300 #. type: verbatim
13301 #: ../fish/guestfish-actions.pod:4408
13302 #, no-wrap
13303 msgid ""
13304 " sfdisk device cyls heads sectors 'lines ...'\n"
13305 "\n"
13306 msgstr ""
13307
13308 #. type: textblock
13309 #: ../fish/guestfish-actions.pod:4410 ../src/guestfs-actions.pod:6681
13310 msgid ""
13311 "This is a direct interface to the L<sfdisk(8)> program for creating "
13312 "partitions on block devices."
13313 msgstr ""
13314
13315 #. type: textblock
13316 #: ../fish/guestfish-actions.pod:4413 ../src/guestfs-actions.pod:6684
13317 msgid "C<device> should be a block device, for example C</dev/sda>."
13318 msgstr ""
13319
13320 #. type: textblock
13321 #: ../fish/guestfish-actions.pod:4415 ../src/guestfs-actions.pod:6686
13322 msgid ""
13323 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13324 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
13325 "I<-H> and I<-S> parameters.  If you pass C<0> for any of these, then the "
13326 "corresponding parameter is omitted.  Usually for 'large' disks, you can just "
13327 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13328 "the kernel) cannot work out the right geometry and you will need to tell it."
13329 msgstr ""
13330
13331 #. type: textblock
13332 #: ../fish/guestfish-actions.pod:4423 ../src/guestfs-actions.pod:6694
13333 msgid ""
13334 "C<lines> is a list of lines that we feed to C<sfdisk>.  For more information "
13335 "refer to the L<sfdisk(8)> manpage."
13336 msgstr ""
13337
13338 #. type: textblock
13339 #: ../fish/guestfish-actions.pod:4426 ../src/guestfs-actions.pod:6697
13340 msgid ""
13341 "To create a single partition occupying the whole disk, you would pass "
13342 "C<lines> as a single element list, when the single element being the string "
13343 "C<,> (comma)."
13344 msgstr ""
13345
13346 #. type: textblock
13347 #: ../fish/guestfish-actions.pod:4430
13348 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
13349 msgstr ""
13350
13351 #. type: textblock
13352 #: ../fish/guestfish-actions.pod:4436 ../fish/guestfish-actions.pod:4459 ../fish/guestfish-actions.pod:4481
13353 msgid ""
13354 "I<This function is deprecated.> In new code, use the L</part_add> call "
13355 "instead."
13356 msgstr ""
13357
13358 #. type: =head2
13359 #: ../fish/guestfish-actions.pod:4443
13360 msgid "sfdiskM"
13361 msgstr ""
13362
13363 #. type: verbatim
13364 #: ../fish/guestfish-actions.pod:4445
13365 #, no-wrap
13366 msgid ""
13367 " sfdiskM device 'lines ...'\n"
13368 "\n"
13369 msgstr ""
13370
13371 #. type: textblock
13372 #: ../fish/guestfish-actions.pod:4447
13373 msgid ""
13374 "This is a simplified interface to the L</sfdisk> command, where partition "
13375 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
13376 "you don't need to specify the cyls, heads and sectors parameters which were "
13377 "rarely if ever used anyway."
13378 msgstr ""
13379
13380 #. type: textblock
13381 #: ../fish/guestfish-actions.pod:4453
13382 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
13383 msgstr ""
13384
13385 #. type: =head2
13386 #: ../fish/guestfish-actions.pod:4466
13387 msgid "sfdisk-N"
13388 msgstr ""
13389
13390 #. type: verbatim
13391 #: ../fish/guestfish-actions.pod:4468
13392 #, no-wrap
13393 msgid ""
13394 " sfdisk-N device partnum cyls heads sectors line\n"
13395 "\n"
13396 msgstr ""
13397
13398 #. type: textblock
13399 #: ../fish/guestfish-actions.pod:4470 ../src/guestfs-actions.pod:6759
13400 msgid ""
13401 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13402 "(note: C<n> counts from 1)."
13403 msgstr ""
13404
13405 #. type: textblock
13406 #: ../fish/guestfish-actions.pod:4473
13407 msgid ""
13408 "For other parameters, see L</sfdisk>.  You should usually pass C<0> for the "
13409 "cyls/heads/sectors parameters."
13410 msgstr ""
13411
13412 #. type: textblock
13413 #: ../fish/guestfish-actions.pod:4476
13414 msgid "See also: L</part-add>"
13415 msgstr ""
13416
13417 #. type: =head2
13418 #: ../fish/guestfish-actions.pod:4488
13419 msgid "sfdisk-disk-geometry"
13420 msgstr ""
13421
13422 #. type: verbatim
13423 #: ../fish/guestfish-actions.pod:4490
13424 #, no-wrap
13425 msgid ""
13426 " sfdisk-disk-geometry device\n"
13427 "\n"
13428 msgstr ""
13429
13430 #. type: textblock
13431 #: ../fish/guestfish-actions.pod:4492
13432 msgid ""
13433 "This displays the disk geometry of C<device> read from the partition table.  "
13434 "Especially in the case where the underlying block device has been resized, "
13435 "this can be different from the kernel's idea of the geometry (see "
13436 "L</sfdisk-kernel-geometry>)."
13437 msgstr ""
13438
13439 #. type: textblock
13440 #: ../fish/guestfish-actions.pod:4497 ../fish/guestfish-actions.pod:4506 ../src/guestfs-actions.pod:6785 ../src/guestfs-actions.pod:6801
13441 msgid "The result is in human-readable format, and not designed to be parsed."
13442 msgstr ""
13443
13444 #. type: =head2
13445 #: ../fish/guestfish-actions.pod:4500
13446 msgid "sfdisk-kernel-geometry"
13447 msgstr ""
13448
13449 #. type: verbatim
13450 #: ../fish/guestfish-actions.pod:4502
13451 #, no-wrap
13452 msgid ""
13453 " sfdisk-kernel-geometry device\n"
13454 "\n"
13455 msgstr ""
13456
13457 #. type: textblock
13458 #: ../fish/guestfish-actions.pod:4504 ../src/guestfs-actions.pod:6799
13459 msgid "This displays the kernel's idea of the geometry of C<device>."
13460 msgstr ""
13461
13462 #. type: =head2
13463 #: ../fish/guestfish-actions.pod:4509
13464 msgid "sfdisk-l"
13465 msgstr ""
13466
13467 #. type: verbatim
13468 #: ../fish/guestfish-actions.pod:4511
13469 #, no-wrap
13470 msgid ""
13471 " sfdisk-l device\n"
13472 "\n"
13473 msgstr ""
13474
13475 #. type: textblock
13476 #: ../fish/guestfish-actions.pod:4513 ../src/guestfs-actions.pod:6822
13477 msgid ""
13478 "This displays the partition table on C<device>, in the human-readable output "
13479 "of the L<sfdisk(8)> command.  It is not intended to be parsed."
13480 msgstr ""
13481
13482 #. type: textblock
13483 #: ../fish/guestfish-actions.pod:4517
13484 msgid "See also: L</part-list>"
13485 msgstr ""
13486
13487 #. type: textblock
13488 #: ../fish/guestfish-actions.pod:4519
13489 msgid ""
13490 "I<This function is deprecated.> In new code, use the L</part_list> call "
13491 "instead."
13492 msgstr ""
13493
13494 #. type: =head2
13495 #: ../fish/guestfish-actions.pod:4526
13496 msgid "sh"
13497 msgstr ""
13498
13499 #. type: verbatim
13500 #: ../fish/guestfish-actions.pod:4528
13501 #, no-wrap
13502 msgid ""
13503 " sh command\n"
13504 "\n"
13505 msgstr ""
13506
13507 #. type: textblock
13508 #: ../fish/guestfish-actions.pod:4530 ../src/guestfs-actions.pod:6839
13509 msgid ""
13510 "This call runs a command from the guest filesystem via the guest's "
13511 "C</bin/sh>."
13512 msgstr ""
13513
13514 #. type: textblock
13515 #: ../fish/guestfish-actions.pod:4533
13516 msgid "This is like L</command>, but passes the command to:"
13517 msgstr ""
13518
13519 #. type: verbatim
13520 #: ../fish/guestfish-actions.pod:4535 ../src/guestfs-actions.pod:6844
13521 #, no-wrap
13522 msgid ""
13523 " /bin/sh -c \"command\"\n"
13524 "\n"
13525 msgstr ""
13526
13527 #. type: textblock
13528 #: ../fish/guestfish-actions.pod:4537 ../src/guestfs-actions.pod:6846
13529 msgid ""
13530 "Depending on the guest's shell, this usually results in wildcards being "
13531 "expanded, shell expressions being interpolated and so on."
13532 msgstr ""
13533
13534 #. type: textblock
13535 #: ../fish/guestfish-actions.pod:4541
13536 msgid "All the provisos about L</command> apply to this call."
13537 msgstr ""
13538
13539 #. type: =head2
13540 #: ../fish/guestfish-actions.pod:4543
13541 msgid "sh-lines"
13542 msgstr ""
13543
13544 #. type: verbatim
13545 #: ../fish/guestfish-actions.pod:4545
13546 #, no-wrap
13547 msgid ""
13548 " sh-lines command\n"
13549 "\n"
13550 msgstr ""
13551
13552 #. type: textblock
13553 #: ../fish/guestfish-actions.pod:4547
13554 msgid "This is the same as L</sh>, but splits the result into a list of lines."
13555 msgstr ""
13556
13557 #. type: textblock
13558 #: ../fish/guestfish-actions.pod:4550
13559 msgid "See also: L</command-lines>"
13560 msgstr ""
13561
13562 #. type: =head2
13563 #: ../fish/guestfish-actions.pod:4552
13564 msgid "sleep"
13565 msgstr ""
13566
13567 #. type: verbatim
13568 #: ../fish/guestfish-actions.pod:4554
13569 #, no-wrap
13570 msgid ""
13571 " sleep secs\n"
13572 "\n"
13573 msgstr ""
13574
13575 #. type: textblock
13576 #: ../fish/guestfish-actions.pod:4556 ../src/guestfs-actions.pod:6880
13577 msgid "Sleep for C<secs> seconds."
13578 msgstr ""
13579
13580 #. type: =head2
13581 #: ../fish/guestfish-actions.pod:4558
13582 msgid "stat"
13583 msgstr ""
13584
13585 #. type: verbatim
13586 #: ../fish/guestfish-actions.pod:4560
13587 #, no-wrap
13588 msgid ""
13589 " stat path\n"
13590 "\n"
13591 msgstr ""
13592
13593 #. type: textblock
13594 #: ../fish/guestfish-actions.pod:4564 ../src/guestfs-actions.pod:6894
13595 msgid "This is the same as the C<stat(2)> system call."
13596 msgstr ""
13597
13598 #. type: =head2
13599 #: ../fish/guestfish-actions.pod:4566
13600 msgid "statvfs"
13601 msgstr ""
13602
13603 #. type: verbatim
13604 #: ../fish/guestfish-actions.pod:4568
13605 #, no-wrap
13606 msgid ""
13607 " statvfs path\n"
13608 "\n"
13609 msgstr ""
13610
13611 #. type: textblock
13612 #: ../fish/guestfish-actions.pod:4570 ../src/guestfs-actions.pod:6908
13613 msgid ""
13614 "Returns file system statistics for any mounted file system.  C<path> should "
13615 "be a file or directory in the mounted file system (typically it is the mount "
13616 "point itself, but it doesn't need to be)."
13617 msgstr ""
13618
13619 #. type: textblock
13620 #: ../fish/guestfish-actions.pod:4574 ../src/guestfs-actions.pod:6912
13621 msgid "This is the same as the C<statvfs(2)> system call."
13622 msgstr ""
13623
13624 #. type: =head2
13625 #: ../fish/guestfish-actions.pod:4576
13626 msgid "strings"
13627 msgstr ""
13628
13629 #. type: verbatim
13630 #: ../fish/guestfish-actions.pod:4578
13631 #, no-wrap
13632 msgid ""
13633 " strings path\n"
13634 "\n"
13635 msgstr ""
13636
13637 #. type: textblock
13638 #: ../fish/guestfish-actions.pod:4580 ../src/guestfs-actions.pod:6926
13639 msgid ""
13640 "This runs the L<strings(1)> command on a file and returns the list of "
13641 "printable strings found."
13642 msgstr ""
13643
13644 #. type: =head2
13645 #: ../fish/guestfish-actions.pod:4586
13646 msgid "strings-e"
13647 msgstr ""
13648
13649 #. type: verbatim
13650 #: ../fish/guestfish-actions.pod:4588
13651 #, no-wrap
13652 msgid ""
13653 " strings-e encoding path\n"
13654 "\n"
13655 msgstr ""
13656
13657 #. type: textblock
13658 #: ../fish/guestfish-actions.pod:4590
13659 msgid ""
13660 "This is like the L</strings> command, but allows you to specify the encoding "
13661 "of strings that are looked for in the source file C<path>."
13662 msgstr ""
13663
13664 #. type: textblock
13665 #: ../fish/guestfish-actions.pod:4594 ../src/guestfs-actions.pod:6949
13666 msgid "Allowed encodings are:"
13667 msgstr ""
13668
13669 #. type: =item
13670 #: ../fish/guestfish-actions.pod:4598 ../src/guestfs-actions.pod:6953
13671 msgid "s"
13672 msgstr ""
13673
13674 #. type: textblock
13675 #: ../fish/guestfish-actions.pod:4600
13676 msgid ""
13677 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13678 "ISO-8859-X (this is what L</strings> uses)."
13679 msgstr ""
13680
13681 #. type: =item
13682 #: ../fish/guestfish-actions.pod:4603 ../src/guestfs-actions.pod:6958
13683 msgid "S"
13684 msgstr ""
13685
13686 #. type: textblock
13687 #: ../fish/guestfish-actions.pod:4605 ../src/guestfs-actions.pod:6960
13688 msgid "Single 8-bit-byte characters."
13689 msgstr ""
13690
13691 #. type: =item
13692 #: ../fish/guestfish-actions.pod:4607 ../src/guestfs-actions.pod:6962
13693 msgid "b"
13694 msgstr ""
13695
13696 #. type: textblock
13697 #: ../fish/guestfish-actions.pod:4609 ../src/guestfs-actions.pod:6964
13698 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13699 msgstr ""
13700
13701 #. type: =item
13702 #: ../fish/guestfish-actions.pod:4612 ../src/guestfs-actions.pod:6967
13703 msgid "l (lower case letter L)"
13704 msgstr ""
13705
13706 #. type: textblock
13707 #: ../fish/guestfish-actions.pod:4614 ../src/guestfs-actions.pod:6969
13708 msgid ""
13709 "16-bit little endian such as UTF-16LE and UCS-2LE.  This is useful for "
13710 "examining binaries in Windows guests."
13711 msgstr ""
13712
13713 #. type: =item
13714 #: ../fish/guestfish-actions.pod:4617 ../src/guestfs-actions.pod:6972
13715 msgid "B"
13716 msgstr ""
13717
13718 #. type: textblock
13719 #: ../fish/guestfish-actions.pod:4619 ../src/guestfs-actions.pod:6974
13720 msgid "32-bit big endian such as UCS-4BE."
13721 msgstr ""
13722
13723 #. type: =item
13724 #: ../fish/guestfish-actions.pod:4621 ../src/guestfs-actions.pod:6976
13725 msgid "L"
13726 msgstr ""
13727
13728 #. type: textblock
13729 #: ../fish/guestfish-actions.pod:4623 ../src/guestfs-actions.pod:6978
13730 msgid "32-bit little endian such as UCS-4LE."
13731 msgstr ""
13732
13733 #. type: textblock
13734 #: ../fish/guestfish-actions.pod:4627 ../src/guestfs-actions.pod:6982
13735 msgid "The returned strings are transcoded to UTF-8."
13736 msgstr ""
13737
13738 #. type: =head2
13739 #: ../fish/guestfish-actions.pod:4632
13740 msgid "swapoff-device"
13741 msgstr ""
13742
13743 #. type: verbatim
13744 #: ../fish/guestfish-actions.pod:4634
13745 #, no-wrap
13746 msgid ""
13747 " swapoff-device device\n"
13748 "\n"
13749 msgstr ""
13750
13751 #. type: textblock
13752 #: ../fish/guestfish-actions.pod:4636
13753 msgid ""
13754 "This command disables the libguestfs appliance swap device or partition "
13755 "named C<device>.  See L</swapon-device>."
13756 msgstr ""
13757
13758 #. type: =head2
13759 #: ../fish/guestfish-actions.pod:4640
13760 msgid "swapoff-file"
13761 msgstr ""
13762
13763 #. type: verbatim
13764 #: ../fish/guestfish-actions.pod:4642
13765 #, no-wrap
13766 msgid ""
13767 " swapoff-file file\n"
13768 "\n"
13769 msgstr ""
13770
13771 #. type: textblock
13772 #: ../fish/guestfish-actions.pod:4644 ../src/guestfs-actions.pod:7013
13773 msgid "This command disables the libguestfs appliance swap on file."
13774 msgstr ""
13775
13776 #. type: =head2
13777 #: ../fish/guestfish-actions.pod:4646
13778 msgid "swapoff-label"
13779 msgstr ""
13780
13781 #. type: verbatim
13782 #: ../fish/guestfish-actions.pod:4648
13783 #, no-wrap
13784 msgid ""
13785 " swapoff-label label\n"
13786 "\n"
13787 msgstr ""
13788
13789 #. type: textblock
13790 #: ../fish/guestfish-actions.pod:4650 ../src/guestfs-actions.pod:7025
13791 msgid ""
13792 "This command disables the libguestfs appliance swap on labeled swap "
13793 "partition."
13794 msgstr ""
13795
13796 #. type: =head2
13797 #: ../fish/guestfish-actions.pod:4653
13798 msgid "swapoff-uuid"
13799 msgstr ""
13800
13801 #. type: verbatim
13802 #: ../fish/guestfish-actions.pod:4655
13803 #, no-wrap
13804 msgid ""
13805 " swapoff-uuid uuid\n"
13806 "\n"
13807 msgstr ""
13808
13809 #. type: textblock
13810 #: ../fish/guestfish-actions.pod:4657 ../src/guestfs-actions.pod:7038
13811 msgid ""
13812 "This command disables the libguestfs appliance swap partition with the given "
13813 "UUID."
13814 msgstr ""
13815
13816 #. type: =head2
13817 #: ../fish/guestfish-actions.pod:4660
13818 msgid "swapon-device"
13819 msgstr ""
13820
13821 #. type: verbatim
13822 #: ../fish/guestfish-actions.pod:4662
13823 #, no-wrap
13824 msgid ""
13825 " swapon-device device\n"
13826 "\n"
13827 msgstr ""
13828
13829 #. type: textblock
13830 #: ../fish/guestfish-actions.pod:4664
13831 msgid ""
13832 "This command enables the libguestfs appliance to use the swap device or "
13833 "partition named C<device>.  The increased memory is made available for all "
13834 "commands, for example those run using L</command> or L</sh>."
13835 msgstr ""
13836
13837 #. type: textblock
13838 #: ../fish/guestfish-actions.pod:4669 ../src/guestfs-actions.pod:7056
13839 msgid ""
13840 "Note that you should not swap to existing guest swap partitions unless you "
13841 "know what you are doing.  They may contain hibernation information, or other "
13842 "information that the guest doesn't want you to trash.  You also risk leaking "
13843 "information about the host to the guest this way.  Instead, attach a new "
13844 "host device to the guest and swap on that."
13845 msgstr ""
13846
13847 #. type: =head2
13848 #: ../fish/guestfish-actions.pod:4676
13849 msgid "swapon-file"
13850 msgstr ""
13851
13852 #. type: verbatim
13853 #: ../fish/guestfish-actions.pod:4678
13854 #, no-wrap
13855 msgid ""
13856 " swapon-file file\n"
13857 "\n"
13858 msgstr ""
13859
13860 #. type: textblock
13861 #: ../fish/guestfish-actions.pod:4680
13862 msgid "This command enables swap to a file.  See L</swapon-device> for other notes."
13863 msgstr ""
13864
13865 #. type: =head2
13866 #: ../fish/guestfish-actions.pod:4683
13867 msgid "swapon-label"
13868 msgstr ""
13869
13870 #. type: verbatim
13871 #: ../fish/guestfish-actions.pod:4685
13872 #, no-wrap
13873 msgid ""
13874 " swapon-label label\n"
13875 "\n"
13876 msgstr ""
13877
13878 #. type: textblock
13879 #: ../fish/guestfish-actions.pod:4687
13880 msgid ""
13881 "This command enables swap to a labeled swap partition.  See "
13882 "L</swapon-device> for other notes."
13883 msgstr ""
13884
13885 #. type: =head2
13886 #: ../fish/guestfish-actions.pod:4690
13887 msgid "swapon-uuid"
13888 msgstr ""
13889
13890 #. type: verbatim
13891 #: ../fish/guestfish-actions.pod:4692
13892 #, no-wrap
13893 msgid ""
13894 " swapon-uuid uuid\n"
13895 "\n"
13896 msgstr ""
13897
13898 #. type: textblock
13899 #: ../fish/guestfish-actions.pod:4694
13900 msgid ""
13901 "This command enables swap to a swap partition with the given UUID.  See "
13902 "L</swapon-device> for other notes."
13903 msgstr ""
13904
13905 #. type: =head2
13906 #: ../fish/guestfish-actions.pod:4697
13907 msgid "sync"
13908 msgstr ""
13909
13910 #. type: verbatim
13911 #: ../fish/guestfish-actions.pod:4699
13912 #, no-wrap
13913 msgid ""
13914 " sync\n"
13915 "\n"
13916 msgstr ""
13917
13918 #. type: textblock
13919 #: ../fish/guestfish-actions.pod:4701 ../src/guestfs-actions.pod:7111
13920 msgid ""
13921 "This syncs the disk, so that any writes are flushed through to the "
13922 "underlying disk image."
13923 msgstr ""
13924
13925 #. type: textblock
13926 #: ../fish/guestfish-actions.pod:4704 ../src/guestfs-actions.pod:7114
13927 msgid ""
13928 "You should always call this if you have modified a disk image, before "
13929 "closing the handle."
13930 msgstr ""
13931
13932 #. type: =head2
13933 #: ../fish/guestfish-actions.pod:4707
13934 msgid "tail"
13935 msgstr ""
13936
13937 #. type: verbatim
13938 #: ../fish/guestfish-actions.pod:4709
13939 #, no-wrap
13940 msgid ""
13941 " tail path\n"
13942 "\n"
13943 msgstr ""
13944
13945 #. type: textblock
13946 #: ../fish/guestfish-actions.pod:4711 ../src/guestfs-actions.pod:7127
13947 msgid "This command returns up to the last 10 lines of a file as a list of strings."
13948 msgstr ""
13949
13950 #. type: =head2
13951 #: ../fish/guestfish-actions.pod:4717
13952 msgid "tail-n"
13953 msgstr ""
13954
13955 #. type: verbatim
13956 #: ../fish/guestfish-actions.pod:4719
13957 #, no-wrap
13958 msgid ""
13959 " tail-n nrlines path\n"
13960 "\n"
13961 msgstr ""
13962
13963 #. type: textblock
13964 #: ../fish/guestfish-actions.pod:4721 ../src/guestfs-actions.pod:7146
13965 msgid ""
13966 "If the parameter C<nrlines> is a positive number, this returns the last "
13967 "C<nrlines> lines of the file C<path>."
13968 msgstr ""
13969
13970 #. type: textblock
13971 #: ../fish/guestfish-actions.pod:4724 ../src/guestfs-actions.pod:7149
13972 msgid ""
13973 "If the parameter C<nrlines> is a negative number, this returns lines from "
13974 "the file C<path>, starting with the C<-nrlines>th line."
13975 msgstr ""
13976
13977 #. type: =head2
13978 #: ../fish/guestfish-actions.pod:4732
13979 msgid "tar-in"
13980 msgstr ""
13981
13982 #. type: verbatim
13983 #: ../fish/guestfish-actions.pod:4734
13984 #, no-wrap
13985 msgid ""
13986 " tar-in (tarfile|-) directory\n"
13987 "\n"
13988 msgstr ""
13989
13990 #. type: textblock
13991 #: ../fish/guestfish-actions.pod:4736 ../src/guestfs-actions.pod:7170
13992 msgid ""
13993 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
13994 "tar file) into C<directory>."
13995 msgstr ""
13996
13997 #. type: textblock
13998 #: ../fish/guestfish-actions.pod:4739
13999 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
14000 msgstr ""
14001
14002 #. type: =head2
14003 #: ../fish/guestfish-actions.pod:4744
14004 msgid "tar-out"
14005 msgstr ""
14006
14007 #. type: verbatim
14008 #: ../fish/guestfish-actions.pod:4746
14009 #, no-wrap
14010 msgid ""
14011 " tar-out directory (tarfile|-)\n"
14012 "\n"
14013 msgstr ""
14014
14015 #. type: textblock
14016 #: ../fish/guestfish-actions.pod:4748 ../src/guestfs-actions.pod:7187
14017 msgid ""
14018 "This command packs the contents of C<directory> and downloads it to local "
14019 "file C<tarfile>."
14020 msgstr ""
14021
14022 #. type: textblock
14023 #: ../fish/guestfish-actions.pod:4751
14024 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
14025 msgstr ""
14026
14027 #. type: =head2
14028 #: ../fish/guestfish-actions.pod:4756
14029 msgid "tgz-in"
14030 msgstr ""
14031
14032 #. type: verbatim
14033 #: ../fish/guestfish-actions.pod:4758
14034 #, no-wrap
14035 msgid ""
14036 " tgz-in (tarball|-) directory\n"
14037 "\n"
14038 msgstr ""
14039
14040 #. type: textblock
14041 #: ../fish/guestfish-actions.pod:4760 ../src/guestfs-actions.pod:7204
14042 msgid ""
14043 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14044 "tar file) into C<directory>."
14045 msgstr ""
14046
14047 #. type: textblock
14048 #: ../fish/guestfish-actions.pod:4763
14049 msgid "To upload an uncompressed tarball, use L</tar-in>."
14050 msgstr ""
14051
14052 #. type: =head2
14053 #: ../fish/guestfish-actions.pod:4767
14054 msgid "tgz-out"
14055 msgstr ""
14056
14057 #. type: verbatim
14058 #: ../fish/guestfish-actions.pod:4769
14059 #, no-wrap
14060 msgid ""
14061 " tgz-out directory (tarball|-)\n"
14062 "\n"
14063 msgstr ""
14064
14065 #. type: textblock
14066 #: ../fish/guestfish-actions.pod:4771 ../src/guestfs-actions.pod:7220
14067 msgid ""
14068 "This command packs the contents of C<directory> and downloads it to local "
14069 "file C<tarball>."
14070 msgstr ""
14071
14072 #. type: textblock
14073 #: ../fish/guestfish-actions.pod:4774
14074 msgid "To download an uncompressed tarball, use L</tar-out>."
14075 msgstr ""
14076
14077 #. type: =head2
14078 #: ../fish/guestfish-actions.pod:4778
14079 msgid "touch"
14080 msgstr ""
14081
14082 #. type: verbatim
14083 #: ../fish/guestfish-actions.pod:4780
14084 #, no-wrap
14085 msgid ""
14086 " touch path\n"
14087 "\n"
14088 msgstr ""
14089
14090 #. type: textblock
14091 #: ../fish/guestfish-actions.pod:4782 ../src/guestfs-actions.pod:7235
14092 msgid ""
14093 "Touch acts like the L<touch(1)> command.  It can be used to update the "
14094 "timestamps on a file, or, if the file does not exist, to create a new "
14095 "zero-length file."
14096 msgstr ""
14097
14098 #. type: textblock
14099 #: ../fish/guestfish-actions.pod:4786 ../src/guestfs-actions.pod:7239
14100 msgid ""
14101 "This command only works on regular files, and will fail on other file types "
14102 "such as directories, symbolic links, block special etc."
14103 msgstr ""
14104
14105 #. type: =head2
14106 #: ../fish/guestfish-actions.pod:4789
14107 msgid "truncate"
14108 msgstr ""
14109
14110 #. type: verbatim
14111 #: ../fish/guestfish-actions.pod:4791
14112 #, no-wrap
14113 msgid ""
14114 " truncate path\n"
14115 "\n"
14116 msgstr ""
14117
14118 #. type: textblock
14119 #: ../fish/guestfish-actions.pod:4793 ../src/guestfs-actions.pod:7252
14120 msgid ""
14121 "This command truncates C<path> to a zero-length file.  The file must exist "
14122 "already."
14123 msgstr ""
14124
14125 #. type: =head2
14126 #: ../fish/guestfish-actions.pod:4796
14127 msgid "truncate-size"
14128 msgstr ""
14129
14130 #. type: verbatim
14131 #: ../fish/guestfish-actions.pod:4798
14132 #, no-wrap
14133 msgid ""
14134 " truncate-size path size\n"
14135 "\n"
14136 msgstr ""
14137
14138 #. type: textblock
14139 #: ../fish/guestfish-actions.pod:4800 ../src/guestfs-actions.pod:7266
14140 msgid ""
14141 "This command truncates C<path> to size C<size> bytes.  The file must exist "
14142 "already."
14143 msgstr ""
14144
14145 #. type: textblock
14146 #: ../fish/guestfish-actions.pod:4803
14147 msgid ""
14148 "If the current file size is less than C<size> then the file is extended to "
14149 "the required size with zero bytes.  This creates a sparse file (ie. disk "
14150 "blocks are not allocated for the file until you write to it).  To create a "
14151 "non-sparse file of zeroes, use L</fallocate64> instead."
14152 msgstr ""
14153
14154 #. type: =head2
14155 #: ../fish/guestfish-actions.pod:4809
14156 msgid "tune2fs-l"
14157 msgstr ""
14158
14159 #. type: verbatim
14160 #: ../fish/guestfish-actions.pod:4811
14161 #, no-wrap
14162 msgid ""
14163 " tune2fs-l device\n"
14164 "\n"
14165 msgstr ""
14166
14167 #. type: textblock
14168 #: ../fish/guestfish-actions.pod:4813 ../src/guestfs-actions.pod:7285
14169 msgid ""
14170 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14171 "C<device>."
14172 msgstr ""
14173
14174 #. type: textblock
14175 #: ../fish/guestfish-actions.pod:4816 ../src/guestfs-actions.pod:7288
14176 msgid ""
14177 "It is the same as running C<tune2fs -l device>.  See L<tune2fs(8)> manpage "
14178 "for more details.  The list of fields returned isn't clearly defined, and "
14179 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14180 "and the filesystem itself."
14181 msgstr ""
14182
14183 #. type: =head2
14184 #: ../fish/guestfish-actions.pod:4821
14185 msgid "txz-in"
14186 msgstr ""
14187
14188 #. type: verbatim
14189 #: ../fish/guestfish-actions.pod:4823
14190 #, no-wrap
14191 msgid ""
14192 " txz-in (tarball|-) directory\n"
14193 "\n"
14194 msgstr ""
14195
14196 #. type: textblock
14197 #: ../fish/guestfish-actions.pod:4825 ../src/guestfs-actions.pod:7308
14198 msgid ""
14199 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14200 "tar file) into C<directory>."
14201 msgstr ""
14202
14203 #. type: =head2
14204 #: ../fish/guestfish-actions.pod:4830
14205 msgid "txz-out"
14206 msgstr ""
14207
14208 #. type: verbatim
14209 #: ../fish/guestfish-actions.pod:4832
14210 #, no-wrap
14211 msgid ""
14212 " txz-out directory (tarball|-)\n"
14213 "\n"
14214 msgstr ""
14215
14216 #. type: textblock
14217 #: ../fish/guestfish-actions.pod:4834 ../src/guestfs-actions.pod:7322
14218 msgid ""
14219 "This command packs the contents of C<directory> and downloads it to local "
14220 "file C<tarball> (as an xz compressed tar archive)."
14221 msgstr ""
14222
14223 #. type: =head2
14224 #: ../fish/guestfish-actions.pod:4839
14225 msgid "umask"
14226 msgstr ""
14227
14228 #. type: verbatim
14229 #: ../fish/guestfish-actions.pod:4841
14230 #, no-wrap
14231 msgid ""
14232 " umask mask\n"
14233 "\n"
14234 msgstr ""
14235
14236 #. type: textblock
14237 #: ../fish/guestfish-actions.pod:4843 ../src/guestfs-actions.pod:7335
14238 msgid ""
14239 "This function sets the mask used for creating new files and device nodes to "
14240 "C<mask & 0777>."
14241 msgstr ""
14242
14243 #. type: textblock
14244 #: ../fish/guestfish-actions.pod:4846 ../src/guestfs-actions.pod:7338
14245 msgid ""
14246 "Typical umask values would be C<022> which creates new files with "
14247 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14248 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14249 msgstr ""
14250
14251 #. type: textblock
14252 #: ../fish/guestfish-actions.pod:4851 ../src/guestfs-actions.pod:7343
14253 msgid ""
14254 "The default umask is C<022>.  This is important because it means that "
14255 "directories and device nodes will be created with C<0644> or C<0755> mode "
14256 "even if you specify C<0777>."
14257 msgstr ""
14258
14259 #. type: textblock
14260 #: ../fish/guestfish-actions.pod:4855
14261 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
14262 msgstr ""
14263
14264 #. type: textblock
14265 #: ../fish/guestfish-actions.pod:4858 ../src/guestfs-actions.pod:7350
14266 msgid "This call returns the previous umask."
14267 msgstr ""
14268
14269 #. type: =head2
14270 #: ../fish/guestfish-actions.pod:4860
14271 msgid "umount"
14272 msgstr ""
14273
14274 #. type: =head2
14275 #: ../fish/guestfish-actions.pod:4862
14276 msgid "unmount"
14277 msgstr ""
14278
14279 #. type: verbatim
14280 #: ../fish/guestfish-actions.pod:4864
14281 #, no-wrap
14282 msgid ""
14283 " umount pathordevice\n"
14284 "\n"
14285 msgstr ""
14286
14287 #. type: textblock
14288 #: ../fish/guestfish-actions.pod:4866 ../src/guestfs-actions.pod:7362
14289 msgid ""
14290 "This unmounts the given filesystem.  The filesystem may be specified either "
14291 "by its mountpoint (path) or the device which contains the filesystem."
14292 msgstr ""
14293
14294 #. type: =head2
14295 #: ../fish/guestfish-actions.pod:4870
14296 msgid "umount-all"
14297 msgstr ""
14298
14299 #. type: =head2
14300 #: ../fish/guestfish-actions.pod:4872
14301 msgid "unmount-all"
14302 msgstr ""
14303
14304 #. type: verbatim
14305 #: ../fish/guestfish-actions.pod:4874
14306 #, no-wrap
14307 msgid ""
14308 " umount-all\n"
14309 "\n"
14310 msgstr ""
14311
14312 #. type: textblock
14313 #: ../fish/guestfish-actions.pod:4876 ../src/guestfs-actions.pod:7375
14314 msgid "This unmounts all mounted filesystems."
14315 msgstr ""
14316
14317 #. type: textblock
14318 #: ../fish/guestfish-actions.pod:4878 ../src/guestfs-actions.pod:7377
14319 msgid "Some internal mounts are not unmounted by this call."
14320 msgstr ""
14321
14322 #. type: =head2
14323 #: ../fish/guestfish-actions.pod:4880
14324 msgid "upload"
14325 msgstr ""
14326
14327 #. type: verbatim
14328 #: ../fish/guestfish-actions.pod:4882
14329 #, no-wrap
14330 msgid ""
14331 " upload (filename|-) remotefilename\n"
14332 "\n"
14333 msgstr ""
14334
14335 #. type: textblock
14336 #: ../fish/guestfish-actions.pod:4884 ../fish/guestfish-actions.pod:4897 ../src/guestfs-actions.pod:7390 ../src/guestfs-actions.pod:7414
14337 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14338 msgstr ""
14339
14340 #. type: textblock
14341 #: ../fish/guestfish-actions.pod:4889
14342 msgid "See also L</download>."
14343 msgstr ""
14344
14345 #. type: =head2
14346 #: ../fish/guestfish-actions.pod:4893
14347 msgid "upload-offset"
14348 msgstr ""
14349
14350 #. type: verbatim
14351 #: ../fish/guestfish-actions.pod:4895
14352 #, no-wrap
14353 msgid ""
14354 " upload-offset (filename|-) remotefilename offset\n"
14355 "\n"
14356 msgstr ""
14357
14358 #. type: textblock
14359 #: ../fish/guestfish-actions.pod:4900 ../src/guestfs-actions.pod:7417
14360 msgid ""
14361 "C<remotefilename> is overwritten starting at the byte C<offset> specified.  "
14362 "The intention is to overwrite parts of existing files or devices, although "
14363 "if a non-existant file is specified then it is created with a \"hole\" "
14364 "before C<offset>.  The size of the data written is implicit in the size of "
14365 "the source C<filename>."
14366 msgstr ""
14367
14368 #. type: textblock
14369 #: ../fish/guestfish-actions.pod:4907
14370 msgid ""
14371 "Note that there is no limit on the amount of data that can be uploaded with "
14372 "this call, unlike with L</pwrite>, and this call always writes the full "
14373 "amount unless an error occurs."
14374 msgstr ""
14375
14376 #. type: textblock
14377 #: ../fish/guestfish-actions.pod:4912
14378 msgid "See also L</upload>, L</pwrite>."
14379 msgstr ""
14380
14381 #. type: =head2
14382 #: ../fish/guestfish-actions.pod:4916
14383 msgid "utimens"
14384 msgstr ""
14385
14386 #. type: verbatim
14387 #: ../fish/guestfish-actions.pod:4918
14388 #, no-wrap
14389 msgid ""
14390 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
14391 "\n"
14392 msgstr ""
14393
14394 #. type: textblock
14395 #: ../fish/guestfish-actions.pod:4920 ../src/guestfs-actions.pod:7450
14396 msgid "This command sets the timestamps of a file with nanosecond precision."
14397 msgstr ""
14398
14399 #. type: textblock
14400 #: ../fish/guestfish-actions.pod:4923 ../src/guestfs-actions.pod:7453
14401 msgid ""
14402 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14403 "from the epoch."
14404 msgstr ""
14405
14406 #. type: textblock
14407 #: ../fish/guestfish-actions.pod:4926 ../src/guestfs-actions.pod:7456
14408 msgid ""
14409 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14410 "nanoseconds from the epoch."
14411 msgstr ""
14412
14413 #. type: textblock
14414 #: ../fish/guestfish-actions.pod:4929 ../src/guestfs-actions.pod:7459
14415 msgid ""
14416 "If the C<*nsecs> field contains the special value C<-1> then the "
14417 "corresponding timestamp is set to the current time.  (The C<*secs> field is "
14418 "ignored in this case)."
14419 msgstr ""
14420
14421 #. type: textblock
14422 #: ../fish/guestfish-actions.pod:4933 ../src/guestfs-actions.pod:7463
14423 msgid ""
14424 "If the C<*nsecs> field contains the special value C<-2> then the "
14425 "corresponding timestamp is left unchanged.  (The C<*secs> field is ignored "
14426 "in this case)."
14427 msgstr ""
14428
14429 #. type: =head2
14430 #: ../fish/guestfish-actions.pod:4937
14431 msgid "version"
14432 msgstr ""
14433
14434 #. type: verbatim
14435 #: ../fish/guestfish-actions.pod:4939
14436 #, no-wrap
14437 msgid ""
14438 " version\n"
14439 "\n"
14440 msgstr ""
14441
14442 #. type: textblock
14443 #: ../fish/guestfish-actions.pod:4941 ../src/guestfs-actions.pod:7476
14444 msgid "Return the libguestfs version number that the program is linked against."
14445 msgstr ""
14446
14447 #. type: textblock
14448 #: ../fish/guestfish-actions.pod:4944 ../src/guestfs-actions.pod:7479
14449 msgid ""
14450 "Note that because of dynamic linking this is not necessarily the version of "
14451 "libguestfs that you compiled against.  You can compile the program, and then "
14452 "at runtime dynamically link against a completely different C<libguestfs.so> "
14453 "library."
14454 msgstr ""
14455
14456 #. type: textblock
14457 #: ../fish/guestfish-actions.pod:4949 ../src/guestfs-actions.pod:7484
14458 msgid ""
14459 "This call was added in version C<1.0.58>.  In previous versions of "
14460 "libguestfs there was no way to get the version number.  From C code you can "
14461 "use dynamic linker functions to find out if this symbol exists (if it "
14462 "doesn't, then it's an earlier version)."
14463 msgstr ""
14464
14465 #. type: textblock
14466 #: ../fish/guestfish-actions.pod:4955 ../src/guestfs-actions.pod:7490
14467 msgid ""
14468 "The call returns a structure with four elements.  The first three (C<major>, "
14469 "C<minor> and C<release>) are numbers and correspond to the usual version "
14470 "triplet.  The fourth element (C<extra>) is a string and is normally empty, "
14471 "but may be used for distro-specific information."
14472 msgstr ""
14473
14474 #. type: textblock
14475 #: ../fish/guestfish-actions.pod:4961 ../src/guestfs-actions.pod:7496
14476 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
14477 msgstr ""
14478
14479 #. type: textblock
14480 #: ../fish/guestfish-actions.pod:4964 ../src/guestfs-actions.pod:7499
14481 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14482 msgstr ""
14483
14484 #. type: textblock
14485 #: ../fish/guestfish-actions.pod:4966
14486 msgid ""
14487 "I<Note:> Don't use this call to test for availability of features.  In "
14488 "enterprise distributions we backport features from later versions into "
14489 "earlier versions, making this an unreliable way to test for features.  Use "
14490 "L</available> instead."
14491 msgstr ""
14492
14493 #. type: =head2
14494 #: ../fish/guestfish-actions.pod:4972
14495 msgid "vfs-label"
14496 msgstr ""
14497
14498 #. type: verbatim
14499 #: ../fish/guestfish-actions.pod:4974
14500 #, no-wrap
14501 msgid ""
14502 " vfs-label device\n"
14503 "\n"
14504 msgstr ""
14505
14506 #. type: textblock
14507 #: ../fish/guestfish-actions.pod:4976 ../src/guestfs-actions.pod:7519
14508 msgid "This returns the filesystem label of the filesystem on C<device>."
14509 msgstr ""
14510
14511 #. type: textblock
14512 #: ../fish/guestfish-actions.pod:4979 ../src/guestfs-actions.pod:7522
14513 msgid "If the filesystem is unlabeled, this returns the empty string."
14514 msgstr ""
14515
14516 #. type: textblock
14517 #: ../fish/guestfish-actions.pod:4981
14518 msgid "To find a filesystem from the label, use L</findfs-label>."
14519 msgstr ""
14520
14521 #. type: =head2
14522 #: ../fish/guestfish-actions.pod:4983
14523 msgid "vfs-type"
14524 msgstr ""
14525
14526 #. type: verbatim
14527 #: ../fish/guestfish-actions.pod:4985
14528 #, no-wrap
14529 msgid ""
14530 " vfs-type device\n"
14531 "\n"
14532 msgstr ""
14533
14534 #. type: textblock
14535 #: ../fish/guestfish-actions.pod:4987 ../src/guestfs-actions.pod:7537
14536 msgid ""
14537 "This command gets the filesystem type corresponding to the filesystem on "
14538 "C<device>."
14539 msgstr ""
14540
14541 #. type: textblock
14542 #: ../fish/guestfish-actions.pod:4990 ../src/guestfs-actions.pod:7540
14543 msgid ""
14544 "For most filesystems, the result is the name of the Linux VFS module which "
14545 "would be used to mount this filesystem if you mounted it without specifying "
14546 "the filesystem type.  For example a string such as C<ext3> or C<ntfs>."
14547 msgstr ""
14548
14549 #. type: =head2
14550 #: ../fish/guestfish-actions.pod:4995
14551 msgid "vfs-uuid"
14552 msgstr ""
14553
14554 #. type: verbatim
14555 #: ../fish/guestfish-actions.pod:4997
14556 #, no-wrap
14557 msgid ""
14558 " vfs-uuid device\n"
14559 "\n"
14560 msgstr ""
14561
14562 #. type: textblock
14563 #: ../fish/guestfish-actions.pod:4999 ../src/guestfs-actions.pod:7556
14564 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14565 msgstr ""
14566
14567 #. type: textblock
14568 #: ../fish/guestfish-actions.pod:5002 ../src/guestfs-actions.pod:7559
14569 msgid "If the filesystem does not have a UUID, this returns the empty string."
14570 msgstr ""
14571
14572 #. type: textblock
14573 #: ../fish/guestfish-actions.pod:5004
14574 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
14575 msgstr ""
14576
14577 #. type: =head2
14578 #: ../fish/guestfish-actions.pod:5006
14579 msgid "vg-activate"
14580 msgstr ""
14581
14582 #. type: verbatim
14583 #: ../fish/guestfish-actions.pod:5008
14584 #, no-wrap
14585 msgid ""
14586 " vg-activate true|false 'volgroups ...'\n"
14587 "\n"
14588 msgstr ""
14589
14590 #. type: textblock
14591 #: ../fish/guestfish-actions.pod:5010 ../src/guestfs-actions.pod:7575
14592 msgid ""
14593 "This command activates or (if C<activate> is false) deactivates all logical "
14594 "volumes in the listed volume groups C<volgroups>."
14595 msgstr ""
14596
14597 #. type: textblock
14598 #: ../fish/guestfish-actions.pod:5013 ../src/guestfs-actions.pod:7578
14599 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14600 msgstr ""
14601
14602 #. type: textblock
14603 #: ../fish/guestfish-actions.pod:5015 ../src/guestfs-actions.pod:7580
14604 msgid ""
14605 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14606 "activated or deactivated."
14607 msgstr ""
14608
14609 #. type: =head2
14610 #: ../fish/guestfish-actions.pod:5018
14611 msgid "vg-activate-all"
14612 msgstr ""
14613
14614 #. type: verbatim
14615 #: ../fish/guestfish-actions.pod:5020
14616 #, no-wrap
14617 msgid ""
14618 " vg-activate-all true|false\n"
14619 "\n"
14620 msgstr ""
14621
14622 #. type: textblock
14623 #: ../fish/guestfish-actions.pod:5022 ../src/guestfs-actions.pod:7593
14624 msgid ""
14625 "This command activates or (if C<activate> is false) deactivates all logical "
14626 "volumes in all volume groups."
14627 msgstr ""
14628
14629 #. type: textblock
14630 #: ../fish/guestfish-actions.pod:5025 ../src/guestfs-actions.pod:7596
14631 msgid "This command is the same as running C<vgchange -a y|n>"
14632 msgstr ""
14633
14634 #. type: =head2
14635 #: ../fish/guestfish-actions.pod:5027
14636 msgid "vgcreate"
14637 msgstr ""
14638
14639 #. type: verbatim
14640 #: ../fish/guestfish-actions.pod:5029
14641 #, no-wrap
14642 msgid ""
14643 " vgcreate volgroup 'physvols ...'\n"
14644 "\n"
14645 msgstr ""
14646
14647 #. type: textblock
14648 #: ../fish/guestfish-actions.pod:5031 ../src/guestfs-actions.pod:7609
14649 msgid ""
14650 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14651 "of physical volumes C<physvols>."
14652 msgstr ""
14653
14654 #. type: =head2
14655 #: ../fish/guestfish-actions.pod:5034
14656 msgid "vglvuuids"
14657 msgstr ""
14658
14659 #. type: verbatim
14660 #: ../fish/guestfish-actions.pod:5036
14661 #, no-wrap
14662 msgid ""
14663 " vglvuuids vgname\n"
14664 "\n"
14665 msgstr ""
14666
14667 #. type: textblock
14668 #: ../fish/guestfish-actions.pod:5038 ../src/guestfs-actions.pod:7622
14669 msgid ""
14670 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14671 "volumes created in this volume group."
14672 msgstr ""
14673
14674 #. type: textblock
14675 #: ../fish/guestfish-actions.pod:5041
14676 msgid ""
14677 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
14678 "logical volumes and volume groups."
14679 msgstr ""
14680
14681 #. type: textblock
14682 #: ../fish/guestfish-actions.pod:5044
14683 msgid "See also L</vgpvuuids>."
14684 msgstr ""
14685
14686 #. type: =head2
14687 #: ../fish/guestfish-actions.pod:5046
14688 msgid "vgpvuuids"
14689 msgstr ""
14690
14691 #. type: verbatim
14692 #: ../fish/guestfish-actions.pod:5048
14693 #, no-wrap
14694 msgid ""
14695 " vgpvuuids vgname\n"
14696 "\n"
14697 msgstr ""
14698
14699 #. type: textblock
14700 #: ../fish/guestfish-actions.pod:5050 ../src/guestfs-actions.pod:7642
14701 msgid ""
14702 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14703 "volumes that this volume group resides on."
14704 msgstr ""
14705
14706 #. type: textblock
14707 #: ../fish/guestfish-actions.pod:5053
14708 msgid ""
14709 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
14710 "physical volumes and volume groups."
14711 msgstr ""
14712
14713 #. type: textblock
14714 #: ../fish/guestfish-actions.pod:5056
14715 msgid "See also L</vglvuuids>."
14716 msgstr ""
14717
14718 #. type: =head2
14719 #: ../fish/guestfish-actions.pod:5058
14720 msgid "vgremove"
14721 msgstr ""
14722
14723 #. type: verbatim
14724 #: ../fish/guestfish-actions.pod:5060
14725 #, no-wrap
14726 msgid ""
14727 " vgremove vgname\n"
14728 "\n"
14729 msgstr ""
14730
14731 #. type: textblock
14732 #: ../fish/guestfish-actions.pod:5062 ../src/guestfs-actions.pod:7662
14733 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14734 msgstr ""
14735
14736 #. type: textblock
14737 #: ../fish/guestfish-actions.pod:5064 ../src/guestfs-actions.pod:7664
14738 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
14739 msgstr ""
14740
14741 #. type: =head2
14742 #: ../fish/guestfish-actions.pod:5067
14743 msgid "vgrename"
14744 msgstr ""
14745
14746 #. type: verbatim
14747 #: ../fish/guestfish-actions.pod:5069
14748 #, no-wrap
14749 msgid ""
14750 " vgrename volgroup newvolgroup\n"
14751 "\n"
14752 msgstr ""
14753
14754 #. type: textblock
14755 #: ../fish/guestfish-actions.pod:5071 ../src/guestfs-actions.pod:7678
14756 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14757 msgstr ""
14758
14759 #. type: =head2
14760 #: ../fish/guestfish-actions.pod:5073
14761 msgid "vgs"
14762 msgstr ""
14763
14764 #. type: verbatim
14765 #: ../fish/guestfish-actions.pod:5075
14766 #, no-wrap
14767 msgid ""
14768 " vgs\n"
14769 "\n"
14770 msgstr ""
14771
14772 #. type: textblock
14773 #: ../fish/guestfish-actions.pod:5077 ../src/guestfs-actions.pod:7689
14774 msgid ""
14775 "List all the volumes groups detected.  This is the equivalent of the "
14776 "L<vgs(8)> command."
14777 msgstr ""
14778
14779 #. type: textblock
14780 #: ../fish/guestfish-actions.pod:5080 ../src/guestfs-actions.pod:7692
14781 msgid ""
14782 "This returns a list of just the volume group names that were detected "
14783 "(eg. C<VolGroup00>)."
14784 msgstr ""
14785
14786 #. type: textblock
14787 #: ../fish/guestfish-actions.pod:5083
14788 msgid "See also L</vgs-full>."
14789 msgstr ""
14790
14791 #. type: =head2
14792 #: ../fish/guestfish-actions.pod:5085
14793 msgid "vgs-full"
14794 msgstr ""
14795
14796 #. type: verbatim
14797 #: ../fish/guestfish-actions.pod:5087
14798 #, no-wrap
14799 msgid ""
14800 " vgs-full\n"
14801 "\n"
14802 msgstr ""
14803
14804 #. type: textblock
14805 #: ../fish/guestfish-actions.pod:5089 ../src/guestfs-actions.pod:7708
14806 msgid ""
14807 "List all the volumes groups detected.  This is the equivalent of the "
14808 "L<vgs(8)> command.  The \"full\" version includes all fields."
14809 msgstr ""
14810
14811 #. type: =head2
14812 #: ../fish/guestfish-actions.pod:5092
14813 msgid "vgscan"
14814 msgstr ""
14815
14816 #. type: verbatim
14817 #: ../fish/guestfish-actions.pod:5094
14818 #, no-wrap
14819 msgid ""
14820 " vgscan\n"
14821 "\n"
14822 msgstr ""
14823
14824 #. type: textblock
14825 #: ../fish/guestfish-actions.pod:5096 ../src/guestfs-actions.pod:7722
14826 msgid ""
14827 "This rescans all block devices and rebuilds the list of LVM physical "
14828 "volumes, volume groups and logical volumes."
14829 msgstr ""
14830
14831 #. type: =head2
14832 #: ../fish/guestfish-actions.pod:5099
14833 msgid "vguuid"
14834 msgstr ""
14835
14836 #. type: verbatim
14837 #: ../fish/guestfish-actions.pod:5101
14838 #, no-wrap
14839 msgid ""
14840 " vguuid vgname\n"
14841 "\n"
14842 msgstr ""
14843
14844 #. type: textblock
14845 #: ../fish/guestfish-actions.pod:5103 ../src/guestfs-actions.pod:7735
14846 msgid "This command returns the UUID of the LVM VG named C<vgname>."
14847 msgstr ""
14848
14849 #. type: =head2
14850 #: ../fish/guestfish-actions.pod:5105
14851 msgid "wc-c"
14852 msgstr ""
14853
14854 #. type: verbatim
14855 #: ../fish/guestfish-actions.pod:5107
14856 #, no-wrap
14857 msgid ""
14858 " wc-c path\n"
14859 "\n"
14860 msgstr ""
14861
14862 #. type: textblock
14863 #: ../fish/guestfish-actions.pod:5109 ../src/guestfs-actions.pod:7775
14864 msgid ""
14865 "This command counts the characters in a file, using the C<wc -c> external "
14866 "command."
14867 msgstr ""
14868
14869 #. type: =head2
14870 #: ../fish/guestfish-actions.pod:5112
14871 msgid "wc-l"
14872 msgstr ""
14873
14874 #. type: verbatim
14875 #: ../fish/guestfish-actions.pod:5114
14876 #, no-wrap
14877 msgid ""
14878 " wc-l path\n"
14879 "\n"
14880 msgstr ""
14881
14882 #. type: textblock
14883 #: ../fish/guestfish-actions.pod:5116 ../src/guestfs-actions.pod:7788
14884 msgid ""
14885 "This command counts the lines in a file, using the C<wc -l> external "
14886 "command."
14887 msgstr ""
14888
14889 #. type: =head2
14890 #: ../fish/guestfish-actions.pod:5119
14891 msgid "wc-w"
14892 msgstr ""
14893
14894 #. type: verbatim
14895 #: ../fish/guestfish-actions.pod:5121
14896 #, no-wrap
14897 msgid ""
14898 " wc-w path\n"
14899 "\n"
14900 msgstr ""
14901
14902 #. type: textblock
14903 #: ../fish/guestfish-actions.pod:5123 ../src/guestfs-actions.pod:7801
14904 msgid ""
14905 "This command counts the words in a file, using the C<wc -w> external "
14906 "command."
14907 msgstr ""
14908
14909 #. type: =head2
14910 #: ../fish/guestfish-actions.pod:5126
14911 msgid "write"
14912 msgstr ""
14913
14914 #. type: verbatim
14915 #: ../fish/guestfish-actions.pod:5128
14916 #, no-wrap
14917 msgid ""
14918 " write path content\n"
14919 "\n"
14920 msgstr ""
14921
14922 #. type: textblock
14923 #: ../fish/guestfish-actions.pod:5130 ../src/guestfs-actions.pod:7816
14924 msgid ""
14925 "This call creates a file called C<path>.  The content of the file is the "
14926 "string C<content> (which can contain any 8 bit data)."
14927 msgstr ""
14928
14929 #. type: textblock
14930 #: ../fish/guestfish-actions.pod:5133
14931 msgid "See also L</write-append>."
14932 msgstr ""
14933
14934 #. type: =head2
14935 #: ../fish/guestfish-actions.pod:5138
14936 msgid "write-append"
14937 msgstr ""
14938
14939 #. type: verbatim
14940 #: ../fish/guestfish-actions.pod:5140
14941 #, no-wrap
14942 msgid ""
14943 " write-append path content\n"
14944 "\n"
14945 msgstr ""
14946
14947 #. type: textblock
14948 #: ../fish/guestfish-actions.pod:5142 ../src/guestfs-actions.pod:7836
14949 msgid ""
14950 "This call appends C<content> to the end of file C<path>.  If C<path> does "
14951 "not exist, then a new file is created."
14952 msgstr ""
14953
14954 #. type: textblock
14955 #: ../fish/guestfish-actions.pod:5145
14956 msgid "See also L</write>."
14957 msgstr ""
14958
14959 #. type: =head2
14960 #: ../fish/guestfish-actions.pod:5150
14961 msgid "write-file"
14962 msgstr ""
14963
14964 #. type: verbatim
14965 #: ../fish/guestfish-actions.pod:5152
14966 #, no-wrap
14967 msgid ""
14968 " write-file path content size\n"
14969 "\n"
14970 msgstr ""
14971
14972 #. type: textblock
14973 #: ../fish/guestfish-actions.pod:5154 ../src/guestfs-actions.pod:7863
14974 msgid ""
14975 "This call creates a file called C<path>.  The contents of the file is the "
14976 "string C<content> (which can contain any 8 bit data), with length C<size>."
14977 msgstr ""
14978
14979 #. type: textblock
14980 #: ../fish/guestfish-actions.pod:5158 ../src/guestfs-actions.pod:7867
14981 msgid ""
14982 "As a special case, if C<size> is C<0> then the length is calculated using "
14983 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
14984 msgstr ""
14985
14986 #. type: textblock
14987 #: ../fish/guestfish-actions.pod:5162 ../src/guestfs-actions.pod:7871
14988 msgid ""
14989 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
14990 "I<not> work, even if the length is specified."
14991 msgstr ""
14992
14993 #. type: textblock
14994 #: ../fish/guestfish-actions.pod:5168
14995 msgid "I<This function is deprecated.> In new code, use the L</write> call instead."
14996 msgstr ""
14997
14998 #. type: =head2
14999 #: ../fish/guestfish-actions.pod:5175
15000 msgid "zegrep"
15001 msgstr ""
15002
15003 #. type: verbatim
15004 #: ../fish/guestfish-actions.pod:5177
15005 #, no-wrap
15006 msgid ""
15007 " zegrep regex path\n"
15008 "\n"
15009 msgstr ""
15010
15011 #. type: textblock
15012 #: ../fish/guestfish-actions.pod:5179 ../src/guestfs-actions.pod:7888
15013 msgid "This calls the external C<zegrep> program and returns the matching lines."
15014 msgstr ""
15015
15016 #. type: =head2
15017 #: ../fish/guestfish-actions.pod:5185
15018 msgid "zegrepi"
15019 msgstr ""
15020
15021 #. type: verbatim
15022 #: ../fish/guestfish-actions.pod:5187
15023 #, no-wrap
15024 msgid ""
15025 " zegrepi regex path\n"
15026 "\n"
15027 msgstr ""
15028
15029 #. type: textblock
15030 #: ../fish/guestfish-actions.pod:5189 ../src/guestfs-actions.pod:7907
15031 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
15032 msgstr ""
15033
15034 #. type: =head2
15035 #: ../fish/guestfish-actions.pod:5195
15036 msgid "zero"
15037 msgstr ""
15038
15039 #. type: verbatim
15040 #: ../fish/guestfish-actions.pod:5197
15041 #, no-wrap
15042 msgid ""
15043 " zero device\n"
15044 "\n"
15045 msgstr ""
15046
15047 #. type: textblock
15048 #: ../fish/guestfish-actions.pod:5199 ../src/guestfs-actions.pod:7925
15049 msgid "This command writes zeroes over the first few blocks of C<device>."
15050 msgstr ""
15051
15052 #. type: textblock
15053 #: ../fish/guestfish-actions.pod:5201 ../src/guestfs-actions.pod:7927
15054 msgid ""
15055 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15056 "securely wipe the device).  It should be sufficient to remove any partition "
15057 "tables, filesystem superblocks and so on."
15058 msgstr ""
15059
15060 #. type: textblock
15061 #: ../fish/guestfish-actions.pod:5205 ../fish/guestfish-actions.pod:5220 ../src/guestfs-actions.pod:7931 ../src/guestfs-actions.pod:7957
15062 msgid ""
15063 "If blocks are already zero, then this command avoids writing zeroes.  This "
15064 "prevents the underlying device from becoming non-sparse or growing "
15065 "unnecessarily."
15066 msgstr ""
15067
15068 #. type: textblock
15069 #: ../fish/guestfish-actions.pod:5209
15070 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
15071 msgstr ""
15072
15073 #. type: =head2
15074 #: ../fish/guestfish-actions.pod:5212
15075 msgid "zero-device"
15076 msgstr ""
15077
15078 #. type: verbatim
15079 #: ../fish/guestfish-actions.pod:5214
15080 #, no-wrap
15081 msgid ""
15082 " zero-device device\n"
15083 "\n"
15084 msgstr ""
15085
15086 #. type: textblock
15087 #: ../fish/guestfish-actions.pod:5216
15088 msgid ""
15089 "This command writes zeroes over the entire C<device>.  Compare with L</zero> "
15090 "which just zeroes the first few blocks of a device."
15091 msgstr ""
15092
15093 #. type: =head2
15094 #: ../fish/guestfish-actions.pod:5227
15095 msgid "zerofree"
15096 msgstr ""
15097
15098 #. type: verbatim
15099 #: ../fish/guestfish-actions.pod:5229
15100 #, no-wrap
15101 msgid ""
15102 " zerofree device\n"
15103 "\n"
15104 msgstr ""
15105
15106 #. type: textblock
15107 #: ../fish/guestfish-actions.pod:5231 ../src/guestfs-actions.pod:7979
15108 msgid ""
15109 "This runs the I<zerofree> program on C<device>.  This program claims to zero "
15110 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
15111 "possible to compress the filesystem more effectively."
15112 msgstr ""
15113
15114 #. type: textblock
15115 #: ../fish/guestfish-actions.pod:5236 ../src/guestfs-actions.pod:7984
15116 msgid "You should B<not> run this program if the filesystem is mounted."
15117 msgstr ""
15118
15119 #. type: textblock
15120 #: ../fish/guestfish-actions.pod:5239 ../src/guestfs-actions.pod:7987
15121 msgid ""
15122 "It is possible that using this program can damage the filesystem or data on "
15123 "the filesystem."
15124 msgstr ""
15125
15126 #. type: =head2
15127 #: ../fish/guestfish-actions.pod:5242
15128 msgid "zfgrep"
15129 msgstr ""
15130
15131 #. type: verbatim
15132 #: ../fish/guestfish-actions.pod:5244
15133 #, no-wrap
15134 msgid ""
15135 " zfgrep pattern path\n"
15136 "\n"
15137 msgstr ""
15138
15139 #. type: textblock
15140 #: ../fish/guestfish-actions.pod:5246 ../src/guestfs-actions.pod:8001
15141 msgid "This calls the external C<zfgrep> program and returns the matching lines."
15142 msgstr ""
15143
15144 #. type: =head2
15145 #: ../fish/guestfish-actions.pod:5252
15146 msgid "zfgrepi"
15147 msgstr ""
15148
15149 #. type: verbatim
15150 #: ../fish/guestfish-actions.pod:5254
15151 #, no-wrap
15152 msgid ""
15153 " zfgrepi pattern path\n"
15154 "\n"
15155 msgstr ""
15156
15157 #. type: textblock
15158 #: ../fish/guestfish-actions.pod:5256 ../src/guestfs-actions.pod:8020
15159 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
15160 msgstr ""
15161
15162 #. type: =head2
15163 #: ../fish/guestfish-actions.pod:5262
15164 msgid "zfile"
15165 msgstr ""
15166
15167 #. type: verbatim
15168 #: ../fish/guestfish-actions.pod:5264
15169 #, no-wrap
15170 msgid ""
15171 " zfile meth path\n"
15172 "\n"
15173 msgstr ""
15174
15175 #. type: textblock
15176 #: ../fish/guestfish-actions.pod:5266 ../src/guestfs-actions.pod:8046
15177 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
15178 msgstr ""
15179
15180 #. type: textblock
15181 #: ../fish/guestfish-actions.pod:5269 ../src/guestfs-actions.pod:8049
15182 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15183 msgstr ""
15184
15185 #. type: textblock
15186 #: ../fish/guestfish-actions.pod:5271
15187 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
15188 msgstr ""
15189
15190 #. type: textblock
15191 #: ../fish/guestfish-actions.pod:5274
15192 msgid "I<This function is deprecated.> In new code, use the L</file> call instead."
15193 msgstr ""
15194
15195 #. type: =head2
15196 #: ../fish/guestfish-actions.pod:5281
15197 msgid "zgrep"
15198 msgstr ""
15199
15200 #. type: verbatim
15201 #: ../fish/guestfish-actions.pod:5283
15202 #, no-wrap
15203 msgid ""
15204 " zgrep regex path\n"
15205 "\n"
15206 msgstr ""
15207
15208 #. type: textblock
15209 #: ../fish/guestfish-actions.pod:5285 ../src/guestfs-actions.pod:8066
15210 msgid "This calls the external C<zgrep> program and returns the matching lines."
15211 msgstr ""
15212
15213 #. type: =head2
15214 #: ../fish/guestfish-actions.pod:5291
15215 msgid "zgrepi"
15216 msgstr ""
15217
15218 #. type: verbatim
15219 #: ../fish/guestfish-actions.pod:5293
15220 #, no-wrap
15221 msgid ""
15222 " zgrepi regex path\n"
15223 "\n"
15224 msgstr ""
15225
15226 #. type: textblock
15227 #: ../fish/guestfish-actions.pod:5295 ../src/guestfs-actions.pod:8085
15228 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
15229 msgstr ""
15230
15231 #. type: =head2
15232 #: ../fish/guestfish-commands.pod:1
15233 msgid "alloc"
15234 msgstr ""
15235
15236 #. type: =head2
15237 #: ../fish/guestfish-commands.pod:3
15238 msgid "allocate"
15239 msgstr ""
15240
15241 #. type: verbatim
15242 #: ../fish/guestfish-commands.pod:5
15243 #, no-wrap
15244 msgid ""
15245 " alloc filename size\n"
15246 "\n"
15247 msgstr ""
15248
15249 #. type: textblock
15250 #: ../fish/guestfish-commands.pod:7
15251 msgid ""
15252 "This creates an empty (zeroed) file of the given size, and then adds so it "
15253 "can be further examined."
15254 msgstr ""
15255
15256 #. type: textblock
15257 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:193
15258 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
15259 msgstr ""
15260
15261 #. type: textblock
15262 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:195
15263 msgid "Size can be specified using standard suffixes, eg. C<1M>."
15264 msgstr ""
15265
15266 #. type: textblock
15267 #: ../fish/guestfish-commands.pod:14
15268 msgid ""
15269 "To create a sparse file, use L</sparse> instead.  To create a prepared disk "
15270 "image, see L</PREPARED DISK IMAGES>."
15271 msgstr ""
15272
15273 #. type: =head2
15274 #: ../fish/guestfish-commands.pod:17
15275 msgid "copy-in"
15276 msgstr ""
15277
15278 #. type: verbatim
15279 #: ../fish/guestfish-commands.pod:19
15280 #, no-wrap
15281 msgid ""
15282 " copy-in local [local ...] /remotedir\n"
15283 "\n"
15284 msgstr ""
15285
15286 #. type: textblock
15287 #: ../fish/guestfish-commands.pod:21
15288 msgid ""
15289 "C<copy-in> copies local files or directories recursively into the disk "
15290 "image, placing them in the directory called C</remotedir> (which must "
15291 "exist).  This guestfish meta-command turns into a sequence of L</tar-in> and "
15292 "other commands as necessary."
15293 msgstr ""
15294
15295 #. type: textblock
15296 #: ../fish/guestfish-commands.pod:26
15297 msgid ""
15298 "Multiple local files and directories can be specified, but the last "
15299 "parameter must always be a remote directory.  Wildcards cannot be used."
15300 msgstr ""
15301
15302 #. type: =head2
15303 #: ../fish/guestfish-commands.pod:30
15304 msgid "copy-out"
15305 msgstr ""
15306
15307 #. type: verbatim
15308 #: ../fish/guestfish-commands.pod:32
15309 #, no-wrap
15310 msgid ""
15311 " copy-out remote [remote ...] localdir\n"
15312 "\n"
15313 msgstr ""
15314
15315 #. type: textblock
15316 #: ../fish/guestfish-commands.pod:34
15317 msgid ""
15318 "C<copy-out> copies remote files or directories recursively out of the disk "
15319 "image, placing them on the host disk in a local directory called C<localdir> "
15320 "(which must exist).  This guestfish meta-command turns into a sequence of "
15321 "L</download>, L</tar-out> and other commands as necessary."
15322 msgstr ""
15323
15324 #. type: textblock
15325 #: ../fish/guestfish-commands.pod:40
15326 msgid ""
15327 "Multiple remote files and directories can be specified, but the last "
15328 "parameter must always be a local directory.  To download to the current "
15329 "directory, use C<.> as in:"
15330 msgstr ""
15331
15332 #. type: verbatim
15333 #: ../fish/guestfish-commands.pod:44
15334 #, no-wrap
15335 msgid ""
15336 " copy-out /home .\n"
15337 "\n"
15338 msgstr ""
15339
15340 #. type: textblock
15341 #: ../fish/guestfish-commands.pod:46
15342 msgid ""
15343 "Wildcards cannot be used in the ordinary command, but you can use them with "
15344 "the help of L</glob> like this:"
15345 msgstr ""
15346
15347 #. type: verbatim
15348 #: ../fish/guestfish-commands.pod:49
15349 #, no-wrap
15350 msgid ""
15351 " glob copy-out /home/* .\n"
15352 "\n"
15353 msgstr ""
15354
15355 #. type: =head2
15356 #: ../fish/guestfish-commands.pod:51
15357 msgid "display"
15358 msgstr ""
15359
15360 #. type: verbatim
15361 #: ../fish/guestfish-commands.pod:53
15362 #, no-wrap
15363 msgid ""
15364 " display filename\n"
15365 "\n"
15366 msgstr ""
15367
15368 #. type: textblock
15369 #: ../fish/guestfish-commands.pod:55
15370 msgid ""
15371 "Use C<display> (a graphical display program) to display an image file.  It "
15372 "downloads the file, and runs C<display> on it."
15373 msgstr ""
15374
15375 #. type: textblock
15376 #: ../fish/guestfish-commands.pod:58
15377 msgid ""
15378 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
15379 "environment variable.  For example to use the GNOME display program:"
15380 msgstr ""
15381
15382 #. type: verbatim
15383 #: ../fish/guestfish-commands.pod:61
15384 #, no-wrap
15385 msgid ""
15386 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
15387 "\n"
15388 msgstr ""
15389
15390 #. type: textblock
15391 #: ../fish/guestfish-commands.pod:63
15392 msgid "See also L<display(1)>."
15393 msgstr ""
15394
15395 #. type: =head2
15396 #: ../fish/guestfish-commands.pod:65
15397 msgid "echo"
15398 msgstr ""
15399
15400 #. type: verbatim
15401 #: ../fish/guestfish-commands.pod:67
15402 #, no-wrap
15403 msgid ""
15404 " echo [params ...]\n"
15405 "\n"
15406 msgstr ""
15407
15408 #. type: textblock
15409 #: ../fish/guestfish-commands.pod:69
15410 msgid "This echos the parameters to the terminal."
15411 msgstr ""
15412
15413 #. type: =head2
15414 #: ../fish/guestfish-commands.pod:71
15415 msgid "edit"
15416 msgstr ""
15417
15418 #. type: =head2
15419 #: ../fish/guestfish-commands.pod:73
15420 msgid "vi"
15421 msgstr ""
15422
15423 #. type: =head2
15424 #: ../fish/guestfish-commands.pod:75
15425 msgid "emacs"
15426 msgstr ""
15427
15428 #. type: verbatim
15429 #: ../fish/guestfish-commands.pod:77
15430 #, no-wrap
15431 msgid ""
15432 " edit filename\n"
15433 "\n"
15434 msgstr ""
15435
15436 #. type: textblock
15437 #: ../fish/guestfish-commands.pod:79
15438 msgid ""
15439 "This is used to edit a file.  It downloads the file, edits it locally using "
15440 "your editor, then uploads the result."
15441 msgstr ""
15442
15443 #. type: textblock
15444 #: ../fish/guestfish-commands.pod:82
15445 msgid ""
15446 "The editor is C<$EDITOR>.  However if you use the alternate commands C<vi> "
15447 "or C<emacs> you will get those corresponding editors."
15448 msgstr ""
15449
15450 #. type: =head2
15451 #: ../fish/guestfish-commands.pod:86
15452 msgid "glob"
15453 msgstr ""
15454
15455 #. type: verbatim
15456 #: ../fish/guestfish-commands.pod:88
15457 #, no-wrap
15458 msgid ""
15459 " glob command args...\n"
15460 "\n"
15461 msgstr ""
15462
15463 #. type: textblock
15464 #: ../fish/guestfish-commands.pod:90
15465 msgid ""
15466 "Expand wildcards in any paths in the args list, and run C<command> "
15467 "repeatedly on each matching path."
15468 msgstr ""
15469
15470 #. type: textblock
15471 #: ../fish/guestfish-commands.pod:93
15472 msgid "See L</WILDCARDS AND GLOBBING>."
15473 msgstr ""
15474
15475 #. type: =head2
15476 #: ../fish/guestfish-commands.pod:95
15477 msgid "hexedit"
15478 msgstr ""
15479
15480 #. type: verbatim
15481 #: ../fish/guestfish-commands.pod:97
15482 #, no-wrap
15483 msgid ""
15484 " hexedit <filename|device>\n"
15485 " hexedit <filename|device> <max>\n"
15486 " hexedit <filename|device> <start> <max>\n"
15487 "\n"
15488 msgstr ""
15489
15490 #. type: textblock
15491 #: ../fish/guestfish-commands.pod:101
15492 msgid ""
15493 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
15494 "device."
15495 msgstr ""
15496
15497 #. type: textblock
15498 #: ../fish/guestfish-commands.pod:104
15499 msgid ""
15500 "This command works by downloading potentially the whole file or device, "
15501 "editing it locally, then uploading it.  If the file or device is large, you "
15502 "have to specify which part you wish to edit by using C<max> and/or C<start> "
15503 "C<max> parameters.  C<start> and C<max> are specified in bytes, with the "
15504 "usual modifiers allowed such as C<1M> (1 megabyte)."
15505 msgstr ""
15506
15507 #. type: textblock
15508 #: ../fish/guestfish-commands.pod:111
15509 msgid "For example to edit the first few sectors of a disk you might do:"
15510 msgstr ""
15511
15512 #. type: verbatim
15513 #: ../fish/guestfish-commands.pod:114
15514 #, no-wrap
15515 msgid ""
15516 " hexedit /dev/sda 1M\n"
15517 "\n"
15518 msgstr ""
15519
15520 #. type: textblock
15521 #: ../fish/guestfish-commands.pod:116
15522 msgid ""
15523 "which would allow you to edit anywhere within the first megabyte of the "
15524 "disk."
15525 msgstr ""
15526
15527 #. type: textblock
15528 #: ../fish/guestfish-commands.pod:119
15529 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
15530 msgstr ""
15531
15532 #. type: verbatim
15533 #: ../fish/guestfish-commands.pod:121
15534 #, no-wrap
15535 msgid ""
15536 " hexedit /dev/sda1 0x400 0x400\n"
15537 "\n"
15538 msgstr ""
15539
15540 #. type: textblock
15541 #: ../fish/guestfish-commands.pod:123
15542 msgid "(assuming the superblock is in the standard location)."
15543 msgstr ""
15544
15545 #. type: textblock
15546 #: ../fish/guestfish-commands.pod:125
15547 msgid ""
15548 "This command requires the external L<hexedit(1)> program.  You can specify "
15549 "another program to use by setting the C<HEXEDITOR> environment variable."
15550 msgstr ""
15551
15552 #. type: textblock
15553 #: ../fish/guestfish-commands.pod:129
15554 msgid "See also L</hexdump>."
15555 msgstr ""
15556
15557 #. type: =head2
15558 #: ../fish/guestfish-commands.pod:131
15559 msgid "lcd"
15560 msgstr ""
15561
15562 #. type: verbatim
15563 #: ../fish/guestfish-commands.pod:133
15564 #, no-wrap
15565 msgid ""
15566 " lcd directory\n"
15567 "\n"
15568 msgstr ""
15569
15570 #. type: textblock
15571 #: ../fish/guestfish-commands.pod:135
15572 msgid "Change the local directory, ie. the current directory of guestfish itself."
15573 msgstr ""
15574
15575 #. type: textblock
15576 #: ../fish/guestfish-commands.pod:138
15577 msgid "Note that C<!cd> won't do what you might expect."
15578 msgstr ""
15579
15580 #. type: =head2
15581 #: ../fish/guestfish-commands.pod:140
15582 msgid "man"
15583 msgstr ""
15584
15585 #. type: =head2
15586 #: ../fish/guestfish-commands.pod:142
15587 msgid "manual"
15588 msgstr ""
15589
15590 #. type: verbatim
15591 #: ../fish/guestfish-commands.pod:144
15592 #, no-wrap
15593 msgid ""
15594 "  man\n"
15595 "\n"
15596 msgstr ""
15597
15598 #. type: textblock
15599 #: ../fish/guestfish-commands.pod:146
15600 msgid "Opens the manual page for guestfish."
15601 msgstr ""
15602
15603 #. type: =head2
15604 #: ../fish/guestfish-commands.pod:148
15605 msgid "more"
15606 msgstr ""
15607
15608 #. type: =head2
15609 #: ../fish/guestfish-commands.pod:150
15610 msgid "less"
15611 msgstr ""
15612
15613 #. type: verbatim
15614 #: ../fish/guestfish-commands.pod:152
15615 #, no-wrap
15616 msgid ""
15617 " more filename\n"
15618 "\n"
15619 msgstr ""
15620
15621 #. type: verbatim
15622 #: ../fish/guestfish-commands.pod:154
15623 #, no-wrap
15624 msgid ""
15625 " less filename\n"
15626 "\n"
15627 msgstr ""
15628
15629 #. type: textblock
15630 #: ../fish/guestfish-commands.pod:156
15631 msgid "This is used to view a file."
15632 msgstr ""
15633
15634 #. type: textblock
15635 #: ../fish/guestfish-commands.pod:158
15636 msgid ""
15637 "The default viewer is C<$PAGER>.  However if you use the alternate command "
15638 "C<less> you will get the C<less> command specifically."
15639 msgstr ""
15640
15641 #. type: =head2
15642 #: ../fish/guestfish-commands.pod:161
15643 msgid "reopen"
15644 msgstr ""
15645
15646 #. type: verbatim
15647 #: ../fish/guestfish-commands.pod:163
15648 #, no-wrap
15649 msgid ""
15650 "  reopen\n"
15651 "\n"
15652 msgstr ""
15653
15654 #. type: textblock
15655 #: ../fish/guestfish-commands.pod:165
15656 msgid ""
15657 "Close and reopen the libguestfs handle.  It is not necessary to use this "
15658 "normally, because the handle is closed properly when guestfish exits.  "
15659 "However this is occasionally useful for testing."
15660 msgstr ""
15661
15662 #. type: =head2
15663 #: ../fish/guestfish-commands.pod:169
15664 msgid "setenv"
15665 msgstr ""
15666
15667 #. type: verbatim
15668 #: ../fish/guestfish-commands.pod:171
15669 #, no-wrap
15670 msgid ""
15671 "  setenv VAR value\n"
15672 "\n"
15673 msgstr ""
15674
15675 #. type: textblock
15676 #: ../fish/guestfish-commands.pod:173
15677 msgid "Set the environment variable C<VAR> to the string C<value>."
15678 msgstr ""
15679
15680 #. type: textblock
15681 #: ../fish/guestfish-commands.pod:175
15682 msgid "To print the value of an environment variable use a shell command such as:"
15683 msgstr ""
15684
15685 #. type: verbatim
15686 #: ../fish/guestfish-commands.pod:178
15687 #, no-wrap
15688 msgid ""
15689 " !echo $VAR\n"
15690 "\n"
15691 msgstr ""
15692
15693 #. type: =head2
15694 #: ../fish/guestfish-commands.pod:180
15695 msgid "sparse"
15696 msgstr ""
15697
15698 #. type: verbatim
15699 #: ../fish/guestfish-commands.pod:182
15700 #, no-wrap
15701 msgid ""
15702 " sparse filename size\n"
15703 "\n"
15704 msgstr ""
15705
15706 #. type: textblock
15707 #: ../fish/guestfish-commands.pod:184
15708 msgid ""
15709 "This creates an empty sparse file of the given size, and then adds so it can "
15710 "be further examined."
15711 msgstr ""
15712
15713 #. type: textblock
15714 #: ../fish/guestfish-commands.pod:187
15715 msgid ""
15716 "In all respects it works the same as the L</alloc> command, except that the "
15717 "image file is allocated sparsely, which means that disk blocks are not "
15718 "assigned to the file until they are needed.  Sparse disk files only use "
15719 "space when written to, but they are slower and there is a danger you could "
15720 "run out of real disk space during a write operation."
15721 msgstr ""
15722
15723 #. type: =head2
15724 #: ../fish/guestfish-commands.pod:197
15725 msgid "supported"
15726 msgstr ""
15727
15728 #. type: verbatim
15729 #: ../fish/guestfish-commands.pod:199
15730 #, no-wrap
15731 msgid ""
15732 " supported\n"
15733 "\n"
15734 msgstr ""
15735
15736 #. type: textblock
15737 #: ../fish/guestfish-commands.pod:201
15738 msgid ""
15739 "This command returns a list of the optional groups known to the daemon, and "
15740 "indicates which ones are supported by this build of the libguestfs "
15741 "appliance."
15742 msgstr ""
15743
15744 #. type: textblock
15745 #: ../fish/guestfish-commands.pod:205
15746 msgid "See also L<guestfs(3)/AVAILABILITY>."
15747 msgstr ""
15748
15749 #. type: =head2
15750 #: ../fish/guestfish-commands.pod:207
15751 msgid "time"
15752 msgstr ""
15753
15754 #. type: verbatim
15755 #: ../fish/guestfish-commands.pod:209
15756 #, no-wrap
15757 msgid ""
15758 " time command args...\n"
15759 "\n"
15760 msgstr ""
15761
15762 #. type: textblock
15763 #: ../fish/guestfish-commands.pod:211
15764 msgid ""
15765 "Run the command as usual, but print the elapsed time afterwards.  This can "
15766 "be useful for benchmarking operations."
15767 msgstr ""
15768
15769 #. type: =head2
15770 #: ../fish/guestfish-commands.pod:214
15771 msgid "unsetenv"
15772 msgstr ""
15773
15774 #. type: verbatim
15775 #: ../fish/guestfish-commands.pod:216
15776 #, no-wrap
15777 msgid ""
15778 "  unsetenv VAR\n"
15779 "\n"
15780 msgstr ""
15781
15782 #. type: textblock
15783 #: ../fish/guestfish-commands.pod:218
15784 msgid "Remove C<VAR> from the environment."
15785 msgstr ""
15786
15787 #. type: textblock
15788 #: ../fish/guestfish.pod:5
15789 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
15790 msgstr ""
15791
15792 #. type: verbatim
15793 #: ../fish/guestfish.pod:9
15794 #, no-wrap
15795 msgid ""
15796 " guestfish [--options] [commands]\n"
15797 "\n"
15798 msgstr ""
15799
15800 #. type: verbatim
15801 #: ../fish/guestfish.pod:11
15802 #, no-wrap
15803 msgid ""
15804 " guestfish\n"
15805 "\n"
15806 msgstr ""
15807
15808 #. type: verbatim
15809 #: ../fish/guestfish.pod:13
15810 #, no-wrap
15811 msgid ""
15812 " guestfish [--ro|--rw] -a disk.img\n"
15813 "\n"
15814 msgstr ""
15815
15816 #. type: verbatim
15817 #: ../fish/guestfish.pod:15
15818 #, no-wrap
15819 msgid ""
15820 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
15821 "\n"
15822 msgstr ""
15823
15824 #. type: verbatim
15825 #: ../fish/guestfish.pod:17
15826 #, no-wrap
15827 msgid ""
15828 " guestfish -d libvirt-domain\n"
15829 "\n"
15830 msgstr ""
15831
15832 #. type: verbatim
15833 #: ../fish/guestfish.pod:19
15834 #, no-wrap
15835 msgid ""
15836 " guestfish [--ro|--rw] -a disk.img -i\n"
15837 "\n"
15838 msgstr ""
15839
15840 #. type: verbatim
15841 #: ../fish/guestfish.pod:21
15842 #, no-wrap
15843 msgid ""
15844 " guestfish -d libvirt-domain -i\n"
15845 "\n"
15846 msgstr ""
15847
15848 #. type: textblock
15849 #: ../fish/guestfish.pod:25
15850 msgid ""
15851 "Using guestfish in read/write mode on live virtual machines can be "
15852 "dangerous, potentially causing disk corruption.  Use the I<--ro> (read-only) "
15853 "option to use guestfish safely if the disk image or virtual machine might be "
15854 "live."
15855 msgstr ""
15856
15857 #. type: textblock
15858 #: ../fish/guestfish.pod:32
15859 msgid ""
15860 "Guestfish is a shell and command-line tool for examining and modifying "
15861 "virtual machine filesystems.  It uses libguestfs and exposes all of the "
15862 "functionality of the guestfs API, see L<guestfs(3)>."
15863 msgstr ""
15864
15865 #. type: textblock
15866 #: ../fish/guestfish.pod:36
15867 msgid ""
15868 "Guestfish gives you structured access to the libguestfs API, from shell "
15869 "scripts or the command line or interactively.  If you want to rescue a "
15870 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
15871 "command."
15872 msgstr ""
15873
15874 #. type: =head2
15875 #: ../fish/guestfish.pod:43
15876 msgid "As an interactive shell"
15877 msgstr ""
15878
15879 #. type: verbatim
15880 #: ../fish/guestfish.pod:45
15881 #, no-wrap
15882 msgid ""
15883 " $ guestfish\n"
15884 " \n"
15885 msgstr ""
15886
15887 #. type: verbatim
15888 #: ../fish/guestfish.pod:47
15889 #, no-wrap
15890 msgid ""
15891 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
15892 " editing virtual machine filesystems.\n"
15893 " \n"
15894 msgstr ""
15895
15896 #. type: verbatim
15897 #: ../fish/guestfish.pod:50
15898 #, no-wrap
15899 msgid ""
15900 " Type: 'help' for a list of commands\n"
15901 "       'man' to read the manual\n"
15902 "       'quit' to quit the shell\n"
15903 " \n"
15904 msgstr ""
15905
15906 #. type: verbatim
15907 #: ../fish/guestfish.pod:54
15908 #, no-wrap
15909 msgid ""
15910 " ><fs> add-ro disk.img\n"
15911 " ><fs> run\n"
15912 " ><fs> list-filesystems\n"
15913 " /dev/sda1: ext4\n"
15914 " /dev/vg_guest/lv_root: ext4\n"
15915 " /dev/vg_guest/lv_swap: swap\n"
15916 " ><fs> mount /dev/vg_guest/lv_root /\n"
15917 " ><fs> cat /etc/fstab\n"
15918 " # /etc/fstab\n"
15919 " # Created by anaconda\n"
15920 " [...]\n"
15921 " ><fs> exit\n"
15922 "\n"
15923 msgstr ""
15924
15925 #. type: =head2
15926 #: ../fish/guestfish.pod:67
15927 msgid "From shell scripts"
15928 msgstr ""
15929
15930 #. type: textblock
15931 #: ../fish/guestfish.pod:69
15932 msgid "Create a new C</etc/motd> file in a guest or disk image:"
15933 msgstr ""
15934
15935 #. type: verbatim
15936 #: ../fish/guestfish.pod:71
15937 #, no-wrap
15938 msgid ""
15939 " guestfish <<_EOF_\n"
15940 " add disk.img\n"
15941 " run\n"
15942 " mount /dev/vg_guest/lv_root /\n"
15943 " write /etc/motd \"Welcome, new users\"\n"
15944 " _EOF_\n"
15945 "\n"
15946 msgstr ""
15947
15948 #. type: textblock
15949 #: ../fish/guestfish.pod:78
15950 msgid "List the LVM logical volumes in a disk image:"
15951 msgstr ""
15952
15953 #. type: verbatim
15954 #: ../fish/guestfish.pod:80
15955 #, no-wrap
15956 msgid ""
15957 " guestfish -a disk.img --ro <<_EOF_\n"
15958 " run\n"
15959 " lvs\n"
15960 " _EOF_\n"
15961 "\n"
15962 msgstr ""
15963
15964 #. type: textblock
15965 #: ../fish/guestfish.pod:85
15966 msgid "List all the filesystems in a disk image:"
15967 msgstr ""
15968
15969 #. type: verbatim
15970 #: ../fish/guestfish.pod:87
15971 #, no-wrap
15972 msgid ""
15973 " guestfish -a disk.img --ro <<_EOF_\n"
15974 " run\n"
15975 " list-filesystems\n"
15976 " _EOF_\n"
15977 "\n"
15978 msgstr ""
15979
15980 #. type: =head2
15981 #: ../fish/guestfish.pod:92
15982 msgid "On one command line"
15983 msgstr ""
15984
15985 #. type: textblock
15986 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
15987 msgid "Update C</etc/resolv.conf> in a guest:"
15988 msgstr ""
15989
15990 #. type: verbatim
15991 #: ../fish/guestfish.pod:96
15992 #, no-wrap
15993 msgid ""
15994 " guestfish \\\n"
15995 "   add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
15996 "   write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
15997 "\n"
15998 msgstr ""
15999
16000 #. type: textblock
16001 #: ../fish/guestfish.pod:100
16002 msgid "Edit C</boot/grub/grub.conf> interactively:"
16003 msgstr ""
16004
16005 #. type: verbatim
16006 #: ../fish/guestfish.pod:102
16007 #, no-wrap
16008 msgid ""
16009 " guestfish --rw --add disk.img \\\n"
16010 "   --mount /dev/vg_guest/lv_root \\\n"
16011 "   --mount /dev/sda1:/boot \\\n"
16012 "   edit /boot/grub/grub.conf\n"
16013 "\n"
16014 msgstr ""
16015
16016 #. type: =head2
16017 #: ../fish/guestfish.pod:107
16018 msgid "Mount disks automatically"
16019 msgstr ""
16020
16021 #. type: textblock
16022 #: ../fish/guestfish.pod:109
16023 msgid ""
16024 "Use the I<-i> option to automatically mount the disks from a virtual "
16025 "machine:"
16026 msgstr ""
16027
16028 #. type: verbatim
16029 #: ../fish/guestfish.pod:112
16030 #, no-wrap
16031 msgid ""
16032 " guestfish --ro -a disk.img -i cat /etc/group\n"
16033 "\n"
16034 msgstr ""
16035
16036 #. type: verbatim
16037 #: ../fish/guestfish.pod:114
16038 #, no-wrap
16039 msgid ""
16040 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
16041 "\n"
16042 msgstr ""
16043
16044 #. type: textblock
16045 #: ../fish/guestfish.pod:116
16046 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
16047 msgstr ""
16048
16049 #. type: verbatim
16050 #: ../fish/guestfish.pod:118
16051 #, no-wrap
16052 msgid ""
16053 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
16054 "\n"
16055 msgstr ""
16056
16057 #. type: =head2
16058 #: ../fish/guestfish.pod:120
16059 msgid "As a script interpreter"
16060 msgstr ""
16061
16062 #. type: textblock
16063 #: ../fish/guestfish.pod:122
16064 msgid "Create a 100MB disk containing an ext2-formatted partition:"
16065 msgstr ""
16066
16067 #. type: verbatim
16068 #: ../fish/guestfish.pod:124
16069 #, no-wrap
16070 msgid ""
16071 " #!/usr/bin/guestfish -f\n"
16072 " sparse test1.img 100M\n"
16073 " run\n"
16074 " part-disk /dev/sda mbr\n"
16075 " mkfs ext2 /dev/sda1\n"
16076 "\n"
16077 msgstr ""
16078
16079 #. type: =head2
16080 #: ../fish/guestfish.pod:130
16081 msgid "Start with a prepared disk"
16082 msgstr ""
16083
16084 #. type: textblock
16085 #: ../fish/guestfish.pod:132
16086 msgid ""
16087 "An alternate way to create a 100MB disk called C<test1.img> containing a "
16088 "single ext2-formatted partition:"
16089 msgstr ""
16090
16091 #. type: verbatim
16092 #: ../fish/guestfish.pod:135
16093 #, no-wrap
16094 msgid ""
16095 " guestfish -N fs\n"
16096 "\n"
16097 msgstr ""
16098
16099 #. type: textblock
16100 #: ../fish/guestfish.pod:137
16101 msgid "To list what is available do:"
16102 msgstr ""
16103
16104 #. type: verbatim
16105 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:1009
16106 #, no-wrap
16107 msgid ""
16108 " guestfish -N help | less\n"
16109 "\n"
16110 msgstr ""
16111
16112 #. type: =head2
16113 #: ../fish/guestfish.pod:141
16114 msgid "Remote control"
16115 msgstr ""
16116
16117 #. type: verbatim
16118 #: ../fish/guestfish.pod:143
16119 #, no-wrap
16120 msgid ""
16121 " eval \"`guestfish --listen`\"\n"
16122 " guestfish --remote add-ro disk.img\n"
16123 " guestfish --remote run\n"
16124 " guestfish --remote lvs\n"
16125 "\n"
16126 msgstr ""
16127
16128 #. type: textblock
16129 #: ../fish/guestfish.pod:154
16130 msgid "Displays general help on options."
16131 msgstr ""
16132
16133 #. type: =item
16134 #: ../fish/guestfish.pod:158
16135 msgid "B<--cmd-help>"
16136 msgstr ""
16137
16138 #. type: textblock
16139 #: ../fish/guestfish.pod:160
16140 msgid "Lists all available guestfish commands."
16141 msgstr ""
16142
16143 #. type: =item
16144 #: ../fish/guestfish.pod:162
16145 msgid "B<-h cmd>"
16146 msgstr ""
16147
16148 #. type: =item
16149 #: ../fish/guestfish.pod:164
16150 msgid "B<--cmd-help cmd>"
16151 msgstr ""
16152
16153 #. type: textblock
16154 #: ../fish/guestfish.pod:166
16155 msgid "Displays detailed help on a single command C<cmd>."
16156 msgstr ""
16157
16158 #. type: =item
16159 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:87
16160 msgid "B<-a image>"
16161 msgstr ""
16162
16163 #. type: =item
16164 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:89
16165 msgid "B<--add image>"
16166 msgstr ""
16167
16168 #. type: textblock
16169 #: ../fish/guestfish.pod:172
16170 msgid "Add a block device or virtual machine image to the shell."
16171 msgstr ""
16172
16173 #. type: textblock
16174 #: ../fish/guestfish.pod:177
16175 msgid ""
16176 "Using this flag is mostly equivalent to using the C<add> command, with "
16177 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
16178 "the I<--format=...> flag was given."
16179 msgstr ""
16180
16181 #. type: textblock
16182 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:100
16183 msgid ""
16184 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16185 "URI to use.  The default is to use the default libvirt connection."
16186 msgstr ""
16187
16188 #. type: =item
16189 #: ../fish/guestfish.pod:189
16190 msgid "B<--csh>"
16191 msgstr ""
16192
16193 #. type: textblock
16194 #: ../fish/guestfish.pod:191
16195 msgid ""
16196 "If using the I<--listen> option and a csh-like shell, use this option.  See "
16197 "section L</REMOTE CONTROL AND CSH> below."
16198 msgstr ""
16199
16200 #. type: =item
16201 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:104
16202 msgid "B<-d libvirt-domain>"
16203 msgstr ""
16204
16205 #. type: =item
16206 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:106
16207 msgid "B<--domain libvirt-domain>"
16208 msgstr ""
16209
16210 #. type: textblock
16211 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:108
16212 msgid ""
16213 "Add disks from the named libvirt domain.  If the I<--ro> option is also "
16214 "used, then any libvirt domain can be used.  However in write mode, only "
16215 "libvirt domains which are shut down can be named here."
16216 msgstr ""
16217
16218 #. type: textblock
16219 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:112
16220 msgid "Domain UUIDs can be used instead of names."
16221 msgstr ""
16222
16223 #. type: textblock
16224 #: ../fish/guestfish.pod:204
16225 msgid ""
16226 "Using this flag is mostly equivalent to using the C<add-domain> command, "
16227 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
16228 "if the I<--format:...> flag was given."
16229 msgstr ""
16230
16231 #. type: =item
16232 #: ../fish/guestfish.pod:208
16233 msgid "B<-D>"
16234 msgstr ""
16235
16236 #. type: =item
16237 #: ../fish/guestfish.pod:210
16238 msgid "B<--no-dest-paths>"
16239 msgstr ""
16240
16241 #. type: textblock
16242 #: ../fish/guestfish.pod:212
16243 msgid ""
16244 "Don't tab-complete paths on the guest filesystem.  It is useful to be able "
16245 "to hit the tab key to complete paths on the guest filesystem, but this "
16246 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16247 "allow this feature to be disabled."
16248 msgstr ""
16249
16250 #. type: textblock
16251 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:128
16252 msgid ""
16253 "When prompting for keys and passphrases, guestfish normally turns echoing "
16254 "off so you cannot see what you are typing.  If you are not worried about "
16255 "Tempest attacks and there is no one else in the room you can specify this "
16256 "flag to see what you are typing."
16257 msgstr ""
16258
16259 #. type: =item
16260 #: ../fish/guestfish.pod:224
16261 msgid "B<-f file>"
16262 msgstr ""
16263
16264 #. type: =item
16265 #: ../fish/guestfish.pod:226
16266 msgid "B<--file file>"
16267 msgstr ""
16268
16269 #. type: textblock
16270 #: ../fish/guestfish.pod:228
16271 msgid "Read commands from C<file>.  To write pure guestfish scripts, use:"
16272 msgstr ""
16273
16274 #. type: verbatim
16275 #: ../fish/guestfish.pod:231
16276 #, no-wrap
16277 msgid ""
16278 " #!/usr/bin/guestfish -f\n"
16279 "\n"
16280 msgstr ""
16281
16282 #. type: verbatim
16283 #: ../fish/guestfish.pod:244
16284 #, no-wrap
16285 msgid ""
16286 " guestfish --format=raw -a disk.img\n"
16287 "\n"
16288 msgstr ""
16289
16290 #. type: verbatim
16291 #: ../fish/guestfish.pod:248
16292 #, no-wrap
16293 msgid ""
16294 " guestfish --format=raw -a disk.img --format -a another.img\n"
16295 "\n"
16296 msgstr ""
16297
16298 #. type: textblock
16299 #: ../fish/guestfish.pod:253
16300 msgid ""
16301 "If you have untrusted raw-format guest disk images, you should use this "
16302 "option to specify the disk format.  This avoids a possible security problem "
16303 "with malicious guests (CVE-2010-3851).  See also L</add-drive-opts>."
16304 msgstr ""
16305
16306 #. type: =item
16307 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:157
16308 msgid "B<--inspector>"
16309 msgstr ""
16310
16311 #. type: textblock
16312 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:159
16313 msgid ""
16314 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16315 "system and mount filesystems as they would be mounted on the real virtual "
16316 "machine."
16317 msgstr ""
16318
16319 #. type: textblock
16320 #: ../fish/guestfish.pod:266
16321 msgid "Typical usage is either:"
16322 msgstr ""
16323
16324 #. type: verbatim
16325 #: ../fish/guestfish.pod:268
16326 #, no-wrap
16327 msgid ""
16328 " guestfish -d myguest -i\n"
16329 "\n"
16330 msgstr ""
16331
16332 #. type: textblock
16333 #: ../fish/guestfish.pod:270
16334 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16335 msgstr ""
16336
16337 #. type: verbatim
16338 #: ../fish/guestfish.pod:272
16339 #, no-wrap
16340 msgid ""
16341 " guestfish --ro -d myguest -i\n"
16342 "\n"
16343 msgstr ""
16344
16345 #. type: textblock
16346 #: ../fish/guestfish.pod:274
16347 msgid "(for active domains, readonly), or specify the block device directly:"
16348 msgstr ""
16349
16350 #. type: verbatim
16351 #: ../fish/guestfish.pod:276
16352 #, no-wrap
16353 msgid ""
16354 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
16355 "\n"
16356 msgstr ""
16357
16358 #. type: textblock
16359 #: ../fish/guestfish.pod:278
16360 msgid ""
16361 "Note that the command line syntax changed slightly over older versions of "
16362 "guestfish.  You can still use the old syntax:"
16363 msgstr ""
16364
16365 #. type: verbatim
16366 #: ../fish/guestfish.pod:281
16367 #, no-wrap
16368 msgid ""
16369 " guestfish [--ro] -i disk.img\n"
16370 "\n"
16371 msgstr ""
16372
16373 #. type: verbatim
16374 #: ../fish/guestfish.pod:283
16375 #, no-wrap
16376 msgid ""
16377 " guestfish [--ro] -i libvirt-domain\n"
16378 "\n"
16379 msgstr ""
16380
16381 #. type: textblock
16382 #: ../fish/guestfish.pod:285
16383 msgid ""
16384 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
16385 "then using other commands to mount the filesystems that were found."
16386 msgstr ""
16387
16388 #. type: =item
16389 #: ../fish/guestfish.pod:294
16390 msgid "B<--listen>"
16391 msgstr ""
16392
16393 #. type: textblock
16394 #: ../fish/guestfish.pod:296
16395 msgid ""
16396 "Fork into the background and listen for remote commands.  See section "
16397 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
16398 msgstr ""
16399
16400 #. type: =item
16401 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:168
16402 msgid "B<--live>"
16403 msgstr ""
16404
16405 #. type: textblock
16406 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:170
16407 msgid ""
16408 "Connect to a live virtual machine.  (Experimental, see "
16409 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
16410 msgstr ""
16411
16412 #. type: =item
16413 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:173
16414 msgid "B<-m dev[:mountpoint[:options]]>"
16415 msgstr ""
16416
16417 #. type: =item
16418 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:175
16419 msgid "B<--mount dev[:mountpoint[:options]]>"
16420 msgstr ""
16421
16422 #. type: textblock
16423 #: ../fish/guestfish.pod:308
16424 msgid "Mount the named partition or logical volume on the given mountpoint."
16425 msgstr ""
16426
16427 #. type: textblock
16428 #: ../fish/guestfish.pod:310
16429 msgid "If the mountpoint is omitted, it defaults to C</>."
16430 msgstr ""
16431
16432 #. type: textblock
16433 #: ../fish/guestfish.pod:312
16434 msgid "You have to mount something on C</> before most commands will work."
16435 msgstr ""
16436
16437 #. type: textblock
16438 #: ../fish/guestfish.pod:314
16439 msgid ""
16440 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16441 "launched."
16442 msgstr ""
16443
16444 #. type: textblock
16445 #: ../fish/guestfish.pod:317
16446 msgid ""
16447 "If you don't know what filesystems a disk image contains, you can either run "
16448 "guestfish without this option, then list the partitions, filesystems and LVs "
16449 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
16450 "commands), or you can use the L<virt-filesystems(1)> program."
16451 msgstr ""
16452
16453 #. type: textblock
16454 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:183
16455 msgid ""
16456 "The third (and rarely used) part of the mount parameter is the list of mount "
16457 "options used to mount the underlying filesystem.  If this is not given, then "
16458 "the mount options are either the empty string or C<ro> (the latter if the "
16459 "I<--ro> flag is used).  By specifying the mount options, you override this "
16460 "default choice.  Probably the only time you would use this is to enable ACLs "
16461 "and/or extended attributes if the filesystem can support them:"
16462 msgstr ""
16463
16464 #. type: verbatim
16465 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:191
16466 #, no-wrap
16467 msgid ""
16468 " -m /dev/sda1:/:acl,user_xattr\n"
16469 "\n"
16470 msgstr ""
16471
16472 #. type: textblock
16473 #: ../fish/guestfish.pod:333
16474 msgid "Using this flag is equivalent to using the C<mount-options> command."
16475 msgstr ""
16476
16477 #. type: =item
16478 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:193 ../resize/virt-resize.pod:358
16479 msgid "B<-n>"
16480 msgstr ""
16481
16482 #. type: =item
16483 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:195
16484 msgid "B<--no-sync>"
16485 msgstr ""
16486
16487 #. type: textblock
16488 #: ../fish/guestfish.pod:339
16489 msgid ""
16490 "Disable autosync.  This is enabled by default.  See the discussion of "
16491 "autosync in the L<guestfs(3)> manpage."
16492 msgstr ""
16493
16494 #. type: =item
16495 #: ../fish/guestfish.pod:342
16496 msgid "B<-N type>"
16497 msgstr ""
16498
16499 #. type: =item
16500 #: ../fish/guestfish.pod:344
16501 msgid "B<--new type>"
16502 msgstr ""
16503
16504 #. type: =item
16505 #: ../fish/guestfish.pod:346
16506 msgid "B<-N help>"
16507 msgstr ""
16508
16509 #. type: textblock
16510 #: ../fish/guestfish.pod:348
16511 msgid ""
16512 "Prepare a fresh disk image formatted as \"type\".  This is an alternative to "
16513 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16514 "preformatted disk with a filesystem and adds it.  See L</PREPARED DISK "
16515 "IMAGES> below."
16516 msgstr ""
16517
16518 #. type: =item
16519 #: ../fish/guestfish.pod:353
16520 msgid "B<--progress-bars>"
16521 msgstr ""
16522
16523 #. type: textblock
16524 #: ../fish/guestfish.pod:355
16525 msgid "Enable progress bars, even when guestfish is used non-interactively."
16526 msgstr ""
16527
16528 #. type: textblock
16529 #: ../fish/guestfish.pod:357
16530 msgid ""
16531 "Progress bars are enabled by default when guestfish is used as an "
16532 "interactive shell."
16533 msgstr ""
16534
16535 #. type: =item
16536 #: ../fish/guestfish.pod:360
16537 msgid "B<--no-progress-bars>"
16538 msgstr ""
16539
16540 #. type: textblock
16541 #: ../fish/guestfish.pod:362
16542 msgid "Disable progress bars."
16543 msgstr ""
16544
16545 #. type: =item
16546 #: ../fish/guestfish.pod:364
16547 msgid "B<--remote[=pid]>"
16548 msgstr ""
16549
16550 #. type: textblock
16551 #: ../fish/guestfish.pod:366
16552 msgid ""
16553 "Send remote commands to C<$GUESTFISH_PID> or C<pid>.  See section L</REMOTE "
16554 "CONTROL GUESTFISH OVER A SOCKET> below."
16555 msgstr ""
16556
16557 #. type: =item
16558 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:239 ../rescue/virt-rescue.pod:161
16559 msgid "B<-r>"
16560 msgstr ""
16561
16562 #. type: =item
16563 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:241 ../rescue/virt-rescue.pod:163
16564 msgid "B<--ro>"
16565 msgstr ""
16566
16567 #. type: textblock
16568 #: ../fish/guestfish.pod:373
16569 msgid ""
16570 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16571 "mounts are done read-only."
16572 msgstr ""
16573
16574 #. type: textblock
16575 #: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:167
16576 msgid ""
16577 "The option must always be used if the disk image or virtual machine might be "
16578 "running, and is generally recommended in cases where you don't need write "
16579 "access to the disk."
16580 msgstr ""
16581
16582 #. type: textblock
16583 #: ../fish/guestfish.pod:380
16584 msgid ""
16585 "Note that prepared disk images created with I<-N> are not affected by this "
16586 "option.  Also commands like C<add> are not affected - you have to specify "
16587 "the C<readonly:true> option explicitly if you need it."
16588 msgstr ""
16589
16590 #. type: textblock
16591 #: ../fish/guestfish.pod:384
16592 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
16593 msgstr ""
16594
16595 #. type: =item
16596 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:253 ../rescue/virt-rescue.pod:173
16597 msgid "B<--selinux>"
16598 msgstr ""
16599
16600 #. type: textblock
16601 #: ../fish/guestfish.pod:388
16602 msgid "Enable SELinux support for the guest.  See L<guestfs(3)/SELINUX>."
16603 msgstr ""
16604
16605 #. type: textblock
16606 #: ../fish/guestfish.pod:394
16607 msgid ""
16608 "Enable very verbose messages.  This is particularly useful if you find a "
16609 "bug."
16610 msgstr ""
16611
16612 #. type: textblock
16613 #: ../fish/guestfish.pod:401
16614 msgid "Display the guestfish / libguestfs version number and exit."
16615 msgstr ""
16616
16617 #. type: =item
16618 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:269 ../rescue/virt-rescue.pod:194
16619 msgid "B<-w>"
16620 msgstr ""
16621
16622 #. type: =item
16623 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:271 ../rescue/virt-rescue.pod:196
16624 msgid "B<--rw>"
16625 msgstr ""
16626
16627 #. type: textblock
16628 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:273
16629 msgid ""
16630 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16631 "mounts are done read-write."
16632 msgstr ""
16633
16634 #. type: textblock
16635 #: ../fish/guestfish.pod:410
16636 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
16637 msgstr ""
16638
16639 #. type: textblock
16640 #: ../fish/guestfish.pod:414
16641 msgid "Echo each command before executing it."
16642 msgstr ""
16643
16644 #. type: =head1
16645 #: ../fish/guestfish.pod:418
16646 msgid "COMMANDS ON COMMAND LINE"
16647 msgstr ""
16648
16649 #. type: textblock
16650 #: ../fish/guestfish.pod:420
16651 msgid "Any additional (non-option) arguments are treated as commands to execute."
16652 msgstr ""
16653
16654 #. type: textblock
16655 #: ../fish/guestfish.pod:423
16656 msgid ""
16657 "Commands to execute should be separated by a colon (C<:>), where the colon "
16658 "is a separate parameter.  Thus:"
16659 msgstr ""
16660
16661 #. type: verbatim
16662 #: ../fish/guestfish.pod:426
16663 #, no-wrap
16664 msgid ""
16665 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
16666 "\n"
16667 msgstr ""
16668
16669 #. type: textblock
16670 #: ../fish/guestfish.pod:428
16671 msgid ""
16672 "If there are no additional arguments, then we enter a shell, either an "
16673 "interactive shell with a prompt (if the input is a terminal) or a "
16674 "non-interactive shell."
16675 msgstr ""
16676
16677 #. type: textblock
16678 #: ../fish/guestfish.pod:432
16679 msgid ""
16680 "In either command line mode or non-interactive shell, the first command that "
16681 "gives an error causes the whole shell to exit.  In interactive mode (with a "
16682 "prompt) if a command fails, you can continue to enter commands."
16683 msgstr ""
16684
16685 #. type: =head1
16686 #: ../fish/guestfish.pod:437
16687 msgid "USING launch (OR run)"
16688 msgstr ""
16689
16690 #. type: textblock
16691 #: ../fish/guestfish.pod:439
16692 msgid ""
16693 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
16694 "then launch it, then mount any disks you need, and finally issue "
16695 "actions/commands.  So the general order of the day is:"
16696 msgstr ""
16697
16698 #. type: textblock
16699 #: ../fish/guestfish.pod:447
16700 msgid "add or -a/--add"
16701 msgstr ""
16702
16703 #. type: textblock
16704 #: ../fish/guestfish.pod:451
16705 msgid "launch (aka run)"
16706 msgstr ""
16707
16708 #. type: textblock
16709 #: ../fish/guestfish.pod:455
16710 msgid "mount or -m/--mount"
16711 msgstr ""
16712
16713 #. type: textblock
16714 #: ../fish/guestfish.pod:459
16715 msgid "any other commands"
16716 msgstr ""
16717
16718 #. type: textblock
16719 #: ../fish/guestfish.pod:463
16720 msgid ""
16721 "C<run> is a synonym for C<launch>.  You must C<launch> (or C<run>)  your "
16722 "guest before mounting or performing any other commands."
16723 msgstr ""
16724
16725 #. type: textblock
16726 #: ../fish/guestfish.pod:466
16727 msgid ""
16728 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
16729 "I<--new> options were given then C<run> is done automatically, simply "
16730 "because guestfish can't perform the action you asked for without doing this."
16731 msgstr ""
16732
16733 #. type: =head1
16734 #: ../fish/guestfish.pod:471
16735 msgid "OPENING DISKS FOR READ AND WRITE"
16736 msgstr ""
16737
16738 #. type: textblock
16739 #: ../fish/guestfish.pod:473
16740 msgid ""
16741 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
16742 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
16743 "I<-i> and I<-m> open disk images read-only or for writing."
16744 msgstr ""
16745
16746 #. type: textblock
16747 #: ../fish/guestfish.pod:478
16748 msgid ""
16749 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
16750 "opening disk images supplied on the command line for write.  To open a disk "
16751 "image read-only you have to do I<-a image --ro>."
16752 msgstr ""
16753
16754 #. type: textblock
16755 #: ../fish/guestfish.pod:482
16756 msgid ""
16757 "This matters: If you accidentally open a live VM disk image writable then "
16758 "you will cause irreversible disk corruption."
16759 msgstr ""
16760
16761 #. type: textblock
16762 #: ../fish/guestfish.pod:485
16763 msgid ""
16764 "In a future libguestfs we intend to change the default the other way.  Disk "
16765 "images will be opened read-only.  You will have to either specify "
16766 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
16767 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
16768 "access for disk images specified by those other command line options."
16769 msgstr ""
16770
16771 #. type: textblock
16772 #: ../fish/guestfish.pod:492
16773 msgid ""
16774 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
16775 "which does nothing (it is already the default).  However it is highly "
16776 "recommended that you use this option to indicate that you need write access, "
16777 "and prepare your scripts for the day when this option will be required for "
16778 "write access."
16779 msgstr ""
16780
16781 #. type: textblock
16782 #: ../fish/guestfish.pod:498
16783 msgid ""
16784 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
16785 "other libguestfs program apart from guestfish and guestmount."
16786 msgstr ""
16787
16788 #. type: =head1
16789 #: ../fish/guestfish.pod:501
16790 msgid "QUOTING"
16791 msgstr ""
16792
16793 #. type: textblock
16794 #: ../fish/guestfish.pod:503
16795 msgid ""
16796 "You can quote ordinary parameters using either single or double quotes.  For "
16797 "example:"
16798 msgstr ""
16799
16800 #. type: verbatim
16801 #: ../fish/guestfish.pod:506
16802 #, no-wrap
16803 msgid ""
16804 " add \"file with a space.img\"\n"
16805 "\n"
16806 msgstr ""
16807
16808 #. type: verbatim
16809 #: ../fish/guestfish.pod:508
16810 #, no-wrap
16811 msgid ""
16812 " rm '/file name'\n"
16813 "\n"
16814 msgstr ""
16815
16816 #. type: verbatim
16817 #: ../fish/guestfish.pod:510
16818 #, no-wrap
16819 msgid ""
16820 " rm '/\"'\n"
16821 "\n"
16822 msgstr ""
16823
16824 #. type: textblock
16825 #: ../fish/guestfish.pod:512
16826 msgid ""
16827 "A few commands require a list of strings to be passed.  For these, use a "
16828 "whitespace-separated list, enclosed in quotes.  Strings containing "
16829 "whitespace to be passed through must be enclosed in single quotes.  A "
16830 "literal single quote must be escaped with a backslash."
16831 msgstr ""
16832
16833 #. type: verbatim
16834 #: ../fish/guestfish.pod:517
16835 #, no-wrap
16836 msgid ""
16837 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
16838 " command \"/bin/echo 'foo      bar'\"\n"
16839 " command \"/bin/echo \\'foo\\'\"\n"
16840 "\n"
16841 msgstr ""
16842
16843 #. type: =head2
16844 #: ../fish/guestfish.pod:521
16845 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
16846 msgstr ""
16847
16848 #. type: textblock
16849 #: ../fish/guestfish.pod:523
16850 msgid ""
16851 "In double-quoted arguments (only) use backslash to insert special "
16852 "characters:"
16853 msgstr ""
16854
16855 #. type: =item
16856 #: ../fish/guestfish.pod:528
16857 msgid "C<\\a>"
16858 msgstr ""
16859
16860 #. type: textblock
16861 #: ../fish/guestfish.pod:530
16862 msgid "Alert (bell) character."
16863 msgstr ""
16864
16865 #. type: =item
16866 #: ../fish/guestfish.pod:532
16867 msgid "C<\\b>"
16868 msgstr ""
16869
16870 #. type: textblock
16871 #: ../fish/guestfish.pod:534
16872 msgid "Backspace character."
16873 msgstr ""
16874
16875 #. type: =item
16876 #: ../fish/guestfish.pod:536
16877 msgid "C<\\f>"
16878 msgstr ""
16879
16880 #. type: textblock
16881 #: ../fish/guestfish.pod:538
16882 msgid "Form feed character."
16883 msgstr ""
16884
16885 #. type: =item
16886 #: ../fish/guestfish.pod:540
16887 msgid "C<\\n>"
16888 msgstr ""
16889
16890 #. type: textblock
16891 #: ../fish/guestfish.pod:542
16892 msgid "Newline character."
16893 msgstr ""
16894
16895 #. type: =item
16896 #: ../fish/guestfish.pod:544
16897 msgid "C<\\r>"
16898 msgstr ""
16899
16900 #. type: textblock
16901 #: ../fish/guestfish.pod:546
16902 msgid "Carriage return character."
16903 msgstr ""
16904
16905 #. type: =item
16906 #: ../fish/guestfish.pod:548
16907 msgid "C<\\t>"
16908 msgstr ""
16909
16910 #. type: textblock
16911 #: ../fish/guestfish.pod:550
16912 msgid "Horizontal tab character."
16913 msgstr ""
16914
16915 #. type: =item
16916 #: ../fish/guestfish.pod:552
16917 msgid "C<\\v>"
16918 msgstr ""
16919
16920 #. type: textblock
16921 #: ../fish/guestfish.pod:554
16922 msgid "Vertical tab character."
16923 msgstr ""
16924
16925 #. type: =item
16926 #: ../fish/guestfish.pod:556
16927 msgid "C<\\\">"
16928 msgstr ""
16929
16930 #. type: textblock
16931 #: ../fish/guestfish.pod:558
16932 msgid "A literal double quote character."
16933 msgstr ""
16934
16935 #. type: =item
16936 #: ../fish/guestfish.pod:560
16937 msgid "C<\\ooo>"
16938 msgstr ""
16939
16940 #. type: textblock
16941 #: ../fish/guestfish.pod:562
16942 msgid ""
16943 "A character with octal value I<ooo>.  There must be precisely 3 octal digits "
16944 "(unlike C)."
16945 msgstr ""
16946
16947 #. type: =item
16948 #: ../fish/guestfish.pod:565
16949 msgid "C<\\xhh>"
16950 msgstr ""
16951
16952 #. type: textblock
16953 #: ../fish/guestfish.pod:567
16954 msgid "A character with hex value I<hh>.  There must be precisely 2 hex digits."
16955 msgstr ""
16956
16957 #. type: textblock
16958 #: ../fish/guestfish.pod:570
16959 msgid ""
16960 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
16961 "strings."
16962 msgstr ""
16963
16964 #. type: =item
16965 #: ../fish/guestfish.pod:573
16966 msgid "C<\\\\>"
16967 msgstr ""
16968
16969 #. type: textblock
16970 #: ../fish/guestfish.pod:575
16971 msgid "A literal backslash character."
16972 msgstr ""
16973
16974 #. type: =head1
16975 #: ../fish/guestfish.pod:579
16976 msgid "OPTIONAL ARGUMENTS"
16977 msgstr ""
16978
16979 #. type: textblock
16980 #: ../fish/guestfish.pod:581
16981 msgid ""
16982 "Some commands take optional arguments.  These arguments appear in this "
16983 "documentation as C<[argname:..]>.  You can use them as in these examples:"
16984 msgstr ""
16985
16986 #. type: verbatim
16987 #: ../fish/guestfish.pod:585
16988 #, no-wrap
16989 msgid ""
16990 " add-drive-opts filename\n"
16991 "\n"
16992 msgstr ""
16993
16994 #. type: verbatim
16995 #: ../fish/guestfish.pod:587
16996 #, no-wrap
16997 msgid ""
16998 " add-drive-opts filename readonly:true\n"
16999 "\n"
17000 msgstr ""
17001
17002 #. type: verbatim
17003 #: ../fish/guestfish.pod:589
17004 #, no-wrap
17005 msgid ""
17006 " add-drive-opts filename format:qcow2 readonly:false\n"
17007 "\n"
17008 msgstr ""
17009
17010 #. type: textblock
17011 #: ../fish/guestfish.pod:591
17012 msgid ""
17013 "Each optional argument can appear at most once.  All optional arguments must "
17014 "appear after the required ones."
17015 msgstr ""
17016
17017 #. type: =head1
17018 #: ../fish/guestfish.pod:594
17019 msgid "NUMBERS"
17020 msgstr ""
17021
17022 #. type: textblock
17023 #: ../fish/guestfish.pod:596
17024 msgid "This section applies to all commands which can take integers as parameters."
17025 msgstr ""
17026
17027 #. type: =head2
17028 #: ../fish/guestfish.pod:599
17029 msgid "SIZE SUFFIX"
17030 msgstr ""
17031
17032 #. type: textblock
17033 #: ../fish/guestfish.pod:601
17034 msgid ""
17035 "When the command takes a parameter measured in bytes, you can use one of the "
17036 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17037 msgstr ""
17038
17039 #. type: =item
17040 #: ../fish/guestfish.pod:607
17041 msgid "B<k> or B<K> or B<KiB>"
17042 msgstr ""
17043
17044 #. type: textblock
17045 #: ../fish/guestfish.pod:609
17046 msgid "The size in kilobytes (multiplied by 1024)."
17047 msgstr ""
17048
17049 #. type: =item
17050 #: ../fish/guestfish.pod:611
17051 msgid "B<KB>"
17052 msgstr ""
17053
17054 #. type: textblock
17055 #: ../fish/guestfish.pod:613
17056 msgid "The size in SI 1000 byte units."
17057 msgstr ""
17058
17059 #. type: =item
17060 #: ../fish/guestfish.pod:615
17061 msgid "B<M> or B<MiB>"
17062 msgstr ""
17063
17064 #. type: textblock
17065 #: ../fish/guestfish.pod:617
17066 msgid "The size in megabytes (multiplied by 1048576)."
17067 msgstr ""
17068
17069 #. type: =item
17070 #: ../fish/guestfish.pod:619
17071 msgid "B<MB>"
17072 msgstr ""
17073
17074 #. type: textblock
17075 #: ../fish/guestfish.pod:621
17076 msgid "The size in SI 1000000 byte units."
17077 msgstr ""
17078
17079 #. type: =item
17080 #: ../fish/guestfish.pod:623
17081 msgid "B<G> or B<GiB>"
17082 msgstr ""
17083
17084 #. type: textblock
17085 #: ../fish/guestfish.pod:625
17086 msgid "The size in gigabytes (multiplied by 2**30)."
17087 msgstr ""
17088
17089 #. type: =item
17090 #: ../fish/guestfish.pod:627
17091 msgid "B<GB>"
17092 msgstr ""
17093
17094 #. type: textblock
17095 #: ../fish/guestfish.pod:629
17096 msgid "The size in SI 10**9 byte units."
17097 msgstr ""
17098
17099 #. type: =item
17100 #: ../fish/guestfish.pod:631
17101 msgid "B<T> or B<TiB>"
17102 msgstr ""
17103
17104 #. type: textblock
17105 #: ../fish/guestfish.pod:633
17106 msgid "The size in terabytes (multiplied by 2**40)."
17107 msgstr ""
17108
17109 #. type: =item
17110 #: ../fish/guestfish.pod:635
17111 msgid "B<TB>"
17112 msgstr ""
17113
17114 #. type: textblock
17115 #: ../fish/guestfish.pod:637
17116 msgid "The size in SI 10**12 byte units."
17117 msgstr ""
17118
17119 #. type: =item
17120 #: ../fish/guestfish.pod:639
17121 msgid "B<P> or B<PiB>"
17122 msgstr ""
17123
17124 #. type: textblock
17125 #: ../fish/guestfish.pod:641
17126 msgid "The size in petabytes (multiplied by 2**50)."
17127 msgstr ""
17128
17129 #. type: =item
17130 #: ../fish/guestfish.pod:643
17131 msgid "B<PB>"
17132 msgstr ""
17133
17134 #. type: textblock
17135 #: ../fish/guestfish.pod:645
17136 msgid "The size in SI 10**15 byte units."
17137 msgstr ""
17138
17139 #. type: =item
17140 #: ../fish/guestfish.pod:647
17141 msgid "B<E> or B<EiB>"
17142 msgstr ""
17143
17144 #. type: textblock
17145 #: ../fish/guestfish.pod:649
17146 msgid "The size in exabytes (multiplied by 2**60)."
17147 msgstr ""
17148
17149 #. type: =item
17150 #: ../fish/guestfish.pod:651
17151 msgid "B<EB>"
17152 msgstr ""
17153
17154 #. type: textblock
17155 #: ../fish/guestfish.pod:653
17156 msgid "The size in SI 10**18 byte units."
17157 msgstr ""
17158
17159 #. type: =item
17160 #: ../fish/guestfish.pod:655
17161 msgid "B<Z> or B<ZiB>"
17162 msgstr ""
17163
17164 #. type: textblock
17165 #: ../fish/guestfish.pod:657
17166 msgid "The size in zettabytes (multiplied by 2**70)."
17167 msgstr ""
17168
17169 #. type: =item
17170 #: ../fish/guestfish.pod:659
17171 msgid "B<ZB>"
17172 msgstr ""
17173
17174 #. type: textblock
17175 #: ../fish/guestfish.pod:661
17176 msgid "The size in SI 10**21 byte units."
17177 msgstr ""
17178
17179 #. type: =item
17180 #: ../fish/guestfish.pod:663
17181 msgid "B<Y> or B<YiB>"
17182 msgstr ""
17183
17184 #. type: textblock
17185 #: ../fish/guestfish.pod:665
17186 msgid "The size in yottabytes (multiplied by 2**80)."
17187 msgstr ""
17188
17189 #. type: =item
17190 #: ../fish/guestfish.pod:667
17191 msgid "B<YB>"
17192 msgstr ""
17193
17194 #. type: textblock
17195 #: ../fish/guestfish.pod:669
17196 msgid "The size in SI 10**24 byte units."
17197 msgstr ""
17198
17199 #. type: verbatim
17200 #: ../fish/guestfish.pod:675
17201 #, no-wrap
17202 msgid ""
17203 " truncate-size /file 1G\n"
17204 "\n"
17205 msgstr ""
17206
17207 #. type: textblock
17208 #: ../fish/guestfish.pod:677
17209 msgid "would truncate the file to 1 gigabyte."
17210 msgstr ""
17211
17212 #. type: textblock
17213 #: ../fish/guestfish.pod:679
17214 msgid ""
17215 "Be careful because a few commands take sizes in kilobytes or megabytes "
17216 "(eg. the parameter to L</memsize> is specified in megabytes already).  "
17217 "Adding a suffix will probably not do what you expect."
17218 msgstr ""
17219
17220 #. type: =head2
17221 #: ../fish/guestfish.pod:683
17222 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17223 msgstr ""
17224
17225 #. type: textblock
17226 #: ../fish/guestfish.pod:685
17227 msgid ""
17228 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17229 "octal number or C<0x> to prefix a hexadecimal number.  For example:"
17230 msgstr ""
17231
17232 #. type: verbatim
17233 #: ../fish/guestfish.pod:688
17234 #, no-wrap
17235 msgid ""
17236 " 1234      decimal number 1234\n"
17237 " 02322     octal number, equivalent to decimal 1234\n"
17238 " 0x4d2     hexadecimal number, equivalent to decimal 1234\n"
17239 "\n"
17240 msgstr ""
17241
17242 #. type: textblock
17243 #: ../fish/guestfish.pod:692
17244 msgid ""
17245 "When using the C<chmod> command, you almost always want to specify an octal "
17246 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17247 "L<chmod(1)> program):"
17248 msgstr ""
17249
17250 #. type: verbatim
17251 #: ../fish/guestfish.pod:696
17252 #, no-wrap
17253 msgid ""
17254 " chmod 0777 /public  # OK\n"
17255 " chmod 777 /public   # WRONG! This is mode 777 decimal = 01411 octal.\n"
17256 "\n"
17257 msgstr ""
17258
17259 #. type: textblock
17260 #: ../fish/guestfish.pod:699
17261 msgid ""
17262 "Commands that return numbers usually print them in decimal, but some "
17263 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17264 "octal, preceeded by C<0>)."
17265 msgstr ""
17266
17267 #. type: =head1
17268 #: ../fish/guestfish.pod:703
17269 msgid "WILDCARDS AND GLOBBING"
17270 msgstr ""
17271
17272 #. type: textblock
17273 #: ../fish/guestfish.pod:705
17274 msgid ""
17275 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17276 "(globbing) by default.  So for example the following will not do what you "
17277 "expect:"
17278 msgstr ""
17279
17280 #. type: verbatim
17281 #: ../fish/guestfish.pod:709
17282 #, no-wrap
17283 msgid ""
17284 " rm-rf /home/*\n"
17285 "\n"
17286 msgstr ""
17287
17288 #. type: textblock
17289 #: ../fish/guestfish.pod:711
17290 msgid ""
17291 "Assuming you don't have a directory called literally C</home/*> then the "
17292 "above command will return an error."
17293 msgstr ""
17294
17295 #. type: textblock
17296 #: ../fish/guestfish.pod:714
17297 msgid "To perform wildcard expansion, use the C<glob> command."
17298 msgstr ""
17299
17300 #. type: verbatim
17301 #: ../fish/guestfish.pod:716
17302 #, no-wrap
17303 msgid ""
17304 " glob rm-rf /home/*\n"
17305 "\n"
17306 msgstr ""
17307
17308 #. type: textblock
17309 #: ../fish/guestfish.pod:718
17310 msgid ""
17311 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17312 "many times), equivalent to:"
17313 msgstr ""
17314
17315 #. type: verbatim
17316 #: ../fish/guestfish.pod:721
17317 #, no-wrap
17318 msgid ""
17319 " rm-rf /home/jim\n"
17320 " rm-rf /home/joe\n"
17321 " rm-rf /home/mary\n"
17322 "\n"
17323 msgstr ""
17324
17325 #. type: textblock
17326 #: ../fish/guestfish.pod:725
17327 msgid "C<glob> only works on simple guest paths and not on device names."
17328 msgstr ""
17329
17330 #. type: textblock
17331 #: ../fish/guestfish.pod:727
17332 msgid ""
17333 "If you have several parameters, each containing a wildcard, then glob will "
17334 "perform a Cartesian product."
17335 msgstr ""
17336
17337 #. type: =head1
17338 #: ../fish/guestfish.pod:730
17339 msgid "COMMENTS"
17340 msgstr ""
17341
17342 #. type: textblock
17343 #: ../fish/guestfish.pod:732
17344 msgid ""
17345 "Any line which starts with a I<#> character is treated as a comment and "
17346 "ignored.  The I<#> can optionally be preceeded by whitespace, but B<not> by "
17347 "a command.  For example:"
17348 msgstr ""
17349
17350 #. type: verbatim
17351 #: ../fish/guestfish.pod:736
17352 #, no-wrap
17353 msgid ""
17354 " # this is a comment\n"
17355 "         # this is a comment\n"
17356 " foo # NOT a comment\n"
17357 "\n"
17358 msgstr ""
17359
17360 #. type: textblock
17361 #: ../fish/guestfish.pod:740
17362 msgid "Blank lines are also ignored."
17363 msgstr ""
17364
17365 #. type: =head1
17366 #: ../fish/guestfish.pod:742
17367 msgid "RUNNING COMMANDS LOCALLY"
17368 msgstr ""
17369
17370 #. type: textblock
17371 #: ../fish/guestfish.pod:744
17372 msgid ""
17373 "Any line which starts with a I<!> character is treated as a command sent to "
17374 "the local shell (C</bin/sh> or whatever L<system(3)> uses).  For example:"
17375 msgstr ""
17376
17377 #. type: verbatim
17378 #: ../fish/guestfish.pod:748
17379 #, no-wrap
17380 msgid ""
17381 " !mkdir local\n"
17382 " tgz-out /remote local/remote-data.tar.gz\n"
17383 "\n"
17384 msgstr ""
17385
17386 #. type: textblock
17387 #: ../fish/guestfish.pod:751
17388 msgid ""
17389 "will create a directory C<local> on the host, and then export the contents "
17390 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>.  "
17391 "(See C<tgz-out>)."
17392 msgstr ""
17393
17394 #. type: textblock
17395 #: ../fish/guestfish.pod:755
17396 msgid ""
17397 "To change the local directory, use the C<lcd> command.  C<!cd> will have no "
17398 "effect, due to the way that subprocesses work in Unix."
17399 msgstr ""
17400
17401 #. type: =head2
17402 #: ../fish/guestfish.pod:758
17403 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
17404 msgstr ""
17405
17406 #. type: textblock
17407 #: ../fish/guestfish.pod:760
17408 msgid ""
17409 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
17410 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
17411 "and executed as guestfish commands."
17412 msgstr ""
17413
17414 #. type: textblock
17415 #: ../fish/guestfish.pod:764
17416 msgid ""
17417 "Thus you can use shell script to construct arbitrary guestfish commands "
17418 "which are then parsed by guestfish."
17419 msgstr ""
17420
17421 #. type: textblock
17422 #: ../fish/guestfish.pod:767
17423 msgid ""
17424 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
17425 "through C</foo.100>) using guestfish commands alone.  However this is simple "
17426 "if we use a shell script to create the guestfish commands for us:"
17427 msgstr ""
17428
17429 #. type: verbatim
17430 #: ../fish/guestfish.pod:772
17431 #, no-wrap
17432 msgid ""
17433 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
17434 "\n"
17435 msgstr ""
17436
17437 #. type: textblock
17438 #: ../fish/guestfish.pod:774
17439 msgid "or with names like C</foo.001>:"
17440 msgstr ""
17441
17442 #. type: verbatim
17443 #: ../fish/guestfish.pod:776
17444 #, no-wrap
17445 msgid ""
17446 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
17447 "\n"
17448 msgstr ""
17449
17450 #. type: textblock
17451 #: ../fish/guestfish.pod:778
17452 msgid ""
17453 "When using guestfish interactively it can be helpful to just run the shell "
17454 "script first (ie. remove the initial C<E<lt>> character so it is just an "
17455 "ordinary I<!> local command), see what guestfish commands it would run, and "
17456 "when you are happy with those prepend the C<E<lt>> character to run the "
17457 "guestfish commands for real."
17458 msgstr ""
17459
17460 #. type: =head1
17461 #: ../fish/guestfish.pod:784
17462 msgid "PIPES"
17463 msgstr ""
17464
17465 #. type: textblock
17466 #: ../fish/guestfish.pod:786
17467 msgid ""
17468 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17469 "command (a guestfish command) to the second command (any host command).  For "
17470 "example:"
17471 msgstr ""
17472
17473 #. type: verbatim
17474 #: ../fish/guestfish.pod:790
17475 #, no-wrap
17476 msgid ""
17477 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17478 "\n"
17479 msgstr ""
17480
17481 #. type: textblock
17482 #: ../fish/guestfish.pod:792
17483 msgid ""
17484 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17485 "program).  The above command would list all accounts in the guest filesystem "
17486 "which have UID 0, ie. root accounts including backdoors.  Other examples:"
17487 msgstr ""
17488
17489 #. type: verbatim
17490 #: ../fish/guestfish.pod:797
17491 #, no-wrap
17492 msgid ""
17493 " hexdump /bin/ls | head\n"
17494 " list-devices | tail -1\n"
17495 " tgz-out / - | tar ztf -\n"
17496 "\n"
17497 msgstr ""
17498
17499 #. type: textblock
17500 #: ../fish/guestfish.pod:801
17501 msgid ""
17502 "The space before the pipe symbol is required, any space after the pipe "
17503 "symbol is optional.  Everything after the pipe symbol is just passed "
17504 "straight to the host shell, so it can contain redirections, globs and "
17505 "anything else that makes sense on the host side."
17506 msgstr ""
17507
17508 #. type: textblock
17509 #: ../fish/guestfish.pod:806
17510 msgid ""
17511 "To use a literal argument which begins with a pipe symbol, you have to quote "
17512 "it, eg:"
17513 msgstr ""
17514
17515 #. type: verbatim
17516 #: ../fish/guestfish.pod:809
17517 #, no-wrap
17518 msgid ""
17519 " echo \"|\"\n"
17520 "\n"
17521 msgstr ""
17522
17523 #. type: =head1
17524 #: ../fish/guestfish.pod:811
17525 msgid "HOME DIRECTORIES"
17526 msgstr ""
17527
17528 #. type: textblock
17529 #: ../fish/guestfish.pod:813
17530 msgid ""
17531 "If a parameter starts with the character C<~> then the tilde may be expanded "
17532 "as a home directory path (either C<~> for the current user's home directory, "
17533 "or C<~user> for another user)."
17534 msgstr ""
17535
17536 #. type: textblock
17537 #: ../fish/guestfish.pod:817
17538 msgid ""
17539 "Note that home directory expansion happens for users known I<on the host>, "
17540 "not in the guest filesystem."
17541 msgstr ""
17542
17543 #. type: textblock
17544 #: ../fish/guestfish.pod:820
17545 msgid ""
17546 "To use a literal argument which begins with a tilde, you have to quote it, "
17547 "eg:"
17548 msgstr ""
17549
17550 #. type: verbatim
17551 #: ../fish/guestfish.pod:823
17552 #, no-wrap
17553 msgid ""
17554 " echo \"~\"\n"
17555 "\n"
17556 msgstr ""
17557
17558 #. type: =head2
17559 #: ../fish/guestfish.pod:825 ../src/guestfs.pod:519
17560 msgid "ENCRYPTED DISKS"
17561 msgstr ""
17562
17563 #. type: textblock
17564 #: ../fish/guestfish.pod:827
17565 msgid ""
17566 "Libguestfs has some support for Linux guests encrypted according to the "
17567 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17568 "disk encryption systems used by modern Linux guests.  Currently only "
17569 "LVM-on-LUKS is supported."
17570 msgstr ""
17571
17572 #. type: textblock
17573 #: ../fish/guestfish.pod:832
17574 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17575 msgstr ""
17576
17577 #. type: verbatim
17578 #: ../fish/guestfish.pod:834
17579 #, no-wrap
17580 msgid ""
17581 " ><fs> vfs-type /dev/sda2\n"
17582 " crypto_LUKS\n"
17583 "\n"
17584 msgstr ""
17585
17586 #. type: textblock
17587 #: ../fish/guestfish.pod:837
17588 msgid ""
17589 "Then open those devices using L</luks-open>.  This creates a device-mapper "
17590 "device called C</dev/mapper/luksdev>."
17591 msgstr ""
17592
17593 #. type: verbatim
17594 #: ../fish/guestfish.pod:840
17595 #, no-wrap
17596 msgid ""
17597 " ><fs> luks-open /dev/sda2 luksdev\n"
17598 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17599 "\n"
17600 msgstr ""
17601
17602 #. type: textblock
17603 #: ../fish/guestfish.pod:843
17604 msgid ""
17605 "Finally you have to tell LVM to scan for volume groups on the newly created "
17606 "mapper device:"
17607 msgstr ""
17608
17609 #. type: verbatim
17610 #: ../fish/guestfish.pod:846
17611 #, no-wrap
17612 msgid ""
17613 " vgscan\n"
17614 " vg-activate-all true\n"
17615 "\n"
17616 msgstr ""
17617
17618 #. type: textblock
17619 #: ../fish/guestfish.pod:849
17620 msgid "The logical volume(s) can now be mounted in the usual way."
17621 msgstr ""
17622
17623 #. type: textblock
17624 #: ../fish/guestfish.pod:851
17625 msgid ""
17626 "Before closing a LUKS device you must unmount any logical volumes on it and "
17627 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17628 "one.  Then you can close the mapper device:"
17629 msgstr ""
17630
17631 #. type: verbatim
17632 #: ../fish/guestfish.pod:855
17633 #, no-wrap
17634 msgid ""
17635 " vg-activate false /dev/VG\n"
17636 " luks-close /dev/mapper/luksdev\n"
17637 "\n"
17638 msgstr ""
17639
17640 #. type: textblock
17641 #: ../fish/guestfish.pod:860
17642 msgid ""
17643 "If a path is prefixed with C<win:> then you can use Windows-style drive "
17644 "letters and paths (with some limitations).  The following commands are "
17645 "equivalent:"
17646 msgstr ""
17647
17648 #. type: verbatim
17649 #: ../fish/guestfish.pod:864
17650 #, no-wrap
17651 msgid ""
17652 " file /WINDOWS/system32/config/system.LOG\n"
17653 "\n"
17654 msgstr ""
17655
17656 #. type: verbatim
17657 #: ../fish/guestfish.pod:866
17658 #, no-wrap
17659 msgid ""
17660 " file win:\\windows\\system32\\config\\system.log\n"
17661 "\n"
17662 msgstr ""
17663
17664 #. type: verbatim
17665 #: ../fish/guestfish.pod:868
17666 #, no-wrap
17667 msgid ""
17668 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
17669 "\n"
17670 msgstr ""
17671
17672 #. type: textblock
17673 #: ../fish/guestfish.pod:870
17674 msgid ""
17675 "The parameter is rewritten \"behind the scenes\" by looking up the position "
17676 "where the drive is mounted, prepending that to the path, changing all "
17677 "backslash characters to forward slash, then resolving the result using "
17678 "L</case-sensitive-path>.  For example if the E: drive was mounted on C</e> "
17679 "then the parameter might be rewritten like this:"
17680 msgstr ""
17681
17682 #. type: verbatim
17683 #: ../fish/guestfish.pod:876
17684 #, no-wrap
17685 msgid ""
17686 " win:e:\\foo\\bar => /e/FOO/bar\n"
17687 "\n"
17688 msgstr ""
17689
17690 #. type: textblock
17691 #: ../fish/guestfish.pod:878
17692 msgid "This only works in argument positions that expect a path."
17693 msgstr ""
17694
17695 #. type: =head1
17696 #: ../fish/guestfish.pod:880
17697 msgid "UPLOADING AND DOWNLOADING FILES"
17698 msgstr ""
17699
17700 #. type: textblock
17701 #: ../fish/guestfish.pod:882
17702 msgid ""
17703 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
17704 "others which upload from or download to a local file, you can use the "
17705 "special filename C<-> to mean \"from stdin\" or \"to stdout\".  For example:"
17706 msgstr ""
17707
17708 #. type: verbatim
17709 #: ../fish/guestfish.pod:886
17710 #, no-wrap
17711 msgid ""
17712 " upload - /foo\n"
17713 "\n"
17714 msgstr ""
17715
17716 #. type: textblock
17717 #: ../fish/guestfish.pod:888
17718 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
17719 msgstr ""
17720
17721 #. type: verbatim
17722 #: ../fish/guestfish.pod:891
17723 #, no-wrap
17724 msgid ""
17725 " tar-out /etc - | tar tf -\n"
17726 "\n"
17727 msgstr ""
17728
17729 #. type: textblock
17730 #: ../fish/guestfish.pod:893
17731 msgid ""
17732 "writes the tarball to stdout and then pipes that into the external \"tar\" "
17733 "command (see L</PIPES>)."
17734 msgstr ""
17735
17736 #. type: textblock
17737 #: ../fish/guestfish.pod:896
17738 msgid ""
17739 "When using C<-> to read from stdin, the input is read up to the end of "
17740 "stdin.  You can also use a special \"heredoc\"-like syntax to read up to "
17741 "some arbitrary end marker:"
17742 msgstr ""
17743
17744 #. type: verbatim
17745 #: ../fish/guestfish.pod:900
17746 #, no-wrap
17747 msgid ""
17748 " upload -<<END /foo\n"
17749 " input line 1\n"
17750 " input line 2\n"
17751 " input line 3\n"
17752 " END\n"
17753 "\n"
17754 msgstr ""
17755
17756 #. type: textblock
17757 #: ../fish/guestfish.pod:906
17758 msgid ""
17759 "Any string of characters can be used instead of C<END>.  The end marker must "
17760 "appear on a line of its own, without any preceeding or following characters "
17761 "(not even spaces)."
17762 msgstr ""
17763
17764 #. type: textblock
17765 #: ../fish/guestfish.pod:910
17766 msgid ""
17767 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
17768 "upload local files (so-called \"FileIn\" parameters in the generator)."
17769 msgstr ""
17770
17771 #. type: =head1
17772 #: ../fish/guestfish.pod:913
17773 msgid "EXIT ON ERROR BEHAVIOUR"
17774 msgstr ""
17775
17776 #. type: textblock
17777 #: ../fish/guestfish.pod:915
17778 msgid ""
17779 "By default, guestfish will ignore any errors when in interactive mode "
17780 "(ie. taking commands from a human over a tty), and will exit on the first "
17781 "error in non-interactive mode (scripts, commands given on the command line)."
17782 msgstr ""
17783
17784 #. type: textblock
17785 #: ../fish/guestfish.pod:920
17786 msgid ""
17787 "If you prefix a command with a I<-> character, then that command will not "
17788 "cause guestfish to exit, even if that (one) command returns an error."
17789 msgstr ""
17790
17791 #. type: =head1
17792 #: ../fish/guestfish.pod:924
17793 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
17794 msgstr ""
17795
17796 #. type: textblock
17797 #: ../fish/guestfish.pod:926
17798 msgid ""
17799 "Guestfish can be remote-controlled over a socket.  This is useful "
17800 "particularly in shell scripts where you want to make several different "
17801 "changes to a filesystem, but you don't want the overhead of starting up a "
17802 "guestfish process each time."
17803 msgstr ""
17804
17805 #. type: textblock
17806 #: ../fish/guestfish.pod:931
17807 msgid "Start a guestfish server process using:"
17808 msgstr ""
17809
17810 #. type: verbatim
17811 #: ../fish/guestfish.pod:933
17812 #, no-wrap
17813 msgid ""
17814 " eval \"`guestfish --listen`\"\n"
17815 "\n"
17816 msgstr ""
17817
17818 #. type: textblock
17819 #: ../fish/guestfish.pod:935
17820 msgid "and then send it commands by doing:"
17821 msgstr ""
17822
17823 #. type: verbatim
17824 #: ../fish/guestfish.pod:937
17825 #, no-wrap
17826 msgid ""
17827 " guestfish --remote cmd [...]\n"
17828 "\n"
17829 msgstr ""
17830
17831 #. type: textblock
17832 #: ../fish/guestfish.pod:939
17833 msgid "To cause the server to exit, send it the exit command:"
17834 msgstr ""
17835
17836 #. type: textblock
17837 #: ../fish/guestfish.pod:943
17838 msgid ""
17839 "Note that the server will normally exit if there is an error in a command.  "
17840 "You can change this in the usual way.  See section L</EXIT ON ERROR "
17841 "BEHAVIOUR>."
17842 msgstr ""
17843
17844 #. type: =head2
17845 #: ../fish/guestfish.pod:947
17846 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
17847 msgstr ""
17848
17849 #. type: textblock
17850 #: ../fish/guestfish.pod:949
17851 msgid ""
17852 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
17853 "is how the I<--remote> option knows where to send the commands.  You can "
17854 "have several guestfish listener processes running using:"
17855 msgstr ""
17856
17857 #. type: verbatim
17858 #: ../fish/guestfish.pod:953
17859 #, no-wrap
17860 msgid ""
17861 " eval \"`guestfish --listen`\"\n"
17862 " pid1=$GUESTFISH_PID\n"
17863 " eval \"`guestfish --listen`\"\n"
17864 " pid2=$GUESTFISH_PID\n"
17865 " ...\n"
17866 " guestfish --remote=$pid1 cmd\n"
17867 " guestfish --remote=$pid2 cmd\n"
17868 "\n"
17869 msgstr ""
17870
17871 #. type: =head2
17872 #: ../fish/guestfish.pod:961
17873 msgid "REMOTE CONTROL AND CSH"
17874 msgstr ""
17875
17876 #. type: textblock
17877 #: ../fish/guestfish.pod:963
17878 msgid ""
17879 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
17880 "option:"
17881 msgstr ""
17882
17883 #. type: verbatim
17884 #: ../fish/guestfish.pod:966
17885 #, no-wrap
17886 msgid ""
17887 " eval \"`guestfish --listen --csh`\"\n"
17888 "\n"
17889 msgstr ""
17890
17891 #. type: =head2
17892 #: ../fish/guestfish.pod:968
17893 msgid "REMOTE CONTROL DETAILS"
17894 msgstr ""
17895
17896 #. type: textblock
17897 #: ../fish/guestfish.pod:970
17898 msgid ""
17899 "Remote control happens over a Unix domain socket called "
17900 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
17901 "of the process, and C<$PID> is the process ID of the server."
17902 msgstr ""
17903
17904 #. type: textblock
17905 #: ../fish/guestfish.pod:974
17906 msgid "Guestfish client and server versions must match exactly."
17907 msgstr ""
17908
17909 #. type: =head2
17910 #: ../fish/guestfish.pod:976
17911 msgid "REMOTE CONTROL RUN COMMAND HANGING"
17912 msgstr ""
17913
17914 #. type: textblock
17915 #: ../fish/guestfish.pod:978
17916 msgid ""
17917 "Using the C<run> (or C<launch>) command remotely in a command substitution "
17918 "context hangs, ie. don't do (note the backquotes):"
17919 msgstr ""
17920
17921 #. type: verbatim
17922 #: ../fish/guestfish.pod:981
17923 #, no-wrap
17924 msgid ""
17925 " a=`guestfish --remote run`\n"
17926 "\n"
17927 msgstr ""
17928
17929 #. type: textblock
17930 #: ../fish/guestfish.pod:983
17931 msgid ""
17932 "Since the C<run> command produces no output on stdout, this is not useful "
17933 "anyway.  For further information see "
17934 "L<https://bugzilla.redhat.com/show_bug.cgi?id=592910>."
17935 msgstr ""
17936
17937 #. type: =head1
17938 #: ../fish/guestfish.pod:987
17939 msgid "PREPARED DISK IMAGES"
17940 msgstr ""
17941
17942 #. type: textblock
17943 #: ../fish/guestfish.pod:989
17944 msgid ""
17945 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
17946 "preformatted disk images that guestfish can make for you to save typing.  "
17947 "This is particularly useful for testing purposes.  This option is used "
17948 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
17949 "can be mixed with I<-a>)."
17950 msgstr ""
17951
17952 #. type: textblock
17953 #: ../fish/guestfish.pod:995
17954 msgid ""
17955 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
17956 "the second and so on.  Existing files in the current directory are "
17957 "I<overwritten>."
17958 msgstr ""
17959
17960 #. type: textblock
17961 #: ../fish/guestfish.pod:999
17962 msgid ""
17963 "The type briefly describes how the disk should be sized, partitioned, how "
17964 "filesystem(s) should be created, and how content should be added.  "
17965 "Optionally the type can be followed by extra parameters, separated by C<:> "
17966 "(colon) characters.  For example, I<-N fs> creates a default 100MB, "
17967 "sparsely-allocated disk, containing a single partition, with the partition "
17968 "formatted as ext2.  I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
17969 "on a 1GB disk instead."
17970 msgstr ""
17971
17972 #. type: textblock
17973 #: ../fish/guestfish.pod:1007
17974 msgid "To list the available types and any extra parameters they take, run:"
17975 msgstr ""
17976
17977 #. type: textblock
17978 #: ../fish/guestfish.pod:1011
17979 msgid ""
17980 "Note that the prepared filesystem is not mounted.  You would usually have to "
17981 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
17982 msgstr ""
17983
17984 #. type: textblock
17985 #: ../fish/guestfish.pod:1015
17986 msgid ""
17987 "If any I<-N> or I<--new> options are given, the guest is automatically "
17988 "launched."
17989 msgstr ""
17990
17991 #. type: textblock
17992 #: ../fish/guestfish.pod:1020
17993 msgid "Create a 100MB disk with an ext4-formatted partition:"
17994 msgstr ""
17995
17996 #. type: verbatim
17997 #: ../fish/guestfish.pod:1022
17998 #, no-wrap
17999 msgid ""
18000 " guestfish -N fs:ext4\n"
18001 "\n"
18002 msgstr ""
18003
18004 #. type: textblock
18005 #: ../fish/guestfish.pod:1024
18006 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18007 msgstr ""
18008
18009 #. type: verbatim
18010 #: ../fish/guestfish.pod:1026
18011 #, no-wrap
18012 msgid ""
18013 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18014 "\n"
18015 msgstr ""
18016
18017 #. type: textblock
18018 #: ../fish/guestfish.pod:1028
18019 msgid "Create a blank 200MB disk:"
18020 msgstr ""
18021
18022 #. type: verbatim
18023 #: ../fish/guestfish.pod:1030
18024 #, no-wrap
18025 msgid ""
18026 " guestfish -N disk:200M\n"
18027 "\n"
18028 msgstr ""
18029
18030 #. type: =head1
18031 #: ../fish/guestfish.pod:1032
18032 msgid "PROGRESS BARS"
18033 msgstr ""
18034
18035 #. type: textblock
18036 #: ../fish/guestfish.pod:1034
18037 msgid ""
18038 "Some (not all) long-running commands send progress notification messages as "
18039 "they are running.  Guestfish turns these messages into progress bars."
18040 msgstr ""
18041
18042 #. type: textblock
18043 #: ../fish/guestfish.pod:1038
18044 msgid ""
18045 "When a command that supports progress bars takes longer than two seconds to "
18046 "run, and if progress bars are enabled, then you will see one appearing below "
18047 "the command:"
18048 msgstr ""
18049
18050 #. type: verbatim
18051 #: ../fish/guestfish.pod:1042
18052 #, no-wrap
18053 msgid ""
18054 " ><fs> copy-size /large-file /another-file 2048M\n"
18055 " / 10% [#####-----------------------------------------] 00:30\n"
18056 "\n"
18057 msgstr ""
18058
18059 #. type: textblock
18060 #: ../fish/guestfish.pod:1045
18061 msgid ""
18062 "The spinner on the left hand side moves round once for every progress "
18063 "notification received from the backend.  This is a (reasonably) golden "
18064 "assurance that the command is \"doing something\" even if the progress bar "
18065 "is not moving, because the command is able to send the progress "
18066 "notifications.  When the bar reaches 100% and the command finishes, the "
18067 "spinner disappears."
18068 msgstr ""
18069
18070 #. type: textblock
18071 #: ../fish/guestfish.pod:1052
18072 msgid ""
18073 "Progress bars are enabled by default when guestfish is used interactively.  "
18074 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18075 "and you can disable them completely using I<--no-progress-bars>."
18076 msgstr ""
18077
18078 #. type: =head1
18079 #: ../fish/guestfish.pod:1057
18080 msgid "GUESTFISH COMMANDS"
18081 msgstr ""
18082
18083 #. type: textblock
18084 #: ../fish/guestfish.pod:1059
18085 msgid ""
18086 "The commands in this section are guestfish convenience commands, in other "
18087 "words, they are not part of the L<guestfs(3)> API."
18088 msgstr ""
18089
18090 #. type: =head2
18091 #: ../fish/guestfish.pod:1062
18092 msgid "help"
18093 msgstr ""
18094
18095 #. type: verbatim
18096 #: ../fish/guestfish.pod:1064
18097 #, no-wrap
18098 msgid ""
18099 " help\n"
18100 " help cmd\n"
18101 "\n"
18102 msgstr ""
18103
18104 #. type: textblock
18105 #: ../fish/guestfish.pod:1067
18106 msgid "Without any parameter, this provides general help."
18107 msgstr ""
18108
18109 #. type: textblock
18110 #: ../fish/guestfish.pod:1069
18111 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18112 msgstr ""
18113
18114 #. type: =head2
18115 #: ../fish/guestfish.pod:1071
18116 msgid "quit | exit"
18117 msgstr ""
18118
18119 #. type: textblock
18120 #: ../fish/guestfish.pod:1073
18121 msgid "This exits guestfish.  You can also use C<^D> key."
18122 msgstr ""
18123
18124 #. type: textblock
18125 #: ../fish/guestfish.pod:1075
18126 msgid "@FISH_COMMANDS@"
18127 msgstr ""
18128
18129 #. type: =head1
18130 #: ../fish/guestfish.pod:1077
18131 msgid "COMMANDS"
18132 msgstr ""
18133
18134 #. type: textblock
18135 #: ../fish/guestfish.pod:1079 ../src/guestfs.pod:1502
18136 msgid "@ACTIONS@"
18137 msgstr ""
18138
18139 #. type: textblock
18140 #: ../fish/guestfish.pod:1083
18141 msgid ""
18142 "guestfish returns 0 if the commands completed without error, or 1 if there "
18143 "was an error."
18144 msgstr ""
18145
18146 #. type: =item
18147 #: ../fish/guestfish.pod:1090
18148 msgid "EDITOR"
18149 msgstr ""
18150
18151 #. type: textblock
18152 #: ../fish/guestfish.pod:1092
18153 msgid ""
18154 "The C<edit> command uses C<$EDITOR> as the editor.  If not set, it uses "
18155 "C<vi>."
18156 msgstr ""
18157
18158 #. type: =item
18159 #: ../fish/guestfish.pod:1095 ../src/guestfs.pod:3107
18160 msgid "FEBOOTSTRAP_KERNEL"
18161 msgstr ""
18162
18163 #. type: =item
18164 #: ../fish/guestfish.pod:1097 ../src/guestfs.pod:3109
18165 msgid "FEBOOTSTRAP_MODULES"
18166 msgstr ""
18167
18168 #. type: textblock
18169 #: ../fish/guestfish.pod:1099 ../src/guestfs.pod:3111
18170 msgid ""
18171 "These two environment variables allow the kernel that libguestfs uses in the "
18172 "appliance to be selected.  If C<$FEBOOTSTRAP_KERNEL> is not set, then the "
18173 "most recent host kernel is chosen.  For more information about kernel "
18174 "selection, see L<febootstrap-supermin-helper(8)>.  This feature is only "
18175 "available in febootstrap E<ge> 3.8."
18176 msgstr ""
18177
18178 #. type: =item
18179 #: ../fish/guestfish.pod:1105
18180 msgid "GUESTFISH_DISPLAY_IMAGE"
18181 msgstr ""
18182
18183 #. type: textblock
18184 #: ../fish/guestfish.pod:1107
18185 msgid ""
18186 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images.  "
18187 "If not set, it uses L<display(1)>."
18188 msgstr ""
18189
18190 #. type: =item
18191 #: ../fish/guestfish.pod:1110
18192 msgid "GUESTFISH_PID"
18193 msgstr ""
18194
18195 #. type: textblock
18196 #: ../fish/guestfish.pod:1112
18197 msgid ""
18198 "Used with the I<--remote> option to specify the remote guestfish process to "
18199 "control.  See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
18200 msgstr ""
18201
18202 #. type: =item
18203 #: ../fish/guestfish.pod:1116
18204 msgid "HEXEDITOR"
18205 msgstr ""
18206
18207 #. type: textblock
18208 #: ../fish/guestfish.pod:1118
18209 msgid ""
18210 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor.  If "
18211 "not specified, the external L<hexedit(1)> program is used."
18212 msgstr ""
18213
18214 #. type: =item
18215 #: ../fish/guestfish.pod:1122
18216 msgid "HOME"
18217 msgstr ""
18218
18219 #. type: textblock
18220 #: ../fish/guestfish.pod:1124
18221 msgid ""
18222 "If compiled with GNU readline support, various files in the home directory "
18223 "can be used.  See L</FILES>."
18224 msgstr ""
18225
18226 #. type: =item
18227 #: ../fish/guestfish.pod:1127 ../src/guestfs.pod:3117
18228 msgid "LIBGUESTFS_APPEND"
18229 msgstr ""
18230
18231 #. type: textblock
18232 #: ../fish/guestfish.pod:1129 ../src/guestfs.pod:3119
18233 msgid "Pass additional options to the guest kernel."
18234 msgstr ""
18235
18236 #. type: =item
18237 #: ../fish/guestfish.pod:1131 ../src/guestfs.pod:3121
18238 msgid "LIBGUESTFS_DEBUG"
18239 msgstr ""
18240
18241 #. type: textblock
18242 #: ../fish/guestfish.pod:1133
18243 msgid ""
18244 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages.  This has the same "
18245 "effect as using the B<-v> option."
18246 msgstr ""
18247
18248 #. type: =item
18249 #: ../fish/guestfish.pod:1136 ../src/guestfs.pod:3126
18250 msgid "LIBGUESTFS_MEMSIZE"
18251 msgstr ""
18252
18253 #. type: textblock
18254 #: ../fish/guestfish.pod:1138 ../src/guestfs.pod:3128
18255 msgid "Set the memory allocated to the qemu process, in megabytes.  For example:"
18256 msgstr ""
18257
18258 #. type: verbatim
18259 #: ../fish/guestfish.pod:1141 ../src/guestfs.pod:3131
18260 #, no-wrap
18261 msgid ""
18262 " LIBGUESTFS_MEMSIZE=700\n"
18263 "\n"
18264 msgstr ""
18265
18266 #. type: =item
18267 #: ../fish/guestfish.pod:1143 ../src/guestfs.pod:3133
18268 msgid "LIBGUESTFS_PATH"
18269 msgstr ""
18270
18271 #. type: textblock
18272 #: ../fish/guestfish.pod:1145
18273 msgid ""
18274 "Set the path that guestfish uses to search for kernel and initrd.img.  See "
18275 "the discussion of paths in L<guestfs(3)>."
18276 msgstr ""
18277
18278 #. type: =item
18279 #: ../fish/guestfish.pod:1148 ../src/guestfs.pod:3138
18280 msgid "LIBGUESTFS_QEMU"
18281 msgstr ""
18282
18283 #. type: textblock
18284 #: ../fish/guestfish.pod:1150 ../src/guestfs.pod:3140
18285 msgid ""
18286 "Set the default qemu binary that libguestfs uses.  If not set, then the qemu "
18287 "which was found at compile time by the configure script is used."
18288 msgstr ""
18289
18290 #. type: =item
18291 #: ../fish/guestfish.pod:1154 ../src/guestfs.pod:3146
18292 msgid "LIBGUESTFS_TRACE"
18293 msgstr ""
18294
18295 #. type: textblock
18296 #: ../fish/guestfish.pod:1156
18297 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18298 msgstr ""
18299
18300 #. type: =item
18301 #: ../fish/guestfish.pod:1158
18302 msgid "PAGER"
18303 msgstr ""
18304
18305 #. type: textblock
18306 #: ../fish/guestfish.pod:1160
18307 msgid ""
18308 "The C<more> command uses C<$PAGER> as the pager.  If not set, it uses "
18309 "C<more>."
18310 msgstr ""
18311
18312 #. type: =item
18313 #: ../fish/guestfish.pod:1163 ../src/guestfs.pod:3151
18314 msgid "TMPDIR"
18315 msgstr ""
18316
18317 #. type: textblock
18318 #: ../fish/guestfish.pod:1165 ../src/guestfs.pod:3153
18319 msgid ""
18320 "Location of temporary directory, defaults to C</tmp> except for the cached "
18321 "supermin appliance which defaults to C</var/tmp>."
18322 msgstr ""
18323
18324 #. type: textblock
18325 #: ../fish/guestfish.pod:1168 ../src/guestfs.pod:3156
18326 msgid ""
18327 "If libguestfs was compiled to use the supermin appliance then the real "
18328 "appliance is cached in this directory, shared between all handles belonging "
18329 "to the same EUID.  You can use C<$TMPDIR> to configure another directory to "
18330 "use in case C</var/tmp> is not large enough."
18331 msgstr ""
18332
18333 #. type: =head1
18334 #: ../fish/guestfish.pod:1176 ../fuse/guestmount.pod:288 ../rescue/virt-rescue.pod:273
18335 msgid "FILES"
18336 msgstr ""
18337
18338 #. type: =item
18339 #: ../fish/guestfish.pod:1180 ../fuse/guestmount.pod:292 ../rescue/virt-rescue.pod:277
18340 msgid "$HOME/.libguestfs-tools.rc"
18341 msgstr ""
18342
18343 #. type: =item
18344 #: ../fish/guestfish.pod:1182 ../fuse/guestmount.pod:294 ../rescue/virt-rescue.pod:279
18345 msgid "/etc/libguestfs-tools.conf"
18346 msgstr ""
18347
18348 #. type: textblock
18349 #: ../fish/guestfish.pod:1184 ../fuse/guestmount.pod:296 ../rescue/virt-rescue.pod:281
18350 msgid ""
18351 "This configuration file controls the default read-only or read-write mode "
18352 "(I<--ro> or I<--rw>)."
18353 msgstr ""
18354
18355 #. type: textblock
18356 #: ../fish/guestfish.pod:1187
18357 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
18358 msgstr ""
18359
18360 #. type: =item
18361 #: ../fish/guestfish.pod:1189
18362 msgid "$HOME/.guestfish"
18363 msgstr ""
18364
18365 #. type: textblock
18366 #: ../fish/guestfish.pod:1191
18367 msgid ""
18368 "If compiled with GNU readline support, then the command history is saved in "
18369 "this file."
18370 msgstr ""
18371
18372 #. type: =item
18373 #: ../fish/guestfish.pod:1194
18374 msgid "$HOME/.inputrc"
18375 msgstr ""
18376
18377 #. type: =item
18378 #: ../fish/guestfish.pod:1196
18379 msgid "/etc/inputrc"
18380 msgstr ""
18381
18382 #. type: textblock
18383 #: ../fish/guestfish.pod:1198
18384 msgid ""
18385 "If compiled with GNU readline support, then these files can be used to "
18386 "configure readline.  For further information, please see "
18387 "L<readline(3)/INITIALIZATION FILE>."
18388 msgstr ""
18389
18390 #. type: textblock
18391 #: ../fish/guestfish.pod:1202
18392 msgid "To write rules which only apply to guestfish, use:"
18393 msgstr ""
18394
18395 #. type: verbatim
18396 #: ../fish/guestfish.pod:1204
18397 #, no-wrap
18398 msgid ""
18399 " $if guestfish\n"
18400 " ...\n"
18401 " $endif\n"
18402 "\n"
18403 msgstr ""
18404
18405 #. type: textblock
18406 #: ../fish/guestfish.pod:1208
18407 msgid ""
18408 "Variables that you can set in inputrc that change the behaviour of guestfish "
18409 "in useful ways include:"
18410 msgstr ""
18411
18412 #. type: =item
18413 #: ../fish/guestfish.pod:1213
18414 msgid "completion-ignore-case (default: on)"
18415 msgstr ""
18416
18417 #. type: textblock
18418 #: ../fish/guestfish.pod:1215
18419 msgid ""
18420 "By default, guestfish will ignore case when tab-completing paths on the "
18421 "disk.  Use:"
18422 msgstr ""
18423
18424 #. type: verbatim
18425 #: ../fish/guestfish.pod:1218
18426 #, no-wrap
18427 msgid ""
18428 " set completion-ignore-case off\n"
18429 "\n"
18430 msgstr ""
18431
18432 #. type: textblock
18433 #: ../fish/guestfish.pod:1220
18434 msgid "to make guestfish case sensitive."
18435 msgstr ""
18436
18437 #. type: =item
18438 #: ../fish/guestfish.pod:1224
18439 msgid "test1.img"
18440 msgstr ""
18441
18442 #. type: =item
18443 #: ../fish/guestfish.pod:1226
18444 msgid "test2.img (etc)"
18445 msgstr ""
18446
18447 #. type: textblock
18448 #: ../fish/guestfish.pod:1228
18449 msgid ""
18450 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
18451 "will be created in the file C<test1.img> in the current directory.  The "
18452 "second use of I<-N> will use C<test2.img> and so on.  Any existing file with "
18453 "the same name will be overwritten."
18454 msgstr ""
18455
18456 #. type: textblock
18457 #: ../fish/guestfish.pod:1237
18458 msgid ""
18459 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
18460 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
18461 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
18462 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
18463 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
18464 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<display(1)>, L<hexedit(1)>, "
18465 "L<febootstrap-supermin-helper(8)>."
18466 msgstr ""
18467
18468 #. type: textblock
18469 #: ../fish/guestfish.pod:1266 ../src/guestfs.pod:3243 ../test-tool/libguestfs-test-tool.pod:112
18470 msgid "Copyright (C) 2009-2011 Red Hat Inc.  L<http://libguestfs.org/>"
18471 msgstr ""
18472
18473 #. type: textblock
18474 #: ../fish/virt-copy-in.pod:5
18475 msgid "virt-copy-in - Copy files and directories into a virtual machine disk image."
18476 msgstr ""
18477
18478 #. type: verbatim
18479 #: ../fish/virt-copy-in.pod:9
18480 #, no-wrap
18481 msgid ""
18482 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
18483 "\n"
18484 msgstr ""
18485
18486 #. type: verbatim
18487 #: ../fish/virt-copy-in.pod:11
18488 #, no-wrap
18489 msgid ""
18490 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
18491 "\n"
18492 msgstr ""
18493
18494 #. type: textblock
18495 #: ../fish/virt-copy-in.pod:15
18496 msgid ""
18497 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
18498 "causing disk corruption.  The virtual machine must be shut down before you "
18499 "use this command."
18500 msgstr ""
18501
18502 #. type: textblock
18503 #: ../fish/virt-copy-in.pod:21
18504 msgid ""
18505 "C<virt-copy-in> copies files and directories from the local disk into a "
18506 "virtual machine disk image or named libvirt domain."
18507 msgstr ""
18508
18509 #. type: textblock
18510 #: ../fish/virt-copy-in.pod:24
18511 msgid ""
18512 "You can give one of more filenames and directories on the command line.  "
18513 "Directories are copied in recursively.  The final parameter must be the "
18514 "destination directory in the disk image which must be an absolute path "
18515 "starting with a C</> character."
18516 msgstr ""
18517
18518 #. type: verbatim
18519 #: ../fish/virt-copy-in.pod:33
18520 #, no-wrap
18521 msgid ""
18522 " virt-copy-in -d MyGuest resolv.conf /etc\n"
18523 "\n"
18524 msgstr ""
18525
18526 #. type: textblock
18527 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
18528 msgid "Upload a home directory to a guest:"
18529 msgstr ""
18530
18531 #. type: verbatim
18532 #: ../fish/virt-copy-in.pod:37
18533 #, no-wrap
18534 msgid ""
18535 " virt-copy-in -d MyGuest skel /home\n"
18536 "\n"
18537 msgstr ""
18538
18539 #. type: =head1
18540 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28 ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
18541 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
18542 msgstr ""
18543
18544 #. type: textblock
18545 #: ../fish/virt-copy-in.pod:41
18546 msgid ""
18547 "This command is just a simple shell script wrapper around the "
18548 "L<guestfish(1)> C<copy-in> command.  For anything more complex than a "
18549 "trivial copy, you are probably better off using guestfish directly."
18550 msgstr ""
18551
18552 #. type: textblock
18553 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36 ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
18554 msgid ""
18555 "Since the shell script just passes options straight to guestfish, read "
18556 "L<guestfish(1)> to see the full list of options."
18557 msgstr ""
18558
18559 #. type: textblock
18560 #: ../fish/virt-copy-in.pod:52
18561 msgid ""
18562 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
18563 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18564 msgstr ""
18565
18566 #. type: textblock
18567 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55 ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
18568 msgid "Copyright (C) 2011 Red Hat Inc.  L<http://libguestfs.org/>"
18569 msgstr ""
18570
18571 #. type: textblock
18572 #: ../fish/virt-copy-out.pod:5
18573 msgid ""
18574 "virt-copy-out - Copy files and directories out of a virtual machine disk "
18575 "image."
18576 msgstr ""
18577
18578 #. type: verbatim
18579 #: ../fish/virt-copy-out.pod:9
18580 #, no-wrap
18581 msgid ""
18582 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
18583 "\n"
18584 msgstr ""
18585
18586 #. type: verbatim
18587 #: ../fish/virt-copy-out.pod:11
18588 #, no-wrap
18589 msgid ""
18590 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
18591 "\n"
18592 msgstr ""
18593
18594 #. type: textblock
18595 #: ../fish/virt-copy-out.pod:15
18596 msgid ""
18597 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
18598 "image or named libvirt domain."
18599 msgstr ""
18600
18601 #. type: textblock
18602 #: ../fish/virt-copy-out.pod:18
18603 msgid ""
18604 "You can give one of more filenames and directories on the command line.  "
18605 "Directories are copied out recursively."
18606 msgstr ""
18607
18608 #. type: textblock
18609 #: ../fish/virt-copy-out.pod:23
18610 msgid "Download the home directories from a virtual machine:"
18611 msgstr ""
18612
18613 #. type: verbatim
18614 #: ../fish/virt-copy-out.pod:25
18615 #, no-wrap
18616 msgid ""
18617 " mkdir homes\n"
18618 " virt-copy-out -d MyGuest /home homes\n"
18619 "\n"
18620 msgstr ""
18621
18622 #. type: textblock
18623 #: ../fish/virt-copy-out.pod:30
18624 msgid ""
18625 "This command is just a simple shell script wrapper around the "
18626 "L<guestfish(1)> C<copy-out> command.  For anything more complex than a "
18627 "trivial copy, you are probably better off using guestfish directly."
18628 msgstr ""
18629
18630 #. type: textblock
18631 #: ../fish/virt-copy-out.pod:41
18632 msgid ""
18633 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, "
18634 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18635 msgstr ""
18636
18637 #. type: textblock
18638 #: ../fish/virt-tar-in.pod:5
18639 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
18640 msgstr ""
18641
18642 #. type: verbatim
18643 #: ../fish/virt-tar-in.pod:9
18644 #, no-wrap
18645 msgid ""
18646 " virt-tar-in -a disk.img data.tar /destination\n"
18647 "\n"
18648 msgstr ""
18649
18650 #. type: verbatim
18651 #: ../fish/virt-tar-in.pod:11
18652 #, no-wrap
18653 msgid ""
18654 " virt-tar-in -d domain data.tar /destination\n"
18655 "\n"
18656 msgstr ""
18657
18658 #. type: verbatim
18659 #: ../fish/virt-tar-in.pod:13
18660 #, no-wrap
18661 msgid ""
18662 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
18663 "\n"
18664 msgstr ""
18665
18666 #. type: textblock
18667 #: ../fish/virt-tar-in.pod:17
18668 msgid ""
18669 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
18670 "causing disk corruption.  The virtual machine must be shut down before you "
18671 "use this command."
18672 msgstr ""
18673
18674 #. type: textblock
18675 #: ../fish/virt-tar-in.pod:23
18676 msgid ""
18677 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
18678 "image or named libvirt domain."
18679 msgstr ""
18680
18681 #. type: textblock
18682 #: ../fish/virt-tar-in.pod:26
18683 msgid ""
18684 "The first parameter is the tar file.  Use C<-> to read the tar file from "
18685 "standard input.  The second parameter is the absolute target directory to "
18686 "unpack into."
18687 msgstr ""
18688
18689 #. type: verbatim
18690 #: ../fish/virt-tar-in.pod:34
18691 #, no-wrap
18692 msgid ""
18693 " virt-tar-in -d MyGuest homes.tar /home\n"
18694 "\n"
18695 msgstr ""
18696
18697 #. type: textblock
18698 #: ../fish/virt-tar-in.pod:38
18699 msgid ""
18700 "This command is just a simple shell script wrapper around the "
18701 "L<guestfish(1)> C<tar-in> command.  For anything more complex than a trivial "
18702 "copy, you are probably better off using guestfish directly."
18703 msgstr ""
18704
18705 #. type: textblock
18706 #: ../fish/virt-tar-in.pod:49
18707 msgid ""
18708 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18709 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, "
18710 "L<http://libguestfs.org/>."
18711 msgstr ""
18712
18713 #. type: textblock
18714 #: ../fish/virt-tar-out.pod:5
18715 msgid "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
18716 msgstr ""
18717
18718 #. type: verbatim
18719 #: ../fish/virt-tar-out.pod:9
18720 #, no-wrap
18721 msgid ""
18722 " virt-tar-out -a disk.img /dir files.tar\n"
18723 "\n"
18724 msgstr ""
18725
18726 #. type: verbatim
18727 #: ../fish/virt-tar-out.pod:11
18728 #, no-wrap
18729 msgid ""
18730 " virt-tar-out -d domain /dir files.tar\n"
18731 "\n"
18732 msgstr ""
18733
18734 #. type: verbatim
18735 #: ../fish/virt-tar-out.pod:13
18736 #, no-wrap
18737 msgid ""
18738 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
18739 "\n"
18740 msgstr ""
18741
18742 #. type: textblock
18743 #: ../fish/virt-tar-out.pod:17
18744 msgid "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
18745 msgstr ""
18746
18747 #. type: textblock
18748 #: ../fish/virt-tar-out.pod:20
18749 msgid ""
18750 "The first parameter is the absolute path of the virtual machine directory.  "
18751 "The second parameter is the tar file to write.  Use C<-> to write to "
18752 "standard output."
18753 msgstr ""
18754
18755 #. type: textblock
18756 #: ../fish/virt-tar-out.pod:26
18757 msgid "Download the home directories from a guest:"
18758 msgstr ""
18759
18760 #. type: verbatim
18761 #: ../fish/virt-tar-out.pod:28
18762 #, no-wrap
18763 msgid ""
18764 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
18765 "\n"
18766 msgstr ""
18767
18768 #. type: textblock
18769 #: ../fish/virt-tar-out.pod:32
18770 msgid ""
18771 "This command is just a simple shell script wrapper around the "
18772 "L<guestfish(1)> C<tar-out> command.  For anything more complex than a "
18773 "trivial copy, you are probably better off using guestfish directly."
18774 msgstr ""
18775
18776 #. type: textblock
18777 #: ../fish/virt-tar-out.pod:43
18778 msgid ""
18779 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18780 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
18781 msgstr ""
18782
18783 #. type: textblock
18784 #: ../fuse/guestmount.pod:5
18785 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
18786 msgstr ""
18787
18788 #. type: verbatim
18789 #: ../fuse/guestmount.pod:9
18790 #, no-wrap
18791 msgid ""
18792 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
18793 "\n"
18794 msgstr ""
18795
18796 #. type: verbatim
18797 #: ../fuse/guestmount.pod:11
18798 #, no-wrap
18799 msgid ""
18800 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
18801 "\n"
18802 msgstr ""
18803
18804 #. type: verbatim
18805 #: ../fuse/guestmount.pod:13
18806 #, no-wrap
18807 msgid ""
18808 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
18809 "\n"
18810 msgstr ""
18811
18812 #. type: textblock
18813 #: ../fuse/guestmount.pod:17
18814 msgid ""
18815 "You must I<not> use C<guestmount> in read-write mode on live virtual "
18816 "machines.  If you do this, you risk disk corruption in the VM."
18817 msgstr ""
18818
18819 #. type: textblock
18820 #: ../fuse/guestmount.pod:22
18821 msgid ""
18822 "The guestmount program can be used to mount virtual machine filesystems and "
18823 "other disk images on the host.  It uses libguestfs for access to the guest "
18824 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
18825 "a mountable device."
18826 msgstr ""
18827
18828 #. type: textblock
18829 #: ../fuse/guestmount.pod:27
18830 msgid ""
18831 "Along with other options, you have to give at least one device (I<-a> "
18832 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
18833 "option) or use the I<-i> inspection option.  How this works is better "
18834 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
18835 "below."
18836 msgstr ""
18837
18838 #. type: textblock
18839 #: ../fuse/guestmount.pod:33
18840 msgid ""
18841 "FUSE lets you mount filesystems as non-root.  The mountpoint must be owned "
18842 "by you, and the filesystem will not be visible to any other users unless you "
18843 "make certain global configuration changes to C</etc/fuse.conf>.  To unmount "
18844 "the filesystem, use the C<fusermount -u> command."
18845 msgstr ""
18846
18847 #. type: textblock
18848 #: ../fuse/guestmount.pod:41
18849 msgid ""
18850 "For a typical Windows guest which has its main filesystem on the first "
18851 "partition:"
18852 msgstr ""
18853
18854 #. type: verbatim
18855 #: ../fuse/guestmount.pod:44
18856 #, no-wrap
18857 msgid ""
18858 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
18859 "\n"
18860 msgstr ""
18861
18862 #. type: textblock
18863 #: ../fuse/guestmount.pod:46
18864 msgid ""
18865 "For a typical Linux guest which has a /boot filesystem on the first "
18866 "partition, and the root filesystem on a logical volume:"
18867 msgstr ""
18868
18869 #. type: verbatim
18870 #: ../fuse/guestmount.pod:49
18871 #, no-wrap
18872 msgid ""
18873 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
18874 "\n"
18875 msgstr ""
18876
18877 #. type: textblock
18878 #: ../fuse/guestmount.pod:51
18879 msgid "To get libguestfs to detect guest mountpoints for you:"
18880 msgstr ""
18881
18882 #. type: verbatim
18883 #: ../fuse/guestmount.pod:53
18884 #, no-wrap
18885 msgid ""
18886 " guestmount -a guest.img -i --ro /mnt\n"
18887 "\n"
18888 msgstr ""
18889
18890 #. type: textblock
18891 #: ../fuse/guestmount.pod:55
18892 msgid "For a libvirt guest called \"Guest\" you could do:"
18893 msgstr ""
18894
18895 #. type: verbatim
18896 #: ../fuse/guestmount.pod:57
18897 #, no-wrap
18898 msgid ""
18899 " guestmount -d Guest -i --ro /mnt\n"
18900 "\n"
18901 msgstr ""
18902
18903 #. type: textblock
18904 #: ../fuse/guestmount.pod:59
18905 msgid ""
18906 "If you don't know what filesystems are contained in a guest or disk image, "
18907 "use L<virt-filesystems(1)> first:"
18908 msgstr ""
18909
18910 #. type: verbatim
18911 #: ../fuse/guestmount.pod:62
18912 #, no-wrap
18913 msgid ""
18914 " virt-filesystems MyGuest\n"
18915 "\n"
18916 msgstr ""
18917
18918 #. type: textblock
18919 #: ../fuse/guestmount.pod:64
18920 msgid ""
18921 "If you want to trace the libguestfs calls but without excessive debugging "
18922 "information, we recommend:"
18923 msgstr ""
18924
18925 #. type: verbatim
18926 #: ../fuse/guestmount.pod:67
18927 #, no-wrap
18928 msgid ""
18929 " guestmount [...] --trace /mnt\n"
18930 "\n"
18931 msgstr ""
18932
18933 #. type: textblock
18934 #: ../fuse/guestmount.pod:69
18935 msgid "If you want to debug the program, we recommend:"
18936 msgstr ""
18937
18938 #. type: verbatim
18939 #: ../fuse/guestmount.pod:71
18940 #, no-wrap
18941 msgid ""
18942 " guestmount [...] --trace --verbose /mnt\n"
18943 "\n"
18944 msgstr ""
18945
18946 #. type: =head1
18947 #: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:68 ../resize/virt-resize.pod:544
18948 msgid "NOTES"
18949 msgstr ""
18950
18951 #. type: =head2
18952 #: ../fuse/guestmount.pod:75
18953 msgid "Other users cannot see the filesystem by default"
18954 msgstr ""
18955
18956 #. type: textblock
18957 #: ../fuse/guestmount.pod:77
18958 msgid ""
18959 "If you mount a filesystem as one user (eg. root), then other users will not "
18960 "be able to see it by default.  The fix is to add the FUSE C<allow_other> "
18961 "option when mounting:"
18962 msgstr ""
18963
18964 #. type: verbatim
18965 #: ../fuse/guestmount.pod:81
18966 #, no-wrap
18967 msgid ""
18968 " sudo guestmount [...] -o allow_other /mnt\n"
18969 "\n"
18970 msgstr ""
18971
18972 #. type: textblock
18973 #: ../fuse/guestmount.pod:91
18974 msgid "Add a block device or virtual machine image."
18975 msgstr ""
18976
18977 #. type: =item
18978 #: ../fuse/guestmount.pod:114
18979 msgid "B<--dir-cache-timeout N>"
18980 msgstr ""
18981
18982 #. type: textblock
18983 #: ../fuse/guestmount.pod:116
18984 msgid ""
18985 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
18986 "seconds.  The readdir cache [actually, there are several semi-independent "
18987 "caches] is populated after a readdir(2) call with the stat and extended "
18988 "attributes of the files in the directory, in anticipation that they will be "
18989 "requested soon after."
18990 msgstr ""
18991
18992 #. type: textblock
18993 #: ../fuse/guestmount.pod:122
18994 msgid ""
18995 "There is also a different attribute cache implemented by FUSE (see the FUSE "
18996 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
18997 "requests, only cache existing ones."
18998 msgstr ""
18999
19000 #. type: textblock
19001 #: ../fuse/guestmount.pod:142
19002 msgid ""
19003 "If you have untrusted raw-format guest disk images, you should use this "
19004 "option to specify the disk format.  This avoids a possible security problem "
19005 "with malicious guests (CVE-2010-3851).  See also "
19006 "L<guestfs(3)/guestfs_add_drive_opts>."
19007 msgstr ""
19008
19009 #. type: =item
19010 #: ../fuse/guestmount.pod:147
19011 msgid "B<--fuse-help>"
19012 msgstr ""
19013
19014 #. type: textblock
19015 #: ../fuse/guestmount.pod:149
19016 msgid "Display help on special FUSE options (see I<-o> below)."
19017 msgstr ""
19018
19019 #. type: textblock
19020 #: ../fuse/guestmount.pod:153
19021 msgid "Display brief help and exit."
19022 msgstr ""
19023
19024 #. type: textblock
19025 #: ../fuse/guestmount.pod:177
19026 msgid ""
19027 "Mount the named partition or logical volume on the given mountpoint B<in the "
19028 "guest> (this has nothing to do with mountpoints in the host)."
19029 msgstr ""
19030
19031 #. type: textblock
19032 #: ../fuse/guestmount.pod:180
19033 msgid ""
19034 "If the mountpoint is omitted, it defaults to C</>.  You have to mount "
19035 "something on C</>."
19036 msgstr ""
19037
19038 #. type: textblock
19039 #: ../fuse/guestmount.pod:197
19040 msgid ""
19041 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
19042 "unmounted.  If you specify this option, then we don't attempt to sync the "
19043 "disk.  See the discussion of autosync in the L<guestfs(3)> manpage."
19044 msgstr ""
19045
19046 #. type: =item
19047 #: ../fuse/guestmount.pod:202
19048 msgid "B<-o option>"
19049 msgstr ""
19050
19051 #. type: =item
19052 #: ../fuse/guestmount.pod:204
19053 msgid "B<--option option>"
19054 msgstr ""
19055
19056 #. type: textblock
19057 #: ../fuse/guestmount.pod:206
19058 msgid "Pass extra options to FUSE."
19059 msgstr ""
19060
19061 #. type: textblock
19062 #: ../fuse/guestmount.pod:208
19063 msgid ""
19064 "To get a list of all the extra options supported by FUSE, use the command "
19065 "below.  Note that only the FUSE I<-o> options can be passed, and only some "
19066 "of them are a good idea."
19067 msgstr ""
19068
19069 #. type: verbatim
19070 #: ../fuse/guestmount.pod:212
19071 #, no-wrap
19072 msgid ""
19073 " guestmount --fuse-help\n"
19074 "\n"
19075 msgstr ""
19076
19077 #. type: textblock
19078 #: ../fuse/guestmount.pod:214
19079 msgid "Some potentially useful FUSE options:"
19080 msgstr ""
19081
19082 #. type: =item
19083 #: ../fuse/guestmount.pod:218
19084 msgid "B<-o allow_other>"
19085 msgstr ""
19086
19087 #. type: textblock
19088 #: ../fuse/guestmount.pod:220
19089 msgid "Allow other users to see the filesystem."
19090 msgstr ""
19091
19092 #. type: =item
19093 #: ../fuse/guestmount.pod:222
19094 msgid "B<-o attr_timeout=N>"
19095 msgstr ""
19096
19097 #. type: textblock
19098 #: ../fuse/guestmount.pod:224
19099 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
19100 msgstr ""
19101
19102 #. type: =item
19103 #: ../fuse/guestmount.pod:226
19104 msgid "B<-o kernel_cache>"
19105 msgstr ""
19106
19107 #. type: textblock
19108 #: ../fuse/guestmount.pod:228
19109 msgid ""
19110 "Allow the kernel to cache files (reduces the number of reads that have to go "
19111 "through the L<guestfs(3)> API).  This is generally a good idea if you can "
19112 "afford the extra memory usage."
19113 msgstr ""
19114
19115 #. type: =item
19116 #: ../fuse/guestmount.pod:232
19117 msgid "B<-o uid=N> B<-o gid=N>"
19118 msgstr ""
19119
19120 #. type: textblock
19121 #: ../fuse/guestmount.pod:234
19122 msgid ""
19123 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
19124 "the chosen values."
19125 msgstr ""
19126
19127 #. type: textblock
19128 #: ../fuse/guestmount.pod:243
19129 msgid ""
19130 "Add devices and mount everything read-only.  Also disallow writes and make "
19131 "the disk appear read-only to FUSE."
19132 msgstr ""
19133
19134 #. type: textblock
19135 #: ../fuse/guestmount.pod:246
19136 msgid ""
19137 "This is highly recommended if you are not going to edit the guest disk.  If "
19138 "the guest is running and this option is I<not> supplied, then there is a "
19139 "strong risk of disk corruption in the guest.  We try to prevent this from "
19140 "happening, but it is not always possible."
19141 msgstr ""
19142
19143 #. type: textblock
19144 #: ../fuse/guestmount.pod:251 ../rescue/virt-rescue.pod:171
19145 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
19146 msgstr ""
19147
19148 #. type: textblock
19149 #: ../fuse/guestmount.pod:255
19150 msgid "Enable SELinux support for the guest."
19151 msgstr ""
19152
19153 #. type: textblock
19154 #: ../fuse/guestmount.pod:261
19155 msgid "Enable verbose messages from underlying libguestfs."
19156 msgstr ""
19157
19158 #. type: textblock
19159 #: ../fuse/guestmount.pod:267
19160 msgid "Display the program version and exit."
19161 msgstr ""
19162
19163 #. type: textblock
19164 #: ../fuse/guestmount.pod:276 ../fuse/guestmount.pod:299 ../rescue/virt-rescue.pod:201 ../rescue/virt-rescue.pod:284
19165 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
19166 msgstr ""
19167
19168 #. type: =item
19169 #: ../fuse/guestmount.pod:280
19170 msgid "B<--trace>"
19171 msgstr ""
19172
19173 #. type: textblock
19174 #: ../fuse/guestmount.pod:282
19175 msgid "Trace libguestfs calls and entry into each FUSE function."
19176 msgstr ""
19177
19178 #. type: textblock
19179 #: ../fuse/guestmount.pod:284
19180 msgid "This also stops the daemon from forking into the background."
19181 msgstr ""
19182
19183 #. type: textblock
19184 #: ../fuse/guestmount.pod:310
19185 msgid ""
19186 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
19187 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
19188 "L<http://fuse.sf.net/>."
19189 msgstr ""
19190
19191 #. type: textblock
19192 #: ../fuse/guestmount.pod:325
19193 msgid "Copyright (C) 2009-2010 Red Hat Inc.  L<http://libguestfs.org/>"
19194 msgstr ""
19195
19196 #. type: textblock
19197 #: ../inspector/virt-inspector.pod:5
19198 msgid ""
19199 "virt-inspector - Display operating system version and other information "
19200 "about a virtual machine"
19201 msgstr ""
19202
19203 #. type: verbatim
19204 #: ../inspector/virt-inspector.pod:9
19205 #, no-wrap
19206 msgid ""
19207 " virt-inspector [--options] -d domname\n"
19208 "\n"
19209 msgstr ""
19210
19211 #. type: verbatim
19212 #: ../inspector/virt-inspector.pod:11
19213 #, no-wrap
19214 msgid ""
19215 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
19216 "\n"
19217 msgstr ""
19218
19219 #. type: verbatim
19220 #: ../inspector/virt-inspector.pod:15
19221 #, no-wrap
19222 msgid ""
19223 " virt-inspector domname\n"
19224 "\n"
19225 msgstr ""
19226
19227 #. type: verbatim
19228 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:141
19229 #, no-wrap
19230 msgid ""
19231 " virt-inspector disk.img [disk.img ...]\n"
19232 "\n"
19233 msgstr ""
19234
19235 #. type: textblock
19236 #: ../inspector/virt-inspector.pod:21
19237 msgid ""
19238 "B<virt-inspector> examines a virtual machine or disk image and tries to "
19239 "determine the version of the operating system and other information about "
19240 "the virtual machine."
19241 msgstr ""
19242
19243 #. type: textblock
19244 #: ../inspector/virt-inspector.pod:25
19245 msgid "Virt-inspector produces XML output for feeding into other programs."
19246 msgstr ""
19247
19248 #. type: textblock
19249 #: ../inspector/virt-inspector.pod:27
19250 msgid ""
19251 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
19252 "the libvirt domain (see: C<virsh list --all>)."
19253 msgstr ""
19254
19255 #. type: textblock
19256 #: ../inspector/virt-inspector.pod:30
19257 msgid ""
19258 "You can also run virt-inspector directly on disk images from a single "
19259 "virtual machine.  Use C<virt-inspector -a disk.img>.  In rare cases a domain "
19260 "has several block devices, in which case you should list several I<-a> "
19261 "options one after another, with the first corresponding to the guest's "
19262 "C</dev/sda>, the second to the guest's C</dev/sdb> and so on."
19263 msgstr ""
19264
19265 #. type: textblock
19266 #: ../inspector/virt-inspector.pod:37
19267 msgid ""
19268 "You can also run virt-inspector on install disks, live CDs, bootable USB "
19269 "keys and similar."
19270 msgstr ""
19271
19272 #. type: textblock
19273 #: ../inspector/virt-inspector.pod:40
19274 msgid ""
19275 "Virt-inspector can only inspect and report upon I<one domain at a time>.  To "
19276 "inspect several virtual machines, you have to run virt-inspector several "
19277 "times (for example, from a shell script for-loop)."
19278 msgstr ""
19279
19280 #. type: textblock
19281 #: ../inspector/virt-inspector.pod:45
19282 msgid ""
19283 "Because virt-inspector needs direct access to guest images, it won't "
19284 "normally work over remote libvirt connections."
19285 msgstr ""
19286
19287 #. type: textblock
19288 #: ../inspector/virt-inspector.pod:48
19289 msgid ""
19290 "All of the information available from virt-inspector is also available "
19291 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>).  "
19292 "The same information can also be fetched using guestfish or via libguestfs "
19293 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
19294 "WITH OTHER PROGRAMMING LANGUAGES>)."
19295 msgstr ""
19296
19297 #. type: textblock
19298 #: ../inspector/virt-inspector.pod:81
19299 msgid ""
19300 "Libvirt is only used if you specify a C<domname> on the command line.  If "
19301 "you specify guest block devices directly (I<-a>), then libvirt is not used "
19302 "at all."
19303 msgstr ""
19304
19305 #. type: textblock
19306 #: ../inspector/virt-inspector.pod:94
19307 msgid ""
19308 "When prompting for keys and passphrases, virt-inspector normally turns "
19309 "echoing off so you cannot see what you are typing.  If you are not worried "
19310 "about Tempest attacks and there is no one else in the room you can specify "
19311 "this flag to see what you are typing."
19312 msgstr ""
19313
19314 #. type: textblock
19315 #: ../inspector/virt-inspector.pod:103 ../tools/virt-list-filesystems.pl:93 ../tools/virt-list-partitions.pl:94 ../tools/virt-tar.pl:143 ../tools/virt-win-reg.pl:144
19316 msgid ""
19317 "Specify the format of disk images given on the command line.  If this is "
19318 "omitted then the format is autodetected from the content of the disk image."
19319 msgstr ""
19320
19321 #. type: textblock
19322 #: ../inspector/virt-inspector.pod:107 ../tools/virt-list-filesystems.pl:97 ../tools/virt-list-partitions.pl:98 ../tools/virt-tar.pl:147 ../tools/virt-win-reg.pl:148
19323 msgid ""
19324 "If disk images are requested from libvirt, then this program asks libvirt "
19325 "for this information.  In this case, the value of the format parameter is "
19326 "ignored."
19327 msgstr ""
19328
19329 #. type: textblock
19330 #: ../inspector/virt-inspector.pod:111 ../resize/virt-resize.pod:314 ../resize/virt-resize.pod:406 ../tools/virt-list-filesystems.pl:101 ../tools/virt-list-partitions.pl:102 ../tools/virt-tar.pl:151 ../tools/virt-win-reg.pl:152
19331 msgid ""
19332 "If working with untrusted raw-format guest disk images, you should ensure "
19333 "the format is always specified."
19334 msgstr ""
19335
19336 #. type: textblock
19337 #: ../inspector/virt-inspector.pod:139
19338 msgid "Previous versions of virt-inspector allowed you to write either:"
19339 msgstr ""
19340
19341 #. type: verbatim
19342 #: ../inspector/virt-inspector.pod:145
19343 #, no-wrap
19344 msgid ""
19345 " virt-inspector guestname\n"
19346 "\n"
19347 msgstr ""
19348
19349 #. type: =head1
19350 #: ../inspector/virt-inspector.pod:153
19351 msgid "XML FORMAT"
19352 msgstr ""
19353
19354 #. type: textblock
19355 #: ../inspector/virt-inspector.pod:155
19356 msgid ""
19357 "The virt-inspector XML is described precisely in a RELAX NG schema file "
19358 "C<virt-inspector.rng> which is supplied with libguestfs.  This section is "
19359 "just an overview."
19360 msgstr ""
19361
19362 #. type: textblock
19363 #: ../inspector/virt-inspector.pod:159
19364 msgid ""
19365 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
19366 "more E<lt>operatingsystemE<gt> elements.  You would only see more than one "
19367 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
19368 "which is vanishingly rare in real world VMs."
19369 msgstr ""
19370
19371 #. type: =head2
19372 #: ../inspector/virt-inspector.pod:164
19373 msgid "E<lt>operatingsystemE<gt>"
19374 msgstr ""
19375
19376 #. type: textblock
19377 #: ../inspector/virt-inspector.pod:166
19378 msgid ""
19379 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
19380 "describe the operating system, its architecture, the descriptive \"product "
19381 "name\" string, the type of OS and so on, as in this example:"
19382 msgstr ""
19383
19384 #. type: verbatim
19385 #: ../inspector/virt-inspector.pod:170
19386 #, no-wrap
19387 msgid ""
19388 " <operatingsystems>\n"
19389 "   <operatingsystem>\n"
19390 "     <root>/dev/sda2</root>\n"
19391 "     <name>windows</name>\n"
19392 "     <arch>i386</arch>\n"
19393 "     <distro>windows</distro>\n"
19394 "     <product_name>Windows 7 Enterprise</product_name>\n"
19395 "     <product_variant>Client</product_variant>\n"
19396 "     <major_version>6</major_version>\n"
19397 "     <minor_version>1</minor_version>\n"
19398 "     <windows_systemroot>/Windows</windows_systemroot>\n"
19399 "     <format>installed</format>\n"
19400 "\n"
19401 msgstr ""
19402
19403 #. type: textblock
19404 #: ../inspector/virt-inspector.pod:183
19405 msgid ""
19406 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
19407 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
19408 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
19409 "architecture.  The other fields are fairly self-explanatory, but because "
19410 "these fields are taken directly from the libguestfs inspection API you can "
19411 "find precise information from L<guestfs(3)/INSPECTION>."
19412 msgstr ""
19413
19414 #. type: textblock
19415 #: ../inspector/virt-inspector.pod:191
19416 msgid ""
19417 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
19418 "of view of libguestfs (block devices may have completely different names "
19419 "inside the VM itself)."
19420 msgstr ""
19421
19422 #. type: =head2
19423 #: ../inspector/virt-inspector.pod:195
19424 msgid "E<lt>mountpointsE<gt>"
19425 msgstr ""
19426
19427 #. type: textblock
19428 #: ../inspector/virt-inspector.pod:197
19429 msgid ""
19430 "Un*x-like guests typically have multiple filesystems which are mounted at "
19431 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
19432 "element which looks like this:"
19433 msgstr ""
19434
19435 #. type: verbatim
19436 #: ../inspector/virt-inspector.pod:201
19437 #, no-wrap
19438 msgid ""
19439 " <operatingsystems>\n"
19440 "   <operatingsystem>\n"
19441 "     ...\n"
19442 "     <mountpoints>\n"
19443 "       <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
19444 "       <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
19445 "     </mountpoints>\n"
19446 "\n"
19447 msgstr ""
19448
19449 #. type: textblock
19450 #: ../inspector/virt-inspector.pod:209
19451 msgid ""
19452 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
19453 "and may have completely different names inside the guest.  Only mountable "
19454 "filesystems appear in this list, not things like swap devices."
19455 msgstr ""
19456
19457 #. type: =head2
19458 #: ../inspector/virt-inspector.pod:214
19459 msgid "E<lt>filesystemsE<gt>"
19460 msgstr ""
19461
19462 #. type: textblock
19463 #: ../inspector/virt-inspector.pod:216
19464 msgid ""
19465 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
19466 "filesystems belonging to the guest, including swap and empty partitions.  "
19467 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
19468 "this OS or shared with this OS and other OSes)."
19469 msgstr ""
19470
19471 #. type: textblock
19472 #: ../inspector/virt-inspector.pod:222
19473 msgid "You might see something like this:"
19474 msgstr ""
19475
19476 #. type: verbatim
19477 #: ../inspector/virt-inspector.pod:224
19478 #, no-wrap
19479 msgid ""
19480 " <operatingsystems>\n"
19481 "   <operatingsystem>\n"
19482 "     ...\n"
19483 "     <filesystems>\n"
19484 "       <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19485 "         <type>ext4</type>\n"
19486 "         <label>Fedora-13-x86_64</label>\n"
19487 "         <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
19488 "       </filesystem>\n"
19489 "\n"
19490 msgstr ""
19491
19492 #. type: textblock
19493 #: ../inspector/virt-inspector.pod:234
19494 msgid ""
19495 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
19496 "the label, and the UUID."
19497 msgstr ""
19498
19499 #. type: =head2
19500 #: ../inspector/virt-inspector.pod:237
19501 msgid "E<lt>applicationsE<gt>"
19502 msgstr ""
19503
19504 #. type: textblock
19505 #: ../inspector/virt-inspector.pod:239
19506 msgid ""
19507 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
19508 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
19509 "machine."
19510 msgstr ""
19511
19512 #. type: textblock
19513 #: ../inspector/virt-inspector.pod:243
19514 msgid ""
19515 "E<lt>package_formatE<gt>, if present, describes the packaging system used.  "
19516 "Typical values would be C<rpm> and C<deb>."
19517 msgstr ""
19518
19519 #. type: textblock
19520 #: ../inspector/virt-inspector.pod:246
19521 msgid ""
19522 "E<lt>package_managementE<gt>, if present, describes the package manager.  "
19523 "Typical values include C<yum>, C<up2date> and C<apt>"
19524 msgstr ""
19525
19526 #. type: textblock
19527 #: ../inspector/virt-inspector.pod:249
19528 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
19529 msgstr ""
19530
19531 #. type: verbatim
19532 #: ../inspector/virt-inspector.pod:252
19533 #, no-wrap
19534 msgid ""
19535 " <operatingsystems>\n"
19536 "   <operatingsystem>\n"
19537 "     ...\n"
19538 "     <applications>\n"
19539 "       <application>\n"
19540 "         <name>coreutils</name>\n"
19541 "         <version>8.5</version>\n"
19542 "         <release>1</release>\n"
19543 "       </application>\n"
19544 "\n"
19545 msgstr ""
19546
19547 #. type: textblock
19548 #: ../inspector/virt-inspector.pod:262
19549 msgid ""
19550 "The version and release fields may not be available for some types guests.  "
19551 "Other fields are possible, see "
19552 "L<guestfs(3)/guestfs_inspect_list_applications>."
19553 msgstr ""
19554
19555 #. type: =head2
19556 #: ../inspector/virt-inspector.pod:266
19557 msgid "E<lt>drive_mappingsE<gt>"
19558 msgstr ""
19559
19560 #. type: textblock
19561 #: ../inspector/virt-inspector.pod:268
19562 msgid ""
19563 "For operating systems like Windows which use drive letters, virt-inspector "
19564 "is able to find out how drive letters map to filesystems."
19565 msgstr ""
19566
19567 #. type: verbatim
19568 #: ../inspector/virt-inspector.pod:272
19569 #, no-wrap
19570 msgid ""
19571 " <operatingsystems>\n"
19572 "   <operatingsystem>\n"
19573 "     ...\n"
19574 "     <drive_mappings>\n"
19575 "       <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
19576 "       <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
19577 "     </drive_mappings>\n"
19578 "\n"
19579 msgstr ""
19580
19581 #. type: textblock
19582 #: ../inspector/virt-inspector.pod:280
19583 msgid ""
19584 "In the example above, drive C maps to the filesystem on the second partition "
19585 "on the first disk, and drive E maps to the filesystem on the first partition "
19586 "on the second disk."
19587 msgstr ""
19588
19589 #. type: textblock
19590 #: ../inspector/virt-inspector.pod:284
19591 msgid ""
19592 "Note that this only covers permanent local filesystem mappings, not things "
19593 "like network shares.  Furthermore NTFS volume mount points may not be listed "
19594 "here."
19595 msgstr ""
19596
19597 #. type: =head2
19598 #: ../inspector/virt-inspector.pod:288
19599 msgid "E<lt>iconE<gt>"
19600 msgstr ""
19601
19602 #. type: textblock
19603 #: ../inspector/virt-inspector.pod:290
19604 msgid ""
19605 "Virt-inspector is sometimes able to extract an icon or logo for the guest.  "
19606 "The icon is returned as base64-encoded PNG data.  Note that the icon can be "
19607 "very large and high quality."
19608 msgstr ""
19609
19610 #. type: verbatim
19611 #: ../inspector/virt-inspector.pod:294
19612 #, no-wrap
19613 msgid ""
19614 " <operatingsystems>\n"
19615 "   <operatingsystem>\n"
19616 "     ...\n"
19617 "     <icon>\n"
19618 "       iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
19619 "       [... many lines of base64 data ...]\n"
19620 "     </icon>\n"
19621 "\n"
19622 msgstr ""
19623
19624 #. type: textblock
19625 #: ../inspector/virt-inspector.pod:302
19626 msgid ""
19627 "To display the icon, you have to extract it and convert the base64 data back "
19628 "to a binary file.  Use an XPath query or simply an editor to extract the "
19629 "data, then use the coreutils L<base64(1)> program to do the conversion back "
19630 "to a PNG file:"
19631 msgstr ""
19632
19633 #. type: verbatim
19634 #: ../inspector/virt-inspector.pod:307
19635 #, no-wrap
19636 msgid ""
19637 " base64 -i -d < icon.data > icon.png\n"
19638 "\n"
19639 msgstr ""
19640
19641 #. type: =head2
19642 #: ../inspector/virt-inspector.pod:309
19643 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
19644 msgstr ""
19645
19646 #. type: textblock
19647 #: ../inspector/virt-inspector.pod:311
19648 msgid ""
19649 "Virt-inspector can detect some operating system installers on install disks, "
19650 "live CDs, bootable USB keys and more."
19651 msgstr ""
19652
19653 #. type: textblock
19654 #: ../inspector/virt-inspector.pod:314
19655 msgid ""
19656 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
19657 "fields may be present to indicate a live CD, network installer, or one part "
19658 "of a multipart CD.  For example:"
19659 msgstr ""
19660
19661 #. type: verbatim
19662 #: ../inspector/virt-inspector.pod:318
19663 #, no-wrap
19664 msgid ""
19665 " <operatingsystems>\n"
19666 "   <operatingsystem>\n"
19667 "     <root>/dev/sda</root>\n"
19668 "     <name>linux</name>\n"
19669 "     <arch>i386</arch>\n"
19670 "     <distro>ubuntu</distro>\n"
19671 "     <product_name>Ubuntu 10.10 &quot;Maverick "
19672 "Meerkat&quot;</product_name>\n"
19673 "     <major_version>10</major_version>\n"
19674 "     <minor_version>10</minor_version>\n"
19675 "     <format>installer</format>\n"
19676 "     <live/>\n"
19677 "\n"
19678 msgstr ""
19679
19680 #. type: =head1
19681 #: ../inspector/virt-inspector.pod:330
19682 msgid "USING XPATH"
19683 msgstr ""
19684
19685 #. type: textblock
19686 #: ../inspector/virt-inspector.pod:332
19687 msgid ""
19688 "You can use the XPath query language to select parts of the XML.  We "
19689 "recommend using C<xmlstarlet> to perform XPath queries from the command "
19690 "line."
19691 msgstr ""
19692
19693 #. type: verbatim
19694 #: ../inspector/virt-inspector.pod:338
19695 #, no-wrap
19696 msgid ""
19697 " $ virt-inspector -d Guest | xmlstarlet sel -t -c '//filesystems'\n"
19698 " <filesystems>\n"
19699 "      <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19700 "        <type>ext4</type>\n"
19701 " [...]\n"
19702 "\n"
19703 msgstr ""
19704
19705 #. type: verbatim
19706 #: ../inspector/virt-inspector.pod:344
19707 #, no-wrap
19708 msgid ""
19709 " $ virt-inspector -d Guest | \\\n"
19710 "     xmlstarlet sel -t -c \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
19711 " ext4\n"
19712 "\n"
19713 msgstr ""
19714
19715 #. type: verbatim
19716 #: ../inspector/virt-inspector.pod:348
19717 #, no-wrap
19718 msgid ""
19719 " $ virt-inspector -d Guest | \\\n"
19720 "    xmlstarlet sel -t -v '//icon' | base64 -i -d | display -\n"
19721 " [displays the guest icon, if there is one]\n"
19722 "\n"
19723 msgstr ""
19724
19725 #. type: =head1
19726 #: ../inspector/virt-inspector.pod:359
19727 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
19728 msgstr ""
19729
19730 #. type: textblock
19731 #: ../inspector/virt-inspector.pod:361
19732 msgid ""
19733 "Early versions of libguestfs shipped with a different virt-inspector program "
19734 "written in Perl (the current version is written in C).  The XML output of "
19735 "the Perl virt-inspector was different and it could also output in other "
19736 "formats like text."
19737 msgstr ""
19738
19739 #. type: textblock
19740 #: ../inspector/virt-inspector.pod:366
19741 msgid "The old virt-inspector is no longer supported or shipped with libguestfs."
19742 msgstr ""
19743
19744 #. type: textblock
19745 #: ../inspector/virt-inspector.pod:369
19746 msgid ""
19747 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
19748 "versions of virt-inspector with different names:"
19749 msgstr ""
19750
19751 #. type: verbatim
19752 #: ../inspector/virt-inspector.pod:372
19753 #, no-wrap
19754 msgid ""
19755 " virt-inspector     Old Perl version.\n"
19756 " virt-inspector2    New C version.\n"
19757 "\n"
19758 msgstr ""
19759
19760 #. type: textblock
19761 #: ../inspector/virt-inspector.pod:382
19762 msgid ""
19763 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, "
19764 "L<base64(1)>, L<xmlstarlet(1)>, L<http://libguestfs.org/>."
19765 msgstr ""
19766
19767 #. type: textblock
19768 #: ../inspector/virt-inspector.pod:399
19769 msgid "Matthew Booth L<mbooth@redhat.com>"
19770 msgstr ""
19771
19772 #. type: textblock
19773 #: ../java/examples/guestfs-java.pod:5
19774 msgid "guestfs-java - How to use libguestfs from Java"
19775 msgstr ""
19776
19777 #. type: verbatim
19778 #: ../java/examples/guestfs-java.pod:9
19779 #, no-wrap
19780 msgid ""
19781 " import com.redhat.et.libguestfs.*;\n"
19782 " \n"
19783 msgstr ""
19784
19785 #. type: verbatim
19786 #: ../java/examples/guestfs-java.pod:11
19787 #, no-wrap
19788 msgid ""
19789 " GuestFS g = new GuestFS ();\n"
19790 " g.add_drive_opts (\"disk.img\", null);\n"
19791 " g.launch ();\n"
19792 "\n"
19793 msgstr ""
19794
19795 #. type: textblock
19796 #: ../java/examples/guestfs-java.pod:17
19797 msgid ""
19798 "This manual page documents how to call libguestfs from the Java programming "
19799 "language.  This page just documents the differences from the C API and gives "
19800 "some examples.  If you are not familiar with using libguestfs, you also need "
19801 "to read L<guestfs(3)>."
19802 msgstr ""
19803
19804 #. type: =head2
19805 #: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
19806 msgid "CLOSING THE HANDLE"
19807 msgstr ""
19808
19809 #. type: textblock
19810 #: ../java/examples/guestfs-java.pod:24
19811 msgid ""
19812 "The handle is closed when it is reaped by the garbage collector.  Because "
19813 "libguestfs handles include a lot of state, it is also possible to close (and "
19814 "hence free) them explicitly by calling the C<close> method."
19815 msgstr ""
19816
19817 #. type: =head2
19818 #: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60 ../python/examples/guestfs-python.pod:21 ../ruby/examples/guestfs-ruby.pod:22
19819 msgid "EXCEPTIONS"
19820 msgstr ""
19821
19822 #. type: textblock
19823 #: ../java/examples/guestfs-java.pod:31
19824 msgid ""
19825 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
19826 "exception.  This has a single parameter which is the error message (a "
19827 "C<String>)."
19828 msgstr ""
19829
19830 #. type: textblock
19831 #: ../java/examples/guestfs-java.pod:35
19832 msgid "Calling any method on a closed handle raises the same exception."
19833 msgstr ""
19834
19835 #. type: textblock
19836 #: ../java/examples/guestfs-java.pod:47
19837 msgid ""
19838 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
19839 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
19840 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>, "
19841 "L<http://caml.inria.fr/>."
19842 msgstr ""
19843
19844 #. type: textblock
19845 #: ../ocaml/examples/guestfs-ocaml.pod:5
19846 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
19847 msgstr ""
19848
19849 #. type: textblock
19850 #: ../ocaml/examples/guestfs-ocaml.pod:9
19851 msgid "Module style:"
19852 msgstr ""
19853
19854 #. type: verbatim
19855 #: ../ocaml/examples/guestfs-ocaml.pod:11
19856 #, no-wrap
19857 msgid ""
19858 " let g = Guestfs.create () in\n"
19859 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
19860 " Guestfs.launch g;\n"
19861 "\n"
19862 msgstr ""
19863
19864 #. type: textblock
19865 #: ../ocaml/examples/guestfs-ocaml.pod:15
19866 msgid "Object-oriented style:"
19867 msgstr ""
19868
19869 #. type: verbatim
19870 #: ../ocaml/examples/guestfs-ocaml.pod:17
19871 #, no-wrap
19872 msgid ""
19873 " let g = new Guestfs.guestfs () in\n"
19874 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
19875 " g#launch ();\n"
19876 "\n"
19877 msgstr ""
19878
19879 #. type: verbatim
19880 #: ../ocaml/examples/guestfs-ocaml.pod:21
19881 #, no-wrap
19882 msgid ""
19883 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
19884 "or:\n"
19885 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
19886 "\n"
19887 msgstr ""
19888
19889 #. type: textblock
19890 #: ../ocaml/examples/guestfs-ocaml.pod:27
19891 msgid ""
19892 "This manual page documents how to call libguestfs from the OCaml programming "
19893 "language.  This page just documents the differences from the C API and gives "
19894 "some examples.  If you are not familiar with using libguestfs, you also need "
19895 "to read L<guestfs(3)>."
19896 msgstr ""
19897
19898 #. type: =head2
19899 #: ../ocaml/examples/guestfs-ocaml.pod:32
19900 msgid "PROGRAMMING STYLES"
19901 msgstr ""
19902
19903 #. type: textblock
19904 #: ../ocaml/examples/guestfs-ocaml.pod:34
19905 msgid ""
19906 "There are two different programming styles supported by the OCaml bindings.  "
19907 "You can use a module style, with each C function mapped to an OCaml "
19908 "function:"
19909 msgstr ""
19910
19911 #. type: verbatim
19912 #: ../ocaml/examples/guestfs-ocaml.pod:38
19913 #, no-wrap
19914 msgid ""
19915 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
19916 "\n"
19917 msgstr ""
19918
19919 #. type: textblock
19920 #: ../ocaml/examples/guestfs-ocaml.pod:40
19921 msgid "becomes:"
19922 msgstr ""
19923
19924 #. type: verbatim
19925 #: ../ocaml/examples/guestfs-ocaml.pod:42
19926 #, no-wrap
19927 msgid ""
19928 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
19929 "\n"
19930 msgstr ""
19931
19932 #. type: textblock
19933 #: ../ocaml/examples/guestfs-ocaml.pod:44
19934 msgid ""
19935 "Alternately you can use an object-oriented style, calling methods on the "
19936 "class C<Guestfs.guestfs>:"
19937 msgstr ""
19938
19939 #. type: verbatim
19940 #: ../ocaml/examples/guestfs-ocaml.pod:47
19941 #, no-wrap
19942 msgid ""
19943 " method set_verbose : bool -> unit\n"
19944 "\n"
19945 msgstr ""
19946
19947 #. type: textblock
19948 #: ../ocaml/examples/guestfs-ocaml.pod:49
19949 msgid ""
19950 "The object-oriented style is usually briefer, and the minor performance "
19951 "penalty isn't noticable in the general overhead of performing libguestfs "
19952 "functions."
19953 msgstr ""
19954
19955 #. type: textblock
19956 #: ../ocaml/examples/guestfs-ocaml.pod:55
19957 msgid ""
19958 "The handle is closed when it is reaped by the garbage collector.  Because "
19959 "libguestfs handles include a lot of state, it is also possible to close (and "
19960 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
19961 "method."
19962 msgstr ""
19963
19964 #. type: textblock
19965 #: ../ocaml/examples/guestfs-ocaml.pod:62
19966 msgid ""
19967 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
19968 "exception.  This has a single parameter which is the error message (a "
19969 "string)."
19970 msgstr ""
19971
19972 #. type: textblock
19973 #: ../ocaml/examples/guestfs-ocaml.pod:66
19974 msgid ""
19975 "Calling any function/method on a closed handle raises "
19976 "C<Guestfs.Handle_closed>.  The single parameter is the name of the function "
19977 "that you called."
19978 msgstr ""
19979
19980 #. type: textblock
19981 #: ../ocaml/examples/guestfs-ocaml.pod:80
19982 msgid ""
19983 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
19984 "L<guestfs-java(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
19985 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>, "
19986 "L<http://caml.inria.fr/>."
19987 msgstr ""
19988
19989 #. type: textblock
19990 #: ../perl/examples/guestfs-perl.pod:5
19991 msgid "guestfs-perl - How to use libguestfs from Perl"
19992 msgstr ""
19993
19994 #. type: verbatim
19995 #: ../perl/examples/guestfs-perl.pod:9
19996 #, no-wrap
19997 msgid ""
19998 " use Sys::Guestfs;\n"
19999 " \n"
20000 msgstr ""
20001
20002 #. type: verbatim
20003 #: ../perl/examples/guestfs-perl.pod:11
20004 #, no-wrap
20005 msgid ""
20006 " my $h = Sys::Guestfs->new ();\n"
20007 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
20008 " $h->launch ();\n"
20009 " $h->mount_options ('', '/dev/sda1', '/');\n"
20010 " $h->touch ('/hello');\n"
20011 " $h->sync ();\n"
20012 "\n"
20013 msgstr ""
20014
20015 #. type: textblock
20016 #: ../perl/examples/guestfs-perl.pod:20
20017 msgid ""
20018 "This manual page documents how to call libguestfs from the Perl programming "
20019 "language.  This page just documents the differences from the C API and gives "
20020 "some examples.  If you are not familiar with using libguestfs, you also need "
20021 "to read L<guestfs(3)>.  To read the full Perl API, see L<Sys::Guestfs(3)>."
20022 msgstr ""
20023
20024 #. type: =head2
20025 #: ../perl/examples/guestfs-perl.pod:26
20026 msgid "ERRORS"
20027 msgstr ""
20028
20029 #. type: textblock
20030 #: ../perl/examples/guestfs-perl.pod:28
20031 msgid ""
20032 "Errors from libguestfs functions turn into calls to C<croak> (see "
20033 "L<Carp(3)>)."
20034 msgstr ""
20035
20036 #. type: textblock
20037 #: ../perl/examples/guestfs-perl.pod:41
20038 msgid ""
20039 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, "
20040 "L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, "
20041 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, "
20042 "L<http://libguestfs.org/>."
20043 msgstr ""
20044
20045 #. type: textblock
20046 #: ../python/examples/guestfs-python.pod:5
20047 msgid "guestfs-python - How to use libguestfs from Python"
20048 msgstr ""
20049
20050 #. type: verbatim
20051 #: ../python/examples/guestfs-python.pod:9
20052 #, no-wrap
20053 msgid ""
20054 " import guestfs\n"
20055 " g = guestfs.GuestFS ()\n"
20056 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
20057 " g.launch\n"
20058 "\n"
20059 msgstr ""
20060
20061 #. type: textblock
20062 #: ../python/examples/guestfs-python.pod:16
20063 msgid ""
20064 "This manual page documents how to call libguestfs from the Python "
20065 "programming language.  This page just documents the differences from the C "
20066 "API and gives some examples.  If you are not familiar with using libguestfs, "
20067 "you also need to read L<guestfs(3)>."
20068 msgstr ""
20069
20070 #. type: textblock
20071 #: ../python/examples/guestfs-python.pod:23
20072 msgid ""
20073 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
20074 "single string argument which is the error message."
20075 msgstr ""
20076
20077 #. type: =head2
20078 #: ../python/examples/guestfs-python.pod:26
20079 msgid "MORE DOCUMENTATION"
20080 msgstr ""
20081
20082 #. type: textblock
20083 #: ../python/examples/guestfs-python.pod:28
20084 msgid "Type:"
20085 msgstr ""
20086
20087 #. type: verbatim
20088 #: ../python/examples/guestfs-python.pod:30
20089 #, no-wrap
20090 msgid ""
20091 " $ python\n"
20092 " >>> import guestfs\n"
20093 " >>> help (guestfs)\n"
20094 "\n"
20095 msgstr ""
20096
20097 #. type: textblock
20098 #: ../python/examples/guestfs-python.pod:44
20099 msgid ""
20100 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
20101 "L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
20102 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
20103 msgstr ""
20104
20105 #. type: textblock
20106 #: ../rescue/virt-rescue.pod:5
20107 msgid "virt-rescue - Run a rescue shell on a virtual machine"
20108 msgstr ""
20109
20110 #. type: verbatim
20111 #: ../rescue/virt-rescue.pod:9
20112 #, no-wrap
20113 msgid ""
20114 " virt-rescue [--options] -d domname\n"
20115 "\n"
20116 msgstr ""
20117
20118 #. type: verbatim
20119 #: ../rescue/virt-rescue.pod:11
20120 #, no-wrap
20121 msgid ""
20122 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
20123 "\n"
20124 msgstr ""
20125
20126 #. type: verbatim
20127 #: ../rescue/virt-rescue.pod:15
20128 #, no-wrap
20129 msgid ""
20130 " virt-rescue [--options] domname\n"
20131 "\n"
20132 msgstr ""
20133
20134 #. type: verbatim
20135 #: ../rescue/virt-rescue.pod:17
20136 #, no-wrap
20137 msgid ""
20138 " virt-rescue [--options] disk.img [disk.img ...]\n"
20139 "\n"
20140 msgstr ""
20141
20142 #. type: textblock
20143 #: ../rescue/virt-rescue.pod:21
20144 msgid ""
20145 "You must I<not> use C<virt-rescue> on live virtual machines.  Doing so will "
20146 "probably result in disk corruption in the VM.  C<virt-rescue> tries to stop "
20147 "you from doing this, but doesn't catch all cases."
20148 msgstr ""
20149
20150 #. type: textblock
20151 #: ../rescue/virt-rescue.pod:25
20152 msgid ""
20153 "However if you use the I<--ro> (read only) option, then you can attach a "
20154 "shell to a live virtual machine.  The results might be strange or "
20155 "inconsistent at times but you won't get disk corruption."
20156 msgstr ""
20157
20158 #. type: textblock
20159 #: ../rescue/virt-rescue.pod:31
20160 msgid ""
20161 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
20162 "need for a CD.  virt-rescue gives you a rescue shell and some simple "
20163 "recovery tools which you can use to examine or rescue a virtual machine or "
20164 "disk image."
20165 msgstr ""
20166
20167 #. type: textblock
20168 #: ../rescue/virt-rescue.pod:36
20169 msgid ""
20170 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
20171 "on disk image(s):"
20172 msgstr ""
20173
20174 #. type: verbatim
20175 #: ../rescue/virt-rescue.pod:39
20176 #, no-wrap
20177 msgid ""
20178 " virt-rescue -d GuestName\n"
20179 "\n"
20180 msgstr ""
20181
20182 #. type: verbatim
20183 #: ../rescue/virt-rescue.pod:41
20184 #, no-wrap
20185 msgid ""
20186 " virt-rescue --ro -a /path/to/disk.img\n"
20187 "\n"
20188 msgstr ""
20189
20190 #. type: verbatim
20191 #: ../rescue/virt-rescue.pod:43
20192 #, no-wrap
20193 msgid ""
20194 " virt-rescue -a /dev/sdc\n"
20195 "\n"
20196 msgstr ""
20197
20198 #. type: textblock
20199 #: ../rescue/virt-rescue.pod:45
20200 msgid "For live VMs you I<must> use the --ro option."
20201 msgstr ""
20202
20203 #. type: textblock
20204 #: ../rescue/virt-rescue.pod:47
20205 msgid ""
20206 "When you run virt-rescue on a virtual machine or disk image, you are placed "
20207 "in an interactive bash shell where you can use many ordinary Linux "
20208 "commands.  What you see in C</> (C</bin>, C</lib> etc) is the rescue "
20209 "appliance.  You must mount the virtual machine's filesystems by hand.  There "
20210 "is an empty directory called C</sysroot> where you can mount filesystems."
20211 msgstr ""
20212
20213 #. type: textblock
20214 #: ../rescue/virt-rescue.pod:54
20215 msgid ""
20216 "In the example below, we list logical volumes, then choose one to mount "
20217 "under C</sysroot>:"
20218 msgstr ""
20219
20220 #. type: verbatim
20221 #: ../rescue/virt-rescue.pod:57
20222 #, no-wrap
20223 msgid ""
20224 " ><rescue> lvs\n"
20225 " LV      VG        Attr   LSize   Origin Snap%  Move Log Copy%  Convert\n"
20226 " lv_root vg_f11x64 -wi-a-   8.83G\n"
20227 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
20228 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
20229 " ><rescue> ls /sysroot\n"
20230 "\n"
20231 msgstr ""
20232
20233 #. type: textblock
20234 #: ../rescue/virt-rescue.pod:64
20235 msgid ""
20236 "If you don't know what filesystems are available on the virtual machine then "
20237 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
20238 msgstr ""
20239
20240 #. type: textblock
20241 #: ../rescue/virt-rescue.pod:70
20242 msgid ""
20243 "Virt-rescue can be used on I<any> disk image file or device, not just a "
20244 "virtual machine.  For example you can use it on a blank file if you want to "
20245 "partition that file (although we would recommend using L<guestfish(1)> "
20246 "instead as it is more suitable for this purpose).  You can even use "
20247 "virt-rescue on things like SD cards."
20248 msgstr ""
20249
20250 #. type: textblock
20251 #: ../rescue/virt-rescue.pod:76
20252 msgid ""
20253 "Virt-rescue does not require root.  You only need to run it as root if you "
20254 "need root to open the disk image."
20255 msgstr ""
20256
20257 #. type: textblock
20258 #: ../rescue/virt-rescue.pod:79
20259 msgid ""
20260 "This tool is just designed for quick interactive hacking on a virtual "
20261 "machine.  For more structured access to a virtual machine disk image, you "
20262 "should use L<guestfs(3)>.  To get a structured shell that you can use to "
20263 "make scripted changes to guests, use L<guestfish(1)>."
20264 msgstr ""
20265
20266 #. type: =item
20267 #: ../rescue/virt-rescue.pod:103
20268 msgid "B<--append kernelopts>"
20269 msgstr ""
20270
20271 #. type: textblock
20272 #: ../rescue/virt-rescue.pod:105
20273 msgid "Pass additional options to the rescue kernel."
20274 msgstr ""
20275
20276 #. type: verbatim
20277 #: ../rescue/virt-rescue.pod:135
20278 #, no-wrap
20279 msgid ""
20280 " virt-rescue --format=raw -a disk.img\n"
20281 "\n"
20282 msgstr ""
20283
20284 #. type: verbatim
20285 #: ../rescue/virt-rescue.pod:139
20286 #, no-wrap
20287 msgid ""
20288 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
20289 "\n"
20290 msgstr ""
20291
20292 #. type: =item
20293 #: ../rescue/virt-rescue.pod:148
20294 msgid "B<-m MB>"
20295 msgstr ""
20296
20297 #. type: =item
20298 #: ../rescue/virt-rescue.pod:150
20299 msgid "B<--memsize MB>"
20300 msgstr ""
20301
20302 #. type: textblock
20303 #: ../rescue/virt-rescue.pod:152
20304 msgid ""
20305 "Change the amount of memory allocated to the rescue system.  The default is "
20306 "set by libguestfs and is small but adequate for running system tools.  The "
20307 "occasional program might need more memory.  The parameter is specified in "
20308 "megabytes."
20309 msgstr ""
20310
20311 #. type: =item
20312 #: ../rescue/virt-rescue.pod:157
20313 msgid "B<--network>"
20314 msgstr ""
20315
20316 #. type: textblock
20317 #: ../rescue/virt-rescue.pod:159
20318 msgid "Enable QEMU user networking in the guest.  See L</NETWORK>."
20319 msgstr ""
20320
20321 #. type: textblock
20322 #: ../rescue/virt-rescue.pod:165
20323 msgid "Open the image read-only."
20324 msgstr ""
20325
20326 #. type: textblock
20327 #: ../rescue/virt-rescue.pod:175
20328 msgid ""
20329 "Enable SELinux in the rescue appliance.  You should read "
20330 "L<guestfs(3)/SELINUX> before using this option."
20331 msgstr ""
20332
20333 #. type: =item
20334 #: ../rescue/virt-rescue.pod:178
20335 msgid "B<--smp> N"
20336 msgstr ""
20337
20338 #. type: textblock
20339 #: ../rescue/virt-rescue.pod:180
20340 msgid "Enable N E<ge> 2 virtual CPUs in the rescue appliance."
20341 msgstr ""
20342
20343 #. type: textblock
20344 #: ../rescue/virt-rescue.pod:198
20345 msgid ""
20346 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
20347 "are done read-write."
20348 msgstr ""
20349
20350 #. type: textblock
20351 #: ../rescue/virt-rescue.pod:211
20352 msgid "Previous versions of virt-rescue allowed you to write either:"
20353 msgstr ""
20354
20355 #. type: verbatim
20356 #: ../rescue/virt-rescue.pod:213
20357 #, no-wrap
20358 msgid ""
20359 " virt-rescue disk.img [disk.img ...]\n"
20360 "\n"
20361 msgstr ""
20362
20363 #. type: verbatim
20364 #: ../rescue/virt-rescue.pod:217
20365 #, no-wrap
20366 msgid ""
20367 " virt-rescue guestname\n"
20368 "\n"
20369 msgstr ""
20370
20371 #. type: =head1
20372 #: ../rescue/virt-rescue.pod:225
20373 msgid "NETWORK"
20374 msgstr ""
20375
20376 #. type: textblock
20377 #: ../rescue/virt-rescue.pod:227
20378 msgid ""
20379 "Adding the I<--network> option enables QEMU user networking in the rescue "
20380 "appliance.  There are some differences between user networking and ordinary "
20381 "networking:"
20382 msgstr ""
20383
20384 #. type: =item
20385 #: ../rescue/virt-rescue.pod:233
20386 msgid "ping does not work"
20387 msgstr ""
20388
20389 #. type: textblock
20390 #: ../rescue/virt-rescue.pod:235
20391 msgid ""
20392 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
20393 "send the ping packets, and because virt-rescue must be able to run as "
20394 "non-root, QEMU user networking is not able to emulate the L<ping(8)> "
20395 "command.  The ping command will appear to resolve addresses but will not be "
20396 "able to send or receive any packets.  This does not mean that the network is "
20397 "not working."
20398 msgstr ""
20399
20400 #. type: =item
20401 #: ../rescue/virt-rescue.pod:242
20402 msgid "cannot receive connections"
20403 msgstr ""
20404
20405 #. type: textblock
20406 #: ../rescue/virt-rescue.pod:244
20407 msgid "QEMU user networking cannot receive incoming connections."
20408 msgstr ""
20409
20410 #. type: =item
20411 #: ../rescue/virt-rescue.pod:246
20412 msgid "making TCP connections"
20413 msgstr ""
20414
20415 #. type: textblock
20416 #: ../rescue/virt-rescue.pod:248
20417 msgid ""
20418 "The virt-rescue appliance needs to be small and so does not include many "
20419 "network tools.  In particular there is no L<telnet(1)> command.  You can "
20420 "make TCP connections from the shell using the magical "
20421 "C</dev/tcp/E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
20422 msgstr ""
20423
20424 #. type: verbatim
20425 #: ../rescue/virt-rescue.pod:253
20426 #, no-wrap
20427 msgid ""
20428 " exec 3<>/dev/tcp/redhat.com/80\n"
20429 " echo \"GET /\" >&3\n"
20430 " cat <&3\n"
20431 "\n"
20432 msgstr ""
20433
20434 #. type: textblock
20435 #: ../rescue/virt-rescue.pod:257
20436 msgid "See L<bash(1)> for more details."
20437 msgstr ""
20438
20439 #. type: textblock
20440 #: ../rescue/virt-rescue.pod:263
20441 msgid ""
20442 "Several environment variables affect virt-rescue.  See "
20443 "L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
20444 msgstr ""
20445
20446 #. type: textblock
20447 #: ../rescue/virt-rescue.pod:290
20448 msgid ""
20449 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
20450 "L<http://libguestfs.org/>."
20451 msgstr ""
20452
20453 #. type: textblock
20454 #: ../resize/virt-resize.pod:5
20455 msgid "virt-resize - Resize a virtual machine disk"
20456 msgstr ""
20457
20458 #. type: verbatim
20459 #: ../resize/virt-resize.pod:9
20460 #, no-wrap
20461 msgid ""
20462 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
20463 "   [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
20464 "   [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
20465 "\n"
20466 msgstr ""
20467
20468 #. type: textblock
20469 #: ../resize/virt-resize.pod:15
20470 msgid ""
20471 "Virt-resize is a tool which can resize a virtual machine disk, making it "
20472 "larger or smaller overall, and resizing or deleting any partitions contained "
20473 "within."
20474 msgstr ""
20475
20476 #. type: textblock
20477 #: ../resize/virt-resize.pod:19
20478 msgid ""
20479 "Virt-resize B<cannot> resize disk images in-place.  Virt-resize B<should "
20480 "not> be used on live virtual machines - for consistent results, shut the "
20481 "virtual machine down before resizing it."
20482 msgstr ""
20483
20484 #. type: textblock
20485 #: ../resize/virt-resize.pod:23
20486 msgid ""
20487 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
20488 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
20489 msgstr ""
20490
20491 #. type: =item
20492 #: ../resize/virt-resize.pod:31 ../resize/virt-resize.pod:520 ../src/guestfs.pod:469 ../src/guestfs.pod:1284 ../src/guestfs.pod:1423 ../src/guestfs.pod:2601
20493 msgid "1."
20494 msgstr ""
20495
20496 #. type: textblock
20497 #: ../resize/virt-resize.pod:33
20498 msgid ""
20499 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
20500 "fill the extra 5GB of space."
20501 msgstr ""
20502
20503 #. type: verbatim
20504 #: ../resize/virt-resize.pod:36
20505 #, no-wrap
20506 msgid ""
20507 " virt-filesystems --long -h --all -a olddisk\n"
20508 " \n"
20509 msgstr ""
20510
20511 #. type: verbatim
20512 #: ../resize/virt-resize.pod:38
20513 #, no-wrap
20514 msgid ""
20515 " truncate -r olddisk newdisk\n"
20516 " truncate -s +5G newdisk\n"
20517 " \n"
20518 msgstr ""
20519
20520 #. type: verbatim
20521 #: ../resize/virt-resize.pod:41
20522 #, no-wrap
20523 msgid ""
20524 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
20525 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
20526 "\n"
20527 msgstr ""
20528
20529 #. type: =item
20530 #: ../resize/virt-resize.pod:44 ../resize/virt-resize.pod:527 ../src/guestfs.pod:475 ../src/guestfs.pod:1288 ../src/guestfs.pod:1427 ../src/guestfs.pod:2626
20531 msgid "2."
20532 msgstr ""
20533
20534 #. type: textblock
20535 #: ../resize/virt-resize.pod:46
20536 msgid ""
20537 "As above, but make the /boot partition 200MB bigger, while giving the "
20538 "remaining space to /dev/sda2:"
20539 msgstr ""
20540
20541 #. type: verbatim
20542 #: ../resize/virt-resize.pod:49
20543 #, no-wrap
20544 msgid ""
20545 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20546 "   olddisk newdisk\n"
20547 "\n"
20548 msgstr ""
20549
20550 #. type: =item
20551 #: ../resize/virt-resize.pod:52 ../resize/virt-resize.pod:533 ../src/guestfs.pod:486 ../src/guestfs.pod:1433
20552 msgid "3."
20553 msgstr ""
20554
20555 #. type: textblock
20556 #: ../resize/virt-resize.pod:54
20557 msgid ""
20558 "As in the first example, but expand a logical volume as the final step.  "
20559 "This is what you would typically use for Linux guests that use LVM:"
20560 msgstr ""
20561
20562 #. type: verbatim
20563 #: ../resize/virt-resize.pod:58
20564 #, no-wrap
20565 msgid ""
20566 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
20567 "   olddisk newdisk\n"
20568 "\n"
20569 msgstr ""
20570
20571 #. type: =item
20572 #: ../resize/virt-resize.pod:61
20573 msgid "4."
20574 msgstr ""
20575
20576 #. type: textblock
20577 #: ../resize/virt-resize.pod:63
20578 msgid ""
20579 "As in the first example, but the output format will be qcow2 instead of a "
20580 "raw disk:"
20581 msgstr ""
20582
20583 #. type: verbatim
20584 #: ../resize/virt-resize.pod:66
20585 #, no-wrap
20586 msgid ""
20587 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
20588 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
20589 "\n"
20590 msgstr ""
20591
20592 #. type: =head1
20593 #: ../resize/virt-resize.pod:71
20594 msgid "DETAILED USAGE"
20595 msgstr ""
20596
20597 #. type: =head2
20598 #: ../resize/virt-resize.pod:73
20599 msgid "EXPANDING A VIRTUAL MACHINE DISK"
20600 msgstr ""
20601
20602 #. type: =item
20603 #: ../resize/virt-resize.pod:77
20604 msgid "1. Shut down the virtual machine"
20605 msgstr ""
20606
20607 #. type: =item
20608 #: ../resize/virt-resize.pod:79
20609 msgid "2. Locate input disk image"
20610 msgstr ""
20611
20612 #. type: textblock
20613 #: ../resize/virt-resize.pod:81
20614 msgid ""
20615 "Locate the input disk image (ie. the file or device on the host containing "
20616 "the guest's disk).  If the guest is managed by libvirt, you can use C<virsh "
20617 "dumpxml> like this to find the disk image name:"
20618 msgstr ""
20619
20620 #. type: verbatim
20621 #: ../resize/virt-resize.pod:85
20622 #, no-wrap
20623 msgid ""
20624 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
20625 " Found 1 nodes:\n"
20626 " -- NODE --\n"
20627 " <source dev=\"/dev/vg/lv_guest\" />\n"
20628 "\n"
20629 msgstr ""
20630
20631 #. type: =item
20632 #: ../resize/virt-resize.pod:90
20633 msgid "3. Look at current sizing"
20634 msgstr ""
20635
20636 #. type: textblock
20637 #: ../resize/virt-resize.pod:92
20638 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
20639 msgstr ""
20640
20641 #. type: verbatim
20642 #: ../resize/virt-resize.pod:95
20643 #, no-wrap
20644 msgid ""
20645 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
20646 " Name       Type       Size  Parent\n"
20647 " /dev/sda1  partition  101M  /dev/sda\n"
20648 " /dev/sda2  partition  7.9G  /dev/sda\n"
20649 " /dev/sda   device     8.0G  -\n"
20650 "\n"
20651 msgstr ""
20652
20653 #. type: textblock
20654 #: ../resize/virt-resize.pod:101
20655 msgid ""
20656 "(This example is a virtual machine with an 8 GB disk which we would like to "
20657 "expand up to 10 GB)."
20658 msgstr ""
20659
20660 #. type: =item
20661 #: ../resize/virt-resize.pod:104
20662 msgid "4. Create output disk"
20663 msgstr ""
20664
20665 #. type: textblock
20666 #: ../resize/virt-resize.pod:106
20667 msgid ""
20668 "Virt-resize cannot do in-place disk modifications.  You have to have space "
20669 "to store the resized output disk."
20670 msgstr ""
20671
20672 #. type: textblock
20673 #: ../resize/virt-resize.pod:109
20674 msgid "To store the resized disk image in a file, create a file of a suitable size:"
20675 msgstr ""
20676
20677 #. type: verbatim
20678 #: ../resize/virt-resize.pod:112
20679 #, no-wrap
20680 msgid ""
20681 " # rm -f outdisk\n"
20682 " # truncate -s 10G outdisk\n"
20683 "\n"
20684 msgstr ""
20685
20686 #. type: textblock
20687 #: ../resize/virt-resize.pod:115
20688 msgid "Or use L<lvcreate(1)> to create a logical volume:"
20689 msgstr ""
20690
20691 #. type: verbatim
20692 #: ../resize/virt-resize.pod:117
20693 #, no-wrap
20694 msgid ""
20695 " # lvcreate -L 10G -n lv_name vg_name\n"
20696 "\n"
20697 msgstr ""
20698
20699 #. type: textblock
20700 #: ../resize/virt-resize.pod:119
20701 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
20702 msgstr ""
20703
20704 #. type: verbatim
20705 #: ../resize/virt-resize.pod:121
20706 #, no-wrap
20707 msgid ""
20708 " # virsh pool-list\n"
20709 " # virsh vol-create-as poolname newvol 10G\n"
20710 "\n"
20711 msgstr ""
20712
20713 #. type: =item
20714 #: ../resize/virt-resize.pod:124
20715 msgid "5. Resize"
20716 msgstr ""
20717
20718 #. type: textblock
20719 #: ../resize/virt-resize.pod:126
20720 msgid ""
20721 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
20722 "file) and the output disk.  The output disk is the one created in the "
20723 "previous step."
20724 msgstr ""
20725
20726 #. type: verbatim
20727 #: ../resize/virt-resize.pod:130
20728 #, no-wrap
20729 msgid ""
20730 " # virt-resize indisk outdisk\n"
20731 "\n"
20732 msgstr ""
20733
20734 #. type: textblock
20735 #: ../resize/virt-resize.pod:132
20736 msgid ""
20737 "This command just copies disk image C<indisk> to disk image C<outdisk> "
20738 "I<without> resizing or changing any existing partitions.  If C<outdisk> is "
20739 "larger, then an extra, empty partition is created at the end of the disk "
20740 "covering the extra space.  If C<outdisk> is smaller, then it will give an "
20741 "error."
20742 msgstr ""
20743
20744 #. type: textblock
20745 #: ../resize/virt-resize.pod:138
20746 msgid ""
20747 "More realistically you'd want to expand existing partitions in the disk "
20748 "image by passing extra options (for the full list see the L</OPTIONS> "
20749 "section below)."
20750 msgstr ""
20751
20752 #. type: textblock
20753 #: ../resize/virt-resize.pod:142
20754 msgid ""
20755 "L</--expand> is the most useful option.  It expands the named partition "
20756 "within the disk to fill any extra space:"
20757 msgstr ""
20758
20759 #. type: verbatim
20760 #: ../resize/virt-resize.pod:145
20761 #, no-wrap
20762 msgid ""
20763 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
20764 "\n"
20765 msgstr ""
20766
20767 #. type: textblock
20768 #: ../resize/virt-resize.pod:147
20769 msgid ""
20770 "(In this case, an extra partition is I<not> created at the end of the disk, "
20771 "because there will be no unused space)."
20772 msgstr ""
20773
20774 #. type: textblock
20775 #: ../resize/virt-resize.pod:150
20776 msgid ""
20777 "L</--resize> is the other commonly used option.  The following would "
20778 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
20779 "rest of the available space:"
20780 msgstr ""
20781
20782 #. type: verbatim
20783 #: ../resize/virt-resize.pod:154
20784 #, no-wrap
20785 msgid ""
20786 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20787 "     indisk outdisk\n"
20788 "\n"
20789 msgstr ""
20790
20791 #. type: textblock
20792 #: ../resize/virt-resize.pod:157
20793 msgid ""
20794 "If the expanded partition in the image contains a filesystem or LVM PV, then "
20795 "if virt-resize knows how, it will resize the contents, the equivalent of "
20796 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
20797 "or L<btrfs(8)>.  However virt-resize does not know how to resize some "
20798 "filesystems, so you would have to online resize them after booting the "
20799 "guest."
20800 msgstr ""
20801
20802 #. type: textblock
20803 #: ../resize/virt-resize.pod:164
20804 msgid "Other options are covered below."
20805 msgstr ""
20806
20807 #. type: =item
20808 #: ../resize/virt-resize.pod:166
20809 msgid "6. Test"
20810 msgstr ""
20811
20812 #. type: textblock
20813 #: ../resize/virt-resize.pod:168
20814 msgid "Thoroughly test the new disk image I<before> discarding the old one."
20815 msgstr ""
20816
20817 #. type: textblock
20818 #: ../resize/virt-resize.pod:170
20819 msgid "If you are using libvirt, edit the XML to point at the new disk:"
20820 msgstr ""
20821
20822 #. type: verbatim
20823 #: ../resize/virt-resize.pod:172
20824 #, no-wrap
20825 msgid ""
20826 " # virsh edit guestname\n"
20827 "\n"
20828 msgstr ""
20829
20830 #. type: textblock
20831 #: ../resize/virt-resize.pod:174
20832 msgid ""
20833 "Change E<lt>source ...E<gt>, see "
20834 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
20835 msgstr ""
20836
20837 #. type: textblock
20838 #: ../resize/virt-resize.pod:177
20839 msgid "Then start up the domain with the new, resized disk:"
20840 msgstr ""
20841
20842 #. type: verbatim
20843 #: ../resize/virt-resize.pod:179
20844 #, no-wrap
20845 msgid ""
20846 " # virsh start guestname\n"
20847 "\n"
20848 msgstr ""
20849
20850 #. type: textblock
20851 #: ../resize/virt-resize.pod:181
20852 msgid ""
20853 "and check that it still works.  See also the L</NOTES> section below for "
20854 "additional information."
20855 msgstr ""
20856
20857 #. type: =item
20858 #: ../resize/virt-resize.pod:184
20859 msgid "7. Resize LVs etc inside the guest"
20860 msgstr ""
20861
20862 #. type: textblock
20863 #: ../resize/virt-resize.pod:186
20864 msgid "(This can also be done offline using L<guestfish(1)>)"
20865 msgstr ""
20866
20867 #. type: textblock
20868 #: ../resize/virt-resize.pod:188
20869 msgid ""
20870 "Once the guest has booted you should see the new space available, at least "
20871 "for filesystems that virt-resize knows how to resize, and for PVs.  The user "
20872 "may need to resize LVs inside PVs, and also resize filesystem types that "
20873 "virt-resize does not know how to expand."
20874 msgstr ""
20875
20876 #. type: =head2
20877 #: ../resize/virt-resize.pod:195
20878 msgid "SHRINKING A VIRTUAL MACHINE DISK"
20879 msgstr ""
20880
20881 #. type: textblock
20882 #: ../resize/virt-resize.pod:197
20883 msgid ""
20884 "Shrinking is somewhat more complex than expanding, and only an overview is "
20885 "given here."
20886 msgstr ""
20887
20888 #. type: textblock
20889 #: ../resize/virt-resize.pod:200
20890 msgid ""
20891 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
20892 "filesystems).  The user has to shrink content before passing the disk image "
20893 "to virt-resize, and virt-resize will check that the content has been shrunk "
20894 "properly."
20895 msgstr ""
20896
20897 #. type: textblock
20898 #: ../resize/virt-resize.pod:205
20899 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
20900 msgstr ""
20901
20902 #. type: textblock
20903 #: ../resize/virt-resize.pod:207
20904 msgid ""
20905 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
20906 "steps 3 and 4 above to allocate a new disk image."
20907 msgstr ""
20908
20909 #. type: textblock
20910 #: ../resize/virt-resize.pod:210
20911 msgid "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
20912 msgstr ""
20913
20914 #. type: =head2
20915 #: ../resize/virt-resize.pod:213
20916 msgid "IGNORING OR DELETING PARTITIONS"
20917 msgstr ""
20918
20919 #. type: textblock
20920 #: ../resize/virt-resize.pod:215
20921 msgid ""
20922 "virt-resize also gives a convenient way to ignore or delete partitions when "
20923 "copying from the input disk to the output disk.  Ignoring a partition speeds "
20924 "up the copy where you don't care about the existing contents of a "
20925 "partition.  Deleting a partition removes it completely, but note that it "
20926 "also renumbers any partitions after the one which is deleted, which can "
20927 "leave some guests unbootable."
20928 msgstr ""
20929
20930 #. type: =head2
20931 #: ../resize/virt-resize.pod:222
20932 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
20933 msgstr ""
20934
20935 #. type: textblock
20936 #: ../resize/virt-resize.pod:224
20937 msgid ""
20938 "If the input disk is in qcow2 format, then you may prefer that the output is "
20939 "in qcow2 format as well.  Alternately, virt-resize can convert the format on "
20940 "the fly.  The output format is simply determined by the format of the empty "
20941 "output container that you provide.  Thus to create qcow2 output, use:"
20942 msgstr ""
20943
20944 #. type: verbatim
20945 #: ../resize/virt-resize.pod:230
20946 #, no-wrap
20947 msgid ""
20948 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
20949 "\n"
20950 msgstr ""
20951
20952 #. type: textblock
20953 #: ../resize/virt-resize.pod:232
20954 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
20955 msgstr ""
20956
20957 #. type: textblock
20958 #: ../resize/virt-resize.pod:234
20959 msgid "Similarly, to get non-sparse raw output use:"
20960 msgstr ""
20961
20962 #. type: verbatim
20963 #: ../resize/virt-resize.pod:236
20964 #, no-wrap
20965 msgid ""
20966 " fallocate -l size outdisk\n"
20967 "\n"
20968 msgstr ""
20969
20970 #. type: textblock
20971 #: ../resize/virt-resize.pod:238
20972 msgid ""
20973 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
20974 "if=/dev/zero of=outdisk bs=1M count=..>)"
20975 msgstr ""
20976
20977 #. type: textblock
20978 #: ../resize/virt-resize.pod:247
20979 msgid "Display help."
20980 msgstr ""
20981
20982 #. type: =item
20983 #: ../resize/virt-resize.pod:249
20984 msgid "B<-d>"
20985 msgstr ""
20986
20987 #. type: =item
20988 #: ../resize/virt-resize.pod:251 ../tools/virt-make-fs.pl:177 ../tools/virt-win-reg.pl:120
20989 msgid "B<--debug>"
20990 msgstr ""
20991
20992 #. type: textblock
20993 #: ../resize/virt-resize.pod:253 ../tools/virt-win-reg.pl:122
20994 msgid "Enable debugging messages."
20995 msgstr ""
20996
20997 #. type: =item
20998 #: ../resize/virt-resize.pod:255
20999 msgid "B<--delete part>"
21000 msgstr ""
21001
21002 #. type: textblock
21003 #: ../resize/virt-resize.pod:257
21004 msgid ""
21005 "Delete the named partition.  It would be more accurate to describe this as "
21006 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
21007 "the original disk image is left intact."
21008 msgstr ""
21009
21010 #. type: textblock
21011 #: ../resize/virt-resize.pod:261
21012 msgid ""
21013 "Note that when you delete a partition, then anything contained in the "
21014 "partition is also deleted.  Furthermore, this causes any partitions that "
21015 "come after to be I<renumbered>, which can easily make your guest unbootable."
21016 msgstr ""
21017
21018 #. type: textblock
21019 #: ../resize/virt-resize.pod:266 ../resize/virt-resize.pod:327 ../resize/virt-resize.pod:454
21020 msgid "You can give this option multiple times."
21021 msgstr ""
21022
21023 #. type: =item
21024 #: ../resize/virt-resize.pod:268
21025 msgid "B<--expand part>"
21026 msgstr ""
21027
21028 #. type: textblock
21029 #: ../resize/virt-resize.pod:270
21030 msgid ""
21031 "Expand the named partition so it uses up all extra space (space left over "
21032 "after any other resize changes that you request have been done)."
21033 msgstr ""
21034
21035 #. type: textblock
21036 #: ../resize/virt-resize.pod:273
21037 msgid ""
21038 "If virt-resize knows how, it will expand the direct content of the "
21039 "partition.  For example, if the partition is an LVM PV, it will expand the "
21040 "PV to fit (like calling L<pvresize(8)>).  Virt-resize leaves any other "
21041 "content it doesn't know about alone."
21042 msgstr ""
21043
21044 #. type: textblock
21045 #: ../resize/virt-resize.pod:278
21046 msgid "Currently virt-resize can resize:"
21047 msgstr ""
21048
21049 #. type: textblock
21050 #: ../resize/virt-resize.pod:284
21051 msgid "ext2, ext3 and ext4 filesystems."
21052 msgstr ""
21053
21054 #. type: textblock
21055 #: ../resize/virt-resize.pod:288
21056 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
21057 msgstr ""
21058
21059 #. type: textblock
21060 #: ../resize/virt-resize.pod:290
21061 msgid ""
21062 "The filesystem must have been shut down consistently last time it was used.  "
21063 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
21064 "consistency check, so at the first boot after resizing Windows will check "
21065 "the disk."
21066 msgstr ""
21067
21068 #. type: textblock
21069 #: ../resize/virt-resize.pod:297
21070 msgid ""
21071 "LVM PVs (physical volumes).  virt-resize does not usually resize anything "
21072 "inside the PV, but see the I<--LV-expand> option.  The user could also "
21073 "resize LVs as desired after boot."
21074 msgstr ""
21075
21076 #. type: textblock
21077 #: ../resize/virt-resize.pod:303
21078 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
21079 msgstr ""
21080
21081 #. type: textblock
21082 #: ../resize/virt-resize.pod:307 ../resize/virt-resize.pod:482
21083 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
21084 msgstr ""
21085
21086 #. type: =item
21087 #: ../resize/virt-resize.pod:309 ../tools/virt-list-filesystems.pl:91 ../tools/virt-list-partitions.pl:92 ../tools/virt-tar.pl:141 ../tools/virt-win-reg.pl:142
21088 msgid "B<--format> raw"
21089 msgstr ""
21090
21091 #. type: textblock
21092 #: ../resize/virt-resize.pod:311
21093 msgid ""
21094 "Specify the format of the input disk image.  If this flag is not given then "
21095 "it is auto-detected from the image itself."
21096 msgstr ""
21097
21098 #. type: textblock
21099 #: ../resize/virt-resize.pod:317
21100 msgid ""
21101 "Note that this option I<does not> affect the output format.  See L</QCOW2 "
21102 "AND NON-SPARSE RAW FORMATS>."
21103 msgstr ""
21104
21105 #. type: =item
21106 #: ../resize/virt-resize.pod:320
21107 msgid "B<--ignore part>"
21108 msgstr ""
21109
21110 #. type: textblock
21111 #: ../resize/virt-resize.pod:322
21112 msgid ""
21113 "Ignore the named partition.  Effectively this means the partition is "
21114 "allocated on the destination disk, but the content is not copied across from "
21115 "the source disk.  The content of the partition will be blank (all zero "
21116 "bytes)."
21117 msgstr ""
21118
21119 #. type: =item
21120 #: ../resize/virt-resize.pod:329
21121 msgid "B<--LV-expand logvol>"
21122 msgstr ""
21123
21124 #. type: textblock
21125 #: ../resize/virt-resize.pod:331
21126 msgid ""
21127 "This takes the logical volume and, as a final step, expands it to fill all "
21128 "the space available in its volume group.  A typical usage, assuming a Linux "
21129 "guest with a single PV C</dev/sda2> and a root device called "
21130 "C</dev/vg_guest/lv_root> would be:"
21131 msgstr ""
21132
21133 #. type: verbatim
21134 #: ../resize/virt-resize.pod:336
21135 #, no-wrap
21136 msgid ""
21137 " virt-resize indisk outdisk \\\n"
21138 "   --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
21139 "\n"
21140 msgstr ""
21141
21142 #. type: textblock
21143 #: ../resize/virt-resize.pod:339
21144 msgid ""
21145 "This would first expand the partition (and PV), and then expand the root "
21146 "device to fill the extra space in the PV."
21147 msgstr ""
21148
21149 #. type: textblock
21150 #: ../resize/virt-resize.pod:342
21151 msgid ""
21152 "The contents of the LV are also resized if virt-resize knows how to do "
21153 "that.  You can stop virt-resize from trying to expand the content by using "
21154 "the option I<--no-expand-content>."
21155 msgstr ""
21156
21157 #. type: textblock
21158 #: ../resize/virt-resize.pod:346
21159 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
21160 msgstr ""
21161
21162 #. type: textblock
21163 #: ../resize/virt-resize.pod:348
21164 msgid ""
21165 "You can give this option multiple times, I<but> it doesn't make sense to do "
21166 "this unless the logical volumes you specify are all in different volume "
21167 "groups."
21168 msgstr ""
21169
21170 #. type: =item
21171 #: ../resize/virt-resize.pod:352
21172 msgid "B<--machine-readable>"
21173 msgstr ""
21174
21175 #. type: textblock
21176 #: ../resize/virt-resize.pod:354
21177 msgid ""
21178 "This option is used to make the output more machine friendly when being "
21179 "parsed by other programs.  See L</MACHINE READABLE OUTPUT> below."
21180 msgstr ""
21181
21182 #. type: =item
21183 #: ../resize/virt-resize.pod:360
21184 msgid "B<--dryrun>"
21185 msgstr ""
21186
21187 #. type: textblock
21188 #: ../resize/virt-resize.pod:362
21189 msgid "Print a summary of what would be done, but don't do anything."
21190 msgstr ""
21191
21192 #. type: =item
21193 #: ../resize/virt-resize.pod:364
21194 msgid "B<--no-copy-boot-loader>"
21195 msgstr ""
21196
21197 #. type: textblock
21198 #: ../resize/virt-resize.pod:366
21199 msgid ""
21200 "By default, virt-resize copies over some sectors at the start of the disk "
21201 "(up to the beginning of the first partition).  Commonly these sectors "
21202 "contain the Master Boot Record (MBR) and the boot loader, and are required "
21203 "in order for the guest to boot correctly."
21204 msgstr ""
21205
21206 #. type: textblock
21207 #: ../resize/virt-resize.pod:371
21208 msgid ""
21209 "If you specify this flag, then this initial copy is not done.  You may need "
21210 "to reinstall the boot loader in this case."
21211 msgstr ""
21212
21213 #. type: =item
21214 #: ../resize/virt-resize.pod:374
21215 msgid "B<--no-extra-partition>"
21216 msgstr ""
21217
21218 #. type: textblock
21219 #: ../resize/virt-resize.pod:376
21220 msgid ""
21221 "By default, virt-resize creates an extra partition if there is any extra, "
21222 "unused space after all resizing has happened.  Use this option to prevent "
21223 "the extra partition from being created.  If you do this then the extra space "
21224 "will be inaccessible until you run fdisk, parted, or some other partitioning "
21225 "tool in the guest."
21226 msgstr ""
21227
21228 #. type: textblock
21229 #: ../resize/virt-resize.pod:382
21230 msgid ""
21231 "Note that if the surplus space is smaller than 10 MB, no extra partition "
21232 "will be created."
21233 msgstr ""
21234
21235 #. type: =item
21236 #: ../resize/virt-resize.pod:385
21237 msgid "B<--no-expand-content>"
21238 msgstr ""
21239
21240 #. type: textblock
21241 #: ../resize/virt-resize.pod:387
21242 msgid ""
21243 "By default, virt-resize will try to expand the direct contents of "
21244 "partitions, if it knows how (see I<--expand> option above)."
21245 msgstr ""
21246
21247 #. type: textblock
21248 #: ../resize/virt-resize.pod:390
21249 msgid ""
21250 "If you give the I<--no-expand-content> option then virt-resize will not "
21251 "attempt this."
21252 msgstr ""
21253
21254 #. type: =item
21255 #: ../resize/virt-resize.pod:393
21256 msgid "B<--ntfsresize-force>"
21257 msgstr ""
21258
21259 #. type: textblock
21260 #: ../resize/virt-resize.pod:395
21261 msgid ""
21262 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
21263 "the NTFS disk is marked as needing a consistency check.  You have to use "
21264 "this option if you want to resize a Windows guest multiple times without "
21265 "booting into Windows between each resize."
21266 msgstr ""
21267
21268 #. type: =item
21269 #: ../resize/virt-resize.pod:401
21270 msgid "B<--output-format> raw"
21271 msgstr ""
21272
21273 #. type: textblock
21274 #: ../resize/virt-resize.pod:403
21275 msgid ""
21276 "Specify the format of the output disk image.  If this flag is not given then "
21277 "it is auto-detected from the image itself."
21278 msgstr ""
21279
21280 #. type: textblock
21281 #: ../resize/virt-resize.pod:409
21282 msgid ""
21283 "Note that this option I<does not create> the output format.  This option "
21284 "just tells libguestfs what it is so it doesn't try to guess it.  You still "
21285 "need to create the output disk with the right format.  See L</QCOW2 AND "
21286 "NON-SPARSE RAW FORMATS>."
21287 msgstr ""
21288
21289 #. type: =item
21290 #: ../resize/virt-resize.pod:414
21291 msgid "B<-q>"
21292 msgstr ""
21293
21294 #. type: =item
21295 #: ../resize/virt-resize.pod:416
21296 msgid "B<--quiet>"
21297 msgstr ""
21298
21299 #. type: textblock
21300 #: ../resize/virt-resize.pod:418
21301 msgid "Don't print the summary."
21302 msgstr ""
21303
21304 #. type: =item
21305 #: ../resize/virt-resize.pod:420
21306 msgid "B<--resize part=size>"
21307 msgstr ""
21308
21309 #. type: textblock
21310 #: ../resize/virt-resize.pod:422
21311 msgid ""
21312 "Resize the named partition (expanding or shrinking it) so that it has the "
21313 "given size."
21314 msgstr ""
21315
21316 #. type: textblock
21317 #: ../resize/virt-resize.pod:425
21318 msgid ""
21319 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
21320 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
21321 "size; or as a relative number or percentage.  For example:"
21322 msgstr ""
21323
21324 #. type: verbatim
21325 #: ../resize/virt-resize.pod:431
21326 #, no-wrap
21327 msgid ""
21328 " --resize /dev/sda2=10G\n"
21329 "\n"
21330 msgstr ""
21331
21332 #. type: verbatim
21333 #: ../resize/virt-resize.pod:433
21334 #, no-wrap
21335 msgid ""
21336 " --resize /dev/sda4=90%\n"
21337 "\n"
21338 msgstr ""
21339
21340 #. type: verbatim
21341 #: ../resize/virt-resize.pod:435
21342 #, no-wrap
21343 msgid ""
21344 " --resize /dev/sda2=+1G\n"
21345 "\n"
21346 msgstr ""
21347
21348 #. type: verbatim
21349 #: ../resize/virt-resize.pod:437
21350 #, no-wrap
21351 msgid ""
21352 " --resize /dev/sda2=-200M\n"
21353 "\n"
21354 msgstr ""
21355
21356 #. type: verbatim
21357 #: ../resize/virt-resize.pod:439
21358 #, no-wrap
21359 msgid ""
21360 " --resize /dev/sda1=+128K\n"
21361 "\n"
21362 msgstr ""
21363
21364 #. type: verbatim
21365 #: ../resize/virt-resize.pod:441
21366 #, no-wrap
21367 msgid ""
21368 " --resize /dev/sda1=+10%\n"
21369 "\n"
21370 msgstr ""
21371
21372 #. type: verbatim
21373 #: ../resize/virt-resize.pod:443
21374 #, no-wrap
21375 msgid ""
21376 " --resize /dev/sda1=-10%\n"
21377 "\n"
21378 msgstr ""
21379
21380 #. type: textblock
21381 #: ../resize/virt-resize.pod:445
21382 msgid ""
21383 "You can increase the size of any partition.  Virt-resize will expand the "
21384 "direct content of the partition if it knows how (see I<--expand> below)."
21385 msgstr ""
21386
21387 #. type: textblock
21388 #: ../resize/virt-resize.pod:449
21389 msgid ""
21390 "You can only I<decrease> the size of partitions that contain filesystems or "
21391 "PVs which have already been shrunk.  Virt-resize will check this has been "
21392 "done before proceeding, or else will print an error (see also "
21393 "I<--resize-force>)."
21394 msgstr ""
21395
21396 #. type: =item
21397 #: ../resize/virt-resize.pod:456
21398 msgid "B<--resize-force part=size>"
21399 msgstr ""
21400
21401 #. type: textblock
21402 #: ../resize/virt-resize.pod:458
21403 msgid ""
21404 "This is the same as I<--resize> except that it will let you decrease the "
21405 "size of any partition.  Generally this means you will lose any data which "
21406 "was at the end of the partition you shrink, but you may not care about that "
21407 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
21408 "as a swap partition)."
21409 msgstr ""
21410
21411 #. type: textblock
21412 #: ../resize/virt-resize.pod:464
21413 msgid "See also the I<--ignore> option."
21414 msgstr ""
21415
21416 #. type: =item
21417 #: ../resize/virt-resize.pod:466
21418 msgid "B<--shrink part>"
21419 msgstr ""
21420
21421 #. type: textblock
21422 #: ../resize/virt-resize.pod:468
21423 msgid ""
21424 "Shrink the named partition until the overall disk image fits in the "
21425 "destination.  The named partition B<must> contain a filesystem or PV which "
21426 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
21427 "online tools).  Virt-resize will check this and give an error if it has not "
21428 "been done."
21429 msgstr ""
21430
21431 #. type: textblock
21432 #: ../resize/virt-resize.pod:474
21433 msgid ""
21434 "The amount by which the overall disk must be shrunk (after carrying out all "
21435 "other operations requested by the user) is called the \"deficit\".  For "
21436 "example, a straight copy (assume no other operations)  from a 5GB disk image "
21437 "to a 4GB disk image results in a 1GB deficit.  In this case, virt-resize "
21438 "would give an error unless the user specified a partition to shrink and that "
21439 "partition had more than a gigabyte of free space."
21440 msgstr ""
21441
21442 #. type: =head1
21443 #: ../resize/virt-resize.pod:492
21444 msgid "MACHINE READABLE OUTPUT"
21445 msgstr ""
21446
21447 #. type: textblock
21448 #: ../resize/virt-resize.pod:494
21449 msgid ""
21450 "The I<--machine-readable> option can be used to make the output more machine "
21451 "friendly, which is useful when calling virt-resize from other programs, GUIs "
21452 "etc."
21453 msgstr ""
21454
21455 #. type: textblock
21456 #: ../resize/virt-resize.pod:498
21457 msgid "There are two ways to use this option."
21458 msgstr ""
21459
21460 #. type: textblock
21461 #: ../resize/virt-resize.pod:500
21462 msgid ""
21463 "Firstly use the option on its own to query the capabilities of the "
21464 "virt-resize binary.  Typical output looks like this:"
21465 msgstr ""
21466
21467 #. type: verbatim
21468 #: ../resize/virt-resize.pod:503
21469 #, no-wrap
21470 msgid ""
21471 " $ virt-resize --machine-readable\n"
21472 " virt-resize\n"
21473 " ntfsresize-force\n"
21474 " 32bitok\n"
21475 " ntfs\n"
21476 " btrfs\n"
21477 "\n"
21478 msgstr ""
21479
21480 #. type: textblock
21481 #: ../resize/virt-resize.pod:510
21482 msgid ""
21483 "A list of features is printed, one per line, and the program exits with "
21484 "status 0."
21485 msgstr ""
21486
21487 #. type: textblock
21488 #: ../resize/virt-resize.pod:513
21489 msgid ""
21490 "Secondly use the option in conjunction with other options to make the "
21491 "regular program output more machine friendly."
21492 msgstr ""
21493
21494 #. type: textblock
21495 #: ../resize/virt-resize.pod:516
21496 msgid "At the moment this means:"
21497 msgstr ""
21498
21499 #. type: textblock
21500 #: ../resize/virt-resize.pod:522
21501 msgid ""
21502 "Progress bar messages can be parsed from stdout by looking for this regular "
21503 "expression:"
21504 msgstr ""
21505
21506 #. type: verbatim
21507 #: ../resize/virt-resize.pod:525
21508 #, no-wrap
21509 msgid ""
21510 " ^[0-9]+/[0-9]+$\n"
21511 "\n"
21512 msgstr ""
21513
21514 #. type: textblock
21515 #: ../resize/virt-resize.pod:529
21516 msgid ""
21517 "The calling program should treat messages sent to stdout (except for "
21518 "progress bar messages) as status messages.  They can be logged and/or "
21519 "displayed to the user."
21520 msgstr ""
21521
21522 #. type: textblock
21523 #: ../resize/virt-resize.pod:535
21524 msgid ""
21525 "The calling program should treat messages sent to stderr as error messages.  "
21526 "In addition, virt-resize exits with a non-zero status code if there was a "
21527 "fatal error."
21528 msgstr ""
21529
21530 #. type: textblock
21531 #: ../resize/virt-resize.pod:541
21532 msgid ""
21533 "Versions of the program prior to 1.13.9 did not support the "
21534 "I<--machine-readable> option and will return an error."
21535 msgstr ""
21536
21537 #. type: =head2
21538 #: ../resize/virt-resize.pod:546
21539 msgid "\"Partition 1 does not end on cylinder boundary.\""
21540 msgstr ""
21541
21542 #. type: textblock
21543 #: ../resize/virt-resize.pod:548
21544 msgid ""
21545 "Virt-resize aligns partitions to multiples of 64 sectors.  Usually this "
21546 "means the partitions will not be aligned to the ancient CHS geometry.  "
21547 "However CHS geometry is meaningless for disks manufactured since the early "
21548 "1990s, and doubly so for virtual hard drives.  Alignment of partitions to "
21549 "cylinders is not required by any modern operating system."
21550 msgstr ""
21551
21552 #. type: =head2
21553 #: ../resize/virt-resize.pod:555
21554 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
21555 msgstr ""
21556
21557 #. type: textblock
21558 #: ../resize/virt-resize.pod:557
21559 msgid ""
21560 "In Windows Vista and later versions, Microsoft switched to using a separate "
21561 "boot partition.  In these VMs, typically C</dev/sda1> is the boot partition "
21562 "and C</dev/sda2> is the main (C:) drive.  We have not had any luck resizing "
21563 "the boot partition.  Doing so seems to break the guest completely.  However "
21564 "expanding the second partition (ie. C: drive) should work."
21565 msgstr ""
21566
21567 #. type: textblock
21568 #: ../resize/virt-resize.pod:564
21569 msgid ""
21570 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
21571 "NTFS partitions have been expanded.  This is just a safety check and (unless "
21572 "it find errors) is nothing to worry about."
21573 msgstr ""
21574
21575 #. type: =head2
21576 #: ../resize/virt-resize.pod:568
21577 msgid "GUEST BOOT STUCK AT \"GRUB\""
21578 msgstr ""
21579
21580 #. type: textblock
21581 #: ../resize/virt-resize.pod:570
21582 msgid ""
21583 "If a Linux guest does not boot after resizing, and the boot is stuck after "
21584 "printing C<GRUB> on the console, try reinstalling grub.  This sometimes "
21585 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
21586 "although we think is to do with partition alignment."
21587 msgstr ""
21588
21589 #. type: verbatim
21590 #: ../resize/virt-resize.pod:575
21591 #, no-wrap
21592 msgid ""
21593 " guestfish -i -a newdisk\n"
21594 " ><fs> cat /boot/grub/device.map\n"
21595 " # check the contents of this file are sensible or\n"
21596 " # edit the file if necessary\n"
21597 " ><fs> grub-install / /dev/vda\n"
21598 " ><fs> exit\n"
21599 "\n"
21600 msgstr ""
21601
21602 #. type: textblock
21603 #: ../resize/virt-resize.pod:582
21604 msgid ""
21605 "For more flexible guest reconfiguration, including if you need to specify "
21606 "other parameters to grub-install, use L<virt-rescue(1)>."
21607 msgstr ""
21608
21609 #. type: =head1
21610 #: ../resize/virt-resize.pod:585
21611 msgid "ALTERNATIVE TOOLS"
21612 msgstr ""
21613
21614 #. type: textblock
21615 #: ../resize/virt-resize.pod:587
21616 msgid ""
21617 "There are several proprietary tools for resizing partitions.  We won't "
21618 "mention any here."
21619 msgstr ""
21620
21621 #. type: textblock
21622 #: ../resize/virt-resize.pod:590
21623 msgid ""
21624 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
21625 "operations on disk images.  They can resize and move partitions, but I don't "
21626 "think they can do anything with the contents, and they certainly don't "
21627 "understand LVM."
21628 msgstr ""
21629
21630 #. type: textblock
21631 #: ../resize/virt-resize.pod:595
21632 msgid ""
21633 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
21634 "but at a much lower level.  You will probably end up hand-calculating sector "
21635 "offsets, which is something that virt-resize was designed to avoid.  If you "
21636 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
21637 "I<--debug> flag."
21638 msgstr ""
21639
21640 #. type: textblock
21641 #: ../resize/virt-resize.pod:615
21642 msgid ""
21643 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
21644 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
21645 "L<ntfsresize(8)>, L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
21646 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
21647 "L<http://libguestfs.org/>."
21648 msgstr ""
21649
21650 #. type: textblock
21651 #: ../ruby/examples/guestfs-ruby.pod:5
21652 msgid "guestfs-ruby - How to use libguestfs from Ruby"
21653 msgstr ""
21654
21655 #. type: verbatim
21656 #: ../ruby/examples/guestfs-ruby.pod:9
21657 #, no-wrap
21658 msgid ""
21659 " require 'guestfs'\n"
21660 " g = Guestfs::Guestfs.new()\n"
21661 " g.add_drive_opts(\"disk.img\",\n"
21662 "                  :readonly => 1, :format => \"raw\")\n"
21663 " g.launch()\n"
21664 "\n"
21665 msgstr ""
21666
21667 #. type: textblock
21668 #: ../ruby/examples/guestfs-ruby.pod:17
21669 msgid ""
21670 "This manual page documents how to call libguestfs from the Ruby programming "
21671 "language.  This page just documents the differences from the C API and gives "
21672 "some examples.  If you are not familiar with using libguestfs, you also need "
21673 "to read L<guestfs(3)>."
21674 msgstr ""
21675
21676 #. type: textblock
21677 #: ../ruby/examples/guestfs-ruby.pod:24
21678 msgid ""
21679 "Errors from libguestfs functions are mapped into the C<Error> exception.  "
21680 "This has a single parameter which is the error message (a string)."
21681 msgstr ""
21682
21683 #. type: textblock
21684 #: ../ruby/examples/guestfs-ruby.pod:38
21685 msgid ""
21686 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
21687 "L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
21688 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<http://libguestfs.org/>."
21689 msgstr ""
21690
21691 #. type: =head2
21692 #: ../src/guestfs-actions.pod:1
21693 msgid "guestfs_add_cdrom"
21694 msgstr ""
21695
21696 #. type: verbatim
21697 #: ../src/guestfs-actions.pod:3
21698 #, no-wrap
21699 msgid ""
21700 " int\n"
21701 " guestfs_add_cdrom (guestfs_h *g,\n"
21702 "                    const char *filename);\n"
21703 "\n"
21704 msgstr ""
21705
21706 #. type: textblock
21707 #: ../src/guestfs-actions.pod:7 ../src/guestfs-actions.pod:249 ../src/guestfs-actions.pod:270
21708 msgid ""
21709 "I<This function is deprecated.> In new code, use the "
21710 "L</guestfs_add_drive_opts> call instead."
21711 msgstr ""
21712
21713 #. type: textblock
21714 #: ../src/guestfs-actions.pod:24
21715 msgid ""
21716 "This call checks for the existence of C<filename>.  This stops you from "
21717 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21718 "and C<http:> URLs.  To specify those, use the general C<guestfs_config> call "
21719 "instead."
21720 msgstr ""
21721
21722 #. type: textblock
21723 #: ../src/guestfs-actions.pod:31
21724 msgid ""
21725 "If you just want to add an ISO file (often you use this as an efficient way "
21726 "to transfer large files into the guest), then you should probably use "
21727 "C<guestfs_add_drive_ro> instead."
21728 msgstr ""
21729
21730 #. type: textblock
21731 #: ../src/guestfs-actions.pod:37 ../src/guestfs-actions.pod:140 ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259 ../src/guestfs-actions.pod:280 ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307 ../src/guestfs-actions.pod:427 ../src/guestfs-actions.pod:447 ../src/guestfs-actions.pod:461 ../src/guestfs-actions.pod:506 ../src/guestfs-actions.pod:534 ../src/guestfs-actions.pod:552 ../src/guestfs-actions.pod:619 ../src/guestfs-actions.pod:652 ../src/guestfs-actions.pod:666 ../src/guestfs-actions.pod:681 ../src/guestfs-actions.pod:780 ../src/guestfs-actions.pod:798 ../src/guestfs-actions.pod:812 ../src/guestfs-actions.pod:826 ../src/guestfs-actions.pod:863 ../src/guestfs-actions.pod:1046 ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1084 ../src/guestfs-actions.pod:1174 ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1275 ../src/guestfs-actions.pod:1293 ../src/guestfs-actions.pod:1312 ../src/guestfs-actions.pod:1326 ../src/guestfs-actions.pod:1346 ../src/guestfs-actions.pod:1416 ../src/guestfs-actions.pod:1447 ../src/guestfs-actions.pod:1472 ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1654 ../src/guestfs-actions.pod:1869 ../src/guestfs-actions.pod:1891 ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:2484 ../src/guestfs-actions.pod:2628 ../src/guestfs-actions.pod:2689 ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:3768 ../src/guestfs-actions.pod:3783 ../src/guestfs-actions.pod:3808 ../src/guestfs-actions.pod:3997 ../src/guestfs-actions.pod:4011 ../src/guestfs-actions.pod:4024 ../src/guestfs-actions.pod:4038 ../src/guestfs-actions.pod:4053 ../src/guestfs-actions.pod:4089 ../src/guestfs-actions.pod:4161 ../src/guestfs-actions.pod:4181 ../src/guestfs-actions.pod:4198 ../src/guestfs-actions.pod:4221 ../src/guestfs-actions.pod:4244 ../src/guestfs-actions.pod:4279 ../src/guestfs-actions.pod:4298 ../src/guestfs-actions.pod:4317 ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4364 ../src/guestfs-actions.pod:4400 ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:4444 ../src/guestfs-actions.pod:4461 ../src/guestfs-actions.pod:4554 ../src/guestfs-actions.pod:4574 ../src/guestfs-actions.pod:4587 ../src/guestfs-actions.pod:4638 ../src/guestfs-actions.pod:4656 ../src/guestfs-actions.pod:4674 ../src/guestfs-actions.pod:4690 ../src/guestfs-actions.pod:4704 ../src/guestfs-actions.pod:4718 ../src/guestfs-actions.pod:4735 ../src/guestfs-actions.pod:4750 ../src/guestfs-actions.pod:4777 ../src/guestfs-actions.pod:4840 ../src/guestfs-actions.pod:4913 ../src/guestfs-actions.pod:4944 ../src/guestfs-actions.pod:4963 ../src/guestfs-actions.pod:4982 ../src/guestfs-actions.pod:4994 ../src/guestfs-actions.pod:5011 ../src/guestfs-actions.pod:5024 ../src/guestfs-actions.pod:5039 ../src/guestfs-actions.pod:5054 ../src/guestfs-actions.pod:5096 ../src/guestfs-actions.pod:5122 ../src/guestfs-actions.pod:5161 ../src/guestfs-actions.pod:5181 ../src/guestfs-actions.pod:5195 ../src/guestfs-actions.pod:5212 ../src/guestfs-actions.pod:5261 ../src/guestfs-actions.pod:5314 ../src/guestfs-actions.pod:5361 ../src/guestfs-actions.pod:5404 ../src/guestfs-actions.pod:5432 ../src/guestfs-actions.pod:5449 ../src/guestfs-actions.pod:5467 ../src/guestfs-actions.pod:5607 ../src/guestfs-actions.pod:5664 ../src/guestfs-actions.pod:5686 ../src/guestfs-actions.pod:5704 ../src/guestfs-actions.pod:5736 ../src/guestfs-actions.pod:5802 ../src/guestfs-actions.pod:5819 ../src/guestfs-actions.pod:5832 ../src/guestfs-actions.pod:5846 ../src/guestfs-actions.pod:6135 ../src/guestfs-actions.pod:6154 ../src/guestfs-actions.pod:6173 ../src/guestfs-actions.pod:6187 ../src/guestfs-actions.pod:6199 ../src/guestfs-actions.pod:6213 ../src/guestfs-actions.pod:6225 ../src/guestfs-actions.pod:6239 ../src/guestfs-actions.pod:6255 ../src/guestfs-actions.pod:6276 ../src/guestfs-actions.pod:6295 ../src/guestfs-actions.pod:6314 ../src/guestfs-actions.pod:6344 ../src/guestfs-actions.pod:6362 ../src/guestfs-actions.pod:6385 ../src/guestfs-actions.pod:6403 ../src/guestfs-actions.pod:6422 ../src/guestfs-actions.pod:6443 ../src/guestfs-actions.pod:6462 ../src/guestfs-actions.pod:6479 ../src/guestfs-actions.pod:6498 ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6550 ../src/guestfs-actions.pod:6569 ../src/guestfs-actions.pod:6585 ../src/guestfs-actions.pod:6607 ../src/guestfs-actions.pod:6626 ../src/guestfs-actions.pod:6641 ../src/guestfs-actions.pod:6660 ../src/guestfs-actions.pod:6704 ../src/guestfs-actions.pod:6734 ../src/guestfs-actions.pod:6767 ../src/guestfs-actions.pod:6882 ../src/guestfs-actions.pod:7003 ../src/guestfs-actions.pod:7015 ../src/guestfs-actions.pod:7028 ../src/guestfs-actions.pod:7041 ../src/guestfs-actions.pod:7063 ../src/guestfs-actions.pod:7076 ../src/guestfs-actions.pod:7089 ../src/guestfs-actions.pod:7102 ../src/guestfs-actions.pod:7117 ../src/guestfs-actions.pod:7176 ../src/guestfs-actions.pod:7193 ../src/guestfs-actions.pod:7209 ../src/guestfs-actions.pod:7225 ../src/guestfs-actions.pod:7242 ../src/guestfs-actions.pod:7255 ../src/guestfs-actions.pod:7275 ../src/guestfs-actions.pod:7311 ../src/guestfs-actions.pod:7325 ../src/guestfs-actions.pod:7366 ../src/guestfs-actions.pod:7379 ../src/guestfs-actions.pod:7397 ../src/guestfs-actions.pod:7431 ../src/guestfs-actions.pod:7467 ../src/guestfs-actions.pod:7583 ../src/guestfs-actions.pod:7598 ../src/guestfs-actions.pod:7612 ../src/guestfs-actions.pod:7667 ../src/guestfs-actions.pod:7680 ../src/guestfs-actions.pod:7725 ../src/guestfs-actions.pod:7765 ../src/guestfs-actions.pod:7821 ../src/guestfs-actions.pod:7841 ../src/guestfs-actions.pod:7874 ../src/guestfs-actions.pod:7938 ../src/guestfs-actions.pod:7961 ../src/guestfs-actions.pod:7990
21732 msgid "This function returns 0 on success or -1 on error."
21733 msgstr ""
21734
21735 #. type: textblock
21736 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142 ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2190 ../src/guestfs-actions.pod:2313 ../src/guestfs-actions.pod:3770 ../src/guestfs-actions.pod:3790 ../src/guestfs-actions.pod:5098 ../src/guestfs-actions.pod:6364 ../src/guestfs-actions.pod:6481 ../src/guestfs-actions.pod:6628 ../src/guestfs-actions.pod:7119 ../src/guestfs-actions.pod:7244 ../src/guestfs-actions.pod:7767
21737 msgid "(Added in 0.3)"
21738 msgstr ""
21739
21740 #. type: =head2
21741 #: ../src/guestfs-actions.pod:41
21742 msgid "guestfs_add_domain"
21743 msgstr ""
21744
21745 #. type: verbatim
21746 #: ../src/guestfs-actions.pod:43
21747 #, no-wrap
21748 msgid ""
21749 " int\n"
21750 " guestfs_add_domain (guestfs_h *g,\n"
21751 "                     const char *dom,\n"
21752 "                     ...);\n"
21753 "\n"
21754 msgstr ""
21755
21756 #. type: textblock
21757 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151 ../src/guestfs-actions.pod:837 ../src/guestfs-actions.pod:1161 ../src/guestfs-actions.pod:1211 ../src/guestfs-actions.pod:2973 ../src/guestfs-actions.pod:4789 ../src/guestfs-actions.pod:5108 ../src/guestfs-actions.pod:5325
21758 msgid ""
21759 "You may supply a list of optional arguments to this call.  Use zero or more "
21760 "of the following pairs of parameters, and terminate the list with C<-1> on "
21761 "its own.  See L</CALLS WITH OPTIONAL ARGUMENTS>."
21762 msgstr ""
21763
21764 #. type: verbatim
21765 #: ../src/guestfs-actions.pod:53
21766 #, no-wrap
21767 msgid ""
21768 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
21769 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
21770 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
21771 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
21772 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
21773 "\n"
21774 msgstr ""
21775
21776 #. type: textblock
21777 #: ../src/guestfs-actions.pod:59
21778 msgid ""
21779 "This function adds the disk(s) attached to the named libvirt domain C<dom>.  "
21780 "It works by connecting to libvirt, requesting the domain and domain XML from "
21781 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
21782 "one."
21783 msgstr ""
21784
21785 #. type: textblock
21786 #: ../src/guestfs-actions.pod:94
21787 msgid ""
21788 "The other optional parameters are passed directly through to "
21789 "C<guestfs_add_drive_opts>."
21790 msgstr ""
21791
21792 #. type: textblock
21793 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350 ../src/guestfs-actions.pod:520 ../src/guestfs-actions.pod:698 ../src/guestfs-actions.pod:729 ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:766 ../src/guestfs-actions.pod:1492 ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:2051 ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:2213 ../src/guestfs-actions.pod:2265 ../src/guestfs-actions.pod:2277 ../src/guestfs-actions.pod:2300 ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:3091 ../src/guestfs-actions.pod:3109 ../src/guestfs-actions.pod:5284 ../src/guestfs-actions.pod:5504 ../src/guestfs-actions.pod:5916 ../src/guestfs-actions.pod:5942 ../src/guestfs-actions.pod:7352 ../src/guestfs-actions.pod:7778 ../src/guestfs-actions.pod:7791 ../src/guestfs-actions.pod:7804
21794 msgid "On error this function returns -1."
21795 msgstr ""
21796
21797 #. type: textblock
21798 #: ../src/guestfs-actions.pod:99
21799 msgid "(Added in 1.7.4)"
21800 msgstr ""
21801
21802 #. type: =head2
21803 #: ../src/guestfs-actions.pod:101
21804 msgid "guestfs_add_domain_va"
21805 msgstr ""
21806
21807 #. type: verbatim
21808 #: ../src/guestfs-actions.pod:103
21809 #, no-wrap
21810 msgid ""
21811 " int\n"
21812 " guestfs_add_domain_va (guestfs_h *g,\n"
21813 "                        const char *dom,\n"
21814 "                        va_list args);\n"
21815 "\n"
21816 msgstr ""
21817
21818 #. type: textblock
21819 #: ../src/guestfs-actions.pod:108
21820 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
21821 msgstr ""
21822
21823 #. type: textblock
21824 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121 ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225 ../src/guestfs-actions.pod:876 ../src/guestfs-actions.pod:887 ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1244 ../src/guestfs-actions.pod:1257 ../src/guestfs-actions.pod:3057 ../src/guestfs-actions.pod:3069 ../src/guestfs-actions.pod:4854 ../src/guestfs-actions.pod:4866 ../src/guestfs-actions.pod:5136 ../src/guestfs-actions.pod:5148 ../src/guestfs-actions.pod:5374 ../src/guestfs-actions.pod:5385
21825 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
21826 msgstr ""
21827
21828 #. type: =head2
21829 #: ../src/guestfs-actions.pod:112
21830 msgid "guestfs_add_domain_argv"
21831 msgstr ""
21832
21833 #. type: verbatim
21834 #: ../src/guestfs-actions.pod:114
21835 #, no-wrap
21836 msgid ""
21837 " int\n"
21838 " guestfs_add_domain_argv (guestfs_h *g,\n"
21839 "                          const char *dom,\n"
21840 "                          const struct guestfs_add_domain_argv *optargs);\n"
21841 "\n"
21842 msgstr ""
21843
21844 #. type: textblock
21845 #: ../src/guestfs-actions.pod:119
21846 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
21847 msgstr ""
21848
21849 #. type: =head2
21850 #: ../src/guestfs-actions.pod:123
21851 msgid "guestfs_add_drive"
21852 msgstr ""
21853
21854 #. type: verbatim
21855 #: ../src/guestfs-actions.pod:125
21856 #, no-wrap
21857 msgid ""
21858 " int\n"
21859 " guestfs_add_drive (guestfs_h *g,\n"
21860 "                    const char *filename);\n"
21861 "\n"
21862 msgstr ""
21863
21864 #. type: textblock
21865 #: ../src/guestfs-actions.pod:129
21866 msgid ""
21867 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
21868 "optional parameters, so the disk is added writable, with the format being "
21869 "detected automatically."
21870 msgstr ""
21871
21872 #. type: textblock
21873 #: ../src/guestfs-actions.pod:133
21874 msgid ""
21875 "Automatic detection of the format opens you up to a potential security hole "
21876 "when dealing with untrusted raw-format images.  See CVE-2010-3851 and "
21877 "RHBZ#642934.  Specifying the format closes this security hole.  Therefore "
21878 "you should think about replacing calls to this function with calls to "
21879 "C<guestfs_add_drive_opts>, and specifying the format."
21880 msgstr ""
21881
21882 #. type: =head2
21883 #: ../src/guestfs-actions.pod:144
21884 msgid "guestfs_add_drive_opts"
21885 msgstr ""
21886
21887 #. type: verbatim
21888 #: ../src/guestfs-actions.pod:146
21889 #, no-wrap
21890 msgid ""
21891 " int\n"
21892 " guestfs_add_drive_opts (guestfs_h *g,\n"
21893 "                         const char *filename,\n"
21894 "                         ...);\n"
21895 "\n"
21896 msgstr ""
21897
21898 #. type: verbatim
21899 #: ../src/guestfs-actions.pod:156
21900 #, no-wrap
21901 msgid ""
21902 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
21903 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
21904 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
21905 "\n"
21906 msgstr ""
21907
21908 #. type: textblock
21909 #: ../src/guestfs-actions.pod:185
21910 msgid ""
21911 "This forces the image format.  If you omit this (or use C<guestfs_add_drive> "
21912 "or C<guestfs_add_drive_ro>) then the format is automatically detected.  "
21913 "Possible formats include C<raw> and C<qcow2>."
21914 msgstr ""
21915
21916 #. type: textblock
21917 #: ../src/guestfs-actions.pod:196
21918 msgid ""
21919 "This rarely-used option lets you emulate the behaviour of the deprecated "
21920 "C<guestfs_add_drive_with_if> call (q.v.)"
21921 msgstr ""
21922
21923 #. type: textblock
21924 #: ../src/guestfs-actions.pod:203
21925 msgid "(Added in 1.5.23)"
21926 msgstr ""
21927
21928 #. type: =head2
21929 #: ../src/guestfs-actions.pod:205
21930 msgid "guestfs_add_drive_opts_va"
21931 msgstr ""
21932
21933 #. type: verbatim
21934 #: ../src/guestfs-actions.pod:207
21935 #, no-wrap
21936 msgid ""
21937 " int\n"
21938 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
21939 "                            const char *filename,\n"
21940 "                            va_list args);\n"
21941 "\n"
21942 msgstr ""
21943
21944 #. type: textblock
21945 #: ../src/guestfs-actions.pod:212
21946 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
21947 msgstr ""
21948
21949 #. type: =head2
21950 #: ../src/guestfs-actions.pod:216
21951 msgid "guestfs_add_drive_opts_argv"
21952 msgstr ""
21953
21954 #. type: verbatim
21955 #: ../src/guestfs-actions.pod:218
21956 #, no-wrap
21957 msgid ""
21958 " int\n"
21959 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
21960 "                              const char *filename,\n"
21961 "                              const struct guestfs_add_drive_opts_argv "
21962 "*optargs);\n"
21963 "\n"
21964 msgstr ""
21965
21966 #. type: textblock
21967 #: ../src/guestfs-actions.pod:223
21968 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
21969 msgstr ""
21970
21971 #. type: =head2
21972 #: ../src/guestfs-actions.pod:227
21973 msgid "guestfs_add_drive_ro"
21974 msgstr ""
21975
21976 #. type: verbatim
21977 #: ../src/guestfs-actions.pod:229
21978 #, no-wrap
21979 msgid ""
21980 " int\n"
21981 " guestfs_add_drive_ro (guestfs_h *g,\n"
21982 "                       const char *filename);\n"
21983 "\n"
21984 msgstr ""
21985
21986 #. type: textblock
21987 #: ../src/guestfs-actions.pod:233
21988 msgid ""
21989 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
21990 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
21991 "disk is added read-only, with the format being detected automatically."
21992 msgstr ""
21993
21994 #. type: textblock
21995 #: ../src/guestfs-actions.pod:240
21996 msgid "(Added in 1.0.38)"
21997 msgstr ""
21998
21999 #. type: =head2
22000 #: ../src/guestfs-actions.pod:242
22001 msgid "guestfs_add_drive_ro_with_if"
22002 msgstr ""
22003
22004 #. type: verbatim
22005 #: ../src/guestfs-actions.pod:244
22006 #, no-wrap
22007 msgid ""
22008 " int\n"
22009 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
22010 "                               const char *filename,\n"
22011 "                               const char *iface);\n"
22012 "\n"
22013 msgstr ""
22014
22015 #. type: textblock
22016 #: ../src/guestfs-actions.pod:256
22017 msgid ""
22018 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
22019 "QEMU interface emulation to use at run time."
22020 msgstr ""
22021
22022 #. type: textblock
22023 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282 ../src/guestfs-actions.pod:2574
22024 msgid "(Added in 1.0.84)"
22025 msgstr ""
22026
22027 #. type: =head2
22028 #: ../src/guestfs-actions.pod:263
22029 msgid "guestfs_add_drive_with_if"
22030 msgstr ""
22031
22032 #. type: verbatim
22033 #: ../src/guestfs-actions.pod:265
22034 #, no-wrap
22035 msgid ""
22036 " int\n"
22037 " guestfs_add_drive_with_if (guestfs_h *g,\n"
22038 "                            const char *filename,\n"
22039 "                            const char *iface);\n"
22040 "\n"
22041 msgstr ""
22042
22043 #. type: textblock
22044 #: ../src/guestfs-actions.pod:277
22045 msgid ""
22046 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
22047 "QEMU interface emulation to use at run time."
22048 msgstr ""
22049
22050 #. type: =head2
22051 #: ../src/guestfs-actions.pod:284
22052 msgid "guestfs_aug_clear"
22053 msgstr ""
22054
22055 #. type: verbatim
22056 #: ../src/guestfs-actions.pod:286
22057 #, no-wrap
22058 msgid ""
22059 " int\n"
22060 " guestfs_aug_clear (guestfs_h *g,\n"
22061 "                    const char *augpath);\n"
22062 "\n"
22063 msgstr ""
22064
22065 #. type: textblock
22066 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2302
22067 msgid "(Added in 1.3.4)"
22068 msgstr ""
22069
22070 #. type: =head2
22071 #: ../src/guestfs-actions.pod:297
22072 msgid "guestfs_aug_close"
22073 msgstr ""
22074
22075 #. type: verbatim
22076 #: ../src/guestfs-actions.pod:299
22077 #, no-wrap
22078 msgid ""
22079 " int\n"
22080 " guestfs_aug_close (guestfs_h *g);\n"
22081 "\n"
22082 msgstr ""
22083
22084 #. type: textblock
22085 #: ../src/guestfs-actions.pod:302
22086 msgid ""
22087 "Close the current Augeas handle and free up any resources used by it.  After "
22088 "calling this, you have to call C<guestfs_aug_init> again before you can use "
22089 "any other Augeas functions."
22090 msgstr ""
22091
22092 #. type: textblock
22093 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334 ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366 ../src/guestfs-actions.pod:429 ../src/guestfs-actions.pod:449 ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:494 ../src/guestfs-actions.pod:508 ../src/guestfs-actions.pod:522 ../src/guestfs-actions.pod:536 ../src/guestfs-actions.pod:554 ../src/guestfs-actions.pod:5993
22094 msgid "(Added in 0.7)"
22095 msgstr ""
22096
22097 #. type: =head2
22098 #: ../src/guestfs-actions.pod:311
22099 msgid "guestfs_aug_defnode"
22100 msgstr ""
22101
22102 #. type: verbatim
22103 #: ../src/guestfs-actions.pod:313
22104 #, no-wrap
22105 msgid ""
22106 " struct guestfs_int_bool *\n"
22107 " guestfs_aug_defnode (guestfs_h *g,\n"
22108 "                      const char *name,\n"
22109 "                      const char *expr,\n"
22110 "                      const char *val);\n"
22111 "\n"
22112 msgstr ""
22113
22114 #. type: textblock
22115 #: ../src/guestfs-actions.pod:322
22116 msgid ""
22117 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22118 "calling C<guestfs_aug_set> C<expr>, C<value>.  C<name> will be the nodeset "
22119 "containing that single node."
22120 msgstr ""
22121
22122 #. type: textblock
22123 #: ../src/guestfs-actions.pod:330
22124 msgid ""
22125 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
22126 "an error.  I<The caller must call C<guestfs_free_int_bool> after use>."
22127 msgstr ""
22128
22129 #. type: =head2
22130 #: ../src/guestfs-actions.pod:336
22131 msgid "guestfs_aug_defvar"
22132 msgstr ""
22133
22134 #. type: verbatim
22135 #: ../src/guestfs-actions.pod:338
22136 #, no-wrap
22137 msgid ""
22138 " int\n"
22139 " guestfs_aug_defvar (guestfs_h *g,\n"
22140 "                     const char *name,\n"
22141 "                     const char *expr);\n"
22142 "\n"
22143 msgstr ""
22144
22145 #. type: =head2
22146 #: ../src/guestfs-actions.pod:354
22147 msgid "guestfs_aug_get"
22148 msgstr ""
22149
22150 #. type: verbatim
22151 #: ../src/guestfs-actions.pod:356
22152 #, no-wrap
22153 msgid ""
22154 " char *\n"
22155 " guestfs_aug_get (guestfs_h *g,\n"
22156 "                  const char *augpath);\n"
22157 "\n"
22158 msgstr ""
22159
22160 #. type: textblock
22161 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:927 ../src/guestfs-actions.pod:945 ../src/guestfs-actions.pod:1005 ../src/guestfs-actions.pod:1021 ../src/guestfs-actions.pod:1124 ../src/guestfs-actions.pod:1361 ../src/guestfs-actions.pod:1378 ../src/guestfs-actions.pod:1397 ../src/guestfs-actions.pod:1531 ../src/guestfs-actions.pod:1719 ../src/guestfs-actions.pod:1831 ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2121 ../src/guestfs-actions.pod:2142 ../src/guestfs-actions.pod:2325 ../src/guestfs-actions.pod:2539 ../src/guestfs-actions.pod:2743 ../src/guestfs-actions.pod:2837 ../src/guestfs-actions.pod:2941 ../src/guestfs-actions.pod:2960 ../src/guestfs-actions.pod:3174 ../src/guestfs-actions.pod:3202 ../src/guestfs-actions.pod:3223 ../src/guestfs-actions.pod:3257 ../src/guestfs-actions.pod:3316 ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3356 ../src/guestfs-actions.pod:3983 ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:4506 ../src/guestfs-actions.pod:4616 ../src/guestfs-actions.pod:5522 ../src/guestfs-actions.pod:5721 ../src/guestfs-actions.pod:5891 ../src/guestfs-actions.pod:6069 ../src/guestfs-actions.pod:6118 ../src/guestfs-actions.pod:6788 ../src/guestfs-actions.pod:6804 ../src/guestfs-actions.pod:6828 ../src/guestfs-actions.pod:6852 ../src/guestfs-actions.pod:7526 ../src/guestfs-actions.pod:7545 ../src/guestfs-actions.pod:7563 ../src/guestfs-actions.pod:7737 ../src/guestfs-actions.pod:8054
22162 msgid ""
22163 "This function returns a string, or NULL on error.  I<The caller must free "
22164 "the returned string after use>."
22165 msgstr ""
22166
22167 #. type: =head2
22168 #: ../src/guestfs-actions.pod:368
22169 msgid "guestfs_aug_init"
22170 msgstr ""
22171
22172 #. type: verbatim
22173 #: ../src/guestfs-actions.pod:370
22174 #, no-wrap
22175 msgid ""
22176 " int\n"
22177 " guestfs_aug_init (guestfs_h *g,\n"
22178 "                   const char *root,\n"
22179 "                   int flags);\n"
22180 "\n"
22181 msgstr ""
22182
22183 #. type: textblock
22184 #: ../src/guestfs-actions.pod:379
22185 msgid "You must call this before using any other C<guestfs_aug_*> commands."
22186 msgstr ""
22187
22188 #. type: textblock
22189 #: ../src/guestfs-actions.pod:404
22190 msgid ""
22191 "This option is only useful when debugging Augeas lenses.  Use of this option "
22192 "may require additional memory for the libguestfs appliance.  You may need to "
22193 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
22194 "C<guestfs_set_memsize>."
22195 msgstr ""
22196
22197 #. type: textblock
22198 #: ../src/guestfs-actions.pod:419
22199 msgid "Do not load the tree in C<guestfs_aug_init>."
22200 msgstr ""
22201
22202 #. type: textblock
22203 #: ../src/guestfs-actions.pod:423
22204 msgid "To close the handle, you can call C<guestfs_aug_close>."
22205 msgstr ""
22206
22207 #. type: =head2
22208 #: ../src/guestfs-actions.pod:431
22209 msgid "guestfs_aug_insert"
22210 msgstr ""
22211
22212 #. type: verbatim
22213 #: ../src/guestfs-actions.pod:433
22214 #, no-wrap
22215 msgid ""
22216 " int\n"
22217 " guestfs_aug_insert (guestfs_h *g,\n"
22218 "                     const char *augpath,\n"
22219 "                     const char *label,\n"
22220 "                     int before);\n"
22221 "\n"
22222 msgstr ""
22223
22224 #. type: =head2
22225 #: ../src/guestfs-actions.pod:451
22226 msgid "guestfs_aug_load"
22227 msgstr ""
22228
22229 #. type: verbatim
22230 #: ../src/guestfs-actions.pod:453
22231 #, no-wrap
22232 msgid ""
22233 " int\n"
22234 " guestfs_aug_load (guestfs_h *g);\n"
22235 "\n"
22236 msgstr ""
22237
22238 #. type: =head2
22239 #: ../src/guestfs-actions.pod:465
22240 msgid "guestfs_aug_ls"
22241 msgstr ""
22242
22243 #. type: verbatim
22244 #: ../src/guestfs-actions.pod:467
22245 #, no-wrap
22246 msgid ""
22247 " char **\n"
22248 " guestfs_aug_ls (guestfs_h *g,\n"
22249 "                 const char *augpath);\n"
22250 "\n"
22251 msgstr ""
22252
22253 #. type: textblock
22254 #: ../src/guestfs-actions.pod:471
22255 msgid ""
22256 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
22257 "sorting the resulting nodes into alphabetical order."
22258 msgstr ""
22259
22260 #. type: textblock
22261 #: ../src/guestfs-actions.pod:474 ../src/guestfs-actions.pod:490 ../src/guestfs-actions.pod:636 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1546 ../src/guestfs-actions.pod:1565 ../src/guestfs-actions.pod:1668 ../src/guestfs-actions.pod:1687 ../src/guestfs-actions.pod:1933 ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2413 ../src/guestfs-actions.pod:2432 ../src/guestfs-actions.pod:2497 ../src/guestfs-actions.pod:2521 ../src/guestfs-actions.pod:2592 ../src/guestfs-actions.pod:2641 ../src/guestfs-actions.pod:2902 ../src/guestfs-actions.pod:3276 ../src/guestfs-actions.pod:3552 ../src/guestfs-actions.pod:3866 ../src/guestfs-actions.pod:3883 ../src/guestfs-actions.pod:3903 ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:4070 ../src/guestfs-actions.pod:4478 ../src/guestfs-actions.pod:5245 ../src/guestfs-actions.pod:5863 ../src/guestfs-actions.pod:5989 ../src/guestfs-actions.pod:6103 ../src/guestfs-actions.pod:6868 ../src/guestfs-actions.pod:6929 ../src/guestfs-actions.pod:6984 ../src/guestfs-actions.pod:7130 ../src/guestfs-actions.pod:7154 ../src/guestfs-actions.pod:7630 ../src/guestfs-actions.pod:7650 ../src/guestfs-actions.pod:7697 ../src/guestfs-actions.pod:7891 ../src/guestfs-actions.pod:7910 ../src/guestfs-actions.pod:8004 ../src/guestfs-actions.pod:8023 ../src/guestfs-actions.pod:8069 ../src/guestfs-actions.pod:8088
22262 msgid ""
22263 "This function returns a NULL-terminated array of strings (like "
22264 "L<environ(3)>), or NULL if there was an error.  I<The caller must free the "
22265 "strings and the array after use>."
22266 msgstr ""
22267
22268 #. type: textblock
22269 #: ../src/guestfs-actions.pod:478 ../src/guestfs-actions.pod:1068 ../src/guestfs-actions.pod:1086 ../src/guestfs-actions.pod:1603 ../src/guestfs-actions.pod:3630 ../src/guestfs-actions.pod:3661 ../src/guestfs-actions.pod:4319 ../src/guestfs-actions.pod:4369 ../src/guestfs-actions.pod:4556 ../src/guestfs-actions.pod:4589 ../src/guestfs-actions.pod:4752 ../src/guestfs-actions.pod:5249 ../src/guestfs-actions.pod:5804 ../src/guestfs-actions.pod:6201 ../src/guestfs-actions.pod:6215 ../src/guestfs-actions.pod:6227 ../src/guestfs-actions.pod:6709 ../src/guestfs-actions.pod:7368 ../src/guestfs-actions.pod:7381 ../src/guestfs-actions.pod:7614 ../src/guestfs-actions.pod:7879
22270 msgid "(Added in 0.8)"
22271 msgstr ""
22272
22273 #. type: =head2
22274 #: ../src/guestfs-actions.pod:480
22275 msgid "guestfs_aug_match"
22276 msgstr ""
22277
22278 #. type: verbatim
22279 #: ../src/guestfs-actions.pod:482
22280 #, no-wrap
22281 msgid ""
22282 " char **\n"
22283 " guestfs_aug_match (guestfs_h *g,\n"
22284 "                    const char *augpath);\n"
22285 "\n"
22286 msgstr ""
22287
22288 #. type: =head2
22289 #: ../src/guestfs-actions.pod:496
22290 msgid "guestfs_aug_mv"
22291 msgstr ""
22292
22293 #. type: verbatim
22294 #: ../src/guestfs-actions.pod:498
22295 #, no-wrap
22296 msgid ""
22297 " int\n"
22298 " guestfs_aug_mv (guestfs_h *g,\n"
22299 "                 const char *src,\n"
22300 "                 const char *dest);\n"
22301 "\n"
22302 msgstr ""
22303
22304 #. type: =head2
22305 #: ../src/guestfs-actions.pod:510
22306 msgid "guestfs_aug_rm"
22307 msgstr ""
22308
22309 #. type: verbatim
22310 #: ../src/guestfs-actions.pod:512
22311 #, no-wrap
22312 msgid ""
22313 " int\n"
22314 " guestfs_aug_rm (guestfs_h *g,\n"
22315 "                 const char *augpath);\n"
22316 "\n"
22317 msgstr ""
22318
22319 #. type: =head2
22320 #: ../src/guestfs-actions.pod:524
22321 msgid "guestfs_aug_save"
22322 msgstr ""
22323
22324 #. type: verbatim
22325 #: ../src/guestfs-actions.pod:526
22326 #, no-wrap
22327 msgid ""
22328 " int\n"
22329 " guestfs_aug_save (guestfs_h *g);\n"
22330 "\n"
22331 msgstr ""
22332
22333 #. type: textblock
22334 #: ../src/guestfs-actions.pod:531
22335 msgid ""
22336 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
22337 "are saved."
22338 msgstr ""
22339
22340 #. type: =head2
22341 #: ../src/guestfs-actions.pod:538
22342 msgid "guestfs_aug_set"
22343 msgstr ""
22344
22345 #. type: verbatim
22346 #: ../src/guestfs-actions.pod:540
22347 #, no-wrap
22348 msgid ""
22349 " int\n"
22350 " guestfs_aug_set (guestfs_h *g,\n"
22351 "                  const char *augpath,\n"
22352 "                  const char *val);\n"
22353 "\n"
22354 msgstr ""
22355
22356 #. type: textblock
22357 #: ../src/guestfs-actions.pod:547
22358 msgid ""
22359 "In the Augeas API, it is possible to clear a node by setting the value to "
22360 "NULL.  Due to an oversight in the libguestfs API you cannot do that with "
22361 "this call.  Instead you must use the C<guestfs_aug_clear> call."
22362 msgstr ""
22363
22364 #. type: =head2
22365 #: ../src/guestfs-actions.pod:556
22366 msgid "guestfs_available"
22367 msgstr ""
22368
22369 #. type: verbatim
22370 #: ../src/guestfs-actions.pod:558
22371 #, no-wrap
22372 msgid ""
22373 " int\n"
22374 " guestfs_available (guestfs_h *g,\n"
22375 "                    char *const *groups);\n"
22376 "\n"
22377 msgstr ""
22378
22379 #. type: textblock
22380 #: ../src/guestfs-actions.pod:566
22381 msgid ""
22382 "The libguestfs groups, and the functions that those groups correspond to, "
22383 "are listed in L<guestfs(3)/AVAILABILITY>.  You can also fetch this list at "
22384 "runtime by calling C<guestfs_available_all_groups>."
22385 msgstr ""
22386
22387 #. type: textblock
22388 #: ../src/guestfs-actions.pod:590
22389 msgid "You must call C<guestfs_launch> before calling this function."
22390 msgstr ""
22391
22392 #. type: textblock
22393 #: ../src/guestfs-actions.pod:612
22394 msgid ""
22395 "This call was added in version C<1.0.80>.  In previous versions of "
22396 "libguestfs all you could do would be to speculatively execute a command to "
22397 "find out if the daemon implemented it.  See also C<guestfs_version>."
22398 msgstr ""
22399
22400 #. type: textblock
22401 #: ../src/guestfs-actions.pod:621 ../src/guestfs-actions.pod:1348
22402 msgid "(Added in 1.0.80)"
22403 msgstr ""
22404
22405 #. type: =head2
22406 #: ../src/guestfs-actions.pod:623
22407 msgid "guestfs_available_all_groups"
22408 msgstr ""
22409
22410 #. type: verbatim
22411 #: ../src/guestfs-actions.pod:625
22412 #, no-wrap
22413 msgid ""
22414 " char **\n"
22415 " guestfs_available_all_groups (guestfs_h *g);\n"
22416 "\n"
22417 msgstr ""
22418
22419 #. type: textblock
22420 #: ../src/guestfs-actions.pod:628
22421 msgid ""
22422 "This command returns a list of all optional groups that this daemon knows "
22423 "about.  Note this returns both supported and unsupported groups.  To find "
22424 "out which ones the daemon can actually support you have to call "
22425 "C<guestfs_available> on each member of the returned list."
22426 msgstr ""
22427
22428 #. type: textblock
22429 #: ../src/guestfs-actions.pod:634
22430 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
22431 msgstr ""
22432
22433 #. type: textblock
22434 #: ../src/guestfs-actions.pod:640
22435 msgid "(Added in 1.3.15)"
22436 msgstr ""
22437
22438 #. type: =head2
22439 #: ../src/guestfs-actions.pod:642
22440 msgid "guestfs_base64_in"
22441 msgstr ""
22442
22443 #. type: verbatim
22444 #: ../src/guestfs-actions.pod:644
22445 #, no-wrap
22446 msgid ""
22447 " int\n"
22448 " guestfs_base64_in (guestfs_h *g,\n"
22449 "                    const char *base64file,\n"
22450 "                    const char *filename);\n"
22451 "\n"
22452 msgstr ""
22453
22454 #. type: textblock
22455 #: ../src/guestfs-actions.pod:654 ../src/guestfs-actions.pod:668
22456 msgid "(Added in 1.3.5)"
22457 msgstr ""
22458
22459 #. type: =head2
22460 #: ../src/guestfs-actions.pod:656
22461 msgid "guestfs_base64_out"
22462 msgstr ""
22463
22464 #. type: verbatim
22465 #: ../src/guestfs-actions.pod:658
22466 #, no-wrap
22467 msgid ""
22468 " int\n"
22469 " guestfs_base64_out (guestfs_h *g,\n"
22470 "                     const char *filename,\n"
22471 "                     const char *base64file);\n"
22472 "\n"
22473 msgstr ""
22474
22475 #. type: =head2
22476 #: ../src/guestfs-actions.pod:670
22477 msgid "guestfs_blockdev_flushbufs"
22478 msgstr ""
22479
22480 #. type: verbatim
22481 #: ../src/guestfs-actions.pod:672
22482 #, no-wrap
22483 msgid ""
22484 " int\n"
22485 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
22486 "                             const char *device);\n"
22487 "\n"
22488 msgstr ""
22489
22490 #. type: textblock
22491 #: ../src/guestfs-actions.pod:683 ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:715 ../src/guestfs-actions.pod:731 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:768 ../src/guestfs-actions.pod:782 ../src/guestfs-actions.pod:800 ../src/guestfs-actions.pod:814 ../src/guestfs-actions.pod:828
22492 msgid "(Added in 0.9.3)"
22493 msgstr ""
22494
22495 #. type: =head2
22496 #: ../src/guestfs-actions.pod:685
22497 msgid "guestfs_blockdev_getbsz"
22498 msgstr ""
22499
22500 #. type: verbatim
22501 #: ../src/guestfs-actions.pod:687
22502 #, no-wrap
22503 msgid ""
22504 " int\n"
22505 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
22506 "                          const char *device);\n"
22507 "\n"
22508 msgstr ""
22509
22510 #. type: =head2
22511 #: ../src/guestfs-actions.pod:702
22512 msgid "guestfs_blockdev_getro"
22513 msgstr ""
22514
22515 #. type: verbatim
22516 #: ../src/guestfs-actions.pod:704
22517 #, no-wrap
22518 msgid ""
22519 " int\n"
22520 " guestfs_blockdev_getro (guestfs_h *g,\n"
22521 "                         const char *device);\n"
22522 "\n"
22523 msgstr ""
22524
22525 #. type: textblock
22526 #: ../src/guestfs-actions.pod:713 ../src/guestfs-actions.pod:1586 ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:2090 ../src/guestfs-actions.pod:2101 ../src/guestfs-actions.pod:2173 ../src/guestfs-actions.pod:2199 ../src/guestfs-actions.pod:2239 ../src/guestfs-actions.pod:2254 ../src/guestfs-actions.pod:2288 ../src/guestfs-actions.pod:2311 ../src/guestfs-actions.pod:3373 ../src/guestfs-actions.pod:3389 ../src/guestfs-actions.pod:3407 ../src/guestfs-actions.pod:3569 ../src/guestfs-actions.pod:3583 ../src/guestfs-actions.pod:3598 ../src/guestfs-actions.pod:3612 ../src/guestfs-actions.pod:3628 ../src/guestfs-actions.pod:3643 ../src/guestfs-actions.pod:3659 ../src/guestfs-actions.pod:3673 ../src/guestfs-actions.pod:3686 ../src/guestfs-actions.pod:3700 ../src/guestfs-actions.pod:3715 ../src/guestfs-actions.pod:3730 ../src/guestfs-actions.pod:3743 ../src/guestfs-actions.pod:3757 ../src/guestfs-actions.pod:5486
22527 msgid "This function returns a C truth value on success or -1 on error."
22528 msgstr ""
22529
22530 #. type: =head2
22531 #: ../src/guestfs-actions.pod:717
22532 msgid "guestfs_blockdev_getsize64"
22533 msgstr ""
22534
22535 #. type: verbatim
22536 #: ../src/guestfs-actions.pod:719
22537 #, no-wrap
22538 msgid ""
22539 " int64_t\n"
22540 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
22541 "                             const char *device);\n"
22542 "\n"
22543 msgstr ""
22544
22545 #. type: textblock
22546 #: ../src/guestfs-actions.pod:725
22547 msgid "See also C<guestfs_blockdev_getsz>."
22548 msgstr ""
22549
22550 #. type: =head2
22551 #: ../src/guestfs-actions.pod:733
22552 msgid "guestfs_blockdev_getss"
22553 msgstr ""
22554
22555 #. type: verbatim
22556 #: ../src/guestfs-actions.pod:735
22557 #, no-wrap
22558 msgid ""
22559 " int\n"
22560 " guestfs_blockdev_getss (guestfs_h *g,\n"
22561 "                         const char *device);\n"
22562 "\n"
22563 msgstr ""
22564
22565 #. type: textblock
22566 #: ../src/guestfs-actions.pod:742
22567 msgid ""
22568 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
22569 "that)."
22570 msgstr ""
22571
22572 #. type: =head2
22573 #: ../src/guestfs-actions.pod:751
22574 msgid "guestfs_blockdev_getsz"
22575 msgstr ""
22576
22577 #. type: verbatim
22578 #: ../src/guestfs-actions.pod:753
22579 #, no-wrap
22580 msgid ""
22581 " int64_t\n"
22582 " guestfs_blockdev_getsz (guestfs_h *g,\n"
22583 "                         const char *device);\n"
22584 "\n"
22585 msgstr ""
22586
22587 #. type: textblock
22588 #: ../src/guestfs-actions.pod:760
22589 msgid ""
22590 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
22591 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
22592 msgstr ""
22593
22594 #. type: =head2
22595 #: ../src/guestfs-actions.pod:770
22596 msgid "guestfs_blockdev_rereadpt"
22597 msgstr ""
22598
22599 #. type: verbatim
22600 #: ../src/guestfs-actions.pod:772
22601 #, no-wrap
22602 msgid ""
22603 " int\n"
22604 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
22605 "                            const char *device);\n"
22606 "\n"
22607 msgstr ""
22608
22609 #. type: =head2
22610 #: ../src/guestfs-actions.pod:784
22611 msgid "guestfs_blockdev_setbsz"
22612 msgstr ""
22613
22614 #. type: verbatim
22615 #: ../src/guestfs-actions.pod:786
22616 #, no-wrap
22617 msgid ""
22618 " int\n"
22619 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
22620 "                          const char *device,\n"
22621 "                          int blocksize);\n"
22622 "\n"
22623 msgstr ""
22624
22625 #. type: =head2
22626 #: ../src/guestfs-actions.pod:802
22627 msgid "guestfs_blockdev_setro"
22628 msgstr ""
22629
22630 #. type: verbatim
22631 #: ../src/guestfs-actions.pod:804
22632 #, no-wrap
22633 msgid ""
22634 " int\n"
22635 " guestfs_blockdev_setro (guestfs_h *g,\n"
22636 "                         const char *device);\n"
22637 "\n"
22638 msgstr ""
22639
22640 #. type: =head2
22641 #: ../src/guestfs-actions.pod:816
22642 msgid "guestfs_blockdev_setrw"
22643 msgstr ""
22644
22645 #. type: verbatim
22646 #: ../src/guestfs-actions.pod:818
22647 #, no-wrap
22648 msgid ""
22649 " int\n"
22650 " guestfs_blockdev_setrw (guestfs_h *g,\n"
22651 "                         const char *device);\n"
22652 "\n"
22653 msgstr ""
22654
22655 #. type: =head2
22656 #: ../src/guestfs-actions.pod:830
22657 msgid "guestfs_btrfs_filesystem_resize"
22658 msgstr ""
22659
22660 #. type: verbatim
22661 #: ../src/guestfs-actions.pod:832
22662 #, no-wrap
22663 msgid ""
22664 " int\n"
22665 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
22666 "                                  const char *mountpoint,\n"
22667 "                                  ...);\n"
22668 "\n"
22669 msgstr ""
22670
22671 #. type: verbatim
22672 #: ../src/guestfs-actions.pod:842
22673 #, no-wrap
22674 msgid ""
22675 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
22676 "\n"
22677 msgstr ""
22678
22679 #. type: textblock
22680 #: ../src/guestfs-actions.pod:865
22681 msgid "(Added in 1.11.17)"
22682 msgstr ""
22683
22684 #. type: =head2
22685 #: ../src/guestfs-actions.pod:867
22686 msgid "guestfs_btrfs_filesystem_resize_va"
22687 msgstr ""
22688
22689 #. type: verbatim
22690 #: ../src/guestfs-actions.pod:869
22691 #, no-wrap
22692 msgid ""
22693 " int\n"
22694 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
22695 "                                     const char *mountpoint,\n"
22696 "                                     va_list args);\n"
22697 "\n"
22698 msgstr ""
22699
22700 #. type: textblock
22701 #: ../src/guestfs-actions.pod:874
22702 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
22703 msgstr ""
22704
22705 #. type: =head2
22706 #: ../src/guestfs-actions.pod:878
22707 msgid "guestfs_btrfs_filesystem_resize_argv"
22708 msgstr ""
22709
22710 #. type: verbatim
22711 #: ../src/guestfs-actions.pod:880
22712 #, no-wrap
22713 msgid ""
22714 " int\n"
22715 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
22716 "                                       const char *mountpoint,\n"
22717 "                                       const struct "
22718 "guestfs_btrfs_filesystem_resize_argv *optargs);\n"
22719 "\n"
22720 msgstr ""
22721
22722 #. type: textblock
22723 #: ../src/guestfs-actions.pod:885
22724 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
22725 msgstr ""
22726
22727 #. type: =head2
22728 #: ../src/guestfs-actions.pod:889
22729 msgid "guestfs_case_sensitive_path"
22730 msgstr ""
22731
22732 #. type: verbatim
22733 #: ../src/guestfs-actions.pod:891
22734 #, no-wrap
22735 msgid ""
22736 " char *\n"
22737 " guestfs_case_sensitive_path (guestfs_h *g,\n"
22738 "                              const char *path);\n"
22739 "\n"
22740 msgstr ""
22741
22742 #. type: textblock
22743 #: ../src/guestfs-actions.pod:917
22744 msgid ""
22745 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")  might return "
22746 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
22747 "how the directories were originally created under Windows)."
22748 msgstr ""
22749
22750 #. type: textblock
22751 #: ../src/guestfs-actions.pod:925
22752 msgid "See also C<guestfs_realpath>."
22753 msgstr ""
22754
22755 #. type: textblock
22756 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:7548
22757 msgid "(Added in 1.0.75)"
22758 msgstr ""
22759
22760 #. type: =head2
22761 #: ../src/guestfs-actions.pod:932
22762 msgid "guestfs_cat"
22763 msgstr ""
22764
22765 #. type: verbatim
22766 #: ../src/guestfs-actions.pod:934
22767 #, no-wrap
22768 msgid ""
22769 " char *\n"
22770 " guestfs_cat (guestfs_h *g,\n"
22771 "              const char *path);\n"
22772 "\n"
22773 msgstr ""
22774
22775 #. type: textblock
22776 #: ../src/guestfs-actions.pod:940
22777 msgid ""
22778 "Note that this function cannot correctly handle binary files (specifically, "
22779 "files containing C<\\0> character which is treated as end of string).  For "
22780 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
22781 "functions which have a more complex interface."
22782 msgstr ""
22783
22784 #. type: textblock
22785 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:3887 ../src/guestfs-actions.pod:3969 ../src/guestfs-actions.pod:3986 ../src/guestfs-actions.pod:4074 ../src/guestfs-actions.pod:4482 ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:5867 ../src/guestfs-actions.pod:5881 ../src/guestfs-actions.pod:7701 ../src/guestfs-actions.pod:7715
22786 msgid "(Added in 0.4)"
22787 msgstr ""
22788
22789 #. type: =head2
22790 #: ../src/guestfs-actions.pod:953
22791 msgid "guestfs_checksum"
22792 msgstr ""
22793
22794 #. type: verbatim
22795 #: ../src/guestfs-actions.pod:955
22796 #, no-wrap
22797 msgid ""
22798 " char *\n"
22799 " guestfs_checksum (guestfs_h *g,\n"
22800 "                   const char *csumtype,\n"
22801 "                   const char *path);\n"
22802 "\n"
22803 msgstr ""
22804
22805 #. type: textblock
22806 #: ../src/guestfs-actions.pod:1001
22807 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
22808 msgstr ""
22809
22810 #. type: textblock
22811 #: ../src/guestfs-actions.pod:1003
22812 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
22813 msgstr ""
22814
22815 #. type: textblock
22816 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1423 ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:3585 ../src/guestfs-actions.pod:3614 ../src/guestfs-actions.pod:3675 ../src/guestfs-actions.pod:3702 ../src/guestfs-actions.pod:7404
22817 msgid "(Added in 1.0.2)"
22818 msgstr ""
22819
22820 #. type: =head2
22821 #: ../src/guestfs-actions.pod:1010
22822 msgid "guestfs_checksum_device"
22823 msgstr ""
22824
22825 #. type: verbatim
22826 #: ../src/guestfs-actions.pod:1012
22827 #, no-wrap
22828 msgid ""
22829 " char *\n"
22830 " guestfs_checksum_device (guestfs_h *g,\n"
22831 "                          const char *csumtype,\n"
22832 "                          const char *device);\n"
22833 "\n"
22834 msgstr ""
22835
22836 #. type: textblock
22837 #: ../src/guestfs-actions.pod:1017
22838 msgid ""
22839 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22840 "device named C<device>.  For the types of checksums supported see the "
22841 "C<guestfs_checksum> command."
22842 msgstr ""
22843
22844 #. type: textblock
22845 #: ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:5316 ../src/guestfs-actions.pod:5451 ../src/guestfs-actions.pod:5488 ../src/guestfs-actions.pod:5506 ../src/guestfs-actions.pod:5688 ../src/guestfs-actions.pod:7313 ../src/guestfs-actions.pod:7327 ../src/guestfs-actions.pod:7727
22846 msgid "(Added in 1.3.2)"
22847 msgstr ""
22848
22849 #. type: =head2
22850 #: ../src/guestfs-actions.pod:1026
22851 msgid "guestfs_checksums_out"
22852 msgstr ""
22853
22854 #. type: verbatim
22855 #: ../src/guestfs-actions.pod:1028
22856 #, no-wrap
22857 msgid ""
22858 " int\n"
22859 " guestfs_checksums_out (guestfs_h *g,\n"
22860 "                        const char *csumtype,\n"
22861 "                        const char *directory,\n"
22862 "                        const char *sumsfile);\n"
22863 "\n"
22864 msgstr ""
22865
22866 #. type: textblock
22867 #: ../src/guestfs-actions.pod:1048
22868 msgid "(Added in 1.3.7)"
22869 msgstr ""
22870
22871 #. type: =head2
22872 #: ../src/guestfs-actions.pod:1050
22873 msgid "guestfs_chmod"
22874 msgstr ""
22875
22876 #. type: verbatim
22877 #: ../src/guestfs-actions.pod:1052
22878 #, no-wrap
22879 msgid ""
22880 " int\n"
22881 " guestfs_chmod (guestfs_h *g,\n"
22882 "                int mode,\n"
22883 "                const char *path);\n"
22884 "\n"
22885 msgstr ""
22886
22887 #. type: =head2
22888 #: ../src/guestfs-actions.pod:1070
22889 msgid "guestfs_chown"
22890 msgstr ""
22891
22892 #. type: verbatim
22893 #: ../src/guestfs-actions.pod:1072
22894 #, no-wrap
22895 msgid ""
22896 " int\n"
22897 " guestfs_chown (guestfs_h *g,\n"
22898 "                int owner,\n"
22899 "                int group,\n"
22900 "                const char *path);\n"
22901 "\n"
22902 msgstr ""
22903
22904 #. type: =head2
22905 #: ../src/guestfs-actions.pod:1088
22906 msgid "guestfs_command"
22907 msgstr ""
22908
22909 #. type: verbatim
22910 #: ../src/guestfs-actions.pod:1090
22911 #, no-wrap
22912 msgid ""
22913 " char *\n"
22914 " guestfs_command (guestfs_h *g,\n"
22915 "                  char *const *arguments);\n"
22916 "\n"
22917 msgstr ""
22918
22919 #. type: textblock
22920 #: ../src/guestfs-actions.pod:1099
22921 msgid ""
22922 "The single parameter is an argv-style list of arguments.  The first element "
22923 "is the name of the program to run.  Subsequent elements are parameters.  The "
22924 "list must be non-empty (ie. must contain a program name).  Note that the "
22925 "command runs directly, and is I<not> invoked via the shell (see "
22926 "C<guestfs_sh>)."
22927 msgstr ""
22928
22929 #. type: textblock
22930 #: ../src/guestfs-actions.pod:1130 ../src/guestfs-actions.pod:1150 ../src/guestfs-actions.pod:1722
22931 msgid "(Added in 0.9.1)"
22932 msgstr ""
22933
22934 #. type: =head2
22935 #: ../src/guestfs-actions.pod:1132
22936 msgid "guestfs_command_lines"
22937 msgstr ""
22938
22939 #. type: verbatim
22940 #: ../src/guestfs-actions.pod:1134
22941 #, no-wrap
22942 msgid ""
22943 " char **\n"
22944 " guestfs_command_lines (guestfs_h *g,\n"
22945 "                        char *const *arguments);\n"
22946 "\n"
22947 msgstr ""
22948
22949 #. type: textblock
22950 #: ../src/guestfs-actions.pod:1138
22951 msgid ""
22952 "This is the same as C<guestfs_command>, but splits the result into a list of "
22953 "lines."
22954 msgstr ""
22955
22956 #. type: textblock
22957 #: ../src/guestfs-actions.pod:1141
22958 msgid "See also: C<guestfs_sh_lines>"
22959 msgstr ""
22960
22961 #. type: =head2
22962 #: ../src/guestfs-actions.pod:1152
22963 msgid "guestfs_compress_device_out"
22964 msgstr ""
22965
22966 #. type: verbatim
22967 #: ../src/guestfs-actions.pod:1154
22968 #, no-wrap
22969 msgid ""
22970 " int\n"
22971 " guestfs_compress_device_out (guestfs_h *g,\n"
22972 "                              const char *ctype,\n"
22973 "                              const char *device,\n"
22974 "                              const char *zdevice,\n"
22975 "                              ...);\n"
22976 "\n"
22977 msgstr ""
22978
22979 #. type: verbatim
22980 #: ../src/guestfs-actions.pod:1166
22981 #, no-wrap
22982 msgid ""
22983 " GUESTFS_COMPRESS_DEVICE_OUT_LEVEL, int level,\n"
22984 "\n"
22985 msgstr ""
22986
22987 #. type: textblock
22988 #: ../src/guestfs-actions.pod:1171
22989 msgid ""
22990 "The C<ctype> and optional C<level> parameters have the same meaning as in "
22991 "C<guestfs_compress_out>."
22992 msgstr ""
22993
22994 #. type: =head2
22995 #: ../src/guestfs-actions.pod:1176
22996 msgid "guestfs_compress_device_out_va"
22997 msgstr ""
22998
22999 #. type: verbatim
23000 #: ../src/guestfs-actions.pod:1178
23001 #, no-wrap
23002 msgid ""
23003 " int\n"
23004 " guestfs_compress_device_out_va (guestfs_h *g,\n"
23005 "                                 const char *ctype,\n"
23006 "                                 const char *device,\n"
23007 "                                 const char *zdevice,\n"
23008 "                                 va_list args);\n"
23009 "\n"
23010 msgstr ""
23011
23012 #. type: textblock
23013 #: ../src/guestfs-actions.pod:1185
23014 msgid "This is the \"va_list variant\" of L</guestfs_compress_device_out>."
23015 msgstr ""
23016
23017 #. type: =head2
23018 #: ../src/guestfs-actions.pod:1189
23019 msgid "guestfs_compress_device_out_argv"
23020 msgstr ""
23021
23022 #. type: verbatim
23023 #: ../src/guestfs-actions.pod:1191
23024 #, no-wrap
23025 msgid ""
23026 " int\n"
23027 " guestfs_compress_device_out_argv (guestfs_h *g,\n"
23028 "                                   const char *ctype,\n"
23029 "                                   const char *device,\n"
23030 "                                   const char *zdevice,\n"
23031 "                                   const struct "
23032 "guestfs_compress_device_out_argv *optargs);\n"
23033 "\n"
23034 msgstr ""
23035
23036 #. type: textblock
23037 #: ../src/guestfs-actions.pod:1198
23038 msgid "This is the \"argv variant\" of L</guestfs_compress_device_out>."
23039 msgstr ""
23040
23041 #. type: =head2
23042 #: ../src/guestfs-actions.pod:1202
23043 msgid "guestfs_compress_out"
23044 msgstr ""
23045
23046 #. type: verbatim
23047 #: ../src/guestfs-actions.pod:1204
23048 #, no-wrap
23049 msgid ""
23050 " int\n"
23051 " guestfs_compress_out (guestfs_h *g,\n"
23052 "                       const char *ctype,\n"
23053 "                       const char *file,\n"
23054 "                       const char *zfile,\n"
23055 "                       ...);\n"
23056 "\n"
23057 msgstr ""
23058
23059 #. type: verbatim
23060 #: ../src/guestfs-actions.pod:1216
23061 #, no-wrap
23062 msgid ""
23063 " GUESTFS_COMPRESS_OUT_LEVEL, int level,\n"
23064 "\n"
23065 msgstr ""
23066
23067 #. type: =head2
23068 #: ../src/guestfs-actions.pod:1233
23069 msgid "guestfs_compress_out_va"
23070 msgstr ""
23071
23072 #. type: verbatim
23073 #: ../src/guestfs-actions.pod:1235
23074 #, no-wrap
23075 msgid ""
23076 " int\n"
23077 " guestfs_compress_out_va (guestfs_h *g,\n"
23078 "                          const char *ctype,\n"
23079 "                          const char *file,\n"
23080 "                          const char *zfile,\n"
23081 "                          va_list args);\n"
23082 "\n"
23083 msgstr ""
23084
23085 #. type: textblock
23086 #: ../src/guestfs-actions.pod:1242
23087 msgid "This is the \"va_list variant\" of L</guestfs_compress_out>."
23088 msgstr ""
23089
23090 #. type: =head2
23091 #: ../src/guestfs-actions.pod:1246
23092 msgid "guestfs_compress_out_argv"
23093 msgstr ""
23094
23095 #. type: verbatim
23096 #: ../src/guestfs-actions.pod:1248
23097 #, no-wrap
23098 msgid ""
23099 " int\n"
23100 " guestfs_compress_out_argv (guestfs_h *g,\n"
23101 "                            const char *ctype,\n"
23102 "                            const char *file,\n"
23103 "                            const char *zfile,\n"
23104 "                            const struct guestfs_compress_out_argv "
23105 "*optargs);\n"
23106 "\n"
23107 msgstr ""
23108
23109 #. type: textblock
23110 #: ../src/guestfs-actions.pod:1255
23111 msgid "This is the \"argv variant\" of L</guestfs_compress_out>."
23112 msgstr ""
23113
23114 #. type: =head2
23115 #: ../src/guestfs-actions.pod:1259
23116 msgid "guestfs_config"
23117 msgstr ""
23118
23119 #. type: verbatim
23120 #: ../src/guestfs-actions.pod:1261
23121 #, no-wrap
23122 msgid ""
23123 " int\n"
23124 " guestfs_config (guestfs_h *g,\n"
23125 "                 const char *qemuparam,\n"
23126 "                 const char *qemuvalue);\n"
23127 "\n"
23128 msgstr ""
23129
23130 #. type: =head2
23131 #: ../src/guestfs-actions.pod:1279
23132 msgid "guestfs_copy_size"
23133 msgstr ""
23134
23135 #. type: verbatim
23136 #: ../src/guestfs-actions.pod:1281
23137 #, no-wrap
23138 msgid ""
23139 " int\n"
23140 " guestfs_copy_size (guestfs_h *g,\n"
23141 "                    const char *src,\n"
23142 "                    const char *dest,\n"
23143 "                    int64_t size);\n"
23144 "\n"
23145 msgstr ""
23146
23147 #. type: textblock
23148 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1418 ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1494 ../src/guestfs-actions.pod:1871 ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:3785 ../src/guestfs-actions.pod:7399 ../src/guestfs-actions.pod:7433 ../src/guestfs-actions.pod:7940 ../src/guestfs-actions.pod:7963
23149 msgid ""
23150 "This long-running command can generate progress notification messages so "
23151 "that the caller can display a progress bar or indicator.  To receive these "
23152 "messages, the caller must register a progress event callback.  See "
23153 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
23154 msgstr ""
23155
23156 #. type: textblock
23157 #: ../src/guestfs-actions.pod:1300 ../src/guestfs-actions.pod:4509 ../src/guestfs-actions.pod:5894 ../src/guestfs-actions.pod:7634 ../src/guestfs-actions.pod:7654 ../src/guestfs-actions.pod:7740
23158 msgid "(Added in 1.0.87)"
23159 msgstr ""
23160
23161 #. type: =head2
23162 #: ../src/guestfs-actions.pod:1302
23163 msgid "guestfs_cp"
23164 msgstr ""
23165
23166 #. type: verbatim
23167 #: ../src/guestfs-actions.pod:1304
23168 #, no-wrap
23169 msgid ""
23170 " int\n"
23171 " guestfs_cp (guestfs_h *g,\n"
23172 "             const char *src,\n"
23173 "             const char *dest);\n"
23174 "\n"
23175 msgstr ""
23176
23177 #. type: textblock
23178 #: ../src/guestfs-actions.pod:1314 ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:1400 ../src/guestfs-actions.pod:1474 ../src/guestfs-actions.pod:1588 ../src/guestfs-actions.pod:5263 ../src/guestfs-actions.pod:5738
23179 msgid "(Added in 1.0.18)"
23180 msgstr ""
23181
23182 #. type: =head2
23183 #: ../src/guestfs-actions.pod:1316
23184 msgid "guestfs_cp_a"
23185 msgstr ""
23186
23187 #. type: verbatim
23188 #: ../src/guestfs-actions.pod:1318
23189 #, no-wrap
23190 msgid ""
23191 " int\n"
23192 " guestfs_cp_a (guestfs_h *g,\n"
23193 "               const char *src,\n"
23194 "               const char *dest);\n"
23195 "\n"
23196 msgstr ""
23197
23198 #. type: =head2
23199 #: ../src/guestfs-actions.pod:1330
23200 msgid "guestfs_dd"
23201 msgstr ""
23202
23203 #. type: verbatim
23204 #: ../src/guestfs-actions.pod:1332
23205 #, no-wrap
23206 msgid ""
23207 " int\n"
23208 " guestfs_dd (guestfs_h *g,\n"
23209 "             const char *src,\n"
23210 "             const char *dest);\n"
23211 "\n"
23212 msgstr ""
23213
23214 #. type: textblock
23215 #: ../src/guestfs-actions.pod:1342
23216 msgid ""
23217 "If the destination is a device, it must be as large or larger than the "
23218 "source file or device, otherwise the copy will fail.  This command cannot do "
23219 "partial copies (see C<guestfs_copy_size>)."
23220 msgstr ""
23221
23222 #. type: =head2
23223 #: ../src/guestfs-actions.pod:1350
23224 msgid "guestfs_df"
23225 msgstr ""
23226
23227 #. type: verbatim
23228 #: ../src/guestfs-actions.pod:1352
23229 #, no-wrap
23230 msgid ""
23231 " char *\n"
23232 " guestfs_df (guestfs_h *g);\n"
23233 "\n"
23234 msgstr ""
23235
23236 #. type: textblock
23237 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:1374
23238 msgid ""
23239 "This command is mostly useful for interactive sessions.  It is I<not> "
23240 "intended that you try to parse the output string.  Use C<guestfs_statvfs> "
23241 "from programs."
23242 msgstr ""
23243
23244 #. type: textblock
23245 #: ../src/guestfs-actions.pod:1364 ../src/guestfs-actions.pod:1381 ../src/guestfs-actions.pod:1499 ../src/guestfs-actions.pod:2504 ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2596 ../src/guestfs-actions.pod:4619 ../src/guestfs-actions.pod:5163 ../src/guestfs-actions.pod:7137 ../src/guestfs-actions.pod:7161 ../src/guestfs-actions.pod:7780 ../src/guestfs-actions.pod:7793 ../src/guestfs-actions.pod:7806
23246 msgid "(Added in 1.0.54)"
23247 msgstr ""
23248
23249 #. type: =head2
23250 #: ../src/guestfs-actions.pod:1366
23251 msgid "guestfs_df_h"
23252 msgstr ""
23253
23254 #. type: verbatim
23255 #: ../src/guestfs-actions.pod:1368
23256 #, no-wrap
23257 msgid ""
23258 " char *\n"
23259 " guestfs_df_h (guestfs_h *g);\n"
23260 "\n"
23261 msgstr ""
23262
23263 #. type: =head2
23264 #: ../src/guestfs-actions.pod:1383
23265 msgid "guestfs_dmesg"
23266 msgstr ""
23267
23268 #. type: verbatim
23269 #: ../src/guestfs-actions.pod:1385
23270 #, no-wrap
23271 msgid ""
23272 " char *\n"
23273 " guestfs_dmesg (guestfs_h *g);\n"
23274 "\n"
23275 msgstr ""
23276
23277 #. type: textblock
23278 #: ../src/guestfs-actions.pod:1392
23279 msgid ""
23280 "Another way to get the same information is to enable verbose messages with "
23281 "C<guestfs_set_verbose> or by setting the environment variable "
23282 "C<LIBGUESTFS_DEBUG=1> before running the program."
23283 msgstr ""
23284
23285 #. type: =head2
23286 #: ../src/guestfs-actions.pod:1402
23287 msgid "guestfs_download"
23288 msgstr ""
23289
23290 #. type: verbatim
23291 #: ../src/guestfs-actions.pod:1404
23292 #, no-wrap
23293 msgid ""
23294 " int\n"
23295 " guestfs_download (guestfs_h *g,\n"
23296 "                   const char *remotefilename,\n"
23297 "                   const char *filename);\n"
23298 "\n"
23299 msgstr ""
23300
23301 #. type: textblock
23302 #: ../src/guestfs-actions.pod:1414
23303 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
23304 msgstr ""
23305
23306 #. type: =head2
23307 #: ../src/guestfs-actions.pod:1425
23308 msgid "guestfs_download_offset"
23309 msgstr ""
23310
23311 #. type: verbatim
23312 #: ../src/guestfs-actions.pod:1427
23313 #, no-wrap
23314 msgid ""
23315 " int\n"
23316 " guestfs_download_offset (guestfs_h *g,\n"
23317 "                          const char *remotefilename,\n"
23318 "                          const char *filename,\n"
23319 "                          int64_t offset,\n"
23320 "                          int64_t size);\n"
23321 "\n"
23322 msgstr ""
23323
23324 #. type: textblock
23325 #: ../src/guestfs-actions.pod:1440
23326 msgid ""
23327 "Note that there is no limit on the amount of data that can be downloaded "
23328 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
23329 "full amount unless an error occurs."
23330 msgstr ""
23331
23332 #. type: textblock
23333 #: ../src/guestfs-actions.pod:1445
23334 msgid "See also C<guestfs_download>, C<guestfs_pread>."
23335 msgstr ""
23336
23337 #. type: textblock
23338 #: ../src/guestfs-actions.pod:1454 ../src/guestfs-actions.pod:7438
23339 msgid "(Added in 1.5.17)"
23340 msgstr ""
23341
23342 #. type: =head2
23343 #: ../src/guestfs-actions.pod:1456
23344 msgid "guestfs_drop_caches"
23345 msgstr ""
23346
23347 #. type: verbatim
23348 #: ../src/guestfs-actions.pod:1458
23349 #, no-wrap
23350 msgid ""
23351 " int\n"
23352 " guestfs_drop_caches (guestfs_h *g,\n"
23353 "                      int whattodrop);\n"
23354 "\n"
23355 msgstr ""
23356
23357 #. type: =head2
23358 #: ../src/guestfs-actions.pod:1476
23359 msgid "guestfs_du"
23360 msgstr ""
23361
23362 #. type: verbatim
23363 #: ../src/guestfs-actions.pod:1478
23364 #, no-wrap
23365 msgid ""
23366 " int64_t\n"
23367 " guestfs_du (guestfs_h *g,\n"
23368 "             const char *path);\n"
23369 "\n"
23370 msgstr ""
23371
23372 #. type: =head2
23373 #: ../src/guestfs-actions.pod:1501
23374 msgid "guestfs_e2fsck_f"
23375 msgstr ""
23376
23377 #. type: verbatim
23378 #: ../src/guestfs-actions.pod:1503
23379 #, no-wrap
23380 msgid ""
23381 " int\n"
23382 " guestfs_e2fsck_f (guestfs_h *g,\n"
23383 "                   const char *device);\n"
23384 "\n"
23385 msgstr ""
23386
23387 #. type: textblock
23388 #: ../src/guestfs-actions.pod:1511
23389 msgid ""
23390 "This command is only needed because of C<guestfs_resize2fs> (q.v.).  "
23391 "Normally you should use C<guestfs_fsck>."
23392 msgstr ""
23393
23394 #. type: textblock
23395 #: ../src/guestfs-actions.pod:1516
23396 msgid "(Added in 1.0.29)"
23397 msgstr ""
23398
23399 #. type: =head2
23400 #: ../src/guestfs-actions.pod:1518
23401 msgid "guestfs_echo_daemon"
23402 msgstr ""
23403
23404 #. type: verbatim
23405 #: ../src/guestfs-actions.pod:1520
23406 #, no-wrap
23407 msgid ""
23408 " char *\n"
23409 " guestfs_echo_daemon (guestfs_h *g,\n"
23410 "                      char *const *words);\n"
23411 "\n"
23412 msgstr ""
23413
23414 #. type: textblock
23415 #: ../src/guestfs-actions.pod:1529
23416 msgid "See also C<guestfs_ping_daemon>."
23417 msgstr ""
23418
23419 #. type: textblock
23420 #: ../src/guestfs-actions.pod:1534 ../src/guestfs-actions.pod:2290 ../src/guestfs-actions.pod:6609
23421 msgid "(Added in 1.0.69)"
23422 msgstr ""
23423
23424 #. type: =head2
23425 #: ../src/guestfs-actions.pod:1536
23426 msgid "guestfs_egrep"
23427 msgstr ""
23428
23429 #. type: verbatim
23430 #: ../src/guestfs-actions.pod:1538
23431 #, no-wrap
23432 msgid ""
23433 " char **\n"
23434 " guestfs_egrep (guestfs_h *g,\n"
23435 "                const char *regex,\n"
23436 "                const char *path);\n"
23437 "\n"
23438 msgstr ""
23439
23440 #. type: textblock
23441 #: ../src/guestfs-actions.pod:1553 ../src/guestfs-actions.pod:1572 ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1675 ../src/guestfs-actions.pod:1694 ../src/guestfs-actions.pod:2420 ../src/guestfs-actions.pod:2439 ../src/guestfs-actions.pod:2617 ../src/guestfs-actions.pod:2630 ../src/guestfs-actions.pod:2645 ../src/guestfs-actions.pod:2691 ../src/guestfs-actions.pod:2713 ../src/guestfs-actions.pod:2726 ../src/guestfs-actions.pod:3999 ../src/guestfs-actions.pod:4013 ../src/guestfs-actions.pod:4026 ../src/guestfs-actions.pod:4040 ../src/guestfs-actions.pod:5041 ../src/guestfs-actions.pod:6072 ../src/guestfs-actions.pod:6121 ../src/guestfs-actions.pod:7005 ../src/guestfs-actions.pod:7017 ../src/guestfs-actions.pod:7030 ../src/guestfs-actions.pod:7043 ../src/guestfs-actions.pod:7065 ../src/guestfs-actions.pod:7078 ../src/guestfs-actions.pod:7091 ../src/guestfs-actions.pod:7104 ../src/guestfs-actions.pod:7898 ../src/guestfs-actions.pod:7917 ../src/guestfs-actions.pod:8011 ../src/guestfs-actions.pod:8030 ../src/guestfs-actions.pod:8076 ../src/guestfs-actions.pod:8095
23442 msgid "(Added in 1.0.66)"
23443 msgstr ""
23444
23445 #. type: =head2
23446 #: ../src/guestfs-actions.pod:1555
23447 msgid "guestfs_egrepi"
23448 msgstr ""
23449
23450 #. type: verbatim
23451 #: ../src/guestfs-actions.pod:1557
23452 #, no-wrap
23453 msgid ""
23454 " char **\n"
23455 " guestfs_egrepi (guestfs_h *g,\n"
23456 "                 const char *regex,\n"
23457 "                 const char *path);\n"
23458 "\n"
23459 msgstr ""
23460
23461 #. type: =head2
23462 #: ../src/guestfs-actions.pod:1574
23463 msgid "guestfs_equal"
23464 msgstr ""
23465
23466 #. type: verbatim
23467 #: ../src/guestfs-actions.pod:1576
23468 #, no-wrap
23469 msgid ""
23470 " int\n"
23471 " guestfs_equal (guestfs_h *g,\n"
23472 "                const char *file1,\n"
23473 "                const char *file2);\n"
23474 "\n"
23475 msgstr ""
23476
23477 #. type: =head2
23478 #: ../src/guestfs-actions.pod:1590
23479 msgid "guestfs_exists"
23480 msgstr ""
23481
23482 #. type: verbatim
23483 #: ../src/guestfs-actions.pod:1592
23484 #, no-wrap
23485 msgid ""
23486 " int\n"
23487 " guestfs_exists (guestfs_h *g,\n"
23488 "                 const char *path);\n"
23489 "\n"
23490 msgstr ""
23491
23492 #. type: textblock
23493 #: ../src/guestfs-actions.pod:1599
23494 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
23495 msgstr ""
23496
23497 #. type: =head2
23498 #: ../src/guestfs-actions.pod:1605
23499 msgid "guestfs_fallocate"
23500 msgstr ""
23501
23502 #. type: verbatim
23503 #: ../src/guestfs-actions.pod:1607
23504 #, no-wrap
23505 msgid ""
23506 " int\n"
23507 " guestfs_fallocate (guestfs_h *g,\n"
23508 "                    const char *path,\n"
23509 "                    int len);\n"
23510 "\n"
23511 msgstr ""
23512
23513 #. type: textblock
23514 #: ../src/guestfs-actions.pod:1612
23515 msgid ""
23516 "I<This function is deprecated.> In new code, use the L</guestfs_fallocate64> "
23517 "call instead."
23518 msgstr ""
23519
23520 #. type: =head2
23521 #: ../src/guestfs-actions.pod:1631
23522 msgid "guestfs_fallocate64"
23523 msgstr ""
23524
23525 #. type: verbatim
23526 #: ../src/guestfs-actions.pod:1633
23527 #, no-wrap
23528 msgid ""
23529 " int\n"
23530 " guestfs_fallocate64 (guestfs_h *g,\n"
23531 "                      const char *path,\n"
23532 "                      int64_t len);\n"
23533 "\n"
23534 msgstr ""
23535
23536 #. type: textblock
23537 #: ../src/guestfs-actions.pod:1642
23538 msgid ""
23539 "Note that this call allocates disk blocks for the file.  To create a sparse "
23540 "file use C<guestfs_truncate_size> instead."
23541 msgstr ""
23542
23543 #. type: textblock
23544 #: ../src/guestfs-actions.pod:1645
23545 msgid ""
23546 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
23547 "oversight it only allowed 30 bit lengths to be specified, effectively "
23548 "limiting the maximum size of files created through that call to 1GB."
23549 msgstr ""
23550
23551 #. type: textblock
23552 #: ../src/guestfs-actions.pod:1656
23553 msgid "(Added in 1.3.17)"
23554 msgstr ""
23555
23556 #. type: =head2
23557 #: ../src/guestfs-actions.pod:1658
23558 msgid "guestfs_fgrep"
23559 msgstr ""
23560
23561 #. type: verbatim
23562 #: ../src/guestfs-actions.pod:1660
23563 #, no-wrap
23564 msgid ""
23565 " char **\n"
23566 " guestfs_fgrep (guestfs_h *g,\n"
23567 "                const char *pattern,\n"
23568 "                const char *path);\n"
23569 "\n"
23570 msgstr ""
23571
23572 #. type: =head2
23573 #: ../src/guestfs-actions.pod:1677
23574 msgid "guestfs_fgrepi"
23575 msgstr ""
23576
23577 #. type: verbatim
23578 #: ../src/guestfs-actions.pod:1679
23579 #, no-wrap
23580 msgid ""
23581 " char **\n"
23582 " guestfs_fgrepi (guestfs_h *g,\n"
23583 "                 const char *pattern,\n"
23584 "                 const char *path);\n"
23585 "\n"
23586 msgstr ""
23587
23588 #. type: =head2
23589 #: ../src/guestfs-actions.pod:1696
23590 msgid "guestfs_file"
23591 msgstr ""
23592
23593 #. type: verbatim
23594 #: ../src/guestfs-actions.pod:1698
23595 #, no-wrap
23596 msgid ""
23597 " char *\n"
23598 " guestfs_file (guestfs_h *g,\n"
23599 "               const char *path);\n"
23600 "\n"
23601 msgstr ""
23602
23603 #. type: textblock
23604 #: ../src/guestfs-actions.pod:1716
23605 msgid ""
23606 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
23607 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
23608 msgstr ""
23609
23610 #. type: =head2
23611 #: ../src/guestfs-actions.pod:1724
23612 msgid "guestfs_file_architecture"
23613 msgstr ""
23614
23615 #. type: verbatim
23616 #: ../src/guestfs-actions.pod:1726
23617 #, no-wrap
23618 msgid ""
23619 " char *\n"
23620 " guestfs_file_architecture (guestfs_h *g,\n"
23621 "                            const char *filename);\n"
23622 "\n"
23623 msgstr ""
23624
23625 #. type: textblock
23626 #: ../src/guestfs-actions.pod:1834 ../src/guestfs-actions.pod:1997 ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2746 ../src/guestfs-actions.pod:2840 ../src/guestfs-actions.pod:2906 ../src/guestfs-actions.pod:3093 ../src/guestfs-actions.pod:3111 ../src/guestfs-actions.pod:3151 ../src/guestfs-actions.pod:3226 ../src/guestfs-actions.pod:3319 ../src/guestfs-actions.pod:3556 ../src/guestfs-actions.pod:3688
23627 msgid "(Added in 1.5.3)"
23628 msgstr ""
23629
23630 #. type: =head2
23631 #: ../src/guestfs-actions.pod:1836
23632 msgid "guestfs_filesize"
23633 msgstr ""
23634
23635 #. type: verbatim
23636 #: ../src/guestfs-actions.pod:1838
23637 #, no-wrap
23638 msgid ""
23639 " int64_t\n"
23640 " guestfs_filesize (guestfs_h *g,\n"
23641 "                   const char *file);\n"
23642 "\n"
23643 msgstr ""
23644
23645 #. type: textblock
23646 #: ../src/guestfs-actions.pod:1844
23647 msgid ""
23648 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
23649 "C<guestfs_is_dir>, C<guestfs_is_file> etc.  To get the size of block "
23650 "devices, use C<guestfs_blockdev_getsize64>."
23651 msgstr ""
23652
23653 #. type: textblock
23654 #: ../src/guestfs-actions.pod:1850
23655 msgid "(Added in 1.0.82)"
23656 msgstr ""
23657
23658 #. type: =head2
23659 #: ../src/guestfs-actions.pod:1852
23660 msgid "guestfs_fill"
23661 msgstr ""
23662
23663 #. type: verbatim
23664 #: ../src/guestfs-actions.pod:1854
23665 #, no-wrap
23666 msgid ""
23667 " int\n"
23668 " guestfs_fill (guestfs_h *g,\n"
23669 "               int c,\n"
23670 "               int len,\n"
23671 "               const char *path);\n"
23672 "\n"
23673 msgstr ""
23674
23675 #. type: textblock
23676 #: ../src/guestfs-actions.pod:1864
23677 msgid ""
23678 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23679 "C<guestfs_truncate_size>.  To create a file with a pattern of repeating "
23680 "bytes use C<guestfs_fill_pattern>."
23681 msgstr ""
23682
23683 #. type: textblock
23684 #: ../src/guestfs-actions.pod:1876
23685 msgid "(Added in 1.0.79)"
23686 msgstr ""
23687
23688 #. type: =head2
23689 #: ../src/guestfs-actions.pod:1878
23690 msgid "guestfs_fill_pattern"
23691 msgstr ""
23692
23693 #. type: verbatim
23694 #: ../src/guestfs-actions.pod:1880
23695 #, no-wrap
23696 msgid ""
23697 " int\n"
23698 " guestfs_fill_pattern (guestfs_h *g,\n"
23699 "                       const char *pattern,\n"
23700 "                       int len,\n"
23701 "                       const char *path);\n"
23702 "\n"
23703 msgstr ""
23704
23705 #. type: textblock
23706 #: ../src/guestfs-actions.pod:1886
23707 msgid ""
23708 "This function is like C<guestfs_fill> except that it creates a new file of "
23709 "length C<len> containing the repeating pattern of bytes in C<pattern>.  The "
23710 "pattern is truncated if necessary to ensure the length of the file is "
23711 "exactly C<len> bytes."
23712 msgstr ""
23713
23714 #. type: textblock
23715 #: ../src/guestfs-actions.pod:1898
23716 msgid "(Added in 1.3.12)"
23717 msgstr ""
23718
23719 #. type: =head2
23720 #: ../src/guestfs-actions.pod:1900
23721 msgid "guestfs_find"
23722 msgstr ""
23723
23724 #. type: verbatim
23725 #: ../src/guestfs-actions.pod:1902
23726 #, no-wrap
23727 msgid ""
23728 " char **\n"
23729 " guestfs_find (guestfs_h *g,\n"
23730 "               const char *directory);\n"
23731 "\n"
23732 msgstr ""
23733
23734 #. type: textblock
23735 #: ../src/guestfs-actions.pod:1918
23736 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
23737 msgstr ""
23738
23739 #. type: textblock
23740 #: ../src/guestfs-actions.pod:1931
23741 msgid "See also C<guestfs_find0>."
23742 msgstr ""
23743
23744 #. type: textblock
23745 #: ../src/guestfs-actions.pod:1940 ../src/guestfs-actions.pod:4446 ../src/guestfs-actions.pod:6156
23746 msgid "(Added in 1.0.27)"
23747 msgstr ""
23748
23749 #. type: =head2
23750 #: ../src/guestfs-actions.pod:1942
23751 msgid "guestfs_find0"
23752 msgstr ""
23753
23754 #. type: verbatim
23755 #: ../src/guestfs-actions.pod:1944
23756 #, no-wrap
23757 msgid ""
23758 " int\n"
23759 " guestfs_find0 (guestfs_h *g,\n"
23760 "                const char *directory,\n"
23761 "                const char *files);\n"
23762 "\n"
23763 msgstr ""
23764
23765 #. type: textblock
23766 #: ../src/guestfs-actions.pod:1953
23767 msgid ""
23768 "This command works the same way as C<guestfs_find> with the following "
23769 "exceptions:"
23770 msgstr ""
23771
23772 #. type: textblock
23773 #: ../src/guestfs-actions.pod:1980
23774 msgid "(Added in 1.0.74)"
23775 msgstr ""
23776
23777 #. type: =head2
23778 #: ../src/guestfs-actions.pod:1982
23779 msgid "guestfs_findfs_label"
23780 msgstr ""
23781
23782 #. type: verbatim
23783 #: ../src/guestfs-actions.pod:1984
23784 #, no-wrap
23785 msgid ""
23786 " char *\n"
23787 " guestfs_findfs_label (guestfs_h *g,\n"
23788 "                       const char *label);\n"
23789 "\n"
23790 msgstr ""
23791
23792 #. type: textblock
23793 #: ../src/guestfs-actions.pod:1992
23794 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
23795 msgstr ""
23796
23797 #. type: =head2
23798 #: ../src/guestfs-actions.pod:1999
23799 msgid "guestfs_findfs_uuid"
23800 msgstr ""
23801
23802 #. type: verbatim
23803 #: ../src/guestfs-actions.pod:2001
23804 #, no-wrap
23805 msgid ""
23806 " char *\n"
23807 " guestfs_findfs_uuid (guestfs_h *g,\n"
23808 "                      const char *uuid);\n"
23809 "\n"
23810 msgstr ""
23811
23812 #. type: textblock
23813 #: ../src/guestfs-actions.pod:2009
23814 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
23815 msgstr ""
23816
23817 #. type: =head2
23818 #: ../src/guestfs-actions.pod:2016
23819 msgid "guestfs_fsck"
23820 msgstr ""
23821
23822 #. type: verbatim
23823 #: ../src/guestfs-actions.pod:2018
23824 #, no-wrap
23825 msgid ""
23826 " int\n"
23827 " guestfs_fsck (guestfs_h *g,\n"
23828 "               const char *fstype,\n"
23829 "               const char *device);\n"
23830 "\n"
23831 msgstr ""
23832
23833 #. type: textblock
23834 #: ../src/guestfs-actions.pod:2053 ../src/guestfs-actions.pod:7945
23835 msgid "(Added in 1.0.16)"
23836 msgstr ""
23837
23838 #. type: =head2
23839 #: ../src/guestfs-actions.pod:2055
23840 msgid "guestfs_get_append"
23841 msgstr ""
23842
23843 #. type: verbatim
23844 #: ../src/guestfs-actions.pod:2057
23845 #, no-wrap
23846 msgid ""
23847 " const char *\n"
23848 " guestfs_get_append (guestfs_h *g);\n"
23849 "\n"
23850 msgstr ""
23851
23852 #. type: textblock
23853 #: ../src/guestfs-actions.pod:2065
23854 msgid ""
23855 "This function returns a string which may be NULL.  There is no way to return "
23856 "an error from this function.  The string is owned by the guest handle and "
23857 "must I<not> be freed."
23858 msgstr ""
23859
23860 #. type: textblock
23861 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:5834 ../src/guestfs-actions.pod:6316 ../src/guestfs-actions.pod:6772 ../src/guestfs-actions.pod:6791 ../src/guestfs-actions.pod:6807 ../src/guestfs-actions.pod:6831 ../src/guestfs-actions.pod:7585 ../src/guestfs-actions.pod:7600 ../src/guestfs-actions.pod:7992
23862 msgid "(Added in 1.0.26)"
23863 msgstr ""
23864
23865 #. type: =head2
23866 #: ../src/guestfs-actions.pod:2071
23867 msgid "guestfs_get_attach_method"
23868 msgstr ""
23869
23870 #. type: verbatim
23871 #: ../src/guestfs-actions.pod:2073
23872 #, no-wrap
23873 msgid ""
23874 " char *\n"
23875 " guestfs_get_attach_method (guestfs_h *g);\n"
23876 "\n"
23877 msgstr ""
23878
23879 #. type: textblock
23880 #: ../src/guestfs-actions.pod:2076
23881 msgid "Return the current attach method.  See C<guestfs_set_attach_method>."
23882 msgstr ""
23883
23884 #. type: textblock
23885 #: ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:6346
23886 msgid "(Added in 1.9.8)"
23887 msgstr ""
23888
23889 #. type: =head2
23890 #: ../src/guestfs-actions.pod:2083
23891 msgid "guestfs_get_autosync"
23892 msgstr ""
23893
23894 #. type: verbatim
23895 #: ../src/guestfs-actions.pod:2085
23896 #, no-wrap
23897 msgid ""
23898 " int\n"
23899 " guestfs_get_autosync (guestfs_h *g);\n"
23900 "\n"
23901 msgstr ""
23902
23903 #. type: =head2
23904 #: ../src/guestfs-actions.pod:2094
23905 msgid "guestfs_get_direct"
23906 msgstr ""
23907
23908 #. type: verbatim
23909 #: ../src/guestfs-actions.pod:2096
23910 #, no-wrap
23911 msgid ""
23912 " int\n"
23913 " guestfs_get_direct (guestfs_h *g);\n"
23914 "\n"
23915 msgstr ""
23916
23917 #. type: textblock
23918 #: ../src/guestfs-actions.pod:2103 ../src/guestfs-actions.pod:6387
23919 msgid "(Added in 1.0.72)"
23920 msgstr ""
23921
23922 #. type: =head2
23923 #: ../src/guestfs-actions.pod:2105
23924 msgid "guestfs_get_e2label"
23925 msgstr ""
23926
23927 #. type: verbatim
23928 #: ../src/guestfs-actions.pod:2107
23929 #, no-wrap
23930 msgid ""
23931 " char *\n"
23932 " guestfs_get_e2label (guestfs_h *g,\n"
23933 "                      const char *device);\n"
23934 "\n"
23935 msgstr ""
23936
23937 #. type: textblock
23938 #: ../src/guestfs-actions.pod:2111
23939 msgid ""
23940 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_label> "
23941 "call instead."
23942 msgstr ""
23943
23944 #. type: textblock
23945 #: ../src/guestfs-actions.pod:2124 ../src/guestfs-actions.pod:2145 ../src/guestfs-actions.pod:6405 ../src/guestfs-actions.pod:6424
23946 msgid "(Added in 1.0.15)"
23947 msgstr ""
23948
23949 #. type: =head2
23950 #: ../src/guestfs-actions.pod:2126
23951 msgid "guestfs_get_e2uuid"
23952 msgstr ""
23953
23954 #. type: verbatim
23955 #: ../src/guestfs-actions.pod:2128
23956 #, no-wrap
23957 msgid ""
23958 " char *\n"
23959 " guestfs_get_e2uuid (guestfs_h *g,\n"
23960 "                     const char *device);\n"
23961 "\n"
23962 msgstr ""
23963
23964 #. type: textblock
23965 #: ../src/guestfs-actions.pod:2132
23966 msgid ""
23967 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_uuid> "
23968 "call instead."
23969 msgstr ""
23970
23971 #. type: =head2
23972 #: ../src/guestfs-actions.pod:2147
23973 msgid "guestfs_get_memsize"
23974 msgstr ""
23975
23976 #. type: verbatim
23977 #: ../src/guestfs-actions.pod:2149
23978 #, no-wrap
23979 msgid ""
23980 " int\n"
23981 " guestfs_get_memsize (guestfs_h *g);\n"
23982 "\n"
23983 msgstr ""
23984
23985 #. type: textblock
23986 #: ../src/guestfs-actions.pod:2155
23987 msgid ""
23988 "If C<guestfs_set_memsize> was not called on this handle, and if "
23989 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23990 "value for memsize."
23991 msgstr ""
23992
23993 #. type: textblock
23994 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:4946 ../src/guestfs-actions.pod:4965 ../src/guestfs-actions.pod:4984 ../src/guestfs-actions.pod:4996 ../src/guestfs-actions.pod:5013 ../src/guestfs-actions.pod:5026 ../src/guestfs-actions.pod:6059 ../src/guestfs-actions.pod:6445 ../src/guestfs-actions.pod:6739 ../src/guestfs-actions.pod:7354
23995 msgid "(Added in 1.0.55)"
23996 msgstr ""
23997
23998 #. type: =head2
23999 #: ../src/guestfs-actions.pod:2166
24000 msgid "guestfs_get_network"
24001 msgstr ""
24002
24003 #. type: verbatim
24004 #: ../src/guestfs-actions.pod:2168
24005 #, no-wrap
24006 msgid ""
24007 " int\n"
24008 " guestfs_get_network (guestfs_h *g);\n"
24009 "\n"
24010 msgstr ""
24011
24012 #. type: textblock
24013 #: ../src/guestfs-actions.pod:2175 ../src/guestfs-actions.pod:6464
24014 msgid "(Added in 1.5.4)"
24015 msgstr ""
24016
24017 #. type: =head2
24018 #: ../src/guestfs-actions.pod:2177
24019 msgid "guestfs_get_path"
24020 msgstr ""
24021
24022 #. type: verbatim
24023 #: ../src/guestfs-actions.pod:2179
24024 #, no-wrap
24025 msgid ""
24026 " const char *\n"
24027 " guestfs_get_path (guestfs_h *g);\n"
24028 "\n"
24029 msgstr ""
24030
24031 #. type: textblock
24032 #: ../src/guestfs-actions.pod:2187 ../src/guestfs-actions.pod:2227
24033 msgid ""
24034 "This function returns a string, or NULL on error.  The string is owned by "
24035 "the guest handle and must I<not> be freed."
24036 msgstr ""
24037
24038 #. type: =head2
24039 #: ../src/guestfs-actions.pod:2192
24040 msgid "guestfs_get_pgroup"
24041 msgstr ""
24042
24043 #. type: verbatim
24044 #: ../src/guestfs-actions.pod:2194
24045 #, no-wrap
24046 msgid ""
24047 " int\n"
24048 " guestfs_get_pgroup (guestfs_h *g);\n"
24049 "\n"
24050 msgstr ""
24051
24052 #. type: textblock
24053 #: ../src/guestfs-actions.pod:2201 ../src/guestfs-actions.pod:6500 ../src/guestfs-actions.pod:7846
24054 msgid "(Added in 1.11.18)"
24055 msgstr ""
24056
24057 #. type: =head2
24058 #: ../src/guestfs-actions.pod:2203
24059 msgid "guestfs_get_pid"
24060 msgstr ""
24061
24062 #. type: verbatim
24063 #: ../src/guestfs-actions.pod:2205
24064 #, no-wrap
24065 msgid ""
24066 " int\n"
24067 " guestfs_get_pid (guestfs_h *g);\n"
24068 "\n"
24069 msgstr ""
24070
24071 #. type: textblock
24072 #: ../src/guestfs-actions.pod:2215
24073 msgid "(Added in 1.0.56)"
24074 msgstr ""
24075
24076 #. type: =head2
24077 #: ../src/guestfs-actions.pod:2217
24078 msgid "guestfs_get_qemu"
24079 msgstr ""
24080
24081 #. type: verbatim
24082 #: ../src/guestfs-actions.pod:2219
24083 #, no-wrap
24084 msgid ""
24085 " const char *\n"
24086 " guestfs_get_qemu (guestfs_h *g);\n"
24087 "\n"
24088 msgstr ""
24089
24090 #. type: textblock
24091 #: ../src/guestfs-actions.pod:2230 ../src/guestfs-actions.pod:6528
24092 msgid "(Added in 1.0.6)"
24093 msgstr ""
24094
24095 #. type: =head2
24096 #: ../src/guestfs-actions.pod:2232
24097 msgid "guestfs_get_recovery_proc"
24098 msgstr ""
24099
24100 #. type: verbatim
24101 #: ../src/guestfs-actions.pod:2234
24102 #, no-wrap
24103 msgid ""
24104 " int\n"
24105 " guestfs_get_recovery_proc (guestfs_h *g);\n"
24106 "\n"
24107 msgstr ""
24108
24109 #. type: textblock
24110 #: ../src/guestfs-actions.pod:2241 ../src/guestfs-actions.pod:3810 ../src/guestfs-actions.pod:4141 ../src/guestfs-actions.pod:4544 ../src/guestfs-actions.pod:4576 ../src/guestfs-actions.pod:5764 ../src/guestfs-actions.pod:6107 ../src/guestfs-actions.pod:6552 ../src/guestfs-actions.pod:7257 ../src/guestfs-actions.pod:7277 ../src/guestfs-actions.pod:7469
24111 msgid "(Added in 1.0.77)"
24112 msgstr ""
24113
24114 #. type: =head2
24115 #: ../src/guestfs-actions.pod:2243
24116 msgid "guestfs_get_selinux"
24117 msgstr ""
24118
24119 #. type: verbatim
24120 #: ../src/guestfs-actions.pod:2245
24121 #, no-wrap
24122 msgid ""
24123 " int\n"
24124 " guestfs_get_selinux (guestfs_h *g);\n"
24125 "\n"
24126 msgstr ""
24127
24128 #. type: textblock
24129 #: ../src/guestfs-actions.pod:2248
24130 msgid ""
24131 "This returns the current setting of the selinux flag which is passed to the "
24132 "appliance at boot time.  See C<guestfs_set_selinux>."
24133 msgstr ""
24134
24135 #. type: textblock
24136 #: ../src/guestfs-actions.pod:2256 ../src/guestfs-actions.pod:2328 ../src/guestfs-actions.pod:6571 ../src/guestfs-actions.pod:6643
24137 msgid "(Added in 1.0.67)"
24138 msgstr ""
24139
24140 #. type: =head2
24141 #: ../src/guestfs-actions.pod:2258
24142 msgid "guestfs_get_smp"
24143 msgstr ""
24144
24145 #. type: verbatim
24146 #: ../src/guestfs-actions.pod:2260
24147 #, no-wrap
24148 msgid ""
24149 " int\n"
24150 " guestfs_get_smp (guestfs_h *g);\n"
24151 "\n"
24152 msgstr ""
24153
24154 #. type: =head2
24155 #: ../src/guestfs-actions.pod:2267
24156 msgid "guestfs_get_state"
24157 msgstr ""
24158
24159 #. type: verbatim
24160 #: ../src/guestfs-actions.pod:2269
24161 #, no-wrap
24162 msgid ""
24163 " int\n"
24164 " guestfs_get_state (guestfs_h *g);\n"
24165 "\n"
24166 msgstr ""
24167
24168 #. type: =head2
24169 #: ../src/guestfs-actions.pod:2281
24170 msgid "guestfs_get_trace"
24171 msgstr ""
24172
24173 #. type: verbatim
24174 #: ../src/guestfs-actions.pod:2283
24175 #, no-wrap
24176 msgid ""
24177 " int\n"
24178 " guestfs_get_trace (guestfs_h *g);\n"
24179 "\n"
24180 msgstr ""
24181
24182 #. type: =head2
24183 #: ../src/guestfs-actions.pod:2292
24184 msgid "guestfs_get_umask"
24185 msgstr ""
24186
24187 #. type: verbatim
24188 #: ../src/guestfs-actions.pod:2294
24189 #, no-wrap
24190 msgid ""
24191 " int\n"
24192 " guestfs_get_umask (guestfs_h *g);\n"
24193 "\n"
24194 msgstr ""
24195
24196 #. type: textblock
24197 #: ../src/guestfs-actions.pod:2297
24198 msgid ""
24199 "Return the current umask.  By default the umask is C<022> unless it has been "
24200 "set by calling C<guestfs_umask>."
24201 msgstr ""
24202
24203 #. type: =head2
24204 #: ../src/guestfs-actions.pod:2304
24205 msgid "guestfs_get_verbose"
24206 msgstr ""
24207
24208 #. type: verbatim
24209 #: ../src/guestfs-actions.pod:2306
24210 #, no-wrap
24211 msgid ""
24212 " int\n"
24213 " guestfs_get_verbose (guestfs_h *g);\n"
24214 "\n"
24215 msgstr ""
24216
24217 #. type: =head2
24218 #: ../src/guestfs-actions.pod:2315
24219 msgid "guestfs_getcon"
24220 msgstr ""
24221
24222 #. type: verbatim
24223 #: ../src/guestfs-actions.pod:2317
24224 #, no-wrap
24225 msgid ""
24226 " char *\n"
24227 " guestfs_getcon (guestfs_h *g);\n"
24228 "\n"
24229 msgstr ""
24230
24231 #. type: textblock
24232 #: ../src/guestfs-actions.pod:2322
24233 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
24234 msgstr ""
24235
24236 #. type: =head2
24237 #: ../src/guestfs-actions.pod:2330
24238 msgid "guestfs_getxattr"
24239 msgstr ""
24240
24241 #. type: verbatim
24242 #: ../src/guestfs-actions.pod:2332
24243 #, no-wrap
24244 msgid ""
24245 " char *\n"
24246 " guestfs_getxattr (guestfs_h *g,\n"
24247 "                   const char *path,\n"
24248 "                   const char *name,\n"
24249 "                   size_t *size_r);\n"
24250 "\n"
24251 msgstr ""
24252
24253 #. type: textblock
24254 #: ../src/guestfs-actions.pod:2338
24255 msgid ""
24256 "Get a single extended attribute from file C<path> named C<name>.  This call "
24257 "follows symlinks.  If you want to lookup an extended attribute for the "
24258 "symlink itself, use C<guestfs_lgetxattr>."
24259 msgstr ""
24260
24261 #. type: textblock
24262 #: ../src/guestfs-actions.pod:2342 ../src/guestfs-actions.pod:3824
24263 msgid ""
24264 "Normally it is better to get all extended attributes from a file in one go "
24265 "by calling C<guestfs_getxattrs>.  However some Linux filesystem "
24266 "implementations are buggy and do not provide a way to list out attributes.  "
24267 "For these filesystems (notably ntfs-3g)  you have to know the names of the "
24268 "extended attributes you want in advance and call this function."
24269 msgstr ""
24270
24271 #. type: textblock
24272 #: ../src/guestfs-actions.pod:2352
24273 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
24274 msgstr ""
24275
24276 #. type: textblock
24277 #: ../src/guestfs-actions.pod:2354 ../src/guestfs-actions.pod:2567 ../src/guestfs-actions.pod:3041 ../src/guestfs-actions.pod:3836 ../src/guestfs-actions.pod:5757 ../src/guestfs-actions.pod:5783 ../src/guestfs-actions.pod:5964
24278 msgid ""
24279 "This function returns a buffer, or NULL on error.  The size of the returned "
24280 "buffer is written to C<*size_r>.  I<The caller must free the returned buffer "
24281 "after use>."
24282 msgstr ""
24283
24284 #. type: textblock
24285 #: ../src/guestfs-actions.pod:2358 ../src/guestfs-actions.pod:3840
24286 msgid "(Added in 1.7.24)"
24287 msgstr ""
24288
24289 #. type: =head2
24290 #: ../src/guestfs-actions.pod:2360
24291 msgid "guestfs_getxattrs"
24292 msgstr ""
24293
24294 #. type: verbatim
24295 #: ../src/guestfs-actions.pod:2362
24296 #, no-wrap
24297 msgid ""
24298 " struct guestfs_xattr_list *\n"
24299 " guestfs_getxattrs (guestfs_h *g,\n"
24300 "                    const char *path);\n"
24301 "\n"
24302 msgstr ""
24303
24304 #. type: textblock
24305 #: ../src/guestfs-actions.pod:2372
24306 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
24307 msgstr ""
24308
24309 #. type: textblock
24310 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:3852 ../src/guestfs-actions.pod:4540
24311 msgid ""
24312 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
24313 "an error.  I<The caller must call C<guestfs_free_xattr_list> after use>."
24314 msgstr ""
24315
24316 #. type: textblock
24317 #: ../src/guestfs-actions.pod:2378 ../src/guestfs-actions.pod:3856 ../src/guestfs-actions.pod:4055 ../src/guestfs-actions.pod:4091 ../src/guestfs-actions.pod:6137 ../src/guestfs-actions.pod:6662 ../src/guestfs-actions.pod:8057
24318 msgid "(Added in 1.0.59)"
24319 msgstr ""
24320
24321 #. type: =head2
24322 #: ../src/guestfs-actions.pod:2380
24323 msgid "guestfs_glob_expand"
24324 msgstr ""
24325
24326 #. type: verbatim
24327 #: ../src/guestfs-actions.pod:2382
24328 #, no-wrap
24329 msgid ""
24330 " char **\n"
24331 " guestfs_glob_expand (guestfs_h *g,\n"
24332 "                      const char *pattern);\n"
24333 "\n"
24334 msgstr ""
24335
24336 #. type: textblock
24337 #: ../src/guestfs-actions.pod:2401 ../src/guestfs-actions.pod:6855 ../src/guestfs-actions.pod:6872
24338 msgid "(Added in 1.0.50)"
24339 msgstr ""
24340
24341 #. type: =head2
24342 #: ../src/guestfs-actions.pod:2403
24343 msgid "guestfs_grep"
24344 msgstr ""
24345
24346 #. type: verbatim
24347 #: ../src/guestfs-actions.pod:2405
24348 #, no-wrap
24349 msgid ""
24350 " char **\n"
24351 " guestfs_grep (guestfs_h *g,\n"
24352 "               const char *regex,\n"
24353 "               const char *path);\n"
24354 "\n"
24355 msgstr ""
24356
24357 #. type: =head2
24358 #: ../src/guestfs-actions.pod:2422
24359 msgid "guestfs_grepi"
24360 msgstr ""
24361
24362 #. type: verbatim
24363 #: ../src/guestfs-actions.pod:2424
24364 #, no-wrap
24365 msgid ""
24366 " char **\n"
24367 " guestfs_grepi (guestfs_h *g,\n"
24368 "                const char *regex,\n"
24369 "                const char *path);\n"
24370 "\n"
24371 msgstr ""
24372
24373 #. type: =head2
24374 #: ../src/guestfs-actions.pod:2441
24375 msgid "guestfs_grub_install"
24376 msgstr ""
24377
24378 #. type: verbatim
24379 #: ../src/guestfs-actions.pod:2443
24380 #, no-wrap
24381 msgid ""
24382 " int\n"
24383 " guestfs_grub_install (guestfs_h *g,\n"
24384 "                       const char *root,\n"
24385 "                       const char *device);\n"
24386 "\n"
24387 msgstr ""
24388
24389 #. type: textblock
24390 #: ../src/guestfs-actions.pod:2486
24391 msgid "(Added in 1.0.17)"
24392 msgstr ""
24393
24394 #. type: =head2
24395 #: ../src/guestfs-actions.pod:2488
24396 msgid "guestfs_head"
24397 msgstr ""
24398
24399 #. type: verbatim
24400 #: ../src/guestfs-actions.pod:2490
24401 #, no-wrap
24402 msgid ""
24403 " char **\n"
24404 " guestfs_head (guestfs_h *g,\n"
24405 "               const char *path);\n"
24406 "\n"
24407 msgstr ""
24408
24409 #. type: =head2
24410 #: ../src/guestfs-actions.pod:2506
24411 msgid "guestfs_head_n"
24412 msgstr ""
24413
24414 #. type: verbatim
24415 #: ../src/guestfs-actions.pod:2508
24416 #, no-wrap
24417 msgid ""
24418 " char **\n"
24419 " guestfs_head_n (guestfs_h *g,\n"
24420 "                 int nrlines,\n"
24421 "                 const char *path);\n"
24422 "\n"
24423 msgstr ""
24424
24425 #. type: =head2
24426 #: ../src/guestfs-actions.pod:2530
24427 msgid "guestfs_hexdump"
24428 msgstr ""
24429
24430 #. type: verbatim
24431 #: ../src/guestfs-actions.pod:2532
24432 #, no-wrap
24433 msgid ""
24434 " char *\n"
24435 " guestfs_hexdump (guestfs_h *g,\n"
24436 "                  const char *path);\n"
24437 "\n"
24438 msgstr ""
24439
24440 #. type: textblock
24441 #: ../src/guestfs-actions.pod:2545 ../src/guestfs-actions.pod:6936 ../src/guestfs-actions.pod:6991
24442 msgid "(Added in 1.0.22)"
24443 msgstr ""
24444
24445 #. type: =head2
24446 #: ../src/guestfs-actions.pod:2547
24447 msgid "guestfs_initrd_cat"
24448 msgstr ""
24449
24450 #. type: verbatim
24451 #: ../src/guestfs-actions.pod:2549
24452 #, no-wrap
24453 msgid ""
24454 " char *\n"
24455 " guestfs_initrd_cat (guestfs_h *g,\n"
24456 "                     const char *initrdpath,\n"
24457 "                     const char *filename,\n"
24458 "                     size_t *size_r);\n"
24459 "\n"
24460 msgstr ""
24461
24462 #. type: textblock
24463 #: ../src/guestfs-actions.pod:2565
24464 msgid "See also C<guestfs_initrd_list>."
24465 msgstr ""
24466
24467 #. type: =head2
24468 #: ../src/guestfs-actions.pod:2576
24469 msgid "guestfs_initrd_list"
24470 msgstr ""
24471
24472 #. type: verbatim
24473 #: ../src/guestfs-actions.pod:2578
24474 #, no-wrap
24475 msgid ""
24476 " char **\n"
24477 " guestfs_initrd_list (guestfs_h *g,\n"
24478 "                      const char *path);\n"
24479 "\n"
24480 msgstr ""
24481
24482 #. type: =head2
24483 #: ../src/guestfs-actions.pod:2598
24484 msgid "guestfs_inotify_add_watch"
24485 msgstr ""
24486
24487 #. type: verbatim
24488 #: ../src/guestfs-actions.pod:2600
24489 #, no-wrap
24490 msgid ""
24491 " int64_t\n"
24492 " guestfs_inotify_add_watch (guestfs_h *g,\n"
24493 "                            const char *path,\n"
24494 "                            int mask);\n"
24495 "\n"
24496 msgstr ""
24497
24498 #. type: =head2
24499 #: ../src/guestfs-actions.pod:2619
24500 msgid "guestfs_inotify_close"
24501 msgstr ""
24502
24503 #. type: verbatim
24504 #: ../src/guestfs-actions.pod:2621
24505 #, no-wrap
24506 msgid ""
24507 " int\n"
24508 " guestfs_inotify_close (guestfs_h *g);\n"
24509 "\n"
24510 msgstr ""
24511
24512 #. type: =head2
24513 #: ../src/guestfs-actions.pod:2632
24514 msgid "guestfs_inotify_files"
24515 msgstr ""
24516
24517 #. type: verbatim
24518 #: ../src/guestfs-actions.pod:2634
24519 #, no-wrap
24520 msgid ""
24521 " char **\n"
24522 " guestfs_inotify_files (guestfs_h *g);\n"
24523 "\n"
24524 msgstr ""
24525
24526 #. type: textblock
24527 #: ../src/guestfs-actions.pod:2637
24528 msgid ""
24529 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
24530 "returns a list of pathnames of objects that were touched.  The returned "
24531 "pathnames are sorted and deduplicated."
24532 msgstr ""
24533
24534 #. type: =head2
24535 #: ../src/guestfs-actions.pod:2647
24536 msgid "guestfs_inotify_init"
24537 msgstr ""
24538
24539 #. type: verbatim
24540 #: ../src/guestfs-actions.pod:2649
24541 #, no-wrap
24542 msgid ""
24543 " int\n"
24544 " guestfs_inotify_init (guestfs_h *g,\n"
24545 "                       int maxevents);\n"
24546 "\n"
24547 msgstr ""
24548
24549 #. type: textblock
24550 #: ../src/guestfs-actions.pod:2657
24551 msgid ""
24552 "C<maxevents> is the maximum number of events which will be queued up between "
24553 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>.  If this is "
24554 "passed as C<0>, then the kernel (or previously set)  default is used.  For "
24555 "Linux 2.6.29 the default was 16384 events.  Beyond this limit, the kernel "
24556 "throws away events, but records the fact that it threw them away by setting "
24557 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
24558 "C<guestfs_inotify_read>)."
24559 msgstr ""
24560
24561 #. type: textblock
24562 #: ../src/guestfs-actions.pod:2667
24563 msgid ""
24564 "Before any events are generated, you have to add some watches to the "
24565 "internal watch list.  See: C<guestfs_inotify_add_watch>, "
24566 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
24567 msgstr ""
24568
24569 #. type: textblock
24570 #: ../src/guestfs-actions.pod:2673
24571 msgid ""
24572 "Queued up events should be read periodically by calling "
24573 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
24574 "wrapper around C<guestfs_inotify_read>).  If you don't read the events out "
24575 "often enough then you risk the internal queue overflowing."
24576 msgstr ""
24577
24578 #. type: textblock
24579 #: ../src/guestfs-actions.pod:2680
24580 msgid ""
24581 "The handle should be closed after use by calling C<guestfs_inotify_close>.  "
24582 "This also removes any watches automatically."
24583 msgstr ""
24584
24585 #. type: =head2
24586 #: ../src/guestfs-actions.pod:2693
24587 msgid "guestfs_inotify_read"
24588 msgstr ""
24589
24590 #. type: verbatim
24591 #: ../src/guestfs-actions.pod:2695
24592 #, no-wrap
24593 msgid ""
24594 " struct guestfs_inotify_event_list *\n"
24595 " guestfs_inotify_read (guestfs_h *g);\n"
24596 "\n"
24597 msgstr ""
24598
24599 #. type: textblock
24600 #: ../src/guestfs-actions.pod:2709
24601 msgid ""
24602 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
24603 "there was an error.  I<The caller must call "
24604 "C<guestfs_free_inotify_event_list> after use>."
24605 msgstr ""
24606
24607 #. type: =head2
24608 #: ../src/guestfs-actions.pod:2715
24609 msgid "guestfs_inotify_rm_watch"
24610 msgstr ""
24611
24612 #. type: verbatim
24613 #: ../src/guestfs-actions.pod:2717
24614 #, no-wrap
24615 msgid ""
24616 " int\n"
24617 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
24618 "                           int wd);\n"
24619 "\n"
24620 msgstr ""
24621
24622 #. type: textblock
24623 #: ../src/guestfs-actions.pod:2721
24624 msgid ""
24625 "Remove a previously defined inotify watch.  See "
24626 "C<guestfs_inotify_add_watch>."
24627 msgstr ""
24628
24629 #. type: =head2
24630 #: ../src/guestfs-actions.pod:2728
24631 msgid "guestfs_inspect_get_arch"
24632 msgstr ""
24633
24634 #. type: verbatim
24635 #: ../src/guestfs-actions.pod:2730
24636 #, no-wrap
24637 msgid ""
24638 " char *\n"
24639 " guestfs_inspect_get_arch (guestfs_h *g,\n"
24640 "                           const char *root);\n"
24641 "\n"
24642 msgstr ""
24643
24644 #. type: textblock
24645 #: ../src/guestfs-actions.pod:2734
24646 msgid ""
24647 "This returns the architecture of the inspected operating system.  The "
24648 "possible return values are listed under C<guestfs_file_architecture>."
24649 msgstr ""
24650
24651 #. type: =head2
24652 #: ../src/guestfs-actions.pod:2748
24653 msgid "guestfs_inspect_get_distro"
24654 msgstr ""
24655
24656 #. type: verbatim
24657 #: ../src/guestfs-actions.pod:2750
24658 #, no-wrap
24659 msgid ""
24660 " char *\n"
24661 " guestfs_inspect_get_distro (guestfs_h *g,\n"
24662 "                             const char *root);\n"
24663 "\n"
24664 msgstr ""
24665
24666 #. type: =head2
24667 #: ../src/guestfs-actions.pod:2842
24668 msgid "guestfs_inspect_get_drive_mappings"
24669 msgstr ""
24670
24671 #. type: verbatim
24672 #: ../src/guestfs-actions.pod:2844
24673 #, no-wrap
24674 msgid ""
24675 " char **\n"
24676 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
24677 "                                     const char *root);\n"
24678 "\n"
24679 msgstr ""
24680
24681 #. type: textblock
24682 #: ../src/guestfs-actions.pod:2873
24683 msgid ""
24684 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
24685 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
24686 msgstr ""
24687
24688 #. type: textblock
24689 #: ../src/guestfs-actions.pod:2877 ../src/guestfs-actions.pod:3145 ../src/guestfs-actions.pod:3943 ../src/guestfs-actions.pod:5225 ../src/guestfs-actions.pod:7293
24690 msgid ""
24691 "This function returns a NULL-terminated array of strings, or NULL if there "
24692 "was an error.  The array of strings will always have length C<2n+1>, where "
24693 "C<n> keys and values alternate, followed by the trailing NULL entry.  I<The "
24694 "caller must free the strings and the array after use>."
24695 msgstr ""
24696
24697 #. type: textblock
24698 #: ../src/guestfs-actions.pod:2883 ../src/guestfs-actions.pod:3339
24699 msgid "(Added in 1.9.17)"
24700 msgstr ""
24701
24702 #. type: =head2
24703 #: ../src/guestfs-actions.pod:2885
24704 msgid "guestfs_inspect_get_filesystems"
24705 msgstr ""
24706
24707 #. type: verbatim
24708 #: ../src/guestfs-actions.pod:2887
24709 #, no-wrap
24710 msgid ""
24711 " char **\n"
24712 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
24713 "                                  const char *root);\n"
24714 "\n"
24715 msgstr ""
24716
24717 #. type: textblock
24718 #: ../src/guestfs-actions.pod:2899
24719 msgid ""
24720 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
24721 "C<guestfs_inspect_get_mountpoints>."
24722 msgstr ""
24723
24724 #. type: =head2
24725 #: ../src/guestfs-actions.pod:2908
24726 msgid "guestfs_inspect_get_format"
24727 msgstr ""
24728
24729 #. type: verbatim
24730 #: ../src/guestfs-actions.pod:2910
24731 #, no-wrap
24732 msgid ""
24733 " char *\n"
24734 " guestfs_inspect_get_format (guestfs_h *g,\n"
24735 "                             const char *root);\n"
24736 "\n"
24737 msgstr ""
24738
24739 #. type: textblock
24740 #: ../src/guestfs-actions.pod:2944 ../src/guestfs-actions.pod:3375 ../src/guestfs-actions.pod:3391 ../src/guestfs-actions.pod:3409 ../src/guestfs-actions.pod:6175
24741 msgid "(Added in 1.9.4)"
24742 msgstr ""
24743
24744 #. type: =head2
24745 #: ../src/guestfs-actions.pod:2946
24746 msgid "guestfs_inspect_get_hostname"
24747 msgstr ""
24748
24749 #. type: verbatim
24750 #: ../src/guestfs-actions.pod:2948
24751 #, no-wrap
24752 msgid ""
24753 " char *\n"
24754 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
24755 "                               const char *root);\n"
24756 "\n"
24757 msgstr ""
24758
24759 #. type: textblock
24760 #: ../src/guestfs-actions.pod:2963
24761 msgid "(Added in 1.7.9)"
24762 msgstr ""
24763
24764 #. type: =head2
24765 #: ../src/guestfs-actions.pod:2965
24766 msgid "guestfs_inspect_get_icon"
24767 msgstr ""
24768
24769 #. type: verbatim
24770 #: ../src/guestfs-actions.pod:2967
24771 #, no-wrap
24772 msgid ""
24773 " char *\n"
24774 " guestfs_inspect_get_icon (guestfs_h *g,\n"
24775 "                           const char *root,\n"
24776 "                           size_t *size_r,\n"
24777 "                           ...);\n"
24778 "\n"
24779 msgstr ""
24780
24781 #. type: verbatim
24782 #: ../src/guestfs-actions.pod:2978
24783 #, no-wrap
24784 msgid ""
24785 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
24786 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
24787 "\n"
24788 msgstr ""
24789
24790 #. type: textblock
24791 #: ../src/guestfs-actions.pod:3045 ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:5124
24792 msgid "(Added in 1.11.12)"
24793 msgstr ""
24794
24795 #. type: =head2
24796 #: ../src/guestfs-actions.pod:3047
24797 msgid "guestfs_inspect_get_icon_va"
24798 msgstr ""
24799
24800 #. type: verbatim
24801 #: ../src/guestfs-actions.pod:3049
24802 #, no-wrap
24803 msgid ""
24804 " char *\n"
24805 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
24806 "                              const char *root,\n"
24807 "                              size_t *size_r,\n"
24808 "                              va_list args);\n"
24809 "\n"
24810 msgstr ""
24811
24812 #. type: textblock
24813 #: ../src/guestfs-actions.pod:3055
24814 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
24815 msgstr ""
24816
24817 #. type: =head2
24818 #: ../src/guestfs-actions.pod:3059
24819 msgid "guestfs_inspect_get_icon_argv"
24820 msgstr ""
24821
24822 #. type: verbatim
24823 #: ../src/guestfs-actions.pod:3061
24824 #, no-wrap
24825 msgid ""
24826 " char *\n"
24827 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
24828 "                                const char *root,\n"
24829 "                                size_t *size_r,\n"
24830 "                                const struct guestfs_inspect_get_icon_argv "
24831 "*optargs);\n"
24832 "\n"
24833 msgstr ""
24834
24835 #. type: textblock
24836 #: ../src/guestfs-actions.pod:3067
24837 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
24838 msgstr ""
24839
24840 #. type: =head2
24841 #: ../src/guestfs-actions.pod:3071
24842 msgid "guestfs_inspect_get_major_version"
24843 msgstr ""
24844
24845 #. type: verbatim
24846 #: ../src/guestfs-actions.pod:3073
24847 #, no-wrap
24848 msgid ""
24849 " int\n"
24850 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
24851 "                                    const char *root);\n"
24852 "\n"
24853 msgstr ""
24854
24855 #. type: =head2
24856 #: ../src/guestfs-actions.pod:3095
24857 msgid "guestfs_inspect_get_minor_version"
24858 msgstr ""
24859
24860 #. type: verbatim
24861 #: ../src/guestfs-actions.pod:3097
24862 #, no-wrap
24863 msgid ""
24864 " int\n"
24865 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
24866 "                                    const char *root);\n"
24867 "\n"
24868 msgstr ""
24869
24870 #. type: textblock
24871 #: ../src/guestfs-actions.pod:3106
24872 msgid ""
24873 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
24874 "C<guestfs_inspect_get_major_version>."
24875 msgstr ""
24876
24877 #. type: =head2
24878 #: ../src/guestfs-actions.pod:3113
24879 msgid "guestfs_inspect_get_mountpoints"
24880 msgstr ""
24881
24882 #. type: verbatim
24883 #: ../src/guestfs-actions.pod:3115
24884 #, no-wrap
24885 msgid ""
24886 " char **\n"
24887 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
24888 "                                  const char *root);\n"
24889 "\n"
24890 msgstr ""
24891
24892 #. type: textblock
24893 #: ../src/guestfs-actions.pod:3136
24894 msgid ""
24895 "For operating systems like Windows which still use drive letters, this call "
24896 "will only return an entry for the first drive \"mounted on\" C</>.  For "
24897 "information about the mapping of drive letters to partitions, see "
24898 "C<guestfs_inspect_get_drive_mappings>."
24899 msgstr ""
24900
24901 #. type: textblock
24902 #: ../src/guestfs-actions.pod:3142
24903 msgid ""
24904 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
24905 "C<guestfs_inspect_get_filesystems>."
24906 msgstr ""
24907
24908 #. type: =head2
24909 #: ../src/guestfs-actions.pod:3153
24910 msgid "guestfs_inspect_get_package_format"
24911 msgstr ""
24912
24913 #. type: verbatim
24914 #: ../src/guestfs-actions.pod:3155
24915 #, no-wrap
24916 msgid ""
24917 " char *\n"
24918 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
24919 "                                     const char *root);\n"
24920 "\n"
24921 msgstr ""
24922
24923 #. type: textblock
24924 #: ../src/guestfs-actions.pod:3159
24925 msgid ""
24926 "This function and C<guestfs_inspect_get_package_management> return the "
24927 "package format and package management tool used by the inspected operating "
24928 "system.  For example for Fedora these functions would return C<rpm> (package "
24929 "format) and C<yum> (package management)."
24930 msgstr ""
24931
24932 #. type: textblock
24933 #: ../src/guestfs-actions.pod:3177 ../src/guestfs-actions.pod:3205
24934 msgid "(Added in 1.7.5)"
24935 msgstr ""
24936
24937 #. type: =head2
24938 #: ../src/guestfs-actions.pod:3179
24939 msgid "guestfs_inspect_get_package_management"
24940 msgstr ""
24941
24942 #. type: verbatim
24943 #: ../src/guestfs-actions.pod:3181
24944 #, no-wrap
24945 msgid ""
24946 " char *\n"
24947 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
24948 "                                         const char *root);\n"
24949 "\n"
24950 msgstr ""
24951
24952 #. type: textblock
24953 #: ../src/guestfs-actions.pod:3185
24954 msgid ""
24955 "C<guestfs_inspect_get_package_format> and this function return the package "
24956 "format and package management tool used by the inspected operating system.  "
24957 "For example for Fedora these functions would return C<rpm> (package format) "
24958 "and C<yum> (package management)."
24959 msgstr ""
24960
24961 #. type: =head2
24962 #: ../src/guestfs-actions.pod:3207
24963 msgid "guestfs_inspect_get_product_name"
24964 msgstr ""
24965
24966 #. type: verbatim
24967 #: ../src/guestfs-actions.pod:3209
24968 #, no-wrap
24969 msgid ""
24970 " char *\n"
24971 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
24972 "                                   const char *root);\n"
24973 "\n"
24974 msgstr ""
24975
24976 #. type: =head2
24977 #: ../src/guestfs-actions.pod:3228
24978 msgid "guestfs_inspect_get_product_variant"
24979 msgstr ""
24980
24981 #. type: verbatim
24982 #: ../src/guestfs-actions.pod:3230
24983 #, no-wrap
24984 msgid ""
24985 " char *\n"
24986 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
24987 "                                      const char *root);\n"
24988 "\n"
24989 msgstr ""
24990
24991 #. type: textblock
24992 #: ../src/guestfs-actions.pod:3253
24993 msgid ""
24994 "Please read L<guestfs(3)/INSPECTION> for more details.  See also "
24995 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
24996 msgstr ""
24997
24998 #. type: textblock
24999 #: ../src/guestfs-actions.pod:3260
25000 msgid "(Added in 1.9.13)"
25001 msgstr ""
25002
25003 #. type: =head2
25004 #: ../src/guestfs-actions.pod:3262
25005 msgid "guestfs_inspect_get_roots"
25006 msgstr ""
25007
25008 #. type: verbatim
25009 #: ../src/guestfs-actions.pod:3264
25010 #, no-wrap
25011 msgid ""
25012 " char **\n"
25013 " guestfs_inspect_get_roots (guestfs_h *g);\n"
25014 "\n"
25015 msgstr ""
25016
25017 #. type: textblock
25018 #: ../src/guestfs-actions.pod:3267
25019 msgid ""
25020 "This function is a convenient way to get the list of root devices, as "
25021 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
25022 "the whole inspection process."
25023 msgstr ""
25024
25025 #. type: textblock
25026 #: ../src/guestfs-actions.pod:3271
25027 msgid ""
25028 "This returns an empty list if either no root devices were found or the "
25029 "caller has not called C<guestfs_inspect_os>."
25030 msgstr ""
25031
25032 #. type: textblock
25033 #: ../src/guestfs-actions.pod:3280
25034 msgid "(Added in 1.7.3)"
25035 msgstr ""
25036
25037 #. type: =head2
25038 #: ../src/guestfs-actions.pod:3282
25039 msgid "guestfs_inspect_get_type"
25040 msgstr ""
25041
25042 #. type: verbatim
25043 #: ../src/guestfs-actions.pod:3284
25044 #, no-wrap
25045 msgid ""
25046 " char *\n"
25047 " guestfs_inspect_get_type (guestfs_h *g,\n"
25048 "                           const char *root);\n"
25049 "\n"
25050 msgstr ""
25051
25052 #. type: =head2
25053 #: ../src/guestfs-actions.pod:3321
25054 msgid "guestfs_inspect_get_windows_current_control_set"
25055 msgstr ""
25056
25057 #. type: verbatim
25058 #: ../src/guestfs-actions.pod:3323
25059 #, no-wrap
25060 msgid ""
25061 " char *\n"
25062 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
25063 "                                                  const char *root);\n"
25064 "\n"
25065 msgstr ""
25066
25067 #. type: =head2
25068 #: ../src/guestfs-actions.pod:3341
25069 msgid "guestfs_inspect_get_windows_systemroot"
25070 msgstr ""
25071
25072 #. type: verbatim
25073 #: ../src/guestfs-actions.pod:3343
25074 #, no-wrap
25075 msgid ""
25076 " char *\n"
25077 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
25078 "                                         const char *root);\n"
25079 "\n"
25080 msgstr ""
25081
25082 #. type: textblock
25083 #: ../src/guestfs-actions.pod:3359
25084 msgid "(Added in 1.5.25)"
25085 msgstr ""
25086
25087 #. type: =head2
25088 #: ../src/guestfs-actions.pod:3361
25089 msgid "guestfs_inspect_is_live"
25090 msgstr ""
25091
25092 #. type: verbatim
25093 #: ../src/guestfs-actions.pod:3363
25094 #, no-wrap
25095 msgid ""
25096 " int\n"
25097 " guestfs_inspect_is_live (guestfs_h *g,\n"
25098 "                          const char *root);\n"
25099 "\n"
25100 msgstr ""
25101
25102 #. type: textblock
25103 #: ../src/guestfs-actions.pod:3367
25104 msgid ""
25105 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25106 "disk), then this returns true if a live image was detected on the disk."
25107 msgstr ""
25108
25109 #. type: =head2
25110 #: ../src/guestfs-actions.pod:3377
25111 msgid "guestfs_inspect_is_multipart"
25112 msgstr ""
25113
25114 #. type: verbatim
25115 #: ../src/guestfs-actions.pod:3379
25116 #, no-wrap
25117 msgid ""
25118 " int\n"
25119 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
25120 "                               const char *root);\n"
25121 "\n"
25122 msgstr ""
25123
25124 #. type: textblock
25125 #: ../src/guestfs-actions.pod:3383
25126 msgid ""
25127 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25128 "disk), then this returns true if the disk is part of a set."
25129 msgstr ""
25130
25131 #. type: =head2
25132 #: ../src/guestfs-actions.pod:3393
25133 msgid "guestfs_inspect_is_netinst"
25134 msgstr ""
25135
25136 #. type: verbatim
25137 #: ../src/guestfs-actions.pod:3395
25138 #, no-wrap
25139 msgid ""
25140 " int\n"
25141 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
25142 "                             const char *root);\n"
25143 "\n"
25144 msgstr ""
25145
25146 #. type: textblock
25147 #: ../src/guestfs-actions.pod:3399
25148 msgid ""
25149 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25150 "disk), then this returns true if the disk is a network installer, ie. not a "
25151 "self-contained install CD but one which is likely to require network access "
25152 "to complete the install."
25153 msgstr ""
25154
25155 #. type: =head2
25156 #: ../src/guestfs-actions.pod:3411
25157 msgid "guestfs_inspect_list_applications"
25158 msgstr ""
25159
25160 #. type: verbatim
25161 #: ../src/guestfs-actions.pod:3413
25162 #, no-wrap
25163 msgid ""
25164 " struct guestfs_application_list *\n"
25165 " guestfs_inspect_list_applications (guestfs_h *g,\n"
25166 "                                    const char *root);\n"
25167 "\n"
25168 msgstr ""
25169
25170 #. type: textblock
25171 #: ../src/guestfs-actions.pod:3419
25172 msgid ""
25173 "I<Note:> This call works differently from other parts of the inspection "
25174 "API.  You have to call C<guestfs_inspect_os>, then "
25175 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
25176 "this.  Listing applications is a significantly more difficult operation "
25177 "which requires access to the full filesystem.  Also note that unlike the "
25178 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
25179 "the libguestfs handle, this call actually reads parts of the mounted "
25180 "filesystems during the call."
25181 msgstr ""
25182
25183 #. type: textblock
25184 #: ../src/guestfs-actions.pod:3509
25185 msgid ""
25186 "This function returns a C<struct guestfs_application_list *>, or NULL if "
25187 "there was an error.  I<The caller must call C<guestfs_free_application_list> "
25188 "after use>."
25189 msgstr ""
25190
25191 #. type: textblock
25192 #: ../src/guestfs-actions.pod:3513
25193 msgid "(Added in 1.7.8)"
25194 msgstr ""
25195
25196 #. type: =head2
25197 #: ../src/guestfs-actions.pod:3515
25198 msgid "guestfs_inspect_os"
25199 msgstr ""
25200
25201 #. type: verbatim
25202 #: ../src/guestfs-actions.pod:3517
25203 #, no-wrap
25204 msgid ""
25205 " char **\n"
25206 " guestfs_inspect_os (guestfs_h *g);\n"
25207 "\n"
25208 msgstr ""
25209
25210 #. type: textblock
25211 #: ../src/guestfs-actions.pod:3533
25212 msgid ""
25213 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
25214 "functions in order to query further information about each operating system, "
25215 "such as the name and version."
25216 msgstr ""
25217
25218 #. type: textblock
25219 #: ../src/guestfs-actions.pod:3538
25220 msgid ""
25221 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
25222 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
25223 "the contents.  This should be called with no disks currently mounted.  The "
25224 "function may also use Augeas, so any existing Augeas handle will be closed."
25225 msgstr ""
25226
25227 #. type: textblock
25228 #: ../src/guestfs-actions.pod:3550 ../src/guestfs-actions.pod:3881 ../src/guestfs-actions.pod:3963
25229 msgid "See also C<guestfs_list_filesystems>."
25230 msgstr ""
25231
25232 #. type: =head2
25233 #: ../src/guestfs-actions.pod:3558
25234 msgid "guestfs_is_blockdev"
25235 msgstr ""
25236
25237 #. type: verbatim
25238 #: ../src/guestfs-actions.pod:3560
25239 #, no-wrap
25240 msgid ""
25241 " int\n"
25242 " guestfs_is_blockdev (guestfs_h *g,\n"
25243 "                      const char *path);\n"
25244 "\n"
25245 msgstr ""
25246
25247 #. type: textblock
25248 #: ../src/guestfs-actions.pod:3567 ../src/guestfs-actions.pod:3596 ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:3641 ../src/guestfs-actions.pod:3657 ../src/guestfs-actions.pod:3713 ../src/guestfs-actions.pod:3728
25249 msgid "See also C<guestfs_stat>."
25250 msgstr ""
25251
25252 #. type: textblock
25253 #: ../src/guestfs-actions.pod:3571 ../src/guestfs-actions.pod:3600 ../src/guestfs-actions.pod:3645 ../src/guestfs-actions.pod:3717 ../src/guestfs-actions.pod:3732
25254 msgid "(Added in 1.5.10)"
25255 msgstr ""
25256
25257 #. type: =head2
25258 #: ../src/guestfs-actions.pod:3573
25259 msgid "guestfs_is_busy"
25260 msgstr ""
25261
25262 #. type: verbatim
25263 #: ../src/guestfs-actions.pod:3575
25264 #, no-wrap
25265 msgid ""
25266 " int\n"
25267 " guestfs_is_busy (guestfs_h *g);\n"
25268 "\n"
25269 msgstr ""
25270
25271 #. type: =head2
25272 #: ../src/guestfs-actions.pod:3587
25273 msgid "guestfs_is_chardev"
25274 msgstr ""
25275
25276 #. type: verbatim
25277 #: ../src/guestfs-actions.pod:3589
25278 #, no-wrap
25279 msgid ""
25280 " int\n"
25281 " guestfs_is_chardev (guestfs_h *g,\n"
25282 "                     const char *path);\n"
25283 "\n"
25284 msgstr ""
25285
25286 #. type: =head2
25287 #: ../src/guestfs-actions.pod:3602
25288 msgid "guestfs_is_config"
25289 msgstr ""
25290
25291 #. type: verbatim
25292 #: ../src/guestfs-actions.pod:3604
25293 #, no-wrap
25294 msgid ""
25295 " int\n"
25296 " guestfs_is_config (guestfs_h *g);\n"
25297 "\n"
25298 msgstr ""
25299
25300 #. type: =head2
25301 #: ../src/guestfs-actions.pod:3616
25302 msgid "guestfs_is_dir"
25303 msgstr ""
25304
25305 #. type: verbatim
25306 #: ../src/guestfs-actions.pod:3618
25307 #, no-wrap
25308 msgid ""
25309 " int\n"
25310 " guestfs_is_dir (guestfs_h *g,\n"
25311 "                 const char *path);\n"
25312 "\n"
25313 msgstr ""
25314
25315 #. type: =head2
25316 #: ../src/guestfs-actions.pod:3632
25317 msgid "guestfs_is_fifo"
25318 msgstr ""
25319
25320 #. type: verbatim
25321 #: ../src/guestfs-actions.pod:3634
25322 #, no-wrap
25323 msgid ""
25324 " int\n"
25325 " guestfs_is_fifo (guestfs_h *g,\n"
25326 "                  const char *path);\n"
25327 "\n"
25328 msgstr ""
25329
25330 #. type: =head2
25331 #: ../src/guestfs-actions.pod:3647
25332 msgid "guestfs_is_file"
25333 msgstr ""
25334
25335 #. type: verbatim
25336 #: ../src/guestfs-actions.pod:3649
25337 #, no-wrap
25338 msgid ""
25339 " int\n"
25340 " guestfs_is_file (guestfs_h *g,\n"
25341 "                  const char *path);\n"
25342 "\n"
25343 msgstr ""
25344
25345 #. type: =head2
25346 #: ../src/guestfs-actions.pod:3663
25347 msgid "guestfs_is_launching"
25348 msgstr ""
25349
25350 #. type: verbatim
25351 #: ../src/guestfs-actions.pod:3665
25352 #, no-wrap
25353 msgid ""
25354 " int\n"
25355 " guestfs_is_launching (guestfs_h *g);\n"
25356 "\n"
25357 msgstr ""
25358
25359 #. type: =head2
25360 #: ../src/guestfs-actions.pod:3677
25361 msgid "guestfs_is_lv"
25362 msgstr ""
25363
25364 #. type: verbatim
25365 #: ../src/guestfs-actions.pod:3679
25366 #, no-wrap
25367 msgid ""
25368 " int\n"
25369 " guestfs_is_lv (guestfs_h *g,\n"
25370 "                const char *device);\n"
25371 "\n"
25372 msgstr ""
25373
25374 #. type: =head2
25375 #: ../src/guestfs-actions.pod:3690
25376 msgid "guestfs_is_ready"
25377 msgstr ""
25378
25379 #. type: verbatim
25380 #: ../src/guestfs-actions.pod:3692
25381 #, no-wrap
25382 msgid ""
25383 " int\n"
25384 " guestfs_is_ready (guestfs_h *g);\n"
25385 "\n"
25386 msgstr ""
25387
25388 #. type: =head2
25389 #: ../src/guestfs-actions.pod:3704
25390 msgid "guestfs_is_socket"
25391 msgstr ""
25392
25393 #. type: verbatim
25394 #: ../src/guestfs-actions.pod:3706
25395 #, no-wrap
25396 msgid ""
25397 " int\n"
25398 " guestfs_is_socket (guestfs_h *g,\n"
25399 "                    const char *path);\n"
25400 "\n"
25401 msgstr ""
25402
25403 #. type: =head2
25404 #: ../src/guestfs-actions.pod:3719
25405 msgid "guestfs_is_symlink"
25406 msgstr ""
25407
25408 #. type: verbatim
25409 #: ../src/guestfs-actions.pod:3721
25410 #, no-wrap
25411 msgid ""
25412 " int\n"
25413 " guestfs_is_symlink (guestfs_h *g,\n"
25414 "                     const char *path);\n"
25415 "\n"
25416 msgstr ""
25417
25418 #. type: =head2
25419 #: ../src/guestfs-actions.pod:3734
25420 msgid "guestfs_is_zero"
25421 msgstr ""
25422
25423 #. type: verbatim
25424 #: ../src/guestfs-actions.pod:3736
25425 #, no-wrap
25426 msgid ""
25427 " int\n"
25428 " guestfs_is_zero (guestfs_h *g,\n"
25429 "                  const char *path);\n"
25430 "\n"
25431 msgstr ""
25432
25433 #. type: textblock
25434 #: ../src/guestfs-actions.pod:3745 ../src/guestfs-actions.pod:3759
25435 msgid "(Added in 1.11.8)"
25436 msgstr ""
25437
25438 #. type: =head2
25439 #: ../src/guestfs-actions.pod:3747
25440 msgid "guestfs_is_zero_device"
25441 msgstr ""
25442
25443 #. type: verbatim
25444 #: ../src/guestfs-actions.pod:3749
25445 #, no-wrap
25446 msgid ""
25447 " int\n"
25448 " guestfs_is_zero_device (guestfs_h *g,\n"
25449 "                         const char *device);\n"
25450 "\n"
25451 msgstr ""
25452
25453 #. type: =head2
25454 #: ../src/guestfs-actions.pod:3761
25455 msgid "guestfs_kill_subprocess"
25456 msgstr ""
25457
25458 #. type: verbatim
25459 #: ../src/guestfs-actions.pod:3763
25460 #, no-wrap
25461 msgid ""
25462 " int\n"
25463 " guestfs_kill_subprocess (guestfs_h *g);\n"
25464 "\n"
25465 msgstr ""
25466
25467 #. type: =head2
25468 #: ../src/guestfs-actions.pod:3772
25469 msgid "guestfs_launch"
25470 msgstr ""
25471
25472 #. type: verbatim
25473 #: ../src/guestfs-actions.pod:3774
25474 #, no-wrap
25475 msgid ""
25476 " int\n"
25477 " guestfs_launch (guestfs_h *g);\n"
25478 "\n"
25479 msgstr ""
25480
25481 #. type: =head2
25482 #: ../src/guestfs-actions.pod:3792
25483 msgid "guestfs_lchown"
25484 msgstr ""
25485
25486 #. type: verbatim
25487 #: ../src/guestfs-actions.pod:3794
25488 #, no-wrap
25489 msgid ""
25490 " int\n"
25491 " guestfs_lchown (guestfs_h *g,\n"
25492 "                 int owner,\n"
25493 "                 int group,\n"
25494 "                 const char *path);\n"
25495 "\n"
25496 msgstr ""
25497
25498 #. type: textblock
25499 #: ../src/guestfs-actions.pod:3800
25500 msgid ""
25501 "Change the file owner to C<owner> and group to C<group>.  This is like "
25502 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
25503 "changed, not the target."
25504 msgstr ""
25505
25506 #. type: =head2
25507 #: ../src/guestfs-actions.pod:3812
25508 msgid "guestfs_lgetxattr"
25509 msgstr ""
25510
25511 #. type: verbatim
25512 #: ../src/guestfs-actions.pod:3814
25513 #, no-wrap
25514 msgid ""
25515 " char *\n"
25516 " guestfs_lgetxattr (guestfs_h *g,\n"
25517 "                    const char *path,\n"
25518 "                    const char *name,\n"
25519 "                    size_t *size_r);\n"
25520 "\n"
25521 msgstr ""
25522
25523 #. type: textblock
25524 #: ../src/guestfs-actions.pod:3834
25525 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
25526 msgstr ""
25527
25528 #. type: =head2
25529 #: ../src/guestfs-actions.pod:3842
25530 msgid "guestfs_lgetxattrs"
25531 msgstr ""
25532
25533 #. type: verbatim
25534 #: ../src/guestfs-actions.pod:3844
25535 #, no-wrap
25536 msgid ""
25537 " struct guestfs_xattr_list *\n"
25538 " guestfs_lgetxattrs (guestfs_h *g,\n"
25539 "                     const char *path);\n"
25540 "\n"
25541 msgstr ""
25542
25543 #. type: textblock
25544 #: ../src/guestfs-actions.pod:3848
25545 msgid ""
25546 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
25547 "then it returns the extended attributes of the link itself."
25548 msgstr ""
25549
25550 #. type: =head2
25551 #: ../src/guestfs-actions.pod:3858
25552 msgid "guestfs_list_9p"
25553 msgstr ""
25554
25555 #. type: verbatim
25556 #: ../src/guestfs-actions.pod:3860
25557 #, no-wrap
25558 msgid ""
25559 " char **\n"
25560 " guestfs_list_9p (guestfs_h *g);\n"
25561 "\n"
25562 msgstr ""
25563
25564 #. type: =head2
25565 #: ../src/guestfs-actions.pod:3872
25566 msgid "guestfs_list_devices"
25567 msgstr ""
25568
25569 #. type: verbatim
25570 #: ../src/guestfs-actions.pod:3874
25571 #, no-wrap
25572 msgid ""
25573 " char **\n"
25574 " guestfs_list_devices (guestfs_h *g);\n"
25575 "\n"
25576 msgstr ""
25577
25578 #. type: =head2
25579 #: ../src/guestfs-actions.pod:3889
25580 msgid "guestfs_list_dm_devices"
25581 msgstr ""
25582
25583 #. type: verbatim
25584 #: ../src/guestfs-actions.pod:3891
25585 #, no-wrap
25586 msgid ""
25587 " char **\n"
25588 " guestfs_list_dm_devices (guestfs_h *g);\n"
25589 "\n"
25590 msgstr ""
25591
25592 #. type: textblock
25593 #: ../src/guestfs-actions.pod:3896
25594 msgid ""
25595 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
25596 "previous call to C<guestfs_luks_open>."
25597 msgstr ""
25598
25599 #. type: textblock
25600 #: ../src/guestfs-actions.pod:3899
25601 msgid ""
25602 "Device mapper devices which correspond to logical volumes are I<not> "
25603 "returned in this list.  Call C<guestfs_lvs> if you want to list logical "
25604 "volumes."
25605 msgstr ""
25606
25607 #. type: textblock
25608 #: ../src/guestfs-actions.pod:3907 ../src/guestfs-actions.pod:5363
25609 msgid "(Added in 1.11.15)"
25610 msgstr ""
25611
25612 #. type: =head2
25613 #: ../src/guestfs-actions.pod:3909
25614 msgid "guestfs_list_filesystems"
25615 msgstr ""
25616
25617 #. type: verbatim
25618 #: ../src/guestfs-actions.pod:3911
25619 #, no-wrap
25620 msgid ""
25621 " char **\n"
25622 " guestfs_list_filesystems (guestfs_h *g);\n"
25623 "\n"
25624 msgstr ""
25625
25626 #. type: textblock
25627 #: ../src/guestfs-actions.pod:3931
25628 msgid ""
25629 "This command runs other libguestfs commands, which might include "
25630 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
25631 "soon after launch and only when nothing is mounted."
25632 msgstr ""
25633
25634 #. type: textblock
25635 #: ../src/guestfs-actions.pod:3935
25636 msgid ""
25637 "Not all of the filesystems returned will be mountable.  In particular, swap "
25638 "partitions are returned in the list.  Also this command does not check that "
25639 "each filesystem found is valid and mountable, and some filesystems might be "
25640 "mountable but require special options.  Filesystems may not all belong to a "
25641 "single logical operating system (use C<guestfs_inspect_os> to look for "
25642 "OSes)."
25643 msgstr ""
25644
25645 #. type: textblock
25646 #: ../src/guestfs-actions.pod:3949 ../src/guestfs-actions.pod:5724
25647 msgid "(Added in 1.5.15)"
25648 msgstr ""
25649
25650 #. type: =head2
25651 #: ../src/guestfs-actions.pod:3951
25652 msgid "guestfs_list_partitions"
25653 msgstr ""
25654
25655 #. type: verbatim
25656 #: ../src/guestfs-actions.pod:3953
25657 #, no-wrap
25658 msgid ""
25659 " char **\n"
25660 " guestfs_list_partitions (guestfs_h *g);\n"
25661 "\n"
25662 msgstr ""
25663
25664 #. type: textblock
25665 #: ../src/guestfs-actions.pod:3960
25666 msgid ""
25667 "This does not return logical volumes.  For that you will need to call "
25668 "C<guestfs_lvs>."
25669 msgstr ""
25670
25671 #. type: =head2
25672 #: ../src/guestfs-actions.pod:3971
25673 msgid "guestfs_ll"
25674 msgstr ""
25675
25676 #. type: verbatim
25677 #: ../src/guestfs-actions.pod:3973
25678 #, no-wrap
25679 msgid ""
25680 " char *\n"
25681 " guestfs_ll (guestfs_h *g,\n"
25682 "             const char *directory);\n"
25683 "\n"
25684 msgstr ""
25685
25686 #. type: =head2
25687 #: ../src/guestfs-actions.pod:3988
25688 msgid "guestfs_ln"
25689 msgstr ""
25690
25691 #. type: verbatim
25692 #: ../src/guestfs-actions.pod:3990
25693 #, no-wrap
25694 msgid ""
25695 " int\n"
25696 " guestfs_ln (guestfs_h *g,\n"
25697 "             const char *target,\n"
25698 "             const char *linkname);\n"
25699 "\n"
25700 msgstr ""
25701
25702 #. type: =head2
25703 #: ../src/guestfs-actions.pod:4001
25704 msgid "guestfs_ln_f"
25705 msgstr ""
25706
25707 #. type: verbatim
25708 #: ../src/guestfs-actions.pod:4003
25709 #, no-wrap
25710 msgid ""
25711 " int\n"
25712 " guestfs_ln_f (guestfs_h *g,\n"
25713 "               const char *target,\n"
25714 "               const char *linkname);\n"
25715 "\n"
25716 msgstr ""
25717
25718 #. type: =head2
25719 #: ../src/guestfs-actions.pod:4015
25720 msgid "guestfs_ln_s"
25721 msgstr ""
25722
25723 #. type: verbatim
25724 #: ../src/guestfs-actions.pod:4017
25725 #, no-wrap
25726 msgid ""
25727 " int\n"
25728 " guestfs_ln_s (guestfs_h *g,\n"
25729 "               const char *target,\n"
25730 "               const char *linkname);\n"
25731 "\n"
25732 msgstr ""
25733
25734 #. type: =head2
25735 #: ../src/guestfs-actions.pod:4028
25736 msgid "guestfs_ln_sf"
25737 msgstr ""
25738
25739 #. type: verbatim
25740 #: ../src/guestfs-actions.pod:4030
25741 #, no-wrap
25742 msgid ""
25743 " int\n"
25744 " guestfs_ln_sf (guestfs_h *g,\n"
25745 "                const char *target,\n"
25746 "                const char *linkname);\n"
25747 "\n"
25748 msgstr ""
25749
25750 #. type: =head2
25751 #: ../src/guestfs-actions.pod:4042
25752 msgid "guestfs_lremovexattr"
25753 msgstr ""
25754
25755 #. type: verbatim
25756 #: ../src/guestfs-actions.pod:4044
25757 #, no-wrap
25758 msgid ""
25759 " int\n"
25760 " guestfs_lremovexattr (guestfs_h *g,\n"
25761 "                       const char *xattr,\n"
25762 "                       const char *path);\n"
25763 "\n"
25764 msgstr ""
25765
25766 #. type: textblock
25767 #: ../src/guestfs-actions.pod:4049
25768 msgid ""
25769 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
25770 "link, then it removes an extended attribute of the link itself."
25771 msgstr ""
25772
25773 #. type: =head2
25774 #: ../src/guestfs-actions.pod:4057
25775 msgid "guestfs_ls"
25776 msgstr ""
25777
25778 #. type: verbatim
25779 #: ../src/guestfs-actions.pod:4059
25780 #, no-wrap
25781 msgid ""
25782 " char **\n"
25783 " guestfs_ls (guestfs_h *g,\n"
25784 "             const char *directory);\n"
25785 "\n"
25786 msgstr ""
25787
25788 #. type: textblock
25789 #: ../src/guestfs-actions.pod:4067
25790 msgid ""
25791 "This command is mostly useful for interactive sessions.  Programs should "
25792 "probably use C<guestfs_readdir> instead."
25793 msgstr ""
25794
25795 #. type: =head2
25796 #: ../src/guestfs-actions.pod:4076
25797 msgid "guestfs_lsetxattr"
25798 msgstr ""
25799
25800 #. type: verbatim
25801 #: ../src/guestfs-actions.pod:4078
25802 #, no-wrap
25803 msgid ""
25804 " int\n"
25805 " guestfs_lsetxattr (guestfs_h *g,\n"
25806 "                    const char *xattr,\n"
25807 "                    const char *val,\n"
25808 "                    int vallen,\n"
25809 "                    const char *path);\n"
25810 "\n"
25811 msgstr ""
25812
25813 #. type: textblock
25814 #: ../src/guestfs-actions.pod:4085
25815 msgid ""
25816 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
25817 "then it sets an extended attribute of the link itself."
25818 msgstr ""
25819
25820 #. type: =head2
25821 #: ../src/guestfs-actions.pod:4093
25822 msgid "guestfs_lstat"
25823 msgstr ""
25824
25825 #. type: verbatim
25826 #: ../src/guestfs-actions.pod:4095
25827 #, no-wrap
25828 msgid ""
25829 " struct guestfs_stat *\n"
25830 " guestfs_lstat (guestfs_h *g,\n"
25831 "                const char *path);\n"
25832 "\n"
25833 msgstr ""
25834
25835 #. type: textblock
25836 #: ../src/guestfs-actions.pod:4101
25837 msgid ""
25838 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
25839 "link, then the link is stat-ed, not the file it refers to."
25840 msgstr ""
25841
25842 #. type: textblock
25843 #: ../src/guestfs-actions.pod:4107 ../src/guestfs-actions.pod:6896
25844 msgid ""
25845 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
25846 "error.  I<The caller must call C<guestfs_free_stat> after use>."
25847 msgstr ""
25848
25849 #. type: textblock
25850 #: ../src/guestfs-actions.pod:4111 ../src/guestfs-actions.pod:6900 ../src/guestfs-actions.pod:6918 ../src/guestfs-actions.pod:7299
25851 msgid "(Added in 0.9.2)"
25852 msgstr ""
25853
25854 #. type: =head2
25855 #: ../src/guestfs-actions.pod:4113
25856 msgid "guestfs_lstatlist"
25857 msgstr ""
25858
25859 #. type: verbatim
25860 #: ../src/guestfs-actions.pod:4115
25861 #, no-wrap
25862 msgid ""
25863 " struct guestfs_stat_list *\n"
25864 " guestfs_lstatlist (guestfs_h *g,\n"
25865 "                    const char *path,\n"
25866 "                    char *const *names);\n"
25867 "\n"
25868 msgstr ""
25869
25870 #. type: textblock
25871 #: ../src/guestfs-actions.pod:4120
25872 msgid ""
25873 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
25874 "files, where all files are in the directory C<path>.  C<names> is the list "
25875 "of files from this directory."
25876 msgstr ""
25877
25878 #. type: textblock
25879 #: ../src/guestfs-actions.pod:4129
25880 msgid ""
25881 "This call is intended for programs that want to efficiently list a directory "
25882 "contents without making many round-trips.  See also C<guestfs_lxattrlist> "
25883 "for a similarly efficient call for getting extended attributes.  Very long "
25884 "directory listings might cause the protocol message size to be exceeded, "
25885 "causing this call to fail.  The caller must split up such requests into "
25886 "smaller groups of names."
25887 msgstr ""
25888
25889 #. type: textblock
25890 #: ../src/guestfs-actions.pod:4137
25891 msgid ""
25892 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
25893 "an error.  I<The caller must call C<guestfs_free_stat_list> after use>."
25894 msgstr ""
25895
25896 #. type: =head2
25897 #: ../src/guestfs-actions.pod:4143
25898 msgid "guestfs_luks_add_key"
25899 msgstr ""
25900
25901 #. type: verbatim
25902 #: ../src/guestfs-actions.pod:4145
25903 #, no-wrap
25904 msgid ""
25905 " int\n"
25906 " guestfs_luks_add_key (guestfs_h *g,\n"
25907 "                       const char *device,\n"
25908 "                       const char *key,\n"
25909 "                       const char *newkey,\n"
25910 "                       int keyslot);\n"
25911 "\n"
25912 msgstr ""
25913
25914 #. type: textblock
25915 #: ../src/guestfs-actions.pod:4157
25916 msgid ""
25917 "Note that if C<keyslot> already contains a key, then this command will "
25918 "fail.  You have to use C<guestfs_luks_kill_slot> first to remove that key."
25919 msgstr ""
25920
25921 #. type: textblock
25922 #: ../src/guestfs-actions.pod:4163 ../src/guestfs-actions.pod:4203 ../src/guestfs-actions.pod:4226 ../src/guestfs-actions.pod:4246 ../src/guestfs-actions.pod:4281 ../src/guestfs-actions.pod:4300
25923 msgid ""
25924 "This function takes a key or passphrase parameter which could contain "
25925 "sensitive material.  Read the section L</KEYS AND PASSPHRASES> for more "
25926 "information."
25927 msgstr ""
25928
25929 #. type: textblock
25930 #: ../src/guestfs-actions.pod:4167 ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:4250
25931 msgid "(Added in 1.5.2)"
25932 msgstr ""
25933
25934 #. type: =head2
25935 #: ../src/guestfs-actions.pod:4169
25936 msgid "guestfs_luks_close"
25937 msgstr ""
25938
25939 #. type: verbatim
25940 #: ../src/guestfs-actions.pod:4171
25941 #, no-wrap
25942 msgid ""
25943 " int\n"
25944 " guestfs_luks_close (guestfs_h *g,\n"
25945 "                     const char *device);\n"
25946 "\n"
25947 msgstr ""
25948
25949 #. type: textblock
25950 #: ../src/guestfs-actions.pod:4175
25951 msgid ""
25952 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
25953 "or C<guestfs_luks_open_ro>.  The C<device> parameter must be the name of the "
25954 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
25955 "underlying block device."
25956 msgstr ""
25957
25958 #. type: textblock
25959 #: ../src/guestfs-actions.pod:4183 ../src/guestfs-actions.pod:4285 ../src/guestfs-actions.pod:4304 ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:4402
25960 msgid "(Added in 1.5.1)"
25961 msgstr ""
25962
25963 #. type: =head2
25964 #: ../src/guestfs-actions.pod:4185
25965 msgid "guestfs_luks_format"
25966 msgstr ""
25967
25968 #. type: verbatim
25969 #: ../src/guestfs-actions.pod:4187
25970 #, no-wrap
25971 msgid ""
25972 " int\n"
25973 " guestfs_luks_format (guestfs_h *g,\n"
25974 "                      const char *device,\n"
25975 "                      const char *key,\n"
25976 "                      int keyslot);\n"
25977 "\n"
25978 msgstr ""
25979
25980 #. type: =head2
25981 #: ../src/guestfs-actions.pod:4209
25982 msgid "guestfs_luks_format_cipher"
25983 msgstr ""
25984
25985 #. type: verbatim
25986 #: ../src/guestfs-actions.pod:4211
25987 #, no-wrap
25988 msgid ""
25989 " int\n"
25990 " guestfs_luks_format_cipher (guestfs_h *g,\n"
25991 "                             const char *device,\n"
25992 "                             const char *key,\n"
25993 "                             int keyslot,\n"
25994 "                             const char *cipher);\n"
25995 "\n"
25996 msgstr ""
25997
25998 #. type: textblock
25999 #: ../src/guestfs-actions.pod:4218
26000 msgid ""
26001 "This command is the same as C<guestfs_luks_format> but it also allows you to "
26002 "set the C<cipher> used."
26003 msgstr ""
26004
26005 #. type: =head2
26006 #: ../src/guestfs-actions.pod:4232
26007 msgid "guestfs_luks_kill_slot"
26008 msgstr ""
26009
26010 #. type: verbatim
26011 #: ../src/guestfs-actions.pod:4234
26012 #, no-wrap
26013 msgid ""
26014 " int\n"
26015 " guestfs_luks_kill_slot (guestfs_h *g,\n"
26016 "                         const char *device,\n"
26017 "                         const char *key,\n"
26018 "                         int keyslot);\n"
26019 "\n"
26020 msgstr ""
26021
26022 #. type: =head2
26023 #: ../src/guestfs-actions.pod:4252
26024 msgid "guestfs_luks_open"
26025 msgstr ""
26026
26027 #. type: verbatim
26028 #: ../src/guestfs-actions.pod:4254
26029 #, no-wrap
26030 msgid ""
26031 " int\n"
26032 " guestfs_luks_open (guestfs_h *g,\n"
26033 "                    const char *device,\n"
26034 "                    const char *key,\n"
26035 "                    const char *mapname);\n"
26036 "\n"
26037 msgstr ""
26038
26039 #. type: textblock
26040 #: ../src/guestfs-actions.pod:4272
26041 msgid ""
26042 "If this block device contains LVM volume groups, then calling "
26043 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
26044 "visible."
26045 msgstr ""
26046
26047 #. type: textblock
26048 #: ../src/guestfs-actions.pod:4276
26049 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
26050 msgstr ""
26051
26052 #. type: =head2
26053 #: ../src/guestfs-actions.pod:4287
26054 msgid "guestfs_luks_open_ro"
26055 msgstr ""
26056
26057 #. type: verbatim
26058 #: ../src/guestfs-actions.pod:4289
26059 #, no-wrap
26060 msgid ""
26061 " int\n"
26062 " guestfs_luks_open_ro (guestfs_h *g,\n"
26063 "                       const char *device,\n"
26064 "                       const char *key,\n"
26065 "                       const char *mapname);\n"
26066 "\n"
26067 msgstr ""
26068
26069 #. type: textblock
26070 #: ../src/guestfs-actions.pod:4295
26071 msgid ""
26072 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
26073 "created."
26074 msgstr ""
26075
26076 #. type: =head2
26077 #: ../src/guestfs-actions.pod:4306
26078 msgid "guestfs_lvcreate"
26079 msgstr ""
26080
26081 #. type: verbatim
26082 #: ../src/guestfs-actions.pod:4308
26083 #, no-wrap
26084 msgid ""
26085 " int\n"
26086 " guestfs_lvcreate (guestfs_h *g,\n"
26087 "                   const char *logvol,\n"
26088 "                   const char *volgroup,\n"
26089 "                   int mbytes);\n"
26090 "\n"
26091 msgstr ""
26092
26093 #. type: =head2
26094 #: ../src/guestfs-actions.pod:4321
26095 msgid "guestfs_lvm_canonical_lv_name"
26096 msgstr ""
26097
26098 #. type: verbatim
26099 #: ../src/guestfs-actions.pod:4323
26100 #, no-wrap
26101 msgid ""
26102 " char *\n"
26103 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
26104 "                                const char *lvname);\n"
26105 "\n"
26106 msgstr ""
26107
26108 #. type: textblock
26109 #: ../src/guestfs-actions.pod:4334
26110 msgid "See also C<guestfs_is_lv>."
26111 msgstr ""
26112
26113 #. type: textblock
26114 #: ../src/guestfs-actions.pod:4339
26115 msgid "(Added in 1.5.24)"
26116 msgstr ""
26117
26118 #. type: =head2
26119 #: ../src/guestfs-actions.pod:4341
26120 msgid "guestfs_lvm_clear_filter"
26121 msgstr ""
26122
26123 #. type: verbatim
26124 #: ../src/guestfs-actions.pod:4343
26125 #, no-wrap
26126 msgid ""
26127 " int\n"
26128 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
26129 "\n"
26130 msgstr ""
26131
26132 #. type: textblock
26133 #: ../src/guestfs-actions.pod:4346
26134 msgid ""
26135 "This undoes the effect of C<guestfs_lvm_set_filter>.  LVM will be able to "
26136 "see every block device."
26137 msgstr ""
26138
26139 #. type: =head2
26140 #: ../src/guestfs-actions.pod:4356
26141 msgid "guestfs_lvm_remove_all"
26142 msgstr ""
26143
26144 #. type: verbatim
26145 #: ../src/guestfs-actions.pod:4358
26146 #, no-wrap
26147 msgid ""
26148 " int\n"
26149 " guestfs_lvm_remove_all (guestfs_h *g);\n"
26150 "\n"
26151 msgstr ""
26152
26153 #. type: =head2
26154 #: ../src/guestfs-actions.pod:4371
26155 msgid "guestfs_lvm_set_filter"
26156 msgstr ""
26157
26158 #. type: verbatim
26159 #: ../src/guestfs-actions.pod:4373
26160 #, no-wrap
26161 msgid ""
26162 " int\n"
26163 " guestfs_lvm_set_filter (guestfs_h *g,\n"
26164 "                         char *const *devices);\n"
26165 "\n"
26166 msgstr ""
26167
26168 #. type: =head2
26169 #: ../src/guestfs-actions.pod:4404
26170 msgid "guestfs_lvremove"
26171 msgstr ""
26172
26173 #. type: verbatim
26174 #: ../src/guestfs-actions.pod:4406
26175 #, no-wrap
26176 msgid ""
26177 " int\n"
26178 " guestfs_lvremove (guestfs_h *g,\n"
26179 "                   const char *device);\n"
26180 "\n"
26181 msgstr ""
26182
26183 #. type: textblock
26184 #: ../src/guestfs-actions.pod:4418 ../src/guestfs-actions.pod:5821 ../src/guestfs-actions.pod:7669
26185 msgid "(Added in 1.0.13)"
26186 msgstr ""
26187
26188 #. type: =head2
26189 #: ../src/guestfs-actions.pod:4420
26190 msgid "guestfs_lvrename"
26191 msgstr ""
26192
26193 #. type: verbatim
26194 #: ../src/guestfs-actions.pod:4422
26195 #, no-wrap
26196 msgid ""
26197 " int\n"
26198 " guestfs_lvrename (guestfs_h *g,\n"
26199 "                   const char *logvol,\n"
26200 "                   const char *newlogvol);\n"
26201 "\n"
26202 msgstr ""
26203
26204 #. type: textblock
26205 #: ../src/guestfs-actions.pod:4431 ../src/guestfs-actions.pod:7682
26206 msgid "(Added in 1.0.83)"
26207 msgstr ""
26208
26209 #. type: =head2
26210 #: ../src/guestfs-actions.pod:4433
26211 msgid "guestfs_lvresize"
26212 msgstr ""
26213
26214 #. type: verbatim
26215 #: ../src/guestfs-actions.pod:4435
26216 #, no-wrap
26217 msgid ""
26218 " int\n"
26219 " guestfs_lvresize (guestfs_h *g,\n"
26220 "                   const char *device,\n"
26221 "                   int mbytes);\n"
26222 "\n"
26223 msgstr ""
26224
26225 #. type: =head2
26226 #: ../src/guestfs-actions.pod:4448
26227 msgid "guestfs_lvresize_free"
26228 msgstr ""
26229
26230 #. type: verbatim
26231 #: ../src/guestfs-actions.pod:4450
26232 #, no-wrap
26233 msgid ""
26234 " int\n"
26235 " guestfs_lvresize_free (guestfs_h *g,\n"
26236 "                        const char *lv,\n"
26237 "                        int percent);\n"
26238 "\n"
26239 msgstr ""
26240
26241 #. type: textblock
26242 #: ../src/guestfs-actions.pod:4463
26243 msgid "(Added in 1.3.3)"
26244 msgstr ""
26245
26246 #. type: =head2
26247 #: ../src/guestfs-actions.pod:4465
26248 msgid "guestfs_lvs"
26249 msgstr ""
26250
26251 #. type: verbatim
26252 #: ../src/guestfs-actions.pod:4467
26253 #, no-wrap
26254 msgid ""
26255 " char **\n"
26256 " guestfs_lvs (guestfs_h *g);\n"
26257 "\n"
26258 msgstr ""
26259
26260 #. type: textblock
26261 #: ../src/guestfs-actions.pod:4476
26262 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
26263 msgstr ""
26264
26265 #. type: =head2
26266 #: ../src/guestfs-actions.pod:4484
26267 msgid "guestfs_lvs_full"
26268 msgstr ""
26269
26270 #. type: verbatim
26271 #: ../src/guestfs-actions.pod:4486
26272 #, no-wrap
26273 msgid ""
26274 " struct guestfs_lvm_lv_list *\n"
26275 " guestfs_lvs_full (guestfs_h *g);\n"
26276 "\n"
26277 msgstr ""
26278
26279 #. type: textblock
26280 #: ../src/guestfs-actions.pod:4492
26281 msgid ""
26282 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
26283 "was an error.  I<The caller must call C<guestfs_free_lvm_lv_list> after "
26284 "use>."
26285 msgstr ""
26286
26287 #. type: =head2
26288 #: ../src/guestfs-actions.pod:4498
26289 msgid "guestfs_lvuuid"
26290 msgstr ""
26291
26292 #. type: verbatim
26293 #: ../src/guestfs-actions.pod:4500
26294 #, no-wrap
26295 msgid ""
26296 " char *\n"
26297 " guestfs_lvuuid (guestfs_h *g,\n"
26298 "                 const char *device);\n"
26299 "\n"
26300 msgstr ""
26301
26302 #. type: =head2
26303 #: ../src/guestfs-actions.pod:4511
26304 msgid "guestfs_lxattrlist"
26305 msgstr ""
26306
26307 #. type: verbatim
26308 #: ../src/guestfs-actions.pod:4513
26309 #, no-wrap
26310 msgid ""
26311 " struct guestfs_xattr_list *\n"
26312 " guestfs_lxattrlist (guestfs_h *g,\n"
26313 "                     const char *path,\n"
26314 "                     char *const *names);\n"
26315 "\n"
26316 msgstr ""
26317
26318 #. type: textblock
26319 #: ../src/guestfs-actions.pod:4532
26320 msgid ""
26321 "This call is intended for programs that want to efficiently list a directory "
26322 "contents without making many round-trips.  See also C<guestfs_lstatlist> for "
26323 "a similarly efficient call for getting standard stats.  Very long directory "
26324 "listings might cause the protocol message size to be exceeded, causing this "
26325 "call to fail.  The caller must split up such requests into smaller groups of "
26326 "names."
26327 msgstr ""
26328
26329 #. type: =head2
26330 #: ../src/guestfs-actions.pod:4546
26331 msgid "guestfs_mkdir"
26332 msgstr ""
26333
26334 #. type: verbatim
26335 #: ../src/guestfs-actions.pod:4548
26336 #, no-wrap
26337 msgid ""
26338 " int\n"
26339 " guestfs_mkdir (guestfs_h *g,\n"
26340 "                const char *path);\n"
26341 "\n"
26342 msgstr ""
26343
26344 #. type: =head2
26345 #: ../src/guestfs-actions.pod:4558
26346 msgid "guestfs_mkdir_mode"
26347 msgstr ""
26348
26349 #. type: verbatim
26350 #: ../src/guestfs-actions.pod:4560
26351 #, no-wrap
26352 msgid ""
26353 " int\n"
26354 " guestfs_mkdir_mode (guestfs_h *g,\n"
26355 "                     const char *path,\n"
26356 "                     int mode);\n"
26357 "\n"
26358 msgstr ""
26359
26360 #. type: textblock
26361 #: ../src/guestfs-actions.pod:4572
26362 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
26363 msgstr ""
26364
26365 #. type: =head2
26366 #: ../src/guestfs-actions.pod:4578
26367 msgid "guestfs_mkdir_p"
26368 msgstr ""
26369
26370 #. type: verbatim
26371 #: ../src/guestfs-actions.pod:4580
26372 #, no-wrap
26373 msgid ""
26374 " int\n"
26375 " guestfs_mkdir_p (guestfs_h *g,\n"
26376 "                  const char *path);\n"
26377 "\n"
26378 msgstr ""
26379
26380 #. type: =head2
26381 #: ../src/guestfs-actions.pod:4591
26382 msgid "guestfs_mkdtemp"
26383 msgstr ""
26384
26385 #. type: verbatim
26386 #: ../src/guestfs-actions.pod:4593
26387 #, no-wrap
26388 msgid ""
26389 " char *\n"
26390 " guestfs_mkdtemp (guestfs_h *g,\n"
26391 "                  const char *template);\n"
26392 "\n"
26393 msgstr ""
26394
26395 #. type: =head2
26396 #: ../src/guestfs-actions.pod:4621
26397 msgid "guestfs_mke2fs_J"
26398 msgstr ""
26399
26400 #. type: verbatim
26401 #: ../src/guestfs-actions.pod:4623
26402 #, no-wrap
26403 msgid ""
26404 " int\n"
26405 " guestfs_mke2fs_J (guestfs_h *g,\n"
26406 "                   const char *fstype,\n"
26407 "                   int blocksize,\n"
26408 "                   const char *device,\n"
26409 "                   const char *journal);\n"
26410 "\n"
26411 msgstr ""
26412
26413 #. type: textblock
26414 #: ../src/guestfs-actions.pod:4636
26415 msgid "See also C<guestfs_mke2journal>."
26416 msgstr ""
26417
26418 #. type: textblock
26419 #: ../src/guestfs-actions.pod:4640 ../src/guestfs-actions.pod:4658 ../src/guestfs-actions.pod:4676 ../src/guestfs-actions.pod:4692 ../src/guestfs-actions.pod:4706 ../src/guestfs-actions.pod:4720 ../src/guestfs-actions.pod:4779 ../src/guestfs-actions.pod:5056
26420 msgid "(Added in 1.0.68)"
26421 msgstr ""
26422
26423 #. type: =head2
26424 #: ../src/guestfs-actions.pod:4642
26425 msgid "guestfs_mke2fs_JL"
26426 msgstr ""
26427
26428 #. type: verbatim
26429 #: ../src/guestfs-actions.pod:4644
26430 #, no-wrap
26431 msgid ""
26432 " int\n"
26433 " guestfs_mke2fs_JL (guestfs_h *g,\n"
26434 "                    const char *fstype,\n"
26435 "                    int blocksize,\n"
26436 "                    const char *device,\n"
26437 "                    const char *label);\n"
26438 "\n"
26439 msgstr ""
26440
26441 #. type: textblock
26442 #: ../src/guestfs-actions.pod:4654
26443 msgid "See also C<guestfs_mke2journal_L>."
26444 msgstr ""
26445
26446 #. type: =head2
26447 #: ../src/guestfs-actions.pod:4660
26448 msgid "guestfs_mke2fs_JU"
26449 msgstr ""
26450
26451 #. type: verbatim
26452 #: ../src/guestfs-actions.pod:4662
26453 #, no-wrap
26454 msgid ""
26455 " int\n"
26456 " guestfs_mke2fs_JU (guestfs_h *g,\n"
26457 "                    const char *fstype,\n"
26458 "                    int blocksize,\n"
26459 "                    const char *device,\n"
26460 "                    const char *uuid);\n"
26461 "\n"
26462 msgstr ""
26463
26464 #. type: textblock
26465 #: ../src/guestfs-actions.pod:4672
26466 msgid "See also C<guestfs_mke2journal_U>."
26467 msgstr ""
26468
26469 #. type: =head2
26470 #: ../src/guestfs-actions.pod:4678
26471 msgid "guestfs_mke2journal"
26472 msgstr ""
26473
26474 #. type: verbatim
26475 #: ../src/guestfs-actions.pod:4680
26476 #, no-wrap
26477 msgid ""
26478 " int\n"
26479 " guestfs_mke2journal (guestfs_h *g,\n"
26480 "                      int blocksize,\n"
26481 "                      const char *device);\n"
26482 "\n"
26483 msgstr ""
26484
26485 #. type: =head2
26486 #: ../src/guestfs-actions.pod:4694
26487 msgid "guestfs_mke2journal_L"
26488 msgstr ""
26489
26490 #. type: verbatim
26491 #: ../src/guestfs-actions.pod:4696
26492 #, no-wrap
26493 msgid ""
26494 " int\n"
26495 " guestfs_mke2journal_L (guestfs_h *g,\n"
26496 "                        int blocksize,\n"
26497 "                        const char *label,\n"
26498 "                        const char *device);\n"
26499 "\n"
26500 msgstr ""
26501
26502 #. type: =head2
26503 #: ../src/guestfs-actions.pod:4708
26504 msgid "guestfs_mke2journal_U"
26505 msgstr ""
26506
26507 #. type: verbatim
26508 #: ../src/guestfs-actions.pod:4710
26509 #, no-wrap
26510 msgid ""
26511 " int\n"
26512 " guestfs_mke2journal_U (guestfs_h *g,\n"
26513 "                        int blocksize,\n"
26514 "                        const char *uuid,\n"
26515 "                        const char *device);\n"
26516 "\n"
26517 msgstr ""
26518
26519 #. type: =head2
26520 #: ../src/guestfs-actions.pod:4722
26521 msgid "guestfs_mkfifo"
26522 msgstr ""
26523
26524 #. type: verbatim
26525 #: ../src/guestfs-actions.pod:4724
26526 #, no-wrap
26527 msgid ""
26528 " int\n"
26529 " guestfs_mkfifo (guestfs_h *g,\n"
26530 "                 int mode,\n"
26531 "                 const char *path);\n"
26532 "\n"
26533 msgstr ""
26534
26535 #. type: textblock
26536 #: ../src/guestfs-actions.pod:4729
26537 msgid ""
26538 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>.  It "
26539 "is just a convenient wrapper around C<guestfs_mknod>."
26540 msgstr ""
26541
26542 #. type: =head2
26543 #: ../src/guestfs-actions.pod:4739
26544 msgid "guestfs_mkfs"
26545 msgstr ""
26546
26547 #. type: verbatim
26548 #: ../src/guestfs-actions.pod:4741
26549 #, no-wrap
26550 msgid ""
26551 " int\n"
26552 " guestfs_mkfs (guestfs_h *g,\n"
26553 "               const char *fstype,\n"
26554 "               const char *device);\n"
26555 "\n"
26556 msgstr ""
26557
26558 #. type: =head2
26559 #: ../src/guestfs-actions.pod:4754
26560 msgid "guestfs_mkfs_b"
26561 msgstr ""
26562
26563 #. type: verbatim
26564 #: ../src/guestfs-actions.pod:4756
26565 #, no-wrap
26566 msgid ""
26567 " int\n"
26568 " guestfs_mkfs_b (guestfs_h *g,\n"
26569 "                 const char *fstype,\n"
26570 "                 int blocksize,\n"
26571 "                 const char *device);\n"
26572 "\n"
26573 msgstr ""
26574
26575 #. type: textblock
26576 #: ../src/guestfs-actions.pod:4762
26577 msgid ""
26578 "I<This function is deprecated.> In new code, use the L</guestfs_mkfs_opts> "
26579 "call instead."
26580 msgstr ""
26581
26582 #. type: textblock
26583 #: ../src/guestfs-actions.pod:4769
26584 msgid ""
26585 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
26586 "block size of the resulting filesystem.  Supported block sizes depend on the "
26587 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
26588 msgstr ""
26589
26590 #. type: =head2
26591 #: ../src/guestfs-actions.pod:4781
26592 msgid "guestfs_mkfs_opts"
26593 msgstr ""
26594
26595 #. type: verbatim
26596 #: ../src/guestfs-actions.pod:4783
26597 #, no-wrap
26598 msgid ""
26599 " int\n"
26600 " guestfs_mkfs_opts (guestfs_h *g,\n"
26601 "                    const char *fstype,\n"
26602 "                    const char *device,\n"
26603 "                    ...);\n"
26604 "\n"
26605 msgstr ""
26606
26607 #. type: verbatim
26608 #: ../src/guestfs-actions.pod:4794
26609 #, no-wrap
26610 msgid ""
26611 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
26612 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
26613 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
26614 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
26615 "\n"
26616 msgstr ""
26617
26618 #. type: textblock
26619 #: ../src/guestfs-actions.pod:4842
26620 msgid "(Added in 1.7.19)"
26621 msgstr ""
26622
26623 #. type: =head2
26624 #: ../src/guestfs-actions.pod:4844
26625 msgid "guestfs_mkfs_opts_va"
26626 msgstr ""
26627
26628 #. type: verbatim
26629 #: ../src/guestfs-actions.pod:4846
26630 #, no-wrap
26631 msgid ""
26632 " int\n"
26633 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
26634 "                       const char *fstype,\n"
26635 "                       const char *device,\n"
26636 "                       va_list args);\n"
26637 "\n"
26638 msgstr ""
26639
26640 #. type: textblock
26641 #: ../src/guestfs-actions.pod:4852
26642 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
26643 msgstr ""
26644
26645 #. type: =head2
26646 #: ../src/guestfs-actions.pod:4856
26647 msgid "guestfs_mkfs_opts_argv"
26648 msgstr ""
26649
26650 #. type: verbatim
26651 #: ../src/guestfs-actions.pod:4858
26652 #, no-wrap
26653 msgid ""
26654 " int\n"
26655 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
26656 "                         const char *fstype,\n"
26657 "                         const char *device,\n"
26658 "                         const struct guestfs_mkfs_opts_argv *optargs);\n"
26659 "\n"
26660 msgstr ""
26661
26662 #. type: textblock
26663 #: ../src/guestfs-actions.pod:4864
26664 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
26665 msgstr ""
26666
26667 #. type: =head2
26668 #: ../src/guestfs-actions.pod:4868
26669 msgid "guestfs_mkmountpoint"
26670 msgstr ""
26671
26672 #. type: verbatim
26673 #: ../src/guestfs-actions.pod:4870
26674 #, no-wrap
26675 msgid ""
26676 " int\n"
26677 " guestfs_mkmountpoint (guestfs_h *g,\n"
26678 "                       const char *exemptpath);\n"
26679 "\n"
26680 msgstr ""
26681
26682 #. type: textblock
26683 #: ../src/guestfs-actions.pod:4874
26684 msgid ""
26685 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
26686 "that can be used to create extra mountpoints before mounting the first "
26687 "filesystem."
26688 msgstr ""
26689
26690 #. type: textblock
26691 #: ../src/guestfs-actions.pod:4898
26692 msgid ""
26693 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>.  You "
26694 "may get unexpected errors if you try to mix these calls.  It is safest to "
26695 "manually unmount filesystems and remove mountpoints after use."
26696 msgstr ""
26697
26698 #. type: textblock
26699 #: ../src/guestfs-actions.pod:4902
26700 msgid ""
26701 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
26702 "first, so for this to work for manual mountpoints, you must ensure that the "
26703 "innermost mountpoints have the longest pathnames, as in the example code "
26704 "above."
26705 msgstr ""
26706
26707 #. type: textblock
26708 #: ../src/guestfs-actions.pod:4909
26709 msgid ""
26710 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
26711 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
26712 "can also trigger these issues."
26713 msgstr ""
26714
26715 #. type: textblock
26716 #: ../src/guestfs-actions.pod:4915 ../src/guestfs-actions.pod:5231 ../src/guestfs-actions.pod:6241
26717 msgid "(Added in 1.0.62)"
26718 msgstr ""
26719
26720 #. type: =head2
26721 #: ../src/guestfs-actions.pod:4917
26722 msgid "guestfs_mknod"
26723 msgstr ""
26724
26725 #. type: verbatim
26726 #: ../src/guestfs-actions.pod:4919
26727 #, no-wrap
26728 msgid ""
26729 " int\n"
26730 " guestfs_mknod (guestfs_h *g,\n"
26731 "                int mode,\n"
26732 "                int devmajor,\n"
26733 "                int devminor,\n"
26734 "                const char *path);\n"
26735 "\n"
26736 msgstr ""
26737
26738 #. type: textblock
26739 #: ../src/guestfs-actions.pod:4934
26740 msgid ""
26741 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
26742 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
26743 "regular file).  These constants are available in the standard Linux header "
26744 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
26745 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
26746 "the appropriate constant for you."
26747 msgstr ""
26748
26749 #. type: =head2
26750 #: ../src/guestfs-actions.pod:4948
26751 msgid "guestfs_mknod_b"
26752 msgstr ""
26753
26754 #. type: verbatim
26755 #: ../src/guestfs-actions.pod:4950
26756 #, no-wrap
26757 msgid ""
26758 " int\n"
26759 " guestfs_mknod_b (guestfs_h *g,\n"
26760 "                  int mode,\n"
26761 "                  int devmajor,\n"
26762 "                  int devminor,\n"
26763 "                  const char *path);\n"
26764 "\n"
26765 msgstr ""
26766
26767 #. type: textblock
26768 #: ../src/guestfs-actions.pod:4957
26769 msgid ""
26770 "This call creates a block device node called C<path> with mode C<mode> and "
26771 "device major/minor C<devmajor> and C<devminor>.  It is just a convenient "
26772 "wrapper around C<guestfs_mknod>."
26773 msgstr ""
26774
26775 #. type: =head2
26776 #: ../src/guestfs-actions.pod:4967
26777 msgid "guestfs_mknod_c"
26778 msgstr ""
26779
26780 #. type: verbatim
26781 #: ../src/guestfs-actions.pod:4969
26782 #, no-wrap
26783 msgid ""
26784 " int\n"
26785 " guestfs_mknod_c (guestfs_h *g,\n"
26786 "                  int mode,\n"
26787 "                  int devmajor,\n"
26788 "                  int devminor,\n"
26789 "                  const char *path);\n"
26790 "\n"
26791 msgstr ""
26792
26793 #. type: textblock
26794 #: ../src/guestfs-actions.pod:4976
26795 msgid ""
26796 "This call creates a char device node called C<path> with mode C<mode> and "
26797 "device major/minor C<devmajor> and C<devminor>.  It is just a convenient "
26798 "wrapper around C<guestfs_mknod>."
26799 msgstr ""
26800
26801 #. type: =head2
26802 #: ../src/guestfs-actions.pod:4986
26803 msgid "guestfs_mkswap"
26804 msgstr ""
26805
26806 #. type: verbatim
26807 #: ../src/guestfs-actions.pod:4988
26808 #, no-wrap
26809 msgid ""
26810 " int\n"
26811 " guestfs_mkswap (guestfs_h *g,\n"
26812 "                 const char *device);\n"
26813 "\n"
26814 msgstr ""
26815
26816 #. type: =head2
26817 #: ../src/guestfs-actions.pod:4998
26818 msgid "guestfs_mkswap_L"
26819 msgstr ""
26820
26821 #. type: verbatim
26822 #: ../src/guestfs-actions.pod:5000
26823 #, no-wrap
26824 msgid ""
26825 " int\n"
26826 " guestfs_mkswap_L (guestfs_h *g,\n"
26827 "                   const char *label,\n"
26828 "                   const char *device);\n"
26829 "\n"
26830 msgstr ""
26831
26832 #. type: =head2
26833 #: ../src/guestfs-actions.pod:5015
26834 msgid "guestfs_mkswap_U"
26835 msgstr ""
26836
26837 #. type: verbatim
26838 #: ../src/guestfs-actions.pod:5017
26839 #, no-wrap
26840 msgid ""
26841 " int\n"
26842 " guestfs_mkswap_U (guestfs_h *g,\n"
26843 "                   const char *uuid,\n"
26844 "                   const char *device);\n"
26845 "\n"
26846 msgstr ""
26847
26848 #. type: =head2
26849 #: ../src/guestfs-actions.pod:5028
26850 msgid "guestfs_mkswap_file"
26851 msgstr ""
26852
26853 #. type: verbatim
26854 #: ../src/guestfs-actions.pod:5030
26855 #, no-wrap
26856 msgid ""
26857 " int\n"
26858 " guestfs_mkswap_file (guestfs_h *g,\n"
26859 "                      const char *path);\n"
26860 "\n"
26861 msgstr ""
26862
26863 #. type: textblock
26864 #: ../src/guestfs-actions.pod:5036
26865 msgid ""
26866 "This command just writes a swap file signature to an existing file.  To "
26867 "create the file itself, use something like C<guestfs_fallocate>."
26868 msgstr ""
26869
26870 #. type: =head2
26871 #: ../src/guestfs-actions.pod:5043
26872 msgid "guestfs_modprobe"
26873 msgstr ""
26874
26875 #. type: verbatim
26876 #: ../src/guestfs-actions.pod:5045
26877 #, no-wrap
26878 msgid ""
26879 " int\n"
26880 " guestfs_modprobe (guestfs_h *g,\n"
26881 "                   const char *modulename);\n"
26882 "\n"
26883 msgstr ""
26884
26885 #. type: =head2
26886 #: ../src/guestfs-actions.pod:5058
26887 msgid "guestfs_mount"
26888 msgstr ""
26889
26890 #. type: verbatim
26891 #: ../src/guestfs-actions.pod:5060
26892 #, no-wrap
26893 msgid ""
26894 " int\n"
26895 " guestfs_mount (guestfs_h *g,\n"
26896 "                const char *device,\n"
26897 "                const char *mountpoint);\n"
26898 "\n"
26899 msgstr ""
26900
26901 #. type: textblock
26902 #: ../src/guestfs-actions.pod:5065
26903 msgid ""
26904 "I<This function is deprecated.> In new code, use the "
26905 "L</guestfs_mount_options> call instead."
26906 msgstr ""
26907
26908 #. type: textblock
26909 #: ../src/guestfs-actions.pod:5086
26910 msgid ""
26911 "B<Important note:> When you use this call, the filesystem options C<sync> "
26912 "and C<noatime> are set implicitly.  This was originally done because we "
26913 "thought it would improve reliability, but it turns out that I<-o sync> has a "
26914 "very large negative performance impact and negligible effect on "
26915 "reliability.  Therefore we recommend that you avoid using C<guestfs_mount> "
26916 "in any code that needs performance, and instead use C<guestfs_mount_options> "
26917 "(use an empty string for the first parameter if you don't want any options)."
26918 msgstr ""
26919
26920 #. type: =head2
26921 #: ../src/guestfs-actions.pod:5100
26922 msgid "guestfs_mount_9p"
26923 msgstr ""
26924
26925 #. type: verbatim
26926 #: ../src/guestfs-actions.pod:5102
26927 #, no-wrap
26928 msgid ""
26929 " int\n"
26930 " guestfs_mount_9p (guestfs_h *g,\n"
26931 "                   const char *mounttag,\n"
26932 "                   const char *mountpoint,\n"
26933 "                   ...);\n"
26934 "\n"
26935 msgstr ""
26936
26937 #. type: verbatim
26938 #: ../src/guestfs-actions.pod:5113
26939 #, no-wrap
26940 msgid ""
26941 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
26942 "\n"
26943 msgstr ""
26944
26945 #. type: =head2
26946 #: ../src/guestfs-actions.pod:5126
26947 msgid "guestfs_mount_9p_va"
26948 msgstr ""
26949
26950 #. type: verbatim
26951 #: ../src/guestfs-actions.pod:5128
26952 #, no-wrap
26953 msgid ""
26954 " int\n"
26955 " guestfs_mount_9p_va (guestfs_h *g,\n"
26956 "                      const char *mounttag,\n"
26957 "                      const char *mountpoint,\n"
26958 "                      va_list args);\n"
26959 "\n"
26960 msgstr ""
26961
26962 #. type: textblock
26963 #: ../src/guestfs-actions.pod:5134
26964 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
26965 msgstr ""
26966
26967 #. type: =head2
26968 #: ../src/guestfs-actions.pod:5138
26969 msgid "guestfs_mount_9p_argv"
26970 msgstr ""
26971
26972 #. type: verbatim
26973 #: ../src/guestfs-actions.pod:5140
26974 #, no-wrap
26975 msgid ""
26976 " int\n"
26977 " guestfs_mount_9p_argv (guestfs_h *g,\n"
26978 "                        const char *mounttag,\n"
26979 "                        const char *mountpoint,\n"
26980 "                        const struct guestfs_mount_9p_argv *optargs);\n"
26981 "\n"
26982 msgstr ""
26983
26984 #. type: textblock
26985 #: ../src/guestfs-actions.pod:5146
26986 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
26987 msgstr ""
26988
26989 #. type: =head2
26990 #: ../src/guestfs-actions.pod:5150
26991 msgid "guestfs_mount_loop"
26992 msgstr ""
26993
26994 #. type: verbatim
26995 #: ../src/guestfs-actions.pod:5152
26996 #, no-wrap
26997 msgid ""
26998 " int\n"
26999 " guestfs_mount_loop (guestfs_h *g,\n"
27000 "                     const char *file,\n"
27001 "                     const char *mountpoint);\n"
27002 "\n"
27003 msgstr ""
27004
27005 #. type: =head2
27006 #: ../src/guestfs-actions.pod:5165
27007 msgid "guestfs_mount_options"
27008 msgstr ""
27009
27010 #. type: verbatim
27011 #: ../src/guestfs-actions.pod:5167
27012 #, no-wrap
27013 msgid ""
27014 " int\n"
27015 " guestfs_mount_options (guestfs_h *g,\n"
27016 "                        const char *options,\n"
27017 "                        const char *device,\n"
27018 "                        const char *mountpoint);\n"
27019 "\n"
27020 msgstr ""
27021
27022 #. type: textblock
27023 #: ../src/guestfs-actions.pod:5173
27024 msgid ""
27025 "This is the same as the C<guestfs_mount> command, but it allows you to set "
27026 "the mount options as for the L<mount(8)> I<-o> flag."
27027 msgstr ""
27028
27029 #. type: textblock
27030 #: ../src/guestfs-actions.pod:5183 ../src/guestfs-actions.pod:5197 ../src/guestfs-actions.pod:5214
27031 msgid "(Added in 1.0.10)"
27032 msgstr ""
27033
27034 #. type: =head2
27035 #: ../src/guestfs-actions.pod:5185
27036 msgid "guestfs_mount_ro"
27037 msgstr ""
27038
27039 #. type: verbatim
27040 #: ../src/guestfs-actions.pod:5187
27041 #, no-wrap
27042 msgid ""
27043 " int\n"
27044 " guestfs_mount_ro (guestfs_h *g,\n"
27045 "                   const char *device,\n"
27046 "                   const char *mountpoint);\n"
27047 "\n"
27048 msgstr ""
27049
27050 #. type: textblock
27051 #: ../src/guestfs-actions.pod:5192
27052 msgid ""
27053 "This is the same as the C<guestfs_mount> command, but it mounts the "
27054 "filesystem with the read-only (I<-o ro>) flag."
27055 msgstr ""
27056
27057 #. type: =head2
27058 #: ../src/guestfs-actions.pod:5199
27059 msgid "guestfs_mount_vfs"
27060 msgstr ""
27061
27062 #. type: verbatim
27063 #: ../src/guestfs-actions.pod:5201
27064 #, no-wrap
27065 msgid ""
27066 " int\n"
27067 " guestfs_mount_vfs (guestfs_h *g,\n"
27068 "                    const char *options,\n"
27069 "                    const char *vfstype,\n"
27070 "                    const char *device,\n"
27071 "                    const char *mountpoint);\n"
27072 "\n"
27073 msgstr ""
27074
27075 #. type: textblock
27076 #: ../src/guestfs-actions.pod:5208
27077 msgid ""
27078 "This is the same as the C<guestfs_mount> command, but it allows you to set "
27079 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
27080 "I<-t> flags."
27081 msgstr ""
27082
27083 #. type: =head2
27084 #: ../src/guestfs-actions.pod:5216
27085 msgid "guestfs_mountpoints"
27086 msgstr ""
27087
27088 #. type: verbatim
27089 #: ../src/guestfs-actions.pod:5218
27090 #, no-wrap
27091 msgid ""
27092 " char **\n"
27093 " guestfs_mountpoints (guestfs_h *g);\n"
27094 "\n"
27095 msgstr ""
27096
27097 #. type: textblock
27098 #: ../src/guestfs-actions.pod:5221
27099 msgid ""
27100 "This call is similar to C<guestfs_mounts>.  That call returns a list of "
27101 "devices.  This one returns a hash table (map) of device name to directory "
27102 "where the device is mounted."
27103 msgstr ""
27104
27105 #. type: =head2
27106 #: ../src/guestfs-actions.pod:5233
27107 msgid "guestfs_mounts"
27108 msgstr ""
27109
27110 #. type: verbatim
27111 #: ../src/guestfs-actions.pod:5235
27112 #, no-wrap
27113 msgid ""
27114 " char **\n"
27115 " guestfs_mounts (guestfs_h *g);\n"
27116 "\n"
27117 msgstr ""
27118
27119 #. type: textblock
27120 #: ../src/guestfs-actions.pod:5243
27121 msgid "See also: C<guestfs_mountpoints>"
27122 msgstr ""
27123
27124 #. type: =head2
27125 #: ../src/guestfs-actions.pod:5251
27126 msgid "guestfs_mv"
27127 msgstr ""
27128
27129 #. type: verbatim
27130 #: ../src/guestfs-actions.pod:5253
27131 #, no-wrap
27132 msgid ""
27133 " int\n"
27134 " guestfs_mv (guestfs_h *g,\n"
27135 "             const char *src,\n"
27136 "             const char *dest);\n"
27137 "\n"
27138 msgstr ""
27139
27140 #. type: =head2
27141 #: ../src/guestfs-actions.pod:5265
27142 msgid "guestfs_ntfs_3g_probe"
27143 msgstr ""
27144
27145 #. type: verbatim
27146 #: ../src/guestfs-actions.pod:5267
27147 #, no-wrap
27148 msgid ""
27149 " int\n"
27150 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
27151 "                        int rw,\n"
27152 "                        const char *device);\n"
27153 "\n"
27154 msgstr ""
27155
27156 #. type: textblock
27157 #: ../src/guestfs-actions.pod:5286
27158 msgid "(Added in 1.0.43)"
27159 msgstr ""
27160
27161 #. type: =head2
27162 #: ../src/guestfs-actions.pod:5288
27163 msgid "guestfs_ntfsresize"
27164 msgstr ""
27165
27166 #. type: verbatim
27167 #: ../src/guestfs-actions.pod:5290
27168 #, no-wrap
27169 msgid ""
27170 " int\n"
27171 " guestfs_ntfsresize (guestfs_h *g,\n"
27172 "                     const char *device);\n"
27173 "\n"
27174 msgstr ""
27175
27176 #. type: textblock
27177 #: ../src/guestfs-actions.pod:5294 ../src/guestfs-actions.pod:5394
27178 msgid ""
27179 "I<This function is deprecated.> In new code, use the "
27180 "L</guestfs_ntfsresize_opts> call instead."
27181 msgstr ""
27182
27183 #. type: =head2
27184 #: ../src/guestfs-actions.pod:5318
27185 msgid "guestfs_ntfsresize_opts"
27186 msgstr ""
27187
27188 #. type: verbatim
27189 #: ../src/guestfs-actions.pod:5320
27190 #, no-wrap
27191 msgid ""
27192 " int\n"
27193 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
27194 "                          const char *device,\n"
27195 "                          ...);\n"
27196 "\n"
27197 msgstr ""
27198
27199 #. type: verbatim
27200 #: ../src/guestfs-actions.pod:5330
27201 #, no-wrap
27202 msgid ""
27203 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
27204 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
27205 "\n"
27206 msgstr ""
27207
27208 #. type: textblock
27209 #: ../src/guestfs-actions.pod:5350
27210 msgid ""
27211 "After the resize operation, the filesystem is always marked as requiring a "
27212 "consistency check (for safety).  You have to boot into Windows to perform "
27213 "this check and clear this condition.  If you I<don't> set the C<force> "
27214 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
27215 "times on a single filesystem without booting into Windows between each "
27216 "resize."
27217 msgstr ""
27218
27219 #. type: =head2
27220 #: ../src/guestfs-actions.pod:5365
27221 msgid "guestfs_ntfsresize_opts_va"
27222 msgstr ""
27223
27224 #. type: verbatim
27225 #: ../src/guestfs-actions.pod:5367
27226 #, no-wrap
27227 msgid ""
27228 " int\n"
27229 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
27230 "                             const char *device,\n"
27231 "                             va_list args);\n"
27232 "\n"
27233 msgstr ""
27234
27235 #. type: textblock
27236 #: ../src/guestfs-actions.pod:5372
27237 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
27238 msgstr ""
27239
27240 #. type: =head2
27241 #: ../src/guestfs-actions.pod:5376
27242 msgid "guestfs_ntfsresize_opts_argv"
27243 msgstr ""
27244
27245 #. type: verbatim
27246 #: ../src/guestfs-actions.pod:5378
27247 #, no-wrap
27248 msgid ""
27249 " int\n"
27250 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
27251 "                               const char *device,\n"
27252 "                               const struct guestfs_ntfsresize_opts_argv "
27253 "*optargs);\n"
27254 "\n"
27255 msgstr ""
27256
27257 #. type: textblock
27258 #: ../src/guestfs-actions.pod:5383
27259 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
27260 msgstr ""
27261
27262 #. type: =head2
27263 #: ../src/guestfs-actions.pod:5387
27264 msgid "guestfs_ntfsresize_size"
27265 msgstr ""
27266
27267 #. type: verbatim
27268 #: ../src/guestfs-actions.pod:5389
27269 #, no-wrap
27270 msgid ""
27271 " int\n"
27272 " guestfs_ntfsresize_size (guestfs_h *g,\n"
27273 "                          const char *device,\n"
27274 "                          int64_t size);\n"
27275 "\n"
27276 msgstr ""
27277
27278 #. type: textblock
27279 #: ../src/guestfs-actions.pod:5401
27280 msgid ""
27281 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
27282 "to specify the new size (in bytes) explicitly."
27283 msgstr ""
27284
27285 #. type: textblock
27286 #: ../src/guestfs-actions.pod:5406 ../src/guestfs-actions.pod:5848 ../src/guestfs-actions.pod:5921 ../src/guestfs-actions.pod:6189 ../src/guestfs-actions.pod:7826
27287 msgid "(Added in 1.3.14)"
27288 msgstr ""
27289
27290 #. type: =head2
27291 #: ../src/guestfs-actions.pod:5408
27292 msgid "guestfs_part_add"
27293 msgstr ""
27294
27295 #. type: verbatim
27296 #: ../src/guestfs-actions.pod:5410
27297 #, no-wrap
27298 msgid ""
27299 " int\n"
27300 " guestfs_part_add (guestfs_h *g,\n"
27301 "                   const char *device,\n"
27302 "                   const char *prlogex,\n"
27303 "                   int64_t startsect,\n"
27304 "                   int64_t endsect);\n"
27305 "\n"
27306 msgstr ""
27307
27308 #. type: textblock
27309 #: ../src/guestfs-actions.pod:5417
27310 msgid ""
27311 "This command adds a partition to C<device>.  If there is no partition table "
27312 "on the device, call C<guestfs_part_init> first."
27313 msgstr ""
27314
27315 #. type: textblock
27316 #: ../src/guestfs-actions.pod:5429
27317 msgid ""
27318 "Creating a partition which covers the whole disk is not so easy.  Use "
27319 "C<guestfs_part_disk> to do that."
27320 msgstr ""
27321
27322 #. type: textblock
27323 #: ../src/guestfs-actions.pod:5434 ../src/guestfs-actions.pod:5472 ../src/guestfs-actions.pod:5525 ../src/guestfs-actions.pod:5609 ../src/guestfs-actions.pod:5647 ../src/guestfs-actions.pod:5666 ../src/guestfs-actions.pod:5706
27324 msgid "(Added in 1.0.78)"
27325 msgstr ""
27326
27327 #. type: =head2
27328 #: ../src/guestfs-actions.pod:5436
27329 msgid "guestfs_part_del"
27330 msgstr ""
27331
27332 #. type: verbatim
27333 #: ../src/guestfs-actions.pod:5438
27334 #, no-wrap
27335 msgid ""
27336 " int\n"
27337 " guestfs_part_del (guestfs_h *g,\n"
27338 "                   const char *device,\n"
27339 "                   int partnum);\n"
27340 "\n"
27341 msgstr ""
27342
27343 #. type: =head2
27344 #: ../src/guestfs-actions.pod:5453
27345 msgid "guestfs_part_disk"
27346 msgstr ""
27347
27348 #. type: verbatim
27349 #: ../src/guestfs-actions.pod:5455
27350 #, no-wrap
27351 msgid ""
27352 " int\n"
27353 " guestfs_part_disk (guestfs_h *g,\n"
27354 "                    const char *device,\n"
27355 "                    const char *parttype);\n"
27356 "\n"
27357 msgstr ""
27358
27359 #. type: textblock
27360 #: ../src/guestfs-actions.pod:5460
27361 msgid ""
27362 "This command is simply a combination of C<guestfs_part_init> followed by "
27363 "C<guestfs_part_add> to create a single primary partition covering the whole "
27364 "disk."
27365 msgstr ""
27366
27367 #. type: textblock
27368 #: ../src/guestfs-actions.pod:5464
27369 msgid ""
27370 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
27371 "possible values are described in C<guestfs_part_init>."
27372 msgstr ""
27373
27374 #. type: =head2
27375 #: ../src/guestfs-actions.pod:5474
27376 msgid "guestfs_part_get_bootable"
27377 msgstr ""
27378
27379 #. type: verbatim
27380 #: ../src/guestfs-actions.pod:5476
27381 #, no-wrap
27382 msgid ""
27383 " int\n"
27384 " guestfs_part_get_bootable (guestfs_h *g,\n"
27385 "                            const char *device,\n"
27386 "                            int partnum);\n"
27387 "\n"
27388 msgstr ""
27389
27390 #. type: textblock
27391 #: ../src/guestfs-actions.pod:5484
27392 msgid "See also C<guestfs_part_set_bootable>."
27393 msgstr ""
27394
27395 #. type: =head2
27396 #: ../src/guestfs-actions.pod:5490
27397 msgid "guestfs_part_get_mbr_id"
27398 msgstr ""
27399
27400 #. type: verbatim
27401 #: ../src/guestfs-actions.pod:5492
27402 #, no-wrap
27403 msgid ""
27404 " int\n"
27405 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
27406 "                          const char *device,\n"
27407 "                          int partnum);\n"
27408 "\n"
27409 msgstr ""
27410
27411 #. type: textblock
27412 #: ../src/guestfs-actions.pod:5500 ../src/guestfs-actions.pod:5682
27413 msgid ""
27414 "Note that only MBR (old DOS-style) partitions have type bytes.  You will get "
27415 "undefined results for other partition table types (see "
27416 "C<guestfs_part_get_parttype>)."
27417 msgstr ""
27418
27419 #. type: =head2
27420 #: ../src/guestfs-actions.pod:5508
27421 msgid "guestfs_part_get_parttype"
27422 msgstr ""
27423
27424 #. type: verbatim
27425 #: ../src/guestfs-actions.pod:5510
27426 #, no-wrap
27427 msgid ""
27428 " char *\n"
27429 " guestfs_part_get_parttype (guestfs_h *g,\n"
27430 "                            const char *device);\n"
27431 "\n"
27432 msgstr ""
27433
27434 #. type: textblock
27435 #: ../src/guestfs-actions.pod:5517
27436 msgid ""
27437 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
27438 "table), C<gpt> (a GPT/EFI-style partition table).  Other values are "
27439 "possible, although unusual.  See C<guestfs_part_init> for a full list."
27440 msgstr ""
27441
27442 #. type: =head2
27443 #: ../src/guestfs-actions.pod:5527
27444 msgid "guestfs_part_init"
27445 msgstr ""
27446
27447 #. type: verbatim
27448 #: ../src/guestfs-actions.pod:5529
27449 #, no-wrap
27450 msgid ""
27451 " int\n"
27452 " guestfs_part_init (guestfs_h *g,\n"
27453 "                    const char *device,\n"
27454 "                    const char *parttype);\n"
27455 "\n"
27456 msgstr ""
27457
27458 #. type: textblock
27459 #: ../src/guestfs-actions.pod:5538
27460 msgid ""
27461 "Initially there are no partitions.  Following this, you should call "
27462 "C<guestfs_part_add> for each partition required."
27463 msgstr ""
27464
27465 #. type: =head2
27466 #: ../src/guestfs-actions.pod:5611
27467 msgid "guestfs_part_list"
27468 msgstr ""
27469
27470 #. type: verbatim
27471 #: ../src/guestfs-actions.pod:5613
27472 #, no-wrap
27473 msgid ""
27474 " struct guestfs_partition_list *\n"
27475 " guestfs_part_list (guestfs_h *g,\n"
27476 "                    const char *device);\n"
27477 "\n"
27478 msgstr ""
27479
27480 #. type: textblock
27481 #: ../src/guestfs-actions.pod:5630
27482 msgid ""
27483 "Start of the partition I<in bytes>.  To get sectors you have to divide by "
27484 "the device's sector size, see C<guestfs_blockdev_getss>."
27485 msgstr ""
27486
27487 #. type: textblock
27488 #: ../src/guestfs-actions.pod:5643
27489 msgid ""
27490 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
27491 "was an error.  I<The caller must call C<guestfs_free_partition_list> after "
27492 "use>."
27493 msgstr ""
27494
27495 #. type: =head2
27496 #: ../src/guestfs-actions.pod:5649
27497 msgid "guestfs_part_set_bootable"
27498 msgstr ""
27499
27500 #. type: verbatim
27501 #: ../src/guestfs-actions.pod:5651
27502 #, no-wrap
27503 msgid ""
27504 " int\n"
27505 " guestfs_part_set_bootable (guestfs_h *g,\n"
27506 "                            const char *device,\n"
27507 "                            int partnum,\n"
27508 "                            int bootable);\n"
27509 "\n"
27510 msgstr ""
27511
27512 #. type: =head2
27513 #: ../src/guestfs-actions.pod:5668
27514 msgid "guestfs_part_set_mbr_id"
27515 msgstr ""
27516
27517 #. type: verbatim
27518 #: ../src/guestfs-actions.pod:5670
27519 #, no-wrap
27520 msgid ""
27521 " int\n"
27522 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
27523 "                          const char *device,\n"
27524 "                          int partnum,\n"
27525 "                          int idbyte);\n"
27526 "\n"
27527 msgstr ""
27528
27529 #. type: =head2
27530 #: ../src/guestfs-actions.pod:5690
27531 msgid "guestfs_part_set_name"
27532 msgstr ""
27533
27534 #. type: verbatim
27535 #: ../src/guestfs-actions.pod:5692
27536 #, no-wrap
27537 msgid ""
27538 " int\n"
27539 " guestfs_part_set_name (guestfs_h *g,\n"
27540 "                        const char *device,\n"
27541 "                        int partnum,\n"
27542 "                        const char *name);\n"
27543 "\n"
27544 msgstr ""
27545
27546 #. type: =head2
27547 #: ../src/guestfs-actions.pod:5708
27548 msgid "guestfs_part_to_dev"
27549 msgstr ""
27550
27551 #. type: verbatim
27552 #: ../src/guestfs-actions.pod:5710
27553 #, no-wrap
27554 msgid ""
27555 " char *\n"
27556 " guestfs_part_to_dev (guestfs_h *g,\n"
27557 "                      const char *partition);\n"
27558 "\n"
27559 msgstr ""
27560
27561 #. type: textblock
27562 #: ../src/guestfs-actions.pod:5718
27563 msgid ""
27564 "The named partition must exist, for example as a string returned from "
27565 "C<guestfs_list_partitions>."
27566 msgstr ""
27567
27568 #. type: =head2
27569 #: ../src/guestfs-actions.pod:5726
27570 msgid "guestfs_ping_daemon"
27571 msgstr ""
27572
27573 #. type: verbatim
27574 #: ../src/guestfs-actions.pod:5728
27575 #, no-wrap
27576 msgid ""
27577 " int\n"
27578 " guestfs_ping_daemon (guestfs_h *g);\n"
27579 "\n"
27580 msgstr ""
27581
27582 #. type: =head2
27583 #: ../src/guestfs-actions.pod:5740
27584 msgid "guestfs_pread"
27585 msgstr ""
27586
27587 #. type: verbatim
27588 #: ../src/guestfs-actions.pod:5742
27589 #, no-wrap
27590 msgid ""
27591 " char *\n"
27592 " guestfs_pread (guestfs_h *g,\n"
27593 "                const char *path,\n"
27594 "                int count,\n"
27595 "                int64_t offset,\n"
27596 "                size_t *size_r);\n"
27597 "\n"
27598 msgstr ""
27599
27600 #. type: textblock
27601 #: ../src/guestfs-actions.pod:5755
27602 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
27603 msgstr ""
27604
27605 #. type: =head2
27606 #: ../src/guestfs-actions.pod:5766
27607 msgid "guestfs_pread_device"
27608 msgstr ""
27609
27610 #. type: verbatim
27611 #: ../src/guestfs-actions.pod:5768
27612 #, no-wrap
27613 msgid ""
27614 " char *\n"
27615 " guestfs_pread_device (guestfs_h *g,\n"
27616 "                       const char *device,\n"
27617 "                       int count,\n"
27618 "                       int64_t offset,\n"
27619 "                       size_t *size_r);\n"
27620 "\n"
27621 msgstr ""
27622
27623 #. type: textblock
27624 #: ../src/guestfs-actions.pod:5781
27625 msgid "See also C<guestfs_pread>."
27626 msgstr ""
27627
27628 #. type: textblock
27629 #: ../src/guestfs-actions.pod:5790
27630 msgid "(Added in 1.5.21)"
27631 msgstr ""
27632
27633 #. type: =head2
27634 #: ../src/guestfs-actions.pod:5792
27635 msgid "guestfs_pvcreate"
27636 msgstr ""
27637
27638 #. type: verbatim
27639 #: ../src/guestfs-actions.pod:5794
27640 #, no-wrap
27641 msgid ""
27642 " int\n"
27643 " guestfs_pvcreate (guestfs_h *g,\n"
27644 "                   const char *device);\n"
27645 "\n"
27646 msgstr ""
27647
27648 #. type: =head2
27649 #: ../src/guestfs-actions.pod:5806
27650 msgid "guestfs_pvremove"
27651 msgstr ""
27652
27653 #. type: verbatim
27654 #: ../src/guestfs-actions.pod:5808
27655 #, no-wrap
27656 msgid ""
27657 " int\n"
27658 " guestfs_pvremove (guestfs_h *g,\n"
27659 "                   const char *device);\n"
27660 "\n"
27661 msgstr ""
27662
27663 #. type: =head2
27664 #: ../src/guestfs-actions.pod:5823
27665 msgid "guestfs_pvresize"
27666 msgstr ""
27667
27668 #. type: verbatim
27669 #: ../src/guestfs-actions.pod:5825
27670 #, no-wrap
27671 msgid ""
27672 " int\n"
27673 " guestfs_pvresize (guestfs_h *g,\n"
27674 "                   const char *device);\n"
27675 "\n"
27676 msgstr ""
27677
27678 #. type: =head2
27679 #: ../src/guestfs-actions.pod:5836
27680 msgid "guestfs_pvresize_size"
27681 msgstr ""
27682
27683 #. type: verbatim
27684 #: ../src/guestfs-actions.pod:5838
27685 #, no-wrap
27686 msgid ""
27687 " int\n"
27688 " guestfs_pvresize_size (guestfs_h *g,\n"
27689 "                        const char *device,\n"
27690 "                        int64_t size);\n"
27691 "\n"
27692 msgstr ""
27693
27694 #. type: textblock
27695 #: ../src/guestfs-actions.pod:5843
27696 msgid ""
27697 "This command is the same as C<guestfs_pvresize> except that it allows you to "
27698 "specify the new size (in bytes) explicitly."
27699 msgstr ""
27700
27701 #. type: =head2
27702 #: ../src/guestfs-actions.pod:5850
27703 msgid "guestfs_pvs"
27704 msgstr ""
27705
27706 #. type: verbatim
27707 #: ../src/guestfs-actions.pod:5852
27708 #, no-wrap
27709 msgid ""
27710 " char **\n"
27711 " guestfs_pvs (guestfs_h *g);\n"
27712 "\n"
27713 msgstr ""
27714
27715 #. type: textblock
27716 #: ../src/guestfs-actions.pod:5861
27717 msgid "See also C<guestfs_pvs_full>."
27718 msgstr ""
27719
27720 #. type: =head2
27721 #: ../src/guestfs-actions.pod:5869
27722 msgid "guestfs_pvs_full"
27723 msgstr ""
27724
27725 #. type: verbatim
27726 #: ../src/guestfs-actions.pod:5871
27727 #, no-wrap
27728 msgid ""
27729 " struct guestfs_lvm_pv_list *\n"
27730 " guestfs_pvs_full (guestfs_h *g);\n"
27731 "\n"
27732 msgstr ""
27733
27734 #. type: textblock
27735 #: ../src/guestfs-actions.pod:5877
27736 msgid ""
27737 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
27738 "was an error.  I<The caller must call C<guestfs_free_lvm_pv_list> after "
27739 "use>."
27740 msgstr ""
27741
27742 #. type: =head2
27743 #: ../src/guestfs-actions.pod:5883
27744 msgid "guestfs_pvuuid"
27745 msgstr ""
27746
27747 #. type: verbatim
27748 #: ../src/guestfs-actions.pod:5885
27749 #, no-wrap
27750 msgid ""
27751 " char *\n"
27752 " guestfs_pvuuid (guestfs_h *g,\n"
27753 "                 const char *device);\n"
27754 "\n"
27755 msgstr ""
27756
27757 #. type: =head2
27758 #: ../src/guestfs-actions.pod:5896
27759 msgid "guestfs_pwrite"
27760 msgstr ""
27761
27762 #. type: verbatim
27763 #: ../src/guestfs-actions.pod:5898
27764 #, no-wrap
27765 msgid ""
27766 " int\n"
27767 " guestfs_pwrite (guestfs_h *g,\n"
27768 "                 const char *path,\n"
27769 "                 const char *content,\n"
27770 "                 size_t content_size,\n"
27771 "                 int64_t offset);\n"
27772 "\n"
27773 msgstr ""
27774
27775 #. type: textblock
27776 #: ../src/guestfs-actions.pod:5914
27777 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
27778 msgstr ""
27779
27780 #. type: =head2
27781 #: ../src/guestfs-actions.pod:5923
27782 msgid "guestfs_pwrite_device"
27783 msgstr ""
27784
27785 #. type: verbatim
27786 #: ../src/guestfs-actions.pod:5925
27787 #, no-wrap
27788 msgid ""
27789 " int\n"
27790 " guestfs_pwrite_device (guestfs_h *g,\n"
27791 "                        const char *device,\n"
27792 "                        const char *content,\n"
27793 "                        size_t content_size,\n"
27794 "                        int64_t offset);\n"
27795 "\n"
27796 msgstr ""
27797
27798 #. type: textblock
27799 #: ../src/guestfs-actions.pod:5940
27800 msgid "See also C<guestfs_pwrite>."
27801 msgstr ""
27802
27803 #. type: textblock
27804 #: ../src/guestfs-actions.pod:5947
27805 msgid "(Added in 1.5.20)"
27806 msgstr ""
27807
27808 #. type: =head2
27809 #: ../src/guestfs-actions.pod:5949
27810 msgid "guestfs_read_file"
27811 msgstr ""
27812
27813 #. type: verbatim
27814 #: ../src/guestfs-actions.pod:5951
27815 #, no-wrap
27816 msgid ""
27817 " char *\n"
27818 " guestfs_read_file (guestfs_h *g,\n"
27819 "                    const char *path,\n"
27820 "                    size_t *size_r);\n"
27821 "\n"
27822 msgstr ""
27823
27824 #. type: textblock
27825 #: ../src/guestfs-actions.pod:5959
27826 msgid ""
27827 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
27828 "embedded ASCII NUL characters.  However unlike C<guestfs_download>, this "
27829 "function is limited in the total size of file that can be handled."
27830 msgstr ""
27831
27832 #. type: textblock
27833 #: ../src/guestfs-actions.pod:5971
27834 msgid "(Added in 1.0.63)"
27835 msgstr ""
27836
27837 #. type: =head2
27838 #: ../src/guestfs-actions.pod:5973
27839 msgid "guestfs_read_lines"
27840 msgstr ""
27841
27842 #. type: verbatim
27843 #: ../src/guestfs-actions.pod:5975
27844 #, no-wrap
27845 msgid ""
27846 " char **\n"
27847 " guestfs_read_lines (guestfs_h *g,\n"
27848 "                     const char *path);\n"
27849 "\n"
27850 msgstr ""
27851
27852 #. type: textblock
27853 #: ../src/guestfs-actions.pod:5984
27854 msgid ""
27855 "Note that this function cannot correctly handle binary files (specifically, "
27856 "files containing C<\\0> character which is treated as end of line).  For "
27857 "those you need to use the C<guestfs_read_file> function which has a more "
27858 "complex interface."
27859 msgstr ""
27860
27861 #. type: =head2
27862 #: ../src/guestfs-actions.pod:5995
27863 msgid "guestfs_readdir"
27864 msgstr ""
27865
27866 #. type: verbatim
27867 #: ../src/guestfs-actions.pod:5997
27868 #, no-wrap
27869 msgid ""
27870 " struct guestfs_dirent_list *\n"
27871 " guestfs_readdir (guestfs_h *g,\n"
27872 "                  const char *dir);\n"
27873 "\n"
27874 msgstr ""
27875
27876 #. type: textblock
27877 #: ../src/guestfs-actions.pod:6051
27878 msgid ""
27879 "This function is primarily intended for use by programs.  To get a simple "
27880 "list of names, use C<guestfs_ls>.  To get a printable directory for human "
27881 "consumption, use C<guestfs_ll>."
27882 msgstr ""
27883
27884 #. type: textblock
27885 #: ../src/guestfs-actions.pod:6055
27886 msgid ""
27887 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
27888 "was an error.  I<The caller must call C<guestfs_free_dirent_list> after "
27889 "use>."
27890 msgstr ""
27891
27892 #. type: =head2
27893 #: ../src/guestfs-actions.pod:6061
27894 msgid "guestfs_readlink"
27895 msgstr ""
27896
27897 #. type: verbatim
27898 #: ../src/guestfs-actions.pod:6063
27899 #, no-wrap
27900 msgid ""
27901 " char *\n"
27902 " guestfs_readlink (guestfs_h *g,\n"
27903 "                   const char *path);\n"
27904 "\n"
27905 msgstr ""
27906
27907 #. type: =head2
27908 #: ../src/guestfs-actions.pod:6074
27909 msgid "guestfs_readlinklist"
27910 msgstr ""
27911
27912 #. type: verbatim
27913 #: ../src/guestfs-actions.pod:6076
27914 #, no-wrap
27915 msgid ""
27916 " char **\n"
27917 " guestfs_readlinklist (guestfs_h *g,\n"
27918 "                       const char *path,\n"
27919 "                       char *const *names);\n"
27920 "\n"
27921 msgstr ""
27922
27923 #. type: =head2
27924 #: ../src/guestfs-actions.pod:6109
27925 msgid "guestfs_realpath"
27926 msgstr ""
27927
27928 #. type: verbatim
27929 #: ../src/guestfs-actions.pod:6111
27930 #, no-wrap
27931 msgid ""
27932 " char *\n"
27933 " guestfs_realpath (guestfs_h *g,\n"
27934 "                   const char *path);\n"
27935 "\n"
27936 msgstr ""
27937
27938 #. type: =head2
27939 #: ../src/guestfs-actions.pod:6123
27940 msgid "guestfs_removexattr"
27941 msgstr ""
27942
27943 #. type: verbatim
27944 #: ../src/guestfs-actions.pod:6125
27945 #, no-wrap
27946 msgid ""
27947 " int\n"
27948 " guestfs_removexattr (guestfs_h *g,\n"
27949 "                      const char *xattr,\n"
27950 "                      const char *path);\n"
27951 "\n"
27952 msgstr ""
27953
27954 #. type: textblock
27955 #: ../src/guestfs-actions.pod:6133
27956 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
27957 msgstr ""
27958
27959 #. type: =head2
27960 #: ../src/guestfs-actions.pod:6139
27961 msgid "guestfs_resize2fs"
27962 msgstr ""
27963
27964 #. type: verbatim
27965 #: ../src/guestfs-actions.pod:6141
27966 #, no-wrap
27967 msgid ""
27968 " int\n"
27969 " guestfs_resize2fs (guestfs_h *g,\n"
27970 "                    const char *device);\n"
27971 "\n"
27972 msgstr ""
27973
27974 #. type: textblock
27975 #: ../src/guestfs-actions.pod:6148
27976 msgid ""
27977 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
27978 "C<device> before calling this command.  For unknown reasons C<resize2fs> "
27979 "sometimes gives an error about this and sometimes not.  In any case, it is "
27980 "always safe to call C<guestfs_e2fsck_f> before calling this function."
27981 msgstr ""
27982
27983 #. type: =head2
27984 #: ../src/guestfs-actions.pod:6158
27985 msgid "guestfs_resize2fs_M"
27986 msgstr ""
27987
27988 #. type: verbatim
27989 #: ../src/guestfs-actions.pod:6160
27990 #, no-wrap
27991 msgid ""
27992 " int\n"
27993 " guestfs_resize2fs_M (guestfs_h *g,\n"
27994 "                      const char *device);\n"
27995 "\n"
27996 msgstr ""
27997
27998 #. type: textblock
27999 #: ../src/guestfs-actions.pod:6164
28000 msgid ""
28001 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
28002 "resized to its minimum size.  This works like the I<-M> option to the "
28003 "C<resize2fs> command."
28004 msgstr ""
28005
28006 #. type: textblock
28007 #: ../src/guestfs-actions.pod:6168
28008 msgid ""
28009 "To get the resulting size of the filesystem you should call "
28010 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values.  "
28011 "These two numbers, multiplied together, give the resulting size of the "
28012 "minimal filesystem in bytes."
28013 msgstr ""
28014
28015 #. type: =head2
28016 #: ../src/guestfs-actions.pod:6177
28017 msgid "guestfs_resize2fs_size"
28018 msgstr ""
28019
28020 #. type: verbatim
28021 #: ../src/guestfs-actions.pod:6179
28022 #, no-wrap
28023 msgid ""
28024 " int\n"
28025 " guestfs_resize2fs_size (guestfs_h *g,\n"
28026 "                         const char *device,\n"
28027 "                         int64_t size);\n"
28028 "\n"
28029 msgstr ""
28030
28031 #. type: textblock
28032 #: ../src/guestfs-actions.pod:6184
28033 msgid ""
28034 "This command is the same as C<guestfs_resize2fs> except that it allows you "
28035 "to specify the new size (in bytes) explicitly."
28036 msgstr ""
28037
28038 #. type: =head2
28039 #: ../src/guestfs-actions.pod:6191
28040 msgid "guestfs_rm"
28041 msgstr ""
28042
28043 #. type: verbatim
28044 #: ../src/guestfs-actions.pod:6193
28045 #, no-wrap
28046 msgid ""
28047 " int\n"
28048 " guestfs_rm (guestfs_h *g,\n"
28049 "             const char *path);\n"
28050 "\n"
28051 msgstr ""
28052
28053 #. type: =head2
28054 #: ../src/guestfs-actions.pod:6203
28055 msgid "guestfs_rm_rf"
28056 msgstr ""
28057
28058 #. type: verbatim
28059 #: ../src/guestfs-actions.pod:6205
28060 #, no-wrap
28061 msgid ""
28062 " int\n"
28063 " guestfs_rm_rf (guestfs_h *g,\n"
28064 "                const char *path);\n"
28065 "\n"
28066 msgstr ""
28067
28068 #. type: =head2
28069 #: ../src/guestfs-actions.pod:6217
28070 msgid "guestfs_rmdir"
28071 msgstr ""
28072
28073 #. type: verbatim
28074 #: ../src/guestfs-actions.pod:6219
28075 #, no-wrap
28076 msgid ""
28077 " int\n"
28078 " guestfs_rmdir (guestfs_h *g,\n"
28079 "                const char *path);\n"
28080 "\n"
28081 msgstr ""
28082
28083 #. type: =head2
28084 #: ../src/guestfs-actions.pod:6229
28085 msgid "guestfs_rmmountpoint"
28086 msgstr ""
28087
28088 #. type: verbatim
28089 #: ../src/guestfs-actions.pod:6231
28090 #, no-wrap
28091 msgid ""
28092 " int\n"
28093 " guestfs_rmmountpoint (guestfs_h *g,\n"
28094 "                       const char *exemptpath);\n"
28095 "\n"
28096 msgstr ""
28097
28098 #. type: textblock
28099 #: ../src/guestfs-actions.pod:6235
28100 msgid ""
28101 "This calls removes a mountpoint that was previously created with "
28102 "C<guestfs_mkmountpoint>.  See C<guestfs_mkmountpoint> for full details."
28103 msgstr ""
28104
28105 #. type: =head2
28106 #: ../src/guestfs-actions.pod:6243
28107 msgid "guestfs_scrub_device"
28108 msgstr ""
28109
28110 #. type: verbatim
28111 #: ../src/guestfs-actions.pod:6245
28112 #, no-wrap
28113 msgid ""
28114 " int\n"
28115 " guestfs_scrub_device (guestfs_h *g,\n"
28116 "                       const char *device);\n"
28117 "\n"
28118 msgstr ""
28119
28120 #. type: textblock
28121 #: ../src/guestfs-actions.pod:6260 ../src/guestfs-actions.pod:6278 ../src/guestfs-actions.pod:6297
28122 msgid "(Added in 1.0.52)"
28123 msgstr ""
28124
28125 #. type: =head2
28126 #: ../src/guestfs-actions.pod:6262
28127 msgid "guestfs_scrub_file"
28128 msgstr ""
28129
28130 #. type: verbatim
28131 #: ../src/guestfs-actions.pod:6264
28132 #, no-wrap
28133 msgid ""
28134 " int\n"
28135 " guestfs_scrub_file (guestfs_h *g,\n"
28136 "                     const char *file);\n"
28137 "\n"
28138 msgstr ""
28139
28140 #. type: =head2
28141 #: ../src/guestfs-actions.pod:6280
28142 msgid "guestfs_scrub_freespace"
28143 msgstr ""
28144
28145 #. type: verbatim
28146 #: ../src/guestfs-actions.pod:6282
28147 #, no-wrap
28148 msgid ""
28149 " int\n"
28150 " guestfs_scrub_freespace (guestfs_h *g,\n"
28151 "                          const char *dir);\n"
28152 "\n"
28153 msgstr ""
28154
28155 #. type: textblock
28156 #: ../src/guestfs-actions.pod:6286
28157 msgid ""
28158 "This command creates the directory C<dir> and then fills it with files until "
28159 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
28160 "and deletes them.  The intention is to scrub any free space on the partition "
28161 "containing C<dir>."
28162 msgstr ""
28163
28164 #. type: =head2
28165 #: ../src/guestfs-actions.pod:6299
28166 msgid "guestfs_set_append"
28167 msgstr ""
28168
28169 #. type: verbatim
28170 #: ../src/guestfs-actions.pod:6301
28171 #, no-wrap
28172 msgid ""
28173 " int\n"
28174 " guestfs_set_append (guestfs_h *g,\n"
28175 "                     const char *append);\n"
28176 "\n"
28177 msgstr ""
28178
28179 #. type: =head2
28180 #: ../src/guestfs-actions.pod:6318
28181 msgid "guestfs_set_attach_method"
28182 msgstr ""
28183
28184 #. type: verbatim
28185 #: ../src/guestfs-actions.pod:6320
28186 #, no-wrap
28187 msgid ""
28188 " int\n"
28189 " guestfs_set_attach_method (guestfs_h *g,\n"
28190 "                            const char *attachmethod);\n"
28191 "\n"
28192 msgstr ""
28193
28194 #. type: =head2
28195 #: ../src/guestfs-actions.pod:6348
28196 msgid "guestfs_set_autosync"
28197 msgstr ""
28198
28199 #. type: verbatim
28200 #: ../src/guestfs-actions.pod:6350
28201 #, no-wrap
28202 msgid ""
28203 " int\n"
28204 " guestfs_set_autosync (guestfs_h *g,\n"
28205 "                       int autosync);\n"
28206 "\n"
28207 msgstr ""
28208
28209 #. type: =head2
28210 #: ../src/guestfs-actions.pod:6366
28211 msgid "guestfs_set_direct"
28212 msgstr ""
28213
28214 #. type: verbatim
28215 #: ../src/guestfs-actions.pod:6368
28216 #, no-wrap
28217 msgid ""
28218 " int\n"
28219 " guestfs_set_direct (guestfs_h *g,\n"
28220 "                     int direct);\n"
28221 "\n"
28222 msgstr ""
28223
28224 #. type: textblock
28225 #: ../src/guestfs-actions.pod:6376
28226 msgid ""
28227 "One consequence of this is that log messages aren't caught by the library "
28228 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
28229 "stdout."
28230 msgstr ""
28231
28232 #. type: =head2
28233 #: ../src/guestfs-actions.pod:6389
28234 msgid "guestfs_set_e2label"
28235 msgstr ""
28236
28237 #. type: verbatim
28238 #: ../src/guestfs-actions.pod:6391
28239 #, no-wrap
28240 msgid ""
28241 " int\n"
28242 " guestfs_set_e2label (guestfs_h *g,\n"
28243 "                      const char *device,\n"
28244 "                      const char *label);\n"
28245 "\n"
28246 msgstr ""
28247
28248 #. type: textblock
28249 #: ../src/guestfs-actions.pod:6400
28250 msgid ""
28251 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
28252 "the existing label on a filesystem."
28253 msgstr ""
28254
28255 #. type: =head2
28256 #: ../src/guestfs-actions.pod:6407
28257 msgid "guestfs_set_e2uuid"
28258 msgstr ""
28259
28260 #. type: verbatim
28261 #: ../src/guestfs-actions.pod:6409
28262 #, no-wrap
28263 msgid ""
28264 " int\n"
28265 " guestfs_set_e2uuid (guestfs_h *g,\n"
28266 "                     const char *device,\n"
28267 "                     const char *uuid);\n"
28268 "\n"
28269 msgstr ""
28270
28271 #. type: textblock
28272 #: ../src/guestfs-actions.pod:6419
28273 msgid ""
28274 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
28275 "the existing UUID of a filesystem."
28276 msgstr ""
28277
28278 #. type: =head2
28279 #: ../src/guestfs-actions.pod:6426
28280 msgid "guestfs_set_memsize"
28281 msgstr ""
28282
28283 #. type: verbatim
28284 #: ../src/guestfs-actions.pod:6428
28285 #, no-wrap
28286 msgid ""
28287 " int\n"
28288 " guestfs_set_memsize (guestfs_h *g,\n"
28289 "                      int memsize);\n"
28290 "\n"
28291 msgstr ""
28292
28293 #. type: textblock
28294 #: ../src/guestfs-actions.pod:6432
28295 msgid ""
28296 "This sets the memory size in megabytes allocated to the qemu subprocess.  "
28297 "This only has any effect if called before C<guestfs_launch>."
28298 msgstr ""
28299
28300 #. type: =head2
28301 #: ../src/guestfs-actions.pod:6447
28302 msgid "guestfs_set_network"
28303 msgstr ""
28304
28305 #. type: verbatim
28306 #: ../src/guestfs-actions.pod:6449
28307 #, no-wrap
28308 msgid ""
28309 " int\n"
28310 " guestfs_set_network (guestfs_h *g,\n"
28311 "                      int network);\n"
28312 "\n"
28313 msgstr ""
28314
28315 #. type: textblock
28316 #: ../src/guestfs-actions.pod:6459
28317 msgid ""
28318 "You must call this before calling C<guestfs_launch>, otherwise it has no "
28319 "effect."
28320 msgstr ""
28321
28322 #. type: =head2
28323 #: ../src/guestfs-actions.pod:6466
28324 msgid "guestfs_set_path"
28325 msgstr ""
28326
28327 #. type: verbatim
28328 #: ../src/guestfs-actions.pod:6468
28329 #, no-wrap
28330 msgid ""
28331 " int\n"
28332 " guestfs_set_path (guestfs_h *g,\n"
28333 "                   const char *searchpath);\n"
28334 "\n"
28335 msgstr ""
28336
28337 #. type: =head2
28338 #: ../src/guestfs-actions.pod:6483
28339 msgid "guestfs_set_pgroup"
28340 msgstr ""
28341
28342 #. type: verbatim
28343 #: ../src/guestfs-actions.pod:6485
28344 #, no-wrap
28345 msgid ""
28346 " int\n"
28347 " guestfs_set_pgroup (guestfs_h *g,\n"
28348 "                     int pgroup);\n"
28349 "\n"
28350 msgstr ""
28351
28352 #. type: =head2
28353 #: ../src/guestfs-actions.pod:6502
28354 msgid "guestfs_set_qemu"
28355 msgstr ""
28356
28357 #. type: verbatim
28358 #: ../src/guestfs-actions.pod:6504
28359 #, no-wrap
28360 msgid ""
28361 " int\n"
28362 " guestfs_set_qemu (guestfs_h *g,\n"
28363 "                   const char *qemu);\n"
28364 "\n"
28365 msgstr ""
28366
28367 #. type: =head2
28368 #: ../src/guestfs-actions.pod:6530
28369 msgid "guestfs_set_recovery_proc"
28370 msgstr ""
28371
28372 #. type: verbatim
28373 #: ../src/guestfs-actions.pod:6532
28374 #, no-wrap
28375 msgid ""
28376 " int\n"
28377 " guestfs_set_recovery_proc (guestfs_h *g,\n"
28378 "                            int recoveryproc);\n"
28379 "\n"
28380 msgstr ""
28381
28382 #. type: textblock
28383 #: ../src/guestfs-actions.pod:6536
28384 msgid ""
28385 "If this is called with the parameter C<false> then C<guestfs_launch> does "
28386 "not create a recovery process.  The purpose of the recovery process is to "
28387 "stop runaway qemu processes in the case where the main program aborts "
28388 "abruptly."
28389 msgstr ""
28390
28391 #. type: textblock
28392 #: ../src/guestfs-actions.pod:6541
28393 msgid ""
28394 "This only has any effect if called before C<guestfs_launch>, and the default "
28395 "is true."
28396 msgstr ""
28397
28398 #. type: =head2
28399 #: ../src/guestfs-actions.pod:6554
28400 msgid "guestfs_set_selinux"
28401 msgstr ""
28402
28403 #. type: verbatim
28404 #: ../src/guestfs-actions.pod:6556
28405 #, no-wrap
28406 msgid ""
28407 " int\n"
28408 " guestfs_set_selinux (guestfs_h *g,\n"
28409 "                      int selinux);\n"
28410 "\n"
28411 msgstr ""
28412
28413 #. type: =head2
28414 #: ../src/guestfs-actions.pod:6573
28415 msgid "guestfs_set_smp"
28416 msgstr ""
28417
28418 #. type: verbatim
28419 #: ../src/guestfs-actions.pod:6575
28420 #, no-wrap
28421 msgid ""
28422 " int\n"
28423 " guestfs_set_smp (guestfs_h *g,\n"
28424 "                  int smp);\n"
28425 "\n"
28426 msgstr ""
28427
28428 #. type: textblock
28429 #: ../src/guestfs-actions.pod:6583
28430 msgid "This function must be called before C<guestfs_launch>."
28431 msgstr ""
28432
28433 #. type: =head2
28434 #: ../src/guestfs-actions.pod:6587
28435 msgid "guestfs_set_trace"
28436 msgstr ""
28437
28438 #. type: verbatim
28439 #: ../src/guestfs-actions.pod:6589
28440 #, no-wrap
28441 msgid ""
28442 " int\n"
28443 " guestfs_set_trace (guestfs_h *g,\n"
28444 "                    int trace);\n"
28445 "\n"
28446 msgstr ""
28447
28448 #. type: textblock
28449 #: ../src/guestfs-actions.pod:6603
28450 msgid ""
28451 "Trace messages are normally sent to C<stderr>, unless you register a "
28452 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
28453 msgstr ""
28454
28455 #. type: =head2
28456 #: ../src/guestfs-actions.pod:6611
28457 msgid "guestfs_set_verbose"
28458 msgstr ""
28459
28460 #. type: verbatim
28461 #: ../src/guestfs-actions.pod:6613
28462 #, no-wrap
28463 msgid ""
28464 " int\n"
28465 " guestfs_set_verbose (guestfs_h *g,\n"
28466 "                      int verbose);\n"
28467 "\n"
28468 msgstr ""
28469
28470 #. type: textblock
28471 #: ../src/guestfs-actions.pod:6622
28472 msgid ""
28473 "Verbose messages are normally sent to C<stderr>, unless you register a "
28474 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
28475 msgstr ""
28476
28477 #. type: =head2
28478 #: ../src/guestfs-actions.pod:6630
28479 msgid "guestfs_setcon"
28480 msgstr ""
28481
28482 #. type: verbatim
28483 #: ../src/guestfs-actions.pod:6632
28484 #, no-wrap
28485 msgid ""
28486 " int\n"
28487 " guestfs_setcon (guestfs_h *g,\n"
28488 "                 const char *context);\n"
28489 "\n"
28490 msgstr ""
28491
28492 #. type: =head2
28493 #: ../src/guestfs-actions.pod:6645
28494 msgid "guestfs_setxattr"
28495 msgstr ""
28496
28497 #. type: verbatim
28498 #: ../src/guestfs-actions.pod:6647
28499 #, no-wrap
28500 msgid ""
28501 " int\n"
28502 " guestfs_setxattr (guestfs_h *g,\n"
28503 "                   const char *xattr,\n"
28504 "                   const char *val,\n"
28505 "                   int vallen,\n"
28506 "                   const char *path);\n"
28507 "\n"
28508 msgstr ""
28509
28510 #. type: textblock
28511 #: ../src/guestfs-actions.pod:6658
28512 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
28513 msgstr ""
28514
28515 #. type: =head2
28516 #: ../src/guestfs-actions.pod:6664
28517 msgid "guestfs_sfdisk"
28518 msgstr ""
28519
28520 #. type: verbatim
28521 #: ../src/guestfs-actions.pod:6666
28522 #, no-wrap
28523 msgid ""
28524 " int\n"
28525 " guestfs_sfdisk (guestfs_h *g,\n"
28526 "                 const char *device,\n"
28527 "                 int cyls,\n"
28528 "                 int heads,\n"
28529 "                 int sectors,\n"
28530 "                 char *const *lines);\n"
28531 "\n"
28532 msgstr ""
28533
28534 #. type: textblock
28535 #: ../src/guestfs-actions.pod:6674 ../src/guestfs-actions.pod:6718 ../src/guestfs-actions.pod:6752
28536 msgid ""
28537 "I<This function is deprecated.> In new code, use the L</guestfs_part_add> "
28538 "call instead."
28539 msgstr ""
28540
28541 #. type: textblock
28542 #: ../src/guestfs-actions.pod:6701
28543 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
28544 msgstr ""
28545
28546 #. type: =head2
28547 #: ../src/guestfs-actions.pod:6711
28548 msgid "guestfs_sfdiskM"
28549 msgstr ""
28550
28551 #. type: verbatim
28552 #: ../src/guestfs-actions.pod:6713
28553 #, no-wrap
28554 msgid ""
28555 " int\n"
28556 " guestfs_sfdiskM (guestfs_h *g,\n"
28557 "                  const char *device,\n"
28558 "                  char *const *lines);\n"
28559 "\n"
28560 msgstr ""
28561
28562 #. type: textblock
28563 #: ../src/guestfs-actions.pod:6725
28564 msgid ""
28565 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
28566 "partition sizes are specified in megabytes only (rounded to the nearest "
28567 "cylinder) and you don't need to specify the cyls, heads and sectors "
28568 "parameters which were rarely if ever used anyway."
28569 msgstr ""
28570
28571 #. type: textblock
28572 #: ../src/guestfs-actions.pod:6731
28573 msgid ""
28574 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
28575 "C<guestfs_part_disk>"
28576 msgstr ""
28577
28578 #. type: =head2
28579 #: ../src/guestfs-actions.pod:6741
28580 msgid "guestfs_sfdisk_N"
28581 msgstr ""
28582
28583 #. type: verbatim
28584 #: ../src/guestfs-actions.pod:6743
28585 #, no-wrap
28586 msgid ""
28587 " int\n"
28588 " guestfs_sfdisk_N (guestfs_h *g,\n"
28589 "                   const char *device,\n"
28590 "                   int partnum,\n"
28591 "                   int cyls,\n"
28592 "                   int heads,\n"
28593 "                   int sectors,\n"
28594 "                   const char *line);\n"
28595 "\n"
28596 msgstr ""
28597
28598 #. type: textblock
28599 #: ../src/guestfs-actions.pod:6762
28600 msgid ""
28601 "For other parameters, see C<guestfs_sfdisk>.  You should usually pass C<0> "
28602 "for the cyls/heads/sectors parameters."
28603 msgstr ""
28604
28605 #. type: textblock
28606 #: ../src/guestfs-actions.pod:6765
28607 msgid "See also: C<guestfs_part_add>"
28608 msgstr ""
28609
28610 #. type: =head2
28611 #: ../src/guestfs-actions.pod:6774
28612 msgid "guestfs_sfdisk_disk_geometry"
28613 msgstr ""
28614
28615 #. type: verbatim
28616 #: ../src/guestfs-actions.pod:6776
28617 #, no-wrap
28618 msgid ""
28619 " char *\n"
28620 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
28621 "                               const char *device);\n"
28622 "\n"
28623 msgstr ""
28624
28625 #. type: textblock
28626 #: ../src/guestfs-actions.pod:6780
28627 msgid ""
28628 "This displays the disk geometry of C<device> read from the partition table.  "
28629 "Especially in the case where the underlying block device has been resized, "
28630 "this can be different from the kernel's idea of the geometry (see "
28631 "C<guestfs_sfdisk_kernel_geometry>)."
28632 msgstr ""
28633
28634 #. type: =head2
28635 #: ../src/guestfs-actions.pod:6793
28636 msgid "guestfs_sfdisk_kernel_geometry"
28637 msgstr ""
28638
28639 #. type: verbatim
28640 #: ../src/guestfs-actions.pod:6795
28641 #, no-wrap
28642 msgid ""
28643 " char *\n"
28644 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
28645 "                                 const char *device);\n"
28646 "\n"
28647 msgstr ""
28648
28649 #. type: =head2
28650 #: ../src/guestfs-actions.pod:6809
28651 msgid "guestfs_sfdisk_l"
28652 msgstr ""
28653
28654 #. type: verbatim
28655 #: ../src/guestfs-actions.pod:6811
28656 #, no-wrap
28657 msgid ""
28658 " char *\n"
28659 " guestfs_sfdisk_l (guestfs_h *g,\n"
28660 "                   const char *device);\n"
28661 "\n"
28662 msgstr ""
28663
28664 #. type: textblock
28665 #: ../src/guestfs-actions.pod:6815
28666 msgid ""
28667 "I<This function is deprecated.> In new code, use the L</guestfs_part_list> "
28668 "call instead."
28669 msgstr ""
28670
28671 #. type: textblock
28672 #: ../src/guestfs-actions.pod:6826
28673 msgid "See also: C<guestfs_part_list>"
28674 msgstr ""
28675
28676 #. type: =head2
28677 #: ../src/guestfs-actions.pod:6833
28678 msgid "guestfs_sh"
28679 msgstr ""
28680
28681 #. type: verbatim
28682 #: ../src/guestfs-actions.pod:6835
28683 #, no-wrap
28684 msgid ""
28685 " char *\n"
28686 " guestfs_sh (guestfs_h *g,\n"
28687 "             const char *command);\n"
28688 "\n"
28689 msgstr ""
28690
28691 #. type: textblock
28692 #: ../src/guestfs-actions.pod:6842
28693 msgid "This is like C<guestfs_command>, but passes the command to:"
28694 msgstr ""
28695
28696 #. type: textblock
28697 #: ../src/guestfs-actions.pod:6850
28698 msgid "All the provisos about C<guestfs_command> apply to this call."
28699 msgstr ""
28700
28701 #. type: =head2
28702 #: ../src/guestfs-actions.pod:6857
28703 msgid "guestfs_sh_lines"
28704 msgstr ""
28705
28706 #. type: verbatim
28707 #: ../src/guestfs-actions.pod:6859
28708 #, no-wrap
28709 msgid ""
28710 " char **\n"
28711 " guestfs_sh_lines (guestfs_h *g,\n"
28712 "                   const char *command);\n"
28713 "\n"
28714 msgstr ""
28715
28716 #. type: textblock
28717 #: ../src/guestfs-actions.pod:6863
28718 msgid ""
28719 "This is the same as C<guestfs_sh>, but splits the result into a list of "
28720 "lines."
28721 msgstr ""
28722
28723 #. type: textblock
28724 #: ../src/guestfs-actions.pod:6866
28725 msgid "See also: C<guestfs_command_lines>"
28726 msgstr ""
28727
28728 #. type: =head2
28729 #: ../src/guestfs-actions.pod:6874
28730 msgid "guestfs_sleep"
28731 msgstr ""
28732
28733 #. type: verbatim
28734 #: ../src/guestfs-actions.pod:6876
28735 #, no-wrap
28736 msgid ""
28737 " int\n"
28738 " guestfs_sleep (guestfs_h *g,\n"
28739 "                int secs);\n"
28740 "\n"
28741 msgstr ""
28742
28743 #. type: textblock
28744 #: ../src/guestfs-actions.pod:6884
28745 msgid "(Added in 1.0.41)"
28746 msgstr ""
28747
28748 #. type: =head2
28749 #: ../src/guestfs-actions.pod:6886 ../src/guestfs-structs.pod:109
28750 msgid "guestfs_stat"
28751 msgstr ""
28752
28753 #. type: verbatim
28754 #: ../src/guestfs-actions.pod:6888
28755 #, no-wrap
28756 msgid ""
28757 " struct guestfs_stat *\n"
28758 " guestfs_stat (guestfs_h *g,\n"
28759 "               const char *path);\n"
28760 "\n"
28761 msgstr ""
28762
28763 #. type: =head2
28764 #: ../src/guestfs-actions.pod:6902 ../src/guestfs-structs.pod:135
28765 msgid "guestfs_statvfs"
28766 msgstr ""
28767
28768 #. type: verbatim
28769 #: ../src/guestfs-actions.pod:6904
28770 #, no-wrap
28771 msgid ""
28772 " struct guestfs_statvfs *\n"
28773 " guestfs_statvfs (guestfs_h *g,\n"
28774 "                  const char *path);\n"
28775 "\n"
28776 msgstr ""
28777
28778 #. type: textblock
28779 #: ../src/guestfs-actions.pod:6914
28780 msgid ""
28781 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
28782 "error.  I<The caller must call C<guestfs_free_statvfs> after use>."
28783 msgstr ""
28784
28785 #. type: =head2
28786 #: ../src/guestfs-actions.pod:6920
28787 msgid "guestfs_strings"
28788 msgstr ""
28789
28790 #. type: verbatim
28791 #: ../src/guestfs-actions.pod:6922
28792 #, no-wrap
28793 msgid ""
28794 " char **\n"
28795 " guestfs_strings (guestfs_h *g,\n"
28796 "                  const char *path);\n"
28797 "\n"
28798 msgstr ""
28799
28800 #. type: =head2
28801 #: ../src/guestfs-actions.pod:6938
28802 msgid "guestfs_strings_e"
28803 msgstr ""
28804
28805 #. type: verbatim
28806 #: ../src/guestfs-actions.pod:6940
28807 #, no-wrap
28808 msgid ""
28809 " char **\n"
28810 " guestfs_strings_e (guestfs_h *g,\n"
28811 "                    const char *encoding,\n"
28812 "                    const char *path);\n"
28813 "\n"
28814 msgstr ""
28815
28816 #. type: textblock
28817 #: ../src/guestfs-actions.pod:6945
28818 msgid ""
28819 "This is like the C<guestfs_strings> command, but allows you to specify the "
28820 "encoding of strings that are looked for in the source file C<path>."
28821 msgstr ""
28822
28823 #. type: textblock
28824 #: ../src/guestfs-actions.pod:6955
28825 msgid ""
28826 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
28827 "ISO-8859-X (this is what C<guestfs_strings> uses)."
28828 msgstr ""
28829
28830 #. type: =head2
28831 #: ../src/guestfs-actions.pod:6993
28832 msgid "guestfs_swapoff_device"
28833 msgstr ""
28834
28835 #. type: verbatim
28836 #: ../src/guestfs-actions.pod:6995
28837 #, no-wrap
28838 msgid ""
28839 " int\n"
28840 " guestfs_swapoff_device (guestfs_h *g,\n"
28841 "                         const char *device);\n"
28842 "\n"
28843 msgstr ""
28844
28845 #. type: textblock
28846 #: ../src/guestfs-actions.pod:6999
28847 msgid ""
28848 "This command disables the libguestfs appliance swap device or partition "
28849 "named C<device>.  See C<guestfs_swapon_device>."
28850 msgstr ""
28851
28852 #. type: =head2
28853 #: ../src/guestfs-actions.pod:7007
28854 msgid "guestfs_swapoff_file"
28855 msgstr ""
28856
28857 #. type: verbatim
28858 #: ../src/guestfs-actions.pod:7009
28859 #, no-wrap
28860 msgid ""
28861 " int\n"
28862 " guestfs_swapoff_file (guestfs_h *g,\n"
28863 "                       const char *file);\n"
28864 "\n"
28865 msgstr ""
28866
28867 #. type: =head2
28868 #: ../src/guestfs-actions.pod:7019
28869 msgid "guestfs_swapoff_label"
28870 msgstr ""
28871
28872 #. type: verbatim
28873 #: ../src/guestfs-actions.pod:7021
28874 #, no-wrap
28875 msgid ""
28876 " int\n"
28877 " guestfs_swapoff_label (guestfs_h *g,\n"
28878 "                        const char *label);\n"
28879 "\n"
28880 msgstr ""
28881
28882 #. type: =head2
28883 #: ../src/guestfs-actions.pod:7032
28884 msgid "guestfs_swapoff_uuid"
28885 msgstr ""
28886
28887 #. type: verbatim
28888 #: ../src/guestfs-actions.pod:7034
28889 #, no-wrap
28890 msgid ""
28891 " int\n"
28892 " guestfs_swapoff_uuid (guestfs_h *g,\n"
28893 "                       const char *uuid);\n"
28894 "\n"
28895 msgstr ""
28896
28897 #. type: =head2
28898 #: ../src/guestfs-actions.pod:7045
28899 msgid "guestfs_swapon_device"
28900 msgstr ""
28901
28902 #. type: verbatim
28903 #: ../src/guestfs-actions.pod:7047
28904 #, no-wrap
28905 msgid ""
28906 " int\n"
28907 " guestfs_swapon_device (guestfs_h *g,\n"
28908 "                        const char *device);\n"
28909 "\n"
28910 msgstr ""
28911
28912 #. type: textblock
28913 #: ../src/guestfs-actions.pod:7051
28914 msgid ""
28915 "This command enables the libguestfs appliance to use the swap device or "
28916 "partition named C<device>.  The increased memory is made available for all "
28917 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
28918 msgstr ""
28919
28920 #. type: =head2
28921 #: ../src/guestfs-actions.pod:7067
28922 msgid "guestfs_swapon_file"
28923 msgstr ""
28924
28925 #. type: verbatim
28926 #: ../src/guestfs-actions.pod:7069
28927 #, no-wrap
28928 msgid ""
28929 " int\n"
28930 " guestfs_swapon_file (guestfs_h *g,\n"
28931 "                      const char *file);\n"
28932 "\n"
28933 msgstr ""
28934
28935 #. type: textblock
28936 #: ../src/guestfs-actions.pod:7073
28937 msgid ""
28938 "This command enables swap to a file.  See C<guestfs_swapon_device> for other "
28939 "notes."
28940 msgstr ""
28941
28942 #. type: =head2
28943 #: ../src/guestfs-actions.pod:7080
28944 msgid "guestfs_swapon_label"
28945 msgstr ""
28946
28947 #. type: verbatim
28948 #: ../src/guestfs-actions.pod:7082
28949 #, no-wrap
28950 msgid ""
28951 " int\n"
28952 " guestfs_swapon_label (guestfs_h *g,\n"
28953 "                       const char *label);\n"
28954 "\n"
28955 msgstr ""
28956
28957 #. type: textblock
28958 #: ../src/guestfs-actions.pod:7086
28959 msgid ""
28960 "This command enables swap to a labeled swap partition.  See "
28961 "C<guestfs_swapon_device> for other notes."
28962 msgstr ""
28963
28964 #. type: =head2
28965 #: ../src/guestfs-actions.pod:7093
28966 msgid "guestfs_swapon_uuid"
28967 msgstr ""
28968
28969 #. type: verbatim
28970 #: ../src/guestfs-actions.pod:7095
28971 #, no-wrap
28972 msgid ""
28973 " int\n"
28974 " guestfs_swapon_uuid (guestfs_h *g,\n"
28975 "                      const char *uuid);\n"
28976 "\n"
28977 msgstr ""
28978
28979 #. type: textblock
28980 #: ../src/guestfs-actions.pod:7099
28981 msgid ""
28982 "This command enables swap to a swap partition with the given UUID.  See "
28983 "C<guestfs_swapon_device> for other notes."
28984 msgstr ""
28985
28986 #. type: =head2
28987 #: ../src/guestfs-actions.pod:7106
28988 msgid "guestfs_sync"
28989 msgstr ""
28990
28991 #. type: verbatim
28992 #: ../src/guestfs-actions.pod:7108
28993 #, no-wrap
28994 msgid ""
28995 " int\n"
28996 " guestfs_sync (guestfs_h *g);\n"
28997 "\n"
28998 msgstr ""
28999
29000 #. type: =head2
29001 #: ../src/guestfs-actions.pod:7121
29002 msgid "guestfs_tail"
29003 msgstr ""
29004
29005 #. type: verbatim
29006 #: ../src/guestfs-actions.pod:7123
29007 #, no-wrap
29008 msgid ""
29009 " char **\n"
29010 " guestfs_tail (guestfs_h *g,\n"
29011 "               const char *path);\n"
29012 "\n"
29013 msgstr ""
29014
29015 #. type: =head2
29016 #: ../src/guestfs-actions.pod:7139
29017 msgid "guestfs_tail_n"
29018 msgstr ""
29019
29020 #. type: verbatim
29021 #: ../src/guestfs-actions.pod:7141
29022 #, no-wrap
29023 msgid ""
29024 " char **\n"
29025 " guestfs_tail_n (guestfs_h *g,\n"
29026 "                 int nrlines,\n"
29027 "                 const char *path);\n"
29028 "\n"
29029 msgstr ""
29030
29031 #. type: =head2
29032 #: ../src/guestfs-actions.pod:7163
29033 msgid "guestfs_tar_in"
29034 msgstr ""
29035
29036 #. type: verbatim
29037 #: ../src/guestfs-actions.pod:7165
29038 #, no-wrap
29039 msgid ""
29040 " int\n"
29041 " guestfs_tar_in (guestfs_h *g,\n"
29042 "                 const char *tarfile,\n"
29043 "                 const char *directory);\n"
29044 "\n"
29045 msgstr ""
29046
29047 #. type: textblock
29048 #: ../src/guestfs-actions.pod:7173
29049 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
29050 msgstr ""
29051
29052 #. type: textblock
29053 #: ../src/guestfs-actions.pod:7178 ../src/guestfs-actions.pod:7195 ../src/guestfs-actions.pod:7211 ../src/guestfs-actions.pod:7227
29054 msgid "(Added in 1.0.3)"
29055 msgstr ""
29056
29057 #. type: =head2
29058 #: ../src/guestfs-actions.pod:7180
29059 msgid "guestfs_tar_out"
29060 msgstr ""
29061
29062 #. type: verbatim
29063 #: ../src/guestfs-actions.pod:7182
29064 #, no-wrap
29065 msgid ""
29066 " int\n"
29067 " guestfs_tar_out (guestfs_h *g,\n"
29068 "                  const char *directory,\n"
29069 "                  const char *tarfile);\n"
29070 "\n"
29071 msgstr ""
29072
29073 #. type: textblock
29074 #: ../src/guestfs-actions.pod:7190
29075 msgid ""
29076 "To download a compressed tarball, use C<guestfs_tgz_out> or "
29077 "C<guestfs_txz_out>."
29078 msgstr ""
29079
29080 #. type: =head2
29081 #: ../src/guestfs-actions.pod:7197
29082 msgid "guestfs_tgz_in"
29083 msgstr ""
29084
29085 #. type: verbatim
29086 #: ../src/guestfs-actions.pod:7199
29087 #, no-wrap
29088 msgid ""
29089 " int\n"
29090 " guestfs_tgz_in (guestfs_h *g,\n"
29091 "                 const char *tarball,\n"
29092 "                 const char *directory);\n"
29093 "\n"
29094 msgstr ""
29095
29096 #. type: textblock
29097 #: ../src/guestfs-actions.pod:7207
29098 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
29099 msgstr ""
29100
29101 #. type: =head2
29102 #: ../src/guestfs-actions.pod:7213
29103 msgid "guestfs_tgz_out"
29104 msgstr ""
29105
29106 #. type: verbatim
29107 #: ../src/guestfs-actions.pod:7215
29108 #, no-wrap
29109 msgid ""
29110 " int\n"
29111 " guestfs_tgz_out (guestfs_h *g,\n"
29112 "                  const char *directory,\n"
29113 "                  const char *tarball);\n"
29114 "\n"
29115 msgstr ""
29116
29117 #. type: textblock
29118 #: ../src/guestfs-actions.pod:7223
29119 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
29120 msgstr ""
29121
29122 #. type: =head2
29123 #: ../src/guestfs-actions.pod:7229
29124 msgid "guestfs_touch"
29125 msgstr ""
29126
29127 #. type: verbatim
29128 #: ../src/guestfs-actions.pod:7231
29129 #, no-wrap
29130 msgid ""
29131 " int\n"
29132 " guestfs_touch (guestfs_h *g,\n"
29133 "                const char *path);\n"
29134 "\n"
29135 msgstr ""
29136
29137 #. type: =head2
29138 #: ../src/guestfs-actions.pod:7246
29139 msgid "guestfs_truncate"
29140 msgstr ""
29141
29142 #. type: verbatim
29143 #: ../src/guestfs-actions.pod:7248
29144 #, no-wrap
29145 msgid ""
29146 " int\n"
29147 " guestfs_truncate (guestfs_h *g,\n"
29148 "                   const char *path);\n"
29149 "\n"
29150 msgstr ""
29151
29152 #. type: =head2
29153 #: ../src/guestfs-actions.pod:7259
29154 msgid "guestfs_truncate_size"
29155 msgstr ""
29156
29157 #. type: verbatim
29158 #: ../src/guestfs-actions.pod:7261
29159 #, no-wrap
29160 msgid ""
29161 " int\n"
29162 " guestfs_truncate_size (guestfs_h *g,\n"
29163 "                        const char *path,\n"
29164 "                        int64_t size);\n"
29165 "\n"
29166 msgstr ""
29167
29168 #. type: textblock
29169 #: ../src/guestfs-actions.pod:7269
29170 msgid ""
29171 "If the current file size is less than C<size> then the file is extended to "
29172 "the required size with zero bytes.  This creates a sparse file (ie. disk "
29173 "blocks are not allocated for the file until you write to it).  To create a "
29174 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
29175 msgstr ""
29176
29177 #. type: =head2
29178 #: ../src/guestfs-actions.pod:7279
29179 msgid "guestfs_tune2fs_l"
29180 msgstr ""
29181
29182 #. type: verbatim
29183 #: ../src/guestfs-actions.pod:7281
29184 #, no-wrap
29185 msgid ""
29186 " char **\n"
29187 " guestfs_tune2fs_l (guestfs_h *g,\n"
29188 "                    const char *device);\n"
29189 "\n"
29190 msgstr ""
29191
29192 #. type: =head2
29193 #: ../src/guestfs-actions.pod:7301
29194 msgid "guestfs_txz_in"
29195 msgstr ""
29196
29197 #. type: verbatim
29198 #: ../src/guestfs-actions.pod:7303
29199 #, no-wrap
29200 msgid ""
29201 " int\n"
29202 " guestfs_txz_in (guestfs_h *g,\n"
29203 "                 const char *tarball,\n"
29204 "                 const char *directory);\n"
29205 "\n"
29206 msgstr ""
29207
29208 #. type: =head2
29209 #: ../src/guestfs-actions.pod:7315
29210 msgid "guestfs_txz_out"
29211 msgstr ""
29212
29213 #. type: verbatim
29214 #: ../src/guestfs-actions.pod:7317
29215 #, no-wrap
29216 msgid ""
29217 " int\n"
29218 " guestfs_txz_out (guestfs_h *g,\n"
29219 "                  const char *directory,\n"
29220 "                  const char *tarball);\n"
29221 "\n"
29222 msgstr ""
29223
29224 #. type: =head2
29225 #: ../src/guestfs-actions.pod:7329
29226 msgid "guestfs_umask"
29227 msgstr ""
29228
29229 #. type: verbatim
29230 #: ../src/guestfs-actions.pod:7331
29231 #, no-wrap
29232 msgid ""
29233 " int\n"
29234 " guestfs_umask (guestfs_h *g,\n"
29235 "                int mask);\n"
29236 "\n"
29237 msgstr ""
29238
29239 #. type: textblock
29240 #: ../src/guestfs-actions.pod:7347
29241 msgid ""
29242 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
29243 "C<guestfs_mkdir>."
29244 msgstr ""
29245
29246 #. type: =head2
29247 #: ../src/guestfs-actions.pod:7356
29248 msgid "guestfs_umount"
29249 msgstr ""
29250
29251 #. type: verbatim
29252 #: ../src/guestfs-actions.pod:7358
29253 #, no-wrap
29254 msgid ""
29255 " int\n"
29256 " guestfs_umount (guestfs_h *g,\n"
29257 "                 const char *pathordevice);\n"
29258 "\n"
29259 msgstr ""
29260
29261 #. type: =head2
29262 #: ../src/guestfs-actions.pod:7370
29263 msgid "guestfs_umount_all"
29264 msgstr ""
29265
29266 #. type: verbatim
29267 #: ../src/guestfs-actions.pod:7372
29268 #, no-wrap
29269 msgid ""
29270 " int\n"
29271 " guestfs_umount_all (guestfs_h *g);\n"
29272 "\n"
29273 msgstr ""
29274
29275 #. type: =head2
29276 #: ../src/guestfs-actions.pod:7383
29277 msgid "guestfs_upload"
29278 msgstr ""
29279
29280 #. type: verbatim
29281 #: ../src/guestfs-actions.pod:7385
29282 #, no-wrap
29283 msgid ""
29284 " int\n"
29285 " guestfs_upload (guestfs_h *g,\n"
29286 "                 const char *filename,\n"
29287 "                 const char *remotefilename);\n"
29288 "\n"
29289 msgstr ""
29290
29291 #. type: textblock
29292 #: ../src/guestfs-actions.pod:7395
29293 msgid "See also C<guestfs_download>."
29294 msgstr ""
29295
29296 #. type: =head2
29297 #: ../src/guestfs-actions.pod:7406
29298 msgid "guestfs_upload_offset"
29299 msgstr ""
29300
29301 #. type: verbatim
29302 #: ../src/guestfs-actions.pod:7408
29303 #, no-wrap
29304 msgid ""
29305 " int\n"
29306 " guestfs_upload_offset (guestfs_h *g,\n"
29307 "                        const char *filename,\n"
29308 "                        const char *remotefilename,\n"
29309 "                        int64_t offset);\n"
29310 "\n"
29311 msgstr ""
29312
29313 #. type: textblock
29314 #: ../src/guestfs-actions.pod:7424
29315 msgid ""
29316 "Note that there is no limit on the amount of data that can be uploaded with "
29317 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
29318 "full amount unless an error occurs."
29319 msgstr ""
29320
29321 #. type: textblock
29322 #: ../src/guestfs-actions.pod:7429
29323 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
29324 msgstr ""
29325
29326 #. type: =head2
29327 #: ../src/guestfs-actions.pod:7440
29328 msgid "guestfs_utimens"
29329 msgstr ""
29330
29331 #. type: verbatim
29332 #: ../src/guestfs-actions.pod:7442
29333 #, no-wrap
29334 msgid ""
29335 " int\n"
29336 " guestfs_utimens (guestfs_h *g,\n"
29337 "                  const char *path,\n"
29338 "                  int64_t atsecs,\n"
29339 "                  int64_t atnsecs,\n"
29340 "                  int64_t mtsecs,\n"
29341 "                  int64_t mtnsecs);\n"
29342 "\n"
29343 msgstr ""
29344
29345 #. type: =head2
29346 #: ../src/guestfs-actions.pod:7471 ../src/guestfs-structs.pod:175
29347 msgid "guestfs_version"
29348 msgstr ""
29349
29350 #. type: verbatim
29351 #: ../src/guestfs-actions.pod:7473
29352 #, no-wrap
29353 msgid ""
29354 " struct guestfs_version *\n"
29355 " guestfs_version (guestfs_h *g);\n"
29356 "\n"
29357 msgstr ""
29358
29359 #. type: textblock
29360 #: ../src/guestfs-actions.pod:7501
29361 msgid ""
29362 "I<Note:> Don't use this call to test for availability of features.  In "
29363 "enterprise distributions we backport features from later versions into "
29364 "earlier versions, making this an unreliable way to test for features.  Use "
29365 "C<guestfs_available> instead."
29366 msgstr ""
29367
29368 #. type: textblock
29369 #: ../src/guestfs-actions.pod:7507
29370 msgid ""
29371 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
29372 "error.  I<The caller must call C<guestfs_free_version> after use>."
29373 msgstr ""
29374
29375 #. type: textblock
29376 #: ../src/guestfs-actions.pod:7511
29377 msgid "(Added in 1.0.58)"
29378 msgstr ""
29379
29380 #. type: =head2
29381 #: ../src/guestfs-actions.pod:7513
29382 msgid "guestfs_vfs_label"
29383 msgstr ""
29384
29385 #. type: verbatim
29386 #: ../src/guestfs-actions.pod:7515
29387 #, no-wrap
29388 msgid ""
29389 " char *\n"
29390 " guestfs_vfs_label (guestfs_h *g,\n"
29391 "                    const char *device);\n"
29392 "\n"
29393 msgstr ""
29394
29395 #. type: textblock
29396 #: ../src/guestfs-actions.pod:7524
29397 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
29398 msgstr ""
29399
29400 #. type: textblock
29401 #: ../src/guestfs-actions.pod:7529 ../src/guestfs-actions.pod:7566
29402 msgid "(Added in 1.3.18)"
29403 msgstr ""
29404
29405 #. type: =head2
29406 #: ../src/guestfs-actions.pod:7531
29407 msgid "guestfs_vfs_type"
29408 msgstr ""
29409
29410 #. type: verbatim
29411 #: ../src/guestfs-actions.pod:7533
29412 #, no-wrap
29413 msgid ""
29414 " char *\n"
29415 " guestfs_vfs_type (guestfs_h *g,\n"
29416 "                   const char *device);\n"
29417 "\n"
29418 msgstr ""
29419
29420 #. type: =head2
29421 #: ../src/guestfs-actions.pod:7550
29422 msgid "guestfs_vfs_uuid"
29423 msgstr ""
29424
29425 #. type: verbatim
29426 #: ../src/guestfs-actions.pod:7552
29427 #, no-wrap
29428 msgid ""
29429 " char *\n"
29430 " guestfs_vfs_uuid (guestfs_h *g,\n"
29431 "                   const char *device);\n"
29432 "\n"
29433 msgstr ""
29434
29435 #. type: textblock
29436 #: ../src/guestfs-actions.pod:7561
29437 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
29438 msgstr ""
29439
29440 #. type: =head2
29441 #: ../src/guestfs-actions.pod:7568
29442 msgid "guestfs_vg_activate"
29443 msgstr ""
29444
29445 #. type: verbatim
29446 #: ../src/guestfs-actions.pod:7570
29447 #, no-wrap
29448 msgid ""
29449 " int\n"
29450 " guestfs_vg_activate (guestfs_h *g,\n"
29451 "                      int activate,\n"
29452 "                      char *const *volgroups);\n"
29453 "\n"
29454 msgstr ""
29455
29456 #. type: =head2
29457 #: ../src/guestfs-actions.pod:7587
29458 msgid "guestfs_vg_activate_all"
29459 msgstr ""
29460
29461 #. type: verbatim
29462 #: ../src/guestfs-actions.pod:7589
29463 #, no-wrap
29464 msgid ""
29465 " int\n"
29466 " guestfs_vg_activate_all (guestfs_h *g,\n"
29467 "                          int activate);\n"
29468 "\n"
29469 msgstr ""
29470
29471 #. type: =head2
29472 #: ../src/guestfs-actions.pod:7602
29473 msgid "guestfs_vgcreate"
29474 msgstr ""
29475
29476 #. type: verbatim
29477 #: ../src/guestfs-actions.pod:7604
29478 #, no-wrap
29479 msgid ""
29480 " int\n"
29481 " guestfs_vgcreate (guestfs_h *g,\n"
29482 "                   const char *volgroup,\n"
29483 "                   char *const *physvols);\n"
29484 "\n"
29485 msgstr ""
29486
29487 #. type: =head2
29488 #: ../src/guestfs-actions.pod:7616
29489 msgid "guestfs_vglvuuids"
29490 msgstr ""
29491
29492 #. type: verbatim
29493 #: ../src/guestfs-actions.pod:7618
29494 #, no-wrap
29495 msgid ""
29496 " char **\n"
29497 " guestfs_vglvuuids (guestfs_h *g,\n"
29498 "                    const char *vgname);\n"
29499 "\n"
29500 msgstr ""
29501
29502 #. type: textblock
29503 #: ../src/guestfs-actions.pod:7625
29504 msgid ""
29505 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
29506 "associate logical volumes and volume groups."
29507 msgstr ""
29508
29509 #. type: textblock
29510 #: ../src/guestfs-actions.pod:7628
29511 msgid "See also C<guestfs_vgpvuuids>."
29512 msgstr ""
29513
29514 #. type: =head2
29515 #: ../src/guestfs-actions.pod:7636
29516 msgid "guestfs_vgpvuuids"
29517 msgstr ""
29518
29519 #. type: verbatim
29520 #: ../src/guestfs-actions.pod:7638
29521 #, no-wrap
29522 msgid ""
29523 " char **\n"
29524 " guestfs_vgpvuuids (guestfs_h *g,\n"
29525 "                    const char *vgname);\n"
29526 "\n"
29527 msgstr ""
29528
29529 #. type: textblock
29530 #: ../src/guestfs-actions.pod:7645
29531 msgid ""
29532 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
29533 "associate physical volumes and volume groups."
29534 msgstr ""
29535
29536 #. type: textblock
29537 #: ../src/guestfs-actions.pod:7648
29538 msgid "See also C<guestfs_vglvuuids>."
29539 msgstr ""
29540
29541 #. type: =head2
29542 #: ../src/guestfs-actions.pod:7656
29543 msgid "guestfs_vgremove"
29544 msgstr ""
29545
29546 #. type: verbatim
29547 #: ../src/guestfs-actions.pod:7658
29548 #, no-wrap
29549 msgid ""
29550 " int\n"
29551 " guestfs_vgremove (guestfs_h *g,\n"
29552 "                   const char *vgname);\n"
29553 "\n"
29554 msgstr ""
29555
29556 #. type: =head2
29557 #: ../src/guestfs-actions.pod:7671
29558 msgid "guestfs_vgrename"
29559 msgstr ""
29560
29561 #. type: verbatim
29562 #: ../src/guestfs-actions.pod:7673
29563 #, no-wrap
29564 msgid ""
29565 " int\n"
29566 " guestfs_vgrename (guestfs_h *g,\n"
29567 "                   const char *volgroup,\n"
29568 "                   const char *newvolgroup);\n"
29569 "\n"
29570 msgstr ""
29571
29572 #. type: =head2
29573 #: ../src/guestfs-actions.pod:7684
29574 msgid "guestfs_vgs"
29575 msgstr ""
29576
29577 #. type: verbatim
29578 #: ../src/guestfs-actions.pod:7686
29579 #, no-wrap
29580 msgid ""
29581 " char **\n"
29582 " guestfs_vgs (guestfs_h *g);\n"
29583 "\n"
29584 msgstr ""
29585
29586 #. type: textblock
29587 #: ../src/guestfs-actions.pod:7695
29588 msgid "See also C<guestfs_vgs_full>."
29589 msgstr ""
29590
29591 #. type: =head2
29592 #: ../src/guestfs-actions.pod:7703
29593 msgid "guestfs_vgs_full"
29594 msgstr ""
29595
29596 #. type: verbatim
29597 #: ../src/guestfs-actions.pod:7705
29598 #, no-wrap
29599 msgid ""
29600 " struct guestfs_lvm_vg_list *\n"
29601 " guestfs_vgs_full (guestfs_h *g);\n"
29602 "\n"
29603 msgstr ""
29604
29605 #. type: textblock
29606 #: ../src/guestfs-actions.pod:7711
29607 msgid ""
29608 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
29609 "was an error.  I<The caller must call C<guestfs_free_lvm_vg_list> after "
29610 "use>."
29611 msgstr ""
29612
29613 #. type: =head2
29614 #: ../src/guestfs-actions.pod:7717
29615 msgid "guestfs_vgscan"
29616 msgstr ""
29617
29618 #. type: verbatim
29619 #: ../src/guestfs-actions.pod:7719
29620 #, no-wrap
29621 msgid ""
29622 " int\n"
29623 " guestfs_vgscan (guestfs_h *g);\n"
29624 "\n"
29625 msgstr ""
29626
29627 #. type: =head2
29628 #: ../src/guestfs-actions.pod:7729
29629 msgid "guestfs_vguuid"
29630 msgstr ""
29631
29632 #. type: verbatim
29633 #: ../src/guestfs-actions.pod:7731
29634 #, no-wrap
29635 msgid ""
29636 " char *\n"
29637 " guestfs_vguuid (guestfs_h *g,\n"
29638 "                 const char *vgname);\n"
29639 "\n"
29640 msgstr ""
29641
29642 #. type: =head2
29643 #: ../src/guestfs-actions.pod:7742
29644 msgid "guestfs_wait_ready"
29645 msgstr ""
29646
29647 #. type: verbatim
29648 #: ../src/guestfs-actions.pod:7744
29649 #, no-wrap
29650 msgid ""
29651 " int\n"
29652 " guestfs_wait_ready (guestfs_h *g);\n"
29653 "\n"
29654 msgstr ""
29655
29656 #. type: textblock
29657 #: ../src/guestfs-actions.pod:7747
29658 msgid ""
29659 "I<This function is deprecated.> In new code, use the L</guestfs_launch> call "
29660 "instead."
29661 msgstr ""
29662
29663 #. type: textblock
29664 #: ../src/guestfs-actions.pod:7754
29665 msgid "This function is a no op."
29666 msgstr ""
29667
29668 #. type: textblock
29669 #: ../src/guestfs-actions.pod:7756
29670 msgid ""
29671 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
29672 "calling C<guestfs_launch> to wait for the launch to complete.  However this "
29673 "is no longer necessary because C<guestfs_launch> now does the waiting."
29674 msgstr ""
29675
29676 #. type: textblock
29677 #: ../src/guestfs-actions.pod:7761
29678 msgid ""
29679 "If you see any calls to this function in code then you can just remove them, "
29680 "unless you want to retain compatibility with older versions of the API."
29681 msgstr ""
29682
29683 #. type: =head2
29684 #: ../src/guestfs-actions.pod:7769
29685 msgid "guestfs_wc_c"
29686 msgstr ""
29687
29688 #. type: verbatim
29689 #: ../src/guestfs-actions.pod:7771
29690 #, no-wrap
29691 msgid ""
29692 " int\n"
29693 " guestfs_wc_c (guestfs_h *g,\n"
29694 "               const char *path);\n"
29695 "\n"
29696 msgstr ""
29697
29698 #. type: =head2
29699 #: ../src/guestfs-actions.pod:7782
29700 msgid "guestfs_wc_l"
29701 msgstr ""
29702
29703 #. type: verbatim
29704 #: ../src/guestfs-actions.pod:7784
29705 #, no-wrap
29706 msgid ""
29707 " int\n"
29708 " guestfs_wc_l (guestfs_h *g,\n"
29709 "               const char *path);\n"
29710 "\n"
29711 msgstr ""
29712
29713 #. type: =head2
29714 #: ../src/guestfs-actions.pod:7795
29715 msgid "guestfs_wc_w"
29716 msgstr ""
29717
29718 #. type: verbatim
29719 #: ../src/guestfs-actions.pod:7797
29720 #, no-wrap
29721 msgid ""
29722 " int\n"
29723 " guestfs_wc_w (guestfs_h *g,\n"
29724 "               const char *path);\n"
29725 "\n"
29726 msgstr ""
29727
29728 #. type: =head2
29729 #: ../src/guestfs-actions.pod:7808
29730 msgid "guestfs_write"
29731 msgstr ""
29732
29733 #. type: verbatim
29734 #: ../src/guestfs-actions.pod:7810
29735 #, no-wrap
29736 msgid ""
29737 " int\n"
29738 " guestfs_write (guestfs_h *g,\n"
29739 "                const char *path,\n"
29740 "                const char *content,\n"
29741 "                size_t content_size);\n"
29742 "\n"
29743 msgstr ""
29744
29745 #. type: textblock
29746 #: ../src/guestfs-actions.pod:7819
29747 msgid "See also C<guestfs_write_append>."
29748 msgstr ""
29749
29750 #. type: =head2
29751 #: ../src/guestfs-actions.pod:7828
29752 msgid "guestfs_write_append"
29753 msgstr ""
29754
29755 #. type: verbatim
29756 #: ../src/guestfs-actions.pod:7830
29757 #, no-wrap
29758 msgid ""
29759 " int\n"
29760 " guestfs_write_append (guestfs_h *g,\n"
29761 "                       const char *path,\n"
29762 "                       const char *content,\n"
29763 "                       size_t content_size);\n"
29764 "\n"
29765 msgstr ""
29766
29767 #. type: textblock
29768 #: ../src/guestfs-actions.pod:7839
29769 msgid "See also C<guestfs_write>."
29770 msgstr ""
29771
29772 #. type: =head2
29773 #: ../src/guestfs-actions.pod:7848
29774 msgid "guestfs_write_file"
29775 msgstr ""
29776
29777 #. type: verbatim
29778 #: ../src/guestfs-actions.pod:7850
29779 #, no-wrap
29780 msgid ""
29781 " int\n"
29782 " guestfs_write_file (guestfs_h *g,\n"
29783 "                     const char *path,\n"
29784 "                     const char *content,\n"
29785 "                     int size);\n"
29786 "\n"
29787 msgstr ""
29788
29789 #. type: textblock
29790 #: ../src/guestfs-actions.pod:7856
29791 msgid ""
29792 "I<This function is deprecated.> In new code, use the L</guestfs_write> call "
29793 "instead."
29794 msgstr ""
29795
29796 #. type: =head2
29797 #: ../src/guestfs-actions.pod:7881
29798 msgid "guestfs_zegrep"
29799 msgstr ""
29800
29801 #. type: verbatim
29802 #: ../src/guestfs-actions.pod:7883
29803 #, no-wrap
29804 msgid ""
29805 " char **\n"
29806 " guestfs_zegrep (guestfs_h *g,\n"
29807 "                 const char *regex,\n"
29808 "                 const char *path);\n"
29809 "\n"
29810 msgstr ""
29811
29812 #. type: =head2
29813 #: ../src/guestfs-actions.pod:7900
29814 msgid "guestfs_zegrepi"
29815 msgstr ""
29816
29817 #. type: verbatim
29818 #: ../src/guestfs-actions.pod:7902
29819 #, no-wrap
29820 msgid ""
29821 " char **\n"
29822 " guestfs_zegrepi (guestfs_h *g,\n"
29823 "                  const char *regex,\n"
29824 "                  const char *path);\n"
29825 "\n"
29826 msgstr ""
29827
29828 #. type: =head2
29829 #: ../src/guestfs-actions.pod:7919
29830 msgid "guestfs_zero"
29831 msgstr ""
29832
29833 #. type: verbatim
29834 #: ../src/guestfs-actions.pod:7921
29835 #, no-wrap
29836 msgid ""
29837 " int\n"
29838 " guestfs_zero (guestfs_h *g,\n"
29839 "               const char *device);\n"
29840 "\n"
29841 msgstr ""
29842
29843 #. type: textblock
29844 #: ../src/guestfs-actions.pod:7935
29845 msgid ""
29846 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
29847 "C<guestfs_is_zero_device>"
29848 msgstr ""
29849
29850 #. type: =head2
29851 #: ../src/guestfs-actions.pod:7947
29852 msgid "guestfs_zero_device"
29853 msgstr ""
29854
29855 #. type: verbatim
29856 #: ../src/guestfs-actions.pod:7949
29857 #, no-wrap
29858 msgid ""
29859 " int\n"
29860 " guestfs_zero_device (guestfs_h *g,\n"
29861 "                      const char *device);\n"
29862 "\n"
29863 msgstr ""
29864
29865 #. type: textblock
29866 #: ../src/guestfs-actions.pod:7953
29867 msgid ""
29868 "This command writes zeroes over the entire C<device>.  Compare with "
29869 "C<guestfs_zero> which just zeroes the first few blocks of a device."
29870 msgstr ""
29871
29872 #. type: textblock
29873 #: ../src/guestfs-actions.pod:7971
29874 msgid "(Added in 1.3.1)"
29875 msgstr ""
29876
29877 #. type: =head2
29878 #: ../src/guestfs-actions.pod:7973
29879 msgid "guestfs_zerofree"
29880 msgstr ""
29881
29882 #. type: verbatim
29883 #: ../src/guestfs-actions.pod:7975
29884 #, no-wrap
29885 msgid ""
29886 " int\n"
29887 " guestfs_zerofree (guestfs_h *g,\n"
29888 "                   const char *device);\n"
29889 "\n"
29890 msgstr ""
29891
29892 #. type: =head2
29893 #: ../src/guestfs-actions.pod:7994
29894 msgid "guestfs_zfgrep"
29895 msgstr ""
29896
29897 #. type: verbatim
29898 #: ../src/guestfs-actions.pod:7996
29899 #, no-wrap
29900 msgid ""
29901 " char **\n"
29902 " guestfs_zfgrep (guestfs_h *g,\n"
29903 "                 const char *pattern,\n"
29904 "                 const char *path);\n"
29905 "\n"
29906 msgstr ""
29907
29908 #. type: =head2
29909 #: ../src/guestfs-actions.pod:8013
29910 msgid "guestfs_zfgrepi"
29911 msgstr ""
29912
29913 #. type: verbatim
29914 #: ../src/guestfs-actions.pod:8015
29915 #, no-wrap
29916 msgid ""
29917 " char **\n"
29918 " guestfs_zfgrepi (guestfs_h *g,\n"
29919 "                  const char *pattern,\n"
29920 "                  const char *path);\n"
29921 "\n"
29922 msgstr ""
29923
29924 #. type: =head2
29925 #: ../src/guestfs-actions.pod:8032
29926 msgid "guestfs_zfile"
29927 msgstr ""
29928
29929 #. type: verbatim
29930 #: ../src/guestfs-actions.pod:8034
29931 #, no-wrap
29932 msgid ""
29933 " char *\n"
29934 " guestfs_zfile (guestfs_h *g,\n"
29935 "                const char *meth,\n"
29936 "                const char *path);\n"
29937 "\n"
29938 msgstr ""
29939
29940 #. type: textblock
29941 #: ../src/guestfs-actions.pod:8039
29942 msgid ""
29943 "I<This function is deprecated.> In new code, use the L</guestfs_file> call "
29944 "instead."
29945 msgstr ""
29946
29947 #. type: textblock
29948 #: ../src/guestfs-actions.pod:8051
29949 msgid ""
29950 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
29951 "files."
29952 msgstr ""
29953
29954 #. type: =head2
29955 #: ../src/guestfs-actions.pod:8059
29956 msgid "guestfs_zgrep"
29957 msgstr ""
29958
29959 #. type: verbatim
29960 #: ../src/guestfs-actions.pod:8061
29961 #, no-wrap
29962 msgid ""
29963 " char **\n"
29964 " guestfs_zgrep (guestfs_h *g,\n"
29965 "                const char *regex,\n"
29966 "                const char *path);\n"
29967 "\n"
29968 msgstr ""
29969
29970 #. type: =head2
29971 #: ../src/guestfs-actions.pod:8078
29972 msgid "guestfs_zgrepi"
29973 msgstr ""
29974
29975 #. type: verbatim
29976 #: ../src/guestfs-actions.pod:8080
29977 #, no-wrap
29978 msgid ""
29979 " char **\n"
29980 " guestfs_zgrepi (guestfs_h *g,\n"
29981 "                 const char *regex,\n"
29982 "                 const char *path);\n"
29983 "\n"
29984 msgstr ""
29985
29986 #. type: =item
29987 #: ../src/guestfs-availability.pod:3
29988 msgid "B<augeas>"
29989 msgstr ""
29990
29991 #. type: textblock
29992 #: ../src/guestfs-availability.pod:5
29993 msgid ""
29994 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
29995 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
29996 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
29997 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
29998 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
29999 msgstr ""
30000
30001 #. type: =item
30002 #: ../src/guestfs-availability.pod:21
30003 msgid "B<btrfs>"
30004 msgstr ""
30005
30006 #. type: textblock
30007 #: ../src/guestfs-availability.pod:23
30008 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
30009 msgstr ""
30010
30011 #. type: =item
30012 #: ../src/guestfs-availability.pod:26
30013 msgid "B<grub>"
30014 msgstr ""
30015
30016 #. type: textblock
30017 #: ../src/guestfs-availability.pod:28
30018 msgid "The following functions: L</guestfs_grub_install>"
30019 msgstr ""
30020
30021 #. type: =item
30022 #: ../src/guestfs-availability.pod:31
30023 msgid "B<inotify>"
30024 msgstr ""
30025
30026 #. type: textblock
30027 #: ../src/guestfs-availability.pod:33
30028 msgid ""
30029 "The following functions: L</guestfs_inotify_add_watch> "
30030 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
30031 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
30032 msgstr ""
30033
30034 #. type: =item
30035 #: ../src/guestfs-availability.pod:41
30036 msgid "B<linuxfsuuid>"
30037 msgstr ""
30038
30039 #. type: textblock
30040 #: ../src/guestfs-availability.pod:43
30041 msgid ""
30042 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
30043 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
30044 msgstr ""
30045
30046 #. type: =item
30047 #: ../src/guestfs-availability.pod:50
30048 msgid "B<linuxmodules>"
30049 msgstr ""
30050
30051 #. type: textblock
30052 #: ../src/guestfs-availability.pod:52
30053 msgid "The following functions: L</guestfs_modprobe>"
30054 msgstr ""
30055
30056 #. type: =item
30057 #: ../src/guestfs-availability.pod:55
30058 msgid "B<linuxxattrs>"
30059 msgstr ""
30060
30061 #. type: textblock
30062 #: ../src/guestfs-availability.pod:57
30063 msgid ""
30064 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
30065 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
30066 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
30067 "L</guestfs_setxattr>"
30068 msgstr ""
30069
30070 #. type: =item
30071 #: ../src/guestfs-availability.pod:68
30072 msgid "B<luks>"
30073 msgstr ""
30074
30075 #. type: textblock
30076 #: ../src/guestfs-availability.pod:70
30077 msgid ""
30078 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
30079 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
30080 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
30081 msgstr ""
30082
30083 #. type: =item
30084 #: ../src/guestfs-availability.pod:79
30085 msgid "B<lvm2>"
30086 msgstr ""
30087
30088 #. type: textblock
30089 #: ../src/guestfs-availability.pod:81
30090 msgid ""
30091 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
30092 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
30093 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
30094 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
30095 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
30096 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
30097 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
30098 "L</guestfs_vgs_full>"
30099 msgstr ""
30100
30101 #. type: =item
30102 #: ../src/guestfs-availability.pod:104
30103 msgid "B<mknod>"
30104 msgstr ""
30105
30106 #. type: textblock
30107 #: ../src/guestfs-availability.pod:106
30108 msgid ""
30109 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
30110 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
30111 msgstr ""
30112
30113 #. type: =item
30114 #: ../src/guestfs-availability.pod:112
30115 msgid "B<ntfs3g>"
30116 msgstr ""
30117
30118 #. type: textblock
30119 #: ../src/guestfs-availability.pod:114
30120 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
30121 msgstr ""
30122
30123 #. type: =item
30124 #: ../src/guestfs-availability.pod:117
30125 msgid "B<ntfsprogs>"
30126 msgstr ""
30127
30128 #. type: textblock
30129 #: ../src/guestfs-availability.pod:119
30130 msgid ""
30131 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
30132 "L</guestfs_ntfsresize_size>"
30133 msgstr ""
30134
30135 #. type: =item
30136 #: ../src/guestfs-availability.pod:124
30137 msgid "B<realpath>"
30138 msgstr ""
30139
30140 #. type: textblock
30141 #: ../src/guestfs-availability.pod:126
30142 msgid "The following functions: L</guestfs_realpath>"
30143 msgstr ""
30144
30145 #. type: =item
30146 #: ../src/guestfs-availability.pod:129
30147 msgid "B<scrub>"
30148 msgstr ""
30149
30150 #. type: textblock
30151 #: ../src/guestfs-availability.pod:131
30152 msgid ""
30153 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
30154 "L</guestfs_scrub_freespace>"
30155 msgstr ""
30156
30157 #. type: =item
30158 #: ../src/guestfs-availability.pod:136
30159 msgid "B<selinux>"
30160 msgstr ""
30161
30162 #. type: textblock
30163 #: ../src/guestfs-availability.pod:138
30164 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
30165 msgstr ""
30166
30167 #. type: =item
30168 #: ../src/guestfs-availability.pod:142
30169 msgid "B<xz>"
30170 msgstr ""
30171
30172 #. type: textblock
30173 #: ../src/guestfs-availability.pod:144
30174 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
30175 msgstr ""
30176
30177 #. type: =item
30178 #: ../src/guestfs-availability.pod:148
30179 msgid "B<zerofree>"
30180 msgstr ""
30181
30182 #. type: textblock
30183 #: ../src/guestfs-availability.pod:150
30184 msgid "The following functions: L</guestfs_zerofree>"
30185 msgstr ""
30186
30187 #. type: =head2
30188 #: ../src/guestfs-structs.pod:1
30189 msgid "guestfs_int_bool"
30190 msgstr ""
30191
30192 #. type: verbatim
30193 #: ../src/guestfs-structs.pod:3
30194 #, no-wrap
30195 msgid ""
30196 " struct guestfs_int_bool {\n"
30197 "   int32_t i;\n"
30198 "   int32_t b;\n"
30199 " };\n"
30200 " \n"
30201 msgstr ""
30202
30203 #. type: verbatim
30204 #: ../src/guestfs-structs.pod:8
30205 #, no-wrap
30206 msgid ""
30207 " struct guestfs_int_bool_list {\n"
30208 "   uint32_t len; /* Number of elements in list. */\n"
30209 "   struct guestfs_int_bool *val; /* Elements. */\n"
30210 " };\n"
30211 " \n"
30212 msgstr ""
30213
30214 #. type: verbatim
30215 #: ../src/guestfs-structs.pod:13
30216 #, no-wrap
30217 msgid ""
30218 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
30219 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
30220 "\n"
30221 msgstr ""
30222
30223 #. type: =head2
30224 #: ../src/guestfs-structs.pod:16
30225 msgid "guestfs_lvm_pv"
30226 msgstr ""
30227
30228 #. type: verbatim
30229 #: ../src/guestfs-structs.pod:18
30230 #, no-wrap
30231 msgid ""
30232 " struct guestfs_lvm_pv {\n"
30233 "   char *pv_name;\n"
30234 "   /* The next field is NOT nul-terminated, be careful when printing it: "
30235 "*/\n"
30236 "   char pv_uuid[32];\n"
30237 "   char *pv_fmt;\n"
30238 "   uint64_t pv_size;\n"
30239 "   uint64_t dev_size;\n"
30240 "   uint64_t pv_free;\n"
30241 "   uint64_t pv_used;\n"
30242 "   char *pv_attr;\n"
30243 "   int64_t pv_pe_count;\n"
30244 "   int64_t pv_pe_alloc_count;\n"
30245 "   char *pv_tags;\n"
30246 "   uint64_t pe_start;\n"
30247 "   int64_t pv_mda_count;\n"
30248 "   uint64_t pv_mda_free;\n"
30249 " };\n"
30250 " \n"
30251 msgstr ""
30252
30253 #. type: verbatim
30254 #: ../src/guestfs-structs.pod:36
30255 #, no-wrap
30256 msgid ""
30257 " struct guestfs_lvm_pv_list {\n"
30258 "   uint32_t len; /* Number of elements in list. */\n"
30259 "   struct guestfs_lvm_pv *val; /* Elements. */\n"
30260 " };\n"
30261 " \n"
30262 msgstr ""
30263
30264 #. type: verbatim
30265 #: ../src/guestfs-structs.pod:41
30266 #, no-wrap
30267 msgid ""
30268 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
30269 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
30270 "\n"
30271 msgstr ""
30272
30273 #. type: =head2
30274 #: ../src/guestfs-structs.pod:44
30275 msgid "guestfs_lvm_vg"
30276 msgstr ""
30277
30278 #. type: verbatim
30279 #: ../src/guestfs-structs.pod:46
30280 #, no-wrap
30281 msgid ""
30282 " struct guestfs_lvm_vg {\n"
30283 "   char *vg_name;\n"
30284 "   /* The next field is NOT nul-terminated, be careful when printing it: "
30285 "*/\n"
30286 "   char vg_uuid[32];\n"
30287 "   char *vg_fmt;\n"
30288 "   char *vg_attr;\n"
30289 "   uint64_t vg_size;\n"
30290 "   uint64_t vg_free;\n"
30291 "   char *vg_sysid;\n"
30292 "   uint64_t vg_extent_size;\n"
30293 "   int64_t vg_extent_count;\n"
30294 "   int64_t vg_free_count;\n"
30295 "   int64_t max_lv;\n"
30296 "   int64_t max_pv;\n"
30297 "   int64_t pv_count;\n"
30298 "   int64_t lv_count;\n"
30299 "   int64_t snap_count;\n"
30300 "   int64_t vg_seqno;\n"
30301 "   char *vg_tags;\n"
30302 "   int64_t vg_mda_count;\n"
30303 "   uint64_t vg_mda_free;\n"
30304 " };\n"
30305 " \n"
30306 msgstr ""
30307
30308 #. type: verbatim
30309 #: ../src/guestfs-structs.pod:69
30310 #, no-wrap
30311 msgid ""
30312 " struct guestfs_lvm_vg_list {\n"
30313 "   uint32_t len; /* Number of elements in list. */\n"
30314 "   struct guestfs_lvm_vg *val; /* Elements. */\n"
30315 " };\n"
30316 " \n"
30317 msgstr ""
30318
30319 #. type: verbatim
30320 #: ../src/guestfs-structs.pod:74
30321 #, no-wrap
30322 msgid ""
30323 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
30324 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
30325 "\n"
30326 msgstr ""
30327
30328 #. type: =head2
30329 #: ../src/guestfs-structs.pod:77
30330 msgid "guestfs_lvm_lv"
30331 msgstr ""
30332
30333 #. type: verbatim
30334 #: ../src/guestfs-structs.pod:79
30335 #, no-wrap
30336 msgid ""
30337 " struct guestfs_lvm_lv {\n"
30338 "   char *lv_name;\n"
30339 "   /* The next field is NOT nul-terminated, be careful when printing it: "
30340 "*/\n"
30341 "   char lv_uuid[32];\n"
30342 "   char *lv_attr;\n"
30343 "   int64_t lv_major;\n"
30344 "   int64_t lv_minor;\n"
30345 "   int64_t lv_kernel_major;\n"
30346 "   int64_t lv_kernel_minor;\n"
30347 "   uint64_t lv_size;\n"
30348 "   int64_t seg_count;\n"
30349 "   char *origin;\n"
30350 "   /* The next field is [0..100] or -1 meaning 'not present': */\n"
30351 "   float snap_percent;\n"
30352 "   /* The next field is [0..100] or -1 meaning 'not present': */\n"
30353 "   float copy_percent;\n"
30354 "   char *move_pv;\n"
30355 "   char *lv_tags;\n"
30356 "   char *mirror_log;\n"
30357 "   char *modules;\n"
30358 " };\n"
30359 " \n"
30360 msgstr ""
30361
30362 #. type: verbatim
30363 #: ../src/guestfs-structs.pod:101
30364 #, no-wrap
30365 msgid ""
30366 " struct guestfs_lvm_lv_list {\n"
30367 "   uint32_t len; /* Number of elements in list. */\n"
30368 "   struct guestfs_lvm_lv *val; /* Elements. */\n"
30369 " };\n"
30370 " \n"
30371 msgstr ""
30372
30373 #. type: verbatim
30374 #: ../src/guestfs-structs.pod:106
30375 #, no-wrap
30376 msgid ""
30377 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
30378 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
30379 "\n"
30380 msgstr ""
30381
30382 #. type: verbatim
30383 #: ../src/guestfs-structs.pod:111
30384 #, no-wrap
30385 msgid ""
30386 " struct guestfs_stat {\n"
30387 "   int64_t dev;\n"
30388 "   int64_t ino;\n"
30389 "   int64_t mode;\n"
30390 "   int64_t nlink;\n"
30391 "   int64_t uid;\n"
30392 "   int64_t gid;\n"
30393 "   int64_t rdev;\n"
30394 "   int64_t size;\n"
30395 "   int64_t blksize;\n"
30396 "   int64_t blocks;\n"
30397 "   int64_t atime;\n"
30398 "   int64_t mtime;\n"
30399 "   int64_t ctime;\n"
30400 " };\n"
30401 " \n"
30402 msgstr ""
30403
30404 #. type: verbatim
30405 #: ../src/guestfs-structs.pod:127
30406 #, no-wrap
30407 msgid ""
30408 " struct guestfs_stat_list {\n"
30409 "   uint32_t len; /* Number of elements in list. */\n"
30410 "   struct guestfs_stat *val; /* Elements. */\n"
30411 " };\n"
30412 " \n"
30413 msgstr ""
30414
30415 #. type: verbatim
30416 #: ../src/guestfs-structs.pod:132
30417 #, no-wrap
30418 msgid ""
30419 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
30420 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
30421 "\n"
30422 msgstr ""
30423
30424 #. type: verbatim
30425 #: ../src/guestfs-structs.pod:137
30426 #, no-wrap
30427 msgid ""
30428 " struct guestfs_statvfs {\n"
30429 "   int64_t bsize;\n"
30430 "   int64_t frsize;\n"
30431 "   int64_t blocks;\n"
30432 "   int64_t bfree;\n"
30433 "   int64_t bavail;\n"
30434 "   int64_t files;\n"
30435 "   int64_t ffree;\n"
30436 "   int64_t favail;\n"
30437 "   int64_t fsid;\n"
30438 "   int64_t flag;\n"
30439 "   int64_t namemax;\n"
30440 " };\n"
30441 " \n"
30442 msgstr ""
30443
30444 #. type: verbatim
30445 #: ../src/guestfs-structs.pod:151
30446 #, no-wrap
30447 msgid ""
30448 " struct guestfs_statvfs_list {\n"
30449 "   uint32_t len; /* Number of elements in list. */\n"
30450 "   struct guestfs_statvfs *val; /* Elements. */\n"
30451 " };\n"
30452 " \n"
30453 msgstr ""
30454
30455 #. type: verbatim
30456 #: ../src/guestfs-structs.pod:156
30457 #, no-wrap
30458 msgid ""
30459 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
30460 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
30461 "\n"
30462 msgstr ""
30463
30464 #. type: =head2
30465 #: ../src/guestfs-structs.pod:159
30466 msgid "guestfs_dirent"
30467 msgstr ""
30468
30469 #. type: verbatim
30470 #: ../src/guestfs-structs.pod:161
30471 #, no-wrap
30472 msgid ""
30473 " struct guestfs_dirent {\n"
30474 "   int64_t ino;\n"
30475 "   char ftyp;\n"
30476 "   char *name;\n"
30477 " };\n"
30478 " \n"
30479 msgstr ""
30480
30481 #. type: verbatim
30482 #: ../src/guestfs-structs.pod:167
30483 #, no-wrap
30484 msgid ""
30485 " struct guestfs_dirent_list {\n"
30486 "   uint32_t len; /* Number of elements in list. */\n"
30487 "   struct guestfs_dirent *val; /* Elements. */\n"
30488 " };\n"
30489 " \n"
30490 msgstr ""
30491
30492 #. type: verbatim
30493 #: ../src/guestfs-structs.pod:172
30494 #, no-wrap
30495 msgid ""
30496 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
30497 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
30498 "\n"
30499 msgstr ""
30500
30501 #. type: verbatim
30502 #: ../src/guestfs-structs.pod:177
30503 #, no-wrap
30504 msgid ""
30505 " struct guestfs_version {\n"
30506 "   int64_t major;\n"
30507 "   int64_t minor;\n"
30508 "   int64_t release;\n"
30509 "   char *extra;\n"
30510 " };\n"
30511 " \n"
30512 msgstr ""
30513
30514 #. type: verbatim
30515 #: ../src/guestfs-structs.pod:184
30516 #, no-wrap
30517 msgid ""
30518 " struct guestfs_version_list {\n"
30519 "   uint32_t len; /* Number of elements in list. */\n"
30520 "   struct guestfs_version *val; /* Elements. */\n"
30521 " };\n"
30522 " \n"
30523 msgstr ""
30524
30525 #. type: verbatim
30526 #: ../src/guestfs-structs.pod:189
30527 #, no-wrap
30528 msgid ""
30529 " void guestfs_free_version (struct guestfs_free_version *);\n"
30530 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
30531 "\n"
30532 msgstr ""
30533
30534 #. type: =head2
30535 #: ../src/guestfs-structs.pod:192
30536 msgid "guestfs_xattr"
30537 msgstr ""
30538
30539 #. type: verbatim
30540 #: ../src/guestfs-structs.pod:194
30541 #, no-wrap
30542 msgid ""
30543 " struct guestfs_xattr {\n"
30544 "   char *attrname;\n"
30545 "   /* The next two fields describe a byte array. */\n"
30546 "   uint32_t attrval_len;\n"
30547 "   char *attrval;\n"
30548 " };\n"
30549 " \n"
30550 msgstr ""
30551
30552 #. type: verbatim
30553 #: ../src/guestfs-structs.pod:201
30554 #, no-wrap
30555 msgid ""
30556 " struct guestfs_xattr_list {\n"
30557 "   uint32_t len; /* Number of elements in list. */\n"
30558 "   struct guestfs_xattr *val; /* Elements. */\n"
30559 " };\n"
30560 " \n"
30561 msgstr ""
30562
30563 #. type: verbatim
30564 #: ../src/guestfs-structs.pod:206
30565 #, no-wrap
30566 msgid ""
30567 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
30568 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
30569 "\n"
30570 msgstr ""
30571
30572 #. type: =head2
30573 #: ../src/guestfs-structs.pod:209
30574 msgid "guestfs_inotify_event"
30575 msgstr ""
30576
30577 #. type: verbatim
30578 #: ../src/guestfs-structs.pod:211
30579 #, no-wrap
30580 msgid ""
30581 " struct guestfs_inotify_event {\n"
30582 "   int64_t in_wd;\n"
30583 "   uint32_t in_mask;\n"
30584 "   uint32_t in_cookie;\n"
30585 "   char *in_name;\n"
30586 " };\n"
30587 " \n"
30588 msgstr ""
30589
30590 #. type: verbatim
30591 #: ../src/guestfs-structs.pod:218
30592 #, no-wrap
30593 msgid ""
30594 " struct guestfs_inotify_event_list {\n"
30595 "   uint32_t len; /* Number of elements in list. */\n"
30596 "   struct guestfs_inotify_event *val; /* Elements. */\n"
30597 " };\n"
30598 " \n"
30599 msgstr ""
30600
30601 #. type: verbatim
30602 #: ../src/guestfs-structs.pod:223
30603 #, no-wrap
30604 msgid ""
30605 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
30606 " void guestfs_free_inotify_event_list (struct "
30607 "guestfs_free_inotify_event_list *);\n"
30608 "\n"
30609 msgstr ""
30610
30611 #. type: =head2
30612 #: ../src/guestfs-structs.pod:226
30613 msgid "guestfs_partition"
30614 msgstr ""
30615
30616 #. type: verbatim
30617 #: ../src/guestfs-structs.pod:228
30618 #, no-wrap
30619 msgid ""
30620 " struct guestfs_partition {\n"
30621 "   int32_t part_num;\n"
30622 "   uint64_t part_start;\n"
30623 "   uint64_t part_end;\n"
30624 "   uint64_t part_size;\n"
30625 " };\n"
30626 " \n"
30627 msgstr ""
30628
30629 #. type: verbatim
30630 #: ../src/guestfs-structs.pod:235
30631 #, no-wrap
30632 msgid ""
30633 " struct guestfs_partition_list {\n"
30634 "   uint32_t len; /* Number of elements in list. */\n"
30635 "   struct guestfs_partition *val; /* Elements. */\n"
30636 " };\n"
30637 " \n"
30638 msgstr ""
30639
30640 #. type: verbatim
30641 #: ../src/guestfs-structs.pod:240
30642 #, no-wrap
30643 msgid ""
30644 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
30645 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
30646 "\n"
30647 msgstr ""
30648
30649 #. type: =head2
30650 #: ../src/guestfs-structs.pod:243
30651 msgid "guestfs_application"
30652 msgstr ""
30653
30654 #. type: verbatim
30655 #: ../src/guestfs-structs.pod:245
30656 #, no-wrap
30657 msgid ""
30658 " struct guestfs_application {\n"
30659 "   char *app_name;\n"
30660 "   char *app_display_name;\n"
30661 "   int32_t app_epoch;\n"
30662 "   char *app_version;\n"
30663 "   char *app_release;\n"
30664 "   char *app_install_path;\n"
30665 "   char *app_trans_path;\n"
30666 "   char *app_publisher;\n"
30667 "   char *app_url;\n"
30668 "   char *app_source_package;\n"
30669 "   char *app_summary;\n"
30670 "   char *app_description;\n"
30671 " };\n"
30672 " \n"
30673 msgstr ""
30674
30675 #. type: verbatim
30676 #: ../src/guestfs-structs.pod:260
30677 #, no-wrap
30678 msgid ""
30679 " struct guestfs_application_list {\n"
30680 "   uint32_t len; /* Number of elements in list. */\n"
30681 "   struct guestfs_application *val; /* Elements. */\n"
30682 " };\n"
30683 " \n"
30684 msgstr ""
30685
30686 #. type: verbatim
30687 #: ../src/guestfs-structs.pod:265
30688 #, no-wrap
30689 msgid ""
30690 " void guestfs_free_application (struct guestfs_free_application *);\n"
30691 " void guestfs_free_application_list (struct guestfs_free_application_list "
30692 "*);\n"
30693 "\n"
30694 msgstr ""
30695
30696 #. type: textblock
30697 #: ../src/guestfs.pod:5
30698 msgid "guestfs - Library for accessing and modifying virtual machine images"
30699 msgstr ""
30700
30701 #. type: verbatim
30702 #: ../src/guestfs.pod:11
30703 #, no-wrap
30704 msgid ""
30705 " guestfs_h *g = guestfs_create ();\n"
30706 " guestfs_add_drive (g, \"guest.img\");\n"
30707 " guestfs_launch (g);\n"
30708 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
30709 " guestfs_touch (g, \"/hello\");\n"
30710 " guestfs_umount (g, \"/\");\n"
30711 " guestfs_close (g);\n"
30712 "\n"
30713 msgstr ""
30714
30715 #. type: textblock
30716 #: ../src/guestfs.pod:25
30717 msgid ""
30718 "Libguestfs is a library for accessing and modifying guest disk images.  "
30719 "Amongst the things this is good for: making batch configuration changes to "
30720 "guests, getting disk used/free statistics (see also: virt-df), migrating "
30721 "between virtualization systems (see also: virt-p2v), performing partial "
30722 "backups, performing partial guest clones, cloning guests and changing "
30723 "registry/UUID/hostname info, and much else besides."
30724 msgstr ""
30725
30726 #. type: textblock
30727 #: ../src/guestfs.pod:33
30728 msgid ""
30729 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
30730 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
30731 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
30732 "qcow2, vmdk."
30733 msgstr ""
30734
30735 #. type: textblock
30736 #: ../src/guestfs.pod:38
30737 msgid ""
30738 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
30739 "what filesystem is in each LV, etc.).  It can also run commands in the "
30740 "context of the guest.  Also you can access filesystems over FUSE."
30741 msgstr ""
30742
30743 #. type: textblock
30744 #: ../src/guestfs.pod:43
30745 msgid ""
30746 "Libguestfs is a library that can be linked with C and C++ management "
30747 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
30748 "PHP, Erlang, Haskell or C#).  You can also use it from shell scripts or the "
30749 "command line."
30750 msgstr ""
30751
30752 #. type: textblock
30753 #: ../src/guestfs.pod:48
30754 msgid ""
30755 "You don't need to be root to use libguestfs, although obviously you do need "
30756 "enough permissions to access the disk images."
30757 msgstr ""
30758
30759 #. type: textblock
30760 #: ../src/guestfs.pod:51
30761 msgid ""
30762 "Libguestfs is a large API because it can do many things.  For a gentle "
30763 "introduction, please read the L</API OVERVIEW> section next."
30764 msgstr ""
30765
30766 #. type: textblock
30767 #: ../src/guestfs.pod:54
30768 msgid ""
30769 "There are also some example programs in the L<guestfs-examples(3)> manual "
30770 "page."
30771 msgstr ""
30772
30773 #. type: =head1
30774 #: ../src/guestfs.pod:57
30775 msgid "API OVERVIEW"
30776 msgstr ""
30777
30778 #. type: textblock
30779 #: ../src/guestfs.pod:59
30780 msgid ""
30781 "This section provides a gentler overview of the libguestfs API.  We also try "
30782 "to group API calls together, where that may not be obvious from reading "
30783 "about the individual calls in the main section of this manual."
30784 msgstr ""
30785
30786 #. type: =head2
30787 #: ../src/guestfs.pod:64
30788 msgid "HANDLES"
30789 msgstr ""
30790
30791 #. type: textblock
30792 #: ../src/guestfs.pod:66
30793 msgid ""
30794 "Before you can use libguestfs calls, you have to create a handle.  Then you "
30795 "must add at least one disk image to the handle, followed by launching the "
30796 "handle, then performing whatever operations you want, and finally closing "
30797 "the handle.  By convention we use the single letter C<g> for the name of the "
30798 "handle variable, although of course you can use any name you want."
30799 msgstr ""
30800
30801 #. type: textblock
30802 #: ../src/guestfs.pod:73
30803 msgid "The general structure of all libguestfs-using programs looks like this:"
30804 msgstr ""
30805
30806 #. type: verbatim
30807 #: ../src/guestfs.pod:76
30808 #, no-wrap
30809 msgid ""
30810 " guestfs_h *g = guestfs_create ();\n"
30811 " \n"
30812 msgstr ""
30813
30814 #. type: verbatim
30815 #: ../src/guestfs.pod:78
30816 #, no-wrap
30817 msgid ""
30818 " /* Call guestfs_add_drive additional times if there are\n"
30819 "  * multiple disk images.\n"
30820 "  */\n"
30821 " guestfs_add_drive (g, \"guest.img\");\n"
30822 " \n"
30823 msgstr ""
30824
30825 #. type: verbatim
30826 #: ../src/guestfs.pod:83
30827 #, no-wrap
30828 msgid ""
30829 " /* Most manipulation calls won't work until you've launched\n"
30830 "  * the handle 'g'.  You have to do this _after_ adding drives\n"
30831 "  * and _before_ other commands.\n"
30832 "  */\n"
30833 " guestfs_launch (g);\n"
30834 " \n"
30835 msgstr ""
30836
30837 #. type: verbatim
30838 #: ../src/guestfs.pod:89
30839 #, no-wrap
30840 msgid ""
30841 " /* Now you can examine what partitions, LVs etc are available.\n"
30842 "  */\n"
30843 " char **partitions = guestfs_list_partitions (g);\n"
30844 " char **logvols = guestfs_lvs (g);\n"
30845 " \n"
30846 msgstr ""
30847
30848 #. type: verbatim
30849 #: ../src/guestfs.pod:94
30850 #, no-wrap
30851 msgid ""
30852 " /* To access a filesystem in the image, you must mount it.\n"
30853 "  */\n"
30854 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
30855 " \n"
30856 msgstr ""
30857
30858 #. type: verbatim
30859 #: ../src/guestfs.pod:98
30860 #, no-wrap
30861 msgid ""
30862 " /* Now you can perform filesystem actions on the guest\n"
30863 "  * disk image.\n"
30864 "  */\n"
30865 " guestfs_touch (g, \"/hello\");\n"
30866 " \n"
30867 msgstr ""
30868
30869 #. type: verbatim
30870 #: ../src/guestfs.pod:103
30871 #, no-wrap
30872 msgid ""
30873 " /* This is only needed for libguestfs < 1.5.24.  Since then\n"
30874 "  * it is done automatically when you close the handle.  See\n"
30875 "  * discussion of autosync in this page.\n"
30876 "  */\n"
30877 " guestfs_sync (g);\n"
30878 " \n"
30879 msgstr ""
30880
30881 #. type: verbatim
30882 #: ../src/guestfs.pod:109
30883 #, no-wrap
30884 msgid ""
30885 " /* Close the handle 'g'. */\n"
30886 " guestfs_close (g);\n"
30887 "\n"
30888 msgstr ""
30889
30890 #. type: textblock
30891 #: ../src/guestfs.pod:112
30892 msgid ""
30893 "The code above doesn't include any error checking.  In real code you should "
30894 "check return values carefully for errors.  In general all functions that "
30895 "return integers return C<-1> on error, and all functions that return "
30896 "pointers return C<NULL> on error.  See section L</ERROR HANDLING> below for "
30897 "how to handle errors, and consult the documentation for each function call "
30898 "below to see precisely how they return error indications.  See "
30899 "L<guestfs-examples(3)> for fully worked examples."
30900 msgstr ""
30901
30902 #. type: =head2
30903 #: ../src/guestfs.pod:121
30904 msgid "DISK IMAGES"
30905 msgstr ""
30906
30907 #. type: textblock
30908 #: ../src/guestfs.pod:123
30909 msgid ""
30910 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
30911 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
30912 "actual block device, or simply an empty file of zeroes that you have created "
30913 "through L<posix_fallocate(3)>.  Libguestfs lets you do useful things to all "
30914 "of these."
30915 msgstr ""
30916
30917 #. type: textblock
30918 #: ../src/guestfs.pod:129
30919 msgid ""
30920 "The call you should use in modern code for adding drives is "
30921 "L</guestfs_add_drive_opts>.  To add a disk image, allowing writes, and "
30922 "specifying that the format is raw, do:"
30923 msgstr ""
30924
30925 #. type: verbatim
30926 #: ../src/guestfs.pod:133
30927 #, no-wrap
30928 msgid ""
30929 " guestfs_add_drive_opts (g, filename,\n"
30930 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
30931 "                         -1);\n"
30932 "\n"
30933 msgstr ""
30934
30935 #. type: textblock
30936 #: ../src/guestfs.pod:137
30937 msgid "You can add a disk read-only using:"
30938 msgstr ""
30939
30940 #. type: verbatim
30941 #: ../src/guestfs.pod:139
30942 #, no-wrap
30943 msgid ""
30944 " guestfs_add_drive_opts (g, filename,\n"
30945 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
30946 "                         GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
30947 "                         -1);\n"
30948 "\n"
30949 msgstr ""
30950
30951 #. type: textblock
30952 #: ../src/guestfs.pod:144
30953 msgid ""
30954 "or by calling the older function L</guestfs_add_drive_ro>.  In either case "
30955 "libguestfs won't modify the file."
30956 msgstr ""
30957
30958 #. type: textblock
30959 #: ../src/guestfs.pod:147
30960 msgid ""
30961 "Be extremely cautious if the disk image is in use, eg. if it is being used "
30962 "by a virtual machine.  Adding it read-write will almost certainly cause disk "
30963 "corruption, but adding it read-only is safe."
30964 msgstr ""
30965
30966 #. type: textblock
30967 #: ../src/guestfs.pod:151
30968 msgid ""
30969 "You must add at least one disk image, and you may add multiple disk images.  "
30970 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
30971 "first one you added), C</dev/sdb> (for the second one you added), etc."
30972 msgstr ""
30973
30974 #. type: textblock
30975 #: ../src/guestfs.pod:156
30976 msgid ""
30977 "Once L</guestfs_launch> has been called you cannot add any more images.  You "
30978 "can call L</guestfs_list_devices> to get a list of the device names, in the "
30979 "order that you added them.  See also L</BLOCK DEVICE NAMING> below."
30980 msgstr ""
30981
30982 #. type: =head2
30983 #: ../src/guestfs.pod:161
30984 msgid "MOUNTING"
30985 msgstr ""
30986
30987 #. type: textblock
30988 #: ../src/guestfs.pod:163
30989 msgid ""
30990 "Before you can read or write files, create directories and so on in a disk "
30991 "image that contains filesystems, you have to mount those filesystems using "
30992 "L</guestfs_mount_options> or L</guestfs_mount_ro>.  If you already know that "
30993 "a disk image contains (for example) one partition with a filesystem on that "
30994 "partition, then you can mount it directly:"
30995 msgstr ""
30996
30997 #. type: verbatim
30998 #: ../src/guestfs.pod:170
30999 #, no-wrap
31000 msgid ""
31001 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
31002 "\n"
31003 msgstr ""
31004
31005 #. type: textblock
31006 #: ../src/guestfs.pod:172
31007 msgid ""
31008 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
31009 "disk image that we added (C</dev/sda>).  If the disk contains Linux LVM2 "
31010 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>).  Note "
31011 "that these are libguestfs virtual devices, and are nothing to do with host "
31012 "devices."
31013 msgstr ""
31014
31015 #. type: textblock
31016 #: ../src/guestfs.pod:178
31017 msgid ""
31018 "If you are given a disk image and you don't know what it contains then you "
31019 "have to find out.  Libguestfs can do that too: use "
31020 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
31021 "and LVs, and either try mounting each to see what is mountable, or else "
31022 "examine them with L</guestfs_vfs_type> or L</guestfs_file>.  To list just "
31023 "filesystems, use L</guestfs_list_filesystems>."
31024 msgstr ""
31025
31026 #. type: textblock
31027 #: ../src/guestfs.pod:186
31028 msgid ""
31029 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
31030 "L</INSPECTION> below).  But you might find it easier to look at higher level "
31031 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
31032 msgstr ""
31033
31034 #. type: textblock
31035 #: ../src/guestfs.pod:191
31036 msgid ""
31037 "To mount a filesystem read-only, use L</guestfs_mount_ro>.  There are "
31038 "several other variations of the C<guestfs_mount_*> call."
31039 msgstr ""
31040
31041 #. type: =head2
31042 #: ../src/guestfs.pod:194
31043 msgid "FILESYSTEM ACCESS AND MODIFICATION"
31044 msgstr ""
31045
31046 #. type: textblock
31047 #: ../src/guestfs.pod:196
31048 msgid ""
31049 "The majority of the libguestfs API consists of fairly low-level calls for "
31050 "accessing and modifying the files, directories, symlinks etc on mounted "
31051 "filesystems.  There are over a hundred such calls which you can find listed "
31052 "in detail below in this man page, and we don't even pretend to cover them "
31053 "all in this overview."
31054 msgstr ""
31055
31056 #. type: textblock
31057 #: ../src/guestfs.pod:202
31058 msgid ""
31059 "Specify filenames as full paths, starting with C<\"/\"> and including the "
31060 "mount point."
31061 msgstr ""
31062
31063 #. type: textblock
31064 #: ../src/guestfs.pod:205
31065 msgid ""
31066 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
31067 "the file called C<\"etc/passwd\"> then you could do:"
31068 msgstr ""
31069
31070 #. type: verbatim
31071 #: ../src/guestfs.pod:208
31072 #, no-wrap
31073 msgid ""
31074 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
31075 "\n"
31076 msgstr ""
31077
31078 #. type: textblock
31079 #: ../src/guestfs.pod:210
31080 msgid ""
31081 "This would return C<data> as a newly allocated buffer containing the full "
31082 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
31083 "or C<NULL> if there was an error."
31084 msgstr ""
31085
31086 #. type: textblock
31087 #: ../src/guestfs.pod:214
31088 msgid ""
31089 "As another example, to create a top-level directory on that filesystem "
31090 "called C<\"var\"> you would do:"
31091 msgstr ""
31092
31093 #. type: verbatim
31094 #: ../src/guestfs.pod:217
31095 #, no-wrap
31096 msgid ""
31097 " guestfs_mkdir (g, \"/var\");\n"
31098 "\n"
31099 msgstr ""
31100
31101 #. type: textblock
31102 #: ../src/guestfs.pod:219
31103 msgid "To create a symlink you could do:"
31104 msgstr ""
31105
31106 #. type: verbatim
31107 #: ../src/guestfs.pod:221
31108 #, no-wrap
31109 msgid ""
31110 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
31111 "               \"/etc/rc3.d/S30portmap\");\n"
31112 "\n"
31113 msgstr ""
31114
31115 #. type: textblock
31116 #: ../src/guestfs.pod:224
31117 msgid ""
31118 "Libguestfs will reject attempts to use relative paths and there is no "
31119 "concept of a current working directory."
31120 msgstr ""
31121
31122 #. type: textblock
31123 #: ../src/guestfs.pod:227
31124 msgid ""
31125 "Libguestfs can return errors in many situations: for example if the "
31126 "filesystem isn't writable, or if a file or directory that you requested "
31127 "doesn't exist.  If you are using the C API (documented here)  you have to "
31128 "check for those error conditions after each call.  (Other language bindings "
31129 "turn these errors into exceptions)."
31130 msgstr ""
31131
31132 #. type: textblock
31133 #: ../src/guestfs.pod:233
31134 msgid ""
31135 "File writes are affected by the per-handle umask, set by calling "
31136 "L</guestfs_umask> and defaulting to 022.  See L</UMASK>."
31137 msgstr ""
31138
31139 #. type: =head2
31140 #: ../src/guestfs.pod:236
31141 msgid "PARTITIONING"
31142 msgstr ""
31143
31144 #. type: textblock
31145 #: ../src/guestfs.pod:238
31146 msgid ""
31147 "Libguestfs contains API calls to read, create and modify partition tables on "
31148 "disk images."
31149 msgstr ""
31150
31151 #. type: textblock
31152 #: ../src/guestfs.pod:241
31153 msgid ""
31154 "In the common case where you want to create a single partition covering the "
31155 "whole disk, you should use the L</guestfs_part_disk> call:"
31156 msgstr ""
31157
31158 #. type: verbatim
31159 #: ../src/guestfs.pod:245
31160 #, no-wrap
31161 msgid ""
31162 " const char *parttype = \"mbr\";\n"
31163 " if (disk_is_larger_than_2TB)\n"
31164 "   parttype = \"gpt\";\n"
31165 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
31166 "\n"
31167 msgstr ""
31168
31169 #. type: textblock
31170 #: ../src/guestfs.pod:250
31171 msgid ""
31172 "Obviously this effectively wipes anything that was on that disk image "
31173 "before."
31174 msgstr ""
31175
31176 #. type: =head2
31177 #: ../src/guestfs.pod:253
31178 msgid "LVM2"
31179 msgstr ""
31180
31181 #. type: textblock
31182 #: ../src/guestfs.pod:255
31183 msgid ""
31184 "Libguestfs provides access to a large part of the LVM2 API, such as "
31185 "L</guestfs_lvcreate> and L</guestfs_vgremove>.  It won't make much sense "
31186 "unless you familiarize yourself with the concepts of physical volumes, "
31187 "volume groups and logical volumes."
31188 msgstr ""
31189
31190 #. type: textblock
31191 #: ../src/guestfs.pod:260
31192 msgid ""
31193 "This author strongly recommends reading the LVM HOWTO, online at "
31194 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
31195 msgstr ""
31196
31197 #. type: =head2
31198 #: ../src/guestfs.pod:263
31199 msgid "DOWNLOADING"
31200 msgstr ""
31201
31202 #. type: textblock
31203 #: ../src/guestfs.pod:265
31204 msgid ""
31205 "Use L</guestfs_cat> to download small, text only files.  This call is "
31206 "limited to files which are less than 2 MB and which cannot contain any ASCII "
31207 "NUL (C<\\0>) characters.  However the API is very simple to use."
31208 msgstr ""
31209
31210 #. type: textblock
31211 #: ../src/guestfs.pod:269
31212 msgid ""
31213 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
31214 "bit data, since it returns a (pointer, size) pair.  However it is still "
31215 "limited to \"small\" files, less than 2 MB."
31216 msgstr ""
31217
31218 #. type: textblock
31219 #: ../src/guestfs.pod:273
31220 msgid ""
31221 "L</guestfs_download> can be used to download any file, with no limits on "
31222 "content or size (even files larger than 4 GB)."
31223 msgstr ""
31224
31225 #. type: textblock
31226 #: ../src/guestfs.pod:276
31227 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
31228 msgstr ""
31229
31230 #. type: =head2
31231 #: ../src/guestfs.pod:279
31232 msgid "UPLOADING"
31233 msgstr ""
31234
31235 #. type: textblock
31236 #: ../src/guestfs.pod:281
31237 msgid ""
31238 "It's often the case that you want to write a file or files to the disk "
31239 "image."
31240 msgstr ""
31241
31242 #. type: textblock
31243 #: ../src/guestfs.pod:284
31244 msgid ""
31245 "To write a small file with fixed content, use L</guestfs_write>.  To create "
31246 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
31247 "L</guestfs_fallocate64> (with all disk blocks allocated).  There are a "
31248 "variety of other functions for creating test files, for example "
31249 "L</guestfs_fill> and L</guestfs_fill_pattern>."
31250 msgstr ""
31251
31252 #. type: textblock
31253 #: ../src/guestfs.pod:290
31254 msgid ""
31255 "To upload a single file, use L</guestfs_upload>.  This call has no limits on "
31256 "file content or size (even files larger than 4 GB)."
31257 msgstr ""
31258
31259 #. type: textblock
31260 #: ../src/guestfs.pod:293
31261 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
31262 msgstr ""
31263
31264 #. type: textblock
31265 #: ../src/guestfs.pod:295
31266 msgid ""
31267 "However the fastest way to upload I<large numbers of arbitrary files> is to "
31268 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
31269 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>.  If you add "
31270 "the drive in a predictable way (eg. adding it last after all other drives) "
31271 "then you can get the device name from L</guestfs_list_devices> and mount it "
31272 "directly using L</guestfs_mount_ro>.  Note that squashfs images are "
31273 "sometimes non-portable between kernel versions, and they don't support "
31274 "labels or UUIDs.  If you want to pre-build an image or you need to mount it "
31275 "using a label or UUID, use an ISO image instead."
31276 msgstr ""
31277
31278 #. type: =head2
31279 #: ../src/guestfs.pod:306
31280 msgid "COPYING"
31281 msgstr ""
31282
31283 #. type: textblock
31284 #: ../src/guestfs.pod:308
31285 msgid ""
31286 "There are various different commands for copying between files and devices "
31287 "and in and out of the guest filesystem.  These are summarised in the table "
31288 "below."
31289 msgstr ""
31290
31291 #. type: =item
31292 #: ../src/guestfs.pod:314
31293 msgid "B<file> to B<file>"
31294 msgstr ""
31295
31296 #. type: textblock
31297 #: ../src/guestfs.pod:316
31298 msgid ""
31299 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
31300 "directories recursively."
31301 msgstr ""
31302
31303 #. type: =item
31304 #: ../src/guestfs.pod:319
31305 msgid "B<file or device> to B<file or device>"
31306 msgstr ""
31307
31308 #. type: textblock
31309 #: ../src/guestfs.pod:321
31310 msgid ""
31311 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
31312 "devices in the guest."
31313 msgstr ""
31314
31315 #. type: textblock
31316 #: ../src/guestfs.pod:324
31317 msgid "Example: duplicate the contents of an LV:"
31318 msgstr ""
31319
31320 #. type: verbatim
31321 #: ../src/guestfs.pod:326
31322 #, no-wrap
31323 msgid ""
31324 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
31325 "\n"
31326 msgstr ""
31327
31328 #. type: textblock
31329 #: ../src/guestfs.pod:328
31330 msgid ""
31331 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
31332 "(C</dev/VG/Original>).  To copy less than the whole source device, use "
31333 "L</guestfs_copy_size>."
31334 msgstr ""
31335
31336 #. type: =item
31337 #: ../src/guestfs.pod:332
31338 msgid "B<file on the host> to B<file or device>"
31339 msgstr ""
31340
31341 #. type: textblock
31342 #: ../src/guestfs.pod:334
31343 msgid "Use L</guestfs_upload>.  See L</UPLOADING> above."
31344 msgstr ""
31345
31346 #. type: =item
31347 #: ../src/guestfs.pod:336
31348 msgid "B<file or device> to B<file on the host>"
31349 msgstr ""
31350
31351 #. type: textblock
31352 #: ../src/guestfs.pod:338
31353 msgid "Use L</guestfs_download>.  See L</DOWNLOADING> above."
31354 msgstr ""
31355
31356 #. type: =head2
31357 #: ../src/guestfs.pod:342
31358 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
31359 msgstr ""
31360
31361 #. type: textblock
31362 #: ../src/guestfs.pod:344
31363 msgid ""
31364 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
31365 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
31366 "appears you can only upload and download to files.  However many Un*x-like "
31367 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
31368 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
31369 "stderr, and arbitrary file descriptor N."
31370 msgstr ""
31371
31372 #. type: textblock
31373 #: ../src/guestfs.pod:352
31374 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
31375 msgstr ""
31376
31377 #. type: verbatim
31378 #: ../src/guestfs.pod:355
31379 #, no-wrap
31380 msgid ""
31381 " guestfs_download (g, filename, \"/dev/stdout\");\n"
31382 "\n"
31383 msgstr ""
31384
31385 #. type: textblock
31386 #: ../src/guestfs.pod:357
31387 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
31388 msgstr ""
31389
31390 #. type: verbatim
31391 #: ../src/guestfs.pod:359
31392 #, no-wrap
31393 msgid ""
31394 " char devfd[64];\n"
31395 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
31396 " guestfs_tar_out (g, \"/\", devfd);\n"
31397 "\n"
31398 msgstr ""
31399
31400 #. type: =head2
31401 #: ../src/guestfs.pod:363
31402 msgid "LISTING FILES"
31403 msgstr ""
31404
31405 #. type: textblock
31406 #: ../src/guestfs.pod:365
31407 msgid ""
31408 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
31409 "L<guestfish(1)>-equivalent command C<ll>)."
31410 msgstr ""
31411
31412 #. type: textblock
31413 #: ../src/guestfs.pod:368
31414 msgid ""
31415 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
31416 "programs, as a flat list of strings."
31417 msgstr ""
31418
31419 #. type: textblock
31420 #: ../src/guestfs.pod:371
31421 msgid ""
31422 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
31423 "directory, plus additional information about each one.  It is more "
31424 "equivalent to using the L<readdir(3)> call on a local filesystem."
31425 msgstr ""
31426
31427 #. type: textblock
31428 #: ../src/guestfs.pod:375
31429 msgid ""
31430 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
31431 "files."
31432 msgstr ""
31433
31434 #. type: =head2
31435 #: ../src/guestfs.pod:378
31436 msgid "RUNNING COMMANDS"
31437 msgstr ""
31438
31439 #. type: textblock
31440 #: ../src/guestfs.pod:380
31441 msgid ""
31442 "Although libguestfs is primarily an API for manipulating files inside guest "
31443 "images, we also provide some limited facilities for running commands inside "
31444 "guests."
31445 msgstr ""
31446
31447 #. type: textblock
31448 #: ../src/guestfs.pod:384
31449 msgid "There are many limitations to this:"
31450 msgstr ""
31451
31452 #. type: textblock
31453 #: ../src/guestfs.pod:390
31454 msgid ""
31455 "The kernel version that the command runs under will be different from what "
31456 "it expects."
31457 msgstr ""
31458
31459 #. type: textblock
31460 #: ../src/guestfs.pod:395
31461 msgid ""
31462 "If the command needs to communicate with daemons, then most likely they "
31463 "won't be running."
31464 msgstr ""
31465
31466 #. type: textblock
31467 #: ../src/guestfs.pod:400
31468 msgid "The command will be running in limited memory."
31469 msgstr ""
31470
31471 #. type: textblock
31472 #: ../src/guestfs.pod:404
31473 msgid ""
31474 "The network may not be available unless you enable it (see "
31475 "L</guestfs_set_network>)."
31476 msgstr ""
31477
31478 #. type: textblock
31479 #: ../src/guestfs.pod:409
31480 msgid "Only supports Linux guests (not Windows, BSD, etc)."
31481 msgstr ""
31482
31483 #. type: textblock
31484 #: ../src/guestfs.pod:413
31485 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
31486 msgstr ""
31487
31488 #. type: textblock
31489 #: ../src/guestfs.pod:418
31490 msgid ""
31491 "For SELinux guests, you may need to enable SELinux and load policy first.  "
31492 "See L</SELINUX> in this manpage."
31493 msgstr ""
31494
31495 #. type: textblock
31496 #: ../src/guestfs.pod:423
31497 msgid ""
31498 "I<Security:> It is not safe to run commands from untrusted, possibly "
31499 "malicious guests.  These commands may attempt to exploit your program by "
31500 "sending unexpected output.  They could also try to exploit the Linux kernel "
31501 "or qemu provided by the libguestfs appliance.  They could use the network "
31502 "provided by the libguestfs appliance to bypass ordinary network partitions "
31503 "and firewalls.  They could use the elevated privileges or different SELinux "
31504 "context of your program to their advantage."
31505 msgstr ""
31506
31507 #. type: textblock
31508 #: ../src/guestfs.pod:432
31509 msgid ""
31510 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
31511 "(a script which runs when the guest next boots normally), and to have this "
31512 "script run the commands you want in the normal context of the running guest, "
31513 "network security and so on.  For information about other security issues, "
31514 "see L</SECURITY>."
31515 msgstr ""
31516
31517 #. type: textblock
31518 #: ../src/guestfs.pod:440
31519 msgid ""
31520 "The two main API calls to run commands are L</guestfs_command> and "
31521 "L</guestfs_sh> (there are also variations)."
31522 msgstr ""
31523
31524 #. type: textblock
31525 #: ../src/guestfs.pod:443
31526 msgid ""
31527 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
31528 "shell globs, redirections, etc will work."
31529 msgstr ""
31530
31531 #. type: =head2
31532 #: ../src/guestfs.pod:446
31533 msgid "CONFIGURATION FILES"
31534 msgstr ""
31535
31536 #. type: textblock
31537 #: ../src/guestfs.pod:448
31538 msgid ""
31539 "To read and write configuration files in Linux guest filesystems, we "
31540 "strongly recommend using Augeas.  For example, Augeas understands how to "
31541 "read and write, say, a Linux shadow password file or X.org configuration "
31542 "file, and so avoids you having to write that code."
31543 msgstr ""
31544
31545 #. type: textblock
31546 #: ../src/guestfs.pod:453
31547 msgid ""
31548 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs.  We don't "
31549 "document Augeas itself here because there is excellent documentation on the "
31550 "L<http://augeas.net/> website."
31551 msgstr ""
31552
31553 #. type: textblock
31554 #: ../src/guestfs.pod:457
31555 msgid ""
31556 "If you don't want to use Augeas (you fool!) then try calling "
31557 "L</guestfs_read_lines> to get the file as a list of lines which you can "
31558 "iterate over."
31559 msgstr ""
31560
31561 #. type: =head2
31562 #: ../src/guestfs.pod:461
31563 msgid "SELINUX"
31564 msgstr ""
31565
31566 #. type: textblock
31567 #: ../src/guestfs.pod:463
31568 msgid ""
31569 "We support SELinux guests.  To ensure that labeling happens correctly in "
31570 "SELinux guests, you need to enable SELinux and load the guest's policy:"
31571 msgstr ""
31572
31573 #. type: textblock
31574 #: ../src/guestfs.pod:471
31575 msgid "Before launching, do:"
31576 msgstr ""
31577
31578 #. type: verbatim
31579 #: ../src/guestfs.pod:473
31580 #, no-wrap
31581 msgid ""
31582 " guestfs_set_selinux (g, 1);\n"
31583 "\n"
31584 msgstr ""
31585
31586 #. type: textblock
31587 #: ../src/guestfs.pod:477
31588 msgid ""
31589 "After mounting the guest's filesystem(s), load the policy.  This is best "
31590 "done by running the L<load_policy(8)> command in the guest itself:"
31591 msgstr ""
31592
31593 #. type: verbatim
31594 #: ../src/guestfs.pod:481
31595 #, no-wrap
31596 msgid ""
31597 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
31598 "\n"
31599 msgstr ""
31600
31601 #. type: textblock
31602 #: ../src/guestfs.pod:483
31603 msgid ""
31604 "(Older versions of C<load_policy> require you to specify the name of the "
31605 "policy file)."
31606 msgstr ""
31607
31608 #. type: textblock
31609 #: ../src/guestfs.pod:488
31610 msgid ""
31611 "Optionally, set the security context for the API.  The correct security "
31612 "context to use can only be known by inspecting the guest.  As an example:"
31613 msgstr ""
31614
31615 #. type: verbatim
31616 #: ../src/guestfs.pod:492
31617 #, no-wrap
31618 msgid ""
31619 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
31620 "\n"
31621 msgstr ""
31622
31623 #. type: textblock
31624 #: ../src/guestfs.pod:496
31625 msgid "This will work for running commands and editing existing files."
31626 msgstr ""
31627
31628 #. type: textblock
31629 #: ../src/guestfs.pod:498
31630 msgid ""
31631 "When new files are created, you may need to label them explicitly, for "
31632 "example by running the external command C<restorecon pathname>."
31633 msgstr ""
31634
31635 #. type: =head2
31636 #: ../src/guestfs.pod:502
31637 msgid "UMASK"
31638 msgstr ""
31639
31640 #. type: textblock
31641 #: ../src/guestfs.pod:504
31642 msgid ""
31643 "Certain calls are affected by the current file mode creation mask (the "
31644 "\"umask\").  In particular ones which create files or directories, such as "
31645 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>.  This affects "
31646 "either the default mode that the file is created with or modifies the mode "
31647 "that you supply."
31648 msgstr ""
31649
31650 #. type: textblock
31651 #: ../src/guestfs.pod:510
31652 msgid ""
31653 "The default umask is C<022>, so files are created with modes such as C<0644> "
31654 "and directories with C<0755>."
31655 msgstr ""
31656
31657 #. type: textblock
31658 #: ../src/guestfs.pod:513
31659 msgid ""
31660 "There are two ways to avoid being affected by umask.  Either set umask to 0 "
31661 "(call C<guestfs_umask (g, 0)> early after launching).  Or call "
31662 "L</guestfs_chmod> after creating each file or directory."
31663 msgstr ""
31664
31665 #. type: textblock
31666 #: ../src/guestfs.pod:517
31667 msgid "For more information about umask, see L<umask(2)>."
31668 msgstr ""
31669
31670 #. type: textblock
31671 #: ../src/guestfs.pod:521
31672 msgid ""
31673 "Libguestfs allows you to access Linux guests which have been encrypted using "
31674 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
31675 "standard.  This includes nearly all whole disk encryption systems used by "
31676 "modern Linux guests."
31677 msgstr ""
31678
31679 #. type: textblock
31680 #: ../src/guestfs.pod:527
31681 msgid ""
31682 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
31683 "returns the string C<crypto_LUKS>)."
31684 msgstr ""
31685
31686 #. type: textblock
31687 #: ../src/guestfs.pod:530
31688 msgid ""
31689 "Then open these devices by calling L</guestfs_luks_open>.  Obviously you "
31690 "will require the passphrase!"
31691 msgstr ""
31692
31693 #. type: textblock
31694 #: ../src/guestfs.pod:533
31695 msgid ""
31696 "Opening a LUKS device creates a new device mapper device called "
31697 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
31698 "L</guestfs_luks_open>).  Reads and writes to this mapper device are "
31699 "decrypted from and encrypted to the underlying block device respectively."
31700 msgstr ""
31701
31702 #. type: textblock
31703 #: ../src/guestfs.pod:539
31704 msgid ""
31705 "LVM volume groups on the device can be made visible by calling "
31706 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>.  The logical "
31707 "volume(s) can now be mounted in the usual way."
31708 msgstr ""
31709
31710 #. type: textblock
31711 #: ../src/guestfs.pod:543
31712 msgid ""
31713 "Use the reverse process to close a LUKS device.  Unmount any logical volumes "
31714 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
31715 "[\"/dev/VG\"])>.  Then close the mapper device by calling "
31716 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
31717 "underlying encrypted block device)."
31718 msgstr ""
31719
31720 #. type: =head2
31721 #: ../src/guestfs.pod:550
31722 msgid "INSPECTION"
31723 msgstr ""
31724
31725 #. type: textblock
31726 #: ../src/guestfs.pod:552
31727 msgid ""
31728 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
31729 "contains operating systems, an install CD or a live CD.  (These APIs used to "
31730 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
31731 "version 1.5.3 the most frequently used part of this library has been "
31732 "rewritten in C and moved into the core code)."
31733 msgstr ""
31734
31735 #. type: textblock
31736 #: ../src/guestfs.pod:559
31737 msgid ""
31738 "Add all disks belonging to the unknown virtual machine and call "
31739 "L</guestfs_launch> in the usual way."
31740 msgstr ""
31741
31742 #. type: textblock
31743 #: ../src/guestfs.pod:562
31744 msgid ""
31745 "Then call L</guestfs_inspect_os>.  This function uses other libguestfs calls "
31746 "and certain heuristics, and returns a list of operating systems that were "
31747 "found.  An empty list means none were found.  A single element is the root "
31748 "filesystem of the operating system.  For dual- or multi-boot guests, "
31749 "multiple roots can be returned, each one corresponding to a separate "
31750 "operating system.  (Multi-boot virtual machines are extremely rare in the "
31751 "world of virtualization, but since this scenario can happen, we have built "
31752 "libguestfs to deal with it.)"
31753 msgstr ""
31754
31755 #. type: textblock
31756 #: ../src/guestfs.pod:571
31757 msgid ""
31758 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
31759 "to get additional details about that operating system.  For example, call "
31760 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
31761 "Windows and Linux-based operating systems respectively."
31762 msgstr ""
31763
31764 #. type: textblock
31765 #: ../src/guestfs.pod:577
31766 msgid ""
31767 "Un*x-like and Linux-based operating systems usually consist of several "
31768 "filesystems which are mounted at boot time (for example, a separate boot "
31769 "partition mounted on C</boot>).  The inspection rules are able to detect how "
31770 "filesystems correspond to mount points.  Call "
31771 "C<guestfs_inspect_get_mountpoints> to get this mapping.  It might return a "
31772 "hash table like this example:"
31773 msgstr ""
31774
31775 #. type: verbatim
31776 #: ../src/guestfs.pod:584
31777 #, no-wrap
31778 msgid ""
31779 " /boot => /dev/sda1\n"
31780 " /     => /dev/vg_guest/lv_root\n"
31781 " /usr  => /dev/vg_guest/lv_usr\n"
31782 "\n"
31783 msgstr ""
31784
31785 #. type: textblock
31786 #: ../src/guestfs.pod:588
31787 msgid ""
31788 "The caller can then make calls to L</guestfs_mount_options> to mount the "
31789 "filesystems as suggested."
31790 msgstr ""
31791
31792 #. type: textblock
31793 #: ../src/guestfs.pod:591
31794 msgid ""
31795 "Be careful to mount filesystems in the right order (eg. C</> before "
31796 "C</usr>).  Sorting the keys of the hash by length, shortest first, should "
31797 "work."
31798 msgstr ""
31799
31800 #. type: textblock
31801 #: ../src/guestfs.pod:595
31802 msgid ""
31803 "Inspection currently only works for some common operating systems.  "
31804 "Contributors are welcome to send patches for other operating systems that we "
31805 "currently cannot detect."
31806 msgstr ""
31807
31808 #. type: textblock
31809 #: ../src/guestfs.pod:599
31810 msgid ""
31811 "Encrypted disks must be opened before inspection.  See L</ENCRYPTED DISKS> "
31812 "for more details.  The L</guestfs_inspect_os> function just ignores any "
31813 "encrypted devices."
31814 msgstr ""
31815
31816 #. type: textblock
31817 #: ../src/guestfs.pod:603
31818 msgid ""
31819 "A note on the implementation: The call L</guestfs_inspect_os> performs "
31820 "inspection and caches the results in the guest handle.  Subsequent calls to "
31821 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
31822 "re-read the disks.  If you change the content of the guest disks, you can "
31823 "redo inspection by calling L</guestfs_inspect_os> again.  "
31824 "(L</guestfs_inspect_list_applications> works a little differently from the "
31825 "other calls and does read the disks.  See documentation for that function "
31826 "for details)."
31827 msgstr ""
31828
31829 #. type: =head3
31830 #: ../src/guestfs.pod:612
31831 msgid "INSPECTING INSTALL DISKS"
31832 msgstr ""
31833
31834 #. type: textblock
31835 #: ../src/guestfs.pod:614
31836 msgid ""
31837 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
31838 "CDs and more."
31839 msgstr ""
31840
31841 #. type: textblock
31842 #: ../src/guestfs.pod:617
31843 msgid ""
31844 "Call L</guestfs_inspect_get_format> to return the format of the operating "
31845 "system, which currently can be C<installed> (a regular operating system) or "
31846 "C<installer> (some sort of install disk)."
31847 msgstr ""
31848
31849 #. type: textblock
31850 #: ../src/guestfs.pod:621
31851 msgid ""
31852 "Further information is available about the operating system that can be "
31853 "installed using the regular inspection APIs like "
31854 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
31855 "etc."
31856 msgstr ""
31857
31858 #. type: textblock
31859 #: ../src/guestfs.pod:626
31860 msgid ""
31861 "Some additional information specific to installer disks is also available "
31862 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
31863 "L</guestfs_inspect_is_multipart> calls."
31864 msgstr ""
31865
31866 #. type: =head2
31867 #: ../src/guestfs.pod:631
31868 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
31869 msgstr ""
31870
31871 #. type: textblock
31872 #: ../src/guestfs.pod:633
31873 msgid ""
31874 "Libguestfs can mount NTFS partitions.  It does this using the "
31875 "L<http://www.ntfs-3g.org/> driver."
31876 msgstr ""
31877
31878 #. type: =head3
31879 #: ../src/guestfs.pod:636
31880 msgid "DRIVE LETTERS AND PATHS"
31881 msgstr ""
31882
31883 #. type: textblock
31884 #: ../src/guestfs.pod:638
31885 msgid ""
31886 "DOS and Windows still use drive letters, and the filesystems are always "
31887 "treated as case insensitive by Windows itself, and therefore you might find "
31888 "a Windows configuration file referring to a path like "
31889 "C<c:\\windows\\system32>.  When the filesystem is mounted in libguestfs, "
31890 "that directory might be referred to as C</WINDOWS/System32>."
31891 msgstr ""
31892
31893 #. type: textblock
31894 #: ../src/guestfs.pod:644
31895 msgid ""
31896 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
31897 "L</guestfs_inspect_get_drive_mappings>)"
31898 msgstr ""
31899
31900 #. type: textblock
31901 #: ../src/guestfs.pod:647
31902 msgid ""
31903 "Dealing with separator characters (backslash vs forward slash) is outside "
31904 "the scope of libguestfs, but usually a simple character replacement will "
31905 "work."
31906 msgstr ""
31907
31908 #. type: textblock
31909 #: ../src/guestfs.pod:651
31910 msgid ""
31911 "To resolve the case insensitivity of paths, call "
31912 "L</guestfs_case_sensitive_path>."
31913 msgstr ""
31914
31915 #. type: =head3
31916 #: ../src/guestfs.pod:654
31917 msgid "ACCESSING THE WINDOWS REGISTRY"
31918 msgstr ""
31919
31920 #. type: textblock
31921 #: ../src/guestfs.pod:656
31922 msgid ""
31923 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
31924 "files, through the library C<hivex> which is part of the libguestfs project "
31925 "although ships as a separate tarball.  You have to locate and download the "
31926 "hive file(s) yourself, and then pass them to C<hivex> functions.  See also "
31927 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
31928 "L<virt-win-reg(1)> for more help on this issue."
31929 msgstr ""
31930
31931 #. type: =head3
31932 #: ../src/guestfs.pod:664
31933 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
31934 msgstr ""
31935
31936 #. type: textblock
31937 #: ../src/guestfs.pod:666
31938 msgid ""
31939 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
31940 "provide something which looks like a Linux symlink.  The way it tries to do "
31941 "the rewriting is described here:"
31942 msgstr ""
31943
31944 #. type: textblock
31945 #: ../src/guestfs.pod:670
31946 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
31947 msgstr ""
31948
31949 #. type: textblock
31950 #: ../src/guestfs.pod:672
31951 msgid ""
31952 "The essential problem is that ntfs-3g simply does not have enough "
31953 "information to do a correct job.  NTFS links can contain drive letters and "
31954 "references to external device GUIDs that ntfs-3g has no way of resolving.  "
31955 "It is almost certainly the case that libguestfs callers should ignore what "
31956 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
31957 msgstr ""
31958
31959 #. type: textblock
31960 #: ../src/guestfs.pod:679
31961 msgid ""
31962 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
31963 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
31964 "attribute, and read the raw reparse data from that (you can find the format "
31965 "documented in various places around the web)."
31966 msgstr ""
31967
31968 #. type: =head3
31969 #: ../src/guestfs.pod:684
31970 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
31971 msgstr ""
31972
31973 #. type: textblock
31974 #: ../src/guestfs.pod:686
31975 msgid ""
31976 "There are other useful extended attributes that can be read from ntfs-3g "
31977 "filesystems (using L</guestfs_getxattr>).  See:"
31978 msgstr ""
31979
31980 #. type: textblock
31981 #: ../src/guestfs.pod:689
31982 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
31983 msgstr ""
31984
31985 #. type: =head2
31986 #: ../src/guestfs.pod:691
31987 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
31988 msgstr ""
31989
31990 #. type: textblock
31991 #: ../src/guestfs.pod:693
31992 msgid ""
31993 "Although we don't want to discourage you from using the C API, we will "
31994 "mention here that the same API is also available in other languages."
31995 msgstr ""
31996
31997 #. type: textblock
31998 #: ../src/guestfs.pod:696
31999 msgid ""
32000 "The API is broadly identical in all supported languages.  This means that "
32001 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
32002 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
32003 "OCaml.  In other words, a straightforward, predictable isomorphism between "
32004 "each language."
32005 msgstr ""
32006
32007 #. type: textblock
32008 #: ../src/guestfs.pod:702
32009 msgid ""
32010 "Error messages are automatically transformed into exceptions if the language "
32011 "supports it."
32012 msgstr ""
32013
32014 #. type: textblock
32015 #: ../src/guestfs.pod:705
32016 msgid ""
32017 "We don't try to \"object orientify\" parts of the API in OO languages, "
32018 "although contributors are welcome to write higher level APIs above what we "
32019 "provide in their favourite languages if they wish."
32020 msgstr ""
32021
32022 #. type: =item
32023 #: ../src/guestfs.pod:711
32024 msgid "B<C++>"
32025 msgstr ""
32026
32027 #. type: textblock
32028 #: ../src/guestfs.pod:713
32029 msgid ""
32030 "You can use the I<guestfs.h> header file from C++ programs.  The C++ API is "
32031 "identical to the C API.  C++ classes and exceptions are not used."
32032 msgstr ""
32033
32034 #. type: =item
32035 #: ../src/guestfs.pod:717
32036 msgid "B<C#>"
32037 msgstr ""
32038
32039 #. type: textblock
32040 #: ../src/guestfs.pod:719
32041 msgid ""
32042 "The C# bindings are highly experimental.  Please read the warnings at the "
32043 "top of C<csharp/Libguestfs.cs>."
32044 msgstr ""
32045
32046 #. type: =item
32047 #: ../src/guestfs.pod:722
32048 msgid "B<Erlang>"
32049 msgstr ""
32050
32051 #. type: textblock
32052 #: ../src/guestfs.pod:724
32053 msgid "See L<guestfs-erlang(3)>."
32054 msgstr ""
32055
32056 #. type: =item
32057 #: ../src/guestfs.pod:726
32058 msgid "B<Haskell>"
32059 msgstr ""
32060
32061 #. type: textblock
32062 #: ../src/guestfs.pod:728
32063 msgid ""
32064 "This is the only language binding that is working but incomplete.  Only "
32065 "calls which return simple integers have been bound in Haskell, and we are "
32066 "looking for help to complete this binding."
32067 msgstr ""
32068
32069 #. type: =item
32070 #: ../src/guestfs.pod:732
32071 msgid "B<Java>"
32072 msgstr ""
32073
32074 #. type: textblock
32075 #: ../src/guestfs.pod:734
32076 msgid ""
32077 "Full documentation is contained in the Javadoc which is distributed with "
32078 "libguestfs.  For examples, see L<guestfs-java(3)>."
32079 msgstr ""
32080
32081 #. type: =item
32082 #: ../src/guestfs.pod:737
32083 msgid "B<OCaml>"
32084 msgstr ""
32085
32086 #. type: textblock
32087 #: ../src/guestfs.pod:739
32088 msgid "See L<guestfs-ocaml(3)>."
32089 msgstr ""
32090
32091 #. type: =item
32092 #: ../src/guestfs.pod:741
32093 msgid "B<Perl>"
32094 msgstr ""
32095
32096 #. type: textblock
32097 #: ../src/guestfs.pod:743
32098 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
32099 msgstr ""
32100
32101 #. type: =item
32102 #: ../src/guestfs.pod:745
32103 msgid "B<PHP>"
32104 msgstr ""
32105
32106 #. type: textblock
32107 #: ../src/guestfs.pod:747
32108 msgid ""
32109 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
32110 "the php-libguestfs package for your distribution."
32111 msgstr ""
32112
32113 #. type: textblock
32114 #: ../src/guestfs.pod:750
32115 msgid "The PHP binding only works correctly on 64 bit machines."
32116 msgstr ""
32117
32118 #. type: =item
32119 #: ../src/guestfs.pod:752
32120 msgid "B<Python>"
32121 msgstr ""
32122
32123 #. type: textblock
32124 #: ../src/guestfs.pod:754
32125 msgid "See L<guestfs-python(3)>."
32126 msgstr ""
32127
32128 #. type: =item
32129 #: ../src/guestfs.pod:756
32130 msgid "B<Ruby>"
32131 msgstr ""
32132
32133 #. type: textblock
32134 #: ../src/guestfs.pod:758
32135 msgid "See L<guestfs-ruby(3)>."
32136 msgstr ""
32137
32138 #. type: =item
32139 #: ../src/guestfs.pod:760
32140 msgid "B<shell scripts>"
32141 msgstr ""
32142
32143 #. type: textblock
32144 #: ../src/guestfs.pod:762
32145 msgid "See L<guestfish(1)>."
32146 msgstr ""
32147
32148 #. type: =head2
32149 #: ../src/guestfs.pod:766
32150 msgid "LIBGUESTFS GOTCHAS"
32151 msgstr ""
32152
32153 #. type: textblock
32154 #: ../src/guestfs.pod:768
32155 msgid ""
32156 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
32157 "system [...] that works in the way it is documented but is counterintuitive "
32158 "and almost invites mistakes.\""
32159 msgstr ""
32160
32161 #. type: textblock
32162 #: ../src/guestfs.pod:772
32163 msgid ""
32164 "Since we developed libguestfs and the associated tools, there are several "
32165 "things we would have designed differently, but are now stuck with for "
32166 "backwards compatibility or other reasons.  If there is ever a libguestfs 2.0 "
32167 "release, you can expect these to change.  Beware of them."
32168 msgstr ""
32169
32170 #. type: =item
32171 #: ../src/guestfs.pod:780
32172 msgid "Autosync / forgetting to sync."
32173 msgstr ""
32174
32175 #. type: textblock
32176 #: ../src/guestfs.pod:782
32177 msgid ""
32178 "I<Update:> Autosync is enabled by default for all API users starting from "
32179 "libguestfs 1.5.24.  This section only applies to older versions."
32180 msgstr ""
32181
32182 #. type: textblock
32183 #: ../src/guestfs.pod:785
32184 msgid ""
32185 "When modifying a filesystem from C or another language, you B<must> unmount "
32186 "all filesystems and call L</guestfs_sync> explicitly before you close the "
32187 "libguestfs handle.  You can also call:"
32188 msgstr ""
32189
32190 #. type: verbatim
32191 #: ../src/guestfs.pod:789
32192 #, no-wrap
32193 msgid ""
32194 " guestfs_set_autosync (g, 1);\n"
32195 "\n"
32196 msgstr ""
32197
32198 #. type: textblock
32199 #: ../src/guestfs.pod:791
32200 msgid ""
32201 "to have the unmount/sync done automatically for you when the handle 'g' is "
32202 "closed.  (This feature is called \"autosync\", L</guestfs_set_autosync> "
32203 "q.v.)"
32204 msgstr ""
32205
32206 #. type: textblock
32207 #: ../src/guestfs.pod:795
32208 msgid ""
32209 "If you forget to do this, then it is entirely possible that your changes "
32210 "won't be written out, or will be partially written, or (very rarely) that "
32211 "you'll get disk corruption."
32212 msgstr ""
32213
32214 #. type: textblock
32215 #: ../src/guestfs.pod:799
32216 msgid ""
32217 "Note that in L<guestfish(3)> autosync is the default.  So quick and dirty "
32218 "guestfish scripts that forget to sync will work just fine, which can make "
32219 "this very puzzling if you are trying to debug a problem."
32220 msgstr ""
32221
32222 #. type: =item
32223 #: ../src/guestfs.pod:803
32224 msgid "Mount option C<-o sync> should not be the default."
32225 msgstr ""
32226
32227 #. type: textblock
32228 #: ../src/guestfs.pod:805
32229 msgid ""
32230 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly.  "
32231 "However C<-o sync> does not add any reliability benefit, but does have a "
32232 "very large performance impact."
32233 msgstr ""
32234
32235 #. type: textblock
32236 #: ../src/guestfs.pod:809
32237 msgid ""
32238 "The work around is to use L</guestfs_mount_options> and set the mount "
32239 "options that you actually want to use."
32240 msgstr ""
32241
32242 #. type: =item
32243 #: ../src/guestfs.pod:812
32244 msgid "Read-only should be the default."
32245 msgstr ""
32246
32247 #. type: textblock
32248 #: ../src/guestfs.pod:814
32249 msgid ""
32250 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
32251 "specify I<--rw> if you want to make changes to the image."
32252 msgstr ""
32253
32254 #. type: textblock
32255 #: ../src/guestfs.pod:817
32256 msgid "This would reduce the potential to corrupt live VM images."
32257 msgstr ""
32258
32259 #. type: textblock
32260 #: ../src/guestfs.pod:819
32261 msgid ""
32262 "Note that many filesystems change the disk when you just mount and unmount, "
32263 "even if you didn't perform any writes.  You need to use "
32264 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
32265 msgstr ""
32266
32267 #. type: =item
32268 #: ../src/guestfs.pod:823
32269 msgid "guestfish command line is hard to use."
32270 msgstr ""
32271
32272 #. type: textblock
32273 #: ../src/guestfs.pod:825
32274 msgid ""
32275 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
32276 "examination).  It tries to run a guestfish command C<disk.img> which doesn't "
32277 "exist, so it fails.  In earlier versions of guestfish the error message was "
32278 "also unintuitive, but we have corrected this since.  Like the Bourne shell, "
32279 "we should have used C<guestfish -c command> to run commands."
32280 msgstr ""
32281
32282 #. type: =item
32283 #: ../src/guestfs.pod:832
32284 msgid "guestfish megabyte modifiers don't work right on all commands"
32285 msgstr ""
32286
32287 #. type: textblock
32288 #: ../src/guestfs.pod:834
32289 msgid ""
32290 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
32291 "other modifiers).  What guestfish actually does is to multiply the number "
32292 "part by the modifier part and pass the result to the C API.  However this "
32293 "doesn't work for a few APIs which aren't expecting bytes, but are already "
32294 "expecting some other unit (eg. megabytes)."
32295 msgstr ""
32296
32297 #. type: textblock
32298 #: ../src/guestfs.pod:841
32299 msgid "The most common is L</guestfs_lvcreate>.  The guestfish command:"
32300 msgstr ""
32301
32302 #. type: verbatim
32303 #: ../src/guestfs.pod:843
32304 #, no-wrap
32305 msgid ""
32306 " lvcreate LV VG 100M\n"
32307 "\n"
32308 msgstr ""
32309
32310 #. type: textblock
32311 #: ../src/guestfs.pod:845
32312 msgid ""
32313 "does not do what you might expect.  Instead because L</guestfs_lvcreate> is "
32314 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
32315 "megabytes * megabytes) logical volume.  The error message you get from this "
32316 "is also a little obscure."
32317 msgstr ""
32318
32319 #. type: textblock
32320 #: ../src/guestfs.pod:850
32321 msgid ""
32322 "This could be fixed in the generator by specially marking parameters and "
32323 "return values which take bytes or other units."
32324 msgstr ""
32325
32326 #. type: =item
32327 #: ../src/guestfs.pod:853
32328 msgid "Ambiguity between devices and paths"
32329 msgstr ""
32330
32331 #. type: textblock
32332 #: ../src/guestfs.pod:855
32333 msgid ""
32334 "There is a subtle ambiguity in the API between a device name "
32335 "(eg. C</dev/sdb2>) and a similar pathname.  A file might just happen to be "
32336 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
32337 msgstr ""
32338
32339 #. type: textblock
32340 #: ../src/guestfs.pod:860
32341 msgid ""
32342 "In the current API we usually resolve this ambiguity by having two separate "
32343 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>.  "
32344 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
32345 "detecting if the path supplied begins with C</dev/>."
32346 msgstr ""
32347
32348 #. type: textblock
32349 #: ../src/guestfs.pod:866
32350 msgid ""
32351 "To avoid both the ambiguity and the need to duplicate some calls, we could "
32352 "make paths/devices into structured names.  One way to do this would be to "
32353 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
32354 "aspect of grub.  Another way would be to use a structured type, equivalent "
32355 "to this OCaml type:"
32356 msgstr ""
32357
32358 #. type: verbatim
32359 #: ../src/guestfs.pod:872
32360 #, no-wrap
32361 msgid ""
32362 " type path = Path of string | Device of int | Partition of int * int\n"
32363 "\n"
32364 msgstr ""
32365
32366 #. type: textblock
32367 #: ../src/guestfs.pod:874
32368 msgid "which would allow you to pass arguments like:"
32369 msgstr ""
32370
32371 #. type: verbatim
32372 #: ../src/guestfs.pod:876
32373 #, no-wrap
32374 msgid ""
32375 " Path \"/foo/bar\"\n"
32376 " Device 1            (* /dev/sdb, or perhaps /dev/sda *)\n"
32377 " Partition (1, 2)    (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
32378 " Path \"/dev/sdb2\"    (* not a device *)\n"
32379 "\n"
32380 msgstr ""
32381
32382 #. type: textblock
32383 #: ../src/guestfs.pod:881
32384 msgid ""
32385 "As you can see there are still problems to resolve even with this "
32386 "representation.  Also consider how it might work in guestfish."
32387 msgstr ""
32388
32389 #. type: =head2
32390 #: ../src/guestfs.pod:886
32391 msgid "KEYS AND PASSPHRASES"
32392 msgstr ""
32393
32394 #. type: textblock
32395 #: ../src/guestfs.pod:888
32396 msgid ""
32397 "Certain libguestfs calls take a parameter that contains sensitive key "
32398 "material, passed in as a C string."
32399 msgstr ""
32400
32401 #. type: textblock
32402 #: ../src/guestfs.pod:891
32403 msgid ""
32404 "In the future we would hope to change the libguestfs implementation so that "
32405 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
32406 "swap.  However this is I<not> done at the moment, because of the complexity "
32407 "of such an implementation."
32408 msgstr ""
32409
32410 #. type: textblock
32411 #: ../src/guestfs.pod:896
32412 msgid ""
32413 "Therefore you should be aware that any key parameter you pass to libguestfs "
32414 "might end up being written out to the swap partition.  If this is a concern, "
32415 "scrub the swap partition or don't use libguestfs on encrypted devices."
32416 msgstr ""
32417
32418 #. type: =head2
32419 #: ../src/guestfs.pod:901
32420 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
32421 msgstr ""
32422
32423 #. type: textblock
32424 #: ../src/guestfs.pod:903
32425 msgid ""
32426 "All high-level libguestfs actions are synchronous.  If you want to use "
32427 "libguestfs asynchronously then you must create a thread."
32428 msgstr ""
32429
32430 #. type: textblock
32431 #: ../src/guestfs.pod:906
32432 msgid ""
32433 "Only use the handle from a single thread.  Either use the handle exclusively "
32434 "from one thread, or provide your own mutex so that two threads cannot issue "
32435 "calls on the same handle at the same time."
32436 msgstr ""
32437
32438 #. type: textblock
32439 #: ../src/guestfs.pod:910
32440 msgid ""
32441 "See the graphical program guestfs-browser for one possible architecture for "
32442 "multithreaded programs using libvirt and libguestfs."
32443 msgstr ""
32444
32445 #. type: =head2
32446 #: ../src/guestfs.pod:913
32447 msgid "PATH"
32448 msgstr ""
32449
32450 #. type: textblock
32451 #: ../src/guestfs.pod:915
32452 msgid ""
32453 "Libguestfs needs a supermin appliance, which it finds by looking along an "
32454 "internal path."
32455 msgstr ""
32456
32457 #. type: textblock
32458 #: ../src/guestfs.pod:918
32459 msgid ""
32460 "By default it looks for these in the directory C<$libdir/guestfs> "
32461 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
32462 msgstr ""
32463
32464 #. type: textblock
32465 #: ../src/guestfs.pod:921
32466 msgid ""
32467 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
32468 "to change the directories that libguestfs will search in.  The value is a "
32469 "colon-separated list of paths.  The current directory is I<not> searched "
32470 "unless the path contains an empty element or C<.>.  For example "
32471 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
32472 "then C</usr/lib/guestfs>."
32473 msgstr ""
32474
32475 #. type: =head2
32476 #: ../src/guestfs.pod:928
32477 msgid "QEMU WRAPPERS"
32478 msgstr ""
32479
32480 #. type: textblock
32481 #: ../src/guestfs.pod:930
32482 msgid ""
32483 "If you want to compile your own qemu, run qemu from a non-standard location, "
32484 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
32485 "around qemu."
32486 msgstr ""
32487
32488 #. type: textblock
32489 #: ../src/guestfs.pod:934
32490 msgid ""
32491 "There is one important rule to remember: you I<must C<exec qemu>> as the "
32492 "last command in the shell script (so that qemu replaces the shell and "
32493 "becomes the direct child of the libguestfs-using program).  If you don't do "
32494 "this, then the qemu process won't be cleaned up correctly."
32495 msgstr ""
32496
32497 #. type: textblock
32498 #: ../src/guestfs.pod:939
32499 msgid ""
32500 "Here is an example of a wrapper, where I have built my own copy of qemu from "
32501 "source:"
32502 msgstr ""
32503
32504 #. type: verbatim
32505 #: ../src/guestfs.pod:942
32506 #, no-wrap
32507 msgid ""
32508 " #!/bin/sh -\n"
32509 " qemudir=/home/rjones/d/qemu\n"
32510 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
32511 "\"$@\"\n"
32512 "\n"
32513 msgstr ""
32514
32515 #. type: textblock
32516 #: ../src/guestfs.pod:946
32517 msgid ""
32518 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
32519 "then use it by setting the LIBGUESTFS_QEMU environment variable.  For "
32520 "example:"
32521 msgstr ""
32522
32523 #. type: verbatim
32524 #: ../src/guestfs.pod:950
32525 #, no-wrap
32526 msgid ""
32527 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
32528 "\n"
32529 msgstr ""
32530
32531 #. type: textblock
32532 #: ../src/guestfs.pod:952
32533 msgid ""
32534 "Note that libguestfs also calls qemu with the -help and -version options in "
32535 "order to determine features."
32536 msgstr ""
32537
32538 #. type: textblock
32539 #: ../src/guestfs.pod:955
32540 msgid ""
32541 "Wrappers can also be used to edit the options passed to qemu.  In the "
32542 "following example, the C<-machine ...> option (C<-machine> and the following "
32543 "argument) are removed from the command line and replaced with C<-machine "
32544 "pc,accel=tcg>.  The while loop iterates over the options until it finds the "
32545 "right one to remove, putting the remaining options into the C<args> array."
32546 msgstr ""
32547
32548 #. type: verbatim
32549 #: ../src/guestfs.pod:962
32550 #, no-wrap
32551 msgid ""
32552 " #!/bin/bash -\n"
32553 " \n"
32554 msgstr ""
32555
32556 #. type: verbatim
32557 #: ../src/guestfs.pod:964
32558 #, no-wrap
32559 msgid ""
32560 " i=0\n"
32561 " while [ $# -gt 0 ]; do\n"
32562 "     case \"$1\" in\n"
32563 "     -machine)\n"
32564 "         shift 2;;\n"
32565 "     *)\n"
32566 "         args[i]=\"$1\"\n"
32567 "         (( i++ ))\n"
32568 "         shift ;;\n"
32569 "     esac\n"
32570 " done\n"
32571 " \n"
32572 msgstr ""
32573
32574 #. type: verbatim
32575 #: ../src/guestfs.pod:976
32576 #, no-wrap
32577 msgid ""
32578 " exec qemu-kvm -machine pc,accel=tcg \"${args[@]}\"\n"
32579 "\n"
32580 msgstr ""
32581
32582 #. type: =head2
32583 #: ../src/guestfs.pod:978
32584 msgid "ATTACHING TO RUNNING DAEMONS"
32585 msgstr ""
32586
32587 #. type: textblock
32588 #: ../src/guestfs.pod:980
32589 msgid ""
32590 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
32591 "babies.  Use with caution."
32592 msgstr ""
32593
32594 #. type: textblock
32595 #: ../src/guestfs.pod:983
32596 msgid ""
32597 "I<Note (2):> This section explains how to attach to a running daemon from a "
32598 "low level perspective.  For most users, simply using virt tools such as "
32599 "L<guestfish(1)> with the I<--live> option will \"just work\"."
32600 msgstr ""
32601
32602 #. type: =head3
32603 #: ../src/guestfs.pod:987
32604 msgid "Using guestfs_set_attach_method"
32605 msgstr ""
32606
32607 #. type: textblock
32608 #: ../src/guestfs.pod:989
32609 msgid ""
32610 "By calling L</guestfs_set_attach_method> you can change how the library "
32611 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
32612 "L</ARCHITECTURE> for some background)."
32613 msgstr ""
32614
32615 #. type: textblock
32616 #: ../src/guestfs.pod:993
32617 msgid ""
32618 "The normal attach method is C<appliance>, where a small appliance is created "
32619 "containing the daemon, and then the library connects to this."
32620 msgstr ""
32621
32622 #. type: textblock
32623 #: ../src/guestfs.pod:996
32624 msgid ""
32625 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
32626 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
32627 "daemon over the Unix domain socket."
32628 msgstr ""
32629
32630 #. type: textblock
32631 #: ../src/guestfs.pod:1000
32632 msgid ""
32633 "The normal use for this is to connect to a running virtual machine that "
32634 "contains a C<guestfsd> daemon, and send commands so you can read and write "
32635 "files inside the live virtual machine."
32636 msgstr ""
32637
32638 #. type: =head3
32639 #: ../src/guestfs.pod:1004
32640 msgid "Using guestfs_add_domain with live flag"
32641 msgstr ""
32642
32643 #. type: textblock
32644 #: ../src/guestfs.pod:1006
32645 msgid ""
32646 "L</guestfs_add_domain> provides some help for getting the correct attach "
32647 "method.  If you pass the C<live> option to this function, then (if the "
32648 "virtual machine is running) it will examine the libvirt XML looking for a "
32649 "virtio-serial channel to connect to:"
32650 msgstr ""
32651
32652 #. type: verbatim
32653 #: ../src/guestfs.pod:1012
32654 #, no-wrap
32655 msgid ""
32656 " <domain>\n"
32657 "   ...\n"
32658 "   <devices>\n"
32659 "     ...\n"
32660 "     <channel type='unix'>\n"
32661 "       <source mode='bind' path='/path/to/socket'/>\n"
32662 "       <target type='virtio' name='org.libguestfs.channel.0'/>\n"
32663 "     </channel>\n"
32664 "     ...\n"
32665 "   </devices>\n"
32666 " </domain>\n"
32667 "\n"
32668 msgstr ""
32669
32670 #. type: textblock
32671 #: ../src/guestfs.pod:1024
32672 msgid ""
32673 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
32674 "method to C<unix:/path/to/socket>."
32675 msgstr ""
32676
32677 #. type: textblock
32678 #: ../src/guestfs.pod:1027
32679 msgid ""
32680 "Some of the libguestfs tools (including guestfish) support a I<--live> "
32681 "option which is passed through to L</guestfs_add_domain> thus allowing you "
32682 "to attach to and modify live virtual machines."
32683 msgstr ""
32684
32685 #. type: textblock
32686 #: ../src/guestfs.pod:1031
32687 msgid ""
32688 "The virtual machine needs to have been set up beforehand so that it has the "
32689 "virtio-serial channel and so that guestfsd is running inside it."
32690 msgstr ""
32691
32692 #. type: =head2
32693 #: ../src/guestfs.pod:1035
32694 msgid "ABI GUARANTEE"
32695 msgstr ""
32696
32697 #. type: textblock
32698 #: ../src/guestfs.pod:1037
32699 msgid ""
32700 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
32701 "actions as outlined in this section.  Although we will deprecate some "
32702 "actions, for example if they get replaced by newer calls, we will keep the "
32703 "old actions forever.  This allows you the developer to program in confidence "
32704 "against the libguestfs API."
32705 msgstr ""
32706
32707 #. type: =head2
32708 #: ../src/guestfs.pod:1043
32709 msgid "BLOCK DEVICE NAMING"
32710 msgstr ""
32711
32712 #. type: textblock
32713 #: ../src/guestfs.pod:1045
32714 msgid ""
32715 "In the kernel there is now quite a profusion of schemata for naming block "
32716 "devices (in this context, by I<block device> I mean a physical or virtual "
32717 "hard drive).  The original Linux IDE driver used names starting with "
32718 "C</dev/hd*>.  SCSI devices have historically used a different naming scheme, "
32719 "C</dev/sd*>.  When the Linux kernel I<libata> driver became a popular "
32720 "replacement for the old IDE driver (particularly for SATA devices) those "
32721 "devices also used the C</dev/sd*> scheme.  Additionally we now have virtual "
32722 "machines with paravirtualized drivers.  This has created several different "
32723 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
32724 "Xen PV disks."
32725 msgstr ""
32726
32727 #. type: textblock
32728 #: ../src/guestfs.pod:1057
32729 msgid ""
32730 "As discussed above, libguestfs uses a qemu appliance running an embedded "
32731 "Linux kernel to access block devices.  We can run a variety of appliances "
32732 "based on a variety of Linux kernels."
32733 msgstr ""
32734
32735 #. type: textblock
32736 #: ../src/guestfs.pod:1061
32737 msgid ""
32738 "This causes a problem for libguestfs because many API calls use device or "
32739 "partition names.  Working scripts and the recipe (example) scripts that we "
32740 "make available over the internet could fail if the naming scheme changes."
32741 msgstr ""
32742
32743 #. type: textblock
32744 #: ../src/guestfs.pod:1066
32745 msgid ""
32746 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>.  "
32747 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
32748 "required.  For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
32749 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
32750 msgstr ""
32751
32752 #. type: textblock
32753 #: ../src/guestfs.pod:1072
32754 msgid ""
32755 "Note that this I<only> applies to parameters.  The L</guestfs_list_devices>, "
32756 "L</guestfs_list_partitions> and similar calls return the true names of the "
32757 "devices and partitions as known to the appliance."
32758 msgstr ""
32759
32760 #. type: =head3
32761 #: ../src/guestfs.pod:1077
32762 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
32763 msgstr ""
32764
32765 #. type: textblock
32766 #: ../src/guestfs.pod:1079
32767 msgid ""
32768 "Usually this translation is transparent.  However in some (very rare)  cases "
32769 "you may need to know the exact algorithm.  Such cases include where you use "
32770 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
32771 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
32772 "devices."
32773 msgstr ""
32774
32775 #. type: textblock
32776 #: ../src/guestfs.pod:1085
32777 msgid ""
32778 "The algorithm is applied only to I<parameters> which are known to be either "
32779 "device or partition names.  Return values from functions such as "
32780 "L</guestfs_list_devices> are never changed."
32781 msgstr ""
32782
32783 #. type: textblock
32784 #: ../src/guestfs.pod:1093
32785 msgid "Is the string a parameter which is a device or partition name?"
32786 msgstr ""
32787
32788 #. type: textblock
32789 #: ../src/guestfs.pod:1097
32790 msgid "Does the string begin with C</dev/sd>?"
32791 msgstr ""
32792
32793 #. type: textblock
32794 #: ../src/guestfs.pod:1101
32795 msgid ""
32796 "Does the named device exist? If so, we use that device.  However if I<not> "
32797 "then we continue with this algorithm."
32798 msgstr ""
32799
32800 #. type: textblock
32801 #: ../src/guestfs.pod:1106
32802 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
32803 msgstr ""
32804
32805 #. type: textblock
32806 #: ../src/guestfs.pod:1108
32807 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
32808 msgstr ""
32809
32810 #. type: textblock
32811 #: ../src/guestfs.pod:1110
32812 msgid "If that named device exists, use it.  If not, continue."
32813 msgstr ""
32814
32815 #. type: textblock
32816 #: ../src/guestfs.pod:1114
32817 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
32818 msgstr ""
32819
32820 #. type: textblock
32821 #: ../src/guestfs.pod:1116
32822 msgid "If that named device exists, use it.  If not, return an error."
32823 msgstr ""
32824
32825 #. type: =head3
32826 #: ../src/guestfs.pod:1120
32827 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
32828 msgstr ""
32829
32830 #. type: textblock
32831 #: ../src/guestfs.pod:1122
32832 msgid ""
32833 "Although the standard naming scheme and automatic translation is useful for "
32834 "simple programs and guestfish scripts, for larger programs it is best not to "
32835 "rely on this mechanism."
32836 msgstr ""
32837
32838 #. type: textblock
32839 #: ../src/guestfs.pod:1126
32840 msgid ""
32841 "Where possible for maximum future portability programs using libguestfs "
32842 "should use these future-proof techniques:"
32843 msgstr ""
32844
32845 #. type: textblock
32846 #: ../src/guestfs.pod:1133
32847 msgid ""
32848 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
32849 "device names, and then use those names directly."
32850 msgstr ""
32851
32852 #. type: textblock
32853 #: ../src/guestfs.pod:1136
32854 msgid "Since those device names exist by definition, they will never be translated."
32855 msgstr ""
32856
32857 #. type: textblock
32858 #: ../src/guestfs.pod:1141
32859 msgid ""
32860 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
32861 "filesystem labels."
32862 msgstr ""
32863
32864 #. type: =head1
32865 #: ../src/guestfs.pod:1146
32866 msgid "SECURITY"
32867 msgstr ""
32868
32869 #. type: textblock
32870 #: ../src/guestfs.pod:1148
32871 msgid ""
32872 "This section discusses security implications of using libguestfs, "
32873 "particularly with untrusted or malicious guests or disk images."
32874 msgstr ""
32875
32876 #. type: =head2
32877 #: ../src/guestfs.pod:1151
32878 msgid "GENERAL SECURITY CONSIDERATIONS"
32879 msgstr ""
32880
32881 #. type: textblock
32882 #: ../src/guestfs.pod:1153
32883 msgid ""
32884 "Be careful with any files or data that you download from a guest (by "
32885 "\"download\" we mean not just the L</guestfs_download> command but any "
32886 "command that reads files, filenames, directories or anything else from a "
32887 "disk image).  An attacker could manipulate the data to fool your program "
32888 "into doing the wrong thing.  Consider cases such as:"
32889 msgstr ""
32890
32891 #. type: textblock
32892 #: ../src/guestfs.pod:1163
32893 msgid "the data (file etc) not being present"
32894 msgstr ""
32895
32896 #. type: textblock
32897 #: ../src/guestfs.pod:1167
32898 msgid "being present but empty"
32899 msgstr ""
32900
32901 #. type: textblock
32902 #: ../src/guestfs.pod:1171
32903 msgid "being much larger than normal"
32904 msgstr ""
32905
32906 #. type: textblock
32907 #: ../src/guestfs.pod:1175
32908 msgid "containing arbitrary 8 bit data"
32909 msgstr ""
32910
32911 #. type: textblock
32912 #: ../src/guestfs.pod:1179
32913 msgid "being in an unexpected character encoding"
32914 msgstr ""
32915
32916 #. type: textblock
32917 #: ../src/guestfs.pod:1183
32918 msgid "containing homoglyphs."
32919 msgstr ""
32920
32921 #. type: =head2
32922 #: ../src/guestfs.pod:1187
32923 msgid "SECURITY OF MOUNTING FILESYSTEMS"
32924 msgstr ""
32925
32926 #. type: textblock
32927 #: ../src/guestfs.pod:1189
32928 msgid ""
32929 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
32930 "(VFS) module can sometimes be escalated into exploits by deliberately "
32931 "creating a malicious, malformed filesystem.  These exploits are very severe "
32932 "for two reasons.  Firstly there are very many filesystem drivers in the "
32933 "kernel, and many of them are infrequently used and not much developer "
32934 "attention has been paid to the code.  Linux userspace helps potential "
32935 "crackers by detecting the filesystem type and automatically choosing the "
32936 "right VFS driver, even if that filesystem type is obscure or unexpected for "
32937 "the administrator.  Secondly, a kernel-level exploit is like a local root "
32938 "exploit (worse in some ways), giving immediate and total access to the "
32939 "system right down to the hardware level."
32940 msgstr ""
32941
32942 #. type: textblock
32943 #: ../src/guestfs.pod:1202
32944 msgid ""
32945 "That explains why you should never mount a filesystem from an untrusted "
32946 "guest on your host kernel.  How about libguestfs? We run a Linux kernel "
32947 "inside a qemu virtual machine, usually running as a non-root user.  The "
32948 "attacker would need to write a filesystem which first exploited the kernel, "
32949 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
32950 "the libguestfs protocol, and finally to be as serious as the host kernel "
32951 "exploit it would need to escalate its privileges to root.  This multi-step "
32952 "escalation, performed by a static piece of data, is thought to be extremely "
32953 "hard to do, although we never say 'never' about security issues."
32954 msgstr ""
32955
32956 #. type: textblock
32957 #: ../src/guestfs.pod:1213
32958 msgid ""
32959 "In any case callers can reduce the attack surface by forcing the filesystem "
32960 "type when mounting (use L</guestfs_mount_vfs>)."
32961 msgstr ""
32962
32963 #. type: =head2
32964 #: ../src/guestfs.pod:1216
32965 msgid "PROTOCOL SECURITY"
32966 msgstr ""
32967
32968 #. type: textblock
32969 #: ../src/guestfs.pod:1218
32970 msgid ""
32971 "The protocol is designed to be secure, being based on RFC 4506 (XDR)  with a "
32972 "defined upper message size.  However a program that uses libguestfs must "
32973 "also take care - for example you can write a program that downloads a binary "
32974 "from a disk image and executes it locally, and no amount of protocol "
32975 "security will save you from the consequences."
32976 msgstr ""
32977
32978 #. type: =head2
32979 #: ../src/guestfs.pod:1224
32980 msgid "INSPECTION SECURITY"
32981 msgstr ""
32982
32983 #. type: textblock
32984 #: ../src/guestfs.pod:1226
32985 msgid ""
32986 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
32987 "directly from the guest, and these could contain any 8 bit data.  Callers "
32988 "should be careful to escape these before printing them to a structured file "
32989 "(for example, use HTML escaping if creating a web page)."
32990 msgstr ""
32991
32992 #. type: textblock
32993 #: ../src/guestfs.pod:1232
32994 msgid ""
32995 "Guest configuration may be altered in unusual ways by the administrator of "
32996 "the virtual machine, and may not reflect reality (particularly for untrusted "
32997 "or actively malicious guests).  For example we parse the hostname from "
32998 "configuration files like C</etc/sysconfig/network> that we find in the "
32999 "guest, but the guest administrator can easily manipulate these files to "
33000 "provide the wrong hostname."
33001 msgstr ""
33002
33003 #. type: textblock
33004 #: ../src/guestfs.pod:1240
33005 msgid ""
33006 "The inspection API parses guest configuration using two external libraries: "
33007 "Augeas (Linux configuration) and hivex (Windows Registry).  Both are "
33008 "designed to be robust in the face of malicious data, although denial of "
33009 "service attacks are still possible, for example with oversized configuration "
33010 "files."
33011 msgstr ""
33012
33013 #. type: =head2
33014 #: ../src/guestfs.pod:1246
33015 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
33016 msgstr ""
33017
33018 #. type: textblock
33019 #: ../src/guestfs.pod:1248
33020 msgid ""
33021 "Be very cautious about running commands from the guest.  By running a "
33022 "command in the guest, you are giving CPU time to a binary that you do not "
33023 "control, under the same user account as the library, albeit wrapped in qemu "
33024 "virtualization.  More information and alternatives can be found in the "
33025 "section L</RUNNING COMMANDS>."
33026 msgstr ""
33027
33028 #. type: =head2
33029 #: ../src/guestfs.pod:1254
33030 msgid "CVE-2010-3851"
33031 msgstr ""
33032
33033 #. type: textblock
33034 #: ../src/guestfs.pod:1256
33035 msgid "https://bugzilla.redhat.com/642934"
33036 msgstr ""
33037
33038 #. type: textblock
33039 #: ../src/guestfs.pod:1258
33040 msgid ""
33041 "This security bug concerns the automatic disk format detection that qemu "
33042 "does on disk images."
33043 msgstr ""
33044
33045 #. type: textblock
33046 #: ../src/guestfs.pod:1261
33047 msgid ""
33048 "A raw disk image is just the raw bytes, there is no header.  Other disk "
33049 "images like qcow2 contain a special header.  Qemu deals with this by looking "
33050 "for one of the known headers, and if none is found then assuming the disk "
33051 "image must be raw."
33052 msgstr ""
33053
33054 #. type: textblock
33055 #: ../src/guestfs.pod:1266
33056 msgid ""
33057 "This allows a guest which has been given a raw disk image to write some "
33058 "other header.  At next boot (or when the disk image is accessed by "
33059 "libguestfs) qemu would do autodetection and think the disk image format was, "
33060 "say, qcow2 based on the header written by the guest."
33061 msgstr ""
33062
33063 #. type: textblock
33064 #: ../src/guestfs.pod:1271
33065 msgid ""
33066 "This in itself would not be a problem, but qcow2 offers many features, one "
33067 "of which is to allow a disk image to refer to another image (called the "
33068 "\"backing disk\").  It does this by placing the path to the backing disk "
33069 "into the qcow2 header.  This path is not validated and could point to any "
33070 "host file (eg. \"/etc/passwd\").  The backing disk is then exposed through "
33071 "\"holes\" in the qcow2 disk image, which of course is completely under the "
33072 "control of the attacker."
33073 msgstr ""
33074
33075 #. type: textblock
33076 #: ../src/guestfs.pod:1279
33077 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
33078 msgstr ""
33079
33080 #. type: textblock
33081 #: ../src/guestfs.pod:1286
33082 msgid "You have enabled the network or have opened the disk in write mode."
33083 msgstr ""
33084
33085 #. type: textblock
33086 #: ../src/guestfs.pod:1290
33087 msgid ""
33088 "You are also running untrusted code from the guest (see L</RUNNING "
33089 "COMMANDS>)."
33090 msgstr ""
33091
33092 #. type: textblock
33093 #: ../src/guestfs.pod:1295
33094 msgid ""
33095 "The way to avoid this is to specify the expected disk format when adding "
33096 "disks (the optional C<format> option to L</guestfs_add_drive_opts>).  You "
33097 "should always do this if the disk is raw format, and it's a good idea for "
33098 "other cases too."
33099 msgstr ""
33100
33101 #. type: textblock
33102 #: ../src/guestfs.pod:1300
33103 msgid ""
33104 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
33105 "format is fetched from libvirt and passed through."
33106 msgstr ""
33107
33108 #. type: textblock
33109 #: ../src/guestfs.pod:1303
33110 msgid ""
33111 "For libguestfs tools, use the I<--format> command line parameter as "
33112 "appropriate."
33113 msgstr ""
33114
33115 #. type: =head1
33116 #: ../src/guestfs.pod:1306
33117 msgid "CONNECTION MANAGEMENT"
33118 msgstr ""
33119
33120 #. type: =head2
33121 #: ../src/guestfs.pod:1308
33122 msgid "guestfs_h *"
33123 msgstr ""
33124
33125 #. type: textblock
33126 #: ../src/guestfs.pod:1310
33127 msgid ""
33128 "C<guestfs_h> is the opaque type representing a connection handle.  Create a "
33129 "handle by calling L</guestfs_create>.  Call L</guestfs_close> to free the "
33130 "handle and release all resources used."
33131 msgstr ""
33132
33133 #. type: textblock
33134 #: ../src/guestfs.pod:1314
33135 msgid ""
33136 "For information on using multiple handles and threads, see the section "
33137 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> above."
33138 msgstr ""
33139
33140 #. type: =head2
33141 #: ../src/guestfs.pod:1317
33142 msgid "guestfs_create"
33143 msgstr ""
33144
33145 #. type: verbatim
33146 #: ../src/guestfs.pod:1319
33147 #, no-wrap
33148 msgid ""
33149 " guestfs_h *guestfs_create (void);\n"
33150 "\n"
33151 msgstr ""
33152
33153 #. type: textblock
33154 #: ../src/guestfs.pod:1321
33155 msgid "Create a connection handle."
33156 msgstr ""
33157
33158 #. type: textblock
33159 #: ../src/guestfs.pod:1323
33160 msgid ""
33161 "On success this returns a non-NULL pointer to a handle.  On error it returns "
33162 "NULL."
33163 msgstr ""
33164
33165 #. type: textblock
33166 #: ../src/guestfs.pod:1326
33167 msgid ""
33168 "You have to \"configure\" the handle after creating it.  This includes "
33169 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
33170 "handle at least once."
33171 msgstr ""
33172
33173 #. type: textblock
33174 #: ../src/guestfs.pod:1330
33175 msgid "After configuring the handle, you have to call L</guestfs_launch>."
33176 msgstr ""
33177
33178 #. type: textblock
33179 #: ../src/guestfs.pod:1332
33180 msgid ""
33181 "You may also want to configure error handling for the handle.  See the "
33182 "L</ERROR HANDLING> section below."
33183 msgstr ""
33184
33185 #. type: =head2
33186 #: ../src/guestfs.pod:1335
33187 msgid "guestfs_close"
33188 msgstr ""
33189
33190 #. type: verbatim
33191 #: ../src/guestfs.pod:1337
33192 #, no-wrap
33193 msgid ""
33194 " void guestfs_close (guestfs_h *g);\n"
33195 "\n"
33196 msgstr ""
33197
33198 #. type: textblock
33199 #: ../src/guestfs.pod:1339
33200 msgid "This closes the connection handle and frees up all resources used."
33201 msgstr ""
33202
33203 #. type: textblock
33204 #: ../src/guestfs.pod:1341
33205 msgid ""
33206 "If autosync was set on the handle and the handle was launched, then this "
33207 "implicitly calls various functions to unmount filesystems and sync the "
33208 "disk.  See L</guestfs_set_autosync> for more details."
33209 msgstr ""
33210
33211 #. type: textblock
33212 #: ../src/guestfs.pod:1345
33213 msgid "If a close callback was set on the handle, then it is called."
33214 msgstr ""
33215
33216 #. type: =head1
33217 #: ../src/guestfs.pod:1347
33218 msgid "ERROR HANDLING"
33219 msgstr ""
33220
33221 #. type: textblock
33222 #: ../src/guestfs.pod:1349
33223 msgid ""
33224 "API functions can return errors.  For example, almost all functions that "
33225 "return C<int> will return C<-1> to indicate an error."
33226 msgstr ""
33227
33228 #. type: textblock
33229 #: ../src/guestfs.pod:1352
33230 msgid ""
33231 "Additional information is available for errors: an error message string and "
33232 "optionally an error number (errno) if the thing that failed was a system "
33233 "call."
33234 msgstr ""
33235
33236 #. type: textblock
33237 #: ../src/guestfs.pod:1356
33238 msgid ""
33239 "You can get at the additional information about the last error on the handle "
33240 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
33241 "up an error handler with L</guestfs_set_error_handler>."
33242 msgstr ""
33243
33244 #. type: textblock
33245 #: ../src/guestfs.pod:1361
33246 msgid ""
33247 "When the handle is created, a default error handler is installed which "
33248 "prints the error message string to C<stderr>.  For small short-running "
33249 "command line programs it is sufficient to do:"
33250 msgstr ""
33251
33252 #. type: verbatim
33253 #: ../src/guestfs.pod:1365
33254 #, no-wrap
33255 msgid ""
33256 " if (guestfs_launch (g) == -1)\n"
33257 "   exit (EXIT_FAILURE);\n"
33258 "\n"
33259 msgstr ""
33260
33261 #. type: textblock
33262 #: ../src/guestfs.pod:1368
33263 msgid ""
33264 "since the default error handler will ensure that an error message has been "
33265 "printed to C<stderr> before the program exits."
33266 msgstr ""
33267
33268 #. type: textblock
33269 #: ../src/guestfs.pod:1371
33270 msgid ""
33271 "For other programs the caller will almost certainly want to install an "
33272 "alternate error handler or do error handling in-line like this:"
33273 msgstr ""
33274
33275 #. type: verbatim
33276 #: ../src/guestfs.pod:1374
33277 #, no-wrap
33278 msgid ""
33279 " /* This disables the default behaviour of printing errors\n"
33280 "    on stderr. */\n"
33281 " guestfs_set_error_handler (g, NULL, NULL);\n"
33282 " \n"
33283 msgstr ""
33284
33285 #. type: verbatim
33286 #: ../src/guestfs.pod:1378
33287 #, no-wrap
33288 msgid ""
33289 " if (guestfs_launch (g) == -1) {\n"
33290 "   /* Examine the error message and print it etc. */\n"
33291 "   char *msg = guestfs_last_error (g);\n"
33292 "   int errnum = guestfs_last_errno (g);\n"
33293 "   fprintf (stderr, \"%s\", msg);\n"
33294 "   if (errnum != 0)\n"
33295 "     fprintf (stderr, \": %s\", strerror (errnum));\n"
33296 "   fprintf (stderr, \"\\n\");\n"
33297 "   /* ... */\n"
33298 " }\n"
33299 "\n"
33300 msgstr ""
33301
33302 #. type: textblock
33303 #: ../src/guestfs.pod:1389
33304 msgid ""
33305 "Out of memory errors are handled differently.  The default action is to call "
33306 "L<abort(3)>.  If this is undesirable, then you can set a handler using "
33307 "L</guestfs_set_out_of_memory_handler>."
33308 msgstr ""
33309
33310 #. type: textblock
33311 #: ../src/guestfs.pod:1393
33312 msgid ""
33313 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
33314 "because there is no handle if this happens there is no way to get additional "
33315 "error information.  However L</guestfs_create> is supposed to be a "
33316 "lightweight operation which can only fail because of insufficient memory (it "
33317 "returns NULL in this case)."
33318 msgstr ""
33319
33320 #. type: =head2
33321 #: ../src/guestfs.pod:1399
33322 msgid "guestfs_last_error"
33323 msgstr ""
33324
33325 #. type: verbatim
33326 #: ../src/guestfs.pod:1401
33327 #, no-wrap
33328 msgid ""
33329 " const char *guestfs_last_error (guestfs_h *g);\n"
33330 "\n"
33331 msgstr ""
33332
33333 #. type: textblock
33334 #: ../src/guestfs.pod:1403
33335 msgid ""
33336 "This returns the last error message that happened on C<g>.  If there has not "
33337 "been an error since the handle was created, then this returns C<NULL>."
33338 msgstr ""
33339
33340 #. type: textblock
33341 #: ../src/guestfs.pod:1407
33342 msgid ""
33343 "The lifetime of the returned string is until the next error occurs, or "
33344 "L</guestfs_close> is called."
33345 msgstr ""
33346
33347 #. type: =head2
33348 #: ../src/guestfs.pod:1410
33349 msgid "guestfs_last_errno"
33350 msgstr ""
33351
33352 #. type: verbatim
33353 #: ../src/guestfs.pod:1412
33354 #, no-wrap
33355 msgid ""
33356 " int guestfs_last_errno (guestfs_h *g);\n"
33357 "\n"
33358 msgstr ""
33359
33360 #. type: textblock
33361 #: ../src/guestfs.pod:1414
33362 msgid "This returns the last error number (errno) that happened on C<g>."
33363 msgstr ""
33364
33365 #. type: textblock
33366 #: ../src/guestfs.pod:1416
33367 msgid "If successful, an errno integer not equal to zero is returned."
33368 msgstr ""
33369
33370 #. type: textblock
33371 #: ../src/guestfs.pod:1418
33372 msgid "If no error, this returns 0.  This call can return 0 in three situations:"
33373 msgstr ""
33374
33375 #. type: textblock
33376 #: ../src/guestfs.pod:1425
33377 msgid "There has not been any error on the handle."
33378 msgstr ""
33379
33380 #. type: textblock
33381 #: ../src/guestfs.pod:1429
33382 msgid ""
33383 "There has been an error but the errno was meaningless.  This corresponds to "
33384 "the case where the error did not come from a failed system call, but for "
33385 "some other reason."
33386 msgstr ""
33387
33388 #. type: textblock
33389 #: ../src/guestfs.pod:1435
33390 msgid ""
33391 "There was an error from a failed system call, but for some reason the errno "
33392 "was not captured and returned.  This usually indicates a bug in libguestfs."
33393 msgstr ""
33394
33395 #. type: textblock
33396 #: ../src/guestfs.pod:1441
33397 msgid ""
33398 "Libguestfs tries to convert the errno from inside the applicance into a "
33399 "corresponding errno for the caller (not entirely trivial: the appliance "
33400 "might be running a completely different operating system from the library "
33401 "and error numbers are not standardized across Un*xen).  If this could not be "
33402 "done, then the error is translated to C<EINVAL>.  In practice this should "
33403 "only happen in very rare circumstances."
33404 msgstr ""
33405
33406 #. type: =head2
33407 #: ../src/guestfs.pod:1449
33408 msgid "guestfs_set_error_handler"
33409 msgstr ""
33410
33411 #. type: verbatim
33412 #: ../src/guestfs.pod:1451
33413 #, no-wrap
33414 msgid ""
33415 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
33416 "                                           void *opaque,\n"
33417 "                                           const char *msg);\n"
33418 " void guestfs_set_error_handler (guestfs_h *g,\n"
33419 "                                 guestfs_error_handler_cb cb,\n"
33420 "                                 void *opaque);\n"
33421 "\n"
33422 msgstr ""
33423
33424 #. type: textblock
33425 #: ../src/guestfs.pod:1458
33426 msgid ""
33427 "The callback C<cb> will be called if there is an error.  The parameters "
33428 "passed to the callback are an opaque data pointer and the error message "
33429 "string."
33430 msgstr ""
33431
33432 #. type: textblock
33433 #: ../src/guestfs.pod:1462
33434 msgid ""
33435 "C<errno> is not passed to the callback.  To get that the callback must call "
33436 "L</guestfs_last_errno>."
33437 msgstr ""
33438
33439 #. type: textblock
33440 #: ../src/guestfs.pod:1465
33441 msgid ""
33442 "Note that the message string C<msg> is freed as soon as the callback "
33443 "function returns, so if you want to stash it somewhere you must make your "
33444 "own copy."
33445 msgstr ""
33446
33447 #. type: textblock
33448 #: ../src/guestfs.pod:1469
33449 msgid "The default handler prints messages on C<stderr>."
33450 msgstr ""
33451
33452 #. type: textblock
33453 #: ../src/guestfs.pod:1471
33454 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
33455 msgstr ""
33456
33457 #. type: =head2
33458 #: ../src/guestfs.pod:1473
33459 msgid "guestfs_get_error_handler"
33460 msgstr ""
33461
33462 #. type: verbatim
33463 #: ../src/guestfs.pod:1475
33464 #, no-wrap
33465 msgid ""
33466 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
33467 "                                                     void **opaque_rtn);\n"
33468 "\n"
33469 msgstr ""
33470
33471 #. type: textblock
33472 #: ../src/guestfs.pod:1478
33473 msgid "Returns the current error handler callback."
33474 msgstr ""
33475
33476 #. type: =head2
33477 #: ../src/guestfs.pod:1480
33478 msgid "guestfs_set_out_of_memory_handler"
33479 msgstr ""
33480
33481 #. type: verbatim
33482 #: ../src/guestfs.pod:1482
33483 #, no-wrap
33484 msgid ""
33485 " typedef void (*guestfs_abort_cb) (void);\n"
33486 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
33487 "                                         guestfs_abort_cb);\n"
33488 "\n"
33489 msgstr ""
33490
33491 #. type: textblock
33492 #: ../src/guestfs.pod:1486
33493 msgid ""
33494 "The callback C<cb> will be called if there is an out of memory situation.  "
33495 "I<Note this callback must not return>."
33496 msgstr ""
33497
33498 #. type: textblock
33499 #: ../src/guestfs.pod:1489
33500 msgid "The default is to call L<abort(3)>."
33501 msgstr ""
33502
33503 #. type: textblock
33504 #: ../src/guestfs.pod:1491
33505 msgid "You cannot set C<cb> to C<NULL>.  You can't ignore out of memory situations."
33506 msgstr ""
33507
33508 #. type: =head2
33509 #: ../src/guestfs.pod:1494
33510 msgid "guestfs_get_out_of_memory_handler"
33511 msgstr ""
33512
33513 #. type: verbatim
33514 #: ../src/guestfs.pod:1496
33515 #, no-wrap
33516 msgid ""
33517 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
33518 "\n"
33519 msgstr ""
33520
33521 #. type: textblock
33522 #: ../src/guestfs.pod:1498
33523 msgid "This returns the current out of memory handler."
33524 msgstr ""
33525
33526 #. type: =head1
33527 #: ../src/guestfs.pod:1500
33528 msgid "API CALLS"
33529 msgstr ""
33530
33531 #. type: =head1
33532 #: ../src/guestfs.pod:1504
33533 msgid "STRUCTURES"
33534 msgstr ""
33535
33536 #. type: textblock
33537 #: ../src/guestfs.pod:1506
33538 msgid "@STRUCTS@"
33539 msgstr ""
33540
33541 #. type: =head1
33542 #: ../src/guestfs.pod:1508
33543 msgid "AVAILABILITY"
33544 msgstr ""
33545
33546 #. type: =head2
33547 #: ../src/guestfs.pod:1510
33548 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
33549 msgstr ""
33550
33551 #. type: textblock
33552 #: ../src/guestfs.pod:1512
33553 msgid ""
33554 "Using L</guestfs_available> you can test availability of the following "
33555 "groups of functions.  This test queries the appliance to see if the "
33556 "appliance you are currently using supports the functionality."
33557 msgstr ""
33558
33559 #. type: textblock
33560 #: ../src/guestfs.pod:1517
33561 msgid "@AVAILABILITY@"
33562 msgstr ""
33563
33564 #. type: =head2
33565 #: ../src/guestfs.pod:1519
33566 msgid "GUESTFISH supported COMMAND"
33567 msgstr ""
33568
33569 #. type: textblock
33570 #: ../src/guestfs.pod:1521
33571 msgid ""
33572 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
33573 "prints out the available groups and whether they are supported by this build "
33574 "of libguestfs.  Note however that you have to do C<run> first."
33575 msgstr ""
33576
33577 #. type: =head2
33578 #: ../src/guestfs.pod:1526
33579 msgid "SINGLE CALLS AT COMPILE TIME"
33580 msgstr ""
33581
33582 #. type: textblock
33583 #: ../src/guestfs.pod:1528
33584 msgid ""
33585 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
33586 "function, such as:"
33587 msgstr ""
33588
33589 #. type: verbatim
33590 #: ../src/guestfs.pod:1531
33591 #, no-wrap
33592 msgid ""
33593 " #define LIBGUESTFS_HAVE_DD 1\n"
33594 "\n"
33595 msgstr ""
33596
33597 #. type: textblock
33598 #: ../src/guestfs.pod:1533
33599 msgid "if L</guestfs_dd> is available."
33600 msgstr ""
33601
33602 #. type: textblock
33603 #: ../src/guestfs.pod:1535
33604 msgid ""
33605 "Before version 1.5.8, if you needed to test whether a single libguestfs "
33606 "function is available at compile time, we recommended using build tools such "
33607 "as autoconf or cmake.  For example in autotools you could use:"
33608 msgstr ""
33609
33610 #. type: verbatim
33611 #: ../src/guestfs.pod:1540
33612 #, no-wrap
33613 msgid ""
33614 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
33615 " AC_CHECK_FUNCS([guestfs_dd])\n"
33616 "\n"
33617 msgstr ""
33618
33619 #. type: textblock
33620 #: ../src/guestfs.pod:1543
33621 msgid ""
33622 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
33623 "in your program."
33624 msgstr ""
33625
33626 #. type: =head2
33627 #: ../src/guestfs.pod:1546
33628 msgid "SINGLE CALLS AT RUN TIME"
33629 msgstr ""
33630
33631 #. type: textblock
33632 #: ../src/guestfs.pod:1548
33633 msgid ""
33634 "Testing at compile time doesn't guarantee that a function really exists in "
33635 "the library.  The reason is that you might be dynamically linked against a "
33636 "previous I<libguestfs.so> (dynamic library)  which doesn't have the call.  "
33637 "This situation unfortunately results in a segmentation fault, which is a "
33638 "shortcoming of the C dynamic linking system itself."
33639 msgstr ""
33640
33641 #. type: textblock
33642 #: ../src/guestfs.pod:1555
33643 msgid ""
33644 "You can use L<dlopen(3)> to test if a function is available at run time, as "
33645 "in this example program (note that you still need the compile time check as "
33646 "well):"
33647 msgstr ""
33648
33649 #. type: verbatim
33650 #: ../src/guestfs.pod:1559
33651 #, no-wrap
33652 msgid ""
33653 " #include <stdio.h>\n"
33654 " #include <stdlib.h>\n"
33655 " #include <unistd.h>\n"
33656 " #include <dlfcn.h>\n"
33657 " #include <guestfs.h>\n"
33658 " \n"
33659 msgstr ""
33660
33661 #. type: verbatim
33662 #: ../src/guestfs.pod:1565
33663 #, no-wrap
33664 msgid ""
33665 " main ()\n"
33666 " {\n"
33667 " #ifdef LIBGUESTFS_HAVE_DD\n"
33668 "   void *dl;\n"
33669 "   int has_function;\n"
33670 " \n"
33671 msgstr ""
33672
33673 #. type: verbatim
33674 #: ../src/guestfs.pod:1571
33675 #, no-wrap
33676 msgid ""
33677 "   /* Test if the function guestfs_dd is really available. */\n"
33678 "   dl = dlopen (NULL, RTLD_LAZY);\n"
33679 "   if (!dl) {\n"
33680 "     fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
33681 "     exit (EXIT_FAILURE);\n"
33682 "   }\n"
33683 "   has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
33684 "   dlclose (dl);\n"
33685 " \n"
33686 msgstr ""
33687
33688 #. type: verbatim
33689 #: ../src/guestfs.pod:1580
33690 #, no-wrap
33691 msgid ""
33692 "   if (!has_function)\n"
33693 "     printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
33694 "   else {\n"
33695 "     printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
33696 "     /* Now it's safe to call\n"
33697 "     guestfs_dd (g, \"foo\", \"bar\");\n"
33698 "     */\n"
33699 "   }\n"
33700 " #else\n"
33701 "   printf (\"guestfs_dd function was not found at compile time\\n\");\n"
33702 " #endif\n"
33703 "  }\n"
33704 "\n"
33705 msgstr ""
33706
33707 #. type: textblock
33708 #: ../src/guestfs.pod:1593
33709 msgid ""
33710 "You may think the above is an awful lot of hassle, and it is.  There are "
33711 "other ways outside of the C linking system to ensure that this kind of "
33712 "incompatibility never arises, such as using package versioning:"
33713 msgstr ""
33714
33715 #. type: verbatim
33716 #: ../src/guestfs.pod:1598
33717 #, no-wrap
33718 msgid ""
33719 " Requires: libguestfs >= 1.0.80\n"
33720 "\n"
33721 msgstr ""
33722
33723 #. type: =head1
33724 #: ../src/guestfs.pod:1600
33725 msgid "CALLS WITH OPTIONAL ARGUMENTS"
33726 msgstr ""
33727
33728 #. type: textblock
33729 #: ../src/guestfs.pod:1602
33730 msgid ""
33731 "A recent feature of the API is the introduction of calls which take optional "
33732 "arguments.  In C these are declared 3 ways.  The main way is as a call which "
33733 "takes variable arguments (ie. C<...>), as in this example:"
33734 msgstr ""
33735
33736 #. type: verbatim
33737 #: ../src/guestfs.pod:1607
33738 #, no-wrap
33739 msgid ""
33740 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
33741 "\n"
33742 msgstr ""
33743
33744 #. type: textblock
33745 #: ../src/guestfs.pod:1609
33746 msgid ""
33747 "Call this with a list of optional arguments, terminated by C<-1>.  So to "
33748 "call with no optional arguments specified:"
33749 msgstr ""
33750
33751 #. type: verbatim
33752 #: ../src/guestfs.pod:1612
33753 #, no-wrap
33754 msgid ""
33755 " guestfs_add_drive_opts (g, filename, -1);\n"
33756 "\n"
33757 msgstr ""
33758
33759 #. type: textblock
33760 #: ../src/guestfs.pod:1614
33761 msgid "With a single optional argument:"
33762 msgstr ""
33763
33764 #. type: verbatim
33765 #: ../src/guestfs.pod:1616
33766 #, no-wrap
33767 msgid ""
33768 " guestfs_add_drive_opts (g, filename,\n"
33769 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33770 "                         -1);\n"
33771 "\n"
33772 msgstr ""
33773
33774 #. type: textblock
33775 #: ../src/guestfs.pod:1620
33776 msgid "With two:"
33777 msgstr ""
33778
33779 #. type: verbatim
33780 #: ../src/guestfs.pod:1622
33781 #, no-wrap
33782 msgid ""
33783 " guestfs_add_drive_opts (g, filename,\n"
33784 "                         GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33785 "                         GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
33786 "                         -1);\n"
33787 "\n"
33788 msgstr ""
33789
33790 #. type: textblock
33791 #: ../src/guestfs.pod:1627
33792 msgid ""
33793 "and so forth.  Don't forget the terminating C<-1> otherwise Bad Things will "
33794 "happen!"
33795 msgstr ""
33796
33797 #. type: =head2
33798 #: ../src/guestfs.pod:1630
33799 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
33800 msgstr ""
33801
33802 #. type: textblock
33803 #: ../src/guestfs.pod:1632
33804 msgid ""
33805 "The second variant has the same name with the suffix C<_va>, which works the "
33806 "same way but takes a C<va_list>.  See the C manual for details.  For the "
33807 "example function, this is declared:"
33808 msgstr ""
33809
33810 #. type: verbatim
33811 #: ../src/guestfs.pod:1636
33812 #, no-wrap
33813 msgid ""
33814 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
33815 "                                va_list args);\n"
33816 "\n"
33817 msgstr ""
33818
33819 #. type: =head2
33820 #: ../src/guestfs.pod:1639
33821 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
33822 msgstr ""
33823
33824 #. type: textblock
33825 #: ../src/guestfs.pod:1641
33826 msgid ""
33827 "The third variant is useful where you need to construct these calls.  You "
33828 "pass in a structure where you fill in the optional fields.  The structure "
33829 "has a bitmask as the first element which you must set to indicate which "
33830 "fields you have filled in.  For our example function the structure and call "
33831 "are declared:"
33832 msgstr ""
33833
33834 #. type: verbatim
33835 #: ../src/guestfs.pod:1647
33836 #, no-wrap
33837 msgid ""
33838 " struct guestfs_add_drive_opts_argv {\n"
33839 "   uint64_t bitmask;\n"
33840 "   int readonly;\n"
33841 "   const char *format;\n"
33842 "   /* ... */\n"
33843 " };\n"
33844 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
33845 "              const struct guestfs_add_drive_opts_argv *optargs);\n"
33846 "\n"
33847 msgstr ""
33848
33849 #. type: textblock
33850 #: ../src/guestfs.pod:1656
33851 msgid "You could call it like this:"
33852 msgstr ""
33853
33854 #. type: verbatim
33855 #: ../src/guestfs.pod:1658
33856 #, no-wrap
33857 msgid ""
33858 " struct guestfs_add_drive_opts_argv optargs = {\n"
33859 "   .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
33860 "              GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
33861 "   .readonly = 1,\n"
33862 "   .format = \"qcow2\"\n"
33863 " };\n"
33864 " \n"
33865 msgstr ""
33866
33867 #. type: verbatim
33868 #: ../src/guestfs.pod:1665
33869 #, no-wrap
33870 msgid ""
33871 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
33872 "\n"
33873 msgstr ""
33874
33875 #. type: textblock
33876 #: ../src/guestfs.pod:1673
33877 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
33878 msgstr ""
33879
33880 #. type: textblock
33881 #: ../src/guestfs.pod:1678
33882 msgid "You do not need to fill in all fields of the structure."
33883 msgstr ""
33884
33885 #. type: textblock
33886 #: ../src/guestfs.pod:1682
33887 msgid ""
33888 "There must be a one-to-one correspondence between fields of the structure "
33889 "that are filled in, and bits set in the bitmask."
33890 msgstr ""
33891
33892 #. type: =head2
33893 #: ../src/guestfs.pod:1687
33894 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
33895 msgstr ""
33896
33897 #. type: textblock
33898 #: ../src/guestfs.pod:1689
33899 msgid ""
33900 "In other languages, optional arguments are expressed in the way that is "
33901 "natural for that language.  We refer you to the language-specific "
33902 "documentation for more details on that."
33903 msgstr ""
33904
33905 #. type: textblock
33906 #: ../src/guestfs.pod:1693
33907 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
33908 msgstr ""
33909
33910 #. type: =head2
33911 #: ../src/guestfs.pod:1695
33912 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
33913 msgstr ""
33914
33915 #. type: textblock
33916 #: ../src/guestfs.pod:1697
33917 msgid ""
33918 "B<Note:> This section documents the generic event mechanism introduced in "
33919 "libguestfs 1.10, which you should use in new code if possible.  The old "
33920 "functions C<guestfs_set_log_message_callback>, "
33921 "C<guestfs_set_subprocess_quit_callback>, "
33922 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
33923 "C<guestfs_set_progress_callback> are no longer documented in this manual "
33924 "page.  Because of the ABI guarantee, the old functions continue to work."
33925 msgstr ""
33926
33927 #. type: textblock
33928 #: ../src/guestfs.pod:1706
33929 msgid ""
33930 "Handles generate events when certain things happen, such as log messages "
33931 "being generated, progress messages during long-running operations, or the "
33932 "handle being closed.  The API calls described below let you register a "
33933 "callback to be called when events happen.  You can register multiple "
33934 "callbacks (for the same, different or overlapping sets of events), and "
33935 "individually remove callbacks.  If callbacks are not removed, then they "
33936 "remain in force until the handle is closed."
33937 msgstr ""
33938
33939 #. type: textblock
33940 #: ../src/guestfs.pod:1714
33941 msgid ""
33942 "In the current implementation, events are only generated synchronously: that "
33943 "means that events (and hence callbacks) can only happen while you are in the "
33944 "middle of making another libguestfs call.  The callback is called in the "
33945 "same thread."
33946 msgstr ""
33947
33948 #. type: textblock
33949 #: ../src/guestfs.pod:1719
33950 msgid ""
33951 "Events may contain a payload, usually nothing (void), an array of 64 bit "
33952 "unsigned integers, or a message buffer.  Payloads are discussed later on."
33953 msgstr ""
33954
33955 #. type: =head3
33956 #: ../src/guestfs.pod:1723
33957 msgid "CLASSES OF EVENTS"
33958 msgstr ""
33959
33960 #. type: =item
33961 #: ../src/guestfs.pod:1727
33962 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
33963 msgstr ""
33964
33965 #. type: textblock
33966 #: ../src/guestfs.pod:1730
33967 msgid ""
33968 "The callback function will be called while the handle is being closed "
33969 "(synchronously from L</guestfs_close>)."
33970 msgstr ""
33971
33972 #. type: textblock
33973 #: ../src/guestfs.pod:1733
33974 msgid ""
33975 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
33976 "handles that are open when the program exits.  This means that this callback "
33977 "might be called indirectly from L<exit(3)>, which can cause unexpected "
33978 "problems in higher-level languages (eg. if your HLL interpreter has already "
33979 "been cleaned up by the time this is called, and if your callback then jumps "
33980 "into some HLL function)."
33981 msgstr ""
33982
33983 #. type: textblock
33984 #: ../src/guestfs.pod:1740
33985 msgid ""
33986 "If no callback is registered: the handle is closed without any callback "
33987 "being invoked."
33988 msgstr ""
33989
33990 #. type: =item
33991 #: ../src/guestfs.pod:1743
33992 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
33993 msgstr ""
33994
33995 #. type: textblock
33996 #: ../src/guestfs.pod:1746
33997 msgid ""
33998 "The callback function will be called when the child process quits, either "
33999 "asynchronously or if killed by L</guestfs_kill_subprocess>.  (This "
34000 "corresponds to a transition from any state to the CONFIG state)."
34001 msgstr ""
34002
34003 #. type: textblock
34004 #: ../src/guestfs.pod:1750 ../src/guestfs.pod:1759 ../src/guestfs.pod:1876
34005 msgid "If no callback is registered: the event is ignored."
34006 msgstr ""
34007
34008 #. type: =item
34009 #: ../src/guestfs.pod:1752
34010 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
34011 msgstr ""
34012
34013 #. type: textblock
34014 #: ../src/guestfs.pod:1755
34015 msgid ""
34016 "The callback function will be called when the child process becomes ready "
34017 "first time after it has been launched.  (This corresponds to a transition "
34018 "from LAUNCHING to the READY state)."
34019 msgstr ""
34020
34021 #. type: =item
34022 #: ../src/guestfs.pod:1761
34023 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
34024 msgstr ""
34025
34026 #. type: textblock
34027 #: ../src/guestfs.pod:1764
34028 msgid ""
34029 "Some long-running operations can generate progress messages.  If this "
34030 "callback is registered, then it will be called each time a progress message "
34031 "is generated (usually two seconds after the operation started, and three "
34032 "times per second thereafter until it completes, although the frequency may "
34033 "change in future versions)."
34034 msgstr ""
34035
34036 #. type: textblock
34037 #: ../src/guestfs.pod:1770
34038 msgid ""
34039 "The callback receives in the payload four unsigned 64 bit numbers which are "
34040 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
34041 msgstr ""
34042
34043 #. type: textblock
34044 #: ../src/guestfs.pod:1773
34045 msgid ""
34046 "The units of C<total> are not defined, although for some operations C<total> "
34047 "may relate in some way to the amount of data to be transferred (eg. in bytes "
34048 "or megabytes), and C<position> may be the portion which has been "
34049 "transferred."
34050 msgstr ""
34051
34052 #. type: textblock
34053 #: ../src/guestfs.pod:1778
34054 msgid "The only defined and stable parts of the API are:"
34055 msgstr ""
34056
34057 #. type: textblock
34058 #: ../src/guestfs.pod:1784
34059 msgid ""
34060 "The callback can display to the user some type of progress bar or indicator "
34061 "which shows the ratio of C<position>:C<total>."
34062 msgstr ""
34063
34064 #. type: textblock
34065 #: ../src/guestfs.pod:1789
34066 msgid "0 E<lt>= C<position> E<lt>= C<total>"
34067 msgstr ""
34068
34069 #. type: textblock
34070 #: ../src/guestfs.pod:1793
34071 msgid ""
34072 "If any progress notification is sent during a call, then a final progress "
34073 "notification is always sent when C<position> = C<total> (I<unless> the call "
34074 "fails with an error)."
34075 msgstr ""
34076
34077 #. type: textblock
34078 #: ../src/guestfs.pod:1797
34079 msgid ""
34080 "This is to simplify caller code, so callers can easily set the progress "
34081 "indicator to \"100%\" at the end of the operation, without requiring special "
34082 "code to detect this case."
34083 msgstr ""
34084
34085 #. type: textblock
34086 #: ../src/guestfs.pod:1803
34087 msgid ""
34088 "For some calls we are unable to estimate the progress of the call, but we "
34089 "can still generate progress messages to indicate activity.  This is known as "
34090 "\"pulse mode\", and is directly supported by certain progress bar "
34091 "implementations (eg. GtkProgressBar)."
34092 msgstr ""
34093
34094 #. type: textblock
34095 #: ../src/guestfs.pod:1808
34096 msgid ""
34097 "For these calls, zero or more progress messages are generated with "
34098 "C<position = 0> and C<total = 1>, followed by a final message with "
34099 "C<position = total = 1>."
34100 msgstr ""
34101
34102 #. type: textblock
34103 #: ../src/guestfs.pod:1812
34104 msgid ""
34105 "As noted above, if the call fails with an error then the final message may "
34106 "not be generated."
34107 msgstr ""
34108
34109 #. type: textblock
34110 #: ../src/guestfs.pod:1817
34111 msgid ""
34112 "The callback also receives the procedure number (C<proc_nr>) and serial "
34113 "number (C<serial>) of the call.  These are only useful for debugging "
34114 "protocol issues, and the callback can normally ignore them.  The callback "
34115 "may want to print these numbers in error messages or debugging messages."
34116 msgstr ""
34117
34118 #. type: textblock
34119 #: ../src/guestfs.pod:1823
34120 msgid "If no callback is registered: progress messages are discarded."
34121 msgstr ""
34122
34123 #. type: =item
34124 #: ../src/guestfs.pod:1825
34125 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
34126 msgstr ""
34127
34128 #. type: textblock
34129 #: ../src/guestfs.pod:1828
34130 msgid ""
34131 "The callback function is called whenever a log message is generated by qemu, "
34132 "the appliance kernel, guestfsd (daemon), or utility programs."
34133 msgstr ""
34134
34135 #. type: textblock
34136 #: ../src/guestfs.pod:1831
34137 msgid ""
34138 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
34139 "(L</guestfs_launch>) then additional debug messages are generated."
34140 msgstr ""
34141
34142 #. type: textblock
34143 #: ../src/guestfs.pod:1834 ../src/guestfs.pod:1848
34144 msgid ""
34145 "If no callback is registered: the messages are discarded unless the verbose "
34146 "flag is set in which case they are sent to stderr.  You can override the "
34147 "printing of verbose messages to stderr by setting up a callback."
34148 msgstr ""
34149
34150 #. type: =item
34151 #: ../src/guestfs.pod:1839
34152 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
34153 msgstr ""
34154
34155 #. type: textblock
34156 #: ../src/guestfs.pod:1842
34157 msgid ""
34158 "The callback function is called whenever a log message is generated by the "
34159 "library part of libguestfs."
34160 msgstr ""
34161
34162 #. type: textblock
34163 #: ../src/guestfs.pod:1845
34164 msgid ""
34165 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
34166 "messages are generated."
34167 msgstr ""
34168
34169 #. type: =item
34170 #: ../src/guestfs.pod:1853
34171 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
34172 msgstr ""
34173
34174 #. type: textblock
34175 #: ../src/guestfs.pod:1856
34176 msgid ""
34177 "The callback function is called whenever a trace message is generated.  This "
34178 "only applies if the trace flag (L</guestfs_set_trace>) is set."
34179 msgstr ""
34180
34181 #. type: textblock
34182 #: ../src/guestfs.pod:1859
34183 msgid ""
34184 "If no callback is registered: the messages are sent to stderr.  You can "
34185 "override the printing of trace messages to stderr by setting up a callback."
34186 msgstr ""
34187
34188 #. type: =item
34189 #: ../src/guestfs.pod:1863
34190 msgid "GUESTFS_EVENT_ENTER (payload type: function name)"
34191 msgstr ""
34192
34193 #. type: textblock
34194 #: ../src/guestfs.pod:1866
34195 msgid "The callback function is called whenever a libguestfs function is entered."
34196 msgstr ""
34197
34198 #. type: textblock
34199 #: ../src/guestfs.pod:1869
34200 msgid ""
34201 "The payload is a string which contains the name of the function that we are "
34202 "entering (not including C<guestfs_> prefix)."
34203 msgstr ""
34204
34205 #. type: textblock
34206 #: ../src/guestfs.pod:1872
34207 msgid ""
34208 "Note that libguestfs functions can call themselves, so you may see many "
34209 "events from a single call.  A few libguestfs functions do not generate this "
34210 "event."
34211 msgstr ""
34212
34213 #. type: =head3
34214 #: ../src/guestfs.pod:1880
34215 msgid "guestfs_set_event_callback"
34216 msgstr ""
34217
34218 #. type: verbatim
34219 #: ../src/guestfs.pod:1882
34220 #, no-wrap
34221 msgid ""
34222 " int guestfs_set_event_callback (guestfs_h *g,\n"
34223 "                                 guestfs_event_callback cb,\n"
34224 "                                 uint64_t event_bitmask,\n"
34225 "                                 int flags,\n"
34226 "                                 void *opaque);\n"
34227 "\n"
34228 msgstr ""
34229
34230 #. type: textblock
34231 #: ../src/guestfs.pod:1888
34232 msgid ""
34233 "This function registers a callback (C<cb>) for all event classes in the "
34234 "C<event_bitmask>."
34235 msgstr ""
34236
34237 #. type: textblock
34238 #: ../src/guestfs.pod:1891
34239 msgid ""
34240 "For example, to register for all log message events, you could call this "
34241 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>.  "
34242 "To register a single callback for all possible classes of events, use "
34243 "C<GUESTFS_EVENT_ALL>."
34244 msgstr ""
34245
34246 #. type: textblock
34247 #: ../src/guestfs.pod:1897
34248 msgid "C<flags> should always be passed as 0."
34249 msgstr ""
34250
34251 #. type: textblock
34252 #: ../src/guestfs.pod:1899
34253 msgid ""
34254 "C<opaque> is an opaque pointer which is passed to the callback.  You can use "
34255 "it for any purpose."
34256 msgstr ""
34257
34258 #. type: textblock
34259 #: ../src/guestfs.pod:1902
34260 msgid ""
34261 "The return value is the event handle (an integer) which you can use to "
34262 "delete the callback (see below)."
34263 msgstr ""
34264
34265 #. type: textblock
34266 #: ../src/guestfs.pod:1905
34267 msgid ""
34268 "If there is an error, this function returns C<-1>, and sets the error in the "
34269 "handle in the usual way (see L</guestfs_last_error> etc.)"
34270 msgstr ""
34271
34272 #. type: textblock
34273 #: ../src/guestfs.pod:1908
34274 msgid ""
34275 "Callbacks remain in effect until they are deleted, or until the handle is "
34276 "closed."
34277 msgstr ""
34278
34279 #. type: textblock
34280 #: ../src/guestfs.pod:1911
34281 msgid ""
34282 "In the case where multiple callbacks are registered for a particular event "
34283 "class, all of the callbacks are called.  The order in which multiple "
34284 "callbacks are called is not defined."
34285 msgstr ""
34286
34287 #. type: =head3
34288 #: ../src/guestfs.pod:1915
34289 msgid "guestfs_delete_event_callback"
34290 msgstr ""
34291
34292 #. type: verbatim
34293 #: ../src/guestfs.pod:1917
34294 #, no-wrap
34295 msgid ""
34296 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
34297 "\n"
34298 msgstr ""
34299
34300 #. type: textblock
34301 #: ../src/guestfs.pod:1919
34302 msgid ""
34303 "Delete a callback that was previously registered.  C<event_handle> should be "
34304 "the integer that was returned by a previous call to "
34305 "C<guestfs_set_event_callback> on the same handle."
34306 msgstr ""
34307
34308 #. type: =head3
34309 #: ../src/guestfs.pod:1923
34310 msgid "guestfs_event_callback"
34311 msgstr ""
34312
34313 #. type: verbatim
34314 #: ../src/guestfs.pod:1925
34315 #, no-wrap
34316 msgid ""
34317 " typedef void (*guestfs_event_callback) (\n"
34318 "                  guestfs_h *g,\n"
34319 "                  void *opaque,\n"
34320 "                  uint64_t event,\n"
34321 "                  int event_handle,\n"
34322 "                  int flags,\n"
34323 "                  const char *buf, size_t buf_len,\n"
34324 "                  const uint64_t *array, size_t array_len);\n"
34325 "\n"
34326 msgstr ""
34327
34328 #. type: textblock
34329 #: ../src/guestfs.pod:1934
34330 msgid "This is the type of the event callback function that you have to provide."
34331 msgstr ""
34332
34333 #. type: textblock
34334 #: ../src/guestfs.pod:1937
34335 msgid ""
34336 "The basic parameters are: the handle (C<g>), the opaque user pointer "
34337 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
34338 "handle, and C<flags> which in the current API you should ignore."
34339 msgstr ""
34340
34341 #. type: textblock
34342 #: ../src/guestfs.pod:1941
34343 msgid ""
34344 "The remaining parameters contain the event payload (if any).  Each event may "
34345 "contain a payload, which usually relates to the event class, but for future "
34346 "proofing your code should be written to handle any payload for any event "
34347 "class."
34348 msgstr ""
34349
34350 #. type: textblock
34351 #: ../src/guestfs.pod:1946
34352 msgid ""
34353 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
34354 "there is no message buffer).  Note that this message buffer can contain "
34355 "arbitrary 8 bit data, including NUL bytes."
34356 msgstr ""
34357
34358 #. type: textblock
34359 #: ../src/guestfs.pod:1950
34360 msgid ""
34361 "C<array> and C<array_len> is an array of 64 bit unsigned integers.  At the "
34362 "moment this is only used for progress messages."
34363 msgstr ""
34364
34365 #. type: =head3
34366 #: ../src/guestfs.pod:1953
34367 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
34368 msgstr ""
34369
34370 #. type: textblock
34371 #: ../src/guestfs.pod:1955
34372 msgid ""
34373 "One motivation for the generic event API was to allow GUI programs to "
34374 "capture debug and other messages.  In libguestfs E<le> 1.8 these were sent "
34375 "unconditionally to C<stderr>."
34376 msgstr ""
34377
34378 #. type: textblock
34379 #: ../src/guestfs.pod:1959
34380 msgid ""
34381 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
34382 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>.  (Note that error "
34383 "messages are not events; you must capture error messages separately)."
34384 msgstr ""
34385
34386 #. type: textblock
34387 #: ../src/guestfs.pod:1964
34388 msgid ""
34389 "Programs have to set up a callback to capture the classes of events of "
34390 "interest:"
34391 msgstr ""
34392
34393 #. type: verbatim
34394 #: ../src/guestfs.pod:1967
34395 #, no-wrap
34396 msgid ""
34397 " int eh =\n"
34398 "   guestfs_set_event_callback\n"
34399 "     (g, message_callback,\n"
34400 "      GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
34401 "      GUESTFS_EVENT_TRACE,\n"
34402 "      0, NULL) == -1)\n"
34403 " if (eh == -1) {\n"
34404 "   // handle error in the usual way\n"
34405 " }\n"
34406 "\n"
34407 msgstr ""
34408
34409 #. type: textblock
34410 #: ../src/guestfs.pod:1977
34411 msgid ""
34412 "The callback can then direct messages to the appropriate place.  In this "
34413 "example, messages are directed to syslog:"
34414 msgstr ""
34415
34416 #. type: verbatim
34417 #: ../src/guestfs.pod:1980
34418 #, no-wrap
34419 msgid ""
34420 " static void\n"
34421 " message_callback (\n"
34422 "         guestfs_h *g,\n"
34423 "         void *opaque,\n"
34424 "         uint64_t event,\n"
34425 "         int event_handle,\n"
34426 "         int flags,\n"
34427 "         const char *buf, size_t buf_len,\n"
34428 "         const uint64_t *array, size_t array_len)\n"
34429 " {\n"
34430 "   const int priority = LOG_USER|LOG_INFO;\n"
34431 "   if (buf_len > 0)\n"
34432 "     syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
34433 " }\n"
34434 "\n"
34435 msgstr ""
34436
34437 #. type: =head1
34438 #: ../src/guestfs.pod:1995
34439 msgid "CANCELLING LONG TRANSFERS"
34440 msgstr ""
34441
34442 #. type: textblock
34443 #: ../src/guestfs.pod:1997
34444 msgid ""
34445 "Some operations can be cancelled by the caller while they are in progress.  "
34446 "Currently only operations that involve uploading or downloading data can be "
34447 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
34448 "parameters in the generator)."
34449 msgstr ""
34450
34451 #. type: =head2
34452 #: ../src/guestfs.pod:2002
34453 msgid "guestfs_user_cancel"
34454 msgstr ""
34455
34456 #. type: verbatim
34457 #: ../src/guestfs.pod:2004
34458 #, no-wrap
34459 msgid ""
34460 " void guestfs_user_cancel (guestfs_h *g);\n"
34461 "\n"
34462 msgstr ""
34463
34464 #. type: textblock
34465 #: ../src/guestfs.pod:2006
34466 msgid "C<guestfs_user_cancel> cancels the current upload or download operation."
34467 msgstr ""
34468
34469 #. type: textblock
34470 #: ../src/guestfs.pod:2009
34471 msgid ""
34472 "Unlike most other libguestfs calls, this function is signal safe and thread "
34473 "safe.  You can call it from a signal handler or from another thread, without "
34474 "needing to do any locking."
34475 msgstr ""
34476
34477 #. type: textblock
34478 #: ../src/guestfs.pod:2013
34479 msgid ""
34480 "The transfer that was in progress (if there is one) will stop shortly "
34481 "afterwards, and will return an error.  The errno (see "
34482 "L</guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
34483 "out if the operation was cancelled or failed because of another error."
34484 msgstr ""
34485
34486 #. type: textblock
34487 #: ../src/guestfs.pod:2019
34488 msgid ""
34489 "No cleanup is performed: for example, if a file was being uploaded then "
34490 "after cancellation there may be a partially uploaded file.  It is the "
34491 "caller's responsibility to clean up if necessary."
34492 msgstr ""
34493
34494 #. type: textblock
34495 #: ../src/guestfs.pod:2023
34496 msgid "There are two common places that you might call C<guestfs_user_cancel>."
34497 msgstr ""
34498
34499 #. type: textblock
34500 #: ../src/guestfs.pod:2025
34501 msgid ""
34502 "In an interactive text-based program, you might call it from a C<SIGINT> "
34503 "signal handler so that pressing C<^C> cancels the current operation.  (You "
34504 "also need to call L</guestfs_set_pgroup> so that child processes don't "
34505 "receive the C<^C> signal)."
34506 msgstr ""
34507
34508 #. type: textblock
34509 #: ../src/guestfs.pod:2030
34510 msgid ""
34511 "In a graphical program, when the main thread is displaying a progress bar "
34512 "with a cancel button, wire up the cancel button to call this function."
34513 msgstr ""
34514
34515 #. type: =head1
34516 #: ../src/guestfs.pod:2034
34517 msgid "PRIVATE DATA AREA"
34518 msgstr ""
34519
34520 #. type: textblock
34521 #: ../src/guestfs.pod:2036
34522 msgid ""
34523 "You can attach named pieces of private data to the libguestfs handle, fetch "
34524 "them by name, and walk over them, for the lifetime of the handle.  This is "
34525 "called the private data area and is only available from the C API."
34526 msgstr ""
34527
34528 #. type: textblock
34529 #: ../src/guestfs.pod:2041
34530 msgid "To attach a named piece of data, use the following call:"
34531 msgstr ""
34532
34533 #. type: verbatim
34534 #: ../src/guestfs.pod:2043
34535 #, no-wrap
34536 msgid ""
34537 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
34538 "\n"
34539 msgstr ""
34540
34541 #. type: textblock
34542 #: ../src/guestfs.pod:2045
34543 msgid ""
34544 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
34545 "pointer (which can be C<NULL>).  Any previous item with the same key is "
34546 "overwritten."
34547 msgstr ""
34548
34549 #. type: textblock
34550 #: ../src/guestfs.pod:2049
34551 msgid ""
34552 "You can use any C<key> you want, but your key should I<not> start with an "
34553 "underscore character.  Keys beginning with an underscore character are "
34554 "reserved for internal libguestfs purposes (eg. for implementing language "
34555 "bindings).  It is recommended that you prefix the key with some unique "
34556 "string to avoid collisions with other users."
34557 msgstr ""
34558
34559 #. type: textblock
34560 #: ../src/guestfs.pod:2055
34561 msgid "To retrieve the pointer, use:"
34562 msgstr ""
34563
34564 #. type: verbatim
34565 #: ../src/guestfs.pod:2057
34566 #, no-wrap
34567 msgid ""
34568 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
34569 "\n"
34570 msgstr ""
34571
34572 #. type: textblock
34573 #: ../src/guestfs.pod:2059
34574 msgid ""
34575 "This function returns C<NULL> if either no data is found associated with "
34576 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
34577 "C<NULL>."
34578 msgstr ""
34579
34580 #. type: textblock
34581 #: ../src/guestfs.pod:2063
34582 msgid ""
34583 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
34584 "way.  As far as libguestfs is concerned, it need not be a valid pointer at "
34585 "all.  In particular, libguestfs does I<not> try to free the data when the "
34586 "handle is closed.  If the data must be freed, then the caller must either "
34587 "free it before calling L</guestfs_close> or must set up a close callback to "
34588 "do it (see L</GUESTFS_EVENT_CLOSE>)."
34589 msgstr ""
34590
34591 #. type: textblock
34592 #: ../src/guestfs.pod:2070
34593 msgid "To walk over all entries, use these two functions:"
34594 msgstr ""
34595
34596 #. type: verbatim
34597 #: ../src/guestfs.pod:2072
34598 #, no-wrap
34599 msgid ""
34600 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
34601 "\n"
34602 msgstr ""
34603
34604 #. type: verbatim
34605 #: ../src/guestfs.pod:2074
34606 #, no-wrap
34607 msgid ""
34608 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
34609 "\n"
34610 msgstr ""
34611
34612 #. type: textblock
34613 #: ../src/guestfs.pod:2076
34614 msgid ""
34615 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
34616 "not have any particular meaning -- keys are not returned in any defined "
34617 "order).  A pointer to the key is returned in C<*key_rtn> and the "
34618 "corresponding data pointer is returned from the function.  C<NULL> is "
34619 "returned if there are no keys stored in the handle."
34620 msgstr ""
34621
34622 #. type: textblock
34623 #: ../src/guestfs.pod:2082
34624 msgid ""
34625 "C<guestfs_next_private> returns the next key, pointer pair.  The return "
34626 "value of this function is also C<NULL> is there are no further entries to "
34627 "return."
34628 msgstr ""
34629
34630 #. type: textblock
34631 #: ../src/guestfs.pod:2086
34632 msgid "Notes about walking over entries:"
34633 msgstr ""
34634
34635 #. type: textblock
34636 #: ../src/guestfs.pod:2092
34637 msgid "You must not call C<guestfs_set_private> while walking over the entries."
34638 msgstr ""
34639
34640 #. type: textblock
34641 #: ../src/guestfs.pod:2097
34642 msgid ""
34643 "The handle maintains an internal iterator which is reset when you call "
34644 "C<guestfs_first_private>.  This internal iterator is invalidated when you "
34645 "call C<guestfs_set_private>."
34646 msgstr ""
34647
34648 #. type: textblock
34649 #: ../src/guestfs.pod:2103
34650 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
34651 msgstr ""
34652
34653 #. type: verbatim
34654 #: ../src/guestfs.pod:2105
34655 #, no-wrap
34656 msgid ""
34657 " guestfs_set_private (g, key, NULL);\n"
34658 "\n"
34659 msgstr ""
34660
34661 #. type: textblock
34662 #: ../src/guestfs.pod:2107
34663 msgid "then that C<key> is not returned when walking."
34664 msgstr ""
34665
34666 #. type: textblock
34667 #: ../src/guestfs.pod:2111
34668 msgid ""
34669 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
34670 "C<guestfs_next_private> or C<guestfs_set_private>."
34671 msgstr ""
34672
34673 #. type: textblock
34674 #: ../src/guestfs.pod:2117
34675 msgid ""
34676 "The following example code shows how to print all keys and data pointers "
34677 "that are associated with the handle C<g>:"
34678 msgstr ""
34679
34680 #. type: verbatim
34681 #: ../src/guestfs.pod:2120
34682 #, no-wrap
34683 msgid ""
34684 " const char *key;\n"
34685 " void *data = guestfs_first_private (g, &key);\n"
34686 " while (data != NULL)\n"
34687 "   {\n"
34688 "     printf (\"key = %s, data = %p\\n\", key, data);\n"
34689 "     data = guestfs_next_private (g, &key);\n"
34690 "   }\n"
34691 "\n"
34692 msgstr ""
34693
34694 #. type: textblock
34695 #: ../src/guestfs.pod:2128
34696 msgid ""
34697 "More commonly you are only interested in keys that begin with an "
34698 "application-specific prefix C<foo_>.  Modify the loop like so:"
34699 msgstr ""
34700
34701 #. type: verbatim
34702 #: ../src/guestfs.pod:2131
34703 #, no-wrap
34704 msgid ""
34705 " const char *key;\n"
34706 " void *data = guestfs_first_private (g, &key);\n"
34707 " while (data != NULL)\n"
34708 "   {\n"
34709 "     if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
34710 "       printf (\"key = %s, data = %p\\n\", key, data);\n"
34711 "     data = guestfs_next_private (g, &key);\n"
34712 "   }\n"
34713 "\n"
34714 msgstr ""
34715
34716 #. type: textblock
34717 #: ../src/guestfs.pod:2140
34718 msgid ""
34719 "If you need to modify keys while walking, then you have to jump back to the "
34720 "beginning of the loop.  For example, to delete all keys prefixed with "
34721 "C<foo_>:"
34722 msgstr ""
34723
34724 #. type: verbatim
34725 #: ../src/guestfs.pod:2144
34726 #, no-wrap
34727 msgid ""
34728 "  const char *key;\n"
34729 "  void *data;\n"
34730 " again:\n"
34731 "  data = guestfs_first_private (g, &key);\n"
34732 "  while (data != NULL)\n"
34733 "    {\n"
34734 "      if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
34735 "        {\n"
34736 "          guestfs_set_private (g, key, NULL);\n"
34737 "          /* note that 'key' pointer is now invalid, and so is\n"
34738 "             the internal iterator */\n"
34739 "          goto again;\n"
34740 "        }\n"
34741 "      data = guestfs_next_private (g, &key);\n"
34742 "    }\n"
34743 "\n"
34744 msgstr ""
34745
34746 #. type: textblock
34747 #: ../src/guestfs.pod:2160
34748 msgid ""
34749 "Note that the above loop is guaranteed to terminate because the keys are "
34750 "being deleted, but other manipulations of keys within the loop might not "
34751 "terminate unless you also maintain an indication of which keys have been "
34752 "visited."
34753 msgstr ""
34754
34755 #. type: =end
34756 #: ../src/guestfs.pod:2165 ../src/guestfs.pod:2170
34757 msgid "html"
34758 msgstr ""
34759
34760 #. type: textblock
34761 #: ../src/guestfs.pod:2167
34762 msgid ""
34763 "<!-- old anchor for the next section --> <a "
34764 "name=\"state_machine_and_low_level_event_api\"/>"
34765 msgstr ""
34766
34767 #. type: =head1
34768 #: ../src/guestfs.pod:2172
34769 msgid "ARCHITECTURE"
34770 msgstr ""
34771
34772 #. type: textblock
34773 #: ../src/guestfs.pod:2174
34774 msgid ""
34775 "Internally, libguestfs is implemented by running an appliance (a special "
34776 "type of small virtual machine) using L<qemu(1)>.  Qemu runs as a child "
34777 "process of the main program."
34778 msgstr ""
34779
34780 #. type: verbatim
34781 #: ../src/guestfs.pod:2178
34782 #, no-wrap
34783 msgid ""
34784 "  ___________________\n"
34785 " /                   \\\n"
34786 " | main program      |\n"
34787 " |                   |\n"
34788 " |                   |           child process / appliance\n"
34789 " |                   |           __________________________\n"
34790 " |                   |          / qemu                     \\\n"
34791 " +-------------------+   RPC    |      +-----------------+ |\n"
34792 " | libguestfs     <--------------------> guestfsd        | |\n"
34793 " |                   |          |      +-----------------+ |\n"
34794 " \\___________________/          |      | Linux kernel    | |\n"
34795 "                                |      +--^--------------+ |\n"
34796 "                                \\_________|________________/\n"
34797 "                                          |\n"
34798 "                                   _______v______\n"
34799 "                                  /              \\\n"
34800 "                                  | Device or    |\n"
34801 "                                  | disk image   |\n"
34802 "                                  \\______________/\n"
34803 "\n"
34804 msgstr ""
34805
34806 #. type: textblock
34807 #: ../src/guestfs.pod:2198
34808 msgid ""
34809 "The library, linked to the main program, creates the child process and hence "
34810 "the appliance in the L</guestfs_launch> function."
34811 msgstr ""
34812
34813 #. type: textblock
34814 #: ../src/guestfs.pod:2201
34815 msgid ""
34816 "Inside the appliance is a Linux kernel and a complete stack of userspace "
34817 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
34818 "L</guestfsd>.  The library talks to L</guestfsd> using remote procedure "
34819 "calls (RPC).  There is a mostly one-to-one correspondence between libguestfs "
34820 "API calls and RPC calls to the daemon.  Lastly the disk image(s) are "
34821 "attached to the qemu process which translates device access by the "
34822 "appliance's Linux kernel into accesses to the image."
34823 msgstr ""
34824
34825 #. type: textblock
34826 #: ../src/guestfs.pod:2210
34827 msgid ""
34828 "A common misunderstanding is that the appliance \"is\" the virtual machine.  "
34829 "Although the disk image you are attached to might also be used by some "
34830 "virtual machine, libguestfs doesn't know or care about this.  (But you will "
34831 "care if both libguestfs's qemu process and your virtual machine are trying "
34832 "to update the disk image at the same time, since these usually results in "
34833 "massive disk corruption)."
34834 msgstr ""
34835
34836 #. type: =head1
34837 #: ../src/guestfs.pod:2217
34838 msgid "STATE MACHINE"
34839 msgstr ""
34840
34841 #. type: textblock
34842 #: ../src/guestfs.pod:2219
34843 msgid "libguestfs uses a state machine to model the child process:"
34844 msgstr ""
34845
34846 #. type: verbatim
34847 #: ../src/guestfs.pod:2221
34848 #, no-wrap
34849 msgid ""
34850 "                         |\n"
34851 "                    guestfs_create\n"
34852 "                         |\n"
34853 "                         |\n"
34854 "                     ____V_____\n"
34855 "                    /          \\\n"
34856 "                    |  CONFIG  |\n"
34857 "                    \\__________/\n"
34858 "                     ^ ^   ^  \\\n"
34859 "                    /  |    \\  \\ guestfs_launch\n"
34860 "                   /   |    _\\__V______\n"
34861 "                  /    |   /           \\\n"
34862 "                 /     |   | LAUNCHING |\n"
34863 "                /      |   \\___________/\n"
34864 "               /       |       /\n"
34865 "              /        |  guestfs_launch\n"
34866 "             /         |     /\n"
34867 "    ______  /        __|____V\n"
34868 "   /      \\ ------> /        \\\n"
34869 "   | BUSY |         | READY  |\n"
34870 "   \\______/ <------ \\________/\n"
34871 "\n"
34872 msgstr ""
34873
34874 #. type: textblock
34875 #: ../src/guestfs.pod:2243
34876 msgid ""
34877 "The normal transitions are (1) CONFIG (when the handle is created, but there "
34878 "is no child process), (2) LAUNCHING (when the child process is booting up), "
34879 "(3) alternating between READY and BUSY as commands are issued to, and "
34880 "carried out by, the child process."
34881 msgstr ""
34882
34883 #. type: textblock
34884 #: ../src/guestfs.pod:2248
34885 msgid ""
34886 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
34887 "asynchronously at any time (eg. due to some internal error), and that causes "
34888 "the state to transition back to CONFIG."
34889 msgstr ""
34890
34891 #. type: textblock
34892 #: ../src/guestfs.pod:2252
34893 msgid ""
34894 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
34895 "issued when in the CONFIG state."
34896 msgstr ""
34897
34898 #. type: textblock
34899 #: ../src/guestfs.pod:2255
34900 msgid ""
34901 "The API offers one call that goes from CONFIG through LAUNCHING to READY.  "
34902 "L</guestfs_launch> blocks until the child process is READY to accept "
34903 "commands (or until some failure or timeout).  L</guestfs_launch> internally "
34904 "moves the state from CONFIG to LAUNCHING while it is running."
34905 msgstr ""
34906
34907 #. type: textblock
34908 #: ../src/guestfs.pod:2261
34909 msgid ""
34910 "API actions such as L</guestfs_mount> can only be issued when in the READY "
34911 "state.  These API calls block waiting for the command to be carried out "
34912 "(ie. the state to transition to BUSY and then back to READY).  There are no "
34913 "non-blocking versions, and no way to issue more than one command per handle "
34914 "at the same time."
34915 msgstr ""
34916
34917 #. type: textblock
34918 #: ../src/guestfs.pod:2267
34919 msgid ""
34920 "Finally, the child process sends asynchronous messages back to the main "
34921 "program, such as kernel log messages.  You can register a callback to "
34922 "receive these messages."
34923 msgstr ""
34924
34925 #. type: =head1
34926 #: ../src/guestfs.pod:2271
34927 msgid "INTERNALS"
34928 msgstr ""
34929
34930 #. type: =head2
34931 #: ../src/guestfs.pod:2273
34932 msgid "APPLIANCE BOOT PROCESS"
34933 msgstr ""
34934
34935 #. type: textblock
34936 #: ../src/guestfs.pod:2275
34937 msgid ""
34938 "This process has evolved and continues to evolve.  The description here "
34939 "corresponds only to the current version of libguestfs and is provided for "
34940 "information only."
34941 msgstr ""
34942
34943 #. type: textblock
34944 #: ../src/guestfs.pod:2279
34945 msgid ""
34946 "In order to follow the stages involved below, enable libguestfs debugging "
34947 "(set the environment variable C<LIBGUESTFS_DEBUG=1>)."
34948 msgstr ""
34949
34950 #. type: =item
34951 #: ../src/guestfs.pod:2284
34952 msgid "Create the appliance"
34953 msgstr ""
34954
34955 #. type: textblock
34956 #: ../src/guestfs.pod:2286
34957 msgid ""
34958 "C<febootstrap-supermin-helper> is invoked to create the kernel, a small "
34959 "initrd and the appliance."
34960 msgstr ""
34961
34962 #. type: textblock
34963 #: ../src/guestfs.pod:2289
34964 msgid ""
34965 "The appliance is cached in C</var/tmp/.guestfs-E<lt>UIDE<gt>> (or in another "
34966 "directory if C<TMPDIR> is set)."
34967 msgstr ""
34968
34969 #. type: textblock
34970 #: ../src/guestfs.pod:2292
34971 msgid ""
34972 "For a complete description of how the appliance is created and cached, read "
34973 "the L<febootstrap(8)> and L<febootstrap-supermin-helper(8)> man pages."
34974 msgstr ""
34975
34976 #. type: =item
34977 #: ../src/guestfs.pod:2296
34978 msgid "Start qemu and boot the kernel"
34979 msgstr ""
34980
34981 #. type: textblock
34982 #: ../src/guestfs.pod:2298
34983 msgid "qemu is invoked to boot the kernel."
34984 msgstr ""
34985
34986 #. type: =item
34987 #: ../src/guestfs.pod:2300
34988 msgid "Run the initrd"
34989 msgstr ""
34990
34991 #. type: textblock
34992 #: ../src/guestfs.pod:2302
34993 msgid ""
34994 "C<febootstrap-supermin-helper> builds a small initrd.  The initrd is not the "
34995 "appliance.  The purpose of the initrd is to load enough kernel modules in "
34996 "order that the appliance itself can be mounted and started."
34997 msgstr ""
34998
34999 #. type: textblock
35000 #: ../src/guestfs.pod:2306
35001 msgid ""
35002 "The initrd is a cpio archive called "
35003 "C</var/tmp/.guestfs-E<lt>UIDE<gt>/initrd>."
35004 msgstr ""
35005
35006 #. type: textblock
35007 #: ../src/guestfs.pod:2309
35008 msgid ""
35009 "When the initrd has started you will see messages showing that kernel "
35010 "modules are being loaded, similar to this:"
35011 msgstr ""
35012
35013 #. type: verbatim
35014 #: ../src/guestfs.pod:2312
35015 #, no-wrap
35016 msgid ""
35017 " febootstrap: ext2 mini initrd starting up\n"
35018 " febootstrap: mounting /sys\n"
35019 " febootstrap: internal insmod libcrc32c.ko\n"
35020 " febootstrap: internal insmod crc32c-intel.ko\n"
35021 "\n"
35022 msgstr ""
35023
35024 #. type: =item
35025 #: ../src/guestfs.pod:2317
35026 msgid "Find and mount the appliance device"
35027 msgstr ""
35028
35029 #. type: textblock
35030 #: ../src/guestfs.pod:2319
35031 msgid ""
35032 "The appliance is a sparse file containing an ext2 filesystem which contains "
35033 "a familiar (although reduced in size) Linux operating system.  It would "
35034 "normally be called C</var/tmp/.guestfs-E<lt>UIDE<gt>/root>."
35035 msgstr ""
35036
35037 #. type: textblock
35038 #: ../src/guestfs.pod:2323
35039 msgid ""
35040 "The regular disks being inspected by libguestfs are the first devices "
35041 "exposed by qemu (eg. as C</dev/vda>)."
35042 msgstr ""
35043
35044 #. type: textblock
35045 #: ../src/guestfs.pod:2326
35046 msgid ""
35047 "The last disk added to qemu is the appliance itself (eg. C</dev/vdb> if "
35048 "there was only one regular disk)."
35049 msgstr ""
35050
35051 #. type: textblock
35052 #: ../src/guestfs.pod:2329
35053 msgid ""
35054 "Thus the final job of the initrd is to locate the appliance disk, mount it, "
35055 "and switch root into the appliance, and run C</init> from the appliance."
35056 msgstr ""
35057
35058 #. type: textblock
35059 #: ../src/guestfs.pod:2333
35060 msgid "If this works successfully you will see messages such as:"
35061 msgstr ""
35062
35063 #. type: verbatim
35064 #: ../src/guestfs.pod:2335
35065 #, no-wrap
35066 msgid ""
35067 " febootstrap: picked /sys/block/vdb/dev as root device\n"
35068 " febootstrap: creating /dev/root as block special 252:16\n"
35069 " febootstrap: mounting new root on /root\n"
35070 " febootstrap: chroot\n"
35071 " Starting /init script ...\n"
35072 "\n"
35073 msgstr ""
35074
35075 #. type: textblock
35076 #: ../src/guestfs.pod:2341
35077 msgid ""
35078 "Note that C<Starting /init script ...> indicates that the appliance's init "
35079 "script is now running."
35080 msgstr ""
35081
35082 #. type: =item
35083 #: ../src/guestfs.pod:2344
35084 msgid "Initialize the appliance"
35085 msgstr ""
35086
35087 #. type: textblock
35088 #: ../src/guestfs.pod:2346
35089 msgid ""
35090 "The appliance itself now initializes itself.  This involves starting certain "
35091 "processes like C<udev>, possibly printing some debug information, and "
35092 "finally running the daemon (C<guestfsd>)."
35093 msgstr ""
35094
35095 #. type: =item
35096 #: ../src/guestfs.pod:2350
35097 msgid "The daemon"
35098 msgstr ""
35099
35100 #. type: textblock
35101 #: ../src/guestfs.pod:2352
35102 msgid ""
35103 "Finally the daemon (C<guestfsd>) runs inside the appliance.  If it runs you "
35104 "should see:"
35105 msgstr ""
35106
35107 #. type: verbatim
35108 #: ../src/guestfs.pod:2355
35109 #, no-wrap
35110 msgid ""
35111 " verbose daemon enabled\n"
35112 "\n"
35113 msgstr ""
35114
35115 #. type: textblock
35116 #: ../src/guestfs.pod:2357
35117 msgid ""
35118 "The daemon expects to see a named virtio-serial port exposed by qemu and "
35119 "connected on the other end to the library."
35120 msgstr ""
35121
35122 #. type: textblock
35123 #: ../src/guestfs.pod:2360
35124 msgid ""
35125 "The daemon connects to this port (and hence to the library) and sends a four "
35126 "byte message C<GUESTFS_LAUNCH_FLAG>, which initiates the communication "
35127 "protocol (see below)."
35128 msgstr ""
35129
35130 #. type: =head2
35131 #: ../src/guestfs.pod:2366
35132 msgid "COMMUNICATION PROTOCOL"
35133 msgstr ""
35134
35135 #. type: textblock
35136 #: ../src/guestfs.pod:2368
35137 msgid ""
35138 "Don't rely on using this protocol directly.  This section documents how it "
35139 "currently works, but it may change at any time."
35140 msgstr ""
35141
35142 #. type: textblock
35143 #: ../src/guestfs.pod:2371
35144 msgid ""
35145 "The protocol used to talk between the library and the daemon running inside "
35146 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
35147 "1014, RFC 1832, RFC 4506)."
35148 msgstr ""
35149
35150 #. type: textblock
35151 #: ../src/guestfs.pod:2375
35152 msgid ""
35153 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
35154 "this file is automatically generated)."
35155 msgstr ""
35156
35157 #. type: textblock
35158 #: ../src/guestfs.pod:2378
35159 msgid ""
35160 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
35161 "and C<FileOut> parameters, which are handled with very simple request/reply "
35162 "messages.  Then there are functions that have any C<FileIn> or C<FileOut> "
35163 "parameters, which use the same request and reply messages, but they may also "
35164 "be followed by files sent using a chunked encoding."
35165 msgstr ""
35166
35167 #. type: =head3
35168 #: ../src/guestfs.pod:2385
35169 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
35170 msgstr ""
35171
35172 #. type: textblock
35173 #: ../src/guestfs.pod:2387
35174 msgid "For ordinary functions, the request message is:"
35175 msgstr ""
35176
35177 #. type: verbatim
35178 #: ../src/guestfs.pod:2389
35179 #, no-wrap
35180 msgid ""
35181 " total length (header + arguments,\n"
35182 "      but not including the length word itself)\n"
35183 " struct guestfs_message_header (encoded as XDR)\n"
35184 " struct guestfs_<foo>_args (encoded as XDR)\n"
35185 "\n"
35186 msgstr ""
35187
35188 #. type: textblock
35189 #: ../src/guestfs.pod:2394
35190 msgid ""
35191 "The total length field allows the daemon to allocate a fixed size buffer "
35192 "into which it slurps the rest of the message.  As a result, the total length "
35193 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
35194 "effective size of any request is limited to somewhere under this size."
35195 msgstr ""
35196
35197 #. type: textblock
35198 #: ../src/guestfs.pod:2400
35199 msgid ""
35200 "Note also that many functions don't take any arguments, in which case the "
35201 "C<guestfs_I<foo>_args> is completely omitted."
35202 msgstr ""
35203
35204 #. type: textblock
35205 #: ../src/guestfs.pod:2403
35206 msgid ""
35207 "The header contains the procedure number (C<guestfs_proc>) which is how the "
35208 "receiver knows what type of args structure to expect, or none at all."
35209 msgstr ""
35210
35211 #. type: textblock
35212 #: ../src/guestfs.pod:2407
35213 msgid ""
35214 "For functions that take optional arguments, the optional arguments are "
35215 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
35216 "arguments.  A bitmask in the header indicates which optional arguments are "
35217 "meaningful.  The bitmask is also checked to see if it contains bits set "
35218 "which the daemon does not know about (eg. if more optional arguments were "
35219 "added in a later version of the library), and this causes the call to be "
35220 "rejected."
35221 msgstr ""
35222
35223 #. type: textblock
35224 #: ../src/guestfs.pod:2415
35225 msgid "The reply message for ordinary functions is:"
35226 msgstr ""
35227
35228 #. type: verbatim
35229 #: ../src/guestfs.pod:2417
35230 #, no-wrap
35231 msgid ""
35232 " total length (header + ret,\n"
35233 "      but not including the length word itself)\n"
35234 " struct guestfs_message_header (encoded as XDR)\n"
35235 " struct guestfs_<foo>_ret (encoded as XDR)\n"
35236 "\n"
35237 msgstr ""
35238
35239 #. type: textblock
35240 #: ../src/guestfs.pod:2422
35241 msgid ""
35242 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
35243 "functions that return no formal return values."
35244 msgstr ""
35245
35246 #. type: textblock
35247 #: ../src/guestfs.pod:2425
35248 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
35249 msgstr ""
35250
35251 #. type: textblock
35252 #: ../src/guestfs.pod:2428
35253 msgid ""
35254 "In the case of an error, a flag is set in the header, and the reply message "
35255 "is slightly changed:"
35256 msgstr ""
35257
35258 #. type: verbatim
35259 #: ../src/guestfs.pod:2431
35260 #, no-wrap
35261 msgid ""
35262 " total length (header + error,\n"
35263 "      but not including the length word itself)\n"
35264 " struct guestfs_message_header (encoded as XDR)\n"
35265 " struct guestfs_message_error (encoded as XDR)\n"
35266 "\n"
35267 msgstr ""
35268
35269 #. type: textblock
35270 #: ../src/guestfs.pod:2436
35271 msgid ""
35272 "The C<guestfs_message_error> structure contains the error message as a "
35273 "string."
35274 msgstr ""
35275
35276 #. type: =head3
35277 #: ../src/guestfs.pod:2439
35278 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
35279 msgstr ""
35280
35281 #. type: textblock
35282 #: ../src/guestfs.pod:2441
35283 msgid ""
35284 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest.  "
35285 "The normal request message is sent (see above).  However this is followed by "
35286 "a sequence of file chunks."
35287 msgstr ""
35288
35289 #. type: verbatim
35290 #: ../src/guestfs.pod:2445
35291 #, no-wrap
35292 msgid ""
35293 " total length (header + arguments,\n"
35294 "      but not including the length word itself,\n"
35295 "      and not including the chunks)\n"
35296 " struct guestfs_message_header (encoded as XDR)\n"
35297 " struct guestfs_<foo>_args (encoded as XDR)\n"
35298 " sequence of chunks for FileIn param #0\n"
35299 " sequence of chunks for FileIn param #1 etc.\n"
35300 "\n"
35301 msgstr ""
35302
35303 #. type: textblock
35304 #: ../src/guestfs.pod:2453
35305 msgid "The \"sequence of chunks\" is:"
35306 msgstr ""
35307
35308 #. type: verbatim
35309 #: ../src/guestfs.pod:2455
35310 #, no-wrap
35311 msgid ""
35312 " length of chunk (not including length word itself)\n"
35313 " struct guestfs_chunk (encoded as XDR)\n"
35314 " length of chunk\n"
35315 " struct guestfs_chunk (encoded as XDR)\n"
35316 "   ...\n"
35317 " length of chunk\n"
35318 " struct guestfs_chunk (with data.data_len == 0)\n"
35319 "\n"
35320 msgstr ""
35321
35322 #. type: textblock
35323 #: ../src/guestfs.pod:2463
35324 msgid ""
35325 "The final chunk has the C<data_len> field set to zero.  Additionally a flag "
35326 "is set in the final chunk to indicate either successful completion or early "
35327 "cancellation."
35328 msgstr ""
35329
35330 #. type: textblock
35331 #: ../src/guestfs.pod:2467
35332 msgid ""
35333 "At time of writing there are no functions that have more than one FileIn "
35334 "parameter.  However this is (theoretically) supported, by sending the "
35335 "sequence of chunks for each FileIn parameter one after another (from left to "
35336 "right)."
35337 msgstr ""
35338
35339 #. type: textblock
35340 #: ../src/guestfs.pod:2472
35341 msgid ""
35342 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
35343 "transfer.  The library does this by sending a chunk with a special flag set "
35344 "to indicate cancellation.  When the daemon sees this, it cancels the whole "
35345 "RPC, does I<not> send any reply, and goes back to reading the next request."
35346 msgstr ""
35347
35348 #. type: textblock
35349 #: ../src/guestfs.pod:2478
35350 msgid ""
35351 "The daemon may also cancel.  It does this by writing a special word "
35352 "C<GUESTFS_CANCEL_FLAG> to the socket.  The library listens for this during "
35353 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
35354 "cancel chunk).  The special word is chosen so that even if cancellation "
35355 "happens right at the end of the transfer (after the library has finished "
35356 "writing and has started listening for the reply), the \"spurious\" cancel "
35357 "flag will not be confused with the reply message."
35358 msgstr ""
35359
35360 #. type: textblock
35361 #: ../src/guestfs.pod:2487
35362 msgid ""
35363 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
35364 "limit), and also files where the size is not known in advance (eg. from "
35365 "pipes or sockets).  However the chunks are rather small "
35366 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
35367 "to keep much in memory."
35368 msgstr ""
35369
35370 #. type: =head3
35371 #: ../src/guestfs.pod:2493
35372 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
35373 msgstr ""
35374
35375 #. type: textblock
35376 #: ../src/guestfs.pod:2495
35377 msgid ""
35378 "The protocol for FileOut parameters is exactly the same as for FileIn "
35379 "parameters, but with the roles of daemon and library reversed."
35380 msgstr ""
35381
35382 #. type: verbatim
35383 #: ../src/guestfs.pod:2498
35384 #, no-wrap
35385 msgid ""
35386 " total length (header + ret,\n"
35387 "      but not including the length word itself,\n"
35388 "      and not including the chunks)\n"
35389 " struct guestfs_message_header (encoded as XDR)\n"
35390 " struct guestfs_<foo>_ret (encoded as XDR)\n"
35391 " sequence of chunks for FileOut param #0\n"
35392 " sequence of chunks for FileOut param #1 etc.\n"
35393 "\n"
35394 msgstr ""
35395
35396 #. type: =head3
35397 #: ../src/guestfs.pod:2506
35398 msgid "INITIAL MESSAGE"
35399 msgstr ""
35400
35401 #. type: textblock
35402 #: ../src/guestfs.pod:2508
35403 msgid ""
35404 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
35405 "which indicates that the guest and daemon is alive.  This is what "
35406 "L</guestfs_launch> waits for."
35407 msgstr ""
35408
35409 #. type: =head3
35410 #: ../src/guestfs.pod:2512
35411 msgid "PROGRESS NOTIFICATION MESSAGES"
35412 msgstr ""
35413
35414 #. type: textblock
35415 #: ../src/guestfs.pod:2514
35416 msgid ""
35417 "The daemon may send progress notification messages at any time.  These are "
35418 "distinguished by the normal length word being replaced by "
35419 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
35420 msgstr ""
35421
35422 #. type: textblock
35423 #: ../src/guestfs.pod:2518
35424 msgid ""
35425 "The library turns them into progress callbacks (see "
35426 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
35427 "them if not."
35428 msgstr ""
35429
35430 #. type: textblock
35431 #: ../src/guestfs.pod:2522
35432 msgid ""
35433 "The daemon self-limits the frequency of progress messages it sends (see "
35434 "C<daemon/proto.c:notify_progress>).  Not all calls generate progress "
35435 "messages."
35436 msgstr ""
35437
35438 #. type: =head1
35439 #: ../src/guestfs.pod:2526
35440 msgid "LIBGUESTFS VERSION NUMBERS"
35441 msgstr ""
35442
35443 #. type: textblock
35444 #: ../src/guestfs.pod:2528
35445 msgid ""
35446 "Since April 2010, libguestfs has started to make separate development and "
35447 "stable releases, along with corresponding branches in our git repository.  "
35448 "These separate releases can be identified by version number:"
35449 msgstr ""
35450
35451 #. type: verbatim
35452 #: ../src/guestfs.pod:2533
35453 #, no-wrap
35454 msgid ""
35455 "                 even numbers for stable: 1.2.x, 1.4.x, ...\n"
35456 "       .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
35457 "       |\n"
35458 "       v\n"
35459 " 1  .  3  .  5\n"
35460 " ^           ^\n"
35461 " |           |\n"
35462 " |           `-------- sub-version\n"
35463 " |\n"
35464 " `------ always '1' because we don't change the ABI\n"
35465 "\n"
35466 msgstr ""
35467
35468 #. type: textblock
35469 #: ../src/guestfs.pod:2544
35470 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
35471 msgstr ""
35472
35473 #. type: textblock
35474 #: ../src/guestfs.pod:2546
35475 msgid ""
35476 "As time passes we cherry pick fixes from the development branch and backport "
35477 "those into the stable branch, the effect being that the stable branch should "
35478 "get more stable and less buggy over time.  So the stable releases are ideal "
35479 "for people who don't need new features but would just like the software to "
35480 "work."
35481 msgstr ""
35482
35483 #. type: textblock
35484 #: ../src/guestfs.pod:2552
35485 msgid "Our criteria for backporting changes are:"
35486 msgstr ""
35487
35488 #. type: textblock
35489 #: ../src/guestfs.pod:2558
35490 msgid ""
35491 "Documentation changes which don't affect any code are backported unless the "
35492 "documentation refers to a future feature which is not in stable."
35493 msgstr ""
35494
35495 #. type: textblock
35496 #: ../src/guestfs.pod:2564
35497 msgid ""
35498 "Bug fixes which are not controversial, fix obvious problems, and have been "
35499 "well tested are backported."
35500 msgstr ""
35501
35502 #. type: textblock
35503 #: ../src/guestfs.pod:2569
35504 msgid ""
35505 "Simple rearrangements of code which shouldn't affect how it works get "
35506 "backported.  This is so that the code in the two branches doesn't get too "
35507 "far out of step, allowing us to backport future fixes more easily."
35508 msgstr ""
35509
35510 #. type: textblock
35511 #: ../src/guestfs.pod:2575
35512 msgid ""
35513 "We I<don't> backport new features, new APIs, new tools etc, except in one "
35514 "exceptional case: the new feature is required in order to implement an "
35515 "important bug fix."
35516 msgstr ""
35517
35518 #. type: textblock
35519 #: ../src/guestfs.pod:2581
35520 msgid ""
35521 "A new stable branch starts when we think the new features in development are "
35522 "substantial and compelling enough over the current stable branch to warrant "
35523 "it.  When that happens we create new stable and development versions 1.N.0 "
35524 "and 1.(N+1).0 [N is even].  The new dot-oh release won't necessarily be so "
35525 "stable at this point, but by backporting fixes from development, that branch "
35526 "will stabilize over time."
35527 msgstr ""
35528
35529 #. type: =head1
35530 #: ../src/guestfs.pod:2589
35531 msgid "EXTENDING LIBGUESTFS"
35532 msgstr ""
35533
35534 #. type: =head2
35535 #: ../src/guestfs.pod:2591
35536 msgid "ADDING A NEW API ACTION"
35537 msgstr ""
35538
35539 #. type: textblock
35540 #: ../src/guestfs.pod:2593
35541 msgid ""
35542 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
35543 "documentation) are generated, and this makes it easy to extend the "
35544 "libguestfs API."
35545 msgstr ""
35546
35547 #. type: textblock
35548 #: ../src/guestfs.pod:2597
35549 msgid "To add a new API action there are two changes:"
35550 msgstr ""
35551
35552 #. type: textblock
35553 #: ../src/guestfs.pod:2603
35554 msgid ""
35555 "You need to add a description of the call (name, parameters, return type, "
35556 "tests, documentation) to C<generator/generator_actions.ml>."
35557 msgstr ""
35558
35559 #. type: textblock
35560 #: ../src/guestfs.pod:2606
35561 msgid ""
35562 "There are two sorts of API action, depending on whether the call goes "
35563 "through to the daemon in the appliance, or is serviced entirely by the "
35564 "library (see L</ARCHITECTURE> above).  L</guestfs_sync> is an example of the "
35565 "former, since the sync is done in the appliance.  L</guestfs_set_trace> is "
35566 "an example of the latter, since a trace flag is maintained in the handle and "
35567 "all tracing is done on the library side."
35568 msgstr ""
35569
35570 #. type: textblock
35571 #: ../src/guestfs.pod:2614
35572 msgid ""
35573 "Most new actions are of the first type, and get added to the "
35574 "C<daemon_functions> list.  Each function has a unique procedure number used "
35575 "in the RPC protocol which is assigned to that action when we publish "
35576 "libguestfs and cannot be reused.  Take the latest procedure number and "
35577 "increment it."
35578 msgstr ""
35579
35580 #. type: textblock
35581 #: ../src/guestfs.pod:2620
35582 msgid ""
35583 "For library-only actions of the second type, add to the "
35584 "C<non_daemon_functions> list.  Since these functions are serviced by the "
35585 "library and do not travel over the RPC mechanism to the daemon, these "
35586 "functions do not need a procedure number, and so the procedure number is set "
35587 "to C<-1>."
35588 msgstr ""
35589
35590 #. type: textblock
35591 #: ../src/guestfs.pod:2628
35592 msgid "Implement the action (in C):"
35593 msgstr ""
35594
35595 #. type: textblock
35596 #: ../src/guestfs.pod:2630
35597 msgid ""
35598 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
35599 "C<daemon/> directory."
35600 msgstr ""
35601
35602 #. type: textblock
35603 #: ../src/guestfs.pod:2633
35604 msgid ""
35605 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
35606 "(note: double underscore) in the C<src/> directory."
35607 msgstr ""
35608
35609 #. type: textblock
35610 #: ../src/guestfs.pod:2636
35611 msgid "In either case, use another function as an example of what to do."
35612 msgstr ""
35613
35614 #. type: textblock
35615 #: ../src/guestfs.pod:2640
35616 msgid "After making these changes, use C<make> to compile."
35617 msgstr ""
35618
35619 #. type: textblock
35620 #: ../src/guestfs.pod:2642
35621 msgid ""
35622 "Note that you don't need to implement the RPC, language bindings, manual "
35623 "pages or anything else.  It's all automatically generated from the OCaml "
35624 "description."
35625 msgstr ""
35626
35627 #. type: =head2
35628 #: ../src/guestfs.pod:2646
35629 msgid "ADDING TESTS FOR AN API ACTION"
35630 msgstr ""
35631
35632 #. type: textblock
35633 #: ../src/guestfs.pod:2648
35634 msgid ""
35635 "You can supply zero or as many tests as you want per API call.  The tests "
35636 "can either be added as part of the API description "
35637 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
35638 "drop a script into C<regressions/>.  Note that adding a script to "
35639 "C<regressions/> is slower, so if possible use the first method."
35640 msgstr ""
35641
35642 #. type: textblock
35643 #: ../src/guestfs.pod:2654
35644 msgid ""
35645 "The following describes the test environment used when you add an API test "
35646 "in C<generator_actions.ml>."
35647 msgstr ""
35648
35649 #. type: textblock
35650 #: ../src/guestfs.pod:2657
35651 msgid "The test environment has 4 block devices:"
35652 msgstr ""
35653
35654 #. type: =item
35655 #: ../src/guestfs.pod:2661
35656 msgid "C</dev/sda> 500MB"
35657 msgstr ""
35658
35659 #. type: textblock
35660 #: ../src/guestfs.pod:2663
35661 msgid "General block device for testing."
35662 msgstr ""
35663
35664 #. type: =item
35665 #: ../src/guestfs.pod:2665
35666 msgid "C</dev/sdb> 50MB"
35667 msgstr ""
35668
35669 #. type: textblock
35670 #: ../src/guestfs.pod:2667
35671 msgid ""
35672 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
35673 "operations."
35674 msgstr ""
35675
35676 #. type: =item
35677 #: ../src/guestfs.pod:2670
35678 msgid "C</dev/sdc> 10MB"
35679 msgstr ""
35680
35681 #. type: textblock
35682 #: ../src/guestfs.pod:2672
35683 msgid "Used in a few tests where two block devices are needed."
35684 msgstr ""
35685
35686 #. type: =item
35687 #: ../src/guestfs.pod:2674
35688 msgid "C</dev/sdd>"
35689 msgstr ""
35690
35691 #. type: textblock
35692 #: ../src/guestfs.pod:2676
35693 msgid "ISO with fixed content (see C<images/test.iso>)."
35694 msgstr ""
35695
35696 #. type: textblock
35697 #: ../src/guestfs.pod:2680
35698 msgid ""
35699 "To be able to run the tests in a reasonable amount of time, the libguestfs "
35700 "appliance and block devices are reused between tests.  So don't try testing "
35701 "L</guestfs_kill_subprocess> :-x"
35702 msgstr ""
35703
35704 #. type: textblock
35705 #: ../src/guestfs.pod:2684
35706 msgid ""
35707 "Each test starts with an initial scenario, selected using one of the "
35708 "C<Init*> expressions, described in C<generator/generator_types.ml>.  These "
35709 "initialize the disks mentioned above in a particular way as documented in "
35710 "C<generator_types.ml>.  You should not assume anything about the previous "
35711 "contents of other disks that are not initialized."
35712 msgstr ""
35713
35714 #. type: textblock
35715 #: ../src/guestfs.pod:2690
35716 msgid ""
35717 "You can add a prerequisite clause to any individual test.  This is a "
35718 "run-time check, which, if it fails, causes the test to be skipped.  Useful "
35719 "if testing a command which might not work on all variations of libguestfs "
35720 "builds.  A test that has prerequisite of C<Always> means to run "
35721 "unconditionally."
35722 msgstr ""
35723
35724 #. type: textblock
35725 #: ../src/guestfs.pod:2696
35726 msgid ""
35727 "In addition, packagers can skip individual tests by setting environment "
35728 "variables before running C<make check>."
35729 msgstr ""
35730
35731 #. type: verbatim
35732 #: ../src/guestfs.pod:2699
35733 #, no-wrap
35734 msgid ""
35735 " SKIP_TEST_<CMD>_<NUM>=1\n"
35736 "\n"
35737 msgstr ""
35738
35739 #. type: textblock
35740 #: ../src/guestfs.pod:2701
35741 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
35742 msgstr ""
35743
35744 #. type: textblock
35745 #: ../src/guestfs.pod:2703
35746 msgid "or:"
35747 msgstr ""
35748
35749 #. type: verbatim
35750 #: ../src/guestfs.pod:2705
35751 #, no-wrap
35752 msgid ""
35753 " SKIP_TEST_<CMD>=1\n"
35754 "\n"
35755 msgstr ""
35756
35757 #. type: textblock
35758 #: ../src/guestfs.pod:2707
35759 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
35760 msgstr ""
35761
35762 #. type: textblock
35763 #: ../src/guestfs.pod:2709
35764 msgid "Packagers can run only certain tests by setting for example:"
35765 msgstr ""
35766
35767 #. type: verbatim
35768 #: ../src/guestfs.pod:2711
35769 #, no-wrap
35770 msgid ""
35771 " TEST_ONLY=\"vfs_type zerofree\"\n"
35772 "\n"
35773 msgstr ""
35774
35775 #. type: textblock
35776 #: ../src/guestfs.pod:2713
35777 msgid ""
35778 "See C<capitests/tests.c> for more details of how these environment variables "
35779 "work."
35780 msgstr ""
35781
35782 #. type: =head2
35783 #: ../src/guestfs.pod:2716
35784 msgid "DEBUGGING NEW API ACTIONS"
35785 msgstr ""
35786
35787 #. type: textblock
35788 #: ../src/guestfs.pod:2718
35789 msgid "Test new actions work before submitting them."
35790 msgstr ""
35791
35792 #. type: textblock
35793 #: ../src/guestfs.pod:2720
35794 msgid "You can use guestfish to try out new commands."
35795 msgstr ""
35796
35797 #. type: textblock
35798 #: ../src/guestfs.pod:2722
35799 msgid ""
35800 "Debugging the daemon is a problem because it runs inside a minimal "
35801 "environment.  However you can fprintf messages in the daemon to stderr, and "
35802 "they will show up if you use C<guestfish -v>."
35803 msgstr ""
35804
35805 #. type: =head2
35806 #: ../src/guestfs.pod:2726
35807 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
35808 msgstr ""
35809
35810 #. type: textblock
35811 #: ../src/guestfs.pod:2728
35812 msgid ""
35813 "Our C source code generally adheres to some basic code-formatting "
35814 "conventions.  The existing code base is not totally consistent on this "
35815 "front, but we do prefer that contributed code be formatted similarly.  In "
35816 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
35817 "indentation level, and other than that, follow the K&R style."
35818 msgstr ""
35819
35820 #. type: textblock
35821 #: ../src/guestfs.pod:2734
35822 msgid ""
35823 "If you use Emacs, add the following to one of one of your start-up files "
35824 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
35825 msgstr ""
35826
35827 #. type: verbatim
35828 #: ../src/guestfs.pod:2737
35829 #, no-wrap
35830 msgid ""
35831 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
35832 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
35833 " (add-hook 'find-file-hook\n"
35834 "     '(lambda () (if (and buffer-file-name\n"
35835 "                          (string-match \"/libguestfs\\\\>\"\n"
35836 "                              (buffer-file-name))\n"
35837 "                          (not (string-equal mode-name \"Change Log\"))\n"
35838 "                          (not (string-equal mode-name \"Makefile\")))\n"
35839 "                     (setq indent-tabs-mode nil))))\n"
35840 " \n"
35841 msgstr ""
35842
35843 #. type: verbatim
35844 #: ../src/guestfs.pod:2747
35845 #, no-wrap
35846 msgid ""
35847 " ;;; When editing C sources in libguestfs, use this style.\n"
35848 " (defun libguestfs-c-mode ()\n"
35849 "   \"C mode with adjusted defaults for use with libguestfs.\"\n"
35850 "   (interactive)\n"
35851 "   (c-set-style \"K&R\")\n"
35852 "   (setq c-indent-level 2)\n"
35853 "   (setq c-basic-offset 2))\n"
35854 " (add-hook 'c-mode-hook\n"
35855 "           '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
35856 "                               (buffer-file-name))\n"
35857 "                           (libguestfs-c-mode))))\n"
35858 "\n"
35859 msgstr ""
35860
35861 #. type: textblock
35862 #: ../src/guestfs.pod:2759
35863 msgid "Enable warnings when compiling (and fix any problems this finds):"
35864 msgstr ""
35865
35866 #. type: verbatim
35867 #: ../src/guestfs.pod:2762
35868 #, no-wrap
35869 msgid ""
35870 " ./configure --enable-gcc-warnings\n"
35871 "\n"
35872 msgstr ""
35873
35874 #. type: textblock
35875 #: ../src/guestfs.pod:2764
35876 msgid "Useful targets are:"
35877 msgstr ""
35878
35879 #. type: verbatim
35880 #: ../src/guestfs.pod:2766
35881 #, no-wrap
35882 msgid ""
35883 " make syntax-check  # checks the syntax of the C code\n"
35884 " make check         # runs the test suite\n"
35885 "\n"
35886 msgstr ""
35887
35888 #. type: =head2
35889 #: ../src/guestfs.pod:2769
35890 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
35891 msgstr ""
35892
35893 #. type: textblock
35894 #: ../src/guestfs.pod:2771
35895 msgid ""
35896 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
35897 "which are used to do shell quoting."
35898 msgstr ""
35899
35900 #. type: =item
35901 #: ../src/guestfs.pod:2776
35902 msgid "%Q"
35903 msgstr ""
35904
35905 #. type: textblock
35906 #: ../src/guestfs.pod:2778
35907 msgid ""
35908 "Simple shell quoted string.  Any spaces or other shell characters are "
35909 "escaped for you."
35910 msgstr ""
35911
35912 #. type: =item
35913 #: ../src/guestfs.pod:2781
35914 msgid "%R"
35915 msgstr ""
35916
35917 #. type: textblock
35918 #: ../src/guestfs.pod:2783
35919 msgid ""
35920 "Same as C<%Q> except the string is treated as a path which is prefixed by "
35921 "the sysroot."
35922 msgstr ""
35923
35924 #. type: verbatim
35925 #: ../src/guestfs.pod:2790
35926 #, no-wrap
35927 msgid ""
35928 " asprintf (&cmd, \"cat %R\", path);\n"
35929 "\n"
35930 msgstr ""
35931
35932 #. type: textblock
35933 #: ../src/guestfs.pod:2792
35934 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
35935 msgstr ""
35936
35937 #. type: textblock
35938 #: ../src/guestfs.pod:2794
35939 msgid ""
35940 "I<Note:> Do I<not> use these when you are passing parameters to the "
35941 "C<command{,r,v,rv}()> functions.  These parameters do NOT need to be quoted "
35942 "because they are not passed via the shell (instead, straight to exec).  You "
35943 "probably want to use the C<sysroot_path()> function however."
35944 msgstr ""
35945
35946 #. type: =head2
35947 #: ../src/guestfs.pod:2800
35948 msgid "SUBMITTING YOUR NEW API ACTIONS"
35949 msgstr ""
35950
35951 #. type: textblock
35952 #: ../src/guestfs.pod:2802
35953 msgid ""
35954 "Submit patches to the mailing list: "
35955 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
35956 "L<rjones@redhat.com>."
35957 msgstr ""
35958
35959 #. type: =head2
35960 #: ../src/guestfs.pod:2806
35961 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
35962 msgstr ""
35963
35964 #. type: textblock
35965 #: ../src/guestfs.pod:2808
35966 msgid "We support i18n (gettext anyhow) in the library."
35967 msgstr ""
35968
35969 #. type: textblock
35970 #: ../src/guestfs.pod:2810
35971 msgid ""
35972 "However many messages come from the daemon, and we don't translate those at "
35973 "the moment.  One reason is that the appliance generally has all locale files "
35974 "removed from it, because they take up a lot of space.  So we'd have to readd "
35975 "some of those, as well as copying our PO files into the appliance."
35976 msgstr ""
35977
35978 #. type: textblock
35979 #: ../src/guestfs.pod:2816
35980 msgid ""
35981 "Debugging messages are never translated, since they are intended for the "
35982 "programmers."
35983 msgstr ""
35984
35985 #. type: =head2
35986 #: ../src/guestfs.pod:2819
35987 msgid "SOURCE CODE SUBDIRECTORIES"
35988 msgstr ""
35989
35990 #. type: textblock
35991 #: ../src/guestfs.pod:2825
35992 msgid "The libguestfs appliance, build scripts and so on."
35993 msgstr ""
35994
35995 #. type: =item
35996 #: ../src/guestfs.pod:2827
35997 msgid "C<capitests>"
35998 msgstr ""
35999
36000 #. type: textblock
36001 #: ../src/guestfs.pod:2829
36002 msgid "Automated tests of the C API."
36003 msgstr ""
36004
36005 #. type: =item
36006 #: ../src/guestfs.pod:2831
36007 msgid "C<cat>"
36008 msgstr ""
36009
36010 #. type: textblock
36011 #: ../src/guestfs.pod:2833
36012 msgid ""
36013 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
36014 "documentation."
36015 msgstr ""
36016
36017 #. type: =item
36018 #: ../src/guestfs.pod:2836
36019 msgid "C<caution>"
36020 msgstr ""
36021
36022 #. type: textblock
36023 #: ../src/guestfs.pod:2838
36024 msgid ""
36025 "Safety and liveness tests of components that libguestfs depends upon (not of "
36026 "libguestfs itself).  Mainly this is for qemu and the kernel."
36027 msgstr ""
36028
36029 #. type: =item
36030 #: ../src/guestfs.pod:2841
36031 msgid "C<contrib>"
36032 msgstr ""
36033
36034 #. type: textblock
36035 #: ../src/guestfs.pod:2843
36036 msgid "Outside contributions, experimental parts."
36037 msgstr ""
36038
36039 #. type: =item
36040 #: ../src/guestfs.pod:2845
36041 msgid "C<daemon>"
36042 msgstr ""
36043
36044 #. type: textblock
36045 #: ../src/guestfs.pod:2847
36046 msgid ""
36047 "The daemon that runs inside the libguestfs appliance and carries out "
36048 "actions."
36049 msgstr ""
36050
36051 #. type: =item
36052 #: ../src/guestfs.pod:2850
36053 msgid "C<df>"
36054 msgstr ""
36055
36056 #. type: textblock
36057 #: ../src/guestfs.pod:2852
36058 msgid "L<virt-df(1)> command and documentation."
36059 msgstr ""
36060
36061 #. type: =item
36062 #: ../src/guestfs.pod:2854
36063 msgid "C<edit>"
36064 msgstr ""
36065
36066 #. type: textblock
36067 #: ../src/guestfs.pod:2856
36068 msgid "L<virt-edit(1)> command and documentation."
36069 msgstr ""
36070
36071 #. type: =item
36072 #: ../src/guestfs.pod:2858
36073 msgid "C<examples>"
36074 msgstr ""
36075
36076 #. type: textblock
36077 #: ../src/guestfs.pod:2860
36078 msgid "C API example code."
36079 msgstr ""
36080
36081 #. type: =item
36082 #: ../src/guestfs.pod:2862
36083 msgid "C<fish>"
36084 msgstr ""
36085
36086 #. type: textblock
36087 #: ../src/guestfs.pod:2864
36088 msgid ""
36089 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
36090 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
36091 "L<virt-tar-out(1)>."
36092 msgstr ""
36093
36094 #. type: =item
36095 #: ../src/guestfs.pod:2868
36096 msgid "C<fuse>"
36097 msgstr ""
36098
36099 #. type: textblock
36100 #: ../src/guestfs.pod:2870
36101 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
36102 msgstr ""
36103
36104 #. type: =item
36105 #: ../src/guestfs.pod:2872
36106 msgid "C<generator>"
36107 msgstr ""
36108
36109 #. type: textblock
36110 #: ../src/guestfs.pod:2874
36111 msgid ""
36112 "The crucially important generator, used to automatically generate large "
36113 "amounts of boilerplate C code for things like RPC and bindings."
36114 msgstr ""
36115
36116 #. type: =item
36117 #: ../src/guestfs.pod:2877
36118 msgid "C<images>"
36119 msgstr ""
36120
36121 #. type: textblock
36122 #: ../src/guestfs.pod:2879
36123 msgid "Files used by the test suite."
36124 msgstr ""
36125
36126 #. type: textblock
36127 #: ../src/guestfs.pod:2881
36128 msgid "Some \"phony\" guest images which we test against."
36129 msgstr ""
36130
36131 #. type: =item
36132 #: ../src/guestfs.pod:2883
36133 msgid "C<inspector>"
36134 msgstr ""
36135
36136 #. type: textblock
36137 #: ../src/guestfs.pod:2885
36138 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
36139 msgstr ""
36140
36141 #. type: =item
36142 #: ../src/guestfs.pod:2887
36143 msgid "C<logo>"
36144 msgstr ""
36145
36146 #. type: textblock
36147 #: ../src/guestfs.pod:2889
36148 msgid "Logo used on the website.  The fish is called Arthur by the way."
36149 msgstr ""
36150
36151 #. type: =item
36152 #: ../src/guestfs.pod:2891
36153 msgid "C<m4>"
36154 msgstr ""
36155
36156 #. type: textblock
36157 #: ../src/guestfs.pod:2893
36158 msgid "M4 macros used by autoconf."
36159 msgstr ""
36160
36161 #. type: =item
36162 #: ../src/guestfs.pod:2895
36163 msgid "C<po>"
36164 msgstr ""
36165
36166 #. type: textblock
36167 #: ../src/guestfs.pod:2897
36168 msgid "Translations of simple gettext strings."
36169 msgstr ""
36170
36171 #. type: =item
36172 #: ../src/guestfs.pod:2899
36173 msgid "C<po-docs>"
36174 msgstr ""
36175
36176 #. type: textblock
36177 #: ../src/guestfs.pod:2901
36178 msgid ""
36179 "The build infrastructure and PO files for translations of manpages and POD "
36180 "files.  Eventually this will be combined with the C<po> directory, but that "
36181 "is rather complicated."
36182 msgstr ""
36183
36184 #. type: =item
36185 #: ../src/guestfs.pod:2905
36186 msgid "C<regressions>"
36187 msgstr ""
36188
36189 #. type: textblock
36190 #: ../src/guestfs.pod:2907
36191 msgid "Regression tests."
36192 msgstr ""
36193
36194 #. type: =item
36195 #: ../src/guestfs.pod:2909
36196 msgid "C<rescue>"
36197 msgstr ""
36198
36199 #. type: textblock
36200 #: ../src/guestfs.pod:2911
36201 msgid "L<virt-rescue(1)> command and documentation."
36202 msgstr ""
36203
36204 #. type: =item
36205 #: ../src/guestfs.pod:2913
36206 msgid "C<src>"
36207 msgstr ""
36208
36209 #. type: textblock
36210 #: ../src/guestfs.pod:2915
36211 msgid "Source code to the C library."
36212 msgstr ""
36213
36214 #. type: =item
36215 #: ../src/guestfs.pod:2917
36216 msgid "C<tools>"
36217 msgstr ""
36218
36219 #. type: textblock
36220 #: ../src/guestfs.pod:2919
36221 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
36222 msgstr ""
36223
36224 #. type: =item
36225 #: ../src/guestfs.pod:2921
36226 msgid "C<test-tool>"
36227 msgstr ""
36228
36229 #. type: textblock
36230 #: ../src/guestfs.pod:2923
36231 msgid ""
36232 "Test tool for end users to test if their qemu/kernel combination will work "
36233 "with libguestfs."
36234 msgstr ""
36235
36236 #. type: =item
36237 #: ../src/guestfs.pod:2926
36238 msgid "C<csharp>"
36239 msgstr ""
36240
36241 #. type: =item
36242 #: ../src/guestfs.pod:2928
36243 msgid "C<erlang>"
36244 msgstr ""
36245
36246 #. type: =item
36247 #: ../src/guestfs.pod:2930
36248 msgid "C<haskell>"
36249 msgstr ""
36250
36251 #. type: =item
36252 #: ../src/guestfs.pod:2932
36253 msgid "C<java>"
36254 msgstr ""
36255
36256 #. type: =item
36257 #: ../src/guestfs.pod:2934
36258 msgid "C<ocaml>"
36259 msgstr ""
36260
36261 #. type: =item
36262 #: ../src/guestfs.pod:2936
36263 msgid "C<php>"
36264 msgstr ""
36265
36266 #. type: =item
36267 #: ../src/guestfs.pod:2938
36268 msgid "C<perl>"
36269 msgstr ""
36270
36271 #. type: =item
36272 #: ../src/guestfs.pod:2940
36273 msgid "C<python>"
36274 msgstr ""
36275
36276 #. type: =item
36277 #: ../src/guestfs.pod:2942
36278 msgid "C<ruby>"
36279 msgstr ""
36280
36281 #. type: textblock
36282 #: ../src/guestfs.pod:2944
36283 msgid "Language bindings."
36284 msgstr ""
36285
36286 #. type: =head2
36287 #: ../src/guestfs.pod:2948
36288 msgid "MAKING A STABLE RELEASE"
36289 msgstr ""
36290
36291 #. type: textblock
36292 #: ../src/guestfs.pod:2950
36293 msgid ""
36294 "When we make a stable release, there are several steps documented here.  See "
36295 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
36296 "branch policy."
36297 msgstr ""
36298
36299 #. type: textblock
36300 #: ../src/guestfs.pod:2958
36301 msgid "Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
36302 msgstr ""
36303
36304 #. type: textblock
36305 #: ../src/guestfs.pod:2963
36306 msgid "Finalize RELEASE-NOTES."
36307 msgstr ""
36308
36309 #. type: textblock
36310 #: ../src/guestfs.pod:2967
36311 msgid "Update ROADMAP."
36312 msgstr ""
36313
36314 #. type: textblock
36315 #: ../src/guestfs.pod:2971
36316 msgid "Run C<src/api-support/update-from-tarballs.sh>."
36317 msgstr ""
36318
36319 #. type: textblock
36320 #: ../src/guestfs.pod:2975
36321 msgid "Push and pull from Transifex."
36322 msgstr ""
36323
36324 #. type: textblock
36325 #: ../src/guestfs.pod:2977
36326 msgid "Run:"
36327 msgstr ""
36328
36329 #. type: verbatim
36330 #: ../src/guestfs.pod:2979
36331 #, no-wrap
36332 msgid ""
36333 " tx push -s\n"
36334 "\n"
36335 msgstr ""
36336
36337 #. type: textblock
36338 #: ../src/guestfs.pod:2981
36339 msgid "to push the latest POT files to Transifex.  Then run:"
36340 msgstr ""
36341
36342 #. type: verbatim
36343 #: ../src/guestfs.pod:2983
36344 #, no-wrap
36345 msgid ""
36346 " ./tx-pull.sh\n"
36347 "\n"
36348 msgstr ""
36349
36350 #. type: textblock
36351 #: ../src/guestfs.pod:2985
36352 msgid "which is a wrapper to pull the latest translated C<*.po> files."
36353 msgstr ""
36354
36355 #. type: textblock
36356 #: ../src/guestfs.pod:2989
36357 msgid ""
36358 "Create new stable and development directories under "
36359 "L<http://libguestfs.org/download>."
36360 msgstr ""
36361
36362 #. type: textblock
36363 #: ../src/guestfs.pod:2994
36364 msgid "Create the branch in git:"
36365 msgstr ""
36366
36367 #. type: verbatim
36368 #: ../src/guestfs.pod:2996
36369 #, no-wrap
36370 msgid ""
36371 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
36372 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
36373 " git branch stable-1.XX\n"
36374 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
36375 "\n"
36376 msgstr ""
36377
36378 #. type: =head1
36379 #: ../src/guestfs.pod:3003
36380 msgid "LIMITS"
36381 msgstr ""
36382
36383 #. type: =head2
36384 #: ../src/guestfs.pod:3005
36385 msgid "PROTOCOL LIMITS"
36386 msgstr ""
36387
36388 #. type: textblock
36389 #: ../src/guestfs.pod:3007
36390 msgid ""
36391 "Internally libguestfs uses a message-based protocol to pass API calls and "
36392 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
36393 "plenty more detail about this).  The maximum message size used by the "
36394 "protocol is slightly less than 4 MB.  For some API calls you may need to be "
36395 "aware of this limit.  The API calls which may be affected are individually "
36396 "documented, with a link back to this section of the documentation."
36397 msgstr ""
36398
36399 #. type: textblock
36400 #: ../src/guestfs.pod:3015
36401 msgid ""
36402 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
36403 "a simple string.  Because this string is at some point internally encoded as "
36404 "a message, the maximum size that it can return is slightly under 4 MB.  If "
36405 "the requested file is larger than this then you will get an error."
36406 msgstr ""
36407
36408 #. type: textblock
36409 #: ../src/guestfs.pod:3021
36410 msgid ""
36411 "In order to transfer large files into and out of the guest filesystem, you "
36412 "need to use particular calls that support this.  The sections L</UPLOADING> "
36413 "and L</DOWNLOADING> document how to do this."
36414 msgstr ""
36415
36416 #. type: textblock
36417 #: ../src/guestfs.pod:3025
36418 msgid ""
36419 "You might also consider mounting the disk image using our FUSE filesystem "
36420 "support (L<guestmount(1)>)."
36421 msgstr ""
36422
36423 #. type: =head2
36424 #: ../src/guestfs.pod:3028
36425 msgid "MAXIMUM NUMBER OF DISKS"
36426 msgstr ""
36427
36428 #. type: textblock
36429 #: ../src/guestfs.pod:3030
36430 msgid "When using virtio disks (the default) the current limit is B<25> disks."
36431 msgstr ""
36432
36433 #. type: textblock
36434 #: ../src/guestfs.pod:3033
36435 msgid ""
36436 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
36437 "slots.  However febootstrap only understands disks with names C</dev/vda> "
36438 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
36439 "purposes."
36440 msgstr ""
36441
36442 #. type: textblock
36443 #: ../src/guestfs.pod:3038
36444 msgid ""
36445 "We are working to substantially raise this limit in future versions but it "
36446 "requires complex changes to qemu."
36447 msgstr ""
36448
36449 #. type: textblock
36450 #: ../src/guestfs.pod:3041
36451 msgid ""
36452 "In future versions of libguestfs it should also be possible to \"hot plug\" "
36453 "disks (add and remove disks after calling L</guestfs_launch>).  This also "
36454 "requires changes to qemu."
36455 msgstr ""
36456
36457 #. type: =head2
36458 #: ../src/guestfs.pod:3045
36459 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
36460 msgstr ""
36461
36462 #. type: textblock
36463 #: ../src/guestfs.pod:3047
36464 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
36465 msgstr ""
36466
36467 #. type: textblock
36468 #: ../src/guestfs.pod:3049
36469 msgid ""
36470 "This is because it reserves 4 bits for the minor device number (thus "
36471 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
36472 msgstr ""
36473
36474 #. type: textblock
36475 #: ../src/guestfs.pod:3052
36476 msgid ""
36477 "If you attach a disk with more than 15 partitions, the extra partitions are "
36478 "ignored by libguestfs."
36479 msgstr ""
36480
36481 #. type: =head2
36482 #: ../src/guestfs.pod:3055
36483 msgid "MAXIMUM SIZE OF A DISK"
36484 msgstr ""
36485
36486 #. type: textblock
36487 #: ../src/guestfs.pod:3057
36488 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
36489 msgstr ""
36490
36491 #. type: textblock
36492 #: ../src/guestfs.pod:3059
36493 msgid ""
36494 "We have tested block devices up to 1 exabyte (2**60 or "
36495 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
36496 "filesystem."
36497 msgstr ""
36498
36499 #. type: textblock
36500 #: ../src/guestfs.pod:3063
36501 msgid ""
36502 "Although libguestfs probably does not impose any limit, the underlying host "
36503 "storage will.  If you store disk images on a host ext4 filesystem, then the "
36504 "maximum size will be limited by the maximum ext4 file size (currently 16 "
36505 "TB).  If you store disk images as host logical volumes then you are limited "
36506 "by the maximum size of an LV."
36507 msgstr ""
36508
36509 #. type: textblock
36510 #: ../src/guestfs.pod:3069
36511 msgid ""
36512 "For the hugest disk image files, we recommend using XFS on the host for "
36513 "storage."
36514 msgstr ""
36515
36516 #. type: =head2
36517 #: ../src/guestfs.pod:3072
36518 msgid "MAXIMUM SIZE OF A PARTITION"
36519 msgstr ""
36520
36521 #. type: textblock
36522 #: ../src/guestfs.pod:3074
36523 msgid ""
36524 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
36525 "numbers.  Assuming a 512 byte sector size, this means that MBR cannot "
36526 "address a partition located beyond 2 TB on the disk."
36527 msgstr ""
36528
36529 #. type: textblock
36530 #: ../src/guestfs.pod:3078
36531 msgid ""
36532 "It is recommended that you use GPT partitions on disks which are larger than "
36533 "this size.  GPT uses 64 bit sector numbers and so can address partitions "
36534 "which are theoretically larger than the largest disk we could support."
36535 msgstr ""
36536
36537 #. type: =head2
36538 #: ../src/guestfs.pod:3083
36539 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
36540 msgstr ""
36541
36542 #. type: textblock
36543 #: ../src/guestfs.pod:3085
36544 msgid ""
36545 "This depends on the filesystem type.  libguestfs itself does not impose any "
36546 "known limit.  Consult Wikipedia or the filesystem documentation to find out "
36547 "what these limits are."
36548 msgstr ""
36549
36550 #. type: =head2
36551 #: ../src/guestfs.pod:3089
36552 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
36553 msgstr ""
36554
36555 #. type: textblock
36556 #: ../src/guestfs.pod:3091
36557 msgid ""
36558 "The API functions L</guestfs_upload>, L</guestfs_download>, "
36559 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
36560 "uploads and downloads."
36561 msgstr ""
36562
36563 #. type: =head2
36564 #: ../src/guestfs.pod:3095
36565 msgid "INSPECTION LIMITS"
36566 msgstr ""
36567
36568 #. type: textblock
36569 #: ../src/guestfs.pod:3097
36570 msgid ""
36571 "The inspection code has several arbitrary limits on things like the size of "
36572 "Windows Registry hive it will read, and the length of product name.  These "
36573 "are intended to stop a malicious guest from consuming arbitrary amounts of "
36574 "memory and disk space on the host, and should not be reached in practice.  "
36575 "See the source code for more information."
36576 msgstr ""
36577
36578 #. type: textblock
36579 #: ../src/guestfs.pod:3123
36580 msgid ""
36581 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages.  This has the same "
36582 "effect as calling C<guestfs_set_verbose (g, 1)>."
36583 msgstr ""
36584
36585 #. type: textblock
36586 #: ../src/guestfs.pod:3135
36587 msgid ""
36588 "Set the path that libguestfs uses to search for a supermin appliance.  See "
36589 "the discussion of paths in section L</PATH> above."
36590 msgstr ""
36591
36592 #. type: textblock
36593 #: ../src/guestfs.pod:3144
36594 msgid "See also L</QEMU WRAPPERS> above."
36595 msgstr ""
36596
36597 #. type: textblock
36598 #: ../src/guestfs.pod:3148
36599 msgid ""
36600 "Set C<LIBGUESTFS_TRACE=1> to enable command traces.  This has the same "
36601 "effect as calling C<guestfs_set_trace (g, 1)>."
36602 msgstr ""
36603
36604 #. type: textblock
36605 #: ../src/guestfs.pod:3166
36606 msgid ""
36607 "L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, "
36608 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
36609 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
36610 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
36611 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
36612 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
36613 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
36614 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, "
36615 "L<febootstrap-supermin-helper(8)>, L<hivex(3)>, L<http://libguestfs.org/>."
36616 msgstr ""
36617
36618 #. type: textblock
36619 #: ../src/guestfs.pod:3197
36620 msgid ""
36621 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
36622 "L<lvm(8)>, L<disktype(1)>."
36623 msgstr ""
36624
36625 #. type: =head1
36626 #: ../src/guestfs.pod:3204 ../tools/virt-make-fs.pl:553 ../tools/virt-win-reg.pl:761
36627 msgid "BUGS"
36628 msgstr ""
36629
36630 #. type: textblock
36631 #: ../src/guestfs.pod:3206
36632 msgid "To get a list of bugs against libguestfs use this link:"
36633 msgstr ""
36634
36635 #. type: textblock
36636 #: ../src/guestfs.pod:3208
36637 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
36638 msgstr ""
36639
36640 #. type: textblock
36641 #: ../src/guestfs.pod:3210
36642 msgid "To report a new bug against libguestfs use this link:"
36643 msgstr ""
36644
36645 #. type: textblock
36646 #: ../src/guestfs.pod:3212
36647 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
36648 msgstr ""
36649
36650 #. type: textblock
36651 #: ../src/guestfs.pod:3214
36652 msgid "When reporting a bug, please check:"
36653 msgstr ""
36654
36655 #. type: textblock
36656 #: ../src/guestfs.pod:3220
36657 msgid "That the bug hasn't been reported already."
36658 msgstr ""
36659
36660 #. type: textblock
36661 #: ../src/guestfs.pod:3224
36662 msgid "That you are testing a recent version."
36663 msgstr ""
36664
36665 #. type: textblock
36666 #: ../src/guestfs.pod:3228
36667 msgid "Describe the bug accurately, and give a way to reproduce it."
36668 msgstr ""
36669
36670 #. type: textblock
36671 #: ../src/guestfs.pod:3232
36672 msgid ""
36673 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
36674 "bug report."
36675 msgstr ""
36676
36677 #. type: textblock
36678 #: ../test-tool/libguestfs-test-tool.pod:5
36679 msgid "libguestfs-test-tool - Diagnostics for libguestfs"
36680 msgstr ""
36681
36682 #. type: verbatim
36683 #: ../test-tool/libguestfs-test-tool.pod:9
36684 #, no-wrap
36685 msgid ""
36686 " libguestfs-test-tool [--options]\n"
36687 "\n"
36688 msgstr ""
36689
36690 #. type: textblock
36691 #: ../test-tool/libguestfs-test-tool.pod:13
36692 msgid ""
36693 "libguestfs-test-tool is a test program shipped with libguestfs to allow you "
36694 "to check basic libguestfs functionality is working.  This is needed because "
36695 "libguestfs occasionally breaks for reasons beyond our control: usually "
36696 "because of changes in the underlying qemu or kernel packages, or the host "
36697 "environment."
36698 msgstr ""
36699
36700 #. type: textblock
36701 #: ../test-tool/libguestfs-test-tool.pod:19
36702 msgid "If you suspect a problem in libguestfs, then just run:"
36703 msgstr ""
36704
36705 #. type: verbatim
36706 #: ../test-tool/libguestfs-test-tool.pod:21
36707 #, no-wrap
36708 msgid ""
36709 " libguestfs-test-tool\n"
36710 "\n"
36711 msgstr ""
36712
36713 #. type: textblock
36714 #: ../test-tool/libguestfs-test-tool.pod:23
36715 msgid "It will print lots of diagnostic messages."
36716 msgstr ""
36717
36718 #. type: textblock
36719 #: ../test-tool/libguestfs-test-tool.pod:25
36720 msgid "If it runs to completion successfully, you will see this near the end:"
36721 msgstr ""
36722
36723 #. type: verbatim
36724 #: ../test-tool/libguestfs-test-tool.pod:27
36725 #, no-wrap
36726 msgid ""
36727 " ===== TEST FINISHED OK =====\n"
36728 "\n"
36729 msgstr ""
36730
36731 #. type: textblock
36732 #: ../test-tool/libguestfs-test-tool.pod:29
36733 msgid "and the test tool will exit with code 0."
36734 msgstr ""
36735
36736 #. type: textblock
36737 #: ../test-tool/libguestfs-test-tool.pod:31
36738 msgid ""
36739 "If it fails (and/or exits with non-zero error code), please paste the "
36740 "I<complete, unedited> output of the test tool into a bug report.  More "
36741 "information about reporting bugs can be found on the "
36742 "L<http://libguestfs.org/> website."
36743 msgstr ""
36744
36745 #. type: textblock
36746 #: ../test-tool/libguestfs-test-tool.pod:42
36747 msgid "Display short usage information and exit."
36748 msgstr ""
36749
36750 #. type: =item
36751 #: ../test-tool/libguestfs-test-tool.pod:44
36752 msgid "B<--qemu qemu_binary>"
36753 msgstr ""
36754
36755 #. type: textblock
36756 #: ../test-tool/libguestfs-test-tool.pod:46
36757 msgid ""
36758 "If you have downloaded another qemu binary, point this option at the full "
36759 "path of the binary to try it."
36760 msgstr ""
36761
36762 #. type: =item
36763 #: ../test-tool/libguestfs-test-tool.pod:49
36764 msgid "B<--qemudir qemu_source_dir>"
36765 msgstr ""
36766
36767 #. type: textblock
36768 #: ../test-tool/libguestfs-test-tool.pod:51
36769 msgid ""
36770 "If you have compiled qemu from source, point this option at the source "
36771 "directory to try it."
36772 msgstr ""
36773
36774 #. type: =item
36775 #: ../test-tool/libguestfs-test-tool.pod:54
36776 msgid "B<-t N>"
36777 msgstr ""
36778
36779 #. type: =item
36780 #: ../test-tool/libguestfs-test-tool.pod:56
36781 msgid "B<--timeout N>"
36782 msgstr ""
36783
36784 #. type: textblock
36785 #: ../test-tool/libguestfs-test-tool.pod:58
36786 msgid ""
36787 "Set the launch timeout to C<N> seconds.  The default is 600 seconds (10 "
36788 "minutes) which does not usually need to be adjusted."
36789 msgstr ""
36790
36791 #. type: =head1
36792 #: ../test-tool/libguestfs-test-tool.pod:63
36793 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
36794 msgstr ""
36795
36796 #. type: textblock
36797 #: ../test-tool/libguestfs-test-tool.pod:65
36798 msgid ""
36799 "If you have compiled another version of qemu from source and would like to "
36800 "try that, then you can use the I<--qemudir> option to point to the qemu "
36801 "source directory."
36802 msgstr ""
36803
36804 #. type: textblock
36805 #: ../test-tool/libguestfs-test-tool.pod:69
36806 msgid ""
36807 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
36808 "option to point to the binary."
36809 msgstr ""
36810
36811 #. type: textblock
36812 #: ../test-tool/libguestfs-test-tool.pod:72
36813 msgid ""
36814 "Note when using these options, you can ignore the business of qemu wrapper "
36815 "scripts (L<guestfs(3)/QEMU WRAPPERS>), since libguestfs-test-tool writes a "
36816 "wrapper script for you if one is needed."
36817 msgstr ""
36818
36819 #. type: =head1
36820 #: ../test-tool/libguestfs-test-tool.pod:76
36821 msgid "TRYING OUT A DIFFERENT KERNEL"
36822 msgstr ""
36823
36824 #. type: textblock
36825 #: ../test-tool/libguestfs-test-tool.pod:78
36826 msgid ""
36827 "If you are using febootstrap E<ge> 3.8 then you can select which kernel "
36828 "libguestfs tries.  You do this by setting the environment variables "
36829 "C<FEBOOTSTRAP_KERNEL> and/or C<FEBOOTSTRAP_MODULES>."
36830 msgstr ""
36831
36832 #. type: textblock
36833 #: ../test-tool/libguestfs-test-tool.pod:82
36834 msgid ""
36835 "Refer to L<febootstrap-supermin-helper(8)/ENVIRONMENT VARIABLES> for further "
36836 "information."
36837 msgstr ""
36838
36839 #. type: =head1
36840 #: ../test-tool/libguestfs-test-tool.pod:85
36841 msgid "SELF-DIAGNOSIS"
36842 msgstr ""
36843
36844 #. type: textblock
36845 #: ../test-tool/libguestfs-test-tool.pod:87
36846 msgid ""
36847 "Refer to L<guestfs(3)/APPLIANCE BOOT PROCESS> to understand the messages "
36848 "produced by libguestfs-test-tool and/or possible errors."
36849 msgstr ""
36850
36851 #. type: textblock
36852 #: ../test-tool/libguestfs-test-tool.pod:92
36853 msgid ""
36854 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
36855 "I<1> if there was an error."
36856 msgstr ""
36857
36858 #. type: textblock
36859 #: ../test-tool/libguestfs-test-tool.pod:97
36860 msgid ""
36861 "For the full list of environment variables which may affect libguestfs, "
36862 "please see the L<guestfs(3)> manual page."
36863 msgstr ""
36864
36865 #. type: textblock
36866 #: ../test-tool/libguestfs-test-tool.pod:102
36867 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
36868 msgstr ""
36869
36870 #. type: textblock
36871 #: ../tools/virt-list-filesystems.pl:32
36872 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
36873 msgstr ""
36874
36875 #. type: verbatim
36876 #: ../tools/virt-list-filesystems.pl:36
36877 #, no-wrap
36878 msgid ""
36879 " virt-list-filesystems [--options] domname\n"
36880 "\n"
36881 msgstr ""
36882
36883 #. type: verbatim
36884 #: ../tools/virt-list-filesystems.pl:38
36885 #, no-wrap
36886 msgid ""
36887 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
36888 "\n"
36889 msgstr ""
36890
36891 #. type: textblock
36892 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
36893 msgid ""
36894 "This tool is obsolete.  Use L<virt-filesystems(1)> as a more flexible "
36895 "replacement."
36896 msgstr ""
36897
36898 #. type: textblock
36899 #: ../tools/virt-list-filesystems.pl:45
36900 msgid ""
36901 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
36902 "are contained in a virtual machine or disk image."
36903 msgstr ""
36904
36905 #. type: textblock
36906 #: ../tools/virt-list-filesystems.pl:49
36907 msgid ""
36908 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
36909 "functionality.  For more complex cases you should look at the "
36910 "L<guestfish(1)> tool."
36911 msgstr ""
36912
36913 #. type: textblock
36914 #: ../tools/virt-list-filesystems.pl:112
36915 msgid ""
36916 "With this option, C<virt-list-filesystems> displays the type of each "
36917 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
36918 msgstr ""
36919
36920 #. type: =item
36921 #: ../tools/virt-list-filesystems.pl:119
36922 msgid "B<-a>"
36923 msgstr ""
36924
36925 #. type: textblock
36926 #: ../tools/virt-list-filesystems.pl:123
36927 msgid ""
36928 "Normally we only show mountable filesystems.  If this option is given then "
36929 "swap devices are shown too."
36930 msgstr ""
36931
36932 #. type: textblock
36933 #: ../tools/virt-list-filesystems.pl:197
36934 msgid ""
36935 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
36936 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
36937 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
36938 msgstr ""
36939
36940 #. type: textblock
36941 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
36942 msgid "Copyright (C) 2009 Red Hat Inc."
36943 msgstr ""
36944
36945 #. type: textblock
36946 #: ../tools/virt-list-partitions.pl:32
36947 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
36948 msgstr ""
36949
36950 #. type: verbatim
36951 #: ../tools/virt-list-partitions.pl:36
36952 #, no-wrap
36953 msgid ""
36954 " virt-list-partitions [--options] domname\n"
36955 "\n"
36956 msgstr ""
36957
36958 #. type: verbatim
36959 #: ../tools/virt-list-partitions.pl:38
36960 #, no-wrap
36961 msgid ""
36962 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
36963 "\n"
36964 msgstr ""
36965
36966 #. type: textblock
36967 #: ../tools/virt-list-partitions.pl:45
36968 msgid ""
36969 "C<virt-list-partitions> is a command line tool to list the partitions that "
36970 "are contained in a virtual machine or disk image.  It is mainly useful as a "
36971 "first step to using L<virt-resize(1)>."
36972 msgstr ""
36973
36974 #. type: textblock
36975 #: ../tools/virt-list-partitions.pl:50
36976 msgid ""
36977 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
36978 "functionality.  For more complex cases you should look at the "
36979 "L<guestfish(1)> tool."
36980 msgstr ""
36981
36982 #. type: textblock
36983 #: ../tools/virt-list-partitions.pl:113
36984 msgid "Show sizes in human-readable form (eg. \"1G\")."
36985 msgstr ""
36986
36987 #. type: textblock
36988 #: ../tools/virt-list-partitions.pl:123
36989 msgid ""
36990 "With this option, C<virt-list-partitions> displays the type and size of each "
36991 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
36992 msgstr ""
36993
36994 #. type: =item
36995 #: ../tools/virt-list-partitions.pl:130
36996 msgid "B<-t>"
36997 msgstr ""
36998
36999 #. type: =item
37000 #: ../tools/virt-list-partitions.pl:132
37001 msgid "B<--total>"
37002 msgstr ""
37003
37004 #. type: textblock
37005 #: ../tools/virt-list-partitions.pl:134
37006 msgid "Display the total size of each block device (as a separate row or rows)."
37007 msgstr ""
37008
37009 #. type: textblock
37010 #: ../tools/virt-list-partitions.pl:267
37011 msgid ""
37012 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
37013 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
37014 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
37015 msgstr ""
37016
37017 #. type: textblock
37018 #: ../tools/virt-list-partitions.pl:283
37019 msgid "Copyright (C) 2009-2010 Red Hat Inc."
37020 msgstr ""
37021
37022 #. type: textblock
37023 #: ../tools/virt-make-fs.pl:37
37024 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
37025 msgstr ""
37026
37027 #. type: verbatim
37028 #: ../tools/virt-make-fs.pl:41
37029 #, no-wrap
37030 msgid ""
37031 " virt-make-fs [--options] input.tar output.img\n"
37032 "\n"
37033 msgstr ""
37034
37035 #. type: verbatim
37036 #: ../tools/virt-make-fs.pl:43
37037 #, no-wrap
37038 msgid ""
37039 " virt-make-fs [--options] input.tar.gz output.img\n"
37040 "\n"
37041 msgstr ""
37042
37043 #. type: verbatim
37044 #: ../tools/virt-make-fs.pl:45
37045 #, no-wrap
37046 msgid ""
37047 " virt-make-fs [--options] directory output.img\n"
37048 "\n"
37049 msgstr ""
37050
37051 #. type: textblock
37052 #: ../tools/virt-make-fs.pl:49
37053 msgid ""
37054 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
37055 "archive or some files in a directory.  It is similar to tools like "
37056 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>.  Unlike those tools, "
37057 "it can create common filesystem types like ext2/3 or NTFS, which can be "
37058 "useful if you want to attach these filesystems to existing virtual machines "
37059 "(eg. to import large amounts of read-only data to a VM)."
37060 msgstr ""
37061
37062 #. type: textblock
37063 #: ../tools/virt-make-fs.pl:57
37064 msgid "Basic usage is:"
37065 msgstr ""
37066
37067 #. type: verbatim
37068 #: ../tools/virt-make-fs.pl:59
37069 #, no-wrap
37070 msgid ""
37071 " virt-make-fs input output\n"
37072 "\n"
37073 msgstr ""
37074
37075 #. type: textblock
37076 #: ../tools/virt-make-fs.pl:61
37077 msgid ""
37078 "where C<input> is either a directory containing files that you want to add, "
37079 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
37080 "C<output> is a disk image.  The input type is detected automatically.  The "
37081 "output disk image defaults to a raw ext2 image unless you specify extra "
37082 "flags (see L</OPTIONS> below)."
37083 msgstr ""
37084
37085 #. type: =head2
37086 #: ../tools/virt-make-fs.pl:67
37087 msgid "EXTRA SPACE"
37088 msgstr ""
37089
37090 #. type: textblock
37091 #: ../tools/virt-make-fs.pl:69
37092 msgid ""
37093 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
37094 "the files that it contains, but might have extra space.  Depending on how "
37095 "you are going to use the output, you might think this extra space is wasted "
37096 "and want to minimize it, or you might want to leave space so that more files "
37097 "can be added later.  Virt-make-fs defaults to minimizing the extra space, "
37098 "but you can use the I<--size> flag to leave space in the filesystem if you "
37099 "want it."
37100 msgstr ""
37101
37102 #. type: textblock
37103 #: ../tools/virt-make-fs.pl:77
37104 msgid ""
37105 "An alternative way to leave extra space but not make the output image any "
37106 "bigger is to use an alternative disk image format (instead of the default "
37107 "\"raw\" format).  Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
37108 "image format (check your hypervisor supports this before using it).  This "
37109 "allows you to choose a large I<--size> but the extra space won't actually be "
37110 "allocated in the image until you try to store something in it."
37111 msgstr ""
37112
37113 #. type: textblock
37114 #: ../tools/virt-make-fs.pl:85
37115 msgid ""
37116 "Don't forget that you can also use local commands including L<resize2fs(8)> "
37117 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
37118 "to build another image from scratch."
37119 msgstr ""
37120
37121 #. type: =head3
37122 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
37123 msgid "EXAMPLE"
37124 msgstr ""
37125
37126 #. type: verbatim
37127 #: ../tools/virt-make-fs.pl:91
37128 #, no-wrap
37129 msgid ""
37130 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
37131 "\n"
37132 msgstr ""
37133
37134 #. type: =head2
37135 #: ../tools/virt-make-fs.pl:93
37136 msgid "FILESYSTEM TYPE"
37137 msgstr ""
37138
37139 #. type: textblock
37140 #: ../tools/virt-make-fs.pl:95
37141 msgid ""
37142 "The default filesystem type is C<ext2>.  Just about any filesystem type that "
37143 "libguestfs supports can be used (but I<not> read-only formats like "
37144 "ISO9660).  Here are some of the more common choices:"
37145 msgstr ""
37146
37147 #. type: =item
37148 #: ../tools/virt-make-fs.pl:101
37149 msgid "I<ext3>"
37150 msgstr ""
37151
37152 #. type: textblock
37153 #: ../tools/virt-make-fs.pl:103
37154 msgid ""
37155 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size.  If "
37156 "you are not going to use the filesystem in a way that requires the journal, "
37157 "then this is just wasted overhead."
37158 msgstr ""
37159
37160 #. type: =item
37161 #: ../tools/virt-make-fs.pl:107
37162 msgid "I<ntfs> or I<vfat>"
37163 msgstr ""
37164
37165 #. type: textblock
37166 #: ../tools/virt-make-fs.pl:109
37167 msgid "Useful if exporting data to a Windows guest."
37168 msgstr ""
37169
37170 #. type: textblock
37171 #: ../tools/virt-make-fs.pl:111
37172 msgid ""
37173 "I<Note for vfat>: The tar archive or local directory must only contain files "
37174 "which are owned by root (ie. UID:GID = 0:0).  The reason is that the tar "
37175 "program running within libguestfs is unable to change the ownership of "
37176 "non-root files, since vfat itself does not support this."
37177 msgstr ""
37178
37179 #. type: =item
37180 #: ../tools/virt-make-fs.pl:116
37181 msgid "I<minix>"
37182 msgstr ""
37183
37184 #. type: textblock
37185 #: ../tools/virt-make-fs.pl:118
37186 msgid ""
37187 "Lower overhead than C<ext2>, but certain limitations on filename length and "
37188 "total filesystem size."
37189 msgstr ""
37190
37191 #. type: verbatim
37192 #: ../tools/virt-make-fs.pl:125
37193 #, no-wrap
37194 msgid ""
37195 " virt-make-fs --type=minix input minixfs.img\n"
37196 "\n"
37197 msgstr ""
37198
37199 #. type: =head2
37200 #: ../tools/virt-make-fs.pl:127
37201 msgid "TO PARTITION OR NOT TO PARTITION"
37202 msgstr ""
37203
37204 #. type: textblock
37205 #: ../tools/virt-make-fs.pl:129
37206 msgid "Optionally virt-make-fs can add a partition table to the output disk."
37207 msgstr ""
37208
37209 #. type: textblock
37210 #: ../tools/virt-make-fs.pl:131
37211 msgid ""
37212 "Adding a partition can make the disk image more compatible with certain "
37213 "virtualized operating systems which don't expect to see a filesystem "
37214 "directly located on a block device (Linux doesn't care and will happily "
37215 "handle both types)."
37216 msgstr ""
37217
37218 #. type: textblock
37219 #: ../tools/virt-make-fs.pl:136
37220 msgid ""
37221 "On the other hand, if you have a partition table then the output image is no "
37222 "longer a straight filesystem.  For example you cannot run L<fsck(8)> "
37223 "directly on a partitioned disk image.  (However libguestfs tools such as "
37224 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
37225 msgstr ""
37226
37227 #. type: textblock
37228 #: ../tools/virt-make-fs.pl:144
37229 msgid "Add an MBR partition:"
37230 msgstr ""
37231
37232 #. type: verbatim
37233 #: ../tools/virt-make-fs.pl:146
37234 #, no-wrap
37235 msgid ""
37236 " virt-make-fs --partition -- input disk.img\n"
37237 "\n"
37238 msgstr ""
37239
37240 #. type: textblock
37241 #: ../tools/virt-make-fs.pl:148
37242 msgid ""
37243 "If the output disk image could be terabyte-sized or larger, it's better to "
37244 "use an EFI/GPT-compatible partition table:"
37245 msgstr ""
37246
37247 #. type: verbatim
37248 #: ../tools/virt-make-fs.pl:151
37249 #, no-wrap
37250 msgid ""
37251 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
37252 "\n"
37253 msgstr ""
37254
37255 #. type: textblock
37256 #: ../tools/virt-make-fs.pl:179
37257 msgid "Enable debugging information."
37258 msgstr ""
37259
37260 #. type: =item
37261 #: ../tools/virt-make-fs.pl:185
37262 msgid "B<--size=E<lt>NE<gt>>"
37263 msgstr ""
37264
37265 #. type: =item
37266 #: ../tools/virt-make-fs.pl:187
37267 msgid "B<--size=+E<lt>NE<gt>>"
37268 msgstr ""
37269
37270 #. type: =item
37271 #: ../tools/virt-make-fs.pl:189
37272 msgid "B<-s E<lt>NE<gt>>"
37273 msgstr ""
37274
37275 #. type: =item
37276 #: ../tools/virt-make-fs.pl:191
37277 msgid "B<-s +E<lt>NE<gt>>"
37278 msgstr ""
37279
37280 #. type: textblock
37281 #: ../tools/virt-make-fs.pl:193
37282 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
37283 msgstr ""
37284
37285 #. type: textblock
37286 #: ../tools/virt-make-fs.pl:196
37287 msgid ""
37288 "If this option is I<not> given, then the output image will be just large "
37289 "enough to contain all the files, with not much wasted space."
37290 msgstr ""
37291
37292 #. type: textblock
37293 #: ../tools/virt-make-fs.pl:199
37294 msgid ""
37295 "To choose a fixed size output disk, specify an absolute number followed by "
37296 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
37297 "Petabytes or Exabytes.  This must be large enough to contain all the input "
37298 "files, else you will get an error."
37299 msgstr ""
37300
37301 #. type: textblock
37302 #: ../tools/virt-make-fs.pl:204
37303 msgid ""
37304 "To leave extra space, specify C<+> (plus sign) and a number followed by "
37305 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
37306 "Petabytes or Exabytes.  For example: I<--size=+200M> means enough space for "
37307 "the input files, and (approximately) an extra 200 MB free space."
37308 msgstr ""
37309
37310 #. type: textblock
37311 #: ../tools/virt-make-fs.pl:210
37312 msgid ""
37313 "Note that virt-make-fs estimates free space, and therefore will not produce "
37314 "filesystems containing precisely the free space requested.  (It is much more "
37315 "expensive and time-consuming to produce a filesystem which has precisely the "
37316 "desired free space)."
37317 msgstr ""
37318
37319 #. type: =item
37320 #: ../tools/virt-make-fs.pl:219
37321 msgid "B<--format=E<lt>fmtE<gt>>"
37322 msgstr ""
37323
37324 #. type: =item
37325 #: ../tools/virt-make-fs.pl:221
37326 msgid "B<-F E<lt>fmtE<gt>>"
37327 msgstr ""
37328
37329 #. type: textblock
37330 #: ../tools/virt-make-fs.pl:223
37331 msgid "Choose the output disk image format."
37332 msgstr ""
37333
37334 #. type: textblock
37335 #: ../tools/virt-make-fs.pl:225
37336 msgid "The default is C<raw> (raw disk image)."
37337 msgstr ""
37338
37339 #. type: textblock
37340 #: ../tools/virt-make-fs.pl:227
37341 msgid ""
37342 "For other choices, see the L<qemu-img(1)> manpage.  The only other choice "
37343 "that would really make sense here is C<qcow2>."
37344 msgstr ""
37345
37346 #. type: =item
37347 #: ../tools/virt-make-fs.pl:234
37348 msgid "B<--type=E<lt>fsE<gt>>"
37349 msgstr ""
37350
37351 #. type: =item
37352 #: ../tools/virt-make-fs.pl:236
37353 msgid "B<-t E<lt>fsE<gt>>"
37354 msgstr ""
37355
37356 #. type: textblock
37357 #: ../tools/virt-make-fs.pl:238
37358 msgid "Choose the output filesystem type."
37359 msgstr ""
37360
37361 #. type: textblock
37362 #: ../tools/virt-make-fs.pl:240
37363 msgid "The default is C<ext2>."
37364 msgstr ""
37365
37366 #. type: textblock
37367 #: ../tools/virt-make-fs.pl:242
37368 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
37369 msgstr ""
37370
37371 #. type: =item
37372 #: ../tools/virt-make-fs.pl:249
37373 msgid "B<--partition>"
37374 msgstr ""
37375
37376 #. type: =item
37377 #: ../tools/virt-make-fs.pl:251
37378 msgid "B<--partition=E<lt>parttypeE<gt>>"
37379 msgstr ""
37380
37381 #. type: textblock
37382 #: ../tools/virt-make-fs.pl:253
37383 msgid ""
37384 "If specified, this flag adds an MBR partition table to the output disk "
37385 "image."
37386 msgstr ""
37387
37388 #. type: textblock
37389 #: ../tools/virt-make-fs.pl:256
37390 msgid ""
37391 "You can change the partition table type, eg. I<--partition=gpt> for large "
37392 "disks."
37393 msgstr ""
37394
37395 #. type: textblock
37396 #: ../tools/virt-make-fs.pl:259
37397 msgid ""
37398 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
37399 "might consider the next parameter to be the partition type.  For example:"
37400 msgstr ""
37401
37402 #. type: verbatim
37403 #: ../tools/virt-make-fs.pl:263
37404 #, no-wrap
37405 msgid ""
37406 " virt-make-fs --partition input.tar ...\n"
37407 "\n"
37408 msgstr ""
37409
37410 #. type: textblock
37411 #: ../tools/virt-make-fs.pl:265
37412 msgid ""
37413 "would cause virt-make-fs to think you wanted to use a partition type of "
37414 "C<input.tar> which is completely wrong.  To avoid this, use I<--> (a double "
37415 "dash) between options and the input file argument:"
37416 msgstr ""
37417
37418 #. type: verbatim
37419 #: ../tools/virt-make-fs.pl:269
37420 #, no-wrap
37421 msgid ""
37422 " virt-make-fs --partition -- input.tar ...\n"
37423 "\n"
37424 msgstr ""
37425
37426 #. type: textblock
37427 #: ../tools/virt-make-fs.pl:541
37428 msgid ""
37429 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
37430 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
37431 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
37432 msgstr ""
37433
37434 #. type: textblock
37435 #: ../tools/virt-make-fs.pl:555 ../tools/virt-win-reg.pl:763
37436 msgid ""
37437 "When reporting bugs, please enable debugging and capture the I<complete> "
37438 "output:"
37439 msgstr ""
37440
37441 #. type: verbatim
37442 #: ../tools/virt-make-fs.pl:558
37443 #, no-wrap
37444 msgid ""
37445 " export LIBGUESTFS_DEBUG=1\n"
37446 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
37447 "\n"
37448 msgstr ""
37449
37450 #. type: textblock
37451 #: ../tools/virt-make-fs.pl:561
37452 msgid ""
37453 "Attach /tmp/virt-make-fs.log to a new bug report at "
37454 "L<https://bugzilla.redhat.com/>"
37455 msgstr ""
37456
37457 #. type: textblock
37458 #: ../tools/virt-tar.pl:33
37459 msgid "virt-tar - Extract or upload files to a virtual machine"
37460 msgstr ""
37461
37462 #. type: verbatim
37463 #: ../tools/virt-tar.pl:37
37464 #, no-wrap
37465 msgid ""
37466 " virt-tar [--options] -x domname directory tarball\n"
37467 "\n"
37468 msgstr ""
37469
37470 #. type: verbatim
37471 #: ../tools/virt-tar.pl:39
37472 #, no-wrap
37473 msgid ""
37474 " virt-tar [--options] -u domname tarball directory\n"
37475 "\n"
37476 msgstr ""
37477
37478 #. type: verbatim
37479 #: ../tools/virt-tar.pl:41
37480 #, no-wrap
37481 msgid ""
37482 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
37483 "\n"
37484 msgstr ""
37485
37486 #. type: verbatim
37487 #: ../tools/virt-tar.pl:43
37488 #, no-wrap
37489 msgid ""
37490 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
37491 "\n"
37492 msgstr ""
37493
37494 #. type: =head2
37495 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
37496 msgid "NOTE"
37497 msgstr ""
37498
37499 #. type: textblock
37500 #: ../tools/virt-tar.pl:47
37501 msgid ""
37502 "This tool is obsolete.  Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
37503 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
37504 msgstr ""
37505
37506 #. type: textblock
37507 #: ../tools/virt-tar.pl:52
37508 msgid "Download C</home> from the VM into a local tarball:"
37509 msgstr ""
37510
37511 #. type: verbatim
37512 #: ../tools/virt-tar.pl:54
37513 #, no-wrap
37514 msgid ""
37515 " virt-tar -x domname /home home.tar\n"
37516 "\n"
37517 msgstr ""
37518
37519 #. type: verbatim
37520 #: ../tools/virt-tar.pl:56
37521 #, no-wrap
37522 msgid ""
37523 " virt-tar -zx domname /home home.tar.gz\n"
37524 "\n"
37525 msgstr ""
37526
37527 #. type: textblock
37528 #: ../tools/virt-tar.pl:58
37529 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
37530 msgstr ""
37531
37532 #. type: verbatim
37533 #: ../tools/virt-tar.pl:60
37534 #, no-wrap
37535 msgid ""
37536 " virt-tar -u domname uploadstuff.tar /tmp\n"
37537 "\n"
37538 msgstr ""
37539
37540 #. type: verbatim
37541 #: ../tools/virt-tar.pl:62
37542 #, no-wrap
37543 msgid ""
37544 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
37545 "\n"
37546 msgstr ""
37547
37548 #. type: textblock
37549 #: ../tools/virt-tar.pl:66
37550 msgid ""
37551 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
37552 "virtual machines.  If you do this, you risk disk corruption in the VM.  "
37553 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
37554 msgstr ""
37555
37556 #. type: textblock
37557 #: ../tools/virt-tar.pl:71
37558 msgid ""
37559 "You can use I<-x> (extract) on live virtual machines, but you might get "
37560 "inconsistent results or errors if there is filesystem activity inside the "
37561 "VM.  If the live VM is synched and quiescent, then C<virt-tar> will usually "
37562 "work, but the only way to guarantee consistent results is if the virtual "
37563 "machine is shut down."
37564 msgstr ""
37565
37566 #. type: textblock
37567 #: ../tools/virt-tar.pl:79
37568 msgid ""
37569 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
37570 "parts of a guest filesystem.  There are many possibilities: making backups, "
37571 "uploading data files, snooping on guest activity, fixing or customizing "
37572 "guests, etc."
37573 msgstr ""
37574
37575 #. type: textblock
37576 #: ../tools/virt-tar.pl:84
37577 msgid ""
37578 "If you want to just view a single file, use L<virt-cat(1)>.  If you just "
37579 "want to edit a single file, use L<virt-edit(1)>.  For more complex cases you "
37580 "should look at the L<guestfish(1)> tool."
37581 msgstr ""
37582
37583 #. type: textblock
37584 #: ../tools/virt-tar.pl:88
37585 msgid ""
37586 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
37587 "its contents (recursively) from the virtual machine into a local tarball.  "
37588 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
37589 "virtual machine.  You cannot use these two options together."
37590 msgstr ""
37591
37592 #. type: textblock
37593 #: ../tools/virt-tar.pl:94
37594 msgid ""
37595 "In addition, you may need to use the I<-z> (gZip) option to enable "
37596 "compression.  When uploading, you have to specify I<-z> if the upload file "
37597 "is compressed because virt-tar won't detect this on its own."
37598 msgstr ""
37599
37600 #. type: textblock
37601 #: ../tools/virt-tar.pl:98
37602 msgid ""
37603 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs.  For "
37604 "example it cannot do PKZip files or bzip2 compression.  If you want that "
37605 "then you'll have to rebuild the tarballs yourself.  (This is a limitation of "
37606 "the L<libguestfs(3)> API)."
37607 msgstr ""
37608
37609 #. type: =item
37610 #: ../tools/virt-tar.pl:160
37611 msgid "B<--extract>"
37612 msgstr ""
37613
37614 #. type: =item
37615 #: ../tools/virt-tar.pl:162
37616 msgid "B<--download>"
37617 msgstr ""
37618
37619 #. type: =item
37620 #: ../tools/virt-tar.pl:164
37621 msgid "B<-u>"
37622 msgstr ""
37623
37624 #. type: =item
37625 #: ../tools/virt-tar.pl:166
37626 msgid "B<--upload>"
37627 msgstr ""
37628
37629 #. type: textblock
37630 #: ../tools/virt-tar.pl:168
37631 msgid ""
37632 "Use I<-x> to extract (download) a directory from a virtual machine to a "
37633 "local tarball."
37634 msgstr ""
37635
37636 #. type: textblock
37637 #: ../tools/virt-tar.pl:171
37638 msgid ""
37639 "Use I<-u> to upload and unpack from a local tarball into a virtual machine.  "
37640 "Please read the L</WARNING> section above before using this option."
37641 msgstr ""
37642
37643 #. type: textblock
37644 #: ../tools/virt-tar.pl:175
37645 msgid "You must specify exactly one of these options."
37646 msgstr ""
37647
37648 #. type: =item
37649 #: ../tools/virt-tar.pl:181
37650 msgid "B<-z>"
37651 msgstr ""
37652
37653 #. type: =item
37654 #: ../tools/virt-tar.pl:183
37655 msgid "B<--gzip>"
37656 msgstr ""
37657
37658 #. type: textblock
37659 #: ../tools/virt-tar.pl:185
37660 msgid "Specify that the input or output tarball is gzip-compressed."
37661 msgstr ""
37662
37663 #. type: textblock
37664 #: ../tools/virt-tar.pl:298
37665 msgid ""
37666 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
37667 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
37668 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
37669 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
37670 msgstr ""
37671
37672 #. type: textblock
37673 #: ../tools/virt-win-reg.pl:37
37674 msgid ""
37675 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
37676 "guest"
37677 msgstr ""
37678
37679 #. type: verbatim
37680 #: ../tools/virt-win-reg.pl:41
37681 #, no-wrap
37682 msgid ""
37683 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
37684 "\n"
37685 msgstr ""
37686
37687 #. type: verbatim
37688 #: ../tools/virt-win-reg.pl:43
37689 #, no-wrap
37690 msgid ""
37691 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
37692 "\n"
37693 msgstr ""
37694
37695 #. type: verbatim
37696 #: ../tools/virt-win-reg.pl:45
37697 #, no-wrap
37698 msgid ""
37699 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
37700 "\n"
37701 msgstr ""
37702
37703 #. type: verbatim
37704 #: ../tools/virt-win-reg.pl:47
37705 #, no-wrap
37706 msgid ""
37707 " virt-win-reg --merge domname [input.reg ...]\n"
37708 "\n"
37709 msgstr ""
37710
37711 #. type: verbatim
37712 #: ../tools/virt-win-reg.pl:49
37713 #, no-wrap
37714 msgid ""
37715 " virt-win-reg [--options] disk.img ... # instead of domname\n"
37716 "\n"
37717 msgstr ""
37718
37719 #. type: textblock
37720 #: ../tools/virt-win-reg.pl:53
37721 msgid ""
37722 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
37723 "virtual machines.  If you do this, you I<will> get irreversible disk "
37724 "corruption in the VM.  C<virt-win-reg> tries to stop you from doing this, "
37725 "but doesn't catch all cases."
37726 msgstr ""
37727
37728 #. type: textblock
37729 #: ../tools/virt-win-reg.pl:58
37730 msgid ""
37731 "Modifying the Windows Registry is an inherently risky operation.  The format "
37732 "is deliberately obscure and undocumented, and Registry changes can leave the "
37733 "system unbootable.  Therefore when using the I<--merge> option, make sure "
37734 "you have a reliable backup first."
37735 msgstr ""
37736
37737 #. type: textblock
37738 #: ../tools/virt-win-reg.pl:65
37739 msgid ""
37740 "This program can export and merge Windows Registry entries from a Windows "
37741 "guest."
37742 msgstr ""
37743
37744 #. type: textblock
37745 #: ../tools/virt-win-reg.pl:68
37746 msgid ""
37747 "The first parameter is the libvirt guest name or the raw disk image of a "
37748 "Windows guest."
37749 msgstr ""
37750
37751 #. type: textblock
37752 #: ../tools/virt-win-reg.pl:71
37753 msgid ""
37754 "If I<--merge> is I<not> specified, then the chosen registry key is "
37755 "displayed/exported (recursively).  For example:"
37756 msgstr ""
37757
37758 #. type: verbatim
37759 #: ../tools/virt-win-reg.pl:74
37760 #, no-wrap
37761 msgid ""
37762 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
37763 "\n"
37764 msgstr ""
37765
37766 #. type: textblock
37767 #: ../tools/virt-win-reg.pl:76
37768 msgid "You can also display single values from within registry keys, for example:"
37769 msgstr ""
37770
37771 #. type: verbatim
37772 #: ../tools/virt-win-reg.pl:79
37773 #, no-wrap
37774 msgid ""
37775 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
37776 " $ virt-win-reg Windows7 $cvkey ProductName\n"
37777 " Windows 7 Enterprise\n"
37778 "\n"
37779 msgstr ""
37780
37781 #. type: textblock
37782 #: ../tools/virt-win-reg.pl:83
37783 msgid ""
37784 "With I<--merge>, you can merge a textual regedit file into the Windows "
37785 "Registry:"
37786 msgstr ""
37787
37788 #. type: verbatim
37789 #: ../tools/virt-win-reg.pl:86
37790 #, no-wrap
37791 msgid ""
37792 " $ virt-win-reg --merge Windows7 changes.reg\n"
37793 "\n"
37794 msgstr ""
37795
37796 #. type: textblock
37797 #: ../tools/virt-win-reg.pl:90
37798 msgid ""
37799 "This program is only meant for simple access to the registry.  If you want "
37800 "to do complicated things with the registry, we suggest you download the "
37801 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
37802 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
37803 "L<hivexregedit(1)>."
37804 msgstr ""
37805
37806 #. type: =item
37807 #: ../tools/virt-win-reg.pl:159
37808 msgid "B<--merge>"
37809 msgstr ""
37810
37811 #. type: textblock
37812 #: ../tools/virt-win-reg.pl:161
37813 msgid ""
37814 "In merge mode, this merges a textual regedit file into the Windows Registry "
37815 "of the virtual machine.  If this flag is I<not> given then virt-win-reg "
37816 "displays or exports Registry entries instead."
37817 msgstr ""
37818
37819 #. type: textblock
37820 #: ../tools/virt-win-reg.pl:165
37821 msgid ""
37822 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
37823 "result in disk corruption.  However exporting (without this flag)  is always "
37824 "safe."
37825 msgstr ""
37826
37827 #. type: =item
37828 #: ../tools/virt-win-reg.pl:173
37829 msgid "B<--encoding> UTF-16LE|ASCII"
37830 msgstr ""
37831
37832 #. type: textblock
37833 #: ../tools/virt-win-reg.pl:175
37834 msgid ""
37835 "When merging (only), you may need to specify the encoding for strings to be "
37836 "used in the hive file.  This is explained in detail in "
37837 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
37838 msgstr ""
37839
37840 #. type: textblock
37841 #: ../tools/virt-win-reg.pl:179
37842 msgid ""
37843 "The default is to use UTF-16LE, which should work with recent versions of "
37844 "Windows."
37845 msgstr ""
37846
37847 #. type: =item
37848 #: ../tools/virt-win-reg.pl:186
37849 msgid "B<--unsafe-printable-strings>"
37850 msgstr ""
37851
37852 #. type: textblock
37853 #: ../tools/virt-win-reg.pl:188
37854 msgid ""
37855 "When exporting (only), assume strings are UTF-16LE and print them as strings "
37856 "instead of hex sequences.  Remove the final zero codepoint from strings if "
37857 "present."
37858 msgstr ""
37859
37860 #. type: textblock
37861 #: ../tools/virt-win-reg.pl:192
37862 msgid ""
37863 "This is unsafe and does not preserve the fidelity of strings in the original "
37864 "Registry for various reasons:"
37865 msgstr ""
37866
37867 #. type: textblock
37868 #: ../tools/virt-win-reg.pl:199
37869 msgid ""
37870 "Assumes the original encoding is UTF-16LE.  ASCII strings and strings in "
37871 "other encodings will be corrupted by this transformation."
37872 msgstr ""
37873
37874 #. type: textblock
37875 #: ../tools/virt-win-reg.pl:204
37876 msgid ""
37877 "Assumes that everything which has type 1 or 2 is really a string and that "
37878 "everything else is not a string, but the type field in real Registries is "
37879 "not reliable."
37880 msgstr ""
37881
37882 #. type: textblock
37883 #: ../tools/virt-win-reg.pl:210
37884 msgid ""
37885 "Loses information about whether a zero codepoint followed the string in the "
37886 "Registry or not."
37887 msgstr ""
37888
37889 #. type: textblock
37890 #: ../tools/virt-win-reg.pl:215
37891 msgid ""
37892 "This all happens because the Registry itself contains no information about "
37893 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
37894 msgstr ""
37895
37896 #. type: textblock
37897 #: ../tools/virt-win-reg.pl:219
37898 msgid ""
37899 "You should only use this option for quick hacking and debugging of the "
37900 "Registry contents, and I<never> use it if the output is going to be passed "
37901 "into another program or stored in another Registry."
37902 msgstr ""
37903
37904 #. type: =head1
37905 #: ../tools/virt-win-reg.pl:556
37906 msgid "SUPPORTED SYSTEMS"
37907 msgstr ""
37908
37909 #. type: textblock
37910 #: ../tools/virt-win-reg.pl:558
37911 msgid ""
37912 "The program currently supports Windows NT-derived guests starting with "
37913 "Windows XP through to at least Windows 7."
37914 msgstr ""
37915
37916 #. type: textblock
37917 #: ../tools/virt-win-reg.pl:561
37918 msgid "The following Registry keys are supported:"
37919 msgstr ""
37920
37921 #. type: =item
37922 #: ../tools/virt-win-reg.pl:565
37923 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
37924 msgstr ""
37925
37926 #. type: =item
37927 #: ../tools/virt-win-reg.pl:567
37928 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
37929 msgstr ""
37930
37931 #. type: =item
37932 #: ../tools/virt-win-reg.pl:569
37933 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
37934 msgstr ""
37935
37936 #. type: =item
37937 #: ../tools/virt-win-reg.pl:571
37938 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
37939 msgstr ""
37940
37941 #. type: =item
37942 #: ../tools/virt-win-reg.pl:573
37943 msgid "C<HKEY_USERS\\.DEFAULT>"
37944 msgstr ""
37945
37946 #. type: =item
37947 #: ../tools/virt-win-reg.pl:575
37948 msgid "C<HKEY_USERS\\I<SID>>"
37949 msgstr ""
37950
37951 #. type: textblock
37952 #: ../tools/virt-win-reg.pl:577
37953 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
37954 msgstr ""
37955
37956 #. type: =item
37957 #: ../tools/virt-win-reg.pl:579
37958 msgid "C<HKEY_USERS\\I<username>>"
37959 msgstr ""
37960
37961 #. type: textblock
37962 #: ../tools/virt-win-reg.pl:581
37963 msgid "where I<username> is a local user name (this is a libguestfs extension)."
37964 msgstr ""
37965
37966 #. type: textblock
37967 #: ../tools/virt-win-reg.pl:585
37968 msgid ""
37969 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
37970 "C<HKEY_USERS>."
37971 msgstr ""
37972
37973 #. type: textblock
37974 #: ../tools/virt-win-reg.pl:588
37975 msgid ""
37976 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
37977 "supported (there is no \"current user\")."
37978 msgstr ""
37979
37980 #. type: =head1
37981 #: ../tools/virt-win-reg.pl:591
37982 msgid "ENCODING"
37983 msgstr ""
37984
37985 #. type: textblock
37986 #: ../tools/virt-win-reg.pl:593
37987 msgid ""
37988 "C<virt-win-reg> expects that regedit files have already been reencoded in "
37989 "the local encoding.  Usually on Linux hosts, this means UTF-8 with "
37990 "Unix-style line endings.  Since Windows regedit files are often in UTF-16LE "
37991 "with Windows-style line endings, you may need to reencode the whole file "
37992 "before or after processing."
37993 msgstr ""
37994
37995 #. type: textblock
37996 #: ../tools/virt-win-reg.pl:599
37997 msgid ""
37998 "To reencode a file from Windows format to Linux (before processing it with "
37999 "the I<--merge> option), you would do something like this:"
38000 msgstr ""
38001
38002 #. type: verbatim
38003 #: ../tools/virt-win-reg.pl:602
38004 #, no-wrap
38005 msgid ""
38006 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
38007 "\n"
38008 msgstr ""
38009
38010 #. type: textblock
38011 #: ../tools/virt-win-reg.pl:604
38012 msgid ""
38013 "To go in the opposite direction, after exporting and before sending the file "
38014 "to a Windows user, do something like this:"
38015 msgstr ""
38016
38017 #. type: verbatim
38018 #: ../tools/virt-win-reg.pl:607
38019 #, no-wrap
38020 msgid ""
38021 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
38022 "\n"
38023 msgstr ""
38024
38025 #. type: textblock
38026 #: ../tools/virt-win-reg.pl:609
38027 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
38028 msgstr ""
38029
38030 #. type: textblock
38031 #: ../tools/virt-win-reg.pl:611
38032 msgid ""
38033 "If you are unsure about the current encoding, use the L<file(1)> command.  "
38034 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
38035 "Windows-style (CRLF) line endings, like this:"
38036 msgstr ""
38037
38038 #. type: verbatim
38039 #: ../tools/virt-win-reg.pl:615
38040 #, no-wrap
38041 msgid ""
38042 " $ file software.reg\n"
38043 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
38044 " with CRLF line terminators\n"
38045 "\n"
38046 msgstr ""
38047
38048 #. type: textblock
38049 #: ../tools/virt-win-reg.pl:619
38050 msgid "This file would need conversion before you could I<--merge> it."
38051 msgstr ""
38052
38053 #. type: =head1
38054 #: ../tools/virt-win-reg.pl:621
38055 msgid "CurrentControlSet etc."
38056 msgstr ""
38057
38058 #. type: textblock
38059 #: ../tools/virt-win-reg.pl:623
38060 msgid ""
38061 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
38062 "Registry at the level of the hive file, and therefore you cannot modify "
38063 "these."
38064 msgstr ""
38065
38066 #. type: textblock
38067 #: ../tools/virt-win-reg.pl:627
38068 msgid ""
38069 "C<CurrentControlSet> is usually an alias for C<ControlSet001>.  In some "
38070 "circumstances it might refer to another control set.  The way to find out is "
38071 "to look at the C<HKLM\\SYSTEM\\Select> key:"
38072 msgstr ""
38073
38074 #. type: verbatim
38075 #: ../tools/virt-win-reg.pl:631
38076 #, no-wrap
38077 msgid ""
38078 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
38079 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
38080 " \"Current\"=dword:00000001\n"
38081 " \"Default\"=dword:00000001\n"
38082 " \"Failed\"=dword:00000000\n"
38083 " \"LastKnownGood\"=dword:00000002\n"
38084 "\n"
38085 msgstr ""
38086
38087 #. type: textblock
38088 #: ../tools/virt-win-reg.pl:638
38089 msgid "\"Current\" is the one which Windows will choose when it boots."
38090 msgstr ""
38091
38092 #. type: textblock
38093 #: ../tools/virt-win-reg.pl:640
38094 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
38095 msgstr ""
38096
38097 #. type: =head1
38098 #: ../tools/virt-win-reg.pl:643
38099 msgid "WINDOWS TIPS"
38100 msgstr ""
38101
38102 #. type: textblock
38103 #: ../tools/virt-win-reg.pl:645
38104 msgid ""
38105 "Note that some of these tips modify the guest disk image.  The guest I<must> "
38106 "be shut off, else you will get disk corruption."
38107 msgstr ""
38108
38109 #. type: =head2
38110 #: ../tools/virt-win-reg.pl:648
38111 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
38112 msgstr ""
38113
38114 #. type: textblock
38115 #: ../tools/virt-win-reg.pl:650
38116 msgid ""
38117 "Prepare a DOS batch script, VBScript or executable.  Upload this using "
38118 "L<guestfish(1)>.  For this example the script is called C<test.bat> and it "
38119 "is uploaded into C<C:\\>:"
38120 msgstr ""
38121
38122 #. type: verbatim
38123 #: ../tools/virt-win-reg.pl:654
38124 #, no-wrap
38125 msgid ""
38126 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
38127 "\n"
38128 msgstr ""
38129
38130 #. type: textblock
38131 #: ../tools/virt-win-reg.pl:656
38132 msgid "Prepare a regedit file containing the registry change:"
38133 msgstr ""
38134
38135 #. type: verbatim
38136 #: ../tools/virt-win-reg.pl:658
38137 #, no-wrap
38138 msgid ""
38139 " cat > test.reg <<'EOF'\n"
38140 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
38141 " \"Test\"=\"c:\\\\test.bat\"\n"
38142 " EOF\n"
38143 "\n"
38144 msgstr ""
38145
38146 #. type: textblock
38147 #: ../tools/virt-win-reg.pl:663
38148 msgid ""
38149 "In this example we use the key C<RunOnce> which means that the script will "
38150 "run precisely once when the first user logs in.  If you want it to run every "
38151 "time a user logs in, replace C<RunOnce> with C<Run>."
38152 msgstr ""
38153
38154 #. type: textblock
38155 #: ../tools/virt-win-reg.pl:667
38156 msgid "Now update the registry:"
38157 msgstr ""
38158
38159 #. type: verbatim
38160 #: ../tools/virt-win-reg.pl:669
38161 #, no-wrap
38162 msgid ""
38163 " virt-win-reg --merge WindowsGuest test.reg\n"
38164 "\n"
38165 msgstr ""
38166
38167 #. type: =head2
38168 #: ../tools/virt-win-reg.pl:671
38169 msgid "INSTALLING A SERVICE"
38170 msgstr ""
38171
38172 #. type: textblock
38173 #: ../tools/virt-win-reg.pl:673
38174 msgid ""
38175 "This section assumes you are familiar with Windows services, and you either "
38176 "have a program which handles the Windows Service Control Protocol directly "
38177 "or you want to run any program using a service wrapper like SrvAny or the "
38178 "free RHSrvAny."
38179 msgstr ""
38180
38181 #. type: textblock
38182 #: ../tools/virt-win-reg.pl:678
38183 msgid ""
38184 "First upload the program and optionally the service wrapper.  In this case "
38185 "the test program is called C<test.exe> and we are using the RHSrvAny "
38186 "wrapper:"
38187 msgstr ""
38188
38189 #. type: verbatim
38190 #: ../tools/virt-win-reg.pl:682
38191 #, no-wrap
38192 msgid ""
38193 " guestfish -i -d WindowsGuest <<EOF\n"
38194 "   upload rhsrvany.exe /rhsrvany.exe\n"
38195 "   upload test.exe /test.exe\n"
38196 " EOF\n"
38197 "\n"
38198 msgstr ""
38199
38200 #. type: textblock
38201 #: ../tools/virt-win-reg.pl:687
38202 msgid ""
38203 "Prepare a regedit file containing the registry changes.  In this example, "
38204 "the first registry change is needed for the service itself or the service "
38205 "wrapper (if used).  The second registry change is only needed because I am "
38206 "using the RHSrvAny service wrapper."
38207 msgstr ""
38208
38209 #. type: verbatim
38210 #: ../tools/virt-win-reg.pl:692
38211 #, no-wrap
38212 msgid ""
38213 " cat > service.reg <<'EOF'\n"
38214 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
38215 " \"Type\"=dword:00000010\n"
38216 " \"Start\"=dword:00000002\n"
38217 " \"ErrorControl\"=dword:00000001\n"
38218 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
38219 " \"DisplayName\"=\"RHSrvAny\"\n"
38220 " \"ObjectName\"=\"NetworkService\"\n"
38221 " \n"
38222 msgstr ""
38223
38224 #. type: verbatim
38225 #: ../tools/virt-win-reg.pl:701
38226 #, no-wrap
38227 msgid ""
38228 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
38229 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
38230 " \"PWD\"=\"c:\\\\Temp\"\n"
38231 " EOF\n"
38232 "\n"
38233 msgstr ""
38234
38235 #. type: textblock
38236 #: ../tools/virt-win-reg.pl:712
38237 msgid ""
38238 "For use of C<ControlSet001> see the section above in this manual page.  You "
38239 "may need to adjust this according to the control set that is in use by the "
38240 "guest."
38241 msgstr ""
38242
38243 #. type: textblock
38244 #: ../tools/virt-win-reg.pl:718
38245 msgid ""
38246 "C<\"ObjectName\"> controls the privileges that the service will have.  An "
38247 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
38248 "privileged account."
38249 msgstr ""
38250
38251 #. type: textblock
38252 #: ../tools/virt-win-reg.pl:724
38253 msgid ""
38254 "For the meaning of the magic numbers, see this Microsoft KB article: "
38255 "L<http://support.microsoft.com/kb/103000>."
38256 msgstr ""
38257
38258 #. type: textblock
38259 #: ../tools/virt-win-reg.pl:729
38260 msgid "Update the registry:"
38261 msgstr ""
38262
38263 #. type: verbatim
38264 #: ../tools/virt-win-reg.pl:731
38265 #, no-wrap
38266 msgid ""
38267 " virt-win-reg --merge WindowsGuest service.reg\n"
38268 "\n"
38269 msgstr ""
38270
38271 #. type: textblock
38272 #: ../tools/virt-win-reg.pl:735
38273 msgid ""
38274 "Be careful when passing parameters containing C<\\> (backslash) in the "
38275 "shell.  Usually you will have to use 'single quotes' or double backslashes "
38276 "(but not both) to protect them from the shell."
38277 msgstr ""
38278
38279 #. type: textblock
38280 #: ../tools/virt-win-reg.pl:739
38281 msgid "Paths and value names are case-insensitive."
38282 msgstr ""
38283
38284 #. type: textblock
38285 #: ../tools/virt-win-reg.pl:748
38286 msgid ""
38287 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
38288 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
38289 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
38290 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
38291 msgstr ""
38292
38293 #. type: verbatim
38294 #: ../tools/virt-win-reg.pl:766
38295 #, no-wrap
38296 msgid ""
38297 " export LIBGUESTFS_DEBUG=1\n"
38298 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
38299 "\n"
38300 msgstr ""
38301
38302 #. type: textblock
38303 #: ../tools/virt-win-reg.pl:769
38304 msgid ""
38305 "Attach /tmp/virt-win-reg.log to a new bug report at "
38306 "L<https://bugzilla.redhat.com/>"
38307 msgstr ""