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.12.8\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-10-19 19:11+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 ../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 ../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 ../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:1051 ../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:92 ../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:160 ../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:102 ../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:135 ../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:142 ../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:144 ../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:146 ../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:2768
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:172 ../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:174 ../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:266 ../inspector/virt-inspector.pod:119 ../rescue/virt-rescue.pod:178
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:268 ../inspector/virt-inspector.pod:121 ../rescue/virt-rescue.pod:180
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:182
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:272 ../inspector/virt-inspector.pod:125 ../rescue/virt-rescue.pod:184 ../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:274 ../inspector/virt-inspector.pod:127 ../rescue/virt-rescue.pod:186 ../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:188 ../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:287 ../inspector/virt-inspector.pod:131 ../rescue/virt-rescue.pod:199 ../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:201
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:205
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:211
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:215
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:219
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:262 ../resize/virt-resize.pod:568 ../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:264 ../resize/virt-resize.pod:570 ../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:1114 ../fuse/guestmount.pod:312 ../inspector/virt-inspector.pod:375 ../resize/virt-resize.pod:575 ../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:314 ../inspector/virt-inspector.pod:377 ../resize/virt-resize.pod:577
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 ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384 ../fish/guestfish.pod:1268 ../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:317 ../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:284 ../resize/virt-resize.pod:580 ../ruby/examples/guestfs-ruby.pod:36 ../src/guestfs.pod:3146 ../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:292 ../resize/virt-resize.pod:601 ../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:294 ../resize/virt-resize.pod:603 ../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 ../examples/guestfs-examples.pod:48 ../examples/guestfs-recipes.pod:400 ../fish/guestfish.pod:1297 ../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:332 ../inspector/virt-inspector.pod:403 ../java/examples/guestfs-java.pod:61 ../ocaml/examples/guestfs-ocaml.pod:94 ../perl/examples/guestfs-perl.pod:55 ../python/examples/guestfs-python.pod:57 ../rescue/virt-rescue.pod:296 ../resize/virt-resize.pod:605 ../ruby/examples/guestfs-ruby.pod:51 ../src/guestfs.pod:3223 ../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:607
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:1302 ../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:337 ../inspector/virt-inspector.pod:407 ../rescue/virt-rescue.pod:300 ../resize/virt-resize.pod:609 ../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:1307 ../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:342 ../inspector/virt-inspector.pod:412 ../rescue/virt-rescue.pod:305 ../resize/virt-resize.pod:614 ../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:1312 ../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:347 ../inspector/virt-inspector.pod:417 ../rescue/virt-rescue.pod:310 ../resize/virt-resize.pod:619 ../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:4210
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:298
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:164
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:1104 ../fish/guestfish-actions.pod:1108 ../fish/guestfish-actions.pod:1112 ../fish/guestfish-actions.pod:1116 ../fish/guestfish-actions.pod:1124 ../fish/guestfish-actions.pod:1128 ../fish/guestfish-actions.pod:1132 ../fish/guestfish-actions.pod:1142 ../fish/guestfish-actions.pod:1146 ../fish/guestfish-actions.pod:1150 ../fish/guestfish-actions.pod:1240 ../fish/guestfish-actions.pod:1244 ../fish/guestfish-actions.pod:1249 ../fish/guestfish-actions.pod:1254 ../fish/guestfish-actions.pod:1296 ../fish/guestfish-actions.pod:1300 ../fish/guestfish-actions.pod:1305 ../fish/guestfish-actions.pod:1555 ../fish/guestfish-actions.pod:1562 ../fish/guestfish-actions.pod:1569 ../fish/guestfish-actions.pod:1960 ../fish/guestfish-actions.pod:1966 ../fish/guestfish-actions.pod:1974 ../fish/guestfish-actions.pod:1981 ../fish/guestfish-actions.pod:1988 ../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:15 ../src/guestfs-actions.pod:22 ../src/guestfs-actions.pod:588 ../src/guestfs-actions.pod:596 ../src/guestfs-actions.pod:603 ../src/guestfs-actions.pod:610 ../src/guestfs-actions.pod:1667 ../src/guestfs-actions.pod:1671 ../src/guestfs-actions.pod:1675 ../src/guestfs-actions.pod:1679 ../src/guestfs-actions.pod:1687 ../src/guestfs-actions.pod:1691 ../src/guestfs-actions.pod:1695 ../src/guestfs-actions.pod:1705 ../src/guestfs-actions.pod:1709 ../src/guestfs-actions.pod:1713 ../src/guestfs-actions.pod:1851 ../src/guestfs-actions.pod:1855 ../src/guestfs-actions.pod:1860 ../src/guestfs-actions.pod:1865 ../src/guestfs-actions.pod:1926 ../src/guestfs-actions.pod:1930 ../src/guestfs-actions.pod:1935 ../src/guestfs-actions.pod:2339 ../src/guestfs-actions.pod:2346 ../src/guestfs-actions.pod:2353 ../src/guestfs-actions.pod:2886 ../src/guestfs-actions.pod:2892 ../src/guestfs-actions.pod:2900 ../src/guestfs-actions.pod:2907 ../src/guestfs-actions.pod:2914 ../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:1087 ../src/guestfs.pod:1091 ../src/guestfs.pod:1095 ../src/guestfs.pod:1100 ../src/guestfs.pod:1108 ../src/guestfs.pod:1127 ../src/guestfs.pod:1135 ../src/guestfs.pod:1157 ../src/guestfs.pod:1161 ../src/guestfs.pod:1165 ../src/guestfs.pod:1169 ../src/guestfs.pod:1173 ../src/guestfs.pod:1177 ../src/guestfs.pod:1666 ../src/guestfs.pod:1671 ../src/guestfs.pod:1675 ../src/guestfs.pod:1777 ../src/guestfs.pod:1782 ../src/guestfs.pod:1786 ../src/guestfs.pod:1796 ../src/guestfs.pod:2070 ../src/guestfs.pod:2075 ../src/guestfs.pod:2081 ../src/guestfs.pod:2089 ../src/guestfs.pod:2536 ../src/guestfs.pod:2542 ../src/guestfs.pod:2547 ../src/guestfs.pod:2553 ../src/guestfs.pod:2938 ../src/guestfs.pod:2943 ../src/guestfs.pod:2947 ../src/guestfs.pod:2951 ../src/guestfs.pod:2955 ../src/guestfs.pod:2969 ../src/guestfs.pod:2974 ../src/guestfs.pod:3200 ../src/guestfs.pod:3204 ../src/guestfs.pod:3208 ../src/guestfs.pod:3212 ../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:105 ../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:107 ../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:1119 ../rescue/virt-rescue.pod:257 ../src/guestfs.pod:3085 ../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 #: ../examples/guestfs-examples.pod:5
2755 msgid "guestfs-examples - Examples of using libguestfs from C"
2759 #: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9
2762 " #include <guestfs.h>\n"
2767 #: ../examples/guestfs-examples.pod:11
2770 " guestfs_h *g = guestfs_create ();\n"
2771 " guestfs_add_drive_ro (g, \"disk.img\");\n"
2772 " guestfs_launch (g);\n"
2777 #: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19
2780 " cc prog.c -o prog -lguestfs\n"
2782 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
2787 #: ../examples/guestfs-examples.pod:21
2789 "This manual page contains examples of calling libguestfs from the C "
2790 "programming language. If you are not familiar with using libguestfs, you "
2791 "also need to read L<guestfs(3)>."
2795 #: ../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
2796 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
2800 #: ../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
2805 #: ../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
2806 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
2810 #: ../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
2815 #: ../examples/guestfs-examples.pod:35
2817 "L<guestfs(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
2818 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, "
2819 "L<http://libguestfs.org/>."
2823 #: ../examples/guestfs-examples.pod:44 ../examples/guestfs-recipes.pod:396 ../fish/guestfish.pod:1293 ../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:328 ../inspector/virt-inspector.pod:389 ../java/examples/guestfs-java.pod:57 ../ocaml/examples/guestfs-ocaml.pod:90 ../perl/examples/guestfs-perl.pod:51 ../python/examples/guestfs-python.pod:53 ../ruby/examples/guestfs-ruby.pod:47 ../src/guestfs.pod:3219 ../test-tool/libguestfs-test-tool.pod:106
2828 #: ../examples/guestfs-examples.pod:46 ../examples/guestfs-recipes.pod:398 ../fish/guestfish.pod:1295 ../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:330 ../java/examples/guestfs-java.pod:59 ../ocaml/examples/guestfs-ocaml.pod:92 ../perl/examples/guestfs-perl.pod:53 ../python/examples/guestfs-python.pod:55 ../ruby/examples/guestfs-ruby.pod:49 ../src/guestfs.pod:3221 ../test-tool/libguestfs-test-tool.pod:108
2829 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
2833 #: ../examples/guestfs-examples.pod:50 ../ocaml/examples/guestfs-ocaml.pod:96 ../python/examples/guestfs-python.pod:59 ../ruby/examples/guestfs-ruby.pod:53
2834 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
2838 #: ../examples/guestfs-examples.pod:52 ../examples/guestfs-recipes.pod:404 ../java/examples/guestfs-java.pod:65 ../ocaml/examples/guestfs-ocaml.pod:98 ../perl/examples/guestfs-perl.pod:59 ../python/examples/guestfs-python.pod:61 ../ruby/examples/guestfs-ruby.pod:55
2840 "The examples in this manual page may be freely copied, modified and "
2841 "distributed without any restrictions."
2845 #: ../examples/guestfs-examples.pod:55 ../examples/guestfs-recipes.pod:407 ../java/examples/guestfs-java.pod:68 ../ocaml/examples/guestfs-ocaml.pod:101 ../perl/examples/guestfs-perl.pod:62 ../python/examples/guestfs-python.pod:64 ../ruby/examples/guestfs-ruby.pod:58 ../src/guestfs.pod:3228
2847 "This library is free software; you can redistribute it and/or modify it "
2848 "under the terms of the GNU Lesser General Public License as published by the "
2849 "Free Software Foundation; either version 2 of the License, or (at your "
2850 "option) any later version."
2854 #: ../examples/guestfs-examples.pod:60 ../examples/guestfs-recipes.pod:412 ../java/examples/guestfs-java.pod:73 ../ocaml/examples/guestfs-ocaml.pod:106 ../perl/examples/guestfs-perl.pod:67 ../python/examples/guestfs-python.pod:69 ../ruby/examples/guestfs-ruby.pod:63 ../src/guestfs.pod:3233
2856 "This library is distributed in the hope that it will be useful, but WITHOUT "
2857 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
2858 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
2863 #: ../examples/guestfs-examples.pod:65 ../examples/guestfs-recipes.pod:417 ../java/examples/guestfs-java.pod:78 ../ocaml/examples/guestfs-ocaml.pod:111 ../perl/examples/guestfs-perl.pod:72 ../python/examples/guestfs-python.pod:74 ../ruby/examples/guestfs-ruby.pod:68 ../src/guestfs.pod:3238
2865 "You should have received a copy of the GNU Lesser General Public License "
2866 "along with this library; if not, write to the Free Software Foundation, "
2867 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
2871 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
2876 #: ../examples/guestfs-recipes.pod:5
2878 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
2879 "here. The only way which works for both sorts of output is to just write "
2880 "the URL directly. Do NOT use L<...> for URLs."
2884 #: ../examples/guestfs-recipes.pod:9
2886 "We break with tradition here and don't use ALL CAPS for the section "
2887 "headings, as this makes them much easier to read."
2891 #: ../examples/guestfs-recipes.pod:16
2892 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
2896 #: ../examples/guestfs-recipes.pod:20
2898 "This page contains recipes for and links to things you can do using "
2899 "libguestfs, L<guestfish(1)> and the virt tools."
2903 #: ../examples/guestfs-recipes.pod:23
2904 msgid "Audit a virtual machine for setuid files"
2908 #: ../examples/guestfs-recipes.pod:25
2910 "The link below contains a small program which can be used to audit a Linux "
2911 "virtual machine to see what setuid and setgid files it contains."
2915 #: ../examples/guestfs-recipes.pod:28
2916 msgid "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-files/#content"
2920 #: ../examples/guestfs-recipes.pod:30
2921 msgid "Change the background image in a Windows XP VM"
2925 #: ../examples/guestfs-recipes.pod:32
2927 "The links below explain how to use L<guestfish(1)> to change the background "
2928 "image for a user of a Windows XP VM. Unfortunately the technique appears to "
2929 "be substantially different for each version of Windows."
2933 #: ../examples/guestfs-recipes.pod:37
2935 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html "
2936 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
2940 #: ../examples/guestfs-recipes.pod:40
2941 msgid "Cloning a virtual machine (Linux)"
2945 #: ../examples/guestfs-recipes.pod:42
2947 "The guestfish technique described in the link below works well for most "
2948 "Linux VMs. Depending on the Linux distro you may need to change the paths "
2953 #: ../examples/guestfs-recipes.pod:46
2954 msgid "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-vm/#content"
2958 #: ../examples/guestfs-recipes.pod:48
2960 "Avoid L<virt-clone(1)>. Currently what to do about virt-clone is under "
2965 #: ../examples/guestfs-recipes.pod:51
2966 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
2970 #: ../examples/guestfs-recipes.pod:53
2971 msgid "Cloning a virtual machine (Windows)"
2975 #: ../examples/guestfs-recipes.pod:55
2977 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
2978 "straightforward. Currently there is code in the Aeolus Oz project which "
2979 "does this (using libguestfs). As part of our review of the virt-clone tool, "
2980 "we may add sysprepping ability."
2984 #: ../examples/guestfs-recipes.pod:60
2986 "https://github.com/clalancette/oz "
2987 "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
2991 #: ../examples/guestfs-recipes.pod:63
2992 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
2996 #: ../examples/guestfs-recipes.pod:65
2997 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
3001 #: ../examples/guestfs-recipes.pod:67
3004 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
3009 #: ../examples/guestfs-recipes.pod:69
3010 msgid "To export just a subdirectory, eg. C</files>, do:"
3014 #: ../examples/guestfs-recipes.pod:71
3017 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
3022 #: ../examples/guestfs-recipes.pod:73
3023 msgid "Create empty disk images"
3027 #: ../examples/guestfs-recipes.pod:75
3029 "You can use the L<guestfish(1)> I<-N> option to create empty disk images. "
3030 "The useful guide below explains the options available."
3034 #: ../examples/guestfs-recipes.pod:78
3035 msgid "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/#content"
3039 #: ../examples/guestfs-recipes.pod:80
3040 msgid "Dump raw filesystem content from inside a disk image or VM"
3044 #: ../examples/guestfs-recipes.pod:82
3046 "You can use the L<guestfish(1)> C<download> command to extract the raw "
3047 "filesystem content from any filesystem in a disk image or a VM (even one "
3048 "which is encrypted or buried inside an LV):"
3052 #: ../examples/guestfs-recipes.pod:86
3055 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
3060 #: ../examples/guestfs-recipes.pod:88
3063 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
3068 #: ../examples/guestfs-recipes.pod:90
3069 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
3073 #: ../examples/guestfs-recipes.pod:92
3074 msgid "Edit grub configuration in a VM"
3078 #: ../examples/guestfs-recipes.pod:94
3079 msgid "You can use this to:"
3083 #: ../examples/guestfs-recipes.pod:100
3084 msgid "Fix a virtual machine that does not boot."
3088 #: ../examples/guestfs-recipes.pod:104
3089 msgid "Change which kernel is used to boot the VM."
3093 #: ../examples/guestfs-recipes.pod:108
3094 msgid "Change kernel command line options."
3098 #: ../examples/guestfs-recipes.pod:112
3099 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
3103 #: ../examples/guestfs-recipes.pod:114
3106 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
3111 #: ../examples/guestfs-recipes.pod:116
3113 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
3118 #: ../examples/guestfs-recipes.pod:119
3121 " virt-rescue -d BrokenGuest\n"
3126 #: ../examples/guestfs-recipes.pod:121
3127 msgid "Export any directory from a VM"
3131 #: ../examples/guestfs-recipes.pod:123
3132 msgid "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
3136 #: ../examples/guestfs-recipes.pod:126
3139 " virt-copy-out -d Guest /home .\n"
3144 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1292 ../fish/guestfish-actions.pod:1551 ../fish/guestfish-actions.pod:1956 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:2335 ../src/guestfs-actions.pod:2882 ../src/guestfs.pod:1662 ../tools/virt-win-reg.pl:706
3149 #: ../examples/guestfs-recipes.pod:134
3151 "The final dot of the command is not a printing error. It means we want to "
3152 "copy out to the current directory."
3156 #: ../examples/guestfs-recipes.pod:139
3157 msgid "This creates a directory called C<home> under the current directory."
3161 #: ../examples/guestfs-recipes.pod:143
3163 "If the guest is a Windows guest then you can use drive letters and "
3164 "backslashes, but you must prefix the path with C<win:> and quote it to "
3165 "protect it from the shell, like this:"
3169 #: ../examples/guestfs-recipes.pod:147
3172 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
3177 #: ../examples/guestfs-recipes.pod:149
3178 msgid "To get the output as a compressed tarball, do:"
3182 #: ../examples/guestfs-recipes.pod:151
3185 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
3190 #: ../examples/guestfs-recipes.pod:153
3192 "Although it sounds tempting, this is usually not a reliable way to get a "
3193 "backup from a running guest. See the entry in the FAQ: "
3194 "http://libguestfs.org/FAQ.html#backup"
3198 #: ../examples/guestfs-recipes.pod:157
3199 msgid "Find out which user is using the most space"
3203 #: ../examples/guestfs-recipes.pod:159
3205 "This simple script examines a Linux guest to find out which user is using "
3206 "the most space in their home directory:"
3210 #: ../examples/guestfs-recipes.pod:162
3218 #: ../examples/guestfs-recipes.pod:164 ../fish/guestfish.pod:984
3226 #: ../examples/guestfs-recipes.pod:166
3235 #: ../examples/guestfs-recipes.pod:169
3238 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
3243 #: ../examples/guestfs-recipes.pod:171
3246 " for d in $(guestfish --remote ls \"$dir\"); do\n"
3247 " echo -n \"$dir/$d\"\n"
3249 " guestfish --remote du \"$dir/$d\";\n"
3250 " done | sort -nr -k 2\n"
3255 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
3258 " guestfish --remote exit\n"
3263 #: ../examples/guestfs-recipes.pod:179
3264 msgid "Get DHCP address from a VM"
3268 #: ../examples/guestfs-recipes.pod:181
3270 "The link below explains the many different possible techniques for getting "
3271 "the last assigned DHCP address of a virtual machine."
3275 #: ../examples/guestfs-recipes.pod:184
3276 msgid "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-a-virtual-machine-disk-image/#content"
3280 #: ../examples/guestfs-recipes.pod:186
3282 "In the libguestfs source examples directory you will find the latest version "
3283 "of the C<virt-dhcp-address.c> program."
3287 #: ../examples/guestfs-recipes.pod:189
3288 msgid "Get the operating system product name string"
3292 #: ../examples/guestfs-recipes.pod:191
3293 msgid "Save the following script into a file called C<product-name.sh>:"
3297 #: ../examples/guestfs-recipes.pod:193
3302 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3303 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3304 " guestfish --remote inspect-get-product-name \"$root\"\n"
3305 " guestfish --remote exit\n"
3310 #: ../examples/guestfs-recipes.pod:200
3311 msgid "Make the script executable and run it on a named guest:"
3315 #: ../examples/guestfs-recipes.pod:202
3318 " # product-name.sh RHEL60x64\n"
3319 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
3324 #: ../examples/guestfs-recipes.pod:205
3326 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
3327 "C<xpath> command line tool or from your favourite programming language:"
3331 #: ../examples/guestfs-recipes.pod:209
3334 " # virt-inspector RHEL60x64 > xml\n"
3335 " # xpath '//product_name' < xml\n"
3338 " <product_name>Red Hat Enterprise Linux Server release 6.0 "
3339 "(Santiago)</product_name>\n"
3344 #: ../examples/guestfs-recipes.pod:215
3345 msgid "Get the default boot kernel for a Linux VM"
3349 #: ../examples/guestfs-recipes.pod:217
3351 "The link below contains a program to print the default boot kernel for a "
3356 #: ../examples/guestfs-recipes.pod:220
3357 msgid "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-kernel-for-a-vm/#content"
3361 #: ../examples/guestfs-recipes.pod:222
3363 "It uses Augeas, and the technique is generally applicable for many different "
3368 #: ../examples/guestfs-recipes.pod:229
3369 msgid "listing the user accounts in the guest"
3373 #: ../examples/guestfs-recipes.pod:233
3374 msgid "what repositories is it configured to use"
3378 #: ../examples/guestfs-recipes.pod:237
3379 msgid "what NTP servers does it connect to"
3383 #: ../examples/guestfs-recipes.pod:241
3384 msgid "what were the boot messages last time it booted"
3388 #: ../examples/guestfs-recipes.pod:245
3389 msgid "listing who was logged in recently"
3393 #: ../examples/guestfs-recipes.pod:249
3394 msgid "http://augeas.net/"
3398 #: ../examples/guestfs-recipes.pod:251
3399 msgid "Install RPMs in a guest"
3403 #: ../examples/guestfs-recipes.pod:253
3405 "The link below contains a method to install RPMs in a guest. In fact the "
3406 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
3407 "installs them next time the guest is booted. You could use this technique "
3408 "to install vital security updates in an offline guest."
3412 #: ../examples/guestfs-recipes.pod:259
3413 msgid "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
3417 #: ../examples/guestfs-recipes.pod:261
3418 msgid "List applications installed in a VM"
3422 #: ../examples/guestfs-recipes.pod:263
3423 msgid "Save the following to a file C<list-apps.sh>:"
3427 #: ../examples/guestfs-recipes.pod:265
3432 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3433 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3434 " guestfish --remote inspect-list-applications \"$root\"\n"
3435 " guestfish --remote exit\n"
3440 #: ../examples/guestfs-recipes.pod:272
3442 "Make the file executable and then you can run it on any named virtual "
3447 #: ../examples/guestfs-recipes.pod:275
3450 " # list-apps.sh WinGuest\n"
3452 " app_name: Mozilla Firefox (3.6.12)\n"
3453 " app_display_name: Mozilla Firefox (3.6.12)\n"
3455 " app_version: 3.6.12 (en-GB)\n"
3457 " app_install_path: C:\\Program Files\\Mozilla Firefox\n"
3458 " app_trans_path:\n"
3459 " app_publisher: Mozilla\n"
3460 " app_url: http://www.mozilla.com/en-GB/\n"
3461 " app_source_package:\n"
3463 " app_description: Mozilla Firefox\n"
3466 " app_name: VLC media player\n"
3467 " app_display_name: VLC media player 1.1.5\n"
3469 " app_version: 1.1.5\n"
3471 " app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
3472 " app_trans_path:\n"
3473 " app_publisher: VideoLAN\n"
3474 " app_url: http://www.videolan.org/\n"
3475 " app_source_package:\n"
3477 " app_description:\n"
3483 #: ../examples/guestfs-recipes.pod:305
3485 "If you want to run the script on disk images (instead of libvirt virtual "
3486 "machines), change C<-d \"$1\"> to C<-a \"$1\">. See also "
3487 "L<virt-inspector(1)>."
3491 #: ../examples/guestfs-recipes.pod:309
3492 msgid "List files and directories in a VM"
3496 #: ../examples/guestfs-recipes.pod:311
3497 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
3501 #: ../examples/guestfs-recipes.pod:313
3504 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
3509 #: ../examples/guestfs-recipes.pod:315
3510 msgid "List services in a Windows VM"
3514 #: ../examples/guestfs-recipes.pod:317
3516 "The link below contains a script that can be used to list out the services "
3517 "from a Windows VM, and whether those services run at boot time or are loaded "
3522 #: ../examples/guestfs-recipes.pod:321
3523 msgid "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/#content"
3527 #: ../examples/guestfs-recipes.pod:323
3528 msgid "Make a disk image sparse"
3532 #: ../examples/guestfs-recipes.pod:325
3534 "The link below contains some guides for making a disk image sparse (or "
3535 "reintroducing sparseness)."
3539 #: ../examples/guestfs-recipes.pod:328
3540 msgid "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
3544 #: ../examples/guestfs-recipes.pod:330
3545 msgid "Monitor disk usage over time"
3549 #: ../examples/guestfs-recipes.pod:332
3551 "You can use L<virt-df(1)> to monitor disk usage of your guests over time. "
3552 "The link below contains a guide."
3556 #: ../examples/guestfs-recipes.pod:335
3557 msgid "http://virt-tools.org/learning/advanced-virt-df/"
3561 #: ../examples/guestfs-recipes.pod:337
3562 msgid "Reading the Windows Event Log from Windows Vista (or later)"
3566 #: ../examples/guestfs-recipes.pod:339
3568 "L<guestfish(1)> plus the tools described in the link below can be used to "
3569 "read out the Windows Event Log from any virtual machine running Windows "
3570 "Vista or a later version."
3574 #: ../examples/guestfs-recipes.pod:343
3575 msgid "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-guestfish/#content"
3579 #: ../examples/guestfs-recipes.pod:345
3580 msgid "Remove root password (Linux)"
3584 #: ../examples/guestfs-recipes.pod:347
3586 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
3587 "files. One use is to remove the root password from a Linux guest:"
3591 #: ../examples/guestfs-recipes.pod:350
3594 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
3599 #: ../examples/guestfs-recipes.pod:352
3600 msgid "Remove Administrator password (Windows)"
3604 #: ../examples/guestfs-recipes.pod:354
3606 "The link below contains one technique for removing the Administrator "
3607 "password from a Windows VM, or to be more precise, it gives you a command "
3608 "prompt the next time you log in which you can use to bypass any security:"
3612 #: ../examples/guestfs-recipes.pod:359
3613 msgid "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-administrator-password-with-guestfish/"
3617 #: ../examples/guestfs-recipes.pod:361
3618 msgid "Unpack a live CD"
3622 #: ../examples/guestfs-recipes.pod:363
3624 "Linux live CDs often contain multiple layers of disk images wrapped like a "
3625 "Russian doll. You can use L<guestfish(1)> to look inside these multiple "
3626 "layers, as outlined in the guide below."
3630 #: ../examples/guestfs-recipes.pod:367
3631 msgid "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-cd/#content"
3635 #: ../examples/guestfs-recipes.pod:369
3636 msgid "Uploading and downloading files"
3640 #: ../examples/guestfs-recipes.pod:371
3642 "The link below contains general tips on uploading (copying in) and "
3643 "downloading (copying out) files from VMs."
3647 #: ../examples/guestfs-recipes.pod:374
3648 msgid "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
3652 #: ../examples/guestfs-recipes.pod:376
3653 msgid "Use libguestfs tools on VMware ESX guests"
3657 #: ../examples/guestfs-recipes.pod:378
3659 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
3660 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
3664 #: ../examples/guestfs-recipes.pod:382
3665 msgid "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-guests/#content"
3669 #: ../examples/guestfs-recipes.pod:386
3671 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
3672 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
3673 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
3677 #: ../examples/guestfs-recipes.pod:402
3678 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
3682 #: ../fish/guestfish-actions.pod:1
3687 #: ../fish/guestfish-actions.pod:3
3690 " add-cdrom filename\n"
3695 #: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:7
3696 msgid "This function adds a virtual CD-ROM disk image to the guest."
3700 #: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:9
3701 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
3705 #: ../fish/guestfish-actions.pod:15
3707 "This call checks for the existence of C<filename>. This stops you from "
3708 "specifying other types of drive which are supported by qemu such as C<nbd:> "
3709 "and C<http:> URLs. To specify those, use the general L</config> call "
3714 #: ../fish/guestfish-actions.pod:22
3716 "If you just want to add an ISO file (often you use this as an efficient way "
3717 "to transfer large files into the guest), then you should probably use "
3718 "L</add-drive-ro> instead."
3722 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
3724 "This function is deprecated. In new code, use the L</add_drive_opts> call "
3729 #: ../fish/guestfish-actions.pod:31 ../fish/guestfish-actions.pod:166 ../fish/guestfish-actions.pod:180 ../fish/guestfish-actions.pod:991 ../fish/guestfish-actions.pod:1351 ../fish/guestfish-actions.pod:1365 ../fish/guestfish-actions.pod:3112 ../fish/guestfish-actions.pod:3319 ../fish/guestfish-actions.pod:3433 ../fish/guestfish-actions.pod:3481 ../fish/guestfish-actions.pod:4382 ../fish/guestfish-actions.pod:4405 ../fish/guestfish-actions.pod:4427 ../fish/guestfish-actions.pod:4465 ../fish/guestfish-actions.pod:5114 ../fish/guestfish-actions.pod:5220 ../src/guestfs-actions.pod:35 ../src/guestfs-actions.pod:257 ../src/guestfs-actions.pod:278 ../src/guestfs-actions.pod:1518 ../src/guestfs-actions.pod:2013 ../src/guestfs-actions.pod:2034 ../src/guestfs-actions.pod:4655 ../src/guestfs-actions.pod:4974 ../src/guestfs-actions.pod:5192 ../src/guestfs-actions.pod:5282 ../src/guestfs-actions.pod:6571 ../src/guestfs-actions.pod:6601 ../src/guestfs-actions.pod:6634 ../src/guestfs-actions.pod:6693 ../src/guestfs-actions.pod:7629 ../src/guestfs-actions.pod:7741 ../src/guestfs-actions.pod:7919
3731 "Deprecated functions will not be removed from the API, but the fact that "
3732 "they are deprecated indicates that there are problems with correct use of "
3737 #: ../fish/guestfish-actions.pod:35
3742 #: ../fish/guestfish-actions.pod:37
3747 #: ../fish/guestfish-actions.pod:39
3750 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] "
3756 #: ../fish/guestfish-actions.pod:41
3758 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
3759 "It works by connecting to libvirt, requesting the domain and domain XML from "
3760 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
3764 #: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:64
3766 "The number of disks added is returned. This operation is atomic: if an "
3767 "error is returned, then no disks are added."
3771 #: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:67
3773 "This function does some minimal checks to make sure the libvirt domain is "
3774 "not running (unless C<readonly> is true). In a future version we will try "
3775 "to acquire the libvirt lock on each disk."
3779 #: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:71
3781 "Disks must be accessible locally. This often means that adding disks from a "
3782 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
3783 "unless those disks are accessible via the same device path locally too."
3787 #: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:76
3789 "The optional C<libvirturi> parameter sets the libvirt URI (see "
3790 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
3791 "default libvirt URI (or one set through an environment variable, see the "
3792 "libvirt documentation for full details)."
3796 #: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:82
3798 "The optional C<live> flag controls whether this call will try to connect to "
3799 "a running virtual machine C<guestfsd> process if it sees a suitable "
3800 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
3801 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
3802 "DAEMONS> for more information."
3806 #: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:89
3808 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
3809 "passed instead of the domain name. The C<dom> string is treated as a UUID "
3810 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
3815 #: ../fish/guestfish-actions.pod:76
3817 "The other optional parameters are passed directly through to "
3818 "L</add-drive-opts>."
3822 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143 ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:1995 ../fish/guestfish-actions.pod:3161 ../fish/guestfish-actions.pod:3334 ../fish/guestfish-actions.pod:3469
3824 "This command has one or more optional arguments. See L</OPTIONAL "
3829 #: ../fish/guestfish-actions.pod:81
3834 #: ../fish/guestfish-actions.pod:83
3837 " add-drive filename\n"
3842 #: ../fish/guestfish-actions.pod:85
3844 "This function is the equivalent of calling L</add-drive-opts> with no "
3845 "optional parameters, so the disk is added writable, with the format being "
3846 "detected automatically."
3850 #: ../fish/guestfish-actions.pod:89
3852 "Automatic detection of the format opens you up to a potential security hole "
3853 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
3854 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
3855 "you should think about replacing calls to this function with calls to "
3856 "L</add-drive-opts>, and specifying the format."
3860 #: ../fish/guestfish-actions.pod:96
3861 msgid "add-drive-opts"
3865 #: ../fish/guestfish-actions.pod:98
3870 #: ../fish/guestfish-actions.pod:100
3873 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
3878 #: ../fish/guestfish-actions.pod:102 ../src/guestfs-actions.pod:160
3880 "This function adds a virtual machine disk image C<filename> to libguestfs. "
3881 "The first time you call this function, the disk appears as C</dev/sda>, the "
3882 "second time as C</dev/sdb>, and so on."
3886 #: ../fish/guestfish-actions.pod:107 ../src/guestfs-actions.pod:165
3888 "You don't necessarily need to be root when using libguestfs. However you "
3889 "obviously do need sufficient permissions to access the filename for whatever "
3890 "operations you want to perform (ie. read access if you just want to read the "
3891 "image or write access if you want to modify the image)."
3895 #: ../fish/guestfish-actions.pod:113 ../src/guestfs-actions.pod:171
3896 msgid "This call checks that C<filename> exists."
3900 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3123 ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4682
3901 msgid "The optional arguments are:"
3905 #: ../fish/guestfish-actions.pod:119 ../src/guestfs-actions.pod:177
3910 #: ../fish/guestfish-actions.pod:121 ../src/guestfs-actions.pod:179
3912 "If true then the image is treated as read-only. Writes are still allowed, "
3913 "but they are stored in a temporary snapshot overlay which is discarded at "
3914 "the end. The disk that you add is not modified."
3918 #: ../fish/guestfish-actions.pod:125 ../src/guestfs-actions.pod:183
3923 #: ../fish/guestfish-actions.pod:127
3925 "This forces the image format. If you omit this (or use L</add-drive> or "
3926 "L</add-drive-ro>) then the format is automatically detected. Possible "
3927 "formats include C<raw> and C<qcow2>."
3931 #: ../fish/guestfish-actions.pod:131 ../src/guestfs-actions.pod:189
3933 "Automatic detection of the format opens you up to a potential security hole "
3934 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
3935 "RHBZ#642934. Specifying the format closes this security hole."
3939 #: ../fish/guestfish-actions.pod:136 ../src/guestfs-actions.pod:194
3944 #: ../fish/guestfish-actions.pod:138
3946 "This rarely-used option lets you emulate the behaviour of the deprecated "
3947 "L</add-drive-with-if> call (q.v.)"
3951 #: ../fish/guestfish-actions.pod:145
3952 msgid "add-drive-ro"
3956 #: ../fish/guestfish-actions.pod:147
3961 #: ../fish/guestfish-actions.pod:149
3964 " add-drive-ro filename\n"
3969 #: ../fish/guestfish-actions.pod:151
3971 "This function is the equivalent of calling L</add-drive-opts> with the "
3972 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
3973 "is added read-only, with the format being detected automatically."
3977 #: ../fish/guestfish-actions.pod:156
3978 msgid "add-drive-ro-with-if"
3982 #: ../fish/guestfish-actions.pod:158
3985 " add-drive-ro-with-if filename iface\n"
3990 #: ../fish/guestfish-actions.pod:160
3992 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
3993 "interface emulation to use at run time."
3997 #: ../fish/guestfish-actions.pod:170
3998 msgid "add-drive-with-if"
4002 #: ../fish/guestfish-actions.pod:172
4005 " add-drive-with-if filename iface\n"
4010 #: ../fish/guestfish-actions.pod:174
4012 "This is the same as L</add-drive> but it allows you to specify the QEMU "
4013 "interface emulation to use at run time."
4017 #: ../fish/guestfish-actions.pod:184
4022 #: ../fish/guestfish-actions.pod:186
4025 " aug-clear augpath\n"
4030 #: ../fish/guestfish-actions.pod:188 ../src/guestfs-actions.pod:290
4032 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4033 "L<augtool(1)> C<clear> command."
4037 #: ../fish/guestfish-actions.pod:191
4042 #: ../fish/guestfish-actions.pod:193
4050 #: ../fish/guestfish-actions.pod:195
4052 "Close the current Augeas handle and free up any resources used by it. After "
4053 "calling this, you have to call L</aug-init> again before you can use any "
4054 "other Augeas functions."
4058 #: ../fish/guestfish-actions.pod:200
4063 #: ../fish/guestfish-actions.pod:202
4066 " aug-defnode name expr val\n"
4071 #: ../fish/guestfish-actions.pod:204 ../src/guestfs-actions.pod:319
4072 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4076 #: ../fish/guestfish-actions.pod:207
4078 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4079 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
4080 "containing that single node."
4084 #: ../fish/guestfish-actions.pod:211 ../src/guestfs-actions.pod:326
4086 "On success this returns a pair containing the number of nodes in the "
4087 "nodeset, and a boolean flag if a node was created."
4091 #: ../fish/guestfish-actions.pod:215
4096 #: ../fish/guestfish-actions.pod:217
4099 " aug-defvar name expr\n"
4104 #: ../fish/guestfish-actions.pod:219 ../src/guestfs-actions.pod:343
4106 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4107 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4111 #: ../fish/guestfish-actions.pod:223 ../src/guestfs-actions.pod:347
4113 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4114 "evaluates to something which is not a nodeset."
4118 #: ../fish/guestfish-actions.pod:226
4123 #: ../fish/guestfish-actions.pod:228
4126 " aug-get augpath\n"
4131 #: ../fish/guestfish-actions.pod:230 ../src/guestfs-actions.pod:360
4133 "Look up the value associated with C<path>. If C<path> matches exactly one "
4134 "node, the C<value> is returned."
4138 #: ../fish/guestfish-actions.pod:233
4143 #: ../fish/guestfish-actions.pod:235
4146 " aug-init root flags\n"
4151 #: ../fish/guestfish-actions.pod:237 ../src/guestfs-actions.pod:375
4153 "Create a new Augeas handle for editing configuration files. If there was "
4154 "any previous Augeas handle associated with this guestfs session, then it is "
4159 #: ../fish/guestfish-actions.pod:241
4160 msgid "You must call this before using any other L</aug-*> commands."
4164 #: ../fish/guestfish-actions.pod:244 ../src/guestfs-actions.pod:382
4165 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4169 #: ../fish/guestfish-actions.pod:247 ../src/guestfs-actions.pod:385
4171 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4172 "logical I<or> of the following integers:"
4176 #: ../fish/guestfish-actions.pod:253 ../src/guestfs-actions.pod:391
4177 msgid "C<AUG_SAVE_BACKUP> = 1"
4181 #: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:393
4182 msgid "Keep the original file with a C<.augsave> extension."
4186 #: ../fish/guestfish-actions.pod:257 ../src/guestfs-actions.pod:395
4187 msgid "C<AUG_SAVE_NEWFILE> = 2"
4191 #: ../fish/guestfish-actions.pod:259 ../src/guestfs-actions.pod:397
4193 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4194 "original. Overrides C<AUG_SAVE_BACKUP>."
4198 #: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:400
4199 msgid "C<AUG_TYPE_CHECK> = 4"
4203 #: ../fish/guestfish-actions.pod:264 ../src/guestfs-actions.pod:402
4204 msgid "Typecheck lenses."
4208 #: ../fish/guestfish-actions.pod:266
4210 "This option is only useful when debugging Augeas lenses. Use of this option "
4211 "may require additional memory for the libguestfs appliance. You may need to "
4212 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
4216 #: ../fish/guestfish-actions.pod:271 ../src/guestfs-actions.pod:409
4217 msgid "C<AUG_NO_STDINC> = 8"
4221 #: ../fish/guestfish-actions.pod:273 ../src/guestfs-actions.pod:411
4222 msgid "Do not use standard load path for modules."
4226 #: ../fish/guestfish-actions.pod:275 ../src/guestfs-actions.pod:413
4227 msgid "C<AUG_SAVE_NOOP> = 16"
4231 #: ../fish/guestfish-actions.pod:277 ../src/guestfs-actions.pod:415
4232 msgid "Make save a no-op, just record what would have been changed."
4236 #: ../fish/guestfish-actions.pod:279 ../src/guestfs-actions.pod:417
4237 msgid "C<AUG_NO_LOAD> = 32"
4241 #: ../fish/guestfish-actions.pod:281
4242 msgid "Do not load the tree in L</aug-init>."
4246 #: ../fish/guestfish-actions.pod:285
4247 msgid "To close the handle, you can call L</aug-close>."
4251 #: ../fish/guestfish-actions.pod:287 ../src/guestfs-actions.pod:425
4252 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4256 #: ../fish/guestfish-actions.pod:289
4261 #: ../fish/guestfish-actions.pod:291
4264 " aug-insert augpath label true|false\n"
4269 #: ../fish/guestfish-actions.pod:293 ../src/guestfs-actions.pod:439
4271 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4272 "or after C<path> (depending on the boolean flag C<before>)."
4276 #: ../fish/guestfish-actions.pod:297 ../src/guestfs-actions.pod:443
4278 "C<path> must match exactly one existing node in the tree, and C<label> must "
4279 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4283 #: ../fish/guestfish-actions.pod:301
4288 #: ../fish/guestfish-actions.pod:303
4296 #: ../fish/guestfish-actions.pod:305 ../src/guestfs-actions.pod:456
4297 msgid "Load files into the tree."
4301 #: ../fish/guestfish-actions.pod:307 ../src/guestfs-actions.pod:458
4302 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4306 #: ../fish/guestfish-actions.pod:310
4311 #: ../fish/guestfish-actions.pod:312
4319 #: ../fish/guestfish-actions.pod:314
4321 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
4322 "resulting nodes into alphabetical order."
4326 #: ../fish/guestfish-actions.pod:317
4331 #: ../fish/guestfish-actions.pod:319
4334 " aug-match augpath\n"
4339 #: ../fish/guestfish-actions.pod:321 ../src/guestfs-actions.pod:486
4341 "Returns a list of paths which match the path expression C<path>. The "
4342 "returned paths are sufficiently qualified so that they match exactly one "
4343 "node in the current tree."
4347 #: ../fish/guestfish-actions.pod:325
4352 #: ../fish/guestfish-actions.pod:327
4355 " aug-mv src dest\n"
4360 #: ../fish/guestfish-actions.pod:329 ../src/guestfs-actions.pod:503
4362 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4363 "C<dest> is overwritten if it exists."
4367 #: ../fish/guestfish-actions.pod:332
4372 #: ../fish/guestfish-actions.pod:334
4380 #: ../fish/guestfish-actions.pod:336 ../src/guestfs-actions.pod:516
4381 msgid "Remove C<path> and all of its children."
4385 #: ../fish/guestfish-actions.pod:338 ../src/guestfs-actions.pod:518
4386 msgid "On success this returns the number of entries which were removed."
4390 #: ../fish/guestfish-actions.pod:340
4395 #: ../fish/guestfish-actions.pod:342
4403 #: ../fish/guestfish-actions.pod:344 ../src/guestfs-actions.pod:529
4404 msgid "This writes all pending changes to disk."
4408 #: ../fish/guestfish-actions.pod:346
4410 "The flags which were passed to L</aug-init> affect exactly how files are "
4415 #: ../fish/guestfish-actions.pod:349
4420 #: ../fish/guestfish-actions.pod:351
4423 " aug-set augpath val\n"
4428 #: ../fish/guestfish-actions.pod:353 ../src/guestfs-actions.pod:545
4429 msgid "Set the value associated with C<path> to C<val>."
4433 #: ../fish/guestfish-actions.pod:355
4435 "In the Augeas API, it is possible to clear a node by setting the value to "
4436 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4437 "this call. Instead you must use the L</aug-clear> call."
4441 #: ../fish/guestfish-actions.pod:360
4446 #: ../fish/guestfish-actions.pod:362
4449 " available 'groups ...'\n"
4454 #: ../fish/guestfish-actions.pod:364 ../src/guestfs-actions.pod:562
4456 "This command is used to check the availability of some groups of "
4457 "functionality in the appliance, which not all builds of the libguestfs "
4458 "appliance will be able to provide."
4462 #: ../fish/guestfish-actions.pod:368
4464 "The libguestfs groups, and the functions that those groups correspond to, "
4465 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4466 "runtime by calling L</available-all-groups>."
4470 #: ../fish/guestfish-actions.pod:373 ../src/guestfs-actions.pod:571
4472 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
4473 "\"augeas\"]> would check for the availability of the Linux inotify functions "
4474 "and Augeas (configuration file editing) functions."
4478 #: ../fish/guestfish-actions.pod:378 ../src/guestfs-actions.pod:576
4479 msgid "The command returns no error if I<all> requested groups are available."
4483 #: ../fish/guestfish-actions.pod:380 ../src/guestfs-actions.pod:578
4485 "It fails with an error if one or more of the requested groups is unavailable "
4490 #: ../fish/guestfish-actions.pod:383 ../src/guestfs-actions.pod:581
4492 "If an unknown group name is included in the list of groups then an error is "
4497 #: ../fish/guestfish-actions.pod:386 ../src/guestfs-actions.pod:584
4502 #: ../fish/guestfish-actions.pod:392
4503 msgid "You must call L</launch> before calling this function."
4507 #: ../fish/guestfish-actions.pod:394 ../src/guestfs-actions.pod:592
4509 "The reason is because we don't know what groups are supported by the "
4510 "appliance/daemon until it is running and can be queried."
4514 #: ../fish/guestfish-actions.pod:400 ../src/guestfs-actions.pod:598
4516 "If a group of functions is available, this does not necessarily mean that "
4517 "they will work. You still have to check for errors when calling individual "
4518 "API functions even if they are available."
4522 #: ../fish/guestfish-actions.pod:407 ../src/guestfs-actions.pod:605
4524 "It is usually the job of distro packagers to build complete functionality "
4525 "into the libguestfs appliance. Upstream libguestfs, if built from source "
4526 "with all requirements satisfied, will support everything."
4530 #: ../fish/guestfish-actions.pod:414
4532 "This call was added in version C<1.0.80>. In previous versions of "
4533 "libguestfs all you could do would be to speculatively execute a command to "
4534 "find out if the daemon implemented it. See also L</version>."
4538 #: ../fish/guestfish-actions.pod:421
4539 msgid "available-all-groups"
4543 #: ../fish/guestfish-actions.pod:423
4546 " available-all-groups\n"
4551 #: ../fish/guestfish-actions.pod:425
4553 "This command returns a list of all optional groups that this daemon knows "
4554 "about. Note this returns both supported and unsupported groups. To find "
4555 "out which ones the daemon can actually support you have to call "
4556 "L</available> on each member of the returned list."
4560 #: ../fish/guestfish-actions.pod:431
4561 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
4565 #: ../fish/guestfish-actions.pod:433
4570 #: ../fish/guestfish-actions.pod:435
4573 " base64-in (base64file|-) filename\n"
4578 #: ../fish/guestfish-actions.pod:437 ../src/guestfs-actions.pod:649
4579 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
4583 #: ../fish/guestfish-actions.pod:440 ../fish/guestfish-actions.pod:449 ../fish/guestfish-actions.pod:698 ../fish/guestfish-actions.pod:867 ../fish/guestfish-actions.pod:886 ../fish/guestfish-actions.pod:1260 ../fish/guestfish-actions.pod:4685 ../fish/guestfish-actions.pod:4697 ../fish/guestfish-actions.pod:4708 ../fish/guestfish-actions.pod:4719 ../fish/guestfish-actions.pod:4771 ../fish/guestfish-actions.pod:4780 ../fish/guestfish-actions.pod:4834 ../fish/guestfish-actions.pod:4857
4584 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
4588 #: ../fish/guestfish-actions.pod:442
4593 #: ../fish/guestfish-actions.pod:444
4596 " base64-out filename (base64file|-)\n"
4601 #: ../fish/guestfish-actions.pod:446 ../src/guestfs-actions.pod:663
4603 "This command downloads the contents of C<filename>, writing it out to local "
4604 "file C<base64file> encoded as base64."
4608 #: ../fish/guestfish-actions.pod:451
4609 msgid "blockdev-flushbufs"
4613 #: ../fish/guestfish-actions.pod:453
4616 " blockdev-flushbufs device\n"
4621 #: ../fish/guestfish-actions.pod:455 ../src/guestfs-actions.pod:676
4622 msgid "This tells the kernel to flush internal buffers associated with C<device>."
4626 #: ../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
4627 msgid "This uses the L<blockdev(8)> command."
4631 #: ../fish/guestfish-actions.pod:460
4632 msgid "blockdev-getbsz"
4636 #: ../fish/guestfish-actions.pod:462
4639 " blockdev-getbsz device\n"
4644 #: ../fish/guestfish-actions.pod:464 ../src/guestfs-actions.pod:691
4645 msgid "This returns the block size of a device."
4649 #: ../fish/guestfish-actions.pod:466 ../fish/guestfish-actions.pod:529 ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:793
4651 "(Note this is different from both I<size in blocks> and I<filesystem block "
4656 #: ../fish/guestfish-actions.pod:471
4657 msgid "blockdev-getro"
4661 #: ../fish/guestfish-actions.pod:473
4664 " blockdev-getro device\n"
4669 #: ../fish/guestfish-actions.pod:475 ../src/guestfs-actions.pod:708
4671 "Returns a boolean indicating if the block device is read-only (true if "
4672 "read-only, false if not)."
4676 #: ../fish/guestfish-actions.pod:480
4677 msgid "blockdev-getsize64"
4681 #: ../fish/guestfish-actions.pod:482
4684 " blockdev-getsize64 device\n"
4689 #: ../fish/guestfish-actions.pod:484 ../src/guestfs-actions.pod:723
4690 msgid "This returns the size of the device in bytes."
4694 #: ../fish/guestfish-actions.pod:486
4695 msgid "See also L</blockdev-getsz>."
4699 #: ../fish/guestfish-actions.pod:490
4700 msgid "blockdev-getss"
4704 #: ../fish/guestfish-actions.pod:492
4707 " blockdev-getss device\n"
4712 #: ../fish/guestfish-actions.pod:494 ../src/guestfs-actions.pod:739
4714 "This returns the size of sectors on a block device. Usually 512, but can be "
4715 "larger for modern devices."
4719 #: ../fish/guestfish-actions.pod:497
4720 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
4724 #: ../fish/guestfish-actions.pod:502
4725 msgid "blockdev-getsz"
4729 #: ../fish/guestfish-actions.pod:504
4732 " blockdev-getsz device\n"
4737 #: ../fish/guestfish-actions.pod:506 ../src/guestfs-actions.pod:757
4739 "This returns the size of the device in units of 512-byte sectors (even if "
4740 "the sectorsize isn't 512 bytes ... weird)."
4744 #: ../fish/guestfish-actions.pod:509
4746 "See also L</blockdev-getss> for the real sector size of the device, and "
4747 "L</blockdev-getsize64> for the more useful I<size in bytes>."
4751 #: ../fish/guestfish-actions.pod:515
4752 msgid "blockdev-rereadpt"
4756 #: ../fish/guestfish-actions.pod:517
4759 " blockdev-rereadpt device\n"
4764 #: ../fish/guestfish-actions.pod:519 ../src/guestfs-actions.pod:776
4765 msgid "Reread the partition table on C<device>."
4769 #: ../fish/guestfish-actions.pod:523
4770 msgid "blockdev-setbsz"
4774 #: ../fish/guestfish-actions.pod:525
4777 " blockdev-setbsz device blocksize\n"
4782 #: ../fish/guestfish-actions.pod:527 ../src/guestfs-actions.pod:791
4783 msgid "This sets the block size of a device."
4787 #: ../fish/guestfish-actions.pod:534
4788 msgid "blockdev-setro"
4792 #: ../fish/guestfish-actions.pod:536
4795 " blockdev-setro device\n"
4800 #: ../fish/guestfish-actions.pod:538 ../src/guestfs-actions.pod:808
4801 msgid "Sets the block device named C<device> to read-only."
4805 #: ../fish/guestfish-actions.pod:542
4806 msgid "blockdev-setrw"
4810 #: ../fish/guestfish-actions.pod:544
4813 " blockdev-setrw device\n"
4818 #: ../fish/guestfish-actions.pod:546 ../src/guestfs-actions.pod:822
4819 msgid "Sets the block device named C<device> to read-write."
4823 #: ../fish/guestfish-actions.pod:550
4824 msgid "btrfs-filesystem-resize"
4828 #: ../fish/guestfish-actions.pod:552
4831 " btrfs-filesystem-resize mountpoint [size:..]\n"
4836 #: ../fish/guestfish-actions.pod:554 ../src/guestfs-actions.pod:844
4837 msgid "This command resizes a btrfs filesystem."
4841 #: ../fish/guestfish-actions.pod:556 ../src/guestfs-actions.pod:846
4843 "Note that unlike other resize calls, the filesystem has to be mounted and "
4844 "the parameter is the mountpoint not the device (this is a requirement of "
4849 #: ../fish/guestfish-actions.pod:560 ../fish/guestfish-actions.pod:3444 ../src/guestfs-actions.pod:850 ../src/guestfs-actions.pod:5216
4850 msgid "The optional parameters are:"
4854 #: ../fish/guestfish-actions.pod:564 ../fish/guestfish-actions.pod:3448 ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:5220
4859 #: ../fish/guestfish-actions.pod:566 ../src/guestfs-actions.pod:856
4861 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
4862 "resized to the maximum size."
4866 #: ../fish/guestfish-actions.pod:571 ../src/guestfs-actions.pod:861
4867 msgid "See also L<btrfs(8)>."
4871 #: ../fish/guestfish-actions.pod:575
4872 msgid "case-sensitive-path"
4876 #: ../fish/guestfish-actions.pod:577
4879 " case-sensitive-path path\n"
4884 #: ../fish/guestfish-actions.pod:579 ../src/guestfs-actions.pod:895
4886 "This can be used to resolve case insensitive paths on a filesystem which is "
4887 "case sensitive. The use case is to resolve paths which you have read from "
4888 "Windows configuration files or the Windows Registry, to the true path."
4892 #: ../fish/guestfish-actions.pod:584 ../src/guestfs-actions.pod:900
4894 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
4895 "(and probably others), which is that although the underlying filesystem is "
4896 "case-insensitive, the driver exports the filesystem to Linux as "
4901 #: ../fish/guestfish-actions.pod:589 ../src/guestfs-actions.pod:905
4903 "One consequence of this is that special directories such as C<c:\\windows> "
4904 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
4905 "precise details of how they were created. In Windows itself this would not "
4910 #: ../fish/guestfish-actions.pod:595 ../src/guestfs-actions.pod:911
4912 "Bug or feature? You decide: "
4913 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
4917 #: ../fish/guestfish-actions.pod:598 ../src/guestfs-actions.pod:914
4919 "This function resolves the true case of each element in the path and returns "
4920 "the case-sensitive path."
4924 #: ../fish/guestfish-actions.pod:601
4926 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
4927 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
4928 "how the directories were originally created under Windows)."
4932 #: ../fish/guestfish-actions.pod:606 ../src/guestfs-actions.pod:922
4933 msgid "I<Note>: This function does not handle drive names, backslashes etc."
4937 #: ../fish/guestfish-actions.pod:609
4938 msgid "See also L</realpath>."
4942 #: ../fish/guestfish-actions.pod:611
4947 #: ../fish/guestfish-actions.pod:613
4955 #: ../fish/guestfish-actions.pod:615 ../fish/guestfish-actions.pod:3864 ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:5859
4956 msgid "Return the contents of the file named C<path>."
4960 #: ../fish/guestfish-actions.pod:617
4962 "Note that this function cannot correctly handle binary files (specifically, "
4963 "files containing C<\\0> character which is treated as end of string). For "
4964 "those you need to use the L</read-file> or L</download> functions which have "
4965 "a more complex interface."
4969 #: ../fish/guestfish-actions.pod:622 ../fish/guestfish-actions.pod:757 ../fish/guestfish-actions.pod:769 ../fish/guestfish-actions.pod:945 ../fish/guestfish-actions.pod:955 ../fish/guestfish-actions.pod:1022 ../fish/guestfish-actions.pod:1032 ../fish/guestfish-actions.pod:1224 ../fish/guestfish-actions.pod:1531 ../fish/guestfish-actions.pod:1541 ../fish/guestfish-actions.pod:1591 ../fish/guestfish-actions.pod:1606 ../fish/guestfish-actions.pod:1616 ../fish/guestfish-actions.pod:1635 ../fish/guestfish-actions.pod:3734 ../fish/guestfish-actions.pod:3749 ../fish/guestfish-actions.pod:3825 ../fish/guestfish-actions.pod:3842 ../fish/guestfish-actions.pod:3857 ../fish/guestfish-actions.pod:4526 ../fish/guestfish-actions.pod:4572 ../fish/guestfish-actions.pod:4657 ../fish/guestfish-actions.pod:4672 ../fish/guestfish-actions.pod:5078 ../fish/guestfish-actions.pod:5090 ../fish/guestfish-actions.pod:5108 ../fish/guestfish-actions.pod:5125 ../fish/guestfish-actions.pod:5135 ../fish/guestfish-actions.pod:5192 ../fish/guestfish-actions.pod:5202 ../fish/guestfish-actions.pod:5231 ../fish/guestfish-actions.pod:5241 ../src/guestfs-actions.pod:948 ../src/guestfs-actions.pod:1127 ../src/guestfs-actions.pod:1147 ../src/guestfs-actions.pod:1443 ../src/guestfs-actions.pod:1462 ../src/guestfs-actions.pod:1565 ../src/guestfs-actions.pod:1584 ../src/guestfs-actions.pod:1830 ../src/guestfs-actions.pod:2301 ../src/guestfs-actions.pod:2320 ../src/guestfs-actions.pod:2385 ../src/guestfs-actions.pod:2409 ../src/guestfs-actions.pod:2426 ../src/guestfs-actions.pod:2455 ../src/guestfs-actions.pod:5641 ../src/guestfs-actions.pod:5667 ../src/guestfs-actions.pod:5798 ../src/guestfs-actions.pod:5824 ../src/guestfs-actions.pod:5848 ../src/guestfs-actions.pod:6799 ../src/guestfs-actions.pod:6854 ../src/guestfs-actions.pod:7000 ../src/guestfs-actions.pod:7024 ../src/guestfs-actions.pod:7689 ../src/guestfs-actions.pod:7709 ../src/guestfs-actions.pod:7735 ../src/guestfs-actions.pod:7761 ../src/guestfs-actions.pod:7780 ../src/guestfs-actions.pod:7874 ../src/guestfs-actions.pod:7893 ../src/guestfs-actions.pod:7939 ../src/guestfs-actions.pod:7958
4971 "Because of the message protocol, there is a transfer limit of somewhere "
4972 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
4976 #: ../fish/guestfish-actions.pod:625
4981 #: ../fish/guestfish-actions.pod:627
4984 " checksum csumtype path\n"
4989 #: ../fish/guestfish-actions.pod:629 ../src/guestfs-actions.pod:960
4990 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
4994 #: ../fish/guestfish-actions.pod:632 ../src/guestfs-actions.pod:963
4996 "The type of checksum to compute is given by the C<csumtype> parameter which "
4997 "must have one of the following values:"
5001 #: ../fish/guestfish-actions.pod:637 ../src/guestfs-actions.pod:968
5006 #: ../fish/guestfish-actions.pod:639 ../src/guestfs-actions.pod:970
5008 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5013 #: ../fish/guestfish-actions.pod:642 ../src/guestfs-actions.pod:973
5018 #: ../fish/guestfish-actions.pod:644 ../src/guestfs-actions.pod:975
5019 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5023 #: ../fish/guestfish-actions.pod:646 ../src/guestfs-actions.pod:977
5028 #: ../fish/guestfish-actions.pod:648 ../src/guestfs-actions.pod:979
5029 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5033 #: ../fish/guestfish-actions.pod:650 ../src/guestfs-actions.pod:981
5038 #: ../fish/guestfish-actions.pod:652 ../src/guestfs-actions.pod:983
5039 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5043 #: ../fish/guestfish-actions.pod:654 ../src/guestfs-actions.pod:985
5048 #: ../fish/guestfish-actions.pod:656 ../src/guestfs-actions.pod:987
5049 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5053 #: ../fish/guestfish-actions.pod:658 ../src/guestfs-actions.pod:989
5058 #: ../fish/guestfish-actions.pod:660 ../src/guestfs-actions.pod:991
5059 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5063 #: ../fish/guestfish-actions.pod:662 ../src/guestfs-actions.pod:993
5068 #: ../fish/guestfish-actions.pod:664 ../src/guestfs-actions.pod:995
5069 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5073 #: ../fish/guestfish-actions.pod:668 ../src/guestfs-actions.pod:999
5074 msgid "The checksum is returned as a printable string."
5078 #: ../fish/guestfish-actions.pod:670
5079 msgid "To get the checksum for a device, use L</checksum-device>."
5083 #: ../fish/guestfish-actions.pod:672
5084 msgid "To get the checksums for many files, use L</checksums-out>."
5088 #: ../fish/guestfish-actions.pod:674
5089 msgid "checksum-device"
5093 #: ../fish/guestfish-actions.pod:676
5096 " checksum-device csumtype device\n"
5101 #: ../fish/guestfish-actions.pod:678
5103 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5104 "device named C<device>. For the types of checksums supported see the "
5105 "L</checksum> command."
5109 #: ../fish/guestfish-actions.pod:682
5110 msgid "checksums-out"
5114 #: ../fish/guestfish-actions.pod:684
5117 " checksums-out csumtype directory (sumsfile|-)\n"
5122 #: ../fish/guestfish-actions.pod:686 ../src/guestfs-actions.pod:1034
5124 "This command computes the checksums of all regular files in C<directory> and "
5125 "then emits a list of those checksums to the local output file C<sumsfile>."
5129 #: ../fish/guestfish-actions.pod:690 ../src/guestfs-actions.pod:1038
5131 "This can be used for verifying the integrity of a virtual machine. However "
5132 "to be properly secure you should pay attention to the output of the checksum "
5133 "command (it uses the ones from GNU coreutils). In particular when the "
5134 "filename is not printable, coreutils uses a special backslash syntax. For "
5135 "more information, see the GNU coreutils info file."
5139 #: ../fish/guestfish-actions.pod:700
5144 #: ../fish/guestfish-actions.pod:702
5147 " chmod mode path\n"
5152 #: ../fish/guestfish-actions.pod:704 ../src/guestfs-actions.pod:1057
5154 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5159 #: ../fish/guestfish-actions.pod:707 ../src/guestfs-actions.pod:1060
5161 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5162 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5167 #: ../fish/guestfish-actions.pod:711 ../fish/guestfish-actions.pod:3087 ../fish/guestfish-actions.pod:3226 ../fish/guestfish-actions.pod:3236 ../fish/guestfish-actions.pod:3246 ../src/guestfs-actions.pod:1064 ../src/guestfs-actions.pod:4613 ../src/guestfs-actions.pod:4822 ../src/guestfs-actions.pod:4841 ../src/guestfs-actions.pod:4860
5168 msgid "The mode actually set is affected by the umask."
5172 #: ../fish/guestfish-actions.pod:713
5177 #: ../fish/guestfish-actions.pod:715
5180 " chown owner group path\n"
5185 #: ../fish/guestfish-actions.pod:717 ../src/guestfs-actions.pod:1078
5186 msgid "Change the file owner to C<owner> and group to C<group>."
5190 #: ../fish/guestfish-actions.pod:719 ../fish/guestfish-actions.pod:2522 ../src/guestfs-actions.pod:1080 ../src/guestfs-actions.pod:3684
5192 "Only numeric uid and gid are supported. If you want to use names, you will "
5193 "need to locate and parse the password file yourself (Augeas support makes "
5194 "this relatively easy)."
5198 #: ../fish/guestfish-actions.pod:723
5203 #: ../fish/guestfish-actions.pod:725
5206 " command 'arguments ...'\n"
5211 #: ../fish/guestfish-actions.pod:727 ../src/guestfs-actions.pod:1094
5213 "This call runs a command from the guest filesystem. The filesystem must be "
5214 "mounted, and must contain a compatible operating system (ie. something "
5215 "Linux, with the same or compatible processor architecture)."
5219 #: ../fish/guestfish-actions.pod:732
5221 "The single parameter is an argv-style list of arguments. The first element "
5222 "is the name of the program to run. Subsequent elements are parameters. The "
5223 "list must be non-empty (ie. must contain a program name). Note that the "
5224 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
5228 #: ../fish/guestfish-actions.pod:739 ../src/guestfs-actions.pod:1106
5229 msgid "The return value is anything printed to I<stdout> by the command."
5233 #: ../fish/guestfish-actions.pod:742 ../src/guestfs-actions.pod:1109
5235 "If the command returns a non-zero exit status, then this function returns an "
5236 "error message. The error message string is the content of I<stderr> from "
5241 #: ../fish/guestfish-actions.pod:746 ../src/guestfs-actions.pod:1113
5243 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
5244 "C</bin>. If you require a program from another location, you should provide "
5245 "the full path in the first parameter."
5249 #: ../fish/guestfish-actions.pod:751 ../src/guestfs-actions.pod:1118
5251 "Shared libraries and data files required by the program must be available on "
5252 "filesystems which are mounted in the correct places. It is the caller's "
5253 "responsibility to ensure all filesystems that are needed are mounted at the "
5258 #: ../fish/guestfish-actions.pod:760
5259 msgid "command-lines"
5263 #: ../fish/guestfish-actions.pod:762
5266 " command-lines 'arguments ...'\n"
5271 #: ../fish/guestfish-actions.pod:764
5272 msgid "This is the same as L</command>, but splits the result into a list of lines."
5276 #: ../fish/guestfish-actions.pod:767
5277 msgid "See also: L</sh-lines>"
5281 #: ../fish/guestfish-actions.pod:772
5286 #: ../fish/guestfish-actions.pod:774
5289 " config qemuparam qemuvalue\n"
5294 #: ../fish/guestfish-actions.pod:776 ../src/guestfs-actions.pod:1159
5296 "This can be used to add arbitrary qemu command line parameters of the form "
5297 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
5298 "setting some parameters which would interfere with parameters that we use."
5302 #: ../fish/guestfish-actions.pod:781 ../src/guestfs-actions.pod:1164
5303 msgid "The first character of C<param> string must be a C<-> (dash)."
5307 #: ../fish/guestfish-actions.pod:783 ../src/guestfs-actions.pod:1166
5308 msgid "C<value> can be NULL."
5312 #: ../fish/guestfish-actions.pod:785
5317 #: ../fish/guestfish-actions.pod:787
5320 " copy-size src dest size\n"
5325 #: ../fish/guestfish-actions.pod:789 ../src/guestfs-actions.pod:1180
5327 "This command copies exactly C<size> bytes from one source device or file "
5328 "C<src> to another destination device or file C<dest>."
5332 #: ../fish/guestfish-actions.pod:792 ../src/guestfs-actions.pod:1183
5334 "Note this will fail if the source is too short or if the destination is not "
5339 #: ../fish/guestfish-actions.pod:795
5344 #: ../fish/guestfish-actions.pod:797
5352 #: ../fish/guestfish-actions.pod:799 ../src/guestfs-actions.pod:1202
5354 "This copies a file from C<src> to C<dest> where C<dest> is either a "
5355 "destination filename or destination directory."
5359 #: ../fish/guestfish-actions.pod:802
5364 #: ../fish/guestfish-actions.pod:804
5372 #: ../fish/guestfish-actions.pod:806 ../src/guestfs-actions.pod:1216
5374 "This copies a file or directory from C<src> to C<dest> recursively using the "
5379 #: ../fish/guestfish-actions.pod:809
5384 #: ../fish/guestfish-actions.pod:811
5392 #: ../fish/guestfish-actions.pod:813 ../src/guestfs-actions.pod:1230
5394 "This command copies from one source device or file C<src> to another "
5395 "destination device or file C<dest>. Normally you would use this to copy to "
5396 "or from a device or partition, for example to duplicate a filesystem."
5400 #: ../fish/guestfish-actions.pod:818
5402 "If the destination is a device, it must be as large or larger than the "
5403 "source file or device, otherwise the copy will fail. This command cannot do "
5404 "partial copies (see L</copy-size>)."
5408 #: ../fish/guestfish-actions.pod:822
5413 #: ../fish/guestfish-actions.pod:824
5421 #: ../fish/guestfish-actions.pod:826 ../src/guestfs-actions.pod:1248
5422 msgid "This command runs the C<df> command to report disk space used."
5426 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:839
5428 "This command is mostly useful for interactive sessions. It is I<not> "
5429 "intended that you try to parse the output string. Use L</statvfs> from "
5434 #: ../fish/guestfish-actions.pod:832
5439 #: ../fish/guestfish-actions.pod:834
5447 #: ../fish/guestfish-actions.pod:836 ../src/guestfs-actions.pod:1264
5449 "This command runs the C<df -h> command to report disk space used in "
5450 "human-readable format."
5454 #: ../fish/guestfish-actions.pod:843
5459 #: ../fish/guestfish-actions.pod:845
5467 #: ../fish/guestfish-actions.pod:847 ../src/guestfs-actions.pod:1281
5469 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
5470 "This is sometimes useful for extended debugging of problems."
5474 #: ../fish/guestfish-actions.pod:851
5476 "Another way to get the same information is to enable verbose messages with "
5477 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
5478 "before running the program."
5482 #: ../fish/guestfish-actions.pod:856
5487 #: ../fish/guestfish-actions.pod:858
5490 " download remotefilename (filename|-)\n"
5495 #: ../fish/guestfish-actions.pod:860 ../fish/guestfish-actions.pod:873 ../src/guestfs-actions.pod:1302 ../src/guestfs-actions.pod:1327
5497 "Download file C<remotefilename> and save it as C<filename> on the local "
5502 #: ../fish/guestfish-actions.pod:863 ../fish/guestfish-actions.pod:4830 ../src/guestfs-actions.pod:1305 ../src/guestfs-actions.pod:7259
5503 msgid "C<filename> can also be a named pipe."
5507 #: ../fish/guestfish-actions.pod:865
5508 msgid "See also L</upload>, L</cat>."
5512 #: ../fish/guestfish-actions.pod:869
5513 msgid "download-offset"
5517 #: ../fish/guestfish-actions.pod:871
5520 " download-offset remotefilename (filename|-) offset size\n"
5525 #: ../fish/guestfish-actions.pod:876 ../src/guestfs-actions.pod:1330
5527 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
5528 "region must be within the file or device)."
5532 #: ../fish/guestfish-actions.pod:879
5534 "Note that there is no limit on the amount of data that can be downloaded "
5535 "with this call, unlike with L</pread>, and this call always reads the full "
5536 "amount unless an error occurs."
5540 #: ../fish/guestfish-actions.pod:884
5541 msgid "See also L</download>, L</pread>."
5545 #: ../fish/guestfish-actions.pod:888
5550 #: ../fish/guestfish-actions.pod:890
5553 " drop-caches whattodrop\n"
5558 #: ../fish/guestfish-actions.pod:892 ../src/guestfs-actions.pod:1355
5560 "This instructs the guest kernel to drop its page cache, and/or dentries and "
5561 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
5562 "to drop, see L<http://linux-mm.org/Drop_Caches>"
5566 #: ../fish/guestfish-actions.pod:897 ../src/guestfs-actions.pod:1360
5567 msgid "Setting C<whattodrop> to 3 should drop everything."
5571 #: ../fish/guestfish-actions.pod:899 ../src/guestfs-actions.pod:1362
5573 "This automatically calls L<sync(2)> before the operation, so that the "
5574 "maximum guest memory is freed."
5578 #: ../fish/guestfish-actions.pod:902
5583 #: ../fish/guestfish-actions.pod:904
5591 #: ../fish/guestfish-actions.pod:906 ../src/guestfs-actions.pod:1375
5593 "This command runs the C<du -s> command to estimate file space usage for "
5598 #: ../fish/guestfish-actions.pod:909 ../src/guestfs-actions.pod:1378
5600 "C<path> can be a file or a directory. If C<path> is a directory then the "
5601 "estimate includes the contents of the directory and all subdirectories "
5606 #: ../fish/guestfish-actions.pod:913 ../src/guestfs-actions.pod:1382
5607 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
5611 #: ../fish/guestfish-actions.pod:916
5616 #: ../fish/guestfish-actions.pod:918
5619 " e2fsck-f device\n"
5624 #: ../fish/guestfish-actions.pod:920 ../src/guestfs-actions.pod:1400
5626 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
5627 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
5632 #: ../fish/guestfish-actions.pod:924
5634 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
5635 "should use L</fsck>."
5639 #: ../fish/guestfish-actions.pod:927
5644 #: ../fish/guestfish-actions.pod:929
5647 " echo-daemon 'words ...'\n"
5652 #: ../fish/guestfish-actions.pod:931 ../src/guestfs-actions.pod:1417
5654 "This command concatenates the list of C<words> passed with single spaces "
5655 "between them and returns the resulting string."
5659 #: ../fish/guestfish-actions.pod:934 ../src/guestfs-actions.pod:1420
5660 msgid "You can use this command to test the connection through to the daemon."
5664 #: ../fish/guestfish-actions.pod:936
5665 msgid "See also L</ping-daemon>."
5669 #: ../fish/guestfish-actions.pod:938
5674 #: ../fish/guestfish-actions.pod:940
5677 " egrep regex path\n"
5682 #: ../fish/guestfish-actions.pod:942 ../src/guestfs-actions.pod:1436
5683 msgid "This calls the external C<egrep> program and returns the matching lines."
5687 #: ../fish/guestfish-actions.pod:948
5692 #: ../fish/guestfish-actions.pod:950
5695 " egrepi regex path\n"
5700 #: ../fish/guestfish-actions.pod:952 ../src/guestfs-actions.pod:1455
5701 msgid "This calls the external C<egrep -i> program and returns the matching lines."
5705 #: ../fish/guestfish-actions.pod:958
5710 #: ../fish/guestfish-actions.pod:960
5713 " equal file1 file2\n"
5718 #: ../fish/guestfish-actions.pod:962 ../src/guestfs-actions.pod:1474
5720 "This compares the two files C<file1> and C<file2> and returns true if their "
5721 "content is exactly equal, or false otherwise."
5725 #: ../fish/guestfish-actions.pod:965 ../src/guestfs-actions.pod:1477
5726 msgid "The external L<cmp(1)> program is used for the comparison."
5730 #: ../fish/guestfish-actions.pod:967
5735 #: ../fish/guestfish-actions.pod:969
5743 #: ../fish/guestfish-actions.pod:971 ../src/guestfs-actions.pod:1489
5745 "This returns C<true> if and only if there is a file, directory (or anything) "
5746 "with the given C<path> name."
5750 #: ../fish/guestfish-actions.pod:974
5751 msgid "See also L</is-file>, L</is-dir>, L</stat>."
5755 #: ../fish/guestfish-actions.pod:976
5760 #: ../fish/guestfish-actions.pod:978
5763 " fallocate path len\n"
5768 #: ../fish/guestfish-actions.pod:980 ../fish/guestfish-actions.pod:999 ../src/guestfs-actions.pod:1505 ../src/guestfs-actions.pod:1531
5770 "This command preallocates a file (containing zero bytes) named C<path> of "
5771 "size C<len> bytes. If the file exists already, it is overwritten."
5775 #: ../fish/guestfish-actions.pod:984 ../src/guestfs-actions.pod:1509
5777 "Do not confuse this with the guestfish-specific C<alloc> command which "
5778 "allocates a file in the host and attaches it as a device."
5782 #: ../fish/guestfish-actions.pod:988
5784 "This function is deprecated. In new code, use the L</fallocate64> call "
5789 #: ../fish/guestfish-actions.pod:995
5794 #: ../fish/guestfish-actions.pod:997
5797 " fallocate64 path len\n"
5802 #: ../fish/guestfish-actions.pod:1003
5804 "Note that this call allocates disk blocks for the file. To create a sparse "
5805 "file use L</truncate-size> instead."
5809 #: ../fish/guestfish-actions.pod:1006
5811 "The deprecated call L</fallocate> does the same, but owing to an oversight "
5812 "it only allowed 30 bit lengths to be specified, effectively limiting the "
5813 "maximum size of files created through that call to 1GB."
5817 #: ../fish/guestfish-actions.pod:1011 ../src/guestfs-actions.pod:1543
5819 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
5820 "commands which create a file in the host and attach it as a device."
5824 #: ../fish/guestfish-actions.pod:1015
5829 #: ../fish/guestfish-actions.pod:1017
5832 " fgrep pattern path\n"
5837 #: ../fish/guestfish-actions.pod:1019 ../src/guestfs-actions.pod:1558
5838 msgid "This calls the external C<fgrep> program and returns the matching lines."
5842 #: ../fish/guestfish-actions.pod:1025
5847 #: ../fish/guestfish-actions.pod:1027
5850 " fgrepi pattern path\n"
5855 #: ../fish/guestfish-actions.pod:1029 ../src/guestfs-actions.pod:1577
5856 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
5860 #: ../fish/guestfish-actions.pod:1035
5865 #: ../fish/guestfish-actions.pod:1037
5873 #: ../fish/guestfish-actions.pod:1039 ../src/guestfs-actions.pod:1595
5875 "This call uses the standard L<file(1)> command to determine the type or "
5876 "contents of the file."
5880 #: ../fish/guestfish-actions.pod:1042 ../src/guestfs-actions.pod:1598
5882 "This call will also transparently look inside various types of compressed "
5887 #: ../fish/guestfish-actions.pod:1045 ../src/guestfs-actions.pod:1601
5889 "The exact command which runs is C<file -zb path>. Note in particular that "
5890 "the filename is not prepended to the output (the I<-b> option)."
5894 #: ../fish/guestfish-actions.pod:1049 ../src/guestfs-actions.pod:1605
5896 "The output depends on the output of the underlying L<file(1)> command and it "
5897 "can change in future in ways beyond our control. In other words, the output "
5898 "is not guaranteed by the ABI."
5902 #: ../fish/guestfish-actions.pod:1053
5904 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
5905 "(etc), L</is-zero>."
5909 #: ../fish/guestfish-actions.pod:1056
5910 msgid "file-architecture"
5914 #: ../fish/guestfish-actions.pod:1058
5917 " file-architecture filename\n"
5922 #: ../fish/guestfish-actions.pod:1060 ../src/guestfs-actions.pod:1623
5924 "This detects the architecture of the binary C<filename>, and returns it if "
5929 #: ../fish/guestfish-actions.pod:1063 ../src/guestfs-actions.pod:1626
5930 msgid "Currently defined architectures are:"
5934 #: ../fish/guestfish-actions.pod:1067 ../src/guestfs-actions.pod:1630
5939 #: ../fish/guestfish-actions.pod:1069 ../src/guestfs-actions.pod:1632
5941 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
5942 "irrespective of the precise processor requirements of the binary."
5946 #: ../fish/guestfish-actions.pod:1072 ../src/guestfs-actions.pod:1635
5951 #: ../fish/guestfish-actions.pod:1074 ../src/guestfs-actions.pod:1637
5952 msgid "64 bit x86-64."
5956 #: ../fish/guestfish-actions.pod:1076 ../src/guestfs-actions.pod:1639
5961 #: ../fish/guestfish-actions.pod:1078 ../src/guestfs-actions.pod:1641
5962 msgid "32 bit SPARC."
5966 #: ../fish/guestfish-actions.pod:1080 ../src/guestfs-actions.pod:1643
5971 #: ../fish/guestfish-actions.pod:1082 ../src/guestfs-actions.pod:1645
5972 msgid "64 bit SPARC V9 and above."
5976 #: ../fish/guestfish-actions.pod:1084 ../src/guestfs-actions.pod:1647
5981 #: ../fish/guestfish-actions.pod:1086 ../src/guestfs-actions.pod:1649
5982 msgid "Intel Itanium."
5986 #: ../fish/guestfish-actions.pod:1088 ../src/guestfs-actions.pod:1651
5991 #: ../fish/guestfish-actions.pod:1090 ../src/guestfs-actions.pod:1653
5992 msgid "32 bit Power PC."
5996 #: ../fish/guestfish-actions.pod:1092 ../src/guestfs-actions.pod:1655
6001 #: ../fish/guestfish-actions.pod:1094 ../src/guestfs-actions.pod:1657
6002 msgid "64 bit Power PC."
6006 #: ../fish/guestfish-actions.pod:1098 ../src/guestfs-actions.pod:1661
6007 msgid "Libguestfs may return other architecture strings in future."
6011 #: ../fish/guestfish-actions.pod:1100 ../src/guestfs-actions.pod:1663
6012 msgid "The function works on at least the following types of files:"
6016 #: ../fish/guestfish-actions.pod:1106 ../src/guestfs-actions.pod:1669
6017 msgid "many types of Un*x and Linux binary"
6021 #: ../fish/guestfish-actions.pod:1110 ../src/guestfs-actions.pod:1673
6022 msgid "many types of Un*x and Linux shared library"
6026 #: ../fish/guestfish-actions.pod:1114 ../src/guestfs-actions.pod:1677
6027 msgid "Windows Win32 and Win64 binaries"
6031 #: ../fish/guestfish-actions.pod:1118 ../src/guestfs-actions.pod:1681
6032 msgid "Windows Win32 and Win64 DLLs"
6036 #: ../fish/guestfish-actions.pod:1120 ../src/guestfs-actions.pod:1683
6037 msgid "Win32 binaries and DLLs return C<i386>."
6041 #: ../fish/guestfish-actions.pod:1122 ../src/guestfs-actions.pod:1685
6042 msgid "Win64 binaries and DLLs return C<x86_64>."
6046 #: ../fish/guestfish-actions.pod:1126 ../src/guestfs-actions.pod:1689
6047 msgid "Linux kernel modules"
6051 #: ../fish/guestfish-actions.pod:1130 ../src/guestfs-actions.pod:1693
6052 msgid "Linux new-style initrd images"
6056 #: ../fish/guestfish-actions.pod:1134 ../src/guestfs-actions.pod:1697
6057 msgid "some non-x86 Linux vmlinuz kernels"
6061 #: ../fish/guestfish-actions.pod:1138 ../src/guestfs-actions.pod:1701
6062 msgid "What it can't do currently:"
6066 #: ../fish/guestfish-actions.pod:1144 ../src/guestfs-actions.pod:1707
6067 msgid "static libraries (libfoo.a)"
6071 #: ../fish/guestfish-actions.pod:1148 ../src/guestfs-actions.pod:1711
6072 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6076 #: ../fish/guestfish-actions.pod:1152 ../src/guestfs-actions.pod:1715
6077 msgid "x86 Linux vmlinuz kernels"
6081 #: ../fish/guestfish-actions.pod:1154 ../src/guestfs-actions.pod:1717
6083 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6084 "compressed code, and are horribly hard to unpack. If you want to find the "
6085 "architecture of a kernel, use the architecture of the associated initrd or "
6086 "kernel module(s) instead."
6090 #: ../fish/guestfish-actions.pod:1161
6095 #: ../fish/guestfish-actions.pod:1163
6103 #: ../fish/guestfish-actions.pod:1165 ../src/guestfs-actions.pod:1735
6104 msgid "This command returns the size of C<file> in bytes."
6108 #: ../fish/guestfish-actions.pod:1167
6110 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
6111 "L</is-file> etc. To get the size of block devices, use "
6112 "L</blockdev-getsize64>."
6116 #: ../fish/guestfish-actions.pod:1171
6121 #: ../fish/guestfish-actions.pod:1173
6124 " fill c len path\n"
6129 #: ../fish/guestfish-actions.pod:1175 ../src/guestfs-actions.pod:1753
6131 "This command creates a new file called C<path>. The initial content of the "
6132 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
6137 #: ../fish/guestfish-actions.pod:1179
6139 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6140 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
6145 #: ../fish/guestfish-actions.pod:1184
6146 msgid "fill-pattern"
6150 #: ../fish/guestfish-actions.pod:1186
6153 " fill-pattern pattern len path\n"
6158 #: ../fish/guestfish-actions.pod:1188
6160 "This function is like L</fill> except that it creates a new file of length "
6161 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
6162 "is truncated if necessary to ensure the length of the file is exactly C<len> "
6167 #: ../fish/guestfish-actions.pod:1193
6172 #: ../fish/guestfish-actions.pod:1195
6180 #: ../fish/guestfish-actions.pod:1197 ../src/guestfs-actions.pod:1799
6182 "This command lists out all files and directories, recursively, starting at "
6183 "C<directory>. It is essentially equivalent to running the shell command "
6184 "C<find directory -print> but some post-processing happens on the output, "
6189 #: ../fish/guestfish-actions.pod:1202 ../src/guestfs-actions.pod:1804
6191 "This returns a list of strings I<without any prefix>. Thus if the directory "
6196 #: ../fish/guestfish-actions.pod:1205 ../src/guestfs-actions.pod:1807
6206 #: ../fish/guestfish-actions.pod:1209
6207 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
6211 #: ../fish/guestfish-actions.pod:1212 ../src/guestfs-actions.pod:1814
6222 #: ../fish/guestfish-actions.pod:1217 ../src/guestfs-actions.pod:1819
6223 msgid "If C<directory> is not a directory, then this command returns an error."
6227 #: ../fish/guestfish-actions.pod:1220 ../src/guestfs-actions.pod:1822
6228 msgid "The returned list is sorted."
6232 #: ../fish/guestfish-actions.pod:1222
6233 msgid "See also L</find0>."
6237 #: ../fish/guestfish-actions.pod:1227
6242 #: ../fish/guestfish-actions.pod:1229
6245 " find0 directory (files|-)\n"
6250 #: ../fish/guestfish-actions.pod:1231 ../src/guestfs-actions.pod:1842
6252 "This command lists out all files and directories, recursively, starting at "
6253 "C<directory>, placing the resulting list in the external file called "
6258 #: ../fish/guestfish-actions.pod:1235
6259 msgid "This command works the same way as L</find> with the following exceptions:"
6263 #: ../fish/guestfish-actions.pod:1242 ../src/guestfs-actions.pod:1853
6264 msgid "The resulting list is written to an external file."
6268 #: ../fish/guestfish-actions.pod:1246 ../src/guestfs-actions.pod:1857
6270 "Items (filenames) in the result are separated by C<\\0> characters. See "
6271 "L<find(1)> option I<-print0>."
6275 #: ../fish/guestfish-actions.pod:1251 ../src/guestfs-actions.pod:1862
6276 msgid "This command is not limited in the number of names that it can return."
6280 #: ../fish/guestfish-actions.pod:1256 ../src/guestfs-actions.pod:1867
6281 msgid "The result list is not sorted."
6285 #: ../fish/guestfish-actions.pod:1262
6286 msgid "findfs-label"
6290 #: ../fish/guestfish-actions.pod:1264
6293 " findfs-label label\n"
6298 #: ../fish/guestfish-actions.pod:1266 ../src/guestfs-actions.pod:1881
6300 "This command searches the filesystems and returns the one which has the "
6301 "given label. An error is returned if no such filesystem can be found."
6305 #: ../fish/guestfish-actions.pod:1270
6306 msgid "To find the label of a filesystem, use L</vfs-label>."
6310 #: ../fish/guestfish-actions.pod:1272
6315 #: ../fish/guestfish-actions.pod:1274
6318 " findfs-uuid uuid\n"
6323 #: ../fish/guestfish-actions.pod:1276 ../src/guestfs-actions.pod:1898
6325 "This command searches the filesystems and returns the one which has the "
6326 "given UUID. An error is returned if no such filesystem can be found."
6330 #: ../fish/guestfish-actions.pod:1280
6331 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
6335 #: ../fish/guestfish-actions.pod:1282
6340 #: ../fish/guestfish-actions.pod:1284
6343 " fsck fstype device\n"
6348 #: ../fish/guestfish-actions.pod:1286 ../src/guestfs-actions.pod:1916
6350 "This runs the filesystem checker (fsck) on C<device> which should have "
6351 "filesystem type C<fstype>."
6355 #: ../fish/guestfish-actions.pod:1289 ../src/guestfs-actions.pod:1919
6357 "The returned integer is the status. See L<fsck(8)> for the list of status "
6358 "codes from C<fsck>."
6362 #: ../fish/guestfish-actions.pod:1298 ../src/guestfs-actions.pod:1928
6363 msgid "Multiple status codes can be summed together."
6367 #: ../fish/guestfish-actions.pod:1302 ../src/guestfs-actions.pod:1932
6369 "A non-zero return code can mean \"success\", for example if errors have been "
6370 "corrected on the filesystem."
6374 #: ../fish/guestfish-actions.pod:1307 ../src/guestfs-actions.pod:1937
6375 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
6379 #: ../fish/guestfish-actions.pod:1312 ../src/guestfs-actions.pod:1942
6380 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
6384 #: ../fish/guestfish-actions.pod:1314
6389 #: ../fish/guestfish-actions.pod:1316
6397 #: ../fish/guestfish-actions.pod:1318 ../src/guestfs-actions.pod:1953
6399 "Return the additional kernel options which are added to the guest kernel "
6404 #: ../fish/guestfish-actions.pod:1321 ../src/guestfs-actions.pod:1956
6405 msgid "If C<NULL> then no options are added."
6409 #: ../fish/guestfish-actions.pod:1323
6410 msgid "get-attach-method"
6414 #: ../fish/guestfish-actions.pod:1325
6417 " get-attach-method\n"
6422 #: ../fish/guestfish-actions.pod:1327
6423 msgid "Return the current attach method. See L</set-attach-method>."
6427 #: ../fish/guestfish-actions.pod:1329
6428 msgid "get-autosync"
6432 #: ../fish/guestfish-actions.pod:1331
6440 #: ../fish/guestfish-actions.pod:1333 ../src/guestfs-actions.pod:1981
6441 msgid "Get the autosync flag."
6445 #: ../fish/guestfish-actions.pod:1335
6450 #: ../fish/guestfish-actions.pod:1337
6458 #: ../fish/guestfish-actions.pod:1339 ../src/guestfs-actions.pod:1992
6459 msgid "Return the direct appliance mode flag."
6463 #: ../fish/guestfish-actions.pod:1341
6468 #: ../fish/guestfish-actions.pod:1343
6471 " get-e2label device\n"
6476 #: ../fish/guestfish-actions.pod:1345 ../src/guestfs-actions.pod:2004
6477 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
6481 #: ../fish/guestfish-actions.pod:1348
6483 "This function is deprecated. In new code, use the L</vfs_label> call "
6488 #: ../fish/guestfish-actions.pod:1355
6493 #: ../fish/guestfish-actions.pod:1357
6496 " get-e2uuid device\n"
6501 #: ../fish/guestfish-actions.pod:1359 ../src/guestfs-actions.pod:2025
6502 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
6506 #: ../fish/guestfish-actions.pod:1362
6508 "This function is deprecated. In new code, use the L</vfs_uuid> call "
6513 #: ../fish/guestfish-actions.pod:1369
6518 #: ../fish/guestfish-actions.pod:1371
6526 #: ../fish/guestfish-actions.pod:1373 ../src/guestfs-actions.pod:2045
6527 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
6531 #: ../fish/guestfish-actions.pod:1376
6533 "If L</set-memsize> was not called on this handle, and if "
6534 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
6535 "value for memsize."
6539 #: ../fish/guestfish-actions.pod:1380 ../fish/guestfish-actions.pod:1437 ../fish/guestfish-actions.pod:4190 ../fish/guestfish-actions.pod:4292 ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2144 ../src/guestfs-actions.pod:6320 ../src/guestfs-actions.pod:6446
6540 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
6544 #: ../fish/guestfish-actions.pod:1383
6549 #: ../fish/guestfish-actions.pod:1385
6557 #: ../fish/guestfish-actions.pod:1387 ../src/guestfs-actions.pod:2064
6558 msgid "This returns the enable network flag."
6562 #: ../fish/guestfish-actions.pod:1389
6567 #: ../fish/guestfish-actions.pod:1391
6575 #: ../fish/guestfish-actions.pod:1393 ../src/guestfs-actions.pod:2075
6576 msgid "Return the current search path."
6580 #: ../fish/guestfish-actions.pod:1395 ../src/guestfs-actions.pod:2077
6582 "This is always non-NULL. If it wasn't set already, then this will return "
6587 #: ../fish/guestfish-actions.pod:1398
6592 #: ../fish/guestfish-actions.pod:1400
6600 #: ../fish/guestfish-actions.pod:1402 ../src/guestfs-actions.pod:2090
6601 msgid "This returns the process group flag."
6605 #: ../fish/guestfish-actions.pod:1404
6610 #: ../fish/guestfish-actions.pod:1406
6615 #: ../fish/guestfish-actions.pod:1408
6623 #: ../fish/guestfish-actions.pod:1410 ../src/guestfs-actions.pod:2101
6625 "Return the process ID of the qemu subprocess. If there is no qemu "
6626 "subprocess, then this will return an error."
6630 #: ../fish/guestfish-actions.pod:1413 ../src/guestfs-actions.pod:2104
6631 msgid "This is an internal call used for debugging and testing."
6635 #: ../fish/guestfish-actions.pod:1415
6640 #: ../fish/guestfish-actions.pod:1417
6648 #: ../fish/guestfish-actions.pod:1419 ../src/guestfs-actions.pod:2115
6649 msgid "Return the current qemu binary."
6653 #: ../fish/guestfish-actions.pod:1421 ../src/guestfs-actions.pod:2117
6655 "This is always non-NULL. If it wasn't set already, then this will return "
6656 "the default qemu binary name."
6660 #: ../fish/guestfish-actions.pod:1424
6661 msgid "get-recovery-proc"
6665 #: ../fish/guestfish-actions.pod:1426
6668 " get-recovery-proc\n"
6673 #: ../fish/guestfish-actions.pod:1428 ../src/guestfs-actions.pod:2130
6674 msgid "Return the recovery process enabled flag."
6678 #: ../fish/guestfish-actions.pod:1430
6683 #: ../fish/guestfish-actions.pod:1432
6691 #: ../fish/guestfish-actions.pod:1434
6693 "This returns the current setting of the selinux flag which is passed to the "
6694 "appliance at boot time. See L</set-selinux>."
6698 #: ../fish/guestfish-actions.pod:1440
6703 #: ../fish/guestfish-actions.pod:1442
6711 #: ../fish/guestfish-actions.pod:1444 ../src/guestfs-actions.pod:2156
6713 "This returns the current state as an opaque integer. This is only useful "
6714 "for printing debug and internal error messages."
6718 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2389 ../fish/guestfish-actions.pod:2407 ../fish/guestfish-actions.pod:2445 ../fish/guestfish-actions.pod:2461 ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3461 ../src/guestfs-actions.pod:3490 ../src/guestfs-actions.pod:3551 ../src/guestfs-actions.pod:3578
6719 msgid "For more information on states, see L<guestfs(3)>."
6723 #: ../fish/guestfish-actions.pod:1449
6728 #: ../fish/guestfish-actions.pod:1451
6736 #: ../fish/guestfish-actions.pod:1453 ../src/guestfs-actions.pod:2170
6737 msgid "Return the command trace flag."
6741 #: ../fish/guestfish-actions.pod:1455
6746 #: ../fish/guestfish-actions.pod:1457
6754 #: ../fish/guestfish-actions.pod:1459
6756 "Return the current umask. By default the umask is C<022> unless it has been "
6757 "set by calling L</umask>."
6761 #: ../fish/guestfish-actions.pod:1462
6766 #: ../fish/guestfish-actions.pod:1464
6774 #: ../fish/guestfish-actions.pod:1466 ../src/guestfs-actions.pod:2193
6775 msgid "This returns the verbose messages flag."
6779 #: ../fish/guestfish-actions.pod:1468
6784 #: ../fish/guestfish-actions.pod:1470
6792 #: ../fish/guestfish-actions.pod:1472 ../src/guestfs-actions.pod:2204
6793 msgid "This gets the SELinux security context of the daemon."
6797 #: ../fish/guestfish-actions.pod:1474
6798 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
6802 #: ../fish/guestfish-actions.pod:1477
6807 #: ../fish/guestfish-actions.pod:1479
6810 " getxattr path name\n"
6815 #: ../fish/guestfish-actions.pod:1481
6817 "Get a single extended attribute from file C<path> named C<name>. This call "
6818 "follows symlinks. If you want to lookup an extended attribute for the "
6819 "symlink itself, use L</lgetxattr>."
6823 #: ../fish/guestfish-actions.pod:1485 ../fish/guestfish-actions.pod:2534
6825 "Normally it is better to get all extended attributes from a file in one go "
6826 "by calling L</getxattrs>. However some Linux filesystem implementations are "
6827 "buggy and do not provide a way to list out attributes. For these "
6828 "filesystems (notably ntfs-3g) you have to know the names of the extended "
6829 "attributes you want in advance and call this function."
6833 #: ../fish/guestfish-actions.pod:1492 ../fish/guestfish-actions.pod:2541 ../src/guestfs-actions.pod:2233 ../src/guestfs-actions.pod:3711
6835 "Extended attribute values are blobs of binary data. If there is no extended "
6836 "attribute named C<name>, this returns an error."
6840 #: ../fish/guestfish-actions.pod:1495
6841 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
6845 #: ../fish/guestfish-actions.pod:1497
6850 #: ../fish/guestfish-actions.pod:1499
6858 #: ../fish/guestfish-actions.pod:1501 ../src/guestfs-actions.pod:2250
6859 msgid "This call lists the extended attributes of the file or directory C<path>."
6863 #: ../fish/guestfish-actions.pod:1504 ../src/guestfs-actions.pod:2253
6865 "At the system call level, this is a combination of the L<listxattr(2)> and "
6866 "L<getxattr(2)> calls."
6870 #: ../fish/guestfish-actions.pod:1507
6871 msgid "See also: L</lgetxattrs>, L<attr(5)>."
6875 #: ../fish/guestfish-actions.pod:1509
6880 #: ../fish/guestfish-actions.pod:1511
6883 " glob-expand pattern\n"
6888 #: ../fish/guestfish-actions.pod:1513 ../src/guestfs-actions.pod:2270
6890 "This command searches for all the pathnames matching C<pattern> according to "
6891 "the wildcard expansion rules used by the shell."
6895 #: ../fish/guestfish-actions.pod:1517 ../src/guestfs-actions.pod:2274
6896 msgid "If no paths match, then this returns an empty list (note: not an error)."
6900 #: ../fish/guestfish-actions.pod:1520 ../src/guestfs-actions.pod:2277
6902 "It is just a wrapper around the C L<glob(3)> function with flags "
6903 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
6907 #: ../fish/guestfish-actions.pod:1524
6912 #: ../fish/guestfish-actions.pod:1526
6915 " grep regex path\n"
6920 #: ../fish/guestfish-actions.pod:1528 ../src/guestfs-actions.pod:2294
6921 msgid "This calls the external C<grep> program and returns the matching lines."
6925 #: ../fish/guestfish-actions.pod:1534
6930 #: ../fish/guestfish-actions.pod:1536
6933 " grepi regex path\n"
6938 #: ../fish/guestfish-actions.pod:1538 ../src/guestfs-actions.pod:2313
6939 msgid "This calls the external C<grep -i> program and returns the matching lines."
6943 #: ../fish/guestfish-actions.pod:1544
6944 msgid "grub-install"
6948 #: ../fish/guestfish-actions.pod:1546
6951 " grub-install root device\n"
6956 #: ../fish/guestfish-actions.pod:1548 ../src/guestfs-actions.pod:2332
6958 "This command installs GRUB 1 (the Grand Unified Bootloader) on C<device>, "
6959 "with the root directory being C<root>."
6963 #: ../fish/guestfish-actions.pod:1557 ../src/guestfs-actions.pod:2341
6965 "There is currently no way in the API to install grub2, which is used by most "
6966 "modern Linux guests. It is possible to run the grub2 command from the "
6967 "guest, although see the caveats in L<guestfs(3)/RUNNING COMMANDS>."
6971 #: ../fish/guestfish-actions.pod:1564 ../src/guestfs-actions.pod:2348
6973 "This uses C<grub-install> from the host. Unfortunately grub is not always "
6974 "compatible with itself, so this only works in rather narrow circumstances. "
6975 "Careful testing with each guest version is advisable."
6979 #: ../fish/guestfish-actions.pod:1571 ../src/guestfs-actions.pod:2355
6981 "If grub-install reports the error \"No suitable drive was found in the "
6982 "generated device map.\" it may be that you need to create a "
6983 "C</boot/grub/device.map> file first that contains the mapping between grub "
6984 "device names and Linux device names. It is usually sufficient to create a "
6989 #: ../fish/guestfish-actions.pod:1578 ../src/guestfs-actions.pod:2362
6997 #: ../fish/guestfish-actions.pod:1580 ../src/guestfs-actions.pod:2364
6998 msgid "replacing C</dev/vda> with the name of the installation device."
7002 #: ../fish/guestfish-actions.pod:1584
7007 #: ../fish/guestfish-actions.pod:1586
7015 #: ../fish/guestfish-actions.pod:1588 ../src/guestfs-actions.pod:2378
7017 "This command returns up to the first 10 lines of a file as a list of "
7022 #: ../fish/guestfish-actions.pod:1594
7027 #: ../fish/guestfish-actions.pod:1596
7030 " head-n nrlines path\n"
7035 #: ../fish/guestfish-actions.pod:1598 ../src/guestfs-actions.pod:2397
7037 "If the parameter C<nrlines> is a positive number, this returns the first "
7038 "C<nrlines> lines of the file C<path>."
7042 #: ../fish/guestfish-actions.pod:1601 ../src/guestfs-actions.pod:2400
7044 "If the parameter C<nrlines> is a negative number, this returns lines from "
7045 "the file C<path>, excluding the last C<nrlines> lines."
7049 #: ../fish/guestfish-actions.pod:1604 ../fish/guestfish-actions.pod:4670 ../src/guestfs-actions.pod:2403 ../src/guestfs-actions.pod:7018
7050 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7054 #: ../fish/guestfish-actions.pod:1609
7059 #: ../fish/guestfish-actions.pod:1611
7067 #: ../fish/guestfish-actions.pod:1613 ../src/guestfs-actions.pod:2420
7069 "This runs C<hexdump -C> on the given C<path>. The result is the "
7070 "human-readable, canonical hex dump of the file."
7074 #: ../fish/guestfish-actions.pod:1619
7079 #: ../fish/guestfish-actions.pod:1621
7082 " initrd-cat initrdpath filename\n"
7087 #: ../fish/guestfish-actions.pod:1623 ../src/guestfs-actions.pod:2439
7089 "This command unpacks the file C<filename> from the initrd file called "
7090 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7095 #: ../fish/guestfish-actions.pod:1627 ../src/guestfs-actions.pod:2443
7097 "For example, in guestfish you could use the following command to examine the "
7098 "boot script (usually called C</init>) contained in a Linux initrd or "
7103 #: ../fish/guestfish-actions.pod:1631 ../src/guestfs-actions.pod:2447
7106 " initrd-cat /boot/initrd-<version>.img init\n"
7111 #: ../fish/guestfish-actions.pod:1633
7112 msgid "See also L</initrd-list>."
7116 #: ../fish/guestfish-actions.pod:1638
7121 #: ../fish/guestfish-actions.pod:1640
7124 " initrd-list path\n"
7129 #: ../fish/guestfish-actions.pod:1642 ../src/guestfs-actions.pod:2466
7130 msgid "This command lists out files contained in an initrd."
7134 #: ../fish/guestfish-actions.pod:1644 ../src/guestfs-actions.pod:2468
7136 "The files are listed without any initial C</> character. The files are "
7137 "listed in the order they appear (not necessarily alphabetical). Directory "
7138 "names are listed as separate items."
7142 #: ../fish/guestfish-actions.pod:1648 ../src/guestfs-actions.pod:2472
7144 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7145 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7150 #: ../fish/guestfish-actions.pod:1652
7151 msgid "inotify-add-watch"
7155 #: ../fish/guestfish-actions.pod:1654
7158 " inotify-add-watch path mask\n"
7163 #: ../fish/guestfish-actions.pod:1656 ../src/guestfs-actions.pod:2489
7164 msgid "Watch C<path> for the events listed in C<mask>."
7168 #: ../fish/guestfish-actions.pod:1658 ../src/guestfs-actions.pod:2491
7170 "Note that if C<path> is a directory then events within that directory are "
7171 "watched, but this does I<not> happen recursively (in subdirectories)."
7175 #: ../fish/guestfish-actions.pod:1662 ../src/guestfs-actions.pod:2495
7177 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7178 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7182 #: ../fish/guestfish-actions.pod:1666
7183 msgid "inotify-close"
7187 #: ../fish/guestfish-actions.pod:1668
7195 #: ../fish/guestfish-actions.pod:1670 ../src/guestfs-actions.pod:2508
7197 "This closes the inotify handle which was previously opened by inotify_init. "
7198 "It removes all watches, throws away any pending events, and deallocates all "
7203 #: ../fish/guestfish-actions.pod:1674
7204 msgid "inotify-files"
7208 #: ../fish/guestfish-actions.pod:1676
7216 #: ../fish/guestfish-actions.pod:1678
7218 "This function is a helpful wrapper around L</inotify-read> which just "
7219 "returns a list of pathnames of objects that were touched. The returned "
7220 "pathnames are sorted and deduplicated."
7224 #: ../fish/guestfish-actions.pod:1682
7225 msgid "inotify-init"
7229 #: ../fish/guestfish-actions.pod:1684
7232 " inotify-init maxevents\n"
7237 #: ../fish/guestfish-actions.pod:1686 ../src/guestfs-actions.pod:2537
7239 "This command creates a new inotify handle. The inotify subsystem can be "
7240 "used to notify events which happen to objects in the guest filesystem."
7244 #: ../fish/guestfish-actions.pod:1690
7246 "C<maxevents> is the maximum number of events which will be queued up between "
7247 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
7248 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
7249 "default was 16384 events. Beyond this limit, the kernel throws away events, "
7250 "but records the fact that it threw them away by setting a flag "
7251 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
7255 #: ../fish/guestfish-actions.pod:1700
7257 "Before any events are generated, you have to add some watches to the "
7258 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
7259 "L</inotify-watch-all>."
7263 #: ../fish/guestfish-actions.pod:1706
7265 "Queued up events should be read periodically by calling L</inotify-read> (or "
7266 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
7267 "If you don't read the events out often enough then you risk the internal "
7268 "queue overflowing."
7272 #: ../fish/guestfish-actions.pod:1713
7274 "The handle should be closed after use by calling L</inotify-close>. This "
7275 "also removes any watches automatically."
7279 #: ../fish/guestfish-actions.pod:1717 ../src/guestfs-actions.pod:2568
7281 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7282 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
7283 "that there is one global inotify handle per libguestfs instance."
7287 #: ../fish/guestfish-actions.pod:1722
7288 msgid "inotify-read"
7292 #: ../fish/guestfish-actions.pod:1724
7300 #: ../fish/guestfish-actions.pod:1726 ../src/guestfs-actions.pod:2582
7302 "Return the complete queue of events that have happened since the previous "
7307 #: ../fish/guestfish-actions.pod:1729 ../src/guestfs-actions.pod:2585
7308 msgid "If no events have happened, this returns an empty list."
7312 #: ../fish/guestfish-actions.pod:1731 ../src/guestfs-actions.pod:2587
7314 "I<Note>: In order to make sure that all events have been read, you must call "
7315 "this function repeatedly until it returns an empty list. The reason is that "
7316 "the call will read events up to the maximum appliance-to-host message size "
7317 "and leave remaining events in the queue."
7321 #: ../fish/guestfish-actions.pod:1737
7322 msgid "inotify-rm-watch"
7326 #: ../fish/guestfish-actions.pod:1739
7329 " inotify-rm-watch wd\n"
7334 #: ../fish/guestfish-actions.pod:1741
7335 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
7339 #: ../fish/guestfish-actions.pod:1744
7340 msgid "inspect-get-arch"
7344 #: ../fish/guestfish-actions.pod:1746
7347 " inspect-get-arch root\n"
7352 #: ../fish/guestfish-actions.pod:1748
7354 "This returns the architecture of the inspected operating system. The "
7355 "possible return values are listed under L</file-architecture>."
7359 #: ../fish/guestfish-actions.pod:1752 ../src/guestfs-actions.pod:2622
7361 "If the architecture could not be determined, then the string C<unknown> is "
7366 #: ../fish/guestfish-actions.pod:1755 ../fish/guestfish-actions.pod:1838 ../fish/guestfish-actions.pod:1917 ../fish/guestfish-actions.pod:1929 ../fish/guestfish-actions.pod:2013 ../fish/guestfish-actions.pod:2074 ../fish/guestfish-actions.pod:2095 ../fish/guestfish-actions.pod:2109 ../fish/guestfish-actions.pod:2149 ../fish/guestfish-actions.pod:2181 ../fish/guestfish-actions.pod:2194 ../fish/guestfish-actions.pod:2207 ../fish/guestfish-actions.pod:2217 ../fish/guestfish-actions.pod:2227 ../fish/guestfish-actions.pod:2239 ../fish/guestfish-actions.pod:2335 ../fish/guestfish-actions.pod:2369 ../src/guestfs-actions.pod:2625 ../src/guestfs-actions.pod:2715 ../src/guestfs-actions.pod:2819 ../src/guestfs-actions.pod:2838 ../src/guestfs-actions.pod:2969 ../src/guestfs-actions.pod:3052 ../src/guestfs-actions.pod:3080 ../src/guestfs-actions.pod:3101 ../src/guestfs-actions.pod:3154 ../src/guestfs-actions.pod:3194 ../src/guestfs-actions.pod:3214 ../src/guestfs-actions.pod:3234 ../src/guestfs-actions.pod:3251 ../src/guestfs-actions.pod:3267 ../src/guestfs-actions.pod:3285 ../src/guestfs-actions.pod:3387 ../src/guestfs-actions.pod:3428
7367 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
7371 #: ../fish/guestfish-actions.pod:1757
7372 msgid "inspect-get-distro"
7376 #: ../fish/guestfish-actions.pod:1759
7379 " inspect-get-distro root\n"
7384 #: ../fish/guestfish-actions.pod:1761 ../src/guestfs-actions.pod:2638
7385 msgid "This returns the distro (distribution) of the inspected operating system."
7389 #: ../fish/guestfish-actions.pod:1764 ../src/guestfs-actions.pod:2641
7390 msgid "Currently defined distros are:"
7394 #: ../fish/guestfish-actions.pod:1768 ../src/guestfs-actions.pod:2645
7395 msgid "\"archlinux\""
7399 #: ../fish/guestfish-actions.pod:1770 ../src/guestfs-actions.pod:2647
7404 #: ../fish/guestfish-actions.pod:1772 ../src/guestfs-actions.pod:2649
7409 #: ../fish/guestfish-actions.pod:1774 ../src/guestfs-actions.pod:2651
7414 #: ../fish/guestfish-actions.pod:1776 ../src/guestfs-actions.pod:2653
7419 #: ../fish/guestfish-actions.pod:1778 ../src/guestfs-actions.pod:2655
7424 #: ../fish/guestfish-actions.pod:1780 ../src/guestfs-actions.pod:2657
7429 #: ../fish/guestfish-actions.pod:1782 ../src/guestfs-actions.pod:2659
7434 #: ../fish/guestfish-actions.pod:1784 ../src/guestfs-actions.pod:2661
7439 #: ../fish/guestfish-actions.pod:1786 ../src/guestfs-actions.pod:2663
7444 #: ../fish/guestfish-actions.pod:1788 ../src/guestfs-actions.pod:2665
7445 msgid "\"linuxmint\""
7449 #: ../fish/guestfish-actions.pod:1790 ../src/guestfs-actions.pod:2667
7454 #: ../fish/guestfish-actions.pod:1792 ../src/guestfs-actions.pod:2669
7455 msgid "\"mandriva\""
7459 #: ../fish/guestfish-actions.pod:1794 ../src/guestfs-actions.pod:2671
7464 #: ../fish/guestfish-actions.pod:1796 ../src/guestfs-actions.pod:2673
7469 #: ../fish/guestfish-actions.pod:1798 ../src/guestfs-actions.pod:2675
7474 #: ../fish/guestfish-actions.pod:1800 ../src/guestfs-actions.pod:2677
7479 #: ../fish/guestfish-actions.pod:1802 ../src/guestfs-actions.pod:2679
7484 #: ../fish/guestfish-actions.pod:1804 ../src/guestfs-actions.pod:2681
7485 msgid "\"redhat-based\""
7489 #: ../fish/guestfish-actions.pod:1806 ../src/guestfs-actions.pod:2683
7490 msgid "Some Red Hat-derived distro."
7494 #: ../fish/guestfish-actions.pod:1808 ../src/guestfs-actions.pod:2685
7499 #: ../fish/guestfish-actions.pod:1810 ../src/guestfs-actions.pod:2687
7500 msgid "Red Hat Enterprise Linux."
7504 #: ../fish/guestfish-actions.pod:1812 ../src/guestfs-actions.pod:2689
7505 msgid "\"scientificlinux\""
7509 #: ../fish/guestfish-actions.pod:1814 ../src/guestfs-actions.pod:2691
7510 msgid "Scientific Linux."
7514 #: ../fish/guestfish-actions.pod:1816 ../src/guestfs-actions.pod:2693
7515 msgid "\"slackware\""
7519 #: ../fish/guestfish-actions.pod:1818 ../src/guestfs-actions.pod:2695
7524 #: ../fish/guestfish-actions.pod:1820 ../src/guestfs-actions.pod:2697
7529 #: ../fish/guestfish-actions.pod:1822 ../src/guestfs-actions.pod:2699
7534 #: ../fish/guestfish-actions.pod:1824 ../fish/guestfish-actions.pod:1908 ../fish/guestfish-actions.pod:2172 ../src/guestfs-actions.pod:2701 ../src/guestfs-actions.pod:2810 ../src/guestfs-actions.pod:3185
7539 #: ../fish/guestfish-actions.pod:1826 ../src/guestfs-actions.pod:2703
7540 msgid "The distro could not be determined."
7544 #: ../fish/guestfish-actions.pod:1828 ../fish/guestfish-actions.pod:2164 ../src/guestfs-actions.pod:2705 ../src/guestfs-actions.pod:3177
7549 #: ../fish/guestfish-actions.pod:1830 ../src/guestfs-actions.pod:2707
7551 "Windows does not have distributions. This string is returned if the OS type "
7556 #: ../fish/guestfish-actions.pod:1835 ../fish/guestfish-actions.pod:1914 ../fish/guestfish-actions.pod:2178 ../src/guestfs-actions.pod:2712 ../src/guestfs-actions.pod:2816 ../src/guestfs-actions.pod:3191
7558 "Future versions of libguestfs may return other strings here. The caller "
7559 "should be prepared to handle any string."
7563 #: ../fish/guestfish-actions.pod:1840
7564 msgid "inspect-get-drive-mappings"
7568 #: ../fish/guestfish-actions.pod:1842
7571 " inspect-get-drive-mappings root\n"
7576 #: ../fish/guestfish-actions.pod:1844 ../src/guestfs-actions.pod:2728
7578 "This call is useful for Windows which uses a primitive system of assigning "
7579 "drive letters (like \"C:\") to partitions. This inspection API examines the "
7580 "Windows Registry to find out how disks/partitions are mapped to drive "
7581 "letters, and returns a hash table as in the example below:"
7585 #: ../fish/guestfish-actions.pod:1850 ../src/guestfs-actions.pod:2734
7595 #: ../fish/guestfish-actions.pod:1854 ../src/guestfs-actions.pod:2738
7597 "Note that keys are drive letters. For Windows, the key is case insensitive "
7598 "and just contains the drive letter, without the customary colon separator "
7603 #: ../fish/guestfish-actions.pod:1858 ../src/guestfs-actions.pod:2742
7605 "In future we may support other operating systems that also used drive "
7606 "letters, but the keys for those might not be case insensitive and might be "
7607 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
7612 #: ../fish/guestfish-actions.pod:1863 ../src/guestfs-actions.pod:2747
7614 "For Windows guests, currently only hard drive mappings are returned. "
7615 "Removable disks (eg. DVD-ROMs) are ignored."
7619 #: ../fish/guestfish-actions.pod:1866 ../src/guestfs-actions.pod:2750
7621 "For guests that do not use drive mappings, or if the drive mappings could "
7622 "not be determined, this returns an empty hash table."
7626 #: ../fish/guestfish-actions.pod:1869
7628 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7629 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
7633 #: ../fish/guestfish-actions.pod:1873
7634 msgid "inspect-get-filesystems"
7638 #: ../fish/guestfish-actions.pod:1875
7641 " inspect-get-filesystems root\n"
7646 #: ../fish/guestfish-actions.pod:1877 ../src/guestfs-actions.pod:2771
7648 "This returns a list of all the filesystems that we think are associated with "
7649 "this operating system. This includes the root filesystem, other ordinary "
7650 "filesystems, and non-mounted devices like swap partitions."
7654 #: ../fish/guestfish-actions.pod:1882 ../src/guestfs-actions.pod:2776
7656 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
7657 "to be shared between operating systems."
7661 #: ../fish/guestfish-actions.pod:1885
7663 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7664 "L</inspect-get-mountpoints>."
7668 #: ../fish/guestfish-actions.pod:1888
7669 msgid "inspect-get-format"
7673 #: ../fish/guestfish-actions.pod:1890
7676 " inspect-get-format root\n"
7681 #: ../fish/guestfish-actions.pod:1892 ../src/guestfs-actions.pod:2794
7683 "This returns the format of the inspected operating system. You can use it "
7684 "to detect install images, live CDs and similar."
7688 #: ../fish/guestfish-actions.pod:1895 ../src/guestfs-actions.pod:2797
7689 msgid "Currently defined formats are:"
7693 #: ../fish/guestfish-actions.pod:1899 ../src/guestfs-actions.pod:2801
7694 msgid "\"installed\""
7698 #: ../fish/guestfish-actions.pod:1901 ../src/guestfs-actions.pod:2803
7699 msgid "This is an installed operating system."
7703 #: ../fish/guestfish-actions.pod:1903 ../src/guestfs-actions.pod:2805
7704 msgid "\"installer\""
7708 #: ../fish/guestfish-actions.pod:1905 ../src/guestfs-actions.pod:2807
7710 "The disk image being inspected is not an installed operating system, but a "
7711 "I<bootable> install disk, live CD, or similar."
7715 #: ../fish/guestfish-actions.pod:1910 ../src/guestfs-actions.pod:2812
7716 msgid "The format of this disk image is not known."
7720 #: ../fish/guestfish-actions.pod:1919
7721 msgid "inspect-get-hostname"
7725 #: ../fish/guestfish-actions.pod:1921
7728 " inspect-get-hostname root\n"
7733 #: ../fish/guestfish-actions.pod:1923 ../src/guestfs-actions.pod:2832
7735 "This function returns the hostname of the operating system as found by "
7736 "inspection of the guest's configuration files."
7740 #: ../fish/guestfish-actions.pod:1926 ../src/guestfs-actions.pod:2835
7742 "If the hostname could not be determined, then the string C<unknown> is "
7747 #: ../fish/guestfish-actions.pod:1931
7748 msgid "inspect-get-icon"
7752 #: ../fish/guestfish-actions.pod:1933
7755 " inspect-get-icon root [favicon:..] [highquality:..]\n"
7760 #: ../fish/guestfish-actions.pod:1935 ../src/guestfs-actions.pod:2861
7762 "This function returns an icon corresponding to the inspected operating "
7763 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
7764 "to PNG if necessary)."
7768 #: ../fish/guestfish-actions.pod:1939 ../src/guestfs-actions.pod:2865
7770 "If it was not possible to get an icon this function returns a zero-length "
7771 "(non-NULL) buffer. I<Callers must check for this case>."
7775 #: ../fish/guestfish-actions.pod:1942 ../src/guestfs-actions.pod:2868
7777 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
7778 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
7779 "this file will be returned. You can disable favicons by passing the "
7780 "optional C<favicon> boolean as false (default is true)."
7784 #: ../fish/guestfish-actions.pod:1948 ../src/guestfs-actions.pod:2874
7786 "If finding the favicon fails, then we look in other places in the guest for "
7791 #: ../fish/guestfish-actions.pod:1951 ../src/guestfs-actions.pod:2877
7793 "If the optional C<highquality> boolean is true then only high quality icons "
7794 "are returned, which means only icons of high resolution with an alpha "
7795 "channel. The default (false) is to return any icon we can, even if it is of "
7796 "substandard quality."
7800 #: ../fish/guestfish-actions.pod:1962 ../src/guestfs-actions.pod:2888
7802 "Unlike most other inspection API calls, the guest's disks must be mounted up "
7803 "before you call this, since it needs to read information from the guest "
7804 "filesystem during the call."
7808 #: ../fish/guestfish-actions.pod:1968 ../src/guestfs-actions.pod:2894
7810 "B<Security:> The icon data comes from the untrusted guest, and should be "
7811 "treated with caution. PNG files have been known to contain exploits. "
7812 "Ensure that libpng (or other relevant libraries) are fully up to date before "
7813 "trying to process or display the icon."
7817 #: ../fish/guestfish-actions.pod:1976 ../src/guestfs-actions.pod:2902
7819 "The PNG image returned can be any size. It might not be square. Libguestfs "
7820 "tries to return the largest, highest quality icon available. The "
7821 "application must scale the icon to the required size."
7825 #: ../fish/guestfish-actions.pod:1983 ../src/guestfs-actions.pod:2909
7827 "Extracting icons from Windows guests requires the external C<wrestool> "
7828 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
7829 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
7830 "installed separately."
7834 #: ../fish/guestfish-actions.pod:1990 ../src/guestfs-actions.pod:2916
7836 "Operating system icons are usually trademarks. Seek legal advice before "
7837 "using trademarks in applications."
7841 #: ../fish/guestfish-actions.pod:1997
7842 msgid "inspect-get-major-version"
7846 #: ../fish/guestfish-actions.pod:1999
7849 " inspect-get-major-version root\n"
7854 #: ../fish/guestfish-actions.pod:2001 ../src/guestfs-actions.pod:2957
7855 msgid "This returns the major version number of the inspected operating system."
7859 #: ../fish/guestfish-actions.pod:2004 ../src/guestfs-actions.pod:2960
7861 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
7862 "popular public names used by the operating system. Notably the operating "
7863 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
7864 "1). You can find out the real versions corresponding to releases of Windows "
7865 "by consulting Wikipedia or MSDN."
7869 #: ../fish/guestfish-actions.pod:2011 ../fish/guestfish-actions.pod:2022 ../src/guestfs-actions.pod:2967 ../src/guestfs-actions.pod:2984
7870 msgid "If the version could not be determined, then C<0> is returned."
7874 #: ../fish/guestfish-actions.pod:2015
7875 msgid "inspect-get-minor-version"
7879 #: ../fish/guestfish-actions.pod:2017
7882 " inspect-get-minor-version root\n"
7887 #: ../fish/guestfish-actions.pod:2019 ../src/guestfs-actions.pod:2981
7888 msgid "This returns the minor version number of the inspected operating system."
7892 #: ../fish/guestfish-actions.pod:2024
7894 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7895 "L</inspect-get-major-version>."
7899 #: ../fish/guestfish-actions.pod:2027
7900 msgid "inspect-get-mountpoints"
7904 #: ../fish/guestfish-actions.pod:2029
7907 " inspect-get-mountpoints root\n"
7912 #: ../fish/guestfish-actions.pod:2031 ../src/guestfs-actions.pod:2999
7914 "This returns a hash of where we think the filesystems associated with this "
7915 "operating system should be mounted. Callers should note that this is at "
7916 "best an educated guess made by reading configuration files such as "
7917 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
7918 "are non-existent or not mountable and callers should be prepared to handle "
7919 "or ignore failures if they try to mount them."
7923 #: ../fish/guestfish-actions.pod:2040 ../src/guestfs-actions.pod:3008
7925 "Each element in the returned hashtable has a key which is the path of the "
7926 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
7927 "mounted there (eg. C</dev/sda1>)."
7931 #: ../fish/guestfish-actions.pod:2045 ../src/guestfs-actions.pod:3013
7932 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
7936 #: ../fish/guestfish-actions.pod:2048
7938 "For operating systems like Windows which still use drive letters, this call "
7939 "will only return an entry for the first drive \"mounted on\" C</>. For "
7940 "information about the mapping of drive letters to partitions, see "
7941 "L</inspect-get-drive-mappings>."
7945 #: ../fish/guestfish-actions.pod:2054
7947 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7948 "L</inspect-get-filesystems>."
7952 #: ../fish/guestfish-actions.pod:2057
7953 msgid "inspect-get-package-format"
7957 #: ../fish/guestfish-actions.pod:2059
7960 " inspect-get-package-format root\n"
7965 #: ../fish/guestfish-actions.pod:2061
7967 "This function and L</inspect-get-package-management> return the package "
7968 "format and package management tool used by the inspected operating system. "
7969 "For example for Fedora these functions would return C<rpm> (package format) "
7970 "and C<yum> (package management)."
7974 #: ../fish/guestfish-actions.pod:2067 ../src/guestfs-actions.pod:3045
7976 "This returns the string C<unknown> if we could not determine the package "
7977 "format I<or> if the operating system does not have a real packaging system "
7982 #: ../fish/guestfish-actions.pod:2071 ../src/guestfs-actions.pod:3049
7984 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
7985 "Future versions of libguestfs may return other strings."
7989 #: ../fish/guestfish-actions.pod:2076
7990 msgid "inspect-get-package-management"
7994 #: ../fish/guestfish-actions.pod:2078
7997 " inspect-get-package-management root\n"
8002 #: ../fish/guestfish-actions.pod:2080
8004 "L</inspect-get-package-format> and this function return the package format "
8005 "and package management tool used by the inspected operating system. For "
8006 "example for Fedora these functions would return C<rpm> (package format) and "
8007 "C<yum> (package management)."
8011 #: ../fish/guestfish-actions.pod:2086 ../src/guestfs-actions.pod:3071
8013 "This returns the string C<unknown> if we could not determine the package "
8014 "management tool I<or> if the operating system does not have a real packaging "
8015 "system (eg. Windows)."
8019 #: ../fish/guestfish-actions.pod:2090 ../src/guestfs-actions.pod:3075
8021 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
8022 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
8023 "libguestfs may return other strings."
8027 #: ../fish/guestfish-actions.pod:2097
8028 msgid "inspect-get-product-name"
8032 #: ../fish/guestfish-actions.pod:2099
8035 " inspect-get-product-name root\n"
8040 #: ../fish/guestfish-actions.pod:2101 ../src/guestfs-actions.pod:3093
8042 "This returns the product name of the inspected operating system. The "
8043 "product name is generally some freeform string which can be displayed to the "
8044 "user, but should not be parsed by programs."
8048 #: ../fish/guestfish-actions.pod:2106 ../src/guestfs-actions.pod:3098
8050 "If the product name could not be determined, then the string C<unknown> is "
8055 #: ../fish/guestfish-actions.pod:2111
8056 msgid "inspect-get-product-variant"
8060 #: ../fish/guestfish-actions.pod:2113
8063 " inspect-get-product-variant root\n"
8068 #: ../fish/guestfish-actions.pod:2115 ../src/guestfs-actions.pod:3114
8069 msgid "This returns the product variant of the inspected operating system."
8073 #: ../fish/guestfish-actions.pod:2118 ../src/guestfs-actions.pod:3117
8075 "For Windows guests, this returns the contents of the Registry key "
8076 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
8077 "which is usually a string such as C<Client> or C<Server> (other values are "
8078 "possible). This can be used to distinguish consumer and enterprise versions "
8079 "of Windows that have the same version number (for example, Windows 7 and "
8080 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
8081 "the latter is C<Server>)."
8085 #: ../fish/guestfish-actions.pod:2127 ../src/guestfs-actions.pod:3126
8087 "For enterprise Linux guests, in future we intend this to return the product "
8088 "variant such as C<Desktop>, C<Server> and so on. But this is not "
8089 "implemented at present."
8093 #: ../fish/guestfish-actions.pod:2131 ../src/guestfs-actions.pod:3130
8095 "If the product variant could not be determined, then the string C<unknown> "
8100 #: ../fish/guestfish-actions.pod:2134
8102 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8103 "L</inspect-get-product-name>, L</inspect-get-major-version>."
8107 #: ../fish/guestfish-actions.pod:2138
8108 msgid "inspect-get-roots"
8112 #: ../fish/guestfish-actions.pod:2140
8115 " inspect-get-roots\n"
8120 #: ../fish/guestfish-actions.pod:2142
8122 "This function is a convenient way to get the list of root devices, as "
8123 "returned from a previous call to L</inspect-os>, but without redoing the "
8124 "whole inspection process."
8128 #: ../fish/guestfish-actions.pod:2146
8130 "This returns an empty list if either no root devices were found or the "
8131 "caller has not called L</inspect-os>."
8135 #: ../fish/guestfish-actions.pod:2151
8136 msgid "inspect-get-type"
8140 #: ../fish/guestfish-actions.pod:2153
8143 " inspect-get-type root\n"
8148 #: ../fish/guestfish-actions.pod:2155 ../src/guestfs-actions.pod:3168
8150 "This returns the type of the inspected operating system. Currently defined "
8155 #: ../fish/guestfish-actions.pod:2160 ../src/guestfs-actions.pod:3173
8160 #: ../fish/guestfish-actions.pod:2162 ../src/guestfs-actions.pod:3175
8161 msgid "Any Linux-based operating system."
8165 #: ../fish/guestfish-actions.pod:2166 ../src/guestfs-actions.pod:3179
8166 msgid "Any Microsoft Windows operating system."
8170 #: ../fish/guestfish-actions.pod:2168 ../src/guestfs-actions.pod:3181
8175 #: ../fish/guestfish-actions.pod:2170 ../src/guestfs-actions.pod:3183
8180 #: ../fish/guestfish-actions.pod:2174 ../src/guestfs-actions.pod:3187
8181 msgid "The operating system type could not be determined."
8185 #: ../fish/guestfish-actions.pod:2183
8186 msgid "inspect-get-windows-current-control-set"
8190 #: ../fish/guestfish-actions.pod:2185
8193 " inspect-get-windows-current-control-set root\n"
8198 #: ../fish/guestfish-actions.pod:2187 ../src/guestfs-actions.pod:3207
8200 "This returns the Windows CurrentControlSet of the inspected guest. The "
8201 "CurrentControlSet is a registry key name such as C<ControlSet001>."
8205 #: ../fish/guestfish-actions.pod:2190 ../src/guestfs-actions.pod:3210
8207 "This call assumes that the guest is Windows and that the Registry could be "
8208 "examined by inspection. If this is not the case then an error is returned."
8212 #: ../fish/guestfish-actions.pod:2196
8213 msgid "inspect-get-windows-systemroot"
8217 #: ../fish/guestfish-actions.pod:2198
8220 " inspect-get-windows-systemroot root\n"
8225 #: ../fish/guestfish-actions.pod:2200 ../src/guestfs-actions.pod:3227
8227 "This returns the Windows systemroot of the inspected guest. The systemroot "
8228 "is a directory path such as C</WINDOWS>."
8232 #: ../fish/guestfish-actions.pod:2203 ../src/guestfs-actions.pod:3230
8234 "This call assumes that the guest is Windows and that the systemroot could be "
8235 "determined by inspection. If this is not the case then an error is "
8240 #: ../fish/guestfish-actions.pod:2209
8241 msgid "inspect-is-live"
8245 #: ../fish/guestfish-actions.pod:2211
8248 " inspect-is-live root\n"
8253 #: ../fish/guestfish-actions.pod:2213
8255 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8256 "then this returns true if a live image was detected on the disk."
8260 #: ../fish/guestfish-actions.pod:2219
8261 msgid "inspect-is-multipart"
8265 #: ../fish/guestfish-actions.pod:2221
8268 " inspect-is-multipart root\n"
8273 #: ../fish/guestfish-actions.pod:2223
8275 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8276 "then this returns true if the disk is part of a set."
8280 #: ../fish/guestfish-actions.pod:2229
8281 msgid "inspect-is-netinst"
8285 #: ../fish/guestfish-actions.pod:2231
8288 " inspect-is-netinst root\n"
8293 #: ../fish/guestfish-actions.pod:2233
8295 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8296 "then this returns true if the disk is a network installer, ie. not a "
8297 "self-contained install CD but one which is likely to require network access "
8298 "to complete the install."
8302 #: ../fish/guestfish-actions.pod:2241
8303 msgid "inspect-list-applications"
8307 #: ../fish/guestfish-actions.pod:2243
8310 " inspect-list-applications root\n"
8315 #: ../fish/guestfish-actions.pod:2245 ../src/guestfs-actions.pod:3297
8316 msgid "Return the list of applications installed in the operating system."
8320 #: ../fish/guestfish-actions.pod:2247
8322 "I<Note:> This call works differently from other parts of the inspection "
8323 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
8324 "then mount up the disks, before calling this. Listing applications is a "
8325 "significantly more difficult operation which requires access to the full "
8326 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
8327 "are just returning data cached in the libguestfs handle, this call actually "
8328 "reads parts of the mounted filesystems during the call."
8332 #: ../fish/guestfish-actions.pod:2257 ../src/guestfs-actions.pod:3309
8334 "This returns an empty list if the inspection code was not able to determine "
8335 "the list of applications."
8339 #: ../fish/guestfish-actions.pod:2260 ../src/guestfs-actions.pod:3312
8340 msgid "The application structure contains the following fields:"
8344 #: ../fish/guestfish-actions.pod:2264 ../src/guestfs-actions.pod:3316
8349 #: ../fish/guestfish-actions.pod:2266 ../src/guestfs-actions.pod:3318
8351 "The name of the application. For Red Hat-derived and Debian-derived Linux "
8352 "guests, this is the package name."
8356 #: ../fish/guestfish-actions.pod:2269 ../src/guestfs-actions.pod:3321
8357 msgid "C<app_display_name>"
8361 #: ../fish/guestfish-actions.pod:2271 ../src/guestfs-actions.pod:3323
8363 "The display name of the application, sometimes localized to the install "
8364 "language of the guest operating system."
8368 #: ../fish/guestfish-actions.pod:2274 ../src/guestfs-actions.pod:3326
8370 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
8371 "to display something can use C<app_name> instead."
8375 #: ../fish/guestfish-actions.pod:2277 ../src/guestfs-actions.pod:3329
8376 msgid "C<app_epoch>"
8380 #: ../fish/guestfish-actions.pod:2279 ../src/guestfs-actions.pod:3331
8382 "For package managers which use epochs, this contains the epoch of the "
8383 "package (an integer). If unavailable, this is returned as C<0>."
8387 #: ../fish/guestfish-actions.pod:2282 ../src/guestfs-actions.pod:3334
8388 msgid "C<app_version>"
8392 #: ../fish/guestfish-actions.pod:2284 ../src/guestfs-actions.pod:3336
8394 "The version string of the application or package. If unavailable this is "
8395 "returned as an empty string C<\"\">."
8399 #: ../fish/guestfish-actions.pod:2287 ../src/guestfs-actions.pod:3339
8400 msgid "C<app_release>"
8404 #: ../fish/guestfish-actions.pod:2289 ../src/guestfs-actions.pod:3341
8406 "The release string of the application or package, for package managers that "
8407 "use this. If unavailable this is returned as an empty string C<\"\">."
8411 #: ../fish/guestfish-actions.pod:2293 ../src/guestfs-actions.pod:3345
8412 msgid "C<app_install_path>"
8416 #: ../fish/guestfish-actions.pod:2295 ../src/guestfs-actions.pod:3347
8418 "The installation path of the application (on operating systems such as "
8419 "Windows which use installation paths). This path is in the format used by "
8420 "the guest operating system, it is not a libguestfs path."
8424 #: ../fish/guestfish-actions.pod:2300 ../src/guestfs-actions.pod:3352
8425 msgid "If unavailable this is returned as an empty string C<\"\">."
8429 #: ../fish/guestfish-actions.pod:2302 ../src/guestfs-actions.pod:3354
8430 msgid "C<app_trans_path>"
8434 #: ../fish/guestfish-actions.pod:2304 ../src/guestfs-actions.pod:3356
8436 "The install path translated into a libguestfs path. If unavailable this is "
8437 "returned as an empty string C<\"\">."
8441 #: ../fish/guestfish-actions.pod:2307 ../src/guestfs-actions.pod:3359
8442 msgid "C<app_publisher>"
8446 #: ../fish/guestfish-actions.pod:2309 ../src/guestfs-actions.pod:3361
8448 "The name of the publisher of the application, for package managers that use "
8449 "this. If unavailable this is returned as an empty string C<\"\">."
8453 #: ../fish/guestfish-actions.pod:2313 ../src/guestfs-actions.pod:3365
8458 #: ../fish/guestfish-actions.pod:2315 ../src/guestfs-actions.pod:3367
8460 "The URL (eg. upstream URL) of the application. If unavailable this is "
8461 "returned as an empty string C<\"\">."
8465 #: ../fish/guestfish-actions.pod:2318 ../src/guestfs-actions.pod:3370
8466 msgid "C<app_source_package>"
8470 #: ../fish/guestfish-actions.pod:2320 ../src/guestfs-actions.pod:3372
8472 "For packaging systems which support this, the name of the source package. "
8473 "If unavailable this is returned as an empty string C<\"\">."
8477 #: ../fish/guestfish-actions.pod:2323 ../src/guestfs-actions.pod:3375
8478 msgid "C<app_summary>"
8482 #: ../fish/guestfish-actions.pod:2325 ../src/guestfs-actions.pod:3377
8484 "A short (usually one line) description of the application or package. If "
8485 "unavailable this is returned as an empty string C<\"\">."
8489 #: ../fish/guestfish-actions.pod:2328 ../src/guestfs-actions.pod:3380
8490 msgid "C<app_description>"
8494 #: ../fish/guestfish-actions.pod:2330 ../src/guestfs-actions.pod:3382
8496 "A longer description of the application or package. If unavailable this is "
8497 "returned as an empty string C<\"\">."
8501 #: ../fish/guestfish-actions.pod:2337
8506 #: ../fish/guestfish-actions.pod:2339
8514 #: ../fish/guestfish-actions.pod:2341 ../src/guestfs-actions.pod:3400
8516 "This function uses other libguestfs functions and certain heuristics to "
8517 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
8518 "for operating systems."
8522 #: ../fish/guestfish-actions.pod:2345 ../src/guestfs-actions.pod:3404
8523 msgid "The list returned is empty if no operating systems were found."
8527 #: ../fish/guestfish-actions.pod:2347 ../src/guestfs-actions.pod:3406
8529 "If one operating system was found, then this returns a list with a single "
8530 "element, which is the name of the root filesystem of this operating system. "
8531 "It is also possible for this function to return a list containing more than "
8532 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
8533 "element being the root filesystem of one of the operating systems."
8537 #: ../fish/guestfish-actions.pod:2354
8539 "You can pass the root string(s) returned to other L</inspect-get-*> "
8540 "functions in order to query further information about each operating system, "
8541 "such as the name and version."
8545 #: ../fish/guestfish-actions.pod:2359
8547 "This function uses other libguestfs features such as L</mount-ro> and "
8548 "L</umount-all> in order to mount and unmount filesystems and look at the "
8549 "contents. This should be called with no disks currently mounted. The "
8550 "function may also use Augeas, so any existing Augeas handle will be closed."
8554 #: ../fish/guestfish-actions.pod:2365 ../src/guestfs-actions.pod:3424
8556 "This function cannot decrypt encrypted disks. The caller must do that first "
8557 "(supplying the necessary keys) if the disk is encrypted."
8561 #: ../fish/guestfish-actions.pod:2371 ../fish/guestfish-actions.pod:2569 ../fish/guestfish-actions.pod:2628
8562 msgid "See also L</list-filesystems>."
8566 #: ../fish/guestfish-actions.pod:2373
8571 #: ../fish/guestfish-actions.pod:2375
8574 " is-blockdev path\n"
8579 #: ../fish/guestfish-actions.pod:2377 ../src/guestfs-actions.pod:3444
8581 "This returns C<true> if and only if there is a block device with the given "
8586 #: ../fish/guestfish-actions.pod:2380 ../fish/guestfish-actions.pod:2398 ../fish/guestfish-actions.pod:2417 ../fish/guestfish-actions.pod:2426 ../fish/guestfish-actions.pod:2436 ../fish/guestfish-actions.pod:2470 ../fish/guestfish-actions.pod:2479
8587 msgid "See also L</stat>."
8591 #: ../fish/guestfish-actions.pod:2382
8596 #: ../fish/guestfish-actions.pod:2384
8604 #: ../fish/guestfish-actions.pod:2386 ../src/guestfs-actions.pod:3458
8606 "This returns true iff this handle is busy processing a command (in the "
8611 #: ../fish/guestfish-actions.pod:2391
8616 #: ../fish/guestfish-actions.pod:2393
8619 " is-chardev path\n"
8624 #: ../fish/guestfish-actions.pod:2395 ../src/guestfs-actions.pod:3473
8626 "This returns C<true> if and only if there is a character device with the "
8627 "given C<path> name."
8631 #: ../fish/guestfish-actions.pod:2400
8636 #: ../fish/guestfish-actions.pod:2402
8644 #: ../fish/guestfish-actions.pod:2404 ../src/guestfs-actions.pod:3487
8646 "This returns true iff this handle is being configured (in the C<CONFIG> "
8651 #: ../fish/guestfish-actions.pod:2409
8656 #: ../fish/guestfish-actions.pod:2411
8664 #: ../fish/guestfish-actions.pod:2413 ../src/guestfs-actions.pod:3502
8666 "This returns C<true> if and only if there is a directory with the given "
8667 "C<path> name. Note that it returns false for other objects like files."
8671 #: ../fish/guestfish-actions.pod:2419
8676 #: ../fish/guestfish-actions.pod:2421
8684 #: ../fish/guestfish-actions.pod:2423 ../src/guestfs-actions.pod:3518
8686 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
8687 "given C<path> name."
8691 #: ../fish/guestfish-actions.pod:2428
8696 #: ../fish/guestfish-actions.pod:2430
8704 #: ../fish/guestfish-actions.pod:2432 ../src/guestfs-actions.pod:3533
8706 "This returns C<true> if and only if there is a regular file with the given "
8707 "C<path> name. Note that it returns false for other objects like "
8712 #: ../fish/guestfish-actions.pod:2438
8713 msgid "is-launching"
8717 #: ../fish/guestfish-actions.pod:2440
8725 #: ../fish/guestfish-actions.pod:2442 ../src/guestfs-actions.pod:3548
8727 "This returns true iff this handle is launching the subprocess (in the "
8728 "C<LAUNCHING> state)."
8732 #: ../fish/guestfish-actions.pod:2447
8737 #: ../fish/guestfish-actions.pod:2449
8745 #: ../fish/guestfish-actions.pod:2451 ../src/guestfs-actions.pod:3563
8747 "This command tests whether C<device> is a logical volume, and returns true "
8748 "iff this is the case."
8752 #: ../fish/guestfish-actions.pod:2454
8757 #: ../fish/guestfish-actions.pod:2456
8765 #: ../fish/guestfish-actions.pod:2458 ../src/guestfs-actions.pod:3575
8767 "This returns true iff this handle is ready to accept commands (in the "
8772 #: ../fish/guestfish-actions.pod:2463
8777 #: ../fish/guestfish-actions.pod:2465
8785 #: ../fish/guestfish-actions.pod:2467 ../src/guestfs-actions.pod:3590
8787 "This returns C<true> if and only if there is a Unix domain socket with the "
8788 "given C<path> name."
8792 #: ../fish/guestfish-actions.pod:2472
8797 #: ../fish/guestfish-actions.pod:2474
8800 " is-symlink path\n"
8805 #: ../fish/guestfish-actions.pod:2476 ../src/guestfs-actions.pod:3605
8807 "This returns C<true> if and only if there is a symbolic link with the given "
8812 #: ../fish/guestfish-actions.pod:2481
8817 #: ../fish/guestfish-actions.pod:2483
8825 #: ../fish/guestfish-actions.pod:2485 ../src/guestfs-actions.pod:3620
8827 "This returns true iff the file exists and the file is empty or it contains "
8832 #: ../fish/guestfish-actions.pod:2488
8833 msgid "is-zero-device"
8837 #: ../fish/guestfish-actions.pod:2490
8840 " is-zero-device device\n"
8845 #: ../fish/guestfish-actions.pod:2492 ../src/guestfs-actions.pod:3633
8846 msgid "This returns true iff the device exists and contains all zero bytes."
8850 #: ../fish/guestfish-actions.pod:2494 ../src/guestfs-actions.pod:3635
8851 msgid "Note that for large devices this can take a long time to run."
8855 #: ../fish/guestfish-actions.pod:2496
8856 msgid "kill-subprocess"
8860 #: ../fish/guestfish-actions.pod:2498
8863 " kill-subprocess\n"
8868 #: ../fish/guestfish-actions.pod:2500 ../src/guestfs-actions.pod:3646
8869 msgid "This kills the qemu subprocess. You should never need to call this."
8873 #: ../fish/guestfish-actions.pod:2502
8878 #: ../fish/guestfish-actions.pod:2504
8883 #: ../fish/guestfish-actions.pod:2506
8891 #: ../fish/guestfish-actions.pod:2508 ../src/guestfs-actions.pod:3657
8893 "Internally libguestfs is implemented by running a virtual machine using "
8898 #: ../fish/guestfish-actions.pod:2511 ../src/guestfs-actions.pod:3660
8900 "You should call this after configuring the handle (eg. adding drives) but "
8901 "before performing any actions."
8905 #: ../fish/guestfish-actions.pod:2514
8910 #: ../fish/guestfish-actions.pod:2516
8913 " lchown owner group path\n"
8918 #: ../fish/guestfish-actions.pod:2518
8920 "Change the file owner to C<owner> and group to C<group>. This is like "
8921 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
8926 #: ../fish/guestfish-actions.pod:2526
8931 #: ../fish/guestfish-actions.pod:2528
8934 " lgetxattr path name\n"
8939 #: ../fish/guestfish-actions.pod:2530 ../src/guestfs-actions.pod:3700
8941 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
8942 "is a symlink, then this call returns an extended attribute from the symlink."
8946 #: ../fish/guestfish-actions.pod:2544
8947 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
8951 #: ../fish/guestfish-actions.pod:2546
8956 #: ../fish/guestfish-actions.pod:2548
8959 " lgetxattrs path\n"
8964 #: ../fish/guestfish-actions.pod:2550
8966 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
8967 "it returns the extended attributes of the link itself."
8971 #: ../fish/guestfish-actions.pod:2554
8976 #: ../fish/guestfish-actions.pod:2556
8984 #: ../fish/guestfish-actions.pod:2558 ../src/guestfs-actions.pod:3743
8986 "List all 9p filesystems attached to the guest. A list of mount tags is "
8991 #: ../fish/guestfish-actions.pod:2561
8992 msgid "list-devices"
8996 #: ../fish/guestfish-actions.pod:2563
9004 #: ../fish/guestfish-actions.pod:2565 ../src/guestfs-actions.pod:3757
9005 msgid "List all the block devices."
9009 #: ../fish/guestfish-actions.pod:2567 ../src/guestfs-actions.pod:3759
9010 msgid "The full block device names are returned, eg. C</dev/sda>."
9014 #: ../fish/guestfish-actions.pod:2571
9015 msgid "list-dm-devices"
9019 #: ../fish/guestfish-actions.pod:2573
9022 " list-dm-devices\n"
9027 #: ../fish/guestfish-actions.pod:2575 ../src/guestfs-actions.pod:3774
9028 msgid "List all device mapper devices."
9032 #: ../fish/guestfish-actions.pod:2577
9034 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
9035 "previous call to L</luks-open>."
9039 #: ../fish/guestfish-actions.pod:2580
9041 "Device mapper devices which correspond to logical volumes are I<not> "
9042 "returned in this list. Call L</lvs> if you want to list logical volumes."
9046 #: ../fish/guestfish-actions.pod:2584
9047 msgid "list-filesystems"
9051 #: ../fish/guestfish-actions.pod:2586
9054 " list-filesystems\n"
9059 #: ../fish/guestfish-actions.pod:2588 ../src/guestfs-actions.pod:3794
9061 "This inspection command looks for filesystems on partitions, block devices "
9062 "and logical volumes, returning a list of devices containing filesystems and "
9067 #: ../fish/guestfish-actions.pod:2592 ../src/guestfs-actions.pod:3798
9069 "The return value is a hash, where the keys are the devices containing "
9070 "filesystems, and the values are the filesystem types. For example:"
9074 #: ../fish/guestfish-actions.pod:2596 ../src/guestfs-actions.pod:3802
9077 " \"/dev/sda1\" => \"ntfs\"\n"
9078 " \"/dev/sda2\" => \"ext2\"\n"
9079 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9080 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9085 #: ../fish/guestfish-actions.pod:2601 ../src/guestfs-actions.pod:3807
9087 "The value can have the special value \"unknown\", meaning the content of the "
9088 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9092 #: ../fish/guestfish-actions.pod:2605
9094 "This command runs other libguestfs commands, which might include L</mount> "
9095 "and L</umount>, and therefore you should use this soon after launch and only "
9096 "when nothing is mounted."
9100 #: ../fish/guestfish-actions.pod:2609
9102 "Not all of the filesystems returned will be mountable. In particular, swap "
9103 "partitions are returned in the list. Also this command does not check that "
9104 "each filesystem found is valid and mountable, and some filesystems might be "
9105 "mountable but require special options. Filesystems may not all belong to a "
9106 "single logical operating system (use L</inspect-os> to look for OSes)."
9110 #: ../fish/guestfish-actions.pod:2617
9111 msgid "list-partitions"
9115 #: ../fish/guestfish-actions.pod:2619
9118 " list-partitions\n"
9123 #: ../fish/guestfish-actions.pod:2621 ../src/guestfs-actions.pod:3836
9124 msgid "List all the partitions detected on all block devices."
9128 #: ../fish/guestfish-actions.pod:2623 ../src/guestfs-actions.pod:3838
9129 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9133 #: ../fish/guestfish-actions.pod:2625
9135 "This does not return logical volumes. For that you will need to call "
9140 #: ../fish/guestfish-actions.pod:2630
9145 #: ../fish/guestfish-actions.pod:2632
9153 #: ../fish/guestfish-actions.pod:2634 ../src/guestfs-actions.pod:3857
9155 "List the files in C<directory> (relative to the root directory, there is no "
9156 "cwd) in the format of 'ls -la'."
9160 #: ../fish/guestfish-actions.pod:2637 ../src/guestfs-actions.pod:3860
9162 "This command is mostly useful for interactive sessions. It is I<not> "
9163 "intended that you try to parse the output string."
9167 #: ../fish/guestfish-actions.pod:2640
9172 #: ../fish/guestfish-actions.pod:2642
9175 " ln target linkname\n"
9180 #: ../fish/guestfish-actions.pod:2644 ../src/guestfs-actions.pod:3875
9181 msgid "This command creates a hard link using the C<ln> command."
9185 #: ../fish/guestfish-actions.pod:2646
9190 #: ../fish/guestfish-actions.pod:2648
9193 " ln-f target linkname\n"
9198 #: ../fish/guestfish-actions.pod:2650 ../src/guestfs-actions.pod:3888
9200 "This command creates a hard link using the C<ln -f> command. The I<-f> "
9201 "option removes the link (C<linkname>) if it exists already."
9205 #: ../fish/guestfish-actions.pod:2653
9210 #: ../fish/guestfish-actions.pod:2655
9213 " ln-s target linkname\n"
9218 #: ../fish/guestfish-actions.pod:2657 ../src/guestfs-actions.pod:3902
9219 msgid "This command creates a symbolic link using the C<ln -s> command."
9223 #: ../fish/guestfish-actions.pod:2659
9228 #: ../fish/guestfish-actions.pod:2661
9231 " ln-sf target linkname\n"
9236 #: ../fish/guestfish-actions.pod:2663 ../src/guestfs-actions.pod:3915
9238 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
9239 "option removes the link (C<linkname>) if it exists already."
9243 #: ../fish/guestfish-actions.pod:2666
9244 msgid "lremovexattr"
9248 #: ../fish/guestfish-actions.pod:2668
9251 " lremovexattr xattr path\n"
9256 #: ../fish/guestfish-actions.pod:2670
9258 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
9259 "it removes an extended attribute of the link itself."
9263 #: ../fish/guestfish-actions.pod:2674
9268 #: ../fish/guestfish-actions.pod:2676
9276 #: ../fish/guestfish-actions.pod:2678 ../src/guestfs-actions.pod:3943
9278 "List the files in C<directory> (relative to the root directory, there is no "
9279 "cwd). The '.' and '..' entries are not returned, but hidden files are "
9284 #: ../fish/guestfish-actions.pod:2682
9286 "This command is mostly useful for interactive sessions. Programs should "
9287 "probably use L</readdir> instead."
9291 #: ../fish/guestfish-actions.pod:2685
9296 #: ../fish/guestfish-actions.pod:2687
9299 " lsetxattr xattr val vallen path\n"
9304 #: ../fish/guestfish-actions.pod:2689
9306 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
9307 "sets an extended attribute of the link itself."
9311 #: ../fish/guestfish-actions.pod:2693
9316 #: ../fish/guestfish-actions.pod:2695
9324 #: ../fish/guestfish-actions.pod:2697 ../fish/guestfish-actions.pod:4505 ../src/guestfs-actions.pod:3979 ../src/guestfs-actions.pod:6758
9325 msgid "Returns file information for the given C<path>."
9329 #: ../fish/guestfish-actions.pod:2699
9331 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
9332 "the link is stat-ed, not the file it refers to."
9336 #: ../fish/guestfish-actions.pod:2703 ../src/guestfs-actions.pod:3985
9337 msgid "This is the same as the C<lstat(2)> system call."
9341 #: ../fish/guestfish-actions.pod:2705
9346 #: ../fish/guestfish-actions.pod:2707
9349 " lstatlist path 'names ...'\n"
9354 #: ../fish/guestfish-actions.pod:2709
9356 "This call allows you to perform the L</lstat> operation on multiple files, "
9357 "where all files are in the directory C<path>. C<names> is the list of files "
9358 "from this directory."
9362 #: ../fish/guestfish-actions.pod:2713 ../src/guestfs-actions.pod:4004
9364 "On return you get a list of stat structs, with a one-to-one correspondence "
9365 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9366 "then the C<ino> field of that structure is set to C<-1>."
9370 #: ../fish/guestfish-actions.pod:2718
9372 "This call is intended for programs that want to efficiently list a directory "
9373 "contents without making many round-trips. See also L</lxattrlist> for a "
9374 "similarly efficient call for getting extended attributes. Very long "
9375 "directory listings might cause the protocol message size to be exceeded, "
9376 "causing this call to fail. The caller must split up such requests into "
9377 "smaller groups of names."
9381 #: ../fish/guestfish-actions.pod:2726
9382 msgid "luks-add-key"
9386 #: ../fish/guestfish-actions.pod:2728
9389 " luks-add-key device keyslot\n"
9394 #: ../fish/guestfish-actions.pod:2730 ../src/guestfs-actions.pod:4032
9396 "This command adds a new key on LUKS device C<device>. C<key> is any "
9397 "existing key, and is used to access the device. C<newkey> is the new key to "
9398 "add. C<keyslot> is the key slot that will be replaced."
9402 #: ../fish/guestfish-actions.pod:2735
9404 "Note that if C<keyslot> already contains a key, then this command will "
9405 "fail. You have to use L</luks-kill-slot> first to remove that key."
9409 #: ../fish/guestfish-actions.pod:2739 ../fish/guestfish-actions.pod:2761 ../fish/guestfish-actions.pod:2774 ../fish/guestfish-actions.pod:2788 ../fish/guestfish-actions.pod:2814 ../fish/guestfish-actions.pod:2824
9411 "This command has one or more key or passphrase parameters. Guestfish will "
9412 "prompt for these separately."
9416 #: ../fish/guestfish-actions.pod:2742
9421 #: ../fish/guestfish-actions.pod:2744
9424 " luks-close device\n"
9429 #: ../fish/guestfish-actions.pod:2746
9431 "This closes a LUKS device that was created earlier by L</luks-open> or "
9432 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
9433 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
9434 "underlying block device."
9438 #: ../fish/guestfish-actions.pod:2752
9443 #: ../fish/guestfish-actions.pod:2754
9446 " luks-format device keyslot\n"
9451 #: ../fish/guestfish-actions.pod:2756 ../src/guestfs-actions.pod:4073
9453 "This command erases existing data on C<device> and formats the device as a "
9454 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9455 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9459 #: ../fish/guestfish-actions.pod:2764 ../fish/guestfish-actions.pod:2777 ../fish/guestfish-actions.pod:2864 ../fish/guestfish-actions.pod:3525 ../fish/guestfish-actions.pod:4051 ../fish/guestfish-actions.pod:4376 ../fish/guestfish-actions.pod:4399 ../fish/guestfish-actions.pod:4421 ../fish/guestfish-actions.pod:5167 ../src/guestfs-actions.pod:4080 ../src/guestfs-actions.pod:4103 ../src/guestfs-actions.pod:4246 ../src/guestfs-actions.pod:5349 ../src/guestfs-actions.pod:6137 ../src/guestfs-actions.pod:6565 ../src/guestfs-actions.pod:6595 ../src/guestfs-actions.pod:6628 ../src/guestfs-actions.pod:7834
9461 "B<This command is dangerous. Without careful use you can easily destroy all "
9466 #: ../fish/guestfish-actions.pod:2767
9467 msgid "luks-format-cipher"
9471 #: ../fish/guestfish-actions.pod:2769
9474 " luks-format-cipher device keyslot cipher\n"
9479 #: ../fish/guestfish-actions.pod:2771
9481 "This command is the same as L</luks-format> but it also allows you to set "
9482 "the C<cipher> used."
9486 #: ../fish/guestfish-actions.pod:2780
9487 msgid "luks-kill-slot"
9491 #: ../fish/guestfish-actions.pod:2782
9494 " luks-kill-slot device keyslot\n"
9499 #: ../fish/guestfish-actions.pod:2784 ../src/guestfs-actions.pod:4120
9501 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
9502 "device C<device>. C<key> must be one of the I<other> keys."
9506 #: ../fish/guestfish-actions.pod:2791
9511 #: ../fish/guestfish-actions.pod:2793
9514 " luks-open device mapname\n"
9519 #: ../fish/guestfish-actions.pod:2795 ../src/guestfs-actions.pod:4140
9521 "This command opens a block device which has been encrypted according to the "
9522 "Linux Unified Key Setup (LUKS) standard."
9526 #: ../fish/guestfish-actions.pod:2798 ../src/guestfs-actions.pod:4143
9527 msgid "C<device> is the encrypted block device or partition."
9531 #: ../fish/guestfish-actions.pod:2800 ../src/guestfs-actions.pod:4145
9533 "The caller must supply one of the keys associated with the LUKS block "
9534 "device, in the C<key> parameter."
9538 #: ../fish/guestfish-actions.pod:2803 ../src/guestfs-actions.pod:4148
9540 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
9541 "writes to this block device are decrypted from and encrypted to the "
9542 "underlying C<device> respectively."
9546 #: ../fish/guestfish-actions.pod:2807
9548 "If this block device contains LVM volume groups, then calling L</vgscan> "
9549 "followed by L</vg-activate-all> will make them visible."
9553 #: ../fish/guestfish-actions.pod:2811
9554 msgid "Use L</list-dm-devices> to list all device mapper devices."
9558 #: ../fish/guestfish-actions.pod:2817
9559 msgid "luks-open-ro"
9563 #: ../fish/guestfish-actions.pod:2819
9566 " luks-open-ro device mapname\n"
9571 #: ../fish/guestfish-actions.pod:2821
9573 "This is the same as L</luks-open> except that a read-only mapping is "
9578 #: ../fish/guestfish-actions.pod:2827
9583 #: ../fish/guestfish-actions.pod:2829
9586 " lvcreate logvol volgroup mbytes\n"
9591 #: ../fish/guestfish-actions.pod:2831 ../src/guestfs-actions.pod:4194
9593 "This creates an LVM logical volume called C<logvol> on the volume group "
9594 "C<volgroup>, with C<size> megabytes."
9598 #: ../fish/guestfish-actions.pod:2834
9599 msgid "lvm-canonical-lv-name"
9603 #: ../fish/guestfish-actions.pod:2836
9606 " lvm-canonical-lv-name lvname\n"
9611 #: ../fish/guestfish-actions.pod:2838 ../src/guestfs-actions.pod:4207
9613 "This converts alternative naming schemes for LVs that you might find to the "
9614 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
9619 #: ../fish/guestfish-actions.pod:2842 ../src/guestfs-actions.pod:4211
9621 "This command returns an error if the C<lvname> parameter does not refer to a "
9626 #: ../fish/guestfish-actions.pod:2845
9627 msgid "See also L</is-lv>."
9631 #: ../fish/guestfish-actions.pod:2847
9632 msgid "lvm-clear-filter"
9636 #: ../fish/guestfish-actions.pod:2849
9639 " lvm-clear-filter\n"
9644 #: ../fish/guestfish-actions.pod:2851
9646 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
9651 #: ../fish/guestfish-actions.pod:2854 ../fish/guestfish-actions.pod:2885 ../src/guestfs-actions.pod:4229 ../src/guestfs-actions.pod:4271
9652 msgid "This command also clears the LVM cache and performs a volume group scan."
9656 #: ../fish/guestfish-actions.pod:2857
9657 msgid "lvm-remove-all"
9661 #: ../fish/guestfish-actions.pod:2859
9669 #: ../fish/guestfish-actions.pod:2861 ../src/guestfs-actions.pod:4241
9671 "This command removes all LVM logical volumes, volume groups and physical "
9676 #: ../fish/guestfish-actions.pod:2867
9677 msgid "lvm-set-filter"
9681 #: ../fish/guestfish-actions.pod:2869
9684 " lvm-set-filter 'devices ...'\n"
9689 #: ../fish/guestfish-actions.pod:2871 ../src/guestfs-actions.pod:4257
9691 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
9692 "block devices in the list C<devices>, and will ignore all other attached "
9697 #: ../fish/guestfish-actions.pod:2875 ../src/guestfs-actions.pod:4261
9699 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
9700 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
9701 "there are two types of duplication possible: either cloned PVs/VGs which "
9702 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
9703 "same name. In normal operation you cannot create this situation, but you "
9704 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
9705 "inside the LVM metadata."
9709 #: ../fish/guestfish-actions.pod:2888 ../src/guestfs-actions.pod:4274
9710 msgid "You can filter whole block devices or individual partitions."
9714 #: ../fish/guestfish-actions.pod:2890 ../src/guestfs-actions.pod:4276
9716 "You cannot use this if any VG is currently in use (eg. contains a mounted "
9717 "filesystem), even if you are not filtering out that VG."
9721 #: ../fish/guestfish-actions.pod:2894
9726 #: ../fish/guestfish-actions.pod:2896
9729 " lvremove device\n"
9734 #: ../fish/guestfish-actions.pod:2898 ../src/guestfs-actions.pod:4290
9736 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
9737 "LV, such as C</dev/VG/LV>."
9741 #: ../fish/guestfish-actions.pod:2901 ../src/guestfs-actions.pod:4293
9743 "You can also remove all LVs in a volume group by specifying the VG name, "
9748 #: ../fish/guestfish-actions.pod:2904
9753 #: ../fish/guestfish-actions.pod:2906
9756 " lvrename logvol newlogvol\n"
9761 #: ../fish/guestfish-actions.pod:2908 ../src/guestfs-actions.pod:4307
9762 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
9766 #: ../fish/guestfish-actions.pod:2910
9771 #: ../fish/guestfish-actions.pod:2912
9774 " lvresize device mbytes\n"
9779 #: ../fish/guestfish-actions.pod:2914 ../src/guestfs-actions.pod:4320
9781 "This resizes (expands or shrinks) an existing LVM logical volume to "
9782 "C<mbytes>. When reducing, data in the reduced part is lost."
9786 #: ../fish/guestfish-actions.pod:2918
9787 msgid "lvresize-free"
9791 #: ../fish/guestfish-actions.pod:2920
9794 " lvresize-free lv percent\n"
9799 #: ../fish/guestfish-actions.pod:2922 ../src/guestfs-actions.pod:4335
9801 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
9802 "remaining free space in the volume group. Commonly you would call this with "
9803 "pc = 100 which expands the logical volume as much as possible, using all "
9804 "remaining free space in the volume group."
9808 #: ../fish/guestfish-actions.pod:2928
9813 #: ../fish/guestfish-actions.pod:2930
9821 #: ../fish/guestfish-actions.pod:2932 ../src/guestfs-actions.pod:4350
9823 "List all the logical volumes detected. This is the equivalent of the "
9824 "L<lvs(8)> command."
9828 #: ../fish/guestfish-actions.pod:2935 ../src/guestfs-actions.pod:4353
9830 "This returns a list of the logical volume device names "
9831 "(eg. C</dev/VolGroup00/LogVol00>)."
9835 #: ../fish/guestfish-actions.pod:2938
9836 msgid "See also L</lvs-full>, L</list-filesystems>."
9840 #: ../fish/guestfish-actions.pod:2940
9845 #: ../fish/guestfish-actions.pod:2942
9853 #: ../fish/guestfish-actions.pod:2944 ../src/guestfs-actions.pod:4369
9855 "List all the logical volumes detected. This is the equivalent of the "
9856 "L<lvs(8)> command. The \"full\" version includes all fields."
9860 #: ../fish/guestfish-actions.pod:2947
9865 #: ../fish/guestfish-actions.pod:2949
9873 #: ../fish/guestfish-actions.pod:2951 ../src/guestfs-actions.pod:4384
9874 msgid "This command returns the UUID of the LVM LV C<device>."
9878 #: ../fish/guestfish-actions.pod:2953
9883 #: ../fish/guestfish-actions.pod:2955
9886 " lxattrlist path 'names ...'\n"
9891 #: ../fish/guestfish-actions.pod:2957 ../src/guestfs-actions.pod:4398
9893 "This call allows you to get the extended attributes of multiple files, where "
9894 "all files are in the directory C<path>. C<names> is the list of files from "
9899 #: ../fish/guestfish-actions.pod:2961 ../src/guestfs-actions.pod:4402
9901 "On return you get a flat list of xattr structs which must be interpreted "
9902 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
9903 "C<attrval> in this struct is zero-length to indicate there was an error "
9904 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
9905 "number (the number of following attributes for this file, which could be "
9906 "C<\"0\">). Then after the first xattr struct are the zero or more "
9907 "attributes for the first named file. This repeats for the second and "
9912 #: ../fish/guestfish-actions.pod:2971
9914 "This call is intended for programs that want to efficiently list a directory "
9915 "contents without making many round-trips. See also L</lstatlist> for a "
9916 "similarly efficient call for getting standard stats. Very long directory "
9917 "listings might cause the protocol message size to be exceeded, causing this "
9918 "call to fail. The caller must split up such requests into smaller groups of "
9923 #: ../fish/guestfish-actions.pod:2979
9928 #: ../fish/guestfish-actions.pod:2981
9936 #: ../fish/guestfish-actions.pod:2983 ../src/guestfs-actions.pod:4432
9937 msgid "Create a directory named C<path>."
9941 #: ../fish/guestfish-actions.pod:2985
9946 #: ../fish/guestfish-actions.pod:2987
9949 " mkdir-mode path mode\n"
9954 #: ../fish/guestfish-actions.pod:2989 ../src/guestfs-actions.pod:4445
9956 "This command creates a directory, setting the initial permissions of the "
9957 "directory to C<mode>."
9961 #: ../fish/guestfish-actions.pod:2992 ../src/guestfs-actions.pod:4448
9963 "For common Linux filesystems, the actual mode which is set will be C<mode & "
9964 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
9969 #: ../fish/guestfish-actions.pod:2996
9970 msgid "See also L</mkdir>, L</umask>"
9974 #: ../fish/guestfish-actions.pod:2998
9979 #: ../fish/guestfish-actions.pod:3000
9987 #: ../fish/guestfish-actions.pod:3002 ../src/guestfs-actions.pod:4464
9989 "Create a directory named C<path>, creating any parent directories as "
9990 "necessary. This is like the C<mkdir -p> shell command."
9994 #: ../fish/guestfish-actions.pod:3005
9999 #: ../fish/guestfish-actions.pod:3007
10002 " mkdtemp template\n"
10007 #: ../fish/guestfish-actions.pod:3009 ../src/guestfs-actions.pod:4477
10009 "This command creates a temporary directory. The C<template> parameter "
10010 "should be a full pathname for the temporary directory name with the final "
10011 "six characters being \"XXXXXX\"."
10015 #: ../fish/guestfish-actions.pod:3014 ../src/guestfs-actions.pod:4482
10017 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
10018 "being suitable for Windows filesystems."
10022 #: ../fish/guestfish-actions.pod:3017 ../src/guestfs-actions.pod:4485
10023 msgid "The name of the temporary directory that was created is returned."
10027 #: ../fish/guestfish-actions.pod:3020 ../src/guestfs-actions.pod:4488
10028 msgid "The temporary directory is created with mode 0700 and is owned by root."
10032 #: ../fish/guestfish-actions.pod:3023 ../src/guestfs-actions.pod:4491
10034 "The caller is responsible for deleting the temporary directory and its "
10035 "contents after use."
10039 #: ../fish/guestfish-actions.pod:3026 ../src/guestfs-actions.pod:4494
10040 msgid "See also: L<mkdtemp(3)>"
10044 #: ../fish/guestfish-actions.pod:3028
10049 #: ../fish/guestfish-actions.pod:3030
10052 " mke2fs-J fstype blocksize device journal\n"
10057 #: ../fish/guestfish-actions.pod:3032 ../src/guestfs-actions.pod:4510
10059 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10060 "C<journal>. It is equivalent to the command:"
10064 #: ../fish/guestfish-actions.pod:3036 ../src/guestfs-actions.pod:4514
10067 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10072 #: ../fish/guestfish-actions.pod:3038
10073 msgid "See also L</mke2journal>."
10077 #: ../fish/guestfish-actions.pod:3040
10082 #: ../fish/guestfish-actions.pod:3042
10085 " mke2fs-JL fstype blocksize device label\n"
10090 #: ../fish/guestfish-actions.pod:3044 ../src/guestfs-actions.pod:4531
10092 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10093 "the journal labeled C<label>."
10097 #: ../fish/guestfish-actions.pod:3047
10098 msgid "See also L</mke2journal-L>."
10102 #: ../fish/guestfish-actions.pod:3049
10107 #: ../fish/guestfish-actions.pod:3051
10110 " mke2fs-JU fstype blocksize device uuid\n"
10115 #: ../fish/guestfish-actions.pod:3053 ../src/guestfs-actions.pod:4549
10117 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10118 "the journal with UUID C<uuid>."
10122 #: ../fish/guestfish-actions.pod:3056
10123 msgid "See also L</mke2journal-U>."
10127 #: ../fish/guestfish-actions.pod:3058
10128 msgid "mke2journal"
10132 #: ../fish/guestfish-actions.pod:3060
10135 " mke2journal blocksize device\n"
10140 #: ../fish/guestfish-actions.pod:3062 ../src/guestfs-actions.pod:4565
10142 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10147 #: ../fish/guestfish-actions.pod:3065 ../src/guestfs-actions.pod:4568
10150 " mke2fs -O journal_dev -b blocksize device\n"
10155 #: ../fish/guestfish-actions.pod:3067
10156 msgid "mke2journal-L"
10160 #: ../fish/guestfish-actions.pod:3069
10163 " mke2journal-L blocksize label device\n"
10168 #: ../fish/guestfish-actions.pod:3071 ../src/guestfs-actions.pod:4582
10169 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10173 #: ../fish/guestfish-actions.pod:3073
10174 msgid "mke2journal-U"
10178 #: ../fish/guestfish-actions.pod:3075
10181 " mke2journal-U blocksize uuid device\n"
10186 #: ../fish/guestfish-actions.pod:3077 ../src/guestfs-actions.pod:4596
10187 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10191 #: ../fish/guestfish-actions.pod:3079
10196 #: ../fish/guestfish-actions.pod:3081
10199 " mkfifo mode path\n"
10204 #: ../fish/guestfish-actions.pod:3083
10206 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10207 "is just a convenient wrapper around L</mknod>."
10211 #: ../fish/guestfish-actions.pod:3089
10216 #: ../fish/guestfish-actions.pod:3091
10219 " mkfs fstype device\n"
10224 #: ../fish/guestfish-actions.pod:3093 ../src/guestfs-actions.pod:4626
10226 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10227 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10231 #: ../fish/guestfish-actions.pod:3097
10236 #: ../fish/guestfish-actions.pod:3099
10239 " mkfs-b fstype blocksize device\n"
10244 #: ../fish/guestfish-actions.pod:3101
10246 "This call is similar to L</mkfs>, but it allows you to control the block "
10247 "size of the resulting filesystem. Supported block sizes depend on the "
10248 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10252 #: ../fish/guestfish-actions.pod:3106 ../fish/guestfish-actions.pod:3133 ../src/guestfs-actions.pod:4647 ../src/guestfs-actions.pod:4692
10254 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10259 #: ../fish/guestfish-actions.pod:3109
10261 "This function is deprecated. In new code, use the L</mkfs_opts> call "
10266 #: ../fish/guestfish-actions.pod:3116
10271 #: ../fish/guestfish-actions.pod:3118
10274 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] "
10275 "[sectorsize:..]\n"
10280 #: ../fish/guestfish-actions.pod:3120 ../src/guestfs-actions.pod:4679
10282 "This function creates a filesystem on C<device>. The filesystem type is "
10283 "C<fstype>, for example C<ext3>."
10287 #: ../fish/guestfish-actions.pod:3127 ../src/guestfs-actions.pod:4686
10288 msgid "C<blocksize>"
10292 #: ../fish/guestfish-actions.pod:3129 ../src/guestfs-actions.pod:4688
10294 "The filesystem block size. Supported block sizes depend on the filesystem "
10295 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
10300 #: ../fish/guestfish-actions.pod:3136 ../src/guestfs-actions.pod:4695
10301 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
10305 #: ../fish/guestfish-actions.pod:3138 ../src/guestfs-actions.pod:4697
10306 msgid "C<features>"
10310 #: ../fish/guestfish-actions.pod:3140 ../src/guestfs-actions.pod:4699
10311 msgid "This passes the I<-O> parameter to the external mkfs program."
10315 #: ../fish/guestfish-actions.pod:3142 ../src/guestfs-actions.pod:4701
10317 "For certain filesystem types, this allows extra filesystem features to be "
10318 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
10322 #: ../fish/guestfish-actions.pod:3146 ../src/guestfs-actions.pod:4705
10324 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
10329 #: ../fish/guestfish-actions.pod:3149 ../src/guestfs-actions.pod:4708
10334 #: ../fish/guestfish-actions.pod:3151 ../src/guestfs-actions.pod:4710
10336 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
10337 "sets the inode size (only for ext2/3/4 filesystems at present)."
10341 #: ../fish/guestfish-actions.pod:3154 ../src/guestfs-actions.pod:4713
10342 msgid "C<sectorsize>"
10346 #: ../fish/guestfish-actions.pod:3156 ../src/guestfs-actions.pod:4715
10348 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
10349 "sets sector size for ufs filesystem."
10353 #: ../fish/guestfish-actions.pod:3163
10354 msgid "mkmountpoint"
10358 #: ../fish/guestfish-actions.pod:3165
10361 " mkmountpoint exemptpath\n"
10366 #: ../fish/guestfish-actions.pod:3167
10368 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
10369 "to create extra mountpoints before mounting the first filesystem."
10373 #: ../fish/guestfish-actions.pod:3171 ../src/guestfs-actions.pod:4758
10375 "These calls are I<only> necessary in some very limited circumstances, mainly "
10376 "the case where you want to mount a mix of unrelated and/or read-only "
10377 "filesystems together."
10381 #: ../fish/guestfish-actions.pod:3175 ../src/guestfs-actions.pod:4762
10383 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10384 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10385 "inside that. You can unpack this as follows in guestfish:"
10389 #: ../fish/guestfish-actions.pod:3180 ../src/guestfs-actions.pod:4767
10392 " add-ro Fedora-11-i686-Live.iso\n"
10394 " mkmountpoint /cd\n"
10395 " mkmountpoint /sqsh\n"
10396 " mkmountpoint /ext3fs\n"
10397 " mount /dev/sda /cd\n"
10398 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10399 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10404 #: ../fish/guestfish-actions.pod:3189 ../src/guestfs-actions.pod:4776
10405 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10409 #: ../fish/guestfish-actions.pod:3191
10411 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
10412 "unexpected errors if you try to mix these calls. It is safest to manually "
10413 "unmount filesystems and remove mountpoints after use."
10417 #: ../fish/guestfish-actions.pod:3195
10419 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
10420 "for this to work for manual mountpoints, you must ensure that the innermost "
10421 "mountpoints have the longest pathnames, as in the example code above."
10425 #: ../fish/guestfish-actions.pod:3200 ../src/guestfs-actions.pod:4787
10426 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10430 #: ../fish/guestfish-actions.pod:3202
10432 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
10433 "L</umount-all> to be called when the handle is closed which can also trigger "
10438 #: ../fish/guestfish-actions.pod:3206
10443 #: ../fish/guestfish-actions.pod:3208
10446 " mknod mode devmajor devminor path\n"
10451 #: ../fish/guestfish-actions.pod:3210 ../src/guestfs-actions.pod:4806
10453 "This call creates block or character special devices, or named pipes "
10458 #: ../fish/guestfish-actions.pod:3213 ../src/guestfs-actions.pod:4809
10460 "The C<mode> parameter should be the mode, using the standard constants. "
10461 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10462 "used when creating block and character special devices."
10466 #: ../fish/guestfish-actions.pod:3218
10468 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10469 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10470 "regular file). These constants are available in the standard Linux header "
10471 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
10472 "wrappers around this command which bitwise OR in the appropriate constant "
10477 #: ../fish/guestfish-actions.pod:3228
10482 #: ../fish/guestfish-actions.pod:3230
10485 " mknod-b mode devmajor devminor path\n"
10490 #: ../fish/guestfish-actions.pod:3232
10492 "This call creates a block device node called C<path> with mode C<mode> and "
10493 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10494 "wrapper around L</mknod>."
10498 #: ../fish/guestfish-actions.pod:3238
10503 #: ../fish/guestfish-actions.pod:3240
10506 " mknod-c mode devmajor devminor path\n"
10511 #: ../fish/guestfish-actions.pod:3242
10513 "This call creates a char device node called C<path> with mode C<mode> and "
10514 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10515 "wrapper around L</mknod>."
10519 #: ../fish/guestfish-actions.pod:3248
10524 #: ../fish/guestfish-actions.pod:3250
10532 #: ../fish/guestfish-actions.pod:3252 ../src/guestfs-actions.pod:4872
10533 msgid "Create a swap partition on C<device>."
10537 #: ../fish/guestfish-actions.pod:3254
10542 #: ../fish/guestfish-actions.pod:3256
10545 " mkswap-L label device\n"
10550 #: ../fish/guestfish-actions.pod:3258 ../src/guestfs-actions.pod:4885
10551 msgid "Create a swap partition on C<device> with label C<label>."
10555 #: ../fish/guestfish-actions.pod:3260 ../src/guestfs-actions.pod:4887
10557 "Note that you cannot attach a swap label to a block device "
10558 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
10559 "the kernel or swap tools."
10563 #: ../fish/guestfish-actions.pod:3264
10568 #: ../fish/guestfish-actions.pod:3266
10571 " mkswap-U uuid device\n"
10576 #: ../fish/guestfish-actions.pod:3268 ../src/guestfs-actions.pod:4902
10577 msgid "Create a swap partition on C<device> with UUID C<uuid>."
10581 #: ../fish/guestfish-actions.pod:3270
10582 msgid "mkswap-file"
10586 #: ../fish/guestfish-actions.pod:3272
10589 " mkswap-file path\n"
10594 #: ../fish/guestfish-actions.pod:3274 ../src/guestfs-actions.pod:4914
10595 msgid "Create a swap file."
10599 #: ../fish/guestfish-actions.pod:3276
10601 "This command just writes a swap file signature to an existing file. To "
10602 "create the file itself, use something like L</fallocate>."
10606 #: ../fish/guestfish-actions.pod:3279
10611 #: ../fish/guestfish-actions.pod:3281
10614 " modprobe modulename\n"
10619 #: ../fish/guestfish-actions.pod:3283 ../src/guestfs-actions.pod:4929
10620 msgid "This loads a kernel module in the appliance."
10624 #: ../fish/guestfish-actions.pod:3285 ../src/guestfs-actions.pod:4931
10626 "The kernel module must have been whitelisted when libguestfs was built (see "
10627 "C<appliance/kmod.whitelist.in> in the source)."
10631 #: ../fish/guestfish-actions.pod:3288
10636 #: ../fish/guestfish-actions.pod:3290
10639 " mount device mountpoint\n"
10644 #: ../fish/guestfish-actions.pod:3292 ../src/guestfs-actions.pod:4945
10646 "Mount a guest disk at a position in the filesystem. Block devices are named "
10647 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
10648 "those block devices contain partitions, they will have the usual names "
10649 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
10653 #: ../fish/guestfish-actions.pod:3298 ../src/guestfs-actions.pod:4951
10655 "The rules are the same as for L<mount(2)>: A filesystem must first be "
10656 "mounted on C</> before others can be mounted. Other filesystems can only be "
10657 "mounted on directories which already exist."
10661 #: ../fish/guestfish-actions.pod:3303 ../src/guestfs-actions.pod:4956
10663 "The mounted filesystem is writable, if we have sufficient permissions on the "
10664 "underlying device."
10668 #: ../fish/guestfish-actions.pod:3306
10670 "B<Important note:> When you use this call, the filesystem options C<sync> "
10671 "and C<noatime> are set implicitly. This was originally done because we "
10672 "thought it would improve reliability, but it turns out that I<-o sync> has a "
10673 "very large negative performance impact and negligible effect on "
10674 "reliability. Therefore we recommend that you avoid using L</mount> in any "
10675 "code that needs performance, and instead use L</mount-options> (use an empty "
10676 "string for the first parameter if you don't want any options)."
10680 #: ../fish/guestfish-actions.pod:3316
10682 "This function is deprecated. In new code, use the L</mount_options> call "
10687 #: ../fish/guestfish-actions.pod:3323
10692 #: ../fish/guestfish-actions.pod:3325
10695 " mount-9p mounttag mountpoint [options:..]\n"
10700 #: ../fish/guestfish-actions.pod:3327 ../src/guestfs-actions.pod:4995
10702 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
10707 #: ../fish/guestfish-actions.pod:3330 ../src/guestfs-actions.pod:4998
10709 "If required, C<trans=virtio> will be automatically added to the options. "
10710 "Any other options required can be passed in the optional C<options> "
10715 #: ../fish/guestfish-actions.pod:3336
10720 #: ../fish/guestfish-actions.pod:3338
10723 " mount-loop file mountpoint\n"
10728 #: ../fish/guestfish-actions.pod:3340 ../src/guestfs-actions.pod:5037
10730 "This command lets you mount C<file> (a filesystem image in a file) on a "
10731 "mount point. It is entirely equivalent to the command C<mount -o loop file "
10736 #: ../fish/guestfish-actions.pod:3344
10737 msgid "mount-options"
10741 #: ../fish/guestfish-actions.pod:3346
10744 " mount-options options device mountpoint\n"
10749 #: ../fish/guestfish-actions.pod:3348
10751 "This is the same as the L</mount> command, but it allows you to set the "
10752 "mount options as for the L<mount(8)> I<-o> flag."
10756 #: ../fish/guestfish-actions.pod:3352 ../src/guestfs-actions.pod:5057
10758 "If the C<options> parameter is an empty string, then no options are passed "
10759 "(all options default to whatever the filesystem uses)."
10763 #: ../fish/guestfish-actions.pod:3356
10768 #: ../fish/guestfish-actions.pod:3358
10771 " mount-ro device mountpoint\n"
10776 #: ../fish/guestfish-actions.pod:3360
10778 "This is the same as the L</mount> command, but it mounts the filesystem with "
10779 "the read-only (I<-o ro>) flag."
10783 #: ../fish/guestfish-actions.pod:3363
10788 #: ../fish/guestfish-actions.pod:3365
10791 " mount-vfs options vfstype device mountpoint\n"
10796 #: ../fish/guestfish-actions.pod:3367
10798 "This is the same as the L</mount> command, but it allows you to set both the "
10799 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
10803 #: ../fish/guestfish-actions.pod:3371
10804 msgid "mountpoints"
10808 #: ../fish/guestfish-actions.pod:3373
10816 #: ../fish/guestfish-actions.pod:3375
10818 "This call is similar to L</mounts>. That call returns a list of devices. "
10819 "This one returns a hash table (map) of device name to directory where the "
10820 "device is mounted."
10824 #: ../fish/guestfish-actions.pod:3379
10829 #: ../fish/guestfish-actions.pod:3381
10837 #: ../fish/guestfish-actions.pod:3383 ../src/guestfs-actions.pod:5118
10839 "This returns the list of currently mounted filesystems. It returns the list "
10840 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
10844 #: ../fish/guestfish-actions.pod:3386 ../src/guestfs-actions.pod:5121
10845 msgid "Some internal mounts are not shown."
10849 #: ../fish/guestfish-actions.pod:3388
10850 msgid "See also: L</mountpoints>"
10854 #: ../fish/guestfish-actions.pod:3390
10859 #: ../fish/guestfish-actions.pod:3392
10867 #: ../fish/guestfish-actions.pod:3394 ../src/guestfs-actions.pod:5138
10869 "This moves a file from C<src> to C<dest> where C<dest> is either a "
10870 "destination filename or destination directory."
10874 #: ../fish/guestfish-actions.pod:3397
10875 msgid "ntfs-3g-probe"
10879 #: ../fish/guestfish-actions.pod:3399
10882 " ntfs-3g-probe true|false device\n"
10887 #: ../fish/guestfish-actions.pod:3401 ../src/guestfs-actions.pod:5152
10889 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
10890 "C<device> for mountability. (Not all NTFS volumes can be mounted "
10891 "read-write, and some cannot be mounted at all)."
10895 #: ../fish/guestfish-actions.pod:3405 ../src/guestfs-actions.pod:5156
10897 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
10898 "can be mounted read-write. Set it to false if you want to test if the "
10899 "volume can be mounted read-only."
10903 #: ../fish/guestfish-actions.pod:3409 ../src/guestfs-actions.pod:5160
10905 "The return value is an integer which C<0> if the operation would succeed, or "
10906 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
10910 #: ../fish/guestfish-actions.pod:3413
10915 #: ../fish/guestfish-actions.pod:3415
10918 " ntfsresize device\n"
10923 #: ../fish/guestfish-actions.pod:3417 ../fish/guestfish-actions.pod:3441 ../src/guestfs-actions.pod:5174 ../src/guestfs-actions.pod:5213
10925 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
10926 "size of the underlying device."
10930 #: ../fish/guestfish-actions.pod:3420 ../src/guestfs-actions.pod:5177
10932 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
10933 "consistency check (for safety). You have to boot into Windows to perform "
10934 "this check and clear this condition. Furthermore, ntfsresize refuses to "
10935 "resize filesystems which have been marked in this way. So in effect it is "
10936 "not possible to call ntfsresize multiple times on a single filesystem "
10937 "without booting into Windows between each resize."
10941 #: ../fish/guestfish-actions.pod:3428 ../fish/guestfish-actions.pod:3467 ../src/guestfs-actions.pod:5185 ../src/guestfs-actions.pod:5239
10942 msgid "See also L<ntfsresize(8)>."
10946 #: ../fish/guestfish-actions.pod:3430 ../fish/guestfish-actions.pod:3478
10948 "This function is deprecated. In new code, use the L</ntfsresize_opts> call "
10953 #: ../fish/guestfish-actions.pod:3437
10954 msgid "ntfsresize-opts"
10958 #: ../fish/guestfish-actions.pod:3439
10961 " ntfsresize-opts device [size:..] [force:..]\n"
10966 #: ../fish/guestfish-actions.pod:3450 ../src/guestfs-actions.pod:5222
10968 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
10969 "resized to fit the container (eg. partition)."
10973 #: ../fish/guestfish-actions.pod:3453 ../src/guestfs-actions.pod:5225
10978 #: ../fish/guestfish-actions.pod:3455 ../src/guestfs-actions.pod:5227
10980 "If this option is true, then force the resize of the filesystem even if the "
10981 "filesystem is marked as requiring a consistency check."
10985 #: ../fish/guestfish-actions.pod:3458
10987 "After the resize operation, the filesystem is always marked as requiring a "
10988 "consistency check (for safety). You have to boot into Windows to perform "
10989 "this check and clear this condition. If you I<don't> set the C<force> "
10990 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
10991 "a single filesystem without booting into Windows between each resize."
10995 #: ../fish/guestfish-actions.pod:3471
10996 msgid "ntfsresize-size"
11000 #: ../fish/guestfish-actions.pod:3473
11003 " ntfsresize-size device size\n"
11008 #: ../fish/guestfish-actions.pod:3475
11010 "This command is the same as L</ntfsresize> except that it allows you to "
11011 "specify the new size (in bytes) explicitly."
11015 #: ../fish/guestfish-actions.pod:3485
11020 #: ../fish/guestfish-actions.pod:3487
11023 " part-add device prlogex startsect endsect\n"
11028 #: ../fish/guestfish-actions.pod:3489
11030 "This command adds a partition to C<device>. If there is no partition table "
11031 "on the device, call L</part-init> first."
11035 #: ../fish/guestfish-actions.pod:3492 ../src/guestfs-actions.pod:5300
11037 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11038 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11039 "C<logical>) and C<e> (or C<extended>) partition types."
11043 #: ../fish/guestfish-actions.pod:3497 ../src/guestfs-actions.pod:5305
11045 "C<startsect> and C<endsect> are the start and end of the partition in "
11046 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11047 "from the end of the disk (C<-1> is the last sector)."
11051 #: ../fish/guestfish-actions.pod:3501
11053 "Creating a partition which covers the whole disk is not so easy. Use "
11054 "L</part-disk> to do that."
11058 #: ../fish/guestfish-actions.pod:3504
11063 #: ../fish/guestfish-actions.pod:3506
11066 " part-del device partnum\n"
11071 #: ../fish/guestfish-actions.pod:3508 ../src/guestfs-actions.pod:5323
11072 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11076 #: ../fish/guestfish-actions.pod:3510 ../src/guestfs-actions.pod:5325
11078 "Note that in the case of MBR partitioning, deleting an extended partition "
11079 "also deletes any logical partitions it contains."
11083 #: ../fish/guestfish-actions.pod:3514
11088 #: ../fish/guestfish-actions.pod:3516
11091 " part-disk device parttype\n"
11096 #: ../fish/guestfish-actions.pod:3518
11098 "This command is simply a combination of L</part-init> followed by "
11099 "L</part-add> to create a single primary partition covering the whole disk."
11103 #: ../fish/guestfish-actions.pod:3522
11105 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11106 "possible values are described in L</part-init>."
11110 #: ../fish/guestfish-actions.pod:3528
11111 msgid "part-get-bootable"
11115 #: ../fish/guestfish-actions.pod:3530
11118 " part-get-bootable device partnum\n"
11123 #: ../fish/guestfish-actions.pod:3532 ../src/guestfs-actions.pod:5361
11125 "This command returns true if the partition C<partnum> on C<device> has the "
11126 "bootable flag set."
11130 #: ../fish/guestfish-actions.pod:3535
11131 msgid "See also L</part-set-bootable>."
11135 #: ../fish/guestfish-actions.pod:3537
11136 msgid "part-get-mbr-id"
11140 #: ../fish/guestfish-actions.pod:3539
11143 " part-get-mbr-id device partnum\n"
11148 #: ../fish/guestfish-actions.pod:3541 ../src/guestfs-actions.pod:5377
11150 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11151 "partition C<partnum>."
11155 #: ../fish/guestfish-actions.pod:3544 ../fish/guestfish-actions.pod:3688
11157 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11158 "undefined results for other partition table types (see "
11159 "L</part-get-parttype>)."
11163 #: ../fish/guestfish-actions.pod:3548
11164 msgid "part-get-parttype"
11168 #: ../fish/guestfish-actions.pod:3550
11171 " part-get-parttype device\n"
11176 #: ../fish/guestfish-actions.pod:3552 ../src/guestfs-actions.pod:5394
11178 "This command examines the partition table on C<device> and returns the "
11179 "partition table type (format) being used."
11183 #: ../fish/guestfish-actions.pod:3555
11185 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11186 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11187 "possible, although unusual. See L</part-init> for a full list."
11191 #: ../fish/guestfish-actions.pod:3560
11196 #: ../fish/guestfish-actions.pod:3562
11199 " part-init device parttype\n"
11204 #: ../fish/guestfish-actions.pod:3564 ../src/guestfs-actions.pod:5414
11206 "This creates an empty partition table on C<device> of one of the partition "
11207 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11208 "(for large disks)."
11212 #: ../fish/guestfish-actions.pod:3568
11214 "Initially there are no partitions. Following this, you should call "
11215 "L</part-add> for each partition required."
11219 #: ../fish/guestfish-actions.pod:3571 ../src/guestfs-actions.pod:5421
11220 msgid "Possible values for C<parttype> are:"
11224 #: ../fish/guestfish-actions.pod:3575 ../src/guestfs-actions.pod:5425
11229 #: ../fish/guestfish-actions.pod:3577 ../src/guestfs-actions.pod:5427
11234 #: ../fish/guestfish-actions.pod:3579 ../src/guestfs-actions.pod:5429
11235 msgid "Intel EFI / GPT partition table."
11239 #: ../fish/guestfish-actions.pod:3581 ../src/guestfs-actions.pod:5431
11241 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11242 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11243 "the C<mbr> format."
11247 #: ../fish/guestfish-actions.pod:3585 ../src/guestfs-actions.pod:5435
11252 #: ../fish/guestfish-actions.pod:3587 ../src/guestfs-actions.pod:5437
11257 #: ../fish/guestfish-actions.pod:3589 ../src/guestfs-actions.pod:5439
11259 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11260 "Windows. This partition type will B<only> work for device sizes up to 2 "
11261 "TB. For large disks we recommend using C<gpt>."
11265 #: ../fish/guestfish-actions.pod:3596 ../src/guestfs-actions.pod:5446
11266 msgid "Other partition table types that may work but are not supported include:"
11270 #: ../fish/guestfish-actions.pod:3601 ../src/guestfs-actions.pod:5451
11275 #: ../fish/guestfish-actions.pod:3603 ../src/guestfs-actions.pod:5453
11276 msgid "AIX disk labels."
11280 #: ../fish/guestfish-actions.pod:3605 ../src/guestfs-actions.pod:5455
11285 #: ../fish/guestfish-actions.pod:3607 ../src/guestfs-actions.pod:5457
11290 #: ../fish/guestfish-actions.pod:3609 ../src/guestfs-actions.pod:5459
11291 msgid "Amiga \"Rigid Disk Block\" format."
11295 #: ../fish/guestfish-actions.pod:3611 ../src/guestfs-actions.pod:5461
11300 #: ../fish/guestfish-actions.pod:3613 ../src/guestfs-actions.pod:5463
11301 msgid "BSD disk labels."
11305 #: ../fish/guestfish-actions.pod:3615 ../src/guestfs-actions.pod:5465
11310 #: ../fish/guestfish-actions.pod:3617 ../src/guestfs-actions.pod:5467
11311 msgid "DASD, used on IBM mainframes."
11315 #: ../fish/guestfish-actions.pod:3619 ../src/guestfs-actions.pod:5469
11320 #: ../fish/guestfish-actions.pod:3621 ../src/guestfs-actions.pod:5471
11321 msgid "MIPS/SGI volumes."
11325 #: ../fish/guestfish-actions.pod:3623 ../src/guestfs-actions.pod:5473
11330 #: ../fish/guestfish-actions.pod:3625 ../src/guestfs-actions.pod:5475
11331 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11335 #: ../fish/guestfish-actions.pod:3627 ../src/guestfs-actions.pod:5477
11340 #: ../fish/guestfish-actions.pod:3629 ../src/guestfs-actions.pod:5479
11341 msgid "NEC PC-98 format, common in Japan apparently."
11345 #: ../fish/guestfish-actions.pod:3631 ../src/guestfs-actions.pod:5481
11350 #: ../fish/guestfish-actions.pod:3633 ../src/guestfs-actions.pod:5483
11351 msgid "Sun disk labels."
11355 #: ../fish/guestfish-actions.pod:3637
11360 #: ../fish/guestfish-actions.pod:3639
11363 " part-list device\n"
11368 #: ../fish/guestfish-actions.pod:3641 ../src/guestfs-actions.pod:5497
11370 "This command parses the partition table on C<device> and returns the list of "
11371 "partitions found."
11375 #: ../fish/guestfish-actions.pod:3644 ../src/guestfs-actions.pod:5500
11376 msgid "The fields in the returned structure are:"
11380 #: ../fish/guestfish-actions.pod:3648 ../src/guestfs-actions.pod:5504
11381 msgid "B<part_num>"
11385 #: ../fish/guestfish-actions.pod:3650 ../src/guestfs-actions.pod:5506
11386 msgid "Partition number, counting from 1."
11390 #: ../fish/guestfish-actions.pod:3652 ../src/guestfs-actions.pod:5508
11391 msgid "B<part_start>"
11395 #: ../fish/guestfish-actions.pod:3654
11397 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11398 "the device's sector size, see L</blockdev-getss>."
11402 #: ../fish/guestfish-actions.pod:3657 ../src/guestfs-actions.pod:5513
11403 msgid "B<part_end>"
11407 #: ../fish/guestfish-actions.pod:3659 ../src/guestfs-actions.pod:5515
11408 msgid "End of the partition in bytes."
11412 #: ../fish/guestfish-actions.pod:3661 ../src/guestfs-actions.pod:5517
11413 msgid "B<part_size>"
11417 #: ../fish/guestfish-actions.pod:3663 ../src/guestfs-actions.pod:5519
11418 msgid "Size of the partition in bytes."
11422 #: ../fish/guestfish-actions.pod:3667
11423 msgid "part-set-bootable"
11427 #: ../fish/guestfish-actions.pod:3669
11430 " part-set-bootable device partnum true|false\n"
11435 #: ../fish/guestfish-actions.pod:3671 ../src/guestfs-actions.pod:5537
11437 "This sets the bootable flag on partition numbered C<partnum> on device "
11438 "C<device>. Note that partitions are numbered from 1."
11442 #: ../fish/guestfish-actions.pod:3674 ../src/guestfs-actions.pod:5540
11444 "The bootable flag is used by some operating systems (notably Windows) to "
11445 "determine which partition to boot from. It is by no means universally "
11450 #: ../fish/guestfish-actions.pod:3678
11451 msgid "part-set-mbr-id"
11455 #: ../fish/guestfish-actions.pod:3680
11458 " part-set-mbr-id device partnum idbyte\n"
11463 #: ../fish/guestfish-actions.pod:3682 ../src/guestfs-actions.pod:5556
11465 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11466 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11467 "documentation are in fact hexadecimal numbers, but usually documented "
11468 "without any leading \"0x\" which might be confusing."
11472 #: ../fish/guestfish-actions.pod:3692
11473 msgid "part-set-name"
11477 #: ../fish/guestfish-actions.pod:3694
11480 " part-set-name device partnum name\n"
11485 #: ../fish/guestfish-actions.pod:3696 ../src/guestfs-actions.pod:5578
11487 "This sets the partition name on partition numbered C<partnum> on device "
11488 "C<device>. Note that partitions are numbered from 1."
11492 #: ../fish/guestfish-actions.pod:3699 ../src/guestfs-actions.pod:5581
11494 "The partition name can only be set on certain types of partition table. "
11495 "This works on C<gpt> but not on C<mbr> partitions."
11499 #: ../fish/guestfish-actions.pod:3702
11500 msgid "part-to-dev"
11504 #: ../fish/guestfish-actions.pod:3704
11507 " part-to-dev partition\n"
11512 #: ../fish/guestfish-actions.pod:3706 ../src/guestfs-actions.pod:5594
11514 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
11515 "partition number, returning the device name (eg. \"/dev/sdb\")."
11519 #: ../fish/guestfish-actions.pod:3710
11521 "The named partition must exist, for example as a string returned from "
11522 "L</list-partitions>."
11526 #: ../fish/guestfish-actions.pod:3713
11527 msgid "ping-daemon"
11531 #: ../fish/guestfish-actions.pod:3715
11539 #: ../fish/guestfish-actions.pod:3717 ../src/guestfs-actions.pod:5611
11541 "This is a test probe into the guestfs daemon running inside the qemu "
11542 "subprocess. Calling this function checks that the daemon responds to the "
11543 "ping message, without affecting the daemon or attached block device(s) in "
11548 #: ../fish/guestfish-actions.pod:3722
11553 #: ../fish/guestfish-actions.pod:3724
11556 " pread path count offset\n"
11561 #: ../fish/guestfish-actions.pod:3726 ../src/guestfs-actions.pod:5629
11563 "This command lets you read part of a file. It reads C<count> bytes of the "
11564 "file, starting at C<offset>, from file C<path>."
11568 #: ../fish/guestfish-actions.pod:3729 ../fish/guestfish-actions.pod:3744 ../src/guestfs-actions.pod:5632 ../src/guestfs-actions.pod:5658
11570 "This may read fewer bytes than requested. For further details see the "
11571 "L<pread(2)> system call."
11575 #: ../fish/guestfish-actions.pod:3732
11576 msgid "See also L</pwrite>, L</pread-device>."
11580 #: ../fish/guestfish-actions.pod:3737
11581 msgid "pread-device"
11585 #: ../fish/guestfish-actions.pod:3739
11588 " pread-device device count offset\n"
11593 #: ../fish/guestfish-actions.pod:3741 ../src/guestfs-actions.pod:5655
11595 "This command lets you read part of a file. It reads C<count> bytes of "
11596 "C<device>, starting at C<offset>."
11600 #: ../fish/guestfish-actions.pod:3747
11601 msgid "See also L</pread>."
11605 #: ../fish/guestfish-actions.pod:3752
11610 #: ../fish/guestfish-actions.pod:3754
11613 " pvcreate device\n"
11618 #: ../fish/guestfish-actions.pod:3756 ../src/guestfs-actions.pod:5678
11620 "This creates an LVM physical volume on the named C<device>, where C<device> "
11621 "should usually be a partition name such as C</dev/sda1>."
11625 #: ../fish/guestfish-actions.pod:3760
11630 #: ../fish/guestfish-actions.pod:3762
11633 " pvremove device\n"
11638 #: ../fish/guestfish-actions.pod:3764 ../src/guestfs-actions.pod:5692
11640 "This wipes a physical volume C<device> so that LVM will no longer recognise "
11645 #: ../fish/guestfish-actions.pod:3767 ../src/guestfs-actions.pod:5695
11647 "The implementation uses the C<pvremove> command which refuses to wipe "
11648 "physical volumes that contain any volume groups, so you have to remove those "
11653 #: ../fish/guestfish-actions.pod:3771
11658 #: ../fish/guestfish-actions.pod:3773
11661 " pvresize device\n"
11666 #: ../fish/guestfish-actions.pod:3775 ../src/guestfs-actions.pod:5709
11668 "This resizes (expands or shrinks) an existing LVM physical volume to match "
11669 "the new size of the underlying device."
11673 #: ../fish/guestfish-actions.pod:3778
11674 msgid "pvresize-size"
11678 #: ../fish/guestfish-actions.pod:3780
11681 " pvresize-size device size\n"
11686 #: ../fish/guestfish-actions.pod:3782
11688 "This command is the same as L</pvresize> except that it allows you to "
11689 "specify the new size (in bytes) explicitly."
11693 #: ../fish/guestfish-actions.pod:3785
11698 #: ../fish/guestfish-actions.pod:3787
11706 #: ../fish/guestfish-actions.pod:3789 ../src/guestfs-actions.pod:5735
11708 "List all the physical volumes detected. This is the equivalent of the "
11709 "L<pvs(8)> command."
11713 #: ../fish/guestfish-actions.pod:3792 ../src/guestfs-actions.pod:5738
11715 "This returns a list of just the device names that contain PVs "
11716 "(eg. C</dev/sda2>)."
11720 #: ../fish/guestfish-actions.pod:3795
11721 msgid "See also L</pvs-full>."
11725 #: ../fish/guestfish-actions.pod:3797
11730 #: ../fish/guestfish-actions.pod:3799
11738 #: ../fish/guestfish-actions.pod:3801 ../src/guestfs-actions.pod:5754
11740 "List all the physical volumes detected. This is the equivalent of the "
11741 "L<pvs(8)> command. The \"full\" version includes all fields."
11745 #: ../fish/guestfish-actions.pod:3804
11750 #: ../fish/guestfish-actions.pod:3806
11758 #: ../fish/guestfish-actions.pod:3808 ../src/guestfs-actions.pod:5769
11759 msgid "This command returns the UUID of the LVM PV C<device>."
11763 #: ../fish/guestfish-actions.pod:3810
11768 #: ../fish/guestfish-actions.pod:3812
11771 " pwrite path content offset\n"
11776 #: ../fish/guestfish-actions.pod:3814 ../src/guestfs-actions.pod:5785
11778 "This command writes to part of a file. It writes the data buffer C<content> "
11779 "to the file C<path> starting at offset C<offset>."
11783 #: ../fish/guestfish-actions.pod:3817 ../src/guestfs-actions.pod:5788
11785 "This command implements the L<pwrite(2)> system call, and like that system "
11786 "call it may not write the full data requested. The return value is the "
11787 "number of bytes that were actually written to the file. This could even be "
11788 "0, although short writes are unlikely for regular files in ordinary "
11793 #: ../fish/guestfish-actions.pod:3823
11794 msgid "See also L</pread>, L</pwrite-device>."
11798 #: ../fish/guestfish-actions.pod:3828
11799 msgid "pwrite-device"
11803 #: ../fish/guestfish-actions.pod:3830
11806 " pwrite-device device content offset\n"
11811 #: ../fish/guestfish-actions.pod:3832 ../src/guestfs-actions.pod:5812
11813 "This command writes to part of a device. It writes the data buffer "
11814 "C<content> to C<device> starting at offset C<offset>."
11818 #: ../fish/guestfish-actions.pod:3835 ../src/guestfs-actions.pod:5815
11820 "This command implements the L<pwrite(2)> system call, and like that system "
11821 "call it may not write the full data requested (although short writes to disk "
11822 "devices and partitions are probably impossible with standard Linux kernels)."
11826 #: ../fish/guestfish-actions.pod:3840
11827 msgid "See also L</pwrite>."
11831 #: ../fish/guestfish-actions.pod:3845
11836 #: ../fish/guestfish-actions.pod:3847
11839 " read-file path\n"
11844 #: ../fish/guestfish-actions.pod:3849 ../src/guestfs-actions.pod:5836
11845 msgid "This calls returns the contents of the file C<path> as a buffer."
11849 #: ../fish/guestfish-actions.pod:3852
11851 "Unlike L</cat>, this function can correctly handle files that contain "
11852 "embedded ASCII NUL characters. However unlike L</download>, this function "
11853 "is limited in the total size of file that can be handled."
11857 #: ../fish/guestfish-actions.pod:3860
11862 #: ../fish/guestfish-actions.pod:3862
11865 " read-lines path\n"
11870 #: ../fish/guestfish-actions.pod:3866 ../src/guestfs-actions.pod:5861
11872 "The file contents are returned as a list of lines. Trailing C<LF> and "
11873 "C<CRLF> character sequences are I<not> returned."
11877 #: ../fish/guestfish-actions.pod:3869
11879 "Note that this function cannot correctly handle binary files (specifically, "
11880 "files containing C<\\0> character which is treated as end of line). For "
11881 "those you need to use the L</read-file> function which has a more complex "
11886 #: ../fish/guestfish-actions.pod:3874
11891 #: ../fish/guestfish-actions.pod:3876
11899 #: ../fish/guestfish-actions.pod:3878 ../src/guestfs-actions.pod:5881
11900 msgid "This returns the list of directory entries in directory C<dir>."
11904 #: ../fish/guestfish-actions.pod:3880 ../src/guestfs-actions.pod:5883
11906 "All entries in the directory are returned, including C<.> and C<..>. The "
11907 "entries are I<not> sorted, but returned in the same order as the underlying "
11912 #: ../fish/guestfish-actions.pod:3884 ../src/guestfs-actions.pod:5887
11914 "Also this call returns basic file type information about each file. The "
11915 "C<ftyp> field will contain one of the following characters:"
11919 #: ../fish/guestfish-actions.pod:3889 ../src/guestfs-actions.pod:5892
11924 #: ../fish/guestfish-actions.pod:3891 ../src/guestfs-actions.pod:5894
11925 msgid "Block special"
11929 #: ../fish/guestfish-actions.pod:3893 ../src/guestfs-actions.pod:5896
11934 #: ../fish/guestfish-actions.pod:3895 ../src/guestfs-actions.pod:5898
11935 msgid "Char special"
11939 #: ../fish/guestfish-actions.pod:3897 ../src/guestfs-actions.pod:5900
11944 #: ../fish/guestfish-actions.pod:3899 ../src/guestfs-actions.pod:5902
11949 #: ../fish/guestfish-actions.pod:3901 ../src/guestfs-actions.pod:5904
11954 #: ../fish/guestfish-actions.pod:3903 ../src/guestfs-actions.pod:5906
11955 msgid "FIFO (named pipe)"
11959 #: ../fish/guestfish-actions.pod:3905 ../src/guestfs-actions.pod:5908
11964 #: ../fish/guestfish-actions.pod:3907 ../src/guestfs-actions.pod:5910
11965 msgid "Symbolic link"
11969 #: ../fish/guestfish-actions.pod:3909 ../src/guestfs-actions.pod:5912
11974 #: ../fish/guestfish-actions.pod:3911 ../src/guestfs-actions.pod:5914
11975 msgid "Regular file"
11979 #: ../fish/guestfish-actions.pod:3913 ../src/guestfs-actions.pod:5916
11984 #: ../fish/guestfish-actions.pod:3915 ../src/guestfs-actions.pod:5918
11989 #: ../fish/guestfish-actions.pod:3917 ../src/guestfs-actions.pod:5920
11994 #: ../fish/guestfish-actions.pod:3919 ../src/guestfs-actions.pod:5922
11995 msgid "Unknown file type"
11999 #: ../fish/guestfish-actions.pod:3921 ../src/guestfs-actions.pod:5924
12004 #: ../fish/guestfish-actions.pod:3923 ../src/guestfs-actions.pod:5926
12005 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
12009 #: ../fish/guestfish-actions.pod:3928
12011 "This function is primarily intended for use by programs. To get a simple "
12012 "list of names, use L</ls>. To get a printable directory for human "
12013 "consumption, use L</ll>."
12017 #: ../fish/guestfish-actions.pod:3932
12022 #: ../fish/guestfish-actions.pod:3934
12030 #: ../fish/guestfish-actions.pod:3936 ../src/guestfs-actions.pod:5947
12031 msgid "This command reads the target of a symbolic link."
12035 #: ../fish/guestfish-actions.pod:3938
12036 msgid "readlinklist"
12040 #: ../fish/guestfish-actions.pod:3940
12043 " readlinklist path 'names ...'\n"
12048 #: ../fish/guestfish-actions.pod:3942 ../src/guestfs-actions.pod:5961
12050 "This call allows you to do a C<readlink> operation on multiple files, where "
12051 "all files are in the directory C<path>. C<names> is the list of files from "
12056 #: ../fish/guestfish-actions.pod:3946 ../src/guestfs-actions.pod:5965
12058 "On return you get a list of strings, with a one-to-one correspondence to the "
12059 "C<names> list. Each string is the value of the symbolic link."
12063 #: ../fish/guestfish-actions.pod:3950 ../src/guestfs-actions.pod:5969
12065 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12066 "result string is the empty string C<\"\">. However the whole operation is "
12067 "completed even if there were C<readlink(2)> errors, and so you can call this "
12068 "function with names where you don't know if they are symbolic links already "
12069 "(albeit slightly less efficient)."
12073 #: ../fish/guestfish-actions.pod:3957 ../src/guestfs-actions.pod:5976
12075 "This call is intended for programs that want to efficiently list a directory "
12076 "contents without making many round-trips. Very long directory listings "
12077 "might cause the protocol message size to be exceeded, causing this call to "
12078 "fail. The caller must split up such requests into smaller groups of names."
12082 #: ../fish/guestfish-actions.pod:3964
12087 #: ../fish/guestfish-actions.pod:3966
12095 #: ../fish/guestfish-actions.pod:3968 ../src/guestfs-actions.pod:5995
12097 "Return the canonicalized absolute pathname of C<path>. The returned path "
12098 "has no C<.>, C<..> or symbolic link path elements."
12102 #: ../fish/guestfish-actions.pod:3971
12103 msgid "removexattr"
12107 #: ../fish/guestfish-actions.pod:3973
12110 " removexattr xattr path\n"
12115 #: ../fish/guestfish-actions.pod:3975 ../src/guestfs-actions.pod:6010
12116 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
12120 #: ../fish/guestfish-actions.pod:3978
12121 msgid "See also: L</lremovexattr>, L<attr(5)>."
12125 #: ../fish/guestfish-actions.pod:3980
12130 #: ../fish/guestfish-actions.pod:3982
12133 " resize2fs device\n"
12138 #: ../fish/guestfish-actions.pod:3984 ../src/guestfs-actions.pod:6025
12140 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12141 "underlying device."
12145 #: ../fish/guestfish-actions.pod:3987
12147 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
12148 "before calling this command. For unknown reasons C<resize2fs> sometimes "
12149 "gives an error about this and sometimes not. In any case, it is always safe "
12150 "to call L</e2fsck-f> before calling this function."
12154 #: ../fish/guestfish-actions.pod:3993
12155 msgid "resize2fs-M"
12159 #: ../fish/guestfish-actions.pod:3995
12162 " resize2fs-M device\n"
12167 #: ../fish/guestfish-actions.pod:3997
12169 "This command is the same as L</resize2fs>, but the filesystem is resized to "
12170 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
12175 #: ../fish/guestfish-actions.pod:4001
12177 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
12178 "and read the C<Block size> and C<Block count> values. These two numbers, "
12179 "multiplied together, give the resulting size of the minimal filesystem in "
12184 #: ../fish/guestfish-actions.pod:4006
12185 msgid "resize2fs-size"
12189 #: ../fish/guestfish-actions.pod:4008
12192 " resize2fs-size device size\n"
12197 #: ../fish/guestfish-actions.pod:4010
12199 "This command is the same as L</resize2fs> except that it allows you to "
12200 "specify the new size (in bytes) explicitly."
12204 #: ../fish/guestfish-actions.pod:4013
12209 #: ../fish/guestfish-actions.pod:4015
12217 #: ../fish/guestfish-actions.pod:4017 ../src/guestfs-actions.pod:6077
12218 msgid "Remove the single file C<path>."
12222 #: ../fish/guestfish-actions.pod:4019
12227 #: ../fish/guestfish-actions.pod:4021
12235 #: ../fish/guestfish-actions.pod:4023 ../src/guestfs-actions.pod:6089
12237 "Remove the file or directory C<path>, recursively removing the contents if "
12238 "its a directory. This is like the C<rm -rf> shell command."
12242 #: ../fish/guestfish-actions.pod:4027
12247 #: ../fish/guestfish-actions.pod:4029
12255 #: ../fish/guestfish-actions.pod:4031 ../src/guestfs-actions.pod:6103
12256 msgid "Remove the single directory C<path>."
12260 #: ../fish/guestfish-actions.pod:4033
12261 msgid "rmmountpoint"
12265 #: ../fish/guestfish-actions.pod:4035
12268 " rmmountpoint exemptpath\n"
12273 #: ../fish/guestfish-actions.pod:4037
12275 "This calls removes a mountpoint that was previously created with "
12276 "L</mkmountpoint>. See L</mkmountpoint> for full details."
12280 #: ../fish/guestfish-actions.pod:4041
12281 msgid "scrub-device"
12285 #: ../fish/guestfish-actions.pod:4043
12288 " scrub-device device\n"
12293 #: ../fish/guestfish-actions.pod:4045 ../src/guestfs-actions.pod:6129
12295 "This command writes patterns over C<device> to make data retrieval more "
12300 #: ../fish/guestfish-actions.pod:4048 ../fish/guestfish-actions.pod:4063 ../fish/guestfish-actions.pod:4076 ../src/guestfs-actions.pod:6132 ../src/guestfs-actions.pod:6153 ../src/guestfs-actions.pod:6172
12302 "It is an interface to the L<scrub(1)> program. See that manual page for "
12307 #: ../fish/guestfish-actions.pod:4054
12312 #: ../fish/guestfish-actions.pod:4056
12315 " scrub-file file\n"
12320 #: ../fish/guestfish-actions.pod:4058 ../src/guestfs-actions.pod:6148
12322 "This command writes patterns over a file to make data retrieval more "
12327 #: ../fish/guestfish-actions.pod:4061 ../src/guestfs-actions.pod:6151
12328 msgid "The file is I<removed> after scrubbing."
12332 #: ../fish/guestfish-actions.pod:4066
12333 msgid "scrub-freespace"
12337 #: ../fish/guestfish-actions.pod:4068
12340 " scrub-freespace dir\n"
12345 #: ../fish/guestfish-actions.pod:4070
12347 "This command creates the directory C<dir> and then fills it with files until "
12348 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
12349 "deletes them. The intention is to scrub any free space on the partition "
12350 "containing C<dir>."
12354 #: ../fish/guestfish-actions.pod:4079
12359 #: ../fish/guestfish-actions.pod:4081
12364 #: ../fish/guestfish-actions.pod:4083
12367 " set-append append\n"
12372 #: ../fish/guestfish-actions.pod:4085 ../src/guestfs-actions.pod:6185
12374 "This function is used to add additional options to the guest kernel command "
12379 #: ../fish/guestfish-actions.pod:4088 ../src/guestfs-actions.pod:6188
12381 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12382 "environment variable."
12386 #: ../fish/guestfish-actions.pod:4091 ../src/guestfs-actions.pod:6191
12388 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12389 "(libguestfs always adds a few of its own)."
12393 #: ../fish/guestfish-actions.pod:4094
12394 msgid "set-attach-method"
12398 #: ../fish/guestfish-actions.pod:4096
12399 msgid "attach-method"
12403 #: ../fish/guestfish-actions.pod:4098
12406 " set-attach-method attachmethod\n"
12411 #: ../fish/guestfish-actions.pod:4100 ../src/guestfs-actions.pod:6204
12413 "Set the method that libguestfs uses to connect to the back end guestfsd "
12414 "daemon. Possible methods are:"
12418 #: ../fish/guestfish-actions.pod:4105 ../src/guestfs-actions.pod:6209 ../src/guestfs.pod:2803
12419 msgid "C<appliance>"
12423 #: ../fish/guestfish-actions.pod:4107 ../src/guestfs-actions.pod:6211
12425 "Launch an appliance and connect to it. This is the ordinary method and the "
12430 #: ../fish/guestfish-actions.pod:4110 ../src/guestfs-actions.pod:6214
12431 msgid "C<unix:I<path>>"
12435 #: ../fish/guestfish-actions.pod:4112 ../src/guestfs-actions.pod:6216
12436 msgid "Connect to the Unix domain socket I<path>."
12440 #: ../fish/guestfish-actions.pod:4114 ../src/guestfs-actions.pod:6218
12442 "This method lets you connect to an existing daemon or (using virtio-serial) "
12443 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
12444 "RUNNING DAEMONS>."
12448 #: ../fish/guestfish-actions.pod:4120
12449 msgid "set-autosync"
12453 #: ../fish/guestfish-actions.pod:4122
12458 #: ../fish/guestfish-actions.pod:4124
12461 " set-autosync true|false\n"
12466 #: ../fish/guestfish-actions.pod:4126 ../src/guestfs-actions.pod:6234
12468 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
12469 "effort attempt to make filesystems consistent and synchronized when the "
12470 "handle is closed (also if the program exits without closing handles)."
12474 #: ../fish/guestfish-actions.pod:4131 ../src/guestfs-actions.pod:6239
12476 "This is enabled by default (since libguestfs 1.5.24, previously it was "
12477 "disabled by default)."
12481 #: ../fish/guestfish-actions.pod:4134
12486 #: ../fish/guestfish-actions.pod:4136
12491 #: ../fish/guestfish-actions.pod:4138
12494 " set-direct true|false\n"
12499 #: ../fish/guestfish-actions.pod:4140 ../src/guestfs-actions.pod:6252
12501 "If the direct appliance mode flag is enabled, then stdin and stdout are "
12502 "passed directly through to the appliance once it is launched."
12506 #: ../fish/guestfish-actions.pod:4144
12508 "One consequence of this is that log messages aren't caught by the library "
12509 "and handled by L</set-log-message-callback>, but go straight to stdout."
12513 #: ../fish/guestfish-actions.pod:4148 ../src/guestfs-actions.pod:6260
12514 msgid "You probably don't want to use this unless you know what you are doing."
12518 #: ../fish/guestfish-actions.pod:4151 ../src/guestfs-actions.pod:6263
12519 msgid "The default is disabled."
12523 #: ../fish/guestfish-actions.pod:4153
12524 msgid "set-e2label"
12528 #: ../fish/guestfish-actions.pod:4155
12531 " set-e2label device label\n"
12536 #: ../fish/guestfish-actions.pod:4157 ../src/guestfs-actions.pod:6276
12538 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
12539 "C<label>. Filesystem labels are limited to 16 characters."
12543 #: ../fish/guestfish-actions.pod:4161
12545 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
12546 "label on a filesystem."
12550 #: ../fish/guestfish-actions.pod:4164
12555 #: ../fish/guestfish-actions.pod:4166
12558 " set-e2uuid device uuid\n"
12563 #: ../fish/guestfish-actions.pod:4168 ../src/guestfs-actions.pod:6294
12565 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
12566 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
12567 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
12571 #: ../fish/guestfish-actions.pod:4173
12573 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
12574 "UUID of a filesystem."
12578 #: ../fish/guestfish-actions.pod:4176
12579 msgid "set-memsize"
12583 #: ../fish/guestfish-actions.pod:4178
12588 #: ../fish/guestfish-actions.pod:4180
12591 " set-memsize memsize\n"
12596 #: ../fish/guestfish-actions.pod:4182
12598 "This sets the memory size in megabytes allocated to the qemu subprocess. "
12599 "This only has any effect if called before L</launch>."
12603 #: ../fish/guestfish-actions.pod:4186 ../src/guestfs-actions.pod:6316
12605 "You can also change this by setting the environment variable "
12606 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
12610 #: ../fish/guestfish-actions.pod:4193
12611 msgid "set-network"
12615 #: ../fish/guestfish-actions.pod:4195
12620 #: ../fish/guestfish-actions.pod:4197
12623 " set-network true|false\n"
12628 #: ../fish/guestfish-actions.pod:4199 ../src/guestfs-actions.pod:6333
12630 "If C<network> is true, then the network is enabled in the libguestfs "
12631 "appliance. The default is false."
12635 #: ../fish/guestfish-actions.pod:4202 ../src/guestfs-actions.pod:6336
12637 "This affects whether commands are able to access the network (see "
12638 "L<guestfs(3)/RUNNING COMMANDS>)."
12642 #: ../fish/guestfish-actions.pod:4205
12643 msgid "You must call this before calling L</launch>, otherwise it has no effect."
12647 #: ../fish/guestfish-actions.pod:4208
12652 #: ../fish/guestfish-actions.pod:4212
12655 " set-path searchpath\n"
12660 #: ../fish/guestfish-actions.pod:4214 ../src/guestfs-actions.pod:6352
12661 msgid "Set the path that libguestfs searches for kernel and initrd.img."
12665 #: ../fish/guestfish-actions.pod:4216 ../src/guestfs-actions.pod:6354
12667 "The default is C<$libdir/guestfs> unless overridden by setting "
12668 "C<LIBGUESTFS_PATH> environment variable."
12672 #: ../fish/guestfish-actions.pod:4219 ../src/guestfs-actions.pod:6357
12673 msgid "Setting C<path> to C<NULL> restores the default path."
12677 #: ../fish/guestfish-actions.pod:4221
12682 #: ../fish/guestfish-actions.pod:4223
12687 #: ../fish/guestfish-actions.pod:4225
12690 " set-pgroup true|false\n"
12695 #: ../fish/guestfish-actions.pod:4227 ../src/guestfs-actions.pod:6369
12697 "If C<pgroup> is true, child processes are placed into their own process "
12702 #: ../fish/guestfish-actions.pod:4230 ../src/guestfs-actions.pod:6372
12704 "The practical upshot of this is that signals like C<SIGINT> (from users "
12705 "pressing C<^C>) won't be received by the child process."
12709 #: ../fish/guestfish-actions.pod:4233 ../src/guestfs-actions.pod:6375
12711 "The default for this flag is false, because usually you want C<^C> to kill "
12716 #: ../fish/guestfish-actions.pod:4236
12721 #: ../fish/guestfish-actions.pod:4238
12726 #: ../fish/guestfish-actions.pod:4240
12734 #: ../fish/guestfish-actions.pod:4242 ../src/guestfs-actions.pod:6388
12735 msgid "Set the qemu binary that we will use."
12739 #: ../fish/guestfish-actions.pod:4244 ../src/guestfs-actions.pod:6390
12740 msgid "The default is chosen when the library was compiled by the configure script."
12744 #: ../fish/guestfish-actions.pod:4247 ../src/guestfs-actions.pod:6393
12746 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
12751 #: ../fish/guestfish-actions.pod:4250 ../src/guestfs-actions.pod:6396
12752 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
12756 #: ../fish/guestfish-actions.pod:4252 ../src/guestfs-actions.pod:6398
12758 "Note that you should call this function as early as possible after creating "
12759 "the handle. This is because some pre-launch operations depend on testing "
12760 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
12761 "don't retest features, and so you might see inconsistent results. Using the "
12762 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
12763 "the qemu binary at the same time as the handle is created."
12767 #: ../fish/guestfish-actions.pod:4260
12768 msgid "set-recovery-proc"
12772 #: ../fish/guestfish-actions.pod:4262
12773 msgid "recovery-proc"
12777 #: ../fish/guestfish-actions.pod:4264
12780 " set-recovery-proc true|false\n"
12785 #: ../fish/guestfish-actions.pod:4266
12787 "If this is called with the parameter C<false> then L</launch> does not "
12788 "create a recovery process. The purpose of the recovery process is to stop "
12789 "runaway qemu processes in the case where the main program aborts abruptly."
12793 #: ../fish/guestfish-actions.pod:4271
12795 "This only has any effect if called before L</launch>, and the default is "
12800 #: ../fish/guestfish-actions.pod:4274 ../src/guestfs-actions.pod:6424
12802 "About the only time when you would want to disable this is if the main "
12803 "process will fork itself into the background (\"daemonize\" itself). In "
12804 "this case the recovery process thinks that the main program has disappeared "
12805 "and so kills qemu, which is not very helpful."
12809 #: ../fish/guestfish-actions.pod:4280
12810 msgid "set-selinux"
12814 #: ../fish/guestfish-actions.pod:4282
12819 #: ../fish/guestfish-actions.pod:4284
12822 " set-selinux true|false\n"
12827 #: ../fish/guestfish-actions.pod:4286 ../src/guestfs-actions.pod:6440
12829 "This sets the selinux flag that is passed to the appliance at boot time. "
12830 "The default is C<selinux=0> (disabled)."
12834 #: ../fish/guestfish-actions.pod:4289 ../src/guestfs-actions.pod:6443
12836 "Note that if SELinux is enabled, it is always in Permissive mode "
12837 "(C<enforcing=0>)."
12841 #: ../fish/guestfish-actions.pod:4295
12846 #: ../fish/guestfish-actions.pod:4297
12851 #: ../fish/guestfish-actions.pod:4299
12854 " set-trace true|false\n"
12859 #: ../fish/guestfish-actions.pod:4301 ../src/guestfs-actions.pod:6459
12861 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
12862 "return values are traced."
12866 #: ../fish/guestfish-actions.pod:4304 ../src/guestfs-actions.pod:6462
12868 "If you want to trace C API calls into libguestfs (and other libraries) then "
12869 "possibly a better way is to use the external ltrace(1) command."
12873 #: ../fish/guestfish-actions.pod:4308 ../src/guestfs-actions.pod:6466
12875 "Command traces are disabled unless the environment variable "
12876 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
12880 #: ../fish/guestfish-actions.pod:4311
12882 "Trace messages are normally sent to C<stderr>, unless you register a "
12883 "callback to send them somewhere else (see L</set-event-callback>)."
12887 #: ../fish/guestfish-actions.pod:4315
12888 msgid "set-verbose"
12892 #: ../fish/guestfish-actions.pod:4317
12897 #: ../fish/guestfish-actions.pod:4319
12900 " set-verbose true|false\n"
12905 #: ../fish/guestfish-actions.pod:4321 ../src/guestfs-actions.pod:6483
12906 msgid "If C<verbose> is true, this turns on verbose messages."
12910 #: ../fish/guestfish-actions.pod:4323 ../src/guestfs-actions.pod:6485
12912 "Verbose messages are disabled unless the environment variable "
12913 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
12917 #: ../fish/guestfish-actions.pod:4326
12919 "Verbose messages are normally sent to C<stderr>, unless you register a "
12920 "callback to send them somewhere else (see L</set-event-callback>)."
12924 #: ../fish/guestfish-actions.pod:4330
12929 #: ../fish/guestfish-actions.pod:4332
12932 " setcon context\n"
12937 #: ../fish/guestfish-actions.pod:4334 ../src/guestfs-actions.pod:6502
12939 "This sets the SELinux security context of the daemon to the string "
12944 #: ../fish/guestfish-actions.pod:4337 ../src/guestfs-actions.pod:6505
12945 msgid "See the documentation about SELINUX in L<guestfs(3)>."
12949 #: ../fish/guestfish-actions.pod:4339
12954 #: ../fish/guestfish-actions.pod:4341
12957 " setxattr xattr val vallen path\n"
12962 #: ../fish/guestfish-actions.pod:4343 ../src/guestfs-actions.pod:6520
12964 "This call sets the extended attribute named C<xattr> of the file C<path> to "
12965 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
12969 #: ../fish/guestfish-actions.pod:4347
12970 msgid "See also: L</lsetxattr>, L<attr(5)>."
12974 #: ../fish/guestfish-actions.pod:4349
12979 #: ../fish/guestfish-actions.pod:4351
12982 " sfdisk device cyls heads sectors 'lines ...'\n"
12987 #: ../fish/guestfish-actions.pod:4353 ../src/guestfs-actions.pod:6540
12989 "This is a direct interface to the L<sfdisk(8)> program for creating "
12990 "partitions on block devices."
12994 #: ../fish/guestfish-actions.pod:4356 ../src/guestfs-actions.pod:6543
12995 msgid "C<device> should be a block device, for example C</dev/sda>."
12999 #: ../fish/guestfish-actions.pod:4358 ../src/guestfs-actions.pod:6545
13001 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
13002 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
13003 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
13004 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
13005 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
13006 "the kernel) cannot work out the right geometry and you will need to tell it."
13010 #: ../fish/guestfish-actions.pod:4366 ../src/guestfs-actions.pod:6553
13012 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
13013 "refer to the L<sfdisk(8)> manpage."
13017 #: ../fish/guestfish-actions.pod:4369 ../src/guestfs-actions.pod:6556
13019 "To create a single partition occupying the whole disk, you would pass "
13020 "C<lines> as a single element list, when the single element being the string "
13025 #: ../fish/guestfish-actions.pod:4373
13026 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
13030 #: ../fish/guestfish-actions.pod:4379 ../fish/guestfish-actions.pod:4402 ../fish/guestfish-actions.pod:4424
13032 "This function is deprecated. In new code, use the L</part_add> call "
13037 #: ../fish/guestfish-actions.pod:4386
13042 #: ../fish/guestfish-actions.pod:4388
13045 " sfdiskM device 'lines ...'\n"
13050 #: ../fish/guestfish-actions.pod:4390
13052 "This is a simplified interface to the L</sfdisk> command, where partition "
13053 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
13054 "you don't need to specify the cyls, heads and sectors parameters which were "
13055 "rarely if ever used anyway."
13059 #: ../fish/guestfish-actions.pod:4396
13060 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
13064 #: ../fish/guestfish-actions.pod:4409
13069 #: ../fish/guestfish-actions.pod:4411
13072 " sfdisk-N device partnum cyls heads sectors line\n"
13077 #: ../fish/guestfish-actions.pod:4413 ../src/guestfs-actions.pod:6618
13079 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13080 "(note: C<n> counts from 1)."
13084 #: ../fish/guestfish-actions.pod:4416
13086 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
13087 "cyls/heads/sectors parameters."
13091 #: ../fish/guestfish-actions.pod:4419
13092 msgid "See also: L</part-add>"
13096 #: ../fish/guestfish-actions.pod:4431
13097 msgid "sfdisk-disk-geometry"
13101 #: ../fish/guestfish-actions.pod:4433
13104 " sfdisk-disk-geometry device\n"
13109 #: ../fish/guestfish-actions.pod:4435
13111 "This displays the disk geometry of C<device> read from the partition table. "
13112 "Especially in the case where the underlying block device has been resized, "
13113 "this can be different from the kernel's idea of the geometry (see "
13114 "L</sfdisk-kernel-geometry>)."
13118 #: ../fish/guestfish-actions.pod:4440 ../fish/guestfish-actions.pod:4449 ../src/guestfs-actions.pod:6651 ../src/guestfs-actions.pod:6667
13119 msgid "The result is in human-readable format, and not designed to be parsed."
13123 #: ../fish/guestfish-actions.pod:4443
13124 msgid "sfdisk-kernel-geometry"
13128 #: ../fish/guestfish-actions.pod:4445
13131 " sfdisk-kernel-geometry device\n"
13136 #: ../fish/guestfish-actions.pod:4447 ../src/guestfs-actions.pod:6665
13137 msgid "This displays the kernel's idea of the geometry of C<device>."
13141 #: ../fish/guestfish-actions.pod:4452
13146 #: ../fish/guestfish-actions.pod:4454
13149 " sfdisk-l device\n"
13154 #: ../fish/guestfish-actions.pod:4456 ../src/guestfs-actions.pod:6681
13156 "This displays the partition table on C<device>, in the human-readable output "
13157 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13161 #: ../fish/guestfish-actions.pod:4460
13162 msgid "See also: L</part-list>"
13166 #: ../fish/guestfish-actions.pod:4462
13168 "This function is deprecated. In new code, use the L</part_list> call "
13173 #: ../fish/guestfish-actions.pod:4469
13178 #: ../fish/guestfish-actions.pod:4471
13186 #: ../fish/guestfish-actions.pod:4473 ../src/guestfs-actions.pod:6705
13188 "This call runs a command from the guest filesystem via the guest's "
13193 #: ../fish/guestfish-actions.pod:4476
13194 msgid "This is like L</command>, but passes the command to:"
13198 #: ../fish/guestfish-actions.pod:4478 ../src/guestfs-actions.pod:6710
13201 " /bin/sh -c \"command\"\n"
13206 #: ../fish/guestfish-actions.pod:4480 ../src/guestfs-actions.pod:6712
13208 "Depending on the guest's shell, this usually results in wildcards being "
13209 "expanded, shell expressions being interpolated and so on."
13213 #: ../fish/guestfish-actions.pod:4484
13214 msgid "All the provisos about L</command> apply to this call."
13218 #: ../fish/guestfish-actions.pod:4486
13223 #: ../fish/guestfish-actions.pod:4488
13226 " sh-lines command\n"
13231 #: ../fish/guestfish-actions.pod:4490
13232 msgid "This is the same as L</sh>, but splits the result into a list of lines."
13236 #: ../fish/guestfish-actions.pod:4493
13237 msgid "See also: L</command-lines>"
13241 #: ../fish/guestfish-actions.pod:4495
13246 #: ../fish/guestfish-actions.pod:4497
13254 #: ../fish/guestfish-actions.pod:4499 ../src/guestfs-actions.pod:6746
13255 msgid "Sleep for C<secs> seconds."
13259 #: ../fish/guestfish-actions.pod:4501
13264 #: ../fish/guestfish-actions.pod:4503
13272 #: ../fish/guestfish-actions.pod:4507 ../src/guestfs-actions.pod:6760
13273 msgid "This is the same as the C<stat(2)> system call."
13277 #: ../fish/guestfish-actions.pod:4509
13282 #: ../fish/guestfish-actions.pod:4511
13290 #: ../fish/guestfish-actions.pod:4513 ../src/guestfs-actions.pod:6774
13292 "Returns file system statistics for any mounted file system. C<path> should "
13293 "be a file or directory in the mounted file system (typically it is the mount "
13294 "point itself, but it doesn't need to be)."
13298 #: ../fish/guestfish-actions.pod:4517 ../src/guestfs-actions.pod:6778
13299 msgid "This is the same as the C<statvfs(2)> system call."
13303 #: ../fish/guestfish-actions.pod:4519
13308 #: ../fish/guestfish-actions.pod:4521
13316 #: ../fish/guestfish-actions.pod:4523 ../src/guestfs-actions.pod:6792
13318 "This runs the L<strings(1)> command on a file and returns the list of "
13319 "printable strings found."
13323 #: ../fish/guestfish-actions.pod:4529
13328 #: ../fish/guestfish-actions.pod:4531
13331 " strings-e encoding path\n"
13336 #: ../fish/guestfish-actions.pod:4533
13338 "This is like the L</strings> command, but allows you to specify the encoding "
13339 "of strings that are looked for in the source file C<path>."
13343 #: ../fish/guestfish-actions.pod:4537 ../src/guestfs-actions.pod:6815
13344 msgid "Allowed encodings are:"
13348 #: ../fish/guestfish-actions.pod:4541 ../src/guestfs-actions.pod:6819
13353 #: ../fish/guestfish-actions.pod:4543
13355 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13356 "ISO-8859-X (this is what L</strings> uses)."
13360 #: ../fish/guestfish-actions.pod:4546 ../src/guestfs-actions.pod:6824
13365 #: ../fish/guestfish-actions.pod:4548 ../src/guestfs-actions.pod:6826
13366 msgid "Single 8-bit-byte characters."
13370 #: ../fish/guestfish-actions.pod:4550 ../src/guestfs-actions.pod:6828
13375 #: ../fish/guestfish-actions.pod:4552 ../src/guestfs-actions.pod:6830
13376 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13380 #: ../fish/guestfish-actions.pod:4555 ../src/guestfs-actions.pod:6833
13381 msgid "l (lower case letter L)"
13385 #: ../fish/guestfish-actions.pod:4557 ../src/guestfs-actions.pod:6835
13387 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13388 "examining binaries in Windows guests."
13392 #: ../fish/guestfish-actions.pod:4560 ../src/guestfs-actions.pod:6838
13397 #: ../fish/guestfish-actions.pod:4562 ../src/guestfs-actions.pod:6840
13398 msgid "32-bit big endian such as UCS-4BE."
13402 #: ../fish/guestfish-actions.pod:4564 ../src/guestfs-actions.pod:6842
13407 #: ../fish/guestfish-actions.pod:4566 ../src/guestfs-actions.pod:6844
13408 msgid "32-bit little endian such as UCS-4LE."
13412 #: ../fish/guestfish-actions.pod:4570 ../src/guestfs-actions.pod:6848
13413 msgid "The returned strings are transcoded to UTF-8."
13417 #: ../fish/guestfish-actions.pod:4575
13418 msgid "swapoff-device"
13422 #: ../fish/guestfish-actions.pod:4577
13425 " swapoff-device device\n"
13430 #: ../fish/guestfish-actions.pod:4579
13432 "This command disables the libguestfs appliance swap device or partition "
13433 "named C<device>. See L</swapon-device>."
13437 #: ../fish/guestfish-actions.pod:4583
13438 msgid "swapoff-file"
13442 #: ../fish/guestfish-actions.pod:4585
13445 " swapoff-file file\n"
13450 #: ../fish/guestfish-actions.pod:4587 ../src/guestfs-actions.pod:6879
13451 msgid "This command disables the libguestfs appliance swap on file."
13455 #: ../fish/guestfish-actions.pod:4589
13456 msgid "swapoff-label"
13460 #: ../fish/guestfish-actions.pod:4591
13463 " swapoff-label label\n"
13468 #: ../fish/guestfish-actions.pod:4593 ../src/guestfs-actions.pod:6891
13470 "This command disables the libguestfs appliance swap on labeled swap "
13475 #: ../fish/guestfish-actions.pod:4596
13476 msgid "swapoff-uuid"
13480 #: ../fish/guestfish-actions.pod:4598
13483 " swapoff-uuid uuid\n"
13488 #: ../fish/guestfish-actions.pod:4600 ../src/guestfs-actions.pod:6904
13490 "This command disables the libguestfs appliance swap partition with the given "
13495 #: ../fish/guestfish-actions.pod:4603
13496 msgid "swapon-device"
13500 #: ../fish/guestfish-actions.pod:4605
13503 " swapon-device device\n"
13508 #: ../fish/guestfish-actions.pod:4607
13510 "This command enables the libguestfs appliance to use the swap device or "
13511 "partition named C<device>. The increased memory is made available for all "
13512 "commands, for example those run using L</command> or L</sh>."
13516 #: ../fish/guestfish-actions.pod:4612 ../src/guestfs-actions.pod:6922
13518 "Note that you should not swap to existing guest swap partitions unless you "
13519 "know what you are doing. They may contain hibernation information, or other "
13520 "information that the guest doesn't want you to trash. You also risk leaking "
13521 "information about the host to the guest this way. Instead, attach a new "
13522 "host device to the guest and swap on that."
13526 #: ../fish/guestfish-actions.pod:4619
13527 msgid "swapon-file"
13531 #: ../fish/guestfish-actions.pod:4621
13534 " swapon-file file\n"
13539 #: ../fish/guestfish-actions.pod:4623
13540 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
13544 #: ../fish/guestfish-actions.pod:4626
13545 msgid "swapon-label"
13549 #: ../fish/guestfish-actions.pod:4628
13552 " swapon-label label\n"
13557 #: ../fish/guestfish-actions.pod:4630
13559 "This command enables swap to a labeled swap partition. See "
13560 "L</swapon-device> for other notes."
13564 #: ../fish/guestfish-actions.pod:4633
13565 msgid "swapon-uuid"
13569 #: ../fish/guestfish-actions.pod:4635
13572 " swapon-uuid uuid\n"
13577 #: ../fish/guestfish-actions.pod:4637
13579 "This command enables swap to a swap partition with the given UUID. See "
13580 "L</swapon-device> for other notes."
13584 #: ../fish/guestfish-actions.pod:4640
13589 #: ../fish/guestfish-actions.pod:4642
13597 #: ../fish/guestfish-actions.pod:4644 ../src/guestfs-actions.pod:6977
13599 "This syncs the disk, so that any writes are flushed through to the "
13600 "underlying disk image."
13604 #: ../fish/guestfish-actions.pod:4647 ../src/guestfs-actions.pod:6980
13606 "You should always call this if you have modified a disk image, before "
13607 "closing the handle."
13611 #: ../fish/guestfish-actions.pod:4650
13616 #: ../fish/guestfish-actions.pod:4652
13624 #: ../fish/guestfish-actions.pod:4654 ../src/guestfs-actions.pod:6993
13625 msgid "This command returns up to the last 10 lines of a file as a list of strings."
13629 #: ../fish/guestfish-actions.pod:4660
13634 #: ../fish/guestfish-actions.pod:4662
13637 " tail-n nrlines path\n"
13642 #: ../fish/guestfish-actions.pod:4664 ../src/guestfs-actions.pod:7012
13644 "If the parameter C<nrlines> is a positive number, this returns the last "
13645 "C<nrlines> lines of the file C<path>."
13649 #: ../fish/guestfish-actions.pod:4667 ../src/guestfs-actions.pod:7015
13651 "If the parameter C<nrlines> is a negative number, this returns lines from "
13652 "the file C<path>, starting with the C<-nrlines>th line."
13656 #: ../fish/guestfish-actions.pod:4675
13661 #: ../fish/guestfish-actions.pod:4677
13664 " tar-in (tarfile|-) directory\n"
13669 #: ../fish/guestfish-actions.pod:4679 ../src/guestfs-actions.pod:7036
13671 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
13672 "tar file) into C<directory>."
13676 #: ../fish/guestfish-actions.pod:4682
13677 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
13681 #: ../fish/guestfish-actions.pod:4687
13686 #: ../fish/guestfish-actions.pod:4689
13689 " tar-out directory (tarfile|-)\n"
13694 #: ../fish/guestfish-actions.pod:4691 ../src/guestfs-actions.pod:7053
13696 "This command packs the contents of C<directory> and downloads it to local "
13701 #: ../fish/guestfish-actions.pod:4694
13702 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
13706 #: ../fish/guestfish-actions.pod:4699
13711 #: ../fish/guestfish-actions.pod:4701
13714 " tgz-in (tarball|-) directory\n"
13719 #: ../fish/guestfish-actions.pod:4703 ../src/guestfs-actions.pod:7070
13721 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
13722 "tar file) into C<directory>."
13726 #: ../fish/guestfish-actions.pod:4706
13727 msgid "To upload an uncompressed tarball, use L</tar-in>."
13731 #: ../fish/guestfish-actions.pod:4710
13736 #: ../fish/guestfish-actions.pod:4712
13739 " tgz-out directory (tarball|-)\n"
13744 #: ../fish/guestfish-actions.pod:4714 ../src/guestfs-actions.pod:7086
13746 "This command packs the contents of C<directory> and downloads it to local "
13751 #: ../fish/guestfish-actions.pod:4717
13752 msgid "To download an uncompressed tarball, use L</tar-out>."
13756 #: ../fish/guestfish-actions.pod:4721
13761 #: ../fish/guestfish-actions.pod:4723
13769 #: ../fish/guestfish-actions.pod:4725 ../src/guestfs-actions.pod:7101
13771 "Touch acts like the L<touch(1)> command. It can be used to update the "
13772 "timestamps on a file, or, if the file does not exist, to create a new "
13773 "zero-length file."
13777 #: ../fish/guestfish-actions.pod:4729 ../src/guestfs-actions.pod:7105
13779 "This command only works on regular files, and will fail on other file types "
13780 "such as directories, symbolic links, block special etc."
13784 #: ../fish/guestfish-actions.pod:4732
13789 #: ../fish/guestfish-actions.pod:4734
13797 #: ../fish/guestfish-actions.pod:4736 ../src/guestfs-actions.pod:7118
13799 "This command truncates C<path> to a zero-length file. The file must exist "
13804 #: ../fish/guestfish-actions.pod:4739
13805 msgid "truncate-size"
13809 #: ../fish/guestfish-actions.pod:4741
13812 " truncate-size path size\n"
13817 #: ../fish/guestfish-actions.pod:4743 ../src/guestfs-actions.pod:7132
13819 "This command truncates C<path> to size C<size> bytes. The file must exist "
13824 #: ../fish/guestfish-actions.pod:4746
13826 "If the current file size is less than C<size> then the file is extended to "
13827 "the required size with zero bytes. This creates a sparse file (ie. disk "
13828 "blocks are not allocated for the file until you write to it). To create a "
13829 "non-sparse file of zeroes, use L</fallocate64> instead."
13833 #: ../fish/guestfish-actions.pod:4752
13838 #: ../fish/guestfish-actions.pod:4754
13841 " tune2fs-l device\n"
13846 #: ../fish/guestfish-actions.pod:4756 ../src/guestfs-actions.pod:7151
13848 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
13853 #: ../fish/guestfish-actions.pod:4759 ../src/guestfs-actions.pod:7154
13855 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
13856 "for more details. The list of fields returned isn't clearly defined, and "
13857 "depends on both the version of C<tune2fs> that libguestfs was built against, "
13858 "and the filesystem itself."
13862 #: ../fish/guestfish-actions.pod:4764
13867 #: ../fish/guestfish-actions.pod:4766
13870 " txz-in (tarball|-) directory\n"
13875 #: ../fish/guestfish-actions.pod:4768 ../src/guestfs-actions.pod:7174
13877 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
13878 "tar file) into C<directory>."
13882 #: ../fish/guestfish-actions.pod:4773
13887 #: ../fish/guestfish-actions.pod:4775
13890 " txz-out directory (tarball|-)\n"
13895 #: ../fish/guestfish-actions.pod:4777 ../src/guestfs-actions.pod:7188
13897 "This command packs the contents of C<directory> and downloads it to local "
13898 "file C<tarball> (as an xz compressed tar archive)."
13902 #: ../fish/guestfish-actions.pod:4782
13907 #: ../fish/guestfish-actions.pod:4784
13915 #: ../fish/guestfish-actions.pod:4786 ../src/guestfs-actions.pod:7201
13917 "This function sets the mask used for creating new files and device nodes to "
13922 #: ../fish/guestfish-actions.pod:4789 ../src/guestfs-actions.pod:7204
13924 "Typical umask values would be C<022> which creates new files with "
13925 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
13926 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
13930 #: ../fish/guestfish-actions.pod:4794 ../src/guestfs-actions.pod:7209
13932 "The default umask is C<022>. This is important because it means that "
13933 "directories and device nodes will be created with C<0644> or C<0755> mode "
13934 "even if you specify C<0777>."
13938 #: ../fish/guestfish-actions.pod:4798
13939 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
13943 #: ../fish/guestfish-actions.pod:4801 ../src/guestfs-actions.pod:7216
13944 msgid "This call returns the previous umask."
13948 #: ../fish/guestfish-actions.pod:4803
13953 #: ../fish/guestfish-actions.pod:4805
13958 #: ../fish/guestfish-actions.pod:4807
13961 " umount pathordevice\n"
13966 #: ../fish/guestfish-actions.pod:4809 ../src/guestfs-actions.pod:7228
13968 "This unmounts the given filesystem. The filesystem may be specified either "
13969 "by its mountpoint (path) or the device which contains the filesystem."
13973 #: ../fish/guestfish-actions.pod:4813
13978 #: ../fish/guestfish-actions.pod:4815
13979 msgid "unmount-all"
13983 #: ../fish/guestfish-actions.pod:4817
13991 #: ../fish/guestfish-actions.pod:4819 ../src/guestfs-actions.pod:7241
13992 msgid "This unmounts all mounted filesystems."
13996 #: ../fish/guestfish-actions.pod:4821 ../src/guestfs-actions.pod:7243
13997 msgid "Some internal mounts are not unmounted by this call."
14001 #: ../fish/guestfish-actions.pod:4823
14006 #: ../fish/guestfish-actions.pod:4825
14009 " upload (filename|-) remotefilename\n"
14014 #: ../fish/guestfish-actions.pod:4827 ../fish/guestfish-actions.pod:4840 ../src/guestfs-actions.pod:7256 ../src/guestfs-actions.pod:7280
14015 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
14019 #: ../fish/guestfish-actions.pod:4832
14020 msgid "See also L</download>."
14024 #: ../fish/guestfish-actions.pod:4836
14025 msgid "upload-offset"
14029 #: ../fish/guestfish-actions.pod:4838
14032 " upload-offset (filename|-) remotefilename offset\n"
14037 #: ../fish/guestfish-actions.pod:4843 ../src/guestfs-actions.pod:7283
14039 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14040 "The intention is to overwrite parts of existing files or devices, although "
14041 "if a non-existant file is specified then it is created with a \"hole\" "
14042 "before C<offset>. The size of the data written is implicit in the size of "
14043 "the source C<filename>."
14047 #: ../fish/guestfish-actions.pod:4850
14049 "Note that there is no limit on the amount of data that can be uploaded with "
14050 "this call, unlike with L</pwrite>, and this call always writes the full "
14051 "amount unless an error occurs."
14055 #: ../fish/guestfish-actions.pod:4855
14056 msgid "See also L</upload>, L</pwrite>."
14060 #: ../fish/guestfish-actions.pod:4859
14065 #: ../fish/guestfish-actions.pod:4861
14068 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
14073 #: ../fish/guestfish-actions.pod:4863 ../src/guestfs-actions.pod:7316
14074 msgid "This command sets the timestamps of a file with nanosecond precision."
14078 #: ../fish/guestfish-actions.pod:4866 ../src/guestfs-actions.pod:7319
14080 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14085 #: ../fish/guestfish-actions.pod:4869 ../src/guestfs-actions.pod:7322
14087 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14088 "nanoseconds from the epoch."
14092 #: ../fish/guestfish-actions.pod:4872 ../src/guestfs-actions.pod:7325
14094 "If the C<*nsecs> field contains the special value C<-1> then the "
14095 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14096 "ignored in this case)."
14100 #: ../fish/guestfish-actions.pod:4876 ../src/guestfs-actions.pod:7329
14102 "If the C<*nsecs> field contains the special value C<-2> then the "
14103 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14108 #: ../fish/guestfish-actions.pod:4880
14113 #: ../fish/guestfish-actions.pod:4882
14121 #: ../fish/guestfish-actions.pod:4884 ../src/guestfs-actions.pod:7342
14122 msgid "Return the libguestfs version number that the program is linked against."
14126 #: ../fish/guestfish-actions.pod:4887 ../src/guestfs-actions.pod:7345
14128 "Note that because of dynamic linking this is not necessarily the version of "
14129 "libguestfs that you compiled against. You can compile the program, and then "
14130 "at runtime dynamically link against a completely different C<libguestfs.so> "
14135 #: ../fish/guestfish-actions.pod:4892 ../src/guestfs-actions.pod:7350
14137 "This call was added in version C<1.0.58>. In previous versions of "
14138 "libguestfs there was no way to get the version number. From C code you can "
14139 "use dynamic linker functions to find out if this symbol exists (if it "
14140 "doesn't, then it's an earlier version)."
14144 #: ../fish/guestfish-actions.pod:4898 ../src/guestfs-actions.pod:7356
14146 "The call returns a structure with four elements. The first three (C<major>, "
14147 "C<minor> and C<release>) are numbers and correspond to the usual version "
14148 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14149 "but may be used for distro-specific information."
14153 #: ../fish/guestfish-actions.pod:4904 ../src/guestfs-actions.pod:7362
14154 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
14158 #: ../fish/guestfish-actions.pod:4907 ../src/guestfs-actions.pod:7365
14159 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14163 #: ../fish/guestfish-actions.pod:4909
14165 "I<Note:> Don't use this call to test for availability of features. In "
14166 "enterprise distributions we backport features from later versions into "
14167 "earlier versions, making this an unreliable way to test for features. Use "
14168 "L</available> instead."
14172 #: ../fish/guestfish-actions.pod:4915
14177 #: ../fish/guestfish-actions.pod:4917
14180 " vfs-label device\n"
14185 #: ../fish/guestfish-actions.pod:4919 ../src/guestfs-actions.pod:7385
14186 msgid "This returns the filesystem label of the filesystem on C<device>."
14190 #: ../fish/guestfish-actions.pod:4922 ../src/guestfs-actions.pod:7388
14191 msgid "If the filesystem is unlabeled, this returns the empty string."
14195 #: ../fish/guestfish-actions.pod:4924
14196 msgid "To find a filesystem from the label, use L</findfs-label>."
14200 #: ../fish/guestfish-actions.pod:4926
14205 #: ../fish/guestfish-actions.pod:4928
14208 " vfs-type device\n"
14213 #: ../fish/guestfish-actions.pod:4930 ../src/guestfs-actions.pod:7403
14215 "This command gets the filesystem type corresponding to the filesystem on "
14220 #: ../fish/guestfish-actions.pod:4933 ../src/guestfs-actions.pod:7406
14222 "For most filesystems, the result is the name of the Linux VFS module which "
14223 "would be used to mount this filesystem if you mounted it without specifying "
14224 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14228 #: ../fish/guestfish-actions.pod:4938
14233 #: ../fish/guestfish-actions.pod:4940
14236 " vfs-uuid device\n"
14241 #: ../fish/guestfish-actions.pod:4942 ../src/guestfs-actions.pod:7422
14242 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14246 #: ../fish/guestfish-actions.pod:4945 ../src/guestfs-actions.pod:7425
14247 msgid "If the filesystem does not have a UUID, this returns the empty string."
14251 #: ../fish/guestfish-actions.pod:4947
14252 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
14256 #: ../fish/guestfish-actions.pod:4949
14257 msgid "vg-activate"
14261 #: ../fish/guestfish-actions.pod:4951
14264 " vg-activate true|false 'volgroups ...'\n"
14269 #: ../fish/guestfish-actions.pod:4953 ../src/guestfs-actions.pod:7441
14271 "This command activates or (if C<activate> is false) deactivates all logical "
14272 "volumes in the listed volume groups C<volgroups>."
14276 #: ../fish/guestfish-actions.pod:4956 ../src/guestfs-actions.pod:7444
14277 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14281 #: ../fish/guestfish-actions.pod:4958 ../src/guestfs-actions.pod:7446
14283 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14284 "activated or deactivated."
14288 #: ../fish/guestfish-actions.pod:4961
14289 msgid "vg-activate-all"
14293 #: ../fish/guestfish-actions.pod:4963
14296 " vg-activate-all true|false\n"
14301 #: ../fish/guestfish-actions.pod:4965 ../src/guestfs-actions.pod:7459
14303 "This command activates or (if C<activate> is false) deactivates all logical "
14304 "volumes in all volume groups."
14308 #: ../fish/guestfish-actions.pod:4968 ../src/guestfs-actions.pod:7462
14309 msgid "This command is the same as running C<vgchange -a y|n>"
14313 #: ../fish/guestfish-actions.pod:4970
14318 #: ../fish/guestfish-actions.pod:4972
14321 " vgcreate volgroup 'physvols ...'\n"
14326 #: ../fish/guestfish-actions.pod:4974 ../src/guestfs-actions.pod:7475
14328 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14329 "of physical volumes C<physvols>."
14333 #: ../fish/guestfish-actions.pod:4977
14338 #: ../fish/guestfish-actions.pod:4979
14341 " vglvuuids vgname\n"
14346 #: ../fish/guestfish-actions.pod:4981 ../src/guestfs-actions.pod:7488
14348 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14349 "volumes created in this volume group."
14353 #: ../fish/guestfish-actions.pod:4984
14355 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
14356 "logical volumes and volume groups."
14360 #: ../fish/guestfish-actions.pod:4987
14361 msgid "See also L</vgpvuuids>."
14365 #: ../fish/guestfish-actions.pod:4989
14370 #: ../fish/guestfish-actions.pod:4991
14373 " vgpvuuids vgname\n"
14378 #: ../fish/guestfish-actions.pod:4993 ../src/guestfs-actions.pod:7508
14380 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14381 "volumes that this volume group resides on."
14385 #: ../fish/guestfish-actions.pod:4996
14387 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
14388 "physical volumes and volume groups."
14392 #: ../fish/guestfish-actions.pod:4999
14393 msgid "See also L</vglvuuids>."
14397 #: ../fish/guestfish-actions.pod:5001
14402 #: ../fish/guestfish-actions.pod:5003
14405 " vgremove vgname\n"
14410 #: ../fish/guestfish-actions.pod:5005 ../src/guestfs-actions.pod:7528
14411 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14415 #: ../fish/guestfish-actions.pod:5007 ../src/guestfs-actions.pod:7530
14416 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
14420 #: ../fish/guestfish-actions.pod:5010
14425 #: ../fish/guestfish-actions.pod:5012
14428 " vgrename volgroup newvolgroup\n"
14433 #: ../fish/guestfish-actions.pod:5014 ../src/guestfs-actions.pod:7544
14434 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14438 #: ../fish/guestfish-actions.pod:5016
14443 #: ../fish/guestfish-actions.pod:5018
14451 #: ../fish/guestfish-actions.pod:5020 ../src/guestfs-actions.pod:7555
14453 "List all the volumes groups detected. This is the equivalent of the "
14454 "L<vgs(8)> command."
14458 #: ../fish/guestfish-actions.pod:5023 ../src/guestfs-actions.pod:7558
14460 "This returns a list of just the volume group names that were detected "
14461 "(eg. C<VolGroup00>)."
14465 #: ../fish/guestfish-actions.pod:5026
14466 msgid "See also L</vgs-full>."
14470 #: ../fish/guestfish-actions.pod:5028
14475 #: ../fish/guestfish-actions.pod:5030
14483 #: ../fish/guestfish-actions.pod:5032 ../src/guestfs-actions.pod:7574
14485 "List all the volumes groups detected. This is the equivalent of the "
14486 "L<vgs(8)> command. The \"full\" version includes all fields."
14490 #: ../fish/guestfish-actions.pod:5035
14495 #: ../fish/guestfish-actions.pod:5037
14503 #: ../fish/guestfish-actions.pod:5039 ../src/guestfs-actions.pod:7588
14505 "This rescans all block devices and rebuilds the list of LVM physical "
14506 "volumes, volume groups and logical volumes."
14510 #: ../fish/guestfish-actions.pod:5042
14515 #: ../fish/guestfish-actions.pod:5044
14523 #: ../fish/guestfish-actions.pod:5046 ../src/guestfs-actions.pod:7601
14524 msgid "This command returns the UUID of the LVM VG named C<vgname>."
14528 #: ../fish/guestfish-actions.pod:5048
14533 #: ../fish/guestfish-actions.pod:5050
14541 #: ../fish/guestfish-actions.pod:5052 ../src/guestfs-actions.pod:7641
14543 "This command counts the characters in a file, using the C<wc -c> external "
14548 #: ../fish/guestfish-actions.pod:5055
14553 #: ../fish/guestfish-actions.pod:5057
14561 #: ../fish/guestfish-actions.pod:5059 ../src/guestfs-actions.pod:7654
14563 "This command counts the lines in a file, using the C<wc -l> external "
14568 #: ../fish/guestfish-actions.pod:5062
14573 #: ../fish/guestfish-actions.pod:5064
14581 #: ../fish/guestfish-actions.pod:5066 ../src/guestfs-actions.pod:7667
14583 "This command counts the words in a file, using the C<wc -w> external "
14588 #: ../fish/guestfish-actions.pod:5069
14593 #: ../fish/guestfish-actions.pod:5071
14596 " write path content\n"
14601 #: ../fish/guestfish-actions.pod:5073 ../src/guestfs-actions.pod:7682
14603 "This call creates a file called C<path>. The content of the file is the "
14604 "string C<content> (which can contain any 8 bit data)."
14608 #: ../fish/guestfish-actions.pod:5076
14609 msgid "See also L</write-append>."
14613 #: ../fish/guestfish-actions.pod:5081
14614 msgid "write-append"
14618 #: ../fish/guestfish-actions.pod:5083
14621 " write-append path content\n"
14626 #: ../fish/guestfish-actions.pod:5085 ../src/guestfs-actions.pod:7702
14628 "This call appends C<content> to the end of file C<path>. If C<path> does "
14629 "not exist, then a new file is created."
14633 #: ../fish/guestfish-actions.pod:5088
14634 msgid "See also L</write>."
14638 #: ../fish/guestfish-actions.pod:5093
14643 #: ../fish/guestfish-actions.pod:5095
14646 " write-file path content size\n"
14651 #: ../fish/guestfish-actions.pod:5097 ../src/guestfs-actions.pod:7722
14653 "This call creates a file called C<path>. The contents of the file is the "
14654 "string C<content> (which can contain any 8 bit data), with length C<size>."
14658 #: ../fish/guestfish-actions.pod:5101 ../src/guestfs-actions.pod:7726
14660 "As a special case, if C<size> is C<0> then the length is calculated using "
14661 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
14665 #: ../fish/guestfish-actions.pod:5105 ../src/guestfs-actions.pod:7730
14667 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
14668 "I<not> work, even if the length is specified."
14672 #: ../fish/guestfish-actions.pod:5111
14673 msgid "This function is deprecated. In new code, use the L</write> call instead."
14677 #: ../fish/guestfish-actions.pod:5118
14682 #: ../fish/guestfish-actions.pod:5120
14685 " zegrep regex path\n"
14690 #: ../fish/guestfish-actions.pod:5122 ../src/guestfs-actions.pod:7754
14691 msgid "This calls the external C<zegrep> program and returns the matching lines."
14695 #: ../fish/guestfish-actions.pod:5128
14700 #: ../fish/guestfish-actions.pod:5130
14703 " zegrepi regex path\n"
14708 #: ../fish/guestfish-actions.pod:5132 ../src/guestfs-actions.pod:7773
14709 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
14713 #: ../fish/guestfish-actions.pod:5138
14718 #: ../fish/guestfish-actions.pod:5140
14726 #: ../fish/guestfish-actions.pod:5142 ../src/guestfs-actions.pod:7791
14727 msgid "This command writes zeroes over the first few blocks of C<device>."
14731 #: ../fish/guestfish-actions.pod:5144 ../src/guestfs-actions.pod:7793
14733 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
14734 "securely wipe the device). It should be sufficient to remove any partition "
14735 "tables, filesystem superblocks and so on."
14739 #: ../fish/guestfish-actions.pod:5148 ../fish/guestfish-actions.pod:5163 ../src/guestfs-actions.pod:7797 ../src/guestfs-actions.pod:7823
14741 "If blocks are already zero, then this command avoids writing zeroes. This "
14742 "prevents the underlying device from becoming non-sparse or growing "
14747 #: ../fish/guestfish-actions.pod:5152
14748 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
14752 #: ../fish/guestfish-actions.pod:5155
14753 msgid "zero-device"
14757 #: ../fish/guestfish-actions.pod:5157
14760 " zero-device device\n"
14765 #: ../fish/guestfish-actions.pod:5159
14767 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
14768 "which just zeroes the first few blocks of a device."
14772 #: ../fish/guestfish-actions.pod:5170
14777 #: ../fish/guestfish-actions.pod:5172
14780 " zerofree device\n"
14785 #: ../fish/guestfish-actions.pod:5174 ../src/guestfs-actions.pod:7845
14787 "This runs the I<zerofree> program on C<device>. This program claims to zero "
14788 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
14789 "possible to compress the filesystem more effectively."
14793 #: ../fish/guestfish-actions.pod:5179 ../src/guestfs-actions.pod:7850
14794 msgid "You should B<not> run this program if the filesystem is mounted."
14798 #: ../fish/guestfish-actions.pod:5182 ../src/guestfs-actions.pod:7853
14800 "It is possible that using this program can damage the filesystem or data on "
14805 #: ../fish/guestfish-actions.pod:5185
14810 #: ../fish/guestfish-actions.pod:5187
14813 " zfgrep pattern path\n"
14818 #: ../fish/guestfish-actions.pod:5189 ../src/guestfs-actions.pod:7867
14819 msgid "This calls the external C<zfgrep> program and returns the matching lines."
14823 #: ../fish/guestfish-actions.pod:5195
14828 #: ../fish/guestfish-actions.pod:5197
14831 " zfgrepi pattern path\n"
14836 #: ../fish/guestfish-actions.pod:5199 ../src/guestfs-actions.pod:7886
14837 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
14841 #: ../fish/guestfish-actions.pod:5205
14846 #: ../fish/guestfish-actions.pod:5207
14849 " zfile meth path\n"
14854 #: ../fish/guestfish-actions.pod:5209 ../src/guestfs-actions.pod:7905
14855 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
14859 #: ../fish/guestfish-actions.pod:5212 ../src/guestfs-actions.pod:7908
14860 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
14864 #: ../fish/guestfish-actions.pod:5214
14865 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
14869 #: ../fish/guestfish-actions.pod:5217
14870 msgid "This function is deprecated. In new code, use the L</file> call instead."
14874 #: ../fish/guestfish-actions.pod:5224
14879 #: ../fish/guestfish-actions.pod:5226
14882 " zgrep regex path\n"
14887 #: ../fish/guestfish-actions.pod:5228 ../src/guestfs-actions.pod:7932
14888 msgid "This calls the external C<zgrep> program and returns the matching lines."
14892 #: ../fish/guestfish-actions.pod:5234
14897 #: ../fish/guestfish-actions.pod:5236
14900 " zgrepi regex path\n"
14905 #: ../fish/guestfish-actions.pod:5238 ../src/guestfs-actions.pod:7951
14906 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
14910 #: ../fish/guestfish-commands.pod:1
14915 #: ../fish/guestfish-commands.pod:3
14920 #: ../fish/guestfish-commands.pod:5
14923 " alloc filename size\n"
14928 #: ../fish/guestfish-commands.pod:7
14930 "This creates an empty (zeroed) file of the given size, and then adds so it "
14931 "can be further examined."
14935 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
14936 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
14940 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
14941 msgid "Size can be specified using standard suffixes, eg. C<1M>."
14945 #: ../fish/guestfish-commands.pod:14
14947 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
14948 "image, see L</PREPARED DISK IMAGES>."
14952 #: ../fish/guestfish-commands.pod:17
14957 #: ../fish/guestfish-commands.pod:19
14960 " copy-in local [local ...] /remotedir\n"
14965 #: ../fish/guestfish-commands.pod:21
14967 "C<copy-in> copies local files or directories recursively into the disk "
14968 "image, placing them in the directory called C</remotedir> (which must "
14969 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
14970 "other commands as necessary."
14974 #: ../fish/guestfish-commands.pod:26
14976 "Multiple local files and directories can be specified, but the last "
14977 "parameter must always be a remote directory. Wildcards cannot be used."
14981 #: ../fish/guestfish-commands.pod:30
14986 #: ../fish/guestfish-commands.pod:32
14989 " copy-out remote [remote ...] localdir\n"
14994 #: ../fish/guestfish-commands.pod:34
14996 "C<copy-out> copies remote files or directories recursively out of the disk "
14997 "image, placing them on the host disk in a local directory called C<localdir> "
14998 "(which must exist). This guestfish meta-command turns into a sequence of "
14999 "L</download>, L</tar-out> and other commands as necessary."
15003 #: ../fish/guestfish-commands.pod:40
15005 "Multiple remote files and directories can be specified, but the last "
15006 "parameter must always be a local directory. To download to the current "
15007 "directory, use C<.> as in:"
15011 #: ../fish/guestfish-commands.pod:44
15014 " copy-out /home .\n"
15019 #: ../fish/guestfish-commands.pod:46
15021 "Wildcards cannot be used in the ordinary command, but you can use them with "
15022 "the help of L</glob> like this:"
15026 #: ../fish/guestfish-commands.pod:49
15029 " glob copy-out /home/* .\n"
15034 #: ../fish/guestfish-commands.pod:51
15039 #: ../fish/guestfish-commands.pod:53
15042 " display filename\n"
15047 #: ../fish/guestfish-commands.pod:55
15049 "Use C<display> (a graphical display program) to display an image file. It "
15050 "downloads the file, and runs C<display> on it."
15054 #: ../fish/guestfish-commands.pod:58
15056 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
15057 "environment variable. For example to use the GNOME display program:"
15061 #: ../fish/guestfish-commands.pod:61
15064 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
15069 #: ../fish/guestfish-commands.pod:63
15070 msgid "See also L<display(1)>."
15074 #: ../fish/guestfish-commands.pod:65
15079 #: ../fish/guestfish-commands.pod:67
15082 " echo [params ...]\n"
15087 #: ../fish/guestfish-commands.pod:69
15088 msgid "This echos the parameters to the terminal."
15092 #: ../fish/guestfish-commands.pod:71
15097 #: ../fish/guestfish-commands.pod:73
15102 #: ../fish/guestfish-commands.pod:75
15107 #: ../fish/guestfish-commands.pod:77
15115 #: ../fish/guestfish-commands.pod:79
15117 "This is used to edit a file. It downloads the file, edits it locally using "
15118 "your editor, then uploads the result."
15122 #: ../fish/guestfish-commands.pod:82
15124 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
15125 "or C<emacs> you will get those corresponding editors."
15129 #: ../fish/guestfish-commands.pod:86
15134 #: ../fish/guestfish-commands.pod:88
15137 " glob command args...\n"
15142 #: ../fish/guestfish-commands.pod:90
15144 "Expand wildcards in any paths in the args list, and run C<command> "
15145 "repeatedly on each matching path."
15149 #: ../fish/guestfish-commands.pod:93
15150 msgid "See L</WILDCARDS AND GLOBBING>."
15154 #: ../fish/guestfish-commands.pod:95
15159 #: ../fish/guestfish-commands.pod:97
15162 " hexedit <filename|device>\n"
15163 " hexedit <filename|device> <max>\n"
15164 " hexedit <filename|device> <start> <max>\n"
15169 #: ../fish/guestfish-commands.pod:101
15171 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
15176 #: ../fish/guestfish-commands.pod:104
15178 "This command works by downloading potentially the whole file or device, "
15179 "editing it locally, then uploading it. If the file or device is large, you "
15180 "have to specify which part you wish to edit by using C<max> and/or C<start> "
15181 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
15182 "usual modifiers allowed such as C<1M> (1 megabyte)."
15186 #: ../fish/guestfish-commands.pod:111
15187 msgid "For example to edit the first few sectors of a disk you might do:"
15191 #: ../fish/guestfish-commands.pod:114
15194 " hexedit /dev/sda 1M\n"
15199 #: ../fish/guestfish-commands.pod:116
15201 "which would allow you to edit anywhere within the first megabyte of the "
15206 #: ../fish/guestfish-commands.pod:119
15207 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
15211 #: ../fish/guestfish-commands.pod:121
15214 " hexedit /dev/sda1 0x400 0x400\n"
15219 #: ../fish/guestfish-commands.pod:123
15220 msgid "(assuming the superblock is in the standard location)."
15224 #: ../fish/guestfish-commands.pod:125
15226 "This command requires the external L<hexedit(1)> program. You can specify "
15227 "another program to use by setting the C<HEXEDITOR> environment variable."
15231 #: ../fish/guestfish-commands.pod:129
15232 msgid "See also L</hexdump>."
15236 #: ../fish/guestfish-commands.pod:131
15241 #: ../fish/guestfish-commands.pod:133
15249 #: ../fish/guestfish-commands.pod:135
15250 msgid "Change the local directory, ie. the current directory of guestfish itself."
15254 #: ../fish/guestfish-commands.pod:138
15255 msgid "Note that C<!cd> won't do what you might expect."
15259 #: ../fish/guestfish-commands.pod:140
15264 #: ../fish/guestfish-commands.pod:142
15269 #: ../fish/guestfish-commands.pod:144
15277 #: ../fish/guestfish-commands.pod:146
15278 msgid "Opens the manual page for guestfish."
15282 #: ../fish/guestfish-commands.pod:148
15287 #: ../fish/guestfish-commands.pod:150
15292 #: ../fish/guestfish-commands.pod:152
15300 #: ../fish/guestfish-commands.pod:154
15308 #: ../fish/guestfish-commands.pod:156
15309 msgid "This is used to view a file."
15313 #: ../fish/guestfish-commands.pod:158
15315 "The default viewer is C<$PAGER>. However if you use the alternate command "
15316 "C<less> you will get the C<less> command specifically."
15320 #: ../fish/guestfish-commands.pod:161
15325 #: ../fish/guestfish-commands.pod:163
15333 #: ../fish/guestfish-commands.pod:165
15335 "Close and reopen the libguestfs handle. It is not necessary to use this "
15336 "normally, because the handle is closed properly when guestfish exits. "
15337 "However this is occasionally useful for testing."
15341 #: ../fish/guestfish-commands.pod:169
15346 #: ../fish/guestfish-commands.pod:171
15349 " sparse filename size\n"
15354 #: ../fish/guestfish-commands.pod:173
15356 "This creates an empty sparse file of the given size, and then adds so it can "
15357 "be further examined."
15361 #: ../fish/guestfish-commands.pod:176
15363 "In all respects it works the same as the L</alloc> command, except that the "
15364 "image file is allocated sparsely, which means that disk blocks are not "
15365 "assigned to the file until they are needed. Sparse disk files only use "
15366 "space when written to, but they are slower and there is a danger you could "
15367 "run out of real disk space during a write operation."
15371 #: ../fish/guestfish-commands.pod:186
15376 #: ../fish/guestfish-commands.pod:188
15384 #: ../fish/guestfish-commands.pod:190
15386 "This command returns a list of the optional groups known to the daemon, and "
15387 "indicates which ones are supported by this build of the libguestfs "
15392 #: ../fish/guestfish-commands.pod:194
15393 msgid "See also L<guestfs(3)/AVAILABILITY>."
15397 #: ../fish/guestfish-commands.pod:196
15402 #: ../fish/guestfish-commands.pod:198
15405 " time command args...\n"
15410 #: ../fish/guestfish-commands.pod:200
15412 "Run the command as usual, but print the elapsed time afterwards. This can "
15413 "be useful for benchmarking operations."
15417 #: ../fish/guestfish.pod:5
15418 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
15422 #: ../fish/guestfish.pod:9
15425 " guestfish [--options] [commands]\n"
15430 #: ../fish/guestfish.pod:11
15438 #: ../fish/guestfish.pod:13
15441 " guestfish [--ro|--rw] -a disk.img\n"
15446 #: ../fish/guestfish.pod:15
15449 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
15454 #: ../fish/guestfish.pod:17
15457 " guestfish -d libvirt-domain\n"
15462 #: ../fish/guestfish.pod:19
15465 " guestfish [--ro|--rw] -a disk.img -i\n"
15470 #: ../fish/guestfish.pod:21
15473 " guestfish -d libvirt-domain -i\n"
15478 #: ../fish/guestfish.pod:25
15480 "Using guestfish in read/write mode on live virtual machines can be "
15481 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
15482 "option to use guestfish safely if the disk image or virtual machine might be "
15487 #: ../fish/guestfish.pod:32
15489 "Guestfish is a shell and command-line tool for examining and modifying "
15490 "virtual machine filesystems. It uses libguestfs and exposes all of the "
15491 "functionality of the guestfs API, see L<guestfs(3)>."
15495 #: ../fish/guestfish.pod:36
15497 "Guestfish gives you structured access to the libguestfs API, from shell "
15498 "scripts or the command line or interactively. If you want to rescue a "
15499 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
15504 #: ../fish/guestfish.pod:43
15505 msgid "As an interactive shell"
15509 #: ../fish/guestfish.pod:45
15517 #: ../fish/guestfish.pod:47
15520 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
15521 " editing virtual machine filesystems.\n"
15526 #: ../fish/guestfish.pod:50
15529 " Type: 'help' for a list of commands\n"
15530 " 'man' to read the manual\n"
15531 " 'quit' to quit the shell\n"
15536 #: ../fish/guestfish.pod:54
15539 " ><fs> add-ro disk.img\n"
15541 " ><fs> list-filesystems\n"
15542 " /dev/sda1: ext4\n"
15543 " /dev/vg_guest/lv_root: ext4\n"
15544 " /dev/vg_guest/lv_swap: swap\n"
15545 " ><fs> mount /dev/vg_guest/lv_root /\n"
15546 " ><fs> cat /etc/fstab\n"
15548 " # Created by anaconda\n"
15555 #: ../fish/guestfish.pod:67
15556 msgid "From shell scripts"
15560 #: ../fish/guestfish.pod:69
15561 msgid "Create a new C</etc/motd> file in a guest or disk image:"
15565 #: ../fish/guestfish.pod:71
15568 " guestfish <<_EOF_\n"
15571 " mount /dev/vg_guest/lv_root /\n"
15572 " write /etc/motd \"Welcome, new users\"\n"
15578 #: ../fish/guestfish.pod:78
15579 msgid "List the LVM logical volumes in a disk image:"
15583 #: ../fish/guestfish.pod:80
15586 " guestfish -a disk.img --ro <<_EOF_\n"
15594 #: ../fish/guestfish.pod:85
15595 msgid "List all the filesystems in a disk image:"
15599 #: ../fish/guestfish.pod:87
15602 " guestfish -a disk.img --ro <<_EOF_\n"
15604 " list-filesystems\n"
15610 #: ../fish/guestfish.pod:92
15611 msgid "On one command line"
15615 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
15616 msgid "Update C</etc/resolv.conf> in a guest:"
15620 #: ../fish/guestfish.pod:96
15624 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
15625 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
15630 #: ../fish/guestfish.pod:100
15631 msgid "Edit C</boot/grub/grub.conf> interactively:"
15635 #: ../fish/guestfish.pod:102
15638 " guestfish --rw --add disk.img \\\n"
15639 " --mount /dev/vg_guest/lv_root \\\n"
15640 " --mount /dev/sda1:/boot \\\n"
15641 " edit /boot/grub/grub.conf\n"
15646 #: ../fish/guestfish.pod:107
15647 msgid "Mount disks automatically"
15651 #: ../fish/guestfish.pod:109
15653 "Use the I<-i> option to automatically mount the disks from a virtual "
15658 #: ../fish/guestfish.pod:112
15661 " guestfish --ro -a disk.img -i cat /etc/group\n"
15666 #: ../fish/guestfish.pod:114
15669 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
15674 #: ../fish/guestfish.pod:116
15675 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
15679 #: ../fish/guestfish.pod:118
15682 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
15687 #: ../fish/guestfish.pod:120
15688 msgid "As a script interpreter"
15692 #: ../fish/guestfish.pod:122
15693 msgid "Create a 100MB disk containing an ext2-formatted partition:"
15697 #: ../fish/guestfish.pod:124
15700 " #!/usr/bin/guestfish -f\n"
15701 " sparse test1.img 100M\n"
15703 " part-disk /dev/sda mbr\n"
15704 " mkfs ext2 /dev/sda1\n"
15709 #: ../fish/guestfish.pod:130
15710 msgid "Start with a prepared disk"
15714 #: ../fish/guestfish.pod:132
15716 "An alternate way to create a 100MB disk called C<test1.img> containing a "
15717 "single ext2-formatted partition:"
15721 #: ../fish/guestfish.pod:135
15724 " guestfish -N fs\n"
15729 #: ../fish/guestfish.pod:137
15730 msgid "To list what is available do:"
15734 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:1042
15737 " guestfish -N help | less\n"
15742 #: ../fish/guestfish.pod:141
15743 msgid "Remote control"
15747 #: ../fish/guestfish.pod:143
15750 " eval \"`guestfish --listen`\"\n"
15751 " guestfish --remote add-ro disk.img\n"
15752 " guestfish --remote run\n"
15753 " guestfish --remote lvs\n"
15758 #: ../fish/guestfish.pod:154
15759 msgid "Displays general help on options."
15763 #: ../fish/guestfish.pod:158
15764 msgid "B<--cmd-help>"
15768 #: ../fish/guestfish.pod:160
15769 msgid "Lists all available guestfish commands."
15773 #: ../fish/guestfish.pod:162
15778 #: ../fish/guestfish.pod:164
15779 msgid "B<--cmd-help cmd>"
15783 #: ../fish/guestfish.pod:166
15784 msgid "Displays detailed help on a single command C<cmd>."
15788 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:96
15789 msgid "B<-a image>"
15793 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:98
15794 msgid "B<--add image>"
15798 #: ../fish/guestfish.pod:172
15799 msgid "Add a block device or virtual machine image to the shell."
15803 #: ../fish/guestfish.pod:177
15805 "Using this flag is mostly equivalent to using the C<add> command, with "
15806 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
15807 "the I<--format=...> flag was given."
15811 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:109
15813 "When used in conjunction with the I<-d> option, this specifies the libvirt "
15814 "URI to use. The default is to use the default libvirt connection."
15818 #: ../fish/guestfish.pod:189
15823 #: ../fish/guestfish.pod:191
15825 "If using the I<--listen> option and a csh-like shell, use this option. See "
15826 "section L</REMOTE CONTROL AND CSH> below."
15830 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:113
15831 msgid "B<-d libvirt-domain>"
15835 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:115
15836 msgid "B<--domain libvirt-domain>"
15840 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:117
15842 "Add disks from the named libvirt domain. If the I<--ro> option is also "
15843 "used, then any libvirt domain can be used. However in write mode, only "
15844 "libvirt domains which are shut down can be named here."
15848 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:121
15849 msgid "Domain UUIDs can be used instead of names."
15853 #: ../fish/guestfish.pod:204
15855 "Using this flag is mostly equivalent to using the C<add-domain> command, "
15856 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
15857 "if the I<--format:...> flag was given."
15861 #: ../fish/guestfish.pod:208
15866 #: ../fish/guestfish.pod:210
15867 msgid "B<--no-dest-paths>"
15871 #: ../fish/guestfish.pod:212
15873 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
15874 "to hit the tab key to complete paths on the guest filesystem, but this "
15875 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
15876 "allow this feature to be disabled."
15880 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:137
15882 "When prompting for keys and passphrases, guestfish normally turns echoing "
15883 "off so you cannot see what you are typing. If you are not worried about "
15884 "Tempest attacks and there is no one else in the room you can specify this "
15885 "flag to see what you are typing."
15889 #: ../fish/guestfish.pod:224
15894 #: ../fish/guestfish.pod:226
15895 msgid "B<--file file>"
15899 #: ../fish/guestfish.pod:228
15900 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
15904 #: ../fish/guestfish.pod:231
15907 " #!/usr/bin/guestfish -f\n"
15912 #: ../fish/guestfish.pod:244
15915 " guestfish --format=raw -a disk.img\n"
15920 #: ../fish/guestfish.pod:248
15923 " guestfish --format=raw -a disk.img --format -a another.img\n"
15928 #: ../fish/guestfish.pod:253
15930 "If you have untrusted raw-format guest disk images, you should use this "
15931 "option to specify the disk format. This avoids a possible security problem "
15932 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
15936 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:166
15937 msgid "B<--inspector>"
15941 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:168
15943 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
15944 "system and mount filesystems as they would be mounted on the real virtual "
15949 #: ../fish/guestfish.pod:266
15950 msgid "Typical usage is either:"
15954 #: ../fish/guestfish.pod:268
15957 " guestfish -d myguest -i\n"
15962 #: ../fish/guestfish.pod:270
15963 msgid "(for an inactive libvirt domain called I<myguest>), or:"
15967 #: ../fish/guestfish.pod:272
15970 " guestfish --ro -d myguest -i\n"
15975 #: ../fish/guestfish.pod:274
15976 msgid "(for active domains, readonly), or specify the block device directly:"
15980 #: ../fish/guestfish.pod:276
15983 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
15988 #: ../fish/guestfish.pod:278
15990 "Note that the command line syntax changed slightly over older versions of "
15991 "guestfish. You can still use the old syntax:"
15995 #: ../fish/guestfish.pod:281
15998 " guestfish [--ro] -i disk.img\n"
16003 #: ../fish/guestfish.pod:283
16006 " guestfish [--ro] -i libvirt-domain\n"
16011 #: ../fish/guestfish.pod:285
16013 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
16014 "then using other commands to mount the filesystems that were found."
16018 #: ../fish/guestfish.pod:294
16019 msgid "B<--listen>"
16023 #: ../fish/guestfish.pod:296
16025 "Fork into the background and listen for remote commands. See section "
16026 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
16030 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:177
16035 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:179
16037 "Connect to a live virtual machine. (Experimental, see "
16038 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
16042 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:182
16043 msgid "B<-m dev[:mountpoint[:options]]>"
16047 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:184
16048 msgid "B<--mount dev[:mountpoint[:options]]>"
16052 #: ../fish/guestfish.pod:308
16053 msgid "Mount the named partition or logical volume on the given mountpoint."
16057 #: ../fish/guestfish.pod:310
16058 msgid "If the mountpoint is omitted, it defaults to C</>."
16062 #: ../fish/guestfish.pod:312
16063 msgid "You have to mount something on C</> before most commands will work."
16067 #: ../fish/guestfish.pod:314
16069 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16074 #: ../fish/guestfish.pod:317
16076 "If you don't know what filesystems a disk image contains, you can either run "
16077 "guestfish without this option, then list the partitions, filesystems and LVs "
16078 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
16079 "commands), or you can use the L<virt-filesystems(1)> program."
16083 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:192
16085 "The third (and rarely used) part of the mount parameter is the list of mount "
16086 "options used to mount the underlying filesystem. If this is not given, then "
16087 "the mount options are either the empty string or C<ro> (the latter if the "
16088 "I<--ro> flag is used). By specifying the mount options, you override this "
16089 "default choice. Probably the only time you would use this is to enable ACLs "
16090 "and/or extended attributes if the filesystem can support them:"
16094 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:200
16097 " -m /dev/sda1:/:acl,user_xattr\n"
16102 #: ../fish/guestfish.pod:333
16103 msgid "Using this flag is equivalent to using the C<mount-options> command."
16107 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:202 ../resize/virt-resize.pod:358
16112 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:204
16113 msgid "B<--no-sync>"
16117 #: ../fish/guestfish.pod:339
16119 "Disable autosync. This is enabled by default. See the discussion of "
16120 "autosync in the L<guestfs(3)> manpage."
16124 #: ../fish/guestfish.pod:342
16129 #: ../fish/guestfish.pod:344
16130 msgid "B<--new type>"
16134 #: ../fish/guestfish.pod:346
16139 #: ../fish/guestfish.pod:348
16141 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
16142 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16143 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
16148 #: ../fish/guestfish.pod:353
16149 msgid "B<--progress-bars>"
16153 #: ../fish/guestfish.pod:355
16154 msgid "Enable progress bars, even when guestfish is used non-interactively."
16158 #: ../fish/guestfish.pod:357
16160 "Progress bars are enabled by default when guestfish is used as an "
16161 "interactive shell."
16165 #: ../fish/guestfish.pod:360
16166 msgid "B<--no-progress-bars>"
16170 #: ../fish/guestfish.pod:362
16171 msgid "Disable progress bars."
16175 #: ../fish/guestfish.pod:364
16176 msgid "B<--remote[=pid]>"
16180 #: ../fish/guestfish.pod:366
16182 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
16183 "CONTROL GUESTFISH OVER A SOCKET> below."
16187 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:248 ../rescue/virt-rescue.pod:161
16192 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:250 ../rescue/virt-rescue.pod:163
16197 #: ../fish/guestfish.pod:373
16199 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16200 "mounts are done read-only."
16204 #: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:167
16206 "The option must always be used if the disk image or virtual machine might be "
16207 "running, and is generally recommended in cases where you don't need write "
16208 "access to the disk."
16212 #: ../fish/guestfish.pod:380
16214 "Note that prepared disk images created with I<-N> are not affected by this "
16215 "option. Also commands like C<add> are not affected - you have to specify "
16216 "the C<readonly:true> option explicitly if you need it."
16220 #: ../fish/guestfish.pod:384
16221 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
16225 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:262 ../rescue/virt-rescue.pod:173
16226 msgid "B<--selinux>"
16230 #: ../fish/guestfish.pod:388
16231 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
16235 #: ../fish/guestfish.pod:394
16237 "Enable very verbose messages. This is particularly useful if you find a "
16242 #: ../fish/guestfish.pod:401
16243 msgid "Display the guestfish / libguestfs version number and exit."
16247 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:278 ../rescue/virt-rescue.pod:190
16252 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:280 ../rescue/virt-rescue.pod:192
16257 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:282
16259 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16260 "mounts are done read-write."
16264 #: ../fish/guestfish.pod:410
16265 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
16269 #: ../fish/guestfish.pod:414
16270 msgid "Echo each command before executing it."
16274 #: ../fish/guestfish.pod:418
16275 msgid "COMMANDS ON COMMAND LINE"
16279 #: ../fish/guestfish.pod:420
16280 msgid "Any additional (non-option) arguments are treated as commands to execute."
16284 #: ../fish/guestfish.pod:423
16286 "Commands to execute should be separated by a colon (C<:>), where the colon "
16287 "is a separate parameter. Thus:"
16291 #: ../fish/guestfish.pod:426
16294 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
16299 #: ../fish/guestfish.pod:428
16301 "If there are no additional arguments, then we enter a shell, either an "
16302 "interactive shell with a prompt (if the input is a terminal) or a "
16303 "non-interactive shell."
16307 #: ../fish/guestfish.pod:432
16309 "In either command line mode or non-interactive shell, the first command that "
16310 "gives an error causes the whole shell to exit. In interactive mode (with a "
16311 "prompt) if a command fails, you can continue to enter commands."
16315 #: ../fish/guestfish.pod:437
16316 msgid "USING launch (OR run)"
16320 #: ../fish/guestfish.pod:439
16322 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
16323 "then launch it, then mount any disks you need, and finally issue "
16324 "actions/commands. So the general order of the day is:"
16328 #: ../fish/guestfish.pod:447
16329 msgid "add or -a/--add"
16333 #: ../fish/guestfish.pod:451
16334 msgid "launch (aka run)"
16338 #: ../fish/guestfish.pod:455
16339 msgid "mount or -m/--mount"
16343 #: ../fish/guestfish.pod:459
16344 msgid "any other commands"
16348 #: ../fish/guestfish.pod:463
16350 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
16351 "guest before mounting or performing any other commands."
16355 #: ../fish/guestfish.pod:466
16357 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
16358 "I<--new> options were given then C<run> is done automatically, simply "
16359 "because guestfish can't perform the action you asked for without doing this."
16363 #: ../fish/guestfish.pod:471
16364 msgid "OPENING DISKS FOR READ AND WRITE"
16368 #: ../fish/guestfish.pod:473
16370 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
16371 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
16372 "I<-i> and I<-m> open disk images read-only or for writing."
16376 #: ../fish/guestfish.pod:478
16378 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
16379 "opening disk images supplied on the command line for write. To open a disk "
16380 "image read-only you have to do I<-a image --ro>."
16384 #: ../fish/guestfish.pod:482
16386 "This matters: If you accidentally open a live VM disk image writable then "
16387 "you will cause irreversible disk corruption."
16391 #: ../fish/guestfish.pod:485
16393 "In a future libguestfs we intend to change the default the other way. Disk "
16394 "images will be opened read-only. You will have to either specify "
16395 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
16396 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
16397 "access for disk images specified by those other command line options."
16401 #: ../fish/guestfish.pod:492
16403 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
16404 "which does nothing (it is already the default). However it is highly "
16405 "recommended that you use this option to indicate that you need write access, "
16406 "and prepare your scripts for the day when this option will be required for "
16411 #: ../fish/guestfish.pod:498
16413 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
16414 "other libguestfs program apart from guestfish and guestmount."
16418 #: ../fish/guestfish.pod:501
16423 #: ../fish/guestfish.pod:503
16425 "You can quote ordinary parameters using either single or double quotes. For "
16430 #: ../fish/guestfish.pod:506
16433 " add \"file with a space.img\"\n"
16438 #: ../fish/guestfish.pod:508
16441 " rm '/file name'\n"
16446 #: ../fish/guestfish.pod:510
16454 #: ../fish/guestfish.pod:512
16456 "A few commands require a list of strings to be passed. For these, use a "
16457 "whitespace-separated list, enclosed in quotes. Strings containing "
16458 "whitespace to be passed through must be enclosed in single quotes. A "
16459 "literal single quote must be escaped with a backslash."
16463 #: ../fish/guestfish.pod:517
16466 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
16467 " command \"/bin/echo 'foo bar'\"\n"
16468 " command \"/bin/echo \\'foo\\'\"\n"
16473 #: ../fish/guestfish.pod:521
16474 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
16478 #: ../fish/guestfish.pod:523
16480 "In double-quoted arguments (only) use backslash to insert special "
16485 #: ../fish/guestfish.pod:528
16490 #: ../fish/guestfish.pod:530
16491 msgid "Alert (bell) character."
16495 #: ../fish/guestfish.pod:532
16500 #: ../fish/guestfish.pod:534
16501 msgid "Backspace character."
16505 #: ../fish/guestfish.pod:536
16510 #: ../fish/guestfish.pod:538
16511 msgid "Form feed character."
16515 #: ../fish/guestfish.pod:540
16520 #: ../fish/guestfish.pod:542
16521 msgid "Newline character."
16525 #: ../fish/guestfish.pod:544
16530 #: ../fish/guestfish.pod:546
16531 msgid "Carriage return character."
16535 #: ../fish/guestfish.pod:548
16540 #: ../fish/guestfish.pod:550
16541 msgid "Horizontal tab character."
16545 #: ../fish/guestfish.pod:552
16550 #: ../fish/guestfish.pod:554
16551 msgid "Vertical tab character."
16555 #: ../fish/guestfish.pod:556
16560 #: ../fish/guestfish.pod:558
16561 msgid "A literal double quote character."
16565 #: ../fish/guestfish.pod:560
16570 #: ../fish/guestfish.pod:562
16572 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
16577 #: ../fish/guestfish.pod:565
16582 #: ../fish/guestfish.pod:567
16583 msgid "A character with hex value I<hh>. There must be precisely 2 hex digits."
16587 #: ../fish/guestfish.pod:570
16589 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
16594 #: ../fish/guestfish.pod:573
16599 #: ../fish/guestfish.pod:575
16600 msgid "A literal backslash character."
16604 #: ../fish/guestfish.pod:579
16605 msgid "OPTIONAL ARGUMENTS"
16609 #: ../fish/guestfish.pod:581
16611 "Some commands take optional arguments. These arguments appear in this "
16612 "documentation as C<[argname:..]>. You can use them as in these examples:"
16616 #: ../fish/guestfish.pod:585
16619 " add-drive-opts filename\n"
16624 #: ../fish/guestfish.pod:587
16627 " add-drive-opts filename readonly:true\n"
16632 #: ../fish/guestfish.pod:589
16635 " add-drive-opts filename format:qcow2 readonly:false\n"
16640 #: ../fish/guestfish.pod:591
16642 "Each optional argument can appear at most once. All optional arguments must "
16643 "appear after the required ones."
16647 #: ../fish/guestfish.pod:594
16652 #: ../fish/guestfish.pod:596
16653 msgid "This section applies to all commands which can take integers as parameters."
16657 #: ../fish/guestfish.pod:599
16658 msgid "SIZE SUFFIX"
16662 #: ../fish/guestfish.pod:601
16664 "When the command takes a parameter measured in bytes, you can use one of the "
16665 "following suffixes to specify kilobytes, megabytes and larger sizes:"
16669 #: ../fish/guestfish.pod:607
16670 msgid "B<k> or B<K> or B<KiB>"
16674 #: ../fish/guestfish.pod:609
16675 msgid "The size in kilobytes (multiplied by 1024)."
16679 #: ../fish/guestfish.pod:611
16684 #: ../fish/guestfish.pod:613
16685 msgid "The size in SI 1000 byte units."
16689 #: ../fish/guestfish.pod:615
16690 msgid "B<M> or B<MiB>"
16694 #: ../fish/guestfish.pod:617
16695 msgid "The size in megabytes (multiplied by 1048576)."
16699 #: ../fish/guestfish.pod:619
16704 #: ../fish/guestfish.pod:621
16705 msgid "The size in SI 1000000 byte units."
16709 #: ../fish/guestfish.pod:623
16710 msgid "B<G> or B<GiB>"
16714 #: ../fish/guestfish.pod:625
16715 msgid "The size in gigabytes (multiplied by 2**30)."
16719 #: ../fish/guestfish.pod:627
16724 #: ../fish/guestfish.pod:629
16725 msgid "The size in SI 10**9 byte units."
16729 #: ../fish/guestfish.pod:631
16730 msgid "B<T> or B<TiB>"
16734 #: ../fish/guestfish.pod:633
16735 msgid "The size in terabytes (multiplied by 2**40)."
16739 #: ../fish/guestfish.pod:635
16744 #: ../fish/guestfish.pod:637
16745 msgid "The size in SI 10**12 byte units."
16749 #: ../fish/guestfish.pod:639
16750 msgid "B<P> or B<PiB>"
16754 #: ../fish/guestfish.pod:641
16755 msgid "The size in petabytes (multiplied by 2**50)."
16759 #: ../fish/guestfish.pod:643
16764 #: ../fish/guestfish.pod:645
16765 msgid "The size in SI 10**15 byte units."
16769 #: ../fish/guestfish.pod:647
16770 msgid "B<E> or B<EiB>"
16774 #: ../fish/guestfish.pod:649
16775 msgid "The size in exabytes (multiplied by 2**60)."
16779 #: ../fish/guestfish.pod:651
16784 #: ../fish/guestfish.pod:653
16785 msgid "The size in SI 10**18 byte units."
16789 #: ../fish/guestfish.pod:655
16790 msgid "B<Z> or B<ZiB>"
16794 #: ../fish/guestfish.pod:657
16795 msgid "The size in zettabytes (multiplied by 2**70)."
16799 #: ../fish/guestfish.pod:659
16804 #: ../fish/guestfish.pod:661
16805 msgid "The size in SI 10**21 byte units."
16809 #: ../fish/guestfish.pod:663
16810 msgid "B<Y> or B<YiB>"
16814 #: ../fish/guestfish.pod:665
16815 msgid "The size in yottabytes (multiplied by 2**80)."
16819 #: ../fish/guestfish.pod:667
16824 #: ../fish/guestfish.pod:669
16825 msgid "The size in SI 10**24 byte units."
16829 #: ../fish/guestfish.pod:675
16832 " truncate-size /file 1G\n"
16837 #: ../fish/guestfish.pod:677
16838 msgid "would truncate the file to 1 gigabyte."
16842 #: ../fish/guestfish.pod:679
16844 "Be careful because a few commands take sizes in kilobytes or megabytes "
16845 "(eg. the parameter to L</memsize> is specified in megabytes already). "
16846 "Adding a suffix will probably not do what you expect."
16850 #: ../fish/guestfish.pod:683
16851 msgid "OCTAL AND HEXADECIMAL NUMBERS"
16855 #: ../fish/guestfish.pod:685
16857 "For specifying the radix (base) use the C convention: C<0> to prefix an "
16858 "octal number or C<0x> to prefix a hexadecimal number. For example:"
16862 #: ../fish/guestfish.pod:688
16865 " 1234 decimal number 1234\n"
16866 " 02322 octal number, equivalent to decimal 1234\n"
16867 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
16872 #: ../fish/guestfish.pod:692
16874 "When using the C<chmod> command, you almost always want to specify an octal "
16875 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
16876 "L<chmod(1)> program):"
16880 #: ../fish/guestfish.pod:696
16883 " chmod 0777 /public # OK\n"
16884 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
16889 #: ../fish/guestfish.pod:699
16891 "Commands that return numbers usually print them in decimal, but some "
16892 "commands print numbers in other radices (eg. C<umask> prints the mode in "
16893 "octal, preceeded by C<0>)."
16897 #: ../fish/guestfish.pod:703
16898 msgid "WILDCARDS AND GLOBBING"
16902 #: ../fish/guestfish.pod:705
16904 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
16905 "(globbing) by default. So for example the following will not do what you "
16910 #: ../fish/guestfish.pod:709
16918 #: ../fish/guestfish.pod:711
16920 "Assuming you don't have a directory called literally C</home/*> then the "
16921 "above command will return an error."
16925 #: ../fish/guestfish.pod:714
16926 msgid "To perform wildcard expansion, use the C<glob> command."
16930 #: ../fish/guestfish.pod:716
16933 " glob rm-rf /home/*\n"
16938 #: ../fish/guestfish.pod:718
16940 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
16941 "many times), equivalent to:"
16945 #: ../fish/guestfish.pod:721
16948 " rm-rf /home/jim\n"
16949 " rm-rf /home/joe\n"
16950 " rm-rf /home/mary\n"
16955 #: ../fish/guestfish.pod:725
16956 msgid "C<glob> only works on simple guest paths and not on device names."
16960 #: ../fish/guestfish.pod:727
16962 "If you have several parameters, each containing a wildcard, then glob will "
16963 "perform a Cartesian product."
16967 #: ../fish/guestfish.pod:730
16972 #: ../fish/guestfish.pod:732
16974 "Any line which starts with a I<#> character is treated as a comment and "
16975 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
16976 "a command. For example:"
16980 #: ../fish/guestfish.pod:736
16983 " # this is a comment\n"
16984 " # this is a comment\n"
16985 " foo # NOT a comment\n"
16990 #: ../fish/guestfish.pod:740
16991 msgid "Blank lines are also ignored."
16995 #: ../fish/guestfish.pod:742
16996 msgid "RUNNING COMMANDS LOCALLY"
17000 #: ../fish/guestfish.pod:744
17002 "Any line which starts with a I<!> character is treated as a command sent to "
17003 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
17007 #: ../fish/guestfish.pod:748
17011 " tgz-out /remote local/remote-data.tar.gz\n"
17016 #: ../fish/guestfish.pod:751
17018 "will create a directory C<local> on the host, and then export the contents "
17019 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
17020 "(See C<tgz-out>)."
17024 #: ../fish/guestfish.pod:755
17026 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
17027 "effect, due to the way that subprocesses work in Unix."
17031 #: ../fish/guestfish.pod:758
17032 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
17036 #: ../fish/guestfish.pod:760
17038 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
17039 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
17040 "and executed as guestfish commands."
17044 #: ../fish/guestfish.pod:764
17046 "Thus you can use shell script to construct arbitrary guestfish commands "
17047 "which are then parsed by guestfish."
17051 #: ../fish/guestfish.pod:767
17053 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
17054 "through C</foo.100>) using guestfish commands alone. However this is simple "
17055 "if we use a shell script to create the guestfish commands for us:"
17059 #: ../fish/guestfish.pod:772
17062 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
17067 #: ../fish/guestfish.pod:774
17068 msgid "or with names like C</foo.001>:"
17072 #: ../fish/guestfish.pod:776
17075 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
17080 #: ../fish/guestfish.pod:778
17082 "When using guestfish interactively it can be helpful to just run the shell "
17083 "script first (ie. remove the initial C<E<lt>> character so it is just an "
17084 "ordinary I<!> local command), see what guestfish commands it would run, and "
17085 "when you are happy with those prepend the C<E<lt>> character to run the "
17086 "guestfish commands for real."
17090 #: ../fish/guestfish.pod:784
17095 #: ../fish/guestfish.pod:786
17097 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17098 "command (a guestfish command) to the second command (any host command). For "
17103 #: ../fish/guestfish.pod:790
17106 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17111 #: ../fish/guestfish.pod:792
17113 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17114 "program). The above command would list all accounts in the guest filesystem "
17115 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17119 #: ../fish/guestfish.pod:797
17122 " hexdump /bin/ls | head\n"
17123 " list-devices | tail -1\n"
17124 " tgz-out / - | tar ztf -\n"
17129 #: ../fish/guestfish.pod:801
17131 "The space before the pipe symbol is required, any space after the pipe "
17132 "symbol is optional. Everything after the pipe symbol is just passed "
17133 "straight to the host shell, so it can contain redirections, globs and "
17134 "anything else that makes sense on the host side."
17138 #: ../fish/guestfish.pod:806
17140 "To use a literal argument which begins with a pipe symbol, you have to quote "
17145 #: ../fish/guestfish.pod:809
17153 #: ../fish/guestfish.pod:811
17154 msgid "HOME DIRECTORIES"
17158 #: ../fish/guestfish.pod:813
17160 "If a parameter starts with the character C<~> then the tilde may be expanded "
17161 "as a home directory path (either C<~> for the current user's home directory, "
17162 "or C<~user> for another user)."
17166 #: ../fish/guestfish.pod:817
17168 "Note that home directory expansion happens for users known I<on the host>, "
17169 "not in the guest filesystem."
17173 #: ../fish/guestfish.pod:820
17175 "To use a literal argument which begins with a tilde, you have to quote it, "
17180 #: ../fish/guestfish.pod:823
17188 #: ../fish/guestfish.pod:825 ../src/guestfs.pod:519
17189 msgid "ENCRYPTED DISKS"
17193 #: ../fish/guestfish.pod:827
17195 "Libguestfs has some support for Linux guests encrypted according to the "
17196 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17197 "disk encryption systems used by modern Linux guests. Currently only "
17198 "LVM-on-LUKS is supported."
17202 #: ../fish/guestfish.pod:832
17203 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17207 #: ../fish/guestfish.pod:834
17210 " ><fs> vfs-type /dev/sda2\n"
17216 #: ../fish/guestfish.pod:837
17218 "Then open those devices using L</luks-open>. This creates a device-mapper "
17219 "device called C</dev/mapper/luksdev>."
17223 #: ../fish/guestfish.pod:840
17226 " ><fs> luks-open /dev/sda2 luksdev\n"
17227 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17232 #: ../fish/guestfish.pod:843
17234 "Finally you have to tell LVM to scan for volume groups on the newly created "
17239 #: ../fish/guestfish.pod:846
17243 " vg-activate-all true\n"
17248 #: ../fish/guestfish.pod:849
17249 msgid "The logical volume(s) can now be mounted in the usual way."
17253 #: ../fish/guestfish.pod:851
17255 "Before closing a LUKS device you must unmount any logical volumes on it and "
17256 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17257 "one. Then you can close the mapper device:"
17261 #: ../fish/guestfish.pod:855
17264 " vg-activate false /dev/VG\n"
17265 " luks-close /dev/mapper/luksdev\n"
17270 #: ../fish/guestfish.pod:860
17272 "If a path is prefixed with C<win:> then you can use Windows-style drive "
17273 "letters and paths (with some limitations). The following commands are "
17278 #: ../fish/guestfish.pod:864
17281 " file /WINDOWS/system32/config/system.LOG\n"
17286 #: ../fish/guestfish.pod:866
17289 " file win:\\windows\\system32\\config\\system.log\n"
17294 #: ../fish/guestfish.pod:868
17297 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
17302 #: ../fish/guestfish.pod:870
17304 "The parameter is rewritten \"behind the scenes\" by looking up the position "
17305 "where the drive is mounted, prepending that to the path, changing all "
17306 "backslash characters to forward slash, then resolving the result using "
17307 "L</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
17308 "then the parameter might be rewritten like this:"
17312 #: ../fish/guestfish.pod:876
17315 " win:e:\\foo\\bar => /e/FOO/bar\n"
17320 #: ../fish/guestfish.pod:878
17321 msgid "This only works in argument positions that expect a path."
17325 #: ../fish/guestfish.pod:880
17326 msgid "UPLOADING AND DOWNLOADING FILES"
17330 #: ../fish/guestfish.pod:882
17332 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
17333 "others which upload from or download to a local file, you can use the "
17334 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
17338 #: ../fish/guestfish.pod:886
17346 #: ../fish/guestfish.pod:888
17347 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
17351 #: ../fish/guestfish.pod:891
17354 " tar-out /etc - | tar tf -\n"
17359 #: ../fish/guestfish.pod:893
17361 "writes the tarball to stdout and then pipes that into the external \"tar\" "
17362 "command (see L</PIPES>)."
17366 #: ../fish/guestfish.pod:896
17368 "When using C<-> to read from stdin, the input is read up to the end of "
17369 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
17370 "some arbitrary end marker:"
17374 #: ../fish/guestfish.pod:900
17377 " upload -<<END /foo\n"
17386 #: ../fish/guestfish.pod:906
17388 "Any string of characters can be used instead of C<END>. The end marker must "
17389 "appear on a line of its own, without any preceeding or following characters "
17390 "(not even spaces)."
17394 #: ../fish/guestfish.pod:910
17396 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
17397 "upload local files (so-called \"FileIn\" parameters in the generator)."
17401 #: ../fish/guestfish.pod:913
17402 msgid "EXIT ON ERROR BEHAVIOUR"
17406 #: ../fish/guestfish.pod:915
17408 "By default, guestfish will ignore any errors when in interactive mode "
17409 "(ie. taking commands from a human over a tty), and will exit on the first "
17410 "error in non-interactive mode (scripts, commands given on the command line)."
17414 #: ../fish/guestfish.pod:920
17416 "If you prefix a command with a I<-> character, then that command will not "
17417 "cause guestfish to exit, even if that (one) command returns an error."
17421 #: ../fish/guestfish.pod:924
17422 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
17426 #: ../fish/guestfish.pod:926
17428 "Guestfish can be remote-controlled over a socket. This is useful "
17429 "particularly in shell scripts where you want to make several different "
17430 "changes to a filesystem, but you don't want the overhead of starting up a "
17431 "guestfish process each time."
17435 #: ../fish/guestfish.pod:931
17436 msgid "Start a guestfish server process using:"
17440 #: ../fish/guestfish.pod:933
17443 " eval \"`guestfish --listen`\"\n"
17448 #: ../fish/guestfish.pod:935
17449 msgid "and then send it commands by doing:"
17453 #: ../fish/guestfish.pod:937
17456 " guestfish --remote cmd [...]\n"
17461 #: ../fish/guestfish.pod:939
17462 msgid "To cause the server to exit, send it the exit command:"
17466 #: ../fish/guestfish.pod:943
17468 "Note that the server will normally exit if there is an error in a command. "
17469 "You can change this in the usual way. See section L</EXIT ON ERROR "
17474 #: ../fish/guestfish.pod:947
17475 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
17479 #: ../fish/guestfish.pod:949
17481 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
17482 "is how the I<--remote> option knows where to send the commands. You can "
17483 "have several guestfish listener processes running using:"
17487 #: ../fish/guestfish.pod:953
17490 " eval \"`guestfish --listen`\"\n"
17491 " pid1=$GUESTFISH_PID\n"
17492 " eval \"`guestfish --listen`\"\n"
17493 " pid2=$GUESTFISH_PID\n"
17495 " guestfish --remote=$pid1 cmd\n"
17496 " guestfish --remote=$pid2 cmd\n"
17501 #: ../fish/guestfish.pod:961
17502 msgid "REMOTE CONTROL AND CSH"
17506 #: ../fish/guestfish.pod:963
17508 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
17513 #: ../fish/guestfish.pod:966
17516 " eval \"`guestfish --listen --csh`\"\n"
17521 #: ../fish/guestfish.pod:968
17522 msgid "REMOTE CONTROL DETAILS"
17526 #: ../fish/guestfish.pod:970
17528 "Remote control happens over a Unix domain socket called "
17529 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
17530 "of the process, and C<$PID> is the process ID of the server."
17534 #: ../fish/guestfish.pod:974
17535 msgid "Guestfish client and server versions must match exactly."
17539 #: ../fish/guestfish.pod:976
17540 msgid "USING REMOTE CONTROL ROBUSTLY FROM SHELL SCRIPTS"
17544 #: ../fish/guestfish.pod:978
17546 "From Bash, you can use the following code which creates a guestfish "
17547 "instance, correctly quotes the command line, handles failure to start, and "
17548 "cleans up guestfish when the script exits:"
17552 #: ../fish/guestfish.pod:982 ../src/guestfs.pod:958
17560 #: ../fish/guestfish.pod:986
17563 " guestfish[0]=\"guestfish\"\n"
17564 " guestfish[1]=\"--listen\"\n"
17565 " guestfish[2]=\"--ro\"\n"
17566 " guestfish[3]=\"-a\"\n"
17567 " guestfish[4]=\"disk.img\"\n"
17572 #: ../fish/guestfish.pod:992
17575 " GUESTFISH_PID=\n"
17576 " eval $(\"${guestfish[@]}\")\n"
17577 " if [ -z \"$GUESTFISH_PID\" ]; then\n"
17578 " echo \"error: guestfish didn't start up, see error messages above\"\n"
17585 #: ../fish/guestfish.pod:999
17588 " cleanup_guestfish ()\n"
17590 " guestfish --remote -- exit >/dev/null 2>&1 ||:\n"
17592 " trap cleanup_guestfish EXIT ERR\n"
17597 #: ../fish/guestfish.pod:1005
17600 " guestfish --remote -- run\n"
17605 #: ../fish/guestfish.pod:1007
17613 #: ../fish/guestfish.pod:1009
17614 msgid "REMOTE CONTROL RUN COMMAND HANGING"
17618 #: ../fish/guestfish.pod:1011
17620 "Using the C<run> (or C<launch>) command remotely in a command substitution "
17621 "context hangs, ie. don't do (note the backquotes):"
17625 #: ../fish/guestfish.pod:1014
17628 " a=`guestfish --remote run`\n"
17633 #: ../fish/guestfish.pod:1016
17635 "Since the C<run> command produces no output on stdout, this is not useful "
17636 "anyway. For further information see "
17637 "L<https://bugzilla.redhat.com/show_bug.cgi?id=592910>."
17641 #: ../fish/guestfish.pod:1020
17642 msgid "PREPARED DISK IMAGES"
17646 #: ../fish/guestfish.pod:1022
17648 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
17649 "preformatted disk images that guestfish can make for you to save typing. "
17650 "This is particularly useful for testing purposes. This option is used "
17651 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
17652 "can be mixed with I<-a>)."
17656 #: ../fish/guestfish.pod:1028
17658 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
17659 "the second and so on. Existing files in the current directory are "
17664 #: ../fish/guestfish.pod:1032
17666 "The type briefly describes how the disk should be sized, partitioned, how "
17667 "filesystem(s) should be created, and how content should be added. "
17668 "Optionally the type can be followed by extra parameters, separated by C<:> "
17669 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
17670 "sparsely-allocated disk, containing a single partition, with the partition "
17671 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
17672 "on a 1GB disk instead."
17676 #: ../fish/guestfish.pod:1040
17677 msgid "To list the available types and any extra parameters they take, run:"
17681 #: ../fish/guestfish.pod:1044
17683 "Note that the prepared filesystem is not mounted. You would usually have to "
17684 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
17688 #: ../fish/guestfish.pod:1048
17690 "If any I<-N> or I<--new> options are given, the guest is automatically "
17695 #: ../fish/guestfish.pod:1053
17696 msgid "Create a 100MB disk with an ext4-formatted partition:"
17700 #: ../fish/guestfish.pod:1055
17703 " guestfish -N fs:ext4\n"
17708 #: ../fish/guestfish.pod:1057
17709 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
17713 #: ../fish/guestfish.pod:1059
17716 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
17721 #: ../fish/guestfish.pod:1061
17722 msgid "Create a blank 200MB disk:"
17726 #: ../fish/guestfish.pod:1063
17729 " guestfish -N disk:200M\n"
17734 #: ../fish/guestfish.pod:1065
17735 msgid "PROGRESS BARS"
17739 #: ../fish/guestfish.pod:1067
17741 "Some (not all) long-running commands send progress notification messages as "
17742 "they are running. Guestfish turns these messages into progress bars."
17746 #: ../fish/guestfish.pod:1071
17748 "When a command that supports progress bars takes longer than two seconds to "
17749 "run, and if progress bars are enabled, then you will see one appearing below "
17754 #: ../fish/guestfish.pod:1075
17757 " ><fs> copy-size /large-file /another-file 2048M\n"
17758 " / 10% [#####-----------------------------------------] 00:30\n"
17763 #: ../fish/guestfish.pod:1078
17765 "The spinner on the left hand side moves round once for every progress "
17766 "notification received from the backend. This is a (reasonably) golden "
17767 "assurance that the command is \"doing something\" even if the progress bar "
17768 "is not moving, because the command is able to send the progress "
17769 "notifications. When the bar reaches 100% and the command finishes, the "
17770 "spinner disappears."
17774 #: ../fish/guestfish.pod:1085
17776 "Progress bars are enabled by default when guestfish is used interactively. "
17777 "You can enable them even for non-interactive modes using I<--progress-bars>, "
17778 "and you can disable them completely using I<--no-progress-bars>."
17782 #: ../fish/guestfish.pod:1090
17783 msgid "GUESTFISH COMMANDS"
17787 #: ../fish/guestfish.pod:1092
17789 "The commands in this section are guestfish convenience commands, in other "
17790 "words, they are not part of the L<guestfs(3)> API."
17794 #: ../fish/guestfish.pod:1095
17799 #: ../fish/guestfish.pod:1097
17808 #: ../fish/guestfish.pod:1100
17809 msgid "Without any parameter, this provides general help."
17813 #: ../fish/guestfish.pod:1102
17814 msgid "With a C<cmd> parameter, this displays detailed help for that command."
17818 #: ../fish/guestfish.pod:1104
17819 msgid "quit | exit"
17823 #: ../fish/guestfish.pod:1106
17824 msgid "This exits guestfish. You can also use C<^D> key."
17828 #: ../fish/guestfish.pod:1108
17829 msgid "@FISH_COMMANDS@"
17833 #: ../fish/guestfish.pod:1110
17838 #: ../fish/guestfish.pod:1112 ../src/guestfs.pod:1497
17843 #: ../fish/guestfish.pod:1116
17845 "guestfish returns 0 if the commands completed without error, or 1 if there "
17850 #: ../fish/guestfish.pod:1123
17855 #: ../fish/guestfish.pod:1125
17857 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
17862 #: ../fish/guestfish.pod:1128 ../src/guestfs.pod:3089
17863 msgid "FEBOOTSTRAP_KERNEL"
17867 #: ../fish/guestfish.pod:1130 ../src/guestfs.pod:3091
17868 msgid "FEBOOTSTRAP_MODULES"
17872 #: ../fish/guestfish.pod:1132 ../src/guestfs.pod:3093
17874 "These two environment variables allow the kernel that libguestfs uses in the "
17875 "appliance to be selected. If C<$FEBOOTSTRAP_KERNEL> is not set, then the "
17876 "most recent host kernel is chosen. For more information about kernel "
17877 "selection, see L<febootstrap-supermin-helper(8)>. This feature is only "
17878 "available in febootstrap E<ge> 3.8."
17882 #: ../fish/guestfish.pod:1138
17883 msgid "GUESTFISH_DISPLAY_IMAGE"
17887 #: ../fish/guestfish.pod:1140
17889 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
17890 "If not set, it uses L<display(1)>."
17894 #: ../fish/guestfish.pod:1143
17895 msgid "GUESTFISH_PID"
17899 #: ../fish/guestfish.pod:1145
17901 "Used with the I<--remote> option to specify the remote guestfish process to "
17902 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
17906 #: ../fish/guestfish.pod:1149
17911 #: ../fish/guestfish.pod:1151
17913 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
17914 "not specified, the external L<hexedit(1)> program is used."
17918 #: ../fish/guestfish.pod:1155
17923 #: ../fish/guestfish.pod:1157
17925 "If compiled with GNU readline support, various files in the home directory "
17926 "can be used. See L</FILES>."
17930 #: ../fish/guestfish.pod:1160 ../src/guestfs.pod:3099
17931 msgid "LIBGUESTFS_APPEND"
17935 #: ../fish/guestfish.pod:1162 ../src/guestfs.pod:3101
17936 msgid "Pass additional options to the guest kernel."
17940 #: ../fish/guestfish.pod:1164 ../src/guestfs.pod:3103
17941 msgid "LIBGUESTFS_DEBUG"
17945 #: ../fish/guestfish.pod:1166
17947 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
17948 "effect as using the B<-v> option."
17952 #: ../fish/guestfish.pod:1169 ../src/guestfs.pod:3108
17953 msgid "LIBGUESTFS_MEMSIZE"
17957 #: ../fish/guestfish.pod:1171 ../src/guestfs.pod:3110
17958 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
17962 #: ../fish/guestfish.pod:1174 ../src/guestfs.pod:3113
17965 " LIBGUESTFS_MEMSIZE=700\n"
17970 #: ../fish/guestfish.pod:1176 ../src/guestfs.pod:3115
17971 msgid "LIBGUESTFS_PATH"
17975 #: ../fish/guestfish.pod:1178
17977 "Set the path that guestfish uses to search for kernel and initrd.img. See "
17978 "the discussion of paths in L<guestfs(3)>."
17982 #: ../fish/guestfish.pod:1181 ../src/guestfs.pod:3120
17983 msgid "LIBGUESTFS_QEMU"
17987 #: ../fish/guestfish.pod:1183 ../src/guestfs.pod:3122
17989 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
17990 "which was found at compile time by the configure script is used."
17994 #: ../fish/guestfish.pod:1187 ../src/guestfs.pod:3128
17995 msgid "LIBGUESTFS_TRACE"
17999 #: ../fish/guestfish.pod:1189
18000 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
18004 #: ../fish/guestfish.pod:1191
18009 #: ../fish/guestfish.pod:1193
18011 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
18016 #: ../fish/guestfish.pod:1196 ../src/guestfs.pod:3133
18021 #: ../fish/guestfish.pod:1198 ../src/guestfs.pod:3135
18023 "Location of temporary directory, defaults to C</tmp> except for the cached "
18024 "supermin appliance which defaults to C</var/tmp>."
18028 #: ../fish/guestfish.pod:1201 ../src/guestfs.pod:3138
18030 "If libguestfs was compiled to use the supermin appliance then the real "
18031 "appliance is cached in this directory, shared between all handles belonging "
18032 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
18033 "use in case C</var/tmp> is not large enough."
18037 #: ../fish/guestfish.pod:1209 ../fuse/guestmount.pod:297 ../rescue/virt-rescue.pod:269
18042 #: ../fish/guestfish.pod:1213 ../fuse/guestmount.pod:301 ../rescue/virt-rescue.pod:273
18043 msgid "$HOME/.libguestfs-tools.rc"
18047 #: ../fish/guestfish.pod:1215 ../fuse/guestmount.pod:303 ../rescue/virt-rescue.pod:275
18048 msgid "/etc/libguestfs-tools.conf"
18052 #: ../fish/guestfish.pod:1217 ../fuse/guestmount.pod:305 ../rescue/virt-rescue.pod:277
18054 "This configuration file controls the default read-only or read-write mode "
18055 "(I<--ro> or I<--rw>)."
18059 #: ../fish/guestfish.pod:1220
18060 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
18064 #: ../fish/guestfish.pod:1222
18065 msgid "$HOME/.guestfish"
18069 #: ../fish/guestfish.pod:1224
18071 "If compiled with GNU readline support, then the command history is saved in "
18076 #: ../fish/guestfish.pod:1227
18077 msgid "$HOME/.inputrc"
18081 #: ../fish/guestfish.pod:1229
18082 msgid "/etc/inputrc"
18086 #: ../fish/guestfish.pod:1231
18088 "If compiled with GNU readline support, then these files can be used to "
18089 "configure readline. For further information, please see "
18090 "L<readline(3)/INITIALIZATION FILE>."
18094 #: ../fish/guestfish.pod:1235
18095 msgid "To write rules which only apply to guestfish, use:"
18099 #: ../fish/guestfish.pod:1237
18109 #: ../fish/guestfish.pod:1241
18111 "Variables that you can set in inputrc that change the behaviour of guestfish "
18112 "in useful ways include:"
18116 #: ../fish/guestfish.pod:1246
18117 msgid "completion-ignore-case (default: on)"
18121 #: ../fish/guestfish.pod:1248
18123 "By default, guestfish will ignore case when tab-completing paths on the "
18128 #: ../fish/guestfish.pod:1251
18131 " set completion-ignore-case off\n"
18136 #: ../fish/guestfish.pod:1253
18137 msgid "to make guestfish case sensitive."
18141 #: ../fish/guestfish.pod:1257
18146 #: ../fish/guestfish.pod:1259
18147 msgid "test2.img (etc)"
18151 #: ../fish/guestfish.pod:1261
18153 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
18154 "will be created in the file C<test1.img> in the current directory. The "
18155 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
18156 "the same name will be overwritten."
18160 #: ../fish/guestfish.pod:1270
18162 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
18163 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
18164 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
18165 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
18166 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
18167 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<display(1)>, L<hexedit(1)>, "
18168 "L<febootstrap-supermin-helper(8)>."
18172 #: ../fish/guestfish.pod:1299 ../src/guestfs.pod:3225 ../test-tool/libguestfs-test-tool.pod:112
18173 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
18177 #: ../fish/virt-copy-in.pod:5
18178 msgid "virt-copy-in - Copy files and directories into a virtual machine disk image."
18182 #: ../fish/virt-copy-in.pod:9
18185 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
18190 #: ../fish/virt-copy-in.pod:11
18193 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
18198 #: ../fish/virt-copy-in.pod:15
18200 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
18201 "causing disk corruption. The virtual machine must be shut down before you "
18202 "use this command."
18206 #: ../fish/virt-copy-in.pod:21
18208 "C<virt-copy-in> copies files and directories from the local disk into a "
18209 "virtual machine disk image or named libvirt domain."
18213 #: ../fish/virt-copy-in.pod:24
18215 "You can give one of more filenames and directories on the command line. "
18216 "Directories are copied in recursively. The final parameter must be the "
18217 "destination directory in the disk image which must be an absolute path "
18218 "starting with a C</> character."
18222 #: ../fish/virt-copy-in.pod:33
18225 " virt-copy-in -d MyGuest resolv.conf /etc\n"
18230 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
18231 msgid "Upload a home directory to a guest:"
18235 #: ../fish/virt-copy-in.pod:37
18238 " virt-copy-in -d MyGuest skel /home\n"
18243 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28 ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
18244 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
18248 #: ../fish/virt-copy-in.pod:41
18250 "This command is just a simple shell script wrapper around the "
18251 "L<guestfish(1)> C<copy-in> command. For anything more complex than a "
18252 "trivial copy, you are probably better off using guestfish directly."
18256 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36 ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
18258 "Since the shell script just passes options straight to guestfish, read "
18259 "L<guestfish(1)> to see the full list of options."
18263 #: ../fish/virt-copy-in.pod:52
18265 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
18266 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18270 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55 ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
18271 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
18275 #: ../fish/virt-copy-out.pod:5
18277 "virt-copy-out - Copy files and directories out of a virtual machine disk "
18282 #: ../fish/virt-copy-out.pod:9
18285 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
18290 #: ../fish/virt-copy-out.pod:11
18293 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
18298 #: ../fish/virt-copy-out.pod:15
18300 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
18301 "image or named libvirt domain."
18305 #: ../fish/virt-copy-out.pod:18
18307 "You can give one of more filenames and directories on the command line. "
18308 "Directories are copied out recursively."
18312 #: ../fish/virt-copy-out.pod:23
18313 msgid "Download the home directories from a virtual machine:"
18317 #: ../fish/virt-copy-out.pod:25
18321 " virt-copy-out -d MyGuest /home homes\n"
18326 #: ../fish/virt-copy-out.pod:30
18328 "This command is just a simple shell script wrapper around the "
18329 "L<guestfish(1)> C<copy-out> command. For anything more complex than a "
18330 "trivial copy, you are probably better off using guestfish directly."
18334 #: ../fish/virt-copy-out.pod:41
18336 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, "
18337 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18341 #: ../fish/virt-tar-in.pod:5
18342 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
18346 #: ../fish/virt-tar-in.pod:9
18349 " virt-tar-in -a disk.img data.tar /destination\n"
18354 #: ../fish/virt-tar-in.pod:11
18357 " virt-tar-in -d domain data.tar /destination\n"
18362 #: ../fish/virt-tar-in.pod:13
18365 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
18370 #: ../fish/virt-tar-in.pod:17
18372 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
18373 "causing disk corruption. The virtual machine must be shut down before you "
18374 "use this command."
18378 #: ../fish/virt-tar-in.pod:23
18380 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
18381 "image or named libvirt domain."
18385 #: ../fish/virt-tar-in.pod:26
18387 "The first parameter is the tar file. Use C<-> to read the tar file from "
18388 "standard input. The second parameter is the absolute target directory to "
18393 #: ../fish/virt-tar-in.pod:34
18396 " virt-tar-in -d MyGuest homes.tar /home\n"
18401 #: ../fish/virt-tar-in.pod:38
18403 "This command is just a simple shell script wrapper around the "
18404 "L<guestfish(1)> C<tar-in> command. For anything more complex than a trivial "
18405 "copy, you are probably better off using guestfish directly."
18409 #: ../fish/virt-tar-in.pod:49
18411 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18412 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, "
18413 "L<http://libguestfs.org/>."
18417 #: ../fish/virt-tar-out.pod:5
18418 msgid "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
18422 #: ../fish/virt-tar-out.pod:9
18425 " virt-tar-out -a disk.img /dir files.tar\n"
18430 #: ../fish/virt-tar-out.pod:11
18433 " virt-tar-out -d domain /dir files.tar\n"
18438 #: ../fish/virt-tar-out.pod:13
18441 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
18446 #: ../fish/virt-tar-out.pod:17
18447 msgid "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
18451 #: ../fish/virt-tar-out.pod:20
18453 "The first parameter is the absolute path of the virtual machine directory. "
18454 "The second parameter is the tar file to write. Use C<-> to write to "
18459 #: ../fish/virt-tar-out.pod:26
18460 msgid "Download the home directories from a guest:"
18464 #: ../fish/virt-tar-out.pod:28
18467 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
18472 #: ../fish/virt-tar-out.pod:32
18474 "This command is just a simple shell script wrapper around the "
18475 "L<guestfish(1)> C<tar-out> command. For anything more complex than a "
18476 "trivial copy, you are probably better off using guestfish directly."
18480 #: ../fish/virt-tar-out.pod:43
18482 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18483 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
18487 #: ../fuse/guestmount.pod:5
18488 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
18492 #: ../fuse/guestmount.pod:9
18495 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
18500 #: ../fuse/guestmount.pod:11
18503 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
18508 #: ../fuse/guestmount.pod:13
18511 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
18516 #: ../fuse/guestmount.pod:17
18518 "You must I<not> use C<guestmount> in read-write mode on live virtual "
18519 "machines. If you do this, you risk disk corruption in the VM."
18523 #: ../fuse/guestmount.pod:22
18525 "The guestmount program can be used to mount virtual machine filesystems and "
18526 "other disk images on the host. It uses libguestfs for access to the guest "
18527 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
18528 "a mountable device."
18532 #: ../fuse/guestmount.pod:27
18534 "Along with other options, you have to give at least one device (I<-a> "
18535 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
18536 "option) or use the I<-i> inspection option. How this works is better "
18537 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
18542 #: ../fuse/guestmount.pod:33
18544 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
18545 "by you, and the filesystem will not be visible to any other users unless you "
18546 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
18547 "the filesystem, use the C<fusermount -u> command."
18551 #: ../fuse/guestmount.pod:41
18553 "For a typical Windows guest which has its main filesystem on the first "
18558 #: ../fuse/guestmount.pod:44
18561 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
18566 #: ../fuse/guestmount.pod:46
18568 "For a typical Linux guest which has a /boot filesystem on the first "
18569 "partition, and the root filesystem on a logical volume:"
18573 #: ../fuse/guestmount.pod:49
18576 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
18581 #: ../fuse/guestmount.pod:51
18582 msgid "To get libguestfs to detect guest mountpoints for you:"
18586 #: ../fuse/guestmount.pod:53
18589 " guestmount -a guest.img -i --ro /mnt\n"
18594 #: ../fuse/guestmount.pod:55
18595 msgid "For a libvirt guest called \"Guest\" you could do:"
18599 #: ../fuse/guestmount.pod:57
18602 " guestmount -d Guest -i --ro /mnt\n"
18607 #: ../fuse/guestmount.pod:59
18609 "If you don't know what filesystems are contained in a guest or disk image, "
18610 "use L<virt-filesystems(1)> first:"
18614 #: ../fuse/guestmount.pod:62
18617 " virt-filesystems MyGuest\n"
18622 #: ../fuse/guestmount.pod:64
18624 "If you want to trace the libguestfs calls but without excessive debugging "
18625 "information, we recommend:"
18629 #: ../fuse/guestmount.pod:67
18632 " guestmount [...] --trace /mnt\n"
18637 #: ../fuse/guestmount.pod:69
18638 msgid "If you want to debug the program, we recommend:"
18642 #: ../fuse/guestmount.pod:71
18645 " guestmount [...] --trace --verbose /mnt\n"
18650 #: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:68 ../resize/virt-resize.pod:511
18655 #: ../fuse/guestmount.pod:75
18656 msgid "Other users cannot see the filesystem by default"
18660 #: ../fuse/guestmount.pod:77
18662 "If you mount a filesystem as one user (eg. root), then other users will not "
18663 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
18664 "option when mounting:"
18668 #: ../fuse/guestmount.pod:81
18671 " sudo guestmount [...] -o allow_other /mnt\n"
18676 #: ../fuse/guestmount.pod:83
18677 msgid "Enabling FUSE"
18681 #: ../fuse/guestmount.pod:85
18683 "On some distros, you may need to add yourself to a special group "
18684 "(eg. C<fuse>) before you can use any FUSE filesystem. This is necessary on "
18685 "Debian and derivatives."
18689 #: ../fuse/guestmount.pod:89
18691 "On other distros, no special group is required. It is not necessary on "
18692 "Fedora or Red Hat Enterprise Linux."
18696 #: ../fuse/guestmount.pod:100
18697 msgid "Add a block device or virtual machine image."
18701 #: ../fuse/guestmount.pod:123
18702 msgid "B<--dir-cache-timeout N>"
18706 #: ../fuse/guestmount.pod:125
18708 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
18709 "seconds. The readdir cache [actually, there are several semi-independent "
18710 "caches] is populated after a readdir(2) call with the stat and extended "
18711 "attributes of the files in the directory, in anticipation that they will be "
18712 "requested soon after."
18716 #: ../fuse/guestmount.pod:131
18718 "There is also a different attribute cache implemented by FUSE (see the FUSE "
18719 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
18720 "requests, only cache existing ones."
18724 #: ../fuse/guestmount.pod:151
18726 "If you have untrusted raw-format guest disk images, you should use this "
18727 "option to specify the disk format. This avoids a possible security problem "
18728 "with malicious guests (CVE-2010-3851). See also "
18729 "L<guestfs(3)/guestfs_add_drive_opts>."
18733 #: ../fuse/guestmount.pod:156
18734 msgid "B<--fuse-help>"
18738 #: ../fuse/guestmount.pod:158
18739 msgid "Display help on special FUSE options (see I<-o> below)."
18743 #: ../fuse/guestmount.pod:162
18744 msgid "Display brief help and exit."
18748 #: ../fuse/guestmount.pod:186
18750 "Mount the named partition or logical volume on the given mountpoint B<in the "
18751 "guest> (this has nothing to do with mountpoints in the host)."
18755 #: ../fuse/guestmount.pod:189
18757 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
18758 "something on C</>."
18762 #: ../fuse/guestmount.pod:206
18764 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
18765 "unmounted. If you specify this option, then we don't attempt to sync the "
18766 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
18770 #: ../fuse/guestmount.pod:211
18771 msgid "B<-o option>"
18775 #: ../fuse/guestmount.pod:213
18776 msgid "B<--option option>"
18780 #: ../fuse/guestmount.pod:215
18781 msgid "Pass extra options to FUSE."
18785 #: ../fuse/guestmount.pod:217
18787 "To get a list of all the extra options supported by FUSE, use the command "
18788 "below. Note that only the FUSE I<-o> options can be passed, and only some "
18789 "of them are a good idea."
18793 #: ../fuse/guestmount.pod:221
18796 " guestmount --fuse-help\n"
18801 #: ../fuse/guestmount.pod:223
18802 msgid "Some potentially useful FUSE options:"
18806 #: ../fuse/guestmount.pod:227
18807 msgid "B<-o allow_other>"
18811 #: ../fuse/guestmount.pod:229
18812 msgid "Allow other users to see the filesystem."
18816 #: ../fuse/guestmount.pod:231
18817 msgid "B<-o attr_timeout=N>"
18821 #: ../fuse/guestmount.pod:233
18822 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
18826 #: ../fuse/guestmount.pod:235
18827 msgid "B<-o kernel_cache>"
18831 #: ../fuse/guestmount.pod:237
18833 "Allow the kernel to cache files (reduces the number of reads that have to go "
18834 "through the L<guestfs(3)> API). This is generally a good idea if you can "
18835 "afford the extra memory usage."
18839 #: ../fuse/guestmount.pod:241
18840 msgid "B<-o uid=N> B<-o gid=N>"
18844 #: ../fuse/guestmount.pod:243
18846 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
18847 "the chosen values."
18851 #: ../fuse/guestmount.pod:252
18853 "Add devices and mount everything read-only. Also disallow writes and make "
18854 "the disk appear read-only to FUSE."
18858 #: ../fuse/guestmount.pod:255
18860 "This is highly recommended if you are not going to edit the guest disk. If "
18861 "the guest is running and this option is I<not> supplied, then there is a "
18862 "strong risk of disk corruption in the guest. We try to prevent this from "
18863 "happening, but it is not always possible."
18867 #: ../fuse/guestmount.pod:260 ../rescue/virt-rescue.pod:171
18868 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
18872 #: ../fuse/guestmount.pod:264
18873 msgid "Enable SELinux support for the guest."
18877 #: ../fuse/guestmount.pod:270
18878 msgid "Enable verbose messages from underlying libguestfs."
18882 #: ../fuse/guestmount.pod:276
18883 msgid "Display the program version and exit."
18887 #: ../fuse/guestmount.pod:285 ../fuse/guestmount.pod:308 ../rescue/virt-rescue.pod:197 ../rescue/virt-rescue.pod:280
18888 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
18892 #: ../fuse/guestmount.pod:289
18897 #: ../fuse/guestmount.pod:291
18898 msgid "Trace libguestfs calls and entry into each FUSE function."
18902 #: ../fuse/guestmount.pod:293
18903 msgid "This also stops the daemon from forking into the background."
18907 #: ../fuse/guestmount.pod:319
18909 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
18910 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
18911 "L<http://fuse.sf.net/>."
18915 #: ../fuse/guestmount.pod:334
18916 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
18920 #: ../inspector/virt-inspector.pod:5
18922 "virt-inspector - Display operating system version and other information "
18923 "about a virtual machine"
18927 #: ../inspector/virt-inspector.pod:9
18930 " virt-inspector [--options] -d domname\n"
18935 #: ../inspector/virt-inspector.pod:11
18938 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
18943 #: ../inspector/virt-inspector.pod:15
18946 " virt-inspector domname\n"
18951 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:141
18954 " virt-inspector disk.img [disk.img ...]\n"
18959 #: ../inspector/virt-inspector.pod:21
18961 "B<virt-inspector> examines a virtual machine or disk image and tries to "
18962 "determine the version of the operating system and other information about "
18963 "the virtual machine."
18967 #: ../inspector/virt-inspector.pod:25
18968 msgid "Virt-inspector produces XML output for feeding into other programs."
18972 #: ../inspector/virt-inspector.pod:27
18974 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
18975 "the libvirt domain (see: C<virsh list --all>)."
18979 #: ../inspector/virt-inspector.pod:30
18981 "You can also run virt-inspector directly on disk images from a single "
18982 "virtual machine. Use C<virt-inspector -a disk.img>. In rare cases a domain "
18983 "has several block devices, in which case you should list several I<-a> "
18984 "options one after another, with the first corresponding to the guest's "
18985 "C</dev/sda>, the second to the guest's C</dev/sdb> and so on."
18989 #: ../inspector/virt-inspector.pod:37
18991 "You can also run virt-inspector on install disks, live CDs, bootable USB "
18992 "keys and similar."
18996 #: ../inspector/virt-inspector.pod:40
18998 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
18999 "inspect several virtual machines, you have to run virt-inspector several "
19000 "times (for example, from a shell script for-loop)."
19004 #: ../inspector/virt-inspector.pod:45
19006 "Because virt-inspector needs direct access to guest images, it won't "
19007 "normally work over remote libvirt connections."
19011 #: ../inspector/virt-inspector.pod:48
19013 "All of the information available from virt-inspector is also available "
19014 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>). "
19015 "The same information can also be fetched using guestfish or via libguestfs "
19016 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
19017 "WITH OTHER PROGRAMMING LANGUAGES>)."
19021 #: ../inspector/virt-inspector.pod:81
19023 "Libvirt is only used if you specify a C<domname> on the command line. If "
19024 "you specify guest block devices directly (I<-a>), then libvirt is not used "
19029 #: ../inspector/virt-inspector.pod:94
19031 "When prompting for keys and passphrases, virt-inspector normally turns "
19032 "echoing off so you cannot see what you are typing. If you are not worried "
19033 "about Tempest attacks and there is no one else in the room you can specify "
19034 "this flag to see what you are typing."
19038 #: ../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
19040 "Specify the format of disk images given on the command line. If this is "
19041 "omitted then the format is autodetected from the content of the disk image."
19045 #: ../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
19047 "If disk images are requested from libvirt, then this program asks libvirt "
19048 "for this information. In this case, the value of the format parameter is "
19053 #: ../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
19055 "If working with untrusted raw-format guest disk images, you should ensure "
19056 "the format is always specified."
19060 #: ../inspector/virt-inspector.pod:139
19061 msgid "Previous versions of virt-inspector allowed you to write either:"
19065 #: ../inspector/virt-inspector.pod:145
19068 " virt-inspector guestname\n"
19073 #: ../inspector/virt-inspector.pod:153
19078 #: ../inspector/virt-inspector.pod:155
19080 "The virt-inspector XML is described precisely in a RELAX NG schema file "
19081 "C<virt-inspector.rng> which is supplied with libguestfs. This section is "
19082 "just an overview."
19086 #: ../inspector/virt-inspector.pod:159
19088 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
19089 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
19090 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
19091 "which is vanishingly rare in real world VMs."
19095 #: ../inspector/virt-inspector.pod:164
19096 msgid "E<lt>operatingsystemE<gt>"
19100 #: ../inspector/virt-inspector.pod:166
19102 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
19103 "describe the operating system, its architecture, the descriptive \"product "
19104 "name\" string, the type of OS and so on, as in this example:"
19108 #: ../inspector/virt-inspector.pod:170
19111 " <operatingsystems>\n"
19112 " <operatingsystem>\n"
19113 " <root>/dev/sda2</root>\n"
19114 " <name>windows</name>\n"
19115 " <arch>i386</arch>\n"
19116 " <distro>windows</distro>\n"
19117 " <product_name>Windows 7 Enterprise</product_name>\n"
19118 " <product_variant>Client</product_variant>\n"
19119 " <major_version>6</major_version>\n"
19120 " <minor_version>1</minor_version>\n"
19121 " <windows_systemroot>/Windows</windows_systemroot>\n"
19122 " <format>installed</format>\n"
19127 #: ../inspector/virt-inspector.pod:183
19129 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
19130 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
19131 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
19132 "architecture. The other fields are fairly self-explanatory, but because "
19133 "these fields are taken directly from the libguestfs inspection API you can "
19134 "find precise information from L<guestfs(3)/INSPECTION>."
19138 #: ../inspector/virt-inspector.pod:191
19140 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
19141 "of view of libguestfs (block devices may have completely different names "
19142 "inside the VM itself)."
19146 #: ../inspector/virt-inspector.pod:195
19147 msgid "E<lt>mountpointsE<gt>"
19151 #: ../inspector/virt-inspector.pod:197
19153 "Un*x-like guests typically have multiple filesystems which are mounted at "
19154 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
19155 "element which looks like this:"
19159 #: ../inspector/virt-inspector.pod:201
19162 " <operatingsystems>\n"
19163 " <operatingsystem>\n"
19166 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
19167 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
19168 " </mountpoints>\n"
19173 #: ../inspector/virt-inspector.pod:209
19175 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
19176 "and may have completely different names inside the guest. Only mountable "
19177 "filesystems appear in this list, not things like swap devices."
19181 #: ../inspector/virt-inspector.pod:214
19182 msgid "E<lt>filesystemsE<gt>"
19186 #: ../inspector/virt-inspector.pod:216
19188 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
19189 "filesystems belonging to the guest, including swap and empty partitions. "
19190 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
19191 "this OS or shared with this OS and other OSes)."
19195 #: ../inspector/virt-inspector.pod:222
19196 msgid "You might see something like this:"
19200 #: ../inspector/virt-inspector.pod:224
19203 " <operatingsystems>\n"
19204 " <operatingsystem>\n"
19207 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19208 " <type>ext4</type>\n"
19209 " <label>Fedora-13-x86_64</label>\n"
19210 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
19216 #: ../inspector/virt-inspector.pod:234
19218 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
19219 "the label, and the UUID."
19223 #: ../inspector/virt-inspector.pod:237
19224 msgid "E<lt>applicationsE<gt>"
19228 #: ../inspector/virt-inspector.pod:239
19230 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
19231 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
19236 #: ../inspector/virt-inspector.pod:243
19238 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
19239 "Typical values would be C<rpm> and C<deb>."
19243 #: ../inspector/virt-inspector.pod:246
19245 "E<lt>package_managementE<gt>, if present, describes the package manager. "
19246 "Typical values include C<yum>, C<up2date> and C<apt>"
19250 #: ../inspector/virt-inspector.pod:249
19251 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
19255 #: ../inspector/virt-inspector.pod:252
19258 " <operatingsystems>\n"
19259 " <operatingsystem>\n"
19261 " <applications>\n"
19263 " <name>coreutils</name>\n"
19264 " <version>8.5</version>\n"
19265 " <release>1</release>\n"
19266 " </application>\n"
19271 #: ../inspector/virt-inspector.pod:262
19273 "The version and release fields may not be available for some types guests. "
19274 "Other fields are possible, see "
19275 "L<guestfs(3)/guestfs_inspect_list_applications>."
19279 #: ../inspector/virt-inspector.pod:266
19280 msgid "E<lt>drive_mappingsE<gt>"
19284 #: ../inspector/virt-inspector.pod:268
19286 "For operating systems like Windows which use drive letters, virt-inspector "
19287 "is able to find out how drive letters map to filesystems."
19291 #: ../inspector/virt-inspector.pod:272
19294 " <operatingsystems>\n"
19295 " <operatingsystem>\n"
19297 " <drive_mappings>\n"
19298 " <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
19299 " <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
19300 " </drive_mappings>\n"
19305 #: ../inspector/virt-inspector.pod:280
19307 "In the example above, drive C maps to the filesystem on the second partition "
19308 "on the first disk, and drive E maps to the filesystem on the first partition "
19309 "on the second disk."
19313 #: ../inspector/virt-inspector.pod:284
19315 "Note that this only covers permanent local filesystem mappings, not things "
19316 "like network shares. Furthermore NTFS volume mount points may not be listed "
19321 #: ../inspector/virt-inspector.pod:288
19322 msgid "E<lt>iconE<gt>"
19326 #: ../inspector/virt-inspector.pod:290
19328 "Virt-inspector is sometimes able to extract an icon or logo for the guest. "
19329 "The icon is returned as base64-encoded PNG data. Note that the icon can be "
19330 "very large and high quality."
19334 #: ../inspector/virt-inspector.pod:294
19337 " <operatingsystems>\n"
19338 " <operatingsystem>\n"
19341 " iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
19342 " [... many lines of base64 data ...]\n"
19348 #: ../inspector/virt-inspector.pod:302
19350 "To display the icon, you have to extract it and convert the base64 data back "
19351 "to a binary file. Use an XPath query or simply an editor to extract the "
19352 "data, then use the coreutils L<base64(1)> program to do the conversion back "
19357 #: ../inspector/virt-inspector.pod:307
19360 " base64 -i -d < icon.data > icon.png\n"
19365 #: ../inspector/virt-inspector.pod:309
19366 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
19370 #: ../inspector/virt-inspector.pod:311
19372 "Virt-inspector can detect some operating system installers on install disks, "
19373 "live CDs, bootable USB keys and more."
19377 #: ../inspector/virt-inspector.pod:314
19379 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
19380 "fields may be present to indicate a live CD, network installer, or one part "
19381 "of a multipart CD. For example:"
19385 #: ../inspector/virt-inspector.pod:318
19388 " <operatingsystems>\n"
19389 " <operatingsystem>\n"
19390 " <root>/dev/sda</root>\n"
19391 " <name>linux</name>\n"
19392 " <arch>i386</arch>\n"
19393 " <distro>ubuntu</distro>\n"
19394 " <product_name>Ubuntu 10.10 "Maverick "
19395 "Meerkat"</product_name>\n"
19396 " <major_version>10</major_version>\n"
19397 " <minor_version>10</minor_version>\n"
19398 " <format>installer</format>\n"
19404 #: ../inspector/virt-inspector.pod:330
19405 msgid "USING XPATH"
19409 #: ../inspector/virt-inspector.pod:332
19411 "You can use the XPath query language to select parts of the XML. We "
19412 "recommend using C<xmlstarlet> to perform XPath queries from the command "
19417 #: ../inspector/virt-inspector.pod:338
19420 " $ virt-inspector -d Guest | xmlstarlet sel -t -c '//filesystems'\n"
19422 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19423 " <type>ext4</type>\n"
19429 #: ../inspector/virt-inspector.pod:344
19432 " $ virt-inspector -d Guest | \\\n"
19433 " xmlstarlet sel -t -c \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
19439 #: ../inspector/virt-inspector.pod:348
19442 " $ virt-inspector -d Guest | \\\n"
19443 " xmlstarlet sel -t -v '//icon' | base64 -i -d | display -\n"
19444 " [displays the guest icon, if there is one]\n"
19449 #: ../inspector/virt-inspector.pod:359
19450 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
19454 #: ../inspector/virt-inspector.pod:361
19456 "Early versions of libguestfs shipped with a different virt-inspector program "
19457 "written in Perl (the current version is written in C). The XML output of "
19458 "the Perl virt-inspector was different and it could also output in other "
19459 "formats like text."
19463 #: ../inspector/virt-inspector.pod:366
19464 msgid "The old virt-inspector is no longer supported or shipped with libguestfs."
19468 #: ../inspector/virt-inspector.pod:369
19470 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
19471 "versions of virt-inspector with different names:"
19475 #: ../inspector/virt-inspector.pod:372
19478 " virt-inspector Old Perl version.\n"
19479 " virt-inspector2 New C version.\n"
19484 #: ../inspector/virt-inspector.pod:382
19486 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, "
19487 "L<base64(1)>, L<xmlstarlet(1)>, L<http://libguestfs.org/>."
19491 #: ../inspector/virt-inspector.pod:399
19492 msgid "Matthew Booth L<mbooth@redhat.com>"
19496 #: ../java/examples/guestfs-java.pod:5
19497 msgid "guestfs-java - How to use libguestfs from Java"
19501 #: ../java/examples/guestfs-java.pod:9
19504 " import com.redhat.et.libguestfs.*;\n"
19509 #: ../java/examples/guestfs-java.pod:11
19512 " GuestFS g = new GuestFS ();\n"
19513 " g.add_drive_opts (\"disk.img\", null);\n"
19519 #: ../java/examples/guestfs-java.pod:17
19521 "This manual page documents how to call libguestfs from the Java programming "
19522 "language. This page just documents the differences from the C API and gives "
19523 "some examples. If you are not familiar with using libguestfs, you also need "
19524 "to read L<guestfs(3)>."
19528 #: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
19529 msgid "CLOSING THE HANDLE"
19533 #: ../java/examples/guestfs-java.pod:24
19535 "The handle is closed when it is reaped by the garbage collector. Because "
19536 "libguestfs handles include a lot of state, it is also possible to close (and "
19537 "hence free) them explicitly by calling the C<close> method."
19541 #: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60 ../python/examples/guestfs-python.pod:21 ../ruby/examples/guestfs-ruby.pod:22
19546 #: ../java/examples/guestfs-java.pod:31
19548 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
19549 "exception. This has a single parameter which is the error message (a "
19554 #: ../java/examples/guestfs-java.pod:35
19555 msgid "Calling any method on a closed handle raises the same exception."
19559 #: ../java/examples/guestfs-java.pod:47
19561 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, "
19562 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
19563 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>, L<http://caml.inria.fr/>."
19567 #: ../java/examples/guestfs-java.pod:63 ../perl/examples/guestfs-perl.pod:57
19568 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
19572 #: ../ocaml/examples/guestfs-ocaml.pod:5
19573 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
19577 #: ../ocaml/examples/guestfs-ocaml.pod:9
19578 msgid "Module style:"
19582 #: ../ocaml/examples/guestfs-ocaml.pod:11
19585 " let g = Guestfs.create () in\n"
19586 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
19587 " Guestfs.launch g;\n"
19592 #: ../ocaml/examples/guestfs-ocaml.pod:15
19593 msgid "Object-oriented style:"
19597 #: ../ocaml/examples/guestfs-ocaml.pod:17
19600 " let g = new Guestfs.guestfs () in\n"
19601 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
19607 #: ../ocaml/examples/guestfs-ocaml.pod:21
19610 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
19612 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
19617 #: ../ocaml/examples/guestfs-ocaml.pod:27
19619 "This manual page documents how to call libguestfs from the OCaml programming "
19620 "language. This page just documents the differences from the C API and gives "
19621 "some examples. If you are not familiar with using libguestfs, you also need "
19622 "to read L<guestfs(3)>."
19626 #: ../ocaml/examples/guestfs-ocaml.pod:32
19627 msgid "PROGRAMMING STYLES"
19631 #: ../ocaml/examples/guestfs-ocaml.pod:34
19633 "There are two different programming styles supported by the OCaml bindings. "
19634 "You can use a module style, with each C function mapped to an OCaml "
19639 #: ../ocaml/examples/guestfs-ocaml.pod:38
19642 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
19647 #: ../ocaml/examples/guestfs-ocaml.pod:40
19652 #: ../ocaml/examples/guestfs-ocaml.pod:42
19655 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
19660 #: ../ocaml/examples/guestfs-ocaml.pod:44
19662 "Alternately you can use an object-oriented style, calling methods on the "
19663 "class C<Guestfs.guestfs>:"
19667 #: ../ocaml/examples/guestfs-ocaml.pod:47
19670 " method set_verbose : bool -> unit\n"
19675 #: ../ocaml/examples/guestfs-ocaml.pod:49
19677 "The object-oriented style is usually briefer, and the minor performance "
19678 "penalty isn't noticable in the general overhead of performing libguestfs "
19683 #: ../ocaml/examples/guestfs-ocaml.pod:55
19685 "The handle is closed when it is reaped by the garbage collector. Because "
19686 "libguestfs handles include a lot of state, it is also possible to close (and "
19687 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
19692 #: ../ocaml/examples/guestfs-ocaml.pod:62
19694 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
19695 "exception. This has a single parameter which is the error message (a "
19700 #: ../ocaml/examples/guestfs-ocaml.pod:66
19702 "Calling any function/method on a closed handle raises "
19703 "C<Guestfs.Handle_closed>. The single parameter is the name of the function "
19708 #: ../ocaml/examples/guestfs-ocaml.pod:80
19710 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
19711 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
19712 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>, L<http://caml.inria.fr/>."
19716 #: ../perl/examples/guestfs-perl.pod:5
19717 msgid "guestfs-perl - How to use libguestfs from Perl"
19721 #: ../perl/examples/guestfs-perl.pod:9
19724 " use Sys::Guestfs;\n"
19729 #: ../perl/examples/guestfs-perl.pod:11
19732 " my $h = Sys::Guestfs->new ();\n"
19733 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
19734 " $h->launch ();\n"
19735 " $h->mount_options ('', '/dev/sda1', '/');\n"
19736 " $h->touch ('/hello');\n"
19742 #: ../perl/examples/guestfs-perl.pod:20
19744 "This manual page documents how to call libguestfs from the Perl programming "
19745 "language. This page just documents the differences from the C API and gives "
19746 "some examples. If you are not familiar with using libguestfs, you also need "
19747 "to read L<guestfs(3)>. To read the full Perl API, see L<Sys::Guestfs(3)>."
19751 #: ../perl/examples/guestfs-perl.pod:26
19756 #: ../perl/examples/guestfs-perl.pod:28
19758 "Errors from libguestfs functions turn into calls to C<croak> (see "
19763 #: ../perl/examples/guestfs-perl.pod:41
19765 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, "
19766 "L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
19767 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
19771 #: ../python/examples/guestfs-python.pod:5
19772 msgid "guestfs-python - How to use libguestfs from Python"
19776 #: ../python/examples/guestfs-python.pod:9
19779 " import guestfs\n"
19780 " g = guestfs.GuestFS ()\n"
19781 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
19787 #: ../python/examples/guestfs-python.pod:16
19789 "This manual page documents how to call libguestfs from the Python "
19790 "programming language. This page just documents the differences from the C "
19791 "API and gives some examples. If you are not familiar with using libguestfs, "
19792 "you also need to read L<guestfs(3)>."
19796 #: ../python/examples/guestfs-python.pod:23
19798 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
19799 "single string argument which is the error message."
19803 #: ../python/examples/guestfs-python.pod:26
19804 msgid "MORE DOCUMENTATION"
19808 #: ../python/examples/guestfs-python.pod:28
19813 #: ../python/examples/guestfs-python.pod:30
19817 " >>> import guestfs\n"
19818 " >>> help (guestfs)\n"
19823 #: ../python/examples/guestfs-python.pod:44
19825 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
19826 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-recipes(1)>, "
19827 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
19831 #: ../rescue/virt-rescue.pod:5
19832 msgid "virt-rescue - Run a rescue shell on a virtual machine"
19836 #: ../rescue/virt-rescue.pod:9
19839 " virt-rescue [--options] -d domname\n"
19844 #: ../rescue/virt-rescue.pod:11
19847 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
19852 #: ../rescue/virt-rescue.pod:15
19855 " virt-rescue [--options] domname\n"
19860 #: ../rescue/virt-rescue.pod:17
19863 " virt-rescue [--options] disk.img [disk.img ...]\n"
19868 #: ../rescue/virt-rescue.pod:21
19870 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
19871 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
19872 "you from doing this, but doesn't catch all cases."
19876 #: ../rescue/virt-rescue.pod:25
19878 "However if you use the I<--ro> (read only) option, then you can attach a "
19879 "shell to a live virtual machine. The results might be strange or "
19880 "inconsistent at times but you won't get disk corruption."
19884 #: ../rescue/virt-rescue.pod:31
19886 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
19887 "need for a CD. virt-rescue gives you a rescue shell and some simple "
19888 "recovery tools which you can use to examine or rescue a virtual machine or "
19893 #: ../rescue/virt-rescue.pod:36
19895 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
19896 "on disk image(s):"
19900 #: ../rescue/virt-rescue.pod:39
19903 " virt-rescue -d GuestName\n"
19908 #: ../rescue/virt-rescue.pod:41
19911 " virt-rescue --ro -a /path/to/disk.img\n"
19916 #: ../rescue/virt-rescue.pod:43
19919 " virt-rescue -a /dev/sdc\n"
19924 #: ../rescue/virt-rescue.pod:45
19925 msgid "For live VMs you I<must> use the --ro option."
19929 #: ../rescue/virt-rescue.pod:47
19931 "When you run virt-rescue on a virtual machine or disk image, you are placed "
19932 "in an interactive bash shell where you can use many ordinary Linux "
19933 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
19934 "appliance. You must mount the virtual machine's filesystems by hand. There "
19935 "is an empty directory called C</sysroot> where you can mount filesystems."
19939 #: ../rescue/virt-rescue.pod:54
19941 "In the example below, we list logical volumes, then choose one to mount "
19942 "under C</sysroot>:"
19946 #: ../rescue/virt-rescue.pod:57
19950 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
19951 " lv_root vg_f11x64 -wi-a- 8.83G\n"
19952 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
19953 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
19954 " ><rescue> ls /sysroot\n"
19959 #: ../rescue/virt-rescue.pod:64
19961 "If you don't know what filesystems are available on the virtual machine then "
19962 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
19966 #: ../rescue/virt-rescue.pod:70
19968 "Virt-rescue can be used on I<any> disk image file or device, not just a "
19969 "virtual machine. For example you can use it on a blank file if you want to "
19970 "partition that file (although we would recommend using L<guestfish(1)> "
19971 "instead as it is more suitable for this purpose). You can even use "
19972 "virt-rescue on things like SD cards."
19976 #: ../rescue/virt-rescue.pod:76
19978 "Virt-rescue does not require root. You only need to run it as root if you "
19979 "need root to open the disk image."
19983 #: ../rescue/virt-rescue.pod:79
19985 "This tool is just designed for quick interactive hacking on a virtual "
19986 "machine. For more structured access to a virtual machine disk image, you "
19987 "should use L<guestfs(3)>. To get a structured shell that you can use to "
19988 "make scripted changes to guests, use L<guestfish(1)>."
19992 #: ../rescue/virt-rescue.pod:103
19993 msgid "B<--append kernelopts>"
19997 #: ../rescue/virt-rescue.pod:105
19998 msgid "Pass additional options to the rescue kernel."
20002 #: ../rescue/virt-rescue.pod:135
20005 " virt-rescue --format=raw -a disk.img\n"
20010 #: ../rescue/virt-rescue.pod:139
20013 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
20018 #: ../rescue/virt-rescue.pod:148
20023 #: ../rescue/virt-rescue.pod:150
20024 msgid "B<--memsize MB>"
20028 #: ../rescue/virt-rescue.pod:152
20030 "Change the amount of memory allocated to the rescue system. The default is "
20031 "set by libguestfs and is small but adequate for running system tools. The "
20032 "occasional program might need more memory. The parameter is specified in "
20037 #: ../rescue/virt-rescue.pod:157
20038 msgid "B<--network>"
20042 #: ../rescue/virt-rescue.pod:159
20043 msgid "Enable QEMU user networking in the guest. See L</NETWORK>."
20047 #: ../rescue/virt-rescue.pod:165
20048 msgid "Open the image read-only."
20052 #: ../rescue/virt-rescue.pod:175
20054 "Enable SELinux in the rescue appliance. You should read "
20055 "L<guestfs(3)/SELINUX> before using this option."
20059 #: ../rescue/virt-rescue.pod:194
20061 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
20062 "are done read-write."
20066 #: ../rescue/virt-rescue.pod:207
20067 msgid "Previous versions of virt-rescue allowed you to write either:"
20071 #: ../rescue/virt-rescue.pod:209
20074 " virt-rescue disk.img [disk.img ...]\n"
20079 #: ../rescue/virt-rescue.pod:213
20082 " virt-rescue guestname\n"
20087 #: ../rescue/virt-rescue.pod:221
20092 #: ../rescue/virt-rescue.pod:223
20094 "Adding the I<--network> option enables QEMU user networking in the rescue "
20095 "appliance. There are some differences between user networking and ordinary "
20100 #: ../rescue/virt-rescue.pod:229
20101 msgid "ping does not work"
20105 #: ../rescue/virt-rescue.pod:231
20107 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
20108 "send the ping packets, and because virt-rescue must be able to run as "
20109 "non-root, QEMU user networking is not able to emulate the L<ping(8)> "
20110 "command. The ping command will appear to resolve addresses but will not be "
20111 "able to send or receive any packets. This does not mean that the network is "
20116 #: ../rescue/virt-rescue.pod:238
20117 msgid "cannot receive connections"
20121 #: ../rescue/virt-rescue.pod:240
20122 msgid "QEMU user networking cannot receive incoming connections."
20126 #: ../rescue/virt-rescue.pod:242
20127 msgid "making TCP connections"
20131 #: ../rescue/virt-rescue.pod:244
20133 "The virt-rescue appliance needs to be small and so does not include many "
20134 "network tools. In particular there is no L<telnet(1)> command. You can "
20135 "make TCP connections from the shell using the magical "
20136 "C</dev/tcp/E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
20140 #: ../rescue/virt-rescue.pod:249
20143 " exec 3<>/dev/tcp/redhat.com/80\n"
20144 " echo \"GET /\" >&3\n"
20150 #: ../rescue/virt-rescue.pod:253
20151 msgid "See L<bash(1)> for more details."
20155 #: ../rescue/virt-rescue.pod:259
20157 "Several environment variables affect virt-rescue. See "
20158 "L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
20162 #: ../rescue/virt-rescue.pod:286
20164 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
20165 "L<http://libguestfs.org/>."
20169 #: ../resize/virt-resize.pod:5
20170 msgid "virt-resize - Resize a virtual machine disk"
20174 #: ../resize/virt-resize.pod:9
20177 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
20178 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
20179 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
20184 #: ../resize/virt-resize.pod:15
20186 "Virt-resize is a tool which can resize a virtual machine disk, making it "
20187 "larger or smaller overall, and resizing or deleting any partitions contained "
20192 #: ../resize/virt-resize.pod:19
20194 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
20195 "not> be used on live virtual machines - for consistent results, shut the "
20196 "virtual machine down before resizing it."
20200 #: ../resize/virt-resize.pod:23
20202 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
20203 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
20207 #: ../resize/virt-resize.pod:31 ../src/guestfs.pod:469 ../src/guestfs.pod:1280 ../src/guestfs.pod:1418 ../src/guestfs.pod:2581
20212 #: ../resize/virt-resize.pod:33
20214 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
20215 "fill the extra 5GB of space."
20219 #: ../resize/virt-resize.pod:36
20222 " virt-filesystems --long -h --all -a olddisk\n"
20227 #: ../resize/virt-resize.pod:38
20230 " truncate -r olddisk newdisk\n"
20231 " truncate -s +5G newdisk\n"
20236 #: ../resize/virt-resize.pod:41
20239 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
20240 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
20245 #: ../resize/virt-resize.pod:44 ../src/guestfs.pod:475 ../src/guestfs.pod:1284 ../src/guestfs.pod:1422 ../src/guestfs.pod:2606
20250 #: ../resize/virt-resize.pod:46
20252 "As above, but make the /boot partition 200MB bigger, while giving the "
20253 "remaining space to /dev/sda2:"
20257 #: ../resize/virt-resize.pod:49
20260 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20261 " olddisk newdisk\n"
20266 #: ../resize/virt-resize.pod:52 ../src/guestfs.pod:486 ../src/guestfs.pod:1428
20271 #: ../resize/virt-resize.pod:54
20273 "As in the first example, but expand a logical volume as the final step. "
20274 "This is what you would typically use for Linux guests that use LVM:"
20278 #: ../resize/virt-resize.pod:58
20281 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
20282 " olddisk newdisk\n"
20287 #: ../resize/virt-resize.pod:61
20292 #: ../resize/virt-resize.pod:63
20294 "As in the first example, but the output format will be qcow2 instead of a "
20299 #: ../resize/virt-resize.pod:66
20302 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
20303 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
20308 #: ../resize/virt-resize.pod:71
20309 msgid "DETAILED USAGE"
20313 #: ../resize/virt-resize.pod:73
20314 msgid "EXPANDING A VIRTUAL MACHINE DISK"
20318 #: ../resize/virt-resize.pod:77
20319 msgid "1. Shut down the virtual machine"
20323 #: ../resize/virt-resize.pod:79
20324 msgid "2. Locate input disk image"
20328 #: ../resize/virt-resize.pod:81
20330 "Locate the input disk image (ie. the file or device on the host containing "
20331 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
20332 "dumpxml> like this to find the disk image name:"
20336 #: ../resize/virt-resize.pod:85
20339 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
20340 " Found 1 nodes:\n"
20342 " <source dev=\"/dev/vg/lv_guest\" />\n"
20347 #: ../resize/virt-resize.pod:90
20348 msgid "3. Look at current sizing"
20352 #: ../resize/virt-resize.pod:92
20353 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
20357 #: ../resize/virt-resize.pod:95
20360 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
20361 " Name Type Size Parent\n"
20362 " /dev/sda1 partition 101M /dev/sda\n"
20363 " /dev/sda2 partition 7.9G /dev/sda\n"
20364 " /dev/sda device 8.0G -\n"
20369 #: ../resize/virt-resize.pod:101
20371 "(This example is a virtual machine with an 8 GB disk which we would like to "
20372 "expand up to 10 GB)."
20376 #: ../resize/virt-resize.pod:104
20377 msgid "4. Create output disk"
20381 #: ../resize/virt-resize.pod:106
20383 "Virt-resize cannot do in-place disk modifications. You have to have space "
20384 "to store the resized output disk."
20388 #: ../resize/virt-resize.pod:109
20389 msgid "To store the resized disk image in a file, create a file of a suitable size:"
20393 #: ../resize/virt-resize.pod:112
20396 " # rm -f outdisk\n"
20397 " # truncate -s 10G outdisk\n"
20402 #: ../resize/virt-resize.pod:115
20403 msgid "Or use L<lvcreate(1)> to create a logical volume:"
20407 #: ../resize/virt-resize.pod:117
20410 " # lvcreate -L 10G -n lv_name vg_name\n"
20415 #: ../resize/virt-resize.pod:119
20416 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
20420 #: ../resize/virt-resize.pod:121
20423 " # virsh pool-list\n"
20424 " # virsh vol-create-as poolname newvol 10G\n"
20429 #: ../resize/virt-resize.pod:124
20434 #: ../resize/virt-resize.pod:126
20436 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
20437 "file) and the output disk. The output disk is the one created in the "
20442 #: ../resize/virt-resize.pod:130
20445 " # virt-resize indisk outdisk\n"
20450 #: ../resize/virt-resize.pod:132
20452 "This command just copies disk image C<indisk> to disk image C<outdisk> "
20453 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
20454 "larger, then an extra, empty partition is created at the end of the disk "
20455 "covering the extra space. If C<outdisk> is smaller, then it will give an "
20460 #: ../resize/virt-resize.pod:138
20462 "More realistically you'd want to expand existing partitions in the disk "
20463 "image by passing extra options (for the full list see the L</OPTIONS> "
20468 #: ../resize/virt-resize.pod:142
20470 "L</--expand> is the most useful option. It expands the named partition "
20471 "within the disk to fill any extra space:"
20475 #: ../resize/virt-resize.pod:145
20478 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
20483 #: ../resize/virt-resize.pod:147
20485 "(In this case, an extra partition is I<not> created at the end of the disk, "
20486 "because there will be no unused space)."
20490 #: ../resize/virt-resize.pod:150
20492 "L</--resize> is the other commonly used option. The following would "
20493 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
20494 "rest of the available space:"
20498 #: ../resize/virt-resize.pod:154
20501 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20502 " indisk outdisk\n"
20507 #: ../resize/virt-resize.pod:157
20509 "If the expanded partition in the image contains a filesystem or LVM PV, then "
20510 "if virt-resize knows how, it will resize the contents, the equivalent of "
20511 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
20512 "or L<btrfs(8)>. However virt-resize does not know how to resize some "
20513 "filesystems, so you would have to online resize them after booting the "
20518 #: ../resize/virt-resize.pod:164
20519 msgid "Other options are covered below."
20523 #: ../resize/virt-resize.pod:166
20528 #: ../resize/virt-resize.pod:168
20529 msgid "Thoroughly test the new disk image I<before> discarding the old one."
20533 #: ../resize/virt-resize.pod:170
20534 msgid "If you are using libvirt, edit the XML to point at the new disk:"
20538 #: ../resize/virt-resize.pod:172
20541 " # virsh edit guestname\n"
20546 #: ../resize/virt-resize.pod:174
20548 "Change E<lt>source ...E<gt>, see "
20549 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
20553 #: ../resize/virt-resize.pod:177
20554 msgid "Then start up the domain with the new, resized disk:"
20558 #: ../resize/virt-resize.pod:179
20561 " # virsh start guestname\n"
20566 #: ../resize/virt-resize.pod:181
20568 "and check that it still works. See also the L</NOTES> section below for "
20569 "additional information."
20573 #: ../resize/virt-resize.pod:184
20574 msgid "7. Resize LVs etc inside the guest"
20578 #: ../resize/virt-resize.pod:186
20579 msgid "(This can also be done offline using L<guestfish(1)>)"
20583 #: ../resize/virt-resize.pod:188
20585 "Once the guest has booted you should see the new space available, at least "
20586 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
20587 "may need to resize LVs inside PVs, and also resize filesystem types that "
20588 "virt-resize does not know how to expand."
20592 #: ../resize/virt-resize.pod:195
20593 msgid "SHRINKING A VIRTUAL MACHINE DISK"
20597 #: ../resize/virt-resize.pod:197
20599 "Shrinking is somewhat more complex than expanding, and only an overview is "
20604 #: ../resize/virt-resize.pod:200
20606 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
20607 "filesystems). The user has to shrink content before passing the disk image "
20608 "to virt-resize, and virt-resize will check that the content has been shrunk "
20613 #: ../resize/virt-resize.pod:205
20614 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
20618 #: ../resize/virt-resize.pod:207
20620 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
20621 "steps 3 and 4 above to allocate a new disk image."
20625 #: ../resize/virt-resize.pod:210
20626 msgid "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
20630 #: ../resize/virt-resize.pod:213
20631 msgid "IGNORING OR DELETING PARTITIONS"
20635 #: ../resize/virt-resize.pod:215
20637 "virt-resize also gives a convenient way to ignore or delete partitions when "
20638 "copying from the input disk to the output disk. Ignoring a partition speeds "
20639 "up the copy where you don't care about the existing contents of a "
20640 "partition. Deleting a partition removes it completely, but note that it "
20641 "also renumbers any partitions after the one which is deleted, which can "
20642 "leave some guests unbootable."
20646 #: ../resize/virt-resize.pod:222
20647 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
20651 #: ../resize/virt-resize.pod:224
20653 "If the input disk is in qcow2 format, then you may prefer that the output is "
20654 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
20655 "the fly. The output format is simply determined by the format of the empty "
20656 "output container that you provide. Thus to create qcow2 output, use:"
20660 #: ../resize/virt-resize.pod:230
20663 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
20668 #: ../resize/virt-resize.pod:232
20669 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
20673 #: ../resize/virt-resize.pod:234
20674 msgid "Similarly, to get non-sparse raw output use:"
20678 #: ../resize/virt-resize.pod:236
20681 " fallocate -l size outdisk\n"
20686 #: ../resize/virt-resize.pod:238
20688 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
20689 "if=/dev/zero of=outdisk bs=1M count=..>)"
20693 #: ../resize/virt-resize.pod:247
20694 msgid "Display help."
20698 #: ../resize/virt-resize.pod:249
20703 #: ../resize/virt-resize.pod:251 ../tools/virt-make-fs.pl:177 ../tools/virt-win-reg.pl:120
20708 #: ../resize/virt-resize.pod:253 ../tools/virt-win-reg.pl:122
20709 msgid "Enable debugging messages."
20713 #: ../resize/virt-resize.pod:255
20714 msgid "B<--delete part>"
20718 #: ../resize/virt-resize.pod:257
20720 "Delete the named partition. It would be more accurate to describe this as "
20721 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
20722 "the original disk image is left intact."
20726 #: ../resize/virt-resize.pod:261
20728 "Note that when you delete a partition, then anything contained in the "
20729 "partition is also deleted. Furthermore, this causes any partitions that "
20730 "come after to be I<renumbered>, which can easily make your guest unbootable."
20734 #: ../resize/virt-resize.pod:266 ../resize/virt-resize.pod:327 ../resize/virt-resize.pod:454
20735 msgid "You can give this option multiple times."
20739 #: ../resize/virt-resize.pod:268
20740 msgid "B<--expand part>"
20744 #: ../resize/virt-resize.pod:270
20746 "Expand the named partition so it uses up all extra space (space left over "
20747 "after any other resize changes that you request have been done)."
20751 #: ../resize/virt-resize.pod:273
20753 "If virt-resize knows how, it will expand the direct content of the "
20754 "partition. For example, if the partition is an LVM PV, it will expand the "
20755 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
20756 "content it doesn't know about alone."
20760 #: ../resize/virt-resize.pod:278
20761 msgid "Currently virt-resize can resize:"
20765 #: ../resize/virt-resize.pod:284
20766 msgid "ext2, ext3 and ext4 filesystems."
20770 #: ../resize/virt-resize.pod:288
20771 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
20775 #: ../resize/virt-resize.pod:290
20777 "The filesystem must have been shut down consistently last time it was used. "
20778 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
20779 "consistency check, so at the first boot after resizing Windows will check "
20784 #: ../resize/virt-resize.pod:297
20786 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
20787 "inside the PV, but see the I<--LV-expand> option. The user could also "
20788 "resize LVs as desired after boot."
20792 #: ../resize/virt-resize.pod:303
20793 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
20797 #: ../resize/virt-resize.pod:307 ../resize/virt-resize.pod:482
20798 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
20802 #: ../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
20803 msgid "B<--format> raw"
20807 #: ../resize/virt-resize.pod:311
20809 "Specify the format of the input disk image. If this flag is not given then "
20810 "it is auto-detected from the image itself."
20814 #: ../resize/virt-resize.pod:317
20816 "Note that this option I<does not> affect the output format. See L</QCOW2 "
20817 "AND NON-SPARSE RAW FORMATS>."
20821 #: ../resize/virt-resize.pod:320
20822 msgid "B<--ignore part>"
20826 #: ../resize/virt-resize.pod:322
20828 "Ignore the named partition. Effectively this means the partition is "
20829 "allocated on the destination disk, but the content is not copied across from "
20830 "the source disk. The content of the partition will be blank (all zero "
20835 #: ../resize/virt-resize.pod:329
20836 msgid "B<--LV-expand logvol>"
20840 #: ../resize/virt-resize.pod:331
20842 "This takes the logical volume and, as a final step, expands it to fill all "
20843 "the space available in its volume group. A typical usage, assuming a Linux "
20844 "guest with a single PV C</dev/sda2> and a root device called "
20845 "C</dev/vg_guest/lv_root> would be:"
20849 #: ../resize/virt-resize.pod:336
20852 " virt-resize indisk outdisk \\\n"
20853 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
20858 #: ../resize/virt-resize.pod:339
20860 "This would first expand the partition (and PV), and then expand the root "
20861 "device to fill the extra space in the PV."
20865 #: ../resize/virt-resize.pod:342
20867 "The contents of the LV are also resized if virt-resize knows how to do "
20868 "that. You can stop virt-resize from trying to expand the content by using "
20869 "the option I<--no-expand-content>."
20873 #: ../resize/virt-resize.pod:346
20874 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
20878 #: ../resize/virt-resize.pod:348
20880 "You can give this option multiple times, I<but> it doesn't make sense to do "
20881 "this unless the logical volumes you specify are all in different volume "
20886 #: ../resize/virt-resize.pod:352
20887 msgid "B<--machine-readable>"
20891 #: ../resize/virt-resize.pod:354
20893 "This option is used to make the output more machine friendly when being "
20894 "parsed by other programs. See L</MACHINE READABLE OUTPUT> below."
20898 #: ../resize/virt-resize.pod:360
20899 msgid "B<--dryrun>"
20903 #: ../resize/virt-resize.pod:362
20904 msgid "Print a summary of what would be done, but don't do anything."
20908 #: ../resize/virt-resize.pod:364
20909 msgid "B<--no-copy-boot-loader>"
20913 #: ../resize/virt-resize.pod:366
20915 "By default, virt-resize copies over some sectors at the start of the disk "
20916 "(up to the beginning of the first partition). Commonly these sectors "
20917 "contain the Master Boot Record (MBR) and the boot loader, and are required "
20918 "in order for the guest to boot correctly."
20922 #: ../resize/virt-resize.pod:371
20924 "If you specify this flag, then this initial copy is not done. You may need "
20925 "to reinstall the boot loader in this case."
20929 #: ../resize/virt-resize.pod:374
20930 msgid "B<--no-extra-partition>"
20934 #: ../resize/virt-resize.pod:376
20936 "By default, virt-resize creates an extra partition if there is any extra, "
20937 "unused space after all resizing has happened. Use this option to prevent "
20938 "the extra partition from being created. If you do this then the extra space "
20939 "will be inaccessible until you run fdisk, parted, or some other partitioning "
20940 "tool in the guest."
20944 #: ../resize/virt-resize.pod:382
20946 "Note that if the surplus space is smaller than 10 MB, no extra partition "
20951 #: ../resize/virt-resize.pod:385
20952 msgid "B<--no-expand-content>"
20956 #: ../resize/virt-resize.pod:387
20958 "By default, virt-resize will try to expand the direct contents of "
20959 "partitions, if it knows how (see I<--expand> option above)."
20963 #: ../resize/virt-resize.pod:390
20965 "If you give the I<--no-expand-content> option then virt-resize will not "
20970 #: ../resize/virt-resize.pod:393
20971 msgid "B<--ntfsresize-force>"
20975 #: ../resize/virt-resize.pod:395
20977 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
20978 "the NTFS disk is marked as needing a consistency check. You have to use "
20979 "this option if you want to resize a Windows guest multiple times without "
20980 "booting into Windows between each resize."
20984 #: ../resize/virt-resize.pod:401
20985 msgid "B<--output-format> raw"
20989 #: ../resize/virt-resize.pod:403
20991 "Specify the format of the output disk image. If this flag is not given then "
20992 "it is auto-detected from the image itself."
20996 #: ../resize/virt-resize.pod:409
20998 "Note that this option I<does not create> the output format. This option "
20999 "just tells libguestfs what it is so it doesn't try to guess it. You still "
21000 "need to create the output disk with the right format. See L</QCOW2 AND "
21001 "NON-SPARSE RAW FORMATS>."
21005 #: ../resize/virt-resize.pod:414
21010 #: ../resize/virt-resize.pod:416
21015 #: ../resize/virt-resize.pod:418
21016 msgid "Don't print the summary."
21020 #: ../resize/virt-resize.pod:420
21021 msgid "B<--resize part=size>"
21025 #: ../resize/virt-resize.pod:422
21027 "Resize the named partition (expanding or shrinking it) so that it has the "
21032 #: ../resize/virt-resize.pod:425
21034 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
21035 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
21036 "size; or as a relative number or percentage. For example:"
21040 #: ../resize/virt-resize.pod:431
21043 " --resize /dev/sda2=10G\n"
21048 #: ../resize/virt-resize.pod:433
21051 " --resize /dev/sda4=90%\n"
21056 #: ../resize/virt-resize.pod:435
21059 " --resize /dev/sda2=+1G\n"
21064 #: ../resize/virt-resize.pod:437
21067 " --resize /dev/sda2=-200M\n"
21072 #: ../resize/virt-resize.pod:439
21075 " --resize /dev/sda1=+128K\n"
21080 #: ../resize/virt-resize.pod:441
21083 " --resize /dev/sda1=+10%\n"
21088 #: ../resize/virt-resize.pod:443
21091 " --resize /dev/sda1=-10%\n"
21096 #: ../resize/virt-resize.pod:445
21098 "You can increase the size of any partition. Virt-resize will expand the "
21099 "direct content of the partition if it knows how (see I<--expand> below)."
21103 #: ../resize/virt-resize.pod:449
21105 "You can only I<decrease> the size of partitions that contain filesystems or "
21106 "PVs which have already been shrunk. Virt-resize will check this has been "
21107 "done before proceeding, or else will print an error (see also "
21108 "I<--resize-force>)."
21112 #: ../resize/virt-resize.pod:456
21113 msgid "B<--resize-force part=size>"
21117 #: ../resize/virt-resize.pod:458
21119 "This is the same as I<--resize> except that it will let you decrease the "
21120 "size of any partition. Generally this means you will lose any data which "
21121 "was at the end of the partition you shrink, but you may not care about that "
21122 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
21123 "as a swap partition)."
21127 #: ../resize/virt-resize.pod:464
21128 msgid "See also the I<--ignore> option."
21132 #: ../resize/virt-resize.pod:466
21133 msgid "B<--shrink part>"
21137 #: ../resize/virt-resize.pod:468
21139 "Shrink the named partition until the overall disk image fits in the "
21140 "destination. The named partition B<must> contain a filesystem or PV which "
21141 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
21142 "online tools). Virt-resize will check this and give an error if it has not "
21147 #: ../resize/virt-resize.pod:474
21149 "The amount by which the overall disk must be shrunk (after carrying out all "
21150 "other operations requested by the user) is called the \"deficit\". For "
21151 "example, a straight copy (assume no other operations) from a 5GB disk image "
21152 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
21153 "would give an error unless the user specified a partition to shrink and that "
21154 "partition had more than a gigabyte of free space."
21158 #: ../resize/virt-resize.pod:492
21159 msgid "MACHINE READABLE OUTPUT"
21163 #: ../resize/virt-resize.pod:494
21165 "The I<--machine-readable> option can be used to make the output more machine "
21166 "friendly, which is useful when calling virt-resize from other programs, GUIs "
21171 #: ../resize/virt-resize.pod:498
21173 "Use the option on its own to query the capabilities of the virt-resize "
21174 "binary. Typical output looks like this:"
21178 #: ../resize/virt-resize.pod:501
21181 " $ virt-resize --machine-readable\n"
21183 " ntfsresize-force\n"
21191 #: ../resize/virt-resize.pod:508
21193 "A list of features is printed, one per line, and the program exits with "
21198 #: ../resize/virt-resize.pod:513
21199 msgid "\"Partition 1 does not end on cylinder boundary.\""
21203 #: ../resize/virt-resize.pod:515
21205 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
21206 "means the partitions will not be aligned to the ancient CHS geometry. "
21207 "However CHS geometry is meaningless for disks manufactured since the early "
21208 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
21209 "cylinders is not required by any modern operating system."
21213 #: ../resize/virt-resize.pod:522
21214 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
21218 #: ../resize/virt-resize.pod:524
21220 "In Windows Vista and later versions, Microsoft switched to using a separate "
21221 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
21222 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
21223 "the boot partition. Doing so seems to break the guest completely. However "
21224 "expanding the second partition (ie. C: drive) should work."
21228 #: ../resize/virt-resize.pod:531
21230 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
21231 "NTFS partitions have been expanded. This is just a safety check and (unless "
21232 "it find errors) is nothing to worry about."
21236 #: ../resize/virt-resize.pod:535
21237 msgid "GUEST BOOT STUCK AT \"GRUB\""
21241 #: ../resize/virt-resize.pod:537
21243 "If a Linux guest does not boot after resizing, and the boot is stuck after "
21244 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
21245 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
21246 "although we think is to do with partition alignment."
21250 #: ../resize/virt-resize.pod:542
21253 " guestfish -i -a newdisk\n"
21254 " ><fs> cat /boot/grub/device.map\n"
21255 " # check the contents of this file are sensible or\n"
21256 " # edit the file if necessary\n"
21257 " ><fs> grub-install / /dev/vda\n"
21263 #: ../resize/virt-resize.pod:549
21265 "For more flexible guest reconfiguration, including if you need to specify "
21266 "other parameters to grub-install, use L<virt-rescue(1)>."
21270 #: ../resize/virt-resize.pod:552
21271 msgid "ALTERNATIVE TOOLS"
21275 #: ../resize/virt-resize.pod:554
21277 "There are several proprietary tools for resizing partitions. We won't "
21278 "mention any here."
21282 #: ../resize/virt-resize.pod:557
21284 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
21285 "operations on disk images. They can resize and move partitions, but I don't "
21286 "think they can do anything with the contents, and they certainly don't "
21291 #: ../resize/virt-resize.pod:562
21293 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
21294 "but at a much lower level. You will probably end up hand-calculating sector "
21295 "offsets, which is something that virt-resize was designed to avoid. If you "
21296 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
21301 #: ../resize/virt-resize.pod:582
21303 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
21304 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
21305 "L<ntfsresize(8)>, L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
21306 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
21307 "L<http://libguestfs.org/>."
21311 #: ../ruby/examples/guestfs-ruby.pod:5
21312 msgid "guestfs-ruby - How to use libguestfs from Ruby"
21316 #: ../ruby/examples/guestfs-ruby.pod:9
21319 " require 'guestfs'\n"
21320 " g = Guestfs::Guestfs.new()\n"
21321 " g.add_drive_opts(\"disk.img\",\n"
21322 " :readonly => 1, :format => \"raw\")\n"
21328 #: ../ruby/examples/guestfs-ruby.pod:17
21330 "This manual page documents how to call libguestfs from the Ruby programming "
21331 "language. This page just documents the differences from the C API and gives "
21332 "some examples. If you are not familiar with using libguestfs, you also need "
21333 "to read L<guestfs(3)>."
21337 #: ../ruby/examples/guestfs-ruby.pod:24
21339 "Errors from libguestfs functions are mapped into the C<Error> exception. "
21340 "This has a single parameter which is the error message (a string)."
21344 #: ../ruby/examples/guestfs-ruby.pod:38
21346 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
21347 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
21348 "L<guestfs-recipes(1)>, L<http://libguestfs.org/>."
21352 #: ../src/guestfs-actions.pod:1
21353 msgid "guestfs_add_cdrom"
21357 #: ../src/guestfs-actions.pod:3
21361 " guestfs_add_cdrom (guestfs_h *g,\n"
21362 " const char *filename);\n"
21367 #: ../src/guestfs-actions.pod:17
21369 "This call checks for the existence of C<filename>. This stops you from "
21370 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21371 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
21376 #: ../src/guestfs-actions.pod:24
21378 "If you just want to add an ISO file (often you use this as an efficient way "
21379 "to transfer large files into the guest), then you should probably use "
21380 "C<guestfs_add_drive_ro> instead."
21384 #: ../src/guestfs-actions.pod:30 ../src/guestfs-actions.pod:140 ../src/guestfs-actions.pod:201 ../src/guestfs-actions.pod:238 ../src/guestfs-actions.pod:252 ../src/guestfs-actions.pod:273 ../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:1168 ../src/guestfs-actions.pod:1186 ../src/guestfs-actions.pod:1205 ../src/guestfs-actions.pod:1219 ../src/guestfs-actions.pod:1239 ../src/guestfs-actions.pod:1309 ../src/guestfs-actions.pod:1340 ../src/guestfs-actions.pod:1365 ../src/guestfs-actions.pod:1407 ../src/guestfs-actions.pod:1513 ../src/guestfs-actions.pod:1547 ../src/guestfs-actions.pod:1762 ../src/guestfs-actions.pod:1784 ../src/guestfs-actions.pod:1871 ../src/guestfs-actions.pod:2368 ../src/guestfs-actions.pod:2512 ../src/guestfs-actions.pod:2573 ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:3648 ../src/guestfs-actions.pod:3663 ../src/guestfs-actions.pod:3688 ../src/guestfs-actions.pod:3877 ../src/guestfs-actions.pod:3891 ../src/guestfs-actions.pod:3904 ../src/guestfs-actions.pod:3918 ../src/guestfs-actions.pod:3933 ../src/guestfs-actions.pod:3969 ../src/guestfs-actions.pod:4041 ../src/guestfs-actions.pod:4061 ../src/guestfs-actions.pod:4078 ../src/guestfs-actions.pod:4101 ../src/guestfs-actions.pod:4124 ../src/guestfs-actions.pod:4159 ../src/guestfs-actions.pod:4178 ../src/guestfs-actions.pod:4197 ../src/guestfs-actions.pod:4232 ../src/guestfs-actions.pod:4244 ../src/guestfs-actions.pod:4280 ../src/guestfs-actions.pod:4296 ../src/guestfs-actions.pod:4309 ../src/guestfs-actions.pod:4324 ../src/guestfs-actions.pod:4341 ../src/guestfs-actions.pod:4434 ../src/guestfs-actions.pod:4454 ../src/guestfs-actions.pod:4467 ../src/guestfs-actions.pod:4518 ../src/guestfs-actions.pod:4536 ../src/guestfs-actions.pod:4554 ../src/guestfs-actions.pod:4570 ../src/guestfs-actions.pod:4584 ../src/guestfs-actions.pod:4598 ../src/guestfs-actions.pod:4615 ../src/guestfs-actions.pod:4630 ../src/guestfs-actions.pod:4650 ../src/guestfs-actions.pod:4720 ../src/guestfs-actions.pod:4793 ../src/guestfs-actions.pod:4824 ../src/guestfs-actions.pod:4843 ../src/guestfs-actions.pod:4862 ../src/guestfs-actions.pod:4874 ../src/guestfs-actions.pod:4891 ../src/guestfs-actions.pod:4904 ../src/guestfs-actions.pod:4919 ../src/guestfs-actions.pod:4934 ../src/guestfs-actions.pod:4969 ../src/guestfs-actions.pod:5002 ../src/guestfs-actions.pod:5041 ../src/guestfs-actions.pod:5061 ../src/guestfs-actions.pod:5075 ../src/guestfs-actions.pod:5092 ../src/guestfs-actions.pod:5141 ../src/guestfs-actions.pod:5187 ../src/guestfs-actions.pod:5241 ../src/guestfs-actions.pod:5277 ../src/guestfs-actions.pod:5312 ../src/guestfs-actions.pod:5329 ../src/guestfs-actions.pod:5347 ../src/guestfs-actions.pod:5487 ../src/guestfs-actions.pod:5544 ../src/guestfs-actions.pod:5566 ../src/guestfs-actions.pod:5584 ../src/guestfs-actions.pod:5616 ../src/guestfs-actions.pod:5682 ../src/guestfs-actions.pod:5699 ../src/guestfs-actions.pod:5712 ../src/guestfs-actions.pod:5726 ../src/guestfs-actions.pod:6015 ../src/guestfs-actions.pod:6034 ../src/guestfs-actions.pod:6053 ../src/guestfs-actions.pod:6067 ../src/guestfs-actions.pod:6079 ../src/guestfs-actions.pod:6093 ../src/guestfs-actions.pod:6105 ../src/guestfs-actions.pod:6119 ../src/guestfs-actions.pod:6135 ../src/guestfs-actions.pod:6156 ../src/guestfs-actions.pod:6175 ../src/guestfs-actions.pod:6194 ../src/guestfs-actions.pod:6224 ../src/guestfs-actions.pod:6242 ../src/guestfs-actions.pod:6265 ../src/guestfs-actions.pod:6283 ../src/guestfs-actions.pod:6302 ../src/guestfs-actions.pod:6323 ../src/guestfs-actions.pod:6342 ../src/guestfs-actions.pod:6359 ../src/guestfs-actions.pod:6378 ../src/guestfs-actions.pod:6406 ../src/guestfs-actions.pod:6430 ../src/guestfs-actions.pod:6449 ../src/guestfs-actions.pod:6473 ../src/guestfs-actions.pod:6492 ../src/guestfs-actions.pod:6507 ../src/guestfs-actions.pod:6526 ../src/guestfs-actions.pod:6563 ../src/guestfs-actions.pod:6593 ../src/guestfs-actions.pod:6626 ../src/guestfs-actions.pod:6748 ../src/guestfs-actions.pod:6869 ../src/guestfs-actions.pod:6881 ../src/guestfs-actions.pod:6894 ../src/guestfs-actions.pod:6907 ../src/guestfs-actions.pod:6929 ../src/guestfs-actions.pod:6942 ../src/guestfs-actions.pod:6955 ../src/guestfs-actions.pod:6968 ../src/guestfs-actions.pod:6983 ../src/guestfs-actions.pod:7042 ../src/guestfs-actions.pod:7059 ../src/guestfs-actions.pod:7075 ../src/guestfs-actions.pod:7091 ../src/guestfs-actions.pod:7108 ../src/guestfs-actions.pod:7121 ../src/guestfs-actions.pod:7141 ../src/guestfs-actions.pod:7177 ../src/guestfs-actions.pod:7191 ../src/guestfs-actions.pod:7232 ../src/guestfs-actions.pod:7245 ../src/guestfs-actions.pod:7263 ../src/guestfs-actions.pod:7297 ../src/guestfs-actions.pod:7333 ../src/guestfs-actions.pod:7449 ../src/guestfs-actions.pod:7464 ../src/guestfs-actions.pod:7478 ../src/guestfs-actions.pod:7533 ../src/guestfs-actions.pod:7546 ../src/guestfs-actions.pod:7591 ../src/guestfs-actions.pod:7624 ../src/guestfs-actions.pod:7687 ../src/guestfs-actions.pod:7707 ../src/guestfs-actions.pod:7733 ../src/guestfs-actions.pod:7804 ../src/guestfs-actions.pod:7827 ../src/guestfs-actions.pod:7856
21385 msgid "This function returns 0 on success or -1 on error."
21389 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254 ../src/guestfs-actions.pod:275
21391 "This function is deprecated. In new code, use the "
21392 "L</guestfs_add_drive_opts> call instead."
21396 #: ../src/guestfs-actions.pod:39 ../src/guestfs-actions.pod:142 ../src/guestfs-actions.pod:1170 ../src/guestfs-actions.pod:1985 ../src/guestfs-actions.pod:2083 ../src/guestfs-actions.pod:2197 ../src/guestfs-actions.pod:3650 ../src/guestfs-actions.pod:3670 ../src/guestfs-actions.pod:4978 ../src/guestfs-actions.pod:6244 ../src/guestfs-actions.pod:6361 ../src/guestfs-actions.pod:6494 ../src/guestfs-actions.pod:6985 ../src/guestfs-actions.pod:7110 ../src/guestfs-actions.pod:7633
21397 msgid "(Added in 0.3)"
21401 #: ../src/guestfs-actions.pod:41
21402 msgid "guestfs_add_domain"
21406 #: ../src/guestfs-actions.pod:43
21410 " guestfs_add_domain (guestfs_h *g,\n"
21411 " const char *dom,\n"
21417 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151 ../src/guestfs-actions.pod:837 ../src/guestfs-actions.pod:2853 ../src/guestfs-actions.pod:4669 ../src/guestfs-actions.pod:4988 ../src/guestfs-actions.pod:5205
21419 "You may supply a list of optional arguments to this call. Use zero or more "
21420 "of the following pairs of parameters, and terminate the list with C<-1> on "
21421 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
21425 #: ../src/guestfs-actions.pod:53
21428 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
21429 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
21430 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
21431 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
21432 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
21437 #: ../src/guestfs-actions.pod:59
21439 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21440 "It works by connecting to libvirt, requesting the domain and domain XML from "
21441 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
21446 #: ../src/guestfs-actions.pod:94
21448 "The other optional parameters are passed directly through to "
21449 "C<guestfs_add_drive_opts>."
21453 #: ../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:1385 ../src/guestfs-actions.pod:1741 ../src/guestfs-actions.pod:1944 ../src/guestfs-actions.pod:2055 ../src/guestfs-actions.pod:2106 ../src/guestfs-actions.pod:2161 ../src/guestfs-actions.pod:2184 ../src/guestfs-actions.pod:2499 ../src/guestfs-actions.pod:2971 ../src/guestfs-actions.pod:2989 ../src/guestfs-actions.pod:5164 ../src/guestfs-actions.pod:5384 ../src/guestfs-actions.pod:5796 ../src/guestfs-actions.pod:5822 ../src/guestfs-actions.pod:7218 ../src/guestfs-actions.pod:7644 ../src/guestfs-actions.pod:7657 ../src/guestfs-actions.pod:7670
21454 msgid "On error this function returns -1."
21458 #: ../src/guestfs-actions.pod:99
21459 msgid "(Added in 1.7.4)"
21463 #: ../src/guestfs-actions.pod:101
21464 msgid "guestfs_add_domain_va"
21468 #: ../src/guestfs-actions.pod:103
21472 " guestfs_add_domain_va (guestfs_h *g,\n"
21473 " const char *dom,\n"
21474 " va_list args);\n"
21479 #: ../src/guestfs-actions.pod:108
21480 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
21484 #: ../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:2937 ../src/guestfs-actions.pod:2949 ../src/guestfs-actions.pod:4734 ../src/guestfs-actions.pod:4746 ../src/guestfs-actions.pod:5016 ../src/guestfs-actions.pod:5028 ../src/guestfs-actions.pod:5254 ../src/guestfs-actions.pod:5265
21485 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
21489 #: ../src/guestfs-actions.pod:112
21490 msgid "guestfs_add_domain_argv"
21494 #: ../src/guestfs-actions.pod:114
21498 " guestfs_add_domain_argv (guestfs_h *g,\n"
21499 " const char *dom,\n"
21500 " const struct guestfs_add_domain_argv *optargs);\n"
21505 #: ../src/guestfs-actions.pod:119
21506 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
21510 #: ../src/guestfs-actions.pod:123
21511 msgid "guestfs_add_drive"
21515 #: ../src/guestfs-actions.pod:125
21519 " guestfs_add_drive (guestfs_h *g,\n"
21520 " const char *filename);\n"
21525 #: ../src/guestfs-actions.pod:129
21527 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
21528 "optional parameters, so the disk is added writable, with the format being "
21529 "detected automatically."
21533 #: ../src/guestfs-actions.pod:133
21535 "Automatic detection of the format opens you up to a potential security hole "
21536 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21537 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21538 "you should think about replacing calls to this function with calls to "
21539 "C<guestfs_add_drive_opts>, and specifying the format."
21543 #: ../src/guestfs-actions.pod:144
21544 msgid "guestfs_add_drive_opts"
21548 #: ../src/guestfs-actions.pod:146
21552 " guestfs_add_drive_opts (guestfs_h *g,\n"
21553 " const char *filename,\n"
21559 #: ../src/guestfs-actions.pod:156
21562 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
21563 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
21564 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
21569 #: ../src/guestfs-actions.pod:185
21571 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
21572 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
21573 "Possible formats include C<raw> and C<qcow2>."
21577 #: ../src/guestfs-actions.pod:196
21579 "This rarely-used option lets you emulate the behaviour of the deprecated "
21580 "C<guestfs_add_drive_with_if> call (q.v.)"
21584 #: ../src/guestfs-actions.pod:203
21585 msgid "(Added in 1.5.23)"
21589 #: ../src/guestfs-actions.pod:205
21590 msgid "guestfs_add_drive_opts_va"
21594 #: ../src/guestfs-actions.pod:207
21598 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
21599 " const char *filename,\n"
21600 " va_list args);\n"
21605 #: ../src/guestfs-actions.pod:212
21606 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
21610 #: ../src/guestfs-actions.pod:216
21611 msgid "guestfs_add_drive_opts_argv"
21615 #: ../src/guestfs-actions.pod:218
21619 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
21620 " const char *filename,\n"
21621 " const struct guestfs_add_drive_opts_argv "
21627 #: ../src/guestfs-actions.pod:223
21628 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
21632 #: ../src/guestfs-actions.pod:227
21633 msgid "guestfs_add_drive_ro"
21637 #: ../src/guestfs-actions.pod:229
21641 " guestfs_add_drive_ro (guestfs_h *g,\n"
21642 " const char *filename);\n"
21647 #: ../src/guestfs-actions.pod:233
21649 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
21650 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
21651 "disk is added read-only, with the format being detected automatically."
21655 #: ../src/guestfs-actions.pod:240
21656 msgid "(Added in 1.0.38)"
21660 #: ../src/guestfs-actions.pod:242
21661 msgid "guestfs_add_drive_ro_with_if"
21665 #: ../src/guestfs-actions.pod:244
21669 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
21670 " const char *filename,\n"
21671 " const char *iface);\n"
21676 #: ../src/guestfs-actions.pod:249
21678 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
21679 "QEMU interface emulation to use at run time."
21683 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282 ../src/guestfs-actions.pod:2458
21684 msgid "(Added in 1.0.84)"
21688 #: ../src/guestfs-actions.pod:263
21689 msgid "guestfs_add_drive_with_if"
21693 #: ../src/guestfs-actions.pod:265
21697 " guestfs_add_drive_with_if (guestfs_h *g,\n"
21698 " const char *filename,\n"
21699 " const char *iface);\n"
21704 #: ../src/guestfs-actions.pod:270
21706 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
21707 "QEMU interface emulation to use at run time."
21711 #: ../src/guestfs-actions.pod:284
21712 msgid "guestfs_aug_clear"
21716 #: ../src/guestfs-actions.pod:286
21720 " guestfs_aug_clear (guestfs_h *g,\n"
21721 " const char *augpath);\n"
21726 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2186
21727 msgid "(Added in 1.3.4)"
21731 #: ../src/guestfs-actions.pod:297
21732 msgid "guestfs_aug_close"
21736 #: ../src/guestfs-actions.pod:299
21740 " guestfs_aug_close (guestfs_h *g);\n"
21745 #: ../src/guestfs-actions.pod:302
21747 "Close the current Augeas handle and free up any resources used by it. After "
21748 "calling this, you have to call C<guestfs_aug_init> again before you can use "
21749 "any other Augeas functions."
21753 #: ../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:5873
21754 msgid "(Added in 0.7)"
21758 #: ../src/guestfs-actions.pod:311
21759 msgid "guestfs_aug_defnode"
21763 #: ../src/guestfs-actions.pod:313
21766 " struct guestfs_int_bool *\n"
21767 " guestfs_aug_defnode (guestfs_h *g,\n"
21768 " const char *name,\n"
21769 " const char *expr,\n"
21770 " const char *val);\n"
21775 #: ../src/guestfs-actions.pod:322
21777 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21778 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
21779 "containing that single node."
21783 #: ../src/guestfs-actions.pod:330
21785 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
21786 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
21790 #: ../src/guestfs-actions.pod:336
21791 msgid "guestfs_aug_defvar"
21795 #: ../src/guestfs-actions.pod:338
21799 " guestfs_aug_defvar (guestfs_h *g,\n"
21800 " const char *name,\n"
21801 " const char *expr);\n"
21806 #: ../src/guestfs-actions.pod:354
21807 msgid "guestfs_aug_get"
21811 #: ../src/guestfs-actions.pod:356
21815 " guestfs_aug_get (guestfs_h *g,\n"
21816 " const char *augpath);\n"
21821 #: ../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:1254 ../src/guestfs-actions.pod:1271 ../src/guestfs-actions.pod:1290 ../src/guestfs-actions.pod:1424 ../src/guestfs-actions.pod:1612 ../src/guestfs-actions.pod:1724 ../src/guestfs-actions.pod:1887 ../src/guestfs-actions.pod:1904 ../src/guestfs-actions.pod:1971 ../src/guestfs-actions.pod:2007 ../src/guestfs-actions.pod:2028 ../src/guestfs-actions.pod:2209 ../src/guestfs-actions.pod:2423 ../src/guestfs-actions.pod:2627 ../src/guestfs-actions.pod:2717 ../src/guestfs-actions.pod:2821 ../src/guestfs-actions.pod:2840 ../src/guestfs-actions.pod:3054 ../src/guestfs-actions.pod:3082 ../src/guestfs-actions.pod:3103 ../src/guestfs-actions.pod:3137 ../src/guestfs-actions.pod:3196 ../src/guestfs-actions.pod:3216 ../src/guestfs-actions.pod:3236 ../src/guestfs-actions.pod:3863 ../src/guestfs-actions.pod:4216 ../src/guestfs-actions.pod:4386 ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:5402 ../src/guestfs-actions.pod:5601 ../src/guestfs-actions.pod:5771 ../src/guestfs-actions.pod:5949 ../src/guestfs-actions.pod:5998 ../src/guestfs-actions.pod:6654 ../src/guestfs-actions.pod:6670 ../src/guestfs-actions.pod:6687 ../src/guestfs-actions.pod:6718 ../src/guestfs-actions.pod:7392 ../src/guestfs-actions.pod:7411 ../src/guestfs-actions.pod:7429 ../src/guestfs-actions.pod:7603 ../src/guestfs-actions.pod:7913
21823 "This function returns a string, or NULL on error. I<The caller must free "
21824 "the returned string after use>."
21828 #: ../src/guestfs-actions.pod:368
21829 msgid "guestfs_aug_init"
21833 #: ../src/guestfs-actions.pod:370
21837 " guestfs_aug_init (guestfs_h *g,\n"
21838 " const char *root,\n"
21844 #: ../src/guestfs-actions.pod:379
21845 msgid "You must call this before using any other C<guestfs_aug_*> commands."
21849 #: ../src/guestfs-actions.pod:404
21851 "This option is only useful when debugging Augeas lenses. Use of this option "
21852 "may require additional memory for the libguestfs appliance. You may need to "
21853 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
21854 "C<guestfs_set_memsize>."
21858 #: ../src/guestfs-actions.pod:419
21859 msgid "Do not load the tree in C<guestfs_aug_init>."
21863 #: ../src/guestfs-actions.pod:423
21864 msgid "To close the handle, you can call C<guestfs_aug_close>."
21868 #: ../src/guestfs-actions.pod:431
21869 msgid "guestfs_aug_insert"
21873 #: ../src/guestfs-actions.pod:433
21877 " guestfs_aug_insert (guestfs_h *g,\n"
21878 " const char *augpath,\n"
21879 " const char *label,\n"
21885 #: ../src/guestfs-actions.pod:451
21886 msgid "guestfs_aug_load"
21890 #: ../src/guestfs-actions.pod:453
21894 " guestfs_aug_load (guestfs_h *g);\n"
21899 #: ../src/guestfs-actions.pod:465
21900 msgid "guestfs_aug_ls"
21904 #: ../src/guestfs-actions.pod:467
21908 " guestfs_aug_ls (guestfs_h *g,\n"
21909 " const char *augpath);\n"
21914 #: ../src/guestfs-actions.pod:471
21916 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
21917 "sorting the resulting nodes into alphabetical order."
21921 #: ../src/guestfs-actions.pod:474 ../src/guestfs-actions.pod:490 ../src/guestfs-actions.pod:636 ../src/guestfs-actions.pod:1143 ../src/guestfs-actions.pod:1439 ../src/guestfs-actions.pod:1458 ../src/guestfs-actions.pod:1561 ../src/guestfs-actions.pod:1580 ../src/guestfs-actions.pod:1826 ../src/guestfs-actions.pod:2281 ../src/guestfs-actions.pod:2297 ../src/guestfs-actions.pod:2316 ../src/guestfs-actions.pod:2381 ../src/guestfs-actions.pod:2405 ../src/guestfs-actions.pod:2476 ../src/guestfs-actions.pod:2525 ../src/guestfs-actions.pod:2782 ../src/guestfs-actions.pod:3156 ../src/guestfs-actions.pod:3432 ../src/guestfs-actions.pod:3746 ../src/guestfs-actions.pod:3763 ../src/guestfs-actions.pod:3783 ../src/guestfs-actions.pod:3845 ../src/guestfs-actions.pod:3950 ../src/guestfs-actions.pod:4358 ../src/guestfs-actions.pod:5125 ../src/guestfs-actions.pod:5743 ../src/guestfs-actions.pod:5869 ../src/guestfs-actions.pod:5983 ../src/guestfs-actions.pod:6734 ../src/guestfs-actions.pod:6795 ../src/guestfs-actions.pod:6850 ../src/guestfs-actions.pod:6996 ../src/guestfs-actions.pod:7020 ../src/guestfs-actions.pod:7496 ../src/guestfs-actions.pod:7516 ../src/guestfs-actions.pod:7563 ../src/guestfs-actions.pod:7757 ../src/guestfs-actions.pod:7776 ../src/guestfs-actions.pod:7870 ../src/guestfs-actions.pod:7889 ../src/guestfs-actions.pod:7935 ../src/guestfs-actions.pod:7954
21923 "This function returns a NULL-terminated array of strings (like "
21924 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
21925 "strings and the array after use>."
21929 #: ../src/guestfs-actions.pod:478 ../src/guestfs-actions.pod:1068 ../src/guestfs-actions.pod:1086 ../src/guestfs-actions.pod:1496 ../src/guestfs-actions.pod:3510 ../src/guestfs-actions.pod:3541 ../src/guestfs-actions.pod:4199 ../src/guestfs-actions.pod:4249 ../src/guestfs-actions.pod:4436 ../src/guestfs-actions.pod:4469 ../src/guestfs-actions.pod:4632 ../src/guestfs-actions.pod:5129 ../src/guestfs-actions.pod:5684 ../src/guestfs-actions.pod:6081 ../src/guestfs-actions.pod:6095 ../src/guestfs-actions.pod:6107 ../src/guestfs-actions.pod:6575 ../src/guestfs-actions.pod:7234 ../src/guestfs-actions.pod:7247 ../src/guestfs-actions.pod:7480 ../src/guestfs-actions.pod:7745
21930 msgid "(Added in 0.8)"
21934 #: ../src/guestfs-actions.pod:480
21935 msgid "guestfs_aug_match"
21939 #: ../src/guestfs-actions.pod:482
21943 " guestfs_aug_match (guestfs_h *g,\n"
21944 " const char *augpath);\n"
21949 #: ../src/guestfs-actions.pod:496
21950 msgid "guestfs_aug_mv"
21954 #: ../src/guestfs-actions.pod:498
21958 " guestfs_aug_mv (guestfs_h *g,\n"
21959 " const char *src,\n"
21960 " const char *dest);\n"
21965 #: ../src/guestfs-actions.pod:510
21966 msgid "guestfs_aug_rm"
21970 #: ../src/guestfs-actions.pod:512
21974 " guestfs_aug_rm (guestfs_h *g,\n"
21975 " const char *augpath);\n"
21980 #: ../src/guestfs-actions.pod:524
21981 msgid "guestfs_aug_save"
21985 #: ../src/guestfs-actions.pod:526
21989 " guestfs_aug_save (guestfs_h *g);\n"
21994 #: ../src/guestfs-actions.pod:531
21996 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
22001 #: ../src/guestfs-actions.pod:538
22002 msgid "guestfs_aug_set"
22006 #: ../src/guestfs-actions.pod:540
22010 " guestfs_aug_set (guestfs_h *g,\n"
22011 " const char *augpath,\n"
22012 " const char *val);\n"
22017 #: ../src/guestfs-actions.pod:547
22019 "In the Augeas API, it is possible to clear a node by setting the value to "
22020 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
22021 "this call. Instead you must use the C<guestfs_aug_clear> call."
22025 #: ../src/guestfs-actions.pod:556
22026 msgid "guestfs_available"
22030 #: ../src/guestfs-actions.pod:558
22034 " guestfs_available (guestfs_h *g,\n"
22035 " char *const *groups);\n"
22040 #: ../src/guestfs-actions.pod:566
22042 "The libguestfs groups, and the functions that those groups correspond to, "
22043 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
22044 "runtime by calling C<guestfs_available_all_groups>."
22048 #: ../src/guestfs-actions.pod:590
22049 msgid "You must call C<guestfs_launch> before calling this function."
22053 #: ../src/guestfs-actions.pod:612
22055 "This call was added in version C<1.0.80>. In previous versions of "
22056 "libguestfs all you could do would be to speculatively execute a command to "
22057 "find out if the daemon implemented it. See also C<guestfs_version>."
22061 #: ../src/guestfs-actions.pod:621 ../src/guestfs-actions.pod:1241
22062 msgid "(Added in 1.0.80)"
22066 #: ../src/guestfs-actions.pod:623
22067 msgid "guestfs_available_all_groups"
22071 #: ../src/guestfs-actions.pod:625
22075 " guestfs_available_all_groups (guestfs_h *g);\n"
22080 #: ../src/guestfs-actions.pod:628
22082 "This command returns a list of all optional groups that this daemon knows "
22083 "about. Note this returns both supported and unsupported groups. To find "
22084 "out which ones the daemon can actually support you have to call "
22085 "C<guestfs_available> on each member of the returned list."
22089 #: ../src/guestfs-actions.pod:634
22090 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
22094 #: ../src/guestfs-actions.pod:640
22095 msgid "(Added in 1.3.15)"
22099 #: ../src/guestfs-actions.pod:642
22100 msgid "guestfs_base64_in"
22104 #: ../src/guestfs-actions.pod:644
22108 " guestfs_base64_in (guestfs_h *g,\n"
22109 " const char *base64file,\n"
22110 " const char *filename);\n"
22115 #: ../src/guestfs-actions.pod:654 ../src/guestfs-actions.pod:668
22116 msgid "(Added in 1.3.5)"
22120 #: ../src/guestfs-actions.pod:656
22121 msgid "guestfs_base64_out"
22125 #: ../src/guestfs-actions.pod:658
22129 " guestfs_base64_out (guestfs_h *g,\n"
22130 " const char *filename,\n"
22131 " const char *base64file);\n"
22136 #: ../src/guestfs-actions.pod:670
22137 msgid "guestfs_blockdev_flushbufs"
22141 #: ../src/guestfs-actions.pod:672
22145 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
22146 " const char *device);\n"
22151 #: ../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
22152 msgid "(Added in 0.9.3)"
22156 #: ../src/guestfs-actions.pod:685
22157 msgid "guestfs_blockdev_getbsz"
22161 #: ../src/guestfs-actions.pod:687
22165 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
22166 " const char *device);\n"
22171 #: ../src/guestfs-actions.pod:702
22172 msgid "guestfs_blockdev_getro"
22176 #: ../src/guestfs-actions.pod:704
22180 " guestfs_blockdev_getro (guestfs_h *g,\n"
22181 " const char *device);\n"
22186 #: ../src/guestfs-actions.pod:713 ../src/guestfs-actions.pod:1479 ../src/guestfs-actions.pod:1494 ../src/guestfs-actions.pod:1983 ../src/guestfs-actions.pod:1994 ../src/guestfs-actions.pod:2066 ../src/guestfs-actions.pod:2092 ../src/guestfs-actions.pod:2132 ../src/guestfs-actions.pod:2147 ../src/guestfs-actions.pod:2172 ../src/guestfs-actions.pod:2195 ../src/guestfs-actions.pod:3253 ../src/guestfs-actions.pod:3269 ../src/guestfs-actions.pod:3287 ../src/guestfs-actions.pod:3449 ../src/guestfs-actions.pod:3463 ../src/guestfs-actions.pod:3478 ../src/guestfs-actions.pod:3492 ../src/guestfs-actions.pod:3508 ../src/guestfs-actions.pod:3523 ../src/guestfs-actions.pod:3539 ../src/guestfs-actions.pod:3553 ../src/guestfs-actions.pod:3566 ../src/guestfs-actions.pod:3580 ../src/guestfs-actions.pod:3595 ../src/guestfs-actions.pod:3610 ../src/guestfs-actions.pod:3623 ../src/guestfs-actions.pod:3637 ../src/guestfs-actions.pod:5366
22187 msgid "This function returns a C truth value on success or -1 on error."
22191 #: ../src/guestfs-actions.pod:717
22192 msgid "guestfs_blockdev_getsize64"
22196 #: ../src/guestfs-actions.pod:719
22200 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
22201 " const char *device);\n"
22206 #: ../src/guestfs-actions.pod:725
22207 msgid "See also C<guestfs_blockdev_getsz>."
22211 #: ../src/guestfs-actions.pod:733
22212 msgid "guestfs_blockdev_getss"
22216 #: ../src/guestfs-actions.pod:735
22220 " guestfs_blockdev_getss (guestfs_h *g,\n"
22221 " const char *device);\n"
22226 #: ../src/guestfs-actions.pod:742
22228 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
22233 #: ../src/guestfs-actions.pod:751
22234 msgid "guestfs_blockdev_getsz"
22238 #: ../src/guestfs-actions.pod:753
22242 " guestfs_blockdev_getsz (guestfs_h *g,\n"
22243 " const char *device);\n"
22248 #: ../src/guestfs-actions.pod:760
22250 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
22251 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
22255 #: ../src/guestfs-actions.pod:770
22256 msgid "guestfs_blockdev_rereadpt"
22260 #: ../src/guestfs-actions.pod:772
22264 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
22265 " const char *device);\n"
22270 #: ../src/guestfs-actions.pod:784
22271 msgid "guestfs_blockdev_setbsz"
22275 #: ../src/guestfs-actions.pod:786
22279 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
22280 " const char *device,\n"
22281 " int blocksize);\n"
22286 #: ../src/guestfs-actions.pod:802
22287 msgid "guestfs_blockdev_setro"
22291 #: ../src/guestfs-actions.pod:804
22295 " guestfs_blockdev_setro (guestfs_h *g,\n"
22296 " const char *device);\n"
22301 #: ../src/guestfs-actions.pod:816
22302 msgid "guestfs_blockdev_setrw"
22306 #: ../src/guestfs-actions.pod:818
22310 " guestfs_blockdev_setrw (guestfs_h *g,\n"
22311 " const char *device);\n"
22316 #: ../src/guestfs-actions.pod:830
22317 msgid "guestfs_btrfs_filesystem_resize"
22321 #: ../src/guestfs-actions.pod:832
22325 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
22326 " const char *mountpoint,\n"
22332 #: ../src/guestfs-actions.pod:842
22335 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
22340 #: ../src/guestfs-actions.pod:865
22341 msgid "(Added in 1.11.17)"
22345 #: ../src/guestfs-actions.pod:867
22346 msgid "guestfs_btrfs_filesystem_resize_va"
22350 #: ../src/guestfs-actions.pod:869
22354 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
22355 " const char *mountpoint,\n"
22356 " va_list args);\n"
22361 #: ../src/guestfs-actions.pod:874
22362 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
22366 #: ../src/guestfs-actions.pod:878
22367 msgid "guestfs_btrfs_filesystem_resize_argv"
22371 #: ../src/guestfs-actions.pod:880
22375 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
22376 " const char *mountpoint,\n"
22378 "guestfs_btrfs_filesystem_resize_argv *optargs);\n"
22383 #: ../src/guestfs-actions.pod:885
22384 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
22388 #: ../src/guestfs-actions.pod:889
22389 msgid "guestfs_case_sensitive_path"
22393 #: ../src/guestfs-actions.pod:891
22397 " guestfs_case_sensitive_path (guestfs_h *g,\n"
22398 " const char *path);\n"
22403 #: ../src/guestfs-actions.pod:917
22405 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
22406 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
22407 "how the directories were originally created under Windows)."
22411 #: ../src/guestfs-actions.pod:925
22412 msgid "See also C<guestfs_realpath>."
22416 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:7414
22417 msgid "(Added in 1.0.75)"
22421 #: ../src/guestfs-actions.pod:932
22422 msgid "guestfs_cat"
22426 #: ../src/guestfs-actions.pod:934
22430 " guestfs_cat (guestfs_h *g,\n"
22431 " const char *path);\n"
22436 #: ../src/guestfs-actions.pod:940
22438 "Note that this function cannot correctly handle binary files (specifically, "
22439 "files containing C<\\0> character which is treated as end of string). For "
22440 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
22441 "functions which have a more complex interface."
22445 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:3767 ../src/guestfs-actions.pod:3849 ../src/guestfs-actions.pod:3866 ../src/guestfs-actions.pod:3954 ../src/guestfs-actions.pod:4362 ../src/guestfs-actions.pod:4376 ../src/guestfs-actions.pod:5747 ../src/guestfs-actions.pod:5761 ../src/guestfs-actions.pod:7567 ../src/guestfs-actions.pod:7581
22446 msgid "(Added in 0.4)"
22450 #: ../src/guestfs-actions.pod:953
22451 msgid "guestfs_checksum"
22455 #: ../src/guestfs-actions.pod:955
22459 " guestfs_checksum (guestfs_h *g,\n"
22460 " const char *csumtype,\n"
22461 " const char *path);\n"
22466 #: ../src/guestfs-actions.pod:1001
22467 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
22471 #: ../src/guestfs-actions.pod:1003
22472 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
22476 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1316 ../src/guestfs-actions.pod:2163 ../src/guestfs-actions.pod:3465 ../src/guestfs-actions.pod:3494 ../src/guestfs-actions.pod:3555 ../src/guestfs-actions.pod:3582 ../src/guestfs-actions.pod:7270
22477 msgid "(Added in 1.0.2)"
22481 #: ../src/guestfs-actions.pod:1010
22482 msgid "guestfs_checksum_device"
22486 #: ../src/guestfs-actions.pod:1012
22490 " guestfs_checksum_device (guestfs_h *g,\n"
22491 " const char *csumtype,\n"
22492 " const char *device);\n"
22497 #: ../src/guestfs-actions.pod:1017
22499 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22500 "device named C<device>. For the types of checksums supported see the "
22501 "C<guestfs_checksum> command."
22505 #: ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:5196 ../src/guestfs-actions.pod:5331 ../src/guestfs-actions.pod:5368 ../src/guestfs-actions.pod:5386 ../src/guestfs-actions.pod:5568 ../src/guestfs-actions.pod:7179 ../src/guestfs-actions.pod:7193 ../src/guestfs-actions.pod:7593
22506 msgid "(Added in 1.3.2)"
22510 #: ../src/guestfs-actions.pod:1026
22511 msgid "guestfs_checksums_out"
22515 #: ../src/guestfs-actions.pod:1028
22519 " guestfs_checksums_out (guestfs_h *g,\n"
22520 " const char *csumtype,\n"
22521 " const char *directory,\n"
22522 " const char *sumsfile);\n"
22527 #: ../src/guestfs-actions.pod:1048
22528 msgid "(Added in 1.3.7)"
22532 #: ../src/guestfs-actions.pod:1050
22533 msgid "guestfs_chmod"
22537 #: ../src/guestfs-actions.pod:1052
22541 " guestfs_chmod (guestfs_h *g,\n"
22543 " const char *path);\n"
22548 #: ../src/guestfs-actions.pod:1070
22549 msgid "guestfs_chown"
22553 #: ../src/guestfs-actions.pod:1072
22557 " guestfs_chown (guestfs_h *g,\n"
22560 " const char *path);\n"
22565 #: ../src/guestfs-actions.pod:1088
22566 msgid "guestfs_command"
22570 #: ../src/guestfs-actions.pod:1090
22574 " guestfs_command (guestfs_h *g,\n"
22575 " char *const *arguments);\n"
22580 #: ../src/guestfs-actions.pod:1099
22582 "The single parameter is an argv-style list of arguments. The first element "
22583 "is the name of the program to run. Subsequent elements are parameters. The "
22584 "list must be non-empty (ie. must contain a program name). Note that the "
22585 "command runs directly, and is I<not> invoked via the shell (see "
22590 #: ../src/guestfs-actions.pod:1130 ../src/guestfs-actions.pod:1150 ../src/guestfs-actions.pod:1615
22591 msgid "(Added in 0.9.1)"
22595 #: ../src/guestfs-actions.pod:1132
22596 msgid "guestfs_command_lines"
22600 #: ../src/guestfs-actions.pod:1134
22604 " guestfs_command_lines (guestfs_h *g,\n"
22605 " char *const *arguments);\n"
22610 #: ../src/guestfs-actions.pod:1138
22612 "This is the same as C<guestfs_command>, but splits the result into a list of "
22617 #: ../src/guestfs-actions.pod:1141
22618 msgid "See also: C<guestfs_sh_lines>"
22622 #: ../src/guestfs-actions.pod:1152
22623 msgid "guestfs_config"
22627 #: ../src/guestfs-actions.pod:1154
22631 " guestfs_config (guestfs_h *g,\n"
22632 " const char *qemuparam,\n"
22633 " const char *qemuvalue);\n"
22638 #: ../src/guestfs-actions.pod:1172
22639 msgid "guestfs_copy_size"
22643 #: ../src/guestfs-actions.pod:1174
22647 " guestfs_copy_size (guestfs_h *g,\n"
22648 " const char *src,\n"
22649 " const char *dest,\n"
22650 " int64_t size);\n"
22655 #: ../src/guestfs-actions.pod:1188 ../src/guestfs-actions.pod:1311 ../src/guestfs-actions.pod:1342 ../src/guestfs-actions.pod:1387 ../src/guestfs-actions.pod:1764 ../src/guestfs-actions.pod:1786 ../src/guestfs-actions.pod:3665 ../src/guestfs-actions.pod:7265 ../src/guestfs-actions.pod:7299 ../src/guestfs-actions.pod:7806 ../src/guestfs-actions.pod:7829
22657 "This long-running command can generate progress notification messages so "
22658 "that the caller can display a progress bar or indicator. To receive these "
22659 "messages, the caller must register a progress event callback. See "
22660 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
22664 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:4389 ../src/guestfs-actions.pod:5774 ../src/guestfs-actions.pod:7500 ../src/guestfs-actions.pod:7520 ../src/guestfs-actions.pod:7606
22665 msgid "(Added in 1.0.87)"
22669 #: ../src/guestfs-actions.pod:1195
22674 #: ../src/guestfs-actions.pod:1197
22678 " guestfs_cp (guestfs_h *g,\n"
22679 " const char *src,\n"
22680 " const char *dest);\n"
22685 #: ../src/guestfs-actions.pod:1207 ../src/guestfs-actions.pod:1221 ../src/guestfs-actions.pod:1293 ../src/guestfs-actions.pod:1367 ../src/guestfs-actions.pod:1481 ../src/guestfs-actions.pod:5143 ../src/guestfs-actions.pod:5618
22686 msgid "(Added in 1.0.18)"
22690 #: ../src/guestfs-actions.pod:1209
22691 msgid "guestfs_cp_a"
22695 #: ../src/guestfs-actions.pod:1211
22699 " guestfs_cp_a (guestfs_h *g,\n"
22700 " const char *src,\n"
22701 " const char *dest);\n"
22706 #: ../src/guestfs-actions.pod:1223
22711 #: ../src/guestfs-actions.pod:1225
22715 " guestfs_dd (guestfs_h *g,\n"
22716 " const char *src,\n"
22717 " const char *dest);\n"
22722 #: ../src/guestfs-actions.pod:1235
22724 "If the destination is a device, it must be as large or larger than the "
22725 "source file or device, otherwise the copy will fail. This command cannot do "
22726 "partial copies (see C<guestfs_copy_size>)."
22730 #: ../src/guestfs-actions.pod:1243
22735 #: ../src/guestfs-actions.pod:1245
22739 " guestfs_df (guestfs_h *g);\n"
22744 #: ../src/guestfs-actions.pod:1250 ../src/guestfs-actions.pod:1267
22746 "This command is mostly useful for interactive sessions. It is I<not> "
22747 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
22752 #: ../src/guestfs-actions.pod:1257 ../src/guestfs-actions.pod:1274 ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:2388 ../src/guestfs-actions.pod:2412 ../src/guestfs-actions.pod:2480 ../src/guestfs-actions.pod:4499 ../src/guestfs-actions.pod:5043 ../src/guestfs-actions.pod:7003 ../src/guestfs-actions.pod:7027 ../src/guestfs-actions.pod:7646 ../src/guestfs-actions.pod:7659 ../src/guestfs-actions.pod:7672
22753 msgid "(Added in 1.0.54)"
22757 #: ../src/guestfs-actions.pod:1259
22758 msgid "guestfs_df_h"
22762 #: ../src/guestfs-actions.pod:1261
22766 " guestfs_df_h (guestfs_h *g);\n"
22771 #: ../src/guestfs-actions.pod:1276
22772 msgid "guestfs_dmesg"
22776 #: ../src/guestfs-actions.pod:1278
22780 " guestfs_dmesg (guestfs_h *g);\n"
22785 #: ../src/guestfs-actions.pod:1285
22787 "Another way to get the same information is to enable verbose messages with "
22788 "C<guestfs_set_verbose> or by setting the environment variable "
22789 "C<LIBGUESTFS_DEBUG=1> before running the program."
22793 #: ../src/guestfs-actions.pod:1295
22794 msgid "guestfs_download"
22798 #: ../src/guestfs-actions.pod:1297
22802 " guestfs_download (guestfs_h *g,\n"
22803 " const char *remotefilename,\n"
22804 " const char *filename);\n"
22809 #: ../src/guestfs-actions.pod:1307
22810 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
22814 #: ../src/guestfs-actions.pod:1318
22815 msgid "guestfs_download_offset"
22819 #: ../src/guestfs-actions.pod:1320
22823 " guestfs_download_offset (guestfs_h *g,\n"
22824 " const char *remotefilename,\n"
22825 " const char *filename,\n"
22826 " int64_t offset,\n"
22827 " int64_t size);\n"
22832 #: ../src/guestfs-actions.pod:1333
22834 "Note that there is no limit on the amount of data that can be downloaded "
22835 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
22836 "full amount unless an error occurs."
22840 #: ../src/guestfs-actions.pod:1338
22841 msgid "See also C<guestfs_download>, C<guestfs_pread>."
22845 #: ../src/guestfs-actions.pod:1347 ../src/guestfs-actions.pod:7304
22846 msgid "(Added in 1.5.17)"
22850 #: ../src/guestfs-actions.pod:1349
22851 msgid "guestfs_drop_caches"
22855 #: ../src/guestfs-actions.pod:1351
22859 " guestfs_drop_caches (guestfs_h *g,\n"
22860 " int whattodrop);\n"
22865 #: ../src/guestfs-actions.pod:1369
22870 #: ../src/guestfs-actions.pod:1371
22874 " guestfs_du (guestfs_h *g,\n"
22875 " const char *path);\n"
22880 #: ../src/guestfs-actions.pod:1394
22881 msgid "guestfs_e2fsck_f"
22885 #: ../src/guestfs-actions.pod:1396
22889 " guestfs_e2fsck_f (guestfs_h *g,\n"
22890 " const char *device);\n"
22895 #: ../src/guestfs-actions.pod:1404
22897 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
22898 "Normally you should use C<guestfs_fsck>."
22902 #: ../src/guestfs-actions.pod:1409
22903 msgid "(Added in 1.0.29)"
22907 #: ../src/guestfs-actions.pod:1411
22908 msgid "guestfs_echo_daemon"
22912 #: ../src/guestfs-actions.pod:1413
22916 " guestfs_echo_daemon (guestfs_h *g,\n"
22917 " char *const *words);\n"
22922 #: ../src/guestfs-actions.pod:1422
22923 msgid "See also C<guestfs_ping_daemon>."
22927 #: ../src/guestfs-actions.pod:1427 ../src/guestfs-actions.pod:2174 ../src/guestfs-actions.pod:6475
22928 msgid "(Added in 1.0.69)"
22932 #: ../src/guestfs-actions.pod:1429
22933 msgid "guestfs_egrep"
22937 #: ../src/guestfs-actions.pod:1431
22941 " guestfs_egrep (guestfs_h *g,\n"
22942 " const char *regex,\n"
22943 " const char *path);\n"
22948 #: ../src/guestfs-actions.pod:1446 ../src/guestfs-actions.pod:1465 ../src/guestfs-actions.pod:1522 ../src/guestfs-actions.pod:1568 ../src/guestfs-actions.pod:1587 ../src/guestfs-actions.pod:2304 ../src/guestfs-actions.pod:2323 ../src/guestfs-actions.pod:2501 ../src/guestfs-actions.pod:2514 ../src/guestfs-actions.pod:2529 ../src/guestfs-actions.pod:2575 ../src/guestfs-actions.pod:2597 ../src/guestfs-actions.pod:2610 ../src/guestfs-actions.pod:3879 ../src/guestfs-actions.pod:3893 ../src/guestfs-actions.pod:3906 ../src/guestfs-actions.pod:3920 ../src/guestfs-actions.pod:4921 ../src/guestfs-actions.pod:5952 ../src/guestfs-actions.pod:6001 ../src/guestfs-actions.pod:6871 ../src/guestfs-actions.pod:6883 ../src/guestfs-actions.pod:6896 ../src/guestfs-actions.pod:6909 ../src/guestfs-actions.pod:6931 ../src/guestfs-actions.pod:6944 ../src/guestfs-actions.pod:6957 ../src/guestfs-actions.pod:6970 ../src/guestfs-actions.pod:7764 ../src/guestfs-actions.pod:7783 ../src/guestfs-actions.pod:7877 ../src/guestfs-actions.pod:7896 ../src/guestfs-actions.pod:7942 ../src/guestfs-actions.pod:7961
22949 msgid "(Added in 1.0.66)"
22953 #: ../src/guestfs-actions.pod:1448
22954 msgid "guestfs_egrepi"
22958 #: ../src/guestfs-actions.pod:1450
22962 " guestfs_egrepi (guestfs_h *g,\n"
22963 " const char *regex,\n"
22964 " const char *path);\n"
22969 #: ../src/guestfs-actions.pod:1467
22970 msgid "guestfs_equal"
22974 #: ../src/guestfs-actions.pod:1469
22978 " guestfs_equal (guestfs_h *g,\n"
22979 " const char *file1,\n"
22980 " const char *file2);\n"
22985 #: ../src/guestfs-actions.pod:1483
22986 msgid "guestfs_exists"
22990 #: ../src/guestfs-actions.pod:1485
22994 " guestfs_exists (guestfs_h *g,\n"
22995 " const char *path);\n"
23000 #: ../src/guestfs-actions.pod:1492
23001 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
23005 #: ../src/guestfs-actions.pod:1498
23006 msgid "guestfs_fallocate"
23010 #: ../src/guestfs-actions.pod:1500
23014 " guestfs_fallocate (guestfs_h *g,\n"
23015 " const char *path,\n"
23021 #: ../src/guestfs-actions.pod:1515
23023 "This function is deprecated. In new code, use the L</guestfs_fallocate64> "
23028 #: ../src/guestfs-actions.pod:1524
23029 msgid "guestfs_fallocate64"
23033 #: ../src/guestfs-actions.pod:1526
23037 " guestfs_fallocate64 (guestfs_h *g,\n"
23038 " const char *path,\n"
23044 #: ../src/guestfs-actions.pod:1535
23046 "Note that this call allocates disk blocks for the file. To create a sparse "
23047 "file use C<guestfs_truncate_size> instead."
23051 #: ../src/guestfs-actions.pod:1538
23053 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
23054 "oversight it only allowed 30 bit lengths to be specified, effectively "
23055 "limiting the maximum size of files created through that call to 1GB."
23059 #: ../src/guestfs-actions.pod:1549
23060 msgid "(Added in 1.3.17)"
23064 #: ../src/guestfs-actions.pod:1551
23065 msgid "guestfs_fgrep"
23069 #: ../src/guestfs-actions.pod:1553
23073 " guestfs_fgrep (guestfs_h *g,\n"
23074 " const char *pattern,\n"
23075 " const char *path);\n"
23080 #: ../src/guestfs-actions.pod:1570
23081 msgid "guestfs_fgrepi"
23085 #: ../src/guestfs-actions.pod:1572
23089 " guestfs_fgrepi (guestfs_h *g,\n"
23090 " const char *pattern,\n"
23091 " const char *path);\n"
23096 #: ../src/guestfs-actions.pod:1589
23097 msgid "guestfs_file"
23101 #: ../src/guestfs-actions.pod:1591
23105 " guestfs_file (guestfs_h *g,\n"
23106 " const char *path);\n"
23111 #: ../src/guestfs-actions.pod:1609
23113 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
23114 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
23118 #: ../src/guestfs-actions.pod:1617
23119 msgid "guestfs_file_architecture"
23123 #: ../src/guestfs-actions.pod:1619
23127 " guestfs_file_architecture (guestfs_h *g,\n"
23128 " const char *filename);\n"
23133 #: ../src/guestfs-actions.pod:1727 ../src/guestfs-actions.pod:1890 ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:2630 ../src/guestfs-actions.pod:2720 ../src/guestfs-actions.pod:2786 ../src/guestfs-actions.pod:2973 ../src/guestfs-actions.pod:2991 ../src/guestfs-actions.pod:3031 ../src/guestfs-actions.pod:3106 ../src/guestfs-actions.pod:3199 ../src/guestfs-actions.pod:3436 ../src/guestfs-actions.pod:3568
23134 msgid "(Added in 1.5.3)"
23138 #: ../src/guestfs-actions.pod:1729
23139 msgid "guestfs_filesize"
23143 #: ../src/guestfs-actions.pod:1731
23147 " guestfs_filesize (guestfs_h *g,\n"
23148 " const char *file);\n"
23153 #: ../src/guestfs-actions.pod:1737
23155 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
23156 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
23157 "devices, use C<guestfs_blockdev_getsize64>."
23161 #: ../src/guestfs-actions.pod:1743
23162 msgid "(Added in 1.0.82)"
23166 #: ../src/guestfs-actions.pod:1745
23167 msgid "guestfs_fill"
23171 #: ../src/guestfs-actions.pod:1747
23175 " guestfs_fill (guestfs_h *g,\n"
23178 " const char *path);\n"
23183 #: ../src/guestfs-actions.pod:1757
23185 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23186 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
23187 "bytes use C<guestfs_fill_pattern>."
23191 #: ../src/guestfs-actions.pod:1769
23192 msgid "(Added in 1.0.79)"
23196 #: ../src/guestfs-actions.pod:1771
23197 msgid "guestfs_fill_pattern"
23201 #: ../src/guestfs-actions.pod:1773
23205 " guestfs_fill_pattern (guestfs_h *g,\n"
23206 " const char *pattern,\n"
23208 " const char *path);\n"
23213 #: ../src/guestfs-actions.pod:1779
23215 "This function is like C<guestfs_fill> except that it creates a new file of "
23216 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
23217 "pattern is truncated if necessary to ensure the length of the file is "
23218 "exactly C<len> bytes."
23222 #: ../src/guestfs-actions.pod:1791
23223 msgid "(Added in 1.3.12)"
23227 #: ../src/guestfs-actions.pod:1793
23228 msgid "guestfs_find"
23232 #: ../src/guestfs-actions.pod:1795
23236 " guestfs_find (guestfs_h *g,\n"
23237 " const char *directory);\n"
23242 #: ../src/guestfs-actions.pod:1811
23243 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
23247 #: ../src/guestfs-actions.pod:1824
23248 msgid "See also C<guestfs_find0>."
23252 #: ../src/guestfs-actions.pod:1833 ../src/guestfs-actions.pod:4326 ../src/guestfs-actions.pod:6036
23253 msgid "(Added in 1.0.27)"
23257 #: ../src/guestfs-actions.pod:1835
23258 msgid "guestfs_find0"
23262 #: ../src/guestfs-actions.pod:1837
23266 " guestfs_find0 (guestfs_h *g,\n"
23267 " const char *directory,\n"
23268 " const char *files);\n"
23273 #: ../src/guestfs-actions.pod:1846
23275 "This command works the same way as C<guestfs_find> with the following "
23280 #: ../src/guestfs-actions.pod:1873
23281 msgid "(Added in 1.0.74)"
23285 #: ../src/guestfs-actions.pod:1875
23286 msgid "guestfs_findfs_label"
23290 #: ../src/guestfs-actions.pod:1877
23294 " guestfs_findfs_label (guestfs_h *g,\n"
23295 " const char *label);\n"
23300 #: ../src/guestfs-actions.pod:1885
23301 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
23305 #: ../src/guestfs-actions.pod:1892
23306 msgid "guestfs_findfs_uuid"
23310 #: ../src/guestfs-actions.pod:1894
23314 " guestfs_findfs_uuid (guestfs_h *g,\n"
23315 " const char *uuid);\n"
23320 #: ../src/guestfs-actions.pod:1902
23321 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
23325 #: ../src/guestfs-actions.pod:1909
23326 msgid "guestfs_fsck"
23330 #: ../src/guestfs-actions.pod:1911
23334 " guestfs_fsck (guestfs_h *g,\n"
23335 " const char *fstype,\n"
23336 " const char *device);\n"
23341 #: ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:7811
23342 msgid "(Added in 1.0.16)"
23346 #: ../src/guestfs-actions.pod:1948
23347 msgid "guestfs_get_append"
23351 #: ../src/guestfs-actions.pod:1950
23355 " guestfs_get_append (guestfs_h *g);\n"
23360 #: ../src/guestfs-actions.pod:1958
23362 "This function returns a string which may be NULL. There is no way to return "
23363 "an error from this function. The string is owned by the guest handle and "
23364 "must I<not> be freed."
23368 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:5714 ../src/guestfs-actions.pod:6196 ../src/guestfs-actions.pod:6638 ../src/guestfs-actions.pod:6657 ../src/guestfs-actions.pod:6673 ../src/guestfs-actions.pod:6697 ../src/guestfs-actions.pod:7451 ../src/guestfs-actions.pod:7466 ../src/guestfs-actions.pod:7858
23369 msgid "(Added in 1.0.26)"
23373 #: ../src/guestfs-actions.pod:1964
23374 msgid "guestfs_get_attach_method"
23378 #: ../src/guestfs-actions.pod:1966
23382 " guestfs_get_attach_method (guestfs_h *g);\n"
23387 #: ../src/guestfs-actions.pod:1969
23388 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
23392 #: ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:6226
23393 msgid "(Added in 1.9.8)"
23397 #: ../src/guestfs-actions.pod:1976
23398 msgid "guestfs_get_autosync"
23402 #: ../src/guestfs-actions.pod:1978
23406 " guestfs_get_autosync (guestfs_h *g);\n"
23411 #: ../src/guestfs-actions.pod:1987
23412 msgid "guestfs_get_direct"
23416 #: ../src/guestfs-actions.pod:1989
23420 " guestfs_get_direct (guestfs_h *g);\n"
23425 #: ../src/guestfs-actions.pod:1996 ../src/guestfs-actions.pod:6267
23426 msgid "(Added in 1.0.72)"
23430 #: ../src/guestfs-actions.pod:1998
23431 msgid "guestfs_get_e2label"
23435 #: ../src/guestfs-actions.pod:2000
23439 " guestfs_get_e2label (guestfs_h *g,\n"
23440 " const char *device);\n"
23445 #: ../src/guestfs-actions.pod:2010
23447 "This function is deprecated. In new code, use the L</guestfs_vfs_label> "
23452 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2038 ../src/guestfs-actions.pod:6285 ../src/guestfs-actions.pod:6304
23453 msgid "(Added in 1.0.15)"
23457 #: ../src/guestfs-actions.pod:2019
23458 msgid "guestfs_get_e2uuid"
23462 #: ../src/guestfs-actions.pod:2021
23466 " guestfs_get_e2uuid (guestfs_h *g,\n"
23467 " const char *device);\n"
23472 #: ../src/guestfs-actions.pod:2031
23474 "This function is deprecated. In new code, use the L</guestfs_vfs_uuid> call "
23479 #: ../src/guestfs-actions.pod:2040
23480 msgid "guestfs_get_memsize"
23484 #: ../src/guestfs-actions.pod:2042
23488 " guestfs_get_memsize (guestfs_h *g);\n"
23493 #: ../src/guestfs-actions.pod:2048
23495 "If C<guestfs_set_memsize> was not called on this handle, and if "
23496 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23497 "value for memsize."
23501 #: ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:4617 ../src/guestfs-actions.pod:4826 ../src/guestfs-actions.pod:4845 ../src/guestfs-actions.pod:4864 ../src/guestfs-actions.pod:4876 ../src/guestfs-actions.pod:4893 ../src/guestfs-actions.pod:4906 ../src/guestfs-actions.pod:5939 ../src/guestfs-actions.pod:6325 ../src/guestfs-actions.pod:6605 ../src/guestfs-actions.pod:7220
23502 msgid "(Added in 1.0.55)"
23506 #: ../src/guestfs-actions.pod:2059
23507 msgid "guestfs_get_network"
23511 #: ../src/guestfs-actions.pod:2061
23515 " guestfs_get_network (guestfs_h *g);\n"
23520 #: ../src/guestfs-actions.pod:2068 ../src/guestfs-actions.pod:6344
23521 msgid "(Added in 1.5.4)"
23525 #: ../src/guestfs-actions.pod:2070
23526 msgid "guestfs_get_path"
23530 #: ../src/guestfs-actions.pod:2072
23534 " guestfs_get_path (guestfs_h *g);\n"
23539 #: ../src/guestfs-actions.pod:2080 ../src/guestfs-actions.pod:2120
23541 "This function returns a string, or NULL on error. The string is owned by "
23542 "the guest handle and must I<not> be freed."
23546 #: ../src/guestfs-actions.pod:2085
23547 msgid "guestfs_get_pgroup"
23551 #: ../src/guestfs-actions.pod:2087
23555 " guestfs_get_pgroup (guestfs_h *g);\n"
23560 #: ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:6380 ../src/guestfs-actions.pod:7712
23561 msgid "(Added in 1.11.18)"
23565 #: ../src/guestfs-actions.pod:2096
23566 msgid "guestfs_get_pid"
23570 #: ../src/guestfs-actions.pod:2098
23574 " guestfs_get_pid (guestfs_h *g);\n"
23579 #: ../src/guestfs-actions.pod:2108
23580 msgid "(Added in 1.0.56)"
23584 #: ../src/guestfs-actions.pod:2110
23585 msgid "guestfs_get_qemu"
23589 #: ../src/guestfs-actions.pod:2112
23593 " guestfs_get_qemu (guestfs_h *g);\n"
23598 #: ../src/guestfs-actions.pod:2123 ../src/guestfs-actions.pod:6408
23599 msgid "(Added in 1.0.6)"
23603 #: ../src/guestfs-actions.pod:2125
23604 msgid "guestfs_get_recovery_proc"
23608 #: ../src/guestfs-actions.pod:2127
23612 " guestfs_get_recovery_proc (guestfs_h *g);\n"
23617 #: ../src/guestfs-actions.pod:2134 ../src/guestfs-actions.pod:3690 ../src/guestfs-actions.pod:4021 ../src/guestfs-actions.pod:4424 ../src/guestfs-actions.pod:4456 ../src/guestfs-actions.pod:5644 ../src/guestfs-actions.pod:5987 ../src/guestfs-actions.pod:6432 ../src/guestfs-actions.pod:7123 ../src/guestfs-actions.pod:7143 ../src/guestfs-actions.pod:7335
23618 msgid "(Added in 1.0.77)"
23622 #: ../src/guestfs-actions.pod:2136
23623 msgid "guestfs_get_selinux"
23627 #: ../src/guestfs-actions.pod:2138
23631 " guestfs_get_selinux (guestfs_h *g);\n"
23636 #: ../src/guestfs-actions.pod:2141
23638 "This returns the current setting of the selinux flag which is passed to the "
23639 "appliance at boot time. See C<guestfs_set_selinux>."
23643 #: ../src/guestfs-actions.pod:2149 ../src/guestfs-actions.pod:2212 ../src/guestfs-actions.pod:6451 ../src/guestfs-actions.pod:6509
23644 msgid "(Added in 1.0.67)"
23648 #: ../src/guestfs-actions.pod:2151
23649 msgid "guestfs_get_state"
23653 #: ../src/guestfs-actions.pod:2153
23657 " guestfs_get_state (guestfs_h *g);\n"
23662 #: ../src/guestfs-actions.pod:2165
23663 msgid "guestfs_get_trace"
23667 #: ../src/guestfs-actions.pod:2167
23671 " guestfs_get_trace (guestfs_h *g);\n"
23676 #: ../src/guestfs-actions.pod:2176
23677 msgid "guestfs_get_umask"
23681 #: ../src/guestfs-actions.pod:2178
23685 " guestfs_get_umask (guestfs_h *g);\n"
23690 #: ../src/guestfs-actions.pod:2181
23692 "Return the current umask. By default the umask is C<022> unless it has been "
23693 "set by calling C<guestfs_umask>."
23697 #: ../src/guestfs-actions.pod:2188
23698 msgid "guestfs_get_verbose"
23702 #: ../src/guestfs-actions.pod:2190
23706 " guestfs_get_verbose (guestfs_h *g);\n"
23711 #: ../src/guestfs-actions.pod:2199
23712 msgid "guestfs_getcon"
23716 #: ../src/guestfs-actions.pod:2201
23720 " guestfs_getcon (guestfs_h *g);\n"
23725 #: ../src/guestfs-actions.pod:2206
23726 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
23730 #: ../src/guestfs-actions.pod:2214
23731 msgid "guestfs_getxattr"
23735 #: ../src/guestfs-actions.pod:2216
23739 " guestfs_getxattr (guestfs_h *g,\n"
23740 " const char *path,\n"
23741 " const char *name,\n"
23742 " size_t *size_r);\n"
23747 #: ../src/guestfs-actions.pod:2222
23749 "Get a single extended attribute from file C<path> named C<name>. This call "
23750 "follows symlinks. If you want to lookup an extended attribute for the "
23751 "symlink itself, use C<guestfs_lgetxattr>."
23755 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:3704
23757 "Normally it is better to get all extended attributes from a file in one go "
23758 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
23759 "implementations are buggy and do not provide a way to list out attributes. "
23760 "For these filesystems (notably ntfs-3g) you have to know the names of the "
23761 "extended attributes you want in advance and call this function."
23765 #: ../src/guestfs-actions.pod:2236
23766 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
23770 #: ../src/guestfs-actions.pod:2238 ../src/guestfs-actions.pod:2451 ../src/guestfs-actions.pod:2921 ../src/guestfs-actions.pod:3716 ../src/guestfs-actions.pod:5637 ../src/guestfs-actions.pod:5663 ../src/guestfs-actions.pod:5844
23772 "This function returns a buffer, or NULL on error. The size of the returned "
23773 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
23778 #: ../src/guestfs-actions.pod:2242 ../src/guestfs-actions.pod:3720
23779 msgid "(Added in 1.7.24)"
23783 #: ../src/guestfs-actions.pod:2244
23784 msgid "guestfs_getxattrs"
23788 #: ../src/guestfs-actions.pod:2246
23791 " struct guestfs_xattr_list *\n"
23792 " guestfs_getxattrs (guestfs_h *g,\n"
23793 " const char *path);\n"
23798 #: ../src/guestfs-actions.pod:2256
23799 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
23803 #: ../src/guestfs-actions.pod:2258 ../src/guestfs-actions.pod:3732 ../src/guestfs-actions.pod:4420
23805 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
23806 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
23810 #: ../src/guestfs-actions.pod:2262 ../src/guestfs-actions.pod:3736 ../src/guestfs-actions.pod:3935 ../src/guestfs-actions.pod:3971 ../src/guestfs-actions.pod:6017 ../src/guestfs-actions.pod:6528 ../src/guestfs-actions.pod:7923
23811 msgid "(Added in 1.0.59)"
23815 #: ../src/guestfs-actions.pod:2264
23816 msgid "guestfs_glob_expand"
23820 #: ../src/guestfs-actions.pod:2266
23824 " guestfs_glob_expand (guestfs_h *g,\n"
23825 " const char *pattern);\n"
23830 #: ../src/guestfs-actions.pod:2285 ../src/guestfs-actions.pod:6721 ../src/guestfs-actions.pod:6738
23831 msgid "(Added in 1.0.50)"
23835 #: ../src/guestfs-actions.pod:2287
23836 msgid "guestfs_grep"
23840 #: ../src/guestfs-actions.pod:2289
23844 " guestfs_grep (guestfs_h *g,\n"
23845 " const char *regex,\n"
23846 " const char *path);\n"
23851 #: ../src/guestfs-actions.pod:2306
23852 msgid "guestfs_grepi"
23856 #: ../src/guestfs-actions.pod:2308
23860 " guestfs_grepi (guestfs_h *g,\n"
23861 " const char *regex,\n"
23862 " const char *path);\n"
23867 #: ../src/guestfs-actions.pod:2325
23868 msgid "guestfs_grub_install"
23872 #: ../src/guestfs-actions.pod:2327
23876 " guestfs_grub_install (guestfs_h *g,\n"
23877 " const char *root,\n"
23878 " const char *device);\n"
23883 #: ../src/guestfs-actions.pod:2370
23884 msgid "(Added in 1.0.17)"
23888 #: ../src/guestfs-actions.pod:2372
23889 msgid "guestfs_head"
23893 #: ../src/guestfs-actions.pod:2374
23897 " guestfs_head (guestfs_h *g,\n"
23898 " const char *path);\n"
23903 #: ../src/guestfs-actions.pod:2390
23904 msgid "guestfs_head_n"
23908 #: ../src/guestfs-actions.pod:2392
23912 " guestfs_head_n (guestfs_h *g,\n"
23914 " const char *path);\n"
23919 #: ../src/guestfs-actions.pod:2414
23920 msgid "guestfs_hexdump"
23924 #: ../src/guestfs-actions.pod:2416
23928 " guestfs_hexdump (guestfs_h *g,\n"
23929 " const char *path);\n"
23934 #: ../src/guestfs-actions.pod:2429 ../src/guestfs-actions.pod:6802 ../src/guestfs-actions.pod:6857
23935 msgid "(Added in 1.0.22)"
23939 #: ../src/guestfs-actions.pod:2431
23940 msgid "guestfs_initrd_cat"
23944 #: ../src/guestfs-actions.pod:2433
23948 " guestfs_initrd_cat (guestfs_h *g,\n"
23949 " const char *initrdpath,\n"
23950 " const char *filename,\n"
23951 " size_t *size_r);\n"
23956 #: ../src/guestfs-actions.pod:2449
23957 msgid "See also C<guestfs_initrd_list>."
23961 #: ../src/guestfs-actions.pod:2460
23962 msgid "guestfs_initrd_list"
23966 #: ../src/guestfs-actions.pod:2462
23970 " guestfs_initrd_list (guestfs_h *g,\n"
23971 " const char *path);\n"
23976 #: ../src/guestfs-actions.pod:2482
23977 msgid "guestfs_inotify_add_watch"
23981 #: ../src/guestfs-actions.pod:2484
23985 " guestfs_inotify_add_watch (guestfs_h *g,\n"
23986 " const char *path,\n"
23992 #: ../src/guestfs-actions.pod:2503
23993 msgid "guestfs_inotify_close"
23997 #: ../src/guestfs-actions.pod:2505
24001 " guestfs_inotify_close (guestfs_h *g);\n"
24006 #: ../src/guestfs-actions.pod:2516
24007 msgid "guestfs_inotify_files"
24011 #: ../src/guestfs-actions.pod:2518
24015 " guestfs_inotify_files (guestfs_h *g);\n"
24020 #: ../src/guestfs-actions.pod:2521
24022 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
24023 "returns a list of pathnames of objects that were touched. The returned "
24024 "pathnames are sorted and deduplicated."
24028 #: ../src/guestfs-actions.pod:2531
24029 msgid "guestfs_inotify_init"
24033 #: ../src/guestfs-actions.pod:2533
24037 " guestfs_inotify_init (guestfs_h *g,\n"
24038 " int maxevents);\n"
24043 #: ../src/guestfs-actions.pod:2541
24045 "C<maxevents> is the maximum number of events which will be queued up between "
24046 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
24047 "passed as C<0>, then the kernel (or previously set) default is used. For "
24048 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
24049 "throws away events, but records the fact that it threw them away by setting "
24050 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
24051 "C<guestfs_inotify_read>)."
24055 #: ../src/guestfs-actions.pod:2551
24057 "Before any events are generated, you have to add some watches to the "
24058 "internal watch list. See: C<guestfs_inotify_add_watch>, "
24059 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
24063 #: ../src/guestfs-actions.pod:2557
24065 "Queued up events should be read periodically by calling "
24066 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
24067 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
24068 "often enough then you risk the internal queue overflowing."
24072 #: ../src/guestfs-actions.pod:2564
24074 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
24075 "This also removes any watches automatically."
24079 #: ../src/guestfs-actions.pod:2577
24080 msgid "guestfs_inotify_read"
24084 #: ../src/guestfs-actions.pod:2579
24087 " struct guestfs_inotify_event_list *\n"
24088 " guestfs_inotify_read (guestfs_h *g);\n"
24093 #: ../src/guestfs-actions.pod:2593
24095 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
24096 "there was an error. I<The caller must call "
24097 "C<guestfs_free_inotify_event_list> after use>."
24101 #: ../src/guestfs-actions.pod:2599
24102 msgid "guestfs_inotify_rm_watch"
24106 #: ../src/guestfs-actions.pod:2601
24110 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
24116 #: ../src/guestfs-actions.pod:2605
24118 "Remove a previously defined inotify watch. See "
24119 "C<guestfs_inotify_add_watch>."
24123 #: ../src/guestfs-actions.pod:2612
24124 msgid "guestfs_inspect_get_arch"
24128 #: ../src/guestfs-actions.pod:2614
24132 " guestfs_inspect_get_arch (guestfs_h *g,\n"
24133 " const char *root);\n"
24138 #: ../src/guestfs-actions.pod:2618
24140 "This returns the architecture of the inspected operating system. The "
24141 "possible return values are listed under C<guestfs_file_architecture>."
24145 #: ../src/guestfs-actions.pod:2632
24146 msgid "guestfs_inspect_get_distro"
24150 #: ../src/guestfs-actions.pod:2634
24154 " guestfs_inspect_get_distro (guestfs_h *g,\n"
24155 " const char *root);\n"
24160 #: ../src/guestfs-actions.pod:2722
24161 msgid "guestfs_inspect_get_drive_mappings"
24165 #: ../src/guestfs-actions.pod:2724
24169 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
24170 " const char *root);\n"
24175 #: ../src/guestfs-actions.pod:2753
24177 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24178 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
24182 #: ../src/guestfs-actions.pod:2757 ../src/guestfs-actions.pod:3025 ../src/guestfs-actions.pod:3823 ../src/guestfs-actions.pod:5105 ../src/guestfs-actions.pod:7159
24184 "This function returns a NULL-terminated array of strings, or NULL if there "
24185 "was an error. The array of strings will always have length C<2n+1>, where "
24186 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
24187 "caller must free the strings and the array after use>."
24191 #: ../src/guestfs-actions.pod:2763 ../src/guestfs-actions.pod:3219
24192 msgid "(Added in 1.9.17)"
24196 #: ../src/guestfs-actions.pod:2765
24197 msgid "guestfs_inspect_get_filesystems"
24201 #: ../src/guestfs-actions.pod:2767
24205 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
24206 " const char *root);\n"
24211 #: ../src/guestfs-actions.pod:2779
24213 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24214 "C<guestfs_inspect_get_mountpoints>."
24218 #: ../src/guestfs-actions.pod:2788
24219 msgid "guestfs_inspect_get_format"
24223 #: ../src/guestfs-actions.pod:2790
24227 " guestfs_inspect_get_format (guestfs_h *g,\n"
24228 " const char *root);\n"
24233 #: ../src/guestfs-actions.pod:2824 ../src/guestfs-actions.pod:3255 ../src/guestfs-actions.pod:3271 ../src/guestfs-actions.pod:3289 ../src/guestfs-actions.pod:6055
24234 msgid "(Added in 1.9.4)"
24238 #: ../src/guestfs-actions.pod:2826
24239 msgid "guestfs_inspect_get_hostname"
24243 #: ../src/guestfs-actions.pod:2828
24247 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
24248 " const char *root);\n"
24253 #: ../src/guestfs-actions.pod:2843
24254 msgid "(Added in 1.7.9)"
24258 #: ../src/guestfs-actions.pod:2845
24259 msgid "guestfs_inspect_get_icon"
24263 #: ../src/guestfs-actions.pod:2847
24267 " guestfs_inspect_get_icon (guestfs_h *g,\n"
24268 " const char *root,\n"
24269 " size_t *size_r,\n"
24275 #: ../src/guestfs-actions.pod:2858
24278 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
24279 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
24284 #: ../src/guestfs-actions.pod:2925 ../src/guestfs-actions.pod:3750 ../src/guestfs-actions.pod:5004
24285 msgid "(Added in 1.11.12)"
24289 #: ../src/guestfs-actions.pod:2927
24290 msgid "guestfs_inspect_get_icon_va"
24294 #: ../src/guestfs-actions.pod:2929
24298 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
24299 " const char *root,\n"
24300 " size_t *size_r,\n"
24301 " va_list args);\n"
24306 #: ../src/guestfs-actions.pod:2935
24307 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
24311 #: ../src/guestfs-actions.pod:2939
24312 msgid "guestfs_inspect_get_icon_argv"
24316 #: ../src/guestfs-actions.pod:2941
24320 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
24321 " const char *root,\n"
24322 " size_t *size_r,\n"
24323 " const struct guestfs_inspect_get_icon_argv "
24329 #: ../src/guestfs-actions.pod:2947
24330 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
24334 #: ../src/guestfs-actions.pod:2951
24335 msgid "guestfs_inspect_get_major_version"
24339 #: ../src/guestfs-actions.pod:2953
24343 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
24344 " const char *root);\n"
24349 #: ../src/guestfs-actions.pod:2975
24350 msgid "guestfs_inspect_get_minor_version"
24354 #: ../src/guestfs-actions.pod:2977
24358 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
24359 " const char *root);\n"
24364 #: ../src/guestfs-actions.pod:2986
24366 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24367 "C<guestfs_inspect_get_major_version>."
24371 #: ../src/guestfs-actions.pod:2993
24372 msgid "guestfs_inspect_get_mountpoints"
24376 #: ../src/guestfs-actions.pod:2995
24380 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
24381 " const char *root);\n"
24386 #: ../src/guestfs-actions.pod:3016
24388 "For operating systems like Windows which still use drive letters, this call "
24389 "will only return an entry for the first drive \"mounted on\" C</>. For "
24390 "information about the mapping of drive letters to partitions, see "
24391 "C<guestfs_inspect_get_drive_mappings>."
24395 #: ../src/guestfs-actions.pod:3022
24397 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24398 "C<guestfs_inspect_get_filesystems>."
24402 #: ../src/guestfs-actions.pod:3033
24403 msgid "guestfs_inspect_get_package_format"
24407 #: ../src/guestfs-actions.pod:3035
24411 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
24412 " const char *root);\n"
24417 #: ../src/guestfs-actions.pod:3039
24419 "This function and C<guestfs_inspect_get_package_management> return the "
24420 "package format and package management tool used by the inspected operating "
24421 "system. For example for Fedora these functions would return C<rpm> (package "
24422 "format) and C<yum> (package management)."
24426 #: ../src/guestfs-actions.pod:3057 ../src/guestfs-actions.pod:3085
24427 msgid "(Added in 1.7.5)"
24431 #: ../src/guestfs-actions.pod:3059
24432 msgid "guestfs_inspect_get_package_management"
24436 #: ../src/guestfs-actions.pod:3061
24440 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
24441 " const char *root);\n"
24446 #: ../src/guestfs-actions.pod:3065
24448 "C<guestfs_inspect_get_package_format> and this function return the package "
24449 "format and package management tool used by the inspected operating system. "
24450 "For example for Fedora these functions would return C<rpm> (package format) "
24451 "and C<yum> (package management)."
24455 #: ../src/guestfs-actions.pod:3087
24456 msgid "guestfs_inspect_get_product_name"
24460 #: ../src/guestfs-actions.pod:3089
24464 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
24465 " const char *root);\n"
24470 #: ../src/guestfs-actions.pod:3108
24471 msgid "guestfs_inspect_get_product_variant"
24475 #: ../src/guestfs-actions.pod:3110
24479 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
24480 " const char *root);\n"
24485 #: ../src/guestfs-actions.pod:3133
24487 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24488 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
24492 #: ../src/guestfs-actions.pod:3140
24493 msgid "(Added in 1.9.13)"
24497 #: ../src/guestfs-actions.pod:3142
24498 msgid "guestfs_inspect_get_roots"
24502 #: ../src/guestfs-actions.pod:3144
24506 " guestfs_inspect_get_roots (guestfs_h *g);\n"
24511 #: ../src/guestfs-actions.pod:3147
24513 "This function is a convenient way to get the list of root devices, as "
24514 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
24515 "the whole inspection process."
24519 #: ../src/guestfs-actions.pod:3151
24521 "This returns an empty list if either no root devices were found or the "
24522 "caller has not called C<guestfs_inspect_os>."
24526 #: ../src/guestfs-actions.pod:3160
24527 msgid "(Added in 1.7.3)"
24531 #: ../src/guestfs-actions.pod:3162
24532 msgid "guestfs_inspect_get_type"
24536 #: ../src/guestfs-actions.pod:3164
24540 " guestfs_inspect_get_type (guestfs_h *g,\n"
24541 " const char *root);\n"
24546 #: ../src/guestfs-actions.pod:3201
24547 msgid "guestfs_inspect_get_windows_current_control_set"
24551 #: ../src/guestfs-actions.pod:3203
24555 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
24556 " const char *root);\n"
24561 #: ../src/guestfs-actions.pod:3221
24562 msgid "guestfs_inspect_get_windows_systemroot"
24566 #: ../src/guestfs-actions.pod:3223
24570 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
24571 " const char *root);\n"
24576 #: ../src/guestfs-actions.pod:3239
24577 msgid "(Added in 1.5.25)"
24581 #: ../src/guestfs-actions.pod:3241
24582 msgid "guestfs_inspect_is_live"
24586 #: ../src/guestfs-actions.pod:3243
24590 " guestfs_inspect_is_live (guestfs_h *g,\n"
24591 " const char *root);\n"
24596 #: ../src/guestfs-actions.pod:3247
24598 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
24599 "disk), then this returns true if a live image was detected on the disk."
24603 #: ../src/guestfs-actions.pod:3257
24604 msgid "guestfs_inspect_is_multipart"
24608 #: ../src/guestfs-actions.pod:3259
24612 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
24613 " const char *root);\n"
24618 #: ../src/guestfs-actions.pod:3263
24620 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
24621 "disk), then this returns true if the disk is part of a set."
24625 #: ../src/guestfs-actions.pod:3273
24626 msgid "guestfs_inspect_is_netinst"
24630 #: ../src/guestfs-actions.pod:3275
24634 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
24635 " const char *root);\n"
24640 #: ../src/guestfs-actions.pod:3279
24642 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
24643 "disk), then this returns true if the disk is a network installer, ie. not a "
24644 "self-contained install CD but one which is likely to require network access "
24645 "to complete the install."
24649 #: ../src/guestfs-actions.pod:3291
24650 msgid "guestfs_inspect_list_applications"
24654 #: ../src/guestfs-actions.pod:3293
24657 " struct guestfs_application_list *\n"
24658 " guestfs_inspect_list_applications (guestfs_h *g,\n"
24659 " const char *root);\n"
24664 #: ../src/guestfs-actions.pod:3299
24666 "I<Note:> This call works differently from other parts of the inspection "
24667 "API. You have to call C<guestfs_inspect_os>, then "
24668 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
24669 "this. Listing applications is a significantly more difficult operation "
24670 "which requires access to the full filesystem. Also note that unlike the "
24671 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
24672 "the libguestfs handle, this call actually reads parts of the mounted "
24673 "filesystems during the call."
24677 #: ../src/guestfs-actions.pod:3389
24679 "This function returns a C<struct guestfs_application_list *>, or NULL if "
24680 "there was an error. I<The caller must call C<guestfs_free_application_list> "
24685 #: ../src/guestfs-actions.pod:3393
24686 msgid "(Added in 1.7.8)"
24690 #: ../src/guestfs-actions.pod:3395
24691 msgid "guestfs_inspect_os"
24695 #: ../src/guestfs-actions.pod:3397
24699 " guestfs_inspect_os (guestfs_h *g);\n"
24704 #: ../src/guestfs-actions.pod:3413
24706 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
24707 "functions in order to query further information about each operating system, "
24708 "such as the name and version."
24712 #: ../src/guestfs-actions.pod:3418
24714 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
24715 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
24716 "the contents. This should be called with no disks currently mounted. The "
24717 "function may also use Augeas, so any existing Augeas handle will be closed."
24721 #: ../src/guestfs-actions.pod:3430 ../src/guestfs-actions.pod:3761 ../src/guestfs-actions.pod:3843
24722 msgid "See also C<guestfs_list_filesystems>."
24726 #: ../src/guestfs-actions.pod:3438
24727 msgid "guestfs_is_blockdev"
24731 #: ../src/guestfs-actions.pod:3440
24735 " guestfs_is_blockdev (guestfs_h *g,\n"
24736 " const char *path);\n"
24741 #: ../src/guestfs-actions.pod:3447 ../src/guestfs-actions.pod:3476 ../src/guestfs-actions.pod:3506 ../src/guestfs-actions.pod:3521 ../src/guestfs-actions.pod:3537 ../src/guestfs-actions.pod:3593 ../src/guestfs-actions.pod:3608
24742 msgid "See also C<guestfs_stat>."
24746 #: ../src/guestfs-actions.pod:3451 ../src/guestfs-actions.pod:3480 ../src/guestfs-actions.pod:3525 ../src/guestfs-actions.pod:3597 ../src/guestfs-actions.pod:3612
24747 msgid "(Added in 1.5.10)"
24751 #: ../src/guestfs-actions.pod:3453
24752 msgid "guestfs_is_busy"
24756 #: ../src/guestfs-actions.pod:3455
24760 " guestfs_is_busy (guestfs_h *g);\n"
24765 #: ../src/guestfs-actions.pod:3467
24766 msgid "guestfs_is_chardev"
24770 #: ../src/guestfs-actions.pod:3469
24774 " guestfs_is_chardev (guestfs_h *g,\n"
24775 " const char *path);\n"
24780 #: ../src/guestfs-actions.pod:3482
24781 msgid "guestfs_is_config"
24785 #: ../src/guestfs-actions.pod:3484
24789 " guestfs_is_config (guestfs_h *g);\n"
24794 #: ../src/guestfs-actions.pod:3496
24795 msgid "guestfs_is_dir"
24799 #: ../src/guestfs-actions.pod:3498
24803 " guestfs_is_dir (guestfs_h *g,\n"
24804 " const char *path);\n"
24809 #: ../src/guestfs-actions.pod:3512
24810 msgid "guestfs_is_fifo"
24814 #: ../src/guestfs-actions.pod:3514
24818 " guestfs_is_fifo (guestfs_h *g,\n"
24819 " const char *path);\n"
24824 #: ../src/guestfs-actions.pod:3527
24825 msgid "guestfs_is_file"
24829 #: ../src/guestfs-actions.pod:3529
24833 " guestfs_is_file (guestfs_h *g,\n"
24834 " const char *path);\n"
24839 #: ../src/guestfs-actions.pod:3543
24840 msgid "guestfs_is_launching"
24844 #: ../src/guestfs-actions.pod:3545
24848 " guestfs_is_launching (guestfs_h *g);\n"
24853 #: ../src/guestfs-actions.pod:3557
24854 msgid "guestfs_is_lv"
24858 #: ../src/guestfs-actions.pod:3559
24862 " guestfs_is_lv (guestfs_h *g,\n"
24863 " const char *device);\n"
24868 #: ../src/guestfs-actions.pod:3570
24869 msgid "guestfs_is_ready"
24873 #: ../src/guestfs-actions.pod:3572
24877 " guestfs_is_ready (guestfs_h *g);\n"
24882 #: ../src/guestfs-actions.pod:3584
24883 msgid "guestfs_is_socket"
24887 #: ../src/guestfs-actions.pod:3586
24891 " guestfs_is_socket (guestfs_h *g,\n"
24892 " const char *path);\n"
24897 #: ../src/guestfs-actions.pod:3599
24898 msgid "guestfs_is_symlink"
24902 #: ../src/guestfs-actions.pod:3601
24906 " guestfs_is_symlink (guestfs_h *g,\n"
24907 " const char *path);\n"
24912 #: ../src/guestfs-actions.pod:3614
24913 msgid "guestfs_is_zero"
24917 #: ../src/guestfs-actions.pod:3616
24921 " guestfs_is_zero (guestfs_h *g,\n"
24922 " const char *path);\n"
24927 #: ../src/guestfs-actions.pod:3625 ../src/guestfs-actions.pod:3639
24928 msgid "(Added in 1.11.8)"
24932 #: ../src/guestfs-actions.pod:3627
24933 msgid "guestfs_is_zero_device"
24937 #: ../src/guestfs-actions.pod:3629
24941 " guestfs_is_zero_device (guestfs_h *g,\n"
24942 " const char *device);\n"
24947 #: ../src/guestfs-actions.pod:3641
24948 msgid "guestfs_kill_subprocess"
24952 #: ../src/guestfs-actions.pod:3643
24956 " guestfs_kill_subprocess (guestfs_h *g);\n"
24961 #: ../src/guestfs-actions.pod:3652
24962 msgid "guestfs_launch"
24966 #: ../src/guestfs-actions.pod:3654
24970 " guestfs_launch (guestfs_h *g);\n"
24975 #: ../src/guestfs-actions.pod:3672
24976 msgid "guestfs_lchown"
24980 #: ../src/guestfs-actions.pod:3674
24984 " guestfs_lchown (guestfs_h *g,\n"
24987 " const char *path);\n"
24992 #: ../src/guestfs-actions.pod:3680
24994 "Change the file owner to C<owner> and group to C<group>. This is like "
24995 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
24996 "changed, not the target."
25000 #: ../src/guestfs-actions.pod:3692
25001 msgid "guestfs_lgetxattr"
25005 #: ../src/guestfs-actions.pod:3694
25009 " guestfs_lgetxattr (guestfs_h *g,\n"
25010 " const char *path,\n"
25011 " const char *name,\n"
25012 " size_t *size_r);\n"
25017 #: ../src/guestfs-actions.pod:3714
25018 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
25022 #: ../src/guestfs-actions.pod:3722
25023 msgid "guestfs_lgetxattrs"
25027 #: ../src/guestfs-actions.pod:3724
25030 " struct guestfs_xattr_list *\n"
25031 " guestfs_lgetxattrs (guestfs_h *g,\n"
25032 " const char *path);\n"
25037 #: ../src/guestfs-actions.pod:3728
25039 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
25040 "then it returns the extended attributes of the link itself."
25044 #: ../src/guestfs-actions.pod:3738
25045 msgid "guestfs_list_9p"
25049 #: ../src/guestfs-actions.pod:3740
25053 " guestfs_list_9p (guestfs_h *g);\n"
25058 #: ../src/guestfs-actions.pod:3752
25059 msgid "guestfs_list_devices"
25063 #: ../src/guestfs-actions.pod:3754
25067 " guestfs_list_devices (guestfs_h *g);\n"
25072 #: ../src/guestfs-actions.pod:3769
25073 msgid "guestfs_list_dm_devices"
25077 #: ../src/guestfs-actions.pod:3771
25081 " guestfs_list_dm_devices (guestfs_h *g);\n"
25086 #: ../src/guestfs-actions.pod:3776
25088 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
25089 "previous call to C<guestfs_luks_open>."
25093 #: ../src/guestfs-actions.pod:3779
25095 "Device mapper devices which correspond to logical volumes are I<not> "
25096 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
25101 #: ../src/guestfs-actions.pod:3787 ../src/guestfs-actions.pod:5243
25102 msgid "(Added in 1.11.15)"
25106 #: ../src/guestfs-actions.pod:3789
25107 msgid "guestfs_list_filesystems"
25111 #: ../src/guestfs-actions.pod:3791
25115 " guestfs_list_filesystems (guestfs_h *g);\n"
25120 #: ../src/guestfs-actions.pod:3811
25122 "This command runs other libguestfs commands, which might include "
25123 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
25124 "soon after launch and only when nothing is mounted."
25128 #: ../src/guestfs-actions.pod:3815
25130 "Not all of the filesystems returned will be mountable. In particular, swap "
25131 "partitions are returned in the list. Also this command does not check that "
25132 "each filesystem found is valid and mountable, and some filesystems might be "
25133 "mountable but require special options. Filesystems may not all belong to a "
25134 "single logical operating system (use C<guestfs_inspect_os> to look for "
25139 #: ../src/guestfs-actions.pod:3829 ../src/guestfs-actions.pod:5604
25140 msgid "(Added in 1.5.15)"
25144 #: ../src/guestfs-actions.pod:3831
25145 msgid "guestfs_list_partitions"
25149 #: ../src/guestfs-actions.pod:3833
25153 " guestfs_list_partitions (guestfs_h *g);\n"
25158 #: ../src/guestfs-actions.pod:3840
25160 "This does not return logical volumes. For that you will need to call "
25165 #: ../src/guestfs-actions.pod:3851
25170 #: ../src/guestfs-actions.pod:3853
25174 " guestfs_ll (guestfs_h *g,\n"
25175 " const char *directory);\n"
25180 #: ../src/guestfs-actions.pod:3868
25185 #: ../src/guestfs-actions.pod:3870
25189 " guestfs_ln (guestfs_h *g,\n"
25190 " const char *target,\n"
25191 " const char *linkname);\n"
25196 #: ../src/guestfs-actions.pod:3881
25197 msgid "guestfs_ln_f"
25201 #: ../src/guestfs-actions.pod:3883
25205 " guestfs_ln_f (guestfs_h *g,\n"
25206 " const char *target,\n"
25207 " const char *linkname);\n"
25212 #: ../src/guestfs-actions.pod:3895
25213 msgid "guestfs_ln_s"
25217 #: ../src/guestfs-actions.pod:3897
25221 " guestfs_ln_s (guestfs_h *g,\n"
25222 " const char *target,\n"
25223 " const char *linkname);\n"
25228 #: ../src/guestfs-actions.pod:3908
25229 msgid "guestfs_ln_sf"
25233 #: ../src/guestfs-actions.pod:3910
25237 " guestfs_ln_sf (guestfs_h *g,\n"
25238 " const char *target,\n"
25239 " const char *linkname);\n"
25244 #: ../src/guestfs-actions.pod:3922
25245 msgid "guestfs_lremovexattr"
25249 #: ../src/guestfs-actions.pod:3924
25253 " guestfs_lremovexattr (guestfs_h *g,\n"
25254 " const char *xattr,\n"
25255 " const char *path);\n"
25260 #: ../src/guestfs-actions.pod:3929
25262 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
25263 "link, then it removes an extended attribute of the link itself."
25267 #: ../src/guestfs-actions.pod:3937
25272 #: ../src/guestfs-actions.pod:3939
25276 " guestfs_ls (guestfs_h *g,\n"
25277 " const char *directory);\n"
25282 #: ../src/guestfs-actions.pod:3947
25284 "This command is mostly useful for interactive sessions. Programs should "
25285 "probably use C<guestfs_readdir> instead."
25289 #: ../src/guestfs-actions.pod:3956
25290 msgid "guestfs_lsetxattr"
25294 #: ../src/guestfs-actions.pod:3958
25298 " guestfs_lsetxattr (guestfs_h *g,\n"
25299 " const char *xattr,\n"
25300 " const char *val,\n"
25302 " const char *path);\n"
25307 #: ../src/guestfs-actions.pod:3965
25309 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
25310 "then it sets an extended attribute of the link itself."
25314 #: ../src/guestfs-actions.pod:3973
25315 msgid "guestfs_lstat"
25319 #: ../src/guestfs-actions.pod:3975
25322 " struct guestfs_stat *\n"
25323 " guestfs_lstat (guestfs_h *g,\n"
25324 " const char *path);\n"
25329 #: ../src/guestfs-actions.pod:3981
25331 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
25332 "link, then the link is stat-ed, not the file it refers to."
25336 #: ../src/guestfs-actions.pod:3987 ../src/guestfs-actions.pod:6762
25338 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
25339 "error. I<The caller must call C<guestfs_free_stat> after use>."
25343 #: ../src/guestfs-actions.pod:3991 ../src/guestfs-actions.pod:6766 ../src/guestfs-actions.pod:6784 ../src/guestfs-actions.pod:7165
25344 msgid "(Added in 0.9.2)"
25348 #: ../src/guestfs-actions.pod:3993
25349 msgid "guestfs_lstatlist"
25353 #: ../src/guestfs-actions.pod:3995
25356 " struct guestfs_stat_list *\n"
25357 " guestfs_lstatlist (guestfs_h *g,\n"
25358 " const char *path,\n"
25359 " char *const *names);\n"
25364 #: ../src/guestfs-actions.pod:4000
25366 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
25367 "files, where all files are in the directory C<path>. C<names> is the list "
25368 "of files from this directory."
25372 #: ../src/guestfs-actions.pod:4009
25374 "This call is intended for programs that want to efficiently list a directory "
25375 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
25376 "for a similarly efficient call for getting extended attributes. Very long "
25377 "directory listings might cause the protocol message size to be exceeded, "
25378 "causing this call to fail. The caller must split up such requests into "
25379 "smaller groups of names."
25383 #: ../src/guestfs-actions.pod:4017
25385 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
25386 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
25390 #: ../src/guestfs-actions.pod:4023
25391 msgid "guestfs_luks_add_key"
25395 #: ../src/guestfs-actions.pod:4025
25399 " guestfs_luks_add_key (guestfs_h *g,\n"
25400 " const char *device,\n"
25401 " const char *key,\n"
25402 " const char *newkey,\n"
25408 #: ../src/guestfs-actions.pod:4037
25410 "Note that if C<keyslot> already contains a key, then this command will "
25411 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
25415 #: ../src/guestfs-actions.pod:4043 ../src/guestfs-actions.pod:4083 ../src/guestfs-actions.pod:4106 ../src/guestfs-actions.pod:4126 ../src/guestfs-actions.pod:4161 ../src/guestfs-actions.pod:4180
25417 "This function takes a key or passphrase parameter which could contain "
25418 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
25423 #: ../src/guestfs-actions.pod:4047 ../src/guestfs-actions.pod:4087 ../src/guestfs-actions.pod:4110 ../src/guestfs-actions.pod:4130
25424 msgid "(Added in 1.5.2)"
25428 #: ../src/guestfs-actions.pod:4049
25429 msgid "guestfs_luks_close"
25433 #: ../src/guestfs-actions.pod:4051
25437 " guestfs_luks_close (guestfs_h *g,\n"
25438 " const char *device);\n"
25443 #: ../src/guestfs-actions.pod:4055
25445 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
25446 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
25447 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
25448 "underlying block device."
25452 #: ../src/guestfs-actions.pod:4063 ../src/guestfs-actions.pod:4165 ../src/guestfs-actions.pod:4184 ../src/guestfs-actions.pod:4234 ../src/guestfs-actions.pod:4282
25453 msgid "(Added in 1.5.1)"
25457 #: ../src/guestfs-actions.pod:4065
25458 msgid "guestfs_luks_format"
25462 #: ../src/guestfs-actions.pod:4067
25466 " guestfs_luks_format (guestfs_h *g,\n"
25467 " const char *device,\n"
25468 " const char *key,\n"
25474 #: ../src/guestfs-actions.pod:4089
25475 msgid "guestfs_luks_format_cipher"
25479 #: ../src/guestfs-actions.pod:4091
25483 " guestfs_luks_format_cipher (guestfs_h *g,\n"
25484 " const char *device,\n"
25485 " const char *key,\n"
25487 " const char *cipher);\n"
25492 #: ../src/guestfs-actions.pod:4098
25494 "This command is the same as C<guestfs_luks_format> but it also allows you to "
25495 "set the C<cipher> used."
25499 #: ../src/guestfs-actions.pod:4112
25500 msgid "guestfs_luks_kill_slot"
25504 #: ../src/guestfs-actions.pod:4114
25508 " guestfs_luks_kill_slot (guestfs_h *g,\n"
25509 " const char *device,\n"
25510 " const char *key,\n"
25516 #: ../src/guestfs-actions.pod:4132
25517 msgid "guestfs_luks_open"
25521 #: ../src/guestfs-actions.pod:4134
25525 " guestfs_luks_open (guestfs_h *g,\n"
25526 " const char *device,\n"
25527 " const char *key,\n"
25528 " const char *mapname);\n"
25533 #: ../src/guestfs-actions.pod:4152
25535 "If this block device contains LVM volume groups, then calling "
25536 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
25541 #: ../src/guestfs-actions.pod:4156
25542 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
25546 #: ../src/guestfs-actions.pod:4167
25547 msgid "guestfs_luks_open_ro"
25551 #: ../src/guestfs-actions.pod:4169
25555 " guestfs_luks_open_ro (guestfs_h *g,\n"
25556 " const char *device,\n"
25557 " const char *key,\n"
25558 " const char *mapname);\n"
25563 #: ../src/guestfs-actions.pod:4175
25565 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
25570 #: ../src/guestfs-actions.pod:4186
25571 msgid "guestfs_lvcreate"
25575 #: ../src/guestfs-actions.pod:4188
25579 " guestfs_lvcreate (guestfs_h *g,\n"
25580 " const char *logvol,\n"
25581 " const char *volgroup,\n"
25587 #: ../src/guestfs-actions.pod:4201
25588 msgid "guestfs_lvm_canonical_lv_name"
25592 #: ../src/guestfs-actions.pod:4203
25596 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
25597 " const char *lvname);\n"
25602 #: ../src/guestfs-actions.pod:4214
25603 msgid "See also C<guestfs_is_lv>."
25607 #: ../src/guestfs-actions.pod:4219
25608 msgid "(Added in 1.5.24)"
25612 #: ../src/guestfs-actions.pod:4221
25613 msgid "guestfs_lvm_clear_filter"
25617 #: ../src/guestfs-actions.pod:4223
25621 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
25626 #: ../src/guestfs-actions.pod:4226
25628 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
25629 "see every block device."
25633 #: ../src/guestfs-actions.pod:4236
25634 msgid "guestfs_lvm_remove_all"
25638 #: ../src/guestfs-actions.pod:4238
25642 " guestfs_lvm_remove_all (guestfs_h *g);\n"
25647 #: ../src/guestfs-actions.pod:4251
25648 msgid "guestfs_lvm_set_filter"
25652 #: ../src/guestfs-actions.pod:4253
25656 " guestfs_lvm_set_filter (guestfs_h *g,\n"
25657 " char *const *devices);\n"
25662 #: ../src/guestfs-actions.pod:4284
25663 msgid "guestfs_lvremove"
25667 #: ../src/guestfs-actions.pod:4286
25671 " guestfs_lvremove (guestfs_h *g,\n"
25672 " const char *device);\n"
25677 #: ../src/guestfs-actions.pod:4298 ../src/guestfs-actions.pod:5701 ../src/guestfs-actions.pod:7535
25678 msgid "(Added in 1.0.13)"
25682 #: ../src/guestfs-actions.pod:4300
25683 msgid "guestfs_lvrename"
25687 #: ../src/guestfs-actions.pod:4302
25691 " guestfs_lvrename (guestfs_h *g,\n"
25692 " const char *logvol,\n"
25693 " const char *newlogvol);\n"
25698 #: ../src/guestfs-actions.pod:4311 ../src/guestfs-actions.pod:7548
25699 msgid "(Added in 1.0.83)"
25703 #: ../src/guestfs-actions.pod:4313
25704 msgid "guestfs_lvresize"
25708 #: ../src/guestfs-actions.pod:4315
25712 " guestfs_lvresize (guestfs_h *g,\n"
25713 " const char *device,\n"
25719 #: ../src/guestfs-actions.pod:4328
25720 msgid "guestfs_lvresize_free"
25724 #: ../src/guestfs-actions.pod:4330
25728 " guestfs_lvresize_free (guestfs_h *g,\n"
25729 " const char *lv,\n"
25735 #: ../src/guestfs-actions.pod:4343
25736 msgid "(Added in 1.3.3)"
25740 #: ../src/guestfs-actions.pod:4345
25741 msgid "guestfs_lvs"
25745 #: ../src/guestfs-actions.pod:4347
25749 " guestfs_lvs (guestfs_h *g);\n"
25754 #: ../src/guestfs-actions.pod:4356
25755 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
25759 #: ../src/guestfs-actions.pod:4364
25760 msgid "guestfs_lvs_full"
25764 #: ../src/guestfs-actions.pod:4366
25767 " struct guestfs_lvm_lv_list *\n"
25768 " guestfs_lvs_full (guestfs_h *g);\n"
25773 #: ../src/guestfs-actions.pod:4372
25775 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
25776 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
25781 #: ../src/guestfs-actions.pod:4378
25782 msgid "guestfs_lvuuid"
25786 #: ../src/guestfs-actions.pod:4380
25790 " guestfs_lvuuid (guestfs_h *g,\n"
25791 " const char *device);\n"
25796 #: ../src/guestfs-actions.pod:4391
25797 msgid "guestfs_lxattrlist"
25801 #: ../src/guestfs-actions.pod:4393
25804 " struct guestfs_xattr_list *\n"
25805 " guestfs_lxattrlist (guestfs_h *g,\n"
25806 " const char *path,\n"
25807 " char *const *names);\n"
25812 #: ../src/guestfs-actions.pod:4412
25814 "This call is intended for programs that want to efficiently list a directory "
25815 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
25816 "a similarly efficient call for getting standard stats. Very long directory "
25817 "listings might cause the protocol message size to be exceeded, causing this "
25818 "call to fail. The caller must split up such requests into smaller groups of "
25823 #: ../src/guestfs-actions.pod:4426
25824 msgid "guestfs_mkdir"
25828 #: ../src/guestfs-actions.pod:4428
25832 " guestfs_mkdir (guestfs_h *g,\n"
25833 " const char *path);\n"
25838 #: ../src/guestfs-actions.pod:4438
25839 msgid "guestfs_mkdir_mode"
25843 #: ../src/guestfs-actions.pod:4440
25847 " guestfs_mkdir_mode (guestfs_h *g,\n"
25848 " const char *path,\n"
25854 #: ../src/guestfs-actions.pod:4452
25855 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
25859 #: ../src/guestfs-actions.pod:4458
25860 msgid "guestfs_mkdir_p"
25864 #: ../src/guestfs-actions.pod:4460
25868 " guestfs_mkdir_p (guestfs_h *g,\n"
25869 " const char *path);\n"
25874 #: ../src/guestfs-actions.pod:4471
25875 msgid "guestfs_mkdtemp"
25879 #: ../src/guestfs-actions.pod:4473
25883 " guestfs_mkdtemp (guestfs_h *g,\n"
25884 " const char *template);\n"
25889 #: ../src/guestfs-actions.pod:4501
25890 msgid "guestfs_mke2fs_J"
25894 #: ../src/guestfs-actions.pod:4503
25898 " guestfs_mke2fs_J (guestfs_h *g,\n"
25899 " const char *fstype,\n"
25900 " int blocksize,\n"
25901 " const char *device,\n"
25902 " const char *journal);\n"
25907 #: ../src/guestfs-actions.pod:4516
25908 msgid "See also C<guestfs_mke2journal>."
25912 #: ../src/guestfs-actions.pod:4520 ../src/guestfs-actions.pod:4538 ../src/guestfs-actions.pod:4556 ../src/guestfs-actions.pod:4572 ../src/guestfs-actions.pod:4586 ../src/guestfs-actions.pod:4600 ../src/guestfs-actions.pod:4659 ../src/guestfs-actions.pod:4936
25913 msgid "(Added in 1.0.68)"
25917 #: ../src/guestfs-actions.pod:4522
25918 msgid "guestfs_mke2fs_JL"
25922 #: ../src/guestfs-actions.pod:4524
25926 " guestfs_mke2fs_JL (guestfs_h *g,\n"
25927 " const char *fstype,\n"
25928 " int blocksize,\n"
25929 " const char *device,\n"
25930 " const char *label);\n"
25935 #: ../src/guestfs-actions.pod:4534
25936 msgid "See also C<guestfs_mke2journal_L>."
25940 #: ../src/guestfs-actions.pod:4540
25941 msgid "guestfs_mke2fs_JU"
25945 #: ../src/guestfs-actions.pod:4542
25949 " guestfs_mke2fs_JU (guestfs_h *g,\n"
25950 " const char *fstype,\n"
25951 " int blocksize,\n"
25952 " const char *device,\n"
25953 " const char *uuid);\n"
25958 #: ../src/guestfs-actions.pod:4552
25959 msgid "See also C<guestfs_mke2journal_U>."
25963 #: ../src/guestfs-actions.pod:4558
25964 msgid "guestfs_mke2journal"
25968 #: ../src/guestfs-actions.pod:4560
25972 " guestfs_mke2journal (guestfs_h *g,\n"
25973 " int blocksize,\n"
25974 " const char *device);\n"
25979 #: ../src/guestfs-actions.pod:4574
25980 msgid "guestfs_mke2journal_L"
25984 #: ../src/guestfs-actions.pod:4576
25988 " guestfs_mke2journal_L (guestfs_h *g,\n"
25989 " int blocksize,\n"
25990 " const char *label,\n"
25991 " const char *device);\n"
25996 #: ../src/guestfs-actions.pod:4588
25997 msgid "guestfs_mke2journal_U"
26001 #: ../src/guestfs-actions.pod:4590
26005 " guestfs_mke2journal_U (guestfs_h *g,\n"
26006 " int blocksize,\n"
26007 " const char *uuid,\n"
26008 " const char *device);\n"
26013 #: ../src/guestfs-actions.pod:4602
26014 msgid "guestfs_mkfifo"
26018 #: ../src/guestfs-actions.pod:4604
26022 " guestfs_mkfifo (guestfs_h *g,\n"
26024 " const char *path);\n"
26029 #: ../src/guestfs-actions.pod:4609
26031 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
26032 "is just a convenient wrapper around C<guestfs_mknod>."
26036 #: ../src/guestfs-actions.pod:4619
26037 msgid "guestfs_mkfs"
26041 #: ../src/guestfs-actions.pod:4621
26045 " guestfs_mkfs (guestfs_h *g,\n"
26046 " const char *fstype,\n"
26047 " const char *device);\n"
26052 #: ../src/guestfs-actions.pod:4634
26053 msgid "guestfs_mkfs_b"
26057 #: ../src/guestfs-actions.pod:4636
26061 " guestfs_mkfs_b (guestfs_h *g,\n"
26062 " const char *fstype,\n"
26063 " int blocksize,\n"
26064 " const char *device);\n"
26069 #: ../src/guestfs-actions.pod:4642
26071 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
26072 "block size of the resulting filesystem. Supported block sizes depend on the "
26073 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
26077 #: ../src/guestfs-actions.pod:4652
26079 "This function is deprecated. In new code, use the L</guestfs_mkfs_opts> "
26084 #: ../src/guestfs-actions.pod:4661
26085 msgid "guestfs_mkfs_opts"
26089 #: ../src/guestfs-actions.pod:4663
26093 " guestfs_mkfs_opts (guestfs_h *g,\n"
26094 " const char *fstype,\n"
26095 " const char *device,\n"
26101 #: ../src/guestfs-actions.pod:4674
26104 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
26105 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
26106 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
26107 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
26112 #: ../src/guestfs-actions.pod:4722
26113 msgid "(Added in 1.7.19)"
26117 #: ../src/guestfs-actions.pod:4724
26118 msgid "guestfs_mkfs_opts_va"
26122 #: ../src/guestfs-actions.pod:4726
26126 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
26127 " const char *fstype,\n"
26128 " const char *device,\n"
26129 " va_list args);\n"
26134 #: ../src/guestfs-actions.pod:4732
26135 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
26139 #: ../src/guestfs-actions.pod:4736
26140 msgid "guestfs_mkfs_opts_argv"
26144 #: ../src/guestfs-actions.pod:4738
26148 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
26149 " const char *fstype,\n"
26150 " const char *device,\n"
26151 " const struct guestfs_mkfs_opts_argv *optargs);\n"
26156 #: ../src/guestfs-actions.pod:4744
26157 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
26161 #: ../src/guestfs-actions.pod:4748
26162 msgid "guestfs_mkmountpoint"
26166 #: ../src/guestfs-actions.pod:4750
26170 " guestfs_mkmountpoint (guestfs_h *g,\n"
26171 " const char *exemptpath);\n"
26176 #: ../src/guestfs-actions.pod:4754
26178 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
26179 "that can be used to create extra mountpoints before mounting the first "
26184 #: ../src/guestfs-actions.pod:4778
26186 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
26187 "may get unexpected errors if you try to mix these calls. It is safest to "
26188 "manually unmount filesystems and remove mountpoints after use."
26192 #: ../src/guestfs-actions.pod:4782
26194 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
26195 "first, so for this to work for manual mountpoints, you must ensure that the "
26196 "innermost mountpoints have the longest pathnames, as in the example code "
26201 #: ../src/guestfs-actions.pod:4789
26203 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
26204 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
26205 "can also trigger these issues."
26209 #: ../src/guestfs-actions.pod:4795 ../src/guestfs-actions.pod:5111 ../src/guestfs-actions.pod:6121
26210 msgid "(Added in 1.0.62)"
26214 #: ../src/guestfs-actions.pod:4797
26215 msgid "guestfs_mknod"
26219 #: ../src/guestfs-actions.pod:4799
26223 " guestfs_mknod (guestfs_h *g,\n"
26227 " const char *path);\n"
26232 #: ../src/guestfs-actions.pod:4814
26234 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
26235 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
26236 "regular file). These constants are available in the standard Linux header "
26237 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
26238 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
26239 "the appropriate constant for you."
26243 #: ../src/guestfs-actions.pod:4828
26244 msgid "guestfs_mknod_b"
26248 #: ../src/guestfs-actions.pod:4830
26252 " guestfs_mknod_b (guestfs_h *g,\n"
26256 " const char *path);\n"
26261 #: ../src/guestfs-actions.pod:4837
26263 "This call creates a block device node called C<path> with mode C<mode> and "
26264 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26265 "wrapper around C<guestfs_mknod>."
26269 #: ../src/guestfs-actions.pod:4847
26270 msgid "guestfs_mknod_c"
26274 #: ../src/guestfs-actions.pod:4849
26278 " guestfs_mknod_c (guestfs_h *g,\n"
26282 " const char *path);\n"
26287 #: ../src/guestfs-actions.pod:4856
26289 "This call creates a char device node called C<path> with mode C<mode> and "
26290 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26291 "wrapper around C<guestfs_mknod>."
26295 #: ../src/guestfs-actions.pod:4866
26296 msgid "guestfs_mkswap"
26300 #: ../src/guestfs-actions.pod:4868
26304 " guestfs_mkswap (guestfs_h *g,\n"
26305 " const char *device);\n"
26310 #: ../src/guestfs-actions.pod:4878
26311 msgid "guestfs_mkswap_L"
26315 #: ../src/guestfs-actions.pod:4880
26319 " guestfs_mkswap_L (guestfs_h *g,\n"
26320 " const char *label,\n"
26321 " const char *device);\n"
26326 #: ../src/guestfs-actions.pod:4895
26327 msgid "guestfs_mkswap_U"
26331 #: ../src/guestfs-actions.pod:4897
26335 " guestfs_mkswap_U (guestfs_h *g,\n"
26336 " const char *uuid,\n"
26337 " const char *device);\n"
26342 #: ../src/guestfs-actions.pod:4908
26343 msgid "guestfs_mkswap_file"
26347 #: ../src/guestfs-actions.pod:4910
26351 " guestfs_mkswap_file (guestfs_h *g,\n"
26352 " const char *path);\n"
26357 #: ../src/guestfs-actions.pod:4916
26359 "This command just writes a swap file signature to an existing file. To "
26360 "create the file itself, use something like C<guestfs_fallocate>."
26364 #: ../src/guestfs-actions.pod:4923
26365 msgid "guestfs_modprobe"
26369 #: ../src/guestfs-actions.pod:4925
26373 " guestfs_modprobe (guestfs_h *g,\n"
26374 " const char *modulename);\n"
26379 #: ../src/guestfs-actions.pod:4938
26380 msgid "guestfs_mount"
26384 #: ../src/guestfs-actions.pod:4940
26388 " guestfs_mount (guestfs_h *g,\n"
26389 " const char *device,\n"
26390 " const char *mountpoint);\n"
26395 #: ../src/guestfs-actions.pod:4959
26397 "B<Important note:> When you use this call, the filesystem options C<sync> "
26398 "and C<noatime> are set implicitly. This was originally done because we "
26399 "thought it would improve reliability, but it turns out that I<-o sync> has a "
26400 "very large negative performance impact and negligible effect on "
26401 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
26402 "in any code that needs performance, and instead use C<guestfs_mount_options> "
26403 "(use an empty string for the first parameter if you don't want any options)."
26407 #: ../src/guestfs-actions.pod:4971
26409 "This function is deprecated. In new code, use the L</guestfs_mount_options> "
26414 #: ../src/guestfs-actions.pod:4980
26415 msgid "guestfs_mount_9p"
26419 #: ../src/guestfs-actions.pod:4982
26423 " guestfs_mount_9p (guestfs_h *g,\n"
26424 " const char *mounttag,\n"
26425 " const char *mountpoint,\n"
26431 #: ../src/guestfs-actions.pod:4993
26434 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
26439 #: ../src/guestfs-actions.pod:5006
26440 msgid "guestfs_mount_9p_va"
26444 #: ../src/guestfs-actions.pod:5008
26448 " guestfs_mount_9p_va (guestfs_h *g,\n"
26449 " const char *mounttag,\n"
26450 " const char *mountpoint,\n"
26451 " va_list args);\n"
26456 #: ../src/guestfs-actions.pod:5014
26457 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
26461 #: ../src/guestfs-actions.pod:5018
26462 msgid "guestfs_mount_9p_argv"
26466 #: ../src/guestfs-actions.pod:5020
26470 " guestfs_mount_9p_argv (guestfs_h *g,\n"
26471 " const char *mounttag,\n"
26472 " const char *mountpoint,\n"
26473 " const struct guestfs_mount_9p_argv *optargs);\n"
26478 #: ../src/guestfs-actions.pod:5026
26479 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
26483 #: ../src/guestfs-actions.pod:5030
26484 msgid "guestfs_mount_loop"
26488 #: ../src/guestfs-actions.pod:5032
26492 " guestfs_mount_loop (guestfs_h *g,\n"
26493 " const char *file,\n"
26494 " const char *mountpoint);\n"
26499 #: ../src/guestfs-actions.pod:5045
26500 msgid "guestfs_mount_options"
26504 #: ../src/guestfs-actions.pod:5047
26508 " guestfs_mount_options (guestfs_h *g,\n"
26509 " const char *options,\n"
26510 " const char *device,\n"
26511 " const char *mountpoint);\n"
26516 #: ../src/guestfs-actions.pod:5053
26518 "This is the same as the C<guestfs_mount> command, but it allows you to set "
26519 "the mount options as for the L<mount(8)> I<-o> flag."
26523 #: ../src/guestfs-actions.pod:5063 ../src/guestfs-actions.pod:5077 ../src/guestfs-actions.pod:5094
26524 msgid "(Added in 1.0.10)"
26528 #: ../src/guestfs-actions.pod:5065
26529 msgid "guestfs_mount_ro"
26533 #: ../src/guestfs-actions.pod:5067
26537 " guestfs_mount_ro (guestfs_h *g,\n"
26538 " const char *device,\n"
26539 " const char *mountpoint);\n"
26544 #: ../src/guestfs-actions.pod:5072
26546 "This is the same as the C<guestfs_mount> command, but it mounts the "
26547 "filesystem with the read-only (I<-o ro>) flag."
26551 #: ../src/guestfs-actions.pod:5079
26552 msgid "guestfs_mount_vfs"
26556 #: ../src/guestfs-actions.pod:5081
26560 " guestfs_mount_vfs (guestfs_h *g,\n"
26561 " const char *options,\n"
26562 " const char *vfstype,\n"
26563 " const char *device,\n"
26564 " const char *mountpoint);\n"
26569 #: ../src/guestfs-actions.pod:5088
26571 "This is the same as the C<guestfs_mount> command, but it allows you to set "
26572 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
26577 #: ../src/guestfs-actions.pod:5096
26578 msgid "guestfs_mountpoints"
26582 #: ../src/guestfs-actions.pod:5098
26586 " guestfs_mountpoints (guestfs_h *g);\n"
26591 #: ../src/guestfs-actions.pod:5101
26593 "This call is similar to C<guestfs_mounts>. That call returns a list of "
26594 "devices. This one returns a hash table (map) of device name to directory "
26595 "where the device is mounted."
26599 #: ../src/guestfs-actions.pod:5113
26600 msgid "guestfs_mounts"
26604 #: ../src/guestfs-actions.pod:5115
26608 " guestfs_mounts (guestfs_h *g);\n"
26613 #: ../src/guestfs-actions.pod:5123
26614 msgid "See also: C<guestfs_mountpoints>"
26618 #: ../src/guestfs-actions.pod:5131
26623 #: ../src/guestfs-actions.pod:5133
26627 " guestfs_mv (guestfs_h *g,\n"
26628 " const char *src,\n"
26629 " const char *dest);\n"
26634 #: ../src/guestfs-actions.pod:5145
26635 msgid "guestfs_ntfs_3g_probe"
26639 #: ../src/guestfs-actions.pod:5147
26643 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
26645 " const char *device);\n"
26650 #: ../src/guestfs-actions.pod:5166
26651 msgid "(Added in 1.0.43)"
26655 #: ../src/guestfs-actions.pod:5168
26656 msgid "guestfs_ntfsresize"
26660 #: ../src/guestfs-actions.pod:5170
26664 " guestfs_ntfsresize (guestfs_h *g,\n"
26665 " const char *device);\n"
26670 #: ../src/guestfs-actions.pod:5189 ../src/guestfs-actions.pod:5279
26672 "This function is deprecated. In new code, use the "
26673 "L</guestfs_ntfsresize_opts> call instead."
26677 #: ../src/guestfs-actions.pod:5198
26678 msgid "guestfs_ntfsresize_opts"
26682 #: ../src/guestfs-actions.pod:5200
26686 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
26687 " const char *device,\n"
26693 #: ../src/guestfs-actions.pod:5210
26696 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
26697 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
26702 #: ../src/guestfs-actions.pod:5230
26704 "After the resize operation, the filesystem is always marked as requiring a "
26705 "consistency check (for safety). You have to boot into Windows to perform "
26706 "this check and clear this condition. If you I<don't> set the C<force> "
26707 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
26708 "times on a single filesystem without booting into Windows between each "
26713 #: ../src/guestfs-actions.pod:5245
26714 msgid "guestfs_ntfsresize_opts_va"
26718 #: ../src/guestfs-actions.pod:5247
26722 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
26723 " const char *device,\n"
26724 " va_list args);\n"
26729 #: ../src/guestfs-actions.pod:5252
26730 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
26734 #: ../src/guestfs-actions.pod:5256
26735 msgid "guestfs_ntfsresize_opts_argv"
26739 #: ../src/guestfs-actions.pod:5258
26743 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
26744 " const char *device,\n"
26745 " const struct guestfs_ntfsresize_opts_argv "
26751 #: ../src/guestfs-actions.pod:5263
26752 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
26756 #: ../src/guestfs-actions.pod:5267
26757 msgid "guestfs_ntfsresize_size"
26761 #: ../src/guestfs-actions.pod:5269
26765 " guestfs_ntfsresize_size (guestfs_h *g,\n"
26766 " const char *device,\n"
26767 " int64_t size);\n"
26772 #: ../src/guestfs-actions.pod:5274
26774 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
26775 "to specify the new size (in bytes) explicitly."
26779 #: ../src/guestfs-actions.pod:5286 ../src/guestfs-actions.pod:5728 ../src/guestfs-actions.pod:5801 ../src/guestfs-actions.pod:6069 ../src/guestfs-actions.pod:7692
26780 msgid "(Added in 1.3.14)"
26784 #: ../src/guestfs-actions.pod:5288
26785 msgid "guestfs_part_add"
26789 #: ../src/guestfs-actions.pod:5290
26793 " guestfs_part_add (guestfs_h *g,\n"
26794 " const char *device,\n"
26795 " const char *prlogex,\n"
26796 " int64_t startsect,\n"
26797 " int64_t endsect);\n"
26802 #: ../src/guestfs-actions.pod:5297
26804 "This command adds a partition to C<device>. If there is no partition table "
26805 "on the device, call C<guestfs_part_init> first."
26809 #: ../src/guestfs-actions.pod:5309
26811 "Creating a partition which covers the whole disk is not so easy. Use "
26812 "C<guestfs_part_disk> to do that."
26816 #: ../src/guestfs-actions.pod:5314 ../src/guestfs-actions.pod:5352 ../src/guestfs-actions.pod:5405 ../src/guestfs-actions.pod:5489 ../src/guestfs-actions.pod:5527 ../src/guestfs-actions.pod:5546 ../src/guestfs-actions.pod:5586
26817 msgid "(Added in 1.0.78)"
26821 #: ../src/guestfs-actions.pod:5316
26822 msgid "guestfs_part_del"
26826 #: ../src/guestfs-actions.pod:5318
26830 " guestfs_part_del (guestfs_h *g,\n"
26831 " const char *device,\n"
26837 #: ../src/guestfs-actions.pod:5333
26838 msgid "guestfs_part_disk"
26842 #: ../src/guestfs-actions.pod:5335
26846 " guestfs_part_disk (guestfs_h *g,\n"
26847 " const char *device,\n"
26848 " const char *parttype);\n"
26853 #: ../src/guestfs-actions.pod:5340
26855 "This command is simply a combination of C<guestfs_part_init> followed by "
26856 "C<guestfs_part_add> to create a single primary partition covering the whole "
26861 #: ../src/guestfs-actions.pod:5344
26863 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
26864 "possible values are described in C<guestfs_part_init>."
26868 #: ../src/guestfs-actions.pod:5354
26869 msgid "guestfs_part_get_bootable"
26873 #: ../src/guestfs-actions.pod:5356
26877 " guestfs_part_get_bootable (guestfs_h *g,\n"
26878 " const char *device,\n"
26884 #: ../src/guestfs-actions.pod:5364
26885 msgid "See also C<guestfs_part_set_bootable>."
26889 #: ../src/guestfs-actions.pod:5370
26890 msgid "guestfs_part_get_mbr_id"
26894 #: ../src/guestfs-actions.pod:5372
26898 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
26899 " const char *device,\n"
26905 #: ../src/guestfs-actions.pod:5380 ../src/guestfs-actions.pod:5562
26907 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
26908 "undefined results for other partition table types (see "
26909 "C<guestfs_part_get_parttype>)."
26913 #: ../src/guestfs-actions.pod:5388
26914 msgid "guestfs_part_get_parttype"
26918 #: ../src/guestfs-actions.pod:5390
26922 " guestfs_part_get_parttype (guestfs_h *g,\n"
26923 " const char *device);\n"
26928 #: ../src/guestfs-actions.pod:5397
26930 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
26931 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
26932 "possible, although unusual. See C<guestfs_part_init> for a full list."
26936 #: ../src/guestfs-actions.pod:5407
26937 msgid "guestfs_part_init"
26941 #: ../src/guestfs-actions.pod:5409
26945 " guestfs_part_init (guestfs_h *g,\n"
26946 " const char *device,\n"
26947 " const char *parttype);\n"
26952 #: ../src/guestfs-actions.pod:5418
26954 "Initially there are no partitions. Following this, you should call "
26955 "C<guestfs_part_add> for each partition required."
26959 #: ../src/guestfs-actions.pod:5491
26960 msgid "guestfs_part_list"
26964 #: ../src/guestfs-actions.pod:5493
26967 " struct guestfs_partition_list *\n"
26968 " guestfs_part_list (guestfs_h *g,\n"
26969 " const char *device);\n"
26974 #: ../src/guestfs-actions.pod:5510
26976 "Start of the partition I<in bytes>. To get sectors you have to divide by "
26977 "the device's sector size, see C<guestfs_blockdev_getss>."
26981 #: ../src/guestfs-actions.pod:5523
26983 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
26984 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
26989 #: ../src/guestfs-actions.pod:5529
26990 msgid "guestfs_part_set_bootable"
26994 #: ../src/guestfs-actions.pod:5531
26998 " guestfs_part_set_bootable (guestfs_h *g,\n"
26999 " const char *device,\n"
27001 " int bootable);\n"
27006 #: ../src/guestfs-actions.pod:5548
27007 msgid "guestfs_part_set_mbr_id"
27011 #: ../src/guestfs-actions.pod:5550
27015 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
27016 " const char *device,\n"
27023 #: ../src/guestfs-actions.pod:5570
27024 msgid "guestfs_part_set_name"
27028 #: ../src/guestfs-actions.pod:5572
27032 " guestfs_part_set_name (guestfs_h *g,\n"
27033 " const char *device,\n"
27035 " const char *name);\n"
27040 #: ../src/guestfs-actions.pod:5588
27041 msgid "guestfs_part_to_dev"
27045 #: ../src/guestfs-actions.pod:5590
27049 " guestfs_part_to_dev (guestfs_h *g,\n"
27050 " const char *partition);\n"
27055 #: ../src/guestfs-actions.pod:5598
27057 "The named partition must exist, for example as a string returned from "
27058 "C<guestfs_list_partitions>."
27062 #: ../src/guestfs-actions.pod:5606
27063 msgid "guestfs_ping_daemon"
27067 #: ../src/guestfs-actions.pod:5608
27071 " guestfs_ping_daemon (guestfs_h *g);\n"
27076 #: ../src/guestfs-actions.pod:5620
27077 msgid "guestfs_pread"
27081 #: ../src/guestfs-actions.pod:5622
27085 " guestfs_pread (guestfs_h *g,\n"
27086 " const char *path,\n"
27088 " int64_t offset,\n"
27089 " size_t *size_r);\n"
27094 #: ../src/guestfs-actions.pod:5635
27095 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
27099 #: ../src/guestfs-actions.pod:5646
27100 msgid "guestfs_pread_device"
27104 #: ../src/guestfs-actions.pod:5648
27108 " guestfs_pread_device (guestfs_h *g,\n"
27109 " const char *device,\n"
27111 " int64_t offset,\n"
27112 " size_t *size_r);\n"
27117 #: ../src/guestfs-actions.pod:5661
27118 msgid "See also C<guestfs_pread>."
27122 #: ../src/guestfs-actions.pod:5670
27123 msgid "(Added in 1.5.21)"
27127 #: ../src/guestfs-actions.pod:5672
27128 msgid "guestfs_pvcreate"
27132 #: ../src/guestfs-actions.pod:5674
27136 " guestfs_pvcreate (guestfs_h *g,\n"
27137 " const char *device);\n"
27142 #: ../src/guestfs-actions.pod:5686
27143 msgid "guestfs_pvremove"
27147 #: ../src/guestfs-actions.pod:5688
27151 " guestfs_pvremove (guestfs_h *g,\n"
27152 " const char *device);\n"
27157 #: ../src/guestfs-actions.pod:5703
27158 msgid "guestfs_pvresize"
27162 #: ../src/guestfs-actions.pod:5705
27166 " guestfs_pvresize (guestfs_h *g,\n"
27167 " const char *device);\n"
27172 #: ../src/guestfs-actions.pod:5716
27173 msgid "guestfs_pvresize_size"
27177 #: ../src/guestfs-actions.pod:5718
27181 " guestfs_pvresize_size (guestfs_h *g,\n"
27182 " const char *device,\n"
27183 " int64_t size);\n"
27188 #: ../src/guestfs-actions.pod:5723
27190 "This command is the same as C<guestfs_pvresize> except that it allows you to "
27191 "specify the new size (in bytes) explicitly."
27195 #: ../src/guestfs-actions.pod:5730
27196 msgid "guestfs_pvs"
27200 #: ../src/guestfs-actions.pod:5732
27204 " guestfs_pvs (guestfs_h *g);\n"
27209 #: ../src/guestfs-actions.pod:5741
27210 msgid "See also C<guestfs_pvs_full>."
27214 #: ../src/guestfs-actions.pod:5749
27215 msgid "guestfs_pvs_full"
27219 #: ../src/guestfs-actions.pod:5751
27222 " struct guestfs_lvm_pv_list *\n"
27223 " guestfs_pvs_full (guestfs_h *g);\n"
27228 #: ../src/guestfs-actions.pod:5757
27230 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
27231 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
27236 #: ../src/guestfs-actions.pod:5763
27237 msgid "guestfs_pvuuid"
27241 #: ../src/guestfs-actions.pod:5765
27245 " guestfs_pvuuid (guestfs_h *g,\n"
27246 " const char *device);\n"
27251 #: ../src/guestfs-actions.pod:5776
27252 msgid "guestfs_pwrite"
27256 #: ../src/guestfs-actions.pod:5778
27260 " guestfs_pwrite (guestfs_h *g,\n"
27261 " const char *path,\n"
27262 " const char *content,\n"
27263 " size_t content_size,\n"
27264 " int64_t offset);\n"
27269 #: ../src/guestfs-actions.pod:5794
27270 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
27274 #: ../src/guestfs-actions.pod:5803
27275 msgid "guestfs_pwrite_device"
27279 #: ../src/guestfs-actions.pod:5805
27283 " guestfs_pwrite_device (guestfs_h *g,\n"
27284 " const char *device,\n"
27285 " const char *content,\n"
27286 " size_t content_size,\n"
27287 " int64_t offset);\n"
27292 #: ../src/guestfs-actions.pod:5820
27293 msgid "See also C<guestfs_pwrite>."
27297 #: ../src/guestfs-actions.pod:5827
27298 msgid "(Added in 1.5.20)"
27302 #: ../src/guestfs-actions.pod:5829
27303 msgid "guestfs_read_file"
27307 #: ../src/guestfs-actions.pod:5831
27311 " guestfs_read_file (guestfs_h *g,\n"
27312 " const char *path,\n"
27313 " size_t *size_r);\n"
27318 #: ../src/guestfs-actions.pod:5839
27320 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
27321 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
27322 "function is limited in the total size of file that can be handled."
27326 #: ../src/guestfs-actions.pod:5851
27327 msgid "(Added in 1.0.63)"
27331 #: ../src/guestfs-actions.pod:5853
27332 msgid "guestfs_read_lines"
27336 #: ../src/guestfs-actions.pod:5855
27340 " guestfs_read_lines (guestfs_h *g,\n"
27341 " const char *path);\n"
27346 #: ../src/guestfs-actions.pod:5864
27348 "Note that this function cannot correctly handle binary files (specifically, "
27349 "files containing C<\\0> character which is treated as end of line). For "
27350 "those you need to use the C<guestfs_read_file> function which has a more "
27351 "complex interface."
27355 #: ../src/guestfs-actions.pod:5875
27356 msgid "guestfs_readdir"
27360 #: ../src/guestfs-actions.pod:5877
27363 " struct guestfs_dirent_list *\n"
27364 " guestfs_readdir (guestfs_h *g,\n"
27365 " const char *dir);\n"
27370 #: ../src/guestfs-actions.pod:5931
27372 "This function is primarily intended for use by programs. To get a simple "
27373 "list of names, use C<guestfs_ls>. To get a printable directory for human "
27374 "consumption, use C<guestfs_ll>."
27378 #: ../src/guestfs-actions.pod:5935
27380 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
27381 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
27386 #: ../src/guestfs-actions.pod:5941
27387 msgid "guestfs_readlink"
27391 #: ../src/guestfs-actions.pod:5943
27395 " guestfs_readlink (guestfs_h *g,\n"
27396 " const char *path);\n"
27401 #: ../src/guestfs-actions.pod:5954
27402 msgid "guestfs_readlinklist"
27406 #: ../src/guestfs-actions.pod:5956
27410 " guestfs_readlinklist (guestfs_h *g,\n"
27411 " const char *path,\n"
27412 " char *const *names);\n"
27417 #: ../src/guestfs-actions.pod:5989
27418 msgid "guestfs_realpath"
27422 #: ../src/guestfs-actions.pod:5991
27426 " guestfs_realpath (guestfs_h *g,\n"
27427 " const char *path);\n"
27432 #: ../src/guestfs-actions.pod:6003
27433 msgid "guestfs_removexattr"
27437 #: ../src/guestfs-actions.pod:6005
27441 " guestfs_removexattr (guestfs_h *g,\n"
27442 " const char *xattr,\n"
27443 " const char *path);\n"
27448 #: ../src/guestfs-actions.pod:6013
27449 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
27453 #: ../src/guestfs-actions.pod:6019
27454 msgid "guestfs_resize2fs"
27458 #: ../src/guestfs-actions.pod:6021
27462 " guestfs_resize2fs (guestfs_h *g,\n"
27463 " const char *device);\n"
27468 #: ../src/guestfs-actions.pod:6028
27470 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
27471 "C<device> before calling this command. For unknown reasons C<resize2fs> "
27472 "sometimes gives an error about this and sometimes not. In any case, it is "
27473 "always safe to call C<guestfs_e2fsck_f> before calling this function."
27477 #: ../src/guestfs-actions.pod:6038
27478 msgid "guestfs_resize2fs_M"
27482 #: ../src/guestfs-actions.pod:6040
27486 " guestfs_resize2fs_M (guestfs_h *g,\n"
27487 " const char *device);\n"
27492 #: ../src/guestfs-actions.pod:6044
27494 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
27495 "resized to its minimum size. This works like the I<-M> option to the "
27496 "C<resize2fs> command."
27500 #: ../src/guestfs-actions.pod:6048
27502 "To get the resulting size of the filesystem you should call "
27503 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
27504 "These two numbers, multiplied together, give the resulting size of the "
27505 "minimal filesystem in bytes."
27509 #: ../src/guestfs-actions.pod:6057
27510 msgid "guestfs_resize2fs_size"
27514 #: ../src/guestfs-actions.pod:6059
27518 " guestfs_resize2fs_size (guestfs_h *g,\n"
27519 " const char *device,\n"
27520 " int64_t size);\n"
27525 #: ../src/guestfs-actions.pod:6064
27527 "This command is the same as C<guestfs_resize2fs> except that it allows you "
27528 "to specify the new size (in bytes) explicitly."
27532 #: ../src/guestfs-actions.pod:6071
27537 #: ../src/guestfs-actions.pod:6073
27541 " guestfs_rm (guestfs_h *g,\n"
27542 " const char *path);\n"
27547 #: ../src/guestfs-actions.pod:6083
27548 msgid "guestfs_rm_rf"
27552 #: ../src/guestfs-actions.pod:6085
27556 " guestfs_rm_rf (guestfs_h *g,\n"
27557 " const char *path);\n"
27562 #: ../src/guestfs-actions.pod:6097
27563 msgid "guestfs_rmdir"
27567 #: ../src/guestfs-actions.pod:6099
27571 " guestfs_rmdir (guestfs_h *g,\n"
27572 " const char *path);\n"
27577 #: ../src/guestfs-actions.pod:6109
27578 msgid "guestfs_rmmountpoint"
27582 #: ../src/guestfs-actions.pod:6111
27586 " guestfs_rmmountpoint (guestfs_h *g,\n"
27587 " const char *exemptpath);\n"
27592 #: ../src/guestfs-actions.pod:6115
27594 "This calls removes a mountpoint that was previously created with "
27595 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
27599 #: ../src/guestfs-actions.pod:6123
27600 msgid "guestfs_scrub_device"
27604 #: ../src/guestfs-actions.pod:6125
27608 " guestfs_scrub_device (guestfs_h *g,\n"
27609 " const char *device);\n"
27614 #: ../src/guestfs-actions.pod:6140 ../src/guestfs-actions.pod:6158 ../src/guestfs-actions.pod:6177
27615 msgid "(Added in 1.0.52)"
27619 #: ../src/guestfs-actions.pod:6142
27620 msgid "guestfs_scrub_file"
27624 #: ../src/guestfs-actions.pod:6144
27628 " guestfs_scrub_file (guestfs_h *g,\n"
27629 " const char *file);\n"
27634 #: ../src/guestfs-actions.pod:6160
27635 msgid "guestfs_scrub_freespace"
27639 #: ../src/guestfs-actions.pod:6162
27643 " guestfs_scrub_freespace (guestfs_h *g,\n"
27644 " const char *dir);\n"
27649 #: ../src/guestfs-actions.pod:6166
27651 "This command creates the directory C<dir> and then fills it with files until "
27652 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
27653 "and deletes them. The intention is to scrub any free space on the partition "
27654 "containing C<dir>."
27658 #: ../src/guestfs-actions.pod:6179
27659 msgid "guestfs_set_append"
27663 #: ../src/guestfs-actions.pod:6181
27667 " guestfs_set_append (guestfs_h *g,\n"
27668 " const char *append);\n"
27673 #: ../src/guestfs-actions.pod:6198
27674 msgid "guestfs_set_attach_method"
27678 #: ../src/guestfs-actions.pod:6200
27682 " guestfs_set_attach_method (guestfs_h *g,\n"
27683 " const char *attachmethod);\n"
27688 #: ../src/guestfs-actions.pod:6228
27689 msgid "guestfs_set_autosync"
27693 #: ../src/guestfs-actions.pod:6230
27697 " guestfs_set_autosync (guestfs_h *g,\n"
27698 " int autosync);\n"
27703 #: ../src/guestfs-actions.pod:6246
27704 msgid "guestfs_set_direct"
27708 #: ../src/guestfs-actions.pod:6248
27712 " guestfs_set_direct (guestfs_h *g,\n"
27718 #: ../src/guestfs-actions.pod:6256
27720 "One consequence of this is that log messages aren't caught by the library "
27721 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
27726 #: ../src/guestfs-actions.pod:6269
27727 msgid "guestfs_set_e2label"
27731 #: ../src/guestfs-actions.pod:6271
27735 " guestfs_set_e2label (guestfs_h *g,\n"
27736 " const char *device,\n"
27737 " const char *label);\n"
27742 #: ../src/guestfs-actions.pod:6280
27744 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
27745 "the existing label on a filesystem."
27749 #: ../src/guestfs-actions.pod:6287
27750 msgid "guestfs_set_e2uuid"
27754 #: ../src/guestfs-actions.pod:6289
27758 " guestfs_set_e2uuid (guestfs_h *g,\n"
27759 " const char *device,\n"
27760 " const char *uuid);\n"
27765 #: ../src/guestfs-actions.pod:6299
27767 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
27768 "the existing UUID of a filesystem."
27772 #: ../src/guestfs-actions.pod:6306
27773 msgid "guestfs_set_memsize"
27777 #: ../src/guestfs-actions.pod:6308
27781 " guestfs_set_memsize (guestfs_h *g,\n"
27787 #: ../src/guestfs-actions.pod:6312
27789 "This sets the memory size in megabytes allocated to the qemu subprocess. "
27790 "This only has any effect if called before C<guestfs_launch>."
27794 #: ../src/guestfs-actions.pod:6327
27795 msgid "guestfs_set_network"
27799 #: ../src/guestfs-actions.pod:6329
27803 " guestfs_set_network (guestfs_h *g,\n"
27809 #: ../src/guestfs-actions.pod:6339
27811 "You must call this before calling C<guestfs_launch>, otherwise it has no "
27816 #: ../src/guestfs-actions.pod:6346
27817 msgid "guestfs_set_path"
27821 #: ../src/guestfs-actions.pod:6348
27825 " guestfs_set_path (guestfs_h *g,\n"
27826 " const char *searchpath);\n"
27831 #: ../src/guestfs-actions.pod:6363
27832 msgid "guestfs_set_pgroup"
27836 #: ../src/guestfs-actions.pod:6365
27840 " guestfs_set_pgroup (guestfs_h *g,\n"
27846 #: ../src/guestfs-actions.pod:6382
27847 msgid "guestfs_set_qemu"
27851 #: ../src/guestfs-actions.pod:6384
27855 " guestfs_set_qemu (guestfs_h *g,\n"
27856 " const char *qemu);\n"
27861 #: ../src/guestfs-actions.pod:6410
27862 msgid "guestfs_set_recovery_proc"
27866 #: ../src/guestfs-actions.pod:6412
27870 " guestfs_set_recovery_proc (guestfs_h *g,\n"
27871 " int recoveryproc);\n"
27876 #: ../src/guestfs-actions.pod:6416
27878 "If this is called with the parameter C<false> then C<guestfs_launch> does "
27879 "not create a recovery process. The purpose of the recovery process is to "
27880 "stop runaway qemu processes in the case where the main program aborts "
27885 #: ../src/guestfs-actions.pod:6421
27887 "This only has any effect if called before C<guestfs_launch>, and the default "
27892 #: ../src/guestfs-actions.pod:6434
27893 msgid "guestfs_set_selinux"
27897 #: ../src/guestfs-actions.pod:6436
27901 " guestfs_set_selinux (guestfs_h *g,\n"
27907 #: ../src/guestfs-actions.pod:6453
27908 msgid "guestfs_set_trace"
27912 #: ../src/guestfs-actions.pod:6455
27916 " guestfs_set_trace (guestfs_h *g,\n"
27922 #: ../src/guestfs-actions.pod:6469
27924 "Trace messages are normally sent to C<stderr>, unless you register a "
27925 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
27929 #: ../src/guestfs-actions.pod:6477
27930 msgid "guestfs_set_verbose"
27934 #: ../src/guestfs-actions.pod:6479
27938 " guestfs_set_verbose (guestfs_h *g,\n"
27944 #: ../src/guestfs-actions.pod:6488
27946 "Verbose messages are normally sent to C<stderr>, unless you register a "
27947 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
27951 #: ../src/guestfs-actions.pod:6496
27952 msgid "guestfs_setcon"
27956 #: ../src/guestfs-actions.pod:6498
27960 " guestfs_setcon (guestfs_h *g,\n"
27961 " const char *context);\n"
27966 #: ../src/guestfs-actions.pod:6511
27967 msgid "guestfs_setxattr"
27971 #: ../src/guestfs-actions.pod:6513
27975 " guestfs_setxattr (guestfs_h *g,\n"
27976 " const char *xattr,\n"
27977 " const char *val,\n"
27979 " const char *path);\n"
27984 #: ../src/guestfs-actions.pod:6524
27985 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
27989 #: ../src/guestfs-actions.pod:6530
27990 msgid "guestfs_sfdisk"
27994 #: ../src/guestfs-actions.pod:6532
27998 " guestfs_sfdisk (guestfs_h *g,\n"
27999 " const char *device,\n"
28003 " char *const *lines);\n"
28008 #: ../src/guestfs-actions.pod:6560
28009 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
28013 #: ../src/guestfs-actions.pod:6568 ../src/guestfs-actions.pod:6598 ../src/guestfs-actions.pod:6631
28015 "This function is deprecated. In new code, use the L</guestfs_part_add> call "
28020 #: ../src/guestfs-actions.pod:6577
28021 msgid "guestfs_sfdiskM"
28025 #: ../src/guestfs-actions.pod:6579
28029 " guestfs_sfdiskM (guestfs_h *g,\n"
28030 " const char *device,\n"
28031 " char *const *lines);\n"
28036 #: ../src/guestfs-actions.pod:6584
28038 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
28039 "partition sizes are specified in megabytes only (rounded to the nearest "
28040 "cylinder) and you don't need to specify the cyls, heads and sectors "
28041 "parameters which were rarely if ever used anyway."
28045 #: ../src/guestfs-actions.pod:6590
28047 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
28048 "C<guestfs_part_disk>"
28052 #: ../src/guestfs-actions.pod:6607
28053 msgid "guestfs_sfdisk_N"
28057 #: ../src/guestfs-actions.pod:6609
28061 " guestfs_sfdisk_N (guestfs_h *g,\n"
28062 " const char *device,\n"
28067 " const char *line);\n"
28072 #: ../src/guestfs-actions.pod:6621
28074 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
28075 "for the cyls/heads/sectors parameters."
28079 #: ../src/guestfs-actions.pod:6624
28080 msgid "See also: C<guestfs_part_add>"
28084 #: ../src/guestfs-actions.pod:6640
28085 msgid "guestfs_sfdisk_disk_geometry"
28089 #: ../src/guestfs-actions.pod:6642
28093 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
28094 " const char *device);\n"
28099 #: ../src/guestfs-actions.pod:6646
28101 "This displays the disk geometry of C<device> read from the partition table. "
28102 "Especially in the case where the underlying block device has been resized, "
28103 "this can be different from the kernel's idea of the geometry (see "
28104 "C<guestfs_sfdisk_kernel_geometry>)."
28108 #: ../src/guestfs-actions.pod:6659
28109 msgid "guestfs_sfdisk_kernel_geometry"
28113 #: ../src/guestfs-actions.pod:6661
28117 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
28118 " const char *device);\n"
28123 #: ../src/guestfs-actions.pod:6675
28124 msgid "guestfs_sfdisk_l"
28128 #: ../src/guestfs-actions.pod:6677
28132 " guestfs_sfdisk_l (guestfs_h *g,\n"
28133 " const char *device);\n"
28138 #: ../src/guestfs-actions.pod:6685
28139 msgid "See also: C<guestfs_part_list>"
28143 #: ../src/guestfs-actions.pod:6690
28145 "This function is deprecated. In new code, use the L</guestfs_part_list> "
28150 #: ../src/guestfs-actions.pod:6699
28155 #: ../src/guestfs-actions.pod:6701
28159 " guestfs_sh (guestfs_h *g,\n"
28160 " const char *command);\n"
28165 #: ../src/guestfs-actions.pod:6708
28166 msgid "This is like C<guestfs_command>, but passes the command to:"
28170 #: ../src/guestfs-actions.pod:6716
28171 msgid "All the provisos about C<guestfs_command> apply to this call."
28175 #: ../src/guestfs-actions.pod:6723
28176 msgid "guestfs_sh_lines"
28180 #: ../src/guestfs-actions.pod:6725
28184 " guestfs_sh_lines (guestfs_h *g,\n"
28185 " const char *command);\n"
28190 #: ../src/guestfs-actions.pod:6729
28192 "This is the same as C<guestfs_sh>, but splits the result into a list of "
28197 #: ../src/guestfs-actions.pod:6732
28198 msgid "See also: C<guestfs_command_lines>"
28202 #: ../src/guestfs-actions.pod:6740
28203 msgid "guestfs_sleep"
28207 #: ../src/guestfs-actions.pod:6742
28211 " guestfs_sleep (guestfs_h *g,\n"
28217 #: ../src/guestfs-actions.pod:6750
28218 msgid "(Added in 1.0.41)"
28222 #: ../src/guestfs-actions.pod:6752 ../src/guestfs-structs.pod:109
28223 msgid "guestfs_stat"
28227 #: ../src/guestfs-actions.pod:6754
28230 " struct guestfs_stat *\n"
28231 " guestfs_stat (guestfs_h *g,\n"
28232 " const char *path);\n"
28237 #: ../src/guestfs-actions.pod:6768 ../src/guestfs-structs.pod:135
28238 msgid "guestfs_statvfs"
28242 #: ../src/guestfs-actions.pod:6770
28245 " struct guestfs_statvfs *\n"
28246 " guestfs_statvfs (guestfs_h *g,\n"
28247 " const char *path);\n"
28252 #: ../src/guestfs-actions.pod:6780
28254 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
28255 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
28259 #: ../src/guestfs-actions.pod:6786
28260 msgid "guestfs_strings"
28264 #: ../src/guestfs-actions.pod:6788
28268 " guestfs_strings (guestfs_h *g,\n"
28269 " const char *path);\n"
28274 #: ../src/guestfs-actions.pod:6804
28275 msgid "guestfs_strings_e"
28279 #: ../src/guestfs-actions.pod:6806
28283 " guestfs_strings_e (guestfs_h *g,\n"
28284 " const char *encoding,\n"
28285 " const char *path);\n"
28290 #: ../src/guestfs-actions.pod:6811
28292 "This is like the C<guestfs_strings> command, but allows you to specify the "
28293 "encoding of strings that are looked for in the source file C<path>."
28297 #: ../src/guestfs-actions.pod:6821
28299 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
28300 "ISO-8859-X (this is what C<guestfs_strings> uses)."
28304 #: ../src/guestfs-actions.pod:6859
28305 msgid "guestfs_swapoff_device"
28309 #: ../src/guestfs-actions.pod:6861
28313 " guestfs_swapoff_device (guestfs_h *g,\n"
28314 " const char *device);\n"
28319 #: ../src/guestfs-actions.pod:6865
28321 "This command disables the libguestfs appliance swap device or partition "
28322 "named C<device>. See C<guestfs_swapon_device>."
28326 #: ../src/guestfs-actions.pod:6873
28327 msgid "guestfs_swapoff_file"
28331 #: ../src/guestfs-actions.pod:6875
28335 " guestfs_swapoff_file (guestfs_h *g,\n"
28336 " const char *file);\n"
28341 #: ../src/guestfs-actions.pod:6885
28342 msgid "guestfs_swapoff_label"
28346 #: ../src/guestfs-actions.pod:6887
28350 " guestfs_swapoff_label (guestfs_h *g,\n"
28351 " const char *label);\n"
28356 #: ../src/guestfs-actions.pod:6898
28357 msgid "guestfs_swapoff_uuid"
28361 #: ../src/guestfs-actions.pod:6900
28365 " guestfs_swapoff_uuid (guestfs_h *g,\n"
28366 " const char *uuid);\n"
28371 #: ../src/guestfs-actions.pod:6911
28372 msgid "guestfs_swapon_device"
28376 #: ../src/guestfs-actions.pod:6913
28380 " guestfs_swapon_device (guestfs_h *g,\n"
28381 " const char *device);\n"
28386 #: ../src/guestfs-actions.pod:6917
28388 "This command enables the libguestfs appliance to use the swap device or "
28389 "partition named C<device>. The increased memory is made available for all "
28390 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
28394 #: ../src/guestfs-actions.pod:6933
28395 msgid "guestfs_swapon_file"
28399 #: ../src/guestfs-actions.pod:6935
28403 " guestfs_swapon_file (guestfs_h *g,\n"
28404 " const char *file);\n"
28409 #: ../src/guestfs-actions.pod:6939
28411 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
28416 #: ../src/guestfs-actions.pod:6946
28417 msgid "guestfs_swapon_label"
28421 #: ../src/guestfs-actions.pod:6948
28425 " guestfs_swapon_label (guestfs_h *g,\n"
28426 " const char *label);\n"
28431 #: ../src/guestfs-actions.pod:6952
28433 "This command enables swap to a labeled swap partition. See "
28434 "C<guestfs_swapon_device> for other notes."
28438 #: ../src/guestfs-actions.pod:6959
28439 msgid "guestfs_swapon_uuid"
28443 #: ../src/guestfs-actions.pod:6961
28447 " guestfs_swapon_uuid (guestfs_h *g,\n"
28448 " const char *uuid);\n"
28453 #: ../src/guestfs-actions.pod:6965
28455 "This command enables swap to a swap partition with the given UUID. See "
28456 "C<guestfs_swapon_device> for other notes."
28460 #: ../src/guestfs-actions.pod:6972
28461 msgid "guestfs_sync"
28465 #: ../src/guestfs-actions.pod:6974
28469 " guestfs_sync (guestfs_h *g);\n"
28474 #: ../src/guestfs-actions.pod:6987
28475 msgid "guestfs_tail"
28479 #: ../src/guestfs-actions.pod:6989
28483 " guestfs_tail (guestfs_h *g,\n"
28484 " const char *path);\n"
28489 #: ../src/guestfs-actions.pod:7005
28490 msgid "guestfs_tail_n"
28494 #: ../src/guestfs-actions.pod:7007
28498 " guestfs_tail_n (guestfs_h *g,\n"
28500 " const char *path);\n"
28505 #: ../src/guestfs-actions.pod:7029
28506 msgid "guestfs_tar_in"
28510 #: ../src/guestfs-actions.pod:7031
28514 " guestfs_tar_in (guestfs_h *g,\n"
28515 " const char *tarfile,\n"
28516 " const char *directory);\n"
28521 #: ../src/guestfs-actions.pod:7039
28522 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
28526 #: ../src/guestfs-actions.pod:7044 ../src/guestfs-actions.pod:7061 ../src/guestfs-actions.pod:7077 ../src/guestfs-actions.pod:7093
28527 msgid "(Added in 1.0.3)"
28531 #: ../src/guestfs-actions.pod:7046
28532 msgid "guestfs_tar_out"
28536 #: ../src/guestfs-actions.pod:7048
28540 " guestfs_tar_out (guestfs_h *g,\n"
28541 " const char *directory,\n"
28542 " const char *tarfile);\n"
28547 #: ../src/guestfs-actions.pod:7056
28549 "To download a compressed tarball, use C<guestfs_tgz_out> or "
28550 "C<guestfs_txz_out>."
28554 #: ../src/guestfs-actions.pod:7063
28555 msgid "guestfs_tgz_in"
28559 #: ../src/guestfs-actions.pod:7065
28563 " guestfs_tgz_in (guestfs_h *g,\n"
28564 " const char *tarball,\n"
28565 " const char *directory);\n"
28570 #: ../src/guestfs-actions.pod:7073
28571 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
28575 #: ../src/guestfs-actions.pod:7079
28576 msgid "guestfs_tgz_out"
28580 #: ../src/guestfs-actions.pod:7081
28584 " guestfs_tgz_out (guestfs_h *g,\n"
28585 " const char *directory,\n"
28586 " const char *tarball);\n"
28591 #: ../src/guestfs-actions.pod:7089
28592 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
28596 #: ../src/guestfs-actions.pod:7095
28597 msgid "guestfs_touch"
28601 #: ../src/guestfs-actions.pod:7097
28605 " guestfs_touch (guestfs_h *g,\n"
28606 " const char *path);\n"
28611 #: ../src/guestfs-actions.pod:7112
28612 msgid "guestfs_truncate"
28616 #: ../src/guestfs-actions.pod:7114
28620 " guestfs_truncate (guestfs_h *g,\n"
28621 " const char *path);\n"
28626 #: ../src/guestfs-actions.pod:7125
28627 msgid "guestfs_truncate_size"
28631 #: ../src/guestfs-actions.pod:7127
28635 " guestfs_truncate_size (guestfs_h *g,\n"
28636 " const char *path,\n"
28637 " int64_t size);\n"
28642 #: ../src/guestfs-actions.pod:7135
28644 "If the current file size is less than C<size> then the file is extended to "
28645 "the required size with zero bytes. This creates a sparse file (ie. disk "
28646 "blocks are not allocated for the file until you write to it). To create a "
28647 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
28651 #: ../src/guestfs-actions.pod:7145
28652 msgid "guestfs_tune2fs_l"
28656 #: ../src/guestfs-actions.pod:7147
28660 " guestfs_tune2fs_l (guestfs_h *g,\n"
28661 " const char *device);\n"
28666 #: ../src/guestfs-actions.pod:7167
28667 msgid "guestfs_txz_in"
28671 #: ../src/guestfs-actions.pod:7169
28675 " guestfs_txz_in (guestfs_h *g,\n"
28676 " const char *tarball,\n"
28677 " const char *directory);\n"
28682 #: ../src/guestfs-actions.pod:7181
28683 msgid "guestfs_txz_out"
28687 #: ../src/guestfs-actions.pod:7183
28691 " guestfs_txz_out (guestfs_h *g,\n"
28692 " const char *directory,\n"
28693 " const char *tarball);\n"
28698 #: ../src/guestfs-actions.pod:7195
28699 msgid "guestfs_umask"
28703 #: ../src/guestfs-actions.pod:7197
28707 " guestfs_umask (guestfs_h *g,\n"
28713 #: ../src/guestfs-actions.pod:7213
28715 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
28716 "C<guestfs_mkdir>."
28720 #: ../src/guestfs-actions.pod:7222
28721 msgid "guestfs_umount"
28725 #: ../src/guestfs-actions.pod:7224
28729 " guestfs_umount (guestfs_h *g,\n"
28730 " const char *pathordevice);\n"
28735 #: ../src/guestfs-actions.pod:7236
28736 msgid "guestfs_umount_all"
28740 #: ../src/guestfs-actions.pod:7238
28744 " guestfs_umount_all (guestfs_h *g);\n"
28749 #: ../src/guestfs-actions.pod:7249
28750 msgid "guestfs_upload"
28754 #: ../src/guestfs-actions.pod:7251
28758 " guestfs_upload (guestfs_h *g,\n"
28759 " const char *filename,\n"
28760 " const char *remotefilename);\n"
28765 #: ../src/guestfs-actions.pod:7261
28766 msgid "See also C<guestfs_download>."
28770 #: ../src/guestfs-actions.pod:7272
28771 msgid "guestfs_upload_offset"
28775 #: ../src/guestfs-actions.pod:7274
28779 " guestfs_upload_offset (guestfs_h *g,\n"
28780 " const char *filename,\n"
28781 " const char *remotefilename,\n"
28782 " int64_t offset);\n"
28787 #: ../src/guestfs-actions.pod:7290
28789 "Note that there is no limit on the amount of data that can be uploaded with "
28790 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
28791 "full amount unless an error occurs."
28795 #: ../src/guestfs-actions.pod:7295
28796 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
28800 #: ../src/guestfs-actions.pod:7306
28801 msgid "guestfs_utimens"
28805 #: ../src/guestfs-actions.pod:7308
28809 " guestfs_utimens (guestfs_h *g,\n"
28810 " const char *path,\n"
28811 " int64_t atsecs,\n"
28812 " int64_t atnsecs,\n"
28813 " int64_t mtsecs,\n"
28814 " int64_t mtnsecs);\n"
28819 #: ../src/guestfs-actions.pod:7337 ../src/guestfs-structs.pod:175
28820 msgid "guestfs_version"
28824 #: ../src/guestfs-actions.pod:7339
28827 " struct guestfs_version *\n"
28828 " guestfs_version (guestfs_h *g);\n"
28833 #: ../src/guestfs-actions.pod:7367
28835 "I<Note:> Don't use this call to test for availability of features. In "
28836 "enterprise distributions we backport features from later versions into "
28837 "earlier versions, making this an unreliable way to test for features. Use "
28838 "C<guestfs_available> instead."
28842 #: ../src/guestfs-actions.pod:7373
28844 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
28845 "error. I<The caller must call C<guestfs_free_version> after use>."
28849 #: ../src/guestfs-actions.pod:7377
28850 msgid "(Added in 1.0.58)"
28854 #: ../src/guestfs-actions.pod:7379
28855 msgid "guestfs_vfs_label"
28859 #: ../src/guestfs-actions.pod:7381
28863 " guestfs_vfs_label (guestfs_h *g,\n"
28864 " const char *device);\n"
28869 #: ../src/guestfs-actions.pod:7390
28870 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
28874 #: ../src/guestfs-actions.pod:7395 ../src/guestfs-actions.pod:7432
28875 msgid "(Added in 1.3.18)"
28879 #: ../src/guestfs-actions.pod:7397
28880 msgid "guestfs_vfs_type"
28884 #: ../src/guestfs-actions.pod:7399
28888 " guestfs_vfs_type (guestfs_h *g,\n"
28889 " const char *device);\n"
28894 #: ../src/guestfs-actions.pod:7416
28895 msgid "guestfs_vfs_uuid"
28899 #: ../src/guestfs-actions.pod:7418
28903 " guestfs_vfs_uuid (guestfs_h *g,\n"
28904 " const char *device);\n"
28909 #: ../src/guestfs-actions.pod:7427
28910 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
28914 #: ../src/guestfs-actions.pod:7434
28915 msgid "guestfs_vg_activate"
28919 #: ../src/guestfs-actions.pod:7436
28923 " guestfs_vg_activate (guestfs_h *g,\n"
28925 " char *const *volgroups);\n"
28930 #: ../src/guestfs-actions.pod:7453
28931 msgid "guestfs_vg_activate_all"
28935 #: ../src/guestfs-actions.pod:7455
28939 " guestfs_vg_activate_all (guestfs_h *g,\n"
28940 " int activate);\n"
28945 #: ../src/guestfs-actions.pod:7468
28946 msgid "guestfs_vgcreate"
28950 #: ../src/guestfs-actions.pod:7470
28954 " guestfs_vgcreate (guestfs_h *g,\n"
28955 " const char *volgroup,\n"
28956 " char *const *physvols);\n"
28961 #: ../src/guestfs-actions.pod:7482
28962 msgid "guestfs_vglvuuids"
28966 #: ../src/guestfs-actions.pod:7484
28970 " guestfs_vglvuuids (guestfs_h *g,\n"
28971 " const char *vgname);\n"
28976 #: ../src/guestfs-actions.pod:7491
28978 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
28979 "associate logical volumes and volume groups."
28983 #: ../src/guestfs-actions.pod:7494
28984 msgid "See also C<guestfs_vgpvuuids>."
28988 #: ../src/guestfs-actions.pod:7502
28989 msgid "guestfs_vgpvuuids"
28993 #: ../src/guestfs-actions.pod:7504
28997 " guestfs_vgpvuuids (guestfs_h *g,\n"
28998 " const char *vgname);\n"
29003 #: ../src/guestfs-actions.pod:7511
29005 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
29006 "associate physical volumes and volume groups."
29010 #: ../src/guestfs-actions.pod:7514
29011 msgid "See also C<guestfs_vglvuuids>."
29015 #: ../src/guestfs-actions.pod:7522
29016 msgid "guestfs_vgremove"
29020 #: ../src/guestfs-actions.pod:7524
29024 " guestfs_vgremove (guestfs_h *g,\n"
29025 " const char *vgname);\n"
29030 #: ../src/guestfs-actions.pod:7537
29031 msgid "guestfs_vgrename"
29035 #: ../src/guestfs-actions.pod:7539
29039 " guestfs_vgrename (guestfs_h *g,\n"
29040 " const char *volgroup,\n"
29041 " const char *newvolgroup);\n"
29046 #: ../src/guestfs-actions.pod:7550
29047 msgid "guestfs_vgs"
29051 #: ../src/guestfs-actions.pod:7552
29055 " guestfs_vgs (guestfs_h *g);\n"
29060 #: ../src/guestfs-actions.pod:7561
29061 msgid "See also C<guestfs_vgs_full>."
29065 #: ../src/guestfs-actions.pod:7569
29066 msgid "guestfs_vgs_full"
29070 #: ../src/guestfs-actions.pod:7571
29073 " struct guestfs_lvm_vg_list *\n"
29074 " guestfs_vgs_full (guestfs_h *g);\n"
29079 #: ../src/guestfs-actions.pod:7577
29081 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
29082 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
29087 #: ../src/guestfs-actions.pod:7583
29088 msgid "guestfs_vgscan"
29092 #: ../src/guestfs-actions.pod:7585
29096 " guestfs_vgscan (guestfs_h *g);\n"
29101 #: ../src/guestfs-actions.pod:7595
29102 msgid "guestfs_vguuid"
29106 #: ../src/guestfs-actions.pod:7597
29110 " guestfs_vguuid (guestfs_h *g,\n"
29111 " const char *vgname);\n"
29116 #: ../src/guestfs-actions.pod:7608
29117 msgid "guestfs_wait_ready"
29121 #: ../src/guestfs-actions.pod:7610
29125 " guestfs_wait_ready (guestfs_h *g);\n"
29130 #: ../src/guestfs-actions.pod:7613
29131 msgid "This function is a no op."
29135 #: ../src/guestfs-actions.pod:7615
29137 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
29138 "calling C<guestfs_launch> to wait for the launch to complete. However this "
29139 "is no longer necessary because C<guestfs_launch> now does the waiting."
29143 #: ../src/guestfs-actions.pod:7620
29145 "If you see any calls to this function in code then you can just remove them, "
29146 "unless you want to retain compatibility with older versions of the API."
29150 #: ../src/guestfs-actions.pod:7626
29152 "This function is deprecated. In new code, use the L</guestfs_launch> call "
29157 #: ../src/guestfs-actions.pod:7635
29158 msgid "guestfs_wc_c"
29162 #: ../src/guestfs-actions.pod:7637
29166 " guestfs_wc_c (guestfs_h *g,\n"
29167 " const char *path);\n"
29172 #: ../src/guestfs-actions.pod:7648
29173 msgid "guestfs_wc_l"
29177 #: ../src/guestfs-actions.pod:7650
29181 " guestfs_wc_l (guestfs_h *g,\n"
29182 " const char *path);\n"
29187 #: ../src/guestfs-actions.pod:7661
29188 msgid "guestfs_wc_w"
29192 #: ../src/guestfs-actions.pod:7663
29196 " guestfs_wc_w (guestfs_h *g,\n"
29197 " const char *path);\n"
29202 #: ../src/guestfs-actions.pod:7674
29203 msgid "guestfs_write"
29207 #: ../src/guestfs-actions.pod:7676
29211 " guestfs_write (guestfs_h *g,\n"
29212 " const char *path,\n"
29213 " const char *content,\n"
29214 " size_t content_size);\n"
29219 #: ../src/guestfs-actions.pod:7685
29220 msgid "See also C<guestfs_write_append>."
29224 #: ../src/guestfs-actions.pod:7694
29225 msgid "guestfs_write_append"
29229 #: ../src/guestfs-actions.pod:7696
29233 " guestfs_write_append (guestfs_h *g,\n"
29234 " const char *path,\n"
29235 " const char *content,\n"
29236 " size_t content_size);\n"
29241 #: ../src/guestfs-actions.pod:7705
29242 msgid "See also C<guestfs_write>."
29246 #: ../src/guestfs-actions.pod:7714
29247 msgid "guestfs_write_file"
29251 #: ../src/guestfs-actions.pod:7716
29255 " guestfs_write_file (guestfs_h *g,\n"
29256 " const char *path,\n"
29257 " const char *content,\n"
29263 #: ../src/guestfs-actions.pod:7738
29265 "This function is deprecated. In new code, use the L</guestfs_write> call "
29270 #: ../src/guestfs-actions.pod:7747
29271 msgid "guestfs_zegrep"
29275 #: ../src/guestfs-actions.pod:7749
29279 " guestfs_zegrep (guestfs_h *g,\n"
29280 " const char *regex,\n"
29281 " const char *path);\n"
29286 #: ../src/guestfs-actions.pod:7766
29287 msgid "guestfs_zegrepi"
29291 #: ../src/guestfs-actions.pod:7768
29295 " guestfs_zegrepi (guestfs_h *g,\n"
29296 " const char *regex,\n"
29297 " const char *path);\n"
29302 #: ../src/guestfs-actions.pod:7785
29303 msgid "guestfs_zero"
29307 #: ../src/guestfs-actions.pod:7787
29311 " guestfs_zero (guestfs_h *g,\n"
29312 " const char *device);\n"
29317 #: ../src/guestfs-actions.pod:7801
29319 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
29320 "C<guestfs_is_zero_device>"
29324 #: ../src/guestfs-actions.pod:7813
29325 msgid "guestfs_zero_device"
29329 #: ../src/guestfs-actions.pod:7815
29333 " guestfs_zero_device (guestfs_h *g,\n"
29334 " const char *device);\n"
29339 #: ../src/guestfs-actions.pod:7819
29341 "This command writes zeroes over the entire C<device>. Compare with "
29342 "C<guestfs_zero> which just zeroes the first few blocks of a device."
29346 #: ../src/guestfs-actions.pod:7837
29347 msgid "(Added in 1.3.1)"
29351 #: ../src/guestfs-actions.pod:7839
29352 msgid "guestfs_zerofree"
29356 #: ../src/guestfs-actions.pod:7841
29360 " guestfs_zerofree (guestfs_h *g,\n"
29361 " const char *device);\n"
29366 #: ../src/guestfs-actions.pod:7860
29367 msgid "guestfs_zfgrep"
29371 #: ../src/guestfs-actions.pod:7862
29375 " guestfs_zfgrep (guestfs_h *g,\n"
29376 " const char *pattern,\n"
29377 " const char *path);\n"
29382 #: ../src/guestfs-actions.pod:7879
29383 msgid "guestfs_zfgrepi"
29387 #: ../src/guestfs-actions.pod:7881
29391 " guestfs_zfgrepi (guestfs_h *g,\n"
29392 " const char *pattern,\n"
29393 " const char *path);\n"
29398 #: ../src/guestfs-actions.pod:7898
29399 msgid "guestfs_zfile"
29403 #: ../src/guestfs-actions.pod:7900
29407 " guestfs_zfile (guestfs_h *g,\n"
29408 " const char *meth,\n"
29409 " const char *path);\n"
29414 #: ../src/guestfs-actions.pod:7910
29416 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
29421 #: ../src/guestfs-actions.pod:7916
29423 "This function is deprecated. In new code, use the L</guestfs_file> call "
29428 #: ../src/guestfs-actions.pod:7925
29429 msgid "guestfs_zgrep"
29433 #: ../src/guestfs-actions.pod:7927
29437 " guestfs_zgrep (guestfs_h *g,\n"
29438 " const char *regex,\n"
29439 " const char *path);\n"
29444 #: ../src/guestfs-actions.pod:7944
29445 msgid "guestfs_zgrepi"
29449 #: ../src/guestfs-actions.pod:7946
29453 " guestfs_zgrepi (guestfs_h *g,\n"
29454 " const char *regex,\n"
29455 " const char *path);\n"
29460 #: ../src/guestfs-availability.pod:3
29465 #: ../src/guestfs-availability.pod:5
29467 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
29468 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
29469 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
29470 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
29471 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
29475 #: ../src/guestfs-availability.pod:21
29480 #: ../src/guestfs-availability.pod:23
29481 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
29485 #: ../src/guestfs-availability.pod:26
29490 #: ../src/guestfs-availability.pod:28
29491 msgid "The following functions: L</guestfs_grub_install>"
29495 #: ../src/guestfs-availability.pod:31
29500 #: ../src/guestfs-availability.pod:33
29502 "The following functions: L</guestfs_inotify_add_watch> "
29503 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
29504 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
29508 #: ../src/guestfs-availability.pod:41
29509 msgid "B<linuxfsuuid>"
29513 #: ../src/guestfs-availability.pod:43
29515 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
29516 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
29520 #: ../src/guestfs-availability.pod:50
29521 msgid "B<linuxmodules>"
29525 #: ../src/guestfs-availability.pod:52
29526 msgid "The following functions: L</guestfs_modprobe>"
29530 #: ../src/guestfs-availability.pod:55
29531 msgid "B<linuxxattrs>"
29535 #: ../src/guestfs-availability.pod:57
29537 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
29538 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
29539 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
29540 "L</guestfs_setxattr>"
29544 #: ../src/guestfs-availability.pod:68
29549 #: ../src/guestfs-availability.pod:70
29551 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
29552 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
29553 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
29557 #: ../src/guestfs-availability.pod:79
29562 #: ../src/guestfs-availability.pod:81
29564 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
29565 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
29566 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
29567 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
29568 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
29569 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
29570 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
29571 "L</guestfs_vgs_full>"
29575 #: ../src/guestfs-availability.pod:104
29580 #: ../src/guestfs-availability.pod:106
29582 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
29583 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
29587 #: ../src/guestfs-availability.pod:112
29592 #: ../src/guestfs-availability.pod:114
29593 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
29597 #: ../src/guestfs-availability.pod:117
29598 msgid "B<ntfsprogs>"
29602 #: ../src/guestfs-availability.pod:119
29604 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
29605 "L</guestfs_ntfsresize_size>"
29609 #: ../src/guestfs-availability.pod:124
29610 msgid "B<realpath>"
29614 #: ../src/guestfs-availability.pod:126
29615 msgid "The following functions: L</guestfs_realpath>"
29619 #: ../src/guestfs-availability.pod:129
29624 #: ../src/guestfs-availability.pod:131
29626 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
29627 "L</guestfs_scrub_freespace>"
29631 #: ../src/guestfs-availability.pod:136
29636 #: ../src/guestfs-availability.pod:138
29637 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
29641 #: ../src/guestfs-availability.pod:142
29646 #: ../src/guestfs-availability.pod:144
29647 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
29651 #: ../src/guestfs-availability.pod:148
29652 msgid "B<zerofree>"
29656 #: ../src/guestfs-availability.pod:150
29657 msgid "The following functions: L</guestfs_zerofree>"
29661 #: ../src/guestfs-structs.pod:1
29662 msgid "guestfs_int_bool"
29666 #: ../src/guestfs-structs.pod:3
29669 " struct guestfs_int_bool {\n"
29677 #: ../src/guestfs-structs.pod:8
29680 " struct guestfs_int_bool_list {\n"
29681 " uint32_t len; /* Number of elements in list. */\n"
29682 " struct guestfs_int_bool *val; /* Elements. */\n"
29688 #: ../src/guestfs-structs.pod:13
29691 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
29692 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
29697 #: ../src/guestfs-structs.pod:16
29698 msgid "guestfs_lvm_pv"
29702 #: ../src/guestfs-structs.pod:18
29705 " struct guestfs_lvm_pv {\n"
29706 " char *pv_name;\n"
29707 " /* The next field is NOT nul-terminated, be careful when printing it: "
29709 " char pv_uuid[32];\n"
29711 " uint64_t pv_size;\n"
29712 " uint64_t dev_size;\n"
29713 " uint64_t pv_free;\n"
29714 " uint64_t pv_used;\n"
29715 " char *pv_attr;\n"
29716 " int64_t pv_pe_count;\n"
29717 " int64_t pv_pe_alloc_count;\n"
29718 " char *pv_tags;\n"
29719 " uint64_t pe_start;\n"
29720 " int64_t pv_mda_count;\n"
29721 " uint64_t pv_mda_free;\n"
29727 #: ../src/guestfs-structs.pod:36
29730 " struct guestfs_lvm_pv_list {\n"
29731 " uint32_t len; /* Number of elements in list. */\n"
29732 " struct guestfs_lvm_pv *val; /* Elements. */\n"
29738 #: ../src/guestfs-structs.pod:41
29741 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
29742 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
29747 #: ../src/guestfs-structs.pod:44
29748 msgid "guestfs_lvm_vg"
29752 #: ../src/guestfs-structs.pod:46
29755 " struct guestfs_lvm_vg {\n"
29756 " char *vg_name;\n"
29757 " /* The next field is NOT nul-terminated, be careful when printing it: "
29759 " char vg_uuid[32];\n"
29761 " char *vg_attr;\n"
29762 " uint64_t vg_size;\n"
29763 " uint64_t vg_free;\n"
29764 " char *vg_sysid;\n"
29765 " uint64_t vg_extent_size;\n"
29766 " int64_t vg_extent_count;\n"
29767 " int64_t vg_free_count;\n"
29768 " int64_t max_lv;\n"
29769 " int64_t max_pv;\n"
29770 " int64_t pv_count;\n"
29771 " int64_t lv_count;\n"
29772 " int64_t snap_count;\n"
29773 " int64_t vg_seqno;\n"
29774 " char *vg_tags;\n"
29775 " int64_t vg_mda_count;\n"
29776 " uint64_t vg_mda_free;\n"
29782 #: ../src/guestfs-structs.pod:69
29785 " struct guestfs_lvm_vg_list {\n"
29786 " uint32_t len; /* Number of elements in list. */\n"
29787 " struct guestfs_lvm_vg *val; /* Elements. */\n"
29793 #: ../src/guestfs-structs.pod:74
29796 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
29797 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
29802 #: ../src/guestfs-structs.pod:77
29803 msgid "guestfs_lvm_lv"
29807 #: ../src/guestfs-structs.pod:79
29810 " struct guestfs_lvm_lv {\n"
29811 " char *lv_name;\n"
29812 " /* The next field is NOT nul-terminated, be careful when printing it: "
29814 " char lv_uuid[32];\n"
29815 " char *lv_attr;\n"
29816 " int64_t lv_major;\n"
29817 " int64_t lv_minor;\n"
29818 " int64_t lv_kernel_major;\n"
29819 " int64_t lv_kernel_minor;\n"
29820 " uint64_t lv_size;\n"
29821 " int64_t seg_count;\n"
29823 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
29824 " float snap_percent;\n"
29825 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
29826 " float copy_percent;\n"
29827 " char *move_pv;\n"
29828 " char *lv_tags;\n"
29829 " char *mirror_log;\n"
29830 " char *modules;\n"
29836 #: ../src/guestfs-structs.pod:101
29839 " struct guestfs_lvm_lv_list {\n"
29840 " uint32_t len; /* Number of elements in list. */\n"
29841 " struct guestfs_lvm_lv *val; /* Elements. */\n"
29847 #: ../src/guestfs-structs.pod:106
29850 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
29851 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
29856 #: ../src/guestfs-structs.pod:111
29859 " struct guestfs_stat {\n"
29863 " int64_t nlink;\n"
29868 " int64_t blksize;\n"
29869 " int64_t blocks;\n"
29870 " int64_t atime;\n"
29871 " int64_t mtime;\n"
29872 " int64_t ctime;\n"
29878 #: ../src/guestfs-structs.pod:127
29881 " struct guestfs_stat_list {\n"
29882 " uint32_t len; /* Number of elements in list. */\n"
29883 " struct guestfs_stat *val; /* Elements. */\n"
29889 #: ../src/guestfs-structs.pod:132
29892 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
29893 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
29898 #: ../src/guestfs-structs.pod:137
29901 " struct guestfs_statvfs {\n"
29902 " int64_t bsize;\n"
29903 " int64_t frsize;\n"
29904 " int64_t blocks;\n"
29905 " int64_t bfree;\n"
29906 " int64_t bavail;\n"
29907 " int64_t files;\n"
29908 " int64_t ffree;\n"
29909 " int64_t favail;\n"
29912 " int64_t namemax;\n"
29918 #: ../src/guestfs-structs.pod:151
29921 " struct guestfs_statvfs_list {\n"
29922 " uint32_t len; /* Number of elements in list. */\n"
29923 " struct guestfs_statvfs *val; /* Elements. */\n"
29929 #: ../src/guestfs-structs.pod:156
29932 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
29933 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
29938 #: ../src/guestfs-structs.pod:159
29939 msgid "guestfs_dirent"
29943 #: ../src/guestfs-structs.pod:161
29946 " struct guestfs_dirent {\n"
29955 #: ../src/guestfs-structs.pod:167
29958 " struct guestfs_dirent_list {\n"
29959 " uint32_t len; /* Number of elements in list. */\n"
29960 " struct guestfs_dirent *val; /* Elements. */\n"
29966 #: ../src/guestfs-structs.pod:172
29969 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
29970 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
29975 #: ../src/guestfs-structs.pod:177
29978 " struct guestfs_version {\n"
29979 " int64_t major;\n"
29980 " int64_t minor;\n"
29981 " int64_t release;\n"
29988 #: ../src/guestfs-structs.pod:184
29991 " struct guestfs_version_list {\n"
29992 " uint32_t len; /* Number of elements in list. */\n"
29993 " struct guestfs_version *val; /* Elements. */\n"
29999 #: ../src/guestfs-structs.pod:189
30002 " void guestfs_free_version (struct guestfs_free_version *);\n"
30003 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
30008 #: ../src/guestfs-structs.pod:192
30009 msgid "guestfs_xattr"
30013 #: ../src/guestfs-structs.pod:194
30016 " struct guestfs_xattr {\n"
30017 " char *attrname;\n"
30018 " /* The next two fields describe a byte array. */\n"
30019 " uint32_t attrval_len;\n"
30020 " char *attrval;\n"
30026 #: ../src/guestfs-structs.pod:201
30029 " struct guestfs_xattr_list {\n"
30030 " uint32_t len; /* Number of elements in list. */\n"
30031 " struct guestfs_xattr *val; /* Elements. */\n"
30037 #: ../src/guestfs-structs.pod:206
30040 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
30041 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
30046 #: ../src/guestfs-structs.pod:209
30047 msgid "guestfs_inotify_event"
30051 #: ../src/guestfs-structs.pod:211
30054 " struct guestfs_inotify_event {\n"
30055 " int64_t in_wd;\n"
30056 " uint32_t in_mask;\n"
30057 " uint32_t in_cookie;\n"
30058 " char *in_name;\n"
30064 #: ../src/guestfs-structs.pod:218
30067 " struct guestfs_inotify_event_list {\n"
30068 " uint32_t len; /* Number of elements in list. */\n"
30069 " struct guestfs_inotify_event *val; /* Elements. */\n"
30075 #: ../src/guestfs-structs.pod:223
30078 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
30079 " void guestfs_free_inotify_event_list (struct "
30080 "guestfs_free_inotify_event_list *);\n"
30085 #: ../src/guestfs-structs.pod:226
30086 msgid "guestfs_partition"
30090 #: ../src/guestfs-structs.pod:228
30093 " struct guestfs_partition {\n"
30094 " int32_t part_num;\n"
30095 " uint64_t part_start;\n"
30096 " uint64_t part_end;\n"
30097 " uint64_t part_size;\n"
30103 #: ../src/guestfs-structs.pod:235
30106 " struct guestfs_partition_list {\n"
30107 " uint32_t len; /* Number of elements in list. */\n"
30108 " struct guestfs_partition *val; /* Elements. */\n"
30114 #: ../src/guestfs-structs.pod:240
30117 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
30118 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
30123 #: ../src/guestfs-structs.pod:243
30124 msgid "guestfs_application"
30128 #: ../src/guestfs-structs.pod:245
30131 " struct guestfs_application {\n"
30132 " char *app_name;\n"
30133 " char *app_display_name;\n"
30134 " int32_t app_epoch;\n"
30135 " char *app_version;\n"
30136 " char *app_release;\n"
30137 " char *app_install_path;\n"
30138 " char *app_trans_path;\n"
30139 " char *app_publisher;\n"
30140 " char *app_url;\n"
30141 " char *app_source_package;\n"
30142 " char *app_summary;\n"
30143 " char *app_description;\n"
30149 #: ../src/guestfs-structs.pod:260
30152 " struct guestfs_application_list {\n"
30153 " uint32_t len; /* Number of elements in list. */\n"
30154 " struct guestfs_application *val; /* Elements. */\n"
30160 #: ../src/guestfs-structs.pod:265
30163 " void guestfs_free_application (struct guestfs_free_application *);\n"
30164 " void guestfs_free_application_list (struct guestfs_free_application_list "
30170 #: ../src/guestfs.pod:5
30171 msgid "guestfs - Library for accessing and modifying virtual machine images"
30175 #: ../src/guestfs.pod:11
30178 " guestfs_h *g = guestfs_create ();\n"
30179 " guestfs_add_drive (g, \"guest.img\");\n"
30180 " guestfs_launch (g);\n"
30181 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
30182 " guestfs_touch (g, \"/hello\");\n"
30183 " guestfs_umount (g, \"/\");\n"
30184 " guestfs_close (g);\n"
30189 #: ../src/guestfs.pod:25
30191 "Libguestfs is a library for accessing and modifying guest disk images. "
30192 "Amongst the things this is good for: making batch configuration changes to "
30193 "guests, getting disk used/free statistics (see also: virt-df), migrating "
30194 "between virtualization systems (see also: virt-p2v), performing partial "
30195 "backups, performing partial guest clones, cloning guests and changing "
30196 "registry/UUID/hostname info, and much else besides."
30200 #: ../src/guestfs.pod:33
30202 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
30203 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
30204 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
30209 #: ../src/guestfs.pod:38
30211 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
30212 "what filesystem is in each LV, etc.). It can also run commands in the "
30213 "context of the guest. Also you can access filesystems over FUSE."
30217 #: ../src/guestfs.pod:43
30219 "Libguestfs is a library that can be linked with C and C++ management "
30220 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
30221 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
30226 #: ../src/guestfs.pod:48
30228 "You don't need to be root to use libguestfs, although obviously you do need "
30229 "enough permissions to access the disk images."
30233 #: ../src/guestfs.pod:51
30235 "Libguestfs is a large API because it can do many things. For a gentle "
30236 "introduction, please read the L</API OVERVIEW> section next."
30240 #: ../src/guestfs.pod:54
30242 "There are also some example programs in the L<guestfs-examples(3)> manual "
30247 #: ../src/guestfs.pod:57
30248 msgid "API OVERVIEW"
30252 #: ../src/guestfs.pod:59
30254 "This section provides a gentler overview of the libguestfs API. We also try "
30255 "to group API calls together, where that may not be obvious from reading "
30256 "about the individual calls in the main section of this manual."
30260 #: ../src/guestfs.pod:64
30265 #: ../src/guestfs.pod:66
30267 "Before you can use libguestfs calls, you have to create a handle. Then you "
30268 "must add at least one disk image to the handle, followed by launching the "
30269 "handle, then performing whatever operations you want, and finally closing "
30270 "the handle. By convention we use the single letter C<g> for the name of the "
30271 "handle variable, although of course you can use any name you want."
30275 #: ../src/guestfs.pod:73
30276 msgid "The general structure of all libguestfs-using programs looks like this:"
30280 #: ../src/guestfs.pod:76
30283 " guestfs_h *g = guestfs_create ();\n"
30288 #: ../src/guestfs.pod:78
30291 " /* Call guestfs_add_drive additional times if there are\n"
30292 " * multiple disk images.\n"
30294 " guestfs_add_drive (g, \"guest.img\");\n"
30299 #: ../src/guestfs.pod:83
30302 " /* Most manipulation calls won't work until you've launched\n"
30303 " * the handle 'g'. You have to do this _after_ adding drives\n"
30304 " * and _before_ other commands.\n"
30306 " guestfs_launch (g);\n"
30311 #: ../src/guestfs.pod:89
30314 " /* Now you can examine what partitions, LVs etc are available.\n"
30316 " char **partitions = guestfs_list_partitions (g);\n"
30317 " char **logvols = guestfs_lvs (g);\n"
30322 #: ../src/guestfs.pod:94
30325 " /* To access a filesystem in the image, you must mount it.\n"
30327 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
30332 #: ../src/guestfs.pod:98
30335 " /* Now you can perform filesystem actions on the guest\n"
30338 " guestfs_touch (g, \"/hello\");\n"
30343 #: ../src/guestfs.pod:103
30346 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
30347 " * it is done automatically when you close the handle. See\n"
30348 " * discussion of autosync in this page.\n"
30350 " guestfs_sync (g);\n"
30355 #: ../src/guestfs.pod:109
30358 " /* Close the handle 'g'. */\n"
30359 " guestfs_close (g);\n"
30364 #: ../src/guestfs.pod:112
30366 "The code above doesn't include any error checking. In real code you should "
30367 "check return values carefully for errors. In general all functions that "
30368 "return integers return C<-1> on error, and all functions that return "
30369 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
30370 "how to handle errors, and consult the documentation for each function call "
30371 "below to see precisely how they return error indications. See "
30372 "L<guestfs-examples(3)> for fully worked examples."
30376 #: ../src/guestfs.pod:121
30377 msgid "DISK IMAGES"
30381 #: ../src/guestfs.pod:123
30383 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
30384 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
30385 "actual block device, or simply an empty file of zeroes that you have created "
30386 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
30391 #: ../src/guestfs.pod:129
30393 "The call you should use in modern code for adding drives is "
30394 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
30395 "specifying that the format is raw, do:"
30399 #: ../src/guestfs.pod:133
30402 " guestfs_add_drive_opts (g, filename,\n"
30403 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
30409 #: ../src/guestfs.pod:137
30410 msgid "You can add a disk read-only using:"
30414 #: ../src/guestfs.pod:139
30417 " guestfs_add_drive_opts (g, filename,\n"
30418 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
30419 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
30425 #: ../src/guestfs.pod:144
30427 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
30428 "libguestfs won't modify the file."
30432 #: ../src/guestfs.pod:147
30434 "Be extremely cautious if the disk image is in use, eg. if it is being used "
30435 "by a virtual machine. Adding it read-write will almost certainly cause disk "
30436 "corruption, but adding it read-only is safe."
30440 #: ../src/guestfs.pod:151
30442 "You must add at least one disk image, and you may add multiple disk images. "
30443 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
30444 "first one you added), C</dev/sdb> (for the second one you added), etc."
30448 #: ../src/guestfs.pod:156
30450 "Once L</guestfs_launch> has been called you cannot add any more images. You "
30451 "can call L</guestfs_list_devices> to get a list of the device names, in the "
30452 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
30456 #: ../src/guestfs.pod:161
30461 #: ../src/guestfs.pod:163
30463 "Before you can read or write files, create directories and so on in a disk "
30464 "image that contains filesystems, you have to mount those filesystems using "
30465 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
30466 "a disk image contains (for example) one partition with a filesystem on that "
30467 "partition, then you can mount it directly:"
30471 #: ../src/guestfs.pod:170
30474 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
30479 #: ../src/guestfs.pod:172
30481 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
30482 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
30483 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
30484 "that these are libguestfs virtual devices, and are nothing to do with host "
30489 #: ../src/guestfs.pod:178
30491 "If you are given a disk image and you don't know what it contains then you "
30492 "have to find out. Libguestfs can do that too: use "
30493 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
30494 "and LVs, and either try mounting each to see what is mountable, or else "
30495 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
30496 "filesystems, use L</guestfs_list_filesystems>."
30500 #: ../src/guestfs.pod:186
30502 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
30503 "L</INSPECTION> below). But you might find it easier to look at higher level "
30504 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
30508 #: ../src/guestfs.pod:191
30510 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
30511 "several other variations of the C<guestfs_mount_*> call."
30515 #: ../src/guestfs.pod:194
30516 msgid "FILESYSTEM ACCESS AND MODIFICATION"
30520 #: ../src/guestfs.pod:196
30522 "The majority of the libguestfs API consists of fairly low-level calls for "
30523 "accessing and modifying the files, directories, symlinks etc on mounted "
30524 "filesystems. There are over a hundred such calls which you can find listed "
30525 "in detail below in this man page, and we don't even pretend to cover them "
30526 "all in this overview."
30530 #: ../src/guestfs.pod:202
30532 "Specify filenames as full paths, starting with C<\"/\"> and including the "
30537 #: ../src/guestfs.pod:205
30539 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
30540 "the file called C<\"etc/passwd\"> then you could do:"
30544 #: ../src/guestfs.pod:208
30547 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
30552 #: ../src/guestfs.pod:210
30554 "This would return C<data> as a newly allocated buffer containing the full "
30555 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
30556 "or C<NULL> if there was an error."
30560 #: ../src/guestfs.pod:214
30562 "As another example, to create a top-level directory on that filesystem "
30563 "called C<\"var\"> you would do:"
30567 #: ../src/guestfs.pod:217
30570 " guestfs_mkdir (g, \"/var\");\n"
30575 #: ../src/guestfs.pod:219
30576 msgid "To create a symlink you could do:"
30580 #: ../src/guestfs.pod:221
30583 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
30584 " \"/etc/rc3.d/S30portmap\");\n"
30589 #: ../src/guestfs.pod:224
30591 "Libguestfs will reject attempts to use relative paths and there is no "
30592 "concept of a current working directory."
30596 #: ../src/guestfs.pod:227
30598 "Libguestfs can return errors in many situations: for example if the "
30599 "filesystem isn't writable, or if a file or directory that you requested "
30600 "doesn't exist. If you are using the C API (documented here) you have to "
30601 "check for those error conditions after each call. (Other language bindings "
30602 "turn these errors into exceptions)."
30606 #: ../src/guestfs.pod:233
30608 "File writes are affected by the per-handle umask, set by calling "
30609 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
30613 #: ../src/guestfs.pod:236
30614 msgid "PARTITIONING"
30618 #: ../src/guestfs.pod:238
30620 "Libguestfs contains API calls to read, create and modify partition tables on "
30625 #: ../src/guestfs.pod:241
30627 "In the common case where you want to create a single partition covering the "
30628 "whole disk, you should use the L</guestfs_part_disk> call:"
30632 #: ../src/guestfs.pod:245
30635 " const char *parttype = \"mbr\";\n"
30636 " if (disk_is_larger_than_2TB)\n"
30637 " parttype = \"gpt\";\n"
30638 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
30643 #: ../src/guestfs.pod:250
30645 "Obviously this effectively wipes anything that was on that disk image "
30650 #: ../src/guestfs.pod:253
30655 #: ../src/guestfs.pod:255
30657 "Libguestfs provides access to a large part of the LVM2 API, such as "
30658 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
30659 "unless you familiarize yourself with the concepts of physical volumes, "
30660 "volume groups and logical volumes."
30664 #: ../src/guestfs.pod:260
30666 "This author strongly recommends reading the LVM HOWTO, online at "
30667 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
30671 #: ../src/guestfs.pod:263
30672 msgid "DOWNLOADING"
30676 #: ../src/guestfs.pod:265
30678 "Use L</guestfs_cat> to download small, text only files. This call is "
30679 "limited to files which are less than 2 MB and which cannot contain any ASCII "
30680 "NUL (C<\\0>) characters. However the API is very simple to use."
30684 #: ../src/guestfs.pod:269
30686 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
30687 "bit data, since it returns a (pointer, size) pair. However it is still "
30688 "limited to \"small\" files, less than 2 MB."
30692 #: ../src/guestfs.pod:273
30694 "L</guestfs_download> can be used to download any file, with no limits on "
30695 "content or size (even files larger than 4 GB)."
30699 #: ../src/guestfs.pod:276
30700 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
30704 #: ../src/guestfs.pod:279
30709 #: ../src/guestfs.pod:281
30711 "It's often the case that you want to write a file or files to the disk "
30716 #: ../src/guestfs.pod:284
30718 "To write a small file with fixed content, use L</guestfs_write>. To create "
30719 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
30720 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
30721 "variety of other functions for creating test files, for example "
30722 "L</guestfs_fill> and L</guestfs_fill_pattern>."
30726 #: ../src/guestfs.pod:290
30728 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
30729 "file content or size (even files larger than 4 GB)."
30733 #: ../src/guestfs.pod:293
30734 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
30738 #: ../src/guestfs.pod:295
30740 "However the fastest way to upload I<large numbers of arbitrary files> is to "
30741 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
30742 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
30743 "the drive in a predictable way (eg. adding it last after all other drives) "
30744 "then you can get the device name from L</guestfs_list_devices> and mount it "
30745 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
30746 "sometimes non-portable between kernel versions, and they don't support "
30747 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
30748 "using a label or UUID, use an ISO image instead."
30752 #: ../src/guestfs.pod:306
30757 #: ../src/guestfs.pod:308
30759 "There are various different commands for copying between files and devices "
30760 "and in and out of the guest filesystem. These are summarised in the table "
30765 #: ../src/guestfs.pod:314
30766 msgid "B<file> to B<file>"
30770 #: ../src/guestfs.pod:316
30772 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
30773 "directories recursively."
30777 #: ../src/guestfs.pod:319
30778 msgid "B<file or device> to B<file or device>"
30782 #: ../src/guestfs.pod:321
30784 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
30785 "devices in the guest."
30789 #: ../src/guestfs.pod:324
30790 msgid "Example: duplicate the contents of an LV:"
30794 #: ../src/guestfs.pod:326
30797 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
30802 #: ../src/guestfs.pod:328
30804 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
30805 "(C</dev/VG/Original>). To copy less than the whole source device, use "
30806 "L</guestfs_copy_size>."
30810 #: ../src/guestfs.pod:332
30811 msgid "B<file on the host> to B<file or device>"
30815 #: ../src/guestfs.pod:334
30816 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
30820 #: ../src/guestfs.pod:336
30821 msgid "B<file or device> to B<file on the host>"
30825 #: ../src/guestfs.pod:338
30826 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
30830 #: ../src/guestfs.pod:342
30831 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
30835 #: ../src/guestfs.pod:344
30837 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
30838 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
30839 "appears you can only upload and download to files. However many Un*x-like "
30840 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
30841 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
30842 "stderr, and arbitrary file descriptor N."
30846 #: ../src/guestfs.pod:352
30847 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
30851 #: ../src/guestfs.pod:355
30854 " guestfs_download (g, filename, \"/dev/stdout\");\n"
30859 #: ../src/guestfs.pod:357
30860 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
30864 #: ../src/guestfs.pod:359
30867 " char devfd[64];\n"
30868 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
30869 " guestfs_tar_out (g, \"/\", devfd);\n"
30874 #: ../src/guestfs.pod:363
30875 msgid "LISTING FILES"
30879 #: ../src/guestfs.pod:365
30881 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
30882 "L<guestfish(1)>-equivalent command C<ll>)."
30886 #: ../src/guestfs.pod:368
30888 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
30889 "programs, as a flat list of strings."
30893 #: ../src/guestfs.pod:371
30895 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
30896 "directory, plus additional information about each one. It is more "
30897 "equivalent to using the L<readdir(3)> call on a local filesystem."
30901 #: ../src/guestfs.pod:375
30903 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
30908 #: ../src/guestfs.pod:378
30909 msgid "RUNNING COMMANDS"
30913 #: ../src/guestfs.pod:380
30915 "Although libguestfs is primarily an API for manipulating files inside guest "
30916 "images, we also provide some limited facilities for running commands inside "
30921 #: ../src/guestfs.pod:384
30922 msgid "There are many limitations to this:"
30926 #: ../src/guestfs.pod:390
30928 "The kernel version that the command runs under will be different from what "
30933 #: ../src/guestfs.pod:395
30935 "If the command needs to communicate with daemons, then most likely they "
30936 "won't be running."
30940 #: ../src/guestfs.pod:400
30941 msgid "The command will be running in limited memory."
30945 #: ../src/guestfs.pod:404
30947 "The network may not be available unless you enable it (see "
30948 "L</guestfs_set_network>)."
30952 #: ../src/guestfs.pod:409
30953 msgid "Only supports Linux guests (not Windows, BSD, etc)."
30957 #: ../src/guestfs.pod:413
30958 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
30962 #: ../src/guestfs.pod:418
30964 "For SELinux guests, you may need to enable SELinux and load policy first. "
30965 "See L</SELINUX> in this manpage."
30969 #: ../src/guestfs.pod:423
30971 "I<Security:> It is not safe to run commands from untrusted, possibly "
30972 "malicious guests. These commands may attempt to exploit your program by "
30973 "sending unexpected output. They could also try to exploit the Linux kernel "
30974 "or qemu provided by the libguestfs appliance. They could use the network "
30975 "provided by the libguestfs appliance to bypass ordinary network partitions "
30976 "and firewalls. They could use the elevated privileges or different SELinux "
30977 "context of your program to their advantage."
30981 #: ../src/guestfs.pod:432
30983 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
30984 "(a script which runs when the guest next boots normally), and to have this "
30985 "script run the commands you want in the normal context of the running guest, "
30986 "network security and so on. For information about other security issues, "
30987 "see L</SECURITY>."
30991 #: ../src/guestfs.pod:440
30993 "The two main API calls to run commands are L</guestfs_command> and "
30994 "L</guestfs_sh> (there are also variations)."
30998 #: ../src/guestfs.pod:443
31000 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
31001 "shell globs, redirections, etc will work."
31005 #: ../src/guestfs.pod:446
31006 msgid "CONFIGURATION FILES"
31010 #: ../src/guestfs.pod:448
31012 "To read and write configuration files in Linux guest filesystems, we "
31013 "strongly recommend using Augeas. For example, Augeas understands how to "
31014 "read and write, say, a Linux shadow password file or X.org configuration "
31015 "file, and so avoids you having to write that code."
31019 #: ../src/guestfs.pod:453
31021 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
31022 "document Augeas itself here because there is excellent documentation on the "
31023 "L<http://augeas.net/> website."
31027 #: ../src/guestfs.pod:457
31029 "If you don't want to use Augeas (you fool!) then try calling "
31030 "L</guestfs_read_lines> to get the file as a list of lines which you can "
31035 #: ../src/guestfs.pod:461
31040 #: ../src/guestfs.pod:463
31042 "We support SELinux guests. To ensure that labeling happens correctly in "
31043 "SELinux guests, you need to enable SELinux and load the guest's policy:"
31047 #: ../src/guestfs.pod:471
31048 msgid "Before launching, do:"
31052 #: ../src/guestfs.pod:473
31055 " guestfs_set_selinux (g, 1);\n"
31060 #: ../src/guestfs.pod:477
31062 "After mounting the guest's filesystem(s), load the policy. This is best "
31063 "done by running the L<load_policy(8)> command in the guest itself:"
31067 #: ../src/guestfs.pod:481
31070 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
31075 #: ../src/guestfs.pod:483
31077 "(Older versions of C<load_policy> require you to specify the name of the "
31082 #: ../src/guestfs.pod:488
31084 "Optionally, set the security context for the API. The correct security "
31085 "context to use can only be known by inspecting the guest. As an example:"
31089 #: ../src/guestfs.pod:492
31092 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
31097 #: ../src/guestfs.pod:496
31098 msgid "This will work for running commands and editing existing files."
31102 #: ../src/guestfs.pod:498
31104 "When new files are created, you may need to label them explicitly, for "
31105 "example by running the external command C<restorecon pathname>."
31109 #: ../src/guestfs.pod:502
31114 #: ../src/guestfs.pod:504
31116 "Certain calls are affected by the current file mode creation mask (the "
31117 "\"umask\"). In particular ones which create files or directories, such as "
31118 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
31119 "either the default mode that the file is created with or modifies the mode "
31124 #: ../src/guestfs.pod:510
31126 "The default umask is C<022>, so files are created with modes such as C<0644> "
31127 "and directories with C<0755>."
31131 #: ../src/guestfs.pod:513
31133 "There are two ways to avoid being affected by umask. Either set umask to 0 "
31134 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
31135 "L</guestfs_chmod> after creating each file or directory."
31139 #: ../src/guestfs.pod:517
31140 msgid "For more information about umask, see L<umask(2)>."
31144 #: ../src/guestfs.pod:521
31146 "Libguestfs allows you to access Linux guests which have been encrypted using "
31147 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
31148 "standard. This includes nearly all whole disk encryption systems used by "
31149 "modern Linux guests."
31153 #: ../src/guestfs.pod:527
31155 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
31156 "returns the string C<crypto_LUKS>)."
31160 #: ../src/guestfs.pod:530
31162 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
31163 "will require the passphrase!"
31167 #: ../src/guestfs.pod:533
31169 "Opening a LUKS device creates a new device mapper device called "
31170 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
31171 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
31172 "decrypted from and encrypted to the underlying block device respectively."
31176 #: ../src/guestfs.pod:539
31178 "LVM volume groups on the device can be made visible by calling "
31179 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
31180 "volume(s) can now be mounted in the usual way."
31184 #: ../src/guestfs.pod:543
31186 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
31187 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
31188 "[\"/dev/VG\"])>. Then close the mapper device by calling "
31189 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
31190 "underlying encrypted block device)."
31194 #: ../src/guestfs.pod:550
31199 #: ../src/guestfs.pod:552
31201 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
31202 "contains operating systems, an install CD or a live CD. (These APIs used to "
31203 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
31204 "version 1.5.3 the most frequently used part of this library has been "
31205 "rewritten in C and moved into the core code)."
31209 #: ../src/guestfs.pod:559
31211 "Add all disks belonging to the unknown virtual machine and call "
31212 "L</guestfs_launch> in the usual way."
31216 #: ../src/guestfs.pod:562
31218 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
31219 "and certain heuristics, and returns a list of operating systems that were "
31220 "found. An empty list means none were found. A single element is the root "
31221 "filesystem of the operating system. For dual- or multi-boot guests, "
31222 "multiple roots can be returned, each one corresponding to a separate "
31223 "operating system. (Multi-boot virtual machines are extremely rare in the "
31224 "world of virtualization, but since this scenario can happen, we have built "
31225 "libguestfs to deal with it.)"
31229 #: ../src/guestfs.pod:571
31231 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
31232 "to get additional details about that operating system. For example, call "
31233 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
31234 "Windows and Linux-based operating systems respectively."
31238 #: ../src/guestfs.pod:577
31240 "Un*x-like and Linux-based operating systems usually consist of several "
31241 "filesystems which are mounted at boot time (for example, a separate boot "
31242 "partition mounted on C</boot>). The inspection rules are able to detect how "
31243 "filesystems correspond to mount points. Call "
31244 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
31245 "hash table like this example:"
31249 #: ../src/guestfs.pod:584
31252 " /boot => /dev/sda1\n"
31253 " / => /dev/vg_guest/lv_root\n"
31254 " /usr => /dev/vg_guest/lv_usr\n"
31259 #: ../src/guestfs.pod:588
31261 "The caller can then make calls to L</guestfs_mount_options> to mount the "
31262 "filesystems as suggested."
31266 #: ../src/guestfs.pod:591
31268 "Be careful to mount filesystems in the right order (eg. C</> before "
31269 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
31274 #: ../src/guestfs.pod:595
31276 "Inspection currently only works for some common operating systems. "
31277 "Contributors are welcome to send patches for other operating systems that we "
31278 "currently cannot detect."
31282 #: ../src/guestfs.pod:599
31284 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
31285 "for more details. The L</guestfs_inspect_os> function just ignores any "
31286 "encrypted devices."
31290 #: ../src/guestfs.pod:603
31292 "A note on the implementation: The call L</guestfs_inspect_os> performs "
31293 "inspection and caches the results in the guest handle. Subsequent calls to "
31294 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
31295 "re-read the disks. If you change the content of the guest disks, you can "
31296 "redo inspection by calling L</guestfs_inspect_os> again. "
31297 "(L</guestfs_inspect_list_applications> works a little differently from the "
31298 "other calls and does read the disks. See documentation for that function "
31303 #: ../src/guestfs.pod:612
31304 msgid "INSPECTING INSTALL DISKS"
31308 #: ../src/guestfs.pod:614
31310 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
31315 #: ../src/guestfs.pod:617
31317 "Call L</guestfs_inspect_get_format> to return the format of the operating "
31318 "system, which currently can be C<installed> (a regular operating system) or "
31319 "C<installer> (some sort of install disk)."
31323 #: ../src/guestfs.pod:621
31325 "Further information is available about the operating system that can be "
31326 "installed using the regular inspection APIs like "
31327 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
31332 #: ../src/guestfs.pod:626
31334 "Some additional information specific to installer disks is also available "
31335 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
31336 "L</guestfs_inspect_is_multipart> calls."
31340 #: ../src/guestfs.pod:631
31341 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
31345 #: ../src/guestfs.pod:633
31347 "Libguestfs can mount NTFS partitions. It does this using the "
31348 "L<http://www.ntfs-3g.org/> driver."
31352 #: ../src/guestfs.pod:636
31353 msgid "DRIVE LETTERS AND PATHS"
31357 #: ../src/guestfs.pod:638
31359 "DOS and Windows still use drive letters, and the filesystems are always "
31360 "treated as case insensitive by Windows itself, and therefore you might find "
31361 "a Windows configuration file referring to a path like "
31362 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
31363 "that directory might be referred to as C</WINDOWS/System32>."
31367 #: ../src/guestfs.pod:644
31369 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
31370 "L</guestfs_inspect_get_drive_mappings>)"
31374 #: ../src/guestfs.pod:647
31376 "Dealing with separator characters (backslash vs forward slash) is outside "
31377 "the scope of libguestfs, but usually a simple character replacement will "
31382 #: ../src/guestfs.pod:651
31384 "To resolve the case insensitivity of paths, call "
31385 "L</guestfs_case_sensitive_path>."
31389 #: ../src/guestfs.pod:654
31390 msgid "ACCESSING THE WINDOWS REGISTRY"
31394 #: ../src/guestfs.pod:656
31396 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
31397 "files, through the library C<hivex> which is part of the libguestfs project "
31398 "although ships as a separate tarball. You have to locate and download the "
31399 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
31400 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
31401 "L<virt-win-reg(1)> for more help on this issue."
31405 #: ../src/guestfs.pod:664
31406 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
31410 #: ../src/guestfs.pod:666
31412 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
31413 "provide something which looks like a Linux symlink. The way it tries to do "
31414 "the rewriting is described here:"
31418 #: ../src/guestfs.pod:670
31419 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
31423 #: ../src/guestfs.pod:672
31425 "The essential problem is that ntfs-3g simply does not have enough "
31426 "information to do a correct job. NTFS links can contain drive letters and "
31427 "references to external device GUIDs that ntfs-3g has no way of resolving. "
31428 "It is almost certainly the case that libguestfs callers should ignore what "
31429 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
31433 #: ../src/guestfs.pod:679
31435 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
31436 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
31437 "attribute, and read the raw reparse data from that (you can find the format "
31438 "documented in various places around the web)."
31442 #: ../src/guestfs.pod:684
31443 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
31447 #: ../src/guestfs.pod:686
31449 "There are other useful extended attributes that can be read from ntfs-3g "
31450 "filesystems (using L</guestfs_getxattr>). See:"
31454 #: ../src/guestfs.pod:689
31455 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
31459 #: ../src/guestfs.pod:691
31460 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
31464 #: ../src/guestfs.pod:693
31466 "Although we don't want to discourage you from using the C API, we will "
31467 "mention here that the same API is also available in other languages."
31471 #: ../src/guestfs.pod:696
31473 "The API is broadly identical in all supported languages. This means that "
31474 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
31475 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
31476 "OCaml. In other words, a straightforward, predictable isomorphism between "
31481 #: ../src/guestfs.pod:702
31483 "Error messages are automatically transformed into exceptions if the language "
31488 #: ../src/guestfs.pod:705
31490 "We don't try to \"object orientify\" parts of the API in OO languages, "
31491 "although contributors are welcome to write higher level APIs above what we "
31492 "provide in their favourite languages if they wish."
31496 #: ../src/guestfs.pod:711
31501 #: ../src/guestfs.pod:713
31503 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
31504 "identical to the C API. C++ classes and exceptions are not used."
31508 #: ../src/guestfs.pod:717
31513 #: ../src/guestfs.pod:719
31515 "The C# bindings are highly experimental. Please read the warnings at the "
31516 "top of C<csharp/Libguestfs.cs>."
31520 #: ../src/guestfs.pod:722
31525 #: ../src/guestfs.pod:724
31527 "This is the only language binding that is working but incomplete. Only "
31528 "calls which return simple integers have been bound in Haskell, and we are "
31529 "looking for help to complete this binding."
31533 #: ../src/guestfs.pod:728
31538 #: ../src/guestfs.pod:730
31540 "Full documentation is contained in the Javadoc which is distributed with "
31541 "libguestfs. For examples, see L<guestfs-java(3)>."
31545 #: ../src/guestfs.pod:733
31550 #: ../src/guestfs.pod:735
31551 msgid "See L<guestfs-ocaml(3)>."
31555 #: ../src/guestfs.pod:737
31560 #: ../src/guestfs.pod:739
31561 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
31565 #: ../src/guestfs.pod:741
31570 #: ../src/guestfs.pod:743
31572 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
31573 "the php-libguestfs package for your distribution."
31577 #: ../src/guestfs.pod:746
31578 msgid "The PHP binding only works correctly on 64 bit machines."
31582 #: ../src/guestfs.pod:748
31587 #: ../src/guestfs.pod:750
31588 msgid "See L<guestfs-python(3)>."
31592 #: ../src/guestfs.pod:752
31597 #: ../src/guestfs.pod:754
31598 msgid "See L<guestfs-ruby(3)>."
31602 #: ../src/guestfs.pod:756
31603 msgid "B<shell scripts>"
31607 #: ../src/guestfs.pod:758
31608 msgid "See L<guestfish(1)>."
31612 #: ../src/guestfs.pod:762
31613 msgid "LIBGUESTFS GOTCHAS"
31617 #: ../src/guestfs.pod:764
31619 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
31620 "system [...] that works in the way it is documented but is counterintuitive "
31621 "and almost invites mistakes.\""
31625 #: ../src/guestfs.pod:768
31627 "Since we developed libguestfs and the associated tools, there are several "
31628 "things we would have designed differently, but are now stuck with for "
31629 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
31630 "release, you can expect these to change. Beware of them."
31634 #: ../src/guestfs.pod:776
31635 msgid "Autosync / forgetting to sync."
31639 #: ../src/guestfs.pod:778
31641 "I<Update:> Autosync is enabled by default for all API users starting from "
31642 "libguestfs 1.5.24. This section only applies to older versions."
31646 #: ../src/guestfs.pod:781
31648 "When modifying a filesystem from C or another language, you B<must> unmount "
31649 "all filesystems and call L</guestfs_sync> explicitly before you close the "
31650 "libguestfs handle. You can also call:"
31654 #: ../src/guestfs.pod:785
31657 " guestfs_set_autosync (g, 1);\n"
31662 #: ../src/guestfs.pod:787
31664 "to have the unmount/sync done automatically for you when the handle 'g' is "
31665 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
31670 #: ../src/guestfs.pod:791
31672 "If you forget to do this, then it is entirely possible that your changes "
31673 "won't be written out, or will be partially written, or (very rarely) that "
31674 "you'll get disk corruption."
31678 #: ../src/guestfs.pod:795
31680 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
31681 "guestfish scripts that forget to sync will work just fine, which can make "
31682 "this very puzzling if you are trying to debug a problem."
31686 #: ../src/guestfs.pod:799
31687 msgid "Mount option C<-o sync> should not be the default."
31691 #: ../src/guestfs.pod:801
31693 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
31694 "However C<-o sync> does not add any reliability benefit, but does have a "
31695 "very large performance impact."
31699 #: ../src/guestfs.pod:805
31701 "The work around is to use L</guestfs_mount_options> and set the mount "
31702 "options that you actually want to use."
31706 #: ../src/guestfs.pod:808
31707 msgid "Read-only should be the default."
31711 #: ../src/guestfs.pod:810
31713 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
31714 "specify I<--rw> if you want to make changes to the image."
31718 #: ../src/guestfs.pod:813
31719 msgid "This would reduce the potential to corrupt live VM images."
31723 #: ../src/guestfs.pod:815
31725 "Note that many filesystems change the disk when you just mount and unmount, "
31726 "even if you didn't perform any writes. You need to use "
31727 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
31731 #: ../src/guestfs.pod:819
31732 msgid "guestfish command line is hard to use."
31736 #: ../src/guestfs.pod:821
31738 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
31739 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
31740 "exist, so it fails. In earlier versions of guestfish the error message was "
31741 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
31742 "we should have used C<guestfish -c command> to run commands."
31746 #: ../src/guestfs.pod:828
31747 msgid "guestfish megabyte modifiers don't work right on all commands"
31751 #: ../src/guestfs.pod:830
31753 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
31754 "other modifiers). What guestfish actually does is to multiply the number "
31755 "part by the modifier part and pass the result to the C API. However this "
31756 "doesn't work for a few APIs which aren't expecting bytes, but are already "
31757 "expecting some other unit (eg. megabytes)."
31761 #: ../src/guestfs.pod:837
31762 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
31766 #: ../src/guestfs.pod:839
31769 " lvcreate LV VG 100M\n"
31774 #: ../src/guestfs.pod:841
31776 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
31777 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
31778 "megabytes * megabytes) logical volume. The error message you get from this "
31779 "is also a little obscure."
31783 #: ../src/guestfs.pod:846
31785 "This could be fixed in the generator by specially marking parameters and "
31786 "return values which take bytes or other units."
31790 #: ../src/guestfs.pod:849
31791 msgid "Ambiguity between devices and paths"
31795 #: ../src/guestfs.pod:851
31797 "There is a subtle ambiguity in the API between a device name "
31798 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
31799 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
31803 #: ../src/guestfs.pod:856
31805 "In the current API we usually resolve this ambiguity by having two separate "
31806 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
31807 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
31808 "detecting if the path supplied begins with C</dev/>."
31812 #: ../src/guestfs.pod:862
31814 "To avoid both the ambiguity and the need to duplicate some calls, we could "
31815 "make paths/devices into structured names. One way to do this would be to "
31816 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
31817 "aspect of grub. Another way would be to use a structured type, equivalent "
31818 "to this OCaml type:"
31822 #: ../src/guestfs.pod:868
31825 " type path = Path of string | Device of int | Partition of int * int\n"
31830 #: ../src/guestfs.pod:870
31831 msgid "which would allow you to pass arguments like:"
31835 #: ../src/guestfs.pod:872
31838 " Path \"/foo/bar\"\n"
31839 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
31840 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
31841 " Path \"/dev/sdb2\" (* not a device *)\n"
31846 #: ../src/guestfs.pod:877
31848 "As you can see there are still problems to resolve even with this "
31849 "representation. Also consider how it might work in guestfish."
31853 #: ../src/guestfs.pod:882
31854 msgid "KEYS AND PASSPHRASES"
31858 #: ../src/guestfs.pod:884
31860 "Certain libguestfs calls take a parameter that contains sensitive key "
31861 "material, passed in as a C string."
31865 #: ../src/guestfs.pod:887
31867 "In the future we would hope to change the libguestfs implementation so that "
31868 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
31869 "swap. However this is I<not> done at the moment, because of the complexity "
31870 "of such an implementation."
31874 #: ../src/guestfs.pod:892
31876 "Therefore you should be aware that any key parameter you pass to libguestfs "
31877 "might end up being written out to the swap partition. If this is a concern, "
31878 "scrub the swap partition or don't use libguestfs on encrypted devices."
31882 #: ../src/guestfs.pod:897
31883 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
31887 #: ../src/guestfs.pod:899
31889 "All high-level libguestfs actions are synchronous. If you want to use "
31890 "libguestfs asynchronously then you must create a thread."
31894 #: ../src/guestfs.pod:902
31896 "Only use the handle from a single thread. Either use the handle exclusively "
31897 "from one thread, or provide your own mutex so that two threads cannot issue "
31898 "calls on the same handle at the same time."
31902 #: ../src/guestfs.pod:906
31904 "See the graphical program guestfs-browser for one possible architecture for "
31905 "multithreaded programs using libvirt and libguestfs."
31909 #: ../src/guestfs.pod:909
31914 #: ../src/guestfs.pod:911
31916 "Libguestfs needs a supermin appliance, which it finds by looking along an "
31921 #: ../src/guestfs.pod:914
31923 "By default it looks for these in the directory C<$libdir/guestfs> "
31924 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
31928 #: ../src/guestfs.pod:917
31930 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
31931 "to change the directories that libguestfs will search in. The value is a "
31932 "colon-separated list of paths. The current directory is I<not> searched "
31933 "unless the path contains an empty element or C<.>. For example "
31934 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
31935 "then C</usr/lib/guestfs>."
31939 #: ../src/guestfs.pod:924
31940 msgid "QEMU WRAPPERS"
31944 #: ../src/guestfs.pod:926
31946 "If you want to compile your own qemu, run qemu from a non-standard location, "
31947 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
31952 #: ../src/guestfs.pod:930
31954 "There is one important rule to remember: you I<must C<exec qemu>> as the "
31955 "last command in the shell script (so that qemu replaces the shell and "
31956 "becomes the direct child of the libguestfs-using program). If you don't do "
31957 "this, then the qemu process won't be cleaned up correctly."
31961 #: ../src/guestfs.pod:935
31963 "Here is an example of a wrapper, where I have built my own copy of qemu from "
31968 #: ../src/guestfs.pod:938
31972 " qemudir=/home/rjones/d/qemu\n"
31973 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
31979 #: ../src/guestfs.pod:942
31981 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
31982 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
31987 #: ../src/guestfs.pod:946
31990 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
31995 #: ../src/guestfs.pod:948
31997 "Note that libguestfs also calls qemu with the -help and -version options in "
31998 "order to determine features."
32002 #: ../src/guestfs.pod:951
32004 "Wrappers can also be used to edit the options passed to qemu. In the "
32005 "following example, the C<-machine ...> option (C<-machine> and the following "
32006 "argument) are removed from the command line and replaced with C<-machine "
32007 "pc,accel=tcg>. The while loop iterates over the options until it finds the "
32008 "right one to remove, putting the remaining options into the C<args> array."
32012 #: ../src/guestfs.pod:960
32016 " while [ $# -gt 0 ]; do\n"
32017 " case \"$1\" in\n"
32021 " args[i]=\"$1\"\n"
32030 #: ../src/guestfs.pod:972
32033 " exec qemu-kvm -machine pc,accel=tcg \"${args[@]}\"\n"
32038 #: ../src/guestfs.pod:974
32039 msgid "ATTACHING TO RUNNING DAEMONS"
32043 #: ../src/guestfs.pod:976
32045 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
32046 "babies. Use with caution."
32050 #: ../src/guestfs.pod:979
32052 "I<Note (2):> This section explains how to attach to a running daemon from a "
32053 "low level perspective. For most users, simply using virt tools such as "
32054 "L<guestfish(1)> with the I<--live> option will \"just work\"."
32058 #: ../src/guestfs.pod:983
32059 msgid "Using guestfs_set_attach_method"
32063 #: ../src/guestfs.pod:985
32065 "By calling L</guestfs_set_attach_method> you can change how the library "
32066 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
32067 "L</ARCHITECTURE> for some background)."
32071 #: ../src/guestfs.pod:989
32073 "The normal attach method is C<appliance>, where a small appliance is created "
32074 "containing the daemon, and then the library connects to this."
32078 #: ../src/guestfs.pod:992
32080 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
32081 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
32082 "daemon over the Unix domain socket."
32086 #: ../src/guestfs.pod:996
32088 "The normal use for this is to connect to a running virtual machine that "
32089 "contains a C<guestfsd> daemon, and send commands so you can read and write "
32090 "files inside the live virtual machine."
32094 #: ../src/guestfs.pod:1000
32095 msgid "Using guestfs_add_domain with live flag"
32099 #: ../src/guestfs.pod:1002
32101 "L</guestfs_add_domain> provides some help for getting the correct attach "
32102 "method. If you pass the C<live> option to this function, then (if the "
32103 "virtual machine is running) it will examine the libvirt XML looking for a "
32104 "virtio-serial channel to connect to:"
32108 #: ../src/guestfs.pod:1008
32115 " <channel type='unix'>\n"
32116 " <source mode='bind' path='/path/to/socket'/>\n"
32117 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
32126 #: ../src/guestfs.pod:1020
32128 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
32129 "method to C<unix:/path/to/socket>."
32133 #: ../src/guestfs.pod:1023
32135 "Some of the libguestfs tools (including guestfish) support a I<--live> "
32136 "option which is passed through to L</guestfs_add_domain> thus allowing you "
32137 "to attach to and modify live virtual machines."
32141 #: ../src/guestfs.pod:1027
32143 "The virtual machine needs to have been set up beforehand so that it has the "
32144 "virtio-serial channel and so that guestfsd is running inside it."
32148 #: ../src/guestfs.pod:1031
32149 msgid "ABI GUARANTEE"
32153 #: ../src/guestfs.pod:1033
32155 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
32156 "actions as outlined in this section. Although we will deprecate some "
32157 "actions, for example if they get replaced by newer calls, we will keep the "
32158 "old actions forever. This allows you the developer to program in confidence "
32159 "against the libguestfs API."
32163 #: ../src/guestfs.pod:1039
32164 msgid "BLOCK DEVICE NAMING"
32168 #: ../src/guestfs.pod:1041
32170 "In the kernel there is now quite a profusion of schemata for naming block "
32171 "devices (in this context, by I<block device> I mean a physical or virtual "
32172 "hard drive). The original Linux IDE driver used names starting with "
32173 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
32174 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
32175 "replacement for the old IDE driver (particularly for SATA devices) those "
32176 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
32177 "machines with paravirtualized drivers. This has created several different "
32178 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
32183 #: ../src/guestfs.pod:1053
32185 "As discussed above, libguestfs uses a qemu appliance running an embedded "
32186 "Linux kernel to access block devices. We can run a variety of appliances "
32187 "based on a variety of Linux kernels."
32191 #: ../src/guestfs.pod:1057
32193 "This causes a problem for libguestfs because many API calls use device or "
32194 "partition names. Working scripts and the recipe (example) scripts that we "
32195 "make available over the internet could fail if the naming scheme changes."
32199 #: ../src/guestfs.pod:1062
32201 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
32202 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
32203 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
32204 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
32208 #: ../src/guestfs.pod:1068
32210 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
32211 "L</guestfs_list_partitions> and similar calls return the true names of the "
32212 "devices and partitions as known to the appliance."
32216 #: ../src/guestfs.pod:1073
32217 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
32221 #: ../src/guestfs.pod:1075
32223 "Usually this translation is transparent. However in some (very rare) cases "
32224 "you may need to know the exact algorithm. Such cases include where you use "
32225 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
32226 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
32231 #: ../src/guestfs.pod:1081
32233 "The algorithm is applied only to I<parameters> which are known to be either "
32234 "device or partition names. Return values from functions such as "
32235 "L</guestfs_list_devices> are never changed."
32239 #: ../src/guestfs.pod:1089
32240 msgid "Is the string a parameter which is a device or partition name?"
32244 #: ../src/guestfs.pod:1093
32245 msgid "Does the string begin with C</dev/sd>?"
32249 #: ../src/guestfs.pod:1097
32251 "Does the named device exist? If so, we use that device. However if I<not> "
32252 "then we continue with this algorithm."
32256 #: ../src/guestfs.pod:1102
32257 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
32261 #: ../src/guestfs.pod:1104
32262 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
32266 #: ../src/guestfs.pod:1106
32267 msgid "If that named device exists, use it. If not, continue."
32271 #: ../src/guestfs.pod:1110
32272 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
32276 #: ../src/guestfs.pod:1112
32277 msgid "If that named device exists, use it. If not, return an error."
32281 #: ../src/guestfs.pod:1116
32282 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
32286 #: ../src/guestfs.pod:1118
32288 "Although the standard naming scheme and automatic translation is useful for "
32289 "simple programs and guestfish scripts, for larger programs it is best not to "
32290 "rely on this mechanism."
32294 #: ../src/guestfs.pod:1122
32296 "Where possible for maximum future portability programs using libguestfs "
32297 "should use these future-proof techniques:"
32301 #: ../src/guestfs.pod:1129
32303 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
32304 "device names, and then use those names directly."
32308 #: ../src/guestfs.pod:1132
32309 msgid "Since those device names exist by definition, they will never be translated."
32313 #: ../src/guestfs.pod:1137
32315 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
32316 "filesystem labels."
32320 #: ../src/guestfs.pod:1142
32325 #: ../src/guestfs.pod:1144
32327 "This section discusses security implications of using libguestfs, "
32328 "particularly with untrusted or malicious guests or disk images."
32332 #: ../src/guestfs.pod:1147
32333 msgid "GENERAL SECURITY CONSIDERATIONS"
32337 #: ../src/guestfs.pod:1149
32339 "Be careful with any files or data that you download from a guest (by "
32340 "\"download\" we mean not just the L</guestfs_download> command but any "
32341 "command that reads files, filenames, directories or anything else from a "
32342 "disk image). An attacker could manipulate the data to fool your program "
32343 "into doing the wrong thing. Consider cases such as:"
32347 #: ../src/guestfs.pod:1159
32348 msgid "the data (file etc) not being present"
32352 #: ../src/guestfs.pod:1163
32353 msgid "being present but empty"
32357 #: ../src/guestfs.pod:1167
32358 msgid "being much larger than normal"
32362 #: ../src/guestfs.pod:1171
32363 msgid "containing arbitrary 8 bit data"
32367 #: ../src/guestfs.pod:1175
32368 msgid "being in an unexpected character encoding"
32372 #: ../src/guestfs.pod:1179
32373 msgid "containing homoglyphs."
32377 #: ../src/guestfs.pod:1183
32378 msgid "SECURITY OF MOUNTING FILESYSTEMS"
32382 #: ../src/guestfs.pod:1185
32384 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
32385 "(VFS) module can sometimes be escalated into exploits by deliberately "
32386 "creating a malicious, malformed filesystem. These exploits are very severe "
32387 "for two reasons. Firstly there are very many filesystem drivers in the "
32388 "kernel, and many of them are infrequently used and not much developer "
32389 "attention has been paid to the code. Linux userspace helps potential "
32390 "crackers by detecting the filesystem type and automatically choosing the "
32391 "right VFS driver, even if that filesystem type is obscure or unexpected for "
32392 "the administrator. Secondly, a kernel-level exploit is like a local root "
32393 "exploit (worse in some ways), giving immediate and total access to the "
32394 "system right down to the hardware level."
32398 #: ../src/guestfs.pod:1198
32400 "That explains why you should never mount a filesystem from an untrusted "
32401 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
32402 "inside a qemu virtual machine, usually running as a non-root user. The "
32403 "attacker would need to write a filesystem which first exploited the kernel, "
32404 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
32405 "the libguestfs protocol, and finally to be as serious as the host kernel "
32406 "exploit it would need to escalate its privileges to root. This multi-step "
32407 "escalation, performed by a static piece of data, is thought to be extremely "
32408 "hard to do, although we never say 'never' about security issues."
32412 #: ../src/guestfs.pod:1209
32414 "In any case callers can reduce the attack surface by forcing the filesystem "
32415 "type when mounting (use L</guestfs_mount_vfs>)."
32419 #: ../src/guestfs.pod:1212
32420 msgid "PROTOCOL SECURITY"
32424 #: ../src/guestfs.pod:1214
32426 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
32427 "defined upper message size. However a program that uses libguestfs must "
32428 "also take care - for example you can write a program that downloads a binary "
32429 "from a disk image and executes it locally, and no amount of protocol "
32430 "security will save you from the consequences."
32434 #: ../src/guestfs.pod:1220
32435 msgid "INSPECTION SECURITY"
32439 #: ../src/guestfs.pod:1222
32441 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
32442 "directly from the guest, and these could contain any 8 bit data. Callers "
32443 "should be careful to escape these before printing them to a structured file "
32444 "(for example, use HTML escaping if creating a web page)."
32448 #: ../src/guestfs.pod:1228
32450 "Guest configuration may be altered in unusual ways by the administrator of "
32451 "the virtual machine, and may not reflect reality (particularly for untrusted "
32452 "or actively malicious guests). For example we parse the hostname from "
32453 "configuration files like C</etc/sysconfig/network> that we find in the "
32454 "guest, but the guest administrator can easily manipulate these files to "
32455 "provide the wrong hostname."
32459 #: ../src/guestfs.pod:1236
32461 "The inspection API parses guest configuration using two external libraries: "
32462 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
32463 "designed to be robust in the face of malicious data, although denial of "
32464 "service attacks are still possible, for example with oversized configuration "
32469 #: ../src/guestfs.pod:1242
32470 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
32474 #: ../src/guestfs.pod:1244
32476 "Be very cautious about running commands from the guest. By running a "
32477 "command in the guest, you are giving CPU time to a binary that you do not "
32478 "control, under the same user account as the library, albeit wrapped in qemu "
32479 "virtualization. More information and alternatives can be found in the "
32480 "section L</RUNNING COMMANDS>."
32484 #: ../src/guestfs.pod:1250
32485 msgid "CVE-2010-3851"
32489 #: ../src/guestfs.pod:1252
32490 msgid "https://bugzilla.redhat.com/642934"
32494 #: ../src/guestfs.pod:1254
32496 "This security bug concerns the automatic disk format detection that qemu "
32497 "does on disk images."
32501 #: ../src/guestfs.pod:1257
32503 "A raw disk image is just the raw bytes, there is no header. Other disk "
32504 "images like qcow2 contain a special header. Qemu deals with this by looking "
32505 "for one of the known headers, and if none is found then assuming the disk "
32506 "image must be raw."
32510 #: ../src/guestfs.pod:1262
32512 "This allows a guest which has been given a raw disk image to write some "
32513 "other header. At next boot (or when the disk image is accessed by "
32514 "libguestfs) qemu would do autodetection and think the disk image format was, "
32515 "say, qcow2 based on the header written by the guest."
32519 #: ../src/guestfs.pod:1267
32521 "This in itself would not be a problem, but qcow2 offers many features, one "
32522 "of which is to allow a disk image to refer to another image (called the "
32523 "\"backing disk\"). It does this by placing the path to the backing disk "
32524 "into the qcow2 header. This path is not validated and could point to any "
32525 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
32526 "\"holes\" in the qcow2 disk image, which of course is completely under the "
32527 "control of the attacker."
32531 #: ../src/guestfs.pod:1275
32532 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
32536 #: ../src/guestfs.pod:1282
32537 msgid "You have enabled the network or have opened the disk in write mode."
32541 #: ../src/guestfs.pod:1286
32543 "You are also running untrusted code from the guest (see L</RUNNING "
32548 #: ../src/guestfs.pod:1291
32550 "The way to avoid this is to specify the expected disk format when adding "
32551 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
32552 "should always do this if the disk is raw format, and it's a good idea for "
32557 #: ../src/guestfs.pod:1296
32559 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
32560 "format is fetched from libvirt and passed through."
32564 #: ../src/guestfs.pod:1299
32566 "For libguestfs tools, use the I<--format> command line parameter as "
32571 #: ../src/guestfs.pod:1302
32572 msgid "CONNECTION MANAGEMENT"
32576 #: ../src/guestfs.pod:1304
32577 msgid "guestfs_h *"
32581 #: ../src/guestfs.pod:1306
32583 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
32584 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
32585 "handle and release all resources used."
32589 #: ../src/guestfs.pod:1310
32591 "For information on using multiple handles and threads, see the section "
32592 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> above."
32596 #: ../src/guestfs.pod:1313
32597 msgid "guestfs_create"
32601 #: ../src/guestfs.pod:1315
32604 " guestfs_h *guestfs_create (void);\n"
32609 #: ../src/guestfs.pod:1317
32610 msgid "Create a connection handle."
32614 #: ../src/guestfs.pod:1319
32616 "On success this returns a non-NULL pointer to a handle. On error it returns "
32621 #: ../src/guestfs.pod:1322
32623 "You have to \"configure\" the handle after creating it. This includes "
32624 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
32625 "handle at least once."
32629 #: ../src/guestfs.pod:1326
32630 msgid "After configuring the handle, you have to call L</guestfs_launch>."
32634 #: ../src/guestfs.pod:1328
32636 "You may also want to configure error handling for the handle. See the "
32637 "L</ERROR HANDLING> section below."
32641 #: ../src/guestfs.pod:1331
32642 msgid "guestfs_close"
32646 #: ../src/guestfs.pod:1333
32649 " void guestfs_close (guestfs_h *g);\n"
32654 #: ../src/guestfs.pod:1335
32655 msgid "This closes the connection handle and frees up all resources used."
32659 #: ../src/guestfs.pod:1337
32661 "If autosync was set on the handle and the handle was launched, then this "
32662 "implicitly calls various functions to unmount filesystems and sync the "
32663 "disk. See L</guestfs_set_autosync> for more details."
32667 #: ../src/guestfs.pod:1341
32668 msgid "If a close callback was set on the handle, then it is called."
32672 #: ../src/guestfs.pod:1343
32673 msgid "ERROR HANDLING"
32677 #: ../src/guestfs.pod:1345
32679 "API functions can return errors. For example, almost all functions that "
32680 "return C<int> will return C<-1> to indicate an error."
32684 #: ../src/guestfs.pod:1348
32686 "Additional information is available for errors: an error message string and "
32687 "optionally an error number (errno) if the thing that failed was a system "
32692 #: ../src/guestfs.pod:1352
32694 "You can get at the additional information about the last error on the handle "
32695 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
32696 "up an error handler with L</guestfs_set_error_handler>."
32700 #: ../src/guestfs.pod:1357
32702 "When the handle is created, a default error handler is installed which "
32703 "prints the error message string to C<stderr>. For small short-running "
32704 "command line programs it is sufficient to do:"
32708 #: ../src/guestfs.pod:1361
32711 " if (guestfs_launch (g) == -1)\n"
32712 " exit (EXIT_FAILURE);\n"
32717 #: ../src/guestfs.pod:1364
32719 "since the default error handler will ensure that an error message has been "
32720 "printed to C<stderr> before the program exits."
32724 #: ../src/guestfs.pod:1367
32726 "For other programs the caller will almost certainly want to install an "
32727 "alternate error handler or do error handling in-line like this:"
32731 #: ../src/guestfs.pod:1370
32734 " g = guestfs_create ();\n"
32739 #: ../src/guestfs.pod:1372
32742 " /* This disables the default behaviour of printing errors\n"
32744 " guestfs_set_error_handler (g, NULL, NULL);\n"
32749 #: ../src/guestfs.pod:1376
32752 " if (guestfs_launch (g) == -1) {\n"
32753 " /* Examine the error message and print it etc. */\n"
32754 " char *msg = guestfs_last_error (g);\n"
32755 " int errnum = guestfs_last_errno (g);\n"
32756 " fprintf (stderr, \"%s\\n\", msg);\n"
32763 #: ../src/guestfs.pod:1384
32765 "Out of memory errors are handled differently. The default action is to call "
32766 "L<abort(3)>. If this is undesirable, then you can set a handler using "
32767 "L</guestfs_set_out_of_memory_handler>."
32771 #: ../src/guestfs.pod:1388
32773 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
32774 "because there is no handle if this happens there is no way to get additional "
32775 "error information. However L</guestfs_create> is supposed to be a "
32776 "lightweight operation which can only fail because of insufficient memory (it "
32777 "returns NULL in this case)."
32781 #: ../src/guestfs.pod:1394
32782 msgid "guestfs_last_error"
32786 #: ../src/guestfs.pod:1396
32789 " const char *guestfs_last_error (guestfs_h *g);\n"
32794 #: ../src/guestfs.pod:1398
32796 "This returns the last error message that happened on C<g>. If there has not "
32797 "been an error since the handle was created, then this returns C<NULL>."
32801 #: ../src/guestfs.pod:1402
32803 "The lifetime of the returned string is until the next error occurs, or "
32804 "L</guestfs_close> is called."
32808 #: ../src/guestfs.pod:1405
32809 msgid "guestfs_last_errno"
32813 #: ../src/guestfs.pod:1407
32816 " int guestfs_last_errno (guestfs_h *g);\n"
32821 #: ../src/guestfs.pod:1409
32822 msgid "This returns the last error number (errno) that happened on C<g>."
32826 #: ../src/guestfs.pod:1411
32827 msgid "If successful, an errno integer not equal to zero is returned."
32831 #: ../src/guestfs.pod:1413
32832 msgid "If no error, this returns 0. This call can return 0 in three situations:"
32836 #: ../src/guestfs.pod:1420
32837 msgid "There has not been any error on the handle."
32841 #: ../src/guestfs.pod:1424
32843 "There has been an error but the errno was meaningless. This corresponds to "
32844 "the case where the error did not come from a failed system call, but for "
32845 "some other reason."
32849 #: ../src/guestfs.pod:1430
32851 "There was an error from a failed system call, but for some reason the errno "
32852 "was not captured and returned. This usually indicates a bug in libguestfs."
32856 #: ../src/guestfs.pod:1436
32858 "Libguestfs tries to convert the errno from inside the applicance into a "
32859 "corresponding errno for the caller (not entirely trivial: the appliance "
32860 "might be running a completely different operating system from the library "
32861 "and error numbers are not standardized across Un*xen). If this could not be "
32862 "done, then the error is translated to C<EINVAL>. In practice this should "
32863 "only happen in very rare circumstances."
32867 #: ../src/guestfs.pod:1444
32868 msgid "guestfs_set_error_handler"
32872 #: ../src/guestfs.pod:1446
32875 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
32877 " const char *msg);\n"
32878 " void guestfs_set_error_handler (guestfs_h *g,\n"
32879 " guestfs_error_handler_cb cb,\n"
32880 " void *opaque);\n"
32885 #: ../src/guestfs.pod:1453
32887 "The callback C<cb> will be called if there is an error. The parameters "
32888 "passed to the callback are an opaque data pointer and the error message "
32893 #: ../src/guestfs.pod:1457
32895 "C<errno> is not passed to the callback. To get that the callback must call "
32896 "L</guestfs_last_errno>."
32900 #: ../src/guestfs.pod:1460
32902 "Note that the message string C<msg> is freed as soon as the callback "
32903 "function returns, so if you want to stash it somewhere you must make your "
32908 #: ../src/guestfs.pod:1464
32909 msgid "The default handler prints messages on C<stderr>."
32913 #: ../src/guestfs.pod:1466
32914 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
32918 #: ../src/guestfs.pod:1468
32919 msgid "guestfs_get_error_handler"
32923 #: ../src/guestfs.pod:1470
32926 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
32927 " void **opaque_rtn);\n"
32932 #: ../src/guestfs.pod:1473
32933 msgid "Returns the current error handler callback."
32937 #: ../src/guestfs.pod:1475
32938 msgid "guestfs_set_out_of_memory_handler"
32942 #: ../src/guestfs.pod:1477
32945 " typedef void (*guestfs_abort_cb) (void);\n"
32946 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
32947 " guestfs_abort_cb);\n"
32952 #: ../src/guestfs.pod:1481
32954 "The callback C<cb> will be called if there is an out of memory situation. "
32955 "I<Note this callback must not return>."
32959 #: ../src/guestfs.pod:1484
32960 msgid "The default is to call L<abort(3)>."
32964 #: ../src/guestfs.pod:1486
32965 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
32969 #: ../src/guestfs.pod:1489
32970 msgid "guestfs_get_out_of_memory_handler"
32974 #: ../src/guestfs.pod:1491
32977 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
32982 #: ../src/guestfs.pod:1493
32983 msgid "This returns the current out of memory handler."
32987 #: ../src/guestfs.pod:1495
32992 #: ../src/guestfs.pod:1499
32997 #: ../src/guestfs.pod:1501
33002 #: ../src/guestfs.pod:1503
33003 msgid "AVAILABILITY"
33007 #: ../src/guestfs.pod:1505
33008 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
33012 #: ../src/guestfs.pod:1507
33014 "Using L</guestfs_available> you can test availability of the following "
33015 "groups of functions. This test queries the appliance to see if the "
33016 "appliance you are currently using supports the functionality."
33020 #: ../src/guestfs.pod:1512
33021 msgid "@AVAILABILITY@"
33025 #: ../src/guestfs.pod:1514
33026 msgid "GUESTFISH supported COMMAND"
33030 #: ../src/guestfs.pod:1516
33032 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
33033 "prints out the available groups and whether they are supported by this build "
33034 "of libguestfs. Note however that you have to do C<run> first."
33038 #: ../src/guestfs.pod:1521
33039 msgid "SINGLE CALLS AT COMPILE TIME"
33043 #: ../src/guestfs.pod:1523
33045 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
33046 "function, such as:"
33050 #: ../src/guestfs.pod:1526
33053 " #define LIBGUESTFS_HAVE_DD 1\n"
33058 #: ../src/guestfs.pod:1528
33059 msgid "if L</guestfs_dd> is available."
33063 #: ../src/guestfs.pod:1530
33065 "Before version 1.5.8, if you needed to test whether a single libguestfs "
33066 "function is available at compile time, we recommended using build tools such "
33067 "as autoconf or cmake. For example in autotools you could use:"
33071 #: ../src/guestfs.pod:1535
33074 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
33075 " AC_CHECK_FUNCS([guestfs_dd])\n"
33080 #: ../src/guestfs.pod:1538
33082 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
33087 #: ../src/guestfs.pod:1541
33088 msgid "SINGLE CALLS AT RUN TIME"
33092 #: ../src/guestfs.pod:1543
33094 "Testing at compile time doesn't guarantee that a function really exists in "
33095 "the library. The reason is that you might be dynamically linked against a "
33096 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
33097 "This situation unfortunately results in a segmentation fault, which is a "
33098 "shortcoming of the C dynamic linking system itself."
33102 #: ../src/guestfs.pod:1550
33104 "You can use L<dlopen(3)> to test if a function is available at run time, as "
33105 "in this example program (note that you still need the compile time check as "
33110 #: ../src/guestfs.pod:1554
33113 " #include <stdio.h>\n"
33114 " #include <stdlib.h>\n"
33115 " #include <unistd.h>\n"
33116 " #include <dlfcn.h>\n"
33117 " #include <guestfs.h>\n"
33122 #: ../src/guestfs.pod:1560
33127 " #ifdef LIBGUESTFS_HAVE_DD\n"
33129 " int has_function;\n"
33134 #: ../src/guestfs.pod:1566
33137 " /* Test if the function guestfs_dd is really available. */\n"
33138 " dl = dlopen (NULL, RTLD_LAZY);\n"
33140 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
33141 " exit (EXIT_FAILURE);\n"
33143 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
33149 #: ../src/guestfs.pod:1575
33152 " if (!has_function)\n"
33153 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
33155 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
33156 " /* Now it's safe to call\n"
33157 " guestfs_dd (g, \"foo\", \"bar\");\n"
33161 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
33168 #: ../src/guestfs.pod:1588
33170 "You may think the above is an awful lot of hassle, and it is. There are "
33171 "other ways outside of the C linking system to ensure that this kind of "
33172 "incompatibility never arises, such as using package versioning:"
33176 #: ../src/guestfs.pod:1593
33179 " Requires: libguestfs >= 1.0.80\n"
33184 #: ../src/guestfs.pod:1595
33185 msgid "CALLS WITH OPTIONAL ARGUMENTS"
33189 #: ../src/guestfs.pod:1597
33191 "A recent feature of the API is the introduction of calls which take optional "
33192 "arguments. In C these are declared 3 ways. The main way is as a call which "
33193 "takes variable arguments (ie. C<...>), as in this example:"
33197 #: ../src/guestfs.pod:1602
33200 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
33205 #: ../src/guestfs.pod:1604
33207 "Call this with a list of optional arguments, terminated by C<-1>. So to "
33208 "call with no optional arguments specified:"
33212 #: ../src/guestfs.pod:1607
33215 " guestfs_add_drive_opts (g, filename, -1);\n"
33220 #: ../src/guestfs.pod:1609
33221 msgid "With a single optional argument:"
33225 #: ../src/guestfs.pod:1611
33228 " guestfs_add_drive_opts (g, filename,\n"
33229 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33235 #: ../src/guestfs.pod:1615
33240 #: ../src/guestfs.pod:1617
33243 " guestfs_add_drive_opts (g, filename,\n"
33244 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33245 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
33251 #: ../src/guestfs.pod:1622
33253 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
33258 #: ../src/guestfs.pod:1625
33259 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
33263 #: ../src/guestfs.pod:1627
33265 "The second variant has the same name with the suffix C<_va>, which works the "
33266 "same way but takes a C<va_list>. See the C manual for details. For the "
33267 "example function, this is declared:"
33271 #: ../src/guestfs.pod:1631
33274 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
33275 " va_list args);\n"
33280 #: ../src/guestfs.pod:1634
33281 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
33285 #: ../src/guestfs.pod:1636
33287 "The third variant is useful where you need to construct these calls. You "
33288 "pass in a structure where you fill in the optional fields. The structure "
33289 "has a bitmask as the first element which you must set to indicate which "
33290 "fields you have filled in. For our example function the structure and call "
33295 #: ../src/guestfs.pod:1642
33298 " struct guestfs_add_drive_opts_argv {\n"
33299 " uint64_t bitmask;\n"
33301 " const char *format;\n"
33304 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
33305 " const struct guestfs_add_drive_opts_argv *optargs);\n"
33310 #: ../src/guestfs.pod:1651
33311 msgid "You could call it like this:"
33315 #: ../src/guestfs.pod:1653
33318 " struct guestfs_add_drive_opts_argv optargs = {\n"
33319 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
33320 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
33321 " .readonly = 1,\n"
33322 " .format = \"qcow2\"\n"
33328 #: ../src/guestfs.pod:1660
33331 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
33336 #: ../src/guestfs.pod:1668
33337 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
33341 #: ../src/guestfs.pod:1673
33342 msgid "You do not need to fill in all fields of the structure."
33346 #: ../src/guestfs.pod:1677
33348 "There must be a one-to-one correspondence between fields of the structure "
33349 "that are filled in, and bits set in the bitmask."
33353 #: ../src/guestfs.pod:1682
33354 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
33358 #: ../src/guestfs.pod:1684
33360 "In other languages, optional arguments are expressed in the way that is "
33361 "natural for that language. We refer you to the language-specific "
33362 "documentation for more details on that."
33366 #: ../src/guestfs.pod:1688
33367 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
33371 #: ../src/guestfs.pod:1690
33372 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
33376 #: ../src/guestfs.pod:1692
33378 "B<Note:> This section documents the generic event mechanism introduced in "
33379 "libguestfs 1.10, which you should use in new code if possible. The old "
33380 "functions C<guestfs_set_log_message_callback>, "
33381 "C<guestfs_set_subprocess_quit_callback>, "
33382 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
33383 "C<guestfs_set_progress_callback> are no longer documented in this manual "
33384 "page. Because of the ABI guarantee, the old functions continue to work."
33388 #: ../src/guestfs.pod:1701
33390 "Handles generate events when certain things happen, such as log messages "
33391 "being generated, progress messages during long-running operations, or the "
33392 "handle being closed. The API calls described below let you register a "
33393 "callback to be called when events happen. You can register multiple "
33394 "callbacks (for the same, different or overlapping sets of events), and "
33395 "individually remove callbacks. If callbacks are not removed, then they "
33396 "remain in force until the handle is closed."
33400 #: ../src/guestfs.pod:1709
33402 "In the current implementation, events are only generated synchronously: that "
33403 "means that events (and hence callbacks) can only happen while you are in the "
33404 "middle of making another libguestfs call. The callback is called in the "
33409 #: ../src/guestfs.pod:1714
33411 "Events may contain a payload, usually nothing (void), an array of 64 bit "
33412 "unsigned integers, or a message buffer. Payloads are discussed later on."
33416 #: ../src/guestfs.pod:1718
33417 msgid "CLASSES OF EVENTS"
33421 #: ../src/guestfs.pod:1722
33422 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
33426 #: ../src/guestfs.pod:1725
33428 "The callback function will be called while the handle is being closed "
33429 "(synchronously from L</guestfs_close>)."
33433 #: ../src/guestfs.pod:1728
33435 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
33436 "handles that are open when the program exits. This means that this callback "
33437 "might be called indirectly from L<exit(3)>, which can cause unexpected "
33438 "problems in higher-level languages (eg. if your HLL interpreter has already "
33439 "been cleaned up by the time this is called, and if your callback then jumps "
33440 "into some HLL function)."
33444 #: ../src/guestfs.pod:1735
33446 "If no callback is registered: the handle is closed without any callback "
33451 #: ../src/guestfs.pod:1738
33452 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
33456 #: ../src/guestfs.pod:1741
33458 "The callback function will be called when the child process quits, either "
33459 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
33460 "corresponds to a transition from any state to the CONFIG state)."
33464 #: ../src/guestfs.pod:1745 ../src/guestfs.pod:1754
33465 msgid "If no callback is registered: the event is ignored."
33469 #: ../src/guestfs.pod:1747
33470 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
33474 #: ../src/guestfs.pod:1750
33476 "The callback function will be called when the child process becomes ready "
33477 "first time after it has been launched. (This corresponds to a transition "
33478 "from LAUNCHING to the READY state)."
33482 #: ../src/guestfs.pod:1756
33483 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
33487 #: ../src/guestfs.pod:1759
33489 "Some long-running operations can generate progress messages. If this "
33490 "callback is registered, then it will be called each time a progress message "
33491 "is generated (usually two seconds after the operation started, and three "
33492 "times per second thereafter until it completes, although the frequency may "
33493 "change in future versions)."
33497 #: ../src/guestfs.pod:1765
33499 "The callback receives in the payload four unsigned 64 bit numbers which are "
33500 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
33504 #: ../src/guestfs.pod:1768
33506 "The units of C<total> are not defined, although for some operations C<total> "
33507 "may relate in some way to the amount of data to be transferred (eg. in bytes "
33508 "or megabytes), and C<position> may be the portion which has been "
33513 #: ../src/guestfs.pod:1773
33514 msgid "The only defined and stable parts of the API are:"
33518 #: ../src/guestfs.pod:1779
33520 "The callback can display to the user some type of progress bar or indicator "
33521 "which shows the ratio of C<position>:C<total>."
33525 #: ../src/guestfs.pod:1784
33526 msgid "0 E<lt>= C<position> E<lt>= C<total>"
33530 #: ../src/guestfs.pod:1788
33532 "If any progress notification is sent during a call, then a final progress "
33533 "notification is always sent when C<position> = C<total> (I<unless> the call "
33534 "fails with an error)."
33538 #: ../src/guestfs.pod:1792
33540 "This is to simplify caller code, so callers can easily set the progress "
33541 "indicator to \"100%\" at the end of the operation, without requiring special "
33542 "code to detect this case."
33546 #: ../src/guestfs.pod:1798
33548 "For some calls we are unable to estimate the progress of the call, but we "
33549 "can still generate progress messages to indicate activity. This is known as "
33550 "\"pulse mode\", and is directly supported by certain progress bar "
33551 "implementations (eg. GtkProgressBar)."
33555 #: ../src/guestfs.pod:1803
33557 "For these calls, zero or more progress messages are generated with "
33558 "C<position = 0> and C<total = 1>, followed by a final message with "
33559 "C<position = total = 1>."
33563 #: ../src/guestfs.pod:1807
33565 "As noted above, if the call fails with an error then the final message may "
33566 "not be generated."
33570 #: ../src/guestfs.pod:1812
33572 "The callback also receives the procedure number (C<proc_nr>) and serial "
33573 "number (C<serial>) of the call. These are only useful for debugging "
33574 "protocol issues, and the callback can normally ignore them. The callback "
33575 "may want to print these numbers in error messages or debugging messages."
33579 #: ../src/guestfs.pod:1818
33580 msgid "If no callback is registered: progress messages are discarded."
33584 #: ../src/guestfs.pod:1820
33585 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
33589 #: ../src/guestfs.pod:1823
33591 "The callback function is called whenever a log message is generated by qemu, "
33592 "the appliance kernel, guestfsd (daemon), or utility programs."
33596 #: ../src/guestfs.pod:1826
33598 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
33599 "(L</guestfs_launch>) then additional debug messages are generated."
33603 #: ../src/guestfs.pod:1829 ../src/guestfs.pod:1843
33605 "If no callback is registered: the messages are discarded unless the verbose "
33606 "flag is set in which case they are sent to stderr. You can override the "
33607 "printing of verbose messages to stderr by setting up a callback."
33611 #: ../src/guestfs.pod:1834
33612 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
33616 #: ../src/guestfs.pod:1837
33618 "The callback function is called whenever a log message is generated by the "
33619 "library part of libguestfs."
33623 #: ../src/guestfs.pod:1840
33625 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
33626 "messages are generated."
33630 #: ../src/guestfs.pod:1848
33631 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
33635 #: ../src/guestfs.pod:1851
33637 "The callback function is called whenever a trace message is generated. This "
33638 "only applies if the trace flag (L</guestfs_set_trace>) is set."
33642 #: ../src/guestfs.pod:1854
33644 "If no callback is registered: the messages are sent to stderr. You can "
33645 "override the printing of trace messages to stderr by setting up a callback."
33649 #: ../src/guestfs.pod:1860
33650 msgid "guestfs_set_event_callback"
33654 #: ../src/guestfs.pod:1862
33657 " int guestfs_set_event_callback (guestfs_h *g,\n"
33658 " guestfs_event_callback cb,\n"
33659 " uint64_t event_bitmask,\n"
33661 " void *opaque);\n"
33666 #: ../src/guestfs.pod:1868
33668 "This function registers a callback (C<cb>) for all event classes in the "
33669 "C<event_bitmask>."
33673 #: ../src/guestfs.pod:1871
33675 "For example, to register for all log message events, you could call this "
33676 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
33677 "To register a single callback for all possible classes of events, use "
33678 "C<GUESTFS_EVENT_ALL>."
33682 #: ../src/guestfs.pod:1877
33683 msgid "C<flags> should always be passed as 0."
33687 #: ../src/guestfs.pod:1879
33689 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
33690 "it for any purpose."
33694 #: ../src/guestfs.pod:1882
33696 "The return value is the event handle (an integer) which you can use to "
33697 "delete the callback (see below)."
33701 #: ../src/guestfs.pod:1885
33703 "If there is an error, this function returns C<-1>, and sets the error in the "
33704 "handle in the usual way (see L</guestfs_last_error> etc.)"
33708 #: ../src/guestfs.pod:1888
33710 "Callbacks remain in effect until they are deleted, or until the handle is "
33715 #: ../src/guestfs.pod:1891
33717 "In the case where multiple callbacks are registered for a particular event "
33718 "class, all of the callbacks are called. The order in which multiple "
33719 "callbacks are called is not defined."
33723 #: ../src/guestfs.pod:1895
33724 msgid "guestfs_delete_event_callback"
33728 #: ../src/guestfs.pod:1897
33731 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
33736 #: ../src/guestfs.pod:1899
33738 "Delete a callback that was previously registered. C<event_handle> should be "
33739 "the integer that was returned by a previous call to "
33740 "C<guestfs_set_event_callback> on the same handle."
33744 #: ../src/guestfs.pod:1903
33745 msgid "guestfs_event_callback"
33749 #: ../src/guestfs.pod:1905
33752 " typedef void (*guestfs_event_callback) (\n"
33755 " uint64_t event,\n"
33756 " int event_handle,\n"
33758 " const char *buf, size_t buf_len,\n"
33759 " const uint64_t *array, size_t array_len);\n"
33764 #: ../src/guestfs.pod:1914
33765 msgid "This is the type of the event callback function that you have to provide."
33769 #: ../src/guestfs.pod:1917
33771 "The basic parameters are: the handle (C<g>), the opaque user pointer "
33772 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
33773 "handle, and C<flags> which in the current API you should ignore."
33777 #: ../src/guestfs.pod:1921
33779 "The remaining parameters contain the event payload (if any). Each event may "
33780 "contain a payload, which usually relates to the event class, but for future "
33781 "proofing your code should be written to handle any payload for any event "
33786 #: ../src/guestfs.pod:1926
33788 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
33789 "there is no message buffer). Note that this message buffer can contain "
33790 "arbitrary 8 bit data, including NUL bytes."
33794 #: ../src/guestfs.pod:1930
33796 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
33797 "moment this is only used for progress messages."
33801 #: ../src/guestfs.pod:1933
33802 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
33806 #: ../src/guestfs.pod:1935
33808 "One motivation for the generic event API was to allow GUI programs to "
33809 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
33810 "unconditionally to C<stderr>."
33814 #: ../src/guestfs.pod:1939
33816 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
33817 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
33818 "messages are not events; you must capture error messages separately)."
33822 #: ../src/guestfs.pod:1944
33824 "Programs have to set up a callback to capture the classes of events of "
33829 #: ../src/guestfs.pod:1947
33833 " guestfs_set_event_callback\n"
33834 " (g, message_callback,\n"
33835 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
33836 " GUESTFS_EVENT_TRACE,\n"
33837 " 0, NULL) == -1)\n"
33838 " if (eh == -1) {\n"
33839 " // handle error in the usual way\n"
33845 #: ../src/guestfs.pod:1957
33847 "The callback can then direct messages to the appropriate place. In this "
33848 "example, messages are directed to syslog:"
33852 #: ../src/guestfs.pod:1960
33856 " message_callback (\n"
33859 " uint64_t event,\n"
33860 " int event_handle,\n"
33862 " const char *buf, size_t buf_len,\n"
33863 " const uint64_t *array, size_t array_len)\n"
33865 " const int priority = LOG_USER|LOG_INFO;\n"
33866 " if (buf_len > 0)\n"
33867 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
33873 #: ../src/guestfs.pod:1975
33874 msgid "CANCELLING LONG TRANSFERS"
33878 #: ../src/guestfs.pod:1977
33880 "Some operations can be cancelled by the caller while they are in progress. "
33881 "Currently only operations that involve uploading or downloading data can be "
33882 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
33883 "parameters in the generator)."
33887 #: ../src/guestfs.pod:1982
33888 msgid "guestfs_user_cancel"
33892 #: ../src/guestfs.pod:1984
33895 " void guestfs_user_cancel (guestfs_h *g);\n"
33900 #: ../src/guestfs.pod:1986
33901 msgid "C<guestfs_user_cancel> cancels the current upload or download operation."
33905 #: ../src/guestfs.pod:1989
33907 "Unlike most other libguestfs calls, this function is signal safe and thread "
33908 "safe. You can call it from a signal handler or from another thread, without "
33909 "needing to do any locking."
33913 #: ../src/guestfs.pod:1993
33915 "The transfer that was in progress (if there is one) will stop shortly "
33916 "afterwards, and will return an error. The errno (see "
33917 "L</guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
33918 "out if the operation was cancelled or failed because of another error."
33922 #: ../src/guestfs.pod:1999
33924 "No cleanup is performed: for example, if a file was being uploaded then "
33925 "after cancellation there may be a partially uploaded file. It is the "
33926 "caller's responsibility to clean up if necessary."
33930 #: ../src/guestfs.pod:2003
33931 msgid "There are two common places that you might call C<guestfs_user_cancel>."
33935 #: ../src/guestfs.pod:2005
33937 "In an interactive text-based program, you might call it from a C<SIGINT> "
33938 "signal handler so that pressing C<^C> cancels the current operation. (You "
33939 "also need to call L</guestfs_set_pgroup> so that child processes don't "
33940 "receive the C<^C> signal)."
33944 #: ../src/guestfs.pod:2010
33946 "In a graphical program, when the main thread is displaying a progress bar "
33947 "with a cancel button, wire up the cancel button to call this function."
33951 #: ../src/guestfs.pod:2014
33952 msgid "PRIVATE DATA AREA"
33956 #: ../src/guestfs.pod:2016
33958 "You can attach named pieces of private data to the libguestfs handle, fetch "
33959 "them by name, and walk over them, for the lifetime of the handle. This is "
33960 "called the private data area and is only available from the C API."
33964 #: ../src/guestfs.pod:2021
33965 msgid "To attach a named piece of data, use the following call:"
33969 #: ../src/guestfs.pod:2023
33972 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
33977 #: ../src/guestfs.pod:2025
33979 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
33980 "pointer (which can be C<NULL>). Any previous item with the same key is "
33985 #: ../src/guestfs.pod:2029
33987 "You can use any C<key> you want, but your key should I<not> start with an "
33988 "underscore character. Keys beginning with an underscore character are "
33989 "reserved for internal libguestfs purposes (eg. for implementing language "
33990 "bindings). It is recommended that you prefix the key with some unique "
33991 "string to avoid collisions with other users."
33995 #: ../src/guestfs.pod:2035
33996 msgid "To retrieve the pointer, use:"
34000 #: ../src/guestfs.pod:2037
34003 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
34008 #: ../src/guestfs.pod:2039
34010 "This function returns C<NULL> if either no data is found associated with "
34011 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
34016 #: ../src/guestfs.pod:2043
34018 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
34019 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
34020 "all. In particular, libguestfs does I<not> try to free the data when the "
34021 "handle is closed. If the data must be freed, then the caller must either "
34022 "free it before calling L</guestfs_close> or must set up a close callback to "
34023 "do it (see L</GUESTFS_EVENT_CLOSE>)."
34027 #: ../src/guestfs.pod:2050
34028 msgid "To walk over all entries, use these two functions:"
34032 #: ../src/guestfs.pod:2052
34035 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
34040 #: ../src/guestfs.pod:2054
34043 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
34048 #: ../src/guestfs.pod:2056
34050 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
34051 "not have any particular meaning -- keys are not returned in any defined "
34052 "order). A pointer to the key is returned in C<*key_rtn> and the "
34053 "corresponding data pointer is returned from the function. C<NULL> is "
34054 "returned if there are no keys stored in the handle."
34058 #: ../src/guestfs.pod:2062
34060 "C<guestfs_next_private> returns the next key, pointer pair. The return "
34061 "value of this function is also C<NULL> is there are no further entries to "
34066 #: ../src/guestfs.pod:2066
34067 msgid "Notes about walking over entries:"
34071 #: ../src/guestfs.pod:2072
34072 msgid "You must not call C<guestfs_set_private> while walking over the entries."
34076 #: ../src/guestfs.pod:2077
34078 "The handle maintains an internal iterator which is reset when you call "
34079 "C<guestfs_first_private>. This internal iterator is invalidated when you "
34080 "call C<guestfs_set_private>."
34084 #: ../src/guestfs.pod:2083
34085 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
34089 #: ../src/guestfs.pod:2085
34092 " guestfs_set_private (g, key, NULL);\n"
34097 #: ../src/guestfs.pod:2087
34098 msgid "then that C<key> is not returned when walking."
34102 #: ../src/guestfs.pod:2091
34104 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
34105 "C<guestfs_next_private> or C<guestfs_set_private>."
34109 #: ../src/guestfs.pod:2097
34111 "The following example code shows how to print all keys and data pointers "
34112 "that are associated with the handle C<g>:"
34116 #: ../src/guestfs.pod:2100
34119 " const char *key;\n"
34120 " void *data = guestfs_first_private (g, &key);\n"
34121 " while (data != NULL)\n"
34123 " printf (\"key = %s, data = %p\\n\", key, data);\n"
34124 " data = guestfs_next_private (g, &key);\n"
34130 #: ../src/guestfs.pod:2108
34132 "More commonly you are only interested in keys that begin with an "
34133 "application-specific prefix C<foo_>. Modify the loop like so:"
34137 #: ../src/guestfs.pod:2111
34140 " const char *key;\n"
34141 " void *data = guestfs_first_private (g, &key);\n"
34142 " while (data != NULL)\n"
34144 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
34145 " printf (\"key = %s, data = %p\\n\", key, data);\n"
34146 " data = guestfs_next_private (g, &key);\n"
34152 #: ../src/guestfs.pod:2120
34154 "If you need to modify keys while walking, then you have to jump back to the "
34155 "beginning of the loop. For example, to delete all keys prefixed with "
34160 #: ../src/guestfs.pod:2124
34163 " const char *key;\n"
34166 " data = guestfs_first_private (g, &key);\n"
34167 " while (data != NULL)\n"
34169 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
34171 " guestfs_set_private (g, key, NULL);\n"
34172 " /* note that 'key' pointer is now invalid, and so is\n"
34173 " the internal iterator */\n"
34176 " data = guestfs_next_private (g, &key);\n"
34182 #: ../src/guestfs.pod:2140
34184 "Note that the above loop is guaranteed to terminate because the keys are "
34185 "being deleted, but other manipulations of keys within the loop might not "
34186 "terminate unless you also maintain an indication of which keys have been "
34191 #: ../src/guestfs.pod:2145 ../src/guestfs.pod:2150
34196 #: ../src/guestfs.pod:2147
34198 "<!-- old anchor for the next section --> <a "
34199 "name=\"state_machine_and_low_level_event_api\"/>"
34203 #: ../src/guestfs.pod:2152
34204 msgid "ARCHITECTURE"
34208 #: ../src/guestfs.pod:2154
34210 "Internally, libguestfs is implemented by running an appliance (a special "
34211 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
34212 "process of the main program."
34216 #: ../src/guestfs.pod:2158
34219 " ___________________\n"
34221 " | main program |\n"
34223 " | | child process / appliance\n"
34224 " | | __________________________\n"
34226 " +-------------------+ RPC | +-----------------+ |\n"
34227 " | libguestfs <--------------------> guestfsd | |\n"
34228 " | | | +-----------------+ |\n"
34229 " \\___________________/ | | Linux kernel | |\n"
34230 " | +--^--------------+ |\n"
34231 " \\_________|________________/\n"
34233 " _______v______\n"
34236 " | disk image |\n"
34237 " \\______________/\n"
34242 #: ../src/guestfs.pod:2178
34244 "The library, linked to the main program, creates the child process and hence "
34245 "the appliance in the L</guestfs_launch> function."
34249 #: ../src/guestfs.pod:2181
34251 "Inside the appliance is a Linux kernel and a complete stack of userspace "
34252 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
34253 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
34254 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
34255 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
34256 "attached to the qemu process which translates device access by the "
34257 "appliance's Linux kernel into accesses to the image."
34261 #: ../src/guestfs.pod:2190
34263 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
34264 "Although the disk image you are attached to might also be used by some "
34265 "virtual machine, libguestfs doesn't know or care about this. (But you will "
34266 "care if both libguestfs's qemu process and your virtual machine are trying "
34267 "to update the disk image at the same time, since these usually results in "
34268 "massive disk corruption)."
34272 #: ../src/guestfs.pod:2197
34273 msgid "STATE MACHINE"
34277 #: ../src/guestfs.pod:2199
34278 msgid "libguestfs uses a state machine to model the child process:"
34282 #: ../src/guestfs.pod:2201
34286 " guestfs_create\n"
34294 " / | \\ \\ guestfs_launch\n"
34295 " / | _\\__V______\n"
34297 " / | | LAUNCHING |\n"
34298 " / | \\___________/\n"
34300 " / | guestfs_launch\n"
34302 " ______ / __|____V\n"
34303 " / \\ ------> / \\\n"
34304 " | BUSY | | READY |\n"
34305 " \\______/ <------ \\________/\n"
34310 #: ../src/guestfs.pod:2223
34312 "The normal transitions are (1) CONFIG (when the handle is created, but there "
34313 "is no child process), (2) LAUNCHING (when the child process is booting up), "
34314 "(3) alternating between READY and BUSY as commands are issued to, and "
34315 "carried out by, the child process."
34319 #: ../src/guestfs.pod:2228
34321 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
34322 "asynchronously at any time (eg. due to some internal error), and that causes "
34323 "the state to transition back to CONFIG."
34327 #: ../src/guestfs.pod:2232
34329 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
34330 "issued when in the CONFIG state."
34334 #: ../src/guestfs.pod:2235
34336 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
34337 "L</guestfs_launch> blocks until the child process is READY to accept "
34338 "commands (or until some failure or timeout). L</guestfs_launch> internally "
34339 "moves the state from CONFIG to LAUNCHING while it is running."
34343 #: ../src/guestfs.pod:2241
34345 "API actions such as L</guestfs_mount> can only be issued when in the READY "
34346 "state. These API calls block waiting for the command to be carried out "
34347 "(ie. the state to transition to BUSY and then back to READY). There are no "
34348 "non-blocking versions, and no way to issue more than one command per handle "
34349 "at the same time."
34353 #: ../src/guestfs.pod:2247
34355 "Finally, the child process sends asynchronous messages back to the main "
34356 "program, such as kernel log messages. You can register a callback to "
34357 "receive these messages."
34361 #: ../src/guestfs.pod:2251
34366 #: ../src/guestfs.pod:2253
34367 msgid "APPLIANCE BOOT PROCESS"
34371 #: ../src/guestfs.pod:2255
34373 "This process has evolved and continues to evolve. The description here "
34374 "corresponds only to the current version of libguestfs and is provided for "
34375 "information only."
34379 #: ../src/guestfs.pod:2259
34381 "In order to follow the stages involved below, enable libguestfs debugging "
34382 "(set the environment variable C<LIBGUESTFS_DEBUG=1>)."
34386 #: ../src/guestfs.pod:2264
34387 msgid "Create the appliance"
34391 #: ../src/guestfs.pod:2266
34393 "C<febootstrap-supermin-helper> is invoked to create the kernel, a small "
34394 "initrd and the appliance."
34398 #: ../src/guestfs.pod:2269
34400 "The appliance is cached in C</var/tmp/.guestfs-E<lt>UIDE<gt>> (or in another "
34401 "directory if C<TMPDIR> is set)."
34405 #: ../src/guestfs.pod:2272
34407 "For a complete description of how the appliance is created and cached, read "
34408 "the L<febootstrap(8)> and L<febootstrap-supermin-helper(8)> man pages."
34412 #: ../src/guestfs.pod:2276
34413 msgid "Start qemu and boot the kernel"
34417 #: ../src/guestfs.pod:2278
34418 msgid "qemu is invoked to boot the kernel."
34422 #: ../src/guestfs.pod:2280
34423 msgid "Run the initrd"
34427 #: ../src/guestfs.pod:2282
34429 "C<febootstrap-supermin-helper> builds a small initrd. The initrd is not the "
34430 "appliance. The purpose of the initrd is to load enough kernel modules in "
34431 "order that the appliance itself can be mounted and started."
34435 #: ../src/guestfs.pod:2286
34437 "The initrd is a cpio archive called "
34438 "C</var/tmp/.guestfs-E<lt>UIDE<gt>/initrd>."
34442 #: ../src/guestfs.pod:2289
34444 "When the initrd has started you will see messages showing that kernel "
34445 "modules are being loaded, similar to this:"
34449 #: ../src/guestfs.pod:2292
34452 " febootstrap: ext2 mini initrd starting up\n"
34453 " febootstrap: mounting /sys\n"
34454 " febootstrap: internal insmod libcrc32c.ko\n"
34455 " febootstrap: internal insmod crc32c-intel.ko\n"
34460 #: ../src/guestfs.pod:2297
34461 msgid "Find and mount the appliance device"
34465 #: ../src/guestfs.pod:2299
34467 "The appliance is a sparse file containing an ext2 filesystem which contains "
34468 "a familiar (although reduced in size) Linux operating system. It would "
34469 "normally be called C</var/tmp/.guestfs-E<lt>UIDE<gt>/root>."
34473 #: ../src/guestfs.pod:2303
34475 "The regular disks being inspected by libguestfs are the first devices "
34476 "exposed by qemu (eg. as C</dev/vda>)."
34480 #: ../src/guestfs.pod:2306
34482 "The last disk added to qemu is the appliance itself (eg. C</dev/vdb> if "
34483 "there was only one regular disk)."
34487 #: ../src/guestfs.pod:2309
34489 "Thus the final job of the initrd is to locate the appliance disk, mount it, "
34490 "and switch root into the appliance, and run C</init> from the appliance."
34494 #: ../src/guestfs.pod:2313
34495 msgid "If this works successfully you will see messages such as:"
34499 #: ../src/guestfs.pod:2315
34502 " febootstrap: picked /sys/block/vdb/dev as root device\n"
34503 " febootstrap: creating /dev/root as block special 252:16\n"
34504 " febootstrap: mounting new root on /root\n"
34505 " febootstrap: chroot\n"
34506 " Starting /init script ...\n"
34511 #: ../src/guestfs.pod:2321
34513 "Note that C<Starting /init script ...> indicates that the appliance's init "
34514 "script is now running."
34518 #: ../src/guestfs.pod:2324
34519 msgid "Initialize the appliance"
34523 #: ../src/guestfs.pod:2326
34525 "The appliance itself now initializes itself. This involves starting certain "
34526 "processes like C<udev>, possibly printing some debug information, and "
34527 "finally running the daemon (C<guestfsd>)."
34531 #: ../src/guestfs.pod:2330
34536 #: ../src/guestfs.pod:2332
34538 "Finally the daemon (C<guestfsd>) runs inside the appliance. If it runs you "
34543 #: ../src/guestfs.pod:2335
34546 " verbose daemon enabled\n"
34551 #: ../src/guestfs.pod:2337
34553 "The daemon expects to see a named virtio-serial port exposed by qemu and "
34554 "connected on the other end to the library."
34558 #: ../src/guestfs.pod:2340
34560 "The daemon connects to this port (and hence to the library) and sends a four "
34561 "byte message C<GUESTFS_LAUNCH_FLAG>, which initiates the communication "
34562 "protocol (see below)."
34566 #: ../src/guestfs.pod:2346
34567 msgid "COMMUNICATION PROTOCOL"
34571 #: ../src/guestfs.pod:2348
34573 "Don't rely on using this protocol directly. This section documents how it "
34574 "currently works, but it may change at any time."
34578 #: ../src/guestfs.pod:2351
34580 "The protocol used to talk between the library and the daemon running inside "
34581 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
34582 "1014, RFC 1832, RFC 4506)."
34586 #: ../src/guestfs.pod:2355
34588 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
34589 "this file is automatically generated)."
34593 #: ../src/guestfs.pod:2358
34595 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
34596 "and C<FileOut> parameters, which are handled with very simple request/reply "
34597 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
34598 "parameters, which use the same request and reply messages, but they may also "
34599 "be followed by files sent using a chunked encoding."
34603 #: ../src/guestfs.pod:2365
34604 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
34608 #: ../src/guestfs.pod:2367
34609 msgid "For ordinary functions, the request message is:"
34613 #: ../src/guestfs.pod:2369
34616 " total length (header + arguments,\n"
34617 " but not including the length word itself)\n"
34618 " struct guestfs_message_header (encoded as XDR)\n"
34619 " struct guestfs_<foo>_args (encoded as XDR)\n"
34624 #: ../src/guestfs.pod:2374
34626 "The total length field allows the daemon to allocate a fixed size buffer "
34627 "into which it slurps the rest of the message. As a result, the total length "
34628 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
34629 "effective size of any request is limited to somewhere under this size."
34633 #: ../src/guestfs.pod:2380
34635 "Note also that many functions don't take any arguments, in which case the "
34636 "C<guestfs_I<foo>_args> is completely omitted."
34640 #: ../src/guestfs.pod:2383
34642 "The header contains the procedure number (C<guestfs_proc>) which is how the "
34643 "receiver knows what type of args structure to expect, or none at all."
34647 #: ../src/guestfs.pod:2387
34649 "For functions that take optional arguments, the optional arguments are "
34650 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
34651 "arguments. A bitmask in the header indicates which optional arguments are "
34652 "meaningful. The bitmask is also checked to see if it contains bits set "
34653 "which the daemon does not know about (eg. if more optional arguments were "
34654 "added in a later version of the library), and this causes the call to be "
34659 #: ../src/guestfs.pod:2395
34660 msgid "The reply message for ordinary functions is:"
34664 #: ../src/guestfs.pod:2397
34667 " total length (header + ret,\n"
34668 " but not including the length word itself)\n"
34669 " struct guestfs_message_header (encoded as XDR)\n"
34670 " struct guestfs_<foo>_ret (encoded as XDR)\n"
34675 #: ../src/guestfs.pod:2402
34677 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
34678 "functions that return no formal return values."
34682 #: ../src/guestfs.pod:2405
34683 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
34687 #: ../src/guestfs.pod:2408
34689 "In the case of an error, a flag is set in the header, and the reply message "
34690 "is slightly changed:"
34694 #: ../src/guestfs.pod:2411
34697 " total length (header + error,\n"
34698 " but not including the length word itself)\n"
34699 " struct guestfs_message_header (encoded as XDR)\n"
34700 " struct guestfs_message_error (encoded as XDR)\n"
34705 #: ../src/guestfs.pod:2416
34707 "The C<guestfs_message_error> structure contains the error message as a "
34712 #: ../src/guestfs.pod:2419
34713 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
34717 #: ../src/guestfs.pod:2421
34719 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
34720 "The normal request message is sent (see above). However this is followed by "
34721 "a sequence of file chunks."
34725 #: ../src/guestfs.pod:2425
34728 " total length (header + arguments,\n"
34729 " but not including the length word itself,\n"
34730 " and not including the chunks)\n"
34731 " struct guestfs_message_header (encoded as XDR)\n"
34732 " struct guestfs_<foo>_args (encoded as XDR)\n"
34733 " sequence of chunks for FileIn param #0\n"
34734 " sequence of chunks for FileIn param #1 etc.\n"
34739 #: ../src/guestfs.pod:2433
34740 msgid "The \"sequence of chunks\" is:"
34744 #: ../src/guestfs.pod:2435
34747 " length of chunk (not including length word itself)\n"
34748 " struct guestfs_chunk (encoded as XDR)\n"
34749 " length of chunk\n"
34750 " struct guestfs_chunk (encoded as XDR)\n"
34752 " length of chunk\n"
34753 " struct guestfs_chunk (with data.data_len == 0)\n"
34758 #: ../src/guestfs.pod:2443
34760 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
34761 "is set in the final chunk to indicate either successful completion or early "
34766 #: ../src/guestfs.pod:2447
34768 "At time of writing there are no functions that have more than one FileIn "
34769 "parameter. However this is (theoretically) supported, by sending the "
34770 "sequence of chunks for each FileIn parameter one after another (from left to "
34775 #: ../src/guestfs.pod:2452
34777 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
34778 "transfer. The library does this by sending a chunk with a special flag set "
34779 "to indicate cancellation. When the daemon sees this, it cancels the whole "
34780 "RPC, does I<not> send any reply, and goes back to reading the next request."
34784 #: ../src/guestfs.pod:2458
34786 "The daemon may also cancel. It does this by writing a special word "
34787 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
34788 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
34789 "cancel chunk). The special word is chosen so that even if cancellation "
34790 "happens right at the end of the transfer (after the library has finished "
34791 "writing and has started listening for the reply), the \"spurious\" cancel "
34792 "flag will not be confused with the reply message."
34796 #: ../src/guestfs.pod:2467
34798 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
34799 "limit), and also files where the size is not known in advance (eg. from "
34800 "pipes or sockets). However the chunks are rather small "
34801 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
34802 "to keep much in memory."
34806 #: ../src/guestfs.pod:2473
34807 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
34811 #: ../src/guestfs.pod:2475
34813 "The protocol for FileOut parameters is exactly the same as for FileIn "
34814 "parameters, but with the roles of daemon and library reversed."
34818 #: ../src/guestfs.pod:2478
34821 " total length (header + ret,\n"
34822 " but not including the length word itself,\n"
34823 " and not including the chunks)\n"
34824 " struct guestfs_message_header (encoded as XDR)\n"
34825 " struct guestfs_<foo>_ret (encoded as XDR)\n"
34826 " sequence of chunks for FileOut param #0\n"
34827 " sequence of chunks for FileOut param #1 etc.\n"
34832 #: ../src/guestfs.pod:2486
34833 msgid "INITIAL MESSAGE"
34837 #: ../src/guestfs.pod:2488
34839 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
34840 "which indicates that the guest and daemon is alive. This is what "
34841 "L</guestfs_launch> waits for."
34845 #: ../src/guestfs.pod:2492
34846 msgid "PROGRESS NOTIFICATION MESSAGES"
34850 #: ../src/guestfs.pod:2494
34852 "The daemon may send progress notification messages at any time. These are "
34853 "distinguished by the normal length word being replaced by "
34854 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
34858 #: ../src/guestfs.pod:2498
34860 "The library turns them into progress callbacks (see "
34861 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
34866 #: ../src/guestfs.pod:2502
34868 "The daemon self-limits the frequency of progress messages it sends (see "
34869 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
34874 #: ../src/guestfs.pod:2506
34875 msgid "LIBGUESTFS VERSION NUMBERS"
34879 #: ../src/guestfs.pod:2508
34881 "Since April 2010, libguestfs has started to make separate development and "
34882 "stable releases, along with corresponding branches in our git repository. "
34883 "These separate releases can be identified by version number:"
34887 #: ../src/guestfs.pod:2513
34890 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
34891 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
34897 " | `-------- sub-version\n"
34899 " `------ always '1' because we don't change the ABI\n"
34904 #: ../src/guestfs.pod:2524
34905 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
34909 #: ../src/guestfs.pod:2526
34911 "As time passes we cherry pick fixes from the development branch and backport "
34912 "those into the stable branch, the effect being that the stable branch should "
34913 "get more stable and less buggy over time. So the stable releases are ideal "
34914 "for people who don't need new features but would just like the software to "
34919 #: ../src/guestfs.pod:2532
34920 msgid "Our criteria for backporting changes are:"
34924 #: ../src/guestfs.pod:2538
34926 "Documentation changes which don't affect any code are backported unless the "
34927 "documentation refers to a future feature which is not in stable."
34931 #: ../src/guestfs.pod:2544
34933 "Bug fixes which are not controversial, fix obvious problems, and have been "
34934 "well tested are backported."
34938 #: ../src/guestfs.pod:2549
34940 "Simple rearrangements of code which shouldn't affect how it works get "
34941 "backported. This is so that the code in the two branches doesn't get too "
34942 "far out of step, allowing us to backport future fixes more easily."
34946 #: ../src/guestfs.pod:2555
34948 "We I<don't> backport new features, new APIs, new tools etc, except in one "
34949 "exceptional case: the new feature is required in order to implement an "
34950 "important bug fix."
34954 #: ../src/guestfs.pod:2561
34956 "A new stable branch starts when we think the new features in development are "
34957 "substantial and compelling enough over the current stable branch to warrant "
34958 "it. When that happens we create new stable and development versions 1.N.0 "
34959 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
34960 "stable at this point, but by backporting fixes from development, that branch "
34961 "will stabilize over time."
34965 #: ../src/guestfs.pod:2569
34966 msgid "EXTENDING LIBGUESTFS"
34970 #: ../src/guestfs.pod:2571
34971 msgid "ADDING A NEW API ACTION"
34975 #: ../src/guestfs.pod:2573
34977 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
34978 "documentation) are generated, and this makes it easy to extend the "
34983 #: ../src/guestfs.pod:2577
34984 msgid "To add a new API action there are two changes:"
34988 #: ../src/guestfs.pod:2583
34990 "You need to add a description of the call (name, parameters, return type, "
34991 "tests, documentation) to C<generator/generator_actions.ml>."
34995 #: ../src/guestfs.pod:2586
34997 "There are two sorts of API action, depending on whether the call goes "
34998 "through to the daemon in the appliance, or is serviced entirely by the "
34999 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
35000 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
35001 "an example of the latter, since a trace flag is maintained in the handle and "
35002 "all tracing is done on the library side."
35006 #: ../src/guestfs.pod:2594
35008 "Most new actions are of the first type, and get added to the "
35009 "C<daemon_functions> list. Each function has a unique procedure number used "
35010 "in the RPC protocol which is assigned to that action when we publish "
35011 "libguestfs and cannot be reused. Take the latest procedure number and "
35016 #: ../src/guestfs.pod:2600
35018 "For library-only actions of the second type, add to the "
35019 "C<non_daemon_functions> list. Since these functions are serviced by the "
35020 "library and do not travel over the RPC mechanism to the daemon, these "
35021 "functions do not need a procedure number, and so the procedure number is set "
35026 #: ../src/guestfs.pod:2608
35027 msgid "Implement the action (in C):"
35031 #: ../src/guestfs.pod:2610
35033 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
35034 "C<daemon/> directory."
35038 #: ../src/guestfs.pod:2613
35040 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
35041 "(note: double underscore) in the C<src/> directory."
35045 #: ../src/guestfs.pod:2616
35046 msgid "In either case, use another function as an example of what to do."
35050 #: ../src/guestfs.pod:2620
35051 msgid "After making these changes, use C<make> to compile."
35055 #: ../src/guestfs.pod:2622
35057 "Note that you don't need to implement the RPC, language bindings, manual "
35058 "pages or anything else. It's all automatically generated from the OCaml "
35063 #: ../src/guestfs.pod:2626
35064 msgid "ADDING TESTS FOR AN API ACTION"
35068 #: ../src/guestfs.pod:2628
35070 "You can supply zero or as many tests as you want per API call. The tests "
35071 "can either be added as part of the API description "
35072 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
35073 "drop a script into C<regressions/>. Note that adding a script to "
35074 "C<regressions/> is slower, so if possible use the first method."
35078 #: ../src/guestfs.pod:2634
35080 "The following describes the test environment used when you add an API test "
35081 "in C<generator_actions.ml>."
35085 #: ../src/guestfs.pod:2637
35086 msgid "The test environment has 4 block devices:"
35090 #: ../src/guestfs.pod:2641
35091 msgid "C</dev/sda> 500MB"
35095 #: ../src/guestfs.pod:2643
35096 msgid "General block device for testing."
35100 #: ../src/guestfs.pod:2645
35101 msgid "C</dev/sdb> 50MB"
35105 #: ../src/guestfs.pod:2647
35107 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
35112 #: ../src/guestfs.pod:2650
35113 msgid "C</dev/sdc> 10MB"
35117 #: ../src/guestfs.pod:2652
35118 msgid "Used in a few tests where two block devices are needed."
35122 #: ../src/guestfs.pod:2654
35123 msgid "C</dev/sdd>"
35127 #: ../src/guestfs.pod:2656
35128 msgid "ISO with fixed content (see C<images/test.iso>)."
35132 #: ../src/guestfs.pod:2660
35134 "To be able to run the tests in a reasonable amount of time, the libguestfs "
35135 "appliance and block devices are reused between tests. So don't try testing "
35136 "L</guestfs_kill_subprocess> :-x"
35140 #: ../src/guestfs.pod:2664
35142 "Each test starts with an initial scenario, selected using one of the "
35143 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
35144 "initialize the disks mentioned above in a particular way as documented in "
35145 "C<generator_types.ml>. You should not assume anything about the previous "
35146 "contents of other disks that are not initialized."
35150 #: ../src/guestfs.pod:2670
35152 "You can add a prerequisite clause to any individual test. This is a "
35153 "run-time check, which, if it fails, causes the test to be skipped. Useful "
35154 "if testing a command which might not work on all variations of libguestfs "
35155 "builds. A test that has prerequisite of C<Always> means to run "
35160 #: ../src/guestfs.pod:2676
35162 "In addition, packagers can skip individual tests by setting environment "
35163 "variables before running C<make check>."
35167 #: ../src/guestfs.pod:2679
35170 " SKIP_TEST_<CMD>_<NUM>=1\n"
35175 #: ../src/guestfs.pod:2681
35176 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
35180 #: ../src/guestfs.pod:2683
35185 #: ../src/guestfs.pod:2685
35188 " SKIP_TEST_<CMD>=1\n"
35193 #: ../src/guestfs.pod:2687
35194 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
35198 #: ../src/guestfs.pod:2689
35199 msgid "Packagers can run only certain tests by setting for example:"
35203 #: ../src/guestfs.pod:2691
35206 " TEST_ONLY=\"vfs_type zerofree\"\n"
35211 #: ../src/guestfs.pod:2693
35213 "See C<capitests/tests.c> for more details of how these environment variables "
35218 #: ../src/guestfs.pod:2696
35219 msgid "DEBUGGING NEW API ACTIONS"
35223 #: ../src/guestfs.pod:2698
35224 msgid "Test new actions work before submitting them."
35228 #: ../src/guestfs.pod:2700
35229 msgid "You can use guestfish to try out new commands."
35233 #: ../src/guestfs.pod:2702
35235 "Debugging the daemon is a problem because it runs inside a minimal "
35236 "environment. However you can fprintf messages in the daemon to stderr, and "
35237 "they will show up if you use C<guestfish -v>."
35241 #: ../src/guestfs.pod:2706
35242 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
35246 #: ../src/guestfs.pod:2708
35248 "Our C source code generally adheres to some basic code-formatting "
35249 "conventions. The existing code base is not totally consistent on this "
35250 "front, but we do prefer that contributed code be formatted similarly. In "
35251 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
35252 "indentation level, and other than that, follow the K&R style."
35256 #: ../src/guestfs.pod:2714
35258 "If you use Emacs, add the following to one of one of your start-up files "
35259 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
35263 #: ../src/guestfs.pod:2717
35266 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
35267 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
35268 " (add-hook 'find-file-hook\n"
35269 " '(lambda () (if (and buffer-file-name\n"
35270 " (string-match \"/libguestfs\\\\>\"\n"
35271 " (buffer-file-name))\n"
35272 " (not (string-equal mode-name \"Change Log\"))\n"
35273 " (not (string-equal mode-name \"Makefile\")))\n"
35274 " (setq indent-tabs-mode nil))))\n"
35279 #: ../src/guestfs.pod:2727
35282 " ;;; When editing C sources in libguestfs, use this style.\n"
35283 " (defun libguestfs-c-mode ()\n"
35284 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
35286 " (c-set-style \"K&R\")\n"
35287 " (setq c-indent-level 2)\n"
35288 " (setq c-basic-offset 2))\n"
35289 " (add-hook 'c-mode-hook\n"
35290 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
35291 " (buffer-file-name))\n"
35292 " (libguestfs-c-mode))))\n"
35297 #: ../src/guestfs.pod:2739
35298 msgid "Enable warnings when compiling (and fix any problems this finds):"
35302 #: ../src/guestfs.pod:2742
35305 " ./configure --enable-gcc-warnings\n"
35310 #: ../src/guestfs.pod:2744
35311 msgid "Useful targets are:"
35315 #: ../src/guestfs.pod:2746
35318 " make syntax-check # checks the syntax of the C code\n"
35319 " make check # runs the test suite\n"
35324 #: ../src/guestfs.pod:2749
35325 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
35329 #: ../src/guestfs.pod:2751
35331 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
35332 "which are used to do shell quoting."
35336 #: ../src/guestfs.pod:2756
35341 #: ../src/guestfs.pod:2758
35343 "Simple shell quoted string. Any spaces or other shell characters are "
35348 #: ../src/guestfs.pod:2761
35353 #: ../src/guestfs.pod:2763
35355 "Same as C<%Q> except the string is treated as a path which is prefixed by "
35360 #: ../src/guestfs.pod:2770
35363 " asprintf (&cmd, \"cat %R\", path);\n"
35368 #: ../src/guestfs.pod:2772
35369 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
35373 #: ../src/guestfs.pod:2774
35375 "I<Note:> Do I<not> use these when you are passing parameters to the "
35376 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
35377 "because they are not passed via the shell (instead, straight to exec). You "
35378 "probably want to use the C<sysroot_path()> function however."
35382 #: ../src/guestfs.pod:2780
35383 msgid "SUBMITTING YOUR NEW API ACTIONS"
35387 #: ../src/guestfs.pod:2782
35389 "Submit patches to the mailing list: "
35390 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
35391 "L<rjones@redhat.com>."
35395 #: ../src/guestfs.pod:2786
35396 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
35400 #: ../src/guestfs.pod:2788
35401 msgid "We support i18n (gettext anyhow) in the library."
35405 #: ../src/guestfs.pod:2790
35407 "However many messages come from the daemon, and we don't translate those at "
35408 "the moment. One reason is that the appliance generally has all locale files "
35409 "removed from it, because they take up a lot of space. So we'd have to readd "
35410 "some of those, as well as copying our PO files into the appliance."
35414 #: ../src/guestfs.pod:2796
35416 "Debugging messages are never translated, since they are intended for the "
35421 #: ../src/guestfs.pod:2799
35422 msgid "SOURCE CODE SUBDIRECTORIES"
35426 #: ../src/guestfs.pod:2805
35427 msgid "The libguestfs appliance, build scripts and so on."
35431 #: ../src/guestfs.pod:2807
35432 msgid "C<capitests>"
35436 #: ../src/guestfs.pod:2809
35437 msgid "Automated tests of the C API."
35441 #: ../src/guestfs.pod:2811
35446 #: ../src/guestfs.pod:2813
35448 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
35453 #: ../src/guestfs.pod:2816
35458 #: ../src/guestfs.pod:2818
35460 "Safety and liveness tests of components that libguestfs depends upon (not of "
35461 "libguestfs itself). Mainly this is for qemu and the kernel."
35465 #: ../src/guestfs.pod:2821
35470 #: ../src/guestfs.pod:2823
35471 msgid "Outside contributions, experimental parts."
35475 #: ../src/guestfs.pod:2825
35480 #: ../src/guestfs.pod:2827
35482 "The daemon that runs inside the libguestfs appliance and carries out "
35487 #: ../src/guestfs.pod:2830
35492 #: ../src/guestfs.pod:2832
35493 msgid "L<virt-df(1)> command and documentation."
35497 #: ../src/guestfs.pod:2834
35502 #: ../src/guestfs.pod:2836
35503 msgid "L<virt-edit(1)> command and documentation."
35507 #: ../src/guestfs.pod:2838
35508 msgid "C<examples>"
35512 #: ../src/guestfs.pod:2840
35513 msgid "C API example code."
35517 #: ../src/guestfs.pod:2842
35522 #: ../src/guestfs.pod:2844
35524 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
35525 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
35526 "L<virt-tar-out(1)>."
35530 #: ../src/guestfs.pod:2848
35535 #: ../src/guestfs.pod:2850
35536 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
35540 #: ../src/guestfs.pod:2852
35541 msgid "C<generator>"
35545 #: ../src/guestfs.pod:2854
35547 "The crucially important generator, used to automatically generate large "
35548 "amounts of boilerplate C code for things like RPC and bindings."
35552 #: ../src/guestfs.pod:2857
35557 #: ../src/guestfs.pod:2859
35558 msgid "Files used by the test suite."
35562 #: ../src/guestfs.pod:2861
35563 msgid "Some \"phony\" guest images which we test against."
35567 #: ../src/guestfs.pod:2863
35568 msgid "C<inspector>"
35572 #: ../src/guestfs.pod:2865
35573 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
35577 #: ../src/guestfs.pod:2867
35582 #: ../src/guestfs.pod:2869
35583 msgid "Logo used on the website. The fish is called Arthur by the way."
35587 #: ../src/guestfs.pod:2871
35592 #: ../src/guestfs.pod:2873
35593 msgid "M4 macros used by autoconf."
35597 #: ../src/guestfs.pod:2875
35602 #: ../src/guestfs.pod:2877
35603 msgid "Translations of simple gettext strings."
35607 #: ../src/guestfs.pod:2879
35612 #: ../src/guestfs.pod:2881
35614 "The build infrastructure and PO files for translations of manpages and POD "
35615 "files. Eventually this will be combined with the C<po> directory, but that "
35616 "is rather complicated."
35620 #: ../src/guestfs.pod:2885
35621 msgid "C<regressions>"
35625 #: ../src/guestfs.pod:2887
35626 msgid "Regression tests."
35630 #: ../src/guestfs.pod:2889
35635 #: ../src/guestfs.pod:2891
35636 msgid "L<virt-rescue(1)> command and documentation."
35640 #: ../src/guestfs.pod:2893
35645 #: ../src/guestfs.pod:2895
35646 msgid "L<virt-resize(1)> command and documentation."
35650 #: ../src/guestfs.pod:2897
35655 #: ../src/guestfs.pod:2899
35656 msgid "Source code to the C library."
35660 #: ../src/guestfs.pod:2901
35665 #: ../src/guestfs.pod:2903
35666 msgid "Command line tools written in Perl (L<virt-win-reg(1)> and many others)."
35670 #: ../src/guestfs.pod:2905
35671 msgid "C<test-tool>"
35675 #: ../src/guestfs.pod:2907
35677 "Test tool for end users to test if their qemu/kernel combination will work "
35682 #: ../src/guestfs.pod:2910
35687 #: ../src/guestfs.pod:2912
35692 #: ../src/guestfs.pod:2914
35697 #: ../src/guestfs.pod:2916
35702 #: ../src/guestfs.pod:2918
35707 #: ../src/guestfs.pod:2920
35712 #: ../src/guestfs.pod:2922
35717 #: ../src/guestfs.pod:2924
35722 #: ../src/guestfs.pod:2926
35723 msgid "Language bindings."
35727 #: ../src/guestfs.pod:2930
35728 msgid "MAKING A STABLE RELEASE"
35732 #: ../src/guestfs.pod:2932
35734 "When we make a stable release, there are several steps documented here. See "
35735 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
35740 #: ../src/guestfs.pod:2940
35741 msgid "Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
35745 #: ../src/guestfs.pod:2945
35746 msgid "Finalize RELEASE-NOTES."
35750 #: ../src/guestfs.pod:2949
35751 msgid "Update ROADMAP."
35755 #: ../src/guestfs.pod:2953
35756 msgid "Run C<src/api-support/update-from-tarballs.sh>."
35760 #: ../src/guestfs.pod:2957
35761 msgid "Push and pull from Transifex."
35765 #: ../src/guestfs.pod:2959
35770 #: ../src/guestfs.pod:2961
35778 #: ../src/guestfs.pod:2963
35779 msgid "to push the latest POT files to Transifex. Then run:"
35783 #: ../src/guestfs.pod:2965
35791 #: ../src/guestfs.pod:2967
35792 msgid "which is a wrapper to pull the latest translated C<*.po> files."
35796 #: ../src/guestfs.pod:2971
35798 "Create new stable and development directories under "
35799 "L<http://libguestfs.org/download>."
35803 #: ../src/guestfs.pod:2976
35804 msgid "Create the branch in git:"
35808 #: ../src/guestfs.pod:2978
35811 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
35812 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
35813 " git branch stable-1.XX\n"
35814 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
35819 #: ../src/guestfs.pod:2985
35824 #: ../src/guestfs.pod:2987
35825 msgid "PROTOCOL LIMITS"
35829 #: ../src/guestfs.pod:2989
35831 "Internally libguestfs uses a message-based protocol to pass API calls and "
35832 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
35833 "plenty more detail about this). The maximum message size used by the "
35834 "protocol is slightly less than 4 MB. For some API calls you may need to be "
35835 "aware of this limit. The API calls which may be affected are individually "
35836 "documented, with a link back to this section of the documentation."
35840 #: ../src/guestfs.pod:2997
35842 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
35843 "a simple string. Because this string is at some point internally encoded as "
35844 "a message, the maximum size that it can return is slightly under 4 MB. If "
35845 "the requested file is larger than this then you will get an error."
35849 #: ../src/guestfs.pod:3003
35851 "In order to transfer large files into and out of the guest filesystem, you "
35852 "need to use particular calls that support this. The sections L</UPLOADING> "
35853 "and L</DOWNLOADING> document how to do this."
35857 #: ../src/guestfs.pod:3007
35859 "You might also consider mounting the disk image using our FUSE filesystem "
35860 "support (L<guestmount(1)>)."
35864 #: ../src/guestfs.pod:3010
35865 msgid "MAXIMUM NUMBER OF DISKS"
35869 #: ../src/guestfs.pod:3012
35870 msgid "When using virtio disks (the default) the current limit is B<25> disks."
35874 #: ../src/guestfs.pod:3015
35876 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
35877 "slots. However febootstrap only understands disks with names C</dev/vda> "
35878 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
35883 #: ../src/guestfs.pod:3020
35885 "We are working to substantially raise this limit in future versions but it "
35886 "requires complex changes to qemu."
35890 #: ../src/guestfs.pod:3023
35892 "In future versions of libguestfs it should also be possible to \"hot plug\" "
35893 "disks (add and remove disks after calling L</guestfs_launch>). This also "
35894 "requires changes to qemu."
35898 #: ../src/guestfs.pod:3027
35899 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
35903 #: ../src/guestfs.pod:3029
35904 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
35908 #: ../src/guestfs.pod:3031
35910 "This is because it reserves 4 bits for the minor device number (thus "
35911 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
35915 #: ../src/guestfs.pod:3034
35917 "If you attach a disk with more than 15 partitions, the extra partitions are "
35918 "ignored by libguestfs."
35922 #: ../src/guestfs.pod:3037
35923 msgid "MAXIMUM SIZE OF A DISK"
35927 #: ../src/guestfs.pod:3039
35928 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
35932 #: ../src/guestfs.pod:3041
35934 "We have tested block devices up to 1 exabyte (2**60 or "
35935 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
35940 #: ../src/guestfs.pod:3045
35942 "Although libguestfs probably does not impose any limit, the underlying host "
35943 "storage will. If you store disk images on a host ext4 filesystem, then the "
35944 "maximum size will be limited by the maximum ext4 file size (currently 16 "
35945 "TB). If you store disk images as host logical volumes then you are limited "
35946 "by the maximum size of an LV."
35950 #: ../src/guestfs.pod:3051
35952 "For the hugest disk image files, we recommend using XFS on the host for "
35957 #: ../src/guestfs.pod:3054
35958 msgid "MAXIMUM SIZE OF A PARTITION"
35962 #: ../src/guestfs.pod:3056
35964 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
35965 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
35966 "address a partition located beyond 2 TB on the disk."
35970 #: ../src/guestfs.pod:3060
35972 "It is recommended that you use GPT partitions on disks which are larger than "
35973 "this size. GPT uses 64 bit sector numbers and so can address partitions "
35974 "which are theoretically larger than the largest disk we could support."
35978 #: ../src/guestfs.pod:3065
35979 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
35983 #: ../src/guestfs.pod:3067
35985 "This depends on the filesystem type. libguestfs itself does not impose any "
35986 "known limit. Consult Wikipedia or the filesystem documentation to find out "
35987 "what these limits are."
35991 #: ../src/guestfs.pod:3071
35992 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
35996 #: ../src/guestfs.pod:3073
35998 "The API functions L</guestfs_upload>, L</guestfs_download>, "
35999 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
36000 "uploads and downloads."
36004 #: ../src/guestfs.pod:3077
36005 msgid "INSPECTION LIMITS"
36009 #: ../src/guestfs.pod:3079
36011 "The inspection code has several arbitrary limits on things like the size of "
36012 "Windows Registry hive it will read, and the length of product name. These "
36013 "are intended to stop a malicious guest from consuming arbitrary amounts of "
36014 "memory and disk space on the host, and should not be reached in practice. "
36015 "See the source code for more information."
36019 #: ../src/guestfs.pod:3105
36021 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
36022 "effect as calling C<guestfs_set_verbose (g, 1)>."
36026 #: ../src/guestfs.pod:3117
36028 "Set the path that libguestfs uses to search for a supermin appliance. See "
36029 "the discussion of paths in section L</PATH> above."
36033 #: ../src/guestfs.pod:3126
36034 msgid "See also L</QEMU WRAPPERS> above."
36038 #: ../src/guestfs.pod:3130
36040 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
36041 "effect as calling C<guestfs_set_trace (g, 1)>."
36045 #: ../src/guestfs.pod:3148
36047 "L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, "
36048 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, "
36049 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
36050 "L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
36051 "L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
36052 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
36053 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
36054 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, "
36055 "L<febootstrap-supermin-helper(8)>, L<hivex(3)>, L<http://libguestfs.org/>."
36059 #: ../src/guestfs.pod:3179
36061 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
36062 "L<lvm(8)>, L<disktype(1)>."
36066 #: ../src/guestfs.pod:3186 ../tools/virt-make-fs.pl:553 ../tools/virt-win-reg.pl:761
36071 #: ../src/guestfs.pod:3188
36072 msgid "To get a list of bugs against libguestfs use this link:"
36076 #: ../src/guestfs.pod:3190
36077 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
36081 #: ../src/guestfs.pod:3192
36082 msgid "To report a new bug against libguestfs use this link:"
36086 #: ../src/guestfs.pod:3194
36087 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
36091 #: ../src/guestfs.pod:3196
36092 msgid "When reporting a bug, please check:"
36096 #: ../src/guestfs.pod:3202
36097 msgid "That the bug hasn't been reported already."
36101 #: ../src/guestfs.pod:3206
36102 msgid "That you are testing a recent version."
36106 #: ../src/guestfs.pod:3210
36107 msgid "Describe the bug accurately, and give a way to reproduce it."
36111 #: ../src/guestfs.pod:3214
36113 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
36118 #: ../test-tool/libguestfs-test-tool.pod:5
36119 msgid "libguestfs-test-tool - Diagnostics for libguestfs"
36123 #: ../test-tool/libguestfs-test-tool.pod:9
36126 " libguestfs-test-tool [--options]\n"
36131 #: ../test-tool/libguestfs-test-tool.pod:13
36133 "libguestfs-test-tool is a test program shipped with libguestfs to allow you "
36134 "to check basic libguestfs functionality is working. This is needed because "
36135 "libguestfs occasionally breaks for reasons beyond our control: usually "
36136 "because of changes in the underlying qemu or kernel packages, or the host "
36141 #: ../test-tool/libguestfs-test-tool.pod:19
36142 msgid "If you suspect a problem in libguestfs, then just run:"
36146 #: ../test-tool/libguestfs-test-tool.pod:21
36149 " libguestfs-test-tool\n"
36154 #: ../test-tool/libguestfs-test-tool.pod:23
36155 msgid "It will print lots of diagnostic messages."
36159 #: ../test-tool/libguestfs-test-tool.pod:25
36160 msgid "If it runs to completion successfully, you will see this near the end:"
36164 #: ../test-tool/libguestfs-test-tool.pod:27
36167 " ===== TEST FINISHED OK =====\n"
36172 #: ../test-tool/libguestfs-test-tool.pod:29
36173 msgid "and the test tool will exit with code 0."
36177 #: ../test-tool/libguestfs-test-tool.pod:31
36179 "If it fails (and/or exits with non-zero error code), please paste the "
36180 "I<complete, unedited> output of the test tool into a bug report. More "
36181 "information about reporting bugs can be found on the "
36182 "L<http://libguestfs.org/> website."
36186 #: ../test-tool/libguestfs-test-tool.pod:42
36187 msgid "Display short usage information and exit."
36191 #: ../test-tool/libguestfs-test-tool.pod:44
36192 msgid "B<--qemu qemu_binary>"
36196 #: ../test-tool/libguestfs-test-tool.pod:46
36198 "If you have downloaded another qemu binary, point this option at the full "
36199 "path of the binary to try it."
36203 #: ../test-tool/libguestfs-test-tool.pod:49
36204 msgid "B<--qemudir qemu_source_dir>"
36208 #: ../test-tool/libguestfs-test-tool.pod:51
36210 "If you have compiled qemu from source, point this option at the source "
36211 "directory to try it."
36215 #: ../test-tool/libguestfs-test-tool.pod:54
36220 #: ../test-tool/libguestfs-test-tool.pod:56
36221 msgid "B<--timeout N>"
36225 #: ../test-tool/libguestfs-test-tool.pod:58
36227 "Set the launch timeout to C<N> seconds. The default is 600 seconds (10 "
36228 "minutes) which does not usually need to be adjusted."
36232 #: ../test-tool/libguestfs-test-tool.pod:63
36233 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
36237 #: ../test-tool/libguestfs-test-tool.pod:65
36239 "If you have compiled another version of qemu from source and would like to "
36240 "try that, then you can use the I<--qemudir> option to point to the qemu "
36241 "source directory."
36245 #: ../test-tool/libguestfs-test-tool.pod:69
36247 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
36248 "option to point to the binary."
36252 #: ../test-tool/libguestfs-test-tool.pod:72
36254 "Note when using these options, you can ignore the business of qemu wrapper "
36255 "scripts (L<guestfs(3)/QEMU WRAPPERS>), since libguestfs-test-tool writes a "
36256 "wrapper script for you if one is needed."
36260 #: ../test-tool/libguestfs-test-tool.pod:76
36261 msgid "TRYING OUT A DIFFERENT KERNEL"
36265 #: ../test-tool/libguestfs-test-tool.pod:78
36267 "If you are using febootstrap E<ge> 3.8 then you can select which kernel "
36268 "libguestfs tries. You do this by setting the environment variables "
36269 "C<FEBOOTSTRAP_KERNEL> and/or C<FEBOOTSTRAP_MODULES>."
36273 #: ../test-tool/libguestfs-test-tool.pod:82
36275 "Refer to L<febootstrap-supermin-helper(8)/ENVIRONMENT VARIABLES> for further "
36280 #: ../test-tool/libguestfs-test-tool.pod:85
36281 msgid "SELF-DIAGNOSIS"
36285 #: ../test-tool/libguestfs-test-tool.pod:87
36287 "Refer to L<guestfs(3)/APPLIANCE BOOT PROCESS> to understand the messages "
36288 "produced by libguestfs-test-tool and/or possible errors."
36292 #: ../test-tool/libguestfs-test-tool.pod:92
36294 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
36295 "I<1> if there was an error."
36299 #: ../test-tool/libguestfs-test-tool.pod:97
36301 "For the full list of environment variables which may affect libguestfs, "
36302 "please see the L<guestfs(3)> manual page."
36306 #: ../test-tool/libguestfs-test-tool.pod:102
36307 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
36311 #: ../tools/virt-list-filesystems.pl:32
36312 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
36316 #: ../tools/virt-list-filesystems.pl:36
36319 " virt-list-filesystems [--options] domname\n"
36324 #: ../tools/virt-list-filesystems.pl:38
36327 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
36332 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
36334 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
36339 #: ../tools/virt-list-filesystems.pl:45
36341 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
36342 "are contained in a virtual machine or disk image."
36346 #: ../tools/virt-list-filesystems.pl:49
36348 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
36349 "functionality. For more complex cases you should look at the "
36350 "L<guestfish(1)> tool."
36354 #: ../tools/virt-list-filesystems.pl:112
36356 "With this option, C<virt-list-filesystems> displays the type of each "
36357 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
36361 #: ../tools/virt-list-filesystems.pl:119
36366 #: ../tools/virt-list-filesystems.pl:123
36368 "Normally we only show mountable filesystems. If this option is given then "
36369 "swap devices are shown too."
36373 #: ../tools/virt-list-filesystems.pl:197
36375 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
36376 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
36377 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
36381 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
36382 msgid "Copyright (C) 2009 Red Hat Inc."
36386 #: ../tools/virt-list-partitions.pl:32
36387 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
36391 #: ../tools/virt-list-partitions.pl:36
36394 " virt-list-partitions [--options] domname\n"
36399 #: ../tools/virt-list-partitions.pl:38
36402 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
36407 #: ../tools/virt-list-partitions.pl:45
36409 "C<virt-list-partitions> is a command line tool to list the partitions that "
36410 "are contained in a virtual machine or disk image. It is mainly useful as a "
36411 "first step to using L<virt-resize(1)>."
36415 #: ../tools/virt-list-partitions.pl:50
36417 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
36418 "functionality. For more complex cases you should look at the "
36419 "L<guestfish(1)> tool."
36423 #: ../tools/virt-list-partitions.pl:113
36424 msgid "Show sizes in human-readable form (eg. \"1G\")."
36428 #: ../tools/virt-list-partitions.pl:123
36430 "With this option, C<virt-list-partitions> displays the type and size of each "
36431 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
36435 #: ../tools/virt-list-partitions.pl:130
36440 #: ../tools/virt-list-partitions.pl:132
36445 #: ../tools/virt-list-partitions.pl:134
36446 msgid "Display the total size of each block device (as a separate row or rows)."
36450 #: ../tools/virt-list-partitions.pl:267
36452 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
36453 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
36454 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
36458 #: ../tools/virt-list-partitions.pl:283
36459 msgid "Copyright (C) 2009-2010 Red Hat Inc."
36463 #: ../tools/virt-make-fs.pl:37
36464 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
36468 #: ../tools/virt-make-fs.pl:41
36471 " virt-make-fs [--options] input.tar output.img\n"
36476 #: ../tools/virt-make-fs.pl:43
36479 " virt-make-fs [--options] input.tar.gz output.img\n"
36484 #: ../tools/virt-make-fs.pl:45
36487 " virt-make-fs [--options] directory output.img\n"
36492 #: ../tools/virt-make-fs.pl:49
36494 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
36495 "archive or some files in a directory. It is similar to tools like "
36496 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
36497 "it can create common filesystem types like ext2/3 or NTFS, which can be "
36498 "useful if you want to attach these filesystems to existing virtual machines "
36499 "(eg. to import large amounts of read-only data to a VM)."
36503 #: ../tools/virt-make-fs.pl:57
36504 msgid "Basic usage is:"
36508 #: ../tools/virt-make-fs.pl:59
36511 " virt-make-fs input output\n"
36516 #: ../tools/virt-make-fs.pl:61
36518 "where C<input> is either a directory containing files that you want to add, "
36519 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
36520 "C<output> is a disk image. The input type is detected automatically. The "
36521 "output disk image defaults to a raw ext2 image unless you specify extra "
36522 "flags (see L</OPTIONS> below)."
36526 #: ../tools/virt-make-fs.pl:67
36527 msgid "EXTRA SPACE"
36531 #: ../tools/virt-make-fs.pl:69
36533 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
36534 "the files that it contains, but might have extra space. Depending on how "
36535 "you are going to use the output, you might think this extra space is wasted "
36536 "and want to minimize it, or you might want to leave space so that more files "
36537 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
36538 "but you can use the I<--size> flag to leave space in the filesystem if you "
36543 #: ../tools/virt-make-fs.pl:77
36545 "An alternative way to leave extra space but not make the output image any "
36546 "bigger is to use an alternative disk image format (instead of the default "
36547 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
36548 "image format (check your hypervisor supports this before using it). This "
36549 "allows you to choose a large I<--size> but the extra space won't actually be "
36550 "allocated in the image until you try to store something in it."
36554 #: ../tools/virt-make-fs.pl:85
36556 "Don't forget that you can also use local commands including L<resize2fs(8)> "
36557 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
36558 "to build another image from scratch."
36562 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
36567 #: ../tools/virt-make-fs.pl:91
36570 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
36575 #: ../tools/virt-make-fs.pl:93
36576 msgid "FILESYSTEM TYPE"
36580 #: ../tools/virt-make-fs.pl:95
36582 "The default filesystem type is C<ext2>. Just about any filesystem type that "
36583 "libguestfs supports can be used (but I<not> read-only formats like "
36584 "ISO9660). Here are some of the more common choices:"
36588 #: ../tools/virt-make-fs.pl:101
36593 #: ../tools/virt-make-fs.pl:103
36595 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
36596 "you are not going to use the filesystem in a way that requires the journal, "
36597 "then this is just wasted overhead."
36601 #: ../tools/virt-make-fs.pl:107
36602 msgid "I<ntfs> or I<vfat>"
36606 #: ../tools/virt-make-fs.pl:109
36607 msgid "Useful if exporting data to a Windows guest."
36611 #: ../tools/virt-make-fs.pl:111
36613 "I<Note for vfat>: The tar archive or local directory must only contain files "
36614 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
36615 "program running within libguestfs is unable to change the ownership of "
36616 "non-root files, since vfat itself does not support this."
36620 #: ../tools/virt-make-fs.pl:116
36625 #: ../tools/virt-make-fs.pl:118
36627 "Lower overhead than C<ext2>, but certain limitations on filename length and "
36628 "total filesystem size."
36632 #: ../tools/virt-make-fs.pl:125
36635 " virt-make-fs --type=minix input minixfs.img\n"
36640 #: ../tools/virt-make-fs.pl:127
36641 msgid "TO PARTITION OR NOT TO PARTITION"
36645 #: ../tools/virt-make-fs.pl:129
36646 msgid "Optionally virt-make-fs can add a partition table to the output disk."
36650 #: ../tools/virt-make-fs.pl:131
36652 "Adding a partition can make the disk image more compatible with certain "
36653 "virtualized operating systems which don't expect to see a filesystem "
36654 "directly located on a block device (Linux doesn't care and will happily "
36655 "handle both types)."
36659 #: ../tools/virt-make-fs.pl:136
36661 "On the other hand, if you have a partition table then the output image is no "
36662 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
36663 "directly on a partitioned disk image. (However libguestfs tools such as "
36664 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
36668 #: ../tools/virt-make-fs.pl:144
36669 msgid "Add an MBR partition:"
36673 #: ../tools/virt-make-fs.pl:146
36676 " virt-make-fs --partition -- input disk.img\n"
36681 #: ../tools/virt-make-fs.pl:148
36683 "If the output disk image could be terabyte-sized or larger, it's better to "
36684 "use an EFI/GPT-compatible partition table:"
36688 #: ../tools/virt-make-fs.pl:151
36691 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
36696 #: ../tools/virt-make-fs.pl:179
36697 msgid "Enable debugging information."
36701 #: ../tools/virt-make-fs.pl:185
36702 msgid "B<--size=E<lt>NE<gt>>"
36706 #: ../tools/virt-make-fs.pl:187
36707 msgid "B<--size=+E<lt>NE<gt>>"
36711 #: ../tools/virt-make-fs.pl:189
36712 msgid "B<-s E<lt>NE<gt>>"
36716 #: ../tools/virt-make-fs.pl:191
36717 msgid "B<-s +E<lt>NE<gt>>"
36721 #: ../tools/virt-make-fs.pl:193
36722 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
36726 #: ../tools/virt-make-fs.pl:196
36728 "If this option is I<not> given, then the output image will be just large "
36729 "enough to contain all the files, with not much wasted space."
36733 #: ../tools/virt-make-fs.pl:199
36735 "To choose a fixed size output disk, specify an absolute number followed by "
36736 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
36737 "Petabytes or Exabytes. This must be large enough to contain all the input "
36738 "files, else you will get an error."
36742 #: ../tools/virt-make-fs.pl:204
36744 "To leave extra space, specify C<+> (plus sign) and a number followed by "
36745 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
36746 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
36747 "the input files, and (approximately) an extra 200 MB free space."
36751 #: ../tools/virt-make-fs.pl:210
36753 "Note that virt-make-fs estimates free space, and therefore will not produce "
36754 "filesystems containing precisely the free space requested. (It is much more "
36755 "expensive and time-consuming to produce a filesystem which has precisely the "
36756 "desired free space)."
36760 #: ../tools/virt-make-fs.pl:219
36761 msgid "B<--format=E<lt>fmtE<gt>>"
36765 #: ../tools/virt-make-fs.pl:221
36766 msgid "B<-F E<lt>fmtE<gt>>"
36770 #: ../tools/virt-make-fs.pl:223
36771 msgid "Choose the output disk image format."
36775 #: ../tools/virt-make-fs.pl:225
36776 msgid "The default is C<raw> (raw disk image)."
36780 #: ../tools/virt-make-fs.pl:227
36782 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
36783 "that would really make sense here is C<qcow2>."
36787 #: ../tools/virt-make-fs.pl:234
36788 msgid "B<--type=E<lt>fsE<gt>>"
36792 #: ../tools/virt-make-fs.pl:236
36793 msgid "B<-t E<lt>fsE<gt>>"
36797 #: ../tools/virt-make-fs.pl:238
36798 msgid "Choose the output filesystem type."
36802 #: ../tools/virt-make-fs.pl:240
36803 msgid "The default is C<ext2>."
36807 #: ../tools/virt-make-fs.pl:242
36808 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
36812 #: ../tools/virt-make-fs.pl:249
36813 msgid "B<--partition>"
36817 #: ../tools/virt-make-fs.pl:251
36818 msgid "B<--partition=E<lt>parttypeE<gt>>"
36822 #: ../tools/virt-make-fs.pl:253
36824 "If specified, this flag adds an MBR partition table to the output disk "
36829 #: ../tools/virt-make-fs.pl:256
36831 "You can change the partition table type, eg. I<--partition=gpt> for large "
36836 #: ../tools/virt-make-fs.pl:259
36838 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
36839 "might consider the next parameter to be the partition type. For example:"
36843 #: ../tools/virt-make-fs.pl:263
36846 " virt-make-fs --partition input.tar ...\n"
36851 #: ../tools/virt-make-fs.pl:265
36853 "would cause virt-make-fs to think you wanted to use a partition type of "
36854 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
36855 "dash) between options and the input file argument:"
36859 #: ../tools/virt-make-fs.pl:269
36862 " virt-make-fs --partition -- input.tar ...\n"
36867 #: ../tools/virt-make-fs.pl:541
36869 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
36870 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
36871 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
36875 #: ../tools/virt-make-fs.pl:555 ../tools/virt-win-reg.pl:763
36877 "When reporting bugs, please enable debugging and capture the I<complete> "
36882 #: ../tools/virt-make-fs.pl:558
36885 " export LIBGUESTFS_DEBUG=1\n"
36886 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
36891 #: ../tools/virt-make-fs.pl:561
36893 "Attach /tmp/virt-make-fs.log to a new bug report at "
36894 "L<https://bugzilla.redhat.com/>"
36898 #: ../tools/virt-tar.pl:33
36899 msgid "virt-tar - Extract or upload files to a virtual machine"
36903 #: ../tools/virt-tar.pl:37
36906 " virt-tar [--options] -x domname directory tarball\n"
36911 #: ../tools/virt-tar.pl:39
36914 " virt-tar [--options] -u domname tarball directory\n"
36919 #: ../tools/virt-tar.pl:41
36922 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
36927 #: ../tools/virt-tar.pl:43
36930 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
36935 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
36940 #: ../tools/virt-tar.pl:47
36942 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
36943 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
36947 #: ../tools/virt-tar.pl:52
36948 msgid "Download C</home> from the VM into a local tarball:"
36952 #: ../tools/virt-tar.pl:54
36955 " virt-tar -x domname /home home.tar\n"
36960 #: ../tools/virt-tar.pl:56
36963 " virt-tar -zx domname /home home.tar.gz\n"
36968 #: ../tools/virt-tar.pl:58
36969 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
36973 #: ../tools/virt-tar.pl:60
36976 " virt-tar -u domname uploadstuff.tar /tmp\n"
36981 #: ../tools/virt-tar.pl:62
36984 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
36989 #: ../tools/virt-tar.pl:66
36991 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
36992 "virtual machines. If you do this, you risk disk corruption in the VM. "
36993 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
36997 #: ../tools/virt-tar.pl:71
36999 "You can use I<-x> (extract) on live virtual machines, but you might get "
37000 "inconsistent results or errors if there is filesystem activity inside the "
37001 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
37002 "work, but the only way to guarantee consistent results is if the virtual "
37003 "machine is shut down."
37007 #: ../tools/virt-tar.pl:79
37009 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
37010 "parts of a guest filesystem. There are many possibilities: making backups, "
37011 "uploading data files, snooping on guest activity, fixing or customizing "
37016 #: ../tools/virt-tar.pl:84
37018 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
37019 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
37020 "should look at the L<guestfish(1)> tool."
37024 #: ../tools/virt-tar.pl:88
37026 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
37027 "its contents (recursively) from the virtual machine into a local tarball. "
37028 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
37029 "virtual machine. You cannot use these two options together."
37033 #: ../tools/virt-tar.pl:94
37035 "In addition, you may need to use the I<-z> (gZip) option to enable "
37036 "compression. When uploading, you have to specify I<-z> if the upload file "
37037 "is compressed because virt-tar won't detect this on its own."
37041 #: ../tools/virt-tar.pl:98
37043 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
37044 "example it cannot do PKZip files or bzip2 compression. If you want that "
37045 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
37046 "the L<libguestfs(3)> API)."
37050 #: ../tools/virt-tar.pl:160
37051 msgid "B<--extract>"
37055 #: ../tools/virt-tar.pl:162
37056 msgid "B<--download>"
37060 #: ../tools/virt-tar.pl:164
37065 #: ../tools/virt-tar.pl:166
37066 msgid "B<--upload>"
37070 #: ../tools/virt-tar.pl:168
37072 "Use I<-x> to extract (download) a directory from a virtual machine to a "
37077 #: ../tools/virt-tar.pl:171
37079 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
37080 "Please read the L</WARNING> section above before using this option."
37084 #: ../tools/virt-tar.pl:175
37085 msgid "You must specify exactly one of these options."
37089 #: ../tools/virt-tar.pl:181
37094 #: ../tools/virt-tar.pl:183
37099 #: ../tools/virt-tar.pl:185
37100 msgid "Specify that the input or output tarball is gzip-compressed."
37104 #: ../tools/virt-tar.pl:298
37106 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
37107 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
37108 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
37109 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
37113 #: ../tools/virt-win-reg.pl:37
37115 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
37120 #: ../tools/virt-win-reg.pl:41
37123 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
37128 #: ../tools/virt-win-reg.pl:43
37131 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
37136 #: ../tools/virt-win-reg.pl:45
37139 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
37144 #: ../tools/virt-win-reg.pl:47
37147 " virt-win-reg --merge domname [input.reg ...]\n"
37152 #: ../tools/virt-win-reg.pl:49
37155 " virt-win-reg [--options] disk.img ... # instead of domname\n"
37160 #: ../tools/virt-win-reg.pl:53
37162 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
37163 "virtual machines. If you do this, you I<will> get irreversible disk "
37164 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
37165 "but doesn't catch all cases."
37169 #: ../tools/virt-win-reg.pl:58
37171 "Modifying the Windows Registry is an inherently risky operation. The format "
37172 "is deliberately obscure and undocumented, and Registry changes can leave the "
37173 "system unbootable. Therefore when using the I<--merge> option, make sure "
37174 "you have a reliable backup first."
37178 #: ../tools/virt-win-reg.pl:65
37180 "This program can export and merge Windows Registry entries from a Windows "
37185 #: ../tools/virt-win-reg.pl:68
37187 "The first parameter is the libvirt guest name or the raw disk image of a "
37192 #: ../tools/virt-win-reg.pl:71
37194 "If I<--merge> is I<not> specified, then the chosen registry key is "
37195 "displayed/exported (recursively). For example:"
37199 #: ../tools/virt-win-reg.pl:74
37202 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
37207 #: ../tools/virt-win-reg.pl:76
37208 msgid "You can also display single values from within registry keys, for example:"
37212 #: ../tools/virt-win-reg.pl:79
37215 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
37216 " $ virt-win-reg Windows7 $cvkey ProductName\n"
37217 " Windows 7 Enterprise\n"
37222 #: ../tools/virt-win-reg.pl:83
37224 "With I<--merge>, you can merge a textual regedit file into the Windows "
37229 #: ../tools/virt-win-reg.pl:86
37232 " $ virt-win-reg --merge Windows7 changes.reg\n"
37237 #: ../tools/virt-win-reg.pl:90
37239 "This program is only meant for simple access to the registry. If you want "
37240 "to do complicated things with the registry, we suggest you download the "
37241 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
37242 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
37243 "L<hivexregedit(1)>."
37247 #: ../tools/virt-win-reg.pl:159
37252 #: ../tools/virt-win-reg.pl:161
37254 "In merge mode, this merges a textual regedit file into the Windows Registry "
37255 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
37256 "displays or exports Registry entries instead."
37260 #: ../tools/virt-win-reg.pl:165
37262 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
37263 "result in disk corruption. However exporting (without this flag) is always "
37268 #: ../tools/virt-win-reg.pl:173
37269 msgid "B<--encoding> UTF-16LE|ASCII"
37273 #: ../tools/virt-win-reg.pl:175
37275 "When merging (only), you may need to specify the encoding for strings to be "
37276 "used in the hive file. This is explained in detail in "
37277 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
37281 #: ../tools/virt-win-reg.pl:179
37283 "The default is to use UTF-16LE, which should work with recent versions of "
37288 #: ../tools/virt-win-reg.pl:186
37289 msgid "B<--unsafe-printable-strings>"
37293 #: ../tools/virt-win-reg.pl:188
37295 "When exporting (only), assume strings are UTF-16LE and print them as strings "
37296 "instead of hex sequences. Remove the final zero codepoint from strings if "
37301 #: ../tools/virt-win-reg.pl:192
37303 "This is unsafe and does not preserve the fidelity of strings in the original "
37304 "Registry for various reasons:"
37308 #: ../tools/virt-win-reg.pl:199
37310 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
37311 "other encodings will be corrupted by this transformation."
37315 #: ../tools/virt-win-reg.pl:204
37317 "Assumes that everything which has type 1 or 2 is really a string and that "
37318 "everything else is not a string, but the type field in real Registries is "
37323 #: ../tools/virt-win-reg.pl:210
37325 "Loses information about whether a zero codepoint followed the string in the "
37330 #: ../tools/virt-win-reg.pl:215
37332 "This all happens because the Registry itself contains no information about "
37333 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
37337 #: ../tools/virt-win-reg.pl:219
37339 "You should only use this option for quick hacking and debugging of the "
37340 "Registry contents, and I<never> use it if the output is going to be passed "
37341 "into another program or stored in another Registry."
37345 #: ../tools/virt-win-reg.pl:556
37346 msgid "SUPPORTED SYSTEMS"
37350 #: ../tools/virt-win-reg.pl:558
37352 "The program currently supports Windows NT-derived guests starting with "
37353 "Windows XP through to at least Windows 7."
37357 #: ../tools/virt-win-reg.pl:561
37358 msgid "The following Registry keys are supported:"
37362 #: ../tools/virt-win-reg.pl:565
37363 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
37367 #: ../tools/virt-win-reg.pl:567
37368 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
37372 #: ../tools/virt-win-reg.pl:569
37373 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
37377 #: ../tools/virt-win-reg.pl:571
37378 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
37382 #: ../tools/virt-win-reg.pl:573
37383 msgid "C<HKEY_USERS\\.DEFAULT>"
37387 #: ../tools/virt-win-reg.pl:575
37388 msgid "C<HKEY_USERS\\I<SID>>"
37392 #: ../tools/virt-win-reg.pl:577
37393 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
37397 #: ../tools/virt-win-reg.pl:579
37398 msgid "C<HKEY_USERS\\I<username>>"
37402 #: ../tools/virt-win-reg.pl:581
37403 msgid "where I<username> is a local user name (this is a libguestfs extension)."
37407 #: ../tools/virt-win-reg.pl:585
37409 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
37414 #: ../tools/virt-win-reg.pl:588
37416 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
37417 "supported (there is no \"current user\")."
37421 #: ../tools/virt-win-reg.pl:591
37426 #: ../tools/virt-win-reg.pl:593
37428 "C<virt-win-reg> expects that regedit files have already been reencoded in "
37429 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
37430 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
37431 "with Windows-style line endings, you may need to reencode the whole file "
37432 "before or after processing."
37436 #: ../tools/virt-win-reg.pl:599
37438 "To reencode a file from Windows format to Linux (before processing it with "
37439 "the I<--merge> option), you would do something like this:"
37443 #: ../tools/virt-win-reg.pl:602
37446 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
37451 #: ../tools/virt-win-reg.pl:604
37453 "To go in the opposite direction, after exporting and before sending the file "
37454 "to a Windows user, do something like this:"
37458 #: ../tools/virt-win-reg.pl:607
37461 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
37466 #: ../tools/virt-win-reg.pl:609
37467 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
37471 #: ../tools/virt-win-reg.pl:611
37473 "If you are unsure about the current encoding, use the L<file(1)> command. "
37474 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
37475 "Windows-style (CRLF) line endings, like this:"
37479 #: ../tools/virt-win-reg.pl:615
37482 " $ file software.reg\n"
37483 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
37484 " with CRLF line terminators\n"
37489 #: ../tools/virt-win-reg.pl:619
37490 msgid "This file would need conversion before you could I<--merge> it."
37494 #: ../tools/virt-win-reg.pl:621
37495 msgid "CurrentControlSet etc."
37499 #: ../tools/virt-win-reg.pl:623
37501 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
37502 "Registry at the level of the hive file, and therefore you cannot modify "
37507 #: ../tools/virt-win-reg.pl:627
37509 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
37510 "circumstances it might refer to another control set. The way to find out is "
37511 "to look at the C<HKLM\\SYSTEM\\Select> key:"
37515 #: ../tools/virt-win-reg.pl:631
37518 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
37519 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
37520 " \"Current\"=dword:00000001\n"
37521 " \"Default\"=dword:00000001\n"
37522 " \"Failed\"=dword:00000000\n"
37523 " \"LastKnownGood\"=dword:00000002\n"
37528 #: ../tools/virt-win-reg.pl:638
37529 msgid "\"Current\" is the one which Windows will choose when it boots."
37533 #: ../tools/virt-win-reg.pl:640
37534 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
37538 #: ../tools/virt-win-reg.pl:643
37539 msgid "WINDOWS TIPS"
37543 #: ../tools/virt-win-reg.pl:645
37545 "Note that some of these tips modify the guest disk image. The guest I<must> "
37546 "be shut off, else you will get disk corruption."
37550 #: ../tools/virt-win-reg.pl:648
37551 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
37555 #: ../tools/virt-win-reg.pl:650
37557 "Prepare a DOS batch script, VBScript or executable. Upload this using "
37558 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
37559 "is uploaded into C<C:\\>:"
37563 #: ../tools/virt-win-reg.pl:654
37566 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
37571 #: ../tools/virt-win-reg.pl:656
37572 msgid "Prepare a regedit file containing the registry change:"
37576 #: ../tools/virt-win-reg.pl:658
37579 " cat > test.reg <<'EOF'\n"
37580 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
37581 " \"Test\"=\"c:\\\\test.bat\"\n"
37587 #: ../tools/virt-win-reg.pl:663
37589 "In this example we use the key C<RunOnce> which means that the script will "
37590 "run precisely once when the first user logs in. If you want it to run every "
37591 "time a user logs in, replace C<RunOnce> with C<Run>."
37595 #: ../tools/virt-win-reg.pl:667
37596 msgid "Now update the registry:"
37600 #: ../tools/virt-win-reg.pl:669
37603 " virt-win-reg --merge WindowsGuest test.reg\n"
37608 #: ../tools/virt-win-reg.pl:671
37609 msgid "INSTALLING A SERVICE"
37613 #: ../tools/virt-win-reg.pl:673
37615 "This section assumes you are familiar with Windows services, and you either "
37616 "have a program which handles the Windows Service Control Protocol directly "
37617 "or you want to run any program using a service wrapper like SrvAny or the "
37622 #: ../tools/virt-win-reg.pl:678
37624 "First upload the program and optionally the service wrapper. In this case "
37625 "the test program is called C<test.exe> and we are using the RHSrvAny "
37630 #: ../tools/virt-win-reg.pl:682
37633 " guestfish -i -d WindowsGuest <<EOF\n"
37634 " upload rhsrvany.exe /rhsrvany.exe\n"
37635 " upload test.exe /test.exe\n"
37641 #: ../tools/virt-win-reg.pl:687
37643 "Prepare a regedit file containing the registry changes. In this example, "
37644 "the first registry change is needed for the service itself or the service "
37645 "wrapper (if used). The second registry change is only needed because I am "
37646 "using the RHSrvAny service wrapper."
37650 #: ../tools/virt-win-reg.pl:692
37653 " cat > service.reg <<'EOF'\n"
37654 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
37655 " \"Type\"=dword:00000010\n"
37656 " \"Start\"=dword:00000002\n"
37657 " \"ErrorControl\"=dword:00000001\n"
37658 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
37659 " \"DisplayName\"=\"RHSrvAny\"\n"
37660 " \"ObjectName\"=\"NetworkService\"\n"
37665 #: ../tools/virt-win-reg.pl:701
37668 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
37669 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
37670 " \"PWD\"=\"c:\\\\Temp\"\n"
37676 #: ../tools/virt-win-reg.pl:712
37678 "For use of C<ControlSet001> see the section above in this manual page. You "
37679 "may need to adjust this according to the control set that is in use by the "
37684 #: ../tools/virt-win-reg.pl:718
37686 "C<\"ObjectName\"> controls the privileges that the service will have. An "
37687 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
37688 "privileged account."
37692 #: ../tools/virt-win-reg.pl:724
37694 "For the meaning of the magic numbers, see this Microsoft KB article: "
37695 "L<http://support.microsoft.com/kb/103000>."
37699 #: ../tools/virt-win-reg.pl:729
37700 msgid "Update the registry:"
37704 #: ../tools/virt-win-reg.pl:731
37707 " virt-win-reg --merge WindowsGuest service.reg\n"
37712 #: ../tools/virt-win-reg.pl:735
37714 "Be careful when passing parameters containing C<\\> (backslash) in the "
37715 "shell. Usually you will have to use 'single quotes' or double backslashes "
37716 "(but not both) to protect them from the shell."
37720 #: ../tools/virt-win-reg.pl:739
37721 msgid "Paths and value names are case-insensitive."
37725 #: ../tools/virt-win-reg.pl:748
37727 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
37728 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
37729 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
37730 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
37734 #: ../tools/virt-win-reg.pl:766
37737 " export LIBGUESTFS_DEBUG=1\n"
37738 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
37743 #: ../tools/virt-win-reg.pl:769
37745 "Attach /tmp/virt-win-reg.log to a new bug report at "
37746 "L<https://bugzilla.redhat.com/>"