1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
5 # rjones <rjones@redhat.com>, 2011.
8 "Project-Id-Version: libguestfs\n"
9 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
10 "POT-Creation-Date: 2011-07-18 11:32+0200\n"
11 "PO-Revision-Date: 2011-07-17 20:50+0000\n"
12 "Last-Translator: rjones <rjones@redhat.com>\n"
13 "Language-Team: Japanese (http://www.transifex.net/projects/p/fedora/team/"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
19 "Plural-Forms: nplurals=1; plural=0\n"
22 #: ../cat/virt-cat.pod:3 ../cat/virt-filesystems.pod:3 ../cat/virt-ls.pod:3
23 #: ../df/virt-df.pod:3 ../edit/virt-edit.pod:3
24 #: ../examples/guestfs-examples.pod:3 ../examples/guestfs-recipes.pod:14
25 #: ../fish/guestfish.pod:3 ../fish/virt-copy-in.pod:3
26 #: ../fish/virt-copy-out.pod:3 ../fish/virt-tar-in.pod:3
27 #: ../fish/virt-tar-out.pod:3 ../fuse/guestmount.pod:3
28 #: ../inspector/virt-inspector.pod:3 ../libguestfs-1.11.19/cat/virt-cat.pod:3
29 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:3
30 #: ../libguestfs-1.11.19/cat/virt-ls.pod:3
31 #: ../libguestfs-1.11.19/df/virt-df.pod:3
32 #: ../libguestfs-1.11.19/edit/virt-edit.pod:3
33 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:3
34 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:14
35 #: ../libguestfs-1.11.19/fish/guestfish.pod:3
36 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:3
37 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:3
38 #: ../libguestfs-1.11.19/fish/virt-tar-in.pod:3
39 #: ../libguestfs-1.11.19/fish/virt-tar-out.pod:3
40 #: ../libguestfs-1.11.19/fuse/guestmount.pod:3
41 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:3
42 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:3
43 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:3
44 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:3
45 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:3
46 #: ../libguestfs-1.11.19/resize/virt-resize.pod:3
47 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:3
48 #: ../libguestfs-1.11.19/src/guestfs.pod:3
49 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:3
50 #: ../ocaml/examples/guestfs-ocaml.pod:3 ../perl/examples/guestfs-perl.pod:3
51 #: ../python/examples/guestfs-python.pod:3 ../rescue/virt-rescue.pod:3
52 #: ../resize/virt-resize.pod:3 ../ruby/examples/guestfs-ruby.pod:3
53 #: ../src/guestfs.pod:3 ../test-tool/libguestfs-test-tool.pod:3
54 #: ../tools/virt-list-filesystems.pl:30 ../tools/virt-list-partitions.pl:30
55 #: ../tools/virt-make-fs.pl:35 ../tools/virt-tar.pl:31
56 #: ../tools/virt-win-reg.pl:35
61 #: ../cat/virt-cat.pod:5 ../libguestfs-1.11.19/cat/virt-cat.pod:5
62 msgid "virt-cat - Display files in a virtual machine"
66 #: ../cat/virt-cat.pod:7 ../cat/virt-filesystems.pod:7 ../cat/virt-ls.pod:7
67 #: ../df/virt-df.pod:7 ../edit/virt-edit.pod:7
68 #: ../examples/guestfs-examples.pod:7 ../fish/guestfish.pod:7
69 #: ../fish/virt-copy-in.pod:7 ../fish/virt-copy-out.pod:7
70 #: ../fish/virt-tar-in.pod:7 ../fish/virt-tar-out.pod:7
71 #: ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pod:7
72 #: ../libguestfs-1.11.19/cat/virt-cat.pod:7
73 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:7
74 #: ../libguestfs-1.11.19/cat/virt-ls.pod:7
75 #: ../libguestfs-1.11.19/df/virt-df.pod:7
76 #: ../libguestfs-1.11.19/edit/virt-edit.pod:7
77 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:7
78 #: ../libguestfs-1.11.19/fish/guestfish.pod:7
79 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:7
80 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:7
81 #: ../libguestfs-1.11.19/fish/virt-tar-in.pod:7
82 #: ../libguestfs-1.11.19/fish/virt-tar-out.pod:7
83 #: ../libguestfs-1.11.19/fuse/guestmount.pod:7
84 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:7
85 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:7
86 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:7
87 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:7
88 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:7
89 #: ../libguestfs-1.11.19/resize/virt-resize.pod:7
90 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:7
91 #: ../libguestfs-1.11.19/src/guestfs.pod:7
92 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:7
93 #: ../ocaml/examples/guestfs-ocaml.pod:7 ../perl/examples/guestfs-perl.pod:7
94 #: ../python/examples/guestfs-python.pod:7 ../rescue/virt-rescue.pod:7
95 #: ../resize/virt-resize.pod:7 ../ruby/examples/guestfs-ruby.pod:7
96 #: ../src/guestfs.pod:7 ../test-tool/libguestfs-test-tool.pod:7
97 #: ../tools/virt-list-filesystems.pl:34 ../tools/virt-list-partitions.pl:34
98 #: ../tools/virt-make-fs.pl:39 ../tools/virt-tar.pl:35
99 #: ../tools/virt-win-reg.pl:39
104 #: ../cat/virt-cat.pod:9 ../libguestfs-1.11.19/cat/virt-cat.pod:9
107 " virt-cat [--options] -d domname file [file ...]\n"
112 #: ../cat/virt-cat.pod:11 ../libguestfs-1.11.19/cat/virt-cat.pod:11
115 " virt-cat [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
120 #: ../cat/virt-cat.pod:13 ../edit/virt-edit.pod:15
121 #: ../inspector/virt-inspector.pod:13
122 #: ../libguestfs-1.11.19/cat/virt-cat.pod:13
123 #: ../libguestfs-1.11.19/edit/virt-edit.pod:15
124 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:13
129 #: ../cat/virt-cat.pod:15 ../libguestfs-1.11.19/cat/virt-cat.pod:15
132 " virt-cat domname file\n"
137 #: ../cat/virt-cat.pod:17 ../libguestfs-1.11.19/cat/virt-cat.pod:17
140 " virt-cat disk.img file\n"
145 #: ../cat/virt-cat.pod:19 ../cat/virt-filesystems.pod:13 ../cat/virt-ls.pod:19
146 #: ../df/virt-df.pod:21 ../edit/virt-edit.pod:27
147 #: ../examples/guestfs-examples.pod:19 ../examples/guestfs-recipes.pod:18
148 #: ../fish/guestfish.pod:30 ../fish/virt-copy-in.pod:19
149 #: ../fish/virt-copy-out.pod:13 ../fish/virt-tar-in.pod:21
150 #: ../fish/virt-tar-out.pod:15 ../fuse/guestmount.pod:20
151 #: ../inspector/virt-inspector.pod:19
152 #: ../libguestfs-1.11.19/cat/virt-cat.pod:19
153 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:13
154 #: ../libguestfs-1.11.19/cat/virt-ls.pod:19
155 #: ../libguestfs-1.11.19/df/virt-df.pod:21
156 #: ../libguestfs-1.11.19/edit/virt-edit.pod:27
157 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:19
158 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:18
159 #: ../libguestfs-1.11.19/fish/guestfish.pod:30
160 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:19
161 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:13
162 #: ../libguestfs-1.11.19/fish/virt-tar-in.pod:21
163 #: ../libguestfs-1.11.19/fish/virt-tar-out.pod:15
164 #: ../libguestfs-1.11.19/fuse/guestmount.pod:20
165 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:19
166 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:25
167 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:18
168 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:14
169 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:29
170 #: ../libguestfs-1.11.19/resize/virt-resize.pod:13
171 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:15
172 #: ../libguestfs-1.11.19/src/guestfs.pod:23
173 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:11
174 #: ../ocaml/examples/guestfs-ocaml.pod:25 ../perl/examples/guestfs-perl.pod:18
175 #: ../python/examples/guestfs-python.pod:14 ../rescue/virt-rescue.pod:29
176 #: ../resize/virt-resize.pod:13 ../ruby/examples/guestfs-ruby.pod:15
177 #: ../src/guestfs.pod:23 ../test-tool/libguestfs-test-tool.pod:11
178 #: ../tools/virt-list-filesystems.pl:40 ../tools/virt-list-partitions.pl:40
179 #: ../tools/virt-make-fs.pl:47 ../tools/virt-tar.pl:77
180 #: ../tools/virt-win-reg.pl:63
185 #: ../cat/virt-cat.pod:21 ../libguestfs-1.11.19/cat/virt-cat.pod:21
187 "C<virt-cat> is a command line tool to display the contents of C<file> where "
188 "C<file> exists in the named virtual machine (or disk image)."
192 #: ../cat/virt-cat.pod:24 ../libguestfs-1.11.19/cat/virt-cat.pod:24
194 "Multiple filenames can be given, in which case they are concatenated "
195 "together. Each filename must be a full path, starting at the root directory "
196 "(starting with '/')."
200 #: ../cat/virt-cat.pod:28 ../libguestfs-1.11.19/cat/virt-cat.pod:28
202 "C<virt-cat> can be used to quickly view a file. To edit a file, use C<virt-"
203 "edit>. For more complex cases you should look at the L<guestfish(1)> tool "
204 "(see L</USING GUESTFISH> below)."
208 #: ../cat/virt-cat.pod:32 ../cat/virt-ls.pod:35 ../df/virt-df.pod:43
209 #: ../edit/virt-edit.pod:44 ../fish/guestfish.pod:41
210 #: ../fish/guestfish.pod:1007 ../fish/virt-copy-in.pod:29
211 #: ../fish/virt-copy-out.pod:21 ../fish/virt-tar-in.pod:30
212 #: ../fish/virt-tar-out.pod:24 ../fuse/guestmount.pod:39
213 #: ../libguestfs-1.11.19/cat/virt-cat.pod:32
214 #: ../libguestfs-1.11.19/cat/virt-ls.pod:35
215 #: ../libguestfs-1.11.19/df/virt-df.pod:43
216 #: ../libguestfs-1.11.19/edit/virt-edit.pod:44
217 #: ../libguestfs-1.11.19/fish/guestfish.pod:41
218 #: ../libguestfs-1.11.19/fish/guestfish.pod:1007
219 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:29
220 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:21
221 #: ../libguestfs-1.11.19/fish/virt-tar-in.pod:30
222 #: ../libguestfs-1.11.19/fish/virt-tar-out.pod:24
223 #: ../libguestfs-1.11.19/fuse/guestmount.pod:39
224 #: ../libguestfs-1.11.19/resize/virt-resize.pod:27
225 #: ../resize/virt-resize.pod:27 ../tools/virt-tar.pl:50
230 #: ../cat/virt-cat.pod:34 ../libguestfs-1.11.19/cat/virt-cat.pod:34
232 "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
236 #: ../cat/virt-cat.pod:37 ../libguestfs-1.11.19/cat/virt-cat.pod:37
239 " virt-cat -d mydomain /etc/fstab\n"
244 #: ../cat/virt-cat.pod:39 ../libguestfs-1.11.19/cat/virt-cat.pod:39
245 msgid "List syslog messages from a VM disk image file:"
249 #: ../cat/virt-cat.pod:41 ../libguestfs-1.11.19/cat/virt-cat.pod:41
252 " virt-cat -a disk.img /var/log/messages | tail\n"
257 #: ../cat/virt-cat.pod:43 ../libguestfs-1.11.19/cat/virt-cat.pod:43
258 msgid "Find out what DHCP IP address a VM acquired:"
262 #: ../cat/virt-cat.pod:45 ../libguestfs-1.11.19/cat/virt-cat.pod:45
265 " virt-cat -d mydomain /var/log/messages | \\\n"
266 " grep 'dhclient: bound to' | tail\n"
271 #: ../cat/virt-cat.pod:48 ../libguestfs-1.11.19/cat/virt-cat.pod:48
272 msgid "Find out what packages were recently installed:"
276 #: ../cat/virt-cat.pod:50 ../libguestfs-1.11.19/cat/virt-cat.pod:50
279 " virt-cat -d mydomain /var/log/yum.log | tail\n"
284 #: ../cat/virt-cat.pod:52 ../libguestfs-1.11.19/cat/virt-cat.pod:52
285 msgid "Find out who is logged on inside a virtual machine:"
289 #: ../cat/virt-cat.pod:54 ../libguestfs-1.11.19/cat/virt-cat.pod:54
292 " virt-cat -d mydomain /var/run/utmp > /tmp/utmp\n"
298 #: ../cat/virt-cat.pod:57 ../libguestfs-1.11.19/cat/virt-cat.pod:57
299 msgid "or who was logged on:"
303 #: ../cat/virt-cat.pod:59 ../libguestfs-1.11.19/cat/virt-cat.pod:59
306 " virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp\n"
307 " last -f /tmp/wtmp\n"
312 #: ../cat/virt-cat.pod:62 ../cat/virt-filesystems.pod:91
313 #: ../cat/virt-ls.pod:261 ../df/virt-df.pod:59 ../edit/virt-edit.pod:62
314 #: ../fish/guestfish.pod:148 ../fish/virt-copy-in.pod:45
315 #: ../fish/virt-copy-out.pod:34 ../fish/virt-tar-in.pod:42
316 #: ../fish/virt-tar-out.pod:36 ../fuse/guestmount.pod:83
317 #: ../inspector/virt-inspector.pod:55
318 #: ../libguestfs-1.11.19/cat/virt-cat.pod:62
319 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:91
320 #: ../libguestfs-1.11.19/cat/virt-ls.pod:261
321 #: ../libguestfs-1.11.19/df/virt-df.pod:59
322 #: ../libguestfs-1.11.19/edit/virt-edit.pod:62
323 #: ../libguestfs-1.11.19/fish/guestfish.pod:148
324 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:45
325 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:34
326 #: ../libguestfs-1.11.19/fish/virt-tar-in.pod:42
327 #: ../libguestfs-1.11.19/fish/virt-tar-out.pod:36
328 #: ../libguestfs-1.11.19/fuse/guestmount.pod:83
329 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:55
330 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:84
331 #: ../libguestfs-1.11.19/resize/virt-resize.pod:241
332 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:37
333 #: ../rescue/virt-rescue.pod:84 ../resize/virt-resize.pod:241
334 #: ../test-tool/libguestfs-test-tool.pod:37
335 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-list-partitions.pl:54
336 #: ../tools/virt-make-fs.pl:153 ../tools/virt-tar.pl:103
337 #: ../tools/virt-win-reg.pl:96
342 #: ../cat/virt-cat.pod:66 ../cat/virt-filesystems.pod:95
343 #: ../cat/virt-ls.pod:265 ../df/virt-df.pod:63 ../edit/virt-edit.pod:66
344 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:151
345 #: ../inspector/virt-inspector.pod:59
346 #: ../libguestfs-1.11.19/cat/virt-cat.pod:66
347 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:95
348 #: ../libguestfs-1.11.19/cat/virt-ls.pod:265
349 #: ../libguestfs-1.11.19/df/virt-df.pod:63
350 #: ../libguestfs-1.11.19/edit/virt-edit.pod:66
351 #: ../libguestfs-1.11.19/fish/guestfish.pod:152
352 #: ../libguestfs-1.11.19/fuse/guestmount.pod:151
353 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:59
354 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:88
355 #: ../libguestfs-1.11.19/resize/virt-resize.pod:245
356 #: ../rescue/virt-rescue.pod:88 ../resize/virt-resize.pod:245
357 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-list-partitions.pl:62
358 #: ../tools/virt-make-fs.pl:161 ../tools/virt-tar.pl:111
359 #: ../tools/virt-win-reg.pl:104
364 #: ../cat/virt-cat.pod:68 ../cat/virt-filesystems.pod:97
365 #: ../cat/virt-ls.pod:267 ../df/virt-df.pod:65 ../edit/virt-edit.pod:68
366 #: ../inspector/virt-inspector.pod:61
367 #: ../libguestfs-1.11.19/cat/virt-cat.pod:68
368 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:97
369 #: ../libguestfs-1.11.19/cat/virt-ls.pod:267
370 #: ../libguestfs-1.11.19/df/virt-df.pod:65
371 #: ../libguestfs-1.11.19/edit/virt-edit.pod:68
372 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:61
373 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:90
374 #: ../rescue/virt-rescue.pod:90 ../tools/virt-list-filesystems.pl:63
375 #: ../tools/virt-list-partitions.pl:64 ../tools/virt-make-fs.pl:163
376 #: ../tools/virt-tar.pl:113 ../tools/virt-win-reg.pl:106
377 msgid "Display brief help."
381 #: ../cat/virt-cat.pod:70 ../cat/virt-filesystems.pod:99
382 #: ../cat/virt-ls.pod:269 ../df/virt-df.pod:67 ../edit/virt-edit.pod:70
383 #: ../inspector/virt-inspector.pod:63
384 #: ../libguestfs-1.11.19/cat/virt-cat.pod:70
385 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:99
386 #: ../libguestfs-1.11.19/cat/virt-ls.pod:269
387 #: ../libguestfs-1.11.19/df/virt-df.pod:67
388 #: ../libguestfs-1.11.19/edit/virt-edit.pod:70
389 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:63
390 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:92
391 #: ../rescue/virt-rescue.pod:92
396 #: ../cat/virt-cat.pod:72 ../cat/virt-filesystems.pod:101
397 #: ../cat/virt-ls.pod:271 ../df/virt-df.pod:69 ../edit/virt-edit.pod:72
398 #: ../inspector/virt-inspector.pod:65
399 #: ../libguestfs-1.11.19/cat/virt-cat.pod:72
400 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:101
401 #: ../libguestfs-1.11.19/cat/virt-ls.pod:271
402 #: ../libguestfs-1.11.19/df/virt-df.pod:69
403 #: ../libguestfs-1.11.19/edit/virt-edit.pod:72
404 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:65
405 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:94
406 #: ../rescue/virt-rescue.pod:94
407 msgid "B<--add> file"
411 #: ../cat/virt-cat.pod:74 ../cat/virt-filesystems.pod:103
412 #: ../cat/virt-ls.pod:273 ../df/virt-df.pod:71 ../edit/virt-edit.pod:74
413 #: ../inspector/virt-inspector.pod:67
414 #: ../libguestfs-1.11.19/cat/virt-cat.pod:74
415 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:103
416 #: ../libguestfs-1.11.19/cat/virt-ls.pod:273
417 #: ../libguestfs-1.11.19/df/virt-df.pod:71
418 #: ../libguestfs-1.11.19/edit/virt-edit.pod:74
419 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:67
420 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:96
421 #: ../rescue/virt-rescue.pod:96
423 "Add I<file> which should be a disk image from a virtual machine. If the "
424 "virtual machine has multiple block devices, you must supply all of them with "
425 "separate I<-a> options."
429 #: ../cat/virt-cat.pod:78 ../cat/virt-filesystems.pod:107
430 #: ../cat/virt-ls.pod:277 ../df/virt-df.pod:75 ../edit/virt-edit.pod:78
431 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:93
432 #: ../inspector/virt-inspector.pod:71
433 #: ../libguestfs-1.11.19/cat/virt-cat.pod:78
434 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:107
435 #: ../libguestfs-1.11.19/cat/virt-ls.pod:277
436 #: ../libguestfs-1.11.19/df/virt-df.pod:75
437 #: ../libguestfs-1.11.19/edit/virt-edit.pod:78
438 #: ../libguestfs-1.11.19/fish/guestfish.pod:174
439 #: ../libguestfs-1.11.19/fuse/guestmount.pod:93
440 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:71
441 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:100
442 #: ../rescue/virt-rescue.pod:100
444 "The format of the disk image is auto-detected. To override this and force a "
445 "particular format use the I<--format=..> option."
449 #: ../cat/virt-cat.pod:81 ../cat/virt-filesystems.pod:125
450 #: ../cat/virt-ls.pod:291 ../df/virt-df.pod:78
451 #: ../libguestfs-1.11.19/cat/virt-cat.pod:81
452 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:125
453 #: ../libguestfs-1.11.19/cat/virt-ls.pod:291
454 #: ../libguestfs-1.11.19/df/virt-df.pod:78
455 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:107
456 #: ../rescue/virt-rescue.pod:107
461 #: ../cat/virt-cat.pod:83 ../cat/virt-filesystems.pod:127
462 #: ../cat/virt-ls.pod:293 ../df/virt-df.pod:80
463 #: ../libguestfs-1.11.19/cat/virt-cat.pod:83
464 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:127
465 #: ../libguestfs-1.11.19/cat/virt-ls.pod:293
466 #: ../libguestfs-1.11.19/df/virt-df.pod:80
467 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:109
468 #: ../rescue/virt-rescue.pod:109
469 msgid "B<--connect> URI"
473 #: ../cat/virt-cat.pod:85 ../cat/virt-filesystems.pod:129
474 #: ../cat/virt-ls.pod:295 ../df/virt-df.pod:82 ../edit/virt-edit.pod:99
475 #: ../inspector/virt-inspector.pod:78
476 #: ../libguestfs-1.11.19/cat/virt-cat.pod:85
477 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:129
478 #: ../libguestfs-1.11.19/cat/virt-ls.pod:295
479 #: ../libguestfs-1.11.19/df/virt-df.pod:82
480 #: ../libguestfs-1.11.19/edit/virt-edit.pod:99
481 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:78
482 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:111
483 #: ../rescue/virt-rescue.pod:111 ../tools/virt-list-filesystems.pl:81
484 #: ../tools/virt-list-partitions.pl:82 ../tools/virt-tar.pl:131
485 #: ../tools/virt-win-reg.pl:132
487 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
488 "to the default libvirt hypervisor."
492 #: ../cat/virt-cat.pod:88 ../cat/virt-filesystems.pod:132
493 #: ../cat/virt-ls.pod:298 ../df/virt-df.pod:85
494 #: ../libguestfs-1.11.19/cat/virt-cat.pod:88
495 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:132
496 #: ../libguestfs-1.11.19/cat/virt-ls.pod:298
497 #: ../libguestfs-1.11.19/df/virt-df.pod:85
498 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:114
499 #: ../rescue/virt-rescue.pod:114
501 "If you specify guest block devices directly (I<-a>), then libvirt is not "
506 #: ../cat/virt-cat.pod:91 ../cat/virt-filesystems.pod:141
507 #: ../cat/virt-ls.pod:307 ../df/virt-df.pod:88 ../edit/virt-edit.pod:105
508 #: ../inspector/virt-inspector.pod:85
509 #: ../libguestfs-1.11.19/cat/virt-cat.pod:91
510 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:141
511 #: ../libguestfs-1.11.19/cat/virt-ls.pod:307
512 #: ../libguestfs-1.11.19/df/virt-df.pod:88
513 #: ../libguestfs-1.11.19/edit/virt-edit.pod:105
514 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:85
515 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:117
516 #: ../rescue/virt-rescue.pod:117
521 #: ../cat/virt-cat.pod:93 ../cat/virt-filesystems.pod:143
522 #: ../cat/virt-ls.pod:309 ../df/virt-df.pod:90 ../edit/virt-edit.pod:107
523 #: ../inspector/virt-inspector.pod:87
524 #: ../libguestfs-1.11.19/cat/virt-cat.pod:93
525 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:143
526 #: ../libguestfs-1.11.19/cat/virt-ls.pod:309
527 #: ../libguestfs-1.11.19/df/virt-df.pod:90
528 #: ../libguestfs-1.11.19/edit/virt-edit.pod:107
529 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:87
530 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:119
531 #: ../rescue/virt-rescue.pod:119
532 msgid "B<--domain> guest"
536 #: ../cat/virt-cat.pod:95 ../cat/virt-filesystems.pod:145
537 #: ../cat/virt-ls.pod:311 ../df/virt-df.pod:92 ../edit/virt-edit.pod:109
538 #: ../inspector/virt-inspector.pod:89
539 #: ../libguestfs-1.11.19/cat/virt-cat.pod:95
540 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:145
541 #: ../libguestfs-1.11.19/cat/virt-ls.pod:311
542 #: ../libguestfs-1.11.19/df/virt-df.pod:92
543 #: ../libguestfs-1.11.19/edit/virt-edit.pod:109
544 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:89
545 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:121
546 #: ../rescue/virt-rescue.pod:121
548 "Add all the disks from the named libvirt guest. Domain UUIDs can be used "
553 #: ../cat/virt-cat.pod:98 ../cat/virt-filesystems.pod:148
554 #: ../cat/virt-ls.pod:314 ../edit/virt-edit.pod:112 ../fish/guestfish.pod:217
555 #: ../fuse/guestmount.pod:126 ../inspector/virt-inspector.pod:92
556 #: ../libguestfs-1.11.19/cat/virt-cat.pod:98
557 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:148
558 #: ../libguestfs-1.11.19/cat/virt-ls.pod:314
559 #: ../libguestfs-1.11.19/edit/virt-edit.pod:112
560 #: ../libguestfs-1.11.19/fish/guestfish.pod:217
561 #: ../libguestfs-1.11.19/fuse/guestmount.pod:126
562 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:92
563 msgid "B<--echo-keys>"
567 #: ../cat/virt-cat.pod:100 ../libguestfs-1.11.19/cat/virt-cat.pod:100
569 "When prompting for keys and passphrases, virt-cat normally turns echoing off "
570 "so you cannot see what you are typing. If you are not worried about Tempest "
571 "attacks and there is no one else in the room you can specify this flag to "
572 "see what you are typing."
576 #: ../cat/virt-cat.pod:105 ../cat/virt-filesystems.pod:170
577 #: ../cat/virt-ls.pod:328 ../df/virt-df.pod:95 ../fish/guestfish.pod:233
578 #: ../fuse/guestmount.pod:133 ../inspector/virt-inspector.pod:99
579 #: ../libguestfs-1.11.19/cat/virt-cat.pod:105
580 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:170
581 #: ../libguestfs-1.11.19/cat/virt-ls.pod:328
582 #: ../libguestfs-1.11.19/df/virt-df.pod:95
583 #: ../libguestfs-1.11.19/fish/guestfish.pod:233
584 #: ../libguestfs-1.11.19/fuse/guestmount.pod:133
585 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:99
586 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:124
587 #: ../rescue/virt-rescue.pod:124
588 msgid "B<--format=raw|qcow2|..>"
592 #: ../cat/virt-cat.pod:107 ../cat/virt-filesystems.pod:172
593 #: ../cat/virt-ls.pod:330 ../df/virt-df.pod:97 ../edit/virt-edit.pod:134
594 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:135
595 #: ../inspector/virt-inspector.pod:101
596 #: ../libguestfs-1.11.19/cat/virt-cat.pod:107
597 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:172
598 #: ../libguestfs-1.11.19/cat/virt-ls.pod:330
599 #: ../libguestfs-1.11.19/df/virt-df.pod:97
600 #: ../libguestfs-1.11.19/edit/virt-edit.pod:134
601 #: ../libguestfs-1.11.19/fish/guestfish.pod:235
602 #: ../libguestfs-1.11.19/fuse/guestmount.pod:135
603 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:101
604 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:126
605 #: ../rescue/virt-rescue.pod:126
610 #: ../cat/virt-cat.pod:109 ../cat/virt-filesystems.pod:174
611 #: ../cat/virt-ls.pod:332 ../df/virt-df.pod:99 ../edit/virt-edit.pod:136
612 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:137
613 #: ../libguestfs-1.11.19/cat/virt-cat.pod:109
614 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:174
615 #: ../libguestfs-1.11.19/cat/virt-ls.pod:332
616 #: ../libguestfs-1.11.19/df/virt-df.pod:99
617 #: ../libguestfs-1.11.19/edit/virt-edit.pod:136
618 #: ../libguestfs-1.11.19/fish/guestfish.pod:237
619 #: ../libguestfs-1.11.19/fuse/guestmount.pod:137
620 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:128
621 #: ../rescue/virt-rescue.pod:128
623 "The default for the I<-a> option is to auto-detect the format of the disk "
624 "image. Using this forces the disk format for I<-a> options which follow on "
625 "the command line. Using I<--format> with no argument switches back to auto-"
626 "detection for subsequent I<-a> options."
630 #: ../cat/virt-cat.pod:114 ../cat/virt-filesystems.pod:179
631 #: ../cat/virt-ls.pod:337 ../df/virt-df.pod:104 ../edit/virt-edit.pod:141
632 #: ../fish/guestfish.pod:242 ../fish/guestfish.pod:673
633 #: ../inspector/virt-inspector.pod:335
634 #: ../libguestfs-1.11.19/cat/virt-cat.pod:114
635 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:179
636 #: ../libguestfs-1.11.19/cat/virt-ls.pod:337
637 #: ../libguestfs-1.11.19/df/virt-df.pod:104
638 #: ../libguestfs-1.11.19/edit/virt-edit.pod:141
639 #: ../libguestfs-1.11.19/fish/guestfish.pod:242
640 #: ../libguestfs-1.11.19/fish/guestfish.pod:673
641 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:335
642 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:133
643 #: ../libguestfs-1.11.19/src/guestfs.pod:2652 ../rescue/virt-rescue.pod:133
644 #: ../src/guestfs.pod:2652
649 #: ../cat/virt-cat.pod:116 ../libguestfs-1.11.19/cat/virt-cat.pod:116
652 " virt-cat --format=raw -a disk.img file\n"
657 #: ../cat/virt-cat.pod:118 ../cat/virt-filesystems.pod:183
658 #: ../cat/virt-ls.pod:341 ../df/virt-df.pod:108 ../edit/virt-edit.pod:145
659 #: ../fish/guestfish.pod:246 ../libguestfs-1.11.19/cat/virt-cat.pod:118
660 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:183
661 #: ../libguestfs-1.11.19/cat/virt-ls.pod:341
662 #: ../libguestfs-1.11.19/df/virt-df.pod:108
663 #: ../libguestfs-1.11.19/edit/virt-edit.pod:145
664 #: ../libguestfs-1.11.19/fish/guestfish.pod:246
665 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:137
666 #: ../rescue/virt-rescue.pod:137
667 msgid "forces raw format (no auto-detection) for C<disk.img>."
671 #: ../cat/virt-cat.pod:120 ../libguestfs-1.11.19/cat/virt-cat.pod:120
674 " virt-cat --format=raw -a disk.img --format -a another.img file\n"
679 #: ../cat/virt-cat.pod:122 ../cat/virt-filesystems.pod:187
680 #: ../cat/virt-ls.pod:345 ../df/virt-df.pod:112 ../edit/virt-edit.pod:149
681 #: ../fish/guestfish.pod:250 ../libguestfs-1.11.19/cat/virt-cat.pod:122
682 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:187
683 #: ../libguestfs-1.11.19/cat/virt-ls.pod:345
684 #: ../libguestfs-1.11.19/df/virt-df.pod:112
685 #: ../libguestfs-1.11.19/edit/virt-edit.pod:149
686 #: ../libguestfs-1.11.19/fish/guestfish.pod:250
687 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:141
688 #: ../rescue/virt-rescue.pod:141
690 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
691 "detection for C<another.img>."
695 #: ../cat/virt-cat.pod:125 ../cat/virt-filesystems.pod:190
696 #: ../cat/virt-ls.pod:348 ../df/virt-df.pod:115 ../edit/virt-edit.pod:152
697 #: ../libguestfs-1.11.19/cat/virt-cat.pod:125
698 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:190
699 #: ../libguestfs-1.11.19/cat/virt-ls.pod:348
700 #: ../libguestfs-1.11.19/df/virt-df.pod:115
701 #: ../libguestfs-1.11.19/edit/virt-edit.pod:152
702 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:144
703 #: ../rescue/virt-rescue.pod:144
705 "If you have untrusted raw-format guest disk images, you should use this "
706 "option to specify the disk format. This avoids a possible security problem "
707 "with malicious guests (CVE-2010-3851)."
711 #: ../cat/virt-cat.pod:129 ../cat/virt-filesystems.pod:200
712 #: ../cat/virt-ls.pod:361 ../edit/virt-edit.pod:156 ../fish/guestfish.pod:289
713 #: ../fuse/guestmount.pod:163 ../inspector/virt-inspector.pod:114
714 #: ../libguestfs-1.11.19/cat/virt-cat.pod:129
715 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:200
716 #: ../libguestfs-1.11.19/cat/virt-ls.pod:361
717 #: ../libguestfs-1.11.19/edit/virt-edit.pod:156
718 #: ../libguestfs-1.11.19/fish/guestfish.pod:289
719 #: ../libguestfs-1.11.19/fuse/guestmount.pod:163
720 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:114
721 msgid "B<--keys-from-stdin>"
725 #: ../cat/virt-cat.pod:131 ../cat/virt-filesystems.pod:202
726 #: ../cat/virt-ls.pod:363 ../edit/virt-edit.pod:158 ../fish/guestfish.pod:291
727 #: ../fuse/guestmount.pod:165 ../inspector/virt-inspector.pod:116
728 #: ../libguestfs-1.11.19/cat/virt-cat.pod:131
729 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:202
730 #: ../libguestfs-1.11.19/cat/virt-ls.pod:363
731 #: ../libguestfs-1.11.19/edit/virt-edit.pod:158
732 #: ../libguestfs-1.11.19/fish/guestfish.pod:291
733 #: ../libguestfs-1.11.19/fuse/guestmount.pod:165
734 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:116
736 "Read key or passphrase parameters from stdin. The default is to try to read "
737 "passphrases from the user by opening C</dev/tty>."
741 #: ../cat/virt-cat.pod:134 ../cat/virt-filesystems.pod:261
742 #: ../cat/virt-ls.pod:425 ../df/virt-df.pod:167 ../edit/virt-edit.pod:161
743 #: ../fish/guestfish.pod:390 ../fuse/guestmount.pod:257
744 #: ../inspector/virt-inspector.pod:119
745 #: ../libguestfs-1.11.19/cat/virt-cat.pod:134
746 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:261
747 #: ../libguestfs-1.11.19/cat/virt-ls.pod:425
748 #: ../libguestfs-1.11.19/df/virt-df.pod:167
749 #: ../libguestfs-1.11.19/edit/virt-edit.pod:161
750 #: ../libguestfs-1.11.19/fish/guestfish.pod:390
751 #: ../libguestfs-1.11.19/fuse/guestmount.pod:257
752 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:119
753 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:178
754 #: ../rescue/virt-rescue.pod:178
759 #: ../cat/virt-cat.pod:136 ../cat/virt-filesystems.pod:263
760 #: ../cat/virt-ls.pod:427 ../df/virt-df.pod:169 ../edit/virt-edit.pod:163
761 #: ../fish/guestfish.pod:392 ../fuse/guestmount.pod:259
762 #: ../inspector/virt-inspector.pod:121
763 #: ../libguestfs-1.11.19/cat/virt-cat.pod:136
764 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:263
765 #: ../libguestfs-1.11.19/cat/virt-ls.pod:427
766 #: ../libguestfs-1.11.19/df/virt-df.pod:169
767 #: ../libguestfs-1.11.19/edit/virt-edit.pod:163
768 #: ../libguestfs-1.11.19/fish/guestfish.pod:392
769 #: ../libguestfs-1.11.19/fuse/guestmount.pod:259
770 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:121
771 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:180
772 #: ../rescue/virt-rescue.pod:180
777 #: ../cat/virt-cat.pod:138 ../cat/virt-filesystems.pod:265
778 #: ../cat/virt-ls.pod:429 ../df/virt-df.pod:171 ../edit/virt-edit.pod:165
779 #: ../inspector/virt-inspector.pod:123
780 #: ../libguestfs-1.11.19/cat/virt-cat.pod:138
781 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:265
782 #: ../libguestfs-1.11.19/cat/virt-ls.pod:429
783 #: ../libguestfs-1.11.19/df/virt-df.pod:171
784 #: ../libguestfs-1.11.19/edit/virt-edit.pod:165
785 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:123
786 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:182
787 #: ../rescue/virt-rescue.pod:182
788 msgid "Enable verbose messages for debugging."
792 #: ../cat/virt-cat.pod:140 ../cat/virt-filesystems.pod:267
793 #: ../cat/virt-ls.pod:431 ../df/virt-df.pod:173 ../edit/virt-edit.pod:167
794 #: ../fish/guestfish.pod:397 ../fuse/guestmount.pod:263
795 #: ../inspector/virt-inspector.pod:125
796 #: ../libguestfs-1.11.19/cat/virt-cat.pod:140
797 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:267
798 #: ../libguestfs-1.11.19/cat/virt-ls.pod:431
799 #: ../libguestfs-1.11.19/df/virt-df.pod:173
800 #: ../libguestfs-1.11.19/edit/virt-edit.pod:167
801 #: ../libguestfs-1.11.19/fish/guestfish.pod:397
802 #: ../libguestfs-1.11.19/fuse/guestmount.pod:263
803 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:125
804 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:184
805 #: ../libguestfs-1.11.19/resize/virt-resize.pod:478
806 #: ../rescue/virt-rescue.pod:184 ../resize/virt-resize.pod:478
811 #: ../cat/virt-cat.pod:142 ../cat/virt-filesystems.pod:269
812 #: ../cat/virt-ls.pod:433 ../df/virt-df.pod:175 ../edit/virt-edit.pod:169
813 #: ../fish/guestfish.pod:399 ../fuse/guestmount.pod:265
814 #: ../inspector/virt-inspector.pod:127
815 #: ../libguestfs-1.11.19/cat/virt-cat.pod:142
816 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:269
817 #: ../libguestfs-1.11.19/cat/virt-ls.pod:433
818 #: ../libguestfs-1.11.19/df/virt-df.pod:175
819 #: ../libguestfs-1.11.19/edit/virt-edit.pod:169
820 #: ../libguestfs-1.11.19/fish/guestfish.pod:399
821 #: ../libguestfs-1.11.19/fuse/guestmount.pod:265
822 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:127
823 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:186
824 #: ../libguestfs-1.11.19/resize/virt-resize.pod:480
825 #: ../rescue/virt-rescue.pod:186 ../resize/virt-resize.pod:480
826 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-list-partitions.pl:70
827 #: ../tools/virt-make-fs.pl:169 ../tools/virt-tar.pl:119
828 #: ../tools/virt-win-reg.pl:112
833 #: ../cat/virt-cat.pod:144 ../cat/virt-filesystems.pod:271
834 #: ../cat/virt-ls.pod:435 ../df/virt-df.pod:177 ../edit/virt-edit.pod:171
835 #: ../inspector/virt-inspector.pod:129
836 #: ../libguestfs-1.11.19/cat/virt-cat.pod:144
837 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:271
838 #: ../libguestfs-1.11.19/cat/virt-ls.pod:435
839 #: ../libguestfs-1.11.19/df/virt-df.pod:177
840 #: ../libguestfs-1.11.19/edit/virt-edit.pod:171
841 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:129
842 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:188
843 #: ../libguestfs-1.11.19/resize/virt-resize.pod:482
844 #: ../rescue/virt-rescue.pod:188 ../resize/virt-resize.pod:482
845 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-list-partitions.pl:72
846 #: ../tools/virt-make-fs.pl:171 ../tools/virt-tar.pl:121
847 #: ../tools/virt-win-reg.pl:114
848 msgid "Display version number and exit."
852 #: ../cat/virt-cat.pod:146 ../cat/virt-filesystems.pod:281
853 #: ../cat/virt-ls.pod:437 ../df/virt-df.pod:179 ../edit/virt-edit.pod:173
854 #: ../fish/guestfish.pod:412 ../fuse/guestmount.pod:278
855 #: ../inspector/virt-inspector.pod:131
856 #: ../libguestfs-1.11.19/cat/virt-cat.pod:146
857 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:281
858 #: ../libguestfs-1.11.19/cat/virt-ls.pod:437
859 #: ../libguestfs-1.11.19/df/virt-df.pod:179
860 #: ../libguestfs-1.11.19/edit/virt-edit.pod:173
861 #: ../libguestfs-1.11.19/fish/guestfish.pod:412
862 #: ../libguestfs-1.11.19/fuse/guestmount.pod:278
863 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:131
864 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:199
865 #: ../rescue/virt-rescue.pod:199 ../tools/virt-tar.pl:158
870 #: ../cat/virt-cat.pod:148 ../cat/virt-filesystems.pod:283
871 #: ../cat/virt-ls.pod:439 ../df/virt-df.pod:181 ../edit/virt-edit.pod:175
872 #: ../inspector/virt-inspector.pod:133
873 #: ../libguestfs-1.11.19/cat/virt-cat.pod:148
874 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:283
875 #: ../libguestfs-1.11.19/cat/virt-ls.pod:439
876 #: ../libguestfs-1.11.19/df/virt-df.pod:181
877 #: ../libguestfs-1.11.19/edit/virt-edit.pod:175
878 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:133
879 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:201
880 #: ../rescue/virt-rescue.pod:201
881 msgid "Enable tracing of libguestfs API calls."
885 #: ../cat/virt-cat.pod:152 ../cat/virt-ls.pod:443 ../edit/virt-edit.pod:179
886 #: ../inspector/virt-inspector.pod:137
887 #: ../libguestfs-1.11.19/cat/virt-cat.pod:152
888 #: ../libguestfs-1.11.19/cat/virt-ls.pod:443
889 #: ../libguestfs-1.11.19/edit/virt-edit.pod:179
890 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:137
891 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:205
892 #: ../rescue/virt-rescue.pod:205
893 msgid "OLD-STYLE COMMAND LINE ARGUMENTS"
897 #: ../cat/virt-cat.pod:154 ../libguestfs-1.11.19/cat/virt-cat.pod:154
898 msgid "Previous versions of virt-cat allowed you to write either:"
902 #: ../cat/virt-cat.pod:156 ../libguestfs-1.11.19/cat/virt-cat.pod:156
905 " virt-cat disk.img [disk.img ...] file\n"
910 #: ../cat/virt-cat.pod:158 ../cat/virt-ls.pod:449 ../edit/virt-edit.pod:185
911 #: ../inspector/virt-inspector.pod:143
912 #: ../libguestfs-1.11.19/cat/virt-cat.pod:158
913 #: ../libguestfs-1.11.19/cat/virt-ls.pod:449
914 #: ../libguestfs-1.11.19/edit/virt-edit.pod:185
915 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:143
916 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:211
917 #: ../rescue/virt-rescue.pod:211
922 #: ../cat/virt-cat.pod:160 ../libguestfs-1.11.19/cat/virt-cat.pod:160
925 " virt-cat guestname file\n"
930 #: ../cat/virt-cat.pod:162 ../cat/virt-ls.pod:453 ../edit/virt-edit.pod:189
931 #: ../inspector/virt-inspector.pod:147
932 #: ../libguestfs-1.11.19/cat/virt-cat.pod:162
933 #: ../libguestfs-1.11.19/cat/virt-ls.pod:453
934 #: ../libguestfs-1.11.19/edit/virt-edit.pod:189
935 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:147
936 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:215
937 #: ../rescue/virt-rescue.pod:215
939 "whereas in this version you should use I<-a> or I<-d> respectively to avoid "
940 "the confusing case where a disk image might have the same name as a guest."
944 #: ../cat/virt-cat.pod:166 ../cat/virt-ls.pod:457 ../edit/virt-edit.pod:193
945 #: ../inspector/virt-inspector.pod:151
946 #: ../libguestfs-1.11.19/cat/virt-cat.pod:166
947 #: ../libguestfs-1.11.19/cat/virt-ls.pod:457
948 #: ../libguestfs-1.11.19/edit/virt-edit.pod:193
949 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:151
950 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:219
951 #: ../rescue/virt-rescue.pod:219
952 msgid "For compatibility the old style is still supported."
956 #: ../cat/virt-cat.pod:168 ../edit/virt-edit.pod:297
957 #: ../libguestfs-1.11.19/cat/virt-cat.pod:168
958 #: ../libguestfs-1.11.19/edit/virt-edit.pod:297
959 msgid "USING GUESTFISH"
963 #: ../cat/virt-cat.pod:170 ../libguestfs-1.11.19/cat/virt-cat.pod:170
965 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
966 "C<virt-cat> doesn't work."
970 #: ../cat/virt-cat.pod:173 ../libguestfs-1.11.19/cat/virt-cat.pod:173
971 msgid "Using C<virt-cat> is approximately equivalent to doing:"
975 #: ../cat/virt-cat.pod:175 ../libguestfs-1.11.19/cat/virt-cat.pod:175
978 " guestfish --ro -i -d domname download file -\n"
983 #: ../cat/virt-cat.pod:177 ../libguestfs-1.11.19/cat/virt-cat.pod:177
985 "where C<domname> is the name of the libvirt guest, and C<file> is the full "
986 "path to the file. Note the final C<-> (meaning \"output to stdout\")."
990 #: ../cat/virt-cat.pod:181 ../libguestfs-1.11.19/cat/virt-cat.pod:181
992 "The command above uses libguestfs's guest inspection feature and so does not "
993 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
994 "disk images that don't contain guests. To display a file from a disk image "
999 #: ../cat/virt-cat.pod:186 ../libguestfs-1.11.19/cat/virt-cat.pod:186
1002 " guestfish --ro -a disk.img -m /dev/sda1 download file -\n"
1007 #: ../cat/virt-cat.pod:188 ../libguestfs-1.11.19/cat/virt-cat.pod:188
1009 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
1010 "the disk image to edit, and C<file> is the full path to the file."
1014 #: ../cat/virt-cat.pod:192 ../cat/virt-filesystems.pod:365
1015 #: ../cat/virt-ls.pod:483 ../df/virt-df.pod:209 ../edit/virt-edit.pod:342
1016 #: ../inspector/virt-inspector.pod:349
1017 #: ../libguestfs-1.11.19/cat/virt-cat.pod:192
1018 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:365
1019 #: ../libguestfs-1.11.19/cat/virt-ls.pod:483
1020 #: ../libguestfs-1.11.19/df/virt-df.pod:209
1021 #: ../libguestfs-1.11.19/edit/virt-edit.pod:342
1022 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:349
1023 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:262
1024 #: ../libguestfs-1.11.19/resize/virt-resize.pod:543
1025 #: ../rescue/virt-rescue.pod:262 ../resize/virt-resize.pod:543
1026 #: ../tools/virt-list-filesystems.pl:188 ../tools/virt-list-partitions.pl:258
1027 #: ../tools/virt-make-fs.pl:532 ../tools/virt-tar.pl:289
1028 #: ../tools/virt-win-reg.pl:733
1029 msgid "SHELL QUOTING"
1033 #: ../cat/virt-cat.pod:194 ../cat/virt-filesystems.pod:367
1034 #: ../cat/virt-ls.pod:485 ../df/virt-df.pod:211 ../edit/virt-edit.pod:344
1035 #: ../inspector/virt-inspector.pod:351
1036 #: ../libguestfs-1.11.19/cat/virt-cat.pod:194
1037 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:367
1038 #: ../libguestfs-1.11.19/cat/virt-ls.pod:485
1039 #: ../libguestfs-1.11.19/df/virt-df.pod:211
1040 #: ../libguestfs-1.11.19/edit/virt-edit.pod:344
1041 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:351
1042 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:264
1043 #: ../libguestfs-1.11.19/resize/virt-resize.pod:545
1044 #: ../rescue/virt-rescue.pod:264 ../resize/virt-resize.pod:545
1045 #: ../tools/virt-list-filesystems.pl:190 ../tools/virt-list-partitions.pl:260
1046 #: ../tools/virt-make-fs.pl:534 ../tools/virt-tar.pl:291
1047 #: ../tools/virt-win-reg.pl:741
1049 "Libvirt guest names can contain arbitrary characters, some of which have "
1050 "meaning to the shell such as C<#> and space. You may need to quote or "
1051 "escape these characters on the command line. See the shell manual page L<sh"
1056 #: ../cat/virt-cat.pod:199 ../cat/virt-filesystems.pod:372
1057 #: ../cat/virt-ls.pod:490 ../df/virt-df.pod:216 ../edit/virt-edit.pod:349
1058 #: ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384
1059 #: ../fish/guestfish.pod:1214 ../fish/virt-copy-in.pod:50
1060 #: ../fish/virt-copy-out.pod:39 ../fish/virt-tar-in.pod:47
1061 #: ../fish/virt-tar-out.pod:41 ../fuse/guestmount.pod:303
1062 #: ../inspector/virt-inspector.pod:372
1063 #: ../libguestfs-1.11.19/cat/virt-cat.pod:199
1064 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:372
1065 #: ../libguestfs-1.11.19/cat/virt-ls.pod:490
1066 #: ../libguestfs-1.11.19/df/virt-df.pod:216
1067 #: ../libguestfs-1.11.19/edit/virt-edit.pod:349
1068 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:33
1069 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:384
1070 #: ../libguestfs-1.11.19/fish/guestfish.pod:1214
1071 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:50
1072 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:39
1073 #: ../libguestfs-1.11.19/fish/virt-tar-in.pod:47
1074 #: ../libguestfs-1.11.19/fish/virt-tar-out.pod:41
1075 #: ../libguestfs-1.11.19/fuse/guestmount.pod:303
1076 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:372
1077 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:78
1078 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:39
1079 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:42
1080 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:284
1081 #: ../libguestfs-1.11.19/resize/virt-resize.pod:550
1082 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:36
1083 #: ../libguestfs-1.11.19/src/guestfs.pod:3011
1084 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:87
1085 #: ../ocaml/examples/guestfs-ocaml.pod:78 ../perl/examples/guestfs-perl.pod:39
1086 #: ../python/examples/guestfs-python.pod:42 ../rescue/virt-rescue.pod:284
1087 #: ../resize/virt-resize.pod:550 ../ruby/examples/guestfs-ruby.pod:36
1088 #: ../src/guestfs.pod:3011 ../test-tool/libguestfs-test-tool.pod:87
1089 #: ../tools/virt-list-filesystems.pl:195 ../tools/virt-list-partitions.pl:265
1090 #: ../tools/virt-make-fs.pl:539 ../tools/virt-tar.pl:296
1091 #: ../tools/virt-win-reg.pl:746
1096 #: ../cat/virt-cat.pod:201 ../libguestfs-1.11.19/cat/virt-cat.pod:201
1098 "L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, L<virt-"
1099 "tar-out(1)>, L<http://libguestfs.org/>."
1103 #: ../cat/virt-cat.pod:208 ../cat/virt-filesystems.pod:383
1104 #: ../cat/virt-ls.pod:502 ../df/virt-df.pod:224 ../edit/virt-edit.pod:363
1105 #: ../libguestfs-1.11.19/cat/virt-cat.pod:208
1106 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:383
1107 #: ../libguestfs-1.11.19/cat/virt-ls.pod:502
1108 #: ../libguestfs-1.11.19/df/virt-df.pod:224
1109 #: ../libguestfs-1.11.19/edit/virt-edit.pod:363
1110 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:292
1111 #: ../libguestfs-1.11.19/resize/virt-resize.pod:571
1112 #: ../rescue/virt-rescue.pod:292 ../resize/virt-resize.pod:571
1113 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-list-partitions.pl:277
1114 #: ../tools/virt-make-fs.pl:564 ../tools/virt-tar.pl:311
1115 #: ../tools/virt-win-reg.pl:772
1120 #: ../cat/virt-cat.pod:210 ../cat/virt-filesystems.pod:385
1121 #: ../cat/virt-ls.pod:504 ../df/virt-df.pod:226 ../edit/virt-edit.pod:365
1122 #: ../inspector/virt-inspector.pod:386
1123 #: ../libguestfs-1.11.19/cat/virt-cat.pod:210
1124 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:385
1125 #: ../libguestfs-1.11.19/cat/virt-ls.pod:504
1126 #: ../libguestfs-1.11.19/df/virt-df.pod:226
1127 #: ../libguestfs-1.11.19/edit/virt-edit.pod:365
1128 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:386
1129 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:294
1130 #: ../libguestfs-1.11.19/resize/virt-resize.pod:573
1131 #: ../rescue/virt-rescue.pod:294 ../resize/virt-resize.pod:573
1132 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-list-partitions.pl:279
1133 #: ../tools/virt-make-fs.pl:566 ../tools/virt-tar.pl:313
1134 #: ../tools/virt-win-reg.pl:774
1135 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
1139 #: ../cat/virt-cat.pod:212 ../cat/virt-filesystems.pod:387
1140 #: ../cat/virt-ls.pod:506 ../df/virt-df.pod:228 ../edit/virt-edit.pod:367
1141 #: ../examples/guestfs-examples.pod:47 ../examples/guestfs-recipes.pod:399
1142 #: ../fish/guestfish.pod:1242 ../fish/virt-copy-in.pod:64
1143 #: ../fish/virt-copy-out.pod:53 ../fish/virt-tar-in.pod:62
1144 #: ../fish/virt-tar-out.pod:55 ../fuse/guestmount.pod:318
1145 #: ../inspector/virt-inspector.pod:394
1146 #: ../libguestfs-1.11.19/cat/virt-cat.pod:212
1147 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:387
1148 #: ../libguestfs-1.11.19/cat/virt-ls.pod:506
1149 #: ../libguestfs-1.11.19/df/virt-df.pod:228
1150 #: ../libguestfs-1.11.19/edit/virt-edit.pod:367
1151 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:47
1152 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:399
1153 #: ../libguestfs-1.11.19/fish/guestfish.pod:1242
1154 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:64
1155 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:53
1156 #: ../libguestfs-1.11.19/fish/virt-tar-in.pod:62
1157 #: ../libguestfs-1.11.19/fish/virt-tar-out.pod:55
1158 #: ../libguestfs-1.11.19/fuse/guestmount.pod:318
1159 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:394
1160 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:93
1161 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:54
1162 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:56
1163 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:296
1164 #: ../libguestfs-1.11.19/resize/virt-resize.pod:575
1165 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:50
1166 #: ../libguestfs-1.11.19/src/guestfs.pod:3084
1167 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:97
1168 #: ../ocaml/examples/guestfs-ocaml.pod:93 ../perl/examples/guestfs-perl.pod:54
1169 #: ../python/examples/guestfs-python.pod:56 ../rescue/virt-rescue.pod:296
1170 #: ../resize/virt-resize.pod:575 ../ruby/examples/guestfs-ruby.pod:50
1171 #: ../src/guestfs.pod:3084 ../test-tool/libguestfs-test-tool.pod:97
1172 #: ../tools/virt-list-filesystems.pl:212 ../tools/virt-list-partitions.pl:281
1173 #: ../tools/virt-make-fs.pl:568 ../tools/virt-tar.pl:315
1174 #: ../tools/virt-win-reg.pl:776
1179 #: ../cat/virt-cat.pod:214 ../inspector/virt-inspector.pod:396
1180 #: ../libguestfs-1.11.19/cat/virt-cat.pod:214
1181 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:396
1182 #: ../libguestfs-1.11.19/resize/virt-resize.pod:577
1183 #: ../resize/virt-resize.pod:577
1184 msgid "Copyright (C) 2010-2011 Red Hat Inc."
1188 #: ../cat/virt-cat.pod:216 ../cat/virt-filesystems.pod:391
1189 #: ../cat/virt-ls.pod:510 ../df/virt-df.pod:232 ../edit/virt-edit.pod:371
1190 #: ../fish/guestfish.pod:1247 ../fish/virt-copy-in.pod:69
1191 #: ../fish/virt-copy-out.pod:58 ../fish/virt-tar-in.pod:67
1192 #: ../fish/virt-tar-out.pod:60 ../fuse/guestmount.pod:323
1193 #: ../inspector/virt-inspector.pod:398
1194 #: ../libguestfs-1.11.19/cat/virt-cat.pod:216
1195 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:391
1196 #: ../libguestfs-1.11.19/cat/virt-ls.pod:510
1197 #: ../libguestfs-1.11.19/df/virt-df.pod:232
1198 #: ../libguestfs-1.11.19/edit/virt-edit.pod:371
1199 #: ../libguestfs-1.11.19/fish/guestfish.pod:1247
1200 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:69
1201 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:58
1202 #: ../libguestfs-1.11.19/fish/virt-tar-in.pod:67
1203 #: ../libguestfs-1.11.19/fish/virt-tar-out.pod:60
1204 #: ../libguestfs-1.11.19/fuse/guestmount.pod:323
1205 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:398
1206 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:300
1207 #: ../libguestfs-1.11.19/resize/virt-resize.pod:579
1208 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:102
1209 #: ../rescue/virt-rescue.pod:300 ../resize/virt-resize.pod:579
1210 #: ../test-tool/libguestfs-test-tool.pod:102
1211 #: ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:285
1212 #: ../tools/virt-make-fs.pl:572 ../tools/virt-tar.pl:319
1213 #: ../tools/virt-win-reg.pl:780
1215 "This program is free software; you can redistribute it and/or modify it "
1216 "under the terms of the GNU General Public License as published by the Free "
1217 "Software Foundation; either version 2 of the License, or (at your option) "
1218 "any later version."
1222 #: ../cat/virt-cat.pod:221 ../cat/virt-filesystems.pod:396
1223 #: ../cat/virt-ls.pod:515 ../df/virt-df.pod:237 ../edit/virt-edit.pod:376
1224 #: ../fish/guestfish.pod:1252 ../fish/virt-copy-in.pod:74
1225 #: ../fish/virt-copy-out.pod:63 ../fish/virt-tar-in.pod:72
1226 #: ../fish/virt-tar-out.pod:65 ../fuse/guestmount.pod:328
1227 #: ../inspector/virt-inspector.pod:403
1228 #: ../libguestfs-1.11.19/cat/virt-cat.pod:221
1229 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:396
1230 #: ../libguestfs-1.11.19/cat/virt-ls.pod:515
1231 #: ../libguestfs-1.11.19/df/virt-df.pod:237
1232 #: ../libguestfs-1.11.19/edit/virt-edit.pod:376
1233 #: ../libguestfs-1.11.19/fish/guestfish.pod:1252
1234 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:74
1235 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:63
1236 #: ../libguestfs-1.11.19/fish/virt-tar-in.pod:72
1237 #: ../libguestfs-1.11.19/fish/virt-tar-out.pod:65
1238 #: ../libguestfs-1.11.19/fuse/guestmount.pod:328
1239 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:403
1240 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:305
1241 #: ../libguestfs-1.11.19/resize/virt-resize.pod:584
1242 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:107
1243 #: ../rescue/virt-rescue.pod:305 ../resize/virt-resize.pod:584
1244 #: ../test-tool/libguestfs-test-tool.pod:107
1245 #: ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:290
1246 #: ../tools/virt-make-fs.pl:577 ../tools/virt-tar.pl:324
1247 #: ../tools/virt-win-reg.pl:785
1249 "This program is distributed in the hope that it will be useful, but WITHOUT "
1250 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
1251 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
1256 #: ../cat/virt-cat.pod:226 ../cat/virt-filesystems.pod:401
1257 #: ../cat/virt-ls.pod:520 ../df/virt-df.pod:242 ../edit/virt-edit.pod:381
1258 #: ../fish/guestfish.pod:1257 ../fish/virt-copy-in.pod:79
1259 #: ../fish/virt-copy-out.pod:68 ../fish/virt-tar-in.pod:77
1260 #: ../fish/virt-tar-out.pod:70 ../fuse/guestmount.pod:333
1261 #: ../inspector/virt-inspector.pod:408
1262 #: ../libguestfs-1.11.19/cat/virt-cat.pod:226
1263 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:401
1264 #: ../libguestfs-1.11.19/cat/virt-ls.pod:520
1265 #: ../libguestfs-1.11.19/df/virt-df.pod:242
1266 #: ../libguestfs-1.11.19/edit/virt-edit.pod:381
1267 #: ../libguestfs-1.11.19/fish/guestfish.pod:1257
1268 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:79
1269 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:68
1270 #: ../libguestfs-1.11.19/fish/virt-tar-in.pod:77
1271 #: ../libguestfs-1.11.19/fish/virt-tar-out.pod:70
1272 #: ../libguestfs-1.11.19/fuse/guestmount.pod:333
1273 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:408
1274 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:310
1275 #: ../libguestfs-1.11.19/resize/virt-resize.pod:589
1276 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:112
1277 #: ../rescue/virt-rescue.pod:310 ../resize/virt-resize.pod:589
1278 #: ../test-tool/libguestfs-test-tool.pod:112
1279 #: ../tools/virt-list-filesystems.pl:226 ../tools/virt-list-partitions.pl:295
1280 #: ../tools/virt-make-fs.pl:582 ../tools/virt-tar.pl:329
1281 #: ../tools/virt-win-reg.pl:790
1283 "You should have received a copy of the GNU General Public License along with "
1284 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
1285 "Ave, Cambridge, MA 02139, USA."
1289 #: ../cat/virt-filesystems.pod:5
1290 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:5
1292 "virt-filesystems - List filesystems, partitions, block devices, LVM in a "
1293 "virtual machine or disk image"
1297 #: ../cat/virt-filesystems.pod:9
1298 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:9
1301 " virt-filesystems [--options] -d domname\n"
1306 #: ../cat/virt-filesystems.pod:11
1307 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:11
1310 " virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
1315 #: ../cat/virt-filesystems.pod:15
1316 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:15
1318 "This tool allows you to discover filesystems, partitions, logical volumes, "
1319 "and their sizes in a disk image or virtual machine. It is a replacement for "
1320 "L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
1324 #: ../cat/virt-filesystems.pod:20
1325 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:20
1327 "One use for this tool is from shell scripts to iterate over all filesystems "
1328 "from a disk image:"
1332 #: ../cat/virt-filesystems.pod:23
1333 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:23
1336 " for fs in $(virt-filesystems -a disk.img); do\n"
1343 #: ../cat/virt-filesystems.pod:27
1344 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:27
1346 "Another use is to list partitions before using another tool to modify those "
1347 "partitions (such as L<virt-resize(1)>). If you are curious about what an "
1348 "unknown disk image contains, use this tool along with L<virt-inspector(1)>."
1352 #: ../cat/virt-filesystems.pod:32
1353 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:32
1355 "Various command line options control what this program displays. You need "
1356 "to give either I<-a> or I<-d> options to specify the disk image or libvirt "
1357 "guest respectively. If you just specify that then the program shows "
1358 "filesystems found, one per line, like this:"
1362 #: ../cat/virt-filesystems.pod:37
1363 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:37
1366 " $ virt-filesystems -a disk.img\n"
1368 " /dev/vg_guest/lv_root\n"
1373 #: ../cat/virt-filesystems.pod:41
1374 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:41
1376 "If you add I<-l> or I<--long> then the output includes extra information:"
1380 #: ../cat/virt-filesystems.pod:44
1381 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:44
1384 " $ virt-filesystems -a disk.img -l\n"
1385 " Name Type VFS Label Size\n"
1386 " /dev/sda1 filesystem ext4 boot 524288000\n"
1387 " /dev/vg_guest/lv_root filesystem ext4 root 10212081664\n"
1392 #: ../cat/virt-filesystems.pod:49
1393 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:49
1395 "If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
1400 #: ../cat/virt-filesystems.pod:52
1401 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:52
1404 " $ virt-filesystems -a disk.img --extra\n"
1406 " /dev/vg_guest/lv_root\n"
1407 " /dev/vg_guest/lv_swap\n"
1408 " /dev/vg_guest/lv_data\n"
1413 #: ../cat/virt-filesystems.pod:58
1414 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:58
1416 "If you add I<--partitions> then partitions are shown instead of filesystems:"
1420 #: ../cat/virt-filesystems.pod:60
1421 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:60
1424 " $ virt-filesystems -a disk.img --partitions\n"
1431 #: ../cat/virt-filesystems.pod:64
1432 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:64
1434 "Similarly you can use I<--logical-volumes>, I<--volume-groups>, I<--physical-"
1435 "volumes>, I<--block-devices> to list those items."
1439 #: ../cat/virt-filesystems.pod:67
1440 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:67
1442 "You can use these options in combination as well (if you want a combination "
1443 "including filesystems, you have to add I<--filesystems>). Notice that some "
1444 "items fall into several categories (eg. C</dev/sda1> might be both a "
1445 "partition and a filesystem). These items are listed several times. To get "
1446 "a list which includes absolutely everything that virt-filesystems knows "
1447 "about, use the I<--all> option."
1451 #: ../cat/virt-filesystems.pod:74
1452 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:74
1454 "UUIDs (because they are quite long) are not shown by default. Add the I<--"
1455 "uuid> option to display device and filesystem UUIDs in the long output."
1459 #: ../cat/virt-filesystems.pod:78
1460 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:78
1462 "I<--all --long --uuid> is a useful combination to display all possible "
1463 "information about everything."
1467 #: ../cat/virt-filesystems.pod:81
1468 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:81
1471 " $ virt-filesystems -a win.img --all --long --uuid -h\n"
1472 " Name Type VFS Label Size Parent UUID\n"
1473 " /dev/sda1 filesystem ntfs System Reserved 100M - F81C92571C92112C\n"
1474 " /dev/sda2 filesystem ntfs - 20G - F2E8996AE8992E3B\n"
1475 " /dev/sda1 partition - - 100M /dev/sda -\n"
1476 " /dev/sda2 partition - - 20G /dev/sda -\n"
1477 " /dev/sda device - - 20G - -\n"
1482 #: ../cat/virt-filesystems.pod:89
1483 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:89
1485 "For machine-readable output, use I<--csv> to get Comma-Separated Values."
1489 #: ../cat/virt-filesystems.pod:110
1490 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:110
1491 #: ../tools/virt-list-filesystems.pl:121
1496 #: ../cat/virt-filesystems.pod:112
1497 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:112
1499 "Display everything. This is currently the same as specifying these options: "
1500 "I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, I<--"
1501 "logical-volumes>, I<--volume-groups>, I<--physical-volumes>. (More may be "
1502 "added to this list in future)."
1506 #: ../cat/virt-filesystems.pod:117
1507 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:117
1508 msgid "See also I<--long>."
1512 #: ../cat/virt-filesystems.pod:119
1513 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:119
1514 msgid "B<--blkdevs>"
1518 #: ../cat/virt-filesystems.pod:121
1519 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:121
1520 msgid "B<--block-devices>"
1524 #: ../cat/virt-filesystems.pod:123
1525 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:123
1526 msgid "Display block devices."
1530 #: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301
1531 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:135
1532 #: ../libguestfs-1.11.19/cat/virt-ls.pod:301
1537 #: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303
1538 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:137
1539 #: ../libguestfs-1.11.19/cat/virt-ls.pod:303
1541 "Write out the results in CSV format (comma-separated values). This format "
1542 "can be imported easily into databases and spreadsheets, but read L</NOTE "
1543 "ABOUT CSV FORMAT> below."
1547 #: ../cat/virt-filesystems.pod:150
1548 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:150
1550 "When prompting for keys and passphrases, virt-filesystems normally turns "
1551 "echoing off so you cannot see what you are typing. If you are not worried "
1552 "about Tempest attacks and there is no one else in the room you can specify "
1553 "this flag to see what you are typing."
1557 #: ../cat/virt-filesystems.pod:155
1558 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:155
1563 #: ../cat/virt-filesystems.pod:157
1564 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:157
1566 "This causes filesystems that are not ordinary, mountable filesystems to be "
1567 "displayed. This category includes swapspace, and filesystems that are empty "
1568 "or contain unknown data."
1572 #: ../cat/virt-filesystems.pod:161
1573 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:161
1574 msgid "This option implies I<--filesystems>."
1578 #: ../cat/virt-filesystems.pod:163
1579 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:163
1580 msgid "B<--filesystems>"
1584 #: ../cat/virt-filesystems.pod:165
1585 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:165
1587 "Display mountable filesystems. If no display option was selected then this "
1588 "option is implied."
1592 #: ../cat/virt-filesystems.pod:168
1593 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:168
1594 msgid "With I<--extra>, non-mountable filesystems are shown too."
1598 #: ../cat/virt-filesystems.pod:181
1599 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:181
1602 " virt-filesystems --format=raw -a disk.img\n"
1607 #: ../cat/virt-filesystems.pod:185
1608 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:185
1611 " virt-filesystems --format=raw -a disk.img --format -a another.img\n"
1616 #: ../cat/virt-filesystems.pod:194 ../cat/virt-ls.pod:352
1617 #: ../df/virt-df.pod:119 ../fish/guestfish.pod:156
1618 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:194
1619 #: ../libguestfs-1.11.19/cat/virt-ls.pod:352
1620 #: ../libguestfs-1.11.19/df/virt-df.pod:119
1621 #: ../libguestfs-1.11.19/fish/guestfish.pod:156
1622 #: ../tools/virt-list-partitions.pl:109
1627 #: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354
1628 #: ../df/virt-df.pod:121 ../libguestfs-1.11.19/cat/virt-filesystems.pod:196
1629 #: ../libguestfs-1.11.19/cat/virt-ls.pod:354
1630 #: ../libguestfs-1.11.19/df/virt-df.pod:121
1631 #: ../tools/virt-list-partitions.pl:111
1632 msgid "B<--human-readable>"
1636 #: ../cat/virt-filesystems.pod:198
1637 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:198
1638 msgid "In I<--long> mode, display sizes in human-readable format."
1642 #: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366
1643 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:205
1644 #: ../libguestfs-1.11.19/cat/virt-ls.pod:366
1645 #: ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
1650 #: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368
1651 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:207
1652 #: ../libguestfs-1.11.19/cat/virt-ls.pod:368
1653 #: ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
1658 #: ../cat/virt-filesystems.pod:209
1659 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:209
1660 msgid "Display extra columns of data (\"long format\")."
1664 #: ../cat/virt-filesystems.pod:211
1665 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:211
1666 msgid "A title row is added unless you also specify I<--no-title>."
1670 #: ../cat/virt-filesystems.pod:213
1671 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:213
1673 "The extra columns displayed depend on what output you select, and the "
1674 "ordering of columns may change in future versions. Use the title row, I<--"
1675 "csv> output and/or L<csvtool(1)> to match columns to data in external "
1680 #: ../cat/virt-filesystems.pod:218
1681 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:218
1683 "Use I<-h> if you want sizes to be displayed in human-readable format. The "
1684 "default is to show raw numbers of I<bytes>."
1688 #: ../cat/virt-filesystems.pod:221
1689 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:221
1690 msgid "Use I<--uuid> to display UUIDs too."
1694 #: ../cat/virt-filesystems.pod:223
1695 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:223
1700 #: ../cat/virt-filesystems.pod:225
1701 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:225
1702 msgid "B<--logvols>"
1706 #: ../cat/virt-filesystems.pod:227
1707 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:227
1708 msgid "B<--logical-volumes>"
1712 #: ../cat/virt-filesystems.pod:229
1713 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:229
1715 "Display LVM logical volumes. In this mode, these are displayed irrespective "
1716 "of whether the LVs contain filesystems."
1720 #: ../cat/virt-filesystems.pod:232
1721 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:232
1722 msgid "B<--no-title>"
1726 #: ../cat/virt-filesystems.pod:234
1727 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:234
1728 msgid "In I<--long> mode, don't add a title row."
1732 #: ../cat/virt-filesystems.pod:236
1733 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:236
1735 "Note that the order of the columns is not fixed, and may change in future "
1736 "versions of virt-filesystems, so using this option may give you unexpected "
1741 #: ../cat/virt-filesystems.pod:240
1742 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:240
1747 #: ../cat/virt-filesystems.pod:242
1748 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:242
1749 msgid "B<--partitions>"
1753 #: ../cat/virt-filesystems.pod:244
1754 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:244
1756 "Display partitions. In this mode, these are displayed irrespective of "
1757 "whether the partitions contain filesystems."
1761 #: ../cat/virt-filesystems.pod:247
1762 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:247
1767 #: ../cat/virt-filesystems.pod:249
1768 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:249
1769 msgid "B<--physvols>"
1773 #: ../cat/virt-filesystems.pod:251
1774 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:251
1775 msgid "B<--physical-volumes>"
1779 #: ../cat/virt-filesystems.pod:253
1780 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:253
1781 msgid "Display LVM physical volumes."
1785 #: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:157
1786 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:255
1787 #: ../libguestfs-1.11.19/df/virt-df.pod:157
1792 #: ../cat/virt-filesystems.pod:257
1793 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:257
1798 #: ../cat/virt-filesystems.pod:259
1799 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:259
1800 msgid "In I<--long> mode, display UUIDs as well."
1804 #: ../cat/virt-filesystems.pod:273
1805 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:273
1810 #: ../cat/virt-filesystems.pod:275
1811 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:275
1812 msgid "B<--volgroups>"
1816 #: ../cat/virt-filesystems.pod:277
1817 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:277
1818 msgid "B<--volume-groups>"
1822 #: ../cat/virt-filesystems.pod:279
1823 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:279
1824 msgid "Display LVM volume groups."
1828 #: ../cat/virt-filesystems.pod:287
1829 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:287
1834 #: ../cat/virt-filesystems.pod:289
1835 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:289
1837 "Note that columns in the output are subject to reordering and change in "
1838 "future versions of this tool."
1842 #: ../cat/virt-filesystems.pod:294
1843 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:294
1848 #: ../cat/virt-filesystems.pod:296
1849 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:296
1850 msgid "The filesystem, partition, block device or LVM name."
1854 #: ../cat/virt-filesystems.pod:298
1855 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:298
1857 "For device and partition names these are displayed as canonical libguestfs "
1858 "names, so that for example C</dev/sda2> is the second partition on the first "
1863 #: ../cat/virt-filesystems.pod:302
1864 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:302
1866 "If the I<--long> option is B<not> specified, then only the name column is "
1867 "shown in the output."
1871 #: ../cat/virt-filesystems.pod:305
1872 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:305
1877 #: ../cat/virt-filesystems.pod:307
1878 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:307
1879 msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
1883 #: ../cat/virt-filesystems.pod:309
1884 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:309
1889 #: ../cat/virt-filesystems.pod:311
1890 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:311
1892 "If there is a filesystem, then this column displays the filesystem type if "
1893 "one could be detected, eg. C<ext4>."
1897 #: ../cat/virt-filesystems.pod:314
1898 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:314
1903 #: ../cat/virt-filesystems.pod:316
1904 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:316
1906 "If the object has a label (used for identifying and mounting filesystems) "
1907 "then this column contains the label."
1911 #: ../cat/virt-filesystems.pod:319
1912 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:319
1917 #: ../cat/virt-filesystems.pod:321
1918 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:321
1920 "The size of the object in bytes. If the I<--human> option is used then the "
1921 "size is displayed in a human-readable form."
1925 #: ../cat/virt-filesystems.pod:324
1926 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:324
1931 #: ../cat/virt-filesystems.pod:326
1932 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:326
1934 "The parent column records the parent relationship between objects. For "
1935 "example, if the object is a partition, then this column contains the name of "
1936 "the containing device. If the object is a logical volume, then this column "
1937 "is the name of the volume group."
1941 #: ../cat/virt-filesystems.pod:331
1942 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:331
1947 #: ../cat/virt-filesystems.pod:333
1948 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:333
1950 "If the object has a UUID (used for identifying and mounting filesystems and "
1951 "block devices) then this column contains the UUID as a string."
1955 #: ../cat/virt-filesystems.pod:337
1956 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:337
1957 msgid "The UUID is only displayed if the I<--uuid> option is given."
1961 #: ../cat/virt-filesystems.pod:341 ../cat/virt-ls.pod:459
1962 #: ../df/virt-df.pod:185 ../libguestfs-1.11.19/cat/virt-filesystems.pod:341
1963 #: ../libguestfs-1.11.19/cat/virt-ls.pod:459
1964 #: ../libguestfs-1.11.19/df/virt-df.pod:185
1965 msgid "NOTE ABOUT CSV FORMAT"
1969 #: ../cat/virt-filesystems.pod:343 ../cat/virt-ls.pod:461
1970 #: ../df/virt-df.pod:187 ../libguestfs-1.11.19/cat/virt-filesystems.pod:343
1971 #: ../libguestfs-1.11.19/cat/virt-ls.pod:461
1972 #: ../libguestfs-1.11.19/df/virt-df.pod:187
1974 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
1975 "should be easy to parse, but it is definitely not easy to parse."
1979 #: ../cat/virt-filesystems.pod:346 ../cat/virt-ls.pod:464
1980 #: ../df/virt-df.pod:190 ../libguestfs-1.11.19/cat/virt-filesystems.pod:346
1981 #: ../libguestfs-1.11.19/cat/virt-ls.pod:464
1982 #: ../libguestfs-1.11.19/df/virt-df.pod:190
1984 "Myth: Just split fields at commas. Reality: This does I<not> work "
1985 "reliably. This example has two columns:"
1989 #: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:467
1990 #: ../df/virt-df.pod:193 ../libguestfs-1.11.19/cat/virt-filesystems.pod:349
1991 #: ../libguestfs-1.11.19/cat/virt-ls.pod:467
1992 #: ../libguestfs-1.11.19/df/virt-df.pod:193
1995 " \"foo,bar\",baz\n"
2000 #: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:469
2001 #: ../df/virt-df.pod:195 ../libguestfs-1.11.19/cat/virt-filesystems.pod:351
2002 #: ../libguestfs-1.11.19/cat/virt-ls.pod:469
2003 #: ../libguestfs-1.11.19/df/virt-df.pod:195
2005 "Myth: Read the file one line at a time. Reality: This does I<not> work "
2006 "reliably. This example has one row:"
2010 #: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:472
2011 #: ../df/virt-df.pod:198 ../libguestfs-1.11.19/cat/virt-filesystems.pod:354
2012 #: ../libguestfs-1.11.19/cat/virt-ls.pod:472
2013 #: ../libguestfs-1.11.19/df/virt-df.pod:198
2022 #: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:475
2023 #: ../df/virt-df.pod:201 ../libguestfs-1.11.19/cat/virt-filesystems.pod:357
2024 #: ../libguestfs-1.11.19/cat/virt-ls.pod:475
2025 #: ../libguestfs-1.11.19/df/virt-df.pod:201
2027 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
2028 "packaged in major Linux distributions)."
2032 #: ../cat/virt-filesystems.pod:360 ../cat/virt-ls.pod:478
2033 #: ../df/virt-df.pod:204 ../libguestfs-1.11.19/cat/virt-filesystems.pod:360
2034 #: ../libguestfs-1.11.19/cat/virt-ls.pod:478
2035 #: ../libguestfs-1.11.19/df/virt-df.pod:204
2037 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
2038 "or Python's built-in csv library)."
2042 #: ../cat/virt-filesystems.pod:363 ../cat/virt-ls.pod:481
2043 #: ../df/virt-df.pod:207 ../libguestfs-1.11.19/cat/virt-filesystems.pod:363
2044 #: ../libguestfs-1.11.19/cat/virt-ls.pod:481
2045 #: ../libguestfs-1.11.19/df/virt-df.pod:207
2046 msgid "Most spreadsheets and databases can import CSV directly."
2050 #: ../cat/virt-filesystems.pod:374
2051 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:374
2053 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, L<virt-list-"
2054 "filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, L<http://"
2059 #: ../cat/virt-filesystems.pod:389
2060 #: ../libguestfs-1.11.19/cat/virt-filesystems.pod:389
2061 #: ../tools/virt-make-fs.pl:570 ../tools/virt-win-reg.pl:778
2062 msgid "Copyright (C) 2010 Red Hat Inc."
2066 #: ../cat/virt-ls.pod:5 ../libguestfs-1.11.19/cat/virt-ls.pod:5
2067 msgid "virt-ls - List files in a virtual machine"
2071 #: ../cat/virt-ls.pod:9 ../libguestfs-1.11.19/cat/virt-ls.pod:9
2074 " virt-ls [--options] -d domname directory [directory ...]\n"
2079 #: ../cat/virt-ls.pod:11 ../libguestfs-1.11.19/cat/virt-ls.pod:11
2082 " virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory ...]\n"
2087 #: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15
2088 #: ../libguestfs-1.11.19/cat/virt-ls.pod:13
2089 #: ../libguestfs-1.11.19/df/virt-df.pod:15
2090 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:13
2091 #: ../rescue/virt-rescue.pod:13
2096 #: ../cat/virt-ls.pod:15 ../libguestfs-1.11.19/cat/virt-ls.pod:15
2099 " virt-ls [--options] domname directory\n"
2104 #: ../cat/virt-ls.pod:17 ../libguestfs-1.11.19/cat/virt-ls.pod:17
2107 " virt-ls [--options] disk.img [disk.img ...] directory\n"
2112 #: ../cat/virt-ls.pod:21 ../libguestfs-1.11.19/cat/virt-ls.pod:21
2114 "C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
2115 "more from a virtual machine or disk image."
2119 #: ../cat/virt-ls.pod:24 ../libguestfs-1.11.19/cat/virt-ls.pod:24
2121 "Multiple directory names can be given, in which case the output from each is "
2126 #: ../cat/virt-ls.pod:27 ../libguestfs-1.11.19/cat/virt-ls.pod:27
2128 "To list directories from a libvirt guest use the I<-d> option to specify the "
2129 "name of the guest. For a disk image, use the I<-a> option."
2133 #: ../cat/virt-ls.pod:31 ../libguestfs-1.11.19/cat/virt-ls.pod:31
2135 "C<virt-ls> can do many simple file listings. For more complicated cases you "
2136 "may need to use L<guestfish(1)>, or write a program directly to the L<guestfs"
2141 #: ../cat/virt-ls.pod:37 ../libguestfs-1.11.19/cat/virt-ls.pod:37
2142 msgid "Get a list of all files and directories in a virtual machine:"
2146 #: ../cat/virt-ls.pod:39 ../libguestfs-1.11.19/cat/virt-ls.pod:39
2149 " virt-ls -R -d guest /\n"
2154 #: ../cat/virt-ls.pod:41 ../libguestfs-1.11.19/cat/virt-ls.pod:41
2155 msgid "List all setuid or setgid programs in a Linux virtual machine:"
2159 #: ../cat/virt-ls.pod:43 ../libguestfs-1.11.19/cat/virt-ls.pod:43
2162 " virt-ls -lR -d guest / | grep '^- [42]'\n"
2167 #: ../cat/virt-ls.pod:45 ../libguestfs-1.11.19/cat/virt-ls.pod:45
2168 msgid "List all public-writable directories in a Linux virtual machine:"
2172 #: ../cat/virt-ls.pod:47 ../libguestfs-1.11.19/cat/virt-ls.pod:47
2175 " virt-ls -lR -d guest / | grep '^d ...7'\n"
2180 #: ../cat/virt-ls.pod:49 ../libguestfs-1.11.19/cat/virt-ls.pod:49
2181 msgid "List all Unix domain sockets in a Linux virtual machine:"
2185 #: ../cat/virt-ls.pod:51 ../libguestfs-1.11.19/cat/virt-ls.pod:51
2188 " virt-ls -lR -d guest / | grep '^s'\n"
2193 #: ../cat/virt-ls.pod:53 ../libguestfs-1.11.19/cat/virt-ls.pod:53
2194 msgid "List all regular files with filenames ending in '.png':"
2198 #: ../cat/virt-ls.pod:55 ../libguestfs-1.11.19/cat/virt-ls.pod:55
2201 " virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
2206 #: ../cat/virt-ls.pod:57 ../libguestfs-1.11.19/cat/virt-ls.pod:57
2207 msgid "To display files larger than 10MB in home directories:"
2211 #: ../cat/virt-ls.pod:59 ../libguestfs-1.11.19/cat/virt-ls.pod:59
2214 " virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
2219 #: ../cat/virt-ls.pod:61 ../libguestfs-1.11.19/cat/virt-ls.pod:61
2220 msgid "Find everything modified in the last 7 days:"
2224 #: ../cat/virt-ls.pod:63 ../libguestfs-1.11.19/cat/virt-ls.pod:63
2227 " virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
2232 #: ../cat/virt-ls.pod:65 ../libguestfs-1.11.19/cat/virt-ls.pod:65
2233 msgid "Find regular files modified in the last 24 hours:"
2237 #: ../cat/virt-ls.pod:67 ../libguestfs-1.11.19/cat/virt-ls.pod:67
2240 " virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
2245 #: ../cat/virt-ls.pod:69 ../libguestfs-1.11.19/cat/virt-ls.pod:69
2246 msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
2250 #: ../cat/virt-ls.pod:71 ../libguestfs-1.11.19/cat/virt-ls.pod:71
2252 "Find the differences between files in a guest and an earlier snapshot of the "
2257 #: ../cat/virt-ls.pod:74 ../libguestfs-1.11.19/cat/virt-ls.pod:74
2260 " virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
2261 " virt-ls -lR -a current.img / --uids --time-t > new\n"
2262 " diff -u old new | less\n"
2267 #: ../cat/virt-ls.pod:78 ../libguestfs-1.11.19/cat/virt-ls.pod:78
2269 "The commands above won't find files where the content has changed but the "
2270 "metadata (eg. file size and modification date) is the same. To do that, you "
2271 "need to add the I<--checksum> parameter to both C<virt-ls> commands. I<--"
2272 "checksum> can be quite slow since it has to read and compute a checksum of "
2273 "every regular file in the virtual machine."
2277 #: ../cat/virt-ls.pod:84 ../libguestfs-1.11.19/cat/virt-ls.pod:84
2278 msgid "OUTPUT MODES"
2282 #: ../cat/virt-ls.pod:86 ../libguestfs-1.11.19/cat/virt-ls.pod:86
2284 "C<virt-ls> has four output modes, controlled by different combinations of "
2285 "the I<-l> and I<-R> options."
2289 #: ../cat/virt-ls.pod:89 ../libguestfs-1.11.19/cat/virt-ls.pod:89
2290 msgid "SIMPLE LISTING"
2294 #: ../cat/virt-ls.pod:91 ../libguestfs-1.11.19/cat/virt-ls.pod:91
2295 msgid "A simple listing is like the ordinary L<ls(1)> command:"
2299 #: ../cat/virt-ls.pod:93 ../libguestfs-1.11.19/cat/virt-ls.pod:93
2302 " $ virt-ls -d guest /\n"
2310 #: ../cat/virt-ls.pod:98 ../libguestfs-1.11.19/cat/virt-ls.pod:98
2311 msgid "LONG LISTING"
2315 #: ../cat/virt-ls.pod:100 ../libguestfs-1.11.19/cat/virt-ls.pod:100
2317 "With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
2318 "(more specifically, like the C<guestfs_ll> function)."
2322 #: ../cat/virt-ls.pod:103 ../libguestfs-1.11.19/cat/virt-ls.pod:103
2325 " $ virt-ls -l -d guest /\n"
2327 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
2328 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
2334 #: ../cat/virt-ls.pod:109 ../libguestfs-1.11.19/cat/virt-ls.pod:109
2336 "Note that while this is useful for displaying a directory, do not try "
2337 "parsing this output in another program. Use L</RECURSIVE LONG LISTING> "
2342 #: ../cat/virt-ls.pod:113 ../libguestfs-1.11.19/cat/virt-ls.pod:113
2343 msgid "RECURSIVE LISTING"
2347 #: ../cat/virt-ls.pod:115 ../libguestfs-1.11.19/cat/virt-ls.pod:115
2349 "With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
2350 "and directories recursively:"
2354 #: ../cat/virt-ls.pod:118 ../libguestfs-1.11.19/cat/virt-ls.pod:118
2357 " $ virt-ls -R -d guest /tmp\n"
2365 #: ../cat/virt-ls.pod:123 ../libguestfs-1.11.19/cat/virt-ls.pod:123
2367 "To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
2368 "converts C<\\0> characters to C<\\n>."
2372 #: ../cat/virt-ls.pod:126 ../libguestfs-1.11.19/cat/virt-ls.pod:126
2373 msgid "RECURSIVE LONG LISTING"
2377 #: ../cat/virt-ls.pod:128 ../libguestfs-1.11.19/cat/virt-ls.pod:128
2379 "Using I<-lR> options together changes the output to display directories "
2380 "recursively, with file stats, and optionally other features such as "
2381 "checksums and extended attributes."
2385 #: ../cat/virt-ls.pod:132 ../libguestfs-1.11.19/cat/virt-ls.pod:132
2387 "Most of the interesting features of C<virt-ls> are only available when using "
2392 #: ../cat/virt-ls.pod:135 ../libguestfs-1.11.19/cat/virt-ls.pod:135
2394 "The fields are normally space-separated. Filenames are B<not> quoted, so "
2395 "you cannot use the output in another program (because filenames can contain "
2396 "spaces and other unsafe characters). If the guest was untrusted and someone "
2397 "knew you were using C<virt-ls> to analyze the guest, they could play tricks "
2398 "on you by creating filenames with embedded newline characters. To B<safely> "
2399 "parse the output in another program, use the I<--csv> (Comma-Separated "
2404 #: ../cat/virt-ls.pod:143 ../libguestfs-1.11.19/cat/virt-ls.pod:143
2406 "Note that this output format is completely unrelated to the C<ls -lR> "
2411 #: ../cat/virt-ls.pod:146 ../libguestfs-1.11.19/cat/virt-ls.pod:146
2414 " $ virt-ls -lR -d guest /bin\n"
2415 " d 0555 4096 /bin\n"
2416 " - 0755 123 /bin/alsaunmute\n"
2417 " - 0755 28328 /bin/arch\n"
2418 " l 0777 4 /bin/awk -> gawk\n"
2419 " - 0755 27216 /bin/basename\n"
2420 " - 0755 943360 /bin/bash\n"
2426 #: ../cat/virt-ls.pod:155 ../libguestfs-1.11.19/cat/virt-ls.pod:155
2427 msgid "These basic fields are always shown:"
2431 #: ../cat/virt-ls.pod:159 ../libguestfs-1.11.19/cat/virt-ls.pod:159
2436 #: ../cat/virt-ls.pod:161 ../libguestfs-1.11.19/cat/virt-ls.pod:161
2438 "The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
2439 "(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
2440 "link), C<s> (socket) or C<u> (unknown)."
2444 #: ../cat/virt-ls.pod:171 ../libguestfs-1.11.19/cat/virt-ls.pod:171
2449 #: ../cat/virt-ls.pod:173 ../libguestfs-1.11.19/cat/virt-ls.pod:173
2450 msgid "The Unix permissions, displayed as a 4 digit octal number."
2454 #: ../cat/virt-ls.pod:175 ../libguestfs-1.11.19/cat/virt-ls.pod:175
2459 #: ../cat/virt-ls.pod:177 ../libguestfs-1.11.19/cat/virt-ls.pod:177
2461 "The size of the file. This is shown in bytes unless I<-h> or I<--human-"
2462 "readable> option is given, in which case this is shown as a human-readable "
2467 #: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4183
2468 #: ../libguestfs-1.11.19/cat/virt-ls.pod:181
2469 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4183
2474 #: ../cat/virt-ls.pod:183 ../libguestfs-1.11.19/cat/virt-ls.pod:183
2475 msgid "The full path of the file or directory."
2479 #: ../cat/virt-ls.pod:185 ../libguestfs-1.11.19/cat/virt-ls.pod:185
2484 #: ../cat/virt-ls.pod:187 ../libguestfs-1.11.19/cat/virt-ls.pod:187
2485 msgid "For symbolic links only, the link target."
2489 #: ../cat/virt-ls.pod:191 ../libguestfs-1.11.19/cat/virt-ls.pod:191
2491 "In I<-lR> mode, additional command line options enable the display of more "
2496 #: ../cat/virt-ls.pod:194 ../libguestfs-1.11.19/cat/virt-ls.pod:194
2498 "With the I<--uids> flag, these additional fields are displayed before the "
2503 #: ../cat/virt-ls.pod:199 ../libguestfs-1.11.19/cat/virt-ls.pod:199
2508 #: ../cat/virt-ls.pod:201 ../libguestfs-1.11.19/cat/virt-ls.pod:201
2513 #: ../cat/virt-ls.pod:203 ../libguestfs-1.11.19/cat/virt-ls.pod:203
2515 "The UID and GID of the owner of the file (displayed numerically). Note "
2516 "these only make sense in the context of a Unix-like guest."
2520 #: ../cat/virt-ls.pod:208 ../libguestfs-1.11.19/cat/virt-ls.pod:208
2521 msgid "With the I<--times> flag, these additional fields are displayed:"
2525 #: ../cat/virt-ls.pod:212 ../libguestfs-1.11.19/cat/virt-ls.pod:212
2530 #: ../cat/virt-ls.pod:214 ../libguestfs-1.11.19/cat/virt-ls.pod:214
2531 msgid "The time of last access."
2535 #: ../cat/virt-ls.pod:216 ../libguestfs-1.11.19/cat/virt-ls.pod:216
2540 #: ../cat/virt-ls.pod:218 ../libguestfs-1.11.19/cat/virt-ls.pod:218
2541 msgid "The time of last modification."
2545 #: ../cat/virt-ls.pod:220 ../libguestfs-1.11.19/cat/virt-ls.pod:220
2550 #: ../cat/virt-ls.pod:222 ../libguestfs-1.11.19/cat/virt-ls.pod:222
2551 msgid "The time of last status change."
2555 #: ../cat/virt-ls.pod:226 ../libguestfs-1.11.19/cat/virt-ls.pod:226
2557 "The time fields are displayed as string dates and times, unless one of the "
2558 "I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
2562 #: ../cat/virt-ls.pod:229 ../libguestfs-1.11.19/cat/virt-ls.pod:229
2563 msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
2567 #: ../cat/virt-ls.pod:233 ../libguestfs-1.11.19/cat/virt-ls.pod:233
2572 #: ../cat/virt-ls.pod:235 ../libguestfs-1.11.19/cat/virt-ls.pod:235
2574 "The device containing the file (displayed as major:minor). This may not "
2575 "match devices as known to the guest."
2579 #: ../cat/virt-ls.pod:238 ../libguestfs-1.11.19/cat/virt-ls.pod:238
2584 #: ../cat/virt-ls.pod:240 ../libguestfs-1.11.19/cat/virt-ls.pod:240
2585 msgid "The inode number."
2589 #: ../cat/virt-ls.pod:242 ../libguestfs-1.11.19/cat/virt-ls.pod:242
2594 #: ../cat/virt-ls.pod:244 ../libguestfs-1.11.19/cat/virt-ls.pod:244
2595 msgid "The number of hard links."
2599 #: ../cat/virt-ls.pod:246 ../libguestfs-1.11.19/cat/virt-ls.pod:246
2604 #: ../cat/virt-ls.pod:248 ../libguestfs-1.11.19/cat/virt-ls.pod:248
2606 "For block and char special files, the device (displayed as major:minor)."
2610 #: ../cat/virt-ls.pod:251 ../libguestfs-1.11.19/cat/virt-ls.pod:251
2615 #: ../cat/virt-ls.pod:253 ../libguestfs-1.11.19/cat/virt-ls.pod:253
2616 msgid "The number of 512 byte blocks allocated to the file."
2620 #: ../cat/virt-ls.pod:257 ../libguestfs-1.11.19/cat/virt-ls.pod:257
2622 "With the I<--checksum> flag, the checksum of the file contents is shown "
2623 "(only for regular files). Computing file checksums can take a considerable "
2628 #: ../cat/virt-ls.pod:280 ../libguestfs-1.11.19/cat/virt-ls.pod:280
2629 msgid "B<--checksum>"
2633 #: ../cat/virt-ls.pod:282 ../libguestfs-1.11.19/cat/virt-ls.pod:282
2634 msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
2638 #: ../cat/virt-ls.pod:284 ../libguestfs-1.11.19/cat/virt-ls.pod:284
2640 "Display checksum over file contents for regular files. With no argument, "
2641 "this defaults to using I<md5>. Using an argument, you can select the "
2642 "checksum type to use."
2646 #: ../cat/virt-ls.pod:288 ../cat/virt-ls.pod:325 ../cat/virt-ls.pod:358
2647 #: ../cat/virt-ls.pod:391 ../cat/virt-ls.pod:401 ../cat/virt-ls.pod:408
2648 #: ../cat/virt-ls.pod:415 ../cat/virt-ls.pod:422
2649 #: ../libguestfs-1.11.19/cat/virt-ls.pod:288
2650 #: ../libguestfs-1.11.19/cat/virt-ls.pod:325
2651 #: ../libguestfs-1.11.19/cat/virt-ls.pod:358
2652 #: ../libguestfs-1.11.19/cat/virt-ls.pod:391
2653 #: ../libguestfs-1.11.19/cat/virt-ls.pod:401
2654 #: ../libguestfs-1.11.19/cat/virt-ls.pod:408
2655 #: ../libguestfs-1.11.19/cat/virt-ls.pod:415
2656 #: ../libguestfs-1.11.19/cat/virt-ls.pod:422
2658 "This option only has effect in I<-lR> output mode. See L</RECURSIVE LONG "
2663 #: ../cat/virt-ls.pod:316 ../libguestfs-1.11.19/cat/virt-ls.pod:316
2665 "When prompting for keys and passphrases, virt-ls normally turns echoing off "
2666 "so you cannot see what you are typing. If you are not worried about Tempest "
2667 "attacks and there is no one else in the room you can specify this flag to "
2668 "see what you are typing."
2672 #: ../cat/virt-ls.pod:321 ../libguestfs-1.11.19/cat/virt-ls.pod:321
2673 msgid "B<--extra-stats>"
2677 #: ../cat/virt-ls.pod:323 ../libguestfs-1.11.19/cat/virt-ls.pod:323
2678 msgid "Display extra stats."
2682 #: ../cat/virt-ls.pod:339 ../libguestfs-1.11.19/cat/virt-ls.pod:339
2685 " virt-ls --format=raw -a disk.img /dir\n"
2690 #: ../cat/virt-ls.pod:343 ../libguestfs-1.11.19/cat/virt-ls.pod:343
2693 " virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
2698 #: ../cat/virt-ls.pod:356 ../libguestfs-1.11.19/cat/virt-ls.pod:356
2699 msgid "Display file sizes in human-readable format."
2703 #: ../cat/virt-ls.pod:370 ../libguestfs-1.11.19/cat/virt-ls.pod:370
2708 #: ../cat/virt-ls.pod:372 ../libguestfs-1.11.19/cat/virt-ls.pod:372
2709 msgid "B<--recursive>"
2713 #: ../cat/virt-ls.pod:374 ../libguestfs-1.11.19/cat/virt-ls.pod:374
2715 "Select the mode. With neither of these options, C<virt-ls> produces a "
2716 "simple, flat list of the files in the named directory. See L</SIMPLE "
2721 #: ../cat/virt-ls.pod:378 ../libguestfs-1.11.19/cat/virt-ls.pod:378
2723 "C<virt-ls -l> produces a \"long listing\", which shows more detail. See L</"
2728 #: ../cat/virt-ls.pod:381 ../libguestfs-1.11.19/cat/virt-ls.pod:381
2730 "C<virt-ls -R> produces a recursive list of files starting at the named "
2731 "directory. See L</RECURSIVE LISTING>."
2735 #: ../cat/virt-ls.pod:384 ../libguestfs-1.11.19/cat/virt-ls.pod:384
2737 "C<virt-ls -lR> produces a recursive long listing which can be more easily "
2738 "parsed. See L</RECURSIVE LONG LISTING>."
2742 #: ../cat/virt-ls.pod:387 ../libguestfs-1.11.19/cat/virt-ls.pod:387
2747 #: ../cat/virt-ls.pod:389 ../libguestfs-1.11.19/cat/virt-ls.pod:389
2748 msgid "Display time fields."
2752 #: ../cat/virt-ls.pod:394 ../libguestfs-1.11.19/cat/virt-ls.pod:394
2753 msgid "B<--time-days>"
2757 #: ../cat/virt-ls.pod:396 ../libguestfs-1.11.19/cat/virt-ls.pod:396
2758 msgid "Display time fields as days before now (negative if in the future)."
2762 #: ../cat/virt-ls.pod:398 ../libguestfs-1.11.19/cat/virt-ls.pod:398
2764 "Note that C<0> in output means \"up to 1 day before now\", or that the age "
2765 "of the file is between 0 and 86399 seconds."
2769 #: ../cat/virt-ls.pod:404 ../libguestfs-1.11.19/cat/virt-ls.pod:404
2770 msgid "B<--time-relative>"
2774 #: ../cat/virt-ls.pod:406 ../libguestfs-1.11.19/cat/virt-ls.pod:406
2775 msgid "Display time fields as seconds before now (negative if in the future)."
2779 #: ../cat/virt-ls.pod:411 ../libguestfs-1.11.19/cat/virt-ls.pod:411
2784 #: ../cat/virt-ls.pod:413 ../libguestfs-1.11.19/cat/virt-ls.pod:413
2785 msgid "Display time fields as seconds since the Unix epoch."
2789 #: ../cat/virt-ls.pod:418 ../libguestfs-1.11.19/cat/virt-ls.pod:418
2794 #: ../cat/virt-ls.pod:420 ../libguestfs-1.11.19/cat/virt-ls.pod:420
2795 msgid "Display UID and GID fields."
2799 #: ../cat/virt-ls.pod:445 ../libguestfs-1.11.19/cat/virt-ls.pod:445
2800 msgid "Previous versions of virt-ls allowed you to write either:"
2804 #: ../cat/virt-ls.pod:447 ../libguestfs-1.11.19/cat/virt-ls.pod:447
2807 " virt-ls disk.img [disk.img ...] /dir\n"
2812 #: ../cat/virt-ls.pod:451 ../libguestfs-1.11.19/cat/virt-ls.pod:451
2815 " virt-ls guestname /dir\n"
2820 #: ../cat/virt-ls.pod:492 ../libguestfs-1.11.19/cat/virt-ls.pod:492
2822 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-"
2823 "tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
2824 "L<http://libguestfs.org/>."
2828 #: ../cat/virt-ls.pod:508 ../df/virt-df.pod:230 ../edit/virt-edit.pod:369
2829 #: ../libguestfs-1.11.19/cat/virt-ls.pod:508
2830 #: ../libguestfs-1.11.19/df/virt-df.pod:230
2831 #: ../libguestfs-1.11.19/edit/virt-edit.pod:369
2832 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:298
2833 #: ../rescue/virt-rescue.pod:298
2834 msgid "Copyright (C) 2009-2011 Red Hat Inc."
2838 #: ../df/virt-df.pod:5 ../libguestfs-1.11.19/df/virt-df.pod:5
2839 msgid "virt-df - Display free space on virtual filesystems"
2843 #: ../df/virt-df.pod:9 ../libguestfs-1.11.19/df/virt-df.pod:9
2846 " virt-df [--options]\n"
2851 #: ../df/virt-df.pod:11 ../libguestfs-1.11.19/df/virt-df.pod:11
2854 " virt-df [--options] -d domname\n"
2859 #: ../df/virt-df.pod:13 ../libguestfs-1.11.19/df/virt-df.pod:13
2862 " virt-df [--options] -a disk.img [-a disk.img ...]\n"
2867 #: ../df/virt-df.pod:17 ../libguestfs-1.11.19/df/virt-df.pod:17
2870 " virt-df [--options] domname\n"
2875 #: ../df/virt-df.pod:19 ../libguestfs-1.11.19/df/virt-df.pod:19
2878 " virt-df [--options] disk.img [disk.img ...]\n"
2883 #: ../df/virt-df.pod:23 ../libguestfs-1.11.19/df/virt-df.pod:23
2885 "C<virt-df> is a command line tool to display free space on virtual machine "
2886 "filesystems. Unlike other tools, it doesn't just display the size of disk "
2887 "allocated to a virtual machine, but can look inside disk images to see how "
2888 "much space is really being used."
2892 #: ../df/virt-df.pod:28 ../libguestfs-1.11.19/df/virt-df.pod:28
2894 "If used without any I<-a> or I<-d> arguments, C<virt-df> checks with libvirt "
2895 "to get a list of all active and inactive guests, and performs a C<df>-type "
2896 "operation on each one in turn, printing out the results."
2900 #: ../df/virt-df.pod:32 ../libguestfs-1.11.19/df/virt-df.pod:32
2902 "If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a C<df>-"
2903 "type operation on either the single named libvirt domain, or on the disk "
2904 "image(s) listed on the command line (which must all belong to a single VM). "
2905 "In this mode (with arguments), C<virt-df> will I<only work for a single "
2906 "guest>. If you want to run on multiple guests, then you have to invoke "
2907 "C<virt-df> multiple times."
2911 #: ../df/virt-df.pod:39 ../libguestfs-1.11.19/df/virt-df.pod:39
2913 "Use the I<--csv> option to get a format which can be easily parsed by other "
2914 "programs. Other options are similar to the standard L<df(1)> command."
2918 #: ../df/virt-df.pod:45 ../libguestfs-1.11.19/df/virt-df.pod:45
2920 "Show disk usage for a single libvirt guest called C<F14x64>. Make the "
2921 "output human-readable:"
2925 #: ../df/virt-df.pod:48 ../libguestfs-1.11.19/df/virt-df.pod:48
2928 " # virt-df -d F14x64 -h\n"
2929 " Filesystem Size Used Available Use%\n"
2930 " F14x64:/dev/sda1 484M 66M 393M 14%\n"
2931 " F14x64:/dev/vg_f13x64/lv_root 7.4G 3.4G 4.0G 46%\n"
2936 #: ../df/virt-df.pod:53 ../libguestfs-1.11.19/df/virt-df.pod:53
2937 msgid "Show disk usage for a disk image file called C<test.img>:"
2941 #: ../df/virt-df.pod:55 ../libguestfs-1.11.19/df/virt-df.pod:55
2944 " $ virt-df -a test1.img\n"
2945 " Filesystem 1K-blocks Used Available Use%\n"
2946 " test1.img:/dev/sda1 99099 1551 92432 2%\n"
2951 #: ../df/virt-df.pod:106 ../libguestfs-1.11.19/df/virt-df.pod:106
2954 " virt-df --format=raw -a disk.img\n"
2959 #: ../df/virt-df.pod:110 ../libguestfs-1.11.19/df/virt-df.pod:110
2962 " virt-df --format=raw -a disk.img --format -a another.img\n"
2967 #: ../df/virt-df.pod:123 ../libguestfs-1.11.19/df/virt-df.pod:123
2968 msgid "Print sizes in human-readable format."
2972 #: ../df/virt-df.pod:125 ../libguestfs-1.11.19/df/virt-df.pod:125
2973 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
2977 #: ../df/virt-df.pod:127 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:155
2978 #: ../libguestfs-1.11.19/df/virt-df.pod:127
2979 #: ../libguestfs-1.11.19/fish/guestfish.pod:258
2980 #: ../libguestfs-1.11.19/fuse/guestmount.pod:155
2985 #: ../df/virt-df.pod:129 ../libguestfs-1.11.19/df/virt-df.pod:129
2990 #: ../df/virt-df.pod:131 ../libguestfs-1.11.19/df/virt-df.pod:131
2991 msgid "Print inodes instead of blocks."
2995 #: ../df/virt-df.pod:133 ../libguestfs-1.11.19/df/virt-df.pod:133
2996 msgid "B<--one-per-guest>"
3000 #: ../df/virt-df.pod:135 ../libguestfs-1.11.19/df/virt-df.pod:135
3002 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
3003 "disks from several guests to a single libguestfs appliance."
3007 #: ../df/virt-df.pod:138 ../libguestfs-1.11.19/df/virt-df.pod:138
3008 msgid "You might use this option in the following circumstances:"
3012 #: ../df/virt-df.pod:142 ../df/virt-df.pod:148 ../edit/virt-edit.pod:266
3013 #: ../edit/virt-edit.pod:271 ../edit/virt-edit.pod:276
3014 #: ../edit/virt-edit.pod:287 ../edit/virt-edit.pod:291
3015 #: ../examples/guestfs-recipes.pod:98 ../examples/guestfs-recipes.pod:102
3016 #: ../examples/guestfs-recipes.pod:106 ../examples/guestfs-recipes.pod:132
3017 #: ../examples/guestfs-recipes.pod:137 ../examples/guestfs-recipes.pod:227
3018 #: ../examples/guestfs-recipes.pod:231 ../examples/guestfs-recipes.pod:235
3019 #: ../examples/guestfs-recipes.pod:239 ../examples/guestfs-recipes.pod:243
3020 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
3021 #: ../fish/guestfish-actions.pod:385 ../fish/guestfish-actions.pod:393
3022 #: ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:407
3023 #: ../fish/guestfish-actions.pod:1099 ../fish/guestfish-actions.pod:1103
3024 #: ../fish/guestfish-actions.pod:1107 ../fish/guestfish-actions.pod:1111
3025 #: ../fish/guestfish-actions.pod:1119 ../fish/guestfish-actions.pod:1123
3026 #: ../fish/guestfish-actions.pod:1127 ../fish/guestfish-actions.pod:1137
3027 #: ../fish/guestfish-actions.pod:1141 ../fish/guestfish-actions.pod:1145
3028 #: ../fish/guestfish-actions.pod:1235 ../fish/guestfish-actions.pod:1239
3029 #: ../fish/guestfish-actions.pod:1244 ../fish/guestfish-actions.pod:1249
3030 #: ../fish/guestfish-actions.pod:1291 ../fish/guestfish-actions.pod:1295
3031 #: ../fish/guestfish-actions.pod:1300 ../fish/guestfish-actions.pod:1933
3032 #: ../fish/guestfish-actions.pod:1939 ../fish/guestfish-actions.pod:1947
3033 #: ../fish/guestfish-actions.pod:1954 ../fish/guestfish-actions.pod:1961
3034 #: ../fish/guestfish.pod:445 ../fish/guestfish.pod:449
3035 #: ../fish/guestfish.pod:453 ../fish/guestfish.pod:457
3036 #: ../inspector/virt-inspector.pod:384 ../inspector/virt-inspector.pod:388
3037 #: ../libguestfs-1.11.19/df/virt-df.pod:142
3038 #: ../libguestfs-1.11.19/df/virt-df.pod:148
3039 #: ../libguestfs-1.11.19/edit/virt-edit.pod:266
3040 #: ../libguestfs-1.11.19/edit/virt-edit.pod:271
3041 #: ../libguestfs-1.11.19/edit/virt-edit.pod:276
3042 #: ../libguestfs-1.11.19/edit/virt-edit.pod:287
3043 #: ../libguestfs-1.11.19/edit/virt-edit.pod:291
3044 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:98
3045 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:102
3046 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:106
3047 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:132
3048 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:137
3049 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:227
3050 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:231
3051 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:235
3052 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:239
3053 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:243
3054 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:13
3055 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:20
3056 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:385
3057 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:393
3058 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:400
3059 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:407
3060 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1099
3061 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1103
3062 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1107
3063 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1111
3064 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1119
3065 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1123
3066 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1127
3067 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1137
3068 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1141
3069 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1145
3070 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1235
3071 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1239
3072 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1244
3073 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1249
3074 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1291
3075 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1295
3076 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1300
3077 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1933
3078 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1939
3079 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1947
3080 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1954
3081 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1961
3082 #: ../libguestfs-1.11.19/fish/guestfish.pod:445
3083 #: ../libguestfs-1.11.19/fish/guestfish.pod:449
3084 #: ../libguestfs-1.11.19/fish/guestfish.pod:453
3085 #: ../libguestfs-1.11.19/fish/guestfish.pod:457
3086 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:384
3087 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:388
3088 #: ../libguestfs-1.11.19/resize/virt-resize.pod:282
3089 #: ../libguestfs-1.11.19/resize/virt-resize.pod:286
3090 #: ../libguestfs-1.11.19/resize/virt-resize.pod:295
3091 #: ../libguestfs-1.11.19/resize/virt-resize.pod:301
3092 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:15
3093 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:22
3094 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:583
3095 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:591
3096 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:598
3097 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:605
3098 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1662
3099 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1666
3100 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1670
3101 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1674
3102 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1682
3103 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1686
3104 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1690
3105 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1700
3106 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1704
3107 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1708
3108 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1846
3109 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1850
3110 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1855
3111 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1860
3112 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1921
3113 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1925
3114 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1930
3115 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2859
3116 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2865
3117 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2873
3118 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2880
3119 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2887
3120 #: ../libguestfs-1.11.19/src/guestfs.pod:388
3121 #: ../libguestfs-1.11.19/src/guestfs.pod:393
3122 #: ../libguestfs-1.11.19/src/guestfs.pod:398
3123 #: ../libguestfs-1.11.19/src/guestfs.pod:402
3124 #: ../libguestfs-1.11.19/src/guestfs.pod:407
3125 #: ../libguestfs-1.11.19/src/guestfs.pod:411
3126 #: ../libguestfs-1.11.19/src/guestfs.pod:416
3127 #: ../libguestfs-1.11.19/src/guestfs.pod:421
3128 #: ../libguestfs-1.11.19/src/guestfs.pod:1064
3129 #: ../libguestfs-1.11.19/src/guestfs.pod:1068
3130 #: ../libguestfs-1.11.19/src/guestfs.pod:1072
3131 #: ../libguestfs-1.11.19/src/guestfs.pod:1077
3132 #: ../libguestfs-1.11.19/src/guestfs.pod:1085
3133 #: ../libguestfs-1.11.19/src/guestfs.pod:1104
3134 #: ../libguestfs-1.11.19/src/guestfs.pod:1112
3135 #: ../libguestfs-1.11.19/src/guestfs.pod:1134
3136 #: ../libguestfs-1.11.19/src/guestfs.pod:1138
3137 #: ../libguestfs-1.11.19/src/guestfs.pod:1142
3138 #: ../libguestfs-1.11.19/src/guestfs.pod:1146
3139 #: ../libguestfs-1.11.19/src/guestfs.pod:1150
3140 #: ../libguestfs-1.11.19/src/guestfs.pod:1154
3141 #: ../libguestfs-1.11.19/src/guestfs.pod:1643
3142 #: ../libguestfs-1.11.19/src/guestfs.pod:1648
3143 #: ../libguestfs-1.11.19/src/guestfs.pod:1652
3144 #: ../libguestfs-1.11.19/src/guestfs.pod:1754
3145 #: ../libguestfs-1.11.19/src/guestfs.pod:1759
3146 #: ../libguestfs-1.11.19/src/guestfs.pod:1763
3147 #: ../libguestfs-1.11.19/src/guestfs.pod:1773
3148 #: ../libguestfs-1.11.19/src/guestfs.pod:2047
3149 #: ../libguestfs-1.11.19/src/guestfs.pod:2052
3150 #: ../libguestfs-1.11.19/src/guestfs.pod:2058
3151 #: ../libguestfs-1.11.19/src/guestfs.pod:2066
3152 #: ../libguestfs-1.11.19/src/guestfs.pod:2420
3153 #: ../libguestfs-1.11.19/src/guestfs.pod:2426
3154 #: ../libguestfs-1.11.19/src/guestfs.pod:2431
3155 #: ../libguestfs-1.11.19/src/guestfs.pod:2437
3156 #: ../libguestfs-1.11.19/src/guestfs.pod:2818
3157 #: ../libguestfs-1.11.19/src/guestfs.pod:2822
3158 #: ../libguestfs-1.11.19/src/guestfs.pod:2826
3159 #: ../libguestfs-1.11.19/src/guestfs.pod:2830
3160 #: ../libguestfs-1.11.19/src/guestfs.pod:2844
3161 #: ../libguestfs-1.11.19/src/guestfs.pod:2849
3162 #: ../libguestfs-1.11.19/src/guestfs.pod:3061
3163 #: ../libguestfs-1.11.19/src/guestfs.pod:3065
3164 #: ../libguestfs-1.11.19/src/guestfs.pod:3069
3165 #: ../libguestfs-1.11.19/src/guestfs.pod:3073 ../resize/virt-resize.pod:282
3166 #: ../resize/virt-resize.pod:286 ../resize/virt-resize.pod:295
3167 #: ../resize/virt-resize.pod:301 ../src/guestfs-actions.pod:15
3168 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583
3169 #: ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598
3170 #: ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1662
3171 #: ../src/guestfs-actions.pod:1666 ../src/guestfs-actions.pod:1670
3172 #: ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1682
3173 #: ../src/guestfs-actions.pod:1686 ../src/guestfs-actions.pod:1690
3174 #: ../src/guestfs-actions.pod:1700 ../src/guestfs-actions.pod:1704
3175 #: ../src/guestfs-actions.pod:1708 ../src/guestfs-actions.pod:1846
3176 #: ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855
3177 #: ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1921
3178 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1930
3179 #: ../src/guestfs-actions.pod:2859 ../src/guestfs-actions.pod:2865
3180 #: ../src/guestfs-actions.pod:2873 ../src/guestfs-actions.pod:2880
3181 #: ../src/guestfs-actions.pod:2887 ../src/guestfs.pod:388
3182 #: ../src/guestfs.pod:393 ../src/guestfs.pod:398 ../src/guestfs.pod:402
3183 #: ../src/guestfs.pod:407 ../src/guestfs.pod:411 ../src/guestfs.pod:416
3184 #: ../src/guestfs.pod:421 ../src/guestfs.pod:1064 ../src/guestfs.pod:1068
3185 #: ../src/guestfs.pod:1072 ../src/guestfs.pod:1077 ../src/guestfs.pod:1085
3186 #: ../src/guestfs.pod:1104 ../src/guestfs.pod:1112 ../src/guestfs.pod:1134
3187 #: ../src/guestfs.pod:1138 ../src/guestfs.pod:1142 ../src/guestfs.pod:1146
3188 #: ../src/guestfs.pod:1150 ../src/guestfs.pod:1154 ../src/guestfs.pod:1643
3189 #: ../src/guestfs.pod:1648 ../src/guestfs.pod:1652 ../src/guestfs.pod:1754
3190 #: ../src/guestfs.pod:1759 ../src/guestfs.pod:1763 ../src/guestfs.pod:1773
3191 #: ../src/guestfs.pod:2047 ../src/guestfs.pod:2052 ../src/guestfs.pod:2058
3192 #: ../src/guestfs.pod:2066 ../src/guestfs.pod:2420 ../src/guestfs.pod:2426
3193 #: ../src/guestfs.pod:2431 ../src/guestfs.pod:2437 ../src/guestfs.pod:2818
3194 #: ../src/guestfs.pod:2822 ../src/guestfs.pod:2826 ../src/guestfs.pod:2830
3195 #: ../src/guestfs.pod:2844 ../src/guestfs.pod:2849 ../src/guestfs.pod:3061
3196 #: ../src/guestfs.pod:3065 ../src/guestfs.pod:3069 ../src/guestfs.pod:3073
3197 #: ../tools/virt-win-reg.pl:197 ../tools/virt-win-reg.pl:202
3198 #: ../tools/virt-win-reg.pl:208 ../tools/virt-win-reg.pl:710
3199 #: ../tools/virt-win-reg.pl:716 ../tools/virt-win-reg.pl:722
3204 #: ../df/virt-df.pod:144 ../libguestfs-1.11.19/df/virt-df.pod:144
3206 "If you think an untrusted guest might actively try to exploit the libguestfs "
3207 "appliance kernel, then this prevents one guest from interfering with the "
3208 "stats printed for another guest."
3212 #: ../df/virt-df.pod:150 ../libguestfs-1.11.19/df/virt-df.pod:150
3214 "If the kernel has a bug which stops it from accessing a filesystem in one "
3215 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
3216 "and report stats for further guests."
3220 #: ../df/virt-df.pod:159 ../libguestfs-1.11.19/df/virt-df.pod:159
3222 "Print UUIDs instead of names. This is useful for following a guest even "
3223 "when the guest is migrated or renamed, or when two guests happen to have the "
3228 #: ../df/virt-df.pod:163 ../libguestfs-1.11.19/df/virt-df.pod:163
3230 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
3231 "images, we still print the disk image name even when this option is "
3236 #: ../df/virt-df.pod:218 ../libguestfs-1.11.19/df/virt-df.pod:218
3238 "L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<http://"
3243 #: ../edit/virt-edit.pod:5 ../libguestfs-1.11.19/edit/virt-edit.pod:5
3244 msgid "virt-edit - Edit a file in a virtual machine"
3248 #: ../edit/virt-edit.pod:9 ../libguestfs-1.11.19/edit/virt-edit.pod:9
3251 " virt-edit [--options] -d domname file [file ...]\n"
3256 #: ../edit/virt-edit.pod:11 ../libguestfs-1.11.19/edit/virt-edit.pod:11
3259 " virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
3264 #: ../edit/virt-edit.pod:13 ../libguestfs-1.11.19/edit/virt-edit.pod:13
3267 " virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
3272 #: ../edit/virt-edit.pod:17 ../libguestfs-1.11.19/edit/virt-edit.pod:17
3275 " virt-edit domname file\n"
3280 #: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
3281 #: ../libguestfs-1.11.19/edit/virt-edit.pod:19
3282 #: ../libguestfs-1.11.19/edit/virt-edit.pod:183
3285 " virt-edit disk.img [disk.img ...] file\n"
3290 #: ../edit/virt-edit.pod:21 ../fish/guestfish.pod:23
3291 #: ../fish/virt-copy-in.pod:13 ../fish/virt-tar-in.pod:15
3292 #: ../fuse/guestmount.pod:15 ../libguestfs-1.11.19/edit/virt-edit.pod:21
3293 #: ../libguestfs-1.11.19/fish/guestfish.pod:23
3294 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:13
3295 #: ../libguestfs-1.11.19/fish/virt-tar-in.pod:15
3296 #: ../libguestfs-1.11.19/fuse/guestmount.pod:15
3297 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:19
3298 #: ../rescue/virt-rescue.pod:19 ../tools/virt-tar.pl:64
3299 #: ../tools/virt-win-reg.pl:51
3304 #: ../edit/virt-edit.pod:23 ../libguestfs-1.11.19/edit/virt-edit.pod:23
3306 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
3307 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
3308 "doing this, but doesn't catch all cases."
3312 #: ../edit/virt-edit.pod:29 ../libguestfs-1.11.19/edit/virt-edit.pod:29
3314 "C<virt-edit> is a command line tool to edit C<file> where each C<file> "
3315 "exists in the named virtual machine (or disk image)."
3319 #: ../edit/virt-edit.pod:32 ../libguestfs-1.11.19/edit/virt-edit.pod:32
3321 "Multiple filenames can be given, in which case they are each edited in "
3322 "turn. Each filename must be a full path, starting at the root directory "
3323 "(starting with '/')."
3327 #: ../edit/virt-edit.pod:36 ../libguestfs-1.11.19/edit/virt-edit.pod:36
3328 msgid "If you want to just view a file, use L<virt-cat(1)>."
3332 #: ../edit/virt-edit.pod:38 ../libguestfs-1.11.19/edit/virt-edit.pod:38
3334 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
3335 "USING GUESTFISH> below)."
3339 #: ../edit/virt-edit.pod:41 ../libguestfs-1.11.19/edit/virt-edit.pod:41
3341 "C<virt-edit> cannot be used to create a new file. L<guestfish(1)> can do "
3342 "that and much more."
3346 #: ../edit/virt-edit.pod:46 ../libguestfs-1.11.19/edit/virt-edit.pod:46
3347 msgid "Edit the named files interactively:"
3351 #: ../edit/virt-edit.pod:48 ../libguestfs-1.11.19/edit/virt-edit.pod:48
3354 " virt-edit -d mydomain /boot/grub/grub.conf\n"
3359 #: ../edit/virt-edit.pod:50 ../libguestfs-1.11.19/edit/virt-edit.pod:50
3362 " virt-edit -d mydomain /etc/passwd\n"
3367 #: ../edit/virt-edit.pod:52 ../libguestfs-1.11.19/edit/virt-edit.pod:52
3368 msgid "For Windows guests, some Windows paths are understood:"
3372 #: ../edit/virt-edit.pod:54 ../libguestfs-1.11.19/edit/virt-edit.pod:54
3375 " virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
3380 #: ../edit/virt-edit.pod:56 ../libguestfs-1.11.19/edit/virt-edit.pod:56
3382 "If Perl is installed, you can also edit files non-interactively (see L</NON-"
3383 "INTERACTIVE EDITING> below). To change the init default level to 5:"
3387 #: ../edit/virt-edit.pod:60 ../libguestfs-1.11.19/edit/virt-edit.pod:60
3390 " virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
3395 #: ../edit/virt-edit.pod:81 ../libguestfs-1.11.19/edit/virt-edit.pod:81
3396 msgid "B<-b> extension"
3400 #: ../edit/virt-edit.pod:83 ../libguestfs-1.11.19/edit/virt-edit.pod:83
3401 msgid "B<--backup> extension"
3405 #: ../edit/virt-edit.pod:85 ../libguestfs-1.11.19/edit/virt-edit.pod:85
3407 "Create a backup of the original file I<in the guest disk image>. The backup "
3408 "has the original filename with C<extension> added."
3412 #: ../edit/virt-edit.pod:88 ../libguestfs-1.11.19/edit/virt-edit.pod:88
3414 "Usually the first character of C<extension> would be a dot C<.> so you would "
3419 #: ../edit/virt-edit.pod:91 ../libguestfs-1.11.19/edit/virt-edit.pod:91
3422 " virt-edit -b .orig [etc]\n"
3427 #: ../edit/virt-edit.pod:93 ../libguestfs-1.11.19/edit/virt-edit.pod:93
3428 msgid "By default, no backup file is made."
3432 #: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181
3433 #: ../fuse/guestmount.pod:96 ../inspector/virt-inspector.pod:74
3434 #: ../libguestfs-1.11.19/edit/virt-edit.pod:95
3435 #: ../libguestfs-1.11.19/fish/guestfish.pod:181
3436 #: ../libguestfs-1.11.19/fuse/guestmount.pod:96
3437 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:74
3438 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78
3439 #: ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
3444 #: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183
3445 #: ../fuse/guestmount.pod:98 ../inspector/virt-inspector.pod:76
3446 #: ../libguestfs-1.11.19/edit/virt-edit.pod:97
3447 #: ../libguestfs-1.11.19/fish/guestfish.pod:183
3448 #: ../libguestfs-1.11.19/fuse/guestmount.pod:98
3449 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:76
3450 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80
3451 #: ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
3452 msgid "B<--connect URI>"
3456 #: ../edit/virt-edit.pod:102 ../libguestfs-1.11.19/edit/virt-edit.pod:102
3457 #: ../tools/virt-list-filesystems.pl:84 ../tools/virt-list-partitions.pl:85
3458 #: ../tools/virt-tar.pl:134 ../tools/virt-win-reg.pl:135
3460 "If you specify guest block devices directly, then libvirt is not used at all."
3464 #: ../edit/virt-edit.pod:114 ../libguestfs-1.11.19/edit/virt-edit.pod:114
3466 "When prompting for keys and passphrases, virt-edit normally turns echoing "
3467 "off so you cannot see what you are typing. If you are not worried about "
3468 "Tempest attacks and there is no one else in the room you can specify this "
3469 "flag to see what you are typing."
3473 #: ../edit/virt-edit.pod:119 ../libguestfs-1.11.19/edit/virt-edit.pod:119
3478 #: ../edit/virt-edit.pod:121 ../libguestfs-1.11.19/edit/virt-edit.pod:121
3479 msgid "B<--expr> EXPR"
3483 #: ../edit/virt-edit.pod:123 ../libguestfs-1.11.19/edit/virt-edit.pod:123
3485 "Instead of launching the external editor, non-interactively apply the Perl "
3486 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
3491 #: ../edit/virt-edit.pod:127 ../libguestfs-1.11.19/edit/virt-edit.pod:127
3493 "Be careful to properly quote the expression to prevent it from being altered "
3498 #: ../edit/virt-edit.pod:130 ../libguestfs-1.11.19/edit/virt-edit.pod:130
3499 msgid "Note that this option is only available when Perl 5 is installed."
3503 #: ../edit/virt-edit.pod:132 ../libguestfs-1.11.19/edit/virt-edit.pod:132
3504 msgid "B<--format> raw|qcow2|..."
3508 #: ../edit/virt-edit.pod:143 ../libguestfs-1.11.19/edit/virt-edit.pod:143
3511 " virt-edit --format=raw -a disk.img file\n"
3516 #: ../edit/virt-edit.pod:147 ../libguestfs-1.11.19/edit/virt-edit.pod:147
3519 " virt-edit --format=raw -a disk.img --format -a another.img file\n"
3524 #: ../edit/virt-edit.pod:181 ../libguestfs-1.11.19/edit/virt-edit.pod:181
3525 msgid "Previous versions of virt-edit allowed you to write either:"
3529 #: ../edit/virt-edit.pod:187 ../libguestfs-1.11.19/edit/virt-edit.pod:187
3532 " virt-edit guestname file\n"
3537 #: ../edit/virt-edit.pod:195 ../libguestfs-1.11.19/edit/virt-edit.pod:195
3538 msgid "NON-INTERACTIVE EDITING"
3542 #: ../edit/virt-edit.pod:197 ../libguestfs-1.11.19/edit/virt-edit.pod:197
3544 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
3545 "administrator can interactively edit the file."
3549 #: ../edit/virt-edit.pod:200 ../libguestfs-1.11.19/edit/virt-edit.pod:200
3551 "There are two ways also to use C<virt-edit> from scripts in order to make "
3552 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
3553 "like this, it's less error-prone to write scripts directly using the "
3554 "libguestfs API and Augeas for configuration file editing.)"
3558 #: ../edit/virt-edit.pod:206 ../libguestfs-1.11.19/edit/virt-edit.pod:206
3560 "The first method is to temporarily set C<$EDITOR> to any script or program "
3561 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
3562 "update C<tmpfile> in place however it likes."
3566 #: ../edit/virt-edit.pod:210 ../libguestfs-1.11.19/edit/virt-edit.pod:210
3568 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
3569 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
3570 "instances of C<foo> with C<bar> in a file:"
3574 #: ../edit/virt-edit.pod:214 ../libguestfs-1.11.19/edit/virt-edit.pod:214
3577 " virt-edit -d domname filename -e 's/foo/bar/'\n"
3582 #: ../edit/virt-edit.pod:216 ../libguestfs-1.11.19/edit/virt-edit.pod:216
3584 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
3585 "For example to delete root's password you could do:"
3589 #: ../edit/virt-edit.pod:219 ../libguestfs-1.11.19/edit/virt-edit.pod:219
3592 " virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
3597 #: ../edit/virt-edit.pod:221 ../libguestfs-1.11.19/edit/virt-edit.pod:221
3599 "What really happens is that the snippet is evaluated as a Perl expression "
3600 "for each line of the file. The line, including the final C<\\n>, is passed "
3601 "in C<$_> and the expression should update C<$_> or leave it unchanged."
3605 #: ../edit/virt-edit.pod:226 ../libguestfs-1.11.19/edit/virt-edit.pod:226
3607 "To delete a line, set C<$_> to the empty string. For example, to delete the "
3608 "C<apache> user account from the password file you can do:"
3612 #: ../edit/virt-edit.pod:229 ../libguestfs-1.11.19/edit/virt-edit.pod:229
3615 " virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
3620 #: ../edit/virt-edit.pod:231 ../libguestfs-1.11.19/edit/virt-edit.pod:231
3622 "To insert a line, prepend or append it to C<$_>. However appending lines to "
3623 "the end of the file is rather difficult this way since there is no concept "
3624 "of \"last line of the file\" - your expression just doesn't get called "
3625 "again. You might want to use the first method (setting C<$EDITOR>) if you "
3630 #: ../edit/virt-edit.pod:237 ../libguestfs-1.11.19/edit/virt-edit.pod:237
3632 "The variable C<$lineno> contains the current line number. As is "
3633 "traditional, the first line in the file is number C<1>."
3637 #: ../edit/virt-edit.pod:240 ../libguestfs-1.11.19/edit/virt-edit.pod:240
3639 "The return value from the expression is ignored, but the expression may call "
3640 "C<die> in order to abort the whole program, leaving the original file "
3645 #: ../edit/virt-edit.pod:244 ../libguestfs-1.11.19/edit/virt-edit.pod:244
3647 "Remember when matching the end of a line that C<$_> may contain the final C<"
3648 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
3649 "newline then neither of these. Thus to match or substitute some text at the "
3650 "end of a line, use this regular expression:"
3654 #: ../edit/virt-edit.pod:249 ../libguestfs-1.11.19/edit/virt-edit.pod:249
3657 " /some text(\\r?\\n)?$/\n"
3662 #: ../edit/virt-edit.pod:251 ../libguestfs-1.11.19/edit/virt-edit.pod:251
3664 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
3665 "$_> itself (since that would remove all newlines from the file):"
3669 #: ../edit/virt-edit.pod:255 ../libguestfs-1.11.19/edit/virt-edit.pod:255
3672 " my $m = $_; chomp $m; $m =~ /some text$/\n"
3677 #: ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
3678 #: ../libguestfs-1.11.19/edit/virt-edit.pod:257
3679 #: ../libguestfs-1.11.19/fish/guestfish.pod:858
3680 msgid "WINDOWS PATHS"
3684 #: ../edit/virt-edit.pod:259 ../libguestfs-1.11.19/edit/virt-edit.pod:259
3686 "C<virt-edit> has a limited ability to understand Windows drive letters and "
3687 "paths (eg. C<E:\\foo\\bar.txt>)."
3691 #: ../edit/virt-edit.pod:262 ../libguestfs-1.11.19/edit/virt-edit.pod:262
3692 msgid "If and only if the guest is running Windows then:"
3696 #: ../edit/virt-edit.pod:268 ../libguestfs-1.11.19/edit/virt-edit.pod:268
3698 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
3699 "to the correct filesystem."
3703 #: ../edit/virt-edit.pod:273 ../libguestfs-1.11.19/edit/virt-edit.pod:273
3705 "Any backslash (C<\\>) characters in the path are replaced with forward "
3706 "slashes so that libguestfs can process it."
3710 #: ../edit/virt-edit.pod:278 ../libguestfs-1.11.19/edit/virt-edit.pod:278
3712 "The path is resolved case insensitively to locate the file that should be "
3717 #: ../edit/virt-edit.pod:283 ../libguestfs-1.11.19/edit/virt-edit.pod:283
3718 msgid "There are some known shortcomings:"
3722 #: ../edit/virt-edit.pod:289 ../libguestfs-1.11.19/edit/virt-edit.pod:289
3723 msgid "Some NTFS symbolic links may not be followed correctly."
3727 #: ../edit/virt-edit.pod:293 ../libguestfs-1.11.19/edit/virt-edit.pod:293
3728 msgid "NTFS junction points that cross filesystems are not followed."
3732 #: ../edit/virt-edit.pod:299 ../libguestfs-1.11.19/edit/virt-edit.pod:299
3734 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
3735 "C<virt-edit> doesn't work."
3739 #: ../edit/virt-edit.pod:302 ../libguestfs-1.11.19/edit/virt-edit.pod:302
3740 msgid "Using C<virt-edit> is approximately equivalent to doing:"
3744 #: ../edit/virt-edit.pod:304 ../libguestfs-1.11.19/edit/virt-edit.pod:304
3747 " guestfish --rw -i -d domname edit /file\n"
3752 #: ../edit/virt-edit.pod:306 ../libguestfs-1.11.19/edit/virt-edit.pod:306
3754 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
3759 #: ../edit/virt-edit.pod:309 ../libguestfs-1.11.19/edit/virt-edit.pod:309
3761 "The command above uses libguestfs's guest inspection feature and so does not "
3762 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
3763 "disk images that don't contain guests. To edit a file on a disk image "
3768 #: ../edit/virt-edit.pod:314 ../libguestfs-1.11.19/edit/virt-edit.pod:314
3771 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
3776 #: ../edit/virt-edit.pod:316 ../libguestfs-1.11.19/edit/virt-edit.pod:316
3778 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
3779 "the disk image to edit, and C</file> is the full path to the file."
3783 #: ../edit/virt-edit.pod:320 ../libguestfs-1.11.19/edit/virt-edit.pod:320
3785 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
3786 "C<write> or C<upload> instead:"
3790 #: ../edit/virt-edit.pod:323 ../libguestfs-1.11.19/edit/virt-edit.pod:323
3793 " guestfish --rw -i -d domname touch /newfile\n"
3798 #: ../edit/virt-edit.pod:325 ../libguestfs-1.11.19/edit/virt-edit.pod:325
3801 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
3806 #: ../edit/virt-edit.pod:327 ../libguestfs-1.11.19/edit/virt-edit.pod:327
3809 " guestfish --rw -i -d domname upload localfile /newfile\n"
3814 #: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1075
3815 #: ../libguestfs-1.11.19/edit/virt-edit.pod:329
3816 #: ../libguestfs-1.11.19/fish/guestfish.pod:1075
3817 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:257
3818 #: ../libguestfs-1.11.19/src/guestfs.pod:2960
3819 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:82
3820 #: ../rescue/virt-rescue.pod:257 ../src/guestfs.pod:2960
3821 #: ../test-tool/libguestfs-test-tool.pod:82
3822 msgid "ENVIRONMENT VARIABLES"
3826 #: ../edit/virt-edit.pod:333 ../libguestfs-1.11.19/edit/virt-edit.pod:333
3831 #: ../edit/virt-edit.pod:335 ../libguestfs-1.11.19/edit/virt-edit.pod:335
3833 "If set, this string is used as the editor. It may contain arguments, eg. C<"
3838 #: ../edit/virt-edit.pod:338 ../libguestfs-1.11.19/edit/virt-edit.pod:338
3839 msgid "If not set, C<vi> is used."
3843 #: ../edit/virt-edit.pod:351 ../libguestfs-1.11.19/edit/virt-edit.pod:351
3845 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
3846 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
3847 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
3851 #: ../examples/guestfs-examples.pod:5
3852 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:5
3853 msgid "guestfs-examples - Examples of using libguestfs from C"
3857 #: ../examples/guestfs-examples.pod:9
3858 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:9
3859 #: ../libguestfs-1.11.19/src/guestfs.pod:9 ../src/guestfs.pod:9
3862 " #include <guestfs.h>\n"
3867 #: ../examples/guestfs-examples.pod:11
3868 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:11
3871 " guestfs_h *g = guestfs_create ();\n"
3872 " guestfs_add_drive_ro (g, \"disk.img\");\n"
3873 " guestfs_launch (g);\n"
3878 #: ../examples/guestfs-examples.pod:15
3879 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:15
3880 #: ../libguestfs-1.11.19/src/guestfs.pod:19 ../src/guestfs.pod:19
3883 " cc prog.c -o prog -lguestfs\n"
3885 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
3890 #: ../examples/guestfs-examples.pod:21
3891 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:21
3893 "This manual page contains examples of calling libguestfs from the C "
3894 "programming language. If you are not familiar with using libguestfs, you "
3895 "also need to read L<guestfs(3)>."
3899 #: ../examples/guestfs-examples.pod:25
3900 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:25
3901 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:70
3902 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:31
3903 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:34
3904 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:28
3905 #: ../ocaml/examples/guestfs-ocaml.pod:70 ../perl/examples/guestfs-perl.pod:31
3906 #: ../python/examples/guestfs-python.pod:34
3907 #: ../ruby/examples/guestfs-ruby.pod:28
3908 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
3912 #: ../examples/guestfs-examples.pod:27
3913 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:27
3914 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:72
3915 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:33
3916 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:36
3917 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:30
3918 #: ../ocaml/examples/guestfs-ocaml.pod:72 ../perl/examples/guestfs-perl.pod:33
3919 #: ../python/examples/guestfs-python.pod:36
3920 #: ../ruby/examples/guestfs-ruby.pod:30
3925 #: ../examples/guestfs-examples.pod:29
3926 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:29
3927 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:74
3928 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:35
3929 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:38
3930 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:32
3931 #: ../ocaml/examples/guestfs-ocaml.pod:74 ../perl/examples/guestfs-perl.pod:35
3932 #: ../python/examples/guestfs-python.pod:38
3933 #: ../ruby/examples/guestfs-ruby.pod:32
3934 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
3938 #: ../examples/guestfs-examples.pod:31
3939 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:31
3940 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:76
3941 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:37
3942 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:40
3943 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:34
3944 #: ../ocaml/examples/guestfs-ocaml.pod:76 ../perl/examples/guestfs-perl.pod:37
3945 #: ../python/examples/guestfs-python.pod:40
3946 #: ../ruby/examples/guestfs-ruby.pod:34
3951 #: ../examples/guestfs-examples.pod:35
3952 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:35
3954 "L<guestfs(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)"
3955 ">, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
3959 #: ../examples/guestfs-examples.pod:43 ../examples/guestfs-recipes.pod:395
3960 #: ../fish/guestfish.pod:1238 ../fish/virt-copy-in.pod:60
3961 #: ../fish/virt-copy-out.pod:49 ../fish/virt-tar-in.pod:58
3962 #: ../fish/virt-tar-out.pod:51 ../fuse/guestmount.pod:314
3963 #: ../inspector/virt-inspector.pod:380
3964 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:43
3965 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:395
3966 #: ../libguestfs-1.11.19/fish/guestfish.pod:1238
3967 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:60
3968 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:49
3969 #: ../libguestfs-1.11.19/fish/virt-tar-in.pod:58
3970 #: ../libguestfs-1.11.19/fish/virt-tar-out.pod:51
3971 #: ../libguestfs-1.11.19/fuse/guestmount.pod:314
3972 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:380
3973 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:89
3974 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:50
3975 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:52
3976 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:46
3977 #: ../libguestfs-1.11.19/src/guestfs.pod:3080
3978 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:93
3979 #: ../ocaml/examples/guestfs-ocaml.pod:89 ../perl/examples/guestfs-perl.pod:50
3980 #: ../python/examples/guestfs-python.pod:52
3981 #: ../ruby/examples/guestfs-ruby.pod:46 ../src/guestfs.pod:3080
3982 #: ../test-tool/libguestfs-test-tool.pod:93
3987 #: ../examples/guestfs-examples.pod:45 ../examples/guestfs-recipes.pod:397
3988 #: ../fish/guestfish.pod:1240 ../fish/virt-copy-in.pod:62
3989 #: ../fish/virt-copy-out.pod:51 ../fish/virt-tar-in.pod:60
3990 #: ../fish/virt-tar-out.pod:53 ../fuse/guestmount.pod:316
3991 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:45
3992 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:397
3993 #: ../libguestfs-1.11.19/fish/guestfish.pod:1240
3994 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:62
3995 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:51
3996 #: ../libguestfs-1.11.19/fish/virt-tar-in.pod:60
3997 #: ../libguestfs-1.11.19/fish/virt-tar-out.pod:53
3998 #: ../libguestfs-1.11.19/fuse/guestmount.pod:316
3999 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:91
4000 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:52
4001 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:54
4002 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:48
4003 #: ../libguestfs-1.11.19/src/guestfs.pod:3082
4004 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:95
4005 #: ../ocaml/examples/guestfs-ocaml.pod:91 ../perl/examples/guestfs-perl.pod:52
4006 #: ../python/examples/guestfs-python.pod:54
4007 #: ../ruby/examples/guestfs-ruby.pod:48 ../src/guestfs.pod:3082
4008 #: ../test-tool/libguestfs-test-tool.pod:95
4009 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4013 #: ../examples/guestfs-examples.pod:49
4014 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:49
4015 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:95
4016 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:58
4017 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:52
4018 #: ../ocaml/examples/guestfs-ocaml.pod:95
4019 #: ../python/examples/guestfs-python.pod:58
4020 #: ../ruby/examples/guestfs-ruby.pod:52
4021 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
4025 #: ../examples/guestfs-examples.pod:51 ../examples/guestfs-recipes.pod:403
4026 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:51
4027 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:403
4028 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:97
4029 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:58
4030 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:60
4031 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:54
4032 #: ../ocaml/examples/guestfs-ocaml.pod:97 ../perl/examples/guestfs-perl.pod:58
4033 #: ../python/examples/guestfs-python.pod:60
4034 #: ../ruby/examples/guestfs-ruby.pod:54
4036 "The examples in this manual page may be freely copied, modified and "
4037 "distributed without any restrictions."
4041 #: ../examples/guestfs-examples.pod:54 ../examples/guestfs-recipes.pod:406
4042 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:54
4043 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:406
4044 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:100
4045 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:61
4046 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:63
4047 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:57
4048 #: ../libguestfs-1.11.19/src/guestfs.pod:3089
4049 #: ../ocaml/examples/guestfs-ocaml.pod:100
4050 #: ../perl/examples/guestfs-perl.pod:61
4051 #: ../python/examples/guestfs-python.pod:63
4052 #: ../ruby/examples/guestfs-ruby.pod:57 ../src/guestfs.pod:3089
4054 "This library is free software; you can redistribute it and/or modify it "
4055 "under the terms of the GNU Lesser General Public License as published by the "
4056 "Free Software Foundation; either version 2 of the License, or (at your "
4057 "option) any later version."
4061 #: ../examples/guestfs-examples.pod:59 ../examples/guestfs-recipes.pod:411
4062 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:59
4063 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:411
4064 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:105
4065 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:66
4066 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:68
4067 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:62
4068 #: ../libguestfs-1.11.19/src/guestfs.pod:3094
4069 #: ../ocaml/examples/guestfs-ocaml.pod:105
4070 #: ../perl/examples/guestfs-perl.pod:66
4071 #: ../python/examples/guestfs-python.pod:68
4072 #: ../ruby/examples/guestfs-ruby.pod:62 ../src/guestfs.pod:3094
4074 "This library is distributed in the hope that it will be useful, but WITHOUT "
4075 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4076 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4081 #: ../examples/guestfs-examples.pod:64 ../examples/guestfs-recipes.pod:416
4082 #: ../libguestfs-1.11.19/examples/guestfs-examples.pod:64
4083 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:416
4084 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:110
4085 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:71
4086 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:73
4087 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:67
4088 #: ../libguestfs-1.11.19/src/guestfs.pod:3099
4089 #: ../ocaml/examples/guestfs-ocaml.pod:110
4090 #: ../perl/examples/guestfs-perl.pod:71
4091 #: ../python/examples/guestfs-python.pod:73
4092 #: ../ruby/examples/guestfs-ruby.pod:67 ../src/guestfs.pod:3099
4094 "You should have received a copy of the GNU Lesser General Public License "
4095 "along with this library; if not, write to the Free Software Foundation, "
4096 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4100 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
4101 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:3
4102 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:12
4107 #: ../examples/guestfs-recipes.pod:5
4108 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:5
4110 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
4111 "here. The only way which works for both sorts of output is to just write "
4112 "the URL directly. Do NOT use L<...> for URLs."
4116 #: ../examples/guestfs-recipes.pod:9
4117 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:9
4119 "We break with tradition here and don't use ALL CAPS for the section "
4120 "headings, as this makes them much easier to read."
4124 #: ../examples/guestfs-recipes.pod:16
4125 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:16
4126 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
4130 #: ../examples/guestfs-recipes.pod:20
4131 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:20
4133 "This page contains recipes for and links to things you can do using "
4134 "libguestfs, L<guestfish(1)> and the virt tools."
4138 #: ../examples/guestfs-recipes.pod:23
4139 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:23
4140 msgid "Audit a virtual machine for setuid files"
4144 #: ../examples/guestfs-recipes.pod:25
4145 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:25
4147 "The link below contains a small program which can be used to audit a Linux "
4148 "virtual machine to see what setuid and setgid files it contains."
4152 #: ../examples/guestfs-recipes.pod:28
4153 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:28
4155 "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-"
4160 #: ../examples/guestfs-recipes.pod:30
4161 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:30
4162 msgid "Change the background image in a Windows XP VM"
4166 #: ../examples/guestfs-recipes.pod:32
4167 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:32
4169 "The links below explain how to use L<guestfish(1)> to change the background "
4170 "image for a user of a Windows XP VM. Unfortunately the technique appears to "
4171 "be substantially different for each version of Windows."
4175 #: ../examples/guestfs-recipes.pod:37
4176 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:37
4178 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html https://"
4179 "lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
4183 #: ../examples/guestfs-recipes.pod:40
4184 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:40
4185 msgid "Cloning a virtual machine (Linux)"
4189 #: ../examples/guestfs-recipes.pod:42
4190 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:42
4192 "The guestfish technique described in the link below works well for most "
4193 "Linux VMs. Depending on the Linux distro you may need to change the paths "
4198 #: ../examples/guestfs-recipes.pod:46
4199 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:46
4201 "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-"
4206 #: ../examples/guestfs-recipes.pod:48
4207 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:48
4209 "Avoid L<virt-clone(1)>. Currently what to do about virt-clone is under "
4214 #: ../examples/guestfs-recipes.pod:51
4215 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:51
4216 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
4220 #: ../examples/guestfs-recipes.pod:53
4221 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:53
4222 msgid "Cloning a virtual machine (Windows)"
4226 #: ../examples/guestfs-recipes.pod:55
4227 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:55
4229 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
4230 "straightforward. Currently there is code in the Aeolus Oz project which "
4231 "does this (using libguestfs). As part of our review of the virt-clone tool, "
4232 "we may add sysprepping ability."
4236 #: ../examples/guestfs-recipes.pod:60
4237 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:60
4239 "https://github.com/clalancette/oz https://www.redhat.com/archives/virt-tools-"
4240 "list/2011-May/msg00019.html"
4244 #: ../examples/guestfs-recipes.pod:63
4245 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:63
4246 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
4250 #: ../examples/guestfs-recipes.pod:65
4251 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:65
4252 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
4256 #: ../examples/guestfs-recipes.pod:67
4257 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:67
4260 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
4265 #: ../examples/guestfs-recipes.pod:69
4266 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:69
4267 msgid "To export just a subdirectory, eg. C</files>, do:"
4271 #: ../examples/guestfs-recipes.pod:71
4272 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:71
4275 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
4280 #: ../examples/guestfs-recipes.pod:73
4281 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:73
4282 msgid "Create empty disk images"
4286 #: ../examples/guestfs-recipes.pod:75
4287 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:75
4289 "You can use the L<guestfish(1)> I<-N> option to create empty disk images. "
4290 "The useful guide below explains the options available."
4294 #: ../examples/guestfs-recipes.pod:78
4295 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:78
4297 "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/"
4302 #: ../examples/guestfs-recipes.pod:80
4303 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:80
4304 msgid "Dump raw filesystem content from inside a disk image or VM"
4308 #: ../examples/guestfs-recipes.pod:82
4309 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:82
4311 "You can use the L<guestfish(1)> C<download> command to extract the raw "
4312 "filesystem content from any filesystem in a disk image or a VM (even one "
4313 "which is encrypted or buried inside an LV):"
4317 #: ../examples/guestfs-recipes.pod:86
4318 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:86
4321 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
4326 #: ../examples/guestfs-recipes.pod:88
4327 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:88
4330 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
4335 #: ../examples/guestfs-recipes.pod:90
4336 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:90
4337 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
4341 #: ../examples/guestfs-recipes.pod:92
4342 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:92
4343 msgid "Edit grub configuration in a VM"
4347 #: ../examples/guestfs-recipes.pod:94
4348 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:94
4349 msgid "You can use this to:"
4353 #: ../examples/guestfs-recipes.pod:100
4354 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:100
4355 msgid "Fix a virtual machine that does not boot."
4359 #: ../examples/guestfs-recipes.pod:104
4360 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:104
4361 msgid "Change which kernel is used to boot the VM."
4365 #: ../examples/guestfs-recipes.pod:108
4366 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:108
4367 msgid "Change kernel command line options."
4371 #: ../examples/guestfs-recipes.pod:112
4372 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:112
4373 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
4377 #: ../examples/guestfs-recipes.pod:114
4378 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:114
4381 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
4386 #: ../examples/guestfs-recipes.pod:116
4387 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:116
4389 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
4394 #: ../examples/guestfs-recipes.pod:119
4395 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:119
4398 " virt-rescue -d BrokenGuest\n"
4403 #: ../examples/guestfs-recipes.pod:121
4404 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:121
4405 msgid "Export any directory from a VM"
4409 #: ../examples/guestfs-recipes.pod:123
4410 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:123
4412 "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
4416 #: ../examples/guestfs-recipes.pod:126
4417 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:126
4420 " virt-copy-out -d Guest /home .\n"
4425 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9
4426 #: ../fish/guestfish-actions.pod:1287 ../fish/guestfish-actions.pod:1929
4427 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:128
4428 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:9
4429 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1287
4430 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1929
4431 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:11
4432 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1917
4433 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2855
4434 #: ../libguestfs-1.11.19/src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
4435 #: ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:2855
4436 #: ../src/guestfs.pod:1639 ../tools/virt-win-reg.pl:706
4441 #: ../examples/guestfs-recipes.pod:134
4442 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:134
4444 "The final dot of the command is not a printing error. It means we want to "
4445 "copy out to the current directory."
4449 #: ../examples/guestfs-recipes.pod:139
4450 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:139
4451 msgid "This creates a directory called C<home> under the current directory."
4455 #: ../examples/guestfs-recipes.pod:143
4456 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:143
4458 "If the guest is a Windows guest then you can use drive letters and "
4459 "backslashes, but you must prefix the path with C<win:> and quote it to "
4460 "protect it from the shell, like this:"
4464 #: ../examples/guestfs-recipes.pod:147
4465 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:147
4468 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
4473 #: ../examples/guestfs-recipes.pod:149
4474 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:149
4475 msgid "To get the output as a compressed tarball, do:"
4479 #: ../examples/guestfs-recipes.pod:151
4480 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:151
4483 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
4488 #: ../examples/guestfs-recipes.pod:153
4489 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:153
4491 "Although it sounds tempting, this is usually not a reliable way to get a "
4492 "backup from a running guest. See the entry in the FAQ: http://libguestfs."
4493 "org/FAQ.html#backup"
4497 #: ../examples/guestfs-recipes.pod:157
4498 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:157
4499 msgid "Find out which user is using the most space"
4503 #: ../examples/guestfs-recipes.pod:159
4504 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:159
4506 "This simple script examines a Linux guest to find out which user is using "
4507 "the most space in their home directory:"
4511 #: ../examples/guestfs-recipes.pod:162
4512 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:162
4520 #: ../examples/guestfs-recipes.pod:164
4521 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:164
4529 #: ../examples/guestfs-recipes.pod:166
4530 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:166
4539 #: ../examples/guestfs-recipes.pod:169
4540 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:169
4543 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
4548 #: ../examples/guestfs-recipes.pod:171
4549 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:171
4552 " for d in $(guestfish --remote ls \"$dir\"); do\n"
4553 " echo -n \"$dir/$d\"\n"
4555 " guestfish --remote du \"$dir/$d\";\n"
4556 " done | sort -nr -k 2\n"
4561 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
4562 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:177
4563 #: ../libguestfs-1.11.19/fish/guestfish.pod:941
4566 " guestfish --remote exit\n"
4571 #: ../examples/guestfs-recipes.pod:179
4572 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:179
4573 msgid "Get DHCP address from a VM"
4577 #: ../examples/guestfs-recipes.pod:181
4578 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:181
4580 "The link below explains the many different possible techniques for getting "
4581 "the last assigned DHCP address of a virtual machine."
4585 #: ../examples/guestfs-recipes.pod:184
4586 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:184
4588 "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-"
4589 "a-virtual-machine-disk-image/#content"
4593 #: ../examples/guestfs-recipes.pod:186
4594 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:186
4596 "In the libguestfs source examples directory you will find the latest version "
4597 "of the C<virt-dhcp-address.c> program."
4601 #: ../examples/guestfs-recipes.pod:189
4602 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:189
4603 msgid "Get the operating system product name string"
4607 #: ../examples/guestfs-recipes.pod:191
4608 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:191
4609 msgid "Save the following script into a file called C<product-name.sh>:"
4613 #: ../examples/guestfs-recipes.pod:193
4614 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:193
4619 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
4620 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
4621 " guestfish --remote inspect-get-product-name \"$root\"\n"
4622 " guestfish --remote exit\n"
4627 #: ../examples/guestfs-recipes.pod:200
4628 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:200
4629 msgid "Make the script executable and run it on a named guest:"
4633 #: ../examples/guestfs-recipes.pod:202
4634 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:202
4637 " # product-name.sh RHEL60x64\n"
4638 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
4643 #: ../examples/guestfs-recipes.pod:205
4644 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:205
4646 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
4647 "C<xpath> command line tool or from your favourite programming language:"
4651 #: ../examples/guestfs-recipes.pod:209
4652 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:209
4655 " # virt-inspector RHEL60x64 > xml\n"
4656 " # xpath '//product_name' < xml\n"
4659 " <product_name>Red Hat Enterprise Linux Server release 6.0 (Santiago)</product_name>\n"
4664 #: ../examples/guestfs-recipes.pod:215
4665 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:215
4666 msgid "Get the default boot kernel for a Linux VM"
4670 #: ../examples/guestfs-recipes.pod:217
4671 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:217
4673 "The link below contains a program to print the default boot kernel for a "
4678 #: ../examples/guestfs-recipes.pod:220
4679 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:220
4681 "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-"
4682 "kernel-for-a-vm/#content"
4686 #: ../examples/guestfs-recipes.pod:222
4687 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:222
4689 "It uses Augeas, and the technique is generally applicable for many different "
4694 #: ../examples/guestfs-recipes.pod:229
4695 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:229
4696 msgid "listing the user accounts in the guest"
4700 #: ../examples/guestfs-recipes.pod:233
4701 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:233
4702 msgid "what repositories is it configured to use"
4706 #: ../examples/guestfs-recipes.pod:237
4707 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:237
4708 msgid "what NTP servers does it connect to"
4712 #: ../examples/guestfs-recipes.pod:241
4713 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:241
4714 msgid "what were the boot messages last time it booted"
4718 #: ../examples/guestfs-recipes.pod:245
4719 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:245
4720 msgid "listing who was logged in recently"
4724 #: ../examples/guestfs-recipes.pod:249
4725 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:249
4726 msgid "http://augeas.net/"
4730 #: ../examples/guestfs-recipes.pod:251
4731 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:251
4732 msgid "Install RPMs in a guest"
4736 #: ../examples/guestfs-recipes.pod:253
4737 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:253
4739 "The link below contains a method to install RPMs in a guest. In fact the "
4740 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
4741 "installs them next time the guest is booted. You could use this technique "
4742 "to install vital security updates in an offline guest."
4746 #: ../examples/guestfs-recipes.pod:259
4747 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:259
4749 "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
4753 #: ../examples/guestfs-recipes.pod:261
4754 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:261
4755 msgid "List applications installed in a VM"
4759 #: ../examples/guestfs-recipes.pod:263
4760 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:263
4761 msgid "Save the following to a file C<list-apps.sh>:"
4765 #: ../examples/guestfs-recipes.pod:265
4766 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:265
4771 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
4772 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
4773 " guestfish --remote inspect-list-applications \"$root\"\n"
4774 " guestfish --remote exit\n"
4779 #: ../examples/guestfs-recipes.pod:272
4780 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:272
4782 "Make the file executable and then you can run it on any named virtual "
4787 #: ../examples/guestfs-recipes.pod:275
4788 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:275
4791 " # list-apps.sh WinGuest\n"
4793 " app_name: Mozilla Firefox (3.6.12)\n"
4794 " app_display_name: Mozilla Firefox (3.6.12)\n"
4796 " app_version: 3.6.12 (en-GB)\n"
4798 " app_install_path: C:\\Program Files\\Mozilla Firefox\n"
4799 " app_trans_path:\n"
4800 " app_publisher: Mozilla\n"
4801 " app_url: http://www.mozilla.com/en-GB/\n"
4802 " app_source_package:\n"
4804 " app_description: Mozilla Firefox\n"
4807 " app_name: VLC media player\n"
4808 " app_display_name: VLC media player 1.1.5\n"
4810 " app_version: 1.1.5\n"
4812 " app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
4813 " app_trans_path:\n"
4814 " app_publisher: VideoLAN\n"
4815 " app_url: http://www.videolan.org/\n"
4816 " app_source_package:\n"
4818 " app_description:\n"
4824 #: ../examples/guestfs-recipes.pod:305
4825 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:305
4827 "If you want to run the script on disk images (instead of libvirt virtual "
4828 "machines), change C<-d \"$1\"> to C<-a \"$1\">. See also L<virt-inspector(1)"
4833 #: ../examples/guestfs-recipes.pod:309
4834 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:309
4835 msgid "List files and directories in a VM"
4839 #: ../examples/guestfs-recipes.pod:311
4840 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:311
4841 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
4845 #: ../examples/guestfs-recipes.pod:313
4846 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:313
4849 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
4854 #: ../examples/guestfs-recipes.pod:315
4855 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:315
4856 msgid "List services in a Windows VM"
4860 #: ../examples/guestfs-recipes.pod:317
4861 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:317
4863 "The link below contains a script that can be used to list out the services "
4864 "from a Windows VM, and whether those services run at boot time or are loaded "
4869 #: ../examples/guestfs-recipes.pod:321
4870 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:321
4872 "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/"
4877 #: ../examples/guestfs-recipes.pod:323
4878 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:323
4879 msgid "Make a disk image sparse"
4883 #: ../examples/guestfs-recipes.pod:325
4884 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:325
4886 "The link below contains some guides for making a disk image sparse (or "
4887 "reintroducing sparseness)."
4891 #: ../examples/guestfs-recipes.pod:328
4892 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:328
4894 "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
4898 #: ../examples/guestfs-recipes.pod:330
4899 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:330
4900 msgid "Monitor disk usage over time"
4904 #: ../examples/guestfs-recipes.pod:332
4905 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:332
4907 "You can use L<virt-df(1)> to monitor disk usage of your guests over time. "
4908 "The link below contains a guide."
4912 #: ../examples/guestfs-recipes.pod:335
4913 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:335
4914 msgid "http://virt-tools.org/learning/advanced-virt-df/"
4918 #: ../examples/guestfs-recipes.pod:337
4919 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:337
4920 msgid "Reading the Windows Event Log from Windows Vista (or later)"
4924 #: ../examples/guestfs-recipes.pod:339
4925 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:339
4927 "L<guestfish(1)> plus the tools described in the link below can be used to "
4928 "read out the Windows Event Log from any virtual machine running Windows "
4929 "Vista or a later version."
4933 #: ../examples/guestfs-recipes.pod:343
4934 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:343
4936 "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-"
4937 "guestfish/#content"
4941 #: ../examples/guestfs-recipes.pod:345
4942 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:345
4943 msgid "Remove root password (Linux)"
4947 #: ../examples/guestfs-recipes.pod:347
4948 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:347
4950 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
4951 "files. One use is to remove the root password from a Linux guest:"
4955 #: ../examples/guestfs-recipes.pod:350
4956 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:350
4959 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
4964 #: ../examples/guestfs-recipes.pod:352
4965 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:352
4966 msgid "Remove Administrator password (Windows)"
4970 #: ../examples/guestfs-recipes.pod:354
4971 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:354
4973 "The link below contains one technique for removing the Administrator "
4974 "password from a Windows VM, or to be more precise, it gives you a command "
4975 "prompt the next time you log in which you can use to bypass any security:"
4979 #: ../examples/guestfs-recipes.pod:359
4980 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:359
4982 "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-"
4983 "administrator-password-with-guestfish/"
4987 #: ../examples/guestfs-recipes.pod:361
4988 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:361
4989 msgid "Unpack a live CD"
4993 #: ../examples/guestfs-recipes.pod:363
4994 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:363
4996 "Linux live CDs often contain multiple layers of disk images wrapped like a "
4997 "Russian doll. You can use L<guestfish(1)> to look inside these multiple "
4998 "layers, as outlined in the guide below."
5002 #: ../examples/guestfs-recipes.pod:367
5003 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:367
5005 "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-"
5010 #: ../examples/guestfs-recipes.pod:369
5011 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:369
5012 msgid "Uploading and downloading files"
5016 #: ../examples/guestfs-recipes.pod:371
5017 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:371
5019 "The link below contains general tips on uploading (copying in) and "
5020 "downloading (copying out) files from VMs."
5024 #: ../examples/guestfs-recipes.pod:374
5025 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:374
5027 "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
5031 #: ../examples/guestfs-recipes.pod:376
5032 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:376
5033 msgid "Use libguestfs tools on VMware ESX guests"
5037 #: ../examples/guestfs-recipes.pod:378
5038 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:378
5040 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
5041 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
5045 #: ../examples/guestfs-recipes.pod:382
5046 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:382
5048 "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-"
5053 #: ../examples/guestfs-recipes.pod:386
5054 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:386
5056 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, "
5057 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, L<http://"
5062 #: ../examples/guestfs-recipes.pod:401
5063 #: ../libguestfs-1.11.19/examples/guestfs-recipes.pod:401
5064 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5068 #: ../fish/guestfish-actions.pod:1
5069 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1
5074 #: ../fish/guestfish-actions.pod:3
5075 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3
5078 " add-cdrom filename\n"
5083 #: ../fish/guestfish-actions.pod:5
5084 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5
5085 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7
5086 #: ../src/guestfs-actions.pod:7
5087 msgid "This function adds a virtual CD-ROM disk image to the guest."
5091 #: ../fish/guestfish-actions.pod:7
5092 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:7
5093 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:9
5094 #: ../src/guestfs-actions.pod:9
5095 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5099 #: ../fish/guestfish-actions.pod:15
5100 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:15
5102 "This call checks for the existence of C<filename>. This stops you from "
5103 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5104 "and C<http:> URLs. To specify those, use the general L</config> call "
5109 #: ../fish/guestfish-actions.pod:22
5110 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:22
5112 "If you just want to add an ISO file (often you use this as an efficient way "
5113 "to transfer large files into the guest), then you should probably use L</add-"
5114 "drive-ro> instead."
5118 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163
5119 #: ../fish/guestfish-actions.pod:177
5120 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:28
5121 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:163
5122 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:177
5123 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:32
5124 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:254
5125 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:275
5126 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
5127 #: ../src/guestfs-actions.pod:275
5129 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5134 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166
5135 #: ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:986
5136 #: ../fish/guestfish-actions.pod:1346 ../fish/guestfish-actions.pod:1360
5137 #: ../fish/guestfish-actions.pod:3085 ../fish/guestfish-actions.pod:3292
5138 #: ../fish/guestfish-actions.pod:3406 ../fish/guestfish-actions.pod:3454
5139 #: ../fish/guestfish-actions.pod:4355 ../fish/guestfish-actions.pod:4378
5140 #: ../fish/guestfish-actions.pod:4400 ../fish/guestfish-actions.pod:4438
5141 #: ../fish/guestfish-actions.pod:5087 ../fish/guestfish-actions.pod:5185
5142 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:31
5143 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:166
5144 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:180
5145 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:986
5146 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1346
5147 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1360
5148 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3085
5149 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3292
5150 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3406
5151 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3454
5152 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4355
5153 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4378
5154 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4400
5155 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4438
5156 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5087
5157 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5185
5158 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:35
5159 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:257
5160 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:278
5161 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1513
5162 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2008
5163 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2029
5164 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4628
5165 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4947
5166 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5165
5167 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5255
5168 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6544
5169 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6574
5170 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6607
5171 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6666
5172 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7602
5173 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7714
5174 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7884
5175 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
5176 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1513
5177 #: ../src/guestfs-actions.pod:2008 ../src/guestfs-actions.pod:2029
5178 #: ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4947
5179 #: ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5255
5180 #: ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6574
5181 #: ../src/guestfs-actions.pod:6607 ../src/guestfs-actions.pod:6666
5182 #: ../src/guestfs-actions.pod:7602 ../src/guestfs-actions.pod:7714
5183 #: ../src/guestfs-actions.pod:7884
5185 "Deprecated functions will not be removed from the API, but the fact that "
5186 "they are deprecated indicates that there are problems with correct use of "
5191 #: ../fish/guestfish-actions.pod:35
5192 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:35
5197 #: ../fish/guestfish-actions.pod:37
5198 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:37
5203 #: ../fish/guestfish-actions.pod:39
5204 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:39
5207 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
5212 #: ../fish/guestfish-actions.pod:41
5213 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:41
5215 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5216 "It works by connecting to libvirt, requesting the domain and domain XML from "
5217 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
5221 #: ../fish/guestfish-actions.pod:46
5222 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:46
5223 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:64
5224 #: ../src/guestfs-actions.pod:64
5226 "The number of disks added is returned. This operation is atomic: if an "
5227 "error is returned, then no disks are added."
5231 #: ../fish/guestfish-actions.pod:49
5232 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:49
5233 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:67
5234 #: ../src/guestfs-actions.pod:67
5236 "This function does some minimal checks to make sure the libvirt domain is "
5237 "not running (unless C<readonly> is true). In a future version we will try "
5238 "to acquire the libvirt lock on each disk."
5242 #: ../fish/guestfish-actions.pod:53
5243 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:53
5244 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:71
5245 #: ../src/guestfs-actions.pod:71
5247 "Disks must be accessible locally. This often means that adding disks from a "
5248 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5249 "unless those disks are accessible via the same device path locally too."
5253 #: ../fish/guestfish-actions.pod:58
5254 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:58
5255 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:76
5256 #: ../src/guestfs-actions.pod:76
5258 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
5259 "libvirt.org/uri.html>). If this is not set then we connect to the default "
5260 "libvirt URI (or one set through an environment variable, see the libvirt "
5261 "documentation for full details)."
5265 #: ../fish/guestfish-actions.pod:64
5266 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:64
5267 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:82
5268 #: ../src/guestfs-actions.pod:82
5270 "The optional C<live> flag controls whether this call will try to connect to "
5271 "a running virtual machine C<guestfsd> process if it sees a suitable "
5272 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5273 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5274 "DAEMONS> for more information."
5278 #: ../fish/guestfish-actions.pod:71
5279 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:71
5280 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:89
5281 #: ../src/guestfs-actions.pod:89
5283 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
5284 "passed instead of the domain name. The C<dom> string is treated as a UUID "
5285 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
5290 #: ../fish/guestfish-actions.pod:76
5291 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:76
5293 "The other optional parameters are passed directly through to L</add-drive-"
5298 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
5299 #: ../fish/guestfish-actions.pod:568 ../fish/guestfish-actions.pod:1968
5300 #: ../fish/guestfish-actions.pod:3134 ../fish/guestfish-actions.pod:3307
5301 #: ../fish/guestfish-actions.pod:3442
5302 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:79
5303 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:143
5304 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:568
5305 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1968
5306 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3134
5307 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3307
5308 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3442
5310 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
5314 #: ../fish/guestfish-actions.pod:81
5315 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:81
5320 #: ../fish/guestfish-actions.pod:83
5321 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:83
5324 " add-drive filename\n"
5329 #: ../fish/guestfish-actions.pod:85
5330 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:85
5332 "This function is the equivalent of calling L</add-drive-opts> with no "
5333 "optional parameters, so the disk is added writable, with the format being "
5334 "detected automatically."
5338 #: ../fish/guestfish-actions.pod:89
5339 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:89
5341 "Automatic detection of the format opens you up to a potential security hole "
5342 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5343 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5344 "you should think about replacing calls to this function with calls to L</add-"
5345 "drive-opts>, and specifying the format."
5349 #: ../fish/guestfish-actions.pod:96
5350 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:96
5351 msgid "add-drive-opts"
5355 #: ../fish/guestfish-actions.pod:98
5356 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:98
5361 #: ../fish/guestfish-actions.pod:100
5362 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:100
5365 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
5370 #: ../fish/guestfish-actions.pod:102
5371 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:102
5372 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:160
5373 #: ../src/guestfs-actions.pod:160
5375 "This function adds a virtual machine disk image C<filename> to libguestfs. "
5376 "The first time you call this function, the disk appears as C</dev/sda>, the "
5377 "second time as C</dev/sdb>, and so on."
5381 #: ../fish/guestfish-actions.pod:107
5382 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:107
5383 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:165
5384 #: ../src/guestfs-actions.pod:165
5386 "You don't necessarily need to be root when using libguestfs. However you "
5387 "obviously do need sufficient permissions to access the filename for whatever "
5388 "operations you want to perform (ie. read access if you just want to read the "
5389 "image or write access if you want to modify the image)."
5393 #: ../fish/guestfish-actions.pod:113
5394 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:113
5395 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:171
5396 #: ../src/guestfs-actions.pod:171
5397 msgid "This call checks that C<filename> exists."
5401 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3096
5402 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:115
5403 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3096
5404 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:173
5405 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4655
5406 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4655
5407 msgid "The optional arguments are:"
5411 #: ../fish/guestfish-actions.pod:119
5412 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:119
5413 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:177
5414 #: ../src/guestfs-actions.pod:177
5419 #: ../fish/guestfish-actions.pod:121
5420 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:121
5421 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:179
5422 #: ../src/guestfs-actions.pod:179
5424 "If true then the image is treated as read-only. Writes are still allowed, "
5425 "but they are stored in a temporary snapshot overlay which is discarded at "
5426 "the end. The disk that you add is not modified."
5430 #: ../fish/guestfish-actions.pod:125
5431 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:125
5432 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:183
5433 #: ../src/guestfs-actions.pod:183
5438 #: ../fish/guestfish-actions.pod:127
5439 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:127
5441 "This forces the image format. If you omit this (or use L</add-drive> or L</"
5442 "add-drive-ro>) then the format is automatically detected. Possible formats "
5443 "include C<raw> and C<qcow2>."
5447 #: ../fish/guestfish-actions.pod:131
5448 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:131
5449 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:189
5450 #: ../src/guestfs-actions.pod:189
5452 "Automatic detection of the format opens you up to a potential security hole "
5453 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5454 "RHBZ#642934. Specifying the format closes this security hole."
5458 #: ../fish/guestfish-actions.pod:136
5459 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:136
5460 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:194
5461 #: ../src/guestfs-actions.pod:194
5466 #: ../fish/guestfish-actions.pod:138
5467 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:138
5469 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
5470 "add-drive-with-if> call (q.v.)"
5474 #: ../fish/guestfish-actions.pod:145
5475 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:145
5476 msgid "add-drive-ro"
5480 #: ../fish/guestfish-actions.pod:147
5481 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:147
5486 #: ../fish/guestfish-actions.pod:149
5487 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:149
5490 " add-drive-ro filename\n"
5495 #: ../fish/guestfish-actions.pod:151
5496 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:151
5498 "This function is the equivalent of calling L</add-drive-opts> with the "
5499 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
5500 "is added read-only, with the format being detected automatically."
5504 #: ../fish/guestfish-actions.pod:156
5505 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:156
5506 msgid "add-drive-ro-with-if"
5510 #: ../fish/guestfish-actions.pod:158
5511 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:158
5514 " add-drive-ro-with-if filename iface\n"
5519 #: ../fish/guestfish-actions.pod:160
5520 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:160
5522 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
5523 "interface emulation to use at run time."
5527 #: ../fish/guestfish-actions.pod:170
5528 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:170
5529 msgid "add-drive-with-if"
5533 #: ../fish/guestfish-actions.pod:172
5534 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:172
5537 " add-drive-with-if filename iface\n"
5542 #: ../fish/guestfish-actions.pod:174
5543 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:174
5545 "This is the same as L</add-drive> but it allows you to specify the QEMU "
5546 "interface emulation to use at run time."
5550 #: ../fish/guestfish-actions.pod:184
5551 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:184
5556 #: ../fish/guestfish-actions.pod:186
5557 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:186
5560 " aug-clear augpath\n"
5565 #: ../fish/guestfish-actions.pod:188
5566 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:188
5567 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:290
5568 #: ../src/guestfs-actions.pod:290
5570 "Set the value associated with C<path> to C<NULL>. This is the same as the "
5571 "L<augtool(1)> C<clear> command."
5575 #: ../fish/guestfish-actions.pod:191
5576 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:191
5581 #: ../fish/guestfish-actions.pod:193
5582 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:193
5590 #: ../fish/guestfish-actions.pod:195
5591 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:195
5593 "Close the current Augeas handle and free up any resources used by it. After "
5594 "calling this, you have to call L</aug-init> again before you can use any "
5595 "other Augeas functions."
5599 #: ../fish/guestfish-actions.pod:200
5600 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:200
5605 #: ../fish/guestfish-actions.pod:202
5606 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:202
5609 " aug-defnode name expr val\n"
5614 #: ../fish/guestfish-actions.pod:204
5615 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:204
5616 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:319
5617 #: ../src/guestfs-actions.pod:319
5619 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
5623 #: ../fish/guestfish-actions.pod:207
5624 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:207
5626 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
5627 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
5628 "containing that single node."
5632 #: ../fish/guestfish-actions.pod:211
5633 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:211
5634 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:326
5635 #: ../src/guestfs-actions.pod:326
5637 "On success this returns a pair containing the number of nodes in the "
5638 "nodeset, and a boolean flag if a node was created."
5642 #: ../fish/guestfish-actions.pod:215
5643 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:215
5648 #: ../fish/guestfish-actions.pod:217
5649 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:217
5652 " aug-defvar name expr\n"
5657 #: ../fish/guestfish-actions.pod:219
5658 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:219
5659 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:343
5660 #: ../src/guestfs-actions.pod:343
5662 "Defines an Augeas variable C<name> whose value is the result of evaluating "
5663 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
5667 #: ../fish/guestfish-actions.pod:223
5668 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:223
5669 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:347
5670 #: ../src/guestfs-actions.pod:347
5672 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
5673 "evaluates to something which is not a nodeset."
5677 #: ../fish/guestfish-actions.pod:226
5678 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:226
5683 #: ../fish/guestfish-actions.pod:228
5684 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:228
5687 " aug-get augpath\n"
5692 #: ../fish/guestfish-actions.pod:230
5693 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:230
5694 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:360
5695 #: ../src/guestfs-actions.pod:360
5697 "Look up the value associated with C<path>. If C<path> matches exactly one "
5698 "node, the C<value> is returned."
5702 #: ../fish/guestfish-actions.pod:233
5703 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:233
5708 #: ../fish/guestfish-actions.pod:235
5709 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:235
5712 " aug-init root flags\n"
5717 #: ../fish/guestfish-actions.pod:237
5718 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:237
5719 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:375
5720 #: ../src/guestfs-actions.pod:375
5722 "Create a new Augeas handle for editing configuration files. If there was "
5723 "any previous Augeas handle associated with this guestfs session, then it is "
5728 #: ../fish/guestfish-actions.pod:241
5729 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:241
5730 msgid "You must call this before using any other L</aug-*> commands."
5734 #: ../fish/guestfish-actions.pod:244
5735 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:244
5736 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:382
5737 #: ../src/guestfs-actions.pod:382
5739 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
5743 #: ../fish/guestfish-actions.pod:247
5744 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:247
5745 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:385
5746 #: ../src/guestfs-actions.pod:385
5748 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
5749 "logical I<or> of the following integers:"
5753 #: ../fish/guestfish-actions.pod:253
5754 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:253
5755 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:391
5756 #: ../src/guestfs-actions.pod:391
5757 msgid "C<AUG_SAVE_BACKUP> = 1"
5761 #: ../fish/guestfish-actions.pod:255
5762 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:255
5763 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:393
5764 #: ../src/guestfs-actions.pod:393
5765 msgid "Keep the original file with a C<.augsave> extension."
5769 #: ../fish/guestfish-actions.pod:257
5770 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:257
5771 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:395
5772 #: ../src/guestfs-actions.pod:395
5773 msgid "C<AUG_SAVE_NEWFILE> = 2"
5777 #: ../fish/guestfish-actions.pod:259
5778 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:259
5779 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:397
5780 #: ../src/guestfs-actions.pod:397
5782 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5783 "original. Overrides C<AUG_SAVE_BACKUP>."
5787 #: ../fish/guestfish-actions.pod:262
5788 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:262
5789 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:400
5790 #: ../src/guestfs-actions.pod:400
5791 msgid "C<AUG_TYPE_CHECK> = 4"
5795 #: ../fish/guestfish-actions.pod:264
5796 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:264
5797 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:402
5798 #: ../src/guestfs-actions.pod:402
5799 msgid "Typecheck lenses (can be expensive)."
5803 #: ../fish/guestfish-actions.pod:266
5804 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:266
5805 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:404
5806 #: ../src/guestfs-actions.pod:404
5807 msgid "C<AUG_NO_STDINC> = 8"
5811 #: ../fish/guestfish-actions.pod:268
5812 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:268
5813 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:406
5814 #: ../src/guestfs-actions.pod:406
5815 msgid "Do not use standard load path for modules."
5819 #: ../fish/guestfish-actions.pod:270
5820 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:270
5821 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:408
5822 #: ../src/guestfs-actions.pod:408
5823 msgid "C<AUG_SAVE_NOOP> = 16"
5827 #: ../fish/guestfish-actions.pod:272
5828 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:272
5829 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:410
5830 #: ../src/guestfs-actions.pod:410
5831 msgid "Make save a no-op, just record what would have been changed."
5835 #: ../fish/guestfish-actions.pod:274
5836 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:274
5837 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:412
5838 #: ../src/guestfs-actions.pod:412
5839 msgid "C<AUG_NO_LOAD> = 32"
5843 #: ../fish/guestfish-actions.pod:276
5844 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:276
5845 msgid "Do not load the tree in L</aug-init>."
5849 #: ../fish/guestfish-actions.pod:280
5850 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:280
5851 msgid "To close the handle, you can call L</aug-close>."
5855 #: ../fish/guestfish-actions.pod:282
5856 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:282
5857 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:420
5858 #: ../src/guestfs-actions.pod:420
5859 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5863 #: ../fish/guestfish-actions.pod:284
5864 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:284
5869 #: ../fish/guestfish-actions.pod:286
5870 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:286
5873 " aug-insert augpath label true|false\n"
5878 #: ../fish/guestfish-actions.pod:288
5879 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:288
5880 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:434
5881 #: ../src/guestfs-actions.pod:434
5883 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5884 "or after C<path> (depending on the boolean flag C<before>)."
5888 #: ../fish/guestfish-actions.pod:292
5889 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:292
5890 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:438
5891 #: ../src/guestfs-actions.pod:438
5893 "C<path> must match exactly one existing node in the tree, and C<label> must "
5894 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5898 #: ../fish/guestfish-actions.pod:296
5899 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:296
5904 #: ../fish/guestfish-actions.pod:298
5905 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:298
5913 #: ../fish/guestfish-actions.pod:300
5914 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:300
5915 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:451
5916 #: ../src/guestfs-actions.pod:451
5917 msgid "Load files into the tree."
5921 #: ../fish/guestfish-actions.pod:302
5922 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:302
5923 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:453
5924 #: ../src/guestfs-actions.pod:453
5925 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5929 #: ../fish/guestfish-actions.pod:305
5930 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:305
5935 #: ../fish/guestfish-actions.pod:307
5936 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:307
5944 #: ../fish/guestfish-actions.pod:309
5945 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:309
5947 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
5948 "resulting nodes into alphabetical order."
5952 #: ../fish/guestfish-actions.pod:312
5953 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:312
5958 #: ../fish/guestfish-actions.pod:314
5959 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:314
5962 " aug-match augpath\n"
5967 #: ../fish/guestfish-actions.pod:316
5968 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:316
5969 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:481
5970 #: ../src/guestfs-actions.pod:481
5972 "Returns a list of paths which match the path expression C<path>. The "
5973 "returned paths are sufficiently qualified so that they match exactly one "
5974 "node in the current tree."
5978 #: ../fish/guestfish-actions.pod:320
5979 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:320
5984 #: ../fish/guestfish-actions.pod:322
5985 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:322
5988 " aug-mv src dest\n"
5993 #: ../fish/guestfish-actions.pod:324
5994 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:324
5995 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:498
5996 #: ../src/guestfs-actions.pod:498
5998 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
5999 "C<dest> is overwritten if it exists."
6003 #: ../fish/guestfish-actions.pod:327
6004 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:327
6009 #: ../fish/guestfish-actions.pod:329
6010 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:329
6018 #: ../fish/guestfish-actions.pod:331
6019 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:331
6020 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:511
6021 #: ../src/guestfs-actions.pod:511
6022 msgid "Remove C<path> and all of its children."
6026 #: ../fish/guestfish-actions.pod:333
6027 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:333
6028 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:513
6029 #: ../src/guestfs-actions.pod:513
6030 msgid "On success this returns the number of entries which were removed."
6034 #: ../fish/guestfish-actions.pod:335
6035 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:335
6040 #: ../fish/guestfish-actions.pod:337
6041 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:337
6049 #: ../fish/guestfish-actions.pod:339
6050 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:339
6051 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:524
6052 #: ../src/guestfs-actions.pod:524
6053 msgid "This writes all pending changes to disk."
6057 #: ../fish/guestfish-actions.pod:341
6058 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:341
6060 "The flags which were passed to L</aug-init> affect exactly how files are "
6065 #: ../fish/guestfish-actions.pod:344
6066 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:344
6071 #: ../fish/guestfish-actions.pod:346
6072 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:346
6075 " aug-set augpath val\n"
6080 #: ../fish/guestfish-actions.pod:348
6081 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:348
6082 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:540
6083 #: ../src/guestfs-actions.pod:540
6084 msgid "Set the value associated with C<path> to C<val>."
6088 #: ../fish/guestfish-actions.pod:350
6089 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:350
6091 "In the Augeas API, it is possible to clear a node by setting the value to "
6092 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6093 "this call. Instead you must use the L</aug-clear> call."
6097 #: ../fish/guestfish-actions.pod:355
6098 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:355
6103 #: ../fish/guestfish-actions.pod:357
6104 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:357
6107 " available 'groups ...'\n"
6112 #: ../fish/guestfish-actions.pod:359
6113 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:359
6114 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:557
6115 #: ../src/guestfs-actions.pod:557
6117 "This command is used to check the availability of some groups of "
6118 "functionality in the appliance, which not all builds of the libguestfs "
6119 "appliance will be able to provide."
6123 #: ../fish/guestfish-actions.pod:363
6124 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:363
6126 "The libguestfs groups, and the functions that those groups correspond to, "
6127 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6128 "runtime by calling L</available-all-groups>."
6132 #: ../fish/guestfish-actions.pod:368
6133 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:368
6134 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:566
6135 #: ../src/guestfs-actions.pod:566
6137 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
6138 "\"]> would check for the availability of the Linux inotify functions and "
6139 "Augeas (configuration file editing) functions."
6143 #: ../fish/guestfish-actions.pod:373
6144 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:373
6145 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:571
6146 #: ../src/guestfs-actions.pod:571
6147 msgid "The command returns no error if I<all> requested groups are available."
6151 #: ../fish/guestfish-actions.pod:375
6152 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:375
6153 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:573
6154 #: ../src/guestfs-actions.pod:573
6156 "It fails with an error if one or more of the requested groups is unavailable "
6161 #: ../fish/guestfish-actions.pod:378
6162 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:378
6163 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:576
6164 #: ../src/guestfs-actions.pod:576
6166 "If an unknown group name is included in the list of groups then an error is "
6171 #: ../fish/guestfish-actions.pod:381
6172 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:381
6173 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:579
6174 #: ../src/guestfs-actions.pod:579
6179 #: ../fish/guestfish-actions.pod:387
6180 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:387
6181 msgid "You must call L</launch> before calling this function."
6185 #: ../fish/guestfish-actions.pod:389
6186 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:389
6187 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:587
6188 #: ../src/guestfs-actions.pod:587
6190 "The reason is because we don't know what groups are supported by the "
6191 "appliance/daemon until it is running and can be queried."
6195 #: ../fish/guestfish-actions.pod:395
6196 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:395
6197 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:593
6198 #: ../src/guestfs-actions.pod:593
6200 "If a group of functions is available, this does not necessarily mean that "
6201 "they will work. You still have to check for errors when calling individual "
6202 "API functions even if they are available."
6206 #: ../fish/guestfish-actions.pod:402
6207 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:402
6208 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:600
6209 #: ../src/guestfs-actions.pod:600
6211 "It is usually the job of distro packagers to build complete functionality "
6212 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6213 "with all requirements satisfied, will support everything."
6217 #: ../fish/guestfish-actions.pod:409
6218 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:409
6220 "This call was added in version C<1.0.80>. In previous versions of "
6221 "libguestfs all you could do would be to speculatively execute a command to "
6222 "find out if the daemon implemented it. See also L</version>."
6226 #: ../fish/guestfish-actions.pod:416
6227 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:416
6228 msgid "available-all-groups"
6232 #: ../fish/guestfish-actions.pod:418
6233 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:418
6236 " available-all-groups\n"
6241 #: ../fish/guestfish-actions.pod:420
6242 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:420
6244 "This command returns a list of all optional groups that this daemon knows "
6245 "about. Note this returns both supported and unsupported groups. To find "
6246 "out which ones the daemon can actually support you have to call L</"
6247 "available> on each member of the returned list."
6251 #: ../fish/guestfish-actions.pod:426
6252 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:426
6253 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
6257 #: ../fish/guestfish-actions.pod:428
6258 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:428
6263 #: ../fish/guestfish-actions.pod:430
6264 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:430
6267 " base64-in (base64file|-) filename\n"
6272 #: ../fish/guestfish-actions.pod:432
6273 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:432
6274 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:644
6275 #: ../src/guestfs-actions.pod:644
6277 "This command uploads base64-encoded data from C<base64file> to C<filename>."
6281 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
6282 #: ../fish/guestfish-actions.pod:693 ../fish/guestfish-actions.pod:862
6283 #: ../fish/guestfish-actions.pod:881 ../fish/guestfish-actions.pod:1255
6284 #: ../fish/guestfish-actions.pod:4658 ../fish/guestfish-actions.pod:4670
6285 #: ../fish/guestfish-actions.pod:4681 ../fish/guestfish-actions.pod:4692
6286 #: ../fish/guestfish-actions.pod:4744 ../fish/guestfish-actions.pod:4753
6287 #: ../fish/guestfish-actions.pod:4807 ../fish/guestfish-actions.pod:4830
6288 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:435
6289 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:444
6290 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:693
6291 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:862
6292 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:881
6293 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1255
6294 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4658
6295 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4670
6296 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4681
6297 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4692
6298 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4744
6299 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4753
6300 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4807
6301 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4830
6302 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
6306 #: ../fish/guestfish-actions.pod:437
6307 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:437
6312 #: ../fish/guestfish-actions.pod:439
6313 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:439
6316 " base64-out filename (base64file|-)\n"
6321 #: ../fish/guestfish-actions.pod:441
6322 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:441
6323 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:658
6324 #: ../src/guestfs-actions.pod:658
6326 "This command downloads the contents of C<filename>, writing it out to local "
6327 "file C<base64file> encoded as base64."
6331 #: ../fish/guestfish-actions.pod:446
6332 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:446
6333 msgid "blockdev-flushbufs"
6337 #: ../fish/guestfish-actions.pod:448
6338 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:448
6341 " blockdev-flushbufs device\n"
6346 #: ../fish/guestfish-actions.pod:450
6347 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:450
6348 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:671
6349 #: ../src/guestfs-actions.pod:671
6351 "This tells the kernel to flush internal buffers associated with C<device>."
6355 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
6356 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
6357 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
6358 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
6359 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
6360 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:453
6361 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:464
6362 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:473
6363 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:483
6364 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:495
6365 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:508
6366 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:516
6367 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:527
6368 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:535
6369 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:543
6370 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:674
6371 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:691
6372 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:706
6373 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:722
6374 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:740
6375 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:759
6376 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:773
6377 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:791
6378 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:805
6379 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:819
6380 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
6381 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
6382 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
6383 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
6384 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
6385 msgid "This uses the L<blockdev(8)> command."
6389 #: ../fish/guestfish-actions.pod:455
6390 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:455
6391 msgid "blockdev-getbsz"
6395 #: ../fish/guestfish-actions.pod:457
6396 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:457
6399 " blockdev-getbsz device\n"
6404 #: ../fish/guestfish-actions.pod:459
6405 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:459
6406 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:686
6407 #: ../src/guestfs-actions.pod:686
6408 msgid "This returns the block size of a device."
6412 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
6413 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:461
6414 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:524
6415 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:688
6416 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:788
6417 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
6419 "(Note this is different from both I<size in blocks> and I<filesystem block "
6424 #: ../fish/guestfish-actions.pod:466
6425 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:466
6426 msgid "blockdev-getro"
6430 #: ../fish/guestfish-actions.pod:468
6431 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:468
6434 " blockdev-getro device\n"
6439 #: ../fish/guestfish-actions.pod:470
6440 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:470
6441 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:703
6442 #: ../src/guestfs-actions.pod:703
6444 "Returns a boolean indicating if the block device is read-only (true if read-"
6445 "only, false if not)."
6449 #: ../fish/guestfish-actions.pod:475
6450 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:475
6451 msgid "blockdev-getsize64"
6455 #: ../fish/guestfish-actions.pod:477
6456 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:477
6459 " blockdev-getsize64 device\n"
6464 #: ../fish/guestfish-actions.pod:479
6465 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:479
6466 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:718
6467 #: ../src/guestfs-actions.pod:718
6468 msgid "This returns the size of the device in bytes."
6472 #: ../fish/guestfish-actions.pod:481
6473 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:481
6474 msgid "See also L</blockdev-getsz>."
6478 #: ../fish/guestfish-actions.pod:485
6479 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:485
6480 msgid "blockdev-getss"
6484 #: ../fish/guestfish-actions.pod:487
6485 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:487
6488 " blockdev-getss device\n"
6493 #: ../fish/guestfish-actions.pod:489
6494 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:489
6495 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:734
6496 #: ../src/guestfs-actions.pod:734
6498 "This returns the size of sectors on a block device. Usually 512, but can be "
6499 "larger for modern devices."
6503 #: ../fish/guestfish-actions.pod:492
6504 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:492
6506 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
6510 #: ../fish/guestfish-actions.pod:497
6511 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:497
6512 msgid "blockdev-getsz"
6516 #: ../fish/guestfish-actions.pod:499
6517 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:499
6520 " blockdev-getsz device\n"
6525 #: ../fish/guestfish-actions.pod:501
6526 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:501
6527 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:752
6528 #: ../src/guestfs-actions.pod:752
6530 "This returns the size of the device in units of 512-byte sectors (even if "
6531 "the sectorsize isn't 512 bytes ... weird)."
6535 #: ../fish/guestfish-actions.pod:504
6536 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:504
6538 "See also L</blockdev-getss> for the real sector size of the device, and L</"
6539 "blockdev-getsize64> for the more useful I<size in bytes>."
6543 #: ../fish/guestfish-actions.pod:510
6544 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:510
6545 msgid "blockdev-rereadpt"
6549 #: ../fish/guestfish-actions.pod:512
6550 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:512
6553 " blockdev-rereadpt device\n"
6558 #: ../fish/guestfish-actions.pod:514
6559 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:514
6560 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:771
6561 #: ../src/guestfs-actions.pod:771
6562 msgid "Reread the partition table on C<device>."
6566 #: ../fish/guestfish-actions.pod:518
6567 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:518
6568 msgid "blockdev-setbsz"
6572 #: ../fish/guestfish-actions.pod:520
6573 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:520
6576 " blockdev-setbsz device blocksize\n"
6581 #: ../fish/guestfish-actions.pod:522
6582 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:522
6583 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:786
6584 #: ../src/guestfs-actions.pod:786
6585 msgid "This sets the block size of a device."
6589 #: ../fish/guestfish-actions.pod:529
6590 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:529
6591 msgid "blockdev-setro"
6595 #: ../fish/guestfish-actions.pod:531
6596 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:531
6599 " blockdev-setro device\n"
6604 #: ../fish/guestfish-actions.pod:533
6605 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:533
6606 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:803
6607 #: ../src/guestfs-actions.pod:803
6608 msgid "Sets the block device named C<device> to read-only."
6612 #: ../fish/guestfish-actions.pod:537
6613 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:537
6614 msgid "blockdev-setrw"
6618 #: ../fish/guestfish-actions.pod:539
6619 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:539
6622 " blockdev-setrw device\n"
6627 #: ../fish/guestfish-actions.pod:541
6628 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:541
6629 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:817
6630 #: ../src/guestfs-actions.pod:817
6631 msgid "Sets the block device named C<device> to read-write."
6635 #: ../fish/guestfish-actions.pod:545
6636 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:545
6637 msgid "btrfs-filesystem-resize"
6641 #: ../fish/guestfish-actions.pod:547
6642 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:547
6645 " btrfs-filesystem-resize mountpoint [size:..]\n"
6650 #: ../fish/guestfish-actions.pod:549
6651 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:549
6652 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:839
6653 #: ../src/guestfs-actions.pod:839
6654 msgid "This command resizes a btrfs filesystem."
6658 #: ../fish/guestfish-actions.pod:551
6659 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:551
6660 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:841
6661 #: ../src/guestfs-actions.pod:841
6663 "Note that unlike other resize calls, the filesystem has to be mounted and "
6664 "the parameter is the mountpoint not the device (this is a requirement of "
6669 #: ../fish/guestfish-actions.pod:555 ../fish/guestfish-actions.pod:3417
6670 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:555
6671 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3417
6672 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:845
6673 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5189
6674 #: ../src/guestfs-actions.pod:845 ../src/guestfs-actions.pod:5189
6675 msgid "The optional parameters are:"
6679 #: ../fish/guestfish-actions.pod:559 ../fish/guestfish-actions.pod:3421
6680 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:559
6681 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3421
6682 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:849
6683 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5193
6684 #: ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:5193
6689 #: ../fish/guestfish-actions.pod:561
6690 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:561
6691 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:851
6692 #: ../src/guestfs-actions.pod:851
6694 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
6695 "resized to the maximum size."
6699 #: ../fish/guestfish-actions.pod:566
6700 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:566
6701 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:856
6702 #: ../src/guestfs-actions.pod:856
6703 msgid "See also L<btrfs(8)>."
6707 #: ../fish/guestfish-actions.pod:570
6708 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:570
6709 msgid "case-sensitive-path"
6713 #: ../fish/guestfish-actions.pod:572
6714 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:572
6717 " case-sensitive-path path\n"
6722 #: ../fish/guestfish-actions.pod:574
6723 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:574
6724 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:890
6725 #: ../src/guestfs-actions.pod:890
6727 "This can be used to resolve case insensitive paths on a filesystem which is "
6728 "case sensitive. The use case is to resolve paths which you have read from "
6729 "Windows configuration files or the Windows Registry, to the true path."
6733 #: ../fish/guestfish-actions.pod:579
6734 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:579
6735 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:895
6736 #: ../src/guestfs-actions.pod:895
6738 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
6739 "(and probably others), which is that although the underlying filesystem is "
6740 "case-insensitive, the driver exports the filesystem to Linux as case-"
6745 #: ../fish/guestfish-actions.pod:584
6746 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:584
6747 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:900
6748 #: ../src/guestfs-actions.pod:900
6750 "One consequence of this is that special directories such as C<c:\\windows> "
6751 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
6752 "precise details of how they were created. In Windows itself this would not "
6757 #: ../fish/guestfish-actions.pod:590
6758 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:590
6759 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:906
6760 #: ../src/guestfs-actions.pod:906
6762 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
6767 #: ../fish/guestfish-actions.pod:593
6768 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:593
6769 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:909
6770 #: ../src/guestfs-actions.pod:909
6772 "This function resolves the true case of each element in the path and returns "
6773 "the case-sensitive path."
6777 #: ../fish/guestfish-actions.pod:596
6778 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:596
6780 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
6781 "WINDOWS/system32\"> (the exact return value would depend on details of how "
6782 "the directories were originally created under Windows)."
6786 #: ../fish/guestfish-actions.pod:601
6787 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:601
6788 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:917
6789 #: ../src/guestfs-actions.pod:917
6790 msgid "I<Note>: This function does not handle drive names, backslashes etc."
6794 #: ../fish/guestfish-actions.pod:604
6795 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:604
6796 msgid "See also L</realpath>."
6800 #: ../fish/guestfish-actions.pod:606
6801 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:606
6806 #: ../fish/guestfish-actions.pod:608
6807 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:608
6815 #: ../fish/guestfish-actions.pod:610 ../fish/guestfish-actions.pod:3837
6816 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:610
6817 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3837
6818 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:933
6819 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5832
6820 #: ../src/guestfs-actions.pod:933 ../src/guestfs-actions.pod:5832
6821 msgid "Return the contents of the file named C<path>."
6825 #: ../fish/guestfish-actions.pod:612
6826 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:612
6828 "Note that this function cannot correctly handle binary files (specifically, "
6829 "files containing C<\\0> character which is treated as end of string). For "
6830 "those you need to use the L</read-file> or L</download> functions which have "
6831 "a more complex interface."
6835 #: ../fish/guestfish-actions.pod:617 ../fish/guestfish-actions.pod:752
6836 #: ../fish/guestfish-actions.pod:764 ../fish/guestfish-actions.pod:940
6837 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:1017
6838 #: ../fish/guestfish-actions.pod:1027 ../fish/guestfish-actions.pod:1219
6839 #: ../fish/guestfish-actions.pod:1526 ../fish/guestfish-actions.pod:1536
6840 #: ../fish/guestfish-actions.pod:1564 ../fish/guestfish-actions.pod:1579
6841 #: ../fish/guestfish-actions.pod:1589 ../fish/guestfish-actions.pod:1608
6842 #: ../fish/guestfish-actions.pod:3707 ../fish/guestfish-actions.pod:3722
6843 #: ../fish/guestfish-actions.pod:3798 ../fish/guestfish-actions.pod:3815
6844 #: ../fish/guestfish-actions.pod:3830 ../fish/guestfish-actions.pod:4499
6845 #: ../fish/guestfish-actions.pod:4545 ../fish/guestfish-actions.pod:4630
6846 #: ../fish/guestfish-actions.pod:4645 ../fish/guestfish-actions.pod:5051
6847 #: ../fish/guestfish-actions.pod:5063 ../fish/guestfish-actions.pod:5081
6848 #: ../fish/guestfish-actions.pod:5098 ../fish/guestfish-actions.pod:5108
6849 #: ../fish/guestfish-actions.pod:5157 ../fish/guestfish-actions.pod:5167
6850 #: ../fish/guestfish-actions.pod:5196 ../fish/guestfish-actions.pod:5206
6851 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:617
6852 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:752
6853 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:764
6854 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:940
6855 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:950
6856 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1017
6857 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1027
6858 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1219
6859 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1526
6860 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1536
6861 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1564
6862 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1579
6863 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1589
6864 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1608
6865 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3707
6866 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3722
6867 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3798
6868 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3815
6869 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3830
6870 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4499
6871 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4545
6872 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4630
6873 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4645
6874 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5051
6875 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5063
6876 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5081
6877 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5098
6878 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5108
6879 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5157
6880 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5167
6881 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5196
6882 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5206
6883 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:943
6884 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1122
6885 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1142
6886 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1438
6887 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1457
6888 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1560
6889 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1579
6890 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1825
6891 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2296
6892 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2315
6893 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2358
6894 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2382
6895 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2399
6896 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2428
6897 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5614
6898 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5640
6899 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5771
6900 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5797
6901 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5821
6902 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6772
6903 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6827
6904 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6973
6905 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6997
6906 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7662
6907 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7682
6908 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7708
6909 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7734
6910 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7753
6911 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7839
6912 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7858
6913 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7904
6914 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7923
6915 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1122
6916 #: ../src/guestfs-actions.pod:1142 ../src/guestfs-actions.pod:1438
6917 #: ../src/guestfs-actions.pod:1457 ../src/guestfs-actions.pod:1560
6918 #: ../src/guestfs-actions.pod:1579 ../src/guestfs-actions.pod:1825
6919 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:2315
6920 #: ../src/guestfs-actions.pod:2358 ../src/guestfs-actions.pod:2382
6921 #: ../src/guestfs-actions.pod:2399 ../src/guestfs-actions.pod:2428
6922 #: ../src/guestfs-actions.pod:5614 ../src/guestfs-actions.pod:5640
6923 #: ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5797
6924 #: ../src/guestfs-actions.pod:5821 ../src/guestfs-actions.pod:6772
6925 #: ../src/guestfs-actions.pod:6827 ../src/guestfs-actions.pod:6973
6926 #: ../src/guestfs-actions.pod:6997 ../src/guestfs-actions.pod:7662
6927 #: ../src/guestfs-actions.pod:7682 ../src/guestfs-actions.pod:7708
6928 #: ../src/guestfs-actions.pod:7734 ../src/guestfs-actions.pod:7753
6929 #: ../src/guestfs-actions.pod:7839 ../src/guestfs-actions.pod:7858
6930 #: ../src/guestfs-actions.pod:7904 ../src/guestfs-actions.pod:7923
6932 "Because of the message protocol, there is a transfer limit of somewhere "
6933 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
6937 #: ../fish/guestfish-actions.pod:620
6938 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:620
6943 #: ../fish/guestfish-actions.pod:622
6944 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:622
6947 " checksum csumtype path\n"
6952 #: ../fish/guestfish-actions.pod:624
6953 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:624
6954 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:955
6955 #: ../src/guestfs-actions.pod:955
6957 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
6961 #: ../fish/guestfish-actions.pod:627
6962 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:627
6963 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:958
6964 #: ../src/guestfs-actions.pod:958
6966 "The type of checksum to compute is given by the C<csumtype> parameter which "
6967 "must have one of the following values:"
6971 #: ../fish/guestfish-actions.pod:632
6972 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:632
6973 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:963
6974 #: ../src/guestfs-actions.pod:963
6979 #: ../fish/guestfish-actions.pod:634
6980 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:634
6981 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:965
6982 #: ../src/guestfs-actions.pod:965
6984 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
6989 #: ../fish/guestfish-actions.pod:637
6990 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:637
6991 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:968
6992 #: ../src/guestfs-actions.pod:968
6997 #: ../fish/guestfish-actions.pod:639
6998 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:639
6999 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:970
7000 #: ../src/guestfs-actions.pod:970
7001 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7005 #: ../fish/guestfish-actions.pod:641
7006 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:641
7007 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:972
7008 #: ../src/guestfs-actions.pod:972
7013 #: ../fish/guestfish-actions.pod:643
7014 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:643
7015 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:974
7016 #: ../src/guestfs-actions.pod:974
7017 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7021 #: ../fish/guestfish-actions.pod:645
7022 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:645
7023 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:976
7024 #: ../src/guestfs-actions.pod:976
7029 #: ../fish/guestfish-actions.pod:647
7030 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:647
7031 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:978
7032 #: ../src/guestfs-actions.pod:978
7033 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7037 #: ../fish/guestfish-actions.pod:649
7038 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:649
7039 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:980
7040 #: ../src/guestfs-actions.pod:980
7045 #: ../fish/guestfish-actions.pod:651
7046 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:651
7047 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:982
7048 #: ../src/guestfs-actions.pod:982
7049 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7053 #: ../fish/guestfish-actions.pod:653
7054 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:653
7055 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:984
7056 #: ../src/guestfs-actions.pod:984
7061 #: ../fish/guestfish-actions.pod:655
7062 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:655
7063 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:986
7064 #: ../src/guestfs-actions.pod:986
7065 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7069 #: ../fish/guestfish-actions.pod:657
7070 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:657
7071 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:988
7072 #: ../src/guestfs-actions.pod:988
7077 #: ../fish/guestfish-actions.pod:659
7078 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:659
7079 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:990
7080 #: ../src/guestfs-actions.pod:990
7081 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7085 #: ../fish/guestfish-actions.pod:663
7086 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:663
7087 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:994
7088 #: ../src/guestfs-actions.pod:994
7089 msgid "The checksum is returned as a printable string."
7093 #: ../fish/guestfish-actions.pod:665
7094 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:665
7095 msgid "To get the checksum for a device, use L</checksum-device>."
7099 #: ../fish/guestfish-actions.pod:667
7100 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:667
7101 msgid "To get the checksums for many files, use L</checksums-out>."
7105 #: ../fish/guestfish-actions.pod:669
7106 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:669
7107 msgid "checksum-device"
7111 #: ../fish/guestfish-actions.pod:671
7112 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:671
7115 " checksum-device csumtype device\n"
7120 #: ../fish/guestfish-actions.pod:673
7121 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:673
7123 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7124 "device named C<device>. For the types of checksums supported see the L</"
7125 "checksum> command."
7129 #: ../fish/guestfish-actions.pod:677
7130 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:677
7131 msgid "checksums-out"
7135 #: ../fish/guestfish-actions.pod:679
7136 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:679
7139 " checksums-out csumtype directory (sumsfile|-)\n"
7144 #: ../fish/guestfish-actions.pod:681
7145 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:681
7146 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1029
7147 #: ../src/guestfs-actions.pod:1029
7149 "This command computes the checksums of all regular files in C<directory> and "
7150 "then emits a list of those checksums to the local output file C<sumsfile>."
7154 #: ../fish/guestfish-actions.pod:685
7155 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:685
7156 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1033
7157 #: ../src/guestfs-actions.pod:1033
7159 "This can be used for verifying the integrity of a virtual machine. However "
7160 "to be properly secure you should pay attention to the output of the checksum "
7161 "command (it uses the ones from GNU coreutils). In particular when the "
7162 "filename is not printable, coreutils uses a special backslash syntax. For "
7163 "more information, see the GNU coreutils info file."
7167 #: ../fish/guestfish-actions.pod:695
7168 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:695
7173 #: ../fish/guestfish-actions.pod:697
7174 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:697
7177 " chmod mode path\n"
7182 #: ../fish/guestfish-actions.pod:699
7183 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:699
7184 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1052
7185 #: ../src/guestfs-actions.pod:1052
7187 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7192 #: ../fish/guestfish-actions.pod:702
7193 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:702
7194 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1055
7195 #: ../src/guestfs-actions.pod:1055
7197 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7198 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7203 #: ../fish/guestfish-actions.pod:706 ../fish/guestfish-actions.pod:3060
7204 #: ../fish/guestfish-actions.pod:3199 ../fish/guestfish-actions.pod:3209
7205 #: ../fish/guestfish-actions.pod:3219
7206 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:706
7207 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3060
7208 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3199
7209 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3209
7210 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3219
7211 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1059
7212 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4586
7213 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4795
7214 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4814
7215 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4833
7216 #: ../src/guestfs-actions.pod:1059 ../src/guestfs-actions.pod:4586
7217 #: ../src/guestfs-actions.pod:4795 ../src/guestfs-actions.pod:4814
7218 #: ../src/guestfs-actions.pod:4833
7219 msgid "The mode actually set is affected by the umask."
7223 #: ../fish/guestfish-actions.pod:708
7224 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:708
7229 #: ../fish/guestfish-actions.pod:710
7230 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:710
7233 " chown owner group path\n"
7238 #: ../fish/guestfish-actions.pod:712
7239 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:712
7240 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1073
7241 #: ../src/guestfs-actions.pod:1073
7242 msgid "Change the file owner to C<owner> and group to C<group>."
7246 #: ../fish/guestfish-actions.pod:714 ../fish/guestfish-actions.pod:2495
7247 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:714
7248 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2495
7249 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1075
7250 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3657
7251 #: ../src/guestfs-actions.pod:1075 ../src/guestfs-actions.pod:3657
7253 "Only numeric uid and gid are supported. If you want to use names, you will "
7254 "need to locate and parse the password file yourself (Augeas support makes "
7255 "this relatively easy)."
7259 #: ../fish/guestfish-actions.pod:718
7260 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:718
7265 #: ../fish/guestfish-actions.pod:720
7266 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:720
7269 " command 'arguments ...'\n"
7274 #: ../fish/guestfish-actions.pod:722
7275 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:722
7276 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1089
7277 #: ../src/guestfs-actions.pod:1089
7279 "This call runs a command from the guest filesystem. The filesystem must be "
7280 "mounted, and must contain a compatible operating system (ie. something "
7281 "Linux, with the same or compatible processor architecture)."
7285 #: ../fish/guestfish-actions.pod:727
7286 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:727
7288 "The single parameter is an argv-style list of arguments. The first element "
7289 "is the name of the program to run. Subsequent elements are parameters. The "
7290 "list must be non-empty (ie. must contain a program name). Note that the "
7291 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
7295 #: ../fish/guestfish-actions.pod:734
7296 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:734
7297 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1101
7298 #: ../src/guestfs-actions.pod:1101
7299 msgid "The return value is anything printed to I<stdout> by the command."
7303 #: ../fish/guestfish-actions.pod:737
7304 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:737
7305 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1104
7306 #: ../src/guestfs-actions.pod:1104
7308 "If the command returns a non-zero exit status, then this function returns an "
7309 "error message. The error message string is the content of I<stderr> from "
7314 #: ../fish/guestfish-actions.pod:741
7315 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:741
7316 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1108
7317 #: ../src/guestfs-actions.pod:1108
7319 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7320 "bin>. If you require a program from another location, you should provide "
7321 "the full path in the first parameter."
7325 #: ../fish/guestfish-actions.pod:746
7326 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:746
7327 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1113
7328 #: ../src/guestfs-actions.pod:1113
7330 "Shared libraries and data files required by the program must be available on "
7331 "filesystems which are mounted in the correct places. It is the caller's "
7332 "responsibility to ensure all filesystems that are needed are mounted at the "
7337 #: ../fish/guestfish-actions.pod:755
7338 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:755
7339 msgid "command-lines"
7343 #: ../fish/guestfish-actions.pod:757
7344 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:757
7347 " command-lines 'arguments ...'\n"
7352 #: ../fish/guestfish-actions.pod:759
7353 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:759
7355 "This is the same as L</command>, but splits the result into a list of lines."
7359 #: ../fish/guestfish-actions.pod:762
7360 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:762
7361 msgid "See also: L</sh-lines>"
7365 #: ../fish/guestfish-actions.pod:767
7366 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:767
7371 #: ../fish/guestfish-actions.pod:769
7372 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:769
7375 " config qemuparam qemuvalue\n"
7380 #: ../fish/guestfish-actions.pod:771
7381 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:771
7382 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1154
7383 #: ../src/guestfs-actions.pod:1154
7385 "This can be used to add arbitrary qemu command line parameters of the form "
7386 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
7387 "setting some parameters which would interfere with parameters that we use."
7391 #: ../fish/guestfish-actions.pod:776
7392 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:776
7393 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1159
7394 #: ../src/guestfs-actions.pod:1159
7395 msgid "The first character of C<param> string must be a C<-> (dash)."
7399 #: ../fish/guestfish-actions.pod:778
7400 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:778
7401 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1161
7402 #: ../src/guestfs-actions.pod:1161
7403 msgid "C<value> can be NULL."
7407 #: ../fish/guestfish-actions.pod:780
7408 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:780
7413 #: ../fish/guestfish-actions.pod:782
7414 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:782
7417 " copy-size src dest size\n"
7422 #: ../fish/guestfish-actions.pod:784
7423 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:784
7424 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1175
7425 #: ../src/guestfs-actions.pod:1175
7427 "This command copies exactly C<size> bytes from one source device or file "
7428 "C<src> to another destination device or file C<dest>."
7432 #: ../fish/guestfish-actions.pod:787
7433 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:787
7434 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1178
7435 #: ../src/guestfs-actions.pod:1178
7437 "Note this will fail if the source is too short or if the destination is not "
7442 #: ../fish/guestfish-actions.pod:790
7443 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:790
7448 #: ../fish/guestfish-actions.pod:792
7449 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:792
7457 #: ../fish/guestfish-actions.pod:794
7458 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:794
7459 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1197
7460 #: ../src/guestfs-actions.pod:1197
7462 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7463 "destination filename or destination directory."
7467 #: ../fish/guestfish-actions.pod:797
7468 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:797
7473 #: ../fish/guestfish-actions.pod:799
7474 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:799
7482 #: ../fish/guestfish-actions.pod:801
7483 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:801
7484 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1211
7485 #: ../src/guestfs-actions.pod:1211
7487 "This copies a file or directory from C<src> to C<dest> recursively using the "
7492 #: ../fish/guestfish-actions.pod:804
7493 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:804
7498 #: ../fish/guestfish-actions.pod:806
7499 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:806
7507 #: ../fish/guestfish-actions.pod:808
7508 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:808
7509 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1225
7510 #: ../src/guestfs-actions.pod:1225
7512 "This command copies from one source device or file C<src> to another "
7513 "destination device or file C<dest>. Normally you would use this to copy to "
7514 "or from a device or partition, for example to duplicate a filesystem."
7518 #: ../fish/guestfish-actions.pod:813
7519 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:813
7521 "If the destination is a device, it must be as large or larger than the "
7522 "source file or device, otherwise the copy will fail. This command cannot do "
7523 "partial copies (see L</copy-size>)."
7527 #: ../fish/guestfish-actions.pod:817
7528 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:817
7533 #: ../fish/guestfish-actions.pod:819
7534 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:819
7542 #: ../fish/guestfish-actions.pod:821
7543 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:821
7544 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1243
7545 #: ../src/guestfs-actions.pod:1243
7546 msgid "This command runs the C<df> command to report disk space used."
7550 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:834
7551 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:823
7552 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:834
7554 "This command is mostly useful for interactive sessions. It is I<not> "
7555 "intended that you try to parse the output string. Use L</statvfs> from "
7560 #: ../fish/guestfish-actions.pod:827
7561 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:827
7566 #: ../fish/guestfish-actions.pod:829
7567 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:829
7575 #: ../fish/guestfish-actions.pod:831
7576 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:831
7577 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1259
7578 #: ../src/guestfs-actions.pod:1259
7580 "This command runs the C<df -h> command to report disk space used in human-"
7585 #: ../fish/guestfish-actions.pod:838
7586 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:838
7591 #: ../fish/guestfish-actions.pod:840
7592 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:840
7600 #: ../fish/guestfish-actions.pod:842
7601 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:842
7602 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1276
7603 #: ../src/guestfs-actions.pod:1276
7605 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7606 "This is sometimes useful for extended debugging of problems."
7610 #: ../fish/guestfish-actions.pod:846
7611 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:846
7613 "Another way to get the same information is to enable verbose messages with "
7614 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
7615 "before running the program."
7619 #: ../fish/guestfish-actions.pod:851
7620 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:851
7625 #: ../fish/guestfish-actions.pod:853
7626 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:853
7629 " download remotefilename (filename|-)\n"
7634 #: ../fish/guestfish-actions.pod:855 ../fish/guestfish-actions.pod:868
7635 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:855
7636 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:868
7637 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1297
7638 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1322
7639 #: ../src/guestfs-actions.pod:1297 ../src/guestfs-actions.pod:1322
7641 "Download file C<remotefilename> and save it as C<filename> on the local "
7646 #: ../fish/guestfish-actions.pod:858 ../fish/guestfish-actions.pod:4803
7647 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:858
7648 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4803
7649 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1300
7650 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7232
7651 #: ../src/guestfs-actions.pod:1300 ../src/guestfs-actions.pod:7232
7652 msgid "C<filename> can also be a named pipe."
7656 #: ../fish/guestfish-actions.pod:860
7657 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:860
7658 msgid "See also L</upload>, L</cat>."
7662 #: ../fish/guestfish-actions.pod:864
7663 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:864
7664 msgid "download-offset"
7668 #: ../fish/guestfish-actions.pod:866
7669 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:866
7672 " download-offset remotefilename (filename|-) offset size\n"
7677 #: ../fish/guestfish-actions.pod:871
7678 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:871
7679 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1325
7680 #: ../src/guestfs-actions.pod:1325
7682 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7683 "region must be within the file or device)."
7687 #: ../fish/guestfish-actions.pod:874
7688 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:874
7690 "Note that there is no limit on the amount of data that can be downloaded "
7691 "with this call, unlike with L</pread>, and this call always reads the full "
7692 "amount unless an error occurs."
7696 #: ../fish/guestfish-actions.pod:879
7697 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:879
7698 msgid "See also L</download>, L</pread>."
7702 #: ../fish/guestfish-actions.pod:883
7703 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:883
7708 #: ../fish/guestfish-actions.pod:885
7709 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:885
7712 " drop-caches whattodrop\n"
7717 #: ../fish/guestfish-actions.pod:887
7718 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:887
7719 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1350
7720 #: ../src/guestfs-actions.pod:1350
7722 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7723 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7724 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7728 #: ../fish/guestfish-actions.pod:892
7729 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:892
7730 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1355
7731 #: ../src/guestfs-actions.pod:1355
7732 msgid "Setting C<whattodrop> to 3 should drop everything."
7736 #: ../fish/guestfish-actions.pod:894
7737 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:894
7738 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1357
7739 #: ../src/guestfs-actions.pod:1357
7741 "This automatically calls L<sync(2)> before the operation, so that the "
7742 "maximum guest memory is freed."
7746 #: ../fish/guestfish-actions.pod:897
7747 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:897
7752 #: ../fish/guestfish-actions.pod:899
7753 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:899
7761 #: ../fish/guestfish-actions.pod:901
7762 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:901
7763 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1370
7764 #: ../src/guestfs-actions.pod:1370
7766 "This command runs the C<du -s> command to estimate file space usage for "
7771 #: ../fish/guestfish-actions.pod:904
7772 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:904
7773 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1373
7774 #: ../src/guestfs-actions.pod:1373
7776 "C<path> can be a file or a directory. If C<path> is a directory then the "
7777 "estimate includes the contents of the directory and all subdirectories "
7782 #: ../fish/guestfish-actions.pod:908
7783 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:908
7784 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1377
7785 #: ../src/guestfs-actions.pod:1377
7787 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
7791 #: ../fish/guestfish-actions.pod:911
7792 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:911
7797 #: ../fish/guestfish-actions.pod:913
7798 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:913
7801 " e2fsck-f device\n"
7806 #: ../fish/guestfish-actions.pod:915
7807 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:915
7808 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1395
7809 #: ../src/guestfs-actions.pod:1395
7811 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
7812 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
7817 #: ../fish/guestfish-actions.pod:919
7818 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:919
7820 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
7821 "should use L</fsck>."
7825 #: ../fish/guestfish-actions.pod:922
7826 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:922
7831 #: ../fish/guestfish-actions.pod:924
7832 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:924
7835 " echo-daemon 'words ...'\n"
7840 #: ../fish/guestfish-actions.pod:926
7841 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:926
7842 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1412
7843 #: ../src/guestfs-actions.pod:1412
7845 "This command concatenates the list of C<words> passed with single spaces "
7846 "between them and returns the resulting string."
7850 #: ../fish/guestfish-actions.pod:929
7851 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:929
7852 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1415
7853 #: ../src/guestfs-actions.pod:1415
7854 msgid "You can use this command to test the connection through to the daemon."
7858 #: ../fish/guestfish-actions.pod:931
7859 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:931
7860 msgid "See also L</ping-daemon>."
7864 #: ../fish/guestfish-actions.pod:933
7865 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:933
7870 #: ../fish/guestfish-actions.pod:935
7871 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:935
7874 " egrep regex path\n"
7879 #: ../fish/guestfish-actions.pod:937
7880 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:937
7881 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1431
7882 #: ../src/guestfs-actions.pod:1431
7884 "This calls the external C<egrep> program and returns the matching lines."
7888 #: ../fish/guestfish-actions.pod:943
7889 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:943
7894 #: ../fish/guestfish-actions.pod:945
7895 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:945
7898 " egrepi regex path\n"
7903 #: ../fish/guestfish-actions.pod:947
7904 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:947
7905 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1450
7906 #: ../src/guestfs-actions.pod:1450
7908 "This calls the external C<egrep -i> program and returns the matching lines."
7912 #: ../fish/guestfish-actions.pod:953
7913 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:953
7918 #: ../fish/guestfish-actions.pod:955
7919 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:955
7922 " equal file1 file2\n"
7927 #: ../fish/guestfish-actions.pod:957
7928 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:957
7929 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1469
7930 #: ../src/guestfs-actions.pod:1469
7932 "This compares the two files C<file1> and C<file2> and returns true if their "
7933 "content is exactly equal, or false otherwise."
7937 #: ../fish/guestfish-actions.pod:960
7938 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:960
7939 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1472
7940 #: ../src/guestfs-actions.pod:1472
7941 msgid "The external L<cmp(1)> program is used for the comparison."
7945 #: ../fish/guestfish-actions.pod:962
7946 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:962
7951 #: ../fish/guestfish-actions.pod:964
7952 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:964
7960 #: ../fish/guestfish-actions.pod:966
7961 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:966
7962 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1484
7963 #: ../src/guestfs-actions.pod:1484
7965 "This returns C<true> if and only if there is a file, directory (or anything) "
7966 "with the given C<path> name."
7970 #: ../fish/guestfish-actions.pod:969
7971 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:969
7972 msgid "See also L</is-file>, L</is-dir>, L</stat>."
7976 #: ../fish/guestfish-actions.pod:971
7977 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:971
7982 #: ../fish/guestfish-actions.pod:973
7983 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:973
7986 " fallocate path len\n"
7991 #: ../fish/guestfish-actions.pod:975 ../fish/guestfish-actions.pod:994
7992 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:975
7993 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:994
7994 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1500
7995 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1526
7996 #: ../src/guestfs-actions.pod:1500 ../src/guestfs-actions.pod:1526
7998 "This command preallocates a file (containing zero bytes) named C<path> of "
7999 "size C<len> bytes. If the file exists already, it is overwritten."
8003 #: ../fish/guestfish-actions.pod:979
8004 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:979
8005 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1504
8006 #: ../src/guestfs-actions.pod:1504
8008 "Do not confuse this with the guestfish-specific C<alloc> command which "
8009 "allocates a file in the host and attaches it as a device."
8013 #: ../fish/guestfish-actions.pod:983
8014 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:983
8015 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1510
8016 #: ../src/guestfs-actions.pod:1510
8018 "This function is deprecated. In new code, use the C<fallocate64> call "
8023 #: ../fish/guestfish-actions.pod:990
8024 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:990
8029 #: ../fish/guestfish-actions.pod:992
8030 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:992
8033 " fallocate64 path len\n"
8038 #: ../fish/guestfish-actions.pod:998
8039 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:998
8041 "Note that this call allocates disk blocks for the file. To create a sparse "
8042 "file use L</truncate-size> instead."
8046 #: ../fish/guestfish-actions.pod:1001
8047 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1001
8049 "The deprecated call L</fallocate> does the same, but owing to an oversight "
8050 "it only allowed 30 bit lengths to be specified, effectively limiting the "
8051 "maximum size of files created through that call to 1GB."
8055 #: ../fish/guestfish-actions.pod:1006
8056 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1006
8057 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1538
8058 #: ../src/guestfs-actions.pod:1538
8060 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8061 "commands which create a file in the host and attach it as a device."
8065 #: ../fish/guestfish-actions.pod:1010
8066 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1010
8071 #: ../fish/guestfish-actions.pod:1012
8072 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1012
8075 " fgrep pattern path\n"
8080 #: ../fish/guestfish-actions.pod:1014
8081 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1014
8082 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1553
8083 #: ../src/guestfs-actions.pod:1553
8085 "This calls the external C<fgrep> program and returns the matching lines."
8089 #: ../fish/guestfish-actions.pod:1020
8090 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1020
8095 #: ../fish/guestfish-actions.pod:1022
8096 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1022
8099 " fgrepi pattern path\n"
8104 #: ../fish/guestfish-actions.pod:1024
8105 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1024
8106 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1572
8107 #: ../src/guestfs-actions.pod:1572
8109 "This calls the external C<fgrep -i> program and returns the matching lines."
8113 #: ../fish/guestfish-actions.pod:1030
8114 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1030
8119 #: ../fish/guestfish-actions.pod:1032
8120 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1032
8128 #: ../fish/guestfish-actions.pod:1034
8129 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1034
8130 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1590
8131 #: ../src/guestfs-actions.pod:1590
8133 "This call uses the standard L<file(1)> command to determine the type or "
8134 "contents of the file."
8138 #: ../fish/guestfish-actions.pod:1037
8139 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1037
8140 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1593
8141 #: ../src/guestfs-actions.pod:1593
8143 "This call will also transparently look inside various types of compressed "
8148 #: ../fish/guestfish-actions.pod:1040
8149 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1040
8150 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1596
8151 #: ../src/guestfs-actions.pod:1596
8153 "The exact command which runs is C<file -zb path>. Note in particular that "
8154 "the filename is not prepended to the output (the I<-b> option)."
8158 #: ../fish/guestfish-actions.pod:1044
8159 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1044
8160 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1600
8161 #: ../src/guestfs-actions.pod:1600
8163 "The output depends on the output of the underlying L<file(1)> command and it "
8164 "can change in future in ways beyond our control. In other words, the output "
8165 "is not guaranteed by the ABI."
8169 #: ../fish/guestfish-actions.pod:1048
8170 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1048
8172 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
8173 "(etc), L</is-zero>."
8177 #: ../fish/guestfish-actions.pod:1051
8178 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1051
8179 msgid "file-architecture"
8183 #: ../fish/guestfish-actions.pod:1053
8184 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1053
8187 " file-architecture filename\n"
8192 #: ../fish/guestfish-actions.pod:1055
8193 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1055
8194 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1618
8195 #: ../src/guestfs-actions.pod:1618
8197 "This detects the architecture of the binary C<filename>, and returns it if "
8202 #: ../fish/guestfish-actions.pod:1058
8203 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1058
8204 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1621
8205 #: ../src/guestfs-actions.pod:1621
8206 msgid "Currently defined architectures are:"
8210 #: ../fish/guestfish-actions.pod:1062
8211 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1062
8212 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1625
8213 #: ../src/guestfs-actions.pod:1625
8218 #: ../fish/guestfish-actions.pod:1064
8219 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1064
8220 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1627
8221 #: ../src/guestfs-actions.pod:1627
8223 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8224 "irrespective of the precise processor requirements of the binary."
8228 #: ../fish/guestfish-actions.pod:1067
8229 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1067
8230 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1630
8231 #: ../src/guestfs-actions.pod:1630
8236 #: ../fish/guestfish-actions.pod:1069
8237 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1069
8238 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1632
8239 #: ../src/guestfs-actions.pod:1632
8240 msgid "64 bit x86-64."
8244 #: ../fish/guestfish-actions.pod:1071
8245 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1071
8246 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1634
8247 #: ../src/guestfs-actions.pod:1634
8252 #: ../fish/guestfish-actions.pod:1073
8253 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1073
8254 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1636
8255 #: ../src/guestfs-actions.pod:1636
8256 msgid "32 bit SPARC."
8260 #: ../fish/guestfish-actions.pod:1075
8261 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1075
8262 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1638
8263 #: ../src/guestfs-actions.pod:1638
8268 #: ../fish/guestfish-actions.pod:1077
8269 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1077
8270 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1640
8271 #: ../src/guestfs-actions.pod:1640
8272 msgid "64 bit SPARC V9 and above."
8276 #: ../fish/guestfish-actions.pod:1079
8277 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1079
8278 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1642
8279 #: ../src/guestfs-actions.pod:1642
8284 #: ../fish/guestfish-actions.pod:1081
8285 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1081
8286 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1644
8287 #: ../src/guestfs-actions.pod:1644
8288 msgid "Intel Itanium."
8292 #: ../fish/guestfish-actions.pod:1083
8293 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1083
8294 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1646
8295 #: ../src/guestfs-actions.pod:1646
8300 #: ../fish/guestfish-actions.pod:1085
8301 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1085
8302 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1648
8303 #: ../src/guestfs-actions.pod:1648
8304 msgid "32 bit Power PC."
8308 #: ../fish/guestfish-actions.pod:1087
8309 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1087
8310 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1650
8311 #: ../src/guestfs-actions.pod:1650
8316 #: ../fish/guestfish-actions.pod:1089
8317 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1089
8318 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1652
8319 #: ../src/guestfs-actions.pod:1652
8320 msgid "64 bit Power PC."
8324 #: ../fish/guestfish-actions.pod:1093
8325 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1093
8326 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1656
8327 #: ../src/guestfs-actions.pod:1656
8328 msgid "Libguestfs may return other architecture strings in future."
8332 #: ../fish/guestfish-actions.pod:1095
8333 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1095
8334 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1658
8335 #: ../src/guestfs-actions.pod:1658
8336 msgid "The function works on at least the following types of files:"
8340 #: ../fish/guestfish-actions.pod:1101
8341 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1101
8342 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1664
8343 #: ../src/guestfs-actions.pod:1664
8344 msgid "many types of Un*x and Linux binary"
8348 #: ../fish/guestfish-actions.pod:1105
8349 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1105
8350 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1668
8351 #: ../src/guestfs-actions.pod:1668
8352 msgid "many types of Un*x and Linux shared library"
8356 #: ../fish/guestfish-actions.pod:1109
8357 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1109
8358 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1672
8359 #: ../src/guestfs-actions.pod:1672
8360 msgid "Windows Win32 and Win64 binaries"
8364 #: ../fish/guestfish-actions.pod:1113
8365 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1113
8366 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1676
8367 #: ../src/guestfs-actions.pod:1676
8368 msgid "Windows Win32 and Win64 DLLs"
8372 #: ../fish/guestfish-actions.pod:1115
8373 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1115
8374 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1678
8375 #: ../src/guestfs-actions.pod:1678
8376 msgid "Win32 binaries and DLLs return C<i386>."
8380 #: ../fish/guestfish-actions.pod:1117
8381 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1117
8382 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1680
8383 #: ../src/guestfs-actions.pod:1680
8384 msgid "Win64 binaries and DLLs return C<x86_64>."
8388 #: ../fish/guestfish-actions.pod:1121
8389 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1121
8390 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1684
8391 #: ../src/guestfs-actions.pod:1684
8392 msgid "Linux kernel modules"
8396 #: ../fish/guestfish-actions.pod:1125
8397 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1125
8398 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1688
8399 #: ../src/guestfs-actions.pod:1688
8400 msgid "Linux new-style initrd images"
8404 #: ../fish/guestfish-actions.pod:1129
8405 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1129
8406 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1692
8407 #: ../src/guestfs-actions.pod:1692
8408 msgid "some non-x86 Linux vmlinuz kernels"
8412 #: ../fish/guestfish-actions.pod:1133
8413 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1133
8414 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1696
8415 #: ../src/guestfs-actions.pod:1696
8416 msgid "What it can't do currently:"
8420 #: ../fish/guestfish-actions.pod:1139
8421 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1139
8422 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1702
8423 #: ../src/guestfs-actions.pod:1702
8424 msgid "static libraries (libfoo.a)"
8428 #: ../fish/guestfish-actions.pod:1143
8429 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1143
8430 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1706
8431 #: ../src/guestfs-actions.pod:1706
8432 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8436 #: ../fish/guestfish-actions.pod:1147
8437 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1147
8438 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1710
8439 #: ../src/guestfs-actions.pod:1710
8440 msgid "x86 Linux vmlinuz kernels"
8444 #: ../fish/guestfish-actions.pod:1149
8445 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1149
8446 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1712
8447 #: ../src/guestfs-actions.pod:1712
8449 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8450 "compressed code, and are horribly hard to unpack. If you want to find the "
8451 "architecture of a kernel, use the architecture of the associated initrd or "
8452 "kernel module(s) instead."
8456 #: ../fish/guestfish-actions.pod:1156
8457 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1156
8462 #: ../fish/guestfish-actions.pod:1158
8463 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1158
8471 #: ../fish/guestfish-actions.pod:1160
8472 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1160
8473 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1730
8474 #: ../src/guestfs-actions.pod:1730
8475 msgid "This command returns the size of C<file> in bytes."
8479 #: ../fish/guestfish-actions.pod:1162
8480 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1162
8482 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
8483 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
8487 #: ../fish/guestfish-actions.pod:1166
8488 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1166
8493 #: ../fish/guestfish-actions.pod:1168
8494 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1168
8497 " fill c len path\n"
8502 #: ../fish/guestfish-actions.pod:1170
8503 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1170
8504 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1748
8505 #: ../src/guestfs-actions.pod:1748
8507 "This command creates a new file called C<path>. The initial content of the "
8508 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
8513 #: ../fish/guestfish-actions.pod:1174
8514 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1174
8516 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8517 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
8522 #: ../fish/guestfish-actions.pod:1179
8523 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1179
8524 msgid "fill-pattern"
8528 #: ../fish/guestfish-actions.pod:1181
8529 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1181
8532 " fill-pattern pattern len path\n"
8537 #: ../fish/guestfish-actions.pod:1183
8538 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1183
8540 "This function is like L</fill> except that it creates a new file of length "
8541 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
8542 "is truncated if necessary to ensure the length of the file is exactly C<len> "
8547 #: ../fish/guestfish-actions.pod:1188
8548 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1188
8553 #: ../fish/guestfish-actions.pod:1190
8554 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1190
8562 #: ../fish/guestfish-actions.pod:1192
8563 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1192
8564 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1794
8565 #: ../src/guestfs-actions.pod:1794
8567 "This command lists out all files and directories, recursively, starting at "
8568 "C<directory>. It is essentially equivalent to running the shell command "
8569 "C<find directory -print> but some post-processing happens on the output, "
8574 #: ../fish/guestfish-actions.pod:1197
8575 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1197
8576 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1799
8577 #: ../src/guestfs-actions.pod:1799
8579 "This returns a list of strings I<without any prefix>. Thus if the directory "
8584 #: ../fish/guestfish-actions.pod:1200
8585 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1200
8586 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1802
8587 #: ../src/guestfs-actions.pod:1802
8597 #: ../fish/guestfish-actions.pod:1204
8598 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1204
8599 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
8603 #: ../fish/guestfish-actions.pod:1207
8604 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1207
8605 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1809
8606 #: ../src/guestfs-actions.pod:1809
8617 #: ../fish/guestfish-actions.pod:1212
8618 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1212
8619 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1814
8620 #: ../src/guestfs-actions.pod:1814
8621 msgid "If C<directory> is not a directory, then this command returns an error."
8625 #: ../fish/guestfish-actions.pod:1215
8626 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1215
8627 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1817
8628 #: ../src/guestfs-actions.pod:1817
8629 msgid "The returned list is sorted."
8633 #: ../fish/guestfish-actions.pod:1217
8634 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1217
8635 msgid "See also L</find0>."
8639 #: ../fish/guestfish-actions.pod:1222
8640 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1222
8645 #: ../fish/guestfish-actions.pod:1224
8646 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1224
8649 " find0 directory (files|-)\n"
8654 #: ../fish/guestfish-actions.pod:1226
8655 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1226
8656 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1837
8657 #: ../src/guestfs-actions.pod:1837
8659 "This command lists out all files and directories, recursively, starting at "
8660 "C<directory>, placing the resulting list in the external file called "
8665 #: ../fish/guestfish-actions.pod:1230
8666 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1230
8668 "This command works the same way as L</find> with the following exceptions:"
8672 #: ../fish/guestfish-actions.pod:1237
8673 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1237
8674 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1848
8675 #: ../src/guestfs-actions.pod:1848
8676 msgid "The resulting list is written to an external file."
8680 #: ../fish/guestfish-actions.pod:1241
8681 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1241
8682 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1852
8683 #: ../src/guestfs-actions.pod:1852
8685 "Items (filenames) in the result are separated by C<\\0> characters. See "
8686 "L<find(1)> option I<-print0>."
8690 #: ../fish/guestfish-actions.pod:1246
8691 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1246
8692 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1857
8693 #: ../src/guestfs-actions.pod:1857
8694 msgid "This command is not limited in the number of names that it can return."
8698 #: ../fish/guestfish-actions.pod:1251
8699 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1251
8700 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1862
8701 #: ../src/guestfs-actions.pod:1862
8702 msgid "The result list is not sorted."
8706 #: ../fish/guestfish-actions.pod:1257
8707 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1257
8708 msgid "findfs-label"
8712 #: ../fish/guestfish-actions.pod:1259
8713 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1259
8716 " findfs-label label\n"
8721 #: ../fish/guestfish-actions.pod:1261
8722 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1261
8723 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1876
8724 #: ../src/guestfs-actions.pod:1876
8726 "This command searches the filesystems and returns the one which has the "
8727 "given label. An error is returned if no such filesystem can be found."
8731 #: ../fish/guestfish-actions.pod:1265
8732 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1265
8733 msgid "To find the label of a filesystem, use L</vfs-label>."
8737 #: ../fish/guestfish-actions.pod:1267
8738 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1267
8743 #: ../fish/guestfish-actions.pod:1269
8744 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1269
8747 " findfs-uuid uuid\n"
8752 #: ../fish/guestfish-actions.pod:1271
8753 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1271
8754 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1893
8755 #: ../src/guestfs-actions.pod:1893
8757 "This command searches the filesystems and returns the one which has the "
8758 "given UUID. An error is returned if no such filesystem can be found."
8762 #: ../fish/guestfish-actions.pod:1275
8763 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1275
8764 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
8768 #: ../fish/guestfish-actions.pod:1277
8769 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1277
8774 #: ../fish/guestfish-actions.pod:1279
8775 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1279
8778 " fsck fstype device\n"
8783 #: ../fish/guestfish-actions.pod:1281
8784 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1281
8785 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1911
8786 #: ../src/guestfs-actions.pod:1911
8788 "This runs the filesystem checker (fsck) on C<device> which should have "
8789 "filesystem type C<fstype>."
8793 #: ../fish/guestfish-actions.pod:1284
8794 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1284
8795 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1914
8796 #: ../src/guestfs-actions.pod:1914
8798 "The returned integer is the status. See L<fsck(8)> for the list of status "
8799 "codes from C<fsck>."
8803 #: ../fish/guestfish-actions.pod:1293
8804 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1293
8805 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1923
8806 #: ../src/guestfs-actions.pod:1923
8807 msgid "Multiple status codes can be summed together."
8811 #: ../fish/guestfish-actions.pod:1297
8812 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1297
8813 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1927
8814 #: ../src/guestfs-actions.pod:1927
8816 "A non-zero return code can mean \"success\", for example if errors have been "
8817 "corrected on the filesystem."
8821 #: ../fish/guestfish-actions.pod:1302
8822 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1302
8823 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1932
8824 #: ../src/guestfs-actions.pod:1932
8825 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8829 #: ../fish/guestfish-actions.pod:1307
8830 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1307
8831 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1937
8832 #: ../src/guestfs-actions.pod:1937
8834 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8838 #: ../fish/guestfish-actions.pod:1309
8839 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1309
8844 #: ../fish/guestfish-actions.pod:1311
8845 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1311
8853 #: ../fish/guestfish-actions.pod:1313
8854 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1313
8855 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1948
8856 #: ../src/guestfs-actions.pod:1948
8858 "Return the additional kernel options which are added to the guest kernel "
8863 #: ../fish/guestfish-actions.pod:1316
8864 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1316
8865 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1951
8866 #: ../src/guestfs-actions.pod:1951
8867 msgid "If C<NULL> then no options are added."
8871 #: ../fish/guestfish-actions.pod:1318
8872 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1318
8873 msgid "get-attach-method"
8877 #: ../fish/guestfish-actions.pod:1320
8878 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1320
8881 " get-attach-method\n"
8886 #: ../fish/guestfish-actions.pod:1322
8887 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1322
8888 msgid "Return the current attach method. See L</set-attach-method>."
8892 #: ../fish/guestfish-actions.pod:1324
8893 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1324
8894 msgid "get-autosync"
8898 #: ../fish/guestfish-actions.pod:1326
8899 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1326
8907 #: ../fish/guestfish-actions.pod:1328
8908 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1328
8909 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1976
8910 #: ../src/guestfs-actions.pod:1976
8911 msgid "Get the autosync flag."
8915 #: ../fish/guestfish-actions.pod:1330
8916 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1330
8921 #: ../fish/guestfish-actions.pod:1332
8922 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1332
8930 #: ../fish/guestfish-actions.pod:1334
8931 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1334
8932 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1987
8933 #: ../src/guestfs-actions.pod:1987
8934 msgid "Return the direct appliance mode flag."
8938 #: ../fish/guestfish-actions.pod:1336
8939 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1336
8944 #: ../fish/guestfish-actions.pod:1338
8945 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1338
8948 " get-e2label device\n"
8953 #: ../fish/guestfish-actions.pod:1340
8954 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1340
8955 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1999
8956 #: ../src/guestfs-actions.pod:1999
8958 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8962 #: ../fish/guestfish-actions.pod:1343
8963 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1343
8964 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2005
8965 #: ../src/guestfs-actions.pod:2005
8967 "This function is deprecated. In new code, use the C<vfs_label> call instead."
8971 #: ../fish/guestfish-actions.pod:1350
8972 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1350
8977 #: ../fish/guestfish-actions.pod:1352
8978 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1352
8981 " get-e2uuid device\n"
8986 #: ../fish/guestfish-actions.pod:1354
8987 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1354
8988 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2020
8989 #: ../src/guestfs-actions.pod:2020
8991 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
8995 #: ../fish/guestfish-actions.pod:1357
8996 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1357
8997 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2026
8998 #: ../src/guestfs-actions.pod:2026
9000 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9004 #: ../fish/guestfish-actions.pod:1364
9005 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1364
9010 #: ../fish/guestfish-actions.pod:1366
9011 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1366
9019 #: ../fish/guestfish-actions.pod:1368
9020 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1368
9021 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2040
9022 #: ../src/guestfs-actions.pod:2040
9024 "This gets the memory size in megabytes allocated to the qemu subprocess."
9028 #: ../fish/guestfish-actions.pod:1371
9029 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1371
9031 "If L</set-memsize> was not called on this handle, and if "
9032 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9033 "value for memsize."
9037 #: ../fish/guestfish-actions.pod:1375 ../fish/guestfish-actions.pod:1432
9038 #: ../fish/guestfish-actions.pod:4163 ../fish/guestfish-actions.pod:4265
9039 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1375
9040 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1432
9041 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4163
9042 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4265
9043 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2047
9044 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2139
9045 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6293
9046 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6419
9047 #: ../src/guestfs-actions.pod:2047 ../src/guestfs-actions.pod:2139
9048 #: ../src/guestfs-actions.pod:6293 ../src/guestfs-actions.pod:6419
9050 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9054 #: ../fish/guestfish-actions.pod:1378
9055 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1378
9060 #: ../fish/guestfish-actions.pod:1380
9061 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1380
9069 #: ../fish/guestfish-actions.pod:1382
9070 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1382
9071 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2059
9072 #: ../src/guestfs-actions.pod:2059
9073 msgid "This returns the enable network flag."
9077 #: ../fish/guestfish-actions.pod:1384
9078 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1384
9083 #: ../fish/guestfish-actions.pod:1386
9084 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1386
9092 #: ../fish/guestfish-actions.pod:1388
9093 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1388
9094 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2070
9095 #: ../src/guestfs-actions.pod:2070
9096 msgid "Return the current search path."
9100 #: ../fish/guestfish-actions.pod:1390
9101 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1390
9102 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2072
9103 #: ../src/guestfs-actions.pod:2072
9105 "This is always non-NULL. If it wasn't set already, then this will return "
9110 #: ../fish/guestfish-actions.pod:1393
9111 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1393
9116 #: ../fish/guestfish-actions.pod:1395
9117 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1395
9125 #: ../fish/guestfish-actions.pod:1397
9126 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1397
9127 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2085
9128 #: ../src/guestfs-actions.pod:2085
9129 msgid "This returns the process group flag."
9133 #: ../fish/guestfish-actions.pod:1399
9134 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1399
9139 #: ../fish/guestfish-actions.pod:1401
9140 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1401
9145 #: ../fish/guestfish-actions.pod:1403
9146 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1403
9154 #: ../fish/guestfish-actions.pod:1405
9155 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1405
9156 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2096
9157 #: ../src/guestfs-actions.pod:2096
9159 "Return the process ID of the qemu subprocess. If there is no qemu "
9160 "subprocess, then this will return an error."
9164 #: ../fish/guestfish-actions.pod:1408
9165 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1408
9166 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2099
9167 #: ../src/guestfs-actions.pod:2099
9168 msgid "This is an internal call used for debugging and testing."
9172 #: ../fish/guestfish-actions.pod:1410
9173 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1410
9178 #: ../fish/guestfish-actions.pod:1412
9179 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1412
9187 #: ../fish/guestfish-actions.pod:1414
9188 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1414
9189 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2110
9190 #: ../src/guestfs-actions.pod:2110
9191 msgid "Return the current qemu binary."
9195 #: ../fish/guestfish-actions.pod:1416
9196 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1416
9197 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2112
9198 #: ../src/guestfs-actions.pod:2112
9200 "This is always non-NULL. If it wasn't set already, then this will return "
9201 "the default qemu binary name."
9205 #: ../fish/guestfish-actions.pod:1419
9206 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1419
9207 msgid "get-recovery-proc"
9211 #: ../fish/guestfish-actions.pod:1421
9212 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1421
9215 " get-recovery-proc\n"
9220 #: ../fish/guestfish-actions.pod:1423
9221 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1423
9222 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2125
9223 #: ../src/guestfs-actions.pod:2125
9224 msgid "Return the recovery process enabled flag."
9228 #: ../fish/guestfish-actions.pod:1425
9229 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1425
9234 #: ../fish/guestfish-actions.pod:1427
9235 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1427
9243 #: ../fish/guestfish-actions.pod:1429
9244 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1429
9246 "This returns the current setting of the selinux flag which is passed to the "
9247 "appliance at boot time. See L</set-selinux>."
9251 #: ../fish/guestfish-actions.pod:1435
9252 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1435
9257 #: ../fish/guestfish-actions.pod:1437
9258 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1437
9266 #: ../fish/guestfish-actions.pod:1439
9267 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1439
9268 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2151
9269 #: ../src/guestfs-actions.pod:2151
9271 "This returns the current state as an opaque integer. This is only useful "
9272 "for printing debug and internal error messages."
9276 #: ../fish/guestfish-actions.pod:1442 ../fish/guestfish-actions.pod:2362
9277 #: ../fish/guestfish-actions.pod:2380 ../fish/guestfish-actions.pod:2418
9278 #: ../fish/guestfish-actions.pod:2434
9279 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1442
9280 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2362
9281 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2380
9282 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2418
9283 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2434
9284 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2154
9285 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3434
9286 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3463
9287 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3524
9288 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3551
9289 #: ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:3434
9290 #: ../src/guestfs-actions.pod:3463 ../src/guestfs-actions.pod:3524
9291 #: ../src/guestfs-actions.pod:3551
9292 msgid "For more information on states, see L<guestfs(3)>."
9296 #: ../fish/guestfish-actions.pod:1444
9297 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1444
9302 #: ../fish/guestfish-actions.pod:1446
9303 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1446
9311 #: ../fish/guestfish-actions.pod:1448
9312 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1448
9313 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2165
9314 #: ../src/guestfs-actions.pod:2165
9315 msgid "Return the command trace flag."
9319 #: ../fish/guestfish-actions.pod:1450
9320 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1450
9325 #: ../fish/guestfish-actions.pod:1452
9326 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1452
9334 #: ../fish/guestfish-actions.pod:1454
9335 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1454
9337 "Return the current umask. By default the umask is C<022> unless it has been "
9338 "set by calling L</umask>."
9342 #: ../fish/guestfish-actions.pod:1457
9343 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1457
9348 #: ../fish/guestfish-actions.pod:1459
9349 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1459
9357 #: ../fish/guestfish-actions.pod:1461
9358 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1461
9359 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2188
9360 #: ../src/guestfs-actions.pod:2188
9361 msgid "This returns the verbose messages flag."
9365 #: ../fish/guestfish-actions.pod:1463
9366 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1463
9371 #: ../fish/guestfish-actions.pod:1465
9372 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1465
9380 #: ../fish/guestfish-actions.pod:1467
9381 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1467
9382 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2199
9383 #: ../src/guestfs-actions.pod:2199
9384 msgid "This gets the SELinux security context of the daemon."
9388 #: ../fish/guestfish-actions.pod:1469
9389 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1469
9390 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
9394 #: ../fish/guestfish-actions.pod:1472
9395 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1472
9400 #: ../fish/guestfish-actions.pod:1474
9401 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1474
9404 " getxattr path name\n"
9409 #: ../fish/guestfish-actions.pod:1476
9410 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1476
9412 "Get a single extended attribute from file C<path> named C<name>. This call "
9413 "follows symlinks. If you want to lookup an extended attribute for the "
9414 "symlink itself, use L</lgetxattr>."
9418 #: ../fish/guestfish-actions.pod:1480 ../fish/guestfish-actions.pod:2507
9419 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1480
9420 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2507
9422 "Normally it is better to get all extended attributes from a file in one go "
9423 "by calling L</getxattrs>. However some Linux filesystem implementations are "
9424 "buggy and do not provide a way to list out attributes. For these "
9425 "filesystems (notably ntfs-3g) you have to know the names of the extended "
9426 "attributes you want in advance and call this function."
9430 #: ../fish/guestfish-actions.pod:1487 ../fish/guestfish-actions.pod:2514
9431 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1487
9432 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2514
9433 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2228
9434 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3684
9435 #: ../src/guestfs-actions.pod:2228 ../src/guestfs-actions.pod:3684
9437 "Extended attribute values are blobs of binary data. If there is no extended "
9438 "attribute named C<name>, this returns an error."
9442 #: ../fish/guestfish-actions.pod:1490
9443 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1490
9444 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
9448 #: ../fish/guestfish-actions.pod:1492
9449 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1492
9454 #: ../fish/guestfish-actions.pod:1494
9455 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1494
9463 #: ../fish/guestfish-actions.pod:1496
9464 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1496
9465 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2245
9466 #: ../src/guestfs-actions.pod:2245
9468 "This call lists the extended attributes of the file or directory C<path>."
9472 #: ../fish/guestfish-actions.pod:1499
9473 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1499
9474 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2248
9475 #: ../src/guestfs-actions.pod:2248
9477 "At the system call level, this is a combination of the L<listxattr(2)> and "
9478 "L<getxattr(2)> calls."
9482 #: ../fish/guestfish-actions.pod:1502
9483 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1502
9484 msgid "See also: L</lgetxattrs>, L<attr(5)>."
9488 #: ../fish/guestfish-actions.pod:1504
9489 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1504
9494 #: ../fish/guestfish-actions.pod:1506
9495 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1506
9498 " glob-expand pattern\n"
9503 #: ../fish/guestfish-actions.pod:1508
9504 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1508
9505 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2265
9506 #: ../src/guestfs-actions.pod:2265
9508 "This command searches for all the pathnames matching C<pattern> according to "
9509 "the wildcard expansion rules used by the shell."
9513 #: ../fish/guestfish-actions.pod:1512
9514 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1512
9515 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2269
9516 #: ../src/guestfs-actions.pod:2269
9518 "If no paths match, then this returns an empty list (note: not an error)."
9522 #: ../fish/guestfish-actions.pod:1515
9523 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1515
9524 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2272
9525 #: ../src/guestfs-actions.pod:2272
9527 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
9528 "GLOB_BRACE>. See that manual page for more details."
9532 #: ../fish/guestfish-actions.pod:1519
9533 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1519
9538 #: ../fish/guestfish-actions.pod:1521
9539 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1521
9542 " grep regex path\n"
9547 #: ../fish/guestfish-actions.pod:1523
9548 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1523
9549 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2289
9550 #: ../src/guestfs-actions.pod:2289
9551 msgid "This calls the external C<grep> program and returns the matching lines."
9555 #: ../fish/guestfish-actions.pod:1529
9556 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1529
9561 #: ../fish/guestfish-actions.pod:1531
9562 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1531
9565 " grepi regex path\n"
9570 #: ../fish/guestfish-actions.pod:1533
9571 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1533
9572 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2308
9573 #: ../src/guestfs-actions.pod:2308
9575 "This calls the external C<grep -i> program and returns the matching lines."
9579 #: ../fish/guestfish-actions.pod:1539
9580 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1539
9581 msgid "grub-install"
9585 #: ../fish/guestfish-actions.pod:1541
9586 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1541
9589 " grub-install root device\n"
9594 #: ../fish/guestfish-actions.pod:1543
9595 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1543
9596 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2327
9597 #: ../src/guestfs-actions.pod:2327
9599 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9600 "the root directory being C<root>."
9604 #: ../fish/guestfish-actions.pod:1546
9605 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1546
9606 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2330
9607 #: ../src/guestfs-actions.pod:2330
9609 "Note: If grub-install reports the error \"No suitable drive was found in the "
9610 "generated device map.\" it may be that you need to create a C</boot/grub/"
9611 "device.map> file first that contains the mapping between grub device names "
9612 "and Linux device names. It is usually sufficient to create a file "
9617 #: ../fish/guestfish-actions.pod:1553
9618 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1553
9619 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2337
9620 #: ../src/guestfs-actions.pod:2337
9628 #: ../fish/guestfish-actions.pod:1555
9629 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1555
9630 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2339
9631 #: ../src/guestfs-actions.pod:2339
9632 msgid "replacing C</dev/vda> with the name of the installation device."
9636 #: ../fish/guestfish-actions.pod:1557
9637 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1557
9642 #: ../fish/guestfish-actions.pod:1559
9643 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1559
9651 #: ../fish/guestfish-actions.pod:1561
9652 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1561
9653 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2351
9654 #: ../src/guestfs-actions.pod:2351
9656 "This command returns up to the first 10 lines of a file as a list of strings."
9660 #: ../fish/guestfish-actions.pod:1567
9661 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1567
9666 #: ../fish/guestfish-actions.pod:1569
9667 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1569
9670 " head-n nrlines path\n"
9675 #: ../fish/guestfish-actions.pod:1571
9676 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1571
9677 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2370
9678 #: ../src/guestfs-actions.pod:2370
9680 "If the parameter C<nrlines> is a positive number, this returns the first "
9681 "C<nrlines> lines of the file C<path>."
9685 #: ../fish/guestfish-actions.pod:1574
9686 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1574
9687 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2373
9688 #: ../src/guestfs-actions.pod:2373
9690 "If the parameter C<nrlines> is a negative number, this returns lines from "
9691 "the file C<path>, excluding the last C<nrlines> lines."
9695 #: ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:4643
9696 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1577
9697 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4643
9698 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2376
9699 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6991
9700 #: ../src/guestfs-actions.pod:2376 ../src/guestfs-actions.pod:6991
9701 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9705 #: ../fish/guestfish-actions.pod:1582
9706 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1582
9711 #: ../fish/guestfish-actions.pod:1584
9712 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1584
9720 #: ../fish/guestfish-actions.pod:1586
9721 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1586
9722 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2393
9723 #: ../src/guestfs-actions.pod:2393
9725 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
9726 "readable, canonical hex dump of the file."
9730 #: ../fish/guestfish-actions.pod:1592
9731 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1592
9736 #: ../fish/guestfish-actions.pod:1594
9737 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1594
9740 " initrd-cat initrdpath filename\n"
9745 #: ../fish/guestfish-actions.pod:1596
9746 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1596
9747 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2412
9748 #: ../src/guestfs-actions.pod:2412
9750 "This command unpacks the file C<filename> from the initrd file called "
9751 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9756 #: ../fish/guestfish-actions.pod:1600
9757 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1600
9758 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2416
9759 #: ../src/guestfs-actions.pod:2416
9761 "For example, in guestfish you could use the following command to examine the "
9762 "boot script (usually called C</init>) contained in a Linux initrd or "
9767 #: ../fish/guestfish-actions.pod:1604
9768 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1604
9769 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2420
9770 #: ../src/guestfs-actions.pod:2420
9773 " initrd-cat /boot/initrd-<version>.img init\n"
9778 #: ../fish/guestfish-actions.pod:1606
9779 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1606
9780 msgid "See also L</initrd-list>."
9784 #: ../fish/guestfish-actions.pod:1611
9785 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1611
9790 #: ../fish/guestfish-actions.pod:1613
9791 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1613
9794 " initrd-list path\n"
9799 #: ../fish/guestfish-actions.pod:1615
9800 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1615
9801 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2439
9802 #: ../src/guestfs-actions.pod:2439
9803 msgid "This command lists out files contained in an initrd."
9807 #: ../fish/guestfish-actions.pod:1617
9808 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1617
9809 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2441
9810 #: ../src/guestfs-actions.pod:2441
9812 "The files are listed without any initial C</> character. The files are "
9813 "listed in the order they appear (not necessarily alphabetical). Directory "
9814 "names are listed as separate items."
9818 #: ../fish/guestfish-actions.pod:1621
9819 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1621
9820 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2445
9821 #: ../src/guestfs-actions.pod:2445
9823 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
9824 "initrd. We I<only> support the newer initramfs format (compressed cpio "
9829 #: ../fish/guestfish-actions.pod:1625
9830 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1625
9831 msgid "inotify-add-watch"
9835 #: ../fish/guestfish-actions.pod:1627
9836 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1627
9839 " inotify-add-watch path mask\n"
9844 #: ../fish/guestfish-actions.pod:1629
9845 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1629
9846 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2462
9847 #: ../src/guestfs-actions.pod:2462
9848 msgid "Watch C<path> for the events listed in C<mask>."
9852 #: ../fish/guestfish-actions.pod:1631
9853 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1631
9854 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2464
9855 #: ../src/guestfs-actions.pod:2464
9857 "Note that if C<path> is a directory then events within that directory are "
9858 "watched, but this does I<not> happen recursively (in subdirectories)."
9862 #: ../fish/guestfish-actions.pod:1635
9863 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1635
9864 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2468
9865 #: ../src/guestfs-actions.pod:2468
9867 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9868 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9872 #: ../fish/guestfish-actions.pod:1639
9873 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1639
9874 msgid "inotify-close"
9878 #: ../fish/guestfish-actions.pod:1641
9879 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1641
9887 #: ../fish/guestfish-actions.pod:1643
9888 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1643
9889 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2481
9890 #: ../src/guestfs-actions.pod:2481
9892 "This closes the inotify handle which was previously opened by inotify_init. "
9893 "It removes all watches, throws away any pending events, and deallocates all "
9898 #: ../fish/guestfish-actions.pod:1647
9899 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1647
9900 msgid "inotify-files"
9904 #: ../fish/guestfish-actions.pod:1649
9905 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1649
9913 #: ../fish/guestfish-actions.pod:1651
9914 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1651
9916 "This function is a helpful wrapper around L</inotify-read> which just "
9917 "returns a list of pathnames of objects that were touched. The returned "
9918 "pathnames are sorted and deduplicated."
9922 #: ../fish/guestfish-actions.pod:1655
9923 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1655
9924 msgid "inotify-init"
9928 #: ../fish/guestfish-actions.pod:1657
9929 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1657
9932 " inotify-init maxevents\n"
9937 #: ../fish/guestfish-actions.pod:1659
9938 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1659
9939 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2510
9940 #: ../src/guestfs-actions.pod:2510
9942 "This command creates a new inotify handle. The inotify subsystem can be "
9943 "used to notify events which happen to objects in the guest filesystem."
9947 #: ../fish/guestfish-actions.pod:1663
9948 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1663
9950 "C<maxevents> is the maximum number of events which will be queued up between "
9951 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
9952 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
9953 "default was 16384 events. Beyond this limit, the kernel throws away events, "
9954 "but records the fact that it threw them away by setting a flag "
9955 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
9959 #: ../fish/guestfish-actions.pod:1673
9960 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1673
9962 "Before any events are generated, you have to add some watches to the "
9963 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
9964 "L</inotify-watch-all>."
9968 #: ../fish/guestfish-actions.pod:1679
9969 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1679
9971 "Queued up events should be read periodically by calling L</inotify-read> (or "
9972 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
9973 "If you don't read the events out often enough then you risk the internal "
9974 "queue overflowing."
9978 #: ../fish/guestfish-actions.pod:1686
9979 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1686
9981 "The handle should be closed after use by calling L</inotify-close>. This "
9982 "also removes any watches automatically."
9986 #: ../fish/guestfish-actions.pod:1690
9987 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1690
9988 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2541
9989 #: ../src/guestfs-actions.pod:2541
9991 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
9992 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
9993 "that there is one global inotify handle per libguestfs instance."
9997 #: ../fish/guestfish-actions.pod:1695
9998 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1695
9999 msgid "inotify-read"
10003 #: ../fish/guestfish-actions.pod:1697
10004 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1697
10012 #: ../fish/guestfish-actions.pod:1699
10013 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1699
10014 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2555
10015 #: ../src/guestfs-actions.pod:2555
10017 "Return the complete queue of events that have happened since the previous "
10022 #: ../fish/guestfish-actions.pod:1702
10023 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1702
10024 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2558
10025 #: ../src/guestfs-actions.pod:2558
10026 msgid "If no events have happened, this returns an empty list."
10030 #: ../fish/guestfish-actions.pod:1704
10031 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1704
10032 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2560
10033 #: ../src/guestfs-actions.pod:2560
10035 "I<Note>: In order to make sure that all events have been read, you must call "
10036 "this function repeatedly until it returns an empty list. The reason is that "
10037 "the call will read events up to the maximum appliance-to-host message size "
10038 "and leave remaining events in the queue."
10042 #: ../fish/guestfish-actions.pod:1710
10043 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1710
10044 msgid "inotify-rm-watch"
10048 #: ../fish/guestfish-actions.pod:1712
10049 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1712
10052 " inotify-rm-watch wd\n"
10057 #: ../fish/guestfish-actions.pod:1714
10058 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1714
10059 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
10063 #: ../fish/guestfish-actions.pod:1717
10064 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1717
10065 msgid "inspect-get-arch"
10069 #: ../fish/guestfish-actions.pod:1719
10070 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1719
10073 " inspect-get-arch root\n"
10078 #: ../fish/guestfish-actions.pod:1721
10079 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1721
10081 "This returns the architecture of the inspected operating system. The "
10082 "possible return values are listed under L</file-architecture>."
10086 #: ../fish/guestfish-actions.pod:1725
10087 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1725
10088 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2595
10089 #: ../src/guestfs-actions.pod:2595
10091 "If the architecture could not be determined, then the string C<unknown> is "
10096 #: ../fish/guestfish-actions.pod:1728 ../fish/guestfish-actions.pod:1811
10097 #: ../fish/guestfish-actions.pod:1890 ../fish/guestfish-actions.pod:1902
10098 #: ../fish/guestfish-actions.pod:1986 ../fish/guestfish-actions.pod:2047
10099 #: ../fish/guestfish-actions.pod:2068 ../fish/guestfish-actions.pod:2082
10100 #: ../fish/guestfish-actions.pod:2122 ../fish/guestfish-actions.pod:2154
10101 #: ../fish/guestfish-actions.pod:2167 ../fish/guestfish-actions.pod:2180
10102 #: ../fish/guestfish-actions.pod:2190 ../fish/guestfish-actions.pod:2200
10103 #: ../fish/guestfish-actions.pod:2212 ../fish/guestfish-actions.pod:2308
10104 #: ../fish/guestfish-actions.pod:2342
10105 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1728
10106 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1811
10107 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1890
10108 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1902
10109 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1986
10110 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2047
10111 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2068
10112 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2082
10113 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2122
10114 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2154
10115 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2167
10116 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2180
10117 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2190
10118 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2200
10119 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2212
10120 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2308
10121 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2342
10122 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2598
10123 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2688
10124 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2792
10125 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2811
10126 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2942
10127 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3025
10128 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3053
10129 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3074
10130 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3127
10131 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3167
10132 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3187
10133 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3207
10134 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3224
10135 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3240
10136 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3258
10137 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3360
10138 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3401
10139 #: ../src/guestfs-actions.pod:2598 ../src/guestfs-actions.pod:2688
10140 #: ../src/guestfs-actions.pod:2792 ../src/guestfs-actions.pod:2811
10141 #: ../src/guestfs-actions.pod:2942 ../src/guestfs-actions.pod:3025
10142 #: ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3074
10143 #: ../src/guestfs-actions.pod:3127 ../src/guestfs-actions.pod:3167
10144 #: ../src/guestfs-actions.pod:3187 ../src/guestfs-actions.pod:3207
10145 #: ../src/guestfs-actions.pod:3224 ../src/guestfs-actions.pod:3240
10146 #: ../src/guestfs-actions.pod:3258 ../src/guestfs-actions.pod:3360
10147 #: ../src/guestfs-actions.pod:3401
10148 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10152 #: ../fish/guestfish-actions.pod:1730
10153 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1730
10154 msgid "inspect-get-distro"
10158 #: ../fish/guestfish-actions.pod:1732
10159 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1732
10162 " inspect-get-distro root\n"
10167 #: ../fish/guestfish-actions.pod:1734
10168 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1734
10169 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2611
10170 #: ../src/guestfs-actions.pod:2611
10172 "This returns the distro (distribution) of the inspected operating system."
10176 #: ../fish/guestfish-actions.pod:1737
10177 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1737
10178 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2614
10179 #: ../src/guestfs-actions.pod:2614
10180 msgid "Currently defined distros are:"
10184 #: ../fish/guestfish-actions.pod:1741
10185 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1741
10186 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2618
10187 #: ../src/guestfs-actions.pod:2618
10188 msgid "\"archlinux\""
10192 #: ../fish/guestfish-actions.pod:1743
10193 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1743
10194 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2620
10195 #: ../src/guestfs-actions.pod:2620
10196 msgid "Arch Linux."
10200 #: ../fish/guestfish-actions.pod:1745
10201 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1745
10202 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2622
10203 #: ../src/guestfs-actions.pod:2622
10208 #: ../fish/guestfish-actions.pod:1747
10209 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1747
10210 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2624
10211 #: ../src/guestfs-actions.pod:2624
10216 #: ../fish/guestfish-actions.pod:1749
10217 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1749
10218 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2626
10219 #: ../src/guestfs-actions.pod:2626
10224 #: ../fish/guestfish-actions.pod:1751
10225 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1751
10226 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2628
10227 #: ../src/guestfs-actions.pod:2628
10232 #: ../fish/guestfish-actions.pod:1753
10233 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1753
10234 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2630
10235 #: ../src/guestfs-actions.pod:2630
10240 #: ../fish/guestfish-actions.pod:1755
10241 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1755
10242 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2632
10243 #: ../src/guestfs-actions.pod:2632
10248 #: ../fish/guestfish-actions.pod:1757
10249 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1757
10250 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2634
10251 #: ../src/guestfs-actions.pod:2634
10256 #: ../fish/guestfish-actions.pod:1759
10257 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1759
10258 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2636
10259 #: ../src/guestfs-actions.pod:2636
10264 #: ../fish/guestfish-actions.pod:1761
10265 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1761
10266 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2638
10267 #: ../src/guestfs-actions.pod:2638
10268 msgid "\"linuxmint\""
10272 #: ../fish/guestfish-actions.pod:1763
10273 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1763
10274 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2640
10275 #: ../src/guestfs-actions.pod:2640
10276 msgid "Linux Mint."
10280 #: ../fish/guestfish-actions.pod:1765
10281 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1765
10282 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2642
10283 #: ../src/guestfs-actions.pod:2642
10284 msgid "\"mandriva\""
10288 #: ../fish/guestfish-actions.pod:1767
10289 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1767
10290 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2644
10291 #: ../src/guestfs-actions.pod:2644
10296 #: ../fish/guestfish-actions.pod:1769
10297 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1769
10298 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2646
10299 #: ../src/guestfs-actions.pod:2646
10304 #: ../fish/guestfish-actions.pod:1771
10305 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1771
10306 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2648
10307 #: ../src/guestfs-actions.pod:2648
10312 #: ../fish/guestfish-actions.pod:1773
10313 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1773
10314 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2650
10315 #: ../src/guestfs-actions.pod:2650
10320 #: ../fish/guestfish-actions.pod:1775
10321 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1775
10322 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2652
10323 #: ../src/guestfs-actions.pod:2652
10328 #: ../fish/guestfish-actions.pod:1777
10329 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1777
10330 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2654
10331 #: ../src/guestfs-actions.pod:2654
10332 msgid "\"redhat-based\""
10336 #: ../fish/guestfish-actions.pod:1779
10337 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1779
10338 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2656
10339 #: ../src/guestfs-actions.pod:2656
10340 msgid "Some Red Hat-derived distro."
10344 #: ../fish/guestfish-actions.pod:1781
10345 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1781
10346 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2658
10347 #: ../src/guestfs-actions.pod:2658
10352 #: ../fish/guestfish-actions.pod:1783
10353 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1783
10354 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2660
10355 #: ../src/guestfs-actions.pod:2660
10356 msgid "Red Hat Enterprise Linux."
10360 #: ../fish/guestfish-actions.pod:1785
10361 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1785
10362 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2662
10363 #: ../src/guestfs-actions.pod:2662
10364 msgid "\"scientificlinux\""
10368 #: ../fish/guestfish-actions.pod:1787
10369 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1787
10370 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2664
10371 #: ../src/guestfs-actions.pod:2664
10372 msgid "Scientific Linux."
10376 #: ../fish/guestfish-actions.pod:1789
10377 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1789
10378 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2666
10379 #: ../src/guestfs-actions.pod:2666
10380 msgid "\"slackware\""
10384 #: ../fish/guestfish-actions.pod:1791
10385 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1791
10386 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2668
10387 #: ../src/guestfs-actions.pod:2668
10392 #: ../fish/guestfish-actions.pod:1793
10393 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1793
10394 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2670
10395 #: ../src/guestfs-actions.pod:2670
10400 #: ../fish/guestfish-actions.pod:1795
10401 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1795
10402 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2672
10403 #: ../src/guestfs-actions.pod:2672
10408 #: ../fish/guestfish-actions.pod:1797 ../fish/guestfish-actions.pod:1881
10409 #: ../fish/guestfish-actions.pod:2145
10410 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1797
10411 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1881
10412 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2145
10413 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2674
10414 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2783
10415 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3158
10416 #: ../src/guestfs-actions.pod:2674 ../src/guestfs-actions.pod:2783
10417 #: ../src/guestfs-actions.pod:3158
10418 msgid "\"unknown\""
10422 #: ../fish/guestfish-actions.pod:1799
10423 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1799
10424 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2676
10425 #: ../src/guestfs-actions.pod:2676
10426 msgid "The distro could not be determined."
10430 #: ../fish/guestfish-actions.pod:1801 ../fish/guestfish-actions.pod:2137
10431 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1801
10432 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2137
10433 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2678
10434 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3150
10435 #: ../src/guestfs-actions.pod:2678 ../src/guestfs-actions.pod:3150
10436 msgid "\"windows\""
10440 #: ../fish/guestfish-actions.pod:1803
10441 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1803
10442 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2680
10443 #: ../src/guestfs-actions.pod:2680
10445 "Windows does not have distributions. This string is returned if the OS type "
10450 #: ../fish/guestfish-actions.pod:1808 ../fish/guestfish-actions.pod:1887
10451 #: ../fish/guestfish-actions.pod:2151
10452 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1808
10453 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1887
10454 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2151
10455 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2685
10456 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2789
10457 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3164
10458 #: ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:2789
10459 #: ../src/guestfs-actions.pod:3164
10461 "Future versions of libguestfs may return other strings here. The caller "
10462 "should be prepared to handle any string."
10466 #: ../fish/guestfish-actions.pod:1813
10467 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1813
10468 msgid "inspect-get-drive-mappings"
10472 #: ../fish/guestfish-actions.pod:1815
10473 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1815
10476 " inspect-get-drive-mappings root\n"
10481 #: ../fish/guestfish-actions.pod:1817
10482 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1817
10483 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2701
10484 #: ../src/guestfs-actions.pod:2701
10486 "This call is useful for Windows which uses a primitive system of assigning "
10487 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10488 "Windows Registry to find out how disks/partitions are mapped to drive "
10489 "letters, and returns a hash table as in the example below:"
10493 #: ../fish/guestfish-actions.pod:1823
10494 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1823
10495 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2707
10496 #: ../src/guestfs-actions.pod:2707
10499 " C => /dev/vda2\n"
10500 " E => /dev/vdb1\n"
10501 " F => /dev/vdc1\n"
10506 #: ../fish/guestfish-actions.pod:1827
10507 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1827
10508 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2711
10509 #: ../src/guestfs-actions.pod:2711
10511 "Note that keys are drive letters. For Windows, the key is case insensitive "
10512 "and just contains the drive letter, without the customary colon separator "
10517 #: ../fish/guestfish-actions.pod:1831
10518 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1831
10519 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2715
10520 #: ../src/guestfs-actions.pod:2715
10522 "In future we may support other operating systems that also used drive "
10523 "letters, but the keys for those might not be case insensitive and might be "
10524 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10529 #: ../fish/guestfish-actions.pod:1836
10530 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1836
10531 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2720
10532 #: ../src/guestfs-actions.pod:2720
10534 "For Windows guests, currently only hard drive mappings are returned. "
10535 "Removable disks (eg. DVD-ROMs) are ignored."
10539 #: ../fish/guestfish-actions.pod:1839
10540 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1839
10541 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2723
10542 #: ../src/guestfs-actions.pod:2723
10544 "For guests that do not use drive mappings, or if the drive mappings could "
10545 "not be determined, this returns an empty hash table."
10549 #: ../fish/guestfish-actions.pod:1842
10550 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1842
10552 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
10553 "get-mountpoints>, L</inspect-get-filesystems>."
10557 #: ../fish/guestfish-actions.pod:1846
10558 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1846
10559 msgid "inspect-get-filesystems"
10563 #: ../fish/guestfish-actions.pod:1848
10564 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1848
10567 " inspect-get-filesystems root\n"
10572 #: ../fish/guestfish-actions.pod:1850
10573 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1850
10574 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2744
10575 #: ../src/guestfs-actions.pod:2744
10577 "This returns a list of all the filesystems that we think are associated with "
10578 "this operating system. This includes the root filesystem, other ordinary "
10579 "filesystems, and non-mounted devices like swap partitions."
10583 #: ../fish/guestfish-actions.pod:1855
10584 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1855
10585 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2749
10586 #: ../src/guestfs-actions.pod:2749
10588 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10589 "to be shared between operating systems."
10593 #: ../fish/guestfish-actions.pod:1858
10594 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1858
10596 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
10597 "get-mountpoints>."
10601 #: ../fish/guestfish-actions.pod:1861
10602 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1861
10603 msgid "inspect-get-format"
10607 #: ../fish/guestfish-actions.pod:1863
10608 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1863
10611 " inspect-get-format root\n"
10616 #: ../fish/guestfish-actions.pod:1865
10617 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1865
10618 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2767
10619 #: ../src/guestfs-actions.pod:2767
10621 "This returns the format of the inspected operating system. You can use it "
10622 "to detect install images, live CDs and similar."
10626 #: ../fish/guestfish-actions.pod:1868
10627 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1868
10628 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2770
10629 #: ../src/guestfs-actions.pod:2770
10630 msgid "Currently defined formats are:"
10634 #: ../fish/guestfish-actions.pod:1872
10635 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1872
10636 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2774
10637 #: ../src/guestfs-actions.pod:2774
10638 msgid "\"installed\""
10642 #: ../fish/guestfish-actions.pod:1874
10643 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1874
10644 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2776
10645 #: ../src/guestfs-actions.pod:2776
10646 msgid "This is an installed operating system."
10650 #: ../fish/guestfish-actions.pod:1876
10651 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1876
10652 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2778
10653 #: ../src/guestfs-actions.pod:2778
10654 msgid "\"installer\""
10658 #: ../fish/guestfish-actions.pod:1878
10659 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1878
10660 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2780
10661 #: ../src/guestfs-actions.pod:2780
10663 "The disk image being inspected is not an installed operating system, but a "
10664 "I<bootable> install disk, live CD, or similar."
10668 #: ../fish/guestfish-actions.pod:1883
10669 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1883
10670 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2785
10671 #: ../src/guestfs-actions.pod:2785
10672 msgid "The format of this disk image is not known."
10676 #: ../fish/guestfish-actions.pod:1892
10677 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1892
10678 msgid "inspect-get-hostname"
10682 #: ../fish/guestfish-actions.pod:1894
10683 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1894
10686 " inspect-get-hostname root\n"
10691 #: ../fish/guestfish-actions.pod:1896
10692 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1896
10693 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2805
10694 #: ../src/guestfs-actions.pod:2805
10696 "This function returns the hostname of the operating system as found by "
10697 "inspection of the guest's configuration files."
10701 #: ../fish/guestfish-actions.pod:1899
10702 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1899
10703 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2808
10704 #: ../src/guestfs-actions.pod:2808
10706 "If the hostname could not be determined, then the string C<unknown> is "
10711 #: ../fish/guestfish-actions.pod:1904
10712 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1904
10713 msgid "inspect-get-icon"
10717 #: ../fish/guestfish-actions.pod:1906
10718 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1906
10721 " inspect-get-icon root [favicon:..] [highquality:..]\n"
10726 #: ../fish/guestfish-actions.pod:1908
10727 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1908
10728 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2834
10729 #: ../src/guestfs-actions.pod:2834
10731 "This function returns an icon corresponding to the inspected operating "
10732 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
10733 "to PNG if necessary)."
10737 #: ../fish/guestfish-actions.pod:1912
10738 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1912
10739 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2838
10740 #: ../src/guestfs-actions.pod:2838
10742 "If it was not possible to get an icon this function returns a zero-length "
10743 "(non-NULL) buffer. I<Callers must check for this case>."
10747 #: ../fish/guestfish-actions.pod:1915
10748 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1915
10749 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2841
10750 #: ../src/guestfs-actions.pod:2841
10752 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
10753 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
10754 "this file will be returned. You can disable favicons by passing the "
10755 "optional C<favicon> boolean as false (default is true)."
10759 #: ../fish/guestfish-actions.pod:1921
10760 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1921
10761 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2847
10762 #: ../src/guestfs-actions.pod:2847
10764 "If finding the favicon fails, then we look in other places in the guest for "
10769 #: ../fish/guestfish-actions.pod:1924
10770 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1924
10771 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2850
10772 #: ../src/guestfs-actions.pod:2850
10774 "If the optional C<highquality> boolean is true then only high quality icons "
10775 "are returned, which means only icons of high resolution with an alpha "
10776 "channel. The default (false) is to return any icon we can, even if it is of "
10777 "substandard quality."
10781 #: ../fish/guestfish-actions.pod:1935
10782 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1935
10783 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2861
10784 #: ../src/guestfs-actions.pod:2861
10786 "Unlike most other inspection API calls, the guest's disks must be mounted up "
10787 "before you call this, since it needs to read information from the guest "
10788 "filesystem during the call."
10792 #: ../fish/guestfish-actions.pod:1941
10793 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1941
10794 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2867
10795 #: ../src/guestfs-actions.pod:2867
10797 "B<Security:> The icon data comes from the untrusted guest, and should be "
10798 "treated with caution. PNG files have been known to contain exploits. "
10799 "Ensure that libpng (or other relevant libraries) are fully up to date before "
10800 "trying to process or display the icon."
10804 #: ../fish/guestfish-actions.pod:1949
10805 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1949
10806 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2875
10807 #: ../src/guestfs-actions.pod:2875
10809 "The PNG image returned can be any size. It might not be square. Libguestfs "
10810 "tries to return the largest, highest quality icon available. The "
10811 "application must scale the icon to the required size."
10815 #: ../fish/guestfish-actions.pod:1956
10816 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1956
10817 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2882
10818 #: ../src/guestfs-actions.pod:2882
10820 "Extracting icons from Windows guests requires the external C<wrestool> "
10821 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
10822 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
10823 "installed separately."
10827 #: ../fish/guestfish-actions.pod:1963
10828 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1963
10829 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2889
10830 #: ../src/guestfs-actions.pod:2889
10832 "Operating system icons are usually trademarks. Seek legal advice before "
10833 "using trademarks in applications."
10837 #: ../fish/guestfish-actions.pod:1970
10838 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1970
10839 msgid "inspect-get-major-version"
10843 #: ../fish/guestfish-actions.pod:1972
10844 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1972
10847 " inspect-get-major-version root\n"
10852 #: ../fish/guestfish-actions.pod:1974
10853 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1974
10854 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2930
10855 #: ../src/guestfs-actions.pod:2930
10857 "This returns the major version number of the inspected operating system."
10861 #: ../fish/guestfish-actions.pod:1977
10862 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1977
10863 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2933
10864 #: ../src/guestfs-actions.pod:2933
10866 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10867 "popular public names used by the operating system. Notably the operating "
10868 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10869 "1). You can find out the real versions corresponding to releases of Windows "
10870 "by consulting Wikipedia or MSDN."
10874 #: ../fish/guestfish-actions.pod:1984 ../fish/guestfish-actions.pod:1995
10875 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1984
10876 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1995
10877 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2940
10878 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2957
10879 #: ../src/guestfs-actions.pod:2940 ../src/guestfs-actions.pod:2957
10880 msgid "If the version could not be determined, then C<0> is returned."
10884 #: ../fish/guestfish-actions.pod:1988
10885 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1988
10886 msgid "inspect-get-minor-version"
10890 #: ../fish/guestfish-actions.pod:1990
10891 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1990
10894 " inspect-get-minor-version root\n"
10899 #: ../fish/guestfish-actions.pod:1992
10900 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1992
10901 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2954
10902 #: ../src/guestfs-actions.pod:2954
10904 "This returns the minor version number of the inspected operating system."
10908 #: ../fish/guestfish-actions.pod:1997
10909 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:1997
10911 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
10912 "get-major-version>."
10916 #: ../fish/guestfish-actions.pod:2000
10917 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2000
10918 msgid "inspect-get-mountpoints"
10922 #: ../fish/guestfish-actions.pod:2002
10923 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2002
10926 " inspect-get-mountpoints root\n"
10931 #: ../fish/guestfish-actions.pod:2004
10932 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2004
10933 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2972
10934 #: ../src/guestfs-actions.pod:2972
10936 "This returns a hash of where we think the filesystems associated with this "
10937 "operating system should be mounted. Callers should note that this is at "
10938 "best an educated guess made by reading configuration files such as C</etc/"
10939 "fstab>. I<In particular note> that this may return filesystems which are "
10940 "non-existent or not mountable and callers should be prepared to handle or "
10941 "ignore failures if they try to mount them."
10945 #: ../fish/guestfish-actions.pod:2013
10946 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2013
10947 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2981
10948 #: ../src/guestfs-actions.pod:2981
10950 "Each element in the returned hashtable has a key which is the path of the "
10951 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10952 "mounted there (eg. C</dev/sda1>)."
10956 #: ../fish/guestfish-actions.pod:2018
10957 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2018
10958 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2986
10959 #: ../src/guestfs-actions.pod:2986
10961 "Non-mounted devices such as swap devices are I<not> returned in this list."
10965 #: ../fish/guestfish-actions.pod:2021
10966 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2021
10968 "For operating systems like Windows which still use drive letters, this call "
10969 "will only return an entry for the first drive \"mounted on\" C</>. For "
10970 "information about the mapping of drive letters to partitions, see L</inspect-"
10971 "get-drive-mappings>."
10975 #: ../fish/guestfish-actions.pod:2027
10976 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2027
10978 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
10979 "get-filesystems>."
10983 #: ../fish/guestfish-actions.pod:2030
10984 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2030
10985 msgid "inspect-get-package-format"
10989 #: ../fish/guestfish-actions.pod:2032
10990 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2032
10993 " inspect-get-package-format root\n"
10998 #: ../fish/guestfish-actions.pod:2034
10999 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2034
11001 "This function and L</inspect-get-package-management> return the package "
11002 "format and package management tool used by the inspected operating system. "
11003 "For example for Fedora these functions would return C<rpm> (package format) "
11004 "and C<yum> (package management)."
11008 #: ../fish/guestfish-actions.pod:2040
11009 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2040
11010 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3018
11011 #: ../src/guestfs-actions.pod:3018
11013 "This returns the string C<unknown> if we could not determine the package "
11014 "format I<or> if the operating system does not have a real packaging system "
11019 #: ../fish/guestfish-actions.pod:2044
11020 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2044
11021 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3022
11022 #: ../src/guestfs-actions.pod:3022
11024 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11025 "Future versions of libguestfs may return other strings."
11029 #: ../fish/guestfish-actions.pod:2049
11030 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2049
11031 msgid "inspect-get-package-management"
11035 #: ../fish/guestfish-actions.pod:2051
11036 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2051
11039 " inspect-get-package-management root\n"
11044 #: ../fish/guestfish-actions.pod:2053
11045 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2053
11047 "L</inspect-get-package-format> and this function return the package format "
11048 "and package management tool used by the inspected operating system. For "
11049 "example for Fedora these functions would return C<rpm> (package format) and "
11050 "C<yum> (package management)."
11054 #: ../fish/guestfish-actions.pod:2059
11055 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2059
11056 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3044
11057 #: ../src/guestfs-actions.pod:3044
11059 "This returns the string C<unknown> if we could not determine the package "
11060 "management tool I<or> if the operating system does not have a real packaging "
11061 "system (eg. Windows)."
11065 #: ../fish/guestfish-actions.pod:2063
11066 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2063
11067 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3048
11068 #: ../src/guestfs-actions.pod:3048
11070 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11071 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11072 "libguestfs may return other strings."
11076 #: ../fish/guestfish-actions.pod:2070
11077 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2070
11078 msgid "inspect-get-product-name"
11082 #: ../fish/guestfish-actions.pod:2072
11083 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2072
11086 " inspect-get-product-name root\n"
11091 #: ../fish/guestfish-actions.pod:2074
11092 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2074
11093 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3066
11094 #: ../src/guestfs-actions.pod:3066
11096 "This returns the product name of the inspected operating system. The "
11097 "product name is generally some freeform string which can be displayed to the "
11098 "user, but should not be parsed by programs."
11102 #: ../fish/guestfish-actions.pod:2079
11103 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2079
11104 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3071
11105 #: ../src/guestfs-actions.pod:3071
11107 "If the product name could not be determined, then the string C<unknown> is "
11112 #: ../fish/guestfish-actions.pod:2084
11113 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2084
11114 msgid "inspect-get-product-variant"
11118 #: ../fish/guestfish-actions.pod:2086
11119 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2086
11122 " inspect-get-product-variant root\n"
11127 #: ../fish/guestfish-actions.pod:2088
11128 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2088
11129 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3087
11130 #: ../src/guestfs-actions.pod:3087
11131 msgid "This returns the product variant of the inspected operating system."
11135 #: ../fish/guestfish-actions.pod:2091
11136 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2091
11137 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3090
11138 #: ../src/guestfs-actions.pod:3090
11140 "For Windows guests, this returns the contents of the Registry key C<HKLM"
11141 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
11142 "is usually a string such as C<Client> or C<Server> (other values are "
11143 "possible). This can be used to distinguish consumer and enterprise versions "
11144 "of Windows that have the same version number (for example, Windows 7 and "
11145 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11146 "the latter is C<Server>)."
11150 #: ../fish/guestfish-actions.pod:2100
11151 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2100
11152 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3099
11153 #: ../src/guestfs-actions.pod:3099
11155 "For enterprise Linux guests, in future we intend this to return the product "
11156 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11157 "implemented at present."
11161 #: ../fish/guestfish-actions.pod:2104
11162 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2104
11163 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3103
11164 #: ../src/guestfs-actions.pod:3103
11166 "If the product variant could not be determined, then the string C<unknown> "
11171 #: ../fish/guestfish-actions.pod:2107
11172 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2107
11174 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
11175 "get-product-name>, L</inspect-get-major-version>."
11179 #: ../fish/guestfish-actions.pod:2111
11180 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2111
11181 msgid "inspect-get-roots"
11185 #: ../fish/guestfish-actions.pod:2113
11186 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2113
11189 " inspect-get-roots\n"
11194 #: ../fish/guestfish-actions.pod:2115
11195 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2115
11197 "This function is a convenient way to get the list of root devices, as "
11198 "returned from a previous call to L</inspect-os>, but without redoing the "
11199 "whole inspection process."
11203 #: ../fish/guestfish-actions.pod:2119
11204 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2119
11206 "This returns an empty list if either no root devices were found or the "
11207 "caller has not called L</inspect-os>."
11211 #: ../fish/guestfish-actions.pod:2124
11212 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2124
11213 msgid "inspect-get-type"
11217 #: ../fish/guestfish-actions.pod:2126
11218 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2126
11221 " inspect-get-type root\n"
11226 #: ../fish/guestfish-actions.pod:2128
11227 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2128
11228 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3141
11229 #: ../src/guestfs-actions.pod:3141
11231 "This returns the type of the inspected operating system. Currently defined "
11236 #: ../fish/guestfish-actions.pod:2133
11237 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2133
11238 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3146
11239 #: ../src/guestfs-actions.pod:3146
11244 #: ../fish/guestfish-actions.pod:2135
11245 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2135
11246 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3148
11247 #: ../src/guestfs-actions.pod:3148
11248 msgid "Any Linux-based operating system."
11252 #: ../fish/guestfish-actions.pod:2139
11253 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2139
11254 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3152
11255 #: ../src/guestfs-actions.pod:3152
11256 msgid "Any Microsoft Windows operating system."
11260 #: ../fish/guestfish-actions.pod:2141
11261 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2141
11262 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3154
11263 #: ../src/guestfs-actions.pod:3154
11264 msgid "\"freebsd\""
11268 #: ../fish/guestfish-actions.pod:2143
11269 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2143
11270 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3156
11271 #: ../src/guestfs-actions.pod:3156
11276 #: ../fish/guestfish-actions.pod:2147
11277 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2147
11278 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3160
11279 #: ../src/guestfs-actions.pod:3160
11280 msgid "The operating system type could not be determined."
11284 #: ../fish/guestfish-actions.pod:2156
11285 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2156
11286 msgid "inspect-get-windows-current-control-set"
11290 #: ../fish/guestfish-actions.pod:2158
11291 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2158
11294 " inspect-get-windows-current-control-set root\n"
11299 #: ../fish/guestfish-actions.pod:2160
11300 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2160
11301 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3180
11302 #: ../src/guestfs-actions.pod:3180
11304 "This returns the Windows CurrentControlSet of the inspected guest. The "
11305 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11309 #: ../fish/guestfish-actions.pod:2163
11310 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2163
11311 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3183
11312 #: ../src/guestfs-actions.pod:3183
11314 "This call assumes that the guest is Windows and that the Registry could be "
11315 "examined by inspection. If this is not the case then an error is returned."
11319 #: ../fish/guestfish-actions.pod:2169
11320 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2169
11321 msgid "inspect-get-windows-systemroot"
11325 #: ../fish/guestfish-actions.pod:2171
11326 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2171
11329 " inspect-get-windows-systemroot root\n"
11334 #: ../fish/guestfish-actions.pod:2173
11335 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2173
11336 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3200
11337 #: ../src/guestfs-actions.pod:3200
11339 "This returns the Windows systemroot of the inspected guest. The systemroot "
11340 "is a directory path such as C</WINDOWS>."
11344 #: ../fish/guestfish-actions.pod:2176
11345 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2176
11346 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3203
11347 #: ../src/guestfs-actions.pod:3203
11349 "This call assumes that the guest is Windows and that the systemroot could be "
11350 "determined by inspection. If this is not the case then an error is returned."
11354 #: ../fish/guestfish-actions.pod:2182
11355 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2182
11356 msgid "inspect-is-live"
11360 #: ../fish/guestfish-actions.pod:2184
11361 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2184
11364 " inspect-is-live root\n"
11369 #: ../fish/guestfish-actions.pod:2186
11370 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2186
11372 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
11373 "then this returns true if a live image was detected on the disk."
11377 #: ../fish/guestfish-actions.pod:2192
11378 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2192
11379 msgid "inspect-is-multipart"
11383 #: ../fish/guestfish-actions.pod:2194
11384 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2194
11387 " inspect-is-multipart root\n"
11392 #: ../fish/guestfish-actions.pod:2196
11393 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2196
11395 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
11396 "then this returns true if the disk is part of a set."
11400 #: ../fish/guestfish-actions.pod:2202
11401 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2202
11402 msgid "inspect-is-netinst"
11406 #: ../fish/guestfish-actions.pod:2204
11407 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2204
11410 " inspect-is-netinst root\n"
11415 #: ../fish/guestfish-actions.pod:2206
11416 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2206
11418 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
11419 "then this returns true if the disk is a network installer, ie. not a self-"
11420 "contained install CD but one which is likely to require network access to "
11421 "complete the install."
11425 #: ../fish/guestfish-actions.pod:2214
11426 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2214
11427 msgid "inspect-list-applications"
11431 #: ../fish/guestfish-actions.pod:2216
11432 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2216
11435 " inspect-list-applications root\n"
11440 #: ../fish/guestfish-actions.pod:2218
11441 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2218
11442 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3270
11443 #: ../src/guestfs-actions.pod:3270
11444 msgid "Return the list of applications installed in the operating system."
11448 #: ../fish/guestfish-actions.pod:2220
11449 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2220
11451 "I<Note:> This call works differently from other parts of the inspection "
11452 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
11453 "then mount up the disks, before calling this. Listing applications is a "
11454 "significantly more difficult operation which requires access to the full "
11455 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
11456 "are just returning data cached in the libguestfs handle, this call actually "
11457 "reads parts of the mounted filesystems during the call."
11461 #: ../fish/guestfish-actions.pod:2230
11462 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2230
11463 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3282
11464 #: ../src/guestfs-actions.pod:3282
11466 "This returns an empty list if the inspection code was not able to determine "
11467 "the list of applications."
11471 #: ../fish/guestfish-actions.pod:2233
11472 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2233
11473 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3285
11474 #: ../src/guestfs-actions.pod:3285
11475 msgid "The application structure contains the following fields:"
11479 #: ../fish/guestfish-actions.pod:2237
11480 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2237
11481 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3289
11482 #: ../src/guestfs-actions.pod:3289
11483 msgid "C<app_name>"
11487 #: ../fish/guestfish-actions.pod:2239
11488 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2239
11489 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3291
11490 #: ../src/guestfs-actions.pod:3291
11492 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11493 "guests, this is the package name."
11497 #: ../fish/guestfish-actions.pod:2242
11498 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2242
11499 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3294
11500 #: ../src/guestfs-actions.pod:3294
11501 msgid "C<app_display_name>"
11505 #: ../fish/guestfish-actions.pod:2244
11506 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2244
11507 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3296
11508 #: ../src/guestfs-actions.pod:3296
11510 "The display name of the application, sometimes localized to the install "
11511 "language of the guest operating system."
11515 #: ../fish/guestfish-actions.pod:2247
11516 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2247
11517 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3299
11518 #: ../src/guestfs-actions.pod:3299
11520 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11521 "to display something can use C<app_name> instead."
11525 #: ../fish/guestfish-actions.pod:2250
11526 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2250
11527 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3302
11528 #: ../src/guestfs-actions.pod:3302
11529 msgid "C<app_epoch>"
11533 #: ../fish/guestfish-actions.pod:2252
11534 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2252
11535 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3304
11536 #: ../src/guestfs-actions.pod:3304
11538 "For package managers which use epochs, this contains the epoch of the "
11539 "package (an integer). If unavailable, this is returned as C<0>."
11543 #: ../fish/guestfish-actions.pod:2255
11544 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2255
11545 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3307
11546 #: ../src/guestfs-actions.pod:3307
11547 msgid "C<app_version>"
11551 #: ../fish/guestfish-actions.pod:2257
11552 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2257
11553 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3309
11554 #: ../src/guestfs-actions.pod:3309
11556 "The version string of the application or package. If unavailable this is "
11557 "returned as an empty string C<\"\">."
11561 #: ../fish/guestfish-actions.pod:2260
11562 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2260
11563 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3312
11564 #: ../src/guestfs-actions.pod:3312
11565 msgid "C<app_release>"
11569 #: ../fish/guestfish-actions.pod:2262
11570 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2262
11571 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3314
11572 #: ../src/guestfs-actions.pod:3314
11574 "The release string of the application or package, for package managers that "
11575 "use this. If unavailable this is returned as an empty string C<\"\">."
11579 #: ../fish/guestfish-actions.pod:2266
11580 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2266
11581 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3318
11582 #: ../src/guestfs-actions.pod:3318
11583 msgid "C<app_install_path>"
11587 #: ../fish/guestfish-actions.pod:2268
11588 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2268
11589 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3320
11590 #: ../src/guestfs-actions.pod:3320
11592 "The installation path of the application (on operating systems such as "
11593 "Windows which use installation paths). This path is in the format used by "
11594 "the guest operating system, it is not a libguestfs path."
11598 #: ../fish/guestfish-actions.pod:2273
11599 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2273
11600 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3325
11601 #: ../src/guestfs-actions.pod:3325
11602 msgid "If unavailable this is returned as an empty string C<\"\">."
11606 #: ../fish/guestfish-actions.pod:2275
11607 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2275
11608 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3327
11609 #: ../src/guestfs-actions.pod:3327
11610 msgid "C<app_trans_path>"
11614 #: ../fish/guestfish-actions.pod:2277
11615 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2277
11616 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3329
11617 #: ../src/guestfs-actions.pod:3329
11619 "The install path translated into a libguestfs path. If unavailable this is "
11620 "returned as an empty string C<\"\">."
11624 #: ../fish/guestfish-actions.pod:2280
11625 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2280
11626 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3332
11627 #: ../src/guestfs-actions.pod:3332
11628 msgid "C<app_publisher>"
11632 #: ../fish/guestfish-actions.pod:2282
11633 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2282
11634 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3334
11635 #: ../src/guestfs-actions.pod:3334
11637 "The name of the publisher of the application, for package managers that use "
11638 "this. If unavailable this is returned as an empty string C<\"\">."
11642 #: ../fish/guestfish-actions.pod:2286
11643 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2286
11644 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3338
11645 #: ../src/guestfs-actions.pod:3338
11650 #: ../fish/guestfish-actions.pod:2288
11651 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2288
11652 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3340
11653 #: ../src/guestfs-actions.pod:3340
11655 "The URL (eg. upstream URL) of the application. If unavailable this is "
11656 "returned as an empty string C<\"\">."
11660 #: ../fish/guestfish-actions.pod:2291
11661 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2291
11662 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3343
11663 #: ../src/guestfs-actions.pod:3343
11664 msgid "C<app_source_package>"
11668 #: ../fish/guestfish-actions.pod:2293
11669 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2293
11670 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3345
11671 #: ../src/guestfs-actions.pod:3345
11673 "For packaging systems which support this, the name of the source package. "
11674 "If unavailable this is returned as an empty string C<\"\">."
11678 #: ../fish/guestfish-actions.pod:2296
11679 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2296
11680 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3348
11681 #: ../src/guestfs-actions.pod:3348
11682 msgid "C<app_summary>"
11686 #: ../fish/guestfish-actions.pod:2298
11687 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2298
11688 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3350
11689 #: ../src/guestfs-actions.pod:3350
11691 "A short (usually one line) description of the application or package. If "
11692 "unavailable this is returned as an empty string C<\"\">."
11696 #: ../fish/guestfish-actions.pod:2301
11697 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2301
11698 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3353
11699 #: ../src/guestfs-actions.pod:3353
11700 msgid "C<app_description>"
11704 #: ../fish/guestfish-actions.pod:2303
11705 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2303
11706 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3355
11707 #: ../src/guestfs-actions.pod:3355
11709 "A longer description of the application or package. If unavailable this is "
11710 "returned as an empty string C<\"\">."
11714 #: ../fish/guestfish-actions.pod:2310
11715 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2310
11720 #: ../fish/guestfish-actions.pod:2312
11721 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2312
11729 #: ../fish/guestfish-actions.pod:2314
11730 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2314
11731 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3373
11732 #: ../src/guestfs-actions.pod:3373
11734 "This function uses other libguestfs functions and certain heuristics to "
11735 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11736 "for operating systems."
11740 #: ../fish/guestfish-actions.pod:2318
11741 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2318
11742 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3377
11743 #: ../src/guestfs-actions.pod:3377
11744 msgid "The list returned is empty if no operating systems were found."
11748 #: ../fish/guestfish-actions.pod:2320
11749 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2320
11750 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3379
11751 #: ../src/guestfs-actions.pod:3379
11753 "If one operating system was found, then this returns a list with a single "
11754 "element, which is the name of the root filesystem of this operating system. "
11755 "It is also possible for this function to return a list containing more than "
11756 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11757 "element being the root filesystem of one of the operating systems."
11761 #: ../fish/guestfish-actions.pod:2327
11762 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2327
11764 "You can pass the root string(s) returned to other L</inspect-get-*> "
11765 "functions in order to query further information about each operating system, "
11766 "such as the name and version."
11770 #: ../fish/guestfish-actions.pod:2332
11771 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2332
11773 "This function uses other libguestfs features such as L</mount-ro> and L</"
11774 "umount-all> in order to mount and unmount filesystems and look at the "
11775 "contents. This should be called with no disks currently mounted. The "
11776 "function may also use Augeas, so any existing Augeas handle will be closed."
11780 #: ../fish/guestfish-actions.pod:2338
11781 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2338
11782 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3397
11783 #: ../src/guestfs-actions.pod:3397
11785 "This function cannot decrypt encrypted disks. The caller must do that first "
11786 "(supplying the necessary keys) if the disk is encrypted."
11790 #: ../fish/guestfish-actions.pod:2344 ../fish/guestfish-actions.pod:2542
11791 #: ../fish/guestfish-actions.pod:2601
11792 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2344
11793 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2542
11794 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2601
11795 msgid "See also L</list-filesystems>."
11799 #: ../fish/guestfish-actions.pod:2346
11800 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2346
11801 msgid "is-blockdev"
11805 #: ../fish/guestfish-actions.pod:2348
11806 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2348
11809 " is-blockdev path\n"
11814 #: ../fish/guestfish-actions.pod:2350
11815 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2350
11816 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3417
11817 #: ../src/guestfs-actions.pod:3417
11819 "This returns C<true> if and only if there is a block device with the given "
11824 #: ../fish/guestfish-actions.pod:2353 ../fish/guestfish-actions.pod:2371
11825 #: ../fish/guestfish-actions.pod:2390 ../fish/guestfish-actions.pod:2399
11826 #: ../fish/guestfish-actions.pod:2409 ../fish/guestfish-actions.pod:2443
11827 #: ../fish/guestfish-actions.pod:2452
11828 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2353
11829 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2371
11830 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2390
11831 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2399
11832 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2409
11833 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2443
11834 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2452
11835 msgid "See also L</stat>."
11839 #: ../fish/guestfish-actions.pod:2355
11840 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2355
11845 #: ../fish/guestfish-actions.pod:2357
11846 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2357
11854 #: ../fish/guestfish-actions.pod:2359
11855 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2359
11856 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3431
11857 #: ../src/guestfs-actions.pod:3431
11859 "This returns true iff this handle is busy processing a command (in the "
11864 #: ../fish/guestfish-actions.pod:2364
11865 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2364
11870 #: ../fish/guestfish-actions.pod:2366
11871 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2366
11874 " is-chardev path\n"
11879 #: ../fish/guestfish-actions.pod:2368
11880 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2368
11881 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3446
11882 #: ../src/guestfs-actions.pod:3446
11884 "This returns C<true> if and only if there is a character device with the "
11885 "given C<path> name."
11889 #: ../fish/guestfish-actions.pod:2373
11890 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2373
11895 #: ../fish/guestfish-actions.pod:2375
11896 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2375
11904 #: ../fish/guestfish-actions.pod:2377
11905 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2377
11906 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3460
11907 #: ../src/guestfs-actions.pod:3460
11909 "This returns true iff this handle is being configured (in the C<CONFIG> "
11914 #: ../fish/guestfish-actions.pod:2382
11915 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2382
11920 #: ../fish/guestfish-actions.pod:2384
11921 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2384
11929 #: ../fish/guestfish-actions.pod:2386
11930 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2386
11931 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3475
11932 #: ../src/guestfs-actions.pod:3475
11934 "This returns C<true> if and only if there is a directory with the given "
11935 "C<path> name. Note that it returns false for other objects like files."
11939 #: ../fish/guestfish-actions.pod:2392
11940 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2392
11945 #: ../fish/guestfish-actions.pod:2394
11946 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2394
11954 #: ../fish/guestfish-actions.pod:2396
11955 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2396
11956 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3491
11957 #: ../src/guestfs-actions.pod:3491
11959 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11960 "given C<path> name."
11964 #: ../fish/guestfish-actions.pod:2401
11965 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2401
11970 #: ../fish/guestfish-actions.pod:2403
11971 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2403
11979 #: ../fish/guestfish-actions.pod:2405
11980 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2405
11981 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3506
11982 #: ../src/guestfs-actions.pod:3506
11984 "This returns C<true> if and only if there is a regular file with the given "
11985 "C<path> name. Note that it returns false for other objects like directories."
11989 #: ../fish/guestfish-actions.pod:2411
11990 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2411
11991 msgid "is-launching"
11995 #: ../fish/guestfish-actions.pod:2413
11996 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2413
12004 #: ../fish/guestfish-actions.pod:2415
12005 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2415
12006 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3521
12007 #: ../src/guestfs-actions.pod:3521
12009 "This returns true iff this handle is launching the subprocess (in the "
12010 "C<LAUNCHING> state)."
12014 #: ../fish/guestfish-actions.pod:2420
12015 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2420
12020 #: ../fish/guestfish-actions.pod:2422
12021 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2422
12029 #: ../fish/guestfish-actions.pod:2424
12030 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2424
12031 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3536
12032 #: ../src/guestfs-actions.pod:3536
12034 "This command tests whether C<device> is a logical volume, and returns true "
12035 "iff this is the case."
12039 #: ../fish/guestfish-actions.pod:2427
12040 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2427
12045 #: ../fish/guestfish-actions.pod:2429
12046 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2429
12054 #: ../fish/guestfish-actions.pod:2431
12055 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2431
12056 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3548
12057 #: ../src/guestfs-actions.pod:3548
12059 "This returns true iff this handle is ready to accept commands (in the "
12064 #: ../fish/guestfish-actions.pod:2436
12065 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2436
12070 #: ../fish/guestfish-actions.pod:2438
12071 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2438
12074 " is-socket path\n"
12079 #: ../fish/guestfish-actions.pod:2440
12080 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2440
12081 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3563
12082 #: ../src/guestfs-actions.pod:3563
12084 "This returns C<true> if and only if there is a Unix domain socket with the "
12085 "given C<path> name."
12089 #: ../fish/guestfish-actions.pod:2445
12090 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2445
12095 #: ../fish/guestfish-actions.pod:2447
12096 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2447
12099 " is-symlink path\n"
12104 #: ../fish/guestfish-actions.pod:2449
12105 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2449
12106 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3578
12107 #: ../src/guestfs-actions.pod:3578
12109 "This returns C<true> if and only if there is a symbolic link with the given "
12114 #: ../fish/guestfish-actions.pod:2454
12115 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2454
12120 #: ../fish/guestfish-actions.pod:2456
12121 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2456
12129 #: ../fish/guestfish-actions.pod:2458
12130 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2458
12131 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3593
12132 #: ../src/guestfs-actions.pod:3593
12134 "This returns true iff the file exists and the file is empty or it contains "
12139 #: ../fish/guestfish-actions.pod:2461
12140 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2461
12141 msgid "is-zero-device"
12145 #: ../fish/guestfish-actions.pod:2463
12146 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2463
12149 " is-zero-device device\n"
12154 #: ../fish/guestfish-actions.pod:2465
12155 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2465
12156 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3606
12157 #: ../src/guestfs-actions.pod:3606
12158 msgid "This returns true iff the device exists and contains all zero bytes."
12162 #: ../fish/guestfish-actions.pod:2467
12163 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2467
12164 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3608
12165 #: ../src/guestfs-actions.pod:3608
12166 msgid "Note that for large devices this can take a long time to run."
12170 #: ../fish/guestfish-actions.pod:2469
12171 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2469
12172 msgid "kill-subprocess"
12176 #: ../fish/guestfish-actions.pod:2471
12177 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2471
12180 " kill-subprocess\n"
12185 #: ../fish/guestfish-actions.pod:2473
12186 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2473
12187 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3619
12188 #: ../src/guestfs-actions.pod:3619
12189 msgid "This kills the qemu subprocess. You should never need to call this."
12193 #: ../fish/guestfish-actions.pod:2475
12194 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2475
12199 #: ../fish/guestfish-actions.pod:2477
12200 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2477
12205 #: ../fish/guestfish-actions.pod:2479
12206 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2479
12214 #: ../fish/guestfish-actions.pod:2481
12215 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2481
12216 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3630
12217 #: ../src/guestfs-actions.pod:3630
12219 "Internally libguestfs is implemented by running a virtual machine using "
12224 #: ../fish/guestfish-actions.pod:2484
12225 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2484
12226 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3633
12227 #: ../src/guestfs-actions.pod:3633
12229 "You should call this after configuring the handle (eg. adding drives) but "
12230 "before performing any actions."
12234 #: ../fish/guestfish-actions.pod:2487
12235 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2487
12240 #: ../fish/guestfish-actions.pod:2489
12241 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2489
12244 " lchown owner group path\n"
12249 #: ../fish/guestfish-actions.pod:2491
12250 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2491
12252 "Change the file owner to C<owner> and group to C<group>. This is like L</"
12253 "chown> but if C<path> is a symlink then the link itself is changed, not the "
12258 #: ../fish/guestfish-actions.pod:2499
12259 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2499
12264 #: ../fish/guestfish-actions.pod:2501
12265 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2501
12268 " lgetxattr path name\n"
12273 #: ../fish/guestfish-actions.pod:2503
12274 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2503
12275 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3673
12276 #: ../src/guestfs-actions.pod:3673
12278 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12279 "is a symlink, then this call returns an extended attribute from the symlink."
12283 #: ../fish/guestfish-actions.pod:2517
12284 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2517
12285 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
12289 #: ../fish/guestfish-actions.pod:2519
12290 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2519
12295 #: ../fish/guestfish-actions.pod:2521
12296 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2521
12299 " lgetxattrs path\n"
12304 #: ../fish/guestfish-actions.pod:2523
12305 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2523
12307 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
12308 "it returns the extended attributes of the link itself."
12312 #: ../fish/guestfish-actions.pod:2527
12313 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2527
12318 #: ../fish/guestfish-actions.pod:2529
12319 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2529
12327 #: ../fish/guestfish-actions.pod:2531
12328 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2531
12329 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3716
12330 #: ../src/guestfs-actions.pod:3716
12332 "List all 9p filesystems attached to the guest. A list of mount tags is "
12337 #: ../fish/guestfish-actions.pod:2534
12338 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2534
12339 msgid "list-devices"
12343 #: ../fish/guestfish-actions.pod:2536
12344 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2536
12352 #: ../fish/guestfish-actions.pod:2538
12353 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2538
12354 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3730
12355 #: ../src/guestfs-actions.pod:3730
12356 msgid "List all the block devices."
12360 #: ../fish/guestfish-actions.pod:2540
12361 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2540
12362 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3732
12363 #: ../src/guestfs-actions.pod:3732
12364 msgid "The full block device names are returned, eg. C</dev/sda>."
12368 #: ../fish/guestfish-actions.pod:2544
12369 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2544
12370 msgid "list-dm-devices"
12374 #: ../fish/guestfish-actions.pod:2546
12375 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2546
12378 " list-dm-devices\n"
12383 #: ../fish/guestfish-actions.pod:2548
12384 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2548
12385 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3747
12386 #: ../src/guestfs-actions.pod:3747
12387 msgid "List all device mapper devices."
12391 #: ../fish/guestfish-actions.pod:2550
12392 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2550
12394 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
12395 "previous call to L</luks-open>."
12399 #: ../fish/guestfish-actions.pod:2553
12400 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2553
12402 "Device mapper devices which correspond to logical volumes are I<not> "
12403 "returned in this list. Call L</lvs> if you want to list logical volumes."
12407 #: ../fish/guestfish-actions.pod:2557
12408 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2557
12409 msgid "list-filesystems"
12413 #: ../fish/guestfish-actions.pod:2559
12414 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2559
12417 " list-filesystems\n"
12422 #: ../fish/guestfish-actions.pod:2561
12423 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2561
12424 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3767
12425 #: ../src/guestfs-actions.pod:3767
12427 "This inspection command looks for filesystems on partitions, block devices "
12428 "and logical volumes, returning a list of devices containing filesystems and "
12433 #: ../fish/guestfish-actions.pod:2565
12434 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2565
12435 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3771
12436 #: ../src/guestfs-actions.pod:3771
12438 "The return value is a hash, where the keys are the devices containing "
12439 "filesystems, and the values are the filesystem types. For example:"
12443 #: ../fish/guestfish-actions.pod:2569
12444 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2569
12445 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3775
12446 #: ../src/guestfs-actions.pod:3775
12449 " \"/dev/sda1\" => \"ntfs\"\n"
12450 " \"/dev/sda2\" => \"ext2\"\n"
12451 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12452 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12457 #: ../fish/guestfish-actions.pod:2574
12458 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2574
12459 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3780
12460 #: ../src/guestfs-actions.pod:3780
12462 "The value can have the special value \"unknown\", meaning the content of the "
12463 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12467 #: ../fish/guestfish-actions.pod:2578
12468 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2578
12470 "This command runs other libguestfs commands, which might include L</mount> "
12471 "and L</umount>, and therefore you should use this soon after launch and only "
12472 "when nothing is mounted."
12476 #: ../fish/guestfish-actions.pod:2582
12477 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2582
12479 "Not all of the filesystems returned will be mountable. In particular, swap "
12480 "partitions are returned in the list. Also this command does not check that "
12481 "each filesystem found is valid and mountable, and some filesystems might be "
12482 "mountable but require special options. Filesystems may not all belong to a "
12483 "single logical operating system (use L</inspect-os> to look for OSes)."
12487 #: ../fish/guestfish-actions.pod:2590
12488 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2590
12489 msgid "list-partitions"
12493 #: ../fish/guestfish-actions.pod:2592
12494 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2592
12497 " list-partitions\n"
12502 #: ../fish/guestfish-actions.pod:2594
12503 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2594
12504 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3809
12505 #: ../src/guestfs-actions.pod:3809
12506 msgid "List all the partitions detected on all block devices."
12510 #: ../fish/guestfish-actions.pod:2596
12511 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2596
12512 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3811
12513 #: ../src/guestfs-actions.pod:3811
12514 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12518 #: ../fish/guestfish-actions.pod:2598
12519 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2598
12521 "This does not return logical volumes. For that you will need to call L</"
12526 #: ../fish/guestfish-actions.pod:2603
12527 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2603
12532 #: ../fish/guestfish-actions.pod:2605
12533 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2605
12541 #: ../fish/guestfish-actions.pod:2607
12542 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2607
12543 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3830
12544 #: ../src/guestfs-actions.pod:3830
12546 "List the files in C<directory> (relative to the root directory, there is no "
12547 "cwd) in the format of 'ls -la'."
12551 #: ../fish/guestfish-actions.pod:2610
12552 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2610
12553 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3833
12554 #: ../src/guestfs-actions.pod:3833
12556 "This command is mostly useful for interactive sessions. It is I<not> "
12557 "intended that you try to parse the output string."
12561 #: ../fish/guestfish-actions.pod:2613
12562 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2613
12567 #: ../fish/guestfish-actions.pod:2615
12568 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2615
12571 " ln target linkname\n"
12576 #: ../fish/guestfish-actions.pod:2617
12577 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2617
12578 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3848
12579 #: ../src/guestfs-actions.pod:3848
12580 msgid "This command creates a hard link using the C<ln> command."
12584 #: ../fish/guestfish-actions.pod:2619
12585 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2619
12590 #: ../fish/guestfish-actions.pod:2621
12591 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2621
12594 " ln-f target linkname\n"
12599 #: ../fish/guestfish-actions.pod:2623
12600 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2623
12601 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3861
12602 #: ../src/guestfs-actions.pod:3861
12604 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12605 "option removes the link (C<linkname>) if it exists already."
12609 #: ../fish/guestfish-actions.pod:2626
12610 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2626
12615 #: ../fish/guestfish-actions.pod:2628
12616 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2628
12619 " ln-s target linkname\n"
12624 #: ../fish/guestfish-actions.pod:2630
12625 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2630
12626 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3875
12627 #: ../src/guestfs-actions.pod:3875
12628 msgid "This command creates a symbolic link using the C<ln -s> command."
12632 #: ../fish/guestfish-actions.pod:2632
12633 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2632
12638 #: ../fish/guestfish-actions.pod:2634
12639 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2634
12642 " ln-sf target linkname\n"
12647 #: ../fish/guestfish-actions.pod:2636
12648 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2636
12649 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3888
12650 #: ../src/guestfs-actions.pod:3888
12652 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12653 "option removes the link (C<linkname>) if it exists already."
12657 #: ../fish/guestfish-actions.pod:2639
12658 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2639
12659 msgid "lremovexattr"
12663 #: ../fish/guestfish-actions.pod:2641
12664 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2641
12667 " lremovexattr xattr path\n"
12672 #: ../fish/guestfish-actions.pod:2643
12673 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2643
12675 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
12676 "it removes an extended attribute of the link itself."
12680 #: ../fish/guestfish-actions.pod:2647
12681 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2647
12686 #: ../fish/guestfish-actions.pod:2649
12687 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2649
12695 #: ../fish/guestfish-actions.pod:2651
12696 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2651
12697 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3916
12698 #: ../src/guestfs-actions.pod:3916
12700 "List the files in C<directory> (relative to the root directory, there is no "
12701 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12705 #: ../fish/guestfish-actions.pod:2655
12706 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2655
12708 "This command is mostly useful for interactive sessions. Programs should "
12709 "probably use L</readdir> instead."
12713 #: ../fish/guestfish-actions.pod:2658
12714 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2658
12719 #: ../fish/guestfish-actions.pod:2660
12720 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2660
12723 " lsetxattr xattr val vallen path\n"
12728 #: ../fish/guestfish-actions.pod:2662
12729 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2662
12731 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
12732 "sets an extended attribute of the link itself."
12736 #: ../fish/guestfish-actions.pod:2666
12737 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2666
12742 #: ../fish/guestfish-actions.pod:2668
12743 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2668
12751 #: ../fish/guestfish-actions.pod:2670 ../fish/guestfish-actions.pod:4478
12752 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2670
12753 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4478
12754 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3952
12755 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6731
12756 #: ../src/guestfs-actions.pod:3952 ../src/guestfs-actions.pod:6731
12757 msgid "Returns file information for the given C<path>."
12761 #: ../fish/guestfish-actions.pod:2672
12762 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2672
12764 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
12765 "the link is stat-ed, not the file it refers to."
12769 #: ../fish/guestfish-actions.pod:2676
12770 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2676
12771 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3958
12772 #: ../src/guestfs-actions.pod:3958
12773 msgid "This is the same as the C<lstat(2)> system call."
12777 #: ../fish/guestfish-actions.pod:2678
12778 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2678
12783 #: ../fish/guestfish-actions.pod:2680
12784 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2680
12787 " lstatlist path 'names ...'\n"
12792 #: ../fish/guestfish-actions.pod:2682
12793 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2682
12795 "This call allows you to perform the L</lstat> operation on multiple files, "
12796 "where all files are in the directory C<path>. C<names> is the list of files "
12797 "from this directory."
12801 #: ../fish/guestfish-actions.pod:2686
12802 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2686
12803 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3977
12804 #: ../src/guestfs-actions.pod:3977
12806 "On return you get a list of stat structs, with a one-to-one correspondence "
12807 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12808 "then the C<ino> field of that structure is set to C<-1>."
12812 #: ../fish/guestfish-actions.pod:2691
12813 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2691
12815 "This call is intended for programs that want to efficiently list a directory "
12816 "contents without making many round-trips. See also L</lxattrlist> for a "
12817 "similarly efficient call for getting extended attributes. Very long "
12818 "directory listings might cause the protocol message size to be exceeded, "
12819 "causing this call to fail. The caller must split up such requests into "
12820 "smaller groups of names."
12824 #: ../fish/guestfish-actions.pod:2699
12825 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2699
12826 msgid "luks-add-key"
12830 #: ../fish/guestfish-actions.pod:2701
12831 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2701
12834 " luks-add-key device keyslot\n"
12839 #: ../fish/guestfish-actions.pod:2703
12840 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2703
12841 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4005
12842 #: ../src/guestfs-actions.pod:4005
12844 "This command adds a new key on LUKS device C<device>. C<key> is any "
12845 "existing key, and is used to access the device. C<newkey> is the new key to "
12846 "add. C<keyslot> is the key slot that will be replaced."
12850 #: ../fish/guestfish-actions.pod:2708
12851 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2708
12853 "Note that if C<keyslot> already contains a key, then this command will "
12854 "fail. You have to use L</luks-kill-slot> first to remove that key."
12858 #: ../fish/guestfish-actions.pod:2712 ../fish/guestfish-actions.pod:2734
12859 #: ../fish/guestfish-actions.pod:2747 ../fish/guestfish-actions.pod:2761
12860 #: ../fish/guestfish-actions.pod:2787 ../fish/guestfish-actions.pod:2797
12861 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2712
12862 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2734
12863 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2747
12864 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2761
12865 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2787
12866 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2797
12868 "This command has one or more key or passphrase parameters. Guestfish will "
12869 "prompt for these separately."
12873 #: ../fish/guestfish-actions.pod:2715
12874 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2715
12879 #: ../fish/guestfish-actions.pod:2717
12880 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2717
12883 " luks-close device\n"
12888 #: ../fish/guestfish-actions.pod:2719
12889 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2719
12891 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
12892 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
12893 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
12898 #: ../fish/guestfish-actions.pod:2725
12899 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2725
12900 msgid "luks-format"
12904 #: ../fish/guestfish-actions.pod:2727
12905 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2727
12908 " luks-format device keyslot\n"
12913 #: ../fish/guestfish-actions.pod:2729
12914 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2729
12915 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4046
12916 #: ../src/guestfs-actions.pod:4046
12918 "This command erases existing data on C<device> and formats the device as a "
12919 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12920 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12924 #: ../fish/guestfish-actions.pod:2737 ../fish/guestfish-actions.pod:2750
12925 #: ../fish/guestfish-actions.pod:2837 ../fish/guestfish-actions.pod:3498
12926 #: ../fish/guestfish-actions.pod:4024 ../fish/guestfish-actions.pod:4349
12927 #: ../fish/guestfish-actions.pod:4372 ../fish/guestfish-actions.pod:4394
12928 #: ../fish/guestfish-actions.pod:5132
12929 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2737
12930 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2750
12931 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2837
12932 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3498
12933 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4024
12934 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4349
12935 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4372
12936 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4394
12937 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5132
12938 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4053
12939 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4076
12940 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4219
12941 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5322
12942 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6110
12943 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6538
12944 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6568
12945 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6601
12946 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7799
12947 #: ../src/guestfs-actions.pod:4053 ../src/guestfs-actions.pod:4076
12948 #: ../src/guestfs-actions.pod:4219 ../src/guestfs-actions.pod:5322
12949 #: ../src/guestfs-actions.pod:6110 ../src/guestfs-actions.pod:6538
12950 #: ../src/guestfs-actions.pod:6568 ../src/guestfs-actions.pod:6601
12951 #: ../src/guestfs-actions.pod:7799
12953 "B<This command is dangerous. Without careful use you can easily destroy all "
12958 #: ../fish/guestfish-actions.pod:2740
12959 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2740
12960 msgid "luks-format-cipher"
12964 #: ../fish/guestfish-actions.pod:2742
12965 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2742
12968 " luks-format-cipher device keyslot cipher\n"
12973 #: ../fish/guestfish-actions.pod:2744
12974 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2744
12976 "This command is the same as L</luks-format> but it also allows you to set "
12977 "the C<cipher> used."
12981 #: ../fish/guestfish-actions.pod:2753
12982 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2753
12983 msgid "luks-kill-slot"
12987 #: ../fish/guestfish-actions.pod:2755
12988 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2755
12991 " luks-kill-slot device keyslot\n"
12996 #: ../fish/guestfish-actions.pod:2757
12997 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2757
12998 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4093
12999 #: ../src/guestfs-actions.pod:4093
13001 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
13002 "device C<device>. C<key> must be one of the I<other> keys."
13006 #: ../fish/guestfish-actions.pod:2764
13007 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2764
13012 #: ../fish/guestfish-actions.pod:2766
13013 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2766
13016 " luks-open device mapname\n"
13021 #: ../fish/guestfish-actions.pod:2768
13022 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2768
13023 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4113
13024 #: ../src/guestfs-actions.pod:4113
13026 "This command opens a block device which has been encrypted according to the "
13027 "Linux Unified Key Setup (LUKS) standard."
13031 #: ../fish/guestfish-actions.pod:2771
13032 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2771
13033 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4116
13034 #: ../src/guestfs-actions.pod:4116
13035 msgid "C<device> is the encrypted block device or partition."
13039 #: ../fish/guestfish-actions.pod:2773
13040 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2773
13041 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4118
13042 #: ../src/guestfs-actions.pod:4118
13044 "The caller must supply one of the keys associated with the LUKS block "
13045 "device, in the C<key> parameter."
13049 #: ../fish/guestfish-actions.pod:2776
13050 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2776
13051 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4121
13052 #: ../src/guestfs-actions.pod:4121
13054 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
13055 "writes to this block device are decrypted from and encrypted to the "
13056 "underlying C<device> respectively."
13060 #: ../fish/guestfish-actions.pod:2780
13061 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2780
13063 "If this block device contains LVM volume groups, then calling L</vgscan> "
13064 "followed by L</vg-activate-all> will make them visible."
13068 #: ../fish/guestfish-actions.pod:2784
13069 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2784
13070 msgid "Use L</list-dm-devices> to list all device mapper devices."
13074 #: ../fish/guestfish-actions.pod:2790
13075 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2790
13076 msgid "luks-open-ro"
13080 #: ../fish/guestfish-actions.pod:2792
13081 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2792
13084 " luks-open-ro device mapname\n"
13089 #: ../fish/guestfish-actions.pod:2794
13090 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2794
13092 "This is the same as L</luks-open> except that a read-only mapping is created."
13096 #: ../fish/guestfish-actions.pod:2800
13097 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2800
13102 #: ../fish/guestfish-actions.pod:2802
13103 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2802
13106 " lvcreate logvol volgroup mbytes\n"
13111 #: ../fish/guestfish-actions.pod:2804
13112 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2804
13113 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4167
13114 #: ../src/guestfs-actions.pod:4167
13116 "This creates an LVM logical volume called C<logvol> on the volume group "
13117 "C<volgroup>, with C<size> megabytes."
13121 #: ../fish/guestfish-actions.pod:2807
13122 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2807
13123 msgid "lvm-canonical-lv-name"
13127 #: ../fish/guestfish-actions.pod:2809
13128 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2809
13131 " lvm-canonical-lv-name lvname\n"
13136 #: ../fish/guestfish-actions.pod:2811
13137 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2811
13138 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4180
13139 #: ../src/guestfs-actions.pod:4180
13141 "This converts alternative naming schemes for LVs that you might find to the "
13142 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13147 #: ../fish/guestfish-actions.pod:2815
13148 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2815
13149 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4184
13150 #: ../src/guestfs-actions.pod:4184
13152 "This command returns an error if the C<lvname> parameter does not refer to a "
13157 #: ../fish/guestfish-actions.pod:2818
13158 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2818
13159 msgid "See also L</is-lv>."
13163 #: ../fish/guestfish-actions.pod:2820
13164 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2820
13165 msgid "lvm-clear-filter"
13169 #: ../fish/guestfish-actions.pod:2822
13170 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2822
13173 " lvm-clear-filter\n"
13178 #: ../fish/guestfish-actions.pod:2824
13179 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2824
13181 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
13186 #: ../fish/guestfish-actions.pod:2827 ../fish/guestfish-actions.pod:2858
13187 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2827
13188 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2858
13189 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4202
13190 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4244
13191 #: ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:4244
13193 "This command also clears the LVM cache and performs a volume group scan."
13197 #: ../fish/guestfish-actions.pod:2830
13198 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2830
13199 msgid "lvm-remove-all"
13203 #: ../fish/guestfish-actions.pod:2832
13204 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2832
13207 " lvm-remove-all\n"
13212 #: ../fish/guestfish-actions.pod:2834
13213 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2834
13214 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4214
13215 #: ../src/guestfs-actions.pod:4214
13217 "This command removes all LVM logical volumes, volume groups and physical "
13222 #: ../fish/guestfish-actions.pod:2840
13223 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2840
13224 msgid "lvm-set-filter"
13228 #: ../fish/guestfish-actions.pod:2842
13229 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2842
13232 " lvm-set-filter 'devices ...'\n"
13237 #: ../fish/guestfish-actions.pod:2844
13238 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2844
13239 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4230
13240 #: ../src/guestfs-actions.pod:4230
13242 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
13243 "block devices in the list C<devices>, and will ignore all other attached "
13248 #: ../fish/guestfish-actions.pod:2848
13249 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2848
13250 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4234
13251 #: ../src/guestfs-actions.pod:4234
13253 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13254 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
13255 "there are two types of duplication possible: either cloned PVs/VGs which "
13256 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
13257 "same name. In normal operation you cannot create this situation, but you "
13258 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13259 "inside the LVM metadata."
13263 #: ../fish/guestfish-actions.pod:2861
13264 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2861
13265 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4247
13266 #: ../src/guestfs-actions.pod:4247
13267 msgid "You can filter whole block devices or individual partitions."
13271 #: ../fish/guestfish-actions.pod:2863
13272 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2863
13273 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4249
13274 #: ../src/guestfs-actions.pod:4249
13276 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13277 "filesystem), even if you are not filtering out that VG."
13281 #: ../fish/guestfish-actions.pod:2867
13282 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2867
13287 #: ../fish/guestfish-actions.pod:2869
13288 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2869
13291 " lvremove device\n"
13296 #: ../fish/guestfish-actions.pod:2871
13297 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2871
13298 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4263
13299 #: ../src/guestfs-actions.pod:4263
13301 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
13302 "LV, such as C</dev/VG/LV>."
13306 #: ../fish/guestfish-actions.pod:2874
13307 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2874
13308 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4266
13309 #: ../src/guestfs-actions.pod:4266
13311 "You can also remove all LVs in a volume group by specifying the VG name, C</"
13316 #: ../fish/guestfish-actions.pod:2877
13317 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2877
13322 #: ../fish/guestfish-actions.pod:2879
13323 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2879
13326 " lvrename logvol newlogvol\n"
13331 #: ../fish/guestfish-actions.pod:2881
13332 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2881
13333 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4280
13334 #: ../src/guestfs-actions.pod:4280
13335 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13339 #: ../fish/guestfish-actions.pod:2883
13340 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2883
13345 #: ../fish/guestfish-actions.pod:2885
13346 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2885
13349 " lvresize device mbytes\n"
13354 #: ../fish/guestfish-actions.pod:2887
13355 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2887
13356 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4293
13357 #: ../src/guestfs-actions.pod:4293
13359 "This resizes (expands or shrinks) an existing LVM logical volume to "
13360 "C<mbytes>. When reducing, data in the reduced part is lost."
13364 #: ../fish/guestfish-actions.pod:2891
13365 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2891
13366 msgid "lvresize-free"
13370 #: ../fish/guestfish-actions.pod:2893
13371 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2893
13374 " lvresize-free lv percent\n"
13379 #: ../fish/guestfish-actions.pod:2895
13380 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2895
13381 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4308
13382 #: ../src/guestfs-actions.pod:4308
13384 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13385 "remaining free space in the volume group. Commonly you would call this with "
13386 "pc = 100 which expands the logical volume as much as possible, using all "
13387 "remaining free space in the volume group."
13391 #: ../fish/guestfish-actions.pod:2901
13392 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2901
13397 #: ../fish/guestfish-actions.pod:2903
13398 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2903
13406 #: ../fish/guestfish-actions.pod:2905
13407 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2905
13408 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4323
13409 #: ../src/guestfs-actions.pod:4323
13411 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13416 #: ../fish/guestfish-actions.pod:2908
13417 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2908
13418 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4326
13419 #: ../src/guestfs-actions.pod:4326
13421 "This returns a list of the logical volume device names (eg. C</dev/"
13422 "VolGroup00/LogVol00>)."
13426 #: ../fish/guestfish-actions.pod:2911
13427 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2911
13428 msgid "See also L</lvs-full>, L</list-filesystems>."
13432 #: ../fish/guestfish-actions.pod:2913
13433 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2913
13438 #: ../fish/guestfish-actions.pod:2915
13439 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2915
13447 #: ../fish/guestfish-actions.pod:2917
13448 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2917
13449 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4342
13450 #: ../src/guestfs-actions.pod:4342
13452 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13453 "(8)> command. The \"full\" version includes all fields."
13457 #: ../fish/guestfish-actions.pod:2920
13458 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2920
13463 #: ../fish/guestfish-actions.pod:2922
13464 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2922
13472 #: ../fish/guestfish-actions.pod:2924
13473 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2924
13474 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4357
13475 #: ../src/guestfs-actions.pod:4357
13476 msgid "This command returns the UUID of the LVM LV C<device>."
13480 #: ../fish/guestfish-actions.pod:2926
13481 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2926
13486 #: ../fish/guestfish-actions.pod:2928
13487 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2928
13490 " lxattrlist path 'names ...'\n"
13495 #: ../fish/guestfish-actions.pod:2930
13496 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2930
13497 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4371
13498 #: ../src/guestfs-actions.pod:4371
13500 "This call allows you to get the extended attributes of multiple files, where "
13501 "all files are in the directory C<path>. C<names> is the list of files from "
13506 #: ../fish/guestfish-actions.pod:2934
13507 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2934
13508 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4375
13509 #: ../src/guestfs-actions.pod:4375
13511 "On return you get a flat list of xattr structs which must be interpreted "
13512 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13513 "C<attrval> in this struct is zero-length to indicate there was an error "
13514 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13515 "number (the number of following attributes for this file, which could be C<"
13516 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13517 "for the first named file. This repeats for the second and subsequent files."
13521 #: ../fish/guestfish-actions.pod:2944
13522 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2944
13524 "This call is intended for programs that want to efficiently list a directory "
13525 "contents without making many round-trips. See also L</lstatlist> for a "
13526 "similarly efficient call for getting standard stats. Very long directory "
13527 "listings might cause the protocol message size to be exceeded, causing this "
13528 "call to fail. The caller must split up such requests into smaller groups of "
13533 #: ../fish/guestfish-actions.pod:2952
13534 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2952
13539 #: ../fish/guestfish-actions.pod:2954
13540 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2954
13548 #: ../fish/guestfish-actions.pod:2956
13549 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2956
13550 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4405
13551 #: ../src/guestfs-actions.pod:4405
13552 msgid "Create a directory named C<path>."
13556 #: ../fish/guestfish-actions.pod:2958
13557 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2958
13562 #: ../fish/guestfish-actions.pod:2960
13563 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2960
13566 " mkdir-mode path mode\n"
13571 #: ../fish/guestfish-actions.pod:2962
13572 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2962
13573 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4418
13574 #: ../src/guestfs-actions.pod:4418
13576 "This command creates a directory, setting the initial permissions of the "
13577 "directory to C<mode>."
13581 #: ../fish/guestfish-actions.pod:2965
13582 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2965
13583 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4421
13584 #: ../src/guestfs-actions.pod:4421
13586 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13587 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13592 #: ../fish/guestfish-actions.pod:2969
13593 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2969
13594 msgid "See also L</mkdir>, L</umask>"
13598 #: ../fish/guestfish-actions.pod:2971
13599 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2971
13604 #: ../fish/guestfish-actions.pod:2973
13605 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2973
13613 #: ../fish/guestfish-actions.pod:2975
13614 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2975
13615 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4437
13616 #: ../src/guestfs-actions.pod:4437
13618 "Create a directory named C<path>, creating any parent directories as "
13619 "necessary. This is like the C<mkdir -p> shell command."
13623 #: ../fish/guestfish-actions.pod:2978
13624 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2978
13629 #: ../fish/guestfish-actions.pod:2980
13630 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2980
13633 " mkdtemp template\n"
13638 #: ../fish/guestfish-actions.pod:2982
13639 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2982
13640 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4450
13641 #: ../src/guestfs-actions.pod:4450
13643 "This command creates a temporary directory. The C<template> parameter "
13644 "should be a full pathname for the temporary directory name with the final "
13645 "six characters being \"XXXXXX\"."
13649 #: ../fish/guestfish-actions.pod:2987
13650 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2987
13651 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4455
13652 #: ../src/guestfs-actions.pod:4455
13654 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13655 "being suitable for Windows filesystems."
13659 #: ../fish/guestfish-actions.pod:2990
13660 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2990
13661 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4458
13662 #: ../src/guestfs-actions.pod:4458
13663 msgid "The name of the temporary directory that was created is returned."
13667 #: ../fish/guestfish-actions.pod:2993
13668 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2993
13669 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4461
13670 #: ../src/guestfs-actions.pod:4461
13671 msgid "The temporary directory is created with mode 0700 and is owned by root."
13675 #: ../fish/guestfish-actions.pod:2996
13676 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2996
13677 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4464
13678 #: ../src/guestfs-actions.pod:4464
13680 "The caller is responsible for deleting the temporary directory and its "
13681 "contents after use."
13685 #: ../fish/guestfish-actions.pod:2999
13686 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:2999
13687 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4467
13688 #: ../src/guestfs-actions.pod:4467
13689 msgid "See also: L<mkdtemp(3)>"
13693 #: ../fish/guestfish-actions.pod:3001
13694 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3001
13699 #: ../fish/guestfish-actions.pod:3003
13700 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3003
13703 " mke2fs-J fstype blocksize device journal\n"
13708 #: ../fish/guestfish-actions.pod:3005
13709 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3005
13710 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4483
13711 #: ../src/guestfs-actions.pod:4483
13713 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13714 "C<journal>. It is equivalent to the command:"
13718 #: ../fish/guestfish-actions.pod:3009
13719 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3009
13720 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4487
13721 #: ../src/guestfs-actions.pod:4487
13724 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13729 #: ../fish/guestfish-actions.pod:3011
13730 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3011
13731 msgid "See also L</mke2journal>."
13735 #: ../fish/guestfish-actions.pod:3013
13736 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3013
13741 #: ../fish/guestfish-actions.pod:3015
13742 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3015
13745 " mke2fs-JL fstype blocksize device label\n"
13750 #: ../fish/guestfish-actions.pod:3017
13751 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3017
13752 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4504
13753 #: ../src/guestfs-actions.pod:4504
13755 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13756 "the journal labeled C<label>."
13760 #: ../fish/guestfish-actions.pod:3020
13761 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3020
13762 msgid "See also L</mke2journal-L>."
13766 #: ../fish/guestfish-actions.pod:3022
13767 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3022
13772 #: ../fish/guestfish-actions.pod:3024
13773 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3024
13776 " mke2fs-JU fstype blocksize device uuid\n"
13781 #: ../fish/guestfish-actions.pod:3026
13782 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3026
13783 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4522
13784 #: ../src/guestfs-actions.pod:4522
13786 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13787 "the journal with UUID C<uuid>."
13791 #: ../fish/guestfish-actions.pod:3029
13792 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3029
13793 msgid "See also L</mke2journal-U>."
13797 #: ../fish/guestfish-actions.pod:3031
13798 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3031
13799 msgid "mke2journal"
13803 #: ../fish/guestfish-actions.pod:3033
13804 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3033
13807 " mke2journal blocksize device\n"
13812 #: ../fish/guestfish-actions.pod:3035
13813 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3035
13814 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4538
13815 #: ../src/guestfs-actions.pod:4538
13817 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13822 #: ../fish/guestfish-actions.pod:3038
13823 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3038
13824 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4541
13825 #: ../src/guestfs-actions.pod:4541
13828 " mke2fs -O journal_dev -b blocksize device\n"
13833 #: ../fish/guestfish-actions.pod:3040
13834 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3040
13835 msgid "mke2journal-L"
13839 #: ../fish/guestfish-actions.pod:3042
13840 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3042
13843 " mke2journal-L blocksize label device\n"
13848 #: ../fish/guestfish-actions.pod:3044
13849 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3044
13850 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4555
13851 #: ../src/guestfs-actions.pod:4555
13852 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13856 #: ../fish/guestfish-actions.pod:3046
13857 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3046
13858 msgid "mke2journal-U"
13862 #: ../fish/guestfish-actions.pod:3048
13863 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3048
13866 " mke2journal-U blocksize uuid device\n"
13871 #: ../fish/guestfish-actions.pod:3050
13872 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3050
13873 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4569
13874 #: ../src/guestfs-actions.pod:4569
13875 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13879 #: ../fish/guestfish-actions.pod:3052
13880 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3052
13885 #: ../fish/guestfish-actions.pod:3054
13886 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3054
13889 " mkfifo mode path\n"
13894 #: ../fish/guestfish-actions.pod:3056
13895 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3056
13897 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13898 "is just a convenient wrapper around L</mknod>."
13902 #: ../fish/guestfish-actions.pod:3062
13903 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3062
13908 #: ../fish/guestfish-actions.pod:3064
13909 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3064
13912 " mkfs fstype device\n"
13917 #: ../fish/guestfish-actions.pod:3066
13918 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3066
13919 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4599
13920 #: ../src/guestfs-actions.pod:4599
13922 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13923 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13927 #: ../fish/guestfish-actions.pod:3070
13928 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3070
13933 #: ../fish/guestfish-actions.pod:3072
13934 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3072
13937 " mkfs-b fstype blocksize device\n"
13942 #: ../fish/guestfish-actions.pod:3074
13943 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3074
13945 "This call is similar to L</mkfs>, but it allows you to control the block "
13946 "size of the resulting filesystem. Supported block sizes depend on the "
13947 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13951 #: ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3106
13952 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3079
13953 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3106
13954 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4620
13955 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4665
13956 #: ../src/guestfs-actions.pod:4620 ../src/guestfs-actions.pod:4665
13958 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13963 #: ../fish/guestfish-actions.pod:3082
13964 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3082
13965 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4625
13966 #: ../src/guestfs-actions.pod:4625
13968 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
13972 #: ../fish/guestfish-actions.pod:3089
13973 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3089
13978 #: ../fish/guestfish-actions.pod:3091
13979 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3091
13982 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] [sectorsize:..]\n"
13987 #: ../fish/guestfish-actions.pod:3093
13988 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3093
13989 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4652
13990 #: ../src/guestfs-actions.pod:4652
13992 "This function creates a filesystem on C<device>. The filesystem type is "
13993 "C<fstype>, for example C<ext3>."
13997 #: ../fish/guestfish-actions.pod:3100
13998 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3100
13999 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4659
14000 #: ../src/guestfs-actions.pod:4659
14001 msgid "C<blocksize>"
14005 #: ../fish/guestfish-actions.pod:3102
14006 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3102
14007 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4661
14008 #: ../src/guestfs-actions.pod:4661
14010 "The filesystem block size. Supported block sizes depend on the filesystem "
14011 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
14016 #: ../fish/guestfish-actions.pod:3109
14017 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3109
14018 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4668
14019 #: ../src/guestfs-actions.pod:4668
14020 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
14024 #: ../fish/guestfish-actions.pod:3111
14025 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3111
14026 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4670
14027 #: ../src/guestfs-actions.pod:4670
14028 msgid "C<features>"
14032 #: ../fish/guestfish-actions.pod:3113
14033 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3113
14034 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4672
14035 #: ../src/guestfs-actions.pod:4672
14036 msgid "This passes the I<-O> parameter to the external mkfs program."
14040 #: ../fish/guestfish-actions.pod:3115
14041 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3115
14042 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4674
14043 #: ../src/guestfs-actions.pod:4674
14045 "For certain filesystem types, this allows extra filesystem features to be "
14046 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
14050 #: ../fish/guestfish-actions.pod:3119
14051 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3119
14052 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4678
14053 #: ../src/guestfs-actions.pod:4678
14055 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
14060 #: ../fish/guestfish-actions.pod:3122
14061 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3122
14062 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4681
14063 #: ../src/guestfs-actions.pod:4681
14068 #: ../fish/guestfish-actions.pod:3124
14069 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3124
14070 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4683
14071 #: ../src/guestfs-actions.pod:4683
14073 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
14074 "sets the inode size (only for ext2/3/4 filesystems at present)."
14078 #: ../fish/guestfish-actions.pod:3127
14079 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3127
14080 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4686
14081 #: ../src/guestfs-actions.pod:4686
14082 msgid "C<sectorsize>"
14086 #: ../fish/guestfish-actions.pod:3129
14087 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3129
14088 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4688
14089 #: ../src/guestfs-actions.pod:4688
14091 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
14092 "sets sector size for ufs filesystem."
14096 #: ../fish/guestfish-actions.pod:3136
14097 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3136
14098 msgid "mkmountpoint"
14102 #: ../fish/guestfish-actions.pod:3138
14103 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3138
14106 " mkmountpoint exemptpath\n"
14111 #: ../fish/guestfish-actions.pod:3140
14112 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3140
14114 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
14115 "to create extra mountpoints before mounting the first filesystem."
14119 #: ../fish/guestfish-actions.pod:3144
14120 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3144
14121 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4731
14122 #: ../src/guestfs-actions.pod:4731
14124 "These calls are I<only> necessary in some very limited circumstances, mainly "
14125 "the case where you want to mount a mix of unrelated and/or read-only "
14126 "filesystems together."
14130 #: ../fish/guestfish-actions.pod:3148
14131 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3148
14132 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4735
14133 #: ../src/guestfs-actions.pod:4735
14135 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
14136 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
14137 "inside that. You can unpack this as follows in guestfish:"
14141 #: ../fish/guestfish-actions.pod:3153
14142 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3153
14143 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4740
14144 #: ../src/guestfs-actions.pod:4740
14147 " add-ro Fedora-11-i686-Live.iso\n"
14149 " mkmountpoint /cd\n"
14150 " mkmountpoint /sqsh\n"
14151 " mkmountpoint /ext3fs\n"
14152 " mount /dev/sda /cd\n"
14153 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
14154 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
14159 #: ../fish/guestfish-actions.pod:3162
14160 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3162
14161 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4749
14162 #: ../src/guestfs-actions.pod:4749
14163 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
14167 #: ../fish/guestfish-actions.pod:3164
14168 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3164
14170 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
14171 "unexpected errors if you try to mix these calls. It is safest to manually "
14172 "unmount filesystems and remove mountpoints after use."
14176 #: ../fish/guestfish-actions.pod:3168
14177 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3168
14179 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
14180 "for this to work for manual mountpoints, you must ensure that the innermost "
14181 "mountpoints have the longest pathnames, as in the example code above."
14185 #: ../fish/guestfish-actions.pod:3173
14186 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3173
14187 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4760
14188 #: ../src/guestfs-actions.pod:4760
14190 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14194 #: ../fish/guestfish-actions.pod:3175
14195 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3175
14197 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
14198 "L</umount-all> to be called when the handle is closed which can also trigger "
14203 #: ../fish/guestfish-actions.pod:3179
14204 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3179
14209 #: ../fish/guestfish-actions.pod:3181
14210 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3181
14213 " mknod mode devmajor devminor path\n"
14218 #: ../fish/guestfish-actions.pod:3183
14219 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3183
14220 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4779
14221 #: ../src/guestfs-actions.pod:4779
14223 "This call creates block or character special devices, or named pipes (FIFOs)."
14227 #: ../fish/guestfish-actions.pod:3186
14228 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3186
14229 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4782
14230 #: ../src/guestfs-actions.pod:4782
14232 "The C<mode> parameter should be the mode, using the standard constants. "
14233 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
14234 "used when creating block and character special devices."
14238 #: ../fish/guestfish-actions.pod:3191
14239 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3191
14241 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
14242 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
14243 "regular file). These constants are available in the standard Linux header "
14244 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
14245 "wrappers around this command which bitwise OR in the appropriate constant "
14250 #: ../fish/guestfish-actions.pod:3201
14251 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3201
14256 #: ../fish/guestfish-actions.pod:3203
14257 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3203
14260 " mknod-b mode devmajor devminor path\n"
14265 #: ../fish/guestfish-actions.pod:3205
14266 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3205
14268 "This call creates a block device node called C<path> with mode C<mode> and "
14269 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14270 "wrapper around L</mknod>."
14274 #: ../fish/guestfish-actions.pod:3211
14275 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3211
14280 #: ../fish/guestfish-actions.pod:3213
14281 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3213
14284 " mknod-c mode devmajor devminor path\n"
14289 #: ../fish/guestfish-actions.pod:3215
14290 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3215
14292 "This call creates a char device node called C<path> with mode C<mode> and "
14293 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14294 "wrapper around L</mknod>."
14298 #: ../fish/guestfish-actions.pod:3221
14299 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3221
14304 #: ../fish/guestfish-actions.pod:3223
14305 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3223
14313 #: ../fish/guestfish-actions.pod:3225
14314 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3225
14315 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4845
14316 #: ../src/guestfs-actions.pod:4845
14317 msgid "Create a swap partition on C<device>."
14321 #: ../fish/guestfish-actions.pod:3227
14322 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3227
14327 #: ../fish/guestfish-actions.pod:3229
14328 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3229
14331 " mkswap-L label device\n"
14336 #: ../fish/guestfish-actions.pod:3231
14337 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3231
14338 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4858
14339 #: ../src/guestfs-actions.pod:4858
14340 msgid "Create a swap partition on C<device> with label C<label>."
14344 #: ../fish/guestfish-actions.pod:3233
14345 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3233
14346 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4860
14347 #: ../src/guestfs-actions.pod:4860
14349 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
14350 "sda>), just to a partition. This appears to be a limitation of the kernel "
14355 #: ../fish/guestfish-actions.pod:3237
14356 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3237
14361 #: ../fish/guestfish-actions.pod:3239
14362 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3239
14365 " mkswap-U uuid device\n"
14370 #: ../fish/guestfish-actions.pod:3241
14371 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3241
14372 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4875
14373 #: ../src/guestfs-actions.pod:4875
14374 msgid "Create a swap partition on C<device> with UUID C<uuid>."
14378 #: ../fish/guestfish-actions.pod:3243
14379 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3243
14380 msgid "mkswap-file"
14384 #: ../fish/guestfish-actions.pod:3245
14385 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3245
14388 " mkswap-file path\n"
14393 #: ../fish/guestfish-actions.pod:3247
14394 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3247
14395 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4887
14396 #: ../src/guestfs-actions.pod:4887
14397 msgid "Create a swap file."
14401 #: ../fish/guestfish-actions.pod:3249
14402 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3249
14404 "This command just writes a swap file signature to an existing file. To "
14405 "create the file itself, use something like L</fallocate>."
14409 #: ../fish/guestfish-actions.pod:3252
14410 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3252
14415 #: ../fish/guestfish-actions.pod:3254
14416 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3254
14419 " modprobe modulename\n"
14424 #: ../fish/guestfish-actions.pod:3256
14425 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3256
14426 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4902
14427 #: ../src/guestfs-actions.pod:4902
14428 msgid "This loads a kernel module in the appliance."
14432 #: ../fish/guestfish-actions.pod:3258
14433 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3258
14434 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4904
14435 #: ../src/guestfs-actions.pod:4904
14437 "The kernel module must have been whitelisted when libguestfs was built (see "
14438 "C<appliance/kmod.whitelist.in> in the source)."
14442 #: ../fish/guestfish-actions.pod:3261
14443 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3261
14448 #: ../fish/guestfish-actions.pod:3263
14449 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3263
14452 " mount device mountpoint\n"
14457 #: ../fish/guestfish-actions.pod:3265
14458 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3265
14459 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4918
14460 #: ../src/guestfs-actions.pod:4918
14462 "Mount a guest disk at a position in the filesystem. Block devices are named "
14463 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14464 "those block devices contain partitions, they will have the usual names (eg. "
14465 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14469 #: ../fish/guestfish-actions.pod:3271
14470 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3271
14471 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4924
14472 #: ../src/guestfs-actions.pod:4924
14474 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14475 "mounted on C</> before others can be mounted. Other filesystems can only be "
14476 "mounted on directories which already exist."
14480 #: ../fish/guestfish-actions.pod:3276
14481 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3276
14482 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4929
14483 #: ../src/guestfs-actions.pod:4929
14485 "The mounted filesystem is writable, if we have sufficient permissions on the "
14486 "underlying device."
14490 #: ../fish/guestfish-actions.pod:3279
14491 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3279
14493 "B<Important note:> When you use this call, the filesystem options C<sync> "
14494 "and C<noatime> are set implicitly. This was originally done because we "
14495 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14496 "very large negative performance impact and negligible effect on "
14497 "reliability. Therefore we recommend that you avoid using L</mount> in any "
14498 "code that needs performance, and instead use L</mount-options> (use an empty "
14499 "string for the first parameter if you don't want any options)."
14503 #: ../fish/guestfish-actions.pod:3289
14504 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3289
14505 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4944
14506 #: ../src/guestfs-actions.pod:4944
14508 "This function is deprecated. In new code, use the C<mount_options> call "
14513 #: ../fish/guestfish-actions.pod:3296
14514 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3296
14519 #: ../fish/guestfish-actions.pod:3298
14520 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3298
14523 " mount-9p mounttag mountpoint [options:..]\n"
14528 #: ../fish/guestfish-actions.pod:3300
14529 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3300
14530 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4968
14531 #: ../src/guestfs-actions.pod:4968
14533 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
14538 #: ../fish/guestfish-actions.pod:3303
14539 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3303
14540 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4971
14541 #: ../src/guestfs-actions.pod:4971
14543 "If required, C<trans=virtio> will be automatically added to the options. "
14544 "Any other options required can be passed in the optional C<options> "
14549 #: ../fish/guestfish-actions.pod:3309
14550 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3309
14555 #: ../fish/guestfish-actions.pod:3311
14556 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3311
14559 " mount-loop file mountpoint\n"
14564 #: ../fish/guestfish-actions.pod:3313
14565 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3313
14566 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5010
14567 #: ../src/guestfs-actions.pod:5010
14569 "This command lets you mount C<file> (a filesystem image in a file) on a "
14570 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14575 #: ../fish/guestfish-actions.pod:3317
14576 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3317
14577 msgid "mount-options"
14581 #: ../fish/guestfish-actions.pod:3319
14582 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3319
14585 " mount-options options device mountpoint\n"
14590 #: ../fish/guestfish-actions.pod:3321
14591 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3321
14593 "This is the same as the L</mount> command, but it allows you to set the "
14594 "mount options as for the L<mount(8)> I<-o> flag."
14598 #: ../fish/guestfish-actions.pod:3325
14599 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3325
14600 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5030
14601 #: ../src/guestfs-actions.pod:5030
14603 "If the C<options> parameter is an empty string, then no options are passed "
14604 "(all options default to whatever the filesystem uses)."
14608 #: ../fish/guestfish-actions.pod:3329
14609 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3329
14614 #: ../fish/guestfish-actions.pod:3331
14615 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3331
14618 " mount-ro device mountpoint\n"
14623 #: ../fish/guestfish-actions.pod:3333
14624 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3333
14626 "This is the same as the L</mount> command, but it mounts the filesystem with "
14627 "the read-only (I<-o ro>) flag."
14631 #: ../fish/guestfish-actions.pod:3336
14632 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3336
14637 #: ../fish/guestfish-actions.pod:3338
14638 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3338
14641 " mount-vfs options vfstype device mountpoint\n"
14646 #: ../fish/guestfish-actions.pod:3340
14647 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3340
14649 "This is the same as the L</mount> command, but it allows you to set both the "
14650 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
14654 #: ../fish/guestfish-actions.pod:3344
14655 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3344
14656 msgid "mountpoints"
14660 #: ../fish/guestfish-actions.pod:3346
14661 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3346
14669 #: ../fish/guestfish-actions.pod:3348
14670 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3348
14672 "This call is similar to L</mounts>. That call returns a list of devices. "
14673 "This one returns a hash table (map) of device name to directory where the "
14674 "device is mounted."
14678 #: ../fish/guestfish-actions.pod:3352
14679 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3352
14684 #: ../fish/guestfish-actions.pod:3354
14685 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3354
14693 #: ../fish/guestfish-actions.pod:3356
14694 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3356
14695 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5091
14696 #: ../src/guestfs-actions.pod:5091
14698 "This returns the list of currently mounted filesystems. It returns the list "
14699 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14703 #: ../fish/guestfish-actions.pod:3359
14704 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3359
14705 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5094
14706 #: ../src/guestfs-actions.pod:5094
14707 msgid "Some internal mounts are not shown."
14711 #: ../fish/guestfish-actions.pod:3361
14712 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3361
14713 msgid "See also: L</mountpoints>"
14717 #: ../fish/guestfish-actions.pod:3363
14718 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3363
14723 #: ../fish/guestfish-actions.pod:3365
14724 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3365
14732 #: ../fish/guestfish-actions.pod:3367
14733 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3367
14734 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5111
14735 #: ../src/guestfs-actions.pod:5111
14737 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14738 "destination filename or destination directory."
14742 #: ../fish/guestfish-actions.pod:3370
14743 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3370
14744 msgid "ntfs-3g-probe"
14748 #: ../fish/guestfish-actions.pod:3372
14749 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3372
14752 " ntfs-3g-probe true|false device\n"
14757 #: ../fish/guestfish-actions.pod:3374
14758 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3374
14759 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5125
14760 #: ../src/guestfs-actions.pod:5125
14762 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14763 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14764 "write, and some cannot be mounted at all)."
14768 #: ../fish/guestfish-actions.pod:3378
14769 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3378
14770 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5129
14771 #: ../src/guestfs-actions.pod:5129
14773 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14774 "can be mounted read-write. Set it to false if you want to test if the "
14775 "volume can be mounted read-only."
14779 #: ../fish/guestfish-actions.pod:3382
14780 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3382
14781 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5133
14782 #: ../src/guestfs-actions.pod:5133
14784 "The return value is an integer which C<0> if the operation would succeed, or "
14785 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14789 #: ../fish/guestfish-actions.pod:3386
14790 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3386
14795 #: ../fish/guestfish-actions.pod:3388
14796 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3388
14799 " ntfsresize device\n"
14804 #: ../fish/guestfish-actions.pod:3390 ../fish/guestfish-actions.pod:3414
14805 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3390
14806 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3414
14807 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5147
14808 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5186
14809 #: ../src/guestfs-actions.pod:5147 ../src/guestfs-actions.pod:5186
14811 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14812 "size of the underlying device."
14816 #: ../fish/guestfish-actions.pod:3393
14817 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3393
14818 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5150
14819 #: ../src/guestfs-actions.pod:5150
14821 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
14822 "consistency check (for safety). You have to boot into Windows to perform "
14823 "this check and clear this condition. Furthermore, ntfsresize refuses to "
14824 "resize filesystems which have been marked in this way. So in effect it is "
14825 "not possible to call ntfsresize multiple times on a single filesystem "
14826 "without booting into Windows between each resize."
14830 #: ../fish/guestfish-actions.pod:3401 ../fish/guestfish-actions.pod:3440
14831 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3401
14832 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3440
14833 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5158
14834 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5212
14835 #: ../src/guestfs-actions.pod:5158 ../src/guestfs-actions.pod:5212
14836 msgid "See also L<ntfsresize(8)>."
14840 #: ../fish/guestfish-actions.pod:3403 ../fish/guestfish-actions.pod:3451
14841 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3403
14842 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3451
14843 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5162
14844 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5252
14845 #: ../src/guestfs-actions.pod:5162 ../src/guestfs-actions.pod:5252
14847 "This function is deprecated. In new code, use the C<ntfsresize_opts> call "
14852 #: ../fish/guestfish-actions.pod:3410
14853 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3410
14854 msgid "ntfsresize-opts"
14858 #: ../fish/guestfish-actions.pod:3412
14859 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3412
14862 " ntfsresize-opts device [size:..] [force:..]\n"
14867 #: ../fish/guestfish-actions.pod:3423
14868 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3423
14869 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5195
14870 #: ../src/guestfs-actions.pod:5195
14872 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
14873 "resized to fit the container (eg. partition)."
14877 #: ../fish/guestfish-actions.pod:3426
14878 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3426
14879 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5198
14880 #: ../src/guestfs-actions.pod:5198
14885 #: ../fish/guestfish-actions.pod:3428
14886 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3428
14887 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5200
14888 #: ../src/guestfs-actions.pod:5200
14890 "If this option is true, then force the resize of the filesystem even if the "
14891 "filesystem is marked as requiring a consistency check."
14895 #: ../fish/guestfish-actions.pod:3431
14896 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3431
14898 "After the resize operation, the filesystem is always marked as requiring a "
14899 "consistency check (for safety). You have to boot into Windows to perform "
14900 "this check and clear this condition. If you I<don't> set the C<force> "
14901 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
14902 "a single filesystem without booting into Windows between each resize."
14906 #: ../fish/guestfish-actions.pod:3444
14907 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3444
14908 msgid "ntfsresize-size"
14912 #: ../fish/guestfish-actions.pod:3446
14913 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3446
14916 " ntfsresize-size device size\n"
14921 #: ../fish/guestfish-actions.pod:3448
14922 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3448
14924 "This command is the same as L</ntfsresize> except that it allows you to "
14925 "specify the new size (in bytes) explicitly."
14929 #: ../fish/guestfish-actions.pod:3458
14930 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3458
14935 #: ../fish/guestfish-actions.pod:3460
14936 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3460
14939 " part-add device prlogex startsect endsect\n"
14944 #: ../fish/guestfish-actions.pod:3462
14945 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3462
14947 "This command adds a partition to C<device>. If there is no partition table "
14948 "on the device, call L</part-init> first."
14952 #: ../fish/guestfish-actions.pod:3465
14953 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3465
14954 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5273
14955 #: ../src/guestfs-actions.pod:5273
14957 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14958 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14959 "C<logical>) and C<e> (or C<extended>) partition types."
14963 #: ../fish/guestfish-actions.pod:3470
14964 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3470
14965 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5278
14966 #: ../src/guestfs-actions.pod:5278
14968 "C<startsect> and C<endsect> are the start and end of the partition in "
14969 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14970 "from the end of the disk (C<-1> is the last sector)."
14974 #: ../fish/guestfish-actions.pod:3474
14975 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3474
14977 "Creating a partition which covers the whole disk is not so easy. Use L</"
14978 "part-disk> to do that."
14982 #: ../fish/guestfish-actions.pod:3477
14983 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3477
14988 #: ../fish/guestfish-actions.pod:3479
14989 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3479
14992 " part-del device partnum\n"
14997 #: ../fish/guestfish-actions.pod:3481
14998 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3481
14999 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5296
15000 #: ../src/guestfs-actions.pod:5296
15001 msgid "This command deletes the partition numbered C<partnum> on C<device>."
15005 #: ../fish/guestfish-actions.pod:3483
15006 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3483
15007 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5298
15008 #: ../src/guestfs-actions.pod:5298
15010 "Note that in the case of MBR partitioning, deleting an extended partition "
15011 "also deletes any logical partitions it contains."
15015 #: ../fish/guestfish-actions.pod:3487
15016 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3487
15021 #: ../fish/guestfish-actions.pod:3489
15022 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3489
15025 " part-disk device parttype\n"
15030 #: ../fish/guestfish-actions.pod:3491
15031 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3491
15033 "This command is simply a combination of L</part-init> followed by L</part-"
15034 "add> to create a single primary partition covering the whole disk."
15038 #: ../fish/guestfish-actions.pod:3495
15039 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3495
15041 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
15042 "possible values are described in L</part-init>."
15046 #: ../fish/guestfish-actions.pod:3501
15047 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3501
15048 msgid "part-get-bootable"
15052 #: ../fish/guestfish-actions.pod:3503
15053 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3503
15056 " part-get-bootable device partnum\n"
15061 #: ../fish/guestfish-actions.pod:3505
15062 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3505
15063 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5334
15064 #: ../src/guestfs-actions.pod:5334
15066 "This command returns true if the partition C<partnum> on C<device> has the "
15067 "bootable flag set."
15071 #: ../fish/guestfish-actions.pod:3508
15072 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3508
15073 msgid "See also L</part-set-bootable>."
15077 #: ../fish/guestfish-actions.pod:3510
15078 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3510
15079 msgid "part-get-mbr-id"
15083 #: ../fish/guestfish-actions.pod:3512
15084 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3512
15087 " part-get-mbr-id device partnum\n"
15092 #: ../fish/guestfish-actions.pod:3514
15093 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3514
15094 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5350
15095 #: ../src/guestfs-actions.pod:5350
15097 "Returns the MBR type byte (also known as the ID byte) from the numbered "
15098 "partition C<partnum>."
15102 #: ../fish/guestfish-actions.pod:3517 ../fish/guestfish-actions.pod:3661
15103 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3517
15104 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3661
15106 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
15107 "undefined results for other partition table types (see L</part-get-"
15112 #: ../fish/guestfish-actions.pod:3521
15113 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3521
15114 msgid "part-get-parttype"
15118 #: ../fish/guestfish-actions.pod:3523
15119 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3523
15122 " part-get-parttype device\n"
15127 #: ../fish/guestfish-actions.pod:3525
15128 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3525
15129 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5367
15130 #: ../src/guestfs-actions.pod:5367
15132 "This command examines the partition table on C<device> and returns the "
15133 "partition table type (format) being used."
15137 #: ../fish/guestfish-actions.pod:3528
15138 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3528
15140 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15141 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15142 "possible, although unusual. See L</part-init> for a full list."
15146 #: ../fish/guestfish-actions.pod:3533
15147 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3533
15152 #: ../fish/guestfish-actions.pod:3535
15153 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3535
15156 " part-init device parttype\n"
15161 #: ../fish/guestfish-actions.pod:3537
15162 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3537
15163 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5387
15164 #: ../src/guestfs-actions.pod:5387
15166 "This creates an empty partition table on C<device> of one of the partition "
15167 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
15168 "(for large disks)."
15172 #: ../fish/guestfish-actions.pod:3541
15173 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3541
15175 "Initially there are no partitions. Following this, you should call L</part-"
15176 "add> for each partition required."
15180 #: ../fish/guestfish-actions.pod:3544
15181 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3544
15182 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5394
15183 #: ../src/guestfs-actions.pod:5394
15184 msgid "Possible values for C<parttype> are:"
15188 #: ../fish/guestfish-actions.pod:3548
15189 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3548
15190 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5398
15191 #: ../src/guestfs-actions.pod:5398
15196 #: ../fish/guestfish-actions.pod:3550
15197 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3550
15198 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5400
15199 #: ../src/guestfs-actions.pod:5400
15204 #: ../fish/guestfish-actions.pod:3552
15205 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3552
15206 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5402
15207 #: ../src/guestfs-actions.pod:5402
15208 msgid "Intel EFI / GPT partition table."
15212 #: ../fish/guestfish-actions.pod:3554
15213 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3554
15214 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5404
15215 #: ../src/guestfs-actions.pod:5404
15217 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
15218 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
15219 "the C<mbr> format."
15223 #: ../fish/guestfish-actions.pod:3558
15224 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3558
15225 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5408
15226 #: ../src/guestfs-actions.pod:5408
15231 #: ../fish/guestfish-actions.pod:3560
15232 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3560
15233 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5410
15234 #: ../src/guestfs-actions.pod:5410
15239 #: ../fish/guestfish-actions.pod:3562
15240 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3562
15241 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5412
15242 #: ../src/guestfs-actions.pod:5412
15244 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
15245 "Windows. This partition type will B<only> work for device sizes up to 2 "
15246 "TB. For large disks we recommend using C<gpt>."
15250 #: ../fish/guestfish-actions.pod:3569
15251 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3569
15252 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5419
15253 #: ../src/guestfs-actions.pod:5419
15255 "Other partition table types that may work but are not supported include:"
15259 #: ../fish/guestfish-actions.pod:3574
15260 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3574
15261 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5424
15262 #: ../src/guestfs-actions.pod:5424
15267 #: ../fish/guestfish-actions.pod:3576
15268 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3576
15269 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5426
15270 #: ../src/guestfs-actions.pod:5426
15271 msgid "AIX disk labels."
15275 #: ../fish/guestfish-actions.pod:3578
15276 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3578
15277 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5428
15278 #: ../src/guestfs-actions.pod:5428
15283 #: ../fish/guestfish-actions.pod:3580
15284 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3580
15285 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5430
15286 #: ../src/guestfs-actions.pod:5430
15291 #: ../fish/guestfish-actions.pod:3582
15292 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3582
15293 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5432
15294 #: ../src/guestfs-actions.pod:5432
15295 msgid "Amiga \"Rigid Disk Block\" format."
15299 #: ../fish/guestfish-actions.pod:3584
15300 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3584
15301 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5434
15302 #: ../src/guestfs-actions.pod:5434
15307 #: ../fish/guestfish-actions.pod:3586
15308 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3586
15309 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5436
15310 #: ../src/guestfs-actions.pod:5436
15311 msgid "BSD disk labels."
15315 #: ../fish/guestfish-actions.pod:3588
15316 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3588
15317 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5438
15318 #: ../src/guestfs-actions.pod:5438
15323 #: ../fish/guestfish-actions.pod:3590
15324 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3590
15325 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5440
15326 #: ../src/guestfs-actions.pod:5440
15327 msgid "DASD, used on IBM mainframes."
15331 #: ../fish/guestfish-actions.pod:3592
15332 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3592
15333 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5442
15334 #: ../src/guestfs-actions.pod:5442
15339 #: ../fish/guestfish-actions.pod:3594
15340 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3594
15341 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5444
15342 #: ../src/guestfs-actions.pod:5444
15343 msgid "MIPS/SGI volumes."
15347 #: ../fish/guestfish-actions.pod:3596
15348 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3596
15349 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5446
15350 #: ../src/guestfs-actions.pod:5446
15355 #: ../fish/guestfish-actions.pod:3598
15356 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3598
15357 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5448
15358 #: ../src/guestfs-actions.pod:5448
15359 msgid "Old Mac partition format. Modern Macs use C<gpt>."
15363 #: ../fish/guestfish-actions.pod:3600
15364 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3600
15365 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5450
15366 #: ../src/guestfs-actions.pod:5450
15371 #: ../fish/guestfish-actions.pod:3602
15372 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3602
15373 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5452
15374 #: ../src/guestfs-actions.pod:5452
15375 msgid "NEC PC-98 format, common in Japan apparently."
15379 #: ../fish/guestfish-actions.pod:3604
15380 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3604
15381 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5454
15382 #: ../src/guestfs-actions.pod:5454
15387 #: ../fish/guestfish-actions.pod:3606
15388 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3606
15389 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5456
15390 #: ../src/guestfs-actions.pod:5456
15391 msgid "Sun disk labels."
15395 #: ../fish/guestfish-actions.pod:3610
15396 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3610
15401 #: ../fish/guestfish-actions.pod:3612
15402 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3612
15405 " part-list device\n"
15410 #: ../fish/guestfish-actions.pod:3614
15411 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3614
15412 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5470
15413 #: ../src/guestfs-actions.pod:5470
15415 "This command parses the partition table on C<device> and returns the list of "
15416 "partitions found."
15420 #: ../fish/guestfish-actions.pod:3617
15421 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3617
15422 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5473
15423 #: ../src/guestfs-actions.pod:5473
15424 msgid "The fields in the returned structure are:"
15428 #: ../fish/guestfish-actions.pod:3621
15429 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3621
15430 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5477
15431 #: ../src/guestfs-actions.pod:5477
15432 msgid "B<part_num>"
15436 #: ../fish/guestfish-actions.pod:3623
15437 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3623
15438 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5479
15439 #: ../src/guestfs-actions.pod:5479
15440 msgid "Partition number, counting from 1."
15444 #: ../fish/guestfish-actions.pod:3625
15445 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3625
15446 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5481
15447 #: ../src/guestfs-actions.pod:5481
15448 msgid "B<part_start>"
15452 #: ../fish/guestfish-actions.pod:3627
15453 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3627
15455 "Start of the partition I<in bytes>. To get sectors you have to divide by "
15456 "the device's sector size, see L</blockdev-getss>."
15460 #: ../fish/guestfish-actions.pod:3630
15461 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3630
15462 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5486
15463 #: ../src/guestfs-actions.pod:5486
15464 msgid "B<part_end>"
15468 #: ../fish/guestfish-actions.pod:3632
15469 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3632
15470 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5488
15471 #: ../src/guestfs-actions.pod:5488
15472 msgid "End of the partition in bytes."
15476 #: ../fish/guestfish-actions.pod:3634
15477 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3634
15478 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5490
15479 #: ../src/guestfs-actions.pod:5490
15480 msgid "B<part_size>"
15484 #: ../fish/guestfish-actions.pod:3636
15485 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3636
15486 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5492
15487 #: ../src/guestfs-actions.pod:5492
15488 msgid "Size of the partition in bytes."
15492 #: ../fish/guestfish-actions.pod:3640
15493 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3640
15494 msgid "part-set-bootable"
15498 #: ../fish/guestfish-actions.pod:3642
15499 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3642
15502 " part-set-bootable device partnum true|false\n"
15507 #: ../fish/guestfish-actions.pod:3644
15508 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3644
15509 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5510
15510 #: ../src/guestfs-actions.pod:5510
15512 "This sets the bootable flag on partition numbered C<partnum> on device "
15513 "C<device>. Note that partitions are numbered from 1."
15517 #: ../fish/guestfish-actions.pod:3647
15518 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3647
15519 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5513
15520 #: ../src/guestfs-actions.pod:5513
15522 "The bootable flag is used by some operating systems (notably Windows) to "
15523 "determine which partition to boot from. It is by no means universally "
15528 #: ../fish/guestfish-actions.pod:3651
15529 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3651
15530 msgid "part-set-mbr-id"
15534 #: ../fish/guestfish-actions.pod:3653
15535 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3653
15538 " part-set-mbr-id device partnum idbyte\n"
15543 #: ../fish/guestfish-actions.pod:3655
15544 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3655
15545 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5529
15546 #: ../src/guestfs-actions.pod:5529
15548 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
15549 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
15550 "documentation are in fact hexadecimal numbers, but usually documented "
15551 "without any leading \"0x\" which might be confusing."
15555 #: ../fish/guestfish-actions.pod:3665
15556 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3665
15557 msgid "part-set-name"
15561 #: ../fish/guestfish-actions.pod:3667
15562 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3667
15565 " part-set-name device partnum name\n"
15570 #: ../fish/guestfish-actions.pod:3669
15571 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3669
15572 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5551
15573 #: ../src/guestfs-actions.pod:5551
15575 "This sets the partition name on partition numbered C<partnum> on device "
15576 "C<device>. Note that partitions are numbered from 1."
15580 #: ../fish/guestfish-actions.pod:3672
15581 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3672
15582 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5554
15583 #: ../src/guestfs-actions.pod:5554
15585 "The partition name can only be set on certain types of partition table. "
15586 "This works on C<gpt> but not on C<mbr> partitions."
15590 #: ../fish/guestfish-actions.pod:3675
15591 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3675
15592 msgid "part-to-dev"
15596 #: ../fish/guestfish-actions.pod:3677
15597 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3677
15600 " part-to-dev partition\n"
15605 #: ../fish/guestfish-actions.pod:3679
15606 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3679
15607 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5567
15608 #: ../src/guestfs-actions.pod:5567
15610 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
15611 "partition number, returning the device name (eg. \"/dev/sdb\")."
15615 #: ../fish/guestfish-actions.pod:3683
15616 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3683
15618 "The named partition must exist, for example as a string returned from L</"
15619 "list-partitions>."
15623 #: ../fish/guestfish-actions.pod:3686
15624 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3686
15625 msgid "ping-daemon"
15629 #: ../fish/guestfish-actions.pod:3688
15630 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3688
15638 #: ../fish/guestfish-actions.pod:3690
15639 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3690
15640 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5584
15641 #: ../src/guestfs-actions.pod:5584
15643 "This is a test probe into the guestfs daemon running inside the qemu "
15644 "subprocess. Calling this function checks that the daemon responds to the "
15645 "ping message, without affecting the daemon or attached block device(s) in "
15650 #: ../fish/guestfish-actions.pod:3695
15651 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3695
15656 #: ../fish/guestfish-actions.pod:3697
15657 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3697
15660 " pread path count offset\n"
15665 #: ../fish/guestfish-actions.pod:3699
15666 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3699
15667 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5602
15668 #: ../src/guestfs-actions.pod:5602
15670 "This command lets you read part of a file. It reads C<count> bytes of the "
15671 "file, starting at C<offset>, from file C<path>."
15675 #: ../fish/guestfish-actions.pod:3702 ../fish/guestfish-actions.pod:3717
15676 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3702
15677 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3717
15678 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5605
15679 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5631
15680 #: ../src/guestfs-actions.pod:5605 ../src/guestfs-actions.pod:5631
15682 "This may read fewer bytes than requested. For further details see the "
15683 "L<pread(2)> system call."
15687 #: ../fish/guestfish-actions.pod:3705
15688 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3705
15689 msgid "See also L</pwrite>, L</pread-device>."
15693 #: ../fish/guestfish-actions.pod:3710
15694 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3710
15695 msgid "pread-device"
15699 #: ../fish/guestfish-actions.pod:3712
15700 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3712
15703 " pread-device device count offset\n"
15708 #: ../fish/guestfish-actions.pod:3714
15709 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3714
15710 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5628
15711 #: ../src/guestfs-actions.pod:5628
15713 "This command lets you read part of a file. It reads C<count> bytes of "
15714 "C<device>, starting at C<offset>."
15718 #: ../fish/guestfish-actions.pod:3720
15719 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3720
15720 msgid "See also L</pread>."
15724 #: ../fish/guestfish-actions.pod:3725
15725 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3725
15730 #: ../fish/guestfish-actions.pod:3727
15731 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3727
15734 " pvcreate device\n"
15739 #: ../fish/guestfish-actions.pod:3729
15740 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3729
15741 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5651
15742 #: ../src/guestfs-actions.pod:5651
15744 "This creates an LVM physical volume on the named C<device>, where C<device> "
15745 "should usually be a partition name such as C</dev/sda1>."
15749 #: ../fish/guestfish-actions.pod:3733
15750 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3733
15755 #: ../fish/guestfish-actions.pod:3735
15756 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3735
15759 " pvremove device\n"
15764 #: ../fish/guestfish-actions.pod:3737
15765 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3737
15766 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5665
15767 #: ../src/guestfs-actions.pod:5665
15769 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15774 #: ../fish/guestfish-actions.pod:3740
15775 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3740
15776 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5668
15777 #: ../src/guestfs-actions.pod:5668
15779 "The implementation uses the C<pvremove> command which refuses to wipe "
15780 "physical volumes that contain any volume groups, so you have to remove those "
15785 #: ../fish/guestfish-actions.pod:3744
15786 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3744
15791 #: ../fish/guestfish-actions.pod:3746
15792 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3746
15795 " pvresize device\n"
15800 #: ../fish/guestfish-actions.pod:3748
15801 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3748
15802 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5682
15803 #: ../src/guestfs-actions.pod:5682
15805 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15806 "the new size of the underlying device."
15810 #: ../fish/guestfish-actions.pod:3751
15811 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3751
15812 msgid "pvresize-size"
15816 #: ../fish/guestfish-actions.pod:3753
15817 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3753
15820 " pvresize-size device size\n"
15825 #: ../fish/guestfish-actions.pod:3755
15826 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3755
15828 "This command is the same as L</pvresize> except that it allows you to "
15829 "specify the new size (in bytes) explicitly."
15833 #: ../fish/guestfish-actions.pod:3758
15834 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3758
15839 #: ../fish/guestfish-actions.pod:3760
15840 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3760
15848 #: ../fish/guestfish-actions.pod:3762
15849 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3762
15850 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5708
15851 #: ../src/guestfs-actions.pod:5708
15853 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15858 #: ../fish/guestfish-actions.pod:3765
15859 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3765
15860 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5711
15861 #: ../src/guestfs-actions.pod:5711
15863 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15868 #: ../fish/guestfish-actions.pod:3768
15869 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3768
15870 msgid "See also L</pvs-full>."
15874 #: ../fish/guestfish-actions.pod:3770
15875 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3770
15880 #: ../fish/guestfish-actions.pod:3772
15881 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3772
15889 #: ../fish/guestfish-actions.pod:3774
15890 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3774
15891 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5727
15892 #: ../src/guestfs-actions.pod:5727
15894 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15895 "(8)> command. The \"full\" version includes all fields."
15899 #: ../fish/guestfish-actions.pod:3777
15900 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3777
15905 #: ../fish/guestfish-actions.pod:3779
15906 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3779
15914 #: ../fish/guestfish-actions.pod:3781
15915 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3781
15916 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5742
15917 #: ../src/guestfs-actions.pod:5742
15918 msgid "This command returns the UUID of the LVM PV C<device>."
15922 #: ../fish/guestfish-actions.pod:3783
15923 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3783
15928 #: ../fish/guestfish-actions.pod:3785
15929 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3785
15932 " pwrite path content offset\n"
15937 #: ../fish/guestfish-actions.pod:3787
15938 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3787
15939 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5758
15940 #: ../src/guestfs-actions.pod:5758
15942 "This command writes to part of a file. It writes the data buffer C<content> "
15943 "to the file C<path> starting at offset C<offset>."
15947 #: ../fish/guestfish-actions.pod:3790
15948 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3790
15949 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5761
15950 #: ../src/guestfs-actions.pod:5761
15952 "This command implements the L<pwrite(2)> system call, and like that system "
15953 "call it may not write the full data requested. The return value is the "
15954 "number of bytes that were actually written to the file. This could even be "
15955 "0, although short writes are unlikely for regular files in ordinary "
15960 #: ../fish/guestfish-actions.pod:3796
15961 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3796
15962 msgid "See also L</pread>, L</pwrite-device>."
15966 #: ../fish/guestfish-actions.pod:3801
15967 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3801
15968 msgid "pwrite-device"
15972 #: ../fish/guestfish-actions.pod:3803
15973 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3803
15976 " pwrite-device device content offset\n"
15981 #: ../fish/guestfish-actions.pod:3805
15982 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3805
15983 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5785
15984 #: ../src/guestfs-actions.pod:5785
15986 "This command writes to part of a device. It writes the data buffer "
15987 "C<content> to C<device> starting at offset C<offset>."
15991 #: ../fish/guestfish-actions.pod:3808
15992 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3808
15993 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5788
15994 #: ../src/guestfs-actions.pod:5788
15996 "This command implements the L<pwrite(2)> system call, and like that system "
15997 "call it may not write the full data requested (although short writes to disk "
15998 "devices and partitions are probably impossible with standard Linux kernels)."
16002 #: ../fish/guestfish-actions.pod:3813
16003 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3813
16004 msgid "See also L</pwrite>."
16008 #: ../fish/guestfish-actions.pod:3818
16009 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3818
16014 #: ../fish/guestfish-actions.pod:3820
16015 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3820
16018 " read-file path\n"
16023 #: ../fish/guestfish-actions.pod:3822
16024 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3822
16025 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5809
16026 #: ../src/guestfs-actions.pod:5809
16027 msgid "This calls returns the contents of the file C<path> as a buffer."
16031 #: ../fish/guestfish-actions.pod:3825
16032 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3825
16034 "Unlike L</cat>, this function can correctly handle files that contain "
16035 "embedded ASCII NUL characters. However unlike L</download>, this function "
16036 "is limited in the total size of file that can be handled."
16040 #: ../fish/guestfish-actions.pod:3833
16041 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3833
16046 #: ../fish/guestfish-actions.pod:3835
16047 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3835
16050 " read-lines path\n"
16055 #: ../fish/guestfish-actions.pod:3839
16056 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3839
16057 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5834
16058 #: ../src/guestfs-actions.pod:5834
16060 "The file contents are returned as a list of lines. Trailing C<LF> and "
16061 "C<CRLF> character sequences are I<not> returned."
16065 #: ../fish/guestfish-actions.pod:3842
16066 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3842
16068 "Note that this function cannot correctly handle binary files (specifically, "
16069 "files containing C<\\0> character which is treated as end of line). For "
16070 "those you need to use the L</read-file> function which has a more complex "
16075 #: ../fish/guestfish-actions.pod:3847
16076 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3847
16081 #: ../fish/guestfish-actions.pod:3849
16082 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3849
16090 #: ../fish/guestfish-actions.pod:3851
16091 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3851
16092 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5854
16093 #: ../src/guestfs-actions.pod:5854
16094 msgid "This returns the list of directory entries in directory C<dir>."
16098 #: ../fish/guestfish-actions.pod:3853
16099 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3853
16100 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5856
16101 #: ../src/guestfs-actions.pod:5856
16103 "All entries in the directory are returned, including C<.> and C<..>. The "
16104 "entries are I<not> sorted, but returned in the same order as the underlying "
16109 #: ../fish/guestfish-actions.pod:3857
16110 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3857
16111 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5860
16112 #: ../src/guestfs-actions.pod:5860
16114 "Also this call returns basic file type information about each file. The "
16115 "C<ftyp> field will contain one of the following characters:"
16119 #: ../fish/guestfish-actions.pod:3862
16120 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3862
16121 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5865
16122 #: ../src/guestfs-actions.pod:5865
16127 #: ../fish/guestfish-actions.pod:3864
16128 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3864
16129 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5867
16130 #: ../src/guestfs-actions.pod:5867
16131 msgid "Block special"
16135 #: ../fish/guestfish-actions.pod:3866
16136 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3866
16137 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5869
16138 #: ../src/guestfs-actions.pod:5869
16143 #: ../fish/guestfish-actions.pod:3868
16144 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3868
16145 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5871
16146 #: ../src/guestfs-actions.pod:5871
16147 msgid "Char special"
16151 #: ../fish/guestfish-actions.pod:3870
16152 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3870
16153 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5873
16154 #: ../src/guestfs-actions.pod:5873
16159 #: ../fish/guestfish-actions.pod:3872
16160 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3872
16161 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5875
16162 #: ../src/guestfs-actions.pod:5875
16167 #: ../fish/guestfish-actions.pod:3874
16168 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3874
16169 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5877
16170 #: ../src/guestfs-actions.pod:5877
16175 #: ../fish/guestfish-actions.pod:3876
16176 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3876
16177 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5879
16178 #: ../src/guestfs-actions.pod:5879
16179 msgid "FIFO (named pipe)"
16183 #: ../fish/guestfish-actions.pod:3878
16184 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3878
16185 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5881
16186 #: ../src/guestfs-actions.pod:5881
16191 #: ../fish/guestfish-actions.pod:3880
16192 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3880
16193 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5883
16194 #: ../src/guestfs-actions.pod:5883
16195 msgid "Symbolic link"
16199 #: ../fish/guestfish-actions.pod:3882
16200 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3882
16201 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5885
16202 #: ../src/guestfs-actions.pod:5885
16207 #: ../fish/guestfish-actions.pod:3884
16208 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3884
16209 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5887
16210 #: ../src/guestfs-actions.pod:5887
16211 msgid "Regular file"
16215 #: ../fish/guestfish-actions.pod:3886
16216 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3886
16217 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5889
16218 #: ../src/guestfs-actions.pod:5889
16223 #: ../fish/guestfish-actions.pod:3888
16224 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3888
16225 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5891
16226 #: ../src/guestfs-actions.pod:5891
16231 #: ../fish/guestfish-actions.pod:3890
16232 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3890
16233 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5893
16234 #: ../src/guestfs-actions.pod:5893
16239 #: ../fish/guestfish-actions.pod:3892
16240 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3892
16241 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5895
16242 #: ../src/guestfs-actions.pod:5895
16243 msgid "Unknown file type"
16247 #: ../fish/guestfish-actions.pod:3894
16248 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3894
16249 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5897
16250 #: ../src/guestfs-actions.pod:5897
16255 #: ../fish/guestfish-actions.pod:3896
16256 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3896
16257 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5899
16258 #: ../src/guestfs-actions.pod:5899
16260 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16264 #: ../fish/guestfish-actions.pod:3901
16265 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3901
16267 "This function is primarily intended for use by programs. To get a simple "
16268 "list of names, use L</ls>. To get a printable directory for human "
16269 "consumption, use L</ll>."
16273 #: ../fish/guestfish-actions.pod:3905
16274 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3905
16279 #: ../fish/guestfish-actions.pod:3907
16280 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3907
16288 #: ../fish/guestfish-actions.pod:3909
16289 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3909
16290 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5920
16291 #: ../src/guestfs-actions.pod:5920
16292 msgid "This command reads the target of a symbolic link."
16296 #: ../fish/guestfish-actions.pod:3911
16297 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3911
16298 msgid "readlinklist"
16302 #: ../fish/guestfish-actions.pod:3913
16303 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3913
16306 " readlinklist path 'names ...'\n"
16311 #: ../fish/guestfish-actions.pod:3915
16312 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3915
16313 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5934
16314 #: ../src/guestfs-actions.pod:5934
16316 "This call allows you to do a C<readlink> operation on multiple files, where "
16317 "all files are in the directory C<path>. C<names> is the list of files from "
16322 #: ../fish/guestfish-actions.pod:3919
16323 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3919
16324 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5938
16325 #: ../src/guestfs-actions.pod:5938
16327 "On return you get a list of strings, with a one-to-one correspondence to the "
16328 "C<names> list. Each string is the value of the symbolic link."
16332 #: ../fish/guestfish-actions.pod:3923
16333 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3923
16334 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5942
16335 #: ../src/guestfs-actions.pod:5942
16337 "If the C<readlink(2)> operation fails on any name, then the corresponding "
16338 "result string is the empty string C<\"\">. However the whole operation is "
16339 "completed even if there were C<readlink(2)> errors, and so you can call this "
16340 "function with names where you don't know if they are symbolic links already "
16341 "(albeit slightly less efficient)."
16345 #: ../fish/guestfish-actions.pod:3930
16346 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3930
16347 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5949
16348 #: ../src/guestfs-actions.pod:5949
16350 "This call is intended for programs that want to efficiently list a directory "
16351 "contents without making many round-trips. Very long directory listings "
16352 "might cause the protocol message size to be exceeded, causing this call to "
16353 "fail. The caller must split up such requests into smaller groups of names."
16357 #: ../fish/guestfish-actions.pod:3937
16358 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3937
16363 #: ../fish/guestfish-actions.pod:3939
16364 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3939
16372 #: ../fish/guestfish-actions.pod:3941
16373 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3941
16374 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5968
16375 #: ../src/guestfs-actions.pod:5968
16377 "Return the canonicalized absolute pathname of C<path>. The returned path "
16378 "has no C<.>, C<..> or symbolic link path elements."
16382 #: ../fish/guestfish-actions.pod:3944
16383 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3944
16384 msgid "removexattr"
16388 #: ../fish/guestfish-actions.pod:3946
16389 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3946
16392 " removexattr xattr path\n"
16397 #: ../fish/guestfish-actions.pod:3948
16398 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3948
16399 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5983
16400 #: ../src/guestfs-actions.pod:5983
16402 "This call removes the extended attribute named C<xattr> of the file C<path>."
16406 #: ../fish/guestfish-actions.pod:3951
16407 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3951
16408 msgid "See also: L</lremovexattr>, L<attr(5)>."
16412 #: ../fish/guestfish-actions.pod:3953
16413 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3953
16418 #: ../fish/guestfish-actions.pod:3955
16419 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3955
16422 " resize2fs device\n"
16427 #: ../fish/guestfish-actions.pod:3957
16428 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3957
16429 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5998
16430 #: ../src/guestfs-actions.pod:5998
16432 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
16433 "underlying device."
16437 #: ../fish/guestfish-actions.pod:3960
16438 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3960
16440 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
16441 "before calling this command. For unknown reasons C<resize2fs> sometimes "
16442 "gives an error about this and sometimes not. In any case, it is always safe "
16443 "to call L</e2fsck-f> before calling this function."
16447 #: ../fish/guestfish-actions.pod:3966
16448 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3966
16449 msgid "resize2fs-M"
16453 #: ../fish/guestfish-actions.pod:3968
16454 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3968
16457 " resize2fs-M device\n"
16462 #: ../fish/guestfish-actions.pod:3970
16463 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3970
16465 "This command is the same as L</resize2fs>, but the filesystem is resized to "
16466 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
16471 #: ../fish/guestfish-actions.pod:3974
16472 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3974
16474 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
16475 "and read the C<Block size> and C<Block count> values. These two numbers, "
16476 "multiplied together, give the resulting size of the minimal filesystem in "
16481 #: ../fish/guestfish-actions.pod:3979
16482 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3979
16483 msgid "resize2fs-size"
16487 #: ../fish/guestfish-actions.pod:3981
16488 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3981
16491 " resize2fs-size device size\n"
16496 #: ../fish/guestfish-actions.pod:3983
16497 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3983
16499 "This command is the same as L</resize2fs> except that it allows you to "
16500 "specify the new size (in bytes) explicitly."
16504 #: ../fish/guestfish-actions.pod:3986
16505 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3986
16510 #: ../fish/guestfish-actions.pod:3988
16511 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3988
16519 #: ../fish/guestfish-actions.pod:3990
16520 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3990
16521 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6050
16522 #: ../src/guestfs-actions.pod:6050
16523 msgid "Remove the single file C<path>."
16527 #: ../fish/guestfish-actions.pod:3992
16528 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3992
16533 #: ../fish/guestfish-actions.pod:3994
16534 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3994
16542 #: ../fish/guestfish-actions.pod:3996
16543 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:3996
16544 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6062
16545 #: ../src/guestfs-actions.pod:6062
16547 "Remove the file or directory C<path>, recursively removing the contents if "
16548 "its a directory. This is like the C<rm -rf> shell command."
16552 #: ../fish/guestfish-actions.pod:4000
16553 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4000
16558 #: ../fish/guestfish-actions.pod:4002
16559 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4002
16567 #: ../fish/guestfish-actions.pod:4004
16568 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4004
16569 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6076
16570 #: ../src/guestfs-actions.pod:6076
16571 msgid "Remove the single directory C<path>."
16575 #: ../fish/guestfish-actions.pod:4006
16576 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4006
16577 msgid "rmmountpoint"
16581 #: ../fish/guestfish-actions.pod:4008
16582 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4008
16585 " rmmountpoint exemptpath\n"
16590 #: ../fish/guestfish-actions.pod:4010
16591 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4010
16593 "This calls removes a mountpoint that was previously created with L</"
16594 "mkmountpoint>. See L</mkmountpoint> for full details."
16598 #: ../fish/guestfish-actions.pod:4014
16599 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4014
16600 msgid "scrub-device"
16604 #: ../fish/guestfish-actions.pod:4016
16605 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4016
16608 " scrub-device device\n"
16613 #: ../fish/guestfish-actions.pod:4018
16614 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4018
16615 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6102
16616 #: ../src/guestfs-actions.pod:6102
16618 "This command writes patterns over C<device> to make data retrieval more "
16623 #: ../fish/guestfish-actions.pod:4021 ../fish/guestfish-actions.pod:4036
16624 #: ../fish/guestfish-actions.pod:4049
16625 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4021
16626 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4036
16627 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4049
16628 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6105
16629 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6126
16630 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6145
16631 #: ../src/guestfs-actions.pod:6105 ../src/guestfs-actions.pod:6126
16632 #: ../src/guestfs-actions.pod:6145
16634 "It is an interface to the L<scrub(1)> program. See that manual page for "
16639 #: ../fish/guestfish-actions.pod:4027
16640 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4027
16645 #: ../fish/guestfish-actions.pod:4029
16646 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4029
16649 " scrub-file file\n"
16654 #: ../fish/guestfish-actions.pod:4031
16655 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4031
16656 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6121
16657 #: ../src/guestfs-actions.pod:6121
16659 "This command writes patterns over a file to make data retrieval more "
16664 #: ../fish/guestfish-actions.pod:4034
16665 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4034
16666 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6124
16667 #: ../src/guestfs-actions.pod:6124
16668 msgid "The file is I<removed> after scrubbing."
16672 #: ../fish/guestfish-actions.pod:4039
16673 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4039
16674 msgid "scrub-freespace"
16678 #: ../fish/guestfish-actions.pod:4041
16679 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4041
16682 " scrub-freespace dir\n"
16687 #: ../fish/guestfish-actions.pod:4043
16688 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4043
16690 "This command creates the directory C<dir> and then fills it with files until "
16691 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
16692 "deletes them. The intention is to scrub any free space on the partition "
16693 "containing C<dir>."
16697 #: ../fish/guestfish-actions.pod:4052
16698 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4052
16703 #: ../fish/guestfish-actions.pod:4054
16704 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4054
16709 #: ../fish/guestfish-actions.pod:4056
16710 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4056
16713 " set-append append\n"
16718 #: ../fish/guestfish-actions.pod:4058
16719 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4058
16720 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6158
16721 #: ../src/guestfs-actions.pod:6158
16723 "This function is used to add additional options to the guest kernel command "
16728 #: ../fish/guestfish-actions.pod:4061
16729 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4061
16730 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6161
16731 #: ../src/guestfs-actions.pod:6161
16733 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
16734 "environment variable."
16738 #: ../fish/guestfish-actions.pod:4064
16739 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4064
16740 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6164
16741 #: ../src/guestfs-actions.pod:6164
16743 "Setting C<append> to C<NULL> means I<no> additional options are passed "
16744 "(libguestfs always adds a few of its own)."
16748 #: ../fish/guestfish-actions.pod:4067
16749 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4067
16750 msgid "set-attach-method"
16754 #: ../fish/guestfish-actions.pod:4069
16755 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4069
16756 msgid "attach-method"
16760 #: ../fish/guestfish-actions.pod:4071
16761 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4071
16764 " set-attach-method attachmethod\n"
16769 #: ../fish/guestfish-actions.pod:4073
16770 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4073
16771 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6177
16772 #: ../src/guestfs-actions.pod:6177
16774 "Set the method that libguestfs uses to connect to the back end guestfsd "
16775 "daemon. Possible methods are:"
16779 #: ../fish/guestfish-actions.pod:4078
16780 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4078
16781 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6182
16782 #: ../libguestfs-1.11.19/src/guestfs.pod:2687 ../src/guestfs-actions.pod:6182
16783 #: ../src/guestfs.pod:2687
16784 msgid "C<appliance>"
16788 #: ../fish/guestfish-actions.pod:4080
16789 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4080
16790 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6184
16791 #: ../src/guestfs-actions.pod:6184
16793 "Launch an appliance and connect to it. This is the ordinary method and the "
16798 #: ../fish/guestfish-actions.pod:4083
16799 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4083
16800 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6187
16801 #: ../src/guestfs-actions.pod:6187
16802 msgid "C<unix:I<path>>"
16806 #: ../fish/guestfish-actions.pod:4085
16807 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4085
16808 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6189
16809 #: ../src/guestfs-actions.pod:6189
16810 msgid "Connect to the Unix domain socket I<path>."
16814 #: ../fish/guestfish-actions.pod:4087
16815 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4087
16816 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6191
16817 #: ../src/guestfs-actions.pod:6191
16819 "This method lets you connect to an existing daemon or (using virtio-serial) "
16820 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
16821 "RUNNING DAEMONS>."
16825 #: ../fish/guestfish-actions.pod:4093
16826 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4093
16827 msgid "set-autosync"
16831 #: ../fish/guestfish-actions.pod:4095
16832 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4095
16837 #: ../fish/guestfish-actions.pod:4097
16838 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4097
16841 " set-autosync true|false\n"
16846 #: ../fish/guestfish-actions.pod:4099
16847 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4099
16848 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6207
16849 #: ../src/guestfs-actions.pod:6207
16851 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
16852 "effort attempt to make filesystems consistent and synchronized when the "
16853 "handle is closed (also if the program exits without closing handles)."
16857 #: ../fish/guestfish-actions.pod:4104
16858 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4104
16859 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6212
16860 #: ../src/guestfs-actions.pod:6212
16862 "This is enabled by default (since libguestfs 1.5.24, previously it was "
16863 "disabled by default)."
16867 #: ../fish/guestfish-actions.pod:4107
16868 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4107
16873 #: ../fish/guestfish-actions.pod:4109
16874 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4109
16879 #: ../fish/guestfish-actions.pod:4111
16880 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4111
16883 " set-direct true|false\n"
16888 #: ../fish/guestfish-actions.pod:4113
16889 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4113
16890 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6225
16891 #: ../src/guestfs-actions.pod:6225
16893 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16894 "passed directly through to the appliance once it is launched."
16898 #: ../fish/guestfish-actions.pod:4117
16899 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4117
16901 "One consequence of this is that log messages aren't caught by the library "
16902 "and handled by L</set-log-message-callback>, but go straight to stdout."
16906 #: ../fish/guestfish-actions.pod:4121
16907 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4121
16908 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6233
16909 #: ../src/guestfs-actions.pod:6233
16910 msgid "You probably don't want to use this unless you know what you are doing."
16914 #: ../fish/guestfish-actions.pod:4124
16915 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4124
16916 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6236
16917 #: ../src/guestfs-actions.pod:6236
16918 msgid "The default is disabled."
16922 #: ../fish/guestfish-actions.pod:4126
16923 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4126
16924 msgid "set-e2label"
16928 #: ../fish/guestfish-actions.pod:4128
16929 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4128
16932 " set-e2label device label\n"
16937 #: ../fish/guestfish-actions.pod:4130
16938 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4130
16939 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6249
16940 #: ../src/guestfs-actions.pod:6249
16942 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16943 "C<label>. Filesystem labels are limited to 16 characters."
16947 #: ../fish/guestfish-actions.pod:4134
16948 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4134
16950 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
16951 "label on a filesystem."
16955 #: ../fish/guestfish-actions.pod:4137
16956 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4137
16961 #: ../fish/guestfish-actions.pod:4139
16962 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4139
16965 " set-e2uuid device uuid\n"
16970 #: ../fish/guestfish-actions.pod:4141
16971 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4141
16972 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6267
16973 #: ../src/guestfs-actions.pod:6267
16975 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16976 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
16977 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
16981 #: ../fish/guestfish-actions.pod:4146
16982 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4146
16984 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
16985 "UUID of a filesystem."
16989 #: ../fish/guestfish-actions.pod:4149
16990 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4149
16991 msgid "set-memsize"
16995 #: ../fish/guestfish-actions.pod:4151
16996 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4151
17001 #: ../fish/guestfish-actions.pod:4153
17002 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4153
17005 " set-memsize memsize\n"
17010 #: ../fish/guestfish-actions.pod:4155
17011 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4155
17013 "This sets the memory size in megabytes allocated to the qemu subprocess. "
17014 "This only has any effect if called before L</launch>."
17018 #: ../fish/guestfish-actions.pod:4159
17019 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4159
17020 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6289
17021 #: ../src/guestfs-actions.pod:6289
17023 "You can also change this by setting the environment variable "
17024 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
17028 #: ../fish/guestfish-actions.pod:4166
17029 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4166
17030 msgid "set-network"
17034 #: ../fish/guestfish-actions.pod:4168
17035 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4168
17040 #: ../fish/guestfish-actions.pod:4170
17041 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4170
17044 " set-network true|false\n"
17049 #: ../fish/guestfish-actions.pod:4172
17050 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4172
17051 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6306
17052 #: ../src/guestfs-actions.pod:6306
17054 "If C<network> is true, then the network is enabled in the libguestfs "
17055 "appliance. The default is false."
17059 #: ../fish/guestfish-actions.pod:4175
17060 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4175
17061 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6309
17062 #: ../src/guestfs-actions.pod:6309
17064 "This affects whether commands are able to access the network (see L<guestfs"
17065 "(3)/RUNNING COMMANDS>)."
17069 #: ../fish/guestfish-actions.pod:4178
17070 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4178
17072 "You must call this before calling L</launch>, otherwise it has no effect."
17076 #: ../fish/guestfish-actions.pod:4181
17077 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4181
17082 #: ../fish/guestfish-actions.pod:4185
17083 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4185
17086 " set-path searchpath\n"
17091 #: ../fish/guestfish-actions.pod:4187
17092 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4187
17093 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6325
17094 #: ../src/guestfs-actions.pod:6325
17095 msgid "Set the path that libguestfs searches for kernel and initrd.img."
17099 #: ../fish/guestfish-actions.pod:4189
17100 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4189
17101 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6327
17102 #: ../src/guestfs-actions.pod:6327
17104 "The default is C<$libdir/guestfs> unless overridden by setting "
17105 "C<LIBGUESTFS_PATH> environment variable."
17109 #: ../fish/guestfish-actions.pod:4192
17110 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4192
17111 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6330
17112 #: ../src/guestfs-actions.pod:6330
17113 msgid "Setting C<path> to C<NULL> restores the default path."
17117 #: ../fish/guestfish-actions.pod:4194
17118 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4194
17123 #: ../fish/guestfish-actions.pod:4196
17124 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4196
17129 #: ../fish/guestfish-actions.pod:4198
17130 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4198
17133 " set-pgroup true|false\n"
17138 #: ../fish/guestfish-actions.pod:4200
17139 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4200
17140 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6342
17141 #: ../src/guestfs-actions.pod:6342
17143 "If C<pgroup> is true, child processes are placed into their own process "
17148 #: ../fish/guestfish-actions.pod:4203
17149 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4203
17150 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6345
17151 #: ../src/guestfs-actions.pod:6345
17153 "The practical upshot of this is that signals like C<SIGINT> (from users "
17154 "pressing C<^C>) won't be received by the child process."
17158 #: ../fish/guestfish-actions.pod:4206
17159 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4206
17160 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6348
17161 #: ../src/guestfs-actions.pod:6348
17163 "The default for this flag is false, because usually you want C<^C> to kill "
17168 #: ../fish/guestfish-actions.pod:4209
17169 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4209
17174 #: ../fish/guestfish-actions.pod:4211
17175 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4211
17180 #: ../fish/guestfish-actions.pod:4213
17181 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4213
17189 #: ../fish/guestfish-actions.pod:4215
17190 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4215
17191 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6361
17192 #: ../src/guestfs-actions.pod:6361
17193 msgid "Set the qemu binary that we will use."
17197 #: ../fish/guestfish-actions.pod:4217
17198 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4217
17199 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6363
17200 #: ../src/guestfs-actions.pod:6363
17202 "The default is chosen when the library was compiled by the configure script."
17206 #: ../fish/guestfish-actions.pod:4220
17207 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4220
17208 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6366
17209 #: ../src/guestfs-actions.pod:6366
17211 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
17216 #: ../fish/guestfish-actions.pod:4223
17217 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4223
17218 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6369
17219 #: ../src/guestfs-actions.pod:6369
17220 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
17224 #: ../fish/guestfish-actions.pod:4225
17225 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4225
17226 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6371
17227 #: ../src/guestfs-actions.pod:6371
17229 "Note that you should call this function as early as possible after creating "
17230 "the handle. This is because some pre-launch operations depend on testing "
17231 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
17232 "don't retest features, and so you might see inconsistent results. Using the "
17233 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
17234 "the qemu binary at the same time as the handle is created."
17238 #: ../fish/guestfish-actions.pod:4233
17239 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4233
17240 msgid "set-recovery-proc"
17244 #: ../fish/guestfish-actions.pod:4235
17245 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4235
17246 msgid "recovery-proc"
17250 #: ../fish/guestfish-actions.pod:4237
17251 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4237
17254 " set-recovery-proc true|false\n"
17259 #: ../fish/guestfish-actions.pod:4239
17260 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4239
17262 "If this is called with the parameter C<false> then L</launch> does not "
17263 "create a recovery process. The purpose of the recovery process is to stop "
17264 "runaway qemu processes in the case where the main program aborts abruptly."
17268 #: ../fish/guestfish-actions.pod:4244
17269 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4244
17271 "This only has any effect if called before L</launch>, and the default is "
17276 #: ../fish/guestfish-actions.pod:4247
17277 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4247
17278 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6397
17279 #: ../src/guestfs-actions.pod:6397
17281 "About the only time when you would want to disable this is if the main "
17282 "process will fork itself into the background (\"daemonize\" itself). In "
17283 "this case the recovery process thinks that the main program has disappeared "
17284 "and so kills qemu, which is not very helpful."
17288 #: ../fish/guestfish-actions.pod:4253
17289 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4253
17290 msgid "set-selinux"
17294 #: ../fish/guestfish-actions.pod:4255
17295 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4255
17300 #: ../fish/guestfish-actions.pod:4257
17301 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4257
17304 " set-selinux true|false\n"
17309 #: ../fish/guestfish-actions.pod:4259
17310 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4259
17311 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6413
17312 #: ../src/guestfs-actions.pod:6413
17314 "This sets the selinux flag that is passed to the appliance at boot time. "
17315 "The default is C<selinux=0> (disabled)."
17319 #: ../fish/guestfish-actions.pod:4262
17320 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4262
17321 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6416
17322 #: ../src/guestfs-actions.pod:6416
17324 "Note that if SELinux is enabled, it is always in Permissive mode "
17325 "(C<enforcing=0>)."
17329 #: ../fish/guestfish-actions.pod:4268
17330 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4268
17335 #: ../fish/guestfish-actions.pod:4270
17336 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4270
17341 #: ../fish/guestfish-actions.pod:4272
17342 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4272
17345 " set-trace true|false\n"
17350 #: ../fish/guestfish-actions.pod:4274
17351 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4274
17352 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6432
17353 #: ../src/guestfs-actions.pod:6432
17355 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
17356 "return values are traced."
17360 #: ../fish/guestfish-actions.pod:4277
17361 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4277
17362 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6435
17363 #: ../src/guestfs-actions.pod:6435
17365 "If you want to trace C API calls into libguestfs (and other libraries) then "
17366 "possibly a better way is to use the external ltrace(1) command."
17370 #: ../fish/guestfish-actions.pod:4281
17371 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4281
17372 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6439
17373 #: ../src/guestfs-actions.pod:6439
17375 "Command traces are disabled unless the environment variable "
17376 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
17380 #: ../fish/guestfish-actions.pod:4284
17381 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4284
17383 "Trace messages are normally sent to C<stderr>, unless you register a "
17384 "callback to send them somewhere else (see L</set-event-callback>)."
17388 #: ../fish/guestfish-actions.pod:4288
17389 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4288
17390 msgid "set-verbose"
17394 #: ../fish/guestfish-actions.pod:4290
17395 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4290
17400 #: ../fish/guestfish-actions.pod:4292
17401 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4292
17404 " set-verbose true|false\n"
17409 #: ../fish/guestfish-actions.pod:4294
17410 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4294
17411 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6456
17412 #: ../src/guestfs-actions.pod:6456
17413 msgid "If C<verbose> is true, this turns on verbose messages."
17417 #: ../fish/guestfish-actions.pod:4296
17418 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4296
17419 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6458
17420 #: ../src/guestfs-actions.pod:6458
17422 "Verbose messages are disabled unless the environment variable "
17423 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
17427 #: ../fish/guestfish-actions.pod:4299
17428 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4299
17430 "Verbose messages are normally sent to C<stderr>, unless you register a "
17431 "callback to send them somewhere else (see L</set-event-callback>)."
17435 #: ../fish/guestfish-actions.pod:4303
17436 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4303
17441 #: ../fish/guestfish-actions.pod:4305
17442 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4305
17445 " setcon context\n"
17450 #: ../fish/guestfish-actions.pod:4307
17451 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4307
17452 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6475
17453 #: ../src/guestfs-actions.pod:6475
17455 "This sets the SELinux security context of the daemon to the string "
17460 #: ../fish/guestfish-actions.pod:4310
17461 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4310
17462 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6478
17463 #: ../src/guestfs-actions.pod:6478
17464 msgid "See the documentation about SELINUX in L<guestfs(3)>."
17468 #: ../fish/guestfish-actions.pod:4312
17469 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4312
17474 #: ../fish/guestfish-actions.pod:4314
17475 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4314
17478 " setxattr xattr val vallen path\n"
17483 #: ../fish/guestfish-actions.pod:4316
17484 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4316
17485 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6493
17486 #: ../src/guestfs-actions.pod:6493
17488 "This call sets the extended attribute named C<xattr> of the file C<path> to "
17489 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
17493 #: ../fish/guestfish-actions.pod:4320
17494 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4320
17495 msgid "See also: L</lsetxattr>, L<attr(5)>."
17499 #: ../fish/guestfish-actions.pod:4322
17500 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4322
17505 #: ../fish/guestfish-actions.pod:4324
17506 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4324
17509 " sfdisk device cyls heads sectors 'lines ...'\n"
17514 #: ../fish/guestfish-actions.pod:4326
17515 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4326
17516 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6513
17517 #: ../src/guestfs-actions.pod:6513
17519 "This is a direct interface to the L<sfdisk(8)> program for creating "
17520 "partitions on block devices."
17524 #: ../fish/guestfish-actions.pod:4329
17525 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4329
17526 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6516
17527 #: ../src/guestfs-actions.pod:6516
17528 msgid "C<device> should be a block device, for example C</dev/sda>."
17532 #: ../fish/guestfish-actions.pod:4331
17533 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4331
17534 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6518
17535 #: ../src/guestfs-actions.pod:6518
17537 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
17538 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
17539 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
17540 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
17541 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
17542 "the kernel) cannot work out the right geometry and you will need to tell it."
17546 #: ../fish/guestfish-actions.pod:4339
17547 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4339
17548 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6526
17549 #: ../src/guestfs-actions.pod:6526
17551 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
17552 "refer to the L<sfdisk(8)> manpage."
17556 #: ../fish/guestfish-actions.pod:4342
17557 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4342
17558 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6529
17559 #: ../src/guestfs-actions.pod:6529
17561 "To create a single partition occupying the whole disk, you would pass "
17562 "C<lines> as a single element list, when the single element being the string "
17567 #: ../fish/guestfish-actions.pod:4346
17568 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4346
17569 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
17573 #: ../fish/guestfish-actions.pod:4352 ../fish/guestfish-actions.pod:4375
17574 #: ../fish/guestfish-actions.pod:4397
17575 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4352
17576 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4375
17577 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4397
17578 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6541
17579 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6571
17580 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6604
17581 #: ../src/guestfs-actions.pod:6541 ../src/guestfs-actions.pod:6571
17582 #: ../src/guestfs-actions.pod:6604
17584 "This function is deprecated. In new code, use the C<part_add> call instead."
17588 #: ../fish/guestfish-actions.pod:4359
17589 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4359
17594 #: ../fish/guestfish-actions.pod:4361
17595 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4361
17598 " sfdiskM device 'lines ...'\n"
17603 #: ../fish/guestfish-actions.pod:4363
17604 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4363
17606 "This is a simplified interface to the L</sfdisk> command, where partition "
17607 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
17608 "you don't need to specify the cyls, heads and sectors parameters which were "
17609 "rarely if ever used anyway."
17613 #: ../fish/guestfish-actions.pod:4369
17614 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4369
17615 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
17619 #: ../fish/guestfish-actions.pod:4382
17620 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4382
17625 #: ../fish/guestfish-actions.pod:4384
17626 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4384
17629 " sfdisk-N device partnum cyls heads sectors line\n"
17634 #: ../fish/guestfish-actions.pod:4386
17635 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4386
17636 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6591
17637 #: ../src/guestfs-actions.pod:6591
17639 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
17640 "(note: C<n> counts from 1)."
17644 #: ../fish/guestfish-actions.pod:4389
17645 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4389
17647 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
17648 "cyls/heads/sectors parameters."
17652 #: ../fish/guestfish-actions.pod:4392
17653 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4392
17654 msgid "See also: L</part-add>"
17658 #: ../fish/guestfish-actions.pod:4404
17659 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4404
17660 msgid "sfdisk-disk-geometry"
17664 #: ../fish/guestfish-actions.pod:4406
17665 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4406
17668 " sfdisk-disk-geometry device\n"
17673 #: ../fish/guestfish-actions.pod:4408
17674 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4408
17676 "This displays the disk geometry of C<device> read from the partition table. "
17677 "Especially in the case where the underlying block device has been resized, "
17678 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
17679 "kernel-geometry>)."
17683 #: ../fish/guestfish-actions.pod:4413 ../fish/guestfish-actions.pod:4422
17684 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4413
17685 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4422
17686 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6624
17687 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6640
17688 #: ../src/guestfs-actions.pod:6624 ../src/guestfs-actions.pod:6640
17689 msgid "The result is in human-readable format, and not designed to be parsed."
17693 #: ../fish/guestfish-actions.pod:4416
17694 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4416
17695 msgid "sfdisk-kernel-geometry"
17699 #: ../fish/guestfish-actions.pod:4418
17700 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4418
17703 " sfdisk-kernel-geometry device\n"
17708 #: ../fish/guestfish-actions.pod:4420
17709 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4420
17710 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6638
17711 #: ../src/guestfs-actions.pod:6638
17712 msgid "This displays the kernel's idea of the geometry of C<device>."
17716 #: ../fish/guestfish-actions.pod:4425
17717 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4425
17722 #: ../fish/guestfish-actions.pod:4427
17723 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4427
17726 " sfdisk-l device\n"
17731 #: ../fish/guestfish-actions.pod:4429
17732 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4429
17733 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6654
17734 #: ../src/guestfs-actions.pod:6654
17736 "This displays the partition table on C<device>, in the human-readable output "
17737 "of the L<sfdisk(8)> command. It is not intended to be parsed."
17741 #: ../fish/guestfish-actions.pod:4433
17742 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4433
17743 msgid "See also: L</part-list>"
17747 #: ../fish/guestfish-actions.pod:4435
17748 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4435
17749 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6663
17750 #: ../src/guestfs-actions.pod:6663
17752 "This function is deprecated. In new code, use the C<part_list> call instead."
17756 #: ../fish/guestfish-actions.pod:4442
17757 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4442
17762 #: ../fish/guestfish-actions.pod:4444
17763 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4444
17771 #: ../fish/guestfish-actions.pod:4446
17772 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4446
17773 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6678
17774 #: ../src/guestfs-actions.pod:6678
17776 "This call runs a command from the guest filesystem via the guest's C</bin/"
17781 #: ../fish/guestfish-actions.pod:4449
17782 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4449
17783 msgid "This is like L</command>, but passes the command to:"
17787 #: ../fish/guestfish-actions.pod:4451
17788 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4451
17789 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6683
17790 #: ../src/guestfs-actions.pod:6683
17793 " /bin/sh -c \"command\"\n"
17798 #: ../fish/guestfish-actions.pod:4453
17799 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4453
17800 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6685
17801 #: ../src/guestfs-actions.pod:6685
17803 "Depending on the guest's shell, this usually results in wildcards being "
17804 "expanded, shell expressions being interpolated and so on."
17808 #: ../fish/guestfish-actions.pod:4457
17809 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4457
17810 msgid "All the provisos about L</command> apply to this call."
17814 #: ../fish/guestfish-actions.pod:4459
17815 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4459
17820 #: ../fish/guestfish-actions.pod:4461
17821 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4461
17824 " sh-lines command\n"
17829 #: ../fish/guestfish-actions.pod:4463
17830 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4463
17831 msgid "This is the same as L</sh>, but splits the result into a list of lines."
17835 #: ../fish/guestfish-actions.pod:4466
17836 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4466
17837 msgid "See also: L</command-lines>"
17841 #: ../fish/guestfish-actions.pod:4468
17842 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4468
17847 #: ../fish/guestfish-actions.pod:4470
17848 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4470
17856 #: ../fish/guestfish-actions.pod:4472
17857 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4472
17858 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6719
17859 #: ../src/guestfs-actions.pod:6719
17860 msgid "Sleep for C<secs> seconds."
17864 #: ../fish/guestfish-actions.pod:4474
17865 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4474
17870 #: ../fish/guestfish-actions.pod:4476
17871 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4476
17879 #: ../fish/guestfish-actions.pod:4480
17880 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4480
17881 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6733
17882 #: ../src/guestfs-actions.pod:6733
17883 msgid "This is the same as the C<stat(2)> system call."
17887 #: ../fish/guestfish-actions.pod:4482
17888 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4482
17893 #: ../fish/guestfish-actions.pod:4484
17894 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4484
17902 #: ../fish/guestfish-actions.pod:4486
17903 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4486
17904 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6747
17905 #: ../src/guestfs-actions.pod:6747
17907 "Returns file system statistics for any mounted file system. C<path> should "
17908 "be a file or directory in the mounted file system (typically it is the mount "
17909 "point itself, but it doesn't need to be)."
17913 #: ../fish/guestfish-actions.pod:4490
17914 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4490
17915 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6751
17916 #: ../src/guestfs-actions.pod:6751
17917 msgid "This is the same as the C<statvfs(2)> system call."
17921 #: ../fish/guestfish-actions.pod:4492
17922 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4492
17927 #: ../fish/guestfish-actions.pod:4494
17928 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4494
17936 #: ../fish/guestfish-actions.pod:4496
17937 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4496
17938 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6765
17939 #: ../src/guestfs-actions.pod:6765
17941 "This runs the L<strings(1)> command on a file and returns the list of "
17942 "printable strings found."
17946 #: ../fish/guestfish-actions.pod:4502
17947 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4502
17952 #: ../fish/guestfish-actions.pod:4504
17953 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4504
17956 " strings-e encoding path\n"
17961 #: ../fish/guestfish-actions.pod:4506
17962 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4506
17964 "This is like the L</strings> command, but allows you to specify the encoding "
17965 "of strings that are looked for in the source file C<path>."
17969 #: ../fish/guestfish-actions.pod:4510
17970 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4510
17971 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6788
17972 #: ../src/guestfs-actions.pod:6788
17973 msgid "Allowed encodings are:"
17977 #: ../fish/guestfish-actions.pod:4514
17978 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4514
17979 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6792
17980 #: ../src/guestfs-actions.pod:6792
17985 #: ../fish/guestfish-actions.pod:4516
17986 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4516
17988 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
17989 "ISO-8859-X (this is what L</strings> uses)."
17993 #: ../fish/guestfish-actions.pod:4519
17994 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4519
17995 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6797
17996 #: ../src/guestfs-actions.pod:6797
18001 #: ../fish/guestfish-actions.pod:4521
18002 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4521
18003 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6799
18004 #: ../src/guestfs-actions.pod:6799
18005 msgid "Single 8-bit-byte characters."
18009 #: ../fish/guestfish-actions.pod:4523
18010 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4523
18011 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6801
18012 #: ../src/guestfs-actions.pod:6801
18017 #: ../fish/guestfish-actions.pod:4525
18018 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4525
18019 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6803
18020 #: ../src/guestfs-actions.pod:6803
18021 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
18025 #: ../fish/guestfish-actions.pod:4528
18026 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4528
18027 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6806
18028 #: ../src/guestfs-actions.pod:6806
18029 msgid "l (lower case letter L)"
18033 #: ../fish/guestfish-actions.pod:4530
18034 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4530
18035 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6808
18036 #: ../src/guestfs-actions.pod:6808
18038 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
18039 "examining binaries in Windows guests."
18043 #: ../fish/guestfish-actions.pod:4533
18044 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4533
18045 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6811
18046 #: ../src/guestfs-actions.pod:6811
18051 #: ../fish/guestfish-actions.pod:4535
18052 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4535
18053 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6813
18054 #: ../src/guestfs-actions.pod:6813
18055 msgid "32-bit big endian such as UCS-4BE."
18059 #: ../fish/guestfish-actions.pod:4537
18060 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4537
18061 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6815
18062 #: ../src/guestfs-actions.pod:6815
18067 #: ../fish/guestfish-actions.pod:4539
18068 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4539
18069 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6817
18070 #: ../src/guestfs-actions.pod:6817
18071 msgid "32-bit little endian such as UCS-4LE."
18075 #: ../fish/guestfish-actions.pod:4543
18076 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4543
18077 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6821
18078 #: ../src/guestfs-actions.pod:6821
18079 msgid "The returned strings are transcoded to UTF-8."
18083 #: ../fish/guestfish-actions.pod:4548
18084 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4548
18085 msgid "swapoff-device"
18089 #: ../fish/guestfish-actions.pod:4550
18090 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4550
18093 " swapoff-device device\n"
18098 #: ../fish/guestfish-actions.pod:4552
18099 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4552
18101 "This command disables the libguestfs appliance swap device or partition "
18102 "named C<device>. See L</swapon-device>."
18106 #: ../fish/guestfish-actions.pod:4556
18107 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4556
18108 msgid "swapoff-file"
18112 #: ../fish/guestfish-actions.pod:4558
18113 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4558
18116 " swapoff-file file\n"
18121 #: ../fish/guestfish-actions.pod:4560
18122 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4560
18123 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6852
18124 #: ../src/guestfs-actions.pod:6852
18125 msgid "This command disables the libguestfs appliance swap on file."
18129 #: ../fish/guestfish-actions.pod:4562
18130 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4562
18131 msgid "swapoff-label"
18135 #: ../fish/guestfish-actions.pod:4564
18136 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4564
18139 " swapoff-label label\n"
18144 #: ../fish/guestfish-actions.pod:4566
18145 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4566
18146 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6864
18147 #: ../src/guestfs-actions.pod:6864
18149 "This command disables the libguestfs appliance swap on labeled swap "
18154 #: ../fish/guestfish-actions.pod:4569
18155 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4569
18156 msgid "swapoff-uuid"
18160 #: ../fish/guestfish-actions.pod:4571
18161 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4571
18164 " swapoff-uuid uuid\n"
18169 #: ../fish/guestfish-actions.pod:4573
18170 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4573
18171 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6877
18172 #: ../src/guestfs-actions.pod:6877
18174 "This command disables the libguestfs appliance swap partition with the given "
18179 #: ../fish/guestfish-actions.pod:4576
18180 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4576
18181 msgid "swapon-device"
18185 #: ../fish/guestfish-actions.pod:4578
18186 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4578
18189 " swapon-device device\n"
18194 #: ../fish/guestfish-actions.pod:4580
18195 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4580
18197 "This command enables the libguestfs appliance to use the swap device or "
18198 "partition named C<device>. The increased memory is made available for all "
18199 "commands, for example those run using L</command> or L</sh>."
18203 #: ../fish/guestfish-actions.pod:4585
18204 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4585
18205 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6895
18206 #: ../src/guestfs-actions.pod:6895
18208 "Note that you should not swap to existing guest swap partitions unless you "
18209 "know what you are doing. They may contain hibernation information, or other "
18210 "information that the guest doesn't want you to trash. You also risk leaking "
18211 "information about the host to the guest this way. Instead, attach a new "
18212 "host device to the guest and swap on that."
18216 #: ../fish/guestfish-actions.pod:4592
18217 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4592
18218 msgid "swapon-file"
18222 #: ../fish/guestfish-actions.pod:4594
18223 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4594
18226 " swapon-file file\n"
18231 #: ../fish/guestfish-actions.pod:4596
18232 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4596
18234 "This command enables swap to a file. See L</swapon-device> for other notes."
18238 #: ../fish/guestfish-actions.pod:4599
18239 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4599
18240 msgid "swapon-label"
18244 #: ../fish/guestfish-actions.pod:4601
18245 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4601
18248 " swapon-label label\n"
18253 #: ../fish/guestfish-actions.pod:4603
18254 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4603
18256 "This command enables swap to a labeled swap partition. See L</swapon-"
18257 "device> for other notes."
18261 #: ../fish/guestfish-actions.pod:4606
18262 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4606
18263 msgid "swapon-uuid"
18267 #: ../fish/guestfish-actions.pod:4608
18268 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4608
18271 " swapon-uuid uuid\n"
18276 #: ../fish/guestfish-actions.pod:4610
18277 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4610
18279 "This command enables swap to a swap partition with the given UUID. See L</"
18280 "swapon-device> for other notes."
18284 #: ../fish/guestfish-actions.pod:4613
18285 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4613
18290 #: ../fish/guestfish-actions.pod:4615
18291 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4615
18299 #: ../fish/guestfish-actions.pod:4617
18300 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4617
18301 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6950
18302 #: ../src/guestfs-actions.pod:6950
18304 "This syncs the disk, so that any writes are flushed through to the "
18305 "underlying disk image."
18309 #: ../fish/guestfish-actions.pod:4620
18310 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4620
18311 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6953
18312 #: ../src/guestfs-actions.pod:6953
18314 "You should always call this if you have modified a disk image, before "
18315 "closing the handle."
18319 #: ../fish/guestfish-actions.pod:4623
18320 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4623
18325 #: ../fish/guestfish-actions.pod:4625
18326 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4625
18334 #: ../fish/guestfish-actions.pod:4627
18335 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4627
18336 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6966
18337 #: ../src/guestfs-actions.pod:6966
18339 "This command returns up to the last 10 lines of a file as a list of strings."
18343 #: ../fish/guestfish-actions.pod:4633
18344 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4633
18349 #: ../fish/guestfish-actions.pod:4635
18350 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4635
18353 " tail-n nrlines path\n"
18358 #: ../fish/guestfish-actions.pod:4637
18359 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4637
18360 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6985
18361 #: ../src/guestfs-actions.pod:6985
18363 "If the parameter C<nrlines> is a positive number, this returns the last "
18364 "C<nrlines> lines of the file C<path>."
18368 #: ../fish/guestfish-actions.pod:4640
18369 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4640
18370 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6988
18371 #: ../src/guestfs-actions.pod:6988
18373 "If the parameter C<nrlines> is a negative number, this returns lines from "
18374 "the file C<path>, starting with the C<-nrlines>th line."
18378 #: ../fish/guestfish-actions.pod:4648
18379 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4648
18384 #: ../fish/guestfish-actions.pod:4650
18385 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4650
18388 " tar-in (tarfile|-) directory\n"
18393 #: ../fish/guestfish-actions.pod:4652
18394 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4652
18395 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7009
18396 #: ../src/guestfs-actions.pod:7009
18398 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
18399 "tar file) into C<directory>."
18403 #: ../fish/guestfish-actions.pod:4655
18404 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4655
18405 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
18409 #: ../fish/guestfish-actions.pod:4660
18410 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4660
18415 #: ../fish/guestfish-actions.pod:4662
18416 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4662
18419 " tar-out directory (tarfile|-)\n"
18424 #: ../fish/guestfish-actions.pod:4664
18425 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4664
18426 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7026
18427 #: ../src/guestfs-actions.pod:7026
18429 "This command packs the contents of C<directory> and downloads it to local "
18434 #: ../fish/guestfish-actions.pod:4667
18435 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4667
18436 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
18440 #: ../fish/guestfish-actions.pod:4672
18441 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4672
18446 #: ../fish/guestfish-actions.pod:4674
18447 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4674
18450 " tgz-in (tarball|-) directory\n"
18455 #: ../fish/guestfish-actions.pod:4676
18456 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4676
18457 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7043
18458 #: ../src/guestfs-actions.pod:7043
18460 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
18461 "tar file) into C<directory>."
18465 #: ../fish/guestfish-actions.pod:4679
18466 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4679
18467 msgid "To upload an uncompressed tarball, use L</tar-in>."
18471 #: ../fish/guestfish-actions.pod:4683
18472 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4683
18477 #: ../fish/guestfish-actions.pod:4685
18478 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4685
18481 " tgz-out directory (tarball|-)\n"
18486 #: ../fish/guestfish-actions.pod:4687
18487 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4687
18488 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7059
18489 #: ../src/guestfs-actions.pod:7059
18491 "This command packs the contents of C<directory> and downloads it to local "
18496 #: ../fish/guestfish-actions.pod:4690
18497 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4690
18498 msgid "To download an uncompressed tarball, use L</tar-out>."
18502 #: ../fish/guestfish-actions.pod:4694
18503 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4694
18508 #: ../fish/guestfish-actions.pod:4696
18509 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4696
18517 #: ../fish/guestfish-actions.pod:4698
18518 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4698
18519 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7074
18520 #: ../src/guestfs-actions.pod:7074
18522 "Touch acts like the L<touch(1)> command. It can be used to update the "
18523 "timestamps on a file, or, if the file does not exist, to create a new zero-"
18528 #: ../fish/guestfish-actions.pod:4702
18529 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4702
18530 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7078
18531 #: ../src/guestfs-actions.pod:7078
18533 "This command only works on regular files, and will fail on other file types "
18534 "such as directories, symbolic links, block special etc."
18538 #: ../fish/guestfish-actions.pod:4705
18539 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4705
18544 #: ../fish/guestfish-actions.pod:4707
18545 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4707
18553 #: ../fish/guestfish-actions.pod:4709
18554 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4709
18555 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7091
18556 #: ../src/guestfs-actions.pod:7091
18558 "This command truncates C<path> to a zero-length file. The file must exist "
18563 #: ../fish/guestfish-actions.pod:4712
18564 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4712
18565 msgid "truncate-size"
18569 #: ../fish/guestfish-actions.pod:4714
18570 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4714
18573 " truncate-size path size\n"
18578 #: ../fish/guestfish-actions.pod:4716
18579 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4716
18580 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7105
18581 #: ../src/guestfs-actions.pod:7105
18583 "This command truncates C<path> to size C<size> bytes. The file must exist "
18588 #: ../fish/guestfish-actions.pod:4719
18589 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4719
18591 "If the current file size is less than C<size> then the file is extended to "
18592 "the required size with zero bytes. This creates a sparse file (ie. disk "
18593 "blocks are not allocated for the file until you write to it). To create a "
18594 "non-sparse file of zeroes, use L</fallocate64> instead."
18598 #: ../fish/guestfish-actions.pod:4725
18599 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4725
18604 #: ../fish/guestfish-actions.pod:4727
18605 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4727
18608 " tune2fs-l device\n"
18613 #: ../fish/guestfish-actions.pod:4729
18614 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4729
18615 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7124
18616 #: ../src/guestfs-actions.pod:7124
18618 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
18623 #: ../fish/guestfish-actions.pod:4732
18624 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4732
18625 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7127
18626 #: ../src/guestfs-actions.pod:7127
18628 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
18629 "for more details. The list of fields returned isn't clearly defined, and "
18630 "depends on both the version of C<tune2fs> that libguestfs was built against, "
18631 "and the filesystem itself."
18635 #: ../fish/guestfish-actions.pod:4737
18636 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4737
18641 #: ../fish/guestfish-actions.pod:4739
18642 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4739
18645 " txz-in (tarball|-) directory\n"
18650 #: ../fish/guestfish-actions.pod:4741
18651 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4741
18652 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7147
18653 #: ../src/guestfs-actions.pod:7147
18655 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
18656 "tar file) into C<directory>."
18660 #: ../fish/guestfish-actions.pod:4746
18661 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4746
18666 #: ../fish/guestfish-actions.pod:4748
18667 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4748
18670 " txz-out directory (tarball|-)\n"
18675 #: ../fish/guestfish-actions.pod:4750
18676 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4750
18677 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7161
18678 #: ../src/guestfs-actions.pod:7161
18680 "This command packs the contents of C<directory> and downloads it to local "
18681 "file C<tarball> (as an xz compressed tar archive)."
18685 #: ../fish/guestfish-actions.pod:4755
18686 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4755
18691 #: ../fish/guestfish-actions.pod:4757
18692 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4757
18700 #: ../fish/guestfish-actions.pod:4759
18701 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4759
18702 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7174
18703 #: ../src/guestfs-actions.pod:7174
18705 "This function sets the mask used for creating new files and device nodes to "
18710 #: ../fish/guestfish-actions.pod:4762
18711 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4762
18712 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7177
18713 #: ../src/guestfs-actions.pod:7177
18715 "Typical umask values would be C<022> which creates new files with "
18716 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
18717 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
18721 #: ../fish/guestfish-actions.pod:4767
18722 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4767
18723 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7182
18724 #: ../src/guestfs-actions.pod:7182
18726 "The default umask is C<022>. This is important because it means that "
18727 "directories and device nodes will be created with C<0644> or C<0755> mode "
18728 "even if you specify C<0777>."
18732 #: ../fish/guestfish-actions.pod:4771
18733 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4771
18734 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
18738 #: ../fish/guestfish-actions.pod:4774
18739 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4774
18740 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7189
18741 #: ../src/guestfs-actions.pod:7189
18742 msgid "This call returns the previous umask."
18746 #: ../fish/guestfish-actions.pod:4776
18747 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4776
18752 #: ../fish/guestfish-actions.pod:4778
18753 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4778
18758 #: ../fish/guestfish-actions.pod:4780
18759 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4780
18762 " umount pathordevice\n"
18767 #: ../fish/guestfish-actions.pod:4782
18768 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4782
18769 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7201
18770 #: ../src/guestfs-actions.pod:7201
18772 "This unmounts the given filesystem. The filesystem may be specified either "
18773 "by its mountpoint (path) or the device which contains the filesystem."
18777 #: ../fish/guestfish-actions.pod:4786
18778 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4786
18783 #: ../fish/guestfish-actions.pod:4788
18784 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4788
18785 msgid "unmount-all"
18789 #: ../fish/guestfish-actions.pod:4790
18790 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4790
18798 #: ../fish/guestfish-actions.pod:4792
18799 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4792
18800 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7214
18801 #: ../src/guestfs-actions.pod:7214
18802 msgid "This unmounts all mounted filesystems."
18806 #: ../fish/guestfish-actions.pod:4794
18807 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4794
18808 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7216
18809 #: ../src/guestfs-actions.pod:7216
18810 msgid "Some internal mounts are not unmounted by this call."
18814 #: ../fish/guestfish-actions.pod:4796
18815 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4796
18820 #: ../fish/guestfish-actions.pod:4798
18821 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4798
18824 " upload (filename|-) remotefilename\n"
18829 #: ../fish/guestfish-actions.pod:4800 ../fish/guestfish-actions.pod:4813
18830 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4800
18831 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4813
18832 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7229
18833 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7253
18834 #: ../src/guestfs-actions.pod:7229 ../src/guestfs-actions.pod:7253
18835 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
18839 #: ../fish/guestfish-actions.pod:4805
18840 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4805
18841 msgid "See also L</download>."
18845 #: ../fish/guestfish-actions.pod:4809
18846 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4809
18847 msgid "upload-offset"
18851 #: ../fish/guestfish-actions.pod:4811
18852 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4811
18855 " upload-offset (filename|-) remotefilename offset\n"
18860 #: ../fish/guestfish-actions.pod:4816
18861 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4816
18862 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7256
18863 #: ../src/guestfs-actions.pod:7256
18865 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
18866 "The intention is to overwrite parts of existing files or devices, although "
18867 "if a non-existant file is specified then it is created with a \"hole\" "
18868 "before C<offset>. The size of the data written is implicit in the size of "
18869 "the source C<filename>."
18873 #: ../fish/guestfish-actions.pod:4823
18874 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4823
18876 "Note that there is no limit on the amount of data that can be uploaded with "
18877 "this call, unlike with L</pwrite>, and this call always writes the full "
18878 "amount unless an error occurs."
18882 #: ../fish/guestfish-actions.pod:4828
18883 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4828
18884 msgid "See also L</upload>, L</pwrite>."
18888 #: ../fish/guestfish-actions.pod:4832
18889 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4832
18894 #: ../fish/guestfish-actions.pod:4834
18895 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4834
18898 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
18903 #: ../fish/guestfish-actions.pod:4836
18904 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4836
18905 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7289
18906 #: ../src/guestfs-actions.pod:7289
18907 msgid "This command sets the timestamps of a file with nanosecond precision."
18911 #: ../fish/guestfish-actions.pod:4839
18912 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4839
18913 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7292
18914 #: ../src/guestfs-actions.pod:7292
18916 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
18921 #: ../fish/guestfish-actions.pod:4842
18922 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4842
18923 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7295
18924 #: ../src/guestfs-actions.pod:7295
18926 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
18927 "nanoseconds from the epoch."
18931 #: ../fish/guestfish-actions.pod:4845
18932 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4845
18933 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7298
18934 #: ../src/guestfs-actions.pod:7298
18936 "If the C<*nsecs> field contains the special value C<-1> then the "
18937 "corresponding timestamp is set to the current time. (The C<*secs> field is "
18938 "ignored in this case)."
18942 #: ../fish/guestfish-actions.pod:4849
18943 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4849
18944 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7302
18945 #: ../src/guestfs-actions.pod:7302
18947 "If the C<*nsecs> field contains the special value C<-2> then the "
18948 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
18953 #: ../fish/guestfish-actions.pod:4853
18954 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4853
18959 #: ../fish/guestfish-actions.pod:4855
18960 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4855
18968 #: ../fish/guestfish-actions.pod:4857
18969 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4857
18970 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7315
18971 #: ../src/guestfs-actions.pod:7315
18973 "Return the libguestfs version number that the program is linked against."
18977 #: ../fish/guestfish-actions.pod:4860
18978 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4860
18979 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7318
18980 #: ../src/guestfs-actions.pod:7318
18982 "Note that because of dynamic linking this is not necessarily the version of "
18983 "libguestfs that you compiled against. You can compile the program, and then "
18984 "at runtime dynamically link against a completely different C<libguestfs.so> "
18989 #: ../fish/guestfish-actions.pod:4865
18990 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4865
18991 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7323
18992 #: ../src/guestfs-actions.pod:7323
18994 "This call was added in version C<1.0.58>. In previous versions of "
18995 "libguestfs there was no way to get the version number. From C code you can "
18996 "use dynamic linker functions to find out if this symbol exists (if it "
18997 "doesn't, then it's an earlier version)."
19001 #: ../fish/guestfish-actions.pod:4871
19002 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4871
19003 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7329
19004 #: ../src/guestfs-actions.pod:7329
19006 "The call returns a structure with four elements. The first three (C<major>, "
19007 "C<minor> and C<release>) are numbers and correspond to the usual version "
19008 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
19009 "but may be used for distro-specific information."
19013 #: ../fish/guestfish-actions.pod:4877
19014 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4877
19015 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7335
19016 #: ../src/guestfs-actions.pod:7335
19018 "To construct the original version string: C<$major.$minor.$release$extra>"
19022 #: ../fish/guestfish-actions.pod:4880
19023 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4880
19024 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7338
19025 #: ../src/guestfs-actions.pod:7338
19026 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
19030 #: ../fish/guestfish-actions.pod:4882
19031 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4882
19033 "I<Note:> Don't use this call to test for availability of features. In "
19034 "enterprise distributions we backport features from later versions into "
19035 "earlier versions, making this an unreliable way to test for features. Use "
19036 "L</available> instead."
19040 #: ../fish/guestfish-actions.pod:4888
19041 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4888
19046 #: ../fish/guestfish-actions.pod:4890
19047 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4890
19050 " vfs-label device\n"
19055 #: ../fish/guestfish-actions.pod:4892
19056 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4892
19057 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7358
19058 #: ../src/guestfs-actions.pod:7358
19059 msgid "This returns the filesystem label of the filesystem on C<device>."
19063 #: ../fish/guestfish-actions.pod:4895
19064 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4895
19065 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7361
19066 #: ../src/guestfs-actions.pod:7361
19067 msgid "If the filesystem is unlabeled, this returns the empty string."
19071 #: ../fish/guestfish-actions.pod:4897
19072 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4897
19073 msgid "To find a filesystem from the label, use L</findfs-label>."
19077 #: ../fish/guestfish-actions.pod:4899
19078 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4899
19083 #: ../fish/guestfish-actions.pod:4901
19084 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4901
19087 " vfs-type device\n"
19092 #: ../fish/guestfish-actions.pod:4903
19093 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4903
19094 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7376
19095 #: ../src/guestfs-actions.pod:7376
19097 "This command gets the filesystem type corresponding to the filesystem on "
19102 #: ../fish/guestfish-actions.pod:4906
19103 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4906
19104 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7379
19105 #: ../src/guestfs-actions.pod:7379
19107 "For most filesystems, the result is the name of the Linux VFS module which "
19108 "would be used to mount this filesystem if you mounted it without specifying "
19109 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
19113 #: ../fish/guestfish-actions.pod:4911
19114 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4911
19119 #: ../fish/guestfish-actions.pod:4913
19120 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4913
19123 " vfs-uuid device\n"
19128 #: ../fish/guestfish-actions.pod:4915
19129 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4915
19130 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7395
19131 #: ../src/guestfs-actions.pod:7395
19132 msgid "This returns the filesystem UUID of the filesystem on C<device>."
19136 #: ../fish/guestfish-actions.pod:4918
19137 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4918
19138 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7398
19139 #: ../src/guestfs-actions.pod:7398
19140 msgid "If the filesystem does not have a UUID, this returns the empty string."
19144 #: ../fish/guestfish-actions.pod:4920
19145 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4920
19146 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
19150 #: ../fish/guestfish-actions.pod:4922
19151 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4922
19152 msgid "vg-activate"
19156 #: ../fish/guestfish-actions.pod:4924
19157 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4924
19160 " vg-activate true|false 'volgroups ...'\n"
19165 #: ../fish/guestfish-actions.pod:4926
19166 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4926
19167 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7414
19168 #: ../src/guestfs-actions.pod:7414
19170 "This command activates or (if C<activate> is false) deactivates all logical "
19171 "volumes in the listed volume groups C<volgroups>."
19175 #: ../fish/guestfish-actions.pod:4929
19176 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4929
19177 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7417
19178 #: ../src/guestfs-actions.pod:7417
19179 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
19183 #: ../fish/guestfish-actions.pod:4931
19184 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4931
19185 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7419
19186 #: ../src/guestfs-actions.pod:7419
19188 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
19189 "activated or deactivated."
19193 #: ../fish/guestfish-actions.pod:4934
19194 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4934
19195 msgid "vg-activate-all"
19199 #: ../fish/guestfish-actions.pod:4936
19200 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4936
19203 " vg-activate-all true|false\n"
19208 #: ../fish/guestfish-actions.pod:4938
19209 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4938
19210 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7432
19211 #: ../src/guestfs-actions.pod:7432
19213 "This command activates or (if C<activate> is false) deactivates all logical "
19214 "volumes in all volume groups."
19218 #: ../fish/guestfish-actions.pod:4941
19219 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4941
19220 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7435
19221 #: ../src/guestfs-actions.pod:7435
19222 msgid "This command is the same as running C<vgchange -a y|n>"
19226 #: ../fish/guestfish-actions.pod:4943
19227 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4943
19232 #: ../fish/guestfish-actions.pod:4945
19233 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4945
19236 " vgcreate volgroup 'physvols ...'\n"
19241 #: ../fish/guestfish-actions.pod:4947
19242 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4947
19243 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7448
19244 #: ../src/guestfs-actions.pod:7448
19246 "This creates an LVM volume group called C<volgroup> from the non-empty list "
19247 "of physical volumes C<physvols>."
19251 #: ../fish/guestfish-actions.pod:4950
19252 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4950
19257 #: ../fish/guestfish-actions.pod:4952
19258 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4952
19261 " vglvuuids vgname\n"
19266 #: ../fish/guestfish-actions.pod:4954
19267 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4954
19268 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7461
19269 #: ../src/guestfs-actions.pod:7461
19271 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
19272 "volumes created in this volume group."
19276 #: ../fish/guestfish-actions.pod:4957
19277 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4957
19279 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
19280 "logical volumes and volume groups."
19284 #: ../fish/guestfish-actions.pod:4960
19285 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4960
19286 msgid "See also L</vgpvuuids>."
19290 #: ../fish/guestfish-actions.pod:4962
19291 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4962
19296 #: ../fish/guestfish-actions.pod:4964
19297 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4964
19300 " vgpvuuids vgname\n"
19305 #: ../fish/guestfish-actions.pod:4966
19306 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4966
19307 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7481
19308 #: ../src/guestfs-actions.pod:7481
19310 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
19311 "volumes that this volume group resides on."
19315 #: ../fish/guestfish-actions.pod:4969
19316 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4969
19318 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
19319 "physical volumes and volume groups."
19323 #: ../fish/guestfish-actions.pod:4972
19324 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4972
19325 msgid "See also L</vglvuuids>."
19329 #: ../fish/guestfish-actions.pod:4974
19330 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4974
19335 #: ../fish/guestfish-actions.pod:4976
19336 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4976
19339 " vgremove vgname\n"
19344 #: ../fish/guestfish-actions.pod:4978
19345 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4978
19346 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7501
19347 #: ../src/guestfs-actions.pod:7501
19348 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
19352 #: ../fish/guestfish-actions.pod:4980
19353 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4980
19354 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7503
19355 #: ../src/guestfs-actions.pod:7503
19357 "This also forcibly removes all logical volumes in the volume group (if any)."
19361 #: ../fish/guestfish-actions.pod:4983
19362 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4983
19367 #: ../fish/guestfish-actions.pod:4985
19368 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4985
19371 " vgrename volgroup newvolgroup\n"
19376 #: ../fish/guestfish-actions.pod:4987
19377 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4987
19378 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7517
19379 #: ../src/guestfs-actions.pod:7517
19380 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
19384 #: ../fish/guestfish-actions.pod:4989
19385 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4989
19390 #: ../fish/guestfish-actions.pod:4991
19391 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4991
19399 #: ../fish/guestfish-actions.pod:4993
19400 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4993
19401 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7528
19402 #: ../src/guestfs-actions.pod:7528
19404 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19409 #: ../fish/guestfish-actions.pod:4996
19410 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4996
19411 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7531
19412 #: ../src/guestfs-actions.pod:7531
19414 "This returns a list of just the volume group names that were detected (eg. "
19419 #: ../fish/guestfish-actions.pod:4999
19420 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:4999
19421 msgid "See also L</vgs-full>."
19425 #: ../fish/guestfish-actions.pod:5001
19426 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5001
19431 #: ../fish/guestfish-actions.pod:5003
19432 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5003
19440 #: ../fish/guestfish-actions.pod:5005
19441 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5005
19442 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7547
19443 #: ../src/guestfs-actions.pod:7547
19445 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19446 "> command. The \"full\" version includes all fields."
19450 #: ../fish/guestfish-actions.pod:5008
19451 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5008
19456 #: ../fish/guestfish-actions.pod:5010
19457 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5010
19465 #: ../fish/guestfish-actions.pod:5012
19466 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5012
19467 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7561
19468 #: ../src/guestfs-actions.pod:7561
19470 "This rescans all block devices and rebuilds the list of LVM physical "
19471 "volumes, volume groups and logical volumes."
19475 #: ../fish/guestfish-actions.pod:5015
19476 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5015
19481 #: ../fish/guestfish-actions.pod:5017
19482 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5017
19490 #: ../fish/guestfish-actions.pod:5019
19491 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5019
19492 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7574
19493 #: ../src/guestfs-actions.pod:7574
19494 msgid "This command returns the UUID of the LVM VG named C<vgname>."
19498 #: ../fish/guestfish-actions.pod:5021
19499 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5021
19504 #: ../fish/guestfish-actions.pod:5023
19505 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5023
19513 #: ../fish/guestfish-actions.pod:5025
19514 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5025
19515 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7614
19516 #: ../src/guestfs-actions.pod:7614
19518 "This command counts the characters in a file, using the C<wc -c> external "
19523 #: ../fish/guestfish-actions.pod:5028
19524 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5028
19529 #: ../fish/guestfish-actions.pod:5030
19530 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5030
19538 #: ../fish/guestfish-actions.pod:5032
19539 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5032
19540 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7627
19541 #: ../src/guestfs-actions.pod:7627
19543 "This command counts the lines in a file, using the C<wc -l> external command."
19547 #: ../fish/guestfish-actions.pod:5035
19548 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5035
19553 #: ../fish/guestfish-actions.pod:5037
19554 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5037
19562 #: ../fish/guestfish-actions.pod:5039
19563 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5039
19564 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7640
19565 #: ../src/guestfs-actions.pod:7640
19567 "This command counts the words in a file, using the C<wc -w> external command."
19571 #: ../fish/guestfish-actions.pod:5042
19572 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5042
19577 #: ../fish/guestfish-actions.pod:5044
19578 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5044
19581 " write path content\n"
19586 #: ../fish/guestfish-actions.pod:5046
19587 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5046
19588 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7655
19589 #: ../src/guestfs-actions.pod:7655
19591 "This call creates a file called C<path>. The content of the file is the "
19592 "string C<content> (which can contain any 8 bit data)."
19596 #: ../fish/guestfish-actions.pod:5049
19597 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5049
19598 msgid "See also L</write-append>."
19602 #: ../fish/guestfish-actions.pod:5054
19603 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5054
19604 msgid "write-append"
19608 #: ../fish/guestfish-actions.pod:5056
19609 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5056
19612 " write-append path content\n"
19617 #: ../fish/guestfish-actions.pod:5058
19618 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5058
19619 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7675
19620 #: ../src/guestfs-actions.pod:7675
19622 "This call appends C<content> to the end of file C<path>. If C<path> does "
19623 "not exist, then a new file is created."
19627 #: ../fish/guestfish-actions.pod:5061
19628 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5061
19629 msgid "See also L</write>."
19633 #: ../fish/guestfish-actions.pod:5066
19634 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5066
19639 #: ../fish/guestfish-actions.pod:5068
19640 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5068
19643 " write-file path content size\n"
19648 #: ../fish/guestfish-actions.pod:5070
19649 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5070
19650 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7695
19651 #: ../src/guestfs-actions.pod:7695
19653 "This call creates a file called C<path>. The contents of the file is the "
19654 "string C<content> (which can contain any 8 bit data), with length C<size>."
19658 #: ../fish/guestfish-actions.pod:5074
19659 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5074
19660 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7699
19661 #: ../src/guestfs-actions.pod:7699
19663 "As a special case, if C<size> is C<0> then the length is calculated using "
19664 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
19668 #: ../fish/guestfish-actions.pod:5078
19669 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5078
19670 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7703
19671 #: ../src/guestfs-actions.pod:7703
19673 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
19674 "I<not> work, even if the length is specified."
19678 #: ../fish/guestfish-actions.pod:5084
19679 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5084
19680 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7711
19681 #: ../src/guestfs-actions.pod:7711
19683 "This function is deprecated. In new code, use the C<write> call instead."
19687 #: ../fish/guestfish-actions.pod:5091
19688 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5091
19693 #: ../fish/guestfish-actions.pod:5093
19694 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5093
19697 " zegrep regex path\n"
19702 #: ../fish/guestfish-actions.pod:5095
19703 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5095
19704 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7727
19705 #: ../src/guestfs-actions.pod:7727
19707 "This calls the external C<zegrep> program and returns the matching lines."
19711 #: ../fish/guestfish-actions.pod:5101
19712 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5101
19717 #: ../fish/guestfish-actions.pod:5103
19718 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5103
19721 " zegrepi regex path\n"
19726 #: ../fish/guestfish-actions.pod:5105
19727 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5105
19728 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7746
19729 #: ../src/guestfs-actions.pod:7746
19731 "This calls the external C<zegrep -i> program and returns the matching lines."
19735 #: ../fish/guestfish-actions.pod:5111
19736 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5111
19741 #: ../fish/guestfish-actions.pod:5113
19742 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5113
19750 #: ../fish/guestfish-actions.pod:5115
19751 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5115
19752 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7764
19753 #: ../src/guestfs-actions.pod:7764
19754 msgid "This command writes zeroes over the first few blocks of C<device>."
19758 #: ../fish/guestfish-actions.pod:5117
19759 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5117
19760 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7766
19761 #: ../src/guestfs-actions.pod:7766
19763 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
19764 "securely wipe the device). It should be sufficient to remove any partition "
19765 "tables, filesystem superblocks and so on."
19769 #: ../fish/guestfish-actions.pod:5121
19770 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5121
19771 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
19775 #: ../fish/guestfish-actions.pod:5124
19776 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5124
19777 msgid "zero-device"
19781 #: ../fish/guestfish-actions.pod:5126
19782 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5126
19785 " zero-device device\n"
19790 #: ../fish/guestfish-actions.pod:5128
19791 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5128
19793 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
19794 "which just zeroes the first few blocks of a device."
19798 #: ../fish/guestfish-actions.pod:5135
19799 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5135
19804 #: ../fish/guestfish-actions.pod:5137
19805 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5137
19808 " zerofree device\n"
19813 #: ../fish/guestfish-actions.pod:5139
19814 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5139
19815 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7810
19816 #: ../src/guestfs-actions.pod:7810
19818 "This runs the I<zerofree> program on C<device>. This program claims to zero "
19819 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
19820 "possible to compress the filesystem more effectively."
19824 #: ../fish/guestfish-actions.pod:5144
19825 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5144
19826 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7815
19827 #: ../src/guestfs-actions.pod:7815
19828 msgid "You should B<not> run this program if the filesystem is mounted."
19832 #: ../fish/guestfish-actions.pod:5147
19833 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5147
19834 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7818
19835 #: ../src/guestfs-actions.pod:7818
19837 "It is possible that using this program can damage the filesystem or data on "
19842 #: ../fish/guestfish-actions.pod:5150
19843 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5150
19848 #: ../fish/guestfish-actions.pod:5152
19849 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5152
19852 " zfgrep pattern path\n"
19857 #: ../fish/guestfish-actions.pod:5154
19858 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5154
19859 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7832
19860 #: ../src/guestfs-actions.pod:7832
19862 "This calls the external C<zfgrep> program and returns the matching lines."
19866 #: ../fish/guestfish-actions.pod:5160
19867 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5160
19872 #: ../fish/guestfish-actions.pod:5162
19873 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5162
19876 " zfgrepi pattern path\n"
19881 #: ../fish/guestfish-actions.pod:5164
19882 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5164
19883 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7851
19884 #: ../src/guestfs-actions.pod:7851
19886 "This calls the external C<zfgrep -i> program and returns the matching lines."
19890 #: ../fish/guestfish-actions.pod:5170
19891 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5170
19896 #: ../fish/guestfish-actions.pod:5172
19897 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5172
19900 " zfile meth path\n"
19905 #: ../fish/guestfish-actions.pod:5174
19906 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5174
19907 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7870
19908 #: ../src/guestfs-actions.pod:7870
19910 "This command runs C<file> after first decompressing C<path> using C<method>."
19914 #: ../fish/guestfish-actions.pod:5177
19915 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5177
19916 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7873
19917 #: ../src/guestfs-actions.pod:7873
19918 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
19922 #: ../fish/guestfish-actions.pod:5179
19923 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5179
19925 "Since 1.0.63, use L</file> instead which can now process compressed files."
19929 #: ../fish/guestfish-actions.pod:5182
19930 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5182
19931 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7881
19932 #: ../src/guestfs-actions.pod:7881
19934 "This function is deprecated. In new code, use the C<file> call instead."
19938 #: ../fish/guestfish-actions.pod:5189
19939 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5189
19944 #: ../fish/guestfish-actions.pod:5191
19945 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5191
19948 " zgrep regex path\n"
19953 #: ../fish/guestfish-actions.pod:5193
19954 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5193
19955 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7897
19956 #: ../src/guestfs-actions.pod:7897
19958 "This calls the external C<zgrep> program and returns the matching lines."
19962 #: ../fish/guestfish-actions.pod:5199
19963 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5199
19968 #: ../fish/guestfish-actions.pod:5201
19969 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5201
19972 " zgrepi regex path\n"
19977 #: ../fish/guestfish-actions.pod:5203
19978 #: ../libguestfs-1.11.19/fish/guestfish-actions.pod:5203
19979 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7916
19980 #: ../src/guestfs-actions.pod:7916
19982 "This calls the external C<zgrep -i> program and returns the matching lines."
19986 #: ../fish/guestfish-commands.pod:1
19987 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:1
19992 #: ../fish/guestfish-commands.pod:3
19993 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:3
19998 #: ../fish/guestfish-commands.pod:5
19999 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:5
20002 " alloc filename size\n"
20007 #: ../fish/guestfish-commands.pod:7
20008 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:7
20010 "This creates an empty (zeroed) file of the given size, and then adds so it "
20011 "can be further examined."
20015 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
20016 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:10
20017 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:182
20018 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
20022 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
20023 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:12
20024 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:184
20025 msgid "Size can be specified using standard suffixes, eg. C<1M>."
20029 #: ../fish/guestfish-commands.pod:14
20030 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:14
20032 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
20033 "image, see L</PREPARED DISK IMAGES>."
20037 #: ../fish/guestfish-commands.pod:17
20038 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:17
20043 #: ../fish/guestfish-commands.pod:19
20044 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:19
20047 " copy-in local [local ...] /remotedir\n"
20052 #: ../fish/guestfish-commands.pod:21
20053 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:21
20055 "C<copy-in> copies local files or directories recursively into the disk "
20056 "image, placing them in the directory called C</remotedir> (which must "
20057 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
20058 "other commands as necessary."
20062 #: ../fish/guestfish-commands.pod:26
20063 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:26
20065 "Multiple local files and directories can be specified, but the last "
20066 "parameter must always be a remote directory. Wildcards cannot be used."
20070 #: ../fish/guestfish-commands.pod:30
20071 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:30
20076 #: ../fish/guestfish-commands.pod:32
20077 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:32
20080 " copy-out remote [remote ...] localdir\n"
20085 #: ../fish/guestfish-commands.pod:34
20086 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:34
20088 "C<copy-out> copies remote files or directories recursively out of the disk "
20089 "image, placing them on the host disk in a local directory called C<localdir> "
20090 "(which must exist). This guestfish meta-command turns into a sequence of L</"
20091 "download>, L</tar-out> and other commands as necessary."
20095 #: ../fish/guestfish-commands.pod:40
20096 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:40
20098 "Multiple remote files and directories can be specified, but the last "
20099 "parameter must always be a local directory. To download to the current "
20100 "directory, use C<.> as in:"
20104 #: ../fish/guestfish-commands.pod:44
20105 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:44
20108 " copy-out /home .\n"
20113 #: ../fish/guestfish-commands.pod:46
20114 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:46
20116 "Wildcards cannot be used in the ordinary command, but you can use them with "
20117 "the help of L</glob> like this:"
20121 #: ../fish/guestfish-commands.pod:49
20122 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:49
20125 " glob copy-out /home/* .\n"
20130 #: ../fish/guestfish-commands.pod:51
20131 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:51
20136 #: ../fish/guestfish-commands.pod:53
20137 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:53
20140 " display filename\n"
20145 #: ../fish/guestfish-commands.pod:55
20146 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:55
20148 "Use C<display> (a graphical display program) to display an image file. It "
20149 "downloads the file, and runs C<display> on it."
20153 #: ../fish/guestfish-commands.pod:58
20154 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:58
20156 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
20157 "environment variable. For example to use the GNOME display program:"
20161 #: ../fish/guestfish-commands.pod:61
20162 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:61
20165 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
20170 #: ../fish/guestfish-commands.pod:63
20171 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:63
20172 msgid "See also L<display(1)>."
20176 #: ../fish/guestfish-commands.pod:65
20177 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:65
20182 #: ../fish/guestfish-commands.pod:67
20183 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:67
20186 " echo [params ...]\n"
20191 #: ../fish/guestfish-commands.pod:69
20192 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:69
20193 msgid "This echos the parameters to the terminal."
20197 #: ../fish/guestfish-commands.pod:71
20198 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:71
20203 #: ../fish/guestfish-commands.pod:73
20204 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:73
20209 #: ../fish/guestfish-commands.pod:75
20210 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:75
20215 #: ../fish/guestfish-commands.pod:77
20216 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:77
20224 #: ../fish/guestfish-commands.pod:79
20225 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:79
20227 "This is used to edit a file. It downloads the file, edits it locally using "
20228 "your editor, then uploads the result."
20232 #: ../fish/guestfish-commands.pod:82
20233 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:82
20235 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
20236 "or C<emacs> you will get those corresponding editors."
20240 #: ../fish/guestfish-commands.pod:86
20241 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:86
20246 #: ../fish/guestfish-commands.pod:88
20247 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:88
20250 " glob command args...\n"
20255 #: ../fish/guestfish-commands.pod:90
20256 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:90
20258 "Expand wildcards in any paths in the args list, and run C<command> "
20259 "repeatedly on each matching path."
20263 #: ../fish/guestfish-commands.pod:93
20264 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:93
20265 msgid "See L</WILDCARDS AND GLOBBING>."
20269 #: ../fish/guestfish-commands.pod:95
20270 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:95
20275 #: ../fish/guestfish-commands.pod:97
20276 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:97
20279 " hexedit <filename|device>\n"
20280 " hexedit <filename|device> <max>\n"
20281 " hexedit <filename|device> <start> <max>\n"
20286 #: ../fish/guestfish-commands.pod:101
20287 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:101
20289 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
20294 #: ../fish/guestfish-commands.pod:104
20295 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:104
20297 "This command works by downloading potentially the whole file or device, "
20298 "editing it locally, then uploading it. If the file or device is large, you "
20299 "have to specify which part you wish to edit by using C<max> and/or C<start> "
20300 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
20301 "usual modifiers allowed such as C<1M> (1 megabyte)."
20305 #: ../fish/guestfish-commands.pod:111
20306 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:111
20307 msgid "For example to edit the first few sectors of a disk you might do:"
20311 #: ../fish/guestfish-commands.pod:114
20312 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:114
20315 " hexedit /dev/sda 1M\n"
20320 #: ../fish/guestfish-commands.pod:116
20321 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:116
20323 "which would allow you to edit anywhere within the first megabyte of the disk."
20327 #: ../fish/guestfish-commands.pod:119
20328 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:119
20329 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
20333 #: ../fish/guestfish-commands.pod:121
20334 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:121
20337 " hexedit /dev/sda1 0x400 0x400\n"
20342 #: ../fish/guestfish-commands.pod:123
20343 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:123
20344 msgid "(assuming the superblock is in the standard location)."
20348 #: ../fish/guestfish-commands.pod:125
20349 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:125
20351 "This command requires the external L<hexedit(1)> program. You can specify "
20352 "another program to use by setting the C<HEXEDITOR> environment variable."
20356 #: ../fish/guestfish-commands.pod:129
20357 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:129
20358 msgid "See also L</hexdump>."
20362 #: ../fish/guestfish-commands.pod:131
20363 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:131
20368 #: ../fish/guestfish-commands.pod:133
20369 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:133
20377 #: ../fish/guestfish-commands.pod:135
20378 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:135
20380 "Change the local directory, ie. the current directory of guestfish itself."
20384 #: ../fish/guestfish-commands.pod:138
20385 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:138
20386 msgid "Note that C<!cd> won't do what you might expect."
20390 #: ../fish/guestfish-commands.pod:140
20391 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:140
20396 #: ../fish/guestfish-commands.pod:142
20397 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:142
20402 #: ../fish/guestfish-commands.pod:144
20403 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:144
20411 #: ../fish/guestfish-commands.pod:146
20412 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:146
20413 msgid "Opens the manual page for guestfish."
20417 #: ../fish/guestfish-commands.pod:148
20418 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:148
20423 #: ../fish/guestfish-commands.pod:150
20424 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:150
20429 #: ../fish/guestfish-commands.pod:152
20430 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:152
20438 #: ../fish/guestfish-commands.pod:154
20439 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:154
20447 #: ../fish/guestfish-commands.pod:156
20448 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:156
20449 msgid "This is used to view a file."
20453 #: ../fish/guestfish-commands.pod:158
20454 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:158
20456 "The default viewer is C<$PAGER>. However if you use the alternate command "
20457 "C<less> you will get the C<less> command specifically."
20461 #: ../fish/guestfish-commands.pod:161
20462 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:161
20467 #: ../fish/guestfish-commands.pod:163
20468 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:163
20476 #: ../fish/guestfish-commands.pod:165
20477 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:165
20479 "Close and reopen the libguestfs handle. It is not necessary to use this "
20480 "normally, because the handle is closed properly when guestfish exits. "
20481 "However this is occasionally useful for testing."
20485 #: ../fish/guestfish-commands.pod:169
20486 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:169
20491 #: ../fish/guestfish-commands.pod:171
20492 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:171
20495 " sparse filename size\n"
20500 #: ../fish/guestfish-commands.pod:173
20501 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:173
20503 "This creates an empty sparse file of the given size, and then adds so it can "
20504 "be further examined."
20508 #: ../fish/guestfish-commands.pod:176
20509 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:176
20511 "In all respects it works the same as the L</alloc> command, except that the "
20512 "image file is allocated sparsely, which means that disk blocks are not "
20513 "assigned to the file until they are needed. Sparse disk files only use "
20514 "space when written to, but they are slower and there is a danger you could "
20515 "run out of real disk space during a write operation."
20519 #: ../fish/guestfish-commands.pod:186
20520 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:186
20525 #: ../fish/guestfish-commands.pod:188
20526 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:188
20534 #: ../fish/guestfish-commands.pod:190
20535 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:190
20537 "This command returns a list of the optional groups known to the daemon, and "
20538 "indicates which ones are supported by this build of the libguestfs appliance."
20542 #: ../fish/guestfish-commands.pod:194
20543 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:194
20544 msgid "See also L<guestfs(3)/AVAILABILITY>."
20548 #: ../fish/guestfish-commands.pod:196
20549 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:196
20554 #: ../fish/guestfish-commands.pod:198
20555 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:198
20558 " time command args...\n"
20563 #: ../fish/guestfish-commands.pod:200
20564 #: ../libguestfs-1.11.19/fish/guestfish-commands.pod:200
20566 "Run the command as usual, but print the elapsed time afterwards. This can "
20567 "be useful for benchmarking operations."
20571 #: ../fish/guestfish.pod:5 ../libguestfs-1.11.19/fish/guestfish.pod:5
20572 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
20576 #: ../fish/guestfish.pod:9 ../libguestfs-1.11.19/fish/guestfish.pod:9
20579 " guestfish [--options] [commands]\n"
20584 #: ../fish/guestfish.pod:11 ../libguestfs-1.11.19/fish/guestfish.pod:11
20592 #: ../fish/guestfish.pod:13 ../libguestfs-1.11.19/fish/guestfish.pod:13
20595 " guestfish [--ro|--rw] -a disk.img\n"
20600 #: ../fish/guestfish.pod:15 ../libguestfs-1.11.19/fish/guestfish.pod:15
20603 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
20608 #: ../fish/guestfish.pod:17 ../libguestfs-1.11.19/fish/guestfish.pod:17
20611 " guestfish -d libvirt-domain\n"
20616 #: ../fish/guestfish.pod:19 ../libguestfs-1.11.19/fish/guestfish.pod:19
20619 " guestfish [--ro|--rw] -a disk.img -i\n"
20624 #: ../fish/guestfish.pod:21 ../libguestfs-1.11.19/fish/guestfish.pod:21
20627 " guestfish -d libvirt-domain -i\n"
20632 #: ../fish/guestfish.pod:25 ../libguestfs-1.11.19/fish/guestfish.pod:25
20634 "Using guestfish in read/write mode on live virtual machines can be "
20635 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
20636 "option to use guestfish safely if the disk image or virtual machine might be "
20641 #: ../fish/guestfish.pod:32 ../libguestfs-1.11.19/fish/guestfish.pod:32
20643 "Guestfish is a shell and command-line tool for examining and modifying "
20644 "virtual machine filesystems. It uses libguestfs and exposes all of the "
20645 "functionality of the guestfs API, see L<guestfs(3)>."
20649 #: ../fish/guestfish.pod:36 ../libguestfs-1.11.19/fish/guestfish.pod:36
20651 "Guestfish gives you structured access to the libguestfs API, from shell "
20652 "scripts or the command line or interactively. If you want to rescue a "
20653 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
20658 #: ../fish/guestfish.pod:43 ../libguestfs-1.11.19/fish/guestfish.pod:43
20659 msgid "As an interactive shell"
20663 #: ../fish/guestfish.pod:45 ../libguestfs-1.11.19/fish/guestfish.pod:45
20671 #: ../fish/guestfish.pod:47 ../libguestfs-1.11.19/fish/guestfish.pod:47
20674 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
20675 " editing virtual machine filesystems.\n"
20680 #: ../fish/guestfish.pod:50 ../libguestfs-1.11.19/fish/guestfish.pod:50
20683 " Type: 'help' for a list of commands\n"
20684 " 'man' to read the manual\n"
20685 " 'quit' to quit the shell\n"
20690 #: ../fish/guestfish.pod:54 ../libguestfs-1.11.19/fish/guestfish.pod:54
20693 " ><fs> add-ro disk.img\n"
20695 " ><fs> list-filesystems\n"
20696 " /dev/sda1: ext4\n"
20697 " /dev/vg_guest/lv_root: ext4\n"
20698 " /dev/vg_guest/lv_swap: swap\n"
20699 " ><fs> mount /dev/vg_guest/lv_root /\n"
20700 " ><fs> cat /etc/fstab\n"
20702 " # Created by anaconda\n"
20709 #: ../fish/guestfish.pod:67 ../libguestfs-1.11.19/fish/guestfish.pod:67
20710 msgid "From shell scripts"
20714 #: ../fish/guestfish.pod:69 ../libguestfs-1.11.19/fish/guestfish.pod:69
20715 msgid "Create a new C</etc/motd> file in a guest or disk image:"
20719 #: ../fish/guestfish.pod:71 ../libguestfs-1.11.19/fish/guestfish.pod:71
20722 " guestfish <<_EOF_\n"
20725 " mount /dev/vg_guest/lv_root /\n"
20726 " write /etc/motd \"Welcome, new users\"\n"
20732 #: ../fish/guestfish.pod:78 ../libguestfs-1.11.19/fish/guestfish.pod:78
20733 msgid "List the LVM logical volumes in a disk image:"
20737 #: ../fish/guestfish.pod:80 ../libguestfs-1.11.19/fish/guestfish.pod:80
20740 " guestfish -a disk.img --ro <<_EOF_\n"
20748 #: ../fish/guestfish.pod:85 ../libguestfs-1.11.19/fish/guestfish.pod:85
20749 msgid "List all the filesystems in a disk image:"
20753 #: ../fish/guestfish.pod:87 ../libguestfs-1.11.19/fish/guestfish.pod:87
20756 " guestfish -a disk.img --ro <<_EOF_\n"
20758 " list-filesystems\n"
20764 #: ../fish/guestfish.pod:92 ../libguestfs-1.11.19/fish/guestfish.pod:92
20765 msgid "On one command line"
20769 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
20770 #: ../libguestfs-1.11.19/fish/guestfish.pod:94
20771 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:31
20772 msgid "Update C</etc/resolv.conf> in a guest:"
20776 #: ../fish/guestfish.pod:96 ../libguestfs-1.11.19/fish/guestfish.pod:96
20780 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
20781 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
20786 #: ../fish/guestfish.pod:100 ../libguestfs-1.11.19/fish/guestfish.pod:100
20787 msgid "Edit C</boot/grub/grub.conf> interactively:"
20791 #: ../fish/guestfish.pod:102 ../libguestfs-1.11.19/fish/guestfish.pod:102
20794 " guestfish --rw --add disk.img \\\n"
20795 " --mount /dev/vg_guest/lv_root \\\n"
20796 " --mount /dev/sda1:/boot \\\n"
20797 " edit /boot/grub/grub.conf\n"
20802 #: ../fish/guestfish.pod:107 ../libguestfs-1.11.19/fish/guestfish.pod:107
20803 msgid "Mount disks automatically"
20807 #: ../fish/guestfish.pod:109 ../libguestfs-1.11.19/fish/guestfish.pod:109
20809 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
20813 #: ../fish/guestfish.pod:112 ../libguestfs-1.11.19/fish/guestfish.pod:112
20816 " guestfish --ro -a disk.img -i cat /etc/group\n"
20821 #: ../fish/guestfish.pod:114 ../libguestfs-1.11.19/fish/guestfish.pod:114
20824 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
20829 #: ../fish/guestfish.pod:116 ../libguestfs-1.11.19/fish/guestfish.pod:116
20830 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
20834 #: ../fish/guestfish.pod:118 ../libguestfs-1.11.19/fish/guestfish.pod:118
20837 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
20842 #: ../fish/guestfish.pod:120 ../libguestfs-1.11.19/fish/guestfish.pod:120
20843 msgid "As a script interpreter"
20847 #: ../fish/guestfish.pod:122 ../libguestfs-1.11.19/fish/guestfish.pod:122
20848 msgid "Create a 100MB disk containing an ext2-formatted partition:"
20852 #: ../fish/guestfish.pod:124 ../libguestfs-1.11.19/fish/guestfish.pod:124
20855 " #!/usr/bin/guestfish -f\n"
20856 " sparse test1.img 100M\n"
20858 " part-disk /dev/sda mbr\n"
20859 " mkfs ext2 /dev/sda1\n"
20864 #: ../fish/guestfish.pod:130 ../libguestfs-1.11.19/fish/guestfish.pod:130
20865 msgid "Start with a prepared disk"
20869 #: ../fish/guestfish.pod:132 ../libguestfs-1.11.19/fish/guestfish.pod:132
20871 "An alternate way to create a 100MB disk called C<test1.img> containing a "
20872 "single ext2-formatted partition:"
20876 #: ../fish/guestfish.pod:135 ../libguestfs-1.11.19/fish/guestfish.pod:135
20879 " guestfish -N fs\n"
20884 #: ../fish/guestfish.pod:137 ../libguestfs-1.11.19/fish/guestfish.pod:137
20885 msgid "To list what is available do:"
20889 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:998
20890 #: ../libguestfs-1.11.19/fish/guestfish.pod:139
20891 #: ../libguestfs-1.11.19/fish/guestfish.pod:998
20894 " guestfish -N help | less\n"
20899 #: ../fish/guestfish.pod:141 ../libguestfs-1.11.19/fish/guestfish.pod:141
20900 msgid "Remote control"
20904 #: ../fish/guestfish.pod:143 ../libguestfs-1.11.19/fish/guestfish.pod:143
20907 " eval \"`guestfish --listen`\"\n"
20908 " guestfish --remote add-ro disk.img\n"
20909 " guestfish --remote run\n"
20910 " guestfish --remote lvs\n"
20915 #: ../fish/guestfish.pod:154 ../libguestfs-1.11.19/fish/guestfish.pod:154
20916 msgid "Displays general help on options."
20920 #: ../fish/guestfish.pod:158 ../libguestfs-1.11.19/fish/guestfish.pod:158
20921 msgid "B<--cmd-help>"
20925 #: ../fish/guestfish.pod:160 ../libguestfs-1.11.19/fish/guestfish.pod:160
20926 msgid "Lists all available guestfish commands."
20930 #: ../fish/guestfish.pod:162 ../libguestfs-1.11.19/fish/guestfish.pod:162
20935 #: ../fish/guestfish.pod:164 ../libguestfs-1.11.19/fish/guestfish.pod:164
20936 msgid "B<--cmd-help cmd>"
20940 #: ../fish/guestfish.pod:166 ../libguestfs-1.11.19/fish/guestfish.pod:166
20941 msgid "Displays detailed help on a single command C<cmd>."
20945 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:87
20946 #: ../libguestfs-1.11.19/fish/guestfish.pod:168
20947 #: ../libguestfs-1.11.19/fuse/guestmount.pod:87
20948 msgid "B<-a image>"
20952 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:89
20953 #: ../libguestfs-1.11.19/fish/guestfish.pod:170
20954 #: ../libguestfs-1.11.19/fuse/guestmount.pod:89
20955 msgid "B<--add image>"
20959 #: ../fish/guestfish.pod:172 ../libguestfs-1.11.19/fish/guestfish.pod:172
20960 msgid "Add a block device or virtual machine image to the shell."
20964 #: ../fish/guestfish.pod:177 ../libguestfs-1.11.19/fish/guestfish.pod:177
20966 "Using this flag is mostly equivalent to using the C<add> command, with "
20967 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
20968 "the I<--format=...> flag was given."
20972 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:100
20973 #: ../libguestfs-1.11.19/fish/guestfish.pod:185
20974 #: ../libguestfs-1.11.19/fuse/guestmount.pod:100
20976 "When used in conjunction with the I<-d> option, this specifies the libvirt "
20977 "URI to use. The default is to use the default libvirt connection."
20981 #: ../fish/guestfish.pod:189 ../libguestfs-1.11.19/fish/guestfish.pod:189
20986 #: ../fish/guestfish.pod:191 ../libguestfs-1.11.19/fish/guestfish.pod:191
20988 "If using the I<--listen> option and a csh-like shell, use this option. See "
20989 "section L</REMOTE CONTROL AND CSH> below."
20993 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:104
20994 #: ../libguestfs-1.11.19/fish/guestfish.pod:194
20995 #: ../libguestfs-1.11.19/fuse/guestmount.pod:104
20996 msgid "B<-d libvirt-domain>"
21000 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:106
21001 #: ../libguestfs-1.11.19/fish/guestfish.pod:196
21002 #: ../libguestfs-1.11.19/fuse/guestmount.pod:106
21003 msgid "B<--domain libvirt-domain>"
21007 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:108
21008 #: ../libguestfs-1.11.19/fish/guestfish.pod:198
21009 #: ../libguestfs-1.11.19/fuse/guestmount.pod:108
21011 "Add disks from the named libvirt domain. If the I<--ro> option is also "
21012 "used, then any libvirt domain can be used. However in write mode, only "
21013 "libvirt domains which are shut down can be named here."
21017 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:112
21018 #: ../libguestfs-1.11.19/fish/guestfish.pod:202
21019 #: ../libguestfs-1.11.19/fuse/guestmount.pod:112
21020 msgid "Domain UUIDs can be used instead of names."
21024 #: ../fish/guestfish.pod:204 ../libguestfs-1.11.19/fish/guestfish.pod:204
21026 "Using this flag is mostly equivalent to using the C<add-domain> command, "
21027 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
21028 "if the I<--format:...> flag was given."
21032 #: ../fish/guestfish.pod:208 ../libguestfs-1.11.19/fish/guestfish.pod:208
21037 #: ../fish/guestfish.pod:210 ../libguestfs-1.11.19/fish/guestfish.pod:210
21038 msgid "B<--no-dest-paths>"
21042 #: ../fish/guestfish.pod:212 ../libguestfs-1.11.19/fish/guestfish.pod:212
21044 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
21045 "to hit the tab key to complete paths on the guest filesystem, but this "
21046 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
21047 "allow this feature to be disabled."
21051 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:128
21052 #: ../libguestfs-1.11.19/fish/guestfish.pod:219
21053 #: ../libguestfs-1.11.19/fuse/guestmount.pod:128
21055 "When prompting for keys and passphrases, guestfish normally turns echoing "
21056 "off so you cannot see what you are typing. If you are not worried about "
21057 "Tempest attacks and there is no one else in the room you can specify this "
21058 "flag to see what you are typing."
21062 #: ../fish/guestfish.pod:224 ../libguestfs-1.11.19/fish/guestfish.pod:224
21067 #: ../fish/guestfish.pod:226 ../libguestfs-1.11.19/fish/guestfish.pod:226
21068 msgid "B<--file file>"
21072 #: ../fish/guestfish.pod:228 ../libguestfs-1.11.19/fish/guestfish.pod:228
21073 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
21077 #: ../fish/guestfish.pod:231 ../libguestfs-1.11.19/fish/guestfish.pod:231
21080 " #!/usr/bin/guestfish -f\n"
21085 #: ../fish/guestfish.pod:244 ../libguestfs-1.11.19/fish/guestfish.pod:244
21088 " guestfish --format=raw -a disk.img\n"
21093 #: ../fish/guestfish.pod:248 ../libguestfs-1.11.19/fish/guestfish.pod:248
21096 " guestfish --format=raw -a disk.img --format -a another.img\n"
21101 #: ../fish/guestfish.pod:253 ../libguestfs-1.11.19/fish/guestfish.pod:253
21103 "If you have untrusted raw-format guest disk images, you should use this "
21104 "option to specify the disk format. This avoids a possible security problem "
21105 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
21109 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:157
21110 #: ../libguestfs-1.11.19/fish/guestfish.pod:260
21111 #: ../libguestfs-1.11.19/fuse/guestmount.pod:157
21112 msgid "B<--inspector>"
21116 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:159
21117 #: ../libguestfs-1.11.19/fish/guestfish.pod:262
21118 #: ../libguestfs-1.11.19/fuse/guestmount.pod:159
21120 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
21121 "system and mount filesystems as they would be mounted on the real virtual "
21126 #: ../fish/guestfish.pod:266 ../libguestfs-1.11.19/fish/guestfish.pod:266
21127 msgid "Typical usage is either:"
21131 #: ../fish/guestfish.pod:268 ../libguestfs-1.11.19/fish/guestfish.pod:268
21134 " guestfish -d myguest -i\n"
21139 #: ../fish/guestfish.pod:270 ../libguestfs-1.11.19/fish/guestfish.pod:270
21140 msgid "(for an inactive libvirt domain called I<myguest>), or:"
21144 #: ../fish/guestfish.pod:272 ../libguestfs-1.11.19/fish/guestfish.pod:272
21147 " guestfish --ro -d myguest -i\n"
21152 #: ../fish/guestfish.pod:274 ../libguestfs-1.11.19/fish/guestfish.pod:274
21153 msgid "(for active domains, readonly), or specify the block device directly:"
21157 #: ../fish/guestfish.pod:276 ../libguestfs-1.11.19/fish/guestfish.pod:276
21160 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
21165 #: ../fish/guestfish.pod:278 ../libguestfs-1.11.19/fish/guestfish.pod:278
21167 "Note that the command line syntax changed slightly over older versions of "
21168 "guestfish. You can still use the old syntax:"
21172 #: ../fish/guestfish.pod:281 ../libguestfs-1.11.19/fish/guestfish.pod:281
21175 " guestfish [--ro] -i disk.img\n"
21180 #: ../fish/guestfish.pod:283 ../libguestfs-1.11.19/fish/guestfish.pod:283
21183 " guestfish [--ro] -i libvirt-domain\n"
21188 #: ../fish/guestfish.pod:285 ../libguestfs-1.11.19/fish/guestfish.pod:285
21190 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
21191 "then using other commands to mount the filesystems that were found."
21195 #: ../fish/guestfish.pod:294 ../libguestfs-1.11.19/fish/guestfish.pod:294
21196 msgid "B<--listen>"
21200 #: ../fish/guestfish.pod:296 ../libguestfs-1.11.19/fish/guestfish.pod:296
21202 "Fork into the background and listen for remote commands. See section L</"
21203 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
21207 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:168
21208 #: ../libguestfs-1.11.19/fish/guestfish.pod:299
21209 #: ../libguestfs-1.11.19/fuse/guestmount.pod:168
21214 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:170
21215 #: ../libguestfs-1.11.19/fish/guestfish.pod:301
21216 #: ../libguestfs-1.11.19/fuse/guestmount.pod:170
21218 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
21219 "ATTACHING TO RUNNING DAEMONS>)."
21223 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:173
21224 #: ../libguestfs-1.11.19/fish/guestfish.pod:304
21225 #: ../libguestfs-1.11.19/fuse/guestmount.pod:173
21226 msgid "B<-m dev[:mountpoint[:options]]>"
21230 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:175
21231 #: ../libguestfs-1.11.19/fish/guestfish.pod:306
21232 #: ../libguestfs-1.11.19/fuse/guestmount.pod:175
21233 msgid "B<--mount dev[:mountpoint[:options]]>"
21237 #: ../fish/guestfish.pod:308 ../libguestfs-1.11.19/fish/guestfish.pod:308
21238 msgid "Mount the named partition or logical volume on the given mountpoint."
21242 #: ../fish/guestfish.pod:310 ../libguestfs-1.11.19/fish/guestfish.pod:310
21243 msgid "If the mountpoint is omitted, it defaults to C</>."
21247 #: ../fish/guestfish.pod:312 ../libguestfs-1.11.19/fish/guestfish.pod:312
21248 msgid "You have to mount something on C</> before most commands will work."
21252 #: ../fish/guestfish.pod:314 ../libguestfs-1.11.19/fish/guestfish.pod:314
21254 "If any I<-m> or I<--mount> options are given, the guest is automatically "
21259 #: ../fish/guestfish.pod:317 ../libguestfs-1.11.19/fish/guestfish.pod:317
21261 "If you don't know what filesystems a disk image contains, you can either run "
21262 "guestfish without this option, then list the partitions, filesystems and LVs "
21263 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
21264 "commands), or you can use the L<virt-filesystems(1)> program."
21268 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:183
21269 #: ../libguestfs-1.11.19/fish/guestfish.pod:323
21270 #: ../libguestfs-1.11.19/fuse/guestmount.pod:183
21272 "The third (and rarely used) part of the mount parameter is the list of mount "
21273 "options used to mount the underlying filesystem. If this is not given, then "
21274 "the mount options are either the empty string or C<ro> (the latter if the "
21275 "I<--ro> flag is used). By specifying the mount options, you override this "
21276 "default choice. Probably the only time you would use this is to enable ACLs "
21277 "and/or extended attributes if the filesystem can support them:"
21281 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:191
21282 #: ../libguestfs-1.11.19/fish/guestfish.pod:331
21283 #: ../libguestfs-1.11.19/fuse/guestmount.pod:191
21286 " -m /dev/sda1:/:acl,user_xattr\n"
21291 #: ../fish/guestfish.pod:333 ../libguestfs-1.11.19/fish/guestfish.pod:333
21292 msgid "Using this flag is equivalent to using the C<mount-options> command."
21296 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:193
21297 #: ../libguestfs-1.11.19/fish/guestfish.pod:335
21298 #: ../libguestfs-1.11.19/fuse/guestmount.pod:193
21299 #: ../libguestfs-1.11.19/resize/virt-resize.pod:352
21300 #: ../resize/virt-resize.pod:352
21305 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:195
21306 #: ../libguestfs-1.11.19/fish/guestfish.pod:337
21307 #: ../libguestfs-1.11.19/fuse/guestmount.pod:195
21308 msgid "B<--no-sync>"
21312 #: ../fish/guestfish.pod:339 ../libguestfs-1.11.19/fish/guestfish.pod:339
21314 "Disable autosync. This is enabled by default. See the discussion of "
21315 "autosync in the L<guestfs(3)> manpage."
21319 #: ../fish/guestfish.pod:342 ../libguestfs-1.11.19/fish/guestfish.pod:342
21324 #: ../fish/guestfish.pod:344 ../libguestfs-1.11.19/fish/guestfish.pod:344
21325 msgid "B<--new type>"
21329 #: ../fish/guestfish.pod:346 ../libguestfs-1.11.19/fish/guestfish.pod:346
21334 #: ../fish/guestfish.pod:348 ../libguestfs-1.11.19/fish/guestfish.pod:348
21336 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
21337 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
21338 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
21343 #: ../fish/guestfish.pod:353 ../libguestfs-1.11.19/fish/guestfish.pod:353
21344 msgid "B<--progress-bars>"
21348 #: ../fish/guestfish.pod:355 ../libguestfs-1.11.19/fish/guestfish.pod:355
21349 msgid "Enable progress bars, even when guestfish is used non-interactively."
21353 #: ../fish/guestfish.pod:357 ../libguestfs-1.11.19/fish/guestfish.pod:357
21355 "Progress bars are enabled by default when guestfish is used as an "
21356 "interactive shell."
21360 #: ../fish/guestfish.pod:360 ../libguestfs-1.11.19/fish/guestfish.pod:360
21361 msgid "B<--no-progress-bars>"
21365 #: ../fish/guestfish.pod:362 ../libguestfs-1.11.19/fish/guestfish.pod:362
21366 msgid "Disable progress bars."
21370 #: ../fish/guestfish.pod:364 ../libguestfs-1.11.19/fish/guestfish.pod:364
21371 msgid "B<--remote[=pid]>"
21375 #: ../fish/guestfish.pod:366 ../libguestfs-1.11.19/fish/guestfish.pod:366
21377 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
21378 "CONTROL GUESTFISH OVER A SOCKET> below."
21382 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:239
21383 #: ../libguestfs-1.11.19/fish/guestfish.pod:369
21384 #: ../libguestfs-1.11.19/fuse/guestmount.pod:239
21385 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:161
21386 #: ../rescue/virt-rescue.pod:161
21391 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:241
21392 #: ../libguestfs-1.11.19/fish/guestfish.pod:371
21393 #: ../libguestfs-1.11.19/fuse/guestmount.pod:241
21394 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:163
21395 #: ../rescue/virt-rescue.pod:163
21400 #: ../fish/guestfish.pod:373 ../libguestfs-1.11.19/fish/guestfish.pod:373
21402 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
21403 "mounts are done read-only."
21407 #: ../fish/guestfish.pod:376 ../libguestfs-1.11.19/fish/guestfish.pod:376
21408 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:167
21409 #: ../rescue/virt-rescue.pod:167
21411 "The option must always be used if the disk image or virtual machine might be "
21412 "running, and is generally recommended in cases where you don't need write "
21413 "access to the disk."
21417 #: ../fish/guestfish.pod:380 ../libguestfs-1.11.19/fish/guestfish.pod:380
21419 "Note that prepared disk images created with I<-N> are not affected by this "
21420 "option. Also commands like C<add> are not affected - you have to specify "
21421 "the C<readonly:true> option explicitly if you need it."
21425 #: ../fish/guestfish.pod:384 ../libguestfs-1.11.19/fish/guestfish.pod:384
21426 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
21430 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:253
21431 #: ../libguestfs-1.11.19/fish/guestfish.pod:386
21432 #: ../libguestfs-1.11.19/fuse/guestmount.pod:253
21433 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:173
21434 #: ../rescue/virt-rescue.pod:173
21435 msgid "B<--selinux>"
21439 #: ../fish/guestfish.pod:388 ../libguestfs-1.11.19/fish/guestfish.pod:388
21440 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
21444 #: ../fish/guestfish.pod:394 ../libguestfs-1.11.19/fish/guestfish.pod:394
21446 "Enable very verbose messages. This is particularly useful if you find a bug."
21450 #: ../fish/guestfish.pod:401 ../libguestfs-1.11.19/fish/guestfish.pod:401
21451 msgid "Display the guestfish / libguestfs version number and exit."
21455 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:269
21456 #: ../libguestfs-1.11.19/fish/guestfish.pod:403
21457 #: ../libguestfs-1.11.19/fuse/guestmount.pod:269
21458 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:190
21459 #: ../rescue/virt-rescue.pod:190
21464 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:271
21465 #: ../libguestfs-1.11.19/fish/guestfish.pod:405
21466 #: ../libguestfs-1.11.19/fuse/guestmount.pod:271
21467 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:192
21468 #: ../rescue/virt-rescue.pod:192
21473 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:273
21474 #: ../libguestfs-1.11.19/fish/guestfish.pod:407
21475 #: ../libguestfs-1.11.19/fuse/guestmount.pod:273
21477 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
21478 "mounts are done read-write."
21482 #: ../fish/guestfish.pod:410 ../libguestfs-1.11.19/fish/guestfish.pod:410
21483 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
21487 #: ../fish/guestfish.pod:414 ../libguestfs-1.11.19/fish/guestfish.pod:414
21488 msgid "Echo each command before executing it."
21492 #: ../fish/guestfish.pod:418 ../libguestfs-1.11.19/fish/guestfish.pod:418
21493 msgid "COMMANDS ON COMMAND LINE"
21497 #: ../fish/guestfish.pod:420 ../libguestfs-1.11.19/fish/guestfish.pod:420
21499 "Any additional (non-option) arguments are treated as commands to execute."
21503 #: ../fish/guestfish.pod:423 ../libguestfs-1.11.19/fish/guestfish.pod:423
21505 "Commands to execute should be separated by a colon (C<:>), where the colon "
21506 "is a separate parameter. Thus:"
21510 #: ../fish/guestfish.pod:426 ../libguestfs-1.11.19/fish/guestfish.pod:426
21513 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
21518 #: ../fish/guestfish.pod:428 ../libguestfs-1.11.19/fish/guestfish.pod:428
21520 "If there are no additional arguments, then we enter a shell, either an "
21521 "interactive shell with a prompt (if the input is a terminal) or a non-"
21522 "interactive shell."
21526 #: ../fish/guestfish.pod:432 ../libguestfs-1.11.19/fish/guestfish.pod:432
21528 "In either command line mode or non-interactive shell, the first command that "
21529 "gives an error causes the whole shell to exit. In interactive mode (with a "
21530 "prompt) if a command fails, you can continue to enter commands."
21534 #: ../fish/guestfish.pod:437 ../libguestfs-1.11.19/fish/guestfish.pod:437
21535 msgid "USING launch (OR run)"
21539 #: ../fish/guestfish.pod:439 ../libguestfs-1.11.19/fish/guestfish.pod:439
21541 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
21542 "then launch it, then mount any disks you need, and finally issue actions/"
21543 "commands. So the general order of the day is:"
21547 #: ../fish/guestfish.pod:447 ../libguestfs-1.11.19/fish/guestfish.pod:447
21548 msgid "add or -a/--add"
21552 #: ../fish/guestfish.pod:451 ../libguestfs-1.11.19/fish/guestfish.pod:451
21553 msgid "launch (aka run)"
21557 #: ../fish/guestfish.pod:455 ../libguestfs-1.11.19/fish/guestfish.pod:455
21558 msgid "mount or -m/--mount"
21562 #: ../fish/guestfish.pod:459 ../libguestfs-1.11.19/fish/guestfish.pod:459
21563 msgid "any other commands"
21567 #: ../fish/guestfish.pod:463 ../libguestfs-1.11.19/fish/guestfish.pod:463
21569 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
21570 "guest before mounting or performing any other commands."
21574 #: ../fish/guestfish.pod:466 ../libguestfs-1.11.19/fish/guestfish.pod:466
21576 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
21577 "I<--new> options were given then C<run> is done automatically, simply "
21578 "because guestfish can't perform the action you asked for without doing this."
21582 #: ../fish/guestfish.pod:471 ../libguestfs-1.11.19/fish/guestfish.pod:471
21583 msgid "OPENING DISKS FOR READ AND WRITE"
21587 #: ../fish/guestfish.pod:473 ../libguestfs-1.11.19/fish/guestfish.pod:473
21589 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
21590 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
21591 "I<-i> and I<-m> open disk images read-only or for writing."
21595 #: ../fish/guestfish.pod:478 ../libguestfs-1.11.19/fish/guestfish.pod:478
21597 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
21598 "opening disk images supplied on the command line for write. To open a disk "
21599 "image read-only you have to do I<-a image --ro>."
21603 #: ../fish/guestfish.pod:482 ../libguestfs-1.11.19/fish/guestfish.pod:482
21605 "This matters: If you accidentally open a live VM disk image writable then "
21606 "you will cause irreversible disk corruption."
21610 #: ../fish/guestfish.pod:485 ../libguestfs-1.11.19/fish/guestfish.pod:485
21612 "In a future libguestfs we intend to change the default the other way. Disk "
21613 "images will be opened read-only. You will have to either specify "
21614 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
21615 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
21616 "access for disk images specified by those other command line options."
21620 #: ../fish/guestfish.pod:492 ../libguestfs-1.11.19/fish/guestfish.pod:492
21622 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
21623 "which does nothing (it is already the default). However it is highly "
21624 "recommended that you use this option to indicate that you need write access, "
21625 "and prepare your scripts for the day when this option will be required for "
21630 #: ../fish/guestfish.pod:498 ../libguestfs-1.11.19/fish/guestfish.pod:498
21632 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
21633 "other libguestfs program apart from guestfish and guestmount."
21637 #: ../fish/guestfish.pod:501 ../libguestfs-1.11.19/fish/guestfish.pod:501
21642 #: ../fish/guestfish.pod:503 ../libguestfs-1.11.19/fish/guestfish.pod:503
21644 "You can quote ordinary parameters using either single or double quotes. For "
21649 #: ../fish/guestfish.pod:506 ../libguestfs-1.11.19/fish/guestfish.pod:506
21652 " add \"file with a space.img\"\n"
21657 #: ../fish/guestfish.pod:508 ../libguestfs-1.11.19/fish/guestfish.pod:508
21660 " rm '/file name'\n"
21665 #: ../fish/guestfish.pod:510 ../libguestfs-1.11.19/fish/guestfish.pod:510
21673 #: ../fish/guestfish.pod:512 ../libguestfs-1.11.19/fish/guestfish.pod:512
21675 "A few commands require a list of strings to be passed. For these, use a "
21676 "whitespace-separated list, enclosed in quotes. Strings containing "
21677 "whitespace to be passed through must be enclosed in single quotes. A "
21678 "literal single quote must be escaped with a backslash."
21682 #: ../fish/guestfish.pod:517 ../libguestfs-1.11.19/fish/guestfish.pod:517
21685 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
21686 " command \"/bin/echo 'foo bar'\"\n"
21687 " command \"/bin/echo \\'foo\\'\"\n"
21692 #: ../fish/guestfish.pod:521 ../libguestfs-1.11.19/fish/guestfish.pod:521
21693 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
21697 #: ../fish/guestfish.pod:523 ../libguestfs-1.11.19/fish/guestfish.pod:523
21699 "In double-quoted arguments (only) use backslash to insert special characters:"
21703 #: ../fish/guestfish.pod:528 ../libguestfs-1.11.19/fish/guestfish.pod:528
21708 #: ../fish/guestfish.pod:530 ../libguestfs-1.11.19/fish/guestfish.pod:530
21709 msgid "Alert (bell) character."
21713 #: ../fish/guestfish.pod:532 ../libguestfs-1.11.19/fish/guestfish.pod:532
21718 #: ../fish/guestfish.pod:534 ../libguestfs-1.11.19/fish/guestfish.pod:534
21719 msgid "Backspace character."
21723 #: ../fish/guestfish.pod:536 ../libguestfs-1.11.19/fish/guestfish.pod:536
21728 #: ../fish/guestfish.pod:538 ../libguestfs-1.11.19/fish/guestfish.pod:538
21729 msgid "Form feed character."
21733 #: ../fish/guestfish.pod:540 ../libguestfs-1.11.19/fish/guestfish.pod:540
21738 #: ../fish/guestfish.pod:542 ../libguestfs-1.11.19/fish/guestfish.pod:542
21739 msgid "Newline character."
21743 #: ../fish/guestfish.pod:544 ../libguestfs-1.11.19/fish/guestfish.pod:544
21748 #: ../fish/guestfish.pod:546 ../libguestfs-1.11.19/fish/guestfish.pod:546
21749 msgid "Carriage return character."
21753 #: ../fish/guestfish.pod:548 ../libguestfs-1.11.19/fish/guestfish.pod:548
21758 #: ../fish/guestfish.pod:550 ../libguestfs-1.11.19/fish/guestfish.pod:550
21759 msgid "Horizontal tab character."
21763 #: ../fish/guestfish.pod:552 ../libguestfs-1.11.19/fish/guestfish.pod:552
21768 #: ../fish/guestfish.pod:554 ../libguestfs-1.11.19/fish/guestfish.pod:554
21769 msgid "Vertical tab character."
21773 #: ../fish/guestfish.pod:556 ../libguestfs-1.11.19/fish/guestfish.pod:556
21778 #: ../fish/guestfish.pod:558 ../libguestfs-1.11.19/fish/guestfish.pod:558
21779 msgid "A literal double quote character."
21783 #: ../fish/guestfish.pod:560 ../libguestfs-1.11.19/fish/guestfish.pod:560
21788 #: ../fish/guestfish.pod:562 ../libguestfs-1.11.19/fish/guestfish.pod:562
21790 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
21795 #: ../fish/guestfish.pod:565 ../libguestfs-1.11.19/fish/guestfish.pod:565
21800 #: ../fish/guestfish.pod:567 ../libguestfs-1.11.19/fish/guestfish.pod:567
21802 "A character with hex value I<hh>. There must be precisely 2 hex digits."
21806 #: ../fish/guestfish.pod:570 ../libguestfs-1.11.19/fish/guestfish.pod:570
21808 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
21813 #: ../fish/guestfish.pod:573 ../libguestfs-1.11.19/fish/guestfish.pod:573
21818 #: ../fish/guestfish.pod:575 ../libguestfs-1.11.19/fish/guestfish.pod:575
21819 msgid "A literal backslash character."
21823 #: ../fish/guestfish.pod:579 ../libguestfs-1.11.19/fish/guestfish.pod:579
21824 msgid "OPTIONAL ARGUMENTS"
21828 #: ../fish/guestfish.pod:581 ../libguestfs-1.11.19/fish/guestfish.pod:581
21830 "Some commands take optional arguments. These arguments appear in this "
21831 "documentation as C<[argname:..]>. You can use them as in these examples:"
21835 #: ../fish/guestfish.pod:585 ../libguestfs-1.11.19/fish/guestfish.pod:585
21838 " add-drive-opts filename\n"
21843 #: ../fish/guestfish.pod:587 ../libguestfs-1.11.19/fish/guestfish.pod:587
21846 " add-drive-opts filename readonly:true\n"
21851 #: ../fish/guestfish.pod:589 ../libguestfs-1.11.19/fish/guestfish.pod:589
21854 " add-drive-opts filename format:qcow2 readonly:false\n"
21859 #: ../fish/guestfish.pod:591 ../libguestfs-1.11.19/fish/guestfish.pod:591
21861 "Each optional argument can appear at most once. All optional arguments must "
21862 "appear after the required ones."
21866 #: ../fish/guestfish.pod:594 ../libguestfs-1.11.19/fish/guestfish.pod:594
21871 #: ../fish/guestfish.pod:596 ../libguestfs-1.11.19/fish/guestfish.pod:596
21873 "This section applies to all commands which can take integers as parameters."
21877 #: ../fish/guestfish.pod:599 ../libguestfs-1.11.19/fish/guestfish.pod:599
21878 msgid "SIZE SUFFIX"
21882 #: ../fish/guestfish.pod:601 ../libguestfs-1.11.19/fish/guestfish.pod:601
21884 "When the command takes a parameter measured in bytes, you can use one of the "
21885 "following suffixes to specify kilobytes, megabytes and larger sizes:"
21889 #: ../fish/guestfish.pod:607 ../libguestfs-1.11.19/fish/guestfish.pod:607
21890 msgid "B<k> or B<K> or B<KiB>"
21894 #: ../fish/guestfish.pod:609 ../libguestfs-1.11.19/fish/guestfish.pod:609
21895 msgid "The size in kilobytes (multiplied by 1024)."
21899 #: ../fish/guestfish.pod:611 ../libguestfs-1.11.19/fish/guestfish.pod:611
21904 #: ../fish/guestfish.pod:613 ../libguestfs-1.11.19/fish/guestfish.pod:613
21905 msgid "The size in SI 1000 byte units."
21909 #: ../fish/guestfish.pod:615 ../libguestfs-1.11.19/fish/guestfish.pod:615
21910 msgid "B<M> or B<MiB>"
21914 #: ../fish/guestfish.pod:617 ../libguestfs-1.11.19/fish/guestfish.pod:617
21915 msgid "The size in megabytes (multiplied by 1048576)."
21919 #: ../fish/guestfish.pod:619 ../libguestfs-1.11.19/fish/guestfish.pod:619
21924 #: ../fish/guestfish.pod:621 ../libguestfs-1.11.19/fish/guestfish.pod:621
21925 msgid "The size in SI 1000000 byte units."
21929 #: ../fish/guestfish.pod:623 ../libguestfs-1.11.19/fish/guestfish.pod:623
21930 msgid "B<G> or B<GiB>"
21934 #: ../fish/guestfish.pod:625 ../libguestfs-1.11.19/fish/guestfish.pod:625
21935 msgid "The size in gigabytes (multiplied by 2**30)."
21939 #: ../fish/guestfish.pod:627 ../libguestfs-1.11.19/fish/guestfish.pod:627
21944 #: ../fish/guestfish.pod:629 ../libguestfs-1.11.19/fish/guestfish.pod:629
21945 msgid "The size in SI 10**9 byte units."
21949 #: ../fish/guestfish.pod:631 ../libguestfs-1.11.19/fish/guestfish.pod:631
21950 msgid "B<T> or B<TiB>"
21954 #: ../fish/guestfish.pod:633 ../libguestfs-1.11.19/fish/guestfish.pod:633
21955 msgid "The size in terabytes (multiplied by 2**40)."
21959 #: ../fish/guestfish.pod:635 ../libguestfs-1.11.19/fish/guestfish.pod:635
21964 #: ../fish/guestfish.pod:637 ../libguestfs-1.11.19/fish/guestfish.pod:637
21965 msgid "The size in SI 10**12 byte units."
21969 #: ../fish/guestfish.pod:639 ../libguestfs-1.11.19/fish/guestfish.pod:639
21970 msgid "B<P> or B<PiB>"
21974 #: ../fish/guestfish.pod:641 ../libguestfs-1.11.19/fish/guestfish.pod:641
21975 msgid "The size in petabytes (multiplied by 2**50)."
21979 #: ../fish/guestfish.pod:643 ../libguestfs-1.11.19/fish/guestfish.pod:643
21984 #: ../fish/guestfish.pod:645 ../libguestfs-1.11.19/fish/guestfish.pod:645
21985 msgid "The size in SI 10**15 byte units."
21989 #: ../fish/guestfish.pod:647 ../libguestfs-1.11.19/fish/guestfish.pod:647
21990 msgid "B<E> or B<EiB>"
21994 #: ../fish/guestfish.pod:649 ../libguestfs-1.11.19/fish/guestfish.pod:649
21995 msgid "The size in exabytes (multiplied by 2**60)."
21999 #: ../fish/guestfish.pod:651 ../libguestfs-1.11.19/fish/guestfish.pod:651
22004 #: ../fish/guestfish.pod:653 ../libguestfs-1.11.19/fish/guestfish.pod:653
22005 msgid "The size in SI 10**18 byte units."
22009 #: ../fish/guestfish.pod:655 ../libguestfs-1.11.19/fish/guestfish.pod:655
22010 msgid "B<Z> or B<ZiB>"
22014 #: ../fish/guestfish.pod:657 ../libguestfs-1.11.19/fish/guestfish.pod:657
22015 msgid "The size in zettabytes (multiplied by 2**70)."
22019 #: ../fish/guestfish.pod:659 ../libguestfs-1.11.19/fish/guestfish.pod:659
22024 #: ../fish/guestfish.pod:661 ../libguestfs-1.11.19/fish/guestfish.pod:661
22025 msgid "The size in SI 10**21 byte units."
22029 #: ../fish/guestfish.pod:663 ../libguestfs-1.11.19/fish/guestfish.pod:663
22030 msgid "B<Y> or B<YiB>"
22034 #: ../fish/guestfish.pod:665 ../libguestfs-1.11.19/fish/guestfish.pod:665
22035 msgid "The size in yottabytes (multiplied by 2**80)."
22039 #: ../fish/guestfish.pod:667 ../libguestfs-1.11.19/fish/guestfish.pod:667
22044 #: ../fish/guestfish.pod:669 ../libguestfs-1.11.19/fish/guestfish.pod:669
22045 msgid "The size in SI 10**24 byte units."
22049 #: ../fish/guestfish.pod:675 ../libguestfs-1.11.19/fish/guestfish.pod:675
22052 " truncate-size /file 1G\n"
22057 #: ../fish/guestfish.pod:677 ../libguestfs-1.11.19/fish/guestfish.pod:677
22058 msgid "would truncate the file to 1 gigabyte."
22062 #: ../fish/guestfish.pod:679 ../libguestfs-1.11.19/fish/guestfish.pod:679
22064 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
22065 "the parameter to L</memsize> is specified in megabytes already). Adding a "
22066 "suffix will probably not do what you expect."
22070 #: ../fish/guestfish.pod:683 ../libguestfs-1.11.19/fish/guestfish.pod:683
22071 msgid "OCTAL AND HEXADECIMAL NUMBERS"
22075 #: ../fish/guestfish.pod:685 ../libguestfs-1.11.19/fish/guestfish.pod:685
22077 "For specifying the radix (base) use the C convention: C<0> to prefix an "
22078 "octal number or C<0x> to prefix a hexadecimal number. For example:"
22082 #: ../fish/guestfish.pod:688 ../libguestfs-1.11.19/fish/guestfish.pod:688
22085 " 1234 decimal number 1234\n"
22086 " 02322 octal number, equivalent to decimal 1234\n"
22087 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
22092 #: ../fish/guestfish.pod:692 ../libguestfs-1.11.19/fish/guestfish.pod:692
22094 "When using the C<chmod> command, you almost always want to specify an octal "
22095 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
22096 "L<chmod(1)> program):"
22100 #: ../fish/guestfish.pod:696 ../libguestfs-1.11.19/fish/guestfish.pod:696
22103 " chmod 0777 /public # OK\n"
22104 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
22109 #: ../fish/guestfish.pod:699 ../libguestfs-1.11.19/fish/guestfish.pod:699
22111 "Commands that return numbers usually print them in decimal, but some "
22112 "commands print numbers in other radices (eg. C<umask> prints the mode in "
22113 "octal, preceeded by C<0>)."
22117 #: ../fish/guestfish.pod:703 ../libguestfs-1.11.19/fish/guestfish.pod:703
22118 msgid "WILDCARDS AND GLOBBING"
22122 #: ../fish/guestfish.pod:705 ../libguestfs-1.11.19/fish/guestfish.pod:705
22124 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
22125 "(globbing) by default. So for example the following will not do what you "
22130 #: ../fish/guestfish.pod:709 ../libguestfs-1.11.19/fish/guestfish.pod:709
22138 #: ../fish/guestfish.pod:711 ../libguestfs-1.11.19/fish/guestfish.pod:711
22140 "Assuming you don't have a directory called literally C</home/*> then the "
22141 "above command will return an error."
22145 #: ../fish/guestfish.pod:714 ../libguestfs-1.11.19/fish/guestfish.pod:714
22146 msgid "To perform wildcard expansion, use the C<glob> command."
22150 #: ../fish/guestfish.pod:716 ../libguestfs-1.11.19/fish/guestfish.pod:716
22153 " glob rm-rf /home/*\n"
22158 #: ../fish/guestfish.pod:718 ../libguestfs-1.11.19/fish/guestfish.pod:718
22160 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
22161 "many times), equivalent to:"
22165 #: ../fish/guestfish.pod:721 ../libguestfs-1.11.19/fish/guestfish.pod:721
22168 " rm-rf /home/jim\n"
22169 " rm-rf /home/joe\n"
22170 " rm-rf /home/mary\n"
22175 #: ../fish/guestfish.pod:725 ../libguestfs-1.11.19/fish/guestfish.pod:725
22176 msgid "C<glob> only works on simple guest paths and not on device names."
22180 #: ../fish/guestfish.pod:727 ../libguestfs-1.11.19/fish/guestfish.pod:727
22182 "If you have several parameters, each containing a wildcard, then glob will "
22183 "perform a Cartesian product."
22187 #: ../fish/guestfish.pod:730 ../libguestfs-1.11.19/fish/guestfish.pod:730
22192 #: ../fish/guestfish.pod:732 ../libguestfs-1.11.19/fish/guestfish.pod:732
22194 "Any line which starts with a I<#> character is treated as a comment and "
22195 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
22196 "a command. For example:"
22200 #: ../fish/guestfish.pod:736 ../libguestfs-1.11.19/fish/guestfish.pod:736
22203 " # this is a comment\n"
22204 " # this is a comment\n"
22205 " foo # NOT a comment\n"
22210 #: ../fish/guestfish.pod:740 ../libguestfs-1.11.19/fish/guestfish.pod:740
22211 msgid "Blank lines are also ignored."
22215 #: ../fish/guestfish.pod:742 ../libguestfs-1.11.19/fish/guestfish.pod:742
22216 msgid "RUNNING COMMANDS LOCALLY"
22220 #: ../fish/guestfish.pod:744 ../libguestfs-1.11.19/fish/guestfish.pod:744
22222 "Any line which starts with a I<!> character is treated as a command sent to "
22223 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
22227 #: ../fish/guestfish.pod:748 ../libguestfs-1.11.19/fish/guestfish.pod:748
22231 " tgz-out /remote local/remote-data.tar.gz\n"
22236 #: ../fish/guestfish.pod:751 ../libguestfs-1.11.19/fish/guestfish.pod:751
22238 "will create a directory C<local> on the host, and then export the contents "
22239 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
22240 "(See C<tgz-out>)."
22244 #: ../fish/guestfish.pod:755 ../libguestfs-1.11.19/fish/guestfish.pod:755
22246 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
22247 "effect, due to the way that subprocesses work in Unix."
22251 #: ../fish/guestfish.pod:758 ../libguestfs-1.11.19/fish/guestfish.pod:758
22252 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
22256 #: ../fish/guestfish.pod:760 ../libguestfs-1.11.19/fish/guestfish.pod:760
22258 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
22259 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
22260 "and executed as guestfish commands."
22264 #: ../fish/guestfish.pod:764 ../libguestfs-1.11.19/fish/guestfish.pod:764
22266 "Thus you can use shell script to construct arbitrary guestfish commands "
22267 "which are then parsed by guestfish."
22271 #: ../fish/guestfish.pod:767 ../libguestfs-1.11.19/fish/guestfish.pod:767
22273 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
22274 "through C</foo.100>) using guestfish commands alone. However this is simple "
22275 "if we use a shell script to create the guestfish commands for us:"
22279 #: ../fish/guestfish.pod:772 ../libguestfs-1.11.19/fish/guestfish.pod:772
22282 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
22287 #: ../fish/guestfish.pod:774 ../libguestfs-1.11.19/fish/guestfish.pod:774
22288 msgid "or with names like C</foo.001>:"
22292 #: ../fish/guestfish.pod:776 ../libguestfs-1.11.19/fish/guestfish.pod:776
22295 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
22300 #: ../fish/guestfish.pod:778 ../libguestfs-1.11.19/fish/guestfish.pod:778
22302 "When using guestfish interactively it can be helpful to just run the shell "
22303 "script first (ie. remove the initial C<E<lt>> character so it is just an "
22304 "ordinary I<!> local command), see what guestfish commands it would run, and "
22305 "when you are happy with those prepend the C<E<lt>> character to run the "
22306 "guestfish commands for real."
22310 #: ../fish/guestfish.pod:784 ../libguestfs-1.11.19/fish/guestfish.pod:784
22315 #: ../fish/guestfish.pod:786 ../libguestfs-1.11.19/fish/guestfish.pod:786
22317 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
22318 "command (a guestfish command) to the second command (any host command). For "
22323 #: ../fish/guestfish.pod:790 ../libguestfs-1.11.19/fish/guestfish.pod:790
22326 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
22331 #: ../fish/guestfish.pod:792 ../libguestfs-1.11.19/fish/guestfish.pod:792
22333 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
22334 "program). The above command would list all accounts in the guest filesystem "
22335 "which have UID 0, ie. root accounts including backdoors. Other examples:"
22339 #: ../fish/guestfish.pod:797 ../libguestfs-1.11.19/fish/guestfish.pod:797
22342 " hexdump /bin/ls | head\n"
22343 " list-devices | tail -1\n"
22344 " tgz-out / - | tar ztf -\n"
22349 #: ../fish/guestfish.pod:801 ../libguestfs-1.11.19/fish/guestfish.pod:801
22351 "The space before the pipe symbol is required, any space after the pipe "
22352 "symbol is optional. Everything after the pipe symbol is just passed "
22353 "straight to the host shell, so it can contain redirections, globs and "
22354 "anything else that makes sense on the host side."
22358 #: ../fish/guestfish.pod:806 ../libguestfs-1.11.19/fish/guestfish.pod:806
22360 "To use a literal argument which begins with a pipe symbol, you have to quote "
22365 #: ../fish/guestfish.pod:809 ../libguestfs-1.11.19/fish/guestfish.pod:809
22373 #: ../fish/guestfish.pod:811 ../libguestfs-1.11.19/fish/guestfish.pod:811
22374 msgid "HOME DIRECTORIES"
22378 #: ../fish/guestfish.pod:813 ../libguestfs-1.11.19/fish/guestfish.pod:813
22380 "If a parameter starts with the character C<~> then the tilde may be expanded "
22381 "as a home directory path (either C<~> for the current user's home directory, "
22382 "or C<~user> for another user)."
22386 #: ../fish/guestfish.pod:817 ../libguestfs-1.11.19/fish/guestfish.pod:817
22388 "Note that home directory expansion happens for users known I<on the host>, "
22389 "not in the guest filesystem."
22393 #: ../fish/guestfish.pod:820 ../libguestfs-1.11.19/fish/guestfish.pod:820
22395 "To use a literal argument which begins with a tilde, you have to quote it, "
22400 #: ../fish/guestfish.pod:823 ../libguestfs-1.11.19/fish/guestfish.pod:823
22408 #: ../fish/guestfish.pod:825 ../libguestfs-1.11.19/fish/guestfish.pod:825
22409 #: ../libguestfs-1.11.19/src/guestfs.pod:519 ../src/guestfs.pod:519
22410 msgid "ENCRYPTED DISKS"
22414 #: ../fish/guestfish.pod:827 ../libguestfs-1.11.19/fish/guestfish.pod:827
22416 "Libguestfs has some support for Linux guests encrypted according to the "
22417 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
22418 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
22419 "LUKS is supported."
22423 #: ../fish/guestfish.pod:832 ../libguestfs-1.11.19/fish/guestfish.pod:832
22424 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
22428 #: ../fish/guestfish.pod:834 ../libguestfs-1.11.19/fish/guestfish.pod:834
22431 " ><fs> vfs-type /dev/sda2\n"
22437 #: ../fish/guestfish.pod:837 ../libguestfs-1.11.19/fish/guestfish.pod:837
22439 "Then open those devices using L</luks-open>. This creates a device-mapper "
22440 "device called C</dev/mapper/luksdev>."
22444 #: ../fish/guestfish.pod:840 ../libguestfs-1.11.19/fish/guestfish.pod:840
22447 " ><fs> luks-open /dev/sda2 luksdev\n"
22448 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
22453 #: ../fish/guestfish.pod:843 ../libguestfs-1.11.19/fish/guestfish.pod:843
22455 "Finally you have to tell LVM to scan for volume groups on the newly created "
22460 #: ../fish/guestfish.pod:846 ../libguestfs-1.11.19/fish/guestfish.pod:846
22464 " vg-activate-all true\n"
22469 #: ../fish/guestfish.pod:849 ../libguestfs-1.11.19/fish/guestfish.pod:849
22470 msgid "The logical volume(s) can now be mounted in the usual way."
22474 #: ../fish/guestfish.pod:851 ../libguestfs-1.11.19/fish/guestfish.pod:851
22476 "Before closing a LUKS device you must unmount any logical volumes on it and "
22477 "deactivate the volume groups by calling C<vg-activate false VG> on each "
22478 "one. Then you can close the mapper device:"
22482 #: ../fish/guestfish.pod:855 ../libguestfs-1.11.19/fish/guestfish.pod:855
22485 " vg-activate false /dev/VG\n"
22486 " luks-close /dev/mapper/luksdev\n"
22491 #: ../fish/guestfish.pod:860 ../libguestfs-1.11.19/fish/guestfish.pod:860
22493 "If a path is prefixed with C<win:> then you can use Windows-style drive "
22494 "letters and paths (with some limitations). The following commands are "
22499 #: ../fish/guestfish.pod:864 ../libguestfs-1.11.19/fish/guestfish.pod:864
22502 " file /WINDOWS/system32/config/system.LOG\n"
22507 #: ../fish/guestfish.pod:866 ../libguestfs-1.11.19/fish/guestfish.pod:866
22510 " file win:\\windows\\system32\\config\\system.log\n"
22515 #: ../fish/guestfish.pod:868 ../libguestfs-1.11.19/fish/guestfish.pod:868
22518 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
22523 #: ../fish/guestfish.pod:870 ../libguestfs-1.11.19/fish/guestfish.pod:870
22525 "The parameter is rewritten \"behind the scenes\" by looking up the position "
22526 "where the drive is mounted, prepending that to the path, changing all "
22527 "backslash characters to forward slash, then resolving the result using L</"
22528 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
22529 "the parameter might be rewritten like this:"
22533 #: ../fish/guestfish.pod:876 ../libguestfs-1.11.19/fish/guestfish.pod:876
22536 " win:e:\\foo\\bar => /e/FOO/bar\n"
22541 #: ../fish/guestfish.pod:878 ../libguestfs-1.11.19/fish/guestfish.pod:878
22542 msgid "This only works in argument positions that expect a path."
22546 #: ../fish/guestfish.pod:880 ../libguestfs-1.11.19/fish/guestfish.pod:880
22547 msgid "UPLOADING AND DOWNLOADING FILES"
22551 #: ../fish/guestfish.pod:882 ../libguestfs-1.11.19/fish/guestfish.pod:882
22553 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
22554 "others which upload from or download to a local file, you can use the "
22555 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
22559 #: ../fish/guestfish.pod:886 ../libguestfs-1.11.19/fish/guestfish.pod:886
22567 #: ../fish/guestfish.pod:888 ../libguestfs-1.11.19/fish/guestfish.pod:888
22569 "reads stdin and creates from that a file C</foo> in the disk image, and:"
22573 #: ../fish/guestfish.pod:891 ../libguestfs-1.11.19/fish/guestfish.pod:891
22576 " tar-out /etc - | tar tf -\n"
22581 #: ../fish/guestfish.pod:893 ../libguestfs-1.11.19/fish/guestfish.pod:893
22583 "writes the tarball to stdout and then pipes that into the external \"tar\" "
22584 "command (see L</PIPES>)."
22588 #: ../fish/guestfish.pod:896 ../libguestfs-1.11.19/fish/guestfish.pod:896
22590 "When using C<-> to read from stdin, the input is read up to the end of "
22591 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
22592 "some arbitrary end marker:"
22596 #: ../fish/guestfish.pod:900 ../libguestfs-1.11.19/fish/guestfish.pod:900
22599 " upload -<<END /foo\n"
22608 #: ../fish/guestfish.pod:906 ../libguestfs-1.11.19/fish/guestfish.pod:906
22610 "Any string of characters can be used instead of C<END>. The end marker must "
22611 "appear on a line of its own, without any preceeding or following characters "
22612 "(not even spaces)."
22616 #: ../fish/guestfish.pod:910 ../libguestfs-1.11.19/fish/guestfish.pod:910
22618 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
22619 "upload local files (so-called \"FileIn\" parameters in the generator)."
22623 #: ../fish/guestfish.pod:913 ../libguestfs-1.11.19/fish/guestfish.pod:913
22624 msgid "EXIT ON ERROR BEHAVIOUR"
22628 #: ../fish/guestfish.pod:915 ../libguestfs-1.11.19/fish/guestfish.pod:915
22630 "By default, guestfish will ignore any errors when in interactive mode (ie. "
22631 "taking commands from a human over a tty), and will exit on the first error "
22632 "in non-interactive mode (scripts, commands given on the command line)."
22636 #: ../fish/guestfish.pod:920 ../libguestfs-1.11.19/fish/guestfish.pod:920
22638 "If you prefix a command with a I<-> character, then that command will not "
22639 "cause guestfish to exit, even if that (one) command returns an error."
22643 #: ../fish/guestfish.pod:924 ../libguestfs-1.11.19/fish/guestfish.pod:924
22644 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
22648 #: ../fish/guestfish.pod:926 ../libguestfs-1.11.19/fish/guestfish.pod:926
22650 "Guestfish can be remote-controlled over a socket. This is useful "
22651 "particularly in shell scripts where you want to make several different "
22652 "changes to a filesystem, but you don't want the overhead of starting up a "
22653 "guestfish process each time."
22657 #: ../fish/guestfish.pod:931 ../libguestfs-1.11.19/fish/guestfish.pod:931
22658 msgid "Start a guestfish server process using:"
22662 #: ../fish/guestfish.pod:933 ../libguestfs-1.11.19/fish/guestfish.pod:933
22665 " eval \"`guestfish --listen`\"\n"
22670 #: ../fish/guestfish.pod:935 ../libguestfs-1.11.19/fish/guestfish.pod:935
22671 msgid "and then send it commands by doing:"
22675 #: ../fish/guestfish.pod:937 ../libguestfs-1.11.19/fish/guestfish.pod:937
22678 " guestfish --remote cmd [...]\n"
22683 #: ../fish/guestfish.pod:939 ../libguestfs-1.11.19/fish/guestfish.pod:939
22684 msgid "To cause the server to exit, send it the exit command:"
22688 #: ../fish/guestfish.pod:943 ../libguestfs-1.11.19/fish/guestfish.pod:943
22690 "Note that the server will normally exit if there is an error in a command. "
22691 "You can change this in the usual way. See section L</EXIT ON ERROR "
22696 #: ../fish/guestfish.pod:947 ../libguestfs-1.11.19/fish/guestfish.pod:947
22697 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
22701 #: ../fish/guestfish.pod:949 ../libguestfs-1.11.19/fish/guestfish.pod:949
22703 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
22704 "is how the I<--remote> option knows where to send the commands. You can "
22705 "have several guestfish listener processes running using:"
22709 #: ../fish/guestfish.pod:953 ../libguestfs-1.11.19/fish/guestfish.pod:953
22712 " eval \"`guestfish --listen`\"\n"
22713 " pid1=$GUESTFISH_PID\n"
22714 " eval \"`guestfish --listen`\"\n"
22715 " pid2=$GUESTFISH_PID\n"
22717 " guestfish --remote=$pid1 cmd\n"
22718 " guestfish --remote=$pid2 cmd\n"
22723 #: ../fish/guestfish.pod:961 ../libguestfs-1.11.19/fish/guestfish.pod:961
22724 msgid "REMOTE CONTROL AND CSH"
22728 #: ../fish/guestfish.pod:963 ../libguestfs-1.11.19/fish/guestfish.pod:963
22730 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
22735 #: ../fish/guestfish.pod:966 ../libguestfs-1.11.19/fish/guestfish.pod:966
22738 " eval \"`guestfish --listen --csh`\"\n"
22743 #: ../fish/guestfish.pod:968 ../libguestfs-1.11.19/fish/guestfish.pod:968
22744 msgid "REMOTE CONTROL DETAILS"
22748 #: ../fish/guestfish.pod:970 ../libguestfs-1.11.19/fish/guestfish.pod:970
22750 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
22751 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
22752 "and C<$PID> is the process ID of the server."
22756 #: ../fish/guestfish.pod:974 ../libguestfs-1.11.19/fish/guestfish.pod:974
22757 msgid "Guestfish client and server versions must match exactly."
22761 #: ../fish/guestfish.pod:976 ../libguestfs-1.11.19/fish/guestfish.pod:976
22762 msgid "PREPARED DISK IMAGES"
22766 #: ../fish/guestfish.pod:978 ../libguestfs-1.11.19/fish/guestfish.pod:978
22768 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
22769 "preformatted disk images that guestfish can make for you to save typing. "
22770 "This is particularly useful for testing purposes. This option is used "
22771 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
22772 "can be mixed with I<-a>)."
22776 #: ../fish/guestfish.pod:984 ../libguestfs-1.11.19/fish/guestfish.pod:984
22778 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
22779 "the second and so on. Existing files in the current directory are "
22784 #: ../fish/guestfish.pod:988 ../libguestfs-1.11.19/fish/guestfish.pod:988
22786 "The type briefly describes how the disk should be sized, partitioned, how "
22787 "filesystem(s) should be created, and how content should be added. "
22788 "Optionally the type can be followed by extra parameters, separated by C<:> "
22789 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
22790 "allocated disk, containing a single partition, with the partition formatted "
22791 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
22796 #: ../fish/guestfish.pod:996 ../libguestfs-1.11.19/fish/guestfish.pod:996
22797 msgid "To list the available types and any extra parameters they take, run:"
22801 #: ../fish/guestfish.pod:1000 ../libguestfs-1.11.19/fish/guestfish.pod:1000
22803 "Note that the prepared filesystem is not mounted. You would usually have to "
22804 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
22808 #: ../fish/guestfish.pod:1004 ../libguestfs-1.11.19/fish/guestfish.pod:1004
22810 "If any I<-N> or I<--new> options are given, the guest is automatically "
22815 #: ../fish/guestfish.pod:1009 ../libguestfs-1.11.19/fish/guestfish.pod:1009
22816 msgid "Create a 100MB disk with an ext4-formatted partition:"
22820 #: ../fish/guestfish.pod:1011 ../libguestfs-1.11.19/fish/guestfish.pod:1011
22823 " guestfish -N fs:ext4\n"
22828 #: ../fish/guestfish.pod:1013 ../libguestfs-1.11.19/fish/guestfish.pod:1013
22829 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
22833 #: ../fish/guestfish.pod:1015 ../libguestfs-1.11.19/fish/guestfish.pod:1015
22836 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
22841 #: ../fish/guestfish.pod:1017 ../libguestfs-1.11.19/fish/guestfish.pod:1017
22842 msgid "Create a blank 200MB disk:"
22846 #: ../fish/guestfish.pod:1019 ../libguestfs-1.11.19/fish/guestfish.pod:1019
22849 " guestfish -N disk:200M\n"
22854 #: ../fish/guestfish.pod:1021 ../libguestfs-1.11.19/fish/guestfish.pod:1021
22855 msgid "PROGRESS BARS"
22859 #: ../fish/guestfish.pod:1023 ../libguestfs-1.11.19/fish/guestfish.pod:1023
22861 "Some (not all) long-running commands send progress notification messages as "
22862 "they are running. Guestfish turns these messages into progress bars."
22866 #: ../fish/guestfish.pod:1027 ../libguestfs-1.11.19/fish/guestfish.pod:1027
22868 "When a command that supports progress bars takes longer than two seconds to "
22869 "run, and if progress bars are enabled, then you will see one appearing below "
22874 #: ../fish/guestfish.pod:1031 ../libguestfs-1.11.19/fish/guestfish.pod:1031
22877 " ><fs> copy-size /large-file /another-file 2048M\n"
22878 " / 10% [#####-----------------------------------------] 00:30\n"
22883 #: ../fish/guestfish.pod:1034 ../libguestfs-1.11.19/fish/guestfish.pod:1034
22885 "The spinner on the left hand side moves round once for every progress "
22886 "notification received from the backend. This is a (reasonably) golden "
22887 "assurance that the command is \"doing something\" even if the progress bar "
22888 "is not moving, because the command is able to send the progress "
22889 "notifications. When the bar reaches 100% and the command finishes, the "
22890 "spinner disappears."
22894 #: ../fish/guestfish.pod:1041 ../libguestfs-1.11.19/fish/guestfish.pod:1041
22896 "Progress bars are enabled by default when guestfish is used interactively. "
22897 "You can enable them even for non-interactive modes using I<--progress-bars>, "
22898 "and you can disable them completely using I<--no-progress-bars>."
22902 #: ../fish/guestfish.pod:1046 ../libguestfs-1.11.19/fish/guestfish.pod:1046
22903 msgid "GUESTFISH COMMANDS"
22907 #: ../fish/guestfish.pod:1048 ../libguestfs-1.11.19/fish/guestfish.pod:1048
22909 "The commands in this section are guestfish convenience commands, in other "
22910 "words, they are not part of the L<guestfs(3)> API."
22914 #: ../fish/guestfish.pod:1051 ../libguestfs-1.11.19/fish/guestfish.pod:1051
22919 #: ../fish/guestfish.pod:1053 ../libguestfs-1.11.19/fish/guestfish.pod:1053
22928 #: ../fish/guestfish.pod:1056 ../libguestfs-1.11.19/fish/guestfish.pod:1056
22929 msgid "Without any parameter, this provides general help."
22933 #: ../fish/guestfish.pod:1058 ../libguestfs-1.11.19/fish/guestfish.pod:1058
22934 msgid "With a C<cmd> parameter, this displays detailed help for that command."
22938 #: ../fish/guestfish.pod:1060 ../libguestfs-1.11.19/fish/guestfish.pod:1060
22939 msgid "quit | exit"
22943 #: ../fish/guestfish.pod:1062 ../libguestfs-1.11.19/fish/guestfish.pod:1062
22944 msgid "This exits guestfish. You can also use C<^D> key."
22948 #: ../fish/guestfish.pod:1064 ../libguestfs-1.11.19/fish/guestfish.pod:1064
22949 msgid "@FISH_COMMANDS@"
22953 #: ../fish/guestfish.pod:1066 ../libguestfs-1.11.19/fish/guestfish.pod:1066
22958 #: ../fish/guestfish.pod:1068 ../libguestfs-1.11.19/fish/guestfish.pod:1068
22959 #: ../libguestfs-1.11.19/src/guestfs.pod:1474 ../src/guestfs.pod:1474
22964 #: ../fish/guestfish.pod:1070 ../libguestfs-1.11.19/fish/guestfish.pod:1070
22965 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:77
22966 #: ../test-tool/libguestfs-test-tool.pod:77
22971 #: ../fish/guestfish.pod:1072 ../libguestfs-1.11.19/fish/guestfish.pod:1072
22973 "guestfish returns 0 if the commands completed without error, or 1 if there "
22978 #: ../fish/guestfish.pod:1079 ../libguestfs-1.11.19/fish/guestfish.pod:1079
22983 #: ../fish/guestfish.pod:1081 ../libguestfs-1.11.19/fish/guestfish.pod:1081
22985 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
22990 #: ../fish/guestfish.pod:1084 ../libguestfs-1.11.19/fish/guestfish.pod:1084
22991 msgid "GUESTFISH_DISPLAY_IMAGE"
22995 #: ../fish/guestfish.pod:1086 ../libguestfs-1.11.19/fish/guestfish.pod:1086
22997 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
22998 "If not set, it uses L<display(1)>."
23002 #: ../fish/guestfish.pod:1089 ../libguestfs-1.11.19/fish/guestfish.pod:1089
23003 msgid "GUESTFISH_PID"
23007 #: ../fish/guestfish.pod:1091 ../libguestfs-1.11.19/fish/guestfish.pod:1091
23009 "Used with the I<--remote> option to specify the remote guestfish process to "
23010 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
23014 #: ../fish/guestfish.pod:1095 ../libguestfs-1.11.19/fish/guestfish.pod:1095
23019 #: ../fish/guestfish.pod:1097 ../libguestfs-1.11.19/fish/guestfish.pod:1097
23021 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
23022 "not specified, the external L<hexedit(1)> program is used."
23026 #: ../fish/guestfish.pod:1101 ../libguestfs-1.11.19/fish/guestfish.pod:1101
23031 #: ../fish/guestfish.pod:1103 ../libguestfs-1.11.19/fish/guestfish.pod:1103
23033 "If compiled with GNU readline support, various files in the home directory "
23034 "can be used. See L</FILES>."
23038 #: ../fish/guestfish.pod:1106 ../libguestfs-1.11.19/fish/guestfish.pod:1106
23039 #: ../libguestfs-1.11.19/src/guestfs.pod:2964 ../src/guestfs.pod:2964
23040 msgid "LIBGUESTFS_APPEND"
23044 #: ../fish/guestfish.pod:1108 ../libguestfs-1.11.19/fish/guestfish.pod:1108
23045 #: ../libguestfs-1.11.19/src/guestfs.pod:2966 ../src/guestfs.pod:2966
23046 msgid "Pass additional options to the guest kernel."
23050 #: ../fish/guestfish.pod:1110 ../libguestfs-1.11.19/fish/guestfish.pod:1110
23051 #: ../libguestfs-1.11.19/src/guestfs.pod:2968 ../src/guestfs.pod:2968
23052 msgid "LIBGUESTFS_DEBUG"
23056 #: ../fish/guestfish.pod:1112 ../libguestfs-1.11.19/fish/guestfish.pod:1112
23058 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
23059 "effect as using the B<-v> option."
23063 #: ../fish/guestfish.pod:1115 ../libguestfs-1.11.19/fish/guestfish.pod:1115
23064 #: ../libguestfs-1.11.19/src/guestfs.pod:2973 ../src/guestfs.pod:2973
23065 msgid "LIBGUESTFS_MEMSIZE"
23069 #: ../fish/guestfish.pod:1117 ../libguestfs-1.11.19/fish/guestfish.pod:1117
23070 #: ../libguestfs-1.11.19/src/guestfs.pod:2975 ../src/guestfs.pod:2975
23072 "Set the memory allocated to the qemu process, in megabytes. For example:"
23076 #: ../fish/guestfish.pod:1120 ../libguestfs-1.11.19/fish/guestfish.pod:1120
23077 #: ../libguestfs-1.11.19/src/guestfs.pod:2978 ../src/guestfs.pod:2978
23080 " LIBGUESTFS_MEMSIZE=700\n"
23085 #: ../fish/guestfish.pod:1122 ../libguestfs-1.11.19/fish/guestfish.pod:1122
23086 #: ../libguestfs-1.11.19/src/guestfs.pod:2980 ../src/guestfs.pod:2980
23087 msgid "LIBGUESTFS_PATH"
23091 #: ../fish/guestfish.pod:1124 ../libguestfs-1.11.19/fish/guestfish.pod:1124
23093 "Set the path that guestfish uses to search for kernel and initrd.img. See "
23094 "the discussion of paths in L<guestfs(3)>."
23098 #: ../fish/guestfish.pod:1127 ../libguestfs-1.11.19/fish/guestfish.pod:1127
23099 #: ../libguestfs-1.11.19/src/guestfs.pod:2985 ../src/guestfs.pod:2985
23100 msgid "LIBGUESTFS_QEMU"
23104 #: ../fish/guestfish.pod:1129 ../libguestfs-1.11.19/fish/guestfish.pod:1129
23105 #: ../libguestfs-1.11.19/src/guestfs.pod:2987 ../src/guestfs.pod:2987
23107 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
23108 "which was found at compile time by the configure script is used."
23112 #: ../fish/guestfish.pod:1133 ../libguestfs-1.11.19/fish/guestfish.pod:1133
23113 #: ../libguestfs-1.11.19/src/guestfs.pod:2993 ../src/guestfs.pod:2993
23114 msgid "LIBGUESTFS_TRACE"
23118 #: ../fish/guestfish.pod:1135 ../libguestfs-1.11.19/fish/guestfish.pod:1135
23119 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
23123 #: ../fish/guestfish.pod:1137 ../libguestfs-1.11.19/fish/guestfish.pod:1137
23128 #: ../fish/guestfish.pod:1139 ../libguestfs-1.11.19/fish/guestfish.pod:1139
23130 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
23135 #: ../fish/guestfish.pod:1142 ../libguestfs-1.11.19/fish/guestfish.pod:1142
23136 #: ../libguestfs-1.11.19/src/guestfs.pod:2998 ../src/guestfs.pod:2998
23141 #: ../fish/guestfish.pod:1144 ../libguestfs-1.11.19/fish/guestfish.pod:1144
23142 #: ../libguestfs-1.11.19/src/guestfs.pod:3000 ../src/guestfs.pod:3000
23144 "Location of temporary directory, defaults to C</tmp> except for the cached "
23145 "supermin appliance which defaults to C</var/tmp>."
23149 #: ../fish/guestfish.pod:1147 ../libguestfs-1.11.19/fish/guestfish.pod:1147
23150 #: ../libguestfs-1.11.19/src/guestfs.pod:3003 ../src/guestfs.pod:3003
23152 "If libguestfs was compiled to use the supermin appliance then the real "
23153 "appliance is cached in this directory, shared between all handles belonging "
23154 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
23155 "use in case C</var/tmp> is not large enough."
23159 #: ../fish/guestfish.pod:1155 ../fuse/guestmount.pod:288
23160 #: ../libguestfs-1.11.19/fish/guestfish.pod:1155
23161 #: ../libguestfs-1.11.19/fuse/guestmount.pod:288
23162 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:269
23163 #: ../rescue/virt-rescue.pod:269
23168 #: ../fish/guestfish.pod:1159 ../fuse/guestmount.pod:292
23169 #: ../libguestfs-1.11.19/fish/guestfish.pod:1159
23170 #: ../libguestfs-1.11.19/fuse/guestmount.pod:292
23171 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:273
23172 #: ../rescue/virt-rescue.pod:273
23173 msgid "$HOME/.libguestfs-tools.rc"
23177 #: ../fish/guestfish.pod:1161 ../fuse/guestmount.pod:294
23178 #: ../libguestfs-1.11.19/fish/guestfish.pod:1161
23179 #: ../libguestfs-1.11.19/fuse/guestmount.pod:294
23180 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:275
23181 #: ../rescue/virt-rescue.pod:275
23182 msgid "/etc/libguestfs-tools.conf"
23186 #: ../fish/guestfish.pod:1163 ../fuse/guestmount.pod:296
23187 #: ../libguestfs-1.11.19/fish/guestfish.pod:1163
23188 #: ../libguestfs-1.11.19/fuse/guestmount.pod:296
23189 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:277
23190 #: ../rescue/virt-rescue.pod:277
23192 "This configuration file controls the default read-only or read-write mode "
23193 "(I<--ro> or I<--rw>)."
23197 #: ../fish/guestfish.pod:1166 ../libguestfs-1.11.19/fish/guestfish.pod:1166
23198 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
23202 #: ../fish/guestfish.pod:1168 ../libguestfs-1.11.19/fish/guestfish.pod:1168
23203 msgid "$HOME/.guestfish"
23207 #: ../fish/guestfish.pod:1170 ../libguestfs-1.11.19/fish/guestfish.pod:1170
23209 "If compiled with GNU readline support, then the command history is saved in "
23214 #: ../fish/guestfish.pod:1173 ../libguestfs-1.11.19/fish/guestfish.pod:1173
23215 msgid "$HOME/.inputrc"
23219 #: ../fish/guestfish.pod:1175 ../libguestfs-1.11.19/fish/guestfish.pod:1175
23220 msgid "/etc/inputrc"
23224 #: ../fish/guestfish.pod:1177 ../libguestfs-1.11.19/fish/guestfish.pod:1177
23226 "If compiled with GNU readline support, then these files can be used to "
23227 "configure readline. For further information, please see L<readline(3)/"
23228 "INITIALIZATION FILE>."
23232 #: ../fish/guestfish.pod:1181 ../libguestfs-1.11.19/fish/guestfish.pod:1181
23233 msgid "To write rules which only apply to guestfish, use:"
23237 #: ../fish/guestfish.pod:1183 ../libguestfs-1.11.19/fish/guestfish.pod:1183
23247 #: ../fish/guestfish.pod:1187 ../libguestfs-1.11.19/fish/guestfish.pod:1187
23249 "Variables that you can set in inputrc that change the behaviour of guestfish "
23250 "in useful ways include:"
23254 #: ../fish/guestfish.pod:1192 ../libguestfs-1.11.19/fish/guestfish.pod:1192
23255 msgid "completion-ignore-case (default: on)"
23259 #: ../fish/guestfish.pod:1194 ../libguestfs-1.11.19/fish/guestfish.pod:1194
23261 "By default, guestfish will ignore case when tab-completing paths on the "
23266 #: ../fish/guestfish.pod:1197 ../libguestfs-1.11.19/fish/guestfish.pod:1197
23269 " set completion-ignore-case off\n"
23274 #: ../fish/guestfish.pod:1199 ../libguestfs-1.11.19/fish/guestfish.pod:1199
23275 msgid "to make guestfish case sensitive."
23279 #: ../fish/guestfish.pod:1203 ../libguestfs-1.11.19/fish/guestfish.pod:1203
23284 #: ../fish/guestfish.pod:1205 ../libguestfs-1.11.19/fish/guestfish.pod:1205
23285 msgid "test2.img (etc)"
23289 #: ../fish/guestfish.pod:1207 ../libguestfs-1.11.19/fish/guestfish.pod:1207
23291 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
23292 "will be created in the file C<test1.img> in the current directory. The "
23293 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
23294 "the same name will be overwritten."
23298 #: ../fish/guestfish.pod:1216 ../libguestfs-1.11.19/fish/guestfish.pod:1216
23300 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
23301 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
23302 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
23303 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
23304 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
23305 ">, L<display(1)>, L<hexedit(1)>."
23309 #: ../fish/guestfish.pod:1244 ../libguestfs-1.11.19/fish/guestfish.pod:1244
23310 #: ../libguestfs-1.11.19/src/guestfs.pod:3086
23311 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:99
23312 #: ../src/guestfs.pod:3086 ../test-tool/libguestfs-test-tool.pod:99
23313 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
23317 #: ../fish/virt-copy-in.pod:5 ../libguestfs-1.11.19/fish/virt-copy-in.pod:5
23319 "virt-copy-in - Copy files and directories into a virtual machine disk image."
23323 #: ../fish/virt-copy-in.pod:9 ../libguestfs-1.11.19/fish/virt-copy-in.pod:9
23326 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
23331 #: ../fish/virt-copy-in.pod:11 ../libguestfs-1.11.19/fish/virt-copy-in.pod:11
23334 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
23339 #: ../fish/virt-copy-in.pod:15 ../libguestfs-1.11.19/fish/virt-copy-in.pod:15
23341 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
23342 "causing disk corruption. The virtual machine must be shut down before you "
23343 "use this command."
23347 #: ../fish/virt-copy-in.pod:21 ../libguestfs-1.11.19/fish/virt-copy-in.pod:21
23349 "C<virt-copy-in> copies files and directories from the local disk into a "
23350 "virtual machine disk image or named libvirt domain."
23354 #: ../fish/virt-copy-in.pod:24 ../libguestfs-1.11.19/fish/virt-copy-in.pod:24
23356 "You can give one of more filenames and directories on the command line. "
23357 "Directories are copied in recursively. The final parameter must be the "
23358 "destination directory in the disk image which must be an absolute path "
23359 "starting with a C</> character."
23363 #: ../fish/virt-copy-in.pod:33 ../libguestfs-1.11.19/fish/virt-copy-in.pod:33
23366 " virt-copy-in -d MyGuest resolv.conf /etc\n"
23371 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
23372 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:35
23373 #: ../libguestfs-1.11.19/fish/virt-tar-in.pod:32
23374 msgid "Upload a home directory to a guest:"
23378 #: ../fish/virt-copy-in.pod:37 ../libguestfs-1.11.19/fish/virt-copy-in.pod:37
23381 " virt-copy-in -d MyGuest skel /home\n"
23386 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28
23387 #: ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
23388 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:39
23389 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:28
23390 #: ../libguestfs-1.11.19/fish/virt-tar-in.pod:36
23391 #: ../libguestfs-1.11.19/fish/virt-tar-out.pod:30
23392 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
23396 #: ../fish/virt-copy-in.pod:41 ../libguestfs-1.11.19/fish/virt-copy-in.pod:41
23398 "This command is just a simple shell script wrapper around the L<guestfish(1)"
23399 "> C<copy-in> command. For anything more complex than a trivial copy, you "
23400 "are probably better off using guestfish directly."
23404 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36
23405 #: ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
23406 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:47
23407 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:36
23408 #: ../libguestfs-1.11.19/fish/virt-tar-in.pod:44
23409 #: ../libguestfs-1.11.19/fish/virt-tar-out.pod:38
23411 "Since the shell script just passes options straight to guestfish, read "
23412 "L<guestfish(1)> to see the full list of options."
23416 #: ../fish/virt-copy-in.pod:52 ../libguestfs-1.11.19/fish/virt-copy-in.pod:52
23418 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
23419 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
23423 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55
23424 #: ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
23425 #: ../libguestfs-1.11.19/fish/virt-copy-in.pod:66
23426 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:55
23427 #: ../libguestfs-1.11.19/fish/virt-tar-in.pod:64
23428 #: ../libguestfs-1.11.19/fish/virt-tar-out.pod:57
23429 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
23433 #: ../fish/virt-copy-out.pod:5 ../libguestfs-1.11.19/fish/virt-copy-out.pod:5
23435 "virt-copy-out - Copy files and directories out of a virtual machine disk "
23440 #: ../fish/virt-copy-out.pod:9 ../libguestfs-1.11.19/fish/virt-copy-out.pod:9
23443 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
23448 #: ../fish/virt-copy-out.pod:11
23449 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:11
23452 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
23457 #: ../fish/virt-copy-out.pod:15
23458 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:15
23460 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
23461 "image or named libvirt domain."
23465 #: ../fish/virt-copy-out.pod:18
23466 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:18
23468 "You can give one of more filenames and directories on the command line. "
23469 "Directories are copied out recursively."
23473 #: ../fish/virt-copy-out.pod:23
23474 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:23
23475 msgid "Download the home directories from a virtual machine:"
23479 #: ../fish/virt-copy-out.pod:25
23480 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:25
23484 " virt-copy-out -d MyGuest /home homes\n"
23489 #: ../fish/virt-copy-out.pod:30
23490 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:30
23492 "This command is just a simple shell script wrapper around the L<guestfish(1)"
23493 "> C<copy-out> command. For anything more complex than a trivial copy, you "
23494 "are probably better off using guestfish directly."
23498 #: ../fish/virt-copy-out.pod:41
23499 #: ../libguestfs-1.11.19/fish/virt-copy-out.pod:41
23501 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, L<virt-"
23502 "tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
23506 #: ../fish/virt-tar-in.pod:5 ../libguestfs-1.11.19/fish/virt-tar-in.pod:5
23507 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
23511 #: ../fish/virt-tar-in.pod:9 ../libguestfs-1.11.19/fish/virt-tar-in.pod:9
23514 " virt-tar-in -a disk.img data.tar /destination\n"
23519 #: ../fish/virt-tar-in.pod:11 ../libguestfs-1.11.19/fish/virt-tar-in.pod:11
23522 " virt-tar-in -d domain data.tar /destination\n"
23527 #: ../fish/virt-tar-in.pod:13 ../libguestfs-1.11.19/fish/virt-tar-in.pod:13
23530 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
23535 #: ../fish/virt-tar-in.pod:17 ../libguestfs-1.11.19/fish/virt-tar-in.pod:17
23537 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
23538 "causing disk corruption. The virtual machine must be shut down before you "
23539 "use this command."
23543 #: ../fish/virt-tar-in.pod:23 ../libguestfs-1.11.19/fish/virt-tar-in.pod:23
23545 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
23546 "image or named libvirt domain."
23550 #: ../fish/virt-tar-in.pod:26 ../libguestfs-1.11.19/fish/virt-tar-in.pod:26
23552 "The first parameter is the tar file. Use C<-> to read the tar file from "
23553 "standard input. The second parameter is the absolute target directory to "
23558 #: ../fish/virt-tar-in.pod:34 ../libguestfs-1.11.19/fish/virt-tar-in.pod:34
23561 " virt-tar-in -d MyGuest homes.tar /home\n"
23566 #: ../fish/virt-tar-in.pod:38 ../libguestfs-1.11.19/fish/virt-tar-in.pod:38
23568 "This command is just a simple shell script wrapper around the L<guestfish(1)"
23569 "> C<tar-in> command. For anything more complex than a trivial copy, you are "
23570 "probably better off using guestfish directly."
23574 #: ../fish/virt-tar-in.pod:49 ../libguestfs-1.11.19/fish/virt-tar-in.pod:49
23576 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
23577 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, L<http://libguestfs."
23582 #: ../fish/virt-tar-out.pod:5 ../libguestfs-1.11.19/fish/virt-tar-out.pod:5
23584 "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
23588 #: ../fish/virt-tar-out.pod:9 ../libguestfs-1.11.19/fish/virt-tar-out.pod:9
23591 " virt-tar-out -a disk.img /dir files.tar\n"
23596 #: ../fish/virt-tar-out.pod:11 ../libguestfs-1.11.19/fish/virt-tar-out.pod:11
23599 " virt-tar-out -d domain /dir files.tar\n"
23604 #: ../fish/virt-tar-out.pod:13 ../libguestfs-1.11.19/fish/virt-tar-out.pod:13
23607 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
23612 #: ../fish/virt-tar-out.pod:17 ../libguestfs-1.11.19/fish/virt-tar-out.pod:17
23614 "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
23618 #: ../fish/virt-tar-out.pod:20 ../libguestfs-1.11.19/fish/virt-tar-out.pod:20
23620 "The first parameter is the absolute path of the virtual machine directory. "
23621 "The second parameter is the tar file to write. Use C<-> to write to "
23626 #: ../fish/virt-tar-out.pod:26 ../libguestfs-1.11.19/fish/virt-tar-out.pod:26
23627 msgid "Download the home directories from a guest:"
23631 #: ../fish/virt-tar-out.pod:28 ../libguestfs-1.11.19/fish/virt-tar-out.pod:28
23634 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
23639 #: ../fish/virt-tar-out.pod:32 ../libguestfs-1.11.19/fish/virt-tar-out.pod:32
23641 "This command is just a simple shell script wrapper around the L<guestfish(1)"
23642 "> C<tar-out> command. For anything more complex than a trivial copy, you "
23643 "are probably better off using guestfish directly."
23647 #: ../fish/virt-tar-out.pod:43 ../libguestfs-1.11.19/fish/virt-tar-out.pod:43
23649 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
23650 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
23654 #: ../fuse/guestmount.pod:5 ../libguestfs-1.11.19/fuse/guestmount.pod:5
23656 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
23660 #: ../fuse/guestmount.pod:9 ../libguestfs-1.11.19/fuse/guestmount.pod:9
23663 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
23668 #: ../fuse/guestmount.pod:11 ../libguestfs-1.11.19/fuse/guestmount.pod:11
23671 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
23676 #: ../fuse/guestmount.pod:13 ../libguestfs-1.11.19/fuse/guestmount.pod:13
23679 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
23684 #: ../fuse/guestmount.pod:17 ../libguestfs-1.11.19/fuse/guestmount.pod:17
23686 "You must I<not> use C<guestmount> in read-write mode on live virtual "
23687 "machines. If you do this, you risk disk corruption in the VM."
23691 #: ../fuse/guestmount.pod:22 ../libguestfs-1.11.19/fuse/guestmount.pod:22
23693 "The guestmount program can be used to mount virtual machine filesystems and "
23694 "other disk images on the host. It uses libguestfs for access to the guest "
23695 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
23696 "a mountable device."
23700 #: ../fuse/guestmount.pod:27 ../libguestfs-1.11.19/fuse/guestmount.pod:27
23702 "Along with other options, you have to give at least one device (I<-a> "
23703 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
23704 "option) or use the I<-i> inspection option. How this works is better "
23705 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
23710 #: ../fuse/guestmount.pod:33 ../libguestfs-1.11.19/fuse/guestmount.pod:33
23712 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
23713 "by you, and the filesystem will not be visible to any other users unless you "
23714 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
23715 "the filesystem, use the C<fusermount -u> command."
23719 #: ../fuse/guestmount.pod:41 ../libguestfs-1.11.19/fuse/guestmount.pod:41
23721 "For a typical Windows guest which has its main filesystem on the first "
23726 #: ../fuse/guestmount.pod:44 ../libguestfs-1.11.19/fuse/guestmount.pod:44
23729 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
23734 #: ../fuse/guestmount.pod:46 ../libguestfs-1.11.19/fuse/guestmount.pod:46
23736 "For a typical Linux guest which has a /boot filesystem on the first "
23737 "partition, and the root filesystem on a logical volume:"
23741 #: ../fuse/guestmount.pod:49 ../libguestfs-1.11.19/fuse/guestmount.pod:49
23744 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
23749 #: ../fuse/guestmount.pod:51 ../libguestfs-1.11.19/fuse/guestmount.pod:51
23750 msgid "To get libguestfs to detect guest mountpoints for you:"
23754 #: ../fuse/guestmount.pod:53 ../libguestfs-1.11.19/fuse/guestmount.pod:53
23757 " guestmount -a guest.img -i --ro /mnt\n"
23762 #: ../fuse/guestmount.pod:55 ../libguestfs-1.11.19/fuse/guestmount.pod:55
23763 msgid "For a libvirt guest called \"Guest\" you could do:"
23767 #: ../fuse/guestmount.pod:57 ../libguestfs-1.11.19/fuse/guestmount.pod:57
23770 " guestmount -d Guest -i --ro /mnt\n"
23775 #: ../fuse/guestmount.pod:59 ../libguestfs-1.11.19/fuse/guestmount.pod:59
23777 "If you don't know what filesystems are contained in a guest or disk image, "
23778 "use L<virt-filesystems(1)> first:"
23782 #: ../fuse/guestmount.pod:62 ../libguestfs-1.11.19/fuse/guestmount.pod:62
23785 " virt-filesystems MyGuest\n"
23790 #: ../fuse/guestmount.pod:64 ../libguestfs-1.11.19/fuse/guestmount.pod:64
23792 "If you want to trace the libguestfs calls but without excessive debugging "
23793 "information, we recommend:"
23797 #: ../fuse/guestmount.pod:67 ../libguestfs-1.11.19/fuse/guestmount.pod:67
23800 " guestmount [...] --trace /mnt\n"
23805 #: ../fuse/guestmount.pod:69 ../libguestfs-1.11.19/fuse/guestmount.pod:69
23806 msgid "If you want to debug the program, we recommend:"
23810 #: ../fuse/guestmount.pod:71 ../libguestfs-1.11.19/fuse/guestmount.pod:71
23813 " guestmount [...] --trace --verbose /mnt\n"
23818 #: ../fuse/guestmount.pod:73 ../libguestfs-1.11.19/fuse/guestmount.pod:73
23819 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:68
23820 #: ../libguestfs-1.11.19/resize/virt-resize.pod:486
23821 #: ../rescue/virt-rescue.pod:68 ../resize/virt-resize.pod:486
23826 #: ../fuse/guestmount.pod:75 ../libguestfs-1.11.19/fuse/guestmount.pod:75
23827 msgid "Other users cannot see the filesystem by default"
23831 #: ../fuse/guestmount.pod:77 ../libguestfs-1.11.19/fuse/guestmount.pod:77
23833 "If you mount a filesystem as one user (eg. root), then other users will not "
23834 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
23835 "option when mounting:"
23839 #: ../fuse/guestmount.pod:81 ../libguestfs-1.11.19/fuse/guestmount.pod:81
23842 " sudo guestmount [...] -o allow_other /mnt\n"
23847 #: ../fuse/guestmount.pod:91 ../libguestfs-1.11.19/fuse/guestmount.pod:91
23848 msgid "Add a block device or virtual machine image."
23852 #: ../fuse/guestmount.pod:114 ../libguestfs-1.11.19/fuse/guestmount.pod:114
23853 msgid "B<--dir-cache-timeout N>"
23857 #: ../fuse/guestmount.pod:116 ../libguestfs-1.11.19/fuse/guestmount.pod:116
23859 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
23860 "seconds. The readdir cache [actually, there are several semi-independent "
23861 "caches] is populated after a readdir(2) call with the stat and extended "
23862 "attributes of the files in the directory, in anticipation that they will be "
23863 "requested soon after."
23867 #: ../fuse/guestmount.pod:122 ../libguestfs-1.11.19/fuse/guestmount.pod:122
23869 "There is also a different attribute cache implemented by FUSE (see the FUSE "
23870 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
23871 "requests, only cache existing ones."
23875 #: ../fuse/guestmount.pod:142 ../libguestfs-1.11.19/fuse/guestmount.pod:142
23877 "If you have untrusted raw-format guest disk images, you should use this "
23878 "option to specify the disk format. This avoids a possible security problem "
23879 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
23880 "guestfs_add_drive_opts>."
23884 #: ../fuse/guestmount.pod:147 ../libguestfs-1.11.19/fuse/guestmount.pod:147
23885 msgid "B<--fuse-help>"
23889 #: ../fuse/guestmount.pod:149 ../libguestfs-1.11.19/fuse/guestmount.pod:149
23890 msgid "Display help on special FUSE options (see I<-o> below)."
23894 #: ../fuse/guestmount.pod:153 ../libguestfs-1.11.19/fuse/guestmount.pod:153
23895 msgid "Display brief help and exit."
23899 #: ../fuse/guestmount.pod:177 ../libguestfs-1.11.19/fuse/guestmount.pod:177
23901 "Mount the named partition or logical volume on the given mountpoint B<in the "
23902 "guest> (this has nothing to do with mountpoints in the host)."
23906 #: ../fuse/guestmount.pod:180 ../libguestfs-1.11.19/fuse/guestmount.pod:180
23908 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
23909 "something on C</>."
23913 #: ../fuse/guestmount.pod:197 ../libguestfs-1.11.19/fuse/guestmount.pod:197
23915 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
23916 "unmounted. If you specify this option, then we don't attempt to sync the "
23917 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
23921 #: ../fuse/guestmount.pod:202 ../libguestfs-1.11.19/fuse/guestmount.pod:202
23922 msgid "B<-o option>"
23926 #: ../fuse/guestmount.pod:204 ../libguestfs-1.11.19/fuse/guestmount.pod:204
23927 msgid "B<--option option>"
23931 #: ../fuse/guestmount.pod:206 ../libguestfs-1.11.19/fuse/guestmount.pod:206
23932 msgid "Pass extra options to FUSE."
23936 #: ../fuse/guestmount.pod:208 ../libguestfs-1.11.19/fuse/guestmount.pod:208
23938 "To get a list of all the extra options supported by FUSE, use the command "
23939 "below. Note that only the FUSE I<-o> options can be passed, and only some "
23940 "of them are a good idea."
23944 #: ../fuse/guestmount.pod:212 ../libguestfs-1.11.19/fuse/guestmount.pod:212
23947 " guestmount --fuse-help\n"
23952 #: ../fuse/guestmount.pod:214 ../libguestfs-1.11.19/fuse/guestmount.pod:214
23953 msgid "Some potentially useful FUSE options:"
23957 #: ../fuse/guestmount.pod:218 ../libguestfs-1.11.19/fuse/guestmount.pod:218
23958 msgid "B<-o allow_other>"
23962 #: ../fuse/guestmount.pod:220 ../libguestfs-1.11.19/fuse/guestmount.pod:220
23963 msgid "Allow other users to see the filesystem."
23967 #: ../fuse/guestmount.pod:222 ../libguestfs-1.11.19/fuse/guestmount.pod:222
23968 msgid "B<-o attr_timeout=N>"
23972 #: ../fuse/guestmount.pod:224 ../libguestfs-1.11.19/fuse/guestmount.pod:224
23973 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
23977 #: ../fuse/guestmount.pod:226 ../libguestfs-1.11.19/fuse/guestmount.pod:226
23978 msgid "B<-o kernel_cache>"
23982 #: ../fuse/guestmount.pod:228 ../libguestfs-1.11.19/fuse/guestmount.pod:228
23984 "Allow the kernel to cache files (reduces the number of reads that have to go "
23985 "through the L<guestfs(3)> API). This is generally a good idea if you can "
23986 "afford the extra memory usage."
23990 #: ../fuse/guestmount.pod:232 ../libguestfs-1.11.19/fuse/guestmount.pod:232
23991 msgid "B<-o uid=N> B<-o gid=N>"
23995 #: ../fuse/guestmount.pod:234 ../libguestfs-1.11.19/fuse/guestmount.pod:234
23997 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
23998 "the chosen values."
24002 #: ../fuse/guestmount.pod:243 ../libguestfs-1.11.19/fuse/guestmount.pod:243
24004 "Add devices and mount everything read-only. Also disallow writes and make "
24005 "the disk appear read-only to FUSE."
24009 #: ../fuse/guestmount.pod:246 ../libguestfs-1.11.19/fuse/guestmount.pod:246
24011 "This is highly recommended if you are not going to edit the guest disk. If "
24012 "the guest is running and this option is I<not> supplied, then there is a "
24013 "strong risk of disk corruption in the guest. We try to prevent this from "
24014 "happening, but it is not always possible."
24018 #: ../fuse/guestmount.pod:251 ../libguestfs-1.11.19/fuse/guestmount.pod:251
24019 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:171
24020 #: ../rescue/virt-rescue.pod:171
24021 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
24025 #: ../fuse/guestmount.pod:255 ../libguestfs-1.11.19/fuse/guestmount.pod:255
24026 msgid "Enable SELinux support for the guest."
24030 #: ../fuse/guestmount.pod:261 ../libguestfs-1.11.19/fuse/guestmount.pod:261
24031 msgid "Enable verbose messages from underlying libguestfs."
24035 #: ../fuse/guestmount.pod:267 ../libguestfs-1.11.19/fuse/guestmount.pod:267
24036 msgid "Display the program version and exit."
24040 #: ../fuse/guestmount.pod:276 ../fuse/guestmount.pod:299
24041 #: ../libguestfs-1.11.19/fuse/guestmount.pod:276
24042 #: ../libguestfs-1.11.19/fuse/guestmount.pod:299
24043 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:197
24044 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:280
24045 #: ../rescue/virt-rescue.pod:197 ../rescue/virt-rescue.pod:280
24046 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
24050 #: ../fuse/guestmount.pod:280 ../libguestfs-1.11.19/fuse/guestmount.pod:280
24055 #: ../fuse/guestmount.pod:282 ../libguestfs-1.11.19/fuse/guestmount.pod:282
24056 msgid "Trace libguestfs calls and entry into each FUSE function."
24060 #: ../fuse/guestmount.pod:284 ../libguestfs-1.11.19/fuse/guestmount.pod:284
24061 msgid "This also stops the daemon from forking into the background."
24065 #: ../fuse/guestmount.pod:305 ../libguestfs-1.11.19/fuse/guestmount.pod:305
24067 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
24068 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
24073 #: ../fuse/guestmount.pod:320 ../libguestfs-1.11.19/fuse/guestmount.pod:320
24074 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
24078 #: ../inspector/virt-inspector.pod:5
24079 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:5
24081 "virt-inspector - Display operating system version and other information "
24082 "about a virtual machine"
24086 #: ../inspector/virt-inspector.pod:9
24087 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:9
24090 " virt-inspector [--options] -d domname\n"
24095 #: ../inspector/virt-inspector.pod:11
24096 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:11
24099 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
24104 #: ../inspector/virt-inspector.pod:15
24105 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:15
24108 " virt-inspector domname\n"
24113 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:141
24114 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:17
24115 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:141
24118 " virt-inspector disk.img [disk.img ...]\n"
24123 #: ../inspector/virt-inspector.pod:21
24124 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:21
24126 "B<virt-inspector> examines a virtual machine or disk image and tries to "
24127 "determine the version of the operating system and other information about "
24128 "the virtual machine."
24132 #: ../inspector/virt-inspector.pod:25
24133 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:25
24134 msgid "Virt-inspector produces XML output for feeding into other programs."
24138 #: ../inspector/virt-inspector.pod:27
24139 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:27
24141 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
24142 "the libvirt domain (see: C<virsh list --all>)."
24146 #: ../inspector/virt-inspector.pod:30
24147 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:30
24149 "You can also run virt-inspector directly on disk images from a single "
24150 "virtual machine. Use C<virt-inspector -a disk.img>. In rare cases a domain "
24151 "has several block devices, in which case you should list several I<-a> "
24152 "options one after another, with the first corresponding to the guest's C</"
24153 "dev/sda>, the second to the guest's C</dev/sdb> and so on."
24157 #: ../inspector/virt-inspector.pod:37
24158 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:37
24160 "You can also run virt-inspector on install disks, live CDs, bootable USB "
24161 "keys and similar."
24165 #: ../inspector/virt-inspector.pod:40
24166 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:40
24168 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
24169 "inspect several virtual machines, you have to run virt-inspector several "
24170 "times (for example, from a shell script for-loop)."
24174 #: ../inspector/virt-inspector.pod:45
24175 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:45
24177 "Because virt-inspector needs direct access to guest images, it won't "
24178 "normally work over remote libvirt connections."
24182 #: ../inspector/virt-inspector.pod:48
24183 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:48
24185 "All of the information available from virt-inspector is also available "
24186 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>). "
24187 "The same information can also be fetched using guestfish or via libguestfs "
24188 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
24189 "WITH OTHER PROGRAMMING LANGUAGES>)."
24193 #: ../inspector/virt-inspector.pod:81
24194 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:81
24196 "Libvirt is only used if you specify a C<domname> on the command line. If "
24197 "you specify guest block devices directly (I<-a>), then libvirt is not used "
24202 #: ../inspector/virt-inspector.pod:94
24203 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:94
24205 "When prompting for keys and passphrases, virt-inspector normally turns "
24206 "echoing off so you cannot see what you are typing. If you are not worried "
24207 "about Tempest attacks and there is no one else in the room you can specify "
24208 "this flag to see what you are typing."
24212 #: ../inspector/virt-inspector.pod:103
24213 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:103
24214 #: ../tools/virt-list-filesystems.pl:93 ../tools/virt-list-partitions.pl:94
24215 #: ../tools/virt-tar.pl:143 ../tools/virt-win-reg.pl:144
24217 "Specify the format of disk images given on the command line. If this is "
24218 "omitted then the format is autodetected from the content of the disk image."
24222 #: ../inspector/virt-inspector.pod:107
24223 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:107
24224 #: ../tools/virt-list-filesystems.pl:97 ../tools/virt-list-partitions.pl:98
24225 #: ../tools/virt-tar.pl:147 ../tools/virt-win-reg.pl:148
24227 "If disk images are requested from libvirt, then this program asks libvirt "
24228 "for this information. In this case, the value of the format parameter is "
24233 #: ../inspector/virt-inspector.pod:111
24234 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:111
24235 #: ../libguestfs-1.11.19/resize/virt-resize.pod:314
24236 #: ../libguestfs-1.11.19/resize/virt-resize.pod:400
24237 #: ../resize/virt-resize.pod:314 ../resize/virt-resize.pod:400
24238 #: ../tools/virt-list-filesystems.pl:101 ../tools/virt-list-partitions.pl:102
24239 #: ../tools/virt-tar.pl:151 ../tools/virt-win-reg.pl:152
24241 "If working with untrusted raw-format guest disk images, you should ensure "
24242 "the format is always specified."
24246 #: ../inspector/virt-inspector.pod:139
24247 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:139
24248 msgid "Previous versions of virt-inspector allowed you to write either:"
24252 #: ../inspector/virt-inspector.pod:145
24253 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:145
24256 " virt-inspector guestname\n"
24261 #: ../inspector/virt-inspector.pod:153
24262 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:153
24267 #: ../inspector/virt-inspector.pod:155
24268 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:155
24270 "The virt-inspector XML is described precisely in a RELAX NG schema file "
24271 "C<virt-inspector.rng> which is supplied with libguestfs. This section is "
24272 "just an overview."
24276 #: ../inspector/virt-inspector.pod:159
24277 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:159
24279 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
24280 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
24281 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
24282 "which is vanishingly rare in real world VMs."
24286 #: ../inspector/virt-inspector.pod:164
24287 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:164
24288 msgid "E<lt>operatingsystemE<gt>"
24292 #: ../inspector/virt-inspector.pod:166
24293 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:166
24295 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
24296 "describe the operating system, its architecture, the descriptive \"product "
24297 "name\" string, the type of OS and so on, as in this example:"
24301 #: ../inspector/virt-inspector.pod:170
24302 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:170
24305 " <operatingsystems>\n"
24306 " <operatingsystem>\n"
24307 " <root>/dev/sda2</root>\n"
24308 " <name>windows</name>\n"
24309 " <arch>i386</arch>\n"
24310 " <distro>windows</distro>\n"
24311 " <product_name>Windows 7 Enterprise</product_name>\n"
24312 " <product_variant>Client</product_variant>\n"
24313 " <major_version>6</major_version>\n"
24314 " <minor_version>1</minor_version>\n"
24315 " <windows_systemroot>/Windows</windows_systemroot>\n"
24316 " <format>installed</format>\n"
24321 #: ../inspector/virt-inspector.pod:183
24322 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:183
24324 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
24325 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
24326 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
24327 "architecture. The other fields are fairly self-explanatory, but because "
24328 "these fields are taken directly from the libguestfs inspection API you can "
24329 "find precise information from L<guestfs(3)/INSPECTION>."
24333 #: ../inspector/virt-inspector.pod:191
24334 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:191
24336 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
24337 "of view of libguestfs (block devices may have completely different names "
24338 "inside the VM itself)."
24342 #: ../inspector/virt-inspector.pod:195
24343 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:195
24344 msgid "E<lt>mountpointsE<gt>"
24348 #: ../inspector/virt-inspector.pod:197
24349 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:197
24351 "Un*x-like guests typically have multiple filesystems which are mounted at "
24352 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
24353 "element which looks like this:"
24357 #: ../inspector/virt-inspector.pod:201
24358 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:201
24361 " <operatingsystems>\n"
24362 " <operatingsystem>\n"
24365 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
24366 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
24367 " </mountpoints>\n"
24372 #: ../inspector/virt-inspector.pod:209
24373 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:209
24375 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
24376 "and may have completely different names inside the guest. Only mountable "
24377 "filesystems appear in this list, not things like swap devices."
24381 #: ../inspector/virt-inspector.pod:214
24382 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:214
24383 msgid "E<lt>filesystemsE<gt>"
24387 #: ../inspector/virt-inspector.pod:216
24388 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:216
24390 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
24391 "filesystems belonging to the guest, including swap and empty partitions. "
24392 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
24393 "this OS or shared with this OS and other OSes)."
24397 #: ../inspector/virt-inspector.pod:222
24398 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:222
24399 msgid "You might see something like this:"
24403 #: ../inspector/virt-inspector.pod:224
24404 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:224
24407 " <operatingsystems>\n"
24408 " <operatingsystem>\n"
24411 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
24412 " <type>ext4</type>\n"
24413 " <label>Fedora-13-x86_64</label>\n"
24414 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
24420 #: ../inspector/virt-inspector.pod:234
24421 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:234
24423 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
24424 "the label, and the UUID."
24428 #: ../inspector/virt-inspector.pod:237
24429 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:237
24430 msgid "E<lt>applicationsE<gt>"
24434 #: ../inspector/virt-inspector.pod:239
24435 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:239
24437 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
24438 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
24443 #: ../inspector/virt-inspector.pod:243
24444 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:243
24446 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
24447 "Typical values would be C<rpm> and C<deb>."
24451 #: ../inspector/virt-inspector.pod:246
24452 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:246
24454 "E<lt>package_managementE<gt>, if present, describes the package manager. "
24455 "Typical values include C<yum>, C<up2date> and C<apt>"
24459 #: ../inspector/virt-inspector.pod:249
24460 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:249
24461 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
24465 #: ../inspector/virt-inspector.pod:252
24466 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:252
24469 " <operatingsystems>\n"
24470 " <operatingsystem>\n"
24472 " <applications>\n"
24474 " <name>coreutils</name>\n"
24475 " <version>8.5</version>\n"
24476 " <release>1</release>\n"
24477 " </application>\n"
24482 #: ../inspector/virt-inspector.pod:262
24483 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:262
24485 "The version and release fields may not be available for some types guests. "
24486 "Other fields are possible, see L<guestfs(3)/"
24487 "guestfs_inspect_list_applications>."
24491 #: ../inspector/virt-inspector.pod:266
24492 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:266
24493 msgid "E<lt>drive_mappingsE<gt>"
24497 #: ../inspector/virt-inspector.pod:268
24498 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:268
24500 "For operating systems like Windows which use drive letters, virt-inspector "
24501 "is able to find out how drive letters map to filesystems."
24505 #: ../inspector/virt-inspector.pod:272
24506 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:272
24509 " <operatingsystems>\n"
24510 " <operatingsystem>\n"
24512 " <drive_mappings>\n"
24513 " <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
24514 " <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
24515 " </drive_mappings>\n"
24520 #: ../inspector/virt-inspector.pod:280
24521 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:280
24523 "In the example above, drive C maps to the filesystem on the second partition "
24524 "on the first disk, and drive E maps to the filesystem on the first partition "
24525 "on the second disk."
24529 #: ../inspector/virt-inspector.pod:284
24530 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:284
24532 "Note that this only covers permanent local filesystem mappings, not things "
24533 "like network shares. Furthermore NTFS volume mount points may not be listed "
24538 #: ../inspector/virt-inspector.pod:288
24539 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:288
24540 msgid "E<lt>iconE<gt>"
24544 #: ../inspector/virt-inspector.pod:290
24545 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:290
24547 "Virt-inspector is sometimes able to extract an icon or logo for the guest. "
24548 "The icon is returned as base64-encoded PNG data. Note that the icon can be "
24549 "very large and high quality."
24553 #: ../inspector/virt-inspector.pod:294
24554 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:294
24557 " <operatingsystems>\n"
24558 " <operatingsystem>\n"
24561 " iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
24562 " [... many lines of base64 data ...]\n"
24568 #: ../inspector/virt-inspector.pod:302
24569 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:302
24571 "To display the icon, you have to extract it and convert the base64 data back "
24572 "to a binary file. Use an XPath query or simply an editor to extract the "
24573 "data, then use the coreutils L<base64(1)> program to do the conversion back "
24578 #: ../inspector/virt-inspector.pod:307
24579 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:307
24582 " base64 -i -d < icon.data > icon.png\n"
24587 #: ../inspector/virt-inspector.pod:309
24588 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:309
24589 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
24593 #: ../inspector/virt-inspector.pod:311
24594 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:311
24596 "Virt-inspector can detect some operating system installers on install disks, "
24597 "live CDs, bootable USB keys and more."
24601 #: ../inspector/virt-inspector.pod:314
24602 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:314
24604 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
24605 "fields may be present to indicate a live CD, network installer, or one part "
24606 "of a multipart CD. For example:"
24610 #: ../inspector/virt-inspector.pod:318
24611 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:318
24614 " <operatingsystems>\n"
24615 " <operatingsystem>\n"
24616 " <root>/dev/sda</root>\n"
24617 " <name>linux</name>\n"
24618 " <arch>i386</arch>\n"
24619 " <distro>ubuntu</distro>\n"
24620 " <product_name>Ubuntu 10.10 "Maverick Meerkat"</product_name>\n"
24621 " <major_version>10</major_version>\n"
24622 " <minor_version>10</minor_version>\n"
24623 " <format>installer</format>\n"
24629 #: ../inspector/virt-inspector.pod:330
24630 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:330
24631 msgid "USING XPATH"
24635 #: ../inspector/virt-inspector.pod:332
24636 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:332
24638 "You can use the XPath query language, and/or the xpath tool, in order to "
24639 "select parts of the XML."
24643 #: ../inspector/virt-inspector.pod:337
24644 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:337
24647 " $ virt-inspector -d Guest | xpath //filesystems\n"
24648 " Found 1 nodes:\n"
24651 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
24652 " <type>ext4</type>\n"
24658 #: ../inspector/virt-inspector.pod:345
24659 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:345
24662 " $ virt-inspector -d Guest | \\\n"
24663 " xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
24664 " Query didn't return a nodeset. Value: ext4\n"
24669 #: ../inspector/virt-inspector.pod:356
24670 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:356
24671 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
24675 #: ../inspector/virt-inspector.pod:358
24676 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:358
24678 "Early versions of libguestfs shipped with a different virt-inspector program "
24679 "written in Perl (the current version is written in C). The XML output of "
24680 "the Perl virt-inspector was different and it could also output in other "
24681 "formats like text."
24685 #: ../inspector/virt-inspector.pod:363
24686 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:363
24688 "The old virt-inspector is no longer supported or shipped with libguestfs."
24692 #: ../inspector/virt-inspector.pod:366
24693 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:366
24695 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
24696 "versions of virt-inspector with different names:"
24700 #: ../inspector/virt-inspector.pod:369
24701 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:369
24704 " virt-inspector Old Perl version.\n"
24705 " virt-inspector2 New C version.\n"
24710 #: ../inspector/virt-inspector.pod:374
24711 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:374
24713 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, L<base64(1)"
24714 ">, L<http://libguestfs.org/>."
24718 #: ../inspector/virt-inspector.pod:390
24719 #: ../libguestfs-1.11.19/inspector/virt-inspector.pod:390
24720 msgid "Matthew Booth L<mbooth@redhat.com>"
24724 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:5
24725 #: ../ocaml/examples/guestfs-ocaml.pod:5
24726 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
24730 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:9
24731 #: ../ocaml/examples/guestfs-ocaml.pod:9
24732 msgid "Module style:"
24736 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:11
24737 #: ../ocaml/examples/guestfs-ocaml.pod:11
24740 " let g = Guestfs.create () in\n"
24741 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
24742 " Guestfs.launch g;\n"
24747 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:15
24748 #: ../ocaml/examples/guestfs-ocaml.pod:15
24749 msgid "Object-oriented style:"
24753 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:17
24754 #: ../ocaml/examples/guestfs-ocaml.pod:17
24757 " let g = new Guestfs.guestfs () in\n"
24758 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
24764 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:21
24765 #: ../ocaml/examples/guestfs-ocaml.pod:21
24768 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
24770 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
24775 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:27
24776 #: ../ocaml/examples/guestfs-ocaml.pod:27
24778 "This manual page documents how to call libguestfs from the OCaml programming "
24779 "language. This page just documents the differences from the C API and gives "
24780 "some examples. If you are not familiar with using libguestfs, you also need "
24781 "to read L<guestfs(3)>."
24785 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:32
24786 #: ../ocaml/examples/guestfs-ocaml.pod:32
24787 msgid "PROGRAMMING STYLES"
24791 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:34
24792 #: ../ocaml/examples/guestfs-ocaml.pod:34
24794 "There are two different programming styles supported by the OCaml bindings. "
24795 "You can use a module style, with each C function mapped to an OCaml function:"
24799 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:38
24800 #: ../ocaml/examples/guestfs-ocaml.pod:38
24803 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
24808 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:40
24809 #: ../ocaml/examples/guestfs-ocaml.pod:40
24814 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:42
24815 #: ../ocaml/examples/guestfs-ocaml.pod:42
24818 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
24823 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:44
24824 #: ../ocaml/examples/guestfs-ocaml.pod:44
24826 "Alternately you can use an object-oriented style, calling methods on the "
24827 "class C<Guestfs.guestfs>:"
24831 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:47
24832 #: ../ocaml/examples/guestfs-ocaml.pod:47
24835 " method set_verbose : bool -> unit\n"
24840 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:49
24841 #: ../ocaml/examples/guestfs-ocaml.pod:49
24843 "The object-oriented style is usually briefer, and the minor performance "
24844 "penalty isn't noticable in the general overhead of performing libguestfs "
24849 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:53
24850 #: ../ocaml/examples/guestfs-ocaml.pod:53
24851 msgid "CLOSING THE HANDLE"
24855 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:55
24856 #: ../ocaml/examples/guestfs-ocaml.pod:55
24858 "The handle is closed when it is reaped by the garbage collector. Because "
24859 "libguestfs handles include a lot of state, it is also possible to close (and "
24860 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
24865 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:60
24866 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:21
24867 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:22
24868 #: ../ocaml/examples/guestfs-ocaml.pod:60
24869 #: ../python/examples/guestfs-python.pod:21
24870 #: ../ruby/examples/guestfs-ruby.pod:22
24875 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:62
24876 #: ../ocaml/examples/guestfs-ocaml.pod:62
24878 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
24879 "exception. This has a single parameter which is the error message (a "
24884 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:66
24885 #: ../ocaml/examples/guestfs-ocaml.pod:66
24887 "Calling any function/method on a closed handle raises C<Guestfs."
24888 "Handle_closed>. The single parameter is the name of the function that you "
24893 #: ../libguestfs-1.11.19/ocaml/examples/guestfs-ocaml.pod:80
24894 #: ../ocaml/examples/guestfs-ocaml.pod:80
24896 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-perl(3)>, L<guestfs-python"
24897 "(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>, "
24898 "L<http://caml.inria.fr/>."
24902 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:5
24903 #: ../perl/examples/guestfs-perl.pod:5
24904 msgid "guestfs-perl - How to use libguestfs from Perl"
24908 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:9
24909 #: ../perl/examples/guestfs-perl.pod:9
24912 " use Sys::Guestfs;\n"
24917 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:11
24918 #: ../perl/examples/guestfs-perl.pod:11
24921 " my $h = Sys::Guestfs->new ();\n"
24922 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
24923 " $h->launch ();\n"
24924 " $h->mount_options ('', '/dev/sda1', '/');\n"
24925 " $h->touch ('/hello');\n"
24931 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:20
24932 #: ../perl/examples/guestfs-perl.pod:20
24934 "This manual page documents how to call libguestfs from the Perl programming "
24935 "language. This page just documents the differences from the C API and gives "
24936 "some examples. If you are not familiar with using libguestfs, you also need "
24937 "to read L<guestfs(3)>. To read the full Perl API, see L<Sys::Guestfs(3)>."
24941 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:26
24942 #: ../perl/examples/guestfs-perl.pod:26
24947 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:28
24948 #: ../perl/examples/guestfs-perl.pod:28
24950 "Errors from libguestfs functions turn into calls to C<croak> (see L<Carp(3)"
24955 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:41
24956 #: ../perl/examples/guestfs-perl.pod:41
24958 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-ocaml(3)"
24959 ">, L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
24960 "libguestfs.org/>."
24964 #: ../libguestfs-1.11.19/perl/examples/guestfs-perl.pod:56
24965 #: ../perl/examples/guestfs-perl.pod:56
24966 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
24970 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:5
24971 #: ../python/examples/guestfs-python.pod:5
24972 msgid "guestfs-python - How to use libguestfs from Python"
24976 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:9
24977 #: ../python/examples/guestfs-python.pod:9
24980 " import guestfs\n"
24981 " g = guestfs.GuestFS ()\n"
24982 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
24988 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:16
24989 #: ../python/examples/guestfs-python.pod:16
24991 "This manual page documents how to call libguestfs from the Python "
24992 "programming language. This page just documents the differences from the C "
24993 "API and gives some examples. If you are not familiar with using libguestfs, "
24994 "you also need to read L<guestfs(3)>."
24998 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:23
24999 #: ../python/examples/guestfs-python.pod:23
25001 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
25002 "single string argument which is the error message."
25006 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:26
25007 #: ../python/examples/guestfs-python.pod:26
25008 msgid "MORE DOCUMENTATION"
25012 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:28
25013 #: ../python/examples/guestfs-python.pod:28
25018 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:30
25019 #: ../python/examples/guestfs-python.pod:30
25023 " >>> import guestfs\n"
25024 " >>> help (guestfs)\n"
25029 #: ../libguestfs-1.11.19/python/examples/guestfs-python.pod:44
25030 #: ../python/examples/guestfs-python.pod:44
25032 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)"
25033 ">, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
25037 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:5 ../rescue/virt-rescue.pod:5
25038 msgid "virt-rescue - Run a rescue shell on a virtual machine"
25042 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:9 ../rescue/virt-rescue.pod:9
25045 " virt-rescue [--options] -d domname\n"
25050 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:11
25051 #: ../rescue/virt-rescue.pod:11
25054 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
25059 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:15
25060 #: ../rescue/virt-rescue.pod:15
25063 " virt-rescue [--options] domname\n"
25068 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:17
25069 #: ../rescue/virt-rescue.pod:17
25072 " virt-rescue [--options] disk.img [disk.img ...]\n"
25077 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:21
25078 #: ../rescue/virt-rescue.pod:21
25080 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
25081 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
25082 "you from doing this, but doesn't catch all cases."
25086 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:25
25087 #: ../rescue/virt-rescue.pod:25
25089 "However if you use the I<--ro> (read only) option, then you can attach a "
25090 "shell to a live virtual machine. The results might be strange or "
25091 "inconsistent at times but you won't get disk corruption."
25095 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:31
25096 #: ../rescue/virt-rescue.pod:31
25098 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
25099 "need for a CD. virt-rescue gives you a rescue shell and some simple "
25100 "recovery tools which you can use to examine or rescue a virtual machine or "
25105 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:36
25106 #: ../rescue/virt-rescue.pod:36
25108 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
25109 "on disk image(s):"
25113 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:39
25114 #: ../rescue/virt-rescue.pod:39
25117 " virt-rescue -d GuestName\n"
25122 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:41
25123 #: ../rescue/virt-rescue.pod:41
25126 " virt-rescue --ro -a /path/to/disk.img\n"
25131 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:43
25132 #: ../rescue/virt-rescue.pod:43
25135 " virt-rescue -a /dev/sdc\n"
25140 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:45
25141 #: ../rescue/virt-rescue.pod:45
25142 msgid "For live VMs you I<must> use the --ro option."
25146 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:47
25147 #: ../rescue/virt-rescue.pod:47
25149 "When you run virt-rescue on a virtual machine or disk image, you are placed "
25150 "in an interactive bash shell where you can use many ordinary Linux "
25151 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
25152 "appliance. You must mount the virtual machine's filesystems by hand. There "
25153 "is an empty directory called C</sysroot> where you can mount filesystems."
25157 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:54
25158 #: ../rescue/virt-rescue.pod:54
25160 "In the example below, we list logical volumes, then choose one to mount "
25161 "under C</sysroot>:"
25165 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:57
25166 #: ../rescue/virt-rescue.pod:57
25170 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
25171 " lv_root vg_f11x64 -wi-a- 8.83G\n"
25172 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
25173 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
25174 " ><rescue> ls /sysroot\n"
25179 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:64
25180 #: ../rescue/virt-rescue.pod:64
25182 "If you don't know what filesystems are available on the virtual machine then "
25183 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
25187 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:70
25188 #: ../rescue/virt-rescue.pod:70
25190 "Virt-rescue can be used on I<any> disk image file or device, not just a "
25191 "virtual machine. For example you can use it on a blank file if you want to "
25192 "partition that file (although we would recommend using L<guestfish(1)> "
25193 "instead as it is more suitable for this purpose). You can even use virt-"
25194 "rescue on things like SD cards."
25198 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:76
25199 #: ../rescue/virt-rescue.pod:76
25201 "Virt-rescue does not require root. You only need to run it as root if you "
25202 "need root to open the disk image."
25206 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:79
25207 #: ../rescue/virt-rescue.pod:79
25209 "This tool is just designed for quick interactive hacking on a virtual "
25210 "machine. For more structured access to a virtual machine disk image, you "
25211 "should use L<guestfs(3)>. To get a structured shell that you can use to "
25212 "make scripted changes to guests, use L<guestfish(1)>."
25216 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:103
25217 #: ../rescue/virt-rescue.pod:103
25218 msgid "B<--append kernelopts>"
25222 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:105
25223 #: ../rescue/virt-rescue.pod:105
25224 msgid "Pass additional options to the rescue kernel."
25228 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:135
25229 #: ../rescue/virt-rescue.pod:135
25232 " virt-rescue --format=raw -a disk.img\n"
25237 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:139
25238 #: ../rescue/virt-rescue.pod:139
25241 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
25246 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:148
25247 #: ../rescue/virt-rescue.pod:148
25252 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:150
25253 #: ../rescue/virt-rescue.pod:150
25254 msgid "B<--memsize MB>"
25258 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:152
25259 #: ../rescue/virt-rescue.pod:152
25261 "Change the amount of memory allocated to the rescue system. The default is "
25262 "set by libguestfs and is small but adequate for running system tools. The "
25263 "occasional program might need more memory. The parameter is specified in "
25268 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:157
25269 #: ../rescue/virt-rescue.pod:157
25270 msgid "B<--network>"
25274 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:159
25275 #: ../rescue/virt-rescue.pod:159
25276 msgid "Enable QEMU user networking in the guest. See L</NETWORK>."
25280 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:165
25281 #: ../rescue/virt-rescue.pod:165
25282 msgid "Open the image read-only."
25286 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:175
25287 #: ../rescue/virt-rescue.pod:175
25289 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
25290 "SELINUX> before using this option."
25294 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:194
25295 #: ../rescue/virt-rescue.pod:194
25297 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
25298 "are done read-write."
25302 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:207
25303 #: ../rescue/virt-rescue.pod:207
25304 msgid "Previous versions of virt-rescue allowed you to write either:"
25308 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:209
25309 #: ../rescue/virt-rescue.pod:209
25312 " virt-rescue disk.img [disk.img ...]\n"
25317 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:213
25318 #: ../rescue/virt-rescue.pod:213
25321 " virt-rescue guestname\n"
25326 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:221
25327 #: ../rescue/virt-rescue.pod:221
25332 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:223
25333 #: ../rescue/virt-rescue.pod:223
25335 "Adding the I<--network> option enables QEMU user networking in the rescue "
25336 "appliance. There are some differences between user networking and ordinary "
25341 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:229
25342 #: ../rescue/virt-rescue.pod:229
25343 msgid "ping does not work"
25347 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:231
25348 #: ../rescue/virt-rescue.pod:231
25350 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
25351 "send the ping packets, and because virt-rescue must be able to run as non-"
25352 "root, QEMU user networking is not able to emulate the L<ping(8)> command. "
25353 "The ping command will appear to resolve addresses but will not be able to "
25354 "send or receive any packets. This does not mean that the network is not "
25359 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:238
25360 #: ../rescue/virt-rescue.pod:238
25361 msgid "cannot receive connections"
25365 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:240
25366 #: ../rescue/virt-rescue.pod:240
25367 msgid "QEMU user networking cannot receive incoming connections."
25371 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:242
25372 #: ../rescue/virt-rescue.pod:242
25373 msgid "making TCP connections"
25377 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:244
25378 #: ../rescue/virt-rescue.pod:244
25380 "The virt-rescue appliance needs to be small and so does not include many "
25381 "network tools. In particular there is no L<telnet(1)> command. You can "
25382 "make TCP connections from the shell using the magical C</dev/tcp/"
25383 "E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
25387 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:249
25388 #: ../rescue/virt-rescue.pod:249
25391 " exec 3<>/dev/tcp/redhat.com/80\n"
25392 " echo \"GET /\" >&3\n"
25398 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:253
25399 #: ../rescue/virt-rescue.pod:253
25400 msgid "See L<bash(1)> for more details."
25404 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:259
25405 #: ../rescue/virt-rescue.pod:259
25407 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
25408 "ENVIRONMENT VARIABLES> for the complete list."
25412 #: ../libguestfs-1.11.19/rescue/virt-rescue.pod:286
25413 #: ../rescue/virt-rescue.pod:286
25415 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<http://"
25416 "libguestfs.org/>."
25420 #: ../libguestfs-1.11.19/resize/virt-resize.pod:5 ../resize/virt-resize.pod:5
25421 msgid "virt-resize - Resize a virtual machine disk"
25425 #: ../libguestfs-1.11.19/resize/virt-resize.pod:9 ../resize/virt-resize.pod:9
25428 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
25429 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
25430 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
25435 #: ../libguestfs-1.11.19/resize/virt-resize.pod:15
25436 #: ../resize/virt-resize.pod:15
25438 "Virt-resize is a tool which can resize a virtual machine disk, making it "
25439 "larger or smaller overall, and resizing or deleting any partitions contained "
25444 #: ../libguestfs-1.11.19/resize/virt-resize.pod:19
25445 #: ../resize/virt-resize.pod:19
25447 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
25448 "not> be used on live virtual machines - for consistent results, shut the "
25449 "virtual machine down before resizing it."
25453 #: ../libguestfs-1.11.19/resize/virt-resize.pod:23
25454 #: ../resize/virt-resize.pod:23
25456 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
25457 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
25461 #: ../libguestfs-1.11.19/resize/virt-resize.pod:31
25462 #: ../libguestfs-1.11.19/src/guestfs.pod:469
25463 #: ../libguestfs-1.11.19/src/guestfs.pod:1257
25464 #: ../libguestfs-1.11.19/src/guestfs.pod:1395
25465 #: ../libguestfs-1.11.19/src/guestfs.pod:2465 ../resize/virt-resize.pod:31
25466 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395
25467 #: ../src/guestfs.pod:2465
25472 #: ../libguestfs-1.11.19/resize/virt-resize.pod:33
25473 #: ../resize/virt-resize.pod:33
25475 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
25476 "fill the extra 5GB of space."
25480 #: ../libguestfs-1.11.19/resize/virt-resize.pod:36
25481 #: ../resize/virt-resize.pod:36
25484 " virt-filesystems --long -h --all -a olddisk\n"
25489 #: ../libguestfs-1.11.19/resize/virt-resize.pod:38
25490 #: ../resize/virt-resize.pod:38
25493 " truncate -r olddisk newdisk\n"
25494 " truncate -s +5G newdisk\n"
25499 #: ../libguestfs-1.11.19/resize/virt-resize.pod:41
25500 #: ../resize/virt-resize.pod:41
25503 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
25504 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
25509 #: ../libguestfs-1.11.19/resize/virt-resize.pod:44
25510 #: ../libguestfs-1.11.19/src/guestfs.pod:475
25511 #: ../libguestfs-1.11.19/src/guestfs.pod:1261
25512 #: ../libguestfs-1.11.19/src/guestfs.pod:1399
25513 #: ../libguestfs-1.11.19/src/guestfs.pod:2490 ../resize/virt-resize.pod:44
25514 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399
25515 #: ../src/guestfs.pod:2490
25520 #: ../libguestfs-1.11.19/resize/virt-resize.pod:46
25521 #: ../resize/virt-resize.pod:46
25523 "As above, but make the /boot partition 200MB bigger, while giving the "
25524 "remaining space to /dev/sda2:"
25528 #: ../libguestfs-1.11.19/resize/virt-resize.pod:49
25529 #: ../resize/virt-resize.pod:49
25532 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
25533 " olddisk newdisk\n"
25538 #: ../libguestfs-1.11.19/resize/virt-resize.pod:52
25539 #: ../libguestfs-1.11.19/src/guestfs.pod:486
25540 #: ../libguestfs-1.11.19/src/guestfs.pod:1405 ../resize/virt-resize.pod:52
25541 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
25546 #: ../libguestfs-1.11.19/resize/virt-resize.pod:54
25547 #: ../resize/virt-resize.pod:54
25549 "As in the first example, but expand a logical volume as the final step. "
25550 "This is what you would typically use for Linux guests that use LVM:"
25554 #: ../libguestfs-1.11.19/resize/virt-resize.pod:58
25555 #: ../resize/virt-resize.pod:58
25558 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
25559 " olddisk newdisk\n"
25564 #: ../libguestfs-1.11.19/resize/virt-resize.pod:61
25565 #: ../resize/virt-resize.pod:61
25570 #: ../libguestfs-1.11.19/resize/virt-resize.pod:63
25571 #: ../resize/virt-resize.pod:63
25573 "As in the first example, but the output format will be qcow2 instead of a "
25578 #: ../libguestfs-1.11.19/resize/virt-resize.pod:66
25579 #: ../resize/virt-resize.pod:66
25582 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
25583 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
25588 #: ../libguestfs-1.11.19/resize/virt-resize.pod:71
25589 #: ../resize/virt-resize.pod:71
25590 msgid "DETAILED USAGE"
25594 #: ../libguestfs-1.11.19/resize/virt-resize.pod:73
25595 #: ../resize/virt-resize.pod:73
25596 msgid "EXPANDING A VIRTUAL MACHINE DISK"
25600 #: ../libguestfs-1.11.19/resize/virt-resize.pod:77
25601 #: ../resize/virt-resize.pod:77
25602 msgid "1. Shut down the virtual machine"
25606 #: ../libguestfs-1.11.19/resize/virt-resize.pod:79
25607 #: ../resize/virt-resize.pod:79
25608 msgid "2. Locate input disk image"
25612 #: ../libguestfs-1.11.19/resize/virt-resize.pod:81
25613 #: ../resize/virt-resize.pod:81
25615 "Locate the input disk image (ie. the file or device on the host containing "
25616 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
25617 "dumpxml> like this to find the disk image name:"
25621 #: ../libguestfs-1.11.19/resize/virt-resize.pod:85
25622 #: ../resize/virt-resize.pod:85
25625 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
25626 " Found 1 nodes:\n"
25628 " <source dev=\"/dev/vg/lv_guest\" />\n"
25633 #: ../libguestfs-1.11.19/resize/virt-resize.pod:90
25634 #: ../resize/virt-resize.pod:90
25635 msgid "3. Look at current sizing"
25639 #: ../libguestfs-1.11.19/resize/virt-resize.pod:92
25640 #: ../resize/virt-resize.pod:92
25641 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
25645 #: ../libguestfs-1.11.19/resize/virt-resize.pod:95
25646 #: ../resize/virt-resize.pod:95
25649 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
25650 " Name Type Size Parent\n"
25651 " /dev/sda1 partition 101M /dev/sda\n"
25652 " /dev/sda2 partition 7.9G /dev/sda\n"
25653 " /dev/sda device 8.0G -\n"
25658 #: ../libguestfs-1.11.19/resize/virt-resize.pod:101
25659 #: ../resize/virt-resize.pod:101
25661 "(This example is a virtual machine with an 8 GB disk which we would like to "
25662 "expand up to 10 GB)."
25666 #: ../libguestfs-1.11.19/resize/virt-resize.pod:104
25667 #: ../resize/virt-resize.pod:104
25668 msgid "4. Create output disk"
25672 #: ../libguestfs-1.11.19/resize/virt-resize.pod:106
25673 #: ../resize/virt-resize.pod:106
25675 "Virt-resize cannot do in-place disk modifications. You have to have space "
25676 "to store the resized output disk."
25680 #: ../libguestfs-1.11.19/resize/virt-resize.pod:109
25681 #: ../resize/virt-resize.pod:109
25683 "To store the resized disk image in a file, create a file of a suitable size:"
25687 #: ../libguestfs-1.11.19/resize/virt-resize.pod:112
25688 #: ../resize/virt-resize.pod:112
25691 " # rm -f outdisk\n"
25692 " # truncate -s 10G outdisk\n"
25697 #: ../libguestfs-1.11.19/resize/virt-resize.pod:115
25698 #: ../resize/virt-resize.pod:115
25699 msgid "Or use L<lvcreate(1)> to create a logical volume:"
25703 #: ../libguestfs-1.11.19/resize/virt-resize.pod:117
25704 #: ../resize/virt-resize.pod:117
25707 " # lvcreate -L 10G -n lv_name vg_name\n"
25712 #: ../libguestfs-1.11.19/resize/virt-resize.pod:119
25713 #: ../resize/virt-resize.pod:119
25714 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
25718 #: ../libguestfs-1.11.19/resize/virt-resize.pod:121
25719 #: ../resize/virt-resize.pod:121
25722 " # virsh pool-list\n"
25723 " # virsh vol-create-as poolname newvol 10G\n"
25728 #: ../libguestfs-1.11.19/resize/virt-resize.pod:124
25729 #: ../resize/virt-resize.pod:124
25734 #: ../libguestfs-1.11.19/resize/virt-resize.pod:126
25735 #: ../resize/virt-resize.pod:126
25737 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
25738 "file) and the output disk. The output disk is the one created in the "
25743 #: ../libguestfs-1.11.19/resize/virt-resize.pod:130
25744 #: ../resize/virt-resize.pod:130
25747 " # virt-resize indisk outdisk\n"
25752 #: ../libguestfs-1.11.19/resize/virt-resize.pod:132
25753 #: ../resize/virt-resize.pod:132
25755 "This command just copies disk image C<indisk> to disk image C<outdisk> "
25756 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
25757 "larger, then an extra, empty partition is created at the end of the disk "
25758 "covering the extra space. If C<outdisk> is smaller, then it will give an "
25763 #: ../libguestfs-1.11.19/resize/virt-resize.pod:138
25764 #: ../resize/virt-resize.pod:138
25766 "More realistically you'd want to expand existing partitions in the disk "
25767 "image by passing extra options (for the full list see the L</OPTIONS> "
25772 #: ../libguestfs-1.11.19/resize/virt-resize.pod:142
25773 #: ../resize/virt-resize.pod:142
25775 "L</--expand> is the most useful option. It expands the named partition "
25776 "within the disk to fill any extra space:"
25780 #: ../libguestfs-1.11.19/resize/virt-resize.pod:145
25781 #: ../resize/virt-resize.pod:145
25784 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
25789 #: ../libguestfs-1.11.19/resize/virt-resize.pod:147
25790 #: ../resize/virt-resize.pod:147
25792 "(In this case, an extra partition is I<not> created at the end of the disk, "
25793 "because there will be no unused space)."
25797 #: ../libguestfs-1.11.19/resize/virt-resize.pod:150
25798 #: ../resize/virt-resize.pod:150
25800 "L</--resize> is the other commonly used option. The following would "
25801 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
25802 "rest of the available space:"
25806 #: ../libguestfs-1.11.19/resize/virt-resize.pod:154
25807 #: ../resize/virt-resize.pod:154
25810 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
25811 " indisk outdisk\n"
25816 #: ../libguestfs-1.11.19/resize/virt-resize.pod:157
25817 #: ../resize/virt-resize.pod:157
25819 "If the expanded partition in the image contains a filesystem or LVM PV, then "
25820 "if virt-resize knows how, it will resize the contents, the equivalent of "
25821 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
25822 "or L<btrfs(8)>. However virt-resize does not know how to resize some "
25823 "filesystems, so you would have to online resize them after booting the guest."
25827 #: ../libguestfs-1.11.19/resize/virt-resize.pod:164
25828 #: ../resize/virt-resize.pod:164
25829 msgid "Other options are covered below."
25833 #: ../libguestfs-1.11.19/resize/virt-resize.pod:166
25834 #: ../resize/virt-resize.pod:166
25839 #: ../libguestfs-1.11.19/resize/virt-resize.pod:168
25840 #: ../resize/virt-resize.pod:168
25841 msgid "Thoroughly test the new disk image I<before> discarding the old one."
25845 #: ../libguestfs-1.11.19/resize/virt-resize.pod:170
25846 #: ../resize/virt-resize.pod:170
25847 msgid "If you are using libvirt, edit the XML to point at the new disk:"
25851 #: ../libguestfs-1.11.19/resize/virt-resize.pod:172
25852 #: ../resize/virt-resize.pod:172
25855 " # virsh edit guestname\n"
25860 #: ../libguestfs-1.11.19/resize/virt-resize.pod:174
25861 #: ../resize/virt-resize.pod:174
25863 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
25864 "html#elementsDisks>"
25868 #: ../libguestfs-1.11.19/resize/virt-resize.pod:177
25869 #: ../resize/virt-resize.pod:177
25870 msgid "Then start up the domain with the new, resized disk:"
25874 #: ../libguestfs-1.11.19/resize/virt-resize.pod:179
25875 #: ../resize/virt-resize.pod:179
25878 " # virsh start guestname\n"
25883 #: ../libguestfs-1.11.19/resize/virt-resize.pod:181
25884 #: ../resize/virt-resize.pod:181
25886 "and check that it still works. See also the L</NOTES> section below for "
25887 "additional information."
25891 #: ../libguestfs-1.11.19/resize/virt-resize.pod:184
25892 #: ../resize/virt-resize.pod:184
25893 msgid "7. Resize LVs etc inside the guest"
25897 #: ../libguestfs-1.11.19/resize/virt-resize.pod:186
25898 #: ../resize/virt-resize.pod:186
25899 msgid "(This can also be done offline using L<guestfish(1)>)"
25903 #: ../libguestfs-1.11.19/resize/virt-resize.pod:188
25904 #: ../resize/virt-resize.pod:188
25906 "Once the guest has booted you should see the new space available, at least "
25907 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
25908 "may need to resize LVs inside PVs, and also resize filesystem types that "
25909 "virt-resize does not know how to expand."
25913 #: ../libguestfs-1.11.19/resize/virt-resize.pod:195
25914 #: ../resize/virt-resize.pod:195
25915 msgid "SHRINKING A VIRTUAL MACHINE DISK"
25919 #: ../libguestfs-1.11.19/resize/virt-resize.pod:197
25920 #: ../resize/virt-resize.pod:197
25922 "Shrinking is somewhat more complex than expanding, and only an overview is "
25927 #: ../libguestfs-1.11.19/resize/virt-resize.pod:200
25928 #: ../resize/virt-resize.pod:200
25930 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
25931 "filesystems). The user has to shrink content before passing the disk image "
25932 "to virt-resize, and virt-resize will check that the content has been shrunk "
25937 #: ../libguestfs-1.11.19/resize/virt-resize.pod:205
25938 #: ../resize/virt-resize.pod:205
25939 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
25943 #: ../libguestfs-1.11.19/resize/virt-resize.pod:207
25944 #: ../resize/virt-resize.pod:207
25946 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
25947 "steps 3 and 4 above to allocate a new disk image."
25951 #: ../libguestfs-1.11.19/resize/virt-resize.pod:210
25952 #: ../resize/virt-resize.pod:210
25954 "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
25958 #: ../libguestfs-1.11.19/resize/virt-resize.pod:213
25959 #: ../resize/virt-resize.pod:213
25960 msgid "IGNORING OR DELETING PARTITIONS"
25964 #: ../libguestfs-1.11.19/resize/virt-resize.pod:215
25965 #: ../resize/virt-resize.pod:215
25967 "virt-resize also gives a convenient way to ignore or delete partitions when "
25968 "copying from the input disk to the output disk. Ignoring a partition speeds "
25969 "up the copy where you don't care about the existing contents of a "
25970 "partition. Deleting a partition removes it completely, but note that it "
25971 "also renumbers any partitions after the one which is deleted, which can "
25972 "leave some guests unbootable."
25976 #: ../libguestfs-1.11.19/resize/virt-resize.pod:222
25977 #: ../resize/virt-resize.pod:222
25978 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
25982 #: ../libguestfs-1.11.19/resize/virt-resize.pod:224
25983 #: ../resize/virt-resize.pod:224
25985 "If the input disk is in qcow2 format, then you may prefer that the output is "
25986 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
25987 "the fly. The output format is simply determined by the format of the empty "
25988 "output container that you provide. Thus to create qcow2 output, use:"
25992 #: ../libguestfs-1.11.19/resize/virt-resize.pod:230
25993 #: ../resize/virt-resize.pod:230
25996 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
26001 #: ../libguestfs-1.11.19/resize/virt-resize.pod:232
26002 #: ../resize/virt-resize.pod:232
26003 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
26007 #: ../libguestfs-1.11.19/resize/virt-resize.pod:234
26008 #: ../resize/virt-resize.pod:234
26009 msgid "Similarly, to get non-sparse raw output use:"
26013 #: ../libguestfs-1.11.19/resize/virt-resize.pod:236
26014 #: ../resize/virt-resize.pod:236
26017 " fallocate -l size outdisk\n"
26022 #: ../libguestfs-1.11.19/resize/virt-resize.pod:238
26023 #: ../resize/virt-resize.pod:238
26025 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
26026 "dev/zero of=outdisk bs=1M count=..>)"
26030 #: ../libguestfs-1.11.19/resize/virt-resize.pod:247
26031 #: ../resize/virt-resize.pod:247
26032 msgid "Display help."
26036 #: ../libguestfs-1.11.19/resize/virt-resize.pod:249
26037 #: ../resize/virt-resize.pod:249
26042 #: ../libguestfs-1.11.19/resize/virt-resize.pod:251
26043 #: ../resize/virt-resize.pod:251 ../tools/virt-make-fs.pl:177
26044 #: ../tools/virt-win-reg.pl:120
26049 #: ../libguestfs-1.11.19/resize/virt-resize.pod:253
26050 #: ../resize/virt-resize.pod:253 ../tools/virt-win-reg.pl:122
26051 msgid "Enable debugging messages."
26055 #: ../libguestfs-1.11.19/resize/virt-resize.pod:255
26056 #: ../resize/virt-resize.pod:255
26057 msgid "B<--delete part>"
26061 #: ../libguestfs-1.11.19/resize/virt-resize.pod:257
26062 #: ../resize/virt-resize.pod:257
26064 "Delete the named partition. It would be more accurate to describe this as "
26065 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
26066 "the original disk image is left intact."
26070 #: ../libguestfs-1.11.19/resize/virt-resize.pod:261
26071 #: ../resize/virt-resize.pod:261
26073 "Note that when you delete a partition, then anything contained in the "
26074 "partition is also deleted. Furthermore, this causes any partitions that "
26075 "come after to be I<renumbered>, which can easily make your guest unbootable."
26079 #: ../libguestfs-1.11.19/resize/virt-resize.pod:266
26080 #: ../libguestfs-1.11.19/resize/virt-resize.pod:327
26081 #: ../libguestfs-1.11.19/resize/virt-resize.pod:448
26082 #: ../resize/virt-resize.pod:266 ../resize/virt-resize.pod:327
26083 #: ../resize/virt-resize.pod:448
26084 msgid "You can give this option multiple times."
26088 #: ../libguestfs-1.11.19/resize/virt-resize.pod:268
26089 #: ../resize/virt-resize.pod:268
26090 msgid "B<--expand part>"
26094 #: ../libguestfs-1.11.19/resize/virt-resize.pod:270
26095 #: ../resize/virt-resize.pod:270
26097 "Expand the named partition so it uses up all extra space (space left over "
26098 "after any other resize changes that you request have been done)."
26102 #: ../libguestfs-1.11.19/resize/virt-resize.pod:273
26103 #: ../resize/virt-resize.pod:273
26105 "If virt-resize knows how, it will expand the direct content of the "
26106 "partition. For example, if the partition is an LVM PV, it will expand the "
26107 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
26108 "content it doesn't know about alone."
26112 #: ../libguestfs-1.11.19/resize/virt-resize.pod:278
26113 #: ../resize/virt-resize.pod:278
26114 msgid "Currently virt-resize can resize:"
26118 #: ../libguestfs-1.11.19/resize/virt-resize.pod:284
26119 #: ../resize/virt-resize.pod:284
26120 msgid "ext2, ext3 and ext4 filesystems."
26124 #: ../libguestfs-1.11.19/resize/virt-resize.pod:288
26125 #: ../resize/virt-resize.pod:288
26126 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
26130 #: ../libguestfs-1.11.19/resize/virt-resize.pod:290
26131 #: ../resize/virt-resize.pod:290
26133 "The filesystem must have been shut down consistently last time it was used. "
26134 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
26135 "consistency check, so at the first boot after resizing Windows will check "
26140 #: ../libguestfs-1.11.19/resize/virt-resize.pod:297
26141 #: ../resize/virt-resize.pod:297
26143 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
26144 "inside the PV, but see the I<--LV-expand> option. The user could also "
26145 "resize LVs as desired after boot."
26149 #: ../libguestfs-1.11.19/resize/virt-resize.pod:303
26150 #: ../resize/virt-resize.pod:303
26151 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
26155 #: ../libguestfs-1.11.19/resize/virt-resize.pod:307
26156 #: ../libguestfs-1.11.19/resize/virt-resize.pod:476
26157 #: ../resize/virt-resize.pod:307 ../resize/virt-resize.pod:476
26158 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
26162 #: ../libguestfs-1.11.19/resize/virt-resize.pod:309
26163 #: ../resize/virt-resize.pod:309 ../tools/virt-list-filesystems.pl:91
26164 #: ../tools/virt-list-partitions.pl:92 ../tools/virt-tar.pl:141
26165 #: ../tools/virt-win-reg.pl:142
26166 msgid "B<--format> raw"
26170 #: ../libguestfs-1.11.19/resize/virt-resize.pod:311
26171 #: ../resize/virt-resize.pod:311
26173 "Specify the format of the input disk image. If this flag is not given then "
26174 "it is auto-detected from the image itself."
26178 #: ../libguestfs-1.11.19/resize/virt-resize.pod:317
26179 #: ../resize/virt-resize.pod:317
26181 "Note that this option I<does not> affect the output format. See L</QCOW2 "
26182 "AND NON-SPARSE RAW FORMATS>."
26186 #: ../libguestfs-1.11.19/resize/virt-resize.pod:320
26187 #: ../resize/virt-resize.pod:320
26188 msgid "B<--ignore part>"
26192 #: ../libguestfs-1.11.19/resize/virt-resize.pod:322
26193 #: ../resize/virt-resize.pod:322
26195 "Ignore the named partition. Effectively this means the partition is "
26196 "allocated on the destination disk, but the content is not copied across from "
26197 "the source disk. The content of the partition will be blank (all zero "
26202 #: ../libguestfs-1.11.19/resize/virt-resize.pod:329
26203 #: ../resize/virt-resize.pod:329
26204 msgid "B<--LV-expand logvol>"
26208 #: ../libguestfs-1.11.19/resize/virt-resize.pod:331
26209 #: ../resize/virt-resize.pod:331
26211 "This takes the logical volume and, as a final step, expands it to fill all "
26212 "the space available in its volume group. A typical usage, assuming a Linux "
26213 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
26214 "lv_root> would be:"
26218 #: ../libguestfs-1.11.19/resize/virt-resize.pod:336
26219 #: ../resize/virt-resize.pod:336
26222 " virt-resize indisk outdisk \\\n"
26223 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
26228 #: ../libguestfs-1.11.19/resize/virt-resize.pod:339
26229 #: ../resize/virt-resize.pod:339
26231 "This would first expand the partition (and PV), and then expand the root "
26232 "device to fill the extra space in the PV."
26236 #: ../libguestfs-1.11.19/resize/virt-resize.pod:342
26237 #: ../resize/virt-resize.pod:342
26239 "The contents of the LV are also resized if virt-resize knows how to do "
26240 "that. You can stop virt-resize from trying to expand the content by using "
26241 "the option I<--no-expand-content>."
26245 #: ../libguestfs-1.11.19/resize/virt-resize.pod:346
26246 #: ../resize/virt-resize.pod:346
26247 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
26251 #: ../libguestfs-1.11.19/resize/virt-resize.pod:348
26252 #: ../resize/virt-resize.pod:348
26254 "You can give this option multiple times, I<but> it doesn't make sense to do "
26255 "this unless the logical volumes you specify are all in different volume "
26260 #: ../libguestfs-1.11.19/resize/virt-resize.pod:354
26261 #: ../resize/virt-resize.pod:354
26262 msgid "B<--dryrun>"
26266 #: ../libguestfs-1.11.19/resize/virt-resize.pod:356
26267 #: ../resize/virt-resize.pod:356
26268 msgid "Print a summary of what would be done, but don't do anything."
26272 #: ../libguestfs-1.11.19/resize/virt-resize.pod:358
26273 #: ../resize/virt-resize.pod:358
26274 msgid "B<--no-copy-boot-loader>"
26278 #: ../libguestfs-1.11.19/resize/virt-resize.pod:360
26279 #: ../resize/virt-resize.pod:360
26281 "By default, virt-resize copies over some sectors at the start of the disk "
26282 "(up to the beginning of the first partition). Commonly these sectors "
26283 "contain the Master Boot Record (MBR) and the boot loader, and are required "
26284 "in order for the guest to boot correctly."
26288 #: ../libguestfs-1.11.19/resize/virt-resize.pod:365
26289 #: ../resize/virt-resize.pod:365
26291 "If you specify this flag, then this initial copy is not done. You may need "
26292 "to reinstall the boot loader in this case."
26296 #: ../libguestfs-1.11.19/resize/virt-resize.pod:368
26297 #: ../resize/virt-resize.pod:368
26298 msgid "B<--no-extra-partition>"
26302 #: ../libguestfs-1.11.19/resize/virt-resize.pod:370
26303 #: ../resize/virt-resize.pod:370
26305 "By default, virt-resize creates an extra partition if there is any extra, "
26306 "unused space after all resizing has happened. Use this option to prevent "
26307 "the extra partition from being created. If you do this then the extra space "
26308 "will be inaccessible until you run fdisk, parted, or some other partitioning "
26309 "tool in the guest."
26313 #: ../libguestfs-1.11.19/resize/virt-resize.pod:376
26314 #: ../resize/virt-resize.pod:376
26316 "Note that if the surplus space is smaller than 10 MB, no extra partition "
26321 #: ../libguestfs-1.11.19/resize/virt-resize.pod:379
26322 #: ../resize/virt-resize.pod:379
26323 msgid "B<--no-expand-content>"
26327 #: ../libguestfs-1.11.19/resize/virt-resize.pod:381
26328 #: ../resize/virt-resize.pod:381
26330 "By default, virt-resize will try to expand the direct contents of "
26331 "partitions, if it knows how (see I<--expand> option above)."
26335 #: ../libguestfs-1.11.19/resize/virt-resize.pod:384
26336 #: ../resize/virt-resize.pod:384
26338 "If you give the I<--no-expand-content> option then virt-resize will not "
26343 #: ../libguestfs-1.11.19/resize/virt-resize.pod:387
26344 #: ../resize/virt-resize.pod:387
26345 msgid "B<--ntfsresize-force>"
26349 #: ../libguestfs-1.11.19/resize/virt-resize.pod:389
26350 #: ../resize/virt-resize.pod:389
26352 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
26353 "the NTFS disk is marked as needing a consistency check. You have to use "
26354 "this option if you want to resize a Windows guest multiple times without "
26355 "booting into Windows between each resize."
26359 #: ../libguestfs-1.11.19/resize/virt-resize.pod:395
26360 #: ../resize/virt-resize.pod:395
26361 msgid "B<--output-format> raw"
26365 #: ../libguestfs-1.11.19/resize/virt-resize.pod:397
26366 #: ../resize/virt-resize.pod:397
26368 "Specify the format of the output disk image. If this flag is not given then "
26369 "it is auto-detected from the image itself."
26373 #: ../libguestfs-1.11.19/resize/virt-resize.pod:403
26374 #: ../resize/virt-resize.pod:403
26376 "Note that this option I<does not create> the output format. This option "
26377 "just tells libguestfs what it is so it doesn't try to guess it. You still "
26378 "need to create the output disk with the right format. See L</QCOW2 AND NON-"
26379 "SPARSE RAW FORMATS>."
26383 #: ../libguestfs-1.11.19/resize/virt-resize.pod:408
26384 #: ../resize/virt-resize.pod:408
26389 #: ../libguestfs-1.11.19/resize/virt-resize.pod:410
26390 #: ../resize/virt-resize.pod:410
26395 #: ../libguestfs-1.11.19/resize/virt-resize.pod:412
26396 #: ../resize/virt-resize.pod:412
26397 msgid "Don't print the summary."
26401 #: ../libguestfs-1.11.19/resize/virt-resize.pod:414
26402 #: ../resize/virt-resize.pod:414
26403 msgid "B<--resize part=size>"
26407 #: ../libguestfs-1.11.19/resize/virt-resize.pod:416
26408 #: ../resize/virt-resize.pod:416
26410 "Resize the named partition (expanding or shrinking it) so that it has the "
26415 #: ../libguestfs-1.11.19/resize/virt-resize.pod:419
26416 #: ../resize/virt-resize.pod:419
26418 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
26419 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
26420 "size; or as a relative number or percentage. For example:"
26424 #: ../libguestfs-1.11.19/resize/virt-resize.pod:425
26425 #: ../resize/virt-resize.pod:425
26428 " --resize /dev/sda2=10G\n"
26433 #: ../libguestfs-1.11.19/resize/virt-resize.pod:427
26434 #: ../resize/virt-resize.pod:427
26437 " --resize /dev/sda4=90%\n"
26442 #: ../libguestfs-1.11.19/resize/virt-resize.pod:429
26443 #: ../resize/virt-resize.pod:429
26446 " --resize /dev/sda2=+1G\n"
26451 #: ../libguestfs-1.11.19/resize/virt-resize.pod:431
26452 #: ../resize/virt-resize.pod:431
26455 " --resize /dev/sda2=-200M\n"
26460 #: ../libguestfs-1.11.19/resize/virt-resize.pod:433
26461 #: ../resize/virt-resize.pod:433
26464 " --resize /dev/sda1=+128K\n"
26469 #: ../libguestfs-1.11.19/resize/virt-resize.pod:435
26470 #: ../resize/virt-resize.pod:435
26473 " --resize /dev/sda1=+10%\n"
26478 #: ../libguestfs-1.11.19/resize/virt-resize.pod:437
26479 #: ../resize/virt-resize.pod:437
26482 " --resize /dev/sda1=-10%\n"
26487 #: ../libguestfs-1.11.19/resize/virt-resize.pod:439
26488 #: ../resize/virt-resize.pod:439
26490 "You can increase the size of any partition. Virt-resize will expand the "
26491 "direct content of the partition if it knows how (see I<--expand> below)."
26495 #: ../libguestfs-1.11.19/resize/virt-resize.pod:443
26496 #: ../resize/virt-resize.pod:443
26498 "You can only I<decrease> the size of partitions that contain filesystems or "
26499 "PVs which have already been shrunk. Virt-resize will check this has been "
26500 "done before proceeding, or else will print an error (see also I<--resize-"
26505 #: ../libguestfs-1.11.19/resize/virt-resize.pod:450
26506 #: ../resize/virt-resize.pod:450
26507 msgid "B<--resize-force part=size>"
26511 #: ../libguestfs-1.11.19/resize/virt-resize.pod:452
26512 #: ../resize/virt-resize.pod:452
26514 "This is the same as I<--resize> except that it will let you decrease the "
26515 "size of any partition. Generally this means you will lose any data which "
26516 "was at the end of the partition you shrink, but you may not care about that "
26517 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
26518 "as a swap partition)."
26522 #: ../libguestfs-1.11.19/resize/virt-resize.pod:458
26523 #: ../resize/virt-resize.pod:458
26524 msgid "See also the I<--ignore> option."
26528 #: ../libguestfs-1.11.19/resize/virt-resize.pod:460
26529 #: ../resize/virt-resize.pod:460
26530 msgid "B<--shrink part>"
26534 #: ../libguestfs-1.11.19/resize/virt-resize.pod:462
26535 #: ../resize/virt-resize.pod:462
26537 "Shrink the named partition until the overall disk image fits in the "
26538 "destination. The named partition B<must> contain a filesystem or PV which "
26539 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
26540 "online tools). Virt-resize will check this and give an error if it has not "
26545 #: ../libguestfs-1.11.19/resize/virt-resize.pod:468
26546 #: ../resize/virt-resize.pod:468
26548 "The amount by which the overall disk must be shrunk (after carrying out all "
26549 "other operations requested by the user) is called the \"deficit\". For "
26550 "example, a straight copy (assume no other operations) from a 5GB disk image "
26551 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
26552 "would give an error unless the user specified a partition to shrink and that "
26553 "partition had more than a gigabyte of free space."
26557 #: ../libguestfs-1.11.19/resize/virt-resize.pod:488
26558 #: ../resize/virt-resize.pod:488
26559 msgid "\"Partition 1 does not end on cylinder boundary.\""
26563 #: ../libguestfs-1.11.19/resize/virt-resize.pod:490
26564 #: ../resize/virt-resize.pod:490
26566 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
26567 "means the partitions will not be aligned to the ancient CHS geometry. "
26568 "However CHS geometry is meaningless for disks manufactured since the early "
26569 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
26570 "cylinders is not required by any modern operating system."
26574 #: ../libguestfs-1.11.19/resize/virt-resize.pod:497
26575 #: ../resize/virt-resize.pod:497
26576 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
26580 #: ../libguestfs-1.11.19/resize/virt-resize.pod:499
26581 #: ../resize/virt-resize.pod:499
26583 "In Windows Vista and later versions, Microsoft switched to using a separate "
26584 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
26585 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
26586 "the boot partition. Doing so seems to break the guest completely. However "
26587 "expanding the second partition (ie. C: drive) should work."
26591 #: ../libguestfs-1.11.19/resize/virt-resize.pod:506
26592 #: ../resize/virt-resize.pod:506
26594 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
26595 "NTFS partitions have been expanded. This is just a safety check and (unless "
26596 "it find errors) is nothing to worry about."
26600 #: ../libguestfs-1.11.19/resize/virt-resize.pod:510
26601 #: ../resize/virt-resize.pod:510
26602 msgid "GUEST BOOT STUCK AT \"GRUB\""
26606 #: ../libguestfs-1.11.19/resize/virt-resize.pod:512
26607 #: ../resize/virt-resize.pod:512
26609 "If a Linux guest does not boot after resizing, and the boot is stuck after "
26610 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
26611 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
26612 "although we think is to do with partition alignment."
26616 #: ../libguestfs-1.11.19/resize/virt-resize.pod:517
26617 #: ../resize/virt-resize.pod:517
26620 " guestfish -i -a newdisk\n"
26621 " ><fs> cat /boot/grub/device.map\n"
26622 " # check the contents of this file are sensible or\n"
26623 " # edit the file if necessary\n"
26624 " ><fs> grub-install / /dev/vda\n"
26630 #: ../libguestfs-1.11.19/resize/virt-resize.pod:524
26631 #: ../resize/virt-resize.pod:524
26633 "For more flexible guest reconfiguration, including if you need to specify "
26634 "other parameters to grub-install, use L<virt-rescue(1)>."
26638 #: ../libguestfs-1.11.19/resize/virt-resize.pod:527
26639 #: ../resize/virt-resize.pod:527
26640 msgid "ALTERNATIVE TOOLS"
26644 #: ../libguestfs-1.11.19/resize/virt-resize.pod:529
26645 #: ../resize/virt-resize.pod:529
26647 "There are several proprietary tools for resizing partitions. We won't "
26648 "mention any here."
26652 #: ../libguestfs-1.11.19/resize/virt-resize.pod:532
26653 #: ../resize/virt-resize.pod:532
26655 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
26656 "operations on disk images. They can resize and move partitions, but I don't "
26657 "think they can do anything with the contents, and they certainly don't "
26662 #: ../libguestfs-1.11.19/resize/virt-resize.pod:537
26663 #: ../resize/virt-resize.pod:537
26665 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
26666 "but at a much lower level. You will probably end up hand-calculating sector "
26667 "offsets, which is something that virt-resize was designed to avoid. If you "
26668 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
26673 #: ../libguestfs-1.11.19/resize/virt-resize.pod:552
26674 #: ../resize/virt-resize.pod:552
26676 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
26677 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
26678 "L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, "
26679 "L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, L<http://libguestfs.org/>."
26683 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:5
26684 #: ../ruby/examples/guestfs-ruby.pod:5
26685 msgid "guestfs-ruby - How to use libguestfs from Ruby"
26689 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:9
26690 #: ../ruby/examples/guestfs-ruby.pod:9
26693 " require 'guestfs'\n"
26694 " g = Guestfs::Guestfs.new()\n"
26695 " g.add_drive_opts(\"disk.img\",\n"
26696 " :readonly => 1, :format => \"raw\")\n"
26702 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:17
26703 #: ../ruby/examples/guestfs-ruby.pod:17
26705 "This manual page documents how to call libguestfs from the Ruby programming "
26706 "language. This page just documents the differences from the C API and gives "
26707 "some examples. If you are not familiar with using libguestfs, you also need "
26708 "to read L<guestfs(3)>."
26712 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:24
26713 #: ../ruby/examples/guestfs-ruby.pod:24
26715 "Errors from libguestfs functions are mapped into the C<Error> exception. "
26716 "This has a single parameter which is the error message (a string)."
26720 #: ../libguestfs-1.11.19/ruby/examples/guestfs-ruby.pod:38
26721 #: ../ruby/examples/guestfs-ruby.pod:38
26723 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)"
26724 ">, L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<http://libguestfs.org/>."
26728 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1
26729 #: ../src/guestfs-actions.pod:1
26730 msgid "guestfs_add_cdrom"
26734 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3
26735 #: ../src/guestfs-actions.pod:3
26739 " guestfs_add_cdrom (guestfs_h *g,\n"
26740 " const char *filename);\n"
26745 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:17
26746 #: ../src/guestfs-actions.pod:17
26748 "This call checks for the existence of C<filename>. This stops you from "
26749 "specifying other types of drive which are supported by qemu such as C<nbd:> "
26750 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
26755 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:24
26756 #: ../src/guestfs-actions.pod:24
26758 "If you just want to add an ISO file (often you use this as an efficient way "
26759 "to transfer large files into the guest), then you should probably use "
26760 "C<guestfs_add_drive_ro> instead."
26764 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:30
26765 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:140
26766 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:201
26767 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:238
26768 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:252
26769 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:273
26770 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:293
26771 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:307
26772 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:422
26773 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:442
26774 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:456
26775 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:501
26776 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:529
26777 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:547
26778 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:614
26779 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:647
26780 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:661
26781 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:676
26782 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:775
26783 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:793
26784 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:807
26785 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:821
26786 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:858
26787 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1041
26788 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1061
26789 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1079
26790 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1163
26791 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1181
26792 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1200
26793 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1214
26794 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1234
26795 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1304
26796 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1335
26797 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1360
26798 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1402
26799 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1508
26800 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1542
26801 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1757
26802 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1779
26803 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1866
26804 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2341
26805 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2485
26806 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2546
26807 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2581
26808 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3621
26809 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3636
26810 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3661
26811 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3850
26812 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3864
26813 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3877
26814 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3891
26815 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3906
26816 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3942
26817 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4014
26818 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4034
26819 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4051
26820 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4074
26821 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4097
26822 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4132
26823 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4151
26824 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4170
26825 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4205
26826 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4217
26827 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4253
26828 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4269
26829 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4282
26830 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4297
26831 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4314
26832 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4407
26833 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4427
26834 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4440
26835 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4491
26836 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4509
26837 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4527
26838 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4543
26839 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4557
26840 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4571
26841 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4588
26842 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4603
26843 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4623
26844 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4693
26845 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4766
26846 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4797
26847 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4816
26848 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4835
26849 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4847
26850 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4864
26851 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4877
26852 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4892
26853 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4907
26854 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4942
26855 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4975
26856 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5014
26857 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5034
26858 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5048
26859 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5065
26860 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5114
26861 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5160
26862 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5214
26863 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5250
26864 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5285
26865 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5302
26866 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5320
26867 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5460
26868 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5517
26869 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5539
26870 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5557
26871 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5589
26872 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5655
26873 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5672
26874 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5685
26875 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5699
26876 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5988
26877 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6007
26878 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6026
26879 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6040
26880 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6052
26881 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6066
26882 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6078
26883 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6092
26884 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6108
26885 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6129
26886 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6148
26887 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6167
26888 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6197
26889 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6215
26890 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6238
26891 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6256
26892 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6275
26893 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6296
26894 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6315
26895 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6332
26896 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6351
26897 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6379
26898 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6403
26899 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6422
26900 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6446
26901 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6465
26902 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6480
26903 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6499
26904 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6536
26905 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6566
26906 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6599
26907 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6721
26908 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6842
26909 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6854
26910 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6867
26911 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6880
26912 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6902
26913 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6915
26914 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6928
26915 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6941
26916 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6956
26917 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7015
26918 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7032
26919 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7048
26920 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7064
26921 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7081
26922 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7094
26923 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7114
26924 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7150
26925 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7164
26926 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7205
26927 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7218
26928 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7236
26929 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7270
26930 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7306
26931 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7422
26932 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7437
26933 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7451
26934 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7506
26935 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7519
26936 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7564
26937 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7597
26938 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7660
26939 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7680
26940 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7706
26941 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7773
26942 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7792
26943 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7821
26944 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140
26945 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
26946 #: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
26947 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
26948 #: ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442
26949 #: ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501
26950 #: ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547
26951 #: ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647
26952 #: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676
26953 #: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793
26954 #: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821
26955 #: ../src/guestfs-actions.pod:858 ../src/guestfs-actions.pod:1041
26956 #: ../src/guestfs-actions.pod:1061 ../src/guestfs-actions.pod:1079
26957 #: ../src/guestfs-actions.pod:1163 ../src/guestfs-actions.pod:1181
26958 #: ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1214
26959 #: ../src/guestfs-actions.pod:1234 ../src/guestfs-actions.pod:1304
26960 #: ../src/guestfs-actions.pod:1335 ../src/guestfs-actions.pod:1360
26961 #: ../src/guestfs-actions.pod:1402 ../src/guestfs-actions.pod:1508
26962 #: ../src/guestfs-actions.pod:1542 ../src/guestfs-actions.pod:1757
26963 #: ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1866
26964 #: ../src/guestfs-actions.pod:2341 ../src/guestfs-actions.pod:2485
26965 #: ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2581
26966 #: ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:3636
26967 #: ../src/guestfs-actions.pod:3661 ../src/guestfs-actions.pod:3850
26968 #: ../src/guestfs-actions.pod:3864 ../src/guestfs-actions.pod:3877
26969 #: ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:3906
26970 #: ../src/guestfs-actions.pod:3942 ../src/guestfs-actions.pod:4014
26971 #: ../src/guestfs-actions.pod:4034 ../src/guestfs-actions.pod:4051
26972 #: ../src/guestfs-actions.pod:4074 ../src/guestfs-actions.pod:4097
26973 #: ../src/guestfs-actions.pod:4132 ../src/guestfs-actions.pod:4151
26974 #: ../src/guestfs-actions.pod:4170 ../src/guestfs-actions.pod:4205
26975 #: ../src/guestfs-actions.pod:4217 ../src/guestfs-actions.pod:4253
26976 #: ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:4282
26977 #: ../src/guestfs-actions.pod:4297 ../src/guestfs-actions.pod:4314
26978 #: ../src/guestfs-actions.pod:4407 ../src/guestfs-actions.pod:4427
26979 #: ../src/guestfs-actions.pod:4440 ../src/guestfs-actions.pod:4491
26980 #: ../src/guestfs-actions.pod:4509 ../src/guestfs-actions.pod:4527
26981 #: ../src/guestfs-actions.pod:4543 ../src/guestfs-actions.pod:4557
26982 #: ../src/guestfs-actions.pod:4571 ../src/guestfs-actions.pod:4588
26983 #: ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:4623
26984 #: ../src/guestfs-actions.pod:4693 ../src/guestfs-actions.pod:4766
26985 #: ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4816
26986 #: ../src/guestfs-actions.pod:4835 ../src/guestfs-actions.pod:4847
26987 #: ../src/guestfs-actions.pod:4864 ../src/guestfs-actions.pod:4877
26988 #: ../src/guestfs-actions.pod:4892 ../src/guestfs-actions.pod:4907
26989 #: ../src/guestfs-actions.pod:4942 ../src/guestfs-actions.pod:4975
26990 #: ../src/guestfs-actions.pod:5014 ../src/guestfs-actions.pod:5034
26991 #: ../src/guestfs-actions.pod:5048 ../src/guestfs-actions.pod:5065
26992 #: ../src/guestfs-actions.pod:5114 ../src/guestfs-actions.pod:5160
26993 #: ../src/guestfs-actions.pod:5214 ../src/guestfs-actions.pod:5250
26994 #: ../src/guestfs-actions.pod:5285 ../src/guestfs-actions.pod:5302
26995 #: ../src/guestfs-actions.pod:5320 ../src/guestfs-actions.pod:5460
26996 #: ../src/guestfs-actions.pod:5517 ../src/guestfs-actions.pod:5539
26997 #: ../src/guestfs-actions.pod:5557 ../src/guestfs-actions.pod:5589
26998 #: ../src/guestfs-actions.pod:5655 ../src/guestfs-actions.pod:5672
26999 #: ../src/guestfs-actions.pod:5685 ../src/guestfs-actions.pod:5699
27000 #: ../src/guestfs-actions.pod:5988 ../src/guestfs-actions.pod:6007
27001 #: ../src/guestfs-actions.pod:6026 ../src/guestfs-actions.pod:6040
27002 #: ../src/guestfs-actions.pod:6052 ../src/guestfs-actions.pod:6066
27003 #: ../src/guestfs-actions.pod:6078 ../src/guestfs-actions.pod:6092
27004 #: ../src/guestfs-actions.pod:6108 ../src/guestfs-actions.pod:6129
27005 #: ../src/guestfs-actions.pod:6148 ../src/guestfs-actions.pod:6167
27006 #: ../src/guestfs-actions.pod:6197 ../src/guestfs-actions.pod:6215
27007 #: ../src/guestfs-actions.pod:6238 ../src/guestfs-actions.pod:6256
27008 #: ../src/guestfs-actions.pod:6275 ../src/guestfs-actions.pod:6296
27009 #: ../src/guestfs-actions.pod:6315 ../src/guestfs-actions.pod:6332
27010 #: ../src/guestfs-actions.pod:6351 ../src/guestfs-actions.pod:6379
27011 #: ../src/guestfs-actions.pod:6403 ../src/guestfs-actions.pod:6422
27012 #: ../src/guestfs-actions.pod:6446 ../src/guestfs-actions.pod:6465
27013 #: ../src/guestfs-actions.pod:6480 ../src/guestfs-actions.pod:6499
27014 #: ../src/guestfs-actions.pod:6536 ../src/guestfs-actions.pod:6566
27015 #: ../src/guestfs-actions.pod:6599 ../src/guestfs-actions.pod:6721
27016 #: ../src/guestfs-actions.pod:6842 ../src/guestfs-actions.pod:6854
27017 #: ../src/guestfs-actions.pod:6867 ../src/guestfs-actions.pod:6880
27018 #: ../src/guestfs-actions.pod:6902 ../src/guestfs-actions.pod:6915
27019 #: ../src/guestfs-actions.pod:6928 ../src/guestfs-actions.pod:6941
27020 #: ../src/guestfs-actions.pod:6956 ../src/guestfs-actions.pod:7015
27021 #: ../src/guestfs-actions.pod:7032 ../src/guestfs-actions.pod:7048
27022 #: ../src/guestfs-actions.pod:7064 ../src/guestfs-actions.pod:7081
27023 #: ../src/guestfs-actions.pod:7094 ../src/guestfs-actions.pod:7114
27024 #: ../src/guestfs-actions.pod:7150 ../src/guestfs-actions.pod:7164
27025 #: ../src/guestfs-actions.pod:7205 ../src/guestfs-actions.pod:7218
27026 #: ../src/guestfs-actions.pod:7236 ../src/guestfs-actions.pod:7270
27027 #: ../src/guestfs-actions.pod:7306 ../src/guestfs-actions.pod:7422
27028 #: ../src/guestfs-actions.pod:7437 ../src/guestfs-actions.pod:7451
27029 #: ../src/guestfs-actions.pod:7506 ../src/guestfs-actions.pod:7519
27030 #: ../src/guestfs-actions.pod:7564 ../src/guestfs-actions.pod:7597
27031 #: ../src/guestfs-actions.pod:7660 ../src/guestfs-actions.pod:7680
27032 #: ../src/guestfs-actions.pod:7706 ../src/guestfs-actions.pod:7773
27033 #: ../src/guestfs-actions.pod:7792 ../src/guestfs-actions.pod:7821
27034 msgid "This function returns 0 on success or -1 on error."
27038 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:39
27039 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:142
27040 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1165
27041 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1980
27042 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2078
27043 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2192
27044 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3623
27045 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3643
27046 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4951
27047 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6217
27048 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6334
27049 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6467
27050 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6958
27051 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7083
27052 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7606
27053 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
27054 #: ../src/guestfs-actions.pod:1165 ../src/guestfs-actions.pod:1980
27055 #: ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2192
27056 #: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3643
27057 #: ../src/guestfs-actions.pod:4951 ../src/guestfs-actions.pod:6217
27058 #: ../src/guestfs-actions.pod:6334 ../src/guestfs-actions.pod:6467
27059 #: ../src/guestfs-actions.pod:6958 ../src/guestfs-actions.pod:7083
27060 #: ../src/guestfs-actions.pod:7606
27061 msgid "(Added in 0.3)"
27065 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:41
27066 #: ../src/guestfs-actions.pod:41
27067 msgid "guestfs_add_domain"
27071 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:43
27072 #: ../src/guestfs-actions.pod:43
27076 " guestfs_add_domain (guestfs_h *g,\n"
27077 " const char *dom,\n"
27083 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:48
27084 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:151
27085 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:832
27086 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2826
27087 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4642
27088 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4961
27089 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5178
27090 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
27091 #: ../src/guestfs-actions.pod:832 ../src/guestfs-actions.pod:2826
27092 #: ../src/guestfs-actions.pod:4642 ../src/guestfs-actions.pod:4961
27093 #: ../src/guestfs-actions.pod:5178
27095 "You may supply a list of optional arguments to this call. Use zero or more "
27096 "of the following pairs of parameters, and terminate the list with C<-1> on "
27097 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
27101 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:53
27102 #: ../src/guestfs-actions.pod:53
27105 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
27106 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
27107 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
27108 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
27109 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
27114 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:59
27115 #: ../src/guestfs-actions.pod:59
27117 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
27118 "It works by connecting to libvirt, requesting the domain and domain XML from "
27119 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
27124 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:94
27125 #: ../src/guestfs-actions.pod:94
27127 "The other optional parameters are passed directly through to "
27128 "C<guestfs_add_drive_opts>."
27132 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:97
27133 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:350
27134 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:515
27135 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:693
27136 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:724
27137 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:742
27138 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:761
27139 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1380
27140 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1736
27141 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1939
27142 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2050
27143 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2101
27144 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2156
27145 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2179
27146 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2472
27147 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2944
27148 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2962
27149 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5137
27150 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5357
27151 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5769
27152 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5795
27153 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7191
27154 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7617
27155 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7630
27156 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7643
27157 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
27158 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
27159 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
27160 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1380
27161 #: ../src/guestfs-actions.pod:1736 ../src/guestfs-actions.pod:1939
27162 #: ../src/guestfs-actions.pod:2050 ../src/guestfs-actions.pod:2101
27163 #: ../src/guestfs-actions.pod:2156 ../src/guestfs-actions.pod:2179
27164 #: ../src/guestfs-actions.pod:2472 ../src/guestfs-actions.pod:2944
27165 #: ../src/guestfs-actions.pod:2962 ../src/guestfs-actions.pod:5137
27166 #: ../src/guestfs-actions.pod:5357 ../src/guestfs-actions.pod:5769
27167 #: ../src/guestfs-actions.pod:5795 ../src/guestfs-actions.pod:7191
27168 #: ../src/guestfs-actions.pod:7617 ../src/guestfs-actions.pod:7630
27169 #: ../src/guestfs-actions.pod:7643
27170 msgid "On error this function returns -1."
27174 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:99
27175 #: ../src/guestfs-actions.pod:99
27176 msgid "(Added in 1.7.4)"
27180 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:101
27181 #: ../src/guestfs-actions.pod:101
27182 msgid "guestfs_add_domain_va"
27186 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:103
27187 #: ../src/guestfs-actions.pod:103
27191 " guestfs_add_domain_va (guestfs_h *g,\n"
27192 " const char *dom,\n"
27193 " va_list args);\n"
27198 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:108
27199 #: ../src/guestfs-actions.pod:108
27200 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
27204 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:110
27205 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:121
27206 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:214
27207 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:225
27208 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:871
27209 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:882
27210 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2910
27211 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2922
27212 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4707
27213 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4719
27214 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4989
27215 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5001
27216 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5227
27217 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5238
27218 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
27219 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
27220 #: ../src/guestfs-actions.pod:871 ../src/guestfs-actions.pod:882
27221 #: ../src/guestfs-actions.pod:2910 ../src/guestfs-actions.pod:2922
27222 #: ../src/guestfs-actions.pod:4707 ../src/guestfs-actions.pod:4719
27223 #: ../src/guestfs-actions.pod:4989 ../src/guestfs-actions.pod:5001
27224 #: ../src/guestfs-actions.pod:5227 ../src/guestfs-actions.pod:5238
27225 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
27229 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:112
27230 #: ../src/guestfs-actions.pod:112
27231 msgid "guestfs_add_domain_argv"
27235 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:114
27236 #: ../src/guestfs-actions.pod:114
27240 " guestfs_add_domain_argv (guestfs_h *g,\n"
27241 " const char *dom,\n"
27242 " const struct guestfs_add_domain_argv *optargs);\n"
27247 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:119
27248 #: ../src/guestfs-actions.pod:119
27249 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
27253 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:123
27254 #: ../src/guestfs-actions.pod:123
27255 msgid "guestfs_add_drive"
27259 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:125
27260 #: ../src/guestfs-actions.pod:125
27264 " guestfs_add_drive (guestfs_h *g,\n"
27265 " const char *filename);\n"
27270 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:129
27271 #: ../src/guestfs-actions.pod:129
27273 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
27274 "optional parameters, so the disk is added writable, with the format being "
27275 "detected automatically."
27279 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:133
27280 #: ../src/guestfs-actions.pod:133
27282 "Automatic detection of the format opens you up to a potential security hole "
27283 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
27284 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
27285 "you should think about replacing calls to this function with calls to "
27286 "C<guestfs_add_drive_opts>, and specifying the format."
27290 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:144
27291 #: ../src/guestfs-actions.pod:144
27292 msgid "guestfs_add_drive_opts"
27296 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:146
27297 #: ../src/guestfs-actions.pod:146
27301 " guestfs_add_drive_opts (guestfs_h *g,\n"
27302 " const char *filename,\n"
27308 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:156
27309 #: ../src/guestfs-actions.pod:156
27312 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
27313 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
27314 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
27319 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:185
27320 #: ../src/guestfs-actions.pod:185
27322 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
27323 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
27324 "Possible formats include C<raw> and C<qcow2>."
27328 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:196
27329 #: ../src/guestfs-actions.pod:196
27331 "This rarely-used option lets you emulate the behaviour of the deprecated "
27332 "C<guestfs_add_drive_with_if> call (q.v.)"
27336 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:203
27337 #: ../src/guestfs-actions.pod:203
27338 msgid "(Added in 1.5.23)"
27342 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:205
27343 #: ../src/guestfs-actions.pod:205
27344 msgid "guestfs_add_drive_opts_va"
27348 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:207
27349 #: ../src/guestfs-actions.pod:207
27353 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
27354 " const char *filename,\n"
27355 " va_list args);\n"
27360 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:212
27361 #: ../src/guestfs-actions.pod:212
27362 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
27366 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:216
27367 #: ../src/guestfs-actions.pod:216
27368 msgid "guestfs_add_drive_opts_argv"
27372 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:218
27373 #: ../src/guestfs-actions.pod:218
27377 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
27378 " const char *filename,\n"
27379 " const struct guestfs_add_drive_opts_argv *optargs);\n"
27384 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:223
27385 #: ../src/guestfs-actions.pod:223
27386 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
27390 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:227
27391 #: ../src/guestfs-actions.pod:227
27392 msgid "guestfs_add_drive_ro"
27396 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:229
27397 #: ../src/guestfs-actions.pod:229
27401 " guestfs_add_drive_ro (guestfs_h *g,\n"
27402 " const char *filename);\n"
27407 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:233
27408 #: ../src/guestfs-actions.pod:233
27410 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
27411 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
27412 "disk is added read-only, with the format being detected automatically."
27416 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:240
27417 #: ../src/guestfs-actions.pod:240
27418 msgid "(Added in 1.0.38)"
27422 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:242
27423 #: ../src/guestfs-actions.pod:242
27424 msgid "guestfs_add_drive_ro_with_if"
27428 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:244
27429 #: ../src/guestfs-actions.pod:244
27433 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
27434 " const char *filename,\n"
27435 " const char *iface);\n"
27440 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:249
27441 #: ../src/guestfs-actions.pod:249
27443 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
27444 "QEMU interface emulation to use at run time."
27448 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:261
27449 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:282
27450 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2431
27451 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
27452 #: ../src/guestfs-actions.pod:2431
27453 msgid "(Added in 1.0.84)"
27457 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:263
27458 #: ../src/guestfs-actions.pod:263
27459 msgid "guestfs_add_drive_with_if"
27463 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:265
27464 #: ../src/guestfs-actions.pod:265
27468 " guestfs_add_drive_with_if (guestfs_h *g,\n"
27469 " const char *filename,\n"
27470 " const char *iface);\n"
27475 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:270
27476 #: ../src/guestfs-actions.pod:270
27478 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
27479 "QEMU interface emulation to use at run time."
27483 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:284
27484 #: ../src/guestfs-actions.pod:284
27485 msgid "guestfs_aug_clear"
27489 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:286
27490 #: ../src/guestfs-actions.pod:286
27494 " guestfs_aug_clear (guestfs_h *g,\n"
27495 " const char *augpath);\n"
27500 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:295
27501 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2181
27502 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2181
27503 msgid "(Added in 1.3.4)"
27507 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:297
27508 #: ../src/guestfs-actions.pod:297
27509 msgid "guestfs_aug_close"
27513 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:299
27514 #: ../src/guestfs-actions.pod:299
27518 " guestfs_aug_close (guestfs_h *g);\n"
27523 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:302
27524 #: ../src/guestfs-actions.pod:302
27526 "Close the current Augeas handle and free up any resources used by it. After "
27527 "calling this, you have to call C<guestfs_aug_init> again before you can use "
27528 "any other Augeas functions."
27532 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:309
27533 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:334
27534 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:352
27535 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:366
27536 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:424
27537 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:444
27538 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:458
27539 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:489
27540 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:503
27541 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:517
27542 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:531
27543 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:549
27544 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5846
27545 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
27546 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
27547 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
27548 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
27549 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
27550 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
27551 #: ../src/guestfs-actions.pod:5846
27552 msgid "(Added in 0.7)"
27556 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:311
27557 #: ../src/guestfs-actions.pod:311
27558 msgid "guestfs_aug_defnode"
27562 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:313
27563 #: ../src/guestfs-actions.pod:313
27566 " struct guestfs_int_bool *\n"
27567 " guestfs_aug_defnode (guestfs_h *g,\n"
27568 " const char *name,\n"
27569 " const char *expr,\n"
27570 " const char *val);\n"
27575 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:322
27576 #: ../src/guestfs-actions.pod:322
27578 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
27579 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
27580 "containing that single node."
27584 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:330
27585 #: ../src/guestfs-actions.pod:330
27587 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
27588 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
27592 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:336
27593 #: ../src/guestfs-actions.pod:336
27594 msgid "guestfs_aug_defvar"
27598 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:338
27599 #: ../src/guestfs-actions.pod:338
27603 " guestfs_aug_defvar (guestfs_h *g,\n"
27604 " const char *name,\n"
27605 " const char *expr);\n"
27610 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:354
27611 #: ../src/guestfs-actions.pod:354
27612 msgid "guestfs_aug_get"
27616 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:356
27617 #: ../src/guestfs-actions.pod:356
27621 " guestfs_aug_get (guestfs_h *g,\n"
27622 " const char *augpath);\n"
27627 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:363
27628 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:922
27629 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:940
27630 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1000
27631 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1016
27632 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1119
27633 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1249
27634 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1266
27635 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1285
27636 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1419
27637 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1607
27638 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1719
27639 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1882
27640 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1899
27641 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1966
27642 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2002
27643 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2023
27644 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2204
27645 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2396
27646 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2600
27647 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2690
27648 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2794
27649 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2813
27650 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3027
27651 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3055
27652 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3076
27653 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3110
27654 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3169
27655 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3189
27656 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3209
27657 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3836
27658 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4189
27659 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4359
27660 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4469
27661 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5375
27662 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5574
27663 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5744
27664 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5922
27665 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5971
27666 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6627
27667 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6643
27668 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6660
27669 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6691
27670 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7365
27671 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7384
27672 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7402
27673 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7576
27674 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7878
27675 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:922
27676 #: ../src/guestfs-actions.pod:940 ../src/guestfs-actions.pod:1000
27677 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1119
27678 #: ../src/guestfs-actions.pod:1249 ../src/guestfs-actions.pod:1266
27679 #: ../src/guestfs-actions.pod:1285 ../src/guestfs-actions.pod:1419
27680 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1719
27681 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:1899
27682 #: ../src/guestfs-actions.pod:1966 ../src/guestfs-actions.pod:2002
27683 #: ../src/guestfs-actions.pod:2023 ../src/guestfs-actions.pod:2204
27684 #: ../src/guestfs-actions.pod:2396 ../src/guestfs-actions.pod:2600
27685 #: ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2794
27686 #: ../src/guestfs-actions.pod:2813 ../src/guestfs-actions.pod:3027
27687 #: ../src/guestfs-actions.pod:3055 ../src/guestfs-actions.pod:3076
27688 #: ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3169
27689 #: ../src/guestfs-actions.pod:3189 ../src/guestfs-actions.pod:3209
27690 #: ../src/guestfs-actions.pod:3836 ../src/guestfs-actions.pod:4189
27691 #: ../src/guestfs-actions.pod:4359 ../src/guestfs-actions.pod:4469
27692 #: ../src/guestfs-actions.pod:5375 ../src/guestfs-actions.pod:5574
27693 #: ../src/guestfs-actions.pod:5744 ../src/guestfs-actions.pod:5922
27694 #: ../src/guestfs-actions.pod:5971 ../src/guestfs-actions.pod:6627
27695 #: ../src/guestfs-actions.pod:6643 ../src/guestfs-actions.pod:6660
27696 #: ../src/guestfs-actions.pod:6691 ../src/guestfs-actions.pod:7365
27697 #: ../src/guestfs-actions.pod:7384 ../src/guestfs-actions.pod:7402
27698 #: ../src/guestfs-actions.pod:7576 ../src/guestfs-actions.pod:7878
27700 "This function returns a string, or NULL on error. I<The caller must free "
27701 "the returned string after use>."
27705 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:368
27706 #: ../src/guestfs-actions.pod:368
27707 msgid "guestfs_aug_init"
27711 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:370
27712 #: ../src/guestfs-actions.pod:370
27716 " guestfs_aug_init (guestfs_h *g,\n"
27717 " const char *root,\n"
27723 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:379
27724 #: ../src/guestfs-actions.pod:379
27725 msgid "You must call this before using any other C<guestfs_aug_*> commands."
27729 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:414
27730 #: ../src/guestfs-actions.pod:414
27731 msgid "Do not load the tree in C<guestfs_aug_init>."
27735 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:418
27736 #: ../src/guestfs-actions.pod:418
27737 msgid "To close the handle, you can call C<guestfs_aug_close>."
27741 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:426
27742 #: ../src/guestfs-actions.pod:426
27743 msgid "guestfs_aug_insert"
27747 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:428
27748 #: ../src/guestfs-actions.pod:428
27752 " guestfs_aug_insert (guestfs_h *g,\n"
27753 " const char *augpath,\n"
27754 " const char *label,\n"
27760 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:446
27761 #: ../src/guestfs-actions.pod:446
27762 msgid "guestfs_aug_load"
27766 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:448
27767 #: ../src/guestfs-actions.pod:448
27771 " guestfs_aug_load (guestfs_h *g);\n"
27776 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:460
27777 #: ../src/guestfs-actions.pod:460
27778 msgid "guestfs_aug_ls"
27782 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:462
27783 #: ../src/guestfs-actions.pod:462
27787 " guestfs_aug_ls (guestfs_h *g,\n"
27788 " const char *augpath);\n"
27793 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:466
27794 #: ../src/guestfs-actions.pod:466
27796 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
27797 "sorting the resulting nodes into alphabetical order."
27801 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:469
27802 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:485
27803 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:631
27804 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1138
27805 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1434
27806 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1453
27807 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1556
27808 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1575
27809 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1821
27810 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2276
27811 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2292
27812 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2311
27813 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2354
27814 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2378
27815 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2449
27816 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2498
27817 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2755
27818 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3129
27819 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3405
27820 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3719
27821 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3736
27822 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3756
27823 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3818
27824 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3923
27825 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4331
27826 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5098
27827 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5716
27828 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5842
27829 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5956
27830 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6707
27831 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6768
27832 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6823
27833 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6969
27834 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6993
27835 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7469
27836 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7489
27837 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7536
27838 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7730
27839 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7749
27840 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7835
27841 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7854
27842 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7900
27843 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7919
27844 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
27845 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1138
27846 #: ../src/guestfs-actions.pod:1434 ../src/guestfs-actions.pod:1453
27847 #: ../src/guestfs-actions.pod:1556 ../src/guestfs-actions.pod:1575
27848 #: ../src/guestfs-actions.pod:1821 ../src/guestfs-actions.pod:2276
27849 #: ../src/guestfs-actions.pod:2292 ../src/guestfs-actions.pod:2311
27850 #: ../src/guestfs-actions.pod:2354 ../src/guestfs-actions.pod:2378
27851 #: ../src/guestfs-actions.pod:2449 ../src/guestfs-actions.pod:2498
27852 #: ../src/guestfs-actions.pod:2755 ../src/guestfs-actions.pod:3129
27853 #: ../src/guestfs-actions.pod:3405 ../src/guestfs-actions.pod:3719
27854 #: ../src/guestfs-actions.pod:3736 ../src/guestfs-actions.pod:3756
27855 #: ../src/guestfs-actions.pod:3818 ../src/guestfs-actions.pod:3923
27856 #: ../src/guestfs-actions.pod:4331 ../src/guestfs-actions.pod:5098
27857 #: ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5842
27858 #: ../src/guestfs-actions.pod:5956 ../src/guestfs-actions.pod:6707
27859 #: ../src/guestfs-actions.pod:6768 ../src/guestfs-actions.pod:6823
27860 #: ../src/guestfs-actions.pod:6969 ../src/guestfs-actions.pod:6993
27861 #: ../src/guestfs-actions.pod:7469 ../src/guestfs-actions.pod:7489
27862 #: ../src/guestfs-actions.pod:7536 ../src/guestfs-actions.pod:7730
27863 #: ../src/guestfs-actions.pod:7749 ../src/guestfs-actions.pod:7835
27864 #: ../src/guestfs-actions.pod:7854 ../src/guestfs-actions.pod:7900
27865 #: ../src/guestfs-actions.pod:7919
27867 "This function returns a NULL-terminated array of strings (like L<environ(3)"
27868 ">), or NULL if there was an error. I<The caller must free the strings and "
27869 "the array after use>."
27873 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:473
27874 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1063
27875 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1081
27876 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1491
27877 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3483
27878 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3514
27879 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4172
27880 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4222
27881 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4409
27882 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4442
27883 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4605
27884 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5102
27885 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5657
27886 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6054
27887 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6068
27888 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6080
27889 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6548
27890 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7207
27891 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7220
27892 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7453
27893 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7718
27894 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1063
27895 #: ../src/guestfs-actions.pod:1081 ../src/guestfs-actions.pod:1491
27896 #: ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:3514
27897 #: ../src/guestfs-actions.pod:4172 ../src/guestfs-actions.pod:4222
27898 #: ../src/guestfs-actions.pod:4409 ../src/guestfs-actions.pod:4442
27899 #: ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:5102
27900 #: ../src/guestfs-actions.pod:5657 ../src/guestfs-actions.pod:6054
27901 #: ../src/guestfs-actions.pod:6068 ../src/guestfs-actions.pod:6080
27902 #: ../src/guestfs-actions.pod:6548 ../src/guestfs-actions.pod:7207
27903 #: ../src/guestfs-actions.pod:7220 ../src/guestfs-actions.pod:7453
27904 #: ../src/guestfs-actions.pod:7718
27905 msgid "(Added in 0.8)"
27909 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:475
27910 #: ../src/guestfs-actions.pod:475
27911 msgid "guestfs_aug_match"
27915 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:477
27916 #: ../src/guestfs-actions.pod:477
27920 " guestfs_aug_match (guestfs_h *g,\n"
27921 " const char *augpath);\n"
27926 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:491
27927 #: ../src/guestfs-actions.pod:491
27928 msgid "guestfs_aug_mv"
27932 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:493
27933 #: ../src/guestfs-actions.pod:493
27937 " guestfs_aug_mv (guestfs_h *g,\n"
27938 " const char *src,\n"
27939 " const char *dest);\n"
27944 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:505
27945 #: ../src/guestfs-actions.pod:505
27946 msgid "guestfs_aug_rm"
27950 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:507
27951 #: ../src/guestfs-actions.pod:507
27955 " guestfs_aug_rm (guestfs_h *g,\n"
27956 " const char *augpath);\n"
27961 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:519
27962 #: ../src/guestfs-actions.pod:519
27963 msgid "guestfs_aug_save"
27967 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:521
27968 #: ../src/guestfs-actions.pod:521
27972 " guestfs_aug_save (guestfs_h *g);\n"
27977 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:526
27978 #: ../src/guestfs-actions.pod:526
27980 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
27985 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:533
27986 #: ../src/guestfs-actions.pod:533
27987 msgid "guestfs_aug_set"
27991 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:535
27992 #: ../src/guestfs-actions.pod:535
27996 " guestfs_aug_set (guestfs_h *g,\n"
27997 " const char *augpath,\n"
27998 " const char *val);\n"
28003 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:542
28004 #: ../src/guestfs-actions.pod:542
28006 "In the Augeas API, it is possible to clear a node by setting the value to "
28007 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
28008 "this call. Instead you must use the C<guestfs_aug_clear> call."
28012 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:551
28013 #: ../src/guestfs-actions.pod:551
28014 msgid "guestfs_available"
28018 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:553
28019 #: ../src/guestfs-actions.pod:553
28023 " guestfs_available (guestfs_h *g,\n"
28024 " char *const *groups);\n"
28029 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:561
28030 #: ../src/guestfs-actions.pod:561
28032 "The libguestfs groups, and the functions that those groups correspond to, "
28033 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
28034 "runtime by calling C<guestfs_available_all_groups>."
28038 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:585
28039 #: ../src/guestfs-actions.pod:585
28040 msgid "You must call C<guestfs_launch> before calling this function."
28044 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:607
28045 #: ../src/guestfs-actions.pod:607
28047 "This call was added in version C<1.0.80>. In previous versions of "
28048 "libguestfs all you could do would be to speculatively execute a command to "
28049 "find out if the daemon implemented it. See also C<guestfs_version>."
28053 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:616
28054 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1236
28055 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1236
28056 msgid "(Added in 1.0.80)"
28060 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:618
28061 #: ../src/guestfs-actions.pod:618
28062 msgid "guestfs_available_all_groups"
28066 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:620
28067 #: ../src/guestfs-actions.pod:620
28071 " guestfs_available_all_groups (guestfs_h *g);\n"
28076 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:623
28077 #: ../src/guestfs-actions.pod:623
28079 "This command returns a list of all optional groups that this daemon knows "
28080 "about. Note this returns both supported and unsupported groups. To find "
28081 "out which ones the daemon can actually support you have to call "
28082 "C<guestfs_available> on each member of the returned list."
28086 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:629
28087 #: ../src/guestfs-actions.pod:629
28088 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
28092 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:635
28093 #: ../src/guestfs-actions.pod:635
28094 msgid "(Added in 1.3.15)"
28098 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:637
28099 #: ../src/guestfs-actions.pod:637
28100 msgid "guestfs_base64_in"
28104 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:639
28105 #: ../src/guestfs-actions.pod:639
28109 " guestfs_base64_in (guestfs_h *g,\n"
28110 " const char *base64file,\n"
28111 " const char *filename);\n"
28116 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:649
28117 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:663
28118 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
28119 msgid "(Added in 1.3.5)"
28123 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:651
28124 #: ../src/guestfs-actions.pod:651
28125 msgid "guestfs_base64_out"
28129 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:653
28130 #: ../src/guestfs-actions.pod:653
28134 " guestfs_base64_out (guestfs_h *g,\n"
28135 " const char *filename,\n"
28136 " const char *base64file);\n"
28141 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:665
28142 #: ../src/guestfs-actions.pod:665
28143 msgid "guestfs_blockdev_flushbufs"
28147 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:667
28148 #: ../src/guestfs-actions.pod:667
28152 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
28153 " const char *device);\n"
28158 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:678
28159 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:695
28160 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:710
28161 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:726
28162 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:744
28163 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:763
28164 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:777
28165 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:795
28166 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:809
28167 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:823
28168 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
28169 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
28170 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
28171 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
28172 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
28173 msgid "(Added in 0.9.3)"
28177 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:680
28178 #: ../src/guestfs-actions.pod:680
28179 msgid "guestfs_blockdev_getbsz"
28183 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:682
28184 #: ../src/guestfs-actions.pod:682
28188 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
28189 " const char *device);\n"
28194 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:697
28195 #: ../src/guestfs-actions.pod:697
28196 msgid "guestfs_blockdev_getro"
28200 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:699
28201 #: ../src/guestfs-actions.pod:699
28205 " guestfs_blockdev_getro (guestfs_h *g,\n"
28206 " const char *device);\n"
28211 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:708
28212 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1474
28213 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1489
28214 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1978
28215 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1989
28216 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2061
28217 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2087
28218 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2127
28219 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2142
28220 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2167
28221 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2190
28222 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3226
28223 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3242
28224 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3260
28225 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3422
28226 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3436
28227 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3451
28228 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3465
28229 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3481
28230 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3496
28231 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3512
28232 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3526
28233 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3539
28234 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3553
28235 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3568
28236 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3583
28237 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3596
28238 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3610
28239 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5339
28240 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1474
28241 #: ../src/guestfs-actions.pod:1489 ../src/guestfs-actions.pod:1978
28242 #: ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2061
28243 #: ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2127
28244 #: ../src/guestfs-actions.pod:2142 ../src/guestfs-actions.pod:2167
28245 #: ../src/guestfs-actions.pod:2190 ../src/guestfs-actions.pod:3226
28246 #: ../src/guestfs-actions.pod:3242 ../src/guestfs-actions.pod:3260
28247 #: ../src/guestfs-actions.pod:3422 ../src/guestfs-actions.pod:3436
28248 #: ../src/guestfs-actions.pod:3451 ../src/guestfs-actions.pod:3465
28249 #: ../src/guestfs-actions.pod:3481 ../src/guestfs-actions.pod:3496
28250 #: ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:3526
28251 #: ../src/guestfs-actions.pod:3539 ../src/guestfs-actions.pod:3553
28252 #: ../src/guestfs-actions.pod:3568 ../src/guestfs-actions.pod:3583
28253 #: ../src/guestfs-actions.pod:3596 ../src/guestfs-actions.pod:3610
28254 #: ../src/guestfs-actions.pod:5339
28255 msgid "This function returns a C truth value on success or -1 on error."
28259 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:712
28260 #: ../src/guestfs-actions.pod:712
28261 msgid "guestfs_blockdev_getsize64"
28265 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:714
28266 #: ../src/guestfs-actions.pod:714
28270 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
28271 " const char *device);\n"
28276 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:720
28277 #: ../src/guestfs-actions.pod:720
28278 msgid "See also C<guestfs_blockdev_getsz>."
28282 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:728
28283 #: ../src/guestfs-actions.pod:728
28284 msgid "guestfs_blockdev_getss"
28288 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:730
28289 #: ../src/guestfs-actions.pod:730
28293 " guestfs_blockdev_getss (guestfs_h *g,\n"
28294 " const char *device);\n"
28299 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:737
28300 #: ../src/guestfs-actions.pod:737
28302 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
28307 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:746
28308 #: ../src/guestfs-actions.pod:746
28309 msgid "guestfs_blockdev_getsz"
28313 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:748
28314 #: ../src/guestfs-actions.pod:748
28318 " guestfs_blockdev_getsz (guestfs_h *g,\n"
28319 " const char *device);\n"
28324 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:755
28325 #: ../src/guestfs-actions.pod:755
28327 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
28328 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
28332 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:765
28333 #: ../src/guestfs-actions.pod:765
28334 msgid "guestfs_blockdev_rereadpt"
28338 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:767
28339 #: ../src/guestfs-actions.pod:767
28343 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
28344 " const char *device);\n"
28349 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:779
28350 #: ../src/guestfs-actions.pod:779
28351 msgid "guestfs_blockdev_setbsz"
28355 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:781
28356 #: ../src/guestfs-actions.pod:781
28360 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
28361 " const char *device,\n"
28362 " int blocksize);\n"
28367 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:797
28368 #: ../src/guestfs-actions.pod:797
28369 msgid "guestfs_blockdev_setro"
28373 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:799
28374 #: ../src/guestfs-actions.pod:799
28378 " guestfs_blockdev_setro (guestfs_h *g,\n"
28379 " const char *device);\n"
28384 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:811
28385 #: ../src/guestfs-actions.pod:811
28386 msgid "guestfs_blockdev_setrw"
28390 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:813
28391 #: ../src/guestfs-actions.pod:813
28395 " guestfs_blockdev_setrw (guestfs_h *g,\n"
28396 " const char *device);\n"
28401 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:825
28402 #: ../src/guestfs-actions.pod:825
28403 msgid "guestfs_btrfs_filesystem_resize"
28407 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:827
28408 #: ../src/guestfs-actions.pod:827
28412 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
28413 " const char *mountpoint,\n"
28419 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:837
28420 #: ../src/guestfs-actions.pod:837
28423 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
28428 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:860
28429 #: ../src/guestfs-actions.pod:860
28430 msgid "(Added in 1.11.17)"
28434 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:862
28435 #: ../src/guestfs-actions.pod:862
28436 msgid "guestfs_btrfs_filesystem_resize_va"
28440 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:864
28441 #: ../src/guestfs-actions.pod:864
28445 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
28446 " const char *mountpoint,\n"
28447 " va_list args);\n"
28452 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:869
28453 #: ../src/guestfs-actions.pod:869
28454 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
28458 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:873
28459 #: ../src/guestfs-actions.pod:873
28460 msgid "guestfs_btrfs_filesystem_resize_argv"
28464 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:875
28465 #: ../src/guestfs-actions.pod:875
28469 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
28470 " const char *mountpoint,\n"
28471 " const struct guestfs_btrfs_filesystem_resize_argv *optargs);\n"
28476 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:880
28477 #: ../src/guestfs-actions.pod:880
28478 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
28482 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:884
28483 #: ../src/guestfs-actions.pod:884
28484 msgid "guestfs_case_sensitive_path"
28488 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:886
28489 #: ../src/guestfs-actions.pod:886
28493 " guestfs_case_sensitive_path (guestfs_h *g,\n"
28494 " const char *path);\n"
28499 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:912
28500 #: ../src/guestfs-actions.pod:912
28502 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
28503 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
28504 "how the directories were originally created under Windows)."
28508 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:920
28509 #: ../src/guestfs-actions.pod:920
28510 msgid "See also C<guestfs_realpath>."
28514 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:925
28515 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7387
28516 #: ../src/guestfs-actions.pod:925 ../src/guestfs-actions.pod:7387
28517 msgid "(Added in 1.0.75)"
28521 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:927
28522 #: ../src/guestfs-actions.pod:927
28523 msgid "guestfs_cat"
28527 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:929
28528 #: ../src/guestfs-actions.pod:929
28532 " guestfs_cat (guestfs_h *g,\n"
28533 " const char *path);\n"
28538 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:935
28539 #: ../src/guestfs-actions.pod:935
28541 "Note that this function cannot correctly handle binary files (specifically, "
28542 "files containing C<\\0> character which is treated as end of string). For "
28543 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
28544 "functions which have a more complex interface."
28548 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:946
28549 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3740
28550 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3822
28551 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3839
28552 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3927
28553 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4335
28554 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4349
28555 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5720
28556 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5734
28557 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7540
28558 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7554
28559 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:3740
28560 #: ../src/guestfs-actions.pod:3822 ../src/guestfs-actions.pod:3839
28561 #: ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:4335
28562 #: ../src/guestfs-actions.pod:4349 ../src/guestfs-actions.pod:5720
28563 #: ../src/guestfs-actions.pod:5734 ../src/guestfs-actions.pod:7540
28564 #: ../src/guestfs-actions.pod:7554
28565 msgid "(Added in 0.4)"
28569 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:948
28570 #: ../src/guestfs-actions.pod:948
28571 msgid "guestfs_checksum"
28575 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:950
28576 #: ../src/guestfs-actions.pod:950
28580 " guestfs_checksum (guestfs_h *g,\n"
28581 " const char *csumtype,\n"
28582 " const char *path);\n"
28587 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:996
28588 #: ../src/guestfs-actions.pod:996
28589 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
28593 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:998
28594 #: ../src/guestfs-actions.pod:998
28595 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
28599 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1003
28600 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1311
28601 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2158
28602 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3438
28603 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3467
28604 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3528
28605 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3555
28606 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7243
28607 #: ../src/guestfs-actions.pod:1003 ../src/guestfs-actions.pod:1311
28608 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:3438
28609 #: ../src/guestfs-actions.pod:3467 ../src/guestfs-actions.pod:3528
28610 #: ../src/guestfs-actions.pod:3555 ../src/guestfs-actions.pod:7243
28611 msgid "(Added in 1.0.2)"
28615 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1005
28616 #: ../src/guestfs-actions.pod:1005
28617 msgid "guestfs_checksum_device"
28621 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1007
28622 #: ../src/guestfs-actions.pod:1007
28626 " guestfs_checksum_device (guestfs_h *g,\n"
28627 " const char *csumtype,\n"
28628 " const char *device);\n"
28633 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1012
28634 #: ../src/guestfs-actions.pod:1012
28636 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
28637 "device named C<device>. For the types of checksums supported see the "
28638 "C<guestfs_checksum> command."
28642 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1019
28643 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5169
28644 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5304
28645 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5341
28646 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5359
28647 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5541
28648 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7152
28649 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7166
28650 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7566
28651 #: ../src/guestfs-actions.pod:1019 ../src/guestfs-actions.pod:5169
28652 #: ../src/guestfs-actions.pod:5304 ../src/guestfs-actions.pod:5341
28653 #: ../src/guestfs-actions.pod:5359 ../src/guestfs-actions.pod:5541
28654 #: ../src/guestfs-actions.pod:7152 ../src/guestfs-actions.pod:7166
28655 #: ../src/guestfs-actions.pod:7566
28656 msgid "(Added in 1.3.2)"
28660 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1021
28661 #: ../src/guestfs-actions.pod:1021
28662 msgid "guestfs_checksums_out"
28666 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1023
28667 #: ../src/guestfs-actions.pod:1023
28671 " guestfs_checksums_out (guestfs_h *g,\n"
28672 " const char *csumtype,\n"
28673 " const char *directory,\n"
28674 " const char *sumsfile);\n"
28679 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1043
28680 #: ../src/guestfs-actions.pod:1043
28681 msgid "(Added in 1.3.7)"
28685 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1045
28686 #: ../src/guestfs-actions.pod:1045
28687 msgid "guestfs_chmod"
28691 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1047
28692 #: ../src/guestfs-actions.pod:1047
28696 " guestfs_chmod (guestfs_h *g,\n"
28698 " const char *path);\n"
28703 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1065
28704 #: ../src/guestfs-actions.pod:1065
28705 msgid "guestfs_chown"
28709 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1067
28710 #: ../src/guestfs-actions.pod:1067
28714 " guestfs_chown (guestfs_h *g,\n"
28717 " const char *path);\n"
28722 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1083
28723 #: ../src/guestfs-actions.pod:1083
28724 msgid "guestfs_command"
28728 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1085
28729 #: ../src/guestfs-actions.pod:1085
28733 " guestfs_command (guestfs_h *g,\n"
28734 " char *const *arguments);\n"
28739 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1094
28740 #: ../src/guestfs-actions.pod:1094
28742 "The single parameter is an argv-style list of arguments. The first element "
28743 "is the name of the program to run. Subsequent elements are parameters. The "
28744 "list must be non-empty (ie. must contain a program name). Note that the "
28745 "command runs directly, and is I<not> invoked via the shell (see "
28750 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1125
28751 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1145
28752 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1610
28753 #: ../src/guestfs-actions.pod:1125 ../src/guestfs-actions.pod:1145
28754 #: ../src/guestfs-actions.pod:1610
28755 msgid "(Added in 0.9.1)"
28759 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1127
28760 #: ../src/guestfs-actions.pod:1127
28761 msgid "guestfs_command_lines"
28765 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1129
28766 #: ../src/guestfs-actions.pod:1129
28770 " guestfs_command_lines (guestfs_h *g,\n"
28771 " char *const *arguments);\n"
28776 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1133
28777 #: ../src/guestfs-actions.pod:1133
28779 "This is the same as C<guestfs_command>, but splits the result into a list of "
28784 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1136
28785 #: ../src/guestfs-actions.pod:1136
28786 msgid "See also: C<guestfs_sh_lines>"
28790 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1147
28791 #: ../src/guestfs-actions.pod:1147
28792 msgid "guestfs_config"
28796 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1149
28797 #: ../src/guestfs-actions.pod:1149
28801 " guestfs_config (guestfs_h *g,\n"
28802 " const char *qemuparam,\n"
28803 " const char *qemuvalue);\n"
28808 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1167
28809 #: ../src/guestfs-actions.pod:1167
28810 msgid "guestfs_copy_size"
28814 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1169
28815 #: ../src/guestfs-actions.pod:1169
28819 " guestfs_copy_size (guestfs_h *g,\n"
28820 " const char *src,\n"
28821 " const char *dest,\n"
28822 " int64_t size);\n"
28827 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1183
28828 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1306
28829 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1337
28830 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1382
28831 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1759
28832 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1781
28833 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3638
28834 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7238
28835 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7272
28836 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7775
28837 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7794
28838 #: ../src/guestfs-actions.pod:1183 ../src/guestfs-actions.pod:1306
28839 #: ../src/guestfs-actions.pod:1337 ../src/guestfs-actions.pod:1382
28840 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:1781
28841 #: ../src/guestfs-actions.pod:3638 ../src/guestfs-actions.pod:7238
28842 #: ../src/guestfs-actions.pod:7272 ../src/guestfs-actions.pod:7775
28843 #: ../src/guestfs-actions.pod:7794
28845 "This long-running command can generate progress notification messages so "
28846 "that the caller can display a progress bar or indicator. To receive these "
28847 "messages, the caller must register a progress event callback. See L<guestfs"
28848 "(3)/GUESTFS_EVENT_PROGRESS>."
28852 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1188
28853 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4362
28854 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5747
28855 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7473
28856 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7493
28857 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7579
28858 #: ../src/guestfs-actions.pod:1188 ../src/guestfs-actions.pod:4362
28859 #: ../src/guestfs-actions.pod:5747 ../src/guestfs-actions.pod:7473
28860 #: ../src/guestfs-actions.pod:7493 ../src/guestfs-actions.pod:7579
28861 msgid "(Added in 1.0.87)"
28865 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1190
28866 #: ../src/guestfs-actions.pod:1190
28871 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1192
28872 #: ../src/guestfs-actions.pod:1192
28876 " guestfs_cp (guestfs_h *g,\n"
28877 " const char *src,\n"
28878 " const char *dest);\n"
28883 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1202
28884 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1216
28885 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1288
28886 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1362
28887 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1476
28888 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5116
28889 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5591
28890 #: ../src/guestfs-actions.pod:1202 ../src/guestfs-actions.pod:1216
28891 #: ../src/guestfs-actions.pod:1288 ../src/guestfs-actions.pod:1362
28892 #: ../src/guestfs-actions.pod:1476 ../src/guestfs-actions.pod:5116
28893 #: ../src/guestfs-actions.pod:5591
28894 msgid "(Added in 1.0.18)"
28898 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1204
28899 #: ../src/guestfs-actions.pod:1204
28900 msgid "guestfs_cp_a"
28904 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1206
28905 #: ../src/guestfs-actions.pod:1206
28909 " guestfs_cp_a (guestfs_h *g,\n"
28910 " const char *src,\n"
28911 " const char *dest);\n"
28916 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1218
28917 #: ../src/guestfs-actions.pod:1218
28922 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1220
28923 #: ../src/guestfs-actions.pod:1220
28927 " guestfs_dd (guestfs_h *g,\n"
28928 " const char *src,\n"
28929 " const char *dest);\n"
28934 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1230
28935 #: ../src/guestfs-actions.pod:1230
28937 "If the destination is a device, it must be as large or larger than the "
28938 "source file or device, otherwise the copy will fail. This command cannot do "
28939 "partial copies (see C<guestfs_copy_size>)."
28943 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1238
28944 #: ../src/guestfs-actions.pod:1238
28949 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1240
28950 #: ../src/guestfs-actions.pod:1240
28954 " guestfs_df (guestfs_h *g);\n"
28959 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1245
28960 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1262
28961 #: ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1262
28963 "This command is mostly useful for interactive sessions. It is I<not> "
28964 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
28969 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1252
28970 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1269
28971 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1387
28972 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2361
28973 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2385
28974 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2453
28975 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4472
28976 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5016
28977 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6976
28978 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7000
28979 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7619
28980 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7632
28981 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7645
28982 #: ../src/guestfs-actions.pod:1252 ../src/guestfs-actions.pod:1269
28983 #: ../src/guestfs-actions.pod:1387 ../src/guestfs-actions.pod:2361
28984 #: ../src/guestfs-actions.pod:2385 ../src/guestfs-actions.pod:2453
28985 #: ../src/guestfs-actions.pod:4472 ../src/guestfs-actions.pod:5016
28986 #: ../src/guestfs-actions.pod:6976 ../src/guestfs-actions.pod:7000
28987 #: ../src/guestfs-actions.pod:7619 ../src/guestfs-actions.pod:7632
28988 #: ../src/guestfs-actions.pod:7645
28989 msgid "(Added in 1.0.54)"
28993 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1254
28994 #: ../src/guestfs-actions.pod:1254
28995 msgid "guestfs_df_h"
28999 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1256
29000 #: ../src/guestfs-actions.pod:1256
29004 " guestfs_df_h (guestfs_h *g);\n"
29009 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1271
29010 #: ../src/guestfs-actions.pod:1271
29011 msgid "guestfs_dmesg"
29015 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1273
29016 #: ../src/guestfs-actions.pod:1273
29020 " guestfs_dmesg (guestfs_h *g);\n"
29025 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1280
29026 #: ../src/guestfs-actions.pod:1280
29028 "Another way to get the same information is to enable verbose messages with "
29029 "C<guestfs_set_verbose> or by setting the environment variable "
29030 "C<LIBGUESTFS_DEBUG=1> before running the program."
29034 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1290
29035 #: ../src/guestfs-actions.pod:1290
29036 msgid "guestfs_download"
29040 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1292
29041 #: ../src/guestfs-actions.pod:1292
29045 " guestfs_download (guestfs_h *g,\n"
29046 " const char *remotefilename,\n"
29047 " const char *filename);\n"
29052 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1302
29053 #: ../src/guestfs-actions.pod:1302
29054 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
29058 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1313
29059 #: ../src/guestfs-actions.pod:1313
29060 msgid "guestfs_download_offset"
29064 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1315
29065 #: ../src/guestfs-actions.pod:1315
29069 " guestfs_download_offset (guestfs_h *g,\n"
29070 " const char *remotefilename,\n"
29071 " const char *filename,\n"
29072 " int64_t offset,\n"
29073 " int64_t size);\n"
29078 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1328
29079 #: ../src/guestfs-actions.pod:1328
29081 "Note that there is no limit on the amount of data that can be downloaded "
29082 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
29083 "full amount unless an error occurs."
29087 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1333
29088 #: ../src/guestfs-actions.pod:1333
29089 msgid "See also C<guestfs_download>, C<guestfs_pread>."
29093 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1342
29094 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7277
29095 #: ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:7277
29096 msgid "(Added in 1.5.17)"
29100 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1344
29101 #: ../src/guestfs-actions.pod:1344
29102 msgid "guestfs_drop_caches"
29106 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1346
29107 #: ../src/guestfs-actions.pod:1346
29111 " guestfs_drop_caches (guestfs_h *g,\n"
29112 " int whattodrop);\n"
29117 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1364
29118 #: ../src/guestfs-actions.pod:1364
29123 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1366
29124 #: ../src/guestfs-actions.pod:1366
29128 " guestfs_du (guestfs_h *g,\n"
29129 " const char *path);\n"
29134 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1389
29135 #: ../src/guestfs-actions.pod:1389
29136 msgid "guestfs_e2fsck_f"
29140 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1391
29141 #: ../src/guestfs-actions.pod:1391
29145 " guestfs_e2fsck_f (guestfs_h *g,\n"
29146 " const char *device);\n"
29151 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1399
29152 #: ../src/guestfs-actions.pod:1399
29154 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
29155 "Normally you should use C<guestfs_fsck>."
29159 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1404
29160 #: ../src/guestfs-actions.pod:1404
29161 msgid "(Added in 1.0.29)"
29165 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1406
29166 #: ../src/guestfs-actions.pod:1406
29167 msgid "guestfs_echo_daemon"
29171 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1408
29172 #: ../src/guestfs-actions.pod:1408
29176 " guestfs_echo_daemon (guestfs_h *g,\n"
29177 " char *const *words);\n"
29182 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1417
29183 #: ../src/guestfs-actions.pod:1417
29184 msgid "See also C<guestfs_ping_daemon>."
29188 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1422
29189 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2169
29190 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6448
29191 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:2169
29192 #: ../src/guestfs-actions.pod:6448
29193 msgid "(Added in 1.0.69)"
29197 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1424
29198 #: ../src/guestfs-actions.pod:1424
29199 msgid "guestfs_egrep"
29203 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1426
29204 #: ../src/guestfs-actions.pod:1426
29208 " guestfs_egrep (guestfs_h *g,\n"
29209 " const char *regex,\n"
29210 " const char *path);\n"
29215 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1441
29216 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1460
29217 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1517
29218 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1563
29219 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1582
29220 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2299
29221 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2318
29222 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2474
29223 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2487
29224 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2502
29225 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2548
29226 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2570
29227 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2583
29228 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3852
29229 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3866
29230 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3879
29231 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3893
29232 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4894
29233 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5925
29234 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5974
29235 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6844
29236 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6856
29237 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6869
29238 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6882
29239 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6904
29240 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6917
29241 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6930
29242 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6943
29243 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7737
29244 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7756
29245 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7842
29246 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7861
29247 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7907
29248 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7926
29249 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1460
29250 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:1563
29251 #: ../src/guestfs-actions.pod:1582 ../src/guestfs-actions.pod:2299
29252 #: ../src/guestfs-actions.pod:2318 ../src/guestfs-actions.pod:2474
29253 #: ../src/guestfs-actions.pod:2487 ../src/guestfs-actions.pod:2502
29254 #: ../src/guestfs-actions.pod:2548 ../src/guestfs-actions.pod:2570
29255 #: ../src/guestfs-actions.pod:2583 ../src/guestfs-actions.pod:3852
29256 #: ../src/guestfs-actions.pod:3866 ../src/guestfs-actions.pod:3879
29257 #: ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:4894
29258 #: ../src/guestfs-actions.pod:5925 ../src/guestfs-actions.pod:5974
29259 #: ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6856
29260 #: ../src/guestfs-actions.pod:6869 ../src/guestfs-actions.pod:6882
29261 #: ../src/guestfs-actions.pod:6904 ../src/guestfs-actions.pod:6917
29262 #: ../src/guestfs-actions.pod:6930 ../src/guestfs-actions.pod:6943
29263 #: ../src/guestfs-actions.pod:7737 ../src/guestfs-actions.pod:7756
29264 #: ../src/guestfs-actions.pod:7842 ../src/guestfs-actions.pod:7861
29265 #: ../src/guestfs-actions.pod:7907 ../src/guestfs-actions.pod:7926
29266 msgid "(Added in 1.0.66)"
29270 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1443
29271 #: ../src/guestfs-actions.pod:1443
29272 msgid "guestfs_egrepi"
29276 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1445
29277 #: ../src/guestfs-actions.pod:1445
29281 " guestfs_egrepi (guestfs_h *g,\n"
29282 " const char *regex,\n"
29283 " const char *path);\n"
29288 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1462
29289 #: ../src/guestfs-actions.pod:1462
29290 msgid "guestfs_equal"
29294 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1464
29295 #: ../src/guestfs-actions.pod:1464
29299 " guestfs_equal (guestfs_h *g,\n"
29300 " const char *file1,\n"
29301 " const char *file2);\n"
29306 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1478
29307 #: ../src/guestfs-actions.pod:1478
29308 msgid "guestfs_exists"
29312 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1480
29313 #: ../src/guestfs-actions.pod:1480
29317 " guestfs_exists (guestfs_h *g,\n"
29318 " const char *path);\n"
29323 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1487
29324 #: ../src/guestfs-actions.pod:1487
29325 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
29329 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1493
29330 #: ../src/guestfs-actions.pod:1493
29331 msgid "guestfs_fallocate"
29335 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1495
29336 #: ../src/guestfs-actions.pod:1495
29340 " guestfs_fallocate (guestfs_h *g,\n"
29341 " const char *path,\n"
29347 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1519
29348 #: ../src/guestfs-actions.pod:1519
29349 msgid "guestfs_fallocate64"
29353 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1521
29354 #: ../src/guestfs-actions.pod:1521
29358 " guestfs_fallocate64 (guestfs_h *g,\n"
29359 " const char *path,\n"
29365 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1530
29366 #: ../src/guestfs-actions.pod:1530
29368 "Note that this call allocates disk blocks for the file. To create a sparse "
29369 "file use C<guestfs_truncate_size> instead."
29373 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1533
29374 #: ../src/guestfs-actions.pod:1533
29376 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
29377 "oversight it only allowed 30 bit lengths to be specified, effectively "
29378 "limiting the maximum size of files created through that call to 1GB."
29382 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1544
29383 #: ../src/guestfs-actions.pod:1544
29384 msgid "(Added in 1.3.17)"
29388 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1546
29389 #: ../src/guestfs-actions.pod:1546
29390 msgid "guestfs_fgrep"
29394 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1548
29395 #: ../src/guestfs-actions.pod:1548
29399 " guestfs_fgrep (guestfs_h *g,\n"
29400 " const char *pattern,\n"
29401 " const char *path);\n"
29406 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1565
29407 #: ../src/guestfs-actions.pod:1565
29408 msgid "guestfs_fgrepi"
29412 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1567
29413 #: ../src/guestfs-actions.pod:1567
29417 " guestfs_fgrepi (guestfs_h *g,\n"
29418 " const char *pattern,\n"
29419 " const char *path);\n"
29424 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1584
29425 #: ../src/guestfs-actions.pod:1584
29426 msgid "guestfs_file"
29430 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1586
29431 #: ../src/guestfs-actions.pod:1586
29435 " guestfs_file (guestfs_h *g,\n"
29436 " const char *path);\n"
29441 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1604
29442 #: ../src/guestfs-actions.pod:1604
29444 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
29445 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
29449 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1612
29450 #: ../src/guestfs-actions.pod:1612
29451 msgid "guestfs_file_architecture"
29455 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1614
29456 #: ../src/guestfs-actions.pod:1614
29460 " guestfs_file_architecture (guestfs_h *g,\n"
29461 " const char *filename);\n"
29466 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1722
29467 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1885
29468 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1902
29469 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2603
29470 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2693
29471 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2759
29472 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2946
29473 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2964
29474 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3004
29475 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3079
29476 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3172
29477 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3409
29478 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3541
29479 #: ../src/guestfs-actions.pod:1722 ../src/guestfs-actions.pod:1885
29480 #: ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:2603
29481 #: ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2759
29482 #: ../src/guestfs-actions.pod:2946 ../src/guestfs-actions.pod:2964
29483 #: ../src/guestfs-actions.pod:3004 ../src/guestfs-actions.pod:3079
29484 #: ../src/guestfs-actions.pod:3172 ../src/guestfs-actions.pod:3409
29485 #: ../src/guestfs-actions.pod:3541
29486 msgid "(Added in 1.5.3)"
29490 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1724
29491 #: ../src/guestfs-actions.pod:1724
29492 msgid "guestfs_filesize"
29496 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1726
29497 #: ../src/guestfs-actions.pod:1726
29501 " guestfs_filesize (guestfs_h *g,\n"
29502 " const char *file);\n"
29507 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1732
29508 #: ../src/guestfs-actions.pod:1732
29510 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
29511 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
29512 "devices, use C<guestfs_blockdev_getsize64>."
29516 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1738
29517 #: ../src/guestfs-actions.pod:1738
29518 msgid "(Added in 1.0.82)"
29522 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1740
29523 #: ../src/guestfs-actions.pod:1740
29524 msgid "guestfs_fill"
29528 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1742
29529 #: ../src/guestfs-actions.pod:1742
29533 " guestfs_fill (guestfs_h *g,\n"
29536 " const char *path);\n"
29541 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1752
29542 #: ../src/guestfs-actions.pod:1752
29544 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
29545 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
29546 "bytes use C<guestfs_fill_pattern>."
29550 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1764
29551 #: ../src/guestfs-actions.pod:1764
29552 msgid "(Added in 1.0.79)"
29556 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1766
29557 #: ../src/guestfs-actions.pod:1766
29558 msgid "guestfs_fill_pattern"
29562 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1768
29563 #: ../src/guestfs-actions.pod:1768
29567 " guestfs_fill_pattern (guestfs_h *g,\n"
29568 " const char *pattern,\n"
29570 " const char *path);\n"
29575 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1774
29576 #: ../src/guestfs-actions.pod:1774
29578 "This function is like C<guestfs_fill> except that it creates a new file of "
29579 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
29580 "pattern is truncated if necessary to ensure the length of the file is "
29581 "exactly C<len> bytes."
29585 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1786
29586 #: ../src/guestfs-actions.pod:1786
29587 msgid "(Added in 1.3.12)"
29591 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1788
29592 #: ../src/guestfs-actions.pod:1788
29593 msgid "guestfs_find"
29597 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1790
29598 #: ../src/guestfs-actions.pod:1790
29602 " guestfs_find (guestfs_h *g,\n"
29603 " const char *directory);\n"
29608 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1806
29609 #: ../src/guestfs-actions.pod:1806
29611 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
29615 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1819
29616 #: ../src/guestfs-actions.pod:1819
29617 msgid "See also C<guestfs_find0>."
29621 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1828
29622 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4299
29623 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6009
29624 #: ../src/guestfs-actions.pod:1828 ../src/guestfs-actions.pod:4299
29625 #: ../src/guestfs-actions.pod:6009
29626 msgid "(Added in 1.0.27)"
29630 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1830
29631 #: ../src/guestfs-actions.pod:1830
29632 msgid "guestfs_find0"
29636 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1832
29637 #: ../src/guestfs-actions.pod:1832
29641 " guestfs_find0 (guestfs_h *g,\n"
29642 " const char *directory,\n"
29643 " const char *files);\n"
29648 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1841
29649 #: ../src/guestfs-actions.pod:1841
29651 "This command works the same way as C<guestfs_find> with the following "
29656 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1868
29657 #: ../src/guestfs-actions.pod:1868
29658 msgid "(Added in 1.0.74)"
29662 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1870
29663 #: ../src/guestfs-actions.pod:1870
29664 msgid "guestfs_findfs_label"
29668 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1872
29669 #: ../src/guestfs-actions.pod:1872
29673 " guestfs_findfs_label (guestfs_h *g,\n"
29674 " const char *label);\n"
29679 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1880
29680 #: ../src/guestfs-actions.pod:1880
29681 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
29685 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1887
29686 #: ../src/guestfs-actions.pod:1887
29687 msgid "guestfs_findfs_uuid"
29691 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1889
29692 #: ../src/guestfs-actions.pod:1889
29696 " guestfs_findfs_uuid (guestfs_h *g,\n"
29697 " const char *uuid);\n"
29702 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1897
29703 #: ../src/guestfs-actions.pod:1897
29704 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
29708 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1904
29709 #: ../src/guestfs-actions.pod:1904
29710 msgid "guestfs_fsck"
29714 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1906
29715 #: ../src/guestfs-actions.pod:1906
29719 " guestfs_fsck (guestfs_h *g,\n"
29720 " const char *fstype,\n"
29721 " const char *device);\n"
29726 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1941
29727 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7780
29728 #: ../src/guestfs-actions.pod:1941 ../src/guestfs-actions.pod:7780
29729 msgid "(Added in 1.0.16)"
29733 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1943
29734 #: ../src/guestfs-actions.pod:1943
29735 msgid "guestfs_get_append"
29739 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1945
29740 #: ../src/guestfs-actions.pod:1945
29744 " guestfs_get_append (guestfs_h *g);\n"
29749 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1953
29750 #: ../src/guestfs-actions.pod:1953
29752 "This function returns a string which may be NULL. There is no way to return "
29753 "an error from this function. The string is owned by the guest handle and "
29754 "must I<not> be freed."
29758 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1957
29759 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5687
29760 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6169
29761 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6611
29762 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6630
29763 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6646
29764 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6670
29765 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7424
29766 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7439
29767 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7823
29768 #: ../src/guestfs-actions.pod:1957 ../src/guestfs-actions.pod:5687
29769 #: ../src/guestfs-actions.pod:6169 ../src/guestfs-actions.pod:6611
29770 #: ../src/guestfs-actions.pod:6630 ../src/guestfs-actions.pod:6646
29771 #: ../src/guestfs-actions.pod:6670 ../src/guestfs-actions.pod:7424
29772 #: ../src/guestfs-actions.pod:7439 ../src/guestfs-actions.pod:7823
29773 msgid "(Added in 1.0.26)"
29777 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1959
29778 #: ../src/guestfs-actions.pod:1959
29779 msgid "guestfs_get_attach_method"
29783 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1961
29784 #: ../src/guestfs-actions.pod:1961
29788 " guestfs_get_attach_method (guestfs_h *g);\n"
29793 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1964
29794 #: ../src/guestfs-actions.pod:1964
29795 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
29799 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1969
29800 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6199
29801 #: ../src/guestfs-actions.pod:1969 ../src/guestfs-actions.pod:6199
29802 msgid "(Added in 1.9.8)"
29806 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1971
29807 #: ../src/guestfs-actions.pod:1971
29808 msgid "guestfs_get_autosync"
29812 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1973
29813 #: ../src/guestfs-actions.pod:1973
29817 " guestfs_get_autosync (guestfs_h *g);\n"
29822 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1982
29823 #: ../src/guestfs-actions.pod:1982
29824 msgid "guestfs_get_direct"
29828 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1984
29829 #: ../src/guestfs-actions.pod:1984
29833 " guestfs_get_direct (guestfs_h *g);\n"
29838 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1991
29839 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6240
29840 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:6240
29841 msgid "(Added in 1.0.72)"
29845 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1993
29846 #: ../src/guestfs-actions.pod:1993
29847 msgid "guestfs_get_e2label"
29851 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:1995
29852 #: ../src/guestfs-actions.pod:1995
29856 " guestfs_get_e2label (guestfs_h *g,\n"
29857 " const char *device);\n"
29862 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2012
29863 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2033
29864 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6258
29865 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6277
29866 #: ../src/guestfs-actions.pod:2012 ../src/guestfs-actions.pod:2033
29867 #: ../src/guestfs-actions.pod:6258 ../src/guestfs-actions.pod:6277
29868 msgid "(Added in 1.0.15)"
29872 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2014
29873 #: ../src/guestfs-actions.pod:2014
29874 msgid "guestfs_get_e2uuid"
29878 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2016
29879 #: ../src/guestfs-actions.pod:2016
29883 " guestfs_get_e2uuid (guestfs_h *g,\n"
29884 " const char *device);\n"
29889 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2035
29890 #: ../src/guestfs-actions.pod:2035
29891 msgid "guestfs_get_memsize"
29895 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2037
29896 #: ../src/guestfs-actions.pod:2037
29900 " guestfs_get_memsize (guestfs_h *g);\n"
29905 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2043
29906 #: ../src/guestfs-actions.pod:2043
29908 "If C<guestfs_set_memsize> was not called on this handle, and if "
29909 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
29910 "value for memsize."
29914 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2052
29915 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4590
29916 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4799
29917 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4818
29918 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4837
29919 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4849
29920 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4866
29921 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4879
29922 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5912
29923 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6298
29924 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6578
29925 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7193
29926 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:4590
29927 #: ../src/guestfs-actions.pod:4799 ../src/guestfs-actions.pod:4818
29928 #: ../src/guestfs-actions.pod:4837 ../src/guestfs-actions.pod:4849
29929 #: ../src/guestfs-actions.pod:4866 ../src/guestfs-actions.pod:4879
29930 #: ../src/guestfs-actions.pod:5912 ../src/guestfs-actions.pod:6298
29931 #: ../src/guestfs-actions.pod:6578 ../src/guestfs-actions.pod:7193
29932 msgid "(Added in 1.0.55)"
29936 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2054
29937 #: ../src/guestfs-actions.pod:2054
29938 msgid "guestfs_get_network"
29942 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2056
29943 #: ../src/guestfs-actions.pod:2056
29947 " guestfs_get_network (guestfs_h *g);\n"
29952 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2063
29953 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6317
29954 #: ../src/guestfs-actions.pod:2063 ../src/guestfs-actions.pod:6317
29955 msgid "(Added in 1.5.4)"
29959 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2065
29960 #: ../src/guestfs-actions.pod:2065
29961 msgid "guestfs_get_path"
29965 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2067
29966 #: ../src/guestfs-actions.pod:2067
29970 " guestfs_get_path (guestfs_h *g);\n"
29975 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2075
29976 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2115
29977 #: ../src/guestfs-actions.pod:2075 ../src/guestfs-actions.pod:2115
29979 "This function returns a string, or NULL on error. The string is owned by "
29980 "the guest handle and must I<not> be freed."
29984 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2080
29985 #: ../src/guestfs-actions.pod:2080
29986 msgid "guestfs_get_pgroup"
29990 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2082
29991 #: ../src/guestfs-actions.pod:2082
29995 " guestfs_get_pgroup (guestfs_h *g);\n"
30000 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2089
30001 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6353
30002 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7685
30003 #: ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:6353
30004 #: ../src/guestfs-actions.pod:7685
30005 msgid "(Added in 1.11.18)"
30009 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2091
30010 #: ../src/guestfs-actions.pod:2091
30011 msgid "guestfs_get_pid"
30015 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2093
30016 #: ../src/guestfs-actions.pod:2093
30020 " guestfs_get_pid (guestfs_h *g);\n"
30025 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2103
30026 #: ../src/guestfs-actions.pod:2103
30027 msgid "(Added in 1.0.56)"
30031 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2105
30032 #: ../src/guestfs-actions.pod:2105
30033 msgid "guestfs_get_qemu"
30037 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2107
30038 #: ../src/guestfs-actions.pod:2107
30042 " guestfs_get_qemu (guestfs_h *g);\n"
30047 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2118
30048 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6381
30049 #: ../src/guestfs-actions.pod:2118 ../src/guestfs-actions.pod:6381
30050 msgid "(Added in 1.0.6)"
30054 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2120
30055 #: ../src/guestfs-actions.pod:2120
30056 msgid "guestfs_get_recovery_proc"
30060 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2122
30061 #: ../src/guestfs-actions.pod:2122
30065 " guestfs_get_recovery_proc (guestfs_h *g);\n"
30070 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2129
30071 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3663
30072 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3994
30073 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4397
30074 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4429
30075 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5617
30076 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5960
30077 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6405
30078 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7096
30079 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7116
30080 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7308
30081 #: ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:3663
30082 #: ../src/guestfs-actions.pod:3994 ../src/guestfs-actions.pod:4397
30083 #: ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:5617
30084 #: ../src/guestfs-actions.pod:5960 ../src/guestfs-actions.pod:6405
30085 #: ../src/guestfs-actions.pod:7096 ../src/guestfs-actions.pod:7116
30086 #: ../src/guestfs-actions.pod:7308
30087 msgid "(Added in 1.0.77)"
30091 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2131
30092 #: ../src/guestfs-actions.pod:2131
30093 msgid "guestfs_get_selinux"
30097 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2133
30098 #: ../src/guestfs-actions.pod:2133
30102 " guestfs_get_selinux (guestfs_h *g);\n"
30107 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2136
30108 #: ../src/guestfs-actions.pod:2136
30110 "This returns the current setting of the selinux flag which is passed to the "
30111 "appliance at boot time. See C<guestfs_set_selinux>."
30115 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2144
30116 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2207
30117 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6424
30118 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6482
30119 #: ../src/guestfs-actions.pod:2144 ../src/guestfs-actions.pod:2207
30120 #: ../src/guestfs-actions.pod:6424 ../src/guestfs-actions.pod:6482
30121 msgid "(Added in 1.0.67)"
30125 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2146
30126 #: ../src/guestfs-actions.pod:2146
30127 msgid "guestfs_get_state"
30131 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2148
30132 #: ../src/guestfs-actions.pod:2148
30136 " guestfs_get_state (guestfs_h *g);\n"
30141 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2160
30142 #: ../src/guestfs-actions.pod:2160
30143 msgid "guestfs_get_trace"
30147 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2162
30148 #: ../src/guestfs-actions.pod:2162
30152 " guestfs_get_trace (guestfs_h *g);\n"
30157 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2171
30158 #: ../src/guestfs-actions.pod:2171
30159 msgid "guestfs_get_umask"
30163 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2173
30164 #: ../src/guestfs-actions.pod:2173
30168 " guestfs_get_umask (guestfs_h *g);\n"
30173 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2176
30174 #: ../src/guestfs-actions.pod:2176
30176 "Return the current umask. By default the umask is C<022> unless it has been "
30177 "set by calling C<guestfs_umask>."
30181 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2183
30182 #: ../src/guestfs-actions.pod:2183
30183 msgid "guestfs_get_verbose"
30187 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2185
30188 #: ../src/guestfs-actions.pod:2185
30192 " guestfs_get_verbose (guestfs_h *g);\n"
30197 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2194
30198 #: ../src/guestfs-actions.pod:2194
30199 msgid "guestfs_getcon"
30203 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2196
30204 #: ../src/guestfs-actions.pod:2196
30208 " guestfs_getcon (guestfs_h *g);\n"
30213 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2201
30214 #: ../src/guestfs-actions.pod:2201
30216 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
30220 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2209
30221 #: ../src/guestfs-actions.pod:2209
30222 msgid "guestfs_getxattr"
30226 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2211
30227 #: ../src/guestfs-actions.pod:2211
30231 " guestfs_getxattr (guestfs_h *g,\n"
30232 " const char *path,\n"
30233 " const char *name,\n"
30234 " size_t *size_r);\n"
30239 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2217
30240 #: ../src/guestfs-actions.pod:2217
30242 "Get a single extended attribute from file C<path> named C<name>. This call "
30243 "follows symlinks. If you want to lookup an extended attribute for the "
30244 "symlink itself, use C<guestfs_lgetxattr>."
30248 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2221
30249 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3677
30250 #: ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:3677
30252 "Normally it is better to get all extended attributes from a file in one go "
30253 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
30254 "implementations are buggy and do not provide a way to list out attributes. "
30255 "For these filesystems (notably ntfs-3g) you have to know the names of the "
30256 "extended attributes you want in advance and call this function."
30260 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2231
30261 #: ../src/guestfs-actions.pod:2231
30262 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
30266 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2233
30267 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2424
30268 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2894
30269 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3689
30270 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5610
30271 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5636
30272 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5817
30273 #: ../src/guestfs-actions.pod:2233 ../src/guestfs-actions.pod:2424
30274 #: ../src/guestfs-actions.pod:2894 ../src/guestfs-actions.pod:3689
30275 #: ../src/guestfs-actions.pod:5610 ../src/guestfs-actions.pod:5636
30276 #: ../src/guestfs-actions.pod:5817
30278 "This function returns a buffer, or NULL on error. The size of the returned "
30279 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
30284 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2237
30285 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3693
30286 #: ../src/guestfs-actions.pod:2237 ../src/guestfs-actions.pod:3693
30287 msgid "(Added in 1.7.24)"
30291 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2239
30292 #: ../src/guestfs-actions.pod:2239
30293 msgid "guestfs_getxattrs"
30297 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2241
30298 #: ../src/guestfs-actions.pod:2241
30301 " struct guestfs_xattr_list *\n"
30302 " guestfs_getxattrs (guestfs_h *g,\n"
30303 " const char *path);\n"
30308 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2251
30309 #: ../src/guestfs-actions.pod:2251
30310 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
30314 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2253
30315 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3705
30316 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4393
30317 #: ../src/guestfs-actions.pod:2253 ../src/guestfs-actions.pod:3705
30318 #: ../src/guestfs-actions.pod:4393
30320 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
30321 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
30325 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2257
30326 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3709
30327 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3908
30328 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3944
30329 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5990
30330 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6501
30331 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7888
30332 #: ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:3709
30333 #: ../src/guestfs-actions.pod:3908 ../src/guestfs-actions.pod:3944
30334 #: ../src/guestfs-actions.pod:5990 ../src/guestfs-actions.pod:6501
30335 #: ../src/guestfs-actions.pod:7888
30336 msgid "(Added in 1.0.59)"
30340 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2259
30341 #: ../src/guestfs-actions.pod:2259
30342 msgid "guestfs_glob_expand"
30346 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2261
30347 #: ../src/guestfs-actions.pod:2261
30351 " guestfs_glob_expand (guestfs_h *g,\n"
30352 " const char *pattern);\n"
30357 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2280
30358 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6694
30359 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6711
30360 #: ../src/guestfs-actions.pod:2280 ../src/guestfs-actions.pod:6694
30361 #: ../src/guestfs-actions.pod:6711
30362 msgid "(Added in 1.0.50)"
30366 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2282
30367 #: ../src/guestfs-actions.pod:2282
30368 msgid "guestfs_grep"
30372 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2284
30373 #: ../src/guestfs-actions.pod:2284
30377 " guestfs_grep (guestfs_h *g,\n"
30378 " const char *regex,\n"
30379 " const char *path);\n"
30384 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2301
30385 #: ../src/guestfs-actions.pod:2301
30386 msgid "guestfs_grepi"
30390 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2303
30391 #: ../src/guestfs-actions.pod:2303
30395 " guestfs_grepi (guestfs_h *g,\n"
30396 " const char *regex,\n"
30397 " const char *path);\n"
30402 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2320
30403 #: ../src/guestfs-actions.pod:2320
30404 msgid "guestfs_grub_install"
30408 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2322
30409 #: ../src/guestfs-actions.pod:2322
30413 " guestfs_grub_install (guestfs_h *g,\n"
30414 " const char *root,\n"
30415 " const char *device);\n"
30420 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2343
30421 #: ../src/guestfs-actions.pod:2343
30422 msgid "(Added in 1.0.17)"
30426 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2345
30427 #: ../src/guestfs-actions.pod:2345
30428 msgid "guestfs_head"
30432 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2347
30433 #: ../src/guestfs-actions.pod:2347
30437 " guestfs_head (guestfs_h *g,\n"
30438 " const char *path);\n"
30443 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2363
30444 #: ../src/guestfs-actions.pod:2363
30445 msgid "guestfs_head_n"
30449 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2365
30450 #: ../src/guestfs-actions.pod:2365
30454 " guestfs_head_n (guestfs_h *g,\n"
30456 " const char *path);\n"
30461 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2387
30462 #: ../src/guestfs-actions.pod:2387
30463 msgid "guestfs_hexdump"
30467 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2389
30468 #: ../src/guestfs-actions.pod:2389
30472 " guestfs_hexdump (guestfs_h *g,\n"
30473 " const char *path);\n"
30478 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2402
30479 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6775
30480 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6830
30481 #: ../src/guestfs-actions.pod:2402 ../src/guestfs-actions.pod:6775
30482 #: ../src/guestfs-actions.pod:6830
30483 msgid "(Added in 1.0.22)"
30487 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2404
30488 #: ../src/guestfs-actions.pod:2404
30489 msgid "guestfs_initrd_cat"
30493 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2406
30494 #: ../src/guestfs-actions.pod:2406
30498 " guestfs_initrd_cat (guestfs_h *g,\n"
30499 " const char *initrdpath,\n"
30500 " const char *filename,\n"
30501 " size_t *size_r);\n"
30506 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2422
30507 #: ../src/guestfs-actions.pod:2422
30508 msgid "See also C<guestfs_initrd_list>."
30512 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2433
30513 #: ../src/guestfs-actions.pod:2433
30514 msgid "guestfs_initrd_list"
30518 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2435
30519 #: ../src/guestfs-actions.pod:2435
30523 " guestfs_initrd_list (guestfs_h *g,\n"
30524 " const char *path);\n"
30529 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2455
30530 #: ../src/guestfs-actions.pod:2455
30531 msgid "guestfs_inotify_add_watch"
30535 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2457
30536 #: ../src/guestfs-actions.pod:2457
30540 " guestfs_inotify_add_watch (guestfs_h *g,\n"
30541 " const char *path,\n"
30547 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2476
30548 #: ../src/guestfs-actions.pod:2476
30549 msgid "guestfs_inotify_close"
30553 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2478
30554 #: ../src/guestfs-actions.pod:2478
30558 " guestfs_inotify_close (guestfs_h *g);\n"
30563 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2489
30564 #: ../src/guestfs-actions.pod:2489
30565 msgid "guestfs_inotify_files"
30569 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2491
30570 #: ../src/guestfs-actions.pod:2491
30574 " guestfs_inotify_files (guestfs_h *g);\n"
30579 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2494
30580 #: ../src/guestfs-actions.pod:2494
30582 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
30583 "returns a list of pathnames of objects that were touched. The returned "
30584 "pathnames are sorted and deduplicated."
30588 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2504
30589 #: ../src/guestfs-actions.pod:2504
30590 msgid "guestfs_inotify_init"
30594 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2506
30595 #: ../src/guestfs-actions.pod:2506
30599 " guestfs_inotify_init (guestfs_h *g,\n"
30600 " int maxevents);\n"
30605 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2514
30606 #: ../src/guestfs-actions.pod:2514
30608 "C<maxevents> is the maximum number of events which will be queued up between "
30609 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
30610 "passed as C<0>, then the kernel (or previously set) default is used. For "
30611 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
30612 "throws away events, but records the fact that it threw them away by setting "
30613 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
30614 "C<guestfs_inotify_read>)."
30618 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2524
30619 #: ../src/guestfs-actions.pod:2524
30621 "Before any events are generated, you have to add some watches to the "
30622 "internal watch list. See: C<guestfs_inotify_add_watch>, "
30623 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
30627 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2530
30628 #: ../src/guestfs-actions.pod:2530
30630 "Queued up events should be read periodically by calling "
30631 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
30632 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
30633 "often enough then you risk the internal queue overflowing."
30637 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2537
30638 #: ../src/guestfs-actions.pod:2537
30640 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
30641 "This also removes any watches automatically."
30645 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2550
30646 #: ../src/guestfs-actions.pod:2550
30647 msgid "guestfs_inotify_read"
30651 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2552
30652 #: ../src/guestfs-actions.pod:2552
30655 " struct guestfs_inotify_event_list *\n"
30656 " guestfs_inotify_read (guestfs_h *g);\n"
30661 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2566
30662 #: ../src/guestfs-actions.pod:2566
30664 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
30665 "there was an error. I<The caller must call "
30666 "C<guestfs_free_inotify_event_list> after use>."
30670 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2572
30671 #: ../src/guestfs-actions.pod:2572
30672 msgid "guestfs_inotify_rm_watch"
30676 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2574
30677 #: ../src/guestfs-actions.pod:2574
30681 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
30687 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2578
30688 #: ../src/guestfs-actions.pod:2578
30690 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
30694 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2585
30695 #: ../src/guestfs-actions.pod:2585
30696 msgid "guestfs_inspect_get_arch"
30700 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2587
30701 #: ../src/guestfs-actions.pod:2587
30705 " guestfs_inspect_get_arch (guestfs_h *g,\n"
30706 " const char *root);\n"
30711 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2591
30712 #: ../src/guestfs-actions.pod:2591
30714 "This returns the architecture of the inspected operating system. The "
30715 "possible return values are listed under C<guestfs_file_architecture>."
30719 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2605
30720 #: ../src/guestfs-actions.pod:2605
30721 msgid "guestfs_inspect_get_distro"
30725 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2607
30726 #: ../src/guestfs-actions.pod:2607
30730 " guestfs_inspect_get_distro (guestfs_h *g,\n"
30731 " const char *root);\n"
30736 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2695
30737 #: ../src/guestfs-actions.pod:2695
30738 msgid "guestfs_inspect_get_drive_mappings"
30742 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2697
30743 #: ../src/guestfs-actions.pod:2697
30747 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
30748 " const char *root);\n"
30753 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2726
30754 #: ../src/guestfs-actions.pod:2726
30756 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
30757 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
30761 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2730
30762 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2998
30763 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3796
30764 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5078
30765 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7132
30766 #: ../src/guestfs-actions.pod:2730 ../src/guestfs-actions.pod:2998
30767 #: ../src/guestfs-actions.pod:3796 ../src/guestfs-actions.pod:5078
30768 #: ../src/guestfs-actions.pod:7132
30770 "This function returns a NULL-terminated array of strings, or NULL if there "
30771 "was an error. The array of strings will always have length C<2n+1>, where "
30772 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
30773 "caller must free the strings and the array after use>."
30777 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2736
30778 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3192
30779 #: ../src/guestfs-actions.pod:2736 ../src/guestfs-actions.pod:3192
30780 msgid "(Added in 1.9.17)"
30784 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2738
30785 #: ../src/guestfs-actions.pod:2738
30786 msgid "guestfs_inspect_get_filesystems"
30790 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2740
30791 #: ../src/guestfs-actions.pod:2740
30795 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
30796 " const char *root);\n"
30801 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2752
30802 #: ../src/guestfs-actions.pod:2752
30804 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
30805 "C<guestfs_inspect_get_mountpoints>."
30809 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2761
30810 #: ../src/guestfs-actions.pod:2761
30811 msgid "guestfs_inspect_get_format"
30815 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2763
30816 #: ../src/guestfs-actions.pod:2763
30820 " guestfs_inspect_get_format (guestfs_h *g,\n"
30821 " const char *root);\n"
30826 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2797
30827 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3228
30828 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3244
30829 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3262
30830 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6028
30831 #: ../src/guestfs-actions.pod:2797 ../src/guestfs-actions.pod:3228
30832 #: ../src/guestfs-actions.pod:3244 ../src/guestfs-actions.pod:3262
30833 #: ../src/guestfs-actions.pod:6028
30834 msgid "(Added in 1.9.4)"
30838 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2799
30839 #: ../src/guestfs-actions.pod:2799
30840 msgid "guestfs_inspect_get_hostname"
30844 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2801
30845 #: ../src/guestfs-actions.pod:2801
30849 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
30850 " const char *root);\n"
30855 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2816
30856 #: ../src/guestfs-actions.pod:2816
30857 msgid "(Added in 1.7.9)"
30861 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2818
30862 #: ../src/guestfs-actions.pod:2818
30863 msgid "guestfs_inspect_get_icon"
30867 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2820
30868 #: ../src/guestfs-actions.pod:2820
30872 " guestfs_inspect_get_icon (guestfs_h *g,\n"
30873 " const char *root,\n"
30874 " size_t *size_r,\n"
30880 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2831
30881 #: ../src/guestfs-actions.pod:2831
30884 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
30885 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
30890 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2898
30891 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3723
30892 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4977
30893 #: ../src/guestfs-actions.pod:2898 ../src/guestfs-actions.pod:3723
30894 #: ../src/guestfs-actions.pod:4977
30895 msgid "(Added in 1.11.12)"
30899 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2900
30900 #: ../src/guestfs-actions.pod:2900
30901 msgid "guestfs_inspect_get_icon_va"
30905 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2902
30906 #: ../src/guestfs-actions.pod:2902
30910 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
30911 " const char *root,\n"
30912 " size_t *size_r,\n"
30913 " va_list args);\n"
30918 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2908
30919 #: ../src/guestfs-actions.pod:2908
30920 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
30924 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2912
30925 #: ../src/guestfs-actions.pod:2912
30926 msgid "guestfs_inspect_get_icon_argv"
30930 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2914
30931 #: ../src/guestfs-actions.pod:2914
30935 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
30936 " const char *root,\n"
30937 " size_t *size_r,\n"
30938 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
30943 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2920
30944 #: ../src/guestfs-actions.pod:2920
30945 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
30949 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2924
30950 #: ../src/guestfs-actions.pod:2924
30951 msgid "guestfs_inspect_get_major_version"
30955 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2926
30956 #: ../src/guestfs-actions.pod:2926
30960 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
30961 " const char *root);\n"
30966 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2948
30967 #: ../src/guestfs-actions.pod:2948
30968 msgid "guestfs_inspect_get_minor_version"
30972 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2950
30973 #: ../src/guestfs-actions.pod:2950
30977 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
30978 " const char *root);\n"
30983 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2959
30984 #: ../src/guestfs-actions.pod:2959
30986 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
30987 "C<guestfs_inspect_get_major_version>."
30991 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2966
30992 #: ../src/guestfs-actions.pod:2966
30993 msgid "guestfs_inspect_get_mountpoints"
30997 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2968
30998 #: ../src/guestfs-actions.pod:2968
31002 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
31003 " const char *root);\n"
31008 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2989
31009 #: ../src/guestfs-actions.pod:2989
31011 "For operating systems like Windows which still use drive letters, this call "
31012 "will only return an entry for the first drive \"mounted on\" C</>. For "
31013 "information about the mapping of drive letters to partitions, see "
31014 "C<guestfs_inspect_get_drive_mappings>."
31018 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:2995
31019 #: ../src/guestfs-actions.pod:2995
31021 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
31022 "C<guestfs_inspect_get_filesystems>."
31026 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3006
31027 #: ../src/guestfs-actions.pod:3006
31028 msgid "guestfs_inspect_get_package_format"
31032 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3008
31033 #: ../src/guestfs-actions.pod:3008
31037 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
31038 " const char *root);\n"
31043 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3012
31044 #: ../src/guestfs-actions.pod:3012
31046 "This function and C<guestfs_inspect_get_package_management> return the "
31047 "package format and package management tool used by the inspected operating "
31048 "system. For example for Fedora these functions would return C<rpm> (package "
31049 "format) and C<yum> (package management)."
31053 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3030
31054 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3058
31055 #: ../src/guestfs-actions.pod:3030 ../src/guestfs-actions.pod:3058
31056 msgid "(Added in 1.7.5)"
31060 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3032
31061 #: ../src/guestfs-actions.pod:3032
31062 msgid "guestfs_inspect_get_package_management"
31066 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3034
31067 #: ../src/guestfs-actions.pod:3034
31071 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
31072 " const char *root);\n"
31077 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3038
31078 #: ../src/guestfs-actions.pod:3038
31080 "C<guestfs_inspect_get_package_format> and this function return the package "
31081 "format and package management tool used by the inspected operating system. "
31082 "For example for Fedora these functions would return C<rpm> (package format) "
31083 "and C<yum> (package management)."
31087 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3060
31088 #: ../src/guestfs-actions.pod:3060
31089 msgid "guestfs_inspect_get_product_name"
31093 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3062
31094 #: ../src/guestfs-actions.pod:3062
31098 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
31099 " const char *root);\n"
31104 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3081
31105 #: ../src/guestfs-actions.pod:3081
31106 msgid "guestfs_inspect_get_product_variant"
31110 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3083
31111 #: ../src/guestfs-actions.pod:3083
31115 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
31116 " const char *root);\n"
31121 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3106
31122 #: ../src/guestfs-actions.pod:3106
31124 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
31125 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
31129 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3113
31130 #: ../src/guestfs-actions.pod:3113
31131 msgid "(Added in 1.9.13)"
31135 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3115
31136 #: ../src/guestfs-actions.pod:3115
31137 msgid "guestfs_inspect_get_roots"
31141 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3117
31142 #: ../src/guestfs-actions.pod:3117
31146 " guestfs_inspect_get_roots (guestfs_h *g);\n"
31151 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3120
31152 #: ../src/guestfs-actions.pod:3120
31154 "This function is a convenient way to get the list of root devices, as "
31155 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
31156 "the whole inspection process."
31160 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3124
31161 #: ../src/guestfs-actions.pod:3124
31163 "This returns an empty list if either no root devices were found or the "
31164 "caller has not called C<guestfs_inspect_os>."
31168 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3133
31169 #: ../src/guestfs-actions.pod:3133
31170 msgid "(Added in 1.7.3)"
31174 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3135
31175 #: ../src/guestfs-actions.pod:3135
31176 msgid "guestfs_inspect_get_type"
31180 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3137
31181 #: ../src/guestfs-actions.pod:3137
31185 " guestfs_inspect_get_type (guestfs_h *g,\n"
31186 " const char *root);\n"
31191 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3174
31192 #: ../src/guestfs-actions.pod:3174
31193 msgid "guestfs_inspect_get_windows_current_control_set"
31197 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3176
31198 #: ../src/guestfs-actions.pod:3176
31202 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
31203 " const char *root);\n"
31208 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3194
31209 #: ../src/guestfs-actions.pod:3194
31210 msgid "guestfs_inspect_get_windows_systemroot"
31214 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3196
31215 #: ../src/guestfs-actions.pod:3196
31219 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
31220 " const char *root);\n"
31225 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3212
31226 #: ../src/guestfs-actions.pod:3212
31227 msgid "(Added in 1.5.25)"
31231 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3214
31232 #: ../src/guestfs-actions.pod:3214
31233 msgid "guestfs_inspect_is_live"
31237 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3216
31238 #: ../src/guestfs-actions.pod:3216
31242 " guestfs_inspect_is_live (guestfs_h *g,\n"
31243 " const char *root);\n"
31248 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3220
31249 #: ../src/guestfs-actions.pod:3220
31251 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
31252 "disk), then this returns true if a live image was detected on the disk."
31256 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3230
31257 #: ../src/guestfs-actions.pod:3230
31258 msgid "guestfs_inspect_is_multipart"
31262 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3232
31263 #: ../src/guestfs-actions.pod:3232
31267 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
31268 " const char *root);\n"
31273 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3236
31274 #: ../src/guestfs-actions.pod:3236
31276 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
31277 "disk), then this returns true if the disk is part of a set."
31281 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3246
31282 #: ../src/guestfs-actions.pod:3246
31283 msgid "guestfs_inspect_is_netinst"
31287 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3248
31288 #: ../src/guestfs-actions.pod:3248
31292 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
31293 " const char *root);\n"
31298 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3252
31299 #: ../src/guestfs-actions.pod:3252
31301 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
31302 "disk), then this returns true if the disk is a network installer, ie. not a "
31303 "self-contained install CD but one which is likely to require network access "
31304 "to complete the install."
31308 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3264
31309 #: ../src/guestfs-actions.pod:3264
31310 msgid "guestfs_inspect_list_applications"
31314 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3266
31315 #: ../src/guestfs-actions.pod:3266
31318 " struct guestfs_application_list *\n"
31319 " guestfs_inspect_list_applications (guestfs_h *g,\n"
31320 " const char *root);\n"
31325 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3272
31326 #: ../src/guestfs-actions.pod:3272
31328 "I<Note:> This call works differently from other parts of the inspection "
31329 "API. You have to call C<guestfs_inspect_os>, then "
31330 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
31331 "this. Listing applications is a significantly more difficult operation "
31332 "which requires access to the full filesystem. Also note that unlike the "
31333 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
31334 "the libguestfs handle, this call actually reads parts of the mounted "
31335 "filesystems during the call."
31339 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3362
31340 #: ../src/guestfs-actions.pod:3362
31342 "This function returns a C<struct guestfs_application_list *>, or NULL if "
31343 "there was an error. I<The caller must call C<guestfs_free_application_list> "
31348 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3366
31349 #: ../src/guestfs-actions.pod:3366
31350 msgid "(Added in 1.7.8)"
31354 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3368
31355 #: ../src/guestfs-actions.pod:3368
31356 msgid "guestfs_inspect_os"
31360 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3370
31361 #: ../src/guestfs-actions.pod:3370
31365 " guestfs_inspect_os (guestfs_h *g);\n"
31370 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3386
31371 #: ../src/guestfs-actions.pod:3386
31373 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
31374 "functions in order to query further information about each operating system, "
31375 "such as the name and version."
31379 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3391
31380 #: ../src/guestfs-actions.pod:3391
31382 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
31383 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
31384 "the contents. This should be called with no disks currently mounted. The "
31385 "function may also use Augeas, so any existing Augeas handle will be closed."
31389 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3403
31390 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3734
31391 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3816
31392 #: ../src/guestfs-actions.pod:3403 ../src/guestfs-actions.pod:3734
31393 #: ../src/guestfs-actions.pod:3816
31394 msgid "See also C<guestfs_list_filesystems>."
31398 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3411
31399 #: ../src/guestfs-actions.pod:3411
31400 msgid "guestfs_is_blockdev"
31404 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3413
31405 #: ../src/guestfs-actions.pod:3413
31409 " guestfs_is_blockdev (guestfs_h *g,\n"
31410 " const char *path);\n"
31415 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3420
31416 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3449
31417 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3479
31418 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3494
31419 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3510
31420 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3566
31421 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3581
31422 #: ../src/guestfs-actions.pod:3420 ../src/guestfs-actions.pod:3449
31423 #: ../src/guestfs-actions.pod:3479 ../src/guestfs-actions.pod:3494
31424 #: ../src/guestfs-actions.pod:3510 ../src/guestfs-actions.pod:3566
31425 #: ../src/guestfs-actions.pod:3581
31426 msgid "See also C<guestfs_stat>."
31430 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3424
31431 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3453
31432 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3498
31433 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3570
31434 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3585
31435 #: ../src/guestfs-actions.pod:3424 ../src/guestfs-actions.pod:3453
31436 #: ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3570
31437 #: ../src/guestfs-actions.pod:3585
31438 msgid "(Added in 1.5.10)"
31442 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3426
31443 #: ../src/guestfs-actions.pod:3426
31444 msgid "guestfs_is_busy"
31448 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3428
31449 #: ../src/guestfs-actions.pod:3428
31453 " guestfs_is_busy (guestfs_h *g);\n"
31458 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3440
31459 #: ../src/guestfs-actions.pod:3440
31460 msgid "guestfs_is_chardev"
31464 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3442
31465 #: ../src/guestfs-actions.pod:3442
31469 " guestfs_is_chardev (guestfs_h *g,\n"
31470 " const char *path);\n"
31475 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3455
31476 #: ../src/guestfs-actions.pod:3455
31477 msgid "guestfs_is_config"
31481 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3457
31482 #: ../src/guestfs-actions.pod:3457
31486 " guestfs_is_config (guestfs_h *g);\n"
31491 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3469
31492 #: ../src/guestfs-actions.pod:3469
31493 msgid "guestfs_is_dir"
31497 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3471
31498 #: ../src/guestfs-actions.pod:3471
31502 " guestfs_is_dir (guestfs_h *g,\n"
31503 " const char *path);\n"
31508 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3485
31509 #: ../src/guestfs-actions.pod:3485
31510 msgid "guestfs_is_fifo"
31514 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3487
31515 #: ../src/guestfs-actions.pod:3487
31519 " guestfs_is_fifo (guestfs_h *g,\n"
31520 " const char *path);\n"
31525 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3500
31526 #: ../src/guestfs-actions.pod:3500
31527 msgid "guestfs_is_file"
31531 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3502
31532 #: ../src/guestfs-actions.pod:3502
31536 " guestfs_is_file (guestfs_h *g,\n"
31537 " const char *path);\n"
31542 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3516
31543 #: ../src/guestfs-actions.pod:3516
31544 msgid "guestfs_is_launching"
31548 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3518
31549 #: ../src/guestfs-actions.pod:3518
31553 " guestfs_is_launching (guestfs_h *g);\n"
31558 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3530
31559 #: ../src/guestfs-actions.pod:3530
31560 msgid "guestfs_is_lv"
31564 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3532
31565 #: ../src/guestfs-actions.pod:3532
31569 " guestfs_is_lv (guestfs_h *g,\n"
31570 " const char *device);\n"
31575 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3543
31576 #: ../src/guestfs-actions.pod:3543
31577 msgid "guestfs_is_ready"
31581 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3545
31582 #: ../src/guestfs-actions.pod:3545
31586 " guestfs_is_ready (guestfs_h *g);\n"
31591 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3557
31592 #: ../src/guestfs-actions.pod:3557
31593 msgid "guestfs_is_socket"
31597 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3559
31598 #: ../src/guestfs-actions.pod:3559
31602 " guestfs_is_socket (guestfs_h *g,\n"
31603 " const char *path);\n"
31608 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3572
31609 #: ../src/guestfs-actions.pod:3572
31610 msgid "guestfs_is_symlink"
31614 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3574
31615 #: ../src/guestfs-actions.pod:3574
31619 " guestfs_is_symlink (guestfs_h *g,\n"
31620 " const char *path);\n"
31625 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3587
31626 #: ../src/guestfs-actions.pod:3587
31627 msgid "guestfs_is_zero"
31631 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3589
31632 #: ../src/guestfs-actions.pod:3589
31636 " guestfs_is_zero (guestfs_h *g,\n"
31637 " const char *path);\n"
31642 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3598
31643 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3612
31644 #: ../src/guestfs-actions.pod:3598 ../src/guestfs-actions.pod:3612
31645 msgid "(Added in 1.11.8)"
31649 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3600
31650 #: ../src/guestfs-actions.pod:3600
31651 msgid "guestfs_is_zero_device"
31655 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3602
31656 #: ../src/guestfs-actions.pod:3602
31660 " guestfs_is_zero_device (guestfs_h *g,\n"
31661 " const char *device);\n"
31666 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3614
31667 #: ../src/guestfs-actions.pod:3614
31668 msgid "guestfs_kill_subprocess"
31672 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3616
31673 #: ../src/guestfs-actions.pod:3616
31677 " guestfs_kill_subprocess (guestfs_h *g);\n"
31682 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3625
31683 #: ../src/guestfs-actions.pod:3625
31684 msgid "guestfs_launch"
31688 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3627
31689 #: ../src/guestfs-actions.pod:3627
31693 " guestfs_launch (guestfs_h *g);\n"
31698 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3645
31699 #: ../src/guestfs-actions.pod:3645
31700 msgid "guestfs_lchown"
31704 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3647
31705 #: ../src/guestfs-actions.pod:3647
31709 " guestfs_lchown (guestfs_h *g,\n"
31712 " const char *path);\n"
31717 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3653
31718 #: ../src/guestfs-actions.pod:3653
31720 "Change the file owner to C<owner> and group to C<group>. This is like "
31721 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
31722 "changed, not the target."
31726 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3665
31727 #: ../src/guestfs-actions.pod:3665
31728 msgid "guestfs_lgetxattr"
31732 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3667
31733 #: ../src/guestfs-actions.pod:3667
31737 " guestfs_lgetxattr (guestfs_h *g,\n"
31738 " const char *path,\n"
31739 " const char *name,\n"
31740 " size_t *size_r);\n"
31745 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3687
31746 #: ../src/guestfs-actions.pod:3687
31747 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
31751 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3695
31752 #: ../src/guestfs-actions.pod:3695
31753 msgid "guestfs_lgetxattrs"
31757 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3697
31758 #: ../src/guestfs-actions.pod:3697
31761 " struct guestfs_xattr_list *\n"
31762 " guestfs_lgetxattrs (guestfs_h *g,\n"
31763 " const char *path);\n"
31768 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3701
31769 #: ../src/guestfs-actions.pod:3701
31771 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
31772 "then it returns the extended attributes of the link itself."
31776 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3711
31777 #: ../src/guestfs-actions.pod:3711
31778 msgid "guestfs_list_9p"
31782 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3713
31783 #: ../src/guestfs-actions.pod:3713
31787 " guestfs_list_9p (guestfs_h *g);\n"
31792 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3725
31793 #: ../src/guestfs-actions.pod:3725
31794 msgid "guestfs_list_devices"
31798 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3727
31799 #: ../src/guestfs-actions.pod:3727
31803 " guestfs_list_devices (guestfs_h *g);\n"
31808 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3742
31809 #: ../src/guestfs-actions.pod:3742
31810 msgid "guestfs_list_dm_devices"
31814 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3744
31815 #: ../src/guestfs-actions.pod:3744
31819 " guestfs_list_dm_devices (guestfs_h *g);\n"
31824 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3749
31825 #: ../src/guestfs-actions.pod:3749
31827 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
31828 "previous call to C<guestfs_luks_open>."
31832 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3752
31833 #: ../src/guestfs-actions.pod:3752
31835 "Device mapper devices which correspond to logical volumes are I<not> "
31836 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
31841 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3760
31842 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5216
31843 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:5216
31844 msgid "(Added in 1.11.15)"
31848 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3762
31849 #: ../src/guestfs-actions.pod:3762
31850 msgid "guestfs_list_filesystems"
31854 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3764
31855 #: ../src/guestfs-actions.pod:3764
31859 " guestfs_list_filesystems (guestfs_h *g);\n"
31864 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3784
31865 #: ../src/guestfs-actions.pod:3784
31867 "This command runs other libguestfs commands, which might include "
31868 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
31869 "soon after launch and only when nothing is mounted."
31873 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3788
31874 #: ../src/guestfs-actions.pod:3788
31876 "Not all of the filesystems returned will be mountable. In particular, swap "
31877 "partitions are returned in the list. Also this command does not check that "
31878 "each filesystem found is valid and mountable, and some filesystems might be "
31879 "mountable but require special options. Filesystems may not all belong to a "
31880 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
31884 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3802
31885 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5577
31886 #: ../src/guestfs-actions.pod:3802 ../src/guestfs-actions.pod:5577
31887 msgid "(Added in 1.5.15)"
31891 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3804
31892 #: ../src/guestfs-actions.pod:3804
31893 msgid "guestfs_list_partitions"
31897 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3806
31898 #: ../src/guestfs-actions.pod:3806
31902 " guestfs_list_partitions (guestfs_h *g);\n"
31907 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3813
31908 #: ../src/guestfs-actions.pod:3813
31910 "This does not return logical volumes. For that you will need to call "
31915 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3824
31916 #: ../src/guestfs-actions.pod:3824
31921 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3826
31922 #: ../src/guestfs-actions.pod:3826
31926 " guestfs_ll (guestfs_h *g,\n"
31927 " const char *directory);\n"
31932 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3841
31933 #: ../src/guestfs-actions.pod:3841
31938 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3843
31939 #: ../src/guestfs-actions.pod:3843
31943 " guestfs_ln (guestfs_h *g,\n"
31944 " const char *target,\n"
31945 " const char *linkname);\n"
31950 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3854
31951 #: ../src/guestfs-actions.pod:3854
31952 msgid "guestfs_ln_f"
31956 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3856
31957 #: ../src/guestfs-actions.pod:3856
31961 " guestfs_ln_f (guestfs_h *g,\n"
31962 " const char *target,\n"
31963 " const char *linkname);\n"
31968 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3868
31969 #: ../src/guestfs-actions.pod:3868
31970 msgid "guestfs_ln_s"
31974 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3870
31975 #: ../src/guestfs-actions.pod:3870
31979 " guestfs_ln_s (guestfs_h *g,\n"
31980 " const char *target,\n"
31981 " const char *linkname);\n"
31986 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3881
31987 #: ../src/guestfs-actions.pod:3881
31988 msgid "guestfs_ln_sf"
31992 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3883
31993 #: ../src/guestfs-actions.pod:3883
31997 " guestfs_ln_sf (guestfs_h *g,\n"
31998 " const char *target,\n"
31999 " const char *linkname);\n"
32004 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3895
32005 #: ../src/guestfs-actions.pod:3895
32006 msgid "guestfs_lremovexattr"
32010 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3897
32011 #: ../src/guestfs-actions.pod:3897
32015 " guestfs_lremovexattr (guestfs_h *g,\n"
32016 " const char *xattr,\n"
32017 " const char *path);\n"
32022 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3902
32023 #: ../src/guestfs-actions.pod:3902
32025 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
32026 "link, then it removes an extended attribute of the link itself."
32030 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3910
32031 #: ../src/guestfs-actions.pod:3910
32036 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3912
32037 #: ../src/guestfs-actions.pod:3912
32041 " guestfs_ls (guestfs_h *g,\n"
32042 " const char *directory);\n"
32047 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3920
32048 #: ../src/guestfs-actions.pod:3920
32050 "This command is mostly useful for interactive sessions. Programs should "
32051 "probably use C<guestfs_readdir> instead."
32055 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3929
32056 #: ../src/guestfs-actions.pod:3929
32057 msgid "guestfs_lsetxattr"
32061 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3931
32062 #: ../src/guestfs-actions.pod:3931
32066 " guestfs_lsetxattr (guestfs_h *g,\n"
32067 " const char *xattr,\n"
32068 " const char *val,\n"
32070 " const char *path);\n"
32075 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3938
32076 #: ../src/guestfs-actions.pod:3938
32078 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
32079 "then it sets an extended attribute of the link itself."
32083 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3946
32084 #: ../src/guestfs-actions.pod:3946
32085 msgid "guestfs_lstat"
32089 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3948
32090 #: ../src/guestfs-actions.pod:3948
32093 " struct guestfs_stat *\n"
32094 " guestfs_lstat (guestfs_h *g,\n"
32095 " const char *path);\n"
32100 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3954
32101 #: ../src/guestfs-actions.pod:3954
32103 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
32104 "link, then the link is stat-ed, not the file it refers to."
32108 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3960
32109 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6735
32110 #: ../src/guestfs-actions.pod:3960 ../src/guestfs-actions.pod:6735
32112 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
32113 "error. I<The caller must call C<guestfs_free_stat> after use>."
32117 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3964
32118 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6739
32119 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6757
32120 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7138
32121 #: ../src/guestfs-actions.pod:3964 ../src/guestfs-actions.pod:6739
32122 #: ../src/guestfs-actions.pod:6757 ../src/guestfs-actions.pod:7138
32123 msgid "(Added in 0.9.2)"
32127 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3966
32128 #: ../src/guestfs-actions.pod:3966
32129 msgid "guestfs_lstatlist"
32133 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3968
32134 #: ../src/guestfs-actions.pod:3968
32137 " struct guestfs_stat_list *\n"
32138 " guestfs_lstatlist (guestfs_h *g,\n"
32139 " const char *path,\n"
32140 " char *const *names);\n"
32145 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3973
32146 #: ../src/guestfs-actions.pod:3973
32148 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
32149 "files, where all files are in the directory C<path>. C<names> is the list "
32150 "of files from this directory."
32154 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3982
32155 #: ../src/guestfs-actions.pod:3982
32157 "This call is intended for programs that want to efficiently list a directory "
32158 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
32159 "for a similarly efficient call for getting extended attributes. Very long "
32160 "directory listings might cause the protocol message size to be exceeded, "
32161 "causing this call to fail. The caller must split up such requests into "
32162 "smaller groups of names."
32166 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3990
32167 #: ../src/guestfs-actions.pod:3990
32169 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
32170 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
32174 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3996
32175 #: ../src/guestfs-actions.pod:3996
32176 msgid "guestfs_luks_add_key"
32180 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:3998
32181 #: ../src/guestfs-actions.pod:3998
32185 " guestfs_luks_add_key (guestfs_h *g,\n"
32186 " const char *device,\n"
32187 " const char *key,\n"
32188 " const char *newkey,\n"
32194 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4010
32195 #: ../src/guestfs-actions.pod:4010
32197 "Note that if C<keyslot> already contains a key, then this command will "
32198 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
32202 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4016
32203 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4056
32204 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4079
32205 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4099
32206 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4134
32207 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4153
32208 #: ../src/guestfs-actions.pod:4016 ../src/guestfs-actions.pod:4056
32209 #: ../src/guestfs-actions.pod:4079 ../src/guestfs-actions.pod:4099
32210 #: ../src/guestfs-actions.pod:4134 ../src/guestfs-actions.pod:4153
32212 "This function takes a key or passphrase parameter which could contain "
32213 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
32218 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4020
32219 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4060
32220 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4083
32221 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4103
32222 #: ../src/guestfs-actions.pod:4020 ../src/guestfs-actions.pod:4060
32223 #: ../src/guestfs-actions.pod:4083 ../src/guestfs-actions.pod:4103
32224 msgid "(Added in 1.5.2)"
32228 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4022
32229 #: ../src/guestfs-actions.pod:4022
32230 msgid "guestfs_luks_close"
32234 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4024
32235 #: ../src/guestfs-actions.pod:4024
32239 " guestfs_luks_close (guestfs_h *g,\n"
32240 " const char *device);\n"
32245 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4028
32246 #: ../src/guestfs-actions.pod:4028
32248 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
32249 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
32250 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
32251 "underlying block device."
32255 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4036
32256 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4138
32257 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4157
32258 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4207
32259 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4255
32260 #: ../src/guestfs-actions.pod:4036 ../src/guestfs-actions.pod:4138
32261 #: ../src/guestfs-actions.pod:4157 ../src/guestfs-actions.pod:4207
32262 #: ../src/guestfs-actions.pod:4255
32263 msgid "(Added in 1.5.1)"
32267 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4038
32268 #: ../src/guestfs-actions.pod:4038
32269 msgid "guestfs_luks_format"
32273 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4040
32274 #: ../src/guestfs-actions.pod:4040
32278 " guestfs_luks_format (guestfs_h *g,\n"
32279 " const char *device,\n"
32280 " const char *key,\n"
32286 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4062
32287 #: ../src/guestfs-actions.pod:4062
32288 msgid "guestfs_luks_format_cipher"
32292 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4064
32293 #: ../src/guestfs-actions.pod:4064
32297 " guestfs_luks_format_cipher (guestfs_h *g,\n"
32298 " const char *device,\n"
32299 " const char *key,\n"
32301 " const char *cipher);\n"
32306 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4071
32307 #: ../src/guestfs-actions.pod:4071
32309 "This command is the same as C<guestfs_luks_format> but it also allows you to "
32310 "set the C<cipher> used."
32314 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4085
32315 #: ../src/guestfs-actions.pod:4085
32316 msgid "guestfs_luks_kill_slot"
32320 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4087
32321 #: ../src/guestfs-actions.pod:4087
32325 " guestfs_luks_kill_slot (guestfs_h *g,\n"
32326 " const char *device,\n"
32327 " const char *key,\n"
32333 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4105
32334 #: ../src/guestfs-actions.pod:4105
32335 msgid "guestfs_luks_open"
32339 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4107
32340 #: ../src/guestfs-actions.pod:4107
32344 " guestfs_luks_open (guestfs_h *g,\n"
32345 " const char *device,\n"
32346 " const char *key,\n"
32347 " const char *mapname);\n"
32352 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4125
32353 #: ../src/guestfs-actions.pod:4125
32355 "If this block device contains LVM volume groups, then calling "
32356 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
32361 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4129
32362 #: ../src/guestfs-actions.pod:4129
32363 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
32367 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4140
32368 #: ../src/guestfs-actions.pod:4140
32369 msgid "guestfs_luks_open_ro"
32373 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4142
32374 #: ../src/guestfs-actions.pod:4142
32378 " guestfs_luks_open_ro (guestfs_h *g,\n"
32379 " const char *device,\n"
32380 " const char *key,\n"
32381 " const char *mapname);\n"
32386 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4148
32387 #: ../src/guestfs-actions.pod:4148
32389 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
32394 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4159
32395 #: ../src/guestfs-actions.pod:4159
32396 msgid "guestfs_lvcreate"
32400 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4161
32401 #: ../src/guestfs-actions.pod:4161
32405 " guestfs_lvcreate (guestfs_h *g,\n"
32406 " const char *logvol,\n"
32407 " const char *volgroup,\n"
32413 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4174
32414 #: ../src/guestfs-actions.pod:4174
32415 msgid "guestfs_lvm_canonical_lv_name"
32419 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4176
32420 #: ../src/guestfs-actions.pod:4176
32424 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
32425 " const char *lvname);\n"
32430 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4187
32431 #: ../src/guestfs-actions.pod:4187
32432 msgid "See also C<guestfs_is_lv>."
32436 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4192
32437 #: ../src/guestfs-actions.pod:4192
32438 msgid "(Added in 1.5.24)"
32442 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4194
32443 #: ../src/guestfs-actions.pod:4194
32444 msgid "guestfs_lvm_clear_filter"
32448 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4196
32449 #: ../src/guestfs-actions.pod:4196
32453 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
32458 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4199
32459 #: ../src/guestfs-actions.pod:4199
32461 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
32462 "see every block device."
32466 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4209
32467 #: ../src/guestfs-actions.pod:4209
32468 msgid "guestfs_lvm_remove_all"
32472 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4211
32473 #: ../src/guestfs-actions.pod:4211
32477 " guestfs_lvm_remove_all (guestfs_h *g);\n"
32482 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4224
32483 #: ../src/guestfs-actions.pod:4224
32484 msgid "guestfs_lvm_set_filter"
32488 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4226
32489 #: ../src/guestfs-actions.pod:4226
32493 " guestfs_lvm_set_filter (guestfs_h *g,\n"
32494 " char *const *devices);\n"
32499 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4257
32500 #: ../src/guestfs-actions.pod:4257
32501 msgid "guestfs_lvremove"
32505 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4259
32506 #: ../src/guestfs-actions.pod:4259
32510 " guestfs_lvremove (guestfs_h *g,\n"
32511 " const char *device);\n"
32516 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4271
32517 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5674
32518 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7508
32519 #: ../src/guestfs-actions.pod:4271 ../src/guestfs-actions.pod:5674
32520 #: ../src/guestfs-actions.pod:7508
32521 msgid "(Added in 1.0.13)"
32525 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4273
32526 #: ../src/guestfs-actions.pod:4273
32527 msgid "guestfs_lvrename"
32531 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4275
32532 #: ../src/guestfs-actions.pod:4275
32536 " guestfs_lvrename (guestfs_h *g,\n"
32537 " const char *logvol,\n"
32538 " const char *newlogvol);\n"
32543 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4284
32544 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7521
32545 #: ../src/guestfs-actions.pod:4284 ../src/guestfs-actions.pod:7521
32546 msgid "(Added in 1.0.83)"
32550 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4286
32551 #: ../src/guestfs-actions.pod:4286
32552 msgid "guestfs_lvresize"
32556 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4288
32557 #: ../src/guestfs-actions.pod:4288
32561 " guestfs_lvresize (guestfs_h *g,\n"
32562 " const char *device,\n"
32568 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4301
32569 #: ../src/guestfs-actions.pod:4301
32570 msgid "guestfs_lvresize_free"
32574 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4303
32575 #: ../src/guestfs-actions.pod:4303
32579 " guestfs_lvresize_free (guestfs_h *g,\n"
32580 " const char *lv,\n"
32586 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4316
32587 #: ../src/guestfs-actions.pod:4316
32588 msgid "(Added in 1.3.3)"
32592 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4318
32593 #: ../src/guestfs-actions.pod:4318
32594 msgid "guestfs_lvs"
32598 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4320
32599 #: ../src/guestfs-actions.pod:4320
32603 " guestfs_lvs (guestfs_h *g);\n"
32608 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4329
32609 #: ../src/guestfs-actions.pod:4329
32610 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
32614 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4337
32615 #: ../src/guestfs-actions.pod:4337
32616 msgid "guestfs_lvs_full"
32620 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4339
32621 #: ../src/guestfs-actions.pod:4339
32624 " struct guestfs_lvm_lv_list *\n"
32625 " guestfs_lvs_full (guestfs_h *g);\n"
32630 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4345
32631 #: ../src/guestfs-actions.pod:4345
32633 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
32634 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
32638 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4351
32639 #: ../src/guestfs-actions.pod:4351
32640 msgid "guestfs_lvuuid"
32644 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4353
32645 #: ../src/guestfs-actions.pod:4353
32649 " guestfs_lvuuid (guestfs_h *g,\n"
32650 " const char *device);\n"
32655 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4364
32656 #: ../src/guestfs-actions.pod:4364
32657 msgid "guestfs_lxattrlist"
32661 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4366
32662 #: ../src/guestfs-actions.pod:4366
32665 " struct guestfs_xattr_list *\n"
32666 " guestfs_lxattrlist (guestfs_h *g,\n"
32667 " const char *path,\n"
32668 " char *const *names);\n"
32673 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4385
32674 #: ../src/guestfs-actions.pod:4385
32676 "This call is intended for programs that want to efficiently list a directory "
32677 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
32678 "a similarly efficient call for getting standard stats. Very long directory "
32679 "listings might cause the protocol message size to be exceeded, causing this "
32680 "call to fail. The caller must split up such requests into smaller groups of "
32685 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4399
32686 #: ../src/guestfs-actions.pod:4399
32687 msgid "guestfs_mkdir"
32691 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4401
32692 #: ../src/guestfs-actions.pod:4401
32696 " guestfs_mkdir (guestfs_h *g,\n"
32697 " const char *path);\n"
32702 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4411
32703 #: ../src/guestfs-actions.pod:4411
32704 msgid "guestfs_mkdir_mode"
32708 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4413
32709 #: ../src/guestfs-actions.pod:4413
32713 " guestfs_mkdir_mode (guestfs_h *g,\n"
32714 " const char *path,\n"
32720 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4425
32721 #: ../src/guestfs-actions.pod:4425
32722 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
32726 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4431
32727 #: ../src/guestfs-actions.pod:4431
32728 msgid "guestfs_mkdir_p"
32732 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4433
32733 #: ../src/guestfs-actions.pod:4433
32737 " guestfs_mkdir_p (guestfs_h *g,\n"
32738 " const char *path);\n"
32743 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4444
32744 #: ../src/guestfs-actions.pod:4444
32745 msgid "guestfs_mkdtemp"
32749 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4446
32750 #: ../src/guestfs-actions.pod:4446
32754 " guestfs_mkdtemp (guestfs_h *g,\n"
32755 " const char *template);\n"
32760 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4474
32761 #: ../src/guestfs-actions.pod:4474
32762 msgid "guestfs_mke2fs_J"
32766 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4476
32767 #: ../src/guestfs-actions.pod:4476
32771 " guestfs_mke2fs_J (guestfs_h *g,\n"
32772 " const char *fstype,\n"
32773 " int blocksize,\n"
32774 " const char *device,\n"
32775 " const char *journal);\n"
32780 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4489
32781 #: ../src/guestfs-actions.pod:4489
32782 msgid "See also C<guestfs_mke2journal>."
32786 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4493
32787 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4511
32788 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4529
32789 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4545
32790 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4559
32791 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4573
32792 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4632
32793 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4909
32794 #: ../src/guestfs-actions.pod:4493 ../src/guestfs-actions.pod:4511
32795 #: ../src/guestfs-actions.pod:4529 ../src/guestfs-actions.pod:4545
32796 #: ../src/guestfs-actions.pod:4559 ../src/guestfs-actions.pod:4573
32797 #: ../src/guestfs-actions.pod:4632 ../src/guestfs-actions.pod:4909
32798 msgid "(Added in 1.0.68)"
32802 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4495
32803 #: ../src/guestfs-actions.pod:4495
32804 msgid "guestfs_mke2fs_JL"
32808 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4497
32809 #: ../src/guestfs-actions.pod:4497
32813 " guestfs_mke2fs_JL (guestfs_h *g,\n"
32814 " const char *fstype,\n"
32815 " int blocksize,\n"
32816 " const char *device,\n"
32817 " const char *label);\n"
32822 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4507
32823 #: ../src/guestfs-actions.pod:4507
32824 msgid "See also C<guestfs_mke2journal_L>."
32828 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4513
32829 #: ../src/guestfs-actions.pod:4513
32830 msgid "guestfs_mke2fs_JU"
32834 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4515
32835 #: ../src/guestfs-actions.pod:4515
32839 " guestfs_mke2fs_JU (guestfs_h *g,\n"
32840 " const char *fstype,\n"
32841 " int blocksize,\n"
32842 " const char *device,\n"
32843 " const char *uuid);\n"
32848 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4525
32849 #: ../src/guestfs-actions.pod:4525
32850 msgid "See also C<guestfs_mke2journal_U>."
32854 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4531
32855 #: ../src/guestfs-actions.pod:4531
32856 msgid "guestfs_mke2journal"
32860 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4533
32861 #: ../src/guestfs-actions.pod:4533
32865 " guestfs_mke2journal (guestfs_h *g,\n"
32866 " int blocksize,\n"
32867 " const char *device);\n"
32872 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4547
32873 #: ../src/guestfs-actions.pod:4547
32874 msgid "guestfs_mke2journal_L"
32878 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4549
32879 #: ../src/guestfs-actions.pod:4549
32883 " guestfs_mke2journal_L (guestfs_h *g,\n"
32884 " int blocksize,\n"
32885 " const char *label,\n"
32886 " const char *device);\n"
32891 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4561
32892 #: ../src/guestfs-actions.pod:4561
32893 msgid "guestfs_mke2journal_U"
32897 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4563
32898 #: ../src/guestfs-actions.pod:4563
32902 " guestfs_mke2journal_U (guestfs_h *g,\n"
32903 " int blocksize,\n"
32904 " const char *uuid,\n"
32905 " const char *device);\n"
32910 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4575
32911 #: ../src/guestfs-actions.pod:4575
32912 msgid "guestfs_mkfifo"
32916 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4577
32917 #: ../src/guestfs-actions.pod:4577
32921 " guestfs_mkfifo (guestfs_h *g,\n"
32923 " const char *path);\n"
32928 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4582
32929 #: ../src/guestfs-actions.pod:4582
32931 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
32932 "is just a convenient wrapper around C<guestfs_mknod>."
32936 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4592
32937 #: ../src/guestfs-actions.pod:4592
32938 msgid "guestfs_mkfs"
32942 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4594
32943 #: ../src/guestfs-actions.pod:4594
32947 " guestfs_mkfs (guestfs_h *g,\n"
32948 " const char *fstype,\n"
32949 " const char *device);\n"
32954 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4607
32955 #: ../src/guestfs-actions.pod:4607
32956 msgid "guestfs_mkfs_b"
32960 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4609
32961 #: ../src/guestfs-actions.pod:4609
32965 " guestfs_mkfs_b (guestfs_h *g,\n"
32966 " const char *fstype,\n"
32967 " int blocksize,\n"
32968 " const char *device);\n"
32973 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4615
32974 #: ../src/guestfs-actions.pod:4615
32976 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
32977 "block size of the resulting filesystem. Supported block sizes depend on the "
32978 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
32982 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4634
32983 #: ../src/guestfs-actions.pod:4634
32984 msgid "guestfs_mkfs_opts"
32988 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4636
32989 #: ../src/guestfs-actions.pod:4636
32993 " guestfs_mkfs_opts (guestfs_h *g,\n"
32994 " const char *fstype,\n"
32995 " const char *device,\n"
33001 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4647
33002 #: ../src/guestfs-actions.pod:4647
33005 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
33006 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
33007 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
33008 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
33013 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4695
33014 #: ../src/guestfs-actions.pod:4695
33015 msgid "(Added in 1.7.19)"
33019 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4697
33020 #: ../src/guestfs-actions.pod:4697
33021 msgid "guestfs_mkfs_opts_va"
33025 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4699
33026 #: ../src/guestfs-actions.pod:4699
33030 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
33031 " const char *fstype,\n"
33032 " const char *device,\n"
33033 " va_list args);\n"
33038 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4705
33039 #: ../src/guestfs-actions.pod:4705
33040 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
33044 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4709
33045 #: ../src/guestfs-actions.pod:4709
33046 msgid "guestfs_mkfs_opts_argv"
33050 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4711
33051 #: ../src/guestfs-actions.pod:4711
33055 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
33056 " const char *fstype,\n"
33057 " const char *device,\n"
33058 " const struct guestfs_mkfs_opts_argv *optargs);\n"
33063 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4717
33064 #: ../src/guestfs-actions.pod:4717
33065 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
33069 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4721
33070 #: ../src/guestfs-actions.pod:4721
33071 msgid "guestfs_mkmountpoint"
33075 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4723
33076 #: ../src/guestfs-actions.pod:4723
33080 " guestfs_mkmountpoint (guestfs_h *g,\n"
33081 " const char *exemptpath);\n"
33086 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4727
33087 #: ../src/guestfs-actions.pod:4727
33089 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
33090 "that can be used to create extra mountpoints before mounting the first "
33095 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4751
33096 #: ../src/guestfs-actions.pod:4751
33098 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
33099 "may get unexpected errors if you try to mix these calls. It is safest to "
33100 "manually unmount filesystems and remove mountpoints after use."
33104 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4755
33105 #: ../src/guestfs-actions.pod:4755
33107 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
33108 "first, so for this to work for manual mountpoints, you must ensure that the "
33109 "innermost mountpoints have the longest pathnames, as in the example code "
33114 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4762
33115 #: ../src/guestfs-actions.pod:4762
33117 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
33118 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
33119 "can also trigger these issues."
33123 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4768
33124 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5084
33125 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6094
33126 #: ../src/guestfs-actions.pod:4768 ../src/guestfs-actions.pod:5084
33127 #: ../src/guestfs-actions.pod:6094
33128 msgid "(Added in 1.0.62)"
33132 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4770
33133 #: ../src/guestfs-actions.pod:4770
33134 msgid "guestfs_mknod"
33138 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4772
33139 #: ../src/guestfs-actions.pod:4772
33143 " guestfs_mknod (guestfs_h *g,\n"
33147 " const char *path);\n"
33152 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4787
33153 #: ../src/guestfs-actions.pod:4787
33155 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
33156 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
33157 "regular file). These constants are available in the standard Linux header "
33158 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
33159 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
33160 "the appropriate constant for you."
33164 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4801
33165 #: ../src/guestfs-actions.pod:4801
33166 msgid "guestfs_mknod_b"
33170 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4803
33171 #: ../src/guestfs-actions.pod:4803
33175 " guestfs_mknod_b (guestfs_h *g,\n"
33179 " const char *path);\n"
33184 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4810
33185 #: ../src/guestfs-actions.pod:4810
33187 "This call creates a block device node called C<path> with mode C<mode> and "
33188 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
33189 "wrapper around C<guestfs_mknod>."
33193 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4820
33194 #: ../src/guestfs-actions.pod:4820
33195 msgid "guestfs_mknod_c"
33199 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4822
33200 #: ../src/guestfs-actions.pod:4822
33204 " guestfs_mknod_c (guestfs_h *g,\n"
33208 " const char *path);\n"
33213 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4829
33214 #: ../src/guestfs-actions.pod:4829
33216 "This call creates a char device node called C<path> with mode C<mode> and "
33217 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
33218 "wrapper around C<guestfs_mknod>."
33222 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4839
33223 #: ../src/guestfs-actions.pod:4839
33224 msgid "guestfs_mkswap"
33228 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4841
33229 #: ../src/guestfs-actions.pod:4841
33233 " guestfs_mkswap (guestfs_h *g,\n"
33234 " const char *device);\n"
33239 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4851
33240 #: ../src/guestfs-actions.pod:4851
33241 msgid "guestfs_mkswap_L"
33245 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4853
33246 #: ../src/guestfs-actions.pod:4853
33250 " guestfs_mkswap_L (guestfs_h *g,\n"
33251 " const char *label,\n"
33252 " const char *device);\n"
33257 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4868
33258 #: ../src/guestfs-actions.pod:4868
33259 msgid "guestfs_mkswap_U"
33263 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4870
33264 #: ../src/guestfs-actions.pod:4870
33268 " guestfs_mkswap_U (guestfs_h *g,\n"
33269 " const char *uuid,\n"
33270 " const char *device);\n"
33275 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4881
33276 #: ../src/guestfs-actions.pod:4881
33277 msgid "guestfs_mkswap_file"
33281 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4883
33282 #: ../src/guestfs-actions.pod:4883
33286 " guestfs_mkswap_file (guestfs_h *g,\n"
33287 " const char *path);\n"
33292 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4889
33293 #: ../src/guestfs-actions.pod:4889
33295 "This command just writes a swap file signature to an existing file. To "
33296 "create the file itself, use something like C<guestfs_fallocate>."
33300 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4896
33301 #: ../src/guestfs-actions.pod:4896
33302 msgid "guestfs_modprobe"
33306 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4898
33307 #: ../src/guestfs-actions.pod:4898
33311 " guestfs_modprobe (guestfs_h *g,\n"
33312 " const char *modulename);\n"
33317 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4911
33318 #: ../src/guestfs-actions.pod:4911
33319 msgid "guestfs_mount"
33323 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4913
33324 #: ../src/guestfs-actions.pod:4913
33328 " guestfs_mount (guestfs_h *g,\n"
33329 " const char *device,\n"
33330 " const char *mountpoint);\n"
33335 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4932
33336 #: ../src/guestfs-actions.pod:4932
33338 "B<Important note:> When you use this call, the filesystem options C<sync> "
33339 "and C<noatime> are set implicitly. This was originally done because we "
33340 "thought it would improve reliability, but it turns out that I<-o sync> has a "
33341 "very large negative performance impact and negligible effect on "
33342 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
33343 "in any code that needs performance, and instead use C<guestfs_mount_options> "
33344 "(use an empty string for the first parameter if you don't want any options)."
33348 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4953
33349 #: ../src/guestfs-actions.pod:4953
33350 msgid "guestfs_mount_9p"
33354 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4955
33355 #: ../src/guestfs-actions.pod:4955
33359 " guestfs_mount_9p (guestfs_h *g,\n"
33360 " const char *mounttag,\n"
33361 " const char *mountpoint,\n"
33367 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4966
33368 #: ../src/guestfs-actions.pod:4966
33371 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
33376 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4979
33377 #: ../src/guestfs-actions.pod:4979
33378 msgid "guestfs_mount_9p_va"
33382 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4981
33383 #: ../src/guestfs-actions.pod:4981
33387 " guestfs_mount_9p_va (guestfs_h *g,\n"
33388 " const char *mounttag,\n"
33389 " const char *mountpoint,\n"
33390 " va_list args);\n"
33395 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4987
33396 #: ../src/guestfs-actions.pod:4987
33397 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
33401 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4991
33402 #: ../src/guestfs-actions.pod:4991
33403 msgid "guestfs_mount_9p_argv"
33407 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4993
33408 #: ../src/guestfs-actions.pod:4993
33412 " guestfs_mount_9p_argv (guestfs_h *g,\n"
33413 " const char *mounttag,\n"
33414 " const char *mountpoint,\n"
33415 " const struct guestfs_mount_9p_argv *optargs);\n"
33420 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:4999
33421 #: ../src/guestfs-actions.pod:4999
33422 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
33426 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5003
33427 #: ../src/guestfs-actions.pod:5003
33428 msgid "guestfs_mount_loop"
33432 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5005
33433 #: ../src/guestfs-actions.pod:5005
33437 " guestfs_mount_loop (guestfs_h *g,\n"
33438 " const char *file,\n"
33439 " const char *mountpoint);\n"
33444 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5018
33445 #: ../src/guestfs-actions.pod:5018
33446 msgid "guestfs_mount_options"
33450 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5020
33451 #: ../src/guestfs-actions.pod:5020
33455 " guestfs_mount_options (guestfs_h *g,\n"
33456 " const char *options,\n"
33457 " const char *device,\n"
33458 " const char *mountpoint);\n"
33463 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5026
33464 #: ../src/guestfs-actions.pod:5026
33466 "This is the same as the C<guestfs_mount> command, but it allows you to set "
33467 "the mount options as for the L<mount(8)> I<-o> flag."
33471 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5036
33472 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5050
33473 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5067
33474 #: ../src/guestfs-actions.pod:5036 ../src/guestfs-actions.pod:5050
33475 #: ../src/guestfs-actions.pod:5067
33476 msgid "(Added in 1.0.10)"
33480 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5038
33481 #: ../src/guestfs-actions.pod:5038
33482 msgid "guestfs_mount_ro"
33486 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5040
33487 #: ../src/guestfs-actions.pod:5040
33491 " guestfs_mount_ro (guestfs_h *g,\n"
33492 " const char *device,\n"
33493 " const char *mountpoint);\n"
33498 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5045
33499 #: ../src/guestfs-actions.pod:5045
33501 "This is the same as the C<guestfs_mount> command, but it mounts the "
33502 "filesystem with the read-only (I<-o ro>) flag."
33506 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5052
33507 #: ../src/guestfs-actions.pod:5052
33508 msgid "guestfs_mount_vfs"
33512 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5054
33513 #: ../src/guestfs-actions.pod:5054
33517 " guestfs_mount_vfs (guestfs_h *g,\n"
33518 " const char *options,\n"
33519 " const char *vfstype,\n"
33520 " const char *device,\n"
33521 " const char *mountpoint);\n"
33526 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5061
33527 #: ../src/guestfs-actions.pod:5061
33529 "This is the same as the C<guestfs_mount> command, but it allows you to set "
33530 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
33535 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5069
33536 #: ../src/guestfs-actions.pod:5069
33537 msgid "guestfs_mountpoints"
33541 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5071
33542 #: ../src/guestfs-actions.pod:5071
33546 " guestfs_mountpoints (guestfs_h *g);\n"
33551 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5074
33552 #: ../src/guestfs-actions.pod:5074
33554 "This call is similar to C<guestfs_mounts>. That call returns a list of "
33555 "devices. This one returns a hash table (map) of device name to directory "
33556 "where the device is mounted."
33560 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5086
33561 #: ../src/guestfs-actions.pod:5086
33562 msgid "guestfs_mounts"
33566 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5088
33567 #: ../src/guestfs-actions.pod:5088
33571 " guestfs_mounts (guestfs_h *g);\n"
33576 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5096
33577 #: ../src/guestfs-actions.pod:5096
33578 msgid "See also: C<guestfs_mountpoints>"
33582 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5104
33583 #: ../src/guestfs-actions.pod:5104
33588 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5106
33589 #: ../src/guestfs-actions.pod:5106
33593 " guestfs_mv (guestfs_h *g,\n"
33594 " const char *src,\n"
33595 " const char *dest);\n"
33600 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5118
33601 #: ../src/guestfs-actions.pod:5118
33602 msgid "guestfs_ntfs_3g_probe"
33606 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5120
33607 #: ../src/guestfs-actions.pod:5120
33611 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
33613 " const char *device);\n"
33618 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5139
33619 #: ../src/guestfs-actions.pod:5139
33620 msgid "(Added in 1.0.43)"
33624 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5141
33625 #: ../src/guestfs-actions.pod:5141
33626 msgid "guestfs_ntfsresize"
33630 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5143
33631 #: ../src/guestfs-actions.pod:5143
33635 " guestfs_ntfsresize (guestfs_h *g,\n"
33636 " const char *device);\n"
33641 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5171
33642 #: ../src/guestfs-actions.pod:5171
33643 msgid "guestfs_ntfsresize_opts"
33647 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5173
33648 #: ../src/guestfs-actions.pod:5173
33652 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
33653 " const char *device,\n"
33659 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5183
33660 #: ../src/guestfs-actions.pod:5183
33663 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
33664 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
33669 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5203
33670 #: ../src/guestfs-actions.pod:5203
33672 "After the resize operation, the filesystem is always marked as requiring a "
33673 "consistency check (for safety). You have to boot into Windows to perform "
33674 "this check and clear this condition. If you I<don't> set the C<force> "
33675 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
33676 "times on a single filesystem without booting into Windows between each "
33681 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5218
33682 #: ../src/guestfs-actions.pod:5218
33683 msgid "guestfs_ntfsresize_opts_va"
33687 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5220
33688 #: ../src/guestfs-actions.pod:5220
33692 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
33693 " const char *device,\n"
33694 " va_list args);\n"
33699 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5225
33700 #: ../src/guestfs-actions.pod:5225
33701 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
33705 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5229
33706 #: ../src/guestfs-actions.pod:5229
33707 msgid "guestfs_ntfsresize_opts_argv"
33711 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5231
33712 #: ../src/guestfs-actions.pod:5231
33716 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
33717 " const char *device,\n"
33718 " const struct guestfs_ntfsresize_opts_argv *optargs);\n"
33723 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5236
33724 #: ../src/guestfs-actions.pod:5236
33725 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
33729 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5240
33730 #: ../src/guestfs-actions.pod:5240
33731 msgid "guestfs_ntfsresize_size"
33735 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5242
33736 #: ../src/guestfs-actions.pod:5242
33740 " guestfs_ntfsresize_size (guestfs_h *g,\n"
33741 " const char *device,\n"
33742 " int64_t size);\n"
33747 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5247
33748 #: ../src/guestfs-actions.pod:5247
33750 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
33751 "to specify the new size (in bytes) explicitly."
33755 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5259
33756 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5701
33757 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5774
33758 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6042
33759 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7665
33760 #: ../src/guestfs-actions.pod:5259 ../src/guestfs-actions.pod:5701
33761 #: ../src/guestfs-actions.pod:5774 ../src/guestfs-actions.pod:6042
33762 #: ../src/guestfs-actions.pod:7665
33763 msgid "(Added in 1.3.14)"
33767 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5261
33768 #: ../src/guestfs-actions.pod:5261
33769 msgid "guestfs_part_add"
33773 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5263
33774 #: ../src/guestfs-actions.pod:5263
33778 " guestfs_part_add (guestfs_h *g,\n"
33779 " const char *device,\n"
33780 " const char *prlogex,\n"
33781 " int64_t startsect,\n"
33782 " int64_t endsect);\n"
33787 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5270
33788 #: ../src/guestfs-actions.pod:5270
33790 "This command adds a partition to C<device>. If there is no partition table "
33791 "on the device, call C<guestfs_part_init> first."
33795 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5282
33796 #: ../src/guestfs-actions.pod:5282
33798 "Creating a partition which covers the whole disk is not so easy. Use "
33799 "C<guestfs_part_disk> to do that."
33803 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5287
33804 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5325
33805 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5378
33806 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5462
33807 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5500
33808 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5519
33809 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5559
33810 #: ../src/guestfs-actions.pod:5287 ../src/guestfs-actions.pod:5325
33811 #: ../src/guestfs-actions.pod:5378 ../src/guestfs-actions.pod:5462
33812 #: ../src/guestfs-actions.pod:5500 ../src/guestfs-actions.pod:5519
33813 #: ../src/guestfs-actions.pod:5559
33814 msgid "(Added in 1.0.78)"
33818 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5289
33819 #: ../src/guestfs-actions.pod:5289
33820 msgid "guestfs_part_del"
33824 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5291
33825 #: ../src/guestfs-actions.pod:5291
33829 " guestfs_part_del (guestfs_h *g,\n"
33830 " const char *device,\n"
33836 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5306
33837 #: ../src/guestfs-actions.pod:5306
33838 msgid "guestfs_part_disk"
33842 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5308
33843 #: ../src/guestfs-actions.pod:5308
33847 " guestfs_part_disk (guestfs_h *g,\n"
33848 " const char *device,\n"
33849 " const char *parttype);\n"
33854 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5313
33855 #: ../src/guestfs-actions.pod:5313
33857 "This command is simply a combination of C<guestfs_part_init> followed by "
33858 "C<guestfs_part_add> to create a single primary partition covering the whole "
33863 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5317
33864 #: ../src/guestfs-actions.pod:5317
33866 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
33867 "possible values are described in C<guestfs_part_init>."
33871 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5327
33872 #: ../src/guestfs-actions.pod:5327
33873 msgid "guestfs_part_get_bootable"
33877 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5329
33878 #: ../src/guestfs-actions.pod:5329
33882 " guestfs_part_get_bootable (guestfs_h *g,\n"
33883 " const char *device,\n"
33889 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5337
33890 #: ../src/guestfs-actions.pod:5337
33891 msgid "See also C<guestfs_part_set_bootable>."
33895 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5343
33896 #: ../src/guestfs-actions.pod:5343
33897 msgid "guestfs_part_get_mbr_id"
33901 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5345
33902 #: ../src/guestfs-actions.pod:5345
33906 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
33907 " const char *device,\n"
33913 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5353
33914 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5535
33915 #: ../src/guestfs-actions.pod:5353 ../src/guestfs-actions.pod:5535
33917 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
33918 "undefined results for other partition table types (see "
33919 "C<guestfs_part_get_parttype>)."
33923 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5361
33924 #: ../src/guestfs-actions.pod:5361
33925 msgid "guestfs_part_get_parttype"
33929 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5363
33930 #: ../src/guestfs-actions.pod:5363
33934 " guestfs_part_get_parttype (guestfs_h *g,\n"
33935 " const char *device);\n"
33940 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5370
33941 #: ../src/guestfs-actions.pod:5370
33943 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
33944 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
33945 "possible, although unusual. See C<guestfs_part_init> for a full list."
33949 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5380
33950 #: ../src/guestfs-actions.pod:5380
33951 msgid "guestfs_part_init"
33955 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5382
33956 #: ../src/guestfs-actions.pod:5382
33960 " guestfs_part_init (guestfs_h *g,\n"
33961 " const char *device,\n"
33962 " const char *parttype);\n"
33967 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5391
33968 #: ../src/guestfs-actions.pod:5391
33970 "Initially there are no partitions. Following this, you should call "
33971 "C<guestfs_part_add> for each partition required."
33975 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5464
33976 #: ../src/guestfs-actions.pod:5464
33977 msgid "guestfs_part_list"
33981 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5466
33982 #: ../src/guestfs-actions.pod:5466
33985 " struct guestfs_partition_list *\n"
33986 " guestfs_part_list (guestfs_h *g,\n"
33987 " const char *device);\n"
33992 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5483
33993 #: ../src/guestfs-actions.pod:5483
33995 "Start of the partition I<in bytes>. To get sectors you have to divide by "
33996 "the device's sector size, see C<guestfs_blockdev_getss>."
34000 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5496
34001 #: ../src/guestfs-actions.pod:5496
34003 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
34004 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
34009 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5502
34010 #: ../src/guestfs-actions.pod:5502
34011 msgid "guestfs_part_set_bootable"
34015 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5504
34016 #: ../src/guestfs-actions.pod:5504
34020 " guestfs_part_set_bootable (guestfs_h *g,\n"
34021 " const char *device,\n"
34023 " int bootable);\n"
34028 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5521
34029 #: ../src/guestfs-actions.pod:5521
34030 msgid "guestfs_part_set_mbr_id"
34034 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5523
34035 #: ../src/guestfs-actions.pod:5523
34039 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
34040 " const char *device,\n"
34047 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5543
34048 #: ../src/guestfs-actions.pod:5543
34049 msgid "guestfs_part_set_name"
34053 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5545
34054 #: ../src/guestfs-actions.pod:5545
34058 " guestfs_part_set_name (guestfs_h *g,\n"
34059 " const char *device,\n"
34061 " const char *name);\n"
34066 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5561
34067 #: ../src/guestfs-actions.pod:5561
34068 msgid "guestfs_part_to_dev"
34072 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5563
34073 #: ../src/guestfs-actions.pod:5563
34077 " guestfs_part_to_dev (guestfs_h *g,\n"
34078 " const char *partition);\n"
34083 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5571
34084 #: ../src/guestfs-actions.pod:5571
34086 "The named partition must exist, for example as a string returned from "
34087 "C<guestfs_list_partitions>."
34091 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5579
34092 #: ../src/guestfs-actions.pod:5579
34093 msgid "guestfs_ping_daemon"
34097 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5581
34098 #: ../src/guestfs-actions.pod:5581
34102 " guestfs_ping_daemon (guestfs_h *g);\n"
34107 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5593
34108 #: ../src/guestfs-actions.pod:5593
34109 msgid "guestfs_pread"
34113 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5595
34114 #: ../src/guestfs-actions.pod:5595
34118 " guestfs_pread (guestfs_h *g,\n"
34119 " const char *path,\n"
34121 " int64_t offset,\n"
34122 " size_t *size_r);\n"
34127 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5608
34128 #: ../src/guestfs-actions.pod:5608
34129 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
34133 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5619
34134 #: ../src/guestfs-actions.pod:5619
34135 msgid "guestfs_pread_device"
34139 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5621
34140 #: ../src/guestfs-actions.pod:5621
34144 " guestfs_pread_device (guestfs_h *g,\n"
34145 " const char *device,\n"
34147 " int64_t offset,\n"
34148 " size_t *size_r);\n"
34153 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5634
34154 #: ../src/guestfs-actions.pod:5634
34155 msgid "See also C<guestfs_pread>."
34159 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5643
34160 #: ../src/guestfs-actions.pod:5643
34161 msgid "(Added in 1.5.21)"
34165 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5645
34166 #: ../src/guestfs-actions.pod:5645
34167 msgid "guestfs_pvcreate"
34171 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5647
34172 #: ../src/guestfs-actions.pod:5647
34176 " guestfs_pvcreate (guestfs_h *g,\n"
34177 " const char *device);\n"
34182 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5659
34183 #: ../src/guestfs-actions.pod:5659
34184 msgid "guestfs_pvremove"
34188 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5661
34189 #: ../src/guestfs-actions.pod:5661
34193 " guestfs_pvremove (guestfs_h *g,\n"
34194 " const char *device);\n"
34199 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5676
34200 #: ../src/guestfs-actions.pod:5676
34201 msgid "guestfs_pvresize"
34205 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5678
34206 #: ../src/guestfs-actions.pod:5678
34210 " guestfs_pvresize (guestfs_h *g,\n"
34211 " const char *device);\n"
34216 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5689
34217 #: ../src/guestfs-actions.pod:5689
34218 msgid "guestfs_pvresize_size"
34222 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5691
34223 #: ../src/guestfs-actions.pod:5691
34227 " guestfs_pvresize_size (guestfs_h *g,\n"
34228 " const char *device,\n"
34229 " int64_t size);\n"
34234 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5696
34235 #: ../src/guestfs-actions.pod:5696
34237 "This command is the same as C<guestfs_pvresize> except that it allows you to "
34238 "specify the new size (in bytes) explicitly."
34242 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5703
34243 #: ../src/guestfs-actions.pod:5703
34244 msgid "guestfs_pvs"
34248 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5705
34249 #: ../src/guestfs-actions.pod:5705
34253 " guestfs_pvs (guestfs_h *g);\n"
34258 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5714
34259 #: ../src/guestfs-actions.pod:5714
34260 msgid "See also C<guestfs_pvs_full>."
34264 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5722
34265 #: ../src/guestfs-actions.pod:5722
34266 msgid "guestfs_pvs_full"
34270 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5724
34271 #: ../src/guestfs-actions.pod:5724
34274 " struct guestfs_lvm_pv_list *\n"
34275 " guestfs_pvs_full (guestfs_h *g);\n"
34280 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5730
34281 #: ../src/guestfs-actions.pod:5730
34283 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
34284 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
34288 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5736
34289 #: ../src/guestfs-actions.pod:5736
34290 msgid "guestfs_pvuuid"
34294 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5738
34295 #: ../src/guestfs-actions.pod:5738
34299 " guestfs_pvuuid (guestfs_h *g,\n"
34300 " const char *device);\n"
34305 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5749
34306 #: ../src/guestfs-actions.pod:5749
34307 msgid "guestfs_pwrite"
34311 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5751
34312 #: ../src/guestfs-actions.pod:5751
34316 " guestfs_pwrite (guestfs_h *g,\n"
34317 " const char *path,\n"
34318 " const char *content,\n"
34319 " size_t content_size,\n"
34320 " int64_t offset);\n"
34325 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5767
34326 #: ../src/guestfs-actions.pod:5767
34327 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
34331 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5776
34332 #: ../src/guestfs-actions.pod:5776
34333 msgid "guestfs_pwrite_device"
34337 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5778
34338 #: ../src/guestfs-actions.pod:5778
34342 " guestfs_pwrite_device (guestfs_h *g,\n"
34343 " const char *device,\n"
34344 " const char *content,\n"
34345 " size_t content_size,\n"
34346 " int64_t offset);\n"
34351 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5793
34352 #: ../src/guestfs-actions.pod:5793
34353 msgid "See also C<guestfs_pwrite>."
34357 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5800
34358 #: ../src/guestfs-actions.pod:5800
34359 msgid "(Added in 1.5.20)"
34363 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5802
34364 #: ../src/guestfs-actions.pod:5802
34365 msgid "guestfs_read_file"
34369 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5804
34370 #: ../src/guestfs-actions.pod:5804
34374 " guestfs_read_file (guestfs_h *g,\n"
34375 " const char *path,\n"
34376 " size_t *size_r);\n"
34381 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5812
34382 #: ../src/guestfs-actions.pod:5812
34384 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
34385 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
34386 "function is limited in the total size of file that can be handled."
34390 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5824
34391 #: ../src/guestfs-actions.pod:5824
34392 msgid "(Added in 1.0.63)"
34396 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5826
34397 #: ../src/guestfs-actions.pod:5826
34398 msgid "guestfs_read_lines"
34402 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5828
34403 #: ../src/guestfs-actions.pod:5828
34407 " guestfs_read_lines (guestfs_h *g,\n"
34408 " const char *path);\n"
34413 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5837
34414 #: ../src/guestfs-actions.pod:5837
34416 "Note that this function cannot correctly handle binary files (specifically, "
34417 "files containing C<\\0> character which is treated as end of line). For "
34418 "those you need to use the C<guestfs_read_file> function which has a more "
34419 "complex interface."
34423 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5848
34424 #: ../src/guestfs-actions.pod:5848
34425 msgid "guestfs_readdir"
34429 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5850
34430 #: ../src/guestfs-actions.pod:5850
34433 " struct guestfs_dirent_list *\n"
34434 " guestfs_readdir (guestfs_h *g,\n"
34435 " const char *dir);\n"
34440 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5904
34441 #: ../src/guestfs-actions.pod:5904
34443 "This function is primarily intended for use by programs. To get a simple "
34444 "list of names, use C<guestfs_ls>. To get a printable directory for human "
34445 "consumption, use C<guestfs_ll>."
34449 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5908
34450 #: ../src/guestfs-actions.pod:5908
34452 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
34453 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
34457 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5914
34458 #: ../src/guestfs-actions.pod:5914
34459 msgid "guestfs_readlink"
34463 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5916
34464 #: ../src/guestfs-actions.pod:5916
34468 " guestfs_readlink (guestfs_h *g,\n"
34469 " const char *path);\n"
34474 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5927
34475 #: ../src/guestfs-actions.pod:5927
34476 msgid "guestfs_readlinklist"
34480 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5929
34481 #: ../src/guestfs-actions.pod:5929
34485 " guestfs_readlinklist (guestfs_h *g,\n"
34486 " const char *path,\n"
34487 " char *const *names);\n"
34492 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5962
34493 #: ../src/guestfs-actions.pod:5962
34494 msgid "guestfs_realpath"
34498 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5964
34499 #: ../src/guestfs-actions.pod:5964
34503 " guestfs_realpath (guestfs_h *g,\n"
34504 " const char *path);\n"
34509 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5976
34510 #: ../src/guestfs-actions.pod:5976
34511 msgid "guestfs_removexattr"
34515 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5978
34516 #: ../src/guestfs-actions.pod:5978
34520 " guestfs_removexattr (guestfs_h *g,\n"
34521 " const char *xattr,\n"
34522 " const char *path);\n"
34527 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5986
34528 #: ../src/guestfs-actions.pod:5986
34529 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
34533 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5992
34534 #: ../src/guestfs-actions.pod:5992
34535 msgid "guestfs_resize2fs"
34539 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:5994
34540 #: ../src/guestfs-actions.pod:5994
34544 " guestfs_resize2fs (guestfs_h *g,\n"
34545 " const char *device);\n"
34550 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6001
34551 #: ../src/guestfs-actions.pod:6001
34553 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
34554 "C<device> before calling this command. For unknown reasons C<resize2fs> "
34555 "sometimes gives an error about this and sometimes not. In any case, it is "
34556 "always safe to call C<guestfs_e2fsck_f> before calling this function."
34560 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6011
34561 #: ../src/guestfs-actions.pod:6011
34562 msgid "guestfs_resize2fs_M"
34566 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6013
34567 #: ../src/guestfs-actions.pod:6013
34571 " guestfs_resize2fs_M (guestfs_h *g,\n"
34572 " const char *device);\n"
34577 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6017
34578 #: ../src/guestfs-actions.pod:6017
34580 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
34581 "resized to its minimum size. This works like the I<-M> option to the "
34582 "C<resize2fs> command."
34586 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6021
34587 #: ../src/guestfs-actions.pod:6021
34589 "To get the resulting size of the filesystem you should call "
34590 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
34591 "These two numbers, multiplied together, give the resulting size of the "
34592 "minimal filesystem in bytes."
34596 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6030
34597 #: ../src/guestfs-actions.pod:6030
34598 msgid "guestfs_resize2fs_size"
34602 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6032
34603 #: ../src/guestfs-actions.pod:6032
34607 " guestfs_resize2fs_size (guestfs_h *g,\n"
34608 " const char *device,\n"
34609 " int64_t size);\n"
34614 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6037
34615 #: ../src/guestfs-actions.pod:6037
34617 "This command is the same as C<guestfs_resize2fs> except that it allows you "
34618 "to specify the new size (in bytes) explicitly."
34622 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6044
34623 #: ../src/guestfs-actions.pod:6044
34628 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6046
34629 #: ../src/guestfs-actions.pod:6046
34633 " guestfs_rm (guestfs_h *g,\n"
34634 " const char *path);\n"
34639 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6056
34640 #: ../src/guestfs-actions.pod:6056
34641 msgid "guestfs_rm_rf"
34645 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6058
34646 #: ../src/guestfs-actions.pod:6058
34650 " guestfs_rm_rf (guestfs_h *g,\n"
34651 " const char *path);\n"
34656 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6070
34657 #: ../src/guestfs-actions.pod:6070
34658 msgid "guestfs_rmdir"
34662 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6072
34663 #: ../src/guestfs-actions.pod:6072
34667 " guestfs_rmdir (guestfs_h *g,\n"
34668 " const char *path);\n"
34673 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6082
34674 #: ../src/guestfs-actions.pod:6082
34675 msgid "guestfs_rmmountpoint"
34679 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6084
34680 #: ../src/guestfs-actions.pod:6084
34684 " guestfs_rmmountpoint (guestfs_h *g,\n"
34685 " const char *exemptpath);\n"
34690 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6088
34691 #: ../src/guestfs-actions.pod:6088
34693 "This calls removes a mountpoint that was previously created with "
34694 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
34698 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6096
34699 #: ../src/guestfs-actions.pod:6096
34700 msgid "guestfs_scrub_device"
34704 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6098
34705 #: ../src/guestfs-actions.pod:6098
34709 " guestfs_scrub_device (guestfs_h *g,\n"
34710 " const char *device);\n"
34715 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6113
34716 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6131
34717 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6150
34718 #: ../src/guestfs-actions.pod:6113 ../src/guestfs-actions.pod:6131
34719 #: ../src/guestfs-actions.pod:6150
34720 msgid "(Added in 1.0.52)"
34724 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6115
34725 #: ../src/guestfs-actions.pod:6115
34726 msgid "guestfs_scrub_file"
34730 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6117
34731 #: ../src/guestfs-actions.pod:6117
34735 " guestfs_scrub_file (guestfs_h *g,\n"
34736 " const char *file);\n"
34741 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6133
34742 #: ../src/guestfs-actions.pod:6133
34743 msgid "guestfs_scrub_freespace"
34747 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6135
34748 #: ../src/guestfs-actions.pod:6135
34752 " guestfs_scrub_freespace (guestfs_h *g,\n"
34753 " const char *dir);\n"
34758 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6139
34759 #: ../src/guestfs-actions.pod:6139
34761 "This command creates the directory C<dir> and then fills it with files until "
34762 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
34763 "and deletes them. The intention is to scrub any free space on the partition "
34764 "containing C<dir>."
34768 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6152
34769 #: ../src/guestfs-actions.pod:6152
34770 msgid "guestfs_set_append"
34774 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6154
34775 #: ../src/guestfs-actions.pod:6154
34779 " guestfs_set_append (guestfs_h *g,\n"
34780 " const char *append);\n"
34785 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6171
34786 #: ../src/guestfs-actions.pod:6171
34787 msgid "guestfs_set_attach_method"
34791 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6173
34792 #: ../src/guestfs-actions.pod:6173
34796 " guestfs_set_attach_method (guestfs_h *g,\n"
34797 " const char *attachmethod);\n"
34802 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6201
34803 #: ../src/guestfs-actions.pod:6201
34804 msgid "guestfs_set_autosync"
34808 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6203
34809 #: ../src/guestfs-actions.pod:6203
34813 " guestfs_set_autosync (guestfs_h *g,\n"
34814 " int autosync);\n"
34819 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6219
34820 #: ../src/guestfs-actions.pod:6219
34821 msgid "guestfs_set_direct"
34825 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6221
34826 #: ../src/guestfs-actions.pod:6221
34830 " guestfs_set_direct (guestfs_h *g,\n"
34836 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6229
34837 #: ../src/guestfs-actions.pod:6229
34839 "One consequence of this is that log messages aren't caught by the library "
34840 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
34845 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6242
34846 #: ../src/guestfs-actions.pod:6242
34847 msgid "guestfs_set_e2label"
34851 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6244
34852 #: ../src/guestfs-actions.pod:6244
34856 " guestfs_set_e2label (guestfs_h *g,\n"
34857 " const char *device,\n"
34858 " const char *label);\n"
34863 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6253
34864 #: ../src/guestfs-actions.pod:6253
34866 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
34867 "the existing label on a filesystem."
34871 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6260
34872 #: ../src/guestfs-actions.pod:6260
34873 msgid "guestfs_set_e2uuid"
34877 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6262
34878 #: ../src/guestfs-actions.pod:6262
34882 " guestfs_set_e2uuid (guestfs_h *g,\n"
34883 " const char *device,\n"
34884 " const char *uuid);\n"
34889 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6272
34890 #: ../src/guestfs-actions.pod:6272
34892 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
34893 "the existing UUID of a filesystem."
34897 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6279
34898 #: ../src/guestfs-actions.pod:6279
34899 msgid "guestfs_set_memsize"
34903 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6281
34904 #: ../src/guestfs-actions.pod:6281
34908 " guestfs_set_memsize (guestfs_h *g,\n"
34914 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6285
34915 #: ../src/guestfs-actions.pod:6285
34917 "This sets the memory size in megabytes allocated to the qemu subprocess. "
34918 "This only has any effect if called before C<guestfs_launch>."
34922 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6300
34923 #: ../src/guestfs-actions.pod:6300
34924 msgid "guestfs_set_network"
34928 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6302
34929 #: ../src/guestfs-actions.pod:6302
34933 " guestfs_set_network (guestfs_h *g,\n"
34939 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6312
34940 #: ../src/guestfs-actions.pod:6312
34942 "You must call this before calling C<guestfs_launch>, otherwise it has no "
34947 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6319
34948 #: ../src/guestfs-actions.pod:6319
34949 msgid "guestfs_set_path"
34953 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6321
34954 #: ../src/guestfs-actions.pod:6321
34958 " guestfs_set_path (guestfs_h *g,\n"
34959 " const char *searchpath);\n"
34964 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6336
34965 #: ../src/guestfs-actions.pod:6336
34966 msgid "guestfs_set_pgroup"
34970 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6338
34971 #: ../src/guestfs-actions.pod:6338
34975 " guestfs_set_pgroup (guestfs_h *g,\n"
34981 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6355
34982 #: ../src/guestfs-actions.pod:6355
34983 msgid "guestfs_set_qemu"
34987 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6357
34988 #: ../src/guestfs-actions.pod:6357
34992 " guestfs_set_qemu (guestfs_h *g,\n"
34993 " const char *qemu);\n"
34998 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6383
34999 #: ../src/guestfs-actions.pod:6383
35000 msgid "guestfs_set_recovery_proc"
35004 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6385
35005 #: ../src/guestfs-actions.pod:6385
35009 " guestfs_set_recovery_proc (guestfs_h *g,\n"
35010 " int recoveryproc);\n"
35015 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6389
35016 #: ../src/guestfs-actions.pod:6389
35018 "If this is called with the parameter C<false> then C<guestfs_launch> does "
35019 "not create a recovery process. The purpose of the recovery process is to "
35020 "stop runaway qemu processes in the case where the main program aborts "
35025 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6394
35026 #: ../src/guestfs-actions.pod:6394
35028 "This only has any effect if called before C<guestfs_launch>, and the default "
35033 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6407
35034 #: ../src/guestfs-actions.pod:6407
35035 msgid "guestfs_set_selinux"
35039 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6409
35040 #: ../src/guestfs-actions.pod:6409
35044 " guestfs_set_selinux (guestfs_h *g,\n"
35050 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6426
35051 #: ../src/guestfs-actions.pod:6426
35052 msgid "guestfs_set_trace"
35056 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6428
35057 #: ../src/guestfs-actions.pod:6428
35061 " guestfs_set_trace (guestfs_h *g,\n"
35067 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6442
35068 #: ../src/guestfs-actions.pod:6442
35070 "Trace messages are normally sent to C<stderr>, unless you register a "
35071 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
35075 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6450
35076 #: ../src/guestfs-actions.pod:6450
35077 msgid "guestfs_set_verbose"
35081 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6452
35082 #: ../src/guestfs-actions.pod:6452
35086 " guestfs_set_verbose (guestfs_h *g,\n"
35092 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6461
35093 #: ../src/guestfs-actions.pod:6461
35095 "Verbose messages are normally sent to C<stderr>, unless you register a "
35096 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
35100 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6469
35101 #: ../src/guestfs-actions.pod:6469
35102 msgid "guestfs_setcon"
35106 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6471
35107 #: ../src/guestfs-actions.pod:6471
35111 " guestfs_setcon (guestfs_h *g,\n"
35112 " const char *context);\n"
35117 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6484
35118 #: ../src/guestfs-actions.pod:6484
35119 msgid "guestfs_setxattr"
35123 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6486
35124 #: ../src/guestfs-actions.pod:6486
35128 " guestfs_setxattr (guestfs_h *g,\n"
35129 " const char *xattr,\n"
35130 " const char *val,\n"
35132 " const char *path);\n"
35137 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6497
35138 #: ../src/guestfs-actions.pod:6497
35139 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
35143 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6503
35144 #: ../src/guestfs-actions.pod:6503
35145 msgid "guestfs_sfdisk"
35149 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6505
35150 #: ../src/guestfs-actions.pod:6505
35154 " guestfs_sfdisk (guestfs_h *g,\n"
35155 " const char *device,\n"
35159 " char *const *lines);\n"
35164 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6533
35165 #: ../src/guestfs-actions.pod:6533
35167 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
35171 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6550
35172 #: ../src/guestfs-actions.pod:6550
35173 msgid "guestfs_sfdiskM"
35177 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6552
35178 #: ../src/guestfs-actions.pod:6552
35182 " guestfs_sfdiskM (guestfs_h *g,\n"
35183 " const char *device,\n"
35184 " char *const *lines);\n"
35189 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6557
35190 #: ../src/guestfs-actions.pod:6557
35192 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
35193 "partition sizes are specified in megabytes only (rounded to the nearest "
35194 "cylinder) and you don't need to specify the cyls, heads and sectors "
35195 "parameters which were rarely if ever used anyway."
35199 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6563
35200 #: ../src/guestfs-actions.pod:6563
35202 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
35203 "C<guestfs_part_disk>"
35207 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6580
35208 #: ../src/guestfs-actions.pod:6580
35209 msgid "guestfs_sfdisk_N"
35213 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6582
35214 #: ../src/guestfs-actions.pod:6582
35218 " guestfs_sfdisk_N (guestfs_h *g,\n"
35219 " const char *device,\n"
35224 " const char *line);\n"
35229 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6594
35230 #: ../src/guestfs-actions.pod:6594
35232 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
35233 "for the cyls/heads/sectors parameters."
35237 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6597
35238 #: ../src/guestfs-actions.pod:6597
35239 msgid "See also: C<guestfs_part_add>"
35243 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6613
35244 #: ../src/guestfs-actions.pod:6613
35245 msgid "guestfs_sfdisk_disk_geometry"
35249 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6615
35250 #: ../src/guestfs-actions.pod:6615
35254 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
35255 " const char *device);\n"
35260 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6619
35261 #: ../src/guestfs-actions.pod:6619
35263 "This displays the disk geometry of C<device> read from the partition table. "
35264 "Especially in the case where the underlying block device has been resized, "
35265 "this can be different from the kernel's idea of the geometry (see "
35266 "C<guestfs_sfdisk_kernel_geometry>)."
35270 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6632
35271 #: ../src/guestfs-actions.pod:6632
35272 msgid "guestfs_sfdisk_kernel_geometry"
35276 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6634
35277 #: ../src/guestfs-actions.pod:6634
35281 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
35282 " const char *device);\n"
35287 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6648
35288 #: ../src/guestfs-actions.pod:6648
35289 msgid "guestfs_sfdisk_l"
35293 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6650
35294 #: ../src/guestfs-actions.pod:6650
35298 " guestfs_sfdisk_l (guestfs_h *g,\n"
35299 " const char *device);\n"
35304 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6658
35305 #: ../src/guestfs-actions.pod:6658
35306 msgid "See also: C<guestfs_part_list>"
35310 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6672
35311 #: ../src/guestfs-actions.pod:6672
35316 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6674
35317 #: ../src/guestfs-actions.pod:6674
35321 " guestfs_sh (guestfs_h *g,\n"
35322 " const char *command);\n"
35327 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6681
35328 #: ../src/guestfs-actions.pod:6681
35329 msgid "This is like C<guestfs_command>, but passes the command to:"
35333 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6689
35334 #: ../src/guestfs-actions.pod:6689
35335 msgid "All the provisos about C<guestfs_command> apply to this call."
35339 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6696
35340 #: ../src/guestfs-actions.pod:6696
35341 msgid "guestfs_sh_lines"
35345 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6698
35346 #: ../src/guestfs-actions.pod:6698
35350 " guestfs_sh_lines (guestfs_h *g,\n"
35351 " const char *command);\n"
35356 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6702
35357 #: ../src/guestfs-actions.pod:6702
35359 "This is the same as C<guestfs_sh>, but splits the result into a list of "
35364 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6705
35365 #: ../src/guestfs-actions.pod:6705
35366 msgid "See also: C<guestfs_command_lines>"
35370 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6713
35371 #: ../src/guestfs-actions.pod:6713
35372 msgid "guestfs_sleep"
35376 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6715
35377 #: ../src/guestfs-actions.pod:6715
35381 " guestfs_sleep (guestfs_h *g,\n"
35387 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6723
35388 #: ../src/guestfs-actions.pod:6723
35389 msgid "(Added in 1.0.41)"
35393 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6725
35394 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:109
35395 #: ../src/guestfs-actions.pod:6725 ../src/guestfs-structs.pod:109
35396 msgid "guestfs_stat"
35400 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6727
35401 #: ../src/guestfs-actions.pod:6727
35404 " struct guestfs_stat *\n"
35405 " guestfs_stat (guestfs_h *g,\n"
35406 " const char *path);\n"
35411 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6741
35412 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:135
35413 #: ../src/guestfs-actions.pod:6741 ../src/guestfs-structs.pod:135
35414 msgid "guestfs_statvfs"
35418 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6743
35419 #: ../src/guestfs-actions.pod:6743
35422 " struct guestfs_statvfs *\n"
35423 " guestfs_statvfs (guestfs_h *g,\n"
35424 " const char *path);\n"
35429 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6753
35430 #: ../src/guestfs-actions.pod:6753
35432 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
35433 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
35437 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6759
35438 #: ../src/guestfs-actions.pod:6759
35439 msgid "guestfs_strings"
35443 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6761
35444 #: ../src/guestfs-actions.pod:6761
35448 " guestfs_strings (guestfs_h *g,\n"
35449 " const char *path);\n"
35454 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6777
35455 #: ../src/guestfs-actions.pod:6777
35456 msgid "guestfs_strings_e"
35460 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6779
35461 #: ../src/guestfs-actions.pod:6779
35465 " guestfs_strings_e (guestfs_h *g,\n"
35466 " const char *encoding,\n"
35467 " const char *path);\n"
35472 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6784
35473 #: ../src/guestfs-actions.pod:6784
35475 "This is like the C<guestfs_strings> command, but allows you to specify the "
35476 "encoding of strings that are looked for in the source file C<path>."
35480 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6794
35481 #: ../src/guestfs-actions.pod:6794
35483 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
35484 "ISO-8859-X (this is what C<guestfs_strings> uses)."
35488 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6832
35489 #: ../src/guestfs-actions.pod:6832
35490 msgid "guestfs_swapoff_device"
35494 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6834
35495 #: ../src/guestfs-actions.pod:6834
35499 " guestfs_swapoff_device (guestfs_h *g,\n"
35500 " const char *device);\n"
35505 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6838
35506 #: ../src/guestfs-actions.pod:6838
35508 "This command disables the libguestfs appliance swap device or partition "
35509 "named C<device>. See C<guestfs_swapon_device>."
35513 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6846
35514 #: ../src/guestfs-actions.pod:6846
35515 msgid "guestfs_swapoff_file"
35519 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6848
35520 #: ../src/guestfs-actions.pod:6848
35524 " guestfs_swapoff_file (guestfs_h *g,\n"
35525 " const char *file);\n"
35530 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6858
35531 #: ../src/guestfs-actions.pod:6858
35532 msgid "guestfs_swapoff_label"
35536 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6860
35537 #: ../src/guestfs-actions.pod:6860
35541 " guestfs_swapoff_label (guestfs_h *g,\n"
35542 " const char *label);\n"
35547 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6871
35548 #: ../src/guestfs-actions.pod:6871
35549 msgid "guestfs_swapoff_uuid"
35553 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6873
35554 #: ../src/guestfs-actions.pod:6873
35558 " guestfs_swapoff_uuid (guestfs_h *g,\n"
35559 " const char *uuid);\n"
35564 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6884
35565 #: ../src/guestfs-actions.pod:6884
35566 msgid "guestfs_swapon_device"
35570 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6886
35571 #: ../src/guestfs-actions.pod:6886
35575 " guestfs_swapon_device (guestfs_h *g,\n"
35576 " const char *device);\n"
35581 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6890
35582 #: ../src/guestfs-actions.pod:6890
35584 "This command enables the libguestfs appliance to use the swap device or "
35585 "partition named C<device>. The increased memory is made available for all "
35586 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
35590 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6906
35591 #: ../src/guestfs-actions.pod:6906
35592 msgid "guestfs_swapon_file"
35596 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6908
35597 #: ../src/guestfs-actions.pod:6908
35601 " guestfs_swapon_file (guestfs_h *g,\n"
35602 " const char *file);\n"
35607 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6912
35608 #: ../src/guestfs-actions.pod:6912
35610 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
35615 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6919
35616 #: ../src/guestfs-actions.pod:6919
35617 msgid "guestfs_swapon_label"
35621 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6921
35622 #: ../src/guestfs-actions.pod:6921
35626 " guestfs_swapon_label (guestfs_h *g,\n"
35627 " const char *label);\n"
35632 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6925
35633 #: ../src/guestfs-actions.pod:6925
35635 "This command enables swap to a labeled swap partition. See "
35636 "C<guestfs_swapon_device> for other notes."
35640 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6932
35641 #: ../src/guestfs-actions.pod:6932
35642 msgid "guestfs_swapon_uuid"
35646 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6934
35647 #: ../src/guestfs-actions.pod:6934
35651 " guestfs_swapon_uuid (guestfs_h *g,\n"
35652 " const char *uuid);\n"
35657 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6938
35658 #: ../src/guestfs-actions.pod:6938
35660 "This command enables swap to a swap partition with the given UUID. See "
35661 "C<guestfs_swapon_device> for other notes."
35665 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6945
35666 #: ../src/guestfs-actions.pod:6945
35667 msgid "guestfs_sync"
35671 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6947
35672 #: ../src/guestfs-actions.pod:6947
35676 " guestfs_sync (guestfs_h *g);\n"
35681 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6960
35682 #: ../src/guestfs-actions.pod:6960
35683 msgid "guestfs_tail"
35687 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6962
35688 #: ../src/guestfs-actions.pod:6962
35692 " guestfs_tail (guestfs_h *g,\n"
35693 " const char *path);\n"
35698 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6978
35699 #: ../src/guestfs-actions.pod:6978
35700 msgid "guestfs_tail_n"
35704 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:6980
35705 #: ../src/guestfs-actions.pod:6980
35709 " guestfs_tail_n (guestfs_h *g,\n"
35711 " const char *path);\n"
35716 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7002
35717 #: ../src/guestfs-actions.pod:7002
35718 msgid "guestfs_tar_in"
35722 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7004
35723 #: ../src/guestfs-actions.pod:7004
35727 " guestfs_tar_in (guestfs_h *g,\n"
35728 " const char *tarfile,\n"
35729 " const char *directory);\n"
35734 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7012
35735 #: ../src/guestfs-actions.pod:7012
35737 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
35741 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7017
35742 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7034
35743 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7050
35744 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7066
35745 #: ../src/guestfs-actions.pod:7017 ../src/guestfs-actions.pod:7034
35746 #: ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7066
35747 msgid "(Added in 1.0.3)"
35751 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7019
35752 #: ../src/guestfs-actions.pod:7019
35753 msgid "guestfs_tar_out"
35757 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7021
35758 #: ../src/guestfs-actions.pod:7021
35762 " guestfs_tar_out (guestfs_h *g,\n"
35763 " const char *directory,\n"
35764 " const char *tarfile);\n"
35769 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7029
35770 #: ../src/guestfs-actions.pod:7029
35772 "To download a compressed tarball, use C<guestfs_tgz_out> or "
35773 "C<guestfs_txz_out>."
35777 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7036
35778 #: ../src/guestfs-actions.pod:7036
35779 msgid "guestfs_tgz_in"
35783 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7038
35784 #: ../src/guestfs-actions.pod:7038
35788 " guestfs_tgz_in (guestfs_h *g,\n"
35789 " const char *tarball,\n"
35790 " const char *directory);\n"
35795 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7046
35796 #: ../src/guestfs-actions.pod:7046
35797 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
35801 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7052
35802 #: ../src/guestfs-actions.pod:7052
35803 msgid "guestfs_tgz_out"
35807 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7054
35808 #: ../src/guestfs-actions.pod:7054
35812 " guestfs_tgz_out (guestfs_h *g,\n"
35813 " const char *directory,\n"
35814 " const char *tarball);\n"
35819 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7062
35820 #: ../src/guestfs-actions.pod:7062
35821 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
35825 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7068
35826 #: ../src/guestfs-actions.pod:7068
35827 msgid "guestfs_touch"
35831 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7070
35832 #: ../src/guestfs-actions.pod:7070
35836 " guestfs_touch (guestfs_h *g,\n"
35837 " const char *path);\n"
35842 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7085
35843 #: ../src/guestfs-actions.pod:7085
35844 msgid "guestfs_truncate"
35848 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7087
35849 #: ../src/guestfs-actions.pod:7087
35853 " guestfs_truncate (guestfs_h *g,\n"
35854 " const char *path);\n"
35859 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7098
35860 #: ../src/guestfs-actions.pod:7098
35861 msgid "guestfs_truncate_size"
35865 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7100
35866 #: ../src/guestfs-actions.pod:7100
35870 " guestfs_truncate_size (guestfs_h *g,\n"
35871 " const char *path,\n"
35872 " int64_t size);\n"
35877 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7108
35878 #: ../src/guestfs-actions.pod:7108
35880 "If the current file size is less than C<size> then the file is extended to "
35881 "the required size with zero bytes. This creates a sparse file (ie. disk "
35882 "blocks are not allocated for the file until you write to it). To create a "
35883 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
35887 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7118
35888 #: ../src/guestfs-actions.pod:7118
35889 msgid "guestfs_tune2fs_l"
35893 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7120
35894 #: ../src/guestfs-actions.pod:7120
35898 " guestfs_tune2fs_l (guestfs_h *g,\n"
35899 " const char *device);\n"
35904 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7140
35905 #: ../src/guestfs-actions.pod:7140
35906 msgid "guestfs_txz_in"
35910 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7142
35911 #: ../src/guestfs-actions.pod:7142
35915 " guestfs_txz_in (guestfs_h *g,\n"
35916 " const char *tarball,\n"
35917 " const char *directory);\n"
35922 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7154
35923 #: ../src/guestfs-actions.pod:7154
35924 msgid "guestfs_txz_out"
35928 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7156
35929 #: ../src/guestfs-actions.pod:7156
35933 " guestfs_txz_out (guestfs_h *g,\n"
35934 " const char *directory,\n"
35935 " const char *tarball);\n"
35940 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7168
35941 #: ../src/guestfs-actions.pod:7168
35942 msgid "guestfs_umask"
35946 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7170
35947 #: ../src/guestfs-actions.pod:7170
35951 " guestfs_umask (guestfs_h *g,\n"
35957 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7186
35958 #: ../src/guestfs-actions.pod:7186
35960 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
35961 "C<guestfs_mkdir>."
35965 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7195
35966 #: ../src/guestfs-actions.pod:7195
35967 msgid "guestfs_umount"
35971 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7197
35972 #: ../src/guestfs-actions.pod:7197
35976 " guestfs_umount (guestfs_h *g,\n"
35977 " const char *pathordevice);\n"
35982 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7209
35983 #: ../src/guestfs-actions.pod:7209
35984 msgid "guestfs_umount_all"
35988 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7211
35989 #: ../src/guestfs-actions.pod:7211
35993 " guestfs_umount_all (guestfs_h *g);\n"
35998 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7222
35999 #: ../src/guestfs-actions.pod:7222
36000 msgid "guestfs_upload"
36004 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7224
36005 #: ../src/guestfs-actions.pod:7224
36009 " guestfs_upload (guestfs_h *g,\n"
36010 " const char *filename,\n"
36011 " const char *remotefilename);\n"
36016 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7234
36017 #: ../src/guestfs-actions.pod:7234
36018 msgid "See also C<guestfs_download>."
36022 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7245
36023 #: ../src/guestfs-actions.pod:7245
36024 msgid "guestfs_upload_offset"
36028 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7247
36029 #: ../src/guestfs-actions.pod:7247
36033 " guestfs_upload_offset (guestfs_h *g,\n"
36034 " const char *filename,\n"
36035 " const char *remotefilename,\n"
36036 " int64_t offset);\n"
36041 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7263
36042 #: ../src/guestfs-actions.pod:7263
36044 "Note that there is no limit on the amount of data that can be uploaded with "
36045 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
36046 "full amount unless an error occurs."
36050 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7268
36051 #: ../src/guestfs-actions.pod:7268
36052 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
36056 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7279
36057 #: ../src/guestfs-actions.pod:7279
36058 msgid "guestfs_utimens"
36062 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7281
36063 #: ../src/guestfs-actions.pod:7281
36067 " guestfs_utimens (guestfs_h *g,\n"
36068 " const char *path,\n"
36069 " int64_t atsecs,\n"
36070 " int64_t atnsecs,\n"
36071 " int64_t mtsecs,\n"
36072 " int64_t mtnsecs);\n"
36077 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7310
36078 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:175
36079 #: ../src/guestfs-actions.pod:7310 ../src/guestfs-structs.pod:175
36080 msgid "guestfs_version"
36084 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7312
36085 #: ../src/guestfs-actions.pod:7312
36088 " struct guestfs_version *\n"
36089 " guestfs_version (guestfs_h *g);\n"
36094 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7340
36095 #: ../src/guestfs-actions.pod:7340
36097 "I<Note:> Don't use this call to test for availability of features. In "
36098 "enterprise distributions we backport features from later versions into "
36099 "earlier versions, making this an unreliable way to test for features. Use "
36100 "C<guestfs_available> instead."
36104 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7346
36105 #: ../src/guestfs-actions.pod:7346
36107 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
36108 "error. I<The caller must call C<guestfs_free_version> after use>."
36112 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7350
36113 #: ../src/guestfs-actions.pod:7350
36114 msgid "(Added in 1.0.58)"
36118 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7352
36119 #: ../src/guestfs-actions.pod:7352
36120 msgid "guestfs_vfs_label"
36124 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7354
36125 #: ../src/guestfs-actions.pod:7354
36129 " guestfs_vfs_label (guestfs_h *g,\n"
36130 " const char *device);\n"
36135 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7363
36136 #: ../src/guestfs-actions.pod:7363
36137 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
36141 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7368
36142 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7405
36143 #: ../src/guestfs-actions.pod:7368 ../src/guestfs-actions.pod:7405
36144 msgid "(Added in 1.3.18)"
36148 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7370
36149 #: ../src/guestfs-actions.pod:7370
36150 msgid "guestfs_vfs_type"
36154 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7372
36155 #: ../src/guestfs-actions.pod:7372
36159 " guestfs_vfs_type (guestfs_h *g,\n"
36160 " const char *device);\n"
36165 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7389
36166 #: ../src/guestfs-actions.pod:7389
36167 msgid "guestfs_vfs_uuid"
36171 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7391
36172 #: ../src/guestfs-actions.pod:7391
36176 " guestfs_vfs_uuid (guestfs_h *g,\n"
36177 " const char *device);\n"
36182 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7400
36183 #: ../src/guestfs-actions.pod:7400
36184 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
36188 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7407
36189 #: ../src/guestfs-actions.pod:7407
36190 msgid "guestfs_vg_activate"
36194 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7409
36195 #: ../src/guestfs-actions.pod:7409
36199 " guestfs_vg_activate (guestfs_h *g,\n"
36201 " char *const *volgroups);\n"
36206 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7426
36207 #: ../src/guestfs-actions.pod:7426
36208 msgid "guestfs_vg_activate_all"
36212 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7428
36213 #: ../src/guestfs-actions.pod:7428
36217 " guestfs_vg_activate_all (guestfs_h *g,\n"
36218 " int activate);\n"
36223 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7441
36224 #: ../src/guestfs-actions.pod:7441
36225 msgid "guestfs_vgcreate"
36229 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7443
36230 #: ../src/guestfs-actions.pod:7443
36234 " guestfs_vgcreate (guestfs_h *g,\n"
36235 " const char *volgroup,\n"
36236 " char *const *physvols);\n"
36241 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7455
36242 #: ../src/guestfs-actions.pod:7455
36243 msgid "guestfs_vglvuuids"
36247 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7457
36248 #: ../src/guestfs-actions.pod:7457
36252 " guestfs_vglvuuids (guestfs_h *g,\n"
36253 " const char *vgname);\n"
36258 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7464
36259 #: ../src/guestfs-actions.pod:7464
36261 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
36262 "associate logical volumes and volume groups."
36266 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7467
36267 #: ../src/guestfs-actions.pod:7467
36268 msgid "See also C<guestfs_vgpvuuids>."
36272 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7475
36273 #: ../src/guestfs-actions.pod:7475
36274 msgid "guestfs_vgpvuuids"
36278 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7477
36279 #: ../src/guestfs-actions.pod:7477
36283 " guestfs_vgpvuuids (guestfs_h *g,\n"
36284 " const char *vgname);\n"
36289 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7484
36290 #: ../src/guestfs-actions.pod:7484
36292 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
36293 "associate physical volumes and volume groups."
36297 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7487
36298 #: ../src/guestfs-actions.pod:7487
36299 msgid "See also C<guestfs_vglvuuids>."
36303 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7495
36304 #: ../src/guestfs-actions.pod:7495
36305 msgid "guestfs_vgremove"
36309 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7497
36310 #: ../src/guestfs-actions.pod:7497
36314 " guestfs_vgremove (guestfs_h *g,\n"
36315 " const char *vgname);\n"
36320 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7510
36321 #: ../src/guestfs-actions.pod:7510
36322 msgid "guestfs_vgrename"
36326 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7512
36327 #: ../src/guestfs-actions.pod:7512
36331 " guestfs_vgrename (guestfs_h *g,\n"
36332 " const char *volgroup,\n"
36333 " const char *newvolgroup);\n"
36338 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7523
36339 #: ../src/guestfs-actions.pod:7523
36340 msgid "guestfs_vgs"
36344 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7525
36345 #: ../src/guestfs-actions.pod:7525
36349 " guestfs_vgs (guestfs_h *g);\n"
36354 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7534
36355 #: ../src/guestfs-actions.pod:7534
36356 msgid "See also C<guestfs_vgs_full>."
36360 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7542
36361 #: ../src/guestfs-actions.pod:7542
36362 msgid "guestfs_vgs_full"
36366 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7544
36367 #: ../src/guestfs-actions.pod:7544
36370 " struct guestfs_lvm_vg_list *\n"
36371 " guestfs_vgs_full (guestfs_h *g);\n"
36376 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7550
36377 #: ../src/guestfs-actions.pod:7550
36379 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
36380 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
36384 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7556
36385 #: ../src/guestfs-actions.pod:7556
36386 msgid "guestfs_vgscan"
36390 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7558
36391 #: ../src/guestfs-actions.pod:7558
36395 " guestfs_vgscan (guestfs_h *g);\n"
36400 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7568
36401 #: ../src/guestfs-actions.pod:7568
36402 msgid "guestfs_vguuid"
36406 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7570
36407 #: ../src/guestfs-actions.pod:7570
36411 " guestfs_vguuid (guestfs_h *g,\n"
36412 " const char *vgname);\n"
36417 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7581
36418 #: ../src/guestfs-actions.pod:7581
36419 msgid "guestfs_wait_ready"
36423 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7583
36424 #: ../src/guestfs-actions.pod:7583
36428 " guestfs_wait_ready (guestfs_h *g);\n"
36433 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7586
36434 #: ../src/guestfs-actions.pod:7586
36435 msgid "This function is a no op."
36439 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7588
36440 #: ../src/guestfs-actions.pod:7588
36442 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
36443 "calling C<guestfs_launch> to wait for the launch to complete. However this "
36444 "is no longer necessary because C<guestfs_launch> now does the waiting."
36448 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7593
36449 #: ../src/guestfs-actions.pod:7593
36451 "If you see any calls to this function in code then you can just remove them, "
36452 "unless you want to retain compatibility with older versions of the API."
36456 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7599
36457 #: ../src/guestfs-actions.pod:7599
36459 "This function is deprecated. In new code, use the C<launch> call instead."
36463 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7608
36464 #: ../src/guestfs-actions.pod:7608
36465 msgid "guestfs_wc_c"
36469 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7610
36470 #: ../src/guestfs-actions.pod:7610
36474 " guestfs_wc_c (guestfs_h *g,\n"
36475 " const char *path);\n"
36480 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7621
36481 #: ../src/guestfs-actions.pod:7621
36482 msgid "guestfs_wc_l"
36486 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7623
36487 #: ../src/guestfs-actions.pod:7623
36491 " guestfs_wc_l (guestfs_h *g,\n"
36492 " const char *path);\n"
36497 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7634
36498 #: ../src/guestfs-actions.pod:7634
36499 msgid "guestfs_wc_w"
36503 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7636
36504 #: ../src/guestfs-actions.pod:7636
36508 " guestfs_wc_w (guestfs_h *g,\n"
36509 " const char *path);\n"
36514 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7647
36515 #: ../src/guestfs-actions.pod:7647
36516 msgid "guestfs_write"
36520 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7649
36521 #: ../src/guestfs-actions.pod:7649
36525 " guestfs_write (guestfs_h *g,\n"
36526 " const char *path,\n"
36527 " const char *content,\n"
36528 " size_t content_size);\n"
36533 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7658
36534 #: ../src/guestfs-actions.pod:7658
36535 msgid "See also C<guestfs_write_append>."
36539 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7667
36540 #: ../src/guestfs-actions.pod:7667
36541 msgid "guestfs_write_append"
36545 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7669
36546 #: ../src/guestfs-actions.pod:7669
36550 " guestfs_write_append (guestfs_h *g,\n"
36551 " const char *path,\n"
36552 " const char *content,\n"
36553 " size_t content_size);\n"
36558 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7678
36559 #: ../src/guestfs-actions.pod:7678
36560 msgid "See also C<guestfs_write>."
36564 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7687
36565 #: ../src/guestfs-actions.pod:7687
36566 msgid "guestfs_write_file"
36570 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7689
36571 #: ../src/guestfs-actions.pod:7689
36575 " guestfs_write_file (guestfs_h *g,\n"
36576 " const char *path,\n"
36577 " const char *content,\n"
36583 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7720
36584 #: ../src/guestfs-actions.pod:7720
36585 msgid "guestfs_zegrep"
36589 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7722
36590 #: ../src/guestfs-actions.pod:7722
36594 " guestfs_zegrep (guestfs_h *g,\n"
36595 " const char *regex,\n"
36596 " const char *path);\n"
36601 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7739
36602 #: ../src/guestfs-actions.pod:7739
36603 msgid "guestfs_zegrepi"
36607 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7741
36608 #: ../src/guestfs-actions.pod:7741
36612 " guestfs_zegrepi (guestfs_h *g,\n"
36613 " const char *regex,\n"
36614 " const char *path);\n"
36619 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7758
36620 #: ../src/guestfs-actions.pod:7758
36621 msgid "guestfs_zero"
36625 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7760
36626 #: ../src/guestfs-actions.pod:7760
36630 " guestfs_zero (guestfs_h *g,\n"
36631 " const char *device);\n"
36636 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7770
36637 #: ../src/guestfs-actions.pod:7770
36639 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
36640 "C<guestfs_is_zero_device>"
36644 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7782
36645 #: ../src/guestfs-actions.pod:7782
36646 msgid "guestfs_zero_device"
36650 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7784
36651 #: ../src/guestfs-actions.pod:7784
36655 " guestfs_zero_device (guestfs_h *g,\n"
36656 " const char *device);\n"
36661 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7788
36662 #: ../src/guestfs-actions.pod:7788
36664 "This command writes zeroes over the entire C<device>. Compare with "
36665 "C<guestfs_zero> which just zeroes the first few blocks of a device."
36669 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7802
36670 #: ../src/guestfs-actions.pod:7802
36671 msgid "(Added in 1.3.1)"
36675 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7804
36676 #: ../src/guestfs-actions.pod:7804
36677 msgid "guestfs_zerofree"
36681 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7806
36682 #: ../src/guestfs-actions.pod:7806
36686 " guestfs_zerofree (guestfs_h *g,\n"
36687 " const char *device);\n"
36692 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7825
36693 #: ../src/guestfs-actions.pod:7825
36694 msgid "guestfs_zfgrep"
36698 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7827
36699 #: ../src/guestfs-actions.pod:7827
36703 " guestfs_zfgrep (guestfs_h *g,\n"
36704 " const char *pattern,\n"
36705 " const char *path);\n"
36710 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7844
36711 #: ../src/guestfs-actions.pod:7844
36712 msgid "guestfs_zfgrepi"
36716 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7846
36717 #: ../src/guestfs-actions.pod:7846
36721 " guestfs_zfgrepi (guestfs_h *g,\n"
36722 " const char *pattern,\n"
36723 " const char *path);\n"
36728 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7863
36729 #: ../src/guestfs-actions.pod:7863
36730 msgid "guestfs_zfile"
36734 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7865
36735 #: ../src/guestfs-actions.pod:7865
36739 " guestfs_zfile (guestfs_h *g,\n"
36740 " const char *meth,\n"
36741 " const char *path);\n"
36746 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7875
36747 #: ../src/guestfs-actions.pod:7875
36749 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
36754 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7890
36755 #: ../src/guestfs-actions.pod:7890
36756 msgid "guestfs_zgrep"
36760 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7892
36761 #: ../src/guestfs-actions.pod:7892
36765 " guestfs_zgrep (guestfs_h *g,\n"
36766 " const char *regex,\n"
36767 " const char *path);\n"
36772 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7909
36773 #: ../src/guestfs-actions.pod:7909
36774 msgid "guestfs_zgrepi"
36778 #: ../libguestfs-1.11.19/src/guestfs-actions.pod:7911
36779 #: ../src/guestfs-actions.pod:7911
36783 " guestfs_zgrepi (guestfs_h *g,\n"
36784 " const char *regex,\n"
36785 " const char *path);\n"
36790 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:3
36791 #: ../src/guestfs-availability.pod:3
36796 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:5
36797 #: ../src/guestfs-availability.pod:5
36799 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
36800 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
36801 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
36802 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
36803 "L</guestfs_aug_save> L</guestfs_aug_set>"
36807 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:21
36808 #: ../src/guestfs-availability.pod:21
36813 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:23
36814 #: ../src/guestfs-availability.pod:23
36815 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
36819 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:26
36820 #: ../src/guestfs-availability.pod:26
36825 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:28
36826 #: ../src/guestfs-availability.pod:28
36828 "The following functions: L</guestfs_inotify_add_watch> L</"
36829 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
36830 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
36834 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:36
36835 #: ../src/guestfs-availability.pod:36
36836 msgid "B<linuxfsuuid>"
36840 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:38
36841 #: ../src/guestfs-availability.pod:38
36843 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
36844 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
36848 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:45
36849 #: ../src/guestfs-availability.pod:45
36850 msgid "B<linuxmodules>"
36854 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:47
36855 #: ../src/guestfs-availability.pod:47
36856 msgid "The following functions: L</guestfs_modprobe>"
36860 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:50
36861 #: ../src/guestfs-availability.pod:50
36862 msgid "B<linuxxattrs>"
36866 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:52
36867 #: ../src/guestfs-availability.pod:52
36869 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
36870 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
36871 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
36872 "guestfs_setxattr>"
36876 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:63
36877 #: ../src/guestfs-availability.pod:63
36882 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:65
36883 #: ../src/guestfs-availability.pod:65
36885 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
36886 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
36887 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
36891 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:74
36892 #: ../src/guestfs-availability.pod:74
36897 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:76
36898 #: ../src/guestfs-availability.pod:76
36900 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
36901 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
36902 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
36903 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
36904 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
36905 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
36906 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
36910 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:99
36911 #: ../src/guestfs-availability.pod:99
36916 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:101
36917 #: ../src/guestfs-availability.pod:101
36919 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
36920 "guestfs_mknod_b> L</guestfs_mknod_c>"
36924 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:107
36925 #: ../src/guestfs-availability.pod:107
36930 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:109
36931 #: ../src/guestfs-availability.pod:109
36932 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
36936 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:112
36937 #: ../src/guestfs-availability.pod:112
36938 msgid "B<ntfsprogs>"
36942 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:114
36943 #: ../src/guestfs-availability.pod:114
36945 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
36946 "L</guestfs_ntfsresize_size>"
36950 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:119
36951 #: ../src/guestfs-availability.pod:119
36952 msgid "B<realpath>"
36956 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:121
36957 #: ../src/guestfs-availability.pod:121
36958 msgid "The following functions: L</guestfs_realpath>"
36962 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:124
36963 #: ../src/guestfs-availability.pod:124
36968 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:126
36969 #: ../src/guestfs-availability.pod:126
36971 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
36972 "guestfs_scrub_freespace>"
36976 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:131
36977 #: ../src/guestfs-availability.pod:131
36982 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:133
36983 #: ../src/guestfs-availability.pod:133
36984 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
36988 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:137
36989 #: ../src/guestfs-availability.pod:137
36994 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:139
36995 #: ../src/guestfs-availability.pod:139
36996 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
37000 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:143
37001 #: ../src/guestfs-availability.pod:143
37002 msgid "B<zerofree>"
37006 #: ../libguestfs-1.11.19/src/guestfs-availability.pod:145
37007 #: ../src/guestfs-availability.pod:145
37008 msgid "The following functions: L</guestfs_zerofree>"
37012 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:1
37013 #: ../src/guestfs-structs.pod:1
37014 msgid "guestfs_int_bool"
37018 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:3
37019 #: ../src/guestfs-structs.pod:3
37022 " struct guestfs_int_bool {\n"
37030 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:8
37031 #: ../src/guestfs-structs.pod:8
37034 " struct guestfs_int_bool_list {\n"
37035 " uint32_t len; /* Number of elements in list. */\n"
37036 " struct guestfs_int_bool *val; /* Elements. */\n"
37042 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:13
37043 #: ../src/guestfs-structs.pod:13
37046 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
37047 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
37052 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:16
37053 #: ../src/guestfs-structs.pod:16
37054 msgid "guestfs_lvm_pv"
37058 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:18
37059 #: ../src/guestfs-structs.pod:18
37062 " struct guestfs_lvm_pv {\n"
37063 " char *pv_name;\n"
37064 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
37065 " char pv_uuid[32];\n"
37067 " uint64_t pv_size;\n"
37068 " uint64_t dev_size;\n"
37069 " uint64_t pv_free;\n"
37070 " uint64_t pv_used;\n"
37071 " char *pv_attr;\n"
37072 " int64_t pv_pe_count;\n"
37073 " int64_t pv_pe_alloc_count;\n"
37074 " char *pv_tags;\n"
37075 " uint64_t pe_start;\n"
37076 " int64_t pv_mda_count;\n"
37077 " uint64_t pv_mda_free;\n"
37083 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:36
37084 #: ../src/guestfs-structs.pod:36
37087 " struct guestfs_lvm_pv_list {\n"
37088 " uint32_t len; /* Number of elements in list. */\n"
37089 " struct guestfs_lvm_pv *val; /* Elements. */\n"
37095 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:41
37096 #: ../src/guestfs-structs.pod:41
37099 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
37100 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
37105 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:44
37106 #: ../src/guestfs-structs.pod:44
37107 msgid "guestfs_lvm_vg"
37111 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:46
37112 #: ../src/guestfs-structs.pod:46
37115 " struct guestfs_lvm_vg {\n"
37116 " char *vg_name;\n"
37117 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
37118 " char vg_uuid[32];\n"
37120 " char *vg_attr;\n"
37121 " uint64_t vg_size;\n"
37122 " uint64_t vg_free;\n"
37123 " char *vg_sysid;\n"
37124 " uint64_t vg_extent_size;\n"
37125 " int64_t vg_extent_count;\n"
37126 " int64_t vg_free_count;\n"
37127 " int64_t max_lv;\n"
37128 " int64_t max_pv;\n"
37129 " int64_t pv_count;\n"
37130 " int64_t lv_count;\n"
37131 " int64_t snap_count;\n"
37132 " int64_t vg_seqno;\n"
37133 " char *vg_tags;\n"
37134 " int64_t vg_mda_count;\n"
37135 " uint64_t vg_mda_free;\n"
37141 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:69
37142 #: ../src/guestfs-structs.pod:69
37145 " struct guestfs_lvm_vg_list {\n"
37146 " uint32_t len; /* Number of elements in list. */\n"
37147 " struct guestfs_lvm_vg *val; /* Elements. */\n"
37153 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:74
37154 #: ../src/guestfs-structs.pod:74
37157 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
37158 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
37163 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:77
37164 #: ../src/guestfs-structs.pod:77
37165 msgid "guestfs_lvm_lv"
37169 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:79
37170 #: ../src/guestfs-structs.pod:79
37173 " struct guestfs_lvm_lv {\n"
37174 " char *lv_name;\n"
37175 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
37176 " char lv_uuid[32];\n"
37177 " char *lv_attr;\n"
37178 " int64_t lv_major;\n"
37179 " int64_t lv_minor;\n"
37180 " int64_t lv_kernel_major;\n"
37181 " int64_t lv_kernel_minor;\n"
37182 " uint64_t lv_size;\n"
37183 " int64_t seg_count;\n"
37185 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
37186 " float snap_percent;\n"
37187 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
37188 " float copy_percent;\n"
37189 " char *move_pv;\n"
37190 " char *lv_tags;\n"
37191 " char *mirror_log;\n"
37192 " char *modules;\n"
37198 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:101
37199 #: ../src/guestfs-structs.pod:101
37202 " struct guestfs_lvm_lv_list {\n"
37203 " uint32_t len; /* Number of elements in list. */\n"
37204 " struct guestfs_lvm_lv *val; /* Elements. */\n"
37210 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:106
37211 #: ../src/guestfs-structs.pod:106
37214 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
37215 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
37220 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:111
37221 #: ../src/guestfs-structs.pod:111
37224 " struct guestfs_stat {\n"
37228 " int64_t nlink;\n"
37233 " int64_t blksize;\n"
37234 " int64_t blocks;\n"
37235 " int64_t atime;\n"
37236 " int64_t mtime;\n"
37237 " int64_t ctime;\n"
37243 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:127
37244 #: ../src/guestfs-structs.pod:127
37247 " struct guestfs_stat_list {\n"
37248 " uint32_t len; /* Number of elements in list. */\n"
37249 " struct guestfs_stat *val; /* Elements. */\n"
37255 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:132
37256 #: ../src/guestfs-structs.pod:132
37259 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
37260 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
37265 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:137
37266 #: ../src/guestfs-structs.pod:137
37269 " struct guestfs_statvfs {\n"
37270 " int64_t bsize;\n"
37271 " int64_t frsize;\n"
37272 " int64_t blocks;\n"
37273 " int64_t bfree;\n"
37274 " int64_t bavail;\n"
37275 " int64_t files;\n"
37276 " int64_t ffree;\n"
37277 " int64_t favail;\n"
37280 " int64_t namemax;\n"
37286 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:151
37287 #: ../src/guestfs-structs.pod:151
37290 " struct guestfs_statvfs_list {\n"
37291 " uint32_t len; /* Number of elements in list. */\n"
37292 " struct guestfs_statvfs *val; /* Elements. */\n"
37298 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:156
37299 #: ../src/guestfs-structs.pod:156
37302 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
37303 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
37308 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:159
37309 #: ../src/guestfs-structs.pod:159
37310 msgid "guestfs_dirent"
37314 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:161
37315 #: ../src/guestfs-structs.pod:161
37318 " struct guestfs_dirent {\n"
37327 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:167
37328 #: ../src/guestfs-structs.pod:167
37331 " struct guestfs_dirent_list {\n"
37332 " uint32_t len; /* Number of elements in list. */\n"
37333 " struct guestfs_dirent *val; /* Elements. */\n"
37339 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:172
37340 #: ../src/guestfs-structs.pod:172
37343 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
37344 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
37349 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:177
37350 #: ../src/guestfs-structs.pod:177
37353 " struct guestfs_version {\n"
37354 " int64_t major;\n"
37355 " int64_t minor;\n"
37356 " int64_t release;\n"
37363 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:184
37364 #: ../src/guestfs-structs.pod:184
37367 " struct guestfs_version_list {\n"
37368 " uint32_t len; /* Number of elements in list. */\n"
37369 " struct guestfs_version *val; /* Elements. */\n"
37375 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:189
37376 #: ../src/guestfs-structs.pod:189
37379 " void guestfs_free_version (struct guestfs_free_version *);\n"
37380 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
37385 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:192
37386 #: ../src/guestfs-structs.pod:192
37387 msgid "guestfs_xattr"
37391 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:194
37392 #: ../src/guestfs-structs.pod:194
37395 " struct guestfs_xattr {\n"
37396 " char *attrname;\n"
37397 " /* The next two fields describe a byte array. */\n"
37398 " uint32_t attrval_len;\n"
37399 " char *attrval;\n"
37405 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:201
37406 #: ../src/guestfs-structs.pod:201
37409 " struct guestfs_xattr_list {\n"
37410 " uint32_t len; /* Number of elements in list. */\n"
37411 " struct guestfs_xattr *val; /* Elements. */\n"
37417 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:206
37418 #: ../src/guestfs-structs.pod:206
37421 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
37422 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
37427 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:209
37428 #: ../src/guestfs-structs.pod:209
37429 msgid "guestfs_inotify_event"
37433 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:211
37434 #: ../src/guestfs-structs.pod:211
37437 " struct guestfs_inotify_event {\n"
37438 " int64_t in_wd;\n"
37439 " uint32_t in_mask;\n"
37440 " uint32_t in_cookie;\n"
37441 " char *in_name;\n"
37447 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:218
37448 #: ../src/guestfs-structs.pod:218
37451 " struct guestfs_inotify_event_list {\n"
37452 " uint32_t len; /* Number of elements in list. */\n"
37453 " struct guestfs_inotify_event *val; /* Elements. */\n"
37459 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:223
37460 #: ../src/guestfs-structs.pod:223
37463 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
37464 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
37469 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:226
37470 #: ../src/guestfs-structs.pod:226
37471 msgid "guestfs_partition"
37475 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:228
37476 #: ../src/guestfs-structs.pod:228
37479 " struct guestfs_partition {\n"
37480 " int32_t part_num;\n"
37481 " uint64_t part_start;\n"
37482 " uint64_t part_end;\n"
37483 " uint64_t part_size;\n"
37489 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:235
37490 #: ../src/guestfs-structs.pod:235
37493 " struct guestfs_partition_list {\n"
37494 " uint32_t len; /* Number of elements in list. */\n"
37495 " struct guestfs_partition *val; /* Elements. */\n"
37501 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:240
37502 #: ../src/guestfs-structs.pod:240
37505 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
37506 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
37511 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:243
37512 #: ../src/guestfs-structs.pod:243
37513 msgid "guestfs_application"
37517 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:245
37518 #: ../src/guestfs-structs.pod:245
37521 " struct guestfs_application {\n"
37522 " char *app_name;\n"
37523 " char *app_display_name;\n"
37524 " int32_t app_epoch;\n"
37525 " char *app_version;\n"
37526 " char *app_release;\n"
37527 " char *app_install_path;\n"
37528 " char *app_trans_path;\n"
37529 " char *app_publisher;\n"
37530 " char *app_url;\n"
37531 " char *app_source_package;\n"
37532 " char *app_summary;\n"
37533 " char *app_description;\n"
37539 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:260
37540 #: ../src/guestfs-structs.pod:260
37543 " struct guestfs_application_list {\n"
37544 " uint32_t len; /* Number of elements in list. */\n"
37545 " struct guestfs_application *val; /* Elements. */\n"
37551 #: ../libguestfs-1.11.19/src/guestfs-structs.pod:265
37552 #: ../src/guestfs-structs.pod:265
37555 " void guestfs_free_application (struct guestfs_free_application *);\n"
37556 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
37561 #: ../libguestfs-1.11.19/src/guestfs.pod:5 ../src/guestfs.pod:5
37562 msgid "guestfs - Library for accessing and modifying virtual machine images"
37566 #: ../libguestfs-1.11.19/src/guestfs.pod:11 ../src/guestfs.pod:11
37569 " guestfs_h *g = guestfs_create ();\n"
37570 " guestfs_add_drive (g, \"guest.img\");\n"
37571 " guestfs_launch (g);\n"
37572 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
37573 " guestfs_touch (g, \"/hello\");\n"
37574 " guestfs_umount (g, \"/\");\n"
37575 " guestfs_close (g);\n"
37580 #: ../libguestfs-1.11.19/src/guestfs.pod:25 ../src/guestfs.pod:25
37582 "Libguestfs is a library for accessing and modifying guest disk images. "
37583 "Amongst the things this is good for: making batch configuration changes to "
37584 "guests, getting disk used/free statistics (see also: virt-df), migrating "
37585 "between virtualization systems (see also: virt-p2v), performing partial "
37586 "backups, performing partial guest clones, cloning guests and changing "
37587 "registry/UUID/hostname info, and much else besides."
37591 #: ../libguestfs-1.11.19/src/guestfs.pod:33 ../src/guestfs.pod:33
37593 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
37594 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
37595 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
37600 #: ../libguestfs-1.11.19/src/guestfs.pod:38 ../src/guestfs.pod:38
37602 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
37603 "what filesystem is in each LV, etc.). It can also run commands in the "
37604 "context of the guest. Also you can access filesystems over FUSE."
37608 #: ../libguestfs-1.11.19/src/guestfs.pod:43 ../src/guestfs.pod:43
37610 "Libguestfs is a library that can be linked with C and C++ management "
37611 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
37612 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
37617 #: ../libguestfs-1.11.19/src/guestfs.pod:48 ../src/guestfs.pod:48
37619 "You don't need to be root to use libguestfs, although obviously you do need "
37620 "enough permissions to access the disk images."
37624 #: ../libguestfs-1.11.19/src/guestfs.pod:51 ../src/guestfs.pod:51
37626 "Libguestfs is a large API because it can do many things. For a gentle "
37627 "introduction, please read the L</API OVERVIEW> section next."
37631 #: ../libguestfs-1.11.19/src/guestfs.pod:54 ../src/guestfs.pod:54
37633 "There are also some example programs in the L<guestfs-examples(3)> manual "
37638 #: ../libguestfs-1.11.19/src/guestfs.pod:57 ../src/guestfs.pod:57
37639 msgid "API OVERVIEW"
37643 #: ../libguestfs-1.11.19/src/guestfs.pod:59 ../src/guestfs.pod:59
37645 "This section provides a gentler overview of the libguestfs API. We also try "
37646 "to group API calls together, where that may not be obvious from reading "
37647 "about the individual calls in the main section of this manual."
37651 #: ../libguestfs-1.11.19/src/guestfs.pod:64 ../src/guestfs.pod:64
37656 #: ../libguestfs-1.11.19/src/guestfs.pod:66 ../src/guestfs.pod:66
37658 "Before you can use libguestfs calls, you have to create a handle. Then you "
37659 "must add at least one disk image to the handle, followed by launching the "
37660 "handle, then performing whatever operations you want, and finally closing "
37661 "the handle. By convention we use the single letter C<g> for the name of the "
37662 "handle variable, although of course you can use any name you want."
37666 #: ../libguestfs-1.11.19/src/guestfs.pod:73 ../src/guestfs.pod:73
37667 msgid "The general structure of all libguestfs-using programs looks like this:"
37671 #: ../libguestfs-1.11.19/src/guestfs.pod:76 ../src/guestfs.pod:76
37674 " guestfs_h *g = guestfs_create ();\n"
37679 #: ../libguestfs-1.11.19/src/guestfs.pod:78 ../src/guestfs.pod:78
37682 " /* Call guestfs_add_drive additional times if there are\n"
37683 " * multiple disk images.\n"
37685 " guestfs_add_drive (g, \"guest.img\");\n"
37690 #: ../libguestfs-1.11.19/src/guestfs.pod:83 ../src/guestfs.pod:83
37693 " /* Most manipulation calls won't work until you've launched\n"
37694 " * the handle 'g'. You have to do this _after_ adding drives\n"
37695 " * and _before_ other commands.\n"
37697 " guestfs_launch (g);\n"
37702 #: ../libguestfs-1.11.19/src/guestfs.pod:89 ../src/guestfs.pod:89
37705 " /* Now you can examine what partitions, LVs etc are available.\n"
37707 " char **partitions = guestfs_list_partitions (g);\n"
37708 " char **logvols = guestfs_lvs (g);\n"
37713 #: ../libguestfs-1.11.19/src/guestfs.pod:94 ../src/guestfs.pod:94
37716 " /* To access a filesystem in the image, you must mount it.\n"
37718 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
37723 #: ../libguestfs-1.11.19/src/guestfs.pod:98 ../src/guestfs.pod:98
37726 " /* Now you can perform filesystem actions on the guest\n"
37729 " guestfs_touch (g, \"/hello\");\n"
37734 #: ../libguestfs-1.11.19/src/guestfs.pod:103 ../src/guestfs.pod:103
37737 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
37738 " * it is done automatically when you close the handle. See\n"
37739 " * discussion of autosync in this page.\n"
37741 " guestfs_sync (g);\n"
37746 #: ../libguestfs-1.11.19/src/guestfs.pod:109 ../src/guestfs.pod:109
37749 " /* Close the handle 'g'. */\n"
37750 " guestfs_close (g);\n"
37755 #: ../libguestfs-1.11.19/src/guestfs.pod:112 ../src/guestfs.pod:112
37757 "The code above doesn't include any error checking. In real code you should "
37758 "check return values carefully for errors. In general all functions that "
37759 "return integers return C<-1> on error, and all functions that return "
37760 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
37761 "how to handle errors, and consult the documentation for each function call "
37762 "below to see precisely how they return error indications. See L<guestfs-"
37763 "examples(3)> for fully worked examples."
37767 #: ../libguestfs-1.11.19/src/guestfs.pod:121 ../src/guestfs.pod:121
37768 msgid "DISK IMAGES"
37772 #: ../libguestfs-1.11.19/src/guestfs.pod:123 ../src/guestfs.pod:123
37774 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
37775 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
37776 "actual block device, or simply an empty file of zeroes that you have created "
37777 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
37782 #: ../libguestfs-1.11.19/src/guestfs.pod:129 ../src/guestfs.pod:129
37784 "The call you should use in modern code for adding drives is L</"
37785 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
37786 "specifying that the format is raw, do:"
37790 #: ../libguestfs-1.11.19/src/guestfs.pod:133 ../src/guestfs.pod:133
37793 " guestfs_add_drive_opts (g, filename,\n"
37794 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
37800 #: ../libguestfs-1.11.19/src/guestfs.pod:137 ../src/guestfs.pod:137
37801 msgid "You can add a disk read-only using:"
37805 #: ../libguestfs-1.11.19/src/guestfs.pod:139 ../src/guestfs.pod:139
37808 " guestfs_add_drive_opts (g, filename,\n"
37809 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
37810 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
37816 #: ../libguestfs-1.11.19/src/guestfs.pod:144 ../src/guestfs.pod:144
37818 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
37819 "libguestfs won't modify the file."
37823 #: ../libguestfs-1.11.19/src/guestfs.pod:147 ../src/guestfs.pod:147
37825 "Be extremely cautious if the disk image is in use, eg. if it is being used "
37826 "by a virtual machine. Adding it read-write will almost certainly cause disk "
37827 "corruption, but adding it read-only is safe."
37831 #: ../libguestfs-1.11.19/src/guestfs.pod:151 ../src/guestfs.pod:151
37833 "You must add at least one disk image, and you may add multiple disk images. "
37834 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
37835 "first one you added), C</dev/sdb> (for the second one you added), etc."
37839 #: ../libguestfs-1.11.19/src/guestfs.pod:156 ../src/guestfs.pod:156
37841 "Once L</guestfs_launch> has been called you cannot add any more images. You "
37842 "can call L</guestfs_list_devices> to get a list of the device names, in the "
37843 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
37847 #: ../libguestfs-1.11.19/src/guestfs.pod:161 ../src/guestfs.pod:161
37852 #: ../libguestfs-1.11.19/src/guestfs.pod:163 ../src/guestfs.pod:163
37854 "Before you can read or write files, create directories and so on in a disk "
37855 "image that contains filesystems, you have to mount those filesystems using "
37856 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
37857 "a disk image contains (for example) one partition with a filesystem on that "
37858 "partition, then you can mount it directly:"
37862 #: ../libguestfs-1.11.19/src/guestfs.pod:170 ../src/guestfs.pod:170
37865 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
37870 #: ../libguestfs-1.11.19/src/guestfs.pod:172 ../src/guestfs.pod:172
37872 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
37873 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
37874 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
37875 "that these are libguestfs virtual devices, and are nothing to do with host "
37880 #: ../libguestfs-1.11.19/src/guestfs.pod:178 ../src/guestfs.pod:178
37882 "If you are given a disk image and you don't know what it contains then you "
37883 "have to find out. Libguestfs can do that too: use L</"
37884 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
37885 "LVs, and either try mounting each to see what is mountable, or else examine "
37886 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
37887 "filesystems, use L</guestfs_list_filesystems>."
37891 #: ../libguestfs-1.11.19/src/guestfs.pod:186 ../src/guestfs.pod:186
37893 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
37894 "L</INSPECTION> below). But you might find it easier to look at higher level "
37895 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
37899 #: ../libguestfs-1.11.19/src/guestfs.pod:191 ../src/guestfs.pod:191
37901 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
37902 "several other variations of the C<guestfs_mount_*> call."
37906 #: ../libguestfs-1.11.19/src/guestfs.pod:194 ../src/guestfs.pod:194
37907 msgid "FILESYSTEM ACCESS AND MODIFICATION"
37911 #: ../libguestfs-1.11.19/src/guestfs.pod:196 ../src/guestfs.pod:196
37913 "The majority of the libguestfs API consists of fairly low-level calls for "
37914 "accessing and modifying the files, directories, symlinks etc on mounted "
37915 "filesystems. There are over a hundred such calls which you can find listed "
37916 "in detail below in this man page, and we don't even pretend to cover them "
37917 "all in this overview."
37921 #: ../libguestfs-1.11.19/src/guestfs.pod:202 ../src/guestfs.pod:202
37923 "Specify filenames as full paths, starting with C<\"/\"> and including the "
37928 #: ../libguestfs-1.11.19/src/guestfs.pod:205 ../src/guestfs.pod:205
37930 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
37931 "the file called C<\"etc/passwd\"> then you could do:"
37935 #: ../libguestfs-1.11.19/src/guestfs.pod:208 ../src/guestfs.pod:208
37938 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
37943 #: ../libguestfs-1.11.19/src/guestfs.pod:210 ../src/guestfs.pod:210
37945 "This would return C<data> as a newly allocated buffer containing the full "
37946 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
37947 "or C<NULL> if there was an error."
37951 #: ../libguestfs-1.11.19/src/guestfs.pod:214 ../src/guestfs.pod:214
37953 "As another example, to create a top-level directory on that filesystem "
37954 "called C<\"var\"> you would do:"
37958 #: ../libguestfs-1.11.19/src/guestfs.pod:217 ../src/guestfs.pod:217
37961 " guestfs_mkdir (g, \"/var\");\n"
37966 #: ../libguestfs-1.11.19/src/guestfs.pod:219 ../src/guestfs.pod:219
37967 msgid "To create a symlink you could do:"
37971 #: ../libguestfs-1.11.19/src/guestfs.pod:221 ../src/guestfs.pod:221
37974 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
37975 " \"/etc/rc3.d/S30portmap\");\n"
37980 #: ../libguestfs-1.11.19/src/guestfs.pod:224 ../src/guestfs.pod:224
37982 "Libguestfs will reject attempts to use relative paths and there is no "
37983 "concept of a current working directory."
37987 #: ../libguestfs-1.11.19/src/guestfs.pod:227 ../src/guestfs.pod:227
37989 "Libguestfs can return errors in many situations: for example if the "
37990 "filesystem isn't writable, or if a file or directory that you requested "
37991 "doesn't exist. If you are using the C API (documented here) you have to "
37992 "check for those error conditions after each call. (Other language bindings "
37993 "turn these errors into exceptions)."
37997 #: ../libguestfs-1.11.19/src/guestfs.pod:233 ../src/guestfs.pod:233
37999 "File writes are affected by the per-handle umask, set by calling L</"
38000 "guestfs_umask> and defaulting to 022. See L</UMASK>."
38004 #: ../libguestfs-1.11.19/src/guestfs.pod:236 ../src/guestfs.pod:236
38005 msgid "PARTITIONING"
38009 #: ../libguestfs-1.11.19/src/guestfs.pod:238 ../src/guestfs.pod:238
38011 "Libguestfs contains API calls to read, create and modify partition tables on "
38016 #: ../libguestfs-1.11.19/src/guestfs.pod:241 ../src/guestfs.pod:241
38018 "In the common case where you want to create a single partition covering the "
38019 "whole disk, you should use the L</guestfs_part_disk> call:"
38023 #: ../libguestfs-1.11.19/src/guestfs.pod:245 ../src/guestfs.pod:245
38026 " const char *parttype = \"mbr\";\n"
38027 " if (disk_is_larger_than_2TB)\n"
38028 " parttype = \"gpt\";\n"
38029 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
38034 #: ../libguestfs-1.11.19/src/guestfs.pod:250 ../src/guestfs.pod:250
38036 "Obviously this effectively wipes anything that was on that disk image before."
38040 #: ../libguestfs-1.11.19/src/guestfs.pod:253 ../src/guestfs.pod:253
38045 #: ../libguestfs-1.11.19/src/guestfs.pod:255 ../src/guestfs.pod:255
38047 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
38048 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
38049 "you familiarize yourself with the concepts of physical volumes, volume "
38050 "groups and logical volumes."
38054 #: ../libguestfs-1.11.19/src/guestfs.pod:260 ../src/guestfs.pod:260
38056 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
38057 "tldp.org/HOWTO/LVM-HOWTO/>."
38061 #: ../libguestfs-1.11.19/src/guestfs.pod:263 ../src/guestfs.pod:263
38062 msgid "DOWNLOADING"
38066 #: ../libguestfs-1.11.19/src/guestfs.pod:265 ../src/guestfs.pod:265
38068 "Use L</guestfs_cat> to download small, text only files. This call is "
38069 "limited to files which are less than 2 MB and which cannot contain any ASCII "
38070 "NUL (C<\\0>) characters. However the API is very simple to use."
38074 #: ../libguestfs-1.11.19/src/guestfs.pod:269 ../src/guestfs.pod:269
38076 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
38077 "bit data, since it returns a (pointer, size) pair. However it is still "
38078 "limited to \"small\" files, less than 2 MB."
38082 #: ../libguestfs-1.11.19/src/guestfs.pod:273 ../src/guestfs.pod:273
38084 "L</guestfs_download> can be used to download any file, with no limits on "
38085 "content or size (even files larger than 4 GB)."
38089 #: ../libguestfs-1.11.19/src/guestfs.pod:276 ../src/guestfs.pod:276
38091 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
38095 #: ../libguestfs-1.11.19/src/guestfs.pod:279 ../src/guestfs.pod:279
38100 #: ../libguestfs-1.11.19/src/guestfs.pod:281 ../src/guestfs.pod:281
38102 "It's often the case that you want to write a file or files to the disk image."
38106 #: ../libguestfs-1.11.19/src/guestfs.pod:284 ../src/guestfs.pod:284
38108 "To write a small file with fixed content, use L</guestfs_write>. To create "
38109 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
38110 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
38111 "of other functions for creating test files, for example L</guestfs_fill> and "
38112 "L</guestfs_fill_pattern>."
38116 #: ../libguestfs-1.11.19/src/guestfs.pod:290 ../src/guestfs.pod:290
38118 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
38119 "file content or size (even files larger than 4 GB)."
38123 #: ../libguestfs-1.11.19/src/guestfs.pod:293 ../src/guestfs.pod:293
38125 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
38129 #: ../libguestfs-1.11.19/src/guestfs.pod:295 ../src/guestfs.pod:295
38131 "However the fastest way to upload I<large numbers of arbitrary files> is to "
38132 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
38133 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
38134 "in a predictable way (eg. adding it last after all other drives) then you "
38135 "can get the device name from L</guestfs_list_devices> and mount it directly "
38136 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
38137 "portable between kernel versions, and they don't support labels or UUIDs. "
38138 "If you want to pre-build an image or you need to mount it using a label or "
38139 "UUID, use an ISO image instead."
38143 #: ../libguestfs-1.11.19/src/guestfs.pod:306 ../src/guestfs.pod:306
38148 #: ../libguestfs-1.11.19/src/guestfs.pod:308 ../src/guestfs.pod:308
38150 "There are various different commands for copying between files and devices "
38151 "and in and out of the guest filesystem. These are summarised in the table "
38156 #: ../libguestfs-1.11.19/src/guestfs.pod:314 ../src/guestfs.pod:314
38157 msgid "B<file> to B<file>"
38161 #: ../libguestfs-1.11.19/src/guestfs.pod:316 ../src/guestfs.pod:316
38163 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
38164 "directories recursively."
38168 #: ../libguestfs-1.11.19/src/guestfs.pod:319 ../src/guestfs.pod:319
38169 msgid "B<file or device> to B<file or device>"
38173 #: ../libguestfs-1.11.19/src/guestfs.pod:321 ../src/guestfs.pod:321
38175 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
38176 "devices in the guest."
38180 #: ../libguestfs-1.11.19/src/guestfs.pod:324 ../src/guestfs.pod:324
38181 msgid "Example: duplicate the contents of an LV:"
38185 #: ../libguestfs-1.11.19/src/guestfs.pod:326 ../src/guestfs.pod:326
38188 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
38193 #: ../libguestfs-1.11.19/src/guestfs.pod:328 ../src/guestfs.pod:328
38195 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
38196 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
38197 "guestfs_copy_size>."
38201 #: ../libguestfs-1.11.19/src/guestfs.pod:332 ../src/guestfs.pod:332
38202 msgid "B<file on the host> to B<file or device>"
38206 #: ../libguestfs-1.11.19/src/guestfs.pod:334 ../src/guestfs.pod:334
38207 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
38211 #: ../libguestfs-1.11.19/src/guestfs.pod:336 ../src/guestfs.pod:336
38212 msgid "B<file or device> to B<file on the host>"
38216 #: ../libguestfs-1.11.19/src/guestfs.pod:338 ../src/guestfs.pod:338
38217 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
38221 #: ../libguestfs-1.11.19/src/guestfs.pod:342 ../src/guestfs.pod:342
38222 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
38226 #: ../libguestfs-1.11.19/src/guestfs.pod:344 ../src/guestfs.pod:344
38228 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
38229 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
38230 "appears you can only upload and download to files. However many Un*x-like "
38231 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
38232 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
38233 "and arbitrary file descriptor N."
38237 #: ../libguestfs-1.11.19/src/guestfs.pod:352 ../src/guestfs.pod:352
38238 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
38242 #: ../libguestfs-1.11.19/src/guestfs.pod:355 ../src/guestfs.pod:355
38245 " guestfs_download (g, filename, \"/dev/stdout\");\n"
38250 #: ../libguestfs-1.11.19/src/guestfs.pod:357 ../src/guestfs.pod:357
38251 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
38255 #: ../libguestfs-1.11.19/src/guestfs.pod:359 ../src/guestfs.pod:359
38258 " char devfd[64];\n"
38259 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
38260 " guestfs_tar_out (g, \"/\", devfd);\n"
38265 #: ../libguestfs-1.11.19/src/guestfs.pod:363 ../src/guestfs.pod:363
38266 msgid "LISTING FILES"
38270 #: ../libguestfs-1.11.19/src/guestfs.pod:365 ../src/guestfs.pod:365
38272 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
38273 "L<guestfish(1)>-equivalent command C<ll>)."
38277 #: ../libguestfs-1.11.19/src/guestfs.pod:368 ../src/guestfs.pod:368
38279 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
38280 "programs, as a flat list of strings."
38284 #: ../libguestfs-1.11.19/src/guestfs.pod:371 ../src/guestfs.pod:371
38286 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
38287 "directory, plus additional information about each one. It is more "
38288 "equivalent to using the L<readdir(3)> call on a local filesystem."
38292 #: ../libguestfs-1.11.19/src/guestfs.pod:375 ../src/guestfs.pod:375
38294 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
38298 #: ../libguestfs-1.11.19/src/guestfs.pod:378 ../src/guestfs.pod:378
38299 msgid "RUNNING COMMANDS"
38303 #: ../libguestfs-1.11.19/src/guestfs.pod:380 ../src/guestfs.pod:380
38305 "Although libguestfs is primarily an API for manipulating files inside guest "
38306 "images, we also provide some limited facilities for running commands inside "
38311 #: ../libguestfs-1.11.19/src/guestfs.pod:384 ../src/guestfs.pod:384
38312 msgid "There are many limitations to this:"
38316 #: ../libguestfs-1.11.19/src/guestfs.pod:390 ../src/guestfs.pod:390
38318 "The kernel version that the command runs under will be different from what "
38323 #: ../libguestfs-1.11.19/src/guestfs.pod:395 ../src/guestfs.pod:395
38325 "If the command needs to communicate with daemons, then most likely they "
38326 "won't be running."
38330 #: ../libguestfs-1.11.19/src/guestfs.pod:400 ../src/guestfs.pod:400
38331 msgid "The command will be running in limited memory."
38335 #: ../libguestfs-1.11.19/src/guestfs.pod:404 ../src/guestfs.pod:404
38337 "The network may not be available unless you enable it (see L</"
38338 "guestfs_set_network>)."
38342 #: ../libguestfs-1.11.19/src/guestfs.pod:409 ../src/guestfs.pod:409
38343 msgid "Only supports Linux guests (not Windows, BSD, etc)."
38347 #: ../libguestfs-1.11.19/src/guestfs.pod:413 ../src/guestfs.pod:413
38349 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
38353 #: ../libguestfs-1.11.19/src/guestfs.pod:418 ../src/guestfs.pod:418
38355 "For SELinux guests, you may need to enable SELinux and load policy first. "
38356 "See L</SELINUX> in this manpage."
38360 #: ../libguestfs-1.11.19/src/guestfs.pod:423 ../src/guestfs.pod:423
38362 "I<Security:> It is not safe to run commands from untrusted, possibly "
38363 "malicious guests. These commands may attempt to exploit your program by "
38364 "sending unexpected output. They could also try to exploit the Linux kernel "
38365 "or qemu provided by the libguestfs appliance. They could use the network "
38366 "provided by the libguestfs appliance to bypass ordinary network partitions "
38367 "and firewalls. They could use the elevated privileges or different SELinux "
38368 "context of your program to their advantage."
38372 #: ../libguestfs-1.11.19/src/guestfs.pod:432 ../src/guestfs.pod:432
38374 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
38375 "(a script which runs when the guest next boots normally), and to have this "
38376 "script run the commands you want in the normal context of the running guest, "
38377 "network security and so on. For information about other security issues, "
38378 "see L</SECURITY>."
38382 #: ../libguestfs-1.11.19/src/guestfs.pod:440 ../src/guestfs.pod:440
38384 "The two main API calls to run commands are L</guestfs_command> and L</"
38385 "guestfs_sh> (there are also variations)."
38389 #: ../libguestfs-1.11.19/src/guestfs.pod:443 ../src/guestfs.pod:443
38391 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
38392 "shell globs, redirections, etc will work."
38396 #: ../libguestfs-1.11.19/src/guestfs.pod:446 ../src/guestfs.pod:446
38397 msgid "CONFIGURATION FILES"
38401 #: ../libguestfs-1.11.19/src/guestfs.pod:448 ../src/guestfs.pod:448
38403 "To read and write configuration files in Linux guest filesystems, we "
38404 "strongly recommend using Augeas. For example, Augeas understands how to "
38405 "read and write, say, a Linux shadow password file or X.org configuration "
38406 "file, and so avoids you having to write that code."
38410 #: ../libguestfs-1.11.19/src/guestfs.pod:453 ../src/guestfs.pod:453
38412 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
38413 "document Augeas itself here because there is excellent documentation on the "
38414 "L<http://augeas.net/> website."
38418 #: ../libguestfs-1.11.19/src/guestfs.pod:457 ../src/guestfs.pod:457
38420 "If you don't want to use Augeas (you fool!) then try calling L</"
38421 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
38426 #: ../libguestfs-1.11.19/src/guestfs.pod:461 ../src/guestfs.pod:461
38431 #: ../libguestfs-1.11.19/src/guestfs.pod:463 ../src/guestfs.pod:463
38433 "We support SELinux guests. To ensure that labeling happens correctly in "
38434 "SELinux guests, you need to enable SELinux and load the guest's policy:"
38438 #: ../libguestfs-1.11.19/src/guestfs.pod:471 ../src/guestfs.pod:471
38439 msgid "Before launching, do:"
38443 #: ../libguestfs-1.11.19/src/guestfs.pod:473 ../src/guestfs.pod:473
38446 " guestfs_set_selinux (g, 1);\n"
38451 #: ../libguestfs-1.11.19/src/guestfs.pod:477 ../src/guestfs.pod:477
38453 "After mounting the guest's filesystem(s), load the policy. This is best "
38454 "done by running the L<load_policy(8)> command in the guest itself:"
38458 #: ../libguestfs-1.11.19/src/guestfs.pod:481 ../src/guestfs.pod:481
38461 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
38466 #: ../libguestfs-1.11.19/src/guestfs.pod:483 ../src/guestfs.pod:483
38468 "(Older versions of C<load_policy> require you to specify the name of the "
38473 #: ../libguestfs-1.11.19/src/guestfs.pod:488 ../src/guestfs.pod:488
38475 "Optionally, set the security context for the API. The correct security "
38476 "context to use can only be known by inspecting the guest. As an example:"
38480 #: ../libguestfs-1.11.19/src/guestfs.pod:492 ../src/guestfs.pod:492
38483 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
38488 #: ../libguestfs-1.11.19/src/guestfs.pod:496 ../src/guestfs.pod:496
38489 msgid "This will work for running commands and editing existing files."
38493 #: ../libguestfs-1.11.19/src/guestfs.pod:498 ../src/guestfs.pod:498
38495 "When new files are created, you may need to label them explicitly, for "
38496 "example by running the external command C<restorecon pathname>."
38500 #: ../libguestfs-1.11.19/src/guestfs.pod:502 ../src/guestfs.pod:502
38505 #: ../libguestfs-1.11.19/src/guestfs.pod:504 ../src/guestfs.pod:504
38507 "Certain calls are affected by the current file mode creation mask (the "
38508 "\"umask\"). In particular ones which create files or directories, such as "
38509 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
38510 "either the default mode that the file is created with or modifies the mode "
38515 #: ../libguestfs-1.11.19/src/guestfs.pod:510 ../src/guestfs.pod:510
38517 "The default umask is C<022>, so files are created with modes such as C<0644> "
38518 "and directories with C<0755>."
38522 #: ../libguestfs-1.11.19/src/guestfs.pod:513 ../src/guestfs.pod:513
38524 "There are two ways to avoid being affected by umask. Either set umask to 0 "
38525 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
38526 "guestfs_chmod> after creating each file or directory."
38530 #: ../libguestfs-1.11.19/src/guestfs.pod:517 ../src/guestfs.pod:517
38531 msgid "For more information about umask, see L<umask(2)>."
38535 #: ../libguestfs-1.11.19/src/guestfs.pod:521 ../src/guestfs.pod:521
38537 "Libguestfs allows you to access Linux guests which have been encrypted using "
38538 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
38539 "standard. This includes nearly all whole disk encryption systems used by "
38540 "modern Linux guests."
38544 #: ../libguestfs-1.11.19/src/guestfs.pod:527 ../src/guestfs.pod:527
38546 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
38547 "returns the string C<crypto_LUKS>)."
38551 #: ../libguestfs-1.11.19/src/guestfs.pod:530 ../src/guestfs.pod:530
38553 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
38554 "will require the passphrase!"
38558 #: ../libguestfs-1.11.19/src/guestfs.pod:533 ../src/guestfs.pod:533
38560 "Opening a LUKS device creates a new device mapper device called C</dev/"
38561 "mapper/mapname> (where C<mapname> is the string you supply to L</"
38562 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
38563 "from and encrypted to the underlying block device respectively."
38567 #: ../libguestfs-1.11.19/src/guestfs.pod:539 ../src/guestfs.pod:539
38569 "LVM volume groups on the device can be made visible by calling L</"
38570 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
38571 "(s) can now be mounted in the usual way."
38575 #: ../libguestfs-1.11.19/src/guestfs.pod:543 ../src/guestfs.pod:543
38577 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
38578 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
38579 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
38580 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
38581 "underlying encrypted block device)."
38585 #: ../libguestfs-1.11.19/src/guestfs.pod:550 ../src/guestfs.pod:550
38590 #: ../libguestfs-1.11.19/src/guestfs.pod:552 ../src/guestfs.pod:552
38592 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
38593 "contains operating systems, an install CD or a live CD. (These APIs used to "
38594 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
38595 "version 1.5.3 the most frequently used part of this library has been "
38596 "rewritten in C and moved into the core code)."
38600 #: ../libguestfs-1.11.19/src/guestfs.pod:559 ../src/guestfs.pod:559
38602 "Add all disks belonging to the unknown virtual machine and call L</"
38603 "guestfs_launch> in the usual way."
38607 #: ../libguestfs-1.11.19/src/guestfs.pod:562 ../src/guestfs.pod:562
38609 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
38610 "and certain heuristics, and returns a list of operating systems that were "
38611 "found. An empty list means none were found. A single element is the root "
38612 "filesystem of the operating system. For dual- or multi-boot guests, "
38613 "multiple roots can be returned, each one corresponding to a separate "
38614 "operating system. (Multi-boot virtual machines are extremely rare in the "
38615 "world of virtualization, but since this scenario can happen, we have built "
38616 "libguestfs to deal with it.)"
38620 #: ../libguestfs-1.11.19/src/guestfs.pod:571 ../src/guestfs.pod:571
38622 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
38623 "to get additional details about that operating system. For example, call L</"
38624 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
38625 "Windows and Linux-based operating systems respectively."
38629 #: ../libguestfs-1.11.19/src/guestfs.pod:577 ../src/guestfs.pod:577
38631 "Un*x-like and Linux-based operating systems usually consist of several "
38632 "filesystems which are mounted at boot time (for example, a separate boot "
38633 "partition mounted on C</boot>). The inspection rules are able to detect how "
38634 "filesystems correspond to mount points. Call "
38635 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
38636 "hash table like this example:"
38640 #: ../libguestfs-1.11.19/src/guestfs.pod:584 ../src/guestfs.pod:584
38643 " /boot => /dev/sda1\n"
38644 " / => /dev/vg_guest/lv_root\n"
38645 " /usr => /dev/vg_guest/lv_usr\n"
38650 #: ../libguestfs-1.11.19/src/guestfs.pod:588 ../src/guestfs.pod:588
38652 "The caller can then make calls to L</guestfs_mount_options> to mount the "
38653 "filesystems as suggested."
38657 #: ../libguestfs-1.11.19/src/guestfs.pod:591 ../src/guestfs.pod:591
38659 "Be careful to mount filesystems in the right order (eg. C</> before C</"
38660 "usr>). Sorting the keys of the hash by length, shortest first, should work."
38664 #: ../libguestfs-1.11.19/src/guestfs.pod:595 ../src/guestfs.pod:595
38666 "Inspection currently only works for some common operating systems. "
38667 "Contributors are welcome to send patches for other operating systems that we "
38668 "currently cannot detect."
38672 #: ../libguestfs-1.11.19/src/guestfs.pod:599 ../src/guestfs.pod:599
38674 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
38675 "for more details. The L</guestfs_inspect_os> function just ignores any "
38676 "encrypted devices."
38680 #: ../libguestfs-1.11.19/src/guestfs.pod:603 ../src/guestfs.pod:603
38682 "A note on the implementation: The call L</guestfs_inspect_os> performs "
38683 "inspection and caches the results in the guest handle. Subsequent calls to "
38684 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
38685 "read the disks. If you change the content of the guest disks, you can redo "
38686 "inspection by calling L</guestfs_inspect_os> again. (L</"
38687 "guestfs_inspect_list_applications> works a little differently from the other "
38688 "calls and does read the disks. See documentation for that function for "
38693 #: ../libguestfs-1.11.19/src/guestfs.pod:612 ../src/guestfs.pod:612
38694 msgid "INSPECTING INSTALL DISKS"
38698 #: ../libguestfs-1.11.19/src/guestfs.pod:614 ../src/guestfs.pod:614
38700 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
38705 #: ../libguestfs-1.11.19/src/guestfs.pod:617 ../src/guestfs.pod:617
38707 "Call L</guestfs_inspect_get_format> to return the format of the operating "
38708 "system, which currently can be C<installed> (a regular operating system) or "
38709 "C<installer> (some sort of install disk)."
38713 #: ../libguestfs-1.11.19/src/guestfs.pod:621 ../src/guestfs.pod:621
38715 "Further information is available about the operating system that can be "
38716 "installed using the regular inspection APIs like L</"
38717 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
38721 #: ../libguestfs-1.11.19/src/guestfs.pod:626 ../src/guestfs.pod:626
38723 "Some additional information specific to installer disks is also available "
38724 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
38725 "guestfs_inspect_is_multipart> calls."
38729 #: ../libguestfs-1.11.19/src/guestfs.pod:631 ../src/guestfs.pod:631
38730 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
38734 #: ../libguestfs-1.11.19/src/guestfs.pod:633 ../src/guestfs.pod:633
38736 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
38737 "ntfs-3g.org/> driver."
38741 #: ../libguestfs-1.11.19/src/guestfs.pod:636 ../src/guestfs.pod:636
38742 msgid "DRIVE LETTERS AND PATHS"
38746 #: ../libguestfs-1.11.19/src/guestfs.pod:638 ../src/guestfs.pod:638
38748 "DOS and Windows still use drive letters, and the filesystems are always "
38749 "treated as case insensitive by Windows itself, and therefore you might find "
38750 "a Windows configuration file referring to a path like C<c:\\windows"
38751 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
38752 "might be referred to as C</WINDOWS/System32>."
38756 #: ../libguestfs-1.11.19/src/guestfs.pod:644 ../src/guestfs.pod:644
38758 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
38759 "L</guestfs_inspect_get_drive_mappings>)"
38763 #: ../libguestfs-1.11.19/src/guestfs.pod:647 ../src/guestfs.pod:647
38765 "Dealing with separator characters (backslash vs forward slash) is outside "
38766 "the scope of libguestfs, but usually a simple character replacement will "
38771 #: ../libguestfs-1.11.19/src/guestfs.pod:651 ../src/guestfs.pod:651
38773 "To resolve the case insensitivity of paths, call L</"
38774 "guestfs_case_sensitive_path>."
38778 #: ../libguestfs-1.11.19/src/guestfs.pod:654 ../src/guestfs.pod:654
38779 msgid "ACCESSING THE WINDOWS REGISTRY"
38783 #: ../libguestfs-1.11.19/src/guestfs.pod:656 ../src/guestfs.pod:656
38785 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
38786 "files, through the library C<hivex> which is part of the libguestfs project "
38787 "although ships as a separate tarball. You have to locate and download the "
38788 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
38789 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
38790 "reg(1)> for more help on this issue."
38794 #: ../libguestfs-1.11.19/src/guestfs.pod:664 ../src/guestfs.pod:664
38795 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
38799 #: ../libguestfs-1.11.19/src/guestfs.pod:666 ../src/guestfs.pod:666
38801 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
38802 "provide something which looks like a Linux symlink. The way it tries to do "
38803 "the rewriting is described here:"
38807 #: ../libguestfs-1.11.19/src/guestfs.pod:670 ../src/guestfs.pod:670
38809 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
38814 #: ../libguestfs-1.11.19/src/guestfs.pod:672 ../src/guestfs.pod:672
38816 "The essential problem is that ntfs-3g simply does not have enough "
38817 "information to do a correct job. NTFS links can contain drive letters and "
38818 "references to external device GUIDs that ntfs-3g has no way of resolving. "
38819 "It is almost certainly the case that libguestfs callers should ignore what "
38820 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
38824 #: ../libguestfs-1.11.19/src/guestfs.pod:679 ../src/guestfs.pod:679
38826 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
38827 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
38828 "attribute, and read the raw reparse data from that (you can find the format "
38829 "documented in various places around the web)."
38833 #: ../libguestfs-1.11.19/src/guestfs.pod:684 ../src/guestfs.pod:684
38834 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
38838 #: ../libguestfs-1.11.19/src/guestfs.pod:686 ../src/guestfs.pod:686
38840 "There are other useful extended attributes that can be read from ntfs-3g "
38841 "filesystems (using L</guestfs_getxattr>). See:"
38845 #: ../libguestfs-1.11.19/src/guestfs.pod:689 ../src/guestfs.pod:689
38847 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
38851 #: ../libguestfs-1.11.19/src/guestfs.pod:691 ../src/guestfs.pod:691
38852 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
38856 #: ../libguestfs-1.11.19/src/guestfs.pod:693 ../src/guestfs.pod:693
38858 "Although we don't want to discourage you from using the C API, we will "
38859 "mention here that the same API is also available in other languages."
38863 #: ../libguestfs-1.11.19/src/guestfs.pod:696 ../src/guestfs.pod:696
38865 "The API is broadly identical in all supported languages. This means that "
38866 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
38867 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
38868 "OCaml. In other words, a straightforward, predictable isomorphism between "
38873 #: ../libguestfs-1.11.19/src/guestfs.pod:702 ../src/guestfs.pod:702
38875 "Error messages are automatically transformed into exceptions if the language "
38880 #: ../libguestfs-1.11.19/src/guestfs.pod:705 ../src/guestfs.pod:705
38882 "We don't try to \"object orientify\" parts of the API in OO languages, "
38883 "although contributors are welcome to write higher level APIs above what we "
38884 "provide in their favourite languages if they wish."
38888 #: ../libguestfs-1.11.19/src/guestfs.pod:711 ../src/guestfs.pod:711
38893 #: ../libguestfs-1.11.19/src/guestfs.pod:713 ../src/guestfs.pod:713
38895 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
38896 "identical to the C API. C++ classes and exceptions are not used."
38900 #: ../libguestfs-1.11.19/src/guestfs.pod:717 ../src/guestfs.pod:717
38905 #: ../libguestfs-1.11.19/src/guestfs.pod:719 ../src/guestfs.pod:719
38907 "The C# bindings are highly experimental. Please read the warnings at the "
38908 "top of C<csharp/Libguestfs.cs>."
38912 #: ../libguestfs-1.11.19/src/guestfs.pod:722 ../src/guestfs.pod:722
38917 #: ../libguestfs-1.11.19/src/guestfs.pod:724 ../src/guestfs.pod:724
38919 "This is the only language binding that is working but incomplete. Only "
38920 "calls which return simple integers have been bound in Haskell, and we are "
38921 "looking for help to complete this binding."
38925 #: ../libguestfs-1.11.19/src/guestfs.pod:728 ../src/guestfs.pod:728
38930 #: ../libguestfs-1.11.19/src/guestfs.pod:730 ../src/guestfs.pod:730
38932 "Full documentation is contained in the Javadoc which is distributed with "
38937 #: ../libguestfs-1.11.19/src/guestfs.pod:733 ../src/guestfs.pod:733
38942 #: ../libguestfs-1.11.19/src/guestfs.pod:735 ../src/guestfs.pod:735
38943 msgid "See L<guestfs-ocaml(3)>."
38947 #: ../libguestfs-1.11.19/src/guestfs.pod:737 ../src/guestfs.pod:737
38952 #: ../libguestfs-1.11.19/src/guestfs.pod:739 ../src/guestfs.pod:739
38953 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
38957 #: ../libguestfs-1.11.19/src/guestfs.pod:741 ../src/guestfs.pod:741
38962 #: ../libguestfs-1.11.19/src/guestfs.pod:743 ../src/guestfs.pod:743
38964 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
38965 "the php-libguestfs package for your distribution."
38969 #: ../libguestfs-1.11.19/src/guestfs.pod:746 ../src/guestfs.pod:746
38970 msgid "The PHP binding only works correctly on 64 bit machines."
38974 #: ../libguestfs-1.11.19/src/guestfs.pod:748 ../src/guestfs.pod:748
38979 #: ../libguestfs-1.11.19/src/guestfs.pod:750 ../src/guestfs.pod:750
38980 msgid "See L<guestfs-python(3)>."
38984 #: ../libguestfs-1.11.19/src/guestfs.pod:752 ../src/guestfs.pod:752
38989 #: ../libguestfs-1.11.19/src/guestfs.pod:754 ../src/guestfs.pod:754
38990 msgid "See L<guestfs-ruby(3)>."
38994 #: ../libguestfs-1.11.19/src/guestfs.pod:756 ../src/guestfs.pod:756
38995 msgid "B<shell scripts>"
38999 #: ../libguestfs-1.11.19/src/guestfs.pod:758 ../src/guestfs.pod:758
39000 msgid "See L<guestfish(1)>."
39004 #: ../libguestfs-1.11.19/src/guestfs.pod:762 ../src/guestfs.pod:762
39005 msgid "LIBGUESTFS GOTCHAS"
39009 #: ../libguestfs-1.11.19/src/guestfs.pod:764 ../src/guestfs.pod:764
39011 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
39012 "system [...] that works in the way it is documented but is counterintuitive "
39013 "and almost invites mistakes.\""
39017 #: ../libguestfs-1.11.19/src/guestfs.pod:768 ../src/guestfs.pod:768
39019 "Since we developed libguestfs and the associated tools, there are several "
39020 "things we would have designed differently, but are now stuck with for "
39021 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
39022 "release, you can expect these to change. Beware of them."
39026 #: ../libguestfs-1.11.19/src/guestfs.pod:776 ../src/guestfs.pod:776
39027 msgid "Autosync / forgetting to sync."
39031 #: ../libguestfs-1.11.19/src/guestfs.pod:778 ../src/guestfs.pod:778
39033 "I<Update:> Autosync is enabled by default for all API users starting from "
39034 "libguestfs 1.5.24. This section only applies to older versions."
39038 #: ../libguestfs-1.11.19/src/guestfs.pod:781 ../src/guestfs.pod:781
39040 "When modifying a filesystem from C or another language, you B<must> unmount "
39041 "all filesystems and call L</guestfs_sync> explicitly before you close the "
39042 "libguestfs handle. You can also call:"
39046 #: ../libguestfs-1.11.19/src/guestfs.pod:785 ../src/guestfs.pod:785
39049 " guestfs_set_autosync (g, 1);\n"
39054 #: ../libguestfs-1.11.19/src/guestfs.pod:787 ../src/guestfs.pod:787
39056 "to have the unmount/sync done automatically for you when the handle 'g' is "
39057 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
39061 #: ../libguestfs-1.11.19/src/guestfs.pod:791 ../src/guestfs.pod:791
39063 "If you forget to do this, then it is entirely possible that your changes "
39064 "won't be written out, or will be partially written, or (very rarely) that "
39065 "you'll get disk corruption."
39069 #: ../libguestfs-1.11.19/src/guestfs.pod:795 ../src/guestfs.pod:795
39071 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
39072 "guestfish scripts that forget to sync will work just fine, which can make "
39073 "this very puzzling if you are trying to debug a problem."
39077 #: ../libguestfs-1.11.19/src/guestfs.pod:799 ../src/guestfs.pod:799
39078 msgid "Mount option C<-o sync> should not be the default."
39082 #: ../libguestfs-1.11.19/src/guestfs.pod:801 ../src/guestfs.pod:801
39084 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
39085 "However C<-o sync> does not add any reliability benefit, but does have a "
39086 "very large performance impact."
39090 #: ../libguestfs-1.11.19/src/guestfs.pod:805 ../src/guestfs.pod:805
39092 "The work around is to use L</guestfs_mount_options> and set the mount "
39093 "options that you actually want to use."
39097 #: ../libguestfs-1.11.19/src/guestfs.pod:808 ../src/guestfs.pod:808
39098 msgid "Read-only should be the default."
39102 #: ../libguestfs-1.11.19/src/guestfs.pod:810 ../src/guestfs.pod:810
39104 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
39105 "specify I<--rw> if you want to make changes to the image."
39109 #: ../libguestfs-1.11.19/src/guestfs.pod:813 ../src/guestfs.pod:813
39110 msgid "This would reduce the potential to corrupt live VM images."
39114 #: ../libguestfs-1.11.19/src/guestfs.pod:815 ../src/guestfs.pod:815
39116 "Note that many filesystems change the disk when you just mount and unmount, "
39117 "even if you didn't perform any writes. You need to use L</"
39118 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
39122 #: ../libguestfs-1.11.19/src/guestfs.pod:819 ../src/guestfs.pod:819
39123 msgid "guestfish command line is hard to use."
39127 #: ../libguestfs-1.11.19/src/guestfs.pod:821 ../src/guestfs.pod:821
39129 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
39130 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
39131 "exist, so it fails. In earlier versions of guestfish the error message was "
39132 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
39133 "we should have used C<guestfish -c command> to run commands."
39137 #: ../libguestfs-1.11.19/src/guestfs.pod:828 ../src/guestfs.pod:828
39138 msgid "guestfish megabyte modifiers don't work right on all commands"
39142 #: ../libguestfs-1.11.19/src/guestfs.pod:830 ../src/guestfs.pod:830
39144 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
39145 "other modifiers). What guestfish actually does is to multiply the number "
39146 "part by the modifier part and pass the result to the C API. However this "
39147 "doesn't work for a few APIs which aren't expecting bytes, but are already "
39148 "expecting some other unit (eg. megabytes)."
39152 #: ../libguestfs-1.11.19/src/guestfs.pod:837 ../src/guestfs.pod:837
39153 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
39157 #: ../libguestfs-1.11.19/src/guestfs.pod:839 ../src/guestfs.pod:839
39160 " lvcreate LV VG 100M\n"
39165 #: ../libguestfs-1.11.19/src/guestfs.pod:841 ../src/guestfs.pod:841
39167 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
39168 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
39169 "megabytes * megabytes) logical volume. The error message you get from this "
39170 "is also a little obscure."
39174 #: ../libguestfs-1.11.19/src/guestfs.pod:846 ../src/guestfs.pod:846
39176 "This could be fixed in the generator by specially marking parameters and "
39177 "return values which take bytes or other units."
39181 #: ../libguestfs-1.11.19/src/guestfs.pod:849 ../src/guestfs.pod:849
39182 msgid "Ambiguity between devices and paths"
39186 #: ../libguestfs-1.11.19/src/guestfs.pod:851 ../src/guestfs.pod:851
39188 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
39189 "sdb2>) and a similar pathname. A file might just happen to be called "
39190 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
39194 #: ../libguestfs-1.11.19/src/guestfs.pod:856 ../src/guestfs.pod:856
39196 "In the current API we usually resolve this ambiguity by having two separate "
39197 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
39198 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
39199 "detecting if the path supplied begins with C</dev/>."
39203 #: ../libguestfs-1.11.19/src/guestfs.pod:862 ../src/guestfs.pod:862
39205 "To avoid both the ambiguity and the need to duplicate some calls, we could "
39206 "make paths/devices into structured names. One way to do this would be to "
39207 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
39208 "aspect of grub. Another way would be to use a structured type, equivalent "
39209 "to this OCaml type:"
39213 #: ../libguestfs-1.11.19/src/guestfs.pod:868 ../src/guestfs.pod:868
39216 " type path = Path of string | Device of int | Partition of int * int\n"
39221 #: ../libguestfs-1.11.19/src/guestfs.pod:870 ../src/guestfs.pod:870
39222 msgid "which would allow you to pass arguments like:"
39226 #: ../libguestfs-1.11.19/src/guestfs.pod:872 ../src/guestfs.pod:872
39229 " Path \"/foo/bar\"\n"
39230 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
39231 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
39232 " Path \"/dev/sdb2\" (* not a device *)\n"
39237 #: ../libguestfs-1.11.19/src/guestfs.pod:877 ../src/guestfs.pod:877
39239 "As you can see there are still problems to resolve even with this "
39240 "representation. Also consider how it might work in guestfish."
39244 #: ../libguestfs-1.11.19/src/guestfs.pod:882 ../src/guestfs.pod:882
39245 msgid "KEYS AND PASSPHRASES"
39249 #: ../libguestfs-1.11.19/src/guestfs.pod:884 ../src/guestfs.pod:884
39251 "Certain libguestfs calls take a parameter that contains sensitive key "
39252 "material, passed in as a C string."
39256 #: ../libguestfs-1.11.19/src/guestfs.pod:887 ../src/guestfs.pod:887
39258 "In the future we would hope to change the libguestfs implementation so that "
39259 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
39260 "swap. However this is I<not> done at the moment, because of the complexity "
39261 "of such an implementation."
39265 #: ../libguestfs-1.11.19/src/guestfs.pod:892 ../src/guestfs.pod:892
39267 "Therefore you should be aware that any key parameter you pass to libguestfs "
39268 "might end up being written out to the swap partition. If this is a concern, "
39269 "scrub the swap partition or don't use libguestfs on encrypted devices."
39273 #: ../libguestfs-1.11.19/src/guestfs.pod:897 ../src/guestfs.pod:897
39274 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
39278 #: ../libguestfs-1.11.19/src/guestfs.pod:899 ../src/guestfs.pod:899
39280 "All high-level libguestfs actions are synchronous. If you want to use "
39281 "libguestfs asynchronously then you must create a thread."
39285 #: ../libguestfs-1.11.19/src/guestfs.pod:902 ../src/guestfs.pod:902
39287 "Only use the handle from a single thread. Either use the handle exclusively "
39288 "from one thread, or provide your own mutex so that two threads cannot issue "
39289 "calls on the same handle at the same time."
39293 #: ../libguestfs-1.11.19/src/guestfs.pod:906 ../src/guestfs.pod:906
39295 "See the graphical program guestfs-browser for one possible architecture for "
39296 "multithreaded programs using libvirt and libguestfs."
39300 #: ../libguestfs-1.11.19/src/guestfs.pod:909 ../src/guestfs.pod:909
39305 #: ../libguestfs-1.11.19/src/guestfs.pod:911 ../src/guestfs.pod:911
39307 "Libguestfs needs a supermin appliance, which it finds by looking along an "
39312 #: ../libguestfs-1.11.19/src/guestfs.pod:914 ../src/guestfs.pod:914
39314 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
39315 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
39319 #: ../libguestfs-1.11.19/src/guestfs.pod:917 ../src/guestfs.pod:917
39321 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
39322 "to change the directories that libguestfs will search in. The value is a "
39323 "colon-separated list of paths. The current directory is I<not> searched "
39324 "unless the path contains an empty element or C<.>. For example "
39325 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
39326 "then C</usr/lib/guestfs>."
39330 #: ../libguestfs-1.11.19/src/guestfs.pod:924 ../src/guestfs.pod:924
39331 msgid "QEMU WRAPPERS"
39335 #: ../libguestfs-1.11.19/src/guestfs.pod:926 ../src/guestfs.pod:926
39337 "If you want to compile your own qemu, run qemu from a non-standard location, "
39338 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
39343 #: ../libguestfs-1.11.19/src/guestfs.pod:930 ../src/guestfs.pod:930
39345 "There is one important rule to remember: you I<must C<exec qemu>> as the "
39346 "last command in the shell script (so that qemu replaces the shell and "
39347 "becomes the direct child of the libguestfs-using program). If you don't do "
39348 "this, then the qemu process won't be cleaned up correctly."
39352 #: ../libguestfs-1.11.19/src/guestfs.pod:935 ../src/guestfs.pod:935
39354 "Here is an example of a wrapper, where I have built my own copy of qemu from "
39359 #: ../libguestfs-1.11.19/src/guestfs.pod:938 ../src/guestfs.pod:938
39363 " qemudir=/home/rjones/d/qemu\n"
39364 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
39369 #: ../libguestfs-1.11.19/src/guestfs.pod:942 ../src/guestfs.pod:942
39371 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
39372 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
39377 #: ../libguestfs-1.11.19/src/guestfs.pod:946 ../src/guestfs.pod:946
39380 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
39385 #: ../libguestfs-1.11.19/src/guestfs.pod:948 ../src/guestfs.pod:948
39387 "Note that libguestfs also calls qemu with the -help and -version options in "
39388 "order to determine features."
39392 #: ../libguestfs-1.11.19/src/guestfs.pod:951 ../src/guestfs.pod:951
39393 msgid "ATTACHING TO RUNNING DAEMONS"
39397 #: ../libguestfs-1.11.19/src/guestfs.pod:953 ../src/guestfs.pod:953
39399 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
39400 "babies. Use with caution."
39404 #: ../libguestfs-1.11.19/src/guestfs.pod:956 ../src/guestfs.pod:956
39406 "I<Note (2):> This section explains how to attach to a running daemon from a "
39407 "low level perspective. For most users, simply using virt tools such as "
39408 "L<guestfish(1)> with the I<--live> option will \"just work\"."
39412 #: ../libguestfs-1.11.19/src/guestfs.pod:960 ../src/guestfs.pod:960
39413 msgid "Using guestfs_set_attach_method"
39417 #: ../libguestfs-1.11.19/src/guestfs.pod:962 ../src/guestfs.pod:962
39419 "By calling L</guestfs_set_attach_method> you can change how the library "
39420 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
39421 "ARCHITECTURE> for some background)."
39425 #: ../libguestfs-1.11.19/src/guestfs.pod:966 ../src/guestfs.pod:966
39427 "The normal attach method is C<appliance>, where a small appliance is created "
39428 "containing the daemon, and then the library connects to this."
39432 #: ../libguestfs-1.11.19/src/guestfs.pod:969 ../src/guestfs.pod:969
39434 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
39435 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
39436 "daemon over the Unix domain socket."
39440 #: ../libguestfs-1.11.19/src/guestfs.pod:973 ../src/guestfs.pod:973
39442 "The normal use for this is to connect to a running virtual machine that "
39443 "contains a C<guestfsd> daemon, and send commands so you can read and write "
39444 "files inside the live virtual machine."
39448 #: ../libguestfs-1.11.19/src/guestfs.pod:977 ../src/guestfs.pod:977
39449 msgid "Using guestfs_add_domain with live flag"
39453 #: ../libguestfs-1.11.19/src/guestfs.pod:979 ../src/guestfs.pod:979
39455 "L</guestfs_add_domain> provides some help for getting the correct attach "
39456 "method. If you pass the C<live> option to this function, then (if the "
39457 "virtual machine is running) it will examine the libvirt XML looking for a "
39458 "virtio-serial channel to connect to:"
39462 #: ../libguestfs-1.11.19/src/guestfs.pod:985 ../src/guestfs.pod:985
39469 " <channel type='unix'>\n"
39470 " <source mode='bind' path='/path/to/socket'/>\n"
39471 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
39480 #: ../libguestfs-1.11.19/src/guestfs.pod:997 ../src/guestfs.pod:997
39482 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
39483 "method to C<unix:/path/to/socket>."
39487 #: ../libguestfs-1.11.19/src/guestfs.pod:1000 ../src/guestfs.pod:1000
39489 "Some of the libguestfs tools (including guestfish) support a I<--live> "
39490 "option which is passed through to L</guestfs_add_domain> thus allowing you "
39491 "to attach to and modify live virtual machines."
39495 #: ../libguestfs-1.11.19/src/guestfs.pod:1004 ../src/guestfs.pod:1004
39497 "The virtual machine needs to have been set up beforehand so that it has the "
39498 "virtio-serial channel and so that guestfsd is running inside it."
39502 #: ../libguestfs-1.11.19/src/guestfs.pod:1008 ../src/guestfs.pod:1008
39503 msgid "ABI GUARANTEE"
39507 #: ../libguestfs-1.11.19/src/guestfs.pod:1010 ../src/guestfs.pod:1010
39509 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
39510 "actions as outlined in this section. Although we will deprecate some "
39511 "actions, for example if they get replaced by newer calls, we will keep the "
39512 "old actions forever. This allows you the developer to program in confidence "
39513 "against the libguestfs API."
39517 #: ../libguestfs-1.11.19/src/guestfs.pod:1016 ../src/guestfs.pod:1016
39518 msgid "BLOCK DEVICE NAMING"
39522 #: ../libguestfs-1.11.19/src/guestfs.pod:1018 ../src/guestfs.pod:1018
39524 "In the kernel there is now quite a profusion of schemata for naming block "
39525 "devices (in this context, by I<block device> I mean a physical or virtual "
39526 "hard drive). The original Linux IDE driver used names starting with C</dev/"
39527 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
39528 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
39529 "for the old IDE driver (particularly for SATA devices) those devices also "
39530 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
39531 "paravirtualized drivers. This has created several different naming systems, "
39532 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
39536 #: ../libguestfs-1.11.19/src/guestfs.pod:1030 ../src/guestfs.pod:1030
39538 "As discussed above, libguestfs uses a qemu appliance running an embedded "
39539 "Linux kernel to access block devices. We can run a variety of appliances "
39540 "based on a variety of Linux kernels."
39544 #: ../libguestfs-1.11.19/src/guestfs.pod:1034 ../src/guestfs.pod:1034
39546 "This causes a problem for libguestfs because many API calls use device or "
39547 "partition names. Working scripts and the recipe (example) scripts that we "
39548 "make available over the internet could fail if the naming scheme changes."
39552 #: ../libguestfs-1.11.19/src/guestfs.pod:1039 ../src/guestfs.pod:1039
39554 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
39555 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
39556 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
39557 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
39561 #: ../libguestfs-1.11.19/src/guestfs.pod:1045 ../src/guestfs.pod:1045
39563 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
39564 "L</guestfs_list_partitions> and similar calls return the true names of the "
39565 "devices and partitions as known to the appliance."
39569 #: ../libguestfs-1.11.19/src/guestfs.pod:1050 ../src/guestfs.pod:1050
39570 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
39574 #: ../libguestfs-1.11.19/src/guestfs.pod:1052 ../src/guestfs.pod:1052
39576 "Usually this translation is transparent. However in some (very rare) cases "
39577 "you may need to know the exact algorithm. Such cases include where you use "
39578 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
39579 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
39583 #: ../libguestfs-1.11.19/src/guestfs.pod:1058 ../src/guestfs.pod:1058
39585 "The algorithm is applied only to I<parameters> which are known to be either "
39586 "device or partition names. Return values from functions such as L</"
39587 "guestfs_list_devices> are never changed."
39591 #: ../libguestfs-1.11.19/src/guestfs.pod:1066 ../src/guestfs.pod:1066
39592 msgid "Is the string a parameter which is a device or partition name?"
39596 #: ../libguestfs-1.11.19/src/guestfs.pod:1070 ../src/guestfs.pod:1070
39597 msgid "Does the string begin with C</dev/sd>?"
39601 #: ../libguestfs-1.11.19/src/guestfs.pod:1074 ../src/guestfs.pod:1074
39603 "Does the named device exist? If so, we use that device. However if I<not> "
39604 "then we continue with this algorithm."
39608 #: ../libguestfs-1.11.19/src/guestfs.pod:1079 ../src/guestfs.pod:1079
39609 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
39613 #: ../libguestfs-1.11.19/src/guestfs.pod:1081 ../src/guestfs.pod:1081
39614 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
39618 #: ../libguestfs-1.11.19/src/guestfs.pod:1083 ../src/guestfs.pod:1083
39619 msgid "If that named device exists, use it. If not, continue."
39623 #: ../libguestfs-1.11.19/src/guestfs.pod:1087 ../src/guestfs.pod:1087
39624 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
39628 #: ../libguestfs-1.11.19/src/guestfs.pod:1089 ../src/guestfs.pod:1089
39629 msgid "If that named device exists, use it. If not, return an error."
39633 #: ../libguestfs-1.11.19/src/guestfs.pod:1093 ../src/guestfs.pod:1093
39634 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
39638 #: ../libguestfs-1.11.19/src/guestfs.pod:1095 ../src/guestfs.pod:1095
39640 "Although the standard naming scheme and automatic translation is useful for "
39641 "simple programs and guestfish scripts, for larger programs it is best not to "
39642 "rely on this mechanism."
39646 #: ../libguestfs-1.11.19/src/guestfs.pod:1099 ../src/guestfs.pod:1099
39648 "Where possible for maximum future portability programs using libguestfs "
39649 "should use these future-proof techniques:"
39653 #: ../libguestfs-1.11.19/src/guestfs.pod:1106 ../src/guestfs.pod:1106
39655 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
39656 "device names, and then use those names directly."
39660 #: ../libguestfs-1.11.19/src/guestfs.pod:1109 ../src/guestfs.pod:1109
39662 "Since those device names exist by definition, they will never be translated."
39666 #: ../libguestfs-1.11.19/src/guestfs.pod:1114 ../src/guestfs.pod:1114
39668 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
39669 "filesystem labels."
39673 #: ../libguestfs-1.11.19/src/guestfs.pod:1119 ../src/guestfs.pod:1119
39678 #: ../libguestfs-1.11.19/src/guestfs.pod:1121 ../src/guestfs.pod:1121
39680 "This section discusses security implications of using libguestfs, "
39681 "particularly with untrusted or malicious guests or disk images."
39685 #: ../libguestfs-1.11.19/src/guestfs.pod:1124 ../src/guestfs.pod:1124
39686 msgid "GENERAL SECURITY CONSIDERATIONS"
39690 #: ../libguestfs-1.11.19/src/guestfs.pod:1126 ../src/guestfs.pod:1126
39692 "Be careful with any files or data that you download from a guest (by "
39693 "\"download\" we mean not just the L</guestfs_download> command but any "
39694 "command that reads files, filenames, directories or anything else from a "
39695 "disk image). An attacker could manipulate the data to fool your program "
39696 "into doing the wrong thing. Consider cases such as:"
39700 #: ../libguestfs-1.11.19/src/guestfs.pod:1136 ../src/guestfs.pod:1136
39701 msgid "the data (file etc) not being present"
39705 #: ../libguestfs-1.11.19/src/guestfs.pod:1140 ../src/guestfs.pod:1140
39706 msgid "being present but empty"
39710 #: ../libguestfs-1.11.19/src/guestfs.pod:1144 ../src/guestfs.pod:1144
39711 msgid "being much larger than normal"
39715 #: ../libguestfs-1.11.19/src/guestfs.pod:1148 ../src/guestfs.pod:1148
39716 msgid "containing arbitrary 8 bit data"
39720 #: ../libguestfs-1.11.19/src/guestfs.pod:1152 ../src/guestfs.pod:1152
39721 msgid "being in an unexpected character encoding"
39725 #: ../libguestfs-1.11.19/src/guestfs.pod:1156 ../src/guestfs.pod:1156
39726 msgid "containing homoglyphs."
39730 #: ../libguestfs-1.11.19/src/guestfs.pod:1160 ../src/guestfs.pod:1160
39731 msgid "SECURITY OF MOUNTING FILESYSTEMS"
39735 #: ../libguestfs-1.11.19/src/guestfs.pod:1162 ../src/guestfs.pod:1162
39737 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
39738 "(VFS) module can sometimes be escalated into exploits by deliberately "
39739 "creating a malicious, malformed filesystem. These exploits are very severe "
39740 "for two reasons. Firstly there are very many filesystem drivers in the "
39741 "kernel, and many of them are infrequently used and not much developer "
39742 "attention has been paid to the code. Linux userspace helps potential "
39743 "crackers by detecting the filesystem type and automatically choosing the "
39744 "right VFS driver, even if that filesystem type is obscure or unexpected for "
39745 "the administrator. Secondly, a kernel-level exploit is like a local root "
39746 "exploit (worse in some ways), giving immediate and total access to the "
39747 "system right down to the hardware level."
39751 #: ../libguestfs-1.11.19/src/guestfs.pod:1175 ../src/guestfs.pod:1175
39753 "That explains why you should never mount a filesystem from an untrusted "
39754 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
39755 "inside a qemu virtual machine, usually running as a non-root user. The "
39756 "attacker would need to write a filesystem which first exploited the kernel, "
39757 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
39758 "the libguestfs protocol, and finally to be as serious as the host kernel "
39759 "exploit it would need to escalate its privileges to root. This multi-step "
39760 "escalation, performed by a static piece of data, is thought to be extremely "
39761 "hard to do, although we never say 'never' about security issues."
39765 #: ../libguestfs-1.11.19/src/guestfs.pod:1186 ../src/guestfs.pod:1186
39767 "In any case callers can reduce the attack surface by forcing the filesystem "
39768 "type when mounting (use L</guestfs_mount_vfs>)."
39772 #: ../libguestfs-1.11.19/src/guestfs.pod:1189 ../src/guestfs.pod:1189
39773 msgid "PROTOCOL SECURITY"
39777 #: ../libguestfs-1.11.19/src/guestfs.pod:1191 ../src/guestfs.pod:1191
39779 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
39780 "defined upper message size. However a program that uses libguestfs must "
39781 "also take care - for example you can write a program that downloads a binary "
39782 "from a disk image and executes it locally, and no amount of protocol "
39783 "security will save you from the consequences."
39787 #: ../libguestfs-1.11.19/src/guestfs.pod:1197 ../src/guestfs.pod:1197
39788 msgid "INSPECTION SECURITY"
39792 #: ../libguestfs-1.11.19/src/guestfs.pod:1199 ../src/guestfs.pod:1199
39794 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
39795 "directly from the guest, and these could contain any 8 bit data. Callers "
39796 "should be careful to escape these before printing them to a structured file "
39797 "(for example, use HTML escaping if creating a web page)."
39801 #: ../libguestfs-1.11.19/src/guestfs.pod:1205 ../src/guestfs.pod:1205
39803 "Guest configuration may be altered in unusual ways by the administrator of "
39804 "the virtual machine, and may not reflect reality (particularly for untrusted "
39805 "or actively malicious guests). For example we parse the hostname from "
39806 "configuration files like C</etc/sysconfig/network> that we find in the "
39807 "guest, but the guest administrator can easily manipulate these files to "
39808 "provide the wrong hostname."
39812 #: ../libguestfs-1.11.19/src/guestfs.pod:1213 ../src/guestfs.pod:1213
39814 "The inspection API parses guest configuration using two external libraries: "
39815 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
39816 "designed to be robust in the face of malicious data, although denial of "
39817 "service attacks are still possible, for example with oversized configuration "
39822 #: ../libguestfs-1.11.19/src/guestfs.pod:1219 ../src/guestfs.pod:1219
39823 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
39827 #: ../libguestfs-1.11.19/src/guestfs.pod:1221 ../src/guestfs.pod:1221
39829 "Be very cautious about running commands from the guest. By running a "
39830 "command in the guest, you are giving CPU time to a binary that you do not "
39831 "control, under the same user account as the library, albeit wrapped in qemu "
39832 "virtualization. More information and alternatives can be found in the "
39833 "section L</RUNNING COMMANDS>."
39837 #: ../libguestfs-1.11.19/src/guestfs.pod:1227 ../src/guestfs.pod:1227
39838 msgid "CVE-2010-3851"
39842 #: ../libguestfs-1.11.19/src/guestfs.pod:1229 ../src/guestfs.pod:1229
39843 msgid "https://bugzilla.redhat.com/642934"
39847 #: ../libguestfs-1.11.19/src/guestfs.pod:1231 ../src/guestfs.pod:1231
39849 "This security bug concerns the automatic disk format detection that qemu "
39850 "does on disk images."
39854 #: ../libguestfs-1.11.19/src/guestfs.pod:1234 ../src/guestfs.pod:1234
39856 "A raw disk image is just the raw bytes, there is no header. Other disk "
39857 "images like qcow2 contain a special header. Qemu deals with this by looking "
39858 "for one of the known headers, and if none is found then assuming the disk "
39859 "image must be raw."
39863 #: ../libguestfs-1.11.19/src/guestfs.pod:1239 ../src/guestfs.pod:1239
39865 "This allows a guest which has been given a raw disk image to write some "
39866 "other header. At next boot (or when the disk image is accessed by "
39867 "libguestfs) qemu would do autodetection and think the disk image format was, "
39868 "say, qcow2 based on the header written by the guest."
39872 #: ../libguestfs-1.11.19/src/guestfs.pod:1244 ../src/guestfs.pod:1244
39874 "This in itself would not be a problem, but qcow2 offers many features, one "
39875 "of which is to allow a disk image to refer to another image (called the "
39876 "\"backing disk\"). It does this by placing the path to the backing disk "
39877 "into the qcow2 header. This path is not validated and could point to any "
39878 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
39879 "\"holes\" in the qcow2 disk image, which of course is completely under the "
39880 "control of the attacker."
39884 #: ../libguestfs-1.11.19/src/guestfs.pod:1252 ../src/guestfs.pod:1252
39886 "In libguestfs this is rather hard to exploit except under two circumstances:"
39890 #: ../libguestfs-1.11.19/src/guestfs.pod:1259 ../src/guestfs.pod:1259
39891 msgid "You have enabled the network or have opened the disk in write mode."
39895 #: ../libguestfs-1.11.19/src/guestfs.pod:1263 ../src/guestfs.pod:1263
39897 "You are also running untrusted code from the guest (see L</RUNNING "
39902 #: ../libguestfs-1.11.19/src/guestfs.pod:1268 ../src/guestfs.pod:1268
39904 "The way to avoid this is to specify the expected disk format when adding "
39905 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
39906 "should always do this if the disk is raw format, and it's a good idea for "
39911 #: ../libguestfs-1.11.19/src/guestfs.pod:1273 ../src/guestfs.pod:1273
39913 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
39914 "format is fetched from libvirt and passed through."
39918 #: ../libguestfs-1.11.19/src/guestfs.pod:1276 ../src/guestfs.pod:1276
39920 "For libguestfs tools, use the I<--format> command line parameter as "
39925 #: ../libguestfs-1.11.19/src/guestfs.pod:1279 ../src/guestfs.pod:1279
39926 msgid "CONNECTION MANAGEMENT"
39930 #: ../libguestfs-1.11.19/src/guestfs.pod:1281 ../src/guestfs.pod:1281
39931 msgid "guestfs_h *"
39935 #: ../libguestfs-1.11.19/src/guestfs.pod:1283 ../src/guestfs.pod:1283
39937 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
39938 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
39939 "handle and release all resources used."
39943 #: ../libguestfs-1.11.19/src/guestfs.pod:1287 ../src/guestfs.pod:1287
39945 "For information on using multiple handles and threads, see the section L</"
39946 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
39950 #: ../libguestfs-1.11.19/src/guestfs.pod:1290 ../src/guestfs.pod:1290
39951 msgid "guestfs_create"
39955 #: ../libguestfs-1.11.19/src/guestfs.pod:1292 ../src/guestfs.pod:1292
39958 " guestfs_h *guestfs_create (void);\n"
39963 #: ../libguestfs-1.11.19/src/guestfs.pod:1294 ../src/guestfs.pod:1294
39964 msgid "Create a connection handle."
39968 #: ../libguestfs-1.11.19/src/guestfs.pod:1296 ../src/guestfs.pod:1296
39970 "On success this returns a non-NULL pointer to a handle. On error it returns "
39975 #: ../libguestfs-1.11.19/src/guestfs.pod:1299 ../src/guestfs.pod:1299
39977 "You have to \"configure\" the handle after creating it. This includes "
39978 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
39979 "handle at least once."
39983 #: ../libguestfs-1.11.19/src/guestfs.pod:1303 ../src/guestfs.pod:1303
39984 msgid "After configuring the handle, you have to call L</guestfs_launch>."
39988 #: ../libguestfs-1.11.19/src/guestfs.pod:1305 ../src/guestfs.pod:1305
39990 "You may also want to configure error handling for the handle. See the L</"
39991 "ERROR HANDLING> section below."
39995 #: ../libguestfs-1.11.19/src/guestfs.pod:1308 ../src/guestfs.pod:1308
39996 msgid "guestfs_close"
40000 #: ../libguestfs-1.11.19/src/guestfs.pod:1310 ../src/guestfs.pod:1310
40003 " void guestfs_close (guestfs_h *g);\n"
40008 #: ../libguestfs-1.11.19/src/guestfs.pod:1312 ../src/guestfs.pod:1312
40009 msgid "This closes the connection handle and frees up all resources used."
40013 #: ../libguestfs-1.11.19/src/guestfs.pod:1314 ../src/guestfs.pod:1314
40015 "If autosync was set on the handle and the handle was launched, then this "
40016 "implicitly calls various functions to unmount filesystems and sync the "
40017 "disk. See L</guestfs_set_autosync> for more details."
40021 #: ../libguestfs-1.11.19/src/guestfs.pod:1318 ../src/guestfs.pod:1318
40022 msgid "If a close callback was set on the handle, then it is called."
40026 #: ../libguestfs-1.11.19/src/guestfs.pod:1320 ../src/guestfs.pod:1320
40027 msgid "ERROR HANDLING"
40031 #: ../libguestfs-1.11.19/src/guestfs.pod:1322 ../src/guestfs.pod:1322
40033 "API functions can return errors. For example, almost all functions that "
40034 "return C<int> will return C<-1> to indicate an error."
40038 #: ../libguestfs-1.11.19/src/guestfs.pod:1325 ../src/guestfs.pod:1325
40040 "Additional information is available for errors: an error message string and "
40041 "optionally an error number (errno) if the thing that failed was a system "
40046 #: ../libguestfs-1.11.19/src/guestfs.pod:1329 ../src/guestfs.pod:1329
40048 "You can get at the additional information about the last error on the handle "
40049 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
40050 "up an error handler with L</guestfs_set_error_handler>."
40054 #: ../libguestfs-1.11.19/src/guestfs.pod:1334 ../src/guestfs.pod:1334
40056 "When the handle is created, a default error handler is installed which "
40057 "prints the error message string to C<stderr>. For small short-running "
40058 "command line programs it is sufficient to do:"
40062 #: ../libguestfs-1.11.19/src/guestfs.pod:1338 ../src/guestfs.pod:1338
40065 " if (guestfs_launch (g) == -1)\n"
40066 " exit (EXIT_FAILURE);\n"
40071 #: ../libguestfs-1.11.19/src/guestfs.pod:1341 ../src/guestfs.pod:1341
40073 "since the default error handler will ensure that an error message has been "
40074 "printed to C<stderr> before the program exits."
40078 #: ../libguestfs-1.11.19/src/guestfs.pod:1344 ../src/guestfs.pod:1344
40080 "For other programs the caller will almost certainly want to install an "
40081 "alternate error handler or do error handling in-line like this:"
40085 #: ../libguestfs-1.11.19/src/guestfs.pod:1347 ../src/guestfs.pod:1347
40088 " g = guestfs_create ();\n"
40093 #: ../libguestfs-1.11.19/src/guestfs.pod:1349 ../src/guestfs.pod:1349
40096 " /* This disables the default behaviour of printing errors\n"
40098 " guestfs_set_error_handler (g, NULL, NULL);\n"
40103 #: ../libguestfs-1.11.19/src/guestfs.pod:1353 ../src/guestfs.pod:1353
40106 " if (guestfs_launch (g) == -1) {\n"
40107 " /* Examine the error message and print it etc. */\n"
40108 " char *msg = guestfs_last_error (g);\n"
40109 " int errnum = guestfs_last_errno (g);\n"
40110 " fprintf (stderr, \"%s\\n\", msg);\n"
40117 #: ../libguestfs-1.11.19/src/guestfs.pod:1361 ../src/guestfs.pod:1361
40119 "Out of memory errors are handled differently. The default action is to call "
40120 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
40121 "guestfs_set_out_of_memory_handler>."
40125 #: ../libguestfs-1.11.19/src/guestfs.pod:1365 ../src/guestfs.pod:1365
40127 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
40128 "because there is no handle if this happens there is no way to get additional "
40129 "error information. However L</guestfs_create> is supposed to be a "
40130 "lightweight operation which can only fail because of insufficient memory (it "
40131 "returns NULL in this case)."
40135 #: ../libguestfs-1.11.19/src/guestfs.pod:1371 ../src/guestfs.pod:1371
40136 msgid "guestfs_last_error"
40140 #: ../libguestfs-1.11.19/src/guestfs.pod:1373 ../src/guestfs.pod:1373
40143 " const char *guestfs_last_error (guestfs_h *g);\n"
40148 #: ../libguestfs-1.11.19/src/guestfs.pod:1375 ../src/guestfs.pod:1375
40150 "This returns the last error message that happened on C<g>. If there has not "
40151 "been an error since the handle was created, then this returns C<NULL>."
40155 #: ../libguestfs-1.11.19/src/guestfs.pod:1379 ../src/guestfs.pod:1379
40157 "The lifetime of the returned string is until the next error occurs, or L</"
40158 "guestfs_close> is called."
40162 #: ../libguestfs-1.11.19/src/guestfs.pod:1382 ../src/guestfs.pod:1382
40163 msgid "guestfs_last_errno"
40167 #: ../libguestfs-1.11.19/src/guestfs.pod:1384 ../src/guestfs.pod:1384
40170 " int guestfs_last_errno (guestfs_h *g);\n"
40175 #: ../libguestfs-1.11.19/src/guestfs.pod:1386 ../src/guestfs.pod:1386
40176 msgid "This returns the last error number (errno) that happened on C<g>."
40180 #: ../libguestfs-1.11.19/src/guestfs.pod:1388 ../src/guestfs.pod:1388
40181 msgid "If successful, an errno integer not equal to zero is returned."
40185 #: ../libguestfs-1.11.19/src/guestfs.pod:1390 ../src/guestfs.pod:1390
40187 "If no error, this returns 0. This call can return 0 in three situations:"
40191 #: ../libguestfs-1.11.19/src/guestfs.pod:1397 ../src/guestfs.pod:1397
40192 msgid "There has not been any error on the handle."
40196 #: ../libguestfs-1.11.19/src/guestfs.pod:1401 ../src/guestfs.pod:1401
40198 "There has been an error but the errno was meaningless. This corresponds to "
40199 "the case where the error did not come from a failed system call, but for "
40200 "some other reason."
40204 #: ../libguestfs-1.11.19/src/guestfs.pod:1407 ../src/guestfs.pod:1407
40206 "There was an error from a failed system call, but for some reason the errno "
40207 "was not captured and returned. This usually indicates a bug in libguestfs."
40211 #: ../libguestfs-1.11.19/src/guestfs.pod:1413 ../src/guestfs.pod:1413
40213 "Libguestfs tries to convert the errno from inside the applicance into a "
40214 "corresponding errno for the caller (not entirely trivial: the appliance "
40215 "might be running a completely different operating system from the library "
40216 "and error numbers are not standardized across Un*xen). If this could not be "
40217 "done, then the error is translated to C<EINVAL>. In practice this should "
40218 "only happen in very rare circumstances."
40222 #: ../libguestfs-1.11.19/src/guestfs.pod:1421 ../src/guestfs.pod:1421
40223 msgid "guestfs_set_error_handler"
40227 #: ../libguestfs-1.11.19/src/guestfs.pod:1423 ../src/guestfs.pod:1423
40230 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
40232 " const char *msg);\n"
40233 " void guestfs_set_error_handler (guestfs_h *g,\n"
40234 " guestfs_error_handler_cb cb,\n"
40235 " void *opaque);\n"
40240 #: ../libguestfs-1.11.19/src/guestfs.pod:1430 ../src/guestfs.pod:1430
40242 "The callback C<cb> will be called if there is an error. The parameters "
40243 "passed to the callback are an opaque data pointer and the error message "
40248 #: ../libguestfs-1.11.19/src/guestfs.pod:1434 ../src/guestfs.pod:1434
40250 "C<errno> is not passed to the callback. To get that the callback must call "
40251 "L</guestfs_last_errno>."
40255 #: ../libguestfs-1.11.19/src/guestfs.pod:1437 ../src/guestfs.pod:1437
40257 "Note that the message string C<msg> is freed as soon as the callback "
40258 "function returns, so if you want to stash it somewhere you must make your "
40263 #: ../libguestfs-1.11.19/src/guestfs.pod:1441 ../src/guestfs.pod:1441
40264 msgid "The default handler prints messages on C<stderr>."
40268 #: ../libguestfs-1.11.19/src/guestfs.pod:1443 ../src/guestfs.pod:1443
40269 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
40273 #: ../libguestfs-1.11.19/src/guestfs.pod:1445 ../src/guestfs.pod:1445
40274 msgid "guestfs_get_error_handler"
40278 #: ../libguestfs-1.11.19/src/guestfs.pod:1447 ../src/guestfs.pod:1447
40281 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
40282 " void **opaque_rtn);\n"
40287 #: ../libguestfs-1.11.19/src/guestfs.pod:1450 ../src/guestfs.pod:1450
40288 msgid "Returns the current error handler callback."
40292 #: ../libguestfs-1.11.19/src/guestfs.pod:1452 ../src/guestfs.pod:1452
40293 msgid "guestfs_set_out_of_memory_handler"
40297 #: ../libguestfs-1.11.19/src/guestfs.pod:1454 ../src/guestfs.pod:1454
40300 " typedef void (*guestfs_abort_cb) (void);\n"
40301 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
40302 " guestfs_abort_cb);\n"
40307 #: ../libguestfs-1.11.19/src/guestfs.pod:1458 ../src/guestfs.pod:1458
40309 "The callback C<cb> will be called if there is an out of memory situation. "
40310 "I<Note this callback must not return>."
40314 #: ../libguestfs-1.11.19/src/guestfs.pod:1461 ../src/guestfs.pod:1461
40315 msgid "The default is to call L<abort(3)>."
40319 #: ../libguestfs-1.11.19/src/guestfs.pod:1463 ../src/guestfs.pod:1463
40321 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
40325 #: ../libguestfs-1.11.19/src/guestfs.pod:1466 ../src/guestfs.pod:1466
40326 msgid "guestfs_get_out_of_memory_handler"
40330 #: ../libguestfs-1.11.19/src/guestfs.pod:1468 ../src/guestfs.pod:1468
40333 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
40338 #: ../libguestfs-1.11.19/src/guestfs.pod:1470 ../src/guestfs.pod:1470
40339 msgid "This returns the current out of memory handler."
40343 #: ../libguestfs-1.11.19/src/guestfs.pod:1472 ../src/guestfs.pod:1472
40348 #: ../libguestfs-1.11.19/src/guestfs.pod:1476 ../src/guestfs.pod:1476
40353 #: ../libguestfs-1.11.19/src/guestfs.pod:1478 ../src/guestfs.pod:1478
40358 #: ../libguestfs-1.11.19/src/guestfs.pod:1480 ../src/guestfs.pod:1480
40359 msgid "AVAILABILITY"
40363 #: ../libguestfs-1.11.19/src/guestfs.pod:1482 ../src/guestfs.pod:1482
40364 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
40368 #: ../libguestfs-1.11.19/src/guestfs.pod:1484 ../src/guestfs.pod:1484
40370 "Using L</guestfs_available> you can test availability of the following "
40371 "groups of functions. This test queries the appliance to see if the "
40372 "appliance you are currently using supports the functionality."
40376 #: ../libguestfs-1.11.19/src/guestfs.pod:1489 ../src/guestfs.pod:1489
40377 msgid "@AVAILABILITY@"
40381 #: ../libguestfs-1.11.19/src/guestfs.pod:1491 ../src/guestfs.pod:1491
40382 msgid "GUESTFISH supported COMMAND"
40386 #: ../libguestfs-1.11.19/src/guestfs.pod:1493 ../src/guestfs.pod:1493
40388 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
40389 "prints out the available groups and whether they are supported by this build "
40390 "of libguestfs. Note however that you have to do C<run> first."
40394 #: ../libguestfs-1.11.19/src/guestfs.pod:1498 ../src/guestfs.pod:1498
40395 msgid "SINGLE CALLS AT COMPILE TIME"
40399 #: ../libguestfs-1.11.19/src/guestfs.pod:1500 ../src/guestfs.pod:1500
40401 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
40402 "function, such as:"
40406 #: ../libguestfs-1.11.19/src/guestfs.pod:1503 ../src/guestfs.pod:1503
40409 " #define LIBGUESTFS_HAVE_DD 1\n"
40414 #: ../libguestfs-1.11.19/src/guestfs.pod:1505 ../src/guestfs.pod:1505
40415 msgid "if L</guestfs_dd> is available."
40419 #: ../libguestfs-1.11.19/src/guestfs.pod:1507 ../src/guestfs.pod:1507
40421 "Before version 1.5.8, if you needed to test whether a single libguestfs "
40422 "function is available at compile time, we recommended using build tools such "
40423 "as autoconf or cmake. For example in autotools you could use:"
40427 #: ../libguestfs-1.11.19/src/guestfs.pod:1512 ../src/guestfs.pod:1512
40430 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
40431 " AC_CHECK_FUNCS([guestfs_dd])\n"
40436 #: ../libguestfs-1.11.19/src/guestfs.pod:1515 ../src/guestfs.pod:1515
40438 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
40443 #: ../libguestfs-1.11.19/src/guestfs.pod:1518 ../src/guestfs.pod:1518
40444 msgid "SINGLE CALLS AT RUN TIME"
40448 #: ../libguestfs-1.11.19/src/guestfs.pod:1520 ../src/guestfs.pod:1520
40450 "Testing at compile time doesn't guarantee that a function really exists in "
40451 "the library. The reason is that you might be dynamically linked against a "
40452 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
40453 "This situation unfortunately results in a segmentation fault, which is a "
40454 "shortcoming of the C dynamic linking system itself."
40458 #: ../libguestfs-1.11.19/src/guestfs.pod:1527 ../src/guestfs.pod:1527
40460 "You can use L<dlopen(3)> to test if a function is available at run time, as "
40461 "in this example program (note that you still need the compile time check as "
40466 #: ../libguestfs-1.11.19/src/guestfs.pod:1531 ../src/guestfs.pod:1531
40469 " #include <stdio.h>\n"
40470 " #include <stdlib.h>\n"
40471 " #include <unistd.h>\n"
40472 " #include <dlfcn.h>\n"
40473 " #include <guestfs.h>\n"
40478 #: ../libguestfs-1.11.19/src/guestfs.pod:1537 ../src/guestfs.pod:1537
40483 " #ifdef LIBGUESTFS_HAVE_DD\n"
40485 " int has_function;\n"
40490 #: ../libguestfs-1.11.19/src/guestfs.pod:1543 ../src/guestfs.pod:1543
40493 " /* Test if the function guestfs_dd is really available. */\n"
40494 " dl = dlopen (NULL, RTLD_LAZY);\n"
40496 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
40497 " exit (EXIT_FAILURE);\n"
40499 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
40505 #: ../libguestfs-1.11.19/src/guestfs.pod:1552 ../src/guestfs.pod:1552
40508 " if (!has_function)\n"
40509 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
40511 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
40512 " /* Now it's safe to call\n"
40513 " guestfs_dd (g, \"foo\", \"bar\");\n"
40517 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
40524 #: ../libguestfs-1.11.19/src/guestfs.pod:1565 ../src/guestfs.pod:1565
40526 "You may think the above is an awful lot of hassle, and it is. There are "
40527 "other ways outside of the C linking system to ensure that this kind of "
40528 "incompatibility never arises, such as using package versioning:"
40532 #: ../libguestfs-1.11.19/src/guestfs.pod:1570 ../src/guestfs.pod:1570
40535 " Requires: libguestfs >= 1.0.80\n"
40540 #: ../libguestfs-1.11.19/src/guestfs.pod:1572 ../src/guestfs.pod:1572
40541 msgid "CALLS WITH OPTIONAL ARGUMENTS"
40545 #: ../libguestfs-1.11.19/src/guestfs.pod:1574 ../src/guestfs.pod:1574
40547 "A recent feature of the API is the introduction of calls which take optional "
40548 "arguments. In C these are declared 3 ways. The main way is as a call which "
40549 "takes variable arguments (ie. C<...>), as in this example:"
40553 #: ../libguestfs-1.11.19/src/guestfs.pod:1579 ../src/guestfs.pod:1579
40556 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
40561 #: ../libguestfs-1.11.19/src/guestfs.pod:1581 ../src/guestfs.pod:1581
40563 "Call this with a list of optional arguments, terminated by C<-1>. So to "
40564 "call with no optional arguments specified:"
40568 #: ../libguestfs-1.11.19/src/guestfs.pod:1584 ../src/guestfs.pod:1584
40571 " guestfs_add_drive_opts (g, filename, -1);\n"
40576 #: ../libguestfs-1.11.19/src/guestfs.pod:1586 ../src/guestfs.pod:1586
40577 msgid "With a single optional argument:"
40581 #: ../libguestfs-1.11.19/src/guestfs.pod:1588 ../src/guestfs.pod:1588
40584 " guestfs_add_drive_opts (g, filename,\n"
40585 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
40591 #: ../libguestfs-1.11.19/src/guestfs.pod:1592 ../src/guestfs.pod:1592
40596 #: ../libguestfs-1.11.19/src/guestfs.pod:1594 ../src/guestfs.pod:1594
40599 " guestfs_add_drive_opts (g, filename,\n"
40600 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
40601 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
40607 #: ../libguestfs-1.11.19/src/guestfs.pod:1599 ../src/guestfs.pod:1599
40609 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
40614 #: ../libguestfs-1.11.19/src/guestfs.pod:1602 ../src/guestfs.pod:1602
40615 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
40619 #: ../libguestfs-1.11.19/src/guestfs.pod:1604 ../src/guestfs.pod:1604
40621 "The second variant has the same name with the suffix C<_va>, which works the "
40622 "same way but takes a C<va_list>. See the C manual for details. For the "
40623 "example function, this is declared:"
40627 #: ../libguestfs-1.11.19/src/guestfs.pod:1608 ../src/guestfs.pod:1608
40630 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
40631 " va_list args);\n"
40636 #: ../libguestfs-1.11.19/src/guestfs.pod:1611 ../src/guestfs.pod:1611
40637 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
40641 #: ../libguestfs-1.11.19/src/guestfs.pod:1613 ../src/guestfs.pod:1613
40643 "The third variant is useful where you need to construct these calls. You "
40644 "pass in a structure where you fill in the optional fields. The structure "
40645 "has a bitmask as the first element which you must set to indicate which "
40646 "fields you have filled in. For our example function the structure and call "
40651 #: ../libguestfs-1.11.19/src/guestfs.pod:1619 ../src/guestfs.pod:1619
40654 " struct guestfs_add_drive_opts_argv {\n"
40655 " uint64_t bitmask;\n"
40657 " const char *format;\n"
40660 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
40661 " const struct guestfs_add_drive_opts_argv *optargs);\n"
40666 #: ../libguestfs-1.11.19/src/guestfs.pod:1628 ../src/guestfs.pod:1628
40667 msgid "You could call it like this:"
40671 #: ../libguestfs-1.11.19/src/guestfs.pod:1630 ../src/guestfs.pod:1630
40674 " struct guestfs_add_drive_opts_argv optargs = {\n"
40675 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
40676 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
40677 " .readonly = 1,\n"
40678 " .format = \"qcow2\"\n"
40684 #: ../libguestfs-1.11.19/src/guestfs.pod:1637 ../src/guestfs.pod:1637
40687 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
40692 #: ../libguestfs-1.11.19/src/guestfs.pod:1645 ../src/guestfs.pod:1645
40693 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
40697 #: ../libguestfs-1.11.19/src/guestfs.pod:1650 ../src/guestfs.pod:1650
40698 msgid "You do not need to fill in all fields of the structure."
40702 #: ../libguestfs-1.11.19/src/guestfs.pod:1654 ../src/guestfs.pod:1654
40704 "There must be a one-to-one correspondence between fields of the structure "
40705 "that are filled in, and bits set in the bitmask."
40709 #: ../libguestfs-1.11.19/src/guestfs.pod:1659 ../src/guestfs.pod:1659
40710 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
40714 #: ../libguestfs-1.11.19/src/guestfs.pod:1661 ../src/guestfs.pod:1661
40716 "In other languages, optional arguments are expressed in the way that is "
40717 "natural for that language. We refer you to the language-specific "
40718 "documentation for more details on that."
40722 #: ../libguestfs-1.11.19/src/guestfs.pod:1665 ../src/guestfs.pod:1665
40723 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
40727 #: ../libguestfs-1.11.19/src/guestfs.pod:1667 ../src/guestfs.pod:1667
40728 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
40732 #: ../libguestfs-1.11.19/src/guestfs.pod:1669 ../src/guestfs.pod:1669
40734 "B<Note:> This section documents the generic event mechanism introduced in "
40735 "libguestfs 1.10, which you should use in new code if possible. The old "
40736 "functions C<guestfs_set_log_message_callback>, "
40737 "C<guestfs_set_subprocess_quit_callback>, "
40738 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
40739 "C<guestfs_set_progress_callback> are no longer documented in this manual "
40740 "page. Because of the ABI guarantee, the old functions continue to work."
40744 #: ../libguestfs-1.11.19/src/guestfs.pod:1678 ../src/guestfs.pod:1678
40746 "Handles generate events when certain things happen, such as log messages "
40747 "being generated, progress messages during long-running operations, or the "
40748 "handle being closed. The API calls described below let you register a "
40749 "callback to be called when events happen. You can register multiple "
40750 "callbacks (for the same, different or overlapping sets of events), and "
40751 "individually remove callbacks. If callbacks are not removed, then they "
40752 "remain in force until the handle is closed."
40756 #: ../libguestfs-1.11.19/src/guestfs.pod:1686 ../src/guestfs.pod:1686
40758 "In the current implementation, events are only generated synchronously: that "
40759 "means that events (and hence callbacks) can only happen while you are in the "
40760 "middle of making another libguestfs call. The callback is called in the "
40765 #: ../libguestfs-1.11.19/src/guestfs.pod:1691 ../src/guestfs.pod:1691
40767 "Events may contain a payload, usually nothing (void), an array of 64 bit "
40768 "unsigned integers, or a message buffer. Payloads are discussed later on."
40772 #: ../libguestfs-1.11.19/src/guestfs.pod:1695 ../src/guestfs.pod:1695
40773 msgid "CLASSES OF EVENTS"
40777 #: ../libguestfs-1.11.19/src/guestfs.pod:1699 ../src/guestfs.pod:1699
40778 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
40782 #: ../libguestfs-1.11.19/src/guestfs.pod:1702 ../src/guestfs.pod:1702
40784 "The callback function will be called while the handle is being closed "
40785 "(synchronously from L</guestfs_close>)."
40789 #: ../libguestfs-1.11.19/src/guestfs.pod:1705 ../src/guestfs.pod:1705
40791 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
40792 "handles that are open when the program exits. This means that this callback "
40793 "might be called indirectly from L<exit(3)>, which can cause unexpected "
40794 "problems in higher-level languages (eg. if your HLL interpreter has already "
40795 "been cleaned up by the time this is called, and if your callback then jumps "
40796 "into some HLL function)."
40800 #: ../libguestfs-1.11.19/src/guestfs.pod:1712 ../src/guestfs.pod:1712
40802 "If no callback is registered: the handle is closed without any callback "
40807 #: ../libguestfs-1.11.19/src/guestfs.pod:1715 ../src/guestfs.pod:1715
40808 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
40812 #: ../libguestfs-1.11.19/src/guestfs.pod:1718 ../src/guestfs.pod:1718
40814 "The callback function will be called when the child process quits, either "
40815 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
40816 "corresponds to a transition from any state to the CONFIG state)."
40820 #: ../libguestfs-1.11.19/src/guestfs.pod:1722
40821 #: ../libguestfs-1.11.19/src/guestfs.pod:1731 ../src/guestfs.pod:1722
40822 #: ../src/guestfs.pod:1731
40823 msgid "If no callback is registered: the event is ignored."
40827 #: ../libguestfs-1.11.19/src/guestfs.pod:1724 ../src/guestfs.pod:1724
40828 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
40832 #: ../libguestfs-1.11.19/src/guestfs.pod:1727 ../src/guestfs.pod:1727
40834 "The callback function will be called when the child process becomes ready "
40835 "first time after it has been launched. (This corresponds to a transition "
40836 "from LAUNCHING to the READY state)."
40840 #: ../libguestfs-1.11.19/src/guestfs.pod:1733 ../src/guestfs.pod:1733
40841 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
40845 #: ../libguestfs-1.11.19/src/guestfs.pod:1736 ../src/guestfs.pod:1736
40847 "Some long-running operations can generate progress messages. If this "
40848 "callback is registered, then it will be called each time a progress message "
40849 "is generated (usually two seconds after the operation started, and three "
40850 "times per second thereafter until it completes, although the frequency may "
40851 "change in future versions)."
40855 #: ../libguestfs-1.11.19/src/guestfs.pod:1742 ../src/guestfs.pod:1742
40857 "The callback receives in the payload four unsigned 64 bit numbers which are "
40858 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
40862 #: ../libguestfs-1.11.19/src/guestfs.pod:1745 ../src/guestfs.pod:1745
40864 "The units of C<total> are not defined, although for some operations C<total> "
40865 "may relate in some way to the amount of data to be transferred (eg. in bytes "
40866 "or megabytes), and C<position> may be the portion which has been transferred."
40870 #: ../libguestfs-1.11.19/src/guestfs.pod:1750 ../src/guestfs.pod:1750
40871 msgid "The only defined and stable parts of the API are:"
40875 #: ../libguestfs-1.11.19/src/guestfs.pod:1756 ../src/guestfs.pod:1756
40877 "The callback can display to the user some type of progress bar or indicator "
40878 "which shows the ratio of C<position>:C<total>."
40882 #: ../libguestfs-1.11.19/src/guestfs.pod:1761 ../src/guestfs.pod:1761
40883 msgid "0 E<lt>= C<position> E<lt>= C<total>"
40887 #: ../libguestfs-1.11.19/src/guestfs.pod:1765 ../src/guestfs.pod:1765
40889 "If any progress notification is sent during a call, then a final progress "
40890 "notification is always sent when C<position> = C<total> (I<unless> the call "
40891 "fails with an error)."
40895 #: ../libguestfs-1.11.19/src/guestfs.pod:1769 ../src/guestfs.pod:1769
40897 "This is to simplify caller code, so callers can easily set the progress "
40898 "indicator to \"100%\" at the end of the operation, without requiring special "
40899 "code to detect this case."
40903 #: ../libguestfs-1.11.19/src/guestfs.pod:1775 ../src/guestfs.pod:1775
40905 "For some calls we are unable to estimate the progress of the call, but we "
40906 "can still generate progress messages to indicate activity. This is known as "
40907 "\"pulse mode\", and is directly supported by certain progress bar "
40908 "implementations (eg. GtkProgressBar)."
40912 #: ../libguestfs-1.11.19/src/guestfs.pod:1780 ../src/guestfs.pod:1780
40914 "For these calls, zero or more progress messages are generated with "
40915 "C<position = 0> and C<total = 1>, followed by a final message with "
40916 "C<position = total = 1>."
40920 #: ../libguestfs-1.11.19/src/guestfs.pod:1784 ../src/guestfs.pod:1784
40922 "As noted above, if the call fails with an error then the final message may "
40923 "not be generated."
40927 #: ../libguestfs-1.11.19/src/guestfs.pod:1789 ../src/guestfs.pod:1789
40929 "The callback also receives the procedure number (C<proc_nr>) and serial "
40930 "number (C<serial>) of the call. These are only useful for debugging "
40931 "protocol issues, and the callback can normally ignore them. The callback "
40932 "may want to print these numbers in error messages or debugging messages."
40936 #: ../libguestfs-1.11.19/src/guestfs.pod:1795 ../src/guestfs.pod:1795
40937 msgid "If no callback is registered: progress messages are discarded."
40941 #: ../libguestfs-1.11.19/src/guestfs.pod:1797 ../src/guestfs.pod:1797
40942 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
40946 #: ../libguestfs-1.11.19/src/guestfs.pod:1800 ../src/guestfs.pod:1800
40948 "The callback function is called whenever a log message is generated by qemu, "
40949 "the appliance kernel, guestfsd (daemon), or utility programs."
40953 #: ../libguestfs-1.11.19/src/guestfs.pod:1803 ../src/guestfs.pod:1803
40955 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
40956 "guestfs_launch>) then additional debug messages are generated."
40960 #: ../libguestfs-1.11.19/src/guestfs.pod:1806
40961 #: ../libguestfs-1.11.19/src/guestfs.pod:1820 ../src/guestfs.pod:1806
40962 #: ../src/guestfs.pod:1820
40964 "If no callback is registered: the messages are discarded unless the verbose "
40965 "flag is set in which case they are sent to stderr. You can override the "
40966 "printing of verbose messages to stderr by setting up a callback."
40970 #: ../libguestfs-1.11.19/src/guestfs.pod:1811 ../src/guestfs.pod:1811
40971 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
40975 #: ../libguestfs-1.11.19/src/guestfs.pod:1814 ../src/guestfs.pod:1814
40977 "The callback function is called whenever a log message is generated by the "
40978 "library part of libguestfs."
40982 #: ../libguestfs-1.11.19/src/guestfs.pod:1817 ../src/guestfs.pod:1817
40984 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
40985 "messages are generated."
40989 #: ../libguestfs-1.11.19/src/guestfs.pod:1825 ../src/guestfs.pod:1825
40990 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
40994 #: ../libguestfs-1.11.19/src/guestfs.pod:1828 ../src/guestfs.pod:1828
40996 "The callback function is called whenever a trace message is generated. This "
40997 "only applies if the trace flag (L</guestfs_set_trace>) is set."
41001 #: ../libguestfs-1.11.19/src/guestfs.pod:1831 ../src/guestfs.pod:1831
41003 "If no callback is registered: the messages are sent to stderr. You can "
41004 "override the printing of trace messages to stderr by setting up a callback."
41008 #: ../libguestfs-1.11.19/src/guestfs.pod:1837 ../src/guestfs.pod:1837
41009 msgid "guestfs_set_event_callback"
41013 #: ../libguestfs-1.11.19/src/guestfs.pod:1839 ../src/guestfs.pod:1839
41016 " int guestfs_set_event_callback (guestfs_h *g,\n"
41017 " guestfs_event_callback cb,\n"
41018 " uint64_t event_bitmask,\n"
41020 " void *opaque);\n"
41025 #: ../libguestfs-1.11.19/src/guestfs.pod:1845 ../src/guestfs.pod:1845
41027 "This function registers a callback (C<cb>) for all event classes in the "
41028 "C<event_bitmask>."
41032 #: ../libguestfs-1.11.19/src/guestfs.pod:1848 ../src/guestfs.pod:1848
41034 "For example, to register for all log message events, you could call this "
41035 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
41036 "To register a single callback for all possible classes of events, use "
41037 "C<GUESTFS_EVENT_ALL>."
41041 #: ../libguestfs-1.11.19/src/guestfs.pod:1854 ../src/guestfs.pod:1854
41042 msgid "C<flags> should always be passed as 0."
41046 #: ../libguestfs-1.11.19/src/guestfs.pod:1856 ../src/guestfs.pod:1856
41048 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
41049 "it for any purpose."
41053 #: ../libguestfs-1.11.19/src/guestfs.pod:1859 ../src/guestfs.pod:1859
41055 "The return value is the event handle (an integer) which you can use to "
41056 "delete the callback (see below)."
41060 #: ../libguestfs-1.11.19/src/guestfs.pod:1862 ../src/guestfs.pod:1862
41062 "If there is an error, this function returns C<-1>, and sets the error in the "
41063 "handle in the usual way (see L</guestfs_last_error> etc.)"
41067 #: ../libguestfs-1.11.19/src/guestfs.pod:1865 ../src/guestfs.pod:1865
41069 "Callbacks remain in effect until they are deleted, or until the handle is "
41074 #: ../libguestfs-1.11.19/src/guestfs.pod:1868 ../src/guestfs.pod:1868
41076 "In the case where multiple callbacks are registered for a particular event "
41077 "class, all of the callbacks are called. The order in which multiple "
41078 "callbacks are called is not defined."
41082 #: ../libguestfs-1.11.19/src/guestfs.pod:1872 ../src/guestfs.pod:1872
41083 msgid "guestfs_delete_event_callback"
41087 #: ../libguestfs-1.11.19/src/guestfs.pod:1874 ../src/guestfs.pod:1874
41090 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
41095 #: ../libguestfs-1.11.19/src/guestfs.pod:1876 ../src/guestfs.pod:1876
41097 "Delete a callback that was previously registered. C<event_handle> should be "
41098 "the integer that was returned by a previous call to "
41099 "C<guestfs_set_event_callback> on the same handle."
41103 #: ../libguestfs-1.11.19/src/guestfs.pod:1880 ../src/guestfs.pod:1880
41104 msgid "guestfs_event_callback"
41108 #: ../libguestfs-1.11.19/src/guestfs.pod:1882 ../src/guestfs.pod:1882
41111 " typedef void (*guestfs_event_callback) (\n"
41114 " uint64_t event,\n"
41115 " int event_handle,\n"
41117 " const char *buf, size_t buf_len,\n"
41118 " const uint64_t *array, size_t array_len);\n"
41123 #: ../libguestfs-1.11.19/src/guestfs.pod:1891 ../src/guestfs.pod:1891
41125 "This is the type of the event callback function that you have to provide."
41129 #: ../libguestfs-1.11.19/src/guestfs.pod:1894 ../src/guestfs.pod:1894
41131 "The basic parameters are: the handle (C<g>), the opaque user pointer "
41132 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
41133 "handle, and C<flags> which in the current API you should ignore."
41137 #: ../libguestfs-1.11.19/src/guestfs.pod:1898 ../src/guestfs.pod:1898
41139 "The remaining parameters contain the event payload (if any). Each event may "
41140 "contain a payload, which usually relates to the event class, but for future "
41141 "proofing your code should be written to handle any payload for any event "
41146 #: ../libguestfs-1.11.19/src/guestfs.pod:1903 ../src/guestfs.pod:1903
41148 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
41149 "there is no message buffer). Note that this message buffer can contain "
41150 "arbitrary 8 bit data, including NUL bytes."
41154 #: ../libguestfs-1.11.19/src/guestfs.pod:1907 ../src/guestfs.pod:1907
41156 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
41157 "moment this is only used for progress messages."
41161 #: ../libguestfs-1.11.19/src/guestfs.pod:1910 ../src/guestfs.pod:1910
41162 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
41166 #: ../libguestfs-1.11.19/src/guestfs.pod:1912 ../src/guestfs.pod:1912
41168 "One motivation for the generic event API was to allow GUI programs to "
41169 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
41170 "unconditionally to C<stderr>."
41174 #: ../libguestfs-1.11.19/src/guestfs.pod:1916 ../src/guestfs.pod:1916
41176 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
41177 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
41178 "messages are not events; you must capture error messages separately)."
41182 #: ../libguestfs-1.11.19/src/guestfs.pod:1921 ../src/guestfs.pod:1921
41184 "Programs have to set up a callback to capture the classes of events of "
41189 #: ../libguestfs-1.11.19/src/guestfs.pod:1924 ../src/guestfs.pod:1924
41193 " guestfs_set_event_callback\n"
41194 " (g, message_callback,\n"
41195 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
41196 " GUESTFS_EVENT_TRACE,\n"
41197 " 0, NULL) == -1)\n"
41198 " if (eh == -1) {\n"
41199 " // handle error in the usual way\n"
41205 #: ../libguestfs-1.11.19/src/guestfs.pod:1934 ../src/guestfs.pod:1934
41207 "The callback can then direct messages to the appropriate place. In this "
41208 "example, messages are directed to syslog:"
41212 #: ../libguestfs-1.11.19/src/guestfs.pod:1937 ../src/guestfs.pod:1937
41216 " message_callback (\n"
41219 " uint64_t event,\n"
41220 " int event_handle,\n"
41222 " const char *buf, size_t buf_len,\n"
41223 " const uint64_t *array, size_t array_len)\n"
41225 " const int priority = LOG_USER|LOG_INFO;\n"
41226 " if (buf_len > 0)\n"
41227 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
41233 #: ../libguestfs-1.11.19/src/guestfs.pod:1952 ../src/guestfs.pod:1952
41234 msgid "CANCELLING LONG TRANSFERS"
41238 #: ../libguestfs-1.11.19/src/guestfs.pod:1954 ../src/guestfs.pod:1954
41240 "Some operations can be cancelled by the caller while they are in progress. "
41241 "Currently only operations that involve uploading or downloading data can be "
41242 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
41243 "parameters in the generator)."
41247 #: ../libguestfs-1.11.19/src/guestfs.pod:1959 ../src/guestfs.pod:1959
41248 msgid "guestfs_user_cancel"
41252 #: ../libguestfs-1.11.19/src/guestfs.pod:1961 ../src/guestfs.pod:1961
41255 " void guestfs_user_cancel (guestfs_h *g);\n"
41260 #: ../libguestfs-1.11.19/src/guestfs.pod:1963 ../src/guestfs.pod:1963
41262 "C<guestfs_user_cancel> cancels the current upload or download operation."
41266 #: ../libguestfs-1.11.19/src/guestfs.pod:1966 ../src/guestfs.pod:1966
41268 "Unlike most other libguestfs calls, this function is signal safe and thread "
41269 "safe. You can call it from a signal handler or from another thread, without "
41270 "needing to do any locking."
41274 #: ../libguestfs-1.11.19/src/guestfs.pod:1970 ../src/guestfs.pod:1970
41276 "The transfer that was in progress (if there is one) will stop shortly "
41277 "afterwards, and will return an error. The errno (see L</"
41278 "guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
41279 "out if the operation was cancelled or failed because of another error."
41283 #: ../libguestfs-1.11.19/src/guestfs.pod:1976 ../src/guestfs.pod:1976
41285 "No cleanup is performed: for example, if a file was being uploaded then "
41286 "after cancellation there may be a partially uploaded file. It is the "
41287 "caller's responsibility to clean up if necessary."
41291 #: ../libguestfs-1.11.19/src/guestfs.pod:1980 ../src/guestfs.pod:1980
41292 msgid "There are two common places that you might call C<guestfs_user_cancel>."
41296 #: ../libguestfs-1.11.19/src/guestfs.pod:1982 ../src/guestfs.pod:1982
41298 "In an interactive text-based program, you might call it from a C<SIGINT> "
41299 "signal handler so that pressing C<^C> cancels the current operation. (You "
41300 "also need to call L</guestfs_set_pgroup> so that child processes don't "
41301 "receive the C<^C> signal)."
41305 #: ../libguestfs-1.11.19/src/guestfs.pod:1987 ../src/guestfs.pod:1987
41307 "In a graphical program, when the main thread is displaying a progress bar "
41308 "with a cancel button, wire up the cancel button to call this function."
41312 #: ../libguestfs-1.11.19/src/guestfs.pod:1991 ../src/guestfs.pod:1991
41313 msgid "PRIVATE DATA AREA"
41317 #: ../libguestfs-1.11.19/src/guestfs.pod:1993 ../src/guestfs.pod:1993
41319 "You can attach named pieces of private data to the libguestfs handle, fetch "
41320 "them by name, and walk over them, for the lifetime of the handle. This is "
41321 "called the private data area and is only available from the C API."
41325 #: ../libguestfs-1.11.19/src/guestfs.pod:1998 ../src/guestfs.pod:1998
41326 msgid "To attach a named piece of data, use the following call:"
41330 #: ../libguestfs-1.11.19/src/guestfs.pod:2000 ../src/guestfs.pod:2000
41333 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
41338 #: ../libguestfs-1.11.19/src/guestfs.pod:2002 ../src/guestfs.pod:2002
41340 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
41341 "pointer (which can be C<NULL>). Any previous item with the same key is "
41346 #: ../libguestfs-1.11.19/src/guestfs.pod:2006 ../src/guestfs.pod:2006
41348 "You can use any C<key> you want, but your key should I<not> start with an "
41349 "underscore character. Keys beginning with an underscore character are "
41350 "reserved for internal libguestfs purposes (eg. for implementing language "
41351 "bindings). It is recommended that you prefix the key with some unique "
41352 "string to avoid collisions with other users."
41356 #: ../libguestfs-1.11.19/src/guestfs.pod:2012 ../src/guestfs.pod:2012
41357 msgid "To retrieve the pointer, use:"
41361 #: ../libguestfs-1.11.19/src/guestfs.pod:2014 ../src/guestfs.pod:2014
41364 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
41369 #: ../libguestfs-1.11.19/src/guestfs.pod:2016 ../src/guestfs.pod:2016
41371 "This function returns C<NULL> if either no data is found associated with "
41372 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
41377 #: ../libguestfs-1.11.19/src/guestfs.pod:2020 ../src/guestfs.pod:2020
41379 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
41380 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
41381 "all. In particular, libguestfs does I<not> try to free the data when the "
41382 "handle is closed. If the data must be freed, then the caller must either "
41383 "free it before calling L</guestfs_close> or must set up a close callback to "
41384 "do it (see L</GUESTFS_EVENT_CLOSE>)."
41388 #: ../libguestfs-1.11.19/src/guestfs.pod:2027 ../src/guestfs.pod:2027
41389 msgid "To walk over all entries, use these two functions:"
41393 #: ../libguestfs-1.11.19/src/guestfs.pod:2029 ../src/guestfs.pod:2029
41396 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
41401 #: ../libguestfs-1.11.19/src/guestfs.pod:2031 ../src/guestfs.pod:2031
41404 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
41409 #: ../libguestfs-1.11.19/src/guestfs.pod:2033 ../src/guestfs.pod:2033
41411 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
41412 "not have any particular meaning -- keys are not returned in any defined "
41413 "order). A pointer to the key is returned in C<*key_rtn> and the "
41414 "corresponding data pointer is returned from the function. C<NULL> is "
41415 "returned if there are no keys stored in the handle."
41419 #: ../libguestfs-1.11.19/src/guestfs.pod:2039 ../src/guestfs.pod:2039
41421 "C<guestfs_next_private> returns the next key, pointer pair. The return "
41422 "value of this function is also C<NULL> is there are no further entries to "
41427 #: ../libguestfs-1.11.19/src/guestfs.pod:2043 ../src/guestfs.pod:2043
41428 msgid "Notes about walking over entries:"
41432 #: ../libguestfs-1.11.19/src/guestfs.pod:2049 ../src/guestfs.pod:2049
41434 "You must not call C<guestfs_set_private> while walking over the entries."
41438 #: ../libguestfs-1.11.19/src/guestfs.pod:2054 ../src/guestfs.pod:2054
41440 "The handle maintains an internal iterator which is reset when you call "
41441 "C<guestfs_first_private>. This internal iterator is invalidated when you "
41442 "call C<guestfs_set_private>."
41446 #: ../libguestfs-1.11.19/src/guestfs.pod:2060 ../src/guestfs.pod:2060
41447 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
41451 #: ../libguestfs-1.11.19/src/guestfs.pod:2062 ../src/guestfs.pod:2062
41454 " guestfs_set_private (g, key, NULL);\n"
41459 #: ../libguestfs-1.11.19/src/guestfs.pod:2064 ../src/guestfs.pod:2064
41460 msgid "then that C<key> is not returned when walking."
41464 #: ../libguestfs-1.11.19/src/guestfs.pod:2068 ../src/guestfs.pod:2068
41466 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
41467 "C<guestfs_next_private> or C<guestfs_set_private>."
41471 #: ../libguestfs-1.11.19/src/guestfs.pod:2074 ../src/guestfs.pod:2074
41473 "The following example code shows how to print all keys and data pointers "
41474 "that are associated with the handle C<g>:"
41478 #: ../libguestfs-1.11.19/src/guestfs.pod:2077 ../src/guestfs.pod:2077
41481 " const char *key;\n"
41482 " void *data = guestfs_first_private (g, &key);\n"
41483 " while (data != NULL)\n"
41485 " printf (\"key = %s, data = %p\\n\", key, data);\n"
41486 " data = guestfs_next_private (g, &key);\n"
41492 #: ../libguestfs-1.11.19/src/guestfs.pod:2085 ../src/guestfs.pod:2085
41494 "More commonly you are only interested in keys that begin with an application-"
41495 "specific prefix C<foo_>. Modify the loop like so:"
41499 #: ../libguestfs-1.11.19/src/guestfs.pod:2088 ../src/guestfs.pod:2088
41502 " const char *key;\n"
41503 " void *data = guestfs_first_private (g, &key);\n"
41504 " while (data != NULL)\n"
41506 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
41507 " printf (\"key = %s, data = %p\\n\", key, data);\n"
41508 " data = guestfs_next_private (g, &key);\n"
41514 #: ../libguestfs-1.11.19/src/guestfs.pod:2097 ../src/guestfs.pod:2097
41516 "If you need to modify keys while walking, then you have to jump back to the "
41517 "beginning of the loop. For example, to delete all keys prefixed with "
41522 #: ../libguestfs-1.11.19/src/guestfs.pod:2101 ../src/guestfs.pod:2101
41525 " const char *key;\n"
41528 " data = guestfs_first_private (g, &key);\n"
41529 " while (data != NULL)\n"
41531 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
41533 " guestfs_set_private (g, key, NULL);\n"
41534 " /* note that 'key' pointer is now invalid, and so is\n"
41535 " the internal iterator */\n"
41538 " data = guestfs_next_private (g, &key);\n"
41544 #: ../libguestfs-1.11.19/src/guestfs.pod:2117 ../src/guestfs.pod:2117
41546 "Note that the above loop is guaranteed to terminate because the keys are "
41547 "being deleted, but other manipulations of keys within the loop might not "
41548 "terminate unless you also maintain an indication of which keys have been "
41553 #: ../libguestfs-1.11.19/src/guestfs.pod:2122
41554 #: ../libguestfs-1.11.19/src/guestfs.pod:2127 ../src/guestfs.pod:2122
41555 #: ../src/guestfs.pod:2127
41560 #: ../libguestfs-1.11.19/src/guestfs.pod:2124 ../src/guestfs.pod:2124
41562 "<!-- old anchor for the next section --> <a name="
41563 "\"state_machine_and_low_level_event_api\"/>"
41567 #: ../libguestfs-1.11.19/src/guestfs.pod:2129 ../src/guestfs.pod:2129
41568 msgid "ARCHITECTURE"
41572 #: ../libguestfs-1.11.19/src/guestfs.pod:2131 ../src/guestfs.pod:2131
41574 "Internally, libguestfs is implemented by running an appliance (a special "
41575 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
41576 "process of the main program."
41580 #: ../libguestfs-1.11.19/src/guestfs.pod:2135 ../src/guestfs.pod:2135
41583 " ___________________\n"
41585 " | main program |\n"
41587 " | | child process / appliance\n"
41588 " | | __________________________\n"
41590 " +-------------------+ RPC | +-----------------+ |\n"
41591 " | libguestfs <--------------------> guestfsd | |\n"
41592 " | | | +-----------------+ |\n"
41593 " \\___________________/ | | Linux kernel | |\n"
41594 " | +--^--------------+ |\n"
41595 " \\_________|________________/\n"
41597 " _______v______\n"
41600 " | disk image |\n"
41601 " \\______________/\n"
41606 #: ../libguestfs-1.11.19/src/guestfs.pod:2155 ../src/guestfs.pod:2155
41608 "The library, linked to the main program, creates the child process and hence "
41609 "the appliance in the L</guestfs_launch> function."
41613 #: ../libguestfs-1.11.19/src/guestfs.pod:2158 ../src/guestfs.pod:2158
41615 "Inside the appliance is a Linux kernel and a complete stack of userspace "
41616 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
41617 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
41618 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
41619 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
41620 "attached to the qemu process which translates device access by the "
41621 "appliance's Linux kernel into accesses to the image."
41625 #: ../libguestfs-1.11.19/src/guestfs.pod:2167 ../src/guestfs.pod:2167
41627 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
41628 "Although the disk image you are attached to might also be used by some "
41629 "virtual machine, libguestfs doesn't know or care about this. (But you will "
41630 "care if both libguestfs's qemu process and your virtual machine are trying "
41631 "to update the disk image at the same time, since these usually results in "
41632 "massive disk corruption)."
41636 #: ../libguestfs-1.11.19/src/guestfs.pod:2174 ../src/guestfs.pod:2174
41637 msgid "STATE MACHINE"
41641 #: ../libguestfs-1.11.19/src/guestfs.pod:2176 ../src/guestfs.pod:2176
41642 msgid "libguestfs uses a state machine to model the child process:"
41646 #: ../libguestfs-1.11.19/src/guestfs.pod:2178 ../src/guestfs.pod:2178
41650 " guestfs_create\n"
41658 " / | \\ \\ guestfs_launch\n"
41659 " / | _\\__V______\n"
41661 " / | | LAUNCHING |\n"
41662 " / | \\___________/\n"
41664 " / | guestfs_launch\n"
41666 " ______ / __|____V\n"
41667 " / \\ ------> / \\\n"
41668 " | BUSY | | READY |\n"
41669 " \\______/ <------ \\________/\n"
41674 #: ../libguestfs-1.11.19/src/guestfs.pod:2200 ../src/guestfs.pod:2200
41676 "The normal transitions are (1) CONFIG (when the handle is created, but there "
41677 "is no child process), (2) LAUNCHING (when the child process is booting up), "
41678 "(3) alternating between READY and BUSY as commands are issued to, and "
41679 "carried out by, the child process."
41683 #: ../libguestfs-1.11.19/src/guestfs.pod:2205 ../src/guestfs.pod:2205
41685 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
41686 "asynchronously at any time (eg. due to some internal error), and that causes "
41687 "the state to transition back to CONFIG."
41691 #: ../libguestfs-1.11.19/src/guestfs.pod:2209 ../src/guestfs.pod:2209
41693 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
41694 "issued when in the CONFIG state."
41698 #: ../libguestfs-1.11.19/src/guestfs.pod:2212 ../src/guestfs.pod:2212
41700 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
41701 "L</guestfs_launch> blocks until the child process is READY to accept "
41702 "commands (or until some failure or timeout). L</guestfs_launch> internally "
41703 "moves the state from CONFIG to LAUNCHING while it is running."
41707 #: ../libguestfs-1.11.19/src/guestfs.pod:2218 ../src/guestfs.pod:2218
41709 "API actions such as L</guestfs_mount> can only be issued when in the READY "
41710 "state. These API calls block waiting for the command to be carried out (ie. "
41711 "the state to transition to BUSY and then back to READY). There are no non-"
41712 "blocking versions, and no way to issue more than one command per handle at "
41717 #: ../libguestfs-1.11.19/src/guestfs.pod:2224 ../src/guestfs.pod:2224
41719 "Finally, the child process sends asynchronous messages back to the main "
41720 "program, such as kernel log messages. You can register a callback to "
41721 "receive these messages."
41725 #: ../libguestfs-1.11.19/src/guestfs.pod:2228 ../src/guestfs.pod:2228
41730 #: ../libguestfs-1.11.19/src/guestfs.pod:2230 ../src/guestfs.pod:2230
41731 msgid "COMMUNICATION PROTOCOL"
41735 #: ../libguestfs-1.11.19/src/guestfs.pod:2232 ../src/guestfs.pod:2232
41737 "Don't rely on using this protocol directly. This section documents how it "
41738 "currently works, but it may change at any time."
41742 #: ../libguestfs-1.11.19/src/guestfs.pod:2235 ../src/guestfs.pod:2235
41744 "The protocol used to talk between the library and the daemon running inside "
41745 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
41746 "1014, RFC 1832, RFC 4506)."
41750 #: ../libguestfs-1.11.19/src/guestfs.pod:2239 ../src/guestfs.pod:2239
41752 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
41753 "this file is automatically generated)."
41757 #: ../libguestfs-1.11.19/src/guestfs.pod:2242 ../src/guestfs.pod:2242
41759 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
41760 "and C<FileOut> parameters, which are handled with very simple request/reply "
41761 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
41762 "parameters, which use the same request and reply messages, but they may also "
41763 "be followed by files sent using a chunked encoding."
41767 #: ../libguestfs-1.11.19/src/guestfs.pod:2249 ../src/guestfs.pod:2249
41768 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
41772 #: ../libguestfs-1.11.19/src/guestfs.pod:2251 ../src/guestfs.pod:2251
41773 msgid "For ordinary functions, the request message is:"
41777 #: ../libguestfs-1.11.19/src/guestfs.pod:2253 ../src/guestfs.pod:2253
41780 " total length (header + arguments,\n"
41781 " but not including the length word itself)\n"
41782 " struct guestfs_message_header (encoded as XDR)\n"
41783 " struct guestfs_<foo>_args (encoded as XDR)\n"
41788 #: ../libguestfs-1.11.19/src/guestfs.pod:2258 ../src/guestfs.pod:2258
41790 "The total length field allows the daemon to allocate a fixed size buffer "
41791 "into which it slurps the rest of the message. As a result, the total length "
41792 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
41793 "effective size of any request is limited to somewhere under this size."
41797 #: ../libguestfs-1.11.19/src/guestfs.pod:2264 ../src/guestfs.pod:2264
41799 "Note also that many functions don't take any arguments, in which case the "
41800 "C<guestfs_I<foo>_args> is completely omitted."
41804 #: ../libguestfs-1.11.19/src/guestfs.pod:2267 ../src/guestfs.pod:2267
41806 "The header contains the procedure number (C<guestfs_proc>) which is how the "
41807 "receiver knows what type of args structure to expect, or none at all."
41811 #: ../libguestfs-1.11.19/src/guestfs.pod:2271 ../src/guestfs.pod:2271
41813 "For functions that take optional arguments, the optional arguments are "
41814 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
41815 "arguments. A bitmask in the header indicates which optional arguments are "
41816 "meaningful. The bitmask is also checked to see if it contains bits set "
41817 "which the daemon does not know about (eg. if more optional arguments were "
41818 "added in a later version of the library), and this causes the call to be "
41823 #: ../libguestfs-1.11.19/src/guestfs.pod:2279 ../src/guestfs.pod:2279
41824 msgid "The reply message for ordinary functions is:"
41828 #: ../libguestfs-1.11.19/src/guestfs.pod:2281 ../src/guestfs.pod:2281
41831 " total length (header + ret,\n"
41832 " but not including the length word itself)\n"
41833 " struct guestfs_message_header (encoded as XDR)\n"
41834 " struct guestfs_<foo>_ret (encoded as XDR)\n"
41839 #: ../libguestfs-1.11.19/src/guestfs.pod:2286 ../src/guestfs.pod:2286
41841 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
41842 "functions that return no formal return values."
41846 #: ../libguestfs-1.11.19/src/guestfs.pod:2289 ../src/guestfs.pod:2289
41848 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
41852 #: ../libguestfs-1.11.19/src/guestfs.pod:2292 ../src/guestfs.pod:2292
41854 "In the case of an error, a flag is set in the header, and the reply message "
41855 "is slightly changed:"
41859 #: ../libguestfs-1.11.19/src/guestfs.pod:2295 ../src/guestfs.pod:2295
41862 " total length (header + error,\n"
41863 " but not including the length word itself)\n"
41864 " struct guestfs_message_header (encoded as XDR)\n"
41865 " struct guestfs_message_error (encoded as XDR)\n"
41870 #: ../libguestfs-1.11.19/src/guestfs.pod:2300 ../src/guestfs.pod:2300
41872 "The C<guestfs_message_error> structure contains the error message as a "
41877 #: ../libguestfs-1.11.19/src/guestfs.pod:2303 ../src/guestfs.pod:2303
41878 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
41882 #: ../libguestfs-1.11.19/src/guestfs.pod:2305 ../src/guestfs.pod:2305
41884 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
41885 "The normal request message is sent (see above). However this is followed by "
41886 "a sequence of file chunks."
41890 #: ../libguestfs-1.11.19/src/guestfs.pod:2309 ../src/guestfs.pod:2309
41893 " total length (header + arguments,\n"
41894 " but not including the length word itself,\n"
41895 " and not including the chunks)\n"
41896 " struct guestfs_message_header (encoded as XDR)\n"
41897 " struct guestfs_<foo>_args (encoded as XDR)\n"
41898 " sequence of chunks for FileIn param #0\n"
41899 " sequence of chunks for FileIn param #1 etc.\n"
41904 #: ../libguestfs-1.11.19/src/guestfs.pod:2317 ../src/guestfs.pod:2317
41905 msgid "The \"sequence of chunks\" is:"
41909 #: ../libguestfs-1.11.19/src/guestfs.pod:2319 ../src/guestfs.pod:2319
41912 " length of chunk (not including length word itself)\n"
41913 " struct guestfs_chunk (encoded as XDR)\n"
41914 " length of chunk\n"
41915 " struct guestfs_chunk (encoded as XDR)\n"
41917 " length of chunk\n"
41918 " struct guestfs_chunk (with data.data_len == 0)\n"
41923 #: ../libguestfs-1.11.19/src/guestfs.pod:2327 ../src/guestfs.pod:2327
41925 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
41926 "is set in the final chunk to indicate either successful completion or early "
41931 #: ../libguestfs-1.11.19/src/guestfs.pod:2331 ../src/guestfs.pod:2331
41933 "At time of writing there are no functions that have more than one FileIn "
41934 "parameter. However this is (theoretically) supported, by sending the "
41935 "sequence of chunks for each FileIn parameter one after another (from left to "
41940 #: ../libguestfs-1.11.19/src/guestfs.pod:2336 ../src/guestfs.pod:2336
41942 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
41943 "transfer. The library does this by sending a chunk with a special flag set "
41944 "to indicate cancellation. When the daemon sees this, it cancels the whole "
41945 "RPC, does I<not> send any reply, and goes back to reading the next request."
41949 #: ../libguestfs-1.11.19/src/guestfs.pod:2342 ../src/guestfs.pod:2342
41951 "The daemon may also cancel. It does this by writing a special word "
41952 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
41953 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
41954 "cancel chunk). The special word is chosen so that even if cancellation "
41955 "happens right at the end of the transfer (after the library has finished "
41956 "writing and has started listening for the reply), the \"spurious\" cancel "
41957 "flag will not be confused with the reply message."
41961 #: ../libguestfs-1.11.19/src/guestfs.pod:2351 ../src/guestfs.pod:2351
41963 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
41964 "limit), and also files where the size is not known in advance (eg. from "
41965 "pipes or sockets). However the chunks are rather small "
41966 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
41967 "to keep much in memory."
41971 #: ../libguestfs-1.11.19/src/guestfs.pod:2357 ../src/guestfs.pod:2357
41972 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
41976 #: ../libguestfs-1.11.19/src/guestfs.pod:2359 ../src/guestfs.pod:2359
41978 "The protocol for FileOut parameters is exactly the same as for FileIn "
41979 "parameters, but with the roles of daemon and library reversed."
41983 #: ../libguestfs-1.11.19/src/guestfs.pod:2362 ../src/guestfs.pod:2362
41986 " total length (header + ret,\n"
41987 " but not including the length word itself,\n"
41988 " and not including the chunks)\n"
41989 " struct guestfs_message_header (encoded as XDR)\n"
41990 " struct guestfs_<foo>_ret (encoded as XDR)\n"
41991 " sequence of chunks for FileOut param #0\n"
41992 " sequence of chunks for FileOut param #1 etc.\n"
41997 #: ../libguestfs-1.11.19/src/guestfs.pod:2370 ../src/guestfs.pod:2370
41998 msgid "INITIAL MESSAGE"
42002 #: ../libguestfs-1.11.19/src/guestfs.pod:2372 ../src/guestfs.pod:2372
42004 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
42005 "which indicates that the guest and daemon is alive. This is what L</"
42006 "guestfs_launch> waits for."
42010 #: ../libguestfs-1.11.19/src/guestfs.pod:2376 ../src/guestfs.pod:2376
42011 msgid "PROGRESS NOTIFICATION MESSAGES"
42015 #: ../libguestfs-1.11.19/src/guestfs.pod:2378 ../src/guestfs.pod:2378
42017 "The daemon may send progress notification messages at any time. These are "
42018 "distinguished by the normal length word being replaced by "
42019 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
42023 #: ../libguestfs-1.11.19/src/guestfs.pod:2382 ../src/guestfs.pod:2382
42025 "The library turns them into progress callbacks (see L</"
42026 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
42031 #: ../libguestfs-1.11.19/src/guestfs.pod:2386 ../src/guestfs.pod:2386
42033 "The daemon self-limits the frequency of progress messages it sends (see "
42034 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
42039 #: ../libguestfs-1.11.19/src/guestfs.pod:2390 ../src/guestfs.pod:2390
42040 msgid "LIBGUESTFS VERSION NUMBERS"
42044 #: ../libguestfs-1.11.19/src/guestfs.pod:2392 ../src/guestfs.pod:2392
42046 "Since April 2010, libguestfs has started to make separate development and "
42047 "stable releases, along with corresponding branches in our git repository. "
42048 "These separate releases can be identified by version number:"
42052 #: ../libguestfs-1.11.19/src/guestfs.pod:2397 ../src/guestfs.pod:2397
42055 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
42056 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
42062 " | `-------- sub-version\n"
42064 " `------ always '1' because we don't change the ABI\n"
42069 #: ../libguestfs-1.11.19/src/guestfs.pod:2408 ../src/guestfs.pod:2408
42070 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
42074 #: ../libguestfs-1.11.19/src/guestfs.pod:2410 ../src/guestfs.pod:2410
42076 "As time passes we cherry pick fixes from the development branch and backport "
42077 "those into the stable branch, the effect being that the stable branch should "
42078 "get more stable and less buggy over time. So the stable releases are ideal "
42079 "for people who don't need new features but would just like the software to "
42084 #: ../libguestfs-1.11.19/src/guestfs.pod:2416 ../src/guestfs.pod:2416
42085 msgid "Our criteria for backporting changes are:"
42089 #: ../libguestfs-1.11.19/src/guestfs.pod:2422 ../src/guestfs.pod:2422
42091 "Documentation changes which don't affect any code are backported unless the "
42092 "documentation refers to a future feature which is not in stable."
42096 #: ../libguestfs-1.11.19/src/guestfs.pod:2428 ../src/guestfs.pod:2428
42098 "Bug fixes which are not controversial, fix obvious problems, and have been "
42099 "well tested are backported."
42103 #: ../libguestfs-1.11.19/src/guestfs.pod:2433 ../src/guestfs.pod:2433
42105 "Simple rearrangements of code which shouldn't affect how it works get "
42106 "backported. This is so that the code in the two branches doesn't get too "
42107 "far out of step, allowing us to backport future fixes more easily."
42111 #: ../libguestfs-1.11.19/src/guestfs.pod:2439 ../src/guestfs.pod:2439
42113 "We I<don't> backport new features, new APIs, new tools etc, except in one "
42114 "exceptional case: the new feature is required in order to implement an "
42115 "important bug fix."
42119 #: ../libguestfs-1.11.19/src/guestfs.pod:2445 ../src/guestfs.pod:2445
42121 "A new stable branch starts when we think the new features in development are "
42122 "substantial and compelling enough over the current stable branch to warrant "
42123 "it. When that happens we create new stable and development versions 1.N.0 "
42124 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
42125 "stable at this point, but by backporting fixes from development, that branch "
42126 "will stabilize over time."
42130 #: ../libguestfs-1.11.19/src/guestfs.pod:2453 ../src/guestfs.pod:2453
42131 msgid "EXTENDING LIBGUESTFS"
42135 #: ../libguestfs-1.11.19/src/guestfs.pod:2455 ../src/guestfs.pod:2455
42136 msgid "ADDING A NEW API ACTION"
42140 #: ../libguestfs-1.11.19/src/guestfs.pod:2457 ../src/guestfs.pod:2457
42142 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
42143 "documentation) are generated, and this makes it easy to extend the "
42148 #: ../libguestfs-1.11.19/src/guestfs.pod:2461 ../src/guestfs.pod:2461
42149 msgid "To add a new API action there are two changes:"
42153 #: ../libguestfs-1.11.19/src/guestfs.pod:2467 ../src/guestfs.pod:2467
42155 "You need to add a description of the call (name, parameters, return type, "
42156 "tests, documentation) to C<generator/generator_actions.ml>."
42160 #: ../libguestfs-1.11.19/src/guestfs.pod:2470 ../src/guestfs.pod:2470
42162 "There are two sorts of API action, depending on whether the call goes "
42163 "through to the daemon in the appliance, or is serviced entirely by the "
42164 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
42165 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
42166 "an example of the latter, since a trace flag is maintained in the handle and "
42167 "all tracing is done on the library side."
42171 #: ../libguestfs-1.11.19/src/guestfs.pod:2478 ../src/guestfs.pod:2478
42173 "Most new actions are of the first type, and get added to the "
42174 "C<daemon_functions> list. Each function has a unique procedure number used "
42175 "in the RPC protocol which is assigned to that action when we publish "
42176 "libguestfs and cannot be reused. Take the latest procedure number and "
42181 #: ../libguestfs-1.11.19/src/guestfs.pod:2484 ../src/guestfs.pod:2484
42183 "For library-only actions of the second type, add to the "
42184 "C<non_daemon_functions> list. Since these functions are serviced by the "
42185 "library and do not travel over the RPC mechanism to the daemon, these "
42186 "functions do not need a procedure number, and so the procedure number is set "
42191 #: ../libguestfs-1.11.19/src/guestfs.pod:2492 ../src/guestfs.pod:2492
42192 msgid "Implement the action (in C):"
42196 #: ../libguestfs-1.11.19/src/guestfs.pod:2494 ../src/guestfs.pod:2494
42198 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
42199 "C<daemon/> directory."
42203 #: ../libguestfs-1.11.19/src/guestfs.pod:2497 ../src/guestfs.pod:2497
42205 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
42206 "(note: double underscore) in the C<src/> directory."
42210 #: ../libguestfs-1.11.19/src/guestfs.pod:2500 ../src/guestfs.pod:2500
42211 msgid "In either case, use another function as an example of what to do."
42215 #: ../libguestfs-1.11.19/src/guestfs.pod:2504 ../src/guestfs.pod:2504
42216 msgid "After making these changes, use C<make> to compile."
42220 #: ../libguestfs-1.11.19/src/guestfs.pod:2506 ../src/guestfs.pod:2506
42222 "Note that you don't need to implement the RPC, language bindings, manual "
42223 "pages or anything else. It's all automatically generated from the OCaml "
42228 #: ../libguestfs-1.11.19/src/guestfs.pod:2510 ../src/guestfs.pod:2510
42229 msgid "ADDING TESTS FOR AN API ACTION"
42233 #: ../libguestfs-1.11.19/src/guestfs.pod:2512 ../src/guestfs.pod:2512
42235 "You can supply zero or as many tests as you want per API call. The tests "
42236 "can either be added as part of the API description (C<generator/"
42237 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
42238 "into C<regressions/>. Note that adding a script to C<regressions/> is "
42239 "slower, so if possible use the first method."
42243 #: ../libguestfs-1.11.19/src/guestfs.pod:2518 ../src/guestfs.pod:2518
42245 "The following describes the test environment used when you add an API test "
42246 "in C<generator_actions.ml>."
42250 #: ../libguestfs-1.11.19/src/guestfs.pod:2521 ../src/guestfs.pod:2521
42251 msgid "The test environment has 4 block devices:"
42255 #: ../libguestfs-1.11.19/src/guestfs.pod:2525 ../src/guestfs.pod:2525
42256 msgid "C</dev/sda> 500MB"
42260 #: ../libguestfs-1.11.19/src/guestfs.pod:2527 ../src/guestfs.pod:2527
42261 msgid "General block device for testing."
42265 #: ../libguestfs-1.11.19/src/guestfs.pod:2529 ../src/guestfs.pod:2529
42266 msgid "C</dev/sdb> 50MB"
42270 #: ../libguestfs-1.11.19/src/guestfs.pod:2531 ../src/guestfs.pod:2531
42272 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
42277 #: ../libguestfs-1.11.19/src/guestfs.pod:2534 ../src/guestfs.pod:2534
42278 msgid "C</dev/sdc> 10MB"
42282 #: ../libguestfs-1.11.19/src/guestfs.pod:2536 ../src/guestfs.pod:2536
42283 msgid "Used in a few tests where two block devices are needed."
42287 #: ../libguestfs-1.11.19/src/guestfs.pod:2538 ../src/guestfs.pod:2538
42288 msgid "C</dev/sdd>"
42292 #: ../libguestfs-1.11.19/src/guestfs.pod:2540 ../src/guestfs.pod:2540
42293 msgid "ISO with fixed content (see C<images/test.iso>)."
42297 #: ../libguestfs-1.11.19/src/guestfs.pod:2544 ../src/guestfs.pod:2544
42299 "To be able to run the tests in a reasonable amount of time, the libguestfs "
42300 "appliance and block devices are reused between tests. So don't try testing "
42301 "L</guestfs_kill_subprocess> :-x"
42305 #: ../libguestfs-1.11.19/src/guestfs.pod:2548 ../src/guestfs.pod:2548
42307 "Each test starts with an initial scenario, selected using one of the "
42308 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
42309 "initialize the disks mentioned above in a particular way as documented in "
42310 "C<generator_types.ml>. You should not assume anything about the previous "
42311 "contents of other disks that are not initialized."
42315 #: ../libguestfs-1.11.19/src/guestfs.pod:2554 ../src/guestfs.pod:2554
42317 "You can add a prerequisite clause to any individual test. This is a run-"
42318 "time check, which, if it fails, causes the test to be skipped. Useful if "
42319 "testing a command which might not work on all variations of libguestfs "
42320 "builds. A test that has prerequisite of C<Always> means to run "
42325 #: ../libguestfs-1.11.19/src/guestfs.pod:2560 ../src/guestfs.pod:2560
42327 "In addition, packagers can skip individual tests by setting environment "
42328 "variables before running C<make check>."
42332 #: ../libguestfs-1.11.19/src/guestfs.pod:2563 ../src/guestfs.pod:2563
42335 " SKIP_TEST_<CMD>_<NUM>=1\n"
42340 #: ../libguestfs-1.11.19/src/guestfs.pod:2565 ../src/guestfs.pod:2565
42341 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
42345 #: ../libguestfs-1.11.19/src/guestfs.pod:2567 ../src/guestfs.pod:2567
42350 #: ../libguestfs-1.11.19/src/guestfs.pod:2569 ../src/guestfs.pod:2569
42353 " SKIP_TEST_<CMD>=1\n"
42358 #: ../libguestfs-1.11.19/src/guestfs.pod:2571 ../src/guestfs.pod:2571
42359 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
42363 #: ../libguestfs-1.11.19/src/guestfs.pod:2573 ../src/guestfs.pod:2573
42364 msgid "Packagers can run only certain tests by setting for example:"
42368 #: ../libguestfs-1.11.19/src/guestfs.pod:2575 ../src/guestfs.pod:2575
42371 " TEST_ONLY=\"vfs_type zerofree\"\n"
42376 #: ../libguestfs-1.11.19/src/guestfs.pod:2577 ../src/guestfs.pod:2577
42378 "See C<capitests/tests.c> for more details of how these environment variables "
42383 #: ../libguestfs-1.11.19/src/guestfs.pod:2580 ../src/guestfs.pod:2580
42384 msgid "DEBUGGING NEW API ACTIONS"
42388 #: ../libguestfs-1.11.19/src/guestfs.pod:2582 ../src/guestfs.pod:2582
42389 msgid "Test new actions work before submitting them."
42393 #: ../libguestfs-1.11.19/src/guestfs.pod:2584 ../src/guestfs.pod:2584
42394 msgid "You can use guestfish to try out new commands."
42398 #: ../libguestfs-1.11.19/src/guestfs.pod:2586 ../src/guestfs.pod:2586
42400 "Debugging the daemon is a problem because it runs inside a minimal "
42401 "environment. However you can fprintf messages in the daemon to stderr, and "
42402 "they will show up if you use C<guestfish -v>."
42406 #: ../libguestfs-1.11.19/src/guestfs.pod:2590 ../src/guestfs.pod:2590
42407 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
42411 #: ../libguestfs-1.11.19/src/guestfs.pod:2592 ../src/guestfs.pod:2592
42413 "Our C source code generally adheres to some basic code-formatting "
42414 "conventions. The existing code base is not totally consistent on this "
42415 "front, but we do prefer that contributed code be formatted similarly. In "
42416 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
42417 "indentation level, and other than that, follow the K&R style."
42421 #: ../libguestfs-1.11.19/src/guestfs.pod:2598 ../src/guestfs.pod:2598
42423 "If you use Emacs, add the following to one of one of your start-up files (e."
42424 "g., ~/.emacs), to help ensure that you get indentation right:"
42428 #: ../libguestfs-1.11.19/src/guestfs.pod:2601 ../src/guestfs.pod:2601
42431 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
42432 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
42433 " (add-hook 'find-file-hook\n"
42434 " '(lambda () (if (and buffer-file-name\n"
42435 " (string-match \"/libguestfs\\\\>\"\n"
42436 " (buffer-file-name))\n"
42437 " (not (string-equal mode-name \"Change Log\"))\n"
42438 " (not (string-equal mode-name \"Makefile\")))\n"
42439 " (setq indent-tabs-mode nil))))\n"
42444 #: ../libguestfs-1.11.19/src/guestfs.pod:2611 ../src/guestfs.pod:2611
42447 " ;;; When editing C sources in libguestfs, use this style.\n"
42448 " (defun libguestfs-c-mode ()\n"
42449 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
42451 " (c-set-style \"K&R\")\n"
42452 " (setq c-indent-level 2)\n"
42453 " (setq c-basic-offset 2))\n"
42454 " (add-hook 'c-mode-hook\n"
42455 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
42456 " (buffer-file-name))\n"
42457 " (libguestfs-c-mode))))\n"
42462 #: ../libguestfs-1.11.19/src/guestfs.pod:2623 ../src/guestfs.pod:2623
42463 msgid "Enable warnings when compiling (and fix any problems this finds):"
42467 #: ../libguestfs-1.11.19/src/guestfs.pod:2626 ../src/guestfs.pod:2626
42470 " ./configure --enable-gcc-warnings\n"
42475 #: ../libguestfs-1.11.19/src/guestfs.pod:2628 ../src/guestfs.pod:2628
42476 msgid "Useful targets are:"
42480 #: ../libguestfs-1.11.19/src/guestfs.pod:2630 ../src/guestfs.pod:2630
42483 " make syntax-check # checks the syntax of the C code\n"
42484 " make check # runs the test suite\n"
42489 #: ../libguestfs-1.11.19/src/guestfs.pod:2633 ../src/guestfs.pod:2633
42490 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
42494 #: ../libguestfs-1.11.19/src/guestfs.pod:2635 ../src/guestfs.pod:2635
42496 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
42497 "which are used to do shell quoting."
42501 #: ../libguestfs-1.11.19/src/guestfs.pod:2640 ../src/guestfs.pod:2640
42506 #: ../libguestfs-1.11.19/src/guestfs.pod:2642 ../src/guestfs.pod:2642
42508 "Simple shell quoted string. Any spaces or other shell characters are "
42513 #: ../libguestfs-1.11.19/src/guestfs.pod:2645 ../src/guestfs.pod:2645
42518 #: ../libguestfs-1.11.19/src/guestfs.pod:2647 ../src/guestfs.pod:2647
42520 "Same as C<%Q> except the string is treated as a path which is prefixed by "
42525 #: ../libguestfs-1.11.19/src/guestfs.pod:2654 ../src/guestfs.pod:2654
42528 " asprintf (&cmd, \"cat %R\", path);\n"
42533 #: ../libguestfs-1.11.19/src/guestfs.pod:2656 ../src/guestfs.pod:2656
42534 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
42538 #: ../libguestfs-1.11.19/src/guestfs.pod:2658 ../src/guestfs.pod:2658
42540 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
42541 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
42542 "they are not passed via the shell (instead, straight to exec). You probably "
42543 "want to use the C<sysroot_path()> function however."
42547 #: ../libguestfs-1.11.19/src/guestfs.pod:2664 ../src/guestfs.pod:2664
42548 msgid "SUBMITTING YOUR NEW API ACTIONS"
42552 #: ../libguestfs-1.11.19/src/guestfs.pod:2666 ../src/guestfs.pod:2666
42554 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
42555 "libguestfs> and CC to L<rjones@redhat.com>."
42559 #: ../libguestfs-1.11.19/src/guestfs.pod:2670 ../src/guestfs.pod:2670
42560 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
42564 #: ../libguestfs-1.11.19/src/guestfs.pod:2672 ../src/guestfs.pod:2672
42565 msgid "We support i18n (gettext anyhow) in the library."
42569 #: ../libguestfs-1.11.19/src/guestfs.pod:2674 ../src/guestfs.pod:2674
42571 "However many messages come from the daemon, and we don't translate those at "
42572 "the moment. One reason is that the appliance generally has all locale files "
42573 "removed from it, because they take up a lot of space. So we'd have to readd "
42574 "some of those, as well as copying our PO files into the appliance."
42578 #: ../libguestfs-1.11.19/src/guestfs.pod:2680 ../src/guestfs.pod:2680
42580 "Debugging messages are never translated, since they are intended for the "
42585 #: ../libguestfs-1.11.19/src/guestfs.pod:2683 ../src/guestfs.pod:2683
42586 msgid "SOURCE CODE SUBDIRECTORIES"
42590 #: ../libguestfs-1.11.19/src/guestfs.pod:2689 ../src/guestfs.pod:2689
42591 msgid "The libguestfs appliance, build scripts and so on."
42595 #: ../libguestfs-1.11.19/src/guestfs.pod:2691 ../src/guestfs.pod:2691
42596 msgid "C<capitests>"
42600 #: ../libguestfs-1.11.19/src/guestfs.pod:2693 ../src/guestfs.pod:2693
42601 msgid "Automated tests of the C API."
42605 #: ../libguestfs-1.11.19/src/guestfs.pod:2695 ../src/guestfs.pod:2695
42610 #: ../libguestfs-1.11.19/src/guestfs.pod:2697 ../src/guestfs.pod:2697
42612 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
42617 #: ../libguestfs-1.11.19/src/guestfs.pod:2700 ../src/guestfs.pod:2700
42622 #: ../libguestfs-1.11.19/src/guestfs.pod:2702 ../src/guestfs.pod:2702
42624 "Safety and liveness tests of components that libguestfs depends upon (not of "
42625 "libguestfs itself). Mainly this is for qemu and the kernel."
42629 #: ../libguestfs-1.11.19/src/guestfs.pod:2705 ../src/guestfs.pod:2705
42634 #: ../libguestfs-1.11.19/src/guestfs.pod:2707 ../src/guestfs.pod:2707
42635 msgid "Outside contributions, experimental parts."
42639 #: ../libguestfs-1.11.19/src/guestfs.pod:2709 ../src/guestfs.pod:2709
42644 #: ../libguestfs-1.11.19/src/guestfs.pod:2711 ../src/guestfs.pod:2711
42646 "The daemon that runs inside the libguestfs appliance and carries out actions."
42650 #: ../libguestfs-1.11.19/src/guestfs.pod:2714 ../src/guestfs.pod:2714
42655 #: ../libguestfs-1.11.19/src/guestfs.pod:2716 ../src/guestfs.pod:2716
42656 msgid "L<virt-df(1)> command and documentation."
42660 #: ../libguestfs-1.11.19/src/guestfs.pod:2718 ../src/guestfs.pod:2718
42665 #: ../libguestfs-1.11.19/src/guestfs.pod:2720 ../src/guestfs.pod:2720
42666 msgid "L<virt-edit(1)> command and documentation."
42670 #: ../libguestfs-1.11.19/src/guestfs.pod:2722 ../src/guestfs.pod:2722
42671 msgid "C<examples>"
42675 #: ../libguestfs-1.11.19/src/guestfs.pod:2724 ../src/guestfs.pod:2724
42676 msgid "C API example code."
42680 #: ../libguestfs-1.11.19/src/guestfs.pod:2726 ../src/guestfs.pod:2726
42685 #: ../libguestfs-1.11.19/src/guestfs.pod:2728 ../src/guestfs.pod:2728
42687 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
42688 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
42689 "L<virt-tar-out(1)>."
42693 #: ../libguestfs-1.11.19/src/guestfs.pod:2732 ../src/guestfs.pod:2732
42698 #: ../libguestfs-1.11.19/src/guestfs.pod:2734 ../src/guestfs.pod:2734
42700 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
42704 #: ../libguestfs-1.11.19/src/guestfs.pod:2736 ../src/guestfs.pod:2736
42705 msgid "C<generator>"
42709 #: ../libguestfs-1.11.19/src/guestfs.pod:2738 ../src/guestfs.pod:2738
42711 "The crucially important generator, used to automatically generate large "
42712 "amounts of boilerplate C code for things like RPC and bindings."
42716 #: ../libguestfs-1.11.19/src/guestfs.pod:2741 ../src/guestfs.pod:2741
42721 #: ../libguestfs-1.11.19/src/guestfs.pod:2743 ../src/guestfs.pod:2743
42722 msgid "Files used by the test suite."
42726 #: ../libguestfs-1.11.19/src/guestfs.pod:2745 ../src/guestfs.pod:2745
42727 msgid "Some \"phony\" guest images which we test against."
42731 #: ../libguestfs-1.11.19/src/guestfs.pod:2747 ../src/guestfs.pod:2747
42732 msgid "C<inspector>"
42736 #: ../libguestfs-1.11.19/src/guestfs.pod:2749 ../src/guestfs.pod:2749
42737 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
42741 #: ../libguestfs-1.11.19/src/guestfs.pod:2751 ../src/guestfs.pod:2751
42746 #: ../libguestfs-1.11.19/src/guestfs.pod:2753 ../src/guestfs.pod:2753
42747 msgid "Logo used on the website. The fish is called Arthur by the way."
42751 #: ../libguestfs-1.11.19/src/guestfs.pod:2755 ../src/guestfs.pod:2755
42756 #: ../libguestfs-1.11.19/src/guestfs.pod:2757 ../src/guestfs.pod:2757
42757 msgid "M4 macros used by autoconf."
42761 #: ../libguestfs-1.11.19/src/guestfs.pod:2759 ../src/guestfs.pod:2759
42766 #: ../libguestfs-1.11.19/src/guestfs.pod:2761 ../src/guestfs.pod:2761
42767 msgid "Translations of simple gettext strings."
42771 #: ../libguestfs-1.11.19/src/guestfs.pod:2763 ../src/guestfs.pod:2763
42776 #: ../libguestfs-1.11.19/src/guestfs.pod:2765 ../src/guestfs.pod:2765
42778 "The build infrastructure and PO files for translations of manpages and POD "
42779 "files. Eventually this will be combined with the C<po> directory, but that "
42780 "is rather complicated."
42784 #: ../libguestfs-1.11.19/src/guestfs.pod:2769 ../src/guestfs.pod:2769
42785 msgid "C<regressions>"
42789 #: ../libguestfs-1.11.19/src/guestfs.pod:2771 ../src/guestfs.pod:2771
42790 msgid "Regression tests."
42794 #: ../libguestfs-1.11.19/src/guestfs.pod:2773 ../src/guestfs.pod:2773
42799 #: ../libguestfs-1.11.19/src/guestfs.pod:2775 ../src/guestfs.pod:2775
42800 msgid "L<virt-rescue(1)> command and documentation."
42804 #: ../libguestfs-1.11.19/src/guestfs.pod:2777 ../src/guestfs.pod:2777
42809 #: ../libguestfs-1.11.19/src/guestfs.pod:2779 ../src/guestfs.pod:2779
42810 msgid "Source code to the C library."
42814 #: ../libguestfs-1.11.19/src/guestfs.pod:2781 ../src/guestfs.pod:2781
42819 #: ../libguestfs-1.11.19/src/guestfs.pod:2783 ../src/guestfs.pod:2783
42820 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
42824 #: ../libguestfs-1.11.19/src/guestfs.pod:2785 ../src/guestfs.pod:2785
42825 msgid "C<test-tool>"
42829 #: ../libguestfs-1.11.19/src/guestfs.pod:2787 ../src/guestfs.pod:2787
42831 "Test tool for end users to test if their qemu/kernel combination will work "
42836 #: ../libguestfs-1.11.19/src/guestfs.pod:2790 ../src/guestfs.pod:2790
42841 #: ../libguestfs-1.11.19/src/guestfs.pod:2792 ../src/guestfs.pod:2792
42846 #: ../libguestfs-1.11.19/src/guestfs.pod:2794 ../src/guestfs.pod:2794
42851 #: ../libguestfs-1.11.19/src/guestfs.pod:2796 ../src/guestfs.pod:2796
42856 #: ../libguestfs-1.11.19/src/guestfs.pod:2798 ../src/guestfs.pod:2798
42861 #: ../libguestfs-1.11.19/src/guestfs.pod:2800 ../src/guestfs.pod:2800
42866 #: ../libguestfs-1.11.19/src/guestfs.pod:2802 ../src/guestfs.pod:2802
42871 #: ../libguestfs-1.11.19/src/guestfs.pod:2804 ../src/guestfs.pod:2804
42876 #: ../libguestfs-1.11.19/src/guestfs.pod:2806 ../src/guestfs.pod:2806
42877 msgid "Language bindings."
42881 #: ../libguestfs-1.11.19/src/guestfs.pod:2810 ../src/guestfs.pod:2810
42882 msgid "MAKING A STABLE RELEASE"
42886 #: ../libguestfs-1.11.19/src/guestfs.pod:2812 ../src/guestfs.pod:2812
42888 "When we make a stable release, there are several steps documented here. See "
42889 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
42894 #: ../libguestfs-1.11.19/src/guestfs.pod:2820 ../src/guestfs.pod:2820
42895 msgid "Finalize RELEASE-NOTES."
42899 #: ../libguestfs-1.11.19/src/guestfs.pod:2824 ../src/guestfs.pod:2824
42900 msgid "Update ROADMAP."
42904 #: ../libguestfs-1.11.19/src/guestfs.pod:2828 ../src/guestfs.pod:2828
42905 msgid "Run C<src/api-support/update-from-tarballs.sh>."
42909 #: ../libguestfs-1.11.19/src/guestfs.pod:2832 ../src/guestfs.pod:2832
42910 msgid "Push and pull from Transifex."
42914 #: ../libguestfs-1.11.19/src/guestfs.pod:2834 ../src/guestfs.pod:2834
42919 #: ../libguestfs-1.11.19/src/guestfs.pod:2836 ../src/guestfs.pod:2836
42927 #: ../libguestfs-1.11.19/src/guestfs.pod:2838 ../src/guestfs.pod:2838
42928 msgid "to push the latest POT files to Transifex. Then run:"
42932 #: ../libguestfs-1.11.19/src/guestfs.pod:2840 ../src/guestfs.pod:2840
42940 #: ../libguestfs-1.11.19/src/guestfs.pod:2842 ../src/guestfs.pod:2842
42941 msgid "which is a wrapper to pull the latest translated C<*.po> files."
42945 #: ../libguestfs-1.11.19/src/guestfs.pod:2846 ../src/guestfs.pod:2846
42947 "Create new stable and development directories under L<http://libguestfs.org/"
42952 #: ../libguestfs-1.11.19/src/guestfs.pod:2851 ../src/guestfs.pod:2851
42953 msgid "Create the branch in git:"
42957 #: ../libguestfs-1.11.19/src/guestfs.pod:2853 ../src/guestfs.pod:2853
42960 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
42961 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
42962 " git branch stable-1.XX\n"
42963 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
42968 #: ../libguestfs-1.11.19/src/guestfs.pod:2860 ../src/guestfs.pod:2860
42973 #: ../libguestfs-1.11.19/src/guestfs.pod:2862 ../src/guestfs.pod:2862
42974 msgid "PROTOCOL LIMITS"
42978 #: ../libguestfs-1.11.19/src/guestfs.pod:2864 ../src/guestfs.pod:2864
42980 "Internally libguestfs uses a message-based protocol to pass API calls and "
42981 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
42982 "plenty more detail about this). The maximum message size used by the "
42983 "protocol is slightly less than 4 MB. For some API calls you may need to be "
42984 "aware of this limit. The API calls which may be affected are individually "
42985 "documented, with a link back to this section of the documentation."
42989 #: ../libguestfs-1.11.19/src/guestfs.pod:2872 ../src/guestfs.pod:2872
42991 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
42992 "a simple string. Because this string is at some point internally encoded as "
42993 "a message, the maximum size that it can return is slightly under 4 MB. If "
42994 "the requested file is larger than this then you will get an error."
42998 #: ../libguestfs-1.11.19/src/guestfs.pod:2878 ../src/guestfs.pod:2878
43000 "In order to transfer large files into and out of the guest filesystem, you "
43001 "need to use particular calls that support this. The sections L</UPLOADING> "
43002 "and L</DOWNLOADING> document how to do this."
43006 #: ../libguestfs-1.11.19/src/guestfs.pod:2882 ../src/guestfs.pod:2882
43008 "You might also consider mounting the disk image using our FUSE filesystem "
43009 "support (L<guestmount(1)>)."
43013 #: ../libguestfs-1.11.19/src/guestfs.pod:2885 ../src/guestfs.pod:2885
43014 msgid "MAXIMUM NUMBER OF DISKS"
43018 #: ../libguestfs-1.11.19/src/guestfs.pod:2887 ../src/guestfs.pod:2887
43019 msgid "When using virtio disks (the default) the current limit is B<25> disks."
43023 #: ../libguestfs-1.11.19/src/guestfs.pod:2890 ../src/guestfs.pod:2890
43025 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
43026 "slots. However febootstrap only understands disks with names C</dev/vda> "
43027 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
43032 #: ../libguestfs-1.11.19/src/guestfs.pod:2895 ../src/guestfs.pod:2895
43034 "We are working to substantially raise this limit in future versions but it "
43035 "requires complex changes to qemu."
43039 #: ../libguestfs-1.11.19/src/guestfs.pod:2898 ../src/guestfs.pod:2898
43041 "In future versions of libguestfs it should also be possible to \"hot plug\" "
43042 "disks (add and remove disks after calling L</guestfs_launch>). This also "
43043 "requires changes to qemu."
43047 #: ../libguestfs-1.11.19/src/guestfs.pod:2902 ../src/guestfs.pod:2902
43048 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
43052 #: ../libguestfs-1.11.19/src/guestfs.pod:2904 ../src/guestfs.pod:2904
43053 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
43057 #: ../libguestfs-1.11.19/src/guestfs.pod:2906 ../src/guestfs.pod:2906
43059 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
43060 "vda>, and C</dev/vda1> through C</dev/vda15>)."
43064 #: ../libguestfs-1.11.19/src/guestfs.pod:2909 ../src/guestfs.pod:2909
43066 "If you attach a disk with more than 15 partitions, the extra partitions are "
43067 "ignored by libguestfs."
43071 #: ../libguestfs-1.11.19/src/guestfs.pod:2912 ../src/guestfs.pod:2912
43072 msgid "MAXIMUM SIZE OF A DISK"
43076 #: ../libguestfs-1.11.19/src/guestfs.pod:2914 ../src/guestfs.pod:2914
43077 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
43081 #: ../libguestfs-1.11.19/src/guestfs.pod:2916 ../src/guestfs.pod:2916
43083 "We have tested block devices up to 1 exabyte (2**60 or "
43084 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
43089 #: ../libguestfs-1.11.19/src/guestfs.pod:2920 ../src/guestfs.pod:2920
43091 "Although libguestfs probably does not impose any limit, the underlying host "
43092 "storage will. If you store disk images on a host ext4 filesystem, then the "
43093 "maximum size will be limited by the maximum ext4 file size (currently 16 "
43094 "TB). If you store disk images as host logical volumes then you are limited "
43095 "by the maximum size of an LV."
43099 #: ../libguestfs-1.11.19/src/guestfs.pod:2926 ../src/guestfs.pod:2926
43101 "For the hugest disk image files, we recommend using XFS on the host for "
43106 #: ../libguestfs-1.11.19/src/guestfs.pod:2929 ../src/guestfs.pod:2929
43107 msgid "MAXIMUM SIZE OF A PARTITION"
43111 #: ../libguestfs-1.11.19/src/guestfs.pod:2931 ../src/guestfs.pod:2931
43113 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
43114 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
43115 "address a partition located beyond 2 TB on the disk."
43119 #: ../libguestfs-1.11.19/src/guestfs.pod:2935 ../src/guestfs.pod:2935
43121 "It is recommended that you use GPT partitions on disks which are larger than "
43122 "this size. GPT uses 64 bit sector numbers and so can address partitions "
43123 "which are theoretically larger than the largest disk we could support."
43127 #: ../libguestfs-1.11.19/src/guestfs.pod:2940 ../src/guestfs.pod:2940
43128 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
43132 #: ../libguestfs-1.11.19/src/guestfs.pod:2942 ../src/guestfs.pod:2942
43134 "This depends on the filesystem type. libguestfs itself does not impose any "
43135 "known limit. Consult Wikipedia or the filesystem documentation to find out "
43136 "what these limits are."
43140 #: ../libguestfs-1.11.19/src/guestfs.pod:2946 ../src/guestfs.pod:2946
43141 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
43145 #: ../libguestfs-1.11.19/src/guestfs.pod:2948 ../src/guestfs.pod:2948
43147 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
43148 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
43149 "uploads and downloads."
43153 #: ../libguestfs-1.11.19/src/guestfs.pod:2952 ../src/guestfs.pod:2952
43154 msgid "INSPECTION LIMITS"
43158 #: ../libguestfs-1.11.19/src/guestfs.pod:2954 ../src/guestfs.pod:2954
43160 "The inspection code has several arbitrary limits on things like the size of "
43161 "Windows Registry hive it will read, and the length of product name. These "
43162 "are intended to stop a malicious guest from consuming arbitrary amounts of "
43163 "memory and disk space on the host, and should not be reached in practice. "
43164 "See the source code for more information."
43168 #: ../libguestfs-1.11.19/src/guestfs.pod:2970 ../src/guestfs.pod:2970
43170 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
43171 "effect as calling C<guestfs_set_verbose (g, 1)>."
43175 #: ../libguestfs-1.11.19/src/guestfs.pod:2982 ../src/guestfs.pod:2982
43177 "Set the path that libguestfs uses to search for a supermin appliance. See "
43178 "the discussion of paths in section L</PATH> above."
43182 #: ../libguestfs-1.11.19/src/guestfs.pod:2991 ../src/guestfs.pod:2991
43183 msgid "See also L</QEMU WRAPPERS> above."
43187 #: ../libguestfs-1.11.19/src/guestfs.pod:2995 ../src/guestfs.pod:2995
43189 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
43190 "effect as calling C<guestfs_set_trace (g, 1)>."
43194 #: ../libguestfs-1.11.19/src/guestfs.pod:3013 ../src/guestfs.pod:3013
43196 "L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-"
43197 "ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in"
43198 "(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems"
43199 "(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-"
43200 "partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-"
43201 "tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)"
43202 ">, L<febootstrap(1)>, L<hivex(3)>, L<http://libguestfs.org/>."
43206 #: ../libguestfs-1.11.19/src/guestfs.pod:3040 ../src/guestfs.pod:3040
43208 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
43209 "(8)>, L<disktype(1)>."
43213 #: ../libguestfs-1.11.19/src/guestfs.pod:3047 ../src/guestfs.pod:3047
43214 #: ../tools/virt-make-fs.pl:553 ../tools/virt-win-reg.pl:761
43219 #: ../libguestfs-1.11.19/src/guestfs.pod:3049 ../src/guestfs.pod:3049
43220 msgid "To get a list of bugs against libguestfs use this link:"
43224 #: ../libguestfs-1.11.19/src/guestfs.pod:3051 ../src/guestfs.pod:3051
43226 "L<https://bugzilla.redhat.com/buglist.cgi?"
43227 "component=libguestfs&product=Virtualization+Tools>"
43231 #: ../libguestfs-1.11.19/src/guestfs.pod:3053 ../src/guestfs.pod:3053
43232 msgid "To report a new bug against libguestfs use this link:"
43236 #: ../libguestfs-1.11.19/src/guestfs.pod:3055 ../src/guestfs.pod:3055
43238 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
43239 "component=libguestfs&product=Virtualization+Tools>"
43243 #: ../libguestfs-1.11.19/src/guestfs.pod:3057 ../src/guestfs.pod:3057
43244 msgid "When reporting a bug, please check:"
43248 #: ../libguestfs-1.11.19/src/guestfs.pod:3063 ../src/guestfs.pod:3063
43249 msgid "That the bug hasn't been reported already."
43253 #: ../libguestfs-1.11.19/src/guestfs.pod:3067 ../src/guestfs.pod:3067
43254 msgid "That you are testing a recent version."
43258 #: ../libguestfs-1.11.19/src/guestfs.pod:3071 ../src/guestfs.pod:3071
43259 msgid "Describe the bug accurately, and give a way to reproduce it."
43263 #: ../libguestfs-1.11.19/src/guestfs.pod:3075 ../src/guestfs.pod:3075
43265 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
43270 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:5
43271 #: ../test-tool/libguestfs-test-tool.pod:5
43272 msgid "libguestfs-test-tool - End user tests for libguestfs"
43276 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:9
43277 #: ../test-tool/libguestfs-test-tool.pod:9
43280 " libguestfs-test-tool [--options]\n"
43285 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:13
43286 #: ../test-tool/libguestfs-test-tool.pod:13
43288 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
43289 "and developers, to allow them to check basic libguestfs functionality is "
43290 "working. This is needed because libguestfs occasionally breaks for reasons "
43291 "beyond our control: usually because of changes in the underlying qemu or "
43292 "kernel packages, or the host environment."
43296 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:20
43297 #: ../test-tool/libguestfs-test-tool.pod:20
43298 msgid "If you suspect a problem in libguestfs, then just run:"
43302 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:22
43303 #: ../test-tool/libguestfs-test-tool.pod:22
43306 " libguestfs-test-tool\n"
43311 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:24
43312 #: ../test-tool/libguestfs-test-tool.pod:24
43313 msgid "It will print lots of diagnostic messages."
43317 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:26
43318 #: ../test-tool/libguestfs-test-tool.pod:26
43319 msgid "If it runs to completion successfully, you will see this near the end:"
43323 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:28
43324 #: ../test-tool/libguestfs-test-tool.pod:28
43327 " ===== TEST FINISHED OK =====\n"
43332 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:30
43333 #: ../test-tool/libguestfs-test-tool.pod:30
43334 msgid "and the test tool will exit with code 0."
43338 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:32
43339 #: ../test-tool/libguestfs-test-tool.pod:32
43341 "If it fails (and/or exits with non-zero error code), please paste the "
43342 "B<complete, unedited> output of the test tool into a bug report. More "
43343 "information about reporting bugs can be found on the L<http://libguestfs.org/"
43348 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:41
43349 #: ../test-tool/libguestfs-test-tool.pod:41
43354 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:43
43355 #: ../test-tool/libguestfs-test-tool.pod:43
43356 msgid "Display short usage information and exit."
43360 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:45
43361 #: ../test-tool/libguestfs-test-tool.pod:45
43362 msgid "I<--qemu qemu_binary>"
43366 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:47
43367 #: ../test-tool/libguestfs-test-tool.pod:47
43369 "If you have downloaded another qemu binary, point this option at the full "
43370 "path of the binary to try it."
43374 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:50
43375 #: ../test-tool/libguestfs-test-tool.pod:50
43376 msgid "I<--qemudir qemu_source_dir>"
43380 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:52
43381 #: ../test-tool/libguestfs-test-tool.pod:52
43383 "If you have compiled qemu from source, point this option at the source "
43384 "directory to try it."
43388 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:55
43389 #: ../test-tool/libguestfs-test-tool.pod:55
43390 msgid "I<--timeout N>"
43394 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:57
43395 #: ../test-tool/libguestfs-test-tool.pod:57
43397 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
43398 "does not usually need to be adjusted unless your machine is very slow."
43402 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:63
43403 #: ../test-tool/libguestfs-test-tool.pod:63
43404 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
43408 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:65
43409 #: ../test-tool/libguestfs-test-tool.pod:65
43411 "If you have compiled another version of qemu from source and would like to "
43412 "try that, then you can use the I<--qemudir> option to point to the qemu "
43413 "source directory."
43417 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:69
43418 #: ../test-tool/libguestfs-test-tool.pod:69
43420 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
43421 "option to point to the binary."
43425 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:72
43426 #: ../test-tool/libguestfs-test-tool.pod:72
43428 "When using an alternate qemu with libguestfs, usually you would need to "
43429 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
43430 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
43431 "use either of the I<--qemudir> or I<--qemu> options."
43435 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:79
43436 #: ../test-tool/libguestfs-test-tool.pod:79
43438 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
43439 "I<1> if there was an error."
43443 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:84
43444 #: ../test-tool/libguestfs-test-tool.pod:84
43446 "For the full list of environment variables which may affect libguestfs, "
43447 "please see the L<guestfs(3)> manual page."
43451 #: ../libguestfs-1.11.19/test-tool/libguestfs-test-tool.pod:89
43452 #: ../test-tool/libguestfs-test-tool.pod:89
43453 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
43457 #: ../tools/virt-list-filesystems.pl:32
43459 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
43463 #: ../tools/virt-list-filesystems.pl:36
43466 " virt-list-filesystems [--options] domname\n"
43471 #: ../tools/virt-list-filesystems.pl:38
43474 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
43479 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
43481 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
43486 #: ../tools/virt-list-filesystems.pl:45
43488 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
43489 "are contained in a virtual machine or disk image."
43493 #: ../tools/virt-list-filesystems.pl:49
43495 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
43496 "functionality. For more complex cases you should look at the L<guestfish(1)"
43501 #: ../tools/virt-list-filesystems.pl:112
43503 "With this option, C<virt-list-filesystems> displays the type of each "
43504 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
43508 #: ../tools/virt-list-filesystems.pl:119
43513 #: ../tools/virt-list-filesystems.pl:123
43515 "Normally we only show mountable filesystems. If this option is given then "
43516 "swap devices are shown too."
43520 #: ../tools/virt-list-filesystems.pl:197
43522 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
43523 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
43524 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
43528 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
43529 msgid "Copyright (C) 2009 Red Hat Inc."
43533 #: ../tools/virt-list-partitions.pl:32
43535 "virt-list-partitions - List partitions in a virtual machine or disk image"
43539 #: ../tools/virt-list-partitions.pl:36
43542 " virt-list-partitions [--options] domname\n"
43547 #: ../tools/virt-list-partitions.pl:38
43550 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
43555 #: ../tools/virt-list-partitions.pl:45
43557 "C<virt-list-partitions> is a command line tool to list the partitions that "
43558 "are contained in a virtual machine or disk image. It is mainly useful as a "
43559 "first step to using L<virt-resize(1)>."
43563 #: ../tools/virt-list-partitions.pl:50
43565 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
43566 "functionality. For more complex cases you should look at the L<guestfish(1)"
43571 #: ../tools/virt-list-partitions.pl:113
43572 msgid "Show sizes in human-readable form (eg. \"1G\")."
43576 #: ../tools/virt-list-partitions.pl:123
43578 "With this option, C<virt-list-partitions> displays the type and size of each "
43579 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
43583 #: ../tools/virt-list-partitions.pl:130
43588 #: ../tools/virt-list-partitions.pl:132
43593 #: ../tools/virt-list-partitions.pl:134
43595 "Display the total size of each block device (as a separate row or rows)."
43599 #: ../tools/virt-list-partitions.pl:267
43601 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
43602 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
43603 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
43607 #: ../tools/virt-list-partitions.pl:283
43608 msgid "Copyright (C) 2009-2010 Red Hat Inc."
43612 #: ../tools/virt-make-fs.pl:37
43613 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
43617 #: ../tools/virt-make-fs.pl:41
43620 " virt-make-fs [--options] input.tar output.img\n"
43625 #: ../tools/virt-make-fs.pl:43
43628 " virt-make-fs [--options] input.tar.gz output.img\n"
43633 #: ../tools/virt-make-fs.pl:45
43636 " virt-make-fs [--options] directory output.img\n"
43641 #: ../tools/virt-make-fs.pl:49
43643 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
43644 "archive or some files in a directory. It is similar to tools like L<mkisofs"
43645 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
43646 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
43647 "you want to attach these filesystems to existing virtual machines (eg. to "
43648 "import large amounts of read-only data to a VM)."
43652 #: ../tools/virt-make-fs.pl:57
43653 msgid "Basic usage is:"
43657 #: ../tools/virt-make-fs.pl:59
43660 " virt-make-fs input output\n"
43665 #: ../tools/virt-make-fs.pl:61
43667 "where C<input> is either a directory containing files that you want to add, "
43668 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
43669 "C<output> is a disk image. The input type is detected automatically. The "
43670 "output disk image defaults to a raw ext2 image unless you specify extra "
43671 "flags (see L</OPTIONS> below)."
43675 #: ../tools/virt-make-fs.pl:67
43676 msgid "EXTRA SPACE"
43680 #: ../tools/virt-make-fs.pl:69
43682 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
43683 "the files that it contains, but might have extra space. Depending on how "
43684 "you are going to use the output, you might think this extra space is wasted "
43685 "and want to minimize it, or you might want to leave space so that more files "
43686 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
43687 "but you can use the I<--size> flag to leave space in the filesystem if you "
43692 #: ../tools/virt-make-fs.pl:77
43694 "An alternative way to leave extra space but not make the output image any "
43695 "bigger is to use an alternative disk image format (instead of the default "
43696 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
43697 "image format (check your hypervisor supports this before using it). This "
43698 "allows you to choose a large I<--size> but the extra space won't actually be "
43699 "allocated in the image until you try to store something in it."
43703 #: ../tools/virt-make-fs.pl:85
43705 "Don't forget that you can also use local commands including L<resize2fs(8)> "
43706 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
43707 "to build another image from scratch."
43711 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
43712 #: ../tools/virt-make-fs.pl:142
43717 #: ../tools/virt-make-fs.pl:91
43720 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
43725 #: ../tools/virt-make-fs.pl:93
43726 msgid "FILESYSTEM TYPE"
43730 #: ../tools/virt-make-fs.pl:95
43732 "The default filesystem type is C<ext2>. Just about any filesystem type that "
43733 "libguestfs supports can be used (but I<not> read-only formats like "
43734 "ISO9660). Here are some of the more common choices:"
43738 #: ../tools/virt-make-fs.pl:101
43743 #: ../tools/virt-make-fs.pl:103
43745 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
43746 "you are not going to use the filesystem in a way that requires the journal, "
43747 "then this is just wasted overhead."
43751 #: ../tools/virt-make-fs.pl:107
43752 msgid "I<ntfs> or I<vfat>"
43756 #: ../tools/virt-make-fs.pl:109
43757 msgid "Useful if exporting data to a Windows guest."
43761 #: ../tools/virt-make-fs.pl:111
43763 "I<Note for vfat>: The tar archive or local directory must only contain files "
43764 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
43765 "program running within libguestfs is unable to change the ownership of non-"
43766 "root files, since vfat itself does not support this."
43770 #: ../tools/virt-make-fs.pl:116
43775 #: ../tools/virt-make-fs.pl:118
43777 "Lower overhead than C<ext2>, but certain limitations on filename length and "
43778 "total filesystem size."
43782 #: ../tools/virt-make-fs.pl:125
43785 " virt-make-fs --type=minix input minixfs.img\n"
43790 #: ../tools/virt-make-fs.pl:127
43791 msgid "TO PARTITION OR NOT TO PARTITION"
43795 #: ../tools/virt-make-fs.pl:129
43796 msgid "Optionally virt-make-fs can add a partition table to the output disk."
43800 #: ../tools/virt-make-fs.pl:131
43802 "Adding a partition can make the disk image more compatible with certain "
43803 "virtualized operating systems which don't expect to see a filesystem "
43804 "directly located on a block device (Linux doesn't care and will happily "
43805 "handle both types)."
43809 #: ../tools/virt-make-fs.pl:136
43811 "On the other hand, if you have a partition table then the output image is no "
43812 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
43813 "directly on a partitioned disk image. (However libguestfs tools such as "
43814 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
43818 #: ../tools/virt-make-fs.pl:144
43819 msgid "Add an MBR partition:"
43823 #: ../tools/virt-make-fs.pl:146
43826 " virt-make-fs --partition -- input disk.img\n"
43831 #: ../tools/virt-make-fs.pl:148
43833 "If the output disk image could be terabyte-sized or larger, it's better to "
43834 "use an EFI/GPT-compatible partition table:"
43838 #: ../tools/virt-make-fs.pl:151
43841 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
43846 #: ../tools/virt-make-fs.pl:179
43847 msgid "Enable debugging information."
43851 #: ../tools/virt-make-fs.pl:185
43852 msgid "B<--size=E<lt>NE<gt>>"
43856 #: ../tools/virt-make-fs.pl:187
43857 msgid "B<--size=+E<lt>NE<gt>>"
43861 #: ../tools/virt-make-fs.pl:189
43862 msgid "B<-s E<lt>NE<gt>>"
43866 #: ../tools/virt-make-fs.pl:191
43867 msgid "B<-s +E<lt>NE<gt>>"
43871 #: ../tools/virt-make-fs.pl:193
43873 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
43877 #: ../tools/virt-make-fs.pl:196
43879 "If this option is I<not> given, then the output image will be just large "
43880 "enough to contain all the files, with not much wasted space."
43884 #: ../tools/virt-make-fs.pl:199
43886 "To choose a fixed size output disk, specify an absolute number followed by b/"
43887 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
43888 "Petabytes or Exabytes. This must be large enough to contain all the input "
43889 "files, else you will get an error."
43893 #: ../tools/virt-make-fs.pl:204
43895 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
43896 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
43897 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
43898 "the input files, and (approximately) an extra 200 MB free space."
43902 #: ../tools/virt-make-fs.pl:210
43904 "Note that virt-make-fs estimates free space, and therefore will not produce "
43905 "filesystems containing precisely the free space requested. (It is much more "
43906 "expensive and time-consuming to produce a filesystem which has precisely the "
43907 "desired free space)."
43911 #: ../tools/virt-make-fs.pl:219
43912 msgid "B<--format=E<lt>fmtE<gt>>"
43916 #: ../tools/virt-make-fs.pl:221
43917 msgid "B<-F E<lt>fmtE<gt>>"
43921 #: ../tools/virt-make-fs.pl:223
43922 msgid "Choose the output disk image format."
43926 #: ../tools/virt-make-fs.pl:225
43927 msgid "The default is C<raw> (raw disk image)."
43931 #: ../tools/virt-make-fs.pl:227
43933 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
43934 "that would really make sense here is C<qcow2>."
43938 #: ../tools/virt-make-fs.pl:234
43939 msgid "B<--type=E<lt>fsE<gt>>"
43943 #: ../tools/virt-make-fs.pl:236
43944 msgid "B<-t E<lt>fsE<gt>>"
43948 #: ../tools/virt-make-fs.pl:238
43949 msgid "Choose the output filesystem type."
43953 #: ../tools/virt-make-fs.pl:240
43954 msgid "The default is C<ext2>."
43958 #: ../tools/virt-make-fs.pl:242
43960 "Any filesystem which is supported read-write by libguestfs can be used here."
43964 #: ../tools/virt-make-fs.pl:249
43965 msgid "B<--partition>"
43969 #: ../tools/virt-make-fs.pl:251
43970 msgid "B<--partition=E<lt>parttypeE<gt>>"
43974 #: ../tools/virt-make-fs.pl:253
43976 "If specified, this flag adds an MBR partition table to the output disk image."
43980 #: ../tools/virt-make-fs.pl:256
43982 "You can change the partition table type, eg. I<--partition=gpt> for large "
43987 #: ../tools/virt-make-fs.pl:259
43989 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
43990 "might consider the next parameter to be the partition type. For example:"
43994 #: ../tools/virt-make-fs.pl:263
43997 " virt-make-fs --partition input.tar ...\n"
44002 #: ../tools/virt-make-fs.pl:265
44004 "would cause virt-make-fs to think you wanted to use a partition type of "
44005 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
44006 "dash) between options and the input file argument:"
44010 #: ../tools/virt-make-fs.pl:269
44013 " virt-make-fs --partition -- input.tar ...\n"
44018 #: ../tools/virt-make-fs.pl:541
44020 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
44021 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
44022 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
44026 #: ../tools/virt-make-fs.pl:555 ../tools/virt-win-reg.pl:763
44028 "When reporting bugs, please enable debugging and capture the I<complete> "
44033 #: ../tools/virt-make-fs.pl:558
44036 " export LIBGUESTFS_DEBUG=1\n"
44037 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
44042 #: ../tools/virt-make-fs.pl:561
44044 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
44049 #: ../tools/virt-tar.pl:33
44050 msgid "virt-tar - Extract or upload files to a virtual machine"
44054 #: ../tools/virt-tar.pl:37
44057 " virt-tar [--options] -x domname directory tarball\n"
44062 #: ../tools/virt-tar.pl:39
44065 " virt-tar [--options] -u domname tarball directory\n"
44070 #: ../tools/virt-tar.pl:41
44073 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
44078 #: ../tools/virt-tar.pl:43
44081 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
44086 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
44091 #: ../tools/virt-tar.pl:47
44093 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
44094 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
44098 #: ../tools/virt-tar.pl:52
44099 msgid "Download C</home> from the VM into a local tarball:"
44103 #: ../tools/virt-tar.pl:54
44106 " virt-tar -x domname /home home.tar\n"
44111 #: ../tools/virt-tar.pl:56
44114 " virt-tar -zx domname /home home.tar.gz\n"
44119 #: ../tools/virt-tar.pl:58
44120 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
44124 #: ../tools/virt-tar.pl:60
44127 " virt-tar -u domname uploadstuff.tar /tmp\n"
44132 #: ../tools/virt-tar.pl:62
44135 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
44140 #: ../tools/virt-tar.pl:66
44142 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
44143 "virtual machines. If you do this, you risk disk corruption in the VM. "
44144 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
44148 #: ../tools/virt-tar.pl:71
44150 "You can use I<-x> (extract) on live virtual machines, but you might get "
44151 "inconsistent results or errors if there is filesystem activity inside the "
44152 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
44153 "work, but the only way to guarantee consistent results is if the virtual "
44154 "machine is shut down."
44158 #: ../tools/virt-tar.pl:79
44160 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
44161 "parts of a guest filesystem. There are many possibilities: making backups, "
44162 "uploading data files, snooping on guest activity, fixing or customizing "
44167 #: ../tools/virt-tar.pl:84
44169 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
44170 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
44171 "should look at the L<guestfish(1)> tool."
44175 #: ../tools/virt-tar.pl:88
44177 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
44178 "its contents (recursively) from the virtual machine into a local tarball. "
44179 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
44180 "virtual machine. You cannot use these two options together."
44184 #: ../tools/virt-tar.pl:94
44186 "In addition, you may need to use the I<-z> (gZip) option to enable "
44187 "compression. When uploading, you have to specify I<-z> if the upload file "
44188 "is compressed because virt-tar won't detect this on its own."
44192 #: ../tools/virt-tar.pl:98
44194 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
44195 "example it cannot do PKZip files or bzip2 compression. If you want that "
44196 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
44197 "the L<libguestfs(3)> API)."
44201 #: ../tools/virt-tar.pl:160
44202 msgid "B<--extract>"
44206 #: ../tools/virt-tar.pl:162
44207 msgid "B<--download>"
44211 #: ../tools/virt-tar.pl:164
44216 #: ../tools/virt-tar.pl:166
44217 msgid "B<--upload>"
44221 #: ../tools/virt-tar.pl:168
44223 "Use I<-x> to extract (download) a directory from a virtual machine to a "
44228 #: ../tools/virt-tar.pl:171
44230 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
44231 "Please read the L</WARNING> section above before using this option."
44235 #: ../tools/virt-tar.pl:175
44236 msgid "You must specify exactly one of these options."
44240 #: ../tools/virt-tar.pl:181
44245 #: ../tools/virt-tar.pl:183
44250 #: ../tools/virt-tar.pl:185
44251 msgid "Specify that the input or output tarball is gzip-compressed."
44255 #: ../tools/virt-tar.pl:298
44257 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
44258 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
44259 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
44264 #: ../tools/virt-win-reg.pl:37
44266 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
44270 #: ../tools/virt-win-reg.pl:41
44273 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
44278 #: ../tools/virt-win-reg.pl:43
44281 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
44286 #: ../tools/virt-win-reg.pl:45
44289 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
44294 #: ../tools/virt-win-reg.pl:47
44297 " virt-win-reg --merge domname [input.reg ...]\n"
44302 #: ../tools/virt-win-reg.pl:49
44305 " virt-win-reg [--options] disk.img ... # instead of domname\n"
44310 #: ../tools/virt-win-reg.pl:53
44312 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
44313 "virtual machines. If you do this, you I<will> get irreversible disk "
44314 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
44315 "but doesn't catch all cases."
44319 #: ../tools/virt-win-reg.pl:58
44321 "Modifying the Windows Registry is an inherently risky operation. The format "
44322 "is deliberately obscure and undocumented, and Registry changes can leave the "
44323 "system unbootable. Therefore when using the I<--merge> option, make sure "
44324 "you have a reliable backup first."
44328 #: ../tools/virt-win-reg.pl:65
44330 "This program can export and merge Windows Registry entries from a Windows "
44335 #: ../tools/virt-win-reg.pl:68
44337 "The first parameter is the libvirt guest name or the raw disk image of a "
44342 #: ../tools/virt-win-reg.pl:71
44344 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
44345 "exported (recursively). For example:"
44349 #: ../tools/virt-win-reg.pl:74
44352 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
44357 #: ../tools/virt-win-reg.pl:76
44359 "You can also display single values from within registry keys, for example:"
44363 #: ../tools/virt-win-reg.pl:79
44366 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
44367 " $ virt-win-reg Windows7 $cvkey ProductName\n"
44368 " Windows 7 Enterprise\n"
44373 #: ../tools/virt-win-reg.pl:83
44375 "With I<--merge>, you can merge a textual regedit file into the Windows "
44380 #: ../tools/virt-win-reg.pl:86
44383 " $ virt-win-reg --merge Windows7 changes.reg\n"
44388 #: ../tools/virt-win-reg.pl:90
44390 "This program is only meant for simple access to the registry. If you want "
44391 "to do complicated things with the registry, we suggest you download the "
44392 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
44393 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
44394 "L<hivexregedit(1)>."
44398 #: ../tools/virt-win-reg.pl:159
44403 #: ../tools/virt-win-reg.pl:161
44405 "In merge mode, this merges a textual regedit file into the Windows Registry "
44406 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
44407 "displays or exports Registry entries instead."
44411 #: ../tools/virt-win-reg.pl:165
44413 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
44414 "result in disk corruption. However exporting (without this flag) is always "
44419 #: ../tools/virt-win-reg.pl:173
44420 msgid "B<--encoding> UTF-16LE|ASCII"
44424 #: ../tools/virt-win-reg.pl:175
44426 "When merging (only), you may need to specify the encoding for strings to be "
44427 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
44428 "(3)/ENCODING STRINGS>."
44432 #: ../tools/virt-win-reg.pl:179
44434 "The default is to use UTF-16LE, which should work with recent versions of "
44439 #: ../tools/virt-win-reg.pl:186
44440 msgid "B<--unsafe-printable-strings>"
44444 #: ../tools/virt-win-reg.pl:188
44446 "When exporting (only), assume strings are UTF-16LE and print them as strings "
44447 "instead of hex sequences. Remove the final zero codepoint from strings if "
44452 #: ../tools/virt-win-reg.pl:192
44454 "This is unsafe and does not preserve the fidelity of strings in the original "
44455 "Registry for various reasons:"
44459 #: ../tools/virt-win-reg.pl:199
44461 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
44462 "other encodings will be corrupted by this transformation."
44466 #: ../tools/virt-win-reg.pl:204
44468 "Assumes that everything which has type 1 or 2 is really a string and that "
44469 "everything else is not a string, but the type field in real Registries is "
44474 #: ../tools/virt-win-reg.pl:210
44476 "Loses information about whether a zero codepoint followed the string in the "
44481 #: ../tools/virt-win-reg.pl:215
44483 "This all happens because the Registry itself contains no information about "
44484 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
44488 #: ../tools/virt-win-reg.pl:219
44490 "You should only use this option for quick hacking and debugging of the "
44491 "Registry contents, and I<never> use it if the output is going to be passed "
44492 "into another program or stored in another Registry."
44496 #: ../tools/virt-win-reg.pl:556
44497 msgid "SUPPORTED SYSTEMS"
44501 #: ../tools/virt-win-reg.pl:558
44503 "The program currently supports Windows NT-derived guests starting with "
44504 "Windows XP through to at least Windows 7."
44508 #: ../tools/virt-win-reg.pl:561
44509 msgid "The following Registry keys are supported:"
44513 #: ../tools/virt-win-reg.pl:565
44514 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
44518 #: ../tools/virt-win-reg.pl:567
44519 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
44523 #: ../tools/virt-win-reg.pl:569
44524 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
44528 #: ../tools/virt-win-reg.pl:571
44529 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
44533 #: ../tools/virt-win-reg.pl:573
44534 msgid "C<HKEY_USERS\\.DEFAULT>"
44538 #: ../tools/virt-win-reg.pl:575
44539 msgid "C<HKEY_USERS\\I<SID>>"
44543 #: ../tools/virt-win-reg.pl:577
44544 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
44548 #: ../tools/virt-win-reg.pl:579
44549 msgid "C<HKEY_USERS\\I<username>>"
44553 #: ../tools/virt-win-reg.pl:581
44555 "where I<username> is a local user name (this is a libguestfs extension)."
44559 #: ../tools/virt-win-reg.pl:585
44561 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
44566 #: ../tools/virt-win-reg.pl:588
44568 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
44569 "supported (there is no \"current user\")."
44573 #: ../tools/virt-win-reg.pl:591
44578 #: ../tools/virt-win-reg.pl:593
44580 "C<virt-win-reg> expects that regedit files have already been reencoded in "
44581 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
44582 "style line endings. Since Windows regedit files are often in UTF-16LE with "
44583 "Windows-style line endings, you may need to reencode the whole file before "
44584 "or after processing."
44588 #: ../tools/virt-win-reg.pl:599
44590 "To reencode a file from Windows format to Linux (before processing it with "
44591 "the I<--merge> option), you would do something like this:"
44595 #: ../tools/virt-win-reg.pl:602
44598 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
44603 #: ../tools/virt-win-reg.pl:604
44605 "To go in the opposite direction, after exporting and before sending the file "
44606 "to a Windows user, do something like this:"
44610 #: ../tools/virt-win-reg.pl:607
44613 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
44618 #: ../tools/virt-win-reg.pl:609
44619 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
44623 #: ../tools/virt-win-reg.pl:611
44625 "If you are unsure about the current encoding, use the L<file(1)> command. "
44626 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
44627 "style (CRLF) line endings, like this:"
44631 #: ../tools/virt-win-reg.pl:615
44634 " $ file software.reg\n"
44635 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
44636 " with CRLF line terminators\n"
44641 #: ../tools/virt-win-reg.pl:619
44642 msgid "This file would need conversion before you could I<--merge> it."
44646 #: ../tools/virt-win-reg.pl:621
44647 msgid "CurrentControlSet etc."
44651 #: ../tools/virt-win-reg.pl:623
44653 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
44654 "Registry at the level of the hive file, and therefore you cannot modify "
44659 #: ../tools/virt-win-reg.pl:627
44661 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
44662 "circumstances it might refer to another control set. The way to find out is "
44663 "to look at the C<HKLM\\SYSTEM\\Select> key:"
44667 #: ../tools/virt-win-reg.pl:631
44670 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
44671 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
44672 " \"Current\"=dword:00000001\n"
44673 " \"Default\"=dword:00000001\n"
44674 " \"Failed\"=dword:00000000\n"
44675 " \"LastKnownGood\"=dword:00000002\n"
44680 #: ../tools/virt-win-reg.pl:638
44681 msgid "\"Current\" is the one which Windows will choose when it boots."
44685 #: ../tools/virt-win-reg.pl:640
44687 "Similarly, other C<Current...> keys in the path may need to be replaced."
44691 #: ../tools/virt-win-reg.pl:643
44692 msgid "WINDOWS TIPS"
44696 #: ../tools/virt-win-reg.pl:645
44698 "Note that some of these tips modify the guest disk image. The guest I<must> "
44699 "be shut off, else you will get disk corruption."
44703 #: ../tools/virt-win-reg.pl:648
44704 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
44708 #: ../tools/virt-win-reg.pl:650
44710 "Prepare a DOS batch script, VBScript or executable. Upload this using "
44711 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
44712 "is uploaded into C<C:\\>:"
44716 #: ../tools/virt-win-reg.pl:654
44719 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
44724 #: ../tools/virt-win-reg.pl:656
44725 msgid "Prepare a regedit file containing the registry change:"
44729 #: ../tools/virt-win-reg.pl:658
44732 " cat > test.reg <<'EOF'\n"
44733 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
44734 " \"Test\"=\"c:\\\\test.bat\"\n"
44740 #: ../tools/virt-win-reg.pl:663
44742 "In this example we use the key C<RunOnce> which means that the script will "
44743 "run precisely once when the first user logs in. If you want it to run every "
44744 "time a user logs in, replace C<RunOnce> with C<Run>."
44748 #: ../tools/virt-win-reg.pl:667
44749 msgid "Now update the registry:"
44753 #: ../tools/virt-win-reg.pl:669
44756 " virt-win-reg --merge WindowsGuest test.reg\n"
44761 #: ../tools/virt-win-reg.pl:671
44762 msgid "INSTALLING A SERVICE"
44766 #: ../tools/virt-win-reg.pl:673
44768 "This section assumes you are familiar with Windows services, and you either "
44769 "have a program which handles the Windows Service Control Protocol directly "
44770 "or you want to run any program using a service wrapper like SrvAny or the "
44775 #: ../tools/virt-win-reg.pl:678
44777 "First upload the program and optionally the service wrapper. In this case "
44778 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
44782 #: ../tools/virt-win-reg.pl:682
44785 " guestfish -i -d WindowsGuest <<EOF\n"
44786 " upload rhsrvany.exe /rhsrvany.exe\n"
44787 " upload test.exe /test.exe\n"
44793 #: ../tools/virt-win-reg.pl:687
44795 "Prepare a regedit file containing the registry changes. In this example, "
44796 "the first registry change is needed for the service itself or the service "
44797 "wrapper (if used). The second registry change is only needed because I am "
44798 "using the RHSrvAny service wrapper."
44802 #: ../tools/virt-win-reg.pl:692
44805 " cat > service.reg <<'EOF'\n"
44806 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
44807 " \"Type\"=dword:00000010\n"
44808 " \"Start\"=dword:00000002\n"
44809 " \"ErrorControl\"=dword:00000001\n"
44810 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
44811 " \"DisplayName\"=\"RHSrvAny\"\n"
44812 " \"ObjectName\"=\"NetworkService\"\n"
44817 #: ../tools/virt-win-reg.pl:701
44820 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
44821 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
44822 " \"PWD\"=\"c:\\\\Temp\"\n"
44828 #: ../tools/virt-win-reg.pl:712
44830 "For use of C<ControlSet001> see the section above in this manual page. You "
44831 "may need to adjust this according to the control set that is in use by the "
44836 #: ../tools/virt-win-reg.pl:718
44838 "C<\"ObjectName\"> controls the privileges that the service will have. An "
44839 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
44840 "privileged account."
44844 #: ../tools/virt-win-reg.pl:724
44846 "For the meaning of the magic numbers, see this Microsoft KB article: "
44847 "L<http://support.microsoft.com/kb/103000>."
44851 #: ../tools/virt-win-reg.pl:729
44852 msgid "Update the registry:"
44856 #: ../tools/virt-win-reg.pl:731
44859 " virt-win-reg --merge WindowsGuest service.reg\n"
44864 #: ../tools/virt-win-reg.pl:735
44866 "Be careful when passing parameters containing C<\\> (backslash) in the "
44867 "shell. Usually you will have to use 'single quotes' or double backslashes "
44868 "(but not both) to protect them from the shell."
44872 #: ../tools/virt-win-reg.pl:739
44873 msgid "Paths and value names are case-insensitive."
44877 #: ../tools/virt-win-reg.pl:748
44879 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
44880 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
44881 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
44885 #: ../tools/virt-win-reg.pl:766
44888 " export LIBGUESTFS_DEBUG=1\n"
44889 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
44894 #: ../tools/virt-win-reg.pl:769
44896 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."