1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Red Hat Inc.
3 # This file is distributed under the same license as the libguestfs package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: libguestfs 1.13.16\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-10-01 14:27+0200\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
21 #: ../cat/virt-cat.pod:3 ../cat/virt-filesystems.pod:3 ../cat/virt-ls.pod:3 ../df/virt-df.pod:3 ../edit/virt-edit.pod:3 ../erlang/examples/guestfs-erlang.pod:3 ../examples/guestfs-examples.pod:3 ../examples/guestfs-recipes.pod:14 ../fish/guestfish.pod:3 ../fish/virt-copy-in.pod:3 ../fish/virt-copy-out.pod:3 ../fish/virt-tar-in.pod:3 ../fish/virt-tar-out.pod:3 ../fuse/guestmount.pod:3 ../inspector/virt-inspector.pod:3 ../java/examples/guestfs-java.pod:3 ../ocaml/examples/guestfs-ocaml.pod:3 ../perl/examples/guestfs-perl.pod:3 ../python/examples/guestfs-python.pod:3 ../rescue/virt-rescue.pod:3 ../resize/virt-resize.pod:3 ../ruby/examples/guestfs-ruby.pod:3 ../src/guestfs.pod:3 ../test-tool/libguestfs-test-tool.pod:3 ../tools/virt-list-filesystems.pl:30 ../tools/virt-list-partitions.pl:30 ../tools/virt-make-fs.pl:35 ../tools/virt-tar.pl:31 ../tools/virt-win-reg.pl:35
26 #: ../cat/virt-cat.pod:5
27 msgid "virt-cat - Display files in a virtual machine"
31 #: ../cat/virt-cat.pod:7 ../cat/virt-filesystems.pod:7 ../cat/virt-ls.pod:7 ../df/virt-df.pod:7 ../edit/virt-edit.pod:7 ../erlang/examples/guestfs-erlang.pod:7 ../examples/guestfs-examples.pod:7 ../fish/guestfish.pod:7 ../fish/virt-copy-in.pod:7 ../fish/virt-copy-out.pod:7 ../fish/virt-tar-in.pod:7 ../fish/virt-tar-out.pod:7 ../fuse/guestmount.pod:7 ../inspector/virt-inspector.pod:7 ../java/examples/guestfs-java.pod:7 ../ocaml/examples/guestfs-ocaml.pod:7 ../perl/examples/guestfs-perl.pod:7 ../python/examples/guestfs-python.pod:7 ../rescue/virt-rescue.pod:7 ../resize/virt-resize.pod:7 ../ruby/examples/guestfs-ruby.pod:7 ../src/guestfs.pod:7 ../test-tool/libguestfs-test-tool.pod:7 ../tools/virt-list-filesystems.pl:34 ../tools/virt-list-partitions.pl:34 ../tools/virt-make-fs.pl:39 ../tools/virt-tar.pl:35 ../tools/virt-win-reg.pl:39
36 #: ../cat/virt-cat.pod:9
39 " virt-cat [--options] -d domname file [file ...]\n"
44 #: ../cat/virt-cat.pod:11
47 " virt-cat [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
52 #: ../cat/virt-cat.pod:13 ../edit/virt-edit.pod:15 ../inspector/virt-inspector.pod:13
57 #: ../cat/virt-cat.pod:15
60 " virt-cat domname file\n"
65 #: ../cat/virt-cat.pod:17
68 " virt-cat disk.img file\n"
73 #: ../cat/virt-cat.pod:19 ../cat/virt-filesystems.pod:13 ../cat/virt-ls.pod:19 ../df/virt-df.pod:21 ../edit/virt-edit.pod:27 ../erlang/examples/guestfs-erlang.pod:16 ../examples/guestfs-examples.pod:19 ../examples/guestfs-recipes.pod:18 ../fish/guestfish.pod:30 ../fish/virt-copy-in.pod:19 ../fish/virt-copy-out.pod:13 ../fish/virt-tar-in.pod:21 ../fish/virt-tar-out.pod:15 ../fuse/guestmount.pod:20 ../inspector/virt-inspector.pod:19 ../java/examples/guestfs-java.pod:15 ../ocaml/examples/guestfs-ocaml.pod:25 ../perl/examples/guestfs-perl.pod:18 ../python/examples/guestfs-python.pod:14 ../rescue/virt-rescue.pod:29 ../resize/virt-resize.pod:13 ../ruby/examples/guestfs-ruby.pod:15 ../src/guestfs.pod:23 ../test-tool/libguestfs-test-tool.pod:11 ../tools/virt-list-filesystems.pl:40 ../tools/virt-list-partitions.pl:40 ../tools/virt-make-fs.pl:47 ../tools/virt-tar.pl:77 ../tools/virt-win-reg.pl:63
78 #: ../cat/virt-cat.pod:21
80 "C<virt-cat> is a command line tool to display the contents of C<file> where "
81 "C<file> exists in the named virtual machine (or disk image)."
85 #: ../cat/virt-cat.pod:24
87 "Multiple filenames can be given, in which case they are concatenated "
88 "together. Each filename must be a full path, starting at the root directory "
89 "(starting with '/')."
93 #: ../cat/virt-cat.pod:28
95 "C<virt-cat> can be used to quickly view a file. To edit a file, use "
96 "C<virt-edit>. For more complex cases you should look at the L<guestfish(1)> "
97 "tool (see L</USING GUESTFISH> below)."
101 #: ../cat/virt-cat.pod:32 ../cat/virt-ls.pod:35 ../df/virt-df.pod:43 ../edit/virt-edit.pod:44 ../fish/guestfish.pod:41 ../fish/guestfish.pod:1018 ../fish/virt-copy-in.pod:29 ../fish/virt-copy-out.pod:21 ../fish/virt-tar-in.pod:30 ../fish/virt-tar-out.pod:24 ../fuse/guestmount.pod:39 ../resize/virt-resize.pod:27 ../tools/virt-tar.pl:50
106 #: ../cat/virt-cat.pod:34
107 msgid "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
111 #: ../cat/virt-cat.pod:37
114 " virt-cat -d mydomain /etc/fstab\n"
119 #: ../cat/virt-cat.pod:39
120 msgid "List syslog messages from a VM disk image file:"
124 #: ../cat/virt-cat.pod:41
127 " virt-cat -a disk.img /var/log/messages | tail\n"
132 #: ../cat/virt-cat.pod:43
133 msgid "Find out what DHCP IP address a VM acquired:"
137 #: ../cat/virt-cat.pod:45
140 " virt-cat -d mydomain /var/log/messages | \\\n"
141 " grep 'dhclient: bound to' | tail\n"
146 #: ../cat/virt-cat.pod:48
147 msgid "Find out what packages were recently installed:"
151 #: ../cat/virt-cat.pod:50
154 " virt-cat -d mydomain /var/log/yum.log | tail\n"
159 #: ../cat/virt-cat.pod:52
160 msgid "Find out who is logged on inside a virtual machine:"
164 #: ../cat/virt-cat.pod:54
167 " virt-cat -d mydomain /var/run/utmp > /tmp/utmp\n"
173 #: ../cat/virt-cat.pod:57
174 msgid "or who was logged on:"
178 #: ../cat/virt-cat.pod:59
181 " virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp\n"
182 " last -f /tmp/wtmp\n"
187 #: ../cat/virt-cat.pod:62 ../cat/virt-filesystems.pod:91 ../cat/virt-ls.pod:261 ../df/virt-df.pod:59 ../edit/virt-edit.pod:62 ../fish/guestfish.pod:148 ../fish/virt-copy-in.pod:45 ../fish/virt-copy-out.pod:34 ../fish/virt-tar-in.pod:42 ../fish/virt-tar-out.pod:36 ../fuse/guestmount.pod:83 ../inspector/virt-inspector.pod:55 ../rescue/virt-rescue.pod:84 ../resize/virt-resize.pod:241 ../test-tool/libguestfs-test-tool.pod:36 ../tools/virt-list-filesystems.pl:53 ../tools/virt-list-partitions.pl:54 ../tools/virt-make-fs.pl:153 ../tools/virt-tar.pl:103 ../tools/virt-win-reg.pl:96
192 #: ../cat/virt-cat.pod:66 ../cat/virt-filesystems.pod:95 ../cat/virt-ls.pod:265 ../df/virt-df.pod:63 ../edit/virt-edit.pod:66 ../fish/guestfish.pod:152 ../fuse/guestmount.pod:151 ../inspector/virt-inspector.pod:59 ../rescue/virt-rescue.pod:88 ../resize/virt-resize.pod:245 ../test-tool/libguestfs-test-tool.pod:40 ../tools/virt-list-filesystems.pl:61 ../tools/virt-list-partitions.pl:62 ../tools/virt-make-fs.pl:161 ../tools/virt-tar.pl:111 ../tools/virt-win-reg.pl:104
197 #: ../cat/virt-cat.pod:68 ../cat/virt-filesystems.pod:97 ../cat/virt-ls.pod:267 ../df/virt-df.pod:65 ../edit/virt-edit.pod:68 ../inspector/virt-inspector.pod:61 ../rescue/virt-rescue.pod:90 ../tools/virt-list-filesystems.pl:63 ../tools/virt-list-partitions.pl:64 ../tools/virt-make-fs.pl:163 ../tools/virt-tar.pl:113 ../tools/virt-win-reg.pl:106
198 msgid "Display brief help."
202 #: ../cat/virt-cat.pod:70 ../cat/virt-filesystems.pod:99 ../cat/virt-ls.pod:269 ../df/virt-df.pod:67 ../edit/virt-edit.pod:70 ../inspector/virt-inspector.pod:63 ../rescue/virt-rescue.pod:92
207 #: ../cat/virt-cat.pod:72 ../cat/virt-filesystems.pod:101 ../cat/virt-ls.pod:271 ../df/virt-df.pod:69 ../edit/virt-edit.pod:72 ../inspector/virt-inspector.pod:65 ../rescue/virt-rescue.pod:94
208 msgid "B<--add> file"
212 #: ../cat/virt-cat.pod:74 ../cat/virt-filesystems.pod:103 ../cat/virt-ls.pod:273 ../df/virt-df.pod:71 ../edit/virt-edit.pod:74 ../inspector/virt-inspector.pod:67 ../rescue/virt-rescue.pod:96
214 "Add I<file> which should be a disk image from a virtual machine. If the "
215 "virtual machine has multiple block devices, you must supply all of them with "
216 "separate I<-a> options."
220 #: ../cat/virt-cat.pod:78 ../cat/virt-filesystems.pod:107 ../cat/virt-ls.pod:277 ../df/virt-df.pod:75 ../edit/virt-edit.pod:78 ../fish/guestfish.pod:174 ../fuse/guestmount.pod:93 ../inspector/virt-inspector.pod:71 ../rescue/virt-rescue.pod:100
222 "The format of the disk image is auto-detected. To override this and force a "
223 "particular format use the I<--format=..> option."
227 #: ../cat/virt-cat.pod:81 ../cat/virt-filesystems.pod:125 ../cat/virt-ls.pod:291 ../df/virt-df.pod:78 ../rescue/virt-rescue.pod:107
232 #: ../cat/virt-cat.pod:83 ../cat/virt-filesystems.pod:127 ../cat/virt-ls.pod:293 ../df/virt-df.pod:80 ../rescue/virt-rescue.pod:109
233 msgid "B<--connect> URI"
237 #: ../cat/virt-cat.pod:85 ../cat/virt-filesystems.pod:129 ../cat/virt-ls.pod:295 ../df/virt-df.pod:82 ../edit/virt-edit.pod:99 ../inspector/virt-inspector.pod:78 ../rescue/virt-rescue.pod:111 ../tools/virt-list-filesystems.pl:81 ../tools/virt-list-partitions.pl:82 ../tools/virt-tar.pl:131 ../tools/virt-win-reg.pl:132
239 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
240 "to the default libvirt hypervisor."
244 #: ../cat/virt-cat.pod:88 ../cat/virt-filesystems.pod:132 ../cat/virt-ls.pod:298 ../df/virt-df.pod:85 ../rescue/virt-rescue.pod:114
246 "If you specify guest block devices directly (I<-a>), then libvirt is not "
251 #: ../cat/virt-cat.pod:91 ../cat/virt-filesystems.pod:141 ../cat/virt-ls.pod:307 ../df/virt-df.pod:94 ../edit/virt-edit.pod:105 ../inspector/virt-inspector.pod:85 ../rescue/virt-rescue.pod:117
256 #: ../cat/virt-cat.pod:93 ../cat/virt-filesystems.pod:143 ../cat/virt-ls.pod:309 ../df/virt-df.pod:96 ../edit/virt-edit.pod:107 ../inspector/virt-inspector.pod:87 ../rescue/virt-rescue.pod:119
257 msgid "B<--domain> guest"
261 #: ../cat/virt-cat.pod:95 ../cat/virt-filesystems.pod:145 ../cat/virt-ls.pod:311 ../df/virt-df.pod:98 ../edit/virt-edit.pod:109 ../inspector/virt-inspector.pod:89 ../rescue/virt-rescue.pod:121
263 "Add all the disks from the named libvirt guest. Domain UUIDs can be used "
268 #: ../cat/virt-cat.pod:98 ../cat/virt-filesystems.pod:148 ../cat/virt-ls.pod:314 ../edit/virt-edit.pod:112 ../fish/guestfish.pod:217 ../fuse/guestmount.pod:126 ../inspector/virt-inspector.pod:92
269 msgid "B<--echo-keys>"
273 #: ../cat/virt-cat.pod:100
275 "When prompting for keys and passphrases, virt-cat normally turns echoing off "
276 "so you cannot see what you are typing. If you are not worried about Tempest "
277 "attacks and there is no one else in the room you can specify this flag to "
278 "see what you are typing."
282 #: ../cat/virt-cat.pod:105 ../cat/virt-filesystems.pod:170 ../cat/virt-ls.pod:328 ../df/virt-df.pod:101 ../fish/guestfish.pod:233 ../fuse/guestmount.pod:133 ../inspector/virt-inspector.pod:99 ../rescue/virt-rescue.pod:124
283 msgid "B<--format=raw|qcow2|..>"
287 #: ../cat/virt-cat.pod:107 ../cat/virt-filesystems.pod:172 ../cat/virt-ls.pod:330 ../df/virt-df.pod:103 ../edit/virt-edit.pod:134 ../fish/guestfish.pod:235 ../fuse/guestmount.pod:135 ../inspector/virt-inspector.pod:101 ../rescue/virt-rescue.pod:126
292 #: ../cat/virt-cat.pod:109 ../cat/virt-filesystems.pod:174 ../cat/virt-ls.pod:332 ../df/virt-df.pod:105 ../edit/virt-edit.pod:136 ../fish/guestfish.pod:237 ../fuse/guestmount.pod:137 ../rescue/virt-rescue.pod:128
294 "The default for the I<-a> option is to auto-detect the format of the disk "
295 "image. Using this forces the disk format for I<-a> options which follow on "
296 "the command line. Using I<--format> with no argument switches back to "
297 "auto-detection for subsequent I<-a> options."
301 #: ../cat/virt-cat.pod:114 ../cat/virt-filesystems.pod:179 ../cat/virt-ls.pod:337 ../df/virt-df.pod:110 ../edit/virt-edit.pod:141 ../fish/guestfish.pod:242 ../fish/guestfish.pod:673 ../inspector/virt-inspector.pod:336 ../rescue/virt-rescue.pod:133 ../src/guestfs.pod:2791
306 #: ../cat/virt-cat.pod:116
309 " virt-cat --format=raw -a disk.img file\n"
314 #: ../cat/virt-cat.pod:118 ../cat/virt-filesystems.pod:183 ../cat/virt-ls.pod:341 ../df/virt-df.pod:114 ../edit/virt-edit.pod:145 ../fish/guestfish.pod:246 ../rescue/virt-rescue.pod:137
315 msgid "forces raw format (no auto-detection) for C<disk.img>."
319 #: ../cat/virt-cat.pod:120
322 " virt-cat --format=raw -a disk.img --format -a another.img file\n"
327 #: ../cat/virt-cat.pod:122 ../cat/virt-filesystems.pod:187 ../cat/virt-ls.pod:345 ../df/virt-df.pod:118 ../edit/virt-edit.pod:149 ../fish/guestfish.pod:250 ../rescue/virt-rescue.pod:141
329 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
330 "auto-detection for C<another.img>."
334 #: ../cat/virt-cat.pod:125 ../cat/virt-filesystems.pod:190 ../cat/virt-ls.pod:348 ../df/virt-df.pod:121 ../edit/virt-edit.pod:152 ../rescue/virt-rescue.pod:144
336 "If you have untrusted raw-format guest disk images, you should use this "
337 "option to specify the disk format. This avoids a possible security problem "
338 "with malicious guests (CVE-2010-3851)."
342 #: ../cat/virt-cat.pod:129 ../cat/virt-filesystems.pod:200 ../cat/virt-ls.pod:361 ../edit/virt-edit.pod:156 ../fish/guestfish.pod:289 ../fuse/guestmount.pod:163 ../inspector/virt-inspector.pod:114
343 msgid "B<--keys-from-stdin>"
347 #: ../cat/virt-cat.pod:131 ../cat/virt-filesystems.pod:202 ../cat/virt-ls.pod:363 ../edit/virt-edit.pod:158 ../fish/guestfish.pod:291 ../fuse/guestmount.pod:165 ../inspector/virt-inspector.pod:116
349 "Read key or passphrase parameters from stdin. The default is to try to read "
350 "passphrases from the user by opening C</dev/tty>."
354 #: ../cat/virt-cat.pod:134 ../cat/virt-filesystems.pod:261 ../cat/virt-ls.pod:425 ../df/virt-df.pod:173 ../edit/virt-edit.pod:161 ../fish/guestfish.pod:390 ../fuse/guestmount.pod:257 ../inspector/virt-inspector.pod:119 ../rescue/virt-rescue.pod:182
359 #: ../cat/virt-cat.pod:136 ../cat/virt-filesystems.pod:263 ../cat/virt-ls.pod:427 ../df/virt-df.pod:175 ../edit/virt-edit.pod:163 ../fish/guestfish.pod:392 ../fuse/guestmount.pod:259 ../inspector/virt-inspector.pod:121 ../rescue/virt-rescue.pod:184
364 #: ../cat/virt-cat.pod:138 ../cat/virt-filesystems.pod:265 ../cat/virt-ls.pod:429 ../df/virt-df.pod:177 ../edit/virt-edit.pod:165 ../inspector/virt-inspector.pod:123 ../rescue/virt-rescue.pod:186
365 msgid "Enable verbose messages for debugging."
369 #: ../cat/virt-cat.pod:140 ../cat/virt-filesystems.pod:267 ../cat/virt-ls.pod:431 ../df/virt-df.pod:179 ../edit/virt-edit.pod:167 ../fish/guestfish.pod:397 ../fuse/guestmount.pod:263 ../inspector/virt-inspector.pod:125 ../rescue/virt-rescue.pod:188 ../resize/virt-resize.pod:484
374 #: ../cat/virt-cat.pod:142 ../cat/virt-filesystems.pod:269 ../cat/virt-ls.pod:433 ../df/virt-df.pod:181 ../edit/virt-edit.pod:169 ../fish/guestfish.pod:399 ../fuse/guestmount.pod:265 ../inspector/virt-inspector.pod:127 ../rescue/virt-rescue.pod:190 ../resize/virt-resize.pod:486 ../tools/virt-list-filesystems.pl:69 ../tools/virt-list-partitions.pl:70 ../tools/virt-make-fs.pl:169 ../tools/virt-tar.pl:119 ../tools/virt-win-reg.pl:112
379 #: ../cat/virt-cat.pod:144 ../cat/virt-filesystems.pod:271 ../cat/virt-ls.pod:435 ../df/virt-df.pod:183 ../edit/virt-edit.pod:171 ../inspector/virt-inspector.pod:129 ../rescue/virt-rescue.pod:192 ../resize/virt-resize.pod:488 ../tools/virt-list-filesystems.pl:71 ../tools/virt-list-partitions.pl:72 ../tools/virt-make-fs.pl:171 ../tools/virt-tar.pl:121 ../tools/virt-win-reg.pl:114
380 msgid "Display version number and exit."
384 #: ../cat/virt-cat.pod:146 ../cat/virt-filesystems.pod:281 ../cat/virt-ls.pod:437 ../df/virt-df.pod:185 ../edit/virt-edit.pod:173 ../fish/guestfish.pod:412 ../fuse/guestmount.pod:278 ../inspector/virt-inspector.pod:131 ../rescue/virt-rescue.pod:203 ../tools/virt-tar.pl:158
389 #: ../cat/virt-cat.pod:148 ../cat/virt-filesystems.pod:283 ../cat/virt-ls.pod:439 ../df/virt-df.pod:187 ../edit/virt-edit.pod:175 ../inspector/virt-inspector.pod:133 ../rescue/virt-rescue.pod:205
390 msgid "Enable tracing of libguestfs API calls."
394 #: ../cat/virt-cat.pod:152 ../cat/virt-ls.pod:443 ../edit/virt-edit.pod:179 ../inspector/virt-inspector.pod:137 ../rescue/virt-rescue.pod:209
395 msgid "OLD-STYLE COMMAND LINE ARGUMENTS"
399 #: ../cat/virt-cat.pod:154
400 msgid "Previous versions of virt-cat allowed you to write either:"
404 #: ../cat/virt-cat.pod:156
407 " virt-cat disk.img [disk.img ...] file\n"
412 #: ../cat/virt-cat.pod:158 ../cat/virt-ls.pod:449 ../edit/virt-edit.pod:185 ../inspector/virt-inspector.pod:143 ../rescue/virt-rescue.pod:215
417 #: ../cat/virt-cat.pod:160
420 " virt-cat guestname file\n"
425 #: ../cat/virt-cat.pod:162 ../cat/virt-ls.pod:453 ../edit/virt-edit.pod:189 ../inspector/virt-inspector.pod:147 ../rescue/virt-rescue.pod:219
427 "whereas in this version you should use I<-a> or I<-d> respectively to avoid "
428 "the confusing case where a disk image might have the same name as a guest."
432 #: ../cat/virt-cat.pod:166 ../cat/virt-ls.pod:457 ../edit/virt-edit.pod:193 ../inspector/virt-inspector.pod:151 ../rescue/virt-rescue.pod:223
433 msgid "For compatibility the old style is still supported."
437 #: ../cat/virt-cat.pod:168 ../edit/virt-edit.pod:297
438 msgid "USING GUESTFISH"
442 #: ../cat/virt-cat.pod:170
444 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
445 "C<virt-cat> doesn't work."
449 #: ../cat/virt-cat.pod:173
450 msgid "Using C<virt-cat> is approximately equivalent to doing:"
454 #: ../cat/virt-cat.pod:175
457 " guestfish --ro -i -d domname download file -\n"
462 #: ../cat/virt-cat.pod:177
464 "where C<domname> is the name of the libvirt guest, and C<file> is the full "
465 "path to the file. Note the final C<-> (meaning \"output to stdout\")."
469 #: ../cat/virt-cat.pod:181
471 "The command above uses libguestfs's guest inspection feature and so does not "
472 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
473 "disk images that don't contain guests. To display a file from a disk image "
478 #: ../cat/virt-cat.pod:186
481 " guestfish --ro -a disk.img -m /dev/sda1 download file -\n"
486 #: ../cat/virt-cat.pod:188
488 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
489 "the disk image, and C<file> is the full path to the file."
493 #: ../cat/virt-cat.pod:191 ../cat/virt-filesystems.pod:365 ../cat/virt-ls.pod:483 ../df/virt-df.pod:215 ../edit/virt-edit.pod:342 ../inspector/virt-inspector.pod:352 ../rescue/virt-rescue.pod:266 ../resize/virt-resize.pod:601 ../tools/virt-list-filesystems.pl:188 ../tools/virt-list-partitions.pl:258 ../tools/virt-make-fs.pl:532 ../tools/virt-tar.pl:289 ../tools/virt-win-reg.pl:733
494 msgid "SHELL QUOTING"
498 #: ../cat/virt-cat.pod:193 ../cat/virt-filesystems.pod:367 ../cat/virt-ls.pod:485 ../df/virt-df.pod:217 ../edit/virt-edit.pod:344 ../inspector/virt-inspector.pod:354 ../rescue/virt-rescue.pod:268 ../resize/virt-resize.pod:603 ../tools/virt-list-filesystems.pl:190 ../tools/virt-list-partitions.pl:260 ../tools/virt-make-fs.pl:534 ../tools/virt-tar.pl:291 ../tools/virt-win-reg.pl:741
500 "Libvirt guest names can contain arbitrary characters, some of which have "
501 "meaning to the shell such as C<#> and space. You may need to quote or "
502 "escape these characters on the command line. See the shell manual page "
503 "L<sh(1)> for details."
507 #: ../cat/virt-cat.pod:198 ../cat/virt-filesystems.pod:372 ../cat/virt-ls.pod:490 ../df/virt-df.pod:222 ../edit/virt-edit.pod:349 ../fish/guestfish.pod:1081 ../fuse/guestmount.pod:303 ../inspector/virt-inspector.pod:375 ../resize/virt-resize.pod:608 ../test-tool/libguestfs-test-tool.pod:90
512 #: ../cat/virt-cat.pod:200 ../cat/virt-filesystems.pod:374 ../cat/virt-ls.pod:492 ../df/virt-df.pod:224 ../edit/virt-edit.pod:351 ../fuse/guestmount.pod:305 ../inspector/virt-inspector.pod:377 ../resize/virt-resize.pod:610
513 msgid "This program returns 0 if successful, or non-zero if there was an error."
517 #: ../cat/virt-cat.pod:203 ../cat/virt-filesystems.pod:377 ../cat/virt-ls.pod:495 ../df/virt-df.pod:227 ../edit/virt-edit.pod:354 ../erlang/examples/guestfs-erlang.pod:97 ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384 ../fish/guestfish.pod:1235 ../fish/virt-copy-in.pod:50 ../fish/virt-copy-out.pod:39 ../fish/virt-tar-in.pod:47 ../fish/virt-tar-out.pod:41 ../fuse/guestmount.pod:308 ../inspector/virt-inspector.pod:380 ../java/examples/guestfs-java.pod:45 ../ocaml/examples/guestfs-ocaml.pod:78 ../perl/examples/guestfs-perl.pod:39 ../python/examples/guestfs-python.pod:42 ../rescue/virt-rescue.pod:288 ../resize/virt-resize.pod:613 ../ruby/examples/guestfs-ruby.pod:36 ../src/guestfs.pod:3167 ../test-tool/libguestfs-test-tool.pod:100 ../tools/virt-list-filesystems.pl:195 ../tools/virt-list-partitions.pl:265 ../tools/virt-make-fs.pl:539 ../tools/virt-tar.pl:296 ../tools/virt-win-reg.pl:746
522 #: ../cat/virt-cat.pod:205
524 "L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
525 "L<virt-tar-out(1)>, L<http://libguestfs.org/>."
529 #: ../cat/virt-cat.pod:212 ../cat/virt-filesystems.pod:388 ../cat/virt-ls.pod:507 ../df/virt-df.pod:235 ../edit/virt-edit.pod:368 ../rescue/virt-rescue.pod:296 ../resize/virt-resize.pod:634 ../tools/virt-list-filesystems.pl:208 ../tools/virt-list-partitions.pl:277 ../tools/virt-make-fs.pl:564 ../tools/virt-tar.pl:311 ../tools/virt-win-reg.pl:772
534 #: ../cat/virt-cat.pod:214 ../cat/virt-filesystems.pod:390 ../cat/virt-ls.pod:509 ../df/virt-df.pod:237 ../edit/virt-edit.pod:370 ../inspector/virt-inspector.pod:395 ../rescue/virt-rescue.pod:298 ../resize/virt-resize.pod:636 ../tools/virt-list-filesystems.pl:210 ../tools/virt-list-partitions.pl:279 ../tools/virt-make-fs.pl:566 ../tools/virt-tar.pl:313 ../tools/virt-win-reg.pl:774
535 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
539 #: ../cat/virt-cat.pod:216 ../cat/virt-filesystems.pod:392 ../cat/virt-ls.pod:511 ../df/virt-df.pod:239 ../edit/virt-edit.pod:372 ../erlang/examples/guestfs-erlang.pod:114 ../examples/guestfs-examples.pod:49 ../examples/guestfs-recipes.pod:401 ../fish/guestfish.pod:1264 ../fish/virt-copy-in.pod:64 ../fish/virt-copy-out.pod:53 ../fish/virt-tar-in.pod:62 ../fish/virt-tar-out.pod:55 ../fuse/guestmount.pod:323 ../inspector/virt-inspector.pod:403 ../java/examples/guestfs-java.pod:62 ../ocaml/examples/guestfs-ocaml.pod:95 ../perl/examples/guestfs-perl.pod:56 ../python/examples/guestfs-python.pod:58 ../rescue/virt-rescue.pod:300 ../resize/virt-resize.pod:638 ../ruby/examples/guestfs-ruby.pod:52 ../src/guestfs.pod:3244 ../test-tool/libguestfs-test-tool.pod:110 ../tools/virt-list-filesystems.pl:212 ../tools/virt-list-partitions.pl:281 ../tools/virt-make-fs.pl:568 ../tools/virt-tar.pl:315 ../tools/virt-win-reg.pl:776
544 #: ../cat/virt-cat.pod:218 ../inspector/virt-inspector.pod:405 ../resize/virt-resize.pod:640
545 msgid "Copyright (C) 2010-2011 Red Hat Inc."
549 #: ../cat/virt-cat.pod:220 ../cat/virt-filesystems.pod:396 ../cat/virt-ls.pod:515 ../df/virt-df.pod:243 ../edit/virt-edit.pod:376 ../fish/guestfish.pod:1269 ../fish/virt-copy-in.pod:69 ../fish/virt-copy-out.pod:58 ../fish/virt-tar-in.pod:67 ../fish/virt-tar-out.pod:60 ../fuse/guestmount.pod:328 ../inspector/virt-inspector.pod:407 ../rescue/virt-rescue.pod:304 ../resize/virt-resize.pod:642 ../test-tool/libguestfs-test-tool.pod:115 ../tools/virt-list-filesystems.pl:216 ../tools/virt-list-partitions.pl:285 ../tools/virt-make-fs.pl:572 ../tools/virt-tar.pl:319 ../tools/virt-win-reg.pl:780
551 "This program is free software; you can redistribute it and/or modify it "
552 "under the terms of the GNU General Public License as published by the Free "
553 "Software Foundation; either version 2 of the License, or (at your option) "
558 #: ../cat/virt-cat.pod:225 ../cat/virt-filesystems.pod:401 ../cat/virt-ls.pod:520 ../df/virt-df.pod:248 ../edit/virt-edit.pod:381 ../fish/guestfish.pod:1274 ../fish/virt-copy-in.pod:74 ../fish/virt-copy-out.pod:63 ../fish/virt-tar-in.pod:72 ../fish/virt-tar-out.pod:65 ../fuse/guestmount.pod:333 ../inspector/virt-inspector.pod:412 ../rescue/virt-rescue.pod:309 ../resize/virt-resize.pod:647 ../test-tool/libguestfs-test-tool.pod:120 ../tools/virt-list-filesystems.pl:221 ../tools/virt-list-partitions.pl:290 ../tools/virt-make-fs.pl:577 ../tools/virt-tar.pl:324 ../tools/virt-win-reg.pl:785
560 "This program is distributed in the hope that it will be useful, but WITHOUT "
561 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
562 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
567 #: ../cat/virt-cat.pod:230 ../cat/virt-filesystems.pod:406 ../cat/virt-ls.pod:525 ../df/virt-df.pod:253 ../edit/virt-edit.pod:386 ../fish/guestfish.pod:1279 ../fish/virt-copy-in.pod:79 ../fish/virt-copy-out.pod:68 ../fish/virt-tar-in.pod:77 ../fish/virt-tar-out.pod:70 ../fuse/guestmount.pod:338 ../inspector/virt-inspector.pod:417 ../rescue/virt-rescue.pod:314 ../resize/virt-resize.pod:652 ../test-tool/libguestfs-test-tool.pod:125 ../tools/virt-list-filesystems.pl:226 ../tools/virt-list-partitions.pl:295 ../tools/virt-make-fs.pl:582 ../tools/virt-tar.pl:329 ../tools/virt-win-reg.pl:790
569 "You should have received a copy of the GNU General Public License along with "
570 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
571 "Ave, Cambridge, MA 02139, USA."
575 #: ../cat/virt-filesystems.pod:5
577 "virt-filesystems - List filesystems, partitions, block devices, LVM in a "
578 "virtual machine or disk image"
582 #: ../cat/virt-filesystems.pod:9
585 " virt-filesystems [--options] -d domname\n"
590 #: ../cat/virt-filesystems.pod:11
593 " virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
598 #: ../cat/virt-filesystems.pod:15
600 "This tool allows you to discover filesystems, partitions, logical volumes, "
601 "and their sizes in a disk image or virtual machine. It is a replacement for "
602 "L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
606 #: ../cat/virt-filesystems.pod:20
608 "One use for this tool is from shell scripts to iterate over all filesystems "
613 #: ../cat/virt-filesystems.pod:23
616 " for fs in $(virt-filesystems -a disk.img); do\n"
623 #: ../cat/virt-filesystems.pod:27
625 "Another use is to list partitions before using another tool to modify those "
626 "partitions (such as L<virt-resize(1)>). If you are curious about what an "
627 "unknown disk image contains, use this tool along with L<virt-inspector(1)>."
631 #: ../cat/virt-filesystems.pod:32
633 "Various command line options control what this program displays. You need "
634 "to give either I<-a> or I<-d> options to specify the disk image or libvirt "
635 "guest respectively. If you just specify that then the program shows "
636 "filesystems found, one per line, like this:"
640 #: ../cat/virt-filesystems.pod:37
643 " $ virt-filesystems -a disk.img\n"
645 " /dev/vg_guest/lv_root\n"
650 #: ../cat/virt-filesystems.pod:41
651 msgid "If you add I<-l> or I<--long> then the output includes extra information:"
655 #: ../cat/virt-filesystems.pod:44
658 " $ virt-filesystems -a disk.img -l\n"
659 " Name Type VFS Label Size\n"
660 " /dev/sda1 filesystem ext4 boot 524288000\n"
661 " /dev/vg_guest/lv_root filesystem ext4 root 10212081664\n"
666 #: ../cat/virt-filesystems.pod:49
668 "If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
673 #: ../cat/virt-filesystems.pod:52
676 " $ virt-filesystems -a disk.img --extra\n"
678 " /dev/vg_guest/lv_root\n"
679 " /dev/vg_guest/lv_swap\n"
680 " /dev/vg_guest/lv_data\n"
685 #: ../cat/virt-filesystems.pod:58
686 msgid "If you add I<--partitions> then partitions are shown instead of filesystems:"
690 #: ../cat/virt-filesystems.pod:60
693 " $ virt-filesystems -a disk.img --partitions\n"
700 #: ../cat/virt-filesystems.pod:64
702 "Similarly you can use I<--logical-volumes>, I<--volume-groups>, "
703 "I<--physical-volumes>, I<--block-devices> to list those items."
707 #: ../cat/virt-filesystems.pod:67
709 "You can use these options in combination as well (if you want a combination "
710 "including filesystems, you have to add I<--filesystems>). Notice that some "
711 "items fall into several categories (eg. C</dev/sda1> might be both a "
712 "partition and a filesystem). These items are listed several times. To get "
713 "a list which includes absolutely everything that virt-filesystems knows "
714 "about, use the I<--all> option."
718 #: ../cat/virt-filesystems.pod:74
720 "UUIDs (because they are quite long) are not shown by default. Add the "
721 "I<--uuid> option to display device and filesystem UUIDs in the long output."
725 #: ../cat/virt-filesystems.pod:78
727 "I<--all --long --uuid> is a useful combination to display all possible "
728 "information about everything."
732 #: ../cat/virt-filesystems.pod:81
735 " $ virt-filesystems -a win.img --all --long --uuid -h\n"
736 " Name Type VFS Label Size Parent UUID\n"
737 " /dev/sda1 filesystem ntfs System Reserved 100M - F81C92571C92112C\n"
738 " /dev/sda2 filesystem ntfs - 20G - F2E8996AE8992E3B\n"
739 " /dev/sda1 partition - - 100M /dev/sda -\n"
740 " /dev/sda2 partition - - 20G /dev/sda -\n"
741 " /dev/sda device - - 20G - -\n"
746 #: ../cat/virt-filesystems.pod:89
747 msgid "For machine-readable output, use I<--csv> to get Comma-Separated Values."
751 #: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121
756 #: ../cat/virt-filesystems.pod:112
758 "Display everything. This is currently the same as specifying these options: "
759 "I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, "
760 "I<--logical-volumes>, I<--volume-groups>, I<--physical-volumes>. (More may "
761 "be added to this list in future)."
765 #: ../cat/virt-filesystems.pod:117
766 msgid "See also I<--long>."
770 #: ../cat/virt-filesystems.pod:119
775 #: ../cat/virt-filesystems.pod:121
776 msgid "B<--block-devices>"
780 #: ../cat/virt-filesystems.pod:123
781 msgid "Display block devices."
785 #: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301 ../df/virt-df.pod:88
790 #: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303 ../df/virt-df.pod:90
792 "Write out the results in CSV format (comma-separated values). This format "
793 "can be imported easily into databases and spreadsheets, but read L</NOTE "
794 "ABOUT CSV FORMAT> below."
798 #: ../cat/virt-filesystems.pod:150
800 "When prompting for keys and passphrases, virt-filesystems normally turns "
801 "echoing off so you cannot see what you are typing. If you are not worried "
802 "about Tempest attacks and there is no one else in the room you can specify "
803 "this flag to see what you are typing."
807 #: ../cat/virt-filesystems.pod:155
812 #: ../cat/virt-filesystems.pod:157
814 "This causes filesystems that are not ordinary, mountable filesystems to be "
815 "displayed. This category includes swapspace, and filesystems that are empty "
816 "or contain unknown data."
820 #: ../cat/virt-filesystems.pod:161
821 msgid "This option implies I<--filesystems>."
825 #: ../cat/virt-filesystems.pod:163
826 msgid "B<--filesystems>"
830 #: ../cat/virt-filesystems.pod:165
832 "Display mountable filesystems. If no display option was selected then this "
837 #: ../cat/virt-filesystems.pod:168
838 msgid "With I<--extra>, non-mountable filesystems are shown too."
842 #: ../cat/virt-filesystems.pod:181
845 " virt-filesystems --format=raw -a disk.img\n"
850 #: ../cat/virt-filesystems.pod:185
853 " virt-filesystems --format=raw -a disk.img --format -a another.img\n"
858 #: ../cat/virt-filesystems.pod:194 ../cat/virt-ls.pod:352 ../df/virt-df.pod:125 ../fish/guestfish.pod:156 ../tools/virt-list-partitions.pl:109
863 #: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354 ../df/virt-df.pod:127 ../tools/virt-list-partitions.pl:111
864 msgid "B<--human-readable>"
868 #: ../cat/virt-filesystems.pod:198
869 msgid "In I<--long> mode, display sizes in human-readable format."
873 #: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366 ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
878 #: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368 ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
883 #: ../cat/virt-filesystems.pod:209
884 msgid "Display extra columns of data (\"long format\")."
888 #: ../cat/virt-filesystems.pod:211
889 msgid "A title row is added unless you also specify I<--no-title>."
893 #: ../cat/virt-filesystems.pod:213
895 "The extra columns displayed depend on what output you select, and the "
896 "ordering of columns may change in future versions. Use the title row, "
897 "I<--csv> output and/or L<csvtool(1)> to match columns to data in external "
902 #: ../cat/virt-filesystems.pod:218
904 "Use I<-h> if you want sizes to be displayed in human-readable format. The "
905 "default is to show raw numbers of I<bytes>."
909 #: ../cat/virt-filesystems.pod:221
910 msgid "Use I<--uuid> to display UUIDs too."
914 #: ../cat/virt-filesystems.pod:223
919 #: ../cat/virt-filesystems.pod:225
924 #: ../cat/virt-filesystems.pod:227
925 msgid "B<--logical-volumes>"
929 #: ../cat/virt-filesystems.pod:229
931 "Display LVM logical volumes. In this mode, these are displayed irrespective "
932 "of whether the LVs contain filesystems."
936 #: ../cat/virt-filesystems.pod:232
937 msgid "B<--no-title>"
941 #: ../cat/virt-filesystems.pod:234
942 msgid "In I<--long> mode, don't add a title row."
946 #: ../cat/virt-filesystems.pod:236
948 "Note that the order of the columns is not fixed, and may change in future "
949 "versions of virt-filesystems, so using this option may give you unexpected "
954 #: ../cat/virt-filesystems.pod:240
959 #: ../cat/virt-filesystems.pod:242
960 msgid "B<--partitions>"
964 #: ../cat/virt-filesystems.pod:244
966 "Display partitions. In this mode, these are displayed irrespective of "
967 "whether the partitions contain filesystems."
971 #: ../cat/virt-filesystems.pod:247
976 #: ../cat/virt-filesystems.pod:249
977 msgid "B<--physvols>"
981 #: ../cat/virt-filesystems.pod:251
982 msgid "B<--physical-volumes>"
986 #: ../cat/virt-filesystems.pod:253
987 msgid "Display LVM physical volumes."
991 #: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:163
996 #: ../cat/virt-filesystems.pod:257
1001 #: ../cat/virt-filesystems.pod:259
1002 msgid "In I<--long> mode, display UUIDs as well."
1006 #: ../cat/virt-filesystems.pod:273
1011 #: ../cat/virt-filesystems.pod:275
1012 msgid "B<--volgroups>"
1016 #: ../cat/virt-filesystems.pod:277
1017 msgid "B<--volume-groups>"
1021 #: ../cat/virt-filesystems.pod:279
1022 msgid "Display LVM volume groups."
1026 #: ../cat/virt-filesystems.pod:287
1031 #: ../cat/virt-filesystems.pod:289
1033 "Note that columns in the output are subject to reordering and change in "
1034 "future versions of this tool."
1038 #: ../cat/virt-filesystems.pod:294
1043 #: ../cat/virt-filesystems.pod:296
1044 msgid "The filesystem, partition, block device or LVM name."
1048 #: ../cat/virt-filesystems.pod:298
1050 "For device and partition names these are displayed as canonical libguestfs "
1051 "names, so that for example C</dev/sda2> is the second partition on the first "
1056 #: ../cat/virt-filesystems.pod:302
1058 "If the I<--long> option is B<not> specified, then only the name column is "
1059 "shown in the output."
1063 #: ../cat/virt-filesystems.pod:305
1068 #: ../cat/virt-filesystems.pod:307
1069 msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
1073 #: ../cat/virt-filesystems.pod:309
1078 #: ../cat/virt-filesystems.pod:311
1080 "If there is a filesystem, then this column displays the filesystem type if "
1081 "one could be detected, eg. C<ext4>."
1085 #: ../cat/virt-filesystems.pod:314
1090 #: ../cat/virt-filesystems.pod:316
1092 "If the object has a label (used for identifying and mounting filesystems) "
1093 "then this column contains the label."
1097 #: ../cat/virt-filesystems.pod:319
1102 #: ../cat/virt-filesystems.pod:321
1104 "The size of the object in bytes. If the I<--human> option is used then the "
1105 "size is displayed in a human-readable form."
1109 #: ../cat/virt-filesystems.pod:324
1114 #: ../cat/virt-filesystems.pod:326
1116 "The parent column records the parent relationship between objects. For "
1117 "example, if the object is a partition, then this column contains the name of "
1118 "the containing device. If the object is a logical volume, then this column "
1119 "is the name of the volume group."
1123 #: ../cat/virt-filesystems.pod:331
1128 #: ../cat/virt-filesystems.pod:333
1130 "If the object has a UUID (used for identifying and mounting filesystems and "
1131 "block devices) then this column contains the UUID as a string."
1135 #: ../cat/virt-filesystems.pod:337
1136 msgid "The UUID is only displayed if the I<--uuid> option is given."
1140 #: ../cat/virt-filesystems.pod:341 ../cat/virt-ls.pod:459 ../df/virt-df.pod:191
1141 msgid "NOTE ABOUT CSV FORMAT"
1145 #: ../cat/virt-filesystems.pod:343 ../cat/virt-ls.pod:461 ../df/virt-df.pod:193
1147 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
1148 "should be easy to parse, but it is definitely not easy to parse."
1152 #: ../cat/virt-filesystems.pod:346 ../cat/virt-ls.pod:464 ../df/virt-df.pod:196
1154 "Myth: Just split fields at commas. Reality: This does I<not> work "
1155 "reliably. This example has two columns:"
1159 #: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:467 ../df/virt-df.pod:199
1162 " \"foo,bar\",baz\n"
1167 #: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:469 ../df/virt-df.pod:201
1169 "Myth: Read the file one line at a time. Reality: This does I<not> work "
1170 "reliably. This example has one row:"
1174 #: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:472 ../df/virt-df.pod:204
1183 #: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:475 ../df/virt-df.pod:207
1185 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
1186 "packaged in major Linux distributions)."
1190 #: ../cat/virt-filesystems.pod:360 ../cat/virt-ls.pod:478 ../df/virt-df.pod:210
1192 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
1193 "or Python's built-in csv library)."
1197 #: ../cat/virt-filesystems.pod:363 ../cat/virt-ls.pod:481 ../df/virt-df.pod:213
1198 msgid "Most spreadsheets and databases can import CSV directly."
1202 #: ../cat/virt-filesystems.pod:379
1204 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
1205 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, "
1206 "L<http://libguestfs.org/>."
1210 #: ../cat/virt-filesystems.pod:394 ../tools/virt-make-fs.pl:570 ../tools/virt-win-reg.pl:778
1211 msgid "Copyright (C) 2010 Red Hat Inc."
1215 #: ../cat/virt-ls.pod:5
1216 msgid "virt-ls - List files in a virtual machine"
1220 #: ../cat/virt-ls.pod:9
1223 " virt-ls [--options] -d domname directory [directory ...]\n"
1228 #: ../cat/virt-ls.pod:11
1231 " virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory "
1237 #: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:13
1242 #: ../cat/virt-ls.pod:15
1245 " virt-ls [--options] domname directory\n"
1250 #: ../cat/virt-ls.pod:17
1253 " virt-ls [--options] disk.img [disk.img ...] directory\n"
1258 #: ../cat/virt-ls.pod:21
1260 "C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
1261 "more from a virtual machine or disk image."
1265 #: ../cat/virt-ls.pod:24
1267 "Multiple directory names can be given, in which case the output from each is "
1272 #: ../cat/virt-ls.pod:27
1274 "To list directories from a libvirt guest use the I<-d> option to specify the "
1275 "name of the guest. For a disk image, use the I<-a> option."
1279 #: ../cat/virt-ls.pod:31
1281 "C<virt-ls> can do many simple file listings. For more complicated cases you "
1282 "may need to use L<guestfish(1)>, or write a program directly to the "
1283 "L<guestfs(3)> API."
1287 #: ../cat/virt-ls.pod:37
1288 msgid "Get a list of all files and directories in a virtual machine:"
1292 #: ../cat/virt-ls.pod:39
1295 " virt-ls -R -d guest /\n"
1300 #: ../cat/virt-ls.pod:41
1301 msgid "List all setuid or setgid programs in a Linux virtual machine:"
1305 #: ../cat/virt-ls.pod:43
1308 " virt-ls -lR -d guest / | grep '^- [42]'\n"
1313 #: ../cat/virt-ls.pod:45
1314 msgid "List all public-writable directories in a Linux virtual machine:"
1318 #: ../cat/virt-ls.pod:47
1321 " virt-ls -lR -d guest / | grep '^d ...7'\n"
1326 #: ../cat/virt-ls.pod:49
1327 msgid "List all Unix domain sockets in a Linux virtual machine:"
1331 #: ../cat/virt-ls.pod:51
1334 " virt-ls -lR -d guest / | grep '^s'\n"
1339 #: ../cat/virt-ls.pod:53
1340 msgid "List all regular files with filenames ending in '.png':"
1344 #: ../cat/virt-ls.pod:55
1347 " virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
1352 #: ../cat/virt-ls.pod:57
1353 msgid "To display files larger than 10MB in home directories:"
1357 #: ../cat/virt-ls.pod:59
1360 " virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
1365 #: ../cat/virt-ls.pod:61
1366 msgid "Find everything modified in the last 7 days:"
1370 #: ../cat/virt-ls.pod:63
1373 " virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
1378 #: ../cat/virt-ls.pod:65
1379 msgid "Find regular files modified in the last 24 hours:"
1383 #: ../cat/virt-ls.pod:67
1386 " virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
1391 #: ../cat/virt-ls.pod:69
1392 msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
1396 #: ../cat/virt-ls.pod:71
1398 "Find the differences between files in a guest and an earlier snapshot of the "
1403 #: ../cat/virt-ls.pod:74
1406 " virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
1407 " virt-ls -lR -a current.img / --uids --time-t > new\n"
1408 " diff -u old new | less\n"
1413 #: ../cat/virt-ls.pod:78
1415 "The commands above won't find files where the content has changed but the "
1416 "metadata (eg. file size and modification date) is the same. To do that, you "
1417 "need to add the I<--checksum> parameter to both C<virt-ls> commands. "
1418 "I<--checksum> can be quite slow since it has to read and compute a checksum "
1419 "of every regular file in the virtual machine."
1423 #: ../cat/virt-ls.pod:84
1424 msgid "OUTPUT MODES"
1428 #: ../cat/virt-ls.pod:86
1430 "C<virt-ls> has four output modes, controlled by different combinations of "
1431 "the I<-l> and I<-R> options."
1435 #: ../cat/virt-ls.pod:89
1436 msgid "SIMPLE LISTING"
1440 #: ../cat/virt-ls.pod:91
1441 msgid "A simple listing is like the ordinary L<ls(1)> command:"
1445 #: ../cat/virt-ls.pod:93
1448 " $ virt-ls -d guest /\n"
1456 #: ../cat/virt-ls.pod:98
1457 msgid "LONG LISTING"
1461 #: ../cat/virt-ls.pod:100
1463 "With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
1464 "(more specifically, like the C<guestfs_ll> function)."
1468 #: ../cat/virt-ls.pod:103
1471 " $ virt-ls -l -d guest /\n"
1473 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
1474 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
1480 #: ../cat/virt-ls.pod:109
1482 "Note that while this is useful for displaying a directory, do not try "
1483 "parsing this output in another program. Use L</RECURSIVE LONG LISTING> "
1488 #: ../cat/virt-ls.pod:113
1489 msgid "RECURSIVE LISTING"
1493 #: ../cat/virt-ls.pod:115
1495 "With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
1496 "and directories recursively:"
1500 #: ../cat/virt-ls.pod:118
1503 " $ virt-ls -R -d guest /tmp\n"
1511 #: ../cat/virt-ls.pod:123
1513 "To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
1514 "converts C<\\0> characters to C<\\n>."
1518 #: ../cat/virt-ls.pod:126
1519 msgid "RECURSIVE LONG LISTING"
1523 #: ../cat/virt-ls.pod:128
1525 "Using I<-lR> options together changes the output to display directories "
1526 "recursively, with file stats, and optionally other features such as "
1527 "checksums and extended attributes."
1531 #: ../cat/virt-ls.pod:132
1533 "Most of the interesting features of C<virt-ls> are only available when using "
1538 #: ../cat/virt-ls.pod:135
1540 "The fields are normally space-separated. Filenames are B<not> quoted, so "
1541 "you cannot use the output in another program (because filenames can contain "
1542 "spaces and other unsafe characters). If the guest was untrusted and someone "
1543 "knew you were using C<virt-ls> to analyze the guest, they could play tricks "
1544 "on you by creating filenames with embedded newline characters. To B<safely> "
1545 "parse the output in another program, use the I<--csv> (Comma-Separated "
1550 #: ../cat/virt-ls.pod:143
1552 "Note that this output format is completely unrelated to the C<ls -lR> "
1557 #: ../cat/virt-ls.pod:146
1560 " $ virt-ls -lR -d guest /bin\n"
1561 " d 0555 4096 /bin\n"
1562 " - 0755 123 /bin/alsaunmute\n"
1563 " - 0755 28328 /bin/arch\n"
1564 " l 0777 4 /bin/awk -> gawk\n"
1565 " - 0755 27216 /bin/basename\n"
1566 " - 0755 943360 /bin/bash\n"
1572 #: ../cat/virt-ls.pod:155
1573 msgid "These basic fields are always shown:"
1577 #: ../cat/virt-ls.pod:159
1582 #: ../cat/virt-ls.pod:161
1584 "The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
1585 "(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
1586 "link), C<s> (socket) or C<u> (unknown)."
1590 #: ../cat/virt-ls.pod:171
1595 #: ../cat/virt-ls.pod:173
1596 msgid "The Unix permissions, displayed as a 4 digit octal number."
1600 #: ../cat/virt-ls.pod:175
1605 #: ../cat/virt-ls.pod:177
1607 "The size of the file. This is shown in bytes unless I<-h> or "
1608 "I<--human-readable> option is given, in which case this is shown as a "
1609 "human-readable number."
1613 #: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4245
1618 #: ../cat/virt-ls.pod:183
1619 msgid "The full path of the file or directory."
1623 #: ../cat/virt-ls.pod:185
1628 #: ../cat/virt-ls.pod:187
1629 msgid "For symbolic links only, the link target."
1633 #: ../cat/virt-ls.pod:191
1635 "In I<-lR> mode, additional command line options enable the display of more "
1640 #: ../cat/virt-ls.pod:194
1642 "With the I<--uids> flag, these additional fields are displayed before the "
1647 #: ../cat/virt-ls.pod:199
1652 #: ../cat/virt-ls.pod:201
1657 #: ../cat/virt-ls.pod:203
1659 "The UID and GID of the owner of the file (displayed numerically). Note "
1660 "these only make sense in the context of a Unix-like guest."
1664 #: ../cat/virt-ls.pod:208
1665 msgid "With the I<--times> flag, these additional fields are displayed:"
1669 #: ../cat/virt-ls.pod:212
1674 #: ../cat/virt-ls.pod:214
1675 msgid "The time of last access."
1679 #: ../cat/virt-ls.pod:216
1684 #: ../cat/virt-ls.pod:218
1685 msgid "The time of last modification."
1689 #: ../cat/virt-ls.pod:220
1694 #: ../cat/virt-ls.pod:222
1695 msgid "The time of last status change."
1699 #: ../cat/virt-ls.pod:226
1701 "The time fields are displayed as string dates and times, unless one of the "
1702 "I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
1706 #: ../cat/virt-ls.pod:229
1707 msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
1711 #: ../cat/virt-ls.pod:233
1716 #: ../cat/virt-ls.pod:235
1718 "The device containing the file (displayed as major:minor). This may not "
1719 "match devices as known to the guest."
1723 #: ../cat/virt-ls.pod:238
1728 #: ../cat/virt-ls.pod:240
1729 msgid "The inode number."
1733 #: ../cat/virt-ls.pod:242
1738 #: ../cat/virt-ls.pod:244
1739 msgid "The number of hard links."
1743 #: ../cat/virt-ls.pod:246
1748 #: ../cat/virt-ls.pod:248
1749 msgid "For block and char special files, the device (displayed as major:minor)."
1753 #: ../cat/virt-ls.pod:251
1758 #: ../cat/virt-ls.pod:253
1759 msgid "The number of 512 byte blocks allocated to the file."
1763 #: ../cat/virt-ls.pod:257
1765 "With the I<--checksum> flag, the checksum of the file contents is shown "
1766 "(only for regular files). Computing file checksums can take a considerable "
1771 #: ../cat/virt-ls.pod:280
1772 msgid "B<--checksum>"
1776 #: ../cat/virt-ls.pod:282
1777 msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
1781 #: ../cat/virt-ls.pod:284
1783 "Display checksum over file contents for regular files. With no argument, "
1784 "this defaults to using I<md5>. Using an argument, you can select the "
1785 "checksum type to use."
1789 #: ../cat/virt-ls.pod:288 ../cat/virt-ls.pod:325 ../cat/virt-ls.pod:358 ../cat/virt-ls.pod:391 ../cat/virt-ls.pod:401 ../cat/virt-ls.pod:408 ../cat/virt-ls.pod:415 ../cat/virt-ls.pod:422
1791 "This option only has effect in I<-lR> output mode. See L</RECURSIVE LONG "
1796 #: ../cat/virt-ls.pod:316
1798 "When prompting for keys and passphrases, virt-ls normally turns echoing off "
1799 "so you cannot see what you are typing. If you are not worried about Tempest "
1800 "attacks and there is no one else in the room you can specify this flag to "
1801 "see what you are typing."
1805 #: ../cat/virt-ls.pod:321
1806 msgid "B<--extra-stats>"
1810 #: ../cat/virt-ls.pod:323
1811 msgid "Display extra stats."
1815 #: ../cat/virt-ls.pod:339
1818 " virt-ls --format=raw -a disk.img /dir\n"
1823 #: ../cat/virt-ls.pod:343
1826 " virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
1831 #: ../cat/virt-ls.pod:356
1832 msgid "Display file sizes in human-readable format."
1836 #: ../cat/virt-ls.pod:370
1841 #: ../cat/virt-ls.pod:372
1842 msgid "B<--recursive>"
1846 #: ../cat/virt-ls.pod:374
1848 "Select the mode. With neither of these options, C<virt-ls> produces a "
1849 "simple, flat list of the files in the named directory. See L</SIMPLE "
1854 #: ../cat/virt-ls.pod:378
1856 "C<virt-ls -l> produces a \"long listing\", which shows more detail. See "
1861 #: ../cat/virt-ls.pod:381
1863 "C<virt-ls -R> produces a recursive list of files starting at the named "
1864 "directory. See L</RECURSIVE LISTING>."
1868 #: ../cat/virt-ls.pod:384
1870 "C<virt-ls -lR> produces a recursive long listing which can be more easily "
1871 "parsed. See L</RECURSIVE LONG LISTING>."
1875 #: ../cat/virt-ls.pod:387
1880 #: ../cat/virt-ls.pod:389
1881 msgid "Display time fields."
1885 #: ../cat/virt-ls.pod:394
1886 msgid "B<--time-days>"
1890 #: ../cat/virt-ls.pod:396
1891 msgid "Display time fields as days before now (negative if in the future)."
1895 #: ../cat/virt-ls.pod:398
1897 "Note that C<0> in output means \"up to 1 day before now\", or that the age "
1898 "of the file is between 0 and 86399 seconds."
1902 #: ../cat/virt-ls.pod:404
1903 msgid "B<--time-relative>"
1907 #: ../cat/virt-ls.pod:406
1908 msgid "Display time fields as seconds before now (negative if in the future)."
1912 #: ../cat/virt-ls.pod:411
1917 #: ../cat/virt-ls.pod:413
1918 msgid "Display time fields as seconds since the Unix epoch."
1922 #: ../cat/virt-ls.pod:418
1927 #: ../cat/virt-ls.pod:420
1928 msgid "Display UID and GID fields."
1932 #: ../cat/virt-ls.pod:445
1933 msgid "Previous versions of virt-ls allowed you to write either:"
1937 #: ../cat/virt-ls.pod:447
1940 " virt-ls disk.img [disk.img ...] /dir\n"
1945 #: ../cat/virt-ls.pod:451
1948 " virt-ls guestname /dir\n"
1953 #: ../cat/virt-ls.pod:497
1955 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, "
1956 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
1957 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
1961 #: ../cat/virt-ls.pod:513 ../df/virt-df.pod:241 ../edit/virt-edit.pod:374 ../rescue/virt-rescue.pod:302
1962 msgid "Copyright (C) 2009-2011 Red Hat Inc."
1966 #: ../df/virt-df.pod:5
1967 msgid "virt-df - Display free space on virtual filesystems"
1971 #: ../df/virt-df.pod:9
1974 " virt-df [--options]\n"
1979 #: ../df/virt-df.pod:11
1982 " virt-df [--options] -d domname\n"
1987 #: ../df/virt-df.pod:13
1990 " virt-df [--options] -a disk.img [-a disk.img ...]\n"
1995 #: ../df/virt-df.pod:17
1998 " virt-df [--options] domname\n"
2003 #: ../df/virt-df.pod:19
2006 " virt-df [--options] disk.img [disk.img ...]\n"
2011 #: ../df/virt-df.pod:23
2013 "C<virt-df> is a command line tool to display free space on virtual machine "
2014 "filesystems. Unlike other tools, it doesn't just display the size of disk "
2015 "allocated to a virtual machine, but can look inside disk images to see how "
2016 "much space is really being used."
2020 #: ../df/virt-df.pod:28
2022 "If used without any I<-a> or I<-d> arguments, C<virt-df> checks with libvirt "
2023 "to get a list of all active and inactive guests, and performs a C<df>-type "
2024 "operation on each one in turn, printing out the results."
2028 #: ../df/virt-df.pod:32
2030 "If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a "
2031 "C<df>-type operation on either the single named libvirt domain, or on the "
2032 "disk image(s) listed on the command line (which must all belong to a single "
2033 "VM). In this mode (with arguments), C<virt-df> will I<only work for a "
2034 "single guest>. If you want to run on multiple guests, then you have to "
2035 "invoke C<virt-df> multiple times."
2039 #: ../df/virt-df.pod:39
2041 "Use the I<--csv> option to get a format which can be easily parsed by other "
2042 "programs. Other options are similar to the standard L<df(1)> command."
2046 #: ../df/virt-df.pod:45
2048 "Show disk usage for a single libvirt guest called C<F14x64>. Make the "
2049 "output human-readable:"
2053 #: ../df/virt-df.pod:48
2056 " # virt-df -d F14x64 -h\n"
2057 " Filesystem Size Used Available Use%\n"
2058 " F14x64:/dev/sda1 484M 66M 393M 14%\n"
2059 " F14x64:/dev/vg_f13x64/lv_root 7.4G 3.4G 4.0G 46%\n"
2064 #: ../df/virt-df.pod:53
2065 msgid "Show disk usage for a disk image file called C<test.img>:"
2069 #: ../df/virt-df.pod:55
2072 " $ virt-df -a test1.img\n"
2073 " Filesystem 1K-blocks Used Available Use%\n"
2074 " test1.img:/dev/sda1 99099 1551 92432 2%\n"
2079 #: ../df/virt-df.pod:112
2082 " virt-df --format=raw -a disk.img\n"
2087 #: ../df/virt-df.pod:116
2090 " virt-df --format=raw -a disk.img --format -a another.img\n"
2095 #: ../df/virt-df.pod:129
2096 msgid "Print sizes in human-readable format."
2100 #: ../df/virt-df.pod:131
2101 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
2105 #: ../df/virt-df.pod:133 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:155
2110 #: ../df/virt-df.pod:135
2115 #: ../df/virt-df.pod:137
2116 msgid "Print inodes instead of blocks."
2120 #: ../df/virt-df.pod:139
2121 msgid "B<--one-per-guest>"
2125 #: ../df/virt-df.pod:141
2127 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
2128 "disks from several guests to a single libguestfs appliance."
2132 #: ../df/virt-df.pod:144
2133 msgid "You might use this option in the following circumstances:"
2137 #: ../df/virt-df.pod:148 ../df/virt-df.pod:154 ../edit/virt-edit.pod:266 ../edit/virt-edit.pod:271 ../edit/virt-edit.pod:276 ../edit/virt-edit.pod:287 ../edit/virt-edit.pod:291 ../examples/guestfs-recipes.pod:98 ../examples/guestfs-recipes.pod:102 ../examples/guestfs-recipes.pod:106 ../examples/guestfs-recipes.pod:132 ../examples/guestfs-recipes.pod:137 ../examples/guestfs-recipes.pod:227 ../examples/guestfs-recipes.pod:231 ../examples/guestfs-recipes.pod:235 ../examples/guestfs-recipes.pod:239 ../examples/guestfs-recipes.pod:243 ../fish/guestfish-actions.pod:13 ../fish/guestfish-actions.pod:20 ../fish/guestfish-actions.pod:390 ../fish/guestfish-actions.pod:398 ../fish/guestfish-actions.pod:405 ../fish/guestfish-actions.pod:412 ../fish/guestfish-actions.pod:1139 ../fish/guestfish-actions.pod:1143 ../fish/guestfish-actions.pod:1147 ../fish/guestfish-actions.pod:1151 ../fish/guestfish-actions.pod:1159 ../fish/guestfish-actions.pod:1163 ../fish/guestfish-actions.pod:1167 ../fish/guestfish-actions.pod:1177 ../fish/guestfish-actions.pod:1181 ../fish/guestfish-actions.pod:1185 ../fish/guestfish-actions.pod:1275 ../fish/guestfish-actions.pod:1279 ../fish/guestfish-actions.pod:1284 ../fish/guestfish-actions.pod:1289 ../fish/guestfish-actions.pod:1331 ../fish/guestfish-actions.pod:1335 ../fish/guestfish-actions.pod:1340 ../fish/guestfish-actions.pod:1596 ../fish/guestfish-actions.pod:1603 ../fish/guestfish-actions.pod:1610 ../fish/guestfish-actions.pod:2005 ../fish/guestfish-actions.pod:2011 ../fish/guestfish-actions.pod:2019 ../fish/guestfish-actions.pod:2026 ../fish/guestfish-actions.pod:2033 ../fish/guestfish.pod:445 ../fish/guestfish.pod:449 ../fish/guestfish.pod:453 ../fish/guestfish.pod:457 ../inspector/virt-inspector.pod:393 ../inspector/virt-inspector.pod:397 ../resize/virt-resize.pod:282 ../resize/virt-resize.pod:286 ../resize/virt-resize.pod:295 ../resize/virt-resize.pod:301 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:29 ../src/guestfs-actions.pod:588 ../src/guestfs-actions.pod:596 ../src/guestfs-actions.pod:603 ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1774 ../src/guestfs-actions.pod:1778 ../src/guestfs-actions.pod:1782 ../src/guestfs-actions.pod:1786 ../src/guestfs-actions.pod:1794 ../src/guestfs-actions.pod:1798 ../src/guestfs-actions.pod:1802 ../src/guestfs-actions.pod:1812 ../src/guestfs-actions.pod:1816 ../src/guestfs-actions.pod:1820 ../src/guestfs-actions.pod:1958 ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:1967 ../src/guestfs-actions.pod:1972 ../src/guestfs-actions.pod:2033 ../src/guestfs-actions.pod:2037 ../src/guestfs-actions.pod:2042 ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:2462 ../src/guestfs-actions.pod:2469 ../src/guestfs-actions.pod:3006 ../src/guestfs-actions.pod:3012 ../src/guestfs-actions.pod:3020 ../src/guestfs-actions.pod:3027 ../src/guestfs-actions.pod:3034 ../src/guestfs.pod:388 ../src/guestfs.pod:393 ../src/guestfs.pod:398 ../src/guestfs.pod:402 ../src/guestfs.pod:407 ../src/guestfs.pod:411 ../src/guestfs.pod:416 ../src/guestfs.pod:421 ../src/guestfs.pod:1094 ../src/guestfs.pod:1098 ../src/guestfs.pod:1102 ../src/guestfs.pod:1107 ../src/guestfs.pod:1115 ../src/guestfs.pod:1134 ../src/guestfs.pod:1142 ../src/guestfs.pod:1164 ../src/guestfs.pod:1168 ../src/guestfs.pod:1172 ../src/guestfs.pod:1176 ../src/guestfs.pod:1180 ../src/guestfs.pod:1184 ../src/guestfs.pod:1674 ../src/guestfs.pod:1679 ../src/guestfs.pod:1683 ../src/guestfs.pod:1785 ../src/guestfs.pod:1790 ../src/guestfs.pod:1794 ../src/guestfs.pod:1804 ../src/guestfs.pod:2093 ../src/guestfs.pod:2098 ../src/guestfs.pod:2104 ../src/guestfs.pod:2112 ../src/guestfs.pod:2559 ../src/guestfs.pod:2565 ../src/guestfs.pod:2570 ../src/guestfs.pod:2576 ../src/guestfs.pod:2959 ../src/guestfs.pod:2964 ../src/guestfs.pod:2968 ../src/guestfs.pod:2972 ../src/guestfs.pod:2976 ../src/guestfs.pod:2990 ../src/guestfs.pod:2995 ../src/guestfs.pod:3221 ../src/guestfs.pod:3225 ../src/guestfs.pod:3229 ../src/guestfs.pod:3233 ../tools/virt-win-reg.pl:197 ../tools/virt-win-reg.pl:202 ../tools/virt-win-reg.pl:208 ../tools/virt-win-reg.pl:710 ../tools/virt-win-reg.pl:716 ../tools/virt-win-reg.pl:722
2142 #: ../df/virt-df.pod:150
2144 "If you think an untrusted guest might actively try to exploit the libguestfs "
2145 "appliance kernel, then this prevents one guest from interfering with the "
2146 "stats printed for another guest."
2150 #: ../df/virt-df.pod:156
2152 "If the kernel has a bug which stops it from accessing a filesystem in one "
2153 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
2154 "and report stats for further guests."
2158 #: ../df/virt-df.pod:165
2160 "Print UUIDs instead of names. This is useful for following a guest even "
2161 "when the guest is migrated or renamed, or when two guests happen to have the "
2166 #: ../df/virt-df.pod:169
2168 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
2169 "images, we still print the disk image name even when this option is "
2174 #: ../df/virt-df.pod:229
2176 "L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
2177 "L<http://libguestfs.org/>."
2181 #: ../edit/virt-edit.pod:5
2182 msgid "virt-edit - Edit a file in a virtual machine"
2186 #: ../edit/virt-edit.pod:9
2189 " virt-edit [--options] -d domname file [file ...]\n"
2194 #: ../edit/virt-edit.pod:11
2197 " virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
2202 #: ../edit/virt-edit.pod:13
2205 " virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
2210 #: ../edit/virt-edit.pod:17
2213 " virt-edit domname file\n"
2218 #: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
2221 " virt-edit disk.img [disk.img ...] file\n"
2226 #: ../edit/virt-edit.pod:21 ../fish/guestfish.pod:23 ../fish/virt-copy-in.pod:13 ../fish/virt-tar-in.pod:15 ../fuse/guestmount.pod:15 ../rescue/virt-rescue.pod:19 ../tools/virt-tar.pl:64 ../tools/virt-win-reg.pl:51
2231 #: ../edit/virt-edit.pod:23
2233 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
2234 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
2235 "doing this, but doesn't catch all cases."
2239 #: ../edit/virt-edit.pod:29
2241 "C<virt-edit> is a command line tool to edit C<file> where each C<file> "
2242 "exists in the named virtual machine (or disk image)."
2246 #: ../edit/virt-edit.pod:32
2248 "Multiple filenames can be given, in which case they are each edited in "
2249 "turn. Each filename must be a full path, starting at the root directory "
2250 "(starting with '/')."
2254 #: ../edit/virt-edit.pod:36
2255 msgid "If you want to just view a file, use L<virt-cat(1)>."
2259 #: ../edit/virt-edit.pod:38
2261 "For more complex cases you should look at the L<guestfish(1)> tool (see "
2262 "L</USING GUESTFISH> below)."
2266 #: ../edit/virt-edit.pod:41
2268 "C<virt-edit> cannot be used to create a new file. L<guestfish(1)> can do "
2269 "that and much more."
2273 #: ../edit/virt-edit.pod:46
2274 msgid "Edit the named files interactively:"
2278 #: ../edit/virt-edit.pod:48
2281 " virt-edit -d mydomain /boot/grub/grub.conf\n"
2286 #: ../edit/virt-edit.pod:50
2289 " virt-edit -d mydomain /etc/passwd\n"
2294 #: ../edit/virt-edit.pod:52
2295 msgid "For Windows guests, some Windows paths are understood:"
2299 #: ../edit/virt-edit.pod:54
2302 " virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
2307 #: ../edit/virt-edit.pod:56
2309 "If Perl is installed, you can also edit files non-interactively (see "
2310 "L</NON-INTERACTIVE EDITING> below). To change the init default level to 5:"
2314 #: ../edit/virt-edit.pod:60
2317 " virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
2322 #: ../edit/virt-edit.pod:81
2323 msgid "B<-b> extension"
2327 #: ../edit/virt-edit.pod:83
2328 msgid "B<--backup> extension"
2332 #: ../edit/virt-edit.pod:85
2334 "Create a backup of the original file I<in the guest disk image>. The backup "
2335 "has the original filename with C<extension> added."
2339 #: ../edit/virt-edit.pod:88
2341 "Usually the first character of C<extension> would be a dot C<.> so you would "
2346 #: ../edit/virt-edit.pod:91
2349 " virt-edit -b .orig [etc]\n"
2354 #: ../edit/virt-edit.pod:93
2355 msgid "By default, no backup file is made."
2359 #: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181 ../fuse/guestmount.pod:96 ../inspector/virt-inspector.pod:74 ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78 ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
2364 #: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183 ../fuse/guestmount.pod:98 ../inspector/virt-inspector.pod:76 ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80 ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
2365 msgid "B<--connect URI>"
2369 #: ../edit/virt-edit.pod:102 ../tools/virt-list-filesystems.pl:84 ../tools/virt-list-partitions.pl:85 ../tools/virt-tar.pl:134 ../tools/virt-win-reg.pl:135
2371 "If you specify guest block devices directly, then libvirt is not used at "
2376 #: ../edit/virt-edit.pod:114
2378 "When prompting for keys and passphrases, virt-edit normally turns echoing "
2379 "off so you cannot see what you are typing. If you are not worried about "
2380 "Tempest attacks and there is no one else in the room you can specify this "
2381 "flag to see what you are typing."
2385 #: ../edit/virt-edit.pod:119
2390 #: ../edit/virt-edit.pod:121
2391 msgid "B<--expr> EXPR"
2395 #: ../edit/virt-edit.pod:123
2397 "Instead of launching the external editor, non-interactively apply the Perl "
2398 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
2403 #: ../edit/virt-edit.pod:127
2405 "Be careful to properly quote the expression to prevent it from being altered "
2410 #: ../edit/virt-edit.pod:130
2411 msgid "Note that this option is only available when Perl 5 is installed."
2415 #: ../edit/virt-edit.pod:132
2416 msgid "B<--format> raw|qcow2|..."
2420 #: ../edit/virt-edit.pod:143
2423 " virt-edit --format=raw -a disk.img file\n"
2428 #: ../edit/virt-edit.pod:147
2431 " virt-edit --format=raw -a disk.img --format -a another.img file\n"
2436 #: ../edit/virt-edit.pod:181
2437 msgid "Previous versions of virt-edit allowed you to write either:"
2441 #: ../edit/virt-edit.pod:187
2444 " virt-edit guestname file\n"
2449 #: ../edit/virt-edit.pod:195
2450 msgid "NON-INTERACTIVE EDITING"
2454 #: ../edit/virt-edit.pod:197
2456 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
2457 "administrator can interactively edit the file."
2461 #: ../edit/virt-edit.pod:200
2463 "There are two ways also to use C<virt-edit> from scripts in order to make "
2464 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
2465 "like this, it's less error-prone to write scripts directly using the "
2466 "libguestfs API and Augeas for configuration file editing.)"
2470 #: ../edit/virt-edit.pod:206
2472 "The first method is to temporarily set C<$EDITOR> to any script or program "
2473 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
2474 "update C<tmpfile> in place however it likes."
2478 #: ../edit/virt-edit.pod:210
2480 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
2481 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
2482 "instances of C<foo> with C<bar> in a file:"
2486 #: ../edit/virt-edit.pod:214
2489 " virt-edit -d domname filename -e 's/foo/bar/'\n"
2494 #: ../edit/virt-edit.pod:216
2496 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
2497 "For example to delete root's password you could do:"
2501 #: ../edit/virt-edit.pod:219
2504 " virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
2509 #: ../edit/virt-edit.pod:221
2511 "What really happens is that the snippet is evaluated as a Perl expression "
2512 "for each line of the file. The line, including the final C<\\n>, is passed "
2513 "in C<$_> and the expression should update C<$_> or leave it unchanged."
2517 #: ../edit/virt-edit.pod:226
2519 "To delete a line, set C<$_> to the empty string. For example, to delete the "
2520 "C<apache> user account from the password file you can do:"
2524 #: ../edit/virt-edit.pod:229
2527 " virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
2532 #: ../edit/virt-edit.pod:231
2534 "To insert a line, prepend or append it to C<$_>. However appending lines to "
2535 "the end of the file is rather difficult this way since there is no concept "
2536 "of \"last line of the file\" - your expression just doesn't get called "
2537 "again. You might want to use the first method (setting C<$EDITOR>) if you "
2542 #: ../edit/virt-edit.pod:237
2544 "The variable C<$lineno> contains the current line number. As is "
2545 "traditional, the first line in the file is number C<1>."
2549 #: ../edit/virt-edit.pod:240
2551 "The return value from the expression is ignored, but the expression may call "
2552 "C<die> in order to abort the whole program, leaving the original file "
2557 #: ../edit/virt-edit.pod:244
2559 "Remember when matching the end of a line that C<$_> may contain the final "
2560 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
2561 "newline then neither of these. Thus to match or substitute some text at the "
2562 "end of a line, use this regular expression:"
2566 #: ../edit/virt-edit.pod:249
2569 " /some text(\\r?\\n)?$/\n"
2574 #: ../edit/virt-edit.pod:251
2576 "Alternately, use the perl C<chomp> function, being careful not to chomp "
2577 "C<$_> itself (since that would remove all newlines from the file):"
2581 #: ../edit/virt-edit.pod:255
2584 " my $m = $_; chomp $m; $m =~ /some text$/\n"
2589 #: ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
2590 msgid "WINDOWS PATHS"
2594 #: ../edit/virt-edit.pod:259
2596 "C<virt-edit> has a limited ability to understand Windows drive letters and "
2597 "paths (eg. C<E:\\foo\\bar.txt>)."
2601 #: ../edit/virt-edit.pod:262
2602 msgid "If and only if the guest is running Windows then:"
2606 #: ../edit/virt-edit.pod:268
2608 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
2609 "to the correct filesystem."
2613 #: ../edit/virt-edit.pod:273
2615 "Any backslash (C<\\>) characters in the path are replaced with forward "
2616 "slashes so that libguestfs can process it."
2620 #: ../edit/virt-edit.pod:278
2622 "The path is resolved case insensitively to locate the file that should be "
2627 #: ../edit/virt-edit.pod:283
2628 msgid "There are some known shortcomings:"
2632 #: ../edit/virt-edit.pod:289
2633 msgid "Some NTFS symbolic links may not be followed correctly."
2637 #: ../edit/virt-edit.pod:293
2638 msgid "NTFS junction points that cross filesystems are not followed."
2642 #: ../edit/virt-edit.pod:299
2644 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
2645 "C<virt-edit> doesn't work."
2649 #: ../edit/virt-edit.pod:302
2650 msgid "Using C<virt-edit> is approximately equivalent to doing:"
2654 #: ../edit/virt-edit.pod:304
2657 " guestfish --rw -i -d domname edit /file\n"
2662 #: ../edit/virt-edit.pod:306
2664 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
2669 #: ../edit/virt-edit.pod:309
2671 "The command above uses libguestfs's guest inspection feature and so does not "
2672 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
2673 "disk images that don't contain guests. To edit a file on a disk image "
2678 #: ../edit/virt-edit.pod:314
2681 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
2686 #: ../edit/virt-edit.pod:316
2688 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
2689 "the disk image to edit, and C</file> is the full path to the file."
2693 #: ../edit/virt-edit.pod:320
2695 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
2696 "C<write> or C<upload> instead:"
2700 #: ../edit/virt-edit.pod:323
2703 " guestfish --rw -i -d domname touch /newfile\n"
2708 #: ../edit/virt-edit.pod:325
2711 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
2716 #: ../edit/virt-edit.pod:327
2719 " guestfish --rw -i -d domname upload localfile /newfile\n"
2724 #: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1086 ../rescue/virt-rescue.pod:261 ../src/guestfs.pod:3106 ../test-tool/libguestfs-test-tool.pod:95
2725 msgid "ENVIRONMENT VARIABLES"
2729 #: ../edit/virt-edit.pod:333
2734 #: ../edit/virt-edit.pod:335
2736 "If set, this string is used as the editor. It may contain arguments, "
2737 "eg. C<\"emacs -nw\">"
2741 #: ../edit/virt-edit.pod:338
2742 msgid "If not set, C<vi> is used."
2746 #: ../edit/virt-edit.pod:356
2748 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
2749 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
2750 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
2754 #: ../erlang/examples/guestfs-erlang.pod:5
2755 msgid "guestfs-erlang - How to use libguestfs from Erlang"
2759 #: ../erlang/examples/guestfs-erlang.pod:9
2762 " {ok, G} = guestfs:create(),\n"
2763 " ok = guestfs:add_drive_opts(G, Disk,\n"
2764 " [{format, \"raw\"}, {readonly, true}]),\n"
2765 " ok = guestfs:launch(G),\n"
2766 " [Device] = guestfs:list_devices(G),\n"
2767 " ok = guestfs:close(G).\n"
2772 #: ../erlang/examples/guestfs-erlang.pod:18
2774 "This manual page documents how to call libguestfs from the Erlang "
2775 "programming language. This page just documents the differences from the C "
2776 "API and gives some examples. If you are not familiar with using libguestfs, "
2777 "you also need to read L<guestfs(3)>."
2781 #: ../erlang/examples/guestfs-erlang.pod:23
2782 msgid "OPENING AND CLOSING THE HANDLE"
2786 #: ../erlang/examples/guestfs-erlang.pod:25
2788 "The Erlang bindings are implemented using an external program called "
2789 "C<erl-guestfs>. This program must be on the current PATH, or else you "
2790 "should specify the full path to the program:"
2794 #: ../erlang/examples/guestfs-erlang.pod:29
2797 " {ok, G} = guestfs:create().\n"
2802 #: ../erlang/examples/guestfs-erlang.pod:31
2805 " {ok, G} = guestfs:create(\"/path/to/erl-guestfs\").\n"
2810 #: ../erlang/examples/guestfs-erlang.pod:33
2811 msgid "C<G> is the libguestfs handle which you should pass to other functions."
2815 #: ../erlang/examples/guestfs-erlang.pod:36
2816 msgid "To close the handle:"
2820 #: ../erlang/examples/guestfs-erlang.pod:38
2823 " ok = guestfs:close(G).\n"
2828 #: ../erlang/examples/guestfs-erlang.pod:40
2829 msgid "FUNCTIONS WITH OPTIONAL ARGUMENTS"
2833 #: ../erlang/examples/guestfs-erlang.pod:42
2835 "For functions that take optional arguments, the first arguments are the "
2836 "non-optional ones. The last argument is a list of tuples supplying the "
2837 "remaining optional arguments."
2841 #: ../erlang/examples/guestfs-erlang.pod:46
2844 " ok = guestfs:add_drive_opts(G, Disk,\n"
2845 " [{format, \"raw\"}, {readonly, true}]).\n"
2850 #: ../erlang/examples/guestfs-erlang.pod:49
2851 msgid "If the last argument would be an empty list, you can also omit it:"
2855 #: ../erlang/examples/guestfs-erlang.pod:51
2858 " ok = guestfs:add_drive_opts(G, Disk).\n"
2863 #: ../erlang/examples/guestfs-erlang.pod:53
2864 msgid "RETURN VALUES AND ERRORS"
2868 #: ../erlang/examples/guestfs-erlang.pod:55
2870 "On success, most functions return a C<Result> term (which could be a list, "
2871 "string, tuple etc.). If there is nothing for the function to return, then "
2872 "the atom C<ok> is returned."
2876 #: ../erlang/examples/guestfs-erlang.pod:59
2877 msgid "On error, you would see one of the following tuples:"
2881 #: ../erlang/examples/guestfs-erlang.pod:63
2882 msgid "C<{error, Msg, Errno}>"
2886 #: ../erlang/examples/guestfs-erlang.pod:65
2887 msgid "This indicates an ordinary error from the function."
2891 #: ../erlang/examples/guestfs-erlang.pod:67
2893 "C<Msg> is the error message (string) and C<Errno> is the Unix error "
2898 #: ../erlang/examples/guestfs-erlang.pod:70
2899 msgid "C<Errno> can be zero. See L<guestfs(3)/guestfs_last_errno>."
2903 #: ../erlang/examples/guestfs-erlang.pod:72
2904 msgid "C<{unknown, Function}>"
2908 #: ../erlang/examples/guestfs-erlang.pod:74
2910 "This indicates that the function you called is not known. Generally this "
2911 "means you are mixing C<erl-guestfs> from another version of libguestfs, "
2912 "which you should not do."
2916 #: ../erlang/examples/guestfs-erlang.pod:78
2917 msgid "C<Function> is the name of the unknown function."
2921 #: ../erlang/examples/guestfs-erlang.pod:80
2922 msgid "C<{unknownarg, Arg}>"
2926 #: ../erlang/examples/guestfs-erlang.pod:82
2928 "This indicates that you called a function with optional arguments, with an "
2929 "unknown argument name."
2933 #: ../erlang/examples/guestfs-erlang.pod:85
2934 msgid "C<Arg> is the name of the unknown argument."
2938 #: ../erlang/examples/guestfs-erlang.pod:89 ../examples/guestfs-examples.pod:25 ../java/examples/guestfs-java.pod:37 ../ocaml/examples/guestfs-ocaml.pod:70 ../perl/examples/guestfs-perl.pod:31 ../python/examples/guestfs-python.pod:34 ../ruby/examples/guestfs-ruby.pod:28
2939 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
2943 #: ../erlang/examples/guestfs-erlang.pod:91 ../examples/guestfs-examples.pod:27 ../java/examples/guestfs-java.pod:39 ../ocaml/examples/guestfs-ocaml.pod:72 ../perl/examples/guestfs-perl.pod:33 ../python/examples/guestfs-python.pod:36 ../ruby/examples/guestfs-ruby.pod:30
2948 #: ../erlang/examples/guestfs-erlang.pod:93 ../examples/guestfs-examples.pod:29 ../java/examples/guestfs-java.pod:41 ../ocaml/examples/guestfs-ocaml.pod:74 ../perl/examples/guestfs-perl.pod:35 ../python/examples/guestfs-python.pod:38 ../ruby/examples/guestfs-ruby.pod:32
2949 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
2953 #: ../erlang/examples/guestfs-erlang.pod:95 ../examples/guestfs-examples.pod:31 ../java/examples/guestfs-java.pod:43 ../ocaml/examples/guestfs-ocaml.pod:76 ../perl/examples/guestfs-perl.pod:37 ../python/examples/guestfs-python.pod:40 ../ruby/examples/guestfs-ruby.pod:34
2958 #: ../erlang/examples/guestfs-erlang.pod:99
2960 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
2961 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
2962 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://www.erlang.org/>. "
2963 "L<http://libguestfs.org/>."
2967 #: ../erlang/examples/guestfs-erlang.pod:110 ../examples/guestfs-examples.pod:45 ../examples/guestfs-recipes.pod:397 ../fish/guestfish.pod:1260 ../fish/virt-copy-in.pod:60 ../fish/virt-copy-out.pod:49 ../fish/virt-tar-in.pod:58 ../fish/virt-tar-out.pod:51 ../fuse/guestmount.pod:319 ../inspector/virt-inspector.pod:389 ../java/examples/guestfs-java.pod:58 ../ocaml/examples/guestfs-ocaml.pod:91 ../perl/examples/guestfs-perl.pod:52 ../python/examples/guestfs-python.pod:54 ../ruby/examples/guestfs-ruby.pod:48 ../src/guestfs.pod:3240 ../test-tool/libguestfs-test-tool.pod:106
2972 #: ../erlang/examples/guestfs-erlang.pod:112 ../examples/guestfs-examples.pod:47 ../examples/guestfs-recipes.pod:399 ../fish/guestfish.pod:1262 ../fish/virt-copy-in.pod:62 ../fish/virt-copy-out.pod:51 ../fish/virt-tar-in.pod:60 ../fish/virt-tar-out.pod:53 ../fuse/guestmount.pod:321 ../java/examples/guestfs-java.pod:60 ../ocaml/examples/guestfs-ocaml.pod:93 ../perl/examples/guestfs-perl.pod:54 ../python/examples/guestfs-python.pod:56 ../ruby/examples/guestfs-ruby.pod:50 ../src/guestfs.pod:3242 ../test-tool/libguestfs-test-tool.pod:108
2973 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
2977 #: ../erlang/examples/guestfs-erlang.pod:116 ../java/examples/guestfs-java.pod:64 ../perl/examples/guestfs-perl.pod:58
2978 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
2982 #: ../erlang/examples/guestfs-erlang.pod:118 ../examples/guestfs-examples.pod:53 ../examples/guestfs-recipes.pod:405 ../java/examples/guestfs-java.pod:66 ../ocaml/examples/guestfs-ocaml.pod:99 ../perl/examples/guestfs-perl.pod:60 ../python/examples/guestfs-python.pod:62 ../ruby/examples/guestfs-ruby.pod:56
2984 "The examples in this manual page may be freely copied, modified and "
2985 "distributed without any restrictions."
2989 #: ../erlang/examples/guestfs-erlang.pod:121 ../examples/guestfs-examples.pod:56 ../examples/guestfs-recipes.pod:408 ../java/examples/guestfs-java.pod:69 ../ocaml/examples/guestfs-ocaml.pod:102 ../perl/examples/guestfs-perl.pod:63 ../python/examples/guestfs-python.pod:65 ../ruby/examples/guestfs-ruby.pod:59 ../src/guestfs.pod:3249
2991 "This library is free software; you can redistribute it and/or modify it "
2992 "under the terms of the GNU Lesser General Public License as published by the "
2993 "Free Software Foundation; either version 2 of the License, or (at your "
2994 "option) any later version."
2998 #: ../erlang/examples/guestfs-erlang.pod:126 ../examples/guestfs-examples.pod:61 ../examples/guestfs-recipes.pod:413 ../java/examples/guestfs-java.pod:74 ../ocaml/examples/guestfs-ocaml.pod:107 ../perl/examples/guestfs-perl.pod:68 ../python/examples/guestfs-python.pod:70 ../ruby/examples/guestfs-ruby.pod:64 ../src/guestfs.pod:3254
3000 "This library is distributed in the hope that it will be useful, but WITHOUT "
3001 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
3002 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
3007 #: ../erlang/examples/guestfs-erlang.pod:131 ../examples/guestfs-examples.pod:66 ../examples/guestfs-recipes.pod:418 ../java/examples/guestfs-java.pod:79 ../ocaml/examples/guestfs-ocaml.pod:112 ../perl/examples/guestfs-perl.pod:73 ../python/examples/guestfs-python.pod:75 ../ruby/examples/guestfs-ruby.pod:69 ../src/guestfs.pod:3259
3009 "You should have received a copy of the GNU Lesser General Public License "
3010 "along with this library; if not, write to the Free Software Foundation, "
3011 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
3015 #: ../examples/guestfs-examples.pod:5
3016 msgid "guestfs-examples - Examples of using libguestfs from C"
3020 #: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9
3023 " #include <guestfs.h>\n"
3028 #: ../examples/guestfs-examples.pod:11
3031 " guestfs_h *g = guestfs_create ();\n"
3032 " guestfs_add_drive_ro (g, \"disk.img\");\n"
3033 " guestfs_launch (g);\n"
3038 #: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19
3041 " cc prog.c -o prog -lguestfs\n"
3043 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
3048 #: ../examples/guestfs-examples.pod:21
3050 "This manual page contains examples of calling libguestfs from the C "
3051 "programming language. If you are not familiar with using libguestfs, you "
3052 "also need to read L<guestfs(3)>."
3056 #: ../examples/guestfs-examples.pod:35
3058 "L<guestfs(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, "
3059 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
3060 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
3064 #: ../examples/guestfs-examples.pod:51 ../ocaml/examples/guestfs-ocaml.pod:97 ../python/examples/guestfs-python.pod:60 ../ruby/examples/guestfs-ruby.pod:54
3065 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
3069 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
3074 #: ../examples/guestfs-recipes.pod:5
3076 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
3077 "here. The only way which works for both sorts of output is to just write "
3078 "the URL directly. Do NOT use L<...> for URLs."
3082 #: ../examples/guestfs-recipes.pod:9
3084 "We break with tradition here and don't use ALL CAPS for the section "
3085 "headings, as this makes them much easier to read."
3089 #: ../examples/guestfs-recipes.pod:16
3090 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
3094 #: ../examples/guestfs-recipes.pod:20
3096 "This page contains recipes for and links to things you can do using "
3097 "libguestfs, L<guestfish(1)> and the virt tools."
3101 #: ../examples/guestfs-recipes.pod:23
3102 msgid "Audit a virtual machine for setuid files"
3106 #: ../examples/guestfs-recipes.pod:25
3108 "The link below contains a small program which can be used to audit a Linux "
3109 "virtual machine to see what setuid and setgid files it contains."
3113 #: ../examples/guestfs-recipes.pod:28
3114 msgid "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-files/#content"
3118 #: ../examples/guestfs-recipes.pod:30
3119 msgid "Change the background image in a Windows XP VM"
3123 #: ../examples/guestfs-recipes.pod:32
3125 "The links below explain how to use L<guestfish(1)> to change the background "
3126 "image for a user of a Windows XP VM. Unfortunately the technique appears to "
3127 "be substantially different for each version of Windows."
3131 #: ../examples/guestfs-recipes.pod:37
3133 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html "
3134 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
3138 #: ../examples/guestfs-recipes.pod:40
3139 msgid "Cloning a virtual machine (Linux)"
3143 #: ../examples/guestfs-recipes.pod:42
3145 "The guestfish technique described in the link below works well for most "
3146 "Linux VMs. Depending on the Linux distro you may need to change the paths "
3151 #: ../examples/guestfs-recipes.pod:46
3152 msgid "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-vm/#content"
3156 #: ../examples/guestfs-recipes.pod:48
3158 "Avoid L<virt-clone(1)>. Currently what to do about virt-clone is under "
3163 #: ../examples/guestfs-recipes.pod:51
3164 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
3168 #: ../examples/guestfs-recipes.pod:53
3169 msgid "Cloning a virtual machine (Windows)"
3173 #: ../examples/guestfs-recipes.pod:55
3175 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
3176 "straightforward. Currently there is code in the Aeolus Oz project which "
3177 "does this (using libguestfs). As part of our review of the virt-clone tool, "
3178 "we may add sysprepping ability."
3182 #: ../examples/guestfs-recipes.pod:60
3184 "https://github.com/clalancette/oz "
3185 "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
3189 #: ../examples/guestfs-recipes.pod:63
3190 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
3194 #: ../examples/guestfs-recipes.pod:65
3195 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
3199 #: ../examples/guestfs-recipes.pod:67
3202 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
3207 #: ../examples/guestfs-recipes.pod:69
3208 msgid "To export just a subdirectory, eg. C</files>, do:"
3212 #: ../examples/guestfs-recipes.pod:71
3215 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
3220 #: ../examples/guestfs-recipes.pod:73
3221 msgid "Create empty disk images"
3225 #: ../examples/guestfs-recipes.pod:75
3227 "You can use the L<guestfish(1)> I<-N> option to create empty disk images. "
3228 "The useful guide below explains the options available."
3232 #: ../examples/guestfs-recipes.pod:78
3233 msgid "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/#content"
3237 #: ../examples/guestfs-recipes.pod:80
3238 msgid "Dump raw filesystem content from inside a disk image or VM"
3242 #: ../examples/guestfs-recipes.pod:82
3244 "You can use the L<guestfish(1)> C<download> command to extract the raw "
3245 "filesystem content from any filesystem in a disk image or a VM (even one "
3246 "which is encrypted or buried inside an LV):"
3250 #: ../examples/guestfs-recipes.pod:86
3253 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
3258 #: ../examples/guestfs-recipes.pod:88
3261 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
3266 #: ../examples/guestfs-recipes.pod:90
3267 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
3271 #: ../examples/guestfs-recipes.pod:92
3272 msgid "Edit grub configuration in a VM"
3276 #: ../examples/guestfs-recipes.pod:94
3277 msgid "You can use this to:"
3281 #: ../examples/guestfs-recipes.pod:100
3282 msgid "Fix a virtual machine that does not boot."
3286 #: ../examples/guestfs-recipes.pod:104
3287 msgid "Change which kernel is used to boot the VM."
3291 #: ../examples/guestfs-recipes.pod:108
3292 msgid "Change kernel command line options."
3296 #: ../examples/guestfs-recipes.pod:112
3297 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
3301 #: ../examples/guestfs-recipes.pod:114
3304 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
3309 #: ../examples/guestfs-recipes.pod:116
3311 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
3316 #: ../examples/guestfs-recipes.pod:119
3319 " virt-rescue -d BrokenGuest\n"
3324 #: ../examples/guestfs-recipes.pod:121
3325 msgid "Export any directory from a VM"
3329 #: ../examples/guestfs-recipes.pod:123
3330 msgid "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
3334 #: ../examples/guestfs-recipes.pod:126
3337 " virt-copy-out -d Guest /home .\n"
3342 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1327 ../fish/guestfish-actions.pod:1592 ../fish/guestfish-actions.pod:2001 ../src/guestfs-actions.pod:18 ../src/guestfs-actions.pod:2029 ../src/guestfs-actions.pod:2451 ../src/guestfs-actions.pod:3002 ../src/guestfs.pod:1670 ../tools/virt-win-reg.pl:706
3347 #: ../examples/guestfs-recipes.pod:134
3349 "The final dot of the command is not a printing error. It means we want to "
3350 "copy out to the current directory."
3354 #: ../examples/guestfs-recipes.pod:139
3355 msgid "This creates a directory called C<home> under the current directory."
3359 #: ../examples/guestfs-recipes.pod:143
3361 "If the guest is a Windows guest then you can use drive letters and "
3362 "backslashes, but you must prefix the path with C<win:> and quote it to "
3363 "protect it from the shell, like this:"
3367 #: ../examples/guestfs-recipes.pod:147
3370 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
3375 #: ../examples/guestfs-recipes.pod:149
3376 msgid "To get the output as a compressed tarball, do:"
3380 #: ../examples/guestfs-recipes.pod:151
3383 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
3388 #: ../examples/guestfs-recipes.pod:153
3390 "Although it sounds tempting, this is usually not a reliable way to get a "
3391 "backup from a running guest. See the entry in the FAQ: "
3392 "http://libguestfs.org/FAQ.html#backup"
3396 #: ../examples/guestfs-recipes.pod:157
3397 msgid "Find out which user is using the most space"
3401 #: ../examples/guestfs-recipes.pod:159
3403 "This simple script examines a Linux guest to find out which user is using "
3404 "the most space in their home directory:"
3408 #: ../examples/guestfs-recipes.pod:162
3416 #: ../examples/guestfs-recipes.pod:164
3424 #: ../examples/guestfs-recipes.pod:166
3433 #: ../examples/guestfs-recipes.pod:169
3436 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
3441 #: ../examples/guestfs-recipes.pod:171
3444 " for d in $(guestfish --remote ls \"$dir\"); do\n"
3445 " echo -n \"$dir/$d\"\n"
3447 " guestfish --remote du \"$dir/$d\";\n"
3448 " done | sort -nr -k 2\n"
3453 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
3456 " guestfish --remote exit\n"
3461 #: ../examples/guestfs-recipes.pod:179
3462 msgid "Get DHCP address from a VM"
3466 #: ../examples/guestfs-recipes.pod:181
3468 "The link below explains the many different possible techniques for getting "
3469 "the last assigned DHCP address of a virtual machine."
3473 #: ../examples/guestfs-recipes.pod:184
3474 msgid "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-a-virtual-machine-disk-image/#content"
3478 #: ../examples/guestfs-recipes.pod:186
3480 "In the libguestfs source examples directory you will find the latest version "
3481 "of the C<virt-dhcp-address.c> program."
3485 #: ../examples/guestfs-recipes.pod:189
3486 msgid "Get the operating system product name string"
3490 #: ../examples/guestfs-recipes.pod:191
3491 msgid "Save the following script into a file called C<product-name.sh>:"
3495 #: ../examples/guestfs-recipes.pod:193
3500 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3501 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3502 " guestfish --remote inspect-get-product-name \"$root\"\n"
3503 " guestfish --remote exit\n"
3508 #: ../examples/guestfs-recipes.pod:200
3509 msgid "Make the script executable and run it on a named guest:"
3513 #: ../examples/guestfs-recipes.pod:202
3516 " # product-name.sh RHEL60x64\n"
3517 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
3522 #: ../examples/guestfs-recipes.pod:205
3524 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
3525 "C<xpath> command line tool or from your favourite programming language:"
3529 #: ../examples/guestfs-recipes.pod:209
3532 " # virt-inspector RHEL60x64 > xml\n"
3533 " # xpath '//product_name' < xml\n"
3536 " <product_name>Red Hat Enterprise Linux Server release 6.0 "
3537 "(Santiago)</product_name>\n"
3542 #: ../examples/guestfs-recipes.pod:215
3543 msgid "Get the default boot kernel for a Linux VM"
3547 #: ../examples/guestfs-recipes.pod:217
3549 "The link below contains a program to print the default boot kernel for a "
3554 #: ../examples/guestfs-recipes.pod:220
3555 msgid "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-kernel-for-a-vm/#content"
3559 #: ../examples/guestfs-recipes.pod:222
3561 "It uses Augeas, and the technique is generally applicable for many different "
3566 #: ../examples/guestfs-recipes.pod:229
3567 msgid "listing the user accounts in the guest"
3571 #: ../examples/guestfs-recipes.pod:233
3572 msgid "what repositories is it configured to use"
3576 #: ../examples/guestfs-recipes.pod:237
3577 msgid "what NTP servers does it connect to"
3581 #: ../examples/guestfs-recipes.pod:241
3582 msgid "what were the boot messages last time it booted"
3586 #: ../examples/guestfs-recipes.pod:245
3587 msgid "listing who was logged in recently"
3591 #: ../examples/guestfs-recipes.pod:249
3592 msgid "http://augeas.net/"
3596 #: ../examples/guestfs-recipes.pod:251
3597 msgid "Install RPMs in a guest"
3601 #: ../examples/guestfs-recipes.pod:253
3603 "The link below contains a method to install RPMs in a guest. In fact the "
3604 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
3605 "installs them next time the guest is booted. You could use this technique "
3606 "to install vital security updates in an offline guest."
3610 #: ../examples/guestfs-recipes.pod:259
3611 msgid "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
3615 #: ../examples/guestfs-recipes.pod:261
3616 msgid "List applications installed in a VM"
3620 #: ../examples/guestfs-recipes.pod:263
3621 msgid "Save the following to a file C<list-apps.sh>:"
3625 #: ../examples/guestfs-recipes.pod:265
3630 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3631 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3632 " guestfish --remote inspect-list-applications \"$root\"\n"
3633 " guestfish --remote exit\n"
3638 #: ../examples/guestfs-recipes.pod:272
3640 "Make the file executable and then you can run it on any named virtual "
3645 #: ../examples/guestfs-recipes.pod:275
3648 " # list-apps.sh WinGuest\n"
3650 " app_name: Mozilla Firefox (3.6.12)\n"
3651 " app_display_name: Mozilla Firefox (3.6.12)\n"
3653 " app_version: 3.6.12 (en-GB)\n"
3655 " app_install_path: C:\\Program Files\\Mozilla Firefox\n"
3656 " app_trans_path:\n"
3657 " app_publisher: Mozilla\n"
3658 " app_url: http://www.mozilla.com/en-GB/\n"
3659 " app_source_package:\n"
3661 " app_description: Mozilla Firefox\n"
3664 " app_name: VLC media player\n"
3665 " app_display_name: VLC media player 1.1.5\n"
3667 " app_version: 1.1.5\n"
3669 " app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
3670 " app_trans_path:\n"
3671 " app_publisher: VideoLAN\n"
3672 " app_url: http://www.videolan.org/\n"
3673 " app_source_package:\n"
3675 " app_description:\n"
3681 #: ../examples/guestfs-recipes.pod:305
3683 "If you want to run the script on disk images (instead of libvirt virtual "
3684 "machines), change C<-d \"$1\"> to C<-a \"$1\">. See also "
3685 "L<virt-inspector(1)>."
3689 #: ../examples/guestfs-recipes.pod:309
3690 msgid "List files and directories in a VM"
3694 #: ../examples/guestfs-recipes.pod:311
3695 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
3699 #: ../examples/guestfs-recipes.pod:313
3702 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
3707 #: ../examples/guestfs-recipes.pod:315
3708 msgid "List services in a Windows VM"
3712 #: ../examples/guestfs-recipes.pod:317
3714 "The link below contains a script that can be used to list out the services "
3715 "from a Windows VM, and whether those services run at boot time or are loaded "
3720 #: ../examples/guestfs-recipes.pod:321
3721 msgid "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/#content"
3725 #: ../examples/guestfs-recipes.pod:323
3726 msgid "Make a disk image sparse"
3730 #: ../examples/guestfs-recipes.pod:325
3732 "The link below contains some guides for making a disk image sparse (or "
3733 "reintroducing sparseness)."
3737 #: ../examples/guestfs-recipes.pod:328
3738 msgid "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
3742 #: ../examples/guestfs-recipes.pod:330
3743 msgid "Monitor disk usage over time"
3747 #: ../examples/guestfs-recipes.pod:332
3749 "You can use L<virt-df(1)> to monitor disk usage of your guests over time. "
3750 "The link below contains a guide."
3754 #: ../examples/guestfs-recipes.pod:335
3755 msgid "http://virt-tools.org/learning/advanced-virt-df/"
3759 #: ../examples/guestfs-recipes.pod:337
3760 msgid "Reading the Windows Event Log from Windows Vista (or later)"
3764 #: ../examples/guestfs-recipes.pod:339
3766 "L<guestfish(1)> plus the tools described in the link below can be used to "
3767 "read out the Windows Event Log from any virtual machine running Windows "
3768 "Vista or a later version."
3772 #: ../examples/guestfs-recipes.pod:343
3773 msgid "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-guestfish/#content"
3777 #: ../examples/guestfs-recipes.pod:345
3778 msgid "Remove root password (Linux)"
3782 #: ../examples/guestfs-recipes.pod:347
3784 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
3785 "files. One use is to remove the root password from a Linux guest:"
3789 #: ../examples/guestfs-recipes.pod:350
3792 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
3797 #: ../examples/guestfs-recipes.pod:352
3798 msgid "Remove Administrator password (Windows)"
3802 #: ../examples/guestfs-recipes.pod:354
3804 "The link below contains one technique for removing the Administrator "
3805 "password from a Windows VM, or to be more precise, it gives you a command "
3806 "prompt the next time you log in which you can use to bypass any security:"
3810 #: ../examples/guestfs-recipes.pod:359
3811 msgid "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-administrator-password-with-guestfish/"
3815 #: ../examples/guestfs-recipes.pod:361
3816 msgid "Unpack a live CD"
3820 #: ../examples/guestfs-recipes.pod:363
3822 "Linux live CDs often contain multiple layers of disk images wrapped like a "
3823 "Russian doll. You can use L<guestfish(1)> to look inside these multiple "
3824 "layers, as outlined in the guide below."
3828 #: ../examples/guestfs-recipes.pod:367
3829 msgid "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-cd/#content"
3833 #: ../examples/guestfs-recipes.pod:369
3834 msgid "Uploading and downloading files"
3838 #: ../examples/guestfs-recipes.pod:371
3840 "The link below contains general tips on uploading (copying in) and "
3841 "downloading (copying out) files from VMs."
3845 #: ../examples/guestfs-recipes.pod:374
3846 msgid "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
3850 #: ../examples/guestfs-recipes.pod:376
3851 msgid "Use libguestfs tools on VMware ESX guests"
3855 #: ../examples/guestfs-recipes.pod:378
3857 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
3858 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
3862 #: ../examples/guestfs-recipes.pod:382
3863 msgid "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-guests/#content"
3867 #: ../examples/guestfs-recipes.pod:386
3869 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, "
3870 "L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, "
3871 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, "
3872 "L<http://libguestfs.org/>."
3876 #: ../examples/guestfs-recipes.pod:403
3877 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
3881 #: ../fish/guestfish-actions.pod:1
3886 #: ../fish/guestfish-actions.pod:3
3889 " add-cdrom filename\n"
3894 #: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:14
3895 msgid "This function adds a virtual CD-ROM disk image to the guest."
3899 #: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:16
3900 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
3904 #: ../fish/guestfish-actions.pod:15
3906 "This call checks for the existence of C<filename>. This stops you from "
3907 "specifying other types of drive which are supported by qemu such as C<nbd:> "
3908 "and C<http:> URLs. To specify those, use the general L</config> call "
3913 #: ../fish/guestfish-actions.pod:22
3915 "If you just want to add an ISO file (often you use this as an efficient way "
3916 "to transfer large files into the guest), then you should probably use "
3917 "L</add-drive-ro> instead."
3921 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
3923 "I<This function is deprecated.> In new code, use the L</add_drive_opts> call "
3928 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:1026 ../fish/guestfish-actions.pod:1386 ../fish/guestfish-actions.pod:1400 ../fish/guestfish-actions.pod:3157 ../fish/guestfish-actions.pod:3468 ../fish/guestfish-actions.pod:3516 ../fish/guestfish-actions.pod:4429 ../fish/guestfish-actions.pod:4452 ../fish/guestfish-actions.pod:4474 ../fish/guestfish-actions.pod:4512 ../fish/guestfish-actions.pod:5161 ../fish/guestfish-actions.pod:5267 ../src/guestfs-actions.pod:10 ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273 ../src/guestfs-actions.pod:1615 ../src/guestfs-actions.pod:2114 ../src/guestfs-actions.pod:2135 ../src/guestfs-actions.pod:4765 ../src/guestfs-actions.pod:5287 ../src/guestfs-actions.pod:5387 ../src/guestfs-actions.pod:6667 ../src/guestfs-actions.pod:6711 ../src/guestfs-actions.pod:6745 ../src/guestfs-actions.pod:6808 ../src/guestfs-actions.pod:7740 ../src/guestfs-actions.pod:7849 ../src/guestfs-actions.pod:8032
3930 "Deprecated functions will not be removed from the API, but the fact that "
3931 "they are deprecated indicates that there are problems with correct use of "
3936 #: ../fish/guestfish-actions.pod:35
3941 #: ../fish/guestfish-actions.pod:37
3946 #: ../fish/guestfish-actions.pod:39
3949 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] "
3955 #: ../fish/guestfish-actions.pod:41
3957 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
3958 "It works by connecting to libvirt, requesting the domain and domain XML from "
3959 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
3963 #: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:64
3965 "The number of disks added is returned. This operation is atomic: if an "
3966 "error is returned, then no disks are added."
3970 #: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:67
3972 "This function does some minimal checks to make sure the libvirt domain is "
3973 "not running (unless C<readonly> is true). In a future version we will try "
3974 "to acquire the libvirt lock on each disk."
3978 #: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:71
3980 "Disks must be accessible locally. This often means that adding disks from a "
3981 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
3982 "unless those disks are accessible via the same device path locally too."
3986 #: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:76
3988 "The optional C<libvirturi> parameter sets the libvirt URI (see "
3989 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
3990 "default libvirt URI (or one set through an environment variable, see the "
3991 "libvirt documentation for full details)."
3995 #: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:82
3997 "The optional C<live> flag controls whether this call will try to connect to "
3998 "a running virtual machine C<guestfsd> process if it sees a suitable "
3999 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
4000 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
4001 "DAEMONS> for more information."
4005 #: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:89
4007 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
4008 "passed instead of the domain name. The C<dom> string is treated as a UUID "
4009 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
4014 #: ../fish/guestfish-actions.pod:76
4016 "The other optional parameters are passed directly through to "
4017 "L</add-drive-opts>."
4021 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143 ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:784 ../fish/guestfish-actions.pod:805 ../fish/guestfish-actions.pod:2040 ../fish/guestfish-actions.pod:3206 ../fish/guestfish-actions.pod:3369 ../fish/guestfish-actions.pod:3504
4023 "This command has one or more optional arguments. See L</OPTIONAL "
4028 #: ../fish/guestfish-actions.pod:81
4033 #: ../fish/guestfish-actions.pod:83
4036 " add-drive filename\n"
4041 #: ../fish/guestfish-actions.pod:85
4043 "This function is the equivalent of calling L</add-drive-opts> with no "
4044 "optional parameters, so the disk is added writable, with the format being "
4045 "detected automatically."
4049 #: ../fish/guestfish-actions.pod:89
4051 "Automatic detection of the format opens you up to a potential security hole "
4052 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4053 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
4054 "you should think about replacing calls to this function with calls to "
4055 "L</add-drive-opts>, and specifying the format."
4059 #: ../fish/guestfish-actions.pod:96
4060 msgid "add-drive-opts"
4064 #: ../fish/guestfish-actions.pod:98
4069 #: ../fish/guestfish-actions.pod:100
4072 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
4077 #: ../fish/guestfish-actions.pod:102 ../src/guestfs-actions.pod:160
4079 "This function adds a virtual machine disk image C<filename> to libguestfs. "
4080 "The first time you call this function, the disk appears as C</dev/sda>, the "
4081 "second time as C</dev/sdb>, and so on."
4085 #: ../fish/guestfish-actions.pod:107 ../src/guestfs-actions.pod:165
4087 "You don't necessarily need to be root when using libguestfs. However you "
4088 "obviously do need sufficient permissions to access the filename for whatever "
4089 "operations you want to perform (ie. read access if you just want to read the "
4090 "image or write access if you want to modify the image)."
4094 #: ../fish/guestfish-actions.pod:113 ../src/guestfs-actions.pod:171
4095 msgid "This call checks that C<filename> exists."
4099 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3168 ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4802
4100 msgid "The optional arguments are:"
4104 #: ../fish/guestfish-actions.pod:119 ../src/guestfs-actions.pod:177
4109 #: ../fish/guestfish-actions.pod:121 ../src/guestfs-actions.pod:179
4111 "If true then the image is treated as read-only. Writes are still allowed, "
4112 "but they are stored in a temporary snapshot overlay which is discarded at "
4113 "the end. The disk that you add is not modified."
4117 #: ../fish/guestfish-actions.pod:125 ../src/guestfs-actions.pod:183
4122 #: ../fish/guestfish-actions.pod:127
4124 "This forces the image format. If you omit this (or use L</add-drive> or "
4125 "L</add-drive-ro>) then the format is automatically detected. Possible "
4126 "formats include C<raw> and C<qcow2>."
4130 #: ../fish/guestfish-actions.pod:131 ../src/guestfs-actions.pod:189
4132 "Automatic detection of the format opens you up to a potential security hole "
4133 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
4134 "RHBZ#642934. Specifying the format closes this security hole."
4138 #: ../fish/guestfish-actions.pod:136 ../src/guestfs-actions.pod:194
4143 #: ../fish/guestfish-actions.pod:138
4145 "This rarely-used option lets you emulate the behaviour of the deprecated "
4146 "L</add-drive-with-if> call (q.v.)"
4150 #: ../fish/guestfish-actions.pod:145
4151 msgid "add-drive-ro"
4155 #: ../fish/guestfish-actions.pod:147
4160 #: ../fish/guestfish-actions.pod:149
4163 " add-drive-ro filename\n"
4168 #: ../fish/guestfish-actions.pod:151
4170 "This function is the equivalent of calling L</add-drive-opts> with the "
4171 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
4172 "is added read-only, with the format being detected automatically."
4176 #: ../fish/guestfish-actions.pod:156
4177 msgid "add-drive-ro-with-if"
4181 #: ../fish/guestfish-actions.pod:158
4184 " add-drive-ro-with-if filename iface\n"
4189 #: ../fish/guestfish-actions.pod:160
4191 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
4192 "interface emulation to use at run time."
4196 #: ../fish/guestfish-actions.pod:170
4197 msgid "add-drive-with-if"
4201 #: ../fish/guestfish-actions.pod:172
4204 " add-drive-with-if filename iface\n"
4209 #: ../fish/guestfish-actions.pod:174
4211 "This is the same as L</add-drive> but it allows you to specify the QEMU "
4212 "interface emulation to use at run time."
4216 #: ../fish/guestfish-actions.pod:184
4221 #: ../fish/guestfish-actions.pod:186
4224 " aug-clear augpath\n"
4229 #: ../fish/guestfish-actions.pod:188 ../src/guestfs-actions.pod:290
4231 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4232 "L<augtool(1)> C<clear> command."
4236 #: ../fish/guestfish-actions.pod:191
4241 #: ../fish/guestfish-actions.pod:193
4249 #: ../fish/guestfish-actions.pod:195
4251 "Close the current Augeas handle and free up any resources used by it. After "
4252 "calling this, you have to call L</aug-init> again before you can use any "
4253 "other Augeas functions."
4257 #: ../fish/guestfish-actions.pod:200
4262 #: ../fish/guestfish-actions.pod:202
4265 " aug-defnode name expr val\n"
4270 #: ../fish/guestfish-actions.pod:204 ../src/guestfs-actions.pod:319
4271 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4275 #: ../fish/guestfish-actions.pod:207
4277 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4278 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
4279 "containing that single node."
4283 #: ../fish/guestfish-actions.pod:211 ../src/guestfs-actions.pod:326
4285 "On success this returns a pair containing the number of nodes in the "
4286 "nodeset, and a boolean flag if a node was created."
4290 #: ../fish/guestfish-actions.pod:215
4295 #: ../fish/guestfish-actions.pod:217
4298 " aug-defvar name expr\n"
4303 #: ../fish/guestfish-actions.pod:219 ../src/guestfs-actions.pod:343
4305 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4306 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4310 #: ../fish/guestfish-actions.pod:223 ../src/guestfs-actions.pod:347
4312 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4313 "evaluates to something which is not a nodeset."
4317 #: ../fish/guestfish-actions.pod:226
4322 #: ../fish/guestfish-actions.pod:228
4325 " aug-get augpath\n"
4330 #: ../fish/guestfish-actions.pod:230 ../src/guestfs-actions.pod:360
4332 "Look up the value associated with C<path>. If C<path> matches exactly one "
4333 "node, the C<value> is returned."
4337 #: ../fish/guestfish-actions.pod:233
4342 #: ../fish/guestfish-actions.pod:235
4345 " aug-init root flags\n"
4350 #: ../fish/guestfish-actions.pod:237 ../src/guestfs-actions.pod:375
4352 "Create a new Augeas handle for editing configuration files. If there was "
4353 "any previous Augeas handle associated with this guestfs session, then it is "
4358 #: ../fish/guestfish-actions.pod:241
4359 msgid "You must call this before using any other L</aug-*> commands."
4363 #: ../fish/guestfish-actions.pod:244 ../src/guestfs-actions.pod:382
4364 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4368 #: ../fish/guestfish-actions.pod:247 ../src/guestfs-actions.pod:385
4370 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4371 "logical I<or> of the following integers:"
4375 #: ../fish/guestfish-actions.pod:253 ../src/guestfs-actions.pod:391
4376 msgid "C<AUG_SAVE_BACKUP> = 1"
4380 #: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:393
4381 msgid "Keep the original file with a C<.augsave> extension."
4385 #: ../fish/guestfish-actions.pod:257 ../src/guestfs-actions.pod:395
4386 msgid "C<AUG_SAVE_NEWFILE> = 2"
4390 #: ../fish/guestfish-actions.pod:259 ../src/guestfs-actions.pod:397
4392 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4393 "original. Overrides C<AUG_SAVE_BACKUP>."
4397 #: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:400
4398 msgid "C<AUG_TYPE_CHECK> = 4"
4402 #: ../fish/guestfish-actions.pod:264 ../src/guestfs-actions.pod:402
4403 msgid "Typecheck lenses."
4407 #: ../fish/guestfish-actions.pod:266
4409 "This option is only useful when debugging Augeas lenses. Use of this option "
4410 "may require additional memory for the libguestfs appliance. You may need to "
4411 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
4415 #: ../fish/guestfish-actions.pod:271 ../src/guestfs-actions.pod:409
4416 msgid "C<AUG_NO_STDINC> = 8"
4420 #: ../fish/guestfish-actions.pod:273 ../src/guestfs-actions.pod:411
4421 msgid "Do not use standard load path for modules."
4425 #: ../fish/guestfish-actions.pod:275 ../src/guestfs-actions.pod:413
4426 msgid "C<AUG_SAVE_NOOP> = 16"
4430 #: ../fish/guestfish-actions.pod:277 ../src/guestfs-actions.pod:415
4431 msgid "Make save a no-op, just record what would have been changed."
4435 #: ../fish/guestfish-actions.pod:279 ../src/guestfs-actions.pod:417
4436 msgid "C<AUG_NO_LOAD> = 32"
4440 #: ../fish/guestfish-actions.pod:281
4441 msgid "Do not load the tree in L</aug-init>."
4445 #: ../fish/guestfish-actions.pod:285
4446 msgid "To close the handle, you can call L</aug-close>."
4450 #: ../fish/guestfish-actions.pod:287 ../src/guestfs-actions.pod:425
4451 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4455 #: ../fish/guestfish-actions.pod:289
4460 #: ../fish/guestfish-actions.pod:291
4463 " aug-insert augpath label true|false\n"
4468 #: ../fish/guestfish-actions.pod:293 ../src/guestfs-actions.pod:439
4470 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4471 "or after C<path> (depending on the boolean flag C<before>)."
4475 #: ../fish/guestfish-actions.pod:297 ../src/guestfs-actions.pod:443
4477 "C<path> must match exactly one existing node in the tree, and C<label> must "
4478 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4482 #: ../fish/guestfish-actions.pod:301
4487 #: ../fish/guestfish-actions.pod:303
4495 #: ../fish/guestfish-actions.pod:305 ../src/guestfs-actions.pod:456
4496 msgid "Load files into the tree."
4500 #: ../fish/guestfish-actions.pod:307 ../src/guestfs-actions.pod:458
4501 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4505 #: ../fish/guestfish-actions.pod:310
4510 #: ../fish/guestfish-actions.pod:312
4518 #: ../fish/guestfish-actions.pod:314
4520 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
4521 "resulting nodes into alphabetical order."
4525 #: ../fish/guestfish-actions.pod:317
4530 #: ../fish/guestfish-actions.pod:319
4533 " aug-match augpath\n"
4538 #: ../fish/guestfish-actions.pod:321 ../src/guestfs-actions.pod:486
4540 "Returns a list of paths which match the path expression C<path>. The "
4541 "returned paths are sufficiently qualified so that they match exactly one "
4542 "node in the current tree."
4546 #: ../fish/guestfish-actions.pod:325
4551 #: ../fish/guestfish-actions.pod:327
4554 " aug-mv src dest\n"
4559 #: ../fish/guestfish-actions.pod:329 ../src/guestfs-actions.pod:503
4561 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4562 "C<dest> is overwritten if it exists."
4566 #: ../fish/guestfish-actions.pod:332
4571 #: ../fish/guestfish-actions.pod:334
4579 #: ../fish/guestfish-actions.pod:336 ../src/guestfs-actions.pod:516
4580 msgid "Remove C<path> and all of its children."
4584 #: ../fish/guestfish-actions.pod:338 ../src/guestfs-actions.pod:518
4585 msgid "On success this returns the number of entries which were removed."
4589 #: ../fish/guestfish-actions.pod:340
4594 #: ../fish/guestfish-actions.pod:342
4602 #: ../fish/guestfish-actions.pod:344 ../src/guestfs-actions.pod:529
4603 msgid "This writes all pending changes to disk."
4607 #: ../fish/guestfish-actions.pod:346
4609 "The flags which were passed to L</aug-init> affect exactly how files are "
4614 #: ../fish/guestfish-actions.pod:349
4619 #: ../fish/guestfish-actions.pod:351
4622 " aug-set augpath val\n"
4627 #: ../fish/guestfish-actions.pod:353 ../src/guestfs-actions.pod:545
4628 msgid "Set the value associated with C<path> to C<val>."
4632 #: ../fish/guestfish-actions.pod:355
4634 "In the Augeas API, it is possible to clear a node by setting the value to "
4635 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4636 "this call. Instead you must use the L</aug-clear> call."
4640 #: ../fish/guestfish-actions.pod:360
4645 #: ../fish/guestfish-actions.pod:362
4648 " available 'groups ...'\n"
4653 #: ../fish/guestfish-actions.pod:364 ../src/guestfs-actions.pod:562
4655 "This command is used to check the availability of some groups of "
4656 "functionality in the appliance, which not all builds of the libguestfs "
4657 "appliance will be able to provide."
4661 #: ../fish/guestfish-actions.pod:368
4663 "The libguestfs groups, and the functions that those groups correspond to, "
4664 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4665 "runtime by calling L</available-all-groups>."
4669 #: ../fish/guestfish-actions.pod:373 ../src/guestfs-actions.pod:571
4671 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
4672 "\"augeas\"]> would check for the availability of the Linux inotify functions "
4673 "and Augeas (configuration file editing) functions."
4677 #: ../fish/guestfish-actions.pod:378 ../src/guestfs-actions.pod:576
4678 msgid "The command returns no error if I<all> requested groups are available."
4682 #: ../fish/guestfish-actions.pod:380 ../src/guestfs-actions.pod:578
4684 "It fails with an error if one or more of the requested groups is unavailable "
4689 #: ../fish/guestfish-actions.pod:383 ../src/guestfs-actions.pod:581
4691 "If an unknown group name is included in the list of groups then an error is "
4696 #: ../fish/guestfish-actions.pod:386 ../src/guestfs-actions.pod:584
4701 #: ../fish/guestfish-actions.pod:392
4702 msgid "You must call L</launch> before calling this function."
4706 #: ../fish/guestfish-actions.pod:394 ../src/guestfs-actions.pod:592
4708 "The reason is because we don't know what groups are supported by the "
4709 "appliance/daemon until it is running and can be queried."
4713 #: ../fish/guestfish-actions.pod:400 ../src/guestfs-actions.pod:598
4715 "If a group of functions is available, this does not necessarily mean that "
4716 "they will work. You still have to check for errors when calling individual "
4717 "API functions even if they are available."
4721 #: ../fish/guestfish-actions.pod:407 ../src/guestfs-actions.pod:605
4723 "It is usually the job of distro packagers to build complete functionality "
4724 "into the libguestfs appliance. Upstream libguestfs, if built from source "
4725 "with all requirements satisfied, will support everything."
4729 #: ../fish/guestfish-actions.pod:414
4731 "This call was added in version C<1.0.80>. In previous versions of "
4732 "libguestfs all you could do would be to speculatively execute a command to "
4733 "find out if the daemon implemented it. See also L</version>."
4737 #: ../fish/guestfish-actions.pod:421
4738 msgid "available-all-groups"
4742 #: ../fish/guestfish-actions.pod:423
4745 " available-all-groups\n"
4750 #: ../fish/guestfish-actions.pod:425
4752 "This command returns a list of all optional groups that this daemon knows "
4753 "about. Note this returns both supported and unsupported groups. To find "
4754 "out which ones the daemon can actually support you have to call "
4755 "L</available> on each member of the returned list."
4759 #: ../fish/guestfish-actions.pod:431
4760 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
4764 #: ../fish/guestfish-actions.pod:433
4769 #: ../fish/guestfish-actions.pod:435
4772 " base64-in (base64file|-) filename\n"
4777 #: ../fish/guestfish-actions.pod:437 ../src/guestfs-actions.pod:649
4778 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
4782 #: ../fish/guestfish-actions.pod:440 ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:698 ../fish/guestfish-actions.pod:782 ../fish/guestfish-actions.pod:803 ../fish/guestfish-actions.pod:902 ../fish/guestfish-actions.pod:921 ../fish/guestfish-actions.pod:1295 ../fish/guestfish-actions.pod:4732 ../fish/guestfish-actions.pod:4744 ../fish/guestfish-actions.pod:4755 ../fish/guestfish-actions.pod:4766 ../fish/guestfish-actions.pod:4818 ../fish/guestfish-actions.pod:4827 ../fish/guestfish-actions.pod:4881 ../fish/guestfish-actions.pod:4904
4783 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
4787 #: ../fish/guestfish-actions.pod:442
4792 #: ../fish/guestfish-actions.pod:444
4795 " base64-out filename (base64file|-)\n"
4800 #: ../fish/guestfish-actions.pod:446 ../src/guestfs-actions.pod:663
4802 "This command downloads the contents of C<filename>, writing it out to local "
4803 "file C<base64file> encoded as base64."
4807 #: ../fish/guestfish-actions.pod:451
4808 msgid "blockdev-flushbufs"
4812 #: ../fish/guestfish-actions.pod:453
4815 " blockdev-flushbufs device\n"
4820 #: ../fish/guestfish-actions.pod:455 ../src/guestfs-actions.pod:676
4821 msgid "This tells the kernel to flush internal buffers associated with C<device>."
4825 #: ../fish/guestfish-actions.pod:458 ../fish/guestfish-actions.pod:469 ../fish/guestfish-actions.pod:478 ../fish/guestfish-actions.pod:488 ../fish/guestfish-actions.pod:500 ../fish/guestfish-actions.pod:513 ../fish/guestfish-actions.pod:521 ../fish/guestfish-actions.pod:532 ../fish/guestfish-actions.pod:540 ../fish/guestfish-actions.pod:548 ../src/guestfs-actions.pod:679 ../src/guestfs-actions.pod:696 ../src/guestfs-actions.pod:711 ../src/guestfs-actions.pod:727 ../src/guestfs-actions.pod:745 ../src/guestfs-actions.pod:764 ../src/guestfs-actions.pod:778 ../src/guestfs-actions.pod:796 ../src/guestfs-actions.pod:810 ../src/guestfs-actions.pod:824
4826 msgid "This uses the L<blockdev(8)> command."
4830 #: ../fish/guestfish-actions.pod:460
4831 msgid "blockdev-getbsz"
4835 #: ../fish/guestfish-actions.pod:462
4838 " blockdev-getbsz device\n"
4843 #: ../fish/guestfish-actions.pod:464 ../src/guestfs-actions.pod:691
4844 msgid "This returns the block size of a device."
4848 #: ../fish/guestfish-actions.pod:466 ../fish/guestfish-actions.pod:529 ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:793
4850 "(Note this is different from both I<size in blocks> and I<filesystem block "
4855 #: ../fish/guestfish-actions.pod:471
4856 msgid "blockdev-getro"
4860 #: ../fish/guestfish-actions.pod:473
4863 " blockdev-getro device\n"
4868 #: ../fish/guestfish-actions.pod:475 ../src/guestfs-actions.pod:708
4870 "Returns a boolean indicating if the block device is read-only (true if "
4871 "read-only, false if not)."
4875 #: ../fish/guestfish-actions.pod:480
4876 msgid "blockdev-getsize64"
4880 #: ../fish/guestfish-actions.pod:482
4883 " blockdev-getsize64 device\n"
4888 #: ../fish/guestfish-actions.pod:484 ../src/guestfs-actions.pod:723
4889 msgid "This returns the size of the device in bytes."
4893 #: ../fish/guestfish-actions.pod:486
4894 msgid "See also L</blockdev-getsz>."
4898 #: ../fish/guestfish-actions.pod:490
4899 msgid "blockdev-getss"
4903 #: ../fish/guestfish-actions.pod:492
4906 " blockdev-getss device\n"
4911 #: ../fish/guestfish-actions.pod:494 ../src/guestfs-actions.pod:739
4913 "This returns the size of sectors on a block device. Usually 512, but can be "
4914 "larger for modern devices."
4918 #: ../fish/guestfish-actions.pod:497
4919 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
4923 #: ../fish/guestfish-actions.pod:502
4924 msgid "blockdev-getsz"
4928 #: ../fish/guestfish-actions.pod:504
4931 " blockdev-getsz device\n"
4936 #: ../fish/guestfish-actions.pod:506 ../src/guestfs-actions.pod:757
4938 "This returns the size of the device in units of 512-byte sectors (even if "
4939 "the sectorsize isn't 512 bytes ... weird)."
4943 #: ../fish/guestfish-actions.pod:509
4945 "See also L</blockdev-getss> for the real sector size of the device, and "
4946 "L</blockdev-getsize64> for the more useful I<size in bytes>."
4950 #: ../fish/guestfish-actions.pod:515
4951 msgid "blockdev-rereadpt"
4955 #: ../fish/guestfish-actions.pod:517
4958 " blockdev-rereadpt device\n"
4963 #: ../fish/guestfish-actions.pod:519 ../src/guestfs-actions.pod:776
4964 msgid "Reread the partition table on C<device>."
4968 #: ../fish/guestfish-actions.pod:523
4969 msgid "blockdev-setbsz"
4973 #: ../fish/guestfish-actions.pod:525
4976 " blockdev-setbsz device blocksize\n"
4981 #: ../fish/guestfish-actions.pod:527 ../src/guestfs-actions.pod:791
4982 msgid "This sets the block size of a device."
4986 #: ../fish/guestfish-actions.pod:534
4987 msgid "blockdev-setro"
4991 #: ../fish/guestfish-actions.pod:536
4994 " blockdev-setro device\n"
4999 #: ../fish/guestfish-actions.pod:538 ../src/guestfs-actions.pod:808
5000 msgid "Sets the block device named C<device> to read-only."
5004 #: ../fish/guestfish-actions.pod:542
5005 msgid "blockdev-setrw"
5009 #: ../fish/guestfish-actions.pod:544
5012 " blockdev-setrw device\n"
5017 #: ../fish/guestfish-actions.pod:546 ../src/guestfs-actions.pod:822
5018 msgid "Sets the block device named C<device> to read-write."
5022 #: ../fish/guestfish-actions.pod:550
5023 msgid "btrfs-filesystem-resize"
5027 #: ../fish/guestfish-actions.pod:552
5030 " btrfs-filesystem-resize mountpoint [size:..]\n"
5035 #: ../fish/guestfish-actions.pod:554 ../src/guestfs-actions.pod:844
5036 msgid "This command resizes a btrfs filesystem."
5040 #: ../fish/guestfish-actions.pod:556 ../src/guestfs-actions.pod:846
5042 "Note that unlike other resize calls, the filesystem has to be mounted and "
5043 "the parameter is the mountpoint not the device (this is a requirement of "
5048 #: ../fish/guestfish-actions.pod:560 ../fish/guestfish-actions.pod:3479 ../src/guestfs-actions.pod:850 ../src/guestfs-actions.pod:5326
5049 msgid "The optional parameters are:"
5053 #: ../fish/guestfish-actions.pod:564 ../fish/guestfish-actions.pod:3483 ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:5330
5058 #: ../fish/guestfish-actions.pod:566 ../src/guestfs-actions.pod:856
5060 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
5061 "resized to the maximum size."
5065 #: ../fish/guestfish-actions.pod:571 ../src/guestfs-actions.pod:861
5066 msgid "See also L<btrfs(8)>."
5070 #: ../fish/guestfish-actions.pod:575
5071 msgid "case-sensitive-path"
5075 #: ../fish/guestfish-actions.pod:577
5078 " case-sensitive-path path\n"
5083 #: ../fish/guestfish-actions.pod:579 ../src/guestfs-actions.pod:895
5085 "This can be used to resolve case insensitive paths on a filesystem which is "
5086 "case sensitive. The use case is to resolve paths which you have read from "
5087 "Windows configuration files or the Windows Registry, to the true path."
5091 #: ../fish/guestfish-actions.pod:584 ../src/guestfs-actions.pod:900
5093 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
5094 "(and probably others), which is that although the underlying filesystem is "
5095 "case-insensitive, the driver exports the filesystem to Linux as "
5100 #: ../fish/guestfish-actions.pod:589 ../src/guestfs-actions.pod:905
5102 "One consequence of this is that special directories such as C<c:\\windows> "
5103 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
5104 "precise details of how they were created. In Windows itself this would not "
5109 #: ../fish/guestfish-actions.pod:595 ../src/guestfs-actions.pod:911
5111 "Bug or feature? You decide: "
5112 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
5116 #: ../fish/guestfish-actions.pod:598 ../src/guestfs-actions.pod:914
5118 "This function resolves the true case of each element in the path and returns "
5119 "the case-sensitive path."
5123 #: ../fish/guestfish-actions.pod:601
5125 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
5126 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
5127 "how the directories were originally created under Windows)."
5131 #: ../fish/guestfish-actions.pod:606 ../src/guestfs-actions.pod:922
5132 msgid "I<Note>: This function does not handle drive names, backslashes etc."
5136 #: ../fish/guestfish-actions.pod:609
5137 msgid "See also L</realpath>."
5141 #: ../fish/guestfish-actions.pod:611
5146 #: ../fish/guestfish-actions.pod:613
5154 #: ../fish/guestfish-actions.pod:615 ../fish/guestfish-actions.pod:3899 ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:5969
5155 msgid "Return the contents of the file named C<path>."
5159 #: ../fish/guestfish-actions.pod:617
5161 "Note that this function cannot correctly handle binary files (specifically, "
5162 "files containing C<\\0> character which is treated as end of string). For "
5163 "those you need to use the L</read-file> or L</download> functions which have "
5164 "a more complex interface."
5168 #: ../fish/guestfish-actions.pod:622 ../fish/guestfish-actions.pod:757 ../fish/guestfish-actions.pod:769 ../fish/guestfish-actions.pod:980 ../fish/guestfish-actions.pod:990 ../fish/guestfish-actions.pod:1057 ../fish/guestfish-actions.pod:1067 ../fish/guestfish-actions.pod:1259 ../fish/guestfish-actions.pod:1572 ../fish/guestfish-actions.pod:1582 ../fish/guestfish-actions.pod:1632 ../fish/guestfish-actions.pod:1647 ../fish/guestfish-actions.pod:1657 ../fish/guestfish-actions.pod:1676 ../fish/guestfish-actions.pod:3769 ../fish/guestfish-actions.pod:3784 ../fish/guestfish-actions.pod:3860 ../fish/guestfish-actions.pod:3877 ../fish/guestfish-actions.pod:3892 ../fish/guestfish-actions.pod:4573 ../fish/guestfish-actions.pod:4619 ../fish/guestfish-actions.pod:4704 ../fish/guestfish-actions.pod:4719 ../fish/guestfish-actions.pod:5125 ../fish/guestfish-actions.pod:5137 ../fish/guestfish-actions.pod:5155 ../fish/guestfish-actions.pod:5172 ../fish/guestfish-actions.pod:5182 ../fish/guestfish-actions.pod:5239 ../fish/guestfish-actions.pod:5249 ../fish/guestfish-actions.pod:5278 ../fish/guestfish-actions.pod:5288 ../src/guestfs-actions.pod:948 ../src/guestfs-actions.pod:1127 ../src/guestfs-actions.pod:1147 ../src/guestfs-actions.pod:1550 ../src/guestfs-actions.pod:1569 ../src/guestfs-actions.pod:1672 ../src/guestfs-actions.pod:1691 ../src/guestfs-actions.pod:1937 ../src/guestfs-actions.pod:2417 ../src/guestfs-actions.pod:2436 ../src/guestfs-actions.pod:2501 ../src/guestfs-actions.pod:2525 ../src/guestfs-actions.pod:2542 ../src/guestfs-actions.pod:2571 ../src/guestfs-actions.pod:5751 ../src/guestfs-actions.pod:5777 ../src/guestfs-actions.pod:5908 ../src/guestfs-actions.pod:5934 ../src/guestfs-actions.pod:5958 ../src/guestfs-actions.pod:6923 ../src/guestfs-actions.pod:6978 ../src/guestfs-actions.pod:7124 ../src/guestfs-actions.pod:7148 ../src/guestfs-actions.pod:7813 ../src/guestfs-actions.pod:7833 ../src/guestfs-actions.pod:7866 ../src/guestfs-actions.pod:7885 ../src/guestfs-actions.pod:7904 ../src/guestfs-actions.pod:7998 ../src/guestfs-actions.pod:8017 ../src/guestfs-actions.pod:8063 ../src/guestfs-actions.pod:8082
5170 "Because of the message protocol, there is a transfer limit of somewhere "
5171 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5175 #: ../fish/guestfish-actions.pod:625
5180 #: ../fish/guestfish-actions.pod:627
5183 " checksum csumtype path\n"
5188 #: ../fish/guestfish-actions.pod:629 ../src/guestfs-actions.pod:960
5189 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
5193 #: ../fish/guestfish-actions.pod:632 ../src/guestfs-actions.pod:963
5195 "The type of checksum to compute is given by the C<csumtype> parameter which "
5196 "must have one of the following values:"
5200 #: ../fish/guestfish-actions.pod:637 ../src/guestfs-actions.pod:968
5205 #: ../fish/guestfish-actions.pod:639 ../src/guestfs-actions.pod:970
5207 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5212 #: ../fish/guestfish-actions.pod:642 ../src/guestfs-actions.pod:973
5217 #: ../fish/guestfish-actions.pod:644 ../src/guestfs-actions.pod:975
5218 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5222 #: ../fish/guestfish-actions.pod:646 ../src/guestfs-actions.pod:977
5227 #: ../fish/guestfish-actions.pod:648 ../src/guestfs-actions.pod:979
5228 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5232 #: ../fish/guestfish-actions.pod:650 ../src/guestfs-actions.pod:981
5237 #: ../fish/guestfish-actions.pod:652 ../src/guestfs-actions.pod:983
5238 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5242 #: ../fish/guestfish-actions.pod:654 ../src/guestfs-actions.pod:985
5247 #: ../fish/guestfish-actions.pod:656 ../src/guestfs-actions.pod:987
5248 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5252 #: ../fish/guestfish-actions.pod:658 ../src/guestfs-actions.pod:989
5257 #: ../fish/guestfish-actions.pod:660 ../src/guestfs-actions.pod:991
5258 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5262 #: ../fish/guestfish-actions.pod:662 ../src/guestfs-actions.pod:993
5267 #: ../fish/guestfish-actions.pod:664 ../src/guestfs-actions.pod:995
5268 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5272 #: ../fish/guestfish-actions.pod:668 ../src/guestfs-actions.pod:999
5273 msgid "The checksum is returned as a printable string."
5277 #: ../fish/guestfish-actions.pod:670
5278 msgid "To get the checksum for a device, use L</checksum-device>."
5282 #: ../fish/guestfish-actions.pod:672
5283 msgid "To get the checksums for many files, use L</checksums-out>."
5287 #: ../fish/guestfish-actions.pod:674
5288 msgid "checksum-device"
5292 #: ../fish/guestfish-actions.pod:676
5295 " checksum-device csumtype device\n"
5300 #: ../fish/guestfish-actions.pod:678
5302 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5303 "device named C<device>. For the types of checksums supported see the "
5304 "L</checksum> command."
5308 #: ../fish/guestfish-actions.pod:682
5309 msgid "checksums-out"
5313 #: ../fish/guestfish-actions.pod:684
5316 " checksums-out csumtype directory (sumsfile|-)\n"
5321 #: ../fish/guestfish-actions.pod:686 ../src/guestfs-actions.pod:1034
5323 "This command computes the checksums of all regular files in C<directory> and "
5324 "then emits a list of those checksums to the local output file C<sumsfile>."
5328 #: ../fish/guestfish-actions.pod:690 ../src/guestfs-actions.pod:1038
5330 "This can be used for verifying the integrity of a virtual machine. However "
5331 "to be properly secure you should pay attention to the output of the checksum "
5332 "command (it uses the ones from GNU coreutils). In particular when the "
5333 "filename is not printable, coreutils uses a special backslash syntax. For "
5334 "more information, see the GNU coreutils info file."
5338 #: ../fish/guestfish-actions.pod:700
5343 #: ../fish/guestfish-actions.pod:702
5346 " chmod mode path\n"
5351 #: ../fish/guestfish-actions.pod:704 ../src/guestfs-actions.pod:1057
5353 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5358 #: ../fish/guestfish-actions.pod:707 ../src/guestfs-actions.pod:1060
5360 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5361 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5366 #: ../fish/guestfish-actions.pod:711 ../fish/guestfish-actions.pod:3132 ../fish/guestfish-actions.pod:3271 ../fish/guestfish-actions.pod:3281 ../fish/guestfish-actions.pod:3291 ../src/guestfs-actions.pod:1064 ../src/guestfs-actions.pod:4733 ../src/guestfs-actions.pod:4942 ../src/guestfs-actions.pod:4961 ../src/guestfs-actions.pod:4980
5367 msgid "The mode actually set is affected by the umask."
5371 #: ../fish/guestfish-actions.pod:713
5376 #: ../fish/guestfish-actions.pod:715
5379 " chown owner group path\n"
5384 #: ../fish/guestfish-actions.pod:717 ../src/guestfs-actions.pod:1078
5385 msgid "Change the file owner to C<owner> and group to C<group>."
5389 #: ../fish/guestfish-actions.pod:719 ../fish/guestfish-actions.pod:2567 ../src/guestfs-actions.pod:1080 ../src/guestfs-actions.pod:3804
5391 "Only numeric uid and gid are supported. If you want to use names, you will "
5392 "need to locate and parse the password file yourself (Augeas support makes "
5393 "this relatively easy)."
5397 #: ../fish/guestfish-actions.pod:723
5402 #: ../fish/guestfish-actions.pod:725
5405 " command 'arguments ...'\n"
5410 #: ../fish/guestfish-actions.pod:727 ../src/guestfs-actions.pod:1094
5412 "This call runs a command from the guest filesystem. The filesystem must be "
5413 "mounted, and must contain a compatible operating system (ie. something "
5414 "Linux, with the same or compatible processor architecture)."
5418 #: ../fish/guestfish-actions.pod:732
5420 "The single parameter is an argv-style list of arguments. The first element "
5421 "is the name of the program to run. Subsequent elements are parameters. The "
5422 "list must be non-empty (ie. must contain a program name). Note that the "
5423 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
5427 #: ../fish/guestfish-actions.pod:739 ../src/guestfs-actions.pod:1106
5428 msgid "The return value is anything printed to I<stdout> by the command."
5432 #: ../fish/guestfish-actions.pod:742 ../src/guestfs-actions.pod:1109
5434 "If the command returns a non-zero exit status, then this function returns an "
5435 "error message. The error message string is the content of I<stderr> from "
5440 #: ../fish/guestfish-actions.pod:746 ../src/guestfs-actions.pod:1113
5442 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
5443 "C</bin>. If you require a program from another location, you should provide "
5444 "the full path in the first parameter."
5448 #: ../fish/guestfish-actions.pod:751 ../src/guestfs-actions.pod:1118
5450 "Shared libraries and data files required by the program must be available on "
5451 "filesystems which are mounted in the correct places. It is the caller's "
5452 "responsibility to ensure all filesystems that are needed are mounted at the "
5457 #: ../fish/guestfish-actions.pod:760
5458 msgid "command-lines"
5462 #: ../fish/guestfish-actions.pod:762
5465 " command-lines 'arguments ...'\n"
5470 #: ../fish/guestfish-actions.pod:764
5471 msgid "This is the same as L</command>, but splits the result into a list of lines."
5475 #: ../fish/guestfish-actions.pod:767
5476 msgid "See also: L</sh-lines>"
5480 #: ../fish/guestfish-actions.pod:772
5481 msgid "compress-device-out"
5485 #: ../fish/guestfish-actions.pod:774
5488 " compress-device-out ctype device (zdevice|-) [level:..]\n"
5493 #: ../fish/guestfish-actions.pod:776 ../src/guestfs-actions.pod:1168
5495 "This command compresses C<device> and writes it out to the local file "
5500 #: ../fish/guestfish-actions.pod:779
5502 "The C<ctype> and optional C<level> parameters have the same meaning as in "
5507 #: ../fish/guestfish-actions.pod:786
5508 msgid "compress-out"
5512 #: ../fish/guestfish-actions.pod:788
5515 " compress-out ctype file (zfile|-) [level:..]\n"
5520 #: ../fish/guestfish-actions.pod:790 ../src/guestfs-actions.pod:1218
5522 "This command compresses C<file> and writes it out to the local file "
5527 #: ../fish/guestfish-actions.pod:793 ../src/guestfs-actions.pod:1221
5529 "The compression program used is controlled by the C<ctype> parameter. "
5530 "Currently this includes: C<compress>, C<gzip>, C<bzip2>, C<xz> or C<lzop>. "
5531 "Some compression types may not be supported by particular builds of "
5532 "libguestfs, in which case you will get an error containing the substring "
5533 "\"not supported\"."
5537 #: ../fish/guestfish-actions.pod:799 ../src/guestfs-actions.pod:1227
5539 "The optional C<level> parameter controls compression level. The meaning and "
5540 "default for this parameter depends on the compression program being used."
5544 #: ../fish/guestfish-actions.pod:807
5549 #: ../fish/guestfish-actions.pod:809
5552 " config qemuparam qemuvalue\n"
5557 #: ../fish/guestfish-actions.pod:811 ../src/guestfs-actions.pod:1266
5559 "This can be used to add arbitrary qemu command line parameters of the form "
5560 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
5561 "setting some parameters which would interfere with parameters that we use."
5565 #: ../fish/guestfish-actions.pod:816 ../src/guestfs-actions.pod:1271
5566 msgid "The first character of C<param> string must be a C<-> (dash)."
5570 #: ../fish/guestfish-actions.pod:818 ../src/guestfs-actions.pod:1273
5571 msgid "C<value> can be NULL."
5575 #: ../fish/guestfish-actions.pod:820
5580 #: ../fish/guestfish-actions.pod:822
5583 " copy-size src dest size\n"
5588 #: ../fish/guestfish-actions.pod:824 ../src/guestfs-actions.pod:1287
5590 "This command copies exactly C<size> bytes from one source device or file "
5591 "C<src> to another destination device or file C<dest>."
5595 #: ../fish/guestfish-actions.pod:827 ../src/guestfs-actions.pod:1290
5597 "Note this will fail if the source is too short or if the destination is not "
5602 #: ../fish/guestfish-actions.pod:830
5607 #: ../fish/guestfish-actions.pod:832
5615 #: ../fish/guestfish-actions.pod:834 ../src/guestfs-actions.pod:1309
5617 "This copies a file from C<src> to C<dest> where C<dest> is either a "
5618 "destination filename or destination directory."
5622 #: ../fish/guestfish-actions.pod:837
5627 #: ../fish/guestfish-actions.pod:839
5635 #: ../fish/guestfish-actions.pod:841 ../src/guestfs-actions.pod:1323
5637 "This copies a file or directory from C<src> to C<dest> recursively using the "
5642 #: ../fish/guestfish-actions.pod:844
5647 #: ../fish/guestfish-actions.pod:846
5655 #: ../fish/guestfish-actions.pod:848 ../src/guestfs-actions.pod:1337
5657 "This command copies from one source device or file C<src> to another "
5658 "destination device or file C<dest>. Normally you would use this to copy to "
5659 "or from a device or partition, for example to duplicate a filesystem."
5663 #: ../fish/guestfish-actions.pod:853
5665 "If the destination is a device, it must be as large or larger than the "
5666 "source file or device, otherwise the copy will fail. This command cannot do "
5667 "partial copies (see L</copy-size>)."
5671 #: ../fish/guestfish-actions.pod:857
5676 #: ../fish/guestfish-actions.pod:859
5684 #: ../fish/guestfish-actions.pod:861 ../src/guestfs-actions.pod:1355
5685 msgid "This command runs the C<df> command to report disk space used."
5689 #: ../fish/guestfish-actions.pod:863 ../fish/guestfish-actions.pod:874
5691 "This command is mostly useful for interactive sessions. It is I<not> "
5692 "intended that you try to parse the output string. Use L</statvfs> from "
5697 #: ../fish/guestfish-actions.pod:867
5702 #: ../fish/guestfish-actions.pod:869
5710 #: ../fish/guestfish-actions.pod:871 ../src/guestfs-actions.pod:1371
5712 "This command runs the C<df -h> command to report disk space used in "
5713 "human-readable format."
5717 #: ../fish/guestfish-actions.pod:878
5722 #: ../fish/guestfish-actions.pod:880
5730 #: ../fish/guestfish-actions.pod:882 ../src/guestfs-actions.pod:1388
5732 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
5733 "This is sometimes useful for extended debugging of problems."
5737 #: ../fish/guestfish-actions.pod:886
5739 "Another way to get the same information is to enable verbose messages with "
5740 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
5741 "before running the program."
5745 #: ../fish/guestfish-actions.pod:891
5750 #: ../fish/guestfish-actions.pod:893
5753 " download remotefilename (filename|-)\n"
5758 #: ../fish/guestfish-actions.pod:895 ../fish/guestfish-actions.pod:908 ../src/guestfs-actions.pod:1409 ../src/guestfs-actions.pod:1434
5760 "Download file C<remotefilename> and save it as C<filename> on the local "
5765 #: ../fish/guestfish-actions.pod:898 ../fish/guestfish-actions.pod:4877 ../src/guestfs-actions.pod:1412 ../src/guestfs-actions.pod:7383
5766 msgid "C<filename> can also be a named pipe."
5770 #: ../fish/guestfish-actions.pod:900
5771 msgid "See also L</upload>, L</cat>."
5775 #: ../fish/guestfish-actions.pod:904
5776 msgid "download-offset"
5780 #: ../fish/guestfish-actions.pod:906
5783 " download-offset remotefilename (filename|-) offset size\n"
5788 #: ../fish/guestfish-actions.pod:911 ../src/guestfs-actions.pod:1437
5790 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
5791 "region must be within the file or device)."
5795 #: ../fish/guestfish-actions.pod:914
5797 "Note that there is no limit on the amount of data that can be downloaded "
5798 "with this call, unlike with L</pread>, and this call always reads the full "
5799 "amount unless an error occurs."
5803 #: ../fish/guestfish-actions.pod:919
5804 msgid "See also L</download>, L</pread>."
5808 #: ../fish/guestfish-actions.pod:923
5813 #: ../fish/guestfish-actions.pod:925
5816 " drop-caches whattodrop\n"
5821 #: ../fish/guestfish-actions.pod:927 ../src/guestfs-actions.pod:1462
5823 "This instructs the guest kernel to drop its page cache, and/or dentries and "
5824 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
5825 "to drop, see L<http://linux-mm.org/Drop_Caches>"
5829 #: ../fish/guestfish-actions.pod:932 ../src/guestfs-actions.pod:1467
5830 msgid "Setting C<whattodrop> to 3 should drop everything."
5834 #: ../fish/guestfish-actions.pod:934 ../src/guestfs-actions.pod:1469
5836 "This automatically calls L<sync(2)> before the operation, so that the "
5837 "maximum guest memory is freed."
5841 #: ../fish/guestfish-actions.pod:937
5846 #: ../fish/guestfish-actions.pod:939
5854 #: ../fish/guestfish-actions.pod:941 ../src/guestfs-actions.pod:1482
5856 "This command runs the C<du -s> command to estimate file space usage for "
5861 #: ../fish/guestfish-actions.pod:944 ../src/guestfs-actions.pod:1485
5863 "C<path> can be a file or a directory. If C<path> is a directory then the "
5864 "estimate includes the contents of the directory and all subdirectories "
5869 #: ../fish/guestfish-actions.pod:948 ../src/guestfs-actions.pod:1489
5870 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
5874 #: ../fish/guestfish-actions.pod:951
5879 #: ../fish/guestfish-actions.pod:953
5882 " e2fsck-f device\n"
5887 #: ../fish/guestfish-actions.pod:955 ../src/guestfs-actions.pod:1507
5889 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
5890 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
5895 #: ../fish/guestfish-actions.pod:959
5897 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
5898 "should use L</fsck>."
5902 #: ../fish/guestfish-actions.pod:962
5907 #: ../fish/guestfish-actions.pod:964
5910 " echo-daemon 'words ...'\n"
5915 #: ../fish/guestfish-actions.pod:966 ../src/guestfs-actions.pod:1524
5917 "This command concatenates the list of C<words> passed with single spaces "
5918 "between them and returns the resulting string."
5922 #: ../fish/guestfish-actions.pod:969 ../src/guestfs-actions.pod:1527
5923 msgid "You can use this command to test the connection through to the daemon."
5927 #: ../fish/guestfish-actions.pod:971
5928 msgid "See also L</ping-daemon>."
5932 #: ../fish/guestfish-actions.pod:973
5937 #: ../fish/guestfish-actions.pod:975
5940 " egrep regex path\n"
5945 #: ../fish/guestfish-actions.pod:977 ../src/guestfs-actions.pod:1543
5946 msgid "This calls the external C<egrep> program and returns the matching lines."
5950 #: ../fish/guestfish-actions.pod:983
5955 #: ../fish/guestfish-actions.pod:985
5958 " egrepi regex path\n"
5963 #: ../fish/guestfish-actions.pod:987 ../src/guestfs-actions.pod:1562
5964 msgid "This calls the external C<egrep -i> program and returns the matching lines."
5968 #: ../fish/guestfish-actions.pod:993
5973 #: ../fish/guestfish-actions.pod:995
5976 " equal file1 file2\n"
5981 #: ../fish/guestfish-actions.pod:997 ../src/guestfs-actions.pod:1581
5983 "This compares the two files C<file1> and C<file2> and returns true if their "
5984 "content is exactly equal, or false otherwise."
5988 #: ../fish/guestfish-actions.pod:1000 ../src/guestfs-actions.pod:1584
5989 msgid "The external L<cmp(1)> program is used for the comparison."
5993 #: ../fish/guestfish-actions.pod:1002
5998 #: ../fish/guestfish-actions.pod:1004
6006 #: ../fish/guestfish-actions.pod:1006 ../src/guestfs-actions.pod:1596
6008 "This returns C<true> if and only if there is a file, directory (or anything) "
6009 "with the given C<path> name."
6013 #: ../fish/guestfish-actions.pod:1009
6014 msgid "See also L</is-file>, L</is-dir>, L</stat>."
6018 #: ../fish/guestfish-actions.pod:1011
6023 #: ../fish/guestfish-actions.pod:1013
6026 " fallocate path len\n"
6031 #: ../fish/guestfish-actions.pod:1015 ../fish/guestfish-actions.pod:1034 ../src/guestfs-actions.pod:1619 ../src/guestfs-actions.pod:1638
6033 "This command preallocates a file (containing zero bytes) named C<path> of "
6034 "size C<len> bytes. If the file exists already, it is overwritten."
6038 #: ../fish/guestfish-actions.pod:1019 ../src/guestfs-actions.pod:1623
6040 "Do not confuse this with the guestfish-specific C<alloc> command which "
6041 "allocates a file in the host and attaches it as a device."
6045 #: ../fish/guestfish-actions.pod:1023
6047 "I<This function is deprecated.> In new code, use the L</fallocate64> call "
6052 #: ../fish/guestfish-actions.pod:1030
6057 #: ../fish/guestfish-actions.pod:1032
6060 " fallocate64 path len\n"
6065 #: ../fish/guestfish-actions.pod:1038
6067 "Note that this call allocates disk blocks for the file. To create a sparse "
6068 "file use L</truncate-size> instead."
6072 #: ../fish/guestfish-actions.pod:1041
6074 "The deprecated call L</fallocate> does the same, but owing to an oversight "
6075 "it only allowed 30 bit lengths to be specified, effectively limiting the "
6076 "maximum size of files created through that call to 1GB."
6080 #: ../fish/guestfish-actions.pod:1046 ../src/guestfs-actions.pod:1650
6082 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
6083 "commands which create a file in the host and attach it as a device."
6087 #: ../fish/guestfish-actions.pod:1050
6092 #: ../fish/guestfish-actions.pod:1052
6095 " fgrep pattern path\n"
6100 #: ../fish/guestfish-actions.pod:1054 ../src/guestfs-actions.pod:1665
6101 msgid "This calls the external C<fgrep> program and returns the matching lines."
6105 #: ../fish/guestfish-actions.pod:1060
6110 #: ../fish/guestfish-actions.pod:1062
6113 " fgrepi pattern path\n"
6118 #: ../fish/guestfish-actions.pod:1064 ../src/guestfs-actions.pod:1684
6119 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
6123 #: ../fish/guestfish-actions.pod:1070
6128 #: ../fish/guestfish-actions.pod:1072
6136 #: ../fish/guestfish-actions.pod:1074 ../src/guestfs-actions.pod:1702
6138 "This call uses the standard L<file(1)> command to determine the type or "
6139 "contents of the file."
6143 #: ../fish/guestfish-actions.pod:1077 ../src/guestfs-actions.pod:1705
6145 "This call will also transparently look inside various types of compressed "
6150 #: ../fish/guestfish-actions.pod:1080 ../src/guestfs-actions.pod:1708
6152 "The exact command which runs is C<file -zb path>. Note in particular that "
6153 "the filename is not prepended to the output (the I<-b> option)."
6157 #: ../fish/guestfish-actions.pod:1084 ../src/guestfs-actions.pod:1712
6159 "The output depends on the output of the underlying L<file(1)> command and it "
6160 "can change in future in ways beyond our control. In other words, the output "
6161 "is not guaranteed by the ABI."
6165 #: ../fish/guestfish-actions.pod:1088
6167 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
6168 "(etc), L</is-zero>."
6172 #: ../fish/guestfish-actions.pod:1091
6173 msgid "file-architecture"
6177 #: ../fish/guestfish-actions.pod:1093
6180 " file-architecture filename\n"
6185 #: ../fish/guestfish-actions.pod:1095 ../src/guestfs-actions.pod:1730
6187 "This detects the architecture of the binary C<filename>, and returns it if "
6192 #: ../fish/guestfish-actions.pod:1098 ../src/guestfs-actions.pod:1733
6193 msgid "Currently defined architectures are:"
6197 #: ../fish/guestfish-actions.pod:1102 ../src/guestfs-actions.pod:1737
6202 #: ../fish/guestfish-actions.pod:1104 ../src/guestfs-actions.pod:1739
6204 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
6205 "irrespective of the precise processor requirements of the binary."
6209 #: ../fish/guestfish-actions.pod:1107 ../src/guestfs-actions.pod:1742
6214 #: ../fish/guestfish-actions.pod:1109 ../src/guestfs-actions.pod:1744
6215 msgid "64 bit x86-64."
6219 #: ../fish/guestfish-actions.pod:1111 ../src/guestfs-actions.pod:1746
6224 #: ../fish/guestfish-actions.pod:1113 ../src/guestfs-actions.pod:1748
6225 msgid "32 bit SPARC."
6229 #: ../fish/guestfish-actions.pod:1115 ../src/guestfs-actions.pod:1750
6234 #: ../fish/guestfish-actions.pod:1117 ../src/guestfs-actions.pod:1752
6235 msgid "64 bit SPARC V9 and above."
6239 #: ../fish/guestfish-actions.pod:1119 ../src/guestfs-actions.pod:1754
6244 #: ../fish/guestfish-actions.pod:1121 ../src/guestfs-actions.pod:1756
6245 msgid "Intel Itanium."
6249 #: ../fish/guestfish-actions.pod:1123 ../src/guestfs-actions.pod:1758
6254 #: ../fish/guestfish-actions.pod:1125 ../src/guestfs-actions.pod:1760
6255 msgid "32 bit Power PC."
6259 #: ../fish/guestfish-actions.pod:1127 ../src/guestfs-actions.pod:1762
6264 #: ../fish/guestfish-actions.pod:1129 ../src/guestfs-actions.pod:1764
6265 msgid "64 bit Power PC."
6269 #: ../fish/guestfish-actions.pod:1133 ../src/guestfs-actions.pod:1768
6270 msgid "Libguestfs may return other architecture strings in future."
6274 #: ../fish/guestfish-actions.pod:1135 ../src/guestfs-actions.pod:1770
6275 msgid "The function works on at least the following types of files:"
6279 #: ../fish/guestfish-actions.pod:1141 ../src/guestfs-actions.pod:1776
6280 msgid "many types of Un*x and Linux binary"
6284 #: ../fish/guestfish-actions.pod:1145 ../src/guestfs-actions.pod:1780
6285 msgid "many types of Un*x and Linux shared library"
6289 #: ../fish/guestfish-actions.pod:1149 ../src/guestfs-actions.pod:1784
6290 msgid "Windows Win32 and Win64 binaries"
6294 #: ../fish/guestfish-actions.pod:1153 ../src/guestfs-actions.pod:1788
6295 msgid "Windows Win32 and Win64 DLLs"
6299 #: ../fish/guestfish-actions.pod:1155 ../src/guestfs-actions.pod:1790
6300 msgid "Win32 binaries and DLLs return C<i386>."
6304 #: ../fish/guestfish-actions.pod:1157 ../src/guestfs-actions.pod:1792
6305 msgid "Win64 binaries and DLLs return C<x86_64>."
6309 #: ../fish/guestfish-actions.pod:1161 ../src/guestfs-actions.pod:1796
6310 msgid "Linux kernel modules"
6314 #: ../fish/guestfish-actions.pod:1165 ../src/guestfs-actions.pod:1800
6315 msgid "Linux new-style initrd images"
6319 #: ../fish/guestfish-actions.pod:1169 ../src/guestfs-actions.pod:1804
6320 msgid "some non-x86 Linux vmlinuz kernels"
6324 #: ../fish/guestfish-actions.pod:1173 ../src/guestfs-actions.pod:1808
6325 msgid "What it can't do currently:"
6329 #: ../fish/guestfish-actions.pod:1179 ../src/guestfs-actions.pod:1814
6330 msgid "static libraries (libfoo.a)"
6334 #: ../fish/guestfish-actions.pod:1183 ../src/guestfs-actions.pod:1818
6335 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6339 #: ../fish/guestfish-actions.pod:1187 ../src/guestfs-actions.pod:1822
6340 msgid "x86 Linux vmlinuz kernels"
6344 #: ../fish/guestfish-actions.pod:1189 ../src/guestfs-actions.pod:1824
6346 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6347 "compressed code, and are horribly hard to unpack. If you want to find the "
6348 "architecture of a kernel, use the architecture of the associated initrd or "
6349 "kernel module(s) instead."
6353 #: ../fish/guestfish-actions.pod:1196
6358 #: ../fish/guestfish-actions.pod:1198
6366 #: ../fish/guestfish-actions.pod:1200 ../src/guestfs-actions.pod:1842
6367 msgid "This command returns the size of C<file> in bytes."
6371 #: ../fish/guestfish-actions.pod:1202
6373 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
6374 "L</is-file> etc. To get the size of block devices, use "
6375 "L</blockdev-getsize64>."
6379 #: ../fish/guestfish-actions.pod:1206
6384 #: ../fish/guestfish-actions.pod:1208
6387 " fill c len path\n"
6392 #: ../fish/guestfish-actions.pod:1210 ../src/guestfs-actions.pod:1860
6394 "This command creates a new file called C<path>. The initial content of the "
6395 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
6400 #: ../fish/guestfish-actions.pod:1214
6402 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6403 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
6408 #: ../fish/guestfish-actions.pod:1219
6409 msgid "fill-pattern"
6413 #: ../fish/guestfish-actions.pod:1221
6416 " fill-pattern pattern len path\n"
6421 #: ../fish/guestfish-actions.pod:1223
6423 "This function is like L</fill> except that it creates a new file of length "
6424 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
6425 "is truncated if necessary to ensure the length of the file is exactly C<len> "
6430 #: ../fish/guestfish-actions.pod:1228
6435 #: ../fish/guestfish-actions.pod:1230
6443 #: ../fish/guestfish-actions.pod:1232 ../src/guestfs-actions.pod:1906
6445 "This command lists out all files and directories, recursively, starting at "
6446 "C<directory>. It is essentially equivalent to running the shell command "
6447 "C<find directory -print> but some post-processing happens on the output, "
6452 #: ../fish/guestfish-actions.pod:1237 ../src/guestfs-actions.pod:1911
6454 "This returns a list of strings I<without any prefix>. Thus if the directory "
6459 #: ../fish/guestfish-actions.pod:1240 ../src/guestfs-actions.pod:1914
6469 #: ../fish/guestfish-actions.pod:1244
6470 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
6474 #: ../fish/guestfish-actions.pod:1247 ../src/guestfs-actions.pod:1921
6485 #: ../fish/guestfish-actions.pod:1252 ../src/guestfs-actions.pod:1926
6486 msgid "If C<directory> is not a directory, then this command returns an error."
6490 #: ../fish/guestfish-actions.pod:1255 ../src/guestfs-actions.pod:1929
6491 msgid "The returned list is sorted."
6495 #: ../fish/guestfish-actions.pod:1257
6496 msgid "See also L</find0>."
6500 #: ../fish/guestfish-actions.pod:1262
6505 #: ../fish/guestfish-actions.pod:1264
6508 " find0 directory (files|-)\n"
6513 #: ../fish/guestfish-actions.pod:1266 ../src/guestfs-actions.pod:1949
6515 "This command lists out all files and directories, recursively, starting at "
6516 "C<directory>, placing the resulting list in the external file called "
6521 #: ../fish/guestfish-actions.pod:1270
6522 msgid "This command works the same way as L</find> with the following exceptions:"
6526 #: ../fish/guestfish-actions.pod:1277 ../src/guestfs-actions.pod:1960
6527 msgid "The resulting list is written to an external file."
6531 #: ../fish/guestfish-actions.pod:1281 ../src/guestfs-actions.pod:1964
6533 "Items (filenames) in the result are separated by C<\\0> characters. See "
6534 "L<find(1)> option I<-print0>."
6538 #: ../fish/guestfish-actions.pod:1286 ../src/guestfs-actions.pod:1969
6539 msgid "This command is not limited in the number of names that it can return."
6543 #: ../fish/guestfish-actions.pod:1291 ../src/guestfs-actions.pod:1974
6544 msgid "The result list is not sorted."
6548 #: ../fish/guestfish-actions.pod:1297
6549 msgid "findfs-label"
6553 #: ../fish/guestfish-actions.pod:1299
6556 " findfs-label label\n"
6561 #: ../fish/guestfish-actions.pod:1301 ../src/guestfs-actions.pod:1988
6563 "This command searches the filesystems and returns the one which has the "
6564 "given label. An error is returned if no such filesystem can be found."
6568 #: ../fish/guestfish-actions.pod:1305
6569 msgid "To find the label of a filesystem, use L</vfs-label>."
6573 #: ../fish/guestfish-actions.pod:1307
6578 #: ../fish/guestfish-actions.pod:1309
6581 " findfs-uuid uuid\n"
6586 #: ../fish/guestfish-actions.pod:1311 ../src/guestfs-actions.pod:2005
6588 "This command searches the filesystems and returns the one which has the "
6589 "given UUID. An error is returned if no such filesystem can be found."
6593 #: ../fish/guestfish-actions.pod:1315
6594 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
6598 #: ../fish/guestfish-actions.pod:1317
6603 #: ../fish/guestfish-actions.pod:1319
6606 " fsck fstype device\n"
6611 #: ../fish/guestfish-actions.pod:1321 ../src/guestfs-actions.pod:2023
6613 "This runs the filesystem checker (fsck) on C<device> which should have "
6614 "filesystem type C<fstype>."
6618 #: ../fish/guestfish-actions.pod:1324 ../src/guestfs-actions.pod:2026
6620 "The returned integer is the status. See L<fsck(8)> for the list of status "
6621 "codes from C<fsck>."
6625 #: ../fish/guestfish-actions.pod:1333 ../src/guestfs-actions.pod:2035
6626 msgid "Multiple status codes can be summed together."
6630 #: ../fish/guestfish-actions.pod:1337 ../src/guestfs-actions.pod:2039
6632 "A non-zero return code can mean \"success\", for example if errors have been "
6633 "corrected on the filesystem."
6637 #: ../fish/guestfish-actions.pod:1342 ../src/guestfs-actions.pod:2044
6638 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
6642 #: ../fish/guestfish-actions.pod:1347 ../src/guestfs-actions.pod:2049
6643 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
6647 #: ../fish/guestfish-actions.pod:1349
6652 #: ../fish/guestfish-actions.pod:1351
6660 #: ../fish/guestfish-actions.pod:1353 ../src/guestfs-actions.pod:2060
6662 "Return the additional kernel options which are added to the guest kernel "
6667 #: ../fish/guestfish-actions.pod:1356 ../src/guestfs-actions.pod:2063
6668 msgid "If C<NULL> then no options are added."
6672 #: ../fish/guestfish-actions.pod:1358
6673 msgid "get-attach-method"
6677 #: ../fish/guestfish-actions.pod:1360
6680 " get-attach-method\n"
6685 #: ../fish/guestfish-actions.pod:1362
6686 msgid "Return the current attach method. See L</set-attach-method>."
6690 #: ../fish/guestfish-actions.pod:1364
6691 msgid "get-autosync"
6695 #: ../fish/guestfish-actions.pod:1366
6703 #: ../fish/guestfish-actions.pod:1368 ../src/guestfs-actions.pod:2088
6704 msgid "Get the autosync flag."
6708 #: ../fish/guestfish-actions.pod:1370
6713 #: ../fish/guestfish-actions.pod:1372
6721 #: ../fish/guestfish-actions.pod:1374 ../src/guestfs-actions.pod:2099
6722 msgid "Return the direct appliance mode flag."
6726 #: ../fish/guestfish-actions.pod:1376
6731 #: ../fish/guestfish-actions.pod:1378
6734 " get-e2label device\n"
6739 #: ../fish/guestfish-actions.pod:1380 ../src/guestfs-actions.pod:2118
6740 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
6744 #: ../fish/guestfish-actions.pod:1383
6746 "I<This function is deprecated.> In new code, use the L</vfs_label> call "
6751 #: ../fish/guestfish-actions.pod:1390
6756 #: ../fish/guestfish-actions.pod:1392
6759 " get-e2uuid device\n"
6764 #: ../fish/guestfish-actions.pod:1394 ../src/guestfs-actions.pod:2139
6765 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
6769 #: ../fish/guestfish-actions.pod:1397
6771 "I<This function is deprecated.> In new code, use the L</vfs_uuid> call "
6776 #: ../fish/guestfish-actions.pod:1404
6781 #: ../fish/guestfish-actions.pod:1406
6789 #: ../fish/guestfish-actions.pod:1408 ../src/guestfs-actions.pod:2152
6790 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
6794 #: ../fish/guestfish-actions.pod:1411
6796 "If L</set-memsize> was not called on this handle, and if "
6797 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
6798 "value for memsize."
6802 #: ../fish/guestfish-actions.pod:1415 ../fish/guestfish-actions.pod:1472 ../fish/guestfish-actions.pod:4225 ../fish/guestfish-actions.pod:4327 ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:2251 ../src/guestfs-actions.pod:6430 ../src/guestfs-actions.pod:6556
6803 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
6807 #: ../fish/guestfish-actions.pod:1418
6812 #: ../fish/guestfish-actions.pod:1420
6820 #: ../fish/guestfish-actions.pod:1422 ../src/guestfs-actions.pod:2171
6821 msgid "This returns the enable network flag."
6825 #: ../fish/guestfish-actions.pod:1424
6830 #: ../fish/guestfish-actions.pod:1426
6838 #: ../fish/guestfish-actions.pod:1428 ../src/guestfs-actions.pod:2182
6839 msgid "Return the current search path."
6843 #: ../fish/guestfish-actions.pod:1430 ../src/guestfs-actions.pod:2184
6845 "This is always non-NULL. If it wasn't set already, then this will return "
6850 #: ../fish/guestfish-actions.pod:1433
6855 #: ../fish/guestfish-actions.pod:1435
6863 #: ../fish/guestfish-actions.pod:1437 ../src/guestfs-actions.pod:2197
6864 msgid "This returns the process group flag."
6868 #: ../fish/guestfish-actions.pod:1439
6873 #: ../fish/guestfish-actions.pod:1441
6878 #: ../fish/guestfish-actions.pod:1443
6886 #: ../fish/guestfish-actions.pod:1445 ../src/guestfs-actions.pod:2208
6888 "Return the process ID of the qemu subprocess. If there is no qemu "
6889 "subprocess, then this will return an error."
6893 #: ../fish/guestfish-actions.pod:1448 ../src/guestfs-actions.pod:2211
6894 msgid "This is an internal call used for debugging and testing."
6898 #: ../fish/guestfish-actions.pod:1450
6903 #: ../fish/guestfish-actions.pod:1452
6911 #: ../fish/guestfish-actions.pod:1454 ../src/guestfs-actions.pod:2222
6912 msgid "Return the current qemu binary."
6916 #: ../fish/guestfish-actions.pod:1456 ../src/guestfs-actions.pod:2224
6918 "This is always non-NULL. If it wasn't set already, then this will return "
6919 "the default qemu binary name."
6923 #: ../fish/guestfish-actions.pod:1459
6924 msgid "get-recovery-proc"
6928 #: ../fish/guestfish-actions.pod:1461
6931 " get-recovery-proc\n"
6936 #: ../fish/guestfish-actions.pod:1463 ../src/guestfs-actions.pod:2237
6937 msgid "Return the recovery process enabled flag."
6941 #: ../fish/guestfish-actions.pod:1465
6946 #: ../fish/guestfish-actions.pod:1467
6954 #: ../fish/guestfish-actions.pod:1469
6956 "This returns the current setting of the selinux flag which is passed to the "
6957 "appliance at boot time. See L</set-selinux>."
6961 #: ../fish/guestfish-actions.pod:1475
6966 #: ../fish/guestfish-actions.pod:1477
6974 #: ../fish/guestfish-actions.pod:1479 ../src/guestfs-actions.pod:2263
6975 msgid "This returns the number of virtual CPUs assigned to the appliance."
6979 #: ../fish/guestfish-actions.pod:1481
6984 #: ../fish/guestfish-actions.pod:1483
6992 #: ../fish/guestfish-actions.pod:1485 ../src/guestfs-actions.pod:2272
6994 "This returns the current state as an opaque integer. This is only useful "
6995 "for printing debug and internal error messages."
6999 #: ../fish/guestfish-actions.pod:1488 ../fish/guestfish-actions.pod:2434 ../fish/guestfish-actions.pod:2452 ../fish/guestfish-actions.pod:2490 ../fish/guestfish-actions.pod:2506 ../src/guestfs-actions.pod:2275 ../src/guestfs-actions.pod:3581 ../src/guestfs-actions.pod:3610 ../src/guestfs-actions.pod:3671 ../src/guestfs-actions.pod:3698
7000 msgid "For more information on states, see L<guestfs(3)>."
7004 #: ../fish/guestfish-actions.pod:1490
7009 #: ../fish/guestfish-actions.pod:1492
7017 #: ../fish/guestfish-actions.pod:1494 ../src/guestfs-actions.pod:2286
7018 msgid "Return the command trace flag."
7022 #: ../fish/guestfish-actions.pod:1496
7027 #: ../fish/guestfish-actions.pod:1498
7035 #: ../fish/guestfish-actions.pod:1500
7037 "Return the current umask. By default the umask is C<022> unless it has been "
7038 "set by calling L</umask>."
7042 #: ../fish/guestfish-actions.pod:1503
7047 #: ../fish/guestfish-actions.pod:1505
7055 #: ../fish/guestfish-actions.pod:1507 ../src/guestfs-actions.pod:2309
7056 msgid "This returns the verbose messages flag."
7060 #: ../fish/guestfish-actions.pod:1509
7065 #: ../fish/guestfish-actions.pod:1511
7073 #: ../fish/guestfish-actions.pod:1513 ../src/guestfs-actions.pod:2320
7074 msgid "This gets the SELinux security context of the daemon."
7078 #: ../fish/guestfish-actions.pod:1515
7079 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
7083 #: ../fish/guestfish-actions.pod:1518
7088 #: ../fish/guestfish-actions.pod:1520
7091 " getxattr path name\n"
7096 #: ../fish/guestfish-actions.pod:1522
7098 "Get a single extended attribute from file C<path> named C<name>. This call "
7099 "follows symlinks. If you want to lookup an extended attribute for the "
7100 "symlink itself, use L</lgetxattr>."
7104 #: ../fish/guestfish-actions.pod:1526 ../fish/guestfish-actions.pod:2579
7106 "Normally it is better to get all extended attributes from a file in one go "
7107 "by calling L</getxattrs>. However some Linux filesystem implementations are "
7108 "buggy and do not provide a way to list out attributes. For these "
7109 "filesystems (notably ntfs-3g) you have to know the names of the extended "
7110 "attributes you want in advance and call this function."
7114 #: ../fish/guestfish-actions.pod:1533 ../fish/guestfish-actions.pod:2586 ../src/guestfs-actions.pod:2349 ../src/guestfs-actions.pod:3831
7116 "Extended attribute values are blobs of binary data. If there is no extended "
7117 "attribute named C<name>, this returns an error."
7121 #: ../fish/guestfish-actions.pod:1536
7122 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
7126 #: ../fish/guestfish-actions.pod:1538
7131 #: ../fish/guestfish-actions.pod:1540
7139 #: ../fish/guestfish-actions.pod:1542 ../src/guestfs-actions.pod:2366
7140 msgid "This call lists the extended attributes of the file or directory C<path>."
7144 #: ../fish/guestfish-actions.pod:1545 ../src/guestfs-actions.pod:2369
7146 "At the system call level, this is a combination of the L<listxattr(2)> and "
7147 "L<getxattr(2)> calls."
7151 #: ../fish/guestfish-actions.pod:1548
7152 msgid "See also: L</lgetxattrs>, L<attr(5)>."
7156 #: ../fish/guestfish-actions.pod:1550
7161 #: ../fish/guestfish-actions.pod:1552
7164 " glob-expand pattern\n"
7169 #: ../fish/guestfish-actions.pod:1554 ../src/guestfs-actions.pod:2386
7171 "This command searches for all the pathnames matching C<pattern> according to "
7172 "the wildcard expansion rules used by the shell."
7176 #: ../fish/guestfish-actions.pod:1558 ../src/guestfs-actions.pod:2390
7177 msgid "If no paths match, then this returns an empty list (note: not an error)."
7181 #: ../fish/guestfish-actions.pod:1561 ../src/guestfs-actions.pod:2393
7183 "It is just a wrapper around the C L<glob(3)> function with flags "
7184 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
7188 #: ../fish/guestfish-actions.pod:1565
7193 #: ../fish/guestfish-actions.pod:1567
7196 " grep regex path\n"
7201 #: ../fish/guestfish-actions.pod:1569 ../src/guestfs-actions.pod:2410
7202 msgid "This calls the external C<grep> program and returns the matching lines."
7206 #: ../fish/guestfish-actions.pod:1575
7211 #: ../fish/guestfish-actions.pod:1577
7214 " grepi regex path\n"
7219 #: ../fish/guestfish-actions.pod:1579 ../src/guestfs-actions.pod:2429
7220 msgid "This calls the external C<grep -i> program and returns the matching lines."
7224 #: ../fish/guestfish-actions.pod:1585
7225 msgid "grub-install"
7229 #: ../fish/guestfish-actions.pod:1587
7232 " grub-install root device\n"
7237 #: ../fish/guestfish-actions.pod:1589 ../src/guestfs-actions.pod:2448
7239 "This command installs GRUB 1 (the Grand Unified Bootloader) on C<device>, "
7240 "with the root directory being C<root>."
7244 #: ../fish/guestfish-actions.pod:1598 ../src/guestfs-actions.pod:2457
7246 "There is currently no way in the API to install grub2, which is used by most "
7247 "modern Linux guests. It is possible to run the grub2 command from the "
7248 "guest, although see the caveats in L<guestfs(3)/RUNNING COMMANDS>."
7252 #: ../fish/guestfish-actions.pod:1605 ../src/guestfs-actions.pod:2464
7254 "This uses C<grub-install> from the host. Unfortunately grub is not always "
7255 "compatible with itself, so this only works in rather narrow circumstances. "
7256 "Careful testing with each guest version is advisable."
7260 #: ../fish/guestfish-actions.pod:1612 ../src/guestfs-actions.pod:2471
7262 "If grub-install reports the error \"No suitable drive was found in the "
7263 "generated device map.\" it may be that you need to create a "
7264 "C</boot/grub/device.map> file first that contains the mapping between grub "
7265 "device names and Linux device names. It is usually sufficient to create a "
7270 #: ../fish/guestfish-actions.pod:1619 ../src/guestfs-actions.pod:2478
7278 #: ../fish/guestfish-actions.pod:1621 ../src/guestfs-actions.pod:2480
7279 msgid "replacing C</dev/vda> with the name of the installation device."
7283 #: ../fish/guestfish-actions.pod:1625
7288 #: ../fish/guestfish-actions.pod:1627
7296 #: ../fish/guestfish-actions.pod:1629 ../src/guestfs-actions.pod:2494
7298 "This command returns up to the first 10 lines of a file as a list of "
7303 #: ../fish/guestfish-actions.pod:1635
7308 #: ../fish/guestfish-actions.pod:1637
7311 " head-n nrlines path\n"
7316 #: ../fish/guestfish-actions.pod:1639 ../src/guestfs-actions.pod:2513
7318 "If the parameter C<nrlines> is a positive number, this returns the first "
7319 "C<nrlines> lines of the file C<path>."
7323 #: ../fish/guestfish-actions.pod:1642 ../src/guestfs-actions.pod:2516
7325 "If the parameter C<nrlines> is a negative number, this returns lines from "
7326 "the file C<path>, excluding the last C<nrlines> lines."
7330 #: ../fish/guestfish-actions.pod:1645 ../fish/guestfish-actions.pod:4717 ../src/guestfs-actions.pod:2519 ../src/guestfs-actions.pod:7142
7331 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7335 #: ../fish/guestfish-actions.pod:1650
7340 #: ../fish/guestfish-actions.pod:1652
7348 #: ../fish/guestfish-actions.pod:1654 ../src/guestfs-actions.pod:2536
7350 "This runs C<hexdump -C> on the given C<path>. The result is the "
7351 "human-readable, canonical hex dump of the file."
7355 #: ../fish/guestfish-actions.pod:1660
7360 #: ../fish/guestfish-actions.pod:1662
7363 " initrd-cat initrdpath filename\n"
7368 #: ../fish/guestfish-actions.pod:1664 ../src/guestfs-actions.pod:2555
7370 "This command unpacks the file C<filename> from the initrd file called "
7371 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7376 #: ../fish/guestfish-actions.pod:1668 ../src/guestfs-actions.pod:2559
7378 "For example, in guestfish you could use the following command to examine the "
7379 "boot script (usually called C</init>) contained in a Linux initrd or "
7384 #: ../fish/guestfish-actions.pod:1672 ../src/guestfs-actions.pod:2563
7387 " initrd-cat /boot/initrd-<version>.img init\n"
7392 #: ../fish/guestfish-actions.pod:1674
7393 msgid "See also L</initrd-list>."
7397 #: ../fish/guestfish-actions.pod:1679
7402 #: ../fish/guestfish-actions.pod:1681
7405 " initrd-list path\n"
7410 #: ../fish/guestfish-actions.pod:1683 ../src/guestfs-actions.pod:2582
7411 msgid "This command lists out files contained in an initrd."
7415 #: ../fish/guestfish-actions.pod:1685 ../src/guestfs-actions.pod:2584
7417 "The files are listed without any initial C</> character. The files are "
7418 "listed in the order they appear (not necessarily alphabetical). Directory "
7419 "names are listed as separate items."
7423 #: ../fish/guestfish-actions.pod:1689 ../src/guestfs-actions.pod:2588
7425 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7426 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7431 #: ../fish/guestfish-actions.pod:1693
7432 msgid "inotify-add-watch"
7436 #: ../fish/guestfish-actions.pod:1695
7439 " inotify-add-watch path mask\n"
7444 #: ../fish/guestfish-actions.pod:1697 ../src/guestfs-actions.pod:2605
7445 msgid "Watch C<path> for the events listed in C<mask>."
7449 #: ../fish/guestfish-actions.pod:1699 ../src/guestfs-actions.pod:2607
7451 "Note that if C<path> is a directory then events within that directory are "
7452 "watched, but this does I<not> happen recursively (in subdirectories)."
7456 #: ../fish/guestfish-actions.pod:1703 ../src/guestfs-actions.pod:2611
7458 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7459 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7463 #: ../fish/guestfish-actions.pod:1707
7464 msgid "inotify-close"
7468 #: ../fish/guestfish-actions.pod:1709
7476 #: ../fish/guestfish-actions.pod:1711 ../src/guestfs-actions.pod:2624
7478 "This closes the inotify handle which was previously opened by inotify_init. "
7479 "It removes all watches, throws away any pending events, and deallocates all "
7484 #: ../fish/guestfish-actions.pod:1715
7485 msgid "inotify-files"
7489 #: ../fish/guestfish-actions.pod:1717
7497 #: ../fish/guestfish-actions.pod:1719
7499 "This function is a helpful wrapper around L</inotify-read> which just "
7500 "returns a list of pathnames of objects that were touched. The returned "
7501 "pathnames are sorted and deduplicated."
7505 #: ../fish/guestfish-actions.pod:1723
7506 msgid "inotify-init"
7510 #: ../fish/guestfish-actions.pod:1725
7513 " inotify-init maxevents\n"
7518 #: ../fish/guestfish-actions.pod:1727 ../src/guestfs-actions.pod:2653
7520 "This command creates a new inotify handle. The inotify subsystem can be "
7521 "used to notify events which happen to objects in the guest filesystem."
7525 #: ../fish/guestfish-actions.pod:1731
7527 "C<maxevents> is the maximum number of events which will be queued up between "
7528 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
7529 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
7530 "default was 16384 events. Beyond this limit, the kernel throws away events, "
7531 "but records the fact that it threw them away by setting a flag "
7532 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
7536 #: ../fish/guestfish-actions.pod:1741
7538 "Before any events are generated, you have to add some watches to the "
7539 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
7540 "L</inotify-watch-all>."
7544 #: ../fish/guestfish-actions.pod:1747
7546 "Queued up events should be read periodically by calling L</inotify-read> (or "
7547 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
7548 "If you don't read the events out often enough then you risk the internal "
7549 "queue overflowing."
7553 #: ../fish/guestfish-actions.pod:1754
7555 "The handle should be closed after use by calling L</inotify-close>. This "
7556 "also removes any watches automatically."
7560 #: ../fish/guestfish-actions.pod:1758 ../src/guestfs-actions.pod:2684
7562 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7563 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
7564 "that there is one global inotify handle per libguestfs instance."
7568 #: ../fish/guestfish-actions.pod:1763
7569 msgid "inotify-read"
7573 #: ../fish/guestfish-actions.pod:1765
7581 #: ../fish/guestfish-actions.pod:1767 ../src/guestfs-actions.pod:2698
7583 "Return the complete queue of events that have happened since the previous "
7588 #: ../fish/guestfish-actions.pod:1770 ../src/guestfs-actions.pod:2701
7589 msgid "If no events have happened, this returns an empty list."
7593 #: ../fish/guestfish-actions.pod:1772 ../src/guestfs-actions.pod:2703
7595 "I<Note>: In order to make sure that all events have been read, you must call "
7596 "this function repeatedly until it returns an empty list. The reason is that "
7597 "the call will read events up to the maximum appliance-to-host message size "
7598 "and leave remaining events in the queue."
7602 #: ../fish/guestfish-actions.pod:1778
7603 msgid "inotify-rm-watch"
7607 #: ../fish/guestfish-actions.pod:1780
7610 " inotify-rm-watch wd\n"
7615 #: ../fish/guestfish-actions.pod:1782
7616 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
7620 #: ../fish/guestfish-actions.pod:1785
7621 msgid "inspect-get-arch"
7625 #: ../fish/guestfish-actions.pod:1787
7628 " inspect-get-arch root\n"
7633 #: ../fish/guestfish-actions.pod:1789
7635 "This returns the architecture of the inspected operating system. The "
7636 "possible return values are listed under L</file-architecture>."
7640 #: ../fish/guestfish-actions.pod:1793 ../src/guestfs-actions.pod:2738
7642 "If the architecture could not be determined, then the string C<unknown> is "
7647 #: ../fish/guestfish-actions.pod:1796 ../fish/guestfish-actions.pod:1883 ../fish/guestfish-actions.pod:1962 ../fish/guestfish-actions.pod:1974 ../fish/guestfish-actions.pod:2058 ../fish/guestfish-actions.pod:2119 ../fish/guestfish-actions.pod:2140 ../fish/guestfish-actions.pod:2154 ../fish/guestfish-actions.pod:2194 ../fish/guestfish-actions.pod:2226 ../fish/guestfish-actions.pod:2239 ../fish/guestfish-actions.pod:2252 ../fish/guestfish-actions.pod:2262 ../fish/guestfish-actions.pod:2272 ../fish/guestfish-actions.pod:2284 ../fish/guestfish-actions.pod:2380 ../fish/guestfish-actions.pod:2414 ../src/guestfs-actions.pod:2741 ../src/guestfs-actions.pod:2835 ../src/guestfs-actions.pod:2939 ../src/guestfs-actions.pod:2958 ../src/guestfs-actions.pod:3089 ../src/guestfs-actions.pod:3172 ../src/guestfs-actions.pod:3200 ../src/guestfs-actions.pod:3221 ../src/guestfs-actions.pod:3274 ../src/guestfs-actions.pod:3314 ../src/guestfs-actions.pod:3334 ../src/guestfs-actions.pod:3354 ../src/guestfs-actions.pod:3371 ../src/guestfs-actions.pod:3387 ../src/guestfs-actions.pod:3405 ../src/guestfs-actions.pod:3507 ../src/guestfs-actions.pod:3548
7648 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
7652 #: ../fish/guestfish-actions.pod:1798
7653 msgid "inspect-get-distro"
7657 #: ../fish/guestfish-actions.pod:1800
7660 " inspect-get-distro root\n"
7665 #: ../fish/guestfish-actions.pod:1802 ../src/guestfs-actions.pod:2754
7666 msgid "This returns the distro (distribution) of the inspected operating system."
7670 #: ../fish/guestfish-actions.pod:1805 ../src/guestfs-actions.pod:2757
7671 msgid "Currently defined distros are:"
7675 #: ../fish/guestfish-actions.pod:1809 ../src/guestfs-actions.pod:2761
7676 msgid "\"archlinux\""
7680 #: ../fish/guestfish-actions.pod:1811 ../src/guestfs-actions.pod:2763
7685 #: ../fish/guestfish-actions.pod:1813 ../src/guestfs-actions.pod:2765
7690 #: ../fish/guestfish-actions.pod:1815 ../src/guestfs-actions.pod:2767
7695 #: ../fish/guestfish-actions.pod:1817 ../src/guestfs-actions.pod:2769
7700 #: ../fish/guestfish-actions.pod:1819 ../src/guestfs-actions.pod:2771
7705 #: ../fish/guestfish-actions.pod:1821 ../src/guestfs-actions.pod:2773
7710 #: ../fish/guestfish-actions.pod:1823 ../src/guestfs-actions.pod:2775
7715 #: ../fish/guestfish-actions.pod:1825 ../src/guestfs-actions.pod:2777
7720 #: ../fish/guestfish-actions.pod:1827 ../src/guestfs-actions.pod:2779
7725 #: ../fish/guestfish-actions.pod:1829 ../src/guestfs-actions.pod:2781
7726 msgid "\"linuxmint\""
7730 #: ../fish/guestfish-actions.pod:1831 ../src/guestfs-actions.pod:2783
7735 #: ../fish/guestfish-actions.pod:1833 ../src/guestfs-actions.pod:2785
7736 msgid "\"mandriva\""
7740 #: ../fish/guestfish-actions.pod:1835 ../src/guestfs-actions.pod:2787
7745 #: ../fish/guestfish-actions.pod:1837 ../src/guestfs-actions.pod:2789
7750 #: ../fish/guestfish-actions.pod:1839 ../src/guestfs-actions.pod:2791
7755 #: ../fish/guestfish-actions.pod:1841 ../src/guestfs-actions.pod:2793
7760 #: ../fish/guestfish-actions.pod:1843 ../src/guestfs-actions.pod:2795
7765 #: ../fish/guestfish-actions.pod:1845 ../src/guestfs-actions.pod:2797
7766 msgid "\"redhat-based\""
7770 #: ../fish/guestfish-actions.pod:1847 ../src/guestfs-actions.pod:2799
7771 msgid "Some Red Hat-derived distro."
7775 #: ../fish/guestfish-actions.pod:1849 ../src/guestfs-actions.pod:2801
7780 #: ../fish/guestfish-actions.pod:1851 ../src/guestfs-actions.pod:2803
7781 msgid "Red Hat Enterprise Linux."
7785 #: ../fish/guestfish-actions.pod:1853 ../src/guestfs-actions.pod:2805
7786 msgid "\"scientificlinux\""
7790 #: ../fish/guestfish-actions.pod:1855 ../src/guestfs-actions.pod:2807
7791 msgid "Scientific Linux."
7795 #: ../fish/guestfish-actions.pod:1857 ../src/guestfs-actions.pod:2809
7796 msgid "\"slackware\""
7800 #: ../fish/guestfish-actions.pod:1859 ../src/guestfs-actions.pod:2811
7805 #: ../fish/guestfish-actions.pod:1861 ../src/guestfs-actions.pod:2813
7806 msgid "\"ttylinux\""
7810 #: ../fish/guestfish-actions.pod:1863 ../src/guestfs-actions.pod:2815
7815 #: ../fish/guestfish-actions.pod:1865 ../src/guestfs-actions.pod:2817
7820 #: ../fish/guestfish-actions.pod:1867 ../src/guestfs-actions.pod:2819
7825 #: ../fish/guestfish-actions.pod:1869 ../fish/guestfish-actions.pod:1953 ../fish/guestfish-actions.pod:2217 ../src/guestfs-actions.pod:2821 ../src/guestfs-actions.pod:2930 ../src/guestfs-actions.pod:3305
7830 #: ../fish/guestfish-actions.pod:1871 ../src/guestfs-actions.pod:2823
7831 msgid "The distro could not be determined."
7835 #: ../fish/guestfish-actions.pod:1873 ../fish/guestfish-actions.pod:2209 ../src/guestfs-actions.pod:2825 ../src/guestfs-actions.pod:3297
7840 #: ../fish/guestfish-actions.pod:1875 ../src/guestfs-actions.pod:2827
7842 "Windows does not have distributions. This string is returned if the OS type "
7847 #: ../fish/guestfish-actions.pod:1880 ../fish/guestfish-actions.pod:1959 ../fish/guestfish-actions.pod:2223 ../src/guestfs-actions.pod:2832 ../src/guestfs-actions.pod:2936 ../src/guestfs-actions.pod:3311
7849 "Future versions of libguestfs may return other strings here. The caller "
7850 "should be prepared to handle any string."
7854 #: ../fish/guestfish-actions.pod:1885
7855 msgid "inspect-get-drive-mappings"
7859 #: ../fish/guestfish-actions.pod:1887
7862 " inspect-get-drive-mappings root\n"
7867 #: ../fish/guestfish-actions.pod:1889 ../src/guestfs-actions.pod:2848
7869 "This call is useful for Windows which uses a primitive system of assigning "
7870 "drive letters (like \"C:\") to partitions. This inspection API examines the "
7871 "Windows Registry to find out how disks/partitions are mapped to drive "
7872 "letters, and returns a hash table as in the example below:"
7876 #: ../fish/guestfish-actions.pod:1895 ../src/guestfs-actions.pod:2854
7886 #: ../fish/guestfish-actions.pod:1899 ../src/guestfs-actions.pod:2858
7888 "Note that keys are drive letters. For Windows, the key is case insensitive "
7889 "and just contains the drive letter, without the customary colon separator "
7894 #: ../fish/guestfish-actions.pod:1903 ../src/guestfs-actions.pod:2862
7896 "In future we may support other operating systems that also used drive "
7897 "letters, but the keys for those might not be case insensitive and might be "
7898 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
7903 #: ../fish/guestfish-actions.pod:1908 ../src/guestfs-actions.pod:2867
7905 "For Windows guests, currently only hard drive mappings are returned. "
7906 "Removable disks (eg. DVD-ROMs) are ignored."
7910 #: ../fish/guestfish-actions.pod:1911 ../src/guestfs-actions.pod:2870
7912 "For guests that do not use drive mappings, or if the drive mappings could "
7913 "not be determined, this returns an empty hash table."
7917 #: ../fish/guestfish-actions.pod:1914
7919 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7920 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
7924 #: ../fish/guestfish-actions.pod:1918
7925 msgid "inspect-get-filesystems"
7929 #: ../fish/guestfish-actions.pod:1920
7932 " inspect-get-filesystems root\n"
7937 #: ../fish/guestfish-actions.pod:1922 ../src/guestfs-actions.pod:2891
7939 "This returns a list of all the filesystems that we think are associated with "
7940 "this operating system. This includes the root filesystem, other ordinary "
7941 "filesystems, and non-mounted devices like swap partitions."
7945 #: ../fish/guestfish-actions.pod:1927 ../src/guestfs-actions.pod:2896
7947 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
7948 "to be shared between operating systems."
7952 #: ../fish/guestfish-actions.pod:1930
7954 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7955 "L</inspect-get-mountpoints>."
7959 #: ../fish/guestfish-actions.pod:1933
7960 msgid "inspect-get-format"
7964 #: ../fish/guestfish-actions.pod:1935
7967 " inspect-get-format root\n"
7972 #: ../fish/guestfish-actions.pod:1937 ../src/guestfs-actions.pod:2914
7974 "This returns the format of the inspected operating system. You can use it "
7975 "to detect install images, live CDs and similar."
7979 #: ../fish/guestfish-actions.pod:1940 ../src/guestfs-actions.pod:2917
7980 msgid "Currently defined formats are:"
7984 #: ../fish/guestfish-actions.pod:1944 ../src/guestfs-actions.pod:2921
7985 msgid "\"installed\""
7989 #: ../fish/guestfish-actions.pod:1946 ../src/guestfs-actions.pod:2923
7990 msgid "This is an installed operating system."
7994 #: ../fish/guestfish-actions.pod:1948 ../src/guestfs-actions.pod:2925
7995 msgid "\"installer\""
7999 #: ../fish/guestfish-actions.pod:1950 ../src/guestfs-actions.pod:2927
8001 "The disk image being inspected is not an installed operating system, but a "
8002 "I<bootable> install disk, live CD, or similar."
8006 #: ../fish/guestfish-actions.pod:1955 ../src/guestfs-actions.pod:2932
8007 msgid "The format of this disk image is not known."
8011 #: ../fish/guestfish-actions.pod:1964
8012 msgid "inspect-get-hostname"
8016 #: ../fish/guestfish-actions.pod:1966
8019 " inspect-get-hostname root\n"
8024 #: ../fish/guestfish-actions.pod:1968 ../src/guestfs-actions.pod:2952
8026 "This function returns the hostname of the operating system as found by "
8027 "inspection of the guest's configuration files."
8031 #: ../fish/guestfish-actions.pod:1971 ../src/guestfs-actions.pod:2955
8033 "If the hostname could not be determined, then the string C<unknown> is "
8038 #: ../fish/guestfish-actions.pod:1976
8039 msgid "inspect-get-icon"
8043 #: ../fish/guestfish-actions.pod:1978
8046 " inspect-get-icon root [favicon:..] [highquality:..]\n"
8051 #: ../fish/guestfish-actions.pod:1980 ../src/guestfs-actions.pod:2981
8053 "This function returns an icon corresponding to the inspected operating "
8054 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
8055 "to PNG if necessary)."
8059 #: ../fish/guestfish-actions.pod:1984 ../src/guestfs-actions.pod:2985
8061 "If it was not possible to get an icon this function returns a zero-length "
8062 "(non-NULL) buffer. I<Callers must check for this case>."
8066 #: ../fish/guestfish-actions.pod:1987 ../src/guestfs-actions.pod:2988
8068 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
8069 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
8070 "this file will be returned. You can disable favicons by passing the "
8071 "optional C<favicon> boolean as false (default is true)."
8075 #: ../fish/guestfish-actions.pod:1993 ../src/guestfs-actions.pod:2994
8077 "If finding the favicon fails, then we look in other places in the guest for "
8082 #: ../fish/guestfish-actions.pod:1996 ../src/guestfs-actions.pod:2997
8084 "If the optional C<highquality> boolean is true then only high quality icons "
8085 "are returned, which means only icons of high resolution with an alpha "
8086 "channel. The default (false) is to return any icon we can, even if it is of "
8087 "substandard quality."
8091 #: ../fish/guestfish-actions.pod:2007 ../src/guestfs-actions.pod:3008
8093 "Unlike most other inspection API calls, the guest's disks must be mounted up "
8094 "before you call this, since it needs to read information from the guest "
8095 "filesystem during the call."
8099 #: ../fish/guestfish-actions.pod:2013 ../src/guestfs-actions.pod:3014
8101 "B<Security:> The icon data comes from the untrusted guest, and should be "
8102 "treated with caution. PNG files have been known to contain exploits. "
8103 "Ensure that libpng (or other relevant libraries) are fully up to date before "
8104 "trying to process or display the icon."
8108 #: ../fish/guestfish-actions.pod:2021 ../src/guestfs-actions.pod:3022
8110 "The PNG image returned can be any size. It might not be square. Libguestfs "
8111 "tries to return the largest, highest quality icon available. The "
8112 "application must scale the icon to the required size."
8116 #: ../fish/guestfish-actions.pod:2028 ../src/guestfs-actions.pod:3029
8118 "Extracting icons from Windows guests requires the external C<wrestool> "
8119 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
8120 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
8121 "installed separately."
8125 #: ../fish/guestfish-actions.pod:2035 ../src/guestfs-actions.pod:3036
8127 "Operating system icons are usually trademarks. Seek legal advice before "
8128 "using trademarks in applications."
8132 #: ../fish/guestfish-actions.pod:2042
8133 msgid "inspect-get-major-version"
8137 #: ../fish/guestfish-actions.pod:2044
8140 " inspect-get-major-version root\n"
8145 #: ../fish/guestfish-actions.pod:2046 ../src/guestfs-actions.pod:3077
8146 msgid "This returns the major version number of the inspected operating system."
8150 #: ../fish/guestfish-actions.pod:2049 ../src/guestfs-actions.pod:3080
8152 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
8153 "popular public names used by the operating system. Notably the operating "
8154 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
8155 "1). You can find out the real versions corresponding to releases of Windows "
8156 "by consulting Wikipedia or MSDN."
8160 #: ../fish/guestfish-actions.pod:2056 ../fish/guestfish-actions.pod:2067 ../src/guestfs-actions.pod:3087 ../src/guestfs-actions.pod:3104
8161 msgid "If the version could not be determined, then C<0> is returned."
8165 #: ../fish/guestfish-actions.pod:2060
8166 msgid "inspect-get-minor-version"
8170 #: ../fish/guestfish-actions.pod:2062
8173 " inspect-get-minor-version root\n"
8178 #: ../fish/guestfish-actions.pod:2064 ../src/guestfs-actions.pod:3101
8179 msgid "This returns the minor version number of the inspected operating system."
8183 #: ../fish/guestfish-actions.pod:2069
8185 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8186 "L</inspect-get-major-version>."
8190 #: ../fish/guestfish-actions.pod:2072
8191 msgid "inspect-get-mountpoints"
8195 #: ../fish/guestfish-actions.pod:2074
8198 " inspect-get-mountpoints root\n"
8203 #: ../fish/guestfish-actions.pod:2076 ../src/guestfs-actions.pod:3119
8205 "This returns a hash of where we think the filesystems associated with this "
8206 "operating system should be mounted. Callers should note that this is at "
8207 "best an educated guess made by reading configuration files such as "
8208 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
8209 "are non-existent or not mountable and callers should be prepared to handle "
8210 "or ignore failures if they try to mount them."
8214 #: ../fish/guestfish-actions.pod:2085 ../src/guestfs-actions.pod:3128
8216 "Each element in the returned hashtable has a key which is the path of the "
8217 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
8218 "mounted there (eg. C</dev/sda1>)."
8222 #: ../fish/guestfish-actions.pod:2090 ../src/guestfs-actions.pod:3133
8223 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
8227 #: ../fish/guestfish-actions.pod:2093
8229 "For operating systems like Windows which still use drive letters, this call "
8230 "will only return an entry for the first drive \"mounted on\" C</>. For "
8231 "information about the mapping of drive letters to partitions, see "
8232 "L</inspect-get-drive-mappings>."
8236 #: ../fish/guestfish-actions.pod:2099
8238 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8239 "L</inspect-get-filesystems>."
8243 #: ../fish/guestfish-actions.pod:2102
8244 msgid "inspect-get-package-format"
8248 #: ../fish/guestfish-actions.pod:2104
8251 " inspect-get-package-format root\n"
8256 #: ../fish/guestfish-actions.pod:2106
8258 "This function and L</inspect-get-package-management> return the package "
8259 "format and package management tool used by the inspected operating system. "
8260 "For example for Fedora these functions would return C<rpm> (package format) "
8261 "and C<yum> (package management)."
8265 #: ../fish/guestfish-actions.pod:2112 ../src/guestfs-actions.pod:3165
8267 "This returns the string C<unknown> if we could not determine the package "
8268 "format I<or> if the operating system does not have a real packaging system "
8273 #: ../fish/guestfish-actions.pod:2116 ../src/guestfs-actions.pod:3169
8275 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
8276 "Future versions of libguestfs may return other strings."
8280 #: ../fish/guestfish-actions.pod:2121
8281 msgid "inspect-get-package-management"
8285 #: ../fish/guestfish-actions.pod:2123
8288 " inspect-get-package-management root\n"
8293 #: ../fish/guestfish-actions.pod:2125
8295 "L</inspect-get-package-format> and this function return the package format "
8296 "and package management tool used by the inspected operating system. For "
8297 "example for Fedora these functions would return C<rpm> (package format) and "
8298 "C<yum> (package management)."
8302 #: ../fish/guestfish-actions.pod:2131 ../src/guestfs-actions.pod:3191
8304 "This returns the string C<unknown> if we could not determine the package "
8305 "management tool I<or> if the operating system does not have a real packaging "
8306 "system (eg. Windows)."
8310 #: ../fish/guestfish-actions.pod:2135 ../src/guestfs-actions.pod:3195
8312 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
8313 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
8314 "libguestfs may return other strings."
8318 #: ../fish/guestfish-actions.pod:2142
8319 msgid "inspect-get-product-name"
8323 #: ../fish/guestfish-actions.pod:2144
8326 " inspect-get-product-name root\n"
8331 #: ../fish/guestfish-actions.pod:2146 ../src/guestfs-actions.pod:3213
8333 "This returns the product name of the inspected operating system. The "
8334 "product name is generally some freeform string which can be displayed to the "
8335 "user, but should not be parsed by programs."
8339 #: ../fish/guestfish-actions.pod:2151 ../src/guestfs-actions.pod:3218
8341 "If the product name could not be determined, then the string C<unknown> is "
8346 #: ../fish/guestfish-actions.pod:2156
8347 msgid "inspect-get-product-variant"
8351 #: ../fish/guestfish-actions.pod:2158
8354 " inspect-get-product-variant root\n"
8359 #: ../fish/guestfish-actions.pod:2160 ../src/guestfs-actions.pod:3234
8360 msgid "This returns the product variant of the inspected operating system."
8364 #: ../fish/guestfish-actions.pod:2163 ../src/guestfs-actions.pod:3237
8366 "For Windows guests, this returns the contents of the Registry key "
8367 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
8368 "which is usually a string such as C<Client> or C<Server> (other values are "
8369 "possible). This can be used to distinguish consumer and enterprise versions "
8370 "of Windows that have the same version number (for example, Windows 7 and "
8371 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
8372 "the latter is C<Server>)."
8376 #: ../fish/guestfish-actions.pod:2172 ../src/guestfs-actions.pod:3246
8378 "For enterprise Linux guests, in future we intend this to return the product "
8379 "variant such as C<Desktop>, C<Server> and so on. But this is not "
8380 "implemented at present."
8384 #: ../fish/guestfish-actions.pod:2176 ../src/guestfs-actions.pod:3250
8386 "If the product variant could not be determined, then the string C<unknown> "
8391 #: ../fish/guestfish-actions.pod:2179
8393 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8394 "L</inspect-get-product-name>, L</inspect-get-major-version>."
8398 #: ../fish/guestfish-actions.pod:2183
8399 msgid "inspect-get-roots"
8403 #: ../fish/guestfish-actions.pod:2185
8406 " inspect-get-roots\n"
8411 #: ../fish/guestfish-actions.pod:2187
8413 "This function is a convenient way to get the list of root devices, as "
8414 "returned from a previous call to L</inspect-os>, but without redoing the "
8415 "whole inspection process."
8419 #: ../fish/guestfish-actions.pod:2191
8421 "This returns an empty list if either no root devices were found or the "
8422 "caller has not called L</inspect-os>."
8426 #: ../fish/guestfish-actions.pod:2196
8427 msgid "inspect-get-type"
8431 #: ../fish/guestfish-actions.pod:2198
8434 " inspect-get-type root\n"
8439 #: ../fish/guestfish-actions.pod:2200 ../src/guestfs-actions.pod:3288
8441 "This returns the type of the inspected operating system. Currently defined "
8446 #: ../fish/guestfish-actions.pod:2205 ../src/guestfs-actions.pod:3293
8451 #: ../fish/guestfish-actions.pod:2207 ../src/guestfs-actions.pod:3295
8452 msgid "Any Linux-based operating system."
8456 #: ../fish/guestfish-actions.pod:2211 ../src/guestfs-actions.pod:3299
8457 msgid "Any Microsoft Windows operating system."
8461 #: ../fish/guestfish-actions.pod:2213 ../src/guestfs-actions.pod:3301
8466 #: ../fish/guestfish-actions.pod:2215 ../src/guestfs-actions.pod:3303
8471 #: ../fish/guestfish-actions.pod:2219 ../src/guestfs-actions.pod:3307
8472 msgid "The operating system type could not be determined."
8476 #: ../fish/guestfish-actions.pod:2228
8477 msgid "inspect-get-windows-current-control-set"
8481 #: ../fish/guestfish-actions.pod:2230
8484 " inspect-get-windows-current-control-set root\n"
8489 #: ../fish/guestfish-actions.pod:2232 ../src/guestfs-actions.pod:3327
8491 "This returns the Windows CurrentControlSet of the inspected guest. The "
8492 "CurrentControlSet is a registry key name such as C<ControlSet001>."
8496 #: ../fish/guestfish-actions.pod:2235 ../src/guestfs-actions.pod:3330
8498 "This call assumes that the guest is Windows and that the Registry could be "
8499 "examined by inspection. If this is not the case then an error is returned."
8503 #: ../fish/guestfish-actions.pod:2241
8504 msgid "inspect-get-windows-systemroot"
8508 #: ../fish/guestfish-actions.pod:2243
8511 " inspect-get-windows-systemroot root\n"
8516 #: ../fish/guestfish-actions.pod:2245 ../src/guestfs-actions.pod:3347
8518 "This returns the Windows systemroot of the inspected guest. The systemroot "
8519 "is a directory path such as C</WINDOWS>."
8523 #: ../fish/guestfish-actions.pod:2248 ../src/guestfs-actions.pod:3350
8525 "This call assumes that the guest is Windows and that the systemroot could be "
8526 "determined by inspection. If this is not the case then an error is "
8531 #: ../fish/guestfish-actions.pod:2254
8532 msgid "inspect-is-live"
8536 #: ../fish/guestfish-actions.pod:2256
8539 " inspect-is-live root\n"
8544 #: ../fish/guestfish-actions.pod:2258
8546 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8547 "then this returns true if a live image was detected on the disk."
8551 #: ../fish/guestfish-actions.pod:2264
8552 msgid "inspect-is-multipart"
8556 #: ../fish/guestfish-actions.pod:2266
8559 " inspect-is-multipart root\n"
8564 #: ../fish/guestfish-actions.pod:2268
8566 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8567 "then this returns true if the disk is part of a set."
8571 #: ../fish/guestfish-actions.pod:2274
8572 msgid "inspect-is-netinst"
8576 #: ../fish/guestfish-actions.pod:2276
8579 " inspect-is-netinst root\n"
8584 #: ../fish/guestfish-actions.pod:2278
8586 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8587 "then this returns true if the disk is a network installer, ie. not a "
8588 "self-contained install CD but one which is likely to require network access "
8589 "to complete the install."
8593 #: ../fish/guestfish-actions.pod:2286
8594 msgid "inspect-list-applications"
8598 #: ../fish/guestfish-actions.pod:2288
8601 " inspect-list-applications root\n"
8606 #: ../fish/guestfish-actions.pod:2290 ../src/guestfs-actions.pod:3417
8607 msgid "Return the list of applications installed in the operating system."
8611 #: ../fish/guestfish-actions.pod:2292
8613 "I<Note:> This call works differently from other parts of the inspection "
8614 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
8615 "then mount up the disks, before calling this. Listing applications is a "
8616 "significantly more difficult operation which requires access to the full "
8617 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
8618 "are just returning data cached in the libguestfs handle, this call actually "
8619 "reads parts of the mounted filesystems during the call."
8623 #: ../fish/guestfish-actions.pod:2302 ../src/guestfs-actions.pod:3429
8625 "This returns an empty list if the inspection code was not able to determine "
8626 "the list of applications."
8630 #: ../fish/guestfish-actions.pod:2305 ../src/guestfs-actions.pod:3432
8631 msgid "The application structure contains the following fields:"
8635 #: ../fish/guestfish-actions.pod:2309 ../src/guestfs-actions.pod:3436
8640 #: ../fish/guestfish-actions.pod:2311 ../src/guestfs-actions.pod:3438
8642 "The name of the application. For Red Hat-derived and Debian-derived Linux "
8643 "guests, this is the package name."
8647 #: ../fish/guestfish-actions.pod:2314 ../src/guestfs-actions.pod:3441
8648 msgid "C<app_display_name>"
8652 #: ../fish/guestfish-actions.pod:2316 ../src/guestfs-actions.pod:3443
8654 "The display name of the application, sometimes localized to the install "
8655 "language of the guest operating system."
8659 #: ../fish/guestfish-actions.pod:2319 ../src/guestfs-actions.pod:3446
8661 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
8662 "to display something can use C<app_name> instead."
8666 #: ../fish/guestfish-actions.pod:2322 ../src/guestfs-actions.pod:3449
8667 msgid "C<app_epoch>"
8671 #: ../fish/guestfish-actions.pod:2324 ../src/guestfs-actions.pod:3451
8673 "For package managers which use epochs, this contains the epoch of the "
8674 "package (an integer). If unavailable, this is returned as C<0>."
8678 #: ../fish/guestfish-actions.pod:2327 ../src/guestfs-actions.pod:3454
8679 msgid "C<app_version>"
8683 #: ../fish/guestfish-actions.pod:2329 ../src/guestfs-actions.pod:3456
8685 "The version string of the application or package. If unavailable this is "
8686 "returned as an empty string C<\"\">."
8690 #: ../fish/guestfish-actions.pod:2332 ../src/guestfs-actions.pod:3459
8691 msgid "C<app_release>"
8695 #: ../fish/guestfish-actions.pod:2334 ../src/guestfs-actions.pod:3461
8697 "The release string of the application or package, for package managers that "
8698 "use this. If unavailable this is returned as an empty string C<\"\">."
8702 #: ../fish/guestfish-actions.pod:2338 ../src/guestfs-actions.pod:3465
8703 msgid "C<app_install_path>"
8707 #: ../fish/guestfish-actions.pod:2340 ../src/guestfs-actions.pod:3467
8709 "The installation path of the application (on operating systems such as "
8710 "Windows which use installation paths). This path is in the format used by "
8711 "the guest operating system, it is not a libguestfs path."
8715 #: ../fish/guestfish-actions.pod:2345 ../src/guestfs-actions.pod:3472
8716 msgid "If unavailable this is returned as an empty string C<\"\">."
8720 #: ../fish/guestfish-actions.pod:2347 ../src/guestfs-actions.pod:3474
8721 msgid "C<app_trans_path>"
8725 #: ../fish/guestfish-actions.pod:2349 ../src/guestfs-actions.pod:3476
8727 "The install path translated into a libguestfs path. If unavailable this is "
8728 "returned as an empty string C<\"\">."
8732 #: ../fish/guestfish-actions.pod:2352 ../src/guestfs-actions.pod:3479
8733 msgid "C<app_publisher>"
8737 #: ../fish/guestfish-actions.pod:2354 ../src/guestfs-actions.pod:3481
8739 "The name of the publisher of the application, for package managers that use "
8740 "this. If unavailable this is returned as an empty string C<\"\">."
8744 #: ../fish/guestfish-actions.pod:2358 ../src/guestfs-actions.pod:3485
8749 #: ../fish/guestfish-actions.pod:2360 ../src/guestfs-actions.pod:3487
8751 "The URL (eg. upstream URL) of the application. If unavailable this is "
8752 "returned as an empty string C<\"\">."
8756 #: ../fish/guestfish-actions.pod:2363 ../src/guestfs-actions.pod:3490
8757 msgid "C<app_source_package>"
8761 #: ../fish/guestfish-actions.pod:2365 ../src/guestfs-actions.pod:3492
8763 "For packaging systems which support this, the name of the source package. "
8764 "If unavailable this is returned as an empty string C<\"\">."
8768 #: ../fish/guestfish-actions.pod:2368 ../src/guestfs-actions.pod:3495
8769 msgid "C<app_summary>"
8773 #: ../fish/guestfish-actions.pod:2370 ../src/guestfs-actions.pod:3497
8775 "A short (usually one line) description of the application or package. If "
8776 "unavailable this is returned as an empty string C<\"\">."
8780 #: ../fish/guestfish-actions.pod:2373 ../src/guestfs-actions.pod:3500
8781 msgid "C<app_description>"
8785 #: ../fish/guestfish-actions.pod:2375 ../src/guestfs-actions.pod:3502
8787 "A longer description of the application or package. If unavailable this is "
8788 "returned as an empty string C<\"\">."
8792 #: ../fish/guestfish-actions.pod:2382
8797 #: ../fish/guestfish-actions.pod:2384
8805 #: ../fish/guestfish-actions.pod:2386 ../src/guestfs-actions.pod:3520
8807 "This function uses other libguestfs functions and certain heuristics to "
8808 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
8809 "for operating systems."
8813 #: ../fish/guestfish-actions.pod:2390 ../src/guestfs-actions.pod:3524
8814 msgid "The list returned is empty if no operating systems were found."
8818 #: ../fish/guestfish-actions.pod:2392 ../src/guestfs-actions.pod:3526
8820 "If one operating system was found, then this returns a list with a single "
8821 "element, which is the name of the root filesystem of this operating system. "
8822 "It is also possible for this function to return a list containing more than "
8823 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
8824 "element being the root filesystem of one of the operating systems."
8828 #: ../fish/guestfish-actions.pod:2399
8830 "You can pass the root string(s) returned to other L</inspect-get-*> "
8831 "functions in order to query further information about each operating system, "
8832 "such as the name and version."
8836 #: ../fish/guestfish-actions.pod:2404
8838 "This function uses other libguestfs features such as L</mount-ro> and "
8839 "L</umount-all> in order to mount and unmount filesystems and look at the "
8840 "contents. This should be called with no disks currently mounted. The "
8841 "function may also use Augeas, so any existing Augeas handle will be closed."
8845 #: ../fish/guestfish-actions.pod:2410 ../src/guestfs-actions.pod:3544
8847 "This function cannot decrypt encrypted disks. The caller must do that first "
8848 "(supplying the necessary keys) if the disk is encrypted."
8852 #: ../fish/guestfish-actions.pod:2416 ../fish/guestfish-actions.pod:2614 ../fish/guestfish-actions.pod:2673
8853 msgid "See also L</list-filesystems>."
8857 #: ../fish/guestfish-actions.pod:2418
8862 #: ../fish/guestfish-actions.pod:2420
8865 " is-blockdev path\n"
8870 #: ../fish/guestfish-actions.pod:2422 ../src/guestfs-actions.pod:3564
8872 "This returns C<true> if and only if there is a block device with the given "
8877 #: ../fish/guestfish-actions.pod:2425 ../fish/guestfish-actions.pod:2443 ../fish/guestfish-actions.pod:2462 ../fish/guestfish-actions.pod:2471 ../fish/guestfish-actions.pod:2481 ../fish/guestfish-actions.pod:2515 ../fish/guestfish-actions.pod:2524
8878 msgid "See also L</stat>."
8882 #: ../fish/guestfish-actions.pod:2427
8887 #: ../fish/guestfish-actions.pod:2429
8895 #: ../fish/guestfish-actions.pod:2431 ../src/guestfs-actions.pod:3578
8897 "This returns true iff this handle is busy processing a command (in the "
8902 #: ../fish/guestfish-actions.pod:2436
8907 #: ../fish/guestfish-actions.pod:2438
8910 " is-chardev path\n"
8915 #: ../fish/guestfish-actions.pod:2440 ../src/guestfs-actions.pod:3593
8917 "This returns C<true> if and only if there is a character device with the "
8918 "given C<path> name."
8922 #: ../fish/guestfish-actions.pod:2445
8927 #: ../fish/guestfish-actions.pod:2447
8935 #: ../fish/guestfish-actions.pod:2449 ../src/guestfs-actions.pod:3607
8937 "This returns true iff this handle is being configured (in the C<CONFIG> "
8942 #: ../fish/guestfish-actions.pod:2454
8947 #: ../fish/guestfish-actions.pod:2456
8955 #: ../fish/guestfish-actions.pod:2458 ../src/guestfs-actions.pod:3622
8957 "This returns C<true> if and only if there is a directory with the given "
8958 "C<path> name. Note that it returns false for other objects like files."
8962 #: ../fish/guestfish-actions.pod:2464
8967 #: ../fish/guestfish-actions.pod:2466
8975 #: ../fish/guestfish-actions.pod:2468 ../src/guestfs-actions.pod:3638
8977 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
8978 "given C<path> name."
8982 #: ../fish/guestfish-actions.pod:2473
8987 #: ../fish/guestfish-actions.pod:2475
8995 #: ../fish/guestfish-actions.pod:2477 ../src/guestfs-actions.pod:3653
8997 "This returns C<true> if and only if there is a regular file with the given "
8998 "C<path> name. Note that it returns false for other objects like "
9003 #: ../fish/guestfish-actions.pod:2483
9004 msgid "is-launching"
9008 #: ../fish/guestfish-actions.pod:2485
9016 #: ../fish/guestfish-actions.pod:2487 ../src/guestfs-actions.pod:3668
9018 "This returns true iff this handle is launching the subprocess (in the "
9019 "C<LAUNCHING> state)."
9023 #: ../fish/guestfish-actions.pod:2492
9028 #: ../fish/guestfish-actions.pod:2494
9036 #: ../fish/guestfish-actions.pod:2496 ../src/guestfs-actions.pod:3683
9038 "This command tests whether C<device> is a logical volume, and returns true "
9039 "iff this is the case."
9043 #: ../fish/guestfish-actions.pod:2499
9048 #: ../fish/guestfish-actions.pod:2501
9056 #: ../fish/guestfish-actions.pod:2503 ../src/guestfs-actions.pod:3695
9058 "This returns true iff this handle is ready to accept commands (in the "
9063 #: ../fish/guestfish-actions.pod:2508
9068 #: ../fish/guestfish-actions.pod:2510
9076 #: ../fish/guestfish-actions.pod:2512 ../src/guestfs-actions.pod:3710
9078 "This returns C<true> if and only if there is a Unix domain socket with the "
9079 "given C<path> name."
9083 #: ../fish/guestfish-actions.pod:2517
9088 #: ../fish/guestfish-actions.pod:2519
9091 " is-symlink path\n"
9096 #: ../fish/guestfish-actions.pod:2521 ../src/guestfs-actions.pod:3725
9098 "This returns C<true> if and only if there is a symbolic link with the given "
9103 #: ../fish/guestfish-actions.pod:2526
9108 #: ../fish/guestfish-actions.pod:2528
9116 #: ../fish/guestfish-actions.pod:2530 ../src/guestfs-actions.pod:3740
9118 "This returns true iff the file exists and the file is empty or it contains "
9123 #: ../fish/guestfish-actions.pod:2533
9124 msgid "is-zero-device"
9128 #: ../fish/guestfish-actions.pod:2535
9131 " is-zero-device device\n"
9136 #: ../fish/guestfish-actions.pod:2537 ../src/guestfs-actions.pod:3753
9137 msgid "This returns true iff the device exists and contains all zero bytes."
9141 #: ../fish/guestfish-actions.pod:2539 ../src/guestfs-actions.pod:3755
9142 msgid "Note that for large devices this can take a long time to run."
9146 #: ../fish/guestfish-actions.pod:2541
9147 msgid "kill-subprocess"
9151 #: ../fish/guestfish-actions.pod:2543
9154 " kill-subprocess\n"
9159 #: ../fish/guestfish-actions.pod:2545 ../src/guestfs-actions.pod:3766
9160 msgid "This kills the qemu subprocess. You should never need to call this."
9164 #: ../fish/guestfish-actions.pod:2547
9169 #: ../fish/guestfish-actions.pod:2549
9174 #: ../fish/guestfish-actions.pod:2551
9182 #: ../fish/guestfish-actions.pod:2553 ../src/guestfs-actions.pod:3777
9184 "Internally libguestfs is implemented by running a virtual machine using "
9189 #: ../fish/guestfish-actions.pod:2556 ../src/guestfs-actions.pod:3780
9191 "You should call this after configuring the handle (eg. adding drives) but "
9192 "before performing any actions."
9196 #: ../fish/guestfish-actions.pod:2559
9201 #: ../fish/guestfish-actions.pod:2561
9204 " lchown owner group path\n"
9209 #: ../fish/guestfish-actions.pod:2563
9211 "Change the file owner to C<owner> and group to C<group>. This is like "
9212 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
9217 #: ../fish/guestfish-actions.pod:2571
9222 #: ../fish/guestfish-actions.pod:2573
9225 " lgetxattr path name\n"
9230 #: ../fish/guestfish-actions.pod:2575 ../src/guestfs-actions.pod:3820
9232 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
9233 "is a symlink, then this call returns an extended attribute from the symlink."
9237 #: ../fish/guestfish-actions.pod:2589
9238 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
9242 #: ../fish/guestfish-actions.pod:2591
9247 #: ../fish/guestfish-actions.pod:2593
9250 " lgetxattrs path\n"
9255 #: ../fish/guestfish-actions.pod:2595
9257 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
9258 "it returns the extended attributes of the link itself."
9262 #: ../fish/guestfish-actions.pod:2599
9267 #: ../fish/guestfish-actions.pod:2601
9275 #: ../fish/guestfish-actions.pod:2603 ../src/guestfs-actions.pod:3863
9277 "List all 9p filesystems attached to the guest. A list of mount tags is "
9282 #: ../fish/guestfish-actions.pod:2606
9283 msgid "list-devices"
9287 #: ../fish/guestfish-actions.pod:2608
9295 #: ../fish/guestfish-actions.pod:2610 ../src/guestfs-actions.pod:3877
9296 msgid "List all the block devices."
9300 #: ../fish/guestfish-actions.pod:2612 ../src/guestfs-actions.pod:3879
9301 msgid "The full block device names are returned, eg. C</dev/sda>."
9305 #: ../fish/guestfish-actions.pod:2616
9306 msgid "list-dm-devices"
9310 #: ../fish/guestfish-actions.pod:2618
9313 " list-dm-devices\n"
9318 #: ../fish/guestfish-actions.pod:2620 ../src/guestfs-actions.pod:3894
9319 msgid "List all device mapper devices."
9323 #: ../fish/guestfish-actions.pod:2622
9325 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
9326 "previous call to L</luks-open>."
9330 #: ../fish/guestfish-actions.pod:2625
9332 "Device mapper devices which correspond to logical volumes are I<not> "
9333 "returned in this list. Call L</lvs> if you want to list logical volumes."
9337 #: ../fish/guestfish-actions.pod:2629
9338 msgid "list-filesystems"
9342 #: ../fish/guestfish-actions.pod:2631
9345 " list-filesystems\n"
9350 #: ../fish/guestfish-actions.pod:2633 ../src/guestfs-actions.pod:3914
9352 "This inspection command looks for filesystems on partitions, block devices "
9353 "and logical volumes, returning a list of devices containing filesystems and "
9358 #: ../fish/guestfish-actions.pod:2637 ../src/guestfs-actions.pod:3918
9360 "The return value is a hash, where the keys are the devices containing "
9361 "filesystems, and the values are the filesystem types. For example:"
9365 #: ../fish/guestfish-actions.pod:2641 ../src/guestfs-actions.pod:3922
9368 " \"/dev/sda1\" => \"ntfs\"\n"
9369 " \"/dev/sda2\" => \"ext2\"\n"
9370 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9371 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9376 #: ../fish/guestfish-actions.pod:2646 ../src/guestfs-actions.pod:3927
9378 "The value can have the special value \"unknown\", meaning the content of the "
9379 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9383 #: ../fish/guestfish-actions.pod:2650
9385 "This command runs other libguestfs commands, which might include L</mount> "
9386 "and L</umount>, and therefore you should use this soon after launch and only "
9387 "when nothing is mounted."
9391 #: ../fish/guestfish-actions.pod:2654
9393 "Not all of the filesystems returned will be mountable. In particular, swap "
9394 "partitions are returned in the list. Also this command does not check that "
9395 "each filesystem found is valid and mountable, and some filesystems might be "
9396 "mountable but require special options. Filesystems may not all belong to a "
9397 "single logical operating system (use L</inspect-os> to look for OSes)."
9401 #: ../fish/guestfish-actions.pod:2662
9402 msgid "list-partitions"
9406 #: ../fish/guestfish-actions.pod:2664
9409 " list-partitions\n"
9414 #: ../fish/guestfish-actions.pod:2666 ../src/guestfs-actions.pod:3956
9415 msgid "List all the partitions detected on all block devices."
9419 #: ../fish/guestfish-actions.pod:2668 ../src/guestfs-actions.pod:3958
9420 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9424 #: ../fish/guestfish-actions.pod:2670
9426 "This does not return logical volumes. For that you will need to call "
9431 #: ../fish/guestfish-actions.pod:2675
9436 #: ../fish/guestfish-actions.pod:2677
9444 #: ../fish/guestfish-actions.pod:2679 ../src/guestfs-actions.pod:3977
9446 "List the files in C<directory> (relative to the root directory, there is no "
9447 "cwd) in the format of 'ls -la'."
9451 #: ../fish/guestfish-actions.pod:2682 ../src/guestfs-actions.pod:3980
9453 "This command is mostly useful for interactive sessions. It is I<not> "
9454 "intended that you try to parse the output string."
9458 #: ../fish/guestfish-actions.pod:2685
9463 #: ../fish/guestfish-actions.pod:2687
9466 " ln target linkname\n"
9471 #: ../fish/guestfish-actions.pod:2689 ../src/guestfs-actions.pod:3995
9472 msgid "This command creates a hard link using the C<ln> command."
9476 #: ../fish/guestfish-actions.pod:2691
9481 #: ../fish/guestfish-actions.pod:2693
9484 " ln-f target linkname\n"
9489 #: ../fish/guestfish-actions.pod:2695 ../src/guestfs-actions.pod:4008
9491 "This command creates a hard link using the C<ln -f> command. The I<-f> "
9492 "option removes the link (C<linkname>) if it exists already."
9496 #: ../fish/guestfish-actions.pod:2698
9501 #: ../fish/guestfish-actions.pod:2700
9504 " ln-s target linkname\n"
9509 #: ../fish/guestfish-actions.pod:2702 ../src/guestfs-actions.pod:4022
9510 msgid "This command creates a symbolic link using the C<ln -s> command."
9514 #: ../fish/guestfish-actions.pod:2704
9519 #: ../fish/guestfish-actions.pod:2706
9522 " ln-sf target linkname\n"
9527 #: ../fish/guestfish-actions.pod:2708 ../src/guestfs-actions.pod:4035
9529 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
9530 "option removes the link (C<linkname>) if it exists already."
9534 #: ../fish/guestfish-actions.pod:2711
9535 msgid "lremovexattr"
9539 #: ../fish/guestfish-actions.pod:2713
9542 " lremovexattr xattr path\n"
9547 #: ../fish/guestfish-actions.pod:2715
9549 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
9550 "it removes an extended attribute of the link itself."
9554 #: ../fish/guestfish-actions.pod:2719
9559 #: ../fish/guestfish-actions.pod:2721
9567 #: ../fish/guestfish-actions.pod:2723 ../src/guestfs-actions.pod:4063
9569 "List the files in C<directory> (relative to the root directory, there is no "
9570 "cwd). The '.' and '..' entries are not returned, but hidden files are "
9575 #: ../fish/guestfish-actions.pod:2727
9577 "This command is mostly useful for interactive sessions. Programs should "
9578 "probably use L</readdir> instead."
9582 #: ../fish/guestfish-actions.pod:2730
9587 #: ../fish/guestfish-actions.pod:2732
9590 " lsetxattr xattr val vallen path\n"
9595 #: ../fish/guestfish-actions.pod:2734
9597 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
9598 "sets an extended attribute of the link itself."
9602 #: ../fish/guestfish-actions.pod:2738
9607 #: ../fish/guestfish-actions.pod:2740
9615 #: ../fish/guestfish-actions.pod:2742 ../fish/guestfish-actions.pod:4552 ../src/guestfs-actions.pod:4099 ../src/guestfs-actions.pod:6882
9616 msgid "Returns file information for the given C<path>."
9620 #: ../fish/guestfish-actions.pod:2744
9622 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
9623 "the link is stat-ed, not the file it refers to."
9627 #: ../fish/guestfish-actions.pod:2748 ../src/guestfs-actions.pod:4105
9628 msgid "This is the same as the C<lstat(2)> system call."
9632 #: ../fish/guestfish-actions.pod:2750
9637 #: ../fish/guestfish-actions.pod:2752
9640 " lstatlist path 'names ...'\n"
9645 #: ../fish/guestfish-actions.pod:2754
9647 "This call allows you to perform the L</lstat> operation on multiple files, "
9648 "where all files are in the directory C<path>. C<names> is the list of files "
9649 "from this directory."
9653 #: ../fish/guestfish-actions.pod:2758 ../src/guestfs-actions.pod:4124
9655 "On return you get a list of stat structs, with a one-to-one correspondence "
9656 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9657 "then the C<ino> field of that structure is set to C<-1>."
9661 #: ../fish/guestfish-actions.pod:2763
9663 "This call is intended for programs that want to efficiently list a directory "
9664 "contents without making many round-trips. See also L</lxattrlist> for a "
9665 "similarly efficient call for getting extended attributes. Very long "
9666 "directory listings might cause the protocol message size to be exceeded, "
9667 "causing this call to fail. The caller must split up such requests into "
9668 "smaller groups of names."
9672 #: ../fish/guestfish-actions.pod:2771
9673 msgid "luks-add-key"
9677 #: ../fish/guestfish-actions.pod:2773
9680 " luks-add-key device keyslot\n"
9685 #: ../fish/guestfish-actions.pod:2775 ../src/guestfs-actions.pod:4152
9687 "This command adds a new key on LUKS device C<device>. C<key> is any "
9688 "existing key, and is used to access the device. C<newkey> is the new key to "
9689 "add. C<keyslot> is the key slot that will be replaced."
9693 #: ../fish/guestfish-actions.pod:2780
9695 "Note that if C<keyslot> already contains a key, then this command will "
9696 "fail. You have to use L</luks-kill-slot> first to remove that key."
9700 #: ../fish/guestfish-actions.pod:2784 ../fish/guestfish-actions.pod:2806 ../fish/guestfish-actions.pod:2819 ../fish/guestfish-actions.pod:2833 ../fish/guestfish-actions.pod:2859 ../fish/guestfish-actions.pod:2869
9702 "This command has one or more key or passphrase parameters. Guestfish will "
9703 "prompt for these separately."
9707 #: ../fish/guestfish-actions.pod:2787
9712 #: ../fish/guestfish-actions.pod:2789
9715 " luks-close device\n"
9720 #: ../fish/guestfish-actions.pod:2791
9722 "This closes a LUKS device that was created earlier by L</luks-open> or "
9723 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
9724 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
9725 "underlying block device."
9729 #: ../fish/guestfish-actions.pod:2797
9734 #: ../fish/guestfish-actions.pod:2799
9737 " luks-format device keyslot\n"
9742 #: ../fish/guestfish-actions.pod:2801 ../src/guestfs-actions.pod:4193
9744 "This command erases existing data on C<device> and formats the device as a "
9745 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9746 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9750 #: ../fish/guestfish-actions.pod:2809 ../fish/guestfish-actions.pod:2822 ../fish/guestfish-actions.pod:2909 ../fish/guestfish-actions.pod:3560 ../fish/guestfish-actions.pod:4086 ../fish/guestfish-actions.pod:4423 ../fish/guestfish-actions.pod:4446 ../fish/guestfish-actions.pod:4468 ../fish/guestfish-actions.pod:5214 ../src/guestfs-actions.pod:4200 ../src/guestfs-actions.pod:4223 ../src/guestfs-actions.pod:4366 ../src/guestfs-actions.pod:5459 ../src/guestfs-actions.pod:6247 ../src/guestfs-actions.pod:6696 ../src/guestfs-actions.pod:6726 ../src/guestfs-actions.pod:6759 ../src/guestfs-actions.pod:7958
9752 "B<This command is dangerous. Without careful use you can easily destroy all "
9757 #: ../fish/guestfish-actions.pod:2812
9758 msgid "luks-format-cipher"
9762 #: ../fish/guestfish-actions.pod:2814
9765 " luks-format-cipher device keyslot cipher\n"
9770 #: ../fish/guestfish-actions.pod:2816
9772 "This command is the same as L</luks-format> but it also allows you to set "
9773 "the C<cipher> used."
9777 #: ../fish/guestfish-actions.pod:2825
9778 msgid "luks-kill-slot"
9782 #: ../fish/guestfish-actions.pod:2827
9785 " luks-kill-slot device keyslot\n"
9790 #: ../fish/guestfish-actions.pod:2829 ../src/guestfs-actions.pod:4240
9792 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
9793 "device C<device>. C<key> must be one of the I<other> keys."
9797 #: ../fish/guestfish-actions.pod:2836
9802 #: ../fish/guestfish-actions.pod:2838
9805 " luks-open device mapname\n"
9810 #: ../fish/guestfish-actions.pod:2840 ../src/guestfs-actions.pod:4260
9812 "This command opens a block device which has been encrypted according to the "
9813 "Linux Unified Key Setup (LUKS) standard."
9817 #: ../fish/guestfish-actions.pod:2843 ../src/guestfs-actions.pod:4263
9818 msgid "C<device> is the encrypted block device or partition."
9822 #: ../fish/guestfish-actions.pod:2845 ../src/guestfs-actions.pod:4265
9824 "The caller must supply one of the keys associated with the LUKS block "
9825 "device, in the C<key> parameter."
9829 #: ../fish/guestfish-actions.pod:2848 ../src/guestfs-actions.pod:4268
9831 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
9832 "writes to this block device are decrypted from and encrypted to the "
9833 "underlying C<device> respectively."
9837 #: ../fish/guestfish-actions.pod:2852
9839 "If this block device contains LVM volume groups, then calling L</vgscan> "
9840 "followed by L</vg-activate-all> will make them visible."
9844 #: ../fish/guestfish-actions.pod:2856
9845 msgid "Use L</list-dm-devices> to list all device mapper devices."
9849 #: ../fish/guestfish-actions.pod:2862
9850 msgid "luks-open-ro"
9854 #: ../fish/guestfish-actions.pod:2864
9857 " luks-open-ro device mapname\n"
9862 #: ../fish/guestfish-actions.pod:2866
9864 "This is the same as L</luks-open> except that a read-only mapping is "
9869 #: ../fish/guestfish-actions.pod:2872
9874 #: ../fish/guestfish-actions.pod:2874
9877 " lvcreate logvol volgroup mbytes\n"
9882 #: ../fish/guestfish-actions.pod:2876 ../src/guestfs-actions.pod:4314
9884 "This creates an LVM logical volume called C<logvol> on the volume group "
9885 "C<volgroup>, with C<size> megabytes."
9889 #: ../fish/guestfish-actions.pod:2879
9890 msgid "lvm-canonical-lv-name"
9894 #: ../fish/guestfish-actions.pod:2881
9897 " lvm-canonical-lv-name lvname\n"
9902 #: ../fish/guestfish-actions.pod:2883 ../src/guestfs-actions.pod:4327
9904 "This converts alternative naming schemes for LVs that you might find to the "
9905 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
9910 #: ../fish/guestfish-actions.pod:2887 ../src/guestfs-actions.pod:4331
9912 "This command returns an error if the C<lvname> parameter does not refer to a "
9917 #: ../fish/guestfish-actions.pod:2890
9918 msgid "See also L</is-lv>."
9922 #: ../fish/guestfish-actions.pod:2892
9923 msgid "lvm-clear-filter"
9927 #: ../fish/guestfish-actions.pod:2894
9930 " lvm-clear-filter\n"
9935 #: ../fish/guestfish-actions.pod:2896
9937 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
9942 #: ../fish/guestfish-actions.pod:2899 ../fish/guestfish-actions.pod:2930 ../src/guestfs-actions.pod:4349 ../src/guestfs-actions.pod:4391
9943 msgid "This command also clears the LVM cache and performs a volume group scan."
9947 #: ../fish/guestfish-actions.pod:2902
9948 msgid "lvm-remove-all"
9952 #: ../fish/guestfish-actions.pod:2904
9960 #: ../fish/guestfish-actions.pod:2906 ../src/guestfs-actions.pod:4361
9962 "This command removes all LVM logical volumes, volume groups and physical "
9967 #: ../fish/guestfish-actions.pod:2912
9968 msgid "lvm-set-filter"
9972 #: ../fish/guestfish-actions.pod:2914
9975 " lvm-set-filter 'devices ...'\n"
9980 #: ../fish/guestfish-actions.pod:2916 ../src/guestfs-actions.pod:4377
9982 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
9983 "block devices in the list C<devices>, and will ignore all other attached "
9988 #: ../fish/guestfish-actions.pod:2920 ../src/guestfs-actions.pod:4381
9990 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
9991 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
9992 "there are two types of duplication possible: either cloned PVs/VGs which "
9993 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
9994 "same name. In normal operation you cannot create this situation, but you "
9995 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
9996 "inside the LVM metadata."
10000 #: ../fish/guestfish-actions.pod:2933 ../src/guestfs-actions.pod:4394
10001 msgid "You can filter whole block devices or individual partitions."
10005 #: ../fish/guestfish-actions.pod:2935 ../src/guestfs-actions.pod:4396
10007 "You cannot use this if any VG is currently in use (eg. contains a mounted "
10008 "filesystem), even if you are not filtering out that VG."
10012 #: ../fish/guestfish-actions.pod:2939
10017 #: ../fish/guestfish-actions.pod:2941
10020 " lvremove device\n"
10025 #: ../fish/guestfish-actions.pod:2943 ../src/guestfs-actions.pod:4410
10027 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
10028 "LV, such as C</dev/VG/LV>."
10032 #: ../fish/guestfish-actions.pod:2946 ../src/guestfs-actions.pod:4413
10034 "You can also remove all LVs in a volume group by specifying the VG name, "
10039 #: ../fish/guestfish-actions.pod:2949
10044 #: ../fish/guestfish-actions.pod:2951
10047 " lvrename logvol newlogvol\n"
10052 #: ../fish/guestfish-actions.pod:2953 ../src/guestfs-actions.pod:4427
10053 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
10057 #: ../fish/guestfish-actions.pod:2955
10062 #: ../fish/guestfish-actions.pod:2957
10065 " lvresize device mbytes\n"
10070 #: ../fish/guestfish-actions.pod:2959 ../src/guestfs-actions.pod:4440
10072 "This resizes (expands or shrinks) an existing LVM logical volume to "
10073 "C<mbytes>. When reducing, data in the reduced part is lost."
10077 #: ../fish/guestfish-actions.pod:2963
10078 msgid "lvresize-free"
10082 #: ../fish/guestfish-actions.pod:2965
10085 " lvresize-free lv percent\n"
10090 #: ../fish/guestfish-actions.pod:2967 ../src/guestfs-actions.pod:4455
10092 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
10093 "remaining free space in the volume group. Commonly you would call this with "
10094 "pc = 100 which expands the logical volume as much as possible, using all "
10095 "remaining free space in the volume group."
10099 #: ../fish/guestfish-actions.pod:2973
10104 #: ../fish/guestfish-actions.pod:2975
10112 #: ../fish/guestfish-actions.pod:2977 ../src/guestfs-actions.pod:4470
10114 "List all the logical volumes detected. This is the equivalent of the "
10115 "L<lvs(8)> command."
10119 #: ../fish/guestfish-actions.pod:2980 ../src/guestfs-actions.pod:4473
10121 "This returns a list of the logical volume device names "
10122 "(eg. C</dev/VolGroup00/LogVol00>)."
10126 #: ../fish/guestfish-actions.pod:2983
10127 msgid "See also L</lvs-full>, L</list-filesystems>."
10131 #: ../fish/guestfish-actions.pod:2985
10136 #: ../fish/guestfish-actions.pod:2987
10144 #: ../fish/guestfish-actions.pod:2989 ../src/guestfs-actions.pod:4489
10146 "List all the logical volumes detected. This is the equivalent of the "
10147 "L<lvs(8)> command. The \"full\" version includes all fields."
10151 #: ../fish/guestfish-actions.pod:2992
10156 #: ../fish/guestfish-actions.pod:2994
10164 #: ../fish/guestfish-actions.pod:2996 ../src/guestfs-actions.pod:4504
10165 msgid "This command returns the UUID of the LVM LV C<device>."
10169 #: ../fish/guestfish-actions.pod:2998
10174 #: ../fish/guestfish-actions.pod:3000
10177 " lxattrlist path 'names ...'\n"
10182 #: ../fish/guestfish-actions.pod:3002 ../src/guestfs-actions.pod:4518
10184 "This call allows you to get the extended attributes of multiple files, where "
10185 "all files are in the directory C<path>. C<names> is the list of files from "
10190 #: ../fish/guestfish-actions.pod:3006 ../src/guestfs-actions.pod:4522
10192 "On return you get a flat list of xattr structs which must be interpreted "
10193 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
10194 "C<attrval> in this struct is zero-length to indicate there was an error "
10195 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
10196 "number (the number of following attributes for this file, which could be "
10197 "C<\"0\">). Then after the first xattr struct are the zero or more "
10198 "attributes for the first named file. This repeats for the second and "
10199 "subsequent files."
10203 #: ../fish/guestfish-actions.pod:3016
10205 "This call is intended for programs that want to efficiently list a directory "
10206 "contents without making many round-trips. See also L</lstatlist> for a "
10207 "similarly efficient call for getting standard stats. Very long directory "
10208 "listings might cause the protocol message size to be exceeded, causing this "
10209 "call to fail. The caller must split up such requests into smaller groups of "
10214 #: ../fish/guestfish-actions.pod:3024
10219 #: ../fish/guestfish-actions.pod:3026
10227 #: ../fish/guestfish-actions.pod:3028 ../src/guestfs-actions.pod:4552
10228 msgid "Create a directory named C<path>."
10232 #: ../fish/guestfish-actions.pod:3030
10237 #: ../fish/guestfish-actions.pod:3032
10240 " mkdir-mode path mode\n"
10245 #: ../fish/guestfish-actions.pod:3034 ../src/guestfs-actions.pod:4565
10247 "This command creates a directory, setting the initial permissions of the "
10248 "directory to C<mode>."
10252 #: ../fish/guestfish-actions.pod:3037 ../src/guestfs-actions.pod:4568
10254 "For common Linux filesystems, the actual mode which is set will be C<mode & "
10255 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
10260 #: ../fish/guestfish-actions.pod:3041
10261 msgid "See also L</mkdir>, L</umask>"
10265 #: ../fish/guestfish-actions.pod:3043
10270 #: ../fish/guestfish-actions.pod:3045
10278 #: ../fish/guestfish-actions.pod:3047 ../src/guestfs-actions.pod:4584
10280 "Create a directory named C<path>, creating any parent directories as "
10281 "necessary. This is like the C<mkdir -p> shell command."
10285 #: ../fish/guestfish-actions.pod:3050
10290 #: ../fish/guestfish-actions.pod:3052
10293 " mkdtemp template\n"
10298 #: ../fish/guestfish-actions.pod:3054 ../src/guestfs-actions.pod:4597
10300 "This command creates a temporary directory. The C<template> parameter "
10301 "should be a full pathname for the temporary directory name with the final "
10302 "six characters being \"XXXXXX\"."
10306 #: ../fish/guestfish-actions.pod:3059 ../src/guestfs-actions.pod:4602
10308 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10309 "being suitable for Windows filesystems."
10313 #: ../fish/guestfish-actions.pod:3062 ../src/guestfs-actions.pod:4605
10314 msgid "The name of the temporary directory that was created is returned."
10318 #: ../fish/guestfish-actions.pod:3065 ../src/guestfs-actions.pod:4608
10319 msgid "The temporary directory is created with mode 0700 and is owned by root."
10323 #: ../fish/guestfish-actions.pod:3068 ../src/guestfs-actions.pod:4611
10325 "The caller is responsible for deleting the temporary directory and its "
10326 "contents after use."
10330 #: ../fish/guestfish-actions.pod:3071 ../src/guestfs-actions.pod:4614
10331 msgid "See also: L<mkdtemp(3)>"
10335 #: ../fish/guestfish-actions.pod:3073
10340 #: ../fish/guestfish-actions.pod:3075
10343 " mke2fs-J fstype blocksize device journal\n"
10348 #: ../fish/guestfish-actions.pod:3077 ../src/guestfs-actions.pod:4630
10350 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10351 "C<journal>. It is equivalent to the command:"
10355 #: ../fish/guestfish-actions.pod:3081 ../src/guestfs-actions.pod:4634
10358 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10363 #: ../fish/guestfish-actions.pod:3083
10364 msgid "See also L</mke2journal>."
10368 #: ../fish/guestfish-actions.pod:3085
10373 #: ../fish/guestfish-actions.pod:3087
10376 " mke2fs-JL fstype blocksize device label\n"
10381 #: ../fish/guestfish-actions.pod:3089 ../src/guestfs-actions.pod:4651
10383 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10384 "the journal labeled C<label>."
10388 #: ../fish/guestfish-actions.pod:3092
10389 msgid "See also L</mke2journal-L>."
10393 #: ../fish/guestfish-actions.pod:3094
10398 #: ../fish/guestfish-actions.pod:3096
10401 " mke2fs-JU fstype blocksize device uuid\n"
10406 #: ../fish/guestfish-actions.pod:3098 ../src/guestfs-actions.pod:4669
10408 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10409 "the journal with UUID C<uuid>."
10413 #: ../fish/guestfish-actions.pod:3101
10414 msgid "See also L</mke2journal-U>."
10418 #: ../fish/guestfish-actions.pod:3103
10419 msgid "mke2journal"
10423 #: ../fish/guestfish-actions.pod:3105
10426 " mke2journal blocksize device\n"
10431 #: ../fish/guestfish-actions.pod:3107 ../src/guestfs-actions.pod:4685
10433 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10438 #: ../fish/guestfish-actions.pod:3110 ../src/guestfs-actions.pod:4688
10441 " mke2fs -O journal_dev -b blocksize device\n"
10446 #: ../fish/guestfish-actions.pod:3112
10447 msgid "mke2journal-L"
10451 #: ../fish/guestfish-actions.pod:3114
10454 " mke2journal-L blocksize label device\n"
10459 #: ../fish/guestfish-actions.pod:3116 ../src/guestfs-actions.pod:4702
10460 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10464 #: ../fish/guestfish-actions.pod:3118
10465 msgid "mke2journal-U"
10469 #: ../fish/guestfish-actions.pod:3120
10472 " mke2journal-U blocksize uuid device\n"
10477 #: ../fish/guestfish-actions.pod:3122 ../src/guestfs-actions.pod:4716
10478 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10482 #: ../fish/guestfish-actions.pod:3124
10487 #: ../fish/guestfish-actions.pod:3126
10490 " mkfifo mode path\n"
10495 #: ../fish/guestfish-actions.pod:3128
10497 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10498 "is just a convenient wrapper around L</mknod>."
10502 #: ../fish/guestfish-actions.pod:3134
10507 #: ../fish/guestfish-actions.pod:3136
10510 " mkfs fstype device\n"
10515 #: ../fish/guestfish-actions.pod:3138 ../src/guestfs-actions.pod:4746
10517 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10518 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10522 #: ../fish/guestfish-actions.pod:3142
10527 #: ../fish/guestfish-actions.pod:3144
10530 " mkfs-b fstype blocksize device\n"
10535 #: ../fish/guestfish-actions.pod:3146
10537 "This call is similar to L</mkfs>, but it allows you to control the block "
10538 "size of the resulting filesystem. Supported block sizes depend on the "
10539 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10543 #: ../fish/guestfish-actions.pod:3151 ../fish/guestfish-actions.pod:3178 ../src/guestfs-actions.pod:4774 ../src/guestfs-actions.pod:4812
10545 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10550 #: ../fish/guestfish-actions.pod:3154
10552 "I<This function is deprecated.> In new code, use the L</mkfs_opts> call "
10557 #: ../fish/guestfish-actions.pod:3161
10562 #: ../fish/guestfish-actions.pod:3163
10565 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] "
10566 "[sectorsize:..]\n"
10571 #: ../fish/guestfish-actions.pod:3165 ../src/guestfs-actions.pod:4799
10573 "This function creates a filesystem on C<device>. The filesystem type is "
10574 "C<fstype>, for example C<ext3>."
10578 #: ../fish/guestfish-actions.pod:3172 ../src/guestfs-actions.pod:4806
10579 msgid "C<blocksize>"
10583 #: ../fish/guestfish-actions.pod:3174 ../src/guestfs-actions.pod:4808
10585 "The filesystem block size. Supported block sizes depend on the filesystem "
10586 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
10591 #: ../fish/guestfish-actions.pod:3181 ../src/guestfs-actions.pod:4815
10592 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
10596 #: ../fish/guestfish-actions.pod:3183 ../src/guestfs-actions.pod:4817
10597 msgid "C<features>"
10601 #: ../fish/guestfish-actions.pod:3185 ../src/guestfs-actions.pod:4819
10602 msgid "This passes the I<-O> parameter to the external mkfs program."
10606 #: ../fish/guestfish-actions.pod:3187 ../src/guestfs-actions.pod:4821
10608 "For certain filesystem types, this allows extra filesystem features to be "
10609 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
10613 #: ../fish/guestfish-actions.pod:3191 ../src/guestfs-actions.pod:4825
10615 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
10620 #: ../fish/guestfish-actions.pod:3194 ../src/guestfs-actions.pod:4828
10625 #: ../fish/guestfish-actions.pod:3196 ../src/guestfs-actions.pod:4830
10627 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
10628 "sets the inode size (only for ext2/3/4 filesystems at present)."
10632 #: ../fish/guestfish-actions.pod:3199 ../src/guestfs-actions.pod:4833
10633 msgid "C<sectorsize>"
10637 #: ../fish/guestfish-actions.pod:3201 ../src/guestfs-actions.pod:4835
10639 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
10640 "sets sector size for ufs filesystem."
10644 #: ../fish/guestfish-actions.pod:3208
10645 msgid "mkmountpoint"
10649 #: ../fish/guestfish-actions.pod:3210
10652 " mkmountpoint exemptpath\n"
10657 #: ../fish/guestfish-actions.pod:3212
10659 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
10660 "to create extra mountpoints before mounting the first filesystem."
10664 #: ../fish/guestfish-actions.pod:3216 ../src/guestfs-actions.pod:4878
10666 "These calls are I<only> necessary in some very limited circumstances, mainly "
10667 "the case where you want to mount a mix of unrelated and/or read-only "
10668 "filesystems together."
10672 #: ../fish/guestfish-actions.pod:3220 ../src/guestfs-actions.pod:4882
10674 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10675 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10676 "inside that. You can unpack this as follows in guestfish:"
10680 #: ../fish/guestfish-actions.pod:3225 ../src/guestfs-actions.pod:4887
10683 " add-ro Fedora-11-i686-Live.iso\n"
10685 " mkmountpoint /cd\n"
10686 " mkmountpoint /sqsh\n"
10687 " mkmountpoint /ext3fs\n"
10688 " mount /dev/sda /cd\n"
10689 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10690 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10695 #: ../fish/guestfish-actions.pod:3234 ../src/guestfs-actions.pod:4896
10696 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10700 #: ../fish/guestfish-actions.pod:3236
10702 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
10703 "unexpected errors if you try to mix these calls. It is safest to manually "
10704 "unmount filesystems and remove mountpoints after use."
10708 #: ../fish/guestfish-actions.pod:3240
10710 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
10711 "for this to work for manual mountpoints, you must ensure that the innermost "
10712 "mountpoints have the longest pathnames, as in the example code above."
10716 #: ../fish/guestfish-actions.pod:3245 ../src/guestfs-actions.pod:4907
10717 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10721 #: ../fish/guestfish-actions.pod:3247
10723 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
10724 "L</umount-all> to be called when the handle is closed which can also trigger "
10729 #: ../fish/guestfish-actions.pod:3251
10734 #: ../fish/guestfish-actions.pod:3253
10737 " mknod mode devmajor devminor path\n"
10742 #: ../fish/guestfish-actions.pod:3255 ../src/guestfs-actions.pod:4926
10744 "This call creates block or character special devices, or named pipes "
10749 #: ../fish/guestfish-actions.pod:3258 ../src/guestfs-actions.pod:4929
10751 "The C<mode> parameter should be the mode, using the standard constants. "
10752 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10753 "used when creating block and character special devices."
10757 #: ../fish/guestfish-actions.pod:3263
10759 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10760 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10761 "regular file). These constants are available in the standard Linux header "
10762 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
10763 "wrappers around this command which bitwise OR in the appropriate constant "
10768 #: ../fish/guestfish-actions.pod:3273
10773 #: ../fish/guestfish-actions.pod:3275
10776 " mknod-b mode devmajor devminor path\n"
10781 #: ../fish/guestfish-actions.pod:3277
10783 "This call creates a block device node called C<path> with mode C<mode> and "
10784 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10785 "wrapper around L</mknod>."
10789 #: ../fish/guestfish-actions.pod:3283
10794 #: ../fish/guestfish-actions.pod:3285
10797 " mknod-c mode devmajor devminor path\n"
10802 #: ../fish/guestfish-actions.pod:3287
10804 "This call creates a char device node called C<path> with mode C<mode> and "
10805 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10806 "wrapper around L</mknod>."
10810 #: ../fish/guestfish-actions.pod:3293
10815 #: ../fish/guestfish-actions.pod:3295
10823 #: ../fish/guestfish-actions.pod:3297 ../src/guestfs-actions.pod:4992
10824 msgid "Create a swap partition on C<device>."
10828 #: ../fish/guestfish-actions.pod:3299
10833 #: ../fish/guestfish-actions.pod:3301
10836 " mkswap-L label device\n"
10841 #: ../fish/guestfish-actions.pod:3303 ../src/guestfs-actions.pod:5005
10842 msgid "Create a swap partition on C<device> with label C<label>."
10846 #: ../fish/guestfish-actions.pod:3305 ../src/guestfs-actions.pod:5007
10848 "Note that you cannot attach a swap label to a block device "
10849 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
10850 "the kernel or swap tools."
10854 #: ../fish/guestfish-actions.pod:3309
10859 #: ../fish/guestfish-actions.pod:3311
10862 " mkswap-U uuid device\n"
10867 #: ../fish/guestfish-actions.pod:3313 ../src/guestfs-actions.pod:5022
10868 msgid "Create a swap partition on C<device> with UUID C<uuid>."
10872 #: ../fish/guestfish-actions.pod:3315
10873 msgid "mkswap-file"
10877 #: ../fish/guestfish-actions.pod:3317
10880 " mkswap-file path\n"
10885 #: ../fish/guestfish-actions.pod:3319 ../src/guestfs-actions.pod:5034
10886 msgid "Create a swap file."
10890 #: ../fish/guestfish-actions.pod:3321
10892 "This command just writes a swap file signature to an existing file. To "
10893 "create the file itself, use something like L</fallocate>."
10897 #: ../fish/guestfish-actions.pod:3324
10902 #: ../fish/guestfish-actions.pod:3326
10905 " modprobe modulename\n"
10910 #: ../fish/guestfish-actions.pod:3328 ../src/guestfs-actions.pod:5049
10911 msgid "This loads a kernel module in the appliance."
10915 #: ../fish/guestfish-actions.pod:3330 ../src/guestfs-actions.pod:5051
10917 "The kernel module must have been whitelisted when libguestfs was built (see "
10918 "C<appliance/kmod.whitelist.in> in the source)."
10922 #: ../fish/guestfish-actions.pod:3333
10927 #: ../fish/guestfish-actions.pod:3335
10930 " mount device mountpoint\n"
10935 #: ../fish/guestfish-actions.pod:3337 ../src/guestfs-actions.pod:5065
10937 "Mount a guest disk at a position in the filesystem. Block devices are named "
10938 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
10939 "those block devices contain partitions, they will have the usual names "
10940 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
10944 #: ../fish/guestfish-actions.pod:3343 ../src/guestfs-actions.pod:5071
10946 "The rules are the same as for L<mount(2)>: A filesystem must first be "
10947 "mounted on C</> before others can be mounted. Other filesystems can only be "
10948 "mounted on directories which already exist."
10952 #: ../fish/guestfish-actions.pod:3348 ../src/guestfs-actions.pod:5076
10954 "The mounted filesystem is writable, if we have sufficient permissions on the "
10955 "underlying device."
10959 #: ../fish/guestfish-actions.pod:3351
10961 "Before libguestfs 1.13.16, this call implicitly added the options C<sync> "
10962 "and C<noatime>. The C<sync> option greatly slowed writes and caused many "
10963 "problems for users. If your program might need to work with older versions "
10964 "of libguestfs, use L</mount-options> instead (using an empty string for the "
10965 "first parameter if you don't want any options)."
10969 #: ../fish/guestfish-actions.pod:3358
10974 #: ../fish/guestfish-actions.pod:3360
10977 " mount-9p mounttag mountpoint [options:..]\n"
10982 #: ../fish/guestfish-actions.pod:3362 ../src/guestfs-actions.pod:5105
10984 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
10989 #: ../fish/guestfish-actions.pod:3365 ../src/guestfs-actions.pod:5108
10991 "If required, C<trans=virtio> will be automatically added to the options. "
10992 "Any other options required can be passed in the optional C<options> "
10997 #: ../fish/guestfish-actions.pod:3371
11002 #: ../fish/guestfish-actions.pod:3373
11005 " mount-loop file mountpoint\n"
11010 #: ../fish/guestfish-actions.pod:3375 ../src/guestfs-actions.pod:5147
11012 "This command lets you mount C<file> (a filesystem image in a file) on a "
11013 "mount point. It is entirely equivalent to the command C<mount -o loop file "
11018 #: ../fish/guestfish-actions.pod:3379
11019 msgid "mount-options"
11023 #: ../fish/guestfish-actions.pod:3381
11026 " mount-options options device mountpoint\n"
11031 #: ../fish/guestfish-actions.pod:3383
11033 "This is the same as the L</mount> command, but it allows you to set the "
11034 "mount options as for the L<mount(8)> I<-o> flag."
11038 #: ../fish/guestfish-actions.pod:3387 ../src/guestfs-actions.pod:5167
11040 "If the C<options> parameter is an empty string, then no options are passed "
11041 "(all options default to whatever the filesystem uses)."
11045 #: ../fish/guestfish-actions.pod:3391
11050 #: ../fish/guestfish-actions.pod:3393
11053 " mount-ro device mountpoint\n"
11058 #: ../fish/guestfish-actions.pod:3395
11060 "This is the same as the L</mount> command, but it mounts the filesystem with "
11061 "the read-only (I<-o ro>) flag."
11065 #: ../fish/guestfish-actions.pod:3398
11070 #: ../fish/guestfish-actions.pod:3400
11073 " mount-vfs options vfstype device mountpoint\n"
11078 #: ../fish/guestfish-actions.pod:3402
11080 "This is the same as the L</mount> command, but it allows you to set both the "
11081 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
11085 #: ../fish/guestfish-actions.pod:3406
11086 msgid "mountpoints"
11090 #: ../fish/guestfish-actions.pod:3408
11098 #: ../fish/guestfish-actions.pod:3410
11100 "This call is similar to L</mounts>. That call returns a list of devices. "
11101 "This one returns a hash table (map) of device name to directory where the "
11102 "device is mounted."
11106 #: ../fish/guestfish-actions.pod:3414
11111 #: ../fish/guestfish-actions.pod:3416
11119 #: ../fish/guestfish-actions.pod:3418 ../src/guestfs-actions.pod:5228
11121 "This returns the list of currently mounted filesystems. It returns the list "
11122 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
11126 #: ../fish/guestfish-actions.pod:3421 ../src/guestfs-actions.pod:5231
11127 msgid "Some internal mounts are not shown."
11131 #: ../fish/guestfish-actions.pod:3423
11132 msgid "See also: L</mountpoints>"
11136 #: ../fish/guestfish-actions.pod:3425
11141 #: ../fish/guestfish-actions.pod:3427
11149 #: ../fish/guestfish-actions.pod:3429 ../src/guestfs-actions.pod:5248
11151 "This moves a file from C<src> to C<dest> where C<dest> is either a "
11152 "destination filename or destination directory."
11156 #: ../fish/guestfish-actions.pod:3432
11157 msgid "ntfs-3g-probe"
11161 #: ../fish/guestfish-actions.pod:3434
11164 " ntfs-3g-probe true|false device\n"
11169 #: ../fish/guestfish-actions.pod:3436 ../src/guestfs-actions.pod:5262
11171 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
11172 "C<device> for mountability. (Not all NTFS volumes can be mounted "
11173 "read-write, and some cannot be mounted at all)."
11177 #: ../fish/guestfish-actions.pod:3440 ../src/guestfs-actions.pod:5266
11179 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
11180 "can be mounted read-write. Set it to false if you want to test if the "
11181 "volume can be mounted read-only."
11185 #: ../fish/guestfish-actions.pod:3444 ../src/guestfs-actions.pod:5270
11187 "The return value is an integer which C<0> if the operation would succeed, or "
11188 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
11192 #: ../fish/guestfish-actions.pod:3448
11197 #: ../fish/guestfish-actions.pod:3450
11200 " ntfsresize device\n"
11205 #: ../fish/guestfish-actions.pod:3452 ../fish/guestfish-actions.pod:3476 ../src/guestfs-actions.pod:5291 ../src/guestfs-actions.pod:5323
11207 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
11208 "size of the underlying device."
11212 #: ../fish/guestfish-actions.pod:3455 ../src/guestfs-actions.pod:5294
11214 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
11215 "consistency check (for safety). You have to boot into Windows to perform "
11216 "this check and clear this condition. Furthermore, ntfsresize refuses to "
11217 "resize filesystems which have been marked in this way. So in effect it is "
11218 "not possible to call ntfsresize multiple times on a single filesystem "
11219 "without booting into Windows between each resize."
11223 #: ../fish/guestfish-actions.pod:3463 ../fish/guestfish-actions.pod:3502 ../src/guestfs-actions.pod:5302 ../src/guestfs-actions.pod:5349
11224 msgid "See also L<ntfsresize(8)>."
11228 #: ../fish/guestfish-actions.pod:3465 ../fish/guestfish-actions.pod:3513
11230 "I<This function is deprecated.> In new code, use the L</ntfsresize_opts> "
11235 #: ../fish/guestfish-actions.pod:3472
11236 msgid "ntfsresize-opts"
11240 #: ../fish/guestfish-actions.pod:3474
11243 " ntfsresize-opts device [size:..] [force:..]\n"
11248 #: ../fish/guestfish-actions.pod:3485 ../src/guestfs-actions.pod:5332
11250 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
11251 "resized to fit the container (eg. partition)."
11255 #: ../fish/guestfish-actions.pod:3488 ../src/guestfs-actions.pod:5335
11260 #: ../fish/guestfish-actions.pod:3490 ../src/guestfs-actions.pod:5337
11262 "If this option is true, then force the resize of the filesystem even if the "
11263 "filesystem is marked as requiring a consistency check."
11267 #: ../fish/guestfish-actions.pod:3493
11269 "After the resize operation, the filesystem is always marked as requiring a "
11270 "consistency check (for safety). You have to boot into Windows to perform "
11271 "this check and clear this condition. If you I<don't> set the C<force> "
11272 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
11273 "a single filesystem without booting into Windows between each resize."
11277 #: ../fish/guestfish-actions.pod:3506
11278 msgid "ntfsresize-size"
11282 #: ../fish/guestfish-actions.pod:3508
11285 " ntfsresize-size device size\n"
11290 #: ../fish/guestfish-actions.pod:3510
11292 "This command is the same as L</ntfsresize> except that it allows you to "
11293 "specify the new size (in bytes) explicitly."
11297 #: ../fish/guestfish-actions.pod:3520
11302 #: ../fish/guestfish-actions.pod:3522
11305 " part-add device prlogex startsect endsect\n"
11310 #: ../fish/guestfish-actions.pod:3524
11312 "This command adds a partition to C<device>. If there is no partition table "
11313 "on the device, call L</part-init> first."
11317 #: ../fish/guestfish-actions.pod:3527 ../src/guestfs-actions.pod:5410
11319 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11320 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11321 "C<logical>) and C<e> (or C<extended>) partition types."
11325 #: ../fish/guestfish-actions.pod:3532 ../src/guestfs-actions.pod:5415
11327 "C<startsect> and C<endsect> are the start and end of the partition in "
11328 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11329 "from the end of the disk (C<-1> is the last sector)."
11333 #: ../fish/guestfish-actions.pod:3536
11335 "Creating a partition which covers the whole disk is not so easy. Use "
11336 "L</part-disk> to do that."
11340 #: ../fish/guestfish-actions.pod:3539
11345 #: ../fish/guestfish-actions.pod:3541
11348 " part-del device partnum\n"
11353 #: ../fish/guestfish-actions.pod:3543 ../src/guestfs-actions.pod:5433
11354 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11358 #: ../fish/guestfish-actions.pod:3545 ../src/guestfs-actions.pod:5435
11360 "Note that in the case of MBR partitioning, deleting an extended partition "
11361 "also deletes any logical partitions it contains."
11365 #: ../fish/guestfish-actions.pod:3549
11370 #: ../fish/guestfish-actions.pod:3551
11373 " part-disk device parttype\n"
11378 #: ../fish/guestfish-actions.pod:3553
11380 "This command is simply a combination of L</part-init> followed by "
11381 "L</part-add> to create a single primary partition covering the whole disk."
11385 #: ../fish/guestfish-actions.pod:3557
11387 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11388 "possible values are described in L</part-init>."
11392 #: ../fish/guestfish-actions.pod:3563
11393 msgid "part-get-bootable"
11397 #: ../fish/guestfish-actions.pod:3565
11400 " part-get-bootable device partnum\n"
11405 #: ../fish/guestfish-actions.pod:3567 ../src/guestfs-actions.pod:5471
11407 "This command returns true if the partition C<partnum> on C<device> has the "
11408 "bootable flag set."
11412 #: ../fish/guestfish-actions.pod:3570
11413 msgid "See also L</part-set-bootable>."
11417 #: ../fish/guestfish-actions.pod:3572
11418 msgid "part-get-mbr-id"
11422 #: ../fish/guestfish-actions.pod:3574
11425 " part-get-mbr-id device partnum\n"
11430 #: ../fish/guestfish-actions.pod:3576 ../src/guestfs-actions.pod:5487
11432 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11433 "partition C<partnum>."
11437 #: ../fish/guestfish-actions.pod:3579 ../fish/guestfish-actions.pod:3723
11439 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11440 "undefined results for other partition table types (see "
11441 "L</part-get-parttype>)."
11445 #: ../fish/guestfish-actions.pod:3583
11446 msgid "part-get-parttype"
11450 #: ../fish/guestfish-actions.pod:3585
11453 " part-get-parttype device\n"
11458 #: ../fish/guestfish-actions.pod:3587 ../src/guestfs-actions.pod:5504
11460 "This command examines the partition table on C<device> and returns the "
11461 "partition table type (format) being used."
11465 #: ../fish/guestfish-actions.pod:3590
11467 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11468 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11469 "possible, although unusual. See L</part-init> for a full list."
11473 #: ../fish/guestfish-actions.pod:3595
11478 #: ../fish/guestfish-actions.pod:3597
11481 " part-init device parttype\n"
11486 #: ../fish/guestfish-actions.pod:3599 ../src/guestfs-actions.pod:5524
11488 "This creates an empty partition table on C<device> of one of the partition "
11489 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11490 "(for large disks)."
11494 #: ../fish/guestfish-actions.pod:3603
11496 "Initially there are no partitions. Following this, you should call "
11497 "L</part-add> for each partition required."
11501 #: ../fish/guestfish-actions.pod:3606 ../src/guestfs-actions.pod:5531
11502 msgid "Possible values for C<parttype> are:"
11506 #: ../fish/guestfish-actions.pod:3610 ../src/guestfs-actions.pod:5535
11511 #: ../fish/guestfish-actions.pod:3612 ../src/guestfs-actions.pod:5537
11516 #: ../fish/guestfish-actions.pod:3614 ../src/guestfs-actions.pod:5539
11517 msgid "Intel EFI / GPT partition table."
11521 #: ../fish/guestfish-actions.pod:3616 ../src/guestfs-actions.pod:5541
11523 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11524 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11525 "the C<mbr> format."
11529 #: ../fish/guestfish-actions.pod:3620 ../src/guestfs-actions.pod:5545
11534 #: ../fish/guestfish-actions.pod:3622 ../src/guestfs-actions.pod:5547
11539 #: ../fish/guestfish-actions.pod:3624 ../src/guestfs-actions.pod:5549
11541 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11542 "Windows. This partition type will B<only> work for device sizes up to 2 "
11543 "TB. For large disks we recommend using C<gpt>."
11547 #: ../fish/guestfish-actions.pod:3631 ../src/guestfs-actions.pod:5556
11548 msgid "Other partition table types that may work but are not supported include:"
11552 #: ../fish/guestfish-actions.pod:3636 ../src/guestfs-actions.pod:5561
11557 #: ../fish/guestfish-actions.pod:3638 ../src/guestfs-actions.pod:5563
11558 msgid "AIX disk labels."
11562 #: ../fish/guestfish-actions.pod:3640 ../src/guestfs-actions.pod:5565
11567 #: ../fish/guestfish-actions.pod:3642 ../src/guestfs-actions.pod:5567
11572 #: ../fish/guestfish-actions.pod:3644 ../src/guestfs-actions.pod:5569
11573 msgid "Amiga \"Rigid Disk Block\" format."
11577 #: ../fish/guestfish-actions.pod:3646 ../src/guestfs-actions.pod:5571
11582 #: ../fish/guestfish-actions.pod:3648 ../src/guestfs-actions.pod:5573
11583 msgid "BSD disk labels."
11587 #: ../fish/guestfish-actions.pod:3650 ../src/guestfs-actions.pod:5575
11592 #: ../fish/guestfish-actions.pod:3652 ../src/guestfs-actions.pod:5577
11593 msgid "DASD, used on IBM mainframes."
11597 #: ../fish/guestfish-actions.pod:3654 ../src/guestfs-actions.pod:5579
11602 #: ../fish/guestfish-actions.pod:3656 ../src/guestfs-actions.pod:5581
11603 msgid "MIPS/SGI volumes."
11607 #: ../fish/guestfish-actions.pod:3658 ../src/guestfs-actions.pod:5583
11612 #: ../fish/guestfish-actions.pod:3660 ../src/guestfs-actions.pod:5585
11613 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11617 #: ../fish/guestfish-actions.pod:3662 ../src/guestfs-actions.pod:5587
11622 #: ../fish/guestfish-actions.pod:3664 ../src/guestfs-actions.pod:5589
11623 msgid "NEC PC-98 format, common in Japan apparently."
11627 #: ../fish/guestfish-actions.pod:3666 ../src/guestfs-actions.pod:5591
11632 #: ../fish/guestfish-actions.pod:3668 ../src/guestfs-actions.pod:5593
11633 msgid "Sun disk labels."
11637 #: ../fish/guestfish-actions.pod:3672
11642 #: ../fish/guestfish-actions.pod:3674
11645 " part-list device\n"
11650 #: ../fish/guestfish-actions.pod:3676 ../src/guestfs-actions.pod:5607
11652 "This command parses the partition table on C<device> and returns the list of "
11653 "partitions found."
11657 #: ../fish/guestfish-actions.pod:3679 ../src/guestfs-actions.pod:5610
11658 msgid "The fields in the returned structure are:"
11662 #: ../fish/guestfish-actions.pod:3683 ../src/guestfs-actions.pod:5614
11663 msgid "B<part_num>"
11667 #: ../fish/guestfish-actions.pod:3685 ../src/guestfs-actions.pod:5616
11668 msgid "Partition number, counting from 1."
11672 #: ../fish/guestfish-actions.pod:3687 ../src/guestfs-actions.pod:5618
11673 msgid "B<part_start>"
11677 #: ../fish/guestfish-actions.pod:3689
11679 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11680 "the device's sector size, see L</blockdev-getss>."
11684 #: ../fish/guestfish-actions.pod:3692 ../src/guestfs-actions.pod:5623
11685 msgid "B<part_end>"
11689 #: ../fish/guestfish-actions.pod:3694 ../src/guestfs-actions.pod:5625
11690 msgid "End of the partition in bytes."
11694 #: ../fish/guestfish-actions.pod:3696 ../src/guestfs-actions.pod:5627
11695 msgid "B<part_size>"
11699 #: ../fish/guestfish-actions.pod:3698 ../src/guestfs-actions.pod:5629
11700 msgid "Size of the partition in bytes."
11704 #: ../fish/guestfish-actions.pod:3702
11705 msgid "part-set-bootable"
11709 #: ../fish/guestfish-actions.pod:3704
11712 " part-set-bootable device partnum true|false\n"
11717 #: ../fish/guestfish-actions.pod:3706 ../src/guestfs-actions.pod:5647
11719 "This sets the bootable flag on partition numbered C<partnum> on device "
11720 "C<device>. Note that partitions are numbered from 1."
11724 #: ../fish/guestfish-actions.pod:3709 ../src/guestfs-actions.pod:5650
11726 "The bootable flag is used by some operating systems (notably Windows) to "
11727 "determine which partition to boot from. It is by no means universally "
11732 #: ../fish/guestfish-actions.pod:3713
11733 msgid "part-set-mbr-id"
11737 #: ../fish/guestfish-actions.pod:3715
11740 " part-set-mbr-id device partnum idbyte\n"
11745 #: ../fish/guestfish-actions.pod:3717 ../src/guestfs-actions.pod:5666
11747 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11748 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11749 "documentation are in fact hexadecimal numbers, but usually documented "
11750 "without any leading \"0x\" which might be confusing."
11754 #: ../fish/guestfish-actions.pod:3727
11755 msgid "part-set-name"
11759 #: ../fish/guestfish-actions.pod:3729
11762 " part-set-name device partnum name\n"
11767 #: ../fish/guestfish-actions.pod:3731 ../src/guestfs-actions.pod:5688
11769 "This sets the partition name on partition numbered C<partnum> on device "
11770 "C<device>. Note that partitions are numbered from 1."
11774 #: ../fish/guestfish-actions.pod:3734 ../src/guestfs-actions.pod:5691
11776 "The partition name can only be set on certain types of partition table. "
11777 "This works on C<gpt> but not on C<mbr> partitions."
11781 #: ../fish/guestfish-actions.pod:3737
11782 msgid "part-to-dev"
11786 #: ../fish/guestfish-actions.pod:3739
11789 " part-to-dev partition\n"
11794 #: ../fish/guestfish-actions.pod:3741 ../src/guestfs-actions.pod:5704
11796 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
11797 "partition number, returning the device name (eg. \"/dev/sdb\")."
11801 #: ../fish/guestfish-actions.pod:3745
11803 "The named partition must exist, for example as a string returned from "
11804 "L</list-partitions>."
11808 #: ../fish/guestfish-actions.pod:3748
11809 msgid "ping-daemon"
11813 #: ../fish/guestfish-actions.pod:3750
11821 #: ../fish/guestfish-actions.pod:3752 ../src/guestfs-actions.pod:5721
11823 "This is a test probe into the guestfs daemon running inside the qemu "
11824 "subprocess. Calling this function checks that the daemon responds to the "
11825 "ping message, without affecting the daemon or attached block device(s) in "
11830 #: ../fish/guestfish-actions.pod:3757
11835 #: ../fish/guestfish-actions.pod:3759
11838 " pread path count offset\n"
11843 #: ../fish/guestfish-actions.pod:3761 ../src/guestfs-actions.pod:5739
11845 "This command lets you read part of a file. It reads C<count> bytes of the "
11846 "file, starting at C<offset>, from file C<path>."
11850 #: ../fish/guestfish-actions.pod:3764 ../fish/guestfish-actions.pod:3779 ../src/guestfs-actions.pod:5742 ../src/guestfs-actions.pod:5768
11852 "This may read fewer bytes than requested. For further details see the "
11853 "L<pread(2)> system call."
11857 #: ../fish/guestfish-actions.pod:3767
11858 msgid "See also L</pwrite>, L</pread-device>."
11862 #: ../fish/guestfish-actions.pod:3772
11863 msgid "pread-device"
11867 #: ../fish/guestfish-actions.pod:3774
11870 " pread-device device count offset\n"
11875 #: ../fish/guestfish-actions.pod:3776 ../src/guestfs-actions.pod:5765
11877 "This command lets you read part of a file. It reads C<count> bytes of "
11878 "C<device>, starting at C<offset>."
11882 #: ../fish/guestfish-actions.pod:3782
11883 msgid "See also L</pread>."
11887 #: ../fish/guestfish-actions.pod:3787
11892 #: ../fish/guestfish-actions.pod:3789
11895 " pvcreate device\n"
11900 #: ../fish/guestfish-actions.pod:3791 ../src/guestfs-actions.pod:5788
11902 "This creates an LVM physical volume on the named C<device>, where C<device> "
11903 "should usually be a partition name such as C</dev/sda1>."
11907 #: ../fish/guestfish-actions.pod:3795
11912 #: ../fish/guestfish-actions.pod:3797
11915 " pvremove device\n"
11920 #: ../fish/guestfish-actions.pod:3799 ../src/guestfs-actions.pod:5802
11922 "This wipes a physical volume C<device> so that LVM will no longer recognise "
11927 #: ../fish/guestfish-actions.pod:3802 ../src/guestfs-actions.pod:5805
11929 "The implementation uses the C<pvremove> command which refuses to wipe "
11930 "physical volumes that contain any volume groups, so you have to remove those "
11935 #: ../fish/guestfish-actions.pod:3806
11940 #: ../fish/guestfish-actions.pod:3808
11943 " pvresize device\n"
11948 #: ../fish/guestfish-actions.pod:3810 ../src/guestfs-actions.pod:5819
11950 "This resizes (expands or shrinks) an existing LVM physical volume to match "
11951 "the new size of the underlying device."
11955 #: ../fish/guestfish-actions.pod:3813
11956 msgid "pvresize-size"
11960 #: ../fish/guestfish-actions.pod:3815
11963 " pvresize-size device size\n"
11968 #: ../fish/guestfish-actions.pod:3817
11970 "This command is the same as L</pvresize> except that it allows you to "
11971 "specify the new size (in bytes) explicitly."
11975 #: ../fish/guestfish-actions.pod:3820
11980 #: ../fish/guestfish-actions.pod:3822
11988 #: ../fish/guestfish-actions.pod:3824 ../src/guestfs-actions.pod:5845
11990 "List all the physical volumes detected. This is the equivalent of the "
11991 "L<pvs(8)> command."
11995 #: ../fish/guestfish-actions.pod:3827 ../src/guestfs-actions.pod:5848
11997 "This returns a list of just the device names that contain PVs "
11998 "(eg. C</dev/sda2>)."
12002 #: ../fish/guestfish-actions.pod:3830
12003 msgid "See also L</pvs-full>."
12007 #: ../fish/guestfish-actions.pod:3832
12012 #: ../fish/guestfish-actions.pod:3834
12020 #: ../fish/guestfish-actions.pod:3836 ../src/guestfs-actions.pod:5864
12022 "List all the physical volumes detected. This is the equivalent of the "
12023 "L<pvs(8)> command. The \"full\" version includes all fields."
12027 #: ../fish/guestfish-actions.pod:3839
12032 #: ../fish/guestfish-actions.pod:3841
12040 #: ../fish/guestfish-actions.pod:3843 ../src/guestfs-actions.pod:5879
12041 msgid "This command returns the UUID of the LVM PV C<device>."
12045 #: ../fish/guestfish-actions.pod:3845
12050 #: ../fish/guestfish-actions.pod:3847
12053 " pwrite path content offset\n"
12058 #: ../fish/guestfish-actions.pod:3849 ../src/guestfs-actions.pod:5895
12060 "This command writes to part of a file. It writes the data buffer C<content> "
12061 "to the file C<path> starting at offset C<offset>."
12065 #: ../fish/guestfish-actions.pod:3852 ../src/guestfs-actions.pod:5898
12067 "This command implements the L<pwrite(2)> system call, and like that system "
12068 "call it may not write the full data requested. The return value is the "
12069 "number of bytes that were actually written to the file. This could even be "
12070 "0, although short writes are unlikely for regular files in ordinary "
12075 #: ../fish/guestfish-actions.pod:3858
12076 msgid "See also L</pread>, L</pwrite-device>."
12080 #: ../fish/guestfish-actions.pod:3863
12081 msgid "pwrite-device"
12085 #: ../fish/guestfish-actions.pod:3865
12088 " pwrite-device device content offset\n"
12093 #: ../fish/guestfish-actions.pod:3867 ../src/guestfs-actions.pod:5922
12095 "This command writes to part of a device. It writes the data buffer "
12096 "C<content> to C<device> starting at offset C<offset>."
12100 #: ../fish/guestfish-actions.pod:3870 ../src/guestfs-actions.pod:5925
12102 "This command implements the L<pwrite(2)> system call, and like that system "
12103 "call it may not write the full data requested (although short writes to disk "
12104 "devices and partitions are probably impossible with standard Linux kernels)."
12108 #: ../fish/guestfish-actions.pod:3875
12109 msgid "See also L</pwrite>."
12113 #: ../fish/guestfish-actions.pod:3880
12118 #: ../fish/guestfish-actions.pod:3882
12121 " read-file path\n"
12126 #: ../fish/guestfish-actions.pod:3884 ../src/guestfs-actions.pod:5946
12127 msgid "This calls returns the contents of the file C<path> as a buffer."
12131 #: ../fish/guestfish-actions.pod:3887
12133 "Unlike L</cat>, this function can correctly handle files that contain "
12134 "embedded ASCII NUL characters. However unlike L</download>, this function "
12135 "is limited in the total size of file that can be handled."
12139 #: ../fish/guestfish-actions.pod:3895
12144 #: ../fish/guestfish-actions.pod:3897
12147 " read-lines path\n"
12152 #: ../fish/guestfish-actions.pod:3901 ../src/guestfs-actions.pod:5971
12154 "The file contents are returned as a list of lines. Trailing C<LF> and "
12155 "C<CRLF> character sequences are I<not> returned."
12159 #: ../fish/guestfish-actions.pod:3904
12161 "Note that this function cannot correctly handle binary files (specifically, "
12162 "files containing C<\\0> character which is treated as end of line). For "
12163 "those you need to use the L</read-file> function which has a more complex "
12168 #: ../fish/guestfish-actions.pod:3909
12173 #: ../fish/guestfish-actions.pod:3911
12181 #: ../fish/guestfish-actions.pod:3913 ../src/guestfs-actions.pod:5991
12182 msgid "This returns the list of directory entries in directory C<dir>."
12186 #: ../fish/guestfish-actions.pod:3915 ../src/guestfs-actions.pod:5993
12188 "All entries in the directory are returned, including C<.> and C<..>. The "
12189 "entries are I<not> sorted, but returned in the same order as the underlying "
12194 #: ../fish/guestfish-actions.pod:3919 ../src/guestfs-actions.pod:5997
12196 "Also this call returns basic file type information about each file. The "
12197 "C<ftyp> field will contain one of the following characters:"
12201 #: ../fish/guestfish-actions.pod:3924 ../src/guestfs-actions.pod:6002
12206 #: ../fish/guestfish-actions.pod:3926 ../src/guestfs-actions.pod:6004
12207 msgid "Block special"
12211 #: ../fish/guestfish-actions.pod:3928 ../src/guestfs-actions.pod:6006
12216 #: ../fish/guestfish-actions.pod:3930 ../src/guestfs-actions.pod:6008
12217 msgid "Char special"
12221 #: ../fish/guestfish-actions.pod:3932 ../src/guestfs-actions.pod:6010
12226 #: ../fish/guestfish-actions.pod:3934 ../src/guestfs-actions.pod:6012
12231 #: ../fish/guestfish-actions.pod:3936 ../src/guestfs-actions.pod:6014
12236 #: ../fish/guestfish-actions.pod:3938 ../src/guestfs-actions.pod:6016
12237 msgid "FIFO (named pipe)"
12241 #: ../fish/guestfish-actions.pod:3940 ../src/guestfs-actions.pod:6018
12246 #: ../fish/guestfish-actions.pod:3942 ../src/guestfs-actions.pod:6020
12247 msgid "Symbolic link"
12251 #: ../fish/guestfish-actions.pod:3944 ../src/guestfs-actions.pod:6022
12256 #: ../fish/guestfish-actions.pod:3946 ../src/guestfs-actions.pod:6024
12257 msgid "Regular file"
12261 #: ../fish/guestfish-actions.pod:3948 ../src/guestfs-actions.pod:6026
12266 #: ../fish/guestfish-actions.pod:3950 ../src/guestfs-actions.pod:6028
12271 #: ../fish/guestfish-actions.pod:3952 ../src/guestfs-actions.pod:6030
12276 #: ../fish/guestfish-actions.pod:3954 ../src/guestfs-actions.pod:6032
12277 msgid "Unknown file type"
12281 #: ../fish/guestfish-actions.pod:3956 ../src/guestfs-actions.pod:6034
12286 #: ../fish/guestfish-actions.pod:3958 ../src/guestfs-actions.pod:6036
12287 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12291 #: ../fish/guestfish-actions.pod:3963
12293 "This function is primarily intended for use by programs. To get a simple "
12294 "list of names, use L</ls>. To get a printable directory for human "
12295 "consumption, use L</ll>."
12299 #: ../fish/guestfish-actions.pod:3967
12304 #: ../fish/guestfish-actions.pod:3969
12312 #: ../fish/guestfish-actions.pod:3971 ../src/guestfs-actions.pod:6057
12313 msgid "This command reads the target of a symbolic link."
12317 #: ../fish/guestfish-actions.pod:3973
12318 msgid "readlinklist"
12322 #: ../fish/guestfish-actions.pod:3975
12325 " readlinklist path 'names ...'\n"
12330 #: ../fish/guestfish-actions.pod:3977 ../src/guestfs-actions.pod:6071
12332 "This call allows you to do a C<readlink> operation on multiple files, where "
12333 "all files are in the directory C<path>. C<names> is the list of files from "
12338 #: ../fish/guestfish-actions.pod:3981 ../src/guestfs-actions.pod:6075
12340 "On return you get a list of strings, with a one-to-one correspondence to the "
12341 "C<names> list. Each string is the value of the symbolic link."
12345 #: ../fish/guestfish-actions.pod:3985 ../src/guestfs-actions.pod:6079
12347 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12348 "result string is the empty string C<\"\">. However the whole operation is "
12349 "completed even if there were C<readlink(2)> errors, and so you can call this "
12350 "function with names where you don't know if they are symbolic links already "
12351 "(albeit slightly less efficient)."
12355 #: ../fish/guestfish-actions.pod:3992 ../src/guestfs-actions.pod:6086
12357 "This call is intended for programs that want to efficiently list a directory "
12358 "contents without making many round-trips. Very long directory listings "
12359 "might cause the protocol message size to be exceeded, causing this call to "
12360 "fail. The caller must split up such requests into smaller groups of names."
12364 #: ../fish/guestfish-actions.pod:3999
12369 #: ../fish/guestfish-actions.pod:4001
12377 #: ../fish/guestfish-actions.pod:4003 ../src/guestfs-actions.pod:6105
12379 "Return the canonicalized absolute pathname of C<path>. The returned path "
12380 "has no C<.>, C<..> or symbolic link path elements."
12384 #: ../fish/guestfish-actions.pod:4006
12385 msgid "removexattr"
12389 #: ../fish/guestfish-actions.pod:4008
12392 " removexattr xattr path\n"
12397 #: ../fish/guestfish-actions.pod:4010 ../src/guestfs-actions.pod:6120
12398 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
12402 #: ../fish/guestfish-actions.pod:4013
12403 msgid "See also: L</lremovexattr>, L<attr(5)>."
12407 #: ../fish/guestfish-actions.pod:4015
12412 #: ../fish/guestfish-actions.pod:4017
12415 " resize2fs device\n"
12420 #: ../fish/guestfish-actions.pod:4019 ../src/guestfs-actions.pod:6135
12422 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12423 "underlying device."
12427 #: ../fish/guestfish-actions.pod:4022
12429 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
12430 "before calling this command. For unknown reasons C<resize2fs> sometimes "
12431 "gives an error about this and sometimes not. In any case, it is always safe "
12432 "to call L</e2fsck-f> before calling this function."
12436 #: ../fish/guestfish-actions.pod:4028
12437 msgid "resize2fs-M"
12441 #: ../fish/guestfish-actions.pod:4030
12444 " resize2fs-M device\n"
12449 #: ../fish/guestfish-actions.pod:4032
12451 "This command is the same as L</resize2fs>, but the filesystem is resized to "
12452 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
12457 #: ../fish/guestfish-actions.pod:4036
12459 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
12460 "and read the C<Block size> and C<Block count> values. These two numbers, "
12461 "multiplied together, give the resulting size of the minimal filesystem in "
12466 #: ../fish/guestfish-actions.pod:4041
12467 msgid "resize2fs-size"
12471 #: ../fish/guestfish-actions.pod:4043
12474 " resize2fs-size device size\n"
12479 #: ../fish/guestfish-actions.pod:4045
12481 "This command is the same as L</resize2fs> except that it allows you to "
12482 "specify the new size (in bytes) explicitly."
12486 #: ../fish/guestfish-actions.pod:4048
12491 #: ../fish/guestfish-actions.pod:4050
12499 #: ../fish/guestfish-actions.pod:4052 ../src/guestfs-actions.pod:6187
12500 msgid "Remove the single file C<path>."
12504 #: ../fish/guestfish-actions.pod:4054
12509 #: ../fish/guestfish-actions.pod:4056
12517 #: ../fish/guestfish-actions.pod:4058 ../src/guestfs-actions.pod:6199
12519 "Remove the file or directory C<path>, recursively removing the contents if "
12520 "its a directory. This is like the C<rm -rf> shell command."
12524 #: ../fish/guestfish-actions.pod:4062
12529 #: ../fish/guestfish-actions.pod:4064
12537 #: ../fish/guestfish-actions.pod:4066 ../src/guestfs-actions.pod:6213
12538 msgid "Remove the single directory C<path>."
12542 #: ../fish/guestfish-actions.pod:4068
12543 msgid "rmmountpoint"
12547 #: ../fish/guestfish-actions.pod:4070
12550 " rmmountpoint exemptpath\n"
12555 #: ../fish/guestfish-actions.pod:4072
12557 "This calls removes a mountpoint that was previously created with "
12558 "L</mkmountpoint>. See L</mkmountpoint> for full details."
12562 #: ../fish/guestfish-actions.pod:4076
12563 msgid "scrub-device"
12567 #: ../fish/guestfish-actions.pod:4078
12570 " scrub-device device\n"
12575 #: ../fish/guestfish-actions.pod:4080 ../src/guestfs-actions.pod:6239
12577 "This command writes patterns over C<device> to make data retrieval more "
12582 #: ../fish/guestfish-actions.pod:4083 ../fish/guestfish-actions.pod:4098 ../fish/guestfish-actions.pod:4111 ../src/guestfs-actions.pod:6242 ../src/guestfs-actions.pod:6263 ../src/guestfs-actions.pod:6282
12584 "It is an interface to the L<scrub(1)> program. See that manual page for "
12589 #: ../fish/guestfish-actions.pod:4089
12594 #: ../fish/guestfish-actions.pod:4091
12597 " scrub-file file\n"
12602 #: ../fish/guestfish-actions.pod:4093 ../src/guestfs-actions.pod:6258
12604 "This command writes patterns over a file to make data retrieval more "
12609 #: ../fish/guestfish-actions.pod:4096 ../src/guestfs-actions.pod:6261
12610 msgid "The file is I<removed> after scrubbing."
12614 #: ../fish/guestfish-actions.pod:4101
12615 msgid "scrub-freespace"
12619 #: ../fish/guestfish-actions.pod:4103
12622 " scrub-freespace dir\n"
12627 #: ../fish/guestfish-actions.pod:4105
12629 "This command creates the directory C<dir> and then fills it with files until "
12630 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
12631 "deletes them. The intention is to scrub any free space on the partition "
12632 "containing C<dir>."
12636 #: ../fish/guestfish-actions.pod:4114
12641 #: ../fish/guestfish-actions.pod:4116
12646 #: ../fish/guestfish-actions.pod:4118
12649 " set-append append\n"
12654 #: ../fish/guestfish-actions.pod:4120 ../src/guestfs-actions.pod:6295
12656 "This function is used to add additional options to the guest kernel command "
12661 #: ../fish/guestfish-actions.pod:4123 ../src/guestfs-actions.pod:6298
12663 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12664 "environment variable."
12668 #: ../fish/guestfish-actions.pod:4126 ../src/guestfs-actions.pod:6301
12670 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12671 "(libguestfs always adds a few of its own)."
12675 #: ../fish/guestfish-actions.pod:4129
12676 msgid "set-attach-method"
12680 #: ../fish/guestfish-actions.pod:4131
12681 msgid "attach-method"
12685 #: ../fish/guestfish-actions.pod:4133
12688 " set-attach-method attachmethod\n"
12693 #: ../fish/guestfish-actions.pod:4135 ../src/guestfs-actions.pod:6314
12695 "Set the method that libguestfs uses to connect to the back end guestfsd "
12696 "daemon. Possible methods are:"
12700 #: ../fish/guestfish-actions.pod:4140 ../src/guestfs-actions.pod:6319 ../src/guestfs.pod:2826
12701 msgid "C<appliance>"
12705 #: ../fish/guestfish-actions.pod:4142 ../src/guestfs-actions.pod:6321
12707 "Launch an appliance and connect to it. This is the ordinary method and the "
12712 #: ../fish/guestfish-actions.pod:4145 ../src/guestfs-actions.pod:6324
12713 msgid "C<unix:I<path>>"
12717 #: ../fish/guestfish-actions.pod:4147 ../src/guestfs-actions.pod:6326
12718 msgid "Connect to the Unix domain socket I<path>."
12722 #: ../fish/guestfish-actions.pod:4149 ../src/guestfs-actions.pod:6328
12724 "This method lets you connect to an existing daemon or (using virtio-serial) "
12725 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
12726 "RUNNING DAEMONS>."
12730 #: ../fish/guestfish-actions.pod:4155
12731 msgid "set-autosync"
12735 #: ../fish/guestfish-actions.pod:4157
12740 #: ../fish/guestfish-actions.pod:4159
12743 " set-autosync true|false\n"
12748 #: ../fish/guestfish-actions.pod:4161 ../src/guestfs-actions.pod:6344
12750 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
12751 "effort attempt to make filesystems consistent and synchronized when the "
12752 "handle is closed (also if the program exits without closing handles)."
12756 #: ../fish/guestfish-actions.pod:4166 ../src/guestfs-actions.pod:6349
12758 "This is enabled by default (since libguestfs 1.5.24, previously it was "
12759 "disabled by default)."
12763 #: ../fish/guestfish-actions.pod:4169
12768 #: ../fish/guestfish-actions.pod:4171
12773 #: ../fish/guestfish-actions.pod:4173
12776 " set-direct true|false\n"
12781 #: ../fish/guestfish-actions.pod:4175 ../src/guestfs-actions.pod:6362
12783 "If the direct appliance mode flag is enabled, then stdin and stdout are "
12784 "passed directly through to the appliance once it is launched."
12788 #: ../fish/guestfish-actions.pod:4179
12790 "One consequence of this is that log messages aren't caught by the library "
12791 "and handled by L</set-log-message-callback>, but go straight to stdout."
12795 #: ../fish/guestfish-actions.pod:4183 ../src/guestfs-actions.pod:6370
12796 msgid "You probably don't want to use this unless you know what you are doing."
12800 #: ../fish/guestfish-actions.pod:4186 ../src/guestfs-actions.pod:6373
12801 msgid "The default is disabled."
12805 #: ../fish/guestfish-actions.pod:4188
12806 msgid "set-e2label"
12810 #: ../fish/guestfish-actions.pod:4190
12813 " set-e2label device label\n"
12818 #: ../fish/guestfish-actions.pod:4192 ../src/guestfs-actions.pod:6386
12820 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
12821 "C<label>. Filesystem labels are limited to 16 characters."
12825 #: ../fish/guestfish-actions.pod:4196
12827 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
12828 "label on a filesystem."
12832 #: ../fish/guestfish-actions.pod:4199
12837 #: ../fish/guestfish-actions.pod:4201
12840 " set-e2uuid device uuid\n"
12845 #: ../fish/guestfish-actions.pod:4203 ../src/guestfs-actions.pod:6404
12847 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
12848 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
12849 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
12853 #: ../fish/guestfish-actions.pod:4208
12855 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
12856 "UUID of a filesystem."
12860 #: ../fish/guestfish-actions.pod:4211
12861 msgid "set-memsize"
12865 #: ../fish/guestfish-actions.pod:4213
12870 #: ../fish/guestfish-actions.pod:4215
12873 " set-memsize memsize\n"
12878 #: ../fish/guestfish-actions.pod:4217
12880 "This sets the memory size in megabytes allocated to the qemu subprocess. "
12881 "This only has any effect if called before L</launch>."
12885 #: ../fish/guestfish-actions.pod:4221 ../src/guestfs-actions.pod:6426
12887 "You can also change this by setting the environment variable "
12888 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
12892 #: ../fish/guestfish-actions.pod:4228
12893 msgid "set-network"
12897 #: ../fish/guestfish-actions.pod:4230
12902 #: ../fish/guestfish-actions.pod:4232
12905 " set-network true|false\n"
12910 #: ../fish/guestfish-actions.pod:4234 ../src/guestfs-actions.pod:6443
12912 "If C<network> is true, then the network is enabled in the libguestfs "
12913 "appliance. The default is false."
12917 #: ../fish/guestfish-actions.pod:4237 ../src/guestfs-actions.pod:6446
12919 "This affects whether commands are able to access the network (see "
12920 "L<guestfs(3)/RUNNING COMMANDS>)."
12924 #: ../fish/guestfish-actions.pod:4240
12925 msgid "You must call this before calling L</launch>, otherwise it has no effect."
12929 #: ../fish/guestfish-actions.pod:4243
12934 #: ../fish/guestfish-actions.pod:4247
12937 " set-path searchpath\n"
12942 #: ../fish/guestfish-actions.pod:4249 ../src/guestfs-actions.pod:6462
12943 msgid "Set the path that libguestfs searches for kernel and initrd.img."
12947 #: ../fish/guestfish-actions.pod:4251 ../src/guestfs-actions.pod:6464
12949 "The default is C<$libdir/guestfs> unless overridden by setting "
12950 "C<LIBGUESTFS_PATH> environment variable."
12954 #: ../fish/guestfish-actions.pod:4254 ../src/guestfs-actions.pod:6467
12955 msgid "Setting C<path> to C<NULL> restores the default path."
12959 #: ../fish/guestfish-actions.pod:4256
12964 #: ../fish/guestfish-actions.pod:4258
12969 #: ../fish/guestfish-actions.pod:4260
12972 " set-pgroup true|false\n"
12977 #: ../fish/guestfish-actions.pod:4262 ../src/guestfs-actions.pod:6479
12979 "If C<pgroup> is true, child processes are placed into their own process "
12984 #: ../fish/guestfish-actions.pod:4265 ../src/guestfs-actions.pod:6482
12986 "The practical upshot of this is that signals like C<SIGINT> (from users "
12987 "pressing C<^C>) won't be received by the child process."
12991 #: ../fish/guestfish-actions.pod:4268 ../src/guestfs-actions.pod:6485
12993 "The default for this flag is false, because usually you want C<^C> to kill "
12998 #: ../fish/guestfish-actions.pod:4271
13003 #: ../fish/guestfish-actions.pod:4273
13008 #: ../fish/guestfish-actions.pod:4275
13016 #: ../fish/guestfish-actions.pod:4277 ../src/guestfs-actions.pod:6498
13017 msgid "Set the qemu binary that we will use."
13021 #: ../fish/guestfish-actions.pod:4279 ../src/guestfs-actions.pod:6500
13022 msgid "The default is chosen when the library was compiled by the configure script."
13026 #: ../fish/guestfish-actions.pod:4282 ../src/guestfs-actions.pod:6503
13028 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
13033 #: ../fish/guestfish-actions.pod:4285 ../src/guestfs-actions.pod:6506
13034 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
13038 #: ../fish/guestfish-actions.pod:4287 ../src/guestfs-actions.pod:6508
13040 "Note that you should call this function as early as possible after creating "
13041 "the handle. This is because some pre-launch operations depend on testing "
13042 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
13043 "don't retest features, and so you might see inconsistent results. Using the "
13044 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
13045 "the qemu binary at the same time as the handle is created."
13049 #: ../fish/guestfish-actions.pod:4295
13050 msgid "set-recovery-proc"
13054 #: ../fish/guestfish-actions.pod:4297
13055 msgid "recovery-proc"
13059 #: ../fish/guestfish-actions.pod:4299
13062 " set-recovery-proc true|false\n"
13067 #: ../fish/guestfish-actions.pod:4301
13069 "If this is called with the parameter C<false> then L</launch> does not "
13070 "create a recovery process. The purpose of the recovery process is to stop "
13071 "runaway qemu processes in the case where the main program aborts abruptly."
13075 #: ../fish/guestfish-actions.pod:4306
13077 "This only has any effect if called before L</launch>, and the default is "
13082 #: ../fish/guestfish-actions.pod:4309 ../src/guestfs-actions.pod:6534
13084 "About the only time when you would want to disable this is if the main "
13085 "process will fork itself into the background (\"daemonize\" itself). In "
13086 "this case the recovery process thinks that the main program has disappeared "
13087 "and so kills qemu, which is not very helpful."
13091 #: ../fish/guestfish-actions.pod:4315
13092 msgid "set-selinux"
13096 #: ../fish/guestfish-actions.pod:4317
13101 #: ../fish/guestfish-actions.pod:4319
13104 " set-selinux true|false\n"
13109 #: ../fish/guestfish-actions.pod:4321 ../src/guestfs-actions.pod:6550
13111 "This sets the selinux flag that is passed to the appliance at boot time. "
13112 "The default is C<selinux=0> (disabled)."
13116 #: ../fish/guestfish-actions.pod:4324 ../src/guestfs-actions.pod:6553
13118 "Note that if SELinux is enabled, it is always in Permissive mode "
13119 "(C<enforcing=0>)."
13123 #: ../fish/guestfish-actions.pod:4330
13128 #: ../fish/guestfish-actions.pod:4332
13133 #: ../fish/guestfish-actions.pod:4334
13141 #: ../fish/guestfish-actions.pod:4336 ../src/guestfs-actions.pod:6569
13143 "Change the number of virtual CPUs assigned to the appliance. The default is "
13144 "C<1>. Increasing this may improve performance, though often it has no "
13149 #: ../fish/guestfish-actions.pod:4340
13150 msgid "This function must be called before L</launch>."
13154 #: ../fish/guestfish-actions.pod:4342
13159 #: ../fish/guestfish-actions.pod:4344
13164 #: ../fish/guestfish-actions.pod:4346
13167 " set-trace true|false\n"
13172 #: ../fish/guestfish-actions.pod:4348 ../src/guestfs-actions.pod:6583
13174 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
13175 "return values are traced."
13179 #: ../fish/guestfish-actions.pod:4351 ../src/guestfs-actions.pod:6586
13181 "If you want to trace C API calls into libguestfs (and other libraries) then "
13182 "possibly a better way is to use the external ltrace(1) command."
13186 #: ../fish/guestfish-actions.pod:4355 ../src/guestfs-actions.pod:6590
13188 "Command traces are disabled unless the environment variable "
13189 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
13193 #: ../fish/guestfish-actions.pod:4358
13195 "Trace messages are normally sent to C<stderr>, unless you register a "
13196 "callback to send them somewhere else (see L</set-event-callback>)."
13200 #: ../fish/guestfish-actions.pod:4362
13201 msgid "set-verbose"
13205 #: ../fish/guestfish-actions.pod:4364
13210 #: ../fish/guestfish-actions.pod:4366
13213 " set-verbose true|false\n"
13218 #: ../fish/guestfish-actions.pod:4368 ../src/guestfs-actions.pod:6607
13219 msgid "If C<verbose> is true, this turns on verbose messages."
13223 #: ../fish/guestfish-actions.pod:4370 ../src/guestfs-actions.pod:6609
13225 "Verbose messages are disabled unless the environment variable "
13226 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
13230 #: ../fish/guestfish-actions.pod:4373
13232 "Verbose messages are normally sent to C<stderr>, unless you register a "
13233 "callback to send them somewhere else (see L</set-event-callback>)."
13237 #: ../fish/guestfish-actions.pod:4377
13242 #: ../fish/guestfish-actions.pod:4379
13245 " setcon context\n"
13250 #: ../fish/guestfish-actions.pod:4381 ../src/guestfs-actions.pod:6626
13252 "This sets the SELinux security context of the daemon to the string "
13257 #: ../fish/guestfish-actions.pod:4384 ../src/guestfs-actions.pod:6629
13258 msgid "See the documentation about SELINUX in L<guestfs(3)>."
13262 #: ../fish/guestfish-actions.pod:4386
13267 #: ../fish/guestfish-actions.pod:4388
13270 " setxattr xattr val vallen path\n"
13275 #: ../fish/guestfish-actions.pod:4390 ../src/guestfs-actions.pod:6644
13277 "This call sets the extended attribute named C<xattr> of the file C<path> to "
13278 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
13282 #: ../fish/guestfish-actions.pod:4394
13283 msgid "See also: L</lsetxattr>, L<attr(5)>."
13287 #: ../fish/guestfish-actions.pod:4396
13292 #: ../fish/guestfish-actions.pod:4398
13295 " sfdisk device cyls heads sectors 'lines ...'\n"
13300 #: ../fish/guestfish-actions.pod:4400 ../src/guestfs-actions.pod:6671
13302 "This is a direct interface to the L<sfdisk(8)> program for creating "
13303 "partitions on block devices."
13307 #: ../fish/guestfish-actions.pod:4403 ../src/guestfs-actions.pod:6674
13308 msgid "C<device> should be a block device, for example C</dev/sda>."
13312 #: ../fish/guestfish-actions.pod:4405 ../src/guestfs-actions.pod:6676
13314 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13315 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
13316 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13317 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13318 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13319 "the kernel) cannot work out the right geometry and you will need to tell it."
13323 #: ../fish/guestfish-actions.pod:4413 ../src/guestfs-actions.pod:6684
13325 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13326 "refer to the L<sfdisk(8)> manpage."
13330 #: ../fish/guestfish-actions.pod:4416 ../src/guestfs-actions.pod:6687
13332 "To create a single partition occupying the whole disk, you would pass "
13333 "C<lines> as a single element list, when the single element being the string "
13338 #: ../fish/guestfish-actions.pod:4420
13339 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
13343 #: ../fish/guestfish-actions.pod:4426 ../fish/guestfish-actions.pod:4449 ../fish/guestfish-actions.pod:4471
13345 "I<This function is deprecated.> In new code, use the L</part_add> call "
13350 #: ../fish/guestfish-actions.pod:4433
13355 #: ../fish/guestfish-actions.pod:4435
13358 " sfdiskM device 'lines ...'\n"
13363 #: ../fish/guestfish-actions.pod:4437
13365 "This is a simplified interface to the L</sfdisk> command, where partition "
13366 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
13367 "you don't need to specify the cyls, heads and sectors parameters which were "
13368 "rarely if ever used anyway."
13372 #: ../fish/guestfish-actions.pod:4443
13373 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
13377 #: ../fish/guestfish-actions.pod:4456
13382 #: ../fish/guestfish-actions.pod:4458
13385 " sfdisk-N device partnum cyls heads sectors line\n"
13390 #: ../fish/guestfish-actions.pod:4460 ../src/guestfs-actions.pod:6749
13392 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13393 "(note: C<n> counts from 1)."
13397 #: ../fish/guestfish-actions.pod:4463
13399 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
13400 "cyls/heads/sectors parameters."
13404 #: ../fish/guestfish-actions.pod:4466
13405 msgid "See also: L</part-add>"
13409 #: ../fish/guestfish-actions.pod:4478
13410 msgid "sfdisk-disk-geometry"
13414 #: ../fish/guestfish-actions.pod:4480
13417 " sfdisk-disk-geometry device\n"
13422 #: ../fish/guestfish-actions.pod:4482
13424 "This displays the disk geometry of C<device> read from the partition table. "
13425 "Especially in the case where the underlying block device has been resized, "
13426 "this can be different from the kernel's idea of the geometry (see "
13427 "L</sfdisk-kernel-geometry>)."
13431 #: ../fish/guestfish-actions.pod:4487 ../fish/guestfish-actions.pod:4496 ../src/guestfs-actions.pod:6775 ../src/guestfs-actions.pod:6791
13432 msgid "The result is in human-readable format, and not designed to be parsed."
13436 #: ../fish/guestfish-actions.pod:4490
13437 msgid "sfdisk-kernel-geometry"
13441 #: ../fish/guestfish-actions.pod:4492
13444 " sfdisk-kernel-geometry device\n"
13449 #: ../fish/guestfish-actions.pod:4494 ../src/guestfs-actions.pod:6789
13450 msgid "This displays the kernel's idea of the geometry of C<device>."
13454 #: ../fish/guestfish-actions.pod:4499
13459 #: ../fish/guestfish-actions.pod:4501
13462 " sfdisk-l device\n"
13467 #: ../fish/guestfish-actions.pod:4503 ../src/guestfs-actions.pod:6812
13469 "This displays the partition table on C<device>, in the human-readable output "
13470 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13474 #: ../fish/guestfish-actions.pod:4507
13475 msgid "See also: L</part-list>"
13479 #: ../fish/guestfish-actions.pod:4509
13481 "I<This function is deprecated.> In new code, use the L</part_list> call "
13486 #: ../fish/guestfish-actions.pod:4516
13491 #: ../fish/guestfish-actions.pod:4518
13499 #: ../fish/guestfish-actions.pod:4520 ../src/guestfs-actions.pod:6829
13501 "This call runs a command from the guest filesystem via the guest's "
13506 #: ../fish/guestfish-actions.pod:4523
13507 msgid "This is like L</command>, but passes the command to:"
13511 #: ../fish/guestfish-actions.pod:4525 ../src/guestfs-actions.pod:6834
13514 " /bin/sh -c \"command\"\n"
13519 #: ../fish/guestfish-actions.pod:4527 ../src/guestfs-actions.pod:6836
13521 "Depending on the guest's shell, this usually results in wildcards being "
13522 "expanded, shell expressions being interpolated and so on."
13526 #: ../fish/guestfish-actions.pod:4531
13527 msgid "All the provisos about L</command> apply to this call."
13531 #: ../fish/guestfish-actions.pod:4533
13536 #: ../fish/guestfish-actions.pod:4535
13539 " sh-lines command\n"
13544 #: ../fish/guestfish-actions.pod:4537
13545 msgid "This is the same as L</sh>, but splits the result into a list of lines."
13549 #: ../fish/guestfish-actions.pod:4540
13550 msgid "See also: L</command-lines>"
13554 #: ../fish/guestfish-actions.pod:4542
13559 #: ../fish/guestfish-actions.pod:4544
13567 #: ../fish/guestfish-actions.pod:4546 ../src/guestfs-actions.pod:6870
13568 msgid "Sleep for C<secs> seconds."
13572 #: ../fish/guestfish-actions.pod:4548
13577 #: ../fish/guestfish-actions.pod:4550
13585 #: ../fish/guestfish-actions.pod:4554 ../src/guestfs-actions.pod:6884
13586 msgid "This is the same as the C<stat(2)> system call."
13590 #: ../fish/guestfish-actions.pod:4556
13595 #: ../fish/guestfish-actions.pod:4558
13603 #: ../fish/guestfish-actions.pod:4560 ../src/guestfs-actions.pod:6898
13605 "Returns file system statistics for any mounted file system. C<path> should "
13606 "be a file or directory in the mounted file system (typically it is the mount "
13607 "point itself, but it doesn't need to be)."
13611 #: ../fish/guestfish-actions.pod:4564 ../src/guestfs-actions.pod:6902
13612 msgid "This is the same as the C<statvfs(2)> system call."
13616 #: ../fish/guestfish-actions.pod:4566
13621 #: ../fish/guestfish-actions.pod:4568
13629 #: ../fish/guestfish-actions.pod:4570 ../src/guestfs-actions.pod:6916
13631 "This runs the L<strings(1)> command on a file and returns the list of "
13632 "printable strings found."
13636 #: ../fish/guestfish-actions.pod:4576
13641 #: ../fish/guestfish-actions.pod:4578
13644 " strings-e encoding path\n"
13649 #: ../fish/guestfish-actions.pod:4580
13651 "This is like the L</strings> command, but allows you to specify the encoding "
13652 "of strings that are looked for in the source file C<path>."
13656 #: ../fish/guestfish-actions.pod:4584 ../src/guestfs-actions.pod:6939
13657 msgid "Allowed encodings are:"
13661 #: ../fish/guestfish-actions.pod:4588 ../src/guestfs-actions.pod:6943
13666 #: ../fish/guestfish-actions.pod:4590
13668 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13669 "ISO-8859-X (this is what L</strings> uses)."
13673 #: ../fish/guestfish-actions.pod:4593 ../src/guestfs-actions.pod:6948
13678 #: ../fish/guestfish-actions.pod:4595 ../src/guestfs-actions.pod:6950
13679 msgid "Single 8-bit-byte characters."
13683 #: ../fish/guestfish-actions.pod:4597 ../src/guestfs-actions.pod:6952
13688 #: ../fish/guestfish-actions.pod:4599 ../src/guestfs-actions.pod:6954
13689 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13693 #: ../fish/guestfish-actions.pod:4602 ../src/guestfs-actions.pod:6957
13694 msgid "l (lower case letter L)"
13698 #: ../fish/guestfish-actions.pod:4604 ../src/guestfs-actions.pod:6959
13700 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13701 "examining binaries in Windows guests."
13705 #: ../fish/guestfish-actions.pod:4607 ../src/guestfs-actions.pod:6962
13710 #: ../fish/guestfish-actions.pod:4609 ../src/guestfs-actions.pod:6964
13711 msgid "32-bit big endian such as UCS-4BE."
13715 #: ../fish/guestfish-actions.pod:4611 ../src/guestfs-actions.pod:6966
13720 #: ../fish/guestfish-actions.pod:4613 ../src/guestfs-actions.pod:6968
13721 msgid "32-bit little endian such as UCS-4LE."
13725 #: ../fish/guestfish-actions.pod:4617 ../src/guestfs-actions.pod:6972
13726 msgid "The returned strings are transcoded to UTF-8."
13730 #: ../fish/guestfish-actions.pod:4622
13731 msgid "swapoff-device"
13735 #: ../fish/guestfish-actions.pod:4624
13738 " swapoff-device device\n"
13743 #: ../fish/guestfish-actions.pod:4626
13745 "This command disables the libguestfs appliance swap device or partition "
13746 "named C<device>. See L</swapon-device>."
13750 #: ../fish/guestfish-actions.pod:4630
13751 msgid "swapoff-file"
13755 #: ../fish/guestfish-actions.pod:4632
13758 " swapoff-file file\n"
13763 #: ../fish/guestfish-actions.pod:4634 ../src/guestfs-actions.pod:7003
13764 msgid "This command disables the libguestfs appliance swap on file."
13768 #: ../fish/guestfish-actions.pod:4636
13769 msgid "swapoff-label"
13773 #: ../fish/guestfish-actions.pod:4638
13776 " swapoff-label label\n"
13781 #: ../fish/guestfish-actions.pod:4640 ../src/guestfs-actions.pod:7015
13783 "This command disables the libguestfs appliance swap on labeled swap "
13788 #: ../fish/guestfish-actions.pod:4643
13789 msgid "swapoff-uuid"
13793 #: ../fish/guestfish-actions.pod:4645
13796 " swapoff-uuid uuid\n"
13801 #: ../fish/guestfish-actions.pod:4647 ../src/guestfs-actions.pod:7028
13803 "This command disables the libguestfs appliance swap partition with the given "
13808 #: ../fish/guestfish-actions.pod:4650
13809 msgid "swapon-device"
13813 #: ../fish/guestfish-actions.pod:4652
13816 " swapon-device device\n"
13821 #: ../fish/guestfish-actions.pod:4654
13823 "This command enables the libguestfs appliance to use the swap device or "
13824 "partition named C<device>. The increased memory is made available for all "
13825 "commands, for example those run using L</command> or L</sh>."
13829 #: ../fish/guestfish-actions.pod:4659 ../src/guestfs-actions.pod:7046
13831 "Note that you should not swap to existing guest swap partitions unless you "
13832 "know what you are doing. They may contain hibernation information, or other "
13833 "information that the guest doesn't want you to trash. You also risk leaking "
13834 "information about the host to the guest this way. Instead, attach a new "
13835 "host device to the guest and swap on that."
13839 #: ../fish/guestfish-actions.pod:4666
13840 msgid "swapon-file"
13844 #: ../fish/guestfish-actions.pod:4668
13847 " swapon-file file\n"
13852 #: ../fish/guestfish-actions.pod:4670
13853 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
13857 #: ../fish/guestfish-actions.pod:4673
13858 msgid "swapon-label"
13862 #: ../fish/guestfish-actions.pod:4675
13865 " swapon-label label\n"
13870 #: ../fish/guestfish-actions.pod:4677
13872 "This command enables swap to a labeled swap partition. See "
13873 "L</swapon-device> for other notes."
13877 #: ../fish/guestfish-actions.pod:4680
13878 msgid "swapon-uuid"
13882 #: ../fish/guestfish-actions.pod:4682
13885 " swapon-uuid uuid\n"
13890 #: ../fish/guestfish-actions.pod:4684
13892 "This command enables swap to a swap partition with the given UUID. See "
13893 "L</swapon-device> for other notes."
13897 #: ../fish/guestfish-actions.pod:4687
13902 #: ../fish/guestfish-actions.pod:4689
13910 #: ../fish/guestfish-actions.pod:4691 ../src/guestfs-actions.pod:7101
13912 "This syncs the disk, so that any writes are flushed through to the "
13913 "underlying disk image."
13917 #: ../fish/guestfish-actions.pod:4694 ../src/guestfs-actions.pod:7104
13919 "You should always call this if you have modified a disk image, before "
13920 "closing the handle."
13924 #: ../fish/guestfish-actions.pod:4697
13929 #: ../fish/guestfish-actions.pod:4699
13937 #: ../fish/guestfish-actions.pod:4701 ../src/guestfs-actions.pod:7117
13938 msgid "This command returns up to the last 10 lines of a file as a list of strings."
13942 #: ../fish/guestfish-actions.pod:4707
13947 #: ../fish/guestfish-actions.pod:4709
13950 " tail-n nrlines path\n"
13955 #: ../fish/guestfish-actions.pod:4711 ../src/guestfs-actions.pod:7136
13957 "If the parameter C<nrlines> is a positive number, this returns the last "
13958 "C<nrlines> lines of the file C<path>."
13962 #: ../fish/guestfish-actions.pod:4714 ../src/guestfs-actions.pod:7139
13964 "If the parameter C<nrlines> is a negative number, this returns lines from "
13965 "the file C<path>, starting with the C<-nrlines>th line."
13969 #: ../fish/guestfish-actions.pod:4722
13974 #: ../fish/guestfish-actions.pod:4724
13977 " tar-in (tarfile|-) directory\n"
13982 #: ../fish/guestfish-actions.pod:4726 ../src/guestfs-actions.pod:7160
13984 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
13985 "tar file) into C<directory>."
13989 #: ../fish/guestfish-actions.pod:4729
13990 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
13994 #: ../fish/guestfish-actions.pod:4734
13999 #: ../fish/guestfish-actions.pod:4736
14002 " tar-out directory (tarfile|-)\n"
14007 #: ../fish/guestfish-actions.pod:4738 ../src/guestfs-actions.pod:7177
14009 "This command packs the contents of C<directory> and downloads it to local "
14014 #: ../fish/guestfish-actions.pod:4741
14015 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
14019 #: ../fish/guestfish-actions.pod:4746
14024 #: ../fish/guestfish-actions.pod:4748
14027 " tgz-in (tarball|-) directory\n"
14032 #: ../fish/guestfish-actions.pod:4750 ../src/guestfs-actions.pod:7194
14034 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
14035 "tar file) into C<directory>."
14039 #: ../fish/guestfish-actions.pod:4753
14040 msgid "To upload an uncompressed tarball, use L</tar-in>."
14044 #: ../fish/guestfish-actions.pod:4757
14049 #: ../fish/guestfish-actions.pod:4759
14052 " tgz-out directory (tarball|-)\n"
14057 #: ../fish/guestfish-actions.pod:4761 ../src/guestfs-actions.pod:7210
14059 "This command packs the contents of C<directory> and downloads it to local "
14064 #: ../fish/guestfish-actions.pod:4764
14065 msgid "To download an uncompressed tarball, use L</tar-out>."
14069 #: ../fish/guestfish-actions.pod:4768
14074 #: ../fish/guestfish-actions.pod:4770
14082 #: ../fish/guestfish-actions.pod:4772 ../src/guestfs-actions.pod:7225
14084 "Touch acts like the L<touch(1)> command. It can be used to update the "
14085 "timestamps on a file, or, if the file does not exist, to create a new "
14086 "zero-length file."
14090 #: ../fish/guestfish-actions.pod:4776 ../src/guestfs-actions.pod:7229
14092 "This command only works on regular files, and will fail on other file types "
14093 "such as directories, symbolic links, block special etc."
14097 #: ../fish/guestfish-actions.pod:4779
14102 #: ../fish/guestfish-actions.pod:4781
14110 #: ../fish/guestfish-actions.pod:4783 ../src/guestfs-actions.pod:7242
14112 "This command truncates C<path> to a zero-length file. The file must exist "
14117 #: ../fish/guestfish-actions.pod:4786
14118 msgid "truncate-size"
14122 #: ../fish/guestfish-actions.pod:4788
14125 " truncate-size path size\n"
14130 #: ../fish/guestfish-actions.pod:4790 ../src/guestfs-actions.pod:7256
14132 "This command truncates C<path> to size C<size> bytes. The file must exist "
14137 #: ../fish/guestfish-actions.pod:4793
14139 "If the current file size is less than C<size> then the file is extended to "
14140 "the required size with zero bytes. This creates a sparse file (ie. disk "
14141 "blocks are not allocated for the file until you write to it). To create a "
14142 "non-sparse file of zeroes, use L</fallocate64> instead."
14146 #: ../fish/guestfish-actions.pod:4799
14151 #: ../fish/guestfish-actions.pod:4801
14154 " tune2fs-l device\n"
14159 #: ../fish/guestfish-actions.pod:4803 ../src/guestfs-actions.pod:7275
14161 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
14166 #: ../fish/guestfish-actions.pod:4806 ../src/guestfs-actions.pod:7278
14168 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
14169 "for more details. The list of fields returned isn't clearly defined, and "
14170 "depends on both the version of C<tune2fs> that libguestfs was built against, "
14171 "and the filesystem itself."
14175 #: ../fish/guestfish-actions.pod:4811
14180 #: ../fish/guestfish-actions.pod:4813
14183 " txz-in (tarball|-) directory\n"
14188 #: ../fish/guestfish-actions.pod:4815 ../src/guestfs-actions.pod:7298
14190 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
14191 "tar file) into C<directory>."
14195 #: ../fish/guestfish-actions.pod:4820
14200 #: ../fish/guestfish-actions.pod:4822
14203 " txz-out directory (tarball|-)\n"
14208 #: ../fish/guestfish-actions.pod:4824 ../src/guestfs-actions.pod:7312
14210 "This command packs the contents of C<directory> and downloads it to local "
14211 "file C<tarball> (as an xz compressed tar archive)."
14215 #: ../fish/guestfish-actions.pod:4829
14220 #: ../fish/guestfish-actions.pod:4831
14228 #: ../fish/guestfish-actions.pod:4833 ../src/guestfs-actions.pod:7325
14230 "This function sets the mask used for creating new files and device nodes to "
14235 #: ../fish/guestfish-actions.pod:4836 ../src/guestfs-actions.pod:7328
14237 "Typical umask values would be C<022> which creates new files with "
14238 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
14239 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
14243 #: ../fish/guestfish-actions.pod:4841 ../src/guestfs-actions.pod:7333
14245 "The default umask is C<022>. This is important because it means that "
14246 "directories and device nodes will be created with C<0644> or C<0755> mode "
14247 "even if you specify C<0777>."
14251 #: ../fish/guestfish-actions.pod:4845
14252 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
14256 #: ../fish/guestfish-actions.pod:4848 ../src/guestfs-actions.pod:7340
14257 msgid "This call returns the previous umask."
14261 #: ../fish/guestfish-actions.pod:4850
14266 #: ../fish/guestfish-actions.pod:4852
14271 #: ../fish/guestfish-actions.pod:4854
14274 " umount pathordevice\n"
14279 #: ../fish/guestfish-actions.pod:4856 ../src/guestfs-actions.pod:7352
14281 "This unmounts the given filesystem. The filesystem may be specified either "
14282 "by its mountpoint (path) or the device which contains the filesystem."
14286 #: ../fish/guestfish-actions.pod:4860
14291 #: ../fish/guestfish-actions.pod:4862
14292 msgid "unmount-all"
14296 #: ../fish/guestfish-actions.pod:4864
14304 #: ../fish/guestfish-actions.pod:4866 ../src/guestfs-actions.pod:7365
14305 msgid "This unmounts all mounted filesystems."
14309 #: ../fish/guestfish-actions.pod:4868 ../src/guestfs-actions.pod:7367
14310 msgid "Some internal mounts are not unmounted by this call."
14314 #: ../fish/guestfish-actions.pod:4870
14319 #: ../fish/guestfish-actions.pod:4872
14322 " upload (filename|-) remotefilename\n"
14327 #: ../fish/guestfish-actions.pod:4874 ../fish/guestfish-actions.pod:4887 ../src/guestfs-actions.pod:7380 ../src/guestfs-actions.pod:7404
14328 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14332 #: ../fish/guestfish-actions.pod:4879
14333 msgid "See also L</download>."
14337 #: ../fish/guestfish-actions.pod:4883
14338 msgid "upload-offset"
14342 #: ../fish/guestfish-actions.pod:4885
14345 " upload-offset (filename|-) remotefilename offset\n"
14350 #: ../fish/guestfish-actions.pod:4890 ../src/guestfs-actions.pod:7407
14352 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14353 "The intention is to overwrite parts of existing files or devices, although "
14354 "if a non-existant file is specified then it is created with a \"hole\" "
14355 "before C<offset>. The size of the data written is implicit in the size of "
14356 "the source C<filename>."
14360 #: ../fish/guestfish-actions.pod:4897
14362 "Note that there is no limit on the amount of data that can be uploaded with "
14363 "this call, unlike with L</pwrite>, and this call always writes the full "
14364 "amount unless an error occurs."
14368 #: ../fish/guestfish-actions.pod:4902
14369 msgid "See also L</upload>, L</pwrite>."
14373 #: ../fish/guestfish-actions.pod:4906
14378 #: ../fish/guestfish-actions.pod:4908
14381 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
14386 #: ../fish/guestfish-actions.pod:4910 ../src/guestfs-actions.pod:7440
14387 msgid "This command sets the timestamps of a file with nanosecond precision."
14391 #: ../fish/guestfish-actions.pod:4913 ../src/guestfs-actions.pod:7443
14393 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14398 #: ../fish/guestfish-actions.pod:4916 ../src/guestfs-actions.pod:7446
14400 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14401 "nanoseconds from the epoch."
14405 #: ../fish/guestfish-actions.pod:4919 ../src/guestfs-actions.pod:7449
14407 "If the C<*nsecs> field contains the special value C<-1> then the "
14408 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14409 "ignored in this case)."
14413 #: ../fish/guestfish-actions.pod:4923 ../src/guestfs-actions.pod:7453
14415 "If the C<*nsecs> field contains the special value C<-2> then the "
14416 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14421 #: ../fish/guestfish-actions.pod:4927
14426 #: ../fish/guestfish-actions.pod:4929
14434 #: ../fish/guestfish-actions.pod:4931 ../src/guestfs-actions.pod:7466
14435 msgid "Return the libguestfs version number that the program is linked against."
14439 #: ../fish/guestfish-actions.pod:4934 ../src/guestfs-actions.pod:7469
14441 "Note that because of dynamic linking this is not necessarily the version of "
14442 "libguestfs that you compiled against. You can compile the program, and then "
14443 "at runtime dynamically link against a completely different C<libguestfs.so> "
14448 #: ../fish/guestfish-actions.pod:4939 ../src/guestfs-actions.pod:7474
14450 "This call was added in version C<1.0.58>. In previous versions of "
14451 "libguestfs there was no way to get the version number. From C code you can "
14452 "use dynamic linker functions to find out if this symbol exists (if it "
14453 "doesn't, then it's an earlier version)."
14457 #: ../fish/guestfish-actions.pod:4945 ../src/guestfs-actions.pod:7480
14459 "The call returns a structure with four elements. The first three (C<major>, "
14460 "C<minor> and C<release>) are numbers and correspond to the usual version "
14461 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14462 "but may be used for distro-specific information."
14466 #: ../fish/guestfish-actions.pod:4951 ../src/guestfs-actions.pod:7486
14467 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
14471 #: ../fish/guestfish-actions.pod:4954 ../src/guestfs-actions.pod:7489
14472 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14476 #: ../fish/guestfish-actions.pod:4956
14478 "I<Note:> Don't use this call to test for availability of features. In "
14479 "enterprise distributions we backport features from later versions into "
14480 "earlier versions, making this an unreliable way to test for features. Use "
14481 "L</available> instead."
14485 #: ../fish/guestfish-actions.pod:4962
14490 #: ../fish/guestfish-actions.pod:4964
14493 " vfs-label device\n"
14498 #: ../fish/guestfish-actions.pod:4966 ../src/guestfs-actions.pod:7509
14499 msgid "This returns the filesystem label of the filesystem on C<device>."
14503 #: ../fish/guestfish-actions.pod:4969 ../src/guestfs-actions.pod:7512
14504 msgid "If the filesystem is unlabeled, this returns the empty string."
14508 #: ../fish/guestfish-actions.pod:4971
14509 msgid "To find a filesystem from the label, use L</findfs-label>."
14513 #: ../fish/guestfish-actions.pod:4973
14518 #: ../fish/guestfish-actions.pod:4975
14521 " vfs-type device\n"
14526 #: ../fish/guestfish-actions.pod:4977 ../src/guestfs-actions.pod:7527
14528 "This command gets the filesystem type corresponding to the filesystem on "
14533 #: ../fish/guestfish-actions.pod:4980 ../src/guestfs-actions.pod:7530
14535 "For most filesystems, the result is the name of the Linux VFS module which "
14536 "would be used to mount this filesystem if you mounted it without specifying "
14537 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14541 #: ../fish/guestfish-actions.pod:4985
14546 #: ../fish/guestfish-actions.pod:4987
14549 " vfs-uuid device\n"
14554 #: ../fish/guestfish-actions.pod:4989 ../src/guestfs-actions.pod:7546
14555 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14559 #: ../fish/guestfish-actions.pod:4992 ../src/guestfs-actions.pod:7549
14560 msgid "If the filesystem does not have a UUID, this returns the empty string."
14564 #: ../fish/guestfish-actions.pod:4994
14565 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
14569 #: ../fish/guestfish-actions.pod:4996
14570 msgid "vg-activate"
14574 #: ../fish/guestfish-actions.pod:4998
14577 " vg-activate true|false 'volgroups ...'\n"
14582 #: ../fish/guestfish-actions.pod:5000 ../src/guestfs-actions.pod:7565
14584 "This command activates or (if C<activate> is false) deactivates all logical "
14585 "volumes in the listed volume groups C<volgroups>."
14589 #: ../fish/guestfish-actions.pod:5003 ../src/guestfs-actions.pod:7568
14590 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14594 #: ../fish/guestfish-actions.pod:5005 ../src/guestfs-actions.pod:7570
14596 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14597 "activated or deactivated."
14601 #: ../fish/guestfish-actions.pod:5008
14602 msgid "vg-activate-all"
14606 #: ../fish/guestfish-actions.pod:5010
14609 " vg-activate-all true|false\n"
14614 #: ../fish/guestfish-actions.pod:5012 ../src/guestfs-actions.pod:7583
14616 "This command activates or (if C<activate> is false) deactivates all logical "
14617 "volumes in all volume groups."
14621 #: ../fish/guestfish-actions.pod:5015 ../src/guestfs-actions.pod:7586
14622 msgid "This command is the same as running C<vgchange -a y|n>"
14626 #: ../fish/guestfish-actions.pod:5017
14631 #: ../fish/guestfish-actions.pod:5019
14634 " vgcreate volgroup 'physvols ...'\n"
14639 #: ../fish/guestfish-actions.pod:5021 ../src/guestfs-actions.pod:7599
14641 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14642 "of physical volumes C<physvols>."
14646 #: ../fish/guestfish-actions.pod:5024
14651 #: ../fish/guestfish-actions.pod:5026
14654 " vglvuuids vgname\n"
14659 #: ../fish/guestfish-actions.pod:5028 ../src/guestfs-actions.pod:7612
14661 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14662 "volumes created in this volume group."
14666 #: ../fish/guestfish-actions.pod:5031
14668 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
14669 "logical volumes and volume groups."
14673 #: ../fish/guestfish-actions.pod:5034
14674 msgid "See also L</vgpvuuids>."
14678 #: ../fish/guestfish-actions.pod:5036
14683 #: ../fish/guestfish-actions.pod:5038
14686 " vgpvuuids vgname\n"
14691 #: ../fish/guestfish-actions.pod:5040 ../src/guestfs-actions.pod:7632
14693 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14694 "volumes that this volume group resides on."
14698 #: ../fish/guestfish-actions.pod:5043
14700 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
14701 "physical volumes and volume groups."
14705 #: ../fish/guestfish-actions.pod:5046
14706 msgid "See also L</vglvuuids>."
14710 #: ../fish/guestfish-actions.pod:5048
14715 #: ../fish/guestfish-actions.pod:5050
14718 " vgremove vgname\n"
14723 #: ../fish/guestfish-actions.pod:5052 ../src/guestfs-actions.pod:7652
14724 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14728 #: ../fish/guestfish-actions.pod:5054 ../src/guestfs-actions.pod:7654
14729 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
14733 #: ../fish/guestfish-actions.pod:5057
14738 #: ../fish/guestfish-actions.pod:5059
14741 " vgrename volgroup newvolgroup\n"
14746 #: ../fish/guestfish-actions.pod:5061 ../src/guestfs-actions.pod:7668
14747 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14751 #: ../fish/guestfish-actions.pod:5063
14756 #: ../fish/guestfish-actions.pod:5065
14764 #: ../fish/guestfish-actions.pod:5067 ../src/guestfs-actions.pod:7679
14766 "List all the volumes groups detected. This is the equivalent of the "
14767 "L<vgs(8)> command."
14771 #: ../fish/guestfish-actions.pod:5070 ../src/guestfs-actions.pod:7682
14773 "This returns a list of just the volume group names that were detected "
14774 "(eg. C<VolGroup00>)."
14778 #: ../fish/guestfish-actions.pod:5073
14779 msgid "See also L</vgs-full>."
14783 #: ../fish/guestfish-actions.pod:5075
14788 #: ../fish/guestfish-actions.pod:5077
14796 #: ../fish/guestfish-actions.pod:5079 ../src/guestfs-actions.pod:7698
14798 "List all the volumes groups detected. This is the equivalent of the "
14799 "L<vgs(8)> command. The \"full\" version includes all fields."
14803 #: ../fish/guestfish-actions.pod:5082
14808 #: ../fish/guestfish-actions.pod:5084
14816 #: ../fish/guestfish-actions.pod:5086 ../src/guestfs-actions.pod:7712
14818 "This rescans all block devices and rebuilds the list of LVM physical "
14819 "volumes, volume groups and logical volumes."
14823 #: ../fish/guestfish-actions.pod:5089
14828 #: ../fish/guestfish-actions.pod:5091
14836 #: ../fish/guestfish-actions.pod:5093 ../src/guestfs-actions.pod:7725
14837 msgid "This command returns the UUID of the LVM VG named C<vgname>."
14841 #: ../fish/guestfish-actions.pod:5095
14846 #: ../fish/guestfish-actions.pod:5097
14854 #: ../fish/guestfish-actions.pod:5099 ../src/guestfs-actions.pod:7765
14856 "This command counts the characters in a file, using the C<wc -c> external "
14861 #: ../fish/guestfish-actions.pod:5102
14866 #: ../fish/guestfish-actions.pod:5104
14874 #: ../fish/guestfish-actions.pod:5106 ../src/guestfs-actions.pod:7778
14876 "This command counts the lines in a file, using the C<wc -l> external "
14881 #: ../fish/guestfish-actions.pod:5109
14886 #: ../fish/guestfish-actions.pod:5111
14894 #: ../fish/guestfish-actions.pod:5113 ../src/guestfs-actions.pod:7791
14896 "This command counts the words in a file, using the C<wc -w> external "
14901 #: ../fish/guestfish-actions.pod:5116
14906 #: ../fish/guestfish-actions.pod:5118
14909 " write path content\n"
14914 #: ../fish/guestfish-actions.pod:5120 ../src/guestfs-actions.pod:7806
14916 "This call creates a file called C<path>. The content of the file is the "
14917 "string C<content> (which can contain any 8 bit data)."
14921 #: ../fish/guestfish-actions.pod:5123
14922 msgid "See also L</write-append>."
14926 #: ../fish/guestfish-actions.pod:5128
14927 msgid "write-append"
14931 #: ../fish/guestfish-actions.pod:5130
14934 " write-append path content\n"
14939 #: ../fish/guestfish-actions.pod:5132 ../src/guestfs-actions.pod:7826
14941 "This call appends C<content> to the end of file C<path>. If C<path> does "
14942 "not exist, then a new file is created."
14946 #: ../fish/guestfish-actions.pod:5135
14947 msgid "See also L</write>."
14951 #: ../fish/guestfish-actions.pod:5140
14956 #: ../fish/guestfish-actions.pod:5142
14959 " write-file path content size\n"
14964 #: ../fish/guestfish-actions.pod:5144 ../src/guestfs-actions.pod:7853
14966 "This call creates a file called C<path>. The contents of the file is the "
14967 "string C<content> (which can contain any 8 bit data), with length C<size>."
14971 #: ../fish/guestfish-actions.pod:5148 ../src/guestfs-actions.pod:7857
14973 "As a special case, if C<size> is C<0> then the length is calculated using "
14974 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
14978 #: ../fish/guestfish-actions.pod:5152 ../src/guestfs-actions.pod:7861
14980 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
14981 "I<not> work, even if the length is specified."
14985 #: ../fish/guestfish-actions.pod:5158
14986 msgid "I<This function is deprecated.> In new code, use the L</write> call instead."
14990 #: ../fish/guestfish-actions.pod:5165
14995 #: ../fish/guestfish-actions.pod:5167
14998 " zegrep regex path\n"
15003 #: ../fish/guestfish-actions.pod:5169 ../src/guestfs-actions.pod:7878
15004 msgid "This calls the external C<zegrep> program and returns the matching lines."
15008 #: ../fish/guestfish-actions.pod:5175
15013 #: ../fish/guestfish-actions.pod:5177
15016 " zegrepi regex path\n"
15021 #: ../fish/guestfish-actions.pod:5179 ../src/guestfs-actions.pod:7897
15022 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
15026 #: ../fish/guestfish-actions.pod:5185
15031 #: ../fish/guestfish-actions.pod:5187
15039 #: ../fish/guestfish-actions.pod:5189 ../src/guestfs-actions.pod:7915
15040 msgid "This command writes zeroes over the first few blocks of C<device>."
15044 #: ../fish/guestfish-actions.pod:5191 ../src/guestfs-actions.pod:7917
15046 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
15047 "securely wipe the device). It should be sufficient to remove any partition "
15048 "tables, filesystem superblocks and so on."
15052 #: ../fish/guestfish-actions.pod:5195 ../fish/guestfish-actions.pod:5210 ../src/guestfs-actions.pod:7921 ../src/guestfs-actions.pod:7947
15054 "If blocks are already zero, then this command avoids writing zeroes. This "
15055 "prevents the underlying device from becoming non-sparse or growing "
15060 #: ../fish/guestfish-actions.pod:5199
15061 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
15065 #: ../fish/guestfish-actions.pod:5202
15066 msgid "zero-device"
15070 #: ../fish/guestfish-actions.pod:5204
15073 " zero-device device\n"
15078 #: ../fish/guestfish-actions.pod:5206
15080 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
15081 "which just zeroes the first few blocks of a device."
15085 #: ../fish/guestfish-actions.pod:5217
15090 #: ../fish/guestfish-actions.pod:5219
15093 " zerofree device\n"
15098 #: ../fish/guestfish-actions.pod:5221 ../src/guestfs-actions.pod:7969
15100 "This runs the I<zerofree> program on C<device>. This program claims to zero "
15101 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
15102 "possible to compress the filesystem more effectively."
15106 #: ../fish/guestfish-actions.pod:5226 ../src/guestfs-actions.pod:7974
15107 msgid "You should B<not> run this program if the filesystem is mounted."
15111 #: ../fish/guestfish-actions.pod:5229 ../src/guestfs-actions.pod:7977
15113 "It is possible that using this program can damage the filesystem or data on "
15118 #: ../fish/guestfish-actions.pod:5232
15123 #: ../fish/guestfish-actions.pod:5234
15126 " zfgrep pattern path\n"
15131 #: ../fish/guestfish-actions.pod:5236 ../src/guestfs-actions.pod:7991
15132 msgid "This calls the external C<zfgrep> program and returns the matching lines."
15136 #: ../fish/guestfish-actions.pod:5242
15141 #: ../fish/guestfish-actions.pod:5244
15144 " zfgrepi pattern path\n"
15149 #: ../fish/guestfish-actions.pod:5246 ../src/guestfs-actions.pod:8010
15150 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
15154 #: ../fish/guestfish-actions.pod:5252
15159 #: ../fish/guestfish-actions.pod:5254
15162 " zfile meth path\n"
15167 #: ../fish/guestfish-actions.pod:5256 ../src/guestfs-actions.pod:8036
15168 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
15172 #: ../fish/guestfish-actions.pod:5259 ../src/guestfs-actions.pod:8039
15173 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
15177 #: ../fish/guestfish-actions.pod:5261
15178 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
15182 #: ../fish/guestfish-actions.pod:5264
15183 msgid "I<This function is deprecated.> In new code, use the L</file> call instead."
15187 #: ../fish/guestfish-actions.pod:5271
15192 #: ../fish/guestfish-actions.pod:5273
15195 " zgrep regex path\n"
15200 #: ../fish/guestfish-actions.pod:5275 ../src/guestfs-actions.pod:8056
15201 msgid "This calls the external C<zgrep> program and returns the matching lines."
15205 #: ../fish/guestfish-actions.pod:5281
15210 #: ../fish/guestfish-actions.pod:5283
15213 " zgrepi regex path\n"
15218 #: ../fish/guestfish-actions.pod:5285 ../src/guestfs-actions.pod:8075
15219 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
15223 #: ../fish/guestfish-commands.pod:1
15228 #: ../fish/guestfish-commands.pod:3
15233 #: ../fish/guestfish-commands.pod:5
15236 " alloc filename size\n"
15241 #: ../fish/guestfish-commands.pod:7
15243 "This creates an empty (zeroed) file of the given size, and then adds so it "
15244 "can be further examined."
15248 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:193
15249 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
15253 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:195
15254 msgid "Size can be specified using standard suffixes, eg. C<1M>."
15258 #: ../fish/guestfish-commands.pod:14
15260 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
15261 "image, see L</PREPARED DISK IMAGES>."
15265 #: ../fish/guestfish-commands.pod:17
15270 #: ../fish/guestfish-commands.pod:19
15273 " copy-in local [local ...] /remotedir\n"
15278 #: ../fish/guestfish-commands.pod:21
15280 "C<copy-in> copies local files or directories recursively into the disk "
15281 "image, placing them in the directory called C</remotedir> (which must "
15282 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
15283 "other commands as necessary."
15287 #: ../fish/guestfish-commands.pod:26
15289 "Multiple local files and directories can be specified, but the last "
15290 "parameter must always be a remote directory. Wildcards cannot be used."
15294 #: ../fish/guestfish-commands.pod:30
15299 #: ../fish/guestfish-commands.pod:32
15302 " copy-out remote [remote ...] localdir\n"
15307 #: ../fish/guestfish-commands.pod:34
15309 "C<copy-out> copies remote files or directories recursively out of the disk "
15310 "image, placing them on the host disk in a local directory called C<localdir> "
15311 "(which must exist). This guestfish meta-command turns into a sequence of "
15312 "L</download>, L</tar-out> and other commands as necessary."
15316 #: ../fish/guestfish-commands.pod:40
15318 "Multiple remote files and directories can be specified, but the last "
15319 "parameter must always be a local directory. To download to the current "
15320 "directory, use C<.> as in:"
15324 #: ../fish/guestfish-commands.pod:44
15327 " copy-out /home .\n"
15332 #: ../fish/guestfish-commands.pod:46
15334 "Wildcards cannot be used in the ordinary command, but you can use them with "
15335 "the help of L</glob> like this:"
15339 #: ../fish/guestfish-commands.pod:49
15342 " glob copy-out /home/* .\n"
15347 #: ../fish/guestfish-commands.pod:51
15352 #: ../fish/guestfish-commands.pod:53
15355 " display filename\n"
15360 #: ../fish/guestfish-commands.pod:55
15362 "Use C<display> (a graphical display program) to display an image file. It "
15363 "downloads the file, and runs C<display> on it."
15367 #: ../fish/guestfish-commands.pod:58
15369 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
15370 "environment variable. For example to use the GNOME display program:"
15374 #: ../fish/guestfish-commands.pod:61
15377 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
15382 #: ../fish/guestfish-commands.pod:63
15383 msgid "See also L<display(1)>."
15387 #: ../fish/guestfish-commands.pod:65
15392 #: ../fish/guestfish-commands.pod:67
15395 " echo [params ...]\n"
15400 #: ../fish/guestfish-commands.pod:69
15401 msgid "This echos the parameters to the terminal."
15405 #: ../fish/guestfish-commands.pod:71
15410 #: ../fish/guestfish-commands.pod:73
15415 #: ../fish/guestfish-commands.pod:75
15420 #: ../fish/guestfish-commands.pod:77
15428 #: ../fish/guestfish-commands.pod:79
15430 "This is used to edit a file. It downloads the file, edits it locally using "
15431 "your editor, then uploads the result."
15435 #: ../fish/guestfish-commands.pod:82
15437 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
15438 "or C<emacs> you will get those corresponding editors."
15442 #: ../fish/guestfish-commands.pod:86
15447 #: ../fish/guestfish-commands.pod:88
15450 " glob command args...\n"
15455 #: ../fish/guestfish-commands.pod:90
15457 "Expand wildcards in any paths in the args list, and run C<command> "
15458 "repeatedly on each matching path."
15462 #: ../fish/guestfish-commands.pod:93
15463 msgid "See L</WILDCARDS AND GLOBBING>."
15467 #: ../fish/guestfish-commands.pod:95
15472 #: ../fish/guestfish-commands.pod:97
15475 " hexedit <filename|device>\n"
15476 " hexedit <filename|device> <max>\n"
15477 " hexedit <filename|device> <start> <max>\n"
15482 #: ../fish/guestfish-commands.pod:101
15484 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
15489 #: ../fish/guestfish-commands.pod:104
15491 "This command works by downloading potentially the whole file or device, "
15492 "editing it locally, then uploading it. If the file or device is large, you "
15493 "have to specify which part you wish to edit by using C<max> and/or C<start> "
15494 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
15495 "usual modifiers allowed such as C<1M> (1 megabyte)."
15499 #: ../fish/guestfish-commands.pod:111
15500 msgid "For example to edit the first few sectors of a disk you might do:"
15504 #: ../fish/guestfish-commands.pod:114
15507 " hexedit /dev/sda 1M\n"
15512 #: ../fish/guestfish-commands.pod:116
15514 "which would allow you to edit anywhere within the first megabyte of the "
15519 #: ../fish/guestfish-commands.pod:119
15520 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
15524 #: ../fish/guestfish-commands.pod:121
15527 " hexedit /dev/sda1 0x400 0x400\n"
15532 #: ../fish/guestfish-commands.pod:123
15533 msgid "(assuming the superblock is in the standard location)."
15537 #: ../fish/guestfish-commands.pod:125
15539 "This command requires the external L<hexedit(1)> program. You can specify "
15540 "another program to use by setting the C<HEXEDITOR> environment variable."
15544 #: ../fish/guestfish-commands.pod:129
15545 msgid "See also L</hexdump>."
15549 #: ../fish/guestfish-commands.pod:131
15554 #: ../fish/guestfish-commands.pod:133
15562 #: ../fish/guestfish-commands.pod:135
15563 msgid "Change the local directory, ie. the current directory of guestfish itself."
15567 #: ../fish/guestfish-commands.pod:138
15568 msgid "Note that C<!cd> won't do what you might expect."
15572 #: ../fish/guestfish-commands.pod:140
15577 #: ../fish/guestfish-commands.pod:142
15582 #: ../fish/guestfish-commands.pod:144
15590 #: ../fish/guestfish-commands.pod:146
15591 msgid "Opens the manual page for guestfish."
15595 #: ../fish/guestfish-commands.pod:148
15600 #: ../fish/guestfish-commands.pod:150
15605 #: ../fish/guestfish-commands.pod:152
15613 #: ../fish/guestfish-commands.pod:154
15621 #: ../fish/guestfish-commands.pod:156
15622 msgid "This is used to view a file."
15626 #: ../fish/guestfish-commands.pod:158
15628 "The default viewer is C<$PAGER>. However if you use the alternate command "
15629 "C<less> you will get the C<less> command specifically."
15633 #: ../fish/guestfish-commands.pod:161
15638 #: ../fish/guestfish-commands.pod:163
15646 #: ../fish/guestfish-commands.pod:165
15648 "Close and reopen the libguestfs handle. It is not necessary to use this "
15649 "normally, because the handle is closed properly when guestfish exits. "
15650 "However this is occasionally useful for testing."
15654 #: ../fish/guestfish-commands.pod:169
15659 #: ../fish/guestfish-commands.pod:171
15662 " setenv VAR value\n"
15667 #: ../fish/guestfish-commands.pod:173
15668 msgid "Set the environment variable C<VAR> to the string C<value>."
15672 #: ../fish/guestfish-commands.pod:175
15673 msgid "To print the value of an environment variable use a shell command such as:"
15677 #: ../fish/guestfish-commands.pod:178
15685 #: ../fish/guestfish-commands.pod:180
15690 #: ../fish/guestfish-commands.pod:182
15693 " sparse filename size\n"
15698 #: ../fish/guestfish-commands.pod:184
15700 "This creates an empty sparse file of the given size, and then adds so it can "
15701 "be further examined."
15705 #: ../fish/guestfish-commands.pod:187
15707 "In all respects it works the same as the L</alloc> command, except that the "
15708 "image file is allocated sparsely, which means that disk blocks are not "
15709 "assigned to the file until they are needed. Sparse disk files only use "
15710 "space when written to, but they are slower and there is a danger you could "
15711 "run out of real disk space during a write operation."
15715 #: ../fish/guestfish-commands.pod:197
15720 #: ../fish/guestfish-commands.pod:199
15728 #: ../fish/guestfish-commands.pod:201
15730 "This command returns a list of the optional groups known to the daemon, and "
15731 "indicates which ones are supported by this build of the libguestfs "
15736 #: ../fish/guestfish-commands.pod:205
15737 msgid "See also L<guestfs(3)/AVAILABILITY>."
15741 #: ../fish/guestfish-commands.pod:207
15746 #: ../fish/guestfish-commands.pod:209
15749 " time command args...\n"
15754 #: ../fish/guestfish-commands.pod:211
15756 "Run the command as usual, but print the elapsed time afterwards. This can "
15757 "be useful for benchmarking operations."
15761 #: ../fish/guestfish-commands.pod:214
15766 #: ../fish/guestfish-commands.pod:216
15774 #: ../fish/guestfish-commands.pod:218
15775 msgid "Remove C<VAR> from the environment."
15779 #: ../fish/guestfish.pod:5
15780 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
15784 #: ../fish/guestfish.pod:9
15787 " guestfish [--options] [commands]\n"
15792 #: ../fish/guestfish.pod:11
15800 #: ../fish/guestfish.pod:13
15803 " guestfish [--ro|--rw] -a disk.img\n"
15808 #: ../fish/guestfish.pod:15
15811 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
15816 #: ../fish/guestfish.pod:17
15819 " guestfish -d libvirt-domain\n"
15824 #: ../fish/guestfish.pod:19
15827 " guestfish [--ro|--rw] -a disk.img -i\n"
15832 #: ../fish/guestfish.pod:21
15835 " guestfish -d libvirt-domain -i\n"
15840 #: ../fish/guestfish.pod:25
15842 "Using guestfish in read/write mode on live virtual machines can be "
15843 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
15844 "option to use guestfish safely if the disk image or virtual machine might be "
15849 #: ../fish/guestfish.pod:32
15851 "Guestfish is a shell and command-line tool for examining and modifying "
15852 "virtual machine filesystems. It uses libguestfs and exposes all of the "
15853 "functionality of the guestfs API, see L<guestfs(3)>."
15857 #: ../fish/guestfish.pod:36
15859 "Guestfish gives you structured access to the libguestfs API, from shell "
15860 "scripts or the command line or interactively. If you want to rescue a "
15861 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
15866 #: ../fish/guestfish.pod:43
15867 msgid "As an interactive shell"
15871 #: ../fish/guestfish.pod:45
15879 #: ../fish/guestfish.pod:47
15882 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
15883 " editing virtual machine filesystems.\n"
15888 #: ../fish/guestfish.pod:50
15891 " Type: 'help' for a list of commands\n"
15892 " 'man' to read the manual\n"
15893 " 'quit' to quit the shell\n"
15898 #: ../fish/guestfish.pod:54
15901 " ><fs> add-ro disk.img\n"
15903 " ><fs> list-filesystems\n"
15904 " /dev/sda1: ext4\n"
15905 " /dev/vg_guest/lv_root: ext4\n"
15906 " /dev/vg_guest/lv_swap: swap\n"
15907 " ><fs> mount /dev/vg_guest/lv_root /\n"
15908 " ><fs> cat /etc/fstab\n"
15910 " # Created by anaconda\n"
15917 #: ../fish/guestfish.pod:67
15918 msgid "From shell scripts"
15922 #: ../fish/guestfish.pod:69
15923 msgid "Create a new C</etc/motd> file in a guest or disk image:"
15927 #: ../fish/guestfish.pod:71
15930 " guestfish <<_EOF_\n"
15933 " mount /dev/vg_guest/lv_root /\n"
15934 " write /etc/motd \"Welcome, new users\"\n"
15940 #: ../fish/guestfish.pod:78
15941 msgid "List the LVM logical volumes in a disk image:"
15945 #: ../fish/guestfish.pod:80
15948 " guestfish -a disk.img --ro <<_EOF_\n"
15956 #: ../fish/guestfish.pod:85
15957 msgid "List all the filesystems in a disk image:"
15961 #: ../fish/guestfish.pod:87
15964 " guestfish -a disk.img --ro <<_EOF_\n"
15966 " list-filesystems\n"
15972 #: ../fish/guestfish.pod:92
15973 msgid "On one command line"
15977 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
15978 msgid "Update C</etc/resolv.conf> in a guest:"
15982 #: ../fish/guestfish.pod:96
15986 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
15987 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
15992 #: ../fish/guestfish.pod:100
15993 msgid "Edit C</boot/grub/grub.conf> interactively:"
15997 #: ../fish/guestfish.pod:102
16000 " guestfish --rw --add disk.img \\\n"
16001 " --mount /dev/vg_guest/lv_root \\\n"
16002 " --mount /dev/sda1:/boot \\\n"
16003 " edit /boot/grub/grub.conf\n"
16008 #: ../fish/guestfish.pod:107
16009 msgid "Mount disks automatically"
16013 #: ../fish/guestfish.pod:109
16015 "Use the I<-i> option to automatically mount the disks from a virtual "
16020 #: ../fish/guestfish.pod:112
16023 " guestfish --ro -a disk.img -i cat /etc/group\n"
16028 #: ../fish/guestfish.pod:114
16031 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
16036 #: ../fish/guestfish.pod:116
16037 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
16041 #: ../fish/guestfish.pod:118
16044 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
16049 #: ../fish/guestfish.pod:120
16050 msgid "As a script interpreter"
16054 #: ../fish/guestfish.pod:122
16055 msgid "Create a 100MB disk containing an ext2-formatted partition:"
16059 #: ../fish/guestfish.pod:124
16062 " #!/usr/bin/guestfish -f\n"
16063 " sparse test1.img 100M\n"
16065 " part-disk /dev/sda mbr\n"
16066 " mkfs ext2 /dev/sda1\n"
16071 #: ../fish/guestfish.pod:130
16072 msgid "Start with a prepared disk"
16076 #: ../fish/guestfish.pod:132
16078 "An alternate way to create a 100MB disk called C<test1.img> containing a "
16079 "single ext2-formatted partition:"
16083 #: ../fish/guestfish.pod:135
16086 " guestfish -N fs\n"
16091 #: ../fish/guestfish.pod:137
16092 msgid "To list what is available do:"
16096 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:1009
16099 " guestfish -N help | less\n"
16104 #: ../fish/guestfish.pod:141
16105 msgid "Remote control"
16109 #: ../fish/guestfish.pod:143
16112 " eval \"`guestfish --listen`\"\n"
16113 " guestfish --remote add-ro disk.img\n"
16114 " guestfish --remote run\n"
16115 " guestfish --remote lvs\n"
16120 #: ../fish/guestfish.pod:154
16121 msgid "Displays general help on options."
16125 #: ../fish/guestfish.pod:158
16126 msgid "B<--cmd-help>"
16130 #: ../fish/guestfish.pod:160
16131 msgid "Lists all available guestfish commands."
16135 #: ../fish/guestfish.pod:162
16140 #: ../fish/guestfish.pod:164
16141 msgid "B<--cmd-help cmd>"
16145 #: ../fish/guestfish.pod:166
16146 msgid "Displays detailed help on a single command C<cmd>."
16150 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:87
16151 msgid "B<-a image>"
16155 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:89
16156 msgid "B<--add image>"
16160 #: ../fish/guestfish.pod:172
16161 msgid "Add a block device or virtual machine image to the shell."
16165 #: ../fish/guestfish.pod:177
16167 "Using this flag is mostly equivalent to using the C<add> command, with "
16168 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
16169 "the I<--format=...> flag was given."
16173 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:100
16175 "When used in conjunction with the I<-d> option, this specifies the libvirt "
16176 "URI to use. The default is to use the default libvirt connection."
16180 #: ../fish/guestfish.pod:189
16185 #: ../fish/guestfish.pod:191
16187 "If using the I<--listen> option and a csh-like shell, use this option. See "
16188 "section L</REMOTE CONTROL AND CSH> below."
16192 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:104
16193 msgid "B<-d libvirt-domain>"
16197 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:106
16198 msgid "B<--domain libvirt-domain>"
16202 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:108
16204 "Add disks from the named libvirt domain. If the I<--ro> option is also "
16205 "used, then any libvirt domain can be used. However in write mode, only "
16206 "libvirt domains which are shut down can be named here."
16210 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:112
16211 msgid "Domain UUIDs can be used instead of names."
16215 #: ../fish/guestfish.pod:204
16217 "Using this flag is mostly equivalent to using the C<add-domain> command, "
16218 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
16219 "if the I<--format:...> flag was given."
16223 #: ../fish/guestfish.pod:208
16228 #: ../fish/guestfish.pod:210
16229 msgid "B<--no-dest-paths>"
16233 #: ../fish/guestfish.pod:212
16235 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
16236 "to hit the tab key to complete paths on the guest filesystem, but this "
16237 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
16238 "allow this feature to be disabled."
16242 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:128
16244 "When prompting for keys and passphrases, guestfish normally turns echoing "
16245 "off so you cannot see what you are typing. If you are not worried about "
16246 "Tempest attacks and there is no one else in the room you can specify this "
16247 "flag to see what you are typing."
16251 #: ../fish/guestfish.pod:224
16256 #: ../fish/guestfish.pod:226
16257 msgid "B<--file file>"
16261 #: ../fish/guestfish.pod:228
16262 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
16266 #: ../fish/guestfish.pod:231
16269 " #!/usr/bin/guestfish -f\n"
16274 #: ../fish/guestfish.pod:244
16277 " guestfish --format=raw -a disk.img\n"
16282 #: ../fish/guestfish.pod:248
16285 " guestfish --format=raw -a disk.img --format -a another.img\n"
16290 #: ../fish/guestfish.pod:253
16292 "If you have untrusted raw-format guest disk images, you should use this "
16293 "option to specify the disk format. This avoids a possible security problem "
16294 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
16298 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:157
16299 msgid "B<--inspector>"
16303 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:159
16305 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
16306 "system and mount filesystems as they would be mounted on the real virtual "
16311 #: ../fish/guestfish.pod:266
16312 msgid "Typical usage is either:"
16316 #: ../fish/guestfish.pod:268
16319 " guestfish -d myguest -i\n"
16324 #: ../fish/guestfish.pod:270
16325 msgid "(for an inactive libvirt domain called I<myguest>), or:"
16329 #: ../fish/guestfish.pod:272
16332 " guestfish --ro -d myguest -i\n"
16337 #: ../fish/guestfish.pod:274
16338 msgid "(for active domains, readonly), or specify the block device directly:"
16342 #: ../fish/guestfish.pod:276
16345 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
16350 #: ../fish/guestfish.pod:278
16352 "Note that the command line syntax changed slightly over older versions of "
16353 "guestfish. You can still use the old syntax:"
16357 #: ../fish/guestfish.pod:281
16360 " guestfish [--ro] -i disk.img\n"
16365 #: ../fish/guestfish.pod:283
16368 " guestfish [--ro] -i libvirt-domain\n"
16373 #: ../fish/guestfish.pod:285
16375 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
16376 "then using other commands to mount the filesystems that were found."
16380 #: ../fish/guestfish.pod:294
16381 msgid "B<--listen>"
16385 #: ../fish/guestfish.pod:296
16387 "Fork into the background and listen for remote commands. See section "
16388 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
16392 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:168
16397 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:170
16399 "Connect to a live virtual machine. (Experimental, see "
16400 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
16404 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:173
16405 msgid "B<-m dev[:mountpoint[:options]]>"
16409 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:175
16410 msgid "B<--mount dev[:mountpoint[:options]]>"
16414 #: ../fish/guestfish.pod:308
16415 msgid "Mount the named partition or logical volume on the given mountpoint."
16419 #: ../fish/guestfish.pod:310
16420 msgid "If the mountpoint is omitted, it defaults to C</>."
16424 #: ../fish/guestfish.pod:312
16425 msgid "You have to mount something on C</> before most commands will work."
16429 #: ../fish/guestfish.pod:314
16431 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16436 #: ../fish/guestfish.pod:317
16438 "If you don't know what filesystems a disk image contains, you can either run "
16439 "guestfish without this option, then list the partitions, filesystems and LVs "
16440 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
16441 "commands), or you can use the L<virt-filesystems(1)> program."
16445 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:183
16447 "The third (and rarely used) part of the mount parameter is the list of mount "
16448 "options used to mount the underlying filesystem. If this is not given, then "
16449 "the mount options are either the empty string or C<ro> (the latter if the "
16450 "I<--ro> flag is used). By specifying the mount options, you override this "
16451 "default choice. Probably the only time you would use this is to enable ACLs "
16452 "and/or extended attributes if the filesystem can support them:"
16456 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:191
16459 " -m /dev/sda1:/:acl,user_xattr\n"
16464 #: ../fish/guestfish.pod:333
16465 msgid "Using this flag is equivalent to using the C<mount-options> command."
16469 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:193 ../resize/virt-resize.pod:358
16474 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:195
16475 msgid "B<--no-sync>"
16479 #: ../fish/guestfish.pod:339
16481 "Disable autosync. This is enabled by default. See the discussion of "
16482 "autosync in the L<guestfs(3)> manpage."
16486 #: ../fish/guestfish.pod:342
16491 #: ../fish/guestfish.pod:344
16492 msgid "B<--new type>"
16496 #: ../fish/guestfish.pod:346
16501 #: ../fish/guestfish.pod:348
16503 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
16504 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16505 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
16510 #: ../fish/guestfish.pod:353
16511 msgid "B<--progress-bars>"
16515 #: ../fish/guestfish.pod:355
16516 msgid "Enable progress bars, even when guestfish is used non-interactively."
16520 #: ../fish/guestfish.pod:357
16522 "Progress bars are enabled by default when guestfish is used as an "
16523 "interactive shell."
16527 #: ../fish/guestfish.pod:360
16528 msgid "B<--no-progress-bars>"
16532 #: ../fish/guestfish.pod:362
16533 msgid "Disable progress bars."
16537 #: ../fish/guestfish.pod:364
16538 msgid "B<--remote[=pid]>"
16542 #: ../fish/guestfish.pod:366
16544 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
16545 "CONTROL GUESTFISH OVER A SOCKET> below."
16549 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:239 ../rescue/virt-rescue.pod:161
16554 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:241 ../rescue/virt-rescue.pod:163
16559 #: ../fish/guestfish.pod:373
16561 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16562 "mounts are done read-only."
16566 #: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:167
16568 "The option must always be used if the disk image or virtual machine might be "
16569 "running, and is generally recommended in cases where you don't need write "
16570 "access to the disk."
16574 #: ../fish/guestfish.pod:380
16576 "Note that prepared disk images created with I<-N> are not affected by this "
16577 "option. Also commands like C<add> are not affected - you have to specify "
16578 "the C<readonly:true> option explicitly if you need it."
16582 #: ../fish/guestfish.pod:384
16583 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
16587 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:253 ../rescue/virt-rescue.pod:173
16588 msgid "B<--selinux>"
16592 #: ../fish/guestfish.pod:388
16593 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
16597 #: ../fish/guestfish.pod:394
16599 "Enable very verbose messages. This is particularly useful if you find a "
16604 #: ../fish/guestfish.pod:401
16605 msgid "Display the guestfish / libguestfs version number and exit."
16609 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:269 ../rescue/virt-rescue.pod:194
16614 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:271 ../rescue/virt-rescue.pod:196
16619 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:273
16621 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16622 "mounts are done read-write."
16626 #: ../fish/guestfish.pod:410
16627 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
16631 #: ../fish/guestfish.pod:414
16632 msgid "Echo each command before executing it."
16636 #: ../fish/guestfish.pod:418
16637 msgid "COMMANDS ON COMMAND LINE"
16641 #: ../fish/guestfish.pod:420
16642 msgid "Any additional (non-option) arguments are treated as commands to execute."
16646 #: ../fish/guestfish.pod:423
16648 "Commands to execute should be separated by a colon (C<:>), where the colon "
16649 "is a separate parameter. Thus:"
16653 #: ../fish/guestfish.pod:426
16656 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
16661 #: ../fish/guestfish.pod:428
16663 "If there are no additional arguments, then we enter a shell, either an "
16664 "interactive shell with a prompt (if the input is a terminal) or a "
16665 "non-interactive shell."
16669 #: ../fish/guestfish.pod:432
16671 "In either command line mode or non-interactive shell, the first command that "
16672 "gives an error causes the whole shell to exit. In interactive mode (with a "
16673 "prompt) if a command fails, you can continue to enter commands."
16677 #: ../fish/guestfish.pod:437
16678 msgid "USING launch (OR run)"
16682 #: ../fish/guestfish.pod:439
16684 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
16685 "then launch it, then mount any disks you need, and finally issue "
16686 "actions/commands. So the general order of the day is:"
16690 #: ../fish/guestfish.pod:447
16691 msgid "add or -a/--add"
16695 #: ../fish/guestfish.pod:451
16696 msgid "launch (aka run)"
16700 #: ../fish/guestfish.pod:455
16701 msgid "mount or -m/--mount"
16705 #: ../fish/guestfish.pod:459
16706 msgid "any other commands"
16710 #: ../fish/guestfish.pod:463
16712 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
16713 "guest before mounting or performing any other commands."
16717 #: ../fish/guestfish.pod:466
16719 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
16720 "I<--new> options were given then C<run> is done automatically, simply "
16721 "because guestfish can't perform the action you asked for without doing this."
16725 #: ../fish/guestfish.pod:471
16726 msgid "OPENING DISKS FOR READ AND WRITE"
16730 #: ../fish/guestfish.pod:473
16732 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
16733 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
16734 "I<-i> and I<-m> open disk images read-only or for writing."
16738 #: ../fish/guestfish.pod:478
16740 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
16741 "opening disk images supplied on the command line for write. To open a disk "
16742 "image read-only you have to do I<-a image --ro>."
16746 #: ../fish/guestfish.pod:482
16748 "This matters: If you accidentally open a live VM disk image writable then "
16749 "you will cause irreversible disk corruption."
16753 #: ../fish/guestfish.pod:485
16755 "In a future libguestfs we intend to change the default the other way. Disk "
16756 "images will be opened read-only. You will have to either specify "
16757 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
16758 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
16759 "access for disk images specified by those other command line options."
16763 #: ../fish/guestfish.pod:492
16765 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
16766 "which does nothing (it is already the default). However it is highly "
16767 "recommended that you use this option to indicate that you need write access, "
16768 "and prepare your scripts for the day when this option will be required for "
16773 #: ../fish/guestfish.pod:498
16775 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
16776 "other libguestfs program apart from guestfish and guestmount."
16780 #: ../fish/guestfish.pod:501
16785 #: ../fish/guestfish.pod:503
16787 "You can quote ordinary parameters using either single or double quotes. For "
16792 #: ../fish/guestfish.pod:506
16795 " add \"file with a space.img\"\n"
16800 #: ../fish/guestfish.pod:508
16803 " rm '/file name'\n"
16808 #: ../fish/guestfish.pod:510
16816 #: ../fish/guestfish.pod:512
16818 "A few commands require a list of strings to be passed. For these, use a "
16819 "whitespace-separated list, enclosed in quotes. Strings containing "
16820 "whitespace to be passed through must be enclosed in single quotes. A "
16821 "literal single quote must be escaped with a backslash."
16825 #: ../fish/guestfish.pod:517
16828 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
16829 " command \"/bin/echo 'foo bar'\"\n"
16830 " command \"/bin/echo \\'foo\\'\"\n"
16835 #: ../fish/guestfish.pod:521
16836 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
16840 #: ../fish/guestfish.pod:523
16842 "In double-quoted arguments (only) use backslash to insert special "
16847 #: ../fish/guestfish.pod:528
16852 #: ../fish/guestfish.pod:530
16853 msgid "Alert (bell) character."
16857 #: ../fish/guestfish.pod:532
16862 #: ../fish/guestfish.pod:534
16863 msgid "Backspace character."
16867 #: ../fish/guestfish.pod:536
16872 #: ../fish/guestfish.pod:538
16873 msgid "Form feed character."
16877 #: ../fish/guestfish.pod:540
16882 #: ../fish/guestfish.pod:542
16883 msgid "Newline character."
16887 #: ../fish/guestfish.pod:544
16892 #: ../fish/guestfish.pod:546
16893 msgid "Carriage return character."
16897 #: ../fish/guestfish.pod:548
16902 #: ../fish/guestfish.pod:550
16903 msgid "Horizontal tab character."
16907 #: ../fish/guestfish.pod:552
16912 #: ../fish/guestfish.pod:554
16913 msgid "Vertical tab character."
16917 #: ../fish/guestfish.pod:556
16922 #: ../fish/guestfish.pod:558
16923 msgid "A literal double quote character."
16927 #: ../fish/guestfish.pod:560
16932 #: ../fish/guestfish.pod:562
16934 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
16939 #: ../fish/guestfish.pod:565
16944 #: ../fish/guestfish.pod:567
16945 msgid "A character with hex value I<hh>. There must be precisely 2 hex digits."
16949 #: ../fish/guestfish.pod:570
16951 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
16956 #: ../fish/guestfish.pod:573
16961 #: ../fish/guestfish.pod:575
16962 msgid "A literal backslash character."
16966 #: ../fish/guestfish.pod:579
16967 msgid "OPTIONAL ARGUMENTS"
16971 #: ../fish/guestfish.pod:581
16973 "Some commands take optional arguments. These arguments appear in this "
16974 "documentation as C<[argname:..]>. You can use them as in these examples:"
16978 #: ../fish/guestfish.pod:585
16981 " add-drive-opts filename\n"
16986 #: ../fish/guestfish.pod:587
16989 " add-drive-opts filename readonly:true\n"
16994 #: ../fish/guestfish.pod:589
16997 " add-drive-opts filename format:qcow2 readonly:false\n"
17002 #: ../fish/guestfish.pod:591
17004 "Each optional argument can appear at most once. All optional arguments must "
17005 "appear after the required ones."
17009 #: ../fish/guestfish.pod:594
17014 #: ../fish/guestfish.pod:596
17015 msgid "This section applies to all commands which can take integers as parameters."
17019 #: ../fish/guestfish.pod:599
17020 msgid "SIZE SUFFIX"
17024 #: ../fish/guestfish.pod:601
17026 "When the command takes a parameter measured in bytes, you can use one of the "
17027 "following suffixes to specify kilobytes, megabytes and larger sizes:"
17031 #: ../fish/guestfish.pod:607
17032 msgid "B<k> or B<K> or B<KiB>"
17036 #: ../fish/guestfish.pod:609
17037 msgid "The size in kilobytes (multiplied by 1024)."
17041 #: ../fish/guestfish.pod:611
17046 #: ../fish/guestfish.pod:613
17047 msgid "The size in SI 1000 byte units."
17051 #: ../fish/guestfish.pod:615
17052 msgid "B<M> or B<MiB>"
17056 #: ../fish/guestfish.pod:617
17057 msgid "The size in megabytes (multiplied by 1048576)."
17061 #: ../fish/guestfish.pod:619
17066 #: ../fish/guestfish.pod:621
17067 msgid "The size in SI 1000000 byte units."
17071 #: ../fish/guestfish.pod:623
17072 msgid "B<G> or B<GiB>"
17076 #: ../fish/guestfish.pod:625
17077 msgid "The size in gigabytes (multiplied by 2**30)."
17081 #: ../fish/guestfish.pod:627
17086 #: ../fish/guestfish.pod:629
17087 msgid "The size in SI 10**9 byte units."
17091 #: ../fish/guestfish.pod:631
17092 msgid "B<T> or B<TiB>"
17096 #: ../fish/guestfish.pod:633
17097 msgid "The size in terabytes (multiplied by 2**40)."
17101 #: ../fish/guestfish.pod:635
17106 #: ../fish/guestfish.pod:637
17107 msgid "The size in SI 10**12 byte units."
17111 #: ../fish/guestfish.pod:639
17112 msgid "B<P> or B<PiB>"
17116 #: ../fish/guestfish.pod:641
17117 msgid "The size in petabytes (multiplied by 2**50)."
17121 #: ../fish/guestfish.pod:643
17126 #: ../fish/guestfish.pod:645
17127 msgid "The size in SI 10**15 byte units."
17131 #: ../fish/guestfish.pod:647
17132 msgid "B<E> or B<EiB>"
17136 #: ../fish/guestfish.pod:649
17137 msgid "The size in exabytes (multiplied by 2**60)."
17141 #: ../fish/guestfish.pod:651
17146 #: ../fish/guestfish.pod:653
17147 msgid "The size in SI 10**18 byte units."
17151 #: ../fish/guestfish.pod:655
17152 msgid "B<Z> or B<ZiB>"
17156 #: ../fish/guestfish.pod:657
17157 msgid "The size in zettabytes (multiplied by 2**70)."
17161 #: ../fish/guestfish.pod:659
17166 #: ../fish/guestfish.pod:661
17167 msgid "The size in SI 10**21 byte units."
17171 #: ../fish/guestfish.pod:663
17172 msgid "B<Y> or B<YiB>"
17176 #: ../fish/guestfish.pod:665
17177 msgid "The size in yottabytes (multiplied by 2**80)."
17181 #: ../fish/guestfish.pod:667
17186 #: ../fish/guestfish.pod:669
17187 msgid "The size in SI 10**24 byte units."
17191 #: ../fish/guestfish.pod:675
17194 " truncate-size /file 1G\n"
17199 #: ../fish/guestfish.pod:677
17200 msgid "would truncate the file to 1 gigabyte."
17204 #: ../fish/guestfish.pod:679
17206 "Be careful because a few commands take sizes in kilobytes or megabytes "
17207 "(eg. the parameter to L</memsize> is specified in megabytes already). "
17208 "Adding a suffix will probably not do what you expect."
17212 #: ../fish/guestfish.pod:683
17213 msgid "OCTAL AND HEXADECIMAL NUMBERS"
17217 #: ../fish/guestfish.pod:685
17219 "For specifying the radix (base) use the C convention: C<0> to prefix an "
17220 "octal number or C<0x> to prefix a hexadecimal number. For example:"
17224 #: ../fish/guestfish.pod:688
17227 " 1234 decimal number 1234\n"
17228 " 02322 octal number, equivalent to decimal 1234\n"
17229 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
17234 #: ../fish/guestfish.pod:692
17236 "When using the C<chmod> command, you almost always want to specify an octal "
17237 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
17238 "L<chmod(1)> program):"
17242 #: ../fish/guestfish.pod:696
17245 " chmod 0777 /public # OK\n"
17246 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
17251 #: ../fish/guestfish.pod:699
17253 "Commands that return numbers usually print them in decimal, but some "
17254 "commands print numbers in other radices (eg. C<umask> prints the mode in "
17255 "octal, preceeded by C<0>)."
17259 #: ../fish/guestfish.pod:703
17260 msgid "WILDCARDS AND GLOBBING"
17264 #: ../fish/guestfish.pod:705
17266 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
17267 "(globbing) by default. So for example the following will not do what you "
17272 #: ../fish/guestfish.pod:709
17280 #: ../fish/guestfish.pod:711
17282 "Assuming you don't have a directory called literally C</home/*> then the "
17283 "above command will return an error."
17287 #: ../fish/guestfish.pod:714
17288 msgid "To perform wildcard expansion, use the C<glob> command."
17292 #: ../fish/guestfish.pod:716
17295 " glob rm-rf /home/*\n"
17300 #: ../fish/guestfish.pod:718
17302 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
17303 "many times), equivalent to:"
17307 #: ../fish/guestfish.pod:721
17310 " rm-rf /home/jim\n"
17311 " rm-rf /home/joe\n"
17312 " rm-rf /home/mary\n"
17317 #: ../fish/guestfish.pod:725
17318 msgid "C<glob> only works on simple guest paths and not on device names."
17322 #: ../fish/guestfish.pod:727
17324 "If you have several parameters, each containing a wildcard, then glob will "
17325 "perform a Cartesian product."
17329 #: ../fish/guestfish.pod:730
17334 #: ../fish/guestfish.pod:732
17336 "Any line which starts with a I<#> character is treated as a comment and "
17337 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
17338 "a command. For example:"
17342 #: ../fish/guestfish.pod:736
17345 " # this is a comment\n"
17346 " # this is a comment\n"
17347 " foo # NOT a comment\n"
17352 #: ../fish/guestfish.pod:740
17353 msgid "Blank lines are also ignored."
17357 #: ../fish/guestfish.pod:742
17358 msgid "RUNNING COMMANDS LOCALLY"
17362 #: ../fish/guestfish.pod:744
17364 "Any line which starts with a I<!> character is treated as a command sent to "
17365 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17369 #: ../fish/guestfish.pod:748
17373 " tgz-out /remote local/remote-data.tar.gz\n"
17378 #: ../fish/guestfish.pod:751
17380 "will create a directory C<local> on the host, and then export the contents "
17381 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17382 "(See C<tgz-out>)."
17386 #: ../fish/guestfish.pod:755
17388 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17389 "effect, due to the way that subprocesses work in Unix."
17393 #: ../fish/guestfish.pod:758
17394 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
17398 #: ../fish/guestfish.pod:760
17400 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
17401 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
17402 "and executed as guestfish commands."
17406 #: ../fish/guestfish.pod:764
17408 "Thus you can use shell script to construct arbitrary guestfish commands "
17409 "which are then parsed by guestfish."
17413 #: ../fish/guestfish.pod:767
17415 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
17416 "through C</foo.100>) using guestfish commands alone. However this is simple "
17417 "if we use a shell script to create the guestfish commands for us:"
17421 #: ../fish/guestfish.pod:772
17424 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
17429 #: ../fish/guestfish.pod:774
17430 msgid "or with names like C</foo.001>:"
17434 #: ../fish/guestfish.pod:776
17437 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
17442 #: ../fish/guestfish.pod:778
17444 "When using guestfish interactively it can be helpful to just run the shell "
17445 "script first (ie. remove the initial C<E<lt>> character so it is just an "
17446 "ordinary I<!> local command), see what guestfish commands it would run, and "
17447 "when you are happy with those prepend the C<E<lt>> character to run the "
17448 "guestfish commands for real."
17452 #: ../fish/guestfish.pod:784
17457 #: ../fish/guestfish.pod:786
17459 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17460 "command (a guestfish command) to the second command (any host command). For "
17465 #: ../fish/guestfish.pod:790
17468 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17473 #: ../fish/guestfish.pod:792
17475 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17476 "program). The above command would list all accounts in the guest filesystem "
17477 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17481 #: ../fish/guestfish.pod:797
17484 " hexdump /bin/ls | head\n"
17485 " list-devices | tail -1\n"
17486 " tgz-out / - | tar ztf -\n"
17491 #: ../fish/guestfish.pod:801
17493 "The space before the pipe symbol is required, any space after the pipe "
17494 "symbol is optional. Everything after the pipe symbol is just passed "
17495 "straight to the host shell, so it can contain redirections, globs and "
17496 "anything else that makes sense on the host side."
17500 #: ../fish/guestfish.pod:806
17502 "To use a literal argument which begins with a pipe symbol, you have to quote "
17507 #: ../fish/guestfish.pod:809
17515 #: ../fish/guestfish.pod:811
17516 msgid "HOME DIRECTORIES"
17520 #: ../fish/guestfish.pod:813
17522 "If a parameter starts with the character C<~> then the tilde may be expanded "
17523 "as a home directory path (either C<~> for the current user's home directory, "
17524 "or C<~user> for another user)."
17528 #: ../fish/guestfish.pod:817
17530 "Note that home directory expansion happens for users known I<on the host>, "
17531 "not in the guest filesystem."
17535 #: ../fish/guestfish.pod:820
17537 "To use a literal argument which begins with a tilde, you have to quote it, "
17542 #: ../fish/guestfish.pod:823
17550 #: ../fish/guestfish.pod:825 ../src/guestfs.pod:519
17551 msgid "ENCRYPTED DISKS"
17555 #: ../fish/guestfish.pod:827
17557 "Libguestfs has some support for Linux guests encrypted according to the "
17558 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17559 "disk encryption systems used by modern Linux guests. Currently only "
17560 "LVM-on-LUKS is supported."
17564 #: ../fish/guestfish.pod:832
17565 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17569 #: ../fish/guestfish.pod:834
17572 " ><fs> vfs-type /dev/sda2\n"
17578 #: ../fish/guestfish.pod:837
17580 "Then open those devices using L</luks-open>. This creates a device-mapper "
17581 "device called C</dev/mapper/luksdev>."
17585 #: ../fish/guestfish.pod:840
17588 " ><fs> luks-open /dev/sda2 luksdev\n"
17589 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17594 #: ../fish/guestfish.pod:843
17596 "Finally you have to tell LVM to scan for volume groups on the newly created "
17601 #: ../fish/guestfish.pod:846
17605 " vg-activate-all true\n"
17610 #: ../fish/guestfish.pod:849
17611 msgid "The logical volume(s) can now be mounted in the usual way."
17615 #: ../fish/guestfish.pod:851
17617 "Before closing a LUKS device you must unmount any logical volumes on it and "
17618 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17619 "one. Then you can close the mapper device:"
17623 #: ../fish/guestfish.pod:855
17626 " vg-activate false /dev/VG\n"
17627 " luks-close /dev/mapper/luksdev\n"
17632 #: ../fish/guestfish.pod:860
17634 "If a path is prefixed with C<win:> then you can use Windows-style drive "
17635 "letters and paths (with some limitations). The following commands are "
17640 #: ../fish/guestfish.pod:864
17643 " file /WINDOWS/system32/config/system.LOG\n"
17648 #: ../fish/guestfish.pod:866
17651 " file win:\\windows\\system32\\config\\system.log\n"
17656 #: ../fish/guestfish.pod:868
17659 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
17664 #: ../fish/guestfish.pod:870
17666 "The parameter is rewritten \"behind the scenes\" by looking up the position "
17667 "where the drive is mounted, prepending that to the path, changing all "
17668 "backslash characters to forward slash, then resolving the result using "
17669 "L</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
17670 "then the parameter might be rewritten like this:"
17674 #: ../fish/guestfish.pod:876
17677 " win:e:\\foo\\bar => /e/FOO/bar\n"
17682 #: ../fish/guestfish.pod:878
17683 msgid "This only works in argument positions that expect a path."
17687 #: ../fish/guestfish.pod:880
17688 msgid "UPLOADING AND DOWNLOADING FILES"
17692 #: ../fish/guestfish.pod:882
17694 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
17695 "others which upload from or download to a local file, you can use the "
17696 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
17700 #: ../fish/guestfish.pod:886
17708 #: ../fish/guestfish.pod:888
17709 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
17713 #: ../fish/guestfish.pod:891
17716 " tar-out /etc - | tar tf -\n"
17721 #: ../fish/guestfish.pod:893
17723 "writes the tarball to stdout and then pipes that into the external \"tar\" "
17724 "command (see L</PIPES>)."
17728 #: ../fish/guestfish.pod:896
17730 "When using C<-> to read from stdin, the input is read up to the end of "
17731 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
17732 "some arbitrary end marker:"
17736 #: ../fish/guestfish.pod:900
17739 " upload -<<END /foo\n"
17748 #: ../fish/guestfish.pod:906
17750 "Any string of characters can be used instead of C<END>. The end marker must "
17751 "appear on a line of its own, without any preceeding or following characters "
17752 "(not even spaces)."
17756 #: ../fish/guestfish.pod:910
17758 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
17759 "upload local files (so-called \"FileIn\" parameters in the generator)."
17763 #: ../fish/guestfish.pod:913
17764 msgid "EXIT ON ERROR BEHAVIOUR"
17768 #: ../fish/guestfish.pod:915
17770 "By default, guestfish will ignore any errors when in interactive mode "
17771 "(ie. taking commands from a human over a tty), and will exit on the first "
17772 "error in non-interactive mode (scripts, commands given on the command line)."
17776 #: ../fish/guestfish.pod:920
17778 "If you prefix a command with a I<-> character, then that command will not "
17779 "cause guestfish to exit, even if that (one) command returns an error."
17783 #: ../fish/guestfish.pod:924
17784 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
17788 #: ../fish/guestfish.pod:926
17790 "Guestfish can be remote-controlled over a socket. This is useful "
17791 "particularly in shell scripts where you want to make several different "
17792 "changes to a filesystem, but you don't want the overhead of starting up a "
17793 "guestfish process each time."
17797 #: ../fish/guestfish.pod:931
17798 msgid "Start a guestfish server process using:"
17802 #: ../fish/guestfish.pod:933
17805 " eval \"`guestfish --listen`\"\n"
17810 #: ../fish/guestfish.pod:935
17811 msgid "and then send it commands by doing:"
17815 #: ../fish/guestfish.pod:937
17818 " guestfish --remote cmd [...]\n"
17823 #: ../fish/guestfish.pod:939
17824 msgid "To cause the server to exit, send it the exit command:"
17828 #: ../fish/guestfish.pod:943
17830 "Note that the server will normally exit if there is an error in a command. "
17831 "You can change this in the usual way. See section L</EXIT ON ERROR "
17836 #: ../fish/guestfish.pod:947
17837 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
17841 #: ../fish/guestfish.pod:949
17843 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
17844 "is how the I<--remote> option knows where to send the commands. You can "
17845 "have several guestfish listener processes running using:"
17849 #: ../fish/guestfish.pod:953
17852 " eval \"`guestfish --listen`\"\n"
17853 " pid1=$GUESTFISH_PID\n"
17854 " eval \"`guestfish --listen`\"\n"
17855 " pid2=$GUESTFISH_PID\n"
17857 " guestfish --remote=$pid1 cmd\n"
17858 " guestfish --remote=$pid2 cmd\n"
17863 #: ../fish/guestfish.pod:961
17864 msgid "REMOTE CONTROL AND CSH"
17868 #: ../fish/guestfish.pod:963
17870 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
17875 #: ../fish/guestfish.pod:966
17878 " eval \"`guestfish --listen --csh`\"\n"
17883 #: ../fish/guestfish.pod:968
17884 msgid "REMOTE CONTROL DETAILS"
17888 #: ../fish/guestfish.pod:970
17890 "Remote control happens over a Unix domain socket called "
17891 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
17892 "of the process, and C<$PID> is the process ID of the server."
17896 #: ../fish/guestfish.pod:974
17897 msgid "Guestfish client and server versions must match exactly."
17901 #: ../fish/guestfish.pod:976
17902 msgid "REMOTE CONTROL RUN COMMAND HANGING"
17906 #: ../fish/guestfish.pod:978
17908 "Using the C<run> (or C<launch>) command remotely in a command substitution "
17909 "context hangs, ie. don't do (note the backquotes):"
17913 #: ../fish/guestfish.pod:981
17916 " a=`guestfish --remote run`\n"
17921 #: ../fish/guestfish.pod:983
17923 "Since the C<run> command produces no output on stdout, this is not useful "
17924 "anyway. For further information see "
17925 "L<https://bugzilla.redhat.com/show_bug.cgi?id=592910>."
17929 #: ../fish/guestfish.pod:987
17930 msgid "PREPARED DISK IMAGES"
17934 #: ../fish/guestfish.pod:989
17936 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
17937 "preformatted disk images that guestfish can make for you to save typing. "
17938 "This is particularly useful for testing purposes. This option is used "
17939 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
17940 "can be mixed with I<-a>)."
17944 #: ../fish/guestfish.pod:995
17946 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
17947 "the second and so on. Existing files in the current directory are "
17952 #: ../fish/guestfish.pod:999
17954 "The type briefly describes how the disk should be sized, partitioned, how "
17955 "filesystem(s) should be created, and how content should be added. "
17956 "Optionally the type can be followed by extra parameters, separated by C<:> "
17957 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
17958 "sparsely-allocated disk, containing a single partition, with the partition "
17959 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
17960 "on a 1GB disk instead."
17964 #: ../fish/guestfish.pod:1007
17965 msgid "To list the available types and any extra parameters they take, run:"
17969 #: ../fish/guestfish.pod:1011
17971 "Note that the prepared filesystem is not mounted. You would usually have to "
17972 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
17976 #: ../fish/guestfish.pod:1015
17978 "If any I<-N> or I<--new> options are given, the guest is automatically "
17983 #: ../fish/guestfish.pod:1020
17984 msgid "Create a 100MB disk with an ext4-formatted partition:"
17988 #: ../fish/guestfish.pod:1022
17991 " guestfish -N fs:ext4\n"
17996 #: ../fish/guestfish.pod:1024
17997 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
18001 #: ../fish/guestfish.pod:1026
18004 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
18009 #: ../fish/guestfish.pod:1028
18010 msgid "Create a blank 200MB disk:"
18014 #: ../fish/guestfish.pod:1030
18017 " guestfish -N disk:200M\n"
18022 #: ../fish/guestfish.pod:1032
18023 msgid "PROGRESS BARS"
18027 #: ../fish/guestfish.pod:1034
18029 "Some (not all) long-running commands send progress notification messages as "
18030 "they are running. Guestfish turns these messages into progress bars."
18034 #: ../fish/guestfish.pod:1038
18036 "When a command that supports progress bars takes longer than two seconds to "
18037 "run, and if progress bars are enabled, then you will see one appearing below "
18042 #: ../fish/guestfish.pod:1042
18045 " ><fs> copy-size /large-file /another-file 2048M\n"
18046 " / 10% [#####-----------------------------------------] 00:30\n"
18051 #: ../fish/guestfish.pod:1045
18053 "The spinner on the left hand side moves round once for every progress "
18054 "notification received from the backend. This is a (reasonably) golden "
18055 "assurance that the command is \"doing something\" even if the progress bar "
18056 "is not moving, because the command is able to send the progress "
18057 "notifications. When the bar reaches 100% and the command finishes, the "
18058 "spinner disappears."
18062 #: ../fish/guestfish.pod:1052
18064 "Progress bars are enabled by default when guestfish is used interactively. "
18065 "You can enable them even for non-interactive modes using I<--progress-bars>, "
18066 "and you can disable them completely using I<--no-progress-bars>."
18070 #: ../fish/guestfish.pod:1057
18071 msgid "GUESTFISH COMMANDS"
18075 #: ../fish/guestfish.pod:1059
18077 "The commands in this section are guestfish convenience commands, in other "
18078 "words, they are not part of the L<guestfs(3)> API."
18082 #: ../fish/guestfish.pod:1062
18087 #: ../fish/guestfish.pod:1064
18096 #: ../fish/guestfish.pod:1067
18097 msgid "Without any parameter, this provides general help."
18101 #: ../fish/guestfish.pod:1069
18102 msgid "With a C<cmd> parameter, this displays detailed help for that command."
18106 #: ../fish/guestfish.pod:1071
18107 msgid "quit | exit"
18111 #: ../fish/guestfish.pod:1073
18112 msgid "This exits guestfish. You can also use C<^D> key."
18116 #: ../fish/guestfish.pod:1075
18117 msgid "@FISH_COMMANDS@"
18121 #: ../fish/guestfish.pod:1077
18126 #: ../fish/guestfish.pod:1079 ../src/guestfs.pod:1505
18131 #: ../fish/guestfish.pod:1083
18133 "guestfish returns 0 if the commands completed without error, or 1 if there "
18138 #: ../fish/guestfish.pod:1090
18143 #: ../fish/guestfish.pod:1092
18145 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
18150 #: ../fish/guestfish.pod:1095 ../src/guestfs.pod:3110
18151 msgid "FEBOOTSTRAP_KERNEL"
18155 #: ../fish/guestfish.pod:1097 ../src/guestfs.pod:3112
18156 msgid "FEBOOTSTRAP_MODULES"
18160 #: ../fish/guestfish.pod:1099 ../src/guestfs.pod:3114
18162 "These two environment variables allow the kernel that libguestfs uses in the "
18163 "appliance to be selected. If C<$FEBOOTSTRAP_KERNEL> is not set, then the "
18164 "most recent host kernel is chosen. For more information about kernel "
18165 "selection, see L<febootstrap-supermin-helper(8)>. This feature is only "
18166 "available in febootstrap E<ge> 3.8."
18170 #: ../fish/guestfish.pod:1105
18171 msgid "GUESTFISH_DISPLAY_IMAGE"
18175 #: ../fish/guestfish.pod:1107
18177 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
18178 "If not set, it uses L<display(1)>."
18182 #: ../fish/guestfish.pod:1110
18183 msgid "GUESTFISH_PID"
18187 #: ../fish/guestfish.pod:1112
18189 "Used with the I<--remote> option to specify the remote guestfish process to "
18190 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
18194 #: ../fish/guestfish.pod:1116
18199 #: ../fish/guestfish.pod:1118
18201 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
18202 "not specified, the external L<hexedit(1)> program is used."
18206 #: ../fish/guestfish.pod:1122
18211 #: ../fish/guestfish.pod:1124
18213 "If compiled with GNU readline support, various files in the home directory "
18214 "can be used. See L</FILES>."
18218 #: ../fish/guestfish.pod:1127 ../src/guestfs.pod:3120
18219 msgid "LIBGUESTFS_APPEND"
18223 #: ../fish/guestfish.pod:1129 ../src/guestfs.pod:3122
18224 msgid "Pass additional options to the guest kernel."
18228 #: ../fish/guestfish.pod:1131 ../src/guestfs.pod:3124
18229 msgid "LIBGUESTFS_DEBUG"
18233 #: ../fish/guestfish.pod:1133
18235 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
18236 "effect as using the B<-v> option."
18240 #: ../fish/guestfish.pod:1136 ../src/guestfs.pod:3129
18241 msgid "LIBGUESTFS_MEMSIZE"
18245 #: ../fish/guestfish.pod:1138 ../src/guestfs.pod:3131
18246 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
18250 #: ../fish/guestfish.pod:1141 ../src/guestfs.pod:3134
18253 " LIBGUESTFS_MEMSIZE=700\n"
18258 #: ../fish/guestfish.pod:1143 ../src/guestfs.pod:3136
18259 msgid "LIBGUESTFS_PATH"
18263 #: ../fish/guestfish.pod:1145
18265 "Set the path that guestfish uses to search for kernel and initrd.img. See "
18266 "the discussion of paths in L<guestfs(3)>."
18270 #: ../fish/guestfish.pod:1148 ../src/guestfs.pod:3141
18271 msgid "LIBGUESTFS_QEMU"
18275 #: ../fish/guestfish.pod:1150 ../src/guestfs.pod:3143
18277 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
18278 "which was found at compile time by the configure script is used."
18282 #: ../fish/guestfish.pod:1154 ../src/guestfs.pod:3149
18283 msgid "LIBGUESTFS_TRACE"
18287 #: ../fish/guestfish.pod:1156
18288 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18292 #: ../fish/guestfish.pod:1158
18297 #: ../fish/guestfish.pod:1160
18299 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
18304 #: ../fish/guestfish.pod:1163 ../src/guestfs.pod:3154
18309 #: ../fish/guestfish.pod:1165 ../src/guestfs.pod:3156
18311 "Location of temporary directory, defaults to C</tmp> except for the cached "
18312 "supermin appliance which defaults to C</var/tmp>."
18316 #: ../fish/guestfish.pod:1168 ../src/guestfs.pod:3159
18318 "If libguestfs was compiled to use the supermin appliance then the real "
18319 "appliance is cached in this directory, shared between all handles belonging "
18320 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
18321 "use in case C</var/tmp> is not large enough."
18325 #: ../fish/guestfish.pod:1176 ../fuse/guestmount.pod:288 ../rescue/virt-rescue.pod:273
18330 #: ../fish/guestfish.pod:1180 ../fuse/guestmount.pod:292 ../rescue/virt-rescue.pod:277
18331 msgid "$HOME/.libguestfs-tools.rc"
18335 #: ../fish/guestfish.pod:1182 ../fuse/guestmount.pod:294 ../rescue/virt-rescue.pod:279
18336 msgid "/etc/libguestfs-tools.conf"
18340 #: ../fish/guestfish.pod:1184 ../fuse/guestmount.pod:296 ../rescue/virt-rescue.pod:281
18342 "This configuration file controls the default read-only or read-write mode "
18343 "(I<--ro> or I<--rw>)."
18347 #: ../fish/guestfish.pod:1187
18348 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
18352 #: ../fish/guestfish.pod:1189
18353 msgid "$HOME/.guestfish"
18357 #: ../fish/guestfish.pod:1191
18359 "If compiled with GNU readline support, then the command history is saved in "
18364 #: ../fish/guestfish.pod:1194
18365 msgid "$HOME/.inputrc"
18369 #: ../fish/guestfish.pod:1196
18370 msgid "/etc/inputrc"
18374 #: ../fish/guestfish.pod:1198
18376 "If compiled with GNU readline support, then these files can be used to "
18377 "configure readline. For further information, please see "
18378 "L<readline(3)/INITIALIZATION FILE>."
18382 #: ../fish/guestfish.pod:1202
18383 msgid "To write rules which only apply to guestfish, use:"
18387 #: ../fish/guestfish.pod:1204
18397 #: ../fish/guestfish.pod:1208
18399 "Variables that you can set in inputrc that change the behaviour of guestfish "
18400 "in useful ways include:"
18404 #: ../fish/guestfish.pod:1213
18405 msgid "completion-ignore-case (default: on)"
18409 #: ../fish/guestfish.pod:1215
18411 "By default, guestfish will ignore case when tab-completing paths on the "
18416 #: ../fish/guestfish.pod:1218
18419 " set completion-ignore-case off\n"
18424 #: ../fish/guestfish.pod:1220
18425 msgid "to make guestfish case sensitive."
18429 #: ../fish/guestfish.pod:1224
18434 #: ../fish/guestfish.pod:1226
18435 msgid "test2.img (etc)"
18439 #: ../fish/guestfish.pod:1228
18441 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
18442 "will be created in the file C<test1.img> in the current directory. The "
18443 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
18444 "the same name will be overwritten."
18448 #: ../fish/guestfish.pod:1237
18450 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
18451 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
18452 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
18453 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
18454 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
18455 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<display(1)>, L<hexedit(1)>, "
18456 "L<febootstrap-supermin-helper(8)>."
18460 #: ../fish/guestfish.pod:1266 ../src/guestfs.pod:3246 ../test-tool/libguestfs-test-tool.pod:112
18461 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
18465 #: ../fish/virt-copy-in.pod:5
18466 msgid "virt-copy-in - Copy files and directories into a virtual machine disk image."
18470 #: ../fish/virt-copy-in.pod:9
18473 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
18478 #: ../fish/virt-copy-in.pod:11
18481 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
18486 #: ../fish/virt-copy-in.pod:15
18488 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
18489 "causing disk corruption. The virtual machine must be shut down before you "
18490 "use this command."
18494 #: ../fish/virt-copy-in.pod:21
18496 "C<virt-copy-in> copies files and directories from the local disk into a "
18497 "virtual machine disk image or named libvirt domain."
18501 #: ../fish/virt-copy-in.pod:24
18503 "You can give one of more filenames and directories on the command line. "
18504 "Directories are copied in recursively. The final parameter must be the "
18505 "destination directory in the disk image which must be an absolute path "
18506 "starting with a C</> character."
18510 #: ../fish/virt-copy-in.pod:33
18513 " virt-copy-in -d MyGuest resolv.conf /etc\n"
18518 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
18519 msgid "Upload a home directory to a guest:"
18523 #: ../fish/virt-copy-in.pod:37
18526 " virt-copy-in -d MyGuest skel /home\n"
18531 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28 ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
18532 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
18536 #: ../fish/virt-copy-in.pod:41
18538 "This command is just a simple shell script wrapper around the "
18539 "L<guestfish(1)> C<copy-in> command. For anything more complex than a "
18540 "trivial copy, you are probably better off using guestfish directly."
18544 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36 ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
18546 "Since the shell script just passes options straight to guestfish, read "
18547 "L<guestfish(1)> to see the full list of options."
18551 #: ../fish/virt-copy-in.pod:52
18553 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
18554 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18558 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55 ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
18559 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
18563 #: ../fish/virt-copy-out.pod:5
18565 "virt-copy-out - Copy files and directories out of a virtual machine disk "
18570 #: ../fish/virt-copy-out.pod:9
18573 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
18578 #: ../fish/virt-copy-out.pod:11
18581 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
18586 #: ../fish/virt-copy-out.pod:15
18588 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
18589 "image or named libvirt domain."
18593 #: ../fish/virt-copy-out.pod:18
18595 "You can give one of more filenames and directories on the command line. "
18596 "Directories are copied out recursively."
18600 #: ../fish/virt-copy-out.pod:23
18601 msgid "Download the home directories from a virtual machine:"
18605 #: ../fish/virt-copy-out.pod:25
18609 " virt-copy-out -d MyGuest /home homes\n"
18614 #: ../fish/virt-copy-out.pod:30
18616 "This command is just a simple shell script wrapper around the "
18617 "L<guestfish(1)> C<copy-out> command. For anything more complex than a "
18618 "trivial copy, you are probably better off using guestfish directly."
18622 #: ../fish/virt-copy-out.pod:41
18624 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, "
18625 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18629 #: ../fish/virt-tar-in.pod:5
18630 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
18634 #: ../fish/virt-tar-in.pod:9
18637 " virt-tar-in -a disk.img data.tar /destination\n"
18642 #: ../fish/virt-tar-in.pod:11
18645 " virt-tar-in -d domain data.tar /destination\n"
18650 #: ../fish/virt-tar-in.pod:13
18653 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
18658 #: ../fish/virt-tar-in.pod:17
18660 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
18661 "causing disk corruption. The virtual machine must be shut down before you "
18662 "use this command."
18666 #: ../fish/virt-tar-in.pod:23
18668 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
18669 "image or named libvirt domain."
18673 #: ../fish/virt-tar-in.pod:26
18675 "The first parameter is the tar file. Use C<-> to read the tar file from "
18676 "standard input. The second parameter is the absolute target directory to "
18681 #: ../fish/virt-tar-in.pod:34
18684 " virt-tar-in -d MyGuest homes.tar /home\n"
18689 #: ../fish/virt-tar-in.pod:38
18691 "This command is just a simple shell script wrapper around the "
18692 "L<guestfish(1)> C<tar-in> command. For anything more complex than a trivial "
18693 "copy, you are probably better off using guestfish directly."
18697 #: ../fish/virt-tar-in.pod:49
18699 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18700 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, "
18701 "L<http://libguestfs.org/>."
18705 #: ../fish/virt-tar-out.pod:5
18706 msgid "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
18710 #: ../fish/virt-tar-out.pod:9
18713 " virt-tar-out -a disk.img /dir files.tar\n"
18718 #: ../fish/virt-tar-out.pod:11
18721 " virt-tar-out -d domain /dir files.tar\n"
18726 #: ../fish/virt-tar-out.pod:13
18729 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
18734 #: ../fish/virt-tar-out.pod:17
18735 msgid "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
18739 #: ../fish/virt-tar-out.pod:20
18741 "The first parameter is the absolute path of the virtual machine directory. "
18742 "The second parameter is the tar file to write. Use C<-> to write to "
18747 #: ../fish/virt-tar-out.pod:26
18748 msgid "Download the home directories from a guest:"
18752 #: ../fish/virt-tar-out.pod:28
18755 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
18760 #: ../fish/virt-tar-out.pod:32
18762 "This command is just a simple shell script wrapper around the "
18763 "L<guestfish(1)> C<tar-out> command. For anything more complex than a "
18764 "trivial copy, you are probably better off using guestfish directly."
18768 #: ../fish/virt-tar-out.pod:43
18770 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18771 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
18775 #: ../fuse/guestmount.pod:5
18776 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
18780 #: ../fuse/guestmount.pod:9
18783 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
18788 #: ../fuse/guestmount.pod:11
18791 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
18796 #: ../fuse/guestmount.pod:13
18799 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
18804 #: ../fuse/guestmount.pod:17
18806 "You must I<not> use C<guestmount> in read-write mode on live virtual "
18807 "machines. If you do this, you risk disk corruption in the VM."
18811 #: ../fuse/guestmount.pod:22
18813 "The guestmount program can be used to mount virtual machine filesystems and "
18814 "other disk images on the host. It uses libguestfs for access to the guest "
18815 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
18816 "a mountable device."
18820 #: ../fuse/guestmount.pod:27
18822 "Along with other options, you have to give at least one device (I<-a> "
18823 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
18824 "option) or use the I<-i> inspection option. How this works is better "
18825 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
18830 #: ../fuse/guestmount.pod:33
18832 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
18833 "by you, and the filesystem will not be visible to any other users unless you "
18834 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
18835 "the filesystem, use the C<fusermount -u> command."
18839 #: ../fuse/guestmount.pod:41
18841 "For a typical Windows guest which has its main filesystem on the first "
18846 #: ../fuse/guestmount.pod:44
18849 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
18854 #: ../fuse/guestmount.pod:46
18856 "For a typical Linux guest which has a /boot filesystem on the first "
18857 "partition, and the root filesystem on a logical volume:"
18861 #: ../fuse/guestmount.pod:49
18864 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
18869 #: ../fuse/guestmount.pod:51
18870 msgid "To get libguestfs to detect guest mountpoints for you:"
18874 #: ../fuse/guestmount.pod:53
18877 " guestmount -a guest.img -i --ro /mnt\n"
18882 #: ../fuse/guestmount.pod:55
18883 msgid "For a libvirt guest called \"Guest\" you could do:"
18887 #: ../fuse/guestmount.pod:57
18890 " guestmount -d Guest -i --ro /mnt\n"
18895 #: ../fuse/guestmount.pod:59
18897 "If you don't know what filesystems are contained in a guest or disk image, "
18898 "use L<virt-filesystems(1)> first:"
18902 #: ../fuse/guestmount.pod:62
18905 " virt-filesystems MyGuest\n"
18910 #: ../fuse/guestmount.pod:64
18912 "If you want to trace the libguestfs calls but without excessive debugging "
18913 "information, we recommend:"
18917 #: ../fuse/guestmount.pod:67
18920 " guestmount [...] --trace /mnt\n"
18925 #: ../fuse/guestmount.pod:69
18926 msgid "If you want to debug the program, we recommend:"
18930 #: ../fuse/guestmount.pod:71
18933 " guestmount [...] --trace --verbose /mnt\n"
18938 #: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:68 ../resize/virt-resize.pod:544
18943 #: ../fuse/guestmount.pod:75
18944 msgid "Other users cannot see the filesystem by default"
18948 #: ../fuse/guestmount.pod:77
18950 "If you mount a filesystem as one user (eg. root), then other users will not "
18951 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
18952 "option when mounting:"
18956 #: ../fuse/guestmount.pod:81
18959 " sudo guestmount [...] -o allow_other /mnt\n"
18964 #: ../fuse/guestmount.pod:91
18965 msgid "Add a block device or virtual machine image."
18969 #: ../fuse/guestmount.pod:114
18970 msgid "B<--dir-cache-timeout N>"
18974 #: ../fuse/guestmount.pod:116
18976 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
18977 "seconds. The readdir cache [actually, there are several semi-independent "
18978 "caches] is populated after a readdir(2) call with the stat and extended "
18979 "attributes of the files in the directory, in anticipation that they will be "
18980 "requested soon after."
18984 #: ../fuse/guestmount.pod:122
18986 "There is also a different attribute cache implemented by FUSE (see the FUSE "
18987 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
18988 "requests, only cache existing ones."
18992 #: ../fuse/guestmount.pod:142
18994 "If you have untrusted raw-format guest disk images, you should use this "
18995 "option to specify the disk format. This avoids a possible security problem "
18996 "with malicious guests (CVE-2010-3851). See also "
18997 "L<guestfs(3)/guestfs_add_drive_opts>."
19001 #: ../fuse/guestmount.pod:147
19002 msgid "B<--fuse-help>"
19006 #: ../fuse/guestmount.pod:149
19007 msgid "Display help on special FUSE options (see I<-o> below)."
19011 #: ../fuse/guestmount.pod:153
19012 msgid "Display brief help and exit."
19016 #: ../fuse/guestmount.pod:177
19018 "Mount the named partition or logical volume on the given mountpoint B<in the "
19019 "guest> (this has nothing to do with mountpoints in the host)."
19023 #: ../fuse/guestmount.pod:180
19025 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
19026 "something on C</>."
19030 #: ../fuse/guestmount.pod:197
19032 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
19033 "unmounted. If you specify this option, then we don't attempt to sync the "
19034 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
19038 #: ../fuse/guestmount.pod:202
19039 msgid "B<-o option>"
19043 #: ../fuse/guestmount.pod:204
19044 msgid "B<--option option>"
19048 #: ../fuse/guestmount.pod:206
19049 msgid "Pass extra options to FUSE."
19053 #: ../fuse/guestmount.pod:208
19055 "To get a list of all the extra options supported by FUSE, use the command "
19056 "below. Note that only the FUSE I<-o> options can be passed, and only some "
19057 "of them are a good idea."
19061 #: ../fuse/guestmount.pod:212
19064 " guestmount --fuse-help\n"
19069 #: ../fuse/guestmount.pod:214
19070 msgid "Some potentially useful FUSE options:"
19074 #: ../fuse/guestmount.pod:218
19075 msgid "B<-o allow_other>"
19079 #: ../fuse/guestmount.pod:220
19080 msgid "Allow other users to see the filesystem."
19084 #: ../fuse/guestmount.pod:222
19085 msgid "B<-o attr_timeout=N>"
19089 #: ../fuse/guestmount.pod:224
19090 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
19094 #: ../fuse/guestmount.pod:226
19095 msgid "B<-o kernel_cache>"
19099 #: ../fuse/guestmount.pod:228
19101 "Allow the kernel to cache files (reduces the number of reads that have to go "
19102 "through the L<guestfs(3)> API). This is generally a good idea if you can "
19103 "afford the extra memory usage."
19107 #: ../fuse/guestmount.pod:232
19108 msgid "B<-o uid=N> B<-o gid=N>"
19112 #: ../fuse/guestmount.pod:234
19114 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
19115 "the chosen values."
19119 #: ../fuse/guestmount.pod:243
19121 "Add devices and mount everything read-only. Also disallow writes and make "
19122 "the disk appear read-only to FUSE."
19126 #: ../fuse/guestmount.pod:246
19128 "This is highly recommended if you are not going to edit the guest disk. If "
19129 "the guest is running and this option is I<not> supplied, then there is a "
19130 "strong risk of disk corruption in the guest. We try to prevent this from "
19131 "happening, but it is not always possible."
19135 #: ../fuse/guestmount.pod:251 ../rescue/virt-rescue.pod:171
19136 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
19140 #: ../fuse/guestmount.pod:255
19141 msgid "Enable SELinux support for the guest."
19145 #: ../fuse/guestmount.pod:261
19146 msgid "Enable verbose messages from underlying libguestfs."
19150 #: ../fuse/guestmount.pod:267
19151 msgid "Display the program version and exit."
19155 #: ../fuse/guestmount.pod:276 ../fuse/guestmount.pod:299 ../rescue/virt-rescue.pod:201 ../rescue/virt-rescue.pod:284
19156 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
19160 #: ../fuse/guestmount.pod:280
19165 #: ../fuse/guestmount.pod:282
19166 msgid "Trace libguestfs calls and entry into each FUSE function."
19170 #: ../fuse/guestmount.pod:284
19171 msgid "This also stops the daemon from forking into the background."
19175 #: ../fuse/guestmount.pod:310
19177 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
19178 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
19179 "L<http://fuse.sf.net/>."
19183 #: ../fuse/guestmount.pod:325
19184 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
19188 #: ../inspector/virt-inspector.pod:5
19190 "virt-inspector - Display operating system version and other information "
19191 "about a virtual machine"
19195 #: ../inspector/virt-inspector.pod:9
19198 " virt-inspector [--options] -d domname\n"
19203 #: ../inspector/virt-inspector.pod:11
19206 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
19211 #: ../inspector/virt-inspector.pod:15
19214 " virt-inspector domname\n"
19219 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:141
19222 " virt-inspector disk.img [disk.img ...]\n"
19227 #: ../inspector/virt-inspector.pod:21
19229 "B<virt-inspector> examines a virtual machine or disk image and tries to "
19230 "determine the version of the operating system and other information about "
19231 "the virtual machine."
19235 #: ../inspector/virt-inspector.pod:25
19236 msgid "Virt-inspector produces XML output for feeding into other programs."
19240 #: ../inspector/virt-inspector.pod:27
19242 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
19243 "the libvirt domain (see: C<virsh list --all>)."
19247 #: ../inspector/virt-inspector.pod:30
19249 "You can also run virt-inspector directly on disk images from a single "
19250 "virtual machine. Use C<virt-inspector -a disk.img>. In rare cases a domain "
19251 "has several block devices, in which case you should list several I<-a> "
19252 "options one after another, with the first corresponding to the guest's "
19253 "C</dev/sda>, the second to the guest's C</dev/sdb> and so on."
19257 #: ../inspector/virt-inspector.pod:37
19259 "You can also run virt-inspector on install disks, live CDs, bootable USB "
19260 "keys and similar."
19264 #: ../inspector/virt-inspector.pod:40
19266 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
19267 "inspect several virtual machines, you have to run virt-inspector several "
19268 "times (for example, from a shell script for-loop)."
19272 #: ../inspector/virt-inspector.pod:45
19274 "Because virt-inspector needs direct access to guest images, it won't "
19275 "normally work over remote libvirt connections."
19279 #: ../inspector/virt-inspector.pod:48
19281 "All of the information available from virt-inspector is also available "
19282 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>). "
19283 "The same information can also be fetched using guestfish or via libguestfs "
19284 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
19285 "WITH OTHER PROGRAMMING LANGUAGES>)."
19289 #: ../inspector/virt-inspector.pod:81
19291 "Libvirt is only used if you specify a C<domname> on the command line. If "
19292 "you specify guest block devices directly (I<-a>), then libvirt is not used "
19297 #: ../inspector/virt-inspector.pod:94
19299 "When prompting for keys and passphrases, virt-inspector normally turns "
19300 "echoing off so you cannot see what you are typing. If you are not worried "
19301 "about Tempest attacks and there is no one else in the room you can specify "
19302 "this flag to see what you are typing."
19306 #: ../inspector/virt-inspector.pod:103 ../tools/virt-list-filesystems.pl:93 ../tools/virt-list-partitions.pl:94 ../tools/virt-tar.pl:143 ../tools/virt-win-reg.pl:144
19308 "Specify the format of disk images given on the command line. If this is "
19309 "omitted then the format is autodetected from the content of the disk image."
19313 #: ../inspector/virt-inspector.pod:107 ../tools/virt-list-filesystems.pl:97 ../tools/virt-list-partitions.pl:98 ../tools/virt-tar.pl:147 ../tools/virt-win-reg.pl:148
19315 "If disk images are requested from libvirt, then this program asks libvirt "
19316 "for this information. In this case, the value of the format parameter is "
19321 #: ../inspector/virt-inspector.pod:111 ../resize/virt-resize.pod:314 ../resize/virt-resize.pod:406 ../tools/virt-list-filesystems.pl:101 ../tools/virt-list-partitions.pl:102 ../tools/virt-tar.pl:151 ../tools/virt-win-reg.pl:152
19323 "If working with untrusted raw-format guest disk images, you should ensure "
19324 "the format is always specified."
19328 #: ../inspector/virt-inspector.pod:139
19329 msgid "Previous versions of virt-inspector allowed you to write either:"
19333 #: ../inspector/virt-inspector.pod:145
19336 " virt-inspector guestname\n"
19341 #: ../inspector/virt-inspector.pod:153
19346 #: ../inspector/virt-inspector.pod:155
19348 "The virt-inspector XML is described precisely in a RELAX NG schema file "
19349 "C<virt-inspector.rng> which is supplied with libguestfs. This section is "
19350 "just an overview."
19354 #: ../inspector/virt-inspector.pod:159
19356 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
19357 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
19358 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
19359 "which is vanishingly rare in real world VMs."
19363 #: ../inspector/virt-inspector.pod:164
19364 msgid "E<lt>operatingsystemE<gt>"
19368 #: ../inspector/virt-inspector.pod:166
19370 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
19371 "describe the operating system, its architecture, the descriptive \"product "
19372 "name\" string, the type of OS and so on, as in this example:"
19376 #: ../inspector/virt-inspector.pod:170
19379 " <operatingsystems>\n"
19380 " <operatingsystem>\n"
19381 " <root>/dev/sda2</root>\n"
19382 " <name>windows</name>\n"
19383 " <arch>i386</arch>\n"
19384 " <distro>windows</distro>\n"
19385 " <product_name>Windows 7 Enterprise</product_name>\n"
19386 " <product_variant>Client</product_variant>\n"
19387 " <major_version>6</major_version>\n"
19388 " <minor_version>1</minor_version>\n"
19389 " <windows_systemroot>/Windows</windows_systemroot>\n"
19390 " <format>installed</format>\n"
19395 #: ../inspector/virt-inspector.pod:183
19397 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
19398 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
19399 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
19400 "architecture. The other fields are fairly self-explanatory, but because "
19401 "these fields are taken directly from the libguestfs inspection API you can "
19402 "find precise information from L<guestfs(3)/INSPECTION>."
19406 #: ../inspector/virt-inspector.pod:191
19408 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
19409 "of view of libguestfs (block devices may have completely different names "
19410 "inside the VM itself)."
19414 #: ../inspector/virt-inspector.pod:195
19415 msgid "E<lt>mountpointsE<gt>"
19419 #: ../inspector/virt-inspector.pod:197
19421 "Un*x-like guests typically have multiple filesystems which are mounted at "
19422 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
19423 "element which looks like this:"
19427 #: ../inspector/virt-inspector.pod:201
19430 " <operatingsystems>\n"
19431 " <operatingsystem>\n"
19434 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
19435 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
19436 " </mountpoints>\n"
19441 #: ../inspector/virt-inspector.pod:209
19443 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
19444 "and may have completely different names inside the guest. Only mountable "
19445 "filesystems appear in this list, not things like swap devices."
19449 #: ../inspector/virt-inspector.pod:214
19450 msgid "E<lt>filesystemsE<gt>"
19454 #: ../inspector/virt-inspector.pod:216
19456 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
19457 "filesystems belonging to the guest, including swap and empty partitions. "
19458 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
19459 "this OS or shared with this OS and other OSes)."
19463 #: ../inspector/virt-inspector.pod:222
19464 msgid "You might see something like this:"
19468 #: ../inspector/virt-inspector.pod:224
19471 " <operatingsystems>\n"
19472 " <operatingsystem>\n"
19475 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19476 " <type>ext4</type>\n"
19477 " <label>Fedora-13-x86_64</label>\n"
19478 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
19484 #: ../inspector/virt-inspector.pod:234
19486 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
19487 "the label, and the UUID."
19491 #: ../inspector/virt-inspector.pod:237
19492 msgid "E<lt>applicationsE<gt>"
19496 #: ../inspector/virt-inspector.pod:239
19498 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
19499 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
19504 #: ../inspector/virt-inspector.pod:243
19506 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
19507 "Typical values would be C<rpm> and C<deb>."
19511 #: ../inspector/virt-inspector.pod:246
19513 "E<lt>package_managementE<gt>, if present, describes the package manager. "
19514 "Typical values include C<yum>, C<up2date> and C<apt>"
19518 #: ../inspector/virt-inspector.pod:249
19519 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
19523 #: ../inspector/virt-inspector.pod:252
19526 " <operatingsystems>\n"
19527 " <operatingsystem>\n"
19529 " <applications>\n"
19531 " <name>coreutils</name>\n"
19532 " <version>8.5</version>\n"
19533 " <release>1</release>\n"
19534 " </application>\n"
19539 #: ../inspector/virt-inspector.pod:262
19541 "The version and release fields may not be available for some types guests. "
19542 "Other fields are possible, see "
19543 "L<guestfs(3)/guestfs_inspect_list_applications>."
19547 #: ../inspector/virt-inspector.pod:266
19548 msgid "E<lt>drive_mappingsE<gt>"
19552 #: ../inspector/virt-inspector.pod:268
19554 "For operating systems like Windows which use drive letters, virt-inspector "
19555 "is able to find out how drive letters map to filesystems."
19559 #: ../inspector/virt-inspector.pod:272
19562 " <operatingsystems>\n"
19563 " <operatingsystem>\n"
19565 " <drive_mappings>\n"
19566 " <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
19567 " <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
19568 " </drive_mappings>\n"
19573 #: ../inspector/virt-inspector.pod:280
19575 "In the example above, drive C maps to the filesystem on the second partition "
19576 "on the first disk, and drive E maps to the filesystem on the first partition "
19577 "on the second disk."
19581 #: ../inspector/virt-inspector.pod:284
19583 "Note that this only covers permanent local filesystem mappings, not things "
19584 "like network shares. Furthermore NTFS volume mount points may not be listed "
19589 #: ../inspector/virt-inspector.pod:288
19590 msgid "E<lt>iconE<gt>"
19594 #: ../inspector/virt-inspector.pod:290
19596 "Virt-inspector is sometimes able to extract an icon or logo for the guest. "
19597 "The icon is returned as base64-encoded PNG data. Note that the icon can be "
19598 "very large and high quality."
19602 #: ../inspector/virt-inspector.pod:294
19605 " <operatingsystems>\n"
19606 " <operatingsystem>\n"
19609 " iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
19610 " [... many lines of base64 data ...]\n"
19616 #: ../inspector/virt-inspector.pod:302
19618 "To display the icon, you have to extract it and convert the base64 data back "
19619 "to a binary file. Use an XPath query or simply an editor to extract the "
19620 "data, then use the coreutils L<base64(1)> program to do the conversion back "
19625 #: ../inspector/virt-inspector.pod:307
19628 " base64 -i -d < icon.data > icon.png\n"
19633 #: ../inspector/virt-inspector.pod:309
19634 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
19638 #: ../inspector/virt-inspector.pod:311
19640 "Virt-inspector can detect some operating system installers on install disks, "
19641 "live CDs, bootable USB keys and more."
19645 #: ../inspector/virt-inspector.pod:314
19647 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
19648 "fields may be present to indicate a live CD, network installer, or one part "
19649 "of a multipart CD. For example:"
19653 #: ../inspector/virt-inspector.pod:318
19656 " <operatingsystems>\n"
19657 " <operatingsystem>\n"
19658 " <root>/dev/sda</root>\n"
19659 " <name>linux</name>\n"
19660 " <arch>i386</arch>\n"
19661 " <distro>ubuntu</distro>\n"
19662 " <product_name>Ubuntu 10.10 "Maverick "
19663 "Meerkat"</product_name>\n"
19664 " <major_version>10</major_version>\n"
19665 " <minor_version>10</minor_version>\n"
19666 " <format>installer</format>\n"
19672 #: ../inspector/virt-inspector.pod:330
19673 msgid "USING XPATH"
19677 #: ../inspector/virt-inspector.pod:332
19679 "You can use the XPath query language to select parts of the XML. We "
19680 "recommend using C<xmlstarlet> to perform XPath queries from the command "
19685 #: ../inspector/virt-inspector.pod:338
19688 " $ virt-inspector -d Guest | xmlstarlet sel -t -c '//filesystems'\n"
19690 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19691 " <type>ext4</type>\n"
19697 #: ../inspector/virt-inspector.pod:344
19700 " $ virt-inspector -d Guest | \\\n"
19701 " xmlstarlet sel -t -c \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
19707 #: ../inspector/virt-inspector.pod:348
19710 " $ virt-inspector -d Guest | \\\n"
19711 " xmlstarlet sel -t -v '//icon' | base64 -i -d | display -\n"
19712 " [displays the guest icon, if there is one]\n"
19717 #: ../inspector/virt-inspector.pod:359
19718 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
19722 #: ../inspector/virt-inspector.pod:361
19724 "Early versions of libguestfs shipped with a different virt-inspector program "
19725 "written in Perl (the current version is written in C). The XML output of "
19726 "the Perl virt-inspector was different and it could also output in other "
19727 "formats like text."
19731 #: ../inspector/virt-inspector.pod:366
19732 msgid "The old virt-inspector is no longer supported or shipped with libguestfs."
19736 #: ../inspector/virt-inspector.pod:369
19738 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
19739 "versions of virt-inspector with different names:"
19743 #: ../inspector/virt-inspector.pod:372
19746 " virt-inspector Old Perl version.\n"
19747 " virt-inspector2 New C version.\n"
19752 #: ../inspector/virt-inspector.pod:382
19754 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, "
19755 "L<base64(1)>, L<xmlstarlet(1)>, L<http://libguestfs.org/>."
19759 #: ../inspector/virt-inspector.pod:399
19760 msgid "Matthew Booth L<mbooth@redhat.com>"
19764 #: ../java/examples/guestfs-java.pod:5
19765 msgid "guestfs-java - How to use libguestfs from Java"
19769 #: ../java/examples/guestfs-java.pod:9
19772 " import com.redhat.et.libguestfs.*;\n"
19777 #: ../java/examples/guestfs-java.pod:11
19780 " GuestFS g = new GuestFS ();\n"
19781 " g.add_drive_opts (\"disk.img\", null);\n"
19787 #: ../java/examples/guestfs-java.pod:17
19789 "This manual page documents how to call libguestfs from the Java programming "
19790 "language. This page just documents the differences from the C API and gives "
19791 "some examples. If you are not familiar with using libguestfs, you also need "
19792 "to read L<guestfs(3)>."
19796 #: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
19797 msgid "CLOSING THE HANDLE"
19801 #: ../java/examples/guestfs-java.pod:24
19803 "The handle is closed when it is reaped by the garbage collector. Because "
19804 "libguestfs handles include a lot of state, it is also possible to close (and "
19805 "hence free) them explicitly by calling the C<close> method."
19809 #: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60 ../python/examples/guestfs-python.pod:21 ../ruby/examples/guestfs-ruby.pod:22
19814 #: ../java/examples/guestfs-java.pod:31
19816 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
19817 "exception. This has a single parameter which is the error message (a "
19822 #: ../java/examples/guestfs-java.pod:35
19823 msgid "Calling any method on a closed handle raises the same exception."
19827 #: ../java/examples/guestfs-java.pod:47
19829 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
19830 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
19831 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>, "
19832 "L<http://caml.inria.fr/>."
19836 #: ../ocaml/examples/guestfs-ocaml.pod:5
19837 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
19841 #: ../ocaml/examples/guestfs-ocaml.pod:9
19842 msgid "Module style:"
19846 #: ../ocaml/examples/guestfs-ocaml.pod:11
19849 " let g = Guestfs.create () in\n"
19850 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
19851 " Guestfs.launch g;\n"
19856 #: ../ocaml/examples/guestfs-ocaml.pod:15
19857 msgid "Object-oriented style:"
19861 #: ../ocaml/examples/guestfs-ocaml.pod:17
19864 " let g = new Guestfs.guestfs () in\n"
19865 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
19871 #: ../ocaml/examples/guestfs-ocaml.pod:21
19874 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
19876 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
19881 #: ../ocaml/examples/guestfs-ocaml.pod:27
19883 "This manual page documents how to call libguestfs from the OCaml programming "
19884 "language. This page just documents the differences from the C API and gives "
19885 "some examples. If you are not familiar with using libguestfs, you also need "
19886 "to read L<guestfs(3)>."
19890 #: ../ocaml/examples/guestfs-ocaml.pod:32
19891 msgid "PROGRAMMING STYLES"
19895 #: ../ocaml/examples/guestfs-ocaml.pod:34
19897 "There are two different programming styles supported by the OCaml bindings. "
19898 "You can use a module style, with each C function mapped to an OCaml "
19903 #: ../ocaml/examples/guestfs-ocaml.pod:38
19906 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
19911 #: ../ocaml/examples/guestfs-ocaml.pod:40
19916 #: ../ocaml/examples/guestfs-ocaml.pod:42
19919 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
19924 #: ../ocaml/examples/guestfs-ocaml.pod:44
19926 "Alternately you can use an object-oriented style, calling methods on the "
19927 "class C<Guestfs.guestfs>:"
19931 #: ../ocaml/examples/guestfs-ocaml.pod:47
19934 " method set_verbose : bool -> unit\n"
19939 #: ../ocaml/examples/guestfs-ocaml.pod:49
19941 "The object-oriented style is usually briefer, and the minor performance "
19942 "penalty isn't noticable in the general overhead of performing libguestfs "
19947 #: ../ocaml/examples/guestfs-ocaml.pod:55
19949 "The handle is closed when it is reaped by the garbage collector. Because "
19950 "libguestfs handles include a lot of state, it is also possible to close (and "
19951 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
19956 #: ../ocaml/examples/guestfs-ocaml.pod:62
19958 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
19959 "exception. This has a single parameter which is the error message (a "
19964 #: ../ocaml/examples/guestfs-ocaml.pod:66
19966 "Calling any function/method on a closed handle raises "
19967 "C<Guestfs.Handle_closed>. The single parameter is the name of the function "
19972 #: ../ocaml/examples/guestfs-ocaml.pod:80
19974 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
19975 "L<guestfs-java(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
19976 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>, "
19977 "L<http://caml.inria.fr/>."
19981 #: ../perl/examples/guestfs-perl.pod:5
19982 msgid "guestfs-perl - How to use libguestfs from Perl"
19986 #: ../perl/examples/guestfs-perl.pod:9
19989 " use Sys::Guestfs;\n"
19994 #: ../perl/examples/guestfs-perl.pod:11
19997 " my $h = Sys::Guestfs->new ();\n"
19998 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
19999 " $h->launch ();\n"
20000 " $h->mount_options ('', '/dev/sda1', '/');\n"
20001 " $h->touch ('/hello');\n"
20007 #: ../perl/examples/guestfs-perl.pod:20
20009 "This manual page documents how to call libguestfs from the Perl programming "
20010 "language. This page just documents the differences from the C API and gives "
20011 "some examples. If you are not familiar with using libguestfs, you also need "
20012 "to read L<guestfs(3)>. To read the full Perl API, see L<Sys::Guestfs(3)>."
20016 #: ../perl/examples/guestfs-perl.pod:26
20021 #: ../perl/examples/guestfs-perl.pod:28
20023 "Errors from libguestfs functions turn into calls to C<croak> (see "
20028 #: ../perl/examples/guestfs-perl.pod:41
20030 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, "
20031 "L<guestfs-erlang(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, "
20032 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, "
20033 "L<http://libguestfs.org/>."
20037 #: ../python/examples/guestfs-python.pod:5
20038 msgid "guestfs-python - How to use libguestfs from Python"
20042 #: ../python/examples/guestfs-python.pod:9
20045 " import guestfs\n"
20046 " g = guestfs.GuestFS ()\n"
20047 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
20053 #: ../python/examples/guestfs-python.pod:16
20055 "This manual page documents how to call libguestfs from the Python "
20056 "programming language. This page just documents the differences from the C "
20057 "API and gives some examples. If you are not familiar with using libguestfs, "
20058 "you also need to read L<guestfs(3)>."
20062 #: ../python/examples/guestfs-python.pod:23
20064 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
20065 "single string argument which is the error message."
20069 #: ../python/examples/guestfs-python.pod:26
20070 msgid "MORE DOCUMENTATION"
20074 #: ../python/examples/guestfs-python.pod:28
20079 #: ../python/examples/guestfs-python.pod:30
20083 " >>> import guestfs\n"
20084 " >>> help (guestfs)\n"
20089 #: ../python/examples/guestfs-python.pod:44
20091 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
20092 "L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
20093 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
20097 #: ../rescue/virt-rescue.pod:5
20098 msgid "virt-rescue - Run a rescue shell on a virtual machine"
20102 #: ../rescue/virt-rescue.pod:9
20105 " virt-rescue [--options] -d domname\n"
20110 #: ../rescue/virt-rescue.pod:11
20113 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
20118 #: ../rescue/virt-rescue.pod:15
20121 " virt-rescue [--options] domname\n"
20126 #: ../rescue/virt-rescue.pod:17
20129 " virt-rescue [--options] disk.img [disk.img ...]\n"
20134 #: ../rescue/virt-rescue.pod:21
20136 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
20137 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
20138 "you from doing this, but doesn't catch all cases."
20142 #: ../rescue/virt-rescue.pod:25
20144 "However if you use the I<--ro> (read only) option, then you can attach a "
20145 "shell to a live virtual machine. The results might be strange or "
20146 "inconsistent at times but you won't get disk corruption."
20150 #: ../rescue/virt-rescue.pod:31
20152 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
20153 "need for a CD. virt-rescue gives you a rescue shell and some simple "
20154 "recovery tools which you can use to examine or rescue a virtual machine or "
20159 #: ../rescue/virt-rescue.pod:36
20161 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
20162 "on disk image(s):"
20166 #: ../rescue/virt-rescue.pod:39
20169 " virt-rescue -d GuestName\n"
20174 #: ../rescue/virt-rescue.pod:41
20177 " virt-rescue --ro -a /path/to/disk.img\n"
20182 #: ../rescue/virt-rescue.pod:43
20185 " virt-rescue -a /dev/sdc\n"
20190 #: ../rescue/virt-rescue.pod:45
20191 msgid "For live VMs you I<must> use the --ro option."
20195 #: ../rescue/virt-rescue.pod:47
20197 "When you run virt-rescue on a virtual machine or disk image, you are placed "
20198 "in an interactive bash shell where you can use many ordinary Linux "
20199 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
20200 "appliance. You must mount the virtual machine's filesystems by hand. There "
20201 "is an empty directory called C</sysroot> where you can mount filesystems."
20205 #: ../rescue/virt-rescue.pod:54
20207 "In the example below, we list logical volumes, then choose one to mount "
20208 "under C</sysroot>:"
20212 #: ../rescue/virt-rescue.pod:57
20216 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
20217 " lv_root vg_f11x64 -wi-a- 8.83G\n"
20218 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
20219 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
20220 " ><rescue> ls /sysroot\n"
20225 #: ../rescue/virt-rescue.pod:64
20227 "If you don't know what filesystems are available on the virtual machine then "
20228 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
20232 #: ../rescue/virt-rescue.pod:70
20234 "Virt-rescue can be used on I<any> disk image file or device, not just a "
20235 "virtual machine. For example you can use it on a blank file if you want to "
20236 "partition that file (although we would recommend using L<guestfish(1)> "
20237 "instead as it is more suitable for this purpose). You can even use "
20238 "virt-rescue on things like SD cards."
20242 #: ../rescue/virt-rescue.pod:76
20244 "Virt-rescue does not require root. You only need to run it as root if you "
20245 "need root to open the disk image."
20249 #: ../rescue/virt-rescue.pod:79
20251 "This tool is just designed for quick interactive hacking on a virtual "
20252 "machine. For more structured access to a virtual machine disk image, you "
20253 "should use L<guestfs(3)>. To get a structured shell that you can use to "
20254 "make scripted changes to guests, use L<guestfish(1)>."
20258 #: ../rescue/virt-rescue.pod:103
20259 msgid "B<--append kernelopts>"
20263 #: ../rescue/virt-rescue.pod:105
20264 msgid "Pass additional options to the rescue kernel."
20268 #: ../rescue/virt-rescue.pod:135
20271 " virt-rescue --format=raw -a disk.img\n"
20276 #: ../rescue/virt-rescue.pod:139
20279 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
20284 #: ../rescue/virt-rescue.pod:148
20289 #: ../rescue/virt-rescue.pod:150
20290 msgid "B<--memsize MB>"
20294 #: ../rescue/virt-rescue.pod:152
20296 "Change the amount of memory allocated to the rescue system. The default is "
20297 "set by libguestfs and is small but adequate for running system tools. The "
20298 "occasional program might need more memory. The parameter is specified in "
20303 #: ../rescue/virt-rescue.pod:157
20304 msgid "B<--network>"
20308 #: ../rescue/virt-rescue.pod:159
20309 msgid "Enable QEMU user networking in the guest. See L</NETWORK>."
20313 #: ../rescue/virt-rescue.pod:165
20314 msgid "Open the image read-only."
20318 #: ../rescue/virt-rescue.pod:175
20320 "Enable SELinux in the rescue appliance. You should read "
20321 "L<guestfs(3)/SELINUX> before using this option."
20325 #: ../rescue/virt-rescue.pod:178
20330 #: ../rescue/virt-rescue.pod:180
20331 msgid "Enable N E<ge> 2 virtual CPUs in the rescue appliance."
20335 #: ../rescue/virt-rescue.pod:198
20337 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
20338 "are done read-write."
20342 #: ../rescue/virt-rescue.pod:211
20343 msgid "Previous versions of virt-rescue allowed you to write either:"
20347 #: ../rescue/virt-rescue.pod:213
20350 " virt-rescue disk.img [disk.img ...]\n"
20355 #: ../rescue/virt-rescue.pod:217
20358 " virt-rescue guestname\n"
20363 #: ../rescue/virt-rescue.pod:225
20368 #: ../rescue/virt-rescue.pod:227
20370 "Adding the I<--network> option enables QEMU user networking in the rescue "
20371 "appliance. There are some differences between user networking and ordinary "
20376 #: ../rescue/virt-rescue.pod:233
20377 msgid "ping does not work"
20381 #: ../rescue/virt-rescue.pod:235
20383 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
20384 "send the ping packets, and because virt-rescue must be able to run as "
20385 "non-root, QEMU user networking is not able to emulate the L<ping(8)> "
20386 "command. The ping command will appear to resolve addresses but will not be "
20387 "able to send or receive any packets. This does not mean that the network is "
20392 #: ../rescue/virt-rescue.pod:242
20393 msgid "cannot receive connections"
20397 #: ../rescue/virt-rescue.pod:244
20398 msgid "QEMU user networking cannot receive incoming connections."
20402 #: ../rescue/virt-rescue.pod:246
20403 msgid "making TCP connections"
20407 #: ../rescue/virt-rescue.pod:248
20409 "The virt-rescue appliance needs to be small and so does not include many "
20410 "network tools. In particular there is no L<telnet(1)> command. You can "
20411 "make TCP connections from the shell using the magical "
20412 "C</dev/tcp/E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
20416 #: ../rescue/virt-rescue.pod:253
20419 " exec 3<>/dev/tcp/redhat.com/80\n"
20420 " echo \"GET /\" >&3\n"
20426 #: ../rescue/virt-rescue.pod:257
20427 msgid "See L<bash(1)> for more details."
20431 #: ../rescue/virt-rescue.pod:263
20433 "Several environment variables affect virt-rescue. See "
20434 "L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
20438 #: ../rescue/virt-rescue.pod:290
20440 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
20441 "L<http://libguestfs.org/>."
20445 #: ../resize/virt-resize.pod:5
20446 msgid "virt-resize - Resize a virtual machine disk"
20450 #: ../resize/virt-resize.pod:9
20453 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
20454 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
20455 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
20460 #: ../resize/virt-resize.pod:15
20462 "Virt-resize is a tool which can resize a virtual machine disk, making it "
20463 "larger or smaller overall, and resizing or deleting any partitions contained "
20468 #: ../resize/virt-resize.pod:19
20470 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
20471 "not> be used on live virtual machines - for consistent results, shut the "
20472 "virtual machine down before resizing it."
20476 #: ../resize/virt-resize.pod:23
20478 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
20479 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
20483 #: ../resize/virt-resize.pod:31 ../resize/virt-resize.pod:520 ../src/guestfs.pod:469 ../src/guestfs.pod:1287 ../src/guestfs.pod:1426 ../src/guestfs.pod:2604
20488 #: ../resize/virt-resize.pod:33
20490 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
20491 "fill the extra 5GB of space."
20495 #: ../resize/virt-resize.pod:36
20498 " virt-filesystems --long -h --all -a olddisk\n"
20503 #: ../resize/virt-resize.pod:38
20506 " truncate -r olddisk newdisk\n"
20507 " truncate -s +5G newdisk\n"
20512 #: ../resize/virt-resize.pod:41
20515 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
20516 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
20521 #: ../resize/virt-resize.pod:44 ../resize/virt-resize.pod:527 ../src/guestfs.pod:475 ../src/guestfs.pod:1291 ../src/guestfs.pod:1430 ../src/guestfs.pod:2629
20526 #: ../resize/virt-resize.pod:46
20528 "As above, but make the /boot partition 200MB bigger, while giving the "
20529 "remaining space to /dev/sda2:"
20533 #: ../resize/virt-resize.pod:49
20536 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20537 " olddisk newdisk\n"
20542 #: ../resize/virt-resize.pod:52 ../resize/virt-resize.pod:533 ../src/guestfs.pod:486 ../src/guestfs.pod:1436
20547 #: ../resize/virt-resize.pod:54
20549 "As in the first example, but expand a logical volume as the final step. "
20550 "This is what you would typically use for Linux guests that use LVM:"
20554 #: ../resize/virt-resize.pod:58
20557 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
20558 " olddisk newdisk\n"
20563 #: ../resize/virt-resize.pod:61
20568 #: ../resize/virt-resize.pod:63
20570 "As in the first example, but the output format will be qcow2 instead of a "
20575 #: ../resize/virt-resize.pod:66
20578 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
20579 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
20584 #: ../resize/virt-resize.pod:71
20585 msgid "DETAILED USAGE"
20589 #: ../resize/virt-resize.pod:73
20590 msgid "EXPANDING A VIRTUAL MACHINE DISK"
20594 #: ../resize/virt-resize.pod:77
20595 msgid "1. Shut down the virtual machine"
20599 #: ../resize/virt-resize.pod:79
20600 msgid "2. Locate input disk image"
20604 #: ../resize/virt-resize.pod:81
20606 "Locate the input disk image (ie. the file or device on the host containing "
20607 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
20608 "dumpxml> like this to find the disk image name:"
20612 #: ../resize/virt-resize.pod:85
20615 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
20616 " Found 1 nodes:\n"
20618 " <source dev=\"/dev/vg/lv_guest\" />\n"
20623 #: ../resize/virt-resize.pod:90
20624 msgid "3. Look at current sizing"
20628 #: ../resize/virt-resize.pod:92
20629 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
20633 #: ../resize/virt-resize.pod:95
20636 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
20637 " Name Type Size Parent\n"
20638 " /dev/sda1 partition 101M /dev/sda\n"
20639 " /dev/sda2 partition 7.9G /dev/sda\n"
20640 " /dev/sda device 8.0G -\n"
20645 #: ../resize/virt-resize.pod:101
20647 "(This example is a virtual machine with an 8 GB disk which we would like to "
20648 "expand up to 10 GB)."
20652 #: ../resize/virt-resize.pod:104
20653 msgid "4. Create output disk"
20657 #: ../resize/virt-resize.pod:106
20659 "Virt-resize cannot do in-place disk modifications. You have to have space "
20660 "to store the resized output disk."
20664 #: ../resize/virt-resize.pod:109
20665 msgid "To store the resized disk image in a file, create a file of a suitable size:"
20669 #: ../resize/virt-resize.pod:112
20672 " # rm -f outdisk\n"
20673 " # truncate -s 10G outdisk\n"
20678 #: ../resize/virt-resize.pod:115
20679 msgid "Or use L<lvcreate(1)> to create a logical volume:"
20683 #: ../resize/virt-resize.pod:117
20686 " # lvcreate -L 10G -n lv_name vg_name\n"
20691 #: ../resize/virt-resize.pod:119
20692 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
20696 #: ../resize/virt-resize.pod:121
20699 " # virsh pool-list\n"
20700 " # virsh vol-create-as poolname newvol 10G\n"
20705 #: ../resize/virt-resize.pod:124
20710 #: ../resize/virt-resize.pod:126
20712 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
20713 "file) and the output disk. The output disk is the one created in the "
20718 #: ../resize/virt-resize.pod:130
20721 " # virt-resize indisk outdisk\n"
20726 #: ../resize/virt-resize.pod:132
20728 "This command just copies disk image C<indisk> to disk image C<outdisk> "
20729 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
20730 "larger, then an extra, empty partition is created at the end of the disk "
20731 "covering the extra space. If C<outdisk> is smaller, then it will give an "
20736 #: ../resize/virt-resize.pod:138
20738 "More realistically you'd want to expand existing partitions in the disk "
20739 "image by passing extra options (for the full list see the L</OPTIONS> "
20744 #: ../resize/virt-resize.pod:142
20746 "L</--expand> is the most useful option. It expands the named partition "
20747 "within the disk to fill any extra space:"
20751 #: ../resize/virt-resize.pod:145
20754 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
20759 #: ../resize/virt-resize.pod:147
20761 "(In this case, an extra partition is I<not> created at the end of the disk, "
20762 "because there will be no unused space)."
20766 #: ../resize/virt-resize.pod:150
20768 "L</--resize> is the other commonly used option. The following would "
20769 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
20770 "rest of the available space:"
20774 #: ../resize/virt-resize.pod:154
20777 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20778 " indisk outdisk\n"
20783 #: ../resize/virt-resize.pod:157
20785 "If the expanded partition in the image contains a filesystem or LVM PV, then "
20786 "if virt-resize knows how, it will resize the contents, the equivalent of "
20787 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
20788 "or L<btrfs(8)>. However virt-resize does not know how to resize some "
20789 "filesystems, so you would have to online resize them after booting the "
20794 #: ../resize/virt-resize.pod:164
20795 msgid "Other options are covered below."
20799 #: ../resize/virt-resize.pod:166
20804 #: ../resize/virt-resize.pod:168
20805 msgid "Thoroughly test the new disk image I<before> discarding the old one."
20809 #: ../resize/virt-resize.pod:170
20810 msgid "If you are using libvirt, edit the XML to point at the new disk:"
20814 #: ../resize/virt-resize.pod:172
20817 " # virsh edit guestname\n"
20822 #: ../resize/virt-resize.pod:174
20824 "Change E<lt>source ...E<gt>, see "
20825 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
20829 #: ../resize/virt-resize.pod:177
20830 msgid "Then start up the domain with the new, resized disk:"
20834 #: ../resize/virt-resize.pod:179
20837 " # virsh start guestname\n"
20842 #: ../resize/virt-resize.pod:181
20844 "and check that it still works. See also the L</NOTES> section below for "
20845 "additional information."
20849 #: ../resize/virt-resize.pod:184
20850 msgid "7. Resize LVs etc inside the guest"
20854 #: ../resize/virt-resize.pod:186
20855 msgid "(This can also be done offline using L<guestfish(1)>)"
20859 #: ../resize/virt-resize.pod:188
20861 "Once the guest has booted you should see the new space available, at least "
20862 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
20863 "may need to resize LVs inside PVs, and also resize filesystem types that "
20864 "virt-resize does not know how to expand."
20868 #: ../resize/virt-resize.pod:195
20869 msgid "SHRINKING A VIRTUAL MACHINE DISK"
20873 #: ../resize/virt-resize.pod:197
20875 "Shrinking is somewhat more complex than expanding, and only an overview is "
20880 #: ../resize/virt-resize.pod:200
20882 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
20883 "filesystems). The user has to shrink content before passing the disk image "
20884 "to virt-resize, and virt-resize will check that the content has been shrunk "
20889 #: ../resize/virt-resize.pod:205
20890 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
20894 #: ../resize/virt-resize.pod:207
20896 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
20897 "steps 3 and 4 above to allocate a new disk image."
20901 #: ../resize/virt-resize.pod:210
20902 msgid "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
20906 #: ../resize/virt-resize.pod:213
20907 msgid "IGNORING OR DELETING PARTITIONS"
20911 #: ../resize/virt-resize.pod:215
20913 "virt-resize also gives a convenient way to ignore or delete partitions when "
20914 "copying from the input disk to the output disk. Ignoring a partition speeds "
20915 "up the copy where you don't care about the existing contents of a "
20916 "partition. Deleting a partition removes it completely, but note that it "
20917 "also renumbers any partitions after the one which is deleted, which can "
20918 "leave some guests unbootable."
20922 #: ../resize/virt-resize.pod:222
20923 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
20927 #: ../resize/virt-resize.pod:224
20929 "If the input disk is in qcow2 format, then you may prefer that the output is "
20930 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
20931 "the fly. The output format is simply determined by the format of the empty "
20932 "output container that you provide. Thus to create qcow2 output, use:"
20936 #: ../resize/virt-resize.pod:230
20939 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
20944 #: ../resize/virt-resize.pod:232
20945 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
20949 #: ../resize/virt-resize.pod:234
20950 msgid "Similarly, to get non-sparse raw output use:"
20954 #: ../resize/virt-resize.pod:236
20957 " fallocate -l size outdisk\n"
20962 #: ../resize/virt-resize.pod:238
20964 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
20965 "if=/dev/zero of=outdisk bs=1M count=..>)"
20969 #: ../resize/virt-resize.pod:247
20970 msgid "Display help."
20974 #: ../resize/virt-resize.pod:249
20979 #: ../resize/virt-resize.pod:251 ../tools/virt-make-fs.pl:177 ../tools/virt-win-reg.pl:120
20984 #: ../resize/virt-resize.pod:253 ../tools/virt-win-reg.pl:122
20985 msgid "Enable debugging messages."
20989 #: ../resize/virt-resize.pod:255
20990 msgid "B<--delete part>"
20994 #: ../resize/virt-resize.pod:257
20996 "Delete the named partition. It would be more accurate to describe this as "
20997 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
20998 "the original disk image is left intact."
21002 #: ../resize/virt-resize.pod:261
21004 "Note that when you delete a partition, then anything contained in the "
21005 "partition is also deleted. Furthermore, this causes any partitions that "
21006 "come after to be I<renumbered>, which can easily make your guest unbootable."
21010 #: ../resize/virt-resize.pod:266 ../resize/virt-resize.pod:327 ../resize/virt-resize.pod:454
21011 msgid "You can give this option multiple times."
21015 #: ../resize/virt-resize.pod:268
21016 msgid "B<--expand part>"
21020 #: ../resize/virt-resize.pod:270
21022 "Expand the named partition so it uses up all extra space (space left over "
21023 "after any other resize changes that you request have been done)."
21027 #: ../resize/virt-resize.pod:273
21029 "If virt-resize knows how, it will expand the direct content of the "
21030 "partition. For example, if the partition is an LVM PV, it will expand the "
21031 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
21032 "content it doesn't know about alone."
21036 #: ../resize/virt-resize.pod:278
21037 msgid "Currently virt-resize can resize:"
21041 #: ../resize/virt-resize.pod:284
21042 msgid "ext2, ext3 and ext4 filesystems."
21046 #: ../resize/virt-resize.pod:288
21047 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
21051 #: ../resize/virt-resize.pod:290
21053 "The filesystem must have been shut down consistently last time it was used. "
21054 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
21055 "consistency check, so at the first boot after resizing Windows will check "
21060 #: ../resize/virt-resize.pod:297
21062 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
21063 "inside the PV, but see the I<--LV-expand> option. The user could also "
21064 "resize LVs as desired after boot."
21068 #: ../resize/virt-resize.pod:303
21069 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
21073 #: ../resize/virt-resize.pod:307 ../resize/virt-resize.pod:482
21074 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
21078 #: ../resize/virt-resize.pod:309 ../tools/virt-list-filesystems.pl:91 ../tools/virt-list-partitions.pl:92 ../tools/virt-tar.pl:141 ../tools/virt-win-reg.pl:142
21079 msgid "B<--format> raw"
21083 #: ../resize/virt-resize.pod:311
21085 "Specify the format of the input disk image. If this flag is not given then "
21086 "it is auto-detected from the image itself."
21090 #: ../resize/virt-resize.pod:317
21092 "Note that this option I<does not> affect the output format. See L</QCOW2 "
21093 "AND NON-SPARSE RAW FORMATS>."
21097 #: ../resize/virt-resize.pod:320
21098 msgid "B<--ignore part>"
21102 #: ../resize/virt-resize.pod:322
21104 "Ignore the named partition. Effectively this means the partition is "
21105 "allocated on the destination disk, but the content is not copied across from "
21106 "the source disk. The content of the partition will be blank (all zero "
21111 #: ../resize/virt-resize.pod:329
21112 msgid "B<--LV-expand logvol>"
21116 #: ../resize/virt-resize.pod:331
21118 "This takes the logical volume and, as a final step, expands it to fill all "
21119 "the space available in its volume group. A typical usage, assuming a Linux "
21120 "guest with a single PV C</dev/sda2> and a root device called "
21121 "C</dev/vg_guest/lv_root> would be:"
21125 #: ../resize/virt-resize.pod:336
21128 " virt-resize indisk outdisk \\\n"
21129 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
21134 #: ../resize/virt-resize.pod:339
21136 "This would first expand the partition (and PV), and then expand the root "
21137 "device to fill the extra space in the PV."
21141 #: ../resize/virt-resize.pod:342
21143 "The contents of the LV are also resized if virt-resize knows how to do "
21144 "that. You can stop virt-resize from trying to expand the content by using "
21145 "the option I<--no-expand-content>."
21149 #: ../resize/virt-resize.pod:346
21150 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
21154 #: ../resize/virt-resize.pod:348
21156 "You can give this option multiple times, I<but> it doesn't make sense to do "
21157 "this unless the logical volumes you specify are all in different volume "
21162 #: ../resize/virt-resize.pod:352
21163 msgid "B<--machine-readable>"
21167 #: ../resize/virt-resize.pod:354
21169 "This option is used to make the output more machine friendly when being "
21170 "parsed by other programs. See L</MACHINE READABLE OUTPUT> below."
21174 #: ../resize/virt-resize.pod:360
21175 msgid "B<--dryrun>"
21179 #: ../resize/virt-resize.pod:362
21180 msgid "Print a summary of what would be done, but don't do anything."
21184 #: ../resize/virt-resize.pod:364
21185 msgid "B<--no-copy-boot-loader>"
21189 #: ../resize/virt-resize.pod:366
21191 "By default, virt-resize copies over some sectors at the start of the disk "
21192 "(up to the beginning of the first partition). Commonly these sectors "
21193 "contain the Master Boot Record (MBR) and the boot loader, and are required "
21194 "in order for the guest to boot correctly."
21198 #: ../resize/virt-resize.pod:371
21200 "If you specify this flag, then this initial copy is not done. You may need "
21201 "to reinstall the boot loader in this case."
21205 #: ../resize/virt-resize.pod:374
21206 msgid "B<--no-extra-partition>"
21210 #: ../resize/virt-resize.pod:376
21212 "By default, virt-resize creates an extra partition if there is any extra, "
21213 "unused space after all resizing has happened. Use this option to prevent "
21214 "the extra partition from being created. If you do this then the extra space "
21215 "will be inaccessible until you run fdisk, parted, or some other partitioning "
21216 "tool in the guest."
21220 #: ../resize/virt-resize.pod:382
21222 "Note that if the surplus space is smaller than 10 MB, no extra partition "
21227 #: ../resize/virt-resize.pod:385
21228 msgid "B<--no-expand-content>"
21232 #: ../resize/virt-resize.pod:387
21234 "By default, virt-resize will try to expand the direct contents of "
21235 "partitions, if it knows how (see I<--expand> option above)."
21239 #: ../resize/virt-resize.pod:390
21241 "If you give the I<--no-expand-content> option then virt-resize will not "
21246 #: ../resize/virt-resize.pod:393
21247 msgid "B<--ntfsresize-force>"
21251 #: ../resize/virt-resize.pod:395
21253 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
21254 "the NTFS disk is marked as needing a consistency check. You have to use "
21255 "this option if you want to resize a Windows guest multiple times without "
21256 "booting into Windows between each resize."
21260 #: ../resize/virt-resize.pod:401
21261 msgid "B<--output-format> raw"
21265 #: ../resize/virt-resize.pod:403
21267 "Specify the format of the output disk image. If this flag is not given then "
21268 "it is auto-detected from the image itself."
21272 #: ../resize/virt-resize.pod:409
21274 "Note that this option I<does not create> the output format. This option "
21275 "just tells libguestfs what it is so it doesn't try to guess it. You still "
21276 "need to create the output disk with the right format. See L</QCOW2 AND "
21277 "NON-SPARSE RAW FORMATS>."
21281 #: ../resize/virt-resize.pod:414
21286 #: ../resize/virt-resize.pod:416
21291 #: ../resize/virt-resize.pod:418
21292 msgid "Don't print the summary."
21296 #: ../resize/virt-resize.pod:420
21297 msgid "B<--resize part=size>"
21301 #: ../resize/virt-resize.pod:422
21303 "Resize the named partition (expanding or shrinking it) so that it has the "
21308 #: ../resize/virt-resize.pod:425
21310 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
21311 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
21312 "size; or as a relative number or percentage. For example:"
21316 #: ../resize/virt-resize.pod:431
21319 " --resize /dev/sda2=10G\n"
21324 #: ../resize/virt-resize.pod:433
21327 " --resize /dev/sda4=90%\n"
21332 #: ../resize/virt-resize.pod:435
21335 " --resize /dev/sda2=+1G\n"
21340 #: ../resize/virt-resize.pod:437
21343 " --resize /dev/sda2=-200M\n"
21348 #: ../resize/virt-resize.pod:439
21351 " --resize /dev/sda1=+128K\n"
21356 #: ../resize/virt-resize.pod:441
21359 " --resize /dev/sda1=+10%\n"
21364 #: ../resize/virt-resize.pod:443
21367 " --resize /dev/sda1=-10%\n"
21372 #: ../resize/virt-resize.pod:445
21374 "You can increase the size of any partition. Virt-resize will expand the "
21375 "direct content of the partition if it knows how (see I<--expand> below)."
21379 #: ../resize/virt-resize.pod:449
21381 "You can only I<decrease> the size of partitions that contain filesystems or "
21382 "PVs which have already been shrunk. Virt-resize will check this has been "
21383 "done before proceeding, or else will print an error (see also "
21384 "I<--resize-force>)."
21388 #: ../resize/virt-resize.pod:456
21389 msgid "B<--resize-force part=size>"
21393 #: ../resize/virt-resize.pod:458
21395 "This is the same as I<--resize> except that it will let you decrease the "
21396 "size of any partition. Generally this means you will lose any data which "
21397 "was at the end of the partition you shrink, but you may not care about that "
21398 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
21399 "as a swap partition)."
21403 #: ../resize/virt-resize.pod:464
21404 msgid "See also the I<--ignore> option."
21408 #: ../resize/virt-resize.pod:466
21409 msgid "B<--shrink part>"
21413 #: ../resize/virt-resize.pod:468
21415 "Shrink the named partition until the overall disk image fits in the "
21416 "destination. The named partition B<must> contain a filesystem or PV which "
21417 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
21418 "online tools). Virt-resize will check this and give an error if it has not "
21423 #: ../resize/virt-resize.pod:474
21425 "The amount by which the overall disk must be shrunk (after carrying out all "
21426 "other operations requested by the user) is called the \"deficit\". For "
21427 "example, a straight copy (assume no other operations) from a 5GB disk image "
21428 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
21429 "would give an error unless the user specified a partition to shrink and that "
21430 "partition had more than a gigabyte of free space."
21434 #: ../resize/virt-resize.pod:492
21435 msgid "MACHINE READABLE OUTPUT"
21439 #: ../resize/virt-resize.pod:494
21441 "The I<--machine-readable> option can be used to make the output more machine "
21442 "friendly, which is useful when calling virt-resize from other programs, GUIs "
21447 #: ../resize/virt-resize.pod:498
21448 msgid "There are two ways to use this option."
21452 #: ../resize/virt-resize.pod:500
21454 "Firstly use the option on its own to query the capabilities of the "
21455 "virt-resize binary. Typical output looks like this:"
21459 #: ../resize/virt-resize.pod:503
21462 " $ virt-resize --machine-readable\n"
21464 " ntfsresize-force\n"
21472 #: ../resize/virt-resize.pod:510
21474 "A list of features is printed, one per line, and the program exits with "
21479 #: ../resize/virt-resize.pod:513
21481 "Secondly use the option in conjunction with other options to make the "
21482 "regular program output more machine friendly."
21486 #: ../resize/virt-resize.pod:516
21487 msgid "At the moment this means:"
21491 #: ../resize/virt-resize.pod:522
21493 "Progress bar messages can be parsed from stdout by looking for this regular "
21498 #: ../resize/virt-resize.pod:525
21501 " ^[0-9]+/[0-9]+$\n"
21506 #: ../resize/virt-resize.pod:529
21508 "The calling program should treat messages sent to stdout (except for "
21509 "progress bar messages) as status messages. They can be logged and/or "
21510 "displayed to the user."
21514 #: ../resize/virt-resize.pod:535
21516 "The calling program should treat messages sent to stderr as error messages. "
21517 "In addition, virt-resize exits with a non-zero status code if there was a "
21522 #: ../resize/virt-resize.pod:541
21524 "Versions of the program prior to 1.13.9 did not support the "
21525 "I<--machine-readable> option and will return an error."
21529 #: ../resize/virt-resize.pod:546
21530 msgid "\"Partition 1 does not end on cylinder boundary.\""
21534 #: ../resize/virt-resize.pod:548
21536 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
21537 "means the partitions will not be aligned to the ancient CHS geometry. "
21538 "However CHS geometry is meaningless for disks manufactured since the early "
21539 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
21540 "cylinders is not required by any modern operating system."
21544 #: ../resize/virt-resize.pod:555
21545 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
21549 #: ../resize/virt-resize.pod:557
21551 "In Windows Vista and later versions, Microsoft switched to using a separate "
21552 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
21553 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
21554 "the boot partition. Doing so seems to break the guest completely. However "
21555 "expanding the second partition (ie. C: drive) should work."
21559 #: ../resize/virt-resize.pod:564
21561 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
21562 "NTFS partitions have been expanded. This is just a safety check and (unless "
21563 "it find errors) is nothing to worry about."
21567 #: ../resize/virt-resize.pod:568
21568 msgid "GUEST BOOT STUCK AT \"GRUB\""
21572 #: ../resize/virt-resize.pod:570
21574 "If a Linux guest does not boot after resizing, and the boot is stuck after "
21575 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
21576 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
21577 "although we think is to do with partition alignment."
21581 #: ../resize/virt-resize.pod:575
21584 " guestfish -i -a newdisk\n"
21585 " ><fs> cat /boot/grub/device.map\n"
21586 " # check the contents of this file are sensible or\n"
21587 " # edit the file if necessary\n"
21588 " ><fs> grub-install / /dev/vda\n"
21594 #: ../resize/virt-resize.pod:582
21596 "For more flexible guest reconfiguration, including if you need to specify "
21597 "other parameters to grub-install, use L<virt-rescue(1)>."
21601 #: ../resize/virt-resize.pod:585
21602 msgid "ALTERNATIVE TOOLS"
21606 #: ../resize/virt-resize.pod:587
21608 "There are several proprietary tools for resizing partitions. We won't "
21609 "mention any here."
21613 #: ../resize/virt-resize.pod:590
21615 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
21616 "operations on disk images. They can resize and move partitions, but I don't "
21617 "think they can do anything with the contents, and they certainly don't "
21622 #: ../resize/virt-resize.pod:595
21624 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
21625 "but at a much lower level. You will probably end up hand-calculating sector "
21626 "offsets, which is something that virt-resize was designed to avoid. If you "
21627 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
21632 #: ../resize/virt-resize.pod:615
21634 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
21635 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
21636 "L<ntfsresize(8)>, L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
21637 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
21638 "L<http://libguestfs.org/>."
21642 #: ../ruby/examples/guestfs-ruby.pod:5
21643 msgid "guestfs-ruby - How to use libguestfs from Ruby"
21647 #: ../ruby/examples/guestfs-ruby.pod:9
21650 " require 'guestfs'\n"
21651 " g = Guestfs::Guestfs.new()\n"
21652 " g.add_drive_opts(\"disk.img\",\n"
21653 " :readonly => 1, :format => \"raw\")\n"
21659 #: ../ruby/examples/guestfs-ruby.pod:17
21661 "This manual page documents how to call libguestfs from the Ruby programming "
21662 "language. This page just documents the differences from the C API and gives "
21663 "some examples. If you are not familiar with using libguestfs, you also need "
21664 "to read L<guestfs(3)>."
21668 #: ../ruby/examples/guestfs-ruby.pod:24
21670 "Errors from libguestfs functions are mapped into the C<Error> exception. "
21671 "This has a single parameter which is the error message (a string)."
21675 #: ../ruby/examples/guestfs-ruby.pod:38
21677 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-erlang(3)>, "
21678 "L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
21679 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<http://libguestfs.org/>."
21683 #: ../src/guestfs-actions.pod:1
21684 msgid "guestfs_add_cdrom"
21688 #: ../src/guestfs-actions.pod:3
21692 " guestfs_add_cdrom (guestfs_h *g,\n"
21693 " const char *filename);\n"
21698 #: ../src/guestfs-actions.pod:7 ../src/guestfs-actions.pod:249 ../src/guestfs-actions.pod:270
21700 "I<This function is deprecated.> In new code, use the "
21701 "L</guestfs_add_drive_opts> call instead."
21705 #: ../src/guestfs-actions.pod:24
21707 "This call checks for the existence of C<filename>. This stops you from "
21708 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21709 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
21714 #: ../src/guestfs-actions.pod:31
21716 "If you just want to add an ISO file (often you use this as an efficient way "
21717 "to transfer large files into the guest), then you should probably use "
21718 "C<guestfs_add_drive_ro> instead."
21722 #: ../src/guestfs-actions.pod:37 ../src/guestfs-actions.pod:140 ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:259 ../src/guestfs-actions.pod:280 ../src/guestfs-actions.pod:293 ../src/guestfs-actions.pod:307 ../src/guestfs-actions.pod:427 ../src/guestfs-actions.pod:447 ../src/guestfs-actions.pod:461 ../src/guestfs-actions.pod:506 ../src/guestfs-actions.pod:534 ../src/guestfs-actions.pod:552 ../src/guestfs-actions.pod:619 ../src/guestfs-actions.pod:652 ../src/guestfs-actions.pod:666 ../src/guestfs-actions.pod:681 ../src/guestfs-actions.pod:780 ../src/guestfs-actions.pod:798 ../src/guestfs-actions.pod:812 ../src/guestfs-actions.pod:826 ../src/guestfs-actions.pod:863 ../src/guestfs-actions.pod:1046 ../src/guestfs-actions.pod:1066 ../src/guestfs-actions.pod:1084 ../src/guestfs-actions.pod:1174 ../src/guestfs-actions.pod:1231 ../src/guestfs-actions.pod:1275 ../src/guestfs-actions.pod:1293 ../src/guestfs-actions.pod:1312 ../src/guestfs-actions.pod:1326 ../src/guestfs-actions.pod:1346 ../src/guestfs-actions.pod:1416 ../src/guestfs-actions.pod:1447 ../src/guestfs-actions.pod:1472 ../src/guestfs-actions.pod:1514 ../src/guestfs-actions.pod:1627 ../src/guestfs-actions.pod:1654 ../src/guestfs-actions.pod:1869 ../src/guestfs-actions.pod:1891 ../src/guestfs-actions.pod:1978 ../src/guestfs-actions.pod:2484 ../src/guestfs-actions.pod:2628 ../src/guestfs-actions.pod:2689 ../src/guestfs-actions.pod:2724 ../src/guestfs-actions.pod:3768 ../src/guestfs-actions.pod:3783 ../src/guestfs-actions.pod:3808 ../src/guestfs-actions.pod:3997 ../src/guestfs-actions.pod:4011 ../src/guestfs-actions.pod:4024 ../src/guestfs-actions.pod:4038 ../src/guestfs-actions.pod:4053 ../src/guestfs-actions.pod:4089 ../src/guestfs-actions.pod:4161 ../src/guestfs-actions.pod:4181 ../src/guestfs-actions.pod:4198 ../src/guestfs-actions.pod:4221 ../src/guestfs-actions.pod:4244 ../src/guestfs-actions.pod:4279 ../src/guestfs-actions.pod:4298 ../src/guestfs-actions.pod:4317 ../src/guestfs-actions.pod:4352 ../src/guestfs-actions.pod:4364 ../src/guestfs-actions.pod:4400 ../src/guestfs-actions.pod:4416 ../src/guestfs-actions.pod:4429 ../src/guestfs-actions.pod:4444 ../src/guestfs-actions.pod:4461 ../src/guestfs-actions.pod:4554 ../src/guestfs-actions.pod:4574 ../src/guestfs-actions.pod:4587 ../src/guestfs-actions.pod:4638 ../src/guestfs-actions.pod:4656 ../src/guestfs-actions.pod:4674 ../src/guestfs-actions.pod:4690 ../src/guestfs-actions.pod:4704 ../src/guestfs-actions.pod:4718 ../src/guestfs-actions.pod:4735 ../src/guestfs-actions.pod:4750 ../src/guestfs-actions.pod:4777 ../src/guestfs-actions.pod:4840 ../src/guestfs-actions.pod:4913 ../src/guestfs-actions.pod:4944 ../src/guestfs-actions.pod:4963 ../src/guestfs-actions.pod:4982 ../src/guestfs-actions.pod:4994 ../src/guestfs-actions.pod:5011 ../src/guestfs-actions.pod:5024 ../src/guestfs-actions.pod:5039 ../src/guestfs-actions.pod:5054 ../src/guestfs-actions.pod:5086 ../src/guestfs-actions.pod:5112 ../src/guestfs-actions.pod:5151 ../src/guestfs-actions.pod:5171 ../src/guestfs-actions.pod:5185 ../src/guestfs-actions.pod:5202 ../src/guestfs-actions.pod:5251 ../src/guestfs-actions.pod:5304 ../src/guestfs-actions.pod:5351 ../src/guestfs-actions.pod:5394 ../src/guestfs-actions.pod:5422 ../src/guestfs-actions.pod:5439 ../src/guestfs-actions.pod:5457 ../src/guestfs-actions.pod:5597 ../src/guestfs-actions.pod:5654 ../src/guestfs-actions.pod:5676 ../src/guestfs-actions.pod:5694 ../src/guestfs-actions.pod:5726 ../src/guestfs-actions.pod:5792 ../src/guestfs-actions.pod:5809 ../src/guestfs-actions.pod:5822 ../src/guestfs-actions.pod:5836 ../src/guestfs-actions.pod:6125 ../src/guestfs-actions.pod:6144 ../src/guestfs-actions.pod:6163 ../src/guestfs-actions.pod:6177 ../src/guestfs-actions.pod:6189 ../src/guestfs-actions.pod:6203 ../src/guestfs-actions.pod:6215 ../src/guestfs-actions.pod:6229 ../src/guestfs-actions.pod:6245 ../src/guestfs-actions.pod:6266 ../src/guestfs-actions.pod:6285 ../src/guestfs-actions.pod:6304 ../src/guestfs-actions.pod:6334 ../src/guestfs-actions.pod:6352 ../src/guestfs-actions.pod:6375 ../src/guestfs-actions.pod:6393 ../src/guestfs-actions.pod:6412 ../src/guestfs-actions.pod:6433 ../src/guestfs-actions.pod:6452 ../src/guestfs-actions.pod:6469 ../src/guestfs-actions.pod:6488 ../src/guestfs-actions.pod:6516 ../src/guestfs-actions.pod:6540 ../src/guestfs-actions.pod:6559 ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:6597 ../src/guestfs-actions.pod:6616 ../src/guestfs-actions.pod:6631 ../src/guestfs-actions.pod:6650 ../src/guestfs-actions.pod:6694 ../src/guestfs-actions.pod:6724 ../src/guestfs-actions.pod:6757 ../src/guestfs-actions.pod:6872 ../src/guestfs-actions.pod:6993 ../src/guestfs-actions.pod:7005 ../src/guestfs-actions.pod:7018 ../src/guestfs-actions.pod:7031 ../src/guestfs-actions.pod:7053 ../src/guestfs-actions.pod:7066 ../src/guestfs-actions.pod:7079 ../src/guestfs-actions.pod:7092 ../src/guestfs-actions.pod:7107 ../src/guestfs-actions.pod:7166 ../src/guestfs-actions.pod:7183 ../src/guestfs-actions.pod:7199 ../src/guestfs-actions.pod:7215 ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7245 ../src/guestfs-actions.pod:7265 ../src/guestfs-actions.pod:7301 ../src/guestfs-actions.pod:7315 ../src/guestfs-actions.pod:7356 ../src/guestfs-actions.pod:7369 ../src/guestfs-actions.pod:7387 ../src/guestfs-actions.pod:7421 ../src/guestfs-actions.pod:7457 ../src/guestfs-actions.pod:7573 ../src/guestfs-actions.pod:7588 ../src/guestfs-actions.pod:7602 ../src/guestfs-actions.pod:7657 ../src/guestfs-actions.pod:7670 ../src/guestfs-actions.pod:7715 ../src/guestfs-actions.pod:7755 ../src/guestfs-actions.pod:7811 ../src/guestfs-actions.pod:7831 ../src/guestfs-actions.pod:7864 ../src/guestfs-actions.pod:7928 ../src/guestfs-actions.pod:7951 ../src/guestfs-actions.pod:7980
21723 msgid "This function returns 0 on success or -1 on error."
21727 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142 ../src/guestfs-actions.pod:1277 ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2190 ../src/guestfs-actions.pod:2313 ../src/guestfs-actions.pod:3770 ../src/guestfs-actions.pod:3790 ../src/guestfs-actions.pod:5088 ../src/guestfs-actions.pod:6354 ../src/guestfs-actions.pod:6471 ../src/guestfs-actions.pod:6618 ../src/guestfs-actions.pod:7109 ../src/guestfs-actions.pod:7234 ../src/guestfs-actions.pod:7757
21728 msgid "(Added in 0.3)"
21732 #: ../src/guestfs-actions.pod:41
21733 msgid "guestfs_add_domain"
21737 #: ../src/guestfs-actions.pod:43
21741 " guestfs_add_domain (guestfs_h *g,\n"
21742 " const char *dom,\n"
21748 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151 ../src/guestfs-actions.pod:837 ../src/guestfs-actions.pod:1161 ../src/guestfs-actions.pod:1211 ../src/guestfs-actions.pod:2973 ../src/guestfs-actions.pod:4789 ../src/guestfs-actions.pod:5098 ../src/guestfs-actions.pod:5315
21750 "You may supply a list of optional arguments to this call. Use zero or more "
21751 "of the following pairs of parameters, and terminate the list with C<-1> on "
21752 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
21756 #: ../src/guestfs-actions.pod:53
21759 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
21760 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
21761 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
21762 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
21763 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
21768 #: ../src/guestfs-actions.pod:59
21770 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21771 "It works by connecting to libvirt, requesting the domain and domain XML from "
21772 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
21777 #: ../src/guestfs-actions.pod:94
21779 "The other optional parameters are passed directly through to "
21780 "C<guestfs_add_drive_opts>."
21784 #: ../src/guestfs-actions.pod:97 ../src/guestfs-actions.pod:350 ../src/guestfs-actions.pod:520 ../src/guestfs-actions.pod:698 ../src/guestfs-actions.pod:729 ../src/guestfs-actions.pod:747 ../src/guestfs-actions.pod:766 ../src/guestfs-actions.pod:1492 ../src/guestfs-actions.pod:1848 ../src/guestfs-actions.pod:2051 ../src/guestfs-actions.pod:2162 ../src/guestfs-actions.pod:2213 ../src/guestfs-actions.pod:2265 ../src/guestfs-actions.pod:2277 ../src/guestfs-actions.pod:2300 ../src/guestfs-actions.pod:2615 ../src/guestfs-actions.pod:3091 ../src/guestfs-actions.pod:3109 ../src/guestfs-actions.pod:5274 ../src/guestfs-actions.pod:5494 ../src/guestfs-actions.pod:5906 ../src/guestfs-actions.pod:5932 ../src/guestfs-actions.pod:7342 ../src/guestfs-actions.pod:7768 ../src/guestfs-actions.pod:7781 ../src/guestfs-actions.pod:7794
21785 msgid "On error this function returns -1."
21789 #: ../src/guestfs-actions.pod:99
21790 msgid "(Added in 1.7.4)"
21794 #: ../src/guestfs-actions.pod:101
21795 msgid "guestfs_add_domain_va"
21799 #: ../src/guestfs-actions.pod:103
21803 " guestfs_add_domain_va (guestfs_h *g,\n"
21804 " const char *dom,\n"
21805 " va_list args);\n"
21810 #: ../src/guestfs-actions.pod:108
21811 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
21815 #: ../src/guestfs-actions.pod:110 ../src/guestfs-actions.pod:121 ../src/guestfs-actions.pod:214 ../src/guestfs-actions.pod:225 ../src/guestfs-actions.pod:876 ../src/guestfs-actions.pod:887 ../src/guestfs-actions.pod:1187 ../src/guestfs-actions.pod:1200 ../src/guestfs-actions.pod:1244 ../src/guestfs-actions.pod:1257 ../src/guestfs-actions.pod:3057 ../src/guestfs-actions.pod:3069 ../src/guestfs-actions.pod:4854 ../src/guestfs-actions.pod:4866 ../src/guestfs-actions.pod:5126 ../src/guestfs-actions.pod:5138 ../src/guestfs-actions.pod:5364 ../src/guestfs-actions.pod:5375
21816 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
21820 #: ../src/guestfs-actions.pod:112
21821 msgid "guestfs_add_domain_argv"
21825 #: ../src/guestfs-actions.pod:114
21829 " guestfs_add_domain_argv (guestfs_h *g,\n"
21830 " const char *dom,\n"
21831 " const struct guestfs_add_domain_argv *optargs);\n"
21836 #: ../src/guestfs-actions.pod:119
21837 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
21841 #: ../src/guestfs-actions.pod:123
21842 msgid "guestfs_add_drive"
21846 #: ../src/guestfs-actions.pod:125
21850 " guestfs_add_drive (guestfs_h *g,\n"
21851 " const char *filename);\n"
21856 #: ../src/guestfs-actions.pod:129
21858 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
21859 "optional parameters, so the disk is added writable, with the format being "
21860 "detected automatically."
21864 #: ../src/guestfs-actions.pod:133
21866 "Automatic detection of the format opens you up to a potential security hole "
21867 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21868 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21869 "you should think about replacing calls to this function with calls to "
21870 "C<guestfs_add_drive_opts>, and specifying the format."
21874 #: ../src/guestfs-actions.pod:144
21875 msgid "guestfs_add_drive_opts"
21879 #: ../src/guestfs-actions.pod:146
21883 " guestfs_add_drive_opts (guestfs_h *g,\n"
21884 " const char *filename,\n"
21890 #: ../src/guestfs-actions.pod:156
21893 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
21894 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
21895 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
21900 #: ../src/guestfs-actions.pod:185
21902 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
21903 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
21904 "Possible formats include C<raw> and C<qcow2>."
21908 #: ../src/guestfs-actions.pod:196
21910 "This rarely-used option lets you emulate the behaviour of the deprecated "
21911 "C<guestfs_add_drive_with_if> call (q.v.)"
21915 #: ../src/guestfs-actions.pod:203
21916 msgid "(Added in 1.5.23)"
21920 #: ../src/guestfs-actions.pod:205
21921 msgid "guestfs_add_drive_opts_va"
21925 #: ../src/guestfs-actions.pod:207
21929 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
21930 " const char *filename,\n"
21931 " va_list args);\n"
21936 #: ../src/guestfs-actions.pod:212
21937 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
21941 #: ../src/guestfs-actions.pod:216
21942 msgid "guestfs_add_drive_opts_argv"
21946 #: ../src/guestfs-actions.pod:218
21950 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
21951 " const char *filename,\n"
21952 " const struct guestfs_add_drive_opts_argv "
21958 #: ../src/guestfs-actions.pod:223
21959 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
21963 #: ../src/guestfs-actions.pod:227
21964 msgid "guestfs_add_drive_ro"
21968 #: ../src/guestfs-actions.pod:229
21972 " guestfs_add_drive_ro (guestfs_h *g,\n"
21973 " const char *filename);\n"
21978 #: ../src/guestfs-actions.pod:233
21980 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
21981 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
21982 "disk is added read-only, with the format being detected automatically."
21986 #: ../src/guestfs-actions.pod:240
21987 msgid "(Added in 1.0.38)"
21991 #: ../src/guestfs-actions.pod:242
21992 msgid "guestfs_add_drive_ro_with_if"
21996 #: ../src/guestfs-actions.pod:244
22000 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
22001 " const char *filename,\n"
22002 " const char *iface);\n"
22007 #: ../src/guestfs-actions.pod:256
22009 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
22010 "QEMU interface emulation to use at run time."
22014 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282 ../src/guestfs-actions.pod:2574
22015 msgid "(Added in 1.0.84)"
22019 #: ../src/guestfs-actions.pod:263
22020 msgid "guestfs_add_drive_with_if"
22024 #: ../src/guestfs-actions.pod:265
22028 " guestfs_add_drive_with_if (guestfs_h *g,\n"
22029 " const char *filename,\n"
22030 " const char *iface);\n"
22035 #: ../src/guestfs-actions.pod:277
22037 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
22038 "QEMU interface emulation to use at run time."
22042 #: ../src/guestfs-actions.pod:284
22043 msgid "guestfs_aug_clear"
22047 #: ../src/guestfs-actions.pod:286
22051 " guestfs_aug_clear (guestfs_h *g,\n"
22052 " const char *augpath);\n"
22057 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2302
22058 msgid "(Added in 1.3.4)"
22062 #: ../src/guestfs-actions.pod:297
22063 msgid "guestfs_aug_close"
22067 #: ../src/guestfs-actions.pod:299
22071 " guestfs_aug_close (guestfs_h *g);\n"
22076 #: ../src/guestfs-actions.pod:302
22078 "Close the current Augeas handle and free up any resources used by it. After "
22079 "calling this, you have to call C<guestfs_aug_init> again before you can use "
22080 "any other Augeas functions."
22084 #: ../src/guestfs-actions.pod:309 ../src/guestfs-actions.pod:334 ../src/guestfs-actions.pod:352 ../src/guestfs-actions.pod:366 ../src/guestfs-actions.pod:429 ../src/guestfs-actions.pod:449 ../src/guestfs-actions.pod:463 ../src/guestfs-actions.pod:494 ../src/guestfs-actions.pod:508 ../src/guestfs-actions.pod:522 ../src/guestfs-actions.pod:536 ../src/guestfs-actions.pod:554 ../src/guestfs-actions.pod:5983
22085 msgid "(Added in 0.7)"
22089 #: ../src/guestfs-actions.pod:311
22090 msgid "guestfs_aug_defnode"
22094 #: ../src/guestfs-actions.pod:313
22097 " struct guestfs_int_bool *\n"
22098 " guestfs_aug_defnode (guestfs_h *g,\n"
22099 " const char *name,\n"
22100 " const char *expr,\n"
22101 " const char *val);\n"
22106 #: ../src/guestfs-actions.pod:322
22108 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
22109 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
22110 "containing that single node."
22114 #: ../src/guestfs-actions.pod:330
22116 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
22117 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
22121 #: ../src/guestfs-actions.pod:336
22122 msgid "guestfs_aug_defvar"
22126 #: ../src/guestfs-actions.pod:338
22130 " guestfs_aug_defvar (guestfs_h *g,\n"
22131 " const char *name,\n"
22132 " const char *expr);\n"
22137 #: ../src/guestfs-actions.pod:354
22138 msgid "guestfs_aug_get"
22142 #: ../src/guestfs-actions.pod:356
22146 " guestfs_aug_get (guestfs_h *g,\n"
22147 " const char *augpath);\n"
22152 #: ../src/guestfs-actions.pod:363 ../src/guestfs-actions.pod:927 ../src/guestfs-actions.pod:945 ../src/guestfs-actions.pod:1005 ../src/guestfs-actions.pod:1021 ../src/guestfs-actions.pod:1124 ../src/guestfs-actions.pod:1361 ../src/guestfs-actions.pod:1378 ../src/guestfs-actions.pod:1397 ../src/guestfs-actions.pod:1531 ../src/guestfs-actions.pod:1719 ../src/guestfs-actions.pod:1831 ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:2011 ../src/guestfs-actions.pod:2078 ../src/guestfs-actions.pod:2121 ../src/guestfs-actions.pod:2142 ../src/guestfs-actions.pod:2325 ../src/guestfs-actions.pod:2539 ../src/guestfs-actions.pod:2743 ../src/guestfs-actions.pod:2837 ../src/guestfs-actions.pod:2941 ../src/guestfs-actions.pod:2960 ../src/guestfs-actions.pod:3174 ../src/guestfs-actions.pod:3202 ../src/guestfs-actions.pod:3223 ../src/guestfs-actions.pod:3257 ../src/guestfs-actions.pod:3316 ../src/guestfs-actions.pod:3336 ../src/guestfs-actions.pod:3356 ../src/guestfs-actions.pod:3983 ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:4506 ../src/guestfs-actions.pod:4616 ../src/guestfs-actions.pod:5512 ../src/guestfs-actions.pod:5711 ../src/guestfs-actions.pod:5881 ../src/guestfs-actions.pod:6059 ../src/guestfs-actions.pod:6108 ../src/guestfs-actions.pod:6778 ../src/guestfs-actions.pod:6794 ../src/guestfs-actions.pod:6818 ../src/guestfs-actions.pod:6842 ../src/guestfs-actions.pod:7516 ../src/guestfs-actions.pod:7535 ../src/guestfs-actions.pod:7553 ../src/guestfs-actions.pod:7727 ../src/guestfs-actions.pod:8044
22154 "This function returns a string, or NULL on error. I<The caller must free "
22155 "the returned string after use>."
22159 #: ../src/guestfs-actions.pod:368
22160 msgid "guestfs_aug_init"
22164 #: ../src/guestfs-actions.pod:370
22168 " guestfs_aug_init (guestfs_h *g,\n"
22169 " const char *root,\n"
22175 #: ../src/guestfs-actions.pod:379
22176 msgid "You must call this before using any other C<guestfs_aug_*> commands."
22180 #: ../src/guestfs-actions.pod:404
22182 "This option is only useful when debugging Augeas lenses. Use of this option "
22183 "may require additional memory for the libguestfs appliance. You may need to "
22184 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
22185 "C<guestfs_set_memsize>."
22189 #: ../src/guestfs-actions.pod:419
22190 msgid "Do not load the tree in C<guestfs_aug_init>."
22194 #: ../src/guestfs-actions.pod:423
22195 msgid "To close the handle, you can call C<guestfs_aug_close>."
22199 #: ../src/guestfs-actions.pod:431
22200 msgid "guestfs_aug_insert"
22204 #: ../src/guestfs-actions.pod:433
22208 " guestfs_aug_insert (guestfs_h *g,\n"
22209 " const char *augpath,\n"
22210 " const char *label,\n"
22216 #: ../src/guestfs-actions.pod:451
22217 msgid "guestfs_aug_load"
22221 #: ../src/guestfs-actions.pod:453
22225 " guestfs_aug_load (guestfs_h *g);\n"
22230 #: ../src/guestfs-actions.pod:465
22231 msgid "guestfs_aug_ls"
22235 #: ../src/guestfs-actions.pod:467
22239 " guestfs_aug_ls (guestfs_h *g,\n"
22240 " const char *augpath);\n"
22245 #: ../src/guestfs-actions.pod:471
22247 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
22248 "sorting the resulting nodes into alphabetical order."
22252 #: ../src/guestfs-actions.pod:474 ../src/guestfs-actions.pod:490 ../src/guestfs-actions.pod:636 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1546 ../src/guestfs-actions.pod:1565 ../src/guestfs-actions.pod:1668 ../src/guestfs-actions.pod:1687 ../src/guestfs-actions.pod:1933 ../src/guestfs-actions.pod:2397 ../src/guestfs-actions.pod:2413 ../src/guestfs-actions.pod:2432 ../src/guestfs-actions.pod:2497 ../src/guestfs-actions.pod:2521 ../src/guestfs-actions.pod:2592 ../src/guestfs-actions.pod:2641 ../src/guestfs-actions.pod:2902 ../src/guestfs-actions.pod:3276 ../src/guestfs-actions.pod:3552 ../src/guestfs-actions.pod:3866 ../src/guestfs-actions.pod:3883 ../src/guestfs-actions.pod:3903 ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:4070 ../src/guestfs-actions.pod:4478 ../src/guestfs-actions.pod:5235 ../src/guestfs-actions.pod:5853 ../src/guestfs-actions.pod:5979 ../src/guestfs-actions.pod:6093 ../src/guestfs-actions.pod:6858 ../src/guestfs-actions.pod:6919 ../src/guestfs-actions.pod:6974 ../src/guestfs-actions.pod:7120 ../src/guestfs-actions.pod:7144 ../src/guestfs-actions.pod:7620 ../src/guestfs-actions.pod:7640 ../src/guestfs-actions.pod:7687 ../src/guestfs-actions.pod:7881 ../src/guestfs-actions.pod:7900 ../src/guestfs-actions.pod:7994 ../src/guestfs-actions.pod:8013 ../src/guestfs-actions.pod:8059 ../src/guestfs-actions.pod:8078
22254 "This function returns a NULL-terminated array of strings (like "
22255 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
22256 "strings and the array after use>."
22260 #: ../src/guestfs-actions.pod:478 ../src/guestfs-actions.pod:1068 ../src/guestfs-actions.pod:1086 ../src/guestfs-actions.pod:1603 ../src/guestfs-actions.pod:3630 ../src/guestfs-actions.pod:3661 ../src/guestfs-actions.pod:4319 ../src/guestfs-actions.pod:4369 ../src/guestfs-actions.pod:4556 ../src/guestfs-actions.pod:4589 ../src/guestfs-actions.pod:4752 ../src/guestfs-actions.pod:5239 ../src/guestfs-actions.pod:5794 ../src/guestfs-actions.pod:6191 ../src/guestfs-actions.pod:6205 ../src/guestfs-actions.pod:6217 ../src/guestfs-actions.pod:6699 ../src/guestfs-actions.pod:7358 ../src/guestfs-actions.pod:7371 ../src/guestfs-actions.pod:7604 ../src/guestfs-actions.pod:7869
22261 msgid "(Added in 0.8)"
22265 #: ../src/guestfs-actions.pod:480
22266 msgid "guestfs_aug_match"
22270 #: ../src/guestfs-actions.pod:482
22274 " guestfs_aug_match (guestfs_h *g,\n"
22275 " const char *augpath);\n"
22280 #: ../src/guestfs-actions.pod:496
22281 msgid "guestfs_aug_mv"
22285 #: ../src/guestfs-actions.pod:498
22289 " guestfs_aug_mv (guestfs_h *g,\n"
22290 " const char *src,\n"
22291 " const char *dest);\n"
22296 #: ../src/guestfs-actions.pod:510
22297 msgid "guestfs_aug_rm"
22301 #: ../src/guestfs-actions.pod:512
22305 " guestfs_aug_rm (guestfs_h *g,\n"
22306 " const char *augpath);\n"
22311 #: ../src/guestfs-actions.pod:524
22312 msgid "guestfs_aug_save"
22316 #: ../src/guestfs-actions.pod:526
22320 " guestfs_aug_save (guestfs_h *g);\n"
22325 #: ../src/guestfs-actions.pod:531
22327 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
22332 #: ../src/guestfs-actions.pod:538
22333 msgid "guestfs_aug_set"
22337 #: ../src/guestfs-actions.pod:540
22341 " guestfs_aug_set (guestfs_h *g,\n"
22342 " const char *augpath,\n"
22343 " const char *val);\n"
22348 #: ../src/guestfs-actions.pod:547
22350 "In the Augeas API, it is possible to clear a node by setting the value to "
22351 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22352 "this call. Instead you must use the C<guestfs_aug_clear> call."
22356 #: ../src/guestfs-actions.pod:556
22357 msgid "guestfs_available"
22361 #: ../src/guestfs-actions.pod:558
22365 " guestfs_available (guestfs_h *g,\n"
22366 " char *const *groups);\n"
22371 #: ../src/guestfs-actions.pod:566
22373 "The libguestfs groups, and the functions that those groups correspond to, "
22374 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22375 "runtime by calling C<guestfs_available_all_groups>."
22379 #: ../src/guestfs-actions.pod:590
22380 msgid "You must call C<guestfs_launch> before calling this function."
22384 #: ../src/guestfs-actions.pod:612
22386 "This call was added in version C<1.0.80>. In previous versions of "
22387 "libguestfs all you could do would be to speculatively execute a command to "
22388 "find out if the daemon implemented it. See also C<guestfs_version>."
22392 #: ../src/guestfs-actions.pod:621 ../src/guestfs-actions.pod:1348
22393 msgid "(Added in 1.0.80)"
22397 #: ../src/guestfs-actions.pod:623
22398 msgid "guestfs_available_all_groups"
22402 #: ../src/guestfs-actions.pod:625
22406 " guestfs_available_all_groups (guestfs_h *g);\n"
22411 #: ../src/guestfs-actions.pod:628
22413 "This command returns a list of all optional groups that this daemon knows "
22414 "about. Note this returns both supported and unsupported groups. To find "
22415 "out which ones the daemon can actually support you have to call "
22416 "C<guestfs_available> on each member of the returned list."
22420 #: ../src/guestfs-actions.pod:634
22421 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
22425 #: ../src/guestfs-actions.pod:640
22426 msgid "(Added in 1.3.15)"
22430 #: ../src/guestfs-actions.pod:642
22431 msgid "guestfs_base64_in"
22435 #: ../src/guestfs-actions.pod:644
22439 " guestfs_base64_in (guestfs_h *g,\n"
22440 " const char *base64file,\n"
22441 " const char *filename);\n"
22446 #: ../src/guestfs-actions.pod:654 ../src/guestfs-actions.pod:668
22447 msgid "(Added in 1.3.5)"
22451 #: ../src/guestfs-actions.pod:656
22452 msgid "guestfs_base64_out"
22456 #: ../src/guestfs-actions.pod:658
22460 " guestfs_base64_out (guestfs_h *g,\n"
22461 " const char *filename,\n"
22462 " const char *base64file);\n"
22467 #: ../src/guestfs-actions.pod:670
22468 msgid "guestfs_blockdev_flushbufs"
22472 #: ../src/guestfs-actions.pod:672
22476 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
22477 " const char *device);\n"
22482 #: ../src/guestfs-actions.pod:683 ../src/guestfs-actions.pod:700 ../src/guestfs-actions.pod:715 ../src/guestfs-actions.pod:731 ../src/guestfs-actions.pod:749 ../src/guestfs-actions.pod:768 ../src/guestfs-actions.pod:782 ../src/guestfs-actions.pod:800 ../src/guestfs-actions.pod:814 ../src/guestfs-actions.pod:828
22483 msgid "(Added in 0.9.3)"
22487 #: ../src/guestfs-actions.pod:685
22488 msgid "guestfs_blockdev_getbsz"
22492 #: ../src/guestfs-actions.pod:687
22496 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
22497 " const char *device);\n"
22502 #: ../src/guestfs-actions.pod:702
22503 msgid "guestfs_blockdev_getro"
22507 #: ../src/guestfs-actions.pod:704
22511 " guestfs_blockdev_getro (guestfs_h *g,\n"
22512 " const char *device);\n"
22517 #: ../src/guestfs-actions.pod:713 ../src/guestfs-actions.pod:1586 ../src/guestfs-actions.pod:1601 ../src/guestfs-actions.pod:2090 ../src/guestfs-actions.pod:2101 ../src/guestfs-actions.pod:2173 ../src/guestfs-actions.pod:2199 ../src/guestfs-actions.pod:2239 ../src/guestfs-actions.pod:2254 ../src/guestfs-actions.pod:2288 ../src/guestfs-actions.pod:2311 ../src/guestfs-actions.pod:3373 ../src/guestfs-actions.pod:3389 ../src/guestfs-actions.pod:3407 ../src/guestfs-actions.pod:3569 ../src/guestfs-actions.pod:3583 ../src/guestfs-actions.pod:3598 ../src/guestfs-actions.pod:3612 ../src/guestfs-actions.pod:3628 ../src/guestfs-actions.pod:3643 ../src/guestfs-actions.pod:3659 ../src/guestfs-actions.pod:3673 ../src/guestfs-actions.pod:3686 ../src/guestfs-actions.pod:3700 ../src/guestfs-actions.pod:3715 ../src/guestfs-actions.pod:3730 ../src/guestfs-actions.pod:3743 ../src/guestfs-actions.pod:3757 ../src/guestfs-actions.pod:5476
22518 msgid "This function returns a C truth value on success or -1 on error."
22522 #: ../src/guestfs-actions.pod:717
22523 msgid "guestfs_blockdev_getsize64"
22527 #: ../src/guestfs-actions.pod:719
22531 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
22532 " const char *device);\n"
22537 #: ../src/guestfs-actions.pod:725
22538 msgid "See also C<guestfs_blockdev_getsz>."
22542 #: ../src/guestfs-actions.pod:733
22543 msgid "guestfs_blockdev_getss"
22547 #: ../src/guestfs-actions.pod:735
22551 " guestfs_blockdev_getss (guestfs_h *g,\n"
22552 " const char *device);\n"
22557 #: ../src/guestfs-actions.pod:742
22559 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
22564 #: ../src/guestfs-actions.pod:751
22565 msgid "guestfs_blockdev_getsz"
22569 #: ../src/guestfs-actions.pod:753
22573 " guestfs_blockdev_getsz (guestfs_h *g,\n"
22574 " const char *device);\n"
22579 #: ../src/guestfs-actions.pod:760
22581 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
22582 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
22586 #: ../src/guestfs-actions.pod:770
22587 msgid "guestfs_blockdev_rereadpt"
22591 #: ../src/guestfs-actions.pod:772
22595 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
22596 " const char *device);\n"
22601 #: ../src/guestfs-actions.pod:784
22602 msgid "guestfs_blockdev_setbsz"
22606 #: ../src/guestfs-actions.pod:786
22610 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
22611 " const char *device,\n"
22612 " int blocksize);\n"
22617 #: ../src/guestfs-actions.pod:802
22618 msgid "guestfs_blockdev_setro"
22622 #: ../src/guestfs-actions.pod:804
22626 " guestfs_blockdev_setro (guestfs_h *g,\n"
22627 " const char *device);\n"
22632 #: ../src/guestfs-actions.pod:816
22633 msgid "guestfs_blockdev_setrw"
22637 #: ../src/guestfs-actions.pod:818
22641 " guestfs_blockdev_setrw (guestfs_h *g,\n"
22642 " const char *device);\n"
22647 #: ../src/guestfs-actions.pod:830
22648 msgid "guestfs_btrfs_filesystem_resize"
22652 #: ../src/guestfs-actions.pod:832
22656 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
22657 " const char *mountpoint,\n"
22663 #: ../src/guestfs-actions.pod:842
22666 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
22671 #: ../src/guestfs-actions.pod:865
22672 msgid "(Added in 1.11.17)"
22676 #: ../src/guestfs-actions.pod:867
22677 msgid "guestfs_btrfs_filesystem_resize_va"
22681 #: ../src/guestfs-actions.pod:869
22685 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
22686 " const char *mountpoint,\n"
22687 " va_list args);\n"
22692 #: ../src/guestfs-actions.pod:874
22693 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
22697 #: ../src/guestfs-actions.pod:878
22698 msgid "guestfs_btrfs_filesystem_resize_argv"
22702 #: ../src/guestfs-actions.pod:880
22706 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
22707 " const char *mountpoint,\n"
22709 "guestfs_btrfs_filesystem_resize_argv *optargs);\n"
22714 #: ../src/guestfs-actions.pod:885
22715 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
22719 #: ../src/guestfs-actions.pod:889
22720 msgid "guestfs_case_sensitive_path"
22724 #: ../src/guestfs-actions.pod:891
22728 " guestfs_case_sensitive_path (guestfs_h *g,\n"
22729 " const char *path);\n"
22734 #: ../src/guestfs-actions.pod:917
22736 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
22737 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
22738 "how the directories were originally created under Windows)."
22742 #: ../src/guestfs-actions.pod:925
22743 msgid "See also C<guestfs_realpath>."
22747 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:7538
22748 msgid "(Added in 1.0.75)"
22752 #: ../src/guestfs-actions.pod:932
22753 msgid "guestfs_cat"
22757 #: ../src/guestfs-actions.pod:934
22761 " guestfs_cat (guestfs_h *g,\n"
22762 " const char *path);\n"
22767 #: ../src/guestfs-actions.pod:940
22769 "Note that this function cannot correctly handle binary files (specifically, "
22770 "files containing C<\\0> character which is treated as end of string). For "
22771 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
22772 "functions which have a more complex interface."
22776 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:3887 ../src/guestfs-actions.pod:3969 ../src/guestfs-actions.pod:3986 ../src/guestfs-actions.pod:4074 ../src/guestfs-actions.pod:4482 ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:5857 ../src/guestfs-actions.pod:5871 ../src/guestfs-actions.pod:7691 ../src/guestfs-actions.pod:7705
22777 msgid "(Added in 0.4)"
22781 #: ../src/guestfs-actions.pod:953
22782 msgid "guestfs_checksum"
22786 #: ../src/guestfs-actions.pod:955
22790 " guestfs_checksum (guestfs_h *g,\n"
22791 " const char *csumtype,\n"
22792 " const char *path);\n"
22797 #: ../src/guestfs-actions.pod:1001
22798 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
22802 #: ../src/guestfs-actions.pod:1003
22803 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
22807 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1423 ../src/guestfs-actions.pod:2279 ../src/guestfs-actions.pod:3585 ../src/guestfs-actions.pod:3614 ../src/guestfs-actions.pod:3675 ../src/guestfs-actions.pod:3702 ../src/guestfs-actions.pod:7394
22808 msgid "(Added in 1.0.2)"
22812 #: ../src/guestfs-actions.pod:1010
22813 msgid "guestfs_checksum_device"
22817 #: ../src/guestfs-actions.pod:1012
22821 " guestfs_checksum_device (guestfs_h *g,\n"
22822 " const char *csumtype,\n"
22823 " const char *device);\n"
22828 #: ../src/guestfs-actions.pod:1017
22830 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22831 "device named C<device>. For the types of checksums supported see the "
22832 "C<guestfs_checksum> command."
22836 #: ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:5306 ../src/guestfs-actions.pod:5441 ../src/guestfs-actions.pod:5478 ../src/guestfs-actions.pod:5496 ../src/guestfs-actions.pod:5678 ../src/guestfs-actions.pod:7303 ../src/guestfs-actions.pod:7317 ../src/guestfs-actions.pod:7717
22837 msgid "(Added in 1.3.2)"
22841 #: ../src/guestfs-actions.pod:1026
22842 msgid "guestfs_checksums_out"
22846 #: ../src/guestfs-actions.pod:1028
22850 " guestfs_checksums_out (guestfs_h *g,\n"
22851 " const char *csumtype,\n"
22852 " const char *directory,\n"
22853 " const char *sumsfile);\n"
22858 #: ../src/guestfs-actions.pod:1048
22859 msgid "(Added in 1.3.7)"
22863 #: ../src/guestfs-actions.pod:1050
22864 msgid "guestfs_chmod"
22868 #: ../src/guestfs-actions.pod:1052
22872 " guestfs_chmod (guestfs_h *g,\n"
22874 " const char *path);\n"
22879 #: ../src/guestfs-actions.pod:1070
22880 msgid "guestfs_chown"
22884 #: ../src/guestfs-actions.pod:1072
22888 " guestfs_chown (guestfs_h *g,\n"
22891 " const char *path);\n"
22896 #: ../src/guestfs-actions.pod:1088
22897 msgid "guestfs_command"
22901 #: ../src/guestfs-actions.pod:1090
22905 " guestfs_command (guestfs_h *g,\n"
22906 " char *const *arguments);\n"
22911 #: ../src/guestfs-actions.pod:1099
22913 "The single parameter is an argv-style list of arguments. The first element "
22914 "is the name of the program to run. Subsequent elements are parameters. The "
22915 "list must be non-empty (ie. must contain a program name). Note that the "
22916 "command runs directly, and is I<not> invoked via the shell (see "
22921 #: ../src/guestfs-actions.pod:1130 ../src/guestfs-actions.pod:1150 ../src/guestfs-actions.pod:1722
22922 msgid "(Added in 0.9.1)"
22926 #: ../src/guestfs-actions.pod:1132
22927 msgid "guestfs_command_lines"
22931 #: ../src/guestfs-actions.pod:1134
22935 " guestfs_command_lines (guestfs_h *g,\n"
22936 " char *const *arguments);\n"
22941 #: ../src/guestfs-actions.pod:1138
22943 "This is the same as C<guestfs_command>, but splits the result into a list of "
22948 #: ../src/guestfs-actions.pod:1141
22949 msgid "See also: C<guestfs_sh_lines>"
22953 #: ../src/guestfs-actions.pod:1152
22954 msgid "guestfs_compress_device_out"
22958 #: ../src/guestfs-actions.pod:1154
22962 " guestfs_compress_device_out (guestfs_h *g,\n"
22963 " const char *ctype,\n"
22964 " const char *device,\n"
22965 " const char *zdevice,\n"
22971 #: ../src/guestfs-actions.pod:1166
22974 " GUESTFS_COMPRESS_DEVICE_OUT_LEVEL, int level,\n"
22979 #: ../src/guestfs-actions.pod:1171
22981 "The C<ctype> and optional C<level> parameters have the same meaning as in "
22982 "C<guestfs_compress_out>."
22986 #: ../src/guestfs-actions.pod:1176
22987 msgid "guestfs_compress_device_out_va"
22991 #: ../src/guestfs-actions.pod:1178
22995 " guestfs_compress_device_out_va (guestfs_h *g,\n"
22996 " const char *ctype,\n"
22997 " const char *device,\n"
22998 " const char *zdevice,\n"
22999 " va_list args);\n"
23004 #: ../src/guestfs-actions.pod:1185
23005 msgid "This is the \"va_list variant\" of L</guestfs_compress_device_out>."
23009 #: ../src/guestfs-actions.pod:1189
23010 msgid "guestfs_compress_device_out_argv"
23014 #: ../src/guestfs-actions.pod:1191
23018 " guestfs_compress_device_out_argv (guestfs_h *g,\n"
23019 " const char *ctype,\n"
23020 " const char *device,\n"
23021 " const char *zdevice,\n"
23023 "guestfs_compress_device_out_argv *optargs);\n"
23028 #: ../src/guestfs-actions.pod:1198
23029 msgid "This is the \"argv variant\" of L</guestfs_compress_device_out>."
23033 #: ../src/guestfs-actions.pod:1202
23034 msgid "guestfs_compress_out"
23038 #: ../src/guestfs-actions.pod:1204
23042 " guestfs_compress_out (guestfs_h *g,\n"
23043 " const char *ctype,\n"
23044 " const char *file,\n"
23045 " const char *zfile,\n"
23051 #: ../src/guestfs-actions.pod:1216
23054 " GUESTFS_COMPRESS_OUT_LEVEL, int level,\n"
23059 #: ../src/guestfs-actions.pod:1233
23060 msgid "guestfs_compress_out_va"
23064 #: ../src/guestfs-actions.pod:1235
23068 " guestfs_compress_out_va (guestfs_h *g,\n"
23069 " const char *ctype,\n"
23070 " const char *file,\n"
23071 " const char *zfile,\n"
23072 " va_list args);\n"
23077 #: ../src/guestfs-actions.pod:1242
23078 msgid "This is the \"va_list variant\" of L</guestfs_compress_out>."
23082 #: ../src/guestfs-actions.pod:1246
23083 msgid "guestfs_compress_out_argv"
23087 #: ../src/guestfs-actions.pod:1248
23091 " guestfs_compress_out_argv (guestfs_h *g,\n"
23092 " const char *ctype,\n"
23093 " const char *file,\n"
23094 " const char *zfile,\n"
23095 " const struct guestfs_compress_out_argv "
23101 #: ../src/guestfs-actions.pod:1255
23102 msgid "This is the \"argv variant\" of L</guestfs_compress_out>."
23106 #: ../src/guestfs-actions.pod:1259
23107 msgid "guestfs_config"
23111 #: ../src/guestfs-actions.pod:1261
23115 " guestfs_config (guestfs_h *g,\n"
23116 " const char *qemuparam,\n"
23117 " const char *qemuvalue);\n"
23122 #: ../src/guestfs-actions.pod:1279
23123 msgid "guestfs_copy_size"
23127 #: ../src/guestfs-actions.pod:1281
23131 " guestfs_copy_size (guestfs_h *g,\n"
23132 " const char *src,\n"
23133 " const char *dest,\n"
23134 " int64_t size);\n"
23139 #: ../src/guestfs-actions.pod:1295 ../src/guestfs-actions.pod:1418 ../src/guestfs-actions.pod:1449 ../src/guestfs-actions.pod:1494 ../src/guestfs-actions.pod:1871 ../src/guestfs-actions.pod:1893 ../src/guestfs-actions.pod:3785 ../src/guestfs-actions.pod:7389 ../src/guestfs-actions.pod:7423 ../src/guestfs-actions.pod:7930 ../src/guestfs-actions.pod:7953
23141 "This long-running command can generate progress notification messages so "
23142 "that the caller can display a progress bar or indicator. To receive these "
23143 "messages, the caller must register a progress event callback. See "
23144 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
23148 #: ../src/guestfs-actions.pod:1300 ../src/guestfs-actions.pod:4509 ../src/guestfs-actions.pod:5884 ../src/guestfs-actions.pod:7624 ../src/guestfs-actions.pod:7644 ../src/guestfs-actions.pod:7730
23149 msgid "(Added in 1.0.87)"
23153 #: ../src/guestfs-actions.pod:1302
23158 #: ../src/guestfs-actions.pod:1304
23162 " guestfs_cp (guestfs_h *g,\n"
23163 " const char *src,\n"
23164 " const char *dest);\n"
23169 #: ../src/guestfs-actions.pod:1314 ../src/guestfs-actions.pod:1328 ../src/guestfs-actions.pod:1400 ../src/guestfs-actions.pod:1474 ../src/guestfs-actions.pod:1588 ../src/guestfs-actions.pod:5253 ../src/guestfs-actions.pod:5728
23170 msgid "(Added in 1.0.18)"
23174 #: ../src/guestfs-actions.pod:1316
23175 msgid "guestfs_cp_a"
23179 #: ../src/guestfs-actions.pod:1318
23183 " guestfs_cp_a (guestfs_h *g,\n"
23184 " const char *src,\n"
23185 " const char *dest);\n"
23190 #: ../src/guestfs-actions.pod:1330
23195 #: ../src/guestfs-actions.pod:1332
23199 " guestfs_dd (guestfs_h *g,\n"
23200 " const char *src,\n"
23201 " const char *dest);\n"
23206 #: ../src/guestfs-actions.pod:1342
23208 "If the destination is a device, it must be as large or larger than the "
23209 "source file or device, otherwise the copy will fail. This command cannot do "
23210 "partial copies (see C<guestfs_copy_size>)."
23214 #: ../src/guestfs-actions.pod:1350
23219 #: ../src/guestfs-actions.pod:1352
23223 " guestfs_df (guestfs_h *g);\n"
23228 #: ../src/guestfs-actions.pod:1357 ../src/guestfs-actions.pod:1374
23230 "This command is mostly useful for interactive sessions. It is I<not> "
23231 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
23236 #: ../src/guestfs-actions.pod:1364 ../src/guestfs-actions.pod:1381 ../src/guestfs-actions.pod:1499 ../src/guestfs-actions.pod:2504 ../src/guestfs-actions.pod:2528 ../src/guestfs-actions.pod:2596 ../src/guestfs-actions.pod:4619 ../src/guestfs-actions.pod:5153 ../src/guestfs-actions.pod:7127 ../src/guestfs-actions.pod:7151 ../src/guestfs-actions.pod:7770 ../src/guestfs-actions.pod:7783 ../src/guestfs-actions.pod:7796
23237 msgid "(Added in 1.0.54)"
23241 #: ../src/guestfs-actions.pod:1366
23242 msgid "guestfs_df_h"
23246 #: ../src/guestfs-actions.pod:1368
23250 " guestfs_df_h (guestfs_h *g);\n"
23255 #: ../src/guestfs-actions.pod:1383
23256 msgid "guestfs_dmesg"
23260 #: ../src/guestfs-actions.pod:1385
23264 " guestfs_dmesg (guestfs_h *g);\n"
23269 #: ../src/guestfs-actions.pod:1392
23271 "Another way to get the same information is to enable verbose messages with "
23272 "C<guestfs_set_verbose> or by setting the environment variable "
23273 "C<LIBGUESTFS_DEBUG=1> before running the program."
23277 #: ../src/guestfs-actions.pod:1402
23278 msgid "guestfs_download"
23282 #: ../src/guestfs-actions.pod:1404
23286 " guestfs_download (guestfs_h *g,\n"
23287 " const char *remotefilename,\n"
23288 " const char *filename);\n"
23293 #: ../src/guestfs-actions.pod:1414
23294 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
23298 #: ../src/guestfs-actions.pod:1425
23299 msgid "guestfs_download_offset"
23303 #: ../src/guestfs-actions.pod:1427
23307 " guestfs_download_offset (guestfs_h *g,\n"
23308 " const char *remotefilename,\n"
23309 " const char *filename,\n"
23310 " int64_t offset,\n"
23311 " int64_t size);\n"
23316 #: ../src/guestfs-actions.pod:1440
23318 "Note that there is no limit on the amount of data that can be downloaded "
23319 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
23320 "full amount unless an error occurs."
23324 #: ../src/guestfs-actions.pod:1445
23325 msgid "See also C<guestfs_download>, C<guestfs_pread>."
23329 #: ../src/guestfs-actions.pod:1454 ../src/guestfs-actions.pod:7428
23330 msgid "(Added in 1.5.17)"
23334 #: ../src/guestfs-actions.pod:1456
23335 msgid "guestfs_drop_caches"
23339 #: ../src/guestfs-actions.pod:1458
23343 " guestfs_drop_caches (guestfs_h *g,\n"
23344 " int whattodrop);\n"
23349 #: ../src/guestfs-actions.pod:1476
23354 #: ../src/guestfs-actions.pod:1478
23358 " guestfs_du (guestfs_h *g,\n"
23359 " const char *path);\n"
23364 #: ../src/guestfs-actions.pod:1501
23365 msgid "guestfs_e2fsck_f"
23369 #: ../src/guestfs-actions.pod:1503
23373 " guestfs_e2fsck_f (guestfs_h *g,\n"
23374 " const char *device);\n"
23379 #: ../src/guestfs-actions.pod:1511
23381 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
23382 "Normally you should use C<guestfs_fsck>."
23386 #: ../src/guestfs-actions.pod:1516
23387 msgid "(Added in 1.0.29)"
23391 #: ../src/guestfs-actions.pod:1518
23392 msgid "guestfs_echo_daemon"
23396 #: ../src/guestfs-actions.pod:1520
23400 " guestfs_echo_daemon (guestfs_h *g,\n"
23401 " char *const *words);\n"
23406 #: ../src/guestfs-actions.pod:1529
23407 msgid "See also C<guestfs_ping_daemon>."
23411 #: ../src/guestfs-actions.pod:1534 ../src/guestfs-actions.pod:2290 ../src/guestfs-actions.pod:6599
23412 msgid "(Added in 1.0.69)"
23416 #: ../src/guestfs-actions.pod:1536
23417 msgid "guestfs_egrep"
23421 #: ../src/guestfs-actions.pod:1538
23425 " guestfs_egrep (guestfs_h *g,\n"
23426 " const char *regex,\n"
23427 " const char *path);\n"
23432 #: ../src/guestfs-actions.pod:1553 ../src/guestfs-actions.pod:1572 ../src/guestfs-actions.pod:1629 ../src/guestfs-actions.pod:1675 ../src/guestfs-actions.pod:1694 ../src/guestfs-actions.pod:2420 ../src/guestfs-actions.pod:2439 ../src/guestfs-actions.pod:2617 ../src/guestfs-actions.pod:2630 ../src/guestfs-actions.pod:2645 ../src/guestfs-actions.pod:2691 ../src/guestfs-actions.pod:2713 ../src/guestfs-actions.pod:2726 ../src/guestfs-actions.pod:3999 ../src/guestfs-actions.pod:4013 ../src/guestfs-actions.pod:4026 ../src/guestfs-actions.pod:4040 ../src/guestfs-actions.pod:5041 ../src/guestfs-actions.pod:6062 ../src/guestfs-actions.pod:6111 ../src/guestfs-actions.pod:6995 ../src/guestfs-actions.pod:7007 ../src/guestfs-actions.pod:7020 ../src/guestfs-actions.pod:7033 ../src/guestfs-actions.pod:7055 ../src/guestfs-actions.pod:7068 ../src/guestfs-actions.pod:7081 ../src/guestfs-actions.pod:7094 ../src/guestfs-actions.pod:7888 ../src/guestfs-actions.pod:7907 ../src/guestfs-actions.pod:8001 ../src/guestfs-actions.pod:8020 ../src/guestfs-actions.pod:8066 ../src/guestfs-actions.pod:8085
23433 msgid "(Added in 1.0.66)"
23437 #: ../src/guestfs-actions.pod:1555
23438 msgid "guestfs_egrepi"
23442 #: ../src/guestfs-actions.pod:1557
23446 " guestfs_egrepi (guestfs_h *g,\n"
23447 " const char *regex,\n"
23448 " const char *path);\n"
23453 #: ../src/guestfs-actions.pod:1574
23454 msgid "guestfs_equal"
23458 #: ../src/guestfs-actions.pod:1576
23462 " guestfs_equal (guestfs_h *g,\n"
23463 " const char *file1,\n"
23464 " const char *file2);\n"
23469 #: ../src/guestfs-actions.pod:1590
23470 msgid "guestfs_exists"
23474 #: ../src/guestfs-actions.pod:1592
23478 " guestfs_exists (guestfs_h *g,\n"
23479 " const char *path);\n"
23484 #: ../src/guestfs-actions.pod:1599
23485 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
23489 #: ../src/guestfs-actions.pod:1605
23490 msgid "guestfs_fallocate"
23494 #: ../src/guestfs-actions.pod:1607
23498 " guestfs_fallocate (guestfs_h *g,\n"
23499 " const char *path,\n"
23505 #: ../src/guestfs-actions.pod:1612
23507 "I<This function is deprecated.> In new code, use the L</guestfs_fallocate64> "
23512 #: ../src/guestfs-actions.pod:1631
23513 msgid "guestfs_fallocate64"
23517 #: ../src/guestfs-actions.pod:1633
23521 " guestfs_fallocate64 (guestfs_h *g,\n"
23522 " const char *path,\n"
23528 #: ../src/guestfs-actions.pod:1642
23530 "Note that this call allocates disk blocks for the file. To create a sparse "
23531 "file use C<guestfs_truncate_size> instead."
23535 #: ../src/guestfs-actions.pod:1645
23537 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
23538 "oversight it only allowed 30 bit lengths to be specified, effectively "
23539 "limiting the maximum size of files created through that call to 1GB."
23543 #: ../src/guestfs-actions.pod:1656
23544 msgid "(Added in 1.3.17)"
23548 #: ../src/guestfs-actions.pod:1658
23549 msgid "guestfs_fgrep"
23553 #: ../src/guestfs-actions.pod:1660
23557 " guestfs_fgrep (guestfs_h *g,\n"
23558 " const char *pattern,\n"
23559 " const char *path);\n"
23564 #: ../src/guestfs-actions.pod:1677
23565 msgid "guestfs_fgrepi"
23569 #: ../src/guestfs-actions.pod:1679
23573 " guestfs_fgrepi (guestfs_h *g,\n"
23574 " const char *pattern,\n"
23575 " const char *path);\n"
23580 #: ../src/guestfs-actions.pod:1696
23581 msgid "guestfs_file"
23585 #: ../src/guestfs-actions.pod:1698
23589 " guestfs_file (guestfs_h *g,\n"
23590 " const char *path);\n"
23595 #: ../src/guestfs-actions.pod:1716
23597 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
23598 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
23602 #: ../src/guestfs-actions.pod:1724
23603 msgid "guestfs_file_architecture"
23607 #: ../src/guestfs-actions.pod:1726
23611 " guestfs_file_architecture (guestfs_h *g,\n"
23612 " const char *filename);\n"
23617 #: ../src/guestfs-actions.pod:1834 ../src/guestfs-actions.pod:1997 ../src/guestfs-actions.pod:2014 ../src/guestfs-actions.pod:2746 ../src/guestfs-actions.pod:2840 ../src/guestfs-actions.pod:2906 ../src/guestfs-actions.pod:3093 ../src/guestfs-actions.pod:3111 ../src/guestfs-actions.pod:3151 ../src/guestfs-actions.pod:3226 ../src/guestfs-actions.pod:3319 ../src/guestfs-actions.pod:3556 ../src/guestfs-actions.pod:3688
23618 msgid "(Added in 1.5.3)"
23622 #: ../src/guestfs-actions.pod:1836
23623 msgid "guestfs_filesize"
23627 #: ../src/guestfs-actions.pod:1838
23631 " guestfs_filesize (guestfs_h *g,\n"
23632 " const char *file);\n"
23637 #: ../src/guestfs-actions.pod:1844
23639 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
23640 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
23641 "devices, use C<guestfs_blockdev_getsize64>."
23645 #: ../src/guestfs-actions.pod:1850
23646 msgid "(Added in 1.0.82)"
23650 #: ../src/guestfs-actions.pod:1852
23651 msgid "guestfs_fill"
23655 #: ../src/guestfs-actions.pod:1854
23659 " guestfs_fill (guestfs_h *g,\n"
23662 " const char *path);\n"
23667 #: ../src/guestfs-actions.pod:1864
23669 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23670 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
23671 "bytes use C<guestfs_fill_pattern>."
23675 #: ../src/guestfs-actions.pod:1876
23676 msgid "(Added in 1.0.79)"
23680 #: ../src/guestfs-actions.pod:1878
23681 msgid "guestfs_fill_pattern"
23685 #: ../src/guestfs-actions.pod:1880
23689 " guestfs_fill_pattern (guestfs_h *g,\n"
23690 " const char *pattern,\n"
23692 " const char *path);\n"
23697 #: ../src/guestfs-actions.pod:1886
23699 "This function is like C<guestfs_fill> except that it creates a new file of "
23700 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
23701 "pattern is truncated if necessary to ensure the length of the file is "
23702 "exactly C<len> bytes."
23706 #: ../src/guestfs-actions.pod:1898
23707 msgid "(Added in 1.3.12)"
23711 #: ../src/guestfs-actions.pod:1900
23712 msgid "guestfs_find"
23716 #: ../src/guestfs-actions.pod:1902
23720 " guestfs_find (guestfs_h *g,\n"
23721 " const char *directory);\n"
23726 #: ../src/guestfs-actions.pod:1918
23727 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
23731 #: ../src/guestfs-actions.pod:1931
23732 msgid "See also C<guestfs_find0>."
23736 #: ../src/guestfs-actions.pod:1940 ../src/guestfs-actions.pod:4446 ../src/guestfs-actions.pod:6146
23737 msgid "(Added in 1.0.27)"
23741 #: ../src/guestfs-actions.pod:1942
23742 msgid "guestfs_find0"
23746 #: ../src/guestfs-actions.pod:1944
23750 " guestfs_find0 (guestfs_h *g,\n"
23751 " const char *directory,\n"
23752 " const char *files);\n"
23757 #: ../src/guestfs-actions.pod:1953
23759 "This command works the same way as C<guestfs_find> with the following "
23764 #: ../src/guestfs-actions.pod:1980
23765 msgid "(Added in 1.0.74)"
23769 #: ../src/guestfs-actions.pod:1982
23770 msgid "guestfs_findfs_label"
23774 #: ../src/guestfs-actions.pod:1984
23778 " guestfs_findfs_label (guestfs_h *g,\n"
23779 " const char *label);\n"
23784 #: ../src/guestfs-actions.pod:1992
23785 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
23789 #: ../src/guestfs-actions.pod:1999
23790 msgid "guestfs_findfs_uuid"
23794 #: ../src/guestfs-actions.pod:2001
23798 " guestfs_findfs_uuid (guestfs_h *g,\n"
23799 " const char *uuid);\n"
23804 #: ../src/guestfs-actions.pod:2009
23805 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
23809 #: ../src/guestfs-actions.pod:2016
23810 msgid "guestfs_fsck"
23814 #: ../src/guestfs-actions.pod:2018
23818 " guestfs_fsck (guestfs_h *g,\n"
23819 " const char *fstype,\n"
23820 " const char *device);\n"
23825 #: ../src/guestfs-actions.pod:2053 ../src/guestfs-actions.pod:7935
23826 msgid "(Added in 1.0.16)"
23830 #: ../src/guestfs-actions.pod:2055
23831 msgid "guestfs_get_append"
23835 #: ../src/guestfs-actions.pod:2057
23839 " guestfs_get_append (guestfs_h *g);\n"
23844 #: ../src/guestfs-actions.pod:2065
23846 "This function returns a string which may be NULL. There is no way to return "
23847 "an error from this function. The string is owned by the guest handle and "
23848 "must I<not> be freed."
23852 #: ../src/guestfs-actions.pod:2069 ../src/guestfs-actions.pod:5824 ../src/guestfs-actions.pod:6306 ../src/guestfs-actions.pod:6762 ../src/guestfs-actions.pod:6781 ../src/guestfs-actions.pod:6797 ../src/guestfs-actions.pod:6821 ../src/guestfs-actions.pod:7575 ../src/guestfs-actions.pod:7590 ../src/guestfs-actions.pod:7982
23853 msgid "(Added in 1.0.26)"
23857 #: ../src/guestfs-actions.pod:2071
23858 msgid "guestfs_get_attach_method"
23862 #: ../src/guestfs-actions.pod:2073
23866 " guestfs_get_attach_method (guestfs_h *g);\n"
23871 #: ../src/guestfs-actions.pod:2076
23872 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
23876 #: ../src/guestfs-actions.pod:2081 ../src/guestfs-actions.pod:6336
23877 msgid "(Added in 1.9.8)"
23881 #: ../src/guestfs-actions.pod:2083
23882 msgid "guestfs_get_autosync"
23886 #: ../src/guestfs-actions.pod:2085
23890 " guestfs_get_autosync (guestfs_h *g);\n"
23895 #: ../src/guestfs-actions.pod:2094
23896 msgid "guestfs_get_direct"
23900 #: ../src/guestfs-actions.pod:2096
23904 " guestfs_get_direct (guestfs_h *g);\n"
23909 #: ../src/guestfs-actions.pod:2103 ../src/guestfs-actions.pod:6377
23910 msgid "(Added in 1.0.72)"
23914 #: ../src/guestfs-actions.pod:2105
23915 msgid "guestfs_get_e2label"
23919 #: ../src/guestfs-actions.pod:2107
23923 " guestfs_get_e2label (guestfs_h *g,\n"
23924 " const char *device);\n"
23929 #: ../src/guestfs-actions.pod:2111
23931 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_label> "
23936 #: ../src/guestfs-actions.pod:2124 ../src/guestfs-actions.pod:2145 ../src/guestfs-actions.pod:6395 ../src/guestfs-actions.pod:6414
23937 msgid "(Added in 1.0.15)"
23941 #: ../src/guestfs-actions.pod:2126
23942 msgid "guestfs_get_e2uuid"
23946 #: ../src/guestfs-actions.pod:2128
23950 " guestfs_get_e2uuid (guestfs_h *g,\n"
23951 " const char *device);\n"
23956 #: ../src/guestfs-actions.pod:2132
23958 "I<This function is deprecated.> In new code, use the L</guestfs_vfs_uuid> "
23963 #: ../src/guestfs-actions.pod:2147
23964 msgid "guestfs_get_memsize"
23968 #: ../src/guestfs-actions.pod:2149
23972 " guestfs_get_memsize (guestfs_h *g);\n"
23977 #: ../src/guestfs-actions.pod:2155
23979 "If C<guestfs_set_memsize> was not called on this handle, and if "
23980 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23981 "value for memsize."
23985 #: ../src/guestfs-actions.pod:2164 ../src/guestfs-actions.pod:4737 ../src/guestfs-actions.pod:4946 ../src/guestfs-actions.pod:4965 ../src/guestfs-actions.pod:4984 ../src/guestfs-actions.pod:4996 ../src/guestfs-actions.pod:5013 ../src/guestfs-actions.pod:5026 ../src/guestfs-actions.pod:6049 ../src/guestfs-actions.pod:6435 ../src/guestfs-actions.pod:6729 ../src/guestfs-actions.pod:7344
23986 msgid "(Added in 1.0.55)"
23990 #: ../src/guestfs-actions.pod:2166
23991 msgid "guestfs_get_network"
23995 #: ../src/guestfs-actions.pod:2168
23999 " guestfs_get_network (guestfs_h *g);\n"
24004 #: ../src/guestfs-actions.pod:2175 ../src/guestfs-actions.pod:6454
24005 msgid "(Added in 1.5.4)"
24009 #: ../src/guestfs-actions.pod:2177
24010 msgid "guestfs_get_path"
24014 #: ../src/guestfs-actions.pod:2179
24018 " guestfs_get_path (guestfs_h *g);\n"
24023 #: ../src/guestfs-actions.pod:2187 ../src/guestfs-actions.pod:2227
24025 "This function returns a string, or NULL on error. The string is owned by "
24026 "the guest handle and must I<not> be freed."
24030 #: ../src/guestfs-actions.pod:2192
24031 msgid "guestfs_get_pgroup"
24035 #: ../src/guestfs-actions.pod:2194
24039 " guestfs_get_pgroup (guestfs_h *g);\n"
24044 #: ../src/guestfs-actions.pod:2201 ../src/guestfs-actions.pod:6490 ../src/guestfs-actions.pod:7836
24045 msgid "(Added in 1.11.18)"
24049 #: ../src/guestfs-actions.pod:2203
24050 msgid "guestfs_get_pid"
24054 #: ../src/guestfs-actions.pod:2205
24058 " guestfs_get_pid (guestfs_h *g);\n"
24063 #: ../src/guestfs-actions.pod:2215
24064 msgid "(Added in 1.0.56)"
24068 #: ../src/guestfs-actions.pod:2217
24069 msgid "guestfs_get_qemu"
24073 #: ../src/guestfs-actions.pod:2219
24077 " guestfs_get_qemu (guestfs_h *g);\n"
24082 #: ../src/guestfs-actions.pod:2230 ../src/guestfs-actions.pod:6518
24083 msgid "(Added in 1.0.6)"
24087 #: ../src/guestfs-actions.pod:2232
24088 msgid "guestfs_get_recovery_proc"
24092 #: ../src/guestfs-actions.pod:2234
24096 " guestfs_get_recovery_proc (guestfs_h *g);\n"
24101 #: ../src/guestfs-actions.pod:2241 ../src/guestfs-actions.pod:3810 ../src/guestfs-actions.pod:4141 ../src/guestfs-actions.pod:4544 ../src/guestfs-actions.pod:4576 ../src/guestfs-actions.pod:5754 ../src/guestfs-actions.pod:6097 ../src/guestfs-actions.pod:6542 ../src/guestfs-actions.pod:7247 ../src/guestfs-actions.pod:7267 ../src/guestfs-actions.pod:7459
24102 msgid "(Added in 1.0.77)"
24106 #: ../src/guestfs-actions.pod:2243
24107 msgid "guestfs_get_selinux"
24111 #: ../src/guestfs-actions.pod:2245
24115 " guestfs_get_selinux (guestfs_h *g);\n"
24120 #: ../src/guestfs-actions.pod:2248
24122 "This returns the current setting of the selinux flag which is passed to the "
24123 "appliance at boot time. See C<guestfs_set_selinux>."
24127 #: ../src/guestfs-actions.pod:2256 ../src/guestfs-actions.pod:2328 ../src/guestfs-actions.pod:6561 ../src/guestfs-actions.pod:6633
24128 msgid "(Added in 1.0.67)"
24132 #: ../src/guestfs-actions.pod:2258
24133 msgid "guestfs_get_smp"
24137 #: ../src/guestfs-actions.pod:2260
24141 " guestfs_get_smp (guestfs_h *g);\n"
24146 #: ../src/guestfs-actions.pod:2267
24147 msgid "guestfs_get_state"
24151 #: ../src/guestfs-actions.pod:2269
24155 " guestfs_get_state (guestfs_h *g);\n"
24160 #: ../src/guestfs-actions.pod:2281
24161 msgid "guestfs_get_trace"
24165 #: ../src/guestfs-actions.pod:2283
24169 " guestfs_get_trace (guestfs_h *g);\n"
24174 #: ../src/guestfs-actions.pod:2292
24175 msgid "guestfs_get_umask"
24179 #: ../src/guestfs-actions.pod:2294
24183 " guestfs_get_umask (guestfs_h *g);\n"
24188 #: ../src/guestfs-actions.pod:2297
24190 "Return the current umask. By default the umask is C<022> unless it has been "
24191 "set by calling C<guestfs_umask>."
24195 #: ../src/guestfs-actions.pod:2304
24196 msgid "guestfs_get_verbose"
24200 #: ../src/guestfs-actions.pod:2306
24204 " guestfs_get_verbose (guestfs_h *g);\n"
24209 #: ../src/guestfs-actions.pod:2315
24210 msgid "guestfs_getcon"
24214 #: ../src/guestfs-actions.pod:2317
24218 " guestfs_getcon (guestfs_h *g);\n"
24223 #: ../src/guestfs-actions.pod:2322
24224 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
24228 #: ../src/guestfs-actions.pod:2330
24229 msgid "guestfs_getxattr"
24233 #: ../src/guestfs-actions.pod:2332
24237 " guestfs_getxattr (guestfs_h *g,\n"
24238 " const char *path,\n"
24239 " const char *name,\n"
24240 " size_t *size_r);\n"
24245 #: ../src/guestfs-actions.pod:2338
24247 "Get a single extended attribute from file C<path> named C<name>. This call "
24248 "follows symlinks. If you want to lookup an extended attribute for the "
24249 "symlink itself, use C<guestfs_lgetxattr>."
24253 #: ../src/guestfs-actions.pod:2342 ../src/guestfs-actions.pod:3824
24255 "Normally it is better to get all extended attributes from a file in one go "
24256 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
24257 "implementations are buggy and do not provide a way to list out attributes. "
24258 "For these filesystems (notably ntfs-3g) you have to know the names of the "
24259 "extended attributes you want in advance and call this function."
24263 #: ../src/guestfs-actions.pod:2352
24264 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
24268 #: ../src/guestfs-actions.pod:2354 ../src/guestfs-actions.pod:2567 ../src/guestfs-actions.pod:3041 ../src/guestfs-actions.pod:3836 ../src/guestfs-actions.pod:5747 ../src/guestfs-actions.pod:5773 ../src/guestfs-actions.pod:5954
24270 "This function returns a buffer, or NULL on error. The size of the returned "
24271 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
24276 #: ../src/guestfs-actions.pod:2358 ../src/guestfs-actions.pod:3840
24277 msgid "(Added in 1.7.24)"
24281 #: ../src/guestfs-actions.pod:2360
24282 msgid "guestfs_getxattrs"
24286 #: ../src/guestfs-actions.pod:2362
24289 " struct guestfs_xattr_list *\n"
24290 " guestfs_getxattrs (guestfs_h *g,\n"
24291 " const char *path);\n"
24296 #: ../src/guestfs-actions.pod:2372
24297 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
24301 #: ../src/guestfs-actions.pod:2374 ../src/guestfs-actions.pod:3852 ../src/guestfs-actions.pod:4540
24303 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
24304 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
24308 #: ../src/guestfs-actions.pod:2378 ../src/guestfs-actions.pod:3856 ../src/guestfs-actions.pod:4055 ../src/guestfs-actions.pod:4091 ../src/guestfs-actions.pod:6127 ../src/guestfs-actions.pod:6652 ../src/guestfs-actions.pod:8047
24309 msgid "(Added in 1.0.59)"
24313 #: ../src/guestfs-actions.pod:2380
24314 msgid "guestfs_glob_expand"
24318 #: ../src/guestfs-actions.pod:2382
24322 " guestfs_glob_expand (guestfs_h *g,\n"
24323 " const char *pattern);\n"
24328 #: ../src/guestfs-actions.pod:2401 ../src/guestfs-actions.pod:6845 ../src/guestfs-actions.pod:6862
24329 msgid "(Added in 1.0.50)"
24333 #: ../src/guestfs-actions.pod:2403
24334 msgid "guestfs_grep"
24338 #: ../src/guestfs-actions.pod:2405
24342 " guestfs_grep (guestfs_h *g,\n"
24343 " const char *regex,\n"
24344 " const char *path);\n"
24349 #: ../src/guestfs-actions.pod:2422
24350 msgid "guestfs_grepi"
24354 #: ../src/guestfs-actions.pod:2424
24358 " guestfs_grepi (guestfs_h *g,\n"
24359 " const char *regex,\n"
24360 " const char *path);\n"
24365 #: ../src/guestfs-actions.pod:2441
24366 msgid "guestfs_grub_install"
24370 #: ../src/guestfs-actions.pod:2443
24374 " guestfs_grub_install (guestfs_h *g,\n"
24375 " const char *root,\n"
24376 " const char *device);\n"
24381 #: ../src/guestfs-actions.pod:2486
24382 msgid "(Added in 1.0.17)"
24386 #: ../src/guestfs-actions.pod:2488
24387 msgid "guestfs_head"
24391 #: ../src/guestfs-actions.pod:2490
24395 " guestfs_head (guestfs_h *g,\n"
24396 " const char *path);\n"
24401 #: ../src/guestfs-actions.pod:2506
24402 msgid "guestfs_head_n"
24406 #: ../src/guestfs-actions.pod:2508
24410 " guestfs_head_n (guestfs_h *g,\n"
24412 " const char *path);\n"
24417 #: ../src/guestfs-actions.pod:2530
24418 msgid "guestfs_hexdump"
24422 #: ../src/guestfs-actions.pod:2532
24426 " guestfs_hexdump (guestfs_h *g,\n"
24427 " const char *path);\n"
24432 #: ../src/guestfs-actions.pod:2545 ../src/guestfs-actions.pod:6926 ../src/guestfs-actions.pod:6981
24433 msgid "(Added in 1.0.22)"
24437 #: ../src/guestfs-actions.pod:2547
24438 msgid "guestfs_initrd_cat"
24442 #: ../src/guestfs-actions.pod:2549
24446 " guestfs_initrd_cat (guestfs_h *g,\n"
24447 " const char *initrdpath,\n"
24448 " const char *filename,\n"
24449 " size_t *size_r);\n"
24454 #: ../src/guestfs-actions.pod:2565
24455 msgid "See also C<guestfs_initrd_list>."
24459 #: ../src/guestfs-actions.pod:2576
24460 msgid "guestfs_initrd_list"
24464 #: ../src/guestfs-actions.pod:2578
24468 " guestfs_initrd_list (guestfs_h *g,\n"
24469 " const char *path);\n"
24474 #: ../src/guestfs-actions.pod:2598
24475 msgid "guestfs_inotify_add_watch"
24479 #: ../src/guestfs-actions.pod:2600
24483 " guestfs_inotify_add_watch (guestfs_h *g,\n"
24484 " const char *path,\n"
24490 #: ../src/guestfs-actions.pod:2619
24491 msgid "guestfs_inotify_close"
24495 #: ../src/guestfs-actions.pod:2621
24499 " guestfs_inotify_close (guestfs_h *g);\n"
24504 #: ../src/guestfs-actions.pod:2632
24505 msgid "guestfs_inotify_files"
24509 #: ../src/guestfs-actions.pod:2634
24513 " guestfs_inotify_files (guestfs_h *g);\n"
24518 #: ../src/guestfs-actions.pod:2637
24520 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
24521 "returns a list of pathnames of objects that were touched. The returned "
24522 "pathnames are sorted and deduplicated."
24526 #: ../src/guestfs-actions.pod:2647
24527 msgid "guestfs_inotify_init"
24531 #: ../src/guestfs-actions.pod:2649
24535 " guestfs_inotify_init (guestfs_h *g,\n"
24536 " int maxevents);\n"
24541 #: ../src/guestfs-actions.pod:2657
24543 "C<maxevents> is the maximum number of events which will be queued up between "
24544 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
24545 "passed as C<0>, then the kernel (or previously set) default is used. For "
24546 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
24547 "throws away events, but records the fact that it threw them away by setting "
24548 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
24549 "C<guestfs_inotify_read>)."
24553 #: ../src/guestfs-actions.pod:2667
24555 "Before any events are generated, you have to add some watches to the "
24556 "internal watch list. See: C<guestfs_inotify_add_watch>, "
24557 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
24561 #: ../src/guestfs-actions.pod:2673
24563 "Queued up events should be read periodically by calling "
24564 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
24565 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
24566 "often enough then you risk the internal queue overflowing."
24570 #: ../src/guestfs-actions.pod:2680
24572 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
24573 "This also removes any watches automatically."
24577 #: ../src/guestfs-actions.pod:2693
24578 msgid "guestfs_inotify_read"
24582 #: ../src/guestfs-actions.pod:2695
24585 " struct guestfs_inotify_event_list *\n"
24586 " guestfs_inotify_read (guestfs_h *g);\n"
24591 #: ../src/guestfs-actions.pod:2709
24593 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
24594 "there was an error. I<The caller must call "
24595 "C<guestfs_free_inotify_event_list> after use>."
24599 #: ../src/guestfs-actions.pod:2715
24600 msgid "guestfs_inotify_rm_watch"
24604 #: ../src/guestfs-actions.pod:2717
24608 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
24614 #: ../src/guestfs-actions.pod:2721
24616 "Remove a previously defined inotify watch. See "
24617 "C<guestfs_inotify_add_watch>."
24621 #: ../src/guestfs-actions.pod:2728
24622 msgid "guestfs_inspect_get_arch"
24626 #: ../src/guestfs-actions.pod:2730
24630 " guestfs_inspect_get_arch (guestfs_h *g,\n"
24631 " const char *root);\n"
24636 #: ../src/guestfs-actions.pod:2734
24638 "This returns the architecture of the inspected operating system. The "
24639 "possible return values are listed under C<guestfs_file_architecture>."
24643 #: ../src/guestfs-actions.pod:2748
24644 msgid "guestfs_inspect_get_distro"
24648 #: ../src/guestfs-actions.pod:2750
24652 " guestfs_inspect_get_distro (guestfs_h *g,\n"
24653 " const char *root);\n"
24658 #: ../src/guestfs-actions.pod:2842
24659 msgid "guestfs_inspect_get_drive_mappings"
24663 #: ../src/guestfs-actions.pod:2844
24667 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
24668 " const char *root);\n"
24673 #: ../src/guestfs-actions.pod:2873
24675 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24676 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
24680 #: ../src/guestfs-actions.pod:2877 ../src/guestfs-actions.pod:3145 ../src/guestfs-actions.pod:3943 ../src/guestfs-actions.pod:5215 ../src/guestfs-actions.pod:7283
24682 "This function returns a NULL-terminated array of strings, or NULL if there "
24683 "was an error. The array of strings will always have length C<2n+1>, where "
24684 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
24685 "caller must free the strings and the array after use>."
24689 #: ../src/guestfs-actions.pod:2883 ../src/guestfs-actions.pod:3339
24690 msgid "(Added in 1.9.17)"
24694 #: ../src/guestfs-actions.pod:2885
24695 msgid "guestfs_inspect_get_filesystems"
24699 #: ../src/guestfs-actions.pod:2887
24703 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
24704 " const char *root);\n"
24709 #: ../src/guestfs-actions.pod:2899
24711 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24712 "C<guestfs_inspect_get_mountpoints>."
24716 #: ../src/guestfs-actions.pod:2908
24717 msgid "guestfs_inspect_get_format"
24721 #: ../src/guestfs-actions.pod:2910
24725 " guestfs_inspect_get_format (guestfs_h *g,\n"
24726 " const char *root);\n"
24731 #: ../src/guestfs-actions.pod:2944 ../src/guestfs-actions.pod:3375 ../src/guestfs-actions.pod:3391 ../src/guestfs-actions.pod:3409 ../src/guestfs-actions.pod:6165
24732 msgid "(Added in 1.9.4)"
24736 #: ../src/guestfs-actions.pod:2946
24737 msgid "guestfs_inspect_get_hostname"
24741 #: ../src/guestfs-actions.pod:2948
24745 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
24746 " const char *root);\n"
24751 #: ../src/guestfs-actions.pod:2963
24752 msgid "(Added in 1.7.9)"
24756 #: ../src/guestfs-actions.pod:2965
24757 msgid "guestfs_inspect_get_icon"
24761 #: ../src/guestfs-actions.pod:2967
24765 " guestfs_inspect_get_icon (guestfs_h *g,\n"
24766 " const char *root,\n"
24767 " size_t *size_r,\n"
24773 #: ../src/guestfs-actions.pod:2978
24776 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
24777 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
24782 #: ../src/guestfs-actions.pod:3045 ../src/guestfs-actions.pod:3870 ../src/guestfs-actions.pod:5114
24783 msgid "(Added in 1.11.12)"
24787 #: ../src/guestfs-actions.pod:3047
24788 msgid "guestfs_inspect_get_icon_va"
24792 #: ../src/guestfs-actions.pod:3049
24796 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
24797 " const char *root,\n"
24798 " size_t *size_r,\n"
24799 " va_list args);\n"
24804 #: ../src/guestfs-actions.pod:3055
24805 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
24809 #: ../src/guestfs-actions.pod:3059
24810 msgid "guestfs_inspect_get_icon_argv"
24814 #: ../src/guestfs-actions.pod:3061
24818 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
24819 " const char *root,\n"
24820 " size_t *size_r,\n"
24821 " const struct guestfs_inspect_get_icon_argv "
24827 #: ../src/guestfs-actions.pod:3067
24828 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
24832 #: ../src/guestfs-actions.pod:3071
24833 msgid "guestfs_inspect_get_major_version"
24837 #: ../src/guestfs-actions.pod:3073
24841 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
24842 " const char *root);\n"
24847 #: ../src/guestfs-actions.pod:3095
24848 msgid "guestfs_inspect_get_minor_version"
24852 #: ../src/guestfs-actions.pod:3097
24856 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
24857 " const char *root);\n"
24862 #: ../src/guestfs-actions.pod:3106
24864 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24865 "C<guestfs_inspect_get_major_version>."
24869 #: ../src/guestfs-actions.pod:3113
24870 msgid "guestfs_inspect_get_mountpoints"
24874 #: ../src/guestfs-actions.pod:3115
24878 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
24879 " const char *root);\n"
24884 #: ../src/guestfs-actions.pod:3136
24886 "For operating systems like Windows which still use drive letters, this call "
24887 "will only return an entry for the first drive \"mounted on\" C</>. For "
24888 "information about the mapping of drive letters to partitions, see "
24889 "C<guestfs_inspect_get_drive_mappings>."
24893 #: ../src/guestfs-actions.pod:3142
24895 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24896 "C<guestfs_inspect_get_filesystems>."
24900 #: ../src/guestfs-actions.pod:3153
24901 msgid "guestfs_inspect_get_package_format"
24905 #: ../src/guestfs-actions.pod:3155
24909 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
24910 " const char *root);\n"
24915 #: ../src/guestfs-actions.pod:3159
24917 "This function and C<guestfs_inspect_get_package_management> return the "
24918 "package format and package management tool used by the inspected operating "
24919 "system. For example for Fedora these functions would return C<rpm> (package "
24920 "format) and C<yum> (package management)."
24924 #: ../src/guestfs-actions.pod:3177 ../src/guestfs-actions.pod:3205
24925 msgid "(Added in 1.7.5)"
24929 #: ../src/guestfs-actions.pod:3179
24930 msgid "guestfs_inspect_get_package_management"
24934 #: ../src/guestfs-actions.pod:3181
24938 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
24939 " const char *root);\n"
24944 #: ../src/guestfs-actions.pod:3185
24946 "C<guestfs_inspect_get_package_format> and this function return the package "
24947 "format and package management tool used by the inspected operating system. "
24948 "For example for Fedora these functions would return C<rpm> (package format) "
24949 "and C<yum> (package management)."
24953 #: ../src/guestfs-actions.pod:3207
24954 msgid "guestfs_inspect_get_product_name"
24958 #: ../src/guestfs-actions.pod:3209
24962 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
24963 " const char *root);\n"
24968 #: ../src/guestfs-actions.pod:3228
24969 msgid "guestfs_inspect_get_product_variant"
24973 #: ../src/guestfs-actions.pod:3230
24977 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
24978 " const char *root);\n"
24983 #: ../src/guestfs-actions.pod:3253
24985 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24986 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
24990 #: ../src/guestfs-actions.pod:3260
24991 msgid "(Added in 1.9.13)"
24995 #: ../src/guestfs-actions.pod:3262
24996 msgid "guestfs_inspect_get_roots"
25000 #: ../src/guestfs-actions.pod:3264
25004 " guestfs_inspect_get_roots (guestfs_h *g);\n"
25009 #: ../src/guestfs-actions.pod:3267
25011 "This function is a convenient way to get the list of root devices, as "
25012 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
25013 "the whole inspection process."
25017 #: ../src/guestfs-actions.pod:3271
25019 "This returns an empty list if either no root devices were found or the "
25020 "caller has not called C<guestfs_inspect_os>."
25024 #: ../src/guestfs-actions.pod:3280
25025 msgid "(Added in 1.7.3)"
25029 #: ../src/guestfs-actions.pod:3282
25030 msgid "guestfs_inspect_get_type"
25034 #: ../src/guestfs-actions.pod:3284
25038 " guestfs_inspect_get_type (guestfs_h *g,\n"
25039 " const char *root);\n"
25044 #: ../src/guestfs-actions.pod:3321
25045 msgid "guestfs_inspect_get_windows_current_control_set"
25049 #: ../src/guestfs-actions.pod:3323
25053 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
25054 " const char *root);\n"
25059 #: ../src/guestfs-actions.pod:3341
25060 msgid "guestfs_inspect_get_windows_systemroot"
25064 #: ../src/guestfs-actions.pod:3343
25068 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
25069 " const char *root);\n"
25074 #: ../src/guestfs-actions.pod:3359
25075 msgid "(Added in 1.5.25)"
25079 #: ../src/guestfs-actions.pod:3361
25080 msgid "guestfs_inspect_is_live"
25084 #: ../src/guestfs-actions.pod:3363
25088 " guestfs_inspect_is_live (guestfs_h *g,\n"
25089 " const char *root);\n"
25094 #: ../src/guestfs-actions.pod:3367
25096 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25097 "disk), then this returns true if a live image was detected on the disk."
25101 #: ../src/guestfs-actions.pod:3377
25102 msgid "guestfs_inspect_is_multipart"
25106 #: ../src/guestfs-actions.pod:3379
25110 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
25111 " const char *root);\n"
25116 #: ../src/guestfs-actions.pod:3383
25118 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25119 "disk), then this returns true if the disk is part of a set."
25123 #: ../src/guestfs-actions.pod:3393
25124 msgid "guestfs_inspect_is_netinst"
25128 #: ../src/guestfs-actions.pod:3395
25132 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
25133 " const char *root);\n"
25138 #: ../src/guestfs-actions.pod:3399
25140 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
25141 "disk), then this returns true if the disk is a network installer, ie. not a "
25142 "self-contained install CD but one which is likely to require network access "
25143 "to complete the install."
25147 #: ../src/guestfs-actions.pod:3411
25148 msgid "guestfs_inspect_list_applications"
25152 #: ../src/guestfs-actions.pod:3413
25155 " struct guestfs_application_list *\n"
25156 " guestfs_inspect_list_applications (guestfs_h *g,\n"
25157 " const char *root);\n"
25162 #: ../src/guestfs-actions.pod:3419
25164 "I<Note:> This call works differently from other parts of the inspection "
25165 "API. You have to call C<guestfs_inspect_os>, then "
25166 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
25167 "this. Listing applications is a significantly more difficult operation "
25168 "which requires access to the full filesystem. Also note that unlike the "
25169 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
25170 "the libguestfs handle, this call actually reads parts of the mounted "
25171 "filesystems during the call."
25175 #: ../src/guestfs-actions.pod:3509
25177 "This function returns a C<struct guestfs_application_list *>, or NULL if "
25178 "there was an error. I<The caller must call C<guestfs_free_application_list> "
25183 #: ../src/guestfs-actions.pod:3513
25184 msgid "(Added in 1.7.8)"
25188 #: ../src/guestfs-actions.pod:3515
25189 msgid "guestfs_inspect_os"
25193 #: ../src/guestfs-actions.pod:3517
25197 " guestfs_inspect_os (guestfs_h *g);\n"
25202 #: ../src/guestfs-actions.pod:3533
25204 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
25205 "functions in order to query further information about each operating system, "
25206 "such as the name and version."
25210 #: ../src/guestfs-actions.pod:3538
25212 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
25213 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
25214 "the contents. This should be called with no disks currently mounted. The "
25215 "function may also use Augeas, so any existing Augeas handle will be closed."
25219 #: ../src/guestfs-actions.pod:3550 ../src/guestfs-actions.pod:3881 ../src/guestfs-actions.pod:3963
25220 msgid "See also C<guestfs_list_filesystems>."
25224 #: ../src/guestfs-actions.pod:3558
25225 msgid "guestfs_is_blockdev"
25229 #: ../src/guestfs-actions.pod:3560
25233 " guestfs_is_blockdev (guestfs_h *g,\n"
25234 " const char *path);\n"
25239 #: ../src/guestfs-actions.pod:3567 ../src/guestfs-actions.pod:3596 ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:3641 ../src/guestfs-actions.pod:3657 ../src/guestfs-actions.pod:3713 ../src/guestfs-actions.pod:3728
25240 msgid "See also C<guestfs_stat>."
25244 #: ../src/guestfs-actions.pod:3571 ../src/guestfs-actions.pod:3600 ../src/guestfs-actions.pod:3645 ../src/guestfs-actions.pod:3717 ../src/guestfs-actions.pod:3732
25245 msgid "(Added in 1.5.10)"
25249 #: ../src/guestfs-actions.pod:3573
25250 msgid "guestfs_is_busy"
25254 #: ../src/guestfs-actions.pod:3575
25258 " guestfs_is_busy (guestfs_h *g);\n"
25263 #: ../src/guestfs-actions.pod:3587
25264 msgid "guestfs_is_chardev"
25268 #: ../src/guestfs-actions.pod:3589
25272 " guestfs_is_chardev (guestfs_h *g,\n"
25273 " const char *path);\n"
25278 #: ../src/guestfs-actions.pod:3602
25279 msgid "guestfs_is_config"
25283 #: ../src/guestfs-actions.pod:3604
25287 " guestfs_is_config (guestfs_h *g);\n"
25292 #: ../src/guestfs-actions.pod:3616
25293 msgid "guestfs_is_dir"
25297 #: ../src/guestfs-actions.pod:3618
25301 " guestfs_is_dir (guestfs_h *g,\n"
25302 " const char *path);\n"
25307 #: ../src/guestfs-actions.pod:3632
25308 msgid "guestfs_is_fifo"
25312 #: ../src/guestfs-actions.pod:3634
25316 " guestfs_is_fifo (guestfs_h *g,\n"
25317 " const char *path);\n"
25322 #: ../src/guestfs-actions.pod:3647
25323 msgid "guestfs_is_file"
25327 #: ../src/guestfs-actions.pod:3649
25331 " guestfs_is_file (guestfs_h *g,\n"
25332 " const char *path);\n"
25337 #: ../src/guestfs-actions.pod:3663
25338 msgid "guestfs_is_launching"
25342 #: ../src/guestfs-actions.pod:3665
25346 " guestfs_is_launching (guestfs_h *g);\n"
25351 #: ../src/guestfs-actions.pod:3677
25352 msgid "guestfs_is_lv"
25356 #: ../src/guestfs-actions.pod:3679
25360 " guestfs_is_lv (guestfs_h *g,\n"
25361 " const char *device);\n"
25366 #: ../src/guestfs-actions.pod:3690
25367 msgid "guestfs_is_ready"
25371 #: ../src/guestfs-actions.pod:3692
25375 " guestfs_is_ready (guestfs_h *g);\n"
25380 #: ../src/guestfs-actions.pod:3704
25381 msgid "guestfs_is_socket"
25385 #: ../src/guestfs-actions.pod:3706
25389 " guestfs_is_socket (guestfs_h *g,\n"
25390 " const char *path);\n"
25395 #: ../src/guestfs-actions.pod:3719
25396 msgid "guestfs_is_symlink"
25400 #: ../src/guestfs-actions.pod:3721
25404 " guestfs_is_symlink (guestfs_h *g,\n"
25405 " const char *path);\n"
25410 #: ../src/guestfs-actions.pod:3734
25411 msgid "guestfs_is_zero"
25415 #: ../src/guestfs-actions.pod:3736
25419 " guestfs_is_zero (guestfs_h *g,\n"
25420 " const char *path);\n"
25425 #: ../src/guestfs-actions.pod:3745 ../src/guestfs-actions.pod:3759
25426 msgid "(Added in 1.11.8)"
25430 #: ../src/guestfs-actions.pod:3747
25431 msgid "guestfs_is_zero_device"
25435 #: ../src/guestfs-actions.pod:3749
25439 " guestfs_is_zero_device (guestfs_h *g,\n"
25440 " const char *device);\n"
25445 #: ../src/guestfs-actions.pod:3761
25446 msgid "guestfs_kill_subprocess"
25450 #: ../src/guestfs-actions.pod:3763
25454 " guestfs_kill_subprocess (guestfs_h *g);\n"
25459 #: ../src/guestfs-actions.pod:3772
25460 msgid "guestfs_launch"
25464 #: ../src/guestfs-actions.pod:3774
25468 " guestfs_launch (guestfs_h *g);\n"
25473 #: ../src/guestfs-actions.pod:3792
25474 msgid "guestfs_lchown"
25478 #: ../src/guestfs-actions.pod:3794
25482 " guestfs_lchown (guestfs_h *g,\n"
25485 " const char *path);\n"
25490 #: ../src/guestfs-actions.pod:3800
25492 "Change the file owner to C<owner> and group to C<group>. This is like "
25493 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
25494 "changed, not the target."
25498 #: ../src/guestfs-actions.pod:3812
25499 msgid "guestfs_lgetxattr"
25503 #: ../src/guestfs-actions.pod:3814
25507 " guestfs_lgetxattr (guestfs_h *g,\n"
25508 " const char *path,\n"
25509 " const char *name,\n"
25510 " size_t *size_r);\n"
25515 #: ../src/guestfs-actions.pod:3834
25516 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
25520 #: ../src/guestfs-actions.pod:3842
25521 msgid "guestfs_lgetxattrs"
25525 #: ../src/guestfs-actions.pod:3844
25528 " struct guestfs_xattr_list *\n"
25529 " guestfs_lgetxattrs (guestfs_h *g,\n"
25530 " const char *path);\n"
25535 #: ../src/guestfs-actions.pod:3848
25537 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
25538 "then it returns the extended attributes of the link itself."
25542 #: ../src/guestfs-actions.pod:3858
25543 msgid "guestfs_list_9p"
25547 #: ../src/guestfs-actions.pod:3860
25551 " guestfs_list_9p (guestfs_h *g);\n"
25556 #: ../src/guestfs-actions.pod:3872
25557 msgid "guestfs_list_devices"
25561 #: ../src/guestfs-actions.pod:3874
25565 " guestfs_list_devices (guestfs_h *g);\n"
25570 #: ../src/guestfs-actions.pod:3889
25571 msgid "guestfs_list_dm_devices"
25575 #: ../src/guestfs-actions.pod:3891
25579 " guestfs_list_dm_devices (guestfs_h *g);\n"
25584 #: ../src/guestfs-actions.pod:3896
25586 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
25587 "previous call to C<guestfs_luks_open>."
25591 #: ../src/guestfs-actions.pod:3899
25593 "Device mapper devices which correspond to logical volumes are I<not> "
25594 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
25599 #: ../src/guestfs-actions.pod:3907 ../src/guestfs-actions.pod:5353
25600 msgid "(Added in 1.11.15)"
25604 #: ../src/guestfs-actions.pod:3909
25605 msgid "guestfs_list_filesystems"
25609 #: ../src/guestfs-actions.pod:3911
25613 " guestfs_list_filesystems (guestfs_h *g);\n"
25618 #: ../src/guestfs-actions.pod:3931
25620 "This command runs other libguestfs commands, which might include "
25621 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
25622 "soon after launch and only when nothing is mounted."
25626 #: ../src/guestfs-actions.pod:3935
25628 "Not all of the filesystems returned will be mountable. In particular, swap "
25629 "partitions are returned in the list. Also this command does not check that "
25630 "each filesystem found is valid and mountable, and some filesystems might be "
25631 "mountable but require special options. Filesystems may not all belong to a "
25632 "single logical operating system (use C<guestfs_inspect_os> to look for "
25637 #: ../src/guestfs-actions.pod:3949 ../src/guestfs-actions.pod:5714
25638 msgid "(Added in 1.5.15)"
25642 #: ../src/guestfs-actions.pod:3951
25643 msgid "guestfs_list_partitions"
25647 #: ../src/guestfs-actions.pod:3953
25651 " guestfs_list_partitions (guestfs_h *g);\n"
25656 #: ../src/guestfs-actions.pod:3960
25658 "This does not return logical volumes. For that you will need to call "
25663 #: ../src/guestfs-actions.pod:3971
25668 #: ../src/guestfs-actions.pod:3973
25672 " guestfs_ll (guestfs_h *g,\n"
25673 " const char *directory);\n"
25678 #: ../src/guestfs-actions.pod:3988
25683 #: ../src/guestfs-actions.pod:3990
25687 " guestfs_ln (guestfs_h *g,\n"
25688 " const char *target,\n"
25689 " const char *linkname);\n"
25694 #: ../src/guestfs-actions.pod:4001
25695 msgid "guestfs_ln_f"
25699 #: ../src/guestfs-actions.pod:4003
25703 " guestfs_ln_f (guestfs_h *g,\n"
25704 " const char *target,\n"
25705 " const char *linkname);\n"
25710 #: ../src/guestfs-actions.pod:4015
25711 msgid "guestfs_ln_s"
25715 #: ../src/guestfs-actions.pod:4017
25719 " guestfs_ln_s (guestfs_h *g,\n"
25720 " const char *target,\n"
25721 " const char *linkname);\n"
25726 #: ../src/guestfs-actions.pod:4028
25727 msgid "guestfs_ln_sf"
25731 #: ../src/guestfs-actions.pod:4030
25735 " guestfs_ln_sf (guestfs_h *g,\n"
25736 " const char *target,\n"
25737 " const char *linkname);\n"
25742 #: ../src/guestfs-actions.pod:4042
25743 msgid "guestfs_lremovexattr"
25747 #: ../src/guestfs-actions.pod:4044
25751 " guestfs_lremovexattr (guestfs_h *g,\n"
25752 " const char *xattr,\n"
25753 " const char *path);\n"
25758 #: ../src/guestfs-actions.pod:4049
25760 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
25761 "link, then it removes an extended attribute of the link itself."
25765 #: ../src/guestfs-actions.pod:4057
25770 #: ../src/guestfs-actions.pod:4059
25774 " guestfs_ls (guestfs_h *g,\n"
25775 " const char *directory);\n"
25780 #: ../src/guestfs-actions.pod:4067
25782 "This command is mostly useful for interactive sessions. Programs should "
25783 "probably use C<guestfs_readdir> instead."
25787 #: ../src/guestfs-actions.pod:4076
25788 msgid "guestfs_lsetxattr"
25792 #: ../src/guestfs-actions.pod:4078
25796 " guestfs_lsetxattr (guestfs_h *g,\n"
25797 " const char *xattr,\n"
25798 " const char *val,\n"
25800 " const char *path);\n"
25805 #: ../src/guestfs-actions.pod:4085
25807 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
25808 "then it sets an extended attribute of the link itself."
25812 #: ../src/guestfs-actions.pod:4093
25813 msgid "guestfs_lstat"
25817 #: ../src/guestfs-actions.pod:4095
25820 " struct guestfs_stat *\n"
25821 " guestfs_lstat (guestfs_h *g,\n"
25822 " const char *path);\n"
25827 #: ../src/guestfs-actions.pod:4101
25829 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
25830 "link, then the link is stat-ed, not the file it refers to."
25834 #: ../src/guestfs-actions.pod:4107 ../src/guestfs-actions.pod:6886
25836 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
25837 "error. I<The caller must call C<guestfs_free_stat> after use>."
25841 #: ../src/guestfs-actions.pod:4111 ../src/guestfs-actions.pod:6890 ../src/guestfs-actions.pod:6908 ../src/guestfs-actions.pod:7289
25842 msgid "(Added in 0.9.2)"
25846 #: ../src/guestfs-actions.pod:4113
25847 msgid "guestfs_lstatlist"
25851 #: ../src/guestfs-actions.pod:4115
25854 " struct guestfs_stat_list *\n"
25855 " guestfs_lstatlist (guestfs_h *g,\n"
25856 " const char *path,\n"
25857 " char *const *names);\n"
25862 #: ../src/guestfs-actions.pod:4120
25864 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
25865 "files, where all files are in the directory C<path>. C<names> is the list "
25866 "of files from this directory."
25870 #: ../src/guestfs-actions.pod:4129
25872 "This call is intended for programs that want to efficiently list a directory "
25873 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
25874 "for a similarly efficient call for getting extended attributes. Very long "
25875 "directory listings might cause the protocol message size to be exceeded, "
25876 "causing this call to fail. The caller must split up such requests into "
25877 "smaller groups of names."
25881 #: ../src/guestfs-actions.pod:4137
25883 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
25884 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
25888 #: ../src/guestfs-actions.pod:4143
25889 msgid "guestfs_luks_add_key"
25893 #: ../src/guestfs-actions.pod:4145
25897 " guestfs_luks_add_key (guestfs_h *g,\n"
25898 " const char *device,\n"
25899 " const char *key,\n"
25900 " const char *newkey,\n"
25906 #: ../src/guestfs-actions.pod:4157
25908 "Note that if C<keyslot> already contains a key, then this command will "
25909 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
25913 #: ../src/guestfs-actions.pod:4163 ../src/guestfs-actions.pod:4203 ../src/guestfs-actions.pod:4226 ../src/guestfs-actions.pod:4246 ../src/guestfs-actions.pod:4281 ../src/guestfs-actions.pod:4300
25915 "This function takes a key or passphrase parameter which could contain "
25916 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
25921 #: ../src/guestfs-actions.pod:4167 ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4230 ../src/guestfs-actions.pod:4250
25922 msgid "(Added in 1.5.2)"
25926 #: ../src/guestfs-actions.pod:4169
25927 msgid "guestfs_luks_close"
25931 #: ../src/guestfs-actions.pod:4171
25935 " guestfs_luks_close (guestfs_h *g,\n"
25936 " const char *device);\n"
25941 #: ../src/guestfs-actions.pod:4175
25943 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
25944 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
25945 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
25946 "underlying block device."
25950 #: ../src/guestfs-actions.pod:4183 ../src/guestfs-actions.pod:4285 ../src/guestfs-actions.pod:4304 ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:4402
25951 msgid "(Added in 1.5.1)"
25955 #: ../src/guestfs-actions.pod:4185
25956 msgid "guestfs_luks_format"
25960 #: ../src/guestfs-actions.pod:4187
25964 " guestfs_luks_format (guestfs_h *g,\n"
25965 " const char *device,\n"
25966 " const char *key,\n"
25972 #: ../src/guestfs-actions.pod:4209
25973 msgid "guestfs_luks_format_cipher"
25977 #: ../src/guestfs-actions.pod:4211
25981 " guestfs_luks_format_cipher (guestfs_h *g,\n"
25982 " const char *device,\n"
25983 " const char *key,\n"
25985 " const char *cipher);\n"
25990 #: ../src/guestfs-actions.pod:4218
25992 "This command is the same as C<guestfs_luks_format> but it also allows you to "
25993 "set the C<cipher> used."
25997 #: ../src/guestfs-actions.pod:4232
25998 msgid "guestfs_luks_kill_slot"
26002 #: ../src/guestfs-actions.pod:4234
26006 " guestfs_luks_kill_slot (guestfs_h *g,\n"
26007 " const char *device,\n"
26008 " const char *key,\n"
26014 #: ../src/guestfs-actions.pod:4252
26015 msgid "guestfs_luks_open"
26019 #: ../src/guestfs-actions.pod:4254
26023 " guestfs_luks_open (guestfs_h *g,\n"
26024 " const char *device,\n"
26025 " const char *key,\n"
26026 " const char *mapname);\n"
26031 #: ../src/guestfs-actions.pod:4272
26033 "If this block device contains LVM volume groups, then calling "
26034 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
26039 #: ../src/guestfs-actions.pod:4276
26040 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
26044 #: ../src/guestfs-actions.pod:4287
26045 msgid "guestfs_luks_open_ro"
26049 #: ../src/guestfs-actions.pod:4289
26053 " guestfs_luks_open_ro (guestfs_h *g,\n"
26054 " const char *device,\n"
26055 " const char *key,\n"
26056 " const char *mapname);\n"
26061 #: ../src/guestfs-actions.pod:4295
26063 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
26068 #: ../src/guestfs-actions.pod:4306
26069 msgid "guestfs_lvcreate"
26073 #: ../src/guestfs-actions.pod:4308
26077 " guestfs_lvcreate (guestfs_h *g,\n"
26078 " const char *logvol,\n"
26079 " const char *volgroup,\n"
26085 #: ../src/guestfs-actions.pod:4321
26086 msgid "guestfs_lvm_canonical_lv_name"
26090 #: ../src/guestfs-actions.pod:4323
26094 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
26095 " const char *lvname);\n"
26100 #: ../src/guestfs-actions.pod:4334
26101 msgid "See also C<guestfs_is_lv>."
26105 #: ../src/guestfs-actions.pod:4339
26106 msgid "(Added in 1.5.24)"
26110 #: ../src/guestfs-actions.pod:4341
26111 msgid "guestfs_lvm_clear_filter"
26115 #: ../src/guestfs-actions.pod:4343
26119 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
26124 #: ../src/guestfs-actions.pod:4346
26126 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
26127 "see every block device."
26131 #: ../src/guestfs-actions.pod:4356
26132 msgid "guestfs_lvm_remove_all"
26136 #: ../src/guestfs-actions.pod:4358
26140 " guestfs_lvm_remove_all (guestfs_h *g);\n"
26145 #: ../src/guestfs-actions.pod:4371
26146 msgid "guestfs_lvm_set_filter"
26150 #: ../src/guestfs-actions.pod:4373
26154 " guestfs_lvm_set_filter (guestfs_h *g,\n"
26155 " char *const *devices);\n"
26160 #: ../src/guestfs-actions.pod:4404
26161 msgid "guestfs_lvremove"
26165 #: ../src/guestfs-actions.pod:4406
26169 " guestfs_lvremove (guestfs_h *g,\n"
26170 " const char *device);\n"
26175 #: ../src/guestfs-actions.pod:4418 ../src/guestfs-actions.pod:5811 ../src/guestfs-actions.pod:7659
26176 msgid "(Added in 1.0.13)"
26180 #: ../src/guestfs-actions.pod:4420
26181 msgid "guestfs_lvrename"
26185 #: ../src/guestfs-actions.pod:4422
26189 " guestfs_lvrename (guestfs_h *g,\n"
26190 " const char *logvol,\n"
26191 " const char *newlogvol);\n"
26196 #: ../src/guestfs-actions.pod:4431 ../src/guestfs-actions.pod:7672
26197 msgid "(Added in 1.0.83)"
26201 #: ../src/guestfs-actions.pod:4433
26202 msgid "guestfs_lvresize"
26206 #: ../src/guestfs-actions.pod:4435
26210 " guestfs_lvresize (guestfs_h *g,\n"
26211 " const char *device,\n"
26217 #: ../src/guestfs-actions.pod:4448
26218 msgid "guestfs_lvresize_free"
26222 #: ../src/guestfs-actions.pod:4450
26226 " guestfs_lvresize_free (guestfs_h *g,\n"
26227 " const char *lv,\n"
26233 #: ../src/guestfs-actions.pod:4463
26234 msgid "(Added in 1.3.3)"
26238 #: ../src/guestfs-actions.pod:4465
26239 msgid "guestfs_lvs"
26243 #: ../src/guestfs-actions.pod:4467
26247 " guestfs_lvs (guestfs_h *g);\n"
26252 #: ../src/guestfs-actions.pod:4476
26253 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
26257 #: ../src/guestfs-actions.pod:4484
26258 msgid "guestfs_lvs_full"
26262 #: ../src/guestfs-actions.pod:4486
26265 " struct guestfs_lvm_lv_list *\n"
26266 " guestfs_lvs_full (guestfs_h *g);\n"
26271 #: ../src/guestfs-actions.pod:4492
26273 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
26274 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
26279 #: ../src/guestfs-actions.pod:4498
26280 msgid "guestfs_lvuuid"
26284 #: ../src/guestfs-actions.pod:4500
26288 " guestfs_lvuuid (guestfs_h *g,\n"
26289 " const char *device);\n"
26294 #: ../src/guestfs-actions.pod:4511
26295 msgid "guestfs_lxattrlist"
26299 #: ../src/guestfs-actions.pod:4513
26302 " struct guestfs_xattr_list *\n"
26303 " guestfs_lxattrlist (guestfs_h *g,\n"
26304 " const char *path,\n"
26305 " char *const *names);\n"
26310 #: ../src/guestfs-actions.pod:4532
26312 "This call is intended for programs that want to efficiently list a directory "
26313 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
26314 "a similarly efficient call for getting standard stats. Very long directory "
26315 "listings might cause the protocol message size to be exceeded, causing this "
26316 "call to fail. The caller must split up such requests into smaller groups of "
26321 #: ../src/guestfs-actions.pod:4546
26322 msgid "guestfs_mkdir"
26326 #: ../src/guestfs-actions.pod:4548
26330 " guestfs_mkdir (guestfs_h *g,\n"
26331 " const char *path);\n"
26336 #: ../src/guestfs-actions.pod:4558
26337 msgid "guestfs_mkdir_mode"
26341 #: ../src/guestfs-actions.pod:4560
26345 " guestfs_mkdir_mode (guestfs_h *g,\n"
26346 " const char *path,\n"
26352 #: ../src/guestfs-actions.pod:4572
26353 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
26357 #: ../src/guestfs-actions.pod:4578
26358 msgid "guestfs_mkdir_p"
26362 #: ../src/guestfs-actions.pod:4580
26366 " guestfs_mkdir_p (guestfs_h *g,\n"
26367 " const char *path);\n"
26372 #: ../src/guestfs-actions.pod:4591
26373 msgid "guestfs_mkdtemp"
26377 #: ../src/guestfs-actions.pod:4593
26381 " guestfs_mkdtemp (guestfs_h *g,\n"
26382 " const char *template);\n"
26387 #: ../src/guestfs-actions.pod:4621
26388 msgid "guestfs_mke2fs_J"
26392 #: ../src/guestfs-actions.pod:4623
26396 " guestfs_mke2fs_J (guestfs_h *g,\n"
26397 " const char *fstype,\n"
26398 " int blocksize,\n"
26399 " const char *device,\n"
26400 " const char *journal);\n"
26405 #: ../src/guestfs-actions.pod:4636
26406 msgid "See also C<guestfs_mke2journal>."
26410 #: ../src/guestfs-actions.pod:4640 ../src/guestfs-actions.pod:4658 ../src/guestfs-actions.pod:4676 ../src/guestfs-actions.pod:4692 ../src/guestfs-actions.pod:4706 ../src/guestfs-actions.pod:4720 ../src/guestfs-actions.pod:4779 ../src/guestfs-actions.pod:5056
26411 msgid "(Added in 1.0.68)"
26415 #: ../src/guestfs-actions.pod:4642
26416 msgid "guestfs_mke2fs_JL"
26420 #: ../src/guestfs-actions.pod:4644
26424 " guestfs_mke2fs_JL (guestfs_h *g,\n"
26425 " const char *fstype,\n"
26426 " int blocksize,\n"
26427 " const char *device,\n"
26428 " const char *label);\n"
26433 #: ../src/guestfs-actions.pod:4654
26434 msgid "See also C<guestfs_mke2journal_L>."
26438 #: ../src/guestfs-actions.pod:4660
26439 msgid "guestfs_mke2fs_JU"
26443 #: ../src/guestfs-actions.pod:4662
26447 " guestfs_mke2fs_JU (guestfs_h *g,\n"
26448 " const char *fstype,\n"
26449 " int blocksize,\n"
26450 " const char *device,\n"
26451 " const char *uuid);\n"
26456 #: ../src/guestfs-actions.pod:4672
26457 msgid "See also C<guestfs_mke2journal_U>."
26461 #: ../src/guestfs-actions.pod:4678
26462 msgid "guestfs_mke2journal"
26466 #: ../src/guestfs-actions.pod:4680
26470 " guestfs_mke2journal (guestfs_h *g,\n"
26471 " int blocksize,\n"
26472 " const char *device);\n"
26477 #: ../src/guestfs-actions.pod:4694
26478 msgid "guestfs_mke2journal_L"
26482 #: ../src/guestfs-actions.pod:4696
26486 " guestfs_mke2journal_L (guestfs_h *g,\n"
26487 " int blocksize,\n"
26488 " const char *label,\n"
26489 " const char *device);\n"
26494 #: ../src/guestfs-actions.pod:4708
26495 msgid "guestfs_mke2journal_U"
26499 #: ../src/guestfs-actions.pod:4710
26503 " guestfs_mke2journal_U (guestfs_h *g,\n"
26504 " int blocksize,\n"
26505 " const char *uuid,\n"
26506 " const char *device);\n"
26511 #: ../src/guestfs-actions.pod:4722
26512 msgid "guestfs_mkfifo"
26516 #: ../src/guestfs-actions.pod:4724
26520 " guestfs_mkfifo (guestfs_h *g,\n"
26522 " const char *path);\n"
26527 #: ../src/guestfs-actions.pod:4729
26529 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
26530 "is just a convenient wrapper around C<guestfs_mknod>."
26534 #: ../src/guestfs-actions.pod:4739
26535 msgid "guestfs_mkfs"
26539 #: ../src/guestfs-actions.pod:4741
26543 " guestfs_mkfs (guestfs_h *g,\n"
26544 " const char *fstype,\n"
26545 " const char *device);\n"
26550 #: ../src/guestfs-actions.pod:4754
26551 msgid "guestfs_mkfs_b"
26555 #: ../src/guestfs-actions.pod:4756
26559 " guestfs_mkfs_b (guestfs_h *g,\n"
26560 " const char *fstype,\n"
26561 " int blocksize,\n"
26562 " const char *device);\n"
26567 #: ../src/guestfs-actions.pod:4762
26569 "I<This function is deprecated.> In new code, use the L</guestfs_mkfs_opts> "
26574 #: ../src/guestfs-actions.pod:4769
26576 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
26577 "block size of the resulting filesystem. Supported block sizes depend on the "
26578 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
26582 #: ../src/guestfs-actions.pod:4781
26583 msgid "guestfs_mkfs_opts"
26587 #: ../src/guestfs-actions.pod:4783
26591 " guestfs_mkfs_opts (guestfs_h *g,\n"
26592 " const char *fstype,\n"
26593 " const char *device,\n"
26599 #: ../src/guestfs-actions.pod:4794
26602 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
26603 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
26604 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
26605 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
26610 #: ../src/guestfs-actions.pod:4842
26611 msgid "(Added in 1.7.19)"
26615 #: ../src/guestfs-actions.pod:4844
26616 msgid "guestfs_mkfs_opts_va"
26620 #: ../src/guestfs-actions.pod:4846
26624 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
26625 " const char *fstype,\n"
26626 " const char *device,\n"
26627 " va_list args);\n"
26632 #: ../src/guestfs-actions.pod:4852
26633 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
26637 #: ../src/guestfs-actions.pod:4856
26638 msgid "guestfs_mkfs_opts_argv"
26642 #: ../src/guestfs-actions.pod:4858
26646 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
26647 " const char *fstype,\n"
26648 " const char *device,\n"
26649 " const struct guestfs_mkfs_opts_argv *optargs);\n"
26654 #: ../src/guestfs-actions.pod:4864
26655 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
26659 #: ../src/guestfs-actions.pod:4868
26660 msgid "guestfs_mkmountpoint"
26664 #: ../src/guestfs-actions.pod:4870
26668 " guestfs_mkmountpoint (guestfs_h *g,\n"
26669 " const char *exemptpath);\n"
26674 #: ../src/guestfs-actions.pod:4874
26676 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
26677 "that can be used to create extra mountpoints before mounting the first "
26682 #: ../src/guestfs-actions.pod:4898
26684 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
26685 "may get unexpected errors if you try to mix these calls. It is safest to "
26686 "manually unmount filesystems and remove mountpoints after use."
26690 #: ../src/guestfs-actions.pod:4902
26692 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
26693 "first, so for this to work for manual mountpoints, you must ensure that the "
26694 "innermost mountpoints have the longest pathnames, as in the example code "
26699 #: ../src/guestfs-actions.pod:4909
26701 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
26702 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
26703 "can also trigger these issues."
26707 #: ../src/guestfs-actions.pod:4915 ../src/guestfs-actions.pod:5221 ../src/guestfs-actions.pod:6231
26708 msgid "(Added in 1.0.62)"
26712 #: ../src/guestfs-actions.pod:4917
26713 msgid "guestfs_mknod"
26717 #: ../src/guestfs-actions.pod:4919
26721 " guestfs_mknod (guestfs_h *g,\n"
26725 " const char *path);\n"
26730 #: ../src/guestfs-actions.pod:4934
26732 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
26733 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
26734 "regular file). These constants are available in the standard Linux header "
26735 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
26736 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
26737 "the appropriate constant for you."
26741 #: ../src/guestfs-actions.pod:4948
26742 msgid "guestfs_mknod_b"
26746 #: ../src/guestfs-actions.pod:4950
26750 " guestfs_mknod_b (guestfs_h *g,\n"
26754 " const char *path);\n"
26759 #: ../src/guestfs-actions.pod:4957
26761 "This call creates a block device node called C<path> with mode C<mode> and "
26762 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26763 "wrapper around C<guestfs_mknod>."
26767 #: ../src/guestfs-actions.pod:4967
26768 msgid "guestfs_mknod_c"
26772 #: ../src/guestfs-actions.pod:4969
26776 " guestfs_mknod_c (guestfs_h *g,\n"
26780 " const char *path);\n"
26785 #: ../src/guestfs-actions.pod:4976
26787 "This call creates a char device node called C<path> with mode C<mode> and "
26788 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26789 "wrapper around C<guestfs_mknod>."
26793 #: ../src/guestfs-actions.pod:4986
26794 msgid "guestfs_mkswap"
26798 #: ../src/guestfs-actions.pod:4988
26802 " guestfs_mkswap (guestfs_h *g,\n"
26803 " const char *device);\n"
26808 #: ../src/guestfs-actions.pod:4998
26809 msgid "guestfs_mkswap_L"
26813 #: ../src/guestfs-actions.pod:5000
26817 " guestfs_mkswap_L (guestfs_h *g,\n"
26818 " const char *label,\n"
26819 " const char *device);\n"
26824 #: ../src/guestfs-actions.pod:5015
26825 msgid "guestfs_mkswap_U"
26829 #: ../src/guestfs-actions.pod:5017
26833 " guestfs_mkswap_U (guestfs_h *g,\n"
26834 " const char *uuid,\n"
26835 " const char *device);\n"
26840 #: ../src/guestfs-actions.pod:5028
26841 msgid "guestfs_mkswap_file"
26845 #: ../src/guestfs-actions.pod:5030
26849 " guestfs_mkswap_file (guestfs_h *g,\n"
26850 " const char *path);\n"
26855 #: ../src/guestfs-actions.pod:5036
26857 "This command just writes a swap file signature to an existing file. To "
26858 "create the file itself, use something like C<guestfs_fallocate>."
26862 #: ../src/guestfs-actions.pod:5043
26863 msgid "guestfs_modprobe"
26867 #: ../src/guestfs-actions.pod:5045
26871 " guestfs_modprobe (guestfs_h *g,\n"
26872 " const char *modulename);\n"
26877 #: ../src/guestfs-actions.pod:5058
26878 msgid "guestfs_mount"
26882 #: ../src/guestfs-actions.pod:5060
26886 " guestfs_mount (guestfs_h *g,\n"
26887 " const char *device,\n"
26888 " const char *mountpoint);\n"
26893 #: ../src/guestfs-actions.pod:5079
26895 "Before libguestfs 1.13.16, this call implicitly added the options C<sync> "
26896 "and C<noatime>. The C<sync> option greatly slowed writes and caused many "
26897 "problems for users. If your program might need to work with older versions "
26898 "of libguestfs, use C<guestfs_mount_options> instead (using an empty string "
26899 "for the first parameter if you don't want any options)."
26903 #: ../src/guestfs-actions.pod:5090
26904 msgid "guestfs_mount_9p"
26908 #: ../src/guestfs-actions.pod:5092
26912 " guestfs_mount_9p (guestfs_h *g,\n"
26913 " const char *mounttag,\n"
26914 " const char *mountpoint,\n"
26920 #: ../src/guestfs-actions.pod:5103
26923 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
26928 #: ../src/guestfs-actions.pod:5116
26929 msgid "guestfs_mount_9p_va"
26933 #: ../src/guestfs-actions.pod:5118
26937 " guestfs_mount_9p_va (guestfs_h *g,\n"
26938 " const char *mounttag,\n"
26939 " const char *mountpoint,\n"
26940 " va_list args);\n"
26945 #: ../src/guestfs-actions.pod:5124
26946 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
26950 #: ../src/guestfs-actions.pod:5128
26951 msgid "guestfs_mount_9p_argv"
26955 #: ../src/guestfs-actions.pod:5130
26959 " guestfs_mount_9p_argv (guestfs_h *g,\n"
26960 " const char *mounttag,\n"
26961 " const char *mountpoint,\n"
26962 " const struct guestfs_mount_9p_argv *optargs);\n"
26967 #: ../src/guestfs-actions.pod:5136
26968 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
26972 #: ../src/guestfs-actions.pod:5140
26973 msgid "guestfs_mount_loop"
26977 #: ../src/guestfs-actions.pod:5142
26981 " guestfs_mount_loop (guestfs_h *g,\n"
26982 " const char *file,\n"
26983 " const char *mountpoint);\n"
26988 #: ../src/guestfs-actions.pod:5155
26989 msgid "guestfs_mount_options"
26993 #: ../src/guestfs-actions.pod:5157
26997 " guestfs_mount_options (guestfs_h *g,\n"
26998 " const char *options,\n"
26999 " const char *device,\n"
27000 " const char *mountpoint);\n"
27005 #: ../src/guestfs-actions.pod:5163
27007 "This is the same as the C<guestfs_mount> command, but it allows you to set "
27008 "the mount options as for the L<mount(8)> I<-o> flag."
27012 #: ../src/guestfs-actions.pod:5173 ../src/guestfs-actions.pod:5187 ../src/guestfs-actions.pod:5204
27013 msgid "(Added in 1.0.10)"
27017 #: ../src/guestfs-actions.pod:5175
27018 msgid "guestfs_mount_ro"
27022 #: ../src/guestfs-actions.pod:5177
27026 " guestfs_mount_ro (guestfs_h *g,\n"
27027 " const char *device,\n"
27028 " const char *mountpoint);\n"
27033 #: ../src/guestfs-actions.pod:5182
27035 "This is the same as the C<guestfs_mount> command, but it mounts the "
27036 "filesystem with the read-only (I<-o ro>) flag."
27040 #: ../src/guestfs-actions.pod:5189
27041 msgid "guestfs_mount_vfs"
27045 #: ../src/guestfs-actions.pod:5191
27049 " guestfs_mount_vfs (guestfs_h *g,\n"
27050 " const char *options,\n"
27051 " const char *vfstype,\n"
27052 " const char *device,\n"
27053 " const char *mountpoint);\n"
27058 #: ../src/guestfs-actions.pod:5198
27060 "This is the same as the C<guestfs_mount> command, but it allows you to set "
27061 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
27066 #: ../src/guestfs-actions.pod:5206
27067 msgid "guestfs_mountpoints"
27071 #: ../src/guestfs-actions.pod:5208
27075 " guestfs_mountpoints (guestfs_h *g);\n"
27080 #: ../src/guestfs-actions.pod:5211
27082 "This call is similar to C<guestfs_mounts>. That call returns a list of "
27083 "devices. This one returns a hash table (map) of device name to directory "
27084 "where the device is mounted."
27088 #: ../src/guestfs-actions.pod:5223
27089 msgid "guestfs_mounts"
27093 #: ../src/guestfs-actions.pod:5225
27097 " guestfs_mounts (guestfs_h *g);\n"
27102 #: ../src/guestfs-actions.pod:5233
27103 msgid "See also: C<guestfs_mountpoints>"
27107 #: ../src/guestfs-actions.pod:5241
27112 #: ../src/guestfs-actions.pod:5243
27116 " guestfs_mv (guestfs_h *g,\n"
27117 " const char *src,\n"
27118 " const char *dest);\n"
27123 #: ../src/guestfs-actions.pod:5255
27124 msgid "guestfs_ntfs_3g_probe"
27128 #: ../src/guestfs-actions.pod:5257
27132 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
27134 " const char *device);\n"
27139 #: ../src/guestfs-actions.pod:5276
27140 msgid "(Added in 1.0.43)"
27144 #: ../src/guestfs-actions.pod:5278
27145 msgid "guestfs_ntfsresize"
27149 #: ../src/guestfs-actions.pod:5280
27153 " guestfs_ntfsresize (guestfs_h *g,\n"
27154 " const char *device);\n"
27159 #: ../src/guestfs-actions.pod:5284 ../src/guestfs-actions.pod:5384
27161 "I<This function is deprecated.> In new code, use the "
27162 "L</guestfs_ntfsresize_opts> call instead."
27166 #: ../src/guestfs-actions.pod:5308
27167 msgid "guestfs_ntfsresize_opts"
27171 #: ../src/guestfs-actions.pod:5310
27175 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
27176 " const char *device,\n"
27182 #: ../src/guestfs-actions.pod:5320
27185 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
27186 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
27191 #: ../src/guestfs-actions.pod:5340
27193 "After the resize operation, the filesystem is always marked as requiring a "
27194 "consistency check (for safety). You have to boot into Windows to perform "
27195 "this check and clear this condition. If you I<don't> set the C<force> "
27196 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
27197 "times on a single filesystem without booting into Windows between each "
27202 #: ../src/guestfs-actions.pod:5355
27203 msgid "guestfs_ntfsresize_opts_va"
27207 #: ../src/guestfs-actions.pod:5357
27211 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
27212 " const char *device,\n"
27213 " va_list args);\n"
27218 #: ../src/guestfs-actions.pod:5362
27219 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
27223 #: ../src/guestfs-actions.pod:5366
27224 msgid "guestfs_ntfsresize_opts_argv"
27228 #: ../src/guestfs-actions.pod:5368
27232 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
27233 " const char *device,\n"
27234 " const struct guestfs_ntfsresize_opts_argv "
27240 #: ../src/guestfs-actions.pod:5373
27241 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
27245 #: ../src/guestfs-actions.pod:5377
27246 msgid "guestfs_ntfsresize_size"
27250 #: ../src/guestfs-actions.pod:5379
27254 " guestfs_ntfsresize_size (guestfs_h *g,\n"
27255 " const char *device,\n"
27256 " int64_t size);\n"
27261 #: ../src/guestfs-actions.pod:5391
27263 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
27264 "to specify the new size (in bytes) explicitly."
27268 #: ../src/guestfs-actions.pod:5396 ../src/guestfs-actions.pod:5838 ../src/guestfs-actions.pod:5911 ../src/guestfs-actions.pod:6179 ../src/guestfs-actions.pod:7816
27269 msgid "(Added in 1.3.14)"
27273 #: ../src/guestfs-actions.pod:5398
27274 msgid "guestfs_part_add"
27278 #: ../src/guestfs-actions.pod:5400
27282 " guestfs_part_add (guestfs_h *g,\n"
27283 " const char *device,\n"
27284 " const char *prlogex,\n"
27285 " int64_t startsect,\n"
27286 " int64_t endsect);\n"
27291 #: ../src/guestfs-actions.pod:5407
27293 "This command adds a partition to C<device>. If there is no partition table "
27294 "on the device, call C<guestfs_part_init> first."
27298 #: ../src/guestfs-actions.pod:5419
27300 "Creating a partition which covers the whole disk is not so easy. Use "
27301 "C<guestfs_part_disk> to do that."
27305 #: ../src/guestfs-actions.pod:5424 ../src/guestfs-actions.pod:5462 ../src/guestfs-actions.pod:5515 ../src/guestfs-actions.pod:5599 ../src/guestfs-actions.pod:5637 ../src/guestfs-actions.pod:5656 ../src/guestfs-actions.pod:5696
27306 msgid "(Added in 1.0.78)"
27310 #: ../src/guestfs-actions.pod:5426
27311 msgid "guestfs_part_del"
27315 #: ../src/guestfs-actions.pod:5428
27319 " guestfs_part_del (guestfs_h *g,\n"
27320 " const char *device,\n"
27326 #: ../src/guestfs-actions.pod:5443
27327 msgid "guestfs_part_disk"
27331 #: ../src/guestfs-actions.pod:5445
27335 " guestfs_part_disk (guestfs_h *g,\n"
27336 " const char *device,\n"
27337 " const char *parttype);\n"
27342 #: ../src/guestfs-actions.pod:5450
27344 "This command is simply a combination of C<guestfs_part_init> followed by "
27345 "C<guestfs_part_add> to create a single primary partition covering the whole "
27350 #: ../src/guestfs-actions.pod:5454
27352 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
27353 "possible values are described in C<guestfs_part_init>."
27357 #: ../src/guestfs-actions.pod:5464
27358 msgid "guestfs_part_get_bootable"
27362 #: ../src/guestfs-actions.pod:5466
27366 " guestfs_part_get_bootable (guestfs_h *g,\n"
27367 " const char *device,\n"
27373 #: ../src/guestfs-actions.pod:5474
27374 msgid "See also C<guestfs_part_set_bootable>."
27378 #: ../src/guestfs-actions.pod:5480
27379 msgid "guestfs_part_get_mbr_id"
27383 #: ../src/guestfs-actions.pod:5482
27387 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
27388 " const char *device,\n"
27394 #: ../src/guestfs-actions.pod:5490 ../src/guestfs-actions.pod:5672
27396 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
27397 "undefined results for other partition table types (see "
27398 "C<guestfs_part_get_parttype>)."
27402 #: ../src/guestfs-actions.pod:5498
27403 msgid "guestfs_part_get_parttype"
27407 #: ../src/guestfs-actions.pod:5500
27411 " guestfs_part_get_parttype (guestfs_h *g,\n"
27412 " const char *device);\n"
27417 #: ../src/guestfs-actions.pod:5507
27419 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
27420 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
27421 "possible, although unusual. See C<guestfs_part_init> for a full list."
27425 #: ../src/guestfs-actions.pod:5517
27426 msgid "guestfs_part_init"
27430 #: ../src/guestfs-actions.pod:5519
27434 " guestfs_part_init (guestfs_h *g,\n"
27435 " const char *device,\n"
27436 " const char *parttype);\n"
27441 #: ../src/guestfs-actions.pod:5528
27443 "Initially there are no partitions. Following this, you should call "
27444 "C<guestfs_part_add> for each partition required."
27448 #: ../src/guestfs-actions.pod:5601
27449 msgid "guestfs_part_list"
27453 #: ../src/guestfs-actions.pod:5603
27456 " struct guestfs_partition_list *\n"
27457 " guestfs_part_list (guestfs_h *g,\n"
27458 " const char *device);\n"
27463 #: ../src/guestfs-actions.pod:5620
27465 "Start of the partition I<in bytes>. To get sectors you have to divide by "
27466 "the device's sector size, see C<guestfs_blockdev_getss>."
27470 #: ../src/guestfs-actions.pod:5633
27472 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
27473 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
27478 #: ../src/guestfs-actions.pod:5639
27479 msgid "guestfs_part_set_bootable"
27483 #: ../src/guestfs-actions.pod:5641
27487 " guestfs_part_set_bootable (guestfs_h *g,\n"
27488 " const char *device,\n"
27490 " int bootable);\n"
27495 #: ../src/guestfs-actions.pod:5658
27496 msgid "guestfs_part_set_mbr_id"
27500 #: ../src/guestfs-actions.pod:5660
27504 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
27505 " const char *device,\n"
27512 #: ../src/guestfs-actions.pod:5680
27513 msgid "guestfs_part_set_name"
27517 #: ../src/guestfs-actions.pod:5682
27521 " guestfs_part_set_name (guestfs_h *g,\n"
27522 " const char *device,\n"
27524 " const char *name);\n"
27529 #: ../src/guestfs-actions.pod:5698
27530 msgid "guestfs_part_to_dev"
27534 #: ../src/guestfs-actions.pod:5700
27538 " guestfs_part_to_dev (guestfs_h *g,\n"
27539 " const char *partition);\n"
27544 #: ../src/guestfs-actions.pod:5708
27546 "The named partition must exist, for example as a string returned from "
27547 "C<guestfs_list_partitions>."
27551 #: ../src/guestfs-actions.pod:5716
27552 msgid "guestfs_ping_daemon"
27556 #: ../src/guestfs-actions.pod:5718
27560 " guestfs_ping_daemon (guestfs_h *g);\n"
27565 #: ../src/guestfs-actions.pod:5730
27566 msgid "guestfs_pread"
27570 #: ../src/guestfs-actions.pod:5732
27574 " guestfs_pread (guestfs_h *g,\n"
27575 " const char *path,\n"
27577 " int64_t offset,\n"
27578 " size_t *size_r);\n"
27583 #: ../src/guestfs-actions.pod:5745
27584 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
27588 #: ../src/guestfs-actions.pod:5756
27589 msgid "guestfs_pread_device"
27593 #: ../src/guestfs-actions.pod:5758
27597 " guestfs_pread_device (guestfs_h *g,\n"
27598 " const char *device,\n"
27600 " int64_t offset,\n"
27601 " size_t *size_r);\n"
27606 #: ../src/guestfs-actions.pod:5771
27607 msgid "See also C<guestfs_pread>."
27611 #: ../src/guestfs-actions.pod:5780
27612 msgid "(Added in 1.5.21)"
27616 #: ../src/guestfs-actions.pod:5782
27617 msgid "guestfs_pvcreate"
27621 #: ../src/guestfs-actions.pod:5784
27625 " guestfs_pvcreate (guestfs_h *g,\n"
27626 " const char *device);\n"
27631 #: ../src/guestfs-actions.pod:5796
27632 msgid "guestfs_pvremove"
27636 #: ../src/guestfs-actions.pod:5798
27640 " guestfs_pvremove (guestfs_h *g,\n"
27641 " const char *device);\n"
27646 #: ../src/guestfs-actions.pod:5813
27647 msgid "guestfs_pvresize"
27651 #: ../src/guestfs-actions.pod:5815
27655 " guestfs_pvresize (guestfs_h *g,\n"
27656 " const char *device);\n"
27661 #: ../src/guestfs-actions.pod:5826
27662 msgid "guestfs_pvresize_size"
27666 #: ../src/guestfs-actions.pod:5828
27670 " guestfs_pvresize_size (guestfs_h *g,\n"
27671 " const char *device,\n"
27672 " int64_t size);\n"
27677 #: ../src/guestfs-actions.pod:5833
27679 "This command is the same as C<guestfs_pvresize> except that it allows you to "
27680 "specify the new size (in bytes) explicitly."
27684 #: ../src/guestfs-actions.pod:5840
27685 msgid "guestfs_pvs"
27689 #: ../src/guestfs-actions.pod:5842
27693 " guestfs_pvs (guestfs_h *g);\n"
27698 #: ../src/guestfs-actions.pod:5851
27699 msgid "See also C<guestfs_pvs_full>."
27703 #: ../src/guestfs-actions.pod:5859
27704 msgid "guestfs_pvs_full"
27708 #: ../src/guestfs-actions.pod:5861
27711 " struct guestfs_lvm_pv_list *\n"
27712 " guestfs_pvs_full (guestfs_h *g);\n"
27717 #: ../src/guestfs-actions.pod:5867
27719 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
27720 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
27725 #: ../src/guestfs-actions.pod:5873
27726 msgid "guestfs_pvuuid"
27730 #: ../src/guestfs-actions.pod:5875
27734 " guestfs_pvuuid (guestfs_h *g,\n"
27735 " const char *device);\n"
27740 #: ../src/guestfs-actions.pod:5886
27741 msgid "guestfs_pwrite"
27745 #: ../src/guestfs-actions.pod:5888
27749 " guestfs_pwrite (guestfs_h *g,\n"
27750 " const char *path,\n"
27751 " const char *content,\n"
27752 " size_t content_size,\n"
27753 " int64_t offset);\n"
27758 #: ../src/guestfs-actions.pod:5904
27759 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
27763 #: ../src/guestfs-actions.pod:5913
27764 msgid "guestfs_pwrite_device"
27768 #: ../src/guestfs-actions.pod:5915
27772 " guestfs_pwrite_device (guestfs_h *g,\n"
27773 " const char *device,\n"
27774 " const char *content,\n"
27775 " size_t content_size,\n"
27776 " int64_t offset);\n"
27781 #: ../src/guestfs-actions.pod:5930
27782 msgid "See also C<guestfs_pwrite>."
27786 #: ../src/guestfs-actions.pod:5937
27787 msgid "(Added in 1.5.20)"
27791 #: ../src/guestfs-actions.pod:5939
27792 msgid "guestfs_read_file"
27796 #: ../src/guestfs-actions.pod:5941
27800 " guestfs_read_file (guestfs_h *g,\n"
27801 " const char *path,\n"
27802 " size_t *size_r);\n"
27807 #: ../src/guestfs-actions.pod:5949
27809 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
27810 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
27811 "function is limited in the total size of file that can be handled."
27815 #: ../src/guestfs-actions.pod:5961
27816 msgid "(Added in 1.0.63)"
27820 #: ../src/guestfs-actions.pod:5963
27821 msgid "guestfs_read_lines"
27825 #: ../src/guestfs-actions.pod:5965
27829 " guestfs_read_lines (guestfs_h *g,\n"
27830 " const char *path);\n"
27835 #: ../src/guestfs-actions.pod:5974
27837 "Note that this function cannot correctly handle binary files (specifically, "
27838 "files containing C<\\0> character which is treated as end of line). For "
27839 "those you need to use the C<guestfs_read_file> function which has a more "
27840 "complex interface."
27844 #: ../src/guestfs-actions.pod:5985
27845 msgid "guestfs_readdir"
27849 #: ../src/guestfs-actions.pod:5987
27852 " struct guestfs_dirent_list *\n"
27853 " guestfs_readdir (guestfs_h *g,\n"
27854 " const char *dir);\n"
27859 #: ../src/guestfs-actions.pod:6041
27861 "This function is primarily intended for use by programs. To get a simple "
27862 "list of names, use C<guestfs_ls>. To get a printable directory for human "
27863 "consumption, use C<guestfs_ll>."
27867 #: ../src/guestfs-actions.pod:6045
27869 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
27870 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
27875 #: ../src/guestfs-actions.pod:6051
27876 msgid "guestfs_readlink"
27880 #: ../src/guestfs-actions.pod:6053
27884 " guestfs_readlink (guestfs_h *g,\n"
27885 " const char *path);\n"
27890 #: ../src/guestfs-actions.pod:6064
27891 msgid "guestfs_readlinklist"
27895 #: ../src/guestfs-actions.pod:6066
27899 " guestfs_readlinklist (guestfs_h *g,\n"
27900 " const char *path,\n"
27901 " char *const *names);\n"
27906 #: ../src/guestfs-actions.pod:6099
27907 msgid "guestfs_realpath"
27911 #: ../src/guestfs-actions.pod:6101
27915 " guestfs_realpath (guestfs_h *g,\n"
27916 " const char *path);\n"
27921 #: ../src/guestfs-actions.pod:6113
27922 msgid "guestfs_removexattr"
27926 #: ../src/guestfs-actions.pod:6115
27930 " guestfs_removexattr (guestfs_h *g,\n"
27931 " const char *xattr,\n"
27932 " const char *path);\n"
27937 #: ../src/guestfs-actions.pod:6123
27938 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
27942 #: ../src/guestfs-actions.pod:6129
27943 msgid "guestfs_resize2fs"
27947 #: ../src/guestfs-actions.pod:6131
27951 " guestfs_resize2fs (guestfs_h *g,\n"
27952 " const char *device);\n"
27957 #: ../src/guestfs-actions.pod:6138
27959 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
27960 "C<device> before calling this command. For unknown reasons C<resize2fs> "
27961 "sometimes gives an error about this and sometimes not. In any case, it is "
27962 "always safe to call C<guestfs_e2fsck_f> before calling this function."
27966 #: ../src/guestfs-actions.pod:6148
27967 msgid "guestfs_resize2fs_M"
27971 #: ../src/guestfs-actions.pod:6150
27975 " guestfs_resize2fs_M (guestfs_h *g,\n"
27976 " const char *device);\n"
27981 #: ../src/guestfs-actions.pod:6154
27983 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
27984 "resized to its minimum size. This works like the I<-M> option to the "
27985 "C<resize2fs> command."
27989 #: ../src/guestfs-actions.pod:6158
27991 "To get the resulting size of the filesystem you should call "
27992 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
27993 "These two numbers, multiplied together, give the resulting size of the "
27994 "minimal filesystem in bytes."
27998 #: ../src/guestfs-actions.pod:6167
27999 msgid "guestfs_resize2fs_size"
28003 #: ../src/guestfs-actions.pod:6169
28007 " guestfs_resize2fs_size (guestfs_h *g,\n"
28008 " const char *device,\n"
28009 " int64_t size);\n"
28014 #: ../src/guestfs-actions.pod:6174
28016 "This command is the same as C<guestfs_resize2fs> except that it allows you "
28017 "to specify the new size (in bytes) explicitly."
28021 #: ../src/guestfs-actions.pod:6181
28026 #: ../src/guestfs-actions.pod:6183
28030 " guestfs_rm (guestfs_h *g,\n"
28031 " const char *path);\n"
28036 #: ../src/guestfs-actions.pod:6193
28037 msgid "guestfs_rm_rf"
28041 #: ../src/guestfs-actions.pod:6195
28045 " guestfs_rm_rf (guestfs_h *g,\n"
28046 " const char *path);\n"
28051 #: ../src/guestfs-actions.pod:6207
28052 msgid "guestfs_rmdir"
28056 #: ../src/guestfs-actions.pod:6209
28060 " guestfs_rmdir (guestfs_h *g,\n"
28061 " const char *path);\n"
28066 #: ../src/guestfs-actions.pod:6219
28067 msgid "guestfs_rmmountpoint"
28071 #: ../src/guestfs-actions.pod:6221
28075 " guestfs_rmmountpoint (guestfs_h *g,\n"
28076 " const char *exemptpath);\n"
28081 #: ../src/guestfs-actions.pod:6225
28083 "This calls removes a mountpoint that was previously created with "
28084 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
28088 #: ../src/guestfs-actions.pod:6233
28089 msgid "guestfs_scrub_device"
28093 #: ../src/guestfs-actions.pod:6235
28097 " guestfs_scrub_device (guestfs_h *g,\n"
28098 " const char *device);\n"
28103 #: ../src/guestfs-actions.pod:6250 ../src/guestfs-actions.pod:6268 ../src/guestfs-actions.pod:6287
28104 msgid "(Added in 1.0.52)"
28108 #: ../src/guestfs-actions.pod:6252
28109 msgid "guestfs_scrub_file"
28113 #: ../src/guestfs-actions.pod:6254
28117 " guestfs_scrub_file (guestfs_h *g,\n"
28118 " const char *file);\n"
28123 #: ../src/guestfs-actions.pod:6270
28124 msgid "guestfs_scrub_freespace"
28128 #: ../src/guestfs-actions.pod:6272
28132 " guestfs_scrub_freespace (guestfs_h *g,\n"
28133 " const char *dir);\n"
28138 #: ../src/guestfs-actions.pod:6276
28140 "This command creates the directory C<dir> and then fills it with files until "
28141 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
28142 "and deletes them. The intention is to scrub any free space on the partition "
28143 "containing C<dir>."
28147 #: ../src/guestfs-actions.pod:6289
28148 msgid "guestfs_set_append"
28152 #: ../src/guestfs-actions.pod:6291
28156 " guestfs_set_append (guestfs_h *g,\n"
28157 " const char *append);\n"
28162 #: ../src/guestfs-actions.pod:6308
28163 msgid "guestfs_set_attach_method"
28167 #: ../src/guestfs-actions.pod:6310
28171 " guestfs_set_attach_method (guestfs_h *g,\n"
28172 " const char *attachmethod);\n"
28177 #: ../src/guestfs-actions.pod:6338
28178 msgid "guestfs_set_autosync"
28182 #: ../src/guestfs-actions.pod:6340
28186 " guestfs_set_autosync (guestfs_h *g,\n"
28187 " int autosync);\n"
28192 #: ../src/guestfs-actions.pod:6356
28193 msgid "guestfs_set_direct"
28197 #: ../src/guestfs-actions.pod:6358
28201 " guestfs_set_direct (guestfs_h *g,\n"
28207 #: ../src/guestfs-actions.pod:6366
28209 "One consequence of this is that log messages aren't caught by the library "
28210 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
28215 #: ../src/guestfs-actions.pod:6379
28216 msgid "guestfs_set_e2label"
28220 #: ../src/guestfs-actions.pod:6381
28224 " guestfs_set_e2label (guestfs_h *g,\n"
28225 " const char *device,\n"
28226 " const char *label);\n"
28231 #: ../src/guestfs-actions.pod:6390
28233 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
28234 "the existing label on a filesystem."
28238 #: ../src/guestfs-actions.pod:6397
28239 msgid "guestfs_set_e2uuid"
28243 #: ../src/guestfs-actions.pod:6399
28247 " guestfs_set_e2uuid (guestfs_h *g,\n"
28248 " const char *device,\n"
28249 " const char *uuid);\n"
28254 #: ../src/guestfs-actions.pod:6409
28256 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
28257 "the existing UUID of a filesystem."
28261 #: ../src/guestfs-actions.pod:6416
28262 msgid "guestfs_set_memsize"
28266 #: ../src/guestfs-actions.pod:6418
28270 " guestfs_set_memsize (guestfs_h *g,\n"
28276 #: ../src/guestfs-actions.pod:6422
28278 "This sets the memory size in megabytes allocated to the qemu subprocess. "
28279 "This only has any effect if called before C<guestfs_launch>."
28283 #: ../src/guestfs-actions.pod:6437
28284 msgid "guestfs_set_network"
28288 #: ../src/guestfs-actions.pod:6439
28292 " guestfs_set_network (guestfs_h *g,\n"
28298 #: ../src/guestfs-actions.pod:6449
28300 "You must call this before calling C<guestfs_launch>, otherwise it has no "
28305 #: ../src/guestfs-actions.pod:6456
28306 msgid "guestfs_set_path"
28310 #: ../src/guestfs-actions.pod:6458
28314 " guestfs_set_path (guestfs_h *g,\n"
28315 " const char *searchpath);\n"
28320 #: ../src/guestfs-actions.pod:6473
28321 msgid "guestfs_set_pgroup"
28325 #: ../src/guestfs-actions.pod:6475
28329 " guestfs_set_pgroup (guestfs_h *g,\n"
28335 #: ../src/guestfs-actions.pod:6492
28336 msgid "guestfs_set_qemu"
28340 #: ../src/guestfs-actions.pod:6494
28344 " guestfs_set_qemu (guestfs_h *g,\n"
28345 " const char *qemu);\n"
28350 #: ../src/guestfs-actions.pod:6520
28351 msgid "guestfs_set_recovery_proc"
28355 #: ../src/guestfs-actions.pod:6522
28359 " guestfs_set_recovery_proc (guestfs_h *g,\n"
28360 " int recoveryproc);\n"
28365 #: ../src/guestfs-actions.pod:6526
28367 "If this is called with the parameter C<false> then C<guestfs_launch> does "
28368 "not create a recovery process. The purpose of the recovery process is to "
28369 "stop runaway qemu processes in the case where the main program aborts "
28374 #: ../src/guestfs-actions.pod:6531
28376 "This only has any effect if called before C<guestfs_launch>, and the default "
28381 #: ../src/guestfs-actions.pod:6544
28382 msgid "guestfs_set_selinux"
28386 #: ../src/guestfs-actions.pod:6546
28390 " guestfs_set_selinux (guestfs_h *g,\n"
28396 #: ../src/guestfs-actions.pod:6563
28397 msgid "guestfs_set_smp"
28401 #: ../src/guestfs-actions.pod:6565
28405 " guestfs_set_smp (guestfs_h *g,\n"
28411 #: ../src/guestfs-actions.pod:6573
28412 msgid "This function must be called before C<guestfs_launch>."
28416 #: ../src/guestfs-actions.pod:6577
28417 msgid "guestfs_set_trace"
28421 #: ../src/guestfs-actions.pod:6579
28425 " guestfs_set_trace (guestfs_h *g,\n"
28431 #: ../src/guestfs-actions.pod:6593
28433 "Trace messages are normally sent to C<stderr>, unless you register a "
28434 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
28438 #: ../src/guestfs-actions.pod:6601
28439 msgid "guestfs_set_verbose"
28443 #: ../src/guestfs-actions.pod:6603
28447 " guestfs_set_verbose (guestfs_h *g,\n"
28453 #: ../src/guestfs-actions.pod:6612
28455 "Verbose messages are normally sent to C<stderr>, unless you register a "
28456 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
28460 #: ../src/guestfs-actions.pod:6620
28461 msgid "guestfs_setcon"
28465 #: ../src/guestfs-actions.pod:6622
28469 " guestfs_setcon (guestfs_h *g,\n"
28470 " const char *context);\n"
28475 #: ../src/guestfs-actions.pod:6635
28476 msgid "guestfs_setxattr"
28480 #: ../src/guestfs-actions.pod:6637
28484 " guestfs_setxattr (guestfs_h *g,\n"
28485 " const char *xattr,\n"
28486 " const char *val,\n"
28488 " const char *path);\n"
28493 #: ../src/guestfs-actions.pod:6648
28494 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
28498 #: ../src/guestfs-actions.pod:6654
28499 msgid "guestfs_sfdisk"
28503 #: ../src/guestfs-actions.pod:6656
28507 " guestfs_sfdisk (guestfs_h *g,\n"
28508 " const char *device,\n"
28512 " char *const *lines);\n"
28517 #: ../src/guestfs-actions.pod:6664 ../src/guestfs-actions.pod:6708 ../src/guestfs-actions.pod:6742
28519 "I<This function is deprecated.> In new code, use the L</guestfs_part_add> "
28524 #: ../src/guestfs-actions.pod:6691
28525 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
28529 #: ../src/guestfs-actions.pod:6701
28530 msgid "guestfs_sfdiskM"
28534 #: ../src/guestfs-actions.pod:6703
28538 " guestfs_sfdiskM (guestfs_h *g,\n"
28539 " const char *device,\n"
28540 " char *const *lines);\n"
28545 #: ../src/guestfs-actions.pod:6715
28547 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
28548 "partition sizes are specified in megabytes only (rounded to the nearest "
28549 "cylinder) and you don't need to specify the cyls, heads and sectors "
28550 "parameters which were rarely if ever used anyway."
28554 #: ../src/guestfs-actions.pod:6721
28556 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
28557 "C<guestfs_part_disk>"
28561 #: ../src/guestfs-actions.pod:6731
28562 msgid "guestfs_sfdisk_N"
28566 #: ../src/guestfs-actions.pod:6733
28570 " guestfs_sfdisk_N (guestfs_h *g,\n"
28571 " const char *device,\n"
28576 " const char *line);\n"
28581 #: ../src/guestfs-actions.pod:6752
28583 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
28584 "for the cyls/heads/sectors parameters."
28588 #: ../src/guestfs-actions.pod:6755
28589 msgid "See also: C<guestfs_part_add>"
28593 #: ../src/guestfs-actions.pod:6764
28594 msgid "guestfs_sfdisk_disk_geometry"
28598 #: ../src/guestfs-actions.pod:6766
28602 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
28603 " const char *device);\n"
28608 #: ../src/guestfs-actions.pod:6770
28610 "This displays the disk geometry of C<device> read from the partition table. "
28611 "Especially in the case where the underlying block device has been resized, "
28612 "this can be different from the kernel's idea of the geometry (see "
28613 "C<guestfs_sfdisk_kernel_geometry>)."
28617 #: ../src/guestfs-actions.pod:6783
28618 msgid "guestfs_sfdisk_kernel_geometry"
28622 #: ../src/guestfs-actions.pod:6785
28626 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
28627 " const char *device);\n"
28632 #: ../src/guestfs-actions.pod:6799
28633 msgid "guestfs_sfdisk_l"
28637 #: ../src/guestfs-actions.pod:6801
28641 " guestfs_sfdisk_l (guestfs_h *g,\n"
28642 " const char *device);\n"
28647 #: ../src/guestfs-actions.pod:6805
28649 "I<This function is deprecated.> In new code, use the L</guestfs_part_list> "
28654 #: ../src/guestfs-actions.pod:6816
28655 msgid "See also: C<guestfs_part_list>"
28659 #: ../src/guestfs-actions.pod:6823
28664 #: ../src/guestfs-actions.pod:6825
28668 " guestfs_sh (guestfs_h *g,\n"
28669 " const char *command);\n"
28674 #: ../src/guestfs-actions.pod:6832
28675 msgid "This is like C<guestfs_command>, but passes the command to:"
28679 #: ../src/guestfs-actions.pod:6840
28680 msgid "All the provisos about C<guestfs_command> apply to this call."
28684 #: ../src/guestfs-actions.pod:6847
28685 msgid "guestfs_sh_lines"
28689 #: ../src/guestfs-actions.pod:6849
28693 " guestfs_sh_lines (guestfs_h *g,\n"
28694 " const char *command);\n"
28699 #: ../src/guestfs-actions.pod:6853
28701 "This is the same as C<guestfs_sh>, but splits the result into a list of "
28706 #: ../src/guestfs-actions.pod:6856
28707 msgid "See also: C<guestfs_command_lines>"
28711 #: ../src/guestfs-actions.pod:6864
28712 msgid "guestfs_sleep"
28716 #: ../src/guestfs-actions.pod:6866
28720 " guestfs_sleep (guestfs_h *g,\n"
28726 #: ../src/guestfs-actions.pod:6874
28727 msgid "(Added in 1.0.41)"
28731 #: ../src/guestfs-actions.pod:6876 ../src/guestfs-structs.pod:109
28732 msgid "guestfs_stat"
28736 #: ../src/guestfs-actions.pod:6878
28739 " struct guestfs_stat *\n"
28740 " guestfs_stat (guestfs_h *g,\n"
28741 " const char *path);\n"
28746 #: ../src/guestfs-actions.pod:6892 ../src/guestfs-structs.pod:135
28747 msgid "guestfs_statvfs"
28751 #: ../src/guestfs-actions.pod:6894
28754 " struct guestfs_statvfs *\n"
28755 " guestfs_statvfs (guestfs_h *g,\n"
28756 " const char *path);\n"
28761 #: ../src/guestfs-actions.pod:6904
28763 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
28764 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
28768 #: ../src/guestfs-actions.pod:6910
28769 msgid "guestfs_strings"
28773 #: ../src/guestfs-actions.pod:6912
28777 " guestfs_strings (guestfs_h *g,\n"
28778 " const char *path);\n"
28783 #: ../src/guestfs-actions.pod:6928
28784 msgid "guestfs_strings_e"
28788 #: ../src/guestfs-actions.pod:6930
28792 " guestfs_strings_e (guestfs_h *g,\n"
28793 " const char *encoding,\n"
28794 " const char *path);\n"
28799 #: ../src/guestfs-actions.pod:6935
28801 "This is like the C<guestfs_strings> command, but allows you to specify the "
28802 "encoding of strings that are looked for in the source file C<path>."
28806 #: ../src/guestfs-actions.pod:6945
28808 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
28809 "ISO-8859-X (this is what C<guestfs_strings> uses)."
28813 #: ../src/guestfs-actions.pod:6983
28814 msgid "guestfs_swapoff_device"
28818 #: ../src/guestfs-actions.pod:6985
28822 " guestfs_swapoff_device (guestfs_h *g,\n"
28823 " const char *device);\n"
28828 #: ../src/guestfs-actions.pod:6989
28830 "This command disables the libguestfs appliance swap device or partition "
28831 "named C<device>. See C<guestfs_swapon_device>."
28835 #: ../src/guestfs-actions.pod:6997
28836 msgid "guestfs_swapoff_file"
28840 #: ../src/guestfs-actions.pod:6999
28844 " guestfs_swapoff_file (guestfs_h *g,\n"
28845 " const char *file);\n"
28850 #: ../src/guestfs-actions.pod:7009
28851 msgid "guestfs_swapoff_label"
28855 #: ../src/guestfs-actions.pod:7011
28859 " guestfs_swapoff_label (guestfs_h *g,\n"
28860 " const char *label);\n"
28865 #: ../src/guestfs-actions.pod:7022
28866 msgid "guestfs_swapoff_uuid"
28870 #: ../src/guestfs-actions.pod:7024
28874 " guestfs_swapoff_uuid (guestfs_h *g,\n"
28875 " const char *uuid);\n"
28880 #: ../src/guestfs-actions.pod:7035
28881 msgid "guestfs_swapon_device"
28885 #: ../src/guestfs-actions.pod:7037
28889 " guestfs_swapon_device (guestfs_h *g,\n"
28890 " const char *device);\n"
28895 #: ../src/guestfs-actions.pod:7041
28897 "This command enables the libguestfs appliance to use the swap device or "
28898 "partition named C<device>. The increased memory is made available for all "
28899 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
28903 #: ../src/guestfs-actions.pod:7057
28904 msgid "guestfs_swapon_file"
28908 #: ../src/guestfs-actions.pod:7059
28912 " guestfs_swapon_file (guestfs_h *g,\n"
28913 " const char *file);\n"
28918 #: ../src/guestfs-actions.pod:7063
28920 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
28925 #: ../src/guestfs-actions.pod:7070
28926 msgid "guestfs_swapon_label"
28930 #: ../src/guestfs-actions.pod:7072
28934 " guestfs_swapon_label (guestfs_h *g,\n"
28935 " const char *label);\n"
28940 #: ../src/guestfs-actions.pod:7076
28942 "This command enables swap to a labeled swap partition. See "
28943 "C<guestfs_swapon_device> for other notes."
28947 #: ../src/guestfs-actions.pod:7083
28948 msgid "guestfs_swapon_uuid"
28952 #: ../src/guestfs-actions.pod:7085
28956 " guestfs_swapon_uuid (guestfs_h *g,\n"
28957 " const char *uuid);\n"
28962 #: ../src/guestfs-actions.pod:7089
28964 "This command enables swap to a swap partition with the given UUID. See "
28965 "C<guestfs_swapon_device> for other notes."
28969 #: ../src/guestfs-actions.pod:7096
28970 msgid "guestfs_sync"
28974 #: ../src/guestfs-actions.pod:7098
28978 " guestfs_sync (guestfs_h *g);\n"
28983 #: ../src/guestfs-actions.pod:7111
28984 msgid "guestfs_tail"
28988 #: ../src/guestfs-actions.pod:7113
28992 " guestfs_tail (guestfs_h *g,\n"
28993 " const char *path);\n"
28998 #: ../src/guestfs-actions.pod:7129
28999 msgid "guestfs_tail_n"
29003 #: ../src/guestfs-actions.pod:7131
29007 " guestfs_tail_n (guestfs_h *g,\n"
29009 " const char *path);\n"
29014 #: ../src/guestfs-actions.pod:7153
29015 msgid "guestfs_tar_in"
29019 #: ../src/guestfs-actions.pod:7155
29023 " guestfs_tar_in (guestfs_h *g,\n"
29024 " const char *tarfile,\n"
29025 " const char *directory);\n"
29030 #: ../src/guestfs-actions.pod:7163
29031 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
29035 #: ../src/guestfs-actions.pod:7168 ../src/guestfs-actions.pod:7185 ../src/guestfs-actions.pod:7201 ../src/guestfs-actions.pod:7217
29036 msgid "(Added in 1.0.3)"
29040 #: ../src/guestfs-actions.pod:7170
29041 msgid "guestfs_tar_out"
29045 #: ../src/guestfs-actions.pod:7172
29049 " guestfs_tar_out (guestfs_h *g,\n"
29050 " const char *directory,\n"
29051 " const char *tarfile);\n"
29056 #: ../src/guestfs-actions.pod:7180
29058 "To download a compressed tarball, use C<guestfs_tgz_out> or "
29059 "C<guestfs_txz_out>."
29063 #: ../src/guestfs-actions.pod:7187
29064 msgid "guestfs_tgz_in"
29068 #: ../src/guestfs-actions.pod:7189
29072 " guestfs_tgz_in (guestfs_h *g,\n"
29073 " const char *tarball,\n"
29074 " const char *directory);\n"
29079 #: ../src/guestfs-actions.pod:7197
29080 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
29084 #: ../src/guestfs-actions.pod:7203
29085 msgid "guestfs_tgz_out"
29089 #: ../src/guestfs-actions.pod:7205
29093 " guestfs_tgz_out (guestfs_h *g,\n"
29094 " const char *directory,\n"
29095 " const char *tarball);\n"
29100 #: ../src/guestfs-actions.pod:7213
29101 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
29105 #: ../src/guestfs-actions.pod:7219
29106 msgid "guestfs_touch"
29110 #: ../src/guestfs-actions.pod:7221
29114 " guestfs_touch (guestfs_h *g,\n"
29115 " const char *path);\n"
29120 #: ../src/guestfs-actions.pod:7236
29121 msgid "guestfs_truncate"
29125 #: ../src/guestfs-actions.pod:7238
29129 " guestfs_truncate (guestfs_h *g,\n"
29130 " const char *path);\n"
29135 #: ../src/guestfs-actions.pod:7249
29136 msgid "guestfs_truncate_size"
29140 #: ../src/guestfs-actions.pod:7251
29144 " guestfs_truncate_size (guestfs_h *g,\n"
29145 " const char *path,\n"
29146 " int64_t size);\n"
29151 #: ../src/guestfs-actions.pod:7259
29153 "If the current file size is less than C<size> then the file is extended to "
29154 "the required size with zero bytes. This creates a sparse file (ie. disk "
29155 "blocks are not allocated for the file until you write to it). To create a "
29156 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
29160 #: ../src/guestfs-actions.pod:7269
29161 msgid "guestfs_tune2fs_l"
29165 #: ../src/guestfs-actions.pod:7271
29169 " guestfs_tune2fs_l (guestfs_h *g,\n"
29170 " const char *device);\n"
29175 #: ../src/guestfs-actions.pod:7291
29176 msgid "guestfs_txz_in"
29180 #: ../src/guestfs-actions.pod:7293
29184 " guestfs_txz_in (guestfs_h *g,\n"
29185 " const char *tarball,\n"
29186 " const char *directory);\n"
29191 #: ../src/guestfs-actions.pod:7305
29192 msgid "guestfs_txz_out"
29196 #: ../src/guestfs-actions.pod:7307
29200 " guestfs_txz_out (guestfs_h *g,\n"
29201 " const char *directory,\n"
29202 " const char *tarball);\n"
29207 #: ../src/guestfs-actions.pod:7319
29208 msgid "guestfs_umask"
29212 #: ../src/guestfs-actions.pod:7321
29216 " guestfs_umask (guestfs_h *g,\n"
29222 #: ../src/guestfs-actions.pod:7337
29224 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
29225 "C<guestfs_mkdir>."
29229 #: ../src/guestfs-actions.pod:7346
29230 msgid "guestfs_umount"
29234 #: ../src/guestfs-actions.pod:7348
29238 " guestfs_umount (guestfs_h *g,\n"
29239 " const char *pathordevice);\n"
29244 #: ../src/guestfs-actions.pod:7360
29245 msgid "guestfs_umount_all"
29249 #: ../src/guestfs-actions.pod:7362
29253 " guestfs_umount_all (guestfs_h *g);\n"
29258 #: ../src/guestfs-actions.pod:7373
29259 msgid "guestfs_upload"
29263 #: ../src/guestfs-actions.pod:7375
29267 " guestfs_upload (guestfs_h *g,\n"
29268 " const char *filename,\n"
29269 " const char *remotefilename);\n"
29274 #: ../src/guestfs-actions.pod:7385
29275 msgid "See also C<guestfs_download>."
29279 #: ../src/guestfs-actions.pod:7396
29280 msgid "guestfs_upload_offset"
29284 #: ../src/guestfs-actions.pod:7398
29288 " guestfs_upload_offset (guestfs_h *g,\n"
29289 " const char *filename,\n"
29290 " const char *remotefilename,\n"
29291 " int64_t offset);\n"
29296 #: ../src/guestfs-actions.pod:7414
29298 "Note that there is no limit on the amount of data that can be uploaded with "
29299 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
29300 "full amount unless an error occurs."
29304 #: ../src/guestfs-actions.pod:7419
29305 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
29309 #: ../src/guestfs-actions.pod:7430
29310 msgid "guestfs_utimens"
29314 #: ../src/guestfs-actions.pod:7432
29318 " guestfs_utimens (guestfs_h *g,\n"
29319 " const char *path,\n"
29320 " int64_t atsecs,\n"
29321 " int64_t atnsecs,\n"
29322 " int64_t mtsecs,\n"
29323 " int64_t mtnsecs);\n"
29328 #: ../src/guestfs-actions.pod:7461 ../src/guestfs-structs.pod:175
29329 msgid "guestfs_version"
29333 #: ../src/guestfs-actions.pod:7463
29336 " struct guestfs_version *\n"
29337 " guestfs_version (guestfs_h *g);\n"
29342 #: ../src/guestfs-actions.pod:7491
29344 "I<Note:> Don't use this call to test for availability of features. In "
29345 "enterprise distributions we backport features from later versions into "
29346 "earlier versions, making this an unreliable way to test for features. Use "
29347 "C<guestfs_available> instead."
29351 #: ../src/guestfs-actions.pod:7497
29353 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
29354 "error. I<The caller must call C<guestfs_free_version> after use>."
29358 #: ../src/guestfs-actions.pod:7501
29359 msgid "(Added in 1.0.58)"
29363 #: ../src/guestfs-actions.pod:7503
29364 msgid "guestfs_vfs_label"
29368 #: ../src/guestfs-actions.pod:7505
29372 " guestfs_vfs_label (guestfs_h *g,\n"
29373 " const char *device);\n"
29378 #: ../src/guestfs-actions.pod:7514
29379 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
29383 #: ../src/guestfs-actions.pod:7519 ../src/guestfs-actions.pod:7556
29384 msgid "(Added in 1.3.18)"
29388 #: ../src/guestfs-actions.pod:7521
29389 msgid "guestfs_vfs_type"
29393 #: ../src/guestfs-actions.pod:7523
29397 " guestfs_vfs_type (guestfs_h *g,\n"
29398 " const char *device);\n"
29403 #: ../src/guestfs-actions.pod:7540
29404 msgid "guestfs_vfs_uuid"
29408 #: ../src/guestfs-actions.pod:7542
29412 " guestfs_vfs_uuid (guestfs_h *g,\n"
29413 " const char *device);\n"
29418 #: ../src/guestfs-actions.pod:7551
29419 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
29423 #: ../src/guestfs-actions.pod:7558
29424 msgid "guestfs_vg_activate"
29428 #: ../src/guestfs-actions.pod:7560
29432 " guestfs_vg_activate (guestfs_h *g,\n"
29434 " char *const *volgroups);\n"
29439 #: ../src/guestfs-actions.pod:7577
29440 msgid "guestfs_vg_activate_all"
29444 #: ../src/guestfs-actions.pod:7579
29448 " guestfs_vg_activate_all (guestfs_h *g,\n"
29449 " int activate);\n"
29454 #: ../src/guestfs-actions.pod:7592
29455 msgid "guestfs_vgcreate"
29459 #: ../src/guestfs-actions.pod:7594
29463 " guestfs_vgcreate (guestfs_h *g,\n"
29464 " const char *volgroup,\n"
29465 " char *const *physvols);\n"
29470 #: ../src/guestfs-actions.pod:7606
29471 msgid "guestfs_vglvuuids"
29475 #: ../src/guestfs-actions.pod:7608
29479 " guestfs_vglvuuids (guestfs_h *g,\n"
29480 " const char *vgname);\n"
29485 #: ../src/guestfs-actions.pod:7615
29487 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
29488 "associate logical volumes and volume groups."
29492 #: ../src/guestfs-actions.pod:7618
29493 msgid "See also C<guestfs_vgpvuuids>."
29497 #: ../src/guestfs-actions.pod:7626
29498 msgid "guestfs_vgpvuuids"
29502 #: ../src/guestfs-actions.pod:7628
29506 " guestfs_vgpvuuids (guestfs_h *g,\n"
29507 " const char *vgname);\n"
29512 #: ../src/guestfs-actions.pod:7635
29514 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
29515 "associate physical volumes and volume groups."
29519 #: ../src/guestfs-actions.pod:7638
29520 msgid "See also C<guestfs_vglvuuids>."
29524 #: ../src/guestfs-actions.pod:7646
29525 msgid "guestfs_vgremove"
29529 #: ../src/guestfs-actions.pod:7648
29533 " guestfs_vgremove (guestfs_h *g,\n"
29534 " const char *vgname);\n"
29539 #: ../src/guestfs-actions.pod:7661
29540 msgid "guestfs_vgrename"
29544 #: ../src/guestfs-actions.pod:7663
29548 " guestfs_vgrename (guestfs_h *g,\n"
29549 " const char *volgroup,\n"
29550 " const char *newvolgroup);\n"
29555 #: ../src/guestfs-actions.pod:7674
29556 msgid "guestfs_vgs"
29560 #: ../src/guestfs-actions.pod:7676
29564 " guestfs_vgs (guestfs_h *g);\n"
29569 #: ../src/guestfs-actions.pod:7685
29570 msgid "See also C<guestfs_vgs_full>."
29574 #: ../src/guestfs-actions.pod:7693
29575 msgid "guestfs_vgs_full"
29579 #: ../src/guestfs-actions.pod:7695
29582 " struct guestfs_lvm_vg_list *\n"
29583 " guestfs_vgs_full (guestfs_h *g);\n"
29588 #: ../src/guestfs-actions.pod:7701
29590 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
29591 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
29596 #: ../src/guestfs-actions.pod:7707
29597 msgid "guestfs_vgscan"
29601 #: ../src/guestfs-actions.pod:7709
29605 " guestfs_vgscan (guestfs_h *g);\n"
29610 #: ../src/guestfs-actions.pod:7719
29611 msgid "guestfs_vguuid"
29615 #: ../src/guestfs-actions.pod:7721
29619 " guestfs_vguuid (guestfs_h *g,\n"
29620 " const char *vgname);\n"
29625 #: ../src/guestfs-actions.pod:7732
29626 msgid "guestfs_wait_ready"
29630 #: ../src/guestfs-actions.pod:7734
29634 " guestfs_wait_ready (guestfs_h *g);\n"
29639 #: ../src/guestfs-actions.pod:7737
29641 "I<This function is deprecated.> In new code, use the L</guestfs_launch> call "
29646 #: ../src/guestfs-actions.pod:7744
29647 msgid "This function is a no op."
29651 #: ../src/guestfs-actions.pod:7746
29653 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
29654 "calling C<guestfs_launch> to wait for the launch to complete. However this "
29655 "is no longer necessary because C<guestfs_launch> now does the waiting."
29659 #: ../src/guestfs-actions.pod:7751
29661 "If you see any calls to this function in code then you can just remove them, "
29662 "unless you want to retain compatibility with older versions of the API."
29666 #: ../src/guestfs-actions.pod:7759
29667 msgid "guestfs_wc_c"
29671 #: ../src/guestfs-actions.pod:7761
29675 " guestfs_wc_c (guestfs_h *g,\n"
29676 " const char *path);\n"
29681 #: ../src/guestfs-actions.pod:7772
29682 msgid "guestfs_wc_l"
29686 #: ../src/guestfs-actions.pod:7774
29690 " guestfs_wc_l (guestfs_h *g,\n"
29691 " const char *path);\n"
29696 #: ../src/guestfs-actions.pod:7785
29697 msgid "guestfs_wc_w"
29701 #: ../src/guestfs-actions.pod:7787
29705 " guestfs_wc_w (guestfs_h *g,\n"
29706 " const char *path);\n"
29711 #: ../src/guestfs-actions.pod:7798
29712 msgid "guestfs_write"
29716 #: ../src/guestfs-actions.pod:7800
29720 " guestfs_write (guestfs_h *g,\n"
29721 " const char *path,\n"
29722 " const char *content,\n"
29723 " size_t content_size);\n"
29728 #: ../src/guestfs-actions.pod:7809
29729 msgid "See also C<guestfs_write_append>."
29733 #: ../src/guestfs-actions.pod:7818
29734 msgid "guestfs_write_append"
29738 #: ../src/guestfs-actions.pod:7820
29742 " guestfs_write_append (guestfs_h *g,\n"
29743 " const char *path,\n"
29744 " const char *content,\n"
29745 " size_t content_size);\n"
29750 #: ../src/guestfs-actions.pod:7829
29751 msgid "See also C<guestfs_write>."
29755 #: ../src/guestfs-actions.pod:7838
29756 msgid "guestfs_write_file"
29760 #: ../src/guestfs-actions.pod:7840
29764 " guestfs_write_file (guestfs_h *g,\n"
29765 " const char *path,\n"
29766 " const char *content,\n"
29772 #: ../src/guestfs-actions.pod:7846
29774 "I<This function is deprecated.> In new code, use the L</guestfs_write> call "
29779 #: ../src/guestfs-actions.pod:7871
29780 msgid "guestfs_zegrep"
29784 #: ../src/guestfs-actions.pod:7873
29788 " guestfs_zegrep (guestfs_h *g,\n"
29789 " const char *regex,\n"
29790 " const char *path);\n"
29795 #: ../src/guestfs-actions.pod:7890
29796 msgid "guestfs_zegrepi"
29800 #: ../src/guestfs-actions.pod:7892
29804 " guestfs_zegrepi (guestfs_h *g,\n"
29805 " const char *regex,\n"
29806 " const char *path);\n"
29811 #: ../src/guestfs-actions.pod:7909
29812 msgid "guestfs_zero"
29816 #: ../src/guestfs-actions.pod:7911
29820 " guestfs_zero (guestfs_h *g,\n"
29821 " const char *device);\n"
29826 #: ../src/guestfs-actions.pod:7925
29828 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
29829 "C<guestfs_is_zero_device>"
29833 #: ../src/guestfs-actions.pod:7937
29834 msgid "guestfs_zero_device"
29838 #: ../src/guestfs-actions.pod:7939
29842 " guestfs_zero_device (guestfs_h *g,\n"
29843 " const char *device);\n"
29848 #: ../src/guestfs-actions.pod:7943
29850 "This command writes zeroes over the entire C<device>. Compare with "
29851 "C<guestfs_zero> which just zeroes the first few blocks of a device."
29855 #: ../src/guestfs-actions.pod:7961
29856 msgid "(Added in 1.3.1)"
29860 #: ../src/guestfs-actions.pod:7963
29861 msgid "guestfs_zerofree"
29865 #: ../src/guestfs-actions.pod:7965
29869 " guestfs_zerofree (guestfs_h *g,\n"
29870 " const char *device);\n"
29875 #: ../src/guestfs-actions.pod:7984
29876 msgid "guestfs_zfgrep"
29880 #: ../src/guestfs-actions.pod:7986
29884 " guestfs_zfgrep (guestfs_h *g,\n"
29885 " const char *pattern,\n"
29886 " const char *path);\n"
29891 #: ../src/guestfs-actions.pod:8003
29892 msgid "guestfs_zfgrepi"
29896 #: ../src/guestfs-actions.pod:8005
29900 " guestfs_zfgrepi (guestfs_h *g,\n"
29901 " const char *pattern,\n"
29902 " const char *path);\n"
29907 #: ../src/guestfs-actions.pod:8022
29908 msgid "guestfs_zfile"
29912 #: ../src/guestfs-actions.pod:8024
29916 " guestfs_zfile (guestfs_h *g,\n"
29917 " const char *meth,\n"
29918 " const char *path);\n"
29923 #: ../src/guestfs-actions.pod:8029
29925 "I<This function is deprecated.> In new code, use the L</guestfs_file> call "
29930 #: ../src/guestfs-actions.pod:8041
29932 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
29937 #: ../src/guestfs-actions.pod:8049
29938 msgid "guestfs_zgrep"
29942 #: ../src/guestfs-actions.pod:8051
29946 " guestfs_zgrep (guestfs_h *g,\n"
29947 " const char *regex,\n"
29948 " const char *path);\n"
29953 #: ../src/guestfs-actions.pod:8068
29954 msgid "guestfs_zgrepi"
29958 #: ../src/guestfs-actions.pod:8070
29962 " guestfs_zgrepi (guestfs_h *g,\n"
29963 " const char *regex,\n"
29964 " const char *path);\n"
29969 #: ../src/guestfs-availability.pod:3
29974 #: ../src/guestfs-availability.pod:5
29976 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
29977 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
29978 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
29979 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
29980 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
29984 #: ../src/guestfs-availability.pod:21
29989 #: ../src/guestfs-availability.pod:23
29990 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
29994 #: ../src/guestfs-availability.pod:26
29999 #: ../src/guestfs-availability.pod:28
30000 msgid "The following functions: L</guestfs_grub_install>"
30004 #: ../src/guestfs-availability.pod:31
30009 #: ../src/guestfs-availability.pod:33
30011 "The following functions: L</guestfs_inotify_add_watch> "
30012 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
30013 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
30017 #: ../src/guestfs-availability.pod:41
30018 msgid "B<linuxfsuuid>"
30022 #: ../src/guestfs-availability.pod:43
30024 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
30025 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
30029 #: ../src/guestfs-availability.pod:50
30030 msgid "B<linuxmodules>"
30034 #: ../src/guestfs-availability.pod:52
30035 msgid "The following functions: L</guestfs_modprobe>"
30039 #: ../src/guestfs-availability.pod:55
30040 msgid "B<linuxxattrs>"
30044 #: ../src/guestfs-availability.pod:57
30046 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
30047 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
30048 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
30049 "L</guestfs_setxattr>"
30053 #: ../src/guestfs-availability.pod:68
30058 #: ../src/guestfs-availability.pod:70
30060 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
30061 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
30062 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
30066 #: ../src/guestfs-availability.pod:79
30071 #: ../src/guestfs-availability.pod:81
30073 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
30074 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
30075 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
30076 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
30077 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
30078 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
30079 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
30080 "L</guestfs_vgs_full>"
30084 #: ../src/guestfs-availability.pod:104
30089 #: ../src/guestfs-availability.pod:106
30091 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
30092 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
30096 #: ../src/guestfs-availability.pod:112
30101 #: ../src/guestfs-availability.pod:114
30102 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
30106 #: ../src/guestfs-availability.pod:117
30107 msgid "B<ntfsprogs>"
30111 #: ../src/guestfs-availability.pod:119
30113 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
30114 "L</guestfs_ntfsresize_size>"
30118 #: ../src/guestfs-availability.pod:124
30119 msgid "B<realpath>"
30123 #: ../src/guestfs-availability.pod:126
30124 msgid "The following functions: L</guestfs_realpath>"
30128 #: ../src/guestfs-availability.pod:129
30133 #: ../src/guestfs-availability.pod:131
30135 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
30136 "L</guestfs_scrub_freespace>"
30140 #: ../src/guestfs-availability.pod:136
30145 #: ../src/guestfs-availability.pod:138
30146 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
30150 #: ../src/guestfs-availability.pod:142
30155 #: ../src/guestfs-availability.pod:144
30156 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
30160 #: ../src/guestfs-availability.pod:148
30161 msgid "B<zerofree>"
30165 #: ../src/guestfs-availability.pod:150
30166 msgid "The following functions: L</guestfs_zerofree>"
30170 #: ../src/guestfs-structs.pod:1
30171 msgid "guestfs_int_bool"
30175 #: ../src/guestfs-structs.pod:3
30178 " struct guestfs_int_bool {\n"
30186 #: ../src/guestfs-structs.pod:8
30189 " struct guestfs_int_bool_list {\n"
30190 " uint32_t len; /* Number of elements in list. */\n"
30191 " struct guestfs_int_bool *val; /* Elements. */\n"
30197 #: ../src/guestfs-structs.pod:13
30200 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
30201 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
30206 #: ../src/guestfs-structs.pod:16
30207 msgid "guestfs_lvm_pv"
30211 #: ../src/guestfs-structs.pod:18
30214 " struct guestfs_lvm_pv {\n"
30215 " char *pv_name;\n"
30216 " /* The next field is NOT nul-terminated, be careful when printing it: "
30218 " char pv_uuid[32];\n"
30220 " uint64_t pv_size;\n"
30221 " uint64_t dev_size;\n"
30222 " uint64_t pv_free;\n"
30223 " uint64_t pv_used;\n"
30224 " char *pv_attr;\n"
30225 " int64_t pv_pe_count;\n"
30226 " int64_t pv_pe_alloc_count;\n"
30227 " char *pv_tags;\n"
30228 " uint64_t pe_start;\n"
30229 " int64_t pv_mda_count;\n"
30230 " uint64_t pv_mda_free;\n"
30236 #: ../src/guestfs-structs.pod:36
30239 " struct guestfs_lvm_pv_list {\n"
30240 " uint32_t len; /* Number of elements in list. */\n"
30241 " struct guestfs_lvm_pv *val; /* Elements. */\n"
30247 #: ../src/guestfs-structs.pod:41
30250 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
30251 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
30256 #: ../src/guestfs-structs.pod:44
30257 msgid "guestfs_lvm_vg"
30261 #: ../src/guestfs-structs.pod:46
30264 " struct guestfs_lvm_vg {\n"
30265 " char *vg_name;\n"
30266 " /* The next field is NOT nul-terminated, be careful when printing it: "
30268 " char vg_uuid[32];\n"
30270 " char *vg_attr;\n"
30271 " uint64_t vg_size;\n"
30272 " uint64_t vg_free;\n"
30273 " char *vg_sysid;\n"
30274 " uint64_t vg_extent_size;\n"
30275 " int64_t vg_extent_count;\n"
30276 " int64_t vg_free_count;\n"
30277 " int64_t max_lv;\n"
30278 " int64_t max_pv;\n"
30279 " int64_t pv_count;\n"
30280 " int64_t lv_count;\n"
30281 " int64_t snap_count;\n"
30282 " int64_t vg_seqno;\n"
30283 " char *vg_tags;\n"
30284 " int64_t vg_mda_count;\n"
30285 " uint64_t vg_mda_free;\n"
30291 #: ../src/guestfs-structs.pod:69
30294 " struct guestfs_lvm_vg_list {\n"
30295 " uint32_t len; /* Number of elements in list. */\n"
30296 " struct guestfs_lvm_vg *val; /* Elements. */\n"
30302 #: ../src/guestfs-structs.pod:74
30305 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
30306 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
30311 #: ../src/guestfs-structs.pod:77
30312 msgid "guestfs_lvm_lv"
30316 #: ../src/guestfs-structs.pod:79
30319 " struct guestfs_lvm_lv {\n"
30320 " char *lv_name;\n"
30321 " /* The next field is NOT nul-terminated, be careful when printing it: "
30323 " char lv_uuid[32];\n"
30324 " char *lv_attr;\n"
30325 " int64_t lv_major;\n"
30326 " int64_t lv_minor;\n"
30327 " int64_t lv_kernel_major;\n"
30328 " int64_t lv_kernel_minor;\n"
30329 " uint64_t lv_size;\n"
30330 " int64_t seg_count;\n"
30332 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
30333 " float snap_percent;\n"
30334 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
30335 " float copy_percent;\n"
30336 " char *move_pv;\n"
30337 " char *lv_tags;\n"
30338 " char *mirror_log;\n"
30339 " char *modules;\n"
30345 #: ../src/guestfs-structs.pod:101
30348 " struct guestfs_lvm_lv_list {\n"
30349 " uint32_t len; /* Number of elements in list. */\n"
30350 " struct guestfs_lvm_lv *val; /* Elements. */\n"
30356 #: ../src/guestfs-structs.pod:106
30359 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
30360 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
30365 #: ../src/guestfs-structs.pod:111
30368 " struct guestfs_stat {\n"
30372 " int64_t nlink;\n"
30377 " int64_t blksize;\n"
30378 " int64_t blocks;\n"
30379 " int64_t atime;\n"
30380 " int64_t mtime;\n"
30381 " int64_t ctime;\n"
30387 #: ../src/guestfs-structs.pod:127
30390 " struct guestfs_stat_list {\n"
30391 " uint32_t len; /* Number of elements in list. */\n"
30392 " struct guestfs_stat *val; /* Elements. */\n"
30398 #: ../src/guestfs-structs.pod:132
30401 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
30402 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
30407 #: ../src/guestfs-structs.pod:137
30410 " struct guestfs_statvfs {\n"
30411 " int64_t bsize;\n"
30412 " int64_t frsize;\n"
30413 " int64_t blocks;\n"
30414 " int64_t bfree;\n"
30415 " int64_t bavail;\n"
30416 " int64_t files;\n"
30417 " int64_t ffree;\n"
30418 " int64_t favail;\n"
30421 " int64_t namemax;\n"
30427 #: ../src/guestfs-structs.pod:151
30430 " struct guestfs_statvfs_list {\n"
30431 " uint32_t len; /* Number of elements in list. */\n"
30432 " struct guestfs_statvfs *val; /* Elements. */\n"
30438 #: ../src/guestfs-structs.pod:156
30441 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
30442 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
30447 #: ../src/guestfs-structs.pod:159
30448 msgid "guestfs_dirent"
30452 #: ../src/guestfs-structs.pod:161
30455 " struct guestfs_dirent {\n"
30464 #: ../src/guestfs-structs.pod:167
30467 " struct guestfs_dirent_list {\n"
30468 " uint32_t len; /* Number of elements in list. */\n"
30469 " struct guestfs_dirent *val; /* Elements. */\n"
30475 #: ../src/guestfs-structs.pod:172
30478 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
30479 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
30484 #: ../src/guestfs-structs.pod:177
30487 " struct guestfs_version {\n"
30488 " int64_t major;\n"
30489 " int64_t minor;\n"
30490 " int64_t release;\n"
30497 #: ../src/guestfs-structs.pod:184
30500 " struct guestfs_version_list {\n"
30501 " uint32_t len; /* Number of elements in list. */\n"
30502 " struct guestfs_version *val; /* Elements. */\n"
30508 #: ../src/guestfs-structs.pod:189
30511 " void guestfs_free_version (struct guestfs_free_version *);\n"
30512 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
30517 #: ../src/guestfs-structs.pod:192
30518 msgid "guestfs_xattr"
30522 #: ../src/guestfs-structs.pod:194
30525 " struct guestfs_xattr {\n"
30526 " char *attrname;\n"
30527 " /* The next two fields describe a byte array. */\n"
30528 " uint32_t attrval_len;\n"
30529 " char *attrval;\n"
30535 #: ../src/guestfs-structs.pod:201
30538 " struct guestfs_xattr_list {\n"
30539 " uint32_t len; /* Number of elements in list. */\n"
30540 " struct guestfs_xattr *val; /* Elements. */\n"
30546 #: ../src/guestfs-structs.pod:206
30549 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
30550 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
30555 #: ../src/guestfs-structs.pod:209
30556 msgid "guestfs_inotify_event"
30560 #: ../src/guestfs-structs.pod:211
30563 " struct guestfs_inotify_event {\n"
30564 " int64_t in_wd;\n"
30565 " uint32_t in_mask;\n"
30566 " uint32_t in_cookie;\n"
30567 " char *in_name;\n"
30573 #: ../src/guestfs-structs.pod:218
30576 " struct guestfs_inotify_event_list {\n"
30577 " uint32_t len; /* Number of elements in list. */\n"
30578 " struct guestfs_inotify_event *val; /* Elements. */\n"
30584 #: ../src/guestfs-structs.pod:223
30587 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
30588 " void guestfs_free_inotify_event_list (struct "
30589 "guestfs_free_inotify_event_list *);\n"
30594 #: ../src/guestfs-structs.pod:226
30595 msgid "guestfs_partition"
30599 #: ../src/guestfs-structs.pod:228
30602 " struct guestfs_partition {\n"
30603 " int32_t part_num;\n"
30604 " uint64_t part_start;\n"
30605 " uint64_t part_end;\n"
30606 " uint64_t part_size;\n"
30612 #: ../src/guestfs-structs.pod:235
30615 " struct guestfs_partition_list {\n"
30616 " uint32_t len; /* Number of elements in list. */\n"
30617 " struct guestfs_partition *val; /* Elements. */\n"
30623 #: ../src/guestfs-structs.pod:240
30626 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
30627 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
30632 #: ../src/guestfs-structs.pod:243
30633 msgid "guestfs_application"
30637 #: ../src/guestfs-structs.pod:245
30640 " struct guestfs_application {\n"
30641 " char *app_name;\n"
30642 " char *app_display_name;\n"
30643 " int32_t app_epoch;\n"
30644 " char *app_version;\n"
30645 " char *app_release;\n"
30646 " char *app_install_path;\n"
30647 " char *app_trans_path;\n"
30648 " char *app_publisher;\n"
30649 " char *app_url;\n"
30650 " char *app_source_package;\n"
30651 " char *app_summary;\n"
30652 " char *app_description;\n"
30658 #: ../src/guestfs-structs.pod:260
30661 " struct guestfs_application_list {\n"
30662 " uint32_t len; /* Number of elements in list. */\n"
30663 " struct guestfs_application *val; /* Elements. */\n"
30669 #: ../src/guestfs-structs.pod:265
30672 " void guestfs_free_application (struct guestfs_free_application *);\n"
30673 " void guestfs_free_application_list (struct guestfs_free_application_list "
30679 #: ../src/guestfs.pod:5
30680 msgid "guestfs - Library for accessing and modifying virtual machine images"
30684 #: ../src/guestfs.pod:11
30687 " guestfs_h *g = guestfs_create ();\n"
30688 " guestfs_add_drive (g, \"guest.img\");\n"
30689 " guestfs_launch (g);\n"
30690 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
30691 " guestfs_touch (g, \"/hello\");\n"
30692 " guestfs_umount (g, \"/\");\n"
30693 " guestfs_close (g);\n"
30698 #: ../src/guestfs.pod:25
30700 "Libguestfs is a library for accessing and modifying guest disk images. "
30701 "Amongst the things this is good for: making batch configuration changes to "
30702 "guests, getting disk used/free statistics (see also: virt-df), migrating "
30703 "between virtualization systems (see also: virt-p2v), performing partial "
30704 "backups, performing partial guest clones, cloning guests and changing "
30705 "registry/UUID/hostname info, and much else besides."
30709 #: ../src/guestfs.pod:33
30711 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
30712 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
30713 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
30718 #: ../src/guestfs.pod:38
30720 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
30721 "what filesystem is in each LV, etc.). It can also run commands in the "
30722 "context of the guest. Also you can access filesystems over FUSE."
30726 #: ../src/guestfs.pod:43
30728 "Libguestfs is a library that can be linked with C and C++ management "
30729 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
30730 "PHP, Erlang, Haskell or C#). You can also use it from shell scripts or the "
30735 #: ../src/guestfs.pod:48
30737 "You don't need to be root to use libguestfs, although obviously you do need "
30738 "enough permissions to access the disk images."
30742 #: ../src/guestfs.pod:51
30744 "Libguestfs is a large API because it can do many things. For a gentle "
30745 "introduction, please read the L</API OVERVIEW> section next."
30749 #: ../src/guestfs.pod:54
30751 "There are also some example programs in the L<guestfs-examples(3)> manual "
30756 #: ../src/guestfs.pod:57
30757 msgid "API OVERVIEW"
30761 #: ../src/guestfs.pod:59
30763 "This section provides a gentler overview of the libguestfs API. We also try "
30764 "to group API calls together, where that may not be obvious from reading "
30765 "about the individual calls in the main section of this manual."
30769 #: ../src/guestfs.pod:64
30774 #: ../src/guestfs.pod:66
30776 "Before you can use libguestfs calls, you have to create a handle. Then you "
30777 "must add at least one disk image to the handle, followed by launching the "
30778 "handle, then performing whatever operations you want, and finally closing "
30779 "the handle. By convention we use the single letter C<g> for the name of the "
30780 "handle variable, although of course you can use any name you want."
30784 #: ../src/guestfs.pod:73
30785 msgid "The general structure of all libguestfs-using programs looks like this:"
30789 #: ../src/guestfs.pod:76
30792 " guestfs_h *g = guestfs_create ();\n"
30797 #: ../src/guestfs.pod:78
30800 " /* Call guestfs_add_drive additional times if there are\n"
30801 " * multiple disk images.\n"
30803 " guestfs_add_drive (g, \"guest.img\");\n"
30808 #: ../src/guestfs.pod:83
30811 " /* Most manipulation calls won't work until you've launched\n"
30812 " * the handle 'g'. You have to do this _after_ adding drives\n"
30813 " * and _before_ other commands.\n"
30815 " guestfs_launch (g);\n"
30820 #: ../src/guestfs.pod:89
30823 " /* Now you can examine what partitions, LVs etc are available.\n"
30825 " char **partitions = guestfs_list_partitions (g);\n"
30826 " char **logvols = guestfs_lvs (g);\n"
30831 #: ../src/guestfs.pod:94
30834 " /* To access a filesystem in the image, you must mount it.\n"
30836 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
30841 #: ../src/guestfs.pod:98
30844 " /* Now you can perform filesystem actions on the guest\n"
30847 " guestfs_touch (g, \"/hello\");\n"
30852 #: ../src/guestfs.pod:103
30855 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
30856 " * it is done automatically when you close the handle. See\n"
30857 " * discussion of autosync in this page.\n"
30859 " guestfs_sync (g);\n"
30864 #: ../src/guestfs.pod:109
30867 " /* Close the handle 'g'. */\n"
30868 " guestfs_close (g);\n"
30873 #: ../src/guestfs.pod:112
30875 "The code above doesn't include any error checking. In real code you should "
30876 "check return values carefully for errors. In general all functions that "
30877 "return integers return C<-1> on error, and all functions that return "
30878 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
30879 "how to handle errors, and consult the documentation for each function call "
30880 "below to see precisely how they return error indications. See "
30881 "L<guestfs-examples(3)> for fully worked examples."
30885 #: ../src/guestfs.pod:121
30886 msgid "DISK IMAGES"
30890 #: ../src/guestfs.pod:123
30892 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
30893 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
30894 "actual block device, or simply an empty file of zeroes that you have created "
30895 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
30900 #: ../src/guestfs.pod:129
30902 "The call you should use in modern code for adding drives is "
30903 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
30904 "specifying that the format is raw, do:"
30908 #: ../src/guestfs.pod:133
30911 " guestfs_add_drive_opts (g, filename,\n"
30912 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
30918 #: ../src/guestfs.pod:137
30919 msgid "You can add a disk read-only using:"
30923 #: ../src/guestfs.pod:139
30926 " guestfs_add_drive_opts (g, filename,\n"
30927 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
30928 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
30934 #: ../src/guestfs.pod:144
30936 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
30937 "libguestfs won't modify the file."
30941 #: ../src/guestfs.pod:147
30943 "Be extremely cautious if the disk image is in use, eg. if it is being used "
30944 "by a virtual machine. Adding it read-write will almost certainly cause disk "
30945 "corruption, but adding it read-only is safe."
30949 #: ../src/guestfs.pod:151
30951 "You must add at least one disk image, and you may add multiple disk images. "
30952 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
30953 "first one you added), C</dev/sdb> (for the second one you added), etc."
30957 #: ../src/guestfs.pod:156
30959 "Once L</guestfs_launch> has been called you cannot add any more images. You "
30960 "can call L</guestfs_list_devices> to get a list of the device names, in the "
30961 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
30965 #: ../src/guestfs.pod:161
30970 #: ../src/guestfs.pod:163
30972 "Before you can read or write files, create directories and so on in a disk "
30973 "image that contains filesystems, you have to mount those filesystems using "
30974 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
30975 "a disk image contains (for example) one partition with a filesystem on that "
30976 "partition, then you can mount it directly:"
30980 #: ../src/guestfs.pod:170
30983 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
30988 #: ../src/guestfs.pod:172
30990 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
30991 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
30992 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
30993 "that these are libguestfs virtual devices, and are nothing to do with host "
30998 #: ../src/guestfs.pod:178
31000 "If you are given a disk image and you don't know what it contains then you "
31001 "have to find out. Libguestfs can do that too: use "
31002 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
31003 "and LVs, and either try mounting each to see what is mountable, or else "
31004 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
31005 "filesystems, use L</guestfs_list_filesystems>."
31009 #: ../src/guestfs.pod:186
31011 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
31012 "L</INSPECTION> below). But you might find it easier to look at higher level "
31013 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
31017 #: ../src/guestfs.pod:191
31019 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
31020 "several other variations of the C<guestfs_mount_*> call."
31024 #: ../src/guestfs.pod:194
31025 msgid "FILESYSTEM ACCESS AND MODIFICATION"
31029 #: ../src/guestfs.pod:196
31031 "The majority of the libguestfs API consists of fairly low-level calls for "
31032 "accessing and modifying the files, directories, symlinks etc on mounted "
31033 "filesystems. There are over a hundred such calls which you can find listed "
31034 "in detail below in this man page, and we don't even pretend to cover them "
31035 "all in this overview."
31039 #: ../src/guestfs.pod:202
31041 "Specify filenames as full paths, starting with C<\"/\"> and including the "
31046 #: ../src/guestfs.pod:205
31048 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
31049 "the file called C<\"etc/passwd\"> then you could do:"
31053 #: ../src/guestfs.pod:208
31056 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
31061 #: ../src/guestfs.pod:210
31063 "This would return C<data> as a newly allocated buffer containing the full "
31064 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
31065 "or C<NULL> if there was an error."
31069 #: ../src/guestfs.pod:214
31071 "As another example, to create a top-level directory on that filesystem "
31072 "called C<\"var\"> you would do:"
31076 #: ../src/guestfs.pod:217
31079 " guestfs_mkdir (g, \"/var\");\n"
31084 #: ../src/guestfs.pod:219
31085 msgid "To create a symlink you could do:"
31089 #: ../src/guestfs.pod:221
31092 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
31093 " \"/etc/rc3.d/S30portmap\");\n"
31098 #: ../src/guestfs.pod:224
31100 "Libguestfs will reject attempts to use relative paths and there is no "
31101 "concept of a current working directory."
31105 #: ../src/guestfs.pod:227
31107 "Libguestfs can return errors in many situations: for example if the "
31108 "filesystem isn't writable, or if a file or directory that you requested "
31109 "doesn't exist. If you are using the C API (documented here) you have to "
31110 "check for those error conditions after each call. (Other language bindings "
31111 "turn these errors into exceptions)."
31115 #: ../src/guestfs.pod:233
31117 "File writes are affected by the per-handle umask, set by calling "
31118 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
31122 #: ../src/guestfs.pod:236
31123 msgid "PARTITIONING"
31127 #: ../src/guestfs.pod:238
31129 "Libguestfs contains API calls to read, create and modify partition tables on "
31134 #: ../src/guestfs.pod:241
31136 "In the common case where you want to create a single partition covering the "
31137 "whole disk, you should use the L</guestfs_part_disk> call:"
31141 #: ../src/guestfs.pod:245
31144 " const char *parttype = \"mbr\";\n"
31145 " if (disk_is_larger_than_2TB)\n"
31146 " parttype = \"gpt\";\n"
31147 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
31152 #: ../src/guestfs.pod:250
31154 "Obviously this effectively wipes anything that was on that disk image "
31159 #: ../src/guestfs.pod:253
31164 #: ../src/guestfs.pod:255
31166 "Libguestfs provides access to a large part of the LVM2 API, such as "
31167 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
31168 "unless you familiarize yourself with the concepts of physical volumes, "
31169 "volume groups and logical volumes."
31173 #: ../src/guestfs.pod:260
31175 "This author strongly recommends reading the LVM HOWTO, online at "
31176 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
31180 #: ../src/guestfs.pod:263
31181 msgid "DOWNLOADING"
31185 #: ../src/guestfs.pod:265
31187 "Use L</guestfs_cat> to download small, text only files. This call is "
31188 "limited to files which are less than 2 MB and which cannot contain any ASCII "
31189 "NUL (C<\\0>) characters. However the API is very simple to use."
31193 #: ../src/guestfs.pod:269
31195 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
31196 "bit data, since it returns a (pointer, size) pair. However it is still "
31197 "limited to \"small\" files, less than 2 MB."
31201 #: ../src/guestfs.pod:273
31203 "L</guestfs_download> can be used to download any file, with no limits on "
31204 "content or size (even files larger than 4 GB)."
31208 #: ../src/guestfs.pod:276
31209 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
31213 #: ../src/guestfs.pod:279
31218 #: ../src/guestfs.pod:281
31220 "It's often the case that you want to write a file or files to the disk "
31225 #: ../src/guestfs.pod:284
31227 "To write a small file with fixed content, use L</guestfs_write>. To create "
31228 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
31229 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
31230 "variety of other functions for creating test files, for example "
31231 "L</guestfs_fill> and L</guestfs_fill_pattern>."
31235 #: ../src/guestfs.pod:290
31237 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
31238 "file content or size (even files larger than 4 GB)."
31242 #: ../src/guestfs.pod:293
31243 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
31247 #: ../src/guestfs.pod:295
31249 "However the fastest way to upload I<large numbers of arbitrary files> is to "
31250 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
31251 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
31252 "the drive in a predictable way (eg. adding it last after all other drives) "
31253 "then you can get the device name from L</guestfs_list_devices> and mount it "
31254 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
31255 "sometimes non-portable between kernel versions, and they don't support "
31256 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
31257 "using a label or UUID, use an ISO image instead."
31261 #: ../src/guestfs.pod:306
31266 #: ../src/guestfs.pod:308
31268 "There are various different commands for copying between files and devices "
31269 "and in and out of the guest filesystem. These are summarised in the table "
31274 #: ../src/guestfs.pod:314
31275 msgid "B<file> to B<file>"
31279 #: ../src/guestfs.pod:316
31281 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
31282 "directories recursively."
31286 #: ../src/guestfs.pod:319
31287 msgid "B<file or device> to B<file or device>"
31291 #: ../src/guestfs.pod:321
31293 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
31294 "devices in the guest."
31298 #: ../src/guestfs.pod:324
31299 msgid "Example: duplicate the contents of an LV:"
31303 #: ../src/guestfs.pod:326
31306 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
31311 #: ../src/guestfs.pod:328
31313 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
31314 "(C</dev/VG/Original>). To copy less than the whole source device, use "
31315 "L</guestfs_copy_size>."
31319 #: ../src/guestfs.pod:332
31320 msgid "B<file on the host> to B<file or device>"
31324 #: ../src/guestfs.pod:334
31325 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
31329 #: ../src/guestfs.pod:336
31330 msgid "B<file or device> to B<file on the host>"
31334 #: ../src/guestfs.pod:338
31335 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
31339 #: ../src/guestfs.pod:342
31340 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
31344 #: ../src/guestfs.pod:344
31346 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
31347 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
31348 "appears you can only upload and download to files. However many Un*x-like "
31349 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
31350 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
31351 "stderr, and arbitrary file descriptor N."
31355 #: ../src/guestfs.pod:352
31356 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
31360 #: ../src/guestfs.pod:355
31363 " guestfs_download (g, filename, \"/dev/stdout\");\n"
31368 #: ../src/guestfs.pod:357
31369 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
31373 #: ../src/guestfs.pod:359
31376 " char devfd[64];\n"
31377 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
31378 " guestfs_tar_out (g, \"/\", devfd);\n"
31383 #: ../src/guestfs.pod:363
31384 msgid "LISTING FILES"
31388 #: ../src/guestfs.pod:365
31390 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
31391 "L<guestfish(1)>-equivalent command C<ll>)."
31395 #: ../src/guestfs.pod:368
31397 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
31398 "programs, as a flat list of strings."
31402 #: ../src/guestfs.pod:371
31404 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
31405 "directory, plus additional information about each one. It is more "
31406 "equivalent to using the L<readdir(3)> call on a local filesystem."
31410 #: ../src/guestfs.pod:375
31412 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
31417 #: ../src/guestfs.pod:378
31418 msgid "RUNNING COMMANDS"
31422 #: ../src/guestfs.pod:380
31424 "Although libguestfs is primarily an API for manipulating files inside guest "
31425 "images, we also provide some limited facilities for running commands inside "
31430 #: ../src/guestfs.pod:384
31431 msgid "There are many limitations to this:"
31435 #: ../src/guestfs.pod:390
31437 "The kernel version that the command runs under will be different from what "
31442 #: ../src/guestfs.pod:395
31444 "If the command needs to communicate with daemons, then most likely they "
31445 "won't be running."
31449 #: ../src/guestfs.pod:400
31450 msgid "The command will be running in limited memory."
31454 #: ../src/guestfs.pod:404
31456 "The network may not be available unless you enable it (see "
31457 "L</guestfs_set_network>)."
31461 #: ../src/guestfs.pod:409
31462 msgid "Only supports Linux guests (not Windows, BSD, etc)."
31466 #: ../src/guestfs.pod:413
31467 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
31471 #: ../src/guestfs.pod:418
31473 "For SELinux guests, you may need to enable SELinux and load policy first. "
31474 "See L</SELINUX> in this manpage."
31478 #: ../src/guestfs.pod:423
31480 "I<Security:> It is not safe to run commands from untrusted, possibly "
31481 "malicious guests. These commands may attempt to exploit your program by "
31482 "sending unexpected output. They could also try to exploit the Linux kernel "
31483 "or qemu provided by the libguestfs appliance. They could use the network "
31484 "provided by the libguestfs appliance to bypass ordinary network partitions "
31485 "and firewalls. They could use the elevated privileges or different SELinux "
31486 "context of your program to their advantage."
31490 #: ../src/guestfs.pod:432
31492 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
31493 "(a script which runs when the guest next boots normally), and to have this "
31494 "script run the commands you want in the normal context of the running guest, "
31495 "network security and so on. For information about other security issues, "
31496 "see L</SECURITY>."
31500 #: ../src/guestfs.pod:440
31502 "The two main API calls to run commands are L</guestfs_command> and "
31503 "L</guestfs_sh> (there are also variations)."
31507 #: ../src/guestfs.pod:443
31509 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
31510 "shell globs, redirections, etc will work."
31514 #: ../src/guestfs.pod:446
31515 msgid "CONFIGURATION FILES"
31519 #: ../src/guestfs.pod:448
31521 "To read and write configuration files in Linux guest filesystems, we "
31522 "strongly recommend using Augeas. For example, Augeas understands how to "
31523 "read and write, say, a Linux shadow password file or X.org configuration "
31524 "file, and so avoids you having to write that code."
31528 #: ../src/guestfs.pod:453
31530 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
31531 "document Augeas itself here because there is excellent documentation on the "
31532 "L<http://augeas.net/> website."
31536 #: ../src/guestfs.pod:457
31538 "If you don't want to use Augeas (you fool!) then try calling "
31539 "L</guestfs_read_lines> to get the file as a list of lines which you can "
31544 #: ../src/guestfs.pod:461
31549 #: ../src/guestfs.pod:463
31551 "We support SELinux guests. To ensure that labeling happens correctly in "
31552 "SELinux guests, you need to enable SELinux and load the guest's policy:"
31556 #: ../src/guestfs.pod:471
31557 msgid "Before launching, do:"
31561 #: ../src/guestfs.pod:473
31564 " guestfs_set_selinux (g, 1);\n"
31569 #: ../src/guestfs.pod:477
31571 "After mounting the guest's filesystem(s), load the policy. This is best "
31572 "done by running the L<load_policy(8)> command in the guest itself:"
31576 #: ../src/guestfs.pod:481
31579 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
31584 #: ../src/guestfs.pod:483
31586 "(Older versions of C<load_policy> require you to specify the name of the "
31591 #: ../src/guestfs.pod:488
31593 "Optionally, set the security context for the API. The correct security "
31594 "context to use can only be known by inspecting the guest. As an example:"
31598 #: ../src/guestfs.pod:492
31601 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
31606 #: ../src/guestfs.pod:496
31607 msgid "This will work for running commands and editing existing files."
31611 #: ../src/guestfs.pod:498
31613 "When new files are created, you may need to label them explicitly, for "
31614 "example by running the external command C<restorecon pathname>."
31618 #: ../src/guestfs.pod:502
31623 #: ../src/guestfs.pod:504
31625 "Certain calls are affected by the current file mode creation mask (the "
31626 "\"umask\"). In particular ones which create files or directories, such as "
31627 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
31628 "either the default mode that the file is created with or modifies the mode "
31633 #: ../src/guestfs.pod:510
31635 "The default umask is C<022>, so files are created with modes such as C<0644> "
31636 "and directories with C<0755>."
31640 #: ../src/guestfs.pod:513
31642 "There are two ways to avoid being affected by umask. Either set umask to 0 "
31643 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
31644 "L</guestfs_chmod> after creating each file or directory."
31648 #: ../src/guestfs.pod:517
31649 msgid "For more information about umask, see L<umask(2)>."
31653 #: ../src/guestfs.pod:521
31655 "Libguestfs allows you to access Linux guests which have been encrypted using "
31656 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
31657 "standard. This includes nearly all whole disk encryption systems used by "
31658 "modern Linux guests."
31662 #: ../src/guestfs.pod:527
31664 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
31665 "returns the string C<crypto_LUKS>)."
31669 #: ../src/guestfs.pod:530
31671 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
31672 "will require the passphrase!"
31676 #: ../src/guestfs.pod:533
31678 "Opening a LUKS device creates a new device mapper device called "
31679 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
31680 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
31681 "decrypted from and encrypted to the underlying block device respectively."
31685 #: ../src/guestfs.pod:539
31687 "LVM volume groups on the device can be made visible by calling "
31688 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
31689 "volume(s) can now be mounted in the usual way."
31693 #: ../src/guestfs.pod:543
31695 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
31696 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
31697 "[\"/dev/VG\"])>. Then close the mapper device by calling "
31698 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
31699 "underlying encrypted block device)."
31703 #: ../src/guestfs.pod:550
31708 #: ../src/guestfs.pod:552
31710 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
31711 "contains operating systems, an install CD or a live CD. (These APIs used to "
31712 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
31713 "version 1.5.3 the most frequently used part of this library has been "
31714 "rewritten in C and moved into the core code)."
31718 #: ../src/guestfs.pod:559
31720 "Add all disks belonging to the unknown virtual machine and call "
31721 "L</guestfs_launch> in the usual way."
31725 #: ../src/guestfs.pod:562
31727 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
31728 "and certain heuristics, and returns a list of operating systems that were "
31729 "found. An empty list means none were found. A single element is the root "
31730 "filesystem of the operating system. For dual- or multi-boot guests, "
31731 "multiple roots can be returned, each one corresponding to a separate "
31732 "operating system. (Multi-boot virtual machines are extremely rare in the "
31733 "world of virtualization, but since this scenario can happen, we have built "
31734 "libguestfs to deal with it.)"
31738 #: ../src/guestfs.pod:571
31740 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
31741 "to get additional details about that operating system. For example, call "
31742 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
31743 "Windows and Linux-based operating systems respectively."
31747 #: ../src/guestfs.pod:577
31749 "Un*x-like and Linux-based operating systems usually consist of several "
31750 "filesystems which are mounted at boot time (for example, a separate boot "
31751 "partition mounted on C</boot>). The inspection rules are able to detect how "
31752 "filesystems correspond to mount points. Call "
31753 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
31754 "hash table like this example:"
31758 #: ../src/guestfs.pod:584
31761 " /boot => /dev/sda1\n"
31762 " / => /dev/vg_guest/lv_root\n"
31763 " /usr => /dev/vg_guest/lv_usr\n"
31768 #: ../src/guestfs.pod:588
31770 "The caller can then make calls to L</guestfs_mount_options> to mount the "
31771 "filesystems as suggested."
31775 #: ../src/guestfs.pod:591
31777 "Be careful to mount filesystems in the right order (eg. C</> before "
31778 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
31783 #: ../src/guestfs.pod:595
31785 "Inspection currently only works for some common operating systems. "
31786 "Contributors are welcome to send patches for other operating systems that we "
31787 "currently cannot detect."
31791 #: ../src/guestfs.pod:599
31793 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
31794 "for more details. The L</guestfs_inspect_os> function just ignores any "
31795 "encrypted devices."
31799 #: ../src/guestfs.pod:603
31801 "A note on the implementation: The call L</guestfs_inspect_os> performs "
31802 "inspection and caches the results in the guest handle. Subsequent calls to "
31803 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
31804 "re-read the disks. If you change the content of the guest disks, you can "
31805 "redo inspection by calling L</guestfs_inspect_os> again. "
31806 "(L</guestfs_inspect_list_applications> works a little differently from the "
31807 "other calls and does read the disks. See documentation for that function "
31812 #: ../src/guestfs.pod:612
31813 msgid "INSPECTING INSTALL DISKS"
31817 #: ../src/guestfs.pod:614
31819 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
31824 #: ../src/guestfs.pod:617
31826 "Call L</guestfs_inspect_get_format> to return the format of the operating "
31827 "system, which currently can be C<installed> (a regular operating system) or "
31828 "C<installer> (some sort of install disk)."
31832 #: ../src/guestfs.pod:621
31834 "Further information is available about the operating system that can be "
31835 "installed using the regular inspection APIs like "
31836 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
31841 #: ../src/guestfs.pod:626
31843 "Some additional information specific to installer disks is also available "
31844 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
31845 "L</guestfs_inspect_is_multipart> calls."
31849 #: ../src/guestfs.pod:631
31850 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
31854 #: ../src/guestfs.pod:633
31856 "Libguestfs can mount NTFS partitions. It does this using the "
31857 "L<http://www.ntfs-3g.org/> driver."
31861 #: ../src/guestfs.pod:636
31862 msgid "DRIVE LETTERS AND PATHS"
31866 #: ../src/guestfs.pod:638
31868 "DOS and Windows still use drive letters, and the filesystems are always "
31869 "treated as case insensitive by Windows itself, and therefore you might find "
31870 "a Windows configuration file referring to a path like "
31871 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
31872 "that directory might be referred to as C</WINDOWS/System32>."
31876 #: ../src/guestfs.pod:644
31878 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
31879 "L</guestfs_inspect_get_drive_mappings>)"
31883 #: ../src/guestfs.pod:647
31885 "Dealing with separator characters (backslash vs forward slash) is outside "
31886 "the scope of libguestfs, but usually a simple character replacement will "
31891 #: ../src/guestfs.pod:651
31893 "To resolve the case insensitivity of paths, call "
31894 "L</guestfs_case_sensitive_path>."
31898 #: ../src/guestfs.pod:654
31899 msgid "ACCESSING THE WINDOWS REGISTRY"
31903 #: ../src/guestfs.pod:656
31905 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
31906 "files, through the library C<hivex> which is part of the libguestfs project "
31907 "although ships as a separate tarball. You have to locate and download the "
31908 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
31909 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
31910 "L<virt-win-reg(1)> for more help on this issue."
31914 #: ../src/guestfs.pod:664
31915 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
31919 #: ../src/guestfs.pod:666
31921 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
31922 "provide something which looks like a Linux symlink. The way it tries to do "
31923 "the rewriting is described here:"
31927 #: ../src/guestfs.pod:670
31928 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
31932 #: ../src/guestfs.pod:672
31934 "The essential problem is that ntfs-3g simply does not have enough "
31935 "information to do a correct job. NTFS links can contain drive letters and "
31936 "references to external device GUIDs that ntfs-3g has no way of resolving. "
31937 "It is almost certainly the case that libguestfs callers should ignore what "
31938 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
31942 #: ../src/guestfs.pod:679
31944 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
31945 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
31946 "attribute, and read the raw reparse data from that (you can find the format "
31947 "documented in various places around the web)."
31951 #: ../src/guestfs.pod:684
31952 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
31956 #: ../src/guestfs.pod:686
31958 "There are other useful extended attributes that can be read from ntfs-3g "
31959 "filesystems (using L</guestfs_getxattr>). See:"
31963 #: ../src/guestfs.pod:689
31964 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
31968 #: ../src/guestfs.pod:691
31969 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
31973 #: ../src/guestfs.pod:693
31975 "Although we don't want to discourage you from using the C API, we will "
31976 "mention here that the same API is also available in other languages."
31980 #: ../src/guestfs.pod:696
31982 "The API is broadly identical in all supported languages. This means that "
31983 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
31984 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
31985 "OCaml. In other words, a straightforward, predictable isomorphism between "
31990 #: ../src/guestfs.pod:702
31992 "Error messages are automatically transformed into exceptions if the language "
31997 #: ../src/guestfs.pod:705
31999 "We don't try to \"object orientify\" parts of the API in OO languages, "
32000 "although contributors are welcome to write higher level APIs above what we "
32001 "provide in their favourite languages if they wish."
32005 #: ../src/guestfs.pod:711
32010 #: ../src/guestfs.pod:713
32012 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
32013 "identical to the C API. C++ classes and exceptions are not used."
32017 #: ../src/guestfs.pod:717
32022 #: ../src/guestfs.pod:719
32024 "The C# bindings are highly experimental. Please read the warnings at the "
32025 "top of C<csharp/Libguestfs.cs>."
32029 #: ../src/guestfs.pod:722
32034 #: ../src/guestfs.pod:724
32035 msgid "See L<guestfs-erlang(3)>."
32039 #: ../src/guestfs.pod:726
32044 #: ../src/guestfs.pod:728
32046 "This is the only language binding that is working but incomplete. Only "
32047 "calls which return simple integers have been bound in Haskell, and we are "
32048 "looking for help to complete this binding."
32052 #: ../src/guestfs.pod:732
32057 #: ../src/guestfs.pod:734
32059 "Full documentation is contained in the Javadoc which is distributed with "
32060 "libguestfs. For examples, see L<guestfs-java(3)>."
32064 #: ../src/guestfs.pod:737
32069 #: ../src/guestfs.pod:739
32070 msgid "See L<guestfs-ocaml(3)>."
32074 #: ../src/guestfs.pod:741
32079 #: ../src/guestfs.pod:743
32080 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
32084 #: ../src/guestfs.pod:745
32089 #: ../src/guestfs.pod:747
32091 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
32092 "the php-libguestfs package for your distribution."
32096 #: ../src/guestfs.pod:750
32097 msgid "The PHP binding only works correctly on 64 bit machines."
32101 #: ../src/guestfs.pod:752
32106 #: ../src/guestfs.pod:754
32107 msgid "See L<guestfs-python(3)>."
32111 #: ../src/guestfs.pod:756
32116 #: ../src/guestfs.pod:758
32117 msgid "See L<guestfs-ruby(3)>."
32121 #: ../src/guestfs.pod:760
32122 msgid "B<shell scripts>"
32126 #: ../src/guestfs.pod:762
32127 msgid "See L<guestfish(1)>."
32131 #: ../src/guestfs.pod:766
32132 msgid "LIBGUESTFS GOTCHAS"
32136 #: ../src/guestfs.pod:768
32138 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
32139 "system [...] that works in the way it is documented but is counterintuitive "
32140 "and almost invites mistakes.\""
32144 #: ../src/guestfs.pod:772
32146 "Since we developed libguestfs and the associated tools, there are several "
32147 "things we would have designed differently, but are now stuck with for "
32148 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
32149 "release, you can expect these to change. Beware of them."
32153 #: ../src/guestfs.pod:780
32154 msgid "Autosync / forgetting to sync."
32158 #: ../src/guestfs.pod:782
32160 "I<Update:> Autosync is enabled by default for all API users starting from "
32161 "libguestfs 1.5.24. This section only applies to older versions."
32165 #: ../src/guestfs.pod:785
32167 "When modifying a filesystem from C or another language, you B<must> unmount "
32168 "all filesystems and call L</guestfs_sync> explicitly before you close the "
32169 "libguestfs handle. You can also call:"
32173 #: ../src/guestfs.pod:789
32176 " guestfs_set_autosync (g, 1);\n"
32181 #: ../src/guestfs.pod:791
32183 "to have the unmount/sync done automatically for you when the handle 'g' is "
32184 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
32189 #: ../src/guestfs.pod:795
32191 "If you forget to do this, then it is entirely possible that your changes "
32192 "won't be written out, or will be partially written, or (very rarely) that "
32193 "you'll get disk corruption."
32197 #: ../src/guestfs.pod:799
32199 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
32200 "guestfish scripts that forget to sync will work just fine, which can make "
32201 "this very puzzling if you are trying to debug a problem."
32205 #: ../src/guestfs.pod:803
32206 msgid "Mount option C<-o sync> should not be the default."
32210 #: ../src/guestfs.pod:805
32212 "I<Update:> L</guestfs_mount> no longer adds any options starting from "
32213 "libguestfs 1.13.16. This section only applies to older versions."
32217 #: ../src/guestfs.pod:808
32219 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
32220 "However C<-o sync> does not add any reliability benefit, but does have a "
32221 "very large performance impact."
32225 #: ../src/guestfs.pod:812
32227 "The work around is to use L</guestfs_mount_options> and set the mount "
32228 "options that you actually want to use."
32232 #: ../src/guestfs.pod:815
32233 msgid "Read-only should be the default."
32237 #: ../src/guestfs.pod:817
32239 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
32240 "specify I<--rw> if you want to make changes to the image."
32244 #: ../src/guestfs.pod:820
32245 msgid "This would reduce the potential to corrupt live VM images."
32249 #: ../src/guestfs.pod:822
32251 "Note that many filesystems change the disk when you just mount and unmount, "
32252 "even if you didn't perform any writes. You need to use "
32253 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
32257 #: ../src/guestfs.pod:826
32258 msgid "guestfish command line is hard to use."
32262 #: ../src/guestfs.pod:828
32264 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
32265 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
32266 "exist, so it fails. In earlier versions of guestfish the error message was "
32267 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
32268 "we should have used C<guestfish -c command> to run commands."
32272 #: ../src/guestfs.pod:835
32273 msgid "guestfish megabyte modifiers don't work right on all commands"
32277 #: ../src/guestfs.pod:837
32279 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
32280 "other modifiers). What guestfish actually does is to multiply the number "
32281 "part by the modifier part and pass the result to the C API. However this "
32282 "doesn't work for a few APIs which aren't expecting bytes, but are already "
32283 "expecting some other unit (eg. megabytes)."
32287 #: ../src/guestfs.pod:844
32288 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
32292 #: ../src/guestfs.pod:846
32295 " lvcreate LV VG 100M\n"
32300 #: ../src/guestfs.pod:848
32302 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
32303 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
32304 "megabytes * megabytes) logical volume. The error message you get from this "
32305 "is also a little obscure."
32309 #: ../src/guestfs.pod:853
32311 "This could be fixed in the generator by specially marking parameters and "
32312 "return values which take bytes or other units."
32316 #: ../src/guestfs.pod:856
32317 msgid "Ambiguity between devices and paths"
32321 #: ../src/guestfs.pod:858
32323 "There is a subtle ambiguity in the API between a device name "
32324 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
32325 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
32329 #: ../src/guestfs.pod:863
32331 "In the current API we usually resolve this ambiguity by having two separate "
32332 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
32333 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
32334 "detecting if the path supplied begins with C</dev/>."
32338 #: ../src/guestfs.pod:869
32340 "To avoid both the ambiguity and the need to duplicate some calls, we could "
32341 "make paths/devices into structured names. One way to do this would be to "
32342 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
32343 "aspect of grub. Another way would be to use a structured type, equivalent "
32344 "to this OCaml type:"
32348 #: ../src/guestfs.pod:875
32351 " type path = Path of string | Device of int | Partition of int * int\n"
32356 #: ../src/guestfs.pod:877
32357 msgid "which would allow you to pass arguments like:"
32361 #: ../src/guestfs.pod:879
32364 " Path \"/foo/bar\"\n"
32365 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
32366 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
32367 " Path \"/dev/sdb2\" (* not a device *)\n"
32372 #: ../src/guestfs.pod:884
32374 "As you can see there are still problems to resolve even with this "
32375 "representation. Also consider how it might work in guestfish."
32379 #: ../src/guestfs.pod:889
32380 msgid "KEYS AND PASSPHRASES"
32384 #: ../src/guestfs.pod:891
32386 "Certain libguestfs calls take a parameter that contains sensitive key "
32387 "material, passed in as a C string."
32391 #: ../src/guestfs.pod:894
32393 "In the future we would hope to change the libguestfs implementation so that "
32394 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
32395 "swap. However this is I<not> done at the moment, because of the complexity "
32396 "of such an implementation."
32400 #: ../src/guestfs.pod:899
32402 "Therefore you should be aware that any key parameter you pass to libguestfs "
32403 "might end up being written out to the swap partition. If this is a concern, "
32404 "scrub the swap partition or don't use libguestfs on encrypted devices."
32408 #: ../src/guestfs.pod:904
32409 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
32413 #: ../src/guestfs.pod:906
32415 "All high-level libguestfs actions are synchronous. If you want to use "
32416 "libguestfs asynchronously then you must create a thread."
32420 #: ../src/guestfs.pod:909
32422 "Only use the handle from a single thread. Either use the handle exclusively "
32423 "from one thread, or provide your own mutex so that two threads cannot issue "
32424 "calls on the same handle at the same time."
32428 #: ../src/guestfs.pod:913
32430 "See the graphical program guestfs-browser for one possible architecture for "
32431 "multithreaded programs using libvirt and libguestfs."
32435 #: ../src/guestfs.pod:916
32440 #: ../src/guestfs.pod:918
32442 "Libguestfs needs a supermin appliance, which it finds by looking along an "
32447 #: ../src/guestfs.pod:921
32449 "By default it looks for these in the directory C<$libdir/guestfs> "
32450 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
32454 #: ../src/guestfs.pod:924
32456 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
32457 "to change the directories that libguestfs will search in. The value is a "
32458 "colon-separated list of paths. The current directory is I<not> searched "
32459 "unless the path contains an empty element or C<.>. For example "
32460 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
32461 "then C</usr/lib/guestfs>."
32465 #: ../src/guestfs.pod:931
32466 msgid "QEMU WRAPPERS"
32470 #: ../src/guestfs.pod:933
32472 "If you want to compile your own qemu, run qemu from a non-standard location, "
32473 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
32478 #: ../src/guestfs.pod:937
32480 "There is one important rule to remember: you I<must C<exec qemu>> as the "
32481 "last command in the shell script (so that qemu replaces the shell and "
32482 "becomes the direct child of the libguestfs-using program). If you don't do "
32483 "this, then the qemu process won't be cleaned up correctly."
32487 #: ../src/guestfs.pod:942
32489 "Here is an example of a wrapper, where I have built my own copy of qemu from "
32494 #: ../src/guestfs.pod:945
32498 " qemudir=/home/rjones/d/qemu\n"
32499 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
32505 #: ../src/guestfs.pod:949
32507 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
32508 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
32513 #: ../src/guestfs.pod:953
32516 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
32521 #: ../src/guestfs.pod:955
32523 "Note that libguestfs also calls qemu with the -help and -version options in "
32524 "order to determine features."
32528 #: ../src/guestfs.pod:958
32530 "Wrappers can also be used to edit the options passed to qemu. In the "
32531 "following example, the C<-machine ...> option (C<-machine> and the following "
32532 "argument) are removed from the command line and replaced with C<-machine "
32533 "pc,accel=tcg>. The while loop iterates over the options until it finds the "
32534 "right one to remove, putting the remaining options into the C<args> array."
32538 #: ../src/guestfs.pod:965
32546 #: ../src/guestfs.pod:967
32550 " while [ $# -gt 0 ]; do\n"
32551 " case \"$1\" in\n"
32555 " args[i]=\"$1\"\n"
32564 #: ../src/guestfs.pod:979
32567 " exec qemu-kvm -machine pc,accel=tcg \"${args[@]}\"\n"
32572 #: ../src/guestfs.pod:981
32573 msgid "ATTACHING TO RUNNING DAEMONS"
32577 #: ../src/guestfs.pod:983
32579 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
32580 "babies. Use with caution."
32584 #: ../src/guestfs.pod:986
32586 "I<Note (2):> This section explains how to attach to a running daemon from a "
32587 "low level perspective. For most users, simply using virt tools such as "
32588 "L<guestfish(1)> with the I<--live> option will \"just work\"."
32592 #: ../src/guestfs.pod:990
32593 msgid "Using guestfs_set_attach_method"
32597 #: ../src/guestfs.pod:992
32599 "By calling L</guestfs_set_attach_method> you can change how the library "
32600 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
32601 "L</ARCHITECTURE> for some background)."
32605 #: ../src/guestfs.pod:996
32607 "The normal attach method is C<appliance>, where a small appliance is created "
32608 "containing the daemon, and then the library connects to this."
32612 #: ../src/guestfs.pod:999
32614 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
32615 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
32616 "daemon over the Unix domain socket."
32620 #: ../src/guestfs.pod:1003
32622 "The normal use for this is to connect to a running virtual machine that "
32623 "contains a C<guestfsd> daemon, and send commands so you can read and write "
32624 "files inside the live virtual machine."
32628 #: ../src/guestfs.pod:1007
32629 msgid "Using guestfs_add_domain with live flag"
32633 #: ../src/guestfs.pod:1009
32635 "L</guestfs_add_domain> provides some help for getting the correct attach "
32636 "method. If you pass the C<live> option to this function, then (if the "
32637 "virtual machine is running) it will examine the libvirt XML looking for a "
32638 "virtio-serial channel to connect to:"
32642 #: ../src/guestfs.pod:1015
32649 " <channel type='unix'>\n"
32650 " <source mode='bind' path='/path/to/socket'/>\n"
32651 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
32660 #: ../src/guestfs.pod:1027
32662 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
32663 "method to C<unix:/path/to/socket>."
32667 #: ../src/guestfs.pod:1030
32669 "Some of the libguestfs tools (including guestfish) support a I<--live> "
32670 "option which is passed through to L</guestfs_add_domain> thus allowing you "
32671 "to attach to and modify live virtual machines."
32675 #: ../src/guestfs.pod:1034
32677 "The virtual machine needs to have been set up beforehand so that it has the "
32678 "virtio-serial channel and so that guestfsd is running inside it."
32682 #: ../src/guestfs.pod:1038
32683 msgid "ABI GUARANTEE"
32687 #: ../src/guestfs.pod:1040
32689 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
32690 "actions as outlined in this section. Although we will deprecate some "
32691 "actions, for example if they get replaced by newer calls, we will keep the "
32692 "old actions forever. This allows you the developer to program in confidence "
32693 "against the libguestfs API."
32697 #: ../src/guestfs.pod:1046
32698 msgid "BLOCK DEVICE NAMING"
32702 #: ../src/guestfs.pod:1048
32704 "In the kernel there is now quite a profusion of schemata for naming block "
32705 "devices (in this context, by I<block device> I mean a physical or virtual "
32706 "hard drive). The original Linux IDE driver used names starting with "
32707 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
32708 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
32709 "replacement for the old IDE driver (particularly for SATA devices) those "
32710 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
32711 "machines with paravirtualized drivers. This has created several different "
32712 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
32717 #: ../src/guestfs.pod:1060
32719 "As discussed above, libguestfs uses a qemu appliance running an embedded "
32720 "Linux kernel to access block devices. We can run a variety of appliances "
32721 "based on a variety of Linux kernels."
32725 #: ../src/guestfs.pod:1064
32727 "This causes a problem for libguestfs because many API calls use device or "
32728 "partition names. Working scripts and the recipe (example) scripts that we "
32729 "make available over the internet could fail if the naming scheme changes."
32733 #: ../src/guestfs.pod:1069
32735 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
32736 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
32737 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
32738 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
32742 #: ../src/guestfs.pod:1075
32744 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
32745 "L</guestfs_list_partitions> and similar calls return the true names of the "
32746 "devices and partitions as known to the appliance."
32750 #: ../src/guestfs.pod:1080
32751 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
32755 #: ../src/guestfs.pod:1082
32757 "Usually this translation is transparent. However in some (very rare) cases "
32758 "you may need to know the exact algorithm. Such cases include where you use "
32759 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
32760 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
32765 #: ../src/guestfs.pod:1088
32767 "The algorithm is applied only to I<parameters> which are known to be either "
32768 "device or partition names. Return values from functions such as "
32769 "L</guestfs_list_devices> are never changed."
32773 #: ../src/guestfs.pod:1096
32774 msgid "Is the string a parameter which is a device or partition name?"
32778 #: ../src/guestfs.pod:1100
32779 msgid "Does the string begin with C</dev/sd>?"
32783 #: ../src/guestfs.pod:1104
32785 "Does the named device exist? If so, we use that device. However if I<not> "
32786 "then we continue with this algorithm."
32790 #: ../src/guestfs.pod:1109
32791 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
32795 #: ../src/guestfs.pod:1111
32796 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
32800 #: ../src/guestfs.pod:1113
32801 msgid "If that named device exists, use it. If not, continue."
32805 #: ../src/guestfs.pod:1117
32806 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
32810 #: ../src/guestfs.pod:1119
32811 msgid "If that named device exists, use it. If not, return an error."
32815 #: ../src/guestfs.pod:1123
32816 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
32820 #: ../src/guestfs.pod:1125
32822 "Although the standard naming scheme and automatic translation is useful for "
32823 "simple programs and guestfish scripts, for larger programs it is best not to "
32824 "rely on this mechanism."
32828 #: ../src/guestfs.pod:1129
32830 "Where possible for maximum future portability programs using libguestfs "
32831 "should use these future-proof techniques:"
32835 #: ../src/guestfs.pod:1136
32837 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
32838 "device names, and then use those names directly."
32842 #: ../src/guestfs.pod:1139
32843 msgid "Since those device names exist by definition, they will never be translated."
32847 #: ../src/guestfs.pod:1144
32849 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
32850 "filesystem labels."
32854 #: ../src/guestfs.pod:1149
32859 #: ../src/guestfs.pod:1151
32861 "This section discusses security implications of using libguestfs, "
32862 "particularly with untrusted or malicious guests or disk images."
32866 #: ../src/guestfs.pod:1154
32867 msgid "GENERAL SECURITY CONSIDERATIONS"
32871 #: ../src/guestfs.pod:1156
32873 "Be careful with any files or data that you download from a guest (by "
32874 "\"download\" we mean not just the L</guestfs_download> command but any "
32875 "command that reads files, filenames, directories or anything else from a "
32876 "disk image). An attacker could manipulate the data to fool your program "
32877 "into doing the wrong thing. Consider cases such as:"
32881 #: ../src/guestfs.pod:1166
32882 msgid "the data (file etc) not being present"
32886 #: ../src/guestfs.pod:1170
32887 msgid "being present but empty"
32891 #: ../src/guestfs.pod:1174
32892 msgid "being much larger than normal"
32896 #: ../src/guestfs.pod:1178
32897 msgid "containing arbitrary 8 bit data"
32901 #: ../src/guestfs.pod:1182
32902 msgid "being in an unexpected character encoding"
32906 #: ../src/guestfs.pod:1186
32907 msgid "containing homoglyphs."
32911 #: ../src/guestfs.pod:1190
32912 msgid "SECURITY OF MOUNTING FILESYSTEMS"
32916 #: ../src/guestfs.pod:1192
32918 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
32919 "(VFS) module can sometimes be escalated into exploits by deliberately "
32920 "creating a malicious, malformed filesystem. These exploits are very severe "
32921 "for two reasons. Firstly there are very many filesystem drivers in the "
32922 "kernel, and many of them are infrequently used and not much developer "
32923 "attention has been paid to the code. Linux userspace helps potential "
32924 "crackers by detecting the filesystem type and automatically choosing the "
32925 "right VFS driver, even if that filesystem type is obscure or unexpected for "
32926 "the administrator. Secondly, a kernel-level exploit is like a local root "
32927 "exploit (worse in some ways), giving immediate and total access to the "
32928 "system right down to the hardware level."
32932 #: ../src/guestfs.pod:1205
32934 "That explains why you should never mount a filesystem from an untrusted "
32935 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
32936 "inside a qemu virtual machine, usually running as a non-root user. The "
32937 "attacker would need to write a filesystem which first exploited the kernel, "
32938 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
32939 "the libguestfs protocol, and finally to be as serious as the host kernel "
32940 "exploit it would need to escalate its privileges to root. This multi-step "
32941 "escalation, performed by a static piece of data, is thought to be extremely "
32942 "hard to do, although we never say 'never' about security issues."
32946 #: ../src/guestfs.pod:1216
32948 "In any case callers can reduce the attack surface by forcing the filesystem "
32949 "type when mounting (use L</guestfs_mount_vfs>)."
32953 #: ../src/guestfs.pod:1219
32954 msgid "PROTOCOL SECURITY"
32958 #: ../src/guestfs.pod:1221
32960 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
32961 "defined upper message size. However a program that uses libguestfs must "
32962 "also take care - for example you can write a program that downloads a binary "
32963 "from a disk image and executes it locally, and no amount of protocol "
32964 "security will save you from the consequences."
32968 #: ../src/guestfs.pod:1227
32969 msgid "INSPECTION SECURITY"
32973 #: ../src/guestfs.pod:1229
32975 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
32976 "directly from the guest, and these could contain any 8 bit data. Callers "
32977 "should be careful to escape these before printing them to a structured file "
32978 "(for example, use HTML escaping if creating a web page)."
32982 #: ../src/guestfs.pod:1235
32984 "Guest configuration may be altered in unusual ways by the administrator of "
32985 "the virtual machine, and may not reflect reality (particularly for untrusted "
32986 "or actively malicious guests). For example we parse the hostname from "
32987 "configuration files like C</etc/sysconfig/network> that we find in the "
32988 "guest, but the guest administrator can easily manipulate these files to "
32989 "provide the wrong hostname."
32993 #: ../src/guestfs.pod:1243
32995 "The inspection API parses guest configuration using two external libraries: "
32996 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
32997 "designed to be robust in the face of malicious data, although denial of "
32998 "service attacks are still possible, for example with oversized configuration "
33003 #: ../src/guestfs.pod:1249
33004 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
33008 #: ../src/guestfs.pod:1251
33010 "Be very cautious about running commands from the guest. By running a "
33011 "command in the guest, you are giving CPU time to a binary that you do not "
33012 "control, under the same user account as the library, albeit wrapped in qemu "
33013 "virtualization. More information and alternatives can be found in the "
33014 "section L</RUNNING COMMANDS>."
33018 #: ../src/guestfs.pod:1257
33019 msgid "CVE-2010-3851"
33023 #: ../src/guestfs.pod:1259
33024 msgid "https://bugzilla.redhat.com/642934"
33028 #: ../src/guestfs.pod:1261
33030 "This security bug concerns the automatic disk format detection that qemu "
33031 "does on disk images."
33035 #: ../src/guestfs.pod:1264
33037 "A raw disk image is just the raw bytes, there is no header. Other disk "
33038 "images like qcow2 contain a special header. Qemu deals with this by looking "
33039 "for one of the known headers, and if none is found then assuming the disk "
33040 "image must be raw."
33044 #: ../src/guestfs.pod:1269
33046 "This allows a guest which has been given a raw disk image to write some "
33047 "other header. At next boot (or when the disk image is accessed by "
33048 "libguestfs) qemu would do autodetection and think the disk image format was, "
33049 "say, qcow2 based on the header written by the guest."
33053 #: ../src/guestfs.pod:1274
33055 "This in itself would not be a problem, but qcow2 offers many features, one "
33056 "of which is to allow a disk image to refer to another image (called the "
33057 "\"backing disk\"). It does this by placing the path to the backing disk "
33058 "into the qcow2 header. This path is not validated and could point to any "
33059 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
33060 "\"holes\" in the qcow2 disk image, which of course is completely under the "
33061 "control of the attacker."
33065 #: ../src/guestfs.pod:1282
33066 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
33070 #: ../src/guestfs.pod:1289
33071 msgid "You have enabled the network or have opened the disk in write mode."
33075 #: ../src/guestfs.pod:1293
33077 "You are also running untrusted code from the guest (see L</RUNNING "
33082 #: ../src/guestfs.pod:1298
33084 "The way to avoid this is to specify the expected disk format when adding "
33085 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
33086 "should always do this if the disk is raw format, and it's a good idea for "
33091 #: ../src/guestfs.pod:1303
33093 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
33094 "format is fetched from libvirt and passed through."
33098 #: ../src/guestfs.pod:1306
33100 "For libguestfs tools, use the I<--format> command line parameter as "
33105 #: ../src/guestfs.pod:1309
33106 msgid "CONNECTION MANAGEMENT"
33110 #: ../src/guestfs.pod:1311
33111 msgid "guestfs_h *"
33115 #: ../src/guestfs.pod:1313
33117 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
33118 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
33119 "handle and release all resources used."
33123 #: ../src/guestfs.pod:1317
33125 "For information on using multiple handles and threads, see the section "
33126 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> above."
33130 #: ../src/guestfs.pod:1320
33131 msgid "guestfs_create"
33135 #: ../src/guestfs.pod:1322
33138 " guestfs_h *guestfs_create (void);\n"
33143 #: ../src/guestfs.pod:1324
33144 msgid "Create a connection handle."
33148 #: ../src/guestfs.pod:1326
33150 "On success this returns a non-NULL pointer to a handle. On error it returns "
33155 #: ../src/guestfs.pod:1329
33157 "You have to \"configure\" the handle after creating it. This includes "
33158 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
33159 "handle at least once."
33163 #: ../src/guestfs.pod:1333
33164 msgid "After configuring the handle, you have to call L</guestfs_launch>."
33168 #: ../src/guestfs.pod:1335
33170 "You may also want to configure error handling for the handle. See the "
33171 "L</ERROR HANDLING> section below."
33175 #: ../src/guestfs.pod:1338
33176 msgid "guestfs_close"
33180 #: ../src/guestfs.pod:1340
33183 " void guestfs_close (guestfs_h *g);\n"
33188 #: ../src/guestfs.pod:1342
33189 msgid "This closes the connection handle and frees up all resources used."
33193 #: ../src/guestfs.pod:1344
33195 "If autosync was set on the handle and the handle was launched, then this "
33196 "implicitly calls various functions to unmount filesystems and sync the "
33197 "disk. See L</guestfs_set_autosync> for more details."
33201 #: ../src/guestfs.pod:1348
33202 msgid "If a close callback was set on the handle, then it is called."
33206 #: ../src/guestfs.pod:1350
33207 msgid "ERROR HANDLING"
33211 #: ../src/guestfs.pod:1352
33213 "API functions can return errors. For example, almost all functions that "
33214 "return C<int> will return C<-1> to indicate an error."
33218 #: ../src/guestfs.pod:1355
33220 "Additional information is available for errors: an error message string and "
33221 "optionally an error number (errno) if the thing that failed was a system "
33226 #: ../src/guestfs.pod:1359
33228 "You can get at the additional information about the last error on the handle "
33229 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
33230 "up an error handler with L</guestfs_set_error_handler>."
33234 #: ../src/guestfs.pod:1364
33236 "When the handle is created, a default error handler is installed which "
33237 "prints the error message string to C<stderr>. For small short-running "
33238 "command line programs it is sufficient to do:"
33242 #: ../src/guestfs.pod:1368
33245 " if (guestfs_launch (g) == -1)\n"
33246 " exit (EXIT_FAILURE);\n"
33251 #: ../src/guestfs.pod:1371
33253 "since the default error handler will ensure that an error message has been "
33254 "printed to C<stderr> before the program exits."
33258 #: ../src/guestfs.pod:1374
33260 "For other programs the caller will almost certainly want to install an "
33261 "alternate error handler or do error handling in-line like this:"
33265 #: ../src/guestfs.pod:1377
33268 " /* This disables the default behaviour of printing errors\n"
33270 " guestfs_set_error_handler (g, NULL, NULL);\n"
33275 #: ../src/guestfs.pod:1381
33278 " if (guestfs_launch (g) == -1) {\n"
33279 " /* Examine the error message and print it etc. */\n"
33280 " char *msg = guestfs_last_error (g);\n"
33281 " int errnum = guestfs_last_errno (g);\n"
33282 " fprintf (stderr, \"%s\", msg);\n"
33283 " if (errnum != 0)\n"
33284 " fprintf (stderr, \": %s\", strerror (errnum));\n"
33285 " fprintf (stderr, \"\\n\");\n"
33292 #: ../src/guestfs.pod:1392
33294 "Out of memory errors are handled differently. The default action is to call "
33295 "L<abort(3)>. If this is undesirable, then you can set a handler using "
33296 "L</guestfs_set_out_of_memory_handler>."
33300 #: ../src/guestfs.pod:1396
33302 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
33303 "because there is no handle if this happens there is no way to get additional "
33304 "error information. However L</guestfs_create> is supposed to be a "
33305 "lightweight operation which can only fail because of insufficient memory (it "
33306 "returns NULL in this case)."
33310 #: ../src/guestfs.pod:1402
33311 msgid "guestfs_last_error"
33315 #: ../src/guestfs.pod:1404
33318 " const char *guestfs_last_error (guestfs_h *g);\n"
33323 #: ../src/guestfs.pod:1406
33325 "This returns the last error message that happened on C<g>. If there has not "
33326 "been an error since the handle was created, then this returns C<NULL>."
33330 #: ../src/guestfs.pod:1410
33332 "The lifetime of the returned string is until the next error occurs, or "
33333 "L</guestfs_close> is called."
33337 #: ../src/guestfs.pod:1413
33338 msgid "guestfs_last_errno"
33342 #: ../src/guestfs.pod:1415
33345 " int guestfs_last_errno (guestfs_h *g);\n"
33350 #: ../src/guestfs.pod:1417
33351 msgid "This returns the last error number (errno) that happened on C<g>."
33355 #: ../src/guestfs.pod:1419
33356 msgid "If successful, an errno integer not equal to zero is returned."
33360 #: ../src/guestfs.pod:1421
33361 msgid "If no error, this returns 0. This call can return 0 in three situations:"
33365 #: ../src/guestfs.pod:1428
33366 msgid "There has not been any error on the handle."
33370 #: ../src/guestfs.pod:1432
33372 "There has been an error but the errno was meaningless. This corresponds to "
33373 "the case where the error did not come from a failed system call, but for "
33374 "some other reason."
33378 #: ../src/guestfs.pod:1438
33380 "There was an error from a failed system call, but for some reason the errno "
33381 "was not captured and returned. This usually indicates a bug in libguestfs."
33385 #: ../src/guestfs.pod:1444
33387 "Libguestfs tries to convert the errno from inside the applicance into a "
33388 "corresponding errno for the caller (not entirely trivial: the appliance "
33389 "might be running a completely different operating system from the library "
33390 "and error numbers are not standardized across Un*xen). If this could not be "
33391 "done, then the error is translated to C<EINVAL>. In practice this should "
33392 "only happen in very rare circumstances."
33396 #: ../src/guestfs.pod:1452
33397 msgid "guestfs_set_error_handler"
33401 #: ../src/guestfs.pod:1454
33404 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
33406 " const char *msg);\n"
33407 " void guestfs_set_error_handler (guestfs_h *g,\n"
33408 " guestfs_error_handler_cb cb,\n"
33409 " void *opaque);\n"
33414 #: ../src/guestfs.pod:1461
33416 "The callback C<cb> will be called if there is an error. The parameters "
33417 "passed to the callback are an opaque data pointer and the error message "
33422 #: ../src/guestfs.pod:1465
33424 "C<errno> is not passed to the callback. To get that the callback must call "
33425 "L</guestfs_last_errno>."
33429 #: ../src/guestfs.pod:1468
33431 "Note that the message string C<msg> is freed as soon as the callback "
33432 "function returns, so if you want to stash it somewhere you must make your "
33437 #: ../src/guestfs.pod:1472
33438 msgid "The default handler prints messages on C<stderr>."
33442 #: ../src/guestfs.pod:1474
33443 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
33447 #: ../src/guestfs.pod:1476
33448 msgid "guestfs_get_error_handler"
33452 #: ../src/guestfs.pod:1478
33455 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
33456 " void **opaque_rtn);\n"
33461 #: ../src/guestfs.pod:1481
33462 msgid "Returns the current error handler callback."
33466 #: ../src/guestfs.pod:1483
33467 msgid "guestfs_set_out_of_memory_handler"
33471 #: ../src/guestfs.pod:1485
33474 " typedef void (*guestfs_abort_cb) (void);\n"
33475 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
33476 " guestfs_abort_cb);\n"
33481 #: ../src/guestfs.pod:1489
33483 "The callback C<cb> will be called if there is an out of memory situation. "
33484 "I<Note this callback must not return>."
33488 #: ../src/guestfs.pod:1492
33489 msgid "The default is to call L<abort(3)>."
33493 #: ../src/guestfs.pod:1494
33494 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
33498 #: ../src/guestfs.pod:1497
33499 msgid "guestfs_get_out_of_memory_handler"
33503 #: ../src/guestfs.pod:1499
33506 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
33511 #: ../src/guestfs.pod:1501
33512 msgid "This returns the current out of memory handler."
33516 #: ../src/guestfs.pod:1503
33521 #: ../src/guestfs.pod:1507
33526 #: ../src/guestfs.pod:1509
33531 #: ../src/guestfs.pod:1511
33532 msgid "AVAILABILITY"
33536 #: ../src/guestfs.pod:1513
33537 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
33541 #: ../src/guestfs.pod:1515
33543 "Using L</guestfs_available> you can test availability of the following "
33544 "groups of functions. This test queries the appliance to see if the "
33545 "appliance you are currently using supports the functionality."
33549 #: ../src/guestfs.pod:1520
33550 msgid "@AVAILABILITY@"
33554 #: ../src/guestfs.pod:1522
33555 msgid "GUESTFISH supported COMMAND"
33559 #: ../src/guestfs.pod:1524
33561 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
33562 "prints out the available groups and whether they are supported by this build "
33563 "of libguestfs. Note however that you have to do C<run> first."
33567 #: ../src/guestfs.pod:1529
33568 msgid "SINGLE CALLS AT COMPILE TIME"
33572 #: ../src/guestfs.pod:1531
33574 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
33575 "function, such as:"
33579 #: ../src/guestfs.pod:1534
33582 " #define LIBGUESTFS_HAVE_DD 1\n"
33587 #: ../src/guestfs.pod:1536
33588 msgid "if L</guestfs_dd> is available."
33592 #: ../src/guestfs.pod:1538
33594 "Before version 1.5.8, if you needed to test whether a single libguestfs "
33595 "function is available at compile time, we recommended using build tools such "
33596 "as autoconf or cmake. For example in autotools you could use:"
33600 #: ../src/guestfs.pod:1543
33603 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
33604 " AC_CHECK_FUNCS([guestfs_dd])\n"
33609 #: ../src/guestfs.pod:1546
33611 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
33616 #: ../src/guestfs.pod:1549
33617 msgid "SINGLE CALLS AT RUN TIME"
33621 #: ../src/guestfs.pod:1551
33623 "Testing at compile time doesn't guarantee that a function really exists in "
33624 "the library. The reason is that you might be dynamically linked against a "
33625 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
33626 "This situation unfortunately results in a segmentation fault, which is a "
33627 "shortcoming of the C dynamic linking system itself."
33631 #: ../src/guestfs.pod:1558
33633 "You can use L<dlopen(3)> to test if a function is available at run time, as "
33634 "in this example program (note that you still need the compile time check as "
33639 #: ../src/guestfs.pod:1562
33642 " #include <stdio.h>\n"
33643 " #include <stdlib.h>\n"
33644 " #include <unistd.h>\n"
33645 " #include <dlfcn.h>\n"
33646 " #include <guestfs.h>\n"
33651 #: ../src/guestfs.pod:1568
33656 " #ifdef LIBGUESTFS_HAVE_DD\n"
33658 " int has_function;\n"
33663 #: ../src/guestfs.pod:1574
33666 " /* Test if the function guestfs_dd is really available. */\n"
33667 " dl = dlopen (NULL, RTLD_LAZY);\n"
33669 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
33670 " exit (EXIT_FAILURE);\n"
33672 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
33678 #: ../src/guestfs.pod:1583
33681 " if (!has_function)\n"
33682 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
33684 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
33685 " /* Now it's safe to call\n"
33686 " guestfs_dd (g, \"foo\", \"bar\");\n"
33690 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
33697 #: ../src/guestfs.pod:1596
33699 "You may think the above is an awful lot of hassle, and it is. There are "
33700 "other ways outside of the C linking system to ensure that this kind of "
33701 "incompatibility never arises, such as using package versioning:"
33705 #: ../src/guestfs.pod:1601
33708 " Requires: libguestfs >= 1.0.80\n"
33713 #: ../src/guestfs.pod:1603
33714 msgid "CALLS WITH OPTIONAL ARGUMENTS"
33718 #: ../src/guestfs.pod:1605
33720 "A recent feature of the API is the introduction of calls which take optional "
33721 "arguments. In C these are declared 3 ways. The main way is as a call which "
33722 "takes variable arguments (ie. C<...>), as in this example:"
33726 #: ../src/guestfs.pod:1610
33729 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
33734 #: ../src/guestfs.pod:1612
33736 "Call this with a list of optional arguments, terminated by C<-1>. So to "
33737 "call with no optional arguments specified:"
33741 #: ../src/guestfs.pod:1615
33744 " guestfs_add_drive_opts (g, filename, -1);\n"
33749 #: ../src/guestfs.pod:1617
33750 msgid "With a single optional argument:"
33754 #: ../src/guestfs.pod:1619
33757 " guestfs_add_drive_opts (g, filename,\n"
33758 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33764 #: ../src/guestfs.pod:1623
33769 #: ../src/guestfs.pod:1625
33772 " guestfs_add_drive_opts (g, filename,\n"
33773 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33774 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
33780 #: ../src/guestfs.pod:1630
33782 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
33787 #: ../src/guestfs.pod:1633
33788 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
33792 #: ../src/guestfs.pod:1635
33794 "The second variant has the same name with the suffix C<_va>, which works the "
33795 "same way but takes a C<va_list>. See the C manual for details. For the "
33796 "example function, this is declared:"
33800 #: ../src/guestfs.pod:1639
33803 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
33804 " va_list args);\n"
33809 #: ../src/guestfs.pod:1642
33810 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
33814 #: ../src/guestfs.pod:1644
33816 "The third variant is useful where you need to construct these calls. You "
33817 "pass in a structure where you fill in the optional fields. The structure "
33818 "has a bitmask as the first element which you must set to indicate which "
33819 "fields you have filled in. For our example function the structure and call "
33824 #: ../src/guestfs.pod:1650
33827 " struct guestfs_add_drive_opts_argv {\n"
33828 " uint64_t bitmask;\n"
33830 " const char *format;\n"
33833 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
33834 " const struct guestfs_add_drive_opts_argv *optargs);\n"
33839 #: ../src/guestfs.pod:1659
33840 msgid "You could call it like this:"
33844 #: ../src/guestfs.pod:1661
33847 " struct guestfs_add_drive_opts_argv optargs = {\n"
33848 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
33849 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
33850 " .readonly = 1,\n"
33851 " .format = \"qcow2\"\n"
33857 #: ../src/guestfs.pod:1668
33860 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
33865 #: ../src/guestfs.pod:1676
33866 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
33870 #: ../src/guestfs.pod:1681
33871 msgid "You do not need to fill in all fields of the structure."
33875 #: ../src/guestfs.pod:1685
33877 "There must be a one-to-one correspondence between fields of the structure "
33878 "that are filled in, and bits set in the bitmask."
33882 #: ../src/guestfs.pod:1690
33883 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
33887 #: ../src/guestfs.pod:1692
33889 "In other languages, optional arguments are expressed in the way that is "
33890 "natural for that language. We refer you to the language-specific "
33891 "documentation for more details on that."
33895 #: ../src/guestfs.pod:1696
33896 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
33900 #: ../src/guestfs.pod:1698
33901 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
33905 #: ../src/guestfs.pod:1700
33907 "B<Note:> This section documents the generic event mechanism introduced in "
33908 "libguestfs 1.10, which you should use in new code if possible. The old "
33909 "functions C<guestfs_set_log_message_callback>, "
33910 "C<guestfs_set_subprocess_quit_callback>, "
33911 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
33912 "C<guestfs_set_progress_callback> are no longer documented in this manual "
33913 "page. Because of the ABI guarantee, the old functions continue to work."
33917 #: ../src/guestfs.pod:1709
33919 "Handles generate events when certain things happen, such as log messages "
33920 "being generated, progress messages during long-running operations, or the "
33921 "handle being closed. The API calls described below let you register a "
33922 "callback to be called when events happen. You can register multiple "
33923 "callbacks (for the same, different or overlapping sets of events), and "
33924 "individually remove callbacks. If callbacks are not removed, then they "
33925 "remain in force until the handle is closed."
33929 #: ../src/guestfs.pod:1717
33931 "In the current implementation, events are only generated synchronously: that "
33932 "means that events (and hence callbacks) can only happen while you are in the "
33933 "middle of making another libguestfs call. The callback is called in the "
33938 #: ../src/guestfs.pod:1722
33940 "Events may contain a payload, usually nothing (void), an array of 64 bit "
33941 "unsigned integers, or a message buffer. Payloads are discussed later on."
33945 #: ../src/guestfs.pod:1726
33946 msgid "CLASSES OF EVENTS"
33950 #: ../src/guestfs.pod:1730
33951 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
33955 #: ../src/guestfs.pod:1733
33957 "The callback function will be called while the handle is being closed "
33958 "(synchronously from L</guestfs_close>)."
33962 #: ../src/guestfs.pod:1736
33964 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
33965 "handles that are open when the program exits. This means that this callback "
33966 "might be called indirectly from L<exit(3)>, which can cause unexpected "
33967 "problems in higher-level languages (eg. if your HLL interpreter has already "
33968 "been cleaned up by the time this is called, and if your callback then jumps "
33969 "into some HLL function)."
33973 #: ../src/guestfs.pod:1743
33975 "If no callback is registered: the handle is closed without any callback "
33980 #: ../src/guestfs.pod:1746
33981 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
33985 #: ../src/guestfs.pod:1749
33987 "The callback function will be called when the child process quits, either "
33988 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
33989 "corresponds to a transition from any state to the CONFIG state)."
33993 #: ../src/guestfs.pod:1753 ../src/guestfs.pod:1762 ../src/guestfs.pod:1879
33994 msgid "If no callback is registered: the event is ignored."
33998 #: ../src/guestfs.pod:1755
33999 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
34003 #: ../src/guestfs.pod:1758
34005 "The callback function will be called when the child process becomes ready "
34006 "first time after it has been launched. (This corresponds to a transition "
34007 "from LAUNCHING to the READY state)."
34011 #: ../src/guestfs.pod:1764
34012 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
34016 #: ../src/guestfs.pod:1767
34018 "Some long-running operations can generate progress messages. If this "
34019 "callback is registered, then it will be called each time a progress message "
34020 "is generated (usually two seconds after the operation started, and three "
34021 "times per second thereafter until it completes, although the frequency may "
34022 "change in future versions)."
34026 #: ../src/guestfs.pod:1773
34028 "The callback receives in the payload four unsigned 64 bit numbers which are "
34029 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
34033 #: ../src/guestfs.pod:1776
34035 "The units of C<total> are not defined, although for some operations C<total> "
34036 "may relate in some way to the amount of data to be transferred (eg. in bytes "
34037 "or megabytes), and C<position> may be the portion which has been "
34042 #: ../src/guestfs.pod:1781
34043 msgid "The only defined and stable parts of the API are:"
34047 #: ../src/guestfs.pod:1787
34049 "The callback can display to the user some type of progress bar or indicator "
34050 "which shows the ratio of C<position>:C<total>."
34054 #: ../src/guestfs.pod:1792
34055 msgid "0 E<lt>= C<position> E<lt>= C<total>"
34059 #: ../src/guestfs.pod:1796
34061 "If any progress notification is sent during a call, then a final progress "
34062 "notification is always sent when C<position> = C<total> (I<unless> the call "
34063 "fails with an error)."
34067 #: ../src/guestfs.pod:1800
34069 "This is to simplify caller code, so callers can easily set the progress "
34070 "indicator to \"100%\" at the end of the operation, without requiring special "
34071 "code to detect this case."
34075 #: ../src/guestfs.pod:1806
34077 "For some calls we are unable to estimate the progress of the call, but we "
34078 "can still generate progress messages to indicate activity. This is known as "
34079 "\"pulse mode\", and is directly supported by certain progress bar "
34080 "implementations (eg. GtkProgressBar)."
34084 #: ../src/guestfs.pod:1811
34086 "For these calls, zero or more progress messages are generated with "
34087 "C<position = 0> and C<total = 1>, followed by a final message with "
34088 "C<position = total = 1>."
34092 #: ../src/guestfs.pod:1815
34094 "As noted above, if the call fails with an error then the final message may "
34095 "not be generated."
34099 #: ../src/guestfs.pod:1820
34101 "The callback also receives the procedure number (C<proc_nr>) and serial "
34102 "number (C<serial>) of the call. These are only useful for debugging "
34103 "protocol issues, and the callback can normally ignore them. The callback "
34104 "may want to print these numbers in error messages or debugging messages."
34108 #: ../src/guestfs.pod:1826
34109 msgid "If no callback is registered: progress messages are discarded."
34113 #: ../src/guestfs.pod:1828
34114 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
34118 #: ../src/guestfs.pod:1831
34120 "The callback function is called whenever a log message is generated by qemu, "
34121 "the appliance kernel, guestfsd (daemon), or utility programs."
34125 #: ../src/guestfs.pod:1834
34127 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
34128 "(L</guestfs_launch>) then additional debug messages are generated."
34132 #: ../src/guestfs.pod:1837 ../src/guestfs.pod:1851
34134 "If no callback is registered: the messages are discarded unless the verbose "
34135 "flag is set in which case they are sent to stderr. You can override the "
34136 "printing of verbose messages to stderr by setting up a callback."
34140 #: ../src/guestfs.pod:1842
34141 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
34145 #: ../src/guestfs.pod:1845
34147 "The callback function is called whenever a log message is generated by the "
34148 "library part of libguestfs."
34152 #: ../src/guestfs.pod:1848
34154 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
34155 "messages are generated."
34159 #: ../src/guestfs.pod:1856
34160 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
34164 #: ../src/guestfs.pod:1859
34166 "The callback function is called whenever a trace message is generated. This "
34167 "only applies if the trace flag (L</guestfs_set_trace>) is set."
34171 #: ../src/guestfs.pod:1862
34173 "If no callback is registered: the messages are sent to stderr. You can "
34174 "override the printing of trace messages to stderr by setting up a callback."
34178 #: ../src/guestfs.pod:1866
34179 msgid "GUESTFS_EVENT_ENTER (payload type: function name)"
34183 #: ../src/guestfs.pod:1869
34184 msgid "The callback function is called whenever a libguestfs function is entered."
34188 #: ../src/guestfs.pod:1872
34190 "The payload is a string which contains the name of the function that we are "
34191 "entering (not including C<guestfs_> prefix)."
34195 #: ../src/guestfs.pod:1875
34197 "Note that libguestfs functions can call themselves, so you may see many "
34198 "events from a single call. A few libguestfs functions do not generate this "
34203 #: ../src/guestfs.pod:1883
34204 msgid "guestfs_set_event_callback"
34208 #: ../src/guestfs.pod:1885
34211 " int guestfs_set_event_callback (guestfs_h *g,\n"
34212 " guestfs_event_callback cb,\n"
34213 " uint64_t event_bitmask,\n"
34215 " void *opaque);\n"
34220 #: ../src/guestfs.pod:1891
34222 "This function registers a callback (C<cb>) for all event classes in the "
34223 "C<event_bitmask>."
34227 #: ../src/guestfs.pod:1894
34229 "For example, to register for all log message events, you could call this "
34230 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
34231 "To register a single callback for all possible classes of events, use "
34232 "C<GUESTFS_EVENT_ALL>."
34236 #: ../src/guestfs.pod:1900
34237 msgid "C<flags> should always be passed as 0."
34241 #: ../src/guestfs.pod:1902
34243 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
34244 "it for any purpose."
34248 #: ../src/guestfs.pod:1905
34250 "The return value is the event handle (an integer) which you can use to "
34251 "delete the callback (see below)."
34255 #: ../src/guestfs.pod:1908
34257 "If there is an error, this function returns C<-1>, and sets the error in the "
34258 "handle in the usual way (see L</guestfs_last_error> etc.)"
34262 #: ../src/guestfs.pod:1911
34264 "Callbacks remain in effect until they are deleted, or until the handle is "
34269 #: ../src/guestfs.pod:1914
34271 "In the case where multiple callbacks are registered for a particular event "
34272 "class, all of the callbacks are called. The order in which multiple "
34273 "callbacks are called is not defined."
34277 #: ../src/guestfs.pod:1918
34278 msgid "guestfs_delete_event_callback"
34282 #: ../src/guestfs.pod:1920
34285 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
34290 #: ../src/guestfs.pod:1922
34292 "Delete a callback that was previously registered. C<event_handle> should be "
34293 "the integer that was returned by a previous call to "
34294 "C<guestfs_set_event_callback> on the same handle."
34298 #: ../src/guestfs.pod:1926
34299 msgid "guestfs_event_callback"
34303 #: ../src/guestfs.pod:1928
34306 " typedef void (*guestfs_event_callback) (\n"
34309 " uint64_t event,\n"
34310 " int event_handle,\n"
34312 " const char *buf, size_t buf_len,\n"
34313 " const uint64_t *array, size_t array_len);\n"
34318 #: ../src/guestfs.pod:1937
34319 msgid "This is the type of the event callback function that you have to provide."
34323 #: ../src/guestfs.pod:1940
34325 "The basic parameters are: the handle (C<g>), the opaque user pointer "
34326 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
34327 "handle, and C<flags> which in the current API you should ignore."
34331 #: ../src/guestfs.pod:1944
34333 "The remaining parameters contain the event payload (if any). Each event may "
34334 "contain a payload, which usually relates to the event class, but for future "
34335 "proofing your code should be written to handle any payload for any event "
34340 #: ../src/guestfs.pod:1949
34342 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
34343 "there is no message buffer). Note that this message buffer can contain "
34344 "arbitrary 8 bit data, including NUL bytes."
34348 #: ../src/guestfs.pod:1953
34350 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
34351 "moment this is only used for progress messages."
34355 #: ../src/guestfs.pod:1956
34356 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
34360 #: ../src/guestfs.pod:1958
34362 "One motivation for the generic event API was to allow GUI programs to "
34363 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
34364 "unconditionally to C<stderr>."
34368 #: ../src/guestfs.pod:1962
34370 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
34371 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
34372 "messages are not events; you must capture error messages separately)."
34376 #: ../src/guestfs.pod:1967
34378 "Programs have to set up a callback to capture the classes of events of "
34383 #: ../src/guestfs.pod:1970
34387 " guestfs_set_event_callback\n"
34388 " (g, message_callback,\n"
34389 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
34390 " GUESTFS_EVENT_TRACE,\n"
34391 " 0, NULL) == -1)\n"
34392 " if (eh == -1) {\n"
34393 " // handle error in the usual way\n"
34399 #: ../src/guestfs.pod:1980
34401 "The callback can then direct messages to the appropriate place. In this "
34402 "example, messages are directed to syslog:"
34406 #: ../src/guestfs.pod:1983
34410 " message_callback (\n"
34413 " uint64_t event,\n"
34414 " int event_handle,\n"
34416 " const char *buf, size_t buf_len,\n"
34417 " const uint64_t *array, size_t array_len)\n"
34419 " const int priority = LOG_USER|LOG_INFO;\n"
34420 " if (buf_len > 0)\n"
34421 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
34427 #: ../src/guestfs.pod:1998
34428 msgid "CANCELLING LONG TRANSFERS"
34432 #: ../src/guestfs.pod:2000
34434 "Some operations can be cancelled by the caller while they are in progress. "
34435 "Currently only operations that involve uploading or downloading data can be "
34436 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
34437 "parameters in the generator)."
34441 #: ../src/guestfs.pod:2005
34442 msgid "guestfs_user_cancel"
34446 #: ../src/guestfs.pod:2007
34449 " void guestfs_user_cancel (guestfs_h *g);\n"
34454 #: ../src/guestfs.pod:2009
34455 msgid "C<guestfs_user_cancel> cancels the current upload or download operation."
34459 #: ../src/guestfs.pod:2012
34461 "Unlike most other libguestfs calls, this function is signal safe and thread "
34462 "safe. You can call it from a signal handler or from another thread, without "
34463 "needing to do any locking."
34467 #: ../src/guestfs.pod:2016
34469 "The transfer that was in progress (if there is one) will stop shortly "
34470 "afterwards, and will return an error. The errno (see "
34471 "L</guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
34472 "out if the operation was cancelled or failed because of another error."
34476 #: ../src/guestfs.pod:2022
34478 "No cleanup is performed: for example, if a file was being uploaded then "
34479 "after cancellation there may be a partially uploaded file. It is the "
34480 "caller's responsibility to clean up if necessary."
34484 #: ../src/guestfs.pod:2026
34485 msgid "There are two common places that you might call C<guestfs_user_cancel>."
34489 #: ../src/guestfs.pod:2028
34491 "In an interactive text-based program, you might call it from a C<SIGINT> "
34492 "signal handler so that pressing C<^C> cancels the current operation. (You "
34493 "also need to call L</guestfs_set_pgroup> so that child processes don't "
34494 "receive the C<^C> signal)."
34498 #: ../src/guestfs.pod:2033
34500 "In a graphical program, when the main thread is displaying a progress bar "
34501 "with a cancel button, wire up the cancel button to call this function."
34505 #: ../src/guestfs.pod:2037
34506 msgid "PRIVATE DATA AREA"
34510 #: ../src/guestfs.pod:2039
34512 "You can attach named pieces of private data to the libguestfs handle, fetch "
34513 "them by name, and walk over them, for the lifetime of the handle. This is "
34514 "called the private data area and is only available from the C API."
34518 #: ../src/guestfs.pod:2044
34519 msgid "To attach a named piece of data, use the following call:"
34523 #: ../src/guestfs.pod:2046
34526 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
34531 #: ../src/guestfs.pod:2048
34533 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
34534 "pointer (which can be C<NULL>). Any previous item with the same key is "
34539 #: ../src/guestfs.pod:2052
34541 "You can use any C<key> you want, but your key should I<not> start with an "
34542 "underscore character. Keys beginning with an underscore character are "
34543 "reserved for internal libguestfs purposes (eg. for implementing language "
34544 "bindings). It is recommended that you prefix the key with some unique "
34545 "string to avoid collisions with other users."
34549 #: ../src/guestfs.pod:2058
34550 msgid "To retrieve the pointer, use:"
34554 #: ../src/guestfs.pod:2060
34557 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
34562 #: ../src/guestfs.pod:2062
34564 "This function returns C<NULL> if either no data is found associated with "
34565 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
34570 #: ../src/guestfs.pod:2066
34572 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
34573 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
34574 "all. In particular, libguestfs does I<not> try to free the data when the "
34575 "handle is closed. If the data must be freed, then the caller must either "
34576 "free it before calling L</guestfs_close> or must set up a close callback to "
34577 "do it (see L</GUESTFS_EVENT_CLOSE>)."
34581 #: ../src/guestfs.pod:2073
34582 msgid "To walk over all entries, use these two functions:"
34586 #: ../src/guestfs.pod:2075
34589 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
34594 #: ../src/guestfs.pod:2077
34597 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
34602 #: ../src/guestfs.pod:2079
34604 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
34605 "not have any particular meaning -- keys are not returned in any defined "
34606 "order). A pointer to the key is returned in C<*key_rtn> and the "
34607 "corresponding data pointer is returned from the function. C<NULL> is "
34608 "returned if there are no keys stored in the handle."
34612 #: ../src/guestfs.pod:2085
34614 "C<guestfs_next_private> returns the next key, pointer pair. The return "
34615 "value of this function is also C<NULL> is there are no further entries to "
34620 #: ../src/guestfs.pod:2089
34621 msgid "Notes about walking over entries:"
34625 #: ../src/guestfs.pod:2095
34626 msgid "You must not call C<guestfs_set_private> while walking over the entries."
34630 #: ../src/guestfs.pod:2100
34632 "The handle maintains an internal iterator which is reset when you call "
34633 "C<guestfs_first_private>. This internal iterator is invalidated when you "
34634 "call C<guestfs_set_private>."
34638 #: ../src/guestfs.pod:2106
34639 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
34643 #: ../src/guestfs.pod:2108
34646 " guestfs_set_private (g, key, NULL);\n"
34651 #: ../src/guestfs.pod:2110
34652 msgid "then that C<key> is not returned when walking."
34656 #: ../src/guestfs.pod:2114
34658 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
34659 "C<guestfs_next_private> or C<guestfs_set_private>."
34663 #: ../src/guestfs.pod:2120
34665 "The following example code shows how to print all keys and data pointers "
34666 "that are associated with the handle C<g>:"
34670 #: ../src/guestfs.pod:2123
34673 " const char *key;\n"
34674 " void *data = guestfs_first_private (g, &key);\n"
34675 " while (data != NULL)\n"
34677 " printf (\"key = %s, data = %p\\n\", key, data);\n"
34678 " data = guestfs_next_private (g, &key);\n"
34684 #: ../src/guestfs.pod:2131
34686 "More commonly you are only interested in keys that begin with an "
34687 "application-specific prefix C<foo_>. Modify the loop like so:"
34691 #: ../src/guestfs.pod:2134
34694 " const char *key;\n"
34695 " void *data = guestfs_first_private (g, &key);\n"
34696 " while (data != NULL)\n"
34698 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
34699 " printf (\"key = %s, data = %p\\n\", key, data);\n"
34700 " data = guestfs_next_private (g, &key);\n"
34706 #: ../src/guestfs.pod:2143
34708 "If you need to modify keys while walking, then you have to jump back to the "
34709 "beginning of the loop. For example, to delete all keys prefixed with "
34714 #: ../src/guestfs.pod:2147
34717 " const char *key;\n"
34720 " data = guestfs_first_private (g, &key);\n"
34721 " while (data != NULL)\n"
34723 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
34725 " guestfs_set_private (g, key, NULL);\n"
34726 " /* note that 'key' pointer is now invalid, and so is\n"
34727 " the internal iterator */\n"
34730 " data = guestfs_next_private (g, &key);\n"
34736 #: ../src/guestfs.pod:2163
34738 "Note that the above loop is guaranteed to terminate because the keys are "
34739 "being deleted, but other manipulations of keys within the loop might not "
34740 "terminate unless you also maintain an indication of which keys have been "
34745 #: ../src/guestfs.pod:2168 ../src/guestfs.pod:2173
34750 #: ../src/guestfs.pod:2170
34752 "<!-- old anchor for the next section --> <a "
34753 "name=\"state_machine_and_low_level_event_api\"/>"
34757 #: ../src/guestfs.pod:2175
34758 msgid "ARCHITECTURE"
34762 #: ../src/guestfs.pod:2177
34764 "Internally, libguestfs is implemented by running an appliance (a special "
34765 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
34766 "process of the main program."
34770 #: ../src/guestfs.pod:2181
34773 " ___________________\n"
34775 " | main program |\n"
34777 " | | child process / appliance\n"
34778 " | | __________________________\n"
34780 " +-------------------+ RPC | +-----------------+ |\n"
34781 " | libguestfs <--------------------> guestfsd | |\n"
34782 " | | | +-----------------+ |\n"
34783 " \\___________________/ | | Linux kernel | |\n"
34784 " | +--^--------------+ |\n"
34785 " \\_________|________________/\n"
34787 " _______v______\n"
34790 " | disk image |\n"
34791 " \\______________/\n"
34796 #: ../src/guestfs.pod:2201
34798 "The library, linked to the main program, creates the child process and hence "
34799 "the appliance in the L</guestfs_launch> function."
34803 #: ../src/guestfs.pod:2204
34805 "Inside the appliance is a Linux kernel and a complete stack of userspace "
34806 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
34807 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
34808 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
34809 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
34810 "attached to the qemu process which translates device access by the "
34811 "appliance's Linux kernel into accesses to the image."
34815 #: ../src/guestfs.pod:2213
34817 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
34818 "Although the disk image you are attached to might also be used by some "
34819 "virtual machine, libguestfs doesn't know or care about this. (But you will "
34820 "care if both libguestfs's qemu process and your virtual machine are trying "
34821 "to update the disk image at the same time, since these usually results in "
34822 "massive disk corruption)."
34826 #: ../src/guestfs.pod:2220
34827 msgid "STATE MACHINE"
34831 #: ../src/guestfs.pod:2222
34832 msgid "libguestfs uses a state machine to model the child process:"
34836 #: ../src/guestfs.pod:2224
34840 " guestfs_create\n"
34848 " / | \\ \\ guestfs_launch\n"
34849 " / | _\\__V______\n"
34851 " / | | LAUNCHING |\n"
34852 " / | \\___________/\n"
34854 " / | guestfs_launch\n"
34856 " ______ / __|____V\n"
34857 " / \\ ------> / \\\n"
34858 " | BUSY | | READY |\n"
34859 " \\______/ <------ \\________/\n"
34864 #: ../src/guestfs.pod:2246
34866 "The normal transitions are (1) CONFIG (when the handle is created, but there "
34867 "is no child process), (2) LAUNCHING (when the child process is booting up), "
34868 "(3) alternating between READY and BUSY as commands are issued to, and "
34869 "carried out by, the child process."
34873 #: ../src/guestfs.pod:2251
34875 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
34876 "asynchronously at any time (eg. due to some internal error), and that causes "
34877 "the state to transition back to CONFIG."
34881 #: ../src/guestfs.pod:2255
34883 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
34884 "issued when in the CONFIG state."
34888 #: ../src/guestfs.pod:2258
34890 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
34891 "L</guestfs_launch> blocks until the child process is READY to accept "
34892 "commands (or until some failure or timeout). L</guestfs_launch> internally "
34893 "moves the state from CONFIG to LAUNCHING while it is running."
34897 #: ../src/guestfs.pod:2264
34899 "API actions such as L</guestfs_mount> can only be issued when in the READY "
34900 "state. These API calls block waiting for the command to be carried out "
34901 "(ie. the state to transition to BUSY and then back to READY). There are no "
34902 "non-blocking versions, and no way to issue more than one command per handle "
34903 "at the same time."
34907 #: ../src/guestfs.pod:2270
34909 "Finally, the child process sends asynchronous messages back to the main "
34910 "program, such as kernel log messages. You can register a callback to "
34911 "receive these messages."
34915 #: ../src/guestfs.pod:2274
34920 #: ../src/guestfs.pod:2276
34921 msgid "APPLIANCE BOOT PROCESS"
34925 #: ../src/guestfs.pod:2278
34927 "This process has evolved and continues to evolve. The description here "
34928 "corresponds only to the current version of libguestfs and is provided for "
34929 "information only."
34933 #: ../src/guestfs.pod:2282
34935 "In order to follow the stages involved below, enable libguestfs debugging "
34936 "(set the environment variable C<LIBGUESTFS_DEBUG=1>)."
34940 #: ../src/guestfs.pod:2287
34941 msgid "Create the appliance"
34945 #: ../src/guestfs.pod:2289
34947 "C<febootstrap-supermin-helper> is invoked to create the kernel, a small "
34948 "initrd and the appliance."
34952 #: ../src/guestfs.pod:2292
34954 "The appliance is cached in C</var/tmp/.guestfs-E<lt>UIDE<gt>> (or in another "
34955 "directory if C<TMPDIR> is set)."
34959 #: ../src/guestfs.pod:2295
34961 "For a complete description of how the appliance is created and cached, read "
34962 "the L<febootstrap(8)> and L<febootstrap-supermin-helper(8)> man pages."
34966 #: ../src/guestfs.pod:2299
34967 msgid "Start qemu and boot the kernel"
34971 #: ../src/guestfs.pod:2301
34972 msgid "qemu is invoked to boot the kernel."
34976 #: ../src/guestfs.pod:2303
34977 msgid "Run the initrd"
34981 #: ../src/guestfs.pod:2305
34983 "C<febootstrap-supermin-helper> builds a small initrd. The initrd is not the "
34984 "appliance. The purpose of the initrd is to load enough kernel modules in "
34985 "order that the appliance itself can be mounted and started."
34989 #: ../src/guestfs.pod:2309
34991 "The initrd is a cpio archive called "
34992 "C</var/tmp/.guestfs-E<lt>UIDE<gt>/initrd>."
34996 #: ../src/guestfs.pod:2312
34998 "When the initrd has started you will see messages showing that kernel "
34999 "modules are being loaded, similar to this:"
35003 #: ../src/guestfs.pod:2315
35006 " febootstrap: ext2 mini initrd starting up\n"
35007 " febootstrap: mounting /sys\n"
35008 " febootstrap: internal insmod libcrc32c.ko\n"
35009 " febootstrap: internal insmod crc32c-intel.ko\n"
35014 #: ../src/guestfs.pod:2320
35015 msgid "Find and mount the appliance device"
35019 #: ../src/guestfs.pod:2322
35021 "The appliance is a sparse file containing an ext2 filesystem which contains "
35022 "a familiar (although reduced in size) Linux operating system. It would "
35023 "normally be called C</var/tmp/.guestfs-E<lt>UIDE<gt>/root>."
35027 #: ../src/guestfs.pod:2326
35029 "The regular disks being inspected by libguestfs are the first devices "
35030 "exposed by qemu (eg. as C</dev/vda>)."
35034 #: ../src/guestfs.pod:2329
35036 "The last disk added to qemu is the appliance itself (eg. C</dev/vdb> if "
35037 "there was only one regular disk)."
35041 #: ../src/guestfs.pod:2332
35043 "Thus the final job of the initrd is to locate the appliance disk, mount it, "
35044 "and switch root into the appliance, and run C</init> from the appliance."
35048 #: ../src/guestfs.pod:2336
35049 msgid "If this works successfully you will see messages such as:"
35053 #: ../src/guestfs.pod:2338
35056 " febootstrap: picked /sys/block/vdb/dev as root device\n"
35057 " febootstrap: creating /dev/root as block special 252:16\n"
35058 " febootstrap: mounting new root on /root\n"
35059 " febootstrap: chroot\n"
35060 " Starting /init script ...\n"
35065 #: ../src/guestfs.pod:2344
35067 "Note that C<Starting /init script ...> indicates that the appliance's init "
35068 "script is now running."
35072 #: ../src/guestfs.pod:2347
35073 msgid "Initialize the appliance"
35077 #: ../src/guestfs.pod:2349
35079 "The appliance itself now initializes itself. This involves starting certain "
35080 "processes like C<udev>, possibly printing some debug information, and "
35081 "finally running the daemon (C<guestfsd>)."
35085 #: ../src/guestfs.pod:2353
35090 #: ../src/guestfs.pod:2355
35092 "Finally the daemon (C<guestfsd>) runs inside the appliance. If it runs you "
35097 #: ../src/guestfs.pod:2358
35100 " verbose daemon enabled\n"
35105 #: ../src/guestfs.pod:2360
35107 "The daemon expects to see a named virtio-serial port exposed by qemu and "
35108 "connected on the other end to the library."
35112 #: ../src/guestfs.pod:2363
35114 "The daemon connects to this port (and hence to the library) and sends a four "
35115 "byte message C<GUESTFS_LAUNCH_FLAG>, which initiates the communication "
35116 "protocol (see below)."
35120 #: ../src/guestfs.pod:2369
35121 msgid "COMMUNICATION PROTOCOL"
35125 #: ../src/guestfs.pod:2371
35127 "Don't rely on using this protocol directly. This section documents how it "
35128 "currently works, but it may change at any time."
35132 #: ../src/guestfs.pod:2374
35134 "The protocol used to talk between the library and the daemon running inside "
35135 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
35136 "1014, RFC 1832, RFC 4506)."
35140 #: ../src/guestfs.pod:2378
35142 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
35143 "this file is automatically generated)."
35147 #: ../src/guestfs.pod:2381
35149 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
35150 "and C<FileOut> parameters, which are handled with very simple request/reply "
35151 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
35152 "parameters, which use the same request and reply messages, but they may also "
35153 "be followed by files sent using a chunked encoding."
35157 #: ../src/guestfs.pod:2388
35158 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
35162 #: ../src/guestfs.pod:2390
35163 msgid "For ordinary functions, the request message is:"
35167 #: ../src/guestfs.pod:2392
35170 " total length (header + arguments,\n"
35171 " but not including the length word itself)\n"
35172 " struct guestfs_message_header (encoded as XDR)\n"
35173 " struct guestfs_<foo>_args (encoded as XDR)\n"
35178 #: ../src/guestfs.pod:2397
35180 "The total length field allows the daemon to allocate a fixed size buffer "
35181 "into which it slurps the rest of the message. As a result, the total length "
35182 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
35183 "effective size of any request is limited to somewhere under this size."
35187 #: ../src/guestfs.pod:2403
35189 "Note also that many functions don't take any arguments, in which case the "
35190 "C<guestfs_I<foo>_args> is completely omitted."
35194 #: ../src/guestfs.pod:2406
35196 "The header contains the procedure number (C<guestfs_proc>) which is how the "
35197 "receiver knows what type of args structure to expect, or none at all."
35201 #: ../src/guestfs.pod:2410
35203 "For functions that take optional arguments, the optional arguments are "
35204 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
35205 "arguments. A bitmask in the header indicates which optional arguments are "
35206 "meaningful. The bitmask is also checked to see if it contains bits set "
35207 "which the daemon does not know about (eg. if more optional arguments were "
35208 "added in a later version of the library), and this causes the call to be "
35213 #: ../src/guestfs.pod:2418
35214 msgid "The reply message for ordinary functions is:"
35218 #: ../src/guestfs.pod:2420
35221 " total length (header + ret,\n"
35222 " but not including the length word itself)\n"
35223 " struct guestfs_message_header (encoded as XDR)\n"
35224 " struct guestfs_<foo>_ret (encoded as XDR)\n"
35229 #: ../src/guestfs.pod:2425
35231 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
35232 "functions that return no formal return values."
35236 #: ../src/guestfs.pod:2428
35237 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
35241 #: ../src/guestfs.pod:2431
35243 "In the case of an error, a flag is set in the header, and the reply message "
35244 "is slightly changed:"
35248 #: ../src/guestfs.pod:2434
35251 " total length (header + error,\n"
35252 " but not including the length word itself)\n"
35253 " struct guestfs_message_header (encoded as XDR)\n"
35254 " struct guestfs_message_error (encoded as XDR)\n"
35259 #: ../src/guestfs.pod:2439
35261 "The C<guestfs_message_error> structure contains the error message as a "
35266 #: ../src/guestfs.pod:2442
35267 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
35271 #: ../src/guestfs.pod:2444
35273 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
35274 "The normal request message is sent (see above). However this is followed by "
35275 "a sequence of file chunks."
35279 #: ../src/guestfs.pod:2448
35282 " total length (header + arguments,\n"
35283 " but not including the length word itself,\n"
35284 " and not including the chunks)\n"
35285 " struct guestfs_message_header (encoded as XDR)\n"
35286 " struct guestfs_<foo>_args (encoded as XDR)\n"
35287 " sequence of chunks for FileIn param #0\n"
35288 " sequence of chunks for FileIn param #1 etc.\n"
35293 #: ../src/guestfs.pod:2456
35294 msgid "The \"sequence of chunks\" is:"
35298 #: ../src/guestfs.pod:2458
35301 " length of chunk (not including length word itself)\n"
35302 " struct guestfs_chunk (encoded as XDR)\n"
35303 " length of chunk\n"
35304 " struct guestfs_chunk (encoded as XDR)\n"
35306 " length of chunk\n"
35307 " struct guestfs_chunk (with data.data_len == 0)\n"
35312 #: ../src/guestfs.pod:2466
35314 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
35315 "is set in the final chunk to indicate either successful completion or early "
35320 #: ../src/guestfs.pod:2470
35322 "At time of writing there are no functions that have more than one FileIn "
35323 "parameter. However this is (theoretically) supported, by sending the "
35324 "sequence of chunks for each FileIn parameter one after another (from left to "
35329 #: ../src/guestfs.pod:2475
35331 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
35332 "transfer. The library does this by sending a chunk with a special flag set "
35333 "to indicate cancellation. When the daemon sees this, it cancels the whole "
35334 "RPC, does I<not> send any reply, and goes back to reading the next request."
35338 #: ../src/guestfs.pod:2481
35340 "The daemon may also cancel. It does this by writing a special word "
35341 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
35342 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
35343 "cancel chunk). The special word is chosen so that even if cancellation "
35344 "happens right at the end of the transfer (after the library has finished "
35345 "writing and has started listening for the reply), the \"spurious\" cancel "
35346 "flag will not be confused with the reply message."
35350 #: ../src/guestfs.pod:2490
35352 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
35353 "limit), and also files where the size is not known in advance (eg. from "
35354 "pipes or sockets). However the chunks are rather small "
35355 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
35356 "to keep much in memory."
35360 #: ../src/guestfs.pod:2496
35361 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
35365 #: ../src/guestfs.pod:2498
35367 "The protocol for FileOut parameters is exactly the same as for FileIn "
35368 "parameters, but with the roles of daemon and library reversed."
35372 #: ../src/guestfs.pod:2501
35375 " total length (header + ret,\n"
35376 " but not including the length word itself,\n"
35377 " and not including the chunks)\n"
35378 " struct guestfs_message_header (encoded as XDR)\n"
35379 " struct guestfs_<foo>_ret (encoded as XDR)\n"
35380 " sequence of chunks for FileOut param #0\n"
35381 " sequence of chunks for FileOut param #1 etc.\n"
35386 #: ../src/guestfs.pod:2509
35387 msgid "INITIAL MESSAGE"
35391 #: ../src/guestfs.pod:2511
35393 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
35394 "which indicates that the guest and daemon is alive. This is what "
35395 "L</guestfs_launch> waits for."
35399 #: ../src/guestfs.pod:2515
35400 msgid "PROGRESS NOTIFICATION MESSAGES"
35404 #: ../src/guestfs.pod:2517
35406 "The daemon may send progress notification messages at any time. These are "
35407 "distinguished by the normal length word being replaced by "
35408 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
35412 #: ../src/guestfs.pod:2521
35414 "The library turns them into progress callbacks (see "
35415 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
35420 #: ../src/guestfs.pod:2525
35422 "The daemon self-limits the frequency of progress messages it sends (see "
35423 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
35428 #: ../src/guestfs.pod:2529
35429 msgid "LIBGUESTFS VERSION NUMBERS"
35433 #: ../src/guestfs.pod:2531
35435 "Since April 2010, libguestfs has started to make separate development and "
35436 "stable releases, along with corresponding branches in our git repository. "
35437 "These separate releases can be identified by version number:"
35441 #: ../src/guestfs.pod:2536
35444 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
35445 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
35451 " | `-------- sub-version\n"
35453 " `------ always '1' because we don't change the ABI\n"
35458 #: ../src/guestfs.pod:2547
35459 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
35463 #: ../src/guestfs.pod:2549
35465 "As time passes we cherry pick fixes from the development branch and backport "
35466 "those into the stable branch, the effect being that the stable branch should "
35467 "get more stable and less buggy over time. So the stable releases are ideal "
35468 "for people who don't need new features but would just like the software to "
35473 #: ../src/guestfs.pod:2555
35474 msgid "Our criteria for backporting changes are:"
35478 #: ../src/guestfs.pod:2561
35480 "Documentation changes which don't affect any code are backported unless the "
35481 "documentation refers to a future feature which is not in stable."
35485 #: ../src/guestfs.pod:2567
35487 "Bug fixes which are not controversial, fix obvious problems, and have been "
35488 "well tested are backported."
35492 #: ../src/guestfs.pod:2572
35494 "Simple rearrangements of code which shouldn't affect how it works get "
35495 "backported. This is so that the code in the two branches doesn't get too "
35496 "far out of step, allowing us to backport future fixes more easily."
35500 #: ../src/guestfs.pod:2578
35502 "We I<don't> backport new features, new APIs, new tools etc, except in one "
35503 "exceptional case: the new feature is required in order to implement an "
35504 "important bug fix."
35508 #: ../src/guestfs.pod:2584
35510 "A new stable branch starts when we think the new features in development are "
35511 "substantial and compelling enough over the current stable branch to warrant "
35512 "it. When that happens we create new stable and development versions 1.N.0 "
35513 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
35514 "stable at this point, but by backporting fixes from development, that branch "
35515 "will stabilize over time."
35519 #: ../src/guestfs.pod:2592
35520 msgid "EXTENDING LIBGUESTFS"
35524 #: ../src/guestfs.pod:2594
35525 msgid "ADDING A NEW API ACTION"
35529 #: ../src/guestfs.pod:2596
35531 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
35532 "documentation) are generated, and this makes it easy to extend the "
35537 #: ../src/guestfs.pod:2600
35538 msgid "To add a new API action there are two changes:"
35542 #: ../src/guestfs.pod:2606
35544 "You need to add a description of the call (name, parameters, return type, "
35545 "tests, documentation) to C<generator/generator_actions.ml>."
35549 #: ../src/guestfs.pod:2609
35551 "There are two sorts of API action, depending on whether the call goes "
35552 "through to the daemon in the appliance, or is serviced entirely by the "
35553 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
35554 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
35555 "an example of the latter, since a trace flag is maintained in the handle and "
35556 "all tracing is done on the library side."
35560 #: ../src/guestfs.pod:2617
35562 "Most new actions are of the first type, and get added to the "
35563 "C<daemon_functions> list. Each function has a unique procedure number used "
35564 "in the RPC protocol which is assigned to that action when we publish "
35565 "libguestfs and cannot be reused. Take the latest procedure number and "
35570 #: ../src/guestfs.pod:2623
35572 "For library-only actions of the second type, add to the "
35573 "C<non_daemon_functions> list. Since these functions are serviced by the "
35574 "library and do not travel over the RPC mechanism to the daemon, these "
35575 "functions do not need a procedure number, and so the procedure number is set "
35580 #: ../src/guestfs.pod:2631
35581 msgid "Implement the action (in C):"
35585 #: ../src/guestfs.pod:2633
35587 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
35588 "C<daemon/> directory."
35592 #: ../src/guestfs.pod:2636
35594 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
35595 "(note: double underscore) in the C<src/> directory."
35599 #: ../src/guestfs.pod:2639
35600 msgid "In either case, use another function as an example of what to do."
35604 #: ../src/guestfs.pod:2643
35605 msgid "After making these changes, use C<make> to compile."
35609 #: ../src/guestfs.pod:2645
35611 "Note that you don't need to implement the RPC, language bindings, manual "
35612 "pages or anything else. It's all automatically generated from the OCaml "
35617 #: ../src/guestfs.pod:2649
35618 msgid "ADDING TESTS FOR AN API ACTION"
35622 #: ../src/guestfs.pod:2651
35624 "You can supply zero or as many tests as you want per API call. The tests "
35625 "can either be added as part of the API description "
35626 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
35627 "drop a script into C<regressions/>. Note that adding a script to "
35628 "C<regressions/> is slower, so if possible use the first method."
35632 #: ../src/guestfs.pod:2657
35634 "The following describes the test environment used when you add an API test "
35635 "in C<generator_actions.ml>."
35639 #: ../src/guestfs.pod:2660
35640 msgid "The test environment has 4 block devices:"
35644 #: ../src/guestfs.pod:2664
35645 msgid "C</dev/sda> 500MB"
35649 #: ../src/guestfs.pod:2666
35650 msgid "General block device for testing."
35654 #: ../src/guestfs.pod:2668
35655 msgid "C</dev/sdb> 50MB"
35659 #: ../src/guestfs.pod:2670
35661 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
35666 #: ../src/guestfs.pod:2673
35667 msgid "C</dev/sdc> 10MB"
35671 #: ../src/guestfs.pod:2675
35672 msgid "Used in a few tests where two block devices are needed."
35676 #: ../src/guestfs.pod:2677
35677 msgid "C</dev/sdd>"
35681 #: ../src/guestfs.pod:2679
35682 msgid "ISO with fixed content (see C<images/test.iso>)."
35686 #: ../src/guestfs.pod:2683
35688 "To be able to run the tests in a reasonable amount of time, the libguestfs "
35689 "appliance and block devices are reused between tests. So don't try testing "
35690 "L</guestfs_kill_subprocess> :-x"
35694 #: ../src/guestfs.pod:2687
35696 "Each test starts with an initial scenario, selected using one of the "
35697 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
35698 "initialize the disks mentioned above in a particular way as documented in "
35699 "C<generator_types.ml>. You should not assume anything about the previous "
35700 "contents of other disks that are not initialized."
35704 #: ../src/guestfs.pod:2693
35706 "You can add a prerequisite clause to any individual test. This is a "
35707 "run-time check, which, if it fails, causes the test to be skipped. Useful "
35708 "if testing a command which might not work on all variations of libguestfs "
35709 "builds. A test that has prerequisite of C<Always> means to run "
35714 #: ../src/guestfs.pod:2699
35716 "In addition, packagers can skip individual tests by setting environment "
35717 "variables before running C<make check>."
35721 #: ../src/guestfs.pod:2702
35724 " SKIP_TEST_<CMD>_<NUM>=1\n"
35729 #: ../src/guestfs.pod:2704
35730 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
35734 #: ../src/guestfs.pod:2706
35739 #: ../src/guestfs.pod:2708
35742 " SKIP_TEST_<CMD>=1\n"
35747 #: ../src/guestfs.pod:2710
35748 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
35752 #: ../src/guestfs.pod:2712
35753 msgid "Packagers can run only certain tests by setting for example:"
35757 #: ../src/guestfs.pod:2714
35760 " TEST_ONLY=\"vfs_type zerofree\"\n"
35765 #: ../src/guestfs.pod:2716
35767 "See C<capitests/tests.c> for more details of how these environment variables "
35772 #: ../src/guestfs.pod:2719
35773 msgid "DEBUGGING NEW API ACTIONS"
35777 #: ../src/guestfs.pod:2721
35778 msgid "Test new actions work before submitting them."
35782 #: ../src/guestfs.pod:2723
35783 msgid "You can use guestfish to try out new commands."
35787 #: ../src/guestfs.pod:2725
35789 "Debugging the daemon is a problem because it runs inside a minimal "
35790 "environment. However you can fprintf messages in the daemon to stderr, and "
35791 "they will show up if you use C<guestfish -v>."
35795 #: ../src/guestfs.pod:2729
35796 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
35800 #: ../src/guestfs.pod:2731
35802 "Our C source code generally adheres to some basic code-formatting "
35803 "conventions. The existing code base is not totally consistent on this "
35804 "front, but we do prefer that contributed code be formatted similarly. In "
35805 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
35806 "indentation level, and other than that, follow the K&R style."
35810 #: ../src/guestfs.pod:2737
35812 "If you use Emacs, add the following to one of one of your start-up files "
35813 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
35817 #: ../src/guestfs.pod:2740
35820 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
35821 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
35822 " (add-hook 'find-file-hook\n"
35823 " '(lambda () (if (and buffer-file-name\n"
35824 " (string-match \"/libguestfs\\\\>\"\n"
35825 " (buffer-file-name))\n"
35826 " (not (string-equal mode-name \"Change Log\"))\n"
35827 " (not (string-equal mode-name \"Makefile\")))\n"
35828 " (setq indent-tabs-mode nil))))\n"
35833 #: ../src/guestfs.pod:2750
35836 " ;;; When editing C sources in libguestfs, use this style.\n"
35837 " (defun libguestfs-c-mode ()\n"
35838 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
35840 " (c-set-style \"K&R\")\n"
35841 " (setq c-indent-level 2)\n"
35842 " (setq c-basic-offset 2))\n"
35843 " (add-hook 'c-mode-hook\n"
35844 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
35845 " (buffer-file-name))\n"
35846 " (libguestfs-c-mode))))\n"
35851 #: ../src/guestfs.pod:2762
35852 msgid "Enable warnings when compiling (and fix any problems this finds):"
35856 #: ../src/guestfs.pod:2765
35859 " ./configure --enable-gcc-warnings\n"
35864 #: ../src/guestfs.pod:2767
35865 msgid "Useful targets are:"
35869 #: ../src/guestfs.pod:2769
35872 " make syntax-check # checks the syntax of the C code\n"
35873 " make check # runs the test suite\n"
35878 #: ../src/guestfs.pod:2772
35879 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
35883 #: ../src/guestfs.pod:2774
35885 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
35886 "which are used to do shell quoting."
35890 #: ../src/guestfs.pod:2779
35895 #: ../src/guestfs.pod:2781
35897 "Simple shell quoted string. Any spaces or other shell characters are "
35902 #: ../src/guestfs.pod:2784
35907 #: ../src/guestfs.pod:2786
35909 "Same as C<%Q> except the string is treated as a path which is prefixed by "
35914 #: ../src/guestfs.pod:2793
35917 " asprintf (&cmd, \"cat %R\", path);\n"
35922 #: ../src/guestfs.pod:2795
35923 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
35927 #: ../src/guestfs.pod:2797
35929 "I<Note:> Do I<not> use these when you are passing parameters to the "
35930 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
35931 "because they are not passed via the shell (instead, straight to exec). You "
35932 "probably want to use the C<sysroot_path()> function however."
35936 #: ../src/guestfs.pod:2803
35937 msgid "SUBMITTING YOUR NEW API ACTIONS"
35941 #: ../src/guestfs.pod:2805
35943 "Submit patches to the mailing list: "
35944 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
35945 "L<rjones@redhat.com>."
35949 #: ../src/guestfs.pod:2809
35950 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
35954 #: ../src/guestfs.pod:2811
35955 msgid "We support i18n (gettext anyhow) in the library."
35959 #: ../src/guestfs.pod:2813
35961 "However many messages come from the daemon, and we don't translate those at "
35962 "the moment. One reason is that the appliance generally has all locale files "
35963 "removed from it, because they take up a lot of space. So we'd have to readd "
35964 "some of those, as well as copying our PO files into the appliance."
35968 #: ../src/guestfs.pod:2819
35970 "Debugging messages are never translated, since they are intended for the "
35975 #: ../src/guestfs.pod:2822
35976 msgid "SOURCE CODE SUBDIRECTORIES"
35980 #: ../src/guestfs.pod:2828
35981 msgid "The libguestfs appliance, build scripts and so on."
35985 #: ../src/guestfs.pod:2830
35986 msgid "C<capitests>"
35990 #: ../src/guestfs.pod:2832
35991 msgid "Automated tests of the C API."
35995 #: ../src/guestfs.pod:2834
36000 #: ../src/guestfs.pod:2836
36002 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
36007 #: ../src/guestfs.pod:2839
36012 #: ../src/guestfs.pod:2841
36014 "Safety and liveness tests of components that libguestfs depends upon (not of "
36015 "libguestfs itself). Mainly this is for qemu and the kernel."
36019 #: ../src/guestfs.pod:2844
36024 #: ../src/guestfs.pod:2846
36025 msgid "Outside contributions, experimental parts."
36029 #: ../src/guestfs.pod:2848
36034 #: ../src/guestfs.pod:2850
36036 "The daemon that runs inside the libguestfs appliance and carries out "
36041 #: ../src/guestfs.pod:2853
36046 #: ../src/guestfs.pod:2855
36047 msgid "L<virt-df(1)> command and documentation."
36051 #: ../src/guestfs.pod:2857
36056 #: ../src/guestfs.pod:2859
36057 msgid "L<virt-edit(1)> command and documentation."
36061 #: ../src/guestfs.pod:2861
36062 msgid "C<examples>"
36066 #: ../src/guestfs.pod:2863
36067 msgid "C API example code."
36071 #: ../src/guestfs.pod:2865
36076 #: ../src/guestfs.pod:2867
36078 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
36079 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
36080 "L<virt-tar-out(1)>."
36084 #: ../src/guestfs.pod:2871
36089 #: ../src/guestfs.pod:2873
36090 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
36094 #: ../src/guestfs.pod:2875
36095 msgid "C<generator>"
36099 #: ../src/guestfs.pod:2877
36101 "The crucially important generator, used to automatically generate large "
36102 "amounts of boilerplate C code for things like RPC and bindings."
36106 #: ../src/guestfs.pod:2880
36111 #: ../src/guestfs.pod:2882
36112 msgid "Files used by the test suite."
36116 #: ../src/guestfs.pod:2884
36117 msgid "Some \"phony\" guest images which we test against."
36121 #: ../src/guestfs.pod:2886
36122 msgid "C<inspector>"
36126 #: ../src/guestfs.pod:2888
36127 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
36131 #: ../src/guestfs.pod:2890
36136 #: ../src/guestfs.pod:2892
36137 msgid "Logo used on the website. The fish is called Arthur by the way."
36141 #: ../src/guestfs.pod:2894
36146 #: ../src/guestfs.pod:2896
36147 msgid "M4 macros used by autoconf."
36151 #: ../src/guestfs.pod:2898
36156 #: ../src/guestfs.pod:2900
36157 msgid "Translations of simple gettext strings."
36161 #: ../src/guestfs.pod:2902
36166 #: ../src/guestfs.pod:2904
36168 "The build infrastructure and PO files for translations of manpages and POD "
36169 "files. Eventually this will be combined with the C<po> directory, but that "
36170 "is rather complicated."
36174 #: ../src/guestfs.pod:2908
36175 msgid "C<regressions>"
36179 #: ../src/guestfs.pod:2910
36180 msgid "Regression tests."
36184 #: ../src/guestfs.pod:2912
36189 #: ../src/guestfs.pod:2914
36190 msgid "L<virt-rescue(1)> command and documentation."
36194 #: ../src/guestfs.pod:2916
36199 #: ../src/guestfs.pod:2918
36200 msgid "Source code to the C library."
36204 #: ../src/guestfs.pod:2920
36209 #: ../src/guestfs.pod:2922
36210 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
36214 #: ../src/guestfs.pod:2924
36215 msgid "C<test-tool>"
36219 #: ../src/guestfs.pod:2926
36221 "Test tool for end users to test if their qemu/kernel combination will work "
36226 #: ../src/guestfs.pod:2929
36231 #: ../src/guestfs.pod:2931
36236 #: ../src/guestfs.pod:2933
36241 #: ../src/guestfs.pod:2935
36246 #: ../src/guestfs.pod:2937
36251 #: ../src/guestfs.pod:2939
36256 #: ../src/guestfs.pod:2941
36261 #: ../src/guestfs.pod:2943
36266 #: ../src/guestfs.pod:2945
36271 #: ../src/guestfs.pod:2947
36272 msgid "Language bindings."
36276 #: ../src/guestfs.pod:2951
36277 msgid "MAKING A STABLE RELEASE"
36281 #: ../src/guestfs.pod:2953
36283 "When we make a stable release, there are several steps documented here. See "
36284 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
36289 #: ../src/guestfs.pod:2961
36290 msgid "Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
36294 #: ../src/guestfs.pod:2966
36295 msgid "Finalize RELEASE-NOTES."
36299 #: ../src/guestfs.pod:2970
36300 msgid "Update ROADMAP."
36304 #: ../src/guestfs.pod:2974
36305 msgid "Run C<src/api-support/update-from-tarballs.sh>."
36309 #: ../src/guestfs.pod:2978
36310 msgid "Push and pull from Transifex."
36314 #: ../src/guestfs.pod:2980
36319 #: ../src/guestfs.pod:2982
36327 #: ../src/guestfs.pod:2984
36328 msgid "to push the latest POT files to Transifex. Then run:"
36332 #: ../src/guestfs.pod:2986
36340 #: ../src/guestfs.pod:2988
36341 msgid "which is a wrapper to pull the latest translated C<*.po> files."
36345 #: ../src/guestfs.pod:2992
36347 "Create new stable and development directories under "
36348 "L<http://libguestfs.org/download>."
36352 #: ../src/guestfs.pod:2997
36353 msgid "Create the branch in git:"
36357 #: ../src/guestfs.pod:2999
36360 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
36361 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
36362 " git branch stable-1.XX\n"
36363 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
36368 #: ../src/guestfs.pod:3006
36373 #: ../src/guestfs.pod:3008
36374 msgid "PROTOCOL LIMITS"
36378 #: ../src/guestfs.pod:3010
36380 "Internally libguestfs uses a message-based protocol to pass API calls and "
36381 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
36382 "plenty more detail about this). The maximum message size used by the "
36383 "protocol is slightly less than 4 MB. For some API calls you may need to be "
36384 "aware of this limit. The API calls which may be affected are individually "
36385 "documented, with a link back to this section of the documentation."
36389 #: ../src/guestfs.pod:3018
36391 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
36392 "a simple string. Because this string is at some point internally encoded as "
36393 "a message, the maximum size that it can return is slightly under 4 MB. If "
36394 "the requested file is larger than this then you will get an error."
36398 #: ../src/guestfs.pod:3024
36400 "In order to transfer large files into and out of the guest filesystem, you "
36401 "need to use particular calls that support this. The sections L</UPLOADING> "
36402 "and L</DOWNLOADING> document how to do this."
36406 #: ../src/guestfs.pod:3028
36408 "You might also consider mounting the disk image using our FUSE filesystem "
36409 "support (L<guestmount(1)>)."
36413 #: ../src/guestfs.pod:3031
36414 msgid "MAXIMUM NUMBER OF DISKS"
36418 #: ../src/guestfs.pod:3033
36419 msgid "When using virtio disks (the default) the current limit is B<25> disks."
36423 #: ../src/guestfs.pod:3036
36425 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
36426 "slots. However febootstrap only understands disks with names C</dev/vda> "
36427 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
36432 #: ../src/guestfs.pod:3041
36434 "We are working to substantially raise this limit in future versions but it "
36435 "requires complex changes to qemu."
36439 #: ../src/guestfs.pod:3044
36441 "In future versions of libguestfs it should also be possible to \"hot plug\" "
36442 "disks (add and remove disks after calling L</guestfs_launch>). This also "
36443 "requires changes to qemu."
36447 #: ../src/guestfs.pod:3048
36448 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
36452 #: ../src/guestfs.pod:3050
36453 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
36457 #: ../src/guestfs.pod:3052
36459 "This is because it reserves 4 bits for the minor device number (thus "
36460 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
36464 #: ../src/guestfs.pod:3055
36466 "If you attach a disk with more than 15 partitions, the extra partitions are "
36467 "ignored by libguestfs."
36471 #: ../src/guestfs.pod:3058
36472 msgid "MAXIMUM SIZE OF A DISK"
36476 #: ../src/guestfs.pod:3060
36477 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
36481 #: ../src/guestfs.pod:3062
36483 "We have tested block devices up to 1 exabyte (2**60 or "
36484 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
36489 #: ../src/guestfs.pod:3066
36491 "Although libguestfs probably does not impose any limit, the underlying host "
36492 "storage will. If you store disk images on a host ext4 filesystem, then the "
36493 "maximum size will be limited by the maximum ext4 file size (currently 16 "
36494 "TB). If you store disk images as host logical volumes then you are limited "
36495 "by the maximum size of an LV."
36499 #: ../src/guestfs.pod:3072
36501 "For the hugest disk image files, we recommend using XFS on the host for "
36506 #: ../src/guestfs.pod:3075
36507 msgid "MAXIMUM SIZE OF A PARTITION"
36511 #: ../src/guestfs.pod:3077
36513 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
36514 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
36515 "address a partition located beyond 2 TB on the disk."
36519 #: ../src/guestfs.pod:3081
36521 "It is recommended that you use GPT partitions on disks which are larger than "
36522 "this size. GPT uses 64 bit sector numbers and so can address partitions "
36523 "which are theoretically larger than the largest disk we could support."
36527 #: ../src/guestfs.pod:3086
36528 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
36532 #: ../src/guestfs.pod:3088
36534 "This depends on the filesystem type. libguestfs itself does not impose any "
36535 "known limit. Consult Wikipedia or the filesystem documentation to find out "
36536 "what these limits are."
36540 #: ../src/guestfs.pod:3092
36541 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
36545 #: ../src/guestfs.pod:3094
36547 "The API functions L</guestfs_upload>, L</guestfs_download>, "
36548 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
36549 "uploads and downloads."
36553 #: ../src/guestfs.pod:3098
36554 msgid "INSPECTION LIMITS"
36558 #: ../src/guestfs.pod:3100
36560 "The inspection code has several arbitrary limits on things like the size of "
36561 "Windows Registry hive it will read, and the length of product name. These "
36562 "are intended to stop a malicious guest from consuming arbitrary amounts of "
36563 "memory and disk space on the host, and should not be reached in practice. "
36564 "See the source code for more information."
36568 #: ../src/guestfs.pod:3126
36570 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
36571 "effect as calling C<guestfs_set_verbose (g, 1)>."
36575 #: ../src/guestfs.pod:3138
36577 "Set the path that libguestfs uses to search for a supermin appliance. See "
36578 "the discussion of paths in section L</PATH> above."
36582 #: ../src/guestfs.pod:3147
36583 msgid "See also L</QEMU WRAPPERS> above."
36587 #: ../src/guestfs.pod:3151
36589 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
36590 "effect as calling C<guestfs_set_trace (g, 1)>."
36594 #: ../src/guestfs.pod:3169
36596 "L<guestfs-examples(3)>, L<guestfs-erlang(3)>, L<guestfs-java(3)>, "
36597 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
36598 "L<guestfs-ruby(3)>, L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, "
36599 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
36600 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
36601 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
36602 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
36603 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, "
36604 "L<febootstrap-supermin-helper(8)>, L<hivex(3)>, L<http://libguestfs.org/>."
36608 #: ../src/guestfs.pod:3200
36610 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
36611 "L<lvm(8)>, L<disktype(1)>."
36615 #: ../src/guestfs.pod:3207 ../tools/virt-make-fs.pl:553 ../tools/virt-win-reg.pl:761
36620 #: ../src/guestfs.pod:3209
36621 msgid "To get a list of bugs against libguestfs use this link:"
36625 #: ../src/guestfs.pod:3211
36626 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
36630 #: ../src/guestfs.pod:3213
36631 msgid "To report a new bug against libguestfs use this link:"
36635 #: ../src/guestfs.pod:3215
36636 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
36640 #: ../src/guestfs.pod:3217
36641 msgid "When reporting a bug, please check:"
36645 #: ../src/guestfs.pod:3223
36646 msgid "That the bug hasn't been reported already."
36650 #: ../src/guestfs.pod:3227
36651 msgid "That you are testing a recent version."
36655 #: ../src/guestfs.pod:3231
36656 msgid "Describe the bug accurately, and give a way to reproduce it."
36660 #: ../src/guestfs.pod:3235
36662 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
36667 #: ../test-tool/libguestfs-test-tool.pod:5
36668 msgid "libguestfs-test-tool - Diagnostics for libguestfs"
36672 #: ../test-tool/libguestfs-test-tool.pod:9
36675 " libguestfs-test-tool [--options]\n"
36680 #: ../test-tool/libguestfs-test-tool.pod:13
36682 "libguestfs-test-tool is a test program shipped with libguestfs to allow you "
36683 "to check basic libguestfs functionality is working. This is needed because "
36684 "libguestfs occasionally breaks for reasons beyond our control: usually "
36685 "because of changes in the underlying qemu or kernel packages, or the host "
36690 #: ../test-tool/libguestfs-test-tool.pod:19
36691 msgid "If you suspect a problem in libguestfs, then just run:"
36695 #: ../test-tool/libguestfs-test-tool.pod:21
36698 " libguestfs-test-tool\n"
36703 #: ../test-tool/libguestfs-test-tool.pod:23
36704 msgid "It will print lots of diagnostic messages."
36708 #: ../test-tool/libguestfs-test-tool.pod:25
36709 msgid "If it runs to completion successfully, you will see this near the end:"
36713 #: ../test-tool/libguestfs-test-tool.pod:27
36716 " ===== TEST FINISHED OK =====\n"
36721 #: ../test-tool/libguestfs-test-tool.pod:29
36722 msgid "and the test tool will exit with code 0."
36726 #: ../test-tool/libguestfs-test-tool.pod:31
36728 "If it fails (and/or exits with non-zero error code), please paste the "
36729 "I<complete, unedited> output of the test tool into a bug report. More "
36730 "information about reporting bugs can be found on the "
36731 "L<http://libguestfs.org/> website."
36735 #: ../test-tool/libguestfs-test-tool.pod:42
36736 msgid "Display short usage information and exit."
36740 #: ../test-tool/libguestfs-test-tool.pod:44
36741 msgid "B<--qemu qemu_binary>"
36745 #: ../test-tool/libguestfs-test-tool.pod:46
36747 "If you have downloaded another qemu binary, point this option at the full "
36748 "path of the binary to try it."
36752 #: ../test-tool/libguestfs-test-tool.pod:49
36753 msgid "B<--qemudir qemu_source_dir>"
36757 #: ../test-tool/libguestfs-test-tool.pod:51
36759 "If you have compiled qemu from source, point this option at the source "
36760 "directory to try it."
36764 #: ../test-tool/libguestfs-test-tool.pod:54
36769 #: ../test-tool/libguestfs-test-tool.pod:56
36770 msgid "B<--timeout N>"
36774 #: ../test-tool/libguestfs-test-tool.pod:58
36776 "Set the launch timeout to C<N> seconds. The default is 600 seconds (10 "
36777 "minutes) which does not usually need to be adjusted."
36781 #: ../test-tool/libguestfs-test-tool.pod:63
36782 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
36786 #: ../test-tool/libguestfs-test-tool.pod:65
36788 "If you have compiled another version of qemu from source and would like to "
36789 "try that, then you can use the I<--qemudir> option to point to the qemu "
36790 "source directory."
36794 #: ../test-tool/libguestfs-test-tool.pod:69
36796 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
36797 "option to point to the binary."
36801 #: ../test-tool/libguestfs-test-tool.pod:72
36803 "Note when using these options, you can ignore the business of qemu wrapper "
36804 "scripts (L<guestfs(3)/QEMU WRAPPERS>), since libguestfs-test-tool writes a "
36805 "wrapper script for you if one is needed."
36809 #: ../test-tool/libguestfs-test-tool.pod:76
36810 msgid "TRYING OUT A DIFFERENT KERNEL"
36814 #: ../test-tool/libguestfs-test-tool.pod:78
36816 "If you are using febootstrap E<ge> 3.8 then you can select which kernel "
36817 "libguestfs tries. You do this by setting the environment variables "
36818 "C<FEBOOTSTRAP_KERNEL> and/or C<FEBOOTSTRAP_MODULES>."
36822 #: ../test-tool/libguestfs-test-tool.pod:82
36824 "Refer to L<febootstrap-supermin-helper(8)/ENVIRONMENT VARIABLES> for further "
36829 #: ../test-tool/libguestfs-test-tool.pod:85
36830 msgid "SELF-DIAGNOSIS"
36834 #: ../test-tool/libguestfs-test-tool.pod:87
36836 "Refer to L<guestfs(3)/APPLIANCE BOOT PROCESS> to understand the messages "
36837 "produced by libguestfs-test-tool and/or possible errors."
36841 #: ../test-tool/libguestfs-test-tool.pod:92
36843 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
36844 "I<1> if there was an error."
36848 #: ../test-tool/libguestfs-test-tool.pod:97
36850 "For the full list of environment variables which may affect libguestfs, "
36851 "please see the L<guestfs(3)> manual page."
36855 #: ../test-tool/libguestfs-test-tool.pod:102
36856 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
36860 #: ../tools/virt-list-filesystems.pl:32
36861 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
36865 #: ../tools/virt-list-filesystems.pl:36
36868 " virt-list-filesystems [--options] domname\n"
36873 #: ../tools/virt-list-filesystems.pl:38
36876 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
36881 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
36883 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
36888 #: ../tools/virt-list-filesystems.pl:45
36890 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
36891 "are contained in a virtual machine or disk image."
36895 #: ../tools/virt-list-filesystems.pl:49
36897 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
36898 "functionality. For more complex cases you should look at the "
36899 "L<guestfish(1)> tool."
36903 #: ../tools/virt-list-filesystems.pl:112
36905 "With this option, C<virt-list-filesystems> displays the type of each "
36906 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
36910 #: ../tools/virt-list-filesystems.pl:119
36915 #: ../tools/virt-list-filesystems.pl:123
36917 "Normally we only show mountable filesystems. If this option is given then "
36918 "swap devices are shown too."
36922 #: ../tools/virt-list-filesystems.pl:197
36924 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
36925 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
36926 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
36930 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
36931 msgid "Copyright (C) 2009 Red Hat Inc."
36935 #: ../tools/virt-list-partitions.pl:32
36936 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
36940 #: ../tools/virt-list-partitions.pl:36
36943 " virt-list-partitions [--options] domname\n"
36948 #: ../tools/virt-list-partitions.pl:38
36951 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
36956 #: ../tools/virt-list-partitions.pl:45
36958 "C<virt-list-partitions> is a command line tool to list the partitions that "
36959 "are contained in a virtual machine or disk image. It is mainly useful as a "
36960 "first step to using L<virt-resize(1)>."
36964 #: ../tools/virt-list-partitions.pl:50
36966 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
36967 "functionality. For more complex cases you should look at the "
36968 "L<guestfish(1)> tool."
36972 #: ../tools/virt-list-partitions.pl:113
36973 msgid "Show sizes in human-readable form (eg. \"1G\")."
36977 #: ../tools/virt-list-partitions.pl:123
36979 "With this option, C<virt-list-partitions> displays the type and size of each "
36980 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
36984 #: ../tools/virt-list-partitions.pl:130
36989 #: ../tools/virt-list-partitions.pl:132
36994 #: ../tools/virt-list-partitions.pl:134
36995 msgid "Display the total size of each block device (as a separate row or rows)."
36999 #: ../tools/virt-list-partitions.pl:267
37001 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
37002 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
37003 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
37007 #: ../tools/virt-list-partitions.pl:283
37008 msgid "Copyright (C) 2009-2010 Red Hat Inc."
37012 #: ../tools/virt-make-fs.pl:37
37013 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
37017 #: ../tools/virt-make-fs.pl:41
37020 " virt-make-fs [--options] input.tar output.img\n"
37025 #: ../tools/virt-make-fs.pl:43
37028 " virt-make-fs [--options] input.tar.gz output.img\n"
37033 #: ../tools/virt-make-fs.pl:45
37036 " virt-make-fs [--options] directory output.img\n"
37041 #: ../tools/virt-make-fs.pl:49
37043 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
37044 "archive or some files in a directory. It is similar to tools like "
37045 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
37046 "it can create common filesystem types like ext2/3 or NTFS, which can be "
37047 "useful if you want to attach these filesystems to existing virtual machines "
37048 "(eg. to import large amounts of read-only data to a VM)."
37052 #: ../tools/virt-make-fs.pl:57
37053 msgid "Basic usage is:"
37057 #: ../tools/virt-make-fs.pl:59
37060 " virt-make-fs input output\n"
37065 #: ../tools/virt-make-fs.pl:61
37067 "where C<input> is either a directory containing files that you want to add, "
37068 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
37069 "C<output> is a disk image. The input type is detected automatically. The "
37070 "output disk image defaults to a raw ext2 image unless you specify extra "
37071 "flags (see L</OPTIONS> below)."
37075 #: ../tools/virt-make-fs.pl:67
37076 msgid "EXTRA SPACE"
37080 #: ../tools/virt-make-fs.pl:69
37082 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
37083 "the files that it contains, but might have extra space. Depending on how "
37084 "you are going to use the output, you might think this extra space is wasted "
37085 "and want to minimize it, or you might want to leave space so that more files "
37086 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
37087 "but you can use the I<--size> flag to leave space in the filesystem if you "
37092 #: ../tools/virt-make-fs.pl:77
37094 "An alternative way to leave extra space but not make the output image any "
37095 "bigger is to use an alternative disk image format (instead of the default "
37096 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
37097 "image format (check your hypervisor supports this before using it). This "
37098 "allows you to choose a large I<--size> but the extra space won't actually be "
37099 "allocated in the image until you try to store something in it."
37103 #: ../tools/virt-make-fs.pl:85
37105 "Don't forget that you can also use local commands including L<resize2fs(8)> "
37106 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
37107 "to build another image from scratch."
37111 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
37116 #: ../tools/virt-make-fs.pl:91
37119 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
37124 #: ../tools/virt-make-fs.pl:93
37125 msgid "FILESYSTEM TYPE"
37129 #: ../tools/virt-make-fs.pl:95
37131 "The default filesystem type is C<ext2>. Just about any filesystem type that "
37132 "libguestfs supports can be used (but I<not> read-only formats like "
37133 "ISO9660). Here are some of the more common choices:"
37137 #: ../tools/virt-make-fs.pl:101
37142 #: ../tools/virt-make-fs.pl:103
37144 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
37145 "you are not going to use the filesystem in a way that requires the journal, "
37146 "then this is just wasted overhead."
37150 #: ../tools/virt-make-fs.pl:107
37151 msgid "I<ntfs> or I<vfat>"
37155 #: ../tools/virt-make-fs.pl:109
37156 msgid "Useful if exporting data to a Windows guest."
37160 #: ../tools/virt-make-fs.pl:111
37162 "I<Note for vfat>: The tar archive or local directory must only contain files "
37163 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
37164 "program running within libguestfs is unable to change the ownership of "
37165 "non-root files, since vfat itself does not support this."
37169 #: ../tools/virt-make-fs.pl:116
37174 #: ../tools/virt-make-fs.pl:118
37176 "Lower overhead than C<ext2>, but certain limitations on filename length and "
37177 "total filesystem size."
37181 #: ../tools/virt-make-fs.pl:125
37184 " virt-make-fs --type=minix input minixfs.img\n"
37189 #: ../tools/virt-make-fs.pl:127
37190 msgid "TO PARTITION OR NOT TO PARTITION"
37194 #: ../tools/virt-make-fs.pl:129
37195 msgid "Optionally virt-make-fs can add a partition table to the output disk."
37199 #: ../tools/virt-make-fs.pl:131
37201 "Adding a partition can make the disk image more compatible with certain "
37202 "virtualized operating systems which don't expect to see a filesystem "
37203 "directly located on a block device (Linux doesn't care and will happily "
37204 "handle both types)."
37208 #: ../tools/virt-make-fs.pl:136
37210 "On the other hand, if you have a partition table then the output image is no "
37211 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
37212 "directly on a partitioned disk image. (However libguestfs tools such as "
37213 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
37217 #: ../tools/virt-make-fs.pl:144
37218 msgid "Add an MBR partition:"
37222 #: ../tools/virt-make-fs.pl:146
37225 " virt-make-fs --partition -- input disk.img\n"
37230 #: ../tools/virt-make-fs.pl:148
37232 "If the output disk image could be terabyte-sized or larger, it's better to "
37233 "use an EFI/GPT-compatible partition table:"
37237 #: ../tools/virt-make-fs.pl:151
37240 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
37245 #: ../tools/virt-make-fs.pl:179
37246 msgid "Enable debugging information."
37250 #: ../tools/virt-make-fs.pl:185
37251 msgid "B<--size=E<lt>NE<gt>>"
37255 #: ../tools/virt-make-fs.pl:187
37256 msgid "B<--size=+E<lt>NE<gt>>"
37260 #: ../tools/virt-make-fs.pl:189
37261 msgid "B<-s E<lt>NE<gt>>"
37265 #: ../tools/virt-make-fs.pl:191
37266 msgid "B<-s +E<lt>NE<gt>>"
37270 #: ../tools/virt-make-fs.pl:193
37271 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
37275 #: ../tools/virt-make-fs.pl:196
37277 "If this option is I<not> given, then the output image will be just large "
37278 "enough to contain all the files, with not much wasted space."
37282 #: ../tools/virt-make-fs.pl:199
37284 "To choose a fixed size output disk, specify an absolute number followed by "
37285 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
37286 "Petabytes or Exabytes. This must be large enough to contain all the input "
37287 "files, else you will get an error."
37291 #: ../tools/virt-make-fs.pl:204
37293 "To leave extra space, specify C<+> (plus sign) and a number followed by "
37294 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
37295 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
37296 "the input files, and (approximately) an extra 200 MB free space."
37300 #: ../tools/virt-make-fs.pl:210
37302 "Note that virt-make-fs estimates free space, and therefore will not produce "
37303 "filesystems containing precisely the free space requested. (It is much more "
37304 "expensive and time-consuming to produce a filesystem which has precisely the "
37305 "desired free space)."
37309 #: ../tools/virt-make-fs.pl:219
37310 msgid "B<--format=E<lt>fmtE<gt>>"
37314 #: ../tools/virt-make-fs.pl:221
37315 msgid "B<-F E<lt>fmtE<gt>>"
37319 #: ../tools/virt-make-fs.pl:223
37320 msgid "Choose the output disk image format."
37324 #: ../tools/virt-make-fs.pl:225
37325 msgid "The default is C<raw> (raw disk image)."
37329 #: ../tools/virt-make-fs.pl:227
37331 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
37332 "that would really make sense here is C<qcow2>."
37336 #: ../tools/virt-make-fs.pl:234
37337 msgid "B<--type=E<lt>fsE<gt>>"
37341 #: ../tools/virt-make-fs.pl:236
37342 msgid "B<-t E<lt>fsE<gt>>"
37346 #: ../tools/virt-make-fs.pl:238
37347 msgid "Choose the output filesystem type."
37351 #: ../tools/virt-make-fs.pl:240
37352 msgid "The default is C<ext2>."
37356 #: ../tools/virt-make-fs.pl:242
37357 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
37361 #: ../tools/virt-make-fs.pl:249
37362 msgid "B<--partition>"
37366 #: ../tools/virt-make-fs.pl:251
37367 msgid "B<--partition=E<lt>parttypeE<gt>>"
37371 #: ../tools/virt-make-fs.pl:253
37373 "If specified, this flag adds an MBR partition table to the output disk "
37378 #: ../tools/virt-make-fs.pl:256
37380 "You can change the partition table type, eg. I<--partition=gpt> for large "
37385 #: ../tools/virt-make-fs.pl:259
37387 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
37388 "might consider the next parameter to be the partition type. For example:"
37392 #: ../tools/virt-make-fs.pl:263
37395 " virt-make-fs --partition input.tar ...\n"
37400 #: ../tools/virt-make-fs.pl:265
37402 "would cause virt-make-fs to think you wanted to use a partition type of "
37403 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
37404 "dash) between options and the input file argument:"
37408 #: ../tools/virt-make-fs.pl:269
37411 " virt-make-fs --partition -- input.tar ...\n"
37416 #: ../tools/virt-make-fs.pl:541
37418 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
37419 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
37420 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
37424 #: ../tools/virt-make-fs.pl:555 ../tools/virt-win-reg.pl:763
37426 "When reporting bugs, please enable debugging and capture the I<complete> "
37431 #: ../tools/virt-make-fs.pl:558
37434 " export LIBGUESTFS_DEBUG=1\n"
37435 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
37440 #: ../tools/virt-make-fs.pl:561
37442 "Attach /tmp/virt-make-fs.log to a new bug report at "
37443 "L<https://bugzilla.redhat.com/>"
37447 #: ../tools/virt-tar.pl:33
37448 msgid "virt-tar - Extract or upload files to a virtual machine"
37452 #: ../tools/virt-tar.pl:37
37455 " virt-tar [--options] -x domname directory tarball\n"
37460 #: ../tools/virt-tar.pl:39
37463 " virt-tar [--options] -u domname tarball directory\n"
37468 #: ../tools/virt-tar.pl:41
37471 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
37476 #: ../tools/virt-tar.pl:43
37479 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
37484 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
37489 #: ../tools/virt-tar.pl:47
37491 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
37492 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
37496 #: ../tools/virt-tar.pl:52
37497 msgid "Download C</home> from the VM into a local tarball:"
37501 #: ../tools/virt-tar.pl:54
37504 " virt-tar -x domname /home home.tar\n"
37509 #: ../tools/virt-tar.pl:56
37512 " virt-tar -zx domname /home home.tar.gz\n"
37517 #: ../tools/virt-tar.pl:58
37518 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
37522 #: ../tools/virt-tar.pl:60
37525 " virt-tar -u domname uploadstuff.tar /tmp\n"
37530 #: ../tools/virt-tar.pl:62
37533 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
37538 #: ../tools/virt-tar.pl:66
37540 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
37541 "virtual machines. If you do this, you risk disk corruption in the VM. "
37542 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
37546 #: ../tools/virt-tar.pl:71
37548 "You can use I<-x> (extract) on live virtual machines, but you might get "
37549 "inconsistent results or errors if there is filesystem activity inside the "
37550 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
37551 "work, but the only way to guarantee consistent results is if the virtual "
37552 "machine is shut down."
37556 #: ../tools/virt-tar.pl:79
37558 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
37559 "parts of a guest filesystem. There are many possibilities: making backups, "
37560 "uploading data files, snooping on guest activity, fixing or customizing "
37565 #: ../tools/virt-tar.pl:84
37567 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
37568 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
37569 "should look at the L<guestfish(1)> tool."
37573 #: ../tools/virt-tar.pl:88
37575 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
37576 "its contents (recursively) from the virtual machine into a local tarball. "
37577 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
37578 "virtual machine. You cannot use these two options together."
37582 #: ../tools/virt-tar.pl:94
37584 "In addition, you may need to use the I<-z> (gZip) option to enable "
37585 "compression. When uploading, you have to specify I<-z> if the upload file "
37586 "is compressed because virt-tar won't detect this on its own."
37590 #: ../tools/virt-tar.pl:98
37592 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
37593 "example it cannot do PKZip files or bzip2 compression. If you want that "
37594 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
37595 "the L<libguestfs(3)> API)."
37599 #: ../tools/virt-tar.pl:160
37600 msgid "B<--extract>"
37604 #: ../tools/virt-tar.pl:162
37605 msgid "B<--download>"
37609 #: ../tools/virt-tar.pl:164
37614 #: ../tools/virt-tar.pl:166
37615 msgid "B<--upload>"
37619 #: ../tools/virt-tar.pl:168
37621 "Use I<-x> to extract (download) a directory from a virtual machine to a "
37626 #: ../tools/virt-tar.pl:171
37628 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
37629 "Please read the L</WARNING> section above before using this option."
37633 #: ../tools/virt-tar.pl:175
37634 msgid "You must specify exactly one of these options."
37638 #: ../tools/virt-tar.pl:181
37643 #: ../tools/virt-tar.pl:183
37648 #: ../tools/virt-tar.pl:185
37649 msgid "Specify that the input or output tarball is gzip-compressed."
37653 #: ../tools/virt-tar.pl:298
37655 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
37656 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
37657 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
37658 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
37662 #: ../tools/virt-win-reg.pl:37
37664 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
37669 #: ../tools/virt-win-reg.pl:41
37672 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
37677 #: ../tools/virt-win-reg.pl:43
37680 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
37685 #: ../tools/virt-win-reg.pl:45
37688 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
37693 #: ../tools/virt-win-reg.pl:47
37696 " virt-win-reg --merge domname [input.reg ...]\n"
37701 #: ../tools/virt-win-reg.pl:49
37704 " virt-win-reg [--options] disk.img ... # instead of domname\n"
37709 #: ../tools/virt-win-reg.pl:53
37711 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
37712 "virtual machines. If you do this, you I<will> get irreversible disk "
37713 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
37714 "but doesn't catch all cases."
37718 #: ../tools/virt-win-reg.pl:58
37720 "Modifying the Windows Registry is an inherently risky operation. The format "
37721 "is deliberately obscure and undocumented, and Registry changes can leave the "
37722 "system unbootable. Therefore when using the I<--merge> option, make sure "
37723 "you have a reliable backup first."
37727 #: ../tools/virt-win-reg.pl:65
37729 "This program can export and merge Windows Registry entries from a Windows "
37734 #: ../tools/virt-win-reg.pl:68
37736 "The first parameter is the libvirt guest name or the raw disk image of a "
37741 #: ../tools/virt-win-reg.pl:71
37743 "If I<--merge> is I<not> specified, then the chosen registry key is "
37744 "displayed/exported (recursively). For example:"
37748 #: ../tools/virt-win-reg.pl:74
37751 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
37756 #: ../tools/virt-win-reg.pl:76
37757 msgid "You can also display single values from within registry keys, for example:"
37761 #: ../tools/virt-win-reg.pl:79
37764 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
37765 " $ virt-win-reg Windows7 $cvkey ProductName\n"
37766 " Windows 7 Enterprise\n"
37771 #: ../tools/virt-win-reg.pl:83
37773 "With I<--merge>, you can merge a textual regedit file into the Windows "
37778 #: ../tools/virt-win-reg.pl:86
37781 " $ virt-win-reg --merge Windows7 changes.reg\n"
37786 #: ../tools/virt-win-reg.pl:90
37788 "This program is only meant for simple access to the registry. If you want "
37789 "to do complicated things with the registry, we suggest you download the "
37790 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
37791 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
37792 "L<hivexregedit(1)>."
37796 #: ../tools/virt-win-reg.pl:159
37801 #: ../tools/virt-win-reg.pl:161
37803 "In merge mode, this merges a textual regedit file into the Windows Registry "
37804 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
37805 "displays or exports Registry entries instead."
37809 #: ../tools/virt-win-reg.pl:165
37811 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
37812 "result in disk corruption. However exporting (without this flag) is always "
37817 #: ../tools/virt-win-reg.pl:173
37818 msgid "B<--encoding> UTF-16LE|ASCII"
37822 #: ../tools/virt-win-reg.pl:175
37824 "When merging (only), you may need to specify the encoding for strings to be "
37825 "used in the hive file. This is explained in detail in "
37826 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
37830 #: ../tools/virt-win-reg.pl:179
37832 "The default is to use UTF-16LE, which should work with recent versions of "
37837 #: ../tools/virt-win-reg.pl:186
37838 msgid "B<--unsafe-printable-strings>"
37842 #: ../tools/virt-win-reg.pl:188
37844 "When exporting (only), assume strings are UTF-16LE and print them as strings "
37845 "instead of hex sequences. Remove the final zero codepoint from strings if "
37850 #: ../tools/virt-win-reg.pl:192
37852 "This is unsafe and does not preserve the fidelity of strings in the original "
37853 "Registry for various reasons:"
37857 #: ../tools/virt-win-reg.pl:199
37859 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
37860 "other encodings will be corrupted by this transformation."
37864 #: ../tools/virt-win-reg.pl:204
37866 "Assumes that everything which has type 1 or 2 is really a string and that "
37867 "everything else is not a string, but the type field in real Registries is "
37872 #: ../tools/virt-win-reg.pl:210
37874 "Loses information about whether a zero codepoint followed the string in the "
37879 #: ../tools/virt-win-reg.pl:215
37881 "This all happens because the Registry itself contains no information about "
37882 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
37886 #: ../tools/virt-win-reg.pl:219
37888 "You should only use this option for quick hacking and debugging of the "
37889 "Registry contents, and I<never> use it if the output is going to be passed "
37890 "into another program or stored in another Registry."
37894 #: ../tools/virt-win-reg.pl:556
37895 msgid "SUPPORTED SYSTEMS"
37899 #: ../tools/virt-win-reg.pl:558
37901 "The program currently supports Windows NT-derived guests starting with "
37902 "Windows XP through to at least Windows 7."
37906 #: ../tools/virt-win-reg.pl:561
37907 msgid "The following Registry keys are supported:"
37911 #: ../tools/virt-win-reg.pl:565
37912 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
37916 #: ../tools/virt-win-reg.pl:567
37917 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
37921 #: ../tools/virt-win-reg.pl:569
37922 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
37926 #: ../tools/virt-win-reg.pl:571
37927 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
37931 #: ../tools/virt-win-reg.pl:573
37932 msgid "C<HKEY_USERS\\.DEFAULT>"
37936 #: ../tools/virt-win-reg.pl:575
37937 msgid "C<HKEY_USERS\\I<SID>>"
37941 #: ../tools/virt-win-reg.pl:577
37942 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
37946 #: ../tools/virt-win-reg.pl:579
37947 msgid "C<HKEY_USERS\\I<username>>"
37951 #: ../tools/virt-win-reg.pl:581
37952 msgid "where I<username> is a local user name (this is a libguestfs extension)."
37956 #: ../tools/virt-win-reg.pl:585
37958 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
37963 #: ../tools/virt-win-reg.pl:588
37965 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
37966 "supported (there is no \"current user\")."
37970 #: ../tools/virt-win-reg.pl:591
37975 #: ../tools/virt-win-reg.pl:593
37977 "C<virt-win-reg> expects that regedit files have already been reencoded in "
37978 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
37979 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
37980 "with Windows-style line endings, you may need to reencode the whole file "
37981 "before or after processing."
37985 #: ../tools/virt-win-reg.pl:599
37987 "To reencode a file from Windows format to Linux (before processing it with "
37988 "the I<--merge> option), you would do something like this:"
37992 #: ../tools/virt-win-reg.pl:602
37995 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
38000 #: ../tools/virt-win-reg.pl:604
38002 "To go in the opposite direction, after exporting and before sending the file "
38003 "to a Windows user, do something like this:"
38007 #: ../tools/virt-win-reg.pl:607
38010 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
38015 #: ../tools/virt-win-reg.pl:609
38016 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
38020 #: ../tools/virt-win-reg.pl:611
38022 "If you are unsure about the current encoding, use the L<file(1)> command. "
38023 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
38024 "Windows-style (CRLF) line endings, like this:"
38028 #: ../tools/virt-win-reg.pl:615
38031 " $ file software.reg\n"
38032 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
38033 " with CRLF line terminators\n"
38038 #: ../tools/virt-win-reg.pl:619
38039 msgid "This file would need conversion before you could I<--merge> it."
38043 #: ../tools/virt-win-reg.pl:621
38044 msgid "CurrentControlSet etc."
38048 #: ../tools/virt-win-reg.pl:623
38050 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
38051 "Registry at the level of the hive file, and therefore you cannot modify "
38056 #: ../tools/virt-win-reg.pl:627
38058 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
38059 "circumstances it might refer to another control set. The way to find out is "
38060 "to look at the C<HKLM\\SYSTEM\\Select> key:"
38064 #: ../tools/virt-win-reg.pl:631
38067 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
38068 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
38069 " \"Current\"=dword:00000001\n"
38070 " \"Default\"=dword:00000001\n"
38071 " \"Failed\"=dword:00000000\n"
38072 " \"LastKnownGood\"=dword:00000002\n"
38077 #: ../tools/virt-win-reg.pl:638
38078 msgid "\"Current\" is the one which Windows will choose when it boots."
38082 #: ../tools/virt-win-reg.pl:640
38083 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
38087 #: ../tools/virt-win-reg.pl:643
38088 msgid "WINDOWS TIPS"
38092 #: ../tools/virt-win-reg.pl:645
38094 "Note that some of these tips modify the guest disk image. The guest I<must> "
38095 "be shut off, else you will get disk corruption."
38099 #: ../tools/virt-win-reg.pl:648
38100 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
38104 #: ../tools/virt-win-reg.pl:650
38106 "Prepare a DOS batch script, VBScript or executable. Upload this using "
38107 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
38108 "is uploaded into C<C:\\>:"
38112 #: ../tools/virt-win-reg.pl:654
38115 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
38120 #: ../tools/virt-win-reg.pl:656
38121 msgid "Prepare a regedit file containing the registry change:"
38125 #: ../tools/virt-win-reg.pl:658
38128 " cat > test.reg <<'EOF'\n"
38129 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
38130 " \"Test\"=\"c:\\\\test.bat\"\n"
38136 #: ../tools/virt-win-reg.pl:663
38138 "In this example we use the key C<RunOnce> which means that the script will "
38139 "run precisely once when the first user logs in. If you want it to run every "
38140 "time a user logs in, replace C<RunOnce> with C<Run>."
38144 #: ../tools/virt-win-reg.pl:667
38145 msgid "Now update the registry:"
38149 #: ../tools/virt-win-reg.pl:669
38152 " virt-win-reg --merge WindowsGuest test.reg\n"
38157 #: ../tools/virt-win-reg.pl:671
38158 msgid "INSTALLING A SERVICE"
38162 #: ../tools/virt-win-reg.pl:673
38164 "This section assumes you are familiar with Windows services, and you either "
38165 "have a program which handles the Windows Service Control Protocol directly "
38166 "or you want to run any program using a service wrapper like SrvAny or the "
38171 #: ../tools/virt-win-reg.pl:678
38173 "First upload the program and optionally the service wrapper. In this case "
38174 "the test program is called C<test.exe> and we are using the RHSrvAny "
38179 #: ../tools/virt-win-reg.pl:682
38182 " guestfish -i -d WindowsGuest <<EOF\n"
38183 " upload rhsrvany.exe /rhsrvany.exe\n"
38184 " upload test.exe /test.exe\n"
38190 #: ../tools/virt-win-reg.pl:687
38192 "Prepare a regedit file containing the registry changes. In this example, "
38193 "the first registry change is needed for the service itself or the service "
38194 "wrapper (if used). The second registry change is only needed because I am "
38195 "using the RHSrvAny service wrapper."
38199 #: ../tools/virt-win-reg.pl:692
38202 " cat > service.reg <<'EOF'\n"
38203 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
38204 " \"Type\"=dword:00000010\n"
38205 " \"Start\"=dword:00000002\n"
38206 " \"ErrorControl\"=dword:00000001\n"
38207 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
38208 " \"DisplayName\"=\"RHSrvAny\"\n"
38209 " \"ObjectName\"=\"NetworkService\"\n"
38214 #: ../tools/virt-win-reg.pl:701
38217 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
38218 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
38219 " \"PWD\"=\"c:\\\\Temp\"\n"
38225 #: ../tools/virt-win-reg.pl:712
38227 "For use of C<ControlSet001> see the section above in this manual page. You "
38228 "may need to adjust this according to the control set that is in use by the "
38233 #: ../tools/virt-win-reg.pl:718
38235 "C<\"ObjectName\"> controls the privileges that the service will have. An "
38236 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
38237 "privileged account."
38241 #: ../tools/virt-win-reg.pl:724
38243 "For the meaning of the magic numbers, see this Microsoft KB article: "
38244 "L<http://support.microsoft.com/kb/103000>."
38248 #: ../tools/virt-win-reg.pl:729
38249 msgid "Update the registry:"
38253 #: ../tools/virt-win-reg.pl:731
38256 " virt-win-reg --merge WindowsGuest service.reg\n"
38261 #: ../tools/virt-win-reg.pl:735
38263 "Be careful when passing parameters containing C<\\> (backslash) in the "
38264 "shell. Usually you will have to use 'single quotes' or double backslashes "
38265 "(but not both) to protect them from the shell."
38269 #: ../tools/virt-win-reg.pl:739
38270 msgid "Paths and value names are case-insensitive."
38274 #: ../tools/virt-win-reg.pl:748
38276 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
38277 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
38278 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
38279 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
38283 #: ../tools/virt-win-reg.pl:766
38286 " export LIBGUESTFS_DEBUG=1\n"
38287 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
38292 #: ../tools/virt-win-reg.pl:769
38294 "Attach /tmp/virt-win-reg.log to a new bug report at "
38295 "L<https://bugzilla.redhat.com/>"