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-19 18:42+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 ../java/examples/guestfs-java.pod:3
29 #: ../libguestfs-1.11.20/cat/virt-cat.pod:3
30 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:3
31 #: ../libguestfs-1.11.20/cat/virt-ls.pod:3
32 #: ../libguestfs-1.11.20/df/virt-df.pod:3
33 #: ../libguestfs-1.11.20/edit/virt-edit.pod:3
34 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:3
35 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:14
36 #: ../libguestfs-1.11.20/fish/guestfish.pod:3
37 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:3
38 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:3
39 #: ../libguestfs-1.11.20/fish/virt-tar-in.pod:3
40 #: ../libguestfs-1.11.20/fish/virt-tar-out.pod:3
41 #: ../libguestfs-1.11.20/fuse/guestmount.pod:3
42 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:3
43 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:3
44 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:3
45 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:3
46 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:3
47 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:3
48 #: ../libguestfs-1.11.20/resize/virt-resize.pod:3
49 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:3
50 #: ../libguestfs-1.11.20/src/guestfs.pod:3
51 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:3
52 #: ../ocaml/examples/guestfs-ocaml.pod:3 ../perl/examples/guestfs-perl.pod:3
53 #: ../python/examples/guestfs-python.pod:3 ../rescue/virt-rescue.pod:3
54 #: ../resize/virt-resize.pod:3 ../ruby/examples/guestfs-ruby.pod:3
55 #: ../src/guestfs.pod:3 ../test-tool/libguestfs-test-tool.pod:3
56 #: ../tools/virt-list-filesystems.pl:30 ../tools/virt-list-partitions.pl:30
57 #: ../tools/virt-make-fs.pl:35 ../tools/virt-tar.pl:31
58 #: ../tools/virt-win-reg.pl:35
63 #: ../cat/virt-cat.pod:5 ../libguestfs-1.11.20/cat/virt-cat.pod:5
64 msgid "virt-cat - Display files in a virtual machine"
68 #: ../cat/virt-cat.pod:7 ../cat/virt-filesystems.pod:7 ../cat/virt-ls.pod:7
69 #: ../df/virt-df.pod:7 ../edit/virt-edit.pod:7
70 #: ../examples/guestfs-examples.pod:7 ../fish/guestfish.pod:7
71 #: ../fish/virt-copy-in.pod:7 ../fish/virt-copy-out.pod:7
72 #: ../fish/virt-tar-in.pod:7 ../fish/virt-tar-out.pod:7
73 #: ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pod:7
74 #: ../java/examples/guestfs-java.pod:7
75 #: ../libguestfs-1.11.20/cat/virt-cat.pod:7
76 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:7
77 #: ../libguestfs-1.11.20/cat/virt-ls.pod:7
78 #: ../libguestfs-1.11.20/df/virt-df.pod:7
79 #: ../libguestfs-1.11.20/edit/virt-edit.pod:7
80 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:7
81 #: ../libguestfs-1.11.20/fish/guestfish.pod:7
82 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:7
83 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:7
84 #: ../libguestfs-1.11.20/fish/virt-tar-in.pod:7
85 #: ../libguestfs-1.11.20/fish/virt-tar-out.pod:7
86 #: ../libguestfs-1.11.20/fuse/guestmount.pod:7
87 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:7
88 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:7
89 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:7
90 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:7
91 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:7
92 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:7
93 #: ../libguestfs-1.11.20/resize/virt-resize.pod:7
94 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:7
95 #: ../libguestfs-1.11.20/src/guestfs.pod:7
96 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:7
97 #: ../ocaml/examples/guestfs-ocaml.pod:7 ../perl/examples/guestfs-perl.pod:7
98 #: ../python/examples/guestfs-python.pod:7 ../rescue/virt-rescue.pod:7
99 #: ../resize/virt-resize.pod:7 ../ruby/examples/guestfs-ruby.pod:7
100 #: ../src/guestfs.pod:7 ../test-tool/libguestfs-test-tool.pod:7
101 #: ../tools/virt-list-filesystems.pl:34 ../tools/virt-list-partitions.pl:34
102 #: ../tools/virt-make-fs.pl:39 ../tools/virt-tar.pl:35
103 #: ../tools/virt-win-reg.pl:39
108 #: ../cat/virt-cat.pod:9 ../libguestfs-1.11.20/cat/virt-cat.pod:9
111 " virt-cat [--options] -d domname file [file ...]\n"
116 #: ../cat/virt-cat.pod:11 ../libguestfs-1.11.20/cat/virt-cat.pod:11
119 " virt-cat [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
124 #: ../cat/virt-cat.pod:13 ../edit/virt-edit.pod:15
125 #: ../inspector/virt-inspector.pod:13
126 #: ../libguestfs-1.11.20/cat/virt-cat.pod:13
127 #: ../libguestfs-1.11.20/edit/virt-edit.pod:15
128 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:13
133 #: ../cat/virt-cat.pod:15 ../libguestfs-1.11.20/cat/virt-cat.pod:15
136 " virt-cat domname file\n"
141 #: ../cat/virt-cat.pod:17 ../libguestfs-1.11.20/cat/virt-cat.pod:17
144 " virt-cat disk.img file\n"
149 #: ../cat/virt-cat.pod:19 ../cat/virt-filesystems.pod:13 ../cat/virt-ls.pod:19
150 #: ../df/virt-df.pod:21 ../edit/virt-edit.pod:27
151 #: ../examples/guestfs-examples.pod:19 ../examples/guestfs-recipes.pod:18
152 #: ../fish/guestfish.pod:30 ../fish/virt-copy-in.pod:19
153 #: ../fish/virt-copy-out.pod:13 ../fish/virt-tar-in.pod:21
154 #: ../fish/virt-tar-out.pod:15 ../fuse/guestmount.pod:20
155 #: ../inspector/virt-inspector.pod:19 ../java/examples/guestfs-java.pod:15
156 #: ../libguestfs-1.11.20/cat/virt-cat.pod:19
157 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:13
158 #: ../libguestfs-1.11.20/cat/virt-ls.pod:19
159 #: ../libguestfs-1.11.20/df/virt-df.pod:21
160 #: ../libguestfs-1.11.20/edit/virt-edit.pod:27
161 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:19
162 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:18
163 #: ../libguestfs-1.11.20/fish/guestfish.pod:30
164 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:19
165 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:13
166 #: ../libguestfs-1.11.20/fish/virt-tar-in.pod:21
167 #: ../libguestfs-1.11.20/fish/virt-tar-out.pod:15
168 #: ../libguestfs-1.11.20/fuse/guestmount.pod:20
169 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:19
170 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:15
171 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:25
172 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:18
173 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:14
174 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:29
175 #: ../libguestfs-1.11.20/resize/virt-resize.pod:13
176 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:15
177 #: ../libguestfs-1.11.20/src/guestfs.pod:23
178 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:11
179 #: ../ocaml/examples/guestfs-ocaml.pod:25 ../perl/examples/guestfs-perl.pod:18
180 #: ../python/examples/guestfs-python.pod:14 ../rescue/virt-rescue.pod:29
181 #: ../resize/virt-resize.pod:13 ../ruby/examples/guestfs-ruby.pod:15
182 #: ../src/guestfs.pod:23 ../test-tool/libguestfs-test-tool.pod:11
183 #: ../tools/virt-list-filesystems.pl:40 ../tools/virt-list-partitions.pl:40
184 #: ../tools/virt-make-fs.pl:47 ../tools/virt-tar.pl:77
185 #: ../tools/virt-win-reg.pl:63
190 #: ../cat/virt-cat.pod:21 ../libguestfs-1.11.20/cat/virt-cat.pod:21
192 "C<virt-cat> is a command line tool to display the contents of C<file> where "
193 "C<file> exists in the named virtual machine (or disk image)."
197 #: ../cat/virt-cat.pod:24 ../libguestfs-1.11.20/cat/virt-cat.pod:24
199 "Multiple filenames can be given, in which case they are concatenated "
200 "together. Each filename must be a full path, starting at the root directory "
201 "(starting with '/')."
205 #: ../cat/virt-cat.pod:28 ../libguestfs-1.11.20/cat/virt-cat.pod:28
207 "C<virt-cat> can be used to quickly view a file. To edit a file, use C<virt-"
208 "edit>. For more complex cases you should look at the L<guestfish(1)> tool "
209 "(see L</USING GUESTFISH> below)."
213 #: ../cat/virt-cat.pod:32 ../cat/virt-ls.pod:35 ../df/virt-df.pod:43
214 #: ../edit/virt-edit.pod:44 ../fish/guestfish.pod:41
215 #: ../fish/guestfish.pod:1007 ../fish/virt-copy-in.pod:29
216 #: ../fish/virt-copy-out.pod:21 ../fish/virt-tar-in.pod:30
217 #: ../fish/virt-tar-out.pod:24 ../fuse/guestmount.pod:39
218 #: ../libguestfs-1.11.20/cat/virt-cat.pod:32
219 #: ../libguestfs-1.11.20/cat/virt-ls.pod:35
220 #: ../libguestfs-1.11.20/df/virt-df.pod:43
221 #: ../libguestfs-1.11.20/edit/virt-edit.pod:44
222 #: ../libguestfs-1.11.20/fish/guestfish.pod:41
223 #: ../libguestfs-1.11.20/fish/guestfish.pod:1007
224 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:29
225 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:21
226 #: ../libguestfs-1.11.20/fish/virt-tar-in.pod:30
227 #: ../libguestfs-1.11.20/fish/virt-tar-out.pod:24
228 #: ../libguestfs-1.11.20/fuse/guestmount.pod:39
229 #: ../libguestfs-1.11.20/resize/virt-resize.pod:27
230 #: ../resize/virt-resize.pod:27 ../tools/virt-tar.pl:50
235 #: ../cat/virt-cat.pod:34 ../libguestfs-1.11.20/cat/virt-cat.pod:34
237 "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
241 #: ../cat/virt-cat.pod:37 ../libguestfs-1.11.20/cat/virt-cat.pod:37
244 " virt-cat -d mydomain /etc/fstab\n"
249 #: ../cat/virt-cat.pod:39 ../libguestfs-1.11.20/cat/virt-cat.pod:39
250 msgid "List syslog messages from a VM disk image file:"
254 #: ../cat/virt-cat.pod:41 ../libguestfs-1.11.20/cat/virt-cat.pod:41
257 " virt-cat -a disk.img /var/log/messages | tail\n"
262 #: ../cat/virt-cat.pod:43 ../libguestfs-1.11.20/cat/virt-cat.pod:43
263 msgid "Find out what DHCP IP address a VM acquired:"
267 #: ../cat/virt-cat.pod:45 ../libguestfs-1.11.20/cat/virt-cat.pod:45
270 " virt-cat -d mydomain /var/log/messages | \\\n"
271 " grep 'dhclient: bound to' | tail\n"
276 #: ../cat/virt-cat.pod:48 ../libguestfs-1.11.20/cat/virt-cat.pod:48
277 msgid "Find out what packages were recently installed:"
281 #: ../cat/virt-cat.pod:50 ../libguestfs-1.11.20/cat/virt-cat.pod:50
284 " virt-cat -d mydomain /var/log/yum.log | tail\n"
289 #: ../cat/virt-cat.pod:52 ../libguestfs-1.11.20/cat/virt-cat.pod:52
290 msgid "Find out who is logged on inside a virtual machine:"
294 #: ../cat/virt-cat.pod:54 ../libguestfs-1.11.20/cat/virt-cat.pod:54
297 " virt-cat -d mydomain /var/run/utmp > /tmp/utmp\n"
303 #: ../cat/virt-cat.pod:57 ../libguestfs-1.11.20/cat/virt-cat.pod:57
304 msgid "or who was logged on:"
308 #: ../cat/virt-cat.pod:59 ../libguestfs-1.11.20/cat/virt-cat.pod:59
311 " virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp\n"
312 " last -f /tmp/wtmp\n"
317 #: ../cat/virt-cat.pod:62 ../cat/virt-filesystems.pod:91
318 #: ../cat/virt-ls.pod:261 ../df/virt-df.pod:59 ../edit/virt-edit.pod:62
319 #: ../fish/guestfish.pod:148 ../fish/virt-copy-in.pod:45
320 #: ../fish/virt-copy-out.pod:34 ../fish/virt-tar-in.pod:42
321 #: ../fish/virt-tar-out.pod:36 ../fuse/guestmount.pod:83
322 #: ../inspector/virt-inspector.pod:55
323 #: ../libguestfs-1.11.20/cat/virt-cat.pod:62
324 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:91
325 #: ../libguestfs-1.11.20/cat/virt-ls.pod:261
326 #: ../libguestfs-1.11.20/df/virt-df.pod:59
327 #: ../libguestfs-1.11.20/edit/virt-edit.pod:62
328 #: ../libguestfs-1.11.20/fish/guestfish.pod:148
329 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:45
330 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:34
331 #: ../libguestfs-1.11.20/fish/virt-tar-in.pod:42
332 #: ../libguestfs-1.11.20/fish/virt-tar-out.pod:36
333 #: ../libguestfs-1.11.20/fuse/guestmount.pod:83
334 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:55
335 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:84
336 #: ../libguestfs-1.11.20/resize/virt-resize.pod:241
337 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:37
338 #: ../rescue/virt-rescue.pod:84 ../resize/virt-resize.pod:241
339 #: ../test-tool/libguestfs-test-tool.pod:37
340 #: ../tools/virt-list-filesystems.pl:53 ../tools/virt-list-partitions.pl:54
341 #: ../tools/virt-make-fs.pl:153 ../tools/virt-tar.pl:103
342 #: ../tools/virt-win-reg.pl:96
347 #: ../cat/virt-cat.pod:66 ../cat/virt-filesystems.pod:95
348 #: ../cat/virt-ls.pod:265 ../df/virt-df.pod:63 ../edit/virt-edit.pod:66
349 #: ../fish/guestfish.pod:152 ../fuse/guestmount.pod:151
350 #: ../inspector/virt-inspector.pod:59
351 #: ../libguestfs-1.11.20/cat/virt-cat.pod:66
352 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:95
353 #: ../libguestfs-1.11.20/cat/virt-ls.pod:265
354 #: ../libguestfs-1.11.20/df/virt-df.pod:63
355 #: ../libguestfs-1.11.20/edit/virt-edit.pod:66
356 #: ../libguestfs-1.11.20/fish/guestfish.pod:152
357 #: ../libguestfs-1.11.20/fuse/guestmount.pod:151
358 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:59
359 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:88
360 #: ../libguestfs-1.11.20/resize/virt-resize.pod:245
361 #: ../rescue/virt-rescue.pod:88 ../resize/virt-resize.pod:245
362 #: ../tools/virt-list-filesystems.pl:61 ../tools/virt-list-partitions.pl:62
363 #: ../tools/virt-make-fs.pl:161 ../tools/virt-tar.pl:111
364 #: ../tools/virt-win-reg.pl:104
369 #: ../cat/virt-cat.pod:68 ../cat/virt-filesystems.pod:97
370 #: ../cat/virt-ls.pod:267 ../df/virt-df.pod:65 ../edit/virt-edit.pod:68
371 #: ../inspector/virt-inspector.pod:61
372 #: ../libguestfs-1.11.20/cat/virt-cat.pod:68
373 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:97
374 #: ../libguestfs-1.11.20/cat/virt-ls.pod:267
375 #: ../libguestfs-1.11.20/df/virt-df.pod:65
376 #: ../libguestfs-1.11.20/edit/virt-edit.pod:68
377 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:61
378 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:90
379 #: ../rescue/virt-rescue.pod:90 ../tools/virt-list-filesystems.pl:63
380 #: ../tools/virt-list-partitions.pl:64 ../tools/virt-make-fs.pl:163
381 #: ../tools/virt-tar.pl:113 ../tools/virt-win-reg.pl:106
382 msgid "Display brief help."
386 #: ../cat/virt-cat.pod:70 ../cat/virt-filesystems.pod:99
387 #: ../cat/virt-ls.pod:269 ../df/virt-df.pod:67 ../edit/virt-edit.pod:70
388 #: ../inspector/virt-inspector.pod:63
389 #: ../libguestfs-1.11.20/cat/virt-cat.pod:70
390 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:99
391 #: ../libguestfs-1.11.20/cat/virt-ls.pod:269
392 #: ../libguestfs-1.11.20/df/virt-df.pod:67
393 #: ../libguestfs-1.11.20/edit/virt-edit.pod:70
394 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:63
395 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:92
396 #: ../rescue/virt-rescue.pod:92
401 #: ../cat/virt-cat.pod:72 ../cat/virt-filesystems.pod:101
402 #: ../cat/virt-ls.pod:271 ../df/virt-df.pod:69 ../edit/virt-edit.pod:72
403 #: ../inspector/virt-inspector.pod:65
404 #: ../libguestfs-1.11.20/cat/virt-cat.pod:72
405 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:101
406 #: ../libguestfs-1.11.20/cat/virt-ls.pod:271
407 #: ../libguestfs-1.11.20/df/virt-df.pod:69
408 #: ../libguestfs-1.11.20/edit/virt-edit.pod:72
409 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:65
410 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:94
411 #: ../rescue/virt-rescue.pod:94
412 msgid "B<--add> file"
416 #: ../cat/virt-cat.pod:74 ../cat/virt-filesystems.pod:103
417 #: ../cat/virt-ls.pod:273 ../df/virt-df.pod:71 ../edit/virt-edit.pod:74
418 #: ../inspector/virt-inspector.pod:67
419 #: ../libguestfs-1.11.20/cat/virt-cat.pod:74
420 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:103
421 #: ../libguestfs-1.11.20/cat/virt-ls.pod:273
422 #: ../libguestfs-1.11.20/df/virt-df.pod:71
423 #: ../libguestfs-1.11.20/edit/virt-edit.pod:74
424 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:67
425 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:96
426 #: ../rescue/virt-rescue.pod:96
428 "Add I<file> which should be a disk image from a virtual machine. If the "
429 "virtual machine has multiple block devices, you must supply all of them with "
430 "separate I<-a> options."
434 #: ../cat/virt-cat.pod:78 ../cat/virt-filesystems.pod:107
435 #: ../cat/virt-ls.pod:277 ../df/virt-df.pod:75 ../edit/virt-edit.pod:78
436 #: ../fish/guestfish.pod:174 ../fuse/guestmount.pod:93
437 #: ../inspector/virt-inspector.pod:71
438 #: ../libguestfs-1.11.20/cat/virt-cat.pod:78
439 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:107
440 #: ../libguestfs-1.11.20/cat/virt-ls.pod:277
441 #: ../libguestfs-1.11.20/df/virt-df.pod:75
442 #: ../libguestfs-1.11.20/edit/virt-edit.pod:78
443 #: ../libguestfs-1.11.20/fish/guestfish.pod:174
444 #: ../libguestfs-1.11.20/fuse/guestmount.pod:93
445 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:71
446 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:100
447 #: ../rescue/virt-rescue.pod:100
449 "The format of the disk image is auto-detected. To override this and force a "
450 "particular format use the I<--format=..> option."
454 #: ../cat/virt-cat.pod:81 ../cat/virt-filesystems.pod:125
455 #: ../cat/virt-ls.pod:291 ../df/virt-df.pod:78
456 #: ../libguestfs-1.11.20/cat/virt-cat.pod:81
457 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:125
458 #: ../libguestfs-1.11.20/cat/virt-ls.pod:291
459 #: ../libguestfs-1.11.20/df/virt-df.pod:78
460 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:107
461 #: ../rescue/virt-rescue.pod:107
466 #: ../cat/virt-cat.pod:83 ../cat/virt-filesystems.pod:127
467 #: ../cat/virt-ls.pod:293 ../df/virt-df.pod:80
468 #: ../libguestfs-1.11.20/cat/virt-cat.pod:83
469 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:127
470 #: ../libguestfs-1.11.20/cat/virt-ls.pod:293
471 #: ../libguestfs-1.11.20/df/virt-df.pod:80
472 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:109
473 #: ../rescue/virt-rescue.pod:109
474 msgid "B<--connect> URI"
478 #: ../cat/virt-cat.pod:85 ../cat/virt-filesystems.pod:129
479 #: ../cat/virt-ls.pod:295 ../df/virt-df.pod:82 ../edit/virt-edit.pod:99
480 #: ../inspector/virt-inspector.pod:78
481 #: ../libguestfs-1.11.20/cat/virt-cat.pod:85
482 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:129
483 #: ../libguestfs-1.11.20/cat/virt-ls.pod:295
484 #: ../libguestfs-1.11.20/df/virt-df.pod:82
485 #: ../libguestfs-1.11.20/edit/virt-edit.pod:99
486 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:78
487 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:111
488 #: ../rescue/virt-rescue.pod:111 ../tools/virt-list-filesystems.pl:81
489 #: ../tools/virt-list-partitions.pl:82 ../tools/virt-tar.pl:131
490 #: ../tools/virt-win-reg.pl:132
492 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
493 "to the default libvirt hypervisor."
497 #: ../cat/virt-cat.pod:88 ../cat/virt-filesystems.pod:132
498 #: ../cat/virt-ls.pod:298 ../df/virt-df.pod:85
499 #: ../libguestfs-1.11.20/cat/virt-cat.pod:88
500 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:132
501 #: ../libguestfs-1.11.20/cat/virt-ls.pod:298
502 #: ../libguestfs-1.11.20/df/virt-df.pod:85
503 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:114
504 #: ../rescue/virt-rescue.pod:114
506 "If you specify guest block devices directly (I<-a>), then libvirt is not "
511 #: ../cat/virt-cat.pod:91 ../cat/virt-filesystems.pod:141
512 #: ../cat/virt-ls.pod:307 ../df/virt-df.pod:88 ../edit/virt-edit.pod:105
513 #: ../inspector/virt-inspector.pod:85
514 #: ../libguestfs-1.11.20/cat/virt-cat.pod:91
515 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:141
516 #: ../libguestfs-1.11.20/cat/virt-ls.pod:307
517 #: ../libguestfs-1.11.20/df/virt-df.pod:88
518 #: ../libguestfs-1.11.20/edit/virt-edit.pod:105
519 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:85
520 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:117
521 #: ../rescue/virt-rescue.pod:117
526 #: ../cat/virt-cat.pod:93 ../cat/virt-filesystems.pod:143
527 #: ../cat/virt-ls.pod:309 ../df/virt-df.pod:90 ../edit/virt-edit.pod:107
528 #: ../inspector/virt-inspector.pod:87
529 #: ../libguestfs-1.11.20/cat/virt-cat.pod:93
530 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:143
531 #: ../libguestfs-1.11.20/cat/virt-ls.pod:309
532 #: ../libguestfs-1.11.20/df/virt-df.pod:90
533 #: ../libguestfs-1.11.20/edit/virt-edit.pod:107
534 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:87
535 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:119
536 #: ../rescue/virt-rescue.pod:119
537 msgid "B<--domain> guest"
541 #: ../cat/virt-cat.pod:95 ../cat/virt-filesystems.pod:145
542 #: ../cat/virt-ls.pod:311 ../df/virt-df.pod:92 ../edit/virt-edit.pod:109
543 #: ../inspector/virt-inspector.pod:89
544 #: ../libguestfs-1.11.20/cat/virt-cat.pod:95
545 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:145
546 #: ../libguestfs-1.11.20/cat/virt-ls.pod:311
547 #: ../libguestfs-1.11.20/df/virt-df.pod:92
548 #: ../libguestfs-1.11.20/edit/virt-edit.pod:109
549 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:89
550 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:121
551 #: ../rescue/virt-rescue.pod:121
553 "Add all the disks from the named libvirt guest. Domain UUIDs can be used "
558 #: ../cat/virt-cat.pod:98 ../cat/virt-filesystems.pod:148
559 #: ../cat/virt-ls.pod:314 ../edit/virt-edit.pod:112 ../fish/guestfish.pod:217
560 #: ../fuse/guestmount.pod:126 ../inspector/virt-inspector.pod:92
561 #: ../libguestfs-1.11.20/cat/virt-cat.pod:98
562 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:148
563 #: ../libguestfs-1.11.20/cat/virt-ls.pod:314
564 #: ../libguestfs-1.11.20/edit/virt-edit.pod:112
565 #: ../libguestfs-1.11.20/fish/guestfish.pod:217
566 #: ../libguestfs-1.11.20/fuse/guestmount.pod:126
567 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:92
568 msgid "B<--echo-keys>"
572 #: ../cat/virt-cat.pod:100 ../libguestfs-1.11.20/cat/virt-cat.pod:100
574 "When prompting for keys and passphrases, virt-cat normally turns echoing off "
575 "so you cannot see what you are typing. If you are not worried about Tempest "
576 "attacks and there is no one else in the room you can specify this flag to "
577 "see what you are typing."
581 #: ../cat/virt-cat.pod:105 ../cat/virt-filesystems.pod:170
582 #: ../cat/virt-ls.pod:328 ../df/virt-df.pod:95 ../fish/guestfish.pod:233
583 #: ../fuse/guestmount.pod:133 ../inspector/virt-inspector.pod:99
584 #: ../libguestfs-1.11.20/cat/virt-cat.pod:105
585 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:170
586 #: ../libguestfs-1.11.20/cat/virt-ls.pod:328
587 #: ../libguestfs-1.11.20/df/virt-df.pod:95
588 #: ../libguestfs-1.11.20/fish/guestfish.pod:233
589 #: ../libguestfs-1.11.20/fuse/guestmount.pod:133
590 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:99
591 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:124
592 #: ../rescue/virt-rescue.pod:124
593 msgid "B<--format=raw|qcow2|..>"
597 #: ../cat/virt-cat.pod:107 ../cat/virt-filesystems.pod:172
598 #: ../cat/virt-ls.pod:330 ../df/virt-df.pod:97 ../edit/virt-edit.pod:134
599 #: ../fish/guestfish.pod:235 ../fuse/guestmount.pod:135
600 #: ../inspector/virt-inspector.pod:101
601 #: ../libguestfs-1.11.20/cat/virt-cat.pod:107
602 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:172
603 #: ../libguestfs-1.11.20/cat/virt-ls.pod:330
604 #: ../libguestfs-1.11.20/df/virt-df.pod:97
605 #: ../libguestfs-1.11.20/edit/virt-edit.pod:134
606 #: ../libguestfs-1.11.20/fish/guestfish.pod:235
607 #: ../libguestfs-1.11.20/fuse/guestmount.pod:135
608 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:101
609 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:126
610 #: ../rescue/virt-rescue.pod:126
615 #: ../cat/virt-cat.pod:109 ../cat/virt-filesystems.pod:174
616 #: ../cat/virt-ls.pod:332 ../df/virt-df.pod:99 ../edit/virt-edit.pod:136
617 #: ../fish/guestfish.pod:237 ../fuse/guestmount.pod:137
618 #: ../libguestfs-1.11.20/cat/virt-cat.pod:109
619 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:174
620 #: ../libguestfs-1.11.20/cat/virt-ls.pod:332
621 #: ../libguestfs-1.11.20/df/virt-df.pod:99
622 #: ../libguestfs-1.11.20/edit/virt-edit.pod:136
623 #: ../libguestfs-1.11.20/fish/guestfish.pod:237
624 #: ../libguestfs-1.11.20/fuse/guestmount.pod:137
625 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:128
626 #: ../rescue/virt-rescue.pod:128
628 "The default for the I<-a> option is to auto-detect the format of the disk "
629 "image. Using this forces the disk format for I<-a> options which follow on "
630 "the command line. Using I<--format> with no argument switches back to auto-"
631 "detection for subsequent I<-a> options."
635 #: ../cat/virt-cat.pod:114 ../cat/virt-filesystems.pod:179
636 #: ../cat/virt-ls.pod:337 ../df/virt-df.pod:104 ../edit/virt-edit.pod:141
637 #: ../fish/guestfish.pod:242 ../fish/guestfish.pod:673
638 #: ../inspector/virt-inspector.pod:335
639 #: ../libguestfs-1.11.20/cat/virt-cat.pod:114
640 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:179
641 #: ../libguestfs-1.11.20/cat/virt-ls.pod:337
642 #: ../libguestfs-1.11.20/df/virt-df.pod:104
643 #: ../libguestfs-1.11.20/edit/virt-edit.pod:141
644 #: ../libguestfs-1.11.20/fish/guestfish.pod:242
645 #: ../libguestfs-1.11.20/fish/guestfish.pod:673
646 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:335
647 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:133
648 #: ../libguestfs-1.11.20/src/guestfs.pod:2652 ../rescue/virt-rescue.pod:133
649 #: ../src/guestfs.pod:2652
654 #: ../cat/virt-cat.pod:116 ../libguestfs-1.11.20/cat/virt-cat.pod:116
657 " virt-cat --format=raw -a disk.img file\n"
662 #: ../cat/virt-cat.pod:118 ../cat/virt-filesystems.pod:183
663 #: ../cat/virt-ls.pod:341 ../df/virt-df.pod:108 ../edit/virt-edit.pod:145
664 #: ../fish/guestfish.pod:246 ../libguestfs-1.11.20/cat/virt-cat.pod:118
665 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:183
666 #: ../libguestfs-1.11.20/cat/virt-ls.pod:341
667 #: ../libguestfs-1.11.20/df/virt-df.pod:108
668 #: ../libguestfs-1.11.20/edit/virt-edit.pod:145
669 #: ../libguestfs-1.11.20/fish/guestfish.pod:246
670 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:137
671 #: ../rescue/virt-rescue.pod:137
672 msgid "forces raw format (no auto-detection) for C<disk.img>."
676 #: ../cat/virt-cat.pod:120 ../libguestfs-1.11.20/cat/virt-cat.pod:120
679 " virt-cat --format=raw -a disk.img --format -a another.img file\n"
684 #: ../cat/virt-cat.pod:122 ../cat/virt-filesystems.pod:187
685 #: ../cat/virt-ls.pod:345 ../df/virt-df.pod:112 ../edit/virt-edit.pod:149
686 #: ../fish/guestfish.pod:250 ../libguestfs-1.11.20/cat/virt-cat.pod:122
687 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:187
688 #: ../libguestfs-1.11.20/cat/virt-ls.pod:345
689 #: ../libguestfs-1.11.20/df/virt-df.pod:112
690 #: ../libguestfs-1.11.20/edit/virt-edit.pod:149
691 #: ../libguestfs-1.11.20/fish/guestfish.pod:250
692 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:141
693 #: ../rescue/virt-rescue.pod:141
695 "forces raw format (no auto-detection) for C<disk.img> and reverts to auto-"
696 "detection for C<another.img>."
700 #: ../cat/virt-cat.pod:125 ../cat/virt-filesystems.pod:190
701 #: ../cat/virt-ls.pod:348 ../df/virt-df.pod:115 ../edit/virt-edit.pod:152
702 #: ../libguestfs-1.11.20/cat/virt-cat.pod:125
703 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:190
704 #: ../libguestfs-1.11.20/cat/virt-ls.pod:348
705 #: ../libguestfs-1.11.20/df/virt-df.pod:115
706 #: ../libguestfs-1.11.20/edit/virt-edit.pod:152
707 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:144
708 #: ../rescue/virt-rescue.pod:144
710 "If you have untrusted raw-format guest disk images, you should use this "
711 "option to specify the disk format. This avoids a possible security problem "
712 "with malicious guests (CVE-2010-3851)."
716 #: ../cat/virt-cat.pod:129 ../cat/virt-filesystems.pod:200
717 #: ../cat/virt-ls.pod:361 ../edit/virt-edit.pod:156 ../fish/guestfish.pod:289
718 #: ../fuse/guestmount.pod:163 ../inspector/virt-inspector.pod:114
719 #: ../libguestfs-1.11.20/cat/virt-cat.pod:129
720 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:200
721 #: ../libguestfs-1.11.20/cat/virt-ls.pod:361
722 #: ../libguestfs-1.11.20/edit/virt-edit.pod:156
723 #: ../libguestfs-1.11.20/fish/guestfish.pod:289
724 #: ../libguestfs-1.11.20/fuse/guestmount.pod:163
725 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:114
726 msgid "B<--keys-from-stdin>"
730 #: ../cat/virt-cat.pod:131 ../cat/virt-filesystems.pod:202
731 #: ../cat/virt-ls.pod:363 ../edit/virt-edit.pod:158 ../fish/guestfish.pod:291
732 #: ../fuse/guestmount.pod:165 ../inspector/virt-inspector.pod:116
733 #: ../libguestfs-1.11.20/cat/virt-cat.pod:131
734 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:202
735 #: ../libguestfs-1.11.20/cat/virt-ls.pod:363
736 #: ../libguestfs-1.11.20/edit/virt-edit.pod:158
737 #: ../libguestfs-1.11.20/fish/guestfish.pod:291
738 #: ../libguestfs-1.11.20/fuse/guestmount.pod:165
739 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:116
741 "Read key or passphrase parameters from stdin. The default is to try to read "
742 "passphrases from the user by opening C</dev/tty>."
746 #: ../cat/virt-cat.pod:134 ../cat/virt-filesystems.pod:261
747 #: ../cat/virt-ls.pod:425 ../df/virt-df.pod:167 ../edit/virt-edit.pod:161
748 #: ../fish/guestfish.pod:390 ../fuse/guestmount.pod:257
749 #: ../inspector/virt-inspector.pod:119
750 #: ../libguestfs-1.11.20/cat/virt-cat.pod:134
751 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:261
752 #: ../libguestfs-1.11.20/cat/virt-ls.pod:425
753 #: ../libguestfs-1.11.20/df/virt-df.pod:167
754 #: ../libguestfs-1.11.20/edit/virt-edit.pod:161
755 #: ../libguestfs-1.11.20/fish/guestfish.pod:390
756 #: ../libguestfs-1.11.20/fuse/guestmount.pod:257
757 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:119
758 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:178
759 #: ../rescue/virt-rescue.pod:178
764 #: ../cat/virt-cat.pod:136 ../cat/virt-filesystems.pod:263
765 #: ../cat/virt-ls.pod:427 ../df/virt-df.pod:169 ../edit/virt-edit.pod:163
766 #: ../fish/guestfish.pod:392 ../fuse/guestmount.pod:259
767 #: ../inspector/virt-inspector.pod:121
768 #: ../libguestfs-1.11.20/cat/virt-cat.pod:136
769 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:263
770 #: ../libguestfs-1.11.20/cat/virt-ls.pod:427
771 #: ../libguestfs-1.11.20/df/virt-df.pod:169
772 #: ../libguestfs-1.11.20/edit/virt-edit.pod:163
773 #: ../libguestfs-1.11.20/fish/guestfish.pod:392
774 #: ../libguestfs-1.11.20/fuse/guestmount.pod:259
775 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:121
776 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:180
777 #: ../rescue/virt-rescue.pod:180
782 #: ../cat/virt-cat.pod:138 ../cat/virt-filesystems.pod:265
783 #: ../cat/virt-ls.pod:429 ../df/virt-df.pod:171 ../edit/virt-edit.pod:165
784 #: ../inspector/virt-inspector.pod:123
785 #: ../libguestfs-1.11.20/cat/virt-cat.pod:138
786 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:265
787 #: ../libguestfs-1.11.20/cat/virt-ls.pod:429
788 #: ../libguestfs-1.11.20/df/virt-df.pod:171
789 #: ../libguestfs-1.11.20/edit/virt-edit.pod:165
790 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:123
791 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:182
792 #: ../rescue/virt-rescue.pod:182
793 msgid "Enable verbose messages for debugging."
797 #: ../cat/virt-cat.pod:140 ../cat/virt-filesystems.pod:267
798 #: ../cat/virt-ls.pod:431 ../df/virt-df.pod:173 ../edit/virt-edit.pod:167
799 #: ../fish/guestfish.pod:397 ../fuse/guestmount.pod:263
800 #: ../inspector/virt-inspector.pod:125
801 #: ../libguestfs-1.11.20/cat/virt-cat.pod:140
802 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:267
803 #: ../libguestfs-1.11.20/cat/virt-ls.pod:431
804 #: ../libguestfs-1.11.20/df/virt-df.pod:173
805 #: ../libguestfs-1.11.20/edit/virt-edit.pod:167
806 #: ../libguestfs-1.11.20/fish/guestfish.pod:397
807 #: ../libguestfs-1.11.20/fuse/guestmount.pod:263
808 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:125
809 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:184
810 #: ../libguestfs-1.11.20/resize/virt-resize.pod:478
811 #: ../rescue/virt-rescue.pod:184 ../resize/virt-resize.pod:478
816 #: ../cat/virt-cat.pod:142 ../cat/virt-filesystems.pod:269
817 #: ../cat/virt-ls.pod:433 ../df/virt-df.pod:175 ../edit/virt-edit.pod:169
818 #: ../fish/guestfish.pod:399 ../fuse/guestmount.pod:265
819 #: ../inspector/virt-inspector.pod:127
820 #: ../libguestfs-1.11.20/cat/virt-cat.pod:142
821 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:269
822 #: ../libguestfs-1.11.20/cat/virt-ls.pod:433
823 #: ../libguestfs-1.11.20/df/virt-df.pod:175
824 #: ../libguestfs-1.11.20/edit/virt-edit.pod:169
825 #: ../libguestfs-1.11.20/fish/guestfish.pod:399
826 #: ../libguestfs-1.11.20/fuse/guestmount.pod:265
827 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:127
828 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:186
829 #: ../libguestfs-1.11.20/resize/virt-resize.pod:480
830 #: ../rescue/virt-rescue.pod:186 ../resize/virt-resize.pod:480
831 #: ../tools/virt-list-filesystems.pl:69 ../tools/virt-list-partitions.pl:70
832 #: ../tools/virt-make-fs.pl:169 ../tools/virt-tar.pl:119
833 #: ../tools/virt-win-reg.pl:112
838 #: ../cat/virt-cat.pod:144 ../cat/virt-filesystems.pod:271
839 #: ../cat/virt-ls.pod:435 ../df/virt-df.pod:177 ../edit/virt-edit.pod:171
840 #: ../inspector/virt-inspector.pod:129
841 #: ../libguestfs-1.11.20/cat/virt-cat.pod:144
842 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:271
843 #: ../libguestfs-1.11.20/cat/virt-ls.pod:435
844 #: ../libguestfs-1.11.20/df/virt-df.pod:177
845 #: ../libguestfs-1.11.20/edit/virt-edit.pod:171
846 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:129
847 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:188
848 #: ../libguestfs-1.11.20/resize/virt-resize.pod:482
849 #: ../rescue/virt-rescue.pod:188 ../resize/virt-resize.pod:482
850 #: ../tools/virt-list-filesystems.pl:71 ../tools/virt-list-partitions.pl:72
851 #: ../tools/virt-make-fs.pl:171 ../tools/virt-tar.pl:121
852 #: ../tools/virt-win-reg.pl:114
853 msgid "Display version number and exit."
857 #: ../cat/virt-cat.pod:146 ../cat/virt-filesystems.pod:281
858 #: ../cat/virt-ls.pod:437 ../df/virt-df.pod:179 ../edit/virt-edit.pod:173
859 #: ../fish/guestfish.pod:412 ../fuse/guestmount.pod:278
860 #: ../inspector/virt-inspector.pod:131
861 #: ../libguestfs-1.11.20/cat/virt-cat.pod:146
862 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:281
863 #: ../libguestfs-1.11.20/cat/virt-ls.pod:437
864 #: ../libguestfs-1.11.20/df/virt-df.pod:179
865 #: ../libguestfs-1.11.20/edit/virt-edit.pod:173
866 #: ../libguestfs-1.11.20/fish/guestfish.pod:412
867 #: ../libguestfs-1.11.20/fuse/guestmount.pod:278
868 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:131
869 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:199
870 #: ../rescue/virt-rescue.pod:199 ../tools/virt-tar.pl:158
875 #: ../cat/virt-cat.pod:148 ../cat/virt-filesystems.pod:283
876 #: ../cat/virt-ls.pod:439 ../df/virt-df.pod:181 ../edit/virt-edit.pod:175
877 #: ../inspector/virt-inspector.pod:133
878 #: ../libguestfs-1.11.20/cat/virt-cat.pod:148
879 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:283
880 #: ../libguestfs-1.11.20/cat/virt-ls.pod:439
881 #: ../libguestfs-1.11.20/df/virt-df.pod:181
882 #: ../libguestfs-1.11.20/edit/virt-edit.pod:175
883 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:133
884 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:201
885 #: ../rescue/virt-rescue.pod:201
886 msgid "Enable tracing of libguestfs API calls."
890 #: ../cat/virt-cat.pod:152 ../cat/virt-ls.pod:443 ../edit/virt-edit.pod:179
891 #: ../inspector/virt-inspector.pod:137
892 #: ../libguestfs-1.11.20/cat/virt-cat.pod:152
893 #: ../libguestfs-1.11.20/cat/virt-ls.pod:443
894 #: ../libguestfs-1.11.20/edit/virt-edit.pod:179
895 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:137
896 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:205
897 #: ../rescue/virt-rescue.pod:205
898 msgid "OLD-STYLE COMMAND LINE ARGUMENTS"
902 #: ../cat/virt-cat.pod:154 ../libguestfs-1.11.20/cat/virt-cat.pod:154
903 msgid "Previous versions of virt-cat allowed you to write either:"
907 #: ../cat/virt-cat.pod:156 ../libguestfs-1.11.20/cat/virt-cat.pod:156
910 " virt-cat disk.img [disk.img ...] file\n"
915 #: ../cat/virt-cat.pod:158 ../cat/virt-ls.pod:449 ../edit/virt-edit.pod:185
916 #: ../inspector/virt-inspector.pod:143
917 #: ../libguestfs-1.11.20/cat/virt-cat.pod:158
918 #: ../libguestfs-1.11.20/cat/virt-ls.pod:449
919 #: ../libguestfs-1.11.20/edit/virt-edit.pod:185
920 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:143
921 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:211
922 #: ../rescue/virt-rescue.pod:211
927 #: ../cat/virt-cat.pod:160 ../libguestfs-1.11.20/cat/virt-cat.pod:160
930 " virt-cat guestname file\n"
935 #: ../cat/virt-cat.pod:162 ../cat/virt-ls.pod:453 ../edit/virt-edit.pod:189
936 #: ../inspector/virt-inspector.pod:147
937 #: ../libguestfs-1.11.20/cat/virt-cat.pod:162
938 #: ../libguestfs-1.11.20/cat/virt-ls.pod:453
939 #: ../libguestfs-1.11.20/edit/virt-edit.pod:189
940 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:147
941 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:215
942 #: ../rescue/virt-rescue.pod:215
944 "whereas in this version you should use I<-a> or I<-d> respectively to avoid "
945 "the confusing case where a disk image might have the same name as a guest."
949 #: ../cat/virt-cat.pod:166 ../cat/virt-ls.pod:457 ../edit/virt-edit.pod:193
950 #: ../inspector/virt-inspector.pod:151
951 #: ../libguestfs-1.11.20/cat/virt-cat.pod:166
952 #: ../libguestfs-1.11.20/cat/virt-ls.pod:457
953 #: ../libguestfs-1.11.20/edit/virt-edit.pod:193
954 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:151
955 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:219
956 #: ../rescue/virt-rescue.pod:219
957 msgid "For compatibility the old style is still supported."
961 #: ../cat/virt-cat.pod:168 ../edit/virt-edit.pod:297
962 #: ../libguestfs-1.11.20/cat/virt-cat.pod:168
963 #: ../libguestfs-1.11.20/edit/virt-edit.pod:297
964 msgid "USING GUESTFISH"
968 #: ../cat/virt-cat.pod:170 ../libguestfs-1.11.20/cat/virt-cat.pod:170
970 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
971 "C<virt-cat> doesn't work."
975 #: ../cat/virt-cat.pod:173 ../libguestfs-1.11.20/cat/virt-cat.pod:173
976 msgid "Using C<virt-cat> is approximately equivalent to doing:"
980 #: ../cat/virt-cat.pod:175 ../libguestfs-1.11.20/cat/virt-cat.pod:175
983 " guestfish --ro -i -d domname download file -\n"
988 #: ../cat/virt-cat.pod:177 ../libguestfs-1.11.20/cat/virt-cat.pod:177
990 "where C<domname> is the name of the libvirt guest, and C<file> is the full "
991 "path to the file. Note the final C<-> (meaning \"output to stdout\")."
995 #: ../cat/virt-cat.pod:181 ../libguestfs-1.11.20/cat/virt-cat.pod:181
997 "The command above uses libguestfs's guest inspection feature and so does not "
998 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
999 "disk images that don't contain guests. To display a file from a disk image "
1004 #: ../cat/virt-cat.pod:186 ../libguestfs-1.11.20/cat/virt-cat.pod:186
1007 " guestfish --ro -a disk.img -m /dev/sda1 download file -\n"
1012 #: ../cat/virt-cat.pod:188 ../libguestfs-1.11.20/cat/virt-cat.pod:188
1014 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
1015 "the disk image to edit, and C<file> is the full path to the file."
1019 #: ../cat/virt-cat.pod:192 ../cat/virt-filesystems.pod:365
1020 #: ../cat/virt-ls.pod:483 ../df/virt-df.pod:209 ../edit/virt-edit.pod:342
1021 #: ../inspector/virt-inspector.pod:349
1022 #: ../libguestfs-1.11.20/cat/virt-cat.pod:192
1023 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:365
1024 #: ../libguestfs-1.11.20/cat/virt-ls.pod:483
1025 #: ../libguestfs-1.11.20/df/virt-df.pod:209
1026 #: ../libguestfs-1.11.20/edit/virt-edit.pod:342
1027 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:349
1028 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:262
1029 #: ../libguestfs-1.11.20/resize/virt-resize.pod:543
1030 #: ../rescue/virt-rescue.pod:262 ../resize/virt-resize.pod:543
1031 #: ../tools/virt-list-filesystems.pl:188 ../tools/virt-list-partitions.pl:258
1032 #: ../tools/virt-make-fs.pl:532 ../tools/virt-tar.pl:289
1033 #: ../tools/virt-win-reg.pl:733
1034 msgid "SHELL QUOTING"
1038 #: ../cat/virt-cat.pod:194 ../cat/virt-filesystems.pod:367
1039 #: ../cat/virt-ls.pod:485 ../df/virt-df.pod:211 ../edit/virt-edit.pod:344
1040 #: ../inspector/virt-inspector.pod:351
1041 #: ../libguestfs-1.11.20/cat/virt-cat.pod:194
1042 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:367
1043 #: ../libguestfs-1.11.20/cat/virt-ls.pod:485
1044 #: ../libguestfs-1.11.20/df/virt-df.pod:211
1045 #: ../libguestfs-1.11.20/edit/virt-edit.pod:344
1046 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:351
1047 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:264
1048 #: ../libguestfs-1.11.20/resize/virt-resize.pod:545
1049 #: ../rescue/virt-rescue.pod:264 ../resize/virt-resize.pod:545
1050 #: ../tools/virt-list-filesystems.pl:190 ../tools/virt-list-partitions.pl:260
1051 #: ../tools/virt-make-fs.pl:534 ../tools/virt-tar.pl:291
1052 #: ../tools/virt-win-reg.pl:741
1054 "Libvirt guest names can contain arbitrary characters, some of which have "
1055 "meaning to the shell such as C<#> and space. You may need to quote or "
1056 "escape these characters on the command line. See the shell manual page L<sh"
1061 #: ../cat/virt-cat.pod:199 ../cat/virt-filesystems.pod:372
1062 #: ../cat/virt-ls.pod:490 ../df/virt-df.pod:216 ../edit/virt-edit.pod:349
1063 #: ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384
1064 #: ../fish/guestfish.pod:1214 ../fish/virt-copy-in.pod:50
1065 #: ../fish/virt-copy-out.pod:39 ../fish/virt-tar-in.pod:47
1066 #: ../fish/virt-tar-out.pod:41 ../fuse/guestmount.pod:303
1067 #: ../inspector/virt-inspector.pod:372 ../java/examples/guestfs-java.pod:45
1068 #: ../libguestfs-1.11.20/cat/virt-cat.pod:199
1069 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:372
1070 #: ../libguestfs-1.11.20/cat/virt-ls.pod:490
1071 #: ../libguestfs-1.11.20/df/virt-df.pod:216
1072 #: ../libguestfs-1.11.20/edit/virt-edit.pod:349
1073 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:33
1074 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:384
1075 #: ../libguestfs-1.11.20/fish/guestfish.pod:1214
1076 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:50
1077 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:39
1078 #: ../libguestfs-1.11.20/fish/virt-tar-in.pod:47
1079 #: ../libguestfs-1.11.20/fish/virt-tar-out.pod:41
1080 #: ../libguestfs-1.11.20/fuse/guestmount.pod:303
1081 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:372
1082 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:45
1083 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:78
1084 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:39
1085 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:42
1086 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:284
1087 #: ../libguestfs-1.11.20/resize/virt-resize.pod:550
1088 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:36
1089 #: ../libguestfs-1.11.20/src/guestfs.pod:3011
1090 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:87
1091 #: ../ocaml/examples/guestfs-ocaml.pod:78 ../perl/examples/guestfs-perl.pod:39
1092 #: ../python/examples/guestfs-python.pod:42 ../rescue/virt-rescue.pod:284
1093 #: ../resize/virt-resize.pod:550 ../ruby/examples/guestfs-ruby.pod:36
1094 #: ../src/guestfs.pod:3011 ../test-tool/libguestfs-test-tool.pod:87
1095 #: ../tools/virt-list-filesystems.pl:195 ../tools/virt-list-partitions.pl:265
1096 #: ../tools/virt-make-fs.pl:539 ../tools/virt-tar.pl:296
1097 #: ../tools/virt-win-reg.pl:746
1102 #: ../cat/virt-cat.pod:201 ../libguestfs-1.11.20/cat/virt-cat.pod:201
1104 "L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, L<virt-"
1105 "tar-out(1)>, L<http://libguestfs.org/>."
1109 #: ../cat/virt-cat.pod:208 ../cat/virt-filesystems.pod:383
1110 #: ../cat/virt-ls.pod:502 ../df/virt-df.pod:224 ../edit/virt-edit.pod:363
1111 #: ../libguestfs-1.11.20/cat/virt-cat.pod:208
1112 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:383
1113 #: ../libguestfs-1.11.20/cat/virt-ls.pod:502
1114 #: ../libguestfs-1.11.20/df/virt-df.pod:224
1115 #: ../libguestfs-1.11.20/edit/virt-edit.pod:363
1116 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:292
1117 #: ../libguestfs-1.11.20/resize/virt-resize.pod:571
1118 #: ../rescue/virt-rescue.pod:292 ../resize/virt-resize.pod:571
1119 #: ../tools/virt-list-filesystems.pl:208 ../tools/virt-list-partitions.pl:277
1120 #: ../tools/virt-make-fs.pl:564 ../tools/virt-tar.pl:311
1121 #: ../tools/virt-win-reg.pl:772
1126 #: ../cat/virt-cat.pod:210 ../cat/virt-filesystems.pod:385
1127 #: ../cat/virt-ls.pod:504 ../df/virt-df.pod:226 ../edit/virt-edit.pod:365
1128 #: ../inspector/virt-inspector.pod:386
1129 #: ../libguestfs-1.11.20/cat/virt-cat.pod:210
1130 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:385
1131 #: ../libguestfs-1.11.20/cat/virt-ls.pod:504
1132 #: ../libguestfs-1.11.20/df/virt-df.pod:226
1133 #: ../libguestfs-1.11.20/edit/virt-edit.pod:365
1134 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:386
1135 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:294
1136 #: ../libguestfs-1.11.20/resize/virt-resize.pod:573
1137 #: ../rescue/virt-rescue.pod:294 ../resize/virt-resize.pod:573
1138 #: ../tools/virt-list-filesystems.pl:210 ../tools/virt-list-partitions.pl:279
1139 #: ../tools/virt-make-fs.pl:566 ../tools/virt-tar.pl:313
1140 #: ../tools/virt-win-reg.pl:774
1141 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
1145 #: ../cat/virt-cat.pod:212 ../cat/virt-filesystems.pod:387
1146 #: ../cat/virt-ls.pod:506 ../df/virt-df.pod:228 ../edit/virt-edit.pod:367
1147 #: ../examples/guestfs-examples.pod:48 ../examples/guestfs-recipes.pod:400
1148 #: ../fish/guestfish.pod:1242 ../fish/virt-copy-in.pod:64
1149 #: ../fish/virt-copy-out.pod:53 ../fish/virt-tar-in.pod:62
1150 #: ../fish/virt-tar-out.pod:55 ../fuse/guestmount.pod:318
1151 #: ../inspector/virt-inspector.pod:394 ../java/examples/guestfs-java.pod:61
1152 #: ../libguestfs-1.11.20/cat/virt-cat.pod:212
1153 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:387
1154 #: ../libguestfs-1.11.20/cat/virt-ls.pod:506
1155 #: ../libguestfs-1.11.20/df/virt-df.pod:228
1156 #: ../libguestfs-1.11.20/edit/virt-edit.pod:367
1157 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:48
1158 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:400
1159 #: ../libguestfs-1.11.20/fish/guestfish.pod:1242
1160 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:64
1161 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:53
1162 #: ../libguestfs-1.11.20/fish/virt-tar-in.pod:62
1163 #: ../libguestfs-1.11.20/fish/virt-tar-out.pod:55
1164 #: ../libguestfs-1.11.20/fuse/guestmount.pod:318
1165 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:394
1166 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:61
1167 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:94
1168 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:55
1169 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:57
1170 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:296
1171 #: ../libguestfs-1.11.20/resize/virt-resize.pod:575
1172 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:51
1173 #: ../libguestfs-1.11.20/src/guestfs.pod:3086
1174 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:97
1175 #: ../ocaml/examples/guestfs-ocaml.pod:94 ../perl/examples/guestfs-perl.pod:55
1176 #: ../python/examples/guestfs-python.pod:57 ../rescue/virt-rescue.pod:296
1177 #: ../resize/virt-resize.pod:575 ../ruby/examples/guestfs-ruby.pod:51
1178 #: ../src/guestfs.pod:3086 ../test-tool/libguestfs-test-tool.pod:97
1179 #: ../tools/virt-list-filesystems.pl:212 ../tools/virt-list-partitions.pl:281
1180 #: ../tools/virt-make-fs.pl:568 ../tools/virt-tar.pl:315
1181 #: ../tools/virt-win-reg.pl:776
1186 #: ../cat/virt-cat.pod:214 ../inspector/virt-inspector.pod:396
1187 #: ../libguestfs-1.11.20/cat/virt-cat.pod:214
1188 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:396
1189 #: ../libguestfs-1.11.20/resize/virt-resize.pod:577
1190 #: ../resize/virt-resize.pod:577
1191 msgid "Copyright (C) 2010-2011 Red Hat Inc."
1195 #: ../cat/virt-cat.pod:216 ../cat/virt-filesystems.pod:391
1196 #: ../cat/virt-ls.pod:510 ../df/virt-df.pod:232 ../edit/virt-edit.pod:371
1197 #: ../fish/guestfish.pod:1247 ../fish/virt-copy-in.pod:69
1198 #: ../fish/virt-copy-out.pod:58 ../fish/virt-tar-in.pod:67
1199 #: ../fish/virt-tar-out.pod:60 ../fuse/guestmount.pod:323
1200 #: ../inspector/virt-inspector.pod:398
1201 #: ../libguestfs-1.11.20/cat/virt-cat.pod:216
1202 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:391
1203 #: ../libguestfs-1.11.20/cat/virt-ls.pod:510
1204 #: ../libguestfs-1.11.20/df/virt-df.pod:232
1205 #: ../libguestfs-1.11.20/edit/virt-edit.pod:371
1206 #: ../libguestfs-1.11.20/fish/guestfish.pod:1247
1207 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:69
1208 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:58
1209 #: ../libguestfs-1.11.20/fish/virt-tar-in.pod:67
1210 #: ../libguestfs-1.11.20/fish/virt-tar-out.pod:60
1211 #: ../libguestfs-1.11.20/fuse/guestmount.pod:323
1212 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:398
1213 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:300
1214 #: ../libguestfs-1.11.20/resize/virt-resize.pod:579
1215 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:102
1216 #: ../rescue/virt-rescue.pod:300 ../resize/virt-resize.pod:579
1217 #: ../test-tool/libguestfs-test-tool.pod:102
1218 #: ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:285
1219 #: ../tools/virt-make-fs.pl:572 ../tools/virt-tar.pl:319
1220 #: ../tools/virt-win-reg.pl:780
1222 "This program is free software; you can redistribute it and/or modify it "
1223 "under the terms of the GNU General Public License as published by the Free "
1224 "Software Foundation; either version 2 of the License, or (at your option) "
1225 "any later version."
1229 #: ../cat/virt-cat.pod:221 ../cat/virt-filesystems.pod:396
1230 #: ../cat/virt-ls.pod:515 ../df/virt-df.pod:237 ../edit/virt-edit.pod:376
1231 #: ../fish/guestfish.pod:1252 ../fish/virt-copy-in.pod:74
1232 #: ../fish/virt-copy-out.pod:63 ../fish/virt-tar-in.pod:72
1233 #: ../fish/virt-tar-out.pod:65 ../fuse/guestmount.pod:328
1234 #: ../inspector/virt-inspector.pod:403
1235 #: ../libguestfs-1.11.20/cat/virt-cat.pod:221
1236 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:396
1237 #: ../libguestfs-1.11.20/cat/virt-ls.pod:515
1238 #: ../libguestfs-1.11.20/df/virt-df.pod:237
1239 #: ../libguestfs-1.11.20/edit/virt-edit.pod:376
1240 #: ../libguestfs-1.11.20/fish/guestfish.pod:1252
1241 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:74
1242 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:63
1243 #: ../libguestfs-1.11.20/fish/virt-tar-in.pod:72
1244 #: ../libguestfs-1.11.20/fish/virt-tar-out.pod:65
1245 #: ../libguestfs-1.11.20/fuse/guestmount.pod:328
1246 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:403
1247 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:305
1248 #: ../libguestfs-1.11.20/resize/virt-resize.pod:584
1249 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:107
1250 #: ../rescue/virt-rescue.pod:305 ../resize/virt-resize.pod:584
1251 #: ../test-tool/libguestfs-test-tool.pod:107
1252 #: ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:290
1253 #: ../tools/virt-make-fs.pl:577 ../tools/virt-tar.pl:324
1254 #: ../tools/virt-win-reg.pl:785
1256 "This program is distributed in the hope that it will be useful, but WITHOUT "
1257 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
1258 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
1263 #: ../cat/virt-cat.pod:226 ../cat/virt-filesystems.pod:401
1264 #: ../cat/virt-ls.pod:520 ../df/virt-df.pod:242 ../edit/virt-edit.pod:381
1265 #: ../fish/guestfish.pod:1257 ../fish/virt-copy-in.pod:79
1266 #: ../fish/virt-copy-out.pod:68 ../fish/virt-tar-in.pod:77
1267 #: ../fish/virt-tar-out.pod:70 ../fuse/guestmount.pod:333
1268 #: ../inspector/virt-inspector.pod:408
1269 #: ../libguestfs-1.11.20/cat/virt-cat.pod:226
1270 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:401
1271 #: ../libguestfs-1.11.20/cat/virt-ls.pod:520
1272 #: ../libguestfs-1.11.20/df/virt-df.pod:242
1273 #: ../libguestfs-1.11.20/edit/virt-edit.pod:381
1274 #: ../libguestfs-1.11.20/fish/guestfish.pod:1257
1275 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:79
1276 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:68
1277 #: ../libguestfs-1.11.20/fish/virt-tar-in.pod:77
1278 #: ../libguestfs-1.11.20/fish/virt-tar-out.pod:70
1279 #: ../libguestfs-1.11.20/fuse/guestmount.pod:333
1280 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:408
1281 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:310
1282 #: ../libguestfs-1.11.20/resize/virt-resize.pod:589
1283 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:112
1284 #: ../rescue/virt-rescue.pod:310 ../resize/virt-resize.pod:589
1285 #: ../test-tool/libguestfs-test-tool.pod:112
1286 #: ../tools/virt-list-filesystems.pl:226 ../tools/virt-list-partitions.pl:295
1287 #: ../tools/virt-make-fs.pl:582 ../tools/virt-tar.pl:329
1288 #: ../tools/virt-win-reg.pl:790
1290 "You should have received a copy of the GNU General Public License along with "
1291 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
1292 "Ave, Cambridge, MA 02139, USA."
1296 #: ../cat/virt-filesystems.pod:5
1297 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:5
1299 "virt-filesystems - List filesystems, partitions, block devices, LVM in a "
1300 "virtual machine or disk image"
1304 #: ../cat/virt-filesystems.pod:9
1305 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:9
1308 " virt-filesystems [--options] -d domname\n"
1313 #: ../cat/virt-filesystems.pod:11
1314 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:11
1317 " virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
1322 #: ../cat/virt-filesystems.pod:15
1323 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:15
1325 "This tool allows you to discover filesystems, partitions, logical volumes, "
1326 "and their sizes in a disk image or virtual machine. It is a replacement for "
1327 "L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
1331 #: ../cat/virt-filesystems.pod:20
1332 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:20
1334 "One use for this tool is from shell scripts to iterate over all filesystems "
1335 "from a disk image:"
1339 #: ../cat/virt-filesystems.pod:23
1340 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:23
1343 " for fs in $(virt-filesystems -a disk.img); do\n"
1350 #: ../cat/virt-filesystems.pod:27
1351 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:27
1353 "Another use is to list partitions before using another tool to modify those "
1354 "partitions (such as L<virt-resize(1)>). If you are curious about what an "
1355 "unknown disk image contains, use this tool along with L<virt-inspector(1)>."
1359 #: ../cat/virt-filesystems.pod:32
1360 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:32
1362 "Various command line options control what this program displays. You need "
1363 "to give either I<-a> or I<-d> options to specify the disk image or libvirt "
1364 "guest respectively. If you just specify that then the program shows "
1365 "filesystems found, one per line, like this:"
1369 #: ../cat/virt-filesystems.pod:37
1370 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:37
1373 " $ virt-filesystems -a disk.img\n"
1375 " /dev/vg_guest/lv_root\n"
1380 #: ../cat/virt-filesystems.pod:41
1381 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:41
1383 "If you add I<-l> or I<--long> then the output includes extra information:"
1387 #: ../cat/virt-filesystems.pod:44
1388 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:44
1391 " $ virt-filesystems -a disk.img -l\n"
1392 " Name Type VFS Label Size\n"
1393 " /dev/sda1 filesystem ext4 boot 524288000\n"
1394 " /dev/vg_guest/lv_root filesystem ext4 root 10212081664\n"
1399 #: ../cat/virt-filesystems.pod:49
1400 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:49
1402 "If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
1407 #: ../cat/virt-filesystems.pod:52
1408 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:52
1411 " $ virt-filesystems -a disk.img --extra\n"
1413 " /dev/vg_guest/lv_root\n"
1414 " /dev/vg_guest/lv_swap\n"
1415 " /dev/vg_guest/lv_data\n"
1420 #: ../cat/virt-filesystems.pod:58
1421 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:58
1423 "If you add I<--partitions> then partitions are shown instead of filesystems:"
1427 #: ../cat/virt-filesystems.pod:60
1428 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:60
1431 " $ virt-filesystems -a disk.img --partitions\n"
1438 #: ../cat/virt-filesystems.pod:64
1439 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:64
1441 "Similarly you can use I<--logical-volumes>, I<--volume-groups>, I<--physical-"
1442 "volumes>, I<--block-devices> to list those items."
1446 #: ../cat/virt-filesystems.pod:67
1447 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:67
1449 "You can use these options in combination as well (if you want a combination "
1450 "including filesystems, you have to add I<--filesystems>). Notice that some "
1451 "items fall into several categories (eg. C</dev/sda1> might be both a "
1452 "partition and a filesystem). These items are listed several times. To get "
1453 "a list which includes absolutely everything that virt-filesystems knows "
1454 "about, use the I<--all> option."
1458 #: ../cat/virt-filesystems.pod:74
1459 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:74
1461 "UUIDs (because they are quite long) are not shown by default. Add the I<--"
1462 "uuid> option to display device and filesystem UUIDs in the long output."
1466 #: ../cat/virt-filesystems.pod:78
1467 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:78
1469 "I<--all --long --uuid> is a useful combination to display all possible "
1470 "information about everything."
1474 #: ../cat/virt-filesystems.pod:81
1475 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:81
1478 " $ virt-filesystems -a win.img --all --long --uuid -h\n"
1479 " Name Type VFS Label Size Parent UUID\n"
1480 " /dev/sda1 filesystem ntfs System Reserved 100M - F81C92571C92112C\n"
1481 " /dev/sda2 filesystem ntfs - 20G - F2E8996AE8992E3B\n"
1482 " /dev/sda1 partition - - 100M /dev/sda -\n"
1483 " /dev/sda2 partition - - 20G /dev/sda -\n"
1484 " /dev/sda device - - 20G - -\n"
1489 #: ../cat/virt-filesystems.pod:89
1490 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:89
1492 "For machine-readable output, use I<--csv> to get Comma-Separated Values."
1496 #: ../cat/virt-filesystems.pod:110
1497 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:110
1498 #: ../tools/virt-list-filesystems.pl:121
1503 #: ../cat/virt-filesystems.pod:112
1504 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:112
1506 "Display everything. This is currently the same as specifying these options: "
1507 "I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, I<--"
1508 "logical-volumes>, I<--volume-groups>, I<--physical-volumes>. (More may be "
1509 "added to this list in future)."
1513 #: ../cat/virt-filesystems.pod:117
1514 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:117
1515 msgid "See also I<--long>."
1519 #: ../cat/virt-filesystems.pod:119
1520 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:119
1521 msgid "B<--blkdevs>"
1525 #: ../cat/virt-filesystems.pod:121
1526 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:121
1527 msgid "B<--block-devices>"
1531 #: ../cat/virt-filesystems.pod:123
1532 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:123
1533 msgid "Display block devices."
1537 #: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301
1538 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:135
1539 #: ../libguestfs-1.11.20/cat/virt-ls.pod:301
1544 #: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303
1545 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:137
1546 #: ../libguestfs-1.11.20/cat/virt-ls.pod:303
1548 "Write out the results in CSV format (comma-separated values). This format "
1549 "can be imported easily into databases and spreadsheets, but read L</NOTE "
1550 "ABOUT CSV FORMAT> below."
1554 #: ../cat/virt-filesystems.pod:150
1555 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:150
1557 "When prompting for keys and passphrases, virt-filesystems normally turns "
1558 "echoing off so you cannot see what you are typing. If you are not worried "
1559 "about Tempest attacks and there is no one else in the room you can specify "
1560 "this flag to see what you are typing."
1564 #: ../cat/virt-filesystems.pod:155
1565 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:155
1570 #: ../cat/virt-filesystems.pod:157
1571 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:157
1573 "This causes filesystems that are not ordinary, mountable filesystems to be "
1574 "displayed. This category includes swapspace, and filesystems that are empty "
1575 "or contain unknown data."
1579 #: ../cat/virt-filesystems.pod:161
1580 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:161
1581 msgid "This option implies I<--filesystems>."
1585 #: ../cat/virt-filesystems.pod:163
1586 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:163
1587 msgid "B<--filesystems>"
1591 #: ../cat/virt-filesystems.pod:165
1592 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:165
1594 "Display mountable filesystems. If no display option was selected then this "
1595 "option is implied."
1599 #: ../cat/virt-filesystems.pod:168
1600 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:168
1601 msgid "With I<--extra>, non-mountable filesystems are shown too."
1605 #: ../cat/virt-filesystems.pod:181
1606 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:181
1609 " virt-filesystems --format=raw -a disk.img\n"
1614 #: ../cat/virt-filesystems.pod:185
1615 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:185
1618 " virt-filesystems --format=raw -a disk.img --format -a another.img\n"
1623 #: ../cat/virt-filesystems.pod:194 ../cat/virt-ls.pod:352
1624 #: ../df/virt-df.pod:119 ../fish/guestfish.pod:156
1625 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:194
1626 #: ../libguestfs-1.11.20/cat/virt-ls.pod:352
1627 #: ../libguestfs-1.11.20/df/virt-df.pod:119
1628 #: ../libguestfs-1.11.20/fish/guestfish.pod:156
1629 #: ../tools/virt-list-partitions.pl:109
1634 #: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354
1635 #: ../df/virt-df.pod:121 ../libguestfs-1.11.20/cat/virt-filesystems.pod:196
1636 #: ../libguestfs-1.11.20/cat/virt-ls.pod:354
1637 #: ../libguestfs-1.11.20/df/virt-df.pod:121
1638 #: ../tools/virt-list-partitions.pl:111
1639 msgid "B<--human-readable>"
1643 #: ../cat/virt-filesystems.pod:198
1644 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:198
1645 msgid "In I<--long> mode, display sizes in human-readable format."
1649 #: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366
1650 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:205
1651 #: ../libguestfs-1.11.20/cat/virt-ls.pod:366
1652 #: ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
1657 #: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368
1658 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:207
1659 #: ../libguestfs-1.11.20/cat/virt-ls.pod:368
1660 #: ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
1665 #: ../cat/virt-filesystems.pod:209
1666 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:209
1667 msgid "Display extra columns of data (\"long format\")."
1671 #: ../cat/virt-filesystems.pod:211
1672 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:211
1673 msgid "A title row is added unless you also specify I<--no-title>."
1677 #: ../cat/virt-filesystems.pod:213
1678 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:213
1680 "The extra columns displayed depend on what output you select, and the "
1681 "ordering of columns may change in future versions. Use the title row, I<--"
1682 "csv> output and/or L<csvtool(1)> to match columns to data in external "
1687 #: ../cat/virt-filesystems.pod:218
1688 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:218
1690 "Use I<-h> if you want sizes to be displayed in human-readable format. The "
1691 "default is to show raw numbers of I<bytes>."
1695 #: ../cat/virt-filesystems.pod:221
1696 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:221
1697 msgid "Use I<--uuid> to display UUIDs too."
1701 #: ../cat/virt-filesystems.pod:223
1702 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:223
1707 #: ../cat/virt-filesystems.pod:225
1708 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:225
1709 msgid "B<--logvols>"
1713 #: ../cat/virt-filesystems.pod:227
1714 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:227
1715 msgid "B<--logical-volumes>"
1719 #: ../cat/virt-filesystems.pod:229
1720 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:229
1722 "Display LVM logical volumes. In this mode, these are displayed irrespective "
1723 "of whether the LVs contain filesystems."
1727 #: ../cat/virt-filesystems.pod:232
1728 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:232
1729 msgid "B<--no-title>"
1733 #: ../cat/virt-filesystems.pod:234
1734 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:234
1735 msgid "In I<--long> mode, don't add a title row."
1739 #: ../cat/virt-filesystems.pod:236
1740 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:236
1742 "Note that the order of the columns is not fixed, and may change in future "
1743 "versions of virt-filesystems, so using this option may give you unexpected "
1748 #: ../cat/virt-filesystems.pod:240
1749 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:240
1754 #: ../cat/virt-filesystems.pod:242
1755 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:242
1756 msgid "B<--partitions>"
1760 #: ../cat/virt-filesystems.pod:244
1761 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:244
1763 "Display partitions. In this mode, these are displayed irrespective of "
1764 "whether the partitions contain filesystems."
1768 #: ../cat/virt-filesystems.pod:247
1769 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:247
1774 #: ../cat/virt-filesystems.pod:249
1775 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:249
1776 msgid "B<--physvols>"
1780 #: ../cat/virt-filesystems.pod:251
1781 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:251
1782 msgid "B<--physical-volumes>"
1786 #: ../cat/virt-filesystems.pod:253
1787 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:253
1788 msgid "Display LVM physical volumes."
1792 #: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:157
1793 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:255
1794 #: ../libguestfs-1.11.20/df/virt-df.pod:157
1799 #: ../cat/virt-filesystems.pod:257
1800 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:257
1805 #: ../cat/virt-filesystems.pod:259
1806 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:259
1807 msgid "In I<--long> mode, display UUIDs as well."
1811 #: ../cat/virt-filesystems.pod:273
1812 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:273
1817 #: ../cat/virt-filesystems.pod:275
1818 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:275
1819 msgid "B<--volgroups>"
1823 #: ../cat/virt-filesystems.pod:277
1824 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:277
1825 msgid "B<--volume-groups>"
1829 #: ../cat/virt-filesystems.pod:279
1830 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:279
1831 msgid "Display LVM volume groups."
1835 #: ../cat/virt-filesystems.pod:287
1836 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:287
1841 #: ../cat/virt-filesystems.pod:289
1842 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:289
1844 "Note that columns in the output are subject to reordering and change in "
1845 "future versions of this tool."
1849 #: ../cat/virt-filesystems.pod:294
1850 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:294
1855 #: ../cat/virt-filesystems.pod:296
1856 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:296
1857 msgid "The filesystem, partition, block device or LVM name."
1861 #: ../cat/virt-filesystems.pod:298
1862 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:298
1864 "For device and partition names these are displayed as canonical libguestfs "
1865 "names, so that for example C</dev/sda2> is the second partition on the first "
1870 #: ../cat/virt-filesystems.pod:302
1871 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:302
1873 "If the I<--long> option is B<not> specified, then only the name column is "
1874 "shown in the output."
1878 #: ../cat/virt-filesystems.pod:305
1879 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:305
1884 #: ../cat/virt-filesystems.pod:307
1885 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:307
1886 msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
1890 #: ../cat/virt-filesystems.pod:309
1891 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:309
1896 #: ../cat/virt-filesystems.pod:311
1897 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:311
1899 "If there is a filesystem, then this column displays the filesystem type if "
1900 "one could be detected, eg. C<ext4>."
1904 #: ../cat/virt-filesystems.pod:314
1905 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:314
1910 #: ../cat/virt-filesystems.pod:316
1911 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:316
1913 "If the object has a label (used for identifying and mounting filesystems) "
1914 "then this column contains the label."
1918 #: ../cat/virt-filesystems.pod:319
1919 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:319
1924 #: ../cat/virt-filesystems.pod:321
1925 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:321
1927 "The size of the object in bytes. If the I<--human> option is used then the "
1928 "size is displayed in a human-readable form."
1932 #: ../cat/virt-filesystems.pod:324
1933 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:324
1938 #: ../cat/virt-filesystems.pod:326
1939 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:326
1941 "The parent column records the parent relationship between objects. For "
1942 "example, if the object is a partition, then this column contains the name of "
1943 "the containing device. If the object is a logical volume, then this column "
1944 "is the name of the volume group."
1948 #: ../cat/virt-filesystems.pod:331
1949 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:331
1954 #: ../cat/virt-filesystems.pod:333
1955 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:333
1957 "If the object has a UUID (used for identifying and mounting filesystems and "
1958 "block devices) then this column contains the UUID as a string."
1962 #: ../cat/virt-filesystems.pod:337
1963 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:337
1964 msgid "The UUID is only displayed if the I<--uuid> option is given."
1968 #: ../cat/virt-filesystems.pod:341 ../cat/virt-ls.pod:459
1969 #: ../df/virt-df.pod:185 ../libguestfs-1.11.20/cat/virt-filesystems.pod:341
1970 #: ../libguestfs-1.11.20/cat/virt-ls.pod:459
1971 #: ../libguestfs-1.11.20/df/virt-df.pod:185
1972 msgid "NOTE ABOUT CSV FORMAT"
1976 #: ../cat/virt-filesystems.pod:343 ../cat/virt-ls.pod:461
1977 #: ../df/virt-df.pod:187 ../libguestfs-1.11.20/cat/virt-filesystems.pod:343
1978 #: ../libguestfs-1.11.20/cat/virt-ls.pod:461
1979 #: ../libguestfs-1.11.20/df/virt-df.pod:187
1981 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
1982 "should be easy to parse, but it is definitely not easy to parse."
1986 #: ../cat/virt-filesystems.pod:346 ../cat/virt-ls.pod:464
1987 #: ../df/virt-df.pod:190 ../libguestfs-1.11.20/cat/virt-filesystems.pod:346
1988 #: ../libguestfs-1.11.20/cat/virt-ls.pod:464
1989 #: ../libguestfs-1.11.20/df/virt-df.pod:190
1991 "Myth: Just split fields at commas. Reality: This does I<not> work "
1992 "reliably. This example has two columns:"
1996 #: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:467
1997 #: ../df/virt-df.pod:193 ../libguestfs-1.11.20/cat/virt-filesystems.pod:349
1998 #: ../libguestfs-1.11.20/cat/virt-ls.pod:467
1999 #: ../libguestfs-1.11.20/df/virt-df.pod:193
2002 " \"foo,bar\",baz\n"
2007 #: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:469
2008 #: ../df/virt-df.pod:195 ../libguestfs-1.11.20/cat/virt-filesystems.pod:351
2009 #: ../libguestfs-1.11.20/cat/virt-ls.pod:469
2010 #: ../libguestfs-1.11.20/df/virt-df.pod:195
2012 "Myth: Read the file one line at a time. Reality: This does I<not> work "
2013 "reliably. This example has one row:"
2017 #: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:472
2018 #: ../df/virt-df.pod:198 ../libguestfs-1.11.20/cat/virt-filesystems.pod:354
2019 #: ../libguestfs-1.11.20/cat/virt-ls.pod:472
2020 #: ../libguestfs-1.11.20/df/virt-df.pod:198
2029 #: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:475
2030 #: ../df/virt-df.pod:201 ../libguestfs-1.11.20/cat/virt-filesystems.pod:357
2031 #: ../libguestfs-1.11.20/cat/virt-ls.pod:475
2032 #: ../libguestfs-1.11.20/df/virt-df.pod:201
2034 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
2035 "packaged in major Linux distributions)."
2039 #: ../cat/virt-filesystems.pod:360 ../cat/virt-ls.pod:478
2040 #: ../df/virt-df.pod:204 ../libguestfs-1.11.20/cat/virt-filesystems.pod:360
2041 #: ../libguestfs-1.11.20/cat/virt-ls.pod:478
2042 #: ../libguestfs-1.11.20/df/virt-df.pod:204
2044 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
2045 "or Python's built-in csv library)."
2049 #: ../cat/virt-filesystems.pod:363 ../cat/virt-ls.pod:481
2050 #: ../df/virt-df.pod:207 ../libguestfs-1.11.20/cat/virt-filesystems.pod:363
2051 #: ../libguestfs-1.11.20/cat/virt-ls.pod:481
2052 #: ../libguestfs-1.11.20/df/virt-df.pod:207
2053 msgid "Most spreadsheets and databases can import CSV directly."
2057 #: ../cat/virt-filesystems.pod:374
2058 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:374
2060 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, L<virt-list-"
2061 "filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, L<http://"
2066 #: ../cat/virt-filesystems.pod:389
2067 #: ../libguestfs-1.11.20/cat/virt-filesystems.pod:389
2068 #: ../tools/virt-make-fs.pl:570 ../tools/virt-win-reg.pl:778
2069 msgid "Copyright (C) 2010 Red Hat Inc."
2073 #: ../cat/virt-ls.pod:5 ../libguestfs-1.11.20/cat/virt-ls.pod:5
2074 msgid "virt-ls - List files in a virtual machine"
2078 #: ../cat/virt-ls.pod:9 ../libguestfs-1.11.20/cat/virt-ls.pod:9
2081 " virt-ls [--options] -d domname directory [directory ...]\n"
2086 #: ../cat/virt-ls.pod:11 ../libguestfs-1.11.20/cat/virt-ls.pod:11
2089 " virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory ...]\n"
2094 #: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15
2095 #: ../libguestfs-1.11.20/cat/virt-ls.pod:13
2096 #: ../libguestfs-1.11.20/df/virt-df.pod:15
2097 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:13
2098 #: ../rescue/virt-rescue.pod:13
2103 #: ../cat/virt-ls.pod:15 ../libguestfs-1.11.20/cat/virt-ls.pod:15
2106 " virt-ls [--options] domname directory\n"
2111 #: ../cat/virt-ls.pod:17 ../libguestfs-1.11.20/cat/virt-ls.pod:17
2114 " virt-ls [--options] disk.img [disk.img ...] directory\n"
2119 #: ../cat/virt-ls.pod:21 ../libguestfs-1.11.20/cat/virt-ls.pod:21
2121 "C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
2122 "more from a virtual machine or disk image."
2126 #: ../cat/virt-ls.pod:24 ../libguestfs-1.11.20/cat/virt-ls.pod:24
2128 "Multiple directory names can be given, in which case the output from each is "
2133 #: ../cat/virt-ls.pod:27 ../libguestfs-1.11.20/cat/virt-ls.pod:27
2135 "To list directories from a libvirt guest use the I<-d> option to specify the "
2136 "name of the guest. For a disk image, use the I<-a> option."
2140 #: ../cat/virt-ls.pod:31 ../libguestfs-1.11.20/cat/virt-ls.pod:31
2142 "C<virt-ls> can do many simple file listings. For more complicated cases you "
2143 "may need to use L<guestfish(1)>, or write a program directly to the L<guestfs"
2148 #: ../cat/virt-ls.pod:37 ../libguestfs-1.11.20/cat/virt-ls.pod:37
2149 msgid "Get a list of all files and directories in a virtual machine:"
2153 #: ../cat/virt-ls.pod:39 ../libguestfs-1.11.20/cat/virt-ls.pod:39
2156 " virt-ls -R -d guest /\n"
2161 #: ../cat/virt-ls.pod:41 ../libguestfs-1.11.20/cat/virt-ls.pod:41
2162 msgid "List all setuid or setgid programs in a Linux virtual machine:"
2166 #: ../cat/virt-ls.pod:43 ../libguestfs-1.11.20/cat/virt-ls.pod:43
2169 " virt-ls -lR -d guest / | grep '^- [42]'\n"
2174 #: ../cat/virt-ls.pod:45 ../libguestfs-1.11.20/cat/virt-ls.pod:45
2175 msgid "List all public-writable directories in a Linux virtual machine:"
2179 #: ../cat/virt-ls.pod:47 ../libguestfs-1.11.20/cat/virt-ls.pod:47
2182 " virt-ls -lR -d guest / | grep '^d ...7'\n"
2187 #: ../cat/virt-ls.pod:49 ../libguestfs-1.11.20/cat/virt-ls.pod:49
2188 msgid "List all Unix domain sockets in a Linux virtual machine:"
2192 #: ../cat/virt-ls.pod:51 ../libguestfs-1.11.20/cat/virt-ls.pod:51
2195 " virt-ls -lR -d guest / | grep '^s'\n"
2200 #: ../cat/virt-ls.pod:53 ../libguestfs-1.11.20/cat/virt-ls.pod:53
2201 msgid "List all regular files with filenames ending in '.png':"
2205 #: ../cat/virt-ls.pod:55 ../libguestfs-1.11.20/cat/virt-ls.pod:55
2208 " virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
2213 #: ../cat/virt-ls.pod:57 ../libguestfs-1.11.20/cat/virt-ls.pod:57
2214 msgid "To display files larger than 10MB in home directories:"
2218 #: ../cat/virt-ls.pod:59 ../libguestfs-1.11.20/cat/virt-ls.pod:59
2221 " virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
2226 #: ../cat/virt-ls.pod:61 ../libguestfs-1.11.20/cat/virt-ls.pod:61
2227 msgid "Find everything modified in the last 7 days:"
2231 #: ../cat/virt-ls.pod:63 ../libguestfs-1.11.20/cat/virt-ls.pod:63
2234 " virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
2239 #: ../cat/virt-ls.pod:65 ../libguestfs-1.11.20/cat/virt-ls.pod:65
2240 msgid "Find regular files modified in the last 24 hours:"
2244 #: ../cat/virt-ls.pod:67 ../libguestfs-1.11.20/cat/virt-ls.pod:67
2247 " virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
2252 #: ../cat/virt-ls.pod:69 ../libguestfs-1.11.20/cat/virt-ls.pod:69
2253 msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
2257 #: ../cat/virt-ls.pod:71 ../libguestfs-1.11.20/cat/virt-ls.pod:71
2259 "Find the differences between files in a guest and an earlier snapshot of the "
2264 #: ../cat/virt-ls.pod:74 ../libguestfs-1.11.20/cat/virt-ls.pod:74
2267 " virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
2268 " virt-ls -lR -a current.img / --uids --time-t > new\n"
2269 " diff -u old new | less\n"
2274 #: ../cat/virt-ls.pod:78 ../libguestfs-1.11.20/cat/virt-ls.pod:78
2276 "The commands above won't find files where the content has changed but the "
2277 "metadata (eg. file size and modification date) is the same. To do that, you "
2278 "need to add the I<--checksum> parameter to both C<virt-ls> commands. I<--"
2279 "checksum> can be quite slow since it has to read and compute a checksum of "
2280 "every regular file in the virtual machine."
2284 #: ../cat/virt-ls.pod:84 ../libguestfs-1.11.20/cat/virt-ls.pod:84
2285 msgid "OUTPUT MODES"
2289 #: ../cat/virt-ls.pod:86 ../libguestfs-1.11.20/cat/virt-ls.pod:86
2291 "C<virt-ls> has four output modes, controlled by different combinations of "
2292 "the I<-l> and I<-R> options."
2296 #: ../cat/virt-ls.pod:89 ../libguestfs-1.11.20/cat/virt-ls.pod:89
2297 msgid "SIMPLE LISTING"
2301 #: ../cat/virt-ls.pod:91 ../libguestfs-1.11.20/cat/virt-ls.pod:91
2302 msgid "A simple listing is like the ordinary L<ls(1)> command:"
2306 #: ../cat/virt-ls.pod:93 ../libguestfs-1.11.20/cat/virt-ls.pod:93
2309 " $ virt-ls -d guest /\n"
2317 #: ../cat/virt-ls.pod:98 ../libguestfs-1.11.20/cat/virt-ls.pod:98
2318 msgid "LONG LISTING"
2322 #: ../cat/virt-ls.pod:100 ../libguestfs-1.11.20/cat/virt-ls.pod:100
2324 "With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
2325 "(more specifically, like the C<guestfs_ll> function)."
2329 #: ../cat/virt-ls.pod:103 ../libguestfs-1.11.20/cat/virt-ls.pod:103
2332 " $ virt-ls -l -d guest /\n"
2334 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
2335 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
2341 #: ../cat/virt-ls.pod:109 ../libguestfs-1.11.20/cat/virt-ls.pod:109
2343 "Note that while this is useful for displaying a directory, do not try "
2344 "parsing this output in another program. Use L</RECURSIVE LONG LISTING> "
2349 #: ../cat/virt-ls.pod:113 ../libguestfs-1.11.20/cat/virt-ls.pod:113
2350 msgid "RECURSIVE LISTING"
2354 #: ../cat/virt-ls.pod:115 ../libguestfs-1.11.20/cat/virt-ls.pod:115
2356 "With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
2357 "and directories recursively:"
2361 #: ../cat/virt-ls.pod:118 ../libguestfs-1.11.20/cat/virt-ls.pod:118
2364 " $ virt-ls -R -d guest /tmp\n"
2372 #: ../cat/virt-ls.pod:123 ../libguestfs-1.11.20/cat/virt-ls.pod:123
2374 "To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
2375 "converts C<\\0> characters to C<\\n>."
2379 #: ../cat/virt-ls.pod:126 ../libguestfs-1.11.20/cat/virt-ls.pod:126
2380 msgid "RECURSIVE LONG LISTING"
2384 #: ../cat/virt-ls.pod:128 ../libguestfs-1.11.20/cat/virt-ls.pod:128
2386 "Using I<-lR> options together changes the output to display directories "
2387 "recursively, with file stats, and optionally other features such as "
2388 "checksums and extended attributes."
2392 #: ../cat/virt-ls.pod:132 ../libguestfs-1.11.20/cat/virt-ls.pod:132
2394 "Most of the interesting features of C<virt-ls> are only available when using "
2399 #: ../cat/virt-ls.pod:135 ../libguestfs-1.11.20/cat/virt-ls.pod:135
2401 "The fields are normally space-separated. Filenames are B<not> quoted, so "
2402 "you cannot use the output in another program (because filenames can contain "
2403 "spaces and other unsafe characters). If the guest was untrusted and someone "
2404 "knew you were using C<virt-ls> to analyze the guest, they could play tricks "
2405 "on you by creating filenames with embedded newline characters. To B<safely> "
2406 "parse the output in another program, use the I<--csv> (Comma-Separated "
2411 #: ../cat/virt-ls.pod:143 ../libguestfs-1.11.20/cat/virt-ls.pod:143
2413 "Note that this output format is completely unrelated to the C<ls -lR> "
2418 #: ../cat/virt-ls.pod:146 ../libguestfs-1.11.20/cat/virt-ls.pod:146
2421 " $ virt-ls -lR -d guest /bin\n"
2422 " d 0555 4096 /bin\n"
2423 " - 0755 123 /bin/alsaunmute\n"
2424 " - 0755 28328 /bin/arch\n"
2425 " l 0777 4 /bin/awk -> gawk\n"
2426 " - 0755 27216 /bin/basename\n"
2427 " - 0755 943360 /bin/bash\n"
2433 #: ../cat/virt-ls.pod:155 ../libguestfs-1.11.20/cat/virt-ls.pod:155
2434 msgid "These basic fields are always shown:"
2438 #: ../cat/virt-ls.pod:159 ../libguestfs-1.11.20/cat/virt-ls.pod:159
2443 #: ../cat/virt-ls.pod:161 ../libguestfs-1.11.20/cat/virt-ls.pod:161
2445 "The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
2446 "(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
2447 "link), C<s> (socket) or C<u> (unknown)."
2451 #: ../cat/virt-ls.pod:171 ../libguestfs-1.11.20/cat/virt-ls.pod:171
2456 #: ../cat/virt-ls.pod:173 ../libguestfs-1.11.20/cat/virt-ls.pod:173
2457 msgid "The Unix permissions, displayed as a 4 digit octal number."
2461 #: ../cat/virt-ls.pod:175 ../libguestfs-1.11.20/cat/virt-ls.pod:175
2466 #: ../cat/virt-ls.pod:177 ../libguestfs-1.11.20/cat/virt-ls.pod:177
2468 "The size of the file. This is shown in bytes unless I<-h> or I<--human-"
2469 "readable> option is given, in which case this is shown as a human-readable "
2474 #: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4183
2475 #: ../libguestfs-1.11.20/cat/virt-ls.pod:181
2476 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4183
2481 #: ../cat/virt-ls.pod:183 ../libguestfs-1.11.20/cat/virt-ls.pod:183
2482 msgid "The full path of the file or directory."
2486 #: ../cat/virt-ls.pod:185 ../libguestfs-1.11.20/cat/virt-ls.pod:185
2491 #: ../cat/virt-ls.pod:187 ../libguestfs-1.11.20/cat/virt-ls.pod:187
2492 msgid "For symbolic links only, the link target."
2496 #: ../cat/virt-ls.pod:191 ../libguestfs-1.11.20/cat/virt-ls.pod:191
2498 "In I<-lR> mode, additional command line options enable the display of more "
2503 #: ../cat/virt-ls.pod:194 ../libguestfs-1.11.20/cat/virt-ls.pod:194
2505 "With the I<--uids> flag, these additional fields are displayed before the "
2510 #: ../cat/virt-ls.pod:199 ../libguestfs-1.11.20/cat/virt-ls.pod:199
2515 #: ../cat/virt-ls.pod:201 ../libguestfs-1.11.20/cat/virt-ls.pod:201
2520 #: ../cat/virt-ls.pod:203 ../libguestfs-1.11.20/cat/virt-ls.pod:203
2522 "The UID and GID of the owner of the file (displayed numerically). Note "
2523 "these only make sense in the context of a Unix-like guest."
2527 #: ../cat/virt-ls.pod:208 ../libguestfs-1.11.20/cat/virt-ls.pod:208
2528 msgid "With the I<--times> flag, these additional fields are displayed:"
2532 #: ../cat/virt-ls.pod:212 ../libguestfs-1.11.20/cat/virt-ls.pod:212
2537 #: ../cat/virt-ls.pod:214 ../libguestfs-1.11.20/cat/virt-ls.pod:214
2538 msgid "The time of last access."
2542 #: ../cat/virt-ls.pod:216 ../libguestfs-1.11.20/cat/virt-ls.pod:216
2547 #: ../cat/virt-ls.pod:218 ../libguestfs-1.11.20/cat/virt-ls.pod:218
2548 msgid "The time of last modification."
2552 #: ../cat/virt-ls.pod:220 ../libguestfs-1.11.20/cat/virt-ls.pod:220
2557 #: ../cat/virt-ls.pod:222 ../libguestfs-1.11.20/cat/virt-ls.pod:222
2558 msgid "The time of last status change."
2562 #: ../cat/virt-ls.pod:226 ../libguestfs-1.11.20/cat/virt-ls.pod:226
2564 "The time fields are displayed as string dates and times, unless one of the "
2565 "I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
2569 #: ../cat/virt-ls.pod:229 ../libguestfs-1.11.20/cat/virt-ls.pod:229
2570 msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
2574 #: ../cat/virt-ls.pod:233 ../libguestfs-1.11.20/cat/virt-ls.pod:233
2579 #: ../cat/virt-ls.pod:235 ../libguestfs-1.11.20/cat/virt-ls.pod:235
2581 "The device containing the file (displayed as major:minor). This may not "
2582 "match devices as known to the guest."
2586 #: ../cat/virt-ls.pod:238 ../libguestfs-1.11.20/cat/virt-ls.pod:238
2591 #: ../cat/virt-ls.pod:240 ../libguestfs-1.11.20/cat/virt-ls.pod:240
2592 msgid "The inode number."
2596 #: ../cat/virt-ls.pod:242 ../libguestfs-1.11.20/cat/virt-ls.pod:242
2601 #: ../cat/virt-ls.pod:244 ../libguestfs-1.11.20/cat/virt-ls.pod:244
2602 msgid "The number of hard links."
2606 #: ../cat/virt-ls.pod:246 ../libguestfs-1.11.20/cat/virt-ls.pod:246
2611 #: ../cat/virt-ls.pod:248 ../libguestfs-1.11.20/cat/virt-ls.pod:248
2613 "For block and char special files, the device (displayed as major:minor)."
2617 #: ../cat/virt-ls.pod:251 ../libguestfs-1.11.20/cat/virt-ls.pod:251
2622 #: ../cat/virt-ls.pod:253 ../libguestfs-1.11.20/cat/virt-ls.pod:253
2623 msgid "The number of 512 byte blocks allocated to the file."
2627 #: ../cat/virt-ls.pod:257 ../libguestfs-1.11.20/cat/virt-ls.pod:257
2629 "With the I<--checksum> flag, the checksum of the file contents is shown "
2630 "(only for regular files). Computing file checksums can take a considerable "
2635 #: ../cat/virt-ls.pod:280 ../libguestfs-1.11.20/cat/virt-ls.pod:280
2636 msgid "B<--checksum>"
2640 #: ../cat/virt-ls.pod:282 ../libguestfs-1.11.20/cat/virt-ls.pod:282
2641 msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
2645 #: ../cat/virt-ls.pod:284 ../libguestfs-1.11.20/cat/virt-ls.pod:284
2647 "Display checksum over file contents for regular files. With no argument, "
2648 "this defaults to using I<md5>. Using an argument, you can select the "
2649 "checksum type to use."
2653 #: ../cat/virt-ls.pod:288 ../cat/virt-ls.pod:325 ../cat/virt-ls.pod:358
2654 #: ../cat/virt-ls.pod:391 ../cat/virt-ls.pod:401 ../cat/virt-ls.pod:408
2655 #: ../cat/virt-ls.pod:415 ../cat/virt-ls.pod:422
2656 #: ../libguestfs-1.11.20/cat/virt-ls.pod:288
2657 #: ../libguestfs-1.11.20/cat/virt-ls.pod:325
2658 #: ../libguestfs-1.11.20/cat/virt-ls.pod:358
2659 #: ../libguestfs-1.11.20/cat/virt-ls.pod:391
2660 #: ../libguestfs-1.11.20/cat/virt-ls.pod:401
2661 #: ../libguestfs-1.11.20/cat/virt-ls.pod:408
2662 #: ../libguestfs-1.11.20/cat/virt-ls.pod:415
2663 #: ../libguestfs-1.11.20/cat/virt-ls.pod:422
2665 "This option only has effect in I<-lR> output mode. See L</RECURSIVE LONG "
2670 #: ../cat/virt-ls.pod:316 ../libguestfs-1.11.20/cat/virt-ls.pod:316
2672 "When prompting for keys and passphrases, virt-ls normally turns echoing off "
2673 "so you cannot see what you are typing. If you are not worried about Tempest "
2674 "attacks and there is no one else in the room you can specify this flag to "
2675 "see what you are typing."
2679 #: ../cat/virt-ls.pod:321 ../libguestfs-1.11.20/cat/virt-ls.pod:321
2680 msgid "B<--extra-stats>"
2684 #: ../cat/virt-ls.pod:323 ../libguestfs-1.11.20/cat/virt-ls.pod:323
2685 msgid "Display extra stats."
2689 #: ../cat/virt-ls.pod:339 ../libguestfs-1.11.20/cat/virt-ls.pod:339
2692 " virt-ls --format=raw -a disk.img /dir\n"
2697 #: ../cat/virt-ls.pod:343 ../libguestfs-1.11.20/cat/virt-ls.pod:343
2700 " virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
2705 #: ../cat/virt-ls.pod:356 ../libguestfs-1.11.20/cat/virt-ls.pod:356
2706 msgid "Display file sizes in human-readable format."
2710 #: ../cat/virt-ls.pod:370 ../libguestfs-1.11.20/cat/virt-ls.pod:370
2715 #: ../cat/virt-ls.pod:372 ../libguestfs-1.11.20/cat/virt-ls.pod:372
2716 msgid "B<--recursive>"
2720 #: ../cat/virt-ls.pod:374 ../libguestfs-1.11.20/cat/virt-ls.pod:374
2722 "Select the mode. With neither of these options, C<virt-ls> produces a "
2723 "simple, flat list of the files in the named directory. See L</SIMPLE "
2728 #: ../cat/virt-ls.pod:378 ../libguestfs-1.11.20/cat/virt-ls.pod:378
2730 "C<virt-ls -l> produces a \"long listing\", which shows more detail. See L</"
2735 #: ../cat/virt-ls.pod:381 ../libguestfs-1.11.20/cat/virt-ls.pod:381
2737 "C<virt-ls -R> produces a recursive list of files starting at the named "
2738 "directory. See L</RECURSIVE LISTING>."
2742 #: ../cat/virt-ls.pod:384 ../libguestfs-1.11.20/cat/virt-ls.pod:384
2744 "C<virt-ls -lR> produces a recursive long listing which can be more easily "
2745 "parsed. See L</RECURSIVE LONG LISTING>."
2749 #: ../cat/virt-ls.pod:387 ../libguestfs-1.11.20/cat/virt-ls.pod:387
2754 #: ../cat/virt-ls.pod:389 ../libguestfs-1.11.20/cat/virt-ls.pod:389
2755 msgid "Display time fields."
2759 #: ../cat/virt-ls.pod:394 ../libguestfs-1.11.20/cat/virt-ls.pod:394
2760 msgid "B<--time-days>"
2764 #: ../cat/virt-ls.pod:396 ../libguestfs-1.11.20/cat/virt-ls.pod:396
2765 msgid "Display time fields as days before now (negative if in the future)."
2769 #: ../cat/virt-ls.pod:398 ../libguestfs-1.11.20/cat/virt-ls.pod:398
2771 "Note that C<0> in output means \"up to 1 day before now\", or that the age "
2772 "of the file is between 0 and 86399 seconds."
2776 #: ../cat/virt-ls.pod:404 ../libguestfs-1.11.20/cat/virt-ls.pod:404
2777 msgid "B<--time-relative>"
2781 #: ../cat/virt-ls.pod:406 ../libguestfs-1.11.20/cat/virt-ls.pod:406
2782 msgid "Display time fields as seconds before now (negative if in the future)."
2786 #: ../cat/virt-ls.pod:411 ../libguestfs-1.11.20/cat/virt-ls.pod:411
2791 #: ../cat/virt-ls.pod:413 ../libguestfs-1.11.20/cat/virt-ls.pod:413
2792 msgid "Display time fields as seconds since the Unix epoch."
2796 #: ../cat/virt-ls.pod:418 ../libguestfs-1.11.20/cat/virt-ls.pod:418
2801 #: ../cat/virt-ls.pod:420 ../libguestfs-1.11.20/cat/virt-ls.pod:420
2802 msgid "Display UID and GID fields."
2806 #: ../cat/virt-ls.pod:445 ../libguestfs-1.11.20/cat/virt-ls.pod:445
2807 msgid "Previous versions of virt-ls allowed you to write either:"
2811 #: ../cat/virt-ls.pod:447 ../libguestfs-1.11.20/cat/virt-ls.pod:447
2814 " virt-ls disk.img [disk.img ...] /dir\n"
2819 #: ../cat/virt-ls.pod:451 ../libguestfs-1.11.20/cat/virt-ls.pod:451
2822 " virt-ls guestname /dir\n"
2827 #: ../cat/virt-ls.pod:492 ../libguestfs-1.11.20/cat/virt-ls.pod:492
2829 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-"
2830 "tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
2831 "L<http://libguestfs.org/>."
2835 #: ../cat/virt-ls.pod:508 ../df/virt-df.pod:230 ../edit/virt-edit.pod:369
2836 #: ../libguestfs-1.11.20/cat/virt-ls.pod:508
2837 #: ../libguestfs-1.11.20/df/virt-df.pod:230
2838 #: ../libguestfs-1.11.20/edit/virt-edit.pod:369
2839 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:298
2840 #: ../rescue/virt-rescue.pod:298
2841 msgid "Copyright (C) 2009-2011 Red Hat Inc."
2845 #: ../df/virt-df.pod:5 ../libguestfs-1.11.20/df/virt-df.pod:5
2846 msgid "virt-df - Display free space on virtual filesystems"
2850 #: ../df/virt-df.pod:9 ../libguestfs-1.11.20/df/virt-df.pod:9
2853 " virt-df [--options]\n"
2858 #: ../df/virt-df.pod:11 ../libguestfs-1.11.20/df/virt-df.pod:11
2861 " virt-df [--options] -d domname\n"
2866 #: ../df/virt-df.pod:13 ../libguestfs-1.11.20/df/virt-df.pod:13
2869 " virt-df [--options] -a disk.img [-a disk.img ...]\n"
2874 #: ../df/virt-df.pod:17 ../libguestfs-1.11.20/df/virt-df.pod:17
2877 " virt-df [--options] domname\n"
2882 #: ../df/virt-df.pod:19 ../libguestfs-1.11.20/df/virt-df.pod:19
2885 " virt-df [--options] disk.img [disk.img ...]\n"
2890 #: ../df/virt-df.pod:23 ../libguestfs-1.11.20/df/virt-df.pod:23
2892 "C<virt-df> is a command line tool to display free space on virtual machine "
2893 "filesystems. Unlike other tools, it doesn't just display the size of disk "
2894 "allocated to a virtual machine, but can look inside disk images to see how "
2895 "much space is really being used."
2899 #: ../df/virt-df.pod:28 ../libguestfs-1.11.20/df/virt-df.pod:28
2901 "If used without any I<-a> or I<-d> arguments, C<virt-df> checks with libvirt "
2902 "to get a list of all active and inactive guests, and performs a C<df>-type "
2903 "operation on each one in turn, printing out the results."
2907 #: ../df/virt-df.pod:32 ../libguestfs-1.11.20/df/virt-df.pod:32
2909 "If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a C<df>-"
2910 "type operation on either the single named libvirt domain, or on the disk "
2911 "image(s) listed on the command line (which must all belong to a single VM). "
2912 "In this mode (with arguments), C<virt-df> will I<only work for a single "
2913 "guest>. If you want to run on multiple guests, then you have to invoke "
2914 "C<virt-df> multiple times."
2918 #: ../df/virt-df.pod:39 ../libguestfs-1.11.20/df/virt-df.pod:39
2920 "Use the I<--csv> option to get a format which can be easily parsed by other "
2921 "programs. Other options are similar to the standard L<df(1)> command."
2925 #: ../df/virt-df.pod:45 ../libguestfs-1.11.20/df/virt-df.pod:45
2927 "Show disk usage for a single libvirt guest called C<F14x64>. Make the "
2928 "output human-readable:"
2932 #: ../df/virt-df.pod:48 ../libguestfs-1.11.20/df/virt-df.pod:48
2935 " # virt-df -d F14x64 -h\n"
2936 " Filesystem Size Used Available Use%\n"
2937 " F14x64:/dev/sda1 484M 66M 393M 14%\n"
2938 " F14x64:/dev/vg_f13x64/lv_root 7.4G 3.4G 4.0G 46%\n"
2943 #: ../df/virt-df.pod:53 ../libguestfs-1.11.20/df/virt-df.pod:53
2944 msgid "Show disk usage for a disk image file called C<test.img>:"
2948 #: ../df/virt-df.pod:55 ../libguestfs-1.11.20/df/virt-df.pod:55
2951 " $ virt-df -a test1.img\n"
2952 " Filesystem 1K-blocks Used Available Use%\n"
2953 " test1.img:/dev/sda1 99099 1551 92432 2%\n"
2958 #: ../df/virt-df.pod:106 ../libguestfs-1.11.20/df/virt-df.pod:106
2961 " virt-df --format=raw -a disk.img\n"
2966 #: ../df/virt-df.pod:110 ../libguestfs-1.11.20/df/virt-df.pod:110
2969 " virt-df --format=raw -a disk.img --format -a another.img\n"
2974 #: ../df/virt-df.pod:123 ../libguestfs-1.11.20/df/virt-df.pod:123
2975 msgid "Print sizes in human-readable format."
2979 #: ../df/virt-df.pod:125 ../libguestfs-1.11.20/df/virt-df.pod:125
2980 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
2984 #: ../df/virt-df.pod:127 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:155
2985 #: ../libguestfs-1.11.20/df/virt-df.pod:127
2986 #: ../libguestfs-1.11.20/fish/guestfish.pod:258
2987 #: ../libguestfs-1.11.20/fuse/guestmount.pod:155
2992 #: ../df/virt-df.pod:129 ../libguestfs-1.11.20/df/virt-df.pod:129
2997 #: ../df/virt-df.pod:131 ../libguestfs-1.11.20/df/virt-df.pod:131
2998 msgid "Print inodes instead of blocks."
3002 #: ../df/virt-df.pod:133 ../libguestfs-1.11.20/df/virt-df.pod:133
3003 msgid "B<--one-per-guest>"
3007 #: ../df/virt-df.pod:135 ../libguestfs-1.11.20/df/virt-df.pod:135
3009 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
3010 "disks from several guests to a single libguestfs appliance."
3014 #: ../df/virt-df.pod:138 ../libguestfs-1.11.20/df/virt-df.pod:138
3015 msgid "You might use this option in the following circumstances:"
3019 #: ../df/virt-df.pod:142 ../df/virt-df.pod:148 ../edit/virt-edit.pod:266
3020 #: ../edit/virt-edit.pod:271 ../edit/virt-edit.pod:276
3021 #: ../edit/virt-edit.pod:287 ../edit/virt-edit.pod:291
3022 #: ../examples/guestfs-recipes.pod:98 ../examples/guestfs-recipes.pod:102
3023 #: ../examples/guestfs-recipes.pod:106 ../examples/guestfs-recipes.pod:132
3024 #: ../examples/guestfs-recipes.pod:137 ../examples/guestfs-recipes.pod:227
3025 #: ../examples/guestfs-recipes.pod:231 ../examples/guestfs-recipes.pod:235
3026 #: ../examples/guestfs-recipes.pod:239 ../examples/guestfs-recipes.pod:243
3027 #: ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20
3028 #: ../fish/guestfish-actions.pod:385 ../fish/guestfish-actions.pod:393
3029 #: ../fish/guestfish-actions.pod:400 ../fish/guestfish-actions.pod:407
3030 #: ../fish/guestfish-actions.pod:1099 ../fish/guestfish-actions.pod:1103
3031 #: ../fish/guestfish-actions.pod:1107 ../fish/guestfish-actions.pod:1111
3032 #: ../fish/guestfish-actions.pod:1119 ../fish/guestfish-actions.pod:1123
3033 #: ../fish/guestfish-actions.pod:1127 ../fish/guestfish-actions.pod:1137
3034 #: ../fish/guestfish-actions.pod:1141 ../fish/guestfish-actions.pod:1145
3035 #: ../fish/guestfish-actions.pod:1235 ../fish/guestfish-actions.pod:1239
3036 #: ../fish/guestfish-actions.pod:1244 ../fish/guestfish-actions.pod:1249
3037 #: ../fish/guestfish-actions.pod:1291 ../fish/guestfish-actions.pod:1295
3038 #: ../fish/guestfish-actions.pod:1300 ../fish/guestfish-actions.pod:1933
3039 #: ../fish/guestfish-actions.pod:1939 ../fish/guestfish-actions.pod:1947
3040 #: ../fish/guestfish-actions.pod:1954 ../fish/guestfish-actions.pod:1961
3041 #: ../fish/guestfish.pod:445 ../fish/guestfish.pod:449
3042 #: ../fish/guestfish.pod:453 ../fish/guestfish.pod:457
3043 #: ../inspector/virt-inspector.pod:384 ../inspector/virt-inspector.pod:388
3044 #: ../libguestfs-1.11.20/df/virt-df.pod:142
3045 #: ../libguestfs-1.11.20/df/virt-df.pod:148
3046 #: ../libguestfs-1.11.20/edit/virt-edit.pod:266
3047 #: ../libguestfs-1.11.20/edit/virt-edit.pod:271
3048 #: ../libguestfs-1.11.20/edit/virt-edit.pod:276
3049 #: ../libguestfs-1.11.20/edit/virt-edit.pod:287
3050 #: ../libguestfs-1.11.20/edit/virt-edit.pod:291
3051 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:98
3052 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:102
3053 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:106
3054 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:132
3055 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:137
3056 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:227
3057 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:231
3058 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:235
3059 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:239
3060 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:243
3061 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:13
3062 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:20
3063 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:385
3064 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:393
3065 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:400
3066 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:407
3067 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1099
3068 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1103
3069 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1107
3070 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1111
3071 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1119
3072 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1123
3073 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1127
3074 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1137
3075 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1141
3076 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1145
3077 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1235
3078 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1239
3079 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1244
3080 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1249
3081 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1291
3082 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1295
3083 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1300
3084 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1933
3085 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1939
3086 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1947
3087 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1954
3088 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1961
3089 #: ../libguestfs-1.11.20/fish/guestfish.pod:445
3090 #: ../libguestfs-1.11.20/fish/guestfish.pod:449
3091 #: ../libguestfs-1.11.20/fish/guestfish.pod:453
3092 #: ../libguestfs-1.11.20/fish/guestfish.pod:457
3093 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:384
3094 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:388
3095 #: ../libguestfs-1.11.20/resize/virt-resize.pod:282
3096 #: ../libguestfs-1.11.20/resize/virt-resize.pod:286
3097 #: ../libguestfs-1.11.20/resize/virt-resize.pod:295
3098 #: ../libguestfs-1.11.20/resize/virt-resize.pod:301
3099 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:15
3100 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:22
3101 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:583
3102 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:591
3103 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:598
3104 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:605
3105 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1662
3106 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1666
3107 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1670
3108 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1674
3109 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1682
3110 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1686
3111 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1690
3112 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1700
3113 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1704
3114 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1708
3115 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1846
3116 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1850
3117 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1855
3118 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1860
3119 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1921
3120 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1925
3121 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1930
3122 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2859
3123 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2865
3124 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2873
3125 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2880
3126 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2887
3127 #: ../libguestfs-1.11.20/src/guestfs.pod:388
3128 #: ../libguestfs-1.11.20/src/guestfs.pod:393
3129 #: ../libguestfs-1.11.20/src/guestfs.pod:398
3130 #: ../libguestfs-1.11.20/src/guestfs.pod:402
3131 #: ../libguestfs-1.11.20/src/guestfs.pod:407
3132 #: ../libguestfs-1.11.20/src/guestfs.pod:411
3133 #: ../libguestfs-1.11.20/src/guestfs.pod:416
3134 #: ../libguestfs-1.11.20/src/guestfs.pod:421
3135 #: ../libguestfs-1.11.20/src/guestfs.pod:1064
3136 #: ../libguestfs-1.11.20/src/guestfs.pod:1068
3137 #: ../libguestfs-1.11.20/src/guestfs.pod:1072
3138 #: ../libguestfs-1.11.20/src/guestfs.pod:1077
3139 #: ../libguestfs-1.11.20/src/guestfs.pod:1085
3140 #: ../libguestfs-1.11.20/src/guestfs.pod:1104
3141 #: ../libguestfs-1.11.20/src/guestfs.pod:1112
3142 #: ../libguestfs-1.11.20/src/guestfs.pod:1134
3143 #: ../libguestfs-1.11.20/src/guestfs.pod:1138
3144 #: ../libguestfs-1.11.20/src/guestfs.pod:1142
3145 #: ../libguestfs-1.11.20/src/guestfs.pod:1146
3146 #: ../libguestfs-1.11.20/src/guestfs.pod:1150
3147 #: ../libguestfs-1.11.20/src/guestfs.pod:1154
3148 #: ../libguestfs-1.11.20/src/guestfs.pod:1643
3149 #: ../libguestfs-1.11.20/src/guestfs.pod:1648
3150 #: ../libguestfs-1.11.20/src/guestfs.pod:1652
3151 #: ../libguestfs-1.11.20/src/guestfs.pod:1754
3152 #: ../libguestfs-1.11.20/src/guestfs.pod:1759
3153 #: ../libguestfs-1.11.20/src/guestfs.pod:1763
3154 #: ../libguestfs-1.11.20/src/guestfs.pod:1773
3155 #: ../libguestfs-1.11.20/src/guestfs.pod:2047
3156 #: ../libguestfs-1.11.20/src/guestfs.pod:2052
3157 #: ../libguestfs-1.11.20/src/guestfs.pod:2058
3158 #: ../libguestfs-1.11.20/src/guestfs.pod:2066
3159 #: ../libguestfs-1.11.20/src/guestfs.pod:2420
3160 #: ../libguestfs-1.11.20/src/guestfs.pod:2426
3161 #: ../libguestfs-1.11.20/src/guestfs.pod:2431
3162 #: ../libguestfs-1.11.20/src/guestfs.pod:2437
3163 #: ../libguestfs-1.11.20/src/guestfs.pod:2818
3164 #: ../libguestfs-1.11.20/src/guestfs.pod:2822
3165 #: ../libguestfs-1.11.20/src/guestfs.pod:2826
3166 #: ../libguestfs-1.11.20/src/guestfs.pod:2830
3167 #: ../libguestfs-1.11.20/src/guestfs.pod:2844
3168 #: ../libguestfs-1.11.20/src/guestfs.pod:2849
3169 #: ../libguestfs-1.11.20/src/guestfs.pod:3063
3170 #: ../libguestfs-1.11.20/src/guestfs.pod:3067
3171 #: ../libguestfs-1.11.20/src/guestfs.pod:3071
3172 #: ../libguestfs-1.11.20/src/guestfs.pod:3075 ../resize/virt-resize.pod:282
3173 #: ../resize/virt-resize.pod:286 ../resize/virt-resize.pod:295
3174 #: ../resize/virt-resize.pod:301 ../src/guestfs-actions.pod:15
3175 #: ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:583
3176 #: ../src/guestfs-actions.pod:591 ../src/guestfs-actions.pod:598
3177 #: ../src/guestfs-actions.pod:605 ../src/guestfs-actions.pod:1662
3178 #: ../src/guestfs-actions.pod:1666 ../src/guestfs-actions.pod:1670
3179 #: ../src/guestfs-actions.pod:1674 ../src/guestfs-actions.pod:1682
3180 #: ../src/guestfs-actions.pod:1686 ../src/guestfs-actions.pod:1690
3181 #: ../src/guestfs-actions.pod:1700 ../src/guestfs-actions.pod:1704
3182 #: ../src/guestfs-actions.pod:1708 ../src/guestfs-actions.pod:1846
3183 #: ../src/guestfs-actions.pod:1850 ../src/guestfs-actions.pod:1855
3184 #: ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1921
3185 #: ../src/guestfs-actions.pod:1925 ../src/guestfs-actions.pod:1930
3186 #: ../src/guestfs-actions.pod:2859 ../src/guestfs-actions.pod:2865
3187 #: ../src/guestfs-actions.pod:2873 ../src/guestfs-actions.pod:2880
3188 #: ../src/guestfs-actions.pod:2887 ../src/guestfs.pod:388
3189 #: ../src/guestfs.pod:393 ../src/guestfs.pod:398 ../src/guestfs.pod:402
3190 #: ../src/guestfs.pod:407 ../src/guestfs.pod:411 ../src/guestfs.pod:416
3191 #: ../src/guestfs.pod:421 ../src/guestfs.pod:1064 ../src/guestfs.pod:1068
3192 #: ../src/guestfs.pod:1072 ../src/guestfs.pod:1077 ../src/guestfs.pod:1085
3193 #: ../src/guestfs.pod:1104 ../src/guestfs.pod:1112 ../src/guestfs.pod:1134
3194 #: ../src/guestfs.pod:1138 ../src/guestfs.pod:1142 ../src/guestfs.pod:1146
3195 #: ../src/guestfs.pod:1150 ../src/guestfs.pod:1154 ../src/guestfs.pod:1643
3196 #: ../src/guestfs.pod:1648 ../src/guestfs.pod:1652 ../src/guestfs.pod:1754
3197 #: ../src/guestfs.pod:1759 ../src/guestfs.pod:1763 ../src/guestfs.pod:1773
3198 #: ../src/guestfs.pod:2047 ../src/guestfs.pod:2052 ../src/guestfs.pod:2058
3199 #: ../src/guestfs.pod:2066 ../src/guestfs.pod:2420 ../src/guestfs.pod:2426
3200 #: ../src/guestfs.pod:2431 ../src/guestfs.pod:2437 ../src/guestfs.pod:2818
3201 #: ../src/guestfs.pod:2822 ../src/guestfs.pod:2826 ../src/guestfs.pod:2830
3202 #: ../src/guestfs.pod:2844 ../src/guestfs.pod:2849 ../src/guestfs.pod:3063
3203 #: ../src/guestfs.pod:3067 ../src/guestfs.pod:3071 ../src/guestfs.pod:3075
3204 #: ../tools/virt-win-reg.pl:197 ../tools/virt-win-reg.pl:202
3205 #: ../tools/virt-win-reg.pl:208 ../tools/virt-win-reg.pl:710
3206 #: ../tools/virt-win-reg.pl:716 ../tools/virt-win-reg.pl:722
3211 #: ../df/virt-df.pod:144 ../libguestfs-1.11.20/df/virt-df.pod:144
3213 "If you think an untrusted guest might actively try to exploit the libguestfs "
3214 "appliance kernel, then this prevents one guest from interfering with the "
3215 "stats printed for another guest."
3219 #: ../df/virt-df.pod:150 ../libguestfs-1.11.20/df/virt-df.pod:150
3221 "If the kernel has a bug which stops it from accessing a filesystem in one "
3222 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
3223 "and report stats for further guests."
3227 #: ../df/virt-df.pod:159 ../libguestfs-1.11.20/df/virt-df.pod:159
3229 "Print UUIDs instead of names. This is useful for following a guest even "
3230 "when the guest is migrated or renamed, or when two guests happen to have the "
3235 #: ../df/virt-df.pod:163 ../libguestfs-1.11.20/df/virt-df.pod:163
3237 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
3238 "images, we still print the disk image name even when this option is "
3243 #: ../df/virt-df.pod:218 ../libguestfs-1.11.20/df/virt-df.pod:218
3245 "L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<http://"
3250 #: ../edit/virt-edit.pod:5 ../libguestfs-1.11.20/edit/virt-edit.pod:5
3251 msgid "virt-edit - Edit a file in a virtual machine"
3255 #: ../edit/virt-edit.pod:9 ../libguestfs-1.11.20/edit/virt-edit.pod:9
3258 " virt-edit [--options] -d domname file [file ...]\n"
3263 #: ../edit/virt-edit.pod:11 ../libguestfs-1.11.20/edit/virt-edit.pod:11
3266 " virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
3271 #: ../edit/virt-edit.pod:13 ../libguestfs-1.11.20/edit/virt-edit.pod:13
3274 " virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
3279 #: ../edit/virt-edit.pod:17 ../libguestfs-1.11.20/edit/virt-edit.pod:17
3282 " virt-edit domname file\n"
3287 #: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
3288 #: ../libguestfs-1.11.20/edit/virt-edit.pod:19
3289 #: ../libguestfs-1.11.20/edit/virt-edit.pod:183
3292 " virt-edit disk.img [disk.img ...] file\n"
3297 #: ../edit/virt-edit.pod:21 ../fish/guestfish.pod:23
3298 #: ../fish/virt-copy-in.pod:13 ../fish/virt-tar-in.pod:15
3299 #: ../fuse/guestmount.pod:15 ../libguestfs-1.11.20/edit/virt-edit.pod:21
3300 #: ../libguestfs-1.11.20/fish/guestfish.pod:23
3301 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:13
3302 #: ../libguestfs-1.11.20/fish/virt-tar-in.pod:15
3303 #: ../libguestfs-1.11.20/fuse/guestmount.pod:15
3304 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:19
3305 #: ../rescue/virt-rescue.pod:19 ../tools/virt-tar.pl:64
3306 #: ../tools/virt-win-reg.pl:51
3311 #: ../edit/virt-edit.pod:23 ../libguestfs-1.11.20/edit/virt-edit.pod:23
3313 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
3314 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
3315 "doing this, but doesn't catch all cases."
3319 #: ../edit/virt-edit.pod:29 ../libguestfs-1.11.20/edit/virt-edit.pod:29
3321 "C<virt-edit> is a command line tool to edit C<file> where each C<file> "
3322 "exists in the named virtual machine (or disk image)."
3326 #: ../edit/virt-edit.pod:32 ../libguestfs-1.11.20/edit/virt-edit.pod:32
3328 "Multiple filenames can be given, in which case they are each edited in "
3329 "turn. Each filename must be a full path, starting at the root directory "
3330 "(starting with '/')."
3334 #: ../edit/virt-edit.pod:36 ../libguestfs-1.11.20/edit/virt-edit.pod:36
3335 msgid "If you want to just view a file, use L<virt-cat(1)>."
3339 #: ../edit/virt-edit.pod:38 ../libguestfs-1.11.20/edit/virt-edit.pod:38
3341 "For more complex cases you should look at the L<guestfish(1)> tool (see L</"
3342 "USING GUESTFISH> below)."
3346 #: ../edit/virt-edit.pod:41 ../libguestfs-1.11.20/edit/virt-edit.pod:41
3348 "C<virt-edit> cannot be used to create a new file. L<guestfish(1)> can do "
3349 "that and much more."
3353 #: ../edit/virt-edit.pod:46 ../libguestfs-1.11.20/edit/virt-edit.pod:46
3354 msgid "Edit the named files interactively:"
3358 #: ../edit/virt-edit.pod:48 ../libguestfs-1.11.20/edit/virt-edit.pod:48
3361 " virt-edit -d mydomain /boot/grub/grub.conf\n"
3366 #: ../edit/virt-edit.pod:50 ../libguestfs-1.11.20/edit/virt-edit.pod:50
3369 " virt-edit -d mydomain /etc/passwd\n"
3374 #: ../edit/virt-edit.pod:52 ../libguestfs-1.11.20/edit/virt-edit.pod:52
3375 msgid "For Windows guests, some Windows paths are understood:"
3379 #: ../edit/virt-edit.pod:54 ../libguestfs-1.11.20/edit/virt-edit.pod:54
3382 " virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
3387 #: ../edit/virt-edit.pod:56 ../libguestfs-1.11.20/edit/virt-edit.pod:56
3389 "If Perl is installed, you can also edit files non-interactively (see L</NON-"
3390 "INTERACTIVE EDITING> below). To change the init default level to 5:"
3394 #: ../edit/virt-edit.pod:60 ../libguestfs-1.11.20/edit/virt-edit.pod:60
3397 " virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
3402 #: ../edit/virt-edit.pod:81 ../libguestfs-1.11.20/edit/virt-edit.pod:81
3403 msgid "B<-b> extension"
3407 #: ../edit/virt-edit.pod:83 ../libguestfs-1.11.20/edit/virt-edit.pod:83
3408 msgid "B<--backup> extension"
3412 #: ../edit/virt-edit.pod:85 ../libguestfs-1.11.20/edit/virt-edit.pod:85
3414 "Create a backup of the original file I<in the guest disk image>. The backup "
3415 "has the original filename with C<extension> added."
3419 #: ../edit/virt-edit.pod:88 ../libguestfs-1.11.20/edit/virt-edit.pod:88
3421 "Usually the first character of C<extension> would be a dot C<.> so you would "
3426 #: ../edit/virt-edit.pod:91 ../libguestfs-1.11.20/edit/virt-edit.pod:91
3429 " virt-edit -b .orig [etc]\n"
3434 #: ../edit/virt-edit.pod:93 ../libguestfs-1.11.20/edit/virt-edit.pod:93
3435 msgid "By default, no backup file is made."
3439 #: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181
3440 #: ../fuse/guestmount.pod:96 ../inspector/virt-inspector.pod:74
3441 #: ../libguestfs-1.11.20/edit/virt-edit.pod:95
3442 #: ../libguestfs-1.11.20/fish/guestfish.pod:181
3443 #: ../libguestfs-1.11.20/fuse/guestmount.pod:96
3444 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:74
3445 #: ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78
3446 #: ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
3451 #: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183
3452 #: ../fuse/guestmount.pod:98 ../inspector/virt-inspector.pod:76
3453 #: ../libguestfs-1.11.20/edit/virt-edit.pod:97
3454 #: ../libguestfs-1.11.20/fish/guestfish.pod:183
3455 #: ../libguestfs-1.11.20/fuse/guestmount.pod:98
3456 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:76
3457 #: ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80
3458 #: ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
3459 msgid "B<--connect URI>"
3463 #: ../edit/virt-edit.pod:102 ../libguestfs-1.11.20/edit/virt-edit.pod:102
3464 #: ../tools/virt-list-filesystems.pl:84 ../tools/virt-list-partitions.pl:85
3465 #: ../tools/virt-tar.pl:134 ../tools/virt-win-reg.pl:135
3467 "If you specify guest block devices directly, then libvirt is not used at all."
3471 #: ../edit/virt-edit.pod:114 ../libguestfs-1.11.20/edit/virt-edit.pod:114
3473 "When prompting for keys and passphrases, virt-edit normally turns echoing "
3474 "off so you cannot see what you are typing. If you are not worried about "
3475 "Tempest attacks and there is no one else in the room you can specify this "
3476 "flag to see what you are typing."
3480 #: ../edit/virt-edit.pod:119 ../libguestfs-1.11.20/edit/virt-edit.pod:119
3485 #: ../edit/virt-edit.pod:121 ../libguestfs-1.11.20/edit/virt-edit.pod:121
3486 msgid "B<--expr> EXPR"
3490 #: ../edit/virt-edit.pod:123 ../libguestfs-1.11.20/edit/virt-edit.pod:123
3492 "Instead of launching the external editor, non-interactively apply the Perl "
3493 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
3498 #: ../edit/virt-edit.pod:127 ../libguestfs-1.11.20/edit/virt-edit.pod:127
3500 "Be careful to properly quote the expression to prevent it from being altered "
3505 #: ../edit/virt-edit.pod:130 ../libguestfs-1.11.20/edit/virt-edit.pod:130
3506 msgid "Note that this option is only available when Perl 5 is installed."
3510 #: ../edit/virt-edit.pod:132 ../libguestfs-1.11.20/edit/virt-edit.pod:132
3511 msgid "B<--format> raw|qcow2|..."
3515 #: ../edit/virt-edit.pod:143 ../libguestfs-1.11.20/edit/virt-edit.pod:143
3518 " virt-edit --format=raw -a disk.img file\n"
3523 #: ../edit/virt-edit.pod:147 ../libguestfs-1.11.20/edit/virt-edit.pod:147
3526 " virt-edit --format=raw -a disk.img --format -a another.img file\n"
3531 #: ../edit/virt-edit.pod:181 ../libguestfs-1.11.20/edit/virt-edit.pod:181
3532 msgid "Previous versions of virt-edit allowed you to write either:"
3536 #: ../edit/virt-edit.pod:187 ../libguestfs-1.11.20/edit/virt-edit.pod:187
3539 " virt-edit guestname file\n"
3544 #: ../edit/virt-edit.pod:195 ../libguestfs-1.11.20/edit/virt-edit.pod:195
3545 msgid "NON-INTERACTIVE EDITING"
3549 #: ../edit/virt-edit.pod:197 ../libguestfs-1.11.20/edit/virt-edit.pod:197
3551 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
3552 "administrator can interactively edit the file."
3556 #: ../edit/virt-edit.pod:200 ../libguestfs-1.11.20/edit/virt-edit.pod:200
3558 "There are two ways also to use C<virt-edit> from scripts in order to make "
3559 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
3560 "like this, it's less error-prone to write scripts directly using the "
3561 "libguestfs API and Augeas for configuration file editing.)"
3565 #: ../edit/virt-edit.pod:206 ../libguestfs-1.11.20/edit/virt-edit.pod:206
3567 "The first method is to temporarily set C<$EDITOR> to any script or program "
3568 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
3569 "update C<tmpfile> in place however it likes."
3573 #: ../edit/virt-edit.pod:210 ../libguestfs-1.11.20/edit/virt-edit.pod:210
3575 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
3576 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
3577 "instances of C<foo> with C<bar> in a file:"
3581 #: ../edit/virt-edit.pod:214 ../libguestfs-1.11.20/edit/virt-edit.pod:214
3584 " virt-edit -d domname filename -e 's/foo/bar/'\n"
3589 #: ../edit/virt-edit.pod:216 ../libguestfs-1.11.20/edit/virt-edit.pod:216
3591 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
3592 "For example to delete root's password you could do:"
3596 #: ../edit/virt-edit.pod:219 ../libguestfs-1.11.20/edit/virt-edit.pod:219
3599 " virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
3604 #: ../edit/virt-edit.pod:221 ../libguestfs-1.11.20/edit/virt-edit.pod:221
3606 "What really happens is that the snippet is evaluated as a Perl expression "
3607 "for each line of the file. The line, including the final C<\\n>, is passed "
3608 "in C<$_> and the expression should update C<$_> or leave it unchanged."
3612 #: ../edit/virt-edit.pod:226 ../libguestfs-1.11.20/edit/virt-edit.pod:226
3614 "To delete a line, set C<$_> to the empty string. For example, to delete the "
3615 "C<apache> user account from the password file you can do:"
3619 #: ../edit/virt-edit.pod:229 ../libguestfs-1.11.20/edit/virt-edit.pod:229
3622 " virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
3627 #: ../edit/virt-edit.pod:231 ../libguestfs-1.11.20/edit/virt-edit.pod:231
3629 "To insert a line, prepend or append it to C<$_>. However appending lines to "
3630 "the end of the file is rather difficult this way since there is no concept "
3631 "of \"last line of the file\" - your expression just doesn't get called "
3632 "again. You might want to use the first method (setting C<$EDITOR>) if you "
3637 #: ../edit/virt-edit.pod:237 ../libguestfs-1.11.20/edit/virt-edit.pod:237
3639 "The variable C<$lineno> contains the current line number. As is "
3640 "traditional, the first line in the file is number C<1>."
3644 #: ../edit/virt-edit.pod:240 ../libguestfs-1.11.20/edit/virt-edit.pod:240
3646 "The return value from the expression is ignored, but the expression may call "
3647 "C<die> in order to abort the whole program, leaving the original file "
3652 #: ../edit/virt-edit.pod:244 ../libguestfs-1.11.20/edit/virt-edit.pod:244
3654 "Remember when matching the end of a line that C<$_> may contain the final C<"
3655 "\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
3656 "newline then neither of these. Thus to match or substitute some text at the "
3657 "end of a line, use this regular expression:"
3661 #: ../edit/virt-edit.pod:249 ../libguestfs-1.11.20/edit/virt-edit.pod:249
3664 " /some text(\\r?\\n)?$/\n"
3669 #: ../edit/virt-edit.pod:251 ../libguestfs-1.11.20/edit/virt-edit.pod:251
3671 "Alternately, use the perl C<chomp> function, being careful not to chomp C<"
3672 "$_> itself (since that would remove all newlines from the file):"
3676 #: ../edit/virt-edit.pod:255 ../libguestfs-1.11.20/edit/virt-edit.pod:255
3679 " my $m = $_; chomp $m; $m =~ /some text$/\n"
3684 #: ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
3685 #: ../libguestfs-1.11.20/edit/virt-edit.pod:257
3686 #: ../libguestfs-1.11.20/fish/guestfish.pod:858
3687 msgid "WINDOWS PATHS"
3691 #: ../edit/virt-edit.pod:259 ../libguestfs-1.11.20/edit/virt-edit.pod:259
3693 "C<virt-edit> has a limited ability to understand Windows drive letters and "
3694 "paths (eg. C<E:\\foo\\bar.txt>)."
3698 #: ../edit/virt-edit.pod:262 ../libguestfs-1.11.20/edit/virt-edit.pod:262
3699 msgid "If and only if the guest is running Windows then:"
3703 #: ../edit/virt-edit.pod:268 ../libguestfs-1.11.20/edit/virt-edit.pod:268
3705 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
3706 "to the correct filesystem."
3710 #: ../edit/virt-edit.pod:273 ../libguestfs-1.11.20/edit/virt-edit.pod:273
3712 "Any backslash (C<\\>) characters in the path are replaced with forward "
3713 "slashes so that libguestfs can process it."
3717 #: ../edit/virt-edit.pod:278 ../libguestfs-1.11.20/edit/virt-edit.pod:278
3719 "The path is resolved case insensitively to locate the file that should be "
3724 #: ../edit/virt-edit.pod:283 ../libguestfs-1.11.20/edit/virt-edit.pod:283
3725 msgid "There are some known shortcomings:"
3729 #: ../edit/virt-edit.pod:289 ../libguestfs-1.11.20/edit/virt-edit.pod:289
3730 msgid "Some NTFS symbolic links may not be followed correctly."
3734 #: ../edit/virt-edit.pod:293 ../libguestfs-1.11.20/edit/virt-edit.pod:293
3735 msgid "NTFS junction points that cross filesystems are not followed."
3739 #: ../edit/virt-edit.pod:299 ../libguestfs-1.11.20/edit/virt-edit.pod:299
3741 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
3742 "C<virt-edit> doesn't work."
3746 #: ../edit/virt-edit.pod:302 ../libguestfs-1.11.20/edit/virt-edit.pod:302
3747 msgid "Using C<virt-edit> is approximately equivalent to doing:"
3751 #: ../edit/virt-edit.pod:304 ../libguestfs-1.11.20/edit/virt-edit.pod:304
3754 " guestfish --rw -i -d domname edit /file\n"
3759 #: ../edit/virt-edit.pod:306 ../libguestfs-1.11.20/edit/virt-edit.pod:306
3761 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
3766 #: ../edit/virt-edit.pod:309 ../libguestfs-1.11.20/edit/virt-edit.pod:309
3768 "The command above uses libguestfs's guest inspection feature and so does not "
3769 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
3770 "disk images that don't contain guests. To edit a file on a disk image "
3775 #: ../edit/virt-edit.pod:314 ../libguestfs-1.11.20/edit/virt-edit.pod:314
3778 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
3783 #: ../edit/virt-edit.pod:316 ../libguestfs-1.11.20/edit/virt-edit.pod:316
3785 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
3786 "the disk image to edit, and C</file> is the full path to the file."
3790 #: ../edit/virt-edit.pod:320 ../libguestfs-1.11.20/edit/virt-edit.pod:320
3792 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
3793 "C<write> or C<upload> instead:"
3797 #: ../edit/virt-edit.pod:323 ../libguestfs-1.11.20/edit/virt-edit.pod:323
3800 " guestfish --rw -i -d domname touch /newfile\n"
3805 #: ../edit/virt-edit.pod:325 ../libguestfs-1.11.20/edit/virt-edit.pod:325
3808 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
3813 #: ../edit/virt-edit.pod:327 ../libguestfs-1.11.20/edit/virt-edit.pod:327
3816 " guestfish --rw -i -d domname upload localfile /newfile\n"
3821 #: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1075
3822 #: ../libguestfs-1.11.20/edit/virt-edit.pod:329
3823 #: ../libguestfs-1.11.20/fish/guestfish.pod:1075
3824 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:257
3825 #: ../libguestfs-1.11.20/src/guestfs.pod:2960
3826 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:82
3827 #: ../rescue/virt-rescue.pod:257 ../src/guestfs.pod:2960
3828 #: ../test-tool/libguestfs-test-tool.pod:82
3829 msgid "ENVIRONMENT VARIABLES"
3833 #: ../edit/virt-edit.pod:333 ../libguestfs-1.11.20/edit/virt-edit.pod:333
3838 #: ../edit/virt-edit.pod:335 ../libguestfs-1.11.20/edit/virt-edit.pod:335
3840 "If set, this string is used as the editor. It may contain arguments, eg. C<"
3845 #: ../edit/virt-edit.pod:338 ../libguestfs-1.11.20/edit/virt-edit.pod:338
3846 msgid "If not set, C<vi> is used."
3850 #: ../edit/virt-edit.pod:351 ../libguestfs-1.11.20/edit/virt-edit.pod:351
3852 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-"
3853 "tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, "
3854 "L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
3858 #: ../examples/guestfs-examples.pod:5
3859 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:5
3860 msgid "guestfs-examples - Examples of using libguestfs from C"
3864 #: ../examples/guestfs-examples.pod:9
3865 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:9
3866 #: ../libguestfs-1.11.20/src/guestfs.pod:9 ../src/guestfs.pod:9
3869 " #include <guestfs.h>\n"
3874 #: ../examples/guestfs-examples.pod:11
3875 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:11
3878 " guestfs_h *g = guestfs_create ();\n"
3879 " guestfs_add_drive_ro (g, \"disk.img\");\n"
3880 " guestfs_launch (g);\n"
3885 #: ../examples/guestfs-examples.pod:15
3886 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:15
3887 #: ../libguestfs-1.11.20/src/guestfs.pod:19 ../src/guestfs.pod:19
3890 " cc prog.c -o prog -lguestfs\n"
3892 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
3897 #: ../examples/guestfs-examples.pod:21
3898 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:21
3900 "This manual page contains examples of calling libguestfs from the C "
3901 "programming language. If you are not familiar with using libguestfs, you "
3902 "also need to read L<guestfs(3)>."
3906 #: ../examples/guestfs-examples.pod:25 ../java/examples/guestfs-java.pod:37
3907 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:25
3908 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:37
3909 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:70
3910 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:31
3911 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:34
3912 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:28
3913 #: ../ocaml/examples/guestfs-ocaml.pod:70 ../perl/examples/guestfs-perl.pod:31
3914 #: ../python/examples/guestfs-python.pod:34
3915 #: ../ruby/examples/guestfs-ruby.pod:28
3916 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
3920 #: ../examples/guestfs-examples.pod:27 ../java/examples/guestfs-java.pod:39
3921 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:27
3922 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:39
3923 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:72
3924 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:33
3925 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:36
3926 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:30
3927 #: ../ocaml/examples/guestfs-ocaml.pod:72 ../perl/examples/guestfs-perl.pod:33
3928 #: ../python/examples/guestfs-python.pod:36
3929 #: ../ruby/examples/guestfs-ruby.pod:30
3934 #: ../examples/guestfs-examples.pod:29 ../java/examples/guestfs-java.pod:41
3935 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:29
3936 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:41
3937 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:74
3938 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:35
3939 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:38
3940 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:32
3941 #: ../ocaml/examples/guestfs-ocaml.pod:74 ../perl/examples/guestfs-perl.pod:35
3942 #: ../python/examples/guestfs-python.pod:38
3943 #: ../ruby/examples/guestfs-ruby.pod:32
3944 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
3948 #: ../examples/guestfs-examples.pod:31 ../java/examples/guestfs-java.pod:43
3949 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:31
3950 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:43
3951 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:76
3952 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:37
3953 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:40
3954 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:34
3955 #: ../ocaml/examples/guestfs-ocaml.pod:76 ../perl/examples/guestfs-perl.pod:37
3956 #: ../python/examples/guestfs-python.pod:40
3957 #: ../ruby/examples/guestfs-ruby.pod:34
3962 #: ../examples/guestfs-examples.pod:35
3963 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:35
3965 "L<guestfs(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
3966 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
3971 #: ../examples/guestfs-examples.pod:44 ../examples/guestfs-recipes.pod:396
3972 #: ../fish/guestfish.pod:1238 ../fish/virt-copy-in.pod:60
3973 #: ../fish/virt-copy-out.pod:49 ../fish/virt-tar-in.pod:58
3974 #: ../fish/virt-tar-out.pod:51 ../fuse/guestmount.pod:314
3975 #: ../inspector/virt-inspector.pod:380 ../java/examples/guestfs-java.pod:57
3976 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:44
3977 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:396
3978 #: ../libguestfs-1.11.20/fish/guestfish.pod:1238
3979 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:60
3980 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:49
3981 #: ../libguestfs-1.11.20/fish/virt-tar-in.pod:58
3982 #: ../libguestfs-1.11.20/fish/virt-tar-out.pod:51
3983 #: ../libguestfs-1.11.20/fuse/guestmount.pod:314
3984 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:380
3985 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:57
3986 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:90
3987 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:51
3988 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:53
3989 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:47
3990 #: ../libguestfs-1.11.20/src/guestfs.pod:3082
3991 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:93
3992 #: ../ocaml/examples/guestfs-ocaml.pod:90 ../perl/examples/guestfs-perl.pod:51
3993 #: ../python/examples/guestfs-python.pod:53
3994 #: ../ruby/examples/guestfs-ruby.pod:47 ../src/guestfs.pod:3082
3995 #: ../test-tool/libguestfs-test-tool.pod:93
4000 #: ../examples/guestfs-examples.pod:46 ../examples/guestfs-recipes.pod:398
4001 #: ../fish/guestfish.pod:1240 ../fish/virt-copy-in.pod:62
4002 #: ../fish/virt-copy-out.pod:51 ../fish/virt-tar-in.pod:60
4003 #: ../fish/virt-tar-out.pod:53 ../fuse/guestmount.pod:316
4004 #: ../java/examples/guestfs-java.pod:59
4005 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:46
4006 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:398
4007 #: ../libguestfs-1.11.20/fish/guestfish.pod:1240
4008 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:62
4009 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:51
4010 #: ../libguestfs-1.11.20/fish/virt-tar-in.pod:60
4011 #: ../libguestfs-1.11.20/fish/virt-tar-out.pod:53
4012 #: ../libguestfs-1.11.20/fuse/guestmount.pod:316
4013 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:59
4014 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:92
4015 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:53
4016 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:55
4017 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:49
4018 #: ../libguestfs-1.11.20/src/guestfs.pod:3084
4019 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:95
4020 #: ../ocaml/examples/guestfs-ocaml.pod:92 ../perl/examples/guestfs-perl.pod:53
4021 #: ../python/examples/guestfs-python.pod:55
4022 #: ../ruby/examples/guestfs-ruby.pod:49 ../src/guestfs.pod:3084
4023 #: ../test-tool/libguestfs-test-tool.pod:95
4024 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
4028 #: ../examples/guestfs-examples.pod:50
4029 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:50
4030 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:96
4031 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:59
4032 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:53
4033 #: ../ocaml/examples/guestfs-ocaml.pod:96
4034 #: ../python/examples/guestfs-python.pod:59
4035 #: ../ruby/examples/guestfs-ruby.pod:53
4036 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
4040 #: ../examples/guestfs-examples.pod:52 ../examples/guestfs-recipes.pod:404
4041 #: ../java/examples/guestfs-java.pod:65
4042 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:52
4043 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:404
4044 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:65
4045 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:98
4046 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:59
4047 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:61
4048 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:55
4049 #: ../ocaml/examples/guestfs-ocaml.pod:98 ../perl/examples/guestfs-perl.pod:59
4050 #: ../python/examples/guestfs-python.pod:61
4051 #: ../ruby/examples/guestfs-ruby.pod:55
4053 "The examples in this manual page may be freely copied, modified and "
4054 "distributed without any restrictions."
4058 #: ../examples/guestfs-examples.pod:55 ../examples/guestfs-recipes.pod:407
4059 #: ../java/examples/guestfs-java.pod:68
4060 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:55
4061 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:407
4062 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:68
4063 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:101
4064 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:62
4065 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:64
4066 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:58
4067 #: ../libguestfs-1.11.20/src/guestfs.pod:3091
4068 #: ../ocaml/examples/guestfs-ocaml.pod:101
4069 #: ../perl/examples/guestfs-perl.pod:62
4070 #: ../python/examples/guestfs-python.pod:64
4071 #: ../ruby/examples/guestfs-ruby.pod:58 ../src/guestfs.pod:3091
4073 "This library is free software; you can redistribute it and/or modify it "
4074 "under the terms of the GNU Lesser General Public License as published by the "
4075 "Free Software Foundation; either version 2 of the License, or (at your "
4076 "option) any later version."
4080 #: ../examples/guestfs-examples.pod:60 ../examples/guestfs-recipes.pod:412
4081 #: ../java/examples/guestfs-java.pod:73
4082 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:60
4083 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:412
4084 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:73
4085 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:106
4086 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:67
4087 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:69
4088 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:63
4089 #: ../libguestfs-1.11.20/src/guestfs.pod:3096
4090 #: ../ocaml/examples/guestfs-ocaml.pod:106
4091 #: ../perl/examples/guestfs-perl.pod:67
4092 #: ../python/examples/guestfs-python.pod:69
4093 #: ../ruby/examples/guestfs-ruby.pod:63 ../src/guestfs.pod:3096
4095 "This library is distributed in the hope that it will be useful, but WITHOUT "
4096 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
4097 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
4102 #: ../examples/guestfs-examples.pod:65 ../examples/guestfs-recipes.pod:417
4103 #: ../java/examples/guestfs-java.pod:78
4104 #: ../libguestfs-1.11.20/examples/guestfs-examples.pod:65
4105 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:417
4106 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:78
4107 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:111
4108 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:72
4109 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:74
4110 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:68
4111 #: ../libguestfs-1.11.20/src/guestfs.pod:3101
4112 #: ../ocaml/examples/guestfs-ocaml.pod:111
4113 #: ../perl/examples/guestfs-perl.pod:72
4114 #: ../python/examples/guestfs-python.pod:74
4115 #: ../ruby/examples/guestfs-ruby.pod:68 ../src/guestfs.pod:3101
4117 "You should have received a copy of the GNU Lesser General Public License "
4118 "along with this library; if not, write to the Free Software Foundation, "
4119 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
4123 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
4124 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:3
4125 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:12
4130 #: ../examples/guestfs-recipes.pod:5
4131 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:5
4133 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
4134 "here. The only way which works for both sorts of output is to just write "
4135 "the URL directly. Do NOT use L<...> for URLs."
4139 #: ../examples/guestfs-recipes.pod:9
4140 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:9
4142 "We break with tradition here and don't use ALL CAPS for the section "
4143 "headings, as this makes them much easier to read."
4147 #: ../examples/guestfs-recipes.pod:16
4148 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:16
4149 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
4153 #: ../examples/guestfs-recipes.pod:20
4154 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:20
4156 "This page contains recipes for and links to things you can do using "
4157 "libguestfs, L<guestfish(1)> and the virt tools."
4161 #: ../examples/guestfs-recipes.pod:23
4162 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:23
4163 msgid "Audit a virtual machine for setuid files"
4167 #: ../examples/guestfs-recipes.pod:25
4168 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:25
4170 "The link below contains a small program which can be used to audit a Linux "
4171 "virtual machine to see what setuid and setgid files it contains."
4175 #: ../examples/guestfs-recipes.pod:28
4176 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:28
4178 "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-"
4183 #: ../examples/guestfs-recipes.pod:30
4184 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:30
4185 msgid "Change the background image in a Windows XP VM"
4189 #: ../examples/guestfs-recipes.pod:32
4190 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:32
4192 "The links below explain how to use L<guestfish(1)> to change the background "
4193 "image for a user of a Windows XP VM. Unfortunately the technique appears to "
4194 "be substantially different for each version of Windows."
4198 #: ../examples/guestfs-recipes.pod:37
4199 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:37
4201 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html https://"
4202 "lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
4206 #: ../examples/guestfs-recipes.pod:40
4207 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:40
4208 msgid "Cloning a virtual machine (Linux)"
4212 #: ../examples/guestfs-recipes.pod:42
4213 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:42
4215 "The guestfish technique described in the link below works well for most "
4216 "Linux VMs. Depending on the Linux distro you may need to change the paths "
4221 #: ../examples/guestfs-recipes.pod:46
4222 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:46
4224 "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-"
4229 #: ../examples/guestfs-recipes.pod:48
4230 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:48
4232 "Avoid L<virt-clone(1)>. Currently what to do about virt-clone is under "
4237 #: ../examples/guestfs-recipes.pod:51
4238 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:51
4239 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
4243 #: ../examples/guestfs-recipes.pod:53
4244 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:53
4245 msgid "Cloning a virtual machine (Windows)"
4249 #: ../examples/guestfs-recipes.pod:55
4250 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:55
4252 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
4253 "straightforward. Currently there is code in the Aeolus Oz project which "
4254 "does this (using libguestfs). As part of our review of the virt-clone tool, "
4255 "we may add sysprepping ability."
4259 #: ../examples/guestfs-recipes.pod:60
4260 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:60
4262 "https://github.com/clalancette/oz https://www.redhat.com/archives/virt-tools-"
4263 "list/2011-May/msg00019.html"
4267 #: ../examples/guestfs-recipes.pod:63
4268 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:63
4269 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
4273 #: ../examples/guestfs-recipes.pod:65
4274 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:65
4275 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
4279 #: ../examples/guestfs-recipes.pod:67
4280 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:67
4283 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
4288 #: ../examples/guestfs-recipes.pod:69
4289 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:69
4290 msgid "To export just a subdirectory, eg. C</files>, do:"
4294 #: ../examples/guestfs-recipes.pod:71
4295 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:71
4298 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
4303 #: ../examples/guestfs-recipes.pod:73
4304 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:73
4305 msgid "Create empty disk images"
4309 #: ../examples/guestfs-recipes.pod:75
4310 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:75
4312 "You can use the L<guestfish(1)> I<-N> option to create empty disk images. "
4313 "The useful guide below explains the options available."
4317 #: ../examples/guestfs-recipes.pod:78
4318 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:78
4320 "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/"
4325 #: ../examples/guestfs-recipes.pod:80
4326 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:80
4327 msgid "Dump raw filesystem content from inside a disk image or VM"
4331 #: ../examples/guestfs-recipes.pod:82
4332 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:82
4334 "You can use the L<guestfish(1)> C<download> command to extract the raw "
4335 "filesystem content from any filesystem in a disk image or a VM (even one "
4336 "which is encrypted or buried inside an LV):"
4340 #: ../examples/guestfs-recipes.pod:86
4341 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:86
4344 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
4349 #: ../examples/guestfs-recipes.pod:88
4350 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:88
4353 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
4358 #: ../examples/guestfs-recipes.pod:90
4359 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:90
4360 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
4364 #: ../examples/guestfs-recipes.pod:92
4365 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:92
4366 msgid "Edit grub configuration in a VM"
4370 #: ../examples/guestfs-recipes.pod:94
4371 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:94
4372 msgid "You can use this to:"
4376 #: ../examples/guestfs-recipes.pod:100
4377 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:100
4378 msgid "Fix a virtual machine that does not boot."
4382 #: ../examples/guestfs-recipes.pod:104
4383 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:104
4384 msgid "Change which kernel is used to boot the VM."
4388 #: ../examples/guestfs-recipes.pod:108
4389 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:108
4390 msgid "Change kernel command line options."
4394 #: ../examples/guestfs-recipes.pod:112
4395 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:112
4396 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
4400 #: ../examples/guestfs-recipes.pod:114
4401 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:114
4404 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
4409 #: ../examples/guestfs-recipes.pod:116
4410 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:116
4412 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
4417 #: ../examples/guestfs-recipes.pod:119
4418 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:119
4421 " virt-rescue -d BrokenGuest\n"
4426 #: ../examples/guestfs-recipes.pod:121
4427 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:121
4428 msgid "Export any directory from a VM"
4432 #: ../examples/guestfs-recipes.pod:123
4433 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:123
4435 "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
4439 #: ../examples/guestfs-recipes.pod:126
4440 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:126
4443 " virt-copy-out -d Guest /home .\n"
4448 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9
4449 #: ../fish/guestfish-actions.pod:1287 ../fish/guestfish-actions.pod:1929
4450 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:128
4451 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:9
4452 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1287
4453 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1929
4454 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:11
4455 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1917
4456 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2855
4457 #: ../libguestfs-1.11.20/src/guestfs.pod:1639 ../src/guestfs-actions.pod:11
4458 #: ../src/guestfs-actions.pod:1917 ../src/guestfs-actions.pod:2855
4459 #: ../src/guestfs.pod:1639 ../tools/virt-win-reg.pl:706
4464 #: ../examples/guestfs-recipes.pod:134
4465 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:134
4467 "The final dot of the command is not a printing error. It means we want to "
4468 "copy out to the current directory."
4472 #: ../examples/guestfs-recipes.pod:139
4473 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:139
4474 msgid "This creates a directory called C<home> under the current directory."
4478 #: ../examples/guestfs-recipes.pod:143
4479 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:143
4481 "If the guest is a Windows guest then you can use drive letters and "
4482 "backslashes, but you must prefix the path with C<win:> and quote it to "
4483 "protect it from the shell, like this:"
4487 #: ../examples/guestfs-recipes.pod:147
4488 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:147
4491 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
4496 #: ../examples/guestfs-recipes.pod:149
4497 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:149
4498 msgid "To get the output as a compressed tarball, do:"
4502 #: ../examples/guestfs-recipes.pod:151
4503 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:151
4506 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
4511 #: ../examples/guestfs-recipes.pod:153
4512 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:153
4514 "Although it sounds tempting, this is usually not a reliable way to get a "
4515 "backup from a running guest. See the entry in the FAQ: http://libguestfs."
4516 "org/FAQ.html#backup"
4520 #: ../examples/guestfs-recipes.pod:157
4521 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:157
4522 msgid "Find out which user is using the most space"
4526 #: ../examples/guestfs-recipes.pod:159
4527 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:159
4529 "This simple script examines a Linux guest to find out which user is using "
4530 "the most space in their home directory:"
4534 #: ../examples/guestfs-recipes.pod:162
4535 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:162
4543 #: ../examples/guestfs-recipes.pod:164
4544 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:164
4552 #: ../examples/guestfs-recipes.pod:166
4553 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:166
4562 #: ../examples/guestfs-recipes.pod:169
4563 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:169
4566 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
4571 #: ../examples/guestfs-recipes.pod:171
4572 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:171
4575 " for d in $(guestfish --remote ls \"$dir\"); do\n"
4576 " echo -n \"$dir/$d\"\n"
4578 " guestfish --remote du \"$dir/$d\";\n"
4579 " done | sort -nr -k 2\n"
4584 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
4585 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:177
4586 #: ../libguestfs-1.11.20/fish/guestfish.pod:941
4589 " guestfish --remote exit\n"
4594 #: ../examples/guestfs-recipes.pod:179
4595 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:179
4596 msgid "Get DHCP address from a VM"
4600 #: ../examples/guestfs-recipes.pod:181
4601 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:181
4603 "The link below explains the many different possible techniques for getting "
4604 "the last assigned DHCP address of a virtual machine."
4608 #: ../examples/guestfs-recipes.pod:184
4609 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:184
4611 "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-"
4612 "a-virtual-machine-disk-image/#content"
4616 #: ../examples/guestfs-recipes.pod:186
4617 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:186
4619 "In the libguestfs source examples directory you will find the latest version "
4620 "of the C<virt-dhcp-address.c> program."
4624 #: ../examples/guestfs-recipes.pod:189
4625 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:189
4626 msgid "Get the operating system product name string"
4630 #: ../examples/guestfs-recipes.pod:191
4631 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:191
4632 msgid "Save the following script into a file called C<product-name.sh>:"
4636 #: ../examples/guestfs-recipes.pod:193
4637 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:193
4642 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
4643 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
4644 " guestfish --remote inspect-get-product-name \"$root\"\n"
4645 " guestfish --remote exit\n"
4650 #: ../examples/guestfs-recipes.pod:200
4651 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:200
4652 msgid "Make the script executable and run it on a named guest:"
4656 #: ../examples/guestfs-recipes.pod:202
4657 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:202
4660 " # product-name.sh RHEL60x64\n"
4661 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
4666 #: ../examples/guestfs-recipes.pod:205
4667 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:205
4669 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
4670 "C<xpath> command line tool or from your favourite programming language:"
4674 #: ../examples/guestfs-recipes.pod:209
4675 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:209
4678 " # virt-inspector RHEL60x64 > xml\n"
4679 " # xpath '//product_name' < xml\n"
4682 " <product_name>Red Hat Enterprise Linux Server release 6.0 (Santiago)</product_name>\n"
4687 #: ../examples/guestfs-recipes.pod:215
4688 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:215
4689 msgid "Get the default boot kernel for a Linux VM"
4693 #: ../examples/guestfs-recipes.pod:217
4694 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:217
4696 "The link below contains a program to print the default boot kernel for a "
4701 #: ../examples/guestfs-recipes.pod:220
4702 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:220
4704 "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-"
4705 "kernel-for-a-vm/#content"
4709 #: ../examples/guestfs-recipes.pod:222
4710 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:222
4712 "It uses Augeas, and the technique is generally applicable for many different "
4717 #: ../examples/guestfs-recipes.pod:229
4718 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:229
4719 msgid "listing the user accounts in the guest"
4723 #: ../examples/guestfs-recipes.pod:233
4724 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:233
4725 msgid "what repositories is it configured to use"
4729 #: ../examples/guestfs-recipes.pod:237
4730 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:237
4731 msgid "what NTP servers does it connect to"
4735 #: ../examples/guestfs-recipes.pod:241
4736 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:241
4737 msgid "what were the boot messages last time it booted"
4741 #: ../examples/guestfs-recipes.pod:245
4742 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:245
4743 msgid "listing who was logged in recently"
4747 #: ../examples/guestfs-recipes.pod:249
4748 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:249
4749 msgid "http://augeas.net/"
4753 #: ../examples/guestfs-recipes.pod:251
4754 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:251
4755 msgid "Install RPMs in a guest"
4759 #: ../examples/guestfs-recipes.pod:253
4760 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:253
4762 "The link below contains a method to install RPMs in a guest. In fact the "
4763 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
4764 "installs them next time the guest is booted. You could use this technique "
4765 "to install vital security updates in an offline guest."
4769 #: ../examples/guestfs-recipes.pod:259
4770 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:259
4772 "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
4776 #: ../examples/guestfs-recipes.pod:261
4777 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:261
4778 msgid "List applications installed in a VM"
4782 #: ../examples/guestfs-recipes.pod:263
4783 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:263
4784 msgid "Save the following to a file C<list-apps.sh>:"
4788 #: ../examples/guestfs-recipes.pod:265
4789 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:265
4794 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
4795 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
4796 " guestfish --remote inspect-list-applications \"$root\"\n"
4797 " guestfish --remote exit\n"
4802 #: ../examples/guestfs-recipes.pod:272
4803 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:272
4805 "Make the file executable and then you can run it on any named virtual "
4810 #: ../examples/guestfs-recipes.pod:275
4811 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:275
4814 " # list-apps.sh WinGuest\n"
4816 " app_name: Mozilla Firefox (3.6.12)\n"
4817 " app_display_name: Mozilla Firefox (3.6.12)\n"
4819 " app_version: 3.6.12 (en-GB)\n"
4821 " app_install_path: C:\\Program Files\\Mozilla Firefox\n"
4822 " app_trans_path:\n"
4823 " app_publisher: Mozilla\n"
4824 " app_url: http://www.mozilla.com/en-GB/\n"
4825 " app_source_package:\n"
4827 " app_description: Mozilla Firefox\n"
4830 " app_name: VLC media player\n"
4831 " app_display_name: VLC media player 1.1.5\n"
4833 " app_version: 1.1.5\n"
4835 " app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
4836 " app_trans_path:\n"
4837 " app_publisher: VideoLAN\n"
4838 " app_url: http://www.videolan.org/\n"
4839 " app_source_package:\n"
4841 " app_description:\n"
4847 #: ../examples/guestfs-recipes.pod:305
4848 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:305
4850 "If you want to run the script on disk images (instead of libvirt virtual "
4851 "machines), change C<-d \"$1\"> to C<-a \"$1\">. See also L<virt-inspector(1)"
4856 #: ../examples/guestfs-recipes.pod:309
4857 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:309
4858 msgid "List files and directories in a VM"
4862 #: ../examples/guestfs-recipes.pod:311
4863 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:311
4864 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
4868 #: ../examples/guestfs-recipes.pod:313
4869 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:313
4872 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
4877 #: ../examples/guestfs-recipes.pod:315
4878 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:315
4879 msgid "List services in a Windows VM"
4883 #: ../examples/guestfs-recipes.pod:317
4884 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:317
4886 "The link below contains a script that can be used to list out the services "
4887 "from a Windows VM, and whether those services run at boot time or are loaded "
4892 #: ../examples/guestfs-recipes.pod:321
4893 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:321
4895 "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/"
4900 #: ../examples/guestfs-recipes.pod:323
4901 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:323
4902 msgid "Make a disk image sparse"
4906 #: ../examples/guestfs-recipes.pod:325
4907 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:325
4909 "The link below contains some guides for making a disk image sparse (or "
4910 "reintroducing sparseness)."
4914 #: ../examples/guestfs-recipes.pod:328
4915 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:328
4917 "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
4921 #: ../examples/guestfs-recipes.pod:330
4922 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:330
4923 msgid "Monitor disk usage over time"
4927 #: ../examples/guestfs-recipes.pod:332
4928 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:332
4930 "You can use L<virt-df(1)> to monitor disk usage of your guests over time. "
4931 "The link below contains a guide."
4935 #: ../examples/guestfs-recipes.pod:335
4936 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:335
4937 msgid "http://virt-tools.org/learning/advanced-virt-df/"
4941 #: ../examples/guestfs-recipes.pod:337
4942 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:337
4943 msgid "Reading the Windows Event Log from Windows Vista (or later)"
4947 #: ../examples/guestfs-recipes.pod:339
4948 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:339
4950 "L<guestfish(1)> plus the tools described in the link below can be used to "
4951 "read out the Windows Event Log from any virtual machine running Windows "
4952 "Vista or a later version."
4956 #: ../examples/guestfs-recipes.pod:343
4957 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:343
4959 "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-"
4960 "guestfish/#content"
4964 #: ../examples/guestfs-recipes.pod:345
4965 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:345
4966 msgid "Remove root password (Linux)"
4970 #: ../examples/guestfs-recipes.pod:347
4971 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:347
4973 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
4974 "files. One use is to remove the root password from a Linux guest:"
4978 #: ../examples/guestfs-recipes.pod:350
4979 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:350
4982 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
4987 #: ../examples/guestfs-recipes.pod:352
4988 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:352
4989 msgid "Remove Administrator password (Windows)"
4993 #: ../examples/guestfs-recipes.pod:354
4994 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:354
4996 "The link below contains one technique for removing the Administrator "
4997 "password from a Windows VM, or to be more precise, it gives you a command "
4998 "prompt the next time you log in which you can use to bypass any security:"
5002 #: ../examples/guestfs-recipes.pod:359
5003 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:359
5005 "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-"
5006 "administrator-password-with-guestfish/"
5010 #: ../examples/guestfs-recipes.pod:361
5011 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:361
5012 msgid "Unpack a live CD"
5016 #: ../examples/guestfs-recipes.pod:363
5017 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:363
5019 "Linux live CDs often contain multiple layers of disk images wrapped like a "
5020 "Russian doll. You can use L<guestfish(1)> to look inside these multiple "
5021 "layers, as outlined in the guide below."
5025 #: ../examples/guestfs-recipes.pod:367
5026 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:367
5028 "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-"
5033 #: ../examples/guestfs-recipes.pod:369
5034 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:369
5035 msgid "Uploading and downloading files"
5039 #: ../examples/guestfs-recipes.pod:371
5040 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:371
5042 "The link below contains general tips on uploading (copying in) and "
5043 "downloading (copying out) files from VMs."
5047 #: ../examples/guestfs-recipes.pod:374
5048 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:374
5050 "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
5054 #: ../examples/guestfs-recipes.pod:376
5055 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:376
5056 msgid "Use libguestfs tools on VMware ESX guests"
5060 #: ../examples/guestfs-recipes.pod:378
5061 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:378
5063 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
5064 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
5068 #: ../examples/guestfs-recipes.pod:382
5069 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:382
5071 "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-"
5076 #: ../examples/guestfs-recipes.pod:386
5077 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:386
5079 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
5080 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby"
5081 "(3)>, L<http://libguestfs.org/>."
5085 #: ../examples/guestfs-recipes.pod:402
5086 #: ../libguestfs-1.11.20/examples/guestfs-recipes.pod:402
5087 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
5091 #: ../fish/guestfish-actions.pod:1
5092 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1
5097 #: ../fish/guestfish-actions.pod:3
5098 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3
5101 " add-cdrom filename\n"
5106 #: ../fish/guestfish-actions.pod:5
5107 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5
5108 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7
5109 #: ../src/guestfs-actions.pod:7
5110 msgid "This function adds a virtual CD-ROM disk image to the guest."
5114 #: ../fish/guestfish-actions.pod:7
5115 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:7
5116 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:9
5117 #: ../src/guestfs-actions.pod:9
5118 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
5122 #: ../fish/guestfish-actions.pod:15
5123 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:15
5125 "This call checks for the existence of C<filename>. This stops you from "
5126 "specifying other types of drive which are supported by qemu such as C<nbd:> "
5127 "and C<http:> URLs. To specify those, use the general L</config> call "
5132 #: ../fish/guestfish-actions.pod:22
5133 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:22
5135 "If you just want to add an ISO file (often you use this as an efficient way "
5136 "to transfer large files into the guest), then you should probably use L</add-"
5137 "drive-ro> instead."
5141 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163
5142 #: ../fish/guestfish-actions.pod:177
5143 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:28
5144 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:163
5145 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:177
5146 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:32
5147 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:254
5148 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:275
5149 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254
5150 #: ../src/guestfs-actions.pod:275
5152 "This function is deprecated. In new code, use the C<add_drive_opts> call "
5157 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166
5158 #: ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:986
5159 #: ../fish/guestfish-actions.pod:1346 ../fish/guestfish-actions.pod:1360
5160 #: ../fish/guestfish-actions.pod:3085 ../fish/guestfish-actions.pod:3292
5161 #: ../fish/guestfish-actions.pod:3406 ../fish/guestfish-actions.pod:3454
5162 #: ../fish/guestfish-actions.pod:4355 ../fish/guestfish-actions.pod:4378
5163 #: ../fish/guestfish-actions.pod:4400 ../fish/guestfish-actions.pod:4438
5164 #: ../fish/guestfish-actions.pod:5087 ../fish/guestfish-actions.pod:5185
5165 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:31
5166 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:166
5167 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:180
5168 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:986
5169 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1346
5170 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1360
5171 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3085
5172 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3292
5173 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3406
5174 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3454
5175 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4355
5176 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4378
5177 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4400
5178 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4438
5179 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5087
5180 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5185
5181 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:35
5182 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:257
5183 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:278
5184 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1513
5185 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2008
5186 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2029
5187 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4628
5188 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4947
5189 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5165
5190 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5255
5191 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6544
5192 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6574
5193 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6607
5194 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6666
5195 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7602
5196 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7714
5197 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7884
5198 #: ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257
5199 #: ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1513
5200 #: ../src/guestfs-actions.pod:2008 ../src/guestfs-actions.pod:2029
5201 #: ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4947
5202 #: ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5255
5203 #: ../src/guestfs-actions.pod:6544 ../src/guestfs-actions.pod:6574
5204 #: ../src/guestfs-actions.pod:6607 ../src/guestfs-actions.pod:6666
5205 #: ../src/guestfs-actions.pod:7602 ../src/guestfs-actions.pod:7714
5206 #: ../src/guestfs-actions.pod:7884
5208 "Deprecated functions will not be removed from the API, but the fact that "
5209 "they are deprecated indicates that there are problems with correct use of "
5214 #: ../fish/guestfish-actions.pod:35
5215 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:35
5220 #: ../fish/guestfish-actions.pod:37
5221 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:37
5226 #: ../fish/guestfish-actions.pod:39
5227 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:39
5230 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] [allowuuid:..]\n"
5235 #: ../fish/guestfish-actions.pod:41
5236 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:41
5238 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
5239 "It works by connecting to libvirt, requesting the domain and domain XML from "
5240 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
5244 #: ../fish/guestfish-actions.pod:46
5245 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:46
5246 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:64
5247 #: ../src/guestfs-actions.pod:64
5249 "The number of disks added is returned. This operation is atomic: if an "
5250 "error is returned, then no disks are added."
5254 #: ../fish/guestfish-actions.pod:49
5255 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:49
5256 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:67
5257 #: ../src/guestfs-actions.pod:67
5259 "This function does some minimal checks to make sure the libvirt domain is "
5260 "not running (unless C<readonly> is true). In a future version we will try "
5261 "to acquire the libvirt lock on each disk."
5265 #: ../fish/guestfish-actions.pod:53
5266 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:53
5267 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:71
5268 #: ../src/guestfs-actions.pod:71
5270 "Disks must be accessible locally. This often means that adding disks from a "
5271 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
5272 "unless those disks are accessible via the same device path locally too."
5276 #: ../fish/guestfish-actions.pod:58
5277 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:58
5278 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:76
5279 #: ../src/guestfs-actions.pod:76
5281 "The optional C<libvirturi> parameter sets the libvirt URI (see L<http://"
5282 "libvirt.org/uri.html>). If this is not set then we connect to the default "
5283 "libvirt URI (or one set through an environment variable, see the libvirt "
5284 "documentation for full details)."
5288 #: ../fish/guestfish-actions.pod:64
5289 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:64
5290 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:82
5291 #: ../src/guestfs-actions.pod:82
5293 "The optional C<live> flag controls whether this call will try to connect to "
5294 "a running virtual machine C<guestfsd> process if it sees a suitable "
5295 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
5296 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
5297 "DAEMONS> for more information."
5301 #: ../fish/guestfish-actions.pod:71
5302 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:71
5303 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:89
5304 #: ../src/guestfs-actions.pod:89
5306 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
5307 "passed instead of the domain name. The C<dom> string is treated as a UUID "
5308 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
5313 #: ../fish/guestfish-actions.pod:76
5314 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:76
5316 "The other optional parameters are passed directly through to L</add-drive-"
5321 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143
5322 #: ../fish/guestfish-actions.pod:568 ../fish/guestfish-actions.pod:1968
5323 #: ../fish/guestfish-actions.pod:3134 ../fish/guestfish-actions.pod:3307
5324 #: ../fish/guestfish-actions.pod:3442
5325 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:79
5326 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:143
5327 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:568
5328 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1968
5329 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3134
5330 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3307
5331 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3442
5333 "This command has one or more optional arguments. See L</OPTIONAL ARGUMENTS>."
5337 #: ../fish/guestfish-actions.pod:81
5338 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:81
5343 #: ../fish/guestfish-actions.pod:83
5344 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:83
5347 " add-drive filename\n"
5352 #: ../fish/guestfish-actions.pod:85
5353 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:85
5355 "This function is the equivalent of calling L</add-drive-opts> with no "
5356 "optional parameters, so the disk is added writable, with the format being "
5357 "detected automatically."
5361 #: ../fish/guestfish-actions.pod:89
5362 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:89
5364 "Automatic detection of the format opens you up to a potential security hole "
5365 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5366 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
5367 "you should think about replacing calls to this function with calls to L</add-"
5368 "drive-opts>, and specifying the format."
5372 #: ../fish/guestfish-actions.pod:96
5373 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:96
5374 msgid "add-drive-opts"
5378 #: ../fish/guestfish-actions.pod:98
5379 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:98
5384 #: ../fish/guestfish-actions.pod:100
5385 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:100
5388 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
5393 #: ../fish/guestfish-actions.pod:102
5394 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:102
5395 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:160
5396 #: ../src/guestfs-actions.pod:160
5398 "This function adds a virtual machine disk image C<filename> to libguestfs. "
5399 "The first time you call this function, the disk appears as C</dev/sda>, the "
5400 "second time as C</dev/sdb>, and so on."
5404 #: ../fish/guestfish-actions.pod:107
5405 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:107
5406 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:165
5407 #: ../src/guestfs-actions.pod:165
5409 "You don't necessarily need to be root when using libguestfs. However you "
5410 "obviously do need sufficient permissions to access the filename for whatever "
5411 "operations you want to perform (ie. read access if you just want to read the "
5412 "image or write access if you want to modify the image)."
5416 #: ../fish/guestfish-actions.pod:113
5417 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:113
5418 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:171
5419 #: ../src/guestfs-actions.pod:171
5420 msgid "This call checks that C<filename> exists."
5424 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3096
5425 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:115
5426 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3096
5427 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:173
5428 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4655
5429 #: ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4655
5430 msgid "The optional arguments are:"
5434 #: ../fish/guestfish-actions.pod:119
5435 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:119
5436 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:177
5437 #: ../src/guestfs-actions.pod:177
5442 #: ../fish/guestfish-actions.pod:121
5443 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:121
5444 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:179
5445 #: ../src/guestfs-actions.pod:179
5447 "If true then the image is treated as read-only. Writes are still allowed, "
5448 "but they are stored in a temporary snapshot overlay which is discarded at "
5449 "the end. The disk that you add is not modified."
5453 #: ../fish/guestfish-actions.pod:125
5454 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:125
5455 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:183
5456 #: ../src/guestfs-actions.pod:183
5461 #: ../fish/guestfish-actions.pod:127
5462 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:127
5464 "This forces the image format. If you omit this (or use L</add-drive> or L</"
5465 "add-drive-ro>) then the format is automatically detected. Possible formats "
5466 "include C<raw> and C<qcow2>."
5470 #: ../fish/guestfish-actions.pod:131
5471 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:131
5472 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:189
5473 #: ../src/guestfs-actions.pod:189
5475 "Automatic detection of the format opens you up to a potential security hole "
5476 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
5477 "RHBZ#642934. Specifying the format closes this security hole."
5481 #: ../fish/guestfish-actions.pod:136
5482 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:136
5483 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:194
5484 #: ../src/guestfs-actions.pod:194
5489 #: ../fish/guestfish-actions.pod:138
5490 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:138
5492 "This rarely-used option lets you emulate the behaviour of the deprecated L</"
5493 "add-drive-with-if> call (q.v.)"
5497 #: ../fish/guestfish-actions.pod:145
5498 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:145
5499 msgid "add-drive-ro"
5503 #: ../fish/guestfish-actions.pod:147
5504 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:147
5509 #: ../fish/guestfish-actions.pod:149
5510 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:149
5513 " add-drive-ro filename\n"
5518 #: ../fish/guestfish-actions.pod:151
5519 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:151
5521 "This function is the equivalent of calling L</add-drive-opts> with the "
5522 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
5523 "is added read-only, with the format being detected automatically."
5527 #: ../fish/guestfish-actions.pod:156
5528 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:156
5529 msgid "add-drive-ro-with-if"
5533 #: ../fish/guestfish-actions.pod:158
5534 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:158
5537 " add-drive-ro-with-if filename iface\n"
5542 #: ../fish/guestfish-actions.pod:160
5543 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:160
5545 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
5546 "interface emulation to use at run time."
5550 #: ../fish/guestfish-actions.pod:170
5551 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:170
5552 msgid "add-drive-with-if"
5556 #: ../fish/guestfish-actions.pod:172
5557 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:172
5560 " add-drive-with-if filename iface\n"
5565 #: ../fish/guestfish-actions.pod:174
5566 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:174
5568 "This is the same as L</add-drive> but it allows you to specify the QEMU "
5569 "interface emulation to use at run time."
5573 #: ../fish/guestfish-actions.pod:184
5574 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:184
5579 #: ../fish/guestfish-actions.pod:186
5580 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:186
5583 " aug-clear augpath\n"
5588 #: ../fish/guestfish-actions.pod:188
5589 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:188
5590 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:290
5591 #: ../src/guestfs-actions.pod:290
5593 "Set the value associated with C<path> to C<NULL>. This is the same as the "
5594 "L<augtool(1)> C<clear> command."
5598 #: ../fish/guestfish-actions.pod:191
5599 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:191
5604 #: ../fish/guestfish-actions.pod:193
5605 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:193
5613 #: ../fish/guestfish-actions.pod:195
5614 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:195
5616 "Close the current Augeas handle and free up any resources used by it. After "
5617 "calling this, you have to call L</aug-init> again before you can use any "
5618 "other Augeas functions."
5622 #: ../fish/guestfish-actions.pod:200
5623 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:200
5628 #: ../fish/guestfish-actions.pod:202
5629 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:202
5632 " aug-defnode name expr val\n"
5637 #: ../fish/guestfish-actions.pod:204
5638 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:204
5639 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:319
5640 #: ../src/guestfs-actions.pod:319
5642 "Defines a variable C<name> whose value is the result of evaluating C<expr>."
5646 #: ../fish/guestfish-actions.pod:207
5647 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:207
5649 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
5650 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
5651 "containing that single node."
5655 #: ../fish/guestfish-actions.pod:211
5656 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:211
5657 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:326
5658 #: ../src/guestfs-actions.pod:326
5660 "On success this returns a pair containing the number of nodes in the "
5661 "nodeset, and a boolean flag if a node was created."
5665 #: ../fish/guestfish-actions.pod:215
5666 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:215
5671 #: ../fish/guestfish-actions.pod:217
5672 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:217
5675 " aug-defvar name expr\n"
5680 #: ../fish/guestfish-actions.pod:219
5681 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:219
5682 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:343
5683 #: ../src/guestfs-actions.pod:343
5685 "Defines an Augeas variable C<name> whose value is the result of evaluating "
5686 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
5690 #: ../fish/guestfish-actions.pod:223
5691 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:223
5692 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:347
5693 #: ../src/guestfs-actions.pod:347
5695 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
5696 "evaluates to something which is not a nodeset."
5700 #: ../fish/guestfish-actions.pod:226
5701 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:226
5706 #: ../fish/guestfish-actions.pod:228
5707 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:228
5710 " aug-get augpath\n"
5715 #: ../fish/guestfish-actions.pod:230
5716 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:230
5717 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:360
5718 #: ../src/guestfs-actions.pod:360
5720 "Look up the value associated with C<path>. If C<path> matches exactly one "
5721 "node, the C<value> is returned."
5725 #: ../fish/guestfish-actions.pod:233
5726 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:233
5731 #: ../fish/guestfish-actions.pod:235
5732 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:235
5735 " aug-init root flags\n"
5740 #: ../fish/guestfish-actions.pod:237
5741 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:237
5742 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:375
5743 #: ../src/guestfs-actions.pod:375
5745 "Create a new Augeas handle for editing configuration files. If there was "
5746 "any previous Augeas handle associated with this guestfs session, then it is "
5751 #: ../fish/guestfish-actions.pod:241
5752 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:241
5753 msgid "You must call this before using any other L</aug-*> commands."
5757 #: ../fish/guestfish-actions.pod:244
5758 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:244
5759 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:382
5760 #: ../src/guestfs-actions.pod:382
5762 "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
5766 #: ../fish/guestfish-actions.pod:247
5767 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:247
5768 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:385
5769 #: ../src/guestfs-actions.pod:385
5771 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
5772 "logical I<or> of the following integers:"
5776 #: ../fish/guestfish-actions.pod:253
5777 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:253
5778 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:391
5779 #: ../src/guestfs-actions.pod:391
5780 msgid "C<AUG_SAVE_BACKUP> = 1"
5784 #: ../fish/guestfish-actions.pod:255
5785 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:255
5786 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:393
5787 #: ../src/guestfs-actions.pod:393
5788 msgid "Keep the original file with a C<.augsave> extension."
5792 #: ../fish/guestfish-actions.pod:257
5793 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:257
5794 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:395
5795 #: ../src/guestfs-actions.pod:395
5796 msgid "C<AUG_SAVE_NEWFILE> = 2"
5800 #: ../fish/guestfish-actions.pod:259
5801 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:259
5802 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:397
5803 #: ../src/guestfs-actions.pod:397
5805 "Save changes into a file with extension C<.augnew>, and do not overwrite "
5806 "original. Overrides C<AUG_SAVE_BACKUP>."
5810 #: ../fish/guestfish-actions.pod:262
5811 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:262
5812 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:400
5813 #: ../src/guestfs-actions.pod:400
5814 msgid "C<AUG_TYPE_CHECK> = 4"
5818 #: ../fish/guestfish-actions.pod:264
5819 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:264
5820 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:402
5821 #: ../src/guestfs-actions.pod:402
5822 msgid "Typecheck lenses (can be expensive)."
5826 #: ../fish/guestfish-actions.pod:266
5827 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:266
5828 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:404
5829 #: ../src/guestfs-actions.pod:404
5830 msgid "C<AUG_NO_STDINC> = 8"
5834 #: ../fish/guestfish-actions.pod:268
5835 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:268
5836 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:406
5837 #: ../src/guestfs-actions.pod:406
5838 msgid "Do not use standard load path for modules."
5842 #: ../fish/guestfish-actions.pod:270
5843 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:270
5844 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:408
5845 #: ../src/guestfs-actions.pod:408
5846 msgid "C<AUG_SAVE_NOOP> = 16"
5850 #: ../fish/guestfish-actions.pod:272
5851 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:272
5852 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:410
5853 #: ../src/guestfs-actions.pod:410
5854 msgid "Make save a no-op, just record what would have been changed."
5858 #: ../fish/guestfish-actions.pod:274
5859 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:274
5860 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:412
5861 #: ../src/guestfs-actions.pod:412
5862 msgid "C<AUG_NO_LOAD> = 32"
5866 #: ../fish/guestfish-actions.pod:276
5867 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:276
5868 msgid "Do not load the tree in L</aug-init>."
5872 #: ../fish/guestfish-actions.pod:280
5873 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:280
5874 msgid "To close the handle, you can call L</aug-close>."
5878 #: ../fish/guestfish-actions.pod:282
5879 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:282
5880 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:420
5881 #: ../src/guestfs-actions.pod:420
5882 msgid "To find out more about Augeas, see L<http://augeas.net/>."
5886 #: ../fish/guestfish-actions.pod:284
5887 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:284
5892 #: ../fish/guestfish-actions.pod:286
5893 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:286
5896 " aug-insert augpath label true|false\n"
5901 #: ../fish/guestfish-actions.pod:288
5902 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:288
5903 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:434
5904 #: ../src/guestfs-actions.pod:434
5906 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
5907 "or after C<path> (depending on the boolean flag C<before>)."
5911 #: ../fish/guestfish-actions.pod:292
5912 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:292
5913 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:438
5914 #: ../src/guestfs-actions.pod:438
5916 "C<path> must match exactly one existing node in the tree, and C<label> must "
5917 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
5921 #: ../fish/guestfish-actions.pod:296
5922 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:296
5927 #: ../fish/guestfish-actions.pod:298
5928 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:298
5936 #: ../fish/guestfish-actions.pod:300
5937 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:300
5938 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:451
5939 #: ../src/guestfs-actions.pod:451
5940 msgid "Load files into the tree."
5944 #: ../fish/guestfish-actions.pod:302
5945 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:302
5946 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:453
5947 #: ../src/guestfs-actions.pod:453
5948 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
5952 #: ../fish/guestfish-actions.pod:305
5953 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:305
5958 #: ../fish/guestfish-actions.pod:307
5959 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:307
5967 #: ../fish/guestfish-actions.pod:309
5968 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:309
5970 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
5971 "resulting nodes into alphabetical order."
5975 #: ../fish/guestfish-actions.pod:312
5976 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:312
5981 #: ../fish/guestfish-actions.pod:314
5982 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:314
5985 " aug-match augpath\n"
5990 #: ../fish/guestfish-actions.pod:316
5991 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:316
5992 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:481
5993 #: ../src/guestfs-actions.pod:481
5995 "Returns a list of paths which match the path expression C<path>. The "
5996 "returned paths are sufficiently qualified so that they match exactly one "
5997 "node in the current tree."
6001 #: ../fish/guestfish-actions.pod:320
6002 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:320
6007 #: ../fish/guestfish-actions.pod:322
6008 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:322
6011 " aug-mv src dest\n"
6016 #: ../fish/guestfish-actions.pod:324
6017 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:324
6018 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:498
6019 #: ../src/guestfs-actions.pod:498
6021 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
6022 "C<dest> is overwritten if it exists."
6026 #: ../fish/guestfish-actions.pod:327
6027 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:327
6032 #: ../fish/guestfish-actions.pod:329
6033 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:329
6041 #: ../fish/guestfish-actions.pod:331
6042 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:331
6043 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:511
6044 #: ../src/guestfs-actions.pod:511
6045 msgid "Remove C<path> and all of its children."
6049 #: ../fish/guestfish-actions.pod:333
6050 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:333
6051 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:513
6052 #: ../src/guestfs-actions.pod:513
6053 msgid "On success this returns the number of entries which were removed."
6057 #: ../fish/guestfish-actions.pod:335
6058 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:335
6063 #: ../fish/guestfish-actions.pod:337
6064 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:337
6072 #: ../fish/guestfish-actions.pod:339
6073 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:339
6074 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:524
6075 #: ../src/guestfs-actions.pod:524
6076 msgid "This writes all pending changes to disk."
6080 #: ../fish/guestfish-actions.pod:341
6081 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:341
6083 "The flags which were passed to L</aug-init> affect exactly how files are "
6088 #: ../fish/guestfish-actions.pod:344
6089 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:344
6094 #: ../fish/guestfish-actions.pod:346
6095 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:346
6098 " aug-set augpath val\n"
6103 #: ../fish/guestfish-actions.pod:348
6104 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:348
6105 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:540
6106 #: ../src/guestfs-actions.pod:540
6107 msgid "Set the value associated with C<path> to C<val>."
6111 #: ../fish/guestfish-actions.pod:350
6112 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:350
6114 "In the Augeas API, it is possible to clear a node by setting the value to "
6115 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
6116 "this call. Instead you must use the L</aug-clear> call."
6120 #: ../fish/guestfish-actions.pod:355
6121 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:355
6126 #: ../fish/guestfish-actions.pod:357
6127 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:357
6130 " available 'groups ...'\n"
6135 #: ../fish/guestfish-actions.pod:359
6136 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:359
6137 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:557
6138 #: ../src/guestfs-actions.pod:557
6140 "This command is used to check the availability of some groups of "
6141 "functionality in the appliance, which not all builds of the libguestfs "
6142 "appliance will be able to provide."
6146 #: ../fish/guestfish-actions.pod:363
6147 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:363
6149 "The libguestfs groups, and the functions that those groups correspond to, "
6150 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
6151 "runtime by calling L</available-all-groups>."
6155 #: ../fish/guestfish-actions.pod:368
6156 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:368
6157 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:566
6158 #: ../src/guestfs-actions.pod:566
6160 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", \"augeas"
6161 "\"]> would check for the availability of the Linux inotify functions and "
6162 "Augeas (configuration file editing) functions."
6166 #: ../fish/guestfish-actions.pod:373
6167 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:373
6168 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:571
6169 #: ../src/guestfs-actions.pod:571
6170 msgid "The command returns no error if I<all> requested groups are available."
6174 #: ../fish/guestfish-actions.pod:375
6175 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:375
6176 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:573
6177 #: ../src/guestfs-actions.pod:573
6179 "It fails with an error if one or more of the requested groups is unavailable "
6184 #: ../fish/guestfish-actions.pod:378
6185 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:378
6186 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:576
6187 #: ../src/guestfs-actions.pod:576
6189 "If an unknown group name is included in the list of groups then an error is "
6194 #: ../fish/guestfish-actions.pod:381
6195 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:381
6196 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:579
6197 #: ../src/guestfs-actions.pod:579
6202 #: ../fish/guestfish-actions.pod:387
6203 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:387
6204 msgid "You must call L</launch> before calling this function."
6208 #: ../fish/guestfish-actions.pod:389
6209 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:389
6210 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:587
6211 #: ../src/guestfs-actions.pod:587
6213 "The reason is because we don't know what groups are supported by the "
6214 "appliance/daemon until it is running and can be queried."
6218 #: ../fish/guestfish-actions.pod:395
6219 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:395
6220 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:593
6221 #: ../src/guestfs-actions.pod:593
6223 "If a group of functions is available, this does not necessarily mean that "
6224 "they will work. You still have to check for errors when calling individual "
6225 "API functions even if they are available."
6229 #: ../fish/guestfish-actions.pod:402
6230 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:402
6231 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:600
6232 #: ../src/guestfs-actions.pod:600
6234 "It is usually the job of distro packagers to build complete functionality "
6235 "into the libguestfs appliance. Upstream libguestfs, if built from source "
6236 "with all requirements satisfied, will support everything."
6240 #: ../fish/guestfish-actions.pod:409
6241 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:409
6243 "This call was added in version C<1.0.80>. In previous versions of "
6244 "libguestfs all you could do would be to speculatively execute a command to "
6245 "find out if the daemon implemented it. See also L</version>."
6249 #: ../fish/guestfish-actions.pod:416
6250 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:416
6251 msgid "available-all-groups"
6255 #: ../fish/guestfish-actions.pod:418
6256 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:418
6259 " available-all-groups\n"
6264 #: ../fish/guestfish-actions.pod:420
6265 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:420
6267 "This command returns a list of all optional groups that this daemon knows "
6268 "about. Note this returns both supported and unsupported groups. To find "
6269 "out which ones the daemon can actually support you have to call L</"
6270 "available> on each member of the returned list."
6274 #: ../fish/guestfish-actions.pod:426
6275 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:426
6276 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
6280 #: ../fish/guestfish-actions.pod:428
6281 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:428
6286 #: ../fish/guestfish-actions.pod:430
6287 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:430
6290 " base64-in (base64file|-) filename\n"
6295 #: ../fish/guestfish-actions.pod:432
6296 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:432
6297 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:644
6298 #: ../src/guestfs-actions.pod:644
6300 "This command uploads base64-encoded data from C<base64file> to C<filename>."
6304 #: ../fish/guestfish-actions.pod:435 ../fish/guestfish-actions.pod:444
6305 #: ../fish/guestfish-actions.pod:693 ../fish/guestfish-actions.pod:862
6306 #: ../fish/guestfish-actions.pod:881 ../fish/guestfish-actions.pod:1255
6307 #: ../fish/guestfish-actions.pod:4658 ../fish/guestfish-actions.pod:4670
6308 #: ../fish/guestfish-actions.pod:4681 ../fish/guestfish-actions.pod:4692
6309 #: ../fish/guestfish-actions.pod:4744 ../fish/guestfish-actions.pod:4753
6310 #: ../fish/guestfish-actions.pod:4807 ../fish/guestfish-actions.pod:4830
6311 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:435
6312 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:444
6313 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:693
6314 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:862
6315 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:881
6316 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1255
6317 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4658
6318 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4670
6319 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4681
6320 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4692
6321 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4744
6322 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4753
6323 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4807
6324 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4830
6325 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
6329 #: ../fish/guestfish-actions.pod:437
6330 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:437
6335 #: ../fish/guestfish-actions.pod:439
6336 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:439
6339 " base64-out filename (base64file|-)\n"
6344 #: ../fish/guestfish-actions.pod:441
6345 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:441
6346 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:658
6347 #: ../src/guestfs-actions.pod:658
6349 "This command downloads the contents of C<filename>, writing it out to local "
6350 "file C<base64file> encoded as base64."
6354 #: ../fish/guestfish-actions.pod:446
6355 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:446
6356 msgid "blockdev-flushbufs"
6360 #: ../fish/guestfish-actions.pod:448
6361 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:448
6364 " blockdev-flushbufs device\n"
6369 #: ../fish/guestfish-actions.pod:450
6370 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:450
6371 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:671
6372 #: ../src/guestfs-actions.pod:671
6374 "This tells the kernel to flush internal buffers associated with C<device>."
6378 #: ../fish/guestfish-actions.pod:453 ../fish/guestfish-actions.pod:464
6379 #: ../fish/guestfish-actions.pod:473 ../fish/guestfish-actions.pod:483
6380 #: ../fish/guestfish-actions.pod:495 ../fish/guestfish-actions.pod:508
6381 #: ../fish/guestfish-actions.pod:516 ../fish/guestfish-actions.pod:527
6382 #: ../fish/guestfish-actions.pod:535 ../fish/guestfish-actions.pod:543
6383 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:453
6384 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:464
6385 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:473
6386 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:483
6387 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:495
6388 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:508
6389 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:516
6390 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:527
6391 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:535
6392 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:543
6393 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:674
6394 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:691
6395 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:706
6396 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:722
6397 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:740
6398 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:759
6399 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:773
6400 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:791
6401 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:805
6402 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:819
6403 #: ../src/guestfs-actions.pod:674 ../src/guestfs-actions.pod:691
6404 #: ../src/guestfs-actions.pod:706 ../src/guestfs-actions.pod:722
6405 #: ../src/guestfs-actions.pod:740 ../src/guestfs-actions.pod:759
6406 #: ../src/guestfs-actions.pod:773 ../src/guestfs-actions.pod:791
6407 #: ../src/guestfs-actions.pod:805 ../src/guestfs-actions.pod:819
6408 msgid "This uses the L<blockdev(8)> command."
6412 #: ../fish/guestfish-actions.pod:455
6413 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:455
6414 msgid "blockdev-getbsz"
6418 #: ../fish/guestfish-actions.pod:457
6419 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:457
6422 " blockdev-getbsz device\n"
6427 #: ../fish/guestfish-actions.pod:459
6428 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:459
6429 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:686
6430 #: ../src/guestfs-actions.pod:686
6431 msgid "This returns the block size of a device."
6435 #: ../fish/guestfish-actions.pod:461 ../fish/guestfish-actions.pod:524
6436 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:461
6437 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:524
6438 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:688
6439 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:788
6440 #: ../src/guestfs-actions.pod:688 ../src/guestfs-actions.pod:788
6442 "(Note this is different from both I<size in blocks> and I<filesystem block "
6447 #: ../fish/guestfish-actions.pod:466
6448 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:466
6449 msgid "blockdev-getro"
6453 #: ../fish/guestfish-actions.pod:468
6454 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:468
6457 " blockdev-getro device\n"
6462 #: ../fish/guestfish-actions.pod:470
6463 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:470
6464 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:703
6465 #: ../src/guestfs-actions.pod:703
6467 "Returns a boolean indicating if the block device is read-only (true if read-"
6468 "only, false if not)."
6472 #: ../fish/guestfish-actions.pod:475
6473 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:475
6474 msgid "blockdev-getsize64"
6478 #: ../fish/guestfish-actions.pod:477
6479 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:477
6482 " blockdev-getsize64 device\n"
6487 #: ../fish/guestfish-actions.pod:479
6488 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:479
6489 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:718
6490 #: ../src/guestfs-actions.pod:718
6491 msgid "This returns the size of the device in bytes."
6495 #: ../fish/guestfish-actions.pod:481
6496 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:481
6497 msgid "See also L</blockdev-getsz>."
6501 #: ../fish/guestfish-actions.pod:485
6502 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:485
6503 msgid "blockdev-getss"
6507 #: ../fish/guestfish-actions.pod:487
6508 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:487
6511 " blockdev-getss device\n"
6516 #: ../fish/guestfish-actions.pod:489
6517 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:489
6518 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:734
6519 #: ../src/guestfs-actions.pod:734
6521 "This returns the size of sectors on a block device. Usually 512, but can be "
6522 "larger for modern devices."
6526 #: ../fish/guestfish-actions.pod:492
6527 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:492
6529 "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
6533 #: ../fish/guestfish-actions.pod:497
6534 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:497
6535 msgid "blockdev-getsz"
6539 #: ../fish/guestfish-actions.pod:499
6540 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:499
6543 " blockdev-getsz device\n"
6548 #: ../fish/guestfish-actions.pod:501
6549 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:501
6550 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:752
6551 #: ../src/guestfs-actions.pod:752
6553 "This returns the size of the device in units of 512-byte sectors (even if "
6554 "the sectorsize isn't 512 bytes ... weird)."
6558 #: ../fish/guestfish-actions.pod:504
6559 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:504
6561 "See also L</blockdev-getss> for the real sector size of the device, and L</"
6562 "blockdev-getsize64> for the more useful I<size in bytes>."
6566 #: ../fish/guestfish-actions.pod:510
6567 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:510
6568 msgid "blockdev-rereadpt"
6572 #: ../fish/guestfish-actions.pod:512
6573 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:512
6576 " blockdev-rereadpt device\n"
6581 #: ../fish/guestfish-actions.pod:514
6582 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:514
6583 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:771
6584 #: ../src/guestfs-actions.pod:771
6585 msgid "Reread the partition table on C<device>."
6589 #: ../fish/guestfish-actions.pod:518
6590 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:518
6591 msgid "blockdev-setbsz"
6595 #: ../fish/guestfish-actions.pod:520
6596 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:520
6599 " blockdev-setbsz device blocksize\n"
6604 #: ../fish/guestfish-actions.pod:522
6605 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:522
6606 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:786
6607 #: ../src/guestfs-actions.pod:786
6608 msgid "This sets the block size of a device."
6612 #: ../fish/guestfish-actions.pod:529
6613 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:529
6614 msgid "blockdev-setro"
6618 #: ../fish/guestfish-actions.pod:531
6619 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:531
6622 " blockdev-setro device\n"
6627 #: ../fish/guestfish-actions.pod:533
6628 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:533
6629 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:803
6630 #: ../src/guestfs-actions.pod:803
6631 msgid "Sets the block device named C<device> to read-only."
6635 #: ../fish/guestfish-actions.pod:537
6636 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:537
6637 msgid "blockdev-setrw"
6641 #: ../fish/guestfish-actions.pod:539
6642 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:539
6645 " blockdev-setrw device\n"
6650 #: ../fish/guestfish-actions.pod:541
6651 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:541
6652 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:817
6653 #: ../src/guestfs-actions.pod:817
6654 msgid "Sets the block device named C<device> to read-write."
6658 #: ../fish/guestfish-actions.pod:545
6659 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:545
6660 msgid "btrfs-filesystem-resize"
6664 #: ../fish/guestfish-actions.pod:547
6665 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:547
6668 " btrfs-filesystem-resize mountpoint [size:..]\n"
6673 #: ../fish/guestfish-actions.pod:549
6674 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:549
6675 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:839
6676 #: ../src/guestfs-actions.pod:839
6677 msgid "This command resizes a btrfs filesystem."
6681 #: ../fish/guestfish-actions.pod:551
6682 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:551
6683 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:841
6684 #: ../src/guestfs-actions.pod:841
6686 "Note that unlike other resize calls, the filesystem has to be mounted and "
6687 "the parameter is the mountpoint not the device (this is a requirement of "
6692 #: ../fish/guestfish-actions.pod:555 ../fish/guestfish-actions.pod:3417
6693 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:555
6694 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3417
6695 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:845
6696 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5189
6697 #: ../src/guestfs-actions.pod:845 ../src/guestfs-actions.pod:5189
6698 msgid "The optional parameters are:"
6702 #: ../fish/guestfish-actions.pod:559 ../fish/guestfish-actions.pod:3421
6703 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:559
6704 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3421
6705 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:849
6706 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5193
6707 #: ../src/guestfs-actions.pod:849 ../src/guestfs-actions.pod:5193
6712 #: ../fish/guestfish-actions.pod:561
6713 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:561
6714 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:851
6715 #: ../src/guestfs-actions.pod:851
6717 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
6718 "resized to the maximum size."
6722 #: ../fish/guestfish-actions.pod:566
6723 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:566
6724 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:856
6725 #: ../src/guestfs-actions.pod:856
6726 msgid "See also L<btrfs(8)>."
6730 #: ../fish/guestfish-actions.pod:570
6731 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:570
6732 msgid "case-sensitive-path"
6736 #: ../fish/guestfish-actions.pod:572
6737 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:572
6740 " case-sensitive-path path\n"
6745 #: ../fish/guestfish-actions.pod:574
6746 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:574
6747 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:890
6748 #: ../src/guestfs-actions.pod:890
6750 "This can be used to resolve case insensitive paths on a filesystem which is "
6751 "case sensitive. The use case is to resolve paths which you have read from "
6752 "Windows configuration files or the Windows Registry, to the true path."
6756 #: ../fish/guestfish-actions.pod:579
6757 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:579
6758 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:895
6759 #: ../src/guestfs-actions.pod:895
6761 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
6762 "(and probably others), which is that although the underlying filesystem is "
6763 "case-insensitive, the driver exports the filesystem to Linux as case-"
6768 #: ../fish/guestfish-actions.pod:584
6769 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:584
6770 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:900
6771 #: ../src/guestfs-actions.pod:900
6773 "One consequence of this is that special directories such as C<c:\\windows> "
6774 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
6775 "precise details of how they were created. In Windows itself this would not "
6780 #: ../fish/guestfish-actions.pod:590
6781 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:590
6782 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:906
6783 #: ../src/guestfs-actions.pod:906
6785 "Bug or feature? You decide: L<http://www.tuxera.com/community/ntfs-3g-faq/"
6790 #: ../fish/guestfish-actions.pod:593
6791 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:593
6792 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:909
6793 #: ../src/guestfs-actions.pod:909
6795 "This function resolves the true case of each element in the path and returns "
6796 "the case-sensitive path."
6800 #: ../fish/guestfish-actions.pod:596
6801 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:596
6803 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return C<\"/"
6804 "WINDOWS/system32\"> (the exact return value would depend on details of how "
6805 "the directories were originally created under Windows)."
6809 #: ../fish/guestfish-actions.pod:601
6810 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:601
6811 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:917
6812 #: ../src/guestfs-actions.pod:917
6813 msgid "I<Note>: This function does not handle drive names, backslashes etc."
6817 #: ../fish/guestfish-actions.pod:604
6818 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:604
6819 msgid "See also L</realpath>."
6823 #: ../fish/guestfish-actions.pod:606
6824 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:606
6829 #: ../fish/guestfish-actions.pod:608
6830 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:608
6838 #: ../fish/guestfish-actions.pod:610 ../fish/guestfish-actions.pod:3837
6839 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:610
6840 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3837
6841 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:933
6842 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5832
6843 #: ../src/guestfs-actions.pod:933 ../src/guestfs-actions.pod:5832
6844 msgid "Return the contents of the file named C<path>."
6848 #: ../fish/guestfish-actions.pod:612
6849 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:612
6851 "Note that this function cannot correctly handle binary files (specifically, "
6852 "files containing C<\\0> character which is treated as end of string). For "
6853 "those you need to use the L</read-file> or L</download> functions which have "
6854 "a more complex interface."
6858 #: ../fish/guestfish-actions.pod:617 ../fish/guestfish-actions.pod:752
6859 #: ../fish/guestfish-actions.pod:764 ../fish/guestfish-actions.pod:940
6860 #: ../fish/guestfish-actions.pod:950 ../fish/guestfish-actions.pod:1017
6861 #: ../fish/guestfish-actions.pod:1027 ../fish/guestfish-actions.pod:1219
6862 #: ../fish/guestfish-actions.pod:1526 ../fish/guestfish-actions.pod:1536
6863 #: ../fish/guestfish-actions.pod:1564 ../fish/guestfish-actions.pod:1579
6864 #: ../fish/guestfish-actions.pod:1589 ../fish/guestfish-actions.pod:1608
6865 #: ../fish/guestfish-actions.pod:3707 ../fish/guestfish-actions.pod:3722
6866 #: ../fish/guestfish-actions.pod:3798 ../fish/guestfish-actions.pod:3815
6867 #: ../fish/guestfish-actions.pod:3830 ../fish/guestfish-actions.pod:4499
6868 #: ../fish/guestfish-actions.pod:4545 ../fish/guestfish-actions.pod:4630
6869 #: ../fish/guestfish-actions.pod:4645 ../fish/guestfish-actions.pod:5051
6870 #: ../fish/guestfish-actions.pod:5063 ../fish/guestfish-actions.pod:5081
6871 #: ../fish/guestfish-actions.pod:5098 ../fish/guestfish-actions.pod:5108
6872 #: ../fish/guestfish-actions.pod:5157 ../fish/guestfish-actions.pod:5167
6873 #: ../fish/guestfish-actions.pod:5196 ../fish/guestfish-actions.pod:5206
6874 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:617
6875 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:752
6876 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:764
6877 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:940
6878 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:950
6879 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1017
6880 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1027
6881 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1219
6882 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1526
6883 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1536
6884 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1564
6885 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1579
6886 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1589
6887 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1608
6888 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3707
6889 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3722
6890 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3798
6891 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3815
6892 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3830
6893 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4499
6894 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4545
6895 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4630
6896 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4645
6897 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5051
6898 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5063
6899 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5081
6900 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5098
6901 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5108
6902 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5157
6903 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5167
6904 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5196
6905 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5206
6906 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:943
6907 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1122
6908 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1142
6909 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1438
6910 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1457
6911 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1560
6912 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1579
6913 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1825
6914 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2296
6915 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2315
6916 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2358
6917 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2382
6918 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2399
6919 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2428
6920 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5614
6921 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5640
6922 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5771
6923 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5797
6924 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5821
6925 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6772
6926 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6827
6927 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6973
6928 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6997
6929 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7662
6930 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7682
6931 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7708
6932 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7734
6933 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7753
6934 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7839
6935 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7858
6936 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7904
6937 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7923
6938 #: ../src/guestfs-actions.pod:943 ../src/guestfs-actions.pod:1122
6939 #: ../src/guestfs-actions.pod:1142 ../src/guestfs-actions.pod:1438
6940 #: ../src/guestfs-actions.pod:1457 ../src/guestfs-actions.pod:1560
6941 #: ../src/guestfs-actions.pod:1579 ../src/guestfs-actions.pod:1825
6942 #: ../src/guestfs-actions.pod:2296 ../src/guestfs-actions.pod:2315
6943 #: ../src/guestfs-actions.pod:2358 ../src/guestfs-actions.pod:2382
6944 #: ../src/guestfs-actions.pod:2399 ../src/guestfs-actions.pod:2428
6945 #: ../src/guestfs-actions.pod:5614 ../src/guestfs-actions.pod:5640
6946 #: ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5797
6947 #: ../src/guestfs-actions.pod:5821 ../src/guestfs-actions.pod:6772
6948 #: ../src/guestfs-actions.pod:6827 ../src/guestfs-actions.pod:6973
6949 #: ../src/guestfs-actions.pod:6997 ../src/guestfs-actions.pod:7662
6950 #: ../src/guestfs-actions.pod:7682 ../src/guestfs-actions.pod:7708
6951 #: ../src/guestfs-actions.pod:7734 ../src/guestfs-actions.pod:7753
6952 #: ../src/guestfs-actions.pod:7839 ../src/guestfs-actions.pod:7858
6953 #: ../src/guestfs-actions.pod:7904 ../src/guestfs-actions.pod:7923
6955 "Because of the message protocol, there is a transfer limit of somewhere "
6956 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
6960 #: ../fish/guestfish-actions.pod:620
6961 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:620
6966 #: ../fish/guestfish-actions.pod:622
6967 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:622
6970 " checksum csumtype path\n"
6975 #: ../fish/guestfish-actions.pod:624
6976 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:624
6977 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:955
6978 #: ../src/guestfs-actions.pod:955
6980 "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
6984 #: ../fish/guestfish-actions.pod:627
6985 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:627
6986 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:958
6987 #: ../src/guestfs-actions.pod:958
6989 "The type of checksum to compute is given by the C<csumtype> parameter which "
6990 "must have one of the following values:"
6994 #: ../fish/guestfish-actions.pod:632
6995 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:632
6996 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:963
6997 #: ../src/guestfs-actions.pod:963
7002 #: ../fish/guestfish-actions.pod:634
7003 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:634
7004 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:965
7005 #: ../src/guestfs-actions.pod:965
7007 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
7012 #: ../fish/guestfish-actions.pod:637
7013 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:637
7014 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:968
7015 #: ../src/guestfs-actions.pod:968
7020 #: ../fish/guestfish-actions.pod:639
7021 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:639
7022 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:970
7023 #: ../src/guestfs-actions.pod:970
7024 msgid "Compute the MD5 hash (using the C<md5sum> program)."
7028 #: ../fish/guestfish-actions.pod:641
7029 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:641
7030 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:972
7031 #: ../src/guestfs-actions.pod:972
7036 #: ../fish/guestfish-actions.pod:643
7037 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:643
7038 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:974
7039 #: ../src/guestfs-actions.pod:974
7040 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
7044 #: ../fish/guestfish-actions.pod:645
7045 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:645
7046 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:976
7047 #: ../src/guestfs-actions.pod:976
7052 #: ../fish/guestfish-actions.pod:647
7053 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:647
7054 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:978
7055 #: ../src/guestfs-actions.pod:978
7056 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
7060 #: ../fish/guestfish-actions.pod:649
7061 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:649
7062 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:980
7063 #: ../src/guestfs-actions.pod:980
7068 #: ../fish/guestfish-actions.pod:651
7069 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:651
7070 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:982
7071 #: ../src/guestfs-actions.pod:982
7072 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
7076 #: ../fish/guestfish-actions.pod:653
7077 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:653
7078 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:984
7079 #: ../src/guestfs-actions.pod:984
7084 #: ../fish/guestfish-actions.pod:655
7085 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:655
7086 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:986
7087 #: ../src/guestfs-actions.pod:986
7088 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
7092 #: ../fish/guestfish-actions.pod:657
7093 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:657
7094 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:988
7095 #: ../src/guestfs-actions.pod:988
7100 #: ../fish/guestfish-actions.pod:659
7101 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:659
7102 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:990
7103 #: ../src/guestfs-actions.pod:990
7104 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
7108 #: ../fish/guestfish-actions.pod:663
7109 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:663
7110 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:994
7111 #: ../src/guestfs-actions.pod:994
7112 msgid "The checksum is returned as a printable string."
7116 #: ../fish/guestfish-actions.pod:665
7117 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:665
7118 msgid "To get the checksum for a device, use L</checksum-device>."
7122 #: ../fish/guestfish-actions.pod:667
7123 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:667
7124 msgid "To get the checksums for many files, use L</checksums-out>."
7128 #: ../fish/guestfish-actions.pod:669
7129 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:669
7130 msgid "checksum-device"
7134 #: ../fish/guestfish-actions.pod:671
7135 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:671
7138 " checksum-device csumtype device\n"
7143 #: ../fish/guestfish-actions.pod:673
7144 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:673
7146 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
7147 "device named C<device>. For the types of checksums supported see the L</"
7148 "checksum> command."
7152 #: ../fish/guestfish-actions.pod:677
7153 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:677
7154 msgid "checksums-out"
7158 #: ../fish/guestfish-actions.pod:679
7159 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:679
7162 " checksums-out csumtype directory (sumsfile|-)\n"
7167 #: ../fish/guestfish-actions.pod:681
7168 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:681
7169 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1029
7170 #: ../src/guestfs-actions.pod:1029
7172 "This command computes the checksums of all regular files in C<directory> and "
7173 "then emits a list of those checksums to the local output file C<sumsfile>."
7177 #: ../fish/guestfish-actions.pod:685
7178 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:685
7179 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1033
7180 #: ../src/guestfs-actions.pod:1033
7182 "This can be used for verifying the integrity of a virtual machine. However "
7183 "to be properly secure you should pay attention to the output of the checksum "
7184 "command (it uses the ones from GNU coreutils). In particular when the "
7185 "filename is not printable, coreutils uses a special backslash syntax. For "
7186 "more information, see the GNU coreutils info file."
7190 #: ../fish/guestfish-actions.pod:695
7191 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:695
7196 #: ../fish/guestfish-actions.pod:697
7197 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:697
7200 " chmod mode path\n"
7205 #: ../fish/guestfish-actions.pod:699
7206 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:699
7207 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1052
7208 #: ../src/guestfs-actions.pod:1052
7210 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
7215 #: ../fish/guestfish-actions.pod:702
7216 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:702
7217 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1055
7218 #: ../src/guestfs-actions.pod:1055
7220 "I<Note>: When using this command from guestfish, C<mode> by default would be "
7221 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
7226 #: ../fish/guestfish-actions.pod:706 ../fish/guestfish-actions.pod:3060
7227 #: ../fish/guestfish-actions.pod:3199 ../fish/guestfish-actions.pod:3209
7228 #: ../fish/guestfish-actions.pod:3219
7229 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:706
7230 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3060
7231 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3199
7232 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3209
7233 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3219
7234 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1059
7235 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4586
7236 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4795
7237 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4814
7238 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4833
7239 #: ../src/guestfs-actions.pod:1059 ../src/guestfs-actions.pod:4586
7240 #: ../src/guestfs-actions.pod:4795 ../src/guestfs-actions.pod:4814
7241 #: ../src/guestfs-actions.pod:4833
7242 msgid "The mode actually set is affected by the umask."
7246 #: ../fish/guestfish-actions.pod:708
7247 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:708
7252 #: ../fish/guestfish-actions.pod:710
7253 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:710
7256 " chown owner group path\n"
7261 #: ../fish/guestfish-actions.pod:712
7262 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:712
7263 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1073
7264 #: ../src/guestfs-actions.pod:1073
7265 msgid "Change the file owner to C<owner> and group to C<group>."
7269 #: ../fish/guestfish-actions.pod:714 ../fish/guestfish-actions.pod:2495
7270 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:714
7271 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2495
7272 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1075
7273 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3657
7274 #: ../src/guestfs-actions.pod:1075 ../src/guestfs-actions.pod:3657
7276 "Only numeric uid and gid are supported. If you want to use names, you will "
7277 "need to locate and parse the password file yourself (Augeas support makes "
7278 "this relatively easy)."
7282 #: ../fish/guestfish-actions.pod:718
7283 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:718
7288 #: ../fish/guestfish-actions.pod:720
7289 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:720
7292 " command 'arguments ...'\n"
7297 #: ../fish/guestfish-actions.pod:722
7298 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:722
7299 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1089
7300 #: ../src/guestfs-actions.pod:1089
7302 "This call runs a command from the guest filesystem. The filesystem must be "
7303 "mounted, and must contain a compatible operating system (ie. something "
7304 "Linux, with the same or compatible processor architecture)."
7308 #: ../fish/guestfish-actions.pod:727
7309 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:727
7311 "The single parameter is an argv-style list of arguments. The first element "
7312 "is the name of the program to run. Subsequent elements are parameters. The "
7313 "list must be non-empty (ie. must contain a program name). Note that the "
7314 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
7318 #: ../fish/guestfish-actions.pod:734
7319 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:734
7320 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1101
7321 #: ../src/guestfs-actions.pod:1101
7322 msgid "The return value is anything printed to I<stdout> by the command."
7326 #: ../fish/guestfish-actions.pod:737
7327 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:737
7328 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1104
7329 #: ../src/guestfs-actions.pod:1104
7331 "If the command returns a non-zero exit status, then this function returns an "
7332 "error message. The error message string is the content of I<stderr> from "
7337 #: ../fish/guestfish-actions.pod:741
7338 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:741
7339 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1108
7340 #: ../src/guestfs-actions.pod:1108
7342 "The C<$PATH> environment variable will contain at least C</usr/bin> and C</"
7343 "bin>. If you require a program from another location, you should provide "
7344 "the full path in the first parameter."
7348 #: ../fish/guestfish-actions.pod:746
7349 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:746
7350 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1113
7351 #: ../src/guestfs-actions.pod:1113
7353 "Shared libraries and data files required by the program must be available on "
7354 "filesystems which are mounted in the correct places. It is the caller's "
7355 "responsibility to ensure all filesystems that are needed are mounted at the "
7360 #: ../fish/guestfish-actions.pod:755
7361 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:755
7362 msgid "command-lines"
7366 #: ../fish/guestfish-actions.pod:757
7367 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:757
7370 " command-lines 'arguments ...'\n"
7375 #: ../fish/guestfish-actions.pod:759
7376 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:759
7378 "This is the same as L</command>, but splits the result into a list of lines."
7382 #: ../fish/guestfish-actions.pod:762
7383 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:762
7384 msgid "See also: L</sh-lines>"
7388 #: ../fish/guestfish-actions.pod:767
7389 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:767
7394 #: ../fish/guestfish-actions.pod:769
7395 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:769
7398 " config qemuparam qemuvalue\n"
7403 #: ../fish/guestfish-actions.pod:771
7404 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:771
7405 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1154
7406 #: ../src/guestfs-actions.pod:1154
7408 "This can be used to add arbitrary qemu command line parameters of the form "
7409 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
7410 "setting some parameters which would interfere with parameters that we use."
7414 #: ../fish/guestfish-actions.pod:776
7415 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:776
7416 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1159
7417 #: ../src/guestfs-actions.pod:1159
7418 msgid "The first character of C<param> string must be a C<-> (dash)."
7422 #: ../fish/guestfish-actions.pod:778
7423 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:778
7424 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1161
7425 #: ../src/guestfs-actions.pod:1161
7426 msgid "C<value> can be NULL."
7430 #: ../fish/guestfish-actions.pod:780
7431 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:780
7436 #: ../fish/guestfish-actions.pod:782
7437 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:782
7440 " copy-size src dest size\n"
7445 #: ../fish/guestfish-actions.pod:784
7446 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:784
7447 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1175
7448 #: ../src/guestfs-actions.pod:1175
7450 "This command copies exactly C<size> bytes from one source device or file "
7451 "C<src> to another destination device or file C<dest>."
7455 #: ../fish/guestfish-actions.pod:787
7456 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:787
7457 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1178
7458 #: ../src/guestfs-actions.pod:1178
7460 "Note this will fail if the source is too short or if the destination is not "
7465 #: ../fish/guestfish-actions.pod:790
7466 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:790
7471 #: ../fish/guestfish-actions.pod:792
7472 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:792
7480 #: ../fish/guestfish-actions.pod:794
7481 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:794
7482 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1197
7483 #: ../src/guestfs-actions.pod:1197
7485 "This copies a file from C<src> to C<dest> where C<dest> is either a "
7486 "destination filename or destination directory."
7490 #: ../fish/guestfish-actions.pod:797
7491 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:797
7496 #: ../fish/guestfish-actions.pod:799
7497 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:799
7505 #: ../fish/guestfish-actions.pod:801
7506 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:801
7507 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1211
7508 #: ../src/guestfs-actions.pod:1211
7510 "This copies a file or directory from C<src> to C<dest> recursively using the "
7515 #: ../fish/guestfish-actions.pod:804
7516 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:804
7521 #: ../fish/guestfish-actions.pod:806
7522 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:806
7530 #: ../fish/guestfish-actions.pod:808
7531 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:808
7532 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1225
7533 #: ../src/guestfs-actions.pod:1225
7535 "This command copies from one source device or file C<src> to another "
7536 "destination device or file C<dest>. Normally you would use this to copy to "
7537 "or from a device or partition, for example to duplicate a filesystem."
7541 #: ../fish/guestfish-actions.pod:813
7542 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:813
7544 "If the destination is a device, it must be as large or larger than the "
7545 "source file or device, otherwise the copy will fail. This command cannot do "
7546 "partial copies (see L</copy-size>)."
7550 #: ../fish/guestfish-actions.pod:817
7551 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:817
7556 #: ../fish/guestfish-actions.pod:819
7557 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:819
7565 #: ../fish/guestfish-actions.pod:821
7566 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:821
7567 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1243
7568 #: ../src/guestfs-actions.pod:1243
7569 msgid "This command runs the C<df> command to report disk space used."
7573 #: ../fish/guestfish-actions.pod:823 ../fish/guestfish-actions.pod:834
7574 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:823
7575 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:834
7577 "This command is mostly useful for interactive sessions. It is I<not> "
7578 "intended that you try to parse the output string. Use L</statvfs> from "
7583 #: ../fish/guestfish-actions.pod:827
7584 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:827
7589 #: ../fish/guestfish-actions.pod:829
7590 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:829
7598 #: ../fish/guestfish-actions.pod:831
7599 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:831
7600 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1259
7601 #: ../src/guestfs-actions.pod:1259
7603 "This command runs the C<df -h> command to report disk space used in human-"
7608 #: ../fish/guestfish-actions.pod:838
7609 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:838
7614 #: ../fish/guestfish-actions.pod:840
7615 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:840
7623 #: ../fish/guestfish-actions.pod:842
7624 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:842
7625 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1276
7626 #: ../src/guestfs-actions.pod:1276
7628 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
7629 "This is sometimes useful for extended debugging of problems."
7633 #: ../fish/guestfish-actions.pod:846
7634 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:846
7636 "Another way to get the same information is to enable verbose messages with "
7637 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
7638 "before running the program."
7642 #: ../fish/guestfish-actions.pod:851
7643 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:851
7648 #: ../fish/guestfish-actions.pod:853
7649 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:853
7652 " download remotefilename (filename|-)\n"
7657 #: ../fish/guestfish-actions.pod:855 ../fish/guestfish-actions.pod:868
7658 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:855
7659 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:868
7660 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1297
7661 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1322
7662 #: ../src/guestfs-actions.pod:1297 ../src/guestfs-actions.pod:1322
7664 "Download file C<remotefilename> and save it as C<filename> on the local "
7669 #: ../fish/guestfish-actions.pod:858 ../fish/guestfish-actions.pod:4803
7670 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:858
7671 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4803
7672 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1300
7673 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7232
7674 #: ../src/guestfs-actions.pod:1300 ../src/guestfs-actions.pod:7232
7675 msgid "C<filename> can also be a named pipe."
7679 #: ../fish/guestfish-actions.pod:860
7680 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:860
7681 msgid "See also L</upload>, L</cat>."
7685 #: ../fish/guestfish-actions.pod:864
7686 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:864
7687 msgid "download-offset"
7691 #: ../fish/guestfish-actions.pod:866
7692 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:866
7695 " download-offset remotefilename (filename|-) offset size\n"
7700 #: ../fish/guestfish-actions.pod:871
7701 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:871
7702 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1325
7703 #: ../src/guestfs-actions.pod:1325
7705 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
7706 "region must be within the file or device)."
7710 #: ../fish/guestfish-actions.pod:874
7711 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:874
7713 "Note that there is no limit on the amount of data that can be downloaded "
7714 "with this call, unlike with L</pread>, and this call always reads the full "
7715 "amount unless an error occurs."
7719 #: ../fish/guestfish-actions.pod:879
7720 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:879
7721 msgid "See also L</download>, L</pread>."
7725 #: ../fish/guestfish-actions.pod:883
7726 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:883
7731 #: ../fish/guestfish-actions.pod:885
7732 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:885
7735 " drop-caches whattodrop\n"
7740 #: ../fish/guestfish-actions.pod:887
7741 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:887
7742 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1350
7743 #: ../src/guestfs-actions.pod:1350
7745 "This instructs the guest kernel to drop its page cache, and/or dentries and "
7746 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
7747 "to drop, see L<http://linux-mm.org/Drop_Caches>"
7751 #: ../fish/guestfish-actions.pod:892
7752 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:892
7753 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1355
7754 #: ../src/guestfs-actions.pod:1355
7755 msgid "Setting C<whattodrop> to 3 should drop everything."
7759 #: ../fish/guestfish-actions.pod:894
7760 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:894
7761 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1357
7762 #: ../src/guestfs-actions.pod:1357
7764 "This automatically calls L<sync(2)> before the operation, so that the "
7765 "maximum guest memory is freed."
7769 #: ../fish/guestfish-actions.pod:897
7770 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:897
7775 #: ../fish/guestfish-actions.pod:899
7776 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:899
7784 #: ../fish/guestfish-actions.pod:901
7785 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:901
7786 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1370
7787 #: ../src/guestfs-actions.pod:1370
7789 "This command runs the C<du -s> command to estimate file space usage for "
7794 #: ../fish/guestfish-actions.pod:904
7795 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:904
7796 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1373
7797 #: ../src/guestfs-actions.pod:1373
7799 "C<path> can be a file or a directory. If C<path> is a directory then the "
7800 "estimate includes the contents of the directory and all subdirectories "
7805 #: ../fish/guestfish-actions.pod:908
7806 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:908
7807 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1377
7808 #: ../src/guestfs-actions.pod:1377
7810 "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
7814 #: ../fish/guestfish-actions.pod:911
7815 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:911
7820 #: ../fish/guestfish-actions.pod:913
7821 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:913
7824 " e2fsck-f device\n"
7829 #: ../fish/guestfish-actions.pod:915
7830 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:915
7831 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1395
7832 #: ../src/guestfs-actions.pod:1395
7834 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
7835 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
7840 #: ../fish/guestfish-actions.pod:919
7841 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:919
7843 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
7844 "should use L</fsck>."
7848 #: ../fish/guestfish-actions.pod:922
7849 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:922
7854 #: ../fish/guestfish-actions.pod:924
7855 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:924
7858 " echo-daemon 'words ...'\n"
7863 #: ../fish/guestfish-actions.pod:926
7864 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:926
7865 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1412
7866 #: ../src/guestfs-actions.pod:1412
7868 "This command concatenates the list of C<words> passed with single spaces "
7869 "between them and returns the resulting string."
7873 #: ../fish/guestfish-actions.pod:929
7874 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:929
7875 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1415
7876 #: ../src/guestfs-actions.pod:1415
7877 msgid "You can use this command to test the connection through to the daemon."
7881 #: ../fish/guestfish-actions.pod:931
7882 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:931
7883 msgid "See also L</ping-daemon>."
7887 #: ../fish/guestfish-actions.pod:933
7888 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:933
7893 #: ../fish/guestfish-actions.pod:935
7894 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:935
7897 " egrep regex path\n"
7902 #: ../fish/guestfish-actions.pod:937
7903 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:937
7904 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1431
7905 #: ../src/guestfs-actions.pod:1431
7907 "This calls the external C<egrep> program and returns the matching lines."
7911 #: ../fish/guestfish-actions.pod:943
7912 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:943
7917 #: ../fish/guestfish-actions.pod:945
7918 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:945
7921 " egrepi regex path\n"
7926 #: ../fish/guestfish-actions.pod:947
7927 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:947
7928 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1450
7929 #: ../src/guestfs-actions.pod:1450
7931 "This calls the external C<egrep -i> program and returns the matching lines."
7935 #: ../fish/guestfish-actions.pod:953
7936 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:953
7941 #: ../fish/guestfish-actions.pod:955
7942 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:955
7945 " equal file1 file2\n"
7950 #: ../fish/guestfish-actions.pod:957
7951 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:957
7952 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1469
7953 #: ../src/guestfs-actions.pod:1469
7955 "This compares the two files C<file1> and C<file2> and returns true if their "
7956 "content is exactly equal, or false otherwise."
7960 #: ../fish/guestfish-actions.pod:960
7961 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:960
7962 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1472
7963 #: ../src/guestfs-actions.pod:1472
7964 msgid "The external L<cmp(1)> program is used for the comparison."
7968 #: ../fish/guestfish-actions.pod:962
7969 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:962
7974 #: ../fish/guestfish-actions.pod:964
7975 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:964
7983 #: ../fish/guestfish-actions.pod:966
7984 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:966
7985 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1484
7986 #: ../src/guestfs-actions.pod:1484
7988 "This returns C<true> if and only if there is a file, directory (or anything) "
7989 "with the given C<path> name."
7993 #: ../fish/guestfish-actions.pod:969
7994 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:969
7995 msgid "See also L</is-file>, L</is-dir>, L</stat>."
7999 #: ../fish/guestfish-actions.pod:971
8000 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:971
8005 #: ../fish/guestfish-actions.pod:973
8006 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:973
8009 " fallocate path len\n"
8014 #: ../fish/guestfish-actions.pod:975 ../fish/guestfish-actions.pod:994
8015 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:975
8016 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:994
8017 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1500
8018 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1526
8019 #: ../src/guestfs-actions.pod:1500 ../src/guestfs-actions.pod:1526
8021 "This command preallocates a file (containing zero bytes) named C<path> of "
8022 "size C<len> bytes. If the file exists already, it is overwritten."
8026 #: ../fish/guestfish-actions.pod:979
8027 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:979
8028 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1504
8029 #: ../src/guestfs-actions.pod:1504
8031 "Do not confuse this with the guestfish-specific C<alloc> command which "
8032 "allocates a file in the host and attaches it as a device."
8036 #: ../fish/guestfish-actions.pod:983
8037 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:983
8038 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1510
8039 #: ../src/guestfs-actions.pod:1510
8041 "This function is deprecated. In new code, use the C<fallocate64> call "
8046 #: ../fish/guestfish-actions.pod:990
8047 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:990
8052 #: ../fish/guestfish-actions.pod:992
8053 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:992
8056 " fallocate64 path len\n"
8061 #: ../fish/guestfish-actions.pod:998
8062 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:998
8064 "Note that this call allocates disk blocks for the file. To create a sparse "
8065 "file use L</truncate-size> instead."
8069 #: ../fish/guestfish-actions.pod:1001
8070 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1001
8072 "The deprecated call L</fallocate> does the same, but owing to an oversight "
8073 "it only allowed 30 bit lengths to be specified, effectively limiting the "
8074 "maximum size of files created through that call to 1GB."
8078 #: ../fish/guestfish-actions.pod:1006
8079 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1006
8080 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1538
8081 #: ../src/guestfs-actions.pod:1538
8083 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
8084 "commands which create a file in the host and attach it as a device."
8088 #: ../fish/guestfish-actions.pod:1010
8089 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1010
8094 #: ../fish/guestfish-actions.pod:1012
8095 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1012
8098 " fgrep pattern path\n"
8103 #: ../fish/guestfish-actions.pod:1014
8104 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1014
8105 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1553
8106 #: ../src/guestfs-actions.pod:1553
8108 "This calls the external C<fgrep> program and returns the matching lines."
8112 #: ../fish/guestfish-actions.pod:1020
8113 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1020
8118 #: ../fish/guestfish-actions.pod:1022
8119 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1022
8122 " fgrepi pattern path\n"
8127 #: ../fish/guestfish-actions.pod:1024
8128 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1024
8129 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1572
8130 #: ../src/guestfs-actions.pod:1572
8132 "This calls the external C<fgrep -i> program and returns the matching lines."
8136 #: ../fish/guestfish-actions.pod:1030
8137 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1030
8142 #: ../fish/guestfish-actions.pod:1032
8143 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1032
8151 #: ../fish/guestfish-actions.pod:1034
8152 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1034
8153 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1590
8154 #: ../src/guestfs-actions.pod:1590
8156 "This call uses the standard L<file(1)> command to determine the type or "
8157 "contents of the file."
8161 #: ../fish/guestfish-actions.pod:1037
8162 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1037
8163 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1593
8164 #: ../src/guestfs-actions.pod:1593
8166 "This call will also transparently look inside various types of compressed "
8171 #: ../fish/guestfish-actions.pod:1040
8172 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1040
8173 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1596
8174 #: ../src/guestfs-actions.pod:1596
8176 "The exact command which runs is C<file -zb path>. Note in particular that "
8177 "the filename is not prepended to the output (the I<-b> option)."
8181 #: ../fish/guestfish-actions.pod:1044
8182 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1044
8183 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1600
8184 #: ../src/guestfs-actions.pod:1600
8186 "The output depends on the output of the underlying L<file(1)> command and it "
8187 "can change in future in ways beyond our control. In other words, the output "
8188 "is not guaranteed by the ABI."
8192 #: ../fish/guestfish-actions.pod:1048
8193 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1048
8195 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
8196 "(etc), L</is-zero>."
8200 #: ../fish/guestfish-actions.pod:1051
8201 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1051
8202 msgid "file-architecture"
8206 #: ../fish/guestfish-actions.pod:1053
8207 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1053
8210 " file-architecture filename\n"
8215 #: ../fish/guestfish-actions.pod:1055
8216 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1055
8217 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1618
8218 #: ../src/guestfs-actions.pod:1618
8220 "This detects the architecture of the binary C<filename>, and returns it if "
8225 #: ../fish/guestfish-actions.pod:1058
8226 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1058
8227 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1621
8228 #: ../src/guestfs-actions.pod:1621
8229 msgid "Currently defined architectures are:"
8233 #: ../fish/guestfish-actions.pod:1062
8234 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1062
8235 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1625
8236 #: ../src/guestfs-actions.pod:1625
8241 #: ../fish/guestfish-actions.pod:1064
8242 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1064
8243 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1627
8244 #: ../src/guestfs-actions.pod:1627
8246 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
8247 "irrespective of the precise processor requirements of the binary."
8251 #: ../fish/guestfish-actions.pod:1067
8252 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1067
8253 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1630
8254 #: ../src/guestfs-actions.pod:1630
8259 #: ../fish/guestfish-actions.pod:1069
8260 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1069
8261 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1632
8262 #: ../src/guestfs-actions.pod:1632
8263 msgid "64 bit x86-64."
8267 #: ../fish/guestfish-actions.pod:1071
8268 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1071
8269 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1634
8270 #: ../src/guestfs-actions.pod:1634
8275 #: ../fish/guestfish-actions.pod:1073
8276 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1073
8277 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1636
8278 #: ../src/guestfs-actions.pod:1636
8279 msgid "32 bit SPARC."
8283 #: ../fish/guestfish-actions.pod:1075
8284 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1075
8285 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1638
8286 #: ../src/guestfs-actions.pod:1638
8291 #: ../fish/guestfish-actions.pod:1077
8292 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1077
8293 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1640
8294 #: ../src/guestfs-actions.pod:1640
8295 msgid "64 bit SPARC V9 and above."
8299 #: ../fish/guestfish-actions.pod:1079
8300 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1079
8301 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1642
8302 #: ../src/guestfs-actions.pod:1642
8307 #: ../fish/guestfish-actions.pod:1081
8308 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1081
8309 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1644
8310 #: ../src/guestfs-actions.pod:1644
8311 msgid "Intel Itanium."
8315 #: ../fish/guestfish-actions.pod:1083
8316 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1083
8317 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1646
8318 #: ../src/guestfs-actions.pod:1646
8323 #: ../fish/guestfish-actions.pod:1085
8324 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1085
8325 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1648
8326 #: ../src/guestfs-actions.pod:1648
8327 msgid "32 bit Power PC."
8331 #: ../fish/guestfish-actions.pod:1087
8332 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1087
8333 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1650
8334 #: ../src/guestfs-actions.pod:1650
8339 #: ../fish/guestfish-actions.pod:1089
8340 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1089
8341 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1652
8342 #: ../src/guestfs-actions.pod:1652
8343 msgid "64 bit Power PC."
8347 #: ../fish/guestfish-actions.pod:1093
8348 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1093
8349 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1656
8350 #: ../src/guestfs-actions.pod:1656
8351 msgid "Libguestfs may return other architecture strings in future."
8355 #: ../fish/guestfish-actions.pod:1095
8356 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1095
8357 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1658
8358 #: ../src/guestfs-actions.pod:1658
8359 msgid "The function works on at least the following types of files:"
8363 #: ../fish/guestfish-actions.pod:1101
8364 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1101
8365 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1664
8366 #: ../src/guestfs-actions.pod:1664
8367 msgid "many types of Un*x and Linux binary"
8371 #: ../fish/guestfish-actions.pod:1105
8372 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1105
8373 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1668
8374 #: ../src/guestfs-actions.pod:1668
8375 msgid "many types of Un*x and Linux shared library"
8379 #: ../fish/guestfish-actions.pod:1109
8380 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1109
8381 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1672
8382 #: ../src/guestfs-actions.pod:1672
8383 msgid "Windows Win32 and Win64 binaries"
8387 #: ../fish/guestfish-actions.pod:1113
8388 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1113
8389 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1676
8390 #: ../src/guestfs-actions.pod:1676
8391 msgid "Windows Win32 and Win64 DLLs"
8395 #: ../fish/guestfish-actions.pod:1115
8396 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1115
8397 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1678
8398 #: ../src/guestfs-actions.pod:1678
8399 msgid "Win32 binaries and DLLs return C<i386>."
8403 #: ../fish/guestfish-actions.pod:1117
8404 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1117
8405 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1680
8406 #: ../src/guestfs-actions.pod:1680
8407 msgid "Win64 binaries and DLLs return C<x86_64>."
8411 #: ../fish/guestfish-actions.pod:1121
8412 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1121
8413 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1684
8414 #: ../src/guestfs-actions.pod:1684
8415 msgid "Linux kernel modules"
8419 #: ../fish/guestfish-actions.pod:1125
8420 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1125
8421 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1688
8422 #: ../src/guestfs-actions.pod:1688
8423 msgid "Linux new-style initrd images"
8427 #: ../fish/guestfish-actions.pod:1129
8428 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1129
8429 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1692
8430 #: ../src/guestfs-actions.pod:1692
8431 msgid "some non-x86 Linux vmlinuz kernels"
8435 #: ../fish/guestfish-actions.pod:1133
8436 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1133
8437 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1696
8438 #: ../src/guestfs-actions.pod:1696
8439 msgid "What it can't do currently:"
8443 #: ../fish/guestfish-actions.pod:1139
8444 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1139
8445 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1702
8446 #: ../src/guestfs-actions.pod:1702
8447 msgid "static libraries (libfoo.a)"
8451 #: ../fish/guestfish-actions.pod:1143
8452 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1143
8453 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1706
8454 #: ../src/guestfs-actions.pod:1706
8455 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
8459 #: ../fish/guestfish-actions.pod:1147
8460 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1147
8461 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1710
8462 #: ../src/guestfs-actions.pod:1710
8463 msgid "x86 Linux vmlinuz kernels"
8467 #: ../fish/guestfish-actions.pod:1149
8468 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1149
8469 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1712
8470 #: ../src/guestfs-actions.pod:1712
8472 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
8473 "compressed code, and are horribly hard to unpack. If you want to find the "
8474 "architecture of a kernel, use the architecture of the associated initrd or "
8475 "kernel module(s) instead."
8479 #: ../fish/guestfish-actions.pod:1156
8480 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1156
8485 #: ../fish/guestfish-actions.pod:1158
8486 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1158
8494 #: ../fish/guestfish-actions.pod:1160
8495 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1160
8496 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1730
8497 #: ../src/guestfs-actions.pod:1730
8498 msgid "This command returns the size of C<file> in bytes."
8502 #: ../fish/guestfish-actions.pod:1162
8503 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1162
8505 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, L</is-"
8506 "file> etc. To get the size of block devices, use L</blockdev-getsize64>."
8510 #: ../fish/guestfish-actions.pod:1166
8511 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1166
8516 #: ../fish/guestfish-actions.pod:1168
8517 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1168
8520 " fill c len path\n"
8525 #: ../fish/guestfish-actions.pod:1170
8526 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1170
8527 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1748
8528 #: ../src/guestfs-actions.pod:1748
8530 "This command creates a new file called C<path>. The initial content of the "
8531 "file is C<len> octets of C<c>, where C<c> must be a number in the range C<"
8536 #: ../fish/guestfish-actions.pod:1174
8537 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1174
8539 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
8540 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
8545 #: ../fish/guestfish-actions.pod:1179
8546 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1179
8547 msgid "fill-pattern"
8551 #: ../fish/guestfish-actions.pod:1181
8552 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1181
8555 " fill-pattern pattern len path\n"
8560 #: ../fish/guestfish-actions.pod:1183
8561 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1183
8563 "This function is like L</fill> except that it creates a new file of length "
8564 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
8565 "is truncated if necessary to ensure the length of the file is exactly C<len> "
8570 #: ../fish/guestfish-actions.pod:1188
8571 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1188
8576 #: ../fish/guestfish-actions.pod:1190
8577 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1190
8585 #: ../fish/guestfish-actions.pod:1192
8586 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1192
8587 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1794
8588 #: ../src/guestfs-actions.pod:1794
8590 "This command lists out all files and directories, recursively, starting at "
8591 "C<directory>. It is essentially equivalent to running the shell command "
8592 "C<find directory -print> but some post-processing happens on the output, "
8597 #: ../fish/guestfish-actions.pod:1197
8598 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1197
8599 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1799
8600 #: ../src/guestfs-actions.pod:1799
8602 "This returns a list of strings I<without any prefix>. Thus if the directory "
8607 #: ../fish/guestfish-actions.pod:1200
8608 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1200
8609 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1802
8610 #: ../src/guestfs-actions.pod:1802
8620 #: ../fish/guestfish-actions.pod:1204
8621 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1204
8622 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
8626 #: ../fish/guestfish-actions.pod:1207
8627 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1207
8628 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1809
8629 #: ../src/guestfs-actions.pod:1809
8640 #: ../fish/guestfish-actions.pod:1212
8641 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1212
8642 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1814
8643 #: ../src/guestfs-actions.pod:1814
8644 msgid "If C<directory> is not a directory, then this command returns an error."
8648 #: ../fish/guestfish-actions.pod:1215
8649 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1215
8650 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1817
8651 #: ../src/guestfs-actions.pod:1817
8652 msgid "The returned list is sorted."
8656 #: ../fish/guestfish-actions.pod:1217
8657 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1217
8658 msgid "See also L</find0>."
8662 #: ../fish/guestfish-actions.pod:1222
8663 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1222
8668 #: ../fish/guestfish-actions.pod:1224
8669 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1224
8672 " find0 directory (files|-)\n"
8677 #: ../fish/guestfish-actions.pod:1226
8678 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1226
8679 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1837
8680 #: ../src/guestfs-actions.pod:1837
8682 "This command lists out all files and directories, recursively, starting at "
8683 "C<directory>, placing the resulting list in the external file called "
8688 #: ../fish/guestfish-actions.pod:1230
8689 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1230
8691 "This command works the same way as L</find> with the following exceptions:"
8695 #: ../fish/guestfish-actions.pod:1237
8696 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1237
8697 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1848
8698 #: ../src/guestfs-actions.pod:1848
8699 msgid "The resulting list is written to an external file."
8703 #: ../fish/guestfish-actions.pod:1241
8704 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1241
8705 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1852
8706 #: ../src/guestfs-actions.pod:1852
8708 "Items (filenames) in the result are separated by C<\\0> characters. See "
8709 "L<find(1)> option I<-print0>."
8713 #: ../fish/guestfish-actions.pod:1246
8714 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1246
8715 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1857
8716 #: ../src/guestfs-actions.pod:1857
8717 msgid "This command is not limited in the number of names that it can return."
8721 #: ../fish/guestfish-actions.pod:1251
8722 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1251
8723 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1862
8724 #: ../src/guestfs-actions.pod:1862
8725 msgid "The result list is not sorted."
8729 #: ../fish/guestfish-actions.pod:1257
8730 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1257
8731 msgid "findfs-label"
8735 #: ../fish/guestfish-actions.pod:1259
8736 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1259
8739 " findfs-label label\n"
8744 #: ../fish/guestfish-actions.pod:1261
8745 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1261
8746 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1876
8747 #: ../src/guestfs-actions.pod:1876
8749 "This command searches the filesystems and returns the one which has the "
8750 "given label. An error is returned if no such filesystem can be found."
8754 #: ../fish/guestfish-actions.pod:1265
8755 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1265
8756 msgid "To find the label of a filesystem, use L</vfs-label>."
8760 #: ../fish/guestfish-actions.pod:1267
8761 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1267
8766 #: ../fish/guestfish-actions.pod:1269
8767 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1269
8770 " findfs-uuid uuid\n"
8775 #: ../fish/guestfish-actions.pod:1271
8776 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1271
8777 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1893
8778 #: ../src/guestfs-actions.pod:1893
8780 "This command searches the filesystems and returns the one which has the "
8781 "given UUID. An error is returned if no such filesystem can be found."
8785 #: ../fish/guestfish-actions.pod:1275
8786 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1275
8787 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
8791 #: ../fish/guestfish-actions.pod:1277
8792 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1277
8797 #: ../fish/guestfish-actions.pod:1279
8798 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1279
8801 " fsck fstype device\n"
8806 #: ../fish/guestfish-actions.pod:1281
8807 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1281
8808 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1911
8809 #: ../src/guestfs-actions.pod:1911
8811 "This runs the filesystem checker (fsck) on C<device> which should have "
8812 "filesystem type C<fstype>."
8816 #: ../fish/guestfish-actions.pod:1284
8817 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1284
8818 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1914
8819 #: ../src/guestfs-actions.pod:1914
8821 "The returned integer is the status. See L<fsck(8)> for the list of status "
8822 "codes from C<fsck>."
8826 #: ../fish/guestfish-actions.pod:1293
8827 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1293
8828 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1923
8829 #: ../src/guestfs-actions.pod:1923
8830 msgid "Multiple status codes can be summed together."
8834 #: ../fish/guestfish-actions.pod:1297
8835 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1297
8836 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1927
8837 #: ../src/guestfs-actions.pod:1927
8839 "A non-zero return code can mean \"success\", for example if errors have been "
8840 "corrected on the filesystem."
8844 #: ../fish/guestfish-actions.pod:1302
8845 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1302
8846 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1932
8847 #: ../src/guestfs-actions.pod:1932
8848 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
8852 #: ../fish/guestfish-actions.pod:1307
8853 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1307
8854 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1937
8855 #: ../src/guestfs-actions.pod:1937
8857 "This command is entirely equivalent to running C<fsck -a -t fstype device>."
8861 #: ../fish/guestfish-actions.pod:1309
8862 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1309
8867 #: ../fish/guestfish-actions.pod:1311
8868 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1311
8876 #: ../fish/guestfish-actions.pod:1313
8877 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1313
8878 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1948
8879 #: ../src/guestfs-actions.pod:1948
8881 "Return the additional kernel options which are added to the guest kernel "
8886 #: ../fish/guestfish-actions.pod:1316
8887 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1316
8888 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1951
8889 #: ../src/guestfs-actions.pod:1951
8890 msgid "If C<NULL> then no options are added."
8894 #: ../fish/guestfish-actions.pod:1318
8895 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1318
8896 msgid "get-attach-method"
8900 #: ../fish/guestfish-actions.pod:1320
8901 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1320
8904 " get-attach-method\n"
8909 #: ../fish/guestfish-actions.pod:1322
8910 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1322
8911 msgid "Return the current attach method. See L</set-attach-method>."
8915 #: ../fish/guestfish-actions.pod:1324
8916 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1324
8917 msgid "get-autosync"
8921 #: ../fish/guestfish-actions.pod:1326
8922 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1326
8930 #: ../fish/guestfish-actions.pod:1328
8931 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1328
8932 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1976
8933 #: ../src/guestfs-actions.pod:1976
8934 msgid "Get the autosync flag."
8938 #: ../fish/guestfish-actions.pod:1330
8939 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1330
8944 #: ../fish/guestfish-actions.pod:1332
8945 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1332
8953 #: ../fish/guestfish-actions.pod:1334
8954 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1334
8955 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1987
8956 #: ../src/guestfs-actions.pod:1987
8957 msgid "Return the direct appliance mode flag."
8961 #: ../fish/guestfish-actions.pod:1336
8962 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1336
8967 #: ../fish/guestfish-actions.pod:1338
8968 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1338
8971 " get-e2label device\n"
8976 #: ../fish/guestfish-actions.pod:1340
8977 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1340
8978 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1999
8979 #: ../src/guestfs-actions.pod:1999
8981 "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
8985 #: ../fish/guestfish-actions.pod:1343
8986 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1343
8987 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2005
8988 #: ../src/guestfs-actions.pod:2005
8990 "This function is deprecated. In new code, use the C<vfs_label> call instead."
8994 #: ../fish/guestfish-actions.pod:1350
8995 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1350
9000 #: ../fish/guestfish-actions.pod:1352
9001 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1352
9004 " get-e2uuid device\n"
9009 #: ../fish/guestfish-actions.pod:1354
9010 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1354
9011 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2020
9012 #: ../src/guestfs-actions.pod:2020
9014 "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
9018 #: ../fish/guestfish-actions.pod:1357
9019 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1357
9020 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2026
9021 #: ../src/guestfs-actions.pod:2026
9023 "This function is deprecated. In new code, use the C<vfs_uuid> call instead."
9027 #: ../fish/guestfish-actions.pod:1364
9028 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1364
9033 #: ../fish/guestfish-actions.pod:1366
9034 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1366
9042 #: ../fish/guestfish-actions.pod:1368
9043 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1368
9044 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2040
9045 #: ../src/guestfs-actions.pod:2040
9047 "This gets the memory size in megabytes allocated to the qemu subprocess."
9051 #: ../fish/guestfish-actions.pod:1371
9052 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1371
9054 "If L</set-memsize> was not called on this handle, and if "
9055 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
9056 "value for memsize."
9060 #: ../fish/guestfish-actions.pod:1375 ../fish/guestfish-actions.pod:1432
9061 #: ../fish/guestfish-actions.pod:4163 ../fish/guestfish-actions.pod:4265
9062 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1375
9063 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1432
9064 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4163
9065 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4265
9066 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2047
9067 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2139
9068 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6293
9069 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6419
9070 #: ../src/guestfs-actions.pod:2047 ../src/guestfs-actions.pod:2139
9071 #: ../src/guestfs-actions.pod:6293 ../src/guestfs-actions.pod:6419
9073 "For more information on the architecture of libguestfs, see L<guestfs(3)>."
9077 #: ../fish/guestfish-actions.pod:1378
9078 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1378
9083 #: ../fish/guestfish-actions.pod:1380
9084 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1380
9092 #: ../fish/guestfish-actions.pod:1382
9093 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1382
9094 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2059
9095 #: ../src/guestfs-actions.pod:2059
9096 msgid "This returns the enable network flag."
9100 #: ../fish/guestfish-actions.pod:1384
9101 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1384
9106 #: ../fish/guestfish-actions.pod:1386
9107 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1386
9115 #: ../fish/guestfish-actions.pod:1388
9116 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1388
9117 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2070
9118 #: ../src/guestfs-actions.pod:2070
9119 msgid "Return the current search path."
9123 #: ../fish/guestfish-actions.pod:1390
9124 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1390
9125 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2072
9126 #: ../src/guestfs-actions.pod:2072
9128 "This is always non-NULL. If it wasn't set already, then this will return "
9133 #: ../fish/guestfish-actions.pod:1393
9134 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1393
9139 #: ../fish/guestfish-actions.pod:1395
9140 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1395
9148 #: ../fish/guestfish-actions.pod:1397
9149 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1397
9150 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2085
9151 #: ../src/guestfs-actions.pod:2085
9152 msgid "This returns the process group flag."
9156 #: ../fish/guestfish-actions.pod:1399
9157 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1399
9162 #: ../fish/guestfish-actions.pod:1401
9163 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1401
9168 #: ../fish/guestfish-actions.pod:1403
9169 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1403
9177 #: ../fish/guestfish-actions.pod:1405
9178 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1405
9179 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2096
9180 #: ../src/guestfs-actions.pod:2096
9182 "Return the process ID of the qemu subprocess. If there is no qemu "
9183 "subprocess, then this will return an error."
9187 #: ../fish/guestfish-actions.pod:1408
9188 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1408
9189 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2099
9190 #: ../src/guestfs-actions.pod:2099
9191 msgid "This is an internal call used for debugging and testing."
9195 #: ../fish/guestfish-actions.pod:1410
9196 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1410
9201 #: ../fish/guestfish-actions.pod:1412
9202 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1412
9210 #: ../fish/guestfish-actions.pod:1414
9211 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1414
9212 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2110
9213 #: ../src/guestfs-actions.pod:2110
9214 msgid "Return the current qemu binary."
9218 #: ../fish/guestfish-actions.pod:1416
9219 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1416
9220 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2112
9221 #: ../src/guestfs-actions.pod:2112
9223 "This is always non-NULL. If it wasn't set already, then this will return "
9224 "the default qemu binary name."
9228 #: ../fish/guestfish-actions.pod:1419
9229 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1419
9230 msgid "get-recovery-proc"
9234 #: ../fish/guestfish-actions.pod:1421
9235 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1421
9238 " get-recovery-proc\n"
9243 #: ../fish/guestfish-actions.pod:1423
9244 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1423
9245 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2125
9246 #: ../src/guestfs-actions.pod:2125
9247 msgid "Return the recovery process enabled flag."
9251 #: ../fish/guestfish-actions.pod:1425
9252 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1425
9257 #: ../fish/guestfish-actions.pod:1427
9258 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1427
9266 #: ../fish/guestfish-actions.pod:1429
9267 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1429
9269 "This returns the current setting of the selinux flag which is passed to the "
9270 "appliance at boot time. See L</set-selinux>."
9274 #: ../fish/guestfish-actions.pod:1435
9275 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1435
9280 #: ../fish/guestfish-actions.pod:1437
9281 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1437
9289 #: ../fish/guestfish-actions.pod:1439
9290 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1439
9291 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2151
9292 #: ../src/guestfs-actions.pod:2151
9294 "This returns the current state as an opaque integer. This is only useful "
9295 "for printing debug and internal error messages."
9299 #: ../fish/guestfish-actions.pod:1442 ../fish/guestfish-actions.pod:2362
9300 #: ../fish/guestfish-actions.pod:2380 ../fish/guestfish-actions.pod:2418
9301 #: ../fish/guestfish-actions.pod:2434
9302 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1442
9303 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2362
9304 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2380
9305 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2418
9306 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2434
9307 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2154
9308 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3434
9309 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3463
9310 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3524
9311 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3551
9312 #: ../src/guestfs-actions.pod:2154 ../src/guestfs-actions.pod:3434
9313 #: ../src/guestfs-actions.pod:3463 ../src/guestfs-actions.pod:3524
9314 #: ../src/guestfs-actions.pod:3551
9315 msgid "For more information on states, see L<guestfs(3)>."
9319 #: ../fish/guestfish-actions.pod:1444
9320 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1444
9325 #: ../fish/guestfish-actions.pod:1446
9326 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1446
9334 #: ../fish/guestfish-actions.pod:1448
9335 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1448
9336 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2165
9337 #: ../src/guestfs-actions.pod:2165
9338 msgid "Return the command trace flag."
9342 #: ../fish/guestfish-actions.pod:1450
9343 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1450
9348 #: ../fish/guestfish-actions.pod:1452
9349 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1452
9357 #: ../fish/guestfish-actions.pod:1454
9358 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1454
9360 "Return the current umask. By default the umask is C<022> unless it has been "
9361 "set by calling L</umask>."
9365 #: ../fish/guestfish-actions.pod:1457
9366 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1457
9371 #: ../fish/guestfish-actions.pod:1459
9372 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1459
9380 #: ../fish/guestfish-actions.pod:1461
9381 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1461
9382 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2188
9383 #: ../src/guestfs-actions.pod:2188
9384 msgid "This returns the verbose messages flag."
9388 #: ../fish/guestfish-actions.pod:1463
9389 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1463
9394 #: ../fish/guestfish-actions.pod:1465
9395 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1465
9403 #: ../fish/guestfish-actions.pod:1467
9404 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1467
9405 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2199
9406 #: ../src/guestfs-actions.pod:2199
9407 msgid "This gets the SELinux security context of the daemon."
9411 #: ../fish/guestfish-actions.pod:1469
9412 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1469
9413 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
9417 #: ../fish/guestfish-actions.pod:1472
9418 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1472
9423 #: ../fish/guestfish-actions.pod:1474
9424 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1474
9427 " getxattr path name\n"
9432 #: ../fish/guestfish-actions.pod:1476
9433 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1476
9435 "Get a single extended attribute from file C<path> named C<name>. This call "
9436 "follows symlinks. If you want to lookup an extended attribute for the "
9437 "symlink itself, use L</lgetxattr>."
9441 #: ../fish/guestfish-actions.pod:1480 ../fish/guestfish-actions.pod:2507
9442 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1480
9443 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2507
9445 "Normally it is better to get all extended attributes from a file in one go "
9446 "by calling L</getxattrs>. However some Linux filesystem implementations are "
9447 "buggy and do not provide a way to list out attributes. For these "
9448 "filesystems (notably ntfs-3g) you have to know the names of the extended "
9449 "attributes you want in advance and call this function."
9453 #: ../fish/guestfish-actions.pod:1487 ../fish/guestfish-actions.pod:2514
9454 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1487
9455 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2514
9456 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2228
9457 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3684
9458 #: ../src/guestfs-actions.pod:2228 ../src/guestfs-actions.pod:3684
9460 "Extended attribute values are blobs of binary data. If there is no extended "
9461 "attribute named C<name>, this returns an error."
9465 #: ../fish/guestfish-actions.pod:1490
9466 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1490
9467 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
9471 #: ../fish/guestfish-actions.pod:1492
9472 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1492
9477 #: ../fish/guestfish-actions.pod:1494
9478 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1494
9486 #: ../fish/guestfish-actions.pod:1496
9487 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1496
9488 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2245
9489 #: ../src/guestfs-actions.pod:2245
9491 "This call lists the extended attributes of the file or directory C<path>."
9495 #: ../fish/guestfish-actions.pod:1499
9496 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1499
9497 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2248
9498 #: ../src/guestfs-actions.pod:2248
9500 "At the system call level, this is a combination of the L<listxattr(2)> and "
9501 "L<getxattr(2)> calls."
9505 #: ../fish/guestfish-actions.pod:1502
9506 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1502
9507 msgid "See also: L</lgetxattrs>, L<attr(5)>."
9511 #: ../fish/guestfish-actions.pod:1504
9512 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1504
9517 #: ../fish/guestfish-actions.pod:1506
9518 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1506
9521 " glob-expand pattern\n"
9526 #: ../fish/guestfish-actions.pod:1508
9527 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1508
9528 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2265
9529 #: ../src/guestfs-actions.pod:2265
9531 "This command searches for all the pathnames matching C<pattern> according to "
9532 "the wildcard expansion rules used by the shell."
9536 #: ../fish/guestfish-actions.pod:1512
9537 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1512
9538 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2269
9539 #: ../src/guestfs-actions.pod:2269
9541 "If no paths match, then this returns an empty list (note: not an error)."
9545 #: ../fish/guestfish-actions.pod:1515
9546 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1515
9547 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2272
9548 #: ../src/guestfs-actions.pod:2272
9550 "It is just a wrapper around the C L<glob(3)> function with flags C<GLOB_MARK|"
9551 "GLOB_BRACE>. See that manual page for more details."
9555 #: ../fish/guestfish-actions.pod:1519
9556 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1519
9561 #: ../fish/guestfish-actions.pod:1521
9562 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1521
9565 " grep regex path\n"
9570 #: ../fish/guestfish-actions.pod:1523
9571 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1523
9572 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2289
9573 #: ../src/guestfs-actions.pod:2289
9574 msgid "This calls the external C<grep> program and returns the matching lines."
9578 #: ../fish/guestfish-actions.pod:1529
9579 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1529
9584 #: ../fish/guestfish-actions.pod:1531
9585 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1531
9588 " grepi regex path\n"
9593 #: ../fish/guestfish-actions.pod:1533
9594 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1533
9595 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2308
9596 #: ../src/guestfs-actions.pod:2308
9598 "This calls the external C<grep -i> program and returns the matching lines."
9602 #: ../fish/guestfish-actions.pod:1539
9603 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1539
9604 msgid "grub-install"
9608 #: ../fish/guestfish-actions.pod:1541
9609 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1541
9612 " grub-install root device\n"
9617 #: ../fish/guestfish-actions.pod:1543
9618 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1543
9619 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2327
9620 #: ../src/guestfs-actions.pod:2327
9622 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
9623 "the root directory being C<root>."
9627 #: ../fish/guestfish-actions.pod:1546
9628 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1546
9629 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2330
9630 #: ../src/guestfs-actions.pod:2330
9632 "Note: If grub-install reports the error \"No suitable drive was found in the "
9633 "generated device map.\" it may be that you need to create a C</boot/grub/"
9634 "device.map> file first that contains the mapping between grub device names "
9635 "and Linux device names. It is usually sufficient to create a file "
9640 #: ../fish/guestfish-actions.pod:1553
9641 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1553
9642 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2337
9643 #: ../src/guestfs-actions.pod:2337
9651 #: ../fish/guestfish-actions.pod:1555
9652 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1555
9653 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2339
9654 #: ../src/guestfs-actions.pod:2339
9655 msgid "replacing C</dev/vda> with the name of the installation device."
9659 #: ../fish/guestfish-actions.pod:1557
9660 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1557
9665 #: ../fish/guestfish-actions.pod:1559
9666 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1559
9674 #: ../fish/guestfish-actions.pod:1561
9675 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1561
9676 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2351
9677 #: ../src/guestfs-actions.pod:2351
9679 "This command returns up to the first 10 lines of a file as a list of strings."
9683 #: ../fish/guestfish-actions.pod:1567
9684 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1567
9689 #: ../fish/guestfish-actions.pod:1569
9690 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1569
9693 " head-n nrlines path\n"
9698 #: ../fish/guestfish-actions.pod:1571
9699 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1571
9700 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2370
9701 #: ../src/guestfs-actions.pod:2370
9703 "If the parameter C<nrlines> is a positive number, this returns the first "
9704 "C<nrlines> lines of the file C<path>."
9708 #: ../fish/guestfish-actions.pod:1574
9709 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1574
9710 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2373
9711 #: ../src/guestfs-actions.pod:2373
9713 "If the parameter C<nrlines> is a negative number, this returns lines from "
9714 "the file C<path>, excluding the last C<nrlines> lines."
9718 #: ../fish/guestfish-actions.pod:1577 ../fish/guestfish-actions.pod:4643
9719 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1577
9720 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4643
9721 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2376
9722 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6991
9723 #: ../src/guestfs-actions.pod:2376 ../src/guestfs-actions.pod:6991
9724 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
9728 #: ../fish/guestfish-actions.pod:1582
9729 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1582
9734 #: ../fish/guestfish-actions.pod:1584
9735 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1584
9743 #: ../fish/guestfish-actions.pod:1586
9744 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1586
9745 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2393
9746 #: ../src/guestfs-actions.pod:2393
9748 "This runs C<hexdump -C> on the given C<path>. The result is the human-"
9749 "readable, canonical hex dump of the file."
9753 #: ../fish/guestfish-actions.pod:1592
9754 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1592
9759 #: ../fish/guestfish-actions.pod:1594
9760 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1594
9763 " initrd-cat initrdpath filename\n"
9768 #: ../fish/guestfish-actions.pod:1596
9769 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1596
9770 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2412
9771 #: ../src/guestfs-actions.pod:2412
9773 "This command unpacks the file C<filename> from the initrd file called "
9774 "C<initrdpath>. The filename must be given I<without> the initial C</> "
9779 #: ../fish/guestfish-actions.pod:1600
9780 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1600
9781 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2416
9782 #: ../src/guestfs-actions.pod:2416
9784 "For example, in guestfish you could use the following command to examine the "
9785 "boot script (usually called C</init>) contained in a Linux initrd or "
9790 #: ../fish/guestfish-actions.pod:1604
9791 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1604
9792 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2420
9793 #: ../src/guestfs-actions.pod:2420
9796 " initrd-cat /boot/initrd-<version>.img init\n"
9801 #: ../fish/guestfish-actions.pod:1606
9802 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1606
9803 msgid "See also L</initrd-list>."
9807 #: ../fish/guestfish-actions.pod:1611
9808 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1611
9813 #: ../fish/guestfish-actions.pod:1613
9814 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1613
9817 " initrd-list path\n"
9822 #: ../fish/guestfish-actions.pod:1615
9823 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1615
9824 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2439
9825 #: ../src/guestfs-actions.pod:2439
9826 msgid "This command lists out files contained in an initrd."
9830 #: ../fish/guestfish-actions.pod:1617
9831 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1617
9832 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2441
9833 #: ../src/guestfs-actions.pod:2441
9835 "The files are listed without any initial C</> character. The files are "
9836 "listed in the order they appear (not necessarily alphabetical). Directory "
9837 "names are listed as separate items."
9841 #: ../fish/guestfish-actions.pod:1621
9842 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1621
9843 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2445
9844 #: ../src/guestfs-actions.pod:2445
9846 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
9847 "initrd. We I<only> support the newer initramfs format (compressed cpio "
9852 #: ../fish/guestfish-actions.pod:1625
9853 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1625
9854 msgid "inotify-add-watch"
9858 #: ../fish/guestfish-actions.pod:1627
9859 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1627
9862 " inotify-add-watch path mask\n"
9867 #: ../fish/guestfish-actions.pod:1629
9868 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1629
9869 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2462
9870 #: ../src/guestfs-actions.pod:2462
9871 msgid "Watch C<path> for the events listed in C<mask>."
9875 #: ../fish/guestfish-actions.pod:1631
9876 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1631
9877 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2464
9878 #: ../src/guestfs-actions.pod:2464
9880 "Note that if C<path> is a directory then events within that directory are "
9881 "watched, but this does I<not> happen recursively (in subdirectories)."
9885 #: ../fish/guestfish-actions.pod:1635
9886 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1635
9887 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2468
9888 #: ../src/guestfs-actions.pod:2468
9890 "Note for non-C or non-Linux callers: the inotify events are defined by the "
9891 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
9895 #: ../fish/guestfish-actions.pod:1639
9896 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1639
9897 msgid "inotify-close"
9901 #: ../fish/guestfish-actions.pod:1641
9902 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1641
9910 #: ../fish/guestfish-actions.pod:1643
9911 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1643
9912 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2481
9913 #: ../src/guestfs-actions.pod:2481
9915 "This closes the inotify handle which was previously opened by inotify_init. "
9916 "It removes all watches, throws away any pending events, and deallocates all "
9921 #: ../fish/guestfish-actions.pod:1647
9922 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1647
9923 msgid "inotify-files"
9927 #: ../fish/guestfish-actions.pod:1649
9928 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1649
9936 #: ../fish/guestfish-actions.pod:1651
9937 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1651
9939 "This function is a helpful wrapper around L</inotify-read> which just "
9940 "returns a list of pathnames of objects that were touched. The returned "
9941 "pathnames are sorted and deduplicated."
9945 #: ../fish/guestfish-actions.pod:1655
9946 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1655
9947 msgid "inotify-init"
9951 #: ../fish/guestfish-actions.pod:1657
9952 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1657
9955 " inotify-init maxevents\n"
9960 #: ../fish/guestfish-actions.pod:1659
9961 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1659
9962 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2510
9963 #: ../src/guestfs-actions.pod:2510
9965 "This command creates a new inotify handle. The inotify subsystem can be "
9966 "used to notify events which happen to objects in the guest filesystem."
9970 #: ../fish/guestfish-actions.pod:1663
9971 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1663
9973 "C<maxevents> is the maximum number of events which will be queued up between "
9974 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
9975 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
9976 "default was 16384 events. Beyond this limit, the kernel throws away events, "
9977 "but records the fact that it threw them away by setting a flag "
9978 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
9982 #: ../fish/guestfish-actions.pod:1673
9983 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1673
9985 "Before any events are generated, you have to add some watches to the "
9986 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
9987 "L</inotify-watch-all>."
9991 #: ../fish/guestfish-actions.pod:1679
9992 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1679
9994 "Queued up events should be read periodically by calling L</inotify-read> (or "
9995 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
9996 "If you don't read the events out often enough then you risk the internal "
9997 "queue overflowing."
10001 #: ../fish/guestfish-actions.pod:1686
10002 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1686
10004 "The handle should be closed after use by calling L</inotify-close>. This "
10005 "also removes any watches automatically."
10009 #: ../fish/guestfish-actions.pod:1690
10010 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1690
10011 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2541
10012 #: ../src/guestfs-actions.pod:2541
10014 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
10015 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
10016 "that there is one global inotify handle per libguestfs instance."
10020 #: ../fish/guestfish-actions.pod:1695
10021 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1695
10022 msgid "inotify-read"
10026 #: ../fish/guestfish-actions.pod:1697
10027 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1697
10035 #: ../fish/guestfish-actions.pod:1699
10036 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1699
10037 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2555
10038 #: ../src/guestfs-actions.pod:2555
10040 "Return the complete queue of events that have happened since the previous "
10045 #: ../fish/guestfish-actions.pod:1702
10046 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1702
10047 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2558
10048 #: ../src/guestfs-actions.pod:2558
10049 msgid "If no events have happened, this returns an empty list."
10053 #: ../fish/guestfish-actions.pod:1704
10054 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1704
10055 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2560
10056 #: ../src/guestfs-actions.pod:2560
10058 "I<Note>: In order to make sure that all events have been read, you must call "
10059 "this function repeatedly until it returns an empty list. The reason is that "
10060 "the call will read events up to the maximum appliance-to-host message size "
10061 "and leave remaining events in the queue."
10065 #: ../fish/guestfish-actions.pod:1710
10066 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1710
10067 msgid "inotify-rm-watch"
10071 #: ../fish/guestfish-actions.pod:1712
10072 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1712
10075 " inotify-rm-watch wd\n"
10080 #: ../fish/guestfish-actions.pod:1714
10081 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1714
10082 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
10086 #: ../fish/guestfish-actions.pod:1717
10087 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1717
10088 msgid "inspect-get-arch"
10092 #: ../fish/guestfish-actions.pod:1719
10093 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1719
10096 " inspect-get-arch root\n"
10101 #: ../fish/guestfish-actions.pod:1721
10102 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1721
10104 "This returns the architecture of the inspected operating system. The "
10105 "possible return values are listed under L</file-architecture>."
10109 #: ../fish/guestfish-actions.pod:1725
10110 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1725
10111 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2595
10112 #: ../src/guestfs-actions.pod:2595
10114 "If the architecture could not be determined, then the string C<unknown> is "
10119 #: ../fish/guestfish-actions.pod:1728 ../fish/guestfish-actions.pod:1811
10120 #: ../fish/guestfish-actions.pod:1890 ../fish/guestfish-actions.pod:1902
10121 #: ../fish/guestfish-actions.pod:1986 ../fish/guestfish-actions.pod:2047
10122 #: ../fish/guestfish-actions.pod:2068 ../fish/guestfish-actions.pod:2082
10123 #: ../fish/guestfish-actions.pod:2122 ../fish/guestfish-actions.pod:2154
10124 #: ../fish/guestfish-actions.pod:2167 ../fish/guestfish-actions.pod:2180
10125 #: ../fish/guestfish-actions.pod:2190 ../fish/guestfish-actions.pod:2200
10126 #: ../fish/guestfish-actions.pod:2212 ../fish/guestfish-actions.pod:2308
10127 #: ../fish/guestfish-actions.pod:2342
10128 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1728
10129 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1811
10130 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1890
10131 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1902
10132 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1986
10133 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2047
10134 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2068
10135 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2082
10136 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2122
10137 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2154
10138 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2167
10139 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2180
10140 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2190
10141 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2200
10142 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2212
10143 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2308
10144 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2342
10145 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2598
10146 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2688
10147 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2792
10148 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2811
10149 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2942
10150 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3025
10151 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3053
10152 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3074
10153 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3127
10154 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3167
10155 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3187
10156 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3207
10157 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3224
10158 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3240
10159 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3258
10160 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3360
10161 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3401
10162 #: ../src/guestfs-actions.pod:2598 ../src/guestfs-actions.pod:2688
10163 #: ../src/guestfs-actions.pod:2792 ../src/guestfs-actions.pod:2811
10164 #: ../src/guestfs-actions.pod:2942 ../src/guestfs-actions.pod:3025
10165 #: ../src/guestfs-actions.pod:3053 ../src/guestfs-actions.pod:3074
10166 #: ../src/guestfs-actions.pod:3127 ../src/guestfs-actions.pod:3167
10167 #: ../src/guestfs-actions.pod:3187 ../src/guestfs-actions.pod:3207
10168 #: ../src/guestfs-actions.pod:3224 ../src/guestfs-actions.pod:3240
10169 #: ../src/guestfs-actions.pod:3258 ../src/guestfs-actions.pod:3360
10170 #: ../src/guestfs-actions.pod:3401
10171 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
10175 #: ../fish/guestfish-actions.pod:1730
10176 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1730
10177 msgid "inspect-get-distro"
10181 #: ../fish/guestfish-actions.pod:1732
10182 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1732
10185 " inspect-get-distro root\n"
10190 #: ../fish/guestfish-actions.pod:1734
10191 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1734
10192 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2611
10193 #: ../src/guestfs-actions.pod:2611
10195 "This returns the distro (distribution) of the inspected operating system."
10199 #: ../fish/guestfish-actions.pod:1737
10200 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1737
10201 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2614
10202 #: ../src/guestfs-actions.pod:2614
10203 msgid "Currently defined distros are:"
10207 #: ../fish/guestfish-actions.pod:1741
10208 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1741
10209 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2618
10210 #: ../src/guestfs-actions.pod:2618
10211 msgid "\"archlinux\""
10215 #: ../fish/guestfish-actions.pod:1743
10216 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1743
10217 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2620
10218 #: ../src/guestfs-actions.pod:2620
10219 msgid "Arch Linux."
10223 #: ../fish/guestfish-actions.pod:1745
10224 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1745
10225 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2622
10226 #: ../src/guestfs-actions.pod:2622
10231 #: ../fish/guestfish-actions.pod:1747
10232 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1747
10233 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2624
10234 #: ../src/guestfs-actions.pod:2624
10239 #: ../fish/guestfish-actions.pod:1749
10240 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1749
10241 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2626
10242 #: ../src/guestfs-actions.pod:2626
10247 #: ../fish/guestfish-actions.pod:1751
10248 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1751
10249 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2628
10250 #: ../src/guestfs-actions.pod:2628
10255 #: ../fish/guestfish-actions.pod:1753
10256 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1753
10257 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2630
10258 #: ../src/guestfs-actions.pod:2630
10263 #: ../fish/guestfish-actions.pod:1755
10264 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1755
10265 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2632
10266 #: ../src/guestfs-actions.pod:2632
10271 #: ../fish/guestfish-actions.pod:1757
10272 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1757
10273 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2634
10274 #: ../src/guestfs-actions.pod:2634
10279 #: ../fish/guestfish-actions.pod:1759
10280 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1759
10281 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2636
10282 #: ../src/guestfs-actions.pod:2636
10287 #: ../fish/guestfish-actions.pod:1761
10288 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1761
10289 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2638
10290 #: ../src/guestfs-actions.pod:2638
10291 msgid "\"linuxmint\""
10295 #: ../fish/guestfish-actions.pod:1763
10296 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1763
10297 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2640
10298 #: ../src/guestfs-actions.pod:2640
10299 msgid "Linux Mint."
10303 #: ../fish/guestfish-actions.pod:1765
10304 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1765
10305 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2642
10306 #: ../src/guestfs-actions.pod:2642
10307 msgid "\"mandriva\""
10311 #: ../fish/guestfish-actions.pod:1767
10312 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1767
10313 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2644
10314 #: ../src/guestfs-actions.pod:2644
10319 #: ../fish/guestfish-actions.pod:1769
10320 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1769
10321 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2646
10322 #: ../src/guestfs-actions.pod:2646
10327 #: ../fish/guestfish-actions.pod:1771
10328 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1771
10329 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2648
10330 #: ../src/guestfs-actions.pod:2648
10335 #: ../fish/guestfish-actions.pod:1773
10336 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1773
10337 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2650
10338 #: ../src/guestfs-actions.pod:2650
10343 #: ../fish/guestfish-actions.pod:1775
10344 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1775
10345 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2652
10346 #: ../src/guestfs-actions.pod:2652
10351 #: ../fish/guestfish-actions.pod:1777
10352 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1777
10353 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2654
10354 #: ../src/guestfs-actions.pod:2654
10355 msgid "\"redhat-based\""
10359 #: ../fish/guestfish-actions.pod:1779
10360 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1779
10361 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2656
10362 #: ../src/guestfs-actions.pod:2656
10363 msgid "Some Red Hat-derived distro."
10367 #: ../fish/guestfish-actions.pod:1781
10368 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1781
10369 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2658
10370 #: ../src/guestfs-actions.pod:2658
10375 #: ../fish/guestfish-actions.pod:1783
10376 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1783
10377 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2660
10378 #: ../src/guestfs-actions.pod:2660
10379 msgid "Red Hat Enterprise Linux."
10383 #: ../fish/guestfish-actions.pod:1785
10384 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1785
10385 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2662
10386 #: ../src/guestfs-actions.pod:2662
10387 msgid "\"scientificlinux\""
10391 #: ../fish/guestfish-actions.pod:1787
10392 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1787
10393 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2664
10394 #: ../src/guestfs-actions.pod:2664
10395 msgid "Scientific Linux."
10399 #: ../fish/guestfish-actions.pod:1789
10400 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1789
10401 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2666
10402 #: ../src/guestfs-actions.pod:2666
10403 msgid "\"slackware\""
10407 #: ../fish/guestfish-actions.pod:1791
10408 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1791
10409 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2668
10410 #: ../src/guestfs-actions.pod:2668
10415 #: ../fish/guestfish-actions.pod:1793
10416 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1793
10417 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2670
10418 #: ../src/guestfs-actions.pod:2670
10423 #: ../fish/guestfish-actions.pod:1795
10424 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1795
10425 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2672
10426 #: ../src/guestfs-actions.pod:2672
10431 #: ../fish/guestfish-actions.pod:1797 ../fish/guestfish-actions.pod:1881
10432 #: ../fish/guestfish-actions.pod:2145
10433 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1797
10434 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1881
10435 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2145
10436 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2674
10437 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2783
10438 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3158
10439 #: ../src/guestfs-actions.pod:2674 ../src/guestfs-actions.pod:2783
10440 #: ../src/guestfs-actions.pod:3158
10441 msgid "\"unknown\""
10445 #: ../fish/guestfish-actions.pod:1799
10446 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1799
10447 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2676
10448 #: ../src/guestfs-actions.pod:2676
10449 msgid "The distro could not be determined."
10453 #: ../fish/guestfish-actions.pod:1801 ../fish/guestfish-actions.pod:2137
10454 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1801
10455 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2137
10456 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2678
10457 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3150
10458 #: ../src/guestfs-actions.pod:2678 ../src/guestfs-actions.pod:3150
10459 msgid "\"windows\""
10463 #: ../fish/guestfish-actions.pod:1803
10464 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1803
10465 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2680
10466 #: ../src/guestfs-actions.pod:2680
10468 "Windows does not have distributions. This string is returned if the OS type "
10473 #: ../fish/guestfish-actions.pod:1808 ../fish/guestfish-actions.pod:1887
10474 #: ../fish/guestfish-actions.pod:2151
10475 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1808
10476 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1887
10477 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2151
10478 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2685
10479 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2789
10480 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3164
10481 #: ../src/guestfs-actions.pod:2685 ../src/guestfs-actions.pod:2789
10482 #: ../src/guestfs-actions.pod:3164
10484 "Future versions of libguestfs may return other strings here. The caller "
10485 "should be prepared to handle any string."
10489 #: ../fish/guestfish-actions.pod:1813
10490 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1813
10491 msgid "inspect-get-drive-mappings"
10495 #: ../fish/guestfish-actions.pod:1815
10496 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1815
10499 " inspect-get-drive-mappings root\n"
10504 #: ../fish/guestfish-actions.pod:1817
10505 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1817
10506 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2701
10507 #: ../src/guestfs-actions.pod:2701
10509 "This call is useful for Windows which uses a primitive system of assigning "
10510 "drive letters (like \"C:\") to partitions. This inspection API examines the "
10511 "Windows Registry to find out how disks/partitions are mapped to drive "
10512 "letters, and returns a hash table as in the example below:"
10516 #: ../fish/guestfish-actions.pod:1823
10517 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1823
10518 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2707
10519 #: ../src/guestfs-actions.pod:2707
10522 " C => /dev/vda2\n"
10523 " E => /dev/vdb1\n"
10524 " F => /dev/vdc1\n"
10529 #: ../fish/guestfish-actions.pod:1827
10530 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1827
10531 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2711
10532 #: ../src/guestfs-actions.pod:2711
10534 "Note that keys are drive letters. For Windows, the key is case insensitive "
10535 "and just contains the drive letter, without the customary colon separator "
10540 #: ../fish/guestfish-actions.pod:1831
10541 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1831
10542 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2715
10543 #: ../src/guestfs-actions.pod:2715
10545 "In future we may support other operating systems that also used drive "
10546 "letters, but the keys for those might not be case insensitive and might be "
10547 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
10552 #: ../fish/guestfish-actions.pod:1836
10553 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1836
10554 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2720
10555 #: ../src/guestfs-actions.pod:2720
10557 "For Windows guests, currently only hard drive mappings are returned. "
10558 "Removable disks (eg. DVD-ROMs) are ignored."
10562 #: ../fish/guestfish-actions.pod:1839
10563 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1839
10564 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2723
10565 #: ../src/guestfs-actions.pod:2723
10567 "For guests that do not use drive mappings, or if the drive mappings could "
10568 "not be determined, this returns an empty hash table."
10572 #: ../fish/guestfish-actions.pod:1842
10573 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1842
10575 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
10576 "get-mountpoints>, L</inspect-get-filesystems>."
10580 #: ../fish/guestfish-actions.pod:1846
10581 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1846
10582 msgid "inspect-get-filesystems"
10586 #: ../fish/guestfish-actions.pod:1848
10587 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1848
10590 " inspect-get-filesystems root\n"
10595 #: ../fish/guestfish-actions.pod:1850
10596 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1850
10597 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2744
10598 #: ../src/guestfs-actions.pod:2744
10600 "This returns a list of all the filesystems that we think are associated with "
10601 "this operating system. This includes the root filesystem, other ordinary "
10602 "filesystems, and non-mounted devices like swap partitions."
10606 #: ../fish/guestfish-actions.pod:1855
10607 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1855
10608 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2749
10609 #: ../src/guestfs-actions.pod:2749
10611 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
10612 "to be shared between operating systems."
10616 #: ../fish/guestfish-actions.pod:1858
10617 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1858
10619 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
10620 "get-mountpoints>."
10624 #: ../fish/guestfish-actions.pod:1861
10625 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1861
10626 msgid "inspect-get-format"
10630 #: ../fish/guestfish-actions.pod:1863
10631 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1863
10634 " inspect-get-format root\n"
10639 #: ../fish/guestfish-actions.pod:1865
10640 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1865
10641 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2767
10642 #: ../src/guestfs-actions.pod:2767
10644 "This returns the format of the inspected operating system. You can use it "
10645 "to detect install images, live CDs and similar."
10649 #: ../fish/guestfish-actions.pod:1868
10650 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1868
10651 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2770
10652 #: ../src/guestfs-actions.pod:2770
10653 msgid "Currently defined formats are:"
10657 #: ../fish/guestfish-actions.pod:1872
10658 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1872
10659 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2774
10660 #: ../src/guestfs-actions.pod:2774
10661 msgid "\"installed\""
10665 #: ../fish/guestfish-actions.pod:1874
10666 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1874
10667 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2776
10668 #: ../src/guestfs-actions.pod:2776
10669 msgid "This is an installed operating system."
10673 #: ../fish/guestfish-actions.pod:1876
10674 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1876
10675 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2778
10676 #: ../src/guestfs-actions.pod:2778
10677 msgid "\"installer\""
10681 #: ../fish/guestfish-actions.pod:1878
10682 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1878
10683 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2780
10684 #: ../src/guestfs-actions.pod:2780
10686 "The disk image being inspected is not an installed operating system, but a "
10687 "I<bootable> install disk, live CD, or similar."
10691 #: ../fish/guestfish-actions.pod:1883
10692 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1883
10693 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2785
10694 #: ../src/guestfs-actions.pod:2785
10695 msgid "The format of this disk image is not known."
10699 #: ../fish/guestfish-actions.pod:1892
10700 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1892
10701 msgid "inspect-get-hostname"
10705 #: ../fish/guestfish-actions.pod:1894
10706 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1894
10709 " inspect-get-hostname root\n"
10714 #: ../fish/guestfish-actions.pod:1896
10715 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1896
10716 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2805
10717 #: ../src/guestfs-actions.pod:2805
10719 "This function returns the hostname of the operating system as found by "
10720 "inspection of the guest's configuration files."
10724 #: ../fish/guestfish-actions.pod:1899
10725 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1899
10726 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2808
10727 #: ../src/guestfs-actions.pod:2808
10729 "If the hostname could not be determined, then the string C<unknown> is "
10734 #: ../fish/guestfish-actions.pod:1904
10735 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1904
10736 msgid "inspect-get-icon"
10740 #: ../fish/guestfish-actions.pod:1906
10741 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1906
10744 " inspect-get-icon root [favicon:..] [highquality:..]\n"
10749 #: ../fish/guestfish-actions.pod:1908
10750 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1908
10751 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2834
10752 #: ../src/guestfs-actions.pod:2834
10754 "This function returns an icon corresponding to the inspected operating "
10755 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
10756 "to PNG if necessary)."
10760 #: ../fish/guestfish-actions.pod:1912
10761 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1912
10762 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2838
10763 #: ../src/guestfs-actions.pod:2838
10765 "If it was not possible to get an icon this function returns a zero-length "
10766 "(non-NULL) buffer. I<Callers must check for this case>."
10770 #: ../fish/guestfish-actions.pod:1915
10771 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1915
10772 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2841
10773 #: ../src/guestfs-actions.pod:2841
10775 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
10776 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
10777 "this file will be returned. You can disable favicons by passing the "
10778 "optional C<favicon> boolean as false (default is true)."
10782 #: ../fish/guestfish-actions.pod:1921
10783 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1921
10784 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2847
10785 #: ../src/guestfs-actions.pod:2847
10787 "If finding the favicon fails, then we look in other places in the guest for "
10792 #: ../fish/guestfish-actions.pod:1924
10793 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1924
10794 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2850
10795 #: ../src/guestfs-actions.pod:2850
10797 "If the optional C<highquality> boolean is true then only high quality icons "
10798 "are returned, which means only icons of high resolution with an alpha "
10799 "channel. The default (false) is to return any icon we can, even if it is of "
10800 "substandard quality."
10804 #: ../fish/guestfish-actions.pod:1935
10805 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1935
10806 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2861
10807 #: ../src/guestfs-actions.pod:2861
10809 "Unlike most other inspection API calls, the guest's disks must be mounted up "
10810 "before you call this, since it needs to read information from the guest "
10811 "filesystem during the call."
10815 #: ../fish/guestfish-actions.pod:1941
10816 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1941
10817 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2867
10818 #: ../src/guestfs-actions.pod:2867
10820 "B<Security:> The icon data comes from the untrusted guest, and should be "
10821 "treated with caution. PNG files have been known to contain exploits. "
10822 "Ensure that libpng (or other relevant libraries) are fully up to date before "
10823 "trying to process or display the icon."
10827 #: ../fish/guestfish-actions.pod:1949
10828 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1949
10829 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2875
10830 #: ../src/guestfs-actions.pod:2875
10832 "The PNG image returned can be any size. It might not be square. Libguestfs "
10833 "tries to return the largest, highest quality icon available. The "
10834 "application must scale the icon to the required size."
10838 #: ../fish/guestfish-actions.pod:1956
10839 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1956
10840 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2882
10841 #: ../src/guestfs-actions.pod:2882
10843 "Extracting icons from Windows guests requires the external C<wrestool> "
10844 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
10845 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
10846 "installed separately."
10850 #: ../fish/guestfish-actions.pod:1963
10851 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1963
10852 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2889
10853 #: ../src/guestfs-actions.pod:2889
10855 "Operating system icons are usually trademarks. Seek legal advice before "
10856 "using trademarks in applications."
10860 #: ../fish/guestfish-actions.pod:1970
10861 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1970
10862 msgid "inspect-get-major-version"
10866 #: ../fish/guestfish-actions.pod:1972
10867 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1972
10870 " inspect-get-major-version root\n"
10875 #: ../fish/guestfish-actions.pod:1974
10876 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1974
10877 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2930
10878 #: ../src/guestfs-actions.pod:2930
10880 "This returns the major version number of the inspected operating system."
10884 #: ../fish/guestfish-actions.pod:1977
10885 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1977
10886 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2933
10887 #: ../src/guestfs-actions.pod:2933
10889 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
10890 "popular public names used by the operating system. Notably the operating "
10891 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
10892 "1). You can find out the real versions corresponding to releases of Windows "
10893 "by consulting Wikipedia or MSDN."
10897 #: ../fish/guestfish-actions.pod:1984 ../fish/guestfish-actions.pod:1995
10898 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1984
10899 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1995
10900 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2940
10901 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2957
10902 #: ../src/guestfs-actions.pod:2940 ../src/guestfs-actions.pod:2957
10903 msgid "If the version could not be determined, then C<0> is returned."
10907 #: ../fish/guestfish-actions.pod:1988
10908 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1988
10909 msgid "inspect-get-minor-version"
10913 #: ../fish/guestfish-actions.pod:1990
10914 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1990
10917 " inspect-get-minor-version root\n"
10922 #: ../fish/guestfish-actions.pod:1992
10923 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1992
10924 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2954
10925 #: ../src/guestfs-actions.pod:2954
10927 "This returns the minor version number of the inspected operating system."
10931 #: ../fish/guestfish-actions.pod:1997
10932 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:1997
10934 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
10935 "get-major-version>."
10939 #: ../fish/guestfish-actions.pod:2000
10940 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2000
10941 msgid "inspect-get-mountpoints"
10945 #: ../fish/guestfish-actions.pod:2002
10946 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2002
10949 " inspect-get-mountpoints root\n"
10954 #: ../fish/guestfish-actions.pod:2004
10955 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2004
10956 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2972
10957 #: ../src/guestfs-actions.pod:2972
10959 "This returns a hash of where we think the filesystems associated with this "
10960 "operating system should be mounted. Callers should note that this is at "
10961 "best an educated guess made by reading configuration files such as C</etc/"
10962 "fstab>. I<In particular note> that this may return filesystems which are "
10963 "non-existent or not mountable and callers should be prepared to handle or "
10964 "ignore failures if they try to mount them."
10968 #: ../fish/guestfish-actions.pod:2013
10969 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2013
10970 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2981
10971 #: ../src/guestfs-actions.pod:2981
10973 "Each element in the returned hashtable has a key which is the path of the "
10974 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
10975 "mounted there (eg. C</dev/sda1>)."
10979 #: ../fish/guestfish-actions.pod:2018
10980 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2018
10981 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2986
10982 #: ../src/guestfs-actions.pod:2986
10984 "Non-mounted devices such as swap devices are I<not> returned in this list."
10988 #: ../fish/guestfish-actions.pod:2021
10989 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2021
10991 "For operating systems like Windows which still use drive letters, this call "
10992 "will only return an entry for the first drive \"mounted on\" C</>. For "
10993 "information about the mapping of drive letters to partitions, see L</inspect-"
10994 "get-drive-mappings>."
10998 #: ../fish/guestfish-actions.pod:2027
10999 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2027
11001 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
11002 "get-filesystems>."
11006 #: ../fish/guestfish-actions.pod:2030
11007 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2030
11008 msgid "inspect-get-package-format"
11012 #: ../fish/guestfish-actions.pod:2032
11013 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2032
11016 " inspect-get-package-format root\n"
11021 #: ../fish/guestfish-actions.pod:2034
11022 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2034
11024 "This function and L</inspect-get-package-management> return the package "
11025 "format and package management tool used by the inspected operating system. "
11026 "For example for Fedora these functions would return C<rpm> (package format) "
11027 "and C<yum> (package management)."
11031 #: ../fish/guestfish-actions.pod:2040
11032 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2040
11033 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3018
11034 #: ../src/guestfs-actions.pod:3018
11036 "This returns the string C<unknown> if we could not determine the package "
11037 "format I<or> if the operating system does not have a real packaging system "
11042 #: ../fish/guestfish-actions.pod:2044
11043 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2044
11044 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3022
11045 #: ../src/guestfs-actions.pod:3022
11047 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
11048 "Future versions of libguestfs may return other strings."
11052 #: ../fish/guestfish-actions.pod:2049
11053 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2049
11054 msgid "inspect-get-package-management"
11058 #: ../fish/guestfish-actions.pod:2051
11059 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2051
11062 " inspect-get-package-management root\n"
11067 #: ../fish/guestfish-actions.pod:2053
11068 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2053
11070 "L</inspect-get-package-format> and this function return the package format "
11071 "and package management tool used by the inspected operating system. For "
11072 "example for Fedora these functions would return C<rpm> (package format) and "
11073 "C<yum> (package management)."
11077 #: ../fish/guestfish-actions.pod:2059
11078 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2059
11079 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3044
11080 #: ../src/guestfs-actions.pod:3044
11082 "This returns the string C<unknown> if we could not determine the package "
11083 "management tool I<or> if the operating system does not have a real packaging "
11084 "system (eg. Windows)."
11088 #: ../fish/guestfish-actions.pod:2063
11089 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2063
11090 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3048
11091 #: ../src/guestfs-actions.pod:3048
11093 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
11094 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
11095 "libguestfs may return other strings."
11099 #: ../fish/guestfish-actions.pod:2070
11100 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2070
11101 msgid "inspect-get-product-name"
11105 #: ../fish/guestfish-actions.pod:2072
11106 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2072
11109 " inspect-get-product-name root\n"
11114 #: ../fish/guestfish-actions.pod:2074
11115 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2074
11116 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3066
11117 #: ../src/guestfs-actions.pod:3066
11119 "This returns the product name of the inspected operating system. The "
11120 "product name is generally some freeform string which can be displayed to the "
11121 "user, but should not be parsed by programs."
11125 #: ../fish/guestfish-actions.pod:2079
11126 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2079
11127 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3071
11128 #: ../src/guestfs-actions.pod:3071
11130 "If the product name could not be determined, then the string C<unknown> is "
11135 #: ../fish/guestfish-actions.pod:2084
11136 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2084
11137 msgid "inspect-get-product-variant"
11141 #: ../fish/guestfish-actions.pod:2086
11142 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2086
11145 " inspect-get-product-variant root\n"
11150 #: ../fish/guestfish-actions.pod:2088
11151 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2088
11152 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3087
11153 #: ../src/guestfs-actions.pod:3087
11154 msgid "This returns the product variant of the inspected operating system."
11158 #: ../fish/guestfish-actions.pod:2091
11159 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2091
11160 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3090
11161 #: ../src/guestfs-actions.pod:3090
11163 "For Windows guests, this returns the contents of the Registry key C<HKLM"
11164 "\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> which "
11165 "is usually a string such as C<Client> or C<Server> (other values are "
11166 "possible). This can be used to distinguish consumer and enterprise versions "
11167 "of Windows that have the same version number (for example, Windows 7 and "
11168 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
11169 "the latter is C<Server>)."
11173 #: ../fish/guestfish-actions.pod:2100
11174 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2100
11175 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3099
11176 #: ../src/guestfs-actions.pod:3099
11178 "For enterprise Linux guests, in future we intend this to return the product "
11179 "variant such as C<Desktop>, C<Server> and so on. But this is not "
11180 "implemented at present."
11184 #: ../fish/guestfish-actions.pod:2104
11185 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2104
11186 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3103
11187 #: ../src/guestfs-actions.pod:3103
11189 "If the product variant could not be determined, then the string C<unknown> "
11194 #: ../fish/guestfish-actions.pod:2107
11195 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2107
11197 "Please read L<guestfs(3)/INSPECTION> for more details. See also L</inspect-"
11198 "get-product-name>, L</inspect-get-major-version>."
11202 #: ../fish/guestfish-actions.pod:2111
11203 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2111
11204 msgid "inspect-get-roots"
11208 #: ../fish/guestfish-actions.pod:2113
11209 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2113
11212 " inspect-get-roots\n"
11217 #: ../fish/guestfish-actions.pod:2115
11218 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2115
11220 "This function is a convenient way to get the list of root devices, as "
11221 "returned from a previous call to L</inspect-os>, but without redoing the "
11222 "whole inspection process."
11226 #: ../fish/guestfish-actions.pod:2119
11227 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2119
11229 "This returns an empty list if either no root devices were found or the "
11230 "caller has not called L</inspect-os>."
11234 #: ../fish/guestfish-actions.pod:2124
11235 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2124
11236 msgid "inspect-get-type"
11240 #: ../fish/guestfish-actions.pod:2126
11241 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2126
11244 " inspect-get-type root\n"
11249 #: ../fish/guestfish-actions.pod:2128
11250 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2128
11251 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3141
11252 #: ../src/guestfs-actions.pod:3141
11254 "This returns the type of the inspected operating system. Currently defined "
11259 #: ../fish/guestfish-actions.pod:2133
11260 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2133
11261 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3146
11262 #: ../src/guestfs-actions.pod:3146
11267 #: ../fish/guestfish-actions.pod:2135
11268 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2135
11269 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3148
11270 #: ../src/guestfs-actions.pod:3148
11271 msgid "Any Linux-based operating system."
11275 #: ../fish/guestfish-actions.pod:2139
11276 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2139
11277 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3152
11278 #: ../src/guestfs-actions.pod:3152
11279 msgid "Any Microsoft Windows operating system."
11283 #: ../fish/guestfish-actions.pod:2141
11284 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2141
11285 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3154
11286 #: ../src/guestfs-actions.pod:3154
11287 msgid "\"freebsd\""
11291 #: ../fish/guestfish-actions.pod:2143
11292 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2143
11293 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3156
11294 #: ../src/guestfs-actions.pod:3156
11299 #: ../fish/guestfish-actions.pod:2147
11300 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2147
11301 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3160
11302 #: ../src/guestfs-actions.pod:3160
11303 msgid "The operating system type could not be determined."
11307 #: ../fish/guestfish-actions.pod:2156
11308 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2156
11309 msgid "inspect-get-windows-current-control-set"
11313 #: ../fish/guestfish-actions.pod:2158
11314 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2158
11317 " inspect-get-windows-current-control-set root\n"
11322 #: ../fish/guestfish-actions.pod:2160
11323 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2160
11324 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3180
11325 #: ../src/guestfs-actions.pod:3180
11327 "This returns the Windows CurrentControlSet of the inspected guest. The "
11328 "CurrentControlSet is a registry key name such as C<ControlSet001>."
11332 #: ../fish/guestfish-actions.pod:2163
11333 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2163
11334 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3183
11335 #: ../src/guestfs-actions.pod:3183
11337 "This call assumes that the guest is Windows and that the Registry could be "
11338 "examined by inspection. If this is not the case then an error is returned."
11342 #: ../fish/guestfish-actions.pod:2169
11343 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2169
11344 msgid "inspect-get-windows-systemroot"
11348 #: ../fish/guestfish-actions.pod:2171
11349 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2171
11352 " inspect-get-windows-systemroot root\n"
11357 #: ../fish/guestfish-actions.pod:2173
11358 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2173
11359 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3200
11360 #: ../src/guestfs-actions.pod:3200
11362 "This returns the Windows systemroot of the inspected guest. The systemroot "
11363 "is a directory path such as C</WINDOWS>."
11367 #: ../fish/guestfish-actions.pod:2176
11368 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2176
11369 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3203
11370 #: ../src/guestfs-actions.pod:3203
11372 "This call assumes that the guest is Windows and that the systemroot could be "
11373 "determined by inspection. If this is not the case then an error is returned."
11377 #: ../fish/guestfish-actions.pod:2182
11378 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2182
11379 msgid "inspect-is-live"
11383 #: ../fish/guestfish-actions.pod:2184
11384 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2184
11387 " inspect-is-live root\n"
11392 #: ../fish/guestfish-actions.pod:2186
11393 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2186
11395 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
11396 "then this returns true if a live image was detected on the disk."
11400 #: ../fish/guestfish-actions.pod:2192
11401 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2192
11402 msgid "inspect-is-multipart"
11406 #: ../fish/guestfish-actions.pod:2194
11407 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2194
11410 " inspect-is-multipart root\n"
11415 #: ../fish/guestfish-actions.pod:2196
11416 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2196
11418 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
11419 "then this returns true if the disk is part of a set."
11423 #: ../fish/guestfish-actions.pod:2202
11424 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2202
11425 msgid "inspect-is-netinst"
11429 #: ../fish/guestfish-actions.pod:2204
11430 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2204
11433 " inspect-is-netinst root\n"
11438 #: ../fish/guestfish-actions.pod:2206
11439 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2206
11441 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
11442 "then this returns true if the disk is a network installer, ie. not a self-"
11443 "contained install CD but one which is likely to require network access to "
11444 "complete the install."
11448 #: ../fish/guestfish-actions.pod:2214
11449 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2214
11450 msgid "inspect-list-applications"
11454 #: ../fish/guestfish-actions.pod:2216
11455 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2216
11458 " inspect-list-applications root\n"
11463 #: ../fish/guestfish-actions.pod:2218
11464 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2218
11465 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3270
11466 #: ../src/guestfs-actions.pod:3270
11467 msgid "Return the list of applications installed in the operating system."
11471 #: ../fish/guestfish-actions.pod:2220
11472 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2220
11474 "I<Note:> This call works differently from other parts of the inspection "
11475 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
11476 "then mount up the disks, before calling this. Listing applications is a "
11477 "significantly more difficult operation which requires access to the full "
11478 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
11479 "are just returning data cached in the libguestfs handle, this call actually "
11480 "reads parts of the mounted filesystems during the call."
11484 #: ../fish/guestfish-actions.pod:2230
11485 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2230
11486 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3282
11487 #: ../src/guestfs-actions.pod:3282
11489 "This returns an empty list if the inspection code was not able to determine "
11490 "the list of applications."
11494 #: ../fish/guestfish-actions.pod:2233
11495 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2233
11496 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3285
11497 #: ../src/guestfs-actions.pod:3285
11498 msgid "The application structure contains the following fields:"
11502 #: ../fish/guestfish-actions.pod:2237
11503 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2237
11504 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3289
11505 #: ../src/guestfs-actions.pod:3289
11506 msgid "C<app_name>"
11510 #: ../fish/guestfish-actions.pod:2239
11511 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2239
11512 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3291
11513 #: ../src/guestfs-actions.pod:3291
11515 "The name of the application. For Red Hat-derived and Debian-derived Linux "
11516 "guests, this is the package name."
11520 #: ../fish/guestfish-actions.pod:2242
11521 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2242
11522 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3294
11523 #: ../src/guestfs-actions.pod:3294
11524 msgid "C<app_display_name>"
11528 #: ../fish/guestfish-actions.pod:2244
11529 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2244
11530 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3296
11531 #: ../src/guestfs-actions.pod:3296
11533 "The display name of the application, sometimes localized to the install "
11534 "language of the guest operating system."
11538 #: ../fish/guestfish-actions.pod:2247
11539 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2247
11540 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3299
11541 #: ../src/guestfs-actions.pod:3299
11543 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
11544 "to display something can use C<app_name> instead."
11548 #: ../fish/guestfish-actions.pod:2250
11549 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2250
11550 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3302
11551 #: ../src/guestfs-actions.pod:3302
11552 msgid "C<app_epoch>"
11556 #: ../fish/guestfish-actions.pod:2252
11557 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2252
11558 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3304
11559 #: ../src/guestfs-actions.pod:3304
11561 "For package managers which use epochs, this contains the epoch of the "
11562 "package (an integer). If unavailable, this is returned as C<0>."
11566 #: ../fish/guestfish-actions.pod:2255
11567 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2255
11568 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3307
11569 #: ../src/guestfs-actions.pod:3307
11570 msgid "C<app_version>"
11574 #: ../fish/guestfish-actions.pod:2257
11575 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2257
11576 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3309
11577 #: ../src/guestfs-actions.pod:3309
11579 "The version string of the application or package. If unavailable this is "
11580 "returned as an empty string C<\"\">."
11584 #: ../fish/guestfish-actions.pod:2260
11585 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2260
11586 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3312
11587 #: ../src/guestfs-actions.pod:3312
11588 msgid "C<app_release>"
11592 #: ../fish/guestfish-actions.pod:2262
11593 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2262
11594 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3314
11595 #: ../src/guestfs-actions.pod:3314
11597 "The release string of the application or package, for package managers that "
11598 "use this. If unavailable this is returned as an empty string C<\"\">."
11602 #: ../fish/guestfish-actions.pod:2266
11603 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2266
11604 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3318
11605 #: ../src/guestfs-actions.pod:3318
11606 msgid "C<app_install_path>"
11610 #: ../fish/guestfish-actions.pod:2268
11611 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2268
11612 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3320
11613 #: ../src/guestfs-actions.pod:3320
11615 "The installation path of the application (on operating systems such as "
11616 "Windows which use installation paths). This path is in the format used by "
11617 "the guest operating system, it is not a libguestfs path."
11621 #: ../fish/guestfish-actions.pod:2273
11622 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2273
11623 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3325
11624 #: ../src/guestfs-actions.pod:3325
11625 msgid "If unavailable this is returned as an empty string C<\"\">."
11629 #: ../fish/guestfish-actions.pod:2275
11630 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2275
11631 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3327
11632 #: ../src/guestfs-actions.pod:3327
11633 msgid "C<app_trans_path>"
11637 #: ../fish/guestfish-actions.pod:2277
11638 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2277
11639 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3329
11640 #: ../src/guestfs-actions.pod:3329
11642 "The install path translated into a libguestfs path. If unavailable this is "
11643 "returned as an empty string C<\"\">."
11647 #: ../fish/guestfish-actions.pod:2280
11648 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2280
11649 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3332
11650 #: ../src/guestfs-actions.pod:3332
11651 msgid "C<app_publisher>"
11655 #: ../fish/guestfish-actions.pod:2282
11656 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2282
11657 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3334
11658 #: ../src/guestfs-actions.pod:3334
11660 "The name of the publisher of the application, for package managers that use "
11661 "this. If unavailable this is returned as an empty string C<\"\">."
11665 #: ../fish/guestfish-actions.pod:2286
11666 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2286
11667 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3338
11668 #: ../src/guestfs-actions.pod:3338
11673 #: ../fish/guestfish-actions.pod:2288
11674 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2288
11675 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3340
11676 #: ../src/guestfs-actions.pod:3340
11678 "The URL (eg. upstream URL) of the application. If unavailable this is "
11679 "returned as an empty string C<\"\">."
11683 #: ../fish/guestfish-actions.pod:2291
11684 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2291
11685 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3343
11686 #: ../src/guestfs-actions.pod:3343
11687 msgid "C<app_source_package>"
11691 #: ../fish/guestfish-actions.pod:2293
11692 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2293
11693 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3345
11694 #: ../src/guestfs-actions.pod:3345
11696 "For packaging systems which support this, the name of the source package. "
11697 "If unavailable this is returned as an empty string C<\"\">."
11701 #: ../fish/guestfish-actions.pod:2296
11702 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2296
11703 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3348
11704 #: ../src/guestfs-actions.pod:3348
11705 msgid "C<app_summary>"
11709 #: ../fish/guestfish-actions.pod:2298
11710 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2298
11711 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3350
11712 #: ../src/guestfs-actions.pod:3350
11714 "A short (usually one line) description of the application or package. If "
11715 "unavailable this is returned as an empty string C<\"\">."
11719 #: ../fish/guestfish-actions.pod:2301
11720 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2301
11721 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3353
11722 #: ../src/guestfs-actions.pod:3353
11723 msgid "C<app_description>"
11727 #: ../fish/guestfish-actions.pod:2303
11728 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2303
11729 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3355
11730 #: ../src/guestfs-actions.pod:3355
11732 "A longer description of the application or package. If unavailable this is "
11733 "returned as an empty string C<\"\">."
11737 #: ../fish/guestfish-actions.pod:2310
11738 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2310
11743 #: ../fish/guestfish-actions.pod:2312
11744 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2312
11752 #: ../fish/guestfish-actions.pod:2314
11753 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2314
11754 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3373
11755 #: ../src/guestfs-actions.pod:3373
11757 "This function uses other libguestfs functions and certain heuristics to "
11758 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
11759 "for operating systems."
11763 #: ../fish/guestfish-actions.pod:2318
11764 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2318
11765 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3377
11766 #: ../src/guestfs-actions.pod:3377
11767 msgid "The list returned is empty if no operating systems were found."
11771 #: ../fish/guestfish-actions.pod:2320
11772 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2320
11773 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3379
11774 #: ../src/guestfs-actions.pod:3379
11776 "If one operating system was found, then this returns a list with a single "
11777 "element, which is the name of the root filesystem of this operating system. "
11778 "It is also possible for this function to return a list containing more than "
11779 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
11780 "element being the root filesystem of one of the operating systems."
11784 #: ../fish/guestfish-actions.pod:2327
11785 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2327
11787 "You can pass the root string(s) returned to other L</inspect-get-*> "
11788 "functions in order to query further information about each operating system, "
11789 "such as the name and version."
11793 #: ../fish/guestfish-actions.pod:2332
11794 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2332
11796 "This function uses other libguestfs features such as L</mount-ro> and L</"
11797 "umount-all> in order to mount and unmount filesystems and look at the "
11798 "contents. This should be called with no disks currently mounted. The "
11799 "function may also use Augeas, so any existing Augeas handle will be closed."
11803 #: ../fish/guestfish-actions.pod:2338
11804 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2338
11805 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3397
11806 #: ../src/guestfs-actions.pod:3397
11808 "This function cannot decrypt encrypted disks. The caller must do that first "
11809 "(supplying the necessary keys) if the disk is encrypted."
11813 #: ../fish/guestfish-actions.pod:2344 ../fish/guestfish-actions.pod:2542
11814 #: ../fish/guestfish-actions.pod:2601
11815 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2344
11816 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2542
11817 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2601
11818 msgid "See also L</list-filesystems>."
11822 #: ../fish/guestfish-actions.pod:2346
11823 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2346
11824 msgid "is-blockdev"
11828 #: ../fish/guestfish-actions.pod:2348
11829 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2348
11832 " is-blockdev path\n"
11837 #: ../fish/guestfish-actions.pod:2350
11838 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2350
11839 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3417
11840 #: ../src/guestfs-actions.pod:3417
11842 "This returns C<true> if and only if there is a block device with the given "
11847 #: ../fish/guestfish-actions.pod:2353 ../fish/guestfish-actions.pod:2371
11848 #: ../fish/guestfish-actions.pod:2390 ../fish/guestfish-actions.pod:2399
11849 #: ../fish/guestfish-actions.pod:2409 ../fish/guestfish-actions.pod:2443
11850 #: ../fish/guestfish-actions.pod:2452
11851 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2353
11852 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2371
11853 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2390
11854 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2399
11855 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2409
11856 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2443
11857 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2452
11858 msgid "See also L</stat>."
11862 #: ../fish/guestfish-actions.pod:2355
11863 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2355
11868 #: ../fish/guestfish-actions.pod:2357
11869 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2357
11877 #: ../fish/guestfish-actions.pod:2359
11878 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2359
11879 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3431
11880 #: ../src/guestfs-actions.pod:3431
11882 "This returns true iff this handle is busy processing a command (in the "
11887 #: ../fish/guestfish-actions.pod:2364
11888 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2364
11893 #: ../fish/guestfish-actions.pod:2366
11894 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2366
11897 " is-chardev path\n"
11902 #: ../fish/guestfish-actions.pod:2368
11903 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2368
11904 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3446
11905 #: ../src/guestfs-actions.pod:3446
11907 "This returns C<true> if and only if there is a character device with the "
11908 "given C<path> name."
11912 #: ../fish/guestfish-actions.pod:2373
11913 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2373
11918 #: ../fish/guestfish-actions.pod:2375
11919 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2375
11927 #: ../fish/guestfish-actions.pod:2377
11928 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2377
11929 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3460
11930 #: ../src/guestfs-actions.pod:3460
11932 "This returns true iff this handle is being configured (in the C<CONFIG> "
11937 #: ../fish/guestfish-actions.pod:2382
11938 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2382
11943 #: ../fish/guestfish-actions.pod:2384
11944 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2384
11952 #: ../fish/guestfish-actions.pod:2386
11953 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2386
11954 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3475
11955 #: ../src/guestfs-actions.pod:3475
11957 "This returns C<true> if and only if there is a directory with the given "
11958 "C<path> name. Note that it returns false for other objects like files."
11962 #: ../fish/guestfish-actions.pod:2392
11963 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2392
11968 #: ../fish/guestfish-actions.pod:2394
11969 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2394
11977 #: ../fish/guestfish-actions.pod:2396
11978 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2396
11979 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3491
11980 #: ../src/guestfs-actions.pod:3491
11982 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
11983 "given C<path> name."
11987 #: ../fish/guestfish-actions.pod:2401
11988 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2401
11993 #: ../fish/guestfish-actions.pod:2403
11994 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2403
12002 #: ../fish/guestfish-actions.pod:2405
12003 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2405
12004 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3506
12005 #: ../src/guestfs-actions.pod:3506
12007 "This returns C<true> if and only if there is a regular file with the given "
12008 "C<path> name. Note that it returns false for other objects like directories."
12012 #: ../fish/guestfish-actions.pod:2411
12013 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2411
12014 msgid "is-launching"
12018 #: ../fish/guestfish-actions.pod:2413
12019 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2413
12027 #: ../fish/guestfish-actions.pod:2415
12028 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2415
12029 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3521
12030 #: ../src/guestfs-actions.pod:3521
12032 "This returns true iff this handle is launching the subprocess (in the "
12033 "C<LAUNCHING> state)."
12037 #: ../fish/guestfish-actions.pod:2420
12038 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2420
12043 #: ../fish/guestfish-actions.pod:2422
12044 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2422
12052 #: ../fish/guestfish-actions.pod:2424
12053 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2424
12054 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3536
12055 #: ../src/guestfs-actions.pod:3536
12057 "This command tests whether C<device> is a logical volume, and returns true "
12058 "iff this is the case."
12062 #: ../fish/guestfish-actions.pod:2427
12063 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2427
12068 #: ../fish/guestfish-actions.pod:2429
12069 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2429
12077 #: ../fish/guestfish-actions.pod:2431
12078 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2431
12079 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3548
12080 #: ../src/guestfs-actions.pod:3548
12082 "This returns true iff this handle is ready to accept commands (in the "
12087 #: ../fish/guestfish-actions.pod:2436
12088 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2436
12093 #: ../fish/guestfish-actions.pod:2438
12094 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2438
12097 " is-socket path\n"
12102 #: ../fish/guestfish-actions.pod:2440
12103 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2440
12104 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3563
12105 #: ../src/guestfs-actions.pod:3563
12107 "This returns C<true> if and only if there is a Unix domain socket with the "
12108 "given C<path> name."
12112 #: ../fish/guestfish-actions.pod:2445
12113 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2445
12118 #: ../fish/guestfish-actions.pod:2447
12119 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2447
12122 " is-symlink path\n"
12127 #: ../fish/guestfish-actions.pod:2449
12128 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2449
12129 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3578
12130 #: ../src/guestfs-actions.pod:3578
12132 "This returns C<true> if and only if there is a symbolic link with the given "
12137 #: ../fish/guestfish-actions.pod:2454
12138 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2454
12143 #: ../fish/guestfish-actions.pod:2456
12144 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2456
12152 #: ../fish/guestfish-actions.pod:2458
12153 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2458
12154 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3593
12155 #: ../src/guestfs-actions.pod:3593
12157 "This returns true iff the file exists and the file is empty or it contains "
12162 #: ../fish/guestfish-actions.pod:2461
12163 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2461
12164 msgid "is-zero-device"
12168 #: ../fish/guestfish-actions.pod:2463
12169 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2463
12172 " is-zero-device device\n"
12177 #: ../fish/guestfish-actions.pod:2465
12178 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2465
12179 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3606
12180 #: ../src/guestfs-actions.pod:3606
12181 msgid "This returns true iff the device exists and contains all zero bytes."
12185 #: ../fish/guestfish-actions.pod:2467
12186 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2467
12187 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3608
12188 #: ../src/guestfs-actions.pod:3608
12189 msgid "Note that for large devices this can take a long time to run."
12193 #: ../fish/guestfish-actions.pod:2469
12194 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2469
12195 msgid "kill-subprocess"
12199 #: ../fish/guestfish-actions.pod:2471
12200 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2471
12203 " kill-subprocess\n"
12208 #: ../fish/guestfish-actions.pod:2473
12209 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2473
12210 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3619
12211 #: ../src/guestfs-actions.pod:3619
12212 msgid "This kills the qemu subprocess. You should never need to call this."
12216 #: ../fish/guestfish-actions.pod:2475
12217 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2475
12222 #: ../fish/guestfish-actions.pod:2477
12223 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2477
12228 #: ../fish/guestfish-actions.pod:2479
12229 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2479
12237 #: ../fish/guestfish-actions.pod:2481
12238 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2481
12239 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3630
12240 #: ../src/guestfs-actions.pod:3630
12242 "Internally libguestfs is implemented by running a virtual machine using "
12247 #: ../fish/guestfish-actions.pod:2484
12248 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2484
12249 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3633
12250 #: ../src/guestfs-actions.pod:3633
12252 "You should call this after configuring the handle (eg. adding drives) but "
12253 "before performing any actions."
12257 #: ../fish/guestfish-actions.pod:2487
12258 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2487
12263 #: ../fish/guestfish-actions.pod:2489
12264 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2489
12267 " lchown owner group path\n"
12272 #: ../fish/guestfish-actions.pod:2491
12273 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2491
12275 "Change the file owner to C<owner> and group to C<group>. This is like L</"
12276 "chown> but if C<path> is a symlink then the link itself is changed, not the "
12281 #: ../fish/guestfish-actions.pod:2499
12282 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2499
12287 #: ../fish/guestfish-actions.pod:2501
12288 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2501
12291 " lgetxattr path name\n"
12296 #: ../fish/guestfish-actions.pod:2503
12297 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2503
12298 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3673
12299 #: ../src/guestfs-actions.pod:3673
12301 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
12302 "is a symlink, then this call returns an extended attribute from the symlink."
12306 #: ../fish/guestfish-actions.pod:2517
12307 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2517
12308 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
12312 #: ../fish/guestfish-actions.pod:2519
12313 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2519
12318 #: ../fish/guestfish-actions.pod:2521
12319 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2521
12322 " lgetxattrs path\n"
12327 #: ../fish/guestfish-actions.pod:2523
12328 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2523
12330 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
12331 "it returns the extended attributes of the link itself."
12335 #: ../fish/guestfish-actions.pod:2527
12336 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2527
12341 #: ../fish/guestfish-actions.pod:2529
12342 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2529
12350 #: ../fish/guestfish-actions.pod:2531
12351 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2531
12352 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3716
12353 #: ../src/guestfs-actions.pod:3716
12355 "List all 9p filesystems attached to the guest. A list of mount tags is "
12360 #: ../fish/guestfish-actions.pod:2534
12361 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2534
12362 msgid "list-devices"
12366 #: ../fish/guestfish-actions.pod:2536
12367 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2536
12375 #: ../fish/guestfish-actions.pod:2538
12376 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2538
12377 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3730
12378 #: ../src/guestfs-actions.pod:3730
12379 msgid "List all the block devices."
12383 #: ../fish/guestfish-actions.pod:2540
12384 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2540
12385 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3732
12386 #: ../src/guestfs-actions.pod:3732
12387 msgid "The full block device names are returned, eg. C</dev/sda>."
12391 #: ../fish/guestfish-actions.pod:2544
12392 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2544
12393 msgid "list-dm-devices"
12397 #: ../fish/guestfish-actions.pod:2546
12398 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2546
12401 " list-dm-devices\n"
12406 #: ../fish/guestfish-actions.pod:2548
12407 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2548
12408 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3747
12409 #: ../src/guestfs-actions.pod:3747
12410 msgid "List all device mapper devices."
12414 #: ../fish/guestfish-actions.pod:2550
12415 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2550
12417 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
12418 "previous call to L</luks-open>."
12422 #: ../fish/guestfish-actions.pod:2553
12423 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2553
12425 "Device mapper devices which correspond to logical volumes are I<not> "
12426 "returned in this list. Call L</lvs> if you want to list logical volumes."
12430 #: ../fish/guestfish-actions.pod:2557
12431 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2557
12432 msgid "list-filesystems"
12436 #: ../fish/guestfish-actions.pod:2559
12437 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2559
12440 " list-filesystems\n"
12445 #: ../fish/guestfish-actions.pod:2561
12446 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2561
12447 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3767
12448 #: ../src/guestfs-actions.pod:3767
12450 "This inspection command looks for filesystems on partitions, block devices "
12451 "and logical volumes, returning a list of devices containing filesystems and "
12456 #: ../fish/guestfish-actions.pod:2565
12457 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2565
12458 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3771
12459 #: ../src/guestfs-actions.pod:3771
12461 "The return value is a hash, where the keys are the devices containing "
12462 "filesystems, and the values are the filesystem types. For example:"
12466 #: ../fish/guestfish-actions.pod:2569
12467 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2569
12468 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3775
12469 #: ../src/guestfs-actions.pod:3775
12472 " \"/dev/sda1\" => \"ntfs\"\n"
12473 " \"/dev/sda2\" => \"ext2\"\n"
12474 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
12475 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
12480 #: ../fish/guestfish-actions.pod:2574
12481 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2574
12482 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3780
12483 #: ../src/guestfs-actions.pod:3780
12485 "The value can have the special value \"unknown\", meaning the content of the "
12486 "device is undetermined or empty. \"swap\" means a Linux swap partition."
12490 #: ../fish/guestfish-actions.pod:2578
12491 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2578
12493 "This command runs other libguestfs commands, which might include L</mount> "
12494 "and L</umount>, and therefore you should use this soon after launch and only "
12495 "when nothing is mounted."
12499 #: ../fish/guestfish-actions.pod:2582
12500 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2582
12502 "Not all of the filesystems returned will be mountable. In particular, swap "
12503 "partitions are returned in the list. Also this command does not check that "
12504 "each filesystem found is valid and mountable, and some filesystems might be "
12505 "mountable but require special options. Filesystems may not all belong to a "
12506 "single logical operating system (use L</inspect-os> to look for OSes)."
12510 #: ../fish/guestfish-actions.pod:2590
12511 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2590
12512 msgid "list-partitions"
12516 #: ../fish/guestfish-actions.pod:2592
12517 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2592
12520 " list-partitions\n"
12525 #: ../fish/guestfish-actions.pod:2594
12526 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2594
12527 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3809
12528 #: ../src/guestfs-actions.pod:3809
12529 msgid "List all the partitions detected on all block devices."
12533 #: ../fish/guestfish-actions.pod:2596
12534 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2596
12535 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3811
12536 #: ../src/guestfs-actions.pod:3811
12537 msgid "The full partition device names are returned, eg. C</dev/sda1>"
12541 #: ../fish/guestfish-actions.pod:2598
12542 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2598
12544 "This does not return logical volumes. For that you will need to call L</"
12549 #: ../fish/guestfish-actions.pod:2603
12550 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2603
12555 #: ../fish/guestfish-actions.pod:2605
12556 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2605
12564 #: ../fish/guestfish-actions.pod:2607
12565 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2607
12566 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3830
12567 #: ../src/guestfs-actions.pod:3830
12569 "List the files in C<directory> (relative to the root directory, there is no "
12570 "cwd) in the format of 'ls -la'."
12574 #: ../fish/guestfish-actions.pod:2610
12575 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2610
12576 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3833
12577 #: ../src/guestfs-actions.pod:3833
12579 "This command is mostly useful for interactive sessions. It is I<not> "
12580 "intended that you try to parse the output string."
12584 #: ../fish/guestfish-actions.pod:2613
12585 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2613
12590 #: ../fish/guestfish-actions.pod:2615
12591 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2615
12594 " ln target linkname\n"
12599 #: ../fish/guestfish-actions.pod:2617
12600 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2617
12601 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3848
12602 #: ../src/guestfs-actions.pod:3848
12603 msgid "This command creates a hard link using the C<ln> command."
12607 #: ../fish/guestfish-actions.pod:2619
12608 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2619
12613 #: ../fish/guestfish-actions.pod:2621
12614 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2621
12617 " ln-f target linkname\n"
12622 #: ../fish/guestfish-actions.pod:2623
12623 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2623
12624 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3861
12625 #: ../src/guestfs-actions.pod:3861
12627 "This command creates a hard link using the C<ln -f> command. The I<-f> "
12628 "option removes the link (C<linkname>) if it exists already."
12632 #: ../fish/guestfish-actions.pod:2626
12633 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2626
12638 #: ../fish/guestfish-actions.pod:2628
12639 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2628
12642 " ln-s target linkname\n"
12647 #: ../fish/guestfish-actions.pod:2630
12648 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2630
12649 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3875
12650 #: ../src/guestfs-actions.pod:3875
12651 msgid "This command creates a symbolic link using the C<ln -s> command."
12655 #: ../fish/guestfish-actions.pod:2632
12656 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2632
12661 #: ../fish/guestfish-actions.pod:2634
12662 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2634
12665 " ln-sf target linkname\n"
12670 #: ../fish/guestfish-actions.pod:2636
12671 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2636
12672 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3888
12673 #: ../src/guestfs-actions.pod:3888
12675 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
12676 "option removes the link (C<linkname>) if it exists already."
12680 #: ../fish/guestfish-actions.pod:2639
12681 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2639
12682 msgid "lremovexattr"
12686 #: ../fish/guestfish-actions.pod:2641
12687 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2641
12690 " lremovexattr xattr path\n"
12695 #: ../fish/guestfish-actions.pod:2643
12696 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2643
12698 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
12699 "it removes an extended attribute of the link itself."
12703 #: ../fish/guestfish-actions.pod:2647
12704 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2647
12709 #: ../fish/guestfish-actions.pod:2649
12710 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2649
12718 #: ../fish/guestfish-actions.pod:2651
12719 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2651
12720 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3916
12721 #: ../src/guestfs-actions.pod:3916
12723 "List the files in C<directory> (relative to the root directory, there is no "
12724 "cwd). The '.' and '..' entries are not returned, but hidden files are shown."
12728 #: ../fish/guestfish-actions.pod:2655
12729 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2655
12731 "This command is mostly useful for interactive sessions. Programs should "
12732 "probably use L</readdir> instead."
12736 #: ../fish/guestfish-actions.pod:2658
12737 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2658
12742 #: ../fish/guestfish-actions.pod:2660
12743 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2660
12746 " lsetxattr xattr val vallen path\n"
12751 #: ../fish/guestfish-actions.pod:2662
12752 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2662
12754 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
12755 "sets an extended attribute of the link itself."
12759 #: ../fish/guestfish-actions.pod:2666
12760 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2666
12765 #: ../fish/guestfish-actions.pod:2668
12766 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2668
12774 #: ../fish/guestfish-actions.pod:2670 ../fish/guestfish-actions.pod:4478
12775 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2670
12776 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4478
12777 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3952
12778 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6731
12779 #: ../src/guestfs-actions.pod:3952 ../src/guestfs-actions.pod:6731
12780 msgid "Returns file information for the given C<path>."
12784 #: ../fish/guestfish-actions.pod:2672
12785 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2672
12787 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
12788 "the link is stat-ed, not the file it refers to."
12792 #: ../fish/guestfish-actions.pod:2676
12793 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2676
12794 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3958
12795 #: ../src/guestfs-actions.pod:3958
12796 msgid "This is the same as the C<lstat(2)> system call."
12800 #: ../fish/guestfish-actions.pod:2678
12801 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2678
12806 #: ../fish/guestfish-actions.pod:2680
12807 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2680
12810 " lstatlist path 'names ...'\n"
12815 #: ../fish/guestfish-actions.pod:2682
12816 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2682
12818 "This call allows you to perform the L</lstat> operation on multiple files, "
12819 "where all files are in the directory C<path>. C<names> is the list of files "
12820 "from this directory."
12824 #: ../fish/guestfish-actions.pod:2686
12825 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2686
12826 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3977
12827 #: ../src/guestfs-actions.pod:3977
12829 "On return you get a list of stat structs, with a one-to-one correspondence "
12830 "to the C<names> list. If any name did not exist or could not be lstat'd, "
12831 "then the C<ino> field of that structure is set to C<-1>."
12835 #: ../fish/guestfish-actions.pod:2691
12836 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2691
12838 "This call is intended for programs that want to efficiently list a directory "
12839 "contents without making many round-trips. See also L</lxattrlist> for a "
12840 "similarly efficient call for getting extended attributes. Very long "
12841 "directory listings might cause the protocol message size to be exceeded, "
12842 "causing this call to fail. The caller must split up such requests into "
12843 "smaller groups of names."
12847 #: ../fish/guestfish-actions.pod:2699
12848 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2699
12849 msgid "luks-add-key"
12853 #: ../fish/guestfish-actions.pod:2701
12854 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2701
12857 " luks-add-key device keyslot\n"
12862 #: ../fish/guestfish-actions.pod:2703
12863 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2703
12864 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4005
12865 #: ../src/guestfs-actions.pod:4005
12867 "This command adds a new key on LUKS device C<device>. C<key> is any "
12868 "existing key, and is used to access the device. C<newkey> is the new key to "
12869 "add. C<keyslot> is the key slot that will be replaced."
12873 #: ../fish/guestfish-actions.pod:2708
12874 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2708
12876 "Note that if C<keyslot> already contains a key, then this command will "
12877 "fail. You have to use L</luks-kill-slot> first to remove that key."
12881 #: ../fish/guestfish-actions.pod:2712 ../fish/guestfish-actions.pod:2734
12882 #: ../fish/guestfish-actions.pod:2747 ../fish/guestfish-actions.pod:2761
12883 #: ../fish/guestfish-actions.pod:2787 ../fish/guestfish-actions.pod:2797
12884 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2712
12885 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2734
12886 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2747
12887 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2761
12888 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2787
12889 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2797
12891 "This command has one or more key or passphrase parameters. Guestfish will "
12892 "prompt for these separately."
12896 #: ../fish/guestfish-actions.pod:2715
12897 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2715
12902 #: ../fish/guestfish-actions.pod:2717
12903 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2717
12906 " luks-close device\n"
12911 #: ../fish/guestfish-actions.pod:2719
12912 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2719
12914 "This closes a LUKS device that was created earlier by L</luks-open> or L</"
12915 "luks-open-ro>. The C<device> parameter must be the name of the LUKS mapping "
12916 "device (ie. C</dev/mapper/mapname>) and I<not> the name of the underlying "
12921 #: ../fish/guestfish-actions.pod:2725
12922 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2725
12923 msgid "luks-format"
12927 #: ../fish/guestfish-actions.pod:2727
12928 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2727
12931 " luks-format device keyslot\n"
12936 #: ../fish/guestfish-actions.pod:2729
12937 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2729
12938 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4046
12939 #: ../src/guestfs-actions.pod:4046
12941 "This command erases existing data on C<device> and formats the device as a "
12942 "LUKS encrypted device. C<key> is the initial key, which is added to key "
12943 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
12947 #: ../fish/guestfish-actions.pod:2737 ../fish/guestfish-actions.pod:2750
12948 #: ../fish/guestfish-actions.pod:2837 ../fish/guestfish-actions.pod:3498
12949 #: ../fish/guestfish-actions.pod:4024 ../fish/guestfish-actions.pod:4349
12950 #: ../fish/guestfish-actions.pod:4372 ../fish/guestfish-actions.pod:4394
12951 #: ../fish/guestfish-actions.pod:5132
12952 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2737
12953 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2750
12954 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2837
12955 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3498
12956 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4024
12957 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4349
12958 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4372
12959 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4394
12960 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5132
12961 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4053
12962 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4076
12963 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4219
12964 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5322
12965 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6110
12966 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6538
12967 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6568
12968 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6601
12969 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7799
12970 #: ../src/guestfs-actions.pod:4053 ../src/guestfs-actions.pod:4076
12971 #: ../src/guestfs-actions.pod:4219 ../src/guestfs-actions.pod:5322
12972 #: ../src/guestfs-actions.pod:6110 ../src/guestfs-actions.pod:6538
12973 #: ../src/guestfs-actions.pod:6568 ../src/guestfs-actions.pod:6601
12974 #: ../src/guestfs-actions.pod:7799
12976 "B<This command is dangerous. Without careful use you can easily destroy all "
12981 #: ../fish/guestfish-actions.pod:2740
12982 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2740
12983 msgid "luks-format-cipher"
12987 #: ../fish/guestfish-actions.pod:2742
12988 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2742
12991 " luks-format-cipher device keyslot cipher\n"
12996 #: ../fish/guestfish-actions.pod:2744
12997 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2744
12999 "This command is the same as L</luks-format> but it also allows you to set "
13000 "the C<cipher> used."
13004 #: ../fish/guestfish-actions.pod:2753
13005 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2753
13006 msgid "luks-kill-slot"
13010 #: ../fish/guestfish-actions.pod:2755
13011 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2755
13014 " luks-kill-slot device keyslot\n"
13019 #: ../fish/guestfish-actions.pod:2757
13020 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2757
13021 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4093
13022 #: ../src/guestfs-actions.pod:4093
13024 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
13025 "device C<device>. C<key> must be one of the I<other> keys."
13029 #: ../fish/guestfish-actions.pod:2764
13030 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2764
13035 #: ../fish/guestfish-actions.pod:2766
13036 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2766
13039 " luks-open device mapname\n"
13044 #: ../fish/guestfish-actions.pod:2768
13045 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2768
13046 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4113
13047 #: ../src/guestfs-actions.pod:4113
13049 "This command opens a block device which has been encrypted according to the "
13050 "Linux Unified Key Setup (LUKS) standard."
13054 #: ../fish/guestfish-actions.pod:2771
13055 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2771
13056 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4116
13057 #: ../src/guestfs-actions.pod:4116
13058 msgid "C<device> is the encrypted block device or partition."
13062 #: ../fish/guestfish-actions.pod:2773
13063 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2773
13064 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4118
13065 #: ../src/guestfs-actions.pod:4118
13067 "The caller must supply one of the keys associated with the LUKS block "
13068 "device, in the C<key> parameter."
13072 #: ../fish/guestfish-actions.pod:2776
13073 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2776
13074 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4121
13075 #: ../src/guestfs-actions.pod:4121
13077 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
13078 "writes to this block device are decrypted from and encrypted to the "
13079 "underlying C<device> respectively."
13083 #: ../fish/guestfish-actions.pod:2780
13084 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2780
13086 "If this block device contains LVM volume groups, then calling L</vgscan> "
13087 "followed by L</vg-activate-all> will make them visible."
13091 #: ../fish/guestfish-actions.pod:2784
13092 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2784
13093 msgid "Use L</list-dm-devices> to list all device mapper devices."
13097 #: ../fish/guestfish-actions.pod:2790
13098 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2790
13099 msgid "luks-open-ro"
13103 #: ../fish/guestfish-actions.pod:2792
13104 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2792
13107 " luks-open-ro device mapname\n"
13112 #: ../fish/guestfish-actions.pod:2794
13113 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2794
13115 "This is the same as L</luks-open> except that a read-only mapping is created."
13119 #: ../fish/guestfish-actions.pod:2800
13120 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2800
13125 #: ../fish/guestfish-actions.pod:2802
13126 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2802
13129 " lvcreate logvol volgroup mbytes\n"
13134 #: ../fish/guestfish-actions.pod:2804
13135 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2804
13136 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4167
13137 #: ../src/guestfs-actions.pod:4167
13139 "This creates an LVM logical volume called C<logvol> on the volume group "
13140 "C<volgroup>, with C<size> megabytes."
13144 #: ../fish/guestfish-actions.pod:2807
13145 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2807
13146 msgid "lvm-canonical-lv-name"
13150 #: ../fish/guestfish-actions.pod:2809
13151 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2809
13154 " lvm-canonical-lv-name lvname\n"
13159 #: ../fish/guestfish-actions.pod:2811
13160 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2811
13161 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4180
13162 #: ../src/guestfs-actions.pod:4180
13164 "This converts alternative naming schemes for LVs that you might find to the "
13165 "canonical name. For example, C</dev/mapper/VG-LV> is converted to C</dev/VG/"
13170 #: ../fish/guestfish-actions.pod:2815
13171 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2815
13172 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4184
13173 #: ../src/guestfs-actions.pod:4184
13175 "This command returns an error if the C<lvname> parameter does not refer to a "
13180 #: ../fish/guestfish-actions.pod:2818
13181 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2818
13182 msgid "See also L</is-lv>."
13186 #: ../fish/guestfish-actions.pod:2820
13187 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2820
13188 msgid "lvm-clear-filter"
13192 #: ../fish/guestfish-actions.pod:2822
13193 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2822
13196 " lvm-clear-filter\n"
13201 #: ../fish/guestfish-actions.pod:2824
13202 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2824
13204 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
13209 #: ../fish/guestfish-actions.pod:2827 ../fish/guestfish-actions.pod:2858
13210 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2827
13211 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2858
13212 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4202
13213 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4244
13214 #: ../src/guestfs-actions.pod:4202 ../src/guestfs-actions.pod:4244
13216 "This command also clears the LVM cache and performs a volume group scan."
13220 #: ../fish/guestfish-actions.pod:2830
13221 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2830
13222 msgid "lvm-remove-all"
13226 #: ../fish/guestfish-actions.pod:2832
13227 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2832
13230 " lvm-remove-all\n"
13235 #: ../fish/guestfish-actions.pod:2834
13236 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2834
13237 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4214
13238 #: ../src/guestfs-actions.pod:4214
13240 "This command removes all LVM logical volumes, volume groups and physical "
13245 #: ../fish/guestfish-actions.pod:2840
13246 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2840
13247 msgid "lvm-set-filter"
13251 #: ../fish/guestfish-actions.pod:2842
13252 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2842
13255 " lvm-set-filter 'devices ...'\n"
13260 #: ../fish/guestfish-actions.pod:2844
13261 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2844
13262 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4230
13263 #: ../src/guestfs-actions.pod:4230
13265 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
13266 "block devices in the list C<devices>, and will ignore all other attached "
13271 #: ../fish/guestfish-actions.pod:2848
13272 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2848
13273 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4234
13274 #: ../src/guestfs-actions.pod:4234
13276 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
13277 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
13278 "there are two types of duplication possible: either cloned PVs/VGs which "
13279 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
13280 "same name. In normal operation you cannot create this situation, but you "
13281 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
13282 "inside the LVM metadata."
13286 #: ../fish/guestfish-actions.pod:2861
13287 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2861
13288 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4247
13289 #: ../src/guestfs-actions.pod:4247
13290 msgid "You can filter whole block devices or individual partitions."
13294 #: ../fish/guestfish-actions.pod:2863
13295 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2863
13296 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4249
13297 #: ../src/guestfs-actions.pod:4249
13299 "You cannot use this if any VG is currently in use (eg. contains a mounted "
13300 "filesystem), even if you are not filtering out that VG."
13304 #: ../fish/guestfish-actions.pod:2867
13305 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2867
13310 #: ../fish/guestfish-actions.pod:2869
13311 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2869
13314 " lvremove device\n"
13319 #: ../fish/guestfish-actions.pod:2871
13320 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2871
13321 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4263
13322 #: ../src/guestfs-actions.pod:4263
13324 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
13325 "LV, such as C</dev/VG/LV>."
13329 #: ../fish/guestfish-actions.pod:2874
13330 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2874
13331 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4266
13332 #: ../src/guestfs-actions.pod:4266
13334 "You can also remove all LVs in a volume group by specifying the VG name, C</"
13339 #: ../fish/guestfish-actions.pod:2877
13340 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2877
13345 #: ../fish/guestfish-actions.pod:2879
13346 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2879
13349 " lvrename logvol newlogvol\n"
13354 #: ../fish/guestfish-actions.pod:2881
13355 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2881
13356 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4280
13357 #: ../src/guestfs-actions.pod:4280
13358 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
13362 #: ../fish/guestfish-actions.pod:2883
13363 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2883
13368 #: ../fish/guestfish-actions.pod:2885
13369 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2885
13372 " lvresize device mbytes\n"
13377 #: ../fish/guestfish-actions.pod:2887
13378 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2887
13379 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4293
13380 #: ../src/guestfs-actions.pod:4293
13382 "This resizes (expands or shrinks) an existing LVM logical volume to "
13383 "C<mbytes>. When reducing, data in the reduced part is lost."
13387 #: ../fish/guestfish-actions.pod:2891
13388 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2891
13389 msgid "lvresize-free"
13393 #: ../fish/guestfish-actions.pod:2893
13394 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2893
13397 " lvresize-free lv percent\n"
13402 #: ../fish/guestfish-actions.pod:2895
13403 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2895
13404 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4308
13405 #: ../src/guestfs-actions.pod:4308
13407 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
13408 "remaining free space in the volume group. Commonly you would call this with "
13409 "pc = 100 which expands the logical volume as much as possible, using all "
13410 "remaining free space in the volume group."
13414 #: ../fish/guestfish-actions.pod:2901
13415 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2901
13420 #: ../fish/guestfish-actions.pod:2903
13421 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2903
13429 #: ../fish/guestfish-actions.pod:2905
13430 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2905
13431 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4323
13432 #: ../src/guestfs-actions.pod:4323
13434 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13439 #: ../fish/guestfish-actions.pod:2908
13440 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2908
13441 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4326
13442 #: ../src/guestfs-actions.pod:4326
13444 "This returns a list of the logical volume device names (eg. C</dev/"
13445 "VolGroup00/LogVol00>)."
13449 #: ../fish/guestfish-actions.pod:2911
13450 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2911
13451 msgid "See also L</lvs-full>, L</list-filesystems>."
13455 #: ../fish/guestfish-actions.pod:2913
13456 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2913
13461 #: ../fish/guestfish-actions.pod:2915
13462 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2915
13470 #: ../fish/guestfish-actions.pod:2917
13471 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2917
13472 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4342
13473 #: ../src/guestfs-actions.pod:4342
13475 "List all the logical volumes detected. This is the equivalent of the L<lvs"
13476 "(8)> command. The \"full\" version includes all fields."
13480 #: ../fish/guestfish-actions.pod:2920
13481 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2920
13486 #: ../fish/guestfish-actions.pod:2922
13487 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2922
13495 #: ../fish/guestfish-actions.pod:2924
13496 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2924
13497 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4357
13498 #: ../src/guestfs-actions.pod:4357
13499 msgid "This command returns the UUID of the LVM LV C<device>."
13503 #: ../fish/guestfish-actions.pod:2926
13504 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2926
13509 #: ../fish/guestfish-actions.pod:2928
13510 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2928
13513 " lxattrlist path 'names ...'\n"
13518 #: ../fish/guestfish-actions.pod:2930
13519 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2930
13520 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4371
13521 #: ../src/guestfs-actions.pod:4371
13523 "This call allows you to get the extended attributes of multiple files, where "
13524 "all files are in the directory C<path>. C<names> is the list of files from "
13529 #: ../fish/guestfish-actions.pod:2934
13530 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2934
13531 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4375
13532 #: ../src/guestfs-actions.pod:4375
13534 "On return you get a flat list of xattr structs which must be interpreted "
13535 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
13536 "C<attrval> in this struct is zero-length to indicate there was an error "
13537 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
13538 "number (the number of following attributes for this file, which could be C<"
13539 "\"0\">). Then after the first xattr struct are the zero or more attributes "
13540 "for the first named file. This repeats for the second and subsequent files."
13544 #: ../fish/guestfish-actions.pod:2944
13545 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2944
13547 "This call is intended for programs that want to efficiently list a directory "
13548 "contents without making many round-trips. See also L</lstatlist> for a "
13549 "similarly efficient call for getting standard stats. Very long directory "
13550 "listings might cause the protocol message size to be exceeded, causing this "
13551 "call to fail. The caller must split up such requests into smaller groups of "
13556 #: ../fish/guestfish-actions.pod:2952
13557 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2952
13562 #: ../fish/guestfish-actions.pod:2954
13563 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2954
13571 #: ../fish/guestfish-actions.pod:2956
13572 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2956
13573 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4405
13574 #: ../src/guestfs-actions.pod:4405
13575 msgid "Create a directory named C<path>."
13579 #: ../fish/guestfish-actions.pod:2958
13580 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2958
13585 #: ../fish/guestfish-actions.pod:2960
13586 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2960
13589 " mkdir-mode path mode\n"
13594 #: ../fish/guestfish-actions.pod:2962
13595 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2962
13596 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4418
13597 #: ../src/guestfs-actions.pod:4418
13599 "This command creates a directory, setting the initial permissions of the "
13600 "directory to C<mode>."
13604 #: ../fish/guestfish-actions.pod:2965
13605 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2965
13606 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4421
13607 #: ../src/guestfs-actions.pod:4421
13609 "For common Linux filesystems, the actual mode which is set will be C<mode & "
13610 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
13615 #: ../fish/guestfish-actions.pod:2969
13616 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2969
13617 msgid "See also L</mkdir>, L</umask>"
13621 #: ../fish/guestfish-actions.pod:2971
13622 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2971
13627 #: ../fish/guestfish-actions.pod:2973
13628 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2973
13636 #: ../fish/guestfish-actions.pod:2975
13637 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2975
13638 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4437
13639 #: ../src/guestfs-actions.pod:4437
13641 "Create a directory named C<path>, creating any parent directories as "
13642 "necessary. This is like the C<mkdir -p> shell command."
13646 #: ../fish/guestfish-actions.pod:2978
13647 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2978
13652 #: ../fish/guestfish-actions.pod:2980
13653 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2980
13656 " mkdtemp template\n"
13661 #: ../fish/guestfish-actions.pod:2982
13662 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2982
13663 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4450
13664 #: ../src/guestfs-actions.pod:4450
13666 "This command creates a temporary directory. The C<template> parameter "
13667 "should be a full pathname for the temporary directory name with the final "
13668 "six characters being \"XXXXXX\"."
13672 #: ../fish/guestfish-actions.pod:2987
13673 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2987
13674 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4455
13675 #: ../src/guestfs-actions.pod:4455
13677 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
13678 "being suitable for Windows filesystems."
13682 #: ../fish/guestfish-actions.pod:2990
13683 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2990
13684 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4458
13685 #: ../src/guestfs-actions.pod:4458
13686 msgid "The name of the temporary directory that was created is returned."
13690 #: ../fish/guestfish-actions.pod:2993
13691 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2993
13692 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4461
13693 #: ../src/guestfs-actions.pod:4461
13694 msgid "The temporary directory is created with mode 0700 and is owned by root."
13698 #: ../fish/guestfish-actions.pod:2996
13699 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2996
13700 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4464
13701 #: ../src/guestfs-actions.pod:4464
13703 "The caller is responsible for deleting the temporary directory and its "
13704 "contents after use."
13708 #: ../fish/guestfish-actions.pod:2999
13709 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:2999
13710 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4467
13711 #: ../src/guestfs-actions.pod:4467
13712 msgid "See also: L<mkdtemp(3)>"
13716 #: ../fish/guestfish-actions.pod:3001
13717 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3001
13722 #: ../fish/guestfish-actions.pod:3003
13723 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3003
13726 " mke2fs-J fstype blocksize device journal\n"
13731 #: ../fish/guestfish-actions.pod:3005
13732 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3005
13733 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4483
13734 #: ../src/guestfs-actions.pod:4483
13736 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13737 "C<journal>. It is equivalent to the command:"
13741 #: ../fish/guestfish-actions.pod:3009
13742 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3009
13743 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4487
13744 #: ../src/guestfs-actions.pod:4487
13747 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
13752 #: ../fish/guestfish-actions.pod:3011
13753 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3011
13754 msgid "See also L</mke2journal>."
13758 #: ../fish/guestfish-actions.pod:3013
13759 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3013
13764 #: ../fish/guestfish-actions.pod:3015
13765 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3015
13768 " mke2fs-JL fstype blocksize device label\n"
13773 #: ../fish/guestfish-actions.pod:3017
13774 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3017
13775 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4504
13776 #: ../src/guestfs-actions.pod:4504
13778 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13779 "the journal labeled C<label>."
13783 #: ../fish/guestfish-actions.pod:3020
13784 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3020
13785 msgid "See also L</mke2journal-L>."
13789 #: ../fish/guestfish-actions.pod:3022
13790 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3022
13795 #: ../fish/guestfish-actions.pod:3024
13796 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3024
13799 " mke2fs-JU fstype blocksize device uuid\n"
13804 #: ../fish/guestfish-actions.pod:3026
13805 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3026
13806 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4522
13807 #: ../src/guestfs-actions.pod:4522
13809 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
13810 "the journal with UUID C<uuid>."
13814 #: ../fish/guestfish-actions.pod:3029
13815 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3029
13816 msgid "See also L</mke2journal-U>."
13820 #: ../fish/guestfish-actions.pod:3031
13821 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3031
13822 msgid "mke2journal"
13826 #: ../fish/guestfish-actions.pod:3033
13827 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3033
13830 " mke2journal blocksize device\n"
13835 #: ../fish/guestfish-actions.pod:3035
13836 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3035
13837 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4538
13838 #: ../src/guestfs-actions.pod:4538
13840 "This creates an ext2 external journal on C<device>. It is equivalent to the "
13845 #: ../fish/guestfish-actions.pod:3038
13846 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3038
13847 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4541
13848 #: ../src/guestfs-actions.pod:4541
13851 " mke2fs -O journal_dev -b blocksize device\n"
13856 #: ../fish/guestfish-actions.pod:3040
13857 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3040
13858 msgid "mke2journal-L"
13862 #: ../fish/guestfish-actions.pod:3042
13863 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3042
13866 " mke2journal-L blocksize label device\n"
13871 #: ../fish/guestfish-actions.pod:3044
13872 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3044
13873 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4555
13874 #: ../src/guestfs-actions.pod:4555
13875 msgid "This creates an ext2 external journal on C<device> with label C<label>."
13879 #: ../fish/guestfish-actions.pod:3046
13880 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3046
13881 msgid "mke2journal-U"
13885 #: ../fish/guestfish-actions.pod:3048
13886 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3048
13889 " mke2journal-U blocksize uuid device\n"
13894 #: ../fish/guestfish-actions.pod:3050
13895 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3050
13896 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4569
13897 #: ../src/guestfs-actions.pod:4569
13898 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
13902 #: ../fish/guestfish-actions.pod:3052
13903 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3052
13908 #: ../fish/guestfish-actions.pod:3054
13909 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3054
13912 " mkfifo mode path\n"
13917 #: ../fish/guestfish-actions.pod:3056
13918 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3056
13920 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
13921 "is just a convenient wrapper around L</mknod>."
13925 #: ../fish/guestfish-actions.pod:3062
13926 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3062
13931 #: ../fish/guestfish-actions.pod:3064
13932 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3064
13935 " mkfs fstype device\n"
13940 #: ../fish/guestfish-actions.pod:3066
13941 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3066
13942 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4599
13943 #: ../src/guestfs-actions.pod:4599
13945 "This creates a filesystem on C<device> (usually a partition or LVM logical "
13946 "volume). The filesystem type is C<fstype>, for example C<ext3>."
13950 #: ../fish/guestfish-actions.pod:3070
13951 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3070
13956 #: ../fish/guestfish-actions.pod:3072
13957 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3072
13960 " mkfs-b fstype blocksize device\n"
13965 #: ../fish/guestfish-actions.pod:3074
13966 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3074
13968 "This call is similar to L</mkfs>, but it allows you to control the block "
13969 "size of the resulting filesystem. Supported block sizes depend on the "
13970 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
13974 #: ../fish/guestfish-actions.pod:3079 ../fish/guestfish-actions.pod:3106
13975 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3079
13976 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3106
13977 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4620
13978 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4665
13979 #: ../src/guestfs-actions.pod:4620 ../src/guestfs-actions.pod:4665
13981 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
13986 #: ../fish/guestfish-actions.pod:3082
13987 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3082
13988 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4625
13989 #: ../src/guestfs-actions.pod:4625
13991 "This function is deprecated. In new code, use the C<mkfs_opts> call instead."
13995 #: ../fish/guestfish-actions.pod:3089
13996 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3089
14001 #: ../fish/guestfish-actions.pod:3091
14002 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3091
14005 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] [sectorsize:..]\n"
14010 #: ../fish/guestfish-actions.pod:3093
14011 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3093
14012 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4652
14013 #: ../src/guestfs-actions.pod:4652
14015 "This function creates a filesystem on C<device>. The filesystem type is "
14016 "C<fstype>, for example C<ext3>."
14020 #: ../fish/guestfish-actions.pod:3100
14021 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3100
14022 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4659
14023 #: ../src/guestfs-actions.pod:4659
14024 msgid "C<blocksize>"
14028 #: ../fish/guestfish-actions.pod:3102
14029 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3102
14030 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4661
14031 #: ../src/guestfs-actions.pod:4661
14033 "The filesystem block size. Supported block sizes depend on the filesystem "
14034 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
14039 #: ../fish/guestfish-actions.pod:3109
14040 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3109
14041 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4668
14042 #: ../src/guestfs-actions.pod:4668
14043 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
14047 #: ../fish/guestfish-actions.pod:3111
14048 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3111
14049 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4670
14050 #: ../src/guestfs-actions.pod:4670
14051 msgid "C<features>"
14055 #: ../fish/guestfish-actions.pod:3113
14056 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3113
14057 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4672
14058 #: ../src/guestfs-actions.pod:4672
14059 msgid "This passes the I<-O> parameter to the external mkfs program."
14063 #: ../fish/guestfish-actions.pod:3115
14064 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3115
14065 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4674
14066 #: ../src/guestfs-actions.pod:4674
14068 "For certain filesystem types, this allows extra filesystem features to be "
14069 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
14073 #: ../fish/guestfish-actions.pod:3119
14074 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3119
14075 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4678
14076 #: ../src/guestfs-actions.pod:4678
14078 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
14083 #: ../fish/guestfish-actions.pod:3122
14084 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3122
14085 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4681
14086 #: ../src/guestfs-actions.pod:4681
14091 #: ../fish/guestfish-actions.pod:3124
14092 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3124
14093 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4683
14094 #: ../src/guestfs-actions.pod:4683
14096 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
14097 "sets the inode size (only for ext2/3/4 filesystems at present)."
14101 #: ../fish/guestfish-actions.pod:3127
14102 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3127
14103 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4686
14104 #: ../src/guestfs-actions.pod:4686
14105 msgid "C<sectorsize>"
14109 #: ../fish/guestfish-actions.pod:3129
14110 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3129
14111 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4688
14112 #: ../src/guestfs-actions.pod:4688
14114 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
14115 "sets sector size for ufs filesystem."
14119 #: ../fish/guestfish-actions.pod:3136
14120 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3136
14121 msgid "mkmountpoint"
14125 #: ../fish/guestfish-actions.pod:3138
14126 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3138
14129 " mkmountpoint exemptpath\n"
14134 #: ../fish/guestfish-actions.pod:3140
14135 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3140
14137 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
14138 "to create extra mountpoints before mounting the first filesystem."
14142 #: ../fish/guestfish-actions.pod:3144
14143 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3144
14144 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4731
14145 #: ../src/guestfs-actions.pod:4731
14147 "These calls are I<only> necessary in some very limited circumstances, mainly "
14148 "the case where you want to mount a mix of unrelated and/or read-only "
14149 "filesystems together."
14153 #: ../fish/guestfish-actions.pod:3148
14154 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3148
14155 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4735
14156 #: ../src/guestfs-actions.pod:4735
14158 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
14159 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
14160 "inside that. You can unpack this as follows in guestfish:"
14164 #: ../fish/guestfish-actions.pod:3153
14165 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3153
14166 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4740
14167 #: ../src/guestfs-actions.pod:4740
14170 " add-ro Fedora-11-i686-Live.iso\n"
14172 " mkmountpoint /cd\n"
14173 " mkmountpoint /sqsh\n"
14174 " mkmountpoint /ext3fs\n"
14175 " mount /dev/sda /cd\n"
14176 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
14177 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
14182 #: ../fish/guestfish-actions.pod:3162
14183 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3162
14184 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4749
14185 #: ../src/guestfs-actions.pod:4749
14186 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
14190 #: ../fish/guestfish-actions.pod:3164
14191 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3164
14193 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
14194 "unexpected errors if you try to mix these calls. It is safest to manually "
14195 "unmount filesystems and remove mountpoints after use."
14199 #: ../fish/guestfish-actions.pod:3168
14200 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3168
14202 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
14203 "for this to work for manual mountpoints, you must ensure that the innermost "
14204 "mountpoints have the longest pathnames, as in the example code above."
14208 #: ../fish/guestfish-actions.pod:3173
14209 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3173
14210 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4760
14211 #: ../src/guestfs-actions.pod:4760
14213 "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
14217 #: ../fish/guestfish-actions.pod:3175
14218 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3175
14220 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
14221 "L</umount-all> to be called when the handle is closed which can also trigger "
14226 #: ../fish/guestfish-actions.pod:3179
14227 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3179
14232 #: ../fish/guestfish-actions.pod:3181
14233 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3181
14236 " mknod mode devmajor devminor path\n"
14241 #: ../fish/guestfish-actions.pod:3183
14242 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3183
14243 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4779
14244 #: ../src/guestfs-actions.pod:4779
14246 "This call creates block or character special devices, or named pipes (FIFOs)."
14250 #: ../fish/guestfish-actions.pod:3186
14251 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3186
14252 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4782
14253 #: ../src/guestfs-actions.pod:4782
14255 "The C<mode> parameter should be the mode, using the standard constants. "
14256 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
14257 "used when creating block and character special devices."
14261 #: ../fish/guestfish-actions.pod:3191
14262 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3191
14264 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
14265 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
14266 "regular file). These constants are available in the standard Linux header "
14267 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
14268 "wrappers around this command which bitwise OR in the appropriate constant "
14273 #: ../fish/guestfish-actions.pod:3201
14274 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3201
14279 #: ../fish/guestfish-actions.pod:3203
14280 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3203
14283 " mknod-b mode devmajor devminor path\n"
14288 #: ../fish/guestfish-actions.pod:3205
14289 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3205
14291 "This call creates a block device node called C<path> with mode C<mode> and "
14292 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14293 "wrapper around L</mknod>."
14297 #: ../fish/guestfish-actions.pod:3211
14298 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3211
14303 #: ../fish/guestfish-actions.pod:3213
14304 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3213
14307 " mknod-c mode devmajor devminor path\n"
14312 #: ../fish/guestfish-actions.pod:3215
14313 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3215
14315 "This call creates a char device node called C<path> with mode C<mode> and "
14316 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
14317 "wrapper around L</mknod>."
14321 #: ../fish/guestfish-actions.pod:3221
14322 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3221
14327 #: ../fish/guestfish-actions.pod:3223
14328 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3223
14336 #: ../fish/guestfish-actions.pod:3225
14337 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3225
14338 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4845
14339 #: ../src/guestfs-actions.pod:4845
14340 msgid "Create a swap partition on C<device>."
14344 #: ../fish/guestfish-actions.pod:3227
14345 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3227
14350 #: ../fish/guestfish-actions.pod:3229
14351 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3229
14354 " mkswap-L label device\n"
14359 #: ../fish/guestfish-actions.pod:3231
14360 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3231
14361 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4858
14362 #: ../src/guestfs-actions.pod:4858
14363 msgid "Create a swap partition on C<device> with label C<label>."
14367 #: ../fish/guestfish-actions.pod:3233
14368 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3233
14369 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4860
14370 #: ../src/guestfs-actions.pod:4860
14372 "Note that you cannot attach a swap label to a block device (eg. C</dev/"
14373 "sda>), just to a partition. This appears to be a limitation of the kernel "
14378 #: ../fish/guestfish-actions.pod:3237
14379 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3237
14384 #: ../fish/guestfish-actions.pod:3239
14385 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3239
14388 " mkswap-U uuid device\n"
14393 #: ../fish/guestfish-actions.pod:3241
14394 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3241
14395 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4875
14396 #: ../src/guestfs-actions.pod:4875
14397 msgid "Create a swap partition on C<device> with UUID C<uuid>."
14401 #: ../fish/guestfish-actions.pod:3243
14402 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3243
14403 msgid "mkswap-file"
14407 #: ../fish/guestfish-actions.pod:3245
14408 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3245
14411 " mkswap-file path\n"
14416 #: ../fish/guestfish-actions.pod:3247
14417 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3247
14418 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4887
14419 #: ../src/guestfs-actions.pod:4887
14420 msgid "Create a swap file."
14424 #: ../fish/guestfish-actions.pod:3249
14425 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3249
14427 "This command just writes a swap file signature to an existing file. To "
14428 "create the file itself, use something like L</fallocate>."
14432 #: ../fish/guestfish-actions.pod:3252
14433 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3252
14438 #: ../fish/guestfish-actions.pod:3254
14439 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3254
14442 " modprobe modulename\n"
14447 #: ../fish/guestfish-actions.pod:3256
14448 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3256
14449 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4902
14450 #: ../src/guestfs-actions.pod:4902
14451 msgid "This loads a kernel module in the appliance."
14455 #: ../fish/guestfish-actions.pod:3258
14456 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3258
14457 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4904
14458 #: ../src/guestfs-actions.pod:4904
14460 "The kernel module must have been whitelisted when libguestfs was built (see "
14461 "C<appliance/kmod.whitelist.in> in the source)."
14465 #: ../fish/guestfish-actions.pod:3261
14466 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3261
14471 #: ../fish/guestfish-actions.pod:3263
14472 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3263
14475 " mount device mountpoint\n"
14480 #: ../fish/guestfish-actions.pod:3265
14481 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3265
14482 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4918
14483 #: ../src/guestfs-actions.pod:4918
14485 "Mount a guest disk at a position in the filesystem. Block devices are named "
14486 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
14487 "those block devices contain partitions, they will have the usual names (eg. "
14488 "C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
14492 #: ../fish/guestfish-actions.pod:3271
14493 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3271
14494 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4924
14495 #: ../src/guestfs-actions.pod:4924
14497 "The rules are the same as for L<mount(2)>: A filesystem must first be "
14498 "mounted on C</> before others can be mounted. Other filesystems can only be "
14499 "mounted on directories which already exist."
14503 #: ../fish/guestfish-actions.pod:3276
14504 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3276
14505 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4929
14506 #: ../src/guestfs-actions.pod:4929
14508 "The mounted filesystem is writable, if we have sufficient permissions on the "
14509 "underlying device."
14513 #: ../fish/guestfish-actions.pod:3279
14514 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3279
14516 "B<Important note:> When you use this call, the filesystem options C<sync> "
14517 "and C<noatime> are set implicitly. This was originally done because we "
14518 "thought it would improve reliability, but it turns out that I<-o sync> has a "
14519 "very large negative performance impact and negligible effect on "
14520 "reliability. Therefore we recommend that you avoid using L</mount> in any "
14521 "code that needs performance, and instead use L</mount-options> (use an empty "
14522 "string for the first parameter if you don't want any options)."
14526 #: ../fish/guestfish-actions.pod:3289
14527 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3289
14528 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4944
14529 #: ../src/guestfs-actions.pod:4944
14531 "This function is deprecated. In new code, use the C<mount_options> call "
14536 #: ../fish/guestfish-actions.pod:3296
14537 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3296
14542 #: ../fish/guestfish-actions.pod:3298
14543 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3298
14546 " mount-9p mounttag mountpoint [options:..]\n"
14551 #: ../fish/guestfish-actions.pod:3300
14552 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3300
14553 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4968
14554 #: ../src/guestfs-actions.pod:4968
14556 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
14561 #: ../fish/guestfish-actions.pod:3303
14562 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3303
14563 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4971
14564 #: ../src/guestfs-actions.pod:4971
14566 "If required, C<trans=virtio> will be automatically added to the options. "
14567 "Any other options required can be passed in the optional C<options> "
14572 #: ../fish/guestfish-actions.pod:3309
14573 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3309
14578 #: ../fish/guestfish-actions.pod:3311
14579 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3311
14582 " mount-loop file mountpoint\n"
14587 #: ../fish/guestfish-actions.pod:3313
14588 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3313
14589 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5010
14590 #: ../src/guestfs-actions.pod:5010
14592 "This command lets you mount C<file> (a filesystem image in a file) on a "
14593 "mount point. It is entirely equivalent to the command C<mount -o loop file "
14598 #: ../fish/guestfish-actions.pod:3317
14599 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3317
14600 msgid "mount-options"
14604 #: ../fish/guestfish-actions.pod:3319
14605 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3319
14608 " mount-options options device mountpoint\n"
14613 #: ../fish/guestfish-actions.pod:3321
14614 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3321
14616 "This is the same as the L</mount> command, but it allows you to set the "
14617 "mount options as for the L<mount(8)> I<-o> flag."
14621 #: ../fish/guestfish-actions.pod:3325
14622 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3325
14623 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5030
14624 #: ../src/guestfs-actions.pod:5030
14626 "If the C<options> parameter is an empty string, then no options are passed "
14627 "(all options default to whatever the filesystem uses)."
14631 #: ../fish/guestfish-actions.pod:3329
14632 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3329
14637 #: ../fish/guestfish-actions.pod:3331
14638 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3331
14641 " mount-ro device mountpoint\n"
14646 #: ../fish/guestfish-actions.pod:3333
14647 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3333
14649 "This is the same as the L</mount> command, but it mounts the filesystem with "
14650 "the read-only (I<-o ro>) flag."
14654 #: ../fish/guestfish-actions.pod:3336
14655 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3336
14660 #: ../fish/guestfish-actions.pod:3338
14661 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3338
14664 " mount-vfs options vfstype device mountpoint\n"
14669 #: ../fish/guestfish-actions.pod:3340
14670 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3340
14672 "This is the same as the L</mount> command, but it allows you to set both the "
14673 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
14677 #: ../fish/guestfish-actions.pod:3344
14678 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3344
14679 msgid "mountpoints"
14683 #: ../fish/guestfish-actions.pod:3346
14684 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3346
14692 #: ../fish/guestfish-actions.pod:3348
14693 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3348
14695 "This call is similar to L</mounts>. That call returns a list of devices. "
14696 "This one returns a hash table (map) of device name to directory where the "
14697 "device is mounted."
14701 #: ../fish/guestfish-actions.pod:3352
14702 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3352
14707 #: ../fish/guestfish-actions.pod:3354
14708 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3354
14716 #: ../fish/guestfish-actions.pod:3356
14717 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3356
14718 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5091
14719 #: ../src/guestfs-actions.pod:5091
14721 "This returns the list of currently mounted filesystems. It returns the list "
14722 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
14726 #: ../fish/guestfish-actions.pod:3359
14727 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3359
14728 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5094
14729 #: ../src/guestfs-actions.pod:5094
14730 msgid "Some internal mounts are not shown."
14734 #: ../fish/guestfish-actions.pod:3361
14735 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3361
14736 msgid "See also: L</mountpoints>"
14740 #: ../fish/guestfish-actions.pod:3363
14741 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3363
14746 #: ../fish/guestfish-actions.pod:3365
14747 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3365
14755 #: ../fish/guestfish-actions.pod:3367
14756 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3367
14757 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5111
14758 #: ../src/guestfs-actions.pod:5111
14760 "This moves a file from C<src> to C<dest> where C<dest> is either a "
14761 "destination filename or destination directory."
14765 #: ../fish/guestfish-actions.pod:3370
14766 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3370
14767 msgid "ntfs-3g-probe"
14771 #: ../fish/guestfish-actions.pod:3372
14772 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3372
14775 " ntfs-3g-probe true|false device\n"
14780 #: ../fish/guestfish-actions.pod:3374
14781 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3374
14782 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5125
14783 #: ../src/guestfs-actions.pod:5125
14785 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
14786 "C<device> for mountability. (Not all NTFS volumes can be mounted read-"
14787 "write, and some cannot be mounted at all)."
14791 #: ../fish/guestfish-actions.pod:3378
14792 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3378
14793 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5129
14794 #: ../src/guestfs-actions.pod:5129
14796 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
14797 "can be mounted read-write. Set it to false if you want to test if the "
14798 "volume can be mounted read-only."
14802 #: ../fish/guestfish-actions.pod:3382
14803 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3382
14804 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5133
14805 #: ../src/guestfs-actions.pod:5133
14807 "The return value is an integer which C<0> if the operation would succeed, or "
14808 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
14812 #: ../fish/guestfish-actions.pod:3386
14813 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3386
14818 #: ../fish/guestfish-actions.pod:3388
14819 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3388
14822 " ntfsresize device\n"
14827 #: ../fish/guestfish-actions.pod:3390 ../fish/guestfish-actions.pod:3414
14828 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3390
14829 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3414
14830 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5147
14831 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5186
14832 #: ../src/guestfs-actions.pod:5147 ../src/guestfs-actions.pod:5186
14834 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
14835 "size of the underlying device."
14839 #: ../fish/guestfish-actions.pod:3393
14840 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3393
14841 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5150
14842 #: ../src/guestfs-actions.pod:5150
14844 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
14845 "consistency check (for safety). You have to boot into Windows to perform "
14846 "this check and clear this condition. Furthermore, ntfsresize refuses to "
14847 "resize filesystems which have been marked in this way. So in effect it is "
14848 "not possible to call ntfsresize multiple times on a single filesystem "
14849 "without booting into Windows between each resize."
14853 #: ../fish/guestfish-actions.pod:3401 ../fish/guestfish-actions.pod:3440
14854 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3401
14855 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3440
14856 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5158
14857 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5212
14858 #: ../src/guestfs-actions.pod:5158 ../src/guestfs-actions.pod:5212
14859 msgid "See also L<ntfsresize(8)>."
14863 #: ../fish/guestfish-actions.pod:3403 ../fish/guestfish-actions.pod:3451
14864 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3403
14865 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3451
14866 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5162
14867 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5252
14868 #: ../src/guestfs-actions.pod:5162 ../src/guestfs-actions.pod:5252
14870 "This function is deprecated. In new code, use the C<ntfsresize_opts> call "
14875 #: ../fish/guestfish-actions.pod:3410
14876 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3410
14877 msgid "ntfsresize-opts"
14881 #: ../fish/guestfish-actions.pod:3412
14882 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3412
14885 " ntfsresize-opts device [size:..] [force:..]\n"
14890 #: ../fish/guestfish-actions.pod:3423
14891 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3423
14892 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5195
14893 #: ../src/guestfs-actions.pod:5195
14895 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
14896 "resized to fit the container (eg. partition)."
14900 #: ../fish/guestfish-actions.pod:3426
14901 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3426
14902 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5198
14903 #: ../src/guestfs-actions.pod:5198
14908 #: ../fish/guestfish-actions.pod:3428
14909 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3428
14910 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5200
14911 #: ../src/guestfs-actions.pod:5200
14913 "If this option is true, then force the resize of the filesystem even if the "
14914 "filesystem is marked as requiring a consistency check."
14918 #: ../fish/guestfish-actions.pod:3431
14919 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3431
14921 "After the resize operation, the filesystem is always marked as requiring a "
14922 "consistency check (for safety). You have to boot into Windows to perform "
14923 "this check and clear this condition. If you I<don't> set the C<force> "
14924 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
14925 "a single filesystem without booting into Windows between each resize."
14929 #: ../fish/guestfish-actions.pod:3444
14930 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3444
14931 msgid "ntfsresize-size"
14935 #: ../fish/guestfish-actions.pod:3446
14936 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3446
14939 " ntfsresize-size device size\n"
14944 #: ../fish/guestfish-actions.pod:3448
14945 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3448
14947 "This command is the same as L</ntfsresize> except that it allows you to "
14948 "specify the new size (in bytes) explicitly."
14952 #: ../fish/guestfish-actions.pod:3458
14953 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3458
14958 #: ../fish/guestfish-actions.pod:3460
14959 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3460
14962 " part-add device prlogex startsect endsect\n"
14967 #: ../fish/guestfish-actions.pod:3462
14968 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3462
14970 "This command adds a partition to C<device>. If there is no partition table "
14971 "on the device, call L</part-init> first."
14975 #: ../fish/guestfish-actions.pod:3465
14976 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3465
14977 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5273
14978 #: ../src/guestfs-actions.pod:5273
14980 "The C<prlogex> parameter is the type of partition. Normally you should pass "
14981 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
14982 "C<logical>) and C<e> (or C<extended>) partition types."
14986 #: ../fish/guestfish-actions.pod:3470
14987 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3470
14988 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5278
14989 #: ../src/guestfs-actions.pod:5278
14991 "C<startsect> and C<endsect> are the start and end of the partition in "
14992 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
14993 "from the end of the disk (C<-1> is the last sector)."
14997 #: ../fish/guestfish-actions.pod:3474
14998 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3474
15000 "Creating a partition which covers the whole disk is not so easy. Use L</"
15001 "part-disk> to do that."
15005 #: ../fish/guestfish-actions.pod:3477
15006 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3477
15011 #: ../fish/guestfish-actions.pod:3479
15012 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3479
15015 " part-del device partnum\n"
15020 #: ../fish/guestfish-actions.pod:3481
15021 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3481
15022 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5296
15023 #: ../src/guestfs-actions.pod:5296
15024 msgid "This command deletes the partition numbered C<partnum> on C<device>."
15028 #: ../fish/guestfish-actions.pod:3483
15029 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3483
15030 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5298
15031 #: ../src/guestfs-actions.pod:5298
15033 "Note that in the case of MBR partitioning, deleting an extended partition "
15034 "also deletes any logical partitions it contains."
15038 #: ../fish/guestfish-actions.pod:3487
15039 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3487
15044 #: ../fish/guestfish-actions.pod:3489
15045 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3489
15048 " part-disk device parttype\n"
15053 #: ../fish/guestfish-actions.pod:3491
15054 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3491
15056 "This command is simply a combination of L</part-init> followed by L</part-"
15057 "add> to create a single primary partition covering the whole disk."
15061 #: ../fish/guestfish-actions.pod:3495
15062 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3495
15064 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
15065 "possible values are described in L</part-init>."
15069 #: ../fish/guestfish-actions.pod:3501
15070 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3501
15071 msgid "part-get-bootable"
15075 #: ../fish/guestfish-actions.pod:3503
15076 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3503
15079 " part-get-bootable device partnum\n"
15084 #: ../fish/guestfish-actions.pod:3505
15085 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3505
15086 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5334
15087 #: ../src/guestfs-actions.pod:5334
15089 "This command returns true if the partition C<partnum> on C<device> has the "
15090 "bootable flag set."
15094 #: ../fish/guestfish-actions.pod:3508
15095 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3508
15096 msgid "See also L</part-set-bootable>."
15100 #: ../fish/guestfish-actions.pod:3510
15101 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3510
15102 msgid "part-get-mbr-id"
15106 #: ../fish/guestfish-actions.pod:3512
15107 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3512
15110 " part-get-mbr-id device partnum\n"
15115 #: ../fish/guestfish-actions.pod:3514
15116 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3514
15117 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5350
15118 #: ../src/guestfs-actions.pod:5350
15120 "Returns the MBR type byte (also known as the ID byte) from the numbered "
15121 "partition C<partnum>."
15125 #: ../fish/guestfish-actions.pod:3517 ../fish/guestfish-actions.pod:3661
15126 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3517
15127 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3661
15129 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
15130 "undefined results for other partition table types (see L</part-get-"
15135 #: ../fish/guestfish-actions.pod:3521
15136 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3521
15137 msgid "part-get-parttype"
15141 #: ../fish/guestfish-actions.pod:3523
15142 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3523
15145 " part-get-parttype device\n"
15150 #: ../fish/guestfish-actions.pod:3525
15151 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3525
15152 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5367
15153 #: ../src/guestfs-actions.pod:5367
15155 "This command examines the partition table on C<device> and returns the "
15156 "partition table type (format) being used."
15160 #: ../fish/guestfish-actions.pod:3528
15161 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3528
15163 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
15164 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
15165 "possible, although unusual. See L</part-init> for a full list."
15169 #: ../fish/guestfish-actions.pod:3533
15170 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3533
15175 #: ../fish/guestfish-actions.pod:3535
15176 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3535
15179 " part-init device parttype\n"
15184 #: ../fish/guestfish-actions.pod:3537
15185 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3537
15186 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5387
15187 #: ../src/guestfs-actions.pod:5387
15189 "This creates an empty partition table on C<device> of one of the partition "
15190 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
15191 "(for large disks)."
15195 #: ../fish/guestfish-actions.pod:3541
15196 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3541
15198 "Initially there are no partitions. Following this, you should call L</part-"
15199 "add> for each partition required."
15203 #: ../fish/guestfish-actions.pod:3544
15204 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3544
15205 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5394
15206 #: ../src/guestfs-actions.pod:5394
15207 msgid "Possible values for C<parttype> are:"
15211 #: ../fish/guestfish-actions.pod:3548
15212 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3548
15213 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5398
15214 #: ../src/guestfs-actions.pod:5398
15219 #: ../fish/guestfish-actions.pod:3550
15220 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3550
15221 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5400
15222 #: ../src/guestfs-actions.pod:5400
15227 #: ../fish/guestfish-actions.pod:3552
15228 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3552
15229 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5402
15230 #: ../src/guestfs-actions.pod:5402
15231 msgid "Intel EFI / GPT partition table."
15235 #: ../fish/guestfish-actions.pod:3554
15236 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3554
15237 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5404
15238 #: ../src/guestfs-actions.pod:5404
15240 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
15241 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
15242 "the C<mbr> format."
15246 #: ../fish/guestfish-actions.pod:3558
15247 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3558
15248 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5408
15249 #: ../src/guestfs-actions.pod:5408
15254 #: ../fish/guestfish-actions.pod:3560
15255 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3560
15256 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5410
15257 #: ../src/guestfs-actions.pod:5410
15262 #: ../fish/guestfish-actions.pod:3562
15263 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3562
15264 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5412
15265 #: ../src/guestfs-actions.pod:5412
15267 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
15268 "Windows. This partition type will B<only> work for device sizes up to 2 "
15269 "TB. For large disks we recommend using C<gpt>."
15273 #: ../fish/guestfish-actions.pod:3569
15274 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3569
15275 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5419
15276 #: ../src/guestfs-actions.pod:5419
15278 "Other partition table types that may work but are not supported include:"
15282 #: ../fish/guestfish-actions.pod:3574
15283 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3574
15284 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5424
15285 #: ../src/guestfs-actions.pod:5424
15290 #: ../fish/guestfish-actions.pod:3576
15291 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3576
15292 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5426
15293 #: ../src/guestfs-actions.pod:5426
15294 msgid "AIX disk labels."
15298 #: ../fish/guestfish-actions.pod:3578
15299 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3578
15300 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5428
15301 #: ../src/guestfs-actions.pod:5428
15306 #: ../fish/guestfish-actions.pod:3580
15307 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3580
15308 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5430
15309 #: ../src/guestfs-actions.pod:5430
15314 #: ../fish/guestfish-actions.pod:3582
15315 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3582
15316 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5432
15317 #: ../src/guestfs-actions.pod:5432
15318 msgid "Amiga \"Rigid Disk Block\" format."
15322 #: ../fish/guestfish-actions.pod:3584
15323 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3584
15324 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5434
15325 #: ../src/guestfs-actions.pod:5434
15330 #: ../fish/guestfish-actions.pod:3586
15331 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3586
15332 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5436
15333 #: ../src/guestfs-actions.pod:5436
15334 msgid "BSD disk labels."
15338 #: ../fish/guestfish-actions.pod:3588
15339 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3588
15340 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5438
15341 #: ../src/guestfs-actions.pod:5438
15346 #: ../fish/guestfish-actions.pod:3590
15347 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3590
15348 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5440
15349 #: ../src/guestfs-actions.pod:5440
15350 msgid "DASD, used on IBM mainframes."
15354 #: ../fish/guestfish-actions.pod:3592
15355 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3592
15356 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5442
15357 #: ../src/guestfs-actions.pod:5442
15362 #: ../fish/guestfish-actions.pod:3594
15363 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3594
15364 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5444
15365 #: ../src/guestfs-actions.pod:5444
15366 msgid "MIPS/SGI volumes."
15370 #: ../fish/guestfish-actions.pod:3596
15371 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3596
15372 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5446
15373 #: ../src/guestfs-actions.pod:5446
15378 #: ../fish/guestfish-actions.pod:3598
15379 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3598
15380 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5448
15381 #: ../src/guestfs-actions.pod:5448
15382 msgid "Old Mac partition format. Modern Macs use C<gpt>."
15386 #: ../fish/guestfish-actions.pod:3600
15387 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3600
15388 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5450
15389 #: ../src/guestfs-actions.pod:5450
15394 #: ../fish/guestfish-actions.pod:3602
15395 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3602
15396 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5452
15397 #: ../src/guestfs-actions.pod:5452
15398 msgid "NEC PC-98 format, common in Japan apparently."
15402 #: ../fish/guestfish-actions.pod:3604
15403 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3604
15404 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5454
15405 #: ../src/guestfs-actions.pod:5454
15410 #: ../fish/guestfish-actions.pod:3606
15411 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3606
15412 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5456
15413 #: ../src/guestfs-actions.pod:5456
15414 msgid "Sun disk labels."
15418 #: ../fish/guestfish-actions.pod:3610
15419 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3610
15424 #: ../fish/guestfish-actions.pod:3612
15425 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3612
15428 " part-list device\n"
15433 #: ../fish/guestfish-actions.pod:3614
15434 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3614
15435 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5470
15436 #: ../src/guestfs-actions.pod:5470
15438 "This command parses the partition table on C<device> and returns the list of "
15439 "partitions found."
15443 #: ../fish/guestfish-actions.pod:3617
15444 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3617
15445 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5473
15446 #: ../src/guestfs-actions.pod:5473
15447 msgid "The fields in the returned structure are:"
15451 #: ../fish/guestfish-actions.pod:3621
15452 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3621
15453 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5477
15454 #: ../src/guestfs-actions.pod:5477
15455 msgid "B<part_num>"
15459 #: ../fish/guestfish-actions.pod:3623
15460 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3623
15461 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5479
15462 #: ../src/guestfs-actions.pod:5479
15463 msgid "Partition number, counting from 1."
15467 #: ../fish/guestfish-actions.pod:3625
15468 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3625
15469 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5481
15470 #: ../src/guestfs-actions.pod:5481
15471 msgid "B<part_start>"
15475 #: ../fish/guestfish-actions.pod:3627
15476 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3627
15478 "Start of the partition I<in bytes>. To get sectors you have to divide by "
15479 "the device's sector size, see L</blockdev-getss>."
15483 #: ../fish/guestfish-actions.pod:3630
15484 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3630
15485 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5486
15486 #: ../src/guestfs-actions.pod:5486
15487 msgid "B<part_end>"
15491 #: ../fish/guestfish-actions.pod:3632
15492 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3632
15493 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5488
15494 #: ../src/guestfs-actions.pod:5488
15495 msgid "End of the partition in bytes."
15499 #: ../fish/guestfish-actions.pod:3634
15500 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3634
15501 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5490
15502 #: ../src/guestfs-actions.pod:5490
15503 msgid "B<part_size>"
15507 #: ../fish/guestfish-actions.pod:3636
15508 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3636
15509 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5492
15510 #: ../src/guestfs-actions.pod:5492
15511 msgid "Size of the partition in bytes."
15515 #: ../fish/guestfish-actions.pod:3640
15516 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3640
15517 msgid "part-set-bootable"
15521 #: ../fish/guestfish-actions.pod:3642
15522 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3642
15525 " part-set-bootable device partnum true|false\n"
15530 #: ../fish/guestfish-actions.pod:3644
15531 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3644
15532 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5510
15533 #: ../src/guestfs-actions.pod:5510
15535 "This sets the bootable flag on partition numbered C<partnum> on device "
15536 "C<device>. Note that partitions are numbered from 1."
15540 #: ../fish/guestfish-actions.pod:3647
15541 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3647
15542 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5513
15543 #: ../src/guestfs-actions.pod:5513
15545 "The bootable flag is used by some operating systems (notably Windows) to "
15546 "determine which partition to boot from. It is by no means universally "
15551 #: ../fish/guestfish-actions.pod:3651
15552 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3651
15553 msgid "part-set-mbr-id"
15557 #: ../fish/guestfish-actions.pod:3653
15558 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3653
15561 " part-set-mbr-id device partnum idbyte\n"
15566 #: ../fish/guestfish-actions.pod:3655
15567 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3655
15568 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5529
15569 #: ../src/guestfs-actions.pod:5529
15571 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
15572 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
15573 "documentation are in fact hexadecimal numbers, but usually documented "
15574 "without any leading \"0x\" which might be confusing."
15578 #: ../fish/guestfish-actions.pod:3665
15579 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3665
15580 msgid "part-set-name"
15584 #: ../fish/guestfish-actions.pod:3667
15585 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3667
15588 " part-set-name device partnum name\n"
15593 #: ../fish/guestfish-actions.pod:3669
15594 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3669
15595 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5551
15596 #: ../src/guestfs-actions.pod:5551
15598 "This sets the partition name on partition numbered C<partnum> on device "
15599 "C<device>. Note that partitions are numbered from 1."
15603 #: ../fish/guestfish-actions.pod:3672
15604 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3672
15605 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5554
15606 #: ../src/guestfs-actions.pod:5554
15608 "The partition name can only be set on certain types of partition table. "
15609 "This works on C<gpt> but not on C<mbr> partitions."
15613 #: ../fish/guestfish-actions.pod:3675
15614 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3675
15615 msgid "part-to-dev"
15619 #: ../fish/guestfish-actions.pod:3677
15620 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3677
15623 " part-to-dev partition\n"
15628 #: ../fish/guestfish-actions.pod:3679
15629 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3679
15630 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5567
15631 #: ../src/guestfs-actions.pod:5567
15633 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
15634 "partition number, returning the device name (eg. \"/dev/sdb\")."
15638 #: ../fish/guestfish-actions.pod:3683
15639 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3683
15641 "The named partition must exist, for example as a string returned from L</"
15642 "list-partitions>."
15646 #: ../fish/guestfish-actions.pod:3686
15647 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3686
15648 msgid "ping-daemon"
15652 #: ../fish/guestfish-actions.pod:3688
15653 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3688
15661 #: ../fish/guestfish-actions.pod:3690
15662 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3690
15663 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5584
15664 #: ../src/guestfs-actions.pod:5584
15666 "This is a test probe into the guestfs daemon running inside the qemu "
15667 "subprocess. Calling this function checks that the daemon responds to the "
15668 "ping message, without affecting the daemon or attached block device(s) in "
15673 #: ../fish/guestfish-actions.pod:3695
15674 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3695
15679 #: ../fish/guestfish-actions.pod:3697
15680 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3697
15683 " pread path count offset\n"
15688 #: ../fish/guestfish-actions.pod:3699
15689 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3699
15690 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5602
15691 #: ../src/guestfs-actions.pod:5602
15693 "This command lets you read part of a file. It reads C<count> bytes of the "
15694 "file, starting at C<offset>, from file C<path>."
15698 #: ../fish/guestfish-actions.pod:3702 ../fish/guestfish-actions.pod:3717
15699 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3702
15700 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3717
15701 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5605
15702 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5631
15703 #: ../src/guestfs-actions.pod:5605 ../src/guestfs-actions.pod:5631
15705 "This may read fewer bytes than requested. For further details see the "
15706 "L<pread(2)> system call."
15710 #: ../fish/guestfish-actions.pod:3705
15711 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3705
15712 msgid "See also L</pwrite>, L</pread-device>."
15716 #: ../fish/guestfish-actions.pod:3710
15717 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3710
15718 msgid "pread-device"
15722 #: ../fish/guestfish-actions.pod:3712
15723 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3712
15726 " pread-device device count offset\n"
15731 #: ../fish/guestfish-actions.pod:3714
15732 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3714
15733 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5628
15734 #: ../src/guestfs-actions.pod:5628
15736 "This command lets you read part of a file. It reads C<count> bytes of "
15737 "C<device>, starting at C<offset>."
15741 #: ../fish/guestfish-actions.pod:3720
15742 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3720
15743 msgid "See also L</pread>."
15747 #: ../fish/guestfish-actions.pod:3725
15748 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3725
15753 #: ../fish/guestfish-actions.pod:3727
15754 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3727
15757 " pvcreate device\n"
15762 #: ../fish/guestfish-actions.pod:3729
15763 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3729
15764 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5651
15765 #: ../src/guestfs-actions.pod:5651
15767 "This creates an LVM physical volume on the named C<device>, where C<device> "
15768 "should usually be a partition name such as C</dev/sda1>."
15772 #: ../fish/guestfish-actions.pod:3733
15773 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3733
15778 #: ../fish/guestfish-actions.pod:3735
15779 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3735
15782 " pvremove device\n"
15787 #: ../fish/guestfish-actions.pod:3737
15788 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3737
15789 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5665
15790 #: ../src/guestfs-actions.pod:5665
15792 "This wipes a physical volume C<device> so that LVM will no longer recognise "
15797 #: ../fish/guestfish-actions.pod:3740
15798 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3740
15799 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5668
15800 #: ../src/guestfs-actions.pod:5668
15802 "The implementation uses the C<pvremove> command which refuses to wipe "
15803 "physical volumes that contain any volume groups, so you have to remove those "
15808 #: ../fish/guestfish-actions.pod:3744
15809 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3744
15814 #: ../fish/guestfish-actions.pod:3746
15815 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3746
15818 " pvresize device\n"
15823 #: ../fish/guestfish-actions.pod:3748
15824 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3748
15825 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5682
15826 #: ../src/guestfs-actions.pod:5682
15828 "This resizes (expands or shrinks) an existing LVM physical volume to match "
15829 "the new size of the underlying device."
15833 #: ../fish/guestfish-actions.pod:3751
15834 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3751
15835 msgid "pvresize-size"
15839 #: ../fish/guestfish-actions.pod:3753
15840 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3753
15843 " pvresize-size device size\n"
15848 #: ../fish/guestfish-actions.pod:3755
15849 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3755
15851 "This command is the same as L</pvresize> except that it allows you to "
15852 "specify the new size (in bytes) explicitly."
15856 #: ../fish/guestfish-actions.pod:3758
15857 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3758
15862 #: ../fish/guestfish-actions.pod:3760
15863 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3760
15871 #: ../fish/guestfish-actions.pod:3762
15872 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3762
15873 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5708
15874 #: ../src/guestfs-actions.pod:5708
15876 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15881 #: ../fish/guestfish-actions.pod:3765
15882 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3765
15883 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5711
15884 #: ../src/guestfs-actions.pod:5711
15886 "This returns a list of just the device names that contain PVs (eg. C</dev/"
15891 #: ../fish/guestfish-actions.pod:3768
15892 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3768
15893 msgid "See also L</pvs-full>."
15897 #: ../fish/guestfish-actions.pod:3770
15898 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3770
15903 #: ../fish/guestfish-actions.pod:3772
15904 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3772
15912 #: ../fish/guestfish-actions.pod:3774
15913 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3774
15914 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5727
15915 #: ../src/guestfs-actions.pod:5727
15917 "List all the physical volumes detected. This is the equivalent of the L<pvs"
15918 "(8)> command. The \"full\" version includes all fields."
15922 #: ../fish/guestfish-actions.pod:3777
15923 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3777
15928 #: ../fish/guestfish-actions.pod:3779
15929 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3779
15937 #: ../fish/guestfish-actions.pod:3781
15938 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3781
15939 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5742
15940 #: ../src/guestfs-actions.pod:5742
15941 msgid "This command returns the UUID of the LVM PV C<device>."
15945 #: ../fish/guestfish-actions.pod:3783
15946 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3783
15951 #: ../fish/guestfish-actions.pod:3785
15952 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3785
15955 " pwrite path content offset\n"
15960 #: ../fish/guestfish-actions.pod:3787
15961 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3787
15962 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5758
15963 #: ../src/guestfs-actions.pod:5758
15965 "This command writes to part of a file. It writes the data buffer C<content> "
15966 "to the file C<path> starting at offset C<offset>."
15970 #: ../fish/guestfish-actions.pod:3790
15971 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3790
15972 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5761
15973 #: ../src/guestfs-actions.pod:5761
15975 "This command implements the L<pwrite(2)> system call, and like that system "
15976 "call it may not write the full data requested. The return value is the "
15977 "number of bytes that were actually written to the file. This could even be "
15978 "0, although short writes are unlikely for regular files in ordinary "
15983 #: ../fish/guestfish-actions.pod:3796
15984 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3796
15985 msgid "See also L</pread>, L</pwrite-device>."
15989 #: ../fish/guestfish-actions.pod:3801
15990 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3801
15991 msgid "pwrite-device"
15995 #: ../fish/guestfish-actions.pod:3803
15996 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3803
15999 " pwrite-device device content offset\n"
16004 #: ../fish/guestfish-actions.pod:3805
16005 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3805
16006 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5785
16007 #: ../src/guestfs-actions.pod:5785
16009 "This command writes to part of a device. It writes the data buffer "
16010 "C<content> to C<device> starting at offset C<offset>."
16014 #: ../fish/guestfish-actions.pod:3808
16015 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3808
16016 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5788
16017 #: ../src/guestfs-actions.pod:5788
16019 "This command implements the L<pwrite(2)> system call, and like that system "
16020 "call it may not write the full data requested (although short writes to disk "
16021 "devices and partitions are probably impossible with standard Linux kernels)."
16025 #: ../fish/guestfish-actions.pod:3813
16026 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3813
16027 msgid "See also L</pwrite>."
16031 #: ../fish/guestfish-actions.pod:3818
16032 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3818
16037 #: ../fish/guestfish-actions.pod:3820
16038 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3820
16041 " read-file path\n"
16046 #: ../fish/guestfish-actions.pod:3822
16047 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3822
16048 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5809
16049 #: ../src/guestfs-actions.pod:5809
16050 msgid "This calls returns the contents of the file C<path> as a buffer."
16054 #: ../fish/guestfish-actions.pod:3825
16055 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3825
16057 "Unlike L</cat>, this function can correctly handle files that contain "
16058 "embedded ASCII NUL characters. However unlike L</download>, this function "
16059 "is limited in the total size of file that can be handled."
16063 #: ../fish/guestfish-actions.pod:3833
16064 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3833
16069 #: ../fish/guestfish-actions.pod:3835
16070 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3835
16073 " read-lines path\n"
16078 #: ../fish/guestfish-actions.pod:3839
16079 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3839
16080 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5834
16081 #: ../src/guestfs-actions.pod:5834
16083 "The file contents are returned as a list of lines. Trailing C<LF> and "
16084 "C<CRLF> character sequences are I<not> returned."
16088 #: ../fish/guestfish-actions.pod:3842
16089 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3842
16091 "Note that this function cannot correctly handle binary files (specifically, "
16092 "files containing C<\\0> character which is treated as end of line). For "
16093 "those you need to use the L</read-file> function which has a more complex "
16098 #: ../fish/guestfish-actions.pod:3847
16099 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3847
16104 #: ../fish/guestfish-actions.pod:3849
16105 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3849
16113 #: ../fish/guestfish-actions.pod:3851
16114 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3851
16115 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5854
16116 #: ../src/guestfs-actions.pod:5854
16117 msgid "This returns the list of directory entries in directory C<dir>."
16121 #: ../fish/guestfish-actions.pod:3853
16122 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3853
16123 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5856
16124 #: ../src/guestfs-actions.pod:5856
16126 "All entries in the directory are returned, including C<.> and C<..>. The "
16127 "entries are I<not> sorted, but returned in the same order as the underlying "
16132 #: ../fish/guestfish-actions.pod:3857
16133 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3857
16134 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5860
16135 #: ../src/guestfs-actions.pod:5860
16137 "Also this call returns basic file type information about each file. The "
16138 "C<ftyp> field will contain one of the following characters:"
16142 #: ../fish/guestfish-actions.pod:3862
16143 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3862
16144 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5865
16145 #: ../src/guestfs-actions.pod:5865
16150 #: ../fish/guestfish-actions.pod:3864
16151 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3864
16152 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5867
16153 #: ../src/guestfs-actions.pod:5867
16154 msgid "Block special"
16158 #: ../fish/guestfish-actions.pod:3866
16159 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3866
16160 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5869
16161 #: ../src/guestfs-actions.pod:5869
16166 #: ../fish/guestfish-actions.pod:3868
16167 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3868
16168 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5871
16169 #: ../src/guestfs-actions.pod:5871
16170 msgid "Char special"
16174 #: ../fish/guestfish-actions.pod:3870
16175 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3870
16176 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5873
16177 #: ../src/guestfs-actions.pod:5873
16182 #: ../fish/guestfish-actions.pod:3872
16183 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3872
16184 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5875
16185 #: ../src/guestfs-actions.pod:5875
16190 #: ../fish/guestfish-actions.pod:3874
16191 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3874
16192 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5877
16193 #: ../src/guestfs-actions.pod:5877
16198 #: ../fish/guestfish-actions.pod:3876
16199 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3876
16200 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5879
16201 #: ../src/guestfs-actions.pod:5879
16202 msgid "FIFO (named pipe)"
16206 #: ../fish/guestfish-actions.pod:3878
16207 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3878
16208 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5881
16209 #: ../src/guestfs-actions.pod:5881
16214 #: ../fish/guestfish-actions.pod:3880
16215 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3880
16216 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5883
16217 #: ../src/guestfs-actions.pod:5883
16218 msgid "Symbolic link"
16222 #: ../fish/guestfish-actions.pod:3882
16223 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3882
16224 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5885
16225 #: ../src/guestfs-actions.pod:5885
16230 #: ../fish/guestfish-actions.pod:3884
16231 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3884
16232 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5887
16233 #: ../src/guestfs-actions.pod:5887
16234 msgid "Regular file"
16238 #: ../fish/guestfish-actions.pod:3886
16239 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3886
16240 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5889
16241 #: ../src/guestfs-actions.pod:5889
16246 #: ../fish/guestfish-actions.pod:3888
16247 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3888
16248 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5891
16249 #: ../src/guestfs-actions.pod:5891
16254 #: ../fish/guestfish-actions.pod:3890
16255 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3890
16256 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5893
16257 #: ../src/guestfs-actions.pod:5893
16262 #: ../fish/guestfish-actions.pod:3892
16263 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3892
16264 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5895
16265 #: ../src/guestfs-actions.pod:5895
16266 msgid "Unknown file type"
16270 #: ../fish/guestfish-actions.pod:3894
16271 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3894
16272 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5897
16273 #: ../src/guestfs-actions.pod:5897
16278 #: ../fish/guestfish-actions.pod:3896
16279 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3896
16280 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5899
16281 #: ../src/guestfs-actions.pod:5899
16283 "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
16287 #: ../fish/guestfish-actions.pod:3901
16288 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3901
16290 "This function is primarily intended for use by programs. To get a simple "
16291 "list of names, use L</ls>. To get a printable directory for human "
16292 "consumption, use L</ll>."
16296 #: ../fish/guestfish-actions.pod:3905
16297 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3905
16302 #: ../fish/guestfish-actions.pod:3907
16303 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3907
16311 #: ../fish/guestfish-actions.pod:3909
16312 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3909
16313 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5920
16314 #: ../src/guestfs-actions.pod:5920
16315 msgid "This command reads the target of a symbolic link."
16319 #: ../fish/guestfish-actions.pod:3911
16320 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3911
16321 msgid "readlinklist"
16325 #: ../fish/guestfish-actions.pod:3913
16326 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3913
16329 " readlinklist path 'names ...'\n"
16334 #: ../fish/guestfish-actions.pod:3915
16335 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3915
16336 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5934
16337 #: ../src/guestfs-actions.pod:5934
16339 "This call allows you to do a C<readlink> operation on multiple files, where "
16340 "all files are in the directory C<path>. C<names> is the list of files from "
16345 #: ../fish/guestfish-actions.pod:3919
16346 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3919
16347 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5938
16348 #: ../src/guestfs-actions.pod:5938
16350 "On return you get a list of strings, with a one-to-one correspondence to the "
16351 "C<names> list. Each string is the value of the symbolic link."
16355 #: ../fish/guestfish-actions.pod:3923
16356 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3923
16357 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5942
16358 #: ../src/guestfs-actions.pod:5942
16360 "If the C<readlink(2)> operation fails on any name, then the corresponding "
16361 "result string is the empty string C<\"\">. However the whole operation is "
16362 "completed even if there were C<readlink(2)> errors, and so you can call this "
16363 "function with names where you don't know if they are symbolic links already "
16364 "(albeit slightly less efficient)."
16368 #: ../fish/guestfish-actions.pod:3930
16369 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3930
16370 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5949
16371 #: ../src/guestfs-actions.pod:5949
16373 "This call is intended for programs that want to efficiently list a directory "
16374 "contents without making many round-trips. Very long directory listings "
16375 "might cause the protocol message size to be exceeded, causing this call to "
16376 "fail. The caller must split up such requests into smaller groups of names."
16380 #: ../fish/guestfish-actions.pod:3937
16381 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3937
16386 #: ../fish/guestfish-actions.pod:3939
16387 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3939
16395 #: ../fish/guestfish-actions.pod:3941
16396 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3941
16397 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5968
16398 #: ../src/guestfs-actions.pod:5968
16400 "Return the canonicalized absolute pathname of C<path>. The returned path "
16401 "has no C<.>, C<..> or symbolic link path elements."
16405 #: ../fish/guestfish-actions.pod:3944
16406 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3944
16407 msgid "removexattr"
16411 #: ../fish/guestfish-actions.pod:3946
16412 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3946
16415 " removexattr xattr path\n"
16420 #: ../fish/guestfish-actions.pod:3948
16421 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3948
16422 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5983
16423 #: ../src/guestfs-actions.pod:5983
16425 "This call removes the extended attribute named C<xattr> of the file C<path>."
16429 #: ../fish/guestfish-actions.pod:3951
16430 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3951
16431 msgid "See also: L</lremovexattr>, L<attr(5)>."
16435 #: ../fish/guestfish-actions.pod:3953
16436 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3953
16441 #: ../fish/guestfish-actions.pod:3955
16442 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3955
16445 " resize2fs device\n"
16450 #: ../fish/guestfish-actions.pod:3957
16451 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3957
16452 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5998
16453 #: ../src/guestfs-actions.pod:5998
16455 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
16456 "underlying device."
16460 #: ../fish/guestfish-actions.pod:3960
16461 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3960
16463 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
16464 "before calling this command. For unknown reasons C<resize2fs> sometimes "
16465 "gives an error about this and sometimes not. In any case, it is always safe "
16466 "to call L</e2fsck-f> before calling this function."
16470 #: ../fish/guestfish-actions.pod:3966
16471 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3966
16472 msgid "resize2fs-M"
16476 #: ../fish/guestfish-actions.pod:3968
16477 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3968
16480 " resize2fs-M device\n"
16485 #: ../fish/guestfish-actions.pod:3970
16486 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3970
16488 "This command is the same as L</resize2fs>, but the filesystem is resized to "
16489 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
16494 #: ../fish/guestfish-actions.pod:3974
16495 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3974
16497 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
16498 "and read the C<Block size> and C<Block count> values. These two numbers, "
16499 "multiplied together, give the resulting size of the minimal filesystem in "
16504 #: ../fish/guestfish-actions.pod:3979
16505 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3979
16506 msgid "resize2fs-size"
16510 #: ../fish/guestfish-actions.pod:3981
16511 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3981
16514 " resize2fs-size device size\n"
16519 #: ../fish/guestfish-actions.pod:3983
16520 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3983
16522 "This command is the same as L</resize2fs> except that it allows you to "
16523 "specify the new size (in bytes) explicitly."
16527 #: ../fish/guestfish-actions.pod:3986
16528 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3986
16533 #: ../fish/guestfish-actions.pod:3988
16534 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3988
16542 #: ../fish/guestfish-actions.pod:3990
16543 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3990
16544 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6050
16545 #: ../src/guestfs-actions.pod:6050
16546 msgid "Remove the single file C<path>."
16550 #: ../fish/guestfish-actions.pod:3992
16551 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3992
16556 #: ../fish/guestfish-actions.pod:3994
16557 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3994
16565 #: ../fish/guestfish-actions.pod:3996
16566 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:3996
16567 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6062
16568 #: ../src/guestfs-actions.pod:6062
16570 "Remove the file or directory C<path>, recursively removing the contents if "
16571 "its a directory. This is like the C<rm -rf> shell command."
16575 #: ../fish/guestfish-actions.pod:4000
16576 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4000
16581 #: ../fish/guestfish-actions.pod:4002
16582 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4002
16590 #: ../fish/guestfish-actions.pod:4004
16591 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4004
16592 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6076
16593 #: ../src/guestfs-actions.pod:6076
16594 msgid "Remove the single directory C<path>."
16598 #: ../fish/guestfish-actions.pod:4006
16599 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4006
16600 msgid "rmmountpoint"
16604 #: ../fish/guestfish-actions.pod:4008
16605 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4008
16608 " rmmountpoint exemptpath\n"
16613 #: ../fish/guestfish-actions.pod:4010
16614 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4010
16616 "This calls removes a mountpoint that was previously created with L</"
16617 "mkmountpoint>. See L</mkmountpoint> for full details."
16621 #: ../fish/guestfish-actions.pod:4014
16622 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4014
16623 msgid "scrub-device"
16627 #: ../fish/guestfish-actions.pod:4016
16628 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4016
16631 " scrub-device device\n"
16636 #: ../fish/guestfish-actions.pod:4018
16637 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4018
16638 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6102
16639 #: ../src/guestfs-actions.pod:6102
16641 "This command writes patterns over C<device> to make data retrieval more "
16646 #: ../fish/guestfish-actions.pod:4021 ../fish/guestfish-actions.pod:4036
16647 #: ../fish/guestfish-actions.pod:4049
16648 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4021
16649 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4036
16650 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4049
16651 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6105
16652 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6126
16653 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6145
16654 #: ../src/guestfs-actions.pod:6105 ../src/guestfs-actions.pod:6126
16655 #: ../src/guestfs-actions.pod:6145
16657 "It is an interface to the L<scrub(1)> program. See that manual page for "
16662 #: ../fish/guestfish-actions.pod:4027
16663 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4027
16668 #: ../fish/guestfish-actions.pod:4029
16669 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4029
16672 " scrub-file file\n"
16677 #: ../fish/guestfish-actions.pod:4031
16678 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4031
16679 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6121
16680 #: ../src/guestfs-actions.pod:6121
16682 "This command writes patterns over a file to make data retrieval more "
16687 #: ../fish/guestfish-actions.pod:4034
16688 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4034
16689 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6124
16690 #: ../src/guestfs-actions.pod:6124
16691 msgid "The file is I<removed> after scrubbing."
16695 #: ../fish/guestfish-actions.pod:4039
16696 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4039
16697 msgid "scrub-freespace"
16701 #: ../fish/guestfish-actions.pod:4041
16702 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4041
16705 " scrub-freespace dir\n"
16710 #: ../fish/guestfish-actions.pod:4043
16711 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4043
16713 "This command creates the directory C<dir> and then fills it with files until "
16714 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
16715 "deletes them. The intention is to scrub any free space on the partition "
16716 "containing C<dir>."
16720 #: ../fish/guestfish-actions.pod:4052
16721 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4052
16726 #: ../fish/guestfish-actions.pod:4054
16727 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4054
16732 #: ../fish/guestfish-actions.pod:4056
16733 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4056
16736 " set-append append\n"
16741 #: ../fish/guestfish-actions.pod:4058
16742 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4058
16743 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6158
16744 #: ../src/guestfs-actions.pod:6158
16746 "This function is used to add additional options to the guest kernel command "
16751 #: ../fish/guestfish-actions.pod:4061
16752 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4061
16753 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6161
16754 #: ../src/guestfs-actions.pod:6161
16756 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
16757 "environment variable."
16761 #: ../fish/guestfish-actions.pod:4064
16762 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4064
16763 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6164
16764 #: ../src/guestfs-actions.pod:6164
16766 "Setting C<append> to C<NULL> means I<no> additional options are passed "
16767 "(libguestfs always adds a few of its own)."
16771 #: ../fish/guestfish-actions.pod:4067
16772 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4067
16773 msgid "set-attach-method"
16777 #: ../fish/guestfish-actions.pod:4069
16778 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4069
16779 msgid "attach-method"
16783 #: ../fish/guestfish-actions.pod:4071
16784 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4071
16787 " set-attach-method attachmethod\n"
16792 #: ../fish/guestfish-actions.pod:4073
16793 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4073
16794 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6177
16795 #: ../src/guestfs-actions.pod:6177
16797 "Set the method that libguestfs uses to connect to the back end guestfsd "
16798 "daemon. Possible methods are:"
16802 #: ../fish/guestfish-actions.pod:4078
16803 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4078
16804 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6182
16805 #: ../libguestfs-1.11.20/src/guestfs.pod:2687 ../src/guestfs-actions.pod:6182
16806 #: ../src/guestfs.pod:2687
16807 msgid "C<appliance>"
16811 #: ../fish/guestfish-actions.pod:4080
16812 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4080
16813 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6184
16814 #: ../src/guestfs-actions.pod:6184
16816 "Launch an appliance and connect to it. This is the ordinary method and the "
16821 #: ../fish/guestfish-actions.pod:4083
16822 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4083
16823 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6187
16824 #: ../src/guestfs-actions.pod:6187
16825 msgid "C<unix:I<path>>"
16829 #: ../fish/guestfish-actions.pod:4085
16830 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4085
16831 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6189
16832 #: ../src/guestfs-actions.pod:6189
16833 msgid "Connect to the Unix domain socket I<path>."
16837 #: ../fish/guestfish-actions.pod:4087
16838 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4087
16839 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6191
16840 #: ../src/guestfs-actions.pod:6191
16842 "This method lets you connect to an existing daemon or (using virtio-serial) "
16843 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
16844 "RUNNING DAEMONS>."
16848 #: ../fish/guestfish-actions.pod:4093
16849 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4093
16850 msgid "set-autosync"
16854 #: ../fish/guestfish-actions.pod:4095
16855 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4095
16860 #: ../fish/guestfish-actions.pod:4097
16861 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4097
16864 " set-autosync true|false\n"
16869 #: ../fish/guestfish-actions.pod:4099
16870 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4099
16871 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6207
16872 #: ../src/guestfs-actions.pod:6207
16874 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
16875 "effort attempt to make filesystems consistent and synchronized when the "
16876 "handle is closed (also if the program exits without closing handles)."
16880 #: ../fish/guestfish-actions.pod:4104
16881 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4104
16882 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6212
16883 #: ../src/guestfs-actions.pod:6212
16885 "This is enabled by default (since libguestfs 1.5.24, previously it was "
16886 "disabled by default)."
16890 #: ../fish/guestfish-actions.pod:4107
16891 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4107
16896 #: ../fish/guestfish-actions.pod:4109
16897 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4109
16902 #: ../fish/guestfish-actions.pod:4111
16903 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4111
16906 " set-direct true|false\n"
16911 #: ../fish/guestfish-actions.pod:4113
16912 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4113
16913 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6225
16914 #: ../src/guestfs-actions.pod:6225
16916 "If the direct appliance mode flag is enabled, then stdin and stdout are "
16917 "passed directly through to the appliance once it is launched."
16921 #: ../fish/guestfish-actions.pod:4117
16922 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4117
16924 "One consequence of this is that log messages aren't caught by the library "
16925 "and handled by L</set-log-message-callback>, but go straight to stdout."
16929 #: ../fish/guestfish-actions.pod:4121
16930 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4121
16931 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6233
16932 #: ../src/guestfs-actions.pod:6233
16933 msgid "You probably don't want to use this unless you know what you are doing."
16937 #: ../fish/guestfish-actions.pod:4124
16938 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4124
16939 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6236
16940 #: ../src/guestfs-actions.pod:6236
16941 msgid "The default is disabled."
16945 #: ../fish/guestfish-actions.pod:4126
16946 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4126
16947 msgid "set-e2label"
16951 #: ../fish/guestfish-actions.pod:4128
16952 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4128
16955 " set-e2label device label\n"
16960 #: ../fish/guestfish-actions.pod:4130
16961 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4130
16962 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6249
16963 #: ../src/guestfs-actions.pod:6249
16965 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
16966 "C<label>. Filesystem labels are limited to 16 characters."
16970 #: ../fish/guestfish-actions.pod:4134
16971 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4134
16973 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
16974 "label on a filesystem."
16978 #: ../fish/guestfish-actions.pod:4137
16979 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4137
16984 #: ../fish/guestfish-actions.pod:4139
16985 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4139
16988 " set-e2uuid device uuid\n"
16993 #: ../fish/guestfish-actions.pod:4141
16994 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4141
16995 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6267
16996 #: ../src/guestfs-actions.pod:6267
16998 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
16999 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
17000 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
17004 #: ../fish/guestfish-actions.pod:4146
17005 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4146
17007 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
17008 "UUID of a filesystem."
17012 #: ../fish/guestfish-actions.pod:4149
17013 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4149
17014 msgid "set-memsize"
17018 #: ../fish/guestfish-actions.pod:4151
17019 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4151
17024 #: ../fish/guestfish-actions.pod:4153
17025 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4153
17028 " set-memsize memsize\n"
17033 #: ../fish/guestfish-actions.pod:4155
17034 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4155
17036 "This sets the memory size in megabytes allocated to the qemu subprocess. "
17037 "This only has any effect if called before L</launch>."
17041 #: ../fish/guestfish-actions.pod:4159
17042 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4159
17043 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6289
17044 #: ../src/guestfs-actions.pod:6289
17046 "You can also change this by setting the environment variable "
17047 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
17051 #: ../fish/guestfish-actions.pod:4166
17052 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4166
17053 msgid "set-network"
17057 #: ../fish/guestfish-actions.pod:4168
17058 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4168
17063 #: ../fish/guestfish-actions.pod:4170
17064 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4170
17067 " set-network true|false\n"
17072 #: ../fish/guestfish-actions.pod:4172
17073 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4172
17074 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6306
17075 #: ../src/guestfs-actions.pod:6306
17077 "If C<network> is true, then the network is enabled in the libguestfs "
17078 "appliance. The default is false."
17082 #: ../fish/guestfish-actions.pod:4175
17083 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4175
17084 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6309
17085 #: ../src/guestfs-actions.pod:6309
17087 "This affects whether commands are able to access the network (see L<guestfs"
17088 "(3)/RUNNING COMMANDS>)."
17092 #: ../fish/guestfish-actions.pod:4178
17093 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4178
17095 "You must call this before calling L</launch>, otherwise it has no effect."
17099 #: ../fish/guestfish-actions.pod:4181
17100 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4181
17105 #: ../fish/guestfish-actions.pod:4185
17106 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4185
17109 " set-path searchpath\n"
17114 #: ../fish/guestfish-actions.pod:4187
17115 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4187
17116 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6325
17117 #: ../src/guestfs-actions.pod:6325
17118 msgid "Set the path that libguestfs searches for kernel and initrd.img."
17122 #: ../fish/guestfish-actions.pod:4189
17123 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4189
17124 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6327
17125 #: ../src/guestfs-actions.pod:6327
17127 "The default is C<$libdir/guestfs> unless overridden by setting "
17128 "C<LIBGUESTFS_PATH> environment variable."
17132 #: ../fish/guestfish-actions.pod:4192
17133 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4192
17134 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6330
17135 #: ../src/guestfs-actions.pod:6330
17136 msgid "Setting C<path> to C<NULL> restores the default path."
17140 #: ../fish/guestfish-actions.pod:4194
17141 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4194
17146 #: ../fish/guestfish-actions.pod:4196
17147 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4196
17152 #: ../fish/guestfish-actions.pod:4198
17153 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4198
17156 " set-pgroup true|false\n"
17161 #: ../fish/guestfish-actions.pod:4200
17162 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4200
17163 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6342
17164 #: ../src/guestfs-actions.pod:6342
17166 "If C<pgroup> is true, child processes are placed into their own process "
17171 #: ../fish/guestfish-actions.pod:4203
17172 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4203
17173 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6345
17174 #: ../src/guestfs-actions.pod:6345
17176 "The practical upshot of this is that signals like C<SIGINT> (from users "
17177 "pressing C<^C>) won't be received by the child process."
17181 #: ../fish/guestfish-actions.pod:4206
17182 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4206
17183 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6348
17184 #: ../src/guestfs-actions.pod:6348
17186 "The default for this flag is false, because usually you want C<^C> to kill "
17191 #: ../fish/guestfish-actions.pod:4209
17192 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4209
17197 #: ../fish/guestfish-actions.pod:4211
17198 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4211
17203 #: ../fish/guestfish-actions.pod:4213
17204 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4213
17212 #: ../fish/guestfish-actions.pod:4215
17213 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4215
17214 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6361
17215 #: ../src/guestfs-actions.pod:6361
17216 msgid "Set the qemu binary that we will use."
17220 #: ../fish/guestfish-actions.pod:4217
17221 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4217
17222 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6363
17223 #: ../src/guestfs-actions.pod:6363
17225 "The default is chosen when the library was compiled by the configure script."
17229 #: ../fish/guestfish-actions.pod:4220
17230 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4220
17231 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6366
17232 #: ../src/guestfs-actions.pod:6366
17234 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
17239 #: ../fish/guestfish-actions.pod:4223
17240 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4223
17241 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6369
17242 #: ../src/guestfs-actions.pod:6369
17243 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
17247 #: ../fish/guestfish-actions.pod:4225
17248 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4225
17249 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6371
17250 #: ../src/guestfs-actions.pod:6371
17252 "Note that you should call this function as early as possible after creating "
17253 "the handle. This is because some pre-launch operations depend on testing "
17254 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
17255 "don't retest features, and so you might see inconsistent results. Using the "
17256 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
17257 "the qemu binary at the same time as the handle is created."
17261 #: ../fish/guestfish-actions.pod:4233
17262 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4233
17263 msgid "set-recovery-proc"
17267 #: ../fish/guestfish-actions.pod:4235
17268 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4235
17269 msgid "recovery-proc"
17273 #: ../fish/guestfish-actions.pod:4237
17274 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4237
17277 " set-recovery-proc true|false\n"
17282 #: ../fish/guestfish-actions.pod:4239
17283 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4239
17285 "If this is called with the parameter C<false> then L</launch> does not "
17286 "create a recovery process. The purpose of the recovery process is to stop "
17287 "runaway qemu processes in the case where the main program aborts abruptly."
17291 #: ../fish/guestfish-actions.pod:4244
17292 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4244
17294 "This only has any effect if called before L</launch>, and the default is "
17299 #: ../fish/guestfish-actions.pod:4247
17300 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4247
17301 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6397
17302 #: ../src/guestfs-actions.pod:6397
17304 "About the only time when you would want to disable this is if the main "
17305 "process will fork itself into the background (\"daemonize\" itself). In "
17306 "this case the recovery process thinks that the main program has disappeared "
17307 "and so kills qemu, which is not very helpful."
17311 #: ../fish/guestfish-actions.pod:4253
17312 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4253
17313 msgid "set-selinux"
17317 #: ../fish/guestfish-actions.pod:4255
17318 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4255
17323 #: ../fish/guestfish-actions.pod:4257
17324 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4257
17327 " set-selinux true|false\n"
17332 #: ../fish/guestfish-actions.pod:4259
17333 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4259
17334 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6413
17335 #: ../src/guestfs-actions.pod:6413
17337 "This sets the selinux flag that is passed to the appliance at boot time. "
17338 "The default is C<selinux=0> (disabled)."
17342 #: ../fish/guestfish-actions.pod:4262
17343 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4262
17344 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6416
17345 #: ../src/guestfs-actions.pod:6416
17347 "Note that if SELinux is enabled, it is always in Permissive mode "
17348 "(C<enforcing=0>)."
17352 #: ../fish/guestfish-actions.pod:4268
17353 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4268
17358 #: ../fish/guestfish-actions.pod:4270
17359 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4270
17364 #: ../fish/guestfish-actions.pod:4272
17365 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4272
17368 " set-trace true|false\n"
17373 #: ../fish/guestfish-actions.pod:4274
17374 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4274
17375 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6432
17376 #: ../src/guestfs-actions.pod:6432
17378 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
17379 "return values are traced."
17383 #: ../fish/guestfish-actions.pod:4277
17384 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4277
17385 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6435
17386 #: ../src/guestfs-actions.pod:6435
17388 "If you want to trace C API calls into libguestfs (and other libraries) then "
17389 "possibly a better way is to use the external ltrace(1) command."
17393 #: ../fish/guestfish-actions.pod:4281
17394 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4281
17395 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6439
17396 #: ../src/guestfs-actions.pod:6439
17398 "Command traces are disabled unless the environment variable "
17399 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
17403 #: ../fish/guestfish-actions.pod:4284
17404 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4284
17406 "Trace messages are normally sent to C<stderr>, unless you register a "
17407 "callback to send them somewhere else (see L</set-event-callback>)."
17411 #: ../fish/guestfish-actions.pod:4288
17412 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4288
17413 msgid "set-verbose"
17417 #: ../fish/guestfish-actions.pod:4290
17418 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4290
17423 #: ../fish/guestfish-actions.pod:4292
17424 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4292
17427 " set-verbose true|false\n"
17432 #: ../fish/guestfish-actions.pod:4294
17433 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4294
17434 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6456
17435 #: ../src/guestfs-actions.pod:6456
17436 msgid "If C<verbose> is true, this turns on verbose messages."
17440 #: ../fish/guestfish-actions.pod:4296
17441 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4296
17442 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6458
17443 #: ../src/guestfs-actions.pod:6458
17445 "Verbose messages are disabled unless the environment variable "
17446 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
17450 #: ../fish/guestfish-actions.pod:4299
17451 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4299
17453 "Verbose messages are normally sent to C<stderr>, unless you register a "
17454 "callback to send them somewhere else (see L</set-event-callback>)."
17458 #: ../fish/guestfish-actions.pod:4303
17459 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4303
17464 #: ../fish/guestfish-actions.pod:4305
17465 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4305
17468 " setcon context\n"
17473 #: ../fish/guestfish-actions.pod:4307
17474 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4307
17475 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6475
17476 #: ../src/guestfs-actions.pod:6475
17478 "This sets the SELinux security context of the daemon to the string "
17483 #: ../fish/guestfish-actions.pod:4310
17484 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4310
17485 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6478
17486 #: ../src/guestfs-actions.pod:6478
17487 msgid "See the documentation about SELINUX in L<guestfs(3)>."
17491 #: ../fish/guestfish-actions.pod:4312
17492 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4312
17497 #: ../fish/guestfish-actions.pod:4314
17498 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4314
17501 " setxattr xattr val vallen path\n"
17506 #: ../fish/guestfish-actions.pod:4316
17507 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4316
17508 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6493
17509 #: ../src/guestfs-actions.pod:6493
17511 "This call sets the extended attribute named C<xattr> of the file C<path> to "
17512 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
17516 #: ../fish/guestfish-actions.pod:4320
17517 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4320
17518 msgid "See also: L</lsetxattr>, L<attr(5)>."
17522 #: ../fish/guestfish-actions.pod:4322
17523 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4322
17528 #: ../fish/guestfish-actions.pod:4324
17529 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4324
17532 " sfdisk device cyls heads sectors 'lines ...'\n"
17537 #: ../fish/guestfish-actions.pod:4326
17538 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4326
17539 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6513
17540 #: ../src/guestfs-actions.pod:6513
17542 "This is a direct interface to the L<sfdisk(8)> program for creating "
17543 "partitions on block devices."
17547 #: ../fish/guestfish-actions.pod:4329
17548 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4329
17549 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6516
17550 #: ../src/guestfs-actions.pod:6516
17551 msgid "C<device> should be a block device, for example C</dev/sda>."
17555 #: ../fish/guestfish-actions.pod:4331
17556 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4331
17557 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6518
17558 #: ../src/guestfs-actions.pod:6518
17560 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
17561 "sectors on the device, which are passed directly to sfdisk as the I<-C>, I<-"
17562 "H> and I<-S> parameters. If you pass C<0> for any of these, then the "
17563 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
17564 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
17565 "the kernel) cannot work out the right geometry and you will need to tell it."
17569 #: ../fish/guestfish-actions.pod:4339
17570 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4339
17571 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6526
17572 #: ../src/guestfs-actions.pod:6526
17574 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
17575 "refer to the L<sfdisk(8)> manpage."
17579 #: ../fish/guestfish-actions.pod:4342
17580 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4342
17581 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6529
17582 #: ../src/guestfs-actions.pod:6529
17584 "To create a single partition occupying the whole disk, you would pass "
17585 "C<lines> as a single element list, when the single element being the string "
17590 #: ../fish/guestfish-actions.pod:4346
17591 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4346
17592 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
17596 #: ../fish/guestfish-actions.pod:4352 ../fish/guestfish-actions.pod:4375
17597 #: ../fish/guestfish-actions.pod:4397
17598 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4352
17599 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4375
17600 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4397
17601 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6541
17602 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6571
17603 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6604
17604 #: ../src/guestfs-actions.pod:6541 ../src/guestfs-actions.pod:6571
17605 #: ../src/guestfs-actions.pod:6604
17607 "This function is deprecated. In new code, use the C<part_add> call instead."
17611 #: ../fish/guestfish-actions.pod:4359
17612 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4359
17617 #: ../fish/guestfish-actions.pod:4361
17618 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4361
17621 " sfdiskM device 'lines ...'\n"
17626 #: ../fish/guestfish-actions.pod:4363
17627 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4363
17629 "This is a simplified interface to the L</sfdisk> command, where partition "
17630 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
17631 "you don't need to specify the cyls, heads and sectors parameters which were "
17632 "rarely if ever used anyway."
17636 #: ../fish/guestfish-actions.pod:4369
17637 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4369
17638 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
17642 #: ../fish/guestfish-actions.pod:4382
17643 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4382
17648 #: ../fish/guestfish-actions.pod:4384
17649 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4384
17652 " sfdisk-N device partnum cyls heads sectors line\n"
17657 #: ../fish/guestfish-actions.pod:4386
17658 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4386
17659 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6591
17660 #: ../src/guestfs-actions.pod:6591
17662 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
17663 "(note: C<n> counts from 1)."
17667 #: ../fish/guestfish-actions.pod:4389
17668 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4389
17670 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
17671 "cyls/heads/sectors parameters."
17675 #: ../fish/guestfish-actions.pod:4392
17676 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4392
17677 msgid "See also: L</part-add>"
17681 #: ../fish/guestfish-actions.pod:4404
17682 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4404
17683 msgid "sfdisk-disk-geometry"
17687 #: ../fish/guestfish-actions.pod:4406
17688 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4406
17691 " sfdisk-disk-geometry device\n"
17696 #: ../fish/guestfish-actions.pod:4408
17697 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4408
17699 "This displays the disk geometry of C<device> read from the partition table. "
17700 "Especially in the case where the underlying block device has been resized, "
17701 "this can be different from the kernel's idea of the geometry (see L</sfdisk-"
17702 "kernel-geometry>)."
17706 #: ../fish/guestfish-actions.pod:4413 ../fish/guestfish-actions.pod:4422
17707 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4413
17708 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4422
17709 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6624
17710 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6640
17711 #: ../src/guestfs-actions.pod:6624 ../src/guestfs-actions.pod:6640
17712 msgid "The result is in human-readable format, and not designed to be parsed."
17716 #: ../fish/guestfish-actions.pod:4416
17717 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4416
17718 msgid "sfdisk-kernel-geometry"
17722 #: ../fish/guestfish-actions.pod:4418
17723 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4418
17726 " sfdisk-kernel-geometry device\n"
17731 #: ../fish/guestfish-actions.pod:4420
17732 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4420
17733 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6638
17734 #: ../src/guestfs-actions.pod:6638
17735 msgid "This displays the kernel's idea of the geometry of C<device>."
17739 #: ../fish/guestfish-actions.pod:4425
17740 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4425
17745 #: ../fish/guestfish-actions.pod:4427
17746 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4427
17749 " sfdisk-l device\n"
17754 #: ../fish/guestfish-actions.pod:4429
17755 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4429
17756 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6654
17757 #: ../src/guestfs-actions.pod:6654
17759 "This displays the partition table on C<device>, in the human-readable output "
17760 "of the L<sfdisk(8)> command. It is not intended to be parsed."
17764 #: ../fish/guestfish-actions.pod:4433
17765 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4433
17766 msgid "See also: L</part-list>"
17770 #: ../fish/guestfish-actions.pod:4435
17771 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4435
17772 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6663
17773 #: ../src/guestfs-actions.pod:6663
17775 "This function is deprecated. In new code, use the C<part_list> call instead."
17779 #: ../fish/guestfish-actions.pod:4442
17780 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4442
17785 #: ../fish/guestfish-actions.pod:4444
17786 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4444
17794 #: ../fish/guestfish-actions.pod:4446
17795 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4446
17796 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6678
17797 #: ../src/guestfs-actions.pod:6678
17799 "This call runs a command from the guest filesystem via the guest's C</bin/"
17804 #: ../fish/guestfish-actions.pod:4449
17805 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4449
17806 msgid "This is like L</command>, but passes the command to:"
17810 #: ../fish/guestfish-actions.pod:4451
17811 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4451
17812 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6683
17813 #: ../src/guestfs-actions.pod:6683
17816 " /bin/sh -c \"command\"\n"
17821 #: ../fish/guestfish-actions.pod:4453
17822 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4453
17823 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6685
17824 #: ../src/guestfs-actions.pod:6685
17826 "Depending on the guest's shell, this usually results in wildcards being "
17827 "expanded, shell expressions being interpolated and so on."
17831 #: ../fish/guestfish-actions.pod:4457
17832 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4457
17833 msgid "All the provisos about L</command> apply to this call."
17837 #: ../fish/guestfish-actions.pod:4459
17838 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4459
17843 #: ../fish/guestfish-actions.pod:4461
17844 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4461
17847 " sh-lines command\n"
17852 #: ../fish/guestfish-actions.pod:4463
17853 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4463
17854 msgid "This is the same as L</sh>, but splits the result into a list of lines."
17858 #: ../fish/guestfish-actions.pod:4466
17859 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4466
17860 msgid "See also: L</command-lines>"
17864 #: ../fish/guestfish-actions.pod:4468
17865 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4468
17870 #: ../fish/guestfish-actions.pod:4470
17871 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4470
17879 #: ../fish/guestfish-actions.pod:4472
17880 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4472
17881 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6719
17882 #: ../src/guestfs-actions.pod:6719
17883 msgid "Sleep for C<secs> seconds."
17887 #: ../fish/guestfish-actions.pod:4474
17888 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4474
17893 #: ../fish/guestfish-actions.pod:4476
17894 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4476
17902 #: ../fish/guestfish-actions.pod:4480
17903 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4480
17904 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6733
17905 #: ../src/guestfs-actions.pod:6733
17906 msgid "This is the same as the C<stat(2)> system call."
17910 #: ../fish/guestfish-actions.pod:4482
17911 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4482
17916 #: ../fish/guestfish-actions.pod:4484
17917 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4484
17925 #: ../fish/guestfish-actions.pod:4486
17926 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4486
17927 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6747
17928 #: ../src/guestfs-actions.pod:6747
17930 "Returns file system statistics for any mounted file system. C<path> should "
17931 "be a file or directory in the mounted file system (typically it is the mount "
17932 "point itself, but it doesn't need to be)."
17936 #: ../fish/guestfish-actions.pod:4490
17937 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4490
17938 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6751
17939 #: ../src/guestfs-actions.pod:6751
17940 msgid "This is the same as the C<statvfs(2)> system call."
17944 #: ../fish/guestfish-actions.pod:4492
17945 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4492
17950 #: ../fish/guestfish-actions.pod:4494
17951 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4494
17959 #: ../fish/guestfish-actions.pod:4496
17960 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4496
17961 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6765
17962 #: ../src/guestfs-actions.pod:6765
17964 "This runs the L<strings(1)> command on a file and returns the list of "
17965 "printable strings found."
17969 #: ../fish/guestfish-actions.pod:4502
17970 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4502
17975 #: ../fish/guestfish-actions.pod:4504
17976 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4504
17979 " strings-e encoding path\n"
17984 #: ../fish/guestfish-actions.pod:4506
17985 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4506
17987 "This is like the L</strings> command, but allows you to specify the encoding "
17988 "of strings that are looked for in the source file C<path>."
17992 #: ../fish/guestfish-actions.pod:4510
17993 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4510
17994 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6788
17995 #: ../src/guestfs-actions.pod:6788
17996 msgid "Allowed encodings are:"
18000 #: ../fish/guestfish-actions.pod:4514
18001 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4514
18002 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6792
18003 #: ../src/guestfs-actions.pod:6792
18008 #: ../fish/guestfish-actions.pod:4516
18009 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4516
18011 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
18012 "ISO-8859-X (this is what L</strings> uses)."
18016 #: ../fish/guestfish-actions.pod:4519
18017 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4519
18018 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6797
18019 #: ../src/guestfs-actions.pod:6797
18024 #: ../fish/guestfish-actions.pod:4521
18025 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4521
18026 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6799
18027 #: ../src/guestfs-actions.pod:6799
18028 msgid "Single 8-bit-byte characters."
18032 #: ../fish/guestfish-actions.pod:4523
18033 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4523
18034 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6801
18035 #: ../src/guestfs-actions.pod:6801
18040 #: ../fish/guestfish-actions.pod:4525
18041 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4525
18042 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6803
18043 #: ../src/guestfs-actions.pod:6803
18044 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
18048 #: ../fish/guestfish-actions.pod:4528
18049 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4528
18050 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6806
18051 #: ../src/guestfs-actions.pod:6806
18052 msgid "l (lower case letter L)"
18056 #: ../fish/guestfish-actions.pod:4530
18057 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4530
18058 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6808
18059 #: ../src/guestfs-actions.pod:6808
18061 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
18062 "examining binaries in Windows guests."
18066 #: ../fish/guestfish-actions.pod:4533
18067 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4533
18068 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6811
18069 #: ../src/guestfs-actions.pod:6811
18074 #: ../fish/guestfish-actions.pod:4535
18075 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4535
18076 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6813
18077 #: ../src/guestfs-actions.pod:6813
18078 msgid "32-bit big endian such as UCS-4BE."
18082 #: ../fish/guestfish-actions.pod:4537
18083 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4537
18084 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6815
18085 #: ../src/guestfs-actions.pod:6815
18090 #: ../fish/guestfish-actions.pod:4539
18091 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4539
18092 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6817
18093 #: ../src/guestfs-actions.pod:6817
18094 msgid "32-bit little endian such as UCS-4LE."
18098 #: ../fish/guestfish-actions.pod:4543
18099 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4543
18100 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6821
18101 #: ../src/guestfs-actions.pod:6821
18102 msgid "The returned strings are transcoded to UTF-8."
18106 #: ../fish/guestfish-actions.pod:4548
18107 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4548
18108 msgid "swapoff-device"
18112 #: ../fish/guestfish-actions.pod:4550
18113 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4550
18116 " swapoff-device device\n"
18121 #: ../fish/guestfish-actions.pod:4552
18122 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4552
18124 "This command disables the libguestfs appliance swap device or partition "
18125 "named C<device>. See L</swapon-device>."
18129 #: ../fish/guestfish-actions.pod:4556
18130 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4556
18131 msgid "swapoff-file"
18135 #: ../fish/guestfish-actions.pod:4558
18136 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4558
18139 " swapoff-file file\n"
18144 #: ../fish/guestfish-actions.pod:4560
18145 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4560
18146 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6852
18147 #: ../src/guestfs-actions.pod:6852
18148 msgid "This command disables the libguestfs appliance swap on file."
18152 #: ../fish/guestfish-actions.pod:4562
18153 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4562
18154 msgid "swapoff-label"
18158 #: ../fish/guestfish-actions.pod:4564
18159 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4564
18162 " swapoff-label label\n"
18167 #: ../fish/guestfish-actions.pod:4566
18168 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4566
18169 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6864
18170 #: ../src/guestfs-actions.pod:6864
18172 "This command disables the libguestfs appliance swap on labeled swap "
18177 #: ../fish/guestfish-actions.pod:4569
18178 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4569
18179 msgid "swapoff-uuid"
18183 #: ../fish/guestfish-actions.pod:4571
18184 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4571
18187 " swapoff-uuid uuid\n"
18192 #: ../fish/guestfish-actions.pod:4573
18193 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4573
18194 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6877
18195 #: ../src/guestfs-actions.pod:6877
18197 "This command disables the libguestfs appliance swap partition with the given "
18202 #: ../fish/guestfish-actions.pod:4576
18203 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4576
18204 msgid "swapon-device"
18208 #: ../fish/guestfish-actions.pod:4578
18209 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4578
18212 " swapon-device device\n"
18217 #: ../fish/guestfish-actions.pod:4580
18218 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4580
18220 "This command enables the libguestfs appliance to use the swap device or "
18221 "partition named C<device>. The increased memory is made available for all "
18222 "commands, for example those run using L</command> or L</sh>."
18226 #: ../fish/guestfish-actions.pod:4585
18227 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4585
18228 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6895
18229 #: ../src/guestfs-actions.pod:6895
18231 "Note that you should not swap to existing guest swap partitions unless you "
18232 "know what you are doing. They may contain hibernation information, or other "
18233 "information that the guest doesn't want you to trash. You also risk leaking "
18234 "information about the host to the guest this way. Instead, attach a new "
18235 "host device to the guest and swap on that."
18239 #: ../fish/guestfish-actions.pod:4592
18240 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4592
18241 msgid "swapon-file"
18245 #: ../fish/guestfish-actions.pod:4594
18246 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4594
18249 " swapon-file file\n"
18254 #: ../fish/guestfish-actions.pod:4596
18255 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4596
18257 "This command enables swap to a file. See L</swapon-device> for other notes."
18261 #: ../fish/guestfish-actions.pod:4599
18262 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4599
18263 msgid "swapon-label"
18267 #: ../fish/guestfish-actions.pod:4601
18268 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4601
18271 " swapon-label label\n"
18276 #: ../fish/guestfish-actions.pod:4603
18277 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4603
18279 "This command enables swap to a labeled swap partition. See L</swapon-"
18280 "device> for other notes."
18284 #: ../fish/guestfish-actions.pod:4606
18285 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4606
18286 msgid "swapon-uuid"
18290 #: ../fish/guestfish-actions.pod:4608
18291 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4608
18294 " swapon-uuid uuid\n"
18299 #: ../fish/guestfish-actions.pod:4610
18300 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4610
18302 "This command enables swap to a swap partition with the given UUID. See L</"
18303 "swapon-device> for other notes."
18307 #: ../fish/guestfish-actions.pod:4613
18308 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4613
18313 #: ../fish/guestfish-actions.pod:4615
18314 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4615
18322 #: ../fish/guestfish-actions.pod:4617
18323 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4617
18324 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6950
18325 #: ../src/guestfs-actions.pod:6950
18327 "This syncs the disk, so that any writes are flushed through to the "
18328 "underlying disk image."
18332 #: ../fish/guestfish-actions.pod:4620
18333 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4620
18334 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6953
18335 #: ../src/guestfs-actions.pod:6953
18337 "You should always call this if you have modified a disk image, before "
18338 "closing the handle."
18342 #: ../fish/guestfish-actions.pod:4623
18343 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4623
18348 #: ../fish/guestfish-actions.pod:4625
18349 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4625
18357 #: ../fish/guestfish-actions.pod:4627
18358 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4627
18359 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6966
18360 #: ../src/guestfs-actions.pod:6966
18362 "This command returns up to the last 10 lines of a file as a list of strings."
18366 #: ../fish/guestfish-actions.pod:4633
18367 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4633
18372 #: ../fish/guestfish-actions.pod:4635
18373 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4635
18376 " tail-n nrlines path\n"
18381 #: ../fish/guestfish-actions.pod:4637
18382 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4637
18383 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6985
18384 #: ../src/guestfs-actions.pod:6985
18386 "If the parameter C<nrlines> is a positive number, this returns the last "
18387 "C<nrlines> lines of the file C<path>."
18391 #: ../fish/guestfish-actions.pod:4640
18392 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4640
18393 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6988
18394 #: ../src/guestfs-actions.pod:6988
18396 "If the parameter C<nrlines> is a negative number, this returns lines from "
18397 "the file C<path>, starting with the C<-nrlines>th line."
18401 #: ../fish/guestfish-actions.pod:4648
18402 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4648
18407 #: ../fish/guestfish-actions.pod:4650
18408 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4650
18411 " tar-in (tarfile|-) directory\n"
18416 #: ../fish/guestfish-actions.pod:4652
18417 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4652
18418 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7009
18419 #: ../src/guestfs-actions.pod:7009
18421 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
18422 "tar file) into C<directory>."
18426 #: ../fish/guestfish-actions.pod:4655
18427 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4655
18428 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
18432 #: ../fish/guestfish-actions.pod:4660
18433 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4660
18438 #: ../fish/guestfish-actions.pod:4662
18439 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4662
18442 " tar-out directory (tarfile|-)\n"
18447 #: ../fish/guestfish-actions.pod:4664
18448 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4664
18449 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7026
18450 #: ../src/guestfs-actions.pod:7026
18452 "This command packs the contents of C<directory> and downloads it to local "
18457 #: ../fish/guestfish-actions.pod:4667
18458 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4667
18459 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
18463 #: ../fish/guestfish-actions.pod:4672
18464 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4672
18469 #: ../fish/guestfish-actions.pod:4674
18470 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4674
18473 " tgz-in (tarball|-) directory\n"
18478 #: ../fish/guestfish-actions.pod:4676
18479 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4676
18480 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7043
18481 #: ../src/guestfs-actions.pod:7043
18483 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
18484 "tar file) into C<directory>."
18488 #: ../fish/guestfish-actions.pod:4679
18489 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4679
18490 msgid "To upload an uncompressed tarball, use L</tar-in>."
18494 #: ../fish/guestfish-actions.pod:4683
18495 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4683
18500 #: ../fish/guestfish-actions.pod:4685
18501 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4685
18504 " tgz-out directory (tarball|-)\n"
18509 #: ../fish/guestfish-actions.pod:4687
18510 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4687
18511 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7059
18512 #: ../src/guestfs-actions.pod:7059
18514 "This command packs the contents of C<directory> and downloads it to local "
18519 #: ../fish/guestfish-actions.pod:4690
18520 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4690
18521 msgid "To download an uncompressed tarball, use L</tar-out>."
18525 #: ../fish/guestfish-actions.pod:4694
18526 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4694
18531 #: ../fish/guestfish-actions.pod:4696
18532 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4696
18540 #: ../fish/guestfish-actions.pod:4698
18541 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4698
18542 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7074
18543 #: ../src/guestfs-actions.pod:7074
18545 "Touch acts like the L<touch(1)> command. It can be used to update the "
18546 "timestamps on a file, or, if the file does not exist, to create a new zero-"
18551 #: ../fish/guestfish-actions.pod:4702
18552 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4702
18553 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7078
18554 #: ../src/guestfs-actions.pod:7078
18556 "This command only works on regular files, and will fail on other file types "
18557 "such as directories, symbolic links, block special etc."
18561 #: ../fish/guestfish-actions.pod:4705
18562 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4705
18567 #: ../fish/guestfish-actions.pod:4707
18568 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4707
18576 #: ../fish/guestfish-actions.pod:4709
18577 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4709
18578 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7091
18579 #: ../src/guestfs-actions.pod:7091
18581 "This command truncates C<path> to a zero-length file. The file must exist "
18586 #: ../fish/guestfish-actions.pod:4712
18587 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4712
18588 msgid "truncate-size"
18592 #: ../fish/guestfish-actions.pod:4714
18593 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4714
18596 " truncate-size path size\n"
18601 #: ../fish/guestfish-actions.pod:4716
18602 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4716
18603 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7105
18604 #: ../src/guestfs-actions.pod:7105
18606 "This command truncates C<path> to size C<size> bytes. The file must exist "
18611 #: ../fish/guestfish-actions.pod:4719
18612 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4719
18614 "If the current file size is less than C<size> then the file is extended to "
18615 "the required size with zero bytes. This creates a sparse file (ie. disk "
18616 "blocks are not allocated for the file until you write to it). To create a "
18617 "non-sparse file of zeroes, use L</fallocate64> instead."
18621 #: ../fish/guestfish-actions.pod:4725
18622 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4725
18627 #: ../fish/guestfish-actions.pod:4727
18628 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4727
18631 " tune2fs-l device\n"
18636 #: ../fish/guestfish-actions.pod:4729
18637 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4729
18638 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7124
18639 #: ../src/guestfs-actions.pod:7124
18641 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
18646 #: ../fish/guestfish-actions.pod:4732
18647 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4732
18648 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7127
18649 #: ../src/guestfs-actions.pod:7127
18651 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
18652 "for more details. The list of fields returned isn't clearly defined, and "
18653 "depends on both the version of C<tune2fs> that libguestfs was built against, "
18654 "and the filesystem itself."
18658 #: ../fish/guestfish-actions.pod:4737
18659 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4737
18664 #: ../fish/guestfish-actions.pod:4739
18665 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4739
18668 " txz-in (tarball|-) directory\n"
18673 #: ../fish/guestfish-actions.pod:4741
18674 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4741
18675 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7147
18676 #: ../src/guestfs-actions.pod:7147
18678 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
18679 "tar file) into C<directory>."
18683 #: ../fish/guestfish-actions.pod:4746
18684 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4746
18689 #: ../fish/guestfish-actions.pod:4748
18690 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4748
18693 " txz-out directory (tarball|-)\n"
18698 #: ../fish/guestfish-actions.pod:4750
18699 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4750
18700 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7161
18701 #: ../src/guestfs-actions.pod:7161
18703 "This command packs the contents of C<directory> and downloads it to local "
18704 "file C<tarball> (as an xz compressed tar archive)."
18708 #: ../fish/guestfish-actions.pod:4755
18709 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4755
18714 #: ../fish/guestfish-actions.pod:4757
18715 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4757
18723 #: ../fish/guestfish-actions.pod:4759
18724 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4759
18725 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7174
18726 #: ../src/guestfs-actions.pod:7174
18728 "This function sets the mask used for creating new files and device nodes to "
18733 #: ../fish/guestfish-actions.pod:4762
18734 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4762
18735 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7177
18736 #: ../src/guestfs-actions.pod:7177
18738 "Typical umask values would be C<022> which creates new files with "
18739 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
18740 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
18744 #: ../fish/guestfish-actions.pod:4767
18745 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4767
18746 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7182
18747 #: ../src/guestfs-actions.pod:7182
18749 "The default umask is C<022>. This is important because it means that "
18750 "directories and device nodes will be created with C<0644> or C<0755> mode "
18751 "even if you specify C<0777>."
18755 #: ../fish/guestfish-actions.pod:4771
18756 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4771
18757 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
18761 #: ../fish/guestfish-actions.pod:4774
18762 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4774
18763 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7189
18764 #: ../src/guestfs-actions.pod:7189
18765 msgid "This call returns the previous umask."
18769 #: ../fish/guestfish-actions.pod:4776
18770 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4776
18775 #: ../fish/guestfish-actions.pod:4778
18776 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4778
18781 #: ../fish/guestfish-actions.pod:4780
18782 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4780
18785 " umount pathordevice\n"
18790 #: ../fish/guestfish-actions.pod:4782
18791 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4782
18792 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7201
18793 #: ../src/guestfs-actions.pod:7201
18795 "This unmounts the given filesystem. The filesystem may be specified either "
18796 "by its mountpoint (path) or the device which contains the filesystem."
18800 #: ../fish/guestfish-actions.pod:4786
18801 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4786
18806 #: ../fish/guestfish-actions.pod:4788
18807 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4788
18808 msgid "unmount-all"
18812 #: ../fish/guestfish-actions.pod:4790
18813 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4790
18821 #: ../fish/guestfish-actions.pod:4792
18822 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4792
18823 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7214
18824 #: ../src/guestfs-actions.pod:7214
18825 msgid "This unmounts all mounted filesystems."
18829 #: ../fish/guestfish-actions.pod:4794
18830 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4794
18831 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7216
18832 #: ../src/guestfs-actions.pod:7216
18833 msgid "Some internal mounts are not unmounted by this call."
18837 #: ../fish/guestfish-actions.pod:4796
18838 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4796
18843 #: ../fish/guestfish-actions.pod:4798
18844 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4798
18847 " upload (filename|-) remotefilename\n"
18852 #: ../fish/guestfish-actions.pod:4800 ../fish/guestfish-actions.pod:4813
18853 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4800
18854 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4813
18855 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7229
18856 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7253
18857 #: ../src/guestfs-actions.pod:7229 ../src/guestfs-actions.pod:7253
18858 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
18862 #: ../fish/guestfish-actions.pod:4805
18863 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4805
18864 msgid "See also L</download>."
18868 #: ../fish/guestfish-actions.pod:4809
18869 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4809
18870 msgid "upload-offset"
18874 #: ../fish/guestfish-actions.pod:4811
18875 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4811
18878 " upload-offset (filename|-) remotefilename offset\n"
18883 #: ../fish/guestfish-actions.pod:4816
18884 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4816
18885 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7256
18886 #: ../src/guestfs-actions.pod:7256
18888 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
18889 "The intention is to overwrite parts of existing files or devices, although "
18890 "if a non-existant file is specified then it is created with a \"hole\" "
18891 "before C<offset>. The size of the data written is implicit in the size of "
18892 "the source C<filename>."
18896 #: ../fish/guestfish-actions.pod:4823
18897 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4823
18899 "Note that there is no limit on the amount of data that can be uploaded with "
18900 "this call, unlike with L</pwrite>, and this call always writes the full "
18901 "amount unless an error occurs."
18905 #: ../fish/guestfish-actions.pod:4828
18906 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4828
18907 msgid "See also L</upload>, L</pwrite>."
18911 #: ../fish/guestfish-actions.pod:4832
18912 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4832
18917 #: ../fish/guestfish-actions.pod:4834
18918 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4834
18921 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
18926 #: ../fish/guestfish-actions.pod:4836
18927 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4836
18928 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7289
18929 #: ../src/guestfs-actions.pod:7289
18930 msgid "This command sets the timestamps of a file with nanosecond precision."
18934 #: ../fish/guestfish-actions.pod:4839
18935 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4839
18936 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7292
18937 #: ../src/guestfs-actions.pod:7292
18939 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
18944 #: ../fish/guestfish-actions.pod:4842
18945 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4842
18946 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7295
18947 #: ../src/guestfs-actions.pod:7295
18949 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
18950 "nanoseconds from the epoch."
18954 #: ../fish/guestfish-actions.pod:4845
18955 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4845
18956 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7298
18957 #: ../src/guestfs-actions.pod:7298
18959 "If the C<*nsecs> field contains the special value C<-1> then the "
18960 "corresponding timestamp is set to the current time. (The C<*secs> field is "
18961 "ignored in this case)."
18965 #: ../fish/guestfish-actions.pod:4849
18966 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4849
18967 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7302
18968 #: ../src/guestfs-actions.pod:7302
18970 "If the C<*nsecs> field contains the special value C<-2> then the "
18971 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
18976 #: ../fish/guestfish-actions.pod:4853
18977 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4853
18982 #: ../fish/guestfish-actions.pod:4855
18983 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4855
18991 #: ../fish/guestfish-actions.pod:4857
18992 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4857
18993 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7315
18994 #: ../src/guestfs-actions.pod:7315
18996 "Return the libguestfs version number that the program is linked against."
19000 #: ../fish/guestfish-actions.pod:4860
19001 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4860
19002 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7318
19003 #: ../src/guestfs-actions.pod:7318
19005 "Note that because of dynamic linking this is not necessarily the version of "
19006 "libguestfs that you compiled against. You can compile the program, and then "
19007 "at runtime dynamically link against a completely different C<libguestfs.so> "
19012 #: ../fish/guestfish-actions.pod:4865
19013 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4865
19014 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7323
19015 #: ../src/guestfs-actions.pod:7323
19017 "This call was added in version C<1.0.58>. In previous versions of "
19018 "libguestfs there was no way to get the version number. From C code you can "
19019 "use dynamic linker functions to find out if this symbol exists (if it "
19020 "doesn't, then it's an earlier version)."
19024 #: ../fish/guestfish-actions.pod:4871
19025 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4871
19026 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7329
19027 #: ../src/guestfs-actions.pod:7329
19029 "The call returns a structure with four elements. The first three (C<major>, "
19030 "C<minor> and C<release>) are numbers and correspond to the usual version "
19031 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
19032 "but may be used for distro-specific information."
19036 #: ../fish/guestfish-actions.pod:4877
19037 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4877
19038 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7335
19039 #: ../src/guestfs-actions.pod:7335
19041 "To construct the original version string: C<$major.$minor.$release$extra>"
19045 #: ../fish/guestfish-actions.pod:4880
19046 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4880
19047 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7338
19048 #: ../src/guestfs-actions.pod:7338
19049 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
19053 #: ../fish/guestfish-actions.pod:4882
19054 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4882
19056 "I<Note:> Don't use this call to test for availability of features. In "
19057 "enterprise distributions we backport features from later versions into "
19058 "earlier versions, making this an unreliable way to test for features. Use "
19059 "L</available> instead."
19063 #: ../fish/guestfish-actions.pod:4888
19064 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4888
19069 #: ../fish/guestfish-actions.pod:4890
19070 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4890
19073 " vfs-label device\n"
19078 #: ../fish/guestfish-actions.pod:4892
19079 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4892
19080 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7358
19081 #: ../src/guestfs-actions.pod:7358
19082 msgid "This returns the filesystem label of the filesystem on C<device>."
19086 #: ../fish/guestfish-actions.pod:4895
19087 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4895
19088 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7361
19089 #: ../src/guestfs-actions.pod:7361
19090 msgid "If the filesystem is unlabeled, this returns the empty string."
19094 #: ../fish/guestfish-actions.pod:4897
19095 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4897
19096 msgid "To find a filesystem from the label, use L</findfs-label>."
19100 #: ../fish/guestfish-actions.pod:4899
19101 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4899
19106 #: ../fish/guestfish-actions.pod:4901
19107 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4901
19110 " vfs-type device\n"
19115 #: ../fish/guestfish-actions.pod:4903
19116 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4903
19117 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7376
19118 #: ../src/guestfs-actions.pod:7376
19120 "This command gets the filesystem type corresponding to the filesystem on "
19125 #: ../fish/guestfish-actions.pod:4906
19126 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4906
19127 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7379
19128 #: ../src/guestfs-actions.pod:7379
19130 "For most filesystems, the result is the name of the Linux VFS module which "
19131 "would be used to mount this filesystem if you mounted it without specifying "
19132 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
19136 #: ../fish/guestfish-actions.pod:4911
19137 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4911
19142 #: ../fish/guestfish-actions.pod:4913
19143 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4913
19146 " vfs-uuid device\n"
19151 #: ../fish/guestfish-actions.pod:4915
19152 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4915
19153 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7395
19154 #: ../src/guestfs-actions.pod:7395
19155 msgid "This returns the filesystem UUID of the filesystem on C<device>."
19159 #: ../fish/guestfish-actions.pod:4918
19160 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4918
19161 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7398
19162 #: ../src/guestfs-actions.pod:7398
19163 msgid "If the filesystem does not have a UUID, this returns the empty string."
19167 #: ../fish/guestfish-actions.pod:4920
19168 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4920
19169 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
19173 #: ../fish/guestfish-actions.pod:4922
19174 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4922
19175 msgid "vg-activate"
19179 #: ../fish/guestfish-actions.pod:4924
19180 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4924
19183 " vg-activate true|false 'volgroups ...'\n"
19188 #: ../fish/guestfish-actions.pod:4926
19189 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4926
19190 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7414
19191 #: ../src/guestfs-actions.pod:7414
19193 "This command activates or (if C<activate> is false) deactivates all logical "
19194 "volumes in the listed volume groups C<volgroups>."
19198 #: ../fish/guestfish-actions.pod:4929
19199 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4929
19200 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7417
19201 #: ../src/guestfs-actions.pod:7417
19202 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
19206 #: ../fish/guestfish-actions.pod:4931
19207 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4931
19208 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7419
19209 #: ../src/guestfs-actions.pod:7419
19211 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
19212 "activated or deactivated."
19216 #: ../fish/guestfish-actions.pod:4934
19217 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4934
19218 msgid "vg-activate-all"
19222 #: ../fish/guestfish-actions.pod:4936
19223 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4936
19226 " vg-activate-all true|false\n"
19231 #: ../fish/guestfish-actions.pod:4938
19232 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4938
19233 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7432
19234 #: ../src/guestfs-actions.pod:7432
19236 "This command activates or (if C<activate> is false) deactivates all logical "
19237 "volumes in all volume groups."
19241 #: ../fish/guestfish-actions.pod:4941
19242 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4941
19243 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7435
19244 #: ../src/guestfs-actions.pod:7435
19245 msgid "This command is the same as running C<vgchange -a y|n>"
19249 #: ../fish/guestfish-actions.pod:4943
19250 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4943
19255 #: ../fish/guestfish-actions.pod:4945
19256 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4945
19259 " vgcreate volgroup 'physvols ...'\n"
19264 #: ../fish/guestfish-actions.pod:4947
19265 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4947
19266 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7448
19267 #: ../src/guestfs-actions.pod:7448
19269 "This creates an LVM volume group called C<volgroup> from the non-empty list "
19270 "of physical volumes C<physvols>."
19274 #: ../fish/guestfish-actions.pod:4950
19275 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4950
19280 #: ../fish/guestfish-actions.pod:4952
19281 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4952
19284 " vglvuuids vgname\n"
19289 #: ../fish/guestfish-actions.pod:4954
19290 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4954
19291 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7461
19292 #: ../src/guestfs-actions.pod:7461
19294 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
19295 "volumes created in this volume group."
19299 #: ../fish/guestfish-actions.pod:4957
19300 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4957
19302 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
19303 "logical volumes and volume groups."
19307 #: ../fish/guestfish-actions.pod:4960
19308 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4960
19309 msgid "See also L</vgpvuuids>."
19313 #: ../fish/guestfish-actions.pod:4962
19314 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4962
19319 #: ../fish/guestfish-actions.pod:4964
19320 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4964
19323 " vgpvuuids vgname\n"
19328 #: ../fish/guestfish-actions.pod:4966
19329 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4966
19330 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7481
19331 #: ../src/guestfs-actions.pod:7481
19333 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
19334 "volumes that this volume group resides on."
19338 #: ../fish/guestfish-actions.pod:4969
19339 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4969
19341 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
19342 "physical volumes and volume groups."
19346 #: ../fish/guestfish-actions.pod:4972
19347 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4972
19348 msgid "See also L</vglvuuids>."
19352 #: ../fish/guestfish-actions.pod:4974
19353 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4974
19358 #: ../fish/guestfish-actions.pod:4976
19359 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4976
19362 " vgremove vgname\n"
19367 #: ../fish/guestfish-actions.pod:4978
19368 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4978
19369 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7501
19370 #: ../src/guestfs-actions.pod:7501
19371 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
19375 #: ../fish/guestfish-actions.pod:4980
19376 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4980
19377 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7503
19378 #: ../src/guestfs-actions.pod:7503
19380 "This also forcibly removes all logical volumes in the volume group (if any)."
19384 #: ../fish/guestfish-actions.pod:4983
19385 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4983
19390 #: ../fish/guestfish-actions.pod:4985
19391 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4985
19394 " vgrename volgroup newvolgroup\n"
19399 #: ../fish/guestfish-actions.pod:4987
19400 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4987
19401 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7517
19402 #: ../src/guestfs-actions.pod:7517
19403 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
19407 #: ../fish/guestfish-actions.pod:4989
19408 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4989
19413 #: ../fish/guestfish-actions.pod:4991
19414 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4991
19422 #: ../fish/guestfish-actions.pod:4993
19423 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4993
19424 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7528
19425 #: ../src/guestfs-actions.pod:7528
19427 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19432 #: ../fish/guestfish-actions.pod:4996
19433 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4996
19434 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7531
19435 #: ../src/guestfs-actions.pod:7531
19437 "This returns a list of just the volume group names that were detected (eg. "
19442 #: ../fish/guestfish-actions.pod:4999
19443 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:4999
19444 msgid "See also L</vgs-full>."
19448 #: ../fish/guestfish-actions.pod:5001
19449 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5001
19454 #: ../fish/guestfish-actions.pod:5003
19455 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5003
19463 #: ../fish/guestfish-actions.pod:5005
19464 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5005
19465 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7547
19466 #: ../src/guestfs-actions.pod:7547
19468 "List all the volumes groups detected. This is the equivalent of the L<vgs(8)"
19469 "> command. The \"full\" version includes all fields."
19473 #: ../fish/guestfish-actions.pod:5008
19474 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5008
19479 #: ../fish/guestfish-actions.pod:5010
19480 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5010
19488 #: ../fish/guestfish-actions.pod:5012
19489 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5012
19490 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7561
19491 #: ../src/guestfs-actions.pod:7561
19493 "This rescans all block devices and rebuilds the list of LVM physical "
19494 "volumes, volume groups and logical volumes."
19498 #: ../fish/guestfish-actions.pod:5015
19499 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5015
19504 #: ../fish/guestfish-actions.pod:5017
19505 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5017
19513 #: ../fish/guestfish-actions.pod:5019
19514 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5019
19515 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7574
19516 #: ../src/guestfs-actions.pod:7574
19517 msgid "This command returns the UUID of the LVM VG named C<vgname>."
19521 #: ../fish/guestfish-actions.pod:5021
19522 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5021
19527 #: ../fish/guestfish-actions.pod:5023
19528 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5023
19536 #: ../fish/guestfish-actions.pod:5025
19537 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5025
19538 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7614
19539 #: ../src/guestfs-actions.pod:7614
19541 "This command counts the characters in a file, using the C<wc -c> external "
19546 #: ../fish/guestfish-actions.pod:5028
19547 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5028
19552 #: ../fish/guestfish-actions.pod:5030
19553 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5030
19561 #: ../fish/guestfish-actions.pod:5032
19562 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5032
19563 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7627
19564 #: ../src/guestfs-actions.pod:7627
19566 "This command counts the lines in a file, using the C<wc -l> external command."
19570 #: ../fish/guestfish-actions.pod:5035
19571 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5035
19576 #: ../fish/guestfish-actions.pod:5037
19577 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5037
19585 #: ../fish/guestfish-actions.pod:5039
19586 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5039
19587 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7640
19588 #: ../src/guestfs-actions.pod:7640
19590 "This command counts the words in a file, using the C<wc -w> external command."
19594 #: ../fish/guestfish-actions.pod:5042
19595 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5042
19600 #: ../fish/guestfish-actions.pod:5044
19601 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5044
19604 " write path content\n"
19609 #: ../fish/guestfish-actions.pod:5046
19610 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5046
19611 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7655
19612 #: ../src/guestfs-actions.pod:7655
19614 "This call creates a file called C<path>. The content of the file is the "
19615 "string C<content> (which can contain any 8 bit data)."
19619 #: ../fish/guestfish-actions.pod:5049
19620 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5049
19621 msgid "See also L</write-append>."
19625 #: ../fish/guestfish-actions.pod:5054
19626 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5054
19627 msgid "write-append"
19631 #: ../fish/guestfish-actions.pod:5056
19632 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5056
19635 " write-append path content\n"
19640 #: ../fish/guestfish-actions.pod:5058
19641 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5058
19642 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7675
19643 #: ../src/guestfs-actions.pod:7675
19645 "This call appends C<content> to the end of file C<path>. If C<path> does "
19646 "not exist, then a new file is created."
19650 #: ../fish/guestfish-actions.pod:5061
19651 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5061
19652 msgid "See also L</write>."
19656 #: ../fish/guestfish-actions.pod:5066
19657 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5066
19662 #: ../fish/guestfish-actions.pod:5068
19663 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5068
19666 " write-file path content size\n"
19671 #: ../fish/guestfish-actions.pod:5070
19672 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5070
19673 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7695
19674 #: ../src/guestfs-actions.pod:7695
19676 "This call creates a file called C<path>. The contents of the file is the "
19677 "string C<content> (which can contain any 8 bit data), with length C<size>."
19681 #: ../fish/guestfish-actions.pod:5074
19682 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5074
19683 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7699
19684 #: ../src/guestfs-actions.pod:7699
19686 "As a special case, if C<size> is C<0> then the length is calculated using "
19687 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
19691 #: ../fish/guestfish-actions.pod:5078
19692 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5078
19693 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7703
19694 #: ../src/guestfs-actions.pod:7703
19696 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
19697 "I<not> work, even if the length is specified."
19701 #: ../fish/guestfish-actions.pod:5084
19702 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5084
19703 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7711
19704 #: ../src/guestfs-actions.pod:7711
19706 "This function is deprecated. In new code, use the C<write> call instead."
19710 #: ../fish/guestfish-actions.pod:5091
19711 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5091
19716 #: ../fish/guestfish-actions.pod:5093
19717 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5093
19720 " zegrep regex path\n"
19725 #: ../fish/guestfish-actions.pod:5095
19726 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5095
19727 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7727
19728 #: ../src/guestfs-actions.pod:7727
19730 "This calls the external C<zegrep> program and returns the matching lines."
19734 #: ../fish/guestfish-actions.pod:5101
19735 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5101
19740 #: ../fish/guestfish-actions.pod:5103
19741 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5103
19744 " zegrepi regex path\n"
19749 #: ../fish/guestfish-actions.pod:5105
19750 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5105
19751 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7746
19752 #: ../src/guestfs-actions.pod:7746
19754 "This calls the external C<zegrep -i> program and returns the matching lines."
19758 #: ../fish/guestfish-actions.pod:5111
19759 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5111
19764 #: ../fish/guestfish-actions.pod:5113
19765 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5113
19773 #: ../fish/guestfish-actions.pod:5115
19774 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5115
19775 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7764
19776 #: ../src/guestfs-actions.pod:7764
19777 msgid "This command writes zeroes over the first few blocks of C<device>."
19781 #: ../fish/guestfish-actions.pod:5117
19782 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5117
19783 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7766
19784 #: ../src/guestfs-actions.pod:7766
19786 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
19787 "securely wipe the device). It should be sufficient to remove any partition "
19788 "tables, filesystem superblocks and so on."
19792 #: ../fish/guestfish-actions.pod:5121
19793 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5121
19794 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
19798 #: ../fish/guestfish-actions.pod:5124
19799 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5124
19800 msgid "zero-device"
19804 #: ../fish/guestfish-actions.pod:5126
19805 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5126
19808 " zero-device device\n"
19813 #: ../fish/guestfish-actions.pod:5128
19814 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5128
19816 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
19817 "which just zeroes the first few blocks of a device."
19821 #: ../fish/guestfish-actions.pod:5135
19822 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5135
19827 #: ../fish/guestfish-actions.pod:5137
19828 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5137
19831 " zerofree device\n"
19836 #: ../fish/guestfish-actions.pod:5139
19837 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5139
19838 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7810
19839 #: ../src/guestfs-actions.pod:7810
19841 "This runs the I<zerofree> program on C<device>. This program claims to zero "
19842 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
19843 "possible to compress the filesystem more effectively."
19847 #: ../fish/guestfish-actions.pod:5144
19848 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5144
19849 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7815
19850 #: ../src/guestfs-actions.pod:7815
19851 msgid "You should B<not> run this program if the filesystem is mounted."
19855 #: ../fish/guestfish-actions.pod:5147
19856 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5147
19857 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7818
19858 #: ../src/guestfs-actions.pod:7818
19860 "It is possible that using this program can damage the filesystem or data on "
19865 #: ../fish/guestfish-actions.pod:5150
19866 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5150
19871 #: ../fish/guestfish-actions.pod:5152
19872 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5152
19875 " zfgrep pattern path\n"
19880 #: ../fish/guestfish-actions.pod:5154
19881 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5154
19882 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7832
19883 #: ../src/guestfs-actions.pod:7832
19885 "This calls the external C<zfgrep> program and returns the matching lines."
19889 #: ../fish/guestfish-actions.pod:5160
19890 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5160
19895 #: ../fish/guestfish-actions.pod:5162
19896 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5162
19899 " zfgrepi pattern path\n"
19904 #: ../fish/guestfish-actions.pod:5164
19905 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5164
19906 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7851
19907 #: ../src/guestfs-actions.pod:7851
19909 "This calls the external C<zfgrep -i> program and returns the matching lines."
19913 #: ../fish/guestfish-actions.pod:5170
19914 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5170
19919 #: ../fish/guestfish-actions.pod:5172
19920 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5172
19923 " zfile meth path\n"
19928 #: ../fish/guestfish-actions.pod:5174
19929 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5174
19930 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7870
19931 #: ../src/guestfs-actions.pod:7870
19933 "This command runs C<file> after first decompressing C<path> using C<method>."
19937 #: ../fish/guestfish-actions.pod:5177
19938 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5177
19939 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7873
19940 #: ../src/guestfs-actions.pod:7873
19941 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
19945 #: ../fish/guestfish-actions.pod:5179
19946 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5179
19948 "Since 1.0.63, use L</file> instead which can now process compressed files."
19952 #: ../fish/guestfish-actions.pod:5182
19953 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5182
19954 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7881
19955 #: ../src/guestfs-actions.pod:7881
19957 "This function is deprecated. In new code, use the C<file> call instead."
19961 #: ../fish/guestfish-actions.pod:5189
19962 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5189
19967 #: ../fish/guestfish-actions.pod:5191
19968 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5191
19971 " zgrep regex path\n"
19976 #: ../fish/guestfish-actions.pod:5193
19977 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5193
19978 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7897
19979 #: ../src/guestfs-actions.pod:7897
19981 "This calls the external C<zgrep> program and returns the matching lines."
19985 #: ../fish/guestfish-actions.pod:5199
19986 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5199
19991 #: ../fish/guestfish-actions.pod:5201
19992 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5201
19995 " zgrepi regex path\n"
20000 #: ../fish/guestfish-actions.pod:5203
20001 #: ../libguestfs-1.11.20/fish/guestfish-actions.pod:5203
20002 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7916
20003 #: ../src/guestfs-actions.pod:7916
20005 "This calls the external C<zgrep -i> program and returns the matching lines."
20009 #: ../fish/guestfish-commands.pod:1
20010 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:1
20015 #: ../fish/guestfish-commands.pod:3
20016 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:3
20021 #: ../fish/guestfish-commands.pod:5
20022 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:5
20025 " alloc filename size\n"
20030 #: ../fish/guestfish-commands.pod:7
20031 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:7
20033 "This creates an empty (zeroed) file of the given size, and then adds so it "
20034 "can be further examined."
20038 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
20039 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:10
20040 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:182
20041 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
20045 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
20046 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:12
20047 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:184
20048 msgid "Size can be specified using standard suffixes, eg. C<1M>."
20052 #: ../fish/guestfish-commands.pod:14
20053 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:14
20055 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
20056 "image, see L</PREPARED DISK IMAGES>."
20060 #: ../fish/guestfish-commands.pod:17
20061 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:17
20066 #: ../fish/guestfish-commands.pod:19
20067 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:19
20070 " copy-in local [local ...] /remotedir\n"
20075 #: ../fish/guestfish-commands.pod:21
20076 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:21
20078 "C<copy-in> copies local files or directories recursively into the disk "
20079 "image, placing them in the directory called C</remotedir> (which must "
20080 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
20081 "other commands as necessary."
20085 #: ../fish/guestfish-commands.pod:26
20086 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:26
20088 "Multiple local files and directories can be specified, but the last "
20089 "parameter must always be a remote directory. Wildcards cannot be used."
20093 #: ../fish/guestfish-commands.pod:30
20094 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:30
20099 #: ../fish/guestfish-commands.pod:32
20100 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:32
20103 " copy-out remote [remote ...] localdir\n"
20108 #: ../fish/guestfish-commands.pod:34
20109 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:34
20111 "C<copy-out> copies remote files or directories recursively out of the disk "
20112 "image, placing them on the host disk in a local directory called C<localdir> "
20113 "(which must exist). This guestfish meta-command turns into a sequence of L</"
20114 "download>, L</tar-out> and other commands as necessary."
20118 #: ../fish/guestfish-commands.pod:40
20119 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:40
20121 "Multiple remote files and directories can be specified, but the last "
20122 "parameter must always be a local directory. To download to the current "
20123 "directory, use C<.> as in:"
20127 #: ../fish/guestfish-commands.pod:44
20128 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:44
20131 " copy-out /home .\n"
20136 #: ../fish/guestfish-commands.pod:46
20137 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:46
20139 "Wildcards cannot be used in the ordinary command, but you can use them with "
20140 "the help of L</glob> like this:"
20144 #: ../fish/guestfish-commands.pod:49
20145 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:49
20148 " glob copy-out /home/* .\n"
20153 #: ../fish/guestfish-commands.pod:51
20154 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:51
20159 #: ../fish/guestfish-commands.pod:53
20160 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:53
20163 " display filename\n"
20168 #: ../fish/guestfish-commands.pod:55
20169 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:55
20171 "Use C<display> (a graphical display program) to display an image file. It "
20172 "downloads the file, and runs C<display> on it."
20176 #: ../fish/guestfish-commands.pod:58
20177 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:58
20179 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
20180 "environment variable. For example to use the GNOME display program:"
20184 #: ../fish/guestfish-commands.pod:61
20185 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:61
20188 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
20193 #: ../fish/guestfish-commands.pod:63
20194 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:63
20195 msgid "See also L<display(1)>."
20199 #: ../fish/guestfish-commands.pod:65
20200 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:65
20205 #: ../fish/guestfish-commands.pod:67
20206 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:67
20209 " echo [params ...]\n"
20214 #: ../fish/guestfish-commands.pod:69
20215 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:69
20216 msgid "This echos the parameters to the terminal."
20220 #: ../fish/guestfish-commands.pod:71
20221 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:71
20226 #: ../fish/guestfish-commands.pod:73
20227 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:73
20232 #: ../fish/guestfish-commands.pod:75
20233 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:75
20238 #: ../fish/guestfish-commands.pod:77
20239 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:77
20247 #: ../fish/guestfish-commands.pod:79
20248 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:79
20250 "This is used to edit a file. It downloads the file, edits it locally using "
20251 "your editor, then uploads the result."
20255 #: ../fish/guestfish-commands.pod:82
20256 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:82
20258 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
20259 "or C<emacs> you will get those corresponding editors."
20263 #: ../fish/guestfish-commands.pod:86
20264 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:86
20269 #: ../fish/guestfish-commands.pod:88
20270 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:88
20273 " glob command args...\n"
20278 #: ../fish/guestfish-commands.pod:90
20279 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:90
20281 "Expand wildcards in any paths in the args list, and run C<command> "
20282 "repeatedly on each matching path."
20286 #: ../fish/guestfish-commands.pod:93
20287 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:93
20288 msgid "See L</WILDCARDS AND GLOBBING>."
20292 #: ../fish/guestfish-commands.pod:95
20293 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:95
20298 #: ../fish/guestfish-commands.pod:97
20299 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:97
20302 " hexedit <filename|device>\n"
20303 " hexedit <filename|device> <max>\n"
20304 " hexedit <filename|device> <start> <max>\n"
20309 #: ../fish/guestfish-commands.pod:101
20310 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:101
20312 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
20317 #: ../fish/guestfish-commands.pod:104
20318 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:104
20320 "This command works by downloading potentially the whole file or device, "
20321 "editing it locally, then uploading it. If the file or device is large, you "
20322 "have to specify which part you wish to edit by using C<max> and/or C<start> "
20323 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
20324 "usual modifiers allowed such as C<1M> (1 megabyte)."
20328 #: ../fish/guestfish-commands.pod:111
20329 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:111
20330 msgid "For example to edit the first few sectors of a disk you might do:"
20334 #: ../fish/guestfish-commands.pod:114
20335 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:114
20338 " hexedit /dev/sda 1M\n"
20343 #: ../fish/guestfish-commands.pod:116
20344 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:116
20346 "which would allow you to edit anywhere within the first megabyte of the disk."
20350 #: ../fish/guestfish-commands.pod:119
20351 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:119
20352 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
20356 #: ../fish/guestfish-commands.pod:121
20357 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:121
20360 " hexedit /dev/sda1 0x400 0x400\n"
20365 #: ../fish/guestfish-commands.pod:123
20366 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:123
20367 msgid "(assuming the superblock is in the standard location)."
20371 #: ../fish/guestfish-commands.pod:125
20372 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:125
20374 "This command requires the external L<hexedit(1)> program. You can specify "
20375 "another program to use by setting the C<HEXEDITOR> environment variable."
20379 #: ../fish/guestfish-commands.pod:129
20380 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:129
20381 msgid "See also L</hexdump>."
20385 #: ../fish/guestfish-commands.pod:131
20386 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:131
20391 #: ../fish/guestfish-commands.pod:133
20392 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:133
20400 #: ../fish/guestfish-commands.pod:135
20401 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:135
20403 "Change the local directory, ie. the current directory of guestfish itself."
20407 #: ../fish/guestfish-commands.pod:138
20408 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:138
20409 msgid "Note that C<!cd> won't do what you might expect."
20413 #: ../fish/guestfish-commands.pod:140
20414 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:140
20419 #: ../fish/guestfish-commands.pod:142
20420 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:142
20425 #: ../fish/guestfish-commands.pod:144
20426 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:144
20434 #: ../fish/guestfish-commands.pod:146
20435 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:146
20436 msgid "Opens the manual page for guestfish."
20440 #: ../fish/guestfish-commands.pod:148
20441 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:148
20446 #: ../fish/guestfish-commands.pod:150
20447 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:150
20452 #: ../fish/guestfish-commands.pod:152
20453 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:152
20461 #: ../fish/guestfish-commands.pod:154
20462 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:154
20470 #: ../fish/guestfish-commands.pod:156
20471 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:156
20472 msgid "This is used to view a file."
20476 #: ../fish/guestfish-commands.pod:158
20477 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:158
20479 "The default viewer is C<$PAGER>. However if you use the alternate command "
20480 "C<less> you will get the C<less> command specifically."
20484 #: ../fish/guestfish-commands.pod:161
20485 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:161
20490 #: ../fish/guestfish-commands.pod:163
20491 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:163
20499 #: ../fish/guestfish-commands.pod:165
20500 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:165
20502 "Close and reopen the libguestfs handle. It is not necessary to use this "
20503 "normally, because the handle is closed properly when guestfish exits. "
20504 "However this is occasionally useful for testing."
20508 #: ../fish/guestfish-commands.pod:169
20509 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:169
20514 #: ../fish/guestfish-commands.pod:171
20515 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:171
20518 " sparse filename size\n"
20523 #: ../fish/guestfish-commands.pod:173
20524 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:173
20526 "This creates an empty sparse file of the given size, and then adds so it can "
20527 "be further examined."
20531 #: ../fish/guestfish-commands.pod:176
20532 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:176
20534 "In all respects it works the same as the L</alloc> command, except that the "
20535 "image file is allocated sparsely, which means that disk blocks are not "
20536 "assigned to the file until they are needed. Sparse disk files only use "
20537 "space when written to, but they are slower and there is a danger you could "
20538 "run out of real disk space during a write operation."
20542 #: ../fish/guestfish-commands.pod:186
20543 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:186
20548 #: ../fish/guestfish-commands.pod:188
20549 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:188
20557 #: ../fish/guestfish-commands.pod:190
20558 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:190
20560 "This command returns a list of the optional groups known to the daemon, and "
20561 "indicates which ones are supported by this build of the libguestfs appliance."
20565 #: ../fish/guestfish-commands.pod:194
20566 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:194
20567 msgid "See also L<guestfs(3)/AVAILABILITY>."
20571 #: ../fish/guestfish-commands.pod:196
20572 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:196
20577 #: ../fish/guestfish-commands.pod:198
20578 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:198
20581 " time command args...\n"
20586 #: ../fish/guestfish-commands.pod:200
20587 #: ../libguestfs-1.11.20/fish/guestfish-commands.pod:200
20589 "Run the command as usual, but print the elapsed time afterwards. This can "
20590 "be useful for benchmarking operations."
20594 #: ../fish/guestfish.pod:5 ../libguestfs-1.11.20/fish/guestfish.pod:5
20595 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
20599 #: ../fish/guestfish.pod:9 ../libguestfs-1.11.20/fish/guestfish.pod:9
20602 " guestfish [--options] [commands]\n"
20607 #: ../fish/guestfish.pod:11 ../libguestfs-1.11.20/fish/guestfish.pod:11
20615 #: ../fish/guestfish.pod:13 ../libguestfs-1.11.20/fish/guestfish.pod:13
20618 " guestfish [--ro|--rw] -a disk.img\n"
20623 #: ../fish/guestfish.pod:15 ../libguestfs-1.11.20/fish/guestfish.pod:15
20626 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
20631 #: ../fish/guestfish.pod:17 ../libguestfs-1.11.20/fish/guestfish.pod:17
20634 " guestfish -d libvirt-domain\n"
20639 #: ../fish/guestfish.pod:19 ../libguestfs-1.11.20/fish/guestfish.pod:19
20642 " guestfish [--ro|--rw] -a disk.img -i\n"
20647 #: ../fish/guestfish.pod:21 ../libguestfs-1.11.20/fish/guestfish.pod:21
20650 " guestfish -d libvirt-domain -i\n"
20655 #: ../fish/guestfish.pod:25 ../libguestfs-1.11.20/fish/guestfish.pod:25
20657 "Using guestfish in read/write mode on live virtual machines can be "
20658 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
20659 "option to use guestfish safely if the disk image or virtual machine might be "
20664 #: ../fish/guestfish.pod:32 ../libguestfs-1.11.20/fish/guestfish.pod:32
20666 "Guestfish is a shell and command-line tool for examining and modifying "
20667 "virtual machine filesystems. It uses libguestfs and exposes all of the "
20668 "functionality of the guestfs API, see L<guestfs(3)>."
20672 #: ../fish/guestfish.pod:36 ../libguestfs-1.11.20/fish/guestfish.pod:36
20674 "Guestfish gives you structured access to the libguestfs API, from shell "
20675 "scripts or the command line or interactively. If you want to rescue a "
20676 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
20681 #: ../fish/guestfish.pod:43 ../libguestfs-1.11.20/fish/guestfish.pod:43
20682 msgid "As an interactive shell"
20686 #: ../fish/guestfish.pod:45 ../libguestfs-1.11.20/fish/guestfish.pod:45
20694 #: ../fish/guestfish.pod:47 ../libguestfs-1.11.20/fish/guestfish.pod:47
20697 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
20698 " editing virtual machine filesystems.\n"
20703 #: ../fish/guestfish.pod:50 ../libguestfs-1.11.20/fish/guestfish.pod:50
20706 " Type: 'help' for a list of commands\n"
20707 " 'man' to read the manual\n"
20708 " 'quit' to quit the shell\n"
20713 #: ../fish/guestfish.pod:54 ../libguestfs-1.11.20/fish/guestfish.pod:54
20716 " ><fs> add-ro disk.img\n"
20718 " ><fs> list-filesystems\n"
20719 " /dev/sda1: ext4\n"
20720 " /dev/vg_guest/lv_root: ext4\n"
20721 " /dev/vg_guest/lv_swap: swap\n"
20722 " ><fs> mount /dev/vg_guest/lv_root /\n"
20723 " ><fs> cat /etc/fstab\n"
20725 " # Created by anaconda\n"
20732 #: ../fish/guestfish.pod:67 ../libguestfs-1.11.20/fish/guestfish.pod:67
20733 msgid "From shell scripts"
20737 #: ../fish/guestfish.pod:69 ../libguestfs-1.11.20/fish/guestfish.pod:69
20738 msgid "Create a new C</etc/motd> file in a guest or disk image:"
20742 #: ../fish/guestfish.pod:71 ../libguestfs-1.11.20/fish/guestfish.pod:71
20745 " guestfish <<_EOF_\n"
20748 " mount /dev/vg_guest/lv_root /\n"
20749 " write /etc/motd \"Welcome, new users\"\n"
20755 #: ../fish/guestfish.pod:78 ../libguestfs-1.11.20/fish/guestfish.pod:78
20756 msgid "List the LVM logical volumes in a disk image:"
20760 #: ../fish/guestfish.pod:80 ../libguestfs-1.11.20/fish/guestfish.pod:80
20763 " guestfish -a disk.img --ro <<_EOF_\n"
20771 #: ../fish/guestfish.pod:85 ../libguestfs-1.11.20/fish/guestfish.pod:85
20772 msgid "List all the filesystems in a disk image:"
20776 #: ../fish/guestfish.pod:87 ../libguestfs-1.11.20/fish/guestfish.pod:87
20779 " guestfish -a disk.img --ro <<_EOF_\n"
20781 " list-filesystems\n"
20787 #: ../fish/guestfish.pod:92 ../libguestfs-1.11.20/fish/guestfish.pod:92
20788 msgid "On one command line"
20792 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
20793 #: ../libguestfs-1.11.20/fish/guestfish.pod:94
20794 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:31
20795 msgid "Update C</etc/resolv.conf> in a guest:"
20799 #: ../fish/guestfish.pod:96 ../libguestfs-1.11.20/fish/guestfish.pod:96
20803 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
20804 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
20809 #: ../fish/guestfish.pod:100 ../libguestfs-1.11.20/fish/guestfish.pod:100
20810 msgid "Edit C</boot/grub/grub.conf> interactively:"
20814 #: ../fish/guestfish.pod:102 ../libguestfs-1.11.20/fish/guestfish.pod:102
20817 " guestfish --rw --add disk.img \\\n"
20818 " --mount /dev/vg_guest/lv_root \\\n"
20819 " --mount /dev/sda1:/boot \\\n"
20820 " edit /boot/grub/grub.conf\n"
20825 #: ../fish/guestfish.pod:107 ../libguestfs-1.11.20/fish/guestfish.pod:107
20826 msgid "Mount disks automatically"
20830 #: ../fish/guestfish.pod:109 ../libguestfs-1.11.20/fish/guestfish.pod:109
20832 "Use the I<-i> option to automatically mount the disks from a virtual machine:"
20836 #: ../fish/guestfish.pod:112 ../libguestfs-1.11.20/fish/guestfish.pod:112
20839 " guestfish --ro -a disk.img -i cat /etc/group\n"
20844 #: ../fish/guestfish.pod:114 ../libguestfs-1.11.20/fish/guestfish.pod:114
20847 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
20852 #: ../fish/guestfish.pod:116 ../libguestfs-1.11.20/fish/guestfish.pod:116
20853 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
20857 #: ../fish/guestfish.pod:118 ../libguestfs-1.11.20/fish/guestfish.pod:118
20860 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
20865 #: ../fish/guestfish.pod:120 ../libguestfs-1.11.20/fish/guestfish.pod:120
20866 msgid "As a script interpreter"
20870 #: ../fish/guestfish.pod:122 ../libguestfs-1.11.20/fish/guestfish.pod:122
20871 msgid "Create a 100MB disk containing an ext2-formatted partition:"
20875 #: ../fish/guestfish.pod:124 ../libguestfs-1.11.20/fish/guestfish.pod:124
20878 " #!/usr/bin/guestfish -f\n"
20879 " sparse test1.img 100M\n"
20881 " part-disk /dev/sda mbr\n"
20882 " mkfs ext2 /dev/sda1\n"
20887 #: ../fish/guestfish.pod:130 ../libguestfs-1.11.20/fish/guestfish.pod:130
20888 msgid "Start with a prepared disk"
20892 #: ../fish/guestfish.pod:132 ../libguestfs-1.11.20/fish/guestfish.pod:132
20894 "An alternate way to create a 100MB disk called C<test1.img> containing a "
20895 "single ext2-formatted partition:"
20899 #: ../fish/guestfish.pod:135 ../libguestfs-1.11.20/fish/guestfish.pod:135
20902 " guestfish -N fs\n"
20907 #: ../fish/guestfish.pod:137 ../libguestfs-1.11.20/fish/guestfish.pod:137
20908 msgid "To list what is available do:"
20912 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:998
20913 #: ../libguestfs-1.11.20/fish/guestfish.pod:139
20914 #: ../libguestfs-1.11.20/fish/guestfish.pod:998
20917 " guestfish -N help | less\n"
20922 #: ../fish/guestfish.pod:141 ../libguestfs-1.11.20/fish/guestfish.pod:141
20923 msgid "Remote control"
20927 #: ../fish/guestfish.pod:143 ../libguestfs-1.11.20/fish/guestfish.pod:143
20930 " eval \"`guestfish --listen`\"\n"
20931 " guestfish --remote add-ro disk.img\n"
20932 " guestfish --remote run\n"
20933 " guestfish --remote lvs\n"
20938 #: ../fish/guestfish.pod:154 ../libguestfs-1.11.20/fish/guestfish.pod:154
20939 msgid "Displays general help on options."
20943 #: ../fish/guestfish.pod:158 ../libguestfs-1.11.20/fish/guestfish.pod:158
20944 msgid "B<--cmd-help>"
20948 #: ../fish/guestfish.pod:160 ../libguestfs-1.11.20/fish/guestfish.pod:160
20949 msgid "Lists all available guestfish commands."
20953 #: ../fish/guestfish.pod:162 ../libguestfs-1.11.20/fish/guestfish.pod:162
20958 #: ../fish/guestfish.pod:164 ../libguestfs-1.11.20/fish/guestfish.pod:164
20959 msgid "B<--cmd-help cmd>"
20963 #: ../fish/guestfish.pod:166 ../libguestfs-1.11.20/fish/guestfish.pod:166
20964 msgid "Displays detailed help on a single command C<cmd>."
20968 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:87
20969 #: ../libguestfs-1.11.20/fish/guestfish.pod:168
20970 #: ../libguestfs-1.11.20/fuse/guestmount.pod:87
20971 msgid "B<-a image>"
20975 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:89
20976 #: ../libguestfs-1.11.20/fish/guestfish.pod:170
20977 #: ../libguestfs-1.11.20/fuse/guestmount.pod:89
20978 msgid "B<--add image>"
20982 #: ../fish/guestfish.pod:172 ../libguestfs-1.11.20/fish/guestfish.pod:172
20983 msgid "Add a block device or virtual machine image to the shell."
20987 #: ../fish/guestfish.pod:177 ../libguestfs-1.11.20/fish/guestfish.pod:177
20989 "Using this flag is mostly equivalent to using the C<add> command, with "
20990 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
20991 "the I<--format=...> flag was given."
20995 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:100
20996 #: ../libguestfs-1.11.20/fish/guestfish.pod:185
20997 #: ../libguestfs-1.11.20/fuse/guestmount.pod:100
20999 "When used in conjunction with the I<-d> option, this specifies the libvirt "
21000 "URI to use. The default is to use the default libvirt connection."
21004 #: ../fish/guestfish.pod:189 ../libguestfs-1.11.20/fish/guestfish.pod:189
21009 #: ../fish/guestfish.pod:191 ../libguestfs-1.11.20/fish/guestfish.pod:191
21011 "If using the I<--listen> option and a csh-like shell, use this option. See "
21012 "section L</REMOTE CONTROL AND CSH> below."
21016 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:104
21017 #: ../libguestfs-1.11.20/fish/guestfish.pod:194
21018 #: ../libguestfs-1.11.20/fuse/guestmount.pod:104
21019 msgid "B<-d libvirt-domain>"
21023 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:106
21024 #: ../libguestfs-1.11.20/fish/guestfish.pod:196
21025 #: ../libguestfs-1.11.20/fuse/guestmount.pod:106
21026 msgid "B<--domain libvirt-domain>"
21030 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:108
21031 #: ../libguestfs-1.11.20/fish/guestfish.pod:198
21032 #: ../libguestfs-1.11.20/fuse/guestmount.pod:108
21034 "Add disks from the named libvirt domain. If the I<--ro> option is also "
21035 "used, then any libvirt domain can be used. However in write mode, only "
21036 "libvirt domains which are shut down can be named here."
21040 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:112
21041 #: ../libguestfs-1.11.20/fish/guestfish.pod:202
21042 #: ../libguestfs-1.11.20/fuse/guestmount.pod:112
21043 msgid "Domain UUIDs can be used instead of names."
21047 #: ../fish/guestfish.pod:204 ../libguestfs-1.11.20/fish/guestfish.pod:204
21049 "Using this flag is mostly equivalent to using the C<add-domain> command, "
21050 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
21051 "if the I<--format:...> flag was given."
21055 #: ../fish/guestfish.pod:208 ../libguestfs-1.11.20/fish/guestfish.pod:208
21060 #: ../fish/guestfish.pod:210 ../libguestfs-1.11.20/fish/guestfish.pod:210
21061 msgid "B<--no-dest-paths>"
21065 #: ../fish/guestfish.pod:212 ../libguestfs-1.11.20/fish/guestfish.pod:212
21067 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
21068 "to hit the tab key to complete paths on the guest filesystem, but this "
21069 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
21070 "allow this feature to be disabled."
21074 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:128
21075 #: ../libguestfs-1.11.20/fish/guestfish.pod:219
21076 #: ../libguestfs-1.11.20/fuse/guestmount.pod:128
21078 "When prompting for keys and passphrases, guestfish normally turns echoing "
21079 "off so you cannot see what you are typing. If you are not worried about "
21080 "Tempest attacks and there is no one else in the room you can specify this "
21081 "flag to see what you are typing."
21085 #: ../fish/guestfish.pod:224 ../libguestfs-1.11.20/fish/guestfish.pod:224
21090 #: ../fish/guestfish.pod:226 ../libguestfs-1.11.20/fish/guestfish.pod:226
21091 msgid "B<--file file>"
21095 #: ../fish/guestfish.pod:228 ../libguestfs-1.11.20/fish/guestfish.pod:228
21096 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
21100 #: ../fish/guestfish.pod:231 ../libguestfs-1.11.20/fish/guestfish.pod:231
21103 " #!/usr/bin/guestfish -f\n"
21108 #: ../fish/guestfish.pod:244 ../libguestfs-1.11.20/fish/guestfish.pod:244
21111 " guestfish --format=raw -a disk.img\n"
21116 #: ../fish/guestfish.pod:248 ../libguestfs-1.11.20/fish/guestfish.pod:248
21119 " guestfish --format=raw -a disk.img --format -a another.img\n"
21124 #: ../fish/guestfish.pod:253 ../libguestfs-1.11.20/fish/guestfish.pod:253
21126 "If you have untrusted raw-format guest disk images, you should use this "
21127 "option to specify the disk format. This avoids a possible security problem "
21128 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
21132 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:157
21133 #: ../libguestfs-1.11.20/fish/guestfish.pod:260
21134 #: ../libguestfs-1.11.20/fuse/guestmount.pod:157
21135 msgid "B<--inspector>"
21139 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:159
21140 #: ../libguestfs-1.11.20/fish/guestfish.pod:262
21141 #: ../libguestfs-1.11.20/fuse/guestmount.pod:159
21143 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
21144 "system and mount filesystems as they would be mounted on the real virtual "
21149 #: ../fish/guestfish.pod:266 ../libguestfs-1.11.20/fish/guestfish.pod:266
21150 msgid "Typical usage is either:"
21154 #: ../fish/guestfish.pod:268 ../libguestfs-1.11.20/fish/guestfish.pod:268
21157 " guestfish -d myguest -i\n"
21162 #: ../fish/guestfish.pod:270 ../libguestfs-1.11.20/fish/guestfish.pod:270
21163 msgid "(for an inactive libvirt domain called I<myguest>), or:"
21167 #: ../fish/guestfish.pod:272 ../libguestfs-1.11.20/fish/guestfish.pod:272
21170 " guestfish --ro -d myguest -i\n"
21175 #: ../fish/guestfish.pod:274 ../libguestfs-1.11.20/fish/guestfish.pod:274
21176 msgid "(for active domains, readonly), or specify the block device directly:"
21180 #: ../fish/guestfish.pod:276 ../libguestfs-1.11.20/fish/guestfish.pod:276
21183 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
21188 #: ../fish/guestfish.pod:278 ../libguestfs-1.11.20/fish/guestfish.pod:278
21190 "Note that the command line syntax changed slightly over older versions of "
21191 "guestfish. You can still use the old syntax:"
21195 #: ../fish/guestfish.pod:281 ../libguestfs-1.11.20/fish/guestfish.pod:281
21198 " guestfish [--ro] -i disk.img\n"
21203 #: ../fish/guestfish.pod:283 ../libguestfs-1.11.20/fish/guestfish.pod:283
21206 " guestfish [--ro] -i libvirt-domain\n"
21211 #: ../fish/guestfish.pod:285 ../libguestfs-1.11.20/fish/guestfish.pod:285
21213 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
21214 "then using other commands to mount the filesystems that were found."
21218 #: ../fish/guestfish.pod:294 ../libguestfs-1.11.20/fish/guestfish.pod:294
21219 msgid "B<--listen>"
21223 #: ../fish/guestfish.pod:296 ../libguestfs-1.11.20/fish/guestfish.pod:296
21225 "Fork into the background and listen for remote commands. See section L</"
21226 "REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
21230 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:168
21231 #: ../libguestfs-1.11.20/fish/guestfish.pod:299
21232 #: ../libguestfs-1.11.20/fuse/guestmount.pod:168
21237 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:170
21238 #: ../libguestfs-1.11.20/fish/guestfish.pod:301
21239 #: ../libguestfs-1.11.20/fuse/guestmount.pod:170
21241 "Connect to a live virtual machine. (Experimental, see L<guestfs(3)/"
21242 "ATTACHING TO RUNNING DAEMONS>)."
21246 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:173
21247 #: ../libguestfs-1.11.20/fish/guestfish.pod:304
21248 #: ../libguestfs-1.11.20/fuse/guestmount.pod:173
21249 msgid "B<-m dev[:mountpoint[:options]]>"
21253 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:175
21254 #: ../libguestfs-1.11.20/fish/guestfish.pod:306
21255 #: ../libguestfs-1.11.20/fuse/guestmount.pod:175
21256 msgid "B<--mount dev[:mountpoint[:options]]>"
21260 #: ../fish/guestfish.pod:308 ../libguestfs-1.11.20/fish/guestfish.pod:308
21261 msgid "Mount the named partition or logical volume on the given mountpoint."
21265 #: ../fish/guestfish.pod:310 ../libguestfs-1.11.20/fish/guestfish.pod:310
21266 msgid "If the mountpoint is omitted, it defaults to C</>."
21270 #: ../fish/guestfish.pod:312 ../libguestfs-1.11.20/fish/guestfish.pod:312
21271 msgid "You have to mount something on C</> before most commands will work."
21275 #: ../fish/guestfish.pod:314 ../libguestfs-1.11.20/fish/guestfish.pod:314
21277 "If any I<-m> or I<--mount> options are given, the guest is automatically "
21282 #: ../fish/guestfish.pod:317 ../libguestfs-1.11.20/fish/guestfish.pod:317
21284 "If you don't know what filesystems a disk image contains, you can either run "
21285 "guestfish without this option, then list the partitions, filesystems and LVs "
21286 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
21287 "commands), or you can use the L<virt-filesystems(1)> program."
21291 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:183
21292 #: ../libguestfs-1.11.20/fish/guestfish.pod:323
21293 #: ../libguestfs-1.11.20/fuse/guestmount.pod:183
21295 "The third (and rarely used) part of the mount parameter is the list of mount "
21296 "options used to mount the underlying filesystem. If this is not given, then "
21297 "the mount options are either the empty string or C<ro> (the latter if the "
21298 "I<--ro> flag is used). By specifying the mount options, you override this "
21299 "default choice. Probably the only time you would use this is to enable ACLs "
21300 "and/or extended attributes if the filesystem can support them:"
21304 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:191
21305 #: ../libguestfs-1.11.20/fish/guestfish.pod:331
21306 #: ../libguestfs-1.11.20/fuse/guestmount.pod:191
21309 " -m /dev/sda1:/:acl,user_xattr\n"
21314 #: ../fish/guestfish.pod:333 ../libguestfs-1.11.20/fish/guestfish.pod:333
21315 msgid "Using this flag is equivalent to using the C<mount-options> command."
21319 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:193
21320 #: ../libguestfs-1.11.20/fish/guestfish.pod:335
21321 #: ../libguestfs-1.11.20/fuse/guestmount.pod:193
21322 #: ../libguestfs-1.11.20/resize/virt-resize.pod:352
21323 #: ../resize/virt-resize.pod:352
21328 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:195
21329 #: ../libguestfs-1.11.20/fish/guestfish.pod:337
21330 #: ../libguestfs-1.11.20/fuse/guestmount.pod:195
21331 msgid "B<--no-sync>"
21335 #: ../fish/guestfish.pod:339 ../libguestfs-1.11.20/fish/guestfish.pod:339
21337 "Disable autosync. This is enabled by default. See the discussion of "
21338 "autosync in the L<guestfs(3)> manpage."
21342 #: ../fish/guestfish.pod:342 ../libguestfs-1.11.20/fish/guestfish.pod:342
21347 #: ../fish/guestfish.pod:344 ../libguestfs-1.11.20/fish/guestfish.pod:344
21348 msgid "B<--new type>"
21352 #: ../fish/guestfish.pod:346 ../libguestfs-1.11.20/fish/guestfish.pod:346
21357 #: ../fish/guestfish.pod:348 ../libguestfs-1.11.20/fish/guestfish.pod:348
21359 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
21360 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
21361 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
21366 #: ../fish/guestfish.pod:353 ../libguestfs-1.11.20/fish/guestfish.pod:353
21367 msgid "B<--progress-bars>"
21371 #: ../fish/guestfish.pod:355 ../libguestfs-1.11.20/fish/guestfish.pod:355
21372 msgid "Enable progress bars, even when guestfish is used non-interactively."
21376 #: ../fish/guestfish.pod:357 ../libguestfs-1.11.20/fish/guestfish.pod:357
21378 "Progress bars are enabled by default when guestfish is used as an "
21379 "interactive shell."
21383 #: ../fish/guestfish.pod:360 ../libguestfs-1.11.20/fish/guestfish.pod:360
21384 msgid "B<--no-progress-bars>"
21388 #: ../fish/guestfish.pod:362 ../libguestfs-1.11.20/fish/guestfish.pod:362
21389 msgid "Disable progress bars."
21393 #: ../fish/guestfish.pod:364 ../libguestfs-1.11.20/fish/guestfish.pod:364
21394 msgid "B<--remote[=pid]>"
21398 #: ../fish/guestfish.pod:366 ../libguestfs-1.11.20/fish/guestfish.pod:366
21400 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
21401 "CONTROL GUESTFISH OVER A SOCKET> below."
21405 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:239
21406 #: ../libguestfs-1.11.20/fish/guestfish.pod:369
21407 #: ../libguestfs-1.11.20/fuse/guestmount.pod:239
21408 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:161
21409 #: ../rescue/virt-rescue.pod:161
21414 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:241
21415 #: ../libguestfs-1.11.20/fish/guestfish.pod:371
21416 #: ../libguestfs-1.11.20/fuse/guestmount.pod:241
21417 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:163
21418 #: ../rescue/virt-rescue.pod:163
21423 #: ../fish/guestfish.pod:373 ../libguestfs-1.11.20/fish/guestfish.pod:373
21425 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
21426 "mounts are done read-only."
21430 #: ../fish/guestfish.pod:376 ../libguestfs-1.11.20/fish/guestfish.pod:376
21431 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:167
21432 #: ../rescue/virt-rescue.pod:167
21434 "The option must always be used if the disk image or virtual machine might be "
21435 "running, and is generally recommended in cases where you don't need write "
21436 "access to the disk."
21440 #: ../fish/guestfish.pod:380 ../libguestfs-1.11.20/fish/guestfish.pod:380
21442 "Note that prepared disk images created with I<-N> are not affected by this "
21443 "option. Also commands like C<add> are not affected - you have to specify "
21444 "the C<readonly:true> option explicitly if you need it."
21448 #: ../fish/guestfish.pod:384 ../libguestfs-1.11.20/fish/guestfish.pod:384
21449 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
21453 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:253
21454 #: ../libguestfs-1.11.20/fish/guestfish.pod:386
21455 #: ../libguestfs-1.11.20/fuse/guestmount.pod:253
21456 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:173
21457 #: ../rescue/virt-rescue.pod:173
21458 msgid "B<--selinux>"
21462 #: ../fish/guestfish.pod:388 ../libguestfs-1.11.20/fish/guestfish.pod:388
21463 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
21467 #: ../fish/guestfish.pod:394 ../libguestfs-1.11.20/fish/guestfish.pod:394
21469 "Enable very verbose messages. This is particularly useful if you find a bug."
21473 #: ../fish/guestfish.pod:401 ../libguestfs-1.11.20/fish/guestfish.pod:401
21474 msgid "Display the guestfish / libguestfs version number and exit."
21478 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:269
21479 #: ../libguestfs-1.11.20/fish/guestfish.pod:403
21480 #: ../libguestfs-1.11.20/fuse/guestmount.pod:269
21481 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:190
21482 #: ../rescue/virt-rescue.pod:190
21487 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:271
21488 #: ../libguestfs-1.11.20/fish/guestfish.pod:405
21489 #: ../libguestfs-1.11.20/fuse/guestmount.pod:271
21490 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:192
21491 #: ../rescue/virt-rescue.pod:192
21496 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:273
21497 #: ../libguestfs-1.11.20/fish/guestfish.pod:407
21498 #: ../libguestfs-1.11.20/fuse/guestmount.pod:273
21500 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
21501 "mounts are done read-write."
21505 #: ../fish/guestfish.pod:410 ../libguestfs-1.11.20/fish/guestfish.pod:410
21506 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
21510 #: ../fish/guestfish.pod:414 ../libguestfs-1.11.20/fish/guestfish.pod:414
21511 msgid "Echo each command before executing it."
21515 #: ../fish/guestfish.pod:418 ../libguestfs-1.11.20/fish/guestfish.pod:418
21516 msgid "COMMANDS ON COMMAND LINE"
21520 #: ../fish/guestfish.pod:420 ../libguestfs-1.11.20/fish/guestfish.pod:420
21522 "Any additional (non-option) arguments are treated as commands to execute."
21526 #: ../fish/guestfish.pod:423 ../libguestfs-1.11.20/fish/guestfish.pod:423
21528 "Commands to execute should be separated by a colon (C<:>), where the colon "
21529 "is a separate parameter. Thus:"
21533 #: ../fish/guestfish.pod:426 ../libguestfs-1.11.20/fish/guestfish.pod:426
21536 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
21541 #: ../fish/guestfish.pod:428 ../libguestfs-1.11.20/fish/guestfish.pod:428
21543 "If there are no additional arguments, then we enter a shell, either an "
21544 "interactive shell with a prompt (if the input is a terminal) or a non-"
21545 "interactive shell."
21549 #: ../fish/guestfish.pod:432 ../libguestfs-1.11.20/fish/guestfish.pod:432
21551 "In either command line mode or non-interactive shell, the first command that "
21552 "gives an error causes the whole shell to exit. In interactive mode (with a "
21553 "prompt) if a command fails, you can continue to enter commands."
21557 #: ../fish/guestfish.pod:437 ../libguestfs-1.11.20/fish/guestfish.pod:437
21558 msgid "USING launch (OR run)"
21562 #: ../fish/guestfish.pod:439 ../libguestfs-1.11.20/fish/guestfish.pod:439
21564 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
21565 "then launch it, then mount any disks you need, and finally issue actions/"
21566 "commands. So the general order of the day is:"
21570 #: ../fish/guestfish.pod:447 ../libguestfs-1.11.20/fish/guestfish.pod:447
21571 msgid "add or -a/--add"
21575 #: ../fish/guestfish.pod:451 ../libguestfs-1.11.20/fish/guestfish.pod:451
21576 msgid "launch (aka run)"
21580 #: ../fish/guestfish.pod:455 ../libguestfs-1.11.20/fish/guestfish.pod:455
21581 msgid "mount or -m/--mount"
21585 #: ../fish/guestfish.pod:459 ../libguestfs-1.11.20/fish/guestfish.pod:459
21586 msgid "any other commands"
21590 #: ../fish/guestfish.pod:463 ../libguestfs-1.11.20/fish/guestfish.pod:463
21592 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
21593 "guest before mounting or performing any other commands."
21597 #: ../fish/guestfish.pod:466 ../libguestfs-1.11.20/fish/guestfish.pod:466
21599 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
21600 "I<--new> options were given then C<run> is done automatically, simply "
21601 "because guestfish can't perform the action you asked for without doing this."
21605 #: ../fish/guestfish.pod:471 ../libguestfs-1.11.20/fish/guestfish.pod:471
21606 msgid "OPENING DISKS FOR READ AND WRITE"
21610 #: ../fish/guestfish.pod:473 ../libguestfs-1.11.20/fish/guestfish.pod:473
21612 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
21613 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
21614 "I<-i> and I<-m> open disk images read-only or for writing."
21618 #: ../fish/guestfish.pod:478 ../libguestfs-1.11.20/fish/guestfish.pod:478
21620 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
21621 "opening disk images supplied on the command line for write. To open a disk "
21622 "image read-only you have to do I<-a image --ro>."
21626 #: ../fish/guestfish.pod:482 ../libguestfs-1.11.20/fish/guestfish.pod:482
21628 "This matters: If you accidentally open a live VM disk image writable then "
21629 "you will cause irreversible disk corruption."
21633 #: ../fish/guestfish.pod:485 ../libguestfs-1.11.20/fish/guestfish.pod:485
21635 "In a future libguestfs we intend to change the default the other way. Disk "
21636 "images will be opened read-only. You will have to either specify "
21637 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
21638 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
21639 "access for disk images specified by those other command line options."
21643 #: ../fish/guestfish.pod:492 ../libguestfs-1.11.20/fish/guestfish.pod:492
21645 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
21646 "which does nothing (it is already the default). However it is highly "
21647 "recommended that you use this option to indicate that you need write access, "
21648 "and prepare your scripts for the day when this option will be required for "
21653 #: ../fish/guestfish.pod:498 ../libguestfs-1.11.20/fish/guestfish.pod:498
21655 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
21656 "other libguestfs program apart from guestfish and guestmount."
21660 #: ../fish/guestfish.pod:501 ../libguestfs-1.11.20/fish/guestfish.pod:501
21665 #: ../fish/guestfish.pod:503 ../libguestfs-1.11.20/fish/guestfish.pod:503
21667 "You can quote ordinary parameters using either single or double quotes. For "
21672 #: ../fish/guestfish.pod:506 ../libguestfs-1.11.20/fish/guestfish.pod:506
21675 " add \"file with a space.img\"\n"
21680 #: ../fish/guestfish.pod:508 ../libguestfs-1.11.20/fish/guestfish.pod:508
21683 " rm '/file name'\n"
21688 #: ../fish/guestfish.pod:510 ../libguestfs-1.11.20/fish/guestfish.pod:510
21696 #: ../fish/guestfish.pod:512 ../libguestfs-1.11.20/fish/guestfish.pod:512
21698 "A few commands require a list of strings to be passed. For these, use a "
21699 "whitespace-separated list, enclosed in quotes. Strings containing "
21700 "whitespace to be passed through must be enclosed in single quotes. A "
21701 "literal single quote must be escaped with a backslash."
21705 #: ../fish/guestfish.pod:517 ../libguestfs-1.11.20/fish/guestfish.pod:517
21708 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
21709 " command \"/bin/echo 'foo bar'\"\n"
21710 " command \"/bin/echo \\'foo\\'\"\n"
21715 #: ../fish/guestfish.pod:521 ../libguestfs-1.11.20/fish/guestfish.pod:521
21716 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
21720 #: ../fish/guestfish.pod:523 ../libguestfs-1.11.20/fish/guestfish.pod:523
21722 "In double-quoted arguments (only) use backslash to insert special characters:"
21726 #: ../fish/guestfish.pod:528 ../libguestfs-1.11.20/fish/guestfish.pod:528
21731 #: ../fish/guestfish.pod:530 ../libguestfs-1.11.20/fish/guestfish.pod:530
21732 msgid "Alert (bell) character."
21736 #: ../fish/guestfish.pod:532 ../libguestfs-1.11.20/fish/guestfish.pod:532
21741 #: ../fish/guestfish.pod:534 ../libguestfs-1.11.20/fish/guestfish.pod:534
21742 msgid "Backspace character."
21746 #: ../fish/guestfish.pod:536 ../libguestfs-1.11.20/fish/guestfish.pod:536
21751 #: ../fish/guestfish.pod:538 ../libguestfs-1.11.20/fish/guestfish.pod:538
21752 msgid "Form feed character."
21756 #: ../fish/guestfish.pod:540 ../libguestfs-1.11.20/fish/guestfish.pod:540
21761 #: ../fish/guestfish.pod:542 ../libguestfs-1.11.20/fish/guestfish.pod:542
21762 msgid "Newline character."
21766 #: ../fish/guestfish.pod:544 ../libguestfs-1.11.20/fish/guestfish.pod:544
21771 #: ../fish/guestfish.pod:546 ../libguestfs-1.11.20/fish/guestfish.pod:546
21772 msgid "Carriage return character."
21776 #: ../fish/guestfish.pod:548 ../libguestfs-1.11.20/fish/guestfish.pod:548
21781 #: ../fish/guestfish.pod:550 ../libguestfs-1.11.20/fish/guestfish.pod:550
21782 msgid "Horizontal tab character."
21786 #: ../fish/guestfish.pod:552 ../libguestfs-1.11.20/fish/guestfish.pod:552
21791 #: ../fish/guestfish.pod:554 ../libguestfs-1.11.20/fish/guestfish.pod:554
21792 msgid "Vertical tab character."
21796 #: ../fish/guestfish.pod:556 ../libguestfs-1.11.20/fish/guestfish.pod:556
21801 #: ../fish/guestfish.pod:558 ../libguestfs-1.11.20/fish/guestfish.pod:558
21802 msgid "A literal double quote character."
21806 #: ../fish/guestfish.pod:560 ../libguestfs-1.11.20/fish/guestfish.pod:560
21811 #: ../fish/guestfish.pod:562 ../libguestfs-1.11.20/fish/guestfish.pod:562
21813 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
21818 #: ../fish/guestfish.pod:565 ../libguestfs-1.11.20/fish/guestfish.pod:565
21823 #: ../fish/guestfish.pod:567 ../libguestfs-1.11.20/fish/guestfish.pod:567
21825 "A character with hex value I<hh>. There must be precisely 2 hex digits."
21829 #: ../fish/guestfish.pod:570 ../libguestfs-1.11.20/fish/guestfish.pod:570
21831 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
21836 #: ../fish/guestfish.pod:573 ../libguestfs-1.11.20/fish/guestfish.pod:573
21841 #: ../fish/guestfish.pod:575 ../libguestfs-1.11.20/fish/guestfish.pod:575
21842 msgid "A literal backslash character."
21846 #: ../fish/guestfish.pod:579 ../libguestfs-1.11.20/fish/guestfish.pod:579
21847 msgid "OPTIONAL ARGUMENTS"
21851 #: ../fish/guestfish.pod:581 ../libguestfs-1.11.20/fish/guestfish.pod:581
21853 "Some commands take optional arguments. These arguments appear in this "
21854 "documentation as C<[argname:..]>. You can use them as in these examples:"
21858 #: ../fish/guestfish.pod:585 ../libguestfs-1.11.20/fish/guestfish.pod:585
21861 " add-drive-opts filename\n"
21866 #: ../fish/guestfish.pod:587 ../libguestfs-1.11.20/fish/guestfish.pod:587
21869 " add-drive-opts filename readonly:true\n"
21874 #: ../fish/guestfish.pod:589 ../libguestfs-1.11.20/fish/guestfish.pod:589
21877 " add-drive-opts filename format:qcow2 readonly:false\n"
21882 #: ../fish/guestfish.pod:591 ../libguestfs-1.11.20/fish/guestfish.pod:591
21884 "Each optional argument can appear at most once. All optional arguments must "
21885 "appear after the required ones."
21889 #: ../fish/guestfish.pod:594 ../libguestfs-1.11.20/fish/guestfish.pod:594
21894 #: ../fish/guestfish.pod:596 ../libguestfs-1.11.20/fish/guestfish.pod:596
21896 "This section applies to all commands which can take integers as parameters."
21900 #: ../fish/guestfish.pod:599 ../libguestfs-1.11.20/fish/guestfish.pod:599
21901 msgid "SIZE SUFFIX"
21905 #: ../fish/guestfish.pod:601 ../libguestfs-1.11.20/fish/guestfish.pod:601
21907 "When the command takes a parameter measured in bytes, you can use one of the "
21908 "following suffixes to specify kilobytes, megabytes and larger sizes:"
21912 #: ../fish/guestfish.pod:607 ../libguestfs-1.11.20/fish/guestfish.pod:607
21913 msgid "B<k> or B<K> or B<KiB>"
21917 #: ../fish/guestfish.pod:609 ../libguestfs-1.11.20/fish/guestfish.pod:609
21918 msgid "The size in kilobytes (multiplied by 1024)."
21922 #: ../fish/guestfish.pod:611 ../libguestfs-1.11.20/fish/guestfish.pod:611
21927 #: ../fish/guestfish.pod:613 ../libguestfs-1.11.20/fish/guestfish.pod:613
21928 msgid "The size in SI 1000 byte units."
21932 #: ../fish/guestfish.pod:615 ../libguestfs-1.11.20/fish/guestfish.pod:615
21933 msgid "B<M> or B<MiB>"
21937 #: ../fish/guestfish.pod:617 ../libguestfs-1.11.20/fish/guestfish.pod:617
21938 msgid "The size in megabytes (multiplied by 1048576)."
21942 #: ../fish/guestfish.pod:619 ../libguestfs-1.11.20/fish/guestfish.pod:619
21947 #: ../fish/guestfish.pod:621 ../libguestfs-1.11.20/fish/guestfish.pod:621
21948 msgid "The size in SI 1000000 byte units."
21952 #: ../fish/guestfish.pod:623 ../libguestfs-1.11.20/fish/guestfish.pod:623
21953 msgid "B<G> or B<GiB>"
21957 #: ../fish/guestfish.pod:625 ../libguestfs-1.11.20/fish/guestfish.pod:625
21958 msgid "The size in gigabytes (multiplied by 2**30)."
21962 #: ../fish/guestfish.pod:627 ../libguestfs-1.11.20/fish/guestfish.pod:627
21967 #: ../fish/guestfish.pod:629 ../libguestfs-1.11.20/fish/guestfish.pod:629
21968 msgid "The size in SI 10**9 byte units."
21972 #: ../fish/guestfish.pod:631 ../libguestfs-1.11.20/fish/guestfish.pod:631
21973 msgid "B<T> or B<TiB>"
21977 #: ../fish/guestfish.pod:633 ../libguestfs-1.11.20/fish/guestfish.pod:633
21978 msgid "The size in terabytes (multiplied by 2**40)."
21982 #: ../fish/guestfish.pod:635 ../libguestfs-1.11.20/fish/guestfish.pod:635
21987 #: ../fish/guestfish.pod:637 ../libguestfs-1.11.20/fish/guestfish.pod:637
21988 msgid "The size in SI 10**12 byte units."
21992 #: ../fish/guestfish.pod:639 ../libguestfs-1.11.20/fish/guestfish.pod:639
21993 msgid "B<P> or B<PiB>"
21997 #: ../fish/guestfish.pod:641 ../libguestfs-1.11.20/fish/guestfish.pod:641
21998 msgid "The size in petabytes (multiplied by 2**50)."
22002 #: ../fish/guestfish.pod:643 ../libguestfs-1.11.20/fish/guestfish.pod:643
22007 #: ../fish/guestfish.pod:645 ../libguestfs-1.11.20/fish/guestfish.pod:645
22008 msgid "The size in SI 10**15 byte units."
22012 #: ../fish/guestfish.pod:647 ../libguestfs-1.11.20/fish/guestfish.pod:647
22013 msgid "B<E> or B<EiB>"
22017 #: ../fish/guestfish.pod:649 ../libguestfs-1.11.20/fish/guestfish.pod:649
22018 msgid "The size in exabytes (multiplied by 2**60)."
22022 #: ../fish/guestfish.pod:651 ../libguestfs-1.11.20/fish/guestfish.pod:651
22027 #: ../fish/guestfish.pod:653 ../libguestfs-1.11.20/fish/guestfish.pod:653
22028 msgid "The size in SI 10**18 byte units."
22032 #: ../fish/guestfish.pod:655 ../libguestfs-1.11.20/fish/guestfish.pod:655
22033 msgid "B<Z> or B<ZiB>"
22037 #: ../fish/guestfish.pod:657 ../libguestfs-1.11.20/fish/guestfish.pod:657
22038 msgid "The size in zettabytes (multiplied by 2**70)."
22042 #: ../fish/guestfish.pod:659 ../libguestfs-1.11.20/fish/guestfish.pod:659
22047 #: ../fish/guestfish.pod:661 ../libguestfs-1.11.20/fish/guestfish.pod:661
22048 msgid "The size in SI 10**21 byte units."
22052 #: ../fish/guestfish.pod:663 ../libguestfs-1.11.20/fish/guestfish.pod:663
22053 msgid "B<Y> or B<YiB>"
22057 #: ../fish/guestfish.pod:665 ../libguestfs-1.11.20/fish/guestfish.pod:665
22058 msgid "The size in yottabytes (multiplied by 2**80)."
22062 #: ../fish/guestfish.pod:667 ../libguestfs-1.11.20/fish/guestfish.pod:667
22067 #: ../fish/guestfish.pod:669 ../libguestfs-1.11.20/fish/guestfish.pod:669
22068 msgid "The size in SI 10**24 byte units."
22072 #: ../fish/guestfish.pod:675 ../libguestfs-1.11.20/fish/guestfish.pod:675
22075 " truncate-size /file 1G\n"
22080 #: ../fish/guestfish.pod:677 ../libguestfs-1.11.20/fish/guestfish.pod:677
22081 msgid "would truncate the file to 1 gigabyte."
22085 #: ../fish/guestfish.pod:679 ../libguestfs-1.11.20/fish/guestfish.pod:679
22087 "Be careful because a few commands take sizes in kilobytes or megabytes (eg. "
22088 "the parameter to L</memsize> is specified in megabytes already). Adding a "
22089 "suffix will probably not do what you expect."
22093 #: ../fish/guestfish.pod:683 ../libguestfs-1.11.20/fish/guestfish.pod:683
22094 msgid "OCTAL AND HEXADECIMAL NUMBERS"
22098 #: ../fish/guestfish.pod:685 ../libguestfs-1.11.20/fish/guestfish.pod:685
22100 "For specifying the radix (base) use the C convention: C<0> to prefix an "
22101 "octal number or C<0x> to prefix a hexadecimal number. For example:"
22105 #: ../fish/guestfish.pod:688 ../libguestfs-1.11.20/fish/guestfish.pod:688
22108 " 1234 decimal number 1234\n"
22109 " 02322 octal number, equivalent to decimal 1234\n"
22110 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
22115 #: ../fish/guestfish.pod:692 ../libguestfs-1.11.20/fish/guestfish.pod:692
22117 "When using the C<chmod> command, you almost always want to specify an octal "
22118 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
22119 "L<chmod(1)> program):"
22123 #: ../fish/guestfish.pod:696 ../libguestfs-1.11.20/fish/guestfish.pod:696
22126 " chmod 0777 /public # OK\n"
22127 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
22132 #: ../fish/guestfish.pod:699 ../libguestfs-1.11.20/fish/guestfish.pod:699
22134 "Commands that return numbers usually print them in decimal, but some "
22135 "commands print numbers in other radices (eg. C<umask> prints the mode in "
22136 "octal, preceeded by C<0>)."
22140 #: ../fish/guestfish.pod:703 ../libguestfs-1.11.20/fish/guestfish.pod:703
22141 msgid "WILDCARDS AND GLOBBING"
22145 #: ../fish/guestfish.pod:705 ../libguestfs-1.11.20/fish/guestfish.pod:705
22147 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
22148 "(globbing) by default. So for example the following will not do what you "
22153 #: ../fish/guestfish.pod:709 ../libguestfs-1.11.20/fish/guestfish.pod:709
22161 #: ../fish/guestfish.pod:711 ../libguestfs-1.11.20/fish/guestfish.pod:711
22163 "Assuming you don't have a directory called literally C</home/*> then the "
22164 "above command will return an error."
22168 #: ../fish/guestfish.pod:714 ../libguestfs-1.11.20/fish/guestfish.pod:714
22169 msgid "To perform wildcard expansion, use the C<glob> command."
22173 #: ../fish/guestfish.pod:716 ../libguestfs-1.11.20/fish/guestfish.pod:716
22176 " glob rm-rf /home/*\n"
22181 #: ../fish/guestfish.pod:718 ../libguestfs-1.11.20/fish/guestfish.pod:718
22183 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
22184 "many times), equivalent to:"
22188 #: ../fish/guestfish.pod:721 ../libguestfs-1.11.20/fish/guestfish.pod:721
22191 " rm-rf /home/jim\n"
22192 " rm-rf /home/joe\n"
22193 " rm-rf /home/mary\n"
22198 #: ../fish/guestfish.pod:725 ../libguestfs-1.11.20/fish/guestfish.pod:725
22199 msgid "C<glob> only works on simple guest paths and not on device names."
22203 #: ../fish/guestfish.pod:727 ../libguestfs-1.11.20/fish/guestfish.pod:727
22205 "If you have several parameters, each containing a wildcard, then glob will "
22206 "perform a Cartesian product."
22210 #: ../fish/guestfish.pod:730 ../libguestfs-1.11.20/fish/guestfish.pod:730
22215 #: ../fish/guestfish.pod:732 ../libguestfs-1.11.20/fish/guestfish.pod:732
22217 "Any line which starts with a I<#> character is treated as a comment and "
22218 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
22219 "a command. For example:"
22223 #: ../fish/guestfish.pod:736 ../libguestfs-1.11.20/fish/guestfish.pod:736
22226 " # this is a comment\n"
22227 " # this is a comment\n"
22228 " foo # NOT a comment\n"
22233 #: ../fish/guestfish.pod:740 ../libguestfs-1.11.20/fish/guestfish.pod:740
22234 msgid "Blank lines are also ignored."
22238 #: ../fish/guestfish.pod:742 ../libguestfs-1.11.20/fish/guestfish.pod:742
22239 msgid "RUNNING COMMANDS LOCALLY"
22243 #: ../fish/guestfish.pod:744 ../libguestfs-1.11.20/fish/guestfish.pod:744
22245 "Any line which starts with a I<!> character is treated as a command sent to "
22246 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
22250 #: ../fish/guestfish.pod:748 ../libguestfs-1.11.20/fish/guestfish.pod:748
22254 " tgz-out /remote local/remote-data.tar.gz\n"
22259 #: ../fish/guestfish.pod:751 ../libguestfs-1.11.20/fish/guestfish.pod:751
22261 "will create a directory C<local> on the host, and then export the contents "
22262 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
22263 "(See C<tgz-out>)."
22267 #: ../fish/guestfish.pod:755 ../libguestfs-1.11.20/fish/guestfish.pod:755
22269 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
22270 "effect, due to the way that subprocesses work in Unix."
22274 #: ../fish/guestfish.pod:758 ../libguestfs-1.11.20/fish/guestfish.pod:758
22275 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
22279 #: ../fish/guestfish.pod:760 ../libguestfs-1.11.20/fish/guestfish.pod:760
22281 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
22282 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
22283 "and executed as guestfish commands."
22287 #: ../fish/guestfish.pod:764 ../libguestfs-1.11.20/fish/guestfish.pod:764
22289 "Thus you can use shell script to construct arbitrary guestfish commands "
22290 "which are then parsed by guestfish."
22294 #: ../fish/guestfish.pod:767 ../libguestfs-1.11.20/fish/guestfish.pod:767
22296 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
22297 "through C</foo.100>) using guestfish commands alone. However this is simple "
22298 "if we use a shell script to create the guestfish commands for us:"
22302 #: ../fish/guestfish.pod:772 ../libguestfs-1.11.20/fish/guestfish.pod:772
22305 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
22310 #: ../fish/guestfish.pod:774 ../libguestfs-1.11.20/fish/guestfish.pod:774
22311 msgid "or with names like C</foo.001>:"
22315 #: ../fish/guestfish.pod:776 ../libguestfs-1.11.20/fish/guestfish.pod:776
22318 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
22323 #: ../fish/guestfish.pod:778 ../libguestfs-1.11.20/fish/guestfish.pod:778
22325 "When using guestfish interactively it can be helpful to just run the shell "
22326 "script first (ie. remove the initial C<E<lt>> character so it is just an "
22327 "ordinary I<!> local command), see what guestfish commands it would run, and "
22328 "when you are happy with those prepend the C<E<lt>> character to run the "
22329 "guestfish commands for real."
22333 #: ../fish/guestfish.pod:784 ../libguestfs-1.11.20/fish/guestfish.pod:784
22338 #: ../fish/guestfish.pod:786 ../libguestfs-1.11.20/fish/guestfish.pod:786
22340 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
22341 "command (a guestfish command) to the second command (any host command). For "
22346 #: ../fish/guestfish.pod:790 ../libguestfs-1.11.20/fish/guestfish.pod:790
22349 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
22354 #: ../fish/guestfish.pod:792 ../libguestfs-1.11.20/fish/guestfish.pod:792
22356 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
22357 "program). The above command would list all accounts in the guest filesystem "
22358 "which have UID 0, ie. root accounts including backdoors. Other examples:"
22362 #: ../fish/guestfish.pod:797 ../libguestfs-1.11.20/fish/guestfish.pod:797
22365 " hexdump /bin/ls | head\n"
22366 " list-devices | tail -1\n"
22367 " tgz-out / - | tar ztf -\n"
22372 #: ../fish/guestfish.pod:801 ../libguestfs-1.11.20/fish/guestfish.pod:801
22374 "The space before the pipe symbol is required, any space after the pipe "
22375 "symbol is optional. Everything after the pipe symbol is just passed "
22376 "straight to the host shell, so it can contain redirections, globs and "
22377 "anything else that makes sense on the host side."
22381 #: ../fish/guestfish.pod:806 ../libguestfs-1.11.20/fish/guestfish.pod:806
22383 "To use a literal argument which begins with a pipe symbol, you have to quote "
22388 #: ../fish/guestfish.pod:809 ../libguestfs-1.11.20/fish/guestfish.pod:809
22396 #: ../fish/guestfish.pod:811 ../libguestfs-1.11.20/fish/guestfish.pod:811
22397 msgid "HOME DIRECTORIES"
22401 #: ../fish/guestfish.pod:813 ../libguestfs-1.11.20/fish/guestfish.pod:813
22403 "If a parameter starts with the character C<~> then the tilde may be expanded "
22404 "as a home directory path (either C<~> for the current user's home directory, "
22405 "or C<~user> for another user)."
22409 #: ../fish/guestfish.pod:817 ../libguestfs-1.11.20/fish/guestfish.pod:817
22411 "Note that home directory expansion happens for users known I<on the host>, "
22412 "not in the guest filesystem."
22416 #: ../fish/guestfish.pod:820 ../libguestfs-1.11.20/fish/guestfish.pod:820
22418 "To use a literal argument which begins with a tilde, you have to quote it, "
22423 #: ../fish/guestfish.pod:823 ../libguestfs-1.11.20/fish/guestfish.pod:823
22431 #: ../fish/guestfish.pod:825 ../libguestfs-1.11.20/fish/guestfish.pod:825
22432 #: ../libguestfs-1.11.20/src/guestfs.pod:519 ../src/guestfs.pod:519
22433 msgid "ENCRYPTED DISKS"
22437 #: ../fish/guestfish.pod:827 ../libguestfs-1.11.20/fish/guestfish.pod:827
22439 "Libguestfs has some support for Linux guests encrypted according to the "
22440 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
22441 "disk encryption systems used by modern Linux guests. Currently only LVM-on-"
22442 "LUKS is supported."
22446 #: ../fish/guestfish.pod:832 ../libguestfs-1.11.20/fish/guestfish.pod:832
22447 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
22451 #: ../fish/guestfish.pod:834 ../libguestfs-1.11.20/fish/guestfish.pod:834
22454 " ><fs> vfs-type /dev/sda2\n"
22460 #: ../fish/guestfish.pod:837 ../libguestfs-1.11.20/fish/guestfish.pod:837
22462 "Then open those devices using L</luks-open>. This creates a device-mapper "
22463 "device called C</dev/mapper/luksdev>."
22467 #: ../fish/guestfish.pod:840 ../libguestfs-1.11.20/fish/guestfish.pod:840
22470 " ><fs> luks-open /dev/sda2 luksdev\n"
22471 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
22476 #: ../fish/guestfish.pod:843 ../libguestfs-1.11.20/fish/guestfish.pod:843
22478 "Finally you have to tell LVM to scan for volume groups on the newly created "
22483 #: ../fish/guestfish.pod:846 ../libguestfs-1.11.20/fish/guestfish.pod:846
22487 " vg-activate-all true\n"
22492 #: ../fish/guestfish.pod:849 ../libguestfs-1.11.20/fish/guestfish.pod:849
22493 msgid "The logical volume(s) can now be mounted in the usual way."
22497 #: ../fish/guestfish.pod:851 ../libguestfs-1.11.20/fish/guestfish.pod:851
22499 "Before closing a LUKS device you must unmount any logical volumes on it and "
22500 "deactivate the volume groups by calling C<vg-activate false VG> on each "
22501 "one. Then you can close the mapper device:"
22505 #: ../fish/guestfish.pod:855 ../libguestfs-1.11.20/fish/guestfish.pod:855
22508 " vg-activate false /dev/VG\n"
22509 " luks-close /dev/mapper/luksdev\n"
22514 #: ../fish/guestfish.pod:860 ../libguestfs-1.11.20/fish/guestfish.pod:860
22516 "If a path is prefixed with C<win:> then you can use Windows-style drive "
22517 "letters and paths (with some limitations). The following commands are "
22522 #: ../fish/guestfish.pod:864 ../libguestfs-1.11.20/fish/guestfish.pod:864
22525 " file /WINDOWS/system32/config/system.LOG\n"
22530 #: ../fish/guestfish.pod:866 ../libguestfs-1.11.20/fish/guestfish.pod:866
22533 " file win:\\windows\\system32\\config\\system.log\n"
22538 #: ../fish/guestfish.pod:868 ../libguestfs-1.11.20/fish/guestfish.pod:868
22541 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
22546 #: ../fish/guestfish.pod:870 ../libguestfs-1.11.20/fish/guestfish.pod:870
22548 "The parameter is rewritten \"behind the scenes\" by looking up the position "
22549 "where the drive is mounted, prepending that to the path, changing all "
22550 "backslash characters to forward slash, then resolving the result using L</"
22551 "case-sensitive-path>. For example if the E: drive was mounted on C</e> then "
22552 "the parameter might be rewritten like this:"
22556 #: ../fish/guestfish.pod:876 ../libguestfs-1.11.20/fish/guestfish.pod:876
22559 " win:e:\\foo\\bar => /e/FOO/bar\n"
22564 #: ../fish/guestfish.pod:878 ../libguestfs-1.11.20/fish/guestfish.pod:878
22565 msgid "This only works in argument positions that expect a path."
22569 #: ../fish/guestfish.pod:880 ../libguestfs-1.11.20/fish/guestfish.pod:880
22570 msgid "UPLOADING AND DOWNLOADING FILES"
22574 #: ../fish/guestfish.pod:882 ../libguestfs-1.11.20/fish/guestfish.pod:882
22576 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
22577 "others which upload from or download to a local file, you can use the "
22578 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
22582 #: ../fish/guestfish.pod:886 ../libguestfs-1.11.20/fish/guestfish.pod:886
22590 #: ../fish/guestfish.pod:888 ../libguestfs-1.11.20/fish/guestfish.pod:888
22592 "reads stdin and creates from that a file C</foo> in the disk image, and:"
22596 #: ../fish/guestfish.pod:891 ../libguestfs-1.11.20/fish/guestfish.pod:891
22599 " tar-out /etc - | tar tf -\n"
22604 #: ../fish/guestfish.pod:893 ../libguestfs-1.11.20/fish/guestfish.pod:893
22606 "writes the tarball to stdout and then pipes that into the external \"tar\" "
22607 "command (see L</PIPES>)."
22611 #: ../fish/guestfish.pod:896 ../libguestfs-1.11.20/fish/guestfish.pod:896
22613 "When using C<-> to read from stdin, the input is read up to the end of "
22614 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
22615 "some arbitrary end marker:"
22619 #: ../fish/guestfish.pod:900 ../libguestfs-1.11.20/fish/guestfish.pod:900
22622 " upload -<<END /foo\n"
22631 #: ../fish/guestfish.pod:906 ../libguestfs-1.11.20/fish/guestfish.pod:906
22633 "Any string of characters can be used instead of C<END>. The end marker must "
22634 "appear on a line of its own, without any preceeding or following characters "
22635 "(not even spaces)."
22639 #: ../fish/guestfish.pod:910 ../libguestfs-1.11.20/fish/guestfish.pod:910
22641 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
22642 "upload local files (so-called \"FileIn\" parameters in the generator)."
22646 #: ../fish/guestfish.pod:913 ../libguestfs-1.11.20/fish/guestfish.pod:913
22647 msgid "EXIT ON ERROR BEHAVIOUR"
22651 #: ../fish/guestfish.pod:915 ../libguestfs-1.11.20/fish/guestfish.pod:915
22653 "By default, guestfish will ignore any errors when in interactive mode (ie. "
22654 "taking commands from a human over a tty), and will exit on the first error "
22655 "in non-interactive mode (scripts, commands given on the command line)."
22659 #: ../fish/guestfish.pod:920 ../libguestfs-1.11.20/fish/guestfish.pod:920
22661 "If you prefix a command with a I<-> character, then that command will not "
22662 "cause guestfish to exit, even if that (one) command returns an error."
22666 #: ../fish/guestfish.pod:924 ../libguestfs-1.11.20/fish/guestfish.pod:924
22667 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
22671 #: ../fish/guestfish.pod:926 ../libguestfs-1.11.20/fish/guestfish.pod:926
22673 "Guestfish can be remote-controlled over a socket. This is useful "
22674 "particularly in shell scripts where you want to make several different "
22675 "changes to a filesystem, but you don't want the overhead of starting up a "
22676 "guestfish process each time."
22680 #: ../fish/guestfish.pod:931 ../libguestfs-1.11.20/fish/guestfish.pod:931
22681 msgid "Start a guestfish server process using:"
22685 #: ../fish/guestfish.pod:933 ../libguestfs-1.11.20/fish/guestfish.pod:933
22688 " eval \"`guestfish --listen`\"\n"
22693 #: ../fish/guestfish.pod:935 ../libguestfs-1.11.20/fish/guestfish.pod:935
22694 msgid "and then send it commands by doing:"
22698 #: ../fish/guestfish.pod:937 ../libguestfs-1.11.20/fish/guestfish.pod:937
22701 " guestfish --remote cmd [...]\n"
22706 #: ../fish/guestfish.pod:939 ../libguestfs-1.11.20/fish/guestfish.pod:939
22707 msgid "To cause the server to exit, send it the exit command:"
22711 #: ../fish/guestfish.pod:943 ../libguestfs-1.11.20/fish/guestfish.pod:943
22713 "Note that the server will normally exit if there is an error in a command. "
22714 "You can change this in the usual way. See section L</EXIT ON ERROR "
22719 #: ../fish/guestfish.pod:947 ../libguestfs-1.11.20/fish/guestfish.pod:947
22720 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
22724 #: ../fish/guestfish.pod:949 ../libguestfs-1.11.20/fish/guestfish.pod:949
22726 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
22727 "is how the I<--remote> option knows where to send the commands. You can "
22728 "have several guestfish listener processes running using:"
22732 #: ../fish/guestfish.pod:953 ../libguestfs-1.11.20/fish/guestfish.pod:953
22735 " eval \"`guestfish --listen`\"\n"
22736 " pid1=$GUESTFISH_PID\n"
22737 " eval \"`guestfish --listen`\"\n"
22738 " pid2=$GUESTFISH_PID\n"
22740 " guestfish --remote=$pid1 cmd\n"
22741 " guestfish --remote=$pid2 cmd\n"
22746 #: ../fish/guestfish.pod:961 ../libguestfs-1.11.20/fish/guestfish.pod:961
22747 msgid "REMOTE CONTROL AND CSH"
22751 #: ../fish/guestfish.pod:963 ../libguestfs-1.11.20/fish/guestfish.pod:963
22753 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
22758 #: ../fish/guestfish.pod:966 ../libguestfs-1.11.20/fish/guestfish.pod:966
22761 " eval \"`guestfish --listen --csh`\"\n"
22766 #: ../fish/guestfish.pod:968 ../libguestfs-1.11.20/fish/guestfish.pod:968
22767 msgid "REMOTE CONTROL DETAILS"
22771 #: ../fish/guestfish.pod:970 ../libguestfs-1.11.20/fish/guestfish.pod:970
22773 "Remote control happens over a Unix domain socket called C</tmp/.guestfish-"
22774 "$UID/socket-$PID>, where C<$UID> is the effective user ID of the process, "
22775 "and C<$PID> is the process ID of the server."
22779 #: ../fish/guestfish.pod:974 ../libguestfs-1.11.20/fish/guestfish.pod:974
22780 msgid "Guestfish client and server versions must match exactly."
22784 #: ../fish/guestfish.pod:976 ../libguestfs-1.11.20/fish/guestfish.pod:976
22785 msgid "PREPARED DISK IMAGES"
22789 #: ../fish/guestfish.pod:978 ../libguestfs-1.11.20/fish/guestfish.pod:978
22791 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
22792 "preformatted disk images that guestfish can make for you to save typing. "
22793 "This is particularly useful for testing purposes. This option is used "
22794 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
22795 "can be mixed with I<-a>)."
22799 #: ../fish/guestfish.pod:984 ../libguestfs-1.11.20/fish/guestfish.pod:984
22801 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
22802 "the second and so on. Existing files in the current directory are "
22807 #: ../fish/guestfish.pod:988 ../libguestfs-1.11.20/fish/guestfish.pod:988
22809 "The type briefly describes how the disk should be sized, partitioned, how "
22810 "filesystem(s) should be created, and how content should be added. "
22811 "Optionally the type can be followed by extra parameters, separated by C<:> "
22812 "(colon) characters. For example, I<-N fs> creates a default 100MB, sparsely-"
22813 "allocated disk, containing a single partition, with the partition formatted "
22814 "as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem on a 1GB "
22819 #: ../fish/guestfish.pod:996 ../libguestfs-1.11.20/fish/guestfish.pod:996
22820 msgid "To list the available types and any extra parameters they take, run:"
22824 #: ../fish/guestfish.pod:1000 ../libguestfs-1.11.20/fish/guestfish.pod:1000
22826 "Note that the prepared filesystem is not mounted. You would usually have to "
22827 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
22831 #: ../fish/guestfish.pod:1004 ../libguestfs-1.11.20/fish/guestfish.pod:1004
22833 "If any I<-N> or I<--new> options are given, the guest is automatically "
22838 #: ../fish/guestfish.pod:1009 ../libguestfs-1.11.20/fish/guestfish.pod:1009
22839 msgid "Create a 100MB disk with an ext4-formatted partition:"
22843 #: ../fish/guestfish.pod:1011 ../libguestfs-1.11.20/fish/guestfish.pod:1011
22846 " guestfish -N fs:ext4\n"
22851 #: ../fish/guestfish.pod:1013 ../libguestfs-1.11.20/fish/guestfish.pod:1013
22852 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
22856 #: ../fish/guestfish.pod:1015 ../libguestfs-1.11.20/fish/guestfish.pod:1015
22859 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
22864 #: ../fish/guestfish.pod:1017 ../libguestfs-1.11.20/fish/guestfish.pod:1017
22865 msgid "Create a blank 200MB disk:"
22869 #: ../fish/guestfish.pod:1019 ../libguestfs-1.11.20/fish/guestfish.pod:1019
22872 " guestfish -N disk:200M\n"
22877 #: ../fish/guestfish.pod:1021 ../libguestfs-1.11.20/fish/guestfish.pod:1021
22878 msgid "PROGRESS BARS"
22882 #: ../fish/guestfish.pod:1023 ../libguestfs-1.11.20/fish/guestfish.pod:1023
22884 "Some (not all) long-running commands send progress notification messages as "
22885 "they are running. Guestfish turns these messages into progress bars."
22889 #: ../fish/guestfish.pod:1027 ../libguestfs-1.11.20/fish/guestfish.pod:1027
22891 "When a command that supports progress bars takes longer than two seconds to "
22892 "run, and if progress bars are enabled, then you will see one appearing below "
22897 #: ../fish/guestfish.pod:1031 ../libguestfs-1.11.20/fish/guestfish.pod:1031
22900 " ><fs> copy-size /large-file /another-file 2048M\n"
22901 " / 10% [#####-----------------------------------------] 00:30\n"
22906 #: ../fish/guestfish.pod:1034 ../libguestfs-1.11.20/fish/guestfish.pod:1034
22908 "The spinner on the left hand side moves round once for every progress "
22909 "notification received from the backend. This is a (reasonably) golden "
22910 "assurance that the command is \"doing something\" even if the progress bar "
22911 "is not moving, because the command is able to send the progress "
22912 "notifications. When the bar reaches 100% and the command finishes, the "
22913 "spinner disappears."
22917 #: ../fish/guestfish.pod:1041 ../libguestfs-1.11.20/fish/guestfish.pod:1041
22919 "Progress bars are enabled by default when guestfish is used interactively. "
22920 "You can enable them even for non-interactive modes using I<--progress-bars>, "
22921 "and you can disable them completely using I<--no-progress-bars>."
22925 #: ../fish/guestfish.pod:1046 ../libguestfs-1.11.20/fish/guestfish.pod:1046
22926 msgid "GUESTFISH COMMANDS"
22930 #: ../fish/guestfish.pod:1048 ../libguestfs-1.11.20/fish/guestfish.pod:1048
22932 "The commands in this section are guestfish convenience commands, in other "
22933 "words, they are not part of the L<guestfs(3)> API."
22937 #: ../fish/guestfish.pod:1051 ../libguestfs-1.11.20/fish/guestfish.pod:1051
22942 #: ../fish/guestfish.pod:1053 ../libguestfs-1.11.20/fish/guestfish.pod:1053
22951 #: ../fish/guestfish.pod:1056 ../libguestfs-1.11.20/fish/guestfish.pod:1056
22952 msgid "Without any parameter, this provides general help."
22956 #: ../fish/guestfish.pod:1058 ../libguestfs-1.11.20/fish/guestfish.pod:1058
22957 msgid "With a C<cmd> parameter, this displays detailed help for that command."
22961 #: ../fish/guestfish.pod:1060 ../libguestfs-1.11.20/fish/guestfish.pod:1060
22962 msgid "quit | exit"
22966 #: ../fish/guestfish.pod:1062 ../libguestfs-1.11.20/fish/guestfish.pod:1062
22967 msgid "This exits guestfish. You can also use C<^D> key."
22971 #: ../fish/guestfish.pod:1064 ../libguestfs-1.11.20/fish/guestfish.pod:1064
22972 msgid "@FISH_COMMANDS@"
22976 #: ../fish/guestfish.pod:1066 ../libguestfs-1.11.20/fish/guestfish.pod:1066
22981 #: ../fish/guestfish.pod:1068 ../libguestfs-1.11.20/fish/guestfish.pod:1068
22982 #: ../libguestfs-1.11.20/src/guestfs.pod:1474 ../src/guestfs.pod:1474
22987 #: ../fish/guestfish.pod:1070 ../libguestfs-1.11.20/fish/guestfish.pod:1070
22988 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:77
22989 #: ../test-tool/libguestfs-test-tool.pod:77
22994 #: ../fish/guestfish.pod:1072 ../libguestfs-1.11.20/fish/guestfish.pod:1072
22996 "guestfish returns 0 if the commands completed without error, or 1 if there "
23001 #: ../fish/guestfish.pod:1079 ../libguestfs-1.11.20/fish/guestfish.pod:1079
23006 #: ../fish/guestfish.pod:1081 ../libguestfs-1.11.20/fish/guestfish.pod:1081
23008 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
23013 #: ../fish/guestfish.pod:1084 ../libguestfs-1.11.20/fish/guestfish.pod:1084
23014 msgid "GUESTFISH_DISPLAY_IMAGE"
23018 #: ../fish/guestfish.pod:1086 ../libguestfs-1.11.20/fish/guestfish.pod:1086
23020 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
23021 "If not set, it uses L<display(1)>."
23025 #: ../fish/guestfish.pod:1089 ../libguestfs-1.11.20/fish/guestfish.pod:1089
23026 msgid "GUESTFISH_PID"
23030 #: ../fish/guestfish.pod:1091 ../libguestfs-1.11.20/fish/guestfish.pod:1091
23032 "Used with the I<--remote> option to specify the remote guestfish process to "
23033 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
23037 #: ../fish/guestfish.pod:1095 ../libguestfs-1.11.20/fish/guestfish.pod:1095
23042 #: ../fish/guestfish.pod:1097 ../libguestfs-1.11.20/fish/guestfish.pod:1097
23044 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
23045 "not specified, the external L<hexedit(1)> program is used."
23049 #: ../fish/guestfish.pod:1101 ../libguestfs-1.11.20/fish/guestfish.pod:1101
23054 #: ../fish/guestfish.pod:1103 ../libguestfs-1.11.20/fish/guestfish.pod:1103
23056 "If compiled with GNU readline support, various files in the home directory "
23057 "can be used. See L</FILES>."
23061 #: ../fish/guestfish.pod:1106 ../libguestfs-1.11.20/fish/guestfish.pod:1106
23062 #: ../libguestfs-1.11.20/src/guestfs.pod:2964 ../src/guestfs.pod:2964
23063 msgid "LIBGUESTFS_APPEND"
23067 #: ../fish/guestfish.pod:1108 ../libguestfs-1.11.20/fish/guestfish.pod:1108
23068 #: ../libguestfs-1.11.20/src/guestfs.pod:2966 ../src/guestfs.pod:2966
23069 msgid "Pass additional options to the guest kernel."
23073 #: ../fish/guestfish.pod:1110 ../libguestfs-1.11.20/fish/guestfish.pod:1110
23074 #: ../libguestfs-1.11.20/src/guestfs.pod:2968 ../src/guestfs.pod:2968
23075 msgid "LIBGUESTFS_DEBUG"
23079 #: ../fish/guestfish.pod:1112 ../libguestfs-1.11.20/fish/guestfish.pod:1112
23081 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
23082 "effect as using the B<-v> option."
23086 #: ../fish/guestfish.pod:1115 ../libguestfs-1.11.20/fish/guestfish.pod:1115
23087 #: ../libguestfs-1.11.20/src/guestfs.pod:2973 ../src/guestfs.pod:2973
23088 msgid "LIBGUESTFS_MEMSIZE"
23092 #: ../fish/guestfish.pod:1117 ../libguestfs-1.11.20/fish/guestfish.pod:1117
23093 #: ../libguestfs-1.11.20/src/guestfs.pod:2975 ../src/guestfs.pod:2975
23095 "Set the memory allocated to the qemu process, in megabytes. For example:"
23099 #: ../fish/guestfish.pod:1120 ../libguestfs-1.11.20/fish/guestfish.pod:1120
23100 #: ../libguestfs-1.11.20/src/guestfs.pod:2978 ../src/guestfs.pod:2978
23103 " LIBGUESTFS_MEMSIZE=700\n"
23108 #: ../fish/guestfish.pod:1122 ../libguestfs-1.11.20/fish/guestfish.pod:1122
23109 #: ../libguestfs-1.11.20/src/guestfs.pod:2980 ../src/guestfs.pod:2980
23110 msgid "LIBGUESTFS_PATH"
23114 #: ../fish/guestfish.pod:1124 ../libguestfs-1.11.20/fish/guestfish.pod:1124
23116 "Set the path that guestfish uses to search for kernel and initrd.img. See "
23117 "the discussion of paths in L<guestfs(3)>."
23121 #: ../fish/guestfish.pod:1127 ../libguestfs-1.11.20/fish/guestfish.pod:1127
23122 #: ../libguestfs-1.11.20/src/guestfs.pod:2985 ../src/guestfs.pod:2985
23123 msgid "LIBGUESTFS_QEMU"
23127 #: ../fish/guestfish.pod:1129 ../libguestfs-1.11.20/fish/guestfish.pod:1129
23128 #: ../libguestfs-1.11.20/src/guestfs.pod:2987 ../src/guestfs.pod:2987
23130 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
23131 "which was found at compile time by the configure script is used."
23135 #: ../fish/guestfish.pod:1133 ../libguestfs-1.11.20/fish/guestfish.pod:1133
23136 #: ../libguestfs-1.11.20/src/guestfs.pod:2993 ../src/guestfs.pod:2993
23137 msgid "LIBGUESTFS_TRACE"
23141 #: ../fish/guestfish.pod:1135 ../libguestfs-1.11.20/fish/guestfish.pod:1135
23142 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
23146 #: ../fish/guestfish.pod:1137 ../libguestfs-1.11.20/fish/guestfish.pod:1137
23151 #: ../fish/guestfish.pod:1139 ../libguestfs-1.11.20/fish/guestfish.pod:1139
23153 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
23158 #: ../fish/guestfish.pod:1142 ../libguestfs-1.11.20/fish/guestfish.pod:1142
23159 #: ../libguestfs-1.11.20/src/guestfs.pod:2998 ../src/guestfs.pod:2998
23164 #: ../fish/guestfish.pod:1144 ../libguestfs-1.11.20/fish/guestfish.pod:1144
23165 #: ../libguestfs-1.11.20/src/guestfs.pod:3000 ../src/guestfs.pod:3000
23167 "Location of temporary directory, defaults to C</tmp> except for the cached "
23168 "supermin appliance which defaults to C</var/tmp>."
23172 #: ../fish/guestfish.pod:1147 ../libguestfs-1.11.20/fish/guestfish.pod:1147
23173 #: ../libguestfs-1.11.20/src/guestfs.pod:3003 ../src/guestfs.pod:3003
23175 "If libguestfs was compiled to use the supermin appliance then the real "
23176 "appliance is cached in this directory, shared between all handles belonging "
23177 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
23178 "use in case C</var/tmp> is not large enough."
23182 #: ../fish/guestfish.pod:1155 ../fuse/guestmount.pod:288
23183 #: ../libguestfs-1.11.20/fish/guestfish.pod:1155
23184 #: ../libguestfs-1.11.20/fuse/guestmount.pod:288
23185 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:269
23186 #: ../rescue/virt-rescue.pod:269
23191 #: ../fish/guestfish.pod:1159 ../fuse/guestmount.pod:292
23192 #: ../libguestfs-1.11.20/fish/guestfish.pod:1159
23193 #: ../libguestfs-1.11.20/fuse/guestmount.pod:292
23194 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:273
23195 #: ../rescue/virt-rescue.pod:273
23196 msgid "$HOME/.libguestfs-tools.rc"
23200 #: ../fish/guestfish.pod:1161 ../fuse/guestmount.pod:294
23201 #: ../libguestfs-1.11.20/fish/guestfish.pod:1161
23202 #: ../libguestfs-1.11.20/fuse/guestmount.pod:294
23203 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:275
23204 #: ../rescue/virt-rescue.pod:275
23205 msgid "/etc/libguestfs-tools.conf"
23209 #: ../fish/guestfish.pod:1163 ../fuse/guestmount.pod:296
23210 #: ../libguestfs-1.11.20/fish/guestfish.pod:1163
23211 #: ../libguestfs-1.11.20/fuse/guestmount.pod:296
23212 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:277
23213 #: ../rescue/virt-rescue.pod:277
23215 "This configuration file controls the default read-only or read-write mode "
23216 "(I<--ro> or I<--rw>)."
23220 #: ../fish/guestfish.pod:1166 ../libguestfs-1.11.20/fish/guestfish.pod:1166
23221 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
23225 #: ../fish/guestfish.pod:1168 ../libguestfs-1.11.20/fish/guestfish.pod:1168
23226 msgid "$HOME/.guestfish"
23230 #: ../fish/guestfish.pod:1170 ../libguestfs-1.11.20/fish/guestfish.pod:1170
23232 "If compiled with GNU readline support, then the command history is saved in "
23237 #: ../fish/guestfish.pod:1173 ../libguestfs-1.11.20/fish/guestfish.pod:1173
23238 msgid "$HOME/.inputrc"
23242 #: ../fish/guestfish.pod:1175 ../libguestfs-1.11.20/fish/guestfish.pod:1175
23243 msgid "/etc/inputrc"
23247 #: ../fish/guestfish.pod:1177 ../libguestfs-1.11.20/fish/guestfish.pod:1177
23249 "If compiled with GNU readline support, then these files can be used to "
23250 "configure readline. For further information, please see L<readline(3)/"
23251 "INITIALIZATION FILE>."
23255 #: ../fish/guestfish.pod:1181 ../libguestfs-1.11.20/fish/guestfish.pod:1181
23256 msgid "To write rules which only apply to guestfish, use:"
23260 #: ../fish/guestfish.pod:1183 ../libguestfs-1.11.20/fish/guestfish.pod:1183
23270 #: ../fish/guestfish.pod:1187 ../libguestfs-1.11.20/fish/guestfish.pod:1187
23272 "Variables that you can set in inputrc that change the behaviour of guestfish "
23273 "in useful ways include:"
23277 #: ../fish/guestfish.pod:1192 ../libguestfs-1.11.20/fish/guestfish.pod:1192
23278 msgid "completion-ignore-case (default: on)"
23282 #: ../fish/guestfish.pod:1194 ../libguestfs-1.11.20/fish/guestfish.pod:1194
23284 "By default, guestfish will ignore case when tab-completing paths on the "
23289 #: ../fish/guestfish.pod:1197 ../libguestfs-1.11.20/fish/guestfish.pod:1197
23292 " set completion-ignore-case off\n"
23297 #: ../fish/guestfish.pod:1199 ../libguestfs-1.11.20/fish/guestfish.pod:1199
23298 msgid "to make guestfish case sensitive."
23302 #: ../fish/guestfish.pod:1203 ../libguestfs-1.11.20/fish/guestfish.pod:1203
23307 #: ../fish/guestfish.pod:1205 ../libguestfs-1.11.20/fish/guestfish.pod:1205
23308 msgid "test2.img (etc)"
23312 #: ../fish/guestfish.pod:1207 ../libguestfs-1.11.20/fish/guestfish.pod:1207
23314 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
23315 "will be created in the file C<test1.img> in the current directory. The "
23316 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
23317 "the same name will be overwritten."
23321 #: ../fish/guestfish.pod:1216 ../libguestfs-1.11.20/fish/guestfish.pod:1216
23323 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, L<virt-copy-in(1)"
23324 ">, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)"
23325 ">, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, L<virt-list-partitions"
23326 "(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-resize(1)"
23327 ">, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<virt-win-reg(1)"
23328 ">, L<display(1)>, L<hexedit(1)>."
23332 #: ../fish/guestfish.pod:1244 ../libguestfs-1.11.20/fish/guestfish.pod:1244
23333 #: ../libguestfs-1.11.20/src/guestfs.pod:3088
23334 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:99
23335 #: ../src/guestfs.pod:3088 ../test-tool/libguestfs-test-tool.pod:99
23336 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
23340 #: ../fish/virt-copy-in.pod:5 ../libguestfs-1.11.20/fish/virt-copy-in.pod:5
23342 "virt-copy-in - Copy files and directories into a virtual machine disk image."
23346 #: ../fish/virt-copy-in.pod:9 ../libguestfs-1.11.20/fish/virt-copy-in.pod:9
23349 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
23354 #: ../fish/virt-copy-in.pod:11 ../libguestfs-1.11.20/fish/virt-copy-in.pod:11
23357 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
23362 #: ../fish/virt-copy-in.pod:15 ../libguestfs-1.11.20/fish/virt-copy-in.pod:15
23364 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
23365 "causing disk corruption. The virtual machine must be shut down before you "
23366 "use this command."
23370 #: ../fish/virt-copy-in.pod:21 ../libguestfs-1.11.20/fish/virt-copy-in.pod:21
23372 "C<virt-copy-in> copies files and directories from the local disk into a "
23373 "virtual machine disk image or named libvirt domain."
23377 #: ../fish/virt-copy-in.pod:24 ../libguestfs-1.11.20/fish/virt-copy-in.pod:24
23379 "You can give one of more filenames and directories on the command line. "
23380 "Directories are copied in recursively. The final parameter must be the "
23381 "destination directory in the disk image which must be an absolute path "
23382 "starting with a C</> character."
23386 #: ../fish/virt-copy-in.pod:33 ../libguestfs-1.11.20/fish/virt-copy-in.pod:33
23389 " virt-copy-in -d MyGuest resolv.conf /etc\n"
23394 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
23395 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:35
23396 #: ../libguestfs-1.11.20/fish/virt-tar-in.pod:32
23397 msgid "Upload a home directory to a guest:"
23401 #: ../fish/virt-copy-in.pod:37 ../libguestfs-1.11.20/fish/virt-copy-in.pod:37
23404 " virt-copy-in -d MyGuest skel /home\n"
23409 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28
23410 #: ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
23411 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:39
23412 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:28
23413 #: ../libguestfs-1.11.20/fish/virt-tar-in.pod:36
23414 #: ../libguestfs-1.11.20/fish/virt-tar-out.pod:30
23415 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
23419 #: ../fish/virt-copy-in.pod:41 ../libguestfs-1.11.20/fish/virt-copy-in.pod:41
23421 "This command is just a simple shell script wrapper around the L<guestfish(1)"
23422 "> C<copy-in> command. For anything more complex than a trivial copy, you "
23423 "are probably better off using guestfish directly."
23427 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36
23428 #: ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
23429 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:47
23430 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:36
23431 #: ../libguestfs-1.11.20/fish/virt-tar-in.pod:44
23432 #: ../libguestfs-1.11.20/fish/virt-tar-out.pod:38
23434 "Since the shell script just passes options straight to guestfish, read "
23435 "L<guestfish(1)> to see the full list of options."
23439 #: ../fish/virt-copy-in.pod:52 ../libguestfs-1.11.20/fish/virt-copy-in.pod:52
23441 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
23442 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
23446 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55
23447 #: ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
23448 #: ../libguestfs-1.11.20/fish/virt-copy-in.pod:66
23449 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:55
23450 #: ../libguestfs-1.11.20/fish/virt-tar-in.pod:64
23451 #: ../libguestfs-1.11.20/fish/virt-tar-out.pod:57
23452 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
23456 #: ../fish/virt-copy-out.pod:5 ../libguestfs-1.11.20/fish/virt-copy-out.pod:5
23458 "virt-copy-out - Copy files and directories out of a virtual machine disk "
23463 #: ../fish/virt-copy-out.pod:9 ../libguestfs-1.11.20/fish/virt-copy-out.pod:9
23466 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
23471 #: ../fish/virt-copy-out.pod:11
23472 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:11
23475 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
23480 #: ../fish/virt-copy-out.pod:15
23481 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:15
23483 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
23484 "image or named libvirt domain."
23488 #: ../fish/virt-copy-out.pod:18
23489 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:18
23491 "You can give one of more filenames and directories on the command line. "
23492 "Directories are copied out recursively."
23496 #: ../fish/virt-copy-out.pod:23
23497 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:23
23498 msgid "Download the home directories from a virtual machine:"
23502 #: ../fish/virt-copy-out.pod:25
23503 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:25
23507 " virt-copy-out -d MyGuest /home homes\n"
23512 #: ../fish/virt-copy-out.pod:30
23513 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:30
23515 "This command is just a simple shell script wrapper around the L<guestfish(1)"
23516 "> C<copy-out> command. For anything more complex than a trivial copy, you "
23517 "are probably better off using guestfish directly."
23521 #: ../fish/virt-copy-out.pod:41
23522 #: ../libguestfs-1.11.20/fish/virt-copy-out.pod:41
23524 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, L<virt-"
23525 "tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
23529 #: ../fish/virt-tar-in.pod:5 ../libguestfs-1.11.20/fish/virt-tar-in.pod:5
23530 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
23534 #: ../fish/virt-tar-in.pod:9 ../libguestfs-1.11.20/fish/virt-tar-in.pod:9
23537 " virt-tar-in -a disk.img data.tar /destination\n"
23542 #: ../fish/virt-tar-in.pod:11 ../libguestfs-1.11.20/fish/virt-tar-in.pod:11
23545 " virt-tar-in -d domain data.tar /destination\n"
23550 #: ../fish/virt-tar-in.pod:13 ../libguestfs-1.11.20/fish/virt-tar-in.pod:13
23553 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
23558 #: ../fish/virt-tar-in.pod:17 ../libguestfs-1.11.20/fish/virt-tar-in.pod:17
23560 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
23561 "causing disk corruption. The virtual machine must be shut down before you "
23562 "use this command."
23566 #: ../fish/virt-tar-in.pod:23 ../libguestfs-1.11.20/fish/virt-tar-in.pod:23
23568 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
23569 "image or named libvirt domain."
23573 #: ../fish/virt-tar-in.pod:26 ../libguestfs-1.11.20/fish/virt-tar-in.pod:26
23575 "The first parameter is the tar file. Use C<-> to read the tar file from "
23576 "standard input. The second parameter is the absolute target directory to "
23581 #: ../fish/virt-tar-in.pod:34 ../libguestfs-1.11.20/fish/virt-tar-in.pod:34
23584 " virt-tar-in -d MyGuest homes.tar /home\n"
23589 #: ../fish/virt-tar-in.pod:38 ../libguestfs-1.11.20/fish/virt-tar-in.pod:38
23591 "This command is just a simple shell script wrapper around the L<guestfish(1)"
23592 "> C<tar-in> command. For anything more complex than a trivial copy, you are "
23593 "probably better off using guestfish directly."
23597 #: ../fish/virt-tar-in.pod:49 ../libguestfs-1.11.20/fish/virt-tar-in.pod:49
23599 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
23600 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, L<http://libguestfs."
23605 #: ../fish/virt-tar-out.pod:5 ../libguestfs-1.11.20/fish/virt-tar-out.pod:5
23607 "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
23611 #: ../fish/virt-tar-out.pod:9 ../libguestfs-1.11.20/fish/virt-tar-out.pod:9
23614 " virt-tar-out -a disk.img /dir files.tar\n"
23619 #: ../fish/virt-tar-out.pod:11 ../libguestfs-1.11.20/fish/virt-tar-out.pod:11
23622 " virt-tar-out -d domain /dir files.tar\n"
23627 #: ../fish/virt-tar-out.pod:13 ../libguestfs-1.11.20/fish/virt-tar-out.pod:13
23630 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
23635 #: ../fish/virt-tar-out.pod:17 ../libguestfs-1.11.20/fish/virt-tar-out.pod:17
23637 "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
23641 #: ../fish/virt-tar-out.pod:20 ../libguestfs-1.11.20/fish/virt-tar-out.pod:20
23643 "The first parameter is the absolute path of the virtual machine directory. "
23644 "The second parameter is the tar file to write. Use C<-> to write to "
23649 #: ../fish/virt-tar-out.pod:26 ../libguestfs-1.11.20/fish/virt-tar-out.pod:26
23650 msgid "Download the home directories from a guest:"
23654 #: ../fish/virt-tar-out.pod:28 ../libguestfs-1.11.20/fish/virt-tar-out.pod:28
23657 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
23662 #: ../fish/virt-tar-out.pod:32 ../libguestfs-1.11.20/fish/virt-tar-out.pod:32
23664 "This command is just a simple shell script wrapper around the L<guestfish(1)"
23665 "> C<tar-out> command. For anything more complex than a trivial copy, you "
23666 "are probably better off using guestfish directly."
23670 #: ../fish/virt-tar-out.pod:43 ../libguestfs-1.11.20/fish/virt-tar-out.pod:43
23672 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
23673 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
23677 #: ../fuse/guestmount.pod:5 ../libguestfs-1.11.20/fuse/guestmount.pod:5
23679 "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
23683 #: ../fuse/guestmount.pod:9 ../libguestfs-1.11.20/fuse/guestmount.pod:9
23686 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
23691 #: ../fuse/guestmount.pod:11 ../libguestfs-1.11.20/fuse/guestmount.pod:11
23694 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
23699 #: ../fuse/guestmount.pod:13 ../libguestfs-1.11.20/fuse/guestmount.pod:13
23702 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
23707 #: ../fuse/guestmount.pod:17 ../libguestfs-1.11.20/fuse/guestmount.pod:17
23709 "You must I<not> use C<guestmount> in read-write mode on live virtual "
23710 "machines. If you do this, you risk disk corruption in the VM."
23714 #: ../fuse/guestmount.pod:22 ../libguestfs-1.11.20/fuse/guestmount.pod:22
23716 "The guestmount program can be used to mount virtual machine filesystems and "
23717 "other disk images on the host. It uses libguestfs for access to the guest "
23718 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
23719 "a mountable device."
23723 #: ../fuse/guestmount.pod:27 ../libguestfs-1.11.20/fuse/guestmount.pod:27
23725 "Along with other options, you have to give at least one device (I<-a> "
23726 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
23727 "option) or use the I<-i> inspection option. How this works is better "
23728 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
23733 #: ../fuse/guestmount.pod:33 ../libguestfs-1.11.20/fuse/guestmount.pod:33
23735 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
23736 "by you, and the filesystem will not be visible to any other users unless you "
23737 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
23738 "the filesystem, use the C<fusermount -u> command."
23742 #: ../fuse/guestmount.pod:41 ../libguestfs-1.11.20/fuse/guestmount.pod:41
23744 "For a typical Windows guest which has its main filesystem on the first "
23749 #: ../fuse/guestmount.pod:44 ../libguestfs-1.11.20/fuse/guestmount.pod:44
23752 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
23757 #: ../fuse/guestmount.pod:46 ../libguestfs-1.11.20/fuse/guestmount.pod:46
23759 "For a typical Linux guest which has a /boot filesystem on the first "
23760 "partition, and the root filesystem on a logical volume:"
23764 #: ../fuse/guestmount.pod:49 ../libguestfs-1.11.20/fuse/guestmount.pod:49
23767 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
23772 #: ../fuse/guestmount.pod:51 ../libguestfs-1.11.20/fuse/guestmount.pod:51
23773 msgid "To get libguestfs to detect guest mountpoints for you:"
23777 #: ../fuse/guestmount.pod:53 ../libguestfs-1.11.20/fuse/guestmount.pod:53
23780 " guestmount -a guest.img -i --ro /mnt\n"
23785 #: ../fuse/guestmount.pod:55 ../libguestfs-1.11.20/fuse/guestmount.pod:55
23786 msgid "For a libvirt guest called \"Guest\" you could do:"
23790 #: ../fuse/guestmount.pod:57 ../libguestfs-1.11.20/fuse/guestmount.pod:57
23793 " guestmount -d Guest -i --ro /mnt\n"
23798 #: ../fuse/guestmount.pod:59 ../libguestfs-1.11.20/fuse/guestmount.pod:59
23800 "If you don't know what filesystems are contained in a guest or disk image, "
23801 "use L<virt-filesystems(1)> first:"
23805 #: ../fuse/guestmount.pod:62 ../libguestfs-1.11.20/fuse/guestmount.pod:62
23808 " virt-filesystems MyGuest\n"
23813 #: ../fuse/guestmount.pod:64 ../libguestfs-1.11.20/fuse/guestmount.pod:64
23815 "If you want to trace the libguestfs calls but without excessive debugging "
23816 "information, we recommend:"
23820 #: ../fuse/guestmount.pod:67 ../libguestfs-1.11.20/fuse/guestmount.pod:67
23823 " guestmount [...] --trace /mnt\n"
23828 #: ../fuse/guestmount.pod:69 ../libguestfs-1.11.20/fuse/guestmount.pod:69
23829 msgid "If you want to debug the program, we recommend:"
23833 #: ../fuse/guestmount.pod:71 ../libguestfs-1.11.20/fuse/guestmount.pod:71
23836 " guestmount [...] --trace --verbose /mnt\n"
23841 #: ../fuse/guestmount.pod:73 ../libguestfs-1.11.20/fuse/guestmount.pod:73
23842 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:68
23843 #: ../libguestfs-1.11.20/resize/virt-resize.pod:486
23844 #: ../rescue/virt-rescue.pod:68 ../resize/virt-resize.pod:486
23849 #: ../fuse/guestmount.pod:75 ../libguestfs-1.11.20/fuse/guestmount.pod:75
23850 msgid "Other users cannot see the filesystem by default"
23854 #: ../fuse/guestmount.pod:77 ../libguestfs-1.11.20/fuse/guestmount.pod:77
23856 "If you mount a filesystem as one user (eg. root), then other users will not "
23857 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
23858 "option when mounting:"
23862 #: ../fuse/guestmount.pod:81 ../libguestfs-1.11.20/fuse/guestmount.pod:81
23865 " sudo guestmount [...] -o allow_other /mnt\n"
23870 #: ../fuse/guestmount.pod:91 ../libguestfs-1.11.20/fuse/guestmount.pod:91
23871 msgid "Add a block device or virtual machine image."
23875 #: ../fuse/guestmount.pod:114 ../libguestfs-1.11.20/fuse/guestmount.pod:114
23876 msgid "B<--dir-cache-timeout N>"
23880 #: ../fuse/guestmount.pod:116 ../libguestfs-1.11.20/fuse/guestmount.pod:116
23882 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
23883 "seconds. The readdir cache [actually, there are several semi-independent "
23884 "caches] is populated after a readdir(2) call with the stat and extended "
23885 "attributes of the files in the directory, in anticipation that they will be "
23886 "requested soon after."
23890 #: ../fuse/guestmount.pod:122 ../libguestfs-1.11.20/fuse/guestmount.pod:122
23892 "There is also a different attribute cache implemented by FUSE (see the FUSE "
23893 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
23894 "requests, only cache existing ones."
23898 #: ../fuse/guestmount.pod:142 ../libguestfs-1.11.20/fuse/guestmount.pod:142
23900 "If you have untrusted raw-format guest disk images, you should use this "
23901 "option to specify the disk format. This avoids a possible security problem "
23902 "with malicious guests (CVE-2010-3851). See also L<guestfs(3)/"
23903 "guestfs_add_drive_opts>."
23907 #: ../fuse/guestmount.pod:147 ../libguestfs-1.11.20/fuse/guestmount.pod:147
23908 msgid "B<--fuse-help>"
23912 #: ../fuse/guestmount.pod:149 ../libguestfs-1.11.20/fuse/guestmount.pod:149
23913 msgid "Display help on special FUSE options (see I<-o> below)."
23917 #: ../fuse/guestmount.pod:153 ../libguestfs-1.11.20/fuse/guestmount.pod:153
23918 msgid "Display brief help and exit."
23922 #: ../fuse/guestmount.pod:177 ../libguestfs-1.11.20/fuse/guestmount.pod:177
23924 "Mount the named partition or logical volume on the given mountpoint B<in the "
23925 "guest> (this has nothing to do with mountpoints in the host)."
23929 #: ../fuse/guestmount.pod:180 ../libguestfs-1.11.20/fuse/guestmount.pod:180
23931 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
23932 "something on C</>."
23936 #: ../fuse/guestmount.pod:197 ../libguestfs-1.11.20/fuse/guestmount.pod:197
23938 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
23939 "unmounted. If you specify this option, then we don't attempt to sync the "
23940 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
23944 #: ../fuse/guestmount.pod:202 ../libguestfs-1.11.20/fuse/guestmount.pod:202
23945 msgid "B<-o option>"
23949 #: ../fuse/guestmount.pod:204 ../libguestfs-1.11.20/fuse/guestmount.pod:204
23950 msgid "B<--option option>"
23954 #: ../fuse/guestmount.pod:206 ../libguestfs-1.11.20/fuse/guestmount.pod:206
23955 msgid "Pass extra options to FUSE."
23959 #: ../fuse/guestmount.pod:208 ../libguestfs-1.11.20/fuse/guestmount.pod:208
23961 "To get a list of all the extra options supported by FUSE, use the command "
23962 "below. Note that only the FUSE I<-o> options can be passed, and only some "
23963 "of them are a good idea."
23967 #: ../fuse/guestmount.pod:212 ../libguestfs-1.11.20/fuse/guestmount.pod:212
23970 " guestmount --fuse-help\n"
23975 #: ../fuse/guestmount.pod:214 ../libguestfs-1.11.20/fuse/guestmount.pod:214
23976 msgid "Some potentially useful FUSE options:"
23980 #: ../fuse/guestmount.pod:218 ../libguestfs-1.11.20/fuse/guestmount.pod:218
23981 msgid "B<-o allow_other>"
23985 #: ../fuse/guestmount.pod:220 ../libguestfs-1.11.20/fuse/guestmount.pod:220
23986 msgid "Allow other users to see the filesystem."
23990 #: ../fuse/guestmount.pod:222 ../libguestfs-1.11.20/fuse/guestmount.pod:222
23991 msgid "B<-o attr_timeout=N>"
23995 #: ../fuse/guestmount.pod:224 ../libguestfs-1.11.20/fuse/guestmount.pod:224
23996 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
24000 #: ../fuse/guestmount.pod:226 ../libguestfs-1.11.20/fuse/guestmount.pod:226
24001 msgid "B<-o kernel_cache>"
24005 #: ../fuse/guestmount.pod:228 ../libguestfs-1.11.20/fuse/guestmount.pod:228
24007 "Allow the kernel to cache files (reduces the number of reads that have to go "
24008 "through the L<guestfs(3)> API). This is generally a good idea if you can "
24009 "afford the extra memory usage."
24013 #: ../fuse/guestmount.pod:232 ../libguestfs-1.11.20/fuse/guestmount.pod:232
24014 msgid "B<-o uid=N> B<-o gid=N>"
24018 #: ../fuse/guestmount.pod:234 ../libguestfs-1.11.20/fuse/guestmount.pod:234
24020 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
24021 "the chosen values."
24025 #: ../fuse/guestmount.pod:243 ../libguestfs-1.11.20/fuse/guestmount.pod:243
24027 "Add devices and mount everything read-only. Also disallow writes and make "
24028 "the disk appear read-only to FUSE."
24032 #: ../fuse/guestmount.pod:246 ../libguestfs-1.11.20/fuse/guestmount.pod:246
24034 "This is highly recommended if you are not going to edit the guest disk. If "
24035 "the guest is running and this option is I<not> supplied, then there is a "
24036 "strong risk of disk corruption in the guest. We try to prevent this from "
24037 "happening, but it is not always possible."
24041 #: ../fuse/guestmount.pod:251 ../libguestfs-1.11.20/fuse/guestmount.pod:251
24042 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:171
24043 #: ../rescue/virt-rescue.pod:171
24044 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
24048 #: ../fuse/guestmount.pod:255 ../libguestfs-1.11.20/fuse/guestmount.pod:255
24049 msgid "Enable SELinux support for the guest."
24053 #: ../fuse/guestmount.pod:261 ../libguestfs-1.11.20/fuse/guestmount.pod:261
24054 msgid "Enable verbose messages from underlying libguestfs."
24058 #: ../fuse/guestmount.pod:267 ../libguestfs-1.11.20/fuse/guestmount.pod:267
24059 msgid "Display the program version and exit."
24063 #: ../fuse/guestmount.pod:276 ../fuse/guestmount.pod:299
24064 #: ../libguestfs-1.11.20/fuse/guestmount.pod:276
24065 #: ../libguestfs-1.11.20/fuse/guestmount.pod:299
24066 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:197
24067 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:280
24068 #: ../rescue/virt-rescue.pod:197 ../rescue/virt-rescue.pod:280
24069 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
24073 #: ../fuse/guestmount.pod:280 ../libguestfs-1.11.20/fuse/guestmount.pod:280
24078 #: ../fuse/guestmount.pod:282 ../libguestfs-1.11.20/fuse/guestmount.pod:282
24079 msgid "Trace libguestfs calls and entry into each FUSE function."
24083 #: ../fuse/guestmount.pod:284 ../libguestfs-1.11.20/fuse/guestmount.pod:284
24084 msgid "This also stops the daemon from forking into the background."
24088 #: ../fuse/guestmount.pod:305 ../libguestfs-1.11.20/fuse/guestmount.pod:305
24090 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
24091 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, L<http://fuse.sf."
24096 #: ../fuse/guestmount.pod:320 ../libguestfs-1.11.20/fuse/guestmount.pod:320
24097 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
24101 #: ../inspector/virt-inspector.pod:5
24102 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:5
24104 "virt-inspector - Display operating system version and other information "
24105 "about a virtual machine"
24109 #: ../inspector/virt-inspector.pod:9
24110 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:9
24113 " virt-inspector [--options] -d domname\n"
24118 #: ../inspector/virt-inspector.pod:11
24119 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:11
24122 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
24127 #: ../inspector/virt-inspector.pod:15
24128 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:15
24131 " virt-inspector domname\n"
24136 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:141
24137 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:17
24138 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:141
24141 " virt-inspector disk.img [disk.img ...]\n"
24146 #: ../inspector/virt-inspector.pod:21
24147 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:21
24149 "B<virt-inspector> examines a virtual machine or disk image and tries to "
24150 "determine the version of the operating system and other information about "
24151 "the virtual machine."
24155 #: ../inspector/virt-inspector.pod:25
24156 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:25
24157 msgid "Virt-inspector produces XML output for feeding into other programs."
24161 #: ../inspector/virt-inspector.pod:27
24162 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:27
24164 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
24165 "the libvirt domain (see: C<virsh list --all>)."
24169 #: ../inspector/virt-inspector.pod:30
24170 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:30
24172 "You can also run virt-inspector directly on disk images from a single "
24173 "virtual machine. Use C<virt-inspector -a disk.img>. In rare cases a domain "
24174 "has several block devices, in which case you should list several I<-a> "
24175 "options one after another, with the first corresponding to the guest's C</"
24176 "dev/sda>, the second to the guest's C</dev/sdb> and so on."
24180 #: ../inspector/virt-inspector.pod:37
24181 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:37
24183 "You can also run virt-inspector on install disks, live CDs, bootable USB "
24184 "keys and similar."
24188 #: ../inspector/virt-inspector.pod:40
24189 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:40
24191 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
24192 "inspect several virtual machines, you have to run virt-inspector several "
24193 "times (for example, from a shell script for-loop)."
24197 #: ../inspector/virt-inspector.pod:45
24198 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:45
24200 "Because virt-inspector needs direct access to guest images, it won't "
24201 "normally work over remote libvirt connections."
24205 #: ../inspector/virt-inspector.pod:48
24206 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:48
24208 "All of the information available from virt-inspector is also available "
24209 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>). "
24210 "The same information can also be fetched using guestfish or via libguestfs "
24211 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
24212 "WITH OTHER PROGRAMMING LANGUAGES>)."
24216 #: ../inspector/virt-inspector.pod:81
24217 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:81
24219 "Libvirt is only used if you specify a C<domname> on the command line. If "
24220 "you specify guest block devices directly (I<-a>), then libvirt is not used "
24225 #: ../inspector/virt-inspector.pod:94
24226 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:94
24228 "When prompting for keys and passphrases, virt-inspector normally turns "
24229 "echoing off so you cannot see what you are typing. If you are not worried "
24230 "about Tempest attacks and there is no one else in the room you can specify "
24231 "this flag to see what you are typing."
24235 #: ../inspector/virt-inspector.pod:103
24236 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:103
24237 #: ../tools/virt-list-filesystems.pl:93 ../tools/virt-list-partitions.pl:94
24238 #: ../tools/virt-tar.pl:143 ../tools/virt-win-reg.pl:144
24240 "Specify the format of disk images given on the command line. If this is "
24241 "omitted then the format is autodetected from the content of the disk image."
24245 #: ../inspector/virt-inspector.pod:107
24246 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:107
24247 #: ../tools/virt-list-filesystems.pl:97 ../tools/virt-list-partitions.pl:98
24248 #: ../tools/virt-tar.pl:147 ../tools/virt-win-reg.pl:148
24250 "If disk images are requested from libvirt, then this program asks libvirt "
24251 "for this information. In this case, the value of the format parameter is "
24256 #: ../inspector/virt-inspector.pod:111
24257 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:111
24258 #: ../libguestfs-1.11.20/resize/virt-resize.pod:314
24259 #: ../libguestfs-1.11.20/resize/virt-resize.pod:400
24260 #: ../resize/virt-resize.pod:314 ../resize/virt-resize.pod:400
24261 #: ../tools/virt-list-filesystems.pl:101 ../tools/virt-list-partitions.pl:102
24262 #: ../tools/virt-tar.pl:151 ../tools/virt-win-reg.pl:152
24264 "If working with untrusted raw-format guest disk images, you should ensure "
24265 "the format is always specified."
24269 #: ../inspector/virt-inspector.pod:139
24270 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:139
24271 msgid "Previous versions of virt-inspector allowed you to write either:"
24275 #: ../inspector/virt-inspector.pod:145
24276 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:145
24279 " virt-inspector guestname\n"
24284 #: ../inspector/virt-inspector.pod:153
24285 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:153
24290 #: ../inspector/virt-inspector.pod:155
24291 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:155
24293 "The virt-inspector XML is described precisely in a RELAX NG schema file "
24294 "C<virt-inspector.rng> which is supplied with libguestfs. This section is "
24295 "just an overview."
24299 #: ../inspector/virt-inspector.pod:159
24300 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:159
24302 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
24303 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
24304 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
24305 "which is vanishingly rare in real world VMs."
24309 #: ../inspector/virt-inspector.pod:164
24310 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:164
24311 msgid "E<lt>operatingsystemE<gt>"
24315 #: ../inspector/virt-inspector.pod:166
24316 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:166
24318 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
24319 "describe the operating system, its architecture, the descriptive \"product "
24320 "name\" string, the type of OS and so on, as in this example:"
24324 #: ../inspector/virt-inspector.pod:170
24325 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:170
24328 " <operatingsystems>\n"
24329 " <operatingsystem>\n"
24330 " <root>/dev/sda2</root>\n"
24331 " <name>windows</name>\n"
24332 " <arch>i386</arch>\n"
24333 " <distro>windows</distro>\n"
24334 " <product_name>Windows 7 Enterprise</product_name>\n"
24335 " <product_variant>Client</product_variant>\n"
24336 " <major_version>6</major_version>\n"
24337 " <minor_version>1</minor_version>\n"
24338 " <windows_systemroot>/Windows</windows_systemroot>\n"
24339 " <format>installed</format>\n"
24344 #: ../inspector/virt-inspector.pod:183
24345 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:183
24347 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
24348 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
24349 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
24350 "architecture. The other fields are fairly self-explanatory, but because "
24351 "these fields are taken directly from the libguestfs inspection API you can "
24352 "find precise information from L<guestfs(3)/INSPECTION>."
24356 #: ../inspector/virt-inspector.pod:191
24357 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:191
24359 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
24360 "of view of libguestfs (block devices may have completely different names "
24361 "inside the VM itself)."
24365 #: ../inspector/virt-inspector.pod:195
24366 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:195
24367 msgid "E<lt>mountpointsE<gt>"
24371 #: ../inspector/virt-inspector.pod:197
24372 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:197
24374 "Un*x-like guests typically have multiple filesystems which are mounted at "
24375 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
24376 "element which looks like this:"
24380 #: ../inspector/virt-inspector.pod:201
24381 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:201
24384 " <operatingsystems>\n"
24385 " <operatingsystem>\n"
24388 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
24389 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
24390 " </mountpoints>\n"
24395 #: ../inspector/virt-inspector.pod:209
24396 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:209
24398 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
24399 "and may have completely different names inside the guest. Only mountable "
24400 "filesystems appear in this list, not things like swap devices."
24404 #: ../inspector/virt-inspector.pod:214
24405 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:214
24406 msgid "E<lt>filesystemsE<gt>"
24410 #: ../inspector/virt-inspector.pod:216
24411 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:216
24413 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
24414 "filesystems belonging to the guest, including swap and empty partitions. "
24415 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
24416 "this OS or shared with this OS and other OSes)."
24420 #: ../inspector/virt-inspector.pod:222
24421 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:222
24422 msgid "You might see something like this:"
24426 #: ../inspector/virt-inspector.pod:224
24427 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:224
24430 " <operatingsystems>\n"
24431 " <operatingsystem>\n"
24434 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
24435 " <type>ext4</type>\n"
24436 " <label>Fedora-13-x86_64</label>\n"
24437 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
24443 #: ../inspector/virt-inspector.pod:234
24444 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:234
24446 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
24447 "the label, and the UUID."
24451 #: ../inspector/virt-inspector.pod:237
24452 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:237
24453 msgid "E<lt>applicationsE<gt>"
24457 #: ../inspector/virt-inspector.pod:239
24458 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:239
24460 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
24461 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
24466 #: ../inspector/virt-inspector.pod:243
24467 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:243
24469 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
24470 "Typical values would be C<rpm> and C<deb>."
24474 #: ../inspector/virt-inspector.pod:246
24475 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:246
24477 "E<lt>package_managementE<gt>, if present, describes the package manager. "
24478 "Typical values include C<yum>, C<up2date> and C<apt>"
24482 #: ../inspector/virt-inspector.pod:249
24483 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:249
24484 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
24488 #: ../inspector/virt-inspector.pod:252
24489 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:252
24492 " <operatingsystems>\n"
24493 " <operatingsystem>\n"
24495 " <applications>\n"
24497 " <name>coreutils</name>\n"
24498 " <version>8.5</version>\n"
24499 " <release>1</release>\n"
24500 " </application>\n"
24505 #: ../inspector/virt-inspector.pod:262
24506 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:262
24508 "The version and release fields may not be available for some types guests. "
24509 "Other fields are possible, see L<guestfs(3)/"
24510 "guestfs_inspect_list_applications>."
24514 #: ../inspector/virt-inspector.pod:266
24515 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:266
24516 msgid "E<lt>drive_mappingsE<gt>"
24520 #: ../inspector/virt-inspector.pod:268
24521 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:268
24523 "For operating systems like Windows which use drive letters, virt-inspector "
24524 "is able to find out how drive letters map to filesystems."
24528 #: ../inspector/virt-inspector.pod:272
24529 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:272
24532 " <operatingsystems>\n"
24533 " <operatingsystem>\n"
24535 " <drive_mappings>\n"
24536 " <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
24537 " <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
24538 " </drive_mappings>\n"
24543 #: ../inspector/virt-inspector.pod:280
24544 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:280
24546 "In the example above, drive C maps to the filesystem on the second partition "
24547 "on the first disk, and drive E maps to the filesystem on the first partition "
24548 "on the second disk."
24552 #: ../inspector/virt-inspector.pod:284
24553 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:284
24555 "Note that this only covers permanent local filesystem mappings, not things "
24556 "like network shares. Furthermore NTFS volume mount points may not be listed "
24561 #: ../inspector/virt-inspector.pod:288
24562 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:288
24563 msgid "E<lt>iconE<gt>"
24567 #: ../inspector/virt-inspector.pod:290
24568 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:290
24570 "Virt-inspector is sometimes able to extract an icon or logo for the guest. "
24571 "The icon is returned as base64-encoded PNG data. Note that the icon can be "
24572 "very large and high quality."
24576 #: ../inspector/virt-inspector.pod:294
24577 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:294
24580 " <operatingsystems>\n"
24581 " <operatingsystem>\n"
24584 " iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
24585 " [... many lines of base64 data ...]\n"
24591 #: ../inspector/virt-inspector.pod:302
24592 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:302
24594 "To display the icon, you have to extract it and convert the base64 data back "
24595 "to a binary file. Use an XPath query or simply an editor to extract the "
24596 "data, then use the coreutils L<base64(1)> program to do the conversion back "
24601 #: ../inspector/virt-inspector.pod:307
24602 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:307
24605 " base64 -i -d < icon.data > icon.png\n"
24610 #: ../inspector/virt-inspector.pod:309
24611 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:309
24612 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
24616 #: ../inspector/virt-inspector.pod:311
24617 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:311
24619 "Virt-inspector can detect some operating system installers on install disks, "
24620 "live CDs, bootable USB keys and more."
24624 #: ../inspector/virt-inspector.pod:314
24625 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:314
24627 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
24628 "fields may be present to indicate a live CD, network installer, or one part "
24629 "of a multipart CD. For example:"
24633 #: ../inspector/virt-inspector.pod:318
24634 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:318
24637 " <operatingsystems>\n"
24638 " <operatingsystem>\n"
24639 " <root>/dev/sda</root>\n"
24640 " <name>linux</name>\n"
24641 " <arch>i386</arch>\n"
24642 " <distro>ubuntu</distro>\n"
24643 " <product_name>Ubuntu 10.10 "Maverick Meerkat"</product_name>\n"
24644 " <major_version>10</major_version>\n"
24645 " <minor_version>10</minor_version>\n"
24646 " <format>installer</format>\n"
24652 #: ../inspector/virt-inspector.pod:330
24653 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:330
24654 msgid "USING XPATH"
24658 #: ../inspector/virt-inspector.pod:332
24659 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:332
24661 "You can use the XPath query language, and/or the xpath tool, in order to "
24662 "select parts of the XML."
24666 #: ../inspector/virt-inspector.pod:337
24667 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:337
24670 " $ virt-inspector -d Guest | xpath //filesystems\n"
24671 " Found 1 nodes:\n"
24674 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
24675 " <type>ext4</type>\n"
24681 #: ../inspector/virt-inspector.pod:345
24682 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:345
24685 " $ virt-inspector -d Guest | \\\n"
24686 " xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
24687 " Query didn't return a nodeset. Value: ext4\n"
24692 #: ../inspector/virt-inspector.pod:356
24693 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:356
24694 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
24698 #: ../inspector/virt-inspector.pod:358
24699 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:358
24701 "Early versions of libguestfs shipped with a different virt-inspector program "
24702 "written in Perl (the current version is written in C). The XML output of "
24703 "the Perl virt-inspector was different and it could also output in other "
24704 "formats like text."
24708 #: ../inspector/virt-inspector.pod:363
24709 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:363
24711 "The old virt-inspector is no longer supported or shipped with libguestfs."
24715 #: ../inspector/virt-inspector.pod:366
24716 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:366
24718 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
24719 "versions of virt-inspector with different names:"
24723 #: ../inspector/virt-inspector.pod:369
24724 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:369
24727 " virt-inspector Old Perl version.\n"
24728 " virt-inspector2 New C version.\n"
24733 #: ../inspector/virt-inspector.pod:374
24734 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:374
24736 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, L<base64(1)"
24737 ">, L<http://libguestfs.org/>."
24741 #: ../inspector/virt-inspector.pod:390
24742 #: ../libguestfs-1.11.20/inspector/virt-inspector.pod:390
24743 msgid "Matthew Booth L<mbooth@redhat.com>"
24747 #: ../java/examples/guestfs-java.pod:5
24748 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:5
24749 msgid "guestfs-java - How to use libguestfs from Java"
24753 #: ../java/examples/guestfs-java.pod:9
24754 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:9
24757 " import com.redhat.et.libguestfs.*;\n"
24762 #: ../java/examples/guestfs-java.pod:11
24763 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:11
24766 " GuestFS g = new GuestFS ();\n"
24767 " g.add_drive_opts (\"disk.img\", null);\n"
24773 #: ../java/examples/guestfs-java.pod:17
24774 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:17
24776 "This manual page documents how to call libguestfs from the Java programming "
24777 "language. This page just documents the differences from the C API and gives "
24778 "some examples. If you are not familiar with using libguestfs, you also need "
24779 "to read L<guestfs(3)>."
24783 #: ../java/examples/guestfs-java.pod:22
24784 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:22
24785 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:53
24786 #: ../ocaml/examples/guestfs-ocaml.pod:53
24787 msgid "CLOSING THE HANDLE"
24791 #: ../java/examples/guestfs-java.pod:24
24792 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:24
24794 "The handle is closed when it is reaped by the garbage collector. Because "
24795 "libguestfs handles include a lot of state, it is also possible to close (and "
24796 "hence free) them explicitly by calling the C<close> method."
24800 #: ../java/examples/guestfs-java.pod:29
24801 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:29
24802 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:60
24803 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:21
24804 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:22
24805 #: ../ocaml/examples/guestfs-ocaml.pod:60
24806 #: ../python/examples/guestfs-python.pod:21
24807 #: ../ruby/examples/guestfs-ruby.pod:22
24812 #: ../java/examples/guestfs-java.pod:31
24813 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:31
24815 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
24816 "exception. This has a single parameter which is the error message (a "
24821 #: ../java/examples/guestfs-java.pod:35
24822 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:35
24823 msgid "Calling any method on a closed handle raises the same exception."
24827 #: ../java/examples/guestfs-java.pod:47
24828 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:47
24830 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)"
24831 ">, L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
24832 "libguestfs.org/>, L<http://caml.inria.fr/>."
24836 #: ../java/examples/guestfs-java.pod:63
24837 #: ../libguestfs-1.11.20/java/examples/guestfs-java.pod:63
24838 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:57
24839 #: ../perl/examples/guestfs-perl.pod:57
24840 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
24844 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:5
24845 #: ../ocaml/examples/guestfs-ocaml.pod:5
24846 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
24850 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:9
24851 #: ../ocaml/examples/guestfs-ocaml.pod:9
24852 msgid "Module style:"
24856 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:11
24857 #: ../ocaml/examples/guestfs-ocaml.pod:11
24860 " let g = Guestfs.create () in\n"
24861 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
24862 " Guestfs.launch g;\n"
24867 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:15
24868 #: ../ocaml/examples/guestfs-ocaml.pod:15
24869 msgid "Object-oriented style:"
24873 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:17
24874 #: ../ocaml/examples/guestfs-ocaml.pod:17
24877 " let g = new Guestfs.guestfs () in\n"
24878 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
24884 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:21
24885 #: ../ocaml/examples/guestfs-ocaml.pod:21
24888 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
24890 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
24895 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:27
24896 #: ../ocaml/examples/guestfs-ocaml.pod:27
24898 "This manual page documents how to call libguestfs from the OCaml programming "
24899 "language. This page just documents the differences from the C API and gives "
24900 "some examples. If you are not familiar with using libguestfs, you also need "
24901 "to read L<guestfs(3)>."
24905 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:32
24906 #: ../ocaml/examples/guestfs-ocaml.pod:32
24907 msgid "PROGRAMMING STYLES"
24911 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:34
24912 #: ../ocaml/examples/guestfs-ocaml.pod:34
24914 "There are two different programming styles supported by the OCaml bindings. "
24915 "You can use a module style, with each C function mapped to an OCaml function:"
24919 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:38
24920 #: ../ocaml/examples/guestfs-ocaml.pod:38
24923 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
24928 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:40
24929 #: ../ocaml/examples/guestfs-ocaml.pod:40
24934 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:42
24935 #: ../ocaml/examples/guestfs-ocaml.pod:42
24938 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
24943 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:44
24944 #: ../ocaml/examples/guestfs-ocaml.pod:44
24946 "Alternately you can use an object-oriented style, calling methods on the "
24947 "class C<Guestfs.guestfs>:"
24951 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:47
24952 #: ../ocaml/examples/guestfs-ocaml.pod:47
24955 " method set_verbose : bool -> unit\n"
24960 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:49
24961 #: ../ocaml/examples/guestfs-ocaml.pod:49
24963 "The object-oriented style is usually briefer, and the minor performance "
24964 "penalty isn't noticable in the general overhead of performing libguestfs "
24969 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:55
24970 #: ../ocaml/examples/guestfs-ocaml.pod:55
24972 "The handle is closed when it is reaped by the garbage collector. Because "
24973 "libguestfs handles include a lot of state, it is also possible to close (and "
24974 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
24979 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:62
24980 #: ../ocaml/examples/guestfs-ocaml.pod:62
24982 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
24983 "exception. This has a single parameter which is the error message (a "
24988 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:66
24989 #: ../ocaml/examples/guestfs-ocaml.pod:66
24991 "Calling any function/method on a closed handle raises C<Guestfs."
24992 "Handle_closed>. The single parameter is the name of the function that you "
24997 #: ../libguestfs-1.11.20/ocaml/examples/guestfs-ocaml.pod:80
24998 #: ../ocaml/examples/guestfs-ocaml.pod:80
25000 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-perl(3)"
25001 ">, L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
25002 "libguestfs.org/>, L<http://caml.inria.fr/>."
25006 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:5
25007 #: ../perl/examples/guestfs-perl.pod:5
25008 msgid "guestfs-perl - How to use libguestfs from Perl"
25012 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:9
25013 #: ../perl/examples/guestfs-perl.pod:9
25016 " use Sys::Guestfs;\n"
25021 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:11
25022 #: ../perl/examples/guestfs-perl.pod:11
25025 " my $h = Sys::Guestfs->new ();\n"
25026 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
25027 " $h->launch ();\n"
25028 " $h->mount_options ('', '/dev/sda1', '/');\n"
25029 " $h->touch ('/hello');\n"
25035 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:20
25036 #: ../perl/examples/guestfs-perl.pod:20
25038 "This manual page documents how to call libguestfs from the Perl programming "
25039 "language. This page just documents the differences from the C API and gives "
25040 "some examples. If you are not familiar with using libguestfs, you also need "
25041 "to read L<guestfs(3)>. To read the full Perl API, see L<Sys::Guestfs(3)>."
25045 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:26
25046 #: ../perl/examples/guestfs-perl.pod:26
25051 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:28
25052 #: ../perl/examples/guestfs-perl.pod:28
25054 "Errors from libguestfs functions turn into calls to C<croak> (see L<Carp(3)"
25059 #: ../libguestfs-1.11.20/perl/examples/guestfs-perl.pod:41
25060 #: ../perl/examples/guestfs-perl.pod:41
25062 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)"
25063 ">, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
25064 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
25068 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:5
25069 #: ../python/examples/guestfs-python.pod:5
25070 msgid "guestfs-python - How to use libguestfs from Python"
25074 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:9
25075 #: ../python/examples/guestfs-python.pod:9
25078 " import guestfs\n"
25079 " g = guestfs.GuestFS ()\n"
25080 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
25086 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:16
25087 #: ../python/examples/guestfs-python.pod:16
25089 "This manual page documents how to call libguestfs from the Python "
25090 "programming language. This page just documents the differences from the C "
25091 "API and gives some examples. If you are not familiar with using libguestfs, "
25092 "you also need to read L<guestfs(3)>."
25096 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:23
25097 #: ../python/examples/guestfs-python.pod:23
25099 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
25100 "single string argument which is the error message."
25104 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:26
25105 #: ../python/examples/guestfs-python.pod:26
25106 msgid "MORE DOCUMENTATION"
25110 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:28
25111 #: ../python/examples/guestfs-python.pod:28
25116 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:30
25117 #: ../python/examples/guestfs-python.pod:30
25121 " >>> import guestfs\n"
25122 " >>> help (guestfs)\n"
25127 #: ../libguestfs-1.11.20/python/examples/guestfs-python.pod:44
25128 #: ../python/examples/guestfs-python.pod:44
25130 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)"
25131 ">, L<guestfs-perl(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://"
25132 "libguestfs.org/>."
25136 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:5 ../rescue/virt-rescue.pod:5
25137 msgid "virt-rescue - Run a rescue shell on a virtual machine"
25141 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:9 ../rescue/virt-rescue.pod:9
25144 " virt-rescue [--options] -d domname\n"
25149 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:11
25150 #: ../rescue/virt-rescue.pod:11
25153 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
25158 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:15
25159 #: ../rescue/virt-rescue.pod:15
25162 " virt-rescue [--options] domname\n"
25167 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:17
25168 #: ../rescue/virt-rescue.pod:17
25171 " virt-rescue [--options] disk.img [disk.img ...]\n"
25176 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:21
25177 #: ../rescue/virt-rescue.pod:21
25179 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
25180 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
25181 "you from doing this, but doesn't catch all cases."
25185 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:25
25186 #: ../rescue/virt-rescue.pod:25
25188 "However if you use the I<--ro> (read only) option, then you can attach a "
25189 "shell to a live virtual machine. The results might be strange or "
25190 "inconsistent at times but you won't get disk corruption."
25194 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:31
25195 #: ../rescue/virt-rescue.pod:31
25197 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
25198 "need for a CD. virt-rescue gives you a rescue shell and some simple "
25199 "recovery tools which you can use to examine or rescue a virtual machine or "
25204 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:36
25205 #: ../rescue/virt-rescue.pod:36
25207 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
25208 "on disk image(s):"
25212 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:39
25213 #: ../rescue/virt-rescue.pod:39
25216 " virt-rescue -d GuestName\n"
25221 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:41
25222 #: ../rescue/virt-rescue.pod:41
25225 " virt-rescue --ro -a /path/to/disk.img\n"
25230 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:43
25231 #: ../rescue/virt-rescue.pod:43
25234 " virt-rescue -a /dev/sdc\n"
25239 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:45
25240 #: ../rescue/virt-rescue.pod:45
25241 msgid "For live VMs you I<must> use the --ro option."
25245 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:47
25246 #: ../rescue/virt-rescue.pod:47
25248 "When you run virt-rescue on a virtual machine or disk image, you are placed "
25249 "in an interactive bash shell where you can use many ordinary Linux "
25250 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
25251 "appliance. You must mount the virtual machine's filesystems by hand. There "
25252 "is an empty directory called C</sysroot> where you can mount filesystems."
25256 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:54
25257 #: ../rescue/virt-rescue.pod:54
25259 "In the example below, we list logical volumes, then choose one to mount "
25260 "under C</sysroot>:"
25264 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:57
25265 #: ../rescue/virt-rescue.pod:57
25269 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
25270 " lv_root vg_f11x64 -wi-a- 8.83G\n"
25271 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
25272 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
25273 " ><rescue> ls /sysroot\n"
25278 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:64
25279 #: ../rescue/virt-rescue.pod:64
25281 "If you don't know what filesystems are available on the virtual machine then "
25282 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
25286 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:70
25287 #: ../rescue/virt-rescue.pod:70
25289 "Virt-rescue can be used on I<any> disk image file or device, not just a "
25290 "virtual machine. For example you can use it on a blank file if you want to "
25291 "partition that file (although we would recommend using L<guestfish(1)> "
25292 "instead as it is more suitable for this purpose). You can even use virt-"
25293 "rescue on things like SD cards."
25297 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:76
25298 #: ../rescue/virt-rescue.pod:76
25300 "Virt-rescue does not require root. You only need to run it as root if you "
25301 "need root to open the disk image."
25305 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:79
25306 #: ../rescue/virt-rescue.pod:79
25308 "This tool is just designed for quick interactive hacking on a virtual "
25309 "machine. For more structured access to a virtual machine disk image, you "
25310 "should use L<guestfs(3)>. To get a structured shell that you can use to "
25311 "make scripted changes to guests, use L<guestfish(1)>."
25315 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:103
25316 #: ../rescue/virt-rescue.pod:103
25317 msgid "B<--append kernelopts>"
25321 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:105
25322 #: ../rescue/virt-rescue.pod:105
25323 msgid "Pass additional options to the rescue kernel."
25327 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:135
25328 #: ../rescue/virt-rescue.pod:135
25331 " virt-rescue --format=raw -a disk.img\n"
25336 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:139
25337 #: ../rescue/virt-rescue.pod:139
25340 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
25345 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:148
25346 #: ../rescue/virt-rescue.pod:148
25351 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:150
25352 #: ../rescue/virt-rescue.pod:150
25353 msgid "B<--memsize MB>"
25357 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:152
25358 #: ../rescue/virt-rescue.pod:152
25360 "Change the amount of memory allocated to the rescue system. The default is "
25361 "set by libguestfs and is small but adequate for running system tools. The "
25362 "occasional program might need more memory. The parameter is specified in "
25367 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:157
25368 #: ../rescue/virt-rescue.pod:157
25369 msgid "B<--network>"
25373 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:159
25374 #: ../rescue/virt-rescue.pod:159
25375 msgid "Enable QEMU user networking in the guest. See L</NETWORK>."
25379 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:165
25380 #: ../rescue/virt-rescue.pod:165
25381 msgid "Open the image read-only."
25385 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:175
25386 #: ../rescue/virt-rescue.pod:175
25388 "Enable SELinux in the rescue appliance. You should read L<guestfs(3)/"
25389 "SELINUX> before using this option."
25393 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:194
25394 #: ../rescue/virt-rescue.pod:194
25396 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
25397 "are done read-write."
25401 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:207
25402 #: ../rescue/virt-rescue.pod:207
25403 msgid "Previous versions of virt-rescue allowed you to write either:"
25407 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:209
25408 #: ../rescue/virt-rescue.pod:209
25411 " virt-rescue disk.img [disk.img ...]\n"
25416 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:213
25417 #: ../rescue/virt-rescue.pod:213
25420 " virt-rescue guestname\n"
25425 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:221
25426 #: ../rescue/virt-rescue.pod:221
25431 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:223
25432 #: ../rescue/virt-rescue.pod:223
25434 "Adding the I<--network> option enables QEMU user networking in the rescue "
25435 "appliance. There are some differences between user networking and ordinary "
25440 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:229
25441 #: ../rescue/virt-rescue.pod:229
25442 msgid "ping does not work"
25446 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:231
25447 #: ../rescue/virt-rescue.pod:231
25449 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
25450 "send the ping packets, and because virt-rescue must be able to run as non-"
25451 "root, QEMU user networking is not able to emulate the L<ping(8)> command. "
25452 "The ping command will appear to resolve addresses but will not be able to "
25453 "send or receive any packets. This does not mean that the network is not "
25458 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:238
25459 #: ../rescue/virt-rescue.pod:238
25460 msgid "cannot receive connections"
25464 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:240
25465 #: ../rescue/virt-rescue.pod:240
25466 msgid "QEMU user networking cannot receive incoming connections."
25470 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:242
25471 #: ../rescue/virt-rescue.pod:242
25472 msgid "making TCP connections"
25476 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:244
25477 #: ../rescue/virt-rescue.pod:244
25479 "The virt-rescue appliance needs to be small and so does not include many "
25480 "network tools. In particular there is no L<telnet(1)> command. You can "
25481 "make TCP connections from the shell using the magical C</dev/tcp/"
25482 "E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
25486 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:249
25487 #: ../rescue/virt-rescue.pod:249
25490 " exec 3<>/dev/tcp/redhat.com/80\n"
25491 " echo \"GET /\" >&3\n"
25497 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:253
25498 #: ../rescue/virt-rescue.pod:253
25499 msgid "See L<bash(1)> for more details."
25503 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:259
25504 #: ../rescue/virt-rescue.pod:259
25506 "Several environment variables affect virt-rescue. See L<guestfs(3)/"
25507 "ENVIRONMENT VARIABLES> for the complete list."
25511 #: ../libguestfs-1.11.20/rescue/virt-rescue.pod:286
25512 #: ../rescue/virt-rescue.pod:286
25514 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<http://"
25515 "libguestfs.org/>."
25519 #: ../libguestfs-1.11.20/resize/virt-resize.pod:5 ../resize/virt-resize.pod:5
25520 msgid "virt-resize - Resize a virtual machine disk"
25524 #: ../libguestfs-1.11.20/resize/virt-resize.pod:9 ../resize/virt-resize.pod:9
25527 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
25528 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
25529 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
25534 #: ../libguestfs-1.11.20/resize/virt-resize.pod:15
25535 #: ../resize/virt-resize.pod:15
25537 "Virt-resize is a tool which can resize a virtual machine disk, making it "
25538 "larger or smaller overall, and resizing or deleting any partitions contained "
25543 #: ../libguestfs-1.11.20/resize/virt-resize.pod:19
25544 #: ../resize/virt-resize.pod:19
25546 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
25547 "not> be used on live virtual machines - for consistent results, shut the "
25548 "virtual machine down before resizing it."
25552 #: ../libguestfs-1.11.20/resize/virt-resize.pod:23
25553 #: ../resize/virt-resize.pod:23
25555 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
25556 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
25560 #: ../libguestfs-1.11.20/resize/virt-resize.pod:31
25561 #: ../libguestfs-1.11.20/src/guestfs.pod:469
25562 #: ../libguestfs-1.11.20/src/guestfs.pod:1257
25563 #: ../libguestfs-1.11.20/src/guestfs.pod:1395
25564 #: ../libguestfs-1.11.20/src/guestfs.pod:2465 ../resize/virt-resize.pod:31
25565 #: ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395
25566 #: ../src/guestfs.pod:2465
25571 #: ../libguestfs-1.11.20/resize/virt-resize.pod:33
25572 #: ../resize/virt-resize.pod:33
25574 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
25575 "fill the extra 5GB of space."
25579 #: ../libguestfs-1.11.20/resize/virt-resize.pod:36
25580 #: ../resize/virt-resize.pod:36
25583 " virt-filesystems --long -h --all -a olddisk\n"
25588 #: ../libguestfs-1.11.20/resize/virt-resize.pod:38
25589 #: ../resize/virt-resize.pod:38
25592 " truncate -r olddisk newdisk\n"
25593 " truncate -s +5G newdisk\n"
25598 #: ../libguestfs-1.11.20/resize/virt-resize.pod:41
25599 #: ../resize/virt-resize.pod:41
25602 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
25603 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
25608 #: ../libguestfs-1.11.20/resize/virt-resize.pod:44
25609 #: ../libguestfs-1.11.20/src/guestfs.pod:475
25610 #: ../libguestfs-1.11.20/src/guestfs.pod:1261
25611 #: ../libguestfs-1.11.20/src/guestfs.pod:1399
25612 #: ../libguestfs-1.11.20/src/guestfs.pod:2490 ../resize/virt-resize.pod:44
25613 #: ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399
25614 #: ../src/guestfs.pod:2490
25619 #: ../libguestfs-1.11.20/resize/virt-resize.pod:46
25620 #: ../resize/virt-resize.pod:46
25622 "As above, but make the /boot partition 200MB bigger, while giving the "
25623 "remaining space to /dev/sda2:"
25627 #: ../libguestfs-1.11.20/resize/virt-resize.pod:49
25628 #: ../resize/virt-resize.pod:49
25631 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
25632 " olddisk newdisk\n"
25637 #: ../libguestfs-1.11.20/resize/virt-resize.pod:52
25638 #: ../libguestfs-1.11.20/src/guestfs.pod:486
25639 #: ../libguestfs-1.11.20/src/guestfs.pod:1405 ../resize/virt-resize.pod:52
25640 #: ../src/guestfs.pod:486 ../src/guestfs.pod:1405
25645 #: ../libguestfs-1.11.20/resize/virt-resize.pod:54
25646 #: ../resize/virt-resize.pod:54
25648 "As in the first example, but expand a logical volume as the final step. "
25649 "This is what you would typically use for Linux guests that use LVM:"
25653 #: ../libguestfs-1.11.20/resize/virt-resize.pod:58
25654 #: ../resize/virt-resize.pod:58
25657 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
25658 " olddisk newdisk\n"
25663 #: ../libguestfs-1.11.20/resize/virt-resize.pod:61
25664 #: ../resize/virt-resize.pod:61
25669 #: ../libguestfs-1.11.20/resize/virt-resize.pod:63
25670 #: ../resize/virt-resize.pod:63
25672 "As in the first example, but the output format will be qcow2 instead of a "
25677 #: ../libguestfs-1.11.20/resize/virt-resize.pod:66
25678 #: ../resize/virt-resize.pod:66
25681 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
25682 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
25687 #: ../libguestfs-1.11.20/resize/virt-resize.pod:71
25688 #: ../resize/virt-resize.pod:71
25689 msgid "DETAILED USAGE"
25693 #: ../libguestfs-1.11.20/resize/virt-resize.pod:73
25694 #: ../resize/virt-resize.pod:73
25695 msgid "EXPANDING A VIRTUAL MACHINE DISK"
25699 #: ../libguestfs-1.11.20/resize/virt-resize.pod:77
25700 #: ../resize/virt-resize.pod:77
25701 msgid "1. Shut down the virtual machine"
25705 #: ../libguestfs-1.11.20/resize/virt-resize.pod:79
25706 #: ../resize/virt-resize.pod:79
25707 msgid "2. Locate input disk image"
25711 #: ../libguestfs-1.11.20/resize/virt-resize.pod:81
25712 #: ../resize/virt-resize.pod:81
25714 "Locate the input disk image (ie. the file or device on the host containing "
25715 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
25716 "dumpxml> like this to find the disk image name:"
25720 #: ../libguestfs-1.11.20/resize/virt-resize.pod:85
25721 #: ../resize/virt-resize.pod:85
25724 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
25725 " Found 1 nodes:\n"
25727 " <source dev=\"/dev/vg/lv_guest\" />\n"
25732 #: ../libguestfs-1.11.20/resize/virt-resize.pod:90
25733 #: ../resize/virt-resize.pod:90
25734 msgid "3. Look at current sizing"
25738 #: ../libguestfs-1.11.20/resize/virt-resize.pod:92
25739 #: ../resize/virt-resize.pod:92
25740 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
25744 #: ../libguestfs-1.11.20/resize/virt-resize.pod:95
25745 #: ../resize/virt-resize.pod:95
25748 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
25749 " Name Type Size Parent\n"
25750 " /dev/sda1 partition 101M /dev/sda\n"
25751 " /dev/sda2 partition 7.9G /dev/sda\n"
25752 " /dev/sda device 8.0G -\n"
25757 #: ../libguestfs-1.11.20/resize/virt-resize.pod:101
25758 #: ../resize/virt-resize.pod:101
25760 "(This example is a virtual machine with an 8 GB disk which we would like to "
25761 "expand up to 10 GB)."
25765 #: ../libguestfs-1.11.20/resize/virt-resize.pod:104
25766 #: ../resize/virt-resize.pod:104
25767 msgid "4. Create output disk"
25771 #: ../libguestfs-1.11.20/resize/virt-resize.pod:106
25772 #: ../resize/virt-resize.pod:106
25774 "Virt-resize cannot do in-place disk modifications. You have to have space "
25775 "to store the resized output disk."
25779 #: ../libguestfs-1.11.20/resize/virt-resize.pod:109
25780 #: ../resize/virt-resize.pod:109
25782 "To store the resized disk image in a file, create a file of a suitable size:"
25786 #: ../libguestfs-1.11.20/resize/virt-resize.pod:112
25787 #: ../resize/virt-resize.pod:112
25790 " # rm -f outdisk\n"
25791 " # truncate -s 10G outdisk\n"
25796 #: ../libguestfs-1.11.20/resize/virt-resize.pod:115
25797 #: ../resize/virt-resize.pod:115
25798 msgid "Or use L<lvcreate(1)> to create a logical volume:"
25802 #: ../libguestfs-1.11.20/resize/virt-resize.pod:117
25803 #: ../resize/virt-resize.pod:117
25806 " # lvcreate -L 10G -n lv_name vg_name\n"
25811 #: ../libguestfs-1.11.20/resize/virt-resize.pod:119
25812 #: ../resize/virt-resize.pod:119
25813 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
25817 #: ../libguestfs-1.11.20/resize/virt-resize.pod:121
25818 #: ../resize/virt-resize.pod:121
25821 " # virsh pool-list\n"
25822 " # virsh vol-create-as poolname newvol 10G\n"
25827 #: ../libguestfs-1.11.20/resize/virt-resize.pod:124
25828 #: ../resize/virt-resize.pod:124
25833 #: ../libguestfs-1.11.20/resize/virt-resize.pod:126
25834 #: ../resize/virt-resize.pod:126
25836 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
25837 "file) and the output disk. The output disk is the one created in the "
25842 #: ../libguestfs-1.11.20/resize/virt-resize.pod:130
25843 #: ../resize/virt-resize.pod:130
25846 " # virt-resize indisk outdisk\n"
25851 #: ../libguestfs-1.11.20/resize/virt-resize.pod:132
25852 #: ../resize/virt-resize.pod:132
25854 "This command just copies disk image C<indisk> to disk image C<outdisk> "
25855 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
25856 "larger, then an extra, empty partition is created at the end of the disk "
25857 "covering the extra space. If C<outdisk> is smaller, then it will give an "
25862 #: ../libguestfs-1.11.20/resize/virt-resize.pod:138
25863 #: ../resize/virt-resize.pod:138
25865 "More realistically you'd want to expand existing partitions in the disk "
25866 "image by passing extra options (for the full list see the L</OPTIONS> "
25871 #: ../libguestfs-1.11.20/resize/virt-resize.pod:142
25872 #: ../resize/virt-resize.pod:142
25874 "L</--expand> is the most useful option. It expands the named partition "
25875 "within the disk to fill any extra space:"
25879 #: ../libguestfs-1.11.20/resize/virt-resize.pod:145
25880 #: ../resize/virt-resize.pod:145
25883 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
25888 #: ../libguestfs-1.11.20/resize/virt-resize.pod:147
25889 #: ../resize/virt-resize.pod:147
25891 "(In this case, an extra partition is I<not> created at the end of the disk, "
25892 "because there will be no unused space)."
25896 #: ../libguestfs-1.11.20/resize/virt-resize.pod:150
25897 #: ../resize/virt-resize.pod:150
25899 "L</--resize> is the other commonly used option. The following would "
25900 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
25901 "rest of the available space:"
25905 #: ../libguestfs-1.11.20/resize/virt-resize.pod:154
25906 #: ../resize/virt-resize.pod:154
25909 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
25910 " indisk outdisk\n"
25915 #: ../libguestfs-1.11.20/resize/virt-resize.pod:157
25916 #: ../resize/virt-resize.pod:157
25918 "If the expanded partition in the image contains a filesystem or LVM PV, then "
25919 "if virt-resize knows how, it will resize the contents, the equivalent of "
25920 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
25921 "or L<btrfs(8)>. However virt-resize does not know how to resize some "
25922 "filesystems, so you would have to online resize them after booting the guest."
25926 #: ../libguestfs-1.11.20/resize/virt-resize.pod:164
25927 #: ../resize/virt-resize.pod:164
25928 msgid "Other options are covered below."
25932 #: ../libguestfs-1.11.20/resize/virt-resize.pod:166
25933 #: ../resize/virt-resize.pod:166
25938 #: ../libguestfs-1.11.20/resize/virt-resize.pod:168
25939 #: ../resize/virt-resize.pod:168
25940 msgid "Thoroughly test the new disk image I<before> discarding the old one."
25944 #: ../libguestfs-1.11.20/resize/virt-resize.pod:170
25945 #: ../resize/virt-resize.pod:170
25946 msgid "If you are using libvirt, edit the XML to point at the new disk:"
25950 #: ../libguestfs-1.11.20/resize/virt-resize.pod:172
25951 #: ../resize/virt-resize.pod:172
25954 " # virsh edit guestname\n"
25959 #: ../libguestfs-1.11.20/resize/virt-resize.pod:174
25960 #: ../resize/virt-resize.pod:174
25962 "Change E<lt>source ...E<gt>, see L<http://libvirt.org/formatdomain."
25963 "html#elementsDisks>"
25967 #: ../libguestfs-1.11.20/resize/virt-resize.pod:177
25968 #: ../resize/virt-resize.pod:177
25969 msgid "Then start up the domain with the new, resized disk:"
25973 #: ../libguestfs-1.11.20/resize/virt-resize.pod:179
25974 #: ../resize/virt-resize.pod:179
25977 " # virsh start guestname\n"
25982 #: ../libguestfs-1.11.20/resize/virt-resize.pod:181
25983 #: ../resize/virt-resize.pod:181
25985 "and check that it still works. See also the L</NOTES> section below for "
25986 "additional information."
25990 #: ../libguestfs-1.11.20/resize/virt-resize.pod:184
25991 #: ../resize/virt-resize.pod:184
25992 msgid "7. Resize LVs etc inside the guest"
25996 #: ../libguestfs-1.11.20/resize/virt-resize.pod:186
25997 #: ../resize/virt-resize.pod:186
25998 msgid "(This can also be done offline using L<guestfish(1)>)"
26002 #: ../libguestfs-1.11.20/resize/virt-resize.pod:188
26003 #: ../resize/virt-resize.pod:188
26005 "Once the guest has booted you should see the new space available, at least "
26006 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
26007 "may need to resize LVs inside PVs, and also resize filesystem types that "
26008 "virt-resize does not know how to expand."
26012 #: ../libguestfs-1.11.20/resize/virt-resize.pod:195
26013 #: ../resize/virt-resize.pod:195
26014 msgid "SHRINKING A VIRTUAL MACHINE DISK"
26018 #: ../libguestfs-1.11.20/resize/virt-resize.pod:197
26019 #: ../resize/virt-resize.pod:197
26021 "Shrinking is somewhat more complex than expanding, and only an overview is "
26026 #: ../libguestfs-1.11.20/resize/virt-resize.pod:200
26027 #: ../resize/virt-resize.pod:200
26029 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
26030 "filesystems). The user has to shrink content before passing the disk image "
26031 "to virt-resize, and virt-resize will check that the content has been shrunk "
26036 #: ../libguestfs-1.11.20/resize/virt-resize.pod:205
26037 #: ../resize/virt-resize.pod:205
26038 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
26042 #: ../libguestfs-1.11.20/resize/virt-resize.pod:207
26043 #: ../resize/virt-resize.pod:207
26045 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
26046 "steps 3 and 4 above to allocate a new disk image."
26050 #: ../libguestfs-1.11.20/resize/virt-resize.pod:210
26051 #: ../resize/virt-resize.pod:210
26053 "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
26057 #: ../libguestfs-1.11.20/resize/virt-resize.pod:213
26058 #: ../resize/virt-resize.pod:213
26059 msgid "IGNORING OR DELETING PARTITIONS"
26063 #: ../libguestfs-1.11.20/resize/virt-resize.pod:215
26064 #: ../resize/virt-resize.pod:215
26066 "virt-resize also gives a convenient way to ignore or delete partitions when "
26067 "copying from the input disk to the output disk. Ignoring a partition speeds "
26068 "up the copy where you don't care about the existing contents of a "
26069 "partition. Deleting a partition removes it completely, but note that it "
26070 "also renumbers any partitions after the one which is deleted, which can "
26071 "leave some guests unbootable."
26075 #: ../libguestfs-1.11.20/resize/virt-resize.pod:222
26076 #: ../resize/virt-resize.pod:222
26077 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
26081 #: ../libguestfs-1.11.20/resize/virt-resize.pod:224
26082 #: ../resize/virt-resize.pod:224
26084 "If the input disk is in qcow2 format, then you may prefer that the output is "
26085 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
26086 "the fly. The output format is simply determined by the format of the empty "
26087 "output container that you provide. Thus to create qcow2 output, use:"
26091 #: ../libguestfs-1.11.20/resize/virt-resize.pod:230
26092 #: ../resize/virt-resize.pod:230
26095 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
26100 #: ../libguestfs-1.11.20/resize/virt-resize.pod:232
26101 #: ../resize/virt-resize.pod:232
26102 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
26106 #: ../libguestfs-1.11.20/resize/virt-resize.pod:234
26107 #: ../resize/virt-resize.pod:234
26108 msgid "Similarly, to get non-sparse raw output use:"
26112 #: ../libguestfs-1.11.20/resize/virt-resize.pod:236
26113 #: ../resize/virt-resize.pod:236
26116 " fallocate -l size outdisk\n"
26121 #: ../libguestfs-1.11.20/resize/virt-resize.pod:238
26122 #: ../resize/virt-resize.pod:238
26124 "(on older systems that don't have the L<fallocate(1)> command use C<dd if=/"
26125 "dev/zero of=outdisk bs=1M count=..>)"
26129 #: ../libguestfs-1.11.20/resize/virt-resize.pod:247
26130 #: ../resize/virt-resize.pod:247
26131 msgid "Display help."
26135 #: ../libguestfs-1.11.20/resize/virt-resize.pod:249
26136 #: ../resize/virt-resize.pod:249
26141 #: ../libguestfs-1.11.20/resize/virt-resize.pod:251
26142 #: ../resize/virt-resize.pod:251 ../tools/virt-make-fs.pl:177
26143 #: ../tools/virt-win-reg.pl:120
26148 #: ../libguestfs-1.11.20/resize/virt-resize.pod:253
26149 #: ../resize/virt-resize.pod:253 ../tools/virt-win-reg.pl:122
26150 msgid "Enable debugging messages."
26154 #: ../libguestfs-1.11.20/resize/virt-resize.pod:255
26155 #: ../resize/virt-resize.pod:255
26156 msgid "B<--delete part>"
26160 #: ../libguestfs-1.11.20/resize/virt-resize.pod:257
26161 #: ../resize/virt-resize.pod:257
26163 "Delete the named partition. It would be more accurate to describe this as "
26164 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
26165 "the original disk image is left intact."
26169 #: ../libguestfs-1.11.20/resize/virt-resize.pod:261
26170 #: ../resize/virt-resize.pod:261
26172 "Note that when you delete a partition, then anything contained in the "
26173 "partition is also deleted. Furthermore, this causes any partitions that "
26174 "come after to be I<renumbered>, which can easily make your guest unbootable."
26178 #: ../libguestfs-1.11.20/resize/virt-resize.pod:266
26179 #: ../libguestfs-1.11.20/resize/virt-resize.pod:327
26180 #: ../libguestfs-1.11.20/resize/virt-resize.pod:448
26181 #: ../resize/virt-resize.pod:266 ../resize/virt-resize.pod:327
26182 #: ../resize/virt-resize.pod:448
26183 msgid "You can give this option multiple times."
26187 #: ../libguestfs-1.11.20/resize/virt-resize.pod:268
26188 #: ../resize/virt-resize.pod:268
26189 msgid "B<--expand part>"
26193 #: ../libguestfs-1.11.20/resize/virt-resize.pod:270
26194 #: ../resize/virt-resize.pod:270
26196 "Expand the named partition so it uses up all extra space (space left over "
26197 "after any other resize changes that you request have been done)."
26201 #: ../libguestfs-1.11.20/resize/virt-resize.pod:273
26202 #: ../resize/virt-resize.pod:273
26204 "If virt-resize knows how, it will expand the direct content of the "
26205 "partition. For example, if the partition is an LVM PV, it will expand the "
26206 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
26207 "content it doesn't know about alone."
26211 #: ../libguestfs-1.11.20/resize/virt-resize.pod:278
26212 #: ../resize/virt-resize.pod:278
26213 msgid "Currently virt-resize can resize:"
26217 #: ../libguestfs-1.11.20/resize/virt-resize.pod:284
26218 #: ../resize/virt-resize.pod:284
26219 msgid "ext2, ext3 and ext4 filesystems."
26223 #: ../libguestfs-1.11.20/resize/virt-resize.pod:288
26224 #: ../resize/virt-resize.pod:288
26225 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
26229 #: ../libguestfs-1.11.20/resize/virt-resize.pod:290
26230 #: ../resize/virt-resize.pod:290
26232 "The filesystem must have been shut down consistently last time it was used. "
26233 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
26234 "consistency check, so at the first boot after resizing Windows will check "
26239 #: ../libguestfs-1.11.20/resize/virt-resize.pod:297
26240 #: ../resize/virt-resize.pod:297
26242 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
26243 "inside the PV, but see the I<--LV-expand> option. The user could also "
26244 "resize LVs as desired after boot."
26248 #: ../libguestfs-1.11.20/resize/virt-resize.pod:303
26249 #: ../resize/virt-resize.pod:303
26250 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
26254 #: ../libguestfs-1.11.20/resize/virt-resize.pod:307
26255 #: ../libguestfs-1.11.20/resize/virt-resize.pod:476
26256 #: ../resize/virt-resize.pod:307 ../resize/virt-resize.pod:476
26257 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
26261 #: ../libguestfs-1.11.20/resize/virt-resize.pod:309
26262 #: ../resize/virt-resize.pod:309 ../tools/virt-list-filesystems.pl:91
26263 #: ../tools/virt-list-partitions.pl:92 ../tools/virt-tar.pl:141
26264 #: ../tools/virt-win-reg.pl:142
26265 msgid "B<--format> raw"
26269 #: ../libguestfs-1.11.20/resize/virt-resize.pod:311
26270 #: ../resize/virt-resize.pod:311
26272 "Specify the format of the input disk image. If this flag is not given then "
26273 "it is auto-detected from the image itself."
26277 #: ../libguestfs-1.11.20/resize/virt-resize.pod:317
26278 #: ../resize/virt-resize.pod:317
26280 "Note that this option I<does not> affect the output format. See L</QCOW2 "
26281 "AND NON-SPARSE RAW FORMATS>."
26285 #: ../libguestfs-1.11.20/resize/virt-resize.pod:320
26286 #: ../resize/virt-resize.pod:320
26287 msgid "B<--ignore part>"
26291 #: ../libguestfs-1.11.20/resize/virt-resize.pod:322
26292 #: ../resize/virt-resize.pod:322
26294 "Ignore the named partition. Effectively this means the partition is "
26295 "allocated on the destination disk, but the content is not copied across from "
26296 "the source disk. The content of the partition will be blank (all zero "
26301 #: ../libguestfs-1.11.20/resize/virt-resize.pod:329
26302 #: ../resize/virt-resize.pod:329
26303 msgid "B<--LV-expand logvol>"
26307 #: ../libguestfs-1.11.20/resize/virt-resize.pod:331
26308 #: ../resize/virt-resize.pod:331
26310 "This takes the logical volume and, as a final step, expands it to fill all "
26311 "the space available in its volume group. A typical usage, assuming a Linux "
26312 "guest with a single PV C</dev/sda2> and a root device called C</dev/vg_guest/"
26313 "lv_root> would be:"
26317 #: ../libguestfs-1.11.20/resize/virt-resize.pod:336
26318 #: ../resize/virt-resize.pod:336
26321 " virt-resize indisk outdisk \\\n"
26322 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
26327 #: ../libguestfs-1.11.20/resize/virt-resize.pod:339
26328 #: ../resize/virt-resize.pod:339
26330 "This would first expand the partition (and PV), and then expand the root "
26331 "device to fill the extra space in the PV."
26335 #: ../libguestfs-1.11.20/resize/virt-resize.pod:342
26336 #: ../resize/virt-resize.pod:342
26338 "The contents of the LV are also resized if virt-resize knows how to do "
26339 "that. You can stop virt-resize from trying to expand the content by using "
26340 "the option I<--no-expand-content>."
26344 #: ../libguestfs-1.11.20/resize/virt-resize.pod:346
26345 #: ../resize/virt-resize.pod:346
26346 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
26350 #: ../libguestfs-1.11.20/resize/virt-resize.pod:348
26351 #: ../resize/virt-resize.pod:348
26353 "You can give this option multiple times, I<but> it doesn't make sense to do "
26354 "this unless the logical volumes you specify are all in different volume "
26359 #: ../libguestfs-1.11.20/resize/virt-resize.pod:354
26360 #: ../resize/virt-resize.pod:354
26361 msgid "B<--dryrun>"
26365 #: ../libguestfs-1.11.20/resize/virt-resize.pod:356
26366 #: ../resize/virt-resize.pod:356
26367 msgid "Print a summary of what would be done, but don't do anything."
26371 #: ../libguestfs-1.11.20/resize/virt-resize.pod:358
26372 #: ../resize/virt-resize.pod:358
26373 msgid "B<--no-copy-boot-loader>"
26377 #: ../libguestfs-1.11.20/resize/virt-resize.pod:360
26378 #: ../resize/virt-resize.pod:360
26380 "By default, virt-resize copies over some sectors at the start of the disk "
26381 "(up to the beginning of the first partition). Commonly these sectors "
26382 "contain the Master Boot Record (MBR) and the boot loader, and are required "
26383 "in order for the guest to boot correctly."
26387 #: ../libguestfs-1.11.20/resize/virt-resize.pod:365
26388 #: ../resize/virt-resize.pod:365
26390 "If you specify this flag, then this initial copy is not done. You may need "
26391 "to reinstall the boot loader in this case."
26395 #: ../libguestfs-1.11.20/resize/virt-resize.pod:368
26396 #: ../resize/virt-resize.pod:368
26397 msgid "B<--no-extra-partition>"
26401 #: ../libguestfs-1.11.20/resize/virt-resize.pod:370
26402 #: ../resize/virt-resize.pod:370
26404 "By default, virt-resize creates an extra partition if there is any extra, "
26405 "unused space after all resizing has happened. Use this option to prevent "
26406 "the extra partition from being created. If you do this then the extra space "
26407 "will be inaccessible until you run fdisk, parted, or some other partitioning "
26408 "tool in the guest."
26412 #: ../libguestfs-1.11.20/resize/virt-resize.pod:376
26413 #: ../resize/virt-resize.pod:376
26415 "Note that if the surplus space is smaller than 10 MB, no extra partition "
26420 #: ../libguestfs-1.11.20/resize/virt-resize.pod:379
26421 #: ../resize/virt-resize.pod:379
26422 msgid "B<--no-expand-content>"
26426 #: ../libguestfs-1.11.20/resize/virt-resize.pod:381
26427 #: ../resize/virt-resize.pod:381
26429 "By default, virt-resize will try to expand the direct contents of "
26430 "partitions, if it knows how (see I<--expand> option above)."
26434 #: ../libguestfs-1.11.20/resize/virt-resize.pod:384
26435 #: ../resize/virt-resize.pod:384
26437 "If you give the I<--no-expand-content> option then virt-resize will not "
26442 #: ../libguestfs-1.11.20/resize/virt-resize.pod:387
26443 #: ../resize/virt-resize.pod:387
26444 msgid "B<--ntfsresize-force>"
26448 #: ../libguestfs-1.11.20/resize/virt-resize.pod:389
26449 #: ../resize/virt-resize.pod:389
26451 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
26452 "the NTFS disk is marked as needing a consistency check. You have to use "
26453 "this option if you want to resize a Windows guest multiple times without "
26454 "booting into Windows between each resize."
26458 #: ../libguestfs-1.11.20/resize/virt-resize.pod:395
26459 #: ../resize/virt-resize.pod:395
26460 msgid "B<--output-format> raw"
26464 #: ../libguestfs-1.11.20/resize/virt-resize.pod:397
26465 #: ../resize/virt-resize.pod:397
26467 "Specify the format of the output disk image. If this flag is not given then "
26468 "it is auto-detected from the image itself."
26472 #: ../libguestfs-1.11.20/resize/virt-resize.pod:403
26473 #: ../resize/virt-resize.pod:403
26475 "Note that this option I<does not create> the output format. This option "
26476 "just tells libguestfs what it is so it doesn't try to guess it. You still "
26477 "need to create the output disk with the right format. See L</QCOW2 AND NON-"
26478 "SPARSE RAW FORMATS>."
26482 #: ../libguestfs-1.11.20/resize/virt-resize.pod:408
26483 #: ../resize/virt-resize.pod:408
26488 #: ../libguestfs-1.11.20/resize/virt-resize.pod:410
26489 #: ../resize/virt-resize.pod:410
26494 #: ../libguestfs-1.11.20/resize/virt-resize.pod:412
26495 #: ../resize/virt-resize.pod:412
26496 msgid "Don't print the summary."
26500 #: ../libguestfs-1.11.20/resize/virt-resize.pod:414
26501 #: ../resize/virt-resize.pod:414
26502 msgid "B<--resize part=size>"
26506 #: ../libguestfs-1.11.20/resize/virt-resize.pod:416
26507 #: ../resize/virt-resize.pod:416
26509 "Resize the named partition (expanding or shrinking it) so that it has the "
26514 #: ../libguestfs-1.11.20/resize/virt-resize.pod:419
26515 #: ../resize/virt-resize.pod:419
26517 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
26518 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
26519 "size; or as a relative number or percentage. For example:"
26523 #: ../libguestfs-1.11.20/resize/virt-resize.pod:425
26524 #: ../resize/virt-resize.pod:425
26527 " --resize /dev/sda2=10G\n"
26532 #: ../libguestfs-1.11.20/resize/virt-resize.pod:427
26533 #: ../resize/virt-resize.pod:427
26536 " --resize /dev/sda4=90%\n"
26541 #: ../libguestfs-1.11.20/resize/virt-resize.pod:429
26542 #: ../resize/virt-resize.pod:429
26545 " --resize /dev/sda2=+1G\n"
26550 #: ../libguestfs-1.11.20/resize/virt-resize.pod:431
26551 #: ../resize/virt-resize.pod:431
26554 " --resize /dev/sda2=-200M\n"
26559 #: ../libguestfs-1.11.20/resize/virt-resize.pod:433
26560 #: ../resize/virt-resize.pod:433
26563 " --resize /dev/sda1=+128K\n"
26568 #: ../libguestfs-1.11.20/resize/virt-resize.pod:435
26569 #: ../resize/virt-resize.pod:435
26572 " --resize /dev/sda1=+10%\n"
26577 #: ../libguestfs-1.11.20/resize/virt-resize.pod:437
26578 #: ../resize/virt-resize.pod:437
26581 " --resize /dev/sda1=-10%\n"
26586 #: ../libguestfs-1.11.20/resize/virt-resize.pod:439
26587 #: ../resize/virt-resize.pod:439
26589 "You can increase the size of any partition. Virt-resize will expand the "
26590 "direct content of the partition if it knows how (see I<--expand> below)."
26594 #: ../libguestfs-1.11.20/resize/virt-resize.pod:443
26595 #: ../resize/virt-resize.pod:443
26597 "You can only I<decrease> the size of partitions that contain filesystems or "
26598 "PVs which have already been shrunk. Virt-resize will check this has been "
26599 "done before proceeding, or else will print an error (see also I<--resize-"
26604 #: ../libguestfs-1.11.20/resize/virt-resize.pod:450
26605 #: ../resize/virt-resize.pod:450
26606 msgid "B<--resize-force part=size>"
26610 #: ../libguestfs-1.11.20/resize/virt-resize.pod:452
26611 #: ../resize/virt-resize.pod:452
26613 "This is the same as I<--resize> except that it will let you decrease the "
26614 "size of any partition. Generally this means you will lose any data which "
26615 "was at the end of the partition you shrink, but you may not care about that "
26616 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
26617 "as a swap partition)."
26621 #: ../libguestfs-1.11.20/resize/virt-resize.pod:458
26622 #: ../resize/virt-resize.pod:458
26623 msgid "See also the I<--ignore> option."
26627 #: ../libguestfs-1.11.20/resize/virt-resize.pod:460
26628 #: ../resize/virt-resize.pod:460
26629 msgid "B<--shrink part>"
26633 #: ../libguestfs-1.11.20/resize/virt-resize.pod:462
26634 #: ../resize/virt-resize.pod:462
26636 "Shrink the named partition until the overall disk image fits in the "
26637 "destination. The named partition B<must> contain a filesystem or PV which "
26638 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
26639 "online tools). Virt-resize will check this and give an error if it has not "
26644 #: ../libguestfs-1.11.20/resize/virt-resize.pod:468
26645 #: ../resize/virt-resize.pod:468
26647 "The amount by which the overall disk must be shrunk (after carrying out all "
26648 "other operations requested by the user) is called the \"deficit\". For "
26649 "example, a straight copy (assume no other operations) from a 5GB disk image "
26650 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
26651 "would give an error unless the user specified a partition to shrink and that "
26652 "partition had more than a gigabyte of free space."
26656 #: ../libguestfs-1.11.20/resize/virt-resize.pod:488
26657 #: ../resize/virt-resize.pod:488
26658 msgid "\"Partition 1 does not end on cylinder boundary.\""
26662 #: ../libguestfs-1.11.20/resize/virt-resize.pod:490
26663 #: ../resize/virt-resize.pod:490
26665 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
26666 "means the partitions will not be aligned to the ancient CHS geometry. "
26667 "However CHS geometry is meaningless for disks manufactured since the early "
26668 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
26669 "cylinders is not required by any modern operating system."
26673 #: ../libguestfs-1.11.20/resize/virt-resize.pod:497
26674 #: ../resize/virt-resize.pod:497
26675 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
26679 #: ../libguestfs-1.11.20/resize/virt-resize.pod:499
26680 #: ../resize/virt-resize.pod:499
26682 "In Windows Vista and later versions, Microsoft switched to using a separate "
26683 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
26684 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
26685 "the boot partition. Doing so seems to break the guest completely. However "
26686 "expanding the second partition (ie. C: drive) should work."
26690 #: ../libguestfs-1.11.20/resize/virt-resize.pod:506
26691 #: ../resize/virt-resize.pod:506
26693 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
26694 "NTFS partitions have been expanded. This is just a safety check and (unless "
26695 "it find errors) is nothing to worry about."
26699 #: ../libguestfs-1.11.20/resize/virt-resize.pod:510
26700 #: ../resize/virt-resize.pod:510
26701 msgid "GUEST BOOT STUCK AT \"GRUB\""
26705 #: ../libguestfs-1.11.20/resize/virt-resize.pod:512
26706 #: ../resize/virt-resize.pod:512
26708 "If a Linux guest does not boot after resizing, and the boot is stuck after "
26709 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
26710 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
26711 "although we think is to do with partition alignment."
26715 #: ../libguestfs-1.11.20/resize/virt-resize.pod:517
26716 #: ../resize/virt-resize.pod:517
26719 " guestfish -i -a newdisk\n"
26720 " ><fs> cat /boot/grub/device.map\n"
26721 " # check the contents of this file are sensible or\n"
26722 " # edit the file if necessary\n"
26723 " ><fs> grub-install / /dev/vda\n"
26729 #: ../libguestfs-1.11.20/resize/virt-resize.pod:524
26730 #: ../resize/virt-resize.pod:524
26732 "For more flexible guest reconfiguration, including if you need to specify "
26733 "other parameters to grub-install, use L<virt-rescue(1)>."
26737 #: ../libguestfs-1.11.20/resize/virt-resize.pod:527
26738 #: ../resize/virt-resize.pod:527
26739 msgid "ALTERNATIVE TOOLS"
26743 #: ../libguestfs-1.11.20/resize/virt-resize.pod:529
26744 #: ../resize/virt-resize.pod:529
26746 "There are several proprietary tools for resizing partitions. We won't "
26747 "mention any here."
26751 #: ../libguestfs-1.11.20/resize/virt-resize.pod:532
26752 #: ../resize/virt-resize.pod:532
26754 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
26755 "operations on disk images. They can resize and move partitions, but I don't "
26756 "think they can do anything with the contents, and they certainly don't "
26761 #: ../libguestfs-1.11.20/resize/virt-resize.pod:537
26762 #: ../resize/virt-resize.pod:537
26764 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
26765 "but at a much lower level. You will probably end up hand-calculating sector "
26766 "offsets, which is something that virt-resize was designed to avoid. If you "
26767 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
26772 #: ../libguestfs-1.11.20/resize/virt-resize.pod:552
26773 #: ../resize/virt-resize.pod:552
26775 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<lvm"
26776 "(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)>, "
26777 "L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, L<fallocate(1)>, "
26778 "L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, L<http://libguestfs.org/>."
26782 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:5
26783 #: ../ruby/examples/guestfs-ruby.pod:5
26784 msgid "guestfs-ruby - How to use libguestfs from Ruby"
26788 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:9
26789 #: ../ruby/examples/guestfs-ruby.pod:9
26792 " require 'guestfs'\n"
26793 " g = Guestfs::Guestfs.new()\n"
26794 " g.add_drive_opts(\"disk.img\",\n"
26795 " :readonly => 1, :format => \"raw\")\n"
26801 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:17
26802 #: ../ruby/examples/guestfs-ruby.pod:17
26804 "This manual page documents how to call libguestfs from the Ruby programming "
26805 "language. This page just documents the differences from the C API and gives "
26806 "some examples. If you are not familiar with using libguestfs, you also need "
26807 "to read L<guestfs(3)>."
26811 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:24
26812 #: ../ruby/examples/guestfs-ruby.pod:24
26814 "Errors from libguestfs functions are mapped into the C<Error> exception. "
26815 "This has a single parameter which is the error message (a string)."
26819 #: ../libguestfs-1.11.20/ruby/examples/guestfs-ruby.pod:38
26820 #: ../ruby/examples/guestfs-ruby.pod:38
26822 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)"
26823 ">, L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<http://"
26824 "libguestfs.org/>."
26828 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1
26829 #: ../src/guestfs-actions.pod:1
26830 msgid "guestfs_add_cdrom"
26834 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3
26835 #: ../src/guestfs-actions.pod:3
26839 " guestfs_add_cdrom (guestfs_h *g,\n"
26840 " const char *filename);\n"
26845 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:17
26846 #: ../src/guestfs-actions.pod:17
26848 "This call checks for the existence of C<filename>. This stops you from "
26849 "specifying other types of drive which are supported by qemu such as C<nbd:> "
26850 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
26855 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:24
26856 #: ../src/guestfs-actions.pod:24
26858 "If you just want to add an ISO file (often you use this as an efficient way "
26859 "to transfer large files into the guest), then you should probably use "
26860 "C<guestfs_add_drive_ro> instead."
26864 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:30
26865 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:140
26866 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:201
26867 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:238
26868 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:252
26869 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:273
26870 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:293
26871 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:307
26872 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:422
26873 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:442
26874 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:456
26875 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:501
26876 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:529
26877 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:547
26878 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:614
26879 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:647
26880 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:661
26881 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:676
26882 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:775
26883 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:793
26884 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:807
26885 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:821
26886 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:858
26887 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1041
26888 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1061
26889 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1079
26890 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1163
26891 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1181
26892 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1200
26893 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1214
26894 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1234
26895 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1304
26896 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1335
26897 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1360
26898 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1402
26899 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1508
26900 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1542
26901 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1757
26902 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1779
26903 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1866
26904 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2341
26905 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2485
26906 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2546
26907 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2581
26908 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3621
26909 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3636
26910 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3661
26911 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3850
26912 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3864
26913 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3877
26914 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3891
26915 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3906
26916 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3942
26917 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4014
26918 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4034
26919 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4051
26920 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4074
26921 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4097
26922 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4132
26923 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4151
26924 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4170
26925 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4205
26926 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4217
26927 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4253
26928 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4269
26929 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4282
26930 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4297
26931 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4314
26932 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4407
26933 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4427
26934 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4440
26935 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4491
26936 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4509
26937 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4527
26938 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4543
26939 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4557
26940 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4571
26941 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4588
26942 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4603
26943 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4623
26944 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4693
26945 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4766
26946 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4797
26947 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4816
26948 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4835
26949 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4847
26950 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4864
26951 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4877
26952 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4892
26953 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4907
26954 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4942
26955 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4975
26956 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5014
26957 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5034
26958 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5048
26959 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5065
26960 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5114
26961 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5160
26962 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5214
26963 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5250
26964 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5285
26965 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5302
26966 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5320
26967 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5460
26968 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5517
26969 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5539
26970 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5557
26971 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5589
26972 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5655
26973 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5672
26974 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5685
26975 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5699
26976 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5988
26977 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6007
26978 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6026
26979 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6040
26980 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6052
26981 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6066
26982 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6078
26983 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6092
26984 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6108
26985 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6129
26986 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6148
26987 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6167
26988 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6197
26989 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6215
26990 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6238
26991 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6256
26992 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6275
26993 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6296
26994 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6315
26995 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6332
26996 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6351
26997 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6379
26998 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6403
26999 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6422
27000 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6446
27001 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6465
27002 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6480
27003 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6499
27004 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6536
27005 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6566
27006 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6599
27007 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6721
27008 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6842
27009 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6854
27010 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6867
27011 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6880
27012 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6902
27013 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6915
27014 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6928
27015 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6941
27016 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6956
27017 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7015
27018 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7032
27019 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7048
27020 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7064
27021 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7081
27022 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7094
27023 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7114
27024 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7150
27025 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7164
27026 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7205
27027 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7218
27028 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7236
27029 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7270
27030 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7306
27031 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7422
27032 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7437
27033 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7451
27034 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7506
27035 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7519
27036 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7564
27037 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7597
27038 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7660
27039 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7680
27040 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7706
27041 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7773
27042 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7792
27043 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7821
27044 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140
27045 #: ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238
27046 #: ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273
27047 #: ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307
27048 #: ../src/guestfs-actions.pod:422 ../src/guestfs-actions.pod:442
27049 #: ../src/guestfs-actions.pod:456 ../src/guestfs-actions.pod:501
27050 #: ../src/guestfs-actions.pod:529 ../src/guestfs-actions.pod:547
27051 #: ../src/guestfs-actions.pod:614 ../src/guestfs-actions.pod:647
27052 #: ../src/guestfs-actions.pod:661 ../src/guestfs-actions.pod:676
27053 #: ../src/guestfs-actions.pod:775 ../src/guestfs-actions.pod:793
27054 #: ../src/guestfs-actions.pod:807 ../src/guestfs-actions.pod:821
27055 #: ../src/guestfs-actions.pod:858 ../src/guestfs-actions.pod:1041
27056 #: ../src/guestfs-actions.pod:1061 ../src/guestfs-actions.pod:1079
27057 #: ../src/guestfs-actions.pod:1163 ../src/guestfs-actions.pod:1181
27058 #: ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1214
27059 #: ../src/guestfs-actions.pod:1234 ../src/guestfs-actions.pod:1304
27060 #: ../src/guestfs-actions.pod:1335 ../src/guestfs-actions.pod:1360
27061 #: ../src/guestfs-actions.pod:1402 ../src/guestfs-actions.pod:1508
27062 #: ../src/guestfs-actions.pod:1542 ../src/guestfs-actions.pod:1757
27063 #: ../src/guestfs-actions.pod:1779 ../src/guestfs-actions.pod:1866
27064 #: ../src/guestfs-actions.pod:2341 ../src/guestfs-actions.pod:2485
27065 #: ../src/guestfs-actions.pod:2546 ../src/guestfs-actions.pod:2581
27066 #: ../src/guestfs-actions.pod:3621 ../src/guestfs-actions.pod:3636
27067 #: ../src/guestfs-actions.pod:3661 ../src/guestfs-actions.pod:3850
27068 #: ../src/guestfs-actions.pod:3864 ../src/guestfs-actions.pod:3877
27069 #: ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:3906
27070 #: ../src/guestfs-actions.pod:3942 ../src/guestfs-actions.pod:4014
27071 #: ../src/guestfs-actions.pod:4034 ../src/guestfs-actions.pod:4051
27072 #: ../src/guestfs-actions.pod:4074 ../src/guestfs-actions.pod:4097
27073 #: ../src/guestfs-actions.pod:4132 ../src/guestfs-actions.pod:4151
27074 #: ../src/guestfs-actions.pod:4170 ../src/guestfs-actions.pod:4205
27075 #: ../src/guestfs-actions.pod:4217 ../src/guestfs-actions.pod:4253
27076 #: ../src/guestfs-actions.pod:4269 ../src/guestfs-actions.pod:4282
27077 #: ../src/guestfs-actions.pod:4297 ../src/guestfs-actions.pod:4314
27078 #: ../src/guestfs-actions.pod:4407 ../src/guestfs-actions.pod:4427
27079 #: ../src/guestfs-actions.pod:4440 ../src/guestfs-actions.pod:4491
27080 #: ../src/guestfs-actions.pod:4509 ../src/guestfs-actions.pod:4527
27081 #: ../src/guestfs-actions.pod:4543 ../src/guestfs-actions.pod:4557
27082 #: ../src/guestfs-actions.pod:4571 ../src/guestfs-actions.pod:4588
27083 #: ../src/guestfs-actions.pod:4603 ../src/guestfs-actions.pod:4623
27084 #: ../src/guestfs-actions.pod:4693 ../src/guestfs-actions.pod:4766
27085 #: ../src/guestfs-actions.pod:4797 ../src/guestfs-actions.pod:4816
27086 #: ../src/guestfs-actions.pod:4835 ../src/guestfs-actions.pod:4847
27087 #: ../src/guestfs-actions.pod:4864 ../src/guestfs-actions.pod:4877
27088 #: ../src/guestfs-actions.pod:4892 ../src/guestfs-actions.pod:4907
27089 #: ../src/guestfs-actions.pod:4942 ../src/guestfs-actions.pod:4975
27090 #: ../src/guestfs-actions.pod:5014 ../src/guestfs-actions.pod:5034
27091 #: ../src/guestfs-actions.pod:5048 ../src/guestfs-actions.pod:5065
27092 #: ../src/guestfs-actions.pod:5114 ../src/guestfs-actions.pod:5160
27093 #: ../src/guestfs-actions.pod:5214 ../src/guestfs-actions.pod:5250
27094 #: ../src/guestfs-actions.pod:5285 ../src/guestfs-actions.pod:5302
27095 #: ../src/guestfs-actions.pod:5320 ../src/guestfs-actions.pod:5460
27096 #: ../src/guestfs-actions.pod:5517 ../src/guestfs-actions.pod:5539
27097 #: ../src/guestfs-actions.pod:5557 ../src/guestfs-actions.pod:5589
27098 #: ../src/guestfs-actions.pod:5655 ../src/guestfs-actions.pod:5672
27099 #: ../src/guestfs-actions.pod:5685 ../src/guestfs-actions.pod:5699
27100 #: ../src/guestfs-actions.pod:5988 ../src/guestfs-actions.pod:6007
27101 #: ../src/guestfs-actions.pod:6026 ../src/guestfs-actions.pod:6040
27102 #: ../src/guestfs-actions.pod:6052 ../src/guestfs-actions.pod:6066
27103 #: ../src/guestfs-actions.pod:6078 ../src/guestfs-actions.pod:6092
27104 #: ../src/guestfs-actions.pod:6108 ../src/guestfs-actions.pod:6129
27105 #: ../src/guestfs-actions.pod:6148 ../src/guestfs-actions.pod:6167
27106 #: ../src/guestfs-actions.pod:6197 ../src/guestfs-actions.pod:6215
27107 #: ../src/guestfs-actions.pod:6238 ../src/guestfs-actions.pod:6256
27108 #: ../src/guestfs-actions.pod:6275 ../src/guestfs-actions.pod:6296
27109 #: ../src/guestfs-actions.pod:6315 ../src/guestfs-actions.pod:6332
27110 #: ../src/guestfs-actions.pod:6351 ../src/guestfs-actions.pod:6379
27111 #: ../src/guestfs-actions.pod:6403 ../src/guestfs-actions.pod:6422
27112 #: ../src/guestfs-actions.pod:6446 ../src/guestfs-actions.pod:6465
27113 #: ../src/guestfs-actions.pod:6480 ../src/guestfs-actions.pod:6499
27114 #: ../src/guestfs-actions.pod:6536 ../src/guestfs-actions.pod:6566
27115 #: ../src/guestfs-actions.pod:6599 ../src/guestfs-actions.pod:6721
27116 #: ../src/guestfs-actions.pod:6842 ../src/guestfs-actions.pod:6854
27117 #: ../src/guestfs-actions.pod:6867 ../src/guestfs-actions.pod:6880
27118 #: ../src/guestfs-actions.pod:6902 ../src/guestfs-actions.pod:6915
27119 #: ../src/guestfs-actions.pod:6928 ../src/guestfs-actions.pod:6941
27120 #: ../src/guestfs-actions.pod:6956 ../src/guestfs-actions.pod:7015
27121 #: ../src/guestfs-actions.pod:7032 ../src/guestfs-actions.pod:7048
27122 #: ../src/guestfs-actions.pod:7064 ../src/guestfs-actions.pod:7081
27123 #: ../src/guestfs-actions.pod:7094 ../src/guestfs-actions.pod:7114
27124 #: ../src/guestfs-actions.pod:7150 ../src/guestfs-actions.pod:7164
27125 #: ../src/guestfs-actions.pod:7205 ../src/guestfs-actions.pod:7218
27126 #: ../src/guestfs-actions.pod:7236 ../src/guestfs-actions.pod:7270
27127 #: ../src/guestfs-actions.pod:7306 ../src/guestfs-actions.pod:7422
27128 #: ../src/guestfs-actions.pod:7437 ../src/guestfs-actions.pod:7451
27129 #: ../src/guestfs-actions.pod:7506 ../src/guestfs-actions.pod:7519
27130 #: ../src/guestfs-actions.pod:7564 ../src/guestfs-actions.pod:7597
27131 #: ../src/guestfs-actions.pod:7660 ../src/guestfs-actions.pod:7680
27132 #: ../src/guestfs-actions.pod:7706 ../src/guestfs-actions.pod:7773
27133 #: ../src/guestfs-actions.pod:7792 ../src/guestfs-actions.pod:7821
27134 msgid "This function returns 0 on success or -1 on error."
27138 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:39
27139 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:142
27140 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1165
27141 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1980
27142 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2078
27143 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2192
27144 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3623
27145 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3643
27146 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4951
27147 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6217
27148 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6334
27149 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6467
27150 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6958
27151 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7083
27152 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7606
27153 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142
27154 #: ../src/guestfs-actions.pod:1165 ../src/guestfs-actions.pod:1980
27155 #: ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2192
27156 #: ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3643
27157 #: ../src/guestfs-actions.pod:4951 ../src/guestfs-actions.pod:6217
27158 #: ../src/guestfs-actions.pod:6334 ../src/guestfs-actions.pod:6467
27159 #: ../src/guestfs-actions.pod:6958 ../src/guestfs-actions.pod:7083
27160 #: ../src/guestfs-actions.pod:7606
27161 msgid "(Added in 0.3)"
27165 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:41
27166 #: ../src/guestfs-actions.pod:41
27167 msgid "guestfs_add_domain"
27171 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:43
27172 #: ../src/guestfs-actions.pod:43
27176 " guestfs_add_domain (guestfs_h *g,\n"
27177 " const char *dom,\n"
27183 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:48
27184 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:151
27185 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:832
27186 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2826
27187 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4642
27188 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4961
27189 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5178
27190 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151
27191 #: ../src/guestfs-actions.pod:832 ../src/guestfs-actions.pod:2826
27192 #: ../src/guestfs-actions.pod:4642 ../src/guestfs-actions.pod:4961
27193 #: ../src/guestfs-actions.pod:5178
27195 "You may supply a list of optional arguments to this call. Use zero or more "
27196 "of the following pairs of parameters, and terminate the list with C<-1> on "
27197 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
27201 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:53
27202 #: ../src/guestfs-actions.pod:53
27205 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
27206 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
27207 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
27208 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
27209 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
27214 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:59
27215 #: ../src/guestfs-actions.pod:59
27217 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
27218 "It works by connecting to libvirt, requesting the domain and domain XML from "
27219 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
27224 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:94
27225 #: ../src/guestfs-actions.pod:94
27227 "The other optional parameters are passed directly through to "
27228 "C<guestfs_add_drive_opts>."
27232 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:97
27233 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:350
27234 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:515
27235 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:693
27236 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:724
27237 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:742
27238 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:761
27239 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1380
27240 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1736
27241 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1939
27242 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2050
27243 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2101
27244 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2156
27245 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2179
27246 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2472
27247 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2944
27248 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2962
27249 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5137
27250 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5357
27251 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5769
27252 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5795
27253 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7191
27254 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7617
27255 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7630
27256 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7643
27257 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350
27258 #: ../src/guestfs-actions.pod:515 ../src/guestfs-actions.pod:693
27259 #: ../src/guestfs-actions.pod:724 ../src/guestfs-actions.pod:742
27260 #: ../src/guestfs-actions.pod:761 ../src/guestfs-actions.pod:1380
27261 #: ../src/guestfs-actions.pod:1736 ../src/guestfs-actions.pod:1939
27262 #: ../src/guestfs-actions.pod:2050 ../src/guestfs-actions.pod:2101
27263 #: ../src/guestfs-actions.pod:2156 ../src/guestfs-actions.pod:2179
27264 #: ../src/guestfs-actions.pod:2472 ../src/guestfs-actions.pod:2944
27265 #: ../src/guestfs-actions.pod:2962 ../src/guestfs-actions.pod:5137
27266 #: ../src/guestfs-actions.pod:5357 ../src/guestfs-actions.pod:5769
27267 #: ../src/guestfs-actions.pod:5795 ../src/guestfs-actions.pod:7191
27268 #: ../src/guestfs-actions.pod:7617 ../src/guestfs-actions.pod:7630
27269 #: ../src/guestfs-actions.pod:7643
27270 msgid "On error this function returns -1."
27274 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:99
27275 #: ../src/guestfs-actions.pod:99
27276 msgid "(Added in 1.7.4)"
27280 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:101
27281 #: ../src/guestfs-actions.pod:101
27282 msgid "guestfs_add_domain_va"
27286 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:103
27287 #: ../src/guestfs-actions.pod:103
27291 " guestfs_add_domain_va (guestfs_h *g,\n"
27292 " const char *dom,\n"
27293 " va_list args);\n"
27298 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:108
27299 #: ../src/guestfs-actions.pod:108
27300 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
27304 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:110
27305 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:121
27306 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:214
27307 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:225
27308 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:871
27309 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:882
27310 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2910
27311 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2922
27312 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4707
27313 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4719
27314 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4989
27315 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5001
27316 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5227
27317 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5238
27318 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121
27319 #: ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225
27320 #: ../src/guestfs-actions.pod:871 ../src/guestfs-actions.pod:882
27321 #: ../src/guestfs-actions.pod:2910 ../src/guestfs-actions.pod:2922
27322 #: ../src/guestfs-actions.pod:4707 ../src/guestfs-actions.pod:4719
27323 #: ../src/guestfs-actions.pod:4989 ../src/guestfs-actions.pod:5001
27324 #: ../src/guestfs-actions.pod:5227 ../src/guestfs-actions.pod:5238
27325 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
27329 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:112
27330 #: ../src/guestfs-actions.pod:112
27331 msgid "guestfs_add_domain_argv"
27335 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:114
27336 #: ../src/guestfs-actions.pod:114
27340 " guestfs_add_domain_argv (guestfs_h *g,\n"
27341 " const char *dom,\n"
27342 " const struct guestfs_add_domain_argv *optargs);\n"
27347 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:119
27348 #: ../src/guestfs-actions.pod:119
27349 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
27353 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:123
27354 #: ../src/guestfs-actions.pod:123
27355 msgid "guestfs_add_drive"
27359 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:125
27360 #: ../src/guestfs-actions.pod:125
27364 " guestfs_add_drive (guestfs_h *g,\n"
27365 " const char *filename);\n"
27370 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:129
27371 #: ../src/guestfs-actions.pod:129
27373 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
27374 "optional parameters, so the disk is added writable, with the format being "
27375 "detected automatically."
27379 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:133
27380 #: ../src/guestfs-actions.pod:133
27382 "Automatic detection of the format opens you up to a potential security hole "
27383 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
27384 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
27385 "you should think about replacing calls to this function with calls to "
27386 "C<guestfs_add_drive_opts>, and specifying the format."
27390 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:144
27391 #: ../src/guestfs-actions.pod:144
27392 msgid "guestfs_add_drive_opts"
27396 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:146
27397 #: ../src/guestfs-actions.pod:146
27401 " guestfs_add_drive_opts (guestfs_h *g,\n"
27402 " const char *filename,\n"
27408 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:156
27409 #: ../src/guestfs-actions.pod:156
27412 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
27413 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
27414 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
27419 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:185
27420 #: ../src/guestfs-actions.pod:185
27422 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
27423 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
27424 "Possible formats include C<raw> and C<qcow2>."
27428 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:196
27429 #: ../src/guestfs-actions.pod:196
27431 "This rarely-used option lets you emulate the behaviour of the deprecated "
27432 "C<guestfs_add_drive_with_if> call (q.v.)"
27436 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:203
27437 #: ../src/guestfs-actions.pod:203
27438 msgid "(Added in 1.5.23)"
27442 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:205
27443 #: ../src/guestfs-actions.pod:205
27444 msgid "guestfs_add_drive_opts_va"
27448 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:207
27449 #: ../src/guestfs-actions.pod:207
27453 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
27454 " const char *filename,\n"
27455 " va_list args);\n"
27460 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:212
27461 #: ../src/guestfs-actions.pod:212
27462 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
27466 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:216
27467 #: ../src/guestfs-actions.pod:216
27468 msgid "guestfs_add_drive_opts_argv"
27472 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:218
27473 #: ../src/guestfs-actions.pod:218
27477 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
27478 " const char *filename,\n"
27479 " const struct guestfs_add_drive_opts_argv *optargs);\n"
27484 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:223
27485 #: ../src/guestfs-actions.pod:223
27486 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
27490 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:227
27491 #: ../src/guestfs-actions.pod:227
27492 msgid "guestfs_add_drive_ro"
27496 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:229
27497 #: ../src/guestfs-actions.pod:229
27501 " guestfs_add_drive_ro (guestfs_h *g,\n"
27502 " const char *filename);\n"
27507 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:233
27508 #: ../src/guestfs-actions.pod:233
27510 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
27511 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
27512 "disk is added read-only, with the format being detected automatically."
27516 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:240
27517 #: ../src/guestfs-actions.pod:240
27518 msgid "(Added in 1.0.38)"
27522 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:242
27523 #: ../src/guestfs-actions.pod:242
27524 msgid "guestfs_add_drive_ro_with_if"
27528 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:244
27529 #: ../src/guestfs-actions.pod:244
27533 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
27534 " const char *filename,\n"
27535 " const char *iface);\n"
27540 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:249
27541 #: ../src/guestfs-actions.pod:249
27543 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
27544 "QEMU interface emulation to use at run time."
27548 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:261
27549 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:282
27550 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2431
27551 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282
27552 #: ../src/guestfs-actions.pod:2431
27553 msgid "(Added in 1.0.84)"
27557 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:263
27558 #: ../src/guestfs-actions.pod:263
27559 msgid "guestfs_add_drive_with_if"
27563 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:265
27564 #: ../src/guestfs-actions.pod:265
27568 " guestfs_add_drive_with_if (guestfs_h *g,\n"
27569 " const char *filename,\n"
27570 " const char *iface);\n"
27575 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:270
27576 #: ../src/guestfs-actions.pod:270
27578 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
27579 "QEMU interface emulation to use at run time."
27583 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:284
27584 #: ../src/guestfs-actions.pod:284
27585 msgid "guestfs_aug_clear"
27589 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:286
27590 #: ../src/guestfs-actions.pod:286
27594 " guestfs_aug_clear (guestfs_h *g,\n"
27595 " const char *augpath);\n"
27600 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:295
27601 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2181
27602 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2181
27603 msgid "(Added in 1.3.4)"
27607 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:297
27608 #: ../src/guestfs-actions.pod:297
27609 msgid "guestfs_aug_close"
27613 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:299
27614 #: ../src/guestfs-actions.pod:299
27618 " guestfs_aug_close (guestfs_h *g);\n"
27623 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:302
27624 #: ../src/guestfs-actions.pod:302
27626 "Close the current Augeas handle and free up any resources used by it. After "
27627 "calling this, you have to call C<guestfs_aug_init> again before you can use "
27628 "any other Augeas functions."
27632 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:309
27633 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:334
27634 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:352
27635 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:366
27636 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:424
27637 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:444
27638 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:458
27639 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:489
27640 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:503
27641 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:517
27642 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:531
27643 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:549
27644 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5846
27645 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334
27646 #: ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366
27647 #: ../src/guestfs-actions.pod:424 ../src/guestfs-actions.pod:444
27648 #: ../src/guestfs-actions.pod:458 ../src/guestfs-actions.pod:489
27649 #: ../src/guestfs-actions.pod:503 ../src/guestfs-actions.pod:517
27650 #: ../src/guestfs-actions.pod:531 ../src/guestfs-actions.pod:549
27651 #: ../src/guestfs-actions.pod:5846
27652 msgid "(Added in 0.7)"
27656 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:311
27657 #: ../src/guestfs-actions.pod:311
27658 msgid "guestfs_aug_defnode"
27662 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:313
27663 #: ../src/guestfs-actions.pod:313
27666 " struct guestfs_int_bool *\n"
27667 " guestfs_aug_defnode (guestfs_h *g,\n"
27668 " const char *name,\n"
27669 " const char *expr,\n"
27670 " const char *val);\n"
27675 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:322
27676 #: ../src/guestfs-actions.pod:322
27678 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
27679 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
27680 "containing that single node."
27684 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:330
27685 #: ../src/guestfs-actions.pod:330
27687 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
27688 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
27692 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:336
27693 #: ../src/guestfs-actions.pod:336
27694 msgid "guestfs_aug_defvar"
27698 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:338
27699 #: ../src/guestfs-actions.pod:338
27703 " guestfs_aug_defvar (guestfs_h *g,\n"
27704 " const char *name,\n"
27705 " const char *expr);\n"
27710 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:354
27711 #: ../src/guestfs-actions.pod:354
27712 msgid "guestfs_aug_get"
27716 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:356
27717 #: ../src/guestfs-actions.pod:356
27721 " guestfs_aug_get (guestfs_h *g,\n"
27722 " const char *augpath);\n"
27727 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:363
27728 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:922
27729 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:940
27730 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1000
27731 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1016
27732 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1119
27733 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1249
27734 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1266
27735 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1285
27736 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1419
27737 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1607
27738 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1719
27739 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1882
27740 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1899
27741 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1966
27742 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2002
27743 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2023
27744 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2204
27745 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2396
27746 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2600
27747 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2690
27748 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2794
27749 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2813
27750 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3027
27751 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3055
27752 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3076
27753 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3110
27754 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3169
27755 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3189
27756 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3209
27757 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3836
27758 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4189
27759 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4359
27760 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4469
27761 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5375
27762 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5574
27763 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5744
27764 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5922
27765 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5971
27766 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6627
27767 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6643
27768 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6660
27769 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6691
27770 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7365
27771 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7384
27772 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7402
27773 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7576
27774 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7878
27775 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:922
27776 #: ../src/guestfs-actions.pod:940 ../src/guestfs-actions.pod:1000
27777 #: ../src/guestfs-actions.pod:1016 ../src/guestfs-actions.pod:1119
27778 #: ../src/guestfs-actions.pod:1249 ../src/guestfs-actions.pod:1266
27779 #: ../src/guestfs-actions.pod:1285 ../src/guestfs-actions.pod:1419
27780 #: ../src/guestfs-actions.pod:1607 ../src/guestfs-actions.pod:1719
27781 #: ../src/guestfs-actions.pod:1882 ../src/guestfs-actions.pod:1899
27782 #: ../src/guestfs-actions.pod:1966 ../src/guestfs-actions.pod:2002
27783 #: ../src/guestfs-actions.pod:2023 ../src/guestfs-actions.pod:2204
27784 #: ../src/guestfs-actions.pod:2396 ../src/guestfs-actions.pod:2600
27785 #: ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2794
27786 #: ../src/guestfs-actions.pod:2813 ../src/guestfs-actions.pod:3027
27787 #: ../src/guestfs-actions.pod:3055 ../src/guestfs-actions.pod:3076
27788 #: ../src/guestfs-actions.pod:3110 ../src/guestfs-actions.pod:3169
27789 #: ../src/guestfs-actions.pod:3189 ../src/guestfs-actions.pod:3209
27790 #: ../src/guestfs-actions.pod:3836 ../src/guestfs-actions.pod:4189
27791 #: ../src/guestfs-actions.pod:4359 ../src/guestfs-actions.pod:4469
27792 #: ../src/guestfs-actions.pod:5375 ../src/guestfs-actions.pod:5574
27793 #: ../src/guestfs-actions.pod:5744 ../src/guestfs-actions.pod:5922
27794 #: ../src/guestfs-actions.pod:5971 ../src/guestfs-actions.pod:6627
27795 #: ../src/guestfs-actions.pod:6643 ../src/guestfs-actions.pod:6660
27796 #: ../src/guestfs-actions.pod:6691 ../src/guestfs-actions.pod:7365
27797 #: ../src/guestfs-actions.pod:7384 ../src/guestfs-actions.pod:7402
27798 #: ../src/guestfs-actions.pod:7576 ../src/guestfs-actions.pod:7878
27800 "This function returns a string, or NULL on error. I<The caller must free "
27801 "the returned string after use>."
27805 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:368
27806 #: ../src/guestfs-actions.pod:368
27807 msgid "guestfs_aug_init"
27811 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:370
27812 #: ../src/guestfs-actions.pod:370
27816 " guestfs_aug_init (guestfs_h *g,\n"
27817 " const char *root,\n"
27823 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:379
27824 #: ../src/guestfs-actions.pod:379
27825 msgid "You must call this before using any other C<guestfs_aug_*> commands."
27829 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:414
27830 #: ../src/guestfs-actions.pod:414
27831 msgid "Do not load the tree in C<guestfs_aug_init>."
27835 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:418
27836 #: ../src/guestfs-actions.pod:418
27837 msgid "To close the handle, you can call C<guestfs_aug_close>."
27841 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:426
27842 #: ../src/guestfs-actions.pod:426
27843 msgid "guestfs_aug_insert"
27847 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:428
27848 #: ../src/guestfs-actions.pod:428
27852 " guestfs_aug_insert (guestfs_h *g,\n"
27853 " const char *augpath,\n"
27854 " const char *label,\n"
27860 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:446
27861 #: ../src/guestfs-actions.pod:446
27862 msgid "guestfs_aug_load"
27866 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:448
27867 #: ../src/guestfs-actions.pod:448
27871 " guestfs_aug_load (guestfs_h *g);\n"
27876 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:460
27877 #: ../src/guestfs-actions.pod:460
27878 msgid "guestfs_aug_ls"
27882 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:462
27883 #: ../src/guestfs-actions.pod:462
27887 " guestfs_aug_ls (guestfs_h *g,\n"
27888 " const char *augpath);\n"
27893 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:466
27894 #: ../src/guestfs-actions.pod:466
27896 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
27897 "sorting the resulting nodes into alphabetical order."
27901 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:469
27902 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:485
27903 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:631
27904 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1138
27905 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1434
27906 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1453
27907 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1556
27908 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1575
27909 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1821
27910 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2276
27911 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2292
27912 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2311
27913 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2354
27914 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2378
27915 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2449
27916 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2498
27917 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2755
27918 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3129
27919 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3405
27920 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3719
27921 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3736
27922 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3756
27923 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3818
27924 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3923
27925 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4331
27926 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5098
27927 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5716
27928 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5842
27929 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5956
27930 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6707
27931 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6768
27932 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6823
27933 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6969
27934 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6993
27935 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7469
27936 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7489
27937 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7536
27938 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7730
27939 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7749
27940 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7835
27941 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7854
27942 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7900
27943 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7919
27944 #: ../src/guestfs-actions.pod:469 ../src/guestfs-actions.pod:485
27945 #: ../src/guestfs-actions.pod:631 ../src/guestfs-actions.pod:1138
27946 #: ../src/guestfs-actions.pod:1434 ../src/guestfs-actions.pod:1453
27947 #: ../src/guestfs-actions.pod:1556 ../src/guestfs-actions.pod:1575
27948 #: ../src/guestfs-actions.pod:1821 ../src/guestfs-actions.pod:2276
27949 #: ../src/guestfs-actions.pod:2292 ../src/guestfs-actions.pod:2311
27950 #: ../src/guestfs-actions.pod:2354 ../src/guestfs-actions.pod:2378
27951 #: ../src/guestfs-actions.pod:2449 ../src/guestfs-actions.pod:2498
27952 #: ../src/guestfs-actions.pod:2755 ../src/guestfs-actions.pod:3129
27953 #: ../src/guestfs-actions.pod:3405 ../src/guestfs-actions.pod:3719
27954 #: ../src/guestfs-actions.pod:3736 ../src/guestfs-actions.pod:3756
27955 #: ../src/guestfs-actions.pod:3818 ../src/guestfs-actions.pod:3923
27956 #: ../src/guestfs-actions.pod:4331 ../src/guestfs-actions.pod:5098
27957 #: ../src/guestfs-actions.pod:5716 ../src/guestfs-actions.pod:5842
27958 #: ../src/guestfs-actions.pod:5956 ../src/guestfs-actions.pod:6707
27959 #: ../src/guestfs-actions.pod:6768 ../src/guestfs-actions.pod:6823
27960 #: ../src/guestfs-actions.pod:6969 ../src/guestfs-actions.pod:6993
27961 #: ../src/guestfs-actions.pod:7469 ../src/guestfs-actions.pod:7489
27962 #: ../src/guestfs-actions.pod:7536 ../src/guestfs-actions.pod:7730
27963 #: ../src/guestfs-actions.pod:7749 ../src/guestfs-actions.pod:7835
27964 #: ../src/guestfs-actions.pod:7854 ../src/guestfs-actions.pod:7900
27965 #: ../src/guestfs-actions.pod:7919
27967 "This function returns a NULL-terminated array of strings (like L<environ(3)"
27968 ">), or NULL if there was an error. I<The caller must free the strings and "
27969 "the array after use>."
27973 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:473
27974 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1063
27975 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1081
27976 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1491
27977 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3483
27978 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3514
27979 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4172
27980 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4222
27981 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4409
27982 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4442
27983 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4605
27984 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5102
27985 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5657
27986 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6054
27987 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6068
27988 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6080
27989 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6548
27990 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7207
27991 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7220
27992 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7453
27993 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7718
27994 #: ../src/guestfs-actions.pod:473 ../src/guestfs-actions.pod:1063
27995 #: ../src/guestfs-actions.pod:1081 ../src/guestfs-actions.pod:1491
27996 #: ../src/guestfs-actions.pod:3483 ../src/guestfs-actions.pod:3514
27997 #: ../src/guestfs-actions.pod:4172 ../src/guestfs-actions.pod:4222
27998 #: ../src/guestfs-actions.pod:4409 ../src/guestfs-actions.pod:4442
27999 #: ../src/guestfs-actions.pod:4605 ../src/guestfs-actions.pod:5102
28000 #: ../src/guestfs-actions.pod:5657 ../src/guestfs-actions.pod:6054
28001 #: ../src/guestfs-actions.pod:6068 ../src/guestfs-actions.pod:6080
28002 #: ../src/guestfs-actions.pod:6548 ../src/guestfs-actions.pod:7207
28003 #: ../src/guestfs-actions.pod:7220 ../src/guestfs-actions.pod:7453
28004 #: ../src/guestfs-actions.pod:7718
28005 msgid "(Added in 0.8)"
28009 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:475
28010 #: ../src/guestfs-actions.pod:475
28011 msgid "guestfs_aug_match"
28015 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:477
28016 #: ../src/guestfs-actions.pod:477
28020 " guestfs_aug_match (guestfs_h *g,\n"
28021 " const char *augpath);\n"
28026 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:491
28027 #: ../src/guestfs-actions.pod:491
28028 msgid "guestfs_aug_mv"
28032 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:493
28033 #: ../src/guestfs-actions.pod:493
28037 " guestfs_aug_mv (guestfs_h *g,\n"
28038 " const char *src,\n"
28039 " const char *dest);\n"
28044 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:505
28045 #: ../src/guestfs-actions.pod:505
28046 msgid "guestfs_aug_rm"
28050 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:507
28051 #: ../src/guestfs-actions.pod:507
28055 " guestfs_aug_rm (guestfs_h *g,\n"
28056 " const char *augpath);\n"
28061 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:519
28062 #: ../src/guestfs-actions.pod:519
28063 msgid "guestfs_aug_save"
28067 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:521
28068 #: ../src/guestfs-actions.pod:521
28072 " guestfs_aug_save (guestfs_h *g);\n"
28077 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:526
28078 #: ../src/guestfs-actions.pod:526
28080 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
28085 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:533
28086 #: ../src/guestfs-actions.pod:533
28087 msgid "guestfs_aug_set"
28091 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:535
28092 #: ../src/guestfs-actions.pod:535
28096 " guestfs_aug_set (guestfs_h *g,\n"
28097 " const char *augpath,\n"
28098 " const char *val);\n"
28103 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:542
28104 #: ../src/guestfs-actions.pod:542
28106 "In the Augeas API, it is possible to clear a node by setting the value to "
28107 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
28108 "this call. Instead you must use the C<guestfs_aug_clear> call."
28112 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:551
28113 #: ../src/guestfs-actions.pod:551
28114 msgid "guestfs_available"
28118 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:553
28119 #: ../src/guestfs-actions.pod:553
28123 " guestfs_available (guestfs_h *g,\n"
28124 " char *const *groups);\n"
28129 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:561
28130 #: ../src/guestfs-actions.pod:561
28132 "The libguestfs groups, and the functions that those groups correspond to, "
28133 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
28134 "runtime by calling C<guestfs_available_all_groups>."
28138 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:585
28139 #: ../src/guestfs-actions.pod:585
28140 msgid "You must call C<guestfs_launch> before calling this function."
28144 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:607
28145 #: ../src/guestfs-actions.pod:607
28147 "This call was added in version C<1.0.80>. In previous versions of "
28148 "libguestfs all you could do would be to speculatively execute a command to "
28149 "find out if the daemon implemented it. See also C<guestfs_version>."
28153 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:616
28154 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1236
28155 #: ../src/guestfs-actions.pod:616 ../src/guestfs-actions.pod:1236
28156 msgid "(Added in 1.0.80)"
28160 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:618
28161 #: ../src/guestfs-actions.pod:618
28162 msgid "guestfs_available_all_groups"
28166 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:620
28167 #: ../src/guestfs-actions.pod:620
28171 " guestfs_available_all_groups (guestfs_h *g);\n"
28176 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:623
28177 #: ../src/guestfs-actions.pod:623
28179 "This command returns a list of all optional groups that this daemon knows "
28180 "about. Note this returns both supported and unsupported groups. To find "
28181 "out which ones the daemon can actually support you have to call "
28182 "C<guestfs_available> on each member of the returned list."
28186 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:629
28187 #: ../src/guestfs-actions.pod:629
28188 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
28192 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:635
28193 #: ../src/guestfs-actions.pod:635
28194 msgid "(Added in 1.3.15)"
28198 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:637
28199 #: ../src/guestfs-actions.pod:637
28200 msgid "guestfs_base64_in"
28204 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:639
28205 #: ../src/guestfs-actions.pod:639
28209 " guestfs_base64_in (guestfs_h *g,\n"
28210 " const char *base64file,\n"
28211 " const char *filename);\n"
28216 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:649
28217 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:663
28218 #: ../src/guestfs-actions.pod:649 ../src/guestfs-actions.pod:663
28219 msgid "(Added in 1.3.5)"
28223 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:651
28224 #: ../src/guestfs-actions.pod:651
28225 msgid "guestfs_base64_out"
28229 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:653
28230 #: ../src/guestfs-actions.pod:653
28234 " guestfs_base64_out (guestfs_h *g,\n"
28235 " const char *filename,\n"
28236 " const char *base64file);\n"
28241 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:665
28242 #: ../src/guestfs-actions.pod:665
28243 msgid "guestfs_blockdev_flushbufs"
28247 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:667
28248 #: ../src/guestfs-actions.pod:667
28252 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
28253 " const char *device);\n"
28258 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:678
28259 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:695
28260 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:710
28261 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:726
28262 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:744
28263 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:763
28264 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:777
28265 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:795
28266 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:809
28267 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:823
28268 #: ../src/guestfs-actions.pod:678 ../src/guestfs-actions.pod:695
28269 #: ../src/guestfs-actions.pod:710 ../src/guestfs-actions.pod:726
28270 #: ../src/guestfs-actions.pod:744 ../src/guestfs-actions.pod:763
28271 #: ../src/guestfs-actions.pod:777 ../src/guestfs-actions.pod:795
28272 #: ../src/guestfs-actions.pod:809 ../src/guestfs-actions.pod:823
28273 msgid "(Added in 0.9.3)"
28277 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:680
28278 #: ../src/guestfs-actions.pod:680
28279 msgid "guestfs_blockdev_getbsz"
28283 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:682
28284 #: ../src/guestfs-actions.pod:682
28288 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
28289 " const char *device);\n"
28294 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:697
28295 #: ../src/guestfs-actions.pod:697
28296 msgid "guestfs_blockdev_getro"
28300 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:699
28301 #: ../src/guestfs-actions.pod:699
28305 " guestfs_blockdev_getro (guestfs_h *g,\n"
28306 " const char *device);\n"
28311 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:708
28312 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1474
28313 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1489
28314 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1978
28315 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1989
28316 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2061
28317 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2087
28318 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2127
28319 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2142
28320 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2167
28321 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2190
28322 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3226
28323 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3242
28324 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3260
28325 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3422
28326 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3436
28327 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3451
28328 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3465
28329 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3481
28330 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3496
28331 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3512
28332 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3526
28333 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3539
28334 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3553
28335 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3568
28336 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3583
28337 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3596
28338 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3610
28339 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5339
28340 #: ../src/guestfs-actions.pod:708 ../src/guestfs-actions.pod:1474
28341 #: ../src/guestfs-actions.pod:1489 ../src/guestfs-actions.pod:1978
28342 #: ../src/guestfs-actions.pod:1989 ../src/guestfs-actions.pod:2061
28343 #: ../src/guestfs-actions.pod:2087 ../src/guestfs-actions.pod:2127
28344 #: ../src/guestfs-actions.pod:2142 ../src/guestfs-actions.pod:2167
28345 #: ../src/guestfs-actions.pod:2190 ../src/guestfs-actions.pod:3226
28346 #: ../src/guestfs-actions.pod:3242 ../src/guestfs-actions.pod:3260
28347 #: ../src/guestfs-actions.pod:3422 ../src/guestfs-actions.pod:3436
28348 #: ../src/guestfs-actions.pod:3451 ../src/guestfs-actions.pod:3465
28349 #: ../src/guestfs-actions.pod:3481 ../src/guestfs-actions.pod:3496
28350 #: ../src/guestfs-actions.pod:3512 ../src/guestfs-actions.pod:3526
28351 #: ../src/guestfs-actions.pod:3539 ../src/guestfs-actions.pod:3553
28352 #: ../src/guestfs-actions.pod:3568 ../src/guestfs-actions.pod:3583
28353 #: ../src/guestfs-actions.pod:3596 ../src/guestfs-actions.pod:3610
28354 #: ../src/guestfs-actions.pod:5339
28355 msgid "This function returns a C truth value on success or -1 on error."
28359 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:712
28360 #: ../src/guestfs-actions.pod:712
28361 msgid "guestfs_blockdev_getsize64"
28365 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:714
28366 #: ../src/guestfs-actions.pod:714
28370 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
28371 " const char *device);\n"
28376 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:720
28377 #: ../src/guestfs-actions.pod:720
28378 msgid "See also C<guestfs_blockdev_getsz>."
28382 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:728
28383 #: ../src/guestfs-actions.pod:728
28384 msgid "guestfs_blockdev_getss"
28388 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:730
28389 #: ../src/guestfs-actions.pod:730
28393 " guestfs_blockdev_getss (guestfs_h *g,\n"
28394 " const char *device);\n"
28399 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:737
28400 #: ../src/guestfs-actions.pod:737
28402 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
28407 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:746
28408 #: ../src/guestfs-actions.pod:746
28409 msgid "guestfs_blockdev_getsz"
28413 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:748
28414 #: ../src/guestfs-actions.pod:748
28418 " guestfs_blockdev_getsz (guestfs_h *g,\n"
28419 " const char *device);\n"
28424 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:755
28425 #: ../src/guestfs-actions.pod:755
28427 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
28428 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
28432 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:765
28433 #: ../src/guestfs-actions.pod:765
28434 msgid "guestfs_blockdev_rereadpt"
28438 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:767
28439 #: ../src/guestfs-actions.pod:767
28443 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
28444 " const char *device);\n"
28449 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:779
28450 #: ../src/guestfs-actions.pod:779
28451 msgid "guestfs_blockdev_setbsz"
28455 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:781
28456 #: ../src/guestfs-actions.pod:781
28460 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
28461 " const char *device,\n"
28462 " int blocksize);\n"
28467 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:797
28468 #: ../src/guestfs-actions.pod:797
28469 msgid "guestfs_blockdev_setro"
28473 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:799
28474 #: ../src/guestfs-actions.pod:799
28478 " guestfs_blockdev_setro (guestfs_h *g,\n"
28479 " const char *device);\n"
28484 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:811
28485 #: ../src/guestfs-actions.pod:811
28486 msgid "guestfs_blockdev_setrw"
28490 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:813
28491 #: ../src/guestfs-actions.pod:813
28495 " guestfs_blockdev_setrw (guestfs_h *g,\n"
28496 " const char *device);\n"
28501 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:825
28502 #: ../src/guestfs-actions.pod:825
28503 msgid "guestfs_btrfs_filesystem_resize"
28507 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:827
28508 #: ../src/guestfs-actions.pod:827
28512 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
28513 " const char *mountpoint,\n"
28519 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:837
28520 #: ../src/guestfs-actions.pod:837
28523 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
28528 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:860
28529 #: ../src/guestfs-actions.pod:860
28530 msgid "(Added in 1.11.17)"
28534 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:862
28535 #: ../src/guestfs-actions.pod:862
28536 msgid "guestfs_btrfs_filesystem_resize_va"
28540 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:864
28541 #: ../src/guestfs-actions.pod:864
28545 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
28546 " const char *mountpoint,\n"
28547 " va_list args);\n"
28552 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:869
28553 #: ../src/guestfs-actions.pod:869
28554 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
28558 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:873
28559 #: ../src/guestfs-actions.pod:873
28560 msgid "guestfs_btrfs_filesystem_resize_argv"
28564 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:875
28565 #: ../src/guestfs-actions.pod:875
28569 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
28570 " const char *mountpoint,\n"
28571 " const struct guestfs_btrfs_filesystem_resize_argv *optargs);\n"
28576 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:880
28577 #: ../src/guestfs-actions.pod:880
28578 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
28582 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:884
28583 #: ../src/guestfs-actions.pod:884
28584 msgid "guestfs_case_sensitive_path"
28588 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:886
28589 #: ../src/guestfs-actions.pod:886
28593 " guestfs_case_sensitive_path (guestfs_h *g,\n"
28594 " const char *path);\n"
28599 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:912
28600 #: ../src/guestfs-actions.pod:912
28602 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return C<"
28603 "\"/WINDOWS/system32\"> (the exact return value would depend on details of "
28604 "how the directories were originally created under Windows)."
28608 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:920
28609 #: ../src/guestfs-actions.pod:920
28610 msgid "See also C<guestfs_realpath>."
28614 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:925
28615 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7387
28616 #: ../src/guestfs-actions.pod:925 ../src/guestfs-actions.pod:7387
28617 msgid "(Added in 1.0.75)"
28621 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:927
28622 #: ../src/guestfs-actions.pod:927
28623 msgid "guestfs_cat"
28627 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:929
28628 #: ../src/guestfs-actions.pod:929
28632 " guestfs_cat (guestfs_h *g,\n"
28633 " const char *path);\n"
28638 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:935
28639 #: ../src/guestfs-actions.pod:935
28641 "Note that this function cannot correctly handle binary files (specifically, "
28642 "files containing C<\\0> character which is treated as end of string). For "
28643 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
28644 "functions which have a more complex interface."
28648 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:946
28649 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3740
28650 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3822
28651 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3839
28652 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3927
28653 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4335
28654 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4349
28655 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5720
28656 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5734
28657 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7540
28658 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7554
28659 #: ../src/guestfs-actions.pod:946 ../src/guestfs-actions.pod:3740
28660 #: ../src/guestfs-actions.pod:3822 ../src/guestfs-actions.pod:3839
28661 #: ../src/guestfs-actions.pod:3927 ../src/guestfs-actions.pod:4335
28662 #: ../src/guestfs-actions.pod:4349 ../src/guestfs-actions.pod:5720
28663 #: ../src/guestfs-actions.pod:5734 ../src/guestfs-actions.pod:7540
28664 #: ../src/guestfs-actions.pod:7554
28665 msgid "(Added in 0.4)"
28669 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:948
28670 #: ../src/guestfs-actions.pod:948
28671 msgid "guestfs_checksum"
28675 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:950
28676 #: ../src/guestfs-actions.pod:950
28680 " guestfs_checksum (guestfs_h *g,\n"
28681 " const char *csumtype,\n"
28682 " const char *path);\n"
28687 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:996
28688 #: ../src/guestfs-actions.pod:996
28689 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
28693 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:998
28694 #: ../src/guestfs-actions.pod:998
28695 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
28699 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1003
28700 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1311
28701 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2158
28702 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3438
28703 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3467
28704 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3528
28705 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3555
28706 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7243
28707 #: ../src/guestfs-actions.pod:1003 ../src/guestfs-actions.pod:1311
28708 #: ../src/guestfs-actions.pod:2158 ../src/guestfs-actions.pod:3438
28709 #: ../src/guestfs-actions.pod:3467 ../src/guestfs-actions.pod:3528
28710 #: ../src/guestfs-actions.pod:3555 ../src/guestfs-actions.pod:7243
28711 msgid "(Added in 1.0.2)"
28715 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1005
28716 #: ../src/guestfs-actions.pod:1005
28717 msgid "guestfs_checksum_device"
28721 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1007
28722 #: ../src/guestfs-actions.pod:1007
28726 " guestfs_checksum_device (guestfs_h *g,\n"
28727 " const char *csumtype,\n"
28728 " const char *device);\n"
28733 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1012
28734 #: ../src/guestfs-actions.pod:1012
28736 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
28737 "device named C<device>. For the types of checksums supported see the "
28738 "C<guestfs_checksum> command."
28742 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1019
28743 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5169
28744 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5304
28745 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5341
28746 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5359
28747 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5541
28748 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7152
28749 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7166
28750 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7566
28751 #: ../src/guestfs-actions.pod:1019 ../src/guestfs-actions.pod:5169
28752 #: ../src/guestfs-actions.pod:5304 ../src/guestfs-actions.pod:5341
28753 #: ../src/guestfs-actions.pod:5359 ../src/guestfs-actions.pod:5541
28754 #: ../src/guestfs-actions.pod:7152 ../src/guestfs-actions.pod:7166
28755 #: ../src/guestfs-actions.pod:7566
28756 msgid "(Added in 1.3.2)"
28760 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1021
28761 #: ../src/guestfs-actions.pod:1021
28762 msgid "guestfs_checksums_out"
28766 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1023
28767 #: ../src/guestfs-actions.pod:1023
28771 " guestfs_checksums_out (guestfs_h *g,\n"
28772 " const char *csumtype,\n"
28773 " const char *directory,\n"
28774 " const char *sumsfile);\n"
28779 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1043
28780 #: ../src/guestfs-actions.pod:1043
28781 msgid "(Added in 1.3.7)"
28785 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1045
28786 #: ../src/guestfs-actions.pod:1045
28787 msgid "guestfs_chmod"
28791 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1047
28792 #: ../src/guestfs-actions.pod:1047
28796 " guestfs_chmod (guestfs_h *g,\n"
28798 " const char *path);\n"
28803 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1065
28804 #: ../src/guestfs-actions.pod:1065
28805 msgid "guestfs_chown"
28809 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1067
28810 #: ../src/guestfs-actions.pod:1067
28814 " guestfs_chown (guestfs_h *g,\n"
28817 " const char *path);\n"
28822 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1083
28823 #: ../src/guestfs-actions.pod:1083
28824 msgid "guestfs_command"
28828 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1085
28829 #: ../src/guestfs-actions.pod:1085
28833 " guestfs_command (guestfs_h *g,\n"
28834 " char *const *arguments);\n"
28839 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1094
28840 #: ../src/guestfs-actions.pod:1094
28842 "The single parameter is an argv-style list of arguments. The first element "
28843 "is the name of the program to run. Subsequent elements are parameters. The "
28844 "list must be non-empty (ie. must contain a program name). Note that the "
28845 "command runs directly, and is I<not> invoked via the shell (see "
28850 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1125
28851 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1145
28852 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1610
28853 #: ../src/guestfs-actions.pod:1125 ../src/guestfs-actions.pod:1145
28854 #: ../src/guestfs-actions.pod:1610
28855 msgid "(Added in 0.9.1)"
28859 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1127
28860 #: ../src/guestfs-actions.pod:1127
28861 msgid "guestfs_command_lines"
28865 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1129
28866 #: ../src/guestfs-actions.pod:1129
28870 " guestfs_command_lines (guestfs_h *g,\n"
28871 " char *const *arguments);\n"
28876 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1133
28877 #: ../src/guestfs-actions.pod:1133
28879 "This is the same as C<guestfs_command>, but splits the result into a list of "
28884 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1136
28885 #: ../src/guestfs-actions.pod:1136
28886 msgid "See also: C<guestfs_sh_lines>"
28890 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1147
28891 #: ../src/guestfs-actions.pod:1147
28892 msgid "guestfs_config"
28896 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1149
28897 #: ../src/guestfs-actions.pod:1149
28901 " guestfs_config (guestfs_h *g,\n"
28902 " const char *qemuparam,\n"
28903 " const char *qemuvalue);\n"
28908 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1167
28909 #: ../src/guestfs-actions.pod:1167
28910 msgid "guestfs_copy_size"
28914 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1169
28915 #: ../src/guestfs-actions.pod:1169
28919 " guestfs_copy_size (guestfs_h *g,\n"
28920 " const char *src,\n"
28921 " const char *dest,\n"
28922 " int64_t size);\n"
28927 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1183
28928 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1306
28929 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1337
28930 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1382
28931 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1759
28932 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1781
28933 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3638
28934 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7238
28935 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7272
28936 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7775
28937 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7794
28938 #: ../src/guestfs-actions.pod:1183 ../src/guestfs-actions.pod:1306
28939 #: ../src/guestfs-actions.pod:1337 ../src/guestfs-actions.pod:1382
28940 #: ../src/guestfs-actions.pod:1759 ../src/guestfs-actions.pod:1781
28941 #: ../src/guestfs-actions.pod:3638 ../src/guestfs-actions.pod:7238
28942 #: ../src/guestfs-actions.pod:7272 ../src/guestfs-actions.pod:7775
28943 #: ../src/guestfs-actions.pod:7794
28945 "This long-running command can generate progress notification messages so "
28946 "that the caller can display a progress bar or indicator. To receive these "
28947 "messages, the caller must register a progress event callback. See L<guestfs"
28948 "(3)/GUESTFS_EVENT_PROGRESS>."
28952 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1188
28953 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4362
28954 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5747
28955 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7473
28956 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7493
28957 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7579
28958 #: ../src/guestfs-actions.pod:1188 ../src/guestfs-actions.pod:4362
28959 #: ../src/guestfs-actions.pod:5747 ../src/guestfs-actions.pod:7473
28960 #: ../src/guestfs-actions.pod:7493 ../src/guestfs-actions.pod:7579
28961 msgid "(Added in 1.0.87)"
28965 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1190
28966 #: ../src/guestfs-actions.pod:1190
28971 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1192
28972 #: ../src/guestfs-actions.pod:1192
28976 " guestfs_cp (guestfs_h *g,\n"
28977 " const char *src,\n"
28978 " const char *dest);\n"
28983 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1202
28984 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1216
28985 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1288
28986 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1362
28987 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1476
28988 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5116
28989 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5591
28990 #: ../src/guestfs-actions.pod:1202 ../src/guestfs-actions.pod:1216
28991 #: ../src/guestfs-actions.pod:1288 ../src/guestfs-actions.pod:1362
28992 #: ../src/guestfs-actions.pod:1476 ../src/guestfs-actions.pod:5116
28993 #: ../src/guestfs-actions.pod:5591
28994 msgid "(Added in 1.0.18)"
28998 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1204
28999 #: ../src/guestfs-actions.pod:1204
29000 msgid "guestfs_cp_a"
29004 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1206
29005 #: ../src/guestfs-actions.pod:1206
29009 " guestfs_cp_a (guestfs_h *g,\n"
29010 " const char *src,\n"
29011 " const char *dest);\n"
29016 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1218
29017 #: ../src/guestfs-actions.pod:1218
29022 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1220
29023 #: ../src/guestfs-actions.pod:1220
29027 " guestfs_dd (guestfs_h *g,\n"
29028 " const char *src,\n"
29029 " const char *dest);\n"
29034 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1230
29035 #: ../src/guestfs-actions.pod:1230
29037 "If the destination is a device, it must be as large or larger than the "
29038 "source file or device, otherwise the copy will fail. This command cannot do "
29039 "partial copies (see C<guestfs_copy_size>)."
29043 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1238
29044 #: ../src/guestfs-actions.pod:1238
29049 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1240
29050 #: ../src/guestfs-actions.pod:1240
29054 " guestfs_df (guestfs_h *g);\n"
29059 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1245
29060 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1262
29061 #: ../src/guestfs-actions.pod:1245 ../src/guestfs-actions.pod:1262
29063 "This command is mostly useful for interactive sessions. It is I<not> "
29064 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
29069 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1252
29070 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1269
29071 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1387
29072 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2361
29073 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2385
29074 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2453
29075 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4472
29076 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5016
29077 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6976
29078 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7000
29079 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7619
29080 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7632
29081 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7645
29082 #: ../src/guestfs-actions.pod:1252 ../src/guestfs-actions.pod:1269
29083 #: ../src/guestfs-actions.pod:1387 ../src/guestfs-actions.pod:2361
29084 #: ../src/guestfs-actions.pod:2385 ../src/guestfs-actions.pod:2453
29085 #: ../src/guestfs-actions.pod:4472 ../src/guestfs-actions.pod:5016
29086 #: ../src/guestfs-actions.pod:6976 ../src/guestfs-actions.pod:7000
29087 #: ../src/guestfs-actions.pod:7619 ../src/guestfs-actions.pod:7632
29088 #: ../src/guestfs-actions.pod:7645
29089 msgid "(Added in 1.0.54)"
29093 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1254
29094 #: ../src/guestfs-actions.pod:1254
29095 msgid "guestfs_df_h"
29099 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1256
29100 #: ../src/guestfs-actions.pod:1256
29104 " guestfs_df_h (guestfs_h *g);\n"
29109 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1271
29110 #: ../src/guestfs-actions.pod:1271
29111 msgid "guestfs_dmesg"
29115 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1273
29116 #: ../src/guestfs-actions.pod:1273
29120 " guestfs_dmesg (guestfs_h *g);\n"
29125 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1280
29126 #: ../src/guestfs-actions.pod:1280
29128 "Another way to get the same information is to enable verbose messages with "
29129 "C<guestfs_set_verbose> or by setting the environment variable "
29130 "C<LIBGUESTFS_DEBUG=1> before running the program."
29134 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1290
29135 #: ../src/guestfs-actions.pod:1290
29136 msgid "guestfs_download"
29140 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1292
29141 #: ../src/guestfs-actions.pod:1292
29145 " guestfs_download (guestfs_h *g,\n"
29146 " const char *remotefilename,\n"
29147 " const char *filename);\n"
29152 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1302
29153 #: ../src/guestfs-actions.pod:1302
29154 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
29158 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1313
29159 #: ../src/guestfs-actions.pod:1313
29160 msgid "guestfs_download_offset"
29164 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1315
29165 #: ../src/guestfs-actions.pod:1315
29169 " guestfs_download_offset (guestfs_h *g,\n"
29170 " const char *remotefilename,\n"
29171 " const char *filename,\n"
29172 " int64_t offset,\n"
29173 " int64_t size);\n"
29178 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1328
29179 #: ../src/guestfs-actions.pod:1328
29181 "Note that there is no limit on the amount of data that can be downloaded "
29182 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
29183 "full amount unless an error occurs."
29187 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1333
29188 #: ../src/guestfs-actions.pod:1333
29189 msgid "See also C<guestfs_download>, C<guestfs_pread>."
29193 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1342
29194 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7277
29195 #: ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:7277
29196 msgid "(Added in 1.5.17)"
29200 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1344
29201 #: ../src/guestfs-actions.pod:1344
29202 msgid "guestfs_drop_caches"
29206 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1346
29207 #: ../src/guestfs-actions.pod:1346
29211 " guestfs_drop_caches (guestfs_h *g,\n"
29212 " int whattodrop);\n"
29217 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1364
29218 #: ../src/guestfs-actions.pod:1364
29223 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1366
29224 #: ../src/guestfs-actions.pod:1366
29228 " guestfs_du (guestfs_h *g,\n"
29229 " const char *path);\n"
29234 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1389
29235 #: ../src/guestfs-actions.pod:1389
29236 msgid "guestfs_e2fsck_f"
29240 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1391
29241 #: ../src/guestfs-actions.pod:1391
29245 " guestfs_e2fsck_f (guestfs_h *g,\n"
29246 " const char *device);\n"
29251 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1399
29252 #: ../src/guestfs-actions.pod:1399
29254 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
29255 "Normally you should use C<guestfs_fsck>."
29259 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1404
29260 #: ../src/guestfs-actions.pod:1404
29261 msgid "(Added in 1.0.29)"
29265 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1406
29266 #: ../src/guestfs-actions.pod:1406
29267 msgid "guestfs_echo_daemon"
29271 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1408
29272 #: ../src/guestfs-actions.pod:1408
29276 " guestfs_echo_daemon (guestfs_h *g,\n"
29277 " char *const *words);\n"
29282 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1417
29283 #: ../src/guestfs-actions.pod:1417
29284 msgid "See also C<guestfs_ping_daemon>."
29288 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1422
29289 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2169
29290 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6448
29291 #: ../src/guestfs-actions.pod:1422 ../src/guestfs-actions.pod:2169
29292 #: ../src/guestfs-actions.pod:6448
29293 msgid "(Added in 1.0.69)"
29297 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1424
29298 #: ../src/guestfs-actions.pod:1424
29299 msgid "guestfs_egrep"
29303 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1426
29304 #: ../src/guestfs-actions.pod:1426
29308 " guestfs_egrep (guestfs_h *g,\n"
29309 " const char *regex,\n"
29310 " const char *path);\n"
29315 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1441
29316 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1460
29317 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1517
29318 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1563
29319 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1582
29320 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2299
29321 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2318
29322 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2474
29323 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2487
29324 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2502
29325 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2548
29326 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2570
29327 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2583
29328 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3852
29329 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3866
29330 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3879
29331 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3893
29332 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4894
29333 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5925
29334 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5974
29335 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6844
29336 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6856
29337 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6869
29338 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6882
29339 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6904
29340 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6917
29341 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6930
29342 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6943
29343 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7737
29344 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7756
29345 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7842
29346 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7861
29347 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7907
29348 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7926
29349 #: ../src/guestfs-actions.pod:1441 ../src/guestfs-actions.pod:1460
29350 #: ../src/guestfs-actions.pod:1517 ../src/guestfs-actions.pod:1563
29351 #: ../src/guestfs-actions.pod:1582 ../src/guestfs-actions.pod:2299
29352 #: ../src/guestfs-actions.pod:2318 ../src/guestfs-actions.pod:2474
29353 #: ../src/guestfs-actions.pod:2487 ../src/guestfs-actions.pod:2502
29354 #: ../src/guestfs-actions.pod:2548 ../src/guestfs-actions.pod:2570
29355 #: ../src/guestfs-actions.pod:2583 ../src/guestfs-actions.pod:3852
29356 #: ../src/guestfs-actions.pod:3866 ../src/guestfs-actions.pod:3879
29357 #: ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:4894
29358 #: ../src/guestfs-actions.pod:5925 ../src/guestfs-actions.pod:5974
29359 #: ../src/guestfs-actions.pod:6844 ../src/guestfs-actions.pod:6856
29360 #: ../src/guestfs-actions.pod:6869 ../src/guestfs-actions.pod:6882
29361 #: ../src/guestfs-actions.pod:6904 ../src/guestfs-actions.pod:6917
29362 #: ../src/guestfs-actions.pod:6930 ../src/guestfs-actions.pod:6943
29363 #: ../src/guestfs-actions.pod:7737 ../src/guestfs-actions.pod:7756
29364 #: ../src/guestfs-actions.pod:7842 ../src/guestfs-actions.pod:7861
29365 #: ../src/guestfs-actions.pod:7907 ../src/guestfs-actions.pod:7926
29366 msgid "(Added in 1.0.66)"
29370 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1443
29371 #: ../src/guestfs-actions.pod:1443
29372 msgid "guestfs_egrepi"
29376 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1445
29377 #: ../src/guestfs-actions.pod:1445
29381 " guestfs_egrepi (guestfs_h *g,\n"
29382 " const char *regex,\n"
29383 " const char *path);\n"
29388 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1462
29389 #: ../src/guestfs-actions.pod:1462
29390 msgid "guestfs_equal"
29394 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1464
29395 #: ../src/guestfs-actions.pod:1464
29399 " guestfs_equal (guestfs_h *g,\n"
29400 " const char *file1,\n"
29401 " const char *file2);\n"
29406 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1478
29407 #: ../src/guestfs-actions.pod:1478
29408 msgid "guestfs_exists"
29412 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1480
29413 #: ../src/guestfs-actions.pod:1480
29417 " guestfs_exists (guestfs_h *g,\n"
29418 " const char *path);\n"
29423 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1487
29424 #: ../src/guestfs-actions.pod:1487
29425 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
29429 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1493
29430 #: ../src/guestfs-actions.pod:1493
29431 msgid "guestfs_fallocate"
29435 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1495
29436 #: ../src/guestfs-actions.pod:1495
29440 " guestfs_fallocate (guestfs_h *g,\n"
29441 " const char *path,\n"
29447 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1519
29448 #: ../src/guestfs-actions.pod:1519
29449 msgid "guestfs_fallocate64"
29453 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1521
29454 #: ../src/guestfs-actions.pod:1521
29458 " guestfs_fallocate64 (guestfs_h *g,\n"
29459 " const char *path,\n"
29465 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1530
29466 #: ../src/guestfs-actions.pod:1530
29468 "Note that this call allocates disk blocks for the file. To create a sparse "
29469 "file use C<guestfs_truncate_size> instead."
29473 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1533
29474 #: ../src/guestfs-actions.pod:1533
29476 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
29477 "oversight it only allowed 30 bit lengths to be specified, effectively "
29478 "limiting the maximum size of files created through that call to 1GB."
29482 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1544
29483 #: ../src/guestfs-actions.pod:1544
29484 msgid "(Added in 1.3.17)"
29488 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1546
29489 #: ../src/guestfs-actions.pod:1546
29490 msgid "guestfs_fgrep"
29494 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1548
29495 #: ../src/guestfs-actions.pod:1548
29499 " guestfs_fgrep (guestfs_h *g,\n"
29500 " const char *pattern,\n"
29501 " const char *path);\n"
29506 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1565
29507 #: ../src/guestfs-actions.pod:1565
29508 msgid "guestfs_fgrepi"
29512 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1567
29513 #: ../src/guestfs-actions.pod:1567
29517 " guestfs_fgrepi (guestfs_h *g,\n"
29518 " const char *pattern,\n"
29519 " const char *path);\n"
29524 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1584
29525 #: ../src/guestfs-actions.pod:1584
29526 msgid "guestfs_file"
29530 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1586
29531 #: ../src/guestfs-actions.pod:1586
29535 " guestfs_file (guestfs_h *g,\n"
29536 " const char *path);\n"
29541 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1604
29542 #: ../src/guestfs-actions.pod:1604
29544 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
29545 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
29549 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1612
29550 #: ../src/guestfs-actions.pod:1612
29551 msgid "guestfs_file_architecture"
29555 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1614
29556 #: ../src/guestfs-actions.pod:1614
29560 " guestfs_file_architecture (guestfs_h *g,\n"
29561 " const char *filename);\n"
29566 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1722
29567 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1885
29568 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1902
29569 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2603
29570 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2693
29571 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2759
29572 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2946
29573 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2964
29574 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3004
29575 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3079
29576 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3172
29577 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3409
29578 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3541
29579 #: ../src/guestfs-actions.pod:1722 ../src/guestfs-actions.pod:1885
29580 #: ../src/guestfs-actions.pod:1902 ../src/guestfs-actions.pod:2603
29581 #: ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2759
29582 #: ../src/guestfs-actions.pod:2946 ../src/guestfs-actions.pod:2964
29583 #: ../src/guestfs-actions.pod:3004 ../src/guestfs-actions.pod:3079
29584 #: ../src/guestfs-actions.pod:3172 ../src/guestfs-actions.pod:3409
29585 #: ../src/guestfs-actions.pod:3541
29586 msgid "(Added in 1.5.3)"
29590 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1724
29591 #: ../src/guestfs-actions.pod:1724
29592 msgid "guestfs_filesize"
29596 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1726
29597 #: ../src/guestfs-actions.pod:1726
29601 " guestfs_filesize (guestfs_h *g,\n"
29602 " const char *file);\n"
29607 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1732
29608 #: ../src/guestfs-actions.pod:1732
29610 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
29611 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
29612 "devices, use C<guestfs_blockdev_getsize64>."
29616 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1738
29617 #: ../src/guestfs-actions.pod:1738
29618 msgid "(Added in 1.0.82)"
29622 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1740
29623 #: ../src/guestfs-actions.pod:1740
29624 msgid "guestfs_fill"
29628 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1742
29629 #: ../src/guestfs-actions.pod:1742
29633 " guestfs_fill (guestfs_h *g,\n"
29636 " const char *path);\n"
29641 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1752
29642 #: ../src/guestfs-actions.pod:1752
29644 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
29645 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
29646 "bytes use C<guestfs_fill_pattern>."
29650 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1764
29651 #: ../src/guestfs-actions.pod:1764
29652 msgid "(Added in 1.0.79)"
29656 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1766
29657 #: ../src/guestfs-actions.pod:1766
29658 msgid "guestfs_fill_pattern"
29662 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1768
29663 #: ../src/guestfs-actions.pod:1768
29667 " guestfs_fill_pattern (guestfs_h *g,\n"
29668 " const char *pattern,\n"
29670 " const char *path);\n"
29675 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1774
29676 #: ../src/guestfs-actions.pod:1774
29678 "This function is like C<guestfs_fill> except that it creates a new file of "
29679 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
29680 "pattern is truncated if necessary to ensure the length of the file is "
29681 "exactly C<len> bytes."
29685 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1786
29686 #: ../src/guestfs-actions.pod:1786
29687 msgid "(Added in 1.3.12)"
29691 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1788
29692 #: ../src/guestfs-actions.pod:1788
29693 msgid "guestfs_find"
29697 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1790
29698 #: ../src/guestfs-actions.pod:1790
29702 " guestfs_find (guestfs_h *g,\n"
29703 " const char *directory);\n"
29708 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1806
29709 #: ../src/guestfs-actions.pod:1806
29711 "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
29715 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1819
29716 #: ../src/guestfs-actions.pod:1819
29717 msgid "See also C<guestfs_find0>."
29721 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1828
29722 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4299
29723 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6009
29724 #: ../src/guestfs-actions.pod:1828 ../src/guestfs-actions.pod:4299
29725 #: ../src/guestfs-actions.pod:6009
29726 msgid "(Added in 1.0.27)"
29730 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1830
29731 #: ../src/guestfs-actions.pod:1830
29732 msgid "guestfs_find0"
29736 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1832
29737 #: ../src/guestfs-actions.pod:1832
29741 " guestfs_find0 (guestfs_h *g,\n"
29742 " const char *directory,\n"
29743 " const char *files);\n"
29748 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1841
29749 #: ../src/guestfs-actions.pod:1841
29751 "This command works the same way as C<guestfs_find> with the following "
29756 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1868
29757 #: ../src/guestfs-actions.pod:1868
29758 msgid "(Added in 1.0.74)"
29762 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1870
29763 #: ../src/guestfs-actions.pod:1870
29764 msgid "guestfs_findfs_label"
29768 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1872
29769 #: ../src/guestfs-actions.pod:1872
29773 " guestfs_findfs_label (guestfs_h *g,\n"
29774 " const char *label);\n"
29779 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1880
29780 #: ../src/guestfs-actions.pod:1880
29781 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
29785 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1887
29786 #: ../src/guestfs-actions.pod:1887
29787 msgid "guestfs_findfs_uuid"
29791 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1889
29792 #: ../src/guestfs-actions.pod:1889
29796 " guestfs_findfs_uuid (guestfs_h *g,\n"
29797 " const char *uuid);\n"
29802 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1897
29803 #: ../src/guestfs-actions.pod:1897
29804 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
29808 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1904
29809 #: ../src/guestfs-actions.pod:1904
29810 msgid "guestfs_fsck"
29814 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1906
29815 #: ../src/guestfs-actions.pod:1906
29819 " guestfs_fsck (guestfs_h *g,\n"
29820 " const char *fstype,\n"
29821 " const char *device);\n"
29826 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1941
29827 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7780
29828 #: ../src/guestfs-actions.pod:1941 ../src/guestfs-actions.pod:7780
29829 msgid "(Added in 1.0.16)"
29833 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1943
29834 #: ../src/guestfs-actions.pod:1943
29835 msgid "guestfs_get_append"
29839 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1945
29840 #: ../src/guestfs-actions.pod:1945
29844 " guestfs_get_append (guestfs_h *g);\n"
29849 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1953
29850 #: ../src/guestfs-actions.pod:1953
29852 "This function returns a string which may be NULL. There is no way to return "
29853 "an error from this function. The string is owned by the guest handle and "
29854 "must I<not> be freed."
29858 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1957
29859 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5687
29860 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6169
29861 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6611
29862 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6630
29863 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6646
29864 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6670
29865 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7424
29866 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7439
29867 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7823
29868 #: ../src/guestfs-actions.pod:1957 ../src/guestfs-actions.pod:5687
29869 #: ../src/guestfs-actions.pod:6169 ../src/guestfs-actions.pod:6611
29870 #: ../src/guestfs-actions.pod:6630 ../src/guestfs-actions.pod:6646
29871 #: ../src/guestfs-actions.pod:6670 ../src/guestfs-actions.pod:7424
29872 #: ../src/guestfs-actions.pod:7439 ../src/guestfs-actions.pod:7823
29873 msgid "(Added in 1.0.26)"
29877 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1959
29878 #: ../src/guestfs-actions.pod:1959
29879 msgid "guestfs_get_attach_method"
29883 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1961
29884 #: ../src/guestfs-actions.pod:1961
29888 " guestfs_get_attach_method (guestfs_h *g);\n"
29893 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1964
29894 #: ../src/guestfs-actions.pod:1964
29895 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
29899 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1969
29900 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6199
29901 #: ../src/guestfs-actions.pod:1969 ../src/guestfs-actions.pod:6199
29902 msgid "(Added in 1.9.8)"
29906 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1971
29907 #: ../src/guestfs-actions.pod:1971
29908 msgid "guestfs_get_autosync"
29912 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1973
29913 #: ../src/guestfs-actions.pod:1973
29917 " guestfs_get_autosync (guestfs_h *g);\n"
29922 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1982
29923 #: ../src/guestfs-actions.pod:1982
29924 msgid "guestfs_get_direct"
29928 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1984
29929 #: ../src/guestfs-actions.pod:1984
29933 " guestfs_get_direct (guestfs_h *g);\n"
29938 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1991
29939 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6240
29940 #: ../src/guestfs-actions.pod:1991 ../src/guestfs-actions.pod:6240
29941 msgid "(Added in 1.0.72)"
29945 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1993
29946 #: ../src/guestfs-actions.pod:1993
29947 msgid "guestfs_get_e2label"
29951 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:1995
29952 #: ../src/guestfs-actions.pod:1995
29956 " guestfs_get_e2label (guestfs_h *g,\n"
29957 " const char *device);\n"
29962 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2012
29963 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2033
29964 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6258
29965 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6277
29966 #: ../src/guestfs-actions.pod:2012 ../src/guestfs-actions.pod:2033
29967 #: ../src/guestfs-actions.pod:6258 ../src/guestfs-actions.pod:6277
29968 msgid "(Added in 1.0.15)"
29972 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2014
29973 #: ../src/guestfs-actions.pod:2014
29974 msgid "guestfs_get_e2uuid"
29978 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2016
29979 #: ../src/guestfs-actions.pod:2016
29983 " guestfs_get_e2uuid (guestfs_h *g,\n"
29984 " const char *device);\n"
29989 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2035
29990 #: ../src/guestfs-actions.pod:2035
29991 msgid "guestfs_get_memsize"
29995 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2037
29996 #: ../src/guestfs-actions.pod:2037
30000 " guestfs_get_memsize (guestfs_h *g);\n"
30005 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2043
30006 #: ../src/guestfs-actions.pod:2043
30008 "If C<guestfs_set_memsize> was not called on this handle, and if "
30009 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
30010 "value for memsize."
30014 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2052
30015 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4590
30016 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4799
30017 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4818
30018 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4837
30019 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4849
30020 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4866
30021 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4879
30022 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5912
30023 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6298
30024 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6578
30025 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7193
30026 #: ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:4590
30027 #: ../src/guestfs-actions.pod:4799 ../src/guestfs-actions.pod:4818
30028 #: ../src/guestfs-actions.pod:4837 ../src/guestfs-actions.pod:4849
30029 #: ../src/guestfs-actions.pod:4866 ../src/guestfs-actions.pod:4879
30030 #: ../src/guestfs-actions.pod:5912 ../src/guestfs-actions.pod:6298
30031 #: ../src/guestfs-actions.pod:6578 ../src/guestfs-actions.pod:7193
30032 msgid "(Added in 1.0.55)"
30036 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2054
30037 #: ../src/guestfs-actions.pod:2054
30038 msgid "guestfs_get_network"
30042 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2056
30043 #: ../src/guestfs-actions.pod:2056
30047 " guestfs_get_network (guestfs_h *g);\n"
30052 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2063
30053 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6317
30054 #: ../src/guestfs-actions.pod:2063 ../src/guestfs-actions.pod:6317
30055 msgid "(Added in 1.5.4)"
30059 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2065
30060 #: ../src/guestfs-actions.pod:2065
30061 msgid "guestfs_get_path"
30065 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2067
30066 #: ../src/guestfs-actions.pod:2067
30070 " guestfs_get_path (guestfs_h *g);\n"
30075 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2075
30076 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2115
30077 #: ../src/guestfs-actions.pod:2075 ../src/guestfs-actions.pod:2115
30079 "This function returns a string, or NULL on error. The string is owned by "
30080 "the guest handle and must I<not> be freed."
30084 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2080
30085 #: ../src/guestfs-actions.pod:2080
30086 msgid "guestfs_get_pgroup"
30090 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2082
30091 #: ../src/guestfs-actions.pod:2082
30095 " guestfs_get_pgroup (guestfs_h *g);\n"
30100 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2089
30101 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6353
30102 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7685
30103 #: ../src/guestfs-actions.pod:2089 ../src/guestfs-actions.pod:6353
30104 #: ../src/guestfs-actions.pod:7685
30105 msgid "(Added in 1.11.18)"
30109 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2091
30110 #: ../src/guestfs-actions.pod:2091
30111 msgid "guestfs_get_pid"
30115 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2093
30116 #: ../src/guestfs-actions.pod:2093
30120 " guestfs_get_pid (guestfs_h *g);\n"
30125 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2103
30126 #: ../src/guestfs-actions.pod:2103
30127 msgid "(Added in 1.0.56)"
30131 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2105
30132 #: ../src/guestfs-actions.pod:2105
30133 msgid "guestfs_get_qemu"
30137 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2107
30138 #: ../src/guestfs-actions.pod:2107
30142 " guestfs_get_qemu (guestfs_h *g);\n"
30147 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2118
30148 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6381
30149 #: ../src/guestfs-actions.pod:2118 ../src/guestfs-actions.pod:6381
30150 msgid "(Added in 1.0.6)"
30154 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2120
30155 #: ../src/guestfs-actions.pod:2120
30156 msgid "guestfs_get_recovery_proc"
30160 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2122
30161 #: ../src/guestfs-actions.pod:2122
30165 " guestfs_get_recovery_proc (guestfs_h *g);\n"
30170 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2129
30171 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3663
30172 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3994
30173 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4397
30174 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4429
30175 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5617
30176 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5960
30177 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6405
30178 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7096
30179 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7116
30180 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7308
30181 #: ../src/guestfs-actions.pod:2129 ../src/guestfs-actions.pod:3663
30182 #: ../src/guestfs-actions.pod:3994 ../src/guestfs-actions.pod:4397
30183 #: ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:5617
30184 #: ../src/guestfs-actions.pod:5960 ../src/guestfs-actions.pod:6405
30185 #: ../src/guestfs-actions.pod:7096 ../src/guestfs-actions.pod:7116
30186 #: ../src/guestfs-actions.pod:7308
30187 msgid "(Added in 1.0.77)"
30191 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2131
30192 #: ../src/guestfs-actions.pod:2131
30193 msgid "guestfs_get_selinux"
30197 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2133
30198 #: ../src/guestfs-actions.pod:2133
30202 " guestfs_get_selinux (guestfs_h *g);\n"
30207 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2136
30208 #: ../src/guestfs-actions.pod:2136
30210 "This returns the current setting of the selinux flag which is passed to the "
30211 "appliance at boot time. See C<guestfs_set_selinux>."
30215 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2144
30216 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2207
30217 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6424
30218 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6482
30219 #: ../src/guestfs-actions.pod:2144 ../src/guestfs-actions.pod:2207
30220 #: ../src/guestfs-actions.pod:6424 ../src/guestfs-actions.pod:6482
30221 msgid "(Added in 1.0.67)"
30225 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2146
30226 #: ../src/guestfs-actions.pod:2146
30227 msgid "guestfs_get_state"
30231 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2148
30232 #: ../src/guestfs-actions.pod:2148
30236 " guestfs_get_state (guestfs_h *g);\n"
30241 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2160
30242 #: ../src/guestfs-actions.pod:2160
30243 msgid "guestfs_get_trace"
30247 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2162
30248 #: ../src/guestfs-actions.pod:2162
30252 " guestfs_get_trace (guestfs_h *g);\n"
30257 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2171
30258 #: ../src/guestfs-actions.pod:2171
30259 msgid "guestfs_get_umask"
30263 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2173
30264 #: ../src/guestfs-actions.pod:2173
30268 " guestfs_get_umask (guestfs_h *g);\n"
30273 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2176
30274 #: ../src/guestfs-actions.pod:2176
30276 "Return the current umask. By default the umask is C<022> unless it has been "
30277 "set by calling C<guestfs_umask>."
30281 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2183
30282 #: ../src/guestfs-actions.pod:2183
30283 msgid "guestfs_get_verbose"
30287 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2185
30288 #: ../src/guestfs-actions.pod:2185
30292 " guestfs_get_verbose (guestfs_h *g);\n"
30297 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2194
30298 #: ../src/guestfs-actions.pod:2194
30299 msgid "guestfs_getcon"
30303 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2196
30304 #: ../src/guestfs-actions.pod:2196
30308 " guestfs_getcon (guestfs_h *g);\n"
30313 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2201
30314 #: ../src/guestfs-actions.pod:2201
30316 "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
30320 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2209
30321 #: ../src/guestfs-actions.pod:2209
30322 msgid "guestfs_getxattr"
30326 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2211
30327 #: ../src/guestfs-actions.pod:2211
30331 " guestfs_getxattr (guestfs_h *g,\n"
30332 " const char *path,\n"
30333 " const char *name,\n"
30334 " size_t *size_r);\n"
30339 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2217
30340 #: ../src/guestfs-actions.pod:2217
30342 "Get a single extended attribute from file C<path> named C<name>. This call "
30343 "follows symlinks. If you want to lookup an extended attribute for the "
30344 "symlink itself, use C<guestfs_lgetxattr>."
30348 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2221
30349 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3677
30350 #: ../src/guestfs-actions.pod:2221 ../src/guestfs-actions.pod:3677
30352 "Normally it is better to get all extended attributes from a file in one go "
30353 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
30354 "implementations are buggy and do not provide a way to list out attributes. "
30355 "For these filesystems (notably ntfs-3g) you have to know the names of the "
30356 "extended attributes you want in advance and call this function."
30360 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2231
30361 #: ../src/guestfs-actions.pod:2231
30362 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
30366 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2233
30367 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2424
30368 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2894
30369 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3689
30370 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5610
30371 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5636
30372 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5817
30373 #: ../src/guestfs-actions.pod:2233 ../src/guestfs-actions.pod:2424
30374 #: ../src/guestfs-actions.pod:2894 ../src/guestfs-actions.pod:3689
30375 #: ../src/guestfs-actions.pod:5610 ../src/guestfs-actions.pod:5636
30376 #: ../src/guestfs-actions.pod:5817
30378 "This function returns a buffer, or NULL on error. The size of the returned "
30379 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
30384 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2237
30385 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3693
30386 #: ../src/guestfs-actions.pod:2237 ../src/guestfs-actions.pod:3693
30387 msgid "(Added in 1.7.24)"
30391 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2239
30392 #: ../src/guestfs-actions.pod:2239
30393 msgid "guestfs_getxattrs"
30397 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2241
30398 #: ../src/guestfs-actions.pod:2241
30401 " struct guestfs_xattr_list *\n"
30402 " guestfs_getxattrs (guestfs_h *g,\n"
30403 " const char *path);\n"
30408 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2251
30409 #: ../src/guestfs-actions.pod:2251
30410 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
30414 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2253
30415 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3705
30416 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4393
30417 #: ../src/guestfs-actions.pod:2253 ../src/guestfs-actions.pod:3705
30418 #: ../src/guestfs-actions.pod:4393
30420 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
30421 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
30425 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2257
30426 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3709
30427 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3908
30428 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3944
30429 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5990
30430 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6501
30431 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7888
30432 #: ../src/guestfs-actions.pod:2257 ../src/guestfs-actions.pod:3709
30433 #: ../src/guestfs-actions.pod:3908 ../src/guestfs-actions.pod:3944
30434 #: ../src/guestfs-actions.pod:5990 ../src/guestfs-actions.pod:6501
30435 #: ../src/guestfs-actions.pod:7888
30436 msgid "(Added in 1.0.59)"
30440 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2259
30441 #: ../src/guestfs-actions.pod:2259
30442 msgid "guestfs_glob_expand"
30446 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2261
30447 #: ../src/guestfs-actions.pod:2261
30451 " guestfs_glob_expand (guestfs_h *g,\n"
30452 " const char *pattern);\n"
30457 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2280
30458 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6694
30459 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6711
30460 #: ../src/guestfs-actions.pod:2280 ../src/guestfs-actions.pod:6694
30461 #: ../src/guestfs-actions.pod:6711
30462 msgid "(Added in 1.0.50)"
30466 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2282
30467 #: ../src/guestfs-actions.pod:2282
30468 msgid "guestfs_grep"
30472 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2284
30473 #: ../src/guestfs-actions.pod:2284
30477 " guestfs_grep (guestfs_h *g,\n"
30478 " const char *regex,\n"
30479 " const char *path);\n"
30484 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2301
30485 #: ../src/guestfs-actions.pod:2301
30486 msgid "guestfs_grepi"
30490 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2303
30491 #: ../src/guestfs-actions.pod:2303
30495 " guestfs_grepi (guestfs_h *g,\n"
30496 " const char *regex,\n"
30497 " const char *path);\n"
30502 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2320
30503 #: ../src/guestfs-actions.pod:2320
30504 msgid "guestfs_grub_install"
30508 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2322
30509 #: ../src/guestfs-actions.pod:2322
30513 " guestfs_grub_install (guestfs_h *g,\n"
30514 " const char *root,\n"
30515 " const char *device);\n"
30520 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2343
30521 #: ../src/guestfs-actions.pod:2343
30522 msgid "(Added in 1.0.17)"
30526 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2345
30527 #: ../src/guestfs-actions.pod:2345
30528 msgid "guestfs_head"
30532 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2347
30533 #: ../src/guestfs-actions.pod:2347
30537 " guestfs_head (guestfs_h *g,\n"
30538 " const char *path);\n"
30543 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2363
30544 #: ../src/guestfs-actions.pod:2363
30545 msgid "guestfs_head_n"
30549 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2365
30550 #: ../src/guestfs-actions.pod:2365
30554 " guestfs_head_n (guestfs_h *g,\n"
30556 " const char *path);\n"
30561 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2387
30562 #: ../src/guestfs-actions.pod:2387
30563 msgid "guestfs_hexdump"
30567 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2389
30568 #: ../src/guestfs-actions.pod:2389
30572 " guestfs_hexdump (guestfs_h *g,\n"
30573 " const char *path);\n"
30578 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2402
30579 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6775
30580 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6830
30581 #: ../src/guestfs-actions.pod:2402 ../src/guestfs-actions.pod:6775
30582 #: ../src/guestfs-actions.pod:6830
30583 msgid "(Added in 1.0.22)"
30587 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2404
30588 #: ../src/guestfs-actions.pod:2404
30589 msgid "guestfs_initrd_cat"
30593 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2406
30594 #: ../src/guestfs-actions.pod:2406
30598 " guestfs_initrd_cat (guestfs_h *g,\n"
30599 " const char *initrdpath,\n"
30600 " const char *filename,\n"
30601 " size_t *size_r);\n"
30606 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2422
30607 #: ../src/guestfs-actions.pod:2422
30608 msgid "See also C<guestfs_initrd_list>."
30612 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2433
30613 #: ../src/guestfs-actions.pod:2433
30614 msgid "guestfs_initrd_list"
30618 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2435
30619 #: ../src/guestfs-actions.pod:2435
30623 " guestfs_initrd_list (guestfs_h *g,\n"
30624 " const char *path);\n"
30629 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2455
30630 #: ../src/guestfs-actions.pod:2455
30631 msgid "guestfs_inotify_add_watch"
30635 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2457
30636 #: ../src/guestfs-actions.pod:2457
30640 " guestfs_inotify_add_watch (guestfs_h *g,\n"
30641 " const char *path,\n"
30647 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2476
30648 #: ../src/guestfs-actions.pod:2476
30649 msgid "guestfs_inotify_close"
30653 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2478
30654 #: ../src/guestfs-actions.pod:2478
30658 " guestfs_inotify_close (guestfs_h *g);\n"
30663 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2489
30664 #: ../src/guestfs-actions.pod:2489
30665 msgid "guestfs_inotify_files"
30669 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2491
30670 #: ../src/guestfs-actions.pod:2491
30674 " guestfs_inotify_files (guestfs_h *g);\n"
30679 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2494
30680 #: ../src/guestfs-actions.pod:2494
30682 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
30683 "returns a list of pathnames of objects that were touched. The returned "
30684 "pathnames are sorted and deduplicated."
30688 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2504
30689 #: ../src/guestfs-actions.pod:2504
30690 msgid "guestfs_inotify_init"
30694 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2506
30695 #: ../src/guestfs-actions.pod:2506
30699 " guestfs_inotify_init (guestfs_h *g,\n"
30700 " int maxevents);\n"
30705 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2514
30706 #: ../src/guestfs-actions.pod:2514
30708 "C<maxevents> is the maximum number of events which will be queued up between "
30709 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
30710 "passed as C<0>, then the kernel (or previously set) default is used. For "
30711 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
30712 "throws away events, but records the fact that it threw them away by setting "
30713 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
30714 "C<guestfs_inotify_read>)."
30718 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2524
30719 #: ../src/guestfs-actions.pod:2524
30721 "Before any events are generated, you have to add some watches to the "
30722 "internal watch list. See: C<guestfs_inotify_add_watch>, "
30723 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
30727 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2530
30728 #: ../src/guestfs-actions.pod:2530
30730 "Queued up events should be read periodically by calling "
30731 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
30732 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
30733 "often enough then you risk the internal queue overflowing."
30737 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2537
30738 #: ../src/guestfs-actions.pod:2537
30740 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
30741 "This also removes any watches automatically."
30745 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2550
30746 #: ../src/guestfs-actions.pod:2550
30747 msgid "guestfs_inotify_read"
30751 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2552
30752 #: ../src/guestfs-actions.pod:2552
30755 " struct guestfs_inotify_event_list *\n"
30756 " guestfs_inotify_read (guestfs_h *g);\n"
30761 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2566
30762 #: ../src/guestfs-actions.pod:2566
30764 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
30765 "there was an error. I<The caller must call "
30766 "C<guestfs_free_inotify_event_list> after use>."
30770 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2572
30771 #: ../src/guestfs-actions.pod:2572
30772 msgid "guestfs_inotify_rm_watch"
30776 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2574
30777 #: ../src/guestfs-actions.pod:2574
30781 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
30787 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2578
30788 #: ../src/guestfs-actions.pod:2578
30790 "Remove a previously defined inotify watch. See C<guestfs_inotify_add_watch>."
30794 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2585
30795 #: ../src/guestfs-actions.pod:2585
30796 msgid "guestfs_inspect_get_arch"
30800 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2587
30801 #: ../src/guestfs-actions.pod:2587
30805 " guestfs_inspect_get_arch (guestfs_h *g,\n"
30806 " const char *root);\n"
30811 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2591
30812 #: ../src/guestfs-actions.pod:2591
30814 "This returns the architecture of the inspected operating system. The "
30815 "possible return values are listed under C<guestfs_file_architecture>."
30819 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2605
30820 #: ../src/guestfs-actions.pod:2605
30821 msgid "guestfs_inspect_get_distro"
30825 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2607
30826 #: ../src/guestfs-actions.pod:2607
30830 " guestfs_inspect_get_distro (guestfs_h *g,\n"
30831 " const char *root);\n"
30836 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2695
30837 #: ../src/guestfs-actions.pod:2695
30838 msgid "guestfs_inspect_get_drive_mappings"
30842 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2697
30843 #: ../src/guestfs-actions.pod:2697
30847 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
30848 " const char *root);\n"
30853 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2726
30854 #: ../src/guestfs-actions.pod:2726
30856 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
30857 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
30861 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2730
30862 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2998
30863 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3796
30864 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5078
30865 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7132
30866 #: ../src/guestfs-actions.pod:2730 ../src/guestfs-actions.pod:2998
30867 #: ../src/guestfs-actions.pod:3796 ../src/guestfs-actions.pod:5078
30868 #: ../src/guestfs-actions.pod:7132
30870 "This function returns a NULL-terminated array of strings, or NULL if there "
30871 "was an error. The array of strings will always have length C<2n+1>, where "
30872 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
30873 "caller must free the strings and the array after use>."
30877 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2736
30878 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3192
30879 #: ../src/guestfs-actions.pod:2736 ../src/guestfs-actions.pod:3192
30880 msgid "(Added in 1.9.17)"
30884 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2738
30885 #: ../src/guestfs-actions.pod:2738
30886 msgid "guestfs_inspect_get_filesystems"
30890 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2740
30891 #: ../src/guestfs-actions.pod:2740
30895 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
30896 " const char *root);\n"
30901 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2752
30902 #: ../src/guestfs-actions.pod:2752
30904 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
30905 "C<guestfs_inspect_get_mountpoints>."
30909 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2761
30910 #: ../src/guestfs-actions.pod:2761
30911 msgid "guestfs_inspect_get_format"
30915 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2763
30916 #: ../src/guestfs-actions.pod:2763
30920 " guestfs_inspect_get_format (guestfs_h *g,\n"
30921 " const char *root);\n"
30926 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2797
30927 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3228
30928 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3244
30929 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3262
30930 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6028
30931 #: ../src/guestfs-actions.pod:2797 ../src/guestfs-actions.pod:3228
30932 #: ../src/guestfs-actions.pod:3244 ../src/guestfs-actions.pod:3262
30933 #: ../src/guestfs-actions.pod:6028
30934 msgid "(Added in 1.9.4)"
30938 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2799
30939 #: ../src/guestfs-actions.pod:2799
30940 msgid "guestfs_inspect_get_hostname"
30944 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2801
30945 #: ../src/guestfs-actions.pod:2801
30949 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
30950 " const char *root);\n"
30955 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2816
30956 #: ../src/guestfs-actions.pod:2816
30957 msgid "(Added in 1.7.9)"
30961 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2818
30962 #: ../src/guestfs-actions.pod:2818
30963 msgid "guestfs_inspect_get_icon"
30967 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2820
30968 #: ../src/guestfs-actions.pod:2820
30972 " guestfs_inspect_get_icon (guestfs_h *g,\n"
30973 " const char *root,\n"
30974 " size_t *size_r,\n"
30980 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2831
30981 #: ../src/guestfs-actions.pod:2831
30984 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
30985 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
30990 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2898
30991 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3723
30992 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4977
30993 #: ../src/guestfs-actions.pod:2898 ../src/guestfs-actions.pod:3723
30994 #: ../src/guestfs-actions.pod:4977
30995 msgid "(Added in 1.11.12)"
30999 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2900
31000 #: ../src/guestfs-actions.pod:2900
31001 msgid "guestfs_inspect_get_icon_va"
31005 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2902
31006 #: ../src/guestfs-actions.pod:2902
31010 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
31011 " const char *root,\n"
31012 " size_t *size_r,\n"
31013 " va_list args);\n"
31018 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2908
31019 #: ../src/guestfs-actions.pod:2908
31020 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
31024 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2912
31025 #: ../src/guestfs-actions.pod:2912
31026 msgid "guestfs_inspect_get_icon_argv"
31030 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2914
31031 #: ../src/guestfs-actions.pod:2914
31035 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
31036 " const char *root,\n"
31037 " size_t *size_r,\n"
31038 " const struct guestfs_inspect_get_icon_argv *optargs);\n"
31043 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2920
31044 #: ../src/guestfs-actions.pod:2920
31045 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
31049 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2924
31050 #: ../src/guestfs-actions.pod:2924
31051 msgid "guestfs_inspect_get_major_version"
31055 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2926
31056 #: ../src/guestfs-actions.pod:2926
31060 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
31061 " const char *root);\n"
31066 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2948
31067 #: ../src/guestfs-actions.pod:2948
31068 msgid "guestfs_inspect_get_minor_version"
31072 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2950
31073 #: ../src/guestfs-actions.pod:2950
31077 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
31078 " const char *root);\n"
31083 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2959
31084 #: ../src/guestfs-actions.pod:2959
31086 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
31087 "C<guestfs_inspect_get_major_version>."
31091 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2966
31092 #: ../src/guestfs-actions.pod:2966
31093 msgid "guestfs_inspect_get_mountpoints"
31097 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2968
31098 #: ../src/guestfs-actions.pod:2968
31102 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
31103 " const char *root);\n"
31108 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2989
31109 #: ../src/guestfs-actions.pod:2989
31111 "For operating systems like Windows which still use drive letters, this call "
31112 "will only return an entry for the first drive \"mounted on\" C</>. For "
31113 "information about the mapping of drive letters to partitions, see "
31114 "C<guestfs_inspect_get_drive_mappings>."
31118 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:2995
31119 #: ../src/guestfs-actions.pod:2995
31121 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
31122 "C<guestfs_inspect_get_filesystems>."
31126 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3006
31127 #: ../src/guestfs-actions.pod:3006
31128 msgid "guestfs_inspect_get_package_format"
31132 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3008
31133 #: ../src/guestfs-actions.pod:3008
31137 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
31138 " const char *root);\n"
31143 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3012
31144 #: ../src/guestfs-actions.pod:3012
31146 "This function and C<guestfs_inspect_get_package_management> return the "
31147 "package format and package management tool used by the inspected operating "
31148 "system. For example for Fedora these functions would return C<rpm> (package "
31149 "format) and C<yum> (package management)."
31153 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3030
31154 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3058
31155 #: ../src/guestfs-actions.pod:3030 ../src/guestfs-actions.pod:3058
31156 msgid "(Added in 1.7.5)"
31160 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3032
31161 #: ../src/guestfs-actions.pod:3032
31162 msgid "guestfs_inspect_get_package_management"
31166 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3034
31167 #: ../src/guestfs-actions.pod:3034
31171 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
31172 " const char *root);\n"
31177 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3038
31178 #: ../src/guestfs-actions.pod:3038
31180 "C<guestfs_inspect_get_package_format> and this function return the package "
31181 "format and package management tool used by the inspected operating system. "
31182 "For example for Fedora these functions would return C<rpm> (package format) "
31183 "and C<yum> (package management)."
31187 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3060
31188 #: ../src/guestfs-actions.pod:3060
31189 msgid "guestfs_inspect_get_product_name"
31193 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3062
31194 #: ../src/guestfs-actions.pod:3062
31198 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
31199 " const char *root);\n"
31204 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3081
31205 #: ../src/guestfs-actions.pod:3081
31206 msgid "guestfs_inspect_get_product_variant"
31210 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3083
31211 #: ../src/guestfs-actions.pod:3083
31215 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
31216 " const char *root);\n"
31221 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3106
31222 #: ../src/guestfs-actions.pod:3106
31224 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
31225 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
31229 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3113
31230 #: ../src/guestfs-actions.pod:3113
31231 msgid "(Added in 1.9.13)"
31235 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3115
31236 #: ../src/guestfs-actions.pod:3115
31237 msgid "guestfs_inspect_get_roots"
31241 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3117
31242 #: ../src/guestfs-actions.pod:3117
31246 " guestfs_inspect_get_roots (guestfs_h *g);\n"
31251 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3120
31252 #: ../src/guestfs-actions.pod:3120
31254 "This function is a convenient way to get the list of root devices, as "
31255 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
31256 "the whole inspection process."
31260 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3124
31261 #: ../src/guestfs-actions.pod:3124
31263 "This returns an empty list if either no root devices were found or the "
31264 "caller has not called C<guestfs_inspect_os>."
31268 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3133
31269 #: ../src/guestfs-actions.pod:3133
31270 msgid "(Added in 1.7.3)"
31274 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3135
31275 #: ../src/guestfs-actions.pod:3135
31276 msgid "guestfs_inspect_get_type"
31280 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3137
31281 #: ../src/guestfs-actions.pod:3137
31285 " guestfs_inspect_get_type (guestfs_h *g,\n"
31286 " const char *root);\n"
31291 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3174
31292 #: ../src/guestfs-actions.pod:3174
31293 msgid "guestfs_inspect_get_windows_current_control_set"
31297 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3176
31298 #: ../src/guestfs-actions.pod:3176
31302 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
31303 " const char *root);\n"
31308 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3194
31309 #: ../src/guestfs-actions.pod:3194
31310 msgid "guestfs_inspect_get_windows_systemroot"
31314 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3196
31315 #: ../src/guestfs-actions.pod:3196
31319 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
31320 " const char *root);\n"
31325 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3212
31326 #: ../src/guestfs-actions.pod:3212
31327 msgid "(Added in 1.5.25)"
31331 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3214
31332 #: ../src/guestfs-actions.pod:3214
31333 msgid "guestfs_inspect_is_live"
31337 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3216
31338 #: ../src/guestfs-actions.pod:3216
31342 " guestfs_inspect_is_live (guestfs_h *g,\n"
31343 " const char *root);\n"
31348 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3220
31349 #: ../src/guestfs-actions.pod:3220
31351 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
31352 "disk), then this returns true if a live image was detected on the disk."
31356 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3230
31357 #: ../src/guestfs-actions.pod:3230
31358 msgid "guestfs_inspect_is_multipart"
31362 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3232
31363 #: ../src/guestfs-actions.pod:3232
31367 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
31368 " const char *root);\n"
31373 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3236
31374 #: ../src/guestfs-actions.pod:3236
31376 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
31377 "disk), then this returns true if the disk is part of a set."
31381 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3246
31382 #: ../src/guestfs-actions.pod:3246
31383 msgid "guestfs_inspect_is_netinst"
31387 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3248
31388 #: ../src/guestfs-actions.pod:3248
31392 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
31393 " const char *root);\n"
31398 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3252
31399 #: ../src/guestfs-actions.pod:3252
31401 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
31402 "disk), then this returns true if the disk is a network installer, ie. not a "
31403 "self-contained install CD but one which is likely to require network access "
31404 "to complete the install."
31408 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3264
31409 #: ../src/guestfs-actions.pod:3264
31410 msgid "guestfs_inspect_list_applications"
31414 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3266
31415 #: ../src/guestfs-actions.pod:3266
31418 " struct guestfs_application_list *\n"
31419 " guestfs_inspect_list_applications (guestfs_h *g,\n"
31420 " const char *root);\n"
31425 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3272
31426 #: ../src/guestfs-actions.pod:3272
31428 "I<Note:> This call works differently from other parts of the inspection "
31429 "API. You have to call C<guestfs_inspect_os>, then "
31430 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
31431 "this. Listing applications is a significantly more difficult operation "
31432 "which requires access to the full filesystem. Also note that unlike the "
31433 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
31434 "the libguestfs handle, this call actually reads parts of the mounted "
31435 "filesystems during the call."
31439 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3362
31440 #: ../src/guestfs-actions.pod:3362
31442 "This function returns a C<struct guestfs_application_list *>, or NULL if "
31443 "there was an error. I<The caller must call C<guestfs_free_application_list> "
31448 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3366
31449 #: ../src/guestfs-actions.pod:3366
31450 msgid "(Added in 1.7.8)"
31454 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3368
31455 #: ../src/guestfs-actions.pod:3368
31456 msgid "guestfs_inspect_os"
31460 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3370
31461 #: ../src/guestfs-actions.pod:3370
31465 " guestfs_inspect_os (guestfs_h *g);\n"
31470 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3386
31471 #: ../src/guestfs-actions.pod:3386
31473 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
31474 "functions in order to query further information about each operating system, "
31475 "such as the name and version."
31479 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3391
31480 #: ../src/guestfs-actions.pod:3391
31482 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
31483 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
31484 "the contents. This should be called with no disks currently mounted. The "
31485 "function may also use Augeas, so any existing Augeas handle will be closed."
31489 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3403
31490 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3734
31491 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3816
31492 #: ../src/guestfs-actions.pod:3403 ../src/guestfs-actions.pod:3734
31493 #: ../src/guestfs-actions.pod:3816
31494 msgid "See also C<guestfs_list_filesystems>."
31498 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3411
31499 #: ../src/guestfs-actions.pod:3411
31500 msgid "guestfs_is_blockdev"
31504 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3413
31505 #: ../src/guestfs-actions.pod:3413
31509 " guestfs_is_blockdev (guestfs_h *g,\n"
31510 " const char *path);\n"
31515 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3420
31516 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3449
31517 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3479
31518 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3494
31519 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3510
31520 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3566
31521 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3581
31522 #: ../src/guestfs-actions.pod:3420 ../src/guestfs-actions.pod:3449
31523 #: ../src/guestfs-actions.pod:3479 ../src/guestfs-actions.pod:3494
31524 #: ../src/guestfs-actions.pod:3510 ../src/guestfs-actions.pod:3566
31525 #: ../src/guestfs-actions.pod:3581
31526 msgid "See also C<guestfs_stat>."
31530 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3424
31531 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3453
31532 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3498
31533 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3570
31534 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3585
31535 #: ../src/guestfs-actions.pod:3424 ../src/guestfs-actions.pod:3453
31536 #: ../src/guestfs-actions.pod:3498 ../src/guestfs-actions.pod:3570
31537 #: ../src/guestfs-actions.pod:3585
31538 msgid "(Added in 1.5.10)"
31542 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3426
31543 #: ../src/guestfs-actions.pod:3426
31544 msgid "guestfs_is_busy"
31548 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3428
31549 #: ../src/guestfs-actions.pod:3428
31553 " guestfs_is_busy (guestfs_h *g);\n"
31558 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3440
31559 #: ../src/guestfs-actions.pod:3440
31560 msgid "guestfs_is_chardev"
31564 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3442
31565 #: ../src/guestfs-actions.pod:3442
31569 " guestfs_is_chardev (guestfs_h *g,\n"
31570 " const char *path);\n"
31575 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3455
31576 #: ../src/guestfs-actions.pod:3455
31577 msgid "guestfs_is_config"
31581 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3457
31582 #: ../src/guestfs-actions.pod:3457
31586 " guestfs_is_config (guestfs_h *g);\n"
31591 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3469
31592 #: ../src/guestfs-actions.pod:3469
31593 msgid "guestfs_is_dir"
31597 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3471
31598 #: ../src/guestfs-actions.pod:3471
31602 " guestfs_is_dir (guestfs_h *g,\n"
31603 " const char *path);\n"
31608 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3485
31609 #: ../src/guestfs-actions.pod:3485
31610 msgid "guestfs_is_fifo"
31614 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3487
31615 #: ../src/guestfs-actions.pod:3487
31619 " guestfs_is_fifo (guestfs_h *g,\n"
31620 " const char *path);\n"
31625 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3500
31626 #: ../src/guestfs-actions.pod:3500
31627 msgid "guestfs_is_file"
31631 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3502
31632 #: ../src/guestfs-actions.pod:3502
31636 " guestfs_is_file (guestfs_h *g,\n"
31637 " const char *path);\n"
31642 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3516
31643 #: ../src/guestfs-actions.pod:3516
31644 msgid "guestfs_is_launching"
31648 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3518
31649 #: ../src/guestfs-actions.pod:3518
31653 " guestfs_is_launching (guestfs_h *g);\n"
31658 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3530
31659 #: ../src/guestfs-actions.pod:3530
31660 msgid "guestfs_is_lv"
31664 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3532
31665 #: ../src/guestfs-actions.pod:3532
31669 " guestfs_is_lv (guestfs_h *g,\n"
31670 " const char *device);\n"
31675 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3543
31676 #: ../src/guestfs-actions.pod:3543
31677 msgid "guestfs_is_ready"
31681 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3545
31682 #: ../src/guestfs-actions.pod:3545
31686 " guestfs_is_ready (guestfs_h *g);\n"
31691 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3557
31692 #: ../src/guestfs-actions.pod:3557
31693 msgid "guestfs_is_socket"
31697 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3559
31698 #: ../src/guestfs-actions.pod:3559
31702 " guestfs_is_socket (guestfs_h *g,\n"
31703 " const char *path);\n"
31708 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3572
31709 #: ../src/guestfs-actions.pod:3572
31710 msgid "guestfs_is_symlink"
31714 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3574
31715 #: ../src/guestfs-actions.pod:3574
31719 " guestfs_is_symlink (guestfs_h *g,\n"
31720 " const char *path);\n"
31725 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3587
31726 #: ../src/guestfs-actions.pod:3587
31727 msgid "guestfs_is_zero"
31731 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3589
31732 #: ../src/guestfs-actions.pod:3589
31736 " guestfs_is_zero (guestfs_h *g,\n"
31737 " const char *path);\n"
31742 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3598
31743 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3612
31744 #: ../src/guestfs-actions.pod:3598 ../src/guestfs-actions.pod:3612
31745 msgid "(Added in 1.11.8)"
31749 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3600
31750 #: ../src/guestfs-actions.pod:3600
31751 msgid "guestfs_is_zero_device"
31755 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3602
31756 #: ../src/guestfs-actions.pod:3602
31760 " guestfs_is_zero_device (guestfs_h *g,\n"
31761 " const char *device);\n"
31766 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3614
31767 #: ../src/guestfs-actions.pod:3614
31768 msgid "guestfs_kill_subprocess"
31772 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3616
31773 #: ../src/guestfs-actions.pod:3616
31777 " guestfs_kill_subprocess (guestfs_h *g);\n"
31782 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3625
31783 #: ../src/guestfs-actions.pod:3625
31784 msgid "guestfs_launch"
31788 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3627
31789 #: ../src/guestfs-actions.pod:3627
31793 " guestfs_launch (guestfs_h *g);\n"
31798 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3645
31799 #: ../src/guestfs-actions.pod:3645
31800 msgid "guestfs_lchown"
31804 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3647
31805 #: ../src/guestfs-actions.pod:3647
31809 " guestfs_lchown (guestfs_h *g,\n"
31812 " const char *path);\n"
31817 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3653
31818 #: ../src/guestfs-actions.pod:3653
31820 "Change the file owner to C<owner> and group to C<group>. This is like "
31821 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
31822 "changed, not the target."
31826 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3665
31827 #: ../src/guestfs-actions.pod:3665
31828 msgid "guestfs_lgetxattr"
31832 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3667
31833 #: ../src/guestfs-actions.pod:3667
31837 " guestfs_lgetxattr (guestfs_h *g,\n"
31838 " const char *path,\n"
31839 " const char *name,\n"
31840 " size_t *size_r);\n"
31845 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3687
31846 #: ../src/guestfs-actions.pod:3687
31847 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
31851 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3695
31852 #: ../src/guestfs-actions.pod:3695
31853 msgid "guestfs_lgetxattrs"
31857 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3697
31858 #: ../src/guestfs-actions.pod:3697
31861 " struct guestfs_xattr_list *\n"
31862 " guestfs_lgetxattrs (guestfs_h *g,\n"
31863 " const char *path);\n"
31868 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3701
31869 #: ../src/guestfs-actions.pod:3701
31871 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
31872 "then it returns the extended attributes of the link itself."
31876 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3711
31877 #: ../src/guestfs-actions.pod:3711
31878 msgid "guestfs_list_9p"
31882 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3713
31883 #: ../src/guestfs-actions.pod:3713
31887 " guestfs_list_9p (guestfs_h *g);\n"
31892 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3725
31893 #: ../src/guestfs-actions.pod:3725
31894 msgid "guestfs_list_devices"
31898 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3727
31899 #: ../src/guestfs-actions.pod:3727
31903 " guestfs_list_devices (guestfs_h *g);\n"
31908 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3742
31909 #: ../src/guestfs-actions.pod:3742
31910 msgid "guestfs_list_dm_devices"
31914 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3744
31915 #: ../src/guestfs-actions.pod:3744
31919 " guestfs_list_dm_devices (guestfs_h *g);\n"
31924 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3749
31925 #: ../src/guestfs-actions.pod:3749
31927 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
31928 "previous call to C<guestfs_luks_open>."
31932 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3752
31933 #: ../src/guestfs-actions.pod:3752
31935 "Device mapper devices which correspond to logical volumes are I<not> "
31936 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
31941 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3760
31942 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5216
31943 #: ../src/guestfs-actions.pod:3760 ../src/guestfs-actions.pod:5216
31944 msgid "(Added in 1.11.15)"
31948 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3762
31949 #: ../src/guestfs-actions.pod:3762
31950 msgid "guestfs_list_filesystems"
31954 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3764
31955 #: ../src/guestfs-actions.pod:3764
31959 " guestfs_list_filesystems (guestfs_h *g);\n"
31964 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3784
31965 #: ../src/guestfs-actions.pod:3784
31967 "This command runs other libguestfs commands, which might include "
31968 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
31969 "soon after launch and only when nothing is mounted."
31973 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3788
31974 #: ../src/guestfs-actions.pod:3788
31976 "Not all of the filesystems returned will be mountable. In particular, swap "
31977 "partitions are returned in the list. Also this command does not check that "
31978 "each filesystem found is valid and mountable, and some filesystems might be "
31979 "mountable but require special options. Filesystems may not all belong to a "
31980 "single logical operating system (use C<guestfs_inspect_os> to look for OSes)."
31984 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3802
31985 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5577
31986 #: ../src/guestfs-actions.pod:3802 ../src/guestfs-actions.pod:5577
31987 msgid "(Added in 1.5.15)"
31991 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3804
31992 #: ../src/guestfs-actions.pod:3804
31993 msgid "guestfs_list_partitions"
31997 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3806
31998 #: ../src/guestfs-actions.pod:3806
32002 " guestfs_list_partitions (guestfs_h *g);\n"
32007 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3813
32008 #: ../src/guestfs-actions.pod:3813
32010 "This does not return logical volumes. For that you will need to call "
32015 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3824
32016 #: ../src/guestfs-actions.pod:3824
32021 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3826
32022 #: ../src/guestfs-actions.pod:3826
32026 " guestfs_ll (guestfs_h *g,\n"
32027 " const char *directory);\n"
32032 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3841
32033 #: ../src/guestfs-actions.pod:3841
32038 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3843
32039 #: ../src/guestfs-actions.pod:3843
32043 " guestfs_ln (guestfs_h *g,\n"
32044 " const char *target,\n"
32045 " const char *linkname);\n"
32050 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3854
32051 #: ../src/guestfs-actions.pod:3854
32052 msgid "guestfs_ln_f"
32056 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3856
32057 #: ../src/guestfs-actions.pod:3856
32061 " guestfs_ln_f (guestfs_h *g,\n"
32062 " const char *target,\n"
32063 " const char *linkname);\n"
32068 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3868
32069 #: ../src/guestfs-actions.pod:3868
32070 msgid "guestfs_ln_s"
32074 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3870
32075 #: ../src/guestfs-actions.pod:3870
32079 " guestfs_ln_s (guestfs_h *g,\n"
32080 " const char *target,\n"
32081 " const char *linkname);\n"
32086 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3881
32087 #: ../src/guestfs-actions.pod:3881
32088 msgid "guestfs_ln_sf"
32092 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3883
32093 #: ../src/guestfs-actions.pod:3883
32097 " guestfs_ln_sf (guestfs_h *g,\n"
32098 " const char *target,\n"
32099 " const char *linkname);\n"
32104 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3895
32105 #: ../src/guestfs-actions.pod:3895
32106 msgid "guestfs_lremovexattr"
32110 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3897
32111 #: ../src/guestfs-actions.pod:3897
32115 " guestfs_lremovexattr (guestfs_h *g,\n"
32116 " const char *xattr,\n"
32117 " const char *path);\n"
32122 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3902
32123 #: ../src/guestfs-actions.pod:3902
32125 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
32126 "link, then it removes an extended attribute of the link itself."
32130 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3910
32131 #: ../src/guestfs-actions.pod:3910
32136 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3912
32137 #: ../src/guestfs-actions.pod:3912
32141 " guestfs_ls (guestfs_h *g,\n"
32142 " const char *directory);\n"
32147 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3920
32148 #: ../src/guestfs-actions.pod:3920
32150 "This command is mostly useful for interactive sessions. Programs should "
32151 "probably use C<guestfs_readdir> instead."
32155 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3929
32156 #: ../src/guestfs-actions.pod:3929
32157 msgid "guestfs_lsetxattr"
32161 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3931
32162 #: ../src/guestfs-actions.pod:3931
32166 " guestfs_lsetxattr (guestfs_h *g,\n"
32167 " const char *xattr,\n"
32168 " const char *val,\n"
32170 " const char *path);\n"
32175 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3938
32176 #: ../src/guestfs-actions.pod:3938
32178 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
32179 "then it sets an extended attribute of the link itself."
32183 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3946
32184 #: ../src/guestfs-actions.pod:3946
32185 msgid "guestfs_lstat"
32189 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3948
32190 #: ../src/guestfs-actions.pod:3948
32193 " struct guestfs_stat *\n"
32194 " guestfs_lstat (guestfs_h *g,\n"
32195 " const char *path);\n"
32200 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3954
32201 #: ../src/guestfs-actions.pod:3954
32203 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
32204 "link, then the link is stat-ed, not the file it refers to."
32208 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3960
32209 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6735
32210 #: ../src/guestfs-actions.pod:3960 ../src/guestfs-actions.pod:6735
32212 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
32213 "error. I<The caller must call C<guestfs_free_stat> after use>."
32217 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3964
32218 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6739
32219 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6757
32220 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7138
32221 #: ../src/guestfs-actions.pod:3964 ../src/guestfs-actions.pod:6739
32222 #: ../src/guestfs-actions.pod:6757 ../src/guestfs-actions.pod:7138
32223 msgid "(Added in 0.9.2)"
32227 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3966
32228 #: ../src/guestfs-actions.pod:3966
32229 msgid "guestfs_lstatlist"
32233 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3968
32234 #: ../src/guestfs-actions.pod:3968
32237 " struct guestfs_stat_list *\n"
32238 " guestfs_lstatlist (guestfs_h *g,\n"
32239 " const char *path,\n"
32240 " char *const *names);\n"
32245 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3973
32246 #: ../src/guestfs-actions.pod:3973
32248 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
32249 "files, where all files are in the directory C<path>. C<names> is the list "
32250 "of files from this directory."
32254 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3982
32255 #: ../src/guestfs-actions.pod:3982
32257 "This call is intended for programs that want to efficiently list a directory "
32258 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
32259 "for a similarly efficient call for getting extended attributes. Very long "
32260 "directory listings might cause the protocol message size to be exceeded, "
32261 "causing this call to fail. The caller must split up such requests into "
32262 "smaller groups of names."
32266 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3990
32267 #: ../src/guestfs-actions.pod:3990
32269 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
32270 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
32274 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3996
32275 #: ../src/guestfs-actions.pod:3996
32276 msgid "guestfs_luks_add_key"
32280 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:3998
32281 #: ../src/guestfs-actions.pod:3998
32285 " guestfs_luks_add_key (guestfs_h *g,\n"
32286 " const char *device,\n"
32287 " const char *key,\n"
32288 " const char *newkey,\n"
32294 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4010
32295 #: ../src/guestfs-actions.pod:4010
32297 "Note that if C<keyslot> already contains a key, then this command will "
32298 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
32302 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4016
32303 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4056
32304 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4079
32305 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4099
32306 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4134
32307 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4153
32308 #: ../src/guestfs-actions.pod:4016 ../src/guestfs-actions.pod:4056
32309 #: ../src/guestfs-actions.pod:4079 ../src/guestfs-actions.pod:4099
32310 #: ../src/guestfs-actions.pod:4134 ../src/guestfs-actions.pod:4153
32312 "This function takes a key or passphrase parameter which could contain "
32313 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
32318 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4020
32319 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4060
32320 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4083
32321 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4103
32322 #: ../src/guestfs-actions.pod:4020 ../src/guestfs-actions.pod:4060
32323 #: ../src/guestfs-actions.pod:4083 ../src/guestfs-actions.pod:4103
32324 msgid "(Added in 1.5.2)"
32328 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4022
32329 #: ../src/guestfs-actions.pod:4022
32330 msgid "guestfs_luks_close"
32334 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4024
32335 #: ../src/guestfs-actions.pod:4024
32339 " guestfs_luks_close (guestfs_h *g,\n"
32340 " const char *device);\n"
32345 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4028
32346 #: ../src/guestfs-actions.pod:4028
32348 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
32349 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
32350 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
32351 "underlying block device."
32355 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4036
32356 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4138
32357 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4157
32358 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4207
32359 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4255
32360 #: ../src/guestfs-actions.pod:4036 ../src/guestfs-actions.pod:4138
32361 #: ../src/guestfs-actions.pod:4157 ../src/guestfs-actions.pod:4207
32362 #: ../src/guestfs-actions.pod:4255
32363 msgid "(Added in 1.5.1)"
32367 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4038
32368 #: ../src/guestfs-actions.pod:4038
32369 msgid "guestfs_luks_format"
32373 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4040
32374 #: ../src/guestfs-actions.pod:4040
32378 " guestfs_luks_format (guestfs_h *g,\n"
32379 " const char *device,\n"
32380 " const char *key,\n"
32386 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4062
32387 #: ../src/guestfs-actions.pod:4062
32388 msgid "guestfs_luks_format_cipher"
32392 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4064
32393 #: ../src/guestfs-actions.pod:4064
32397 " guestfs_luks_format_cipher (guestfs_h *g,\n"
32398 " const char *device,\n"
32399 " const char *key,\n"
32401 " const char *cipher);\n"
32406 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4071
32407 #: ../src/guestfs-actions.pod:4071
32409 "This command is the same as C<guestfs_luks_format> but it also allows you to "
32410 "set the C<cipher> used."
32414 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4085
32415 #: ../src/guestfs-actions.pod:4085
32416 msgid "guestfs_luks_kill_slot"
32420 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4087
32421 #: ../src/guestfs-actions.pod:4087
32425 " guestfs_luks_kill_slot (guestfs_h *g,\n"
32426 " const char *device,\n"
32427 " const char *key,\n"
32433 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4105
32434 #: ../src/guestfs-actions.pod:4105
32435 msgid "guestfs_luks_open"
32439 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4107
32440 #: ../src/guestfs-actions.pod:4107
32444 " guestfs_luks_open (guestfs_h *g,\n"
32445 " const char *device,\n"
32446 " const char *key,\n"
32447 " const char *mapname);\n"
32452 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4125
32453 #: ../src/guestfs-actions.pod:4125
32455 "If this block device contains LVM volume groups, then calling "
32456 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
32461 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4129
32462 #: ../src/guestfs-actions.pod:4129
32463 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
32467 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4140
32468 #: ../src/guestfs-actions.pod:4140
32469 msgid "guestfs_luks_open_ro"
32473 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4142
32474 #: ../src/guestfs-actions.pod:4142
32478 " guestfs_luks_open_ro (guestfs_h *g,\n"
32479 " const char *device,\n"
32480 " const char *key,\n"
32481 " const char *mapname);\n"
32486 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4148
32487 #: ../src/guestfs-actions.pod:4148
32489 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
32494 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4159
32495 #: ../src/guestfs-actions.pod:4159
32496 msgid "guestfs_lvcreate"
32500 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4161
32501 #: ../src/guestfs-actions.pod:4161
32505 " guestfs_lvcreate (guestfs_h *g,\n"
32506 " const char *logvol,\n"
32507 " const char *volgroup,\n"
32513 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4174
32514 #: ../src/guestfs-actions.pod:4174
32515 msgid "guestfs_lvm_canonical_lv_name"
32519 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4176
32520 #: ../src/guestfs-actions.pod:4176
32524 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
32525 " const char *lvname);\n"
32530 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4187
32531 #: ../src/guestfs-actions.pod:4187
32532 msgid "See also C<guestfs_is_lv>."
32536 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4192
32537 #: ../src/guestfs-actions.pod:4192
32538 msgid "(Added in 1.5.24)"
32542 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4194
32543 #: ../src/guestfs-actions.pod:4194
32544 msgid "guestfs_lvm_clear_filter"
32548 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4196
32549 #: ../src/guestfs-actions.pod:4196
32553 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
32558 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4199
32559 #: ../src/guestfs-actions.pod:4199
32561 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
32562 "see every block device."
32566 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4209
32567 #: ../src/guestfs-actions.pod:4209
32568 msgid "guestfs_lvm_remove_all"
32572 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4211
32573 #: ../src/guestfs-actions.pod:4211
32577 " guestfs_lvm_remove_all (guestfs_h *g);\n"
32582 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4224
32583 #: ../src/guestfs-actions.pod:4224
32584 msgid "guestfs_lvm_set_filter"
32588 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4226
32589 #: ../src/guestfs-actions.pod:4226
32593 " guestfs_lvm_set_filter (guestfs_h *g,\n"
32594 " char *const *devices);\n"
32599 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4257
32600 #: ../src/guestfs-actions.pod:4257
32601 msgid "guestfs_lvremove"
32605 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4259
32606 #: ../src/guestfs-actions.pod:4259
32610 " guestfs_lvremove (guestfs_h *g,\n"
32611 " const char *device);\n"
32616 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4271
32617 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5674
32618 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7508
32619 #: ../src/guestfs-actions.pod:4271 ../src/guestfs-actions.pod:5674
32620 #: ../src/guestfs-actions.pod:7508
32621 msgid "(Added in 1.0.13)"
32625 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4273
32626 #: ../src/guestfs-actions.pod:4273
32627 msgid "guestfs_lvrename"
32631 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4275
32632 #: ../src/guestfs-actions.pod:4275
32636 " guestfs_lvrename (guestfs_h *g,\n"
32637 " const char *logvol,\n"
32638 " const char *newlogvol);\n"
32643 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4284
32644 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7521
32645 #: ../src/guestfs-actions.pod:4284 ../src/guestfs-actions.pod:7521
32646 msgid "(Added in 1.0.83)"
32650 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4286
32651 #: ../src/guestfs-actions.pod:4286
32652 msgid "guestfs_lvresize"
32656 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4288
32657 #: ../src/guestfs-actions.pod:4288
32661 " guestfs_lvresize (guestfs_h *g,\n"
32662 " const char *device,\n"
32668 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4301
32669 #: ../src/guestfs-actions.pod:4301
32670 msgid "guestfs_lvresize_free"
32674 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4303
32675 #: ../src/guestfs-actions.pod:4303
32679 " guestfs_lvresize_free (guestfs_h *g,\n"
32680 " const char *lv,\n"
32686 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4316
32687 #: ../src/guestfs-actions.pod:4316
32688 msgid "(Added in 1.3.3)"
32692 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4318
32693 #: ../src/guestfs-actions.pod:4318
32694 msgid "guestfs_lvs"
32698 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4320
32699 #: ../src/guestfs-actions.pod:4320
32703 " guestfs_lvs (guestfs_h *g);\n"
32708 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4329
32709 #: ../src/guestfs-actions.pod:4329
32710 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
32714 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4337
32715 #: ../src/guestfs-actions.pod:4337
32716 msgid "guestfs_lvs_full"
32720 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4339
32721 #: ../src/guestfs-actions.pod:4339
32724 " struct guestfs_lvm_lv_list *\n"
32725 " guestfs_lvs_full (guestfs_h *g);\n"
32730 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4345
32731 #: ../src/guestfs-actions.pod:4345
32733 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
32734 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after use>."
32738 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4351
32739 #: ../src/guestfs-actions.pod:4351
32740 msgid "guestfs_lvuuid"
32744 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4353
32745 #: ../src/guestfs-actions.pod:4353
32749 " guestfs_lvuuid (guestfs_h *g,\n"
32750 " const char *device);\n"
32755 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4364
32756 #: ../src/guestfs-actions.pod:4364
32757 msgid "guestfs_lxattrlist"
32761 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4366
32762 #: ../src/guestfs-actions.pod:4366
32765 " struct guestfs_xattr_list *\n"
32766 " guestfs_lxattrlist (guestfs_h *g,\n"
32767 " const char *path,\n"
32768 " char *const *names);\n"
32773 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4385
32774 #: ../src/guestfs-actions.pod:4385
32776 "This call is intended for programs that want to efficiently list a directory "
32777 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
32778 "a similarly efficient call for getting standard stats. Very long directory "
32779 "listings might cause the protocol message size to be exceeded, causing this "
32780 "call to fail. The caller must split up such requests into smaller groups of "
32785 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4399
32786 #: ../src/guestfs-actions.pod:4399
32787 msgid "guestfs_mkdir"
32791 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4401
32792 #: ../src/guestfs-actions.pod:4401
32796 " guestfs_mkdir (guestfs_h *g,\n"
32797 " const char *path);\n"
32802 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4411
32803 #: ../src/guestfs-actions.pod:4411
32804 msgid "guestfs_mkdir_mode"
32808 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4413
32809 #: ../src/guestfs-actions.pod:4413
32813 " guestfs_mkdir_mode (guestfs_h *g,\n"
32814 " const char *path,\n"
32820 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4425
32821 #: ../src/guestfs-actions.pod:4425
32822 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
32826 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4431
32827 #: ../src/guestfs-actions.pod:4431
32828 msgid "guestfs_mkdir_p"
32832 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4433
32833 #: ../src/guestfs-actions.pod:4433
32837 " guestfs_mkdir_p (guestfs_h *g,\n"
32838 " const char *path);\n"
32843 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4444
32844 #: ../src/guestfs-actions.pod:4444
32845 msgid "guestfs_mkdtemp"
32849 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4446
32850 #: ../src/guestfs-actions.pod:4446
32854 " guestfs_mkdtemp (guestfs_h *g,\n"
32855 " const char *template);\n"
32860 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4474
32861 #: ../src/guestfs-actions.pod:4474
32862 msgid "guestfs_mke2fs_J"
32866 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4476
32867 #: ../src/guestfs-actions.pod:4476
32871 " guestfs_mke2fs_J (guestfs_h *g,\n"
32872 " const char *fstype,\n"
32873 " int blocksize,\n"
32874 " const char *device,\n"
32875 " const char *journal);\n"
32880 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4489
32881 #: ../src/guestfs-actions.pod:4489
32882 msgid "See also C<guestfs_mke2journal>."
32886 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4493
32887 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4511
32888 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4529
32889 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4545
32890 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4559
32891 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4573
32892 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4632
32893 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4909
32894 #: ../src/guestfs-actions.pod:4493 ../src/guestfs-actions.pod:4511
32895 #: ../src/guestfs-actions.pod:4529 ../src/guestfs-actions.pod:4545
32896 #: ../src/guestfs-actions.pod:4559 ../src/guestfs-actions.pod:4573
32897 #: ../src/guestfs-actions.pod:4632 ../src/guestfs-actions.pod:4909
32898 msgid "(Added in 1.0.68)"
32902 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4495
32903 #: ../src/guestfs-actions.pod:4495
32904 msgid "guestfs_mke2fs_JL"
32908 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4497
32909 #: ../src/guestfs-actions.pod:4497
32913 " guestfs_mke2fs_JL (guestfs_h *g,\n"
32914 " const char *fstype,\n"
32915 " int blocksize,\n"
32916 " const char *device,\n"
32917 " const char *label);\n"
32922 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4507
32923 #: ../src/guestfs-actions.pod:4507
32924 msgid "See also C<guestfs_mke2journal_L>."
32928 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4513
32929 #: ../src/guestfs-actions.pod:4513
32930 msgid "guestfs_mke2fs_JU"
32934 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4515
32935 #: ../src/guestfs-actions.pod:4515
32939 " guestfs_mke2fs_JU (guestfs_h *g,\n"
32940 " const char *fstype,\n"
32941 " int blocksize,\n"
32942 " const char *device,\n"
32943 " const char *uuid);\n"
32948 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4525
32949 #: ../src/guestfs-actions.pod:4525
32950 msgid "See also C<guestfs_mke2journal_U>."
32954 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4531
32955 #: ../src/guestfs-actions.pod:4531
32956 msgid "guestfs_mke2journal"
32960 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4533
32961 #: ../src/guestfs-actions.pod:4533
32965 " guestfs_mke2journal (guestfs_h *g,\n"
32966 " int blocksize,\n"
32967 " const char *device);\n"
32972 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4547
32973 #: ../src/guestfs-actions.pod:4547
32974 msgid "guestfs_mke2journal_L"
32978 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4549
32979 #: ../src/guestfs-actions.pod:4549
32983 " guestfs_mke2journal_L (guestfs_h *g,\n"
32984 " int blocksize,\n"
32985 " const char *label,\n"
32986 " const char *device);\n"
32991 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4561
32992 #: ../src/guestfs-actions.pod:4561
32993 msgid "guestfs_mke2journal_U"
32997 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4563
32998 #: ../src/guestfs-actions.pod:4563
33002 " guestfs_mke2journal_U (guestfs_h *g,\n"
33003 " int blocksize,\n"
33004 " const char *uuid,\n"
33005 " const char *device);\n"
33010 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4575
33011 #: ../src/guestfs-actions.pod:4575
33012 msgid "guestfs_mkfifo"
33016 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4577
33017 #: ../src/guestfs-actions.pod:4577
33021 " guestfs_mkfifo (guestfs_h *g,\n"
33023 " const char *path);\n"
33028 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4582
33029 #: ../src/guestfs-actions.pod:4582
33031 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
33032 "is just a convenient wrapper around C<guestfs_mknod>."
33036 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4592
33037 #: ../src/guestfs-actions.pod:4592
33038 msgid "guestfs_mkfs"
33042 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4594
33043 #: ../src/guestfs-actions.pod:4594
33047 " guestfs_mkfs (guestfs_h *g,\n"
33048 " const char *fstype,\n"
33049 " const char *device);\n"
33054 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4607
33055 #: ../src/guestfs-actions.pod:4607
33056 msgid "guestfs_mkfs_b"
33060 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4609
33061 #: ../src/guestfs-actions.pod:4609
33065 " guestfs_mkfs_b (guestfs_h *g,\n"
33066 " const char *fstype,\n"
33067 " int blocksize,\n"
33068 " const char *device);\n"
33073 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4615
33074 #: ../src/guestfs-actions.pod:4615
33076 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
33077 "block size of the resulting filesystem. Supported block sizes depend on the "
33078 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
33082 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4634
33083 #: ../src/guestfs-actions.pod:4634
33084 msgid "guestfs_mkfs_opts"
33088 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4636
33089 #: ../src/guestfs-actions.pod:4636
33093 " guestfs_mkfs_opts (guestfs_h *g,\n"
33094 " const char *fstype,\n"
33095 " const char *device,\n"
33101 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4647
33102 #: ../src/guestfs-actions.pod:4647
33105 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
33106 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
33107 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
33108 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
33113 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4695
33114 #: ../src/guestfs-actions.pod:4695
33115 msgid "(Added in 1.7.19)"
33119 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4697
33120 #: ../src/guestfs-actions.pod:4697
33121 msgid "guestfs_mkfs_opts_va"
33125 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4699
33126 #: ../src/guestfs-actions.pod:4699
33130 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
33131 " const char *fstype,\n"
33132 " const char *device,\n"
33133 " va_list args);\n"
33138 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4705
33139 #: ../src/guestfs-actions.pod:4705
33140 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
33144 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4709
33145 #: ../src/guestfs-actions.pod:4709
33146 msgid "guestfs_mkfs_opts_argv"
33150 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4711
33151 #: ../src/guestfs-actions.pod:4711
33155 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
33156 " const char *fstype,\n"
33157 " const char *device,\n"
33158 " const struct guestfs_mkfs_opts_argv *optargs);\n"
33163 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4717
33164 #: ../src/guestfs-actions.pod:4717
33165 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
33169 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4721
33170 #: ../src/guestfs-actions.pod:4721
33171 msgid "guestfs_mkmountpoint"
33175 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4723
33176 #: ../src/guestfs-actions.pod:4723
33180 " guestfs_mkmountpoint (guestfs_h *g,\n"
33181 " const char *exemptpath);\n"
33186 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4727
33187 #: ../src/guestfs-actions.pod:4727
33189 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
33190 "that can be used to create extra mountpoints before mounting the first "
33195 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4751
33196 #: ../src/guestfs-actions.pod:4751
33198 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
33199 "may get unexpected errors if you try to mix these calls. It is safest to "
33200 "manually unmount filesystems and remove mountpoints after use."
33204 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4755
33205 #: ../src/guestfs-actions.pod:4755
33207 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
33208 "first, so for this to work for manual mountpoints, you must ensure that the "
33209 "innermost mountpoints have the longest pathnames, as in the example code "
33214 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4762
33215 #: ../src/guestfs-actions.pod:4762
33217 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
33218 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
33219 "can also trigger these issues."
33223 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4768
33224 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5084
33225 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6094
33226 #: ../src/guestfs-actions.pod:4768 ../src/guestfs-actions.pod:5084
33227 #: ../src/guestfs-actions.pod:6094
33228 msgid "(Added in 1.0.62)"
33232 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4770
33233 #: ../src/guestfs-actions.pod:4770
33234 msgid "guestfs_mknod"
33238 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4772
33239 #: ../src/guestfs-actions.pod:4772
33243 " guestfs_mknod (guestfs_h *g,\n"
33247 " const char *path);\n"
33252 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4787
33253 #: ../src/guestfs-actions.pod:4787
33255 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
33256 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
33257 "regular file). These constants are available in the standard Linux header "
33258 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
33259 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
33260 "the appropriate constant for you."
33264 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4801
33265 #: ../src/guestfs-actions.pod:4801
33266 msgid "guestfs_mknod_b"
33270 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4803
33271 #: ../src/guestfs-actions.pod:4803
33275 " guestfs_mknod_b (guestfs_h *g,\n"
33279 " const char *path);\n"
33284 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4810
33285 #: ../src/guestfs-actions.pod:4810
33287 "This call creates a block device node called C<path> with mode C<mode> and "
33288 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
33289 "wrapper around C<guestfs_mknod>."
33293 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4820
33294 #: ../src/guestfs-actions.pod:4820
33295 msgid "guestfs_mknod_c"
33299 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4822
33300 #: ../src/guestfs-actions.pod:4822
33304 " guestfs_mknod_c (guestfs_h *g,\n"
33308 " const char *path);\n"
33313 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4829
33314 #: ../src/guestfs-actions.pod:4829
33316 "This call creates a char device node called C<path> with mode C<mode> and "
33317 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
33318 "wrapper around C<guestfs_mknod>."
33322 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4839
33323 #: ../src/guestfs-actions.pod:4839
33324 msgid "guestfs_mkswap"
33328 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4841
33329 #: ../src/guestfs-actions.pod:4841
33333 " guestfs_mkswap (guestfs_h *g,\n"
33334 " const char *device);\n"
33339 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4851
33340 #: ../src/guestfs-actions.pod:4851
33341 msgid "guestfs_mkswap_L"
33345 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4853
33346 #: ../src/guestfs-actions.pod:4853
33350 " guestfs_mkswap_L (guestfs_h *g,\n"
33351 " const char *label,\n"
33352 " const char *device);\n"
33357 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4868
33358 #: ../src/guestfs-actions.pod:4868
33359 msgid "guestfs_mkswap_U"
33363 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4870
33364 #: ../src/guestfs-actions.pod:4870
33368 " guestfs_mkswap_U (guestfs_h *g,\n"
33369 " const char *uuid,\n"
33370 " const char *device);\n"
33375 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4881
33376 #: ../src/guestfs-actions.pod:4881
33377 msgid "guestfs_mkswap_file"
33381 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4883
33382 #: ../src/guestfs-actions.pod:4883
33386 " guestfs_mkswap_file (guestfs_h *g,\n"
33387 " const char *path);\n"
33392 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4889
33393 #: ../src/guestfs-actions.pod:4889
33395 "This command just writes a swap file signature to an existing file. To "
33396 "create the file itself, use something like C<guestfs_fallocate>."
33400 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4896
33401 #: ../src/guestfs-actions.pod:4896
33402 msgid "guestfs_modprobe"
33406 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4898
33407 #: ../src/guestfs-actions.pod:4898
33411 " guestfs_modprobe (guestfs_h *g,\n"
33412 " const char *modulename);\n"
33417 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4911
33418 #: ../src/guestfs-actions.pod:4911
33419 msgid "guestfs_mount"
33423 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4913
33424 #: ../src/guestfs-actions.pod:4913
33428 " guestfs_mount (guestfs_h *g,\n"
33429 " const char *device,\n"
33430 " const char *mountpoint);\n"
33435 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4932
33436 #: ../src/guestfs-actions.pod:4932
33438 "B<Important note:> When you use this call, the filesystem options C<sync> "
33439 "and C<noatime> are set implicitly. This was originally done because we "
33440 "thought it would improve reliability, but it turns out that I<-o sync> has a "
33441 "very large negative performance impact and negligible effect on "
33442 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
33443 "in any code that needs performance, and instead use C<guestfs_mount_options> "
33444 "(use an empty string for the first parameter if you don't want any options)."
33448 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4953
33449 #: ../src/guestfs-actions.pod:4953
33450 msgid "guestfs_mount_9p"
33454 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4955
33455 #: ../src/guestfs-actions.pod:4955
33459 " guestfs_mount_9p (guestfs_h *g,\n"
33460 " const char *mounttag,\n"
33461 " const char *mountpoint,\n"
33467 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4966
33468 #: ../src/guestfs-actions.pod:4966
33471 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
33476 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4979
33477 #: ../src/guestfs-actions.pod:4979
33478 msgid "guestfs_mount_9p_va"
33482 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4981
33483 #: ../src/guestfs-actions.pod:4981
33487 " guestfs_mount_9p_va (guestfs_h *g,\n"
33488 " const char *mounttag,\n"
33489 " const char *mountpoint,\n"
33490 " va_list args);\n"
33495 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4987
33496 #: ../src/guestfs-actions.pod:4987
33497 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
33501 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4991
33502 #: ../src/guestfs-actions.pod:4991
33503 msgid "guestfs_mount_9p_argv"
33507 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4993
33508 #: ../src/guestfs-actions.pod:4993
33512 " guestfs_mount_9p_argv (guestfs_h *g,\n"
33513 " const char *mounttag,\n"
33514 " const char *mountpoint,\n"
33515 " const struct guestfs_mount_9p_argv *optargs);\n"
33520 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:4999
33521 #: ../src/guestfs-actions.pod:4999
33522 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
33526 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5003
33527 #: ../src/guestfs-actions.pod:5003
33528 msgid "guestfs_mount_loop"
33532 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5005
33533 #: ../src/guestfs-actions.pod:5005
33537 " guestfs_mount_loop (guestfs_h *g,\n"
33538 " const char *file,\n"
33539 " const char *mountpoint);\n"
33544 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5018
33545 #: ../src/guestfs-actions.pod:5018
33546 msgid "guestfs_mount_options"
33550 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5020
33551 #: ../src/guestfs-actions.pod:5020
33555 " guestfs_mount_options (guestfs_h *g,\n"
33556 " const char *options,\n"
33557 " const char *device,\n"
33558 " const char *mountpoint);\n"
33563 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5026
33564 #: ../src/guestfs-actions.pod:5026
33566 "This is the same as the C<guestfs_mount> command, but it allows you to set "
33567 "the mount options as for the L<mount(8)> I<-o> flag."
33571 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5036
33572 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5050
33573 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5067
33574 #: ../src/guestfs-actions.pod:5036 ../src/guestfs-actions.pod:5050
33575 #: ../src/guestfs-actions.pod:5067
33576 msgid "(Added in 1.0.10)"
33580 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5038
33581 #: ../src/guestfs-actions.pod:5038
33582 msgid "guestfs_mount_ro"
33586 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5040
33587 #: ../src/guestfs-actions.pod:5040
33591 " guestfs_mount_ro (guestfs_h *g,\n"
33592 " const char *device,\n"
33593 " const char *mountpoint);\n"
33598 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5045
33599 #: ../src/guestfs-actions.pod:5045
33601 "This is the same as the C<guestfs_mount> command, but it mounts the "
33602 "filesystem with the read-only (I<-o ro>) flag."
33606 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5052
33607 #: ../src/guestfs-actions.pod:5052
33608 msgid "guestfs_mount_vfs"
33612 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5054
33613 #: ../src/guestfs-actions.pod:5054
33617 " guestfs_mount_vfs (guestfs_h *g,\n"
33618 " const char *options,\n"
33619 " const char *vfstype,\n"
33620 " const char *device,\n"
33621 " const char *mountpoint);\n"
33626 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5061
33627 #: ../src/guestfs-actions.pod:5061
33629 "This is the same as the C<guestfs_mount> command, but it allows you to set "
33630 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and I<-"
33635 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5069
33636 #: ../src/guestfs-actions.pod:5069
33637 msgid "guestfs_mountpoints"
33641 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5071
33642 #: ../src/guestfs-actions.pod:5071
33646 " guestfs_mountpoints (guestfs_h *g);\n"
33651 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5074
33652 #: ../src/guestfs-actions.pod:5074
33654 "This call is similar to C<guestfs_mounts>. That call returns a list of "
33655 "devices. This one returns a hash table (map) of device name to directory "
33656 "where the device is mounted."
33660 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5086
33661 #: ../src/guestfs-actions.pod:5086
33662 msgid "guestfs_mounts"
33666 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5088
33667 #: ../src/guestfs-actions.pod:5088
33671 " guestfs_mounts (guestfs_h *g);\n"
33676 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5096
33677 #: ../src/guestfs-actions.pod:5096
33678 msgid "See also: C<guestfs_mountpoints>"
33682 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5104
33683 #: ../src/guestfs-actions.pod:5104
33688 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5106
33689 #: ../src/guestfs-actions.pod:5106
33693 " guestfs_mv (guestfs_h *g,\n"
33694 " const char *src,\n"
33695 " const char *dest);\n"
33700 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5118
33701 #: ../src/guestfs-actions.pod:5118
33702 msgid "guestfs_ntfs_3g_probe"
33706 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5120
33707 #: ../src/guestfs-actions.pod:5120
33711 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
33713 " const char *device);\n"
33718 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5139
33719 #: ../src/guestfs-actions.pod:5139
33720 msgid "(Added in 1.0.43)"
33724 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5141
33725 #: ../src/guestfs-actions.pod:5141
33726 msgid "guestfs_ntfsresize"
33730 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5143
33731 #: ../src/guestfs-actions.pod:5143
33735 " guestfs_ntfsresize (guestfs_h *g,\n"
33736 " const char *device);\n"
33741 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5171
33742 #: ../src/guestfs-actions.pod:5171
33743 msgid "guestfs_ntfsresize_opts"
33747 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5173
33748 #: ../src/guestfs-actions.pod:5173
33752 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
33753 " const char *device,\n"
33759 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5183
33760 #: ../src/guestfs-actions.pod:5183
33763 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
33764 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
33769 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5203
33770 #: ../src/guestfs-actions.pod:5203
33772 "After the resize operation, the filesystem is always marked as requiring a "
33773 "consistency check (for safety). You have to boot into Windows to perform "
33774 "this check and clear this condition. If you I<don't> set the C<force> "
33775 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
33776 "times on a single filesystem without booting into Windows between each "
33781 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5218
33782 #: ../src/guestfs-actions.pod:5218
33783 msgid "guestfs_ntfsresize_opts_va"
33787 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5220
33788 #: ../src/guestfs-actions.pod:5220
33792 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
33793 " const char *device,\n"
33794 " va_list args);\n"
33799 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5225
33800 #: ../src/guestfs-actions.pod:5225
33801 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
33805 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5229
33806 #: ../src/guestfs-actions.pod:5229
33807 msgid "guestfs_ntfsresize_opts_argv"
33811 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5231
33812 #: ../src/guestfs-actions.pod:5231
33816 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
33817 " const char *device,\n"
33818 " const struct guestfs_ntfsresize_opts_argv *optargs);\n"
33823 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5236
33824 #: ../src/guestfs-actions.pod:5236
33825 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
33829 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5240
33830 #: ../src/guestfs-actions.pod:5240
33831 msgid "guestfs_ntfsresize_size"
33835 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5242
33836 #: ../src/guestfs-actions.pod:5242
33840 " guestfs_ntfsresize_size (guestfs_h *g,\n"
33841 " const char *device,\n"
33842 " int64_t size);\n"
33847 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5247
33848 #: ../src/guestfs-actions.pod:5247
33850 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
33851 "to specify the new size (in bytes) explicitly."
33855 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5259
33856 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5701
33857 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5774
33858 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6042
33859 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7665
33860 #: ../src/guestfs-actions.pod:5259 ../src/guestfs-actions.pod:5701
33861 #: ../src/guestfs-actions.pod:5774 ../src/guestfs-actions.pod:6042
33862 #: ../src/guestfs-actions.pod:7665
33863 msgid "(Added in 1.3.14)"
33867 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5261
33868 #: ../src/guestfs-actions.pod:5261
33869 msgid "guestfs_part_add"
33873 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5263
33874 #: ../src/guestfs-actions.pod:5263
33878 " guestfs_part_add (guestfs_h *g,\n"
33879 " const char *device,\n"
33880 " const char *prlogex,\n"
33881 " int64_t startsect,\n"
33882 " int64_t endsect);\n"
33887 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5270
33888 #: ../src/guestfs-actions.pod:5270
33890 "This command adds a partition to C<device>. If there is no partition table "
33891 "on the device, call C<guestfs_part_init> first."
33895 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5282
33896 #: ../src/guestfs-actions.pod:5282
33898 "Creating a partition which covers the whole disk is not so easy. Use "
33899 "C<guestfs_part_disk> to do that."
33903 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5287
33904 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5325
33905 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5378
33906 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5462
33907 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5500
33908 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5519
33909 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5559
33910 #: ../src/guestfs-actions.pod:5287 ../src/guestfs-actions.pod:5325
33911 #: ../src/guestfs-actions.pod:5378 ../src/guestfs-actions.pod:5462
33912 #: ../src/guestfs-actions.pod:5500 ../src/guestfs-actions.pod:5519
33913 #: ../src/guestfs-actions.pod:5559
33914 msgid "(Added in 1.0.78)"
33918 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5289
33919 #: ../src/guestfs-actions.pod:5289
33920 msgid "guestfs_part_del"
33924 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5291
33925 #: ../src/guestfs-actions.pod:5291
33929 " guestfs_part_del (guestfs_h *g,\n"
33930 " const char *device,\n"
33936 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5306
33937 #: ../src/guestfs-actions.pod:5306
33938 msgid "guestfs_part_disk"
33942 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5308
33943 #: ../src/guestfs-actions.pod:5308
33947 " guestfs_part_disk (guestfs_h *g,\n"
33948 " const char *device,\n"
33949 " const char *parttype);\n"
33954 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5313
33955 #: ../src/guestfs-actions.pod:5313
33957 "This command is simply a combination of C<guestfs_part_init> followed by "
33958 "C<guestfs_part_add> to create a single primary partition covering the whole "
33963 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5317
33964 #: ../src/guestfs-actions.pod:5317
33966 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
33967 "possible values are described in C<guestfs_part_init>."
33971 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5327
33972 #: ../src/guestfs-actions.pod:5327
33973 msgid "guestfs_part_get_bootable"
33977 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5329
33978 #: ../src/guestfs-actions.pod:5329
33982 " guestfs_part_get_bootable (guestfs_h *g,\n"
33983 " const char *device,\n"
33989 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5337
33990 #: ../src/guestfs-actions.pod:5337
33991 msgid "See also C<guestfs_part_set_bootable>."
33995 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5343
33996 #: ../src/guestfs-actions.pod:5343
33997 msgid "guestfs_part_get_mbr_id"
34001 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5345
34002 #: ../src/guestfs-actions.pod:5345
34006 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
34007 " const char *device,\n"
34013 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5353
34014 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5535
34015 #: ../src/guestfs-actions.pod:5353 ../src/guestfs-actions.pod:5535
34017 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
34018 "undefined results for other partition table types (see "
34019 "C<guestfs_part_get_parttype>)."
34023 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5361
34024 #: ../src/guestfs-actions.pod:5361
34025 msgid "guestfs_part_get_parttype"
34029 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5363
34030 #: ../src/guestfs-actions.pod:5363
34034 " guestfs_part_get_parttype (guestfs_h *g,\n"
34035 " const char *device);\n"
34040 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5370
34041 #: ../src/guestfs-actions.pod:5370
34043 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
34044 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
34045 "possible, although unusual. See C<guestfs_part_init> for a full list."
34049 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5380
34050 #: ../src/guestfs-actions.pod:5380
34051 msgid "guestfs_part_init"
34055 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5382
34056 #: ../src/guestfs-actions.pod:5382
34060 " guestfs_part_init (guestfs_h *g,\n"
34061 " const char *device,\n"
34062 " const char *parttype);\n"
34067 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5391
34068 #: ../src/guestfs-actions.pod:5391
34070 "Initially there are no partitions. Following this, you should call "
34071 "C<guestfs_part_add> for each partition required."
34075 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5464
34076 #: ../src/guestfs-actions.pod:5464
34077 msgid "guestfs_part_list"
34081 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5466
34082 #: ../src/guestfs-actions.pod:5466
34085 " struct guestfs_partition_list *\n"
34086 " guestfs_part_list (guestfs_h *g,\n"
34087 " const char *device);\n"
34092 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5483
34093 #: ../src/guestfs-actions.pod:5483
34095 "Start of the partition I<in bytes>. To get sectors you have to divide by "
34096 "the device's sector size, see C<guestfs_blockdev_getss>."
34100 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5496
34101 #: ../src/guestfs-actions.pod:5496
34103 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
34104 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
34109 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5502
34110 #: ../src/guestfs-actions.pod:5502
34111 msgid "guestfs_part_set_bootable"
34115 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5504
34116 #: ../src/guestfs-actions.pod:5504
34120 " guestfs_part_set_bootable (guestfs_h *g,\n"
34121 " const char *device,\n"
34123 " int bootable);\n"
34128 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5521
34129 #: ../src/guestfs-actions.pod:5521
34130 msgid "guestfs_part_set_mbr_id"
34134 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5523
34135 #: ../src/guestfs-actions.pod:5523
34139 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
34140 " const char *device,\n"
34147 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5543
34148 #: ../src/guestfs-actions.pod:5543
34149 msgid "guestfs_part_set_name"
34153 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5545
34154 #: ../src/guestfs-actions.pod:5545
34158 " guestfs_part_set_name (guestfs_h *g,\n"
34159 " const char *device,\n"
34161 " const char *name);\n"
34166 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5561
34167 #: ../src/guestfs-actions.pod:5561
34168 msgid "guestfs_part_to_dev"
34172 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5563
34173 #: ../src/guestfs-actions.pod:5563
34177 " guestfs_part_to_dev (guestfs_h *g,\n"
34178 " const char *partition);\n"
34183 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5571
34184 #: ../src/guestfs-actions.pod:5571
34186 "The named partition must exist, for example as a string returned from "
34187 "C<guestfs_list_partitions>."
34191 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5579
34192 #: ../src/guestfs-actions.pod:5579
34193 msgid "guestfs_ping_daemon"
34197 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5581
34198 #: ../src/guestfs-actions.pod:5581
34202 " guestfs_ping_daemon (guestfs_h *g);\n"
34207 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5593
34208 #: ../src/guestfs-actions.pod:5593
34209 msgid "guestfs_pread"
34213 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5595
34214 #: ../src/guestfs-actions.pod:5595
34218 " guestfs_pread (guestfs_h *g,\n"
34219 " const char *path,\n"
34221 " int64_t offset,\n"
34222 " size_t *size_r);\n"
34227 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5608
34228 #: ../src/guestfs-actions.pod:5608
34229 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
34233 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5619
34234 #: ../src/guestfs-actions.pod:5619
34235 msgid "guestfs_pread_device"
34239 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5621
34240 #: ../src/guestfs-actions.pod:5621
34244 " guestfs_pread_device (guestfs_h *g,\n"
34245 " const char *device,\n"
34247 " int64_t offset,\n"
34248 " size_t *size_r);\n"
34253 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5634
34254 #: ../src/guestfs-actions.pod:5634
34255 msgid "See also C<guestfs_pread>."
34259 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5643
34260 #: ../src/guestfs-actions.pod:5643
34261 msgid "(Added in 1.5.21)"
34265 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5645
34266 #: ../src/guestfs-actions.pod:5645
34267 msgid "guestfs_pvcreate"
34271 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5647
34272 #: ../src/guestfs-actions.pod:5647
34276 " guestfs_pvcreate (guestfs_h *g,\n"
34277 " const char *device);\n"
34282 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5659
34283 #: ../src/guestfs-actions.pod:5659
34284 msgid "guestfs_pvremove"
34288 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5661
34289 #: ../src/guestfs-actions.pod:5661
34293 " guestfs_pvremove (guestfs_h *g,\n"
34294 " const char *device);\n"
34299 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5676
34300 #: ../src/guestfs-actions.pod:5676
34301 msgid "guestfs_pvresize"
34305 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5678
34306 #: ../src/guestfs-actions.pod:5678
34310 " guestfs_pvresize (guestfs_h *g,\n"
34311 " const char *device);\n"
34316 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5689
34317 #: ../src/guestfs-actions.pod:5689
34318 msgid "guestfs_pvresize_size"
34322 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5691
34323 #: ../src/guestfs-actions.pod:5691
34327 " guestfs_pvresize_size (guestfs_h *g,\n"
34328 " const char *device,\n"
34329 " int64_t size);\n"
34334 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5696
34335 #: ../src/guestfs-actions.pod:5696
34337 "This command is the same as C<guestfs_pvresize> except that it allows you to "
34338 "specify the new size (in bytes) explicitly."
34342 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5703
34343 #: ../src/guestfs-actions.pod:5703
34344 msgid "guestfs_pvs"
34348 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5705
34349 #: ../src/guestfs-actions.pod:5705
34353 " guestfs_pvs (guestfs_h *g);\n"
34358 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5714
34359 #: ../src/guestfs-actions.pod:5714
34360 msgid "See also C<guestfs_pvs_full>."
34364 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5722
34365 #: ../src/guestfs-actions.pod:5722
34366 msgid "guestfs_pvs_full"
34370 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5724
34371 #: ../src/guestfs-actions.pod:5724
34374 " struct guestfs_lvm_pv_list *\n"
34375 " guestfs_pvs_full (guestfs_h *g);\n"
34380 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5730
34381 #: ../src/guestfs-actions.pod:5730
34383 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
34384 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after use>."
34388 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5736
34389 #: ../src/guestfs-actions.pod:5736
34390 msgid "guestfs_pvuuid"
34394 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5738
34395 #: ../src/guestfs-actions.pod:5738
34399 " guestfs_pvuuid (guestfs_h *g,\n"
34400 " const char *device);\n"
34405 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5749
34406 #: ../src/guestfs-actions.pod:5749
34407 msgid "guestfs_pwrite"
34411 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5751
34412 #: ../src/guestfs-actions.pod:5751
34416 " guestfs_pwrite (guestfs_h *g,\n"
34417 " const char *path,\n"
34418 " const char *content,\n"
34419 " size_t content_size,\n"
34420 " int64_t offset);\n"
34425 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5767
34426 #: ../src/guestfs-actions.pod:5767
34427 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
34431 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5776
34432 #: ../src/guestfs-actions.pod:5776
34433 msgid "guestfs_pwrite_device"
34437 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5778
34438 #: ../src/guestfs-actions.pod:5778
34442 " guestfs_pwrite_device (guestfs_h *g,\n"
34443 " const char *device,\n"
34444 " const char *content,\n"
34445 " size_t content_size,\n"
34446 " int64_t offset);\n"
34451 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5793
34452 #: ../src/guestfs-actions.pod:5793
34453 msgid "See also C<guestfs_pwrite>."
34457 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5800
34458 #: ../src/guestfs-actions.pod:5800
34459 msgid "(Added in 1.5.20)"
34463 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5802
34464 #: ../src/guestfs-actions.pod:5802
34465 msgid "guestfs_read_file"
34469 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5804
34470 #: ../src/guestfs-actions.pod:5804
34474 " guestfs_read_file (guestfs_h *g,\n"
34475 " const char *path,\n"
34476 " size_t *size_r);\n"
34481 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5812
34482 #: ../src/guestfs-actions.pod:5812
34484 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
34485 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
34486 "function is limited in the total size of file that can be handled."
34490 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5824
34491 #: ../src/guestfs-actions.pod:5824
34492 msgid "(Added in 1.0.63)"
34496 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5826
34497 #: ../src/guestfs-actions.pod:5826
34498 msgid "guestfs_read_lines"
34502 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5828
34503 #: ../src/guestfs-actions.pod:5828
34507 " guestfs_read_lines (guestfs_h *g,\n"
34508 " const char *path);\n"
34513 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5837
34514 #: ../src/guestfs-actions.pod:5837
34516 "Note that this function cannot correctly handle binary files (specifically, "
34517 "files containing C<\\0> character which is treated as end of line). For "
34518 "those you need to use the C<guestfs_read_file> function which has a more "
34519 "complex interface."
34523 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5848
34524 #: ../src/guestfs-actions.pod:5848
34525 msgid "guestfs_readdir"
34529 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5850
34530 #: ../src/guestfs-actions.pod:5850
34533 " struct guestfs_dirent_list *\n"
34534 " guestfs_readdir (guestfs_h *g,\n"
34535 " const char *dir);\n"
34540 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5904
34541 #: ../src/guestfs-actions.pod:5904
34543 "This function is primarily intended for use by programs. To get a simple "
34544 "list of names, use C<guestfs_ls>. To get a printable directory for human "
34545 "consumption, use C<guestfs_ll>."
34549 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5908
34550 #: ../src/guestfs-actions.pod:5908
34552 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
34553 "was an error. I<The caller must call C<guestfs_free_dirent_list> after use>."
34557 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5914
34558 #: ../src/guestfs-actions.pod:5914
34559 msgid "guestfs_readlink"
34563 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5916
34564 #: ../src/guestfs-actions.pod:5916
34568 " guestfs_readlink (guestfs_h *g,\n"
34569 " const char *path);\n"
34574 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5927
34575 #: ../src/guestfs-actions.pod:5927
34576 msgid "guestfs_readlinklist"
34580 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5929
34581 #: ../src/guestfs-actions.pod:5929
34585 " guestfs_readlinklist (guestfs_h *g,\n"
34586 " const char *path,\n"
34587 " char *const *names);\n"
34592 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5962
34593 #: ../src/guestfs-actions.pod:5962
34594 msgid "guestfs_realpath"
34598 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5964
34599 #: ../src/guestfs-actions.pod:5964
34603 " guestfs_realpath (guestfs_h *g,\n"
34604 " const char *path);\n"
34609 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5976
34610 #: ../src/guestfs-actions.pod:5976
34611 msgid "guestfs_removexattr"
34615 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5978
34616 #: ../src/guestfs-actions.pod:5978
34620 " guestfs_removexattr (guestfs_h *g,\n"
34621 " const char *xattr,\n"
34622 " const char *path);\n"
34627 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5986
34628 #: ../src/guestfs-actions.pod:5986
34629 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
34633 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5992
34634 #: ../src/guestfs-actions.pod:5992
34635 msgid "guestfs_resize2fs"
34639 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:5994
34640 #: ../src/guestfs-actions.pod:5994
34644 " guestfs_resize2fs (guestfs_h *g,\n"
34645 " const char *device);\n"
34650 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6001
34651 #: ../src/guestfs-actions.pod:6001
34653 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
34654 "C<device> before calling this command. For unknown reasons C<resize2fs> "
34655 "sometimes gives an error about this and sometimes not. In any case, it is "
34656 "always safe to call C<guestfs_e2fsck_f> before calling this function."
34660 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6011
34661 #: ../src/guestfs-actions.pod:6011
34662 msgid "guestfs_resize2fs_M"
34666 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6013
34667 #: ../src/guestfs-actions.pod:6013
34671 " guestfs_resize2fs_M (guestfs_h *g,\n"
34672 " const char *device);\n"
34677 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6017
34678 #: ../src/guestfs-actions.pod:6017
34680 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
34681 "resized to its minimum size. This works like the I<-M> option to the "
34682 "C<resize2fs> command."
34686 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6021
34687 #: ../src/guestfs-actions.pod:6021
34689 "To get the resulting size of the filesystem you should call "
34690 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
34691 "These two numbers, multiplied together, give the resulting size of the "
34692 "minimal filesystem in bytes."
34696 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6030
34697 #: ../src/guestfs-actions.pod:6030
34698 msgid "guestfs_resize2fs_size"
34702 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6032
34703 #: ../src/guestfs-actions.pod:6032
34707 " guestfs_resize2fs_size (guestfs_h *g,\n"
34708 " const char *device,\n"
34709 " int64_t size);\n"
34714 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6037
34715 #: ../src/guestfs-actions.pod:6037
34717 "This command is the same as C<guestfs_resize2fs> except that it allows you "
34718 "to specify the new size (in bytes) explicitly."
34722 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6044
34723 #: ../src/guestfs-actions.pod:6044
34728 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6046
34729 #: ../src/guestfs-actions.pod:6046
34733 " guestfs_rm (guestfs_h *g,\n"
34734 " const char *path);\n"
34739 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6056
34740 #: ../src/guestfs-actions.pod:6056
34741 msgid "guestfs_rm_rf"
34745 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6058
34746 #: ../src/guestfs-actions.pod:6058
34750 " guestfs_rm_rf (guestfs_h *g,\n"
34751 " const char *path);\n"
34756 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6070
34757 #: ../src/guestfs-actions.pod:6070
34758 msgid "guestfs_rmdir"
34762 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6072
34763 #: ../src/guestfs-actions.pod:6072
34767 " guestfs_rmdir (guestfs_h *g,\n"
34768 " const char *path);\n"
34773 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6082
34774 #: ../src/guestfs-actions.pod:6082
34775 msgid "guestfs_rmmountpoint"
34779 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6084
34780 #: ../src/guestfs-actions.pod:6084
34784 " guestfs_rmmountpoint (guestfs_h *g,\n"
34785 " const char *exemptpath);\n"
34790 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6088
34791 #: ../src/guestfs-actions.pod:6088
34793 "This calls removes a mountpoint that was previously created with "
34794 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
34798 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6096
34799 #: ../src/guestfs-actions.pod:6096
34800 msgid "guestfs_scrub_device"
34804 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6098
34805 #: ../src/guestfs-actions.pod:6098
34809 " guestfs_scrub_device (guestfs_h *g,\n"
34810 " const char *device);\n"
34815 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6113
34816 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6131
34817 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6150
34818 #: ../src/guestfs-actions.pod:6113 ../src/guestfs-actions.pod:6131
34819 #: ../src/guestfs-actions.pod:6150
34820 msgid "(Added in 1.0.52)"
34824 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6115
34825 #: ../src/guestfs-actions.pod:6115
34826 msgid "guestfs_scrub_file"
34830 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6117
34831 #: ../src/guestfs-actions.pod:6117
34835 " guestfs_scrub_file (guestfs_h *g,\n"
34836 " const char *file);\n"
34841 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6133
34842 #: ../src/guestfs-actions.pod:6133
34843 msgid "guestfs_scrub_freespace"
34847 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6135
34848 #: ../src/guestfs-actions.pod:6135
34852 " guestfs_scrub_freespace (guestfs_h *g,\n"
34853 " const char *dir);\n"
34858 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6139
34859 #: ../src/guestfs-actions.pod:6139
34861 "This command creates the directory C<dir> and then fills it with files until "
34862 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
34863 "and deletes them. The intention is to scrub any free space on the partition "
34864 "containing C<dir>."
34868 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6152
34869 #: ../src/guestfs-actions.pod:6152
34870 msgid "guestfs_set_append"
34874 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6154
34875 #: ../src/guestfs-actions.pod:6154
34879 " guestfs_set_append (guestfs_h *g,\n"
34880 " const char *append);\n"
34885 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6171
34886 #: ../src/guestfs-actions.pod:6171
34887 msgid "guestfs_set_attach_method"
34891 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6173
34892 #: ../src/guestfs-actions.pod:6173
34896 " guestfs_set_attach_method (guestfs_h *g,\n"
34897 " const char *attachmethod);\n"
34902 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6201
34903 #: ../src/guestfs-actions.pod:6201
34904 msgid "guestfs_set_autosync"
34908 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6203
34909 #: ../src/guestfs-actions.pod:6203
34913 " guestfs_set_autosync (guestfs_h *g,\n"
34914 " int autosync);\n"
34919 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6219
34920 #: ../src/guestfs-actions.pod:6219
34921 msgid "guestfs_set_direct"
34925 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6221
34926 #: ../src/guestfs-actions.pod:6221
34930 " guestfs_set_direct (guestfs_h *g,\n"
34936 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6229
34937 #: ../src/guestfs-actions.pod:6229
34939 "One consequence of this is that log messages aren't caught by the library "
34940 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
34945 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6242
34946 #: ../src/guestfs-actions.pod:6242
34947 msgid "guestfs_set_e2label"
34951 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6244
34952 #: ../src/guestfs-actions.pod:6244
34956 " guestfs_set_e2label (guestfs_h *g,\n"
34957 " const char *device,\n"
34958 " const char *label);\n"
34963 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6253
34964 #: ../src/guestfs-actions.pod:6253
34966 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
34967 "the existing label on a filesystem."
34971 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6260
34972 #: ../src/guestfs-actions.pod:6260
34973 msgid "guestfs_set_e2uuid"
34977 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6262
34978 #: ../src/guestfs-actions.pod:6262
34982 " guestfs_set_e2uuid (guestfs_h *g,\n"
34983 " const char *device,\n"
34984 " const char *uuid);\n"
34989 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6272
34990 #: ../src/guestfs-actions.pod:6272
34992 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
34993 "the existing UUID of a filesystem."
34997 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6279
34998 #: ../src/guestfs-actions.pod:6279
34999 msgid "guestfs_set_memsize"
35003 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6281
35004 #: ../src/guestfs-actions.pod:6281
35008 " guestfs_set_memsize (guestfs_h *g,\n"
35014 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6285
35015 #: ../src/guestfs-actions.pod:6285
35017 "This sets the memory size in megabytes allocated to the qemu subprocess. "
35018 "This only has any effect if called before C<guestfs_launch>."
35022 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6300
35023 #: ../src/guestfs-actions.pod:6300
35024 msgid "guestfs_set_network"
35028 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6302
35029 #: ../src/guestfs-actions.pod:6302
35033 " guestfs_set_network (guestfs_h *g,\n"
35039 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6312
35040 #: ../src/guestfs-actions.pod:6312
35042 "You must call this before calling C<guestfs_launch>, otherwise it has no "
35047 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6319
35048 #: ../src/guestfs-actions.pod:6319
35049 msgid "guestfs_set_path"
35053 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6321
35054 #: ../src/guestfs-actions.pod:6321
35058 " guestfs_set_path (guestfs_h *g,\n"
35059 " const char *searchpath);\n"
35064 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6336
35065 #: ../src/guestfs-actions.pod:6336
35066 msgid "guestfs_set_pgroup"
35070 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6338
35071 #: ../src/guestfs-actions.pod:6338
35075 " guestfs_set_pgroup (guestfs_h *g,\n"
35081 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6355
35082 #: ../src/guestfs-actions.pod:6355
35083 msgid "guestfs_set_qemu"
35087 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6357
35088 #: ../src/guestfs-actions.pod:6357
35092 " guestfs_set_qemu (guestfs_h *g,\n"
35093 " const char *qemu);\n"
35098 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6383
35099 #: ../src/guestfs-actions.pod:6383
35100 msgid "guestfs_set_recovery_proc"
35104 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6385
35105 #: ../src/guestfs-actions.pod:6385
35109 " guestfs_set_recovery_proc (guestfs_h *g,\n"
35110 " int recoveryproc);\n"
35115 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6389
35116 #: ../src/guestfs-actions.pod:6389
35118 "If this is called with the parameter C<false> then C<guestfs_launch> does "
35119 "not create a recovery process. The purpose of the recovery process is to "
35120 "stop runaway qemu processes in the case where the main program aborts "
35125 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6394
35126 #: ../src/guestfs-actions.pod:6394
35128 "This only has any effect if called before C<guestfs_launch>, and the default "
35133 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6407
35134 #: ../src/guestfs-actions.pod:6407
35135 msgid "guestfs_set_selinux"
35139 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6409
35140 #: ../src/guestfs-actions.pod:6409
35144 " guestfs_set_selinux (guestfs_h *g,\n"
35150 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6426
35151 #: ../src/guestfs-actions.pod:6426
35152 msgid "guestfs_set_trace"
35156 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6428
35157 #: ../src/guestfs-actions.pod:6428
35161 " guestfs_set_trace (guestfs_h *g,\n"
35167 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6442
35168 #: ../src/guestfs-actions.pod:6442
35170 "Trace messages are normally sent to C<stderr>, unless you register a "
35171 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
35175 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6450
35176 #: ../src/guestfs-actions.pod:6450
35177 msgid "guestfs_set_verbose"
35181 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6452
35182 #: ../src/guestfs-actions.pod:6452
35186 " guestfs_set_verbose (guestfs_h *g,\n"
35192 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6461
35193 #: ../src/guestfs-actions.pod:6461
35195 "Verbose messages are normally sent to C<stderr>, unless you register a "
35196 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
35200 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6469
35201 #: ../src/guestfs-actions.pod:6469
35202 msgid "guestfs_setcon"
35206 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6471
35207 #: ../src/guestfs-actions.pod:6471
35211 " guestfs_setcon (guestfs_h *g,\n"
35212 " const char *context);\n"
35217 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6484
35218 #: ../src/guestfs-actions.pod:6484
35219 msgid "guestfs_setxattr"
35223 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6486
35224 #: ../src/guestfs-actions.pod:6486
35228 " guestfs_setxattr (guestfs_h *g,\n"
35229 " const char *xattr,\n"
35230 " const char *val,\n"
35232 " const char *path);\n"
35237 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6497
35238 #: ../src/guestfs-actions.pod:6497
35239 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
35243 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6503
35244 #: ../src/guestfs-actions.pod:6503
35245 msgid "guestfs_sfdisk"
35249 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6505
35250 #: ../src/guestfs-actions.pod:6505
35254 " guestfs_sfdisk (guestfs_h *g,\n"
35255 " const char *device,\n"
35259 " char *const *lines);\n"
35264 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6533
35265 #: ../src/guestfs-actions.pod:6533
35267 "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
35271 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6550
35272 #: ../src/guestfs-actions.pod:6550
35273 msgid "guestfs_sfdiskM"
35277 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6552
35278 #: ../src/guestfs-actions.pod:6552
35282 " guestfs_sfdiskM (guestfs_h *g,\n"
35283 " const char *device,\n"
35284 " char *const *lines);\n"
35289 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6557
35290 #: ../src/guestfs-actions.pod:6557
35292 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
35293 "partition sizes are specified in megabytes only (rounded to the nearest "
35294 "cylinder) and you don't need to specify the cyls, heads and sectors "
35295 "parameters which were rarely if ever used anyway."
35299 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6563
35300 #: ../src/guestfs-actions.pod:6563
35302 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
35303 "C<guestfs_part_disk>"
35307 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6580
35308 #: ../src/guestfs-actions.pod:6580
35309 msgid "guestfs_sfdisk_N"
35313 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6582
35314 #: ../src/guestfs-actions.pod:6582
35318 " guestfs_sfdisk_N (guestfs_h *g,\n"
35319 " const char *device,\n"
35324 " const char *line);\n"
35329 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6594
35330 #: ../src/guestfs-actions.pod:6594
35332 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
35333 "for the cyls/heads/sectors parameters."
35337 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6597
35338 #: ../src/guestfs-actions.pod:6597
35339 msgid "See also: C<guestfs_part_add>"
35343 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6613
35344 #: ../src/guestfs-actions.pod:6613
35345 msgid "guestfs_sfdisk_disk_geometry"
35349 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6615
35350 #: ../src/guestfs-actions.pod:6615
35354 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
35355 " const char *device);\n"
35360 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6619
35361 #: ../src/guestfs-actions.pod:6619
35363 "This displays the disk geometry of C<device> read from the partition table. "
35364 "Especially in the case where the underlying block device has been resized, "
35365 "this can be different from the kernel's idea of the geometry (see "
35366 "C<guestfs_sfdisk_kernel_geometry>)."
35370 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6632
35371 #: ../src/guestfs-actions.pod:6632
35372 msgid "guestfs_sfdisk_kernel_geometry"
35376 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6634
35377 #: ../src/guestfs-actions.pod:6634
35381 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
35382 " const char *device);\n"
35387 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6648
35388 #: ../src/guestfs-actions.pod:6648
35389 msgid "guestfs_sfdisk_l"
35393 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6650
35394 #: ../src/guestfs-actions.pod:6650
35398 " guestfs_sfdisk_l (guestfs_h *g,\n"
35399 " const char *device);\n"
35404 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6658
35405 #: ../src/guestfs-actions.pod:6658
35406 msgid "See also: C<guestfs_part_list>"
35410 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6672
35411 #: ../src/guestfs-actions.pod:6672
35416 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6674
35417 #: ../src/guestfs-actions.pod:6674
35421 " guestfs_sh (guestfs_h *g,\n"
35422 " const char *command);\n"
35427 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6681
35428 #: ../src/guestfs-actions.pod:6681
35429 msgid "This is like C<guestfs_command>, but passes the command to:"
35433 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6689
35434 #: ../src/guestfs-actions.pod:6689
35435 msgid "All the provisos about C<guestfs_command> apply to this call."
35439 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6696
35440 #: ../src/guestfs-actions.pod:6696
35441 msgid "guestfs_sh_lines"
35445 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6698
35446 #: ../src/guestfs-actions.pod:6698
35450 " guestfs_sh_lines (guestfs_h *g,\n"
35451 " const char *command);\n"
35456 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6702
35457 #: ../src/guestfs-actions.pod:6702
35459 "This is the same as C<guestfs_sh>, but splits the result into a list of "
35464 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6705
35465 #: ../src/guestfs-actions.pod:6705
35466 msgid "See also: C<guestfs_command_lines>"
35470 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6713
35471 #: ../src/guestfs-actions.pod:6713
35472 msgid "guestfs_sleep"
35476 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6715
35477 #: ../src/guestfs-actions.pod:6715
35481 " guestfs_sleep (guestfs_h *g,\n"
35487 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6723
35488 #: ../src/guestfs-actions.pod:6723
35489 msgid "(Added in 1.0.41)"
35493 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6725
35494 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:109
35495 #: ../src/guestfs-actions.pod:6725 ../src/guestfs-structs.pod:109
35496 msgid "guestfs_stat"
35500 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6727
35501 #: ../src/guestfs-actions.pod:6727
35504 " struct guestfs_stat *\n"
35505 " guestfs_stat (guestfs_h *g,\n"
35506 " const char *path);\n"
35511 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6741
35512 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:135
35513 #: ../src/guestfs-actions.pod:6741 ../src/guestfs-structs.pod:135
35514 msgid "guestfs_statvfs"
35518 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6743
35519 #: ../src/guestfs-actions.pod:6743
35522 " struct guestfs_statvfs *\n"
35523 " guestfs_statvfs (guestfs_h *g,\n"
35524 " const char *path);\n"
35529 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6753
35530 #: ../src/guestfs-actions.pod:6753
35532 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
35533 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
35537 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6759
35538 #: ../src/guestfs-actions.pod:6759
35539 msgid "guestfs_strings"
35543 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6761
35544 #: ../src/guestfs-actions.pod:6761
35548 " guestfs_strings (guestfs_h *g,\n"
35549 " const char *path);\n"
35554 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6777
35555 #: ../src/guestfs-actions.pod:6777
35556 msgid "guestfs_strings_e"
35560 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6779
35561 #: ../src/guestfs-actions.pod:6779
35565 " guestfs_strings_e (guestfs_h *g,\n"
35566 " const char *encoding,\n"
35567 " const char *path);\n"
35572 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6784
35573 #: ../src/guestfs-actions.pod:6784
35575 "This is like the C<guestfs_strings> command, but allows you to specify the "
35576 "encoding of strings that are looked for in the source file C<path>."
35580 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6794
35581 #: ../src/guestfs-actions.pod:6794
35583 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
35584 "ISO-8859-X (this is what C<guestfs_strings> uses)."
35588 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6832
35589 #: ../src/guestfs-actions.pod:6832
35590 msgid "guestfs_swapoff_device"
35594 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6834
35595 #: ../src/guestfs-actions.pod:6834
35599 " guestfs_swapoff_device (guestfs_h *g,\n"
35600 " const char *device);\n"
35605 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6838
35606 #: ../src/guestfs-actions.pod:6838
35608 "This command disables the libguestfs appliance swap device or partition "
35609 "named C<device>. See C<guestfs_swapon_device>."
35613 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6846
35614 #: ../src/guestfs-actions.pod:6846
35615 msgid "guestfs_swapoff_file"
35619 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6848
35620 #: ../src/guestfs-actions.pod:6848
35624 " guestfs_swapoff_file (guestfs_h *g,\n"
35625 " const char *file);\n"
35630 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6858
35631 #: ../src/guestfs-actions.pod:6858
35632 msgid "guestfs_swapoff_label"
35636 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6860
35637 #: ../src/guestfs-actions.pod:6860
35641 " guestfs_swapoff_label (guestfs_h *g,\n"
35642 " const char *label);\n"
35647 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6871
35648 #: ../src/guestfs-actions.pod:6871
35649 msgid "guestfs_swapoff_uuid"
35653 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6873
35654 #: ../src/guestfs-actions.pod:6873
35658 " guestfs_swapoff_uuid (guestfs_h *g,\n"
35659 " const char *uuid);\n"
35664 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6884
35665 #: ../src/guestfs-actions.pod:6884
35666 msgid "guestfs_swapon_device"
35670 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6886
35671 #: ../src/guestfs-actions.pod:6886
35675 " guestfs_swapon_device (guestfs_h *g,\n"
35676 " const char *device);\n"
35681 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6890
35682 #: ../src/guestfs-actions.pod:6890
35684 "This command enables the libguestfs appliance to use the swap device or "
35685 "partition named C<device>. The increased memory is made available for all "
35686 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
35690 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6906
35691 #: ../src/guestfs-actions.pod:6906
35692 msgid "guestfs_swapon_file"
35696 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6908
35697 #: ../src/guestfs-actions.pod:6908
35701 " guestfs_swapon_file (guestfs_h *g,\n"
35702 " const char *file);\n"
35707 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6912
35708 #: ../src/guestfs-actions.pod:6912
35710 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
35715 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6919
35716 #: ../src/guestfs-actions.pod:6919
35717 msgid "guestfs_swapon_label"
35721 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6921
35722 #: ../src/guestfs-actions.pod:6921
35726 " guestfs_swapon_label (guestfs_h *g,\n"
35727 " const char *label);\n"
35732 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6925
35733 #: ../src/guestfs-actions.pod:6925
35735 "This command enables swap to a labeled swap partition. See "
35736 "C<guestfs_swapon_device> for other notes."
35740 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6932
35741 #: ../src/guestfs-actions.pod:6932
35742 msgid "guestfs_swapon_uuid"
35746 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6934
35747 #: ../src/guestfs-actions.pod:6934
35751 " guestfs_swapon_uuid (guestfs_h *g,\n"
35752 " const char *uuid);\n"
35757 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6938
35758 #: ../src/guestfs-actions.pod:6938
35760 "This command enables swap to a swap partition with the given UUID. See "
35761 "C<guestfs_swapon_device> for other notes."
35765 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6945
35766 #: ../src/guestfs-actions.pod:6945
35767 msgid "guestfs_sync"
35771 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6947
35772 #: ../src/guestfs-actions.pod:6947
35776 " guestfs_sync (guestfs_h *g);\n"
35781 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6960
35782 #: ../src/guestfs-actions.pod:6960
35783 msgid "guestfs_tail"
35787 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6962
35788 #: ../src/guestfs-actions.pod:6962
35792 " guestfs_tail (guestfs_h *g,\n"
35793 " const char *path);\n"
35798 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6978
35799 #: ../src/guestfs-actions.pod:6978
35800 msgid "guestfs_tail_n"
35804 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:6980
35805 #: ../src/guestfs-actions.pod:6980
35809 " guestfs_tail_n (guestfs_h *g,\n"
35811 " const char *path);\n"
35816 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7002
35817 #: ../src/guestfs-actions.pod:7002
35818 msgid "guestfs_tar_in"
35822 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7004
35823 #: ../src/guestfs-actions.pod:7004
35827 " guestfs_tar_in (guestfs_h *g,\n"
35828 " const char *tarfile,\n"
35829 " const char *directory);\n"
35834 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7012
35835 #: ../src/guestfs-actions.pod:7012
35837 "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
35841 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7017
35842 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7034
35843 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7050
35844 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7066
35845 #: ../src/guestfs-actions.pod:7017 ../src/guestfs-actions.pod:7034
35846 #: ../src/guestfs-actions.pod:7050 ../src/guestfs-actions.pod:7066
35847 msgid "(Added in 1.0.3)"
35851 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7019
35852 #: ../src/guestfs-actions.pod:7019
35853 msgid "guestfs_tar_out"
35857 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7021
35858 #: ../src/guestfs-actions.pod:7021
35862 " guestfs_tar_out (guestfs_h *g,\n"
35863 " const char *directory,\n"
35864 " const char *tarfile);\n"
35869 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7029
35870 #: ../src/guestfs-actions.pod:7029
35872 "To download a compressed tarball, use C<guestfs_tgz_out> or "
35873 "C<guestfs_txz_out>."
35877 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7036
35878 #: ../src/guestfs-actions.pod:7036
35879 msgid "guestfs_tgz_in"
35883 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7038
35884 #: ../src/guestfs-actions.pod:7038
35888 " guestfs_tgz_in (guestfs_h *g,\n"
35889 " const char *tarball,\n"
35890 " const char *directory);\n"
35895 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7046
35896 #: ../src/guestfs-actions.pod:7046
35897 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
35901 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7052
35902 #: ../src/guestfs-actions.pod:7052
35903 msgid "guestfs_tgz_out"
35907 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7054
35908 #: ../src/guestfs-actions.pod:7054
35912 " guestfs_tgz_out (guestfs_h *g,\n"
35913 " const char *directory,\n"
35914 " const char *tarball);\n"
35919 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7062
35920 #: ../src/guestfs-actions.pod:7062
35921 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
35925 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7068
35926 #: ../src/guestfs-actions.pod:7068
35927 msgid "guestfs_touch"
35931 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7070
35932 #: ../src/guestfs-actions.pod:7070
35936 " guestfs_touch (guestfs_h *g,\n"
35937 " const char *path);\n"
35942 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7085
35943 #: ../src/guestfs-actions.pod:7085
35944 msgid "guestfs_truncate"
35948 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7087
35949 #: ../src/guestfs-actions.pod:7087
35953 " guestfs_truncate (guestfs_h *g,\n"
35954 " const char *path);\n"
35959 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7098
35960 #: ../src/guestfs-actions.pod:7098
35961 msgid "guestfs_truncate_size"
35965 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7100
35966 #: ../src/guestfs-actions.pod:7100
35970 " guestfs_truncate_size (guestfs_h *g,\n"
35971 " const char *path,\n"
35972 " int64_t size);\n"
35977 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7108
35978 #: ../src/guestfs-actions.pod:7108
35980 "If the current file size is less than C<size> then the file is extended to "
35981 "the required size with zero bytes. This creates a sparse file (ie. disk "
35982 "blocks are not allocated for the file until you write to it). To create a "
35983 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
35987 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7118
35988 #: ../src/guestfs-actions.pod:7118
35989 msgid "guestfs_tune2fs_l"
35993 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7120
35994 #: ../src/guestfs-actions.pod:7120
35998 " guestfs_tune2fs_l (guestfs_h *g,\n"
35999 " const char *device);\n"
36004 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7140
36005 #: ../src/guestfs-actions.pod:7140
36006 msgid "guestfs_txz_in"
36010 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7142
36011 #: ../src/guestfs-actions.pod:7142
36015 " guestfs_txz_in (guestfs_h *g,\n"
36016 " const char *tarball,\n"
36017 " const char *directory);\n"
36022 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7154
36023 #: ../src/guestfs-actions.pod:7154
36024 msgid "guestfs_txz_out"
36028 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7156
36029 #: ../src/guestfs-actions.pod:7156
36033 " guestfs_txz_out (guestfs_h *g,\n"
36034 " const char *directory,\n"
36035 " const char *tarball);\n"
36040 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7168
36041 #: ../src/guestfs-actions.pod:7168
36042 msgid "guestfs_umask"
36046 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7170
36047 #: ../src/guestfs-actions.pod:7170
36051 " guestfs_umask (guestfs_h *g,\n"
36057 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7186
36058 #: ../src/guestfs-actions.pod:7186
36060 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
36061 "C<guestfs_mkdir>."
36065 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7195
36066 #: ../src/guestfs-actions.pod:7195
36067 msgid "guestfs_umount"
36071 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7197
36072 #: ../src/guestfs-actions.pod:7197
36076 " guestfs_umount (guestfs_h *g,\n"
36077 " const char *pathordevice);\n"
36082 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7209
36083 #: ../src/guestfs-actions.pod:7209
36084 msgid "guestfs_umount_all"
36088 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7211
36089 #: ../src/guestfs-actions.pod:7211
36093 " guestfs_umount_all (guestfs_h *g);\n"
36098 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7222
36099 #: ../src/guestfs-actions.pod:7222
36100 msgid "guestfs_upload"
36104 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7224
36105 #: ../src/guestfs-actions.pod:7224
36109 " guestfs_upload (guestfs_h *g,\n"
36110 " const char *filename,\n"
36111 " const char *remotefilename);\n"
36116 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7234
36117 #: ../src/guestfs-actions.pod:7234
36118 msgid "See also C<guestfs_download>."
36122 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7245
36123 #: ../src/guestfs-actions.pod:7245
36124 msgid "guestfs_upload_offset"
36128 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7247
36129 #: ../src/guestfs-actions.pod:7247
36133 " guestfs_upload_offset (guestfs_h *g,\n"
36134 " const char *filename,\n"
36135 " const char *remotefilename,\n"
36136 " int64_t offset);\n"
36141 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7263
36142 #: ../src/guestfs-actions.pod:7263
36144 "Note that there is no limit on the amount of data that can be uploaded with "
36145 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
36146 "full amount unless an error occurs."
36150 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7268
36151 #: ../src/guestfs-actions.pod:7268
36152 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
36156 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7279
36157 #: ../src/guestfs-actions.pod:7279
36158 msgid "guestfs_utimens"
36162 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7281
36163 #: ../src/guestfs-actions.pod:7281
36167 " guestfs_utimens (guestfs_h *g,\n"
36168 " const char *path,\n"
36169 " int64_t atsecs,\n"
36170 " int64_t atnsecs,\n"
36171 " int64_t mtsecs,\n"
36172 " int64_t mtnsecs);\n"
36177 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7310
36178 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:175
36179 #: ../src/guestfs-actions.pod:7310 ../src/guestfs-structs.pod:175
36180 msgid "guestfs_version"
36184 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7312
36185 #: ../src/guestfs-actions.pod:7312
36188 " struct guestfs_version *\n"
36189 " guestfs_version (guestfs_h *g);\n"
36194 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7340
36195 #: ../src/guestfs-actions.pod:7340
36197 "I<Note:> Don't use this call to test for availability of features. In "
36198 "enterprise distributions we backport features from later versions into "
36199 "earlier versions, making this an unreliable way to test for features. Use "
36200 "C<guestfs_available> instead."
36204 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7346
36205 #: ../src/guestfs-actions.pod:7346
36207 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
36208 "error. I<The caller must call C<guestfs_free_version> after use>."
36212 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7350
36213 #: ../src/guestfs-actions.pod:7350
36214 msgid "(Added in 1.0.58)"
36218 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7352
36219 #: ../src/guestfs-actions.pod:7352
36220 msgid "guestfs_vfs_label"
36224 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7354
36225 #: ../src/guestfs-actions.pod:7354
36229 " guestfs_vfs_label (guestfs_h *g,\n"
36230 " const char *device);\n"
36235 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7363
36236 #: ../src/guestfs-actions.pod:7363
36237 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
36241 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7368
36242 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7405
36243 #: ../src/guestfs-actions.pod:7368 ../src/guestfs-actions.pod:7405
36244 msgid "(Added in 1.3.18)"
36248 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7370
36249 #: ../src/guestfs-actions.pod:7370
36250 msgid "guestfs_vfs_type"
36254 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7372
36255 #: ../src/guestfs-actions.pod:7372
36259 " guestfs_vfs_type (guestfs_h *g,\n"
36260 " const char *device);\n"
36265 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7389
36266 #: ../src/guestfs-actions.pod:7389
36267 msgid "guestfs_vfs_uuid"
36271 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7391
36272 #: ../src/guestfs-actions.pod:7391
36276 " guestfs_vfs_uuid (guestfs_h *g,\n"
36277 " const char *device);\n"
36282 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7400
36283 #: ../src/guestfs-actions.pod:7400
36284 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
36288 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7407
36289 #: ../src/guestfs-actions.pod:7407
36290 msgid "guestfs_vg_activate"
36294 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7409
36295 #: ../src/guestfs-actions.pod:7409
36299 " guestfs_vg_activate (guestfs_h *g,\n"
36301 " char *const *volgroups);\n"
36306 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7426
36307 #: ../src/guestfs-actions.pod:7426
36308 msgid "guestfs_vg_activate_all"
36312 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7428
36313 #: ../src/guestfs-actions.pod:7428
36317 " guestfs_vg_activate_all (guestfs_h *g,\n"
36318 " int activate);\n"
36323 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7441
36324 #: ../src/guestfs-actions.pod:7441
36325 msgid "guestfs_vgcreate"
36329 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7443
36330 #: ../src/guestfs-actions.pod:7443
36334 " guestfs_vgcreate (guestfs_h *g,\n"
36335 " const char *volgroup,\n"
36336 " char *const *physvols);\n"
36341 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7455
36342 #: ../src/guestfs-actions.pod:7455
36343 msgid "guestfs_vglvuuids"
36347 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7457
36348 #: ../src/guestfs-actions.pod:7457
36352 " guestfs_vglvuuids (guestfs_h *g,\n"
36353 " const char *vgname);\n"
36358 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7464
36359 #: ../src/guestfs-actions.pod:7464
36361 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
36362 "associate logical volumes and volume groups."
36366 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7467
36367 #: ../src/guestfs-actions.pod:7467
36368 msgid "See also C<guestfs_vgpvuuids>."
36372 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7475
36373 #: ../src/guestfs-actions.pod:7475
36374 msgid "guestfs_vgpvuuids"
36378 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7477
36379 #: ../src/guestfs-actions.pod:7477
36383 " guestfs_vgpvuuids (guestfs_h *g,\n"
36384 " const char *vgname);\n"
36389 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7484
36390 #: ../src/guestfs-actions.pod:7484
36392 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
36393 "associate physical volumes and volume groups."
36397 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7487
36398 #: ../src/guestfs-actions.pod:7487
36399 msgid "See also C<guestfs_vglvuuids>."
36403 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7495
36404 #: ../src/guestfs-actions.pod:7495
36405 msgid "guestfs_vgremove"
36409 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7497
36410 #: ../src/guestfs-actions.pod:7497
36414 " guestfs_vgremove (guestfs_h *g,\n"
36415 " const char *vgname);\n"
36420 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7510
36421 #: ../src/guestfs-actions.pod:7510
36422 msgid "guestfs_vgrename"
36426 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7512
36427 #: ../src/guestfs-actions.pod:7512
36431 " guestfs_vgrename (guestfs_h *g,\n"
36432 " const char *volgroup,\n"
36433 " const char *newvolgroup);\n"
36438 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7523
36439 #: ../src/guestfs-actions.pod:7523
36440 msgid "guestfs_vgs"
36444 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7525
36445 #: ../src/guestfs-actions.pod:7525
36449 " guestfs_vgs (guestfs_h *g);\n"
36454 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7534
36455 #: ../src/guestfs-actions.pod:7534
36456 msgid "See also C<guestfs_vgs_full>."
36460 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7542
36461 #: ../src/guestfs-actions.pod:7542
36462 msgid "guestfs_vgs_full"
36466 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7544
36467 #: ../src/guestfs-actions.pod:7544
36470 " struct guestfs_lvm_vg_list *\n"
36471 " guestfs_vgs_full (guestfs_h *g);\n"
36476 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7550
36477 #: ../src/guestfs-actions.pod:7550
36479 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
36480 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after use>."
36484 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7556
36485 #: ../src/guestfs-actions.pod:7556
36486 msgid "guestfs_vgscan"
36490 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7558
36491 #: ../src/guestfs-actions.pod:7558
36495 " guestfs_vgscan (guestfs_h *g);\n"
36500 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7568
36501 #: ../src/guestfs-actions.pod:7568
36502 msgid "guestfs_vguuid"
36506 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7570
36507 #: ../src/guestfs-actions.pod:7570
36511 " guestfs_vguuid (guestfs_h *g,\n"
36512 " const char *vgname);\n"
36517 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7581
36518 #: ../src/guestfs-actions.pod:7581
36519 msgid "guestfs_wait_ready"
36523 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7583
36524 #: ../src/guestfs-actions.pod:7583
36528 " guestfs_wait_ready (guestfs_h *g);\n"
36533 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7586
36534 #: ../src/guestfs-actions.pod:7586
36535 msgid "This function is a no op."
36539 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7588
36540 #: ../src/guestfs-actions.pod:7588
36542 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
36543 "calling C<guestfs_launch> to wait for the launch to complete. However this "
36544 "is no longer necessary because C<guestfs_launch> now does the waiting."
36548 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7593
36549 #: ../src/guestfs-actions.pod:7593
36551 "If you see any calls to this function in code then you can just remove them, "
36552 "unless you want to retain compatibility with older versions of the API."
36556 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7599
36557 #: ../src/guestfs-actions.pod:7599
36559 "This function is deprecated. In new code, use the C<launch> call instead."
36563 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7608
36564 #: ../src/guestfs-actions.pod:7608
36565 msgid "guestfs_wc_c"
36569 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7610
36570 #: ../src/guestfs-actions.pod:7610
36574 " guestfs_wc_c (guestfs_h *g,\n"
36575 " const char *path);\n"
36580 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7621
36581 #: ../src/guestfs-actions.pod:7621
36582 msgid "guestfs_wc_l"
36586 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7623
36587 #: ../src/guestfs-actions.pod:7623
36591 " guestfs_wc_l (guestfs_h *g,\n"
36592 " const char *path);\n"
36597 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7634
36598 #: ../src/guestfs-actions.pod:7634
36599 msgid "guestfs_wc_w"
36603 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7636
36604 #: ../src/guestfs-actions.pod:7636
36608 " guestfs_wc_w (guestfs_h *g,\n"
36609 " const char *path);\n"
36614 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7647
36615 #: ../src/guestfs-actions.pod:7647
36616 msgid "guestfs_write"
36620 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7649
36621 #: ../src/guestfs-actions.pod:7649
36625 " guestfs_write (guestfs_h *g,\n"
36626 " const char *path,\n"
36627 " const char *content,\n"
36628 " size_t content_size);\n"
36633 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7658
36634 #: ../src/guestfs-actions.pod:7658
36635 msgid "See also C<guestfs_write_append>."
36639 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7667
36640 #: ../src/guestfs-actions.pod:7667
36641 msgid "guestfs_write_append"
36645 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7669
36646 #: ../src/guestfs-actions.pod:7669
36650 " guestfs_write_append (guestfs_h *g,\n"
36651 " const char *path,\n"
36652 " const char *content,\n"
36653 " size_t content_size);\n"
36658 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7678
36659 #: ../src/guestfs-actions.pod:7678
36660 msgid "See also C<guestfs_write>."
36664 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7687
36665 #: ../src/guestfs-actions.pod:7687
36666 msgid "guestfs_write_file"
36670 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7689
36671 #: ../src/guestfs-actions.pod:7689
36675 " guestfs_write_file (guestfs_h *g,\n"
36676 " const char *path,\n"
36677 " const char *content,\n"
36683 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7720
36684 #: ../src/guestfs-actions.pod:7720
36685 msgid "guestfs_zegrep"
36689 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7722
36690 #: ../src/guestfs-actions.pod:7722
36694 " guestfs_zegrep (guestfs_h *g,\n"
36695 " const char *regex,\n"
36696 " const char *path);\n"
36701 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7739
36702 #: ../src/guestfs-actions.pod:7739
36703 msgid "guestfs_zegrepi"
36707 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7741
36708 #: ../src/guestfs-actions.pod:7741
36712 " guestfs_zegrepi (guestfs_h *g,\n"
36713 " const char *regex,\n"
36714 " const char *path);\n"
36719 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7758
36720 #: ../src/guestfs-actions.pod:7758
36721 msgid "guestfs_zero"
36725 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7760
36726 #: ../src/guestfs-actions.pod:7760
36730 " guestfs_zero (guestfs_h *g,\n"
36731 " const char *device);\n"
36736 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7770
36737 #: ../src/guestfs-actions.pod:7770
36739 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
36740 "C<guestfs_is_zero_device>"
36744 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7782
36745 #: ../src/guestfs-actions.pod:7782
36746 msgid "guestfs_zero_device"
36750 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7784
36751 #: ../src/guestfs-actions.pod:7784
36755 " guestfs_zero_device (guestfs_h *g,\n"
36756 " const char *device);\n"
36761 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7788
36762 #: ../src/guestfs-actions.pod:7788
36764 "This command writes zeroes over the entire C<device>. Compare with "
36765 "C<guestfs_zero> which just zeroes the first few blocks of a device."
36769 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7802
36770 #: ../src/guestfs-actions.pod:7802
36771 msgid "(Added in 1.3.1)"
36775 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7804
36776 #: ../src/guestfs-actions.pod:7804
36777 msgid "guestfs_zerofree"
36781 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7806
36782 #: ../src/guestfs-actions.pod:7806
36786 " guestfs_zerofree (guestfs_h *g,\n"
36787 " const char *device);\n"
36792 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7825
36793 #: ../src/guestfs-actions.pod:7825
36794 msgid "guestfs_zfgrep"
36798 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7827
36799 #: ../src/guestfs-actions.pod:7827
36803 " guestfs_zfgrep (guestfs_h *g,\n"
36804 " const char *pattern,\n"
36805 " const char *path);\n"
36810 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7844
36811 #: ../src/guestfs-actions.pod:7844
36812 msgid "guestfs_zfgrepi"
36816 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7846
36817 #: ../src/guestfs-actions.pod:7846
36821 " guestfs_zfgrepi (guestfs_h *g,\n"
36822 " const char *pattern,\n"
36823 " const char *path);\n"
36828 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7863
36829 #: ../src/guestfs-actions.pod:7863
36830 msgid "guestfs_zfile"
36834 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7865
36835 #: ../src/guestfs-actions.pod:7865
36839 " guestfs_zfile (guestfs_h *g,\n"
36840 " const char *meth,\n"
36841 " const char *path);\n"
36846 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7875
36847 #: ../src/guestfs-actions.pod:7875
36849 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
36854 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7890
36855 #: ../src/guestfs-actions.pod:7890
36856 msgid "guestfs_zgrep"
36860 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7892
36861 #: ../src/guestfs-actions.pod:7892
36865 " guestfs_zgrep (guestfs_h *g,\n"
36866 " const char *regex,\n"
36867 " const char *path);\n"
36872 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7909
36873 #: ../src/guestfs-actions.pod:7909
36874 msgid "guestfs_zgrepi"
36878 #: ../libguestfs-1.11.20/src/guestfs-actions.pod:7911
36879 #: ../src/guestfs-actions.pod:7911
36883 " guestfs_zgrepi (guestfs_h *g,\n"
36884 " const char *regex,\n"
36885 " const char *path);\n"
36890 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:3
36891 #: ../src/guestfs-availability.pod:3
36896 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:5
36897 #: ../src/guestfs-availability.pod:5
36899 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> L</"
36900 "guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> L</"
36901 "guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> L</"
36902 "guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> L</guestfs_aug_rm> "
36903 "L</guestfs_aug_save> L</guestfs_aug_set>"
36907 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:21
36908 #: ../src/guestfs-availability.pod:21
36913 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:23
36914 #: ../src/guestfs-availability.pod:23
36915 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
36919 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:26
36920 #: ../src/guestfs-availability.pod:26
36925 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:28
36926 #: ../src/guestfs-availability.pod:28
36928 "The following functions: L</guestfs_inotify_add_watch> L</"
36929 "guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> L</"
36930 "guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
36934 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:36
36935 #: ../src/guestfs-availability.pod:36
36936 msgid "B<linuxfsuuid>"
36940 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:38
36941 #: ../src/guestfs-availability.pod:38
36943 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> L</"
36944 "guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
36948 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:45
36949 #: ../src/guestfs-availability.pod:45
36950 msgid "B<linuxmodules>"
36954 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:47
36955 #: ../src/guestfs-availability.pod:47
36956 msgid "The following functions: L</guestfs_modprobe>"
36960 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:50
36961 #: ../src/guestfs-availability.pod:50
36962 msgid "B<linuxxattrs>"
36966 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:52
36967 #: ../src/guestfs-availability.pod:52
36969 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> L</"
36970 "guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> L</"
36971 "guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> L</"
36972 "guestfs_setxattr>"
36976 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:63
36977 #: ../src/guestfs-availability.pod:63
36982 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:65
36983 #: ../src/guestfs-availability.pod:65
36985 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> L</"
36986 "guestfs_luks_format> L</guestfs_luks_format_cipher> L</"
36987 "guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
36991 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:74
36992 #: ../src/guestfs-availability.pod:74
36997 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:76
36998 #: ../src/guestfs-availability.pod:76
37000 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> L</"
37001 "guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> L</"
37002 "guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> L</"
37003 "guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> L</"
37004 "guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> L</"
37005 "guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> L</"
37006 "guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> L</guestfs_vgs_full>"
37010 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:99
37011 #: ../src/guestfs-availability.pod:99
37016 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:101
37017 #: ../src/guestfs-availability.pod:101
37019 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> L</"
37020 "guestfs_mknod_b> L</guestfs_mknod_c>"
37024 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:107
37025 #: ../src/guestfs-availability.pod:107
37030 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:109
37031 #: ../src/guestfs-availability.pod:109
37032 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
37036 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:112
37037 #: ../src/guestfs-availability.pod:112
37038 msgid "B<ntfsprogs>"
37042 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:114
37043 #: ../src/guestfs-availability.pod:114
37045 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
37046 "L</guestfs_ntfsresize_size>"
37050 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:119
37051 #: ../src/guestfs-availability.pod:119
37052 msgid "B<realpath>"
37056 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:121
37057 #: ../src/guestfs-availability.pod:121
37058 msgid "The following functions: L</guestfs_realpath>"
37062 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:124
37063 #: ../src/guestfs-availability.pod:124
37068 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:126
37069 #: ../src/guestfs-availability.pod:126
37071 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> L</"
37072 "guestfs_scrub_freespace>"
37076 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:131
37077 #: ../src/guestfs-availability.pod:131
37082 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:133
37083 #: ../src/guestfs-availability.pod:133
37084 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
37088 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:137
37089 #: ../src/guestfs-availability.pod:137
37094 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:139
37095 #: ../src/guestfs-availability.pod:139
37096 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
37100 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:143
37101 #: ../src/guestfs-availability.pod:143
37102 msgid "B<zerofree>"
37106 #: ../libguestfs-1.11.20/src/guestfs-availability.pod:145
37107 #: ../src/guestfs-availability.pod:145
37108 msgid "The following functions: L</guestfs_zerofree>"
37112 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:1
37113 #: ../src/guestfs-structs.pod:1
37114 msgid "guestfs_int_bool"
37118 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:3
37119 #: ../src/guestfs-structs.pod:3
37122 " struct guestfs_int_bool {\n"
37130 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:8
37131 #: ../src/guestfs-structs.pod:8
37134 " struct guestfs_int_bool_list {\n"
37135 " uint32_t len; /* Number of elements in list. */\n"
37136 " struct guestfs_int_bool *val; /* Elements. */\n"
37142 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:13
37143 #: ../src/guestfs-structs.pod:13
37146 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
37147 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
37152 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:16
37153 #: ../src/guestfs-structs.pod:16
37154 msgid "guestfs_lvm_pv"
37158 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:18
37159 #: ../src/guestfs-structs.pod:18
37162 " struct guestfs_lvm_pv {\n"
37163 " char *pv_name;\n"
37164 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
37165 " char pv_uuid[32];\n"
37167 " uint64_t pv_size;\n"
37168 " uint64_t dev_size;\n"
37169 " uint64_t pv_free;\n"
37170 " uint64_t pv_used;\n"
37171 " char *pv_attr;\n"
37172 " int64_t pv_pe_count;\n"
37173 " int64_t pv_pe_alloc_count;\n"
37174 " char *pv_tags;\n"
37175 " uint64_t pe_start;\n"
37176 " int64_t pv_mda_count;\n"
37177 " uint64_t pv_mda_free;\n"
37183 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:36
37184 #: ../src/guestfs-structs.pod:36
37187 " struct guestfs_lvm_pv_list {\n"
37188 " uint32_t len; /* Number of elements in list. */\n"
37189 " struct guestfs_lvm_pv *val; /* Elements. */\n"
37195 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:41
37196 #: ../src/guestfs-structs.pod:41
37199 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
37200 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
37205 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:44
37206 #: ../src/guestfs-structs.pod:44
37207 msgid "guestfs_lvm_vg"
37211 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:46
37212 #: ../src/guestfs-structs.pod:46
37215 " struct guestfs_lvm_vg {\n"
37216 " char *vg_name;\n"
37217 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
37218 " char vg_uuid[32];\n"
37220 " char *vg_attr;\n"
37221 " uint64_t vg_size;\n"
37222 " uint64_t vg_free;\n"
37223 " char *vg_sysid;\n"
37224 " uint64_t vg_extent_size;\n"
37225 " int64_t vg_extent_count;\n"
37226 " int64_t vg_free_count;\n"
37227 " int64_t max_lv;\n"
37228 " int64_t max_pv;\n"
37229 " int64_t pv_count;\n"
37230 " int64_t lv_count;\n"
37231 " int64_t snap_count;\n"
37232 " int64_t vg_seqno;\n"
37233 " char *vg_tags;\n"
37234 " int64_t vg_mda_count;\n"
37235 " uint64_t vg_mda_free;\n"
37241 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:69
37242 #: ../src/guestfs-structs.pod:69
37245 " struct guestfs_lvm_vg_list {\n"
37246 " uint32_t len; /* Number of elements in list. */\n"
37247 " struct guestfs_lvm_vg *val; /* Elements. */\n"
37253 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:74
37254 #: ../src/guestfs-structs.pod:74
37257 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
37258 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
37263 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:77
37264 #: ../src/guestfs-structs.pod:77
37265 msgid "guestfs_lvm_lv"
37269 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:79
37270 #: ../src/guestfs-structs.pod:79
37273 " struct guestfs_lvm_lv {\n"
37274 " char *lv_name;\n"
37275 " /* The next field is NOT nul-terminated, be careful when printing it: */\n"
37276 " char lv_uuid[32];\n"
37277 " char *lv_attr;\n"
37278 " int64_t lv_major;\n"
37279 " int64_t lv_minor;\n"
37280 " int64_t lv_kernel_major;\n"
37281 " int64_t lv_kernel_minor;\n"
37282 " uint64_t lv_size;\n"
37283 " int64_t seg_count;\n"
37285 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
37286 " float snap_percent;\n"
37287 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
37288 " float copy_percent;\n"
37289 " char *move_pv;\n"
37290 " char *lv_tags;\n"
37291 " char *mirror_log;\n"
37292 " char *modules;\n"
37298 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:101
37299 #: ../src/guestfs-structs.pod:101
37302 " struct guestfs_lvm_lv_list {\n"
37303 " uint32_t len; /* Number of elements in list. */\n"
37304 " struct guestfs_lvm_lv *val; /* Elements. */\n"
37310 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:106
37311 #: ../src/guestfs-structs.pod:106
37314 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
37315 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
37320 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:111
37321 #: ../src/guestfs-structs.pod:111
37324 " struct guestfs_stat {\n"
37328 " int64_t nlink;\n"
37333 " int64_t blksize;\n"
37334 " int64_t blocks;\n"
37335 " int64_t atime;\n"
37336 " int64_t mtime;\n"
37337 " int64_t ctime;\n"
37343 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:127
37344 #: ../src/guestfs-structs.pod:127
37347 " struct guestfs_stat_list {\n"
37348 " uint32_t len; /* Number of elements in list. */\n"
37349 " struct guestfs_stat *val; /* Elements. */\n"
37355 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:132
37356 #: ../src/guestfs-structs.pod:132
37359 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
37360 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
37365 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:137
37366 #: ../src/guestfs-structs.pod:137
37369 " struct guestfs_statvfs {\n"
37370 " int64_t bsize;\n"
37371 " int64_t frsize;\n"
37372 " int64_t blocks;\n"
37373 " int64_t bfree;\n"
37374 " int64_t bavail;\n"
37375 " int64_t files;\n"
37376 " int64_t ffree;\n"
37377 " int64_t favail;\n"
37380 " int64_t namemax;\n"
37386 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:151
37387 #: ../src/guestfs-structs.pod:151
37390 " struct guestfs_statvfs_list {\n"
37391 " uint32_t len; /* Number of elements in list. */\n"
37392 " struct guestfs_statvfs *val; /* Elements. */\n"
37398 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:156
37399 #: ../src/guestfs-structs.pod:156
37402 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
37403 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
37408 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:159
37409 #: ../src/guestfs-structs.pod:159
37410 msgid "guestfs_dirent"
37414 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:161
37415 #: ../src/guestfs-structs.pod:161
37418 " struct guestfs_dirent {\n"
37427 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:167
37428 #: ../src/guestfs-structs.pod:167
37431 " struct guestfs_dirent_list {\n"
37432 " uint32_t len; /* Number of elements in list. */\n"
37433 " struct guestfs_dirent *val; /* Elements. */\n"
37439 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:172
37440 #: ../src/guestfs-structs.pod:172
37443 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
37444 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
37449 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:177
37450 #: ../src/guestfs-structs.pod:177
37453 " struct guestfs_version {\n"
37454 " int64_t major;\n"
37455 " int64_t minor;\n"
37456 " int64_t release;\n"
37463 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:184
37464 #: ../src/guestfs-structs.pod:184
37467 " struct guestfs_version_list {\n"
37468 " uint32_t len; /* Number of elements in list. */\n"
37469 " struct guestfs_version *val; /* Elements. */\n"
37475 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:189
37476 #: ../src/guestfs-structs.pod:189
37479 " void guestfs_free_version (struct guestfs_free_version *);\n"
37480 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
37485 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:192
37486 #: ../src/guestfs-structs.pod:192
37487 msgid "guestfs_xattr"
37491 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:194
37492 #: ../src/guestfs-structs.pod:194
37495 " struct guestfs_xattr {\n"
37496 " char *attrname;\n"
37497 " /* The next two fields describe a byte array. */\n"
37498 " uint32_t attrval_len;\n"
37499 " char *attrval;\n"
37505 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:201
37506 #: ../src/guestfs-structs.pod:201
37509 " struct guestfs_xattr_list {\n"
37510 " uint32_t len; /* Number of elements in list. */\n"
37511 " struct guestfs_xattr *val; /* Elements. */\n"
37517 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:206
37518 #: ../src/guestfs-structs.pod:206
37521 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
37522 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
37527 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:209
37528 #: ../src/guestfs-structs.pod:209
37529 msgid "guestfs_inotify_event"
37533 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:211
37534 #: ../src/guestfs-structs.pod:211
37537 " struct guestfs_inotify_event {\n"
37538 " int64_t in_wd;\n"
37539 " uint32_t in_mask;\n"
37540 " uint32_t in_cookie;\n"
37541 " char *in_name;\n"
37547 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:218
37548 #: ../src/guestfs-structs.pod:218
37551 " struct guestfs_inotify_event_list {\n"
37552 " uint32_t len; /* Number of elements in list. */\n"
37553 " struct guestfs_inotify_event *val; /* Elements. */\n"
37559 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:223
37560 #: ../src/guestfs-structs.pod:223
37563 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
37564 " void guestfs_free_inotify_event_list (struct guestfs_free_inotify_event_list *);\n"
37569 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:226
37570 #: ../src/guestfs-structs.pod:226
37571 msgid "guestfs_partition"
37575 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:228
37576 #: ../src/guestfs-structs.pod:228
37579 " struct guestfs_partition {\n"
37580 " int32_t part_num;\n"
37581 " uint64_t part_start;\n"
37582 " uint64_t part_end;\n"
37583 " uint64_t part_size;\n"
37589 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:235
37590 #: ../src/guestfs-structs.pod:235
37593 " struct guestfs_partition_list {\n"
37594 " uint32_t len; /* Number of elements in list. */\n"
37595 " struct guestfs_partition *val; /* Elements. */\n"
37601 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:240
37602 #: ../src/guestfs-structs.pod:240
37605 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
37606 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
37611 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:243
37612 #: ../src/guestfs-structs.pod:243
37613 msgid "guestfs_application"
37617 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:245
37618 #: ../src/guestfs-structs.pod:245
37621 " struct guestfs_application {\n"
37622 " char *app_name;\n"
37623 " char *app_display_name;\n"
37624 " int32_t app_epoch;\n"
37625 " char *app_version;\n"
37626 " char *app_release;\n"
37627 " char *app_install_path;\n"
37628 " char *app_trans_path;\n"
37629 " char *app_publisher;\n"
37630 " char *app_url;\n"
37631 " char *app_source_package;\n"
37632 " char *app_summary;\n"
37633 " char *app_description;\n"
37639 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:260
37640 #: ../src/guestfs-structs.pod:260
37643 " struct guestfs_application_list {\n"
37644 " uint32_t len; /* Number of elements in list. */\n"
37645 " struct guestfs_application *val; /* Elements. */\n"
37651 #: ../libguestfs-1.11.20/src/guestfs-structs.pod:265
37652 #: ../src/guestfs-structs.pod:265
37655 " void guestfs_free_application (struct guestfs_free_application *);\n"
37656 " void guestfs_free_application_list (struct guestfs_free_application_list *);\n"
37661 #: ../libguestfs-1.11.20/src/guestfs.pod:5 ../src/guestfs.pod:5
37662 msgid "guestfs - Library for accessing and modifying virtual machine images"
37666 #: ../libguestfs-1.11.20/src/guestfs.pod:11 ../src/guestfs.pod:11
37669 " guestfs_h *g = guestfs_create ();\n"
37670 " guestfs_add_drive (g, \"guest.img\");\n"
37671 " guestfs_launch (g);\n"
37672 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
37673 " guestfs_touch (g, \"/hello\");\n"
37674 " guestfs_umount (g, \"/\");\n"
37675 " guestfs_close (g);\n"
37680 #: ../libguestfs-1.11.20/src/guestfs.pod:25 ../src/guestfs.pod:25
37682 "Libguestfs is a library for accessing and modifying guest disk images. "
37683 "Amongst the things this is good for: making batch configuration changes to "
37684 "guests, getting disk used/free statistics (see also: virt-df), migrating "
37685 "between virtualization systems (see also: virt-p2v), performing partial "
37686 "backups, performing partial guest clones, cloning guests and changing "
37687 "registry/UUID/hostname info, and much else besides."
37691 #: ../libguestfs-1.11.20/src/guestfs.pod:33 ../src/guestfs.pod:33
37693 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
37694 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
37695 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
37700 #: ../libguestfs-1.11.20/src/guestfs.pod:38 ../src/guestfs.pod:38
37702 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
37703 "what filesystem is in each LV, etc.). It can also run commands in the "
37704 "context of the guest. Also you can access filesystems over FUSE."
37708 #: ../libguestfs-1.11.20/src/guestfs.pod:43 ../src/guestfs.pod:43
37710 "Libguestfs is a library that can be linked with C and C++ management "
37711 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
37712 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
37717 #: ../libguestfs-1.11.20/src/guestfs.pod:48 ../src/guestfs.pod:48
37719 "You don't need to be root to use libguestfs, although obviously you do need "
37720 "enough permissions to access the disk images."
37724 #: ../libguestfs-1.11.20/src/guestfs.pod:51 ../src/guestfs.pod:51
37726 "Libguestfs is a large API because it can do many things. For a gentle "
37727 "introduction, please read the L</API OVERVIEW> section next."
37731 #: ../libguestfs-1.11.20/src/guestfs.pod:54 ../src/guestfs.pod:54
37733 "There are also some example programs in the L<guestfs-examples(3)> manual "
37738 #: ../libguestfs-1.11.20/src/guestfs.pod:57 ../src/guestfs.pod:57
37739 msgid "API OVERVIEW"
37743 #: ../libguestfs-1.11.20/src/guestfs.pod:59 ../src/guestfs.pod:59
37745 "This section provides a gentler overview of the libguestfs API. We also try "
37746 "to group API calls together, where that may not be obvious from reading "
37747 "about the individual calls in the main section of this manual."
37751 #: ../libguestfs-1.11.20/src/guestfs.pod:64 ../src/guestfs.pod:64
37756 #: ../libguestfs-1.11.20/src/guestfs.pod:66 ../src/guestfs.pod:66
37758 "Before you can use libguestfs calls, you have to create a handle. Then you "
37759 "must add at least one disk image to the handle, followed by launching the "
37760 "handle, then performing whatever operations you want, and finally closing "
37761 "the handle. By convention we use the single letter C<g> for the name of the "
37762 "handle variable, although of course you can use any name you want."
37766 #: ../libguestfs-1.11.20/src/guestfs.pod:73 ../src/guestfs.pod:73
37767 msgid "The general structure of all libguestfs-using programs looks like this:"
37771 #: ../libguestfs-1.11.20/src/guestfs.pod:76 ../src/guestfs.pod:76
37774 " guestfs_h *g = guestfs_create ();\n"
37779 #: ../libguestfs-1.11.20/src/guestfs.pod:78 ../src/guestfs.pod:78
37782 " /* Call guestfs_add_drive additional times if there are\n"
37783 " * multiple disk images.\n"
37785 " guestfs_add_drive (g, \"guest.img\");\n"
37790 #: ../libguestfs-1.11.20/src/guestfs.pod:83 ../src/guestfs.pod:83
37793 " /* Most manipulation calls won't work until you've launched\n"
37794 " * the handle 'g'. You have to do this _after_ adding drives\n"
37795 " * and _before_ other commands.\n"
37797 " guestfs_launch (g);\n"
37802 #: ../libguestfs-1.11.20/src/guestfs.pod:89 ../src/guestfs.pod:89
37805 " /* Now you can examine what partitions, LVs etc are available.\n"
37807 " char **partitions = guestfs_list_partitions (g);\n"
37808 " char **logvols = guestfs_lvs (g);\n"
37813 #: ../libguestfs-1.11.20/src/guestfs.pod:94 ../src/guestfs.pod:94
37816 " /* To access a filesystem in the image, you must mount it.\n"
37818 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
37823 #: ../libguestfs-1.11.20/src/guestfs.pod:98 ../src/guestfs.pod:98
37826 " /* Now you can perform filesystem actions on the guest\n"
37829 " guestfs_touch (g, \"/hello\");\n"
37834 #: ../libguestfs-1.11.20/src/guestfs.pod:103 ../src/guestfs.pod:103
37837 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
37838 " * it is done automatically when you close the handle. See\n"
37839 " * discussion of autosync in this page.\n"
37841 " guestfs_sync (g);\n"
37846 #: ../libguestfs-1.11.20/src/guestfs.pod:109 ../src/guestfs.pod:109
37849 " /* Close the handle 'g'. */\n"
37850 " guestfs_close (g);\n"
37855 #: ../libguestfs-1.11.20/src/guestfs.pod:112 ../src/guestfs.pod:112
37857 "The code above doesn't include any error checking. In real code you should "
37858 "check return values carefully for errors. In general all functions that "
37859 "return integers return C<-1> on error, and all functions that return "
37860 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
37861 "how to handle errors, and consult the documentation for each function call "
37862 "below to see precisely how they return error indications. See L<guestfs-"
37863 "examples(3)> for fully worked examples."
37867 #: ../libguestfs-1.11.20/src/guestfs.pod:121 ../src/guestfs.pod:121
37868 msgid "DISK IMAGES"
37872 #: ../libguestfs-1.11.20/src/guestfs.pod:123 ../src/guestfs.pod:123
37874 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
37875 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
37876 "actual block device, or simply an empty file of zeroes that you have created "
37877 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
37882 #: ../libguestfs-1.11.20/src/guestfs.pod:129 ../src/guestfs.pod:129
37884 "The call you should use in modern code for adding drives is L</"
37885 "guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
37886 "specifying that the format is raw, do:"
37890 #: ../libguestfs-1.11.20/src/guestfs.pod:133 ../src/guestfs.pod:133
37893 " guestfs_add_drive_opts (g, filename,\n"
37894 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
37900 #: ../libguestfs-1.11.20/src/guestfs.pod:137 ../src/guestfs.pod:137
37901 msgid "You can add a disk read-only using:"
37905 #: ../libguestfs-1.11.20/src/guestfs.pod:139 ../src/guestfs.pod:139
37908 " guestfs_add_drive_opts (g, filename,\n"
37909 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
37910 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
37916 #: ../libguestfs-1.11.20/src/guestfs.pod:144 ../src/guestfs.pod:144
37918 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
37919 "libguestfs won't modify the file."
37923 #: ../libguestfs-1.11.20/src/guestfs.pod:147 ../src/guestfs.pod:147
37925 "Be extremely cautious if the disk image is in use, eg. if it is being used "
37926 "by a virtual machine. Adding it read-write will almost certainly cause disk "
37927 "corruption, but adding it read-only is safe."
37931 #: ../libguestfs-1.11.20/src/guestfs.pod:151 ../src/guestfs.pod:151
37933 "You must add at least one disk image, and you may add multiple disk images. "
37934 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
37935 "first one you added), C</dev/sdb> (for the second one you added), etc."
37939 #: ../libguestfs-1.11.20/src/guestfs.pod:156 ../src/guestfs.pod:156
37941 "Once L</guestfs_launch> has been called you cannot add any more images. You "
37942 "can call L</guestfs_list_devices> to get a list of the device names, in the "
37943 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
37947 #: ../libguestfs-1.11.20/src/guestfs.pod:161 ../src/guestfs.pod:161
37952 #: ../libguestfs-1.11.20/src/guestfs.pod:163 ../src/guestfs.pod:163
37954 "Before you can read or write files, create directories and so on in a disk "
37955 "image that contains filesystems, you have to mount those filesystems using "
37956 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
37957 "a disk image contains (for example) one partition with a filesystem on that "
37958 "partition, then you can mount it directly:"
37962 #: ../libguestfs-1.11.20/src/guestfs.pod:170 ../src/guestfs.pod:170
37965 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
37970 #: ../libguestfs-1.11.20/src/guestfs.pod:172 ../src/guestfs.pod:172
37972 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
37973 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
37974 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
37975 "that these are libguestfs virtual devices, and are nothing to do with host "
37980 #: ../libguestfs-1.11.20/src/guestfs.pod:178 ../src/guestfs.pod:178
37982 "If you are given a disk image and you don't know what it contains then you "
37983 "have to find out. Libguestfs can do that too: use L</"
37984 "guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions and "
37985 "LVs, and either try mounting each to see what is mountable, or else examine "
37986 "them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
37987 "filesystems, use L</guestfs_list_filesystems>."
37991 #: ../libguestfs-1.11.20/src/guestfs.pod:186 ../src/guestfs.pod:186
37993 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
37994 "L</INSPECTION> below). But you might find it easier to look at higher level "
37995 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
37999 #: ../libguestfs-1.11.20/src/guestfs.pod:191 ../src/guestfs.pod:191
38001 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
38002 "several other variations of the C<guestfs_mount_*> call."
38006 #: ../libguestfs-1.11.20/src/guestfs.pod:194 ../src/guestfs.pod:194
38007 msgid "FILESYSTEM ACCESS AND MODIFICATION"
38011 #: ../libguestfs-1.11.20/src/guestfs.pod:196 ../src/guestfs.pod:196
38013 "The majority of the libguestfs API consists of fairly low-level calls for "
38014 "accessing and modifying the files, directories, symlinks etc on mounted "
38015 "filesystems. There are over a hundred such calls which you can find listed "
38016 "in detail below in this man page, and we don't even pretend to cover them "
38017 "all in this overview."
38021 #: ../libguestfs-1.11.20/src/guestfs.pod:202 ../src/guestfs.pod:202
38023 "Specify filenames as full paths, starting with C<\"/\"> and including the "
38028 #: ../libguestfs-1.11.20/src/guestfs.pod:205 ../src/guestfs.pod:205
38030 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
38031 "the file called C<\"etc/passwd\"> then you could do:"
38035 #: ../libguestfs-1.11.20/src/guestfs.pod:208 ../src/guestfs.pod:208
38038 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
38043 #: ../libguestfs-1.11.20/src/guestfs.pod:210 ../src/guestfs.pod:210
38045 "This would return C<data> as a newly allocated buffer containing the full "
38046 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
38047 "or C<NULL> if there was an error."
38051 #: ../libguestfs-1.11.20/src/guestfs.pod:214 ../src/guestfs.pod:214
38053 "As another example, to create a top-level directory on that filesystem "
38054 "called C<\"var\"> you would do:"
38058 #: ../libguestfs-1.11.20/src/guestfs.pod:217 ../src/guestfs.pod:217
38061 " guestfs_mkdir (g, \"/var\");\n"
38066 #: ../libguestfs-1.11.20/src/guestfs.pod:219 ../src/guestfs.pod:219
38067 msgid "To create a symlink you could do:"
38071 #: ../libguestfs-1.11.20/src/guestfs.pod:221 ../src/guestfs.pod:221
38074 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
38075 " \"/etc/rc3.d/S30portmap\");\n"
38080 #: ../libguestfs-1.11.20/src/guestfs.pod:224 ../src/guestfs.pod:224
38082 "Libguestfs will reject attempts to use relative paths and there is no "
38083 "concept of a current working directory."
38087 #: ../libguestfs-1.11.20/src/guestfs.pod:227 ../src/guestfs.pod:227
38089 "Libguestfs can return errors in many situations: for example if the "
38090 "filesystem isn't writable, or if a file or directory that you requested "
38091 "doesn't exist. If you are using the C API (documented here) you have to "
38092 "check for those error conditions after each call. (Other language bindings "
38093 "turn these errors into exceptions)."
38097 #: ../libguestfs-1.11.20/src/guestfs.pod:233 ../src/guestfs.pod:233
38099 "File writes are affected by the per-handle umask, set by calling L</"
38100 "guestfs_umask> and defaulting to 022. See L</UMASK>."
38104 #: ../libguestfs-1.11.20/src/guestfs.pod:236 ../src/guestfs.pod:236
38105 msgid "PARTITIONING"
38109 #: ../libguestfs-1.11.20/src/guestfs.pod:238 ../src/guestfs.pod:238
38111 "Libguestfs contains API calls to read, create and modify partition tables on "
38116 #: ../libguestfs-1.11.20/src/guestfs.pod:241 ../src/guestfs.pod:241
38118 "In the common case where you want to create a single partition covering the "
38119 "whole disk, you should use the L</guestfs_part_disk> call:"
38123 #: ../libguestfs-1.11.20/src/guestfs.pod:245 ../src/guestfs.pod:245
38126 " const char *parttype = \"mbr\";\n"
38127 " if (disk_is_larger_than_2TB)\n"
38128 " parttype = \"gpt\";\n"
38129 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
38134 #: ../libguestfs-1.11.20/src/guestfs.pod:250 ../src/guestfs.pod:250
38136 "Obviously this effectively wipes anything that was on that disk image before."
38140 #: ../libguestfs-1.11.20/src/guestfs.pod:253 ../src/guestfs.pod:253
38145 #: ../libguestfs-1.11.20/src/guestfs.pod:255 ../src/guestfs.pod:255
38147 "Libguestfs provides access to a large part of the LVM2 API, such as L</"
38148 "guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense unless "
38149 "you familiarize yourself with the concepts of physical volumes, volume "
38150 "groups and logical volumes."
38154 #: ../libguestfs-1.11.20/src/guestfs.pod:260 ../src/guestfs.pod:260
38156 "This author strongly recommends reading the LVM HOWTO, online at L<http://"
38157 "tldp.org/HOWTO/LVM-HOWTO/>."
38161 #: ../libguestfs-1.11.20/src/guestfs.pod:263 ../src/guestfs.pod:263
38162 msgid "DOWNLOADING"
38166 #: ../libguestfs-1.11.20/src/guestfs.pod:265 ../src/guestfs.pod:265
38168 "Use L</guestfs_cat> to download small, text only files. This call is "
38169 "limited to files which are less than 2 MB and which cannot contain any ASCII "
38170 "NUL (C<\\0>) characters. However the API is very simple to use."
38174 #: ../libguestfs-1.11.20/src/guestfs.pod:269 ../src/guestfs.pod:269
38176 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
38177 "bit data, since it returns a (pointer, size) pair. However it is still "
38178 "limited to \"small\" files, less than 2 MB."
38182 #: ../libguestfs-1.11.20/src/guestfs.pod:273 ../src/guestfs.pod:273
38184 "L</guestfs_download> can be used to download any file, with no limits on "
38185 "content or size (even files larger than 4 GB)."
38189 #: ../libguestfs-1.11.20/src/guestfs.pod:276 ../src/guestfs.pod:276
38191 "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
38195 #: ../libguestfs-1.11.20/src/guestfs.pod:279 ../src/guestfs.pod:279
38200 #: ../libguestfs-1.11.20/src/guestfs.pod:281 ../src/guestfs.pod:281
38202 "It's often the case that you want to write a file or files to the disk image."
38206 #: ../libguestfs-1.11.20/src/guestfs.pod:284 ../src/guestfs.pod:284
38208 "To write a small file with fixed content, use L</guestfs_write>. To create "
38209 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or L</"
38210 "guestfs_fallocate64> (with all disk blocks allocated). There are a variety "
38211 "of other functions for creating test files, for example L</guestfs_fill> and "
38212 "L</guestfs_fill_pattern>."
38216 #: ../libguestfs-1.11.20/src/guestfs.pod:290 ../src/guestfs.pod:290
38218 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
38219 "file content or size (even files larger than 4 GB)."
38223 #: ../libguestfs-1.11.20/src/guestfs.pod:293 ../src/guestfs.pod:293
38225 "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
38229 #: ../libguestfs-1.11.20/src/guestfs.pod:295 ../src/guestfs.pod:295
38231 "However the fastest way to upload I<large numbers of arbitrary files> is to "
38232 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and L<mkisofs(8)"
38233 ">), then attach this using L</guestfs_add_drive_ro>. If you add the drive "
38234 "in a predictable way (eg. adding it last after all other drives) then you "
38235 "can get the device name from L</guestfs_list_devices> and mount it directly "
38236 "using L</guestfs_mount_ro>. Note that squashfs images are sometimes non-"
38237 "portable between kernel versions, and they don't support labels or UUIDs. "
38238 "If you want to pre-build an image or you need to mount it using a label or "
38239 "UUID, use an ISO image instead."
38243 #: ../libguestfs-1.11.20/src/guestfs.pod:306 ../src/guestfs.pod:306
38248 #: ../libguestfs-1.11.20/src/guestfs.pod:308 ../src/guestfs.pod:308
38250 "There are various different commands for copying between files and devices "
38251 "and in and out of the guest filesystem. These are summarised in the table "
38256 #: ../libguestfs-1.11.20/src/guestfs.pod:314 ../src/guestfs.pod:314
38257 msgid "B<file> to B<file>"
38261 #: ../libguestfs-1.11.20/src/guestfs.pod:316 ../src/guestfs.pod:316
38263 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
38264 "directories recursively."
38268 #: ../libguestfs-1.11.20/src/guestfs.pod:319 ../src/guestfs.pod:319
38269 msgid "B<file or device> to B<file or device>"
38273 #: ../libguestfs-1.11.20/src/guestfs.pod:321 ../src/guestfs.pod:321
38275 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
38276 "devices in the guest."
38280 #: ../libguestfs-1.11.20/src/guestfs.pod:324 ../src/guestfs.pod:324
38281 msgid "Example: duplicate the contents of an LV:"
38285 #: ../libguestfs-1.11.20/src/guestfs.pod:326 ../src/guestfs.pod:326
38288 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
38293 #: ../libguestfs-1.11.20/src/guestfs.pod:328 ../src/guestfs.pod:328
38295 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
38296 "(C</dev/VG/Original>). To copy less than the whole source device, use L</"
38297 "guestfs_copy_size>."
38301 #: ../libguestfs-1.11.20/src/guestfs.pod:332 ../src/guestfs.pod:332
38302 msgid "B<file on the host> to B<file or device>"
38306 #: ../libguestfs-1.11.20/src/guestfs.pod:334 ../src/guestfs.pod:334
38307 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
38311 #: ../libguestfs-1.11.20/src/guestfs.pod:336 ../src/guestfs.pod:336
38312 msgid "B<file or device> to B<file on the host>"
38316 #: ../libguestfs-1.11.20/src/guestfs.pod:338 ../src/guestfs.pod:338
38317 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
38321 #: ../libguestfs-1.11.20/src/guestfs.pod:342 ../src/guestfs.pod:342
38322 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
38326 #: ../libguestfs-1.11.20/src/guestfs.pod:344 ../src/guestfs.pod:344
38328 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, L</"
38329 "guestfs_tar_out> etc appear to only take filenames as arguments, so it "
38330 "appears you can only upload and download to files. However many Un*x-like "
38331 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, C</"
38332 "dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, stderr, "
38333 "and arbitrary file descriptor N."
38337 #: ../libguestfs-1.11.20/src/guestfs.pod:352 ../src/guestfs.pod:352
38338 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
38342 #: ../libguestfs-1.11.20/src/guestfs.pod:355 ../src/guestfs.pod:355
38345 " guestfs_download (g, filename, \"/dev/stdout\");\n"
38350 #: ../libguestfs-1.11.20/src/guestfs.pod:357 ../src/guestfs.pod:357
38351 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
38355 #: ../libguestfs-1.11.20/src/guestfs.pod:359 ../src/guestfs.pod:359
38358 " char devfd[64];\n"
38359 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
38360 " guestfs_tar_out (g, \"/\", devfd);\n"
38365 #: ../libguestfs-1.11.20/src/guestfs.pod:363 ../src/guestfs.pod:363
38366 msgid "LISTING FILES"
38370 #: ../libguestfs-1.11.20/src/guestfs.pod:365 ../src/guestfs.pod:365
38372 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
38373 "L<guestfish(1)>-equivalent command C<ll>)."
38377 #: ../libguestfs-1.11.20/src/guestfs.pod:368 ../src/guestfs.pod:368
38379 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
38380 "programs, as a flat list of strings."
38384 #: ../libguestfs-1.11.20/src/guestfs.pod:371 ../src/guestfs.pod:371
38386 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
38387 "directory, plus additional information about each one. It is more "
38388 "equivalent to using the L<readdir(3)> call on a local filesystem."
38392 #: ../libguestfs-1.11.20/src/guestfs.pod:375 ../src/guestfs.pod:375
38394 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list files."
38398 #: ../libguestfs-1.11.20/src/guestfs.pod:378 ../src/guestfs.pod:378
38399 msgid "RUNNING COMMANDS"
38403 #: ../libguestfs-1.11.20/src/guestfs.pod:380 ../src/guestfs.pod:380
38405 "Although libguestfs is primarily an API for manipulating files inside guest "
38406 "images, we also provide some limited facilities for running commands inside "
38411 #: ../libguestfs-1.11.20/src/guestfs.pod:384 ../src/guestfs.pod:384
38412 msgid "There are many limitations to this:"
38416 #: ../libguestfs-1.11.20/src/guestfs.pod:390 ../src/guestfs.pod:390
38418 "The kernel version that the command runs under will be different from what "
38423 #: ../libguestfs-1.11.20/src/guestfs.pod:395 ../src/guestfs.pod:395
38425 "If the command needs to communicate with daemons, then most likely they "
38426 "won't be running."
38430 #: ../libguestfs-1.11.20/src/guestfs.pod:400 ../src/guestfs.pod:400
38431 msgid "The command will be running in limited memory."
38435 #: ../libguestfs-1.11.20/src/guestfs.pod:404 ../src/guestfs.pod:404
38437 "The network may not be available unless you enable it (see L</"
38438 "guestfs_set_network>)."
38442 #: ../libguestfs-1.11.20/src/guestfs.pod:409 ../src/guestfs.pod:409
38443 msgid "Only supports Linux guests (not Windows, BSD, etc)."
38447 #: ../libguestfs-1.11.20/src/guestfs.pod:413 ../src/guestfs.pod:413
38449 "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
38453 #: ../libguestfs-1.11.20/src/guestfs.pod:418 ../src/guestfs.pod:418
38455 "For SELinux guests, you may need to enable SELinux and load policy first. "
38456 "See L</SELINUX> in this manpage."
38460 #: ../libguestfs-1.11.20/src/guestfs.pod:423 ../src/guestfs.pod:423
38462 "I<Security:> It is not safe to run commands from untrusted, possibly "
38463 "malicious guests. These commands may attempt to exploit your program by "
38464 "sending unexpected output. They could also try to exploit the Linux kernel "
38465 "or qemu provided by the libguestfs appliance. They could use the network "
38466 "provided by the libguestfs appliance to bypass ordinary network partitions "
38467 "and firewalls. They could use the elevated privileges or different SELinux "
38468 "context of your program to their advantage."
38472 #: ../libguestfs-1.11.20/src/guestfs.pod:432 ../src/guestfs.pod:432
38474 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
38475 "(a script which runs when the guest next boots normally), and to have this "
38476 "script run the commands you want in the normal context of the running guest, "
38477 "network security and so on. For information about other security issues, "
38478 "see L</SECURITY>."
38482 #: ../libguestfs-1.11.20/src/guestfs.pod:440 ../src/guestfs.pod:440
38484 "The two main API calls to run commands are L</guestfs_command> and L</"
38485 "guestfs_sh> (there are also variations)."
38489 #: ../libguestfs-1.11.20/src/guestfs.pod:443 ../src/guestfs.pod:443
38491 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
38492 "shell globs, redirections, etc will work."
38496 #: ../libguestfs-1.11.20/src/guestfs.pod:446 ../src/guestfs.pod:446
38497 msgid "CONFIGURATION FILES"
38501 #: ../libguestfs-1.11.20/src/guestfs.pod:448 ../src/guestfs.pod:448
38503 "To read and write configuration files in Linux guest filesystems, we "
38504 "strongly recommend using Augeas. For example, Augeas understands how to "
38505 "read and write, say, a Linux shadow password file or X.org configuration "
38506 "file, and so avoids you having to write that code."
38510 #: ../libguestfs-1.11.20/src/guestfs.pod:453 ../src/guestfs.pod:453
38512 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
38513 "document Augeas itself here because there is excellent documentation on the "
38514 "L<http://augeas.net/> website."
38518 #: ../libguestfs-1.11.20/src/guestfs.pod:457 ../src/guestfs.pod:457
38520 "If you don't want to use Augeas (you fool!) then try calling L</"
38521 "guestfs_read_lines> to get the file as a list of lines which you can iterate "
38526 #: ../libguestfs-1.11.20/src/guestfs.pod:461 ../src/guestfs.pod:461
38531 #: ../libguestfs-1.11.20/src/guestfs.pod:463 ../src/guestfs.pod:463
38533 "We support SELinux guests. To ensure that labeling happens correctly in "
38534 "SELinux guests, you need to enable SELinux and load the guest's policy:"
38538 #: ../libguestfs-1.11.20/src/guestfs.pod:471 ../src/guestfs.pod:471
38539 msgid "Before launching, do:"
38543 #: ../libguestfs-1.11.20/src/guestfs.pod:473 ../src/guestfs.pod:473
38546 " guestfs_set_selinux (g, 1);\n"
38551 #: ../libguestfs-1.11.20/src/guestfs.pod:477 ../src/guestfs.pod:477
38553 "After mounting the guest's filesystem(s), load the policy. This is best "
38554 "done by running the L<load_policy(8)> command in the guest itself:"
38558 #: ../libguestfs-1.11.20/src/guestfs.pod:481 ../src/guestfs.pod:481
38561 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
38566 #: ../libguestfs-1.11.20/src/guestfs.pod:483 ../src/guestfs.pod:483
38568 "(Older versions of C<load_policy> require you to specify the name of the "
38573 #: ../libguestfs-1.11.20/src/guestfs.pod:488 ../src/guestfs.pod:488
38575 "Optionally, set the security context for the API. The correct security "
38576 "context to use can only be known by inspecting the guest. As an example:"
38580 #: ../libguestfs-1.11.20/src/guestfs.pod:492 ../src/guestfs.pod:492
38583 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
38588 #: ../libguestfs-1.11.20/src/guestfs.pod:496 ../src/guestfs.pod:496
38589 msgid "This will work for running commands and editing existing files."
38593 #: ../libguestfs-1.11.20/src/guestfs.pod:498 ../src/guestfs.pod:498
38595 "When new files are created, you may need to label them explicitly, for "
38596 "example by running the external command C<restorecon pathname>."
38600 #: ../libguestfs-1.11.20/src/guestfs.pod:502 ../src/guestfs.pod:502
38605 #: ../libguestfs-1.11.20/src/guestfs.pod:504 ../src/guestfs.pod:504
38607 "Certain calls are affected by the current file mode creation mask (the "
38608 "\"umask\"). In particular ones which create files or directories, such as "
38609 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
38610 "either the default mode that the file is created with or modifies the mode "
38615 #: ../libguestfs-1.11.20/src/guestfs.pod:510 ../src/guestfs.pod:510
38617 "The default umask is C<022>, so files are created with modes such as C<0644> "
38618 "and directories with C<0755>."
38622 #: ../libguestfs-1.11.20/src/guestfs.pod:513 ../src/guestfs.pod:513
38624 "There are two ways to avoid being affected by umask. Either set umask to 0 "
38625 "(call C<guestfs_umask (g, 0)> early after launching). Or call L</"
38626 "guestfs_chmod> after creating each file or directory."
38630 #: ../libguestfs-1.11.20/src/guestfs.pod:517 ../src/guestfs.pod:517
38631 msgid "For more information about umask, see L<umask(2)>."
38635 #: ../libguestfs-1.11.20/src/guestfs.pod:521 ../src/guestfs.pod:521
38637 "Libguestfs allows you to access Linux guests which have been encrypted using "
38638 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
38639 "standard. This includes nearly all whole disk encryption systems used by "
38640 "modern Linux guests."
38644 #: ../libguestfs-1.11.20/src/guestfs.pod:527 ../src/guestfs.pod:527
38646 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
38647 "returns the string C<crypto_LUKS>)."
38651 #: ../libguestfs-1.11.20/src/guestfs.pod:530 ../src/guestfs.pod:530
38653 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
38654 "will require the passphrase!"
38658 #: ../libguestfs-1.11.20/src/guestfs.pod:533 ../src/guestfs.pod:533
38660 "Opening a LUKS device creates a new device mapper device called C</dev/"
38661 "mapper/mapname> (where C<mapname> is the string you supply to L</"
38662 "guestfs_luks_open>). Reads and writes to this mapper device are decrypted "
38663 "from and encrypted to the underlying block device respectively."
38667 #: ../libguestfs-1.11.20/src/guestfs.pod:539 ../src/guestfs.pod:539
38669 "LVM volume groups on the device can be made visible by calling L</"
38670 "guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical volume"
38671 "(s) can now be mounted in the usual way."
38675 #: ../libguestfs-1.11.20/src/guestfs.pod:543 ../src/guestfs.pod:543
38677 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
38678 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
38679 "[\"/dev/VG\"])>. Then close the mapper device by calling L</"
38680 "guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
38681 "underlying encrypted block device)."
38685 #: ../libguestfs-1.11.20/src/guestfs.pod:550 ../src/guestfs.pod:550
38690 #: ../libguestfs-1.11.20/src/guestfs.pod:552 ../src/guestfs.pod:552
38692 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
38693 "contains operating systems, an install CD or a live CD. (These APIs used to "
38694 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
38695 "version 1.5.3 the most frequently used part of this library has been "
38696 "rewritten in C and moved into the core code)."
38700 #: ../libguestfs-1.11.20/src/guestfs.pod:559 ../src/guestfs.pod:559
38702 "Add all disks belonging to the unknown virtual machine and call L</"
38703 "guestfs_launch> in the usual way."
38707 #: ../libguestfs-1.11.20/src/guestfs.pod:562 ../src/guestfs.pod:562
38709 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
38710 "and certain heuristics, and returns a list of operating systems that were "
38711 "found. An empty list means none were found. A single element is the root "
38712 "filesystem of the operating system. For dual- or multi-boot guests, "
38713 "multiple roots can be returned, each one corresponding to a separate "
38714 "operating system. (Multi-boot virtual machines are extremely rare in the "
38715 "world of virtualization, but since this scenario can happen, we have built "
38716 "libguestfs to deal with it.)"
38720 #: ../libguestfs-1.11.20/src/guestfs.pod:571 ../src/guestfs.pod:571
38722 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
38723 "to get additional details about that operating system. For example, call L</"
38724 "guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
38725 "Windows and Linux-based operating systems respectively."
38729 #: ../libguestfs-1.11.20/src/guestfs.pod:577 ../src/guestfs.pod:577
38731 "Un*x-like and Linux-based operating systems usually consist of several "
38732 "filesystems which are mounted at boot time (for example, a separate boot "
38733 "partition mounted on C</boot>). The inspection rules are able to detect how "
38734 "filesystems correspond to mount points. Call "
38735 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
38736 "hash table like this example:"
38740 #: ../libguestfs-1.11.20/src/guestfs.pod:584 ../src/guestfs.pod:584
38743 " /boot => /dev/sda1\n"
38744 " / => /dev/vg_guest/lv_root\n"
38745 " /usr => /dev/vg_guest/lv_usr\n"
38750 #: ../libguestfs-1.11.20/src/guestfs.pod:588 ../src/guestfs.pod:588
38752 "The caller can then make calls to L</guestfs_mount_options> to mount the "
38753 "filesystems as suggested."
38757 #: ../libguestfs-1.11.20/src/guestfs.pod:591 ../src/guestfs.pod:591
38759 "Be careful to mount filesystems in the right order (eg. C</> before C</"
38760 "usr>). Sorting the keys of the hash by length, shortest first, should work."
38764 #: ../libguestfs-1.11.20/src/guestfs.pod:595 ../src/guestfs.pod:595
38766 "Inspection currently only works for some common operating systems. "
38767 "Contributors are welcome to send patches for other operating systems that we "
38768 "currently cannot detect."
38772 #: ../libguestfs-1.11.20/src/guestfs.pod:599 ../src/guestfs.pod:599
38774 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
38775 "for more details. The L</guestfs_inspect_os> function just ignores any "
38776 "encrypted devices."
38780 #: ../libguestfs-1.11.20/src/guestfs.pod:603 ../src/guestfs.pod:603
38782 "A note on the implementation: The call L</guestfs_inspect_os> performs "
38783 "inspection and caches the results in the guest handle. Subsequent calls to "
38784 "C<guestfs_inspect_get_*> return this cached information, but I<do not> re-"
38785 "read the disks. If you change the content of the guest disks, you can redo "
38786 "inspection by calling L</guestfs_inspect_os> again. (L</"
38787 "guestfs_inspect_list_applications> works a little differently from the other "
38788 "calls and does read the disks. See documentation for that function for "
38793 #: ../libguestfs-1.11.20/src/guestfs.pod:612 ../src/guestfs.pod:612
38794 msgid "INSPECTING INSTALL DISKS"
38798 #: ../libguestfs-1.11.20/src/guestfs.pod:614 ../src/guestfs.pod:614
38800 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
38805 #: ../libguestfs-1.11.20/src/guestfs.pod:617 ../src/guestfs.pod:617
38807 "Call L</guestfs_inspect_get_format> to return the format of the operating "
38808 "system, which currently can be C<installed> (a regular operating system) or "
38809 "C<installer> (some sort of install disk)."
38813 #: ../libguestfs-1.11.20/src/guestfs.pod:621 ../src/guestfs.pod:621
38815 "Further information is available about the operating system that can be "
38816 "installed using the regular inspection APIs like L</"
38817 "guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> etc."
38821 #: ../libguestfs-1.11.20/src/guestfs.pod:626 ../src/guestfs.pod:626
38823 "Some additional information specific to installer disks is also available "
38824 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and L</"
38825 "guestfs_inspect_is_multipart> calls."
38829 #: ../libguestfs-1.11.20/src/guestfs.pod:631 ../src/guestfs.pod:631
38830 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
38834 #: ../libguestfs-1.11.20/src/guestfs.pod:633 ../src/guestfs.pod:633
38836 "Libguestfs can mount NTFS partitions. It does this using the L<http://www."
38837 "ntfs-3g.org/> driver."
38841 #: ../libguestfs-1.11.20/src/guestfs.pod:636 ../src/guestfs.pod:636
38842 msgid "DRIVE LETTERS AND PATHS"
38846 #: ../libguestfs-1.11.20/src/guestfs.pod:638 ../src/guestfs.pod:638
38848 "DOS and Windows still use drive letters, and the filesystems are always "
38849 "treated as case insensitive by Windows itself, and therefore you might find "
38850 "a Windows configuration file referring to a path like C<c:\\windows"
38851 "\\system32>. When the filesystem is mounted in libguestfs, that directory "
38852 "might be referred to as C</WINDOWS/System32>."
38856 #: ../libguestfs-1.11.20/src/guestfs.pod:644 ../src/guestfs.pod:644
38858 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
38859 "L</guestfs_inspect_get_drive_mappings>)"
38863 #: ../libguestfs-1.11.20/src/guestfs.pod:647 ../src/guestfs.pod:647
38865 "Dealing with separator characters (backslash vs forward slash) is outside "
38866 "the scope of libguestfs, but usually a simple character replacement will "
38871 #: ../libguestfs-1.11.20/src/guestfs.pod:651 ../src/guestfs.pod:651
38873 "To resolve the case insensitivity of paths, call L</"
38874 "guestfs_case_sensitive_path>."
38878 #: ../libguestfs-1.11.20/src/guestfs.pod:654 ../src/guestfs.pod:654
38879 msgid "ACCESSING THE WINDOWS REGISTRY"
38883 #: ../libguestfs-1.11.20/src/guestfs.pod:656 ../src/guestfs.pod:656
38885 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
38886 "files, through the library C<hivex> which is part of the libguestfs project "
38887 "although ships as a separate tarball. You have to locate and download the "
38888 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
38889 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and L<virt-win-"
38890 "reg(1)> for more help on this issue."
38894 #: ../libguestfs-1.11.20/src/guestfs.pod:664 ../src/guestfs.pod:664
38895 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
38899 #: ../libguestfs-1.11.20/src/guestfs.pod:666 ../src/guestfs.pod:666
38901 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
38902 "provide something which looks like a Linux symlink. The way it tries to do "
38903 "the rewriting is described here:"
38907 #: ../libguestfs-1.11.20/src/guestfs.pod:670 ../src/guestfs.pod:670
38909 "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-"
38914 #: ../libguestfs-1.11.20/src/guestfs.pod:672 ../src/guestfs.pod:672
38916 "The essential problem is that ntfs-3g simply does not have enough "
38917 "information to do a correct job. NTFS links can contain drive letters and "
38918 "references to external device GUIDs that ntfs-3g has no way of resolving. "
38919 "It is almost certainly the case that libguestfs callers should ignore what "
38920 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
38924 #: ../libguestfs-1.11.20/src/guestfs.pod:679 ../src/guestfs.pod:679
38926 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use L</"
38927 "guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
38928 "attribute, and read the raw reparse data from that (you can find the format "
38929 "documented in various places around the web)."
38933 #: ../libguestfs-1.11.20/src/guestfs.pod:684 ../src/guestfs.pod:684
38934 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
38938 #: ../libguestfs-1.11.20/src/guestfs.pod:686 ../src/guestfs.pod:686
38940 "There are other useful extended attributes that can be read from ntfs-3g "
38941 "filesystems (using L</guestfs_getxattr>). See:"
38945 #: ../libguestfs-1.11.20/src/guestfs.pod:689 ../src/guestfs.pod:689
38947 "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
38951 #: ../libguestfs-1.11.20/src/guestfs.pod:691 ../src/guestfs.pod:691
38952 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
38956 #: ../libguestfs-1.11.20/src/guestfs.pod:693 ../src/guestfs.pod:693
38958 "Although we don't want to discourage you from using the C API, we will "
38959 "mention here that the same API is also available in other languages."
38963 #: ../libguestfs-1.11.20/src/guestfs.pod:696 ../src/guestfs.pod:696
38965 "The API is broadly identical in all supported languages. This means that "
38966 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
38967 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
38968 "OCaml. In other words, a straightforward, predictable isomorphism between "
38973 #: ../libguestfs-1.11.20/src/guestfs.pod:702 ../src/guestfs.pod:702
38975 "Error messages are automatically transformed into exceptions if the language "
38980 #: ../libguestfs-1.11.20/src/guestfs.pod:705 ../src/guestfs.pod:705
38982 "We don't try to \"object orientify\" parts of the API in OO languages, "
38983 "although contributors are welcome to write higher level APIs above what we "
38984 "provide in their favourite languages if they wish."
38988 #: ../libguestfs-1.11.20/src/guestfs.pod:711 ../src/guestfs.pod:711
38993 #: ../libguestfs-1.11.20/src/guestfs.pod:713 ../src/guestfs.pod:713
38995 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
38996 "identical to the C API. C++ classes and exceptions are not used."
39000 #: ../libguestfs-1.11.20/src/guestfs.pod:717 ../src/guestfs.pod:717
39005 #: ../libguestfs-1.11.20/src/guestfs.pod:719 ../src/guestfs.pod:719
39007 "The C# bindings are highly experimental. Please read the warnings at the "
39008 "top of C<csharp/Libguestfs.cs>."
39012 #: ../libguestfs-1.11.20/src/guestfs.pod:722 ../src/guestfs.pod:722
39017 #: ../libguestfs-1.11.20/src/guestfs.pod:724 ../src/guestfs.pod:724
39019 "This is the only language binding that is working but incomplete. Only "
39020 "calls which return simple integers have been bound in Haskell, and we are "
39021 "looking for help to complete this binding."
39025 #: ../libguestfs-1.11.20/src/guestfs.pod:728 ../src/guestfs.pod:728
39030 #: ../libguestfs-1.11.20/src/guestfs.pod:730 ../src/guestfs.pod:730
39032 "Full documentation is contained in the Javadoc which is distributed with "
39033 "libguestfs. For examples, see L<guestfs-java(3)>."
39037 #: ../libguestfs-1.11.20/src/guestfs.pod:733 ../src/guestfs.pod:733
39042 #: ../libguestfs-1.11.20/src/guestfs.pod:735 ../src/guestfs.pod:735
39043 msgid "See L<guestfs-ocaml(3)>."
39047 #: ../libguestfs-1.11.20/src/guestfs.pod:737 ../src/guestfs.pod:737
39052 #: ../libguestfs-1.11.20/src/guestfs.pod:739 ../src/guestfs.pod:739
39053 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
39057 #: ../libguestfs-1.11.20/src/guestfs.pod:741 ../src/guestfs.pod:741
39062 #: ../libguestfs-1.11.20/src/guestfs.pod:743 ../src/guestfs.pod:743
39064 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
39065 "the php-libguestfs package for your distribution."
39069 #: ../libguestfs-1.11.20/src/guestfs.pod:746 ../src/guestfs.pod:746
39070 msgid "The PHP binding only works correctly on 64 bit machines."
39074 #: ../libguestfs-1.11.20/src/guestfs.pod:748 ../src/guestfs.pod:748
39079 #: ../libguestfs-1.11.20/src/guestfs.pod:750 ../src/guestfs.pod:750
39080 msgid "See L<guestfs-python(3)>."
39084 #: ../libguestfs-1.11.20/src/guestfs.pod:752 ../src/guestfs.pod:752
39089 #: ../libguestfs-1.11.20/src/guestfs.pod:754 ../src/guestfs.pod:754
39090 msgid "See L<guestfs-ruby(3)>."
39094 #: ../libguestfs-1.11.20/src/guestfs.pod:756 ../src/guestfs.pod:756
39095 msgid "B<shell scripts>"
39099 #: ../libguestfs-1.11.20/src/guestfs.pod:758 ../src/guestfs.pod:758
39100 msgid "See L<guestfish(1)>."
39104 #: ../libguestfs-1.11.20/src/guestfs.pod:762 ../src/guestfs.pod:762
39105 msgid "LIBGUESTFS GOTCHAS"
39109 #: ../libguestfs-1.11.20/src/guestfs.pod:764 ../src/guestfs.pod:764
39111 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
39112 "system [...] that works in the way it is documented but is counterintuitive "
39113 "and almost invites mistakes.\""
39117 #: ../libguestfs-1.11.20/src/guestfs.pod:768 ../src/guestfs.pod:768
39119 "Since we developed libguestfs and the associated tools, there are several "
39120 "things we would have designed differently, but are now stuck with for "
39121 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
39122 "release, you can expect these to change. Beware of them."
39126 #: ../libguestfs-1.11.20/src/guestfs.pod:776 ../src/guestfs.pod:776
39127 msgid "Autosync / forgetting to sync."
39131 #: ../libguestfs-1.11.20/src/guestfs.pod:778 ../src/guestfs.pod:778
39133 "I<Update:> Autosync is enabled by default for all API users starting from "
39134 "libguestfs 1.5.24. This section only applies to older versions."
39138 #: ../libguestfs-1.11.20/src/guestfs.pod:781 ../src/guestfs.pod:781
39140 "When modifying a filesystem from C or another language, you B<must> unmount "
39141 "all filesystems and call L</guestfs_sync> explicitly before you close the "
39142 "libguestfs handle. You can also call:"
39146 #: ../libguestfs-1.11.20/src/guestfs.pod:785 ../src/guestfs.pod:785
39149 " guestfs_set_autosync (g, 1);\n"
39154 #: ../libguestfs-1.11.20/src/guestfs.pod:787 ../src/guestfs.pod:787
39156 "to have the unmount/sync done automatically for you when the handle 'g' is "
39157 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> q.v.)"
39161 #: ../libguestfs-1.11.20/src/guestfs.pod:791 ../src/guestfs.pod:791
39163 "If you forget to do this, then it is entirely possible that your changes "
39164 "won't be written out, or will be partially written, or (very rarely) that "
39165 "you'll get disk corruption."
39169 #: ../libguestfs-1.11.20/src/guestfs.pod:795 ../src/guestfs.pod:795
39171 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
39172 "guestfish scripts that forget to sync will work just fine, which can make "
39173 "this very puzzling if you are trying to debug a problem."
39177 #: ../libguestfs-1.11.20/src/guestfs.pod:799 ../src/guestfs.pod:799
39178 msgid "Mount option C<-o sync> should not be the default."
39182 #: ../libguestfs-1.11.20/src/guestfs.pod:801 ../src/guestfs.pod:801
39184 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
39185 "However C<-o sync> does not add any reliability benefit, but does have a "
39186 "very large performance impact."
39190 #: ../libguestfs-1.11.20/src/guestfs.pod:805 ../src/guestfs.pod:805
39192 "The work around is to use L</guestfs_mount_options> and set the mount "
39193 "options that you actually want to use."
39197 #: ../libguestfs-1.11.20/src/guestfs.pod:808 ../src/guestfs.pod:808
39198 msgid "Read-only should be the default."
39202 #: ../libguestfs-1.11.20/src/guestfs.pod:810 ../src/guestfs.pod:810
39204 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
39205 "specify I<--rw> if you want to make changes to the image."
39209 #: ../libguestfs-1.11.20/src/guestfs.pod:813 ../src/guestfs.pod:813
39210 msgid "This would reduce the potential to corrupt live VM images."
39214 #: ../libguestfs-1.11.20/src/guestfs.pod:815 ../src/guestfs.pod:815
39216 "Note that many filesystems change the disk when you just mount and unmount, "
39217 "even if you didn't perform any writes. You need to use L</"
39218 "guestfs_add_drive_ro> to guarantee that the disk is not changed."
39222 #: ../libguestfs-1.11.20/src/guestfs.pod:819 ../src/guestfs.pod:819
39223 msgid "guestfish command line is hard to use."
39227 #: ../libguestfs-1.11.20/src/guestfs.pod:821 ../src/guestfs.pod:821
39229 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
39230 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
39231 "exist, so it fails. In earlier versions of guestfish the error message was "
39232 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
39233 "we should have used C<guestfish -c command> to run commands."
39237 #: ../libguestfs-1.11.20/src/guestfs.pod:828 ../src/guestfs.pod:828
39238 msgid "guestfish megabyte modifiers don't work right on all commands"
39242 #: ../libguestfs-1.11.20/src/guestfs.pod:830 ../src/guestfs.pod:830
39244 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
39245 "other modifiers). What guestfish actually does is to multiply the number "
39246 "part by the modifier part and pass the result to the C API. However this "
39247 "doesn't work for a few APIs which aren't expecting bytes, but are already "
39248 "expecting some other unit (eg. megabytes)."
39252 #: ../libguestfs-1.11.20/src/guestfs.pod:837 ../src/guestfs.pod:837
39253 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
39257 #: ../libguestfs-1.11.20/src/guestfs.pod:839 ../src/guestfs.pod:839
39260 " lvcreate LV VG 100M\n"
39265 #: ../libguestfs-1.11.20/src/guestfs.pod:841 ../src/guestfs.pod:841
39267 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
39268 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
39269 "megabytes * megabytes) logical volume. The error message you get from this "
39270 "is also a little obscure."
39274 #: ../libguestfs-1.11.20/src/guestfs.pod:846 ../src/guestfs.pod:846
39276 "This could be fixed in the generator by specially marking parameters and "
39277 "return values which take bytes or other units."
39281 #: ../libguestfs-1.11.20/src/guestfs.pod:849 ../src/guestfs.pod:849
39282 msgid "Ambiguity between devices and paths"
39286 #: ../libguestfs-1.11.20/src/guestfs.pod:851 ../src/guestfs.pod:851
39288 "There is a subtle ambiguity in the API between a device name (eg. C</dev/"
39289 "sdb2>) and a similar pathname. A file might just happen to be called "
39290 "C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
39294 #: ../libguestfs-1.11.20/src/guestfs.pod:856 ../src/guestfs.pod:856
39296 "In the current API we usually resolve this ambiguity by having two separate "
39297 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
39298 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
39299 "detecting if the path supplied begins with C</dev/>."
39303 #: ../libguestfs-1.11.20/src/guestfs.pod:862 ../src/guestfs.pod:862
39305 "To avoid both the ambiguity and the need to duplicate some calls, we could "
39306 "make paths/devices into structured names. One way to do this would be to "
39307 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
39308 "aspect of grub. Another way would be to use a structured type, equivalent "
39309 "to this OCaml type:"
39313 #: ../libguestfs-1.11.20/src/guestfs.pod:868 ../src/guestfs.pod:868
39316 " type path = Path of string | Device of int | Partition of int * int\n"
39321 #: ../libguestfs-1.11.20/src/guestfs.pod:870 ../src/guestfs.pod:870
39322 msgid "which would allow you to pass arguments like:"
39326 #: ../libguestfs-1.11.20/src/guestfs.pod:872 ../src/guestfs.pod:872
39329 " Path \"/foo/bar\"\n"
39330 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
39331 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
39332 " Path \"/dev/sdb2\" (* not a device *)\n"
39337 #: ../libguestfs-1.11.20/src/guestfs.pod:877 ../src/guestfs.pod:877
39339 "As you can see there are still problems to resolve even with this "
39340 "representation. Also consider how it might work in guestfish."
39344 #: ../libguestfs-1.11.20/src/guestfs.pod:882 ../src/guestfs.pod:882
39345 msgid "KEYS AND PASSPHRASES"
39349 #: ../libguestfs-1.11.20/src/guestfs.pod:884 ../src/guestfs.pod:884
39351 "Certain libguestfs calls take a parameter that contains sensitive key "
39352 "material, passed in as a C string."
39356 #: ../libguestfs-1.11.20/src/guestfs.pod:887 ../src/guestfs.pod:887
39358 "In the future we would hope to change the libguestfs implementation so that "
39359 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
39360 "swap. However this is I<not> done at the moment, because of the complexity "
39361 "of such an implementation."
39365 #: ../libguestfs-1.11.20/src/guestfs.pod:892 ../src/guestfs.pod:892
39367 "Therefore you should be aware that any key parameter you pass to libguestfs "
39368 "might end up being written out to the swap partition. If this is a concern, "
39369 "scrub the swap partition or don't use libguestfs on encrypted devices."
39373 #: ../libguestfs-1.11.20/src/guestfs.pod:897 ../src/guestfs.pod:897
39374 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
39378 #: ../libguestfs-1.11.20/src/guestfs.pod:899 ../src/guestfs.pod:899
39380 "All high-level libguestfs actions are synchronous. If you want to use "
39381 "libguestfs asynchronously then you must create a thread."
39385 #: ../libguestfs-1.11.20/src/guestfs.pod:902 ../src/guestfs.pod:902
39387 "Only use the handle from a single thread. Either use the handle exclusively "
39388 "from one thread, or provide your own mutex so that two threads cannot issue "
39389 "calls on the same handle at the same time."
39393 #: ../libguestfs-1.11.20/src/guestfs.pod:906 ../src/guestfs.pod:906
39395 "See the graphical program guestfs-browser for one possible architecture for "
39396 "multithreaded programs using libvirt and libguestfs."
39400 #: ../libguestfs-1.11.20/src/guestfs.pod:909 ../src/guestfs.pod:909
39405 #: ../libguestfs-1.11.20/src/guestfs.pod:911 ../src/guestfs.pod:911
39407 "Libguestfs needs a supermin appliance, which it finds by looking along an "
39412 #: ../libguestfs-1.11.20/src/guestfs.pod:914 ../src/guestfs.pod:914
39414 "By default it looks for these in the directory C<$libdir/guestfs> (eg. C</"
39415 "usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
39419 #: ../libguestfs-1.11.20/src/guestfs.pod:917 ../src/guestfs.pod:917
39421 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
39422 "to change the directories that libguestfs will search in. The value is a "
39423 "colon-separated list of paths. The current directory is I<not> searched "
39424 "unless the path contains an empty element or C<.>. For example "
39425 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
39426 "then C</usr/lib/guestfs>."
39430 #: ../libguestfs-1.11.20/src/guestfs.pod:924 ../src/guestfs.pod:924
39431 msgid "QEMU WRAPPERS"
39435 #: ../libguestfs-1.11.20/src/guestfs.pod:926 ../src/guestfs.pod:926
39437 "If you want to compile your own qemu, run qemu from a non-standard location, "
39438 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
39443 #: ../libguestfs-1.11.20/src/guestfs.pod:930 ../src/guestfs.pod:930
39445 "There is one important rule to remember: you I<must C<exec qemu>> as the "
39446 "last command in the shell script (so that qemu replaces the shell and "
39447 "becomes the direct child of the libguestfs-using program). If you don't do "
39448 "this, then the qemu process won't be cleaned up correctly."
39452 #: ../libguestfs-1.11.20/src/guestfs.pod:935 ../src/guestfs.pod:935
39454 "Here is an example of a wrapper, where I have built my own copy of qemu from "
39459 #: ../libguestfs-1.11.20/src/guestfs.pod:938 ../src/guestfs.pod:938
39463 " qemudir=/home/rjones/d/qemu\n"
39464 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios \"$@\"\n"
39469 #: ../libguestfs-1.11.20/src/guestfs.pod:942 ../src/guestfs.pod:942
39471 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
39472 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
39477 #: ../libguestfs-1.11.20/src/guestfs.pod:946 ../src/guestfs.pod:946
39480 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
39485 #: ../libguestfs-1.11.20/src/guestfs.pod:948 ../src/guestfs.pod:948
39487 "Note that libguestfs also calls qemu with the -help and -version options in "
39488 "order to determine features."
39492 #: ../libguestfs-1.11.20/src/guestfs.pod:951 ../src/guestfs.pod:951
39493 msgid "ATTACHING TO RUNNING DAEMONS"
39497 #: ../libguestfs-1.11.20/src/guestfs.pod:953 ../src/guestfs.pod:953
39499 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
39500 "babies. Use with caution."
39504 #: ../libguestfs-1.11.20/src/guestfs.pod:956 ../src/guestfs.pod:956
39506 "I<Note (2):> This section explains how to attach to a running daemon from a "
39507 "low level perspective. For most users, simply using virt tools such as "
39508 "L<guestfish(1)> with the I<--live> option will \"just work\"."
39512 #: ../libguestfs-1.11.20/src/guestfs.pod:960 ../src/guestfs.pod:960
39513 msgid "Using guestfs_set_attach_method"
39517 #: ../libguestfs-1.11.20/src/guestfs.pod:962 ../src/guestfs.pod:962
39519 "By calling L</guestfs_set_attach_method> you can change how the library "
39520 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read L</"
39521 "ARCHITECTURE> for some background)."
39525 #: ../libguestfs-1.11.20/src/guestfs.pod:966 ../src/guestfs.pod:966
39527 "The normal attach method is C<appliance>, where a small appliance is created "
39528 "containing the daemon, and then the library connects to this."
39532 #: ../libguestfs-1.11.20/src/guestfs.pod:969 ../src/guestfs.pod:969
39534 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
39535 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
39536 "daemon over the Unix domain socket."
39540 #: ../libguestfs-1.11.20/src/guestfs.pod:973 ../src/guestfs.pod:973
39542 "The normal use for this is to connect to a running virtual machine that "
39543 "contains a C<guestfsd> daemon, and send commands so you can read and write "
39544 "files inside the live virtual machine."
39548 #: ../libguestfs-1.11.20/src/guestfs.pod:977 ../src/guestfs.pod:977
39549 msgid "Using guestfs_add_domain with live flag"
39553 #: ../libguestfs-1.11.20/src/guestfs.pod:979 ../src/guestfs.pod:979
39555 "L</guestfs_add_domain> provides some help for getting the correct attach "
39556 "method. If you pass the C<live> option to this function, then (if the "
39557 "virtual machine is running) it will examine the libvirt XML looking for a "
39558 "virtio-serial channel to connect to:"
39562 #: ../libguestfs-1.11.20/src/guestfs.pod:985 ../src/guestfs.pod:985
39569 " <channel type='unix'>\n"
39570 " <source mode='bind' path='/path/to/socket'/>\n"
39571 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
39580 #: ../libguestfs-1.11.20/src/guestfs.pod:997 ../src/guestfs.pod:997
39582 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
39583 "method to C<unix:/path/to/socket>."
39587 #: ../libguestfs-1.11.20/src/guestfs.pod:1000 ../src/guestfs.pod:1000
39589 "Some of the libguestfs tools (including guestfish) support a I<--live> "
39590 "option which is passed through to L</guestfs_add_domain> thus allowing you "
39591 "to attach to and modify live virtual machines."
39595 #: ../libguestfs-1.11.20/src/guestfs.pod:1004 ../src/guestfs.pod:1004
39597 "The virtual machine needs to have been set up beforehand so that it has the "
39598 "virtio-serial channel and so that guestfsd is running inside it."
39602 #: ../libguestfs-1.11.20/src/guestfs.pod:1008 ../src/guestfs.pod:1008
39603 msgid "ABI GUARANTEE"
39607 #: ../libguestfs-1.11.20/src/guestfs.pod:1010 ../src/guestfs.pod:1010
39609 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
39610 "actions as outlined in this section. Although we will deprecate some "
39611 "actions, for example if they get replaced by newer calls, we will keep the "
39612 "old actions forever. This allows you the developer to program in confidence "
39613 "against the libguestfs API."
39617 #: ../libguestfs-1.11.20/src/guestfs.pod:1016 ../src/guestfs.pod:1016
39618 msgid "BLOCK DEVICE NAMING"
39622 #: ../libguestfs-1.11.20/src/guestfs.pod:1018 ../src/guestfs.pod:1018
39624 "In the kernel there is now quite a profusion of schemata for naming block "
39625 "devices (in this context, by I<block device> I mean a physical or virtual "
39626 "hard drive). The original Linux IDE driver used names starting with C</dev/"
39627 "hd*>. SCSI devices have historically used a different naming scheme, C</dev/"
39628 "sd*>. When the Linux kernel I<libata> driver became a popular replacement "
39629 "for the old IDE driver (particularly for SATA devices) those devices also "
39630 "used the C</dev/sd*> scheme. Additionally we now have virtual machines with "
39631 "paravirtualized drivers. This has created several different naming systems, "
39632 "such as C</dev/vd*> for virtio disks and C</dev/xvd*> for Xen PV disks."
39636 #: ../libguestfs-1.11.20/src/guestfs.pod:1030 ../src/guestfs.pod:1030
39638 "As discussed above, libguestfs uses a qemu appliance running an embedded "
39639 "Linux kernel to access block devices. We can run a variety of appliances "
39640 "based on a variety of Linux kernels."
39644 #: ../libguestfs-1.11.20/src/guestfs.pod:1034 ../src/guestfs.pod:1034
39646 "This causes a problem for libguestfs because many API calls use device or "
39647 "partition names. Working scripts and the recipe (example) scripts that we "
39648 "make available over the internet could fail if the naming scheme changes."
39652 #: ../libguestfs-1.11.20/src/guestfs.pod:1039 ../src/guestfs.pod:1039
39654 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
39655 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
39656 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
39657 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
39661 #: ../libguestfs-1.11.20/src/guestfs.pod:1045 ../src/guestfs.pod:1045
39663 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
39664 "L</guestfs_list_partitions> and similar calls return the true names of the "
39665 "devices and partitions as known to the appliance."
39669 #: ../libguestfs-1.11.20/src/guestfs.pod:1050 ../src/guestfs.pod:1050
39670 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
39674 #: ../libguestfs-1.11.20/src/guestfs.pod:1052 ../src/guestfs.pod:1052
39676 "Usually this translation is transparent. However in some (very rare) cases "
39677 "you may need to know the exact algorithm. Such cases include where you use "
39678 "L</guestfs_config> to add a mixture of virtio and IDE devices to the qemu-"
39679 "based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> devices."
39683 #: ../libguestfs-1.11.20/src/guestfs.pod:1058 ../src/guestfs.pod:1058
39685 "The algorithm is applied only to I<parameters> which are known to be either "
39686 "device or partition names. Return values from functions such as L</"
39687 "guestfs_list_devices> are never changed."
39691 #: ../libguestfs-1.11.20/src/guestfs.pod:1066 ../src/guestfs.pod:1066
39692 msgid "Is the string a parameter which is a device or partition name?"
39696 #: ../libguestfs-1.11.20/src/guestfs.pod:1070 ../src/guestfs.pod:1070
39697 msgid "Does the string begin with C</dev/sd>?"
39701 #: ../libguestfs-1.11.20/src/guestfs.pod:1074 ../src/guestfs.pod:1074
39703 "Does the named device exist? If so, we use that device. However if I<not> "
39704 "then we continue with this algorithm."
39708 #: ../libguestfs-1.11.20/src/guestfs.pod:1079 ../src/guestfs.pod:1079
39709 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
39713 #: ../libguestfs-1.11.20/src/guestfs.pod:1081 ../src/guestfs.pod:1081
39714 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
39718 #: ../libguestfs-1.11.20/src/guestfs.pod:1083 ../src/guestfs.pod:1083
39719 msgid "If that named device exists, use it. If not, continue."
39723 #: ../libguestfs-1.11.20/src/guestfs.pod:1087 ../src/guestfs.pod:1087
39724 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
39728 #: ../libguestfs-1.11.20/src/guestfs.pod:1089 ../src/guestfs.pod:1089
39729 msgid "If that named device exists, use it. If not, return an error."
39733 #: ../libguestfs-1.11.20/src/guestfs.pod:1093 ../src/guestfs.pod:1093
39734 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
39738 #: ../libguestfs-1.11.20/src/guestfs.pod:1095 ../src/guestfs.pod:1095
39740 "Although the standard naming scheme and automatic translation is useful for "
39741 "simple programs and guestfish scripts, for larger programs it is best not to "
39742 "rely on this mechanism."
39746 #: ../libguestfs-1.11.20/src/guestfs.pod:1099 ../src/guestfs.pod:1099
39748 "Where possible for maximum future portability programs using libguestfs "
39749 "should use these future-proof techniques:"
39753 #: ../libguestfs-1.11.20/src/guestfs.pod:1106 ../src/guestfs.pod:1106
39755 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
39756 "device names, and then use those names directly."
39760 #: ../libguestfs-1.11.20/src/guestfs.pod:1109 ../src/guestfs.pod:1109
39762 "Since those device names exist by definition, they will never be translated."
39766 #: ../libguestfs-1.11.20/src/guestfs.pod:1114 ../src/guestfs.pod:1114
39768 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
39769 "filesystem labels."
39773 #: ../libguestfs-1.11.20/src/guestfs.pod:1119 ../src/guestfs.pod:1119
39778 #: ../libguestfs-1.11.20/src/guestfs.pod:1121 ../src/guestfs.pod:1121
39780 "This section discusses security implications of using libguestfs, "
39781 "particularly with untrusted or malicious guests or disk images."
39785 #: ../libguestfs-1.11.20/src/guestfs.pod:1124 ../src/guestfs.pod:1124
39786 msgid "GENERAL SECURITY CONSIDERATIONS"
39790 #: ../libguestfs-1.11.20/src/guestfs.pod:1126 ../src/guestfs.pod:1126
39792 "Be careful with any files or data that you download from a guest (by "
39793 "\"download\" we mean not just the L</guestfs_download> command but any "
39794 "command that reads files, filenames, directories or anything else from a "
39795 "disk image). An attacker could manipulate the data to fool your program "
39796 "into doing the wrong thing. Consider cases such as:"
39800 #: ../libguestfs-1.11.20/src/guestfs.pod:1136 ../src/guestfs.pod:1136
39801 msgid "the data (file etc) not being present"
39805 #: ../libguestfs-1.11.20/src/guestfs.pod:1140 ../src/guestfs.pod:1140
39806 msgid "being present but empty"
39810 #: ../libguestfs-1.11.20/src/guestfs.pod:1144 ../src/guestfs.pod:1144
39811 msgid "being much larger than normal"
39815 #: ../libguestfs-1.11.20/src/guestfs.pod:1148 ../src/guestfs.pod:1148
39816 msgid "containing arbitrary 8 bit data"
39820 #: ../libguestfs-1.11.20/src/guestfs.pod:1152 ../src/guestfs.pod:1152
39821 msgid "being in an unexpected character encoding"
39825 #: ../libguestfs-1.11.20/src/guestfs.pod:1156 ../src/guestfs.pod:1156
39826 msgid "containing homoglyphs."
39830 #: ../libguestfs-1.11.20/src/guestfs.pod:1160 ../src/guestfs.pod:1160
39831 msgid "SECURITY OF MOUNTING FILESYSTEMS"
39835 #: ../libguestfs-1.11.20/src/guestfs.pod:1162 ../src/guestfs.pod:1162
39837 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
39838 "(VFS) module can sometimes be escalated into exploits by deliberately "
39839 "creating a malicious, malformed filesystem. These exploits are very severe "
39840 "for two reasons. Firstly there are very many filesystem drivers in the "
39841 "kernel, and many of them are infrequently used and not much developer "
39842 "attention has been paid to the code. Linux userspace helps potential "
39843 "crackers by detecting the filesystem type and automatically choosing the "
39844 "right VFS driver, even if that filesystem type is obscure or unexpected for "
39845 "the administrator. Secondly, a kernel-level exploit is like a local root "
39846 "exploit (worse in some ways), giving immediate and total access to the "
39847 "system right down to the hardware level."
39851 #: ../libguestfs-1.11.20/src/guestfs.pod:1175 ../src/guestfs.pod:1175
39853 "That explains why you should never mount a filesystem from an untrusted "
39854 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
39855 "inside a qemu virtual machine, usually running as a non-root user. The "
39856 "attacker would need to write a filesystem which first exploited the kernel, "
39857 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
39858 "the libguestfs protocol, and finally to be as serious as the host kernel "
39859 "exploit it would need to escalate its privileges to root. This multi-step "
39860 "escalation, performed by a static piece of data, is thought to be extremely "
39861 "hard to do, although we never say 'never' about security issues."
39865 #: ../libguestfs-1.11.20/src/guestfs.pod:1186 ../src/guestfs.pod:1186
39867 "In any case callers can reduce the attack surface by forcing the filesystem "
39868 "type when mounting (use L</guestfs_mount_vfs>)."
39872 #: ../libguestfs-1.11.20/src/guestfs.pod:1189 ../src/guestfs.pod:1189
39873 msgid "PROTOCOL SECURITY"
39877 #: ../libguestfs-1.11.20/src/guestfs.pod:1191 ../src/guestfs.pod:1191
39879 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
39880 "defined upper message size. However a program that uses libguestfs must "
39881 "also take care - for example you can write a program that downloads a binary "
39882 "from a disk image and executes it locally, and no amount of protocol "
39883 "security will save you from the consequences."
39887 #: ../libguestfs-1.11.20/src/guestfs.pod:1197 ../src/guestfs.pod:1197
39888 msgid "INSPECTION SECURITY"
39892 #: ../libguestfs-1.11.20/src/guestfs.pod:1199 ../src/guestfs.pod:1199
39894 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
39895 "directly from the guest, and these could contain any 8 bit data. Callers "
39896 "should be careful to escape these before printing them to a structured file "
39897 "(for example, use HTML escaping if creating a web page)."
39901 #: ../libguestfs-1.11.20/src/guestfs.pod:1205 ../src/guestfs.pod:1205
39903 "Guest configuration may be altered in unusual ways by the administrator of "
39904 "the virtual machine, and may not reflect reality (particularly for untrusted "
39905 "or actively malicious guests). For example we parse the hostname from "
39906 "configuration files like C</etc/sysconfig/network> that we find in the "
39907 "guest, but the guest administrator can easily manipulate these files to "
39908 "provide the wrong hostname."
39912 #: ../libguestfs-1.11.20/src/guestfs.pod:1213 ../src/guestfs.pod:1213
39914 "The inspection API parses guest configuration using two external libraries: "
39915 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
39916 "designed to be robust in the face of malicious data, although denial of "
39917 "service attacks are still possible, for example with oversized configuration "
39922 #: ../libguestfs-1.11.20/src/guestfs.pod:1219 ../src/guestfs.pod:1219
39923 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
39927 #: ../libguestfs-1.11.20/src/guestfs.pod:1221 ../src/guestfs.pod:1221
39929 "Be very cautious about running commands from the guest. By running a "
39930 "command in the guest, you are giving CPU time to a binary that you do not "
39931 "control, under the same user account as the library, albeit wrapped in qemu "
39932 "virtualization. More information and alternatives can be found in the "
39933 "section L</RUNNING COMMANDS>."
39937 #: ../libguestfs-1.11.20/src/guestfs.pod:1227 ../src/guestfs.pod:1227
39938 msgid "CVE-2010-3851"
39942 #: ../libguestfs-1.11.20/src/guestfs.pod:1229 ../src/guestfs.pod:1229
39943 msgid "https://bugzilla.redhat.com/642934"
39947 #: ../libguestfs-1.11.20/src/guestfs.pod:1231 ../src/guestfs.pod:1231
39949 "This security bug concerns the automatic disk format detection that qemu "
39950 "does on disk images."
39954 #: ../libguestfs-1.11.20/src/guestfs.pod:1234 ../src/guestfs.pod:1234
39956 "A raw disk image is just the raw bytes, there is no header. Other disk "
39957 "images like qcow2 contain a special header. Qemu deals with this by looking "
39958 "for one of the known headers, and if none is found then assuming the disk "
39959 "image must be raw."
39963 #: ../libguestfs-1.11.20/src/guestfs.pod:1239 ../src/guestfs.pod:1239
39965 "This allows a guest which has been given a raw disk image to write some "
39966 "other header. At next boot (or when the disk image is accessed by "
39967 "libguestfs) qemu would do autodetection and think the disk image format was, "
39968 "say, qcow2 based on the header written by the guest."
39972 #: ../libguestfs-1.11.20/src/guestfs.pod:1244 ../src/guestfs.pod:1244
39974 "This in itself would not be a problem, but qcow2 offers many features, one "
39975 "of which is to allow a disk image to refer to another image (called the "
39976 "\"backing disk\"). It does this by placing the path to the backing disk "
39977 "into the qcow2 header. This path is not validated and could point to any "
39978 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
39979 "\"holes\" in the qcow2 disk image, which of course is completely under the "
39980 "control of the attacker."
39984 #: ../libguestfs-1.11.20/src/guestfs.pod:1252 ../src/guestfs.pod:1252
39986 "In libguestfs this is rather hard to exploit except under two circumstances:"
39990 #: ../libguestfs-1.11.20/src/guestfs.pod:1259 ../src/guestfs.pod:1259
39991 msgid "You have enabled the network or have opened the disk in write mode."
39995 #: ../libguestfs-1.11.20/src/guestfs.pod:1263 ../src/guestfs.pod:1263
39997 "You are also running untrusted code from the guest (see L</RUNNING "
40002 #: ../libguestfs-1.11.20/src/guestfs.pod:1268 ../src/guestfs.pod:1268
40004 "The way to avoid this is to specify the expected disk format when adding "
40005 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
40006 "should always do this if the disk is raw format, and it's a good idea for "
40011 #: ../libguestfs-1.11.20/src/guestfs.pod:1273 ../src/guestfs.pod:1273
40013 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
40014 "format is fetched from libvirt and passed through."
40018 #: ../libguestfs-1.11.20/src/guestfs.pod:1276 ../src/guestfs.pod:1276
40020 "For libguestfs tools, use the I<--format> command line parameter as "
40025 #: ../libguestfs-1.11.20/src/guestfs.pod:1279 ../src/guestfs.pod:1279
40026 msgid "CONNECTION MANAGEMENT"
40030 #: ../libguestfs-1.11.20/src/guestfs.pod:1281 ../src/guestfs.pod:1281
40031 msgid "guestfs_h *"
40035 #: ../libguestfs-1.11.20/src/guestfs.pod:1283 ../src/guestfs.pod:1283
40037 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
40038 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
40039 "handle and release all resources used."
40043 #: ../libguestfs-1.11.20/src/guestfs.pod:1287 ../src/guestfs.pod:1287
40045 "For information on using multiple handles and threads, see the section L</"
40046 "MULTIPLE HANDLES AND MULTIPLE THREADS> above."
40050 #: ../libguestfs-1.11.20/src/guestfs.pod:1290 ../src/guestfs.pod:1290
40051 msgid "guestfs_create"
40055 #: ../libguestfs-1.11.20/src/guestfs.pod:1292 ../src/guestfs.pod:1292
40058 " guestfs_h *guestfs_create (void);\n"
40063 #: ../libguestfs-1.11.20/src/guestfs.pod:1294 ../src/guestfs.pod:1294
40064 msgid "Create a connection handle."
40068 #: ../libguestfs-1.11.20/src/guestfs.pod:1296 ../src/guestfs.pod:1296
40070 "On success this returns a non-NULL pointer to a handle. On error it returns "
40075 #: ../libguestfs-1.11.20/src/guestfs.pod:1299 ../src/guestfs.pod:1299
40077 "You have to \"configure\" the handle after creating it. This includes "
40078 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
40079 "handle at least once."
40083 #: ../libguestfs-1.11.20/src/guestfs.pod:1303 ../src/guestfs.pod:1303
40084 msgid "After configuring the handle, you have to call L</guestfs_launch>."
40088 #: ../libguestfs-1.11.20/src/guestfs.pod:1305 ../src/guestfs.pod:1305
40090 "You may also want to configure error handling for the handle. See the L</"
40091 "ERROR HANDLING> section below."
40095 #: ../libguestfs-1.11.20/src/guestfs.pod:1308 ../src/guestfs.pod:1308
40096 msgid "guestfs_close"
40100 #: ../libguestfs-1.11.20/src/guestfs.pod:1310 ../src/guestfs.pod:1310
40103 " void guestfs_close (guestfs_h *g);\n"
40108 #: ../libguestfs-1.11.20/src/guestfs.pod:1312 ../src/guestfs.pod:1312
40109 msgid "This closes the connection handle and frees up all resources used."
40113 #: ../libguestfs-1.11.20/src/guestfs.pod:1314 ../src/guestfs.pod:1314
40115 "If autosync was set on the handle and the handle was launched, then this "
40116 "implicitly calls various functions to unmount filesystems and sync the "
40117 "disk. See L</guestfs_set_autosync> for more details."
40121 #: ../libguestfs-1.11.20/src/guestfs.pod:1318 ../src/guestfs.pod:1318
40122 msgid "If a close callback was set on the handle, then it is called."
40126 #: ../libguestfs-1.11.20/src/guestfs.pod:1320 ../src/guestfs.pod:1320
40127 msgid "ERROR HANDLING"
40131 #: ../libguestfs-1.11.20/src/guestfs.pod:1322 ../src/guestfs.pod:1322
40133 "API functions can return errors. For example, almost all functions that "
40134 "return C<int> will return C<-1> to indicate an error."
40138 #: ../libguestfs-1.11.20/src/guestfs.pod:1325 ../src/guestfs.pod:1325
40140 "Additional information is available for errors: an error message string and "
40141 "optionally an error number (errno) if the thing that failed was a system "
40146 #: ../libguestfs-1.11.20/src/guestfs.pod:1329 ../src/guestfs.pod:1329
40148 "You can get at the additional information about the last error on the handle "
40149 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
40150 "up an error handler with L</guestfs_set_error_handler>."
40154 #: ../libguestfs-1.11.20/src/guestfs.pod:1334 ../src/guestfs.pod:1334
40156 "When the handle is created, a default error handler is installed which "
40157 "prints the error message string to C<stderr>. For small short-running "
40158 "command line programs it is sufficient to do:"
40162 #: ../libguestfs-1.11.20/src/guestfs.pod:1338 ../src/guestfs.pod:1338
40165 " if (guestfs_launch (g) == -1)\n"
40166 " exit (EXIT_FAILURE);\n"
40171 #: ../libguestfs-1.11.20/src/guestfs.pod:1341 ../src/guestfs.pod:1341
40173 "since the default error handler will ensure that an error message has been "
40174 "printed to C<stderr> before the program exits."
40178 #: ../libguestfs-1.11.20/src/guestfs.pod:1344 ../src/guestfs.pod:1344
40180 "For other programs the caller will almost certainly want to install an "
40181 "alternate error handler or do error handling in-line like this:"
40185 #: ../libguestfs-1.11.20/src/guestfs.pod:1347 ../src/guestfs.pod:1347
40188 " g = guestfs_create ();\n"
40193 #: ../libguestfs-1.11.20/src/guestfs.pod:1349 ../src/guestfs.pod:1349
40196 " /* This disables the default behaviour of printing errors\n"
40198 " guestfs_set_error_handler (g, NULL, NULL);\n"
40203 #: ../libguestfs-1.11.20/src/guestfs.pod:1353 ../src/guestfs.pod:1353
40206 " if (guestfs_launch (g) == -1) {\n"
40207 " /* Examine the error message and print it etc. */\n"
40208 " char *msg = guestfs_last_error (g);\n"
40209 " int errnum = guestfs_last_errno (g);\n"
40210 " fprintf (stderr, \"%s\\n\", msg);\n"
40217 #: ../libguestfs-1.11.20/src/guestfs.pod:1361 ../src/guestfs.pod:1361
40219 "Out of memory errors are handled differently. The default action is to call "
40220 "L<abort(3)>. If this is undesirable, then you can set a handler using L</"
40221 "guestfs_set_out_of_memory_handler>."
40225 #: ../libguestfs-1.11.20/src/guestfs.pod:1365 ../src/guestfs.pod:1365
40227 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
40228 "because there is no handle if this happens there is no way to get additional "
40229 "error information. However L</guestfs_create> is supposed to be a "
40230 "lightweight operation which can only fail because of insufficient memory (it "
40231 "returns NULL in this case)."
40235 #: ../libguestfs-1.11.20/src/guestfs.pod:1371 ../src/guestfs.pod:1371
40236 msgid "guestfs_last_error"
40240 #: ../libguestfs-1.11.20/src/guestfs.pod:1373 ../src/guestfs.pod:1373
40243 " const char *guestfs_last_error (guestfs_h *g);\n"
40248 #: ../libguestfs-1.11.20/src/guestfs.pod:1375 ../src/guestfs.pod:1375
40250 "This returns the last error message that happened on C<g>. If there has not "
40251 "been an error since the handle was created, then this returns C<NULL>."
40255 #: ../libguestfs-1.11.20/src/guestfs.pod:1379 ../src/guestfs.pod:1379
40257 "The lifetime of the returned string is until the next error occurs, or L</"
40258 "guestfs_close> is called."
40262 #: ../libguestfs-1.11.20/src/guestfs.pod:1382 ../src/guestfs.pod:1382
40263 msgid "guestfs_last_errno"
40267 #: ../libguestfs-1.11.20/src/guestfs.pod:1384 ../src/guestfs.pod:1384
40270 " int guestfs_last_errno (guestfs_h *g);\n"
40275 #: ../libguestfs-1.11.20/src/guestfs.pod:1386 ../src/guestfs.pod:1386
40276 msgid "This returns the last error number (errno) that happened on C<g>."
40280 #: ../libguestfs-1.11.20/src/guestfs.pod:1388 ../src/guestfs.pod:1388
40281 msgid "If successful, an errno integer not equal to zero is returned."
40285 #: ../libguestfs-1.11.20/src/guestfs.pod:1390 ../src/guestfs.pod:1390
40287 "If no error, this returns 0. This call can return 0 in three situations:"
40291 #: ../libguestfs-1.11.20/src/guestfs.pod:1397 ../src/guestfs.pod:1397
40292 msgid "There has not been any error on the handle."
40296 #: ../libguestfs-1.11.20/src/guestfs.pod:1401 ../src/guestfs.pod:1401
40298 "There has been an error but the errno was meaningless. This corresponds to "
40299 "the case where the error did not come from a failed system call, but for "
40300 "some other reason."
40304 #: ../libguestfs-1.11.20/src/guestfs.pod:1407 ../src/guestfs.pod:1407
40306 "There was an error from a failed system call, but for some reason the errno "
40307 "was not captured and returned. This usually indicates a bug in libguestfs."
40311 #: ../libguestfs-1.11.20/src/guestfs.pod:1413 ../src/guestfs.pod:1413
40313 "Libguestfs tries to convert the errno from inside the applicance into a "
40314 "corresponding errno for the caller (not entirely trivial: the appliance "
40315 "might be running a completely different operating system from the library "
40316 "and error numbers are not standardized across Un*xen). If this could not be "
40317 "done, then the error is translated to C<EINVAL>. In practice this should "
40318 "only happen in very rare circumstances."
40322 #: ../libguestfs-1.11.20/src/guestfs.pod:1421 ../src/guestfs.pod:1421
40323 msgid "guestfs_set_error_handler"
40327 #: ../libguestfs-1.11.20/src/guestfs.pod:1423 ../src/guestfs.pod:1423
40330 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
40332 " const char *msg);\n"
40333 " void guestfs_set_error_handler (guestfs_h *g,\n"
40334 " guestfs_error_handler_cb cb,\n"
40335 " void *opaque);\n"
40340 #: ../libguestfs-1.11.20/src/guestfs.pod:1430 ../src/guestfs.pod:1430
40342 "The callback C<cb> will be called if there is an error. The parameters "
40343 "passed to the callback are an opaque data pointer and the error message "
40348 #: ../libguestfs-1.11.20/src/guestfs.pod:1434 ../src/guestfs.pod:1434
40350 "C<errno> is not passed to the callback. To get that the callback must call "
40351 "L</guestfs_last_errno>."
40355 #: ../libguestfs-1.11.20/src/guestfs.pod:1437 ../src/guestfs.pod:1437
40357 "Note that the message string C<msg> is freed as soon as the callback "
40358 "function returns, so if you want to stash it somewhere you must make your "
40363 #: ../libguestfs-1.11.20/src/guestfs.pod:1441 ../src/guestfs.pod:1441
40364 msgid "The default handler prints messages on C<stderr>."
40368 #: ../libguestfs-1.11.20/src/guestfs.pod:1443 ../src/guestfs.pod:1443
40369 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
40373 #: ../libguestfs-1.11.20/src/guestfs.pod:1445 ../src/guestfs.pod:1445
40374 msgid "guestfs_get_error_handler"
40378 #: ../libguestfs-1.11.20/src/guestfs.pod:1447 ../src/guestfs.pod:1447
40381 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
40382 " void **opaque_rtn);\n"
40387 #: ../libguestfs-1.11.20/src/guestfs.pod:1450 ../src/guestfs.pod:1450
40388 msgid "Returns the current error handler callback."
40392 #: ../libguestfs-1.11.20/src/guestfs.pod:1452 ../src/guestfs.pod:1452
40393 msgid "guestfs_set_out_of_memory_handler"
40397 #: ../libguestfs-1.11.20/src/guestfs.pod:1454 ../src/guestfs.pod:1454
40400 " typedef void (*guestfs_abort_cb) (void);\n"
40401 " int guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
40402 " guestfs_abort_cb);\n"
40407 #: ../libguestfs-1.11.20/src/guestfs.pod:1458 ../src/guestfs.pod:1458
40409 "The callback C<cb> will be called if there is an out of memory situation. "
40410 "I<Note this callback must not return>."
40414 #: ../libguestfs-1.11.20/src/guestfs.pod:1461 ../src/guestfs.pod:1461
40415 msgid "The default is to call L<abort(3)>."
40419 #: ../libguestfs-1.11.20/src/guestfs.pod:1463 ../src/guestfs.pod:1463
40421 "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
40425 #: ../libguestfs-1.11.20/src/guestfs.pod:1466 ../src/guestfs.pod:1466
40426 msgid "guestfs_get_out_of_memory_handler"
40430 #: ../libguestfs-1.11.20/src/guestfs.pod:1468 ../src/guestfs.pod:1468
40433 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
40438 #: ../libguestfs-1.11.20/src/guestfs.pod:1470 ../src/guestfs.pod:1470
40439 msgid "This returns the current out of memory handler."
40443 #: ../libguestfs-1.11.20/src/guestfs.pod:1472 ../src/guestfs.pod:1472
40448 #: ../libguestfs-1.11.20/src/guestfs.pod:1476 ../src/guestfs.pod:1476
40453 #: ../libguestfs-1.11.20/src/guestfs.pod:1478 ../src/guestfs.pod:1478
40458 #: ../libguestfs-1.11.20/src/guestfs.pod:1480 ../src/guestfs.pod:1480
40459 msgid "AVAILABILITY"
40463 #: ../libguestfs-1.11.20/src/guestfs.pod:1482 ../src/guestfs.pod:1482
40464 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
40468 #: ../libguestfs-1.11.20/src/guestfs.pod:1484 ../src/guestfs.pod:1484
40470 "Using L</guestfs_available> you can test availability of the following "
40471 "groups of functions. This test queries the appliance to see if the "
40472 "appliance you are currently using supports the functionality."
40476 #: ../libguestfs-1.11.20/src/guestfs.pod:1489 ../src/guestfs.pod:1489
40477 msgid "@AVAILABILITY@"
40481 #: ../libguestfs-1.11.20/src/guestfs.pod:1491 ../src/guestfs.pod:1491
40482 msgid "GUESTFISH supported COMMAND"
40486 #: ../libguestfs-1.11.20/src/guestfs.pod:1493 ../src/guestfs.pod:1493
40488 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
40489 "prints out the available groups and whether they are supported by this build "
40490 "of libguestfs. Note however that you have to do C<run> first."
40494 #: ../libguestfs-1.11.20/src/guestfs.pod:1498 ../src/guestfs.pod:1498
40495 msgid "SINGLE CALLS AT COMPILE TIME"
40499 #: ../libguestfs-1.11.20/src/guestfs.pod:1500 ../src/guestfs.pod:1500
40501 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
40502 "function, such as:"
40506 #: ../libguestfs-1.11.20/src/guestfs.pod:1503 ../src/guestfs.pod:1503
40509 " #define LIBGUESTFS_HAVE_DD 1\n"
40514 #: ../libguestfs-1.11.20/src/guestfs.pod:1505 ../src/guestfs.pod:1505
40515 msgid "if L</guestfs_dd> is available."
40519 #: ../libguestfs-1.11.20/src/guestfs.pod:1507 ../src/guestfs.pod:1507
40521 "Before version 1.5.8, if you needed to test whether a single libguestfs "
40522 "function is available at compile time, we recommended using build tools such "
40523 "as autoconf or cmake. For example in autotools you could use:"
40527 #: ../libguestfs-1.11.20/src/guestfs.pod:1512 ../src/guestfs.pod:1512
40530 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
40531 " AC_CHECK_FUNCS([guestfs_dd])\n"
40536 #: ../libguestfs-1.11.20/src/guestfs.pod:1515 ../src/guestfs.pod:1515
40538 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
40543 #: ../libguestfs-1.11.20/src/guestfs.pod:1518 ../src/guestfs.pod:1518
40544 msgid "SINGLE CALLS AT RUN TIME"
40548 #: ../libguestfs-1.11.20/src/guestfs.pod:1520 ../src/guestfs.pod:1520
40550 "Testing at compile time doesn't guarantee that a function really exists in "
40551 "the library. The reason is that you might be dynamically linked against a "
40552 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
40553 "This situation unfortunately results in a segmentation fault, which is a "
40554 "shortcoming of the C dynamic linking system itself."
40558 #: ../libguestfs-1.11.20/src/guestfs.pod:1527 ../src/guestfs.pod:1527
40560 "You can use L<dlopen(3)> to test if a function is available at run time, as "
40561 "in this example program (note that you still need the compile time check as "
40566 #: ../libguestfs-1.11.20/src/guestfs.pod:1531 ../src/guestfs.pod:1531
40569 " #include <stdio.h>\n"
40570 " #include <stdlib.h>\n"
40571 " #include <unistd.h>\n"
40572 " #include <dlfcn.h>\n"
40573 " #include <guestfs.h>\n"
40578 #: ../libguestfs-1.11.20/src/guestfs.pod:1537 ../src/guestfs.pod:1537
40583 " #ifdef LIBGUESTFS_HAVE_DD\n"
40585 " int has_function;\n"
40590 #: ../libguestfs-1.11.20/src/guestfs.pod:1543 ../src/guestfs.pod:1543
40593 " /* Test if the function guestfs_dd is really available. */\n"
40594 " dl = dlopen (NULL, RTLD_LAZY);\n"
40596 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
40597 " exit (EXIT_FAILURE);\n"
40599 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
40605 #: ../libguestfs-1.11.20/src/guestfs.pod:1552 ../src/guestfs.pod:1552
40608 " if (!has_function)\n"
40609 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
40611 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
40612 " /* Now it's safe to call\n"
40613 " guestfs_dd (g, \"foo\", \"bar\");\n"
40617 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
40624 #: ../libguestfs-1.11.20/src/guestfs.pod:1565 ../src/guestfs.pod:1565
40626 "You may think the above is an awful lot of hassle, and it is. There are "
40627 "other ways outside of the C linking system to ensure that this kind of "
40628 "incompatibility never arises, such as using package versioning:"
40632 #: ../libguestfs-1.11.20/src/guestfs.pod:1570 ../src/guestfs.pod:1570
40635 " Requires: libguestfs >= 1.0.80\n"
40640 #: ../libguestfs-1.11.20/src/guestfs.pod:1572 ../src/guestfs.pod:1572
40641 msgid "CALLS WITH OPTIONAL ARGUMENTS"
40645 #: ../libguestfs-1.11.20/src/guestfs.pod:1574 ../src/guestfs.pod:1574
40647 "A recent feature of the API is the introduction of calls which take optional "
40648 "arguments. In C these are declared 3 ways. The main way is as a call which "
40649 "takes variable arguments (ie. C<...>), as in this example:"
40653 #: ../libguestfs-1.11.20/src/guestfs.pod:1579 ../src/guestfs.pod:1579
40656 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
40661 #: ../libguestfs-1.11.20/src/guestfs.pod:1581 ../src/guestfs.pod:1581
40663 "Call this with a list of optional arguments, terminated by C<-1>. So to "
40664 "call with no optional arguments specified:"
40668 #: ../libguestfs-1.11.20/src/guestfs.pod:1584 ../src/guestfs.pod:1584
40671 " guestfs_add_drive_opts (g, filename, -1);\n"
40676 #: ../libguestfs-1.11.20/src/guestfs.pod:1586 ../src/guestfs.pod:1586
40677 msgid "With a single optional argument:"
40681 #: ../libguestfs-1.11.20/src/guestfs.pod:1588 ../src/guestfs.pod:1588
40684 " guestfs_add_drive_opts (g, filename,\n"
40685 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
40691 #: ../libguestfs-1.11.20/src/guestfs.pod:1592 ../src/guestfs.pod:1592
40696 #: ../libguestfs-1.11.20/src/guestfs.pod:1594 ../src/guestfs.pod:1594
40699 " guestfs_add_drive_opts (g, filename,\n"
40700 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
40701 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
40707 #: ../libguestfs-1.11.20/src/guestfs.pod:1599 ../src/guestfs.pod:1599
40709 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
40714 #: ../libguestfs-1.11.20/src/guestfs.pod:1602 ../src/guestfs.pod:1602
40715 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
40719 #: ../libguestfs-1.11.20/src/guestfs.pod:1604 ../src/guestfs.pod:1604
40721 "The second variant has the same name with the suffix C<_va>, which works the "
40722 "same way but takes a C<va_list>. See the C manual for details. For the "
40723 "example function, this is declared:"
40727 #: ../libguestfs-1.11.20/src/guestfs.pod:1608 ../src/guestfs.pod:1608
40730 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
40731 " va_list args);\n"
40736 #: ../libguestfs-1.11.20/src/guestfs.pod:1611 ../src/guestfs.pod:1611
40737 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
40741 #: ../libguestfs-1.11.20/src/guestfs.pod:1613 ../src/guestfs.pod:1613
40743 "The third variant is useful where you need to construct these calls. You "
40744 "pass in a structure where you fill in the optional fields. The structure "
40745 "has a bitmask as the first element which you must set to indicate which "
40746 "fields you have filled in. For our example function the structure and call "
40751 #: ../libguestfs-1.11.20/src/guestfs.pod:1619 ../src/guestfs.pod:1619
40754 " struct guestfs_add_drive_opts_argv {\n"
40755 " uint64_t bitmask;\n"
40757 " const char *format;\n"
40760 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
40761 " const struct guestfs_add_drive_opts_argv *optargs);\n"
40766 #: ../libguestfs-1.11.20/src/guestfs.pod:1628 ../src/guestfs.pod:1628
40767 msgid "You could call it like this:"
40771 #: ../libguestfs-1.11.20/src/guestfs.pod:1630 ../src/guestfs.pod:1630
40774 " struct guestfs_add_drive_opts_argv optargs = {\n"
40775 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
40776 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
40777 " .readonly = 1,\n"
40778 " .format = \"qcow2\"\n"
40784 #: ../libguestfs-1.11.20/src/guestfs.pod:1637 ../src/guestfs.pod:1637
40787 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
40792 #: ../libguestfs-1.11.20/src/guestfs.pod:1645 ../src/guestfs.pod:1645
40793 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
40797 #: ../libguestfs-1.11.20/src/guestfs.pod:1650 ../src/guestfs.pod:1650
40798 msgid "You do not need to fill in all fields of the structure."
40802 #: ../libguestfs-1.11.20/src/guestfs.pod:1654 ../src/guestfs.pod:1654
40804 "There must be a one-to-one correspondence between fields of the structure "
40805 "that are filled in, and bits set in the bitmask."
40809 #: ../libguestfs-1.11.20/src/guestfs.pod:1659 ../src/guestfs.pod:1659
40810 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
40814 #: ../libguestfs-1.11.20/src/guestfs.pod:1661 ../src/guestfs.pod:1661
40816 "In other languages, optional arguments are expressed in the way that is "
40817 "natural for that language. We refer you to the language-specific "
40818 "documentation for more details on that."
40822 #: ../libguestfs-1.11.20/src/guestfs.pod:1665 ../src/guestfs.pod:1665
40823 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
40827 #: ../libguestfs-1.11.20/src/guestfs.pod:1667 ../src/guestfs.pod:1667
40828 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
40832 #: ../libguestfs-1.11.20/src/guestfs.pod:1669 ../src/guestfs.pod:1669
40834 "B<Note:> This section documents the generic event mechanism introduced in "
40835 "libguestfs 1.10, which you should use in new code if possible. The old "
40836 "functions C<guestfs_set_log_message_callback>, "
40837 "C<guestfs_set_subprocess_quit_callback>, "
40838 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
40839 "C<guestfs_set_progress_callback> are no longer documented in this manual "
40840 "page. Because of the ABI guarantee, the old functions continue to work."
40844 #: ../libguestfs-1.11.20/src/guestfs.pod:1678 ../src/guestfs.pod:1678
40846 "Handles generate events when certain things happen, such as log messages "
40847 "being generated, progress messages during long-running operations, or the "
40848 "handle being closed. The API calls described below let you register a "
40849 "callback to be called when events happen. You can register multiple "
40850 "callbacks (for the same, different or overlapping sets of events), and "
40851 "individually remove callbacks. If callbacks are not removed, then they "
40852 "remain in force until the handle is closed."
40856 #: ../libguestfs-1.11.20/src/guestfs.pod:1686 ../src/guestfs.pod:1686
40858 "In the current implementation, events are only generated synchronously: that "
40859 "means that events (and hence callbacks) can only happen while you are in the "
40860 "middle of making another libguestfs call. The callback is called in the "
40865 #: ../libguestfs-1.11.20/src/guestfs.pod:1691 ../src/guestfs.pod:1691
40867 "Events may contain a payload, usually nothing (void), an array of 64 bit "
40868 "unsigned integers, or a message buffer. Payloads are discussed later on."
40872 #: ../libguestfs-1.11.20/src/guestfs.pod:1695 ../src/guestfs.pod:1695
40873 msgid "CLASSES OF EVENTS"
40877 #: ../libguestfs-1.11.20/src/guestfs.pod:1699 ../src/guestfs.pod:1699
40878 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
40882 #: ../libguestfs-1.11.20/src/guestfs.pod:1702 ../src/guestfs.pod:1702
40884 "The callback function will be called while the handle is being closed "
40885 "(synchronously from L</guestfs_close>)."
40889 #: ../libguestfs-1.11.20/src/guestfs.pod:1705 ../src/guestfs.pod:1705
40891 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
40892 "handles that are open when the program exits. This means that this callback "
40893 "might be called indirectly from L<exit(3)>, which can cause unexpected "
40894 "problems in higher-level languages (eg. if your HLL interpreter has already "
40895 "been cleaned up by the time this is called, and if your callback then jumps "
40896 "into some HLL function)."
40900 #: ../libguestfs-1.11.20/src/guestfs.pod:1712 ../src/guestfs.pod:1712
40902 "If no callback is registered: the handle is closed without any callback "
40907 #: ../libguestfs-1.11.20/src/guestfs.pod:1715 ../src/guestfs.pod:1715
40908 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
40912 #: ../libguestfs-1.11.20/src/guestfs.pod:1718 ../src/guestfs.pod:1718
40914 "The callback function will be called when the child process quits, either "
40915 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
40916 "corresponds to a transition from any state to the CONFIG state)."
40920 #: ../libguestfs-1.11.20/src/guestfs.pod:1722
40921 #: ../libguestfs-1.11.20/src/guestfs.pod:1731 ../src/guestfs.pod:1722
40922 #: ../src/guestfs.pod:1731
40923 msgid "If no callback is registered: the event is ignored."
40927 #: ../libguestfs-1.11.20/src/guestfs.pod:1724 ../src/guestfs.pod:1724
40928 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
40932 #: ../libguestfs-1.11.20/src/guestfs.pod:1727 ../src/guestfs.pod:1727
40934 "The callback function will be called when the child process becomes ready "
40935 "first time after it has been launched. (This corresponds to a transition "
40936 "from LAUNCHING to the READY state)."
40940 #: ../libguestfs-1.11.20/src/guestfs.pod:1733 ../src/guestfs.pod:1733
40941 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
40945 #: ../libguestfs-1.11.20/src/guestfs.pod:1736 ../src/guestfs.pod:1736
40947 "Some long-running operations can generate progress messages. If this "
40948 "callback is registered, then it will be called each time a progress message "
40949 "is generated (usually two seconds after the operation started, and three "
40950 "times per second thereafter until it completes, although the frequency may "
40951 "change in future versions)."
40955 #: ../libguestfs-1.11.20/src/guestfs.pod:1742 ../src/guestfs.pod:1742
40957 "The callback receives in the payload four unsigned 64 bit numbers which are "
40958 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
40962 #: ../libguestfs-1.11.20/src/guestfs.pod:1745 ../src/guestfs.pod:1745
40964 "The units of C<total> are not defined, although for some operations C<total> "
40965 "may relate in some way to the amount of data to be transferred (eg. in bytes "
40966 "or megabytes), and C<position> may be the portion which has been transferred."
40970 #: ../libguestfs-1.11.20/src/guestfs.pod:1750 ../src/guestfs.pod:1750
40971 msgid "The only defined and stable parts of the API are:"
40975 #: ../libguestfs-1.11.20/src/guestfs.pod:1756 ../src/guestfs.pod:1756
40977 "The callback can display to the user some type of progress bar or indicator "
40978 "which shows the ratio of C<position>:C<total>."
40982 #: ../libguestfs-1.11.20/src/guestfs.pod:1761 ../src/guestfs.pod:1761
40983 msgid "0 E<lt>= C<position> E<lt>= C<total>"
40987 #: ../libguestfs-1.11.20/src/guestfs.pod:1765 ../src/guestfs.pod:1765
40989 "If any progress notification is sent during a call, then a final progress "
40990 "notification is always sent when C<position> = C<total> (I<unless> the call "
40991 "fails with an error)."
40995 #: ../libguestfs-1.11.20/src/guestfs.pod:1769 ../src/guestfs.pod:1769
40997 "This is to simplify caller code, so callers can easily set the progress "
40998 "indicator to \"100%\" at the end of the operation, without requiring special "
40999 "code to detect this case."
41003 #: ../libguestfs-1.11.20/src/guestfs.pod:1775 ../src/guestfs.pod:1775
41005 "For some calls we are unable to estimate the progress of the call, but we "
41006 "can still generate progress messages to indicate activity. This is known as "
41007 "\"pulse mode\", and is directly supported by certain progress bar "
41008 "implementations (eg. GtkProgressBar)."
41012 #: ../libguestfs-1.11.20/src/guestfs.pod:1780 ../src/guestfs.pod:1780
41014 "For these calls, zero or more progress messages are generated with "
41015 "C<position = 0> and C<total = 1>, followed by a final message with "
41016 "C<position = total = 1>."
41020 #: ../libguestfs-1.11.20/src/guestfs.pod:1784 ../src/guestfs.pod:1784
41022 "As noted above, if the call fails with an error then the final message may "
41023 "not be generated."
41027 #: ../libguestfs-1.11.20/src/guestfs.pod:1789 ../src/guestfs.pod:1789
41029 "The callback also receives the procedure number (C<proc_nr>) and serial "
41030 "number (C<serial>) of the call. These are only useful for debugging "
41031 "protocol issues, and the callback can normally ignore them. The callback "
41032 "may want to print these numbers in error messages or debugging messages."
41036 #: ../libguestfs-1.11.20/src/guestfs.pod:1795 ../src/guestfs.pod:1795
41037 msgid "If no callback is registered: progress messages are discarded."
41041 #: ../libguestfs-1.11.20/src/guestfs.pod:1797 ../src/guestfs.pod:1797
41042 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
41046 #: ../libguestfs-1.11.20/src/guestfs.pod:1800 ../src/guestfs.pod:1800
41048 "The callback function is called whenever a log message is generated by qemu, "
41049 "the appliance kernel, guestfsd (daemon), or utility programs."
41053 #: ../libguestfs-1.11.20/src/guestfs.pod:1803 ../src/guestfs.pod:1803
41055 "If the verbose flag (L</guestfs_set_verbose>) is set before launch (L</"
41056 "guestfs_launch>) then additional debug messages are generated."
41060 #: ../libguestfs-1.11.20/src/guestfs.pod:1806
41061 #: ../libguestfs-1.11.20/src/guestfs.pod:1820 ../src/guestfs.pod:1806
41062 #: ../src/guestfs.pod:1820
41064 "If no callback is registered: the messages are discarded unless the verbose "
41065 "flag is set in which case they are sent to stderr. You can override the "
41066 "printing of verbose messages to stderr by setting up a callback."
41070 #: ../libguestfs-1.11.20/src/guestfs.pod:1811 ../src/guestfs.pod:1811
41071 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
41075 #: ../libguestfs-1.11.20/src/guestfs.pod:1814 ../src/guestfs.pod:1814
41077 "The callback function is called whenever a log message is generated by the "
41078 "library part of libguestfs."
41082 #: ../libguestfs-1.11.20/src/guestfs.pod:1817 ../src/guestfs.pod:1817
41084 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
41085 "messages are generated."
41089 #: ../libguestfs-1.11.20/src/guestfs.pod:1825 ../src/guestfs.pod:1825
41090 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
41094 #: ../libguestfs-1.11.20/src/guestfs.pod:1828 ../src/guestfs.pod:1828
41096 "The callback function is called whenever a trace message is generated. This "
41097 "only applies if the trace flag (L</guestfs_set_trace>) is set."
41101 #: ../libguestfs-1.11.20/src/guestfs.pod:1831 ../src/guestfs.pod:1831
41103 "If no callback is registered: the messages are sent to stderr. You can "
41104 "override the printing of trace messages to stderr by setting up a callback."
41108 #: ../libguestfs-1.11.20/src/guestfs.pod:1837 ../src/guestfs.pod:1837
41109 msgid "guestfs_set_event_callback"
41113 #: ../libguestfs-1.11.20/src/guestfs.pod:1839 ../src/guestfs.pod:1839
41116 " int guestfs_set_event_callback (guestfs_h *g,\n"
41117 " guestfs_event_callback cb,\n"
41118 " uint64_t event_bitmask,\n"
41120 " void *opaque);\n"
41125 #: ../libguestfs-1.11.20/src/guestfs.pod:1845 ../src/guestfs.pod:1845
41127 "This function registers a callback (C<cb>) for all event classes in the "
41128 "C<event_bitmask>."
41132 #: ../libguestfs-1.11.20/src/guestfs.pod:1848 ../src/guestfs.pod:1848
41134 "For example, to register for all log message events, you could call this "
41135 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
41136 "To register a single callback for all possible classes of events, use "
41137 "C<GUESTFS_EVENT_ALL>."
41141 #: ../libguestfs-1.11.20/src/guestfs.pod:1854 ../src/guestfs.pod:1854
41142 msgid "C<flags> should always be passed as 0."
41146 #: ../libguestfs-1.11.20/src/guestfs.pod:1856 ../src/guestfs.pod:1856
41148 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
41149 "it for any purpose."
41153 #: ../libguestfs-1.11.20/src/guestfs.pod:1859 ../src/guestfs.pod:1859
41155 "The return value is the event handle (an integer) which you can use to "
41156 "delete the callback (see below)."
41160 #: ../libguestfs-1.11.20/src/guestfs.pod:1862 ../src/guestfs.pod:1862
41162 "If there is an error, this function returns C<-1>, and sets the error in the "
41163 "handle in the usual way (see L</guestfs_last_error> etc.)"
41167 #: ../libguestfs-1.11.20/src/guestfs.pod:1865 ../src/guestfs.pod:1865
41169 "Callbacks remain in effect until they are deleted, or until the handle is "
41174 #: ../libguestfs-1.11.20/src/guestfs.pod:1868 ../src/guestfs.pod:1868
41176 "In the case where multiple callbacks are registered for a particular event "
41177 "class, all of the callbacks are called. The order in which multiple "
41178 "callbacks are called is not defined."
41182 #: ../libguestfs-1.11.20/src/guestfs.pod:1872 ../src/guestfs.pod:1872
41183 msgid "guestfs_delete_event_callback"
41187 #: ../libguestfs-1.11.20/src/guestfs.pod:1874 ../src/guestfs.pod:1874
41190 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
41195 #: ../libguestfs-1.11.20/src/guestfs.pod:1876 ../src/guestfs.pod:1876
41197 "Delete a callback that was previously registered. C<event_handle> should be "
41198 "the integer that was returned by a previous call to "
41199 "C<guestfs_set_event_callback> on the same handle."
41203 #: ../libguestfs-1.11.20/src/guestfs.pod:1880 ../src/guestfs.pod:1880
41204 msgid "guestfs_event_callback"
41208 #: ../libguestfs-1.11.20/src/guestfs.pod:1882 ../src/guestfs.pod:1882
41211 " typedef void (*guestfs_event_callback) (\n"
41214 " uint64_t event,\n"
41215 " int event_handle,\n"
41217 " const char *buf, size_t buf_len,\n"
41218 " const uint64_t *array, size_t array_len);\n"
41223 #: ../libguestfs-1.11.20/src/guestfs.pod:1891 ../src/guestfs.pod:1891
41225 "This is the type of the event callback function that you have to provide."
41229 #: ../libguestfs-1.11.20/src/guestfs.pod:1894 ../src/guestfs.pod:1894
41231 "The basic parameters are: the handle (C<g>), the opaque user pointer "
41232 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
41233 "handle, and C<flags> which in the current API you should ignore."
41237 #: ../libguestfs-1.11.20/src/guestfs.pod:1898 ../src/guestfs.pod:1898
41239 "The remaining parameters contain the event payload (if any). Each event may "
41240 "contain a payload, which usually relates to the event class, but for future "
41241 "proofing your code should be written to handle any payload for any event "
41246 #: ../libguestfs-1.11.20/src/guestfs.pod:1903 ../src/guestfs.pod:1903
41248 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
41249 "there is no message buffer). Note that this message buffer can contain "
41250 "arbitrary 8 bit data, including NUL bytes."
41254 #: ../libguestfs-1.11.20/src/guestfs.pod:1907 ../src/guestfs.pod:1907
41256 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
41257 "moment this is only used for progress messages."
41261 #: ../libguestfs-1.11.20/src/guestfs.pod:1910 ../src/guestfs.pod:1910
41262 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
41266 #: ../libguestfs-1.11.20/src/guestfs.pod:1912 ../src/guestfs.pod:1912
41268 "One motivation for the generic event API was to allow GUI programs to "
41269 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
41270 "unconditionally to C<stderr>."
41274 #: ../libguestfs-1.11.20/src/guestfs.pod:1916 ../src/guestfs.pod:1916
41276 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
41277 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
41278 "messages are not events; you must capture error messages separately)."
41282 #: ../libguestfs-1.11.20/src/guestfs.pod:1921 ../src/guestfs.pod:1921
41284 "Programs have to set up a callback to capture the classes of events of "
41289 #: ../libguestfs-1.11.20/src/guestfs.pod:1924 ../src/guestfs.pod:1924
41293 " guestfs_set_event_callback\n"
41294 " (g, message_callback,\n"
41295 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
41296 " GUESTFS_EVENT_TRACE,\n"
41297 " 0, NULL) == -1)\n"
41298 " if (eh == -1) {\n"
41299 " // handle error in the usual way\n"
41305 #: ../libguestfs-1.11.20/src/guestfs.pod:1934 ../src/guestfs.pod:1934
41307 "The callback can then direct messages to the appropriate place. In this "
41308 "example, messages are directed to syslog:"
41312 #: ../libguestfs-1.11.20/src/guestfs.pod:1937 ../src/guestfs.pod:1937
41316 " message_callback (\n"
41319 " uint64_t event,\n"
41320 " int event_handle,\n"
41322 " const char *buf, size_t buf_len,\n"
41323 " const uint64_t *array, size_t array_len)\n"
41325 " const int priority = LOG_USER|LOG_INFO;\n"
41326 " if (buf_len > 0)\n"
41327 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
41333 #: ../libguestfs-1.11.20/src/guestfs.pod:1952 ../src/guestfs.pod:1952
41334 msgid "CANCELLING LONG TRANSFERS"
41338 #: ../libguestfs-1.11.20/src/guestfs.pod:1954 ../src/guestfs.pod:1954
41340 "Some operations can be cancelled by the caller while they are in progress. "
41341 "Currently only operations that involve uploading or downloading data can be "
41342 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
41343 "parameters in the generator)."
41347 #: ../libguestfs-1.11.20/src/guestfs.pod:1959 ../src/guestfs.pod:1959
41348 msgid "guestfs_user_cancel"
41352 #: ../libguestfs-1.11.20/src/guestfs.pod:1961 ../src/guestfs.pod:1961
41355 " void guestfs_user_cancel (guestfs_h *g);\n"
41360 #: ../libguestfs-1.11.20/src/guestfs.pod:1963 ../src/guestfs.pod:1963
41362 "C<guestfs_user_cancel> cancels the current upload or download operation."
41366 #: ../libguestfs-1.11.20/src/guestfs.pod:1966 ../src/guestfs.pod:1966
41368 "Unlike most other libguestfs calls, this function is signal safe and thread "
41369 "safe. You can call it from a signal handler or from another thread, without "
41370 "needing to do any locking."
41374 #: ../libguestfs-1.11.20/src/guestfs.pod:1970 ../src/guestfs.pod:1970
41376 "The transfer that was in progress (if there is one) will stop shortly "
41377 "afterwards, and will return an error. The errno (see L</"
41378 "guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
41379 "out if the operation was cancelled or failed because of another error."
41383 #: ../libguestfs-1.11.20/src/guestfs.pod:1976 ../src/guestfs.pod:1976
41385 "No cleanup is performed: for example, if a file was being uploaded then "
41386 "after cancellation there may be a partially uploaded file. It is the "
41387 "caller's responsibility to clean up if necessary."
41391 #: ../libguestfs-1.11.20/src/guestfs.pod:1980 ../src/guestfs.pod:1980
41392 msgid "There are two common places that you might call C<guestfs_user_cancel>."
41396 #: ../libguestfs-1.11.20/src/guestfs.pod:1982 ../src/guestfs.pod:1982
41398 "In an interactive text-based program, you might call it from a C<SIGINT> "
41399 "signal handler so that pressing C<^C> cancels the current operation. (You "
41400 "also need to call L</guestfs_set_pgroup> so that child processes don't "
41401 "receive the C<^C> signal)."
41405 #: ../libguestfs-1.11.20/src/guestfs.pod:1987 ../src/guestfs.pod:1987
41407 "In a graphical program, when the main thread is displaying a progress bar "
41408 "with a cancel button, wire up the cancel button to call this function."
41412 #: ../libguestfs-1.11.20/src/guestfs.pod:1991 ../src/guestfs.pod:1991
41413 msgid "PRIVATE DATA AREA"
41417 #: ../libguestfs-1.11.20/src/guestfs.pod:1993 ../src/guestfs.pod:1993
41419 "You can attach named pieces of private data to the libguestfs handle, fetch "
41420 "them by name, and walk over them, for the lifetime of the handle. This is "
41421 "called the private data area and is only available from the C API."
41425 #: ../libguestfs-1.11.20/src/guestfs.pod:1998 ../src/guestfs.pod:1998
41426 msgid "To attach a named piece of data, use the following call:"
41430 #: ../libguestfs-1.11.20/src/guestfs.pod:2000 ../src/guestfs.pod:2000
41433 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
41438 #: ../libguestfs-1.11.20/src/guestfs.pod:2002 ../src/guestfs.pod:2002
41440 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
41441 "pointer (which can be C<NULL>). Any previous item with the same key is "
41446 #: ../libguestfs-1.11.20/src/guestfs.pod:2006 ../src/guestfs.pod:2006
41448 "You can use any C<key> you want, but your key should I<not> start with an "
41449 "underscore character. Keys beginning with an underscore character are "
41450 "reserved for internal libguestfs purposes (eg. for implementing language "
41451 "bindings). It is recommended that you prefix the key with some unique "
41452 "string to avoid collisions with other users."
41456 #: ../libguestfs-1.11.20/src/guestfs.pod:2012 ../src/guestfs.pod:2012
41457 msgid "To retrieve the pointer, use:"
41461 #: ../libguestfs-1.11.20/src/guestfs.pod:2014 ../src/guestfs.pod:2014
41464 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
41469 #: ../libguestfs-1.11.20/src/guestfs.pod:2016 ../src/guestfs.pod:2016
41471 "This function returns C<NULL> if either no data is found associated with "
41472 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
41477 #: ../libguestfs-1.11.20/src/guestfs.pod:2020 ../src/guestfs.pod:2020
41479 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
41480 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
41481 "all. In particular, libguestfs does I<not> try to free the data when the "
41482 "handle is closed. If the data must be freed, then the caller must either "
41483 "free it before calling L</guestfs_close> or must set up a close callback to "
41484 "do it (see L</GUESTFS_EVENT_CLOSE>)."
41488 #: ../libguestfs-1.11.20/src/guestfs.pod:2027 ../src/guestfs.pod:2027
41489 msgid "To walk over all entries, use these two functions:"
41493 #: ../libguestfs-1.11.20/src/guestfs.pod:2029 ../src/guestfs.pod:2029
41496 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
41501 #: ../libguestfs-1.11.20/src/guestfs.pod:2031 ../src/guestfs.pod:2031
41504 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
41509 #: ../libguestfs-1.11.20/src/guestfs.pod:2033 ../src/guestfs.pod:2033
41511 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
41512 "not have any particular meaning -- keys are not returned in any defined "
41513 "order). A pointer to the key is returned in C<*key_rtn> and the "
41514 "corresponding data pointer is returned from the function. C<NULL> is "
41515 "returned if there are no keys stored in the handle."
41519 #: ../libguestfs-1.11.20/src/guestfs.pod:2039 ../src/guestfs.pod:2039
41521 "C<guestfs_next_private> returns the next key, pointer pair. The return "
41522 "value of this function is also C<NULL> is there are no further entries to "
41527 #: ../libguestfs-1.11.20/src/guestfs.pod:2043 ../src/guestfs.pod:2043
41528 msgid "Notes about walking over entries:"
41532 #: ../libguestfs-1.11.20/src/guestfs.pod:2049 ../src/guestfs.pod:2049
41534 "You must not call C<guestfs_set_private> while walking over the entries."
41538 #: ../libguestfs-1.11.20/src/guestfs.pod:2054 ../src/guestfs.pod:2054
41540 "The handle maintains an internal iterator which is reset when you call "
41541 "C<guestfs_first_private>. This internal iterator is invalidated when you "
41542 "call C<guestfs_set_private>."
41546 #: ../libguestfs-1.11.20/src/guestfs.pod:2060 ../src/guestfs.pod:2060
41547 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
41551 #: ../libguestfs-1.11.20/src/guestfs.pod:2062 ../src/guestfs.pod:2062
41554 " guestfs_set_private (g, key, NULL);\n"
41559 #: ../libguestfs-1.11.20/src/guestfs.pod:2064 ../src/guestfs.pod:2064
41560 msgid "then that C<key> is not returned when walking."
41564 #: ../libguestfs-1.11.20/src/guestfs.pod:2068 ../src/guestfs.pod:2068
41566 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
41567 "C<guestfs_next_private> or C<guestfs_set_private>."
41571 #: ../libguestfs-1.11.20/src/guestfs.pod:2074 ../src/guestfs.pod:2074
41573 "The following example code shows how to print all keys and data pointers "
41574 "that are associated with the handle C<g>:"
41578 #: ../libguestfs-1.11.20/src/guestfs.pod:2077 ../src/guestfs.pod:2077
41581 " const char *key;\n"
41582 " void *data = guestfs_first_private (g, &key);\n"
41583 " while (data != NULL)\n"
41585 " printf (\"key = %s, data = %p\\n\", key, data);\n"
41586 " data = guestfs_next_private (g, &key);\n"
41592 #: ../libguestfs-1.11.20/src/guestfs.pod:2085 ../src/guestfs.pod:2085
41594 "More commonly you are only interested in keys that begin with an application-"
41595 "specific prefix C<foo_>. Modify the loop like so:"
41599 #: ../libguestfs-1.11.20/src/guestfs.pod:2088 ../src/guestfs.pod:2088
41602 " const char *key;\n"
41603 " void *data = guestfs_first_private (g, &key);\n"
41604 " while (data != NULL)\n"
41606 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
41607 " printf (\"key = %s, data = %p\\n\", key, data);\n"
41608 " data = guestfs_next_private (g, &key);\n"
41614 #: ../libguestfs-1.11.20/src/guestfs.pod:2097 ../src/guestfs.pod:2097
41616 "If you need to modify keys while walking, then you have to jump back to the "
41617 "beginning of the loop. For example, to delete all keys prefixed with "
41622 #: ../libguestfs-1.11.20/src/guestfs.pod:2101 ../src/guestfs.pod:2101
41625 " const char *key;\n"
41628 " data = guestfs_first_private (g, &key);\n"
41629 " while (data != NULL)\n"
41631 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
41633 " guestfs_set_private (g, key, NULL);\n"
41634 " /* note that 'key' pointer is now invalid, and so is\n"
41635 " the internal iterator */\n"
41638 " data = guestfs_next_private (g, &key);\n"
41644 #: ../libguestfs-1.11.20/src/guestfs.pod:2117 ../src/guestfs.pod:2117
41646 "Note that the above loop is guaranteed to terminate because the keys are "
41647 "being deleted, but other manipulations of keys within the loop might not "
41648 "terminate unless you also maintain an indication of which keys have been "
41653 #: ../libguestfs-1.11.20/src/guestfs.pod:2122
41654 #: ../libguestfs-1.11.20/src/guestfs.pod:2127 ../src/guestfs.pod:2122
41655 #: ../src/guestfs.pod:2127
41660 #: ../libguestfs-1.11.20/src/guestfs.pod:2124 ../src/guestfs.pod:2124
41662 "<!-- old anchor for the next section --> <a name="
41663 "\"state_machine_and_low_level_event_api\"/>"
41667 #: ../libguestfs-1.11.20/src/guestfs.pod:2129 ../src/guestfs.pod:2129
41668 msgid "ARCHITECTURE"
41672 #: ../libguestfs-1.11.20/src/guestfs.pod:2131 ../src/guestfs.pod:2131
41674 "Internally, libguestfs is implemented by running an appliance (a special "
41675 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
41676 "process of the main program."
41680 #: ../libguestfs-1.11.20/src/guestfs.pod:2135 ../src/guestfs.pod:2135
41683 " ___________________\n"
41685 " | main program |\n"
41687 " | | child process / appliance\n"
41688 " | | __________________________\n"
41690 " +-------------------+ RPC | +-----------------+ |\n"
41691 " | libguestfs <--------------------> guestfsd | |\n"
41692 " | | | +-----------------+ |\n"
41693 " \\___________________/ | | Linux kernel | |\n"
41694 " | +--^--------------+ |\n"
41695 " \\_________|________________/\n"
41697 " _______v______\n"
41700 " | disk image |\n"
41701 " \\______________/\n"
41706 #: ../libguestfs-1.11.20/src/guestfs.pod:2155 ../src/guestfs.pod:2155
41708 "The library, linked to the main program, creates the child process and hence "
41709 "the appliance in the L</guestfs_launch> function."
41713 #: ../libguestfs-1.11.20/src/guestfs.pod:2158 ../src/guestfs.pod:2158
41715 "Inside the appliance is a Linux kernel and a complete stack of userspace "
41716 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
41717 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
41718 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
41719 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
41720 "attached to the qemu process which translates device access by the "
41721 "appliance's Linux kernel into accesses to the image."
41725 #: ../libguestfs-1.11.20/src/guestfs.pod:2167 ../src/guestfs.pod:2167
41727 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
41728 "Although the disk image you are attached to might also be used by some "
41729 "virtual machine, libguestfs doesn't know or care about this. (But you will "
41730 "care if both libguestfs's qemu process and your virtual machine are trying "
41731 "to update the disk image at the same time, since these usually results in "
41732 "massive disk corruption)."
41736 #: ../libguestfs-1.11.20/src/guestfs.pod:2174 ../src/guestfs.pod:2174
41737 msgid "STATE MACHINE"
41741 #: ../libguestfs-1.11.20/src/guestfs.pod:2176 ../src/guestfs.pod:2176
41742 msgid "libguestfs uses a state machine to model the child process:"
41746 #: ../libguestfs-1.11.20/src/guestfs.pod:2178 ../src/guestfs.pod:2178
41750 " guestfs_create\n"
41758 " / | \\ \\ guestfs_launch\n"
41759 " / | _\\__V______\n"
41761 " / | | LAUNCHING |\n"
41762 " / | \\___________/\n"
41764 " / | guestfs_launch\n"
41766 " ______ / __|____V\n"
41767 " / \\ ------> / \\\n"
41768 " | BUSY | | READY |\n"
41769 " \\______/ <------ \\________/\n"
41774 #: ../libguestfs-1.11.20/src/guestfs.pod:2200 ../src/guestfs.pod:2200
41776 "The normal transitions are (1) CONFIG (when the handle is created, but there "
41777 "is no child process), (2) LAUNCHING (when the child process is booting up), "
41778 "(3) alternating between READY and BUSY as commands are issued to, and "
41779 "carried out by, the child process."
41783 #: ../libguestfs-1.11.20/src/guestfs.pod:2205 ../src/guestfs.pod:2205
41785 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
41786 "asynchronously at any time (eg. due to some internal error), and that causes "
41787 "the state to transition back to CONFIG."
41791 #: ../libguestfs-1.11.20/src/guestfs.pod:2209 ../src/guestfs.pod:2209
41793 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
41794 "issued when in the CONFIG state."
41798 #: ../libguestfs-1.11.20/src/guestfs.pod:2212 ../src/guestfs.pod:2212
41800 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
41801 "L</guestfs_launch> blocks until the child process is READY to accept "
41802 "commands (or until some failure or timeout). L</guestfs_launch> internally "
41803 "moves the state from CONFIG to LAUNCHING while it is running."
41807 #: ../libguestfs-1.11.20/src/guestfs.pod:2218 ../src/guestfs.pod:2218
41809 "API actions such as L</guestfs_mount> can only be issued when in the READY "
41810 "state. These API calls block waiting for the command to be carried out (ie. "
41811 "the state to transition to BUSY and then back to READY). There are no non-"
41812 "blocking versions, and no way to issue more than one command per handle at "
41817 #: ../libguestfs-1.11.20/src/guestfs.pod:2224 ../src/guestfs.pod:2224
41819 "Finally, the child process sends asynchronous messages back to the main "
41820 "program, such as kernel log messages. You can register a callback to "
41821 "receive these messages."
41825 #: ../libguestfs-1.11.20/src/guestfs.pod:2228 ../src/guestfs.pod:2228
41830 #: ../libguestfs-1.11.20/src/guestfs.pod:2230 ../src/guestfs.pod:2230
41831 msgid "COMMUNICATION PROTOCOL"
41835 #: ../libguestfs-1.11.20/src/guestfs.pod:2232 ../src/guestfs.pod:2232
41837 "Don't rely on using this protocol directly. This section documents how it "
41838 "currently works, but it may change at any time."
41842 #: ../libguestfs-1.11.20/src/guestfs.pod:2235 ../src/guestfs.pod:2235
41844 "The protocol used to talk between the library and the daemon running inside "
41845 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
41846 "1014, RFC 1832, RFC 4506)."
41850 #: ../libguestfs-1.11.20/src/guestfs.pod:2239 ../src/guestfs.pod:2239
41852 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
41853 "this file is automatically generated)."
41857 #: ../libguestfs-1.11.20/src/guestfs.pod:2242 ../src/guestfs.pod:2242
41859 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
41860 "and C<FileOut> parameters, which are handled with very simple request/reply "
41861 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
41862 "parameters, which use the same request and reply messages, but they may also "
41863 "be followed by files sent using a chunked encoding."
41867 #: ../libguestfs-1.11.20/src/guestfs.pod:2249 ../src/guestfs.pod:2249
41868 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
41872 #: ../libguestfs-1.11.20/src/guestfs.pod:2251 ../src/guestfs.pod:2251
41873 msgid "For ordinary functions, the request message is:"
41877 #: ../libguestfs-1.11.20/src/guestfs.pod:2253 ../src/guestfs.pod:2253
41880 " total length (header + arguments,\n"
41881 " but not including the length word itself)\n"
41882 " struct guestfs_message_header (encoded as XDR)\n"
41883 " struct guestfs_<foo>_args (encoded as XDR)\n"
41888 #: ../libguestfs-1.11.20/src/guestfs.pod:2258 ../src/guestfs.pod:2258
41890 "The total length field allows the daemon to allocate a fixed size buffer "
41891 "into which it slurps the rest of the message. As a result, the total length "
41892 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
41893 "effective size of any request is limited to somewhere under this size."
41897 #: ../libguestfs-1.11.20/src/guestfs.pod:2264 ../src/guestfs.pod:2264
41899 "Note also that many functions don't take any arguments, in which case the "
41900 "C<guestfs_I<foo>_args> is completely omitted."
41904 #: ../libguestfs-1.11.20/src/guestfs.pod:2267 ../src/guestfs.pod:2267
41906 "The header contains the procedure number (C<guestfs_proc>) which is how the "
41907 "receiver knows what type of args structure to expect, or none at all."
41911 #: ../libguestfs-1.11.20/src/guestfs.pod:2271 ../src/guestfs.pod:2271
41913 "For functions that take optional arguments, the optional arguments are "
41914 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
41915 "arguments. A bitmask in the header indicates which optional arguments are "
41916 "meaningful. The bitmask is also checked to see if it contains bits set "
41917 "which the daemon does not know about (eg. if more optional arguments were "
41918 "added in a later version of the library), and this causes the call to be "
41923 #: ../libguestfs-1.11.20/src/guestfs.pod:2279 ../src/guestfs.pod:2279
41924 msgid "The reply message for ordinary functions is:"
41928 #: ../libguestfs-1.11.20/src/guestfs.pod:2281 ../src/guestfs.pod:2281
41931 " total length (header + ret,\n"
41932 " but not including the length word itself)\n"
41933 " struct guestfs_message_header (encoded as XDR)\n"
41934 " struct guestfs_<foo>_ret (encoded as XDR)\n"
41939 #: ../libguestfs-1.11.20/src/guestfs.pod:2286 ../src/guestfs.pod:2286
41941 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
41942 "functions that return no formal return values."
41946 #: ../libguestfs-1.11.20/src/guestfs.pod:2289 ../src/guestfs.pod:2289
41948 "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
41952 #: ../libguestfs-1.11.20/src/guestfs.pod:2292 ../src/guestfs.pod:2292
41954 "In the case of an error, a flag is set in the header, and the reply message "
41955 "is slightly changed:"
41959 #: ../libguestfs-1.11.20/src/guestfs.pod:2295 ../src/guestfs.pod:2295
41962 " total length (header + error,\n"
41963 " but not including the length word itself)\n"
41964 " struct guestfs_message_header (encoded as XDR)\n"
41965 " struct guestfs_message_error (encoded as XDR)\n"
41970 #: ../libguestfs-1.11.20/src/guestfs.pod:2300 ../src/guestfs.pod:2300
41972 "The C<guestfs_message_error> structure contains the error message as a "
41977 #: ../libguestfs-1.11.20/src/guestfs.pod:2303 ../src/guestfs.pod:2303
41978 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
41982 #: ../libguestfs-1.11.20/src/guestfs.pod:2305 ../src/guestfs.pod:2305
41984 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
41985 "The normal request message is sent (see above). However this is followed by "
41986 "a sequence of file chunks."
41990 #: ../libguestfs-1.11.20/src/guestfs.pod:2309 ../src/guestfs.pod:2309
41993 " total length (header + arguments,\n"
41994 " but not including the length word itself,\n"
41995 " and not including the chunks)\n"
41996 " struct guestfs_message_header (encoded as XDR)\n"
41997 " struct guestfs_<foo>_args (encoded as XDR)\n"
41998 " sequence of chunks for FileIn param #0\n"
41999 " sequence of chunks for FileIn param #1 etc.\n"
42004 #: ../libguestfs-1.11.20/src/guestfs.pod:2317 ../src/guestfs.pod:2317
42005 msgid "The \"sequence of chunks\" is:"
42009 #: ../libguestfs-1.11.20/src/guestfs.pod:2319 ../src/guestfs.pod:2319
42012 " length of chunk (not including length word itself)\n"
42013 " struct guestfs_chunk (encoded as XDR)\n"
42014 " length of chunk\n"
42015 " struct guestfs_chunk (encoded as XDR)\n"
42017 " length of chunk\n"
42018 " struct guestfs_chunk (with data.data_len == 0)\n"
42023 #: ../libguestfs-1.11.20/src/guestfs.pod:2327 ../src/guestfs.pod:2327
42025 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
42026 "is set in the final chunk to indicate either successful completion or early "
42031 #: ../libguestfs-1.11.20/src/guestfs.pod:2331 ../src/guestfs.pod:2331
42033 "At time of writing there are no functions that have more than one FileIn "
42034 "parameter. However this is (theoretically) supported, by sending the "
42035 "sequence of chunks for each FileIn parameter one after another (from left to "
42040 #: ../libguestfs-1.11.20/src/guestfs.pod:2336 ../src/guestfs.pod:2336
42042 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
42043 "transfer. The library does this by sending a chunk with a special flag set "
42044 "to indicate cancellation. When the daemon sees this, it cancels the whole "
42045 "RPC, does I<not> send any reply, and goes back to reading the next request."
42049 #: ../libguestfs-1.11.20/src/guestfs.pod:2342 ../src/guestfs.pod:2342
42051 "The daemon may also cancel. It does this by writing a special word "
42052 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
42053 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
42054 "cancel chunk). The special word is chosen so that even if cancellation "
42055 "happens right at the end of the transfer (after the library has finished "
42056 "writing and has started listening for the reply), the \"spurious\" cancel "
42057 "flag will not be confused with the reply message."
42061 #: ../libguestfs-1.11.20/src/guestfs.pod:2351 ../src/guestfs.pod:2351
42063 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
42064 "limit), and also files where the size is not known in advance (eg. from "
42065 "pipes or sockets). However the chunks are rather small "
42066 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
42067 "to keep much in memory."
42071 #: ../libguestfs-1.11.20/src/guestfs.pod:2357 ../src/guestfs.pod:2357
42072 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
42076 #: ../libguestfs-1.11.20/src/guestfs.pod:2359 ../src/guestfs.pod:2359
42078 "The protocol for FileOut parameters is exactly the same as for FileIn "
42079 "parameters, but with the roles of daemon and library reversed."
42083 #: ../libguestfs-1.11.20/src/guestfs.pod:2362 ../src/guestfs.pod:2362
42086 " total length (header + ret,\n"
42087 " but not including the length word itself,\n"
42088 " and not including the chunks)\n"
42089 " struct guestfs_message_header (encoded as XDR)\n"
42090 " struct guestfs_<foo>_ret (encoded as XDR)\n"
42091 " sequence of chunks for FileOut param #0\n"
42092 " sequence of chunks for FileOut param #1 etc.\n"
42097 #: ../libguestfs-1.11.20/src/guestfs.pod:2370 ../src/guestfs.pod:2370
42098 msgid "INITIAL MESSAGE"
42102 #: ../libguestfs-1.11.20/src/guestfs.pod:2372 ../src/guestfs.pod:2372
42104 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
42105 "which indicates that the guest and daemon is alive. This is what L</"
42106 "guestfs_launch> waits for."
42110 #: ../libguestfs-1.11.20/src/guestfs.pod:2376 ../src/guestfs.pod:2376
42111 msgid "PROGRESS NOTIFICATION MESSAGES"
42115 #: ../libguestfs-1.11.20/src/guestfs.pod:2378 ../src/guestfs.pod:2378
42117 "The daemon may send progress notification messages at any time. These are "
42118 "distinguished by the normal length word being replaced by "
42119 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
42123 #: ../libguestfs-1.11.20/src/guestfs.pod:2382 ../src/guestfs.pod:2382
42125 "The library turns them into progress callbacks (see L</"
42126 "GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards them "
42131 #: ../libguestfs-1.11.20/src/guestfs.pod:2386 ../src/guestfs.pod:2386
42133 "The daemon self-limits the frequency of progress messages it sends (see "
42134 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
42139 #: ../libguestfs-1.11.20/src/guestfs.pod:2390 ../src/guestfs.pod:2390
42140 msgid "LIBGUESTFS VERSION NUMBERS"
42144 #: ../libguestfs-1.11.20/src/guestfs.pod:2392 ../src/guestfs.pod:2392
42146 "Since April 2010, libguestfs has started to make separate development and "
42147 "stable releases, along with corresponding branches in our git repository. "
42148 "These separate releases can be identified by version number:"
42152 #: ../libguestfs-1.11.20/src/guestfs.pod:2397 ../src/guestfs.pod:2397
42155 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
42156 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
42162 " | `-------- sub-version\n"
42164 " `------ always '1' because we don't change the ABI\n"
42169 #: ../libguestfs-1.11.20/src/guestfs.pod:2408 ../src/guestfs.pod:2408
42170 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
42174 #: ../libguestfs-1.11.20/src/guestfs.pod:2410 ../src/guestfs.pod:2410
42176 "As time passes we cherry pick fixes from the development branch and backport "
42177 "those into the stable branch, the effect being that the stable branch should "
42178 "get more stable and less buggy over time. So the stable releases are ideal "
42179 "for people who don't need new features but would just like the software to "
42184 #: ../libguestfs-1.11.20/src/guestfs.pod:2416 ../src/guestfs.pod:2416
42185 msgid "Our criteria for backporting changes are:"
42189 #: ../libguestfs-1.11.20/src/guestfs.pod:2422 ../src/guestfs.pod:2422
42191 "Documentation changes which don't affect any code are backported unless the "
42192 "documentation refers to a future feature which is not in stable."
42196 #: ../libguestfs-1.11.20/src/guestfs.pod:2428 ../src/guestfs.pod:2428
42198 "Bug fixes which are not controversial, fix obvious problems, and have been "
42199 "well tested are backported."
42203 #: ../libguestfs-1.11.20/src/guestfs.pod:2433 ../src/guestfs.pod:2433
42205 "Simple rearrangements of code which shouldn't affect how it works get "
42206 "backported. This is so that the code in the two branches doesn't get too "
42207 "far out of step, allowing us to backport future fixes more easily."
42211 #: ../libguestfs-1.11.20/src/guestfs.pod:2439 ../src/guestfs.pod:2439
42213 "We I<don't> backport new features, new APIs, new tools etc, except in one "
42214 "exceptional case: the new feature is required in order to implement an "
42215 "important bug fix."
42219 #: ../libguestfs-1.11.20/src/guestfs.pod:2445 ../src/guestfs.pod:2445
42221 "A new stable branch starts when we think the new features in development are "
42222 "substantial and compelling enough over the current stable branch to warrant "
42223 "it. When that happens we create new stable and development versions 1.N.0 "
42224 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
42225 "stable at this point, but by backporting fixes from development, that branch "
42226 "will stabilize over time."
42230 #: ../libguestfs-1.11.20/src/guestfs.pod:2453 ../src/guestfs.pod:2453
42231 msgid "EXTENDING LIBGUESTFS"
42235 #: ../libguestfs-1.11.20/src/guestfs.pod:2455 ../src/guestfs.pod:2455
42236 msgid "ADDING A NEW API ACTION"
42240 #: ../libguestfs-1.11.20/src/guestfs.pod:2457 ../src/guestfs.pod:2457
42242 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
42243 "documentation) are generated, and this makes it easy to extend the "
42248 #: ../libguestfs-1.11.20/src/guestfs.pod:2461 ../src/guestfs.pod:2461
42249 msgid "To add a new API action there are two changes:"
42253 #: ../libguestfs-1.11.20/src/guestfs.pod:2467 ../src/guestfs.pod:2467
42255 "You need to add a description of the call (name, parameters, return type, "
42256 "tests, documentation) to C<generator/generator_actions.ml>."
42260 #: ../libguestfs-1.11.20/src/guestfs.pod:2470 ../src/guestfs.pod:2470
42262 "There are two sorts of API action, depending on whether the call goes "
42263 "through to the daemon in the appliance, or is serviced entirely by the "
42264 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
42265 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
42266 "an example of the latter, since a trace flag is maintained in the handle and "
42267 "all tracing is done on the library side."
42271 #: ../libguestfs-1.11.20/src/guestfs.pod:2478 ../src/guestfs.pod:2478
42273 "Most new actions are of the first type, and get added to the "
42274 "C<daemon_functions> list. Each function has a unique procedure number used "
42275 "in the RPC protocol which is assigned to that action when we publish "
42276 "libguestfs and cannot be reused. Take the latest procedure number and "
42281 #: ../libguestfs-1.11.20/src/guestfs.pod:2484 ../src/guestfs.pod:2484
42283 "For library-only actions of the second type, add to the "
42284 "C<non_daemon_functions> list. Since these functions are serviced by the "
42285 "library and do not travel over the RPC mechanism to the daemon, these "
42286 "functions do not need a procedure number, and so the procedure number is set "
42291 #: ../libguestfs-1.11.20/src/guestfs.pod:2492 ../src/guestfs.pod:2492
42292 msgid "Implement the action (in C):"
42296 #: ../libguestfs-1.11.20/src/guestfs.pod:2494 ../src/guestfs.pod:2494
42298 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
42299 "C<daemon/> directory."
42303 #: ../libguestfs-1.11.20/src/guestfs.pod:2497 ../src/guestfs.pod:2497
42305 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
42306 "(note: double underscore) in the C<src/> directory."
42310 #: ../libguestfs-1.11.20/src/guestfs.pod:2500 ../src/guestfs.pod:2500
42311 msgid "In either case, use another function as an example of what to do."
42315 #: ../libguestfs-1.11.20/src/guestfs.pod:2504 ../src/guestfs.pod:2504
42316 msgid "After making these changes, use C<make> to compile."
42320 #: ../libguestfs-1.11.20/src/guestfs.pod:2506 ../src/guestfs.pod:2506
42322 "Note that you don't need to implement the RPC, language bindings, manual "
42323 "pages or anything else. It's all automatically generated from the OCaml "
42328 #: ../libguestfs-1.11.20/src/guestfs.pod:2510 ../src/guestfs.pod:2510
42329 msgid "ADDING TESTS FOR AN API ACTION"
42333 #: ../libguestfs-1.11.20/src/guestfs.pod:2512 ../src/guestfs.pod:2512
42335 "You can supply zero or as many tests as you want per API call. The tests "
42336 "can either be added as part of the API description (C<generator/"
42337 "generator_actions.ml>), or in some rarer cases you may want to drop a script "
42338 "into C<regressions/>. Note that adding a script to C<regressions/> is "
42339 "slower, so if possible use the first method."
42343 #: ../libguestfs-1.11.20/src/guestfs.pod:2518 ../src/guestfs.pod:2518
42345 "The following describes the test environment used when you add an API test "
42346 "in C<generator_actions.ml>."
42350 #: ../libguestfs-1.11.20/src/guestfs.pod:2521 ../src/guestfs.pod:2521
42351 msgid "The test environment has 4 block devices:"
42355 #: ../libguestfs-1.11.20/src/guestfs.pod:2525 ../src/guestfs.pod:2525
42356 msgid "C</dev/sda> 500MB"
42360 #: ../libguestfs-1.11.20/src/guestfs.pod:2527 ../src/guestfs.pod:2527
42361 msgid "General block device for testing."
42365 #: ../libguestfs-1.11.20/src/guestfs.pod:2529 ../src/guestfs.pod:2529
42366 msgid "C</dev/sdb> 50MB"
42370 #: ../libguestfs-1.11.20/src/guestfs.pod:2531 ../src/guestfs.pod:2531
42372 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
42377 #: ../libguestfs-1.11.20/src/guestfs.pod:2534 ../src/guestfs.pod:2534
42378 msgid "C</dev/sdc> 10MB"
42382 #: ../libguestfs-1.11.20/src/guestfs.pod:2536 ../src/guestfs.pod:2536
42383 msgid "Used in a few tests where two block devices are needed."
42387 #: ../libguestfs-1.11.20/src/guestfs.pod:2538 ../src/guestfs.pod:2538
42388 msgid "C</dev/sdd>"
42392 #: ../libguestfs-1.11.20/src/guestfs.pod:2540 ../src/guestfs.pod:2540
42393 msgid "ISO with fixed content (see C<images/test.iso>)."
42397 #: ../libguestfs-1.11.20/src/guestfs.pod:2544 ../src/guestfs.pod:2544
42399 "To be able to run the tests in a reasonable amount of time, the libguestfs "
42400 "appliance and block devices are reused between tests. So don't try testing "
42401 "L</guestfs_kill_subprocess> :-x"
42405 #: ../libguestfs-1.11.20/src/guestfs.pod:2548 ../src/guestfs.pod:2548
42407 "Each test starts with an initial scenario, selected using one of the "
42408 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
42409 "initialize the disks mentioned above in a particular way as documented in "
42410 "C<generator_types.ml>. You should not assume anything about the previous "
42411 "contents of other disks that are not initialized."
42415 #: ../libguestfs-1.11.20/src/guestfs.pod:2554 ../src/guestfs.pod:2554
42417 "You can add a prerequisite clause to any individual test. This is a run-"
42418 "time check, which, if it fails, causes the test to be skipped. Useful if "
42419 "testing a command which might not work on all variations of libguestfs "
42420 "builds. A test that has prerequisite of C<Always> means to run "
42425 #: ../libguestfs-1.11.20/src/guestfs.pod:2560 ../src/guestfs.pod:2560
42427 "In addition, packagers can skip individual tests by setting environment "
42428 "variables before running C<make check>."
42432 #: ../libguestfs-1.11.20/src/guestfs.pod:2563 ../src/guestfs.pod:2563
42435 " SKIP_TEST_<CMD>_<NUM>=1\n"
42440 #: ../libguestfs-1.11.20/src/guestfs.pod:2565 ../src/guestfs.pod:2565
42441 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
42445 #: ../libguestfs-1.11.20/src/guestfs.pod:2567 ../src/guestfs.pod:2567
42450 #: ../libguestfs-1.11.20/src/guestfs.pod:2569 ../src/guestfs.pod:2569
42453 " SKIP_TEST_<CMD>=1\n"
42458 #: ../libguestfs-1.11.20/src/guestfs.pod:2571 ../src/guestfs.pod:2571
42459 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
42463 #: ../libguestfs-1.11.20/src/guestfs.pod:2573 ../src/guestfs.pod:2573
42464 msgid "Packagers can run only certain tests by setting for example:"
42468 #: ../libguestfs-1.11.20/src/guestfs.pod:2575 ../src/guestfs.pod:2575
42471 " TEST_ONLY=\"vfs_type zerofree\"\n"
42476 #: ../libguestfs-1.11.20/src/guestfs.pod:2577 ../src/guestfs.pod:2577
42478 "See C<capitests/tests.c> for more details of how these environment variables "
42483 #: ../libguestfs-1.11.20/src/guestfs.pod:2580 ../src/guestfs.pod:2580
42484 msgid "DEBUGGING NEW API ACTIONS"
42488 #: ../libguestfs-1.11.20/src/guestfs.pod:2582 ../src/guestfs.pod:2582
42489 msgid "Test new actions work before submitting them."
42493 #: ../libguestfs-1.11.20/src/guestfs.pod:2584 ../src/guestfs.pod:2584
42494 msgid "You can use guestfish to try out new commands."
42498 #: ../libguestfs-1.11.20/src/guestfs.pod:2586 ../src/guestfs.pod:2586
42500 "Debugging the daemon is a problem because it runs inside a minimal "
42501 "environment. However you can fprintf messages in the daemon to stderr, and "
42502 "they will show up if you use C<guestfish -v>."
42506 #: ../libguestfs-1.11.20/src/guestfs.pod:2590 ../src/guestfs.pod:2590
42507 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
42511 #: ../libguestfs-1.11.20/src/guestfs.pod:2592 ../src/guestfs.pod:2592
42513 "Our C source code generally adheres to some basic code-formatting "
42514 "conventions. The existing code base is not totally consistent on this "
42515 "front, but we do prefer that contributed code be formatted similarly. In "
42516 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
42517 "indentation level, and other than that, follow the K&R style."
42521 #: ../libguestfs-1.11.20/src/guestfs.pod:2598 ../src/guestfs.pod:2598
42523 "If you use Emacs, add the following to one of one of your start-up files (e."
42524 "g., ~/.emacs), to help ensure that you get indentation right:"
42528 #: ../libguestfs-1.11.20/src/guestfs.pod:2601 ../src/guestfs.pod:2601
42531 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
42532 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
42533 " (add-hook 'find-file-hook\n"
42534 " '(lambda () (if (and buffer-file-name\n"
42535 " (string-match \"/libguestfs\\\\>\"\n"
42536 " (buffer-file-name))\n"
42537 " (not (string-equal mode-name \"Change Log\"))\n"
42538 " (not (string-equal mode-name \"Makefile\")))\n"
42539 " (setq indent-tabs-mode nil))))\n"
42544 #: ../libguestfs-1.11.20/src/guestfs.pod:2611 ../src/guestfs.pod:2611
42547 " ;;; When editing C sources in libguestfs, use this style.\n"
42548 " (defun libguestfs-c-mode ()\n"
42549 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
42551 " (c-set-style \"K&R\")\n"
42552 " (setq c-indent-level 2)\n"
42553 " (setq c-basic-offset 2))\n"
42554 " (add-hook 'c-mode-hook\n"
42555 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
42556 " (buffer-file-name))\n"
42557 " (libguestfs-c-mode))))\n"
42562 #: ../libguestfs-1.11.20/src/guestfs.pod:2623 ../src/guestfs.pod:2623
42563 msgid "Enable warnings when compiling (and fix any problems this finds):"
42567 #: ../libguestfs-1.11.20/src/guestfs.pod:2626 ../src/guestfs.pod:2626
42570 " ./configure --enable-gcc-warnings\n"
42575 #: ../libguestfs-1.11.20/src/guestfs.pod:2628 ../src/guestfs.pod:2628
42576 msgid "Useful targets are:"
42580 #: ../libguestfs-1.11.20/src/guestfs.pod:2630 ../src/guestfs.pod:2630
42583 " make syntax-check # checks the syntax of the C code\n"
42584 " make check # runs the test suite\n"
42589 #: ../libguestfs-1.11.20/src/guestfs.pod:2633 ../src/guestfs.pod:2633
42590 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
42594 #: ../libguestfs-1.11.20/src/guestfs.pod:2635 ../src/guestfs.pod:2635
42596 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
42597 "which are used to do shell quoting."
42601 #: ../libguestfs-1.11.20/src/guestfs.pod:2640 ../src/guestfs.pod:2640
42606 #: ../libguestfs-1.11.20/src/guestfs.pod:2642 ../src/guestfs.pod:2642
42608 "Simple shell quoted string. Any spaces or other shell characters are "
42613 #: ../libguestfs-1.11.20/src/guestfs.pod:2645 ../src/guestfs.pod:2645
42618 #: ../libguestfs-1.11.20/src/guestfs.pod:2647 ../src/guestfs.pod:2647
42620 "Same as C<%Q> except the string is treated as a path which is prefixed by "
42625 #: ../libguestfs-1.11.20/src/guestfs.pod:2654 ../src/guestfs.pod:2654
42628 " asprintf (&cmd, \"cat %R\", path);\n"
42633 #: ../libguestfs-1.11.20/src/guestfs.pod:2656 ../src/guestfs.pod:2656
42634 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
42638 #: ../libguestfs-1.11.20/src/guestfs.pod:2658 ../src/guestfs.pod:2658
42640 "I<Note:> Do I<not> use these when you are passing parameters to the C<command"
42641 "{,r,v,rv}()> functions. These parameters do NOT need to be quoted because "
42642 "they are not passed via the shell (instead, straight to exec). You probably "
42643 "want to use the C<sysroot_path()> function however."
42647 #: ../libguestfs-1.11.20/src/guestfs.pod:2664 ../src/guestfs.pod:2664
42648 msgid "SUBMITTING YOUR NEW API ACTIONS"
42652 #: ../libguestfs-1.11.20/src/guestfs.pod:2666 ../src/guestfs.pod:2666
42654 "Submit patches to the mailing list: L<http://www.redhat.com/mailman/listinfo/"
42655 "libguestfs> and CC to L<rjones@redhat.com>."
42659 #: ../libguestfs-1.11.20/src/guestfs.pod:2670 ../src/guestfs.pod:2670
42660 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
42664 #: ../libguestfs-1.11.20/src/guestfs.pod:2672 ../src/guestfs.pod:2672
42665 msgid "We support i18n (gettext anyhow) in the library."
42669 #: ../libguestfs-1.11.20/src/guestfs.pod:2674 ../src/guestfs.pod:2674
42671 "However many messages come from the daemon, and we don't translate those at "
42672 "the moment. One reason is that the appliance generally has all locale files "
42673 "removed from it, because they take up a lot of space. So we'd have to readd "
42674 "some of those, as well as copying our PO files into the appliance."
42678 #: ../libguestfs-1.11.20/src/guestfs.pod:2680 ../src/guestfs.pod:2680
42680 "Debugging messages are never translated, since they are intended for the "
42685 #: ../libguestfs-1.11.20/src/guestfs.pod:2683 ../src/guestfs.pod:2683
42686 msgid "SOURCE CODE SUBDIRECTORIES"
42690 #: ../libguestfs-1.11.20/src/guestfs.pod:2689 ../src/guestfs.pod:2689
42691 msgid "The libguestfs appliance, build scripts and so on."
42695 #: ../libguestfs-1.11.20/src/guestfs.pod:2691 ../src/guestfs.pod:2691
42696 msgid "C<capitests>"
42700 #: ../libguestfs-1.11.20/src/guestfs.pod:2693 ../src/guestfs.pod:2693
42701 msgid "Automated tests of the C API."
42705 #: ../libguestfs-1.11.20/src/guestfs.pod:2695 ../src/guestfs.pod:2695
42710 #: ../libguestfs-1.11.20/src/guestfs.pod:2697 ../src/guestfs.pod:2697
42712 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
42717 #: ../libguestfs-1.11.20/src/guestfs.pod:2700 ../src/guestfs.pod:2700
42722 #: ../libguestfs-1.11.20/src/guestfs.pod:2702 ../src/guestfs.pod:2702
42724 "Safety and liveness tests of components that libguestfs depends upon (not of "
42725 "libguestfs itself). Mainly this is for qemu and the kernel."
42729 #: ../libguestfs-1.11.20/src/guestfs.pod:2705 ../src/guestfs.pod:2705
42734 #: ../libguestfs-1.11.20/src/guestfs.pod:2707 ../src/guestfs.pod:2707
42735 msgid "Outside contributions, experimental parts."
42739 #: ../libguestfs-1.11.20/src/guestfs.pod:2709 ../src/guestfs.pod:2709
42744 #: ../libguestfs-1.11.20/src/guestfs.pod:2711 ../src/guestfs.pod:2711
42746 "The daemon that runs inside the libguestfs appliance and carries out actions."
42750 #: ../libguestfs-1.11.20/src/guestfs.pod:2714 ../src/guestfs.pod:2714
42755 #: ../libguestfs-1.11.20/src/guestfs.pod:2716 ../src/guestfs.pod:2716
42756 msgid "L<virt-df(1)> command and documentation."
42760 #: ../libguestfs-1.11.20/src/guestfs.pod:2718 ../src/guestfs.pod:2718
42765 #: ../libguestfs-1.11.20/src/guestfs.pod:2720 ../src/guestfs.pod:2720
42766 msgid "L<virt-edit(1)> command and documentation."
42770 #: ../libguestfs-1.11.20/src/guestfs.pod:2722 ../src/guestfs.pod:2722
42771 msgid "C<examples>"
42775 #: ../libguestfs-1.11.20/src/guestfs.pod:2724 ../src/guestfs.pod:2724
42776 msgid "C API example code."
42780 #: ../libguestfs-1.11.20/src/guestfs.pod:2726 ../src/guestfs.pod:2726
42785 #: ../libguestfs-1.11.20/src/guestfs.pod:2728 ../src/guestfs.pod:2728
42787 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
42788 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
42789 "L<virt-tar-out(1)>."
42793 #: ../libguestfs-1.11.20/src/guestfs.pod:2732 ../src/guestfs.pod:2732
42798 #: ../libguestfs-1.11.20/src/guestfs.pod:2734 ../src/guestfs.pod:2734
42800 "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
42804 #: ../libguestfs-1.11.20/src/guestfs.pod:2736 ../src/guestfs.pod:2736
42805 msgid "C<generator>"
42809 #: ../libguestfs-1.11.20/src/guestfs.pod:2738 ../src/guestfs.pod:2738
42811 "The crucially important generator, used to automatically generate large "
42812 "amounts of boilerplate C code for things like RPC and bindings."
42816 #: ../libguestfs-1.11.20/src/guestfs.pod:2741 ../src/guestfs.pod:2741
42821 #: ../libguestfs-1.11.20/src/guestfs.pod:2743 ../src/guestfs.pod:2743
42822 msgid "Files used by the test suite."
42826 #: ../libguestfs-1.11.20/src/guestfs.pod:2745 ../src/guestfs.pod:2745
42827 msgid "Some \"phony\" guest images which we test against."
42831 #: ../libguestfs-1.11.20/src/guestfs.pod:2747 ../src/guestfs.pod:2747
42832 msgid "C<inspector>"
42836 #: ../libguestfs-1.11.20/src/guestfs.pod:2749 ../src/guestfs.pod:2749
42837 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
42841 #: ../libguestfs-1.11.20/src/guestfs.pod:2751 ../src/guestfs.pod:2751
42846 #: ../libguestfs-1.11.20/src/guestfs.pod:2753 ../src/guestfs.pod:2753
42847 msgid "Logo used on the website. The fish is called Arthur by the way."
42851 #: ../libguestfs-1.11.20/src/guestfs.pod:2755 ../src/guestfs.pod:2755
42856 #: ../libguestfs-1.11.20/src/guestfs.pod:2757 ../src/guestfs.pod:2757
42857 msgid "M4 macros used by autoconf."
42861 #: ../libguestfs-1.11.20/src/guestfs.pod:2759 ../src/guestfs.pod:2759
42866 #: ../libguestfs-1.11.20/src/guestfs.pod:2761 ../src/guestfs.pod:2761
42867 msgid "Translations of simple gettext strings."
42871 #: ../libguestfs-1.11.20/src/guestfs.pod:2763 ../src/guestfs.pod:2763
42876 #: ../libguestfs-1.11.20/src/guestfs.pod:2765 ../src/guestfs.pod:2765
42878 "The build infrastructure and PO files for translations of manpages and POD "
42879 "files. Eventually this will be combined with the C<po> directory, but that "
42880 "is rather complicated."
42884 #: ../libguestfs-1.11.20/src/guestfs.pod:2769 ../src/guestfs.pod:2769
42885 msgid "C<regressions>"
42889 #: ../libguestfs-1.11.20/src/guestfs.pod:2771 ../src/guestfs.pod:2771
42890 msgid "Regression tests."
42894 #: ../libguestfs-1.11.20/src/guestfs.pod:2773 ../src/guestfs.pod:2773
42899 #: ../libguestfs-1.11.20/src/guestfs.pod:2775 ../src/guestfs.pod:2775
42900 msgid "L<virt-rescue(1)> command and documentation."
42904 #: ../libguestfs-1.11.20/src/guestfs.pod:2777 ../src/guestfs.pod:2777
42909 #: ../libguestfs-1.11.20/src/guestfs.pod:2779 ../src/guestfs.pod:2779
42910 msgid "Source code to the C library."
42914 #: ../libguestfs-1.11.20/src/guestfs.pod:2781 ../src/guestfs.pod:2781
42919 #: ../libguestfs-1.11.20/src/guestfs.pod:2783 ../src/guestfs.pod:2783
42920 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
42924 #: ../libguestfs-1.11.20/src/guestfs.pod:2785 ../src/guestfs.pod:2785
42925 msgid "C<test-tool>"
42929 #: ../libguestfs-1.11.20/src/guestfs.pod:2787 ../src/guestfs.pod:2787
42931 "Test tool for end users to test if their qemu/kernel combination will work "
42936 #: ../libguestfs-1.11.20/src/guestfs.pod:2790 ../src/guestfs.pod:2790
42941 #: ../libguestfs-1.11.20/src/guestfs.pod:2792 ../src/guestfs.pod:2792
42946 #: ../libguestfs-1.11.20/src/guestfs.pod:2794 ../src/guestfs.pod:2794
42951 #: ../libguestfs-1.11.20/src/guestfs.pod:2796 ../src/guestfs.pod:2796
42956 #: ../libguestfs-1.11.20/src/guestfs.pod:2798 ../src/guestfs.pod:2798
42961 #: ../libguestfs-1.11.20/src/guestfs.pod:2800 ../src/guestfs.pod:2800
42966 #: ../libguestfs-1.11.20/src/guestfs.pod:2802 ../src/guestfs.pod:2802
42971 #: ../libguestfs-1.11.20/src/guestfs.pod:2804 ../src/guestfs.pod:2804
42976 #: ../libguestfs-1.11.20/src/guestfs.pod:2806 ../src/guestfs.pod:2806
42977 msgid "Language bindings."
42981 #: ../libguestfs-1.11.20/src/guestfs.pod:2810 ../src/guestfs.pod:2810
42982 msgid "MAKING A STABLE RELEASE"
42986 #: ../libguestfs-1.11.20/src/guestfs.pod:2812 ../src/guestfs.pod:2812
42988 "When we make a stable release, there are several steps documented here. See "
42989 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
42994 #: ../libguestfs-1.11.20/src/guestfs.pod:2820 ../src/guestfs.pod:2820
42995 msgid "Finalize RELEASE-NOTES."
42999 #: ../libguestfs-1.11.20/src/guestfs.pod:2824 ../src/guestfs.pod:2824
43000 msgid "Update ROADMAP."
43004 #: ../libguestfs-1.11.20/src/guestfs.pod:2828 ../src/guestfs.pod:2828
43005 msgid "Run C<src/api-support/update-from-tarballs.sh>."
43009 #: ../libguestfs-1.11.20/src/guestfs.pod:2832 ../src/guestfs.pod:2832
43010 msgid "Push and pull from Transifex."
43014 #: ../libguestfs-1.11.20/src/guestfs.pod:2834 ../src/guestfs.pod:2834
43019 #: ../libguestfs-1.11.20/src/guestfs.pod:2836 ../src/guestfs.pod:2836
43027 #: ../libguestfs-1.11.20/src/guestfs.pod:2838 ../src/guestfs.pod:2838
43028 msgid "to push the latest POT files to Transifex. Then run:"
43032 #: ../libguestfs-1.11.20/src/guestfs.pod:2840 ../src/guestfs.pod:2840
43040 #: ../libguestfs-1.11.20/src/guestfs.pod:2842 ../src/guestfs.pod:2842
43041 msgid "which is a wrapper to pull the latest translated C<*.po> files."
43045 #: ../libguestfs-1.11.20/src/guestfs.pod:2846 ../src/guestfs.pod:2846
43047 "Create new stable and development directories under L<http://libguestfs.org/"
43052 #: ../libguestfs-1.11.20/src/guestfs.pod:2851 ../src/guestfs.pod:2851
43053 msgid "Create the branch in git:"
43057 #: ../libguestfs-1.11.20/src/guestfs.pod:2853 ../src/guestfs.pod:2853
43060 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
43061 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
43062 " git branch stable-1.XX\n"
43063 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
43068 #: ../libguestfs-1.11.20/src/guestfs.pod:2860 ../src/guestfs.pod:2860
43073 #: ../libguestfs-1.11.20/src/guestfs.pod:2862 ../src/guestfs.pod:2862
43074 msgid "PROTOCOL LIMITS"
43078 #: ../libguestfs-1.11.20/src/guestfs.pod:2864 ../src/guestfs.pod:2864
43080 "Internally libguestfs uses a message-based protocol to pass API calls and "
43081 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
43082 "plenty more detail about this). The maximum message size used by the "
43083 "protocol is slightly less than 4 MB. For some API calls you may need to be "
43084 "aware of this limit. The API calls which may be affected are individually "
43085 "documented, with a link back to this section of the documentation."
43089 #: ../libguestfs-1.11.20/src/guestfs.pod:2872 ../src/guestfs.pod:2872
43091 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
43092 "a simple string. Because this string is at some point internally encoded as "
43093 "a message, the maximum size that it can return is slightly under 4 MB. If "
43094 "the requested file is larger than this then you will get an error."
43098 #: ../libguestfs-1.11.20/src/guestfs.pod:2878 ../src/guestfs.pod:2878
43100 "In order to transfer large files into and out of the guest filesystem, you "
43101 "need to use particular calls that support this. The sections L</UPLOADING> "
43102 "and L</DOWNLOADING> document how to do this."
43106 #: ../libguestfs-1.11.20/src/guestfs.pod:2882 ../src/guestfs.pod:2882
43108 "You might also consider mounting the disk image using our FUSE filesystem "
43109 "support (L<guestmount(1)>)."
43113 #: ../libguestfs-1.11.20/src/guestfs.pod:2885 ../src/guestfs.pod:2885
43114 msgid "MAXIMUM NUMBER OF DISKS"
43118 #: ../libguestfs-1.11.20/src/guestfs.pod:2887 ../src/guestfs.pod:2887
43119 msgid "When using virtio disks (the default) the current limit is B<25> disks."
43123 #: ../libguestfs-1.11.20/src/guestfs.pod:2890 ../src/guestfs.pod:2890
43125 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
43126 "slots. However febootstrap only understands disks with names C</dev/vda> "
43127 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
43132 #: ../libguestfs-1.11.20/src/guestfs.pod:2895 ../src/guestfs.pod:2895
43134 "We are working to substantially raise this limit in future versions but it "
43135 "requires complex changes to qemu."
43139 #: ../libguestfs-1.11.20/src/guestfs.pod:2898 ../src/guestfs.pod:2898
43141 "In future versions of libguestfs it should also be possible to \"hot plug\" "
43142 "disks (add and remove disks after calling L</guestfs_launch>). This also "
43143 "requires changes to qemu."
43147 #: ../libguestfs-1.11.20/src/guestfs.pod:2902 ../src/guestfs.pod:2902
43148 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
43152 #: ../libguestfs-1.11.20/src/guestfs.pod:2904 ../src/guestfs.pod:2904
43153 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
43157 #: ../libguestfs-1.11.20/src/guestfs.pod:2906 ../src/guestfs.pod:2906
43159 "This is because it reserves 4 bits for the minor device number (thus C</dev/"
43160 "vda>, and C</dev/vda1> through C</dev/vda15>)."
43164 #: ../libguestfs-1.11.20/src/guestfs.pod:2909 ../src/guestfs.pod:2909
43166 "If you attach a disk with more than 15 partitions, the extra partitions are "
43167 "ignored by libguestfs."
43171 #: ../libguestfs-1.11.20/src/guestfs.pod:2912 ../src/guestfs.pod:2912
43172 msgid "MAXIMUM SIZE OF A DISK"
43176 #: ../libguestfs-1.11.20/src/guestfs.pod:2914 ../src/guestfs.pod:2914
43177 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
43181 #: ../libguestfs-1.11.20/src/guestfs.pod:2916 ../src/guestfs.pod:2916
43183 "We have tested block devices up to 1 exabyte (2**60 or "
43184 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
43189 #: ../libguestfs-1.11.20/src/guestfs.pod:2920 ../src/guestfs.pod:2920
43191 "Although libguestfs probably does not impose any limit, the underlying host "
43192 "storage will. If you store disk images on a host ext4 filesystem, then the "
43193 "maximum size will be limited by the maximum ext4 file size (currently 16 "
43194 "TB). If you store disk images as host logical volumes then you are limited "
43195 "by the maximum size of an LV."
43199 #: ../libguestfs-1.11.20/src/guestfs.pod:2926 ../src/guestfs.pod:2926
43201 "For the hugest disk image files, we recommend using XFS on the host for "
43206 #: ../libguestfs-1.11.20/src/guestfs.pod:2929 ../src/guestfs.pod:2929
43207 msgid "MAXIMUM SIZE OF A PARTITION"
43211 #: ../libguestfs-1.11.20/src/guestfs.pod:2931 ../src/guestfs.pod:2931
43213 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
43214 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
43215 "address a partition located beyond 2 TB on the disk."
43219 #: ../libguestfs-1.11.20/src/guestfs.pod:2935 ../src/guestfs.pod:2935
43221 "It is recommended that you use GPT partitions on disks which are larger than "
43222 "this size. GPT uses 64 bit sector numbers and so can address partitions "
43223 "which are theoretically larger than the largest disk we could support."
43227 #: ../libguestfs-1.11.20/src/guestfs.pod:2940 ../src/guestfs.pod:2940
43228 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
43232 #: ../libguestfs-1.11.20/src/guestfs.pod:2942 ../src/guestfs.pod:2942
43234 "This depends on the filesystem type. libguestfs itself does not impose any "
43235 "known limit. Consult Wikipedia or the filesystem documentation to find out "
43236 "what these limits are."
43240 #: ../libguestfs-1.11.20/src/guestfs.pod:2946 ../src/guestfs.pod:2946
43241 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
43245 #: ../libguestfs-1.11.20/src/guestfs.pod:2948 ../src/guestfs.pod:2948
43247 "The API functions L</guestfs_upload>, L</guestfs_download>, L</"
43248 "guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
43249 "uploads and downloads."
43253 #: ../libguestfs-1.11.20/src/guestfs.pod:2952 ../src/guestfs.pod:2952
43254 msgid "INSPECTION LIMITS"
43258 #: ../libguestfs-1.11.20/src/guestfs.pod:2954 ../src/guestfs.pod:2954
43260 "The inspection code has several arbitrary limits on things like the size of "
43261 "Windows Registry hive it will read, and the length of product name. These "
43262 "are intended to stop a malicious guest from consuming arbitrary amounts of "
43263 "memory and disk space on the host, and should not be reached in practice. "
43264 "See the source code for more information."
43268 #: ../libguestfs-1.11.20/src/guestfs.pod:2970 ../src/guestfs.pod:2970
43270 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
43271 "effect as calling C<guestfs_set_verbose (g, 1)>."
43275 #: ../libguestfs-1.11.20/src/guestfs.pod:2982 ../src/guestfs.pod:2982
43277 "Set the path that libguestfs uses to search for a supermin appliance. See "
43278 "the discussion of paths in section L</PATH> above."
43282 #: ../libguestfs-1.11.20/src/guestfs.pod:2991 ../src/guestfs.pod:2991
43283 msgid "See also L</QEMU WRAPPERS> above."
43287 #: ../libguestfs-1.11.20/src/guestfs.pod:2995 ../src/guestfs.pod:2995
43289 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
43290 "effect as calling C<guestfs_set_trace (g, 1)>."
43294 #: ../libguestfs-1.11.20/src/guestfs.pod:3013 ../src/guestfs.pod:3013
43296 "L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-"
43297 "perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, L<guestfish(1)>, "
43298 "L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
43299 "L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, L<virt-inspector(1)"
43300 ">, L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<virt-ls(1)>, "
43301 "L<virt-make-fs(1)>, L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
43302 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, "
43303 "L<hivex(3)>, L<http://libguestfs.org/>."
43307 #: ../libguestfs-1.11.20/src/guestfs.pod:3042 ../src/guestfs.pod:3042
43309 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, L<lvm"
43310 "(8)>, L<disktype(1)>."
43314 #: ../libguestfs-1.11.20/src/guestfs.pod:3049 ../src/guestfs.pod:3049
43315 #: ../tools/virt-make-fs.pl:553 ../tools/virt-win-reg.pl:761
43320 #: ../libguestfs-1.11.20/src/guestfs.pod:3051 ../src/guestfs.pod:3051
43321 msgid "To get a list of bugs against libguestfs use this link:"
43325 #: ../libguestfs-1.11.20/src/guestfs.pod:3053 ../src/guestfs.pod:3053
43327 "L<https://bugzilla.redhat.com/buglist.cgi?"
43328 "component=libguestfs&product=Virtualization+Tools>"
43332 #: ../libguestfs-1.11.20/src/guestfs.pod:3055 ../src/guestfs.pod:3055
43333 msgid "To report a new bug against libguestfs use this link:"
43337 #: ../libguestfs-1.11.20/src/guestfs.pod:3057 ../src/guestfs.pod:3057
43339 "L<https://bugzilla.redhat.com/enter_bug.cgi?"
43340 "component=libguestfs&product=Virtualization+Tools>"
43344 #: ../libguestfs-1.11.20/src/guestfs.pod:3059 ../src/guestfs.pod:3059
43345 msgid "When reporting a bug, please check:"
43349 #: ../libguestfs-1.11.20/src/guestfs.pod:3065 ../src/guestfs.pod:3065
43350 msgid "That the bug hasn't been reported already."
43354 #: ../libguestfs-1.11.20/src/guestfs.pod:3069 ../src/guestfs.pod:3069
43355 msgid "That you are testing a recent version."
43359 #: ../libguestfs-1.11.20/src/guestfs.pod:3073 ../src/guestfs.pod:3073
43360 msgid "Describe the bug accurately, and give a way to reproduce it."
43364 #: ../libguestfs-1.11.20/src/guestfs.pod:3077 ../src/guestfs.pod:3077
43366 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
43371 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:5
43372 #: ../test-tool/libguestfs-test-tool.pod:5
43373 msgid "libguestfs-test-tool - End user tests for libguestfs"
43377 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:9
43378 #: ../test-tool/libguestfs-test-tool.pod:9
43381 " libguestfs-test-tool [--options]\n"
43386 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:13
43387 #: ../test-tool/libguestfs-test-tool.pod:13
43389 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
43390 "and developers, to allow them to check basic libguestfs functionality is "
43391 "working. This is needed because libguestfs occasionally breaks for reasons "
43392 "beyond our control: usually because of changes in the underlying qemu or "
43393 "kernel packages, or the host environment."
43397 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:20
43398 #: ../test-tool/libguestfs-test-tool.pod:20
43399 msgid "If you suspect a problem in libguestfs, then just run:"
43403 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:22
43404 #: ../test-tool/libguestfs-test-tool.pod:22
43407 " libguestfs-test-tool\n"
43412 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:24
43413 #: ../test-tool/libguestfs-test-tool.pod:24
43414 msgid "It will print lots of diagnostic messages."
43418 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:26
43419 #: ../test-tool/libguestfs-test-tool.pod:26
43420 msgid "If it runs to completion successfully, you will see this near the end:"
43424 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:28
43425 #: ../test-tool/libguestfs-test-tool.pod:28
43428 " ===== TEST FINISHED OK =====\n"
43433 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:30
43434 #: ../test-tool/libguestfs-test-tool.pod:30
43435 msgid "and the test tool will exit with code 0."
43439 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:32
43440 #: ../test-tool/libguestfs-test-tool.pod:32
43442 "If it fails (and/or exits with non-zero error code), please paste the "
43443 "B<complete, unedited> output of the test tool into a bug report. More "
43444 "information about reporting bugs can be found on the L<http://libguestfs.org/"
43449 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:41
43450 #: ../test-tool/libguestfs-test-tool.pod:41
43455 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:43
43456 #: ../test-tool/libguestfs-test-tool.pod:43
43457 msgid "Display short usage information and exit."
43461 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:45
43462 #: ../test-tool/libguestfs-test-tool.pod:45
43463 msgid "I<--qemu qemu_binary>"
43467 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:47
43468 #: ../test-tool/libguestfs-test-tool.pod:47
43470 "If you have downloaded another qemu binary, point this option at the full "
43471 "path of the binary to try it."
43475 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:50
43476 #: ../test-tool/libguestfs-test-tool.pod:50
43477 msgid "I<--qemudir qemu_source_dir>"
43481 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:52
43482 #: ../test-tool/libguestfs-test-tool.pod:52
43484 "If you have compiled qemu from source, point this option at the source "
43485 "directory to try it."
43489 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:55
43490 #: ../test-tool/libguestfs-test-tool.pod:55
43491 msgid "I<--timeout N>"
43495 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:57
43496 #: ../test-tool/libguestfs-test-tool.pod:57
43498 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
43499 "does not usually need to be adjusted unless your machine is very slow."
43503 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:63
43504 #: ../test-tool/libguestfs-test-tool.pod:63
43505 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
43509 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:65
43510 #: ../test-tool/libguestfs-test-tool.pod:65
43512 "If you have compiled another version of qemu from source and would like to "
43513 "try that, then you can use the I<--qemudir> option to point to the qemu "
43514 "source directory."
43518 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:69
43519 #: ../test-tool/libguestfs-test-tool.pod:69
43521 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
43522 "option to point to the binary."
43526 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:72
43527 #: ../test-tool/libguestfs-test-tool.pod:72
43529 "When using an alternate qemu with libguestfs, usually you would need to "
43530 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in L<guestfs(3)"
43531 ">). libguestfs-test-tool writes a temporary qemu wrapper script when you "
43532 "use either of the I<--qemudir> or I<--qemu> options."
43536 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:79
43537 #: ../test-tool/libguestfs-test-tool.pod:79
43539 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
43540 "I<1> if there was an error."
43544 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:84
43545 #: ../test-tool/libguestfs-test-tool.pod:84
43547 "For the full list of environment variables which may affect libguestfs, "
43548 "please see the L<guestfs(3)> manual page."
43552 #: ../libguestfs-1.11.20/test-tool/libguestfs-test-tool.pod:89
43553 #: ../test-tool/libguestfs-test-tool.pod:89
43554 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
43558 #: ../tools/virt-list-filesystems.pl:32
43560 "virt-list-filesystems - List filesystems in a virtual machine or disk image"
43564 #: ../tools/virt-list-filesystems.pl:36
43567 " virt-list-filesystems [--options] domname\n"
43572 #: ../tools/virt-list-filesystems.pl:38
43575 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
43580 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
43582 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
43587 #: ../tools/virt-list-filesystems.pl:45
43589 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
43590 "are contained in a virtual machine or disk image."
43594 #: ../tools/virt-list-filesystems.pl:49
43596 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
43597 "functionality. For more complex cases you should look at the L<guestfish(1)"
43602 #: ../tools/virt-list-filesystems.pl:112
43604 "With this option, C<virt-list-filesystems> displays the type of each "
43605 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
43609 #: ../tools/virt-list-filesystems.pl:119
43614 #: ../tools/virt-list-filesystems.pl:123
43616 "Normally we only show mountable filesystems. If this option is given then "
43617 "swap devices are shown too."
43621 #: ../tools/virt-list-filesystems.pl:197
43623 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, L<virt-"
43624 "filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, L<Sys::"
43625 "Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
43629 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
43630 msgid "Copyright (C) 2009 Red Hat Inc."
43634 #: ../tools/virt-list-partitions.pl:32
43636 "virt-list-partitions - List partitions in a virtual machine or disk image"
43640 #: ../tools/virt-list-partitions.pl:36
43643 " virt-list-partitions [--options] domname\n"
43648 #: ../tools/virt-list-partitions.pl:38
43651 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
43656 #: ../tools/virt-list-partitions.pl:45
43658 "C<virt-list-partitions> is a command line tool to list the partitions that "
43659 "are contained in a virtual machine or disk image. It is mainly useful as a "
43660 "first step to using L<virt-resize(1)>."
43664 #: ../tools/virt-list-partitions.pl:50
43666 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
43667 "functionality. For more complex cases you should look at the L<guestfish(1)"
43672 #: ../tools/virt-list-partitions.pl:113
43673 msgid "Show sizes in human-readable form (eg. \"1G\")."
43677 #: ../tools/virt-list-partitions.pl:123
43679 "With this option, C<virt-list-partitions> displays the type and size of each "
43680 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
43684 #: ../tools/virt-list-partitions.pl:130
43689 #: ../tools/virt-list-partitions.pl:132
43694 #: ../tools/virt-list-partitions.pl:134
43696 "Display the total size of each block device (as a separate row or rows)."
43700 #: ../tools/virt-list-partitions.pl:267
43702 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, L<virt-list-"
43703 "filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib"
43704 "(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
43708 #: ../tools/virt-list-partitions.pl:283
43709 msgid "Copyright (C) 2009-2010 Red Hat Inc."
43713 #: ../tools/virt-make-fs.pl:37
43714 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
43718 #: ../tools/virt-make-fs.pl:41
43721 " virt-make-fs [--options] input.tar output.img\n"
43726 #: ../tools/virt-make-fs.pl:43
43729 " virt-make-fs [--options] input.tar.gz output.img\n"
43734 #: ../tools/virt-make-fs.pl:45
43737 " virt-make-fs [--options] directory output.img\n"
43742 #: ../tools/virt-make-fs.pl:49
43744 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
43745 "archive or some files in a directory. It is similar to tools like L<mkisofs"
43746 "(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, it can "
43747 "create common filesystem types like ext2/3 or NTFS, which can be useful if "
43748 "you want to attach these filesystems to existing virtual machines (eg. to "
43749 "import large amounts of read-only data to a VM)."
43753 #: ../tools/virt-make-fs.pl:57
43754 msgid "Basic usage is:"
43758 #: ../tools/virt-make-fs.pl:59
43761 " virt-make-fs input output\n"
43766 #: ../tools/virt-make-fs.pl:61
43768 "where C<input> is either a directory containing files that you want to add, "
43769 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
43770 "C<output> is a disk image. The input type is detected automatically. The "
43771 "output disk image defaults to a raw ext2 image unless you specify extra "
43772 "flags (see L</OPTIONS> below)."
43776 #: ../tools/virt-make-fs.pl:67
43777 msgid "EXTRA SPACE"
43781 #: ../tools/virt-make-fs.pl:69
43783 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
43784 "the files that it contains, but might have extra space. Depending on how "
43785 "you are going to use the output, you might think this extra space is wasted "
43786 "and want to minimize it, or you might want to leave space so that more files "
43787 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
43788 "but you can use the I<--size> flag to leave space in the filesystem if you "
43793 #: ../tools/virt-make-fs.pl:77
43795 "An alternative way to leave extra space but not make the output image any "
43796 "bigger is to use an alternative disk image format (instead of the default "
43797 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
43798 "image format (check your hypervisor supports this before using it). This "
43799 "allows you to choose a large I<--size> but the extra space won't actually be "
43800 "allocated in the image until you try to store something in it."
43804 #: ../tools/virt-make-fs.pl:85
43806 "Don't forget that you can also use local commands including L<resize2fs(8)> "
43807 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
43808 "to build another image from scratch."
43812 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123
43813 #: ../tools/virt-make-fs.pl:142
43818 #: ../tools/virt-make-fs.pl:91
43821 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
43826 #: ../tools/virt-make-fs.pl:93
43827 msgid "FILESYSTEM TYPE"
43831 #: ../tools/virt-make-fs.pl:95
43833 "The default filesystem type is C<ext2>. Just about any filesystem type that "
43834 "libguestfs supports can be used (but I<not> read-only formats like "
43835 "ISO9660). Here are some of the more common choices:"
43839 #: ../tools/virt-make-fs.pl:101
43844 #: ../tools/virt-make-fs.pl:103
43846 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
43847 "you are not going to use the filesystem in a way that requires the journal, "
43848 "then this is just wasted overhead."
43852 #: ../tools/virt-make-fs.pl:107
43853 msgid "I<ntfs> or I<vfat>"
43857 #: ../tools/virt-make-fs.pl:109
43858 msgid "Useful if exporting data to a Windows guest."
43862 #: ../tools/virt-make-fs.pl:111
43864 "I<Note for vfat>: The tar archive or local directory must only contain files "
43865 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
43866 "program running within libguestfs is unable to change the ownership of non-"
43867 "root files, since vfat itself does not support this."
43871 #: ../tools/virt-make-fs.pl:116
43876 #: ../tools/virt-make-fs.pl:118
43878 "Lower overhead than C<ext2>, but certain limitations on filename length and "
43879 "total filesystem size."
43883 #: ../tools/virt-make-fs.pl:125
43886 " virt-make-fs --type=minix input minixfs.img\n"
43891 #: ../tools/virt-make-fs.pl:127
43892 msgid "TO PARTITION OR NOT TO PARTITION"
43896 #: ../tools/virt-make-fs.pl:129
43897 msgid "Optionally virt-make-fs can add a partition table to the output disk."
43901 #: ../tools/virt-make-fs.pl:131
43903 "Adding a partition can make the disk image more compatible with certain "
43904 "virtualized operating systems which don't expect to see a filesystem "
43905 "directly located on a block device (Linux doesn't care and will happily "
43906 "handle both types)."
43910 #: ../tools/virt-make-fs.pl:136
43912 "On the other hand, if you have a partition table then the output image is no "
43913 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
43914 "directly on a partitioned disk image. (However libguestfs tools such as "
43915 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
43919 #: ../tools/virt-make-fs.pl:144
43920 msgid "Add an MBR partition:"
43924 #: ../tools/virt-make-fs.pl:146
43927 " virt-make-fs --partition -- input disk.img\n"
43932 #: ../tools/virt-make-fs.pl:148
43934 "If the output disk image could be terabyte-sized or larger, it's better to "
43935 "use an EFI/GPT-compatible partition table:"
43939 #: ../tools/virt-make-fs.pl:151
43942 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
43947 #: ../tools/virt-make-fs.pl:179
43948 msgid "Enable debugging information."
43952 #: ../tools/virt-make-fs.pl:185
43953 msgid "B<--size=E<lt>NE<gt>>"
43957 #: ../tools/virt-make-fs.pl:187
43958 msgid "B<--size=+E<lt>NE<gt>>"
43962 #: ../tools/virt-make-fs.pl:189
43963 msgid "B<-s E<lt>NE<gt>>"
43967 #: ../tools/virt-make-fs.pl:191
43968 msgid "B<-s +E<lt>NE<gt>>"
43972 #: ../tools/virt-make-fs.pl:193
43974 "Use the I<--size> (or I<-s>) option to choose the size of the output image."
43978 #: ../tools/virt-make-fs.pl:196
43980 "If this option is I<not> given, then the output image will be just large "
43981 "enough to contain all the files, with not much wasted space."
43985 #: ../tools/virt-make-fs.pl:199
43987 "To choose a fixed size output disk, specify an absolute number followed by b/"
43988 "K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
43989 "Petabytes or Exabytes. This must be large enough to contain all the input "
43990 "files, else you will get an error."
43994 #: ../tools/virt-make-fs.pl:204
43996 "To leave extra space, specify C<+> (plus sign) and a number followed by b/K/"
43997 "M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
43998 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
43999 "the input files, and (approximately) an extra 200 MB free space."
44003 #: ../tools/virt-make-fs.pl:210
44005 "Note that virt-make-fs estimates free space, and therefore will not produce "
44006 "filesystems containing precisely the free space requested. (It is much more "
44007 "expensive and time-consuming to produce a filesystem which has precisely the "
44008 "desired free space)."
44012 #: ../tools/virt-make-fs.pl:219
44013 msgid "B<--format=E<lt>fmtE<gt>>"
44017 #: ../tools/virt-make-fs.pl:221
44018 msgid "B<-F E<lt>fmtE<gt>>"
44022 #: ../tools/virt-make-fs.pl:223
44023 msgid "Choose the output disk image format."
44027 #: ../tools/virt-make-fs.pl:225
44028 msgid "The default is C<raw> (raw disk image)."
44032 #: ../tools/virt-make-fs.pl:227
44034 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
44035 "that would really make sense here is C<qcow2>."
44039 #: ../tools/virt-make-fs.pl:234
44040 msgid "B<--type=E<lt>fsE<gt>>"
44044 #: ../tools/virt-make-fs.pl:236
44045 msgid "B<-t E<lt>fsE<gt>>"
44049 #: ../tools/virt-make-fs.pl:238
44050 msgid "Choose the output filesystem type."
44054 #: ../tools/virt-make-fs.pl:240
44055 msgid "The default is C<ext2>."
44059 #: ../tools/virt-make-fs.pl:242
44061 "Any filesystem which is supported read-write by libguestfs can be used here."
44065 #: ../tools/virt-make-fs.pl:249
44066 msgid "B<--partition>"
44070 #: ../tools/virt-make-fs.pl:251
44071 msgid "B<--partition=E<lt>parttypeE<gt>>"
44075 #: ../tools/virt-make-fs.pl:253
44077 "If specified, this flag adds an MBR partition table to the output disk image."
44081 #: ../tools/virt-make-fs.pl:256
44083 "You can change the partition table type, eg. I<--partition=gpt> for large "
44088 #: ../tools/virt-make-fs.pl:259
44090 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
44091 "might consider the next parameter to be the partition type. For example:"
44095 #: ../tools/virt-make-fs.pl:263
44098 " virt-make-fs --partition input.tar ...\n"
44103 #: ../tools/virt-make-fs.pl:265
44105 "would cause virt-make-fs to think you wanted to use a partition type of "
44106 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
44107 "dash) between options and the input file argument:"
44111 #: ../tools/virt-make-fs.pl:269
44114 " virt-make-fs --partition -- input.tar ...\n"
44119 #: ../tools/virt-make-fs.pl:541
44121 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
44122 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, L<guestfs"
44123 "(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
44127 #: ../tools/virt-make-fs.pl:555 ../tools/virt-win-reg.pl:763
44129 "When reporting bugs, please enable debugging and capture the I<complete> "
44134 #: ../tools/virt-make-fs.pl:558
44137 " export LIBGUESTFS_DEBUG=1\n"
44138 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
44143 #: ../tools/virt-make-fs.pl:561
44145 "Attach /tmp/virt-make-fs.log to a new bug report at L<https://bugzilla."
44150 #: ../tools/virt-tar.pl:33
44151 msgid "virt-tar - Extract or upload files to a virtual machine"
44155 #: ../tools/virt-tar.pl:37
44158 " virt-tar [--options] -x domname directory tarball\n"
44163 #: ../tools/virt-tar.pl:39
44166 " virt-tar [--options] -u domname tarball directory\n"
44171 #: ../tools/virt-tar.pl:41
44174 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
44179 #: ../tools/virt-tar.pl:43
44182 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
44187 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
44192 #: ../tools/virt-tar.pl:47
44194 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-"
44195 "tar-in(1)>, L<virt-tar-out(1)> as replacements."
44199 #: ../tools/virt-tar.pl:52
44200 msgid "Download C</home> from the VM into a local tarball:"
44204 #: ../tools/virt-tar.pl:54
44207 " virt-tar -x domname /home home.tar\n"
44212 #: ../tools/virt-tar.pl:56
44215 " virt-tar -zx domname /home home.tar.gz\n"
44220 #: ../tools/virt-tar.pl:58
44221 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
44225 #: ../tools/virt-tar.pl:60
44228 " virt-tar -u domname uploadstuff.tar /tmp\n"
44233 #: ../tools/virt-tar.pl:62
44236 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
44241 #: ../tools/virt-tar.pl:66
44243 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
44244 "virtual machines. If you do this, you risk disk corruption in the VM. "
44245 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
44249 #: ../tools/virt-tar.pl:71
44251 "You can use I<-x> (extract) on live virtual machines, but you might get "
44252 "inconsistent results or errors if there is filesystem activity inside the "
44253 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
44254 "work, but the only way to guarantee consistent results is if the virtual "
44255 "machine is shut down."
44259 #: ../tools/virt-tar.pl:79
44261 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
44262 "parts of a guest filesystem. There are many possibilities: making backups, "
44263 "uploading data files, snooping on guest activity, fixing or customizing "
44268 #: ../tools/virt-tar.pl:84
44270 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
44271 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
44272 "should look at the L<guestfish(1)> tool."
44276 #: ../tools/virt-tar.pl:88
44278 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
44279 "its contents (recursively) from the virtual machine into a local tarball. "
44280 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
44281 "virtual machine. You cannot use these two options together."
44285 #: ../tools/virt-tar.pl:94
44287 "In addition, you may need to use the I<-z> (gZip) option to enable "
44288 "compression. When uploading, you have to specify I<-z> if the upload file "
44289 "is compressed because virt-tar won't detect this on its own."
44293 #: ../tools/virt-tar.pl:98
44295 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
44296 "example it cannot do PKZip files or bzip2 compression. If you want that "
44297 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
44298 "the L<libguestfs(3)> API)."
44302 #: ../tools/virt-tar.pl:160
44303 msgid "B<--extract>"
44307 #: ../tools/virt-tar.pl:162
44308 msgid "B<--download>"
44312 #: ../tools/virt-tar.pl:164
44317 #: ../tools/virt-tar.pl:166
44318 msgid "B<--upload>"
44322 #: ../tools/virt-tar.pl:168
44324 "Use I<-x> to extract (download) a directory from a virtual machine to a "
44329 #: ../tools/virt-tar.pl:171
44331 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
44332 "Please read the L</WARNING> section above before using this option."
44336 #: ../tools/virt-tar.pl:175
44337 msgid "You must specify exactly one of these options."
44341 #: ../tools/virt-tar.pl:181
44346 #: ../tools/virt-tar.pl:183
44351 #: ../tools/virt-tar.pl:185
44352 msgid "Specify that the input or output tarball is gzip-compressed."
44356 #: ../tools/virt-tar.pl:298
44358 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, L<virt-copy-"
44359 "in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<Sys::"
44360 "Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs."
44365 #: ../tools/virt-win-reg.pl:37
44367 "virt-win-reg - Export and merge Windows Registry entries from a Windows guest"
44371 #: ../tools/virt-win-reg.pl:41
44374 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
44379 #: ../tools/virt-win-reg.pl:43
44382 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
44387 #: ../tools/virt-win-reg.pl:45
44390 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
44395 #: ../tools/virt-win-reg.pl:47
44398 " virt-win-reg --merge domname [input.reg ...]\n"
44403 #: ../tools/virt-win-reg.pl:49
44406 " virt-win-reg [--options] disk.img ... # instead of domname\n"
44411 #: ../tools/virt-win-reg.pl:53
44413 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
44414 "virtual machines. If you do this, you I<will> get irreversible disk "
44415 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
44416 "but doesn't catch all cases."
44420 #: ../tools/virt-win-reg.pl:58
44422 "Modifying the Windows Registry is an inherently risky operation. The format "
44423 "is deliberately obscure and undocumented, and Registry changes can leave the "
44424 "system unbootable. Therefore when using the I<--merge> option, make sure "
44425 "you have a reliable backup first."
44429 #: ../tools/virt-win-reg.pl:65
44431 "This program can export and merge Windows Registry entries from a Windows "
44436 #: ../tools/virt-win-reg.pl:68
44438 "The first parameter is the libvirt guest name or the raw disk image of a "
44443 #: ../tools/virt-win-reg.pl:71
44445 "If I<--merge> is I<not> specified, then the chosen registry key is displayed/"
44446 "exported (recursively). For example:"
44450 #: ../tools/virt-win-reg.pl:74
44453 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
44458 #: ../tools/virt-win-reg.pl:76
44460 "You can also display single values from within registry keys, for example:"
44464 #: ../tools/virt-win-reg.pl:79
44467 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
44468 " $ virt-win-reg Windows7 $cvkey ProductName\n"
44469 " Windows 7 Enterprise\n"
44474 #: ../tools/virt-win-reg.pl:83
44476 "With I<--merge>, you can merge a textual regedit file into the Windows "
44481 #: ../tools/virt-win-reg.pl:86
44484 " $ virt-win-reg --merge Windows7 changes.reg\n"
44489 #: ../tools/virt-win-reg.pl:90
44491 "This program is only meant for simple access to the registry. If you want "
44492 "to do complicated things with the registry, we suggest you download the "
44493 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
44494 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
44495 "L<hivexregedit(1)>."
44499 #: ../tools/virt-win-reg.pl:159
44504 #: ../tools/virt-win-reg.pl:161
44506 "In merge mode, this merges a textual regedit file into the Windows Registry "
44507 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
44508 "displays or exports Registry entries instead."
44512 #: ../tools/virt-win-reg.pl:165
44514 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
44515 "result in disk corruption. However exporting (without this flag) is always "
44520 #: ../tools/virt-win-reg.pl:173
44521 msgid "B<--encoding> UTF-16LE|ASCII"
44525 #: ../tools/virt-win-reg.pl:175
44527 "When merging (only), you may need to specify the encoding for strings to be "
44528 "used in the hive file. This is explained in detail in L<Win::Hivex::Regedit"
44529 "(3)/ENCODING STRINGS>."
44533 #: ../tools/virt-win-reg.pl:179
44535 "The default is to use UTF-16LE, which should work with recent versions of "
44540 #: ../tools/virt-win-reg.pl:186
44541 msgid "B<--unsafe-printable-strings>"
44545 #: ../tools/virt-win-reg.pl:188
44547 "When exporting (only), assume strings are UTF-16LE and print them as strings "
44548 "instead of hex sequences. Remove the final zero codepoint from strings if "
44553 #: ../tools/virt-win-reg.pl:192
44555 "This is unsafe and does not preserve the fidelity of strings in the original "
44556 "Registry for various reasons:"
44560 #: ../tools/virt-win-reg.pl:199
44562 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
44563 "other encodings will be corrupted by this transformation."
44567 #: ../tools/virt-win-reg.pl:204
44569 "Assumes that everything which has type 1 or 2 is really a string and that "
44570 "everything else is not a string, but the type field in real Registries is "
44575 #: ../tools/virt-win-reg.pl:210
44577 "Loses information about whether a zero codepoint followed the string in the "
44582 #: ../tools/virt-win-reg.pl:215
44584 "This all happens because the Registry itself contains no information about "
44585 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
44589 #: ../tools/virt-win-reg.pl:219
44591 "You should only use this option for quick hacking and debugging of the "
44592 "Registry contents, and I<never> use it if the output is going to be passed "
44593 "into another program or stored in another Registry."
44597 #: ../tools/virt-win-reg.pl:556
44598 msgid "SUPPORTED SYSTEMS"
44602 #: ../tools/virt-win-reg.pl:558
44604 "The program currently supports Windows NT-derived guests starting with "
44605 "Windows XP through to at least Windows 7."
44609 #: ../tools/virt-win-reg.pl:561
44610 msgid "The following Registry keys are supported:"
44614 #: ../tools/virt-win-reg.pl:565
44615 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
44619 #: ../tools/virt-win-reg.pl:567
44620 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
44624 #: ../tools/virt-win-reg.pl:569
44625 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
44629 #: ../tools/virt-win-reg.pl:571
44630 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
44634 #: ../tools/virt-win-reg.pl:573
44635 msgid "C<HKEY_USERS\\.DEFAULT>"
44639 #: ../tools/virt-win-reg.pl:575
44640 msgid "C<HKEY_USERS\\I<SID>>"
44644 #: ../tools/virt-win-reg.pl:577
44645 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
44649 #: ../tools/virt-win-reg.pl:579
44650 msgid "C<HKEY_USERS\\I<username>>"
44654 #: ../tools/virt-win-reg.pl:581
44656 "where I<username> is a local user name (this is a libguestfs extension)."
44660 #: ../tools/virt-win-reg.pl:585
44662 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
44667 #: ../tools/virt-win-reg.pl:588
44669 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
44670 "supported (there is no \"current user\")."
44674 #: ../tools/virt-win-reg.pl:591
44679 #: ../tools/virt-win-reg.pl:593
44681 "C<virt-win-reg> expects that regedit files have already been reencoded in "
44682 "the local encoding. Usually on Linux hosts, this means UTF-8 with Unix-"
44683 "style line endings. Since Windows regedit files are often in UTF-16LE with "
44684 "Windows-style line endings, you may need to reencode the whole file before "
44685 "or after processing."
44689 #: ../tools/virt-win-reg.pl:599
44691 "To reencode a file from Windows format to Linux (before processing it with "
44692 "the I<--merge> option), you would do something like this:"
44696 #: ../tools/virt-win-reg.pl:602
44699 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
44704 #: ../tools/virt-win-reg.pl:604
44706 "To go in the opposite direction, after exporting and before sending the file "
44707 "to a Windows user, do something like this:"
44711 #: ../tools/virt-win-reg.pl:607
44714 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
44719 #: ../tools/virt-win-reg.pl:609
44720 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
44724 #: ../tools/virt-win-reg.pl:611
44726 "If you are unsure about the current encoding, use the L<file(1)> command. "
44727 "Recent versions of Windows regedit.exe produce a UTF-16LE file with Windows-"
44728 "style (CRLF) line endings, like this:"
44732 #: ../tools/virt-win-reg.pl:615
44735 " $ file software.reg\n"
44736 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
44737 " with CRLF line terminators\n"
44742 #: ../tools/virt-win-reg.pl:619
44743 msgid "This file would need conversion before you could I<--merge> it."
44747 #: ../tools/virt-win-reg.pl:621
44748 msgid "CurrentControlSet etc."
44752 #: ../tools/virt-win-reg.pl:623
44754 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
44755 "Registry at the level of the hive file, and therefore you cannot modify "
44760 #: ../tools/virt-win-reg.pl:627
44762 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
44763 "circumstances it might refer to another control set. The way to find out is "
44764 "to look at the C<HKLM\\SYSTEM\\Select> key:"
44768 #: ../tools/virt-win-reg.pl:631
44771 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
44772 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
44773 " \"Current\"=dword:00000001\n"
44774 " \"Default\"=dword:00000001\n"
44775 " \"Failed\"=dword:00000000\n"
44776 " \"LastKnownGood\"=dword:00000002\n"
44781 #: ../tools/virt-win-reg.pl:638
44782 msgid "\"Current\" is the one which Windows will choose when it boots."
44786 #: ../tools/virt-win-reg.pl:640
44788 "Similarly, other C<Current...> keys in the path may need to be replaced."
44792 #: ../tools/virt-win-reg.pl:643
44793 msgid "WINDOWS TIPS"
44797 #: ../tools/virt-win-reg.pl:645
44799 "Note that some of these tips modify the guest disk image. The guest I<must> "
44800 "be shut off, else you will get disk corruption."
44804 #: ../tools/virt-win-reg.pl:648
44805 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
44809 #: ../tools/virt-win-reg.pl:650
44811 "Prepare a DOS batch script, VBScript or executable. Upload this using "
44812 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
44813 "is uploaded into C<C:\\>:"
44817 #: ../tools/virt-win-reg.pl:654
44820 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
44825 #: ../tools/virt-win-reg.pl:656
44826 msgid "Prepare a regedit file containing the registry change:"
44830 #: ../tools/virt-win-reg.pl:658
44833 " cat > test.reg <<'EOF'\n"
44834 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
44835 " \"Test\"=\"c:\\\\test.bat\"\n"
44841 #: ../tools/virt-win-reg.pl:663
44843 "In this example we use the key C<RunOnce> which means that the script will "
44844 "run precisely once when the first user logs in. If you want it to run every "
44845 "time a user logs in, replace C<RunOnce> with C<Run>."
44849 #: ../tools/virt-win-reg.pl:667
44850 msgid "Now update the registry:"
44854 #: ../tools/virt-win-reg.pl:669
44857 " virt-win-reg --merge WindowsGuest test.reg\n"
44862 #: ../tools/virt-win-reg.pl:671
44863 msgid "INSTALLING A SERVICE"
44867 #: ../tools/virt-win-reg.pl:673
44869 "This section assumes you are familiar with Windows services, and you either "
44870 "have a program which handles the Windows Service Control Protocol directly "
44871 "or you want to run any program using a service wrapper like SrvAny or the "
44876 #: ../tools/virt-win-reg.pl:678
44878 "First upload the program and optionally the service wrapper. In this case "
44879 "the test program is called C<test.exe> and we are using the RHSrvAny wrapper:"
44883 #: ../tools/virt-win-reg.pl:682
44886 " guestfish -i -d WindowsGuest <<EOF\n"
44887 " upload rhsrvany.exe /rhsrvany.exe\n"
44888 " upload test.exe /test.exe\n"
44894 #: ../tools/virt-win-reg.pl:687
44896 "Prepare a regedit file containing the registry changes. In this example, "
44897 "the first registry change is needed for the service itself or the service "
44898 "wrapper (if used). The second registry change is only needed because I am "
44899 "using the RHSrvAny service wrapper."
44903 #: ../tools/virt-win-reg.pl:692
44906 " cat > service.reg <<'EOF'\n"
44907 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
44908 " \"Type\"=dword:00000010\n"
44909 " \"Start\"=dword:00000002\n"
44910 " \"ErrorControl\"=dword:00000001\n"
44911 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
44912 " \"DisplayName\"=\"RHSrvAny\"\n"
44913 " \"ObjectName\"=\"NetworkService\"\n"
44918 #: ../tools/virt-win-reg.pl:701
44921 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
44922 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
44923 " \"PWD\"=\"c:\\\\Temp\"\n"
44929 #: ../tools/virt-win-reg.pl:712
44931 "For use of C<ControlSet001> see the section above in this manual page. You "
44932 "may need to adjust this according to the control set that is in use by the "
44937 #: ../tools/virt-win-reg.pl:718
44939 "C<\"ObjectName\"> controls the privileges that the service will have. An "
44940 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
44941 "privileged account."
44945 #: ../tools/virt-win-reg.pl:724
44947 "For the meaning of the magic numbers, see this Microsoft KB article: "
44948 "L<http://support.microsoft.com/kb/103000>."
44952 #: ../tools/virt-win-reg.pl:729
44953 msgid "Update the registry:"
44957 #: ../tools/virt-win-reg.pl:731
44960 " virt-win-reg --merge WindowsGuest service.reg\n"
44965 #: ../tools/virt-win-reg.pl:735
44967 "Be careful when passing parameters containing C<\\> (backslash) in the "
44968 "shell. Usually you will have to use 'single quotes' or double backslashes "
44969 "(but not both) to protect them from the shell."
44973 #: ../tools/virt-win-reg.pl:739
44974 msgid "Paths and value names are case-insensitive."
44978 #: ../tools/virt-win-reg.pl:748
44980 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, L<guestfish(1)"
44981 ">, L<virt-cat(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, L<Win::Hivex"
44982 "(3)>, L<Win::Hivex::Regedit(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
44986 #: ../tools/virt-win-reg.pl:766
44989 " export LIBGUESTFS_DEBUG=1\n"
44990 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
44995 #: ../tools/virt-win-reg.pl:769
44997 "Attach /tmp/virt-win-reg.log to a new bug report at L<https://bugzilla."