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.4\n"
10 "Report-Msgid-Bugs-To: libguestfs@redhat.com\n"
11 "POT-Creation-Date: 2011-08-17 13:52+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:1018 ../fish/virt-copy-in.pod:29 ../fish/virt-copy-out.pod:21 ../fish/virt-tar-in.pod:30 ../fish/virt-tar-out.pod:24 ../fuse/guestmount.pod:39 ../resize/virt-resize.pod:27 ../tools/virt-tar.pl:50
106 #: ../cat/virt-cat.pod:34
107 msgid "Display C</etc/fstab> file from inside the libvirt VM called C<mydomain>:"
111 #: ../cat/virt-cat.pod:37
114 " virt-cat -d mydomain /etc/fstab\n"
119 #: ../cat/virt-cat.pod:39
120 msgid "List syslog messages from a VM disk image file:"
124 #: ../cat/virt-cat.pod:41
127 " virt-cat -a disk.img /var/log/messages | tail\n"
132 #: ../cat/virt-cat.pod:43
133 msgid "Find out what DHCP IP address a VM acquired:"
137 #: ../cat/virt-cat.pod:45
140 " virt-cat -d mydomain /var/log/messages | \\\n"
141 " grep 'dhclient: bound to' | tail\n"
146 #: ../cat/virt-cat.pod:48
147 msgid "Find out what packages were recently installed:"
151 #: ../cat/virt-cat.pod:50
154 " virt-cat -d mydomain /var/log/yum.log | tail\n"
159 #: ../cat/virt-cat.pod:52
160 msgid "Find out who is logged on inside a virtual machine:"
164 #: ../cat/virt-cat.pod:54
167 " virt-cat -d mydomain /var/run/utmp > /tmp/utmp\n"
173 #: ../cat/virt-cat.pod:57
174 msgid "or who was logged on:"
178 #: ../cat/virt-cat.pod:59
181 " virt-cat -d mydomain /var/log/wtmp > /tmp/wtmp\n"
182 " last -f /tmp/wtmp\n"
187 #: ../cat/virt-cat.pod:62 ../cat/virt-filesystems.pod:91 ../cat/virt-ls.pod:261 ../df/virt-df.pod:59 ../edit/virt-edit.pod:62 ../fish/guestfish.pod:148 ../fish/virt-copy-in.pod:45 ../fish/virt-copy-out.pod:34 ../fish/virt-tar-in.pod:42 ../fish/virt-tar-out.pod:36 ../fuse/guestmount.pod:83 ../inspector/virt-inspector.pod:55 ../rescue/virt-rescue.pod:84 ../resize/virt-resize.pod:241 ../test-tool/libguestfs-test-tool.pod:37 ../tools/virt-list-filesystems.pl:53 ../tools/virt-list-partitions.pl:54 ../tools/virt-make-fs.pl:153 ../tools/virt-tar.pl:103 ../tools/virt-win-reg.pl:96
192 #: ../cat/virt-cat.pod:66 ../cat/virt-filesystems.pod:95 ../cat/virt-ls.pod:265 ../df/virt-df.pod:63 ../edit/virt-edit.pod:66 ../fish/guestfish.pod:152 ../fuse/guestmount.pod:151 ../inspector/virt-inspector.pod:59 ../rescue/virt-rescue.pod:88 ../resize/virt-resize.pod:245 ../tools/virt-list-filesystems.pl:61 ../tools/virt-list-partitions.pl:62 ../tools/virt-make-fs.pl:161 ../tools/virt-tar.pl:111 ../tools/virt-win-reg.pl:104
197 #: ../cat/virt-cat.pod:68 ../cat/virt-filesystems.pod:97 ../cat/virt-ls.pod:267 ../df/virt-df.pod:65 ../edit/virt-edit.pod:68 ../inspector/virt-inspector.pod:61 ../rescue/virt-rescue.pod:90 ../tools/virt-list-filesystems.pl:63 ../tools/virt-list-partitions.pl:64 ../tools/virt-make-fs.pl:163 ../tools/virt-tar.pl:113 ../tools/virt-win-reg.pl:106
198 msgid "Display brief help."
202 #: ../cat/virt-cat.pod:70 ../cat/virt-filesystems.pod:99 ../cat/virt-ls.pod:269 ../df/virt-df.pod:67 ../edit/virt-edit.pod:70 ../inspector/virt-inspector.pod:63 ../rescue/virt-rescue.pod:92
207 #: ../cat/virt-cat.pod:72 ../cat/virt-filesystems.pod:101 ../cat/virt-ls.pod:271 ../df/virt-df.pod:69 ../edit/virt-edit.pod:72 ../inspector/virt-inspector.pod:65 ../rescue/virt-rescue.pod:94
208 msgid "B<--add> file"
212 #: ../cat/virt-cat.pod:74 ../cat/virt-filesystems.pod:103 ../cat/virt-ls.pod:273 ../df/virt-df.pod:71 ../edit/virt-edit.pod:74 ../inspector/virt-inspector.pod:67 ../rescue/virt-rescue.pod:96
214 "Add I<file> which should be a disk image from a virtual machine. If the "
215 "virtual machine has multiple block devices, you must supply all of them with "
216 "separate I<-a> options."
220 #: ../cat/virt-cat.pod:78 ../cat/virt-filesystems.pod:107 ../cat/virt-ls.pod:277 ../df/virt-df.pod:75 ../edit/virt-edit.pod:78 ../fish/guestfish.pod:174 ../fuse/guestmount.pod:93 ../inspector/virt-inspector.pod:71 ../rescue/virt-rescue.pod:100
222 "The format of the disk image is auto-detected. To override this and force a "
223 "particular format use the I<--format=..> option."
227 #: ../cat/virt-cat.pod:81 ../cat/virt-filesystems.pod:125 ../cat/virt-ls.pod:291 ../df/virt-df.pod:78 ../rescue/virt-rescue.pod:107
232 #: ../cat/virt-cat.pod:83 ../cat/virt-filesystems.pod:127 ../cat/virt-ls.pod:293 ../df/virt-df.pod:80 ../rescue/virt-rescue.pod:109
233 msgid "B<--connect> URI"
237 #: ../cat/virt-cat.pod:85 ../cat/virt-filesystems.pod:129 ../cat/virt-ls.pod:295 ../df/virt-df.pod:82 ../edit/virt-edit.pod:99 ../inspector/virt-inspector.pod:78 ../rescue/virt-rescue.pod:111 ../tools/virt-list-filesystems.pl:81 ../tools/virt-list-partitions.pl:82 ../tools/virt-tar.pl:131 ../tools/virt-win-reg.pl:132
239 "If using libvirt, connect to the given I<URI>. If omitted, then we connect "
240 "to the default libvirt hypervisor."
244 #: ../cat/virt-cat.pod:88 ../cat/virt-filesystems.pod:132 ../cat/virt-ls.pod:298 ../df/virt-df.pod:85 ../rescue/virt-rescue.pod:114
246 "If you specify guest block devices directly (I<-a>), then libvirt is not "
251 #: ../cat/virt-cat.pod:91 ../cat/virt-filesystems.pod:141 ../cat/virt-ls.pod:307 ../df/virt-df.pod:94 ../edit/virt-edit.pod:105 ../inspector/virt-inspector.pod:85 ../rescue/virt-rescue.pod:117
256 #: ../cat/virt-cat.pod:93 ../cat/virt-filesystems.pod:143 ../cat/virt-ls.pod:309 ../df/virt-df.pod:96 ../edit/virt-edit.pod:107 ../inspector/virt-inspector.pod:87 ../rescue/virt-rescue.pod:119
257 msgid "B<--domain> guest"
261 #: ../cat/virt-cat.pod:95 ../cat/virt-filesystems.pod:145 ../cat/virt-ls.pod:311 ../df/virt-df.pod:98 ../edit/virt-edit.pod:109 ../inspector/virt-inspector.pod:89 ../rescue/virt-rescue.pod:121
263 "Add all the disks from the named libvirt guest. Domain UUIDs can be used "
268 #: ../cat/virt-cat.pod:98 ../cat/virt-filesystems.pod:148 ../cat/virt-ls.pod:314 ../edit/virt-edit.pod:112 ../fish/guestfish.pod:217 ../fuse/guestmount.pod:126 ../inspector/virt-inspector.pod:92
269 msgid "B<--echo-keys>"
273 #: ../cat/virt-cat.pod:100
275 "When prompting for keys and passphrases, virt-cat normally turns echoing off "
276 "so you cannot see what you are typing. If you are not worried about Tempest "
277 "attacks and there is no one else in the room you can specify this flag to "
278 "see what you are typing."
282 #: ../cat/virt-cat.pod:105 ../cat/virt-filesystems.pod:170 ../cat/virt-ls.pod:328 ../df/virt-df.pod:101 ../fish/guestfish.pod:233 ../fuse/guestmount.pod:133 ../inspector/virt-inspector.pod:99 ../rescue/virt-rescue.pod:124
283 msgid "B<--format=raw|qcow2|..>"
287 #: ../cat/virt-cat.pod:107 ../cat/virt-filesystems.pod:172 ../cat/virt-ls.pod:330 ../df/virt-df.pod:103 ../edit/virt-edit.pod:134 ../fish/guestfish.pod:235 ../fuse/guestmount.pod:135 ../inspector/virt-inspector.pod:101 ../rescue/virt-rescue.pod:126
292 #: ../cat/virt-cat.pod:109 ../cat/virt-filesystems.pod:174 ../cat/virt-ls.pod:332 ../df/virt-df.pod:105 ../edit/virt-edit.pod:136 ../fish/guestfish.pod:237 ../fuse/guestmount.pod:137 ../rescue/virt-rescue.pod:128
294 "The default for the I<-a> option is to auto-detect the format of the disk "
295 "image. Using this forces the disk format for I<-a> options which follow on "
296 "the command line. Using I<--format> with no argument switches back to "
297 "auto-detection for subsequent I<-a> options."
301 #: ../cat/virt-cat.pod:114 ../cat/virt-filesystems.pod:179 ../cat/virt-ls.pod:337 ../df/virt-df.pod:110 ../edit/virt-edit.pod:141 ../fish/guestfish.pod:242 ../fish/guestfish.pod:673 ../inspector/virt-inspector.pod:335 ../rescue/virt-rescue.pod:133 ../src/guestfs.pod:2652
306 #: ../cat/virt-cat.pod:116
309 " virt-cat --format=raw -a disk.img file\n"
314 #: ../cat/virt-cat.pod:118 ../cat/virt-filesystems.pod:183 ../cat/virt-ls.pod:341 ../df/virt-df.pod:114 ../edit/virt-edit.pod:145 ../fish/guestfish.pod:246 ../rescue/virt-rescue.pod:137
315 msgid "forces raw format (no auto-detection) for C<disk.img>."
319 #: ../cat/virt-cat.pod:120
322 " virt-cat --format=raw -a disk.img --format -a another.img file\n"
327 #: ../cat/virt-cat.pod:122 ../cat/virt-filesystems.pod:187 ../cat/virt-ls.pod:345 ../df/virt-df.pod:118 ../edit/virt-edit.pod:149 ../fish/guestfish.pod:250 ../rescue/virt-rescue.pod:141
329 "forces raw format (no auto-detection) for C<disk.img> and reverts to "
330 "auto-detection for C<another.img>."
334 #: ../cat/virt-cat.pod:125 ../cat/virt-filesystems.pod:190 ../cat/virt-ls.pod:348 ../df/virt-df.pod:121 ../edit/virt-edit.pod:152 ../rescue/virt-rescue.pod:144
336 "If you have untrusted raw-format guest disk images, you should use this "
337 "option to specify the disk format. This avoids a possible security problem "
338 "with malicious guests (CVE-2010-3851)."
342 #: ../cat/virt-cat.pod:129 ../cat/virt-filesystems.pod:200 ../cat/virt-ls.pod:361 ../edit/virt-edit.pod:156 ../fish/guestfish.pod:289 ../fuse/guestmount.pod:163 ../inspector/virt-inspector.pod:114
343 msgid "B<--keys-from-stdin>"
347 #: ../cat/virt-cat.pod:131 ../cat/virt-filesystems.pod:202 ../cat/virt-ls.pod:363 ../edit/virt-edit.pod:158 ../fish/guestfish.pod:291 ../fuse/guestmount.pod:165 ../inspector/virt-inspector.pod:116
349 "Read key or passphrase parameters from stdin. The default is to try to read "
350 "passphrases from the user by opening C</dev/tty>."
354 #: ../cat/virt-cat.pod:134 ../cat/virt-filesystems.pod:261 ../cat/virt-ls.pod:425 ../df/virt-df.pod:173 ../edit/virt-edit.pod:161 ../fish/guestfish.pod:390 ../fuse/guestmount.pod:257 ../inspector/virt-inspector.pod:119 ../rescue/virt-rescue.pod: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:259 ../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:263 ../inspector/virt-inspector.pod:125 ../rescue/virt-rescue.pod:184 ../resize/virt-resize.pod:478
374 #: ../cat/virt-cat.pod:142 ../cat/virt-filesystems.pod:269 ../cat/virt-ls.pod:433 ../df/virt-df.pod:181 ../edit/virt-edit.pod:169 ../fish/guestfish.pod:399 ../fuse/guestmount.pod:265 ../inspector/virt-inspector.pod:127 ../rescue/virt-rescue.pod:186 ../resize/virt-resize.pod:480 ../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:482 ../tools/virt-list-filesystems.pl:71 ../tools/virt-list-partitions.pl:72 ../tools/virt-make-fs.pl:171 ../tools/virt-tar.pl:121 ../tools/virt-win-reg.pl:114
380 msgid "Display version number and exit."
384 #: ../cat/virt-cat.pod:146 ../cat/virt-filesystems.pod:281 ../cat/virt-ls.pod:437 ../df/virt-df.pod:185 ../edit/virt-edit.pod:173 ../fish/guestfish.pod:412 ../fuse/guestmount.pod:278 ../inspector/virt-inspector.pod:131 ../rescue/virt-rescue.pod: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 to edit, and C<file> is the full path to the file."
493 #: ../cat/virt-cat.pod:192 ../cat/virt-filesystems.pod:365 ../cat/virt-ls.pod:483 ../df/virt-df.pod:215 ../edit/virt-edit.pod:342 ../inspector/virt-inspector.pod:349 ../rescue/virt-rescue.pod:262 ../resize/virt-resize.pod:543 ../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:194 ../cat/virt-filesystems.pod:367 ../cat/virt-ls.pod:485 ../df/virt-df.pod:217 ../edit/virt-edit.pod:344 ../inspector/virt-inspector.pod:351 ../rescue/virt-rescue.pod:264 ../resize/virt-resize.pod:545 ../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:199 ../cat/virt-filesystems.pod:372 ../cat/virt-ls.pod:490 ../df/virt-df.pod:222 ../edit/virt-edit.pod:349 ../examples/guestfs-examples.pod:33 ../examples/guestfs-recipes.pod:384 ../fish/guestfish.pod:1235 ../fish/virt-copy-in.pod:50 ../fish/virt-copy-out.pod:39 ../fish/virt-tar-in.pod:47 ../fish/virt-tar-out.pod:41 ../fuse/guestmount.pod:303 ../inspector/virt-inspector.pod:372 ../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:550 ../ruby/examples/guestfs-ruby.pod:36 ../src/guestfs.pod:3026 ../test-tool/libguestfs-test-tool.pod:87 ../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
512 #: ../cat/virt-cat.pod:201
514 "L<guestfs(3)>, L<guestfish(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
515 "L<virt-tar-out(1)>, L<http://libguestfs.org/>."
519 #: ../cat/virt-cat.pod:208 ../cat/virt-filesystems.pod:383 ../cat/virt-ls.pod:502 ../df/virt-df.pod:230 ../edit/virt-edit.pod:363 ../rescue/virt-rescue.pod:292 ../resize/virt-resize.pod:571 ../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
524 #: ../cat/virt-cat.pod:210 ../cat/virt-filesystems.pod:385 ../cat/virt-ls.pod:504 ../df/virt-df.pod:232 ../edit/virt-edit.pod:365 ../inspector/virt-inspector.pod:386 ../rescue/virt-rescue.pod:294 ../resize/virt-resize.pod:573 ../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
525 msgid "Richard W.M. Jones L<http://people.redhat.com/~rjones/>"
529 #: ../cat/virt-cat.pod:212 ../cat/virt-filesystems.pod:387 ../cat/virt-ls.pod:506 ../df/virt-df.pod:234 ../edit/virt-edit.pod:367 ../examples/guestfs-examples.pod:48 ../examples/guestfs-recipes.pod:400 ../fish/guestfish.pod:1264 ../fish/virt-copy-in.pod:64 ../fish/virt-copy-out.pod:53 ../fish/virt-tar-in.pod:62 ../fish/virt-tar-out.pod:55 ../fuse/guestmount.pod:318 ../inspector/virt-inspector.pod:394 ../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:575 ../ruby/examples/guestfs-ruby.pod:51 ../src/guestfs.pod:3102 ../test-tool/libguestfs-test-tool.pod:97 ../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
534 #: ../cat/virt-cat.pod:214 ../inspector/virt-inspector.pod:396 ../resize/virt-resize.pod:577
535 msgid "Copyright (C) 2010-2011 Red Hat Inc."
539 #: ../cat/virt-cat.pod:216 ../cat/virt-filesystems.pod:391 ../cat/virt-ls.pod:510 ../df/virt-df.pod:238 ../edit/virt-edit.pod:371 ../fish/guestfish.pod:1269 ../fish/virt-copy-in.pod:69 ../fish/virt-copy-out.pod:58 ../fish/virt-tar-in.pod:67 ../fish/virt-tar-out.pod:60 ../fuse/guestmount.pod:323 ../inspector/virt-inspector.pod:398 ../rescue/virt-rescue.pod:300 ../resize/virt-resize.pod:579 ../test-tool/libguestfs-test-tool.pod:102 ../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
541 "This program is free software; you can redistribute it and/or modify it "
542 "under the terms of the GNU General Public License as published by the Free "
543 "Software Foundation; either version 2 of the License, or (at your option) "
548 #: ../cat/virt-cat.pod:221 ../cat/virt-filesystems.pod:396 ../cat/virt-ls.pod:515 ../df/virt-df.pod:243 ../edit/virt-edit.pod:376 ../fish/guestfish.pod:1274 ../fish/virt-copy-in.pod:74 ../fish/virt-copy-out.pod:63 ../fish/virt-tar-in.pod:72 ../fish/virt-tar-out.pod:65 ../fuse/guestmount.pod:328 ../inspector/virt-inspector.pod:403 ../rescue/virt-rescue.pod:305 ../resize/virt-resize.pod:584 ../test-tool/libguestfs-test-tool.pod:107 ../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
550 "This program is distributed in the hope that it will be useful, but WITHOUT "
551 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
552 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for "
557 #: ../cat/virt-cat.pod:226 ../cat/virt-filesystems.pod:401 ../cat/virt-ls.pod:520 ../df/virt-df.pod:248 ../edit/virt-edit.pod:381 ../fish/guestfish.pod:1279 ../fish/virt-copy-in.pod:79 ../fish/virt-copy-out.pod:68 ../fish/virt-tar-in.pod:77 ../fish/virt-tar-out.pod:70 ../fuse/guestmount.pod:333 ../inspector/virt-inspector.pod:408 ../rescue/virt-rescue.pod:310 ../resize/virt-resize.pod:589 ../test-tool/libguestfs-test-tool.pod:112 ../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
559 "You should have received a copy of the GNU General Public License along with "
560 "this program; if not, write to the Free Software Foundation, Inc., 675 Mass "
561 "Ave, Cambridge, MA 02139, USA."
565 #: ../cat/virt-filesystems.pod:5
567 "virt-filesystems - List filesystems, partitions, block devices, LVM in a "
568 "virtual machine or disk image"
572 #: ../cat/virt-filesystems.pod:9
575 " virt-filesystems [--options] -d domname\n"
580 #: ../cat/virt-filesystems.pod:11
583 " virt-filesystems [--options] -a disk.img [-a disk.img ...]\n"
588 #: ../cat/virt-filesystems.pod:15
590 "This tool allows you to discover filesystems, partitions, logical volumes, "
591 "and their sizes in a disk image or virtual machine. It is a replacement for "
592 "L<virt-list-filesystems(1)> and L<virt-list-partitions(1)>."
596 #: ../cat/virt-filesystems.pod:20
598 "One use for this tool is from shell scripts to iterate over all filesystems "
603 #: ../cat/virt-filesystems.pod:23
606 " for fs in $(virt-filesystems -a disk.img); do\n"
613 #: ../cat/virt-filesystems.pod:27
615 "Another use is to list partitions before using another tool to modify those "
616 "partitions (such as L<virt-resize(1)>). If you are curious about what an "
617 "unknown disk image contains, use this tool along with L<virt-inspector(1)>."
621 #: ../cat/virt-filesystems.pod:32
623 "Various command line options control what this program displays. You need "
624 "to give either I<-a> or I<-d> options to specify the disk image or libvirt "
625 "guest respectively. If you just specify that then the program shows "
626 "filesystems found, one per line, like this:"
630 #: ../cat/virt-filesystems.pod:37
633 " $ virt-filesystems -a disk.img\n"
635 " /dev/vg_guest/lv_root\n"
640 #: ../cat/virt-filesystems.pod:41
641 msgid "If you add I<-l> or I<--long> then the output includes extra information:"
645 #: ../cat/virt-filesystems.pod:44
648 " $ virt-filesystems -a disk.img -l\n"
649 " Name Type VFS Label Size\n"
650 " /dev/sda1 filesystem ext4 boot 524288000\n"
651 " /dev/vg_guest/lv_root filesystem ext4 root 10212081664\n"
656 #: ../cat/virt-filesystems.pod:49
658 "If you add I<--extra> then non-mountable (swap, unknown) filesystems are "
663 #: ../cat/virt-filesystems.pod:52
666 " $ virt-filesystems -a disk.img --extra\n"
668 " /dev/vg_guest/lv_root\n"
669 " /dev/vg_guest/lv_swap\n"
670 " /dev/vg_guest/lv_data\n"
675 #: ../cat/virt-filesystems.pod:58
676 msgid "If you add I<--partitions> then partitions are shown instead of filesystems:"
680 #: ../cat/virt-filesystems.pod:60
683 " $ virt-filesystems -a disk.img --partitions\n"
690 #: ../cat/virt-filesystems.pod:64
692 "Similarly you can use I<--logical-volumes>, I<--volume-groups>, "
693 "I<--physical-volumes>, I<--block-devices> to list those items."
697 #: ../cat/virt-filesystems.pod:67
699 "You can use these options in combination as well (if you want a combination "
700 "including filesystems, you have to add I<--filesystems>). Notice that some "
701 "items fall into several categories (eg. C</dev/sda1> might be both a "
702 "partition and a filesystem). These items are listed several times. To get "
703 "a list which includes absolutely everything that virt-filesystems knows "
704 "about, use the I<--all> option."
708 #: ../cat/virt-filesystems.pod:74
710 "UUIDs (because they are quite long) are not shown by default. Add the "
711 "I<--uuid> option to display device and filesystem UUIDs in the long output."
715 #: ../cat/virt-filesystems.pod:78
717 "I<--all --long --uuid> is a useful combination to display all possible "
718 "information about everything."
722 #: ../cat/virt-filesystems.pod:81
725 " $ virt-filesystems -a win.img --all --long --uuid -h\n"
726 " Name Type VFS Label Size Parent UUID\n"
727 " /dev/sda1 filesystem ntfs System Reserved 100M - F81C92571C92112C\n"
728 " /dev/sda2 filesystem ntfs - 20G - F2E8996AE8992E3B\n"
729 " /dev/sda1 partition - - 100M /dev/sda -\n"
730 " /dev/sda2 partition - - 20G /dev/sda -\n"
731 " /dev/sda device - - 20G - -\n"
736 #: ../cat/virt-filesystems.pod:89
737 msgid "For machine-readable output, use I<--csv> to get Comma-Separated Values."
741 #: ../cat/virt-filesystems.pod:110 ../tools/virt-list-filesystems.pl:121
746 #: ../cat/virt-filesystems.pod:112
748 "Display everything. This is currently the same as specifying these options: "
749 "I<--filesystems>, I<--extra>, I<--partitions>, I<--block-devices>, "
750 "I<--logical-volumes>, I<--volume-groups>, I<--physical-volumes>. (More may "
751 "be added to this list in future)."
755 #: ../cat/virt-filesystems.pod:117
756 msgid "See also I<--long>."
760 #: ../cat/virt-filesystems.pod:119
765 #: ../cat/virt-filesystems.pod:121
766 msgid "B<--block-devices>"
770 #: ../cat/virt-filesystems.pod:123
771 msgid "Display block devices."
775 #: ../cat/virt-filesystems.pod:135 ../cat/virt-ls.pod:301 ../df/virt-df.pod:88
780 #: ../cat/virt-filesystems.pod:137 ../cat/virt-ls.pod:303 ../df/virt-df.pod:90
782 "Write out the results in CSV format (comma-separated values). This format "
783 "can be imported easily into databases and spreadsheets, but read L</NOTE "
784 "ABOUT CSV FORMAT> below."
788 #: ../cat/virt-filesystems.pod:150
790 "When prompting for keys and passphrases, virt-filesystems normally turns "
791 "echoing off so you cannot see what you are typing. If you are not worried "
792 "about Tempest attacks and there is no one else in the room you can specify "
793 "this flag to see what you are typing."
797 #: ../cat/virt-filesystems.pod:155
802 #: ../cat/virt-filesystems.pod:157
804 "This causes filesystems that are not ordinary, mountable filesystems to be "
805 "displayed. This category includes swapspace, and filesystems that are empty "
806 "or contain unknown data."
810 #: ../cat/virt-filesystems.pod:161
811 msgid "This option implies I<--filesystems>."
815 #: ../cat/virt-filesystems.pod:163
816 msgid "B<--filesystems>"
820 #: ../cat/virt-filesystems.pod:165
822 "Display mountable filesystems. If no display option was selected then this "
827 #: ../cat/virt-filesystems.pod:168
828 msgid "With I<--extra>, non-mountable filesystems are shown too."
832 #: ../cat/virt-filesystems.pod:181
835 " virt-filesystems --format=raw -a disk.img\n"
840 #: ../cat/virt-filesystems.pod:185
843 " virt-filesystems --format=raw -a disk.img --format -a another.img\n"
848 #: ../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
853 #: ../cat/virt-filesystems.pod:196 ../cat/virt-ls.pod:354 ../df/virt-df.pod:127 ../tools/virt-list-partitions.pl:111
854 msgid "B<--human-readable>"
858 #: ../cat/virt-filesystems.pod:198
859 msgid "In I<--long> mode, display sizes in human-readable format."
863 #: ../cat/virt-filesystems.pod:205 ../cat/virt-ls.pod:366 ../tools/virt-list-filesystems.pl:108 ../tools/virt-list-partitions.pl:119
868 #: ../cat/virt-filesystems.pod:207 ../cat/virt-ls.pod:368 ../tools/virt-list-filesystems.pl:110 ../tools/virt-list-partitions.pl:121
873 #: ../cat/virt-filesystems.pod:209
874 msgid "Display extra columns of data (\"long format\")."
878 #: ../cat/virt-filesystems.pod:211
879 msgid "A title row is added unless you also specify I<--no-title>."
883 #: ../cat/virt-filesystems.pod:213
885 "The extra columns displayed depend on what output you select, and the "
886 "ordering of columns may change in future versions. Use the title row, "
887 "I<--csv> output and/or L<csvtool(1)> to match columns to data in external "
892 #: ../cat/virt-filesystems.pod:218
894 "Use I<-h> if you want sizes to be displayed in human-readable format. The "
895 "default is to show raw numbers of I<bytes>."
899 #: ../cat/virt-filesystems.pod:221
900 msgid "Use I<--uuid> to display UUIDs too."
904 #: ../cat/virt-filesystems.pod:223
909 #: ../cat/virt-filesystems.pod:225
914 #: ../cat/virt-filesystems.pod:227
915 msgid "B<--logical-volumes>"
919 #: ../cat/virt-filesystems.pod:229
921 "Display LVM logical volumes. In this mode, these are displayed irrespective "
922 "of whether the LVs contain filesystems."
926 #: ../cat/virt-filesystems.pod:232
927 msgid "B<--no-title>"
931 #: ../cat/virt-filesystems.pod:234
932 msgid "In I<--long> mode, don't add a title row."
936 #: ../cat/virt-filesystems.pod:236
938 "Note that the order of the columns is not fixed, and may change in future "
939 "versions of virt-filesystems, so using this option may give you unexpected "
944 #: ../cat/virt-filesystems.pod:240
949 #: ../cat/virt-filesystems.pod:242
950 msgid "B<--partitions>"
954 #: ../cat/virt-filesystems.pod:244
956 "Display partitions. In this mode, these are displayed irrespective of "
957 "whether the partitions contain filesystems."
961 #: ../cat/virt-filesystems.pod:247
966 #: ../cat/virt-filesystems.pod:249
967 msgid "B<--physvols>"
971 #: ../cat/virt-filesystems.pod:251
972 msgid "B<--physical-volumes>"
976 #: ../cat/virt-filesystems.pod:253
977 msgid "Display LVM physical volumes."
981 #: ../cat/virt-filesystems.pod:255 ../df/virt-df.pod:163
986 #: ../cat/virt-filesystems.pod:257
991 #: ../cat/virt-filesystems.pod:259
992 msgid "In I<--long> mode, display UUIDs as well."
996 #: ../cat/virt-filesystems.pod:273
1001 #: ../cat/virt-filesystems.pod:275
1002 msgid "B<--volgroups>"
1006 #: ../cat/virt-filesystems.pod:277
1007 msgid "B<--volume-groups>"
1011 #: ../cat/virt-filesystems.pod:279
1012 msgid "Display LVM volume groups."
1016 #: ../cat/virt-filesystems.pod:287
1021 #: ../cat/virt-filesystems.pod:289
1023 "Note that columns in the output are subject to reordering and change in "
1024 "future versions of this tool."
1028 #: ../cat/virt-filesystems.pod:294
1033 #: ../cat/virt-filesystems.pod:296
1034 msgid "The filesystem, partition, block device or LVM name."
1038 #: ../cat/virt-filesystems.pod:298
1040 "For device and partition names these are displayed as canonical libguestfs "
1041 "names, so that for example C</dev/sda2> is the second partition on the first "
1046 #: ../cat/virt-filesystems.pod:302
1048 "If the I<--long> option is B<not> specified, then only the name column is "
1049 "shown in the output."
1053 #: ../cat/virt-filesystems.pod:305
1058 #: ../cat/virt-filesystems.pod:307
1059 msgid "The object type, for example C<filesystem>, C<lv>, C<device> etc."
1063 #: ../cat/virt-filesystems.pod:309
1068 #: ../cat/virt-filesystems.pod:311
1070 "If there is a filesystem, then this column displays the filesystem type if "
1071 "one could be detected, eg. C<ext4>."
1075 #: ../cat/virt-filesystems.pod:314
1080 #: ../cat/virt-filesystems.pod:316
1082 "If the object has a label (used for identifying and mounting filesystems) "
1083 "then this column contains the label."
1087 #: ../cat/virt-filesystems.pod:319
1092 #: ../cat/virt-filesystems.pod:321
1094 "The size of the object in bytes. If the I<--human> option is used then the "
1095 "size is displayed in a human-readable form."
1099 #: ../cat/virt-filesystems.pod:324
1104 #: ../cat/virt-filesystems.pod:326
1106 "The parent column records the parent relationship between objects. For "
1107 "example, if the object is a partition, then this column contains the name of "
1108 "the containing device. If the object is a logical volume, then this column "
1109 "is the name of the volume group."
1113 #: ../cat/virt-filesystems.pod:331
1118 #: ../cat/virt-filesystems.pod:333
1120 "If the object has a UUID (used for identifying and mounting filesystems and "
1121 "block devices) then this column contains the UUID as a string."
1125 #: ../cat/virt-filesystems.pod:337
1126 msgid "The UUID is only displayed if the I<--uuid> option is given."
1130 #: ../cat/virt-filesystems.pod:341 ../cat/virt-ls.pod:459 ../df/virt-df.pod:191
1131 msgid "NOTE ABOUT CSV FORMAT"
1135 #: ../cat/virt-filesystems.pod:343 ../cat/virt-ls.pod:461 ../df/virt-df.pod:193
1137 "Comma-separated values (CSV) is a deceptive format. It I<seems> like it "
1138 "should be easy to parse, but it is definitely not easy to parse."
1142 #: ../cat/virt-filesystems.pod:346 ../cat/virt-ls.pod:464 ../df/virt-df.pod:196
1144 "Myth: Just split fields at commas. Reality: This does I<not> work "
1145 "reliably. This example has two columns:"
1149 #: ../cat/virt-filesystems.pod:349 ../cat/virt-ls.pod:467 ../df/virt-df.pod:199
1152 " \"foo,bar\",baz\n"
1157 #: ../cat/virt-filesystems.pod:351 ../cat/virt-ls.pod:469 ../df/virt-df.pod:201
1159 "Myth: Read the file one line at a time. Reality: This does I<not> work "
1160 "reliably. This example has one row:"
1164 #: ../cat/virt-filesystems.pod:354 ../cat/virt-ls.pod:472 ../df/virt-df.pod:204
1173 #: ../cat/virt-filesystems.pod:357 ../cat/virt-ls.pod:475 ../df/virt-df.pod:207
1175 "For shell scripts, use C<csvtool> (L<http://merjis.com/developers/csv> also "
1176 "packaged in major Linux distributions)."
1180 #: ../cat/virt-filesystems.pod:360 ../cat/virt-ls.pod:478 ../df/virt-df.pod:210
1182 "For other languages, use a CSV processing library (eg. C<Text::CSV> for Perl "
1183 "or Python's built-in csv library)."
1187 #: ../cat/virt-filesystems.pod:363 ../cat/virt-ls.pod:481 ../df/virt-df.pod:213
1188 msgid "Most spreadsheets and databases can import CSV directly."
1192 #: ../cat/virt-filesystems.pod:374
1194 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-df(1)>, "
1195 "L<virt-list-filesystems(1)>, L<virt-list-partitions(1)>, L<csvtool(1)>, "
1196 "L<http://libguestfs.org/>."
1200 #: ../cat/virt-filesystems.pod:389 ../tools/virt-make-fs.pl:570 ../tools/virt-win-reg.pl:778
1201 msgid "Copyright (C) 2010 Red Hat Inc."
1205 #: ../cat/virt-ls.pod:5
1206 msgid "virt-ls - List files in a virtual machine"
1210 #: ../cat/virt-ls.pod:9
1213 " virt-ls [--options] -d domname directory [directory ...]\n"
1218 #: ../cat/virt-ls.pod:11
1221 " virt-ls [--options] -a disk.img [-a disk.img ...] directory [directory "
1227 #: ../cat/virt-ls.pod:13 ../df/virt-df.pod:15 ../rescue/virt-rescue.pod:13
1232 #: ../cat/virt-ls.pod:15
1235 " virt-ls [--options] domname directory\n"
1240 #: ../cat/virt-ls.pod:17
1243 " virt-ls [--options] disk.img [disk.img ...] directory\n"
1248 #: ../cat/virt-ls.pod:21
1250 "C<virt-ls> lists filenames, file sizes, checksums, extended attributes and "
1251 "more from a virtual machine or disk image."
1255 #: ../cat/virt-ls.pod:24
1257 "Multiple directory names can be given, in which case the output from each is "
1262 #: ../cat/virt-ls.pod:27
1264 "To list directories from a libvirt guest use the I<-d> option to specify the "
1265 "name of the guest. For a disk image, use the I<-a> option."
1269 #: ../cat/virt-ls.pod:31
1271 "C<virt-ls> can do many simple file listings. For more complicated cases you "
1272 "may need to use L<guestfish(1)>, or write a program directly to the "
1273 "L<guestfs(3)> API."
1277 #: ../cat/virt-ls.pod:37
1278 msgid "Get a list of all files and directories in a virtual machine:"
1282 #: ../cat/virt-ls.pod:39
1285 " virt-ls -R -d guest /\n"
1290 #: ../cat/virt-ls.pod:41
1291 msgid "List all setuid or setgid programs in a Linux virtual machine:"
1295 #: ../cat/virt-ls.pod:43
1298 " virt-ls -lR -d guest / | grep '^- [42]'\n"
1303 #: ../cat/virt-ls.pod:45
1304 msgid "List all public-writable directories in a Linux virtual machine:"
1308 #: ../cat/virt-ls.pod:47
1311 " virt-ls -lR -d guest / | grep '^d ...7'\n"
1316 #: ../cat/virt-ls.pod:49
1317 msgid "List all Unix domain sockets in a Linux virtual machine:"
1321 #: ../cat/virt-ls.pod:51
1324 " virt-ls -lR -d guest / | grep '^s'\n"
1329 #: ../cat/virt-ls.pod:53
1330 msgid "List all regular files with filenames ending in '.png':"
1334 #: ../cat/virt-ls.pod:55
1337 " virt-ls -lR -d guest / | grep -i '^-.*\\.png$'\n"
1342 #: ../cat/virt-ls.pod:57
1343 msgid "To display files larger than 10MB in home directories:"
1347 #: ../cat/virt-ls.pod:59
1350 " virt-ls -lR -d guest /home | awk '$3 > 10*1024*1024'\n"
1355 #: ../cat/virt-ls.pod:61
1356 msgid "Find everything modified in the last 7 days:"
1360 #: ../cat/virt-ls.pod:63
1363 " virt-ls -lR -d guest --time-days / | awk '$6 <= 7'\n"
1368 #: ../cat/virt-ls.pod:65
1369 msgid "Find regular files modified in the last 24 hours:"
1373 #: ../cat/virt-ls.pod:67
1376 " virt-ls -lR -d guest --time-days / | grep '^-' | awk '$6 < 1'\n"
1381 #: ../cat/virt-ls.pod:69
1382 msgid "DIFFERENCES IN SNAPSHOTS AND BACKING FILES"
1386 #: ../cat/virt-ls.pod:71
1388 "Find the differences between files in a guest and an earlier snapshot of the "
1393 #: ../cat/virt-ls.pod:74
1396 " virt-ls -lR -a snapshot.img / --uids --time-t > old\n"
1397 " virt-ls -lR -a current.img / --uids --time-t > new\n"
1398 " diff -u old new | less\n"
1403 #: ../cat/virt-ls.pod:78
1405 "The commands above won't find files where the content has changed but the "
1406 "metadata (eg. file size and modification date) is the same. To do that, you "
1407 "need to add the I<--checksum> parameter to both C<virt-ls> commands. "
1408 "I<--checksum> can be quite slow since it has to read and compute a checksum "
1409 "of every regular file in the virtual machine."
1413 #: ../cat/virt-ls.pod:84
1414 msgid "OUTPUT MODES"
1418 #: ../cat/virt-ls.pod:86
1420 "C<virt-ls> has four output modes, controlled by different combinations of "
1421 "the I<-l> and I<-R> options."
1425 #: ../cat/virt-ls.pod:89
1426 msgid "SIMPLE LISTING"
1430 #: ../cat/virt-ls.pod:91
1431 msgid "A simple listing is like the ordinary L<ls(1)> command:"
1435 #: ../cat/virt-ls.pod:93
1438 " $ virt-ls -d guest /\n"
1446 #: ../cat/virt-ls.pod:98
1447 msgid "LONG LISTING"
1451 #: ../cat/virt-ls.pod:100
1453 "With the I<-l> (I<--long>) option, the output is like the C<ls -l> command "
1454 "(more specifically, like the C<guestfs_ll> function)."
1458 #: ../cat/virt-ls.pod:103
1461 " $ virt-ls -l -d guest /\n"
1463 " dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin\n"
1464 " dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot\n"
1470 #: ../cat/virt-ls.pod:109
1472 "Note that while this is useful for displaying a directory, do not try "
1473 "parsing this output in another program. Use L</RECURSIVE LONG LISTING> "
1478 #: ../cat/virt-ls.pod:113
1479 msgid "RECURSIVE LISTING"
1483 #: ../cat/virt-ls.pod:115
1485 "With the I<-R> (I<--recursive>) option, C<virt-ls> lists the names of files "
1486 "and directories recursively:"
1490 #: ../cat/virt-ls.pod:118
1493 " $ virt-ls -R -d guest /tmp\n"
1501 #: ../cat/virt-ls.pod:123
1503 "To generate this output, C<virt-ls> runs the C<guestfs_find0> function and "
1504 "converts C<\\0> characters to C<\\n>."
1508 #: ../cat/virt-ls.pod:126
1509 msgid "RECURSIVE LONG LISTING"
1513 #: ../cat/virt-ls.pod:128
1515 "Using I<-lR> options together changes the output to display directories "
1516 "recursively, with file stats, and optionally other features such as "
1517 "checksums and extended attributes."
1521 #: ../cat/virt-ls.pod:132
1523 "Most of the interesting features of C<virt-ls> are only available when using "
1528 #: ../cat/virt-ls.pod:135
1530 "The fields are normally space-separated. Filenames are B<not> quoted, so "
1531 "you cannot use the output in another program (because filenames can contain "
1532 "spaces and other unsafe characters). If the guest was untrusted and someone "
1533 "knew you were using C<virt-ls> to analyze the guest, they could play tricks "
1534 "on you by creating filenames with embedded newline characters. To B<safely> "
1535 "parse the output in another program, use the I<--csv> (Comma-Separated "
1540 #: ../cat/virt-ls.pod:143
1542 "Note that this output format is completely unrelated to the C<ls -lR> "
1547 #: ../cat/virt-ls.pod:146
1550 " $ virt-ls -lR -d guest /bin\n"
1551 " d 0555 4096 /bin\n"
1552 " - 0755 123 /bin/alsaunmute\n"
1553 " - 0755 28328 /bin/arch\n"
1554 " l 0777 4 /bin/awk -> gawk\n"
1555 " - 0755 27216 /bin/basename\n"
1556 " - 0755 943360 /bin/bash\n"
1562 #: ../cat/virt-ls.pod:155
1563 msgid "These basic fields are always shown:"
1567 #: ../cat/virt-ls.pod:159
1572 #: ../cat/virt-ls.pod:161
1574 "The file type, one of: C<-> (regular file), C<d> (directory), C<c> "
1575 "(character device), C<b> (block device), C<p> (named pipe), C<l> (symbolic "
1576 "link), C<s> (socket) or C<u> (unknown)."
1580 #: ../cat/virt-ls.pod:171
1585 #: ../cat/virt-ls.pod:173
1586 msgid "The Unix permissions, displayed as a 4 digit octal number."
1590 #: ../cat/virt-ls.pod:175
1595 #: ../cat/virt-ls.pod:177
1597 "The size of the file. This is shown in bytes unless I<-h> or "
1598 "I<--human-readable> option is given, in which case this is shown as a "
1599 "human-readable number."
1603 #: ../cat/virt-ls.pod:181 ../fish/guestfish-actions.pod:4188
1608 #: ../cat/virt-ls.pod:183
1609 msgid "The full path of the file or directory."
1613 #: ../cat/virt-ls.pod:185
1618 #: ../cat/virt-ls.pod:187
1619 msgid "For symbolic links only, the link target."
1623 #: ../cat/virt-ls.pod:191
1625 "In I<-lR> mode, additional command line options enable the display of more "
1630 #: ../cat/virt-ls.pod:194
1632 "With the I<--uids> flag, these additional fields are displayed before the "
1637 #: ../cat/virt-ls.pod:199
1642 #: ../cat/virt-ls.pod:201
1647 #: ../cat/virt-ls.pod:203
1649 "The UID and GID of the owner of the file (displayed numerically). Note "
1650 "these only make sense in the context of a Unix-like guest."
1654 #: ../cat/virt-ls.pod:208
1655 msgid "With the I<--times> flag, these additional fields are displayed:"
1659 #: ../cat/virt-ls.pod:212
1664 #: ../cat/virt-ls.pod:214
1665 msgid "The time of last access."
1669 #: ../cat/virt-ls.pod:216
1674 #: ../cat/virt-ls.pod:218
1675 msgid "The time of last modification."
1679 #: ../cat/virt-ls.pod:220
1684 #: ../cat/virt-ls.pod:222
1685 msgid "The time of last status change."
1689 #: ../cat/virt-ls.pod:226
1691 "The time fields are displayed as string dates and times, unless one of the "
1692 "I<--time-t>, I<--time-relative> or I<--time-days> flags is given."
1696 #: ../cat/virt-ls.pod:229
1697 msgid "With the I<--extra-stats> flag, these additional fields are displayed:"
1701 #: ../cat/virt-ls.pod:233
1706 #: ../cat/virt-ls.pod:235
1708 "The device containing the file (displayed as major:minor). This may not "
1709 "match devices as known to the guest."
1713 #: ../cat/virt-ls.pod:238
1718 #: ../cat/virt-ls.pod:240
1719 msgid "The inode number."
1723 #: ../cat/virt-ls.pod:242
1728 #: ../cat/virt-ls.pod:244
1729 msgid "The number of hard links."
1733 #: ../cat/virt-ls.pod:246
1738 #: ../cat/virt-ls.pod:248
1739 msgid "For block and char special files, the device (displayed as major:minor)."
1743 #: ../cat/virt-ls.pod:251
1748 #: ../cat/virt-ls.pod:253
1749 msgid "The number of 512 byte blocks allocated to the file."
1753 #: ../cat/virt-ls.pod:257
1755 "With the I<--checksum> flag, the checksum of the file contents is shown "
1756 "(only for regular files). Computing file checksums can take a considerable "
1761 #: ../cat/virt-ls.pod:280
1762 msgid "B<--checksum>"
1766 #: ../cat/virt-ls.pod:282
1767 msgid "B<--checksum=crc|md5|sha1|sha224|sha256|sha384|sha512>"
1771 #: ../cat/virt-ls.pod:284
1773 "Display checksum over file contents for regular files. With no argument, "
1774 "this defaults to using I<md5>. Using an argument, you can select the "
1775 "checksum type to use."
1779 #: ../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
1781 "This option only has effect in I<-lR> output mode. See L</RECURSIVE LONG "
1786 #: ../cat/virt-ls.pod:316
1788 "When prompting for keys and passphrases, virt-ls normally turns echoing off "
1789 "so you cannot see what you are typing. If you are not worried about Tempest "
1790 "attacks and there is no one else in the room you can specify this flag to "
1791 "see what you are typing."
1795 #: ../cat/virt-ls.pod:321
1796 msgid "B<--extra-stats>"
1800 #: ../cat/virt-ls.pod:323
1801 msgid "Display extra stats."
1805 #: ../cat/virt-ls.pod:339
1808 " virt-ls --format=raw -a disk.img /dir\n"
1813 #: ../cat/virt-ls.pod:343
1816 " virt-ls --format=raw -a disk.img --format -a another.img /dir\n"
1821 #: ../cat/virt-ls.pod:356
1822 msgid "Display file sizes in human-readable format."
1826 #: ../cat/virt-ls.pod:370
1831 #: ../cat/virt-ls.pod:372
1832 msgid "B<--recursive>"
1836 #: ../cat/virt-ls.pod:374
1838 "Select the mode. With neither of these options, C<virt-ls> produces a "
1839 "simple, flat list of the files in the named directory. See L</SIMPLE "
1844 #: ../cat/virt-ls.pod:378
1846 "C<virt-ls -l> produces a \"long listing\", which shows more detail. See "
1851 #: ../cat/virt-ls.pod:381
1853 "C<virt-ls -R> produces a recursive list of files starting at the named "
1854 "directory. See L</RECURSIVE LISTING>."
1858 #: ../cat/virt-ls.pod:384
1860 "C<virt-ls -lR> produces a recursive long listing which can be more easily "
1861 "parsed. See L</RECURSIVE LONG LISTING>."
1865 #: ../cat/virt-ls.pod:387
1870 #: ../cat/virt-ls.pod:389
1871 msgid "Display time fields."
1875 #: ../cat/virt-ls.pod:394
1876 msgid "B<--time-days>"
1880 #: ../cat/virt-ls.pod:396
1881 msgid "Display time fields as days before now (negative if in the future)."
1885 #: ../cat/virt-ls.pod:398
1887 "Note that C<0> in output means \"up to 1 day before now\", or that the age "
1888 "of the file is between 0 and 86399 seconds."
1892 #: ../cat/virt-ls.pod:404
1893 msgid "B<--time-relative>"
1897 #: ../cat/virt-ls.pod:406
1898 msgid "Display time fields as seconds before now (negative if in the future)."
1902 #: ../cat/virt-ls.pod:411
1907 #: ../cat/virt-ls.pod:413
1908 msgid "Display time fields as seconds since the Unix epoch."
1912 #: ../cat/virt-ls.pod:418
1917 #: ../cat/virt-ls.pod:420
1918 msgid "Display UID and GID fields."
1922 #: ../cat/virt-ls.pod:445
1923 msgid "Previous versions of virt-ls allowed you to write either:"
1927 #: ../cat/virt-ls.pod:447
1930 " virt-ls disk.img [disk.img ...] /dir\n"
1935 #: ../cat/virt-ls.pod:451
1938 " virt-ls guestname /dir\n"
1943 #: ../cat/virt-ls.pod:492
1945 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, "
1946 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
1947 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
1951 #: ../cat/virt-ls.pod:508 ../df/virt-df.pod:236 ../edit/virt-edit.pod:369 ../rescue/virt-rescue.pod:298
1952 msgid "Copyright (C) 2009-2011 Red Hat Inc."
1956 #: ../df/virt-df.pod:5
1957 msgid "virt-df - Display free space on virtual filesystems"
1961 #: ../df/virt-df.pod:9
1964 " virt-df [--options]\n"
1969 #: ../df/virt-df.pod:11
1972 " virt-df [--options] -d domname\n"
1977 #: ../df/virt-df.pod:13
1980 " virt-df [--options] -a disk.img [-a disk.img ...]\n"
1985 #: ../df/virt-df.pod:17
1988 " virt-df [--options] domname\n"
1993 #: ../df/virt-df.pod:19
1996 " virt-df [--options] disk.img [disk.img ...]\n"
2001 #: ../df/virt-df.pod:23
2003 "C<virt-df> is a command line tool to display free space on virtual machine "
2004 "filesystems. Unlike other tools, it doesn't just display the size of disk "
2005 "allocated to a virtual machine, but can look inside disk images to see how "
2006 "much space is really being used."
2010 #: ../df/virt-df.pod:28
2012 "If used without any I<-a> or I<-d> arguments, C<virt-df> checks with libvirt "
2013 "to get a list of all active and inactive guests, and performs a C<df>-type "
2014 "operation on each one in turn, printing out the results."
2018 #: ../df/virt-df.pod:32
2020 "If any I<-a> or I<-d> arguments are specified, C<virt-df> performs a "
2021 "C<df>-type operation on either the single named libvirt domain, or on the "
2022 "disk image(s) listed on the command line (which must all belong to a single "
2023 "VM). In this mode (with arguments), C<virt-df> will I<only work for a "
2024 "single guest>. If you want to run on multiple guests, then you have to "
2025 "invoke C<virt-df> multiple times."
2029 #: ../df/virt-df.pod:39
2031 "Use the I<--csv> option to get a format which can be easily parsed by other "
2032 "programs. Other options are similar to the standard L<df(1)> command."
2036 #: ../df/virt-df.pod:45
2038 "Show disk usage for a single libvirt guest called C<F14x64>. Make the "
2039 "output human-readable:"
2043 #: ../df/virt-df.pod:48
2046 " # virt-df -d F14x64 -h\n"
2047 " Filesystem Size Used Available Use%\n"
2048 " F14x64:/dev/sda1 484M 66M 393M 14%\n"
2049 " F14x64:/dev/vg_f13x64/lv_root 7.4G 3.4G 4.0G 46%\n"
2054 #: ../df/virt-df.pod:53
2055 msgid "Show disk usage for a disk image file called C<test.img>:"
2059 #: ../df/virt-df.pod:55
2062 " $ virt-df -a test1.img\n"
2063 " Filesystem 1K-blocks Used Available Use%\n"
2064 " test1.img:/dev/sda1 99099 1551 92432 2%\n"
2069 #: ../df/virt-df.pod:112
2072 " virt-df --format=raw -a disk.img\n"
2077 #: ../df/virt-df.pod:116
2080 " virt-df --format=raw -a disk.img --format -a another.img\n"
2085 #: ../df/virt-df.pod:129
2086 msgid "Print sizes in human-readable format."
2090 #: ../df/virt-df.pod:131
2091 msgid "You are not allowed to use I<-h> and I<--csv> at the same time."
2095 #: ../df/virt-df.pod:133 ../fish/guestfish.pod:258 ../fuse/guestmount.pod:155
2100 #: ../df/virt-df.pod:135
2105 #: ../df/virt-df.pod:137
2106 msgid "Print inodes instead of blocks."
2110 #: ../df/virt-df.pod:139
2111 msgid "B<--one-per-guest>"
2115 #: ../df/virt-df.pod:141
2117 "Run one libguestfs appliance per guest. Normally C<virt-df> will add the "
2118 "disks from several guests to a single libguestfs appliance."
2122 #: ../df/virt-df.pod:144
2123 msgid "You might use this option in the following circumstances:"
2127 #: ../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:1938 ../fish/guestfish-actions.pod:1944 ../fish/guestfish-actions.pod:1952 ../fish/guestfish-actions.pod:1959 ../fish/guestfish-actions.pod:1966 ../fish/guestfish.pod:445 ../fish/guestfish.pod:449 ../fish/guestfish.pod:453 ../fish/guestfish.pod:457 ../inspector/virt-inspector.pod:384 ../inspector/virt-inspector.pod:388 ../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:2864 ../src/guestfs-actions.pod:2870 ../src/guestfs-actions.pod:2878 ../src/guestfs-actions.pod:2885 ../src/guestfs-actions.pod:2892 ../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:1064 ../src/guestfs.pod:1068 ../src/guestfs.pod:1072 ../src/guestfs.pod:1077 ../src/guestfs.pod:1085 ../src/guestfs.pod:1104 ../src/guestfs.pod:1112 ../src/guestfs.pod:1134 ../src/guestfs.pod:1138 ../src/guestfs.pod:1142 ../src/guestfs.pod:1146 ../src/guestfs.pod:1150 ../src/guestfs.pod:1154 ../src/guestfs.pod:1643 ../src/guestfs.pod:1648 ../src/guestfs.pod:1652 ../src/guestfs.pod:1754 ../src/guestfs.pod:1759 ../src/guestfs.pod:1763 ../src/guestfs.pod:1773 ../src/guestfs.pod:2047 ../src/guestfs.pod:2052 ../src/guestfs.pod:2058 ../src/guestfs.pod:2066 ../src/guestfs.pod:2420 ../src/guestfs.pod:2426 ../src/guestfs.pod:2431 ../src/guestfs.pod:2437 ../src/guestfs.pod:2818 ../src/guestfs.pod:2823 ../src/guestfs.pod:2827 ../src/guestfs.pod:2831 ../src/guestfs.pod:2835 ../src/guestfs.pod:2849 ../src/guestfs.pod:2854 ../src/guestfs.pod:3079 ../src/guestfs.pod:3083 ../src/guestfs.pod:3087 ../src/guestfs.pod:3091 ../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
2132 #: ../df/virt-df.pod:150
2134 "If you think an untrusted guest might actively try to exploit the libguestfs "
2135 "appliance kernel, then this prevents one guest from interfering with the "
2136 "stats printed for another guest."
2140 #: ../df/virt-df.pod:156
2142 "If the kernel has a bug which stops it from accessing a filesystem in one "
2143 "guest (see for example RHBZ#635373) then this allows libguestfs to continue "
2144 "and report stats for further guests."
2148 #: ../df/virt-df.pod:165
2150 "Print UUIDs instead of names. This is useful for following a guest even "
2151 "when the guest is migrated or renamed, or when two guests happen to have the "
2156 #: ../df/virt-df.pod:169
2158 "Note that only domains that we fetch from libvirt come with UUIDs. For disk "
2159 "images, we still print the disk image name even when this option is "
2164 #: ../df/virt-df.pod:224
2166 "L<df(1)>, L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
2167 "L<http://libguestfs.org/>."
2171 #: ../edit/virt-edit.pod:5
2172 msgid "virt-edit - Edit a file in a virtual machine"
2176 #: ../edit/virt-edit.pod:9
2179 " virt-edit [--options] -d domname file [file ...]\n"
2184 #: ../edit/virt-edit.pod:11
2187 " virt-edit [--options] -a disk.img [-a disk.img ...] file [file ...]\n"
2192 #: ../edit/virt-edit.pod:13
2195 " virt-edit [-d domname|-a disk.img] file -e 'expr'\n"
2200 #: ../edit/virt-edit.pod:17
2203 " virt-edit domname file\n"
2208 #: ../edit/virt-edit.pod:19 ../edit/virt-edit.pod:183
2211 " virt-edit disk.img [disk.img ...] file\n"
2216 #: ../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
2221 #: ../edit/virt-edit.pod:23
2223 "You must I<not> use C<virt-edit> on live virtual machines. If you do this, "
2224 "you risk disk corruption in the VM. C<virt-edit> tries to stop you from "
2225 "doing this, but doesn't catch all cases."
2229 #: ../edit/virt-edit.pod:29
2231 "C<virt-edit> is a command line tool to edit C<file> where each C<file> "
2232 "exists in the named virtual machine (or disk image)."
2236 #: ../edit/virt-edit.pod:32
2238 "Multiple filenames can be given, in which case they are each edited in "
2239 "turn. Each filename must be a full path, starting at the root directory "
2240 "(starting with '/')."
2244 #: ../edit/virt-edit.pod:36
2245 msgid "If you want to just view a file, use L<virt-cat(1)>."
2249 #: ../edit/virt-edit.pod:38
2251 "For more complex cases you should look at the L<guestfish(1)> tool (see "
2252 "L</USING GUESTFISH> below)."
2256 #: ../edit/virt-edit.pod:41
2258 "C<virt-edit> cannot be used to create a new file. L<guestfish(1)> can do "
2259 "that and much more."
2263 #: ../edit/virt-edit.pod:46
2264 msgid "Edit the named files interactively:"
2268 #: ../edit/virt-edit.pod:48
2271 " virt-edit -d mydomain /boot/grub/grub.conf\n"
2276 #: ../edit/virt-edit.pod:50
2279 " virt-edit -d mydomain /etc/passwd\n"
2284 #: ../edit/virt-edit.pod:52
2285 msgid "For Windows guests, some Windows paths are understood:"
2289 #: ../edit/virt-edit.pod:54
2292 " virt-edit -d mywindomain 'c:\\autoexec.bat'\n"
2297 #: ../edit/virt-edit.pod:56
2299 "If Perl is installed, you can also edit files non-interactively (see "
2300 "L</NON-INTERACTIVE EDITING> below). To change the init default level to 5:"
2304 #: ../edit/virt-edit.pod:60
2307 " virt-edit -d mydomain /etc/inittab -e 's/^id:.*/id:5:initdefault:/'\n"
2312 #: ../edit/virt-edit.pod:81
2313 msgid "B<-b> extension"
2317 #: ../edit/virt-edit.pod:83
2318 msgid "B<--backup> extension"
2322 #: ../edit/virt-edit.pod:85
2324 "Create a backup of the original file I<in the guest disk image>. The backup "
2325 "has the original filename with C<extension> added."
2329 #: ../edit/virt-edit.pod:88
2331 "Usually the first character of C<extension> would be a dot C<.> so you would "
2336 #: ../edit/virt-edit.pod:91
2339 " virt-edit -b .orig [etc]\n"
2344 #: ../edit/virt-edit.pod:93
2345 msgid "By default, no backup file is made."
2349 #: ../edit/virt-edit.pod:95 ../fish/guestfish.pod:181 ../fuse/guestmount.pod:96 ../inspector/virt-inspector.pod:74 ../tools/virt-list-filesystems.pl:77 ../tools/virt-list-partitions.pl:78 ../tools/virt-tar.pl:127 ../tools/virt-win-reg.pl:128
2354 #: ../edit/virt-edit.pod:97 ../fish/guestfish.pod:183 ../fuse/guestmount.pod:98 ../inspector/virt-inspector.pod:76 ../tools/virt-list-filesystems.pl:79 ../tools/virt-list-partitions.pl:80 ../tools/virt-tar.pl:129 ../tools/virt-win-reg.pl:130
2355 msgid "B<--connect URI>"
2359 #: ../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
2361 "If you specify guest block devices directly, then libvirt is not used at "
2366 #: ../edit/virt-edit.pod:114
2368 "When prompting for keys and passphrases, virt-edit normally turns echoing "
2369 "off so you cannot see what you are typing. If you are not worried about "
2370 "Tempest attacks and there is no one else in the room you can specify this "
2371 "flag to see what you are typing."
2375 #: ../edit/virt-edit.pod:119
2380 #: ../edit/virt-edit.pod:121
2381 msgid "B<--expr> EXPR"
2385 #: ../edit/virt-edit.pod:123
2387 "Instead of launching the external editor, non-interactively apply the Perl "
2388 "expression C<EXPR> to each line in the file. See L</NON-INTERACTIVE "
2393 #: ../edit/virt-edit.pod:127
2395 "Be careful to properly quote the expression to prevent it from being altered "
2400 #: ../edit/virt-edit.pod:130
2401 msgid "Note that this option is only available when Perl 5 is installed."
2405 #: ../edit/virt-edit.pod:132
2406 msgid "B<--format> raw|qcow2|..."
2410 #: ../edit/virt-edit.pod:143
2413 " virt-edit --format=raw -a disk.img file\n"
2418 #: ../edit/virt-edit.pod:147
2421 " virt-edit --format=raw -a disk.img --format -a another.img file\n"
2426 #: ../edit/virt-edit.pod:181
2427 msgid "Previous versions of virt-edit allowed you to write either:"
2431 #: ../edit/virt-edit.pod:187
2434 " virt-edit guestname file\n"
2439 #: ../edit/virt-edit.pod:195
2440 msgid "NON-INTERACTIVE EDITING"
2444 #: ../edit/virt-edit.pod:197
2446 "C<virt-edit> normally calls out to C<$EDITOR> (or vi) so the system "
2447 "administrator can interactively edit the file."
2451 #: ../edit/virt-edit.pod:200
2453 "There are two ways also to use C<virt-edit> from scripts in order to make "
2454 "automated edits to files. (Note that although you I<can> use C<virt-edit> "
2455 "like this, it's less error-prone to write scripts directly using the "
2456 "libguestfs API and Augeas for configuration file editing.)"
2460 #: ../edit/virt-edit.pod:206
2462 "The first method is to temporarily set C<$EDITOR> to any script or program "
2463 "you want to run. The script is invoked as C<$EDITOR tmpfile> and it should "
2464 "update C<tmpfile> in place however it likes."
2468 #: ../edit/virt-edit.pod:210
2470 "The second method is to use the I<-e> parameter of C<virt-edit> to run a "
2471 "short Perl snippet in the style of L<sed(1)>. For example to replace all "
2472 "instances of C<foo> with C<bar> in a file:"
2476 #: ../edit/virt-edit.pod:214
2479 " virt-edit -d domname filename -e 's/foo/bar/'\n"
2484 #: ../edit/virt-edit.pod:216
2486 "The full power of Perl regular expressions can be used (see L<perlre(1)>). "
2487 "For example to delete root's password you could do:"
2491 #: ../edit/virt-edit.pod:219
2494 " virt-edit -d domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
2499 #: ../edit/virt-edit.pod:221
2501 "What really happens is that the snippet is evaluated as a Perl expression "
2502 "for each line of the file. The line, including the final C<\\n>, is passed "
2503 "in C<$_> and the expression should update C<$_> or leave it unchanged."
2507 #: ../edit/virt-edit.pod:226
2509 "To delete a line, set C<$_> to the empty string. For example, to delete the "
2510 "C<apache> user account from the password file you can do:"
2514 #: ../edit/virt-edit.pod:229
2517 " virt-edit -d mydomain /etc/passwd -e '$_ = \"\" if /^apache:/'\n"
2522 #: ../edit/virt-edit.pod:231
2524 "To insert a line, prepend or append it to C<$_>. However appending lines to "
2525 "the end of the file is rather difficult this way since there is no concept "
2526 "of \"last line of the file\" - your expression just doesn't get called "
2527 "again. You might want to use the first method (setting C<$EDITOR>) if you "
2532 #: ../edit/virt-edit.pod:237
2534 "The variable C<$lineno> contains the current line number. As is "
2535 "traditional, the first line in the file is number C<1>."
2539 #: ../edit/virt-edit.pod:240
2541 "The return value from the expression is ignored, but the expression may call "
2542 "C<die> in order to abort the whole program, leaving the original file "
2547 #: ../edit/virt-edit.pod:244
2549 "Remember when matching the end of a line that C<$_> may contain the final "
2550 "C<\\n>, or (for DOS files) C<\\r\\n>, or if the file does not end with a "
2551 "newline then neither of these. Thus to match or substitute some text at the "
2552 "end of a line, use this regular expression:"
2556 #: ../edit/virt-edit.pod:249
2559 " /some text(\\r?\\n)?$/\n"
2564 #: ../edit/virt-edit.pod:251
2566 "Alternately, use the perl C<chomp> function, being careful not to chomp "
2567 "C<$_> itself (since that would remove all newlines from the file):"
2571 #: ../edit/virt-edit.pod:255
2574 " my $m = $_; chomp $m; $m =~ /some text$/\n"
2579 #: ../edit/virt-edit.pod:257 ../fish/guestfish.pod:858
2580 msgid "WINDOWS PATHS"
2584 #: ../edit/virt-edit.pod:259
2586 "C<virt-edit> has a limited ability to understand Windows drive letters and "
2587 "paths (eg. C<E:\\foo\\bar.txt>)."
2591 #: ../edit/virt-edit.pod:262
2592 msgid "If and only if the guest is running Windows then:"
2596 #: ../edit/virt-edit.pod:268
2598 "Drive letter prefixes like C<C:> are resolved against the Windows Registry "
2599 "to the correct filesystem."
2603 #: ../edit/virt-edit.pod:273
2605 "Any backslash (C<\\>) characters in the path are replaced with forward "
2606 "slashes so that libguestfs can process it."
2610 #: ../edit/virt-edit.pod:278
2612 "The path is resolved case insensitively to locate the file that should be "
2617 #: ../edit/virt-edit.pod:283
2618 msgid "There are some known shortcomings:"
2622 #: ../edit/virt-edit.pod:289
2623 msgid "Some NTFS symbolic links may not be followed correctly."
2627 #: ../edit/virt-edit.pod:293
2628 msgid "NTFS junction points that cross filesystems are not followed."
2632 #: ../edit/virt-edit.pod:299
2634 "L<guestfish(1)> is a more powerful, lower level tool which you can use when "
2635 "C<virt-edit> doesn't work."
2639 #: ../edit/virt-edit.pod:302
2640 msgid "Using C<virt-edit> is approximately equivalent to doing:"
2644 #: ../edit/virt-edit.pod:304
2647 " guestfish --rw -i -d domname edit /file\n"
2652 #: ../edit/virt-edit.pod:306
2654 "where C<domname> is the name of the libvirt guest, and C</file> is the full "
2659 #: ../edit/virt-edit.pod:309
2661 "The command above uses libguestfs's guest inspection feature and so does not "
2662 "work on guests that libguestfs cannot inspect, or on things like arbitrary "
2663 "disk images that don't contain guests. To edit a file on a disk image "
2668 #: ../edit/virt-edit.pod:314
2671 " guestfish --rw -a disk.img -m /dev/sda1 edit /file\n"
2676 #: ../edit/virt-edit.pod:316
2678 "where C<disk.img> is the disk image, C</dev/sda1> is the filesystem within "
2679 "the disk image to edit, and C</file> is the full path to the file."
2683 #: ../edit/virt-edit.pod:320
2685 "C<virt-edit> cannot create new files. Use the guestfish commands C<touch>, "
2686 "C<write> or C<upload> instead:"
2690 #: ../edit/virt-edit.pod:323
2693 " guestfish --rw -i -d domname touch /newfile\n"
2698 #: ../edit/virt-edit.pod:325
2701 " guestfish --rw -i -d domname write /newfile \"new content\"\n"
2706 #: ../edit/virt-edit.pod:327
2709 " guestfish --rw -i -d domname upload localfile /newfile\n"
2714 #: ../edit/virt-edit.pod:329 ../fish/guestfish.pod:1086 ../rescue/virt-rescue.pod:257 ../src/guestfs.pod:2965 ../test-tool/libguestfs-test-tool.pod:82
2715 msgid "ENVIRONMENT VARIABLES"
2719 #: ../edit/virt-edit.pod:333
2724 #: ../edit/virt-edit.pod:335
2726 "If set, this string is used as the editor. It may contain arguments, "
2727 "eg. C<\"emacs -nw\">"
2731 #: ../edit/virt-edit.pod:338
2732 msgid "If not set, C<vi> is used."
2736 #: ../edit/virt-edit.pod:351
2738 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
2739 "L<virt-tar-in(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
2740 "L<Sys::Virt(3)>, L<http://libguestfs.org/>, L<perl(1)>, L<perlre(1)>."
2744 #: ../examples/guestfs-examples.pod:5
2745 msgid "guestfs-examples - Examples of using libguestfs from C"
2749 #: ../examples/guestfs-examples.pod:9 ../src/guestfs.pod:9
2752 " #include <guestfs.h>\n"
2757 #: ../examples/guestfs-examples.pod:11
2760 " guestfs_h *g = guestfs_create ();\n"
2761 " guestfs_add_drive_ro (g, \"disk.img\");\n"
2762 " guestfs_launch (g);\n"
2767 #: ../examples/guestfs-examples.pod:15 ../src/guestfs.pod:19
2770 " cc prog.c -o prog -lguestfs\n"
2772 " cc prog.c -o prog `pkg-config libguestfs --cflags --libs`\n"
2777 #: ../examples/guestfs-examples.pod:21
2779 "This manual page contains examples of calling libguestfs from the C "
2780 "programming language. If you are not familiar with using libguestfs, you "
2781 "also need to read L<guestfs(3)>."
2785 #: ../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
2786 msgid "EXAMPLE 1: CREATE A DISK IMAGE"
2790 #: ../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
2795 #: ../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
2796 msgid "EXAMPLE 2: INSPECT A VIRTUAL MACHINE DISK IMAGE"
2800 #: ../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
2805 #: ../examples/guestfs-examples.pod:35
2807 "L<guestfs(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, "
2808 "L<guestfs-python(3)>, L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, "
2809 "L<http://libguestfs.org/>."
2813 #: ../examples/guestfs-examples.pod:44 ../examples/guestfs-recipes.pod:396 ../fish/guestfish.pod:1260 ../fish/virt-copy-in.pod:60 ../fish/virt-copy-out.pod:49 ../fish/virt-tar-in.pod:58 ../fish/virt-tar-out.pod:51 ../fuse/guestmount.pod:314 ../inspector/virt-inspector.pod:380 ../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:3098 ../test-tool/libguestfs-test-tool.pod:93
2818 #: ../examples/guestfs-examples.pod:46 ../examples/guestfs-recipes.pod:398 ../fish/guestfish.pod:1262 ../fish/virt-copy-in.pod:62 ../fish/virt-copy-out.pod:51 ../fish/virt-tar-in.pod:60 ../fish/virt-tar-out.pod:53 ../fuse/guestmount.pod:316 ../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:3100 ../test-tool/libguestfs-test-tool.pod:95
2819 msgid "Richard W.M. Jones (C<rjones at redhat dot com>)"
2823 #: ../examples/guestfs-examples.pod:50 ../ocaml/examples/guestfs-ocaml.pod:96 ../python/examples/guestfs-python.pod:59 ../ruby/examples/guestfs-ruby.pod:53
2824 msgid "Copyright (C) 2010 Red Hat Inc. L<http://libguestfs.org/>"
2828 #: ../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
2830 "The examples in this manual page may be freely copied, modified and "
2831 "distributed without any restrictions."
2835 #: ../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:3107
2837 "This library is free software; you can redistribute it and/or modify it "
2838 "under the terms of the GNU Lesser General Public License as published by the "
2839 "Free Software Foundation; either version 2 of the License, or (at your "
2840 "option) any later version."
2844 #: ../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:3112
2846 "This library is distributed in the hope that it will be useful, but WITHOUT "
2847 "ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or "
2848 "FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License "
2853 #: ../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:3117
2855 "You should have received a copy of the GNU Lesser General Public License "
2856 "along with this library; if not, write to the Free Software Foundation, "
2857 "Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA"
2861 #: ../examples/guestfs-recipes.pod:3 ../examples/guestfs-recipes.pod:12
2866 #: ../examples/guestfs-recipes.pod:5
2868 "pod2man and pod2html have differing bugs which makes it hard to write URLs "
2869 "here. The only way which works for both sorts of output is to just write "
2870 "the URL directly. Do NOT use L<...> for URLs."
2874 #: ../examples/guestfs-recipes.pod:9
2876 "We break with tradition here and don't use ALL CAPS for the section "
2877 "headings, as this makes them much easier to read."
2881 #: ../examples/guestfs-recipes.pod:16
2882 msgid "guestfs-recipes - libguestfs, guestfish and virt tools recipes"
2886 #: ../examples/guestfs-recipes.pod:20
2888 "This page contains recipes for and links to things you can do using "
2889 "libguestfs, L<guestfish(1)> and the virt tools."
2893 #: ../examples/guestfs-recipes.pod:23
2894 msgid "Audit a virtual machine for setuid files"
2898 #: ../examples/guestfs-recipes.pod:25
2900 "The link below contains a small program which can be used to audit a Linux "
2901 "virtual machine to see what setuid and setgid files it contains."
2905 #: ../examples/guestfs-recipes.pod:28
2906 msgid "https://rwmj.wordpress.com/2010/12/15/tip-audit-virtual-machine-for-setuid-files/#content"
2910 #: ../examples/guestfs-recipes.pod:30
2911 msgid "Change the background image in a Windows XP VM"
2915 #: ../examples/guestfs-recipes.pod:32
2917 "The links below explain how to use L<guestfish(1)> to change the background "
2918 "image for a user of a Windows XP VM. Unfortunately the technique appears to "
2919 "be substantially different for each version of Windows."
2923 #: ../examples/guestfs-recipes.pod:37
2925 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002655.html "
2926 "https://lists.fedoraproject.org/pipermail/virt/2011-May/002658.html"
2930 #: ../examples/guestfs-recipes.pod:40
2931 msgid "Cloning a virtual machine (Linux)"
2935 #: ../examples/guestfs-recipes.pod:42
2937 "The guestfish technique described in the link below works well for most "
2938 "Linux VMs. Depending on the Linux distro you may need to change the paths "
2943 #: ../examples/guestfs-recipes.pod:46
2944 msgid "https://rwmj.wordpress.com/2010/09/24/tip-my-procedure-for-cloning-a-fedora-vm/#content"
2948 #: ../examples/guestfs-recipes.pod:48
2950 "Avoid L<virt-clone(1)>. Currently what to do about virt-clone is under "
2955 #: ../examples/guestfs-recipes.pod:51
2956 msgid "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
2960 #: ../examples/guestfs-recipes.pod:53
2961 msgid "Cloning a virtual machine (Windows)"
2965 #: ../examples/guestfs-recipes.pod:55
2967 "It is possible to do a \"sysprep\" using libguestfs alone, although not "
2968 "straightforward. Currently there is code in the Aeolus Oz project which "
2969 "does this (using libguestfs). As part of our review of the virt-clone tool, "
2970 "we may add sysprepping ability."
2974 #: ../examples/guestfs-recipes.pod:60
2976 "https://github.com/clalancette/oz "
2977 "https://www.redhat.com/archives/virt-tools-list/2011-May/msg00019.html"
2981 #: ../examples/guestfs-recipes.pod:63
2982 msgid "Convert a CD-ROM / DVD / ISO to a tarball"
2986 #: ../examples/guestfs-recipes.pod:65
2987 msgid "This converts input C<cd.iso> to output C<cd.tar.gz>:"
2991 #: ../examples/guestfs-recipes.pod:67
2994 " guestfish --ro -a cd.iso -m /dev/sda tgz-out / cd.tar.gz\n"
2999 #: ../examples/guestfs-recipes.pod:69
3000 msgid "To export just a subdirectory, eg. C</files>, do:"
3004 #: ../examples/guestfs-recipes.pod:71
3007 " guestfish --ro -a cd.iso -m /dev/sda tgz-out /files cd.tar.gz\n"
3012 #: ../examples/guestfs-recipes.pod:73
3013 msgid "Create empty disk images"
3017 #: ../examples/guestfs-recipes.pod:75
3019 "You can use the L<guestfish(1)> I<-N> option to create empty disk images. "
3020 "The useful guide below explains the options available."
3024 #: ../examples/guestfs-recipes.pod:78
3025 msgid "https://rwmj.wordpress.com/2010/09/08/new-guestfish-n-options-in-1-5-9/#content"
3029 #: ../examples/guestfs-recipes.pod:80
3030 msgid "Dump raw filesystem content from inside a disk image or VM"
3034 #: ../examples/guestfs-recipes.pod:82
3036 "You can use the L<guestfish(1)> C<download> command to extract the raw "
3037 "filesystem content from any filesystem in a disk image or a VM (even one "
3038 "which is encrypted or buried inside an LV):"
3042 #: ../examples/guestfs-recipes.pod:86
3045 " guestfish --ro -a disk.img run : download /dev/sda1 sda1.img\n"
3050 #: ../examples/guestfs-recipes.pod:88
3053 " guestfish --ro -d Guest run : download /dev/vg_guest/lv_root lv.img\n"
3058 #: ../examples/guestfs-recipes.pod:90
3059 msgid "To list the filesystems in a disk image, use L<virt-filesystems(1)>."
3063 #: ../examples/guestfs-recipes.pod:92
3064 msgid "Edit grub configuration in a VM"
3068 #: ../examples/guestfs-recipes.pod:94
3069 msgid "You can use this to:"
3073 #: ../examples/guestfs-recipes.pod:100
3074 msgid "Fix a virtual machine that does not boot."
3078 #: ../examples/guestfs-recipes.pod:104
3079 msgid "Change which kernel is used to boot the VM."
3083 #: ../examples/guestfs-recipes.pod:108
3084 msgid "Change kernel command line options."
3088 #: ../examples/guestfs-recipes.pod:112
3089 msgid "Use L<virt-edit(1)> to edit the grub configuration:"
3093 #: ../examples/guestfs-recipes.pod:114
3096 " virt-edit -d BrokenGuest /boot/grub/grub.conf\n"
3101 #: ../examples/guestfs-recipes.pod:116
3103 "or for general tinkering inside an unbootable VM use L<virt-rescue(1)> like "
3108 #: ../examples/guestfs-recipes.pod:119
3111 " virt-rescue -d BrokenGuest\n"
3116 #: ../examples/guestfs-recipes.pod:121
3117 msgid "Export any directory from a VM"
3121 #: ../examples/guestfs-recipes.pod:123
3122 msgid "To export C</home> from a VM into a local directory use L<virt-copy-out(1)>:"
3126 #: ../examples/guestfs-recipes.pod:126
3129 " virt-copy-out -d Guest /home .\n"
3134 #: ../examples/guestfs-recipes.pod:128 ../fish/guestfish-actions.pod:9 ../fish/guestfish-actions.pod:1292 ../fish/guestfish-actions.pod:1934 ../src/guestfs-actions.pod:11 ../src/guestfs-actions.pod:1922 ../src/guestfs-actions.pod:2860 ../src/guestfs.pod:1639 ../tools/virt-win-reg.pl:706
3139 #: ../examples/guestfs-recipes.pod:134
3141 "The final dot of the command is not a printing error. It means we want to "
3142 "copy out to the current directory."
3146 #: ../examples/guestfs-recipes.pod:139
3147 msgid "This creates a directory called C<home> under the current directory."
3151 #: ../examples/guestfs-recipes.pod:143
3153 "If the guest is a Windows guest then you can use drive letters and "
3154 "backslashes, but you must prefix the path with C<win:> and quote it to "
3155 "protect it from the shell, like this:"
3159 #: ../examples/guestfs-recipes.pod:147
3162 " virt-copy-out -d WinGuest 'win:c:\\windows\\system32\\config' .\n"
3167 #: ../examples/guestfs-recipes.pod:149
3168 msgid "To get the output as a compressed tarball, do:"
3172 #: ../examples/guestfs-recipes.pod:151
3175 " virt-tar-out -d Guest /home - | gzip --best > home.tar.gz\n"
3180 #: ../examples/guestfs-recipes.pod:153
3182 "Although it sounds tempting, this is usually not a reliable way to get a "
3183 "backup from a running guest. See the entry in the FAQ: "
3184 "http://libguestfs.org/FAQ.html#backup"
3188 #: ../examples/guestfs-recipes.pod:157
3189 msgid "Find out which user is using the most space"
3193 #: ../examples/guestfs-recipes.pod:159
3195 "This simple script examines a Linux guest to find out which user is using "
3196 "the most space in their home directory:"
3200 #: ../examples/guestfs-recipes.pod:162
3208 #: ../examples/guestfs-recipes.pod:164
3216 #: ../examples/guestfs-recipes.pod:166
3225 #: ../examples/guestfs-recipes.pod:169
3228 " eval $(guestfish --ro -d \"$vm\" -i --listen)\n"
3233 #: ../examples/guestfs-recipes.pod:171
3236 " for d in $(guestfish --remote ls \"$dir\"); do\n"
3237 " echo -n \"$dir/$d\"\n"
3239 " guestfish --remote du \"$dir/$d\";\n"
3240 " done | sort -nr -k 2\n"
3245 #: ../examples/guestfs-recipes.pod:177 ../fish/guestfish.pod:941
3248 " guestfish --remote exit\n"
3253 #: ../examples/guestfs-recipes.pod:179
3254 msgid "Get DHCP address from a VM"
3258 #: ../examples/guestfs-recipes.pod:181
3260 "The link below explains the many different possible techniques for getting "
3261 "the last assigned DHCP address of a virtual machine."
3265 #: ../examples/guestfs-recipes.pod:184
3266 msgid "https://rwmj.wordpress.com/2011/03/31/tip-code-for-getting-dhcp-address-from-a-virtual-machine-disk-image/#content"
3270 #: ../examples/guestfs-recipes.pod:186
3272 "In the libguestfs source examples directory you will find the latest version "
3273 "of the C<virt-dhcp-address.c> program."
3277 #: ../examples/guestfs-recipes.pod:189
3278 msgid "Get the operating system product name string"
3282 #: ../examples/guestfs-recipes.pod:191
3283 msgid "Save the following script into a file called C<product-name.sh>:"
3287 #: ../examples/guestfs-recipes.pod:193
3292 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3293 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3294 " guestfish --remote inspect-get-product-name \"$root\"\n"
3295 " guestfish --remote exit\n"
3300 #: ../examples/guestfs-recipes.pod:200
3301 msgid "Make the script executable and run it on a named guest:"
3305 #: ../examples/guestfs-recipes.pod:202
3308 " # product-name.sh RHEL60x64\n"
3309 " Red Hat Enterprise Linux Server release 6.0 (Santiago)\n"
3314 #: ../examples/guestfs-recipes.pod:205
3316 "You can also use an XPath query on the L<virt-inspector(1)> XML using the "
3317 "C<xpath> command line tool or from your favourite programming language:"
3321 #: ../examples/guestfs-recipes.pod:209
3324 " # virt-inspector RHEL60x64 > xml\n"
3325 " # xpath '//product_name' < xml\n"
3328 " <product_name>Red Hat Enterprise Linux Server release 6.0 "
3329 "(Santiago)</product_name>\n"
3334 #: ../examples/guestfs-recipes.pod:215
3335 msgid "Get the default boot kernel for a Linux VM"
3339 #: ../examples/guestfs-recipes.pod:217
3341 "The link below contains a program to print the default boot kernel for a "
3346 #: ../examples/guestfs-recipes.pod:220
3347 msgid "https://rwmj.wordpress.com/2010/10/30/tip-use-augeas-to-get-the-default-boot-kernel-for-a-vm/#content"
3351 #: ../examples/guestfs-recipes.pod:222
3353 "It uses Augeas, and the technique is generally applicable for many different "
3358 #: ../examples/guestfs-recipes.pod:229
3359 msgid "listing the user accounts in the guest"
3363 #: ../examples/guestfs-recipes.pod:233
3364 msgid "what repositories is it configured to use"
3368 #: ../examples/guestfs-recipes.pod:237
3369 msgid "what NTP servers does it connect to"
3373 #: ../examples/guestfs-recipes.pod:241
3374 msgid "what were the boot messages last time it booted"
3378 #: ../examples/guestfs-recipes.pod:245
3379 msgid "listing who was logged in recently"
3383 #: ../examples/guestfs-recipes.pod:249
3384 msgid "http://augeas.net/"
3388 #: ../examples/guestfs-recipes.pod:251
3389 msgid "Install RPMs in a guest"
3393 #: ../examples/guestfs-recipes.pod:253
3395 "The link below contains a method to install RPMs in a guest. In fact the "
3396 "RPMs are just uploaded to the guest along with a \"firstboot\" script that "
3397 "installs them next time the guest is booted. You could use this technique "
3398 "to install vital security updates in an offline guest."
3402 #: ../examples/guestfs-recipes.pod:259
3403 msgid "https://rwmj.wordpress.com/2010/12/01/tip-install-rpms-in-a-guest/#content"
3407 #: ../examples/guestfs-recipes.pod:261
3408 msgid "List applications installed in a VM"
3412 #: ../examples/guestfs-recipes.pod:263
3413 msgid "Save the following to a file C<list-apps.sh>:"
3417 #: ../examples/guestfs-recipes.pod:265
3422 " eval \"$(guestfish --ro -d \"$1\" --i --listen)\"\n"
3423 " root=\"$(guestfish --remote inspect-get-roots)\"\n"
3424 " guestfish --remote inspect-list-applications \"$root\"\n"
3425 " guestfish --remote exit\n"
3430 #: ../examples/guestfs-recipes.pod:272
3432 "Make the file executable and then you can run it on any named virtual "
3437 #: ../examples/guestfs-recipes.pod:275
3440 " # list-apps.sh WinGuest\n"
3442 " app_name: Mozilla Firefox (3.6.12)\n"
3443 " app_display_name: Mozilla Firefox (3.6.12)\n"
3445 " app_version: 3.6.12 (en-GB)\n"
3447 " app_install_path: C:\\Program Files\\Mozilla Firefox\n"
3448 " app_trans_path:\n"
3449 " app_publisher: Mozilla\n"
3450 " app_url: http://www.mozilla.com/en-GB/\n"
3451 " app_source_package:\n"
3453 " app_description: Mozilla Firefox\n"
3456 " app_name: VLC media player\n"
3457 " app_display_name: VLC media player 1.1.5\n"
3459 " app_version: 1.1.5\n"
3461 " app_install_path: C:\\Program Files\\VideoLAN\\VLC\n"
3462 " app_trans_path:\n"
3463 " app_publisher: VideoLAN\n"
3464 " app_url: http://www.videolan.org/\n"
3465 " app_source_package:\n"
3467 " app_description:\n"
3473 #: ../examples/guestfs-recipes.pod:305
3475 "If you want to run the script on disk images (instead of libvirt virtual "
3476 "machines), change C<-d \"$1\"> to C<-a \"$1\">. See also "
3477 "L<virt-inspector(1)>."
3481 #: ../examples/guestfs-recipes.pod:309
3482 msgid "List files and directories in a VM"
3486 #: ../examples/guestfs-recipes.pod:311
3487 msgid "This involves using the L<guestfish(1)> C<find0> command like this:"
3491 #: ../examples/guestfs-recipes.pod:313
3494 " guestfish --ro -d Guest -i find0 / - | tr '\\0' '\\n' | sort\n"
3499 #: ../examples/guestfs-recipes.pod:315
3500 msgid "List services in a Windows VM"
3504 #: ../examples/guestfs-recipes.pod:317
3506 "The link below contains a script that can be used to list out the services "
3507 "from a Windows VM, and whether those services run at boot time or are loaded "
3512 #: ../examples/guestfs-recipes.pod:321
3513 msgid "https://rwmj.wordpress.com/2010/12/10/tip-list-services-in-a-windows-guest/#content"
3517 #: ../examples/guestfs-recipes.pod:323
3518 msgid "Make a disk image sparse"
3522 #: ../examples/guestfs-recipes.pod:325
3524 "The link below contains some guides for making a disk image sparse (or "
3525 "reintroducing sparseness)."
3529 #: ../examples/guestfs-recipes.pod:328
3530 msgid "https://rwmj.wordpress.com/2010/10/19/tip-making-a-disk-image-sparse/#content"
3534 #: ../examples/guestfs-recipes.pod:330
3535 msgid "Monitor disk usage over time"
3539 #: ../examples/guestfs-recipes.pod:332
3541 "You can use L<virt-df(1)> to monitor disk usage of your guests over time. "
3542 "The link below contains a guide."
3546 #: ../examples/guestfs-recipes.pod:335
3547 msgid "http://virt-tools.org/learning/advanced-virt-df/"
3551 #: ../examples/guestfs-recipes.pod:337
3552 msgid "Reading the Windows Event Log from Windows Vista (or later)"
3556 #: ../examples/guestfs-recipes.pod:339
3558 "L<guestfish(1)> plus the tools described in the link below can be used to "
3559 "read out the Windows Event Log from any virtual machine running Windows "
3560 "Vista or a later version."
3564 #: ../examples/guestfs-recipes.pod:343
3565 msgid "https://rwmj.wordpress.com/2011/04/17/decoding-the-windows-event-log-using-guestfish/#content"
3569 #: ../examples/guestfs-recipes.pod:345
3570 msgid "Remove root password (Linux)"
3574 #: ../examples/guestfs-recipes.pod:347
3576 "Using the L<virt-edit(1)> I<-e> option you can do simple replacements on "
3577 "files. One use is to remove the root password from a Linux guest:"
3581 #: ../examples/guestfs-recipes.pod:350
3584 " virt-edit domname /etc/passwd -e 's/^root:.*?:/root::/'\n"
3589 #: ../examples/guestfs-recipes.pod:352
3590 msgid "Remove Administrator password (Windows)"
3594 #: ../examples/guestfs-recipes.pod:354
3596 "The link below contains one technique for removing the Administrator "
3597 "password from a Windows VM, or to be more precise, it gives you a command "
3598 "prompt the next time you log in which you can use to bypass any security:"
3602 #: ../examples/guestfs-recipes.pod:359
3603 msgid "https://mdbooth.wordpress.com/2010/10/18/resetting-a-windows-guests-administrator-password-with-guestfish/"
3607 #: ../examples/guestfs-recipes.pod:361
3608 msgid "Unpack a live CD"
3612 #: ../examples/guestfs-recipes.pod:363
3614 "Linux live CDs often contain multiple layers of disk images wrapped like a "
3615 "Russian doll. You can use L<guestfish(1)> to look inside these multiple "
3616 "layers, as outlined in the guide below."
3620 #: ../examples/guestfs-recipes.pod:367
3621 msgid "https://rwmj.wordpress.com/2009/07/15/unpack-the-russian-doll-of-a-f11-live-cd/#content"
3625 #: ../examples/guestfs-recipes.pod:369
3626 msgid "Uploading and downloading files"
3630 #: ../examples/guestfs-recipes.pod:371
3632 "The link below contains general tips on uploading (copying in) and "
3633 "downloading (copying out) files from VMs."
3637 #: ../examples/guestfs-recipes.pod:374
3638 msgid "https://rwmj.wordpress.com/2010/12/02/tip-uploading-and-downloading/#content"
3642 #: ../examples/guestfs-recipes.pod:376
3643 msgid "Use libguestfs tools on VMware ESX guests"
3647 #: ../examples/guestfs-recipes.pod:378
3649 "The link below explains how to use libguestfs, L<guestfish(1)> and the virt "
3650 "tools on any VMware ESX guests, by first sharing the VMware VMFS over sshfs."
3654 #: ../examples/guestfs-recipes.pod:382
3655 msgid "https://rwmj.wordpress.com/2011/05/10/tip-use-libguestfs-on-vmware-esx-guests/#content"
3659 #: ../examples/guestfs-recipes.pod:386
3661 "L<guestfs(3)>, L<guestfish(1)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
3662 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
3663 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
3667 #: ../examples/guestfs-recipes.pod:402
3668 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
3672 #: ../fish/guestfish-actions.pod:1
3677 #: ../fish/guestfish-actions.pod:3
3680 " add-cdrom filename\n"
3685 #: ../fish/guestfish-actions.pod:5 ../src/guestfs-actions.pod:7
3686 msgid "This function adds a virtual CD-ROM disk image to the guest."
3690 #: ../fish/guestfish-actions.pod:7 ../src/guestfs-actions.pod:9
3691 msgid "This is equivalent to the qemu parameter I<-cdrom filename>."
3695 #: ../fish/guestfish-actions.pod:15
3697 "This call checks for the existence of C<filename>. This stops you from "
3698 "specifying other types of drive which are supported by qemu such as C<nbd:> "
3699 "and C<http:> URLs. To specify those, use the general L</config> call "
3704 #: ../fish/guestfish-actions.pod:22
3706 "If you just want to add an ISO file (often you use this as an efficient way "
3707 "to transfer large files into the guest), then you should probably use "
3708 "L</add-drive-ro> instead."
3712 #: ../fish/guestfish-actions.pod:28 ../fish/guestfish-actions.pod:163 ../fish/guestfish-actions.pod:177
3714 "This function is deprecated. In new code, use the L</add_drive_opts> call "
3719 #: ../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:3090 ../fish/guestfish-actions.pod:3297 ../fish/guestfish-actions.pod:3411 ../fish/guestfish-actions.pod:3459 ../fish/guestfish-actions.pod:4360 ../fish/guestfish-actions.pod:4383 ../fish/guestfish-actions.pod:4405 ../fish/guestfish-actions.pod:4443 ../fish/guestfish-actions.pod:5092 ../fish/guestfish-actions.pod:5190 ../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:4633 ../src/guestfs-actions.pod:4952 ../src/guestfs-actions.pod:5170 ../src/guestfs-actions.pod:5260 ../src/guestfs-actions.pod:6549 ../src/guestfs-actions.pod:6579 ../src/guestfs-actions.pod:6612 ../src/guestfs-actions.pod:6671 ../src/guestfs-actions.pod:7607 ../src/guestfs-actions.pod:7719 ../src/guestfs-actions.pod:7889
3721 "Deprecated functions will not be removed from the API, but the fact that "
3722 "they are deprecated indicates that there are problems with correct use of "
3727 #: ../fish/guestfish-actions.pod:35
3732 #: ../fish/guestfish-actions.pod:37
3737 #: ../fish/guestfish-actions.pod:39
3740 " add-domain dom [libvirturi:..] [readonly:..] [iface:..] [live:..] "
3746 #: ../fish/guestfish-actions.pod:41
3748 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
3749 "It works by connecting to libvirt, requesting the domain and domain XML from "
3750 "libvirt, parsing it for disks, and calling L</add-drive-opts> on each one."
3754 #: ../fish/guestfish-actions.pod:46 ../src/guestfs-actions.pod:64
3756 "The number of disks added is returned. This operation is atomic: if an "
3757 "error is returned, then no disks are added."
3761 #: ../fish/guestfish-actions.pod:49 ../src/guestfs-actions.pod:67
3763 "This function does some minimal checks to make sure the libvirt domain is "
3764 "not running (unless C<readonly> is true). In a future version we will try "
3765 "to acquire the libvirt lock on each disk."
3769 #: ../fish/guestfish-actions.pod:53 ../src/guestfs-actions.pod:71
3771 "Disks must be accessible locally. This often means that adding disks from a "
3772 "remote libvirt connection (see L<http://libvirt.org/remote.html>) will fail "
3773 "unless those disks are accessible via the same device path locally too."
3777 #: ../fish/guestfish-actions.pod:58 ../src/guestfs-actions.pod:76
3779 "The optional C<libvirturi> parameter sets the libvirt URI (see "
3780 "L<http://libvirt.org/uri.html>). If this is not set then we connect to the "
3781 "default libvirt URI (or one set through an environment variable, see the "
3782 "libvirt documentation for full details)."
3786 #: ../fish/guestfish-actions.pod:64 ../src/guestfs-actions.pod:82
3788 "The optional C<live> flag controls whether this call will try to connect to "
3789 "a running virtual machine C<guestfsd> process if it sees a suitable "
3790 "E<lt>channelE<gt> element in the libvirt XML definition. The default (if "
3791 "the flag is omitted) is never to try. See L<guestfs(3)/ATTACHING TO RUNNING "
3792 "DAEMONS> for more information."
3796 #: ../fish/guestfish-actions.pod:71 ../src/guestfs-actions.pod:89
3798 "If the C<allowuuid> flag is true (default is false) then a UUID I<may> be "
3799 "passed instead of the domain name. The C<dom> string is treated as a UUID "
3800 "first and looked up, and if that lookup fails then we treat C<dom> as a name "
3805 #: ../fish/guestfish-actions.pod:76
3807 "The other optional parameters are passed directly through to "
3808 "L</add-drive-opts>."
3812 #: ../fish/guestfish-actions.pod:79 ../fish/guestfish-actions.pod:143 ../fish/guestfish-actions.pod:573 ../fish/guestfish-actions.pod:1973 ../fish/guestfish-actions.pod:3139 ../fish/guestfish-actions.pod:3312 ../fish/guestfish-actions.pod:3447
3814 "This command has one or more optional arguments. See L</OPTIONAL "
3819 #: ../fish/guestfish-actions.pod:81
3824 #: ../fish/guestfish-actions.pod:83
3827 " add-drive filename\n"
3832 #: ../fish/guestfish-actions.pod:85
3834 "This function is the equivalent of calling L</add-drive-opts> with no "
3835 "optional parameters, so the disk is added writable, with the format being "
3836 "detected automatically."
3840 #: ../fish/guestfish-actions.pod:89
3842 "Automatic detection of the format opens you up to a potential security hole "
3843 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
3844 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
3845 "you should think about replacing calls to this function with calls to "
3846 "L</add-drive-opts>, and specifying the format."
3850 #: ../fish/guestfish-actions.pod:96
3851 msgid "add-drive-opts"
3855 #: ../fish/guestfish-actions.pod:98
3860 #: ../fish/guestfish-actions.pod:100
3863 " add-drive-opts filename [readonly:..] [format:..] [iface:..]\n"
3868 #: ../fish/guestfish-actions.pod:102 ../src/guestfs-actions.pod:160
3870 "This function adds a virtual machine disk image C<filename> to libguestfs. "
3871 "The first time you call this function, the disk appears as C</dev/sda>, the "
3872 "second time as C</dev/sdb>, and so on."
3876 #: ../fish/guestfish-actions.pod:107 ../src/guestfs-actions.pod:165
3878 "You don't necessarily need to be root when using libguestfs. However you "
3879 "obviously do need sufficient permissions to access the filename for whatever "
3880 "operations you want to perform (ie. read access if you just want to read the "
3881 "image or write access if you want to modify the image)."
3885 #: ../fish/guestfish-actions.pod:113 ../src/guestfs-actions.pod:171
3886 msgid "This call checks that C<filename> exists."
3890 #: ../fish/guestfish-actions.pod:115 ../fish/guestfish-actions.pod:3101 ../src/guestfs-actions.pod:173 ../src/guestfs-actions.pod:4660
3891 msgid "The optional arguments are:"
3895 #: ../fish/guestfish-actions.pod:119 ../src/guestfs-actions.pod:177
3900 #: ../fish/guestfish-actions.pod:121 ../src/guestfs-actions.pod:179
3902 "If true then the image is treated as read-only. Writes are still allowed, "
3903 "but they are stored in a temporary snapshot overlay which is discarded at "
3904 "the end. The disk that you add is not modified."
3908 #: ../fish/guestfish-actions.pod:125 ../src/guestfs-actions.pod:183
3913 #: ../fish/guestfish-actions.pod:127
3915 "This forces the image format. If you omit this (or use L</add-drive> or "
3916 "L</add-drive-ro>) then the format is automatically detected. Possible "
3917 "formats include C<raw> and C<qcow2>."
3921 #: ../fish/guestfish-actions.pod:131 ../src/guestfs-actions.pod:189
3923 "Automatic detection of the format opens you up to a potential security hole "
3924 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
3925 "RHBZ#642934. Specifying the format closes this security hole."
3929 #: ../fish/guestfish-actions.pod:136 ../src/guestfs-actions.pod:194
3934 #: ../fish/guestfish-actions.pod:138
3936 "This rarely-used option lets you emulate the behaviour of the deprecated "
3937 "L</add-drive-with-if> call (q.v.)"
3941 #: ../fish/guestfish-actions.pod:145
3942 msgid "add-drive-ro"
3946 #: ../fish/guestfish-actions.pod:147
3951 #: ../fish/guestfish-actions.pod:149
3954 " add-drive-ro filename\n"
3959 #: ../fish/guestfish-actions.pod:151
3961 "This function is the equivalent of calling L</add-drive-opts> with the "
3962 "optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the disk "
3963 "is added read-only, with the format being detected automatically."
3967 #: ../fish/guestfish-actions.pod:156
3968 msgid "add-drive-ro-with-if"
3972 #: ../fish/guestfish-actions.pod:158
3975 " add-drive-ro-with-if filename iface\n"
3980 #: ../fish/guestfish-actions.pod:160
3982 "This is the same as L</add-drive-ro> but it allows you to specify the QEMU "
3983 "interface emulation to use at run time."
3987 #: ../fish/guestfish-actions.pod:170
3988 msgid "add-drive-with-if"
3992 #: ../fish/guestfish-actions.pod:172
3995 " add-drive-with-if filename iface\n"
4000 #: ../fish/guestfish-actions.pod:174
4002 "This is the same as L</add-drive> but it allows you to specify the QEMU "
4003 "interface emulation to use at run time."
4007 #: ../fish/guestfish-actions.pod:184
4012 #: ../fish/guestfish-actions.pod:186
4015 " aug-clear augpath\n"
4020 #: ../fish/guestfish-actions.pod:188 ../src/guestfs-actions.pod:290
4022 "Set the value associated with C<path> to C<NULL>. This is the same as the "
4023 "L<augtool(1)> C<clear> command."
4027 #: ../fish/guestfish-actions.pod:191
4032 #: ../fish/guestfish-actions.pod:193
4040 #: ../fish/guestfish-actions.pod:195
4042 "Close the current Augeas handle and free up any resources used by it. After "
4043 "calling this, you have to call L</aug-init> again before you can use any "
4044 "other Augeas functions."
4048 #: ../fish/guestfish-actions.pod:200
4053 #: ../fish/guestfish-actions.pod:202
4056 " aug-defnode name expr val\n"
4061 #: ../fish/guestfish-actions.pod:204 ../src/guestfs-actions.pod:319
4062 msgid "Defines a variable C<name> whose value is the result of evaluating C<expr>."
4066 #: ../fish/guestfish-actions.pod:207
4068 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
4069 "calling L</aug-set> C<expr>, C<value>. C<name> will be the nodeset "
4070 "containing that single node."
4074 #: ../fish/guestfish-actions.pod:211 ../src/guestfs-actions.pod:326
4076 "On success this returns a pair containing the number of nodes in the "
4077 "nodeset, and a boolean flag if a node was created."
4081 #: ../fish/guestfish-actions.pod:215
4086 #: ../fish/guestfish-actions.pod:217
4089 " aug-defvar name expr\n"
4094 #: ../fish/guestfish-actions.pod:219 ../src/guestfs-actions.pod:343
4096 "Defines an Augeas variable C<name> whose value is the result of evaluating "
4097 "C<expr>. If C<expr> is NULL, then C<name> is undefined."
4101 #: ../fish/guestfish-actions.pod:223 ../src/guestfs-actions.pod:347
4103 "On success this returns the number of nodes in C<expr>, or C<0> if C<expr> "
4104 "evaluates to something which is not a nodeset."
4108 #: ../fish/guestfish-actions.pod:226
4113 #: ../fish/guestfish-actions.pod:228
4116 " aug-get augpath\n"
4121 #: ../fish/guestfish-actions.pod:230 ../src/guestfs-actions.pod:360
4123 "Look up the value associated with C<path>. If C<path> matches exactly one "
4124 "node, the C<value> is returned."
4128 #: ../fish/guestfish-actions.pod:233
4133 #: ../fish/guestfish-actions.pod:235
4136 " aug-init root flags\n"
4141 #: ../fish/guestfish-actions.pod:237 ../src/guestfs-actions.pod:375
4143 "Create a new Augeas handle for editing configuration files. If there was "
4144 "any previous Augeas handle associated with this guestfs session, then it is "
4149 #: ../fish/guestfish-actions.pod:241
4150 msgid "You must call this before using any other L</aug-*> commands."
4154 #: ../fish/guestfish-actions.pod:244 ../src/guestfs-actions.pod:382
4155 msgid "C<root> is the filesystem root. C<root> must not be NULL, use C</> instead."
4159 #: ../fish/guestfish-actions.pod:247 ../src/guestfs-actions.pod:385
4161 "The flags are the same as the flags defined in E<lt>augeas.hE<gt>, the "
4162 "logical I<or> of the following integers:"
4166 #: ../fish/guestfish-actions.pod:253 ../src/guestfs-actions.pod:391
4167 msgid "C<AUG_SAVE_BACKUP> = 1"
4171 #: ../fish/guestfish-actions.pod:255 ../src/guestfs-actions.pod:393
4172 msgid "Keep the original file with a C<.augsave> extension."
4176 #: ../fish/guestfish-actions.pod:257 ../src/guestfs-actions.pod:395
4177 msgid "C<AUG_SAVE_NEWFILE> = 2"
4181 #: ../fish/guestfish-actions.pod:259 ../src/guestfs-actions.pod:397
4183 "Save changes into a file with extension C<.augnew>, and do not overwrite "
4184 "original. Overrides C<AUG_SAVE_BACKUP>."
4188 #: ../fish/guestfish-actions.pod:262 ../src/guestfs-actions.pod:400
4189 msgid "C<AUG_TYPE_CHECK> = 4"
4193 #: ../fish/guestfish-actions.pod:264 ../src/guestfs-actions.pod:402
4194 msgid "Typecheck lenses."
4198 #: ../fish/guestfish-actions.pod:266
4200 "This option is only useful when debugging Augeas lenses. Use of this option "
4201 "may require additional memory for the libguestfs appliance. You may need to "
4202 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call L</set-memsize>."
4206 #: ../fish/guestfish-actions.pod:271 ../src/guestfs-actions.pod:409
4207 msgid "C<AUG_NO_STDINC> = 8"
4211 #: ../fish/guestfish-actions.pod:273 ../src/guestfs-actions.pod:411
4212 msgid "Do not use standard load path for modules."
4216 #: ../fish/guestfish-actions.pod:275 ../src/guestfs-actions.pod:413
4217 msgid "C<AUG_SAVE_NOOP> = 16"
4221 #: ../fish/guestfish-actions.pod:277 ../src/guestfs-actions.pod:415
4222 msgid "Make save a no-op, just record what would have been changed."
4226 #: ../fish/guestfish-actions.pod:279 ../src/guestfs-actions.pod:417
4227 msgid "C<AUG_NO_LOAD> = 32"
4231 #: ../fish/guestfish-actions.pod:281
4232 msgid "Do not load the tree in L</aug-init>."
4236 #: ../fish/guestfish-actions.pod:285
4237 msgid "To close the handle, you can call L</aug-close>."
4241 #: ../fish/guestfish-actions.pod:287 ../src/guestfs-actions.pod:425
4242 msgid "To find out more about Augeas, see L<http://augeas.net/>."
4246 #: ../fish/guestfish-actions.pod:289
4251 #: ../fish/guestfish-actions.pod:291
4254 " aug-insert augpath label true|false\n"
4259 #: ../fish/guestfish-actions.pod:293 ../src/guestfs-actions.pod:439
4261 "Create a new sibling C<label> for C<path>, inserting it into the tree before "
4262 "or after C<path> (depending on the boolean flag C<before>)."
4266 #: ../fish/guestfish-actions.pod:297 ../src/guestfs-actions.pod:443
4268 "C<path> must match exactly one existing node in the tree, and C<label> must "
4269 "be a label, ie. not contain C</>, C<*> or end with a bracketed index C<[N]>."
4273 #: ../fish/guestfish-actions.pod:301
4278 #: ../fish/guestfish-actions.pod:303
4286 #: ../fish/guestfish-actions.pod:305 ../src/guestfs-actions.pod:456
4287 msgid "Load files into the tree."
4291 #: ../fish/guestfish-actions.pod:307 ../src/guestfs-actions.pod:458
4292 msgid "See C<aug_load> in the Augeas documentation for the full gory details."
4296 #: ../fish/guestfish-actions.pod:310
4301 #: ../fish/guestfish-actions.pod:312
4309 #: ../fish/guestfish-actions.pod:314
4311 "This is just a shortcut for listing L</aug-match> C<path/*> and sorting the "
4312 "resulting nodes into alphabetical order."
4316 #: ../fish/guestfish-actions.pod:317
4321 #: ../fish/guestfish-actions.pod:319
4324 " aug-match augpath\n"
4329 #: ../fish/guestfish-actions.pod:321 ../src/guestfs-actions.pod:486
4331 "Returns a list of paths which match the path expression C<path>. The "
4332 "returned paths are sufficiently qualified so that they match exactly one "
4333 "node in the current tree."
4337 #: ../fish/guestfish-actions.pod:325
4342 #: ../fish/guestfish-actions.pod:327
4345 " aug-mv src dest\n"
4350 #: ../fish/guestfish-actions.pod:329 ../src/guestfs-actions.pod:503
4352 "Move the node C<src> to C<dest>. C<src> must match exactly one node. "
4353 "C<dest> is overwritten if it exists."
4357 #: ../fish/guestfish-actions.pod:332
4362 #: ../fish/guestfish-actions.pod:334
4370 #: ../fish/guestfish-actions.pod:336 ../src/guestfs-actions.pod:516
4371 msgid "Remove C<path> and all of its children."
4375 #: ../fish/guestfish-actions.pod:338 ../src/guestfs-actions.pod:518
4376 msgid "On success this returns the number of entries which were removed."
4380 #: ../fish/guestfish-actions.pod:340
4385 #: ../fish/guestfish-actions.pod:342
4393 #: ../fish/guestfish-actions.pod:344 ../src/guestfs-actions.pod:529
4394 msgid "This writes all pending changes to disk."
4398 #: ../fish/guestfish-actions.pod:346
4400 "The flags which were passed to L</aug-init> affect exactly how files are "
4405 #: ../fish/guestfish-actions.pod:349
4410 #: ../fish/guestfish-actions.pod:351
4413 " aug-set augpath val\n"
4418 #: ../fish/guestfish-actions.pod:353 ../src/guestfs-actions.pod:545
4419 msgid "Set the value associated with C<path> to C<val>."
4423 #: ../fish/guestfish-actions.pod:355
4425 "In the Augeas API, it is possible to clear a node by setting the value to "
4426 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
4427 "this call. Instead you must use the L</aug-clear> call."
4431 #: ../fish/guestfish-actions.pod:360
4436 #: ../fish/guestfish-actions.pod:362
4439 " available 'groups ...'\n"
4444 #: ../fish/guestfish-actions.pod:364 ../src/guestfs-actions.pod:562
4446 "This command is used to check the availability of some groups of "
4447 "functionality in the appliance, which not all builds of the libguestfs "
4448 "appliance will be able to provide."
4452 #: ../fish/guestfish-actions.pod:368
4454 "The libguestfs groups, and the functions that those groups correspond to, "
4455 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
4456 "runtime by calling L</available-all-groups>."
4460 #: ../fish/guestfish-actions.pod:373 ../src/guestfs-actions.pod:571
4462 "The argument C<groups> is a list of group names, eg: C<[\"inotify\", "
4463 "\"augeas\"]> would check for the availability of the Linux inotify functions "
4464 "and Augeas (configuration file editing) functions."
4468 #: ../fish/guestfish-actions.pod:378 ../src/guestfs-actions.pod:576
4469 msgid "The command returns no error if I<all> requested groups are available."
4473 #: ../fish/guestfish-actions.pod:380 ../src/guestfs-actions.pod:578
4475 "It fails with an error if one or more of the requested groups is unavailable "
4480 #: ../fish/guestfish-actions.pod:383 ../src/guestfs-actions.pod:581
4482 "If an unknown group name is included in the list of groups then an error is "
4487 #: ../fish/guestfish-actions.pod:386 ../src/guestfs-actions.pod:584
4492 #: ../fish/guestfish-actions.pod:392
4493 msgid "You must call L</launch> before calling this function."
4497 #: ../fish/guestfish-actions.pod:394 ../src/guestfs-actions.pod:592
4499 "The reason is because we don't know what groups are supported by the "
4500 "appliance/daemon until it is running and can be queried."
4504 #: ../fish/guestfish-actions.pod:400 ../src/guestfs-actions.pod:598
4506 "If a group of functions is available, this does not necessarily mean that "
4507 "they will work. You still have to check for errors when calling individual "
4508 "API functions even if they are available."
4512 #: ../fish/guestfish-actions.pod:407 ../src/guestfs-actions.pod:605
4514 "It is usually the job of distro packagers to build complete functionality "
4515 "into the libguestfs appliance. Upstream libguestfs, if built from source "
4516 "with all requirements satisfied, will support everything."
4520 #: ../fish/guestfish-actions.pod:414
4522 "This call was added in version C<1.0.80>. In previous versions of "
4523 "libguestfs all you could do would be to speculatively execute a command to "
4524 "find out if the daemon implemented it. See also L</version>."
4528 #: ../fish/guestfish-actions.pod:421
4529 msgid "available-all-groups"
4533 #: ../fish/guestfish-actions.pod:423
4536 " available-all-groups\n"
4541 #: ../fish/guestfish-actions.pod:425
4543 "This command returns a list of all optional groups that this daemon knows "
4544 "about. Note this returns both supported and unsupported groups. To find "
4545 "out which ones the daemon can actually support you have to call "
4546 "L</available> on each member of the returned list."
4550 #: ../fish/guestfish-actions.pod:431
4551 msgid "See also L</available> and L<guestfs(3)/AVAILABILITY>."
4555 #: ../fish/guestfish-actions.pod:433
4560 #: ../fish/guestfish-actions.pod:435
4563 " base64-in (base64file|-) filename\n"
4568 #: ../fish/guestfish-actions.pod:437 ../src/guestfs-actions.pod:649
4569 msgid "This command uploads base64-encoded data from C<base64file> to C<filename>."
4573 #: ../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:4663 ../fish/guestfish-actions.pod:4675 ../fish/guestfish-actions.pod:4686 ../fish/guestfish-actions.pod:4697 ../fish/guestfish-actions.pod:4749 ../fish/guestfish-actions.pod:4758 ../fish/guestfish-actions.pod:4812 ../fish/guestfish-actions.pod:4835
4574 msgid "Use C<-> instead of a filename to read/write from stdin/stdout."
4578 #: ../fish/guestfish-actions.pod:442
4583 #: ../fish/guestfish-actions.pod:444
4586 " base64-out filename (base64file|-)\n"
4591 #: ../fish/guestfish-actions.pod:446 ../src/guestfs-actions.pod:663
4593 "This command downloads the contents of C<filename>, writing it out to local "
4594 "file C<base64file> encoded as base64."
4598 #: ../fish/guestfish-actions.pod:451
4599 msgid "blockdev-flushbufs"
4603 #: ../fish/guestfish-actions.pod:453
4606 " blockdev-flushbufs device\n"
4611 #: ../fish/guestfish-actions.pod:455 ../src/guestfs-actions.pod:676
4612 msgid "This tells the kernel to flush internal buffers associated with C<device>."
4616 #: ../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
4617 msgid "This uses the L<blockdev(8)> command."
4621 #: ../fish/guestfish-actions.pod:460
4622 msgid "blockdev-getbsz"
4626 #: ../fish/guestfish-actions.pod:462
4629 " blockdev-getbsz device\n"
4634 #: ../fish/guestfish-actions.pod:464 ../src/guestfs-actions.pod:691
4635 msgid "This returns the block size of a device."
4639 #: ../fish/guestfish-actions.pod:466 ../fish/guestfish-actions.pod:529 ../src/guestfs-actions.pod:693 ../src/guestfs-actions.pod:793
4641 "(Note this is different from both I<size in blocks> and I<filesystem block "
4646 #: ../fish/guestfish-actions.pod:471
4647 msgid "blockdev-getro"
4651 #: ../fish/guestfish-actions.pod:473
4654 " blockdev-getro device\n"
4659 #: ../fish/guestfish-actions.pod:475 ../src/guestfs-actions.pod:708
4661 "Returns a boolean indicating if the block device is read-only (true if "
4662 "read-only, false if not)."
4666 #: ../fish/guestfish-actions.pod:480
4667 msgid "blockdev-getsize64"
4671 #: ../fish/guestfish-actions.pod:482
4674 " blockdev-getsize64 device\n"
4679 #: ../fish/guestfish-actions.pod:484 ../src/guestfs-actions.pod:723
4680 msgid "This returns the size of the device in bytes."
4684 #: ../fish/guestfish-actions.pod:486
4685 msgid "See also L</blockdev-getsz>."
4689 #: ../fish/guestfish-actions.pod:490
4690 msgid "blockdev-getss"
4694 #: ../fish/guestfish-actions.pod:492
4697 " blockdev-getss device\n"
4702 #: ../fish/guestfish-actions.pod:494 ../src/guestfs-actions.pod:739
4704 "This returns the size of sectors on a block device. Usually 512, but can be "
4705 "larger for modern devices."
4709 #: ../fish/guestfish-actions.pod:497
4710 msgid "(Note, this is not the size in sectors, use L</blockdev-getsz> for that)."
4714 #: ../fish/guestfish-actions.pod:502
4715 msgid "blockdev-getsz"
4719 #: ../fish/guestfish-actions.pod:504
4722 " blockdev-getsz device\n"
4727 #: ../fish/guestfish-actions.pod:506 ../src/guestfs-actions.pod:757
4729 "This returns the size of the device in units of 512-byte sectors (even if "
4730 "the sectorsize isn't 512 bytes ... weird)."
4734 #: ../fish/guestfish-actions.pod:509
4736 "See also L</blockdev-getss> for the real sector size of the device, and "
4737 "L</blockdev-getsize64> for the more useful I<size in bytes>."
4741 #: ../fish/guestfish-actions.pod:515
4742 msgid "blockdev-rereadpt"
4746 #: ../fish/guestfish-actions.pod:517
4749 " blockdev-rereadpt device\n"
4754 #: ../fish/guestfish-actions.pod:519 ../src/guestfs-actions.pod:776
4755 msgid "Reread the partition table on C<device>."
4759 #: ../fish/guestfish-actions.pod:523
4760 msgid "blockdev-setbsz"
4764 #: ../fish/guestfish-actions.pod:525
4767 " blockdev-setbsz device blocksize\n"
4772 #: ../fish/guestfish-actions.pod:527 ../src/guestfs-actions.pod:791
4773 msgid "This sets the block size of a device."
4777 #: ../fish/guestfish-actions.pod:534
4778 msgid "blockdev-setro"
4782 #: ../fish/guestfish-actions.pod:536
4785 " blockdev-setro device\n"
4790 #: ../fish/guestfish-actions.pod:538 ../src/guestfs-actions.pod:808
4791 msgid "Sets the block device named C<device> to read-only."
4795 #: ../fish/guestfish-actions.pod:542
4796 msgid "blockdev-setrw"
4800 #: ../fish/guestfish-actions.pod:544
4803 " blockdev-setrw device\n"
4808 #: ../fish/guestfish-actions.pod:546 ../src/guestfs-actions.pod:822
4809 msgid "Sets the block device named C<device> to read-write."
4813 #: ../fish/guestfish-actions.pod:550
4814 msgid "btrfs-filesystem-resize"
4818 #: ../fish/guestfish-actions.pod:552
4821 " btrfs-filesystem-resize mountpoint [size:..]\n"
4826 #: ../fish/guestfish-actions.pod:554 ../src/guestfs-actions.pod:844
4827 msgid "This command resizes a btrfs filesystem."
4831 #: ../fish/guestfish-actions.pod:556 ../src/guestfs-actions.pod:846
4833 "Note that unlike other resize calls, the filesystem has to be mounted and "
4834 "the parameter is the mountpoint not the device (this is a requirement of "
4839 #: ../fish/guestfish-actions.pod:560 ../fish/guestfish-actions.pod:3422 ../src/guestfs-actions.pod:850 ../src/guestfs-actions.pod:5194
4840 msgid "The optional parameters are:"
4844 #: ../fish/guestfish-actions.pod:564 ../fish/guestfish-actions.pod:3426 ../src/guestfs-actions.pod:854 ../src/guestfs-actions.pod:5198
4849 #: ../fish/guestfish-actions.pod:566 ../src/guestfs-actions.pod:856
4851 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
4852 "resized to the maximum size."
4856 #: ../fish/guestfish-actions.pod:571 ../src/guestfs-actions.pod:861
4857 msgid "See also L<btrfs(8)>."
4861 #: ../fish/guestfish-actions.pod:575
4862 msgid "case-sensitive-path"
4866 #: ../fish/guestfish-actions.pod:577
4869 " case-sensitive-path path\n"
4874 #: ../fish/guestfish-actions.pod:579 ../src/guestfs-actions.pod:895
4876 "This can be used to resolve case insensitive paths on a filesystem which is "
4877 "case sensitive. The use case is to resolve paths which you have read from "
4878 "Windows configuration files or the Windows Registry, to the true path."
4882 #: ../fish/guestfish-actions.pod:584 ../src/guestfs-actions.pod:900
4884 "The command handles a peculiarity of the Linux ntfs-3g filesystem driver "
4885 "(and probably others), which is that although the underlying filesystem is "
4886 "case-insensitive, the driver exports the filesystem to Linux as "
4891 #: ../fish/guestfish-actions.pod:589 ../src/guestfs-actions.pod:905
4893 "One consequence of this is that special directories such as C<c:\\windows> "
4894 "may appear as C</WINDOWS> or C</windows> (or other things) depending on the "
4895 "precise details of how they were created. In Windows itself this would not "
4900 #: ../fish/guestfish-actions.pod:595 ../src/guestfs-actions.pod:911
4902 "Bug or feature? You decide: "
4903 "L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>"
4907 #: ../fish/guestfish-actions.pod:598 ../src/guestfs-actions.pod:914
4909 "This function resolves the true case of each element in the path and returns "
4910 "the case-sensitive path."
4914 #: ../fish/guestfish-actions.pod:601
4916 "Thus L</case-sensitive-path> (\"/Windows/System32\") might return "
4917 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
4918 "how the directories were originally created under Windows)."
4922 #: ../fish/guestfish-actions.pod:606 ../src/guestfs-actions.pod:922
4923 msgid "I<Note>: This function does not handle drive names, backslashes etc."
4927 #: ../fish/guestfish-actions.pod:609
4928 msgid "See also L</realpath>."
4932 #: ../fish/guestfish-actions.pod:611
4937 #: ../fish/guestfish-actions.pod:613
4945 #: ../fish/guestfish-actions.pod:615 ../fish/guestfish-actions.pod:3842 ../src/guestfs-actions.pod:938 ../src/guestfs-actions.pod:5837
4946 msgid "Return the contents of the file named C<path>."
4950 #: ../fish/guestfish-actions.pod:617
4952 "Note that this function cannot correctly handle binary files (specifically, "
4953 "files containing C<\\0> character which is treated as end of string). For "
4954 "those you need to use the L</read-file> or L</download> functions which have "
4955 "a more complex interface."
4959 #: ../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:1569 ../fish/guestfish-actions.pod:1584 ../fish/guestfish-actions.pod:1594 ../fish/guestfish-actions.pod:1613 ../fish/guestfish-actions.pod:3712 ../fish/guestfish-actions.pod:3727 ../fish/guestfish-actions.pod:3803 ../fish/guestfish-actions.pod:3820 ../fish/guestfish-actions.pod:3835 ../fish/guestfish-actions.pod:4504 ../fish/guestfish-actions.pod:4550 ../fish/guestfish-actions.pod:4635 ../fish/guestfish-actions.pod:4650 ../fish/guestfish-actions.pod:5056 ../fish/guestfish-actions.pod:5068 ../fish/guestfish-actions.pod:5086 ../fish/guestfish-actions.pod:5103 ../fish/guestfish-actions.pod:5113 ../fish/guestfish-actions.pod:5162 ../fish/guestfish-actions.pod:5172 ../fish/guestfish-actions.pod:5201 ../fish/guestfish-actions.pod:5211 ../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:2363 ../src/guestfs-actions.pod:2387 ../src/guestfs-actions.pod:2404 ../src/guestfs-actions.pod:2433 ../src/guestfs-actions.pod:5619 ../src/guestfs-actions.pod:5645 ../src/guestfs-actions.pod:5776 ../src/guestfs-actions.pod:5802 ../src/guestfs-actions.pod:5826 ../src/guestfs-actions.pod:6777 ../src/guestfs-actions.pod:6832 ../src/guestfs-actions.pod:6978 ../src/guestfs-actions.pod:7002 ../src/guestfs-actions.pod:7667 ../src/guestfs-actions.pod:7687 ../src/guestfs-actions.pod:7713 ../src/guestfs-actions.pod:7739 ../src/guestfs-actions.pod:7758 ../src/guestfs-actions.pod:7844 ../src/guestfs-actions.pod:7863 ../src/guestfs-actions.pod:7909 ../src/guestfs-actions.pod:7928
4961 "Because of the message protocol, there is a transfer limit of somewhere "
4962 "between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
4966 #: ../fish/guestfish-actions.pod:625
4971 #: ../fish/guestfish-actions.pod:627
4974 " checksum csumtype path\n"
4979 #: ../fish/guestfish-actions.pod:629 ../src/guestfs-actions.pod:960
4980 msgid "This call computes the MD5, SHAx or CRC checksum of the file named C<path>."
4984 #: ../fish/guestfish-actions.pod:632 ../src/guestfs-actions.pod:963
4986 "The type of checksum to compute is given by the C<csumtype> parameter which "
4987 "must have one of the following values:"
4991 #: ../fish/guestfish-actions.pod:637 ../src/guestfs-actions.pod:968
4996 #: ../fish/guestfish-actions.pod:639 ../src/guestfs-actions.pod:970
4998 "Compute the cyclic redundancy check (CRC) specified by POSIX for the "
5003 #: ../fish/guestfish-actions.pod:642 ../src/guestfs-actions.pod:973
5008 #: ../fish/guestfish-actions.pod:644 ../src/guestfs-actions.pod:975
5009 msgid "Compute the MD5 hash (using the C<md5sum> program)."
5013 #: ../fish/guestfish-actions.pod:646 ../src/guestfs-actions.pod:977
5018 #: ../fish/guestfish-actions.pod:648 ../src/guestfs-actions.pod:979
5019 msgid "Compute the SHA1 hash (using the C<sha1sum> program)."
5023 #: ../fish/guestfish-actions.pod:650 ../src/guestfs-actions.pod:981
5028 #: ../fish/guestfish-actions.pod:652 ../src/guestfs-actions.pod:983
5029 msgid "Compute the SHA224 hash (using the C<sha224sum> program)."
5033 #: ../fish/guestfish-actions.pod:654 ../src/guestfs-actions.pod:985
5038 #: ../fish/guestfish-actions.pod:656 ../src/guestfs-actions.pod:987
5039 msgid "Compute the SHA256 hash (using the C<sha256sum> program)."
5043 #: ../fish/guestfish-actions.pod:658 ../src/guestfs-actions.pod:989
5048 #: ../fish/guestfish-actions.pod:660 ../src/guestfs-actions.pod:991
5049 msgid "Compute the SHA384 hash (using the C<sha384sum> program)."
5053 #: ../fish/guestfish-actions.pod:662 ../src/guestfs-actions.pod:993
5058 #: ../fish/guestfish-actions.pod:664 ../src/guestfs-actions.pod:995
5059 msgid "Compute the SHA512 hash (using the C<sha512sum> program)."
5063 #: ../fish/guestfish-actions.pod:668 ../src/guestfs-actions.pod:999
5064 msgid "The checksum is returned as a printable string."
5068 #: ../fish/guestfish-actions.pod:670
5069 msgid "To get the checksum for a device, use L</checksum-device>."
5073 #: ../fish/guestfish-actions.pod:672
5074 msgid "To get the checksums for many files, use L</checksums-out>."
5078 #: ../fish/guestfish-actions.pod:674
5079 msgid "checksum-device"
5083 #: ../fish/guestfish-actions.pod:676
5086 " checksum-device csumtype device\n"
5091 #: ../fish/guestfish-actions.pod:678
5093 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
5094 "device named C<device>. For the types of checksums supported see the "
5095 "L</checksum> command."
5099 #: ../fish/guestfish-actions.pod:682
5100 msgid "checksums-out"
5104 #: ../fish/guestfish-actions.pod:684
5107 " checksums-out csumtype directory (sumsfile|-)\n"
5112 #: ../fish/guestfish-actions.pod:686 ../src/guestfs-actions.pod:1034
5114 "This command computes the checksums of all regular files in C<directory> and "
5115 "then emits a list of those checksums to the local output file C<sumsfile>."
5119 #: ../fish/guestfish-actions.pod:690 ../src/guestfs-actions.pod:1038
5121 "This can be used for verifying the integrity of a virtual machine. However "
5122 "to be properly secure you should pay attention to the output of the checksum "
5123 "command (it uses the ones from GNU coreutils). In particular when the "
5124 "filename is not printable, coreutils uses a special backslash syntax. For "
5125 "more information, see the GNU coreutils info file."
5129 #: ../fish/guestfish-actions.pod:700
5134 #: ../fish/guestfish-actions.pod:702
5137 " chmod mode path\n"
5142 #: ../fish/guestfish-actions.pod:704 ../src/guestfs-actions.pod:1057
5144 "Change the mode (permissions) of C<path> to C<mode>. Only numeric modes are "
5149 #: ../fish/guestfish-actions.pod:707 ../src/guestfs-actions.pod:1060
5151 "I<Note>: When using this command from guestfish, C<mode> by default would be "
5152 "decimal, unless you prefix it with C<0> to get octal, ie. use C<0700> not "
5157 #: ../fish/guestfish-actions.pod:711 ../fish/guestfish-actions.pod:3065 ../fish/guestfish-actions.pod:3204 ../fish/guestfish-actions.pod:3214 ../fish/guestfish-actions.pod:3224 ../src/guestfs-actions.pod:1064 ../src/guestfs-actions.pod:4591 ../src/guestfs-actions.pod:4800 ../src/guestfs-actions.pod:4819 ../src/guestfs-actions.pod:4838
5158 msgid "The mode actually set is affected by the umask."
5162 #: ../fish/guestfish-actions.pod:713
5167 #: ../fish/guestfish-actions.pod:715
5170 " chown owner group path\n"
5175 #: ../fish/guestfish-actions.pod:717 ../src/guestfs-actions.pod:1078
5176 msgid "Change the file owner to C<owner> and group to C<group>."
5180 #: ../fish/guestfish-actions.pod:719 ../fish/guestfish-actions.pod:2500 ../src/guestfs-actions.pod:1080 ../src/guestfs-actions.pod:3662
5182 "Only numeric uid and gid are supported. If you want to use names, you will "
5183 "need to locate and parse the password file yourself (Augeas support makes "
5184 "this relatively easy)."
5188 #: ../fish/guestfish-actions.pod:723
5193 #: ../fish/guestfish-actions.pod:725
5196 " command 'arguments ...'\n"
5201 #: ../fish/guestfish-actions.pod:727 ../src/guestfs-actions.pod:1094
5203 "This call runs a command from the guest filesystem. The filesystem must be "
5204 "mounted, and must contain a compatible operating system (ie. something "
5205 "Linux, with the same or compatible processor architecture)."
5209 #: ../fish/guestfish-actions.pod:732
5211 "The single parameter is an argv-style list of arguments. The first element "
5212 "is the name of the program to run. Subsequent elements are parameters. The "
5213 "list must be non-empty (ie. must contain a program name). Note that the "
5214 "command runs directly, and is I<not> invoked via the shell (see L</sh>)."
5218 #: ../fish/guestfish-actions.pod:739 ../src/guestfs-actions.pod:1106
5219 msgid "The return value is anything printed to I<stdout> by the command."
5223 #: ../fish/guestfish-actions.pod:742 ../src/guestfs-actions.pod:1109
5225 "If the command returns a non-zero exit status, then this function returns an "
5226 "error message. The error message string is the content of I<stderr> from "
5231 #: ../fish/guestfish-actions.pod:746 ../src/guestfs-actions.pod:1113
5233 "The C<$PATH> environment variable will contain at least C</usr/bin> and "
5234 "C</bin>. If you require a program from another location, you should provide "
5235 "the full path in the first parameter."
5239 #: ../fish/guestfish-actions.pod:751 ../src/guestfs-actions.pod:1118
5241 "Shared libraries and data files required by the program must be available on "
5242 "filesystems which are mounted in the correct places. It is the caller's "
5243 "responsibility to ensure all filesystems that are needed are mounted at the "
5248 #: ../fish/guestfish-actions.pod:760
5249 msgid "command-lines"
5253 #: ../fish/guestfish-actions.pod:762
5256 " command-lines 'arguments ...'\n"
5261 #: ../fish/guestfish-actions.pod:764
5262 msgid "This is the same as L</command>, but splits the result into a list of lines."
5266 #: ../fish/guestfish-actions.pod:767
5267 msgid "See also: L</sh-lines>"
5271 #: ../fish/guestfish-actions.pod:772
5276 #: ../fish/guestfish-actions.pod:774
5279 " config qemuparam qemuvalue\n"
5284 #: ../fish/guestfish-actions.pod:776 ../src/guestfs-actions.pod:1159
5286 "This can be used to add arbitrary qemu command line parameters of the form "
5287 "I<-param value>. Actually it's not quite arbitrary - we prevent you from "
5288 "setting some parameters which would interfere with parameters that we use."
5292 #: ../fish/guestfish-actions.pod:781 ../src/guestfs-actions.pod:1164
5293 msgid "The first character of C<param> string must be a C<-> (dash)."
5297 #: ../fish/guestfish-actions.pod:783 ../src/guestfs-actions.pod:1166
5298 msgid "C<value> can be NULL."
5302 #: ../fish/guestfish-actions.pod:785
5307 #: ../fish/guestfish-actions.pod:787
5310 " copy-size src dest size\n"
5315 #: ../fish/guestfish-actions.pod:789 ../src/guestfs-actions.pod:1180
5317 "This command copies exactly C<size> bytes from one source device or file "
5318 "C<src> to another destination device or file C<dest>."
5322 #: ../fish/guestfish-actions.pod:792 ../src/guestfs-actions.pod:1183
5324 "Note this will fail if the source is too short or if the destination is not "
5329 #: ../fish/guestfish-actions.pod:795
5334 #: ../fish/guestfish-actions.pod:797
5342 #: ../fish/guestfish-actions.pod:799 ../src/guestfs-actions.pod:1202
5344 "This copies a file from C<src> to C<dest> where C<dest> is either a "
5345 "destination filename or destination directory."
5349 #: ../fish/guestfish-actions.pod:802
5354 #: ../fish/guestfish-actions.pod:804
5362 #: ../fish/guestfish-actions.pod:806 ../src/guestfs-actions.pod:1216
5364 "This copies a file or directory from C<src> to C<dest> recursively using the "
5369 #: ../fish/guestfish-actions.pod:809
5374 #: ../fish/guestfish-actions.pod:811
5382 #: ../fish/guestfish-actions.pod:813 ../src/guestfs-actions.pod:1230
5384 "This command copies from one source device or file C<src> to another "
5385 "destination device or file C<dest>. Normally you would use this to copy to "
5386 "or from a device or partition, for example to duplicate a filesystem."
5390 #: ../fish/guestfish-actions.pod:818
5392 "If the destination is a device, it must be as large or larger than the "
5393 "source file or device, otherwise the copy will fail. This command cannot do "
5394 "partial copies (see L</copy-size>)."
5398 #: ../fish/guestfish-actions.pod:822
5403 #: ../fish/guestfish-actions.pod:824
5411 #: ../fish/guestfish-actions.pod:826 ../src/guestfs-actions.pod:1248
5412 msgid "This command runs the C<df> command to report disk space used."
5416 #: ../fish/guestfish-actions.pod:828 ../fish/guestfish-actions.pod:839
5418 "This command is mostly useful for interactive sessions. It is I<not> "
5419 "intended that you try to parse the output string. Use L</statvfs> from "
5424 #: ../fish/guestfish-actions.pod:832
5429 #: ../fish/guestfish-actions.pod:834
5437 #: ../fish/guestfish-actions.pod:836 ../src/guestfs-actions.pod:1264
5439 "This command runs the C<df -h> command to report disk space used in "
5440 "human-readable format."
5444 #: ../fish/guestfish-actions.pod:843
5449 #: ../fish/guestfish-actions.pod:845
5457 #: ../fish/guestfish-actions.pod:847 ../src/guestfs-actions.pod:1281
5459 "This returns the kernel messages (C<dmesg> output) from the guest kernel. "
5460 "This is sometimes useful for extended debugging of problems."
5464 #: ../fish/guestfish-actions.pod:851
5466 "Another way to get the same information is to enable verbose messages with "
5467 "L</set-verbose> or by setting the environment variable C<LIBGUESTFS_DEBUG=1> "
5468 "before running the program."
5472 #: ../fish/guestfish-actions.pod:856
5477 #: ../fish/guestfish-actions.pod:858
5480 " download remotefilename (filename|-)\n"
5485 #: ../fish/guestfish-actions.pod:860 ../fish/guestfish-actions.pod:873 ../src/guestfs-actions.pod:1302 ../src/guestfs-actions.pod:1327
5487 "Download file C<remotefilename> and save it as C<filename> on the local "
5492 #: ../fish/guestfish-actions.pod:863 ../fish/guestfish-actions.pod:4808 ../src/guestfs-actions.pod:1305 ../src/guestfs-actions.pod:7237
5493 msgid "C<filename> can also be a named pipe."
5497 #: ../fish/guestfish-actions.pod:865
5498 msgid "See also L</upload>, L</cat>."
5502 #: ../fish/guestfish-actions.pod:869
5503 msgid "download-offset"
5507 #: ../fish/guestfish-actions.pod:871
5510 " download-offset remotefilename (filename|-) offset size\n"
5515 #: ../fish/guestfish-actions.pod:876 ../src/guestfs-actions.pod:1330
5517 "C<remotefilename> is read for C<size> bytes starting at C<offset> (this "
5518 "region must be within the file or device)."
5522 #: ../fish/guestfish-actions.pod:879
5524 "Note that there is no limit on the amount of data that can be downloaded "
5525 "with this call, unlike with L</pread>, and this call always reads the full "
5526 "amount unless an error occurs."
5530 #: ../fish/guestfish-actions.pod:884
5531 msgid "See also L</download>, L</pread>."
5535 #: ../fish/guestfish-actions.pod:888
5540 #: ../fish/guestfish-actions.pod:890
5543 " drop-caches whattodrop\n"
5548 #: ../fish/guestfish-actions.pod:892 ../src/guestfs-actions.pod:1355
5550 "This instructs the guest kernel to drop its page cache, and/or dentries and "
5551 "inode caches. The parameter C<whattodrop> tells the kernel what precisely "
5552 "to drop, see L<http://linux-mm.org/Drop_Caches>"
5556 #: ../fish/guestfish-actions.pod:897 ../src/guestfs-actions.pod:1360
5557 msgid "Setting C<whattodrop> to 3 should drop everything."
5561 #: ../fish/guestfish-actions.pod:899 ../src/guestfs-actions.pod:1362
5563 "This automatically calls L<sync(2)> before the operation, so that the "
5564 "maximum guest memory is freed."
5568 #: ../fish/guestfish-actions.pod:902
5573 #: ../fish/guestfish-actions.pod:904
5581 #: ../fish/guestfish-actions.pod:906 ../src/guestfs-actions.pod:1375
5583 "This command runs the C<du -s> command to estimate file space usage for "
5588 #: ../fish/guestfish-actions.pod:909 ../src/guestfs-actions.pod:1378
5590 "C<path> can be a file or a directory. If C<path> is a directory then the "
5591 "estimate includes the contents of the directory and all subdirectories "
5596 #: ../fish/guestfish-actions.pod:913 ../src/guestfs-actions.pod:1382
5597 msgid "The result is the estimated size in I<kilobytes> (ie. units of 1024 bytes)."
5601 #: ../fish/guestfish-actions.pod:916
5606 #: ../fish/guestfish-actions.pod:918
5609 " e2fsck-f device\n"
5614 #: ../fish/guestfish-actions.pod:920 ../src/guestfs-actions.pod:1400
5616 "This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3 filesystem checker "
5617 "on C<device>, noninteractively (I<-p>), even if the filesystem appears to be "
5622 #: ../fish/guestfish-actions.pod:924
5624 "This command is only needed because of L</resize2fs> (q.v.). Normally you "
5625 "should use L</fsck>."
5629 #: ../fish/guestfish-actions.pod:927
5634 #: ../fish/guestfish-actions.pod:929
5637 " echo-daemon 'words ...'\n"
5642 #: ../fish/guestfish-actions.pod:931 ../src/guestfs-actions.pod:1417
5644 "This command concatenates the list of C<words> passed with single spaces "
5645 "between them and returns the resulting string."
5649 #: ../fish/guestfish-actions.pod:934 ../src/guestfs-actions.pod:1420
5650 msgid "You can use this command to test the connection through to the daemon."
5654 #: ../fish/guestfish-actions.pod:936
5655 msgid "See also L</ping-daemon>."
5659 #: ../fish/guestfish-actions.pod:938
5664 #: ../fish/guestfish-actions.pod:940
5667 " egrep regex path\n"
5672 #: ../fish/guestfish-actions.pod:942 ../src/guestfs-actions.pod:1436
5673 msgid "This calls the external C<egrep> program and returns the matching lines."
5677 #: ../fish/guestfish-actions.pod:948
5682 #: ../fish/guestfish-actions.pod:950
5685 " egrepi regex path\n"
5690 #: ../fish/guestfish-actions.pod:952 ../src/guestfs-actions.pod:1455
5691 msgid "This calls the external C<egrep -i> program and returns the matching lines."
5695 #: ../fish/guestfish-actions.pod:958
5700 #: ../fish/guestfish-actions.pod:960
5703 " equal file1 file2\n"
5708 #: ../fish/guestfish-actions.pod:962 ../src/guestfs-actions.pod:1474
5710 "This compares the two files C<file1> and C<file2> and returns true if their "
5711 "content is exactly equal, or false otherwise."
5715 #: ../fish/guestfish-actions.pod:965 ../src/guestfs-actions.pod:1477
5716 msgid "The external L<cmp(1)> program is used for the comparison."
5720 #: ../fish/guestfish-actions.pod:967
5725 #: ../fish/guestfish-actions.pod:969
5733 #: ../fish/guestfish-actions.pod:971 ../src/guestfs-actions.pod:1489
5735 "This returns C<true> if and only if there is a file, directory (or anything) "
5736 "with the given C<path> name."
5740 #: ../fish/guestfish-actions.pod:974
5741 msgid "See also L</is-file>, L</is-dir>, L</stat>."
5745 #: ../fish/guestfish-actions.pod:976
5750 #: ../fish/guestfish-actions.pod:978
5753 " fallocate path len\n"
5758 #: ../fish/guestfish-actions.pod:980 ../fish/guestfish-actions.pod:999 ../src/guestfs-actions.pod:1505 ../src/guestfs-actions.pod:1531
5760 "This command preallocates a file (containing zero bytes) named C<path> of "
5761 "size C<len> bytes. If the file exists already, it is overwritten."
5765 #: ../fish/guestfish-actions.pod:984 ../src/guestfs-actions.pod:1509
5767 "Do not confuse this with the guestfish-specific C<alloc> command which "
5768 "allocates a file in the host and attaches it as a device."
5772 #: ../fish/guestfish-actions.pod:988
5774 "This function is deprecated. In new code, use the L</fallocate64> call "
5779 #: ../fish/guestfish-actions.pod:995
5784 #: ../fish/guestfish-actions.pod:997
5787 " fallocate64 path len\n"
5792 #: ../fish/guestfish-actions.pod:1003
5794 "Note that this call allocates disk blocks for the file. To create a sparse "
5795 "file use L</truncate-size> instead."
5799 #: ../fish/guestfish-actions.pod:1006
5801 "The deprecated call L</fallocate> does the same, but owing to an oversight "
5802 "it only allowed 30 bit lengths to be specified, effectively limiting the "
5803 "maximum size of files created through that call to 1GB."
5807 #: ../fish/guestfish-actions.pod:1011 ../src/guestfs-actions.pod:1543
5809 "Do not confuse this with the guestfish-specific C<alloc> and C<sparse> "
5810 "commands which create a file in the host and attach it as a device."
5814 #: ../fish/guestfish-actions.pod:1015
5819 #: ../fish/guestfish-actions.pod:1017
5822 " fgrep pattern path\n"
5827 #: ../fish/guestfish-actions.pod:1019 ../src/guestfs-actions.pod:1558
5828 msgid "This calls the external C<fgrep> program and returns the matching lines."
5832 #: ../fish/guestfish-actions.pod:1025
5837 #: ../fish/guestfish-actions.pod:1027
5840 " fgrepi pattern path\n"
5845 #: ../fish/guestfish-actions.pod:1029 ../src/guestfs-actions.pod:1577
5846 msgid "This calls the external C<fgrep -i> program and returns the matching lines."
5850 #: ../fish/guestfish-actions.pod:1035
5855 #: ../fish/guestfish-actions.pod:1037
5863 #: ../fish/guestfish-actions.pod:1039 ../src/guestfs-actions.pod:1595
5865 "This call uses the standard L<file(1)> command to determine the type or "
5866 "contents of the file."
5870 #: ../fish/guestfish-actions.pod:1042 ../src/guestfs-actions.pod:1598
5872 "This call will also transparently look inside various types of compressed "
5877 #: ../fish/guestfish-actions.pod:1045 ../src/guestfs-actions.pod:1601
5879 "The exact command which runs is C<file -zb path>. Note in particular that "
5880 "the filename is not prepended to the output (the I<-b> option)."
5884 #: ../fish/guestfish-actions.pod:1049 ../src/guestfs-actions.pod:1605
5886 "The output depends on the output of the underlying L<file(1)> command and it "
5887 "can change in future in ways beyond our control. In other words, the output "
5888 "is not guaranteed by the ABI."
5892 #: ../fish/guestfish-actions.pod:1053
5894 "See also: L<file(1)>, L</vfs-type>, L</lstat>, L</is-file>, L</is-blockdev> "
5895 "(etc), L</is-zero>."
5899 #: ../fish/guestfish-actions.pod:1056
5900 msgid "file-architecture"
5904 #: ../fish/guestfish-actions.pod:1058
5907 " file-architecture filename\n"
5912 #: ../fish/guestfish-actions.pod:1060 ../src/guestfs-actions.pod:1623
5914 "This detects the architecture of the binary C<filename>, and returns it if "
5919 #: ../fish/guestfish-actions.pod:1063 ../src/guestfs-actions.pod:1626
5920 msgid "Currently defined architectures are:"
5924 #: ../fish/guestfish-actions.pod:1067 ../src/guestfs-actions.pod:1630
5929 #: ../fish/guestfish-actions.pod:1069 ../src/guestfs-actions.pod:1632
5931 "This string is returned for all 32 bit i386, i486, i586, i686 binaries "
5932 "irrespective of the precise processor requirements of the binary."
5936 #: ../fish/guestfish-actions.pod:1072 ../src/guestfs-actions.pod:1635
5941 #: ../fish/guestfish-actions.pod:1074 ../src/guestfs-actions.pod:1637
5942 msgid "64 bit x86-64."
5946 #: ../fish/guestfish-actions.pod:1076 ../src/guestfs-actions.pod:1639
5951 #: ../fish/guestfish-actions.pod:1078 ../src/guestfs-actions.pod:1641
5952 msgid "32 bit SPARC."
5956 #: ../fish/guestfish-actions.pod:1080 ../src/guestfs-actions.pod:1643
5961 #: ../fish/guestfish-actions.pod:1082 ../src/guestfs-actions.pod:1645
5962 msgid "64 bit SPARC V9 and above."
5966 #: ../fish/guestfish-actions.pod:1084 ../src/guestfs-actions.pod:1647
5971 #: ../fish/guestfish-actions.pod:1086 ../src/guestfs-actions.pod:1649
5972 msgid "Intel Itanium."
5976 #: ../fish/guestfish-actions.pod:1088 ../src/guestfs-actions.pod:1651
5981 #: ../fish/guestfish-actions.pod:1090 ../src/guestfs-actions.pod:1653
5982 msgid "32 bit Power PC."
5986 #: ../fish/guestfish-actions.pod:1092 ../src/guestfs-actions.pod:1655
5991 #: ../fish/guestfish-actions.pod:1094 ../src/guestfs-actions.pod:1657
5992 msgid "64 bit Power PC."
5996 #: ../fish/guestfish-actions.pod:1098 ../src/guestfs-actions.pod:1661
5997 msgid "Libguestfs may return other architecture strings in future."
6001 #: ../fish/guestfish-actions.pod:1100 ../src/guestfs-actions.pod:1663
6002 msgid "The function works on at least the following types of files:"
6006 #: ../fish/guestfish-actions.pod:1106 ../src/guestfs-actions.pod:1669
6007 msgid "many types of Un*x and Linux binary"
6011 #: ../fish/guestfish-actions.pod:1110 ../src/guestfs-actions.pod:1673
6012 msgid "many types of Un*x and Linux shared library"
6016 #: ../fish/guestfish-actions.pod:1114 ../src/guestfs-actions.pod:1677
6017 msgid "Windows Win32 and Win64 binaries"
6021 #: ../fish/guestfish-actions.pod:1118 ../src/guestfs-actions.pod:1681
6022 msgid "Windows Win32 and Win64 DLLs"
6026 #: ../fish/guestfish-actions.pod:1120 ../src/guestfs-actions.pod:1683
6027 msgid "Win32 binaries and DLLs return C<i386>."
6031 #: ../fish/guestfish-actions.pod:1122 ../src/guestfs-actions.pod:1685
6032 msgid "Win64 binaries and DLLs return C<x86_64>."
6036 #: ../fish/guestfish-actions.pod:1126 ../src/guestfs-actions.pod:1689
6037 msgid "Linux kernel modules"
6041 #: ../fish/guestfish-actions.pod:1130 ../src/guestfs-actions.pod:1693
6042 msgid "Linux new-style initrd images"
6046 #: ../fish/guestfish-actions.pod:1134 ../src/guestfs-actions.pod:1697
6047 msgid "some non-x86 Linux vmlinuz kernels"
6051 #: ../fish/guestfish-actions.pod:1138 ../src/guestfs-actions.pod:1701
6052 msgid "What it can't do currently:"
6056 #: ../fish/guestfish-actions.pod:1144 ../src/guestfs-actions.pod:1707
6057 msgid "static libraries (libfoo.a)"
6061 #: ../fish/guestfish-actions.pod:1148 ../src/guestfs-actions.pod:1711
6062 msgid "Linux old-style initrd as compressed ext2 filesystem (RHEL 3)"
6066 #: ../fish/guestfish-actions.pod:1152 ../src/guestfs-actions.pod:1715
6067 msgid "x86 Linux vmlinuz kernels"
6071 #: ../fish/guestfish-actions.pod:1154 ../src/guestfs-actions.pod:1717
6073 "x86 vmlinuz images (bzImage format) consist of a mix of 16-, 32- and "
6074 "compressed code, and are horribly hard to unpack. If you want to find the "
6075 "architecture of a kernel, use the architecture of the associated initrd or "
6076 "kernel module(s) instead."
6080 #: ../fish/guestfish-actions.pod:1161
6085 #: ../fish/guestfish-actions.pod:1163
6093 #: ../fish/guestfish-actions.pod:1165 ../src/guestfs-actions.pod:1735
6094 msgid "This command returns the size of C<file> in bytes."
6098 #: ../fish/guestfish-actions.pod:1167
6100 "To get other stats about a file, use L</stat>, L</lstat>, L</is-dir>, "
6101 "L</is-file> etc. To get the size of block devices, use "
6102 "L</blockdev-getsize64>."
6106 #: ../fish/guestfish-actions.pod:1171
6111 #: ../fish/guestfish-actions.pod:1173
6114 " fill c len path\n"
6119 #: ../fish/guestfish-actions.pod:1175 ../src/guestfs-actions.pod:1753
6121 "This command creates a new file called C<path>. The initial content of the "
6122 "file is C<len> octets of C<c>, where C<c> must be a number in the range "
6127 #: ../fish/guestfish-actions.pod:1179
6129 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
6130 "L</truncate-size>. To create a file with a pattern of repeating bytes use "
6135 #: ../fish/guestfish-actions.pod:1184
6136 msgid "fill-pattern"
6140 #: ../fish/guestfish-actions.pod:1186
6143 " fill-pattern pattern len path\n"
6148 #: ../fish/guestfish-actions.pod:1188
6150 "This function is like L</fill> except that it creates a new file of length "
6151 "C<len> containing the repeating pattern of bytes in C<pattern>. The pattern "
6152 "is truncated if necessary to ensure the length of the file is exactly C<len> "
6157 #: ../fish/guestfish-actions.pod:1193
6162 #: ../fish/guestfish-actions.pod:1195
6170 #: ../fish/guestfish-actions.pod:1197 ../src/guestfs-actions.pod:1799
6172 "This command lists out all files and directories, recursively, starting at "
6173 "C<directory>. It is essentially equivalent to running the shell command "
6174 "C<find directory -print> but some post-processing happens on the output, "
6179 #: ../fish/guestfish-actions.pod:1202 ../src/guestfs-actions.pod:1804
6181 "This returns a list of strings I<without any prefix>. Thus if the directory "
6186 #: ../fish/guestfish-actions.pod:1205 ../src/guestfs-actions.pod:1807
6196 #: ../fish/guestfish-actions.pod:1209
6197 msgid "then the returned list from L</find> C</tmp> would be 4 elements:"
6201 #: ../fish/guestfish-actions.pod:1212 ../src/guestfs-actions.pod:1814
6212 #: ../fish/guestfish-actions.pod:1217 ../src/guestfs-actions.pod:1819
6213 msgid "If C<directory> is not a directory, then this command returns an error."
6217 #: ../fish/guestfish-actions.pod:1220 ../src/guestfs-actions.pod:1822
6218 msgid "The returned list is sorted."
6222 #: ../fish/guestfish-actions.pod:1222
6223 msgid "See also L</find0>."
6227 #: ../fish/guestfish-actions.pod:1227
6232 #: ../fish/guestfish-actions.pod:1229
6235 " find0 directory (files|-)\n"
6240 #: ../fish/guestfish-actions.pod:1231 ../src/guestfs-actions.pod:1842
6242 "This command lists out all files and directories, recursively, starting at "
6243 "C<directory>, placing the resulting list in the external file called "
6248 #: ../fish/guestfish-actions.pod:1235
6249 msgid "This command works the same way as L</find> with the following exceptions:"
6253 #: ../fish/guestfish-actions.pod:1242 ../src/guestfs-actions.pod:1853
6254 msgid "The resulting list is written to an external file."
6258 #: ../fish/guestfish-actions.pod:1246 ../src/guestfs-actions.pod:1857
6260 "Items (filenames) in the result are separated by C<\\0> characters. See "
6261 "L<find(1)> option I<-print0>."
6265 #: ../fish/guestfish-actions.pod:1251 ../src/guestfs-actions.pod:1862
6266 msgid "This command is not limited in the number of names that it can return."
6270 #: ../fish/guestfish-actions.pod:1256 ../src/guestfs-actions.pod:1867
6271 msgid "The result list is not sorted."
6275 #: ../fish/guestfish-actions.pod:1262
6276 msgid "findfs-label"
6280 #: ../fish/guestfish-actions.pod:1264
6283 " findfs-label label\n"
6288 #: ../fish/guestfish-actions.pod:1266 ../src/guestfs-actions.pod:1881
6290 "This command searches the filesystems and returns the one which has the "
6291 "given label. An error is returned if no such filesystem can be found."
6295 #: ../fish/guestfish-actions.pod:1270
6296 msgid "To find the label of a filesystem, use L</vfs-label>."
6300 #: ../fish/guestfish-actions.pod:1272
6305 #: ../fish/guestfish-actions.pod:1274
6308 " findfs-uuid uuid\n"
6313 #: ../fish/guestfish-actions.pod:1276 ../src/guestfs-actions.pod:1898
6315 "This command searches the filesystems and returns the one which has the "
6316 "given UUID. An error is returned if no such filesystem can be found."
6320 #: ../fish/guestfish-actions.pod:1280
6321 msgid "To find the UUID of a filesystem, use L</vfs-uuid>."
6325 #: ../fish/guestfish-actions.pod:1282
6330 #: ../fish/guestfish-actions.pod:1284
6333 " fsck fstype device\n"
6338 #: ../fish/guestfish-actions.pod:1286 ../src/guestfs-actions.pod:1916
6340 "This runs the filesystem checker (fsck) on C<device> which should have "
6341 "filesystem type C<fstype>."
6345 #: ../fish/guestfish-actions.pod:1289 ../src/guestfs-actions.pod:1919
6347 "The returned integer is the status. See L<fsck(8)> for the list of status "
6348 "codes from C<fsck>."
6352 #: ../fish/guestfish-actions.pod:1298 ../src/guestfs-actions.pod:1928
6353 msgid "Multiple status codes can be summed together."
6357 #: ../fish/guestfish-actions.pod:1302 ../src/guestfs-actions.pod:1932
6359 "A non-zero return code can mean \"success\", for example if errors have been "
6360 "corrected on the filesystem."
6364 #: ../fish/guestfish-actions.pod:1307 ../src/guestfs-actions.pod:1937
6365 msgid "Checking or repairing NTFS volumes is not supported (by linux-ntfs)."
6369 #: ../fish/guestfish-actions.pod:1312 ../src/guestfs-actions.pod:1942
6370 msgid "This command is entirely equivalent to running C<fsck -a -t fstype device>."
6374 #: ../fish/guestfish-actions.pod:1314
6379 #: ../fish/guestfish-actions.pod:1316
6387 #: ../fish/guestfish-actions.pod:1318 ../src/guestfs-actions.pod:1953
6389 "Return the additional kernel options which are added to the guest kernel "
6394 #: ../fish/guestfish-actions.pod:1321 ../src/guestfs-actions.pod:1956
6395 msgid "If C<NULL> then no options are added."
6399 #: ../fish/guestfish-actions.pod:1323
6400 msgid "get-attach-method"
6404 #: ../fish/guestfish-actions.pod:1325
6407 " get-attach-method\n"
6412 #: ../fish/guestfish-actions.pod:1327
6413 msgid "Return the current attach method. See L</set-attach-method>."
6417 #: ../fish/guestfish-actions.pod:1329
6418 msgid "get-autosync"
6422 #: ../fish/guestfish-actions.pod:1331
6430 #: ../fish/guestfish-actions.pod:1333 ../src/guestfs-actions.pod:1981
6431 msgid "Get the autosync flag."
6435 #: ../fish/guestfish-actions.pod:1335
6440 #: ../fish/guestfish-actions.pod:1337
6448 #: ../fish/guestfish-actions.pod:1339 ../src/guestfs-actions.pod:1992
6449 msgid "Return the direct appliance mode flag."
6453 #: ../fish/guestfish-actions.pod:1341
6458 #: ../fish/guestfish-actions.pod:1343
6461 " get-e2label device\n"
6466 #: ../fish/guestfish-actions.pod:1345 ../src/guestfs-actions.pod:2004
6467 msgid "This returns the ext2/3/4 filesystem label of the filesystem on C<device>."
6471 #: ../fish/guestfish-actions.pod:1348
6473 "This function is deprecated. In new code, use the L</vfs_label> call "
6478 #: ../fish/guestfish-actions.pod:1355
6483 #: ../fish/guestfish-actions.pod:1357
6486 " get-e2uuid device\n"
6491 #: ../fish/guestfish-actions.pod:1359 ../src/guestfs-actions.pod:2025
6492 msgid "This returns the ext2/3/4 filesystem UUID of the filesystem on C<device>."
6496 #: ../fish/guestfish-actions.pod:1362
6498 "This function is deprecated. In new code, use the L</vfs_uuid> call "
6503 #: ../fish/guestfish-actions.pod:1369
6508 #: ../fish/guestfish-actions.pod:1371
6516 #: ../fish/guestfish-actions.pod:1373 ../src/guestfs-actions.pod:2045
6517 msgid "This gets the memory size in megabytes allocated to the qemu subprocess."
6521 #: ../fish/guestfish-actions.pod:1376
6523 "If L</set-memsize> was not called on this handle, and if "
6524 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
6525 "value for memsize."
6529 #: ../fish/guestfish-actions.pod:1380 ../fish/guestfish-actions.pod:1437 ../fish/guestfish-actions.pod:4168 ../fish/guestfish-actions.pod:4270 ../src/guestfs-actions.pod:2052 ../src/guestfs-actions.pod:2144 ../src/guestfs-actions.pod:6298 ../src/guestfs-actions.pod:6424
6530 msgid "For more information on the architecture of libguestfs, see L<guestfs(3)>."
6534 #: ../fish/guestfish-actions.pod:1383
6539 #: ../fish/guestfish-actions.pod:1385
6547 #: ../fish/guestfish-actions.pod:1387 ../src/guestfs-actions.pod:2064
6548 msgid "This returns the enable network flag."
6552 #: ../fish/guestfish-actions.pod:1389
6557 #: ../fish/guestfish-actions.pod:1391
6565 #: ../fish/guestfish-actions.pod:1393 ../src/guestfs-actions.pod:2075
6566 msgid "Return the current search path."
6570 #: ../fish/guestfish-actions.pod:1395 ../src/guestfs-actions.pod:2077
6572 "This is always non-NULL. If it wasn't set already, then this will return "
6577 #: ../fish/guestfish-actions.pod:1398
6582 #: ../fish/guestfish-actions.pod:1400
6590 #: ../fish/guestfish-actions.pod:1402 ../src/guestfs-actions.pod:2090
6591 msgid "This returns the process group flag."
6595 #: ../fish/guestfish-actions.pod:1404
6600 #: ../fish/guestfish-actions.pod:1406
6605 #: ../fish/guestfish-actions.pod:1408
6613 #: ../fish/guestfish-actions.pod:1410 ../src/guestfs-actions.pod:2101
6615 "Return the process ID of the qemu subprocess. If there is no qemu "
6616 "subprocess, then this will return an error."
6620 #: ../fish/guestfish-actions.pod:1413 ../src/guestfs-actions.pod:2104
6621 msgid "This is an internal call used for debugging and testing."
6625 #: ../fish/guestfish-actions.pod:1415
6630 #: ../fish/guestfish-actions.pod:1417
6638 #: ../fish/guestfish-actions.pod:1419 ../src/guestfs-actions.pod:2115
6639 msgid "Return the current qemu binary."
6643 #: ../fish/guestfish-actions.pod:1421 ../src/guestfs-actions.pod:2117
6645 "This is always non-NULL. If it wasn't set already, then this will return "
6646 "the default qemu binary name."
6650 #: ../fish/guestfish-actions.pod:1424
6651 msgid "get-recovery-proc"
6655 #: ../fish/guestfish-actions.pod:1426
6658 " get-recovery-proc\n"
6663 #: ../fish/guestfish-actions.pod:1428 ../src/guestfs-actions.pod:2130
6664 msgid "Return the recovery process enabled flag."
6668 #: ../fish/guestfish-actions.pod:1430
6673 #: ../fish/guestfish-actions.pod:1432
6681 #: ../fish/guestfish-actions.pod:1434
6683 "This returns the current setting of the selinux flag which is passed to the "
6684 "appliance at boot time. See L</set-selinux>."
6688 #: ../fish/guestfish-actions.pod:1440
6693 #: ../fish/guestfish-actions.pod:1442
6701 #: ../fish/guestfish-actions.pod:1444 ../src/guestfs-actions.pod:2156
6703 "This returns the current state as an opaque integer. This is only useful "
6704 "for printing debug and internal error messages."
6708 #: ../fish/guestfish-actions.pod:1447 ../fish/guestfish-actions.pod:2367 ../fish/guestfish-actions.pod:2385 ../fish/guestfish-actions.pod:2423 ../fish/guestfish-actions.pod:2439 ../src/guestfs-actions.pod:2159 ../src/guestfs-actions.pod:3439 ../src/guestfs-actions.pod:3468 ../src/guestfs-actions.pod:3529 ../src/guestfs-actions.pod:3556
6709 msgid "For more information on states, see L<guestfs(3)>."
6713 #: ../fish/guestfish-actions.pod:1449
6718 #: ../fish/guestfish-actions.pod:1451
6726 #: ../fish/guestfish-actions.pod:1453 ../src/guestfs-actions.pod:2170
6727 msgid "Return the command trace flag."
6731 #: ../fish/guestfish-actions.pod:1455
6736 #: ../fish/guestfish-actions.pod:1457
6744 #: ../fish/guestfish-actions.pod:1459
6746 "Return the current umask. By default the umask is C<022> unless it has been "
6747 "set by calling L</umask>."
6751 #: ../fish/guestfish-actions.pod:1462
6756 #: ../fish/guestfish-actions.pod:1464
6764 #: ../fish/guestfish-actions.pod:1466 ../src/guestfs-actions.pod:2193
6765 msgid "This returns the verbose messages flag."
6769 #: ../fish/guestfish-actions.pod:1468
6774 #: ../fish/guestfish-actions.pod:1470
6782 #: ../fish/guestfish-actions.pod:1472 ../src/guestfs-actions.pod:2204
6783 msgid "This gets the SELinux security context of the daemon."
6787 #: ../fish/guestfish-actions.pod:1474
6788 msgid "See the documentation about SELINUX in L<guestfs(3)>, and L</setcon>"
6792 #: ../fish/guestfish-actions.pod:1477
6797 #: ../fish/guestfish-actions.pod:1479
6800 " getxattr path name\n"
6805 #: ../fish/guestfish-actions.pod:1481
6807 "Get a single extended attribute from file C<path> named C<name>. This call "
6808 "follows symlinks. If you want to lookup an extended attribute for the "
6809 "symlink itself, use L</lgetxattr>."
6813 #: ../fish/guestfish-actions.pod:1485 ../fish/guestfish-actions.pod:2512
6815 "Normally it is better to get all extended attributes from a file in one go "
6816 "by calling L</getxattrs>. However some Linux filesystem implementations are "
6817 "buggy and do not provide a way to list out attributes. For these "
6818 "filesystems (notably ntfs-3g) you have to know the names of the extended "
6819 "attributes you want in advance and call this function."
6823 #: ../fish/guestfish-actions.pod:1492 ../fish/guestfish-actions.pod:2519 ../src/guestfs-actions.pod:2233 ../src/guestfs-actions.pod:3689
6825 "Extended attribute values are blobs of binary data. If there is no extended "
6826 "attribute named C<name>, this returns an error."
6830 #: ../fish/guestfish-actions.pod:1495
6831 msgid "See also: L</getxattrs>, L</lgetxattr>, L<attr(5)>."
6835 #: ../fish/guestfish-actions.pod:1497
6840 #: ../fish/guestfish-actions.pod:1499
6848 #: ../fish/guestfish-actions.pod:1501 ../src/guestfs-actions.pod:2250
6849 msgid "This call lists the extended attributes of the file or directory C<path>."
6853 #: ../fish/guestfish-actions.pod:1504 ../src/guestfs-actions.pod:2253
6855 "At the system call level, this is a combination of the L<listxattr(2)> and "
6856 "L<getxattr(2)> calls."
6860 #: ../fish/guestfish-actions.pod:1507
6861 msgid "See also: L</lgetxattrs>, L<attr(5)>."
6865 #: ../fish/guestfish-actions.pod:1509
6870 #: ../fish/guestfish-actions.pod:1511
6873 " glob-expand pattern\n"
6878 #: ../fish/guestfish-actions.pod:1513 ../src/guestfs-actions.pod:2270
6880 "This command searches for all the pathnames matching C<pattern> according to "
6881 "the wildcard expansion rules used by the shell."
6885 #: ../fish/guestfish-actions.pod:1517 ../src/guestfs-actions.pod:2274
6886 msgid "If no paths match, then this returns an empty list (note: not an error)."
6890 #: ../fish/guestfish-actions.pod:1520 ../src/guestfs-actions.pod:2277
6892 "It is just a wrapper around the C L<glob(3)> function with flags "
6893 "C<GLOB_MARK|GLOB_BRACE>. See that manual page for more details."
6897 #: ../fish/guestfish-actions.pod:1524
6902 #: ../fish/guestfish-actions.pod:1526
6905 " grep regex path\n"
6910 #: ../fish/guestfish-actions.pod:1528 ../src/guestfs-actions.pod:2294
6911 msgid "This calls the external C<grep> program and returns the matching lines."
6915 #: ../fish/guestfish-actions.pod:1534
6920 #: ../fish/guestfish-actions.pod:1536
6923 " grepi regex path\n"
6928 #: ../fish/guestfish-actions.pod:1538 ../src/guestfs-actions.pod:2313
6929 msgid "This calls the external C<grep -i> program and returns the matching lines."
6933 #: ../fish/guestfish-actions.pod:1544
6934 msgid "grub-install"
6938 #: ../fish/guestfish-actions.pod:1546
6941 " grub-install root device\n"
6946 #: ../fish/guestfish-actions.pod:1548 ../src/guestfs-actions.pod:2332
6948 "This command installs GRUB (the Grand Unified Bootloader) on C<device>, with "
6949 "the root directory being C<root>."
6953 #: ../fish/guestfish-actions.pod:1551 ../src/guestfs-actions.pod:2335
6955 "Note: If grub-install reports the error \"No suitable drive was found in the "
6956 "generated device map.\" it may be that you need to create a "
6957 "C</boot/grub/device.map> file first that contains the mapping between grub "
6958 "device names and Linux device names. It is usually sufficient to create a "
6963 #: ../fish/guestfish-actions.pod:1558 ../src/guestfs-actions.pod:2342
6971 #: ../fish/guestfish-actions.pod:1560 ../src/guestfs-actions.pod:2344
6972 msgid "replacing C</dev/vda> with the name of the installation device."
6976 #: ../fish/guestfish-actions.pod:1562
6981 #: ../fish/guestfish-actions.pod:1564
6989 #: ../fish/guestfish-actions.pod:1566 ../src/guestfs-actions.pod:2356
6991 "This command returns up to the first 10 lines of a file as a list of "
6996 #: ../fish/guestfish-actions.pod:1572
7001 #: ../fish/guestfish-actions.pod:1574
7004 " head-n nrlines path\n"
7009 #: ../fish/guestfish-actions.pod:1576 ../src/guestfs-actions.pod:2375
7011 "If the parameter C<nrlines> is a positive number, this returns the first "
7012 "C<nrlines> lines of the file C<path>."
7016 #: ../fish/guestfish-actions.pod:1579 ../src/guestfs-actions.pod:2378
7018 "If the parameter C<nrlines> is a negative number, this returns lines from "
7019 "the file C<path>, excluding the last C<nrlines> lines."
7023 #: ../fish/guestfish-actions.pod:1582 ../fish/guestfish-actions.pod:4648 ../src/guestfs-actions.pod:2381 ../src/guestfs-actions.pod:6996
7024 msgid "If the parameter C<nrlines> is zero, this returns an empty list."
7028 #: ../fish/guestfish-actions.pod:1587
7033 #: ../fish/guestfish-actions.pod:1589
7041 #: ../fish/guestfish-actions.pod:1591 ../src/guestfs-actions.pod:2398
7043 "This runs C<hexdump -C> on the given C<path>. The result is the "
7044 "human-readable, canonical hex dump of the file."
7048 #: ../fish/guestfish-actions.pod:1597
7053 #: ../fish/guestfish-actions.pod:1599
7056 " initrd-cat initrdpath filename\n"
7061 #: ../fish/guestfish-actions.pod:1601 ../src/guestfs-actions.pod:2417
7063 "This command unpacks the file C<filename> from the initrd file called "
7064 "C<initrdpath>. The filename must be given I<without> the initial C</> "
7069 #: ../fish/guestfish-actions.pod:1605 ../src/guestfs-actions.pod:2421
7071 "For example, in guestfish you could use the following command to examine the "
7072 "boot script (usually called C</init>) contained in a Linux initrd or "
7077 #: ../fish/guestfish-actions.pod:1609 ../src/guestfs-actions.pod:2425
7080 " initrd-cat /boot/initrd-<version>.img init\n"
7085 #: ../fish/guestfish-actions.pod:1611
7086 msgid "See also L</initrd-list>."
7090 #: ../fish/guestfish-actions.pod:1616
7095 #: ../fish/guestfish-actions.pod:1618
7098 " initrd-list path\n"
7103 #: ../fish/guestfish-actions.pod:1620 ../src/guestfs-actions.pod:2444
7104 msgid "This command lists out files contained in an initrd."
7108 #: ../fish/guestfish-actions.pod:1622 ../src/guestfs-actions.pod:2446
7110 "The files are listed without any initial C</> character. The files are "
7111 "listed in the order they appear (not necessarily alphabetical). Directory "
7112 "names are listed as separate items."
7116 #: ../fish/guestfish-actions.pod:1626 ../src/guestfs-actions.pod:2450
7118 "Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as "
7119 "initrd. We I<only> support the newer initramfs format (compressed cpio "
7124 #: ../fish/guestfish-actions.pod:1630
7125 msgid "inotify-add-watch"
7129 #: ../fish/guestfish-actions.pod:1632
7132 " inotify-add-watch path mask\n"
7137 #: ../fish/guestfish-actions.pod:1634 ../src/guestfs-actions.pod:2467
7138 msgid "Watch C<path> for the events listed in C<mask>."
7142 #: ../fish/guestfish-actions.pod:1636 ../src/guestfs-actions.pod:2469
7144 "Note that if C<path> is a directory then events within that directory are "
7145 "watched, but this does I<not> happen recursively (in subdirectories)."
7149 #: ../fish/guestfish-actions.pod:1640 ../src/guestfs-actions.pod:2473
7151 "Note for non-C or non-Linux callers: the inotify events are defined by the "
7152 "Linux kernel ABI and are listed in C</usr/include/sys/inotify.h>."
7156 #: ../fish/guestfish-actions.pod:1644
7157 msgid "inotify-close"
7161 #: ../fish/guestfish-actions.pod:1646
7169 #: ../fish/guestfish-actions.pod:1648 ../src/guestfs-actions.pod:2486
7171 "This closes the inotify handle which was previously opened by inotify_init. "
7172 "It removes all watches, throws away any pending events, and deallocates all "
7177 #: ../fish/guestfish-actions.pod:1652
7178 msgid "inotify-files"
7182 #: ../fish/guestfish-actions.pod:1654
7190 #: ../fish/guestfish-actions.pod:1656
7192 "This function is a helpful wrapper around L</inotify-read> which just "
7193 "returns a list of pathnames of objects that were touched. The returned "
7194 "pathnames are sorted and deduplicated."
7198 #: ../fish/guestfish-actions.pod:1660
7199 msgid "inotify-init"
7203 #: ../fish/guestfish-actions.pod:1662
7206 " inotify-init maxevents\n"
7211 #: ../fish/guestfish-actions.pod:1664 ../src/guestfs-actions.pod:2515
7213 "This command creates a new inotify handle. The inotify subsystem can be "
7214 "used to notify events which happen to objects in the guest filesystem."
7218 #: ../fish/guestfish-actions.pod:1668
7220 "C<maxevents> is the maximum number of events which will be queued up between "
7221 "calls to L</inotify-read> or L</inotify-files>. If this is passed as C<0>, "
7222 "then the kernel (or previously set) default is used. For Linux 2.6.29 the "
7223 "default was 16384 events. Beyond this limit, the kernel throws away events, "
7224 "but records the fact that it threw them away by setting a flag "
7225 "C<IN_Q_OVERFLOW> in the returned structure list (see L</inotify-read>)."
7229 #: ../fish/guestfish-actions.pod:1678
7231 "Before any events are generated, you have to add some watches to the "
7232 "internal watch list. See: L</inotify-add-watch>, L</inotify-rm-watch> and "
7233 "L</inotify-watch-all>."
7237 #: ../fish/guestfish-actions.pod:1684
7239 "Queued up events should be read periodically by calling L</inotify-read> (or "
7240 "L</inotify-files> which is just a helpful wrapper around L</inotify-read>). "
7241 "If you don't read the events out often enough then you risk the internal "
7242 "queue overflowing."
7246 #: ../fish/guestfish-actions.pod:1691
7248 "The handle should be closed after use by calling L</inotify-close>. This "
7249 "also removes any watches automatically."
7253 #: ../fish/guestfish-actions.pod:1695 ../src/guestfs-actions.pod:2546
7255 "See also L<inotify(7)> for an overview of the inotify interface as exposed "
7256 "by the Linux kernel, which is roughly what we expose via libguestfs. Note "
7257 "that there is one global inotify handle per libguestfs instance."
7261 #: ../fish/guestfish-actions.pod:1700
7262 msgid "inotify-read"
7266 #: ../fish/guestfish-actions.pod:1702
7274 #: ../fish/guestfish-actions.pod:1704 ../src/guestfs-actions.pod:2560
7276 "Return the complete queue of events that have happened since the previous "
7281 #: ../fish/guestfish-actions.pod:1707 ../src/guestfs-actions.pod:2563
7282 msgid "If no events have happened, this returns an empty list."
7286 #: ../fish/guestfish-actions.pod:1709 ../src/guestfs-actions.pod:2565
7288 "I<Note>: In order to make sure that all events have been read, you must call "
7289 "this function repeatedly until it returns an empty list. The reason is that "
7290 "the call will read events up to the maximum appliance-to-host message size "
7291 "and leave remaining events in the queue."
7295 #: ../fish/guestfish-actions.pod:1715
7296 msgid "inotify-rm-watch"
7300 #: ../fish/guestfish-actions.pod:1717
7303 " inotify-rm-watch wd\n"
7308 #: ../fish/guestfish-actions.pod:1719
7309 msgid "Remove a previously defined inotify watch. See L</inotify-add-watch>."
7313 #: ../fish/guestfish-actions.pod:1722
7314 msgid "inspect-get-arch"
7318 #: ../fish/guestfish-actions.pod:1724
7321 " inspect-get-arch root\n"
7326 #: ../fish/guestfish-actions.pod:1726
7328 "This returns the architecture of the inspected operating system. The "
7329 "possible return values are listed under L</file-architecture>."
7333 #: ../fish/guestfish-actions.pod:1730 ../src/guestfs-actions.pod:2600
7335 "If the architecture could not be determined, then the string C<unknown> is "
7340 #: ../fish/guestfish-actions.pod:1733 ../fish/guestfish-actions.pod:1816 ../fish/guestfish-actions.pod:1895 ../fish/guestfish-actions.pod:1907 ../fish/guestfish-actions.pod:1991 ../fish/guestfish-actions.pod:2052 ../fish/guestfish-actions.pod:2073 ../fish/guestfish-actions.pod:2087 ../fish/guestfish-actions.pod:2127 ../fish/guestfish-actions.pod:2159 ../fish/guestfish-actions.pod:2172 ../fish/guestfish-actions.pod:2185 ../fish/guestfish-actions.pod:2195 ../fish/guestfish-actions.pod:2205 ../fish/guestfish-actions.pod:2217 ../fish/guestfish-actions.pod:2313 ../fish/guestfish-actions.pod:2347 ../src/guestfs-actions.pod:2603 ../src/guestfs-actions.pod:2693 ../src/guestfs-actions.pod:2797 ../src/guestfs-actions.pod:2816 ../src/guestfs-actions.pod:2947 ../src/guestfs-actions.pod:3030 ../src/guestfs-actions.pod:3058 ../src/guestfs-actions.pod:3079 ../src/guestfs-actions.pod:3132 ../src/guestfs-actions.pod:3172 ../src/guestfs-actions.pod:3192 ../src/guestfs-actions.pod:3212 ../src/guestfs-actions.pod:3229 ../src/guestfs-actions.pod:3245 ../src/guestfs-actions.pod:3263 ../src/guestfs-actions.pod:3365 ../src/guestfs-actions.pod:3406
7341 msgid "Please read L<guestfs(3)/INSPECTION> for more details."
7345 #: ../fish/guestfish-actions.pod:1735
7346 msgid "inspect-get-distro"
7350 #: ../fish/guestfish-actions.pod:1737
7353 " inspect-get-distro root\n"
7358 #: ../fish/guestfish-actions.pod:1739 ../src/guestfs-actions.pod:2616
7359 msgid "This returns the distro (distribution) of the inspected operating system."
7363 #: ../fish/guestfish-actions.pod:1742 ../src/guestfs-actions.pod:2619
7364 msgid "Currently defined distros are:"
7368 #: ../fish/guestfish-actions.pod:1746 ../src/guestfs-actions.pod:2623
7369 msgid "\"archlinux\""
7373 #: ../fish/guestfish-actions.pod:1748 ../src/guestfs-actions.pod:2625
7378 #: ../fish/guestfish-actions.pod:1750 ../src/guestfs-actions.pod:2627
7383 #: ../fish/guestfish-actions.pod:1752 ../src/guestfs-actions.pod:2629
7388 #: ../fish/guestfish-actions.pod:1754 ../src/guestfs-actions.pod:2631
7393 #: ../fish/guestfish-actions.pod:1756 ../src/guestfs-actions.pod:2633
7398 #: ../fish/guestfish-actions.pod:1758 ../src/guestfs-actions.pod:2635
7403 #: ../fish/guestfish-actions.pod:1760 ../src/guestfs-actions.pod:2637
7408 #: ../fish/guestfish-actions.pod:1762 ../src/guestfs-actions.pod:2639
7413 #: ../fish/guestfish-actions.pod:1764 ../src/guestfs-actions.pod:2641
7418 #: ../fish/guestfish-actions.pod:1766 ../src/guestfs-actions.pod:2643
7419 msgid "\"linuxmint\""
7423 #: ../fish/guestfish-actions.pod:1768 ../src/guestfs-actions.pod:2645
7428 #: ../fish/guestfish-actions.pod:1770 ../src/guestfs-actions.pod:2647
7429 msgid "\"mandriva\""
7433 #: ../fish/guestfish-actions.pod:1772 ../src/guestfs-actions.pod:2649
7438 #: ../fish/guestfish-actions.pod:1774 ../src/guestfs-actions.pod:2651
7443 #: ../fish/guestfish-actions.pod:1776 ../src/guestfs-actions.pod:2653
7448 #: ../fish/guestfish-actions.pod:1778 ../src/guestfs-actions.pod:2655
7453 #: ../fish/guestfish-actions.pod:1780 ../src/guestfs-actions.pod:2657
7458 #: ../fish/guestfish-actions.pod:1782 ../src/guestfs-actions.pod:2659
7459 msgid "\"redhat-based\""
7463 #: ../fish/guestfish-actions.pod:1784 ../src/guestfs-actions.pod:2661
7464 msgid "Some Red Hat-derived distro."
7468 #: ../fish/guestfish-actions.pod:1786 ../src/guestfs-actions.pod:2663
7473 #: ../fish/guestfish-actions.pod:1788 ../src/guestfs-actions.pod:2665
7474 msgid "Red Hat Enterprise Linux."
7478 #: ../fish/guestfish-actions.pod:1790 ../src/guestfs-actions.pod:2667
7479 msgid "\"scientificlinux\""
7483 #: ../fish/guestfish-actions.pod:1792 ../src/guestfs-actions.pod:2669
7484 msgid "Scientific Linux."
7488 #: ../fish/guestfish-actions.pod:1794 ../src/guestfs-actions.pod:2671
7489 msgid "\"slackware\""
7493 #: ../fish/guestfish-actions.pod:1796 ../src/guestfs-actions.pod:2673
7498 #: ../fish/guestfish-actions.pod:1798 ../src/guestfs-actions.pod:2675
7503 #: ../fish/guestfish-actions.pod:1800 ../src/guestfs-actions.pod:2677
7508 #: ../fish/guestfish-actions.pod:1802 ../fish/guestfish-actions.pod:1886 ../fish/guestfish-actions.pod:2150 ../src/guestfs-actions.pod:2679 ../src/guestfs-actions.pod:2788 ../src/guestfs-actions.pod:3163
7513 #: ../fish/guestfish-actions.pod:1804 ../src/guestfs-actions.pod:2681
7514 msgid "The distro could not be determined."
7518 #: ../fish/guestfish-actions.pod:1806 ../fish/guestfish-actions.pod:2142 ../src/guestfs-actions.pod:2683 ../src/guestfs-actions.pod:3155
7523 #: ../fish/guestfish-actions.pod:1808 ../src/guestfs-actions.pod:2685
7525 "Windows does not have distributions. This string is returned if the OS type "
7530 #: ../fish/guestfish-actions.pod:1813 ../fish/guestfish-actions.pod:1892 ../fish/guestfish-actions.pod:2156 ../src/guestfs-actions.pod:2690 ../src/guestfs-actions.pod:2794 ../src/guestfs-actions.pod:3169
7532 "Future versions of libguestfs may return other strings here. The caller "
7533 "should be prepared to handle any string."
7537 #: ../fish/guestfish-actions.pod:1818
7538 msgid "inspect-get-drive-mappings"
7542 #: ../fish/guestfish-actions.pod:1820
7545 " inspect-get-drive-mappings root\n"
7550 #: ../fish/guestfish-actions.pod:1822 ../src/guestfs-actions.pod:2706
7552 "This call is useful for Windows which uses a primitive system of assigning "
7553 "drive letters (like \"C:\") to partitions. This inspection API examines the "
7554 "Windows Registry to find out how disks/partitions are mapped to drive "
7555 "letters, and returns a hash table as in the example below:"
7559 #: ../fish/guestfish-actions.pod:1828 ../src/guestfs-actions.pod:2712
7569 #: ../fish/guestfish-actions.pod:1832 ../src/guestfs-actions.pod:2716
7571 "Note that keys are drive letters. For Windows, the key is case insensitive "
7572 "and just contains the drive letter, without the customary colon separator "
7577 #: ../fish/guestfish-actions.pod:1836 ../src/guestfs-actions.pod:2720
7579 "In future we may support other operating systems that also used drive "
7580 "letters, but the keys for those might not be case insensitive and might be "
7581 "longer than 1 character. For example in OS-9, hard drives were named C<h0>, "
7586 #: ../fish/guestfish-actions.pod:1841 ../src/guestfs-actions.pod:2725
7588 "For Windows guests, currently only hard drive mappings are returned. "
7589 "Removable disks (eg. DVD-ROMs) are ignored."
7593 #: ../fish/guestfish-actions.pod:1844 ../src/guestfs-actions.pod:2728
7595 "For guests that do not use drive mappings, or if the drive mappings could "
7596 "not be determined, this returns an empty hash table."
7600 #: ../fish/guestfish-actions.pod:1847
7602 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7603 "L</inspect-get-mountpoints>, L</inspect-get-filesystems>."
7607 #: ../fish/guestfish-actions.pod:1851
7608 msgid "inspect-get-filesystems"
7612 #: ../fish/guestfish-actions.pod:1853
7615 " inspect-get-filesystems root\n"
7620 #: ../fish/guestfish-actions.pod:1855 ../src/guestfs-actions.pod:2749
7622 "This returns a list of all the filesystems that we think are associated with "
7623 "this operating system. This includes the root filesystem, other ordinary "
7624 "filesystems, and non-mounted devices like swap partitions."
7628 #: ../fish/guestfish-actions.pod:1860 ../src/guestfs-actions.pod:2754
7630 "In the case of a multi-boot virtual machine, it is possible for a filesystem "
7631 "to be shared between operating systems."
7635 #: ../fish/guestfish-actions.pod:1863
7637 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7638 "L</inspect-get-mountpoints>."
7642 #: ../fish/guestfish-actions.pod:1866
7643 msgid "inspect-get-format"
7647 #: ../fish/guestfish-actions.pod:1868
7650 " inspect-get-format root\n"
7655 #: ../fish/guestfish-actions.pod:1870 ../src/guestfs-actions.pod:2772
7657 "This returns the format of the inspected operating system. You can use it "
7658 "to detect install images, live CDs and similar."
7662 #: ../fish/guestfish-actions.pod:1873 ../src/guestfs-actions.pod:2775
7663 msgid "Currently defined formats are:"
7667 #: ../fish/guestfish-actions.pod:1877 ../src/guestfs-actions.pod:2779
7668 msgid "\"installed\""
7672 #: ../fish/guestfish-actions.pod:1879 ../src/guestfs-actions.pod:2781
7673 msgid "This is an installed operating system."
7677 #: ../fish/guestfish-actions.pod:1881 ../src/guestfs-actions.pod:2783
7678 msgid "\"installer\""
7682 #: ../fish/guestfish-actions.pod:1883 ../src/guestfs-actions.pod:2785
7684 "The disk image being inspected is not an installed operating system, but a "
7685 "I<bootable> install disk, live CD, or similar."
7689 #: ../fish/guestfish-actions.pod:1888 ../src/guestfs-actions.pod:2790
7690 msgid "The format of this disk image is not known."
7694 #: ../fish/guestfish-actions.pod:1897
7695 msgid "inspect-get-hostname"
7699 #: ../fish/guestfish-actions.pod:1899
7702 " inspect-get-hostname root\n"
7707 #: ../fish/guestfish-actions.pod:1901 ../src/guestfs-actions.pod:2810
7709 "This function returns the hostname of the operating system as found by "
7710 "inspection of the guest's configuration files."
7714 #: ../fish/guestfish-actions.pod:1904 ../src/guestfs-actions.pod:2813
7716 "If the hostname could not be determined, then the string C<unknown> is "
7721 #: ../fish/guestfish-actions.pod:1909
7722 msgid "inspect-get-icon"
7726 #: ../fish/guestfish-actions.pod:1911
7729 " inspect-get-icon root [favicon:..] [highquality:..]\n"
7734 #: ../fish/guestfish-actions.pod:1913 ../src/guestfs-actions.pod:2839
7736 "This function returns an icon corresponding to the inspected operating "
7737 "system. The icon is returned as a buffer containing a PNG image (re-encoded "
7738 "to PNG if necessary)."
7742 #: ../fish/guestfish-actions.pod:1917 ../src/guestfs-actions.pod:2843
7744 "If it was not possible to get an icon this function returns a zero-length "
7745 "(non-NULL) buffer. I<Callers must check for this case>."
7749 #: ../fish/guestfish-actions.pod:1920 ../src/guestfs-actions.pod:2846
7751 "Libguestfs will start by looking for a file called C</etc/favicon.png> or "
7752 "C<C:\\etc\\favicon.png> and if it has the correct format, the contents of "
7753 "this file will be returned. You can disable favicons by passing the "
7754 "optional C<favicon> boolean as false (default is true)."
7758 #: ../fish/guestfish-actions.pod:1926 ../src/guestfs-actions.pod:2852
7760 "If finding the favicon fails, then we look in other places in the guest for "
7765 #: ../fish/guestfish-actions.pod:1929 ../src/guestfs-actions.pod:2855
7767 "If the optional C<highquality> boolean is true then only high quality icons "
7768 "are returned, which means only icons of high resolution with an alpha "
7769 "channel. The default (false) is to return any icon we can, even if it is of "
7770 "substandard quality."
7774 #: ../fish/guestfish-actions.pod:1940 ../src/guestfs-actions.pod:2866
7776 "Unlike most other inspection API calls, the guest's disks must be mounted up "
7777 "before you call this, since it needs to read information from the guest "
7778 "filesystem during the call."
7782 #: ../fish/guestfish-actions.pod:1946 ../src/guestfs-actions.pod:2872
7784 "B<Security:> The icon data comes from the untrusted guest, and should be "
7785 "treated with caution. PNG files have been known to contain exploits. "
7786 "Ensure that libpng (or other relevant libraries) are fully up to date before "
7787 "trying to process or display the icon."
7791 #: ../fish/guestfish-actions.pod:1954 ../src/guestfs-actions.pod:2880
7793 "The PNG image returned can be any size. It might not be square. Libguestfs "
7794 "tries to return the largest, highest quality icon available. The "
7795 "application must scale the icon to the required size."
7799 #: ../fish/guestfish-actions.pod:1961 ../src/guestfs-actions.pod:2887
7801 "Extracting icons from Windows guests requires the external C<wrestool> "
7802 "program from the C<icoutils> package, and several programs (C<bmptopnm>, "
7803 "C<pnmtopng>, C<pamcut>) from the C<netpbm> package. These must be "
7804 "installed separately."
7808 #: ../fish/guestfish-actions.pod:1968 ../src/guestfs-actions.pod:2894
7810 "Operating system icons are usually trademarks. Seek legal advice before "
7811 "using trademarks in applications."
7815 #: ../fish/guestfish-actions.pod:1975
7816 msgid "inspect-get-major-version"
7820 #: ../fish/guestfish-actions.pod:1977
7823 " inspect-get-major-version root\n"
7828 #: ../fish/guestfish-actions.pod:1979 ../src/guestfs-actions.pod:2935
7829 msgid "This returns the major version number of the inspected operating system."
7833 #: ../fish/guestfish-actions.pod:1982 ../src/guestfs-actions.pod:2938
7835 "Windows uses a consistent versioning scheme which is I<not> reflected in the "
7836 "popular public names used by the operating system. Notably the operating "
7837 "system known as \"Windows 7\" is really version 6.1 (ie. major = 6, minor = "
7838 "1). You can find out the real versions corresponding to releases of Windows "
7839 "by consulting Wikipedia or MSDN."
7843 #: ../fish/guestfish-actions.pod:1989 ../fish/guestfish-actions.pod:2000 ../src/guestfs-actions.pod:2945 ../src/guestfs-actions.pod:2962
7844 msgid "If the version could not be determined, then C<0> is returned."
7848 #: ../fish/guestfish-actions.pod:1993
7849 msgid "inspect-get-minor-version"
7853 #: ../fish/guestfish-actions.pod:1995
7856 " inspect-get-minor-version root\n"
7861 #: ../fish/guestfish-actions.pod:1997 ../src/guestfs-actions.pod:2959
7862 msgid "This returns the minor version number of the inspected operating system."
7866 #: ../fish/guestfish-actions.pod:2002
7868 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7869 "L</inspect-get-major-version>."
7873 #: ../fish/guestfish-actions.pod:2005
7874 msgid "inspect-get-mountpoints"
7878 #: ../fish/guestfish-actions.pod:2007
7881 " inspect-get-mountpoints root\n"
7886 #: ../fish/guestfish-actions.pod:2009 ../src/guestfs-actions.pod:2977
7888 "This returns a hash of where we think the filesystems associated with this "
7889 "operating system should be mounted. Callers should note that this is at "
7890 "best an educated guess made by reading configuration files such as "
7891 "C</etc/fstab>. I<In particular note> that this may return filesystems which "
7892 "are non-existent or not mountable and callers should be prepared to handle "
7893 "or ignore failures if they try to mount them."
7897 #: ../fish/guestfish-actions.pod:2018 ../src/guestfs-actions.pod:2986
7899 "Each element in the returned hashtable has a key which is the path of the "
7900 "mountpoint (eg. C</boot>) and a value which is the filesystem that would be "
7901 "mounted there (eg. C</dev/sda1>)."
7905 #: ../fish/guestfish-actions.pod:2023 ../src/guestfs-actions.pod:2991
7906 msgid "Non-mounted devices such as swap devices are I<not> returned in this list."
7910 #: ../fish/guestfish-actions.pod:2026
7912 "For operating systems like Windows which still use drive letters, this call "
7913 "will only return an entry for the first drive \"mounted on\" C</>. For "
7914 "information about the mapping of drive letters to partitions, see "
7915 "L</inspect-get-drive-mappings>."
7919 #: ../fish/guestfish-actions.pod:2032
7921 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
7922 "L</inspect-get-filesystems>."
7926 #: ../fish/guestfish-actions.pod:2035
7927 msgid "inspect-get-package-format"
7931 #: ../fish/guestfish-actions.pod:2037
7934 " inspect-get-package-format root\n"
7939 #: ../fish/guestfish-actions.pod:2039
7941 "This function and L</inspect-get-package-management> return the package "
7942 "format and package management tool used by the inspected operating system. "
7943 "For example for Fedora these functions would return C<rpm> (package format) "
7944 "and C<yum> (package management)."
7948 #: ../fish/guestfish-actions.pod:2045 ../src/guestfs-actions.pod:3023
7950 "This returns the string C<unknown> if we could not determine the package "
7951 "format I<or> if the operating system does not have a real packaging system "
7956 #: ../fish/guestfish-actions.pod:2049 ../src/guestfs-actions.pod:3027
7958 "Possible strings include: C<rpm>, C<deb>, C<ebuild>, C<pisi>, C<pacman>. "
7959 "Future versions of libguestfs may return other strings."
7963 #: ../fish/guestfish-actions.pod:2054
7964 msgid "inspect-get-package-management"
7968 #: ../fish/guestfish-actions.pod:2056
7971 " inspect-get-package-management root\n"
7976 #: ../fish/guestfish-actions.pod:2058
7978 "L</inspect-get-package-format> and this function return the package format "
7979 "and package management tool used by the inspected operating system. For "
7980 "example for Fedora these functions would return C<rpm> (package format) and "
7981 "C<yum> (package management)."
7985 #: ../fish/guestfish-actions.pod:2064 ../src/guestfs-actions.pod:3049
7987 "This returns the string C<unknown> if we could not determine the package "
7988 "management tool I<or> if the operating system does not have a real packaging "
7989 "system (eg. Windows)."
7993 #: ../fish/guestfish-actions.pod:2068 ../src/guestfs-actions.pod:3053
7995 "Possible strings include: C<yum>, C<up2date>, C<apt> (for all Debian "
7996 "derivatives), C<portage>, C<pisi>, C<pacman>, C<urpmi>. Future versions of "
7997 "libguestfs may return other strings."
8001 #: ../fish/guestfish-actions.pod:2075
8002 msgid "inspect-get-product-name"
8006 #: ../fish/guestfish-actions.pod:2077
8009 " inspect-get-product-name root\n"
8014 #: ../fish/guestfish-actions.pod:2079 ../src/guestfs-actions.pod:3071
8016 "This returns the product name of the inspected operating system. The "
8017 "product name is generally some freeform string which can be displayed to the "
8018 "user, but should not be parsed by programs."
8022 #: ../fish/guestfish-actions.pod:2084 ../src/guestfs-actions.pod:3076
8024 "If the product name could not be determined, then the string C<unknown> is "
8029 #: ../fish/guestfish-actions.pod:2089
8030 msgid "inspect-get-product-variant"
8034 #: ../fish/guestfish-actions.pod:2091
8037 " inspect-get-product-variant root\n"
8042 #: ../fish/guestfish-actions.pod:2093 ../src/guestfs-actions.pod:3092
8043 msgid "This returns the product variant of the inspected operating system."
8047 #: ../fish/guestfish-actions.pod:2096 ../src/guestfs-actions.pod:3095
8049 "For Windows guests, this returns the contents of the Registry key "
8050 "C<HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion> C<InstallationType> "
8051 "which is usually a string such as C<Client> or C<Server> (other values are "
8052 "possible). This can be used to distinguish consumer and enterprise versions "
8053 "of Windows that have the same version number (for example, Windows 7 and "
8054 "Windows 2008 Server are both version 6.1, but the former is C<Client> and "
8055 "the latter is C<Server>)."
8059 #: ../fish/guestfish-actions.pod:2105 ../src/guestfs-actions.pod:3104
8061 "For enterprise Linux guests, in future we intend this to return the product "
8062 "variant such as C<Desktop>, C<Server> and so on. But this is not "
8063 "implemented at present."
8067 #: ../fish/guestfish-actions.pod:2109 ../src/guestfs-actions.pod:3108
8069 "If the product variant could not be determined, then the string C<unknown> "
8074 #: ../fish/guestfish-actions.pod:2112
8076 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
8077 "L</inspect-get-product-name>, L</inspect-get-major-version>."
8081 #: ../fish/guestfish-actions.pod:2116
8082 msgid "inspect-get-roots"
8086 #: ../fish/guestfish-actions.pod:2118
8089 " inspect-get-roots\n"
8094 #: ../fish/guestfish-actions.pod:2120
8096 "This function is a convenient way to get the list of root devices, as "
8097 "returned from a previous call to L</inspect-os>, but without redoing the "
8098 "whole inspection process."
8102 #: ../fish/guestfish-actions.pod:2124
8104 "This returns an empty list if either no root devices were found or the "
8105 "caller has not called L</inspect-os>."
8109 #: ../fish/guestfish-actions.pod:2129
8110 msgid "inspect-get-type"
8114 #: ../fish/guestfish-actions.pod:2131
8117 " inspect-get-type root\n"
8122 #: ../fish/guestfish-actions.pod:2133 ../src/guestfs-actions.pod:3146
8124 "This returns the type of the inspected operating system. Currently defined "
8129 #: ../fish/guestfish-actions.pod:2138 ../src/guestfs-actions.pod:3151
8134 #: ../fish/guestfish-actions.pod:2140 ../src/guestfs-actions.pod:3153
8135 msgid "Any Linux-based operating system."
8139 #: ../fish/guestfish-actions.pod:2144 ../src/guestfs-actions.pod:3157
8140 msgid "Any Microsoft Windows operating system."
8144 #: ../fish/guestfish-actions.pod:2146 ../src/guestfs-actions.pod:3159
8149 #: ../fish/guestfish-actions.pod:2148 ../src/guestfs-actions.pod:3161
8154 #: ../fish/guestfish-actions.pod:2152 ../src/guestfs-actions.pod:3165
8155 msgid "The operating system type could not be determined."
8159 #: ../fish/guestfish-actions.pod:2161
8160 msgid "inspect-get-windows-current-control-set"
8164 #: ../fish/guestfish-actions.pod:2163
8167 " inspect-get-windows-current-control-set root\n"
8172 #: ../fish/guestfish-actions.pod:2165 ../src/guestfs-actions.pod:3185
8174 "This returns the Windows CurrentControlSet of the inspected guest. The "
8175 "CurrentControlSet is a registry key name such as C<ControlSet001>."
8179 #: ../fish/guestfish-actions.pod:2168 ../src/guestfs-actions.pod:3188
8181 "This call assumes that the guest is Windows and that the Registry could be "
8182 "examined by inspection. If this is not the case then an error is returned."
8186 #: ../fish/guestfish-actions.pod:2174
8187 msgid "inspect-get-windows-systemroot"
8191 #: ../fish/guestfish-actions.pod:2176
8194 " inspect-get-windows-systemroot root\n"
8199 #: ../fish/guestfish-actions.pod:2178 ../src/guestfs-actions.pod:3205
8201 "This returns the Windows systemroot of the inspected guest. The systemroot "
8202 "is a directory path such as C</WINDOWS>."
8206 #: ../fish/guestfish-actions.pod:2181 ../src/guestfs-actions.pod:3208
8208 "This call assumes that the guest is Windows and that the systemroot could be "
8209 "determined by inspection. If this is not the case then an error is "
8214 #: ../fish/guestfish-actions.pod:2187
8215 msgid "inspect-is-live"
8219 #: ../fish/guestfish-actions.pod:2189
8222 " inspect-is-live root\n"
8227 #: ../fish/guestfish-actions.pod:2191
8229 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8230 "then this returns true if a live image was detected on the disk."
8234 #: ../fish/guestfish-actions.pod:2197
8235 msgid "inspect-is-multipart"
8239 #: ../fish/guestfish-actions.pod:2199
8242 " inspect-is-multipart root\n"
8247 #: ../fish/guestfish-actions.pod:2201
8249 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8250 "then this returns true if the disk is part of a set."
8254 #: ../fish/guestfish-actions.pod:2207
8255 msgid "inspect-is-netinst"
8259 #: ../fish/guestfish-actions.pod:2209
8262 " inspect-is-netinst root\n"
8267 #: ../fish/guestfish-actions.pod:2211
8269 "If L</inspect-get-format> returns C<installer> (this is an install disk), "
8270 "then this returns true if the disk is a network installer, ie. not a "
8271 "self-contained install CD but one which is likely to require network access "
8272 "to complete the install."
8276 #: ../fish/guestfish-actions.pod:2219
8277 msgid "inspect-list-applications"
8281 #: ../fish/guestfish-actions.pod:2221
8284 " inspect-list-applications root\n"
8289 #: ../fish/guestfish-actions.pod:2223 ../src/guestfs-actions.pod:3275
8290 msgid "Return the list of applications installed in the operating system."
8294 #: ../fish/guestfish-actions.pod:2225
8296 "I<Note:> This call works differently from other parts of the inspection "
8297 "API. You have to call L</inspect-os>, then L</inspect-get-mountpoints>, "
8298 "then mount up the disks, before calling this. Listing applications is a "
8299 "significantly more difficult operation which requires access to the full "
8300 "filesystem. Also note that unlike the other L</inspect-get-*> calls which "
8301 "are just returning data cached in the libguestfs handle, this call actually "
8302 "reads parts of the mounted filesystems during the call."
8306 #: ../fish/guestfish-actions.pod:2235 ../src/guestfs-actions.pod:3287
8308 "This returns an empty list if the inspection code was not able to determine "
8309 "the list of applications."
8313 #: ../fish/guestfish-actions.pod:2238 ../src/guestfs-actions.pod:3290
8314 msgid "The application structure contains the following fields:"
8318 #: ../fish/guestfish-actions.pod:2242 ../src/guestfs-actions.pod:3294
8323 #: ../fish/guestfish-actions.pod:2244 ../src/guestfs-actions.pod:3296
8325 "The name of the application. For Red Hat-derived and Debian-derived Linux "
8326 "guests, this is the package name."
8330 #: ../fish/guestfish-actions.pod:2247 ../src/guestfs-actions.pod:3299
8331 msgid "C<app_display_name>"
8335 #: ../fish/guestfish-actions.pod:2249 ../src/guestfs-actions.pod:3301
8337 "The display name of the application, sometimes localized to the install "
8338 "language of the guest operating system."
8342 #: ../fish/guestfish-actions.pod:2252 ../src/guestfs-actions.pod:3304
8344 "If unavailable this is returned as an empty string C<\"\">. Callers needing "
8345 "to display something can use C<app_name> instead."
8349 #: ../fish/guestfish-actions.pod:2255 ../src/guestfs-actions.pod:3307
8350 msgid "C<app_epoch>"
8354 #: ../fish/guestfish-actions.pod:2257 ../src/guestfs-actions.pod:3309
8356 "For package managers which use epochs, this contains the epoch of the "
8357 "package (an integer). If unavailable, this is returned as C<0>."
8361 #: ../fish/guestfish-actions.pod:2260 ../src/guestfs-actions.pod:3312
8362 msgid "C<app_version>"
8366 #: ../fish/guestfish-actions.pod:2262 ../src/guestfs-actions.pod:3314
8368 "The version string of the application or package. If unavailable this is "
8369 "returned as an empty string C<\"\">."
8373 #: ../fish/guestfish-actions.pod:2265 ../src/guestfs-actions.pod:3317
8374 msgid "C<app_release>"
8378 #: ../fish/guestfish-actions.pod:2267 ../src/guestfs-actions.pod:3319
8380 "The release string of the application or package, for package managers that "
8381 "use this. If unavailable this is returned as an empty string C<\"\">."
8385 #: ../fish/guestfish-actions.pod:2271 ../src/guestfs-actions.pod:3323
8386 msgid "C<app_install_path>"
8390 #: ../fish/guestfish-actions.pod:2273 ../src/guestfs-actions.pod:3325
8392 "The installation path of the application (on operating systems such as "
8393 "Windows which use installation paths). This path is in the format used by "
8394 "the guest operating system, it is not a libguestfs path."
8398 #: ../fish/guestfish-actions.pod:2278 ../src/guestfs-actions.pod:3330
8399 msgid "If unavailable this is returned as an empty string C<\"\">."
8403 #: ../fish/guestfish-actions.pod:2280 ../src/guestfs-actions.pod:3332
8404 msgid "C<app_trans_path>"
8408 #: ../fish/guestfish-actions.pod:2282 ../src/guestfs-actions.pod:3334
8410 "The install path translated into a libguestfs path. If unavailable this is "
8411 "returned as an empty string C<\"\">."
8415 #: ../fish/guestfish-actions.pod:2285 ../src/guestfs-actions.pod:3337
8416 msgid "C<app_publisher>"
8420 #: ../fish/guestfish-actions.pod:2287 ../src/guestfs-actions.pod:3339
8422 "The name of the publisher of the application, for package managers that use "
8423 "this. If unavailable this is returned as an empty string C<\"\">."
8427 #: ../fish/guestfish-actions.pod:2291 ../src/guestfs-actions.pod:3343
8432 #: ../fish/guestfish-actions.pod:2293 ../src/guestfs-actions.pod:3345
8434 "The URL (eg. upstream URL) of the application. If unavailable this is "
8435 "returned as an empty string C<\"\">."
8439 #: ../fish/guestfish-actions.pod:2296 ../src/guestfs-actions.pod:3348
8440 msgid "C<app_source_package>"
8444 #: ../fish/guestfish-actions.pod:2298 ../src/guestfs-actions.pod:3350
8446 "For packaging systems which support this, the name of the source package. "
8447 "If unavailable this is returned as an empty string C<\"\">."
8451 #: ../fish/guestfish-actions.pod:2301 ../src/guestfs-actions.pod:3353
8452 msgid "C<app_summary>"
8456 #: ../fish/guestfish-actions.pod:2303 ../src/guestfs-actions.pod:3355
8458 "A short (usually one line) description of the application or package. If "
8459 "unavailable this is returned as an empty string C<\"\">."
8463 #: ../fish/guestfish-actions.pod:2306 ../src/guestfs-actions.pod:3358
8464 msgid "C<app_description>"
8468 #: ../fish/guestfish-actions.pod:2308 ../src/guestfs-actions.pod:3360
8470 "A longer description of the application or package. If unavailable this is "
8471 "returned as an empty string C<\"\">."
8475 #: ../fish/guestfish-actions.pod:2315
8480 #: ../fish/guestfish-actions.pod:2317
8488 #: ../fish/guestfish-actions.pod:2319 ../src/guestfs-actions.pod:3378
8490 "This function uses other libguestfs functions and certain heuristics to "
8491 "inspect the disk(s) (usually disks belonging to a virtual machine), looking "
8492 "for operating systems."
8496 #: ../fish/guestfish-actions.pod:2323 ../src/guestfs-actions.pod:3382
8497 msgid "The list returned is empty if no operating systems were found."
8501 #: ../fish/guestfish-actions.pod:2325 ../src/guestfs-actions.pod:3384
8503 "If one operating system was found, then this returns a list with a single "
8504 "element, which is the name of the root filesystem of this operating system. "
8505 "It is also possible for this function to return a list containing more than "
8506 "one element, indicating a dual-boot or multi-boot virtual machine, with each "
8507 "element being the root filesystem of one of the operating systems."
8511 #: ../fish/guestfish-actions.pod:2332
8513 "You can pass the root string(s) returned to other L</inspect-get-*> "
8514 "functions in order to query further information about each operating system, "
8515 "such as the name and version."
8519 #: ../fish/guestfish-actions.pod:2337
8521 "This function uses other libguestfs features such as L</mount-ro> and "
8522 "L</umount-all> in order to mount and unmount filesystems and look at the "
8523 "contents. This should be called with no disks currently mounted. The "
8524 "function may also use Augeas, so any existing Augeas handle will be closed."
8528 #: ../fish/guestfish-actions.pod:2343 ../src/guestfs-actions.pod:3402
8530 "This function cannot decrypt encrypted disks. The caller must do that first "
8531 "(supplying the necessary keys) if the disk is encrypted."
8535 #: ../fish/guestfish-actions.pod:2349 ../fish/guestfish-actions.pod:2547 ../fish/guestfish-actions.pod:2606
8536 msgid "See also L</list-filesystems>."
8540 #: ../fish/guestfish-actions.pod:2351
8545 #: ../fish/guestfish-actions.pod:2353
8548 " is-blockdev path\n"
8553 #: ../fish/guestfish-actions.pod:2355 ../src/guestfs-actions.pod:3422
8555 "This returns C<true> if and only if there is a block device with the given "
8560 #: ../fish/guestfish-actions.pod:2358 ../fish/guestfish-actions.pod:2376 ../fish/guestfish-actions.pod:2395 ../fish/guestfish-actions.pod:2404 ../fish/guestfish-actions.pod:2414 ../fish/guestfish-actions.pod:2448 ../fish/guestfish-actions.pod:2457
8561 msgid "See also L</stat>."
8565 #: ../fish/guestfish-actions.pod:2360
8570 #: ../fish/guestfish-actions.pod:2362
8578 #: ../fish/guestfish-actions.pod:2364 ../src/guestfs-actions.pod:3436
8580 "This returns true iff this handle is busy processing a command (in the "
8585 #: ../fish/guestfish-actions.pod:2369
8590 #: ../fish/guestfish-actions.pod:2371
8593 " is-chardev path\n"
8598 #: ../fish/guestfish-actions.pod:2373 ../src/guestfs-actions.pod:3451
8600 "This returns C<true> if and only if there is a character device with the "
8601 "given C<path> name."
8605 #: ../fish/guestfish-actions.pod:2378
8610 #: ../fish/guestfish-actions.pod:2380
8618 #: ../fish/guestfish-actions.pod:2382 ../src/guestfs-actions.pod:3465
8620 "This returns true iff this handle is being configured (in the C<CONFIG> "
8625 #: ../fish/guestfish-actions.pod:2387
8630 #: ../fish/guestfish-actions.pod:2389
8638 #: ../fish/guestfish-actions.pod:2391 ../src/guestfs-actions.pod:3480
8640 "This returns C<true> if and only if there is a directory with the given "
8641 "C<path> name. Note that it returns false for other objects like files."
8645 #: ../fish/guestfish-actions.pod:2397
8650 #: ../fish/guestfish-actions.pod:2399
8658 #: ../fish/guestfish-actions.pod:2401 ../src/guestfs-actions.pod:3496
8660 "This returns C<true> if and only if there is a FIFO (named pipe) with the "
8661 "given C<path> name."
8665 #: ../fish/guestfish-actions.pod:2406
8670 #: ../fish/guestfish-actions.pod:2408
8678 #: ../fish/guestfish-actions.pod:2410 ../src/guestfs-actions.pod:3511
8680 "This returns C<true> if and only if there is a regular file with the given "
8681 "C<path> name. Note that it returns false for other objects like "
8686 #: ../fish/guestfish-actions.pod:2416
8687 msgid "is-launching"
8691 #: ../fish/guestfish-actions.pod:2418
8699 #: ../fish/guestfish-actions.pod:2420 ../src/guestfs-actions.pod:3526
8701 "This returns true iff this handle is launching the subprocess (in the "
8702 "C<LAUNCHING> state)."
8706 #: ../fish/guestfish-actions.pod:2425
8711 #: ../fish/guestfish-actions.pod:2427
8719 #: ../fish/guestfish-actions.pod:2429 ../src/guestfs-actions.pod:3541
8721 "This command tests whether C<device> is a logical volume, and returns true "
8722 "iff this is the case."
8726 #: ../fish/guestfish-actions.pod:2432
8731 #: ../fish/guestfish-actions.pod:2434
8739 #: ../fish/guestfish-actions.pod:2436 ../src/guestfs-actions.pod:3553
8741 "This returns true iff this handle is ready to accept commands (in the "
8746 #: ../fish/guestfish-actions.pod:2441
8751 #: ../fish/guestfish-actions.pod:2443
8759 #: ../fish/guestfish-actions.pod:2445 ../src/guestfs-actions.pod:3568
8761 "This returns C<true> if and only if there is a Unix domain socket with the "
8762 "given C<path> name."
8766 #: ../fish/guestfish-actions.pod:2450
8771 #: ../fish/guestfish-actions.pod:2452
8774 " is-symlink path\n"
8779 #: ../fish/guestfish-actions.pod:2454 ../src/guestfs-actions.pod:3583
8781 "This returns C<true> if and only if there is a symbolic link with the given "
8786 #: ../fish/guestfish-actions.pod:2459
8791 #: ../fish/guestfish-actions.pod:2461
8799 #: ../fish/guestfish-actions.pod:2463 ../src/guestfs-actions.pod:3598
8801 "This returns true iff the file exists and the file is empty or it contains "
8806 #: ../fish/guestfish-actions.pod:2466
8807 msgid "is-zero-device"
8811 #: ../fish/guestfish-actions.pod:2468
8814 " is-zero-device device\n"
8819 #: ../fish/guestfish-actions.pod:2470 ../src/guestfs-actions.pod:3611
8820 msgid "This returns true iff the device exists and contains all zero bytes."
8824 #: ../fish/guestfish-actions.pod:2472 ../src/guestfs-actions.pod:3613
8825 msgid "Note that for large devices this can take a long time to run."
8829 #: ../fish/guestfish-actions.pod:2474
8830 msgid "kill-subprocess"
8834 #: ../fish/guestfish-actions.pod:2476
8837 " kill-subprocess\n"
8842 #: ../fish/guestfish-actions.pod:2478 ../src/guestfs-actions.pod:3624
8843 msgid "This kills the qemu subprocess. You should never need to call this."
8847 #: ../fish/guestfish-actions.pod:2480
8852 #: ../fish/guestfish-actions.pod:2482
8857 #: ../fish/guestfish-actions.pod:2484
8865 #: ../fish/guestfish-actions.pod:2486 ../src/guestfs-actions.pod:3635
8867 "Internally libguestfs is implemented by running a virtual machine using "
8872 #: ../fish/guestfish-actions.pod:2489 ../src/guestfs-actions.pod:3638
8874 "You should call this after configuring the handle (eg. adding drives) but "
8875 "before performing any actions."
8879 #: ../fish/guestfish-actions.pod:2492
8884 #: ../fish/guestfish-actions.pod:2494
8887 " lchown owner group path\n"
8892 #: ../fish/guestfish-actions.pod:2496
8894 "Change the file owner to C<owner> and group to C<group>. This is like "
8895 "L</chown> but if C<path> is a symlink then the link itself is changed, not "
8900 #: ../fish/guestfish-actions.pod:2504
8905 #: ../fish/guestfish-actions.pod:2506
8908 " lgetxattr path name\n"
8913 #: ../fish/guestfish-actions.pod:2508 ../src/guestfs-actions.pod:3678
8915 "Get a single extended attribute from file C<path> named C<name>. If C<path> "
8916 "is a symlink, then this call returns an extended attribute from the symlink."
8920 #: ../fish/guestfish-actions.pod:2522
8921 msgid "See also: L</lgetxattrs>, L</getxattr>, L<attr(5)>."
8925 #: ../fish/guestfish-actions.pod:2524
8930 #: ../fish/guestfish-actions.pod:2526
8933 " lgetxattrs path\n"
8938 #: ../fish/guestfish-actions.pod:2528
8940 "This is the same as L</getxattrs>, but if C<path> is a symbolic link, then "
8941 "it returns the extended attributes of the link itself."
8945 #: ../fish/guestfish-actions.pod:2532
8950 #: ../fish/guestfish-actions.pod:2534
8958 #: ../fish/guestfish-actions.pod:2536 ../src/guestfs-actions.pod:3721
8960 "List all 9p filesystems attached to the guest. A list of mount tags is "
8965 #: ../fish/guestfish-actions.pod:2539
8966 msgid "list-devices"
8970 #: ../fish/guestfish-actions.pod:2541
8978 #: ../fish/guestfish-actions.pod:2543 ../src/guestfs-actions.pod:3735
8979 msgid "List all the block devices."
8983 #: ../fish/guestfish-actions.pod:2545 ../src/guestfs-actions.pod:3737
8984 msgid "The full block device names are returned, eg. C</dev/sda>."
8988 #: ../fish/guestfish-actions.pod:2549
8989 msgid "list-dm-devices"
8993 #: ../fish/guestfish-actions.pod:2551
8996 " list-dm-devices\n"
9001 #: ../fish/guestfish-actions.pod:2553 ../src/guestfs-actions.pod:3752
9002 msgid "List all device mapper devices."
9006 #: ../fish/guestfish-actions.pod:2555
9008 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
9009 "previous call to L</luks-open>."
9013 #: ../fish/guestfish-actions.pod:2558
9015 "Device mapper devices which correspond to logical volumes are I<not> "
9016 "returned in this list. Call L</lvs> if you want to list logical volumes."
9020 #: ../fish/guestfish-actions.pod:2562
9021 msgid "list-filesystems"
9025 #: ../fish/guestfish-actions.pod:2564
9028 " list-filesystems\n"
9033 #: ../fish/guestfish-actions.pod:2566 ../src/guestfs-actions.pod:3772
9035 "This inspection command looks for filesystems on partitions, block devices "
9036 "and logical volumes, returning a list of devices containing filesystems and "
9041 #: ../fish/guestfish-actions.pod:2570 ../src/guestfs-actions.pod:3776
9043 "The return value is a hash, where the keys are the devices containing "
9044 "filesystems, and the values are the filesystem types. For example:"
9048 #: ../fish/guestfish-actions.pod:2574 ../src/guestfs-actions.pod:3780
9051 " \"/dev/sda1\" => \"ntfs\"\n"
9052 " \"/dev/sda2\" => \"ext2\"\n"
9053 " \"/dev/vg_guest/lv_root\" => \"ext4\"\n"
9054 " \"/dev/vg_guest/lv_swap\" => \"swap\"\n"
9059 #: ../fish/guestfish-actions.pod:2579 ../src/guestfs-actions.pod:3785
9061 "The value can have the special value \"unknown\", meaning the content of the "
9062 "device is undetermined or empty. \"swap\" means a Linux swap partition."
9066 #: ../fish/guestfish-actions.pod:2583
9068 "This command runs other libguestfs commands, which might include L</mount> "
9069 "and L</umount>, and therefore you should use this soon after launch and only "
9070 "when nothing is mounted."
9074 #: ../fish/guestfish-actions.pod:2587
9076 "Not all of the filesystems returned will be mountable. In particular, swap "
9077 "partitions are returned in the list. Also this command does not check that "
9078 "each filesystem found is valid and mountable, and some filesystems might be "
9079 "mountable but require special options. Filesystems may not all belong to a "
9080 "single logical operating system (use L</inspect-os> to look for OSes)."
9084 #: ../fish/guestfish-actions.pod:2595
9085 msgid "list-partitions"
9089 #: ../fish/guestfish-actions.pod:2597
9092 " list-partitions\n"
9097 #: ../fish/guestfish-actions.pod:2599 ../src/guestfs-actions.pod:3814
9098 msgid "List all the partitions detected on all block devices."
9102 #: ../fish/guestfish-actions.pod:2601 ../src/guestfs-actions.pod:3816
9103 msgid "The full partition device names are returned, eg. C</dev/sda1>"
9107 #: ../fish/guestfish-actions.pod:2603
9109 "This does not return logical volumes. For that you will need to call "
9114 #: ../fish/guestfish-actions.pod:2608
9119 #: ../fish/guestfish-actions.pod:2610
9127 #: ../fish/guestfish-actions.pod:2612 ../src/guestfs-actions.pod:3835
9129 "List the files in C<directory> (relative to the root directory, there is no "
9130 "cwd) in the format of 'ls -la'."
9134 #: ../fish/guestfish-actions.pod:2615 ../src/guestfs-actions.pod:3838
9136 "This command is mostly useful for interactive sessions. It is I<not> "
9137 "intended that you try to parse the output string."
9141 #: ../fish/guestfish-actions.pod:2618
9146 #: ../fish/guestfish-actions.pod:2620
9149 " ln target linkname\n"
9154 #: ../fish/guestfish-actions.pod:2622 ../src/guestfs-actions.pod:3853
9155 msgid "This command creates a hard link using the C<ln> command."
9159 #: ../fish/guestfish-actions.pod:2624
9164 #: ../fish/guestfish-actions.pod:2626
9167 " ln-f target linkname\n"
9172 #: ../fish/guestfish-actions.pod:2628 ../src/guestfs-actions.pod:3866
9174 "This command creates a hard link using the C<ln -f> command. The I<-f> "
9175 "option removes the link (C<linkname>) if it exists already."
9179 #: ../fish/guestfish-actions.pod:2631
9184 #: ../fish/guestfish-actions.pod:2633
9187 " ln-s target linkname\n"
9192 #: ../fish/guestfish-actions.pod:2635 ../src/guestfs-actions.pod:3880
9193 msgid "This command creates a symbolic link using the C<ln -s> command."
9197 #: ../fish/guestfish-actions.pod:2637
9202 #: ../fish/guestfish-actions.pod:2639
9205 " ln-sf target linkname\n"
9210 #: ../fish/guestfish-actions.pod:2641 ../src/guestfs-actions.pod:3893
9212 "This command creates a symbolic link using the C<ln -sf> command, The I<-f> "
9213 "option removes the link (C<linkname>) if it exists already."
9217 #: ../fish/guestfish-actions.pod:2644
9218 msgid "lremovexattr"
9222 #: ../fish/guestfish-actions.pod:2646
9225 " lremovexattr xattr path\n"
9230 #: ../fish/guestfish-actions.pod:2648
9232 "This is the same as L</removexattr>, but if C<path> is a symbolic link, then "
9233 "it removes an extended attribute of the link itself."
9237 #: ../fish/guestfish-actions.pod:2652
9242 #: ../fish/guestfish-actions.pod:2654
9250 #: ../fish/guestfish-actions.pod:2656 ../src/guestfs-actions.pod:3921
9252 "List the files in C<directory> (relative to the root directory, there is no "
9253 "cwd). The '.' and '..' entries are not returned, but hidden files are "
9258 #: ../fish/guestfish-actions.pod:2660
9260 "This command is mostly useful for interactive sessions. Programs should "
9261 "probably use L</readdir> instead."
9265 #: ../fish/guestfish-actions.pod:2663
9270 #: ../fish/guestfish-actions.pod:2665
9273 " lsetxattr xattr val vallen path\n"
9278 #: ../fish/guestfish-actions.pod:2667
9280 "This is the same as L</setxattr>, but if C<path> is a symbolic link, then it "
9281 "sets an extended attribute of the link itself."
9285 #: ../fish/guestfish-actions.pod:2671
9290 #: ../fish/guestfish-actions.pod:2673
9298 #: ../fish/guestfish-actions.pod:2675 ../fish/guestfish-actions.pod:4483 ../src/guestfs-actions.pod:3957 ../src/guestfs-actions.pod:6736
9299 msgid "Returns file information for the given C<path>."
9303 #: ../fish/guestfish-actions.pod:2677
9305 "This is the same as L</stat> except that if C<path> is a symbolic link, then "
9306 "the link is stat-ed, not the file it refers to."
9310 #: ../fish/guestfish-actions.pod:2681 ../src/guestfs-actions.pod:3963
9311 msgid "This is the same as the C<lstat(2)> system call."
9315 #: ../fish/guestfish-actions.pod:2683
9320 #: ../fish/guestfish-actions.pod:2685
9323 " lstatlist path 'names ...'\n"
9328 #: ../fish/guestfish-actions.pod:2687
9330 "This call allows you to perform the L</lstat> operation on multiple files, "
9331 "where all files are in the directory C<path>. C<names> is the list of files "
9332 "from this directory."
9336 #: ../fish/guestfish-actions.pod:2691 ../src/guestfs-actions.pod:3982
9338 "On return you get a list of stat structs, with a one-to-one correspondence "
9339 "to the C<names> list. If any name did not exist or could not be lstat'd, "
9340 "then the C<ino> field of that structure is set to C<-1>."
9344 #: ../fish/guestfish-actions.pod:2696
9346 "This call is intended for programs that want to efficiently list a directory "
9347 "contents without making many round-trips. See also L</lxattrlist> for a "
9348 "similarly efficient call for getting extended attributes. Very long "
9349 "directory listings might cause the protocol message size to be exceeded, "
9350 "causing this call to fail. The caller must split up such requests into "
9351 "smaller groups of names."
9355 #: ../fish/guestfish-actions.pod:2704
9356 msgid "luks-add-key"
9360 #: ../fish/guestfish-actions.pod:2706
9363 " luks-add-key device keyslot\n"
9368 #: ../fish/guestfish-actions.pod:2708 ../src/guestfs-actions.pod:4010
9370 "This command adds a new key on LUKS device C<device>. C<key> is any "
9371 "existing key, and is used to access the device. C<newkey> is the new key to "
9372 "add. C<keyslot> is the key slot that will be replaced."
9376 #: ../fish/guestfish-actions.pod:2713
9378 "Note that if C<keyslot> already contains a key, then this command will "
9379 "fail. You have to use L</luks-kill-slot> first to remove that key."
9383 #: ../fish/guestfish-actions.pod:2717 ../fish/guestfish-actions.pod:2739 ../fish/guestfish-actions.pod:2752 ../fish/guestfish-actions.pod:2766 ../fish/guestfish-actions.pod:2792 ../fish/guestfish-actions.pod:2802
9385 "This command has one or more key or passphrase parameters. Guestfish will "
9386 "prompt for these separately."
9390 #: ../fish/guestfish-actions.pod:2720
9395 #: ../fish/guestfish-actions.pod:2722
9398 " luks-close device\n"
9403 #: ../fish/guestfish-actions.pod:2724
9405 "This closes a LUKS device that was created earlier by L</luks-open> or "
9406 "L</luks-open-ro>. The C<device> parameter must be the name of the LUKS "
9407 "mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
9408 "underlying block device."
9412 #: ../fish/guestfish-actions.pod:2730
9417 #: ../fish/guestfish-actions.pod:2732
9420 " luks-format device keyslot\n"
9425 #: ../fish/guestfish-actions.pod:2734 ../src/guestfs-actions.pod:4051
9427 "This command erases existing data on C<device> and formats the device as a "
9428 "LUKS encrypted device. C<key> is the initial key, which is added to key "
9429 "slot C<slot>. (LUKS supports 8 key slots, numbered 0-7)."
9433 #: ../fish/guestfish-actions.pod:2742 ../fish/guestfish-actions.pod:2755 ../fish/guestfish-actions.pod:2842 ../fish/guestfish-actions.pod:3503 ../fish/guestfish-actions.pod:4029 ../fish/guestfish-actions.pod:4354 ../fish/guestfish-actions.pod:4377 ../fish/guestfish-actions.pod:4399 ../fish/guestfish-actions.pod:5137 ../src/guestfs-actions.pod:4058 ../src/guestfs-actions.pod:4081 ../src/guestfs-actions.pod:4224 ../src/guestfs-actions.pod:5327 ../src/guestfs-actions.pod:6115 ../src/guestfs-actions.pod:6543 ../src/guestfs-actions.pod:6573 ../src/guestfs-actions.pod:6606 ../src/guestfs-actions.pod:7804
9435 "B<This command is dangerous. Without careful use you can easily destroy all "
9440 #: ../fish/guestfish-actions.pod:2745
9441 msgid "luks-format-cipher"
9445 #: ../fish/guestfish-actions.pod:2747
9448 " luks-format-cipher device keyslot cipher\n"
9453 #: ../fish/guestfish-actions.pod:2749
9455 "This command is the same as L</luks-format> but it also allows you to set "
9456 "the C<cipher> used."
9460 #: ../fish/guestfish-actions.pod:2758
9461 msgid "luks-kill-slot"
9465 #: ../fish/guestfish-actions.pod:2760
9468 " luks-kill-slot device keyslot\n"
9473 #: ../fish/guestfish-actions.pod:2762 ../src/guestfs-actions.pod:4098
9475 "This command deletes the key in key slot C<keyslot> from the encrypted LUKS "
9476 "device C<device>. C<key> must be one of the I<other> keys."
9480 #: ../fish/guestfish-actions.pod:2769
9485 #: ../fish/guestfish-actions.pod:2771
9488 " luks-open device mapname\n"
9493 #: ../fish/guestfish-actions.pod:2773 ../src/guestfs-actions.pod:4118
9495 "This command opens a block device which has been encrypted according to the "
9496 "Linux Unified Key Setup (LUKS) standard."
9500 #: ../fish/guestfish-actions.pod:2776 ../src/guestfs-actions.pod:4121
9501 msgid "C<device> is the encrypted block device or partition."
9505 #: ../fish/guestfish-actions.pod:2778 ../src/guestfs-actions.pod:4123
9507 "The caller must supply one of the keys associated with the LUKS block "
9508 "device, in the C<key> parameter."
9512 #: ../fish/guestfish-actions.pod:2781 ../src/guestfs-actions.pod:4126
9514 "This creates a new block device called C</dev/mapper/mapname>. Reads and "
9515 "writes to this block device are decrypted from and encrypted to the "
9516 "underlying C<device> respectively."
9520 #: ../fish/guestfish-actions.pod:2785
9522 "If this block device contains LVM volume groups, then calling L</vgscan> "
9523 "followed by L</vg-activate-all> will make them visible."
9527 #: ../fish/guestfish-actions.pod:2789
9528 msgid "Use L</list-dm-devices> to list all device mapper devices."
9532 #: ../fish/guestfish-actions.pod:2795
9533 msgid "luks-open-ro"
9537 #: ../fish/guestfish-actions.pod:2797
9540 " luks-open-ro device mapname\n"
9545 #: ../fish/guestfish-actions.pod:2799
9547 "This is the same as L</luks-open> except that a read-only mapping is "
9552 #: ../fish/guestfish-actions.pod:2805
9557 #: ../fish/guestfish-actions.pod:2807
9560 " lvcreate logvol volgroup mbytes\n"
9565 #: ../fish/guestfish-actions.pod:2809 ../src/guestfs-actions.pod:4172
9567 "This creates an LVM logical volume called C<logvol> on the volume group "
9568 "C<volgroup>, with C<size> megabytes."
9572 #: ../fish/guestfish-actions.pod:2812
9573 msgid "lvm-canonical-lv-name"
9577 #: ../fish/guestfish-actions.pod:2814
9580 " lvm-canonical-lv-name lvname\n"
9585 #: ../fish/guestfish-actions.pod:2816 ../src/guestfs-actions.pod:4185
9587 "This converts alternative naming schemes for LVs that you might find to the "
9588 "canonical name. For example, C</dev/mapper/VG-LV> is converted to "
9593 #: ../fish/guestfish-actions.pod:2820 ../src/guestfs-actions.pod:4189
9595 "This command returns an error if the C<lvname> parameter does not refer to a "
9600 #: ../fish/guestfish-actions.pod:2823
9601 msgid "See also L</is-lv>."
9605 #: ../fish/guestfish-actions.pod:2825
9606 msgid "lvm-clear-filter"
9610 #: ../fish/guestfish-actions.pod:2827
9613 " lvm-clear-filter\n"
9618 #: ../fish/guestfish-actions.pod:2829
9620 "This undoes the effect of L</lvm-set-filter>. LVM will be able to see every "
9625 #: ../fish/guestfish-actions.pod:2832 ../fish/guestfish-actions.pod:2863 ../src/guestfs-actions.pod:4207 ../src/guestfs-actions.pod:4249
9626 msgid "This command also clears the LVM cache and performs a volume group scan."
9630 #: ../fish/guestfish-actions.pod:2835
9631 msgid "lvm-remove-all"
9635 #: ../fish/guestfish-actions.pod:2837
9643 #: ../fish/guestfish-actions.pod:2839 ../src/guestfs-actions.pod:4219
9645 "This command removes all LVM logical volumes, volume groups and physical "
9650 #: ../fish/guestfish-actions.pod:2845
9651 msgid "lvm-set-filter"
9655 #: ../fish/guestfish-actions.pod:2847
9658 " lvm-set-filter 'devices ...'\n"
9663 #: ../fish/guestfish-actions.pod:2849 ../src/guestfs-actions.pod:4235
9665 "This sets the LVM device filter so that LVM will only be able to \"see\" the "
9666 "block devices in the list C<devices>, and will ignore all other attached "
9671 #: ../fish/guestfish-actions.pod:2853 ../src/guestfs-actions.pod:4239
9673 "Where disk image(s) contain duplicate PVs or VGs, this command is useful to "
9674 "get LVM to ignore the duplicates, otherwise LVM can get confused. Note also "
9675 "there are two types of duplication possible: either cloned PVs/VGs which "
9676 "have identical UUIDs; or VGs that are not cloned but just happen to have the "
9677 "same name. In normal operation you cannot create this situation, but you "
9678 "can do it outside LVM, eg. by cloning disk images or by bit twiddling "
9679 "inside the LVM metadata."
9683 #: ../fish/guestfish-actions.pod:2866 ../src/guestfs-actions.pod:4252
9684 msgid "You can filter whole block devices or individual partitions."
9688 #: ../fish/guestfish-actions.pod:2868 ../src/guestfs-actions.pod:4254
9690 "You cannot use this if any VG is currently in use (eg. contains a mounted "
9691 "filesystem), even if you are not filtering out that VG."
9695 #: ../fish/guestfish-actions.pod:2872
9700 #: ../fish/guestfish-actions.pod:2874
9703 " lvremove device\n"
9708 #: ../fish/guestfish-actions.pod:2876 ../src/guestfs-actions.pod:4268
9710 "Remove an LVM logical volume C<device>, where C<device> is the path to the "
9711 "LV, such as C</dev/VG/LV>."
9715 #: ../fish/guestfish-actions.pod:2879 ../src/guestfs-actions.pod:4271
9717 "You can also remove all LVs in a volume group by specifying the VG name, "
9722 #: ../fish/guestfish-actions.pod:2882
9727 #: ../fish/guestfish-actions.pod:2884
9730 " lvrename logvol newlogvol\n"
9735 #: ../fish/guestfish-actions.pod:2886 ../src/guestfs-actions.pod:4285
9736 msgid "Rename a logical volume C<logvol> with the new name C<newlogvol>."
9740 #: ../fish/guestfish-actions.pod:2888
9745 #: ../fish/guestfish-actions.pod:2890
9748 " lvresize device mbytes\n"
9753 #: ../fish/guestfish-actions.pod:2892 ../src/guestfs-actions.pod:4298
9755 "This resizes (expands or shrinks) an existing LVM logical volume to "
9756 "C<mbytes>. When reducing, data in the reduced part is lost."
9760 #: ../fish/guestfish-actions.pod:2896
9761 msgid "lvresize-free"
9765 #: ../fish/guestfish-actions.pod:2898
9768 " lvresize-free lv percent\n"
9773 #: ../fish/guestfish-actions.pod:2900 ../src/guestfs-actions.pod:4313
9775 "This expands an existing logical volume C<lv> so that it fills C<pc>% of the "
9776 "remaining free space in the volume group. Commonly you would call this with "
9777 "pc = 100 which expands the logical volume as much as possible, using all "
9778 "remaining free space in the volume group."
9782 #: ../fish/guestfish-actions.pod:2906
9787 #: ../fish/guestfish-actions.pod:2908
9795 #: ../fish/guestfish-actions.pod:2910 ../src/guestfs-actions.pod:4328
9797 "List all the logical volumes detected. This is the equivalent of the "
9798 "L<lvs(8)> command."
9802 #: ../fish/guestfish-actions.pod:2913 ../src/guestfs-actions.pod:4331
9804 "This returns a list of the logical volume device names "
9805 "(eg. C</dev/VolGroup00/LogVol00>)."
9809 #: ../fish/guestfish-actions.pod:2916
9810 msgid "See also L</lvs-full>, L</list-filesystems>."
9814 #: ../fish/guestfish-actions.pod:2918
9819 #: ../fish/guestfish-actions.pod:2920
9827 #: ../fish/guestfish-actions.pod:2922 ../src/guestfs-actions.pod:4347
9829 "List all the logical volumes detected. This is the equivalent of the "
9830 "L<lvs(8)> command. The \"full\" version includes all fields."
9834 #: ../fish/guestfish-actions.pod:2925
9839 #: ../fish/guestfish-actions.pod:2927
9847 #: ../fish/guestfish-actions.pod:2929 ../src/guestfs-actions.pod:4362
9848 msgid "This command returns the UUID of the LVM LV C<device>."
9852 #: ../fish/guestfish-actions.pod:2931
9857 #: ../fish/guestfish-actions.pod:2933
9860 " lxattrlist path 'names ...'\n"
9865 #: ../fish/guestfish-actions.pod:2935 ../src/guestfs-actions.pod:4376
9867 "This call allows you to get the extended attributes of multiple files, where "
9868 "all files are in the directory C<path>. C<names> is the list of files from "
9873 #: ../fish/guestfish-actions.pod:2939 ../src/guestfs-actions.pod:4380
9875 "On return you get a flat list of xattr structs which must be interpreted "
9876 "sequentially. The first xattr struct always has a zero-length C<attrname>. "
9877 "C<attrval> in this struct is zero-length to indicate there was an error "
9878 "doing C<lgetxattr> for this file, I<or> is a C string which is a decimal "
9879 "number (the number of following attributes for this file, which could be "
9880 "C<\"0\">). Then after the first xattr struct are the zero or more "
9881 "attributes for the first named file. This repeats for the second and "
9886 #: ../fish/guestfish-actions.pod:2949
9888 "This call is intended for programs that want to efficiently list a directory "
9889 "contents without making many round-trips. See also L</lstatlist> for a "
9890 "similarly efficient call for getting standard stats. Very long directory "
9891 "listings might cause the protocol message size to be exceeded, causing this "
9892 "call to fail. The caller must split up such requests into smaller groups of "
9897 #: ../fish/guestfish-actions.pod:2957
9902 #: ../fish/guestfish-actions.pod:2959
9910 #: ../fish/guestfish-actions.pod:2961 ../src/guestfs-actions.pod:4410
9911 msgid "Create a directory named C<path>."
9915 #: ../fish/guestfish-actions.pod:2963
9920 #: ../fish/guestfish-actions.pod:2965
9923 " mkdir-mode path mode\n"
9928 #: ../fish/guestfish-actions.pod:2967 ../src/guestfs-actions.pod:4423
9930 "This command creates a directory, setting the initial permissions of the "
9931 "directory to C<mode>."
9935 #: ../fish/guestfish-actions.pod:2970 ../src/guestfs-actions.pod:4426
9937 "For common Linux filesystems, the actual mode which is set will be C<mode & "
9938 "~umask & 01777>. Non-native-Linux filesystems may interpret the mode in "
9943 #: ../fish/guestfish-actions.pod:2974
9944 msgid "See also L</mkdir>, L</umask>"
9948 #: ../fish/guestfish-actions.pod:2976
9953 #: ../fish/guestfish-actions.pod:2978
9961 #: ../fish/guestfish-actions.pod:2980 ../src/guestfs-actions.pod:4442
9963 "Create a directory named C<path>, creating any parent directories as "
9964 "necessary. This is like the C<mkdir -p> shell command."
9968 #: ../fish/guestfish-actions.pod:2983
9973 #: ../fish/guestfish-actions.pod:2985
9976 " mkdtemp template\n"
9981 #: ../fish/guestfish-actions.pod:2987 ../src/guestfs-actions.pod:4455
9983 "This command creates a temporary directory. The C<template> parameter "
9984 "should be a full pathname for the temporary directory name with the final "
9985 "six characters being \"XXXXXX\"."
9989 #: ../fish/guestfish-actions.pod:2992 ../src/guestfs-actions.pod:4460
9991 "For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\", the second one "
9992 "being suitable for Windows filesystems."
9996 #: ../fish/guestfish-actions.pod:2995 ../src/guestfs-actions.pod:4463
9997 msgid "The name of the temporary directory that was created is returned."
10001 #: ../fish/guestfish-actions.pod:2998 ../src/guestfs-actions.pod:4466
10002 msgid "The temporary directory is created with mode 0700 and is owned by root."
10006 #: ../fish/guestfish-actions.pod:3001 ../src/guestfs-actions.pod:4469
10008 "The caller is responsible for deleting the temporary directory and its "
10009 "contents after use."
10013 #: ../fish/guestfish-actions.pod:3004 ../src/guestfs-actions.pod:4472
10014 msgid "See also: L<mkdtemp(3)>"
10018 #: ../fish/guestfish-actions.pod:3006
10023 #: ../fish/guestfish-actions.pod:3008
10026 " mke2fs-J fstype blocksize device journal\n"
10031 #: ../fish/guestfish-actions.pod:3010 ../src/guestfs-actions.pod:4488
10033 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10034 "C<journal>. It is equivalent to the command:"
10038 #: ../fish/guestfish-actions.pod:3014 ../src/guestfs-actions.pod:4492
10041 " mke2fs -t fstype -b blocksize -J device=<journal> <device>\n"
10046 #: ../fish/guestfish-actions.pod:3016
10047 msgid "See also L</mke2journal>."
10051 #: ../fish/guestfish-actions.pod:3018
10056 #: ../fish/guestfish-actions.pod:3020
10059 " mke2fs-JL fstype blocksize device label\n"
10064 #: ../fish/guestfish-actions.pod:3022 ../src/guestfs-actions.pod:4509
10066 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10067 "the journal labeled C<label>."
10071 #: ../fish/guestfish-actions.pod:3025
10072 msgid "See also L</mke2journal-L>."
10076 #: ../fish/guestfish-actions.pod:3027
10081 #: ../fish/guestfish-actions.pod:3029
10084 " mke2fs-JU fstype blocksize device uuid\n"
10089 #: ../fish/guestfish-actions.pod:3031 ../src/guestfs-actions.pod:4527
10091 "This creates an ext2/3/4 filesystem on C<device> with an external journal on "
10092 "the journal with UUID C<uuid>."
10096 #: ../fish/guestfish-actions.pod:3034
10097 msgid "See also L</mke2journal-U>."
10101 #: ../fish/guestfish-actions.pod:3036
10102 msgid "mke2journal"
10106 #: ../fish/guestfish-actions.pod:3038
10109 " mke2journal blocksize device\n"
10114 #: ../fish/guestfish-actions.pod:3040 ../src/guestfs-actions.pod:4543
10116 "This creates an ext2 external journal on C<device>. It is equivalent to the "
10121 #: ../fish/guestfish-actions.pod:3043 ../src/guestfs-actions.pod:4546
10124 " mke2fs -O journal_dev -b blocksize device\n"
10129 #: ../fish/guestfish-actions.pod:3045
10130 msgid "mke2journal-L"
10134 #: ../fish/guestfish-actions.pod:3047
10137 " mke2journal-L blocksize label device\n"
10142 #: ../fish/guestfish-actions.pod:3049 ../src/guestfs-actions.pod:4560
10143 msgid "This creates an ext2 external journal on C<device> with label C<label>."
10147 #: ../fish/guestfish-actions.pod:3051
10148 msgid "mke2journal-U"
10152 #: ../fish/guestfish-actions.pod:3053
10155 " mke2journal-U blocksize uuid device\n"
10160 #: ../fish/guestfish-actions.pod:3055 ../src/guestfs-actions.pod:4574
10161 msgid "This creates an ext2 external journal on C<device> with UUID C<uuid>."
10165 #: ../fish/guestfish-actions.pod:3057
10170 #: ../fish/guestfish-actions.pod:3059
10173 " mkfifo mode path\n"
10178 #: ../fish/guestfish-actions.pod:3061
10180 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
10181 "is just a convenient wrapper around L</mknod>."
10185 #: ../fish/guestfish-actions.pod:3067
10190 #: ../fish/guestfish-actions.pod:3069
10193 " mkfs fstype device\n"
10198 #: ../fish/guestfish-actions.pod:3071 ../src/guestfs-actions.pod:4604
10200 "This creates a filesystem on C<device> (usually a partition or LVM logical "
10201 "volume). The filesystem type is C<fstype>, for example C<ext3>."
10205 #: ../fish/guestfish-actions.pod:3075
10210 #: ../fish/guestfish-actions.pod:3077
10213 " mkfs-b fstype blocksize device\n"
10218 #: ../fish/guestfish-actions.pod:3079
10220 "This call is similar to L</mkfs>, but it allows you to control the block "
10221 "size of the resulting filesystem. Supported block sizes depend on the "
10222 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
10226 #: ../fish/guestfish-actions.pod:3084 ../fish/guestfish-actions.pod:3111 ../src/guestfs-actions.pod:4625 ../src/guestfs-actions.pod:4670
10228 "For VFAT and NTFS the C<blocksize> parameter is treated as the requested "
10233 #: ../fish/guestfish-actions.pod:3087
10235 "This function is deprecated. In new code, use the L</mkfs_opts> call "
10240 #: ../fish/guestfish-actions.pod:3094
10245 #: ../fish/guestfish-actions.pod:3096
10248 " mkfs-opts fstype device [blocksize:..] [features:..] [inode:..] "
10249 "[sectorsize:..]\n"
10254 #: ../fish/guestfish-actions.pod:3098 ../src/guestfs-actions.pod:4657
10256 "This function creates a filesystem on C<device>. The filesystem type is "
10257 "C<fstype>, for example C<ext3>."
10261 #: ../fish/guestfish-actions.pod:3105 ../src/guestfs-actions.pod:4664
10262 msgid "C<blocksize>"
10266 #: ../fish/guestfish-actions.pod:3107 ../src/guestfs-actions.pod:4666
10268 "The filesystem block size. Supported block sizes depend on the filesystem "
10269 "type, but typically they are C<1024>, C<2048> or C<4096> for Linux ext2/3 "
10274 #: ../fish/guestfish-actions.pod:3114 ../src/guestfs-actions.pod:4673
10275 msgid "For UFS block sizes, please see L<mkfs.ufs(8)>."
10279 #: ../fish/guestfish-actions.pod:3116 ../src/guestfs-actions.pod:4675
10280 msgid "C<features>"
10284 #: ../fish/guestfish-actions.pod:3118 ../src/guestfs-actions.pod:4677
10285 msgid "This passes the I<-O> parameter to the external mkfs program."
10289 #: ../fish/guestfish-actions.pod:3120 ../src/guestfs-actions.pod:4679
10291 "For certain filesystem types, this allows extra filesystem features to be "
10292 "selected. See L<mke2fs(8)> and L<mkfs.ufs(8)> for more details."
10296 #: ../fish/guestfish-actions.pod:3124 ../src/guestfs-actions.pod:4683
10298 "You cannot use this optional parameter with the C<gfs> or C<gfs2> filesystem "
10303 #: ../fish/guestfish-actions.pod:3127 ../src/guestfs-actions.pod:4686
10308 #: ../fish/guestfish-actions.pod:3129 ../src/guestfs-actions.pod:4688
10310 "This passes the I<-I> parameter to the external L<mke2fs(8)> program which "
10311 "sets the inode size (only for ext2/3/4 filesystems at present)."
10315 #: ../fish/guestfish-actions.pod:3132 ../src/guestfs-actions.pod:4691
10316 msgid "C<sectorsize>"
10320 #: ../fish/guestfish-actions.pod:3134 ../src/guestfs-actions.pod:4693
10322 "This passes the I<-S> parameter to external L<mkfs.ufs(8)> program, which "
10323 "sets sector size for ufs filesystem."
10327 #: ../fish/guestfish-actions.pod:3141
10328 msgid "mkmountpoint"
10332 #: ../fish/guestfish-actions.pod:3143
10335 " mkmountpoint exemptpath\n"
10340 #: ../fish/guestfish-actions.pod:3145
10342 "L</mkmountpoint> and L</rmmountpoint> are specialized calls that can be used "
10343 "to create extra mountpoints before mounting the first filesystem."
10347 #: ../fish/guestfish-actions.pod:3149 ../src/guestfs-actions.pod:4736
10349 "These calls are I<only> necessary in some very limited circumstances, mainly "
10350 "the case where you want to mount a mix of unrelated and/or read-only "
10351 "filesystems together."
10355 #: ../fish/guestfish-actions.pod:3153 ../src/guestfs-actions.pod:4740
10357 "For example, live CDs often contain a \"Russian doll\" nest of filesystems, "
10358 "an ISO outer layer, with a squashfs image inside, with an ext2/3 image "
10359 "inside that. You can unpack this as follows in guestfish:"
10363 #: ../fish/guestfish-actions.pod:3158 ../src/guestfs-actions.pod:4745
10366 " add-ro Fedora-11-i686-Live.iso\n"
10368 " mkmountpoint /cd\n"
10369 " mkmountpoint /sqsh\n"
10370 " mkmountpoint /ext3fs\n"
10371 " mount /dev/sda /cd\n"
10372 " mount-loop /cd/LiveOS/squashfs.img /sqsh\n"
10373 " mount-loop /sqsh/LiveOS/ext3fs.img /ext3fs\n"
10378 #: ../fish/guestfish-actions.pod:3167 ../src/guestfs-actions.pod:4754
10379 msgid "The inner filesystem is now unpacked under the /ext3fs mountpoint."
10383 #: ../fish/guestfish-actions.pod:3169
10385 "L</mkmountpoint> is not compatible with L</umount-all>. You may get "
10386 "unexpected errors if you try to mix these calls. It is safest to manually "
10387 "unmount filesystems and remove mountpoints after use."
10391 #: ../fish/guestfish-actions.pod:3173
10393 "L</umount-all> unmounts filesystems by sorting the paths longest first, so "
10394 "for this to work for manual mountpoints, you must ensure that the innermost "
10395 "mountpoints have the longest pathnames, as in the example code above."
10399 #: ../fish/guestfish-actions.pod:3178 ../src/guestfs-actions.pod:4765
10400 msgid "For more details see L<https://bugzilla.redhat.com/show_bug.cgi?id=599503>"
10404 #: ../fish/guestfish-actions.pod:3180
10406 "Autosync [see L</set-autosync>, this is set by default on handles] can cause "
10407 "L</umount-all> to be called when the handle is closed which can also trigger "
10412 #: ../fish/guestfish-actions.pod:3184
10417 #: ../fish/guestfish-actions.pod:3186
10420 " mknod mode devmajor devminor path\n"
10425 #: ../fish/guestfish-actions.pod:3188 ../src/guestfs-actions.pod:4784
10427 "This call creates block or character special devices, or named pipes "
10432 #: ../fish/guestfish-actions.pod:3191 ../src/guestfs-actions.pod:4787
10434 "The C<mode> parameter should be the mode, using the standard constants. "
10435 "C<devmajor> and C<devminor> are the device major and minor numbers, only "
10436 "used when creating block and character special devices."
10440 #: ../fish/guestfish-actions.pod:3196
10442 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
10443 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
10444 "regular file). These constants are available in the standard Linux header "
10445 "files, or you can use L</mknod-b>, L</mknod-c> or L</mkfifo> which are "
10446 "wrappers around this command which bitwise OR in the appropriate constant "
10451 #: ../fish/guestfish-actions.pod:3206
10456 #: ../fish/guestfish-actions.pod:3208
10459 " mknod-b mode devmajor devminor path\n"
10464 #: ../fish/guestfish-actions.pod:3210
10466 "This call creates a block device node called C<path> with mode C<mode> and "
10467 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10468 "wrapper around L</mknod>."
10472 #: ../fish/guestfish-actions.pod:3216
10477 #: ../fish/guestfish-actions.pod:3218
10480 " mknod-c mode devmajor devminor path\n"
10485 #: ../fish/guestfish-actions.pod:3220
10487 "This call creates a char device node called C<path> with mode C<mode> and "
10488 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
10489 "wrapper around L</mknod>."
10493 #: ../fish/guestfish-actions.pod:3226
10498 #: ../fish/guestfish-actions.pod:3228
10506 #: ../fish/guestfish-actions.pod:3230 ../src/guestfs-actions.pod:4850
10507 msgid "Create a swap partition on C<device>."
10511 #: ../fish/guestfish-actions.pod:3232
10516 #: ../fish/guestfish-actions.pod:3234
10519 " mkswap-L label device\n"
10524 #: ../fish/guestfish-actions.pod:3236 ../src/guestfs-actions.pod:4863
10525 msgid "Create a swap partition on C<device> with label C<label>."
10529 #: ../fish/guestfish-actions.pod:3238 ../src/guestfs-actions.pod:4865
10531 "Note that you cannot attach a swap label to a block device "
10532 "(eg. C</dev/sda>), just to a partition. This appears to be a limitation of "
10533 "the kernel or swap tools."
10537 #: ../fish/guestfish-actions.pod:3242
10542 #: ../fish/guestfish-actions.pod:3244
10545 " mkswap-U uuid device\n"
10550 #: ../fish/guestfish-actions.pod:3246 ../src/guestfs-actions.pod:4880
10551 msgid "Create a swap partition on C<device> with UUID C<uuid>."
10555 #: ../fish/guestfish-actions.pod:3248
10556 msgid "mkswap-file"
10560 #: ../fish/guestfish-actions.pod:3250
10563 " mkswap-file path\n"
10568 #: ../fish/guestfish-actions.pod:3252 ../src/guestfs-actions.pod:4892
10569 msgid "Create a swap file."
10573 #: ../fish/guestfish-actions.pod:3254
10575 "This command just writes a swap file signature to an existing file. To "
10576 "create the file itself, use something like L</fallocate>."
10580 #: ../fish/guestfish-actions.pod:3257
10585 #: ../fish/guestfish-actions.pod:3259
10588 " modprobe modulename\n"
10593 #: ../fish/guestfish-actions.pod:3261 ../src/guestfs-actions.pod:4907
10594 msgid "This loads a kernel module in the appliance."
10598 #: ../fish/guestfish-actions.pod:3263 ../src/guestfs-actions.pod:4909
10600 "The kernel module must have been whitelisted when libguestfs was built (see "
10601 "C<appliance/kmod.whitelist.in> in the source)."
10605 #: ../fish/guestfish-actions.pod:3266
10610 #: ../fish/guestfish-actions.pod:3268
10613 " mount device mountpoint\n"
10618 #: ../fish/guestfish-actions.pod:3270 ../src/guestfs-actions.pod:4923
10620 "Mount a guest disk at a position in the filesystem. Block devices are named "
10621 "C</dev/sda>, C</dev/sdb> and so on, as they were added to the guest. If "
10622 "those block devices contain partitions, they will have the usual names "
10623 "(eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style names can be used."
10627 #: ../fish/guestfish-actions.pod:3276 ../src/guestfs-actions.pod:4929
10629 "The rules are the same as for L<mount(2)>: A filesystem must first be "
10630 "mounted on C</> before others can be mounted. Other filesystems can only be "
10631 "mounted on directories which already exist."
10635 #: ../fish/guestfish-actions.pod:3281 ../src/guestfs-actions.pod:4934
10637 "The mounted filesystem is writable, if we have sufficient permissions on the "
10638 "underlying device."
10642 #: ../fish/guestfish-actions.pod:3284
10644 "B<Important note:> When you use this call, the filesystem options C<sync> "
10645 "and C<noatime> are set implicitly. This was originally done because we "
10646 "thought it would improve reliability, but it turns out that I<-o sync> has a "
10647 "very large negative performance impact and negligible effect on "
10648 "reliability. Therefore we recommend that you avoid using L</mount> in any "
10649 "code that needs performance, and instead use L</mount-options> (use an empty "
10650 "string for the first parameter if you don't want any options)."
10654 #: ../fish/guestfish-actions.pod:3294
10656 "This function is deprecated. In new code, use the L</mount_options> call "
10661 #: ../fish/guestfish-actions.pod:3301
10666 #: ../fish/guestfish-actions.pod:3303
10669 " mount-9p mounttag mountpoint [options:..]\n"
10674 #: ../fish/guestfish-actions.pod:3305 ../src/guestfs-actions.pod:4973
10676 "Mount the virtio-9p filesystem with the tag C<mounttag> on the directory "
10681 #: ../fish/guestfish-actions.pod:3308 ../src/guestfs-actions.pod:4976
10683 "If required, C<trans=virtio> will be automatically added to the options. "
10684 "Any other options required can be passed in the optional C<options> "
10689 #: ../fish/guestfish-actions.pod:3314
10694 #: ../fish/guestfish-actions.pod:3316
10697 " mount-loop file mountpoint\n"
10702 #: ../fish/guestfish-actions.pod:3318 ../src/guestfs-actions.pod:5015
10704 "This command lets you mount C<file> (a filesystem image in a file) on a "
10705 "mount point. It is entirely equivalent to the command C<mount -o loop file "
10710 #: ../fish/guestfish-actions.pod:3322
10711 msgid "mount-options"
10715 #: ../fish/guestfish-actions.pod:3324
10718 " mount-options options device mountpoint\n"
10723 #: ../fish/guestfish-actions.pod:3326
10725 "This is the same as the L</mount> command, but it allows you to set the "
10726 "mount options as for the L<mount(8)> I<-o> flag."
10730 #: ../fish/guestfish-actions.pod:3330 ../src/guestfs-actions.pod:5035
10732 "If the C<options> parameter is an empty string, then no options are passed "
10733 "(all options default to whatever the filesystem uses)."
10737 #: ../fish/guestfish-actions.pod:3334
10742 #: ../fish/guestfish-actions.pod:3336
10745 " mount-ro device mountpoint\n"
10750 #: ../fish/guestfish-actions.pod:3338
10752 "This is the same as the L</mount> command, but it mounts the filesystem with "
10753 "the read-only (I<-o ro>) flag."
10757 #: ../fish/guestfish-actions.pod:3341
10762 #: ../fish/guestfish-actions.pod:3343
10765 " mount-vfs options vfstype device mountpoint\n"
10770 #: ../fish/guestfish-actions.pod:3345
10772 "This is the same as the L</mount> command, but it allows you to set both the "
10773 "mount options and the vfstype as for the L<mount(8)> I<-o> and I<-t> flags."
10777 #: ../fish/guestfish-actions.pod:3349
10778 msgid "mountpoints"
10782 #: ../fish/guestfish-actions.pod:3351
10790 #: ../fish/guestfish-actions.pod:3353
10792 "This call is similar to L</mounts>. That call returns a list of devices. "
10793 "This one returns a hash table (map) of device name to directory where the "
10794 "device is mounted."
10798 #: ../fish/guestfish-actions.pod:3357
10803 #: ../fish/guestfish-actions.pod:3359
10811 #: ../fish/guestfish-actions.pod:3361 ../src/guestfs-actions.pod:5096
10813 "This returns the list of currently mounted filesystems. It returns the list "
10814 "of devices (eg. C</dev/sda1>, C</dev/VG/LV>)."
10818 #: ../fish/guestfish-actions.pod:3364 ../src/guestfs-actions.pod:5099
10819 msgid "Some internal mounts are not shown."
10823 #: ../fish/guestfish-actions.pod:3366
10824 msgid "See also: L</mountpoints>"
10828 #: ../fish/guestfish-actions.pod:3368
10833 #: ../fish/guestfish-actions.pod:3370
10841 #: ../fish/guestfish-actions.pod:3372 ../src/guestfs-actions.pod:5116
10843 "This moves a file from C<src> to C<dest> where C<dest> is either a "
10844 "destination filename or destination directory."
10848 #: ../fish/guestfish-actions.pod:3375
10849 msgid "ntfs-3g-probe"
10853 #: ../fish/guestfish-actions.pod:3377
10856 " ntfs-3g-probe true|false device\n"
10861 #: ../fish/guestfish-actions.pod:3379 ../src/guestfs-actions.pod:5130
10863 "This command runs the L<ntfs-3g.probe(8)> command which probes an NTFS "
10864 "C<device> for mountability. (Not all NTFS volumes can be mounted "
10865 "read-write, and some cannot be mounted at all)."
10869 #: ../fish/guestfish-actions.pod:3383 ../src/guestfs-actions.pod:5134
10871 "C<rw> is a boolean flag. Set it to true if you want to test if the volume "
10872 "can be mounted read-write. Set it to false if you want to test if the "
10873 "volume can be mounted read-only."
10877 #: ../fish/guestfish-actions.pod:3387 ../src/guestfs-actions.pod:5138
10879 "The return value is an integer which C<0> if the operation would succeed, or "
10880 "some non-zero value documented in the L<ntfs-3g.probe(8)> manual page."
10884 #: ../fish/guestfish-actions.pod:3391
10889 #: ../fish/guestfish-actions.pod:3393
10892 " ntfsresize device\n"
10897 #: ../fish/guestfish-actions.pod:3395 ../fish/guestfish-actions.pod:3419 ../src/guestfs-actions.pod:5152 ../src/guestfs-actions.pod:5191
10899 "This command resizes an NTFS filesystem, expanding or shrinking it to the "
10900 "size of the underlying device."
10904 #: ../fish/guestfish-actions.pod:3398 ../src/guestfs-actions.pod:5155
10906 "I<Note:> After the resize operation, the filesystem is marked as requiring a "
10907 "consistency check (for safety). You have to boot into Windows to perform "
10908 "this check and clear this condition. Furthermore, ntfsresize refuses to "
10909 "resize filesystems which have been marked in this way. So in effect it is "
10910 "not possible to call ntfsresize multiple times on a single filesystem "
10911 "without booting into Windows between each resize."
10915 #: ../fish/guestfish-actions.pod:3406 ../fish/guestfish-actions.pod:3445 ../src/guestfs-actions.pod:5163 ../src/guestfs-actions.pod:5217
10916 msgid "See also L<ntfsresize(8)>."
10920 #: ../fish/guestfish-actions.pod:3408 ../fish/guestfish-actions.pod:3456
10922 "This function is deprecated. In new code, use the L</ntfsresize_opts> call "
10927 #: ../fish/guestfish-actions.pod:3415
10928 msgid "ntfsresize-opts"
10932 #: ../fish/guestfish-actions.pod:3417
10935 " ntfsresize-opts device [size:..] [force:..]\n"
10940 #: ../fish/guestfish-actions.pod:3428 ../src/guestfs-actions.pod:5200
10942 "The new size (in bytes) of the filesystem. If omitted, the filesystem is "
10943 "resized to fit the container (eg. partition)."
10947 #: ../fish/guestfish-actions.pod:3431 ../src/guestfs-actions.pod:5203
10952 #: ../fish/guestfish-actions.pod:3433 ../src/guestfs-actions.pod:5205
10954 "If this option is true, then force the resize of the filesystem even if the "
10955 "filesystem is marked as requiring a consistency check."
10959 #: ../fish/guestfish-actions.pod:3436
10961 "After the resize operation, the filesystem is always marked as requiring a "
10962 "consistency check (for safety). You have to boot into Windows to perform "
10963 "this check and clear this condition. If you I<don't> set the C<force> "
10964 "option then it is not possible to call L</ntfsresize-opts> multiple times on "
10965 "a single filesystem without booting into Windows between each resize."
10969 #: ../fish/guestfish-actions.pod:3449
10970 msgid "ntfsresize-size"
10974 #: ../fish/guestfish-actions.pod:3451
10977 " ntfsresize-size device size\n"
10982 #: ../fish/guestfish-actions.pod:3453
10984 "This command is the same as L</ntfsresize> except that it allows you to "
10985 "specify the new size (in bytes) explicitly."
10989 #: ../fish/guestfish-actions.pod:3463
10994 #: ../fish/guestfish-actions.pod:3465
10997 " part-add device prlogex startsect endsect\n"
11002 #: ../fish/guestfish-actions.pod:3467
11004 "This command adds a partition to C<device>. If there is no partition table "
11005 "on the device, call L</part-init> first."
11009 #: ../fish/guestfish-actions.pod:3470 ../src/guestfs-actions.pod:5278
11011 "The C<prlogex> parameter is the type of partition. Normally you should pass "
11012 "C<p> or C<primary> here, but MBR partition tables also support C<l> (or "
11013 "C<logical>) and C<e> (or C<extended>) partition types."
11017 #: ../fish/guestfish-actions.pod:3475 ../src/guestfs-actions.pod:5283
11019 "C<startsect> and C<endsect> are the start and end of the partition in "
11020 "I<sectors>. C<endsect> may be negative, which means it counts backwards "
11021 "from the end of the disk (C<-1> is the last sector)."
11025 #: ../fish/guestfish-actions.pod:3479
11027 "Creating a partition which covers the whole disk is not so easy. Use "
11028 "L</part-disk> to do that."
11032 #: ../fish/guestfish-actions.pod:3482
11037 #: ../fish/guestfish-actions.pod:3484
11040 " part-del device partnum\n"
11045 #: ../fish/guestfish-actions.pod:3486 ../src/guestfs-actions.pod:5301
11046 msgid "This command deletes the partition numbered C<partnum> on C<device>."
11050 #: ../fish/guestfish-actions.pod:3488 ../src/guestfs-actions.pod:5303
11052 "Note that in the case of MBR partitioning, deleting an extended partition "
11053 "also deletes any logical partitions it contains."
11057 #: ../fish/guestfish-actions.pod:3492
11062 #: ../fish/guestfish-actions.pod:3494
11065 " part-disk device parttype\n"
11070 #: ../fish/guestfish-actions.pod:3496
11072 "This command is simply a combination of L</part-init> followed by "
11073 "L</part-add> to create a single primary partition covering the whole disk."
11077 #: ../fish/guestfish-actions.pod:3500
11079 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
11080 "possible values are described in L</part-init>."
11084 #: ../fish/guestfish-actions.pod:3506
11085 msgid "part-get-bootable"
11089 #: ../fish/guestfish-actions.pod:3508
11092 " part-get-bootable device partnum\n"
11097 #: ../fish/guestfish-actions.pod:3510 ../src/guestfs-actions.pod:5339
11099 "This command returns true if the partition C<partnum> on C<device> has the "
11100 "bootable flag set."
11104 #: ../fish/guestfish-actions.pod:3513
11105 msgid "See also L</part-set-bootable>."
11109 #: ../fish/guestfish-actions.pod:3515
11110 msgid "part-get-mbr-id"
11114 #: ../fish/guestfish-actions.pod:3517
11117 " part-get-mbr-id device partnum\n"
11122 #: ../fish/guestfish-actions.pod:3519 ../src/guestfs-actions.pod:5355
11124 "Returns the MBR type byte (also known as the ID byte) from the numbered "
11125 "partition C<partnum>."
11129 #: ../fish/guestfish-actions.pod:3522 ../fish/guestfish-actions.pod:3666
11131 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
11132 "undefined results for other partition table types (see "
11133 "L</part-get-parttype>)."
11137 #: ../fish/guestfish-actions.pod:3526
11138 msgid "part-get-parttype"
11142 #: ../fish/guestfish-actions.pod:3528
11145 " part-get-parttype device\n"
11150 #: ../fish/guestfish-actions.pod:3530 ../src/guestfs-actions.pod:5372
11152 "This command examines the partition table on C<device> and returns the "
11153 "partition table type (format) being used."
11157 #: ../fish/guestfish-actions.pod:3533
11159 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
11160 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
11161 "possible, although unusual. See L</part-init> for a full list."
11165 #: ../fish/guestfish-actions.pod:3538
11170 #: ../fish/guestfish-actions.pod:3540
11173 " part-init device parttype\n"
11178 #: ../fish/guestfish-actions.pod:3542 ../src/guestfs-actions.pod:5392
11180 "This creates an empty partition table on C<device> of one of the partition "
11181 "types listed below. Usually C<parttype> should be either C<msdos> or C<gpt> "
11182 "(for large disks)."
11186 #: ../fish/guestfish-actions.pod:3546
11188 "Initially there are no partitions. Following this, you should call "
11189 "L</part-add> for each partition required."
11193 #: ../fish/guestfish-actions.pod:3549 ../src/guestfs-actions.pod:5399
11194 msgid "Possible values for C<parttype> are:"
11198 #: ../fish/guestfish-actions.pod:3553 ../src/guestfs-actions.pod:5403
11203 #: ../fish/guestfish-actions.pod:3555 ../src/guestfs-actions.pod:5405
11208 #: ../fish/guestfish-actions.pod:3557 ../src/guestfs-actions.pod:5407
11209 msgid "Intel EFI / GPT partition table."
11213 #: ../fish/guestfish-actions.pod:3559 ../src/guestfs-actions.pod:5409
11215 "This is recommended for >= 2 TB partitions that will be accessed from Linux "
11216 "and Intel-based Mac OS X. It also has limited backwards compatibility with "
11217 "the C<mbr> format."
11221 #: ../fish/guestfish-actions.pod:3563 ../src/guestfs-actions.pod:5413
11226 #: ../fish/guestfish-actions.pod:3565 ../src/guestfs-actions.pod:5415
11231 #: ../fish/guestfish-actions.pod:3567 ../src/guestfs-actions.pod:5417
11233 "The standard PC \"Master Boot Record\" (MBR) format used by MS-DOS and "
11234 "Windows. This partition type will B<only> work for device sizes up to 2 "
11235 "TB. For large disks we recommend using C<gpt>."
11239 #: ../fish/guestfish-actions.pod:3574 ../src/guestfs-actions.pod:5424
11240 msgid "Other partition table types that may work but are not supported include:"
11244 #: ../fish/guestfish-actions.pod:3579 ../src/guestfs-actions.pod:5429
11249 #: ../fish/guestfish-actions.pod:3581 ../src/guestfs-actions.pod:5431
11250 msgid "AIX disk labels."
11254 #: ../fish/guestfish-actions.pod:3583 ../src/guestfs-actions.pod:5433
11259 #: ../fish/guestfish-actions.pod:3585 ../src/guestfs-actions.pod:5435
11264 #: ../fish/guestfish-actions.pod:3587 ../src/guestfs-actions.pod:5437
11265 msgid "Amiga \"Rigid Disk Block\" format."
11269 #: ../fish/guestfish-actions.pod:3589 ../src/guestfs-actions.pod:5439
11274 #: ../fish/guestfish-actions.pod:3591 ../src/guestfs-actions.pod:5441
11275 msgid "BSD disk labels."
11279 #: ../fish/guestfish-actions.pod:3593 ../src/guestfs-actions.pod:5443
11284 #: ../fish/guestfish-actions.pod:3595 ../src/guestfs-actions.pod:5445
11285 msgid "DASD, used on IBM mainframes."
11289 #: ../fish/guestfish-actions.pod:3597 ../src/guestfs-actions.pod:5447
11294 #: ../fish/guestfish-actions.pod:3599 ../src/guestfs-actions.pod:5449
11295 msgid "MIPS/SGI volumes."
11299 #: ../fish/guestfish-actions.pod:3601 ../src/guestfs-actions.pod:5451
11304 #: ../fish/guestfish-actions.pod:3603 ../src/guestfs-actions.pod:5453
11305 msgid "Old Mac partition format. Modern Macs use C<gpt>."
11309 #: ../fish/guestfish-actions.pod:3605 ../src/guestfs-actions.pod:5455
11314 #: ../fish/guestfish-actions.pod:3607 ../src/guestfs-actions.pod:5457
11315 msgid "NEC PC-98 format, common in Japan apparently."
11319 #: ../fish/guestfish-actions.pod:3609 ../src/guestfs-actions.pod:5459
11324 #: ../fish/guestfish-actions.pod:3611 ../src/guestfs-actions.pod:5461
11325 msgid "Sun disk labels."
11329 #: ../fish/guestfish-actions.pod:3615
11334 #: ../fish/guestfish-actions.pod:3617
11337 " part-list device\n"
11342 #: ../fish/guestfish-actions.pod:3619 ../src/guestfs-actions.pod:5475
11344 "This command parses the partition table on C<device> and returns the list of "
11345 "partitions found."
11349 #: ../fish/guestfish-actions.pod:3622 ../src/guestfs-actions.pod:5478
11350 msgid "The fields in the returned structure are:"
11354 #: ../fish/guestfish-actions.pod:3626 ../src/guestfs-actions.pod:5482
11355 msgid "B<part_num>"
11359 #: ../fish/guestfish-actions.pod:3628 ../src/guestfs-actions.pod:5484
11360 msgid "Partition number, counting from 1."
11364 #: ../fish/guestfish-actions.pod:3630 ../src/guestfs-actions.pod:5486
11365 msgid "B<part_start>"
11369 #: ../fish/guestfish-actions.pod:3632
11371 "Start of the partition I<in bytes>. To get sectors you have to divide by "
11372 "the device's sector size, see L</blockdev-getss>."
11376 #: ../fish/guestfish-actions.pod:3635 ../src/guestfs-actions.pod:5491
11377 msgid "B<part_end>"
11381 #: ../fish/guestfish-actions.pod:3637 ../src/guestfs-actions.pod:5493
11382 msgid "End of the partition in bytes."
11386 #: ../fish/guestfish-actions.pod:3639 ../src/guestfs-actions.pod:5495
11387 msgid "B<part_size>"
11391 #: ../fish/guestfish-actions.pod:3641 ../src/guestfs-actions.pod:5497
11392 msgid "Size of the partition in bytes."
11396 #: ../fish/guestfish-actions.pod:3645
11397 msgid "part-set-bootable"
11401 #: ../fish/guestfish-actions.pod:3647
11404 " part-set-bootable device partnum true|false\n"
11409 #: ../fish/guestfish-actions.pod:3649 ../src/guestfs-actions.pod:5515
11411 "This sets the bootable flag on partition numbered C<partnum> on device "
11412 "C<device>. Note that partitions are numbered from 1."
11416 #: ../fish/guestfish-actions.pod:3652 ../src/guestfs-actions.pod:5518
11418 "The bootable flag is used by some operating systems (notably Windows) to "
11419 "determine which partition to boot from. It is by no means universally "
11424 #: ../fish/guestfish-actions.pod:3656
11425 msgid "part-set-mbr-id"
11429 #: ../fish/guestfish-actions.pod:3658
11432 " part-set-mbr-id device partnum idbyte\n"
11437 #: ../fish/guestfish-actions.pod:3660 ../src/guestfs-actions.pod:5534
11439 "Sets the MBR type byte (also known as the ID byte) of the numbered partition "
11440 "C<partnum> to C<idbyte>. Note that the type bytes quoted in most "
11441 "documentation are in fact hexadecimal numbers, but usually documented "
11442 "without any leading \"0x\" which might be confusing."
11446 #: ../fish/guestfish-actions.pod:3670
11447 msgid "part-set-name"
11451 #: ../fish/guestfish-actions.pod:3672
11454 " part-set-name device partnum name\n"
11459 #: ../fish/guestfish-actions.pod:3674 ../src/guestfs-actions.pod:5556
11461 "This sets the partition name on partition numbered C<partnum> on device "
11462 "C<device>. Note that partitions are numbered from 1."
11466 #: ../fish/guestfish-actions.pod:3677 ../src/guestfs-actions.pod:5559
11468 "The partition name can only be set on certain types of partition table. "
11469 "This works on C<gpt> but not on C<mbr> partitions."
11473 #: ../fish/guestfish-actions.pod:3680
11474 msgid "part-to-dev"
11478 #: ../fish/guestfish-actions.pod:3682
11481 " part-to-dev partition\n"
11486 #: ../fish/guestfish-actions.pod:3684 ../src/guestfs-actions.pod:5572
11488 "This function takes a partition name (eg. \"/dev/sdb1\") and removes the "
11489 "partition number, returning the device name (eg. \"/dev/sdb\")."
11493 #: ../fish/guestfish-actions.pod:3688
11495 "The named partition must exist, for example as a string returned from "
11496 "L</list-partitions>."
11500 #: ../fish/guestfish-actions.pod:3691
11501 msgid "ping-daemon"
11505 #: ../fish/guestfish-actions.pod:3693
11513 #: ../fish/guestfish-actions.pod:3695 ../src/guestfs-actions.pod:5589
11515 "This is a test probe into the guestfs daemon running inside the qemu "
11516 "subprocess. Calling this function checks that the daemon responds to the "
11517 "ping message, without affecting the daemon or attached block device(s) in "
11522 #: ../fish/guestfish-actions.pod:3700
11527 #: ../fish/guestfish-actions.pod:3702
11530 " pread path count offset\n"
11535 #: ../fish/guestfish-actions.pod:3704 ../src/guestfs-actions.pod:5607
11537 "This command lets you read part of a file. It reads C<count> bytes of the "
11538 "file, starting at C<offset>, from file C<path>."
11542 #: ../fish/guestfish-actions.pod:3707 ../fish/guestfish-actions.pod:3722 ../src/guestfs-actions.pod:5610 ../src/guestfs-actions.pod:5636
11544 "This may read fewer bytes than requested. For further details see the "
11545 "L<pread(2)> system call."
11549 #: ../fish/guestfish-actions.pod:3710
11550 msgid "See also L</pwrite>, L</pread-device>."
11554 #: ../fish/guestfish-actions.pod:3715
11555 msgid "pread-device"
11559 #: ../fish/guestfish-actions.pod:3717
11562 " pread-device device count offset\n"
11567 #: ../fish/guestfish-actions.pod:3719 ../src/guestfs-actions.pod:5633
11569 "This command lets you read part of a file. It reads C<count> bytes of "
11570 "C<device>, starting at C<offset>."
11574 #: ../fish/guestfish-actions.pod:3725
11575 msgid "See also L</pread>."
11579 #: ../fish/guestfish-actions.pod:3730
11584 #: ../fish/guestfish-actions.pod:3732
11587 " pvcreate device\n"
11592 #: ../fish/guestfish-actions.pod:3734 ../src/guestfs-actions.pod:5656
11594 "This creates an LVM physical volume on the named C<device>, where C<device> "
11595 "should usually be a partition name such as C</dev/sda1>."
11599 #: ../fish/guestfish-actions.pod:3738
11604 #: ../fish/guestfish-actions.pod:3740
11607 " pvremove device\n"
11612 #: ../fish/guestfish-actions.pod:3742 ../src/guestfs-actions.pod:5670
11614 "This wipes a physical volume C<device> so that LVM will no longer recognise "
11619 #: ../fish/guestfish-actions.pod:3745 ../src/guestfs-actions.pod:5673
11621 "The implementation uses the C<pvremove> command which refuses to wipe "
11622 "physical volumes that contain any volume groups, so you have to remove those "
11627 #: ../fish/guestfish-actions.pod:3749
11632 #: ../fish/guestfish-actions.pod:3751
11635 " pvresize device\n"
11640 #: ../fish/guestfish-actions.pod:3753 ../src/guestfs-actions.pod:5687
11642 "This resizes (expands or shrinks) an existing LVM physical volume to match "
11643 "the new size of the underlying device."
11647 #: ../fish/guestfish-actions.pod:3756
11648 msgid "pvresize-size"
11652 #: ../fish/guestfish-actions.pod:3758
11655 " pvresize-size device size\n"
11660 #: ../fish/guestfish-actions.pod:3760
11662 "This command is the same as L</pvresize> except that it allows you to "
11663 "specify the new size (in bytes) explicitly."
11667 #: ../fish/guestfish-actions.pod:3763
11672 #: ../fish/guestfish-actions.pod:3765
11680 #: ../fish/guestfish-actions.pod:3767 ../src/guestfs-actions.pod:5713
11682 "List all the physical volumes detected. This is the equivalent of the "
11683 "L<pvs(8)> command."
11687 #: ../fish/guestfish-actions.pod:3770 ../src/guestfs-actions.pod:5716
11689 "This returns a list of just the device names that contain PVs "
11690 "(eg. C</dev/sda2>)."
11694 #: ../fish/guestfish-actions.pod:3773
11695 msgid "See also L</pvs-full>."
11699 #: ../fish/guestfish-actions.pod:3775
11704 #: ../fish/guestfish-actions.pod:3777
11712 #: ../fish/guestfish-actions.pod:3779 ../src/guestfs-actions.pod:5732
11714 "List all the physical volumes detected. This is the equivalent of the "
11715 "L<pvs(8)> command. The \"full\" version includes all fields."
11719 #: ../fish/guestfish-actions.pod:3782
11724 #: ../fish/guestfish-actions.pod:3784
11732 #: ../fish/guestfish-actions.pod:3786 ../src/guestfs-actions.pod:5747
11733 msgid "This command returns the UUID of the LVM PV C<device>."
11737 #: ../fish/guestfish-actions.pod:3788
11742 #: ../fish/guestfish-actions.pod:3790
11745 " pwrite path content offset\n"
11750 #: ../fish/guestfish-actions.pod:3792 ../src/guestfs-actions.pod:5763
11752 "This command writes to part of a file. It writes the data buffer C<content> "
11753 "to the file C<path> starting at offset C<offset>."
11757 #: ../fish/guestfish-actions.pod:3795 ../src/guestfs-actions.pod:5766
11759 "This command implements the L<pwrite(2)> system call, and like that system "
11760 "call it may not write the full data requested. The return value is the "
11761 "number of bytes that were actually written to the file. This could even be "
11762 "0, although short writes are unlikely for regular files in ordinary "
11767 #: ../fish/guestfish-actions.pod:3801
11768 msgid "See also L</pread>, L</pwrite-device>."
11772 #: ../fish/guestfish-actions.pod:3806
11773 msgid "pwrite-device"
11777 #: ../fish/guestfish-actions.pod:3808
11780 " pwrite-device device content offset\n"
11785 #: ../fish/guestfish-actions.pod:3810 ../src/guestfs-actions.pod:5790
11787 "This command writes to part of a device. It writes the data buffer "
11788 "C<content> to C<device> starting at offset C<offset>."
11792 #: ../fish/guestfish-actions.pod:3813 ../src/guestfs-actions.pod:5793
11794 "This command implements the L<pwrite(2)> system call, and like that system "
11795 "call it may not write the full data requested (although short writes to disk "
11796 "devices and partitions are probably impossible with standard Linux kernels)."
11800 #: ../fish/guestfish-actions.pod:3818
11801 msgid "See also L</pwrite>."
11805 #: ../fish/guestfish-actions.pod:3823
11810 #: ../fish/guestfish-actions.pod:3825
11813 " read-file path\n"
11818 #: ../fish/guestfish-actions.pod:3827 ../src/guestfs-actions.pod:5814
11819 msgid "This calls returns the contents of the file C<path> as a buffer."
11823 #: ../fish/guestfish-actions.pod:3830
11825 "Unlike L</cat>, this function can correctly handle files that contain "
11826 "embedded ASCII NUL characters. However unlike L</download>, this function "
11827 "is limited in the total size of file that can be handled."
11831 #: ../fish/guestfish-actions.pod:3838
11836 #: ../fish/guestfish-actions.pod:3840
11839 " read-lines path\n"
11844 #: ../fish/guestfish-actions.pod:3844 ../src/guestfs-actions.pod:5839
11846 "The file contents are returned as a list of lines. Trailing C<LF> and "
11847 "C<CRLF> character sequences are I<not> returned."
11851 #: ../fish/guestfish-actions.pod:3847
11853 "Note that this function cannot correctly handle binary files (specifically, "
11854 "files containing C<\\0> character which is treated as end of line). For "
11855 "those you need to use the L</read-file> function which has a more complex "
11860 #: ../fish/guestfish-actions.pod:3852
11865 #: ../fish/guestfish-actions.pod:3854
11873 #: ../fish/guestfish-actions.pod:3856 ../src/guestfs-actions.pod:5859
11874 msgid "This returns the list of directory entries in directory C<dir>."
11878 #: ../fish/guestfish-actions.pod:3858 ../src/guestfs-actions.pod:5861
11880 "All entries in the directory are returned, including C<.> and C<..>. The "
11881 "entries are I<not> sorted, but returned in the same order as the underlying "
11886 #: ../fish/guestfish-actions.pod:3862 ../src/guestfs-actions.pod:5865
11888 "Also this call returns basic file type information about each file. The "
11889 "C<ftyp> field will contain one of the following characters:"
11893 #: ../fish/guestfish-actions.pod:3867 ../src/guestfs-actions.pod:5870
11898 #: ../fish/guestfish-actions.pod:3869 ../src/guestfs-actions.pod:5872
11899 msgid "Block special"
11903 #: ../fish/guestfish-actions.pod:3871 ../src/guestfs-actions.pod:5874
11908 #: ../fish/guestfish-actions.pod:3873 ../src/guestfs-actions.pod:5876
11909 msgid "Char special"
11913 #: ../fish/guestfish-actions.pod:3875 ../src/guestfs-actions.pod:5878
11918 #: ../fish/guestfish-actions.pod:3877 ../src/guestfs-actions.pod:5880
11923 #: ../fish/guestfish-actions.pod:3879 ../src/guestfs-actions.pod:5882
11928 #: ../fish/guestfish-actions.pod:3881 ../src/guestfs-actions.pod:5884
11929 msgid "FIFO (named pipe)"
11933 #: ../fish/guestfish-actions.pod:3883 ../src/guestfs-actions.pod:5886
11938 #: ../fish/guestfish-actions.pod:3885 ../src/guestfs-actions.pod:5888
11939 msgid "Symbolic link"
11943 #: ../fish/guestfish-actions.pod:3887 ../src/guestfs-actions.pod:5890
11948 #: ../fish/guestfish-actions.pod:3889 ../src/guestfs-actions.pod:5892
11949 msgid "Regular file"
11953 #: ../fish/guestfish-actions.pod:3891 ../src/guestfs-actions.pod:5894
11958 #: ../fish/guestfish-actions.pod:3893 ../src/guestfs-actions.pod:5896
11963 #: ../fish/guestfish-actions.pod:3895 ../src/guestfs-actions.pod:5898
11968 #: ../fish/guestfish-actions.pod:3897 ../src/guestfs-actions.pod:5900
11969 msgid "Unknown file type"
11973 #: ../fish/guestfish-actions.pod:3899 ../src/guestfs-actions.pod:5902
11978 #: ../fish/guestfish-actions.pod:3901 ../src/guestfs-actions.pod:5904
11979 msgid "The L<readdir(3)> call returned a C<d_type> field with an unexpected value"
11983 #: ../fish/guestfish-actions.pod:3906
11985 "This function is primarily intended for use by programs. To get a simple "
11986 "list of names, use L</ls>. To get a printable directory for human "
11987 "consumption, use L</ll>."
11991 #: ../fish/guestfish-actions.pod:3910
11996 #: ../fish/guestfish-actions.pod:3912
12004 #: ../fish/guestfish-actions.pod:3914 ../src/guestfs-actions.pod:5925
12005 msgid "This command reads the target of a symbolic link."
12009 #: ../fish/guestfish-actions.pod:3916
12010 msgid "readlinklist"
12014 #: ../fish/guestfish-actions.pod:3918
12017 " readlinklist path 'names ...'\n"
12022 #: ../fish/guestfish-actions.pod:3920 ../src/guestfs-actions.pod:5939
12024 "This call allows you to do a C<readlink> operation on multiple files, where "
12025 "all files are in the directory C<path>. C<names> is the list of files from "
12030 #: ../fish/guestfish-actions.pod:3924 ../src/guestfs-actions.pod:5943
12032 "On return you get a list of strings, with a one-to-one correspondence to the "
12033 "C<names> list. Each string is the value of the symbolic link."
12037 #: ../fish/guestfish-actions.pod:3928 ../src/guestfs-actions.pod:5947
12039 "If the C<readlink(2)> operation fails on any name, then the corresponding "
12040 "result string is the empty string C<\"\">. However the whole operation is "
12041 "completed even if there were C<readlink(2)> errors, and so you can call this "
12042 "function with names where you don't know if they are symbolic links already "
12043 "(albeit slightly less efficient)."
12047 #: ../fish/guestfish-actions.pod:3935 ../src/guestfs-actions.pod:5954
12049 "This call is intended for programs that want to efficiently list a directory "
12050 "contents without making many round-trips. Very long directory listings "
12051 "might cause the protocol message size to be exceeded, causing this call to "
12052 "fail. The caller must split up such requests into smaller groups of names."
12056 #: ../fish/guestfish-actions.pod:3942
12061 #: ../fish/guestfish-actions.pod:3944
12069 #: ../fish/guestfish-actions.pod:3946 ../src/guestfs-actions.pod:5973
12071 "Return the canonicalized absolute pathname of C<path>. The returned path "
12072 "has no C<.>, C<..> or symbolic link path elements."
12076 #: ../fish/guestfish-actions.pod:3949
12077 msgid "removexattr"
12081 #: ../fish/guestfish-actions.pod:3951
12084 " removexattr xattr path\n"
12089 #: ../fish/guestfish-actions.pod:3953 ../src/guestfs-actions.pod:5988
12090 msgid "This call removes the extended attribute named C<xattr> of the file C<path>."
12094 #: ../fish/guestfish-actions.pod:3956
12095 msgid "See also: L</lremovexattr>, L<attr(5)>."
12099 #: ../fish/guestfish-actions.pod:3958
12104 #: ../fish/guestfish-actions.pod:3960
12107 " resize2fs device\n"
12112 #: ../fish/guestfish-actions.pod:3962 ../src/guestfs-actions.pod:6003
12114 "This resizes an ext2, ext3 or ext4 filesystem to match the size of the "
12115 "underlying device."
12119 #: ../fish/guestfish-actions.pod:3965
12121 "I<Note:> It is sometimes required that you run L</e2fsck-f> on the C<device> "
12122 "before calling this command. For unknown reasons C<resize2fs> sometimes "
12123 "gives an error about this and sometimes not. In any case, it is always safe "
12124 "to call L</e2fsck-f> before calling this function."
12128 #: ../fish/guestfish-actions.pod:3971
12129 msgid "resize2fs-M"
12133 #: ../fish/guestfish-actions.pod:3973
12136 " resize2fs-M device\n"
12141 #: ../fish/guestfish-actions.pod:3975
12143 "This command is the same as L</resize2fs>, but the filesystem is resized to "
12144 "its minimum size. This works like the I<-M> option to the C<resize2fs> "
12149 #: ../fish/guestfish-actions.pod:3979
12151 "To get the resulting size of the filesystem you should call L</tune2fs-l> "
12152 "and read the C<Block size> and C<Block count> values. These two numbers, "
12153 "multiplied together, give the resulting size of the minimal filesystem in "
12158 #: ../fish/guestfish-actions.pod:3984
12159 msgid "resize2fs-size"
12163 #: ../fish/guestfish-actions.pod:3986
12166 " resize2fs-size device size\n"
12171 #: ../fish/guestfish-actions.pod:3988
12173 "This command is the same as L</resize2fs> except that it allows you to "
12174 "specify the new size (in bytes) explicitly."
12178 #: ../fish/guestfish-actions.pod:3991
12183 #: ../fish/guestfish-actions.pod:3993
12191 #: ../fish/guestfish-actions.pod:3995 ../src/guestfs-actions.pod:6055
12192 msgid "Remove the single file C<path>."
12196 #: ../fish/guestfish-actions.pod:3997
12201 #: ../fish/guestfish-actions.pod:3999
12209 #: ../fish/guestfish-actions.pod:4001 ../src/guestfs-actions.pod:6067
12211 "Remove the file or directory C<path>, recursively removing the contents if "
12212 "its a directory. This is like the C<rm -rf> shell command."
12216 #: ../fish/guestfish-actions.pod:4005
12221 #: ../fish/guestfish-actions.pod:4007
12229 #: ../fish/guestfish-actions.pod:4009 ../src/guestfs-actions.pod:6081
12230 msgid "Remove the single directory C<path>."
12234 #: ../fish/guestfish-actions.pod:4011
12235 msgid "rmmountpoint"
12239 #: ../fish/guestfish-actions.pod:4013
12242 " rmmountpoint exemptpath\n"
12247 #: ../fish/guestfish-actions.pod:4015
12249 "This calls removes a mountpoint that was previously created with "
12250 "L</mkmountpoint>. See L</mkmountpoint> for full details."
12254 #: ../fish/guestfish-actions.pod:4019
12255 msgid "scrub-device"
12259 #: ../fish/guestfish-actions.pod:4021
12262 " scrub-device device\n"
12267 #: ../fish/guestfish-actions.pod:4023 ../src/guestfs-actions.pod:6107
12269 "This command writes patterns over C<device> to make data retrieval more "
12274 #: ../fish/guestfish-actions.pod:4026 ../fish/guestfish-actions.pod:4041 ../fish/guestfish-actions.pod:4054 ../src/guestfs-actions.pod:6110 ../src/guestfs-actions.pod:6131 ../src/guestfs-actions.pod:6150
12276 "It is an interface to the L<scrub(1)> program. See that manual page for "
12281 #: ../fish/guestfish-actions.pod:4032
12286 #: ../fish/guestfish-actions.pod:4034
12289 " scrub-file file\n"
12294 #: ../fish/guestfish-actions.pod:4036 ../src/guestfs-actions.pod:6126
12296 "This command writes patterns over a file to make data retrieval more "
12301 #: ../fish/guestfish-actions.pod:4039 ../src/guestfs-actions.pod:6129
12302 msgid "The file is I<removed> after scrubbing."
12306 #: ../fish/guestfish-actions.pod:4044
12307 msgid "scrub-freespace"
12311 #: ../fish/guestfish-actions.pod:4046
12314 " scrub-freespace dir\n"
12319 #: ../fish/guestfish-actions.pod:4048
12321 "This command creates the directory C<dir> and then fills it with files until "
12322 "the filesystem is full, and scrubs the files as for L</scrub-file>, and "
12323 "deletes them. The intention is to scrub any free space on the partition "
12324 "containing C<dir>."
12328 #: ../fish/guestfish-actions.pod:4057
12333 #: ../fish/guestfish-actions.pod:4059
12338 #: ../fish/guestfish-actions.pod:4061
12341 " set-append append\n"
12346 #: ../fish/guestfish-actions.pod:4063 ../src/guestfs-actions.pod:6163
12348 "This function is used to add additional options to the guest kernel command "
12353 #: ../fish/guestfish-actions.pod:4066 ../src/guestfs-actions.pod:6166
12355 "The default is C<NULL> unless overridden by setting C<LIBGUESTFS_APPEND> "
12356 "environment variable."
12360 #: ../fish/guestfish-actions.pod:4069 ../src/guestfs-actions.pod:6169
12362 "Setting C<append> to C<NULL> means I<no> additional options are passed "
12363 "(libguestfs always adds a few of its own)."
12367 #: ../fish/guestfish-actions.pod:4072
12368 msgid "set-attach-method"
12372 #: ../fish/guestfish-actions.pod:4074
12373 msgid "attach-method"
12377 #: ../fish/guestfish-actions.pod:4076
12380 " set-attach-method attachmethod\n"
12385 #: ../fish/guestfish-actions.pod:4078 ../src/guestfs-actions.pod:6182
12387 "Set the method that libguestfs uses to connect to the back end guestfsd "
12388 "daemon. Possible methods are:"
12392 #: ../fish/guestfish-actions.pod:4083 ../src/guestfs-actions.pod:6187 ../src/guestfs.pod:2687
12393 msgid "C<appliance>"
12397 #: ../fish/guestfish-actions.pod:4085 ../src/guestfs-actions.pod:6189
12399 "Launch an appliance and connect to it. This is the ordinary method and the "
12404 #: ../fish/guestfish-actions.pod:4088 ../src/guestfs-actions.pod:6192
12405 msgid "C<unix:I<path>>"
12409 #: ../fish/guestfish-actions.pod:4090 ../src/guestfs-actions.pod:6194
12410 msgid "Connect to the Unix domain socket I<path>."
12414 #: ../fish/guestfish-actions.pod:4092 ../src/guestfs-actions.pod:6196
12416 "This method lets you connect to an existing daemon or (using virtio-serial) "
12417 "to a live guest. For more information, see L<guestfs(3)/ATTACHING TO "
12418 "RUNNING DAEMONS>."
12422 #: ../fish/guestfish-actions.pod:4098
12423 msgid "set-autosync"
12427 #: ../fish/guestfish-actions.pod:4100
12432 #: ../fish/guestfish-actions.pod:4102
12435 " set-autosync true|false\n"
12440 #: ../fish/guestfish-actions.pod:4104 ../src/guestfs-actions.pod:6212
12442 "If C<autosync> is true, this enables autosync. Libguestfs will make a best "
12443 "effort attempt to make filesystems consistent and synchronized when the "
12444 "handle is closed (also if the program exits without closing handles)."
12448 #: ../fish/guestfish-actions.pod:4109 ../src/guestfs-actions.pod:6217
12450 "This is enabled by default (since libguestfs 1.5.24, previously it was "
12451 "disabled by default)."
12455 #: ../fish/guestfish-actions.pod:4112
12460 #: ../fish/guestfish-actions.pod:4114
12465 #: ../fish/guestfish-actions.pod:4116
12468 " set-direct true|false\n"
12473 #: ../fish/guestfish-actions.pod:4118 ../src/guestfs-actions.pod:6230
12475 "If the direct appliance mode flag is enabled, then stdin and stdout are "
12476 "passed directly through to the appliance once it is launched."
12480 #: ../fish/guestfish-actions.pod:4122
12482 "One consequence of this is that log messages aren't caught by the library "
12483 "and handled by L</set-log-message-callback>, but go straight to stdout."
12487 #: ../fish/guestfish-actions.pod:4126 ../src/guestfs-actions.pod:6238
12488 msgid "You probably don't want to use this unless you know what you are doing."
12492 #: ../fish/guestfish-actions.pod:4129 ../src/guestfs-actions.pod:6241
12493 msgid "The default is disabled."
12497 #: ../fish/guestfish-actions.pod:4131
12498 msgid "set-e2label"
12502 #: ../fish/guestfish-actions.pod:4133
12505 " set-e2label device label\n"
12510 #: ../fish/guestfish-actions.pod:4135 ../src/guestfs-actions.pod:6254
12512 "This sets the ext2/3/4 filesystem label of the filesystem on C<device> to "
12513 "C<label>. Filesystem labels are limited to 16 characters."
12517 #: ../fish/guestfish-actions.pod:4139
12519 "You can use either L</tune2fs-l> or L</get-e2label> to return the existing "
12520 "label on a filesystem."
12524 #: ../fish/guestfish-actions.pod:4142
12529 #: ../fish/guestfish-actions.pod:4144
12532 " set-e2uuid device uuid\n"
12537 #: ../fish/guestfish-actions.pod:4146 ../src/guestfs-actions.pod:6272
12539 "This sets the ext2/3/4 filesystem UUID of the filesystem on C<device> to "
12540 "C<uuid>. The format of the UUID and alternatives such as C<clear>, "
12541 "C<random> and C<time> are described in the L<tune2fs(8)> manpage."
12545 #: ../fish/guestfish-actions.pod:4151
12547 "You can use either L</tune2fs-l> or L</get-e2uuid> to return the existing "
12548 "UUID of a filesystem."
12552 #: ../fish/guestfish-actions.pod:4154
12553 msgid "set-memsize"
12557 #: ../fish/guestfish-actions.pod:4156
12562 #: ../fish/guestfish-actions.pod:4158
12565 " set-memsize memsize\n"
12570 #: ../fish/guestfish-actions.pod:4160
12572 "This sets the memory size in megabytes allocated to the qemu subprocess. "
12573 "This only has any effect if called before L</launch>."
12577 #: ../fish/guestfish-actions.pod:4164 ../src/guestfs-actions.pod:6294
12579 "You can also change this by setting the environment variable "
12580 "C<LIBGUESTFS_MEMSIZE> before the handle is created."
12584 #: ../fish/guestfish-actions.pod:4171
12585 msgid "set-network"
12589 #: ../fish/guestfish-actions.pod:4173
12594 #: ../fish/guestfish-actions.pod:4175
12597 " set-network true|false\n"
12602 #: ../fish/guestfish-actions.pod:4177 ../src/guestfs-actions.pod:6311
12604 "If C<network> is true, then the network is enabled in the libguestfs "
12605 "appliance. The default is false."
12609 #: ../fish/guestfish-actions.pod:4180 ../src/guestfs-actions.pod:6314
12611 "This affects whether commands are able to access the network (see "
12612 "L<guestfs(3)/RUNNING COMMANDS>)."
12616 #: ../fish/guestfish-actions.pod:4183
12617 msgid "You must call this before calling L</launch>, otherwise it has no effect."
12621 #: ../fish/guestfish-actions.pod:4186
12626 #: ../fish/guestfish-actions.pod:4190
12629 " set-path searchpath\n"
12634 #: ../fish/guestfish-actions.pod:4192 ../src/guestfs-actions.pod:6330
12635 msgid "Set the path that libguestfs searches for kernel and initrd.img."
12639 #: ../fish/guestfish-actions.pod:4194 ../src/guestfs-actions.pod:6332
12641 "The default is C<$libdir/guestfs> unless overridden by setting "
12642 "C<LIBGUESTFS_PATH> environment variable."
12646 #: ../fish/guestfish-actions.pod:4197 ../src/guestfs-actions.pod:6335
12647 msgid "Setting C<path> to C<NULL> restores the default path."
12651 #: ../fish/guestfish-actions.pod:4199
12656 #: ../fish/guestfish-actions.pod:4201
12661 #: ../fish/guestfish-actions.pod:4203
12664 " set-pgroup true|false\n"
12669 #: ../fish/guestfish-actions.pod:4205 ../src/guestfs-actions.pod:6347
12671 "If C<pgroup> is true, child processes are placed into their own process "
12676 #: ../fish/guestfish-actions.pod:4208 ../src/guestfs-actions.pod:6350
12678 "The practical upshot of this is that signals like C<SIGINT> (from users "
12679 "pressing C<^C>) won't be received by the child process."
12683 #: ../fish/guestfish-actions.pod:4211 ../src/guestfs-actions.pod:6353
12685 "The default for this flag is false, because usually you want C<^C> to kill "
12690 #: ../fish/guestfish-actions.pod:4214
12695 #: ../fish/guestfish-actions.pod:4216
12700 #: ../fish/guestfish-actions.pod:4218
12708 #: ../fish/guestfish-actions.pod:4220 ../src/guestfs-actions.pod:6366
12709 msgid "Set the qemu binary that we will use."
12713 #: ../fish/guestfish-actions.pod:4222 ../src/guestfs-actions.pod:6368
12714 msgid "The default is chosen when the library was compiled by the configure script."
12718 #: ../fish/guestfish-actions.pod:4225 ../src/guestfs-actions.pod:6371
12720 "You can also override this by setting the C<LIBGUESTFS_QEMU> environment "
12725 #: ../fish/guestfish-actions.pod:4228 ../src/guestfs-actions.pod:6374
12726 msgid "Setting C<qemu> to C<NULL> restores the default qemu binary."
12730 #: ../fish/guestfish-actions.pod:4230 ../src/guestfs-actions.pod:6376
12732 "Note that you should call this function as early as possible after creating "
12733 "the handle. This is because some pre-launch operations depend on testing "
12734 "qemu features (by running C<qemu -help>). If the qemu binary changes, we "
12735 "don't retest features, and so you might see inconsistent results. Using the "
12736 "environment variable C<LIBGUESTFS_QEMU> is safest of all since that picks "
12737 "the qemu binary at the same time as the handle is created."
12741 #: ../fish/guestfish-actions.pod:4238
12742 msgid "set-recovery-proc"
12746 #: ../fish/guestfish-actions.pod:4240
12747 msgid "recovery-proc"
12751 #: ../fish/guestfish-actions.pod:4242
12754 " set-recovery-proc true|false\n"
12759 #: ../fish/guestfish-actions.pod:4244
12761 "If this is called with the parameter C<false> then L</launch> does not "
12762 "create a recovery process. The purpose of the recovery process is to stop "
12763 "runaway qemu processes in the case where the main program aborts abruptly."
12767 #: ../fish/guestfish-actions.pod:4249
12769 "This only has any effect if called before L</launch>, and the default is "
12774 #: ../fish/guestfish-actions.pod:4252 ../src/guestfs-actions.pod:6402
12776 "About the only time when you would want to disable this is if the main "
12777 "process will fork itself into the background (\"daemonize\" itself). In "
12778 "this case the recovery process thinks that the main program has disappeared "
12779 "and so kills qemu, which is not very helpful."
12783 #: ../fish/guestfish-actions.pod:4258
12784 msgid "set-selinux"
12788 #: ../fish/guestfish-actions.pod:4260
12793 #: ../fish/guestfish-actions.pod:4262
12796 " set-selinux true|false\n"
12801 #: ../fish/guestfish-actions.pod:4264 ../src/guestfs-actions.pod:6418
12803 "This sets the selinux flag that is passed to the appliance at boot time. "
12804 "The default is C<selinux=0> (disabled)."
12808 #: ../fish/guestfish-actions.pod:4267 ../src/guestfs-actions.pod:6421
12810 "Note that if SELinux is enabled, it is always in Permissive mode "
12811 "(C<enforcing=0>)."
12815 #: ../fish/guestfish-actions.pod:4273
12820 #: ../fish/guestfish-actions.pod:4275
12825 #: ../fish/guestfish-actions.pod:4277
12828 " set-trace true|false\n"
12833 #: ../fish/guestfish-actions.pod:4279 ../src/guestfs-actions.pod:6437
12835 "If the command trace flag is set to 1, then libguestfs calls, parameters and "
12836 "return values are traced."
12840 #: ../fish/guestfish-actions.pod:4282 ../src/guestfs-actions.pod:6440
12842 "If you want to trace C API calls into libguestfs (and other libraries) then "
12843 "possibly a better way is to use the external ltrace(1) command."
12847 #: ../fish/guestfish-actions.pod:4286 ../src/guestfs-actions.pod:6444
12849 "Command traces are disabled unless the environment variable "
12850 "C<LIBGUESTFS_TRACE> is defined and set to C<1>."
12854 #: ../fish/guestfish-actions.pod:4289
12856 "Trace messages are normally sent to C<stderr>, unless you register a "
12857 "callback to send them somewhere else (see L</set-event-callback>)."
12861 #: ../fish/guestfish-actions.pod:4293
12862 msgid "set-verbose"
12866 #: ../fish/guestfish-actions.pod:4295
12871 #: ../fish/guestfish-actions.pod:4297
12874 " set-verbose true|false\n"
12879 #: ../fish/guestfish-actions.pod:4299 ../src/guestfs-actions.pod:6461
12880 msgid "If C<verbose> is true, this turns on verbose messages."
12884 #: ../fish/guestfish-actions.pod:4301 ../src/guestfs-actions.pod:6463
12886 "Verbose messages are disabled unless the environment variable "
12887 "C<LIBGUESTFS_DEBUG> is defined and set to C<1>."
12891 #: ../fish/guestfish-actions.pod:4304
12893 "Verbose messages are normally sent to C<stderr>, unless you register a "
12894 "callback to send them somewhere else (see L</set-event-callback>)."
12898 #: ../fish/guestfish-actions.pod:4308
12903 #: ../fish/guestfish-actions.pod:4310
12906 " setcon context\n"
12911 #: ../fish/guestfish-actions.pod:4312 ../src/guestfs-actions.pod:6480
12913 "This sets the SELinux security context of the daemon to the string "
12918 #: ../fish/guestfish-actions.pod:4315 ../src/guestfs-actions.pod:6483
12919 msgid "See the documentation about SELINUX in L<guestfs(3)>."
12923 #: ../fish/guestfish-actions.pod:4317
12928 #: ../fish/guestfish-actions.pod:4319
12931 " setxattr xattr val vallen path\n"
12936 #: ../fish/guestfish-actions.pod:4321 ../src/guestfs-actions.pod:6498
12938 "This call sets the extended attribute named C<xattr> of the file C<path> to "
12939 "the value C<val> (of length C<vallen>). The value is arbitrary 8 bit data."
12943 #: ../fish/guestfish-actions.pod:4325
12944 msgid "See also: L</lsetxattr>, L<attr(5)>."
12948 #: ../fish/guestfish-actions.pod:4327
12953 #: ../fish/guestfish-actions.pod:4329
12956 " sfdisk device cyls heads sectors 'lines ...'\n"
12961 #: ../fish/guestfish-actions.pod:4331 ../src/guestfs-actions.pod:6518
12963 "This is a direct interface to the L<sfdisk(8)> program for creating "
12964 "partitions on block devices."
12968 #: ../fish/guestfish-actions.pod:4334 ../src/guestfs-actions.pod:6521
12969 msgid "C<device> should be a block device, for example C</dev/sda>."
12973 #: ../fish/guestfish-actions.pod:4336 ../src/guestfs-actions.pod:6523
12975 "C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads and "
12976 "sectors on the device, which are passed directly to sfdisk as the I<-C>, "
12977 "I<-H> and I<-S> parameters. If you pass C<0> for any of these, then the "
12978 "corresponding parameter is omitted. Usually for 'large' disks, you can just "
12979 "pass C<0> for these, but for small (floppy-sized) disks, sfdisk (or rather, "
12980 "the kernel) cannot work out the right geometry and you will need to tell it."
12984 #: ../fish/guestfish-actions.pod:4344 ../src/guestfs-actions.pod:6531
12986 "C<lines> is a list of lines that we feed to C<sfdisk>. For more information "
12987 "refer to the L<sfdisk(8)> manpage."
12991 #: ../fish/guestfish-actions.pod:4347 ../src/guestfs-actions.pod:6534
12993 "To create a single partition occupying the whole disk, you would pass "
12994 "C<lines> as a single element list, when the single element being the string "
12999 #: ../fish/guestfish-actions.pod:4351
13000 msgid "See also: L</sfdisk-l>, L</sfdisk-N>, L</part-init>"
13004 #: ../fish/guestfish-actions.pod:4357 ../fish/guestfish-actions.pod:4380 ../fish/guestfish-actions.pod:4402
13006 "This function is deprecated. In new code, use the L</part_add> call "
13011 #: ../fish/guestfish-actions.pod:4364
13016 #: ../fish/guestfish-actions.pod:4366
13019 " sfdiskM device 'lines ...'\n"
13024 #: ../fish/guestfish-actions.pod:4368
13026 "This is a simplified interface to the L</sfdisk> command, where partition "
13027 "sizes are specified in megabytes only (rounded to the nearest cylinder) and "
13028 "you don't need to specify the cyls, heads and sectors parameters which were "
13029 "rarely if ever used anyway."
13033 #: ../fish/guestfish-actions.pod:4374
13034 msgid "See also: L</sfdisk>, the L<sfdisk(8)> manpage and L</part-disk>"
13038 #: ../fish/guestfish-actions.pod:4387
13043 #: ../fish/guestfish-actions.pod:4389
13046 " sfdisk-N device partnum cyls heads sectors line\n"
13051 #: ../fish/guestfish-actions.pod:4391 ../src/guestfs-actions.pod:6596
13053 "This runs L<sfdisk(8)> option to modify just the single partition C<n> "
13054 "(note: C<n> counts from 1)."
13058 #: ../fish/guestfish-actions.pod:4394
13060 "For other parameters, see L</sfdisk>. You should usually pass C<0> for the "
13061 "cyls/heads/sectors parameters."
13065 #: ../fish/guestfish-actions.pod:4397
13066 msgid "See also: L</part-add>"
13070 #: ../fish/guestfish-actions.pod:4409
13071 msgid "sfdisk-disk-geometry"
13075 #: ../fish/guestfish-actions.pod:4411
13078 " sfdisk-disk-geometry device\n"
13083 #: ../fish/guestfish-actions.pod:4413
13085 "This displays the disk geometry of C<device> read from the partition table. "
13086 "Especially in the case where the underlying block device has been resized, "
13087 "this can be different from the kernel's idea of the geometry (see "
13088 "L</sfdisk-kernel-geometry>)."
13092 #: ../fish/guestfish-actions.pod:4418 ../fish/guestfish-actions.pod:4427 ../src/guestfs-actions.pod:6629 ../src/guestfs-actions.pod:6645
13093 msgid "The result is in human-readable format, and not designed to be parsed."
13097 #: ../fish/guestfish-actions.pod:4421
13098 msgid "sfdisk-kernel-geometry"
13102 #: ../fish/guestfish-actions.pod:4423
13105 " sfdisk-kernel-geometry device\n"
13110 #: ../fish/guestfish-actions.pod:4425 ../src/guestfs-actions.pod:6643
13111 msgid "This displays the kernel's idea of the geometry of C<device>."
13115 #: ../fish/guestfish-actions.pod:4430
13120 #: ../fish/guestfish-actions.pod:4432
13123 " sfdisk-l device\n"
13128 #: ../fish/guestfish-actions.pod:4434 ../src/guestfs-actions.pod:6659
13130 "This displays the partition table on C<device>, in the human-readable output "
13131 "of the L<sfdisk(8)> command. It is not intended to be parsed."
13135 #: ../fish/guestfish-actions.pod:4438
13136 msgid "See also: L</part-list>"
13140 #: ../fish/guestfish-actions.pod:4440
13142 "This function is deprecated. In new code, use the L</part_list> call "
13147 #: ../fish/guestfish-actions.pod:4447
13152 #: ../fish/guestfish-actions.pod:4449
13160 #: ../fish/guestfish-actions.pod:4451 ../src/guestfs-actions.pod:6683
13162 "This call runs a command from the guest filesystem via the guest's "
13167 #: ../fish/guestfish-actions.pod:4454
13168 msgid "This is like L</command>, but passes the command to:"
13172 #: ../fish/guestfish-actions.pod:4456 ../src/guestfs-actions.pod:6688
13175 " /bin/sh -c \"command\"\n"
13180 #: ../fish/guestfish-actions.pod:4458 ../src/guestfs-actions.pod:6690
13182 "Depending on the guest's shell, this usually results in wildcards being "
13183 "expanded, shell expressions being interpolated and so on."
13187 #: ../fish/guestfish-actions.pod:4462
13188 msgid "All the provisos about L</command> apply to this call."
13192 #: ../fish/guestfish-actions.pod:4464
13197 #: ../fish/guestfish-actions.pod:4466
13200 " sh-lines command\n"
13205 #: ../fish/guestfish-actions.pod:4468
13206 msgid "This is the same as L</sh>, but splits the result into a list of lines."
13210 #: ../fish/guestfish-actions.pod:4471
13211 msgid "See also: L</command-lines>"
13215 #: ../fish/guestfish-actions.pod:4473
13220 #: ../fish/guestfish-actions.pod:4475
13228 #: ../fish/guestfish-actions.pod:4477 ../src/guestfs-actions.pod:6724
13229 msgid "Sleep for C<secs> seconds."
13233 #: ../fish/guestfish-actions.pod:4479
13238 #: ../fish/guestfish-actions.pod:4481
13246 #: ../fish/guestfish-actions.pod:4485 ../src/guestfs-actions.pod:6738
13247 msgid "This is the same as the C<stat(2)> system call."
13251 #: ../fish/guestfish-actions.pod:4487
13256 #: ../fish/guestfish-actions.pod:4489
13264 #: ../fish/guestfish-actions.pod:4491 ../src/guestfs-actions.pod:6752
13266 "Returns file system statistics for any mounted file system. C<path> should "
13267 "be a file or directory in the mounted file system (typically it is the mount "
13268 "point itself, but it doesn't need to be)."
13272 #: ../fish/guestfish-actions.pod:4495 ../src/guestfs-actions.pod:6756
13273 msgid "This is the same as the C<statvfs(2)> system call."
13277 #: ../fish/guestfish-actions.pod:4497
13282 #: ../fish/guestfish-actions.pod:4499
13290 #: ../fish/guestfish-actions.pod:4501 ../src/guestfs-actions.pod:6770
13292 "This runs the L<strings(1)> command on a file and returns the list of "
13293 "printable strings found."
13297 #: ../fish/guestfish-actions.pod:4507
13302 #: ../fish/guestfish-actions.pod:4509
13305 " strings-e encoding path\n"
13310 #: ../fish/guestfish-actions.pod:4511
13312 "This is like the L</strings> command, but allows you to specify the encoding "
13313 "of strings that are looked for in the source file C<path>."
13317 #: ../fish/guestfish-actions.pod:4515 ../src/guestfs-actions.pod:6793
13318 msgid "Allowed encodings are:"
13322 #: ../fish/guestfish-actions.pod:4519 ../src/guestfs-actions.pod:6797
13327 #: ../fish/guestfish-actions.pod:4521
13329 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
13330 "ISO-8859-X (this is what L</strings> uses)."
13334 #: ../fish/guestfish-actions.pod:4524 ../src/guestfs-actions.pod:6802
13339 #: ../fish/guestfish-actions.pod:4526 ../src/guestfs-actions.pod:6804
13340 msgid "Single 8-bit-byte characters."
13344 #: ../fish/guestfish-actions.pod:4528 ../src/guestfs-actions.pod:6806
13349 #: ../fish/guestfish-actions.pod:4530 ../src/guestfs-actions.pod:6808
13350 msgid "16-bit big endian strings such as those encoded in UTF-16BE or UCS-2BE."
13354 #: ../fish/guestfish-actions.pod:4533 ../src/guestfs-actions.pod:6811
13355 msgid "l (lower case letter L)"
13359 #: ../fish/guestfish-actions.pod:4535 ../src/guestfs-actions.pod:6813
13361 "16-bit little endian such as UTF-16LE and UCS-2LE. This is useful for "
13362 "examining binaries in Windows guests."
13366 #: ../fish/guestfish-actions.pod:4538 ../src/guestfs-actions.pod:6816
13371 #: ../fish/guestfish-actions.pod:4540 ../src/guestfs-actions.pod:6818
13372 msgid "32-bit big endian such as UCS-4BE."
13376 #: ../fish/guestfish-actions.pod:4542 ../src/guestfs-actions.pod:6820
13381 #: ../fish/guestfish-actions.pod:4544 ../src/guestfs-actions.pod:6822
13382 msgid "32-bit little endian such as UCS-4LE."
13386 #: ../fish/guestfish-actions.pod:4548 ../src/guestfs-actions.pod:6826
13387 msgid "The returned strings are transcoded to UTF-8."
13391 #: ../fish/guestfish-actions.pod:4553
13392 msgid "swapoff-device"
13396 #: ../fish/guestfish-actions.pod:4555
13399 " swapoff-device device\n"
13404 #: ../fish/guestfish-actions.pod:4557
13406 "This command disables the libguestfs appliance swap device or partition "
13407 "named C<device>. See L</swapon-device>."
13411 #: ../fish/guestfish-actions.pod:4561
13412 msgid "swapoff-file"
13416 #: ../fish/guestfish-actions.pod:4563
13419 " swapoff-file file\n"
13424 #: ../fish/guestfish-actions.pod:4565 ../src/guestfs-actions.pod:6857
13425 msgid "This command disables the libguestfs appliance swap on file."
13429 #: ../fish/guestfish-actions.pod:4567
13430 msgid "swapoff-label"
13434 #: ../fish/guestfish-actions.pod:4569
13437 " swapoff-label label\n"
13442 #: ../fish/guestfish-actions.pod:4571 ../src/guestfs-actions.pod:6869
13444 "This command disables the libguestfs appliance swap on labeled swap "
13449 #: ../fish/guestfish-actions.pod:4574
13450 msgid "swapoff-uuid"
13454 #: ../fish/guestfish-actions.pod:4576
13457 " swapoff-uuid uuid\n"
13462 #: ../fish/guestfish-actions.pod:4578 ../src/guestfs-actions.pod:6882
13464 "This command disables the libguestfs appliance swap partition with the given "
13469 #: ../fish/guestfish-actions.pod:4581
13470 msgid "swapon-device"
13474 #: ../fish/guestfish-actions.pod:4583
13477 " swapon-device device\n"
13482 #: ../fish/guestfish-actions.pod:4585
13484 "This command enables the libguestfs appliance to use the swap device or "
13485 "partition named C<device>. The increased memory is made available for all "
13486 "commands, for example those run using L</command> or L</sh>."
13490 #: ../fish/guestfish-actions.pod:4590 ../src/guestfs-actions.pod:6900
13492 "Note that you should not swap to existing guest swap partitions unless you "
13493 "know what you are doing. They may contain hibernation information, or other "
13494 "information that the guest doesn't want you to trash. You also risk leaking "
13495 "information about the host to the guest this way. Instead, attach a new "
13496 "host device to the guest and swap on that."
13500 #: ../fish/guestfish-actions.pod:4597
13501 msgid "swapon-file"
13505 #: ../fish/guestfish-actions.pod:4599
13508 " swapon-file file\n"
13513 #: ../fish/guestfish-actions.pod:4601
13514 msgid "This command enables swap to a file. See L</swapon-device> for other notes."
13518 #: ../fish/guestfish-actions.pod:4604
13519 msgid "swapon-label"
13523 #: ../fish/guestfish-actions.pod:4606
13526 " swapon-label label\n"
13531 #: ../fish/guestfish-actions.pod:4608
13533 "This command enables swap to a labeled swap partition. See "
13534 "L</swapon-device> for other notes."
13538 #: ../fish/guestfish-actions.pod:4611
13539 msgid "swapon-uuid"
13543 #: ../fish/guestfish-actions.pod:4613
13546 " swapon-uuid uuid\n"
13551 #: ../fish/guestfish-actions.pod:4615
13553 "This command enables swap to a swap partition with the given UUID. See "
13554 "L</swapon-device> for other notes."
13558 #: ../fish/guestfish-actions.pod:4618
13563 #: ../fish/guestfish-actions.pod:4620
13571 #: ../fish/guestfish-actions.pod:4622 ../src/guestfs-actions.pod:6955
13573 "This syncs the disk, so that any writes are flushed through to the "
13574 "underlying disk image."
13578 #: ../fish/guestfish-actions.pod:4625 ../src/guestfs-actions.pod:6958
13580 "You should always call this if you have modified a disk image, before "
13581 "closing the handle."
13585 #: ../fish/guestfish-actions.pod:4628
13590 #: ../fish/guestfish-actions.pod:4630
13598 #: ../fish/guestfish-actions.pod:4632 ../src/guestfs-actions.pod:6971
13599 msgid "This command returns up to the last 10 lines of a file as a list of strings."
13603 #: ../fish/guestfish-actions.pod:4638
13608 #: ../fish/guestfish-actions.pod:4640
13611 " tail-n nrlines path\n"
13616 #: ../fish/guestfish-actions.pod:4642 ../src/guestfs-actions.pod:6990
13618 "If the parameter C<nrlines> is a positive number, this returns the last "
13619 "C<nrlines> lines of the file C<path>."
13623 #: ../fish/guestfish-actions.pod:4645 ../src/guestfs-actions.pod:6993
13625 "If the parameter C<nrlines> is a negative number, this returns lines from "
13626 "the file C<path>, starting with the C<-nrlines>th line."
13630 #: ../fish/guestfish-actions.pod:4653
13635 #: ../fish/guestfish-actions.pod:4655
13638 " tar-in (tarfile|-) directory\n"
13643 #: ../fish/guestfish-actions.pod:4657 ../src/guestfs-actions.pod:7014
13645 "This command uploads and unpacks local file C<tarfile> (an I<uncompressed> "
13646 "tar file) into C<directory>."
13650 #: ../fish/guestfish-actions.pod:4660
13651 msgid "To upload a compressed tarball, use L</tgz-in> or L</txz-in>."
13655 #: ../fish/guestfish-actions.pod:4665
13660 #: ../fish/guestfish-actions.pod:4667
13663 " tar-out directory (tarfile|-)\n"
13668 #: ../fish/guestfish-actions.pod:4669 ../src/guestfs-actions.pod:7031
13670 "This command packs the contents of C<directory> and downloads it to local "
13675 #: ../fish/guestfish-actions.pod:4672
13676 msgid "To download a compressed tarball, use L</tgz-out> or L</txz-out>."
13680 #: ../fish/guestfish-actions.pod:4677
13685 #: ../fish/guestfish-actions.pod:4679
13688 " tgz-in (tarball|-) directory\n"
13693 #: ../fish/guestfish-actions.pod:4681 ../src/guestfs-actions.pod:7048
13695 "This command uploads and unpacks local file C<tarball> (a I<gzip compressed> "
13696 "tar file) into C<directory>."
13700 #: ../fish/guestfish-actions.pod:4684
13701 msgid "To upload an uncompressed tarball, use L</tar-in>."
13705 #: ../fish/guestfish-actions.pod:4688
13710 #: ../fish/guestfish-actions.pod:4690
13713 " tgz-out directory (tarball|-)\n"
13718 #: ../fish/guestfish-actions.pod:4692 ../src/guestfs-actions.pod:7064
13720 "This command packs the contents of C<directory> and downloads it to local "
13725 #: ../fish/guestfish-actions.pod:4695
13726 msgid "To download an uncompressed tarball, use L</tar-out>."
13730 #: ../fish/guestfish-actions.pod:4699
13735 #: ../fish/guestfish-actions.pod:4701
13743 #: ../fish/guestfish-actions.pod:4703 ../src/guestfs-actions.pod:7079
13745 "Touch acts like the L<touch(1)> command. It can be used to update the "
13746 "timestamps on a file, or, if the file does not exist, to create a new "
13747 "zero-length file."
13751 #: ../fish/guestfish-actions.pod:4707 ../src/guestfs-actions.pod:7083
13753 "This command only works on regular files, and will fail on other file types "
13754 "such as directories, symbolic links, block special etc."
13758 #: ../fish/guestfish-actions.pod:4710
13763 #: ../fish/guestfish-actions.pod:4712
13771 #: ../fish/guestfish-actions.pod:4714 ../src/guestfs-actions.pod:7096
13773 "This command truncates C<path> to a zero-length file. The file must exist "
13778 #: ../fish/guestfish-actions.pod:4717
13779 msgid "truncate-size"
13783 #: ../fish/guestfish-actions.pod:4719
13786 " truncate-size path size\n"
13791 #: ../fish/guestfish-actions.pod:4721 ../src/guestfs-actions.pod:7110
13793 "This command truncates C<path> to size C<size> bytes. The file must exist "
13798 #: ../fish/guestfish-actions.pod:4724
13800 "If the current file size is less than C<size> then the file is extended to "
13801 "the required size with zero bytes. This creates a sparse file (ie. disk "
13802 "blocks are not allocated for the file until you write to it). To create a "
13803 "non-sparse file of zeroes, use L</fallocate64> instead."
13807 #: ../fish/guestfish-actions.pod:4730
13812 #: ../fish/guestfish-actions.pod:4732
13815 " tune2fs-l device\n"
13820 #: ../fish/guestfish-actions.pod:4734 ../src/guestfs-actions.pod:7129
13822 "This returns the contents of the ext2, ext3 or ext4 filesystem superblock on "
13827 #: ../fish/guestfish-actions.pod:4737 ../src/guestfs-actions.pod:7132
13829 "It is the same as running C<tune2fs -l device>. See L<tune2fs(8)> manpage "
13830 "for more details. The list of fields returned isn't clearly defined, and "
13831 "depends on both the version of C<tune2fs> that libguestfs was built against, "
13832 "and the filesystem itself."
13836 #: ../fish/guestfish-actions.pod:4742
13841 #: ../fish/guestfish-actions.pod:4744
13844 " txz-in (tarball|-) directory\n"
13849 #: ../fish/guestfish-actions.pod:4746 ../src/guestfs-actions.pod:7152
13851 "This command uploads and unpacks local file C<tarball> (an I<xz compressed> "
13852 "tar file) into C<directory>."
13856 #: ../fish/guestfish-actions.pod:4751
13861 #: ../fish/guestfish-actions.pod:4753
13864 " txz-out directory (tarball|-)\n"
13869 #: ../fish/guestfish-actions.pod:4755 ../src/guestfs-actions.pod:7166
13871 "This command packs the contents of C<directory> and downloads it to local "
13872 "file C<tarball> (as an xz compressed tar archive)."
13876 #: ../fish/guestfish-actions.pod:4760
13881 #: ../fish/guestfish-actions.pod:4762
13889 #: ../fish/guestfish-actions.pod:4764 ../src/guestfs-actions.pod:7179
13891 "This function sets the mask used for creating new files and device nodes to "
13896 #: ../fish/guestfish-actions.pod:4767 ../src/guestfs-actions.pod:7182
13898 "Typical umask values would be C<022> which creates new files with "
13899 "permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and C<002> which creates "
13900 "new files with permissions like \"-rw-rw-r--\" or \"-rwxrwxr-x\"."
13904 #: ../fish/guestfish-actions.pod:4772 ../src/guestfs-actions.pod:7187
13906 "The default umask is C<022>. This is important because it means that "
13907 "directories and device nodes will be created with C<0644> or C<0755> mode "
13908 "even if you specify C<0777>."
13912 #: ../fish/guestfish-actions.pod:4776
13913 msgid "See also L</get-umask>, L<umask(2)>, L</mknod>, L</mkdir>."
13917 #: ../fish/guestfish-actions.pod:4779 ../src/guestfs-actions.pod:7194
13918 msgid "This call returns the previous umask."
13922 #: ../fish/guestfish-actions.pod:4781
13927 #: ../fish/guestfish-actions.pod:4783
13932 #: ../fish/guestfish-actions.pod:4785
13935 " umount pathordevice\n"
13940 #: ../fish/guestfish-actions.pod:4787 ../src/guestfs-actions.pod:7206
13942 "This unmounts the given filesystem. The filesystem may be specified either "
13943 "by its mountpoint (path) or the device which contains the filesystem."
13947 #: ../fish/guestfish-actions.pod:4791
13952 #: ../fish/guestfish-actions.pod:4793
13953 msgid "unmount-all"
13957 #: ../fish/guestfish-actions.pod:4795
13965 #: ../fish/guestfish-actions.pod:4797 ../src/guestfs-actions.pod:7219
13966 msgid "This unmounts all mounted filesystems."
13970 #: ../fish/guestfish-actions.pod:4799 ../src/guestfs-actions.pod:7221
13971 msgid "Some internal mounts are not unmounted by this call."
13975 #: ../fish/guestfish-actions.pod:4801
13980 #: ../fish/guestfish-actions.pod:4803
13983 " upload (filename|-) remotefilename\n"
13988 #: ../fish/guestfish-actions.pod:4805 ../fish/guestfish-actions.pod:4818 ../src/guestfs-actions.pod:7234 ../src/guestfs-actions.pod:7258
13989 msgid "Upload local file C<filename> to C<remotefilename> on the filesystem."
13993 #: ../fish/guestfish-actions.pod:4810
13994 msgid "See also L</download>."
13998 #: ../fish/guestfish-actions.pod:4814
13999 msgid "upload-offset"
14003 #: ../fish/guestfish-actions.pod:4816
14006 " upload-offset (filename|-) remotefilename offset\n"
14011 #: ../fish/guestfish-actions.pod:4821 ../src/guestfs-actions.pod:7261
14013 "C<remotefilename> is overwritten starting at the byte C<offset> specified. "
14014 "The intention is to overwrite parts of existing files or devices, although "
14015 "if a non-existant file is specified then it is created with a \"hole\" "
14016 "before C<offset>. The size of the data written is implicit in the size of "
14017 "the source C<filename>."
14021 #: ../fish/guestfish-actions.pod:4828
14023 "Note that there is no limit on the amount of data that can be uploaded with "
14024 "this call, unlike with L</pwrite>, and this call always writes the full "
14025 "amount unless an error occurs."
14029 #: ../fish/guestfish-actions.pod:4833
14030 msgid "See also L</upload>, L</pwrite>."
14034 #: ../fish/guestfish-actions.pod:4837
14039 #: ../fish/guestfish-actions.pod:4839
14042 " utimens path atsecs atnsecs mtsecs mtnsecs\n"
14047 #: ../fish/guestfish-actions.pod:4841 ../src/guestfs-actions.pod:7294
14048 msgid "This command sets the timestamps of a file with nanosecond precision."
14052 #: ../fish/guestfish-actions.pod:4844 ../src/guestfs-actions.pod:7297
14054 "C<atsecs, atnsecs> are the last access time (atime) in secs and nanoseconds "
14059 #: ../fish/guestfish-actions.pod:4847 ../src/guestfs-actions.pod:7300
14061 "C<mtsecs, mtnsecs> are the last modification time (mtime) in secs and "
14062 "nanoseconds from the epoch."
14066 #: ../fish/guestfish-actions.pod:4850 ../src/guestfs-actions.pod:7303
14068 "If the C<*nsecs> field contains the special value C<-1> then the "
14069 "corresponding timestamp is set to the current time. (The C<*secs> field is "
14070 "ignored in this case)."
14074 #: ../fish/guestfish-actions.pod:4854 ../src/guestfs-actions.pod:7307
14076 "If the C<*nsecs> field contains the special value C<-2> then the "
14077 "corresponding timestamp is left unchanged. (The C<*secs> field is ignored "
14082 #: ../fish/guestfish-actions.pod:4858
14087 #: ../fish/guestfish-actions.pod:4860
14095 #: ../fish/guestfish-actions.pod:4862 ../src/guestfs-actions.pod:7320
14096 msgid "Return the libguestfs version number that the program is linked against."
14100 #: ../fish/guestfish-actions.pod:4865 ../src/guestfs-actions.pod:7323
14102 "Note that because of dynamic linking this is not necessarily the version of "
14103 "libguestfs that you compiled against. You can compile the program, and then "
14104 "at runtime dynamically link against a completely different C<libguestfs.so> "
14109 #: ../fish/guestfish-actions.pod:4870 ../src/guestfs-actions.pod:7328
14111 "This call was added in version C<1.0.58>. In previous versions of "
14112 "libguestfs there was no way to get the version number. From C code you can "
14113 "use dynamic linker functions to find out if this symbol exists (if it "
14114 "doesn't, then it's an earlier version)."
14118 #: ../fish/guestfish-actions.pod:4876 ../src/guestfs-actions.pod:7334
14120 "The call returns a structure with four elements. The first three (C<major>, "
14121 "C<minor> and C<release>) are numbers and correspond to the usual version "
14122 "triplet. The fourth element (C<extra>) is a string and is normally empty, "
14123 "but may be used for distro-specific information."
14127 #: ../fish/guestfish-actions.pod:4882 ../src/guestfs-actions.pod:7340
14128 msgid "To construct the original version string: C<$major.$minor.$release$extra>"
14132 #: ../fish/guestfish-actions.pod:4885 ../src/guestfs-actions.pod:7343
14133 msgid "See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>."
14137 #: ../fish/guestfish-actions.pod:4887
14139 "I<Note:> Don't use this call to test for availability of features. In "
14140 "enterprise distributions we backport features from later versions into "
14141 "earlier versions, making this an unreliable way to test for features. Use "
14142 "L</available> instead."
14146 #: ../fish/guestfish-actions.pod:4893
14151 #: ../fish/guestfish-actions.pod:4895
14154 " vfs-label device\n"
14159 #: ../fish/guestfish-actions.pod:4897 ../src/guestfs-actions.pod:7363
14160 msgid "This returns the filesystem label of the filesystem on C<device>."
14164 #: ../fish/guestfish-actions.pod:4900 ../src/guestfs-actions.pod:7366
14165 msgid "If the filesystem is unlabeled, this returns the empty string."
14169 #: ../fish/guestfish-actions.pod:4902
14170 msgid "To find a filesystem from the label, use L</findfs-label>."
14174 #: ../fish/guestfish-actions.pod:4904
14179 #: ../fish/guestfish-actions.pod:4906
14182 " vfs-type device\n"
14187 #: ../fish/guestfish-actions.pod:4908 ../src/guestfs-actions.pod:7381
14189 "This command gets the filesystem type corresponding to the filesystem on "
14194 #: ../fish/guestfish-actions.pod:4911 ../src/guestfs-actions.pod:7384
14196 "For most filesystems, the result is the name of the Linux VFS module which "
14197 "would be used to mount this filesystem if you mounted it without specifying "
14198 "the filesystem type. For example a string such as C<ext3> or C<ntfs>."
14202 #: ../fish/guestfish-actions.pod:4916
14207 #: ../fish/guestfish-actions.pod:4918
14210 " vfs-uuid device\n"
14215 #: ../fish/guestfish-actions.pod:4920 ../src/guestfs-actions.pod:7400
14216 msgid "This returns the filesystem UUID of the filesystem on C<device>."
14220 #: ../fish/guestfish-actions.pod:4923 ../src/guestfs-actions.pod:7403
14221 msgid "If the filesystem does not have a UUID, this returns the empty string."
14225 #: ../fish/guestfish-actions.pod:4925
14226 msgid "To find a filesystem from the UUID, use L</findfs-uuid>."
14230 #: ../fish/guestfish-actions.pod:4927
14231 msgid "vg-activate"
14235 #: ../fish/guestfish-actions.pod:4929
14238 " vg-activate true|false 'volgroups ...'\n"
14243 #: ../fish/guestfish-actions.pod:4931 ../src/guestfs-actions.pod:7419
14245 "This command activates or (if C<activate> is false) deactivates all logical "
14246 "volumes in the listed volume groups C<volgroups>."
14250 #: ../fish/guestfish-actions.pod:4934 ../src/guestfs-actions.pod:7422
14251 msgid "This command is the same as running C<vgchange -a y|n volgroups...>"
14255 #: ../fish/guestfish-actions.pod:4936 ../src/guestfs-actions.pod:7424
14257 "Note that if C<volgroups> is an empty list then B<all> volume groups are "
14258 "activated or deactivated."
14262 #: ../fish/guestfish-actions.pod:4939
14263 msgid "vg-activate-all"
14267 #: ../fish/guestfish-actions.pod:4941
14270 " vg-activate-all true|false\n"
14275 #: ../fish/guestfish-actions.pod:4943 ../src/guestfs-actions.pod:7437
14277 "This command activates or (if C<activate> is false) deactivates all logical "
14278 "volumes in all volume groups."
14282 #: ../fish/guestfish-actions.pod:4946 ../src/guestfs-actions.pod:7440
14283 msgid "This command is the same as running C<vgchange -a y|n>"
14287 #: ../fish/guestfish-actions.pod:4948
14292 #: ../fish/guestfish-actions.pod:4950
14295 " vgcreate volgroup 'physvols ...'\n"
14300 #: ../fish/guestfish-actions.pod:4952 ../src/guestfs-actions.pod:7453
14302 "This creates an LVM volume group called C<volgroup> from the non-empty list "
14303 "of physical volumes C<physvols>."
14307 #: ../fish/guestfish-actions.pod:4955
14312 #: ../fish/guestfish-actions.pod:4957
14315 " vglvuuids vgname\n"
14320 #: ../fish/guestfish-actions.pod:4959 ../src/guestfs-actions.pod:7466
14322 "Given a VG called C<vgname>, this returns the UUIDs of all the logical "
14323 "volumes created in this volume group."
14327 #: ../fish/guestfish-actions.pod:4962
14329 "You can use this along with L</lvs> and L</lvuuid> calls to associate "
14330 "logical volumes and volume groups."
14334 #: ../fish/guestfish-actions.pod:4965
14335 msgid "See also L</vgpvuuids>."
14339 #: ../fish/guestfish-actions.pod:4967
14344 #: ../fish/guestfish-actions.pod:4969
14347 " vgpvuuids vgname\n"
14352 #: ../fish/guestfish-actions.pod:4971 ../src/guestfs-actions.pod:7486
14354 "Given a VG called C<vgname>, this returns the UUIDs of all the physical "
14355 "volumes that this volume group resides on."
14359 #: ../fish/guestfish-actions.pod:4974
14361 "You can use this along with L</pvs> and L</pvuuid> calls to associate "
14362 "physical volumes and volume groups."
14366 #: ../fish/guestfish-actions.pod:4977
14367 msgid "See also L</vglvuuids>."
14371 #: ../fish/guestfish-actions.pod:4979
14376 #: ../fish/guestfish-actions.pod:4981
14379 " vgremove vgname\n"
14384 #: ../fish/guestfish-actions.pod:4983 ../src/guestfs-actions.pod:7506
14385 msgid "Remove an LVM volume group C<vgname>, (for example C<VG>)."
14389 #: ../fish/guestfish-actions.pod:4985 ../src/guestfs-actions.pod:7508
14390 msgid "This also forcibly removes all logical volumes in the volume group (if any)."
14394 #: ../fish/guestfish-actions.pod:4988
14399 #: ../fish/guestfish-actions.pod:4990
14402 " vgrename volgroup newvolgroup\n"
14407 #: ../fish/guestfish-actions.pod:4992 ../src/guestfs-actions.pod:7522
14408 msgid "Rename a volume group C<volgroup> with the new name C<newvolgroup>."
14412 #: ../fish/guestfish-actions.pod:4994
14417 #: ../fish/guestfish-actions.pod:4996
14425 #: ../fish/guestfish-actions.pod:4998 ../src/guestfs-actions.pod:7533
14427 "List all the volumes groups detected. This is the equivalent of the "
14428 "L<vgs(8)> command."
14432 #: ../fish/guestfish-actions.pod:5001 ../src/guestfs-actions.pod:7536
14434 "This returns a list of just the volume group names that were detected "
14435 "(eg. C<VolGroup00>)."
14439 #: ../fish/guestfish-actions.pod:5004
14440 msgid "See also L</vgs-full>."
14444 #: ../fish/guestfish-actions.pod:5006
14449 #: ../fish/guestfish-actions.pod:5008
14457 #: ../fish/guestfish-actions.pod:5010 ../src/guestfs-actions.pod:7552
14459 "List all the volumes groups detected. This is the equivalent of the "
14460 "L<vgs(8)> command. The \"full\" version includes all fields."
14464 #: ../fish/guestfish-actions.pod:5013
14469 #: ../fish/guestfish-actions.pod:5015
14477 #: ../fish/guestfish-actions.pod:5017 ../src/guestfs-actions.pod:7566
14479 "This rescans all block devices and rebuilds the list of LVM physical "
14480 "volumes, volume groups and logical volumes."
14484 #: ../fish/guestfish-actions.pod:5020
14489 #: ../fish/guestfish-actions.pod:5022
14497 #: ../fish/guestfish-actions.pod:5024 ../src/guestfs-actions.pod:7579
14498 msgid "This command returns the UUID of the LVM VG named C<vgname>."
14502 #: ../fish/guestfish-actions.pod:5026
14507 #: ../fish/guestfish-actions.pod:5028
14515 #: ../fish/guestfish-actions.pod:5030 ../src/guestfs-actions.pod:7619
14517 "This command counts the characters in a file, using the C<wc -c> external "
14522 #: ../fish/guestfish-actions.pod:5033
14527 #: ../fish/guestfish-actions.pod:5035
14535 #: ../fish/guestfish-actions.pod:5037 ../src/guestfs-actions.pod:7632
14537 "This command counts the lines in a file, using the C<wc -l> external "
14542 #: ../fish/guestfish-actions.pod:5040
14547 #: ../fish/guestfish-actions.pod:5042
14555 #: ../fish/guestfish-actions.pod:5044 ../src/guestfs-actions.pod:7645
14557 "This command counts the words in a file, using the C<wc -w> external "
14562 #: ../fish/guestfish-actions.pod:5047
14567 #: ../fish/guestfish-actions.pod:5049
14570 " write path content\n"
14575 #: ../fish/guestfish-actions.pod:5051 ../src/guestfs-actions.pod:7660
14577 "This call creates a file called C<path>. The content of the file is the "
14578 "string C<content> (which can contain any 8 bit data)."
14582 #: ../fish/guestfish-actions.pod:5054
14583 msgid "See also L</write-append>."
14587 #: ../fish/guestfish-actions.pod:5059
14588 msgid "write-append"
14592 #: ../fish/guestfish-actions.pod:5061
14595 " write-append path content\n"
14600 #: ../fish/guestfish-actions.pod:5063 ../src/guestfs-actions.pod:7680
14602 "This call appends C<content> to the end of file C<path>. If C<path> does "
14603 "not exist, then a new file is created."
14607 #: ../fish/guestfish-actions.pod:5066
14608 msgid "See also L</write>."
14612 #: ../fish/guestfish-actions.pod:5071
14617 #: ../fish/guestfish-actions.pod:5073
14620 " write-file path content size\n"
14625 #: ../fish/guestfish-actions.pod:5075 ../src/guestfs-actions.pod:7700
14627 "This call creates a file called C<path>. The contents of the file is the "
14628 "string C<content> (which can contain any 8 bit data), with length C<size>."
14632 #: ../fish/guestfish-actions.pod:5079 ../src/guestfs-actions.pod:7704
14634 "As a special case, if C<size> is C<0> then the length is calculated using "
14635 "C<strlen> (so in this case the content cannot contain embedded ASCII NULs)."
14639 #: ../fish/guestfish-actions.pod:5083 ../src/guestfs-actions.pod:7708
14641 "I<NB.> Owing to a bug, writing content containing ASCII NUL characters does "
14642 "I<not> work, even if the length is specified."
14646 #: ../fish/guestfish-actions.pod:5089
14647 msgid "This function is deprecated. In new code, use the L</write> call instead."
14651 #: ../fish/guestfish-actions.pod:5096
14656 #: ../fish/guestfish-actions.pod:5098
14659 " zegrep regex path\n"
14664 #: ../fish/guestfish-actions.pod:5100 ../src/guestfs-actions.pod:7732
14665 msgid "This calls the external C<zegrep> program and returns the matching lines."
14669 #: ../fish/guestfish-actions.pod:5106
14674 #: ../fish/guestfish-actions.pod:5108
14677 " zegrepi regex path\n"
14682 #: ../fish/guestfish-actions.pod:5110 ../src/guestfs-actions.pod:7751
14683 msgid "This calls the external C<zegrep -i> program and returns the matching lines."
14687 #: ../fish/guestfish-actions.pod:5116
14692 #: ../fish/guestfish-actions.pod:5118
14700 #: ../fish/guestfish-actions.pod:5120 ../src/guestfs-actions.pod:7769
14701 msgid "This command writes zeroes over the first few blocks of C<device>."
14705 #: ../fish/guestfish-actions.pod:5122 ../src/guestfs-actions.pod:7771
14707 "How many blocks are zeroed isn't specified (but it's I<not> enough to "
14708 "securely wipe the device). It should be sufficient to remove any partition "
14709 "tables, filesystem superblocks and so on."
14713 #: ../fish/guestfish-actions.pod:5126
14714 msgid "See also: L</zero-device>, L</scrub-device>, L</is-zero-device>"
14718 #: ../fish/guestfish-actions.pod:5129
14719 msgid "zero-device"
14723 #: ../fish/guestfish-actions.pod:5131
14726 " zero-device device\n"
14731 #: ../fish/guestfish-actions.pod:5133
14733 "This command writes zeroes over the entire C<device>. Compare with L</zero> "
14734 "which just zeroes the first few blocks of a device."
14738 #: ../fish/guestfish-actions.pod:5140
14743 #: ../fish/guestfish-actions.pod:5142
14746 " zerofree device\n"
14751 #: ../fish/guestfish-actions.pod:5144 ../src/guestfs-actions.pod:7815
14753 "This runs the I<zerofree> program on C<device>. This program claims to zero "
14754 "unused inodes and disk blocks on an ext2/3 filesystem, thus making it "
14755 "possible to compress the filesystem more effectively."
14759 #: ../fish/guestfish-actions.pod:5149 ../src/guestfs-actions.pod:7820
14760 msgid "You should B<not> run this program if the filesystem is mounted."
14764 #: ../fish/guestfish-actions.pod:5152 ../src/guestfs-actions.pod:7823
14766 "It is possible that using this program can damage the filesystem or data on "
14771 #: ../fish/guestfish-actions.pod:5155
14776 #: ../fish/guestfish-actions.pod:5157
14779 " zfgrep pattern path\n"
14784 #: ../fish/guestfish-actions.pod:5159 ../src/guestfs-actions.pod:7837
14785 msgid "This calls the external C<zfgrep> program and returns the matching lines."
14789 #: ../fish/guestfish-actions.pod:5165
14794 #: ../fish/guestfish-actions.pod:5167
14797 " zfgrepi pattern path\n"
14802 #: ../fish/guestfish-actions.pod:5169 ../src/guestfs-actions.pod:7856
14803 msgid "This calls the external C<zfgrep -i> program and returns the matching lines."
14807 #: ../fish/guestfish-actions.pod:5175
14812 #: ../fish/guestfish-actions.pod:5177
14815 " zfile meth path\n"
14820 #: ../fish/guestfish-actions.pod:5179 ../src/guestfs-actions.pod:7875
14821 msgid "This command runs C<file> after first decompressing C<path> using C<method>."
14825 #: ../fish/guestfish-actions.pod:5182 ../src/guestfs-actions.pod:7878
14826 msgid "C<method> must be one of C<gzip>, C<compress> or C<bzip2>."
14830 #: ../fish/guestfish-actions.pod:5184
14831 msgid "Since 1.0.63, use L</file> instead which can now process compressed files."
14835 #: ../fish/guestfish-actions.pod:5187
14836 msgid "This function is deprecated. In new code, use the L</file> call instead."
14840 #: ../fish/guestfish-actions.pod:5194
14845 #: ../fish/guestfish-actions.pod:5196
14848 " zgrep regex path\n"
14853 #: ../fish/guestfish-actions.pod:5198 ../src/guestfs-actions.pod:7902
14854 msgid "This calls the external C<zgrep> program and returns the matching lines."
14858 #: ../fish/guestfish-actions.pod:5204
14863 #: ../fish/guestfish-actions.pod:5206
14866 " zgrepi regex path\n"
14871 #: ../fish/guestfish-actions.pod:5208 ../src/guestfs-actions.pod:7921
14872 msgid "This calls the external C<zgrep -i> program and returns the matching lines."
14876 #: ../fish/guestfish-commands.pod:1
14881 #: ../fish/guestfish-commands.pod:3
14886 #: ../fish/guestfish-commands.pod:5
14889 " alloc filename size\n"
14894 #: ../fish/guestfish-commands.pod:7
14896 "This creates an empty (zeroed) file of the given size, and then adds so it "
14897 "can be further examined."
14901 #: ../fish/guestfish-commands.pod:10 ../fish/guestfish-commands.pod:182
14902 msgid "For more advanced image creation, see L<qemu-img(1)> utility."
14906 #: ../fish/guestfish-commands.pod:12 ../fish/guestfish-commands.pod:184
14907 msgid "Size can be specified using standard suffixes, eg. C<1M>."
14911 #: ../fish/guestfish-commands.pod:14
14913 "To create a sparse file, use L</sparse> instead. To create a prepared disk "
14914 "image, see L</PREPARED DISK IMAGES>."
14918 #: ../fish/guestfish-commands.pod:17
14923 #: ../fish/guestfish-commands.pod:19
14926 " copy-in local [local ...] /remotedir\n"
14931 #: ../fish/guestfish-commands.pod:21
14933 "C<copy-in> copies local files or directories recursively into the disk "
14934 "image, placing them in the directory called C</remotedir> (which must "
14935 "exist). This guestfish meta-command turns into a sequence of L</tar-in> and "
14936 "other commands as necessary."
14940 #: ../fish/guestfish-commands.pod:26
14942 "Multiple local files and directories can be specified, but the last "
14943 "parameter must always be a remote directory. Wildcards cannot be used."
14947 #: ../fish/guestfish-commands.pod:30
14952 #: ../fish/guestfish-commands.pod:32
14955 " copy-out remote [remote ...] localdir\n"
14960 #: ../fish/guestfish-commands.pod:34
14962 "C<copy-out> copies remote files or directories recursively out of the disk "
14963 "image, placing them on the host disk in a local directory called C<localdir> "
14964 "(which must exist). This guestfish meta-command turns into a sequence of "
14965 "L</download>, L</tar-out> and other commands as necessary."
14969 #: ../fish/guestfish-commands.pod:40
14971 "Multiple remote files and directories can be specified, but the last "
14972 "parameter must always be a local directory. To download to the current "
14973 "directory, use C<.> as in:"
14977 #: ../fish/guestfish-commands.pod:44
14980 " copy-out /home .\n"
14985 #: ../fish/guestfish-commands.pod:46
14987 "Wildcards cannot be used in the ordinary command, but you can use them with "
14988 "the help of L</glob> like this:"
14992 #: ../fish/guestfish-commands.pod:49
14995 " glob copy-out /home/* .\n"
15000 #: ../fish/guestfish-commands.pod:51
15005 #: ../fish/guestfish-commands.pod:53
15008 " display filename\n"
15013 #: ../fish/guestfish-commands.pod:55
15015 "Use C<display> (a graphical display program) to display an image file. It "
15016 "downloads the file, and runs C<display> on it."
15020 #: ../fish/guestfish-commands.pod:58
15022 "To use an alternative program, set the C<GUESTFISH_DISPLAY_IMAGE> "
15023 "environment variable. For example to use the GNOME display program:"
15027 #: ../fish/guestfish-commands.pod:61
15030 " export GUESTFISH_DISPLAY_IMAGE=eog\n"
15035 #: ../fish/guestfish-commands.pod:63
15036 msgid "See also L<display(1)>."
15040 #: ../fish/guestfish-commands.pod:65
15045 #: ../fish/guestfish-commands.pod:67
15048 " echo [params ...]\n"
15053 #: ../fish/guestfish-commands.pod:69
15054 msgid "This echos the parameters to the terminal."
15058 #: ../fish/guestfish-commands.pod:71
15063 #: ../fish/guestfish-commands.pod:73
15068 #: ../fish/guestfish-commands.pod:75
15073 #: ../fish/guestfish-commands.pod:77
15081 #: ../fish/guestfish-commands.pod:79
15083 "This is used to edit a file. It downloads the file, edits it locally using "
15084 "your editor, then uploads the result."
15088 #: ../fish/guestfish-commands.pod:82
15090 "The editor is C<$EDITOR>. However if you use the alternate commands C<vi> "
15091 "or C<emacs> you will get those corresponding editors."
15095 #: ../fish/guestfish-commands.pod:86
15100 #: ../fish/guestfish-commands.pod:88
15103 " glob command args...\n"
15108 #: ../fish/guestfish-commands.pod:90
15110 "Expand wildcards in any paths in the args list, and run C<command> "
15111 "repeatedly on each matching path."
15115 #: ../fish/guestfish-commands.pod:93
15116 msgid "See L</WILDCARDS AND GLOBBING>."
15120 #: ../fish/guestfish-commands.pod:95
15125 #: ../fish/guestfish-commands.pod:97
15128 " hexedit <filename|device>\n"
15129 " hexedit <filename|device> <max>\n"
15130 " hexedit <filename|device> <start> <max>\n"
15135 #: ../fish/guestfish-commands.pod:101
15137 "Use hexedit (a hex editor) to edit all or part of a binary file or block "
15142 #: ../fish/guestfish-commands.pod:104
15144 "This command works by downloading potentially the whole file or device, "
15145 "editing it locally, then uploading it. If the file or device is large, you "
15146 "have to specify which part you wish to edit by using C<max> and/or C<start> "
15147 "C<max> parameters. C<start> and C<max> are specified in bytes, with the "
15148 "usual modifiers allowed such as C<1M> (1 megabyte)."
15152 #: ../fish/guestfish-commands.pod:111
15153 msgid "For example to edit the first few sectors of a disk you might do:"
15157 #: ../fish/guestfish-commands.pod:114
15160 " hexedit /dev/sda 1M\n"
15165 #: ../fish/guestfish-commands.pod:116
15167 "which would allow you to edit anywhere within the first megabyte of the "
15172 #: ../fish/guestfish-commands.pod:119
15173 msgid "To edit the superblock of an ext2 filesystem on C</dev/sda1>, do:"
15177 #: ../fish/guestfish-commands.pod:121
15180 " hexedit /dev/sda1 0x400 0x400\n"
15185 #: ../fish/guestfish-commands.pod:123
15186 msgid "(assuming the superblock is in the standard location)."
15190 #: ../fish/guestfish-commands.pod:125
15192 "This command requires the external L<hexedit(1)> program. You can specify "
15193 "another program to use by setting the C<HEXEDITOR> environment variable."
15197 #: ../fish/guestfish-commands.pod:129
15198 msgid "See also L</hexdump>."
15202 #: ../fish/guestfish-commands.pod:131
15207 #: ../fish/guestfish-commands.pod:133
15215 #: ../fish/guestfish-commands.pod:135
15216 msgid "Change the local directory, ie. the current directory of guestfish itself."
15220 #: ../fish/guestfish-commands.pod:138
15221 msgid "Note that C<!cd> won't do what you might expect."
15225 #: ../fish/guestfish-commands.pod:140
15230 #: ../fish/guestfish-commands.pod:142
15235 #: ../fish/guestfish-commands.pod:144
15243 #: ../fish/guestfish-commands.pod:146
15244 msgid "Opens the manual page for guestfish."
15248 #: ../fish/guestfish-commands.pod:148
15253 #: ../fish/guestfish-commands.pod:150
15258 #: ../fish/guestfish-commands.pod:152
15266 #: ../fish/guestfish-commands.pod:154
15274 #: ../fish/guestfish-commands.pod:156
15275 msgid "This is used to view a file."
15279 #: ../fish/guestfish-commands.pod:158
15281 "The default viewer is C<$PAGER>. However if you use the alternate command "
15282 "C<less> you will get the C<less> command specifically."
15286 #: ../fish/guestfish-commands.pod:161
15291 #: ../fish/guestfish-commands.pod:163
15299 #: ../fish/guestfish-commands.pod:165
15301 "Close and reopen the libguestfs handle. It is not necessary to use this "
15302 "normally, because the handle is closed properly when guestfish exits. "
15303 "However this is occasionally useful for testing."
15307 #: ../fish/guestfish-commands.pod:169
15312 #: ../fish/guestfish-commands.pod:171
15315 " sparse filename size\n"
15320 #: ../fish/guestfish-commands.pod:173
15322 "This creates an empty sparse file of the given size, and then adds so it can "
15323 "be further examined."
15327 #: ../fish/guestfish-commands.pod:176
15329 "In all respects it works the same as the L</alloc> command, except that the "
15330 "image file is allocated sparsely, which means that disk blocks are not "
15331 "assigned to the file until they are needed. Sparse disk files only use "
15332 "space when written to, but they are slower and there is a danger you could "
15333 "run out of real disk space during a write operation."
15337 #: ../fish/guestfish-commands.pod:186
15342 #: ../fish/guestfish-commands.pod:188
15350 #: ../fish/guestfish-commands.pod:190
15352 "This command returns a list of the optional groups known to the daemon, and "
15353 "indicates which ones are supported by this build of the libguestfs "
15358 #: ../fish/guestfish-commands.pod:194
15359 msgid "See also L<guestfs(3)/AVAILABILITY>."
15363 #: ../fish/guestfish-commands.pod:196
15368 #: ../fish/guestfish-commands.pod:198
15371 " time command args...\n"
15376 #: ../fish/guestfish-commands.pod:200
15378 "Run the command as usual, but print the elapsed time afterwards. This can "
15379 "be useful for benchmarking operations."
15383 #: ../fish/guestfish.pod:5
15384 msgid "guestfish - the libguestfs Filesystem Interactive SHell"
15388 #: ../fish/guestfish.pod:9
15391 " guestfish [--options] [commands]\n"
15396 #: ../fish/guestfish.pod:11
15404 #: ../fish/guestfish.pod:13
15407 " guestfish [--ro|--rw] -a disk.img\n"
15412 #: ../fish/guestfish.pod:15
15415 " guestfish [--ro|--rw] -a disk.img -m dev[:mountpoint]\n"
15420 #: ../fish/guestfish.pod:17
15423 " guestfish -d libvirt-domain\n"
15428 #: ../fish/guestfish.pod:19
15431 " guestfish [--ro|--rw] -a disk.img -i\n"
15436 #: ../fish/guestfish.pod:21
15439 " guestfish -d libvirt-domain -i\n"
15444 #: ../fish/guestfish.pod:25
15446 "Using guestfish in read/write mode on live virtual machines can be "
15447 "dangerous, potentially causing disk corruption. Use the I<--ro> (read-only) "
15448 "option to use guestfish safely if the disk image or virtual machine might be "
15453 #: ../fish/guestfish.pod:32
15455 "Guestfish is a shell and command-line tool for examining and modifying "
15456 "virtual machine filesystems. It uses libguestfs and exposes all of the "
15457 "functionality of the guestfs API, see L<guestfs(3)>."
15461 #: ../fish/guestfish.pod:36
15463 "Guestfish gives you structured access to the libguestfs API, from shell "
15464 "scripts or the command line or interactively. If you want to rescue a "
15465 "broken virtual machine image, you should look at the L<virt-rescue(1)> "
15470 #: ../fish/guestfish.pod:43
15471 msgid "As an interactive shell"
15475 #: ../fish/guestfish.pod:45
15483 #: ../fish/guestfish.pod:47
15486 " Welcome to guestfish, the libguestfs filesystem interactive shell for\n"
15487 " editing virtual machine filesystems.\n"
15492 #: ../fish/guestfish.pod:50
15495 " Type: 'help' for a list of commands\n"
15496 " 'man' to read the manual\n"
15497 " 'quit' to quit the shell\n"
15502 #: ../fish/guestfish.pod:54
15505 " ><fs> add-ro disk.img\n"
15507 " ><fs> list-filesystems\n"
15508 " /dev/sda1: ext4\n"
15509 " /dev/vg_guest/lv_root: ext4\n"
15510 " /dev/vg_guest/lv_swap: swap\n"
15511 " ><fs> mount /dev/vg_guest/lv_root /\n"
15512 " ><fs> cat /etc/fstab\n"
15514 " # Created by anaconda\n"
15521 #: ../fish/guestfish.pod:67
15522 msgid "From shell scripts"
15526 #: ../fish/guestfish.pod:69
15527 msgid "Create a new C</etc/motd> file in a guest or disk image:"
15531 #: ../fish/guestfish.pod:71
15534 " guestfish <<_EOF_\n"
15537 " mount /dev/vg_guest/lv_root /\n"
15538 " write /etc/motd \"Welcome, new users\"\n"
15544 #: ../fish/guestfish.pod:78
15545 msgid "List the LVM logical volumes in a disk image:"
15549 #: ../fish/guestfish.pod:80
15552 " guestfish -a disk.img --ro <<_EOF_\n"
15560 #: ../fish/guestfish.pod:85
15561 msgid "List all the filesystems in a disk image:"
15565 #: ../fish/guestfish.pod:87
15568 " guestfish -a disk.img --ro <<_EOF_\n"
15570 " list-filesystems\n"
15576 #: ../fish/guestfish.pod:92
15577 msgid "On one command line"
15581 #: ../fish/guestfish.pod:94 ../fish/virt-copy-in.pod:31
15582 msgid "Update C</etc/resolv.conf> in a guest:"
15586 #: ../fish/guestfish.pod:96
15590 " add disk.img : run : mount /dev/vg_guest/lv_root / : \\\n"
15591 " write /etc/resolv.conf \"nameserver 1.2.3.4\"\n"
15596 #: ../fish/guestfish.pod:100
15597 msgid "Edit C</boot/grub/grub.conf> interactively:"
15601 #: ../fish/guestfish.pod:102
15604 " guestfish --rw --add disk.img \\\n"
15605 " --mount /dev/vg_guest/lv_root \\\n"
15606 " --mount /dev/sda1:/boot \\\n"
15607 " edit /boot/grub/grub.conf\n"
15612 #: ../fish/guestfish.pod:107
15613 msgid "Mount disks automatically"
15617 #: ../fish/guestfish.pod:109
15619 "Use the I<-i> option to automatically mount the disks from a virtual "
15624 #: ../fish/guestfish.pod:112
15627 " guestfish --ro -a disk.img -i cat /etc/group\n"
15632 #: ../fish/guestfish.pod:114
15635 " guestfish --ro -d libvirt-domain -i cat /etc/group\n"
15640 #: ../fish/guestfish.pod:116
15641 msgid "Another way to edit C</boot/grub/grub.conf> interactively is:"
15645 #: ../fish/guestfish.pod:118
15648 " guestfish --rw -a disk.img -i edit /boot/grub/grub.conf\n"
15653 #: ../fish/guestfish.pod:120
15654 msgid "As a script interpreter"
15658 #: ../fish/guestfish.pod:122
15659 msgid "Create a 100MB disk containing an ext2-formatted partition:"
15663 #: ../fish/guestfish.pod:124
15666 " #!/usr/bin/guestfish -f\n"
15667 " sparse test1.img 100M\n"
15669 " part-disk /dev/sda mbr\n"
15670 " mkfs ext2 /dev/sda1\n"
15675 #: ../fish/guestfish.pod:130
15676 msgid "Start with a prepared disk"
15680 #: ../fish/guestfish.pod:132
15682 "An alternate way to create a 100MB disk called C<test1.img> containing a "
15683 "single ext2-formatted partition:"
15687 #: ../fish/guestfish.pod:135
15690 " guestfish -N fs\n"
15695 #: ../fish/guestfish.pod:137
15696 msgid "To list what is available do:"
15700 #: ../fish/guestfish.pod:139 ../fish/guestfish.pod:1009
15703 " guestfish -N help | less\n"
15708 #: ../fish/guestfish.pod:141
15709 msgid "Remote control"
15713 #: ../fish/guestfish.pod:143
15716 " eval \"`guestfish --listen`\"\n"
15717 " guestfish --remote add-ro disk.img\n"
15718 " guestfish --remote run\n"
15719 " guestfish --remote lvs\n"
15724 #: ../fish/guestfish.pod:154
15725 msgid "Displays general help on options."
15729 #: ../fish/guestfish.pod:158
15730 msgid "B<--cmd-help>"
15734 #: ../fish/guestfish.pod:160
15735 msgid "Lists all available guestfish commands."
15739 #: ../fish/guestfish.pod:162
15744 #: ../fish/guestfish.pod:164
15745 msgid "B<--cmd-help cmd>"
15749 #: ../fish/guestfish.pod:166
15750 msgid "Displays detailed help on a single command C<cmd>."
15754 #: ../fish/guestfish.pod:168 ../fuse/guestmount.pod:87
15755 msgid "B<-a image>"
15759 #: ../fish/guestfish.pod:170 ../fuse/guestmount.pod:89
15760 msgid "B<--add image>"
15764 #: ../fish/guestfish.pod:172
15765 msgid "Add a block device or virtual machine image to the shell."
15769 #: ../fish/guestfish.pod:177
15771 "Using this flag is mostly equivalent to using the C<add> command, with "
15772 "C<readonly:true> if the I<--ro> flag was given, and with C<format:...> if "
15773 "the I<--format=...> flag was given."
15777 #: ../fish/guestfish.pod:185 ../fuse/guestmount.pod:100
15779 "When used in conjunction with the I<-d> option, this specifies the libvirt "
15780 "URI to use. The default is to use the default libvirt connection."
15784 #: ../fish/guestfish.pod:189
15789 #: ../fish/guestfish.pod:191
15791 "If using the I<--listen> option and a csh-like shell, use this option. See "
15792 "section L</REMOTE CONTROL AND CSH> below."
15796 #: ../fish/guestfish.pod:194 ../fuse/guestmount.pod:104
15797 msgid "B<-d libvirt-domain>"
15801 #: ../fish/guestfish.pod:196 ../fuse/guestmount.pod:106
15802 msgid "B<--domain libvirt-domain>"
15806 #: ../fish/guestfish.pod:198 ../fuse/guestmount.pod:108
15808 "Add disks from the named libvirt domain. If the I<--ro> option is also "
15809 "used, then any libvirt domain can be used. However in write mode, only "
15810 "libvirt domains which are shut down can be named here."
15814 #: ../fish/guestfish.pod:202 ../fuse/guestmount.pod:112
15815 msgid "Domain UUIDs can be used instead of names."
15819 #: ../fish/guestfish.pod:204
15821 "Using this flag is mostly equivalent to using the C<add-domain> command, "
15822 "with C<readonly:true> if the I<--ro> flag was given, and with C<format:...> "
15823 "if the I<--format:...> flag was given."
15827 #: ../fish/guestfish.pod:208
15832 #: ../fish/guestfish.pod:210
15833 msgid "B<--no-dest-paths>"
15837 #: ../fish/guestfish.pod:212
15839 "Don't tab-complete paths on the guest filesystem. It is useful to be able "
15840 "to hit the tab key to complete paths on the guest filesystem, but this "
15841 "causes extra \"hidden\" guestfs calls to be made, so this option is here to "
15842 "allow this feature to be disabled."
15846 #: ../fish/guestfish.pod:219 ../fuse/guestmount.pod:128
15848 "When prompting for keys and passphrases, guestfish normally turns echoing "
15849 "off so you cannot see what you are typing. If you are not worried about "
15850 "Tempest attacks and there is no one else in the room you can specify this "
15851 "flag to see what you are typing."
15855 #: ../fish/guestfish.pod:224
15860 #: ../fish/guestfish.pod:226
15861 msgid "B<--file file>"
15865 #: ../fish/guestfish.pod:228
15866 msgid "Read commands from C<file>. To write pure guestfish scripts, use:"
15870 #: ../fish/guestfish.pod:231
15873 " #!/usr/bin/guestfish -f\n"
15878 #: ../fish/guestfish.pod:244
15881 " guestfish --format=raw -a disk.img\n"
15886 #: ../fish/guestfish.pod:248
15889 " guestfish --format=raw -a disk.img --format -a another.img\n"
15894 #: ../fish/guestfish.pod:253
15896 "If you have untrusted raw-format guest disk images, you should use this "
15897 "option to specify the disk format. This avoids a possible security problem "
15898 "with malicious guests (CVE-2010-3851). See also L</add-drive-opts>."
15902 #: ../fish/guestfish.pod:260 ../fuse/guestmount.pod:157
15903 msgid "B<--inspector>"
15907 #: ../fish/guestfish.pod:262 ../fuse/guestmount.pod:159
15909 "Using L<virt-inspector(1)> code, inspect the disks looking for an operating "
15910 "system and mount filesystems as they would be mounted on the real virtual "
15915 #: ../fish/guestfish.pod:266
15916 msgid "Typical usage is either:"
15920 #: ../fish/guestfish.pod:268
15923 " guestfish -d myguest -i\n"
15928 #: ../fish/guestfish.pod:270
15929 msgid "(for an inactive libvirt domain called I<myguest>), or:"
15933 #: ../fish/guestfish.pod:272
15936 " guestfish --ro -d myguest -i\n"
15941 #: ../fish/guestfish.pod:274
15942 msgid "(for active domains, readonly), or specify the block device directly:"
15946 #: ../fish/guestfish.pod:276
15949 " guestfish --rw -a /dev/Guests/MyGuest -i\n"
15954 #: ../fish/guestfish.pod:278
15956 "Note that the command line syntax changed slightly over older versions of "
15957 "guestfish. You can still use the old syntax:"
15961 #: ../fish/guestfish.pod:281
15964 " guestfish [--ro] -i disk.img\n"
15969 #: ../fish/guestfish.pod:283
15972 " guestfish [--ro] -i libvirt-domain\n"
15977 #: ../fish/guestfish.pod:285
15979 "Using this flag is mostly equivalent to using the C<inspect-os> command and "
15980 "then using other commands to mount the filesystems that were found."
15984 #: ../fish/guestfish.pod:294
15985 msgid "B<--listen>"
15989 #: ../fish/guestfish.pod:296
15991 "Fork into the background and listen for remote commands. See section "
15992 "L</REMOTE CONTROL GUESTFISH OVER A SOCKET> below."
15996 #: ../fish/guestfish.pod:299 ../fuse/guestmount.pod:168
16001 #: ../fish/guestfish.pod:301 ../fuse/guestmount.pod:170
16003 "Connect to a live virtual machine. (Experimental, see "
16004 "L<guestfs(3)/ATTACHING TO RUNNING DAEMONS>)."
16008 #: ../fish/guestfish.pod:304 ../fuse/guestmount.pod:173
16009 msgid "B<-m dev[:mountpoint[:options]]>"
16013 #: ../fish/guestfish.pod:306 ../fuse/guestmount.pod:175
16014 msgid "B<--mount dev[:mountpoint[:options]]>"
16018 #: ../fish/guestfish.pod:308
16019 msgid "Mount the named partition or logical volume on the given mountpoint."
16023 #: ../fish/guestfish.pod:310
16024 msgid "If the mountpoint is omitted, it defaults to C</>."
16028 #: ../fish/guestfish.pod:312
16029 msgid "You have to mount something on C</> before most commands will work."
16033 #: ../fish/guestfish.pod:314
16035 "If any I<-m> or I<--mount> options are given, the guest is automatically "
16040 #: ../fish/guestfish.pod:317
16042 "If you don't know what filesystems a disk image contains, you can either run "
16043 "guestfish without this option, then list the partitions, filesystems and LVs "
16044 "available (see L</list-partitions>, L</list-filesystems> and L</lvs> "
16045 "commands), or you can use the L<virt-filesystems(1)> program."
16049 #: ../fish/guestfish.pod:323 ../fuse/guestmount.pod:183
16051 "The third (and rarely used) part of the mount parameter is the list of mount "
16052 "options used to mount the underlying filesystem. If this is not given, then "
16053 "the mount options are either the empty string or C<ro> (the latter if the "
16054 "I<--ro> flag is used). By specifying the mount options, you override this "
16055 "default choice. Probably the only time you would use this is to enable ACLs "
16056 "and/or extended attributes if the filesystem can support them:"
16060 #: ../fish/guestfish.pod:331 ../fuse/guestmount.pod:191
16063 " -m /dev/sda1:/:acl,user_xattr\n"
16068 #: ../fish/guestfish.pod:333
16069 msgid "Using this flag is equivalent to using the C<mount-options> command."
16073 #: ../fish/guestfish.pod:335 ../fuse/guestmount.pod:193 ../resize/virt-resize.pod:352
16078 #: ../fish/guestfish.pod:337 ../fuse/guestmount.pod:195
16079 msgid "B<--no-sync>"
16083 #: ../fish/guestfish.pod:339
16085 "Disable autosync. This is enabled by default. See the discussion of "
16086 "autosync in the L<guestfs(3)> manpage."
16090 #: ../fish/guestfish.pod:342
16095 #: ../fish/guestfish.pod:344
16096 msgid "B<--new type>"
16100 #: ../fish/guestfish.pod:346
16105 #: ../fish/guestfish.pod:348
16107 "Prepare a fresh disk image formatted as \"type\". This is an alternative to "
16108 "the I<-a> option: whereas I<-a> adds an existing disk, I<-N> creates a "
16109 "preformatted disk with a filesystem and adds it. See L</PREPARED DISK "
16114 #: ../fish/guestfish.pod:353
16115 msgid "B<--progress-bars>"
16119 #: ../fish/guestfish.pod:355
16120 msgid "Enable progress bars, even when guestfish is used non-interactively."
16124 #: ../fish/guestfish.pod:357
16126 "Progress bars are enabled by default when guestfish is used as an "
16127 "interactive shell."
16131 #: ../fish/guestfish.pod:360
16132 msgid "B<--no-progress-bars>"
16136 #: ../fish/guestfish.pod:362
16137 msgid "Disable progress bars."
16141 #: ../fish/guestfish.pod:364
16142 msgid "B<--remote[=pid]>"
16146 #: ../fish/guestfish.pod:366
16148 "Send remote commands to C<$GUESTFISH_PID> or C<pid>. See section L</REMOTE "
16149 "CONTROL GUESTFISH OVER A SOCKET> below."
16153 #: ../fish/guestfish.pod:369 ../fuse/guestmount.pod:239 ../rescue/virt-rescue.pod:161
16158 #: ../fish/guestfish.pod:371 ../fuse/guestmount.pod:241 ../rescue/virt-rescue.pod:163
16163 #: ../fish/guestfish.pod:373
16165 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16166 "mounts are done read-only."
16170 #: ../fish/guestfish.pod:376 ../rescue/virt-rescue.pod:167
16172 "The option must always be used if the disk image or virtual machine might be "
16173 "running, and is generally recommended in cases where you don't need write "
16174 "access to the disk."
16178 #: ../fish/guestfish.pod:380
16180 "Note that prepared disk images created with I<-N> are not affected by this "
16181 "option. Also commands like C<add> are not affected - you have to specify "
16182 "the C<readonly:true> option explicitly if you need it."
16186 #: ../fish/guestfish.pod:384
16187 msgid "See also L</OPENING DISKS FOR READ AND WRITE> below."
16191 #: ../fish/guestfish.pod:386 ../fuse/guestmount.pod:253 ../rescue/virt-rescue.pod:173
16192 msgid "B<--selinux>"
16196 #: ../fish/guestfish.pod:388
16197 msgid "Enable SELinux support for the guest. See L<guestfs(3)/SELINUX>."
16201 #: ../fish/guestfish.pod:394
16203 "Enable very verbose messages. This is particularly useful if you find a "
16208 #: ../fish/guestfish.pod:401
16209 msgid "Display the guestfish / libguestfs version number and exit."
16213 #: ../fish/guestfish.pod:403 ../fuse/guestmount.pod:269 ../rescue/virt-rescue.pod:190
16218 #: ../fish/guestfish.pod:405 ../fuse/guestmount.pod:271 ../rescue/virt-rescue.pod:192
16223 #: ../fish/guestfish.pod:407 ../fuse/guestmount.pod:273
16225 "This changes the I<-a>, I<-d> and I<-m> options so that disks are added and "
16226 "mounts are done read-write."
16230 #: ../fish/guestfish.pod:410
16231 msgid "See L</OPENING DISKS FOR READ AND WRITE> below."
16235 #: ../fish/guestfish.pod:414
16236 msgid "Echo each command before executing it."
16240 #: ../fish/guestfish.pod:418
16241 msgid "COMMANDS ON COMMAND LINE"
16245 #: ../fish/guestfish.pod:420
16246 msgid "Any additional (non-option) arguments are treated as commands to execute."
16250 #: ../fish/guestfish.pod:423
16252 "Commands to execute should be separated by a colon (C<:>), where the colon "
16253 "is a separate parameter. Thus:"
16257 #: ../fish/guestfish.pod:426
16260 " guestfish cmd [args...] : cmd [args...] : cmd [args...] ...\n"
16265 #: ../fish/guestfish.pod:428
16267 "If there are no additional arguments, then we enter a shell, either an "
16268 "interactive shell with a prompt (if the input is a terminal) or a "
16269 "non-interactive shell."
16273 #: ../fish/guestfish.pod:432
16275 "In either command line mode or non-interactive shell, the first command that "
16276 "gives an error causes the whole shell to exit. In interactive mode (with a "
16277 "prompt) if a command fails, you can continue to enter commands."
16281 #: ../fish/guestfish.pod:437
16282 msgid "USING launch (OR run)"
16286 #: ../fish/guestfish.pod:439
16288 "As with L<guestfs(3)>, you must first configure your guest by adding disks, "
16289 "then launch it, then mount any disks you need, and finally issue "
16290 "actions/commands. So the general order of the day is:"
16294 #: ../fish/guestfish.pod:447
16295 msgid "add or -a/--add"
16299 #: ../fish/guestfish.pod:451
16300 msgid "launch (aka run)"
16304 #: ../fish/guestfish.pod:455
16305 msgid "mount or -m/--mount"
16309 #: ../fish/guestfish.pod:459
16310 msgid "any other commands"
16314 #: ../fish/guestfish.pod:463
16316 "C<run> is a synonym for C<launch>. You must C<launch> (or C<run>) your "
16317 "guest before mounting or performing any other commands."
16321 #: ../fish/guestfish.pod:466
16323 "The only exception is that if any of the I<-i>, I<-m>, I<--mount>, I<-N> or "
16324 "I<--new> options were given then C<run> is done automatically, simply "
16325 "because guestfish can't perform the action you asked for without doing this."
16329 #: ../fish/guestfish.pod:471
16330 msgid "OPENING DISKS FOR READ AND WRITE"
16334 #: ../fish/guestfish.pod:473
16336 "The guestfish, L<guestmount(1)> and L<virt-rescue(1)> options I<--ro> and "
16337 "I<--rw> affect whether the other command line options I<-a>, I<-c>, I<-d>, "
16338 "I<-i> and I<-m> open disk images read-only or for writing."
16342 #: ../fish/guestfish.pod:478
16344 "In libguestfs E<le> 1.10, guestfish, guestmount and virt-rescue defaulted to "
16345 "opening disk images supplied on the command line for write. To open a disk "
16346 "image read-only you have to do I<-a image --ro>."
16350 #: ../fish/guestfish.pod:482
16352 "This matters: If you accidentally open a live VM disk image writable then "
16353 "you will cause irreversible disk corruption."
16357 #: ../fish/guestfish.pod:485
16359 "In a future libguestfs we intend to change the default the other way. Disk "
16360 "images will be opened read-only. You will have to either specify "
16361 "I<guestfish --rw>, I<guestmount --rw>, I<virt-rescue --rw>, or change the "
16362 "configuration file C</etc/libguestfs-tools.conf> in order to get write "
16363 "access for disk images specified by those other command line options."
16367 #: ../fish/guestfish.pod:492
16369 "This version of guestfish, guestmount and virt-rescue has a I<--rw> option "
16370 "which does nothing (it is already the default). However it is highly "
16371 "recommended that you use this option to indicate that you need write access, "
16372 "and prepare your scripts for the day when this option will be required for "
16377 #: ../fish/guestfish.pod:498
16379 "B<Note:> This does I<not> affect commands like L</add> and L</mount>, or any "
16380 "other libguestfs program apart from guestfish and guestmount."
16384 #: ../fish/guestfish.pod:501
16389 #: ../fish/guestfish.pod:503
16391 "You can quote ordinary parameters using either single or double quotes. For "
16396 #: ../fish/guestfish.pod:506
16399 " add \"file with a space.img\"\n"
16404 #: ../fish/guestfish.pod:508
16407 " rm '/file name'\n"
16412 #: ../fish/guestfish.pod:510
16420 #: ../fish/guestfish.pod:512
16422 "A few commands require a list of strings to be passed. For these, use a "
16423 "whitespace-separated list, enclosed in quotes. Strings containing "
16424 "whitespace to be passed through must be enclosed in single quotes. A "
16425 "literal single quote must be escaped with a backslash."
16429 #: ../fish/guestfish.pod:517
16432 " vgcreate VG \"/dev/sda1 /dev/sdb1\"\n"
16433 " command \"/bin/echo 'foo bar'\"\n"
16434 " command \"/bin/echo \\'foo\\'\"\n"
16439 #: ../fish/guestfish.pod:521
16440 msgid "ESCAPE SEQUENCES IN DOUBLE QUOTED ARGUMENTS"
16444 #: ../fish/guestfish.pod:523
16446 "In double-quoted arguments (only) use backslash to insert special "
16451 #: ../fish/guestfish.pod:528
16456 #: ../fish/guestfish.pod:530
16457 msgid "Alert (bell) character."
16461 #: ../fish/guestfish.pod:532
16466 #: ../fish/guestfish.pod:534
16467 msgid "Backspace character."
16471 #: ../fish/guestfish.pod:536
16476 #: ../fish/guestfish.pod:538
16477 msgid "Form feed character."
16481 #: ../fish/guestfish.pod:540
16486 #: ../fish/guestfish.pod:542
16487 msgid "Newline character."
16491 #: ../fish/guestfish.pod:544
16496 #: ../fish/guestfish.pod:546
16497 msgid "Carriage return character."
16501 #: ../fish/guestfish.pod:548
16506 #: ../fish/guestfish.pod:550
16507 msgid "Horizontal tab character."
16511 #: ../fish/guestfish.pod:552
16516 #: ../fish/guestfish.pod:554
16517 msgid "Vertical tab character."
16521 #: ../fish/guestfish.pod:556
16526 #: ../fish/guestfish.pod:558
16527 msgid "A literal double quote character."
16531 #: ../fish/guestfish.pod:560
16536 #: ../fish/guestfish.pod:562
16538 "A character with octal value I<ooo>. There must be precisely 3 octal digits "
16543 #: ../fish/guestfish.pod:565
16548 #: ../fish/guestfish.pod:567
16549 msgid "A character with hex value I<hh>. There must be precisely 2 hex digits."
16553 #: ../fish/guestfish.pod:570
16555 "In the current implementation C<\\000> and C<\\x00> cannot be used in "
16560 #: ../fish/guestfish.pod:573
16565 #: ../fish/guestfish.pod:575
16566 msgid "A literal backslash character."
16570 #: ../fish/guestfish.pod:579
16571 msgid "OPTIONAL ARGUMENTS"
16575 #: ../fish/guestfish.pod:581
16577 "Some commands take optional arguments. These arguments appear in this "
16578 "documentation as C<[argname:..]>. You can use them as in these examples:"
16582 #: ../fish/guestfish.pod:585
16585 " add-drive-opts filename\n"
16590 #: ../fish/guestfish.pod:587
16593 " add-drive-opts filename readonly:true\n"
16598 #: ../fish/guestfish.pod:589
16601 " add-drive-opts filename format:qcow2 readonly:false\n"
16606 #: ../fish/guestfish.pod:591
16608 "Each optional argument can appear at most once. All optional arguments must "
16609 "appear after the required ones."
16613 #: ../fish/guestfish.pod:594
16618 #: ../fish/guestfish.pod:596
16619 msgid "This section applies to all commands which can take integers as parameters."
16623 #: ../fish/guestfish.pod:599
16624 msgid "SIZE SUFFIX"
16628 #: ../fish/guestfish.pod:601
16630 "When the command takes a parameter measured in bytes, you can use one of the "
16631 "following suffixes to specify kilobytes, megabytes and larger sizes:"
16635 #: ../fish/guestfish.pod:607
16636 msgid "B<k> or B<K> or B<KiB>"
16640 #: ../fish/guestfish.pod:609
16641 msgid "The size in kilobytes (multiplied by 1024)."
16645 #: ../fish/guestfish.pod:611
16650 #: ../fish/guestfish.pod:613
16651 msgid "The size in SI 1000 byte units."
16655 #: ../fish/guestfish.pod:615
16656 msgid "B<M> or B<MiB>"
16660 #: ../fish/guestfish.pod:617
16661 msgid "The size in megabytes (multiplied by 1048576)."
16665 #: ../fish/guestfish.pod:619
16670 #: ../fish/guestfish.pod:621
16671 msgid "The size in SI 1000000 byte units."
16675 #: ../fish/guestfish.pod:623
16676 msgid "B<G> or B<GiB>"
16680 #: ../fish/guestfish.pod:625
16681 msgid "The size in gigabytes (multiplied by 2**30)."
16685 #: ../fish/guestfish.pod:627
16690 #: ../fish/guestfish.pod:629
16691 msgid "The size in SI 10**9 byte units."
16695 #: ../fish/guestfish.pod:631
16696 msgid "B<T> or B<TiB>"
16700 #: ../fish/guestfish.pod:633
16701 msgid "The size in terabytes (multiplied by 2**40)."
16705 #: ../fish/guestfish.pod:635
16710 #: ../fish/guestfish.pod:637
16711 msgid "The size in SI 10**12 byte units."
16715 #: ../fish/guestfish.pod:639
16716 msgid "B<P> or B<PiB>"
16720 #: ../fish/guestfish.pod:641
16721 msgid "The size in petabytes (multiplied by 2**50)."
16725 #: ../fish/guestfish.pod:643
16730 #: ../fish/guestfish.pod:645
16731 msgid "The size in SI 10**15 byte units."
16735 #: ../fish/guestfish.pod:647
16736 msgid "B<E> or B<EiB>"
16740 #: ../fish/guestfish.pod:649
16741 msgid "The size in exabytes (multiplied by 2**60)."
16745 #: ../fish/guestfish.pod:651
16750 #: ../fish/guestfish.pod:653
16751 msgid "The size in SI 10**18 byte units."
16755 #: ../fish/guestfish.pod:655
16756 msgid "B<Z> or B<ZiB>"
16760 #: ../fish/guestfish.pod:657
16761 msgid "The size in zettabytes (multiplied by 2**70)."
16765 #: ../fish/guestfish.pod:659
16770 #: ../fish/guestfish.pod:661
16771 msgid "The size in SI 10**21 byte units."
16775 #: ../fish/guestfish.pod:663
16776 msgid "B<Y> or B<YiB>"
16780 #: ../fish/guestfish.pod:665
16781 msgid "The size in yottabytes (multiplied by 2**80)."
16785 #: ../fish/guestfish.pod:667
16790 #: ../fish/guestfish.pod:669
16791 msgid "The size in SI 10**24 byte units."
16795 #: ../fish/guestfish.pod:675
16798 " truncate-size /file 1G\n"
16803 #: ../fish/guestfish.pod:677
16804 msgid "would truncate the file to 1 gigabyte."
16808 #: ../fish/guestfish.pod:679
16810 "Be careful because a few commands take sizes in kilobytes or megabytes "
16811 "(eg. the parameter to L</memsize> is specified in megabytes already). "
16812 "Adding a suffix will probably not do what you expect."
16816 #: ../fish/guestfish.pod:683
16817 msgid "OCTAL AND HEXADECIMAL NUMBERS"
16821 #: ../fish/guestfish.pod:685
16823 "For specifying the radix (base) use the C convention: C<0> to prefix an "
16824 "octal number or C<0x> to prefix a hexadecimal number. For example:"
16828 #: ../fish/guestfish.pod:688
16831 " 1234 decimal number 1234\n"
16832 " 02322 octal number, equivalent to decimal 1234\n"
16833 " 0x4d2 hexadecimal number, equivalent to decimal 1234\n"
16838 #: ../fish/guestfish.pod:692
16840 "When using the C<chmod> command, you almost always want to specify an octal "
16841 "number for the mode, and you must prefix it with C<0> (unlike the Unix "
16842 "L<chmod(1)> program):"
16846 #: ../fish/guestfish.pod:696
16849 " chmod 0777 /public # OK\n"
16850 " chmod 777 /public # WRONG! This is mode 777 decimal = 01411 octal.\n"
16855 #: ../fish/guestfish.pod:699
16857 "Commands that return numbers usually print them in decimal, but some "
16858 "commands print numbers in other radices (eg. C<umask> prints the mode in "
16859 "octal, preceeded by C<0>)."
16863 #: ../fish/guestfish.pod:703
16864 msgid "WILDCARDS AND GLOBBING"
16868 #: ../fish/guestfish.pod:705
16870 "Neither guestfish nor the underlying guestfs API performs wildcard expansion "
16871 "(globbing) by default. So for example the following will not do what you "
16876 #: ../fish/guestfish.pod:709
16884 #: ../fish/guestfish.pod:711
16886 "Assuming you don't have a directory called literally C</home/*> then the "
16887 "above command will return an error."
16891 #: ../fish/guestfish.pod:714
16892 msgid "To perform wildcard expansion, use the C<glob> command."
16896 #: ../fish/guestfish.pod:716
16899 " glob rm-rf /home/*\n"
16904 #: ../fish/guestfish.pod:718
16906 "runs C<rm-rf> on each path that matches (ie. potentially running the command "
16907 "many times), equivalent to:"
16911 #: ../fish/guestfish.pod:721
16914 " rm-rf /home/jim\n"
16915 " rm-rf /home/joe\n"
16916 " rm-rf /home/mary\n"
16921 #: ../fish/guestfish.pod:725
16922 msgid "C<glob> only works on simple guest paths and not on device names."
16926 #: ../fish/guestfish.pod:727
16928 "If you have several parameters, each containing a wildcard, then glob will "
16929 "perform a Cartesian product."
16933 #: ../fish/guestfish.pod:730
16938 #: ../fish/guestfish.pod:732
16940 "Any line which starts with a I<#> character is treated as a comment and "
16941 "ignored. The I<#> can optionally be preceeded by whitespace, but B<not> by "
16942 "a command. For example:"
16946 #: ../fish/guestfish.pod:736
16949 " # this is a comment\n"
16950 " # this is a comment\n"
16951 " foo # NOT a comment\n"
16956 #: ../fish/guestfish.pod:740
16957 msgid "Blank lines are also ignored."
16961 #: ../fish/guestfish.pod:742
16962 msgid "RUNNING COMMANDS LOCALLY"
16966 #: ../fish/guestfish.pod:744
16968 "Any line which starts with a I<!> character is treated as a command sent to "
16969 "the local shell (C</bin/sh> or whatever L<system(3)> uses). For example:"
16973 #: ../fish/guestfish.pod:748
16977 " tgz-out /remote local/remote-data.tar.gz\n"
16982 #: ../fish/guestfish.pod:751
16984 "will create a directory C<local> on the host, and then export the contents "
16985 "of C</remote> on the mounted filesystem to C<local/remote-data.tar.gz>. "
16986 "(See C<tgz-out>)."
16990 #: ../fish/guestfish.pod:755
16992 "To change the local directory, use the C<lcd> command. C<!cd> will have no "
16993 "effect, due to the way that subprocesses work in Unix."
16997 #: ../fish/guestfish.pod:758
16998 msgid "LOCAL COMMANDS WITH INLINE EXECUTION"
17002 #: ../fish/guestfish.pod:760
17004 "If a line starts with I<E<lt>!> then the shell command is executed (as for "
17005 "I<!>), but subsequently any output (stdout) of the shell command is parsed "
17006 "and executed as guestfish commands."
17010 #: ../fish/guestfish.pod:764
17012 "Thus you can use shell script to construct arbitrary guestfish commands "
17013 "which are then parsed by guestfish."
17017 #: ../fish/guestfish.pod:767
17019 "For example it is tedious to create a sequence of files (eg. C</foo.1> "
17020 "through C</foo.100>) using guestfish commands alone. However this is simple "
17021 "if we use a shell script to create the guestfish commands for us:"
17025 #: ../fish/guestfish.pod:772
17028 " <! for n in `seq 1 100`; do echo write /foo.$n $n; done\n"
17033 #: ../fish/guestfish.pod:774
17034 msgid "or with names like C</foo.001>:"
17038 #: ../fish/guestfish.pod:776
17041 " <! for n in `seq 1 100`; do printf \"write /foo.%03d %d\\n\" $n $n; done\n"
17046 #: ../fish/guestfish.pod:778
17048 "When using guestfish interactively it can be helpful to just run the shell "
17049 "script first (ie. remove the initial C<E<lt>> character so it is just an "
17050 "ordinary I<!> local command), see what guestfish commands it would run, and "
17051 "when you are happy with those prepend the C<E<lt>> character to run the "
17052 "guestfish commands for real."
17056 #: ../fish/guestfish.pod:784
17061 #: ../fish/guestfish.pod:786
17063 "Use C<command E<lt>spaceE<gt> | command> to pipe the output of the first "
17064 "command (a guestfish command) to the second command (any host command). For "
17069 #: ../fish/guestfish.pod:790
17072 " cat /etc/passwd | awk -F: '$3 == 0 { print }'\n"
17077 #: ../fish/guestfish.pod:792
17079 "(where C<cat> is the guestfish cat command, but C<awk> is the host awk "
17080 "program). The above command would list all accounts in the guest filesystem "
17081 "which have UID 0, ie. root accounts including backdoors. Other examples:"
17085 #: ../fish/guestfish.pod:797
17088 " hexdump /bin/ls | head\n"
17089 " list-devices | tail -1\n"
17090 " tgz-out / - | tar ztf -\n"
17095 #: ../fish/guestfish.pod:801
17097 "The space before the pipe symbol is required, any space after the pipe "
17098 "symbol is optional. Everything after the pipe symbol is just passed "
17099 "straight to the host shell, so it can contain redirections, globs and "
17100 "anything else that makes sense on the host side."
17104 #: ../fish/guestfish.pod:806
17106 "To use a literal argument which begins with a pipe symbol, you have to quote "
17111 #: ../fish/guestfish.pod:809
17119 #: ../fish/guestfish.pod:811
17120 msgid "HOME DIRECTORIES"
17124 #: ../fish/guestfish.pod:813
17126 "If a parameter starts with the character C<~> then the tilde may be expanded "
17127 "as a home directory path (either C<~> for the current user's home directory, "
17128 "or C<~user> for another user)."
17132 #: ../fish/guestfish.pod:817
17134 "Note that home directory expansion happens for users known I<on the host>, "
17135 "not in the guest filesystem."
17139 #: ../fish/guestfish.pod:820
17141 "To use a literal argument which begins with a tilde, you have to quote it, "
17146 #: ../fish/guestfish.pod:823
17154 #: ../fish/guestfish.pod:825 ../src/guestfs.pod:519
17155 msgid "ENCRYPTED DISKS"
17159 #: ../fish/guestfish.pod:827
17161 "Libguestfs has some support for Linux guests encrypted according to the "
17162 "Linux Unified Key Setup (LUKS) standard, which includes nearly all whole "
17163 "disk encryption systems used by modern Linux guests. Currently only "
17164 "LVM-on-LUKS is supported."
17168 #: ../fish/guestfish.pod:832
17169 msgid "Identify encrypted block devices and partitions using L</vfs-type>:"
17173 #: ../fish/guestfish.pod:834
17176 " ><fs> vfs-type /dev/sda2\n"
17182 #: ../fish/guestfish.pod:837
17184 "Then open those devices using L</luks-open>. This creates a device-mapper "
17185 "device called C</dev/mapper/luksdev>."
17189 #: ../fish/guestfish.pod:840
17192 " ><fs> luks-open /dev/sda2 luksdev\n"
17193 " Enter key or passphrase (\"key\"): <enter the passphrase>\n"
17198 #: ../fish/guestfish.pod:843
17200 "Finally you have to tell LVM to scan for volume groups on the newly created "
17205 #: ../fish/guestfish.pod:846
17209 " vg-activate-all true\n"
17214 #: ../fish/guestfish.pod:849
17215 msgid "The logical volume(s) can now be mounted in the usual way."
17219 #: ../fish/guestfish.pod:851
17221 "Before closing a LUKS device you must unmount any logical volumes on it and "
17222 "deactivate the volume groups by calling C<vg-activate false VG> on each "
17223 "one. Then you can close the mapper device:"
17227 #: ../fish/guestfish.pod:855
17230 " vg-activate false /dev/VG\n"
17231 " luks-close /dev/mapper/luksdev\n"
17236 #: ../fish/guestfish.pod:860
17238 "If a path is prefixed with C<win:> then you can use Windows-style drive "
17239 "letters and paths (with some limitations). The following commands are "
17244 #: ../fish/guestfish.pod:864
17247 " file /WINDOWS/system32/config/system.LOG\n"
17252 #: ../fish/guestfish.pod:866
17255 " file win:\\windows\\system32\\config\\system.log\n"
17260 #: ../fish/guestfish.pod:868
17263 " file WIN:C:\\Windows\\SYSTEM32\\CONFIG\\SYSTEM.LOG\n"
17268 #: ../fish/guestfish.pod:870
17270 "The parameter is rewritten \"behind the scenes\" by looking up the position "
17271 "where the drive is mounted, prepending that to the path, changing all "
17272 "backslash characters to forward slash, then resolving the result using "
17273 "L</case-sensitive-path>. For example if the E: drive was mounted on C</e> "
17274 "then the parameter might be rewritten like this:"
17278 #: ../fish/guestfish.pod:876
17281 " win:e:\\foo\\bar => /e/FOO/bar\n"
17286 #: ../fish/guestfish.pod:878
17287 msgid "This only works in argument positions that expect a path."
17291 #: ../fish/guestfish.pod:880
17292 msgid "UPLOADING AND DOWNLOADING FILES"
17296 #: ../fish/guestfish.pod:882
17298 "For commands such as C<upload>, C<download>, C<tar-in>, C<tar-out> and "
17299 "others which upload from or download to a local file, you can use the "
17300 "special filename C<-> to mean \"from stdin\" or \"to stdout\". For example:"
17304 #: ../fish/guestfish.pod:886
17312 #: ../fish/guestfish.pod:888
17313 msgid "reads stdin and creates from that a file C</foo> in the disk image, and:"
17317 #: ../fish/guestfish.pod:891
17320 " tar-out /etc - | tar tf -\n"
17325 #: ../fish/guestfish.pod:893
17327 "writes the tarball to stdout and then pipes that into the external \"tar\" "
17328 "command (see L</PIPES>)."
17332 #: ../fish/guestfish.pod:896
17334 "When using C<-> to read from stdin, the input is read up to the end of "
17335 "stdin. You can also use a special \"heredoc\"-like syntax to read up to "
17336 "some arbitrary end marker:"
17340 #: ../fish/guestfish.pod:900
17343 " upload -<<END /foo\n"
17352 #: ../fish/guestfish.pod:906
17354 "Any string of characters can be used instead of C<END>. The end marker must "
17355 "appear on a line of its own, without any preceeding or following characters "
17356 "(not even spaces)."
17360 #: ../fish/guestfish.pod:910
17362 "Note that the C<-E<lt>E<lt>> syntax only applies to parameters used to "
17363 "upload local files (so-called \"FileIn\" parameters in the generator)."
17367 #: ../fish/guestfish.pod:913
17368 msgid "EXIT ON ERROR BEHAVIOUR"
17372 #: ../fish/guestfish.pod:915
17374 "By default, guestfish will ignore any errors when in interactive mode "
17375 "(ie. taking commands from a human over a tty), and will exit on the first "
17376 "error in non-interactive mode (scripts, commands given on the command line)."
17380 #: ../fish/guestfish.pod:920
17382 "If you prefix a command with a I<-> character, then that command will not "
17383 "cause guestfish to exit, even if that (one) command returns an error."
17387 #: ../fish/guestfish.pod:924
17388 msgid "REMOTE CONTROL GUESTFISH OVER A SOCKET"
17392 #: ../fish/guestfish.pod:926
17394 "Guestfish can be remote-controlled over a socket. This is useful "
17395 "particularly in shell scripts where you want to make several different "
17396 "changes to a filesystem, but you don't want the overhead of starting up a "
17397 "guestfish process each time."
17401 #: ../fish/guestfish.pod:931
17402 msgid "Start a guestfish server process using:"
17406 #: ../fish/guestfish.pod:933
17409 " eval \"`guestfish --listen`\"\n"
17414 #: ../fish/guestfish.pod:935
17415 msgid "and then send it commands by doing:"
17419 #: ../fish/guestfish.pod:937
17422 " guestfish --remote cmd [...]\n"
17427 #: ../fish/guestfish.pod:939
17428 msgid "To cause the server to exit, send it the exit command:"
17432 #: ../fish/guestfish.pod:943
17434 "Note that the server will normally exit if there is an error in a command. "
17435 "You can change this in the usual way. See section L</EXIT ON ERROR "
17440 #: ../fish/guestfish.pod:947
17441 msgid "CONTROLLING MULTIPLE GUESTFISH PROCESSES"
17445 #: ../fish/guestfish.pod:949
17447 "The C<eval> statement sets the environment variable C<$GUESTFISH_PID>, which "
17448 "is how the I<--remote> option knows where to send the commands. You can "
17449 "have several guestfish listener processes running using:"
17453 #: ../fish/guestfish.pod:953
17456 " eval \"`guestfish --listen`\"\n"
17457 " pid1=$GUESTFISH_PID\n"
17458 " eval \"`guestfish --listen`\"\n"
17459 " pid2=$GUESTFISH_PID\n"
17461 " guestfish --remote=$pid1 cmd\n"
17462 " guestfish --remote=$pid2 cmd\n"
17467 #: ../fish/guestfish.pod:961
17468 msgid "REMOTE CONTROL AND CSH"
17472 #: ../fish/guestfish.pod:963
17474 "When using csh-like shells (csh, tcsh etc) you have to add the I<--csh> "
17479 #: ../fish/guestfish.pod:966
17482 " eval \"`guestfish --listen --csh`\"\n"
17487 #: ../fish/guestfish.pod:968
17488 msgid "REMOTE CONTROL DETAILS"
17492 #: ../fish/guestfish.pod:970
17494 "Remote control happens over a Unix domain socket called "
17495 "C</tmp/.guestfish-$UID/socket-$PID>, where C<$UID> is the effective user ID "
17496 "of the process, and C<$PID> is the process ID of the server."
17500 #: ../fish/guestfish.pod:974
17501 msgid "Guestfish client and server versions must match exactly."
17505 #: ../fish/guestfish.pod:976
17506 msgid "REMOTE CONTROL RUN COMMAND HANGING"
17510 #: ../fish/guestfish.pod:978
17512 "Using the C<run> (or C<launch>) command remotely in a command substitution "
17513 "context hangs, ie. don't do (note the backquotes):"
17517 #: ../fish/guestfish.pod:981
17520 " a=`guestfish --remote run`\n"
17525 #: ../fish/guestfish.pod:983
17527 "Since the C<run> command produces no output on stdout, this is not useful "
17528 "anyway. For further information see "
17529 "L<https://bugzilla.redhat.com/show_bug.cgi?id=592910>."
17533 #: ../fish/guestfish.pod:987
17534 msgid "PREPARED DISK IMAGES"
17538 #: ../fish/guestfish.pod:989
17540 "Use the I<-N type> or I<--new type> parameter to select one of a set of "
17541 "preformatted disk images that guestfish can make for you to save typing. "
17542 "This is particularly useful for testing purposes. This option is used "
17543 "instead of the I<-a> option, and like I<-a> can appear multiple times (and "
17544 "can be mixed with I<-a>)."
17548 #: ../fish/guestfish.pod:995
17550 "The new disk is called C<test1.img> for the first I<-N>, C<test2.img> for "
17551 "the second and so on. Existing files in the current directory are "
17556 #: ../fish/guestfish.pod:999
17558 "The type briefly describes how the disk should be sized, partitioned, how "
17559 "filesystem(s) should be created, and how content should be added. "
17560 "Optionally the type can be followed by extra parameters, separated by C<:> "
17561 "(colon) characters. For example, I<-N fs> creates a default 100MB, "
17562 "sparsely-allocated disk, containing a single partition, with the partition "
17563 "formatted as ext2. I<-N fs:ext4:1G> is the same, but for an ext4 filesystem "
17564 "on a 1GB disk instead."
17568 #: ../fish/guestfish.pod:1007
17569 msgid "To list the available types and any extra parameters they take, run:"
17573 #: ../fish/guestfish.pod:1011
17575 "Note that the prepared filesystem is not mounted. You would usually have to "
17576 "use the C<mount /dev/sda1 /> command or add the I<-m /dev/sda1> option."
17580 #: ../fish/guestfish.pod:1015
17582 "If any I<-N> or I<--new> options are given, the guest is automatically "
17587 #: ../fish/guestfish.pod:1020
17588 msgid "Create a 100MB disk with an ext4-formatted partition:"
17592 #: ../fish/guestfish.pod:1022
17595 " guestfish -N fs:ext4\n"
17600 #: ../fish/guestfish.pod:1024
17601 msgid "Create a 32MB disk with a VFAT-formatted partition, and mount it:"
17605 #: ../fish/guestfish.pod:1026
17608 " guestfish -N fs:vfat:32M -m /dev/sda1\n"
17613 #: ../fish/guestfish.pod:1028
17614 msgid "Create a blank 200MB disk:"
17618 #: ../fish/guestfish.pod:1030
17621 " guestfish -N disk:200M\n"
17626 #: ../fish/guestfish.pod:1032
17627 msgid "PROGRESS BARS"
17631 #: ../fish/guestfish.pod:1034
17633 "Some (not all) long-running commands send progress notification messages as "
17634 "they are running. Guestfish turns these messages into progress bars."
17638 #: ../fish/guestfish.pod:1038
17640 "When a command that supports progress bars takes longer than two seconds to "
17641 "run, and if progress bars are enabled, then you will see one appearing below "
17646 #: ../fish/guestfish.pod:1042
17649 " ><fs> copy-size /large-file /another-file 2048M\n"
17650 " / 10% [#####-----------------------------------------] 00:30\n"
17655 #: ../fish/guestfish.pod:1045
17657 "The spinner on the left hand side moves round once for every progress "
17658 "notification received from the backend. This is a (reasonably) golden "
17659 "assurance that the command is \"doing something\" even if the progress bar "
17660 "is not moving, because the command is able to send the progress "
17661 "notifications. When the bar reaches 100% and the command finishes, the "
17662 "spinner disappears."
17666 #: ../fish/guestfish.pod:1052
17668 "Progress bars are enabled by default when guestfish is used interactively. "
17669 "You can enable them even for non-interactive modes using I<--progress-bars>, "
17670 "and you can disable them completely using I<--no-progress-bars>."
17674 #: ../fish/guestfish.pod:1057
17675 msgid "GUESTFISH COMMANDS"
17679 #: ../fish/guestfish.pod:1059
17681 "The commands in this section are guestfish convenience commands, in other "
17682 "words, they are not part of the L<guestfs(3)> API."
17686 #: ../fish/guestfish.pod:1062
17691 #: ../fish/guestfish.pod:1064
17700 #: ../fish/guestfish.pod:1067
17701 msgid "Without any parameter, this provides general help."
17705 #: ../fish/guestfish.pod:1069
17706 msgid "With a C<cmd> parameter, this displays detailed help for that command."
17710 #: ../fish/guestfish.pod:1071
17711 msgid "quit | exit"
17715 #: ../fish/guestfish.pod:1073
17716 msgid "This exits guestfish. You can also use C<^D> key."
17720 #: ../fish/guestfish.pod:1075
17721 msgid "@FISH_COMMANDS@"
17725 #: ../fish/guestfish.pod:1077
17730 #: ../fish/guestfish.pod:1079 ../src/guestfs.pod:1474
17735 #: ../fish/guestfish.pod:1081 ../test-tool/libguestfs-test-tool.pod:77
17740 #: ../fish/guestfish.pod:1083
17742 "guestfish returns 0 if the commands completed without error, or 1 if there "
17747 #: ../fish/guestfish.pod:1090
17752 #: ../fish/guestfish.pod:1092
17754 "The C<edit> command uses C<$EDITOR> as the editor. If not set, it uses "
17759 #: ../fish/guestfish.pod:1095 ../src/guestfs.pod:2969
17760 msgid "FEBOOTSTRAP_KERNEL"
17764 #: ../fish/guestfish.pod:1097 ../src/guestfs.pod:2971
17765 msgid "FEBOOTSTRAP_MODULES"
17769 #: ../fish/guestfish.pod:1099 ../src/guestfs.pod:2973
17771 "These two environment variables allow the kernel that libguestfs uses in the "
17772 "appliance to be selected. If C<$FEBOOTSTRAP_KERNEL> is not set, then the "
17773 "most recent host kernel is chosen. For more information about kernel "
17774 "selection, see L<febootstrap-supermin-helper(8)>. This feature is only "
17775 "available in febootstrap E<ge> 3.8."
17779 #: ../fish/guestfish.pod:1105
17780 msgid "GUESTFISH_DISPLAY_IMAGE"
17784 #: ../fish/guestfish.pod:1107
17786 "The C<display> command uses C<$GUESTFISH_DISPLAY_IMAGE> to display images. "
17787 "If not set, it uses L<display(1)>."
17791 #: ../fish/guestfish.pod:1110
17792 msgid "GUESTFISH_PID"
17796 #: ../fish/guestfish.pod:1112
17798 "Used with the I<--remote> option to specify the remote guestfish process to "
17799 "control. See section L</REMOTE CONTROL GUESTFISH OVER A SOCKET>."
17803 #: ../fish/guestfish.pod:1116
17808 #: ../fish/guestfish.pod:1118
17810 "The L</hexedit> command uses C<$HEXEDITOR> as the external hex editor. If "
17811 "not specified, the external L<hexedit(1)> program is used."
17815 #: ../fish/guestfish.pod:1122
17820 #: ../fish/guestfish.pod:1124
17822 "If compiled with GNU readline support, various files in the home directory "
17823 "can be used. See L</FILES>."
17827 #: ../fish/guestfish.pod:1127 ../src/guestfs.pod:2979
17828 msgid "LIBGUESTFS_APPEND"
17832 #: ../fish/guestfish.pod:1129 ../src/guestfs.pod:2981
17833 msgid "Pass additional options to the guest kernel."
17837 #: ../fish/guestfish.pod:1131 ../src/guestfs.pod:2983
17838 msgid "LIBGUESTFS_DEBUG"
17842 #: ../fish/guestfish.pod:1133
17844 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
17845 "effect as using the B<-v> option."
17849 #: ../fish/guestfish.pod:1136 ../src/guestfs.pod:2988
17850 msgid "LIBGUESTFS_MEMSIZE"
17854 #: ../fish/guestfish.pod:1138 ../src/guestfs.pod:2990
17855 msgid "Set the memory allocated to the qemu process, in megabytes. For example:"
17859 #: ../fish/guestfish.pod:1141 ../src/guestfs.pod:2993
17862 " LIBGUESTFS_MEMSIZE=700\n"
17867 #: ../fish/guestfish.pod:1143 ../src/guestfs.pod:2995
17868 msgid "LIBGUESTFS_PATH"
17872 #: ../fish/guestfish.pod:1145
17874 "Set the path that guestfish uses to search for kernel and initrd.img. See "
17875 "the discussion of paths in L<guestfs(3)>."
17879 #: ../fish/guestfish.pod:1148 ../src/guestfs.pod:3000
17880 msgid "LIBGUESTFS_QEMU"
17884 #: ../fish/guestfish.pod:1150 ../src/guestfs.pod:3002
17886 "Set the default qemu binary that libguestfs uses. If not set, then the qemu "
17887 "which was found at compile time by the configure script is used."
17891 #: ../fish/guestfish.pod:1154 ../src/guestfs.pod:3008
17892 msgid "LIBGUESTFS_TRACE"
17896 #: ../fish/guestfish.pod:1156
17897 msgid "Set C<LIBGUESTFS_TRACE=1> to enable command traces."
17901 #: ../fish/guestfish.pod:1158
17906 #: ../fish/guestfish.pod:1160
17908 "The C<more> command uses C<$PAGER> as the pager. If not set, it uses "
17913 #: ../fish/guestfish.pod:1163 ../src/guestfs.pod:3013
17918 #: ../fish/guestfish.pod:1165 ../src/guestfs.pod:3015
17920 "Location of temporary directory, defaults to C</tmp> except for the cached "
17921 "supermin appliance which defaults to C</var/tmp>."
17925 #: ../fish/guestfish.pod:1168 ../src/guestfs.pod:3018
17927 "If libguestfs was compiled to use the supermin appliance then the real "
17928 "appliance is cached in this directory, shared between all handles belonging "
17929 "to the same EUID. You can use C<$TMPDIR> to configure another directory to "
17930 "use in case C</var/tmp> is not large enough."
17934 #: ../fish/guestfish.pod:1176 ../fuse/guestmount.pod:288 ../rescue/virt-rescue.pod:269
17939 #: ../fish/guestfish.pod:1180 ../fuse/guestmount.pod:292 ../rescue/virt-rescue.pod:273
17940 msgid "$HOME/.libguestfs-tools.rc"
17944 #: ../fish/guestfish.pod:1182 ../fuse/guestmount.pod:294 ../rescue/virt-rescue.pod:275
17945 msgid "/etc/libguestfs-tools.conf"
17949 #: ../fish/guestfish.pod:1184 ../fuse/guestmount.pod:296 ../rescue/virt-rescue.pod:277
17951 "This configuration file controls the default read-only or read-write mode "
17952 "(I<--ro> or I<--rw>)."
17956 #: ../fish/guestfish.pod:1187
17957 msgid "See L</OPENING DISKS FOR READ AND WRITE>."
17961 #: ../fish/guestfish.pod:1189
17962 msgid "$HOME/.guestfish"
17966 #: ../fish/guestfish.pod:1191
17968 "If compiled with GNU readline support, then the command history is saved in "
17973 #: ../fish/guestfish.pod:1194
17974 msgid "$HOME/.inputrc"
17978 #: ../fish/guestfish.pod:1196
17979 msgid "/etc/inputrc"
17983 #: ../fish/guestfish.pod:1198
17985 "If compiled with GNU readline support, then these files can be used to "
17986 "configure readline. For further information, please see "
17987 "L<readline(3)/INITIALIZATION FILE>."
17991 #: ../fish/guestfish.pod:1202
17992 msgid "To write rules which only apply to guestfish, use:"
17996 #: ../fish/guestfish.pod:1204
18006 #: ../fish/guestfish.pod:1208
18008 "Variables that you can set in inputrc that change the behaviour of guestfish "
18009 "in useful ways include:"
18013 #: ../fish/guestfish.pod:1213
18014 msgid "completion-ignore-case (default: on)"
18018 #: ../fish/guestfish.pod:1215
18020 "By default, guestfish will ignore case when tab-completing paths on the "
18025 #: ../fish/guestfish.pod:1218
18028 " set completion-ignore-case off\n"
18033 #: ../fish/guestfish.pod:1220
18034 msgid "to make guestfish case sensitive."
18038 #: ../fish/guestfish.pod:1224
18043 #: ../fish/guestfish.pod:1226
18044 msgid "test2.img (etc)"
18048 #: ../fish/guestfish.pod:1228
18050 "When using the I<-N> or I<--new> option, the prepared disk or filesystem "
18051 "will be created in the file C<test1.img> in the current directory. The "
18052 "second use of I<-N> will use C<test2.img> and so on. Any existing file with "
18053 "the same name will be overwritten."
18057 #: ../fish/guestfish.pod:1237
18059 "L<guestfs(3)>, L<http://libguestfs.org/>, L<virt-cat(1)>, "
18060 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, "
18061 "L<virt-filesystems(1)>, L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
18062 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
18063 "L<virt-rescue(1)>, L<virt-resize(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, "
18064 "L<virt-tar-out(1)>, L<virt-win-reg(1)>, L<display(1)>, L<hexedit(1)>, "
18065 "L<febootstrap-supermin-helper(8)>."
18069 #: ../fish/guestfish.pod:1266 ../src/guestfs.pod:3104 ../test-tool/libguestfs-test-tool.pod:99
18070 msgid "Copyright (C) 2009-2011 Red Hat Inc. L<http://libguestfs.org/>"
18074 #: ../fish/virt-copy-in.pod:5
18075 msgid "virt-copy-in - Copy files and directories into a virtual machine disk image."
18079 #: ../fish/virt-copy-in.pod:9
18082 " virt-copy-in -a disk.img file|dir [file|dir ...] /destination\n"
18087 #: ../fish/virt-copy-in.pod:11
18090 " virt-copy-in -d domain file|dir [file|dir ...] /destination\n"
18095 #: ../fish/virt-copy-in.pod:15
18097 "Using C<virt-copy-in> on live virtual machines can be dangerous, potentially "
18098 "causing disk corruption. The virtual machine must be shut down before you "
18099 "use this command."
18103 #: ../fish/virt-copy-in.pod:21
18105 "C<virt-copy-in> copies files and directories from the local disk into a "
18106 "virtual machine disk image or named libvirt domain."
18110 #: ../fish/virt-copy-in.pod:24
18112 "You can give one of more filenames and directories on the command line. "
18113 "Directories are copied in recursively. The final parameter must be the "
18114 "destination directory in the disk image which must be an absolute path "
18115 "starting with a C</> character."
18119 #: ../fish/virt-copy-in.pod:33
18122 " virt-copy-in -d MyGuest resolv.conf /etc\n"
18127 #: ../fish/virt-copy-in.pod:35 ../fish/virt-tar-in.pod:32
18128 msgid "Upload a home directory to a guest:"
18132 #: ../fish/virt-copy-in.pod:37
18135 " virt-copy-in -d MyGuest skel /home\n"
18140 #: ../fish/virt-copy-in.pod:39 ../fish/virt-copy-out.pod:28 ../fish/virt-tar-in.pod:36 ../fish/virt-tar-out.pod:30
18141 msgid "JUST A SHELL SCRIPT WRAPPER AROUND GUESTFISH"
18145 #: ../fish/virt-copy-in.pod:41
18147 "This command is just a simple shell script wrapper around the "
18148 "L<guestfish(1)> C<copy-in> command. For anything more complex than a "
18149 "trivial copy, you are probably better off using guestfish directly."
18153 #: ../fish/virt-copy-in.pod:47 ../fish/virt-copy-out.pod:36 ../fish/virt-tar-in.pod:44 ../fish/virt-tar-out.pod:38
18155 "Since the shell script just passes options straight to guestfish, read "
18156 "L<guestfish(1)> to see the full list of options."
18160 #: ../fish/virt-copy-in.pod:52
18162 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-out(1)>, L<virt-edit(1)>, "
18163 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18167 #: ../fish/virt-copy-in.pod:66 ../fish/virt-copy-out.pod:55 ../fish/virt-tar-in.pod:64 ../fish/virt-tar-out.pod:57
18168 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
18172 #: ../fish/virt-copy-out.pod:5
18174 "virt-copy-out - Copy files and directories out of a virtual machine disk "
18179 #: ../fish/virt-copy-out.pod:9
18182 " virt-copy-out -a disk.img /file|dir [/file|dir ...] localdir\n"
18187 #: ../fish/virt-copy-out.pod:11
18190 " virt-copy-out -d domain /file|dir [/file|dir ...] localdir\n"
18195 #: ../fish/virt-copy-out.pod:15
18197 "C<virt-copy-out> copies files and directories out of a virtual machine disk "
18198 "image or named libvirt domain."
18202 #: ../fish/virt-copy-out.pod:18
18204 "You can give one of more filenames and directories on the command line. "
18205 "Directories are copied out recursively."
18209 #: ../fish/virt-copy-out.pod:23
18210 msgid "Download the home directories from a virtual machine:"
18214 #: ../fish/virt-copy-out.pod:25
18218 " virt-copy-out -d MyGuest /home homes\n"
18223 #: ../fish/virt-copy-out.pod:30
18225 "This command is just a simple shell script wrapper around the "
18226 "L<guestfish(1)> C<copy-out> command. For anything more complex than a "
18227 "trivial copy, you are probably better off using guestfish directly."
18231 #: ../fish/virt-copy-out.pod:41
18233 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-edit(1)>, "
18234 "L<virt-tar-in(1)>, L<virt-tar-out(1)>, L<http://libguestfs.org/>."
18238 #: ../fish/virt-tar-in.pod:5
18239 msgid "virt-tar-in - Unpack a tarball into a virtual machine disk image."
18243 #: ../fish/virt-tar-in.pod:9
18246 " virt-tar-in -a disk.img data.tar /destination\n"
18251 #: ../fish/virt-tar-in.pod:11
18254 " virt-tar-in -d domain data.tar /destination\n"
18259 #: ../fish/virt-tar-in.pod:13
18262 " zcat data.tar.gz | virt-tar-in -d domain - /destination\n"
18267 #: ../fish/virt-tar-in.pod:17
18269 "Using C<virt-tar-in> on live virtual machines can be dangerous, potentially "
18270 "causing disk corruption. The virtual machine must be shut down before you "
18271 "use this command."
18275 #: ../fish/virt-tar-in.pod:23
18277 "C<virt-tar-in> unpacks an uncompressed tarball into a virtual machine disk "
18278 "image or named libvirt domain."
18282 #: ../fish/virt-tar-in.pod:26
18284 "The first parameter is the tar file. Use C<-> to read the tar file from "
18285 "standard input. The second parameter is the absolute target directory to "
18290 #: ../fish/virt-tar-in.pod:34
18293 " virt-tar-in -d MyGuest homes.tar /home\n"
18298 #: ../fish/virt-tar-in.pod:38
18300 "This command is just a simple shell script wrapper around the "
18301 "L<guestfish(1)> C<tar-in> command. For anything more complex than a trivial "
18302 "copy, you are probably better off using guestfish directly."
18306 #: ../fish/virt-tar-in.pod:49
18308 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18309 "L<virt-edit(1)>, L<virt-make-fs(1)>, L<virt-tar-out(1)>, "
18310 "L<http://libguestfs.org/>."
18314 #: ../fish/virt-tar-out.pod:5
18315 msgid "virt-tar-out - Pack a virtual machine disk image directory into a tarball."
18319 #: ../fish/virt-tar-out.pod:9
18322 " virt-tar-out -a disk.img /dir files.tar\n"
18327 #: ../fish/virt-tar-out.pod:11
18330 " virt-tar-out -d domain /dir files.tar\n"
18335 #: ../fish/virt-tar-out.pod:13
18338 " virt-tar-out -d domain /dir - | gzip --best > files.tar.gz\n"
18343 #: ../fish/virt-tar-out.pod:17
18344 msgid "C<virt-tar-out> packs a virtual machine disk image directory into a tarball."
18348 #: ../fish/virt-tar-out.pod:20
18350 "The first parameter is the absolute path of the virtual machine directory. "
18351 "The second parameter is the tar file to write. Use C<-> to write to "
18356 #: ../fish/virt-tar-out.pod:26
18357 msgid "Download the home directories from a guest:"
18361 #: ../fish/virt-tar-out.pod:28
18364 " virt-tar-out -d MyGuest /home - | gzip --best > homes.tar.gz\n"
18369 #: ../fish/virt-tar-out.pod:32
18371 "This command is just a simple shell script wrapper around the "
18372 "L<guestfish(1)> C<tar-out> command. For anything more complex than a "
18373 "trivial copy, you are probably better off using guestfish directly."
18377 #: ../fish/virt-tar-out.pod:43
18379 "L<guestfish(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
18380 "L<virt-edit(1)>, L<virt-tar-in(1)>, L<http://libguestfs.org/>."
18384 #: ../fuse/guestmount.pod:5
18385 msgid "guestmount - Mount a guest filesystem on the host using FUSE and libguestfs"
18389 #: ../fuse/guestmount.pod:9
18392 " guestmount [--options] -a disk.img -m device [--ro] mountpoint\n"
18397 #: ../fuse/guestmount.pod:11
18400 " guestmount [--options] -a disk.img -i [--ro] mountpoint\n"
18405 #: ../fuse/guestmount.pod:13
18408 " guestmount [--options] -d Guest -i [--ro] mountpoint\n"
18413 #: ../fuse/guestmount.pod:17
18415 "You must I<not> use C<guestmount> in read-write mode on live virtual "
18416 "machines. If you do this, you risk disk corruption in the VM."
18420 #: ../fuse/guestmount.pod:22
18422 "The guestmount program can be used to mount virtual machine filesystems and "
18423 "other disk images on the host. It uses libguestfs for access to the guest "
18424 "filesystem, and FUSE (the \"filesystem in userspace\") to make it appear as "
18425 "a mountable device."
18429 #: ../fuse/guestmount.pod:27
18431 "Along with other options, you have to give at least one device (I<-a> "
18432 "option) or libvirt domain (I<-d> option), and at least one mountpoint (I<-m> "
18433 "option) or use the I<-i> inspection option. How this works is better "
18434 "explained in the L<guestfish(1)> manual page, or by looking at the examples "
18439 #: ../fuse/guestmount.pod:33
18441 "FUSE lets you mount filesystems as non-root. The mountpoint must be owned "
18442 "by you, and the filesystem will not be visible to any other users unless you "
18443 "make certain global configuration changes to C</etc/fuse.conf>. To unmount "
18444 "the filesystem, use the C<fusermount -u> command."
18448 #: ../fuse/guestmount.pod:41
18450 "For a typical Windows guest which has its main filesystem on the first "
18455 #: ../fuse/guestmount.pod:44
18458 " guestmount -a windows.img -m /dev/sda1 --ro /mnt\n"
18463 #: ../fuse/guestmount.pod:46
18465 "For a typical Linux guest which has a /boot filesystem on the first "
18466 "partition, and the root filesystem on a logical volume:"
18470 #: ../fuse/guestmount.pod:49
18473 " guestmount -a linux.img -m /dev/VG/LV -m /dev/sda1:/boot --ro /mnt\n"
18478 #: ../fuse/guestmount.pod:51
18479 msgid "To get libguestfs to detect guest mountpoints for you:"
18483 #: ../fuse/guestmount.pod:53
18486 " guestmount -a guest.img -i --ro /mnt\n"
18491 #: ../fuse/guestmount.pod:55
18492 msgid "For a libvirt guest called \"Guest\" you could do:"
18496 #: ../fuse/guestmount.pod:57
18499 " guestmount -d Guest -i --ro /mnt\n"
18504 #: ../fuse/guestmount.pod:59
18506 "If you don't know what filesystems are contained in a guest or disk image, "
18507 "use L<virt-filesystems(1)> first:"
18511 #: ../fuse/guestmount.pod:62
18514 " virt-filesystems MyGuest\n"
18519 #: ../fuse/guestmount.pod:64
18521 "If you want to trace the libguestfs calls but without excessive debugging "
18522 "information, we recommend:"
18526 #: ../fuse/guestmount.pod:67
18529 " guestmount [...] --trace /mnt\n"
18534 #: ../fuse/guestmount.pod:69
18535 msgid "If you want to debug the program, we recommend:"
18539 #: ../fuse/guestmount.pod:71
18542 " guestmount [...] --trace --verbose /mnt\n"
18547 #: ../fuse/guestmount.pod:73 ../rescue/virt-rescue.pod:68 ../resize/virt-resize.pod:486
18552 #: ../fuse/guestmount.pod:75
18553 msgid "Other users cannot see the filesystem by default"
18557 #: ../fuse/guestmount.pod:77
18559 "If you mount a filesystem as one user (eg. root), then other users will not "
18560 "be able to see it by default. The fix is to add the FUSE C<allow_other> "
18561 "option when mounting:"
18565 #: ../fuse/guestmount.pod:81
18568 " sudo guestmount [...] -o allow_other /mnt\n"
18573 #: ../fuse/guestmount.pod:91
18574 msgid "Add a block device or virtual machine image."
18578 #: ../fuse/guestmount.pod:114
18579 msgid "B<--dir-cache-timeout N>"
18583 #: ../fuse/guestmount.pod:116
18585 "Set the readdir cache timeout to I<N> seconds, the default being 60 "
18586 "seconds. The readdir cache [actually, there are several semi-independent "
18587 "caches] is populated after a readdir(2) call with the stat and extended "
18588 "attributes of the files in the directory, in anticipation that they will be "
18589 "requested soon after."
18593 #: ../fuse/guestmount.pod:122
18595 "There is also a different attribute cache implemented by FUSE (see the FUSE "
18596 "option I<-o attr_timeout>), but the FUSE cache does not anticipate future "
18597 "requests, only cache existing ones."
18601 #: ../fuse/guestmount.pod:142
18603 "If you have untrusted raw-format guest disk images, you should use this "
18604 "option to specify the disk format. This avoids a possible security problem "
18605 "with malicious guests (CVE-2010-3851). See also "
18606 "L<guestfs(3)/guestfs_add_drive_opts>."
18610 #: ../fuse/guestmount.pod:147
18611 msgid "B<--fuse-help>"
18615 #: ../fuse/guestmount.pod:149
18616 msgid "Display help on special FUSE options (see I<-o> below)."
18620 #: ../fuse/guestmount.pod:153
18621 msgid "Display brief help and exit."
18625 #: ../fuse/guestmount.pod:177
18627 "Mount the named partition or logical volume on the given mountpoint B<in the "
18628 "guest> (this has nothing to do with mountpoints in the host)."
18632 #: ../fuse/guestmount.pod:180
18634 "If the mountpoint is omitted, it defaults to C</>. You have to mount "
18635 "something on C</>."
18639 #: ../fuse/guestmount.pod:197
18641 "By default, we attempt to sync the guest disk when the FUSE mountpoint is "
18642 "unmounted. If you specify this option, then we don't attempt to sync the "
18643 "disk. See the discussion of autosync in the L<guestfs(3)> manpage."
18647 #: ../fuse/guestmount.pod:202
18648 msgid "B<-o option>"
18652 #: ../fuse/guestmount.pod:204
18653 msgid "B<--option option>"
18657 #: ../fuse/guestmount.pod:206
18658 msgid "Pass extra options to FUSE."
18662 #: ../fuse/guestmount.pod:208
18664 "To get a list of all the extra options supported by FUSE, use the command "
18665 "below. Note that only the FUSE I<-o> options can be passed, and only some "
18666 "of them are a good idea."
18670 #: ../fuse/guestmount.pod:212
18673 " guestmount --fuse-help\n"
18678 #: ../fuse/guestmount.pod:214
18679 msgid "Some potentially useful FUSE options:"
18683 #: ../fuse/guestmount.pod:218
18684 msgid "B<-o allow_other>"
18688 #: ../fuse/guestmount.pod:220
18689 msgid "Allow other users to see the filesystem."
18693 #: ../fuse/guestmount.pod:222
18694 msgid "B<-o attr_timeout=N>"
18698 #: ../fuse/guestmount.pod:224
18699 msgid "Enable attribute caching by FUSE, and set the timeout to I<N> seconds."
18703 #: ../fuse/guestmount.pod:226
18704 msgid "B<-o kernel_cache>"
18708 #: ../fuse/guestmount.pod:228
18710 "Allow the kernel to cache files (reduces the number of reads that have to go "
18711 "through the L<guestfs(3)> API). This is generally a good idea if you can "
18712 "afford the extra memory usage."
18716 #: ../fuse/guestmount.pod:232
18717 msgid "B<-o uid=N> B<-o gid=N>"
18721 #: ../fuse/guestmount.pod:234
18723 "Use these options to map all UIDs and GIDs inside the guest filesystem to "
18724 "the chosen values."
18728 #: ../fuse/guestmount.pod:243
18730 "Add devices and mount everything read-only. Also disallow writes and make "
18731 "the disk appear read-only to FUSE."
18735 #: ../fuse/guestmount.pod:246
18737 "This is highly recommended if you are not going to edit the guest disk. If "
18738 "the guest is running and this option is I<not> supplied, then there is a "
18739 "strong risk of disk corruption in the guest. We try to prevent this from "
18740 "happening, but it is not always possible."
18744 #: ../fuse/guestmount.pod:251 ../rescue/virt-rescue.pod:171
18745 msgid "See also L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
18749 #: ../fuse/guestmount.pod:255
18750 msgid "Enable SELinux support for the guest."
18754 #: ../fuse/guestmount.pod:261
18755 msgid "Enable verbose messages from underlying libguestfs."
18759 #: ../fuse/guestmount.pod:267
18760 msgid "Display the program version and exit."
18764 #: ../fuse/guestmount.pod:276 ../fuse/guestmount.pod:299 ../rescue/virt-rescue.pod:197 ../rescue/virt-rescue.pod:280
18765 msgid "See L<guestfish(1)/OPENING DISKS FOR READ AND WRITE>."
18769 #: ../fuse/guestmount.pod:280
18774 #: ../fuse/guestmount.pod:282
18775 msgid "Trace libguestfs calls and entry into each FUSE function."
18779 #: ../fuse/guestmount.pod:284
18780 msgid "This also stops the daemon from forking into the background."
18784 #: ../fuse/guestmount.pod:305
18786 "L<guestfish(1)>, L<virt-inspector(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
18787 "L<virt-tar(1)>, L<guestfs(3)>, L<http://libguestfs.org/>, "
18788 "L<http://fuse.sf.net/>."
18792 #: ../fuse/guestmount.pod:320
18793 msgid "Copyright (C) 2009-2010 Red Hat Inc. L<http://libguestfs.org/>"
18797 #: ../inspector/virt-inspector.pod:5
18799 "virt-inspector - Display operating system version and other information "
18800 "about a virtual machine"
18804 #: ../inspector/virt-inspector.pod:9
18807 " virt-inspector [--options] -d domname\n"
18812 #: ../inspector/virt-inspector.pod:11
18815 " virt-inspector [--options] -a disk.img [-a disk.img ...]\n"
18820 #: ../inspector/virt-inspector.pod:15
18823 " virt-inspector domname\n"
18828 #: ../inspector/virt-inspector.pod:17 ../inspector/virt-inspector.pod:141
18831 " virt-inspector disk.img [disk.img ...]\n"
18836 #: ../inspector/virt-inspector.pod:21
18838 "B<virt-inspector> examines a virtual machine or disk image and tries to "
18839 "determine the version of the operating system and other information about "
18840 "the virtual machine."
18844 #: ../inspector/virt-inspector.pod:25
18845 msgid "Virt-inspector produces XML output for feeding into other programs."
18849 #: ../inspector/virt-inspector.pod:27
18851 "In the normal usage, use C<virt-inspector -d domname> where C<domname> is "
18852 "the libvirt domain (see: C<virsh list --all>)."
18856 #: ../inspector/virt-inspector.pod:30
18858 "You can also run virt-inspector directly on disk images from a single "
18859 "virtual machine. Use C<virt-inspector -a disk.img>. In rare cases a domain "
18860 "has several block devices, in which case you should list several I<-a> "
18861 "options one after another, with the first corresponding to the guest's "
18862 "C</dev/sda>, the second to the guest's C</dev/sdb> and so on."
18866 #: ../inspector/virt-inspector.pod:37
18868 "You can also run virt-inspector on install disks, live CDs, bootable USB "
18869 "keys and similar."
18873 #: ../inspector/virt-inspector.pod:40
18875 "Virt-inspector can only inspect and report upon I<one domain at a time>. To "
18876 "inspect several virtual machines, you have to run virt-inspector several "
18877 "times (for example, from a shell script for-loop)."
18881 #: ../inspector/virt-inspector.pod:45
18883 "Because virt-inspector needs direct access to guest images, it won't "
18884 "normally work over remote libvirt connections."
18888 #: ../inspector/virt-inspector.pod:48
18890 "All of the information available from virt-inspector is also available "
18891 "through the core libguestfs inspection API (see L<guestfs(3)/INSPECTION>). "
18892 "The same information can also be fetched using guestfish or via libguestfs "
18893 "bindings in many programming languages (see L<guestfs(3)/USING LIBGUESTFS "
18894 "WITH OTHER PROGRAMMING LANGUAGES>)."
18898 #: ../inspector/virt-inspector.pod:81
18900 "Libvirt is only used if you specify a C<domname> on the command line. If "
18901 "you specify guest block devices directly (I<-a>), then libvirt is not used "
18906 #: ../inspector/virt-inspector.pod:94
18908 "When prompting for keys and passphrases, virt-inspector normally turns "
18909 "echoing off so you cannot see what you are typing. If you are not worried "
18910 "about Tempest attacks and there is no one else in the room you can specify "
18911 "this flag to see what you are typing."
18915 #: ../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
18917 "Specify the format of disk images given on the command line. If this is "
18918 "omitted then the format is autodetected from the content of the disk image."
18922 #: ../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
18924 "If disk images are requested from libvirt, then this program asks libvirt "
18925 "for this information. In this case, the value of the format parameter is "
18930 #: ../inspector/virt-inspector.pod:111 ../resize/virt-resize.pod:314 ../resize/virt-resize.pod:400 ../tools/virt-list-filesystems.pl:101 ../tools/virt-list-partitions.pl:102 ../tools/virt-tar.pl:151 ../tools/virt-win-reg.pl:152
18932 "If working with untrusted raw-format guest disk images, you should ensure "
18933 "the format is always specified."
18937 #: ../inspector/virt-inspector.pod:139
18938 msgid "Previous versions of virt-inspector allowed you to write either:"
18942 #: ../inspector/virt-inspector.pod:145
18945 " virt-inspector guestname\n"
18950 #: ../inspector/virt-inspector.pod:153
18955 #: ../inspector/virt-inspector.pod:155
18957 "The virt-inspector XML is described precisely in a RELAX NG schema file "
18958 "C<virt-inspector.rng> which is supplied with libguestfs. This section is "
18959 "just an overview."
18963 #: ../inspector/virt-inspector.pod:159
18965 "The top-level element is E<lt>operatingsystemsE<gt>, and it contains one or "
18966 "more E<lt>operatingsystemE<gt> elements. You would only see more than one "
18967 "E<lt>operatingsystemE<gt> element if the virtual machine is multi-boot, "
18968 "which is vanishingly rare in real world VMs."
18972 #: ../inspector/virt-inspector.pod:164
18973 msgid "E<lt>operatingsystemE<gt>"
18977 #: ../inspector/virt-inspector.pod:166
18979 "In the E<lt>operatingsystemE<gt> tag are various optional fields that "
18980 "describe the operating system, its architecture, the descriptive \"product "
18981 "name\" string, the type of OS and so on, as in this example:"
18985 #: ../inspector/virt-inspector.pod:170
18988 " <operatingsystems>\n"
18989 " <operatingsystem>\n"
18990 " <root>/dev/sda2</root>\n"
18991 " <name>windows</name>\n"
18992 " <arch>i386</arch>\n"
18993 " <distro>windows</distro>\n"
18994 " <product_name>Windows 7 Enterprise</product_name>\n"
18995 " <product_variant>Client</product_variant>\n"
18996 " <major_version>6</major_version>\n"
18997 " <minor_version>1</minor_version>\n"
18998 " <windows_systemroot>/Windows</windows_systemroot>\n"
18999 " <format>installed</format>\n"
19004 #: ../inspector/virt-inspector.pod:183
19006 "In brief, E<lt>nameE<gt> is the class of operating system (something like "
19007 "C<linux> or C<windows>), E<lt>distroE<gt> is the distribution (eg. C<fedora> "
19008 "but many other distros are recognized) and E<lt>archE<gt> is the guest "
19009 "architecture. The other fields are fairly self-explanatory, but because "
19010 "these fields are taken directly from the libguestfs inspection API you can "
19011 "find precise information from L<guestfs(3)/INSPECTION>."
19015 #: ../inspector/virt-inspector.pod:191
19017 "The E<lt>rootE<gt> element is the root filesystem device, but from the point "
19018 "of view of libguestfs (block devices may have completely different names "
19019 "inside the VM itself)."
19023 #: ../inspector/virt-inspector.pod:195
19024 msgid "E<lt>mountpointsE<gt>"
19028 #: ../inspector/virt-inspector.pod:197
19030 "Un*x-like guests typically have multiple filesystems which are mounted at "
19031 "various mountpoints, and these are described in the E<lt>mountpointsE<gt> "
19032 "element which looks like this:"
19036 #: ../inspector/virt-inspector.pod:201
19039 " <operatingsystems>\n"
19040 " <operatingsystem>\n"
19043 " <mountpoint dev=\"/dev/vg_f13x64/lv_root\">/</mountpoint>\n"
19044 " <mountpoint dev=\"/dev/sda1\">/boot</mountpoint>\n"
19045 " </mountpoints>\n"
19050 #: ../inspector/virt-inspector.pod:209
19052 "As with E<lt>rootE<gt>, devices are from the point of view of libguestfs, "
19053 "and may have completely different names inside the guest. Only mountable "
19054 "filesystems appear in this list, not things like swap devices."
19058 #: ../inspector/virt-inspector.pod:214
19059 msgid "E<lt>filesystemsE<gt>"
19063 #: ../inspector/virt-inspector.pod:216
19065 "E<lt>filesystemsE<gt> is like E<lt>mountpointsE<gt> but covers I<all> "
19066 "filesystems belonging to the guest, including swap and empty partitions. "
19067 "(In the rare case of a multi-boot guest, it covers filesystems belonging to "
19068 "this OS or shared with this OS and other OSes)."
19072 #: ../inspector/virt-inspector.pod:222
19073 msgid "You might see something like this:"
19077 #: ../inspector/virt-inspector.pod:224
19080 " <operatingsystems>\n"
19081 " <operatingsystem>\n"
19084 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19085 " <type>ext4</type>\n"
19086 " <label>Fedora-13-x86_64</label>\n"
19087 " <uuid>e6a4db1e-15c2-477b-ac2a-699181c396aa</uuid>\n"
19093 #: ../inspector/virt-inspector.pod:234
19095 "The optional elements within E<lt>filesystemE<gt> are the filesystem type, "
19096 "the label, and the UUID."
19100 #: ../inspector/virt-inspector.pod:237
19101 msgid "E<lt>applicationsE<gt>"
19105 #: ../inspector/virt-inspector.pod:239
19107 "The related elements E<lt>package_formatE<gt>, E<lt>package_managementE<gt> "
19108 "and E<lt>applicationsE<gt> describe applications installed in the virtual "
19113 #: ../inspector/virt-inspector.pod:243
19115 "E<lt>package_formatE<gt>, if present, describes the packaging system used. "
19116 "Typical values would be C<rpm> and C<deb>."
19120 #: ../inspector/virt-inspector.pod:246
19122 "E<lt>package_managementE<gt>, if present, describes the package manager. "
19123 "Typical values include C<yum>, C<up2date> and C<apt>"
19127 #: ../inspector/virt-inspector.pod:249
19128 msgid "E<lt>applicationsE<gt> lists the packages or applications installed."
19132 #: ../inspector/virt-inspector.pod:252
19135 " <operatingsystems>\n"
19136 " <operatingsystem>\n"
19138 " <applications>\n"
19140 " <name>coreutils</name>\n"
19141 " <version>8.5</version>\n"
19142 " <release>1</release>\n"
19143 " </application>\n"
19148 #: ../inspector/virt-inspector.pod:262
19150 "The version and release fields may not be available for some types guests. "
19151 "Other fields are possible, see "
19152 "L<guestfs(3)/guestfs_inspect_list_applications>."
19156 #: ../inspector/virt-inspector.pod:266
19157 msgid "E<lt>drive_mappingsE<gt>"
19161 #: ../inspector/virt-inspector.pod:268
19163 "For operating systems like Windows which use drive letters, virt-inspector "
19164 "is able to find out how drive letters map to filesystems."
19168 #: ../inspector/virt-inspector.pod:272
19171 " <operatingsystems>\n"
19172 " <operatingsystem>\n"
19174 " <drive_mappings>\n"
19175 " <drive_mapping name=\"C\">/dev/sda2</drive_mapping>\n"
19176 " <drive_mapping name=\"E\">/dev/sdb1</drive_mapping>\n"
19177 " </drive_mappings>\n"
19182 #: ../inspector/virt-inspector.pod:280
19184 "In the example above, drive C maps to the filesystem on the second partition "
19185 "on the first disk, and drive E maps to the filesystem on the first partition "
19186 "on the second disk."
19190 #: ../inspector/virt-inspector.pod:284
19192 "Note that this only covers permanent local filesystem mappings, not things "
19193 "like network shares. Furthermore NTFS volume mount points may not be listed "
19198 #: ../inspector/virt-inspector.pod:288
19199 msgid "E<lt>iconE<gt>"
19203 #: ../inspector/virt-inspector.pod:290
19205 "Virt-inspector is sometimes able to extract an icon or logo for the guest. "
19206 "The icon is returned as base64-encoded PNG data. Note that the icon can be "
19207 "very large and high quality."
19211 #: ../inspector/virt-inspector.pod:294
19214 " <operatingsystems>\n"
19215 " <operatingsystem>\n"
19218 " iVBORw0KGgoAAAANSUhEUgAAAGAAAABg[.......]\n"
19219 " [... many lines of base64 data ...]\n"
19225 #: ../inspector/virt-inspector.pod:302
19227 "To display the icon, you have to extract it and convert the base64 data back "
19228 "to a binary file. Use an XPath query or simply an editor to extract the "
19229 "data, then use the coreutils L<base64(1)> program to do the conversion back "
19234 #: ../inspector/virt-inspector.pod:307
19237 " base64 -i -d < icon.data > icon.png\n"
19242 #: ../inspector/virt-inspector.pod:309
19243 msgid "INSPECTING INSTALL DISKS, LIVE CDs"
19247 #: ../inspector/virt-inspector.pod:311
19249 "Virt-inspector can detect some operating system installers on install disks, "
19250 "live CDs, bootable USB keys and more."
19254 #: ../inspector/virt-inspector.pod:314
19256 "In this case the E<lt>formatE<gt> tag will contain C<installer> and other "
19257 "fields may be present to indicate a live CD, network installer, or one part "
19258 "of a multipart CD. For example:"
19262 #: ../inspector/virt-inspector.pod:318
19265 " <operatingsystems>\n"
19266 " <operatingsystem>\n"
19267 " <root>/dev/sda</root>\n"
19268 " <name>linux</name>\n"
19269 " <arch>i386</arch>\n"
19270 " <distro>ubuntu</distro>\n"
19271 " <product_name>Ubuntu 10.10 "Maverick "
19272 "Meerkat"</product_name>\n"
19273 " <major_version>10</major_version>\n"
19274 " <minor_version>10</minor_version>\n"
19275 " <format>installer</format>\n"
19281 #: ../inspector/virt-inspector.pod:330
19282 msgid "USING XPATH"
19286 #: ../inspector/virt-inspector.pod:332
19288 "You can use the XPath query language, and/or the xpath tool, in order to "
19289 "select parts of the XML."
19293 #: ../inspector/virt-inspector.pod:337
19296 " $ virt-inspector -d Guest | xpath //filesystems\n"
19297 " Found 1 nodes:\n"
19300 " <filesystem dev=\"/dev/vg_f13x64/lv_root\">\n"
19301 " <type>ext4</type>\n"
19307 #: ../inspector/virt-inspector.pod:345
19310 " $ virt-inspector -d Guest | \\\n"
19311 " xpath \"string(//filesystem[@dev='/dev/sda1']/type)\"\n"
19312 " Query didn't return a nodeset. Value: ext4\n"
19317 #: ../inspector/virt-inspector.pod:356
19318 msgid "OLD VERSIONS OF VIRT-INSPECTOR"
19322 #: ../inspector/virt-inspector.pod:358
19324 "Early versions of libguestfs shipped with a different virt-inspector program "
19325 "written in Perl (the current version is written in C). The XML output of "
19326 "the Perl virt-inspector was different and it could also output in other "
19327 "formats like text."
19331 #: ../inspector/virt-inspector.pod:363
19332 msgid "The old virt-inspector is no longer supported or shipped with libguestfs."
19336 #: ../inspector/virt-inspector.pod:366
19338 "To confuse matters further, in Red Hat Enterprise Linux 6 we ship two "
19339 "versions of virt-inspector with different names:"
19343 #: ../inspector/virt-inspector.pod:369
19346 " virt-inspector Old Perl version.\n"
19347 " virt-inspector2 New C version.\n"
19352 #: ../inspector/virt-inspector.pod:374
19354 "L<guestfs(3)>, L<guestfish(1)>, L<http://www.w3.org/TR/xpath/>, "
19355 "L<base64(1)>, L<http://libguestfs.org/>."
19359 #: ../inspector/virt-inspector.pod:390
19360 msgid "Matthew Booth L<mbooth@redhat.com>"
19364 #: ../java/examples/guestfs-java.pod:5
19365 msgid "guestfs-java - How to use libguestfs from Java"
19369 #: ../java/examples/guestfs-java.pod:9
19372 " import com.redhat.et.libguestfs.*;\n"
19377 #: ../java/examples/guestfs-java.pod:11
19380 " GuestFS g = new GuestFS ();\n"
19381 " g.add_drive_opts (\"disk.img\", null);\n"
19387 #: ../java/examples/guestfs-java.pod:17
19389 "This manual page documents how to call libguestfs from the Java programming "
19390 "language. This page just documents the differences from the C API and gives "
19391 "some examples. If you are not familiar with using libguestfs, you also need "
19392 "to read L<guestfs(3)>."
19396 #: ../java/examples/guestfs-java.pod:22 ../ocaml/examples/guestfs-ocaml.pod:53
19397 msgid "CLOSING THE HANDLE"
19401 #: ../java/examples/guestfs-java.pod:24
19403 "The handle is closed when it is reaped by the garbage collector. Because "
19404 "libguestfs handles include a lot of state, it is also possible to close (and "
19405 "hence free) them explicitly by calling the C<close> method."
19409 #: ../java/examples/guestfs-java.pod:29 ../ocaml/examples/guestfs-ocaml.pod:60 ../python/examples/guestfs-python.pod:21 ../ruby/examples/guestfs-ruby.pod:22
19414 #: ../java/examples/guestfs-java.pod:31
19416 "Errors from libguestfs functions are mapped into the C<LibGuestFSException> "
19417 "exception. This has a single parameter which is the error message (a "
19422 #: ../java/examples/guestfs-java.pod:35
19423 msgid "Calling any method on a closed handle raises the same exception."
19427 #: ../java/examples/guestfs-java.pod:47
19429 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-ocaml(3)>, "
19430 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
19431 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>, L<http://caml.inria.fr/>."
19435 #: ../java/examples/guestfs-java.pod:63 ../perl/examples/guestfs-perl.pod:57
19436 msgid "Copyright (C) 2011 Red Hat Inc. L<http://libguestfs.org/>"
19440 #: ../ocaml/examples/guestfs-ocaml.pod:5
19441 msgid "guestfs-ocaml - How to use libguestfs from OCaml"
19445 #: ../ocaml/examples/guestfs-ocaml.pod:9
19446 msgid "Module style:"
19450 #: ../ocaml/examples/guestfs-ocaml.pod:11
19453 " let g = Guestfs.create () in\n"
19454 " Guestfs.add_drive_opts g ~format:\"raw\" ~readonly:true \"disk.img\";\n"
19455 " Guestfs.launch g;\n"
19460 #: ../ocaml/examples/guestfs-ocaml.pod:15
19461 msgid "Object-oriented style:"
19465 #: ../ocaml/examples/guestfs-ocaml.pod:17
19468 " let g = new Guestfs.guestfs () in\n"
19469 " g#add_drive_opts ~format:\"raw\" ~readonly:true \"disk.img\";\n"
19475 #: ../ocaml/examples/guestfs-ocaml.pod:21
19478 " ocamlfind opt prog.ml -package guestfs -linkpkg -o prog\n"
19480 " ocamlopt -I +guestfs mlguestfs.cmxa prog.ml -o prog\n"
19485 #: ../ocaml/examples/guestfs-ocaml.pod:27
19487 "This manual page documents how to call libguestfs from the OCaml programming "
19488 "language. This page just documents the differences from the C API and gives "
19489 "some examples. If you are not familiar with using libguestfs, you also need "
19490 "to read L<guestfs(3)>."
19494 #: ../ocaml/examples/guestfs-ocaml.pod:32
19495 msgid "PROGRAMMING STYLES"
19499 #: ../ocaml/examples/guestfs-ocaml.pod:34
19501 "There are two different programming styles supported by the OCaml bindings. "
19502 "You can use a module style, with each C function mapped to an OCaml "
19507 #: ../ocaml/examples/guestfs-ocaml.pod:38
19510 " int guestfs_set_verbose (guestfs_h *g, int flag);\n"
19515 #: ../ocaml/examples/guestfs-ocaml.pod:40
19520 #: ../ocaml/examples/guestfs-ocaml.pod:42
19523 " val Guestfs.set_verbose : Guestfs.t -> bool -> unit\n"
19528 #: ../ocaml/examples/guestfs-ocaml.pod:44
19530 "Alternately you can use an object-oriented style, calling methods on the "
19531 "class C<Guestfs.guestfs>:"
19535 #: ../ocaml/examples/guestfs-ocaml.pod:47
19538 " method set_verbose : bool -> unit\n"
19543 #: ../ocaml/examples/guestfs-ocaml.pod:49
19545 "The object-oriented style is usually briefer, and the minor performance "
19546 "penalty isn't noticable in the general overhead of performing libguestfs "
19551 #: ../ocaml/examples/guestfs-ocaml.pod:55
19553 "The handle is closed when it is reaped by the garbage collector. Because "
19554 "libguestfs handles include a lot of state, it is also possible to close (and "
19555 "hence free) them explicitly by calling C<Guestfs.close> or the C<#close> "
19560 #: ../ocaml/examples/guestfs-ocaml.pod:62
19562 "Errors from libguestfs functions are mapped into the C<Guestfs.Error> "
19563 "exception. This has a single parameter which is the error message (a "
19568 #: ../ocaml/examples/guestfs-ocaml.pod:66
19570 "Calling any function/method on a closed handle raises "
19571 "C<Guestfs.Handle_closed>. The single parameter is the name of the function "
19576 #: ../ocaml/examples/guestfs-ocaml.pod:80
19578 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
19579 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-recipes(1)>, "
19580 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>, L<http://caml.inria.fr/>."
19584 #: ../perl/examples/guestfs-perl.pod:5
19585 msgid "guestfs-perl - How to use libguestfs from Perl"
19589 #: ../perl/examples/guestfs-perl.pod:9
19592 " use Sys::Guestfs;\n"
19597 #: ../perl/examples/guestfs-perl.pod:11
19600 " my $h = Sys::Guestfs->new ();\n"
19601 " $h->add_drive_opts ('guest.img', format => 'raw');\n"
19602 " $h->launch ();\n"
19603 " $h->mount_options ('', '/dev/sda1', '/');\n"
19604 " $h->touch ('/hello');\n"
19610 #: ../perl/examples/guestfs-perl.pod:20
19612 "This manual page documents how to call libguestfs from the Perl programming "
19613 "language. This page just documents the differences from the C API and gives "
19614 "some examples. If you are not familiar with using libguestfs, you also need "
19615 "to read L<guestfs(3)>. To read the full Perl API, see L<Sys::Guestfs(3)>."
19619 #: ../perl/examples/guestfs-perl.pod:26
19624 #: ../perl/examples/guestfs-perl.pod:28
19626 "Errors from libguestfs functions turn into calls to C<croak> (see "
19631 #: ../perl/examples/guestfs-perl.pod:41
19633 "L<Sys::Guestfs(3)>, L<guestfs(3)>, L<guestfs-examples(3)>, "
19634 "L<guestfs-java(3)>, L<guestfs-ocaml(3)>, L<guestfs-python(3)>, "
19635 "L<guestfs-recipes(1)>, L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
19639 #: ../python/examples/guestfs-python.pod:5
19640 msgid "guestfs-python - How to use libguestfs from Python"
19644 #: ../python/examples/guestfs-python.pod:9
19647 " import guestfs\n"
19648 " g = guestfs.GuestFS ()\n"
19649 " g.add_drive_opts (\"disk.img\", format=\"raw\", readonly=1)\n"
19655 #: ../python/examples/guestfs-python.pod:16
19657 "This manual page documents how to call libguestfs from the Python "
19658 "programming language. This page just documents the differences from the C "
19659 "API and gives some examples. If you are not familiar with using libguestfs, "
19660 "you also need to read L<guestfs(3)>."
19664 #: ../python/examples/guestfs-python.pod:23
19666 "Errors from libguestfs functions are mapped into C<RuntimeException> with a "
19667 "single string argument which is the error message."
19671 #: ../python/examples/guestfs-python.pod:26
19672 msgid "MORE DOCUMENTATION"
19676 #: ../python/examples/guestfs-python.pod:28
19681 #: ../python/examples/guestfs-python.pod:30
19685 " >>> import guestfs\n"
19686 " >>> help (guestfs)\n"
19691 #: ../python/examples/guestfs-python.pod:44
19693 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
19694 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-recipes(1)>, "
19695 "L<guestfs-ruby(3)>, L<http://libguestfs.org/>."
19699 #: ../rescue/virt-rescue.pod:5
19700 msgid "virt-rescue - Run a rescue shell on a virtual machine"
19704 #: ../rescue/virt-rescue.pod:9
19707 " virt-rescue [--options] -d domname\n"
19712 #: ../rescue/virt-rescue.pod:11
19715 " virt-rescue [--options] -a disk.img [-a disk.img ...]\n"
19720 #: ../rescue/virt-rescue.pod:15
19723 " virt-rescue [--options] domname\n"
19728 #: ../rescue/virt-rescue.pod:17
19731 " virt-rescue [--options] disk.img [disk.img ...]\n"
19736 #: ../rescue/virt-rescue.pod:21
19738 "You must I<not> use C<virt-rescue> on live virtual machines. Doing so will "
19739 "probably result in disk corruption in the VM. C<virt-rescue> tries to stop "
19740 "you from doing this, but doesn't catch all cases."
19744 #: ../rescue/virt-rescue.pod:25
19746 "However if you use the I<--ro> (read only) option, then you can attach a "
19747 "shell to a live virtual machine. The results might be strange or "
19748 "inconsistent at times but you won't get disk corruption."
19752 #: ../rescue/virt-rescue.pod:31
19754 "virt-rescue is like a Rescue CD, but for virtual machines, and without the "
19755 "need for a CD. virt-rescue gives you a rescue shell and some simple "
19756 "recovery tools which you can use to examine or rescue a virtual machine or "
19761 #: ../rescue/virt-rescue.pod:36
19763 "You can run virt-rescue on any virtual machine known to libvirt, or directly "
19764 "on disk image(s):"
19768 #: ../rescue/virt-rescue.pod:39
19771 " virt-rescue -d GuestName\n"
19776 #: ../rescue/virt-rescue.pod:41
19779 " virt-rescue --ro -a /path/to/disk.img\n"
19784 #: ../rescue/virt-rescue.pod:43
19787 " virt-rescue -a /dev/sdc\n"
19792 #: ../rescue/virt-rescue.pod:45
19793 msgid "For live VMs you I<must> use the --ro option."
19797 #: ../rescue/virt-rescue.pod:47
19799 "When you run virt-rescue on a virtual machine or disk image, you are placed "
19800 "in an interactive bash shell where you can use many ordinary Linux "
19801 "commands. What you see in C</> (C</bin>, C</lib> etc) is the rescue "
19802 "appliance. You must mount the virtual machine's filesystems by hand. There "
19803 "is an empty directory called C</sysroot> where you can mount filesystems."
19807 #: ../rescue/virt-rescue.pod:54
19809 "In the example below, we list logical volumes, then choose one to mount "
19810 "under C</sysroot>:"
19814 #: ../rescue/virt-rescue.pod:57
19818 " LV VG Attr LSize Origin Snap% Move Log Copy% Convert\n"
19819 " lv_root vg_f11x64 -wi-a- 8.83G\n"
19820 " lv_swap vg_f11x64 -wi-a- 992.00M\n"
19821 " ><rescue> mount /dev/vg_f11x64/lv_root /sysroot\n"
19822 " ><rescue> ls /sysroot\n"
19827 #: ../rescue/virt-rescue.pod:64
19829 "If you don't know what filesystems are available on the virtual machine then "
19830 "you can use commands such as L<parted(8)> and L<lvs(8)> to find out."
19834 #: ../rescue/virt-rescue.pod:70
19836 "Virt-rescue can be used on I<any> disk image file or device, not just a "
19837 "virtual machine. For example you can use it on a blank file if you want to "
19838 "partition that file (although we would recommend using L<guestfish(1)> "
19839 "instead as it is more suitable for this purpose). You can even use "
19840 "virt-rescue on things like SD cards."
19844 #: ../rescue/virt-rescue.pod:76
19846 "Virt-rescue does not require root. You only need to run it as root if you "
19847 "need root to open the disk image."
19851 #: ../rescue/virt-rescue.pod:79
19853 "This tool is just designed for quick interactive hacking on a virtual "
19854 "machine. For more structured access to a virtual machine disk image, you "
19855 "should use L<guestfs(3)>. To get a structured shell that you can use to "
19856 "make scripted changes to guests, use L<guestfish(1)>."
19860 #: ../rescue/virt-rescue.pod:103
19861 msgid "B<--append kernelopts>"
19865 #: ../rescue/virt-rescue.pod:105
19866 msgid "Pass additional options to the rescue kernel."
19870 #: ../rescue/virt-rescue.pod:135
19873 " virt-rescue --format=raw -a disk.img\n"
19878 #: ../rescue/virt-rescue.pod:139
19881 " virt-rescue --format=raw -a disk.img --format -a another.img\n"
19886 #: ../rescue/virt-rescue.pod:148
19891 #: ../rescue/virt-rescue.pod:150
19892 msgid "B<--memsize MB>"
19896 #: ../rescue/virt-rescue.pod:152
19898 "Change the amount of memory allocated to the rescue system. The default is "
19899 "set by libguestfs and is small but adequate for running system tools. The "
19900 "occasional program might need more memory. The parameter is specified in "
19905 #: ../rescue/virt-rescue.pod:157
19906 msgid "B<--network>"
19910 #: ../rescue/virt-rescue.pod:159
19911 msgid "Enable QEMU user networking in the guest. See L</NETWORK>."
19915 #: ../rescue/virt-rescue.pod:165
19916 msgid "Open the image read-only."
19920 #: ../rescue/virt-rescue.pod:175
19922 "Enable SELinux in the rescue appliance. You should read "
19923 "L<guestfs(3)/SELINUX> before using this option."
19927 #: ../rescue/virt-rescue.pod:194
19929 "This changes the I<-a> and I<-d> options so that disks are added and mounts "
19930 "are done read-write."
19934 #: ../rescue/virt-rescue.pod:207
19935 msgid "Previous versions of virt-rescue allowed you to write either:"
19939 #: ../rescue/virt-rescue.pod:209
19942 " virt-rescue disk.img [disk.img ...]\n"
19947 #: ../rescue/virt-rescue.pod:213
19950 " virt-rescue guestname\n"
19955 #: ../rescue/virt-rescue.pod:221
19960 #: ../rescue/virt-rescue.pod:223
19962 "Adding the I<--network> option enables QEMU user networking in the rescue "
19963 "appliance. There are some differences between user networking and ordinary "
19968 #: ../rescue/virt-rescue.pod:229
19969 msgid "ping does not work"
19973 #: ../rescue/virt-rescue.pod:231
19975 "Because the ICMP ECHO_REQUEST protocol generally requires root in order to "
19976 "send the ping packets, and because virt-rescue must be able to run as "
19977 "non-root, QEMU user networking is not able to emulate the L<ping(8)> "
19978 "command. The ping command will appear to resolve addresses but will not be "
19979 "able to send or receive any packets. This does not mean that the network is "
19984 #: ../rescue/virt-rescue.pod:238
19985 msgid "cannot receive connections"
19989 #: ../rescue/virt-rescue.pod:240
19990 msgid "QEMU user networking cannot receive incoming connections."
19994 #: ../rescue/virt-rescue.pod:242
19995 msgid "making TCP connections"
19999 #: ../rescue/virt-rescue.pod:244
20001 "The virt-rescue appliance needs to be small and so does not include many "
20002 "network tools. In particular there is no L<telnet(1)> command. You can "
20003 "make TCP connections from the shell using the magical "
20004 "C</dev/tcp/E<lt>hostnameE<gt>/E<lt>portE<gt>> syntax:"
20008 #: ../rescue/virt-rescue.pod:249
20011 " exec 3<>/dev/tcp/redhat.com/80\n"
20012 " echo \"GET /\" >&3\n"
20018 #: ../rescue/virt-rescue.pod:253
20019 msgid "See L<bash(1)> for more details."
20023 #: ../rescue/virt-rescue.pod:259
20025 "Several environment variables affect virt-rescue. See "
20026 "L<guestfs(3)/ENVIRONMENT VARIABLES> for the complete list."
20030 #: ../rescue/virt-rescue.pod:286
20032 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
20033 "L<http://libguestfs.org/>."
20037 #: ../resize/virt-resize.pod:5
20038 msgid "virt-resize - Resize a virtual machine disk"
20042 #: ../resize/virt-resize.pod:9
20045 " virt-resize [--resize /dev/sdaN=[+/-]<size>[%]]\n"
20046 " [--expand /dev/sdaN] [--shrink /dev/sdaN]\n"
20047 " [--ignore /dev/sdaN] [--delete /dev/sdaN] [...] indisk outdisk\n"
20052 #: ../resize/virt-resize.pod:15
20054 "Virt-resize is a tool which can resize a virtual machine disk, making it "
20055 "larger or smaller overall, and resizing or deleting any partitions contained "
20060 #: ../resize/virt-resize.pod:19
20062 "Virt-resize B<cannot> resize disk images in-place. Virt-resize B<should "
20063 "not> be used on live virtual machines - for consistent results, shut the "
20064 "virtual machine down before resizing it."
20068 #: ../resize/virt-resize.pod:23
20070 "If you are not familiar with the associated tools: L<virt-filesystems(1)> "
20071 "and L<virt-df(1)>, we recommend you go and read those manual pages first."
20075 #: ../resize/virt-resize.pod:31 ../src/guestfs.pod:469 ../src/guestfs.pod:1257 ../src/guestfs.pod:1395 ../src/guestfs.pod:2465
20080 #: ../resize/virt-resize.pod:33
20082 "Copy C<olddisk> to C<newdisk>, extending one of the guest's partitions to "
20083 "fill the extra 5GB of space."
20087 #: ../resize/virt-resize.pod:36
20090 " virt-filesystems --long -h --all -a olddisk\n"
20095 #: ../resize/virt-resize.pod:38
20098 " truncate -r olddisk newdisk\n"
20099 " truncate -s +5G newdisk\n"
20104 #: ../resize/virt-resize.pod:41
20107 " # Note \"/dev/sda2\" is a partition inside the \"olddisk\" file.\n"
20108 " virt-resize --expand /dev/sda2 olddisk newdisk\n"
20113 #: ../resize/virt-resize.pod:44 ../src/guestfs.pod:475 ../src/guestfs.pod:1261 ../src/guestfs.pod:1399 ../src/guestfs.pod:2490
20118 #: ../resize/virt-resize.pod:46
20120 "As above, but make the /boot partition 200MB bigger, while giving the "
20121 "remaining space to /dev/sda2:"
20125 #: ../resize/virt-resize.pod:49
20128 " virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20129 " olddisk newdisk\n"
20134 #: ../resize/virt-resize.pod:52 ../src/guestfs.pod:486 ../src/guestfs.pod:1405
20139 #: ../resize/virt-resize.pod:54
20141 "As in the first example, but expand a logical volume as the final step. "
20142 "This is what you would typically use for Linux guests that use LVM:"
20146 #: ../resize/virt-resize.pod:58
20149 " virt-resize --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root \\\n"
20150 " olddisk newdisk\n"
20155 #: ../resize/virt-resize.pod:61
20160 #: ../resize/virt-resize.pod:63
20162 "As in the first example, but the output format will be qcow2 instead of a "
20167 #: ../resize/virt-resize.pod:66
20170 " qemu-img create -f qcow2 newdisk.qcow2 15G\n"
20171 " virt-resize --expand /dev/sda2 olddisk newdisk.qcow2\n"
20176 #: ../resize/virt-resize.pod:71
20177 msgid "DETAILED USAGE"
20181 #: ../resize/virt-resize.pod:73
20182 msgid "EXPANDING A VIRTUAL MACHINE DISK"
20186 #: ../resize/virt-resize.pod:77
20187 msgid "1. Shut down the virtual machine"
20191 #: ../resize/virt-resize.pod:79
20192 msgid "2. Locate input disk image"
20196 #: ../resize/virt-resize.pod:81
20198 "Locate the input disk image (ie. the file or device on the host containing "
20199 "the guest's disk). If the guest is managed by libvirt, you can use C<virsh "
20200 "dumpxml> like this to find the disk image name:"
20204 #: ../resize/virt-resize.pod:85
20207 " # virsh dumpxml guestname | xpath /domain/devices/disk/source\n"
20208 " Found 1 nodes:\n"
20210 " <source dev=\"/dev/vg/lv_guest\" />\n"
20215 #: ../resize/virt-resize.pod:90
20216 msgid "3. Look at current sizing"
20220 #: ../resize/virt-resize.pod:92
20221 msgid "Use L<virt-filesystems(1)> to display the current partitions and sizes:"
20225 #: ../resize/virt-resize.pod:95
20228 " # virt-filesystems --long --parts --blkdevs -h -a /dev/vg/lv_guest\n"
20229 " Name Type Size Parent\n"
20230 " /dev/sda1 partition 101M /dev/sda\n"
20231 " /dev/sda2 partition 7.9G /dev/sda\n"
20232 " /dev/sda device 8.0G -\n"
20237 #: ../resize/virt-resize.pod:101
20239 "(This example is a virtual machine with an 8 GB disk which we would like to "
20240 "expand up to 10 GB)."
20244 #: ../resize/virt-resize.pod:104
20245 msgid "4. Create output disk"
20249 #: ../resize/virt-resize.pod:106
20251 "Virt-resize cannot do in-place disk modifications. You have to have space "
20252 "to store the resized output disk."
20256 #: ../resize/virt-resize.pod:109
20257 msgid "To store the resized disk image in a file, create a file of a suitable size:"
20261 #: ../resize/virt-resize.pod:112
20264 " # rm -f outdisk\n"
20265 " # truncate -s 10G outdisk\n"
20270 #: ../resize/virt-resize.pod:115
20271 msgid "Or use L<lvcreate(1)> to create a logical volume:"
20275 #: ../resize/virt-resize.pod:117
20278 " # lvcreate -L 10G -n lv_name vg_name\n"
20283 #: ../resize/virt-resize.pod:119
20284 msgid "Or use L<virsh(1)> vol-create-as to create a libvirt storage volume:"
20288 #: ../resize/virt-resize.pod:121
20291 " # virsh pool-list\n"
20292 " # virsh vol-create-as poolname newvol 10G\n"
20297 #: ../resize/virt-resize.pod:124
20302 #: ../resize/virt-resize.pod:126
20304 "virt-resize takes two mandatory parameters, the input disk (eg. device or "
20305 "file) and the output disk. The output disk is the one created in the "
20310 #: ../resize/virt-resize.pod:130
20313 " # virt-resize indisk outdisk\n"
20318 #: ../resize/virt-resize.pod:132
20320 "This command just copies disk image C<indisk> to disk image C<outdisk> "
20321 "I<without> resizing or changing any existing partitions. If C<outdisk> is "
20322 "larger, then an extra, empty partition is created at the end of the disk "
20323 "covering the extra space. If C<outdisk> is smaller, then it will give an "
20328 #: ../resize/virt-resize.pod:138
20330 "More realistically you'd want to expand existing partitions in the disk "
20331 "image by passing extra options (for the full list see the L</OPTIONS> "
20336 #: ../resize/virt-resize.pod:142
20338 "L</--expand> is the most useful option. It expands the named partition "
20339 "within the disk to fill any extra space:"
20343 #: ../resize/virt-resize.pod:145
20346 " # virt-resize --expand /dev/sda2 indisk outdisk\n"
20351 #: ../resize/virt-resize.pod:147
20353 "(In this case, an extra partition is I<not> created at the end of the disk, "
20354 "because there will be no unused space)."
20358 #: ../resize/virt-resize.pod:150
20360 "L</--resize> is the other commonly used option. The following would "
20361 "increase the size of /dev/sda1 by 200M, and expand /dev/sda2 to fill the "
20362 "rest of the available space:"
20366 #: ../resize/virt-resize.pod:154
20369 " # virt-resize --resize /dev/sda1=+200M --expand /dev/sda2 \\\n"
20370 " indisk outdisk\n"
20375 #: ../resize/virt-resize.pod:157
20377 "If the expanded partition in the image contains a filesystem or LVM PV, then "
20378 "if virt-resize knows how, it will resize the contents, the equivalent of "
20379 "calling a command such as L<pvresize(8)>, L<resize2fs(8)>, L<ntfsresize(8)> "
20380 "or L<btrfs(8)>. However virt-resize does not know how to resize some "
20381 "filesystems, so you would have to online resize them after booting the "
20386 #: ../resize/virt-resize.pod:164
20387 msgid "Other options are covered below."
20391 #: ../resize/virt-resize.pod:166
20396 #: ../resize/virt-resize.pod:168
20397 msgid "Thoroughly test the new disk image I<before> discarding the old one."
20401 #: ../resize/virt-resize.pod:170
20402 msgid "If you are using libvirt, edit the XML to point at the new disk:"
20406 #: ../resize/virt-resize.pod:172
20409 " # virsh edit guestname\n"
20414 #: ../resize/virt-resize.pod:174
20416 "Change E<lt>source ...E<gt>, see "
20417 "L<http://libvirt.org/formatdomain.html#elementsDisks>"
20421 #: ../resize/virt-resize.pod:177
20422 msgid "Then start up the domain with the new, resized disk:"
20426 #: ../resize/virt-resize.pod:179
20429 " # virsh start guestname\n"
20434 #: ../resize/virt-resize.pod:181
20436 "and check that it still works. See also the L</NOTES> section below for "
20437 "additional information."
20441 #: ../resize/virt-resize.pod:184
20442 msgid "7. Resize LVs etc inside the guest"
20446 #: ../resize/virt-resize.pod:186
20447 msgid "(This can also be done offline using L<guestfish(1)>)"
20451 #: ../resize/virt-resize.pod:188
20453 "Once the guest has booted you should see the new space available, at least "
20454 "for filesystems that virt-resize knows how to resize, and for PVs. The user "
20455 "may need to resize LVs inside PVs, and also resize filesystem types that "
20456 "virt-resize does not know how to expand."
20460 #: ../resize/virt-resize.pod:195
20461 msgid "SHRINKING A VIRTUAL MACHINE DISK"
20465 #: ../resize/virt-resize.pod:197
20467 "Shrinking is somewhat more complex than expanding, and only an overview is "
20472 #: ../resize/virt-resize.pod:200
20474 "Firstly virt-resize will not attempt to shrink any partition content (PVs, "
20475 "filesystems). The user has to shrink content before passing the disk image "
20476 "to virt-resize, and virt-resize will check that the content has been shrunk "
20481 #: ../resize/virt-resize.pod:205
20482 msgid "(Shrinking can also be done offline using L<guestfish(1)>)"
20486 #: ../resize/virt-resize.pod:207
20488 "After shrinking PVs and filesystems, shut down the guest, and proceed with "
20489 "steps 3 and 4 above to allocate a new disk image."
20493 #: ../resize/virt-resize.pod:210
20494 msgid "Then run virt-resize with any of the I<--shrink> and/or I<--resize> options."
20498 #: ../resize/virt-resize.pod:213
20499 msgid "IGNORING OR DELETING PARTITIONS"
20503 #: ../resize/virt-resize.pod:215
20505 "virt-resize also gives a convenient way to ignore or delete partitions when "
20506 "copying from the input disk to the output disk. Ignoring a partition speeds "
20507 "up the copy where you don't care about the existing contents of a "
20508 "partition. Deleting a partition removes it completely, but note that it "
20509 "also renumbers any partitions after the one which is deleted, which can "
20510 "leave some guests unbootable."
20514 #: ../resize/virt-resize.pod:222
20515 msgid "QCOW2 AND NON-SPARSE RAW FORMATS"
20519 #: ../resize/virt-resize.pod:224
20521 "If the input disk is in qcow2 format, then you may prefer that the output is "
20522 "in qcow2 format as well. Alternately, virt-resize can convert the format on "
20523 "the fly. The output format is simply determined by the format of the empty "
20524 "output container that you provide. Thus to create qcow2 output, use:"
20528 #: ../resize/virt-resize.pod:230
20531 " qemu-img create [-c] -f qcow2 outdisk [size]\n"
20536 #: ../resize/virt-resize.pod:232
20537 msgid "instead of the truncate command (use I<-c> for a compressed disk)."
20541 #: ../resize/virt-resize.pod:234
20542 msgid "Similarly, to get non-sparse raw output use:"
20546 #: ../resize/virt-resize.pod:236
20549 " fallocate -l size outdisk\n"
20554 #: ../resize/virt-resize.pod:238
20556 "(on older systems that don't have the L<fallocate(1)> command use C<dd "
20557 "if=/dev/zero of=outdisk bs=1M count=..>)"
20561 #: ../resize/virt-resize.pod:247
20562 msgid "Display help."
20566 #: ../resize/virt-resize.pod:249
20571 #: ../resize/virt-resize.pod:251 ../tools/virt-make-fs.pl:177 ../tools/virt-win-reg.pl:120
20576 #: ../resize/virt-resize.pod:253 ../tools/virt-win-reg.pl:122
20577 msgid "Enable debugging messages."
20581 #: ../resize/virt-resize.pod:255
20582 msgid "B<--delete part>"
20586 #: ../resize/virt-resize.pod:257
20588 "Delete the named partition. It would be more accurate to describe this as "
20589 "\"don't copy it over\", since virt-resize doesn't do in-place changes and "
20590 "the original disk image is left intact."
20594 #: ../resize/virt-resize.pod:261
20596 "Note that when you delete a partition, then anything contained in the "
20597 "partition is also deleted. Furthermore, this causes any partitions that "
20598 "come after to be I<renumbered>, which can easily make your guest unbootable."
20602 #: ../resize/virt-resize.pod:266 ../resize/virt-resize.pod:327 ../resize/virt-resize.pod:448
20603 msgid "You can give this option multiple times."
20607 #: ../resize/virt-resize.pod:268
20608 msgid "B<--expand part>"
20612 #: ../resize/virt-resize.pod:270
20614 "Expand the named partition so it uses up all extra space (space left over "
20615 "after any other resize changes that you request have been done)."
20619 #: ../resize/virt-resize.pod:273
20621 "If virt-resize knows how, it will expand the direct content of the "
20622 "partition. For example, if the partition is an LVM PV, it will expand the "
20623 "PV to fit (like calling L<pvresize(8)>). Virt-resize leaves any other "
20624 "content it doesn't know about alone."
20628 #: ../resize/virt-resize.pod:278
20629 msgid "Currently virt-resize can resize:"
20633 #: ../resize/virt-resize.pod:284
20634 msgid "ext2, ext3 and ext4 filesystems."
20638 #: ../resize/virt-resize.pod:288
20639 msgid "NTFS filesystems, if libguestfs was compiled with support for NTFS."
20643 #: ../resize/virt-resize.pod:290
20645 "The filesystem must have been shut down consistently last time it was used. "
20646 "Additionally, L<ntfsresize(8)> marks the resized filesystem as requiring a "
20647 "consistency check, so at the first boot after resizing Windows will check "
20652 #: ../resize/virt-resize.pod:297
20654 "LVM PVs (physical volumes). virt-resize does not usually resize anything "
20655 "inside the PV, but see the I<--LV-expand> option. The user could also "
20656 "resize LVs as desired after boot."
20660 #: ../resize/virt-resize.pod:303
20661 msgid "Btrfs filesystems, if libguestfs was compiled with support for btrfs."
20665 #: ../resize/virt-resize.pod:307 ../resize/virt-resize.pod:476
20666 msgid "Note that you cannot use I<--expand> and I<--shrink> together."
20670 #: ../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
20671 msgid "B<--format> raw"
20675 #: ../resize/virt-resize.pod:311
20677 "Specify the format of the input disk image. If this flag is not given then "
20678 "it is auto-detected from the image itself."
20682 #: ../resize/virt-resize.pod:317
20684 "Note that this option I<does not> affect the output format. See L</QCOW2 "
20685 "AND NON-SPARSE RAW FORMATS>."
20689 #: ../resize/virt-resize.pod:320
20690 msgid "B<--ignore part>"
20694 #: ../resize/virt-resize.pod:322
20696 "Ignore the named partition. Effectively this means the partition is "
20697 "allocated on the destination disk, but the content is not copied across from "
20698 "the source disk. The content of the partition will be blank (all zero "
20703 #: ../resize/virt-resize.pod:329
20704 msgid "B<--LV-expand logvol>"
20708 #: ../resize/virt-resize.pod:331
20710 "This takes the logical volume and, as a final step, expands it to fill all "
20711 "the space available in its volume group. A typical usage, assuming a Linux "
20712 "guest with a single PV C</dev/sda2> and a root device called "
20713 "C</dev/vg_guest/lv_root> would be:"
20717 #: ../resize/virt-resize.pod:336
20720 " virt-resize indisk outdisk \\\n"
20721 " --expand /dev/sda2 --LV-expand /dev/vg_guest/lv_root\n"
20726 #: ../resize/virt-resize.pod:339
20728 "This would first expand the partition (and PV), and then expand the root "
20729 "device to fill the extra space in the PV."
20733 #: ../resize/virt-resize.pod:342
20735 "The contents of the LV are also resized if virt-resize knows how to do "
20736 "that. You can stop virt-resize from trying to expand the content by using "
20737 "the option I<--no-expand-content>."
20741 #: ../resize/virt-resize.pod:346
20742 msgid "Use L<virt-filesystems(1)> to list the filesystems in the guest."
20746 #: ../resize/virt-resize.pod:348
20748 "You can give this option multiple times, I<but> it doesn't make sense to do "
20749 "this unless the logical volumes you specify are all in different volume "
20754 #: ../resize/virt-resize.pod:354
20755 msgid "B<--dryrun>"
20759 #: ../resize/virt-resize.pod:356
20760 msgid "Print a summary of what would be done, but don't do anything."
20764 #: ../resize/virt-resize.pod:358
20765 msgid "B<--no-copy-boot-loader>"
20769 #: ../resize/virt-resize.pod:360
20771 "By default, virt-resize copies over some sectors at the start of the disk "
20772 "(up to the beginning of the first partition). Commonly these sectors "
20773 "contain the Master Boot Record (MBR) and the boot loader, and are required "
20774 "in order for the guest to boot correctly."
20778 #: ../resize/virt-resize.pod:365
20780 "If you specify this flag, then this initial copy is not done. You may need "
20781 "to reinstall the boot loader in this case."
20785 #: ../resize/virt-resize.pod:368
20786 msgid "B<--no-extra-partition>"
20790 #: ../resize/virt-resize.pod:370
20792 "By default, virt-resize creates an extra partition if there is any extra, "
20793 "unused space after all resizing has happened. Use this option to prevent "
20794 "the extra partition from being created. If you do this then the extra space "
20795 "will be inaccessible until you run fdisk, parted, or some other partitioning "
20796 "tool in the guest."
20800 #: ../resize/virt-resize.pod:376
20802 "Note that if the surplus space is smaller than 10 MB, no extra partition "
20807 #: ../resize/virt-resize.pod:379
20808 msgid "B<--no-expand-content>"
20812 #: ../resize/virt-resize.pod:381
20814 "By default, virt-resize will try to expand the direct contents of "
20815 "partitions, if it knows how (see I<--expand> option above)."
20819 #: ../resize/virt-resize.pod:384
20821 "If you give the I<--no-expand-content> option then virt-resize will not "
20826 #: ../resize/virt-resize.pod:387
20827 msgid "B<--ntfsresize-force>"
20831 #: ../resize/virt-resize.pod:389
20833 "Pass the I<--force> option to L<ntfsresize(8)>, allowing resizing even if "
20834 "the NTFS disk is marked as needing a consistency check. You have to use "
20835 "this option if you want to resize a Windows guest multiple times without "
20836 "booting into Windows between each resize."
20840 #: ../resize/virt-resize.pod:395
20841 msgid "B<--output-format> raw"
20845 #: ../resize/virt-resize.pod:397
20847 "Specify the format of the output disk image. If this flag is not given then "
20848 "it is auto-detected from the image itself."
20852 #: ../resize/virt-resize.pod:403
20854 "Note that this option I<does not create> the output format. This option "
20855 "just tells libguestfs what it is so it doesn't try to guess it. You still "
20856 "need to create the output disk with the right format. See L</QCOW2 AND "
20857 "NON-SPARSE RAW FORMATS>."
20861 #: ../resize/virt-resize.pod:408
20866 #: ../resize/virt-resize.pod:410
20871 #: ../resize/virt-resize.pod:412
20872 msgid "Don't print the summary."
20876 #: ../resize/virt-resize.pod:414
20877 msgid "B<--resize part=size>"
20881 #: ../resize/virt-resize.pod:416
20883 "Resize the named partition (expanding or shrinking it) so that it has the "
20888 #: ../resize/virt-resize.pod:419
20890 "C<size> can be expressed as an absolute number followed by b/K/M/G to mean "
20891 "bytes, Kilobytes, Megabytes, or Gigabytes; or as a percentage of the current "
20892 "size; or as a relative number or percentage. For example:"
20896 #: ../resize/virt-resize.pod:425
20899 " --resize /dev/sda2=10G\n"
20904 #: ../resize/virt-resize.pod:427
20907 " --resize /dev/sda4=90%\n"
20912 #: ../resize/virt-resize.pod:429
20915 " --resize /dev/sda2=+1G\n"
20920 #: ../resize/virt-resize.pod:431
20923 " --resize /dev/sda2=-200M\n"
20928 #: ../resize/virt-resize.pod:433
20931 " --resize /dev/sda1=+128K\n"
20936 #: ../resize/virt-resize.pod:435
20939 " --resize /dev/sda1=+10%\n"
20944 #: ../resize/virt-resize.pod:437
20947 " --resize /dev/sda1=-10%\n"
20952 #: ../resize/virt-resize.pod:439
20954 "You can increase the size of any partition. Virt-resize will expand the "
20955 "direct content of the partition if it knows how (see I<--expand> below)."
20959 #: ../resize/virt-resize.pod:443
20961 "You can only I<decrease> the size of partitions that contain filesystems or "
20962 "PVs which have already been shrunk. Virt-resize will check this has been "
20963 "done before proceeding, or else will print an error (see also "
20964 "I<--resize-force>)."
20968 #: ../resize/virt-resize.pod:450
20969 msgid "B<--resize-force part=size>"
20973 #: ../resize/virt-resize.pod:452
20975 "This is the same as I<--resize> except that it will let you decrease the "
20976 "size of any partition. Generally this means you will lose any data which "
20977 "was at the end of the partition you shrink, but you may not care about that "
20978 "(eg. if shrinking an unused partition, or if you can easily recreate it such "
20979 "as a swap partition)."
20983 #: ../resize/virt-resize.pod:458
20984 msgid "See also the I<--ignore> option."
20988 #: ../resize/virt-resize.pod:460
20989 msgid "B<--shrink part>"
20993 #: ../resize/virt-resize.pod:462
20995 "Shrink the named partition until the overall disk image fits in the "
20996 "destination. The named partition B<must> contain a filesystem or PV which "
20997 "has already been shrunk using another tool (eg. L<guestfish(1)> or other "
20998 "online tools). Virt-resize will check this and give an error if it has not "
21003 #: ../resize/virt-resize.pod:468
21005 "The amount by which the overall disk must be shrunk (after carrying out all "
21006 "other operations requested by the user) is called the \"deficit\". For "
21007 "example, a straight copy (assume no other operations) from a 5GB disk image "
21008 "to a 4GB disk image results in a 1GB deficit. In this case, virt-resize "
21009 "would give an error unless the user specified a partition to shrink and that "
21010 "partition had more than a gigabyte of free space."
21014 #: ../resize/virt-resize.pod:488
21015 msgid "\"Partition 1 does not end on cylinder boundary.\""
21019 #: ../resize/virt-resize.pod:490
21021 "Virt-resize aligns partitions to multiples of 64 sectors. Usually this "
21022 "means the partitions will not be aligned to the ancient CHS geometry. "
21023 "However CHS geometry is meaningless for disks manufactured since the early "
21024 "1990s, and doubly so for virtual hard drives. Alignment of partitions to "
21025 "cylinders is not required by any modern operating system."
21029 #: ../resize/virt-resize.pod:497
21030 msgid "RESIZING WINDOWS VIRTUAL MACHINES"
21034 #: ../resize/virt-resize.pod:499
21036 "In Windows Vista and later versions, Microsoft switched to using a separate "
21037 "boot partition. In these VMs, typically C</dev/sda1> is the boot partition "
21038 "and C</dev/sda2> is the main (C:) drive. We have not had any luck resizing "
21039 "the boot partition. Doing so seems to break the guest completely. However "
21040 "expanding the second partition (ie. C: drive) should work."
21044 #: ../resize/virt-resize.pod:506
21046 "Windows may initiate a lengthy \"chkdsk\" on first boot after a resize, if "
21047 "NTFS partitions have been expanded. This is just a safety check and (unless "
21048 "it find errors) is nothing to worry about."
21052 #: ../resize/virt-resize.pod:510
21053 msgid "GUEST BOOT STUCK AT \"GRUB\""
21057 #: ../resize/virt-resize.pod:512
21059 "If a Linux guest does not boot after resizing, and the boot is stuck after "
21060 "printing C<GRUB> on the console, try reinstalling grub. This sometimes "
21061 "happens on older (RHEL 5-era) guests, for reasons we don't fully understand, "
21062 "although we think is to do with partition alignment."
21066 #: ../resize/virt-resize.pod:517
21069 " guestfish -i -a newdisk\n"
21070 " ><fs> cat /boot/grub/device.map\n"
21071 " # check the contents of this file are sensible or\n"
21072 " # edit the file if necessary\n"
21073 " ><fs> grub-install / /dev/vda\n"
21079 #: ../resize/virt-resize.pod:524
21081 "For more flexible guest reconfiguration, including if you need to specify "
21082 "other parameters to grub-install, use L<virt-rescue(1)>."
21086 #: ../resize/virt-resize.pod:527
21087 msgid "ALTERNATIVE TOOLS"
21091 #: ../resize/virt-resize.pod:529
21093 "There are several proprietary tools for resizing partitions. We won't "
21094 "mention any here."
21098 #: ../resize/virt-resize.pod:532
21100 "L<parted(8)> and its graphical shell gparted can do some types of resizing "
21101 "operations on disk images. They can resize and move partitions, but I don't "
21102 "think they can do anything with the contents, and they certainly don't "
21107 #: ../resize/virt-resize.pod:537
21109 "L<guestfish(1)> can do everything that virt-resize can do and a lot more, "
21110 "but at a much lower level. You will probably end up hand-calculating sector "
21111 "offsets, which is something that virt-resize was designed to avoid. If you "
21112 "want to see the guestfish-equivalent commands that virt-resize runs, use the "
21117 #: ../resize/virt-resize.pod:552
21119 "L<virt-filesystems(1)>, L<virt-df(1)>, L<guestfs(3)>, L<guestfish(1)>, "
21120 "L<lvm(8)>, L<pvresize(8)>, L<lvresize(8)>, L<resize2fs(8)>, "
21121 "L<ntfsresize(8)>, L<btrfs(8)>, L<virsh(1)>, L<parted(8)>, L<truncate(1)>, "
21122 "L<fallocate(1)>, L<grub(8)>, L<grub-install(8)>, L<virt-rescue(1)>, "
21123 "L<http://libguestfs.org/>."
21127 #: ../ruby/examples/guestfs-ruby.pod:5
21128 msgid "guestfs-ruby - How to use libguestfs from Ruby"
21132 #: ../ruby/examples/guestfs-ruby.pod:9
21135 " require 'guestfs'\n"
21136 " g = Guestfs::Guestfs.new()\n"
21137 " g.add_drive_opts(\"disk.img\",\n"
21138 " :readonly => 1, :format => \"raw\")\n"
21144 #: ../ruby/examples/guestfs-ruby.pod:17
21146 "This manual page documents how to call libguestfs from the Ruby programming "
21147 "language. This page just documents the differences from the C API and gives "
21148 "some examples. If you are not familiar with using libguestfs, you also need "
21149 "to read L<guestfs(3)>."
21153 #: ../ruby/examples/guestfs-ruby.pod:24
21155 "Errors from libguestfs functions are mapped into the C<Error> exception. "
21156 "This has a single parameter which is the error message (a string)."
21160 #: ../ruby/examples/guestfs-ruby.pod:38
21162 "L<guestfs(3)>, L<guestfs-examples(3)>, L<guestfs-java(3)>, "
21163 "L<guestfs-ocaml(3)>, L<guestfs-perl(3)>, L<guestfs-python(3)>, "
21164 "L<guestfs-recipes(1)>, L<http://libguestfs.org/>."
21168 #: ../src/guestfs-actions.pod:1
21169 msgid "guestfs_add_cdrom"
21173 #: ../src/guestfs-actions.pod:3
21177 " guestfs_add_cdrom (guestfs_h *g,\n"
21178 " const char *filename);\n"
21183 #: ../src/guestfs-actions.pod:17
21185 "This call checks for the existence of C<filename>. This stops you from "
21186 "specifying other types of drive which are supported by qemu such as C<nbd:> "
21187 "and C<http:> URLs. To specify those, use the general C<guestfs_config> call "
21192 #: ../src/guestfs-actions.pod:24
21194 "If you just want to add an ISO file (often you use this as an efficient way "
21195 "to transfer large files into the guest), then you should probably use "
21196 "C<guestfs_add_drive_ro> instead."
21200 #: ../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:2346 ../src/guestfs-actions.pod:2490 ../src/guestfs-actions.pod:2551 ../src/guestfs-actions.pod:2586 ../src/guestfs-actions.pod:3626 ../src/guestfs-actions.pod:3641 ../src/guestfs-actions.pod:3666 ../src/guestfs-actions.pod:3855 ../src/guestfs-actions.pod:3869 ../src/guestfs-actions.pod:3882 ../src/guestfs-actions.pod:3896 ../src/guestfs-actions.pod:3911 ../src/guestfs-actions.pod:3947 ../src/guestfs-actions.pod:4019 ../src/guestfs-actions.pod:4039 ../src/guestfs-actions.pod:4056 ../src/guestfs-actions.pod:4079 ../src/guestfs-actions.pod:4102 ../src/guestfs-actions.pod:4137 ../src/guestfs-actions.pod:4156 ../src/guestfs-actions.pod:4175 ../src/guestfs-actions.pod:4210 ../src/guestfs-actions.pod:4222 ../src/guestfs-actions.pod:4258 ../src/guestfs-actions.pod:4274 ../src/guestfs-actions.pod:4287 ../src/guestfs-actions.pod:4302 ../src/guestfs-actions.pod:4319 ../src/guestfs-actions.pod:4412 ../src/guestfs-actions.pod:4432 ../src/guestfs-actions.pod:4445 ../src/guestfs-actions.pod:4496 ../src/guestfs-actions.pod:4514 ../src/guestfs-actions.pod:4532 ../src/guestfs-actions.pod:4548 ../src/guestfs-actions.pod:4562 ../src/guestfs-actions.pod:4576 ../src/guestfs-actions.pod:4593 ../src/guestfs-actions.pod:4608 ../src/guestfs-actions.pod:4628 ../src/guestfs-actions.pod:4698 ../src/guestfs-actions.pod:4771 ../src/guestfs-actions.pod:4802 ../src/guestfs-actions.pod:4821 ../src/guestfs-actions.pod:4840 ../src/guestfs-actions.pod:4852 ../src/guestfs-actions.pod:4869 ../src/guestfs-actions.pod:4882 ../src/guestfs-actions.pod:4897 ../src/guestfs-actions.pod:4912 ../src/guestfs-actions.pod:4947 ../src/guestfs-actions.pod:4980 ../src/guestfs-actions.pod:5019 ../src/guestfs-actions.pod:5039 ../src/guestfs-actions.pod:5053 ../src/guestfs-actions.pod:5070 ../src/guestfs-actions.pod:5119 ../src/guestfs-actions.pod:5165 ../src/guestfs-actions.pod:5219 ../src/guestfs-actions.pod:5255 ../src/guestfs-actions.pod:5290 ../src/guestfs-actions.pod:5307 ../src/guestfs-actions.pod:5325 ../src/guestfs-actions.pod:5465 ../src/guestfs-actions.pod:5522 ../src/guestfs-actions.pod:5544 ../src/guestfs-actions.pod:5562 ../src/guestfs-actions.pod:5594 ../src/guestfs-actions.pod:5660 ../src/guestfs-actions.pod:5677 ../src/guestfs-actions.pod:5690 ../src/guestfs-actions.pod:5704 ../src/guestfs-actions.pod:5993 ../src/guestfs-actions.pod:6012 ../src/guestfs-actions.pod:6031 ../src/guestfs-actions.pod:6045 ../src/guestfs-actions.pod:6057 ../src/guestfs-actions.pod:6071 ../src/guestfs-actions.pod:6083 ../src/guestfs-actions.pod:6097 ../src/guestfs-actions.pod:6113 ../src/guestfs-actions.pod:6134 ../src/guestfs-actions.pod:6153 ../src/guestfs-actions.pod:6172 ../src/guestfs-actions.pod:6202 ../src/guestfs-actions.pod:6220 ../src/guestfs-actions.pod:6243 ../src/guestfs-actions.pod:6261 ../src/guestfs-actions.pod:6280 ../src/guestfs-actions.pod:6301 ../src/guestfs-actions.pod:6320 ../src/guestfs-actions.pod:6337 ../src/guestfs-actions.pod:6356 ../src/guestfs-actions.pod:6384 ../src/guestfs-actions.pod:6408 ../src/guestfs-actions.pod:6427 ../src/guestfs-actions.pod:6451 ../src/guestfs-actions.pod:6470 ../src/guestfs-actions.pod:6485 ../src/guestfs-actions.pod:6504 ../src/guestfs-actions.pod:6541 ../src/guestfs-actions.pod:6571 ../src/guestfs-actions.pod:6604 ../src/guestfs-actions.pod:6726 ../src/guestfs-actions.pod:6847 ../src/guestfs-actions.pod:6859 ../src/guestfs-actions.pod:6872 ../src/guestfs-actions.pod:6885 ../src/guestfs-actions.pod:6907 ../src/guestfs-actions.pod:6920 ../src/guestfs-actions.pod:6933 ../src/guestfs-actions.pod:6946 ../src/guestfs-actions.pod:6961 ../src/guestfs-actions.pod:7020 ../src/guestfs-actions.pod:7037 ../src/guestfs-actions.pod:7053 ../src/guestfs-actions.pod:7069 ../src/guestfs-actions.pod:7086 ../src/guestfs-actions.pod:7099 ../src/guestfs-actions.pod:7119 ../src/guestfs-actions.pod:7155 ../src/guestfs-actions.pod:7169 ../src/guestfs-actions.pod:7210 ../src/guestfs-actions.pod:7223 ../src/guestfs-actions.pod:7241 ../src/guestfs-actions.pod:7275 ../src/guestfs-actions.pod:7311 ../src/guestfs-actions.pod:7427 ../src/guestfs-actions.pod:7442 ../src/guestfs-actions.pod:7456 ../src/guestfs-actions.pod:7511 ../src/guestfs-actions.pod:7524 ../src/guestfs-actions.pod:7569 ../src/guestfs-actions.pod:7602 ../src/guestfs-actions.pod:7665 ../src/guestfs-actions.pod:7685 ../src/guestfs-actions.pod:7711 ../src/guestfs-actions.pod:7778 ../src/guestfs-actions.pod:7797 ../src/guestfs-actions.pod:7826
21201 msgid "This function returns 0 on success or -1 on error."
21205 #: ../src/guestfs-actions.pod:32 ../src/guestfs-actions.pod:254 ../src/guestfs-actions.pod:275
21207 "This function is deprecated. In new code, use the "
21208 "L</guestfs_add_drive_opts> call instead."
21212 #: ../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:3628 ../src/guestfs-actions.pod:3648 ../src/guestfs-actions.pod:4956 ../src/guestfs-actions.pod:6222 ../src/guestfs-actions.pod:6339 ../src/guestfs-actions.pod:6472 ../src/guestfs-actions.pod:6963 ../src/guestfs-actions.pod:7088 ../src/guestfs-actions.pod:7611
21213 msgid "(Added in 0.3)"
21217 #: ../src/guestfs-actions.pod:41
21218 msgid "guestfs_add_domain"
21222 #: ../src/guestfs-actions.pod:43
21226 " guestfs_add_domain (guestfs_h *g,\n"
21227 " const char *dom,\n"
21233 #: ../src/guestfs-actions.pod:48 ../src/guestfs-actions.pod:151 ../src/guestfs-actions.pod:837 ../src/guestfs-actions.pod:2831 ../src/guestfs-actions.pod:4647 ../src/guestfs-actions.pod:4966 ../src/guestfs-actions.pod:5183
21235 "You may supply a list of optional arguments to this call. Use zero or more "
21236 "of the following pairs of parameters, and terminate the list with C<-1> on "
21237 "its own. See L</CALLS WITH OPTIONAL ARGUMENTS>."
21241 #: ../src/guestfs-actions.pod:53
21244 " GUESTFS_ADD_DOMAIN_LIBVIRTURI, const char *libvirturi,\n"
21245 " GUESTFS_ADD_DOMAIN_READONLY, int readonly,\n"
21246 " GUESTFS_ADD_DOMAIN_IFACE, const char *iface,\n"
21247 " GUESTFS_ADD_DOMAIN_LIVE, int live,\n"
21248 " GUESTFS_ADD_DOMAIN_ALLOWUUID, int allowuuid,\n"
21253 #: ../src/guestfs-actions.pod:59
21255 "This function adds the disk(s) attached to the named libvirt domain C<dom>. "
21256 "It works by connecting to libvirt, requesting the domain and domain XML from "
21257 "libvirt, parsing it for disks, and calling C<guestfs_add_drive_opts> on each "
21262 #: ../src/guestfs-actions.pod:94
21264 "The other optional parameters are passed directly through to "
21265 "C<guestfs_add_drive_opts>."
21269 #: ../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:2477 ../src/guestfs-actions.pod:2949 ../src/guestfs-actions.pod:2967 ../src/guestfs-actions.pod:5142 ../src/guestfs-actions.pod:5362 ../src/guestfs-actions.pod:5774 ../src/guestfs-actions.pod:5800 ../src/guestfs-actions.pod:7196 ../src/guestfs-actions.pod:7622 ../src/guestfs-actions.pod:7635 ../src/guestfs-actions.pod:7648
21270 msgid "On error this function returns -1."
21274 #: ../src/guestfs-actions.pod:99
21275 msgid "(Added in 1.7.4)"
21279 #: ../src/guestfs-actions.pod:101
21280 msgid "guestfs_add_domain_va"
21284 #: ../src/guestfs-actions.pod:103
21288 " guestfs_add_domain_va (guestfs_h *g,\n"
21289 " const char *dom,\n"
21290 " va_list args);\n"
21295 #: ../src/guestfs-actions.pod:108
21296 msgid "This is the \"va_list variant\" of L</guestfs_add_domain>."
21300 #: ../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:2915 ../src/guestfs-actions.pod:2927 ../src/guestfs-actions.pod:4712 ../src/guestfs-actions.pod:4724 ../src/guestfs-actions.pod:4994 ../src/guestfs-actions.pod:5006 ../src/guestfs-actions.pod:5232 ../src/guestfs-actions.pod:5243
21301 msgid "See L</CALLS WITH OPTIONAL ARGUMENTS>."
21305 #: ../src/guestfs-actions.pod:112
21306 msgid "guestfs_add_domain_argv"
21310 #: ../src/guestfs-actions.pod:114
21314 " guestfs_add_domain_argv (guestfs_h *g,\n"
21315 " const char *dom,\n"
21316 " const struct guestfs_add_domain_argv *optargs);\n"
21321 #: ../src/guestfs-actions.pod:119
21322 msgid "This is the \"argv variant\" of L</guestfs_add_domain>."
21326 #: ../src/guestfs-actions.pod:123
21327 msgid "guestfs_add_drive"
21331 #: ../src/guestfs-actions.pod:125
21335 " guestfs_add_drive (guestfs_h *g,\n"
21336 " const char *filename);\n"
21341 #: ../src/guestfs-actions.pod:129
21343 "This function is the equivalent of calling C<guestfs_add_drive_opts> with no "
21344 "optional parameters, so the disk is added writable, with the format being "
21345 "detected automatically."
21349 #: ../src/guestfs-actions.pod:133
21351 "Automatic detection of the format opens you up to a potential security hole "
21352 "when dealing with untrusted raw-format images. See CVE-2010-3851 and "
21353 "RHBZ#642934. Specifying the format closes this security hole. Therefore "
21354 "you should think about replacing calls to this function with calls to "
21355 "C<guestfs_add_drive_opts>, and specifying the format."
21359 #: ../src/guestfs-actions.pod:144
21360 msgid "guestfs_add_drive_opts"
21364 #: ../src/guestfs-actions.pod:146
21368 " guestfs_add_drive_opts (guestfs_h *g,\n"
21369 " const char *filename,\n"
21375 #: ../src/guestfs-actions.pod:156
21378 " GUESTFS_ADD_DRIVE_OPTS_READONLY, int readonly,\n"
21379 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, const char *format,\n"
21380 " GUESTFS_ADD_DRIVE_OPTS_IFACE, const char *iface,\n"
21385 #: ../src/guestfs-actions.pod:185
21387 "This forces the image format. If you omit this (or use C<guestfs_add_drive> "
21388 "or C<guestfs_add_drive_ro>) then the format is automatically detected. "
21389 "Possible formats include C<raw> and C<qcow2>."
21393 #: ../src/guestfs-actions.pod:196
21395 "This rarely-used option lets you emulate the behaviour of the deprecated "
21396 "C<guestfs_add_drive_with_if> call (q.v.)"
21400 #: ../src/guestfs-actions.pod:203
21401 msgid "(Added in 1.5.23)"
21405 #: ../src/guestfs-actions.pod:205
21406 msgid "guestfs_add_drive_opts_va"
21410 #: ../src/guestfs-actions.pod:207
21414 " guestfs_add_drive_opts_va (guestfs_h *g,\n"
21415 " const char *filename,\n"
21416 " va_list args);\n"
21421 #: ../src/guestfs-actions.pod:212
21422 msgid "This is the \"va_list variant\" of L</guestfs_add_drive_opts>."
21426 #: ../src/guestfs-actions.pod:216
21427 msgid "guestfs_add_drive_opts_argv"
21431 #: ../src/guestfs-actions.pod:218
21435 " guestfs_add_drive_opts_argv (guestfs_h *g,\n"
21436 " const char *filename,\n"
21437 " const struct guestfs_add_drive_opts_argv "
21443 #: ../src/guestfs-actions.pod:223
21444 msgid "This is the \"argv variant\" of L</guestfs_add_drive_opts>."
21448 #: ../src/guestfs-actions.pod:227
21449 msgid "guestfs_add_drive_ro"
21453 #: ../src/guestfs-actions.pod:229
21457 " guestfs_add_drive_ro (guestfs_h *g,\n"
21458 " const char *filename);\n"
21463 #: ../src/guestfs-actions.pod:233
21465 "This function is the equivalent of calling C<guestfs_add_drive_opts> with "
21466 "the optional parameter C<GUESTFS_ADD_DRIVE_OPTS_READONLY> set to 1, so the "
21467 "disk is added read-only, with the format being detected automatically."
21471 #: ../src/guestfs-actions.pod:240
21472 msgid "(Added in 1.0.38)"
21476 #: ../src/guestfs-actions.pod:242
21477 msgid "guestfs_add_drive_ro_with_if"
21481 #: ../src/guestfs-actions.pod:244
21485 " guestfs_add_drive_ro_with_if (guestfs_h *g,\n"
21486 " const char *filename,\n"
21487 " const char *iface);\n"
21492 #: ../src/guestfs-actions.pod:249
21494 "This is the same as C<guestfs_add_drive_ro> but it allows you to specify the "
21495 "QEMU interface emulation to use at run time."
21499 #: ../src/guestfs-actions.pod:261 ../src/guestfs-actions.pod:282 ../src/guestfs-actions.pod:2436
21500 msgid "(Added in 1.0.84)"
21504 #: ../src/guestfs-actions.pod:263
21505 msgid "guestfs_add_drive_with_if"
21509 #: ../src/guestfs-actions.pod:265
21513 " guestfs_add_drive_with_if (guestfs_h *g,\n"
21514 " const char *filename,\n"
21515 " const char *iface);\n"
21520 #: ../src/guestfs-actions.pod:270
21522 "This is the same as C<guestfs_add_drive> but it allows you to specify the "
21523 "QEMU interface emulation to use at run time."
21527 #: ../src/guestfs-actions.pod:284
21528 msgid "guestfs_aug_clear"
21532 #: ../src/guestfs-actions.pod:286
21536 " guestfs_aug_clear (guestfs_h *g,\n"
21537 " const char *augpath);\n"
21542 #: ../src/guestfs-actions.pod:295 ../src/guestfs-actions.pod:2186
21543 msgid "(Added in 1.3.4)"
21547 #: ../src/guestfs-actions.pod:297
21548 msgid "guestfs_aug_close"
21552 #: ../src/guestfs-actions.pod:299
21556 " guestfs_aug_close (guestfs_h *g);\n"
21561 #: ../src/guestfs-actions.pod:302
21563 "Close the current Augeas handle and free up any resources used by it. After "
21564 "calling this, you have to call C<guestfs_aug_init> again before you can use "
21565 "any other Augeas functions."
21569 #: ../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:5851
21570 msgid "(Added in 0.7)"
21574 #: ../src/guestfs-actions.pod:311
21575 msgid "guestfs_aug_defnode"
21579 #: ../src/guestfs-actions.pod:313
21582 " struct guestfs_int_bool *\n"
21583 " guestfs_aug_defnode (guestfs_h *g,\n"
21584 " const char *name,\n"
21585 " const char *expr,\n"
21586 " const char *val);\n"
21591 #: ../src/guestfs-actions.pod:322
21593 "If C<expr> evaluates to an empty nodeset, a node is created, equivalent to "
21594 "calling C<guestfs_aug_set> C<expr>, C<value>. C<name> will be the nodeset "
21595 "containing that single node."
21599 #: ../src/guestfs-actions.pod:330
21601 "This function returns a C<struct guestfs_int_bool *>, or NULL if there was "
21602 "an error. I<The caller must call C<guestfs_free_int_bool> after use>."
21606 #: ../src/guestfs-actions.pod:336
21607 msgid "guestfs_aug_defvar"
21611 #: ../src/guestfs-actions.pod:338
21615 " guestfs_aug_defvar (guestfs_h *g,\n"
21616 " const char *name,\n"
21617 " const char *expr);\n"
21622 #: ../src/guestfs-actions.pod:354
21623 msgid "guestfs_aug_get"
21627 #: ../src/guestfs-actions.pod:356
21631 " guestfs_aug_get (guestfs_h *g,\n"
21632 " const char *augpath);\n"
21637 #: ../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:2401 ../src/guestfs-actions.pod:2605 ../src/guestfs-actions.pod:2695 ../src/guestfs-actions.pod:2799 ../src/guestfs-actions.pod:2818 ../src/guestfs-actions.pod:3032 ../src/guestfs-actions.pod:3060 ../src/guestfs-actions.pod:3081 ../src/guestfs-actions.pod:3115 ../src/guestfs-actions.pod:3174 ../src/guestfs-actions.pod:3194 ../src/guestfs-actions.pod:3214 ../src/guestfs-actions.pod:3841 ../src/guestfs-actions.pod:4194 ../src/guestfs-actions.pod:4364 ../src/guestfs-actions.pod:4474 ../src/guestfs-actions.pod:5380 ../src/guestfs-actions.pod:5579 ../src/guestfs-actions.pod:5749 ../src/guestfs-actions.pod:5927 ../src/guestfs-actions.pod:5976 ../src/guestfs-actions.pod:6632 ../src/guestfs-actions.pod:6648 ../src/guestfs-actions.pod:6665 ../src/guestfs-actions.pod:6696 ../src/guestfs-actions.pod:7370 ../src/guestfs-actions.pod:7389 ../src/guestfs-actions.pod:7407 ../src/guestfs-actions.pod:7581 ../src/guestfs-actions.pod:7883
21639 "This function returns a string, or NULL on error. I<The caller must free "
21640 "the returned string after use>."
21644 #: ../src/guestfs-actions.pod:368
21645 msgid "guestfs_aug_init"
21649 #: ../src/guestfs-actions.pod:370
21653 " guestfs_aug_init (guestfs_h *g,\n"
21654 " const char *root,\n"
21660 #: ../src/guestfs-actions.pod:379
21661 msgid "You must call this before using any other C<guestfs_aug_*> commands."
21665 #: ../src/guestfs-actions.pod:404
21667 "This option is only useful when debugging Augeas lenses. Use of this option "
21668 "may require additional memory for the libguestfs appliance. You may need to "
21669 "set the C<LIBGUESTFS_MEMSIZE> environment variable or call "
21670 "C<guestfs_set_memsize>."
21674 #: ../src/guestfs-actions.pod:419
21675 msgid "Do not load the tree in C<guestfs_aug_init>."
21679 #: ../src/guestfs-actions.pod:423
21680 msgid "To close the handle, you can call C<guestfs_aug_close>."
21684 #: ../src/guestfs-actions.pod:431
21685 msgid "guestfs_aug_insert"
21689 #: ../src/guestfs-actions.pod:433
21693 " guestfs_aug_insert (guestfs_h *g,\n"
21694 " const char *augpath,\n"
21695 " const char *label,\n"
21701 #: ../src/guestfs-actions.pod:451
21702 msgid "guestfs_aug_load"
21706 #: ../src/guestfs-actions.pod:453
21710 " guestfs_aug_load (guestfs_h *g);\n"
21715 #: ../src/guestfs-actions.pod:465
21716 msgid "guestfs_aug_ls"
21720 #: ../src/guestfs-actions.pod:467
21724 " guestfs_aug_ls (guestfs_h *g,\n"
21725 " const char *augpath);\n"
21730 #: ../src/guestfs-actions.pod:471
21732 "This is just a shortcut for listing C<guestfs_aug_match> C<path/*> and "
21733 "sorting the resulting nodes into alphabetical order."
21737 #: ../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:2359 ../src/guestfs-actions.pod:2383 ../src/guestfs-actions.pod:2454 ../src/guestfs-actions.pod:2503 ../src/guestfs-actions.pod:2760 ../src/guestfs-actions.pod:3134 ../src/guestfs-actions.pod:3410 ../src/guestfs-actions.pod:3724 ../src/guestfs-actions.pod:3741 ../src/guestfs-actions.pod:3761 ../src/guestfs-actions.pod:3823 ../src/guestfs-actions.pod:3928 ../src/guestfs-actions.pod:4336 ../src/guestfs-actions.pod:5103 ../src/guestfs-actions.pod:5721 ../src/guestfs-actions.pod:5847 ../src/guestfs-actions.pod:5961 ../src/guestfs-actions.pod:6712 ../src/guestfs-actions.pod:6773 ../src/guestfs-actions.pod:6828 ../src/guestfs-actions.pod:6974 ../src/guestfs-actions.pod:6998 ../src/guestfs-actions.pod:7474 ../src/guestfs-actions.pod:7494 ../src/guestfs-actions.pod:7541 ../src/guestfs-actions.pod:7735 ../src/guestfs-actions.pod:7754 ../src/guestfs-actions.pod:7840 ../src/guestfs-actions.pod:7859 ../src/guestfs-actions.pod:7905 ../src/guestfs-actions.pod:7924
21739 "This function returns a NULL-terminated array of strings (like "
21740 "L<environ(3)>), or NULL if there was an error. I<The caller must free the "
21741 "strings and the array after use>."
21745 #: ../src/guestfs-actions.pod:478 ../src/guestfs-actions.pod:1068 ../src/guestfs-actions.pod:1086 ../src/guestfs-actions.pod:1496 ../src/guestfs-actions.pod:3488 ../src/guestfs-actions.pod:3519 ../src/guestfs-actions.pod:4177 ../src/guestfs-actions.pod:4227 ../src/guestfs-actions.pod:4414 ../src/guestfs-actions.pod:4447 ../src/guestfs-actions.pod:4610 ../src/guestfs-actions.pod:5107 ../src/guestfs-actions.pod:5662 ../src/guestfs-actions.pod:6059 ../src/guestfs-actions.pod:6073 ../src/guestfs-actions.pod:6085 ../src/guestfs-actions.pod:6553 ../src/guestfs-actions.pod:7212 ../src/guestfs-actions.pod:7225 ../src/guestfs-actions.pod:7458 ../src/guestfs-actions.pod:7723
21746 msgid "(Added in 0.8)"
21750 #: ../src/guestfs-actions.pod:480
21751 msgid "guestfs_aug_match"
21755 #: ../src/guestfs-actions.pod:482
21759 " guestfs_aug_match (guestfs_h *g,\n"
21760 " const char *augpath);\n"
21765 #: ../src/guestfs-actions.pod:496
21766 msgid "guestfs_aug_mv"
21770 #: ../src/guestfs-actions.pod:498
21774 " guestfs_aug_mv (guestfs_h *g,\n"
21775 " const char *src,\n"
21776 " const char *dest);\n"
21781 #: ../src/guestfs-actions.pod:510
21782 msgid "guestfs_aug_rm"
21786 #: ../src/guestfs-actions.pod:512
21790 " guestfs_aug_rm (guestfs_h *g,\n"
21791 " const char *augpath);\n"
21796 #: ../src/guestfs-actions.pod:524
21797 msgid "guestfs_aug_save"
21801 #: ../src/guestfs-actions.pod:526
21805 " guestfs_aug_save (guestfs_h *g);\n"
21810 #: ../src/guestfs-actions.pod:531
21812 "The flags which were passed to C<guestfs_aug_init> affect exactly how files "
21817 #: ../src/guestfs-actions.pod:538
21818 msgid "guestfs_aug_set"
21822 #: ../src/guestfs-actions.pod:540
21826 " guestfs_aug_set (guestfs_h *g,\n"
21827 " const char *augpath,\n"
21828 " const char *val);\n"
21833 #: ../src/guestfs-actions.pod:547
21835 "In the Augeas API, it is possible to clear a node by setting the value to "
21836 "NULL. Due to an oversight in the libguestfs API you cannot do that with "
21837 "this call. Instead you must use the C<guestfs_aug_clear> call."
21841 #: ../src/guestfs-actions.pod:556
21842 msgid "guestfs_available"
21846 #: ../src/guestfs-actions.pod:558
21850 " guestfs_available (guestfs_h *g,\n"
21851 " char *const *groups);\n"
21856 #: ../src/guestfs-actions.pod:566
21858 "The libguestfs groups, and the functions that those groups correspond to, "
21859 "are listed in L<guestfs(3)/AVAILABILITY>. You can also fetch this list at "
21860 "runtime by calling C<guestfs_available_all_groups>."
21864 #: ../src/guestfs-actions.pod:590
21865 msgid "You must call C<guestfs_launch> before calling this function."
21869 #: ../src/guestfs-actions.pod:612
21871 "This call was added in version C<1.0.80>. In previous versions of "
21872 "libguestfs all you could do would be to speculatively execute a command to "
21873 "find out if the daemon implemented it. See also C<guestfs_version>."
21877 #: ../src/guestfs-actions.pod:621 ../src/guestfs-actions.pod:1241
21878 msgid "(Added in 1.0.80)"
21882 #: ../src/guestfs-actions.pod:623
21883 msgid "guestfs_available_all_groups"
21887 #: ../src/guestfs-actions.pod:625
21891 " guestfs_available_all_groups (guestfs_h *g);\n"
21896 #: ../src/guestfs-actions.pod:628
21898 "This command returns a list of all optional groups that this daemon knows "
21899 "about. Note this returns both supported and unsupported groups. To find "
21900 "out which ones the daemon can actually support you have to call "
21901 "C<guestfs_available> on each member of the returned list."
21905 #: ../src/guestfs-actions.pod:634
21906 msgid "See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>."
21910 #: ../src/guestfs-actions.pod:640
21911 msgid "(Added in 1.3.15)"
21915 #: ../src/guestfs-actions.pod:642
21916 msgid "guestfs_base64_in"
21920 #: ../src/guestfs-actions.pod:644
21924 " guestfs_base64_in (guestfs_h *g,\n"
21925 " const char *base64file,\n"
21926 " const char *filename);\n"
21931 #: ../src/guestfs-actions.pod:654 ../src/guestfs-actions.pod:668
21932 msgid "(Added in 1.3.5)"
21936 #: ../src/guestfs-actions.pod:656
21937 msgid "guestfs_base64_out"
21941 #: ../src/guestfs-actions.pod:658
21945 " guestfs_base64_out (guestfs_h *g,\n"
21946 " const char *filename,\n"
21947 " const char *base64file);\n"
21952 #: ../src/guestfs-actions.pod:670
21953 msgid "guestfs_blockdev_flushbufs"
21957 #: ../src/guestfs-actions.pod:672
21961 " guestfs_blockdev_flushbufs (guestfs_h *g,\n"
21962 " const char *device);\n"
21967 #: ../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
21968 msgid "(Added in 0.9.3)"
21972 #: ../src/guestfs-actions.pod:685
21973 msgid "guestfs_blockdev_getbsz"
21977 #: ../src/guestfs-actions.pod:687
21981 " guestfs_blockdev_getbsz (guestfs_h *g,\n"
21982 " const char *device);\n"
21987 #: ../src/guestfs-actions.pod:702
21988 msgid "guestfs_blockdev_getro"
21992 #: ../src/guestfs-actions.pod:704
21996 " guestfs_blockdev_getro (guestfs_h *g,\n"
21997 " const char *device);\n"
22002 #: ../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:3231 ../src/guestfs-actions.pod:3247 ../src/guestfs-actions.pod:3265 ../src/guestfs-actions.pod:3427 ../src/guestfs-actions.pod:3441 ../src/guestfs-actions.pod:3456 ../src/guestfs-actions.pod:3470 ../src/guestfs-actions.pod:3486 ../src/guestfs-actions.pod:3501 ../src/guestfs-actions.pod:3517 ../src/guestfs-actions.pod:3531 ../src/guestfs-actions.pod:3544 ../src/guestfs-actions.pod:3558 ../src/guestfs-actions.pod:3573 ../src/guestfs-actions.pod:3588 ../src/guestfs-actions.pod:3601 ../src/guestfs-actions.pod:3615 ../src/guestfs-actions.pod:5344
22003 msgid "This function returns a C truth value on success or -1 on error."
22007 #: ../src/guestfs-actions.pod:717
22008 msgid "guestfs_blockdev_getsize64"
22012 #: ../src/guestfs-actions.pod:719
22016 " guestfs_blockdev_getsize64 (guestfs_h *g,\n"
22017 " const char *device);\n"
22022 #: ../src/guestfs-actions.pod:725
22023 msgid "See also C<guestfs_blockdev_getsz>."
22027 #: ../src/guestfs-actions.pod:733
22028 msgid "guestfs_blockdev_getss"
22032 #: ../src/guestfs-actions.pod:735
22036 " guestfs_blockdev_getss (guestfs_h *g,\n"
22037 " const char *device);\n"
22042 #: ../src/guestfs-actions.pod:742
22044 "(Note, this is not the size in sectors, use C<guestfs_blockdev_getsz> for "
22049 #: ../src/guestfs-actions.pod:751
22050 msgid "guestfs_blockdev_getsz"
22054 #: ../src/guestfs-actions.pod:753
22058 " guestfs_blockdev_getsz (guestfs_h *g,\n"
22059 " const char *device);\n"
22064 #: ../src/guestfs-actions.pod:760
22066 "See also C<guestfs_blockdev_getss> for the real sector size of the device, "
22067 "and C<guestfs_blockdev_getsize64> for the more useful I<size in bytes>."
22071 #: ../src/guestfs-actions.pod:770
22072 msgid "guestfs_blockdev_rereadpt"
22076 #: ../src/guestfs-actions.pod:772
22080 " guestfs_blockdev_rereadpt (guestfs_h *g,\n"
22081 " const char *device);\n"
22086 #: ../src/guestfs-actions.pod:784
22087 msgid "guestfs_blockdev_setbsz"
22091 #: ../src/guestfs-actions.pod:786
22095 " guestfs_blockdev_setbsz (guestfs_h *g,\n"
22096 " const char *device,\n"
22097 " int blocksize);\n"
22102 #: ../src/guestfs-actions.pod:802
22103 msgid "guestfs_blockdev_setro"
22107 #: ../src/guestfs-actions.pod:804
22111 " guestfs_blockdev_setro (guestfs_h *g,\n"
22112 " const char *device);\n"
22117 #: ../src/guestfs-actions.pod:816
22118 msgid "guestfs_blockdev_setrw"
22122 #: ../src/guestfs-actions.pod:818
22126 " guestfs_blockdev_setrw (guestfs_h *g,\n"
22127 " const char *device);\n"
22132 #: ../src/guestfs-actions.pod:830
22133 msgid "guestfs_btrfs_filesystem_resize"
22137 #: ../src/guestfs-actions.pod:832
22141 " guestfs_btrfs_filesystem_resize (guestfs_h *g,\n"
22142 " const char *mountpoint,\n"
22148 #: ../src/guestfs-actions.pod:842
22151 " GUESTFS_BTRFS_FILESYSTEM_RESIZE_SIZE, int64_t size,\n"
22156 #: ../src/guestfs-actions.pod:865
22157 msgid "(Added in 1.11.17)"
22161 #: ../src/guestfs-actions.pod:867
22162 msgid "guestfs_btrfs_filesystem_resize_va"
22166 #: ../src/guestfs-actions.pod:869
22170 " guestfs_btrfs_filesystem_resize_va (guestfs_h *g,\n"
22171 " const char *mountpoint,\n"
22172 " va_list args);\n"
22177 #: ../src/guestfs-actions.pod:874
22178 msgid "This is the \"va_list variant\" of L</guestfs_btrfs_filesystem_resize>."
22182 #: ../src/guestfs-actions.pod:878
22183 msgid "guestfs_btrfs_filesystem_resize_argv"
22187 #: ../src/guestfs-actions.pod:880
22191 " guestfs_btrfs_filesystem_resize_argv (guestfs_h *g,\n"
22192 " const char *mountpoint,\n"
22194 "guestfs_btrfs_filesystem_resize_argv *optargs);\n"
22199 #: ../src/guestfs-actions.pod:885
22200 msgid "This is the \"argv variant\" of L</guestfs_btrfs_filesystem_resize>."
22204 #: ../src/guestfs-actions.pod:889
22205 msgid "guestfs_case_sensitive_path"
22209 #: ../src/guestfs-actions.pod:891
22213 " guestfs_case_sensitive_path (guestfs_h *g,\n"
22214 " const char *path);\n"
22219 #: ../src/guestfs-actions.pod:917
22221 "Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\") might return "
22222 "C<\"/WINDOWS/system32\"> (the exact return value would depend on details of "
22223 "how the directories were originally created under Windows)."
22227 #: ../src/guestfs-actions.pod:925
22228 msgid "See also C<guestfs_realpath>."
22232 #: ../src/guestfs-actions.pod:930 ../src/guestfs-actions.pod:7392
22233 msgid "(Added in 1.0.75)"
22237 #: ../src/guestfs-actions.pod:932
22238 msgid "guestfs_cat"
22242 #: ../src/guestfs-actions.pod:934
22246 " guestfs_cat (guestfs_h *g,\n"
22247 " const char *path);\n"
22252 #: ../src/guestfs-actions.pod:940
22254 "Note that this function cannot correctly handle binary files (specifically, "
22255 "files containing C<\\0> character which is treated as end of string). For "
22256 "those you need to use the C<guestfs_read_file> or C<guestfs_download> "
22257 "functions which have a more complex interface."
22261 #: ../src/guestfs-actions.pod:951 ../src/guestfs-actions.pod:3745 ../src/guestfs-actions.pod:3827 ../src/guestfs-actions.pod:3844 ../src/guestfs-actions.pod:3932 ../src/guestfs-actions.pod:4340 ../src/guestfs-actions.pod:4354 ../src/guestfs-actions.pod:5725 ../src/guestfs-actions.pod:5739 ../src/guestfs-actions.pod:7545 ../src/guestfs-actions.pod:7559
22262 msgid "(Added in 0.4)"
22266 #: ../src/guestfs-actions.pod:953
22267 msgid "guestfs_checksum"
22271 #: ../src/guestfs-actions.pod:955
22275 " guestfs_checksum (guestfs_h *g,\n"
22276 " const char *csumtype,\n"
22277 " const char *path);\n"
22282 #: ../src/guestfs-actions.pod:1001
22283 msgid "To get the checksum for a device, use C<guestfs_checksum_device>."
22287 #: ../src/guestfs-actions.pod:1003
22288 msgid "To get the checksums for many files, use C<guestfs_checksums_out>."
22292 #: ../src/guestfs-actions.pod:1008 ../src/guestfs-actions.pod:1316 ../src/guestfs-actions.pod:2163 ../src/guestfs-actions.pod:3443 ../src/guestfs-actions.pod:3472 ../src/guestfs-actions.pod:3533 ../src/guestfs-actions.pod:3560 ../src/guestfs-actions.pod:7248
22293 msgid "(Added in 1.0.2)"
22297 #: ../src/guestfs-actions.pod:1010
22298 msgid "guestfs_checksum_device"
22302 #: ../src/guestfs-actions.pod:1012
22306 " guestfs_checksum_device (guestfs_h *g,\n"
22307 " const char *csumtype,\n"
22308 " const char *device);\n"
22313 #: ../src/guestfs-actions.pod:1017
22315 "This call computes the MD5, SHAx or CRC checksum of the contents of the "
22316 "device named C<device>. For the types of checksums supported see the "
22317 "C<guestfs_checksum> command."
22321 #: ../src/guestfs-actions.pod:1024 ../src/guestfs-actions.pod:5174 ../src/guestfs-actions.pod:5309 ../src/guestfs-actions.pod:5346 ../src/guestfs-actions.pod:5364 ../src/guestfs-actions.pod:5546 ../src/guestfs-actions.pod:7157 ../src/guestfs-actions.pod:7171 ../src/guestfs-actions.pod:7571
22322 msgid "(Added in 1.3.2)"
22326 #: ../src/guestfs-actions.pod:1026
22327 msgid "guestfs_checksums_out"
22331 #: ../src/guestfs-actions.pod:1028
22335 " guestfs_checksums_out (guestfs_h *g,\n"
22336 " const char *csumtype,\n"
22337 " const char *directory,\n"
22338 " const char *sumsfile);\n"
22343 #: ../src/guestfs-actions.pod:1048
22344 msgid "(Added in 1.3.7)"
22348 #: ../src/guestfs-actions.pod:1050
22349 msgid "guestfs_chmod"
22353 #: ../src/guestfs-actions.pod:1052
22357 " guestfs_chmod (guestfs_h *g,\n"
22359 " const char *path);\n"
22364 #: ../src/guestfs-actions.pod:1070
22365 msgid "guestfs_chown"
22369 #: ../src/guestfs-actions.pod:1072
22373 " guestfs_chown (guestfs_h *g,\n"
22376 " const char *path);\n"
22381 #: ../src/guestfs-actions.pod:1088
22382 msgid "guestfs_command"
22386 #: ../src/guestfs-actions.pod:1090
22390 " guestfs_command (guestfs_h *g,\n"
22391 " char *const *arguments);\n"
22396 #: ../src/guestfs-actions.pod:1099
22398 "The single parameter is an argv-style list of arguments. The first element "
22399 "is the name of the program to run. Subsequent elements are parameters. The "
22400 "list must be non-empty (ie. must contain a program name). Note that the "
22401 "command runs directly, and is I<not> invoked via the shell (see "
22406 #: ../src/guestfs-actions.pod:1130 ../src/guestfs-actions.pod:1150 ../src/guestfs-actions.pod:1615
22407 msgid "(Added in 0.9.1)"
22411 #: ../src/guestfs-actions.pod:1132
22412 msgid "guestfs_command_lines"
22416 #: ../src/guestfs-actions.pod:1134
22420 " guestfs_command_lines (guestfs_h *g,\n"
22421 " char *const *arguments);\n"
22426 #: ../src/guestfs-actions.pod:1138
22428 "This is the same as C<guestfs_command>, but splits the result into a list of "
22433 #: ../src/guestfs-actions.pod:1141
22434 msgid "See also: C<guestfs_sh_lines>"
22438 #: ../src/guestfs-actions.pod:1152
22439 msgid "guestfs_config"
22443 #: ../src/guestfs-actions.pod:1154
22447 " guestfs_config (guestfs_h *g,\n"
22448 " const char *qemuparam,\n"
22449 " const char *qemuvalue);\n"
22454 #: ../src/guestfs-actions.pod:1172
22455 msgid "guestfs_copy_size"
22459 #: ../src/guestfs-actions.pod:1174
22463 " guestfs_copy_size (guestfs_h *g,\n"
22464 " const char *src,\n"
22465 " const char *dest,\n"
22466 " int64_t size);\n"
22471 #: ../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:3643 ../src/guestfs-actions.pod:7243 ../src/guestfs-actions.pod:7277 ../src/guestfs-actions.pod:7780 ../src/guestfs-actions.pod:7799
22473 "This long-running command can generate progress notification messages so "
22474 "that the caller can display a progress bar or indicator. To receive these "
22475 "messages, the caller must register a progress event callback. See "
22476 "L<guestfs(3)/GUESTFS_EVENT_PROGRESS>."
22480 #: ../src/guestfs-actions.pod:1193 ../src/guestfs-actions.pod:4367 ../src/guestfs-actions.pod:5752 ../src/guestfs-actions.pod:7478 ../src/guestfs-actions.pod:7498 ../src/guestfs-actions.pod:7584
22481 msgid "(Added in 1.0.87)"
22485 #: ../src/guestfs-actions.pod:1195
22490 #: ../src/guestfs-actions.pod:1197
22494 " guestfs_cp (guestfs_h *g,\n"
22495 " const char *src,\n"
22496 " const char *dest);\n"
22501 #: ../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:5121 ../src/guestfs-actions.pod:5596
22502 msgid "(Added in 1.0.18)"
22506 #: ../src/guestfs-actions.pod:1209
22507 msgid "guestfs_cp_a"
22511 #: ../src/guestfs-actions.pod:1211
22515 " guestfs_cp_a (guestfs_h *g,\n"
22516 " const char *src,\n"
22517 " const char *dest);\n"
22522 #: ../src/guestfs-actions.pod:1223
22527 #: ../src/guestfs-actions.pod:1225
22531 " guestfs_dd (guestfs_h *g,\n"
22532 " const char *src,\n"
22533 " const char *dest);\n"
22538 #: ../src/guestfs-actions.pod:1235
22540 "If the destination is a device, it must be as large or larger than the "
22541 "source file or device, otherwise the copy will fail. This command cannot do "
22542 "partial copies (see C<guestfs_copy_size>)."
22546 #: ../src/guestfs-actions.pod:1243
22551 #: ../src/guestfs-actions.pod:1245
22555 " guestfs_df (guestfs_h *g);\n"
22560 #: ../src/guestfs-actions.pod:1250 ../src/guestfs-actions.pod:1267
22562 "This command is mostly useful for interactive sessions. It is I<not> "
22563 "intended that you try to parse the output string. Use C<guestfs_statvfs> "
22568 #: ../src/guestfs-actions.pod:1257 ../src/guestfs-actions.pod:1274 ../src/guestfs-actions.pod:1392 ../src/guestfs-actions.pod:2366 ../src/guestfs-actions.pod:2390 ../src/guestfs-actions.pod:2458 ../src/guestfs-actions.pod:4477 ../src/guestfs-actions.pod:5021 ../src/guestfs-actions.pod:6981 ../src/guestfs-actions.pod:7005 ../src/guestfs-actions.pod:7624 ../src/guestfs-actions.pod:7637 ../src/guestfs-actions.pod:7650
22569 msgid "(Added in 1.0.54)"
22573 #: ../src/guestfs-actions.pod:1259
22574 msgid "guestfs_df_h"
22578 #: ../src/guestfs-actions.pod:1261
22582 " guestfs_df_h (guestfs_h *g);\n"
22587 #: ../src/guestfs-actions.pod:1276
22588 msgid "guestfs_dmesg"
22592 #: ../src/guestfs-actions.pod:1278
22596 " guestfs_dmesg (guestfs_h *g);\n"
22601 #: ../src/guestfs-actions.pod:1285
22603 "Another way to get the same information is to enable verbose messages with "
22604 "C<guestfs_set_verbose> or by setting the environment variable "
22605 "C<LIBGUESTFS_DEBUG=1> before running the program."
22609 #: ../src/guestfs-actions.pod:1295
22610 msgid "guestfs_download"
22614 #: ../src/guestfs-actions.pod:1297
22618 " guestfs_download (guestfs_h *g,\n"
22619 " const char *remotefilename,\n"
22620 " const char *filename);\n"
22625 #: ../src/guestfs-actions.pod:1307
22626 msgid "See also C<guestfs_upload>, C<guestfs_cat>."
22630 #: ../src/guestfs-actions.pod:1318
22631 msgid "guestfs_download_offset"
22635 #: ../src/guestfs-actions.pod:1320
22639 " guestfs_download_offset (guestfs_h *g,\n"
22640 " const char *remotefilename,\n"
22641 " const char *filename,\n"
22642 " int64_t offset,\n"
22643 " int64_t size);\n"
22648 #: ../src/guestfs-actions.pod:1333
22650 "Note that there is no limit on the amount of data that can be downloaded "
22651 "with this call, unlike with C<guestfs_pread>, and this call always reads the "
22652 "full amount unless an error occurs."
22656 #: ../src/guestfs-actions.pod:1338
22657 msgid "See also C<guestfs_download>, C<guestfs_pread>."
22661 #: ../src/guestfs-actions.pod:1347 ../src/guestfs-actions.pod:7282
22662 msgid "(Added in 1.5.17)"
22666 #: ../src/guestfs-actions.pod:1349
22667 msgid "guestfs_drop_caches"
22671 #: ../src/guestfs-actions.pod:1351
22675 " guestfs_drop_caches (guestfs_h *g,\n"
22676 " int whattodrop);\n"
22681 #: ../src/guestfs-actions.pod:1369
22686 #: ../src/guestfs-actions.pod:1371
22690 " guestfs_du (guestfs_h *g,\n"
22691 " const char *path);\n"
22696 #: ../src/guestfs-actions.pod:1394
22697 msgid "guestfs_e2fsck_f"
22701 #: ../src/guestfs-actions.pod:1396
22705 " guestfs_e2fsck_f (guestfs_h *g,\n"
22706 " const char *device);\n"
22711 #: ../src/guestfs-actions.pod:1404
22713 "This command is only needed because of C<guestfs_resize2fs> (q.v.). "
22714 "Normally you should use C<guestfs_fsck>."
22718 #: ../src/guestfs-actions.pod:1409
22719 msgid "(Added in 1.0.29)"
22723 #: ../src/guestfs-actions.pod:1411
22724 msgid "guestfs_echo_daemon"
22728 #: ../src/guestfs-actions.pod:1413
22732 " guestfs_echo_daemon (guestfs_h *g,\n"
22733 " char *const *words);\n"
22738 #: ../src/guestfs-actions.pod:1422
22739 msgid "See also C<guestfs_ping_daemon>."
22743 #: ../src/guestfs-actions.pod:1427 ../src/guestfs-actions.pod:2174 ../src/guestfs-actions.pod:6453
22744 msgid "(Added in 1.0.69)"
22748 #: ../src/guestfs-actions.pod:1429
22749 msgid "guestfs_egrep"
22753 #: ../src/guestfs-actions.pod:1431
22757 " guestfs_egrep (guestfs_h *g,\n"
22758 " const char *regex,\n"
22759 " const char *path);\n"
22764 #: ../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:2479 ../src/guestfs-actions.pod:2492 ../src/guestfs-actions.pod:2507 ../src/guestfs-actions.pod:2553 ../src/guestfs-actions.pod:2575 ../src/guestfs-actions.pod:2588 ../src/guestfs-actions.pod:3857 ../src/guestfs-actions.pod:3871 ../src/guestfs-actions.pod:3884 ../src/guestfs-actions.pod:3898 ../src/guestfs-actions.pod:4899 ../src/guestfs-actions.pod:5930 ../src/guestfs-actions.pod:5979 ../src/guestfs-actions.pod:6849 ../src/guestfs-actions.pod:6861 ../src/guestfs-actions.pod:6874 ../src/guestfs-actions.pod:6887 ../src/guestfs-actions.pod:6909 ../src/guestfs-actions.pod:6922 ../src/guestfs-actions.pod:6935 ../src/guestfs-actions.pod:6948 ../src/guestfs-actions.pod:7742 ../src/guestfs-actions.pod:7761 ../src/guestfs-actions.pod:7847 ../src/guestfs-actions.pod:7866 ../src/guestfs-actions.pod:7912 ../src/guestfs-actions.pod:7931
22765 msgid "(Added in 1.0.66)"
22769 #: ../src/guestfs-actions.pod:1448
22770 msgid "guestfs_egrepi"
22774 #: ../src/guestfs-actions.pod:1450
22778 " guestfs_egrepi (guestfs_h *g,\n"
22779 " const char *regex,\n"
22780 " const char *path);\n"
22785 #: ../src/guestfs-actions.pod:1467
22786 msgid "guestfs_equal"
22790 #: ../src/guestfs-actions.pod:1469
22794 " guestfs_equal (guestfs_h *g,\n"
22795 " const char *file1,\n"
22796 " const char *file2);\n"
22801 #: ../src/guestfs-actions.pod:1483
22802 msgid "guestfs_exists"
22806 #: ../src/guestfs-actions.pod:1485
22810 " guestfs_exists (guestfs_h *g,\n"
22811 " const char *path);\n"
22816 #: ../src/guestfs-actions.pod:1492
22817 msgid "See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>."
22821 #: ../src/guestfs-actions.pod:1498
22822 msgid "guestfs_fallocate"
22826 #: ../src/guestfs-actions.pod:1500
22830 " guestfs_fallocate (guestfs_h *g,\n"
22831 " const char *path,\n"
22837 #: ../src/guestfs-actions.pod:1515
22839 "This function is deprecated. In new code, use the L</guestfs_fallocate64> "
22844 #: ../src/guestfs-actions.pod:1524
22845 msgid "guestfs_fallocate64"
22849 #: ../src/guestfs-actions.pod:1526
22853 " guestfs_fallocate64 (guestfs_h *g,\n"
22854 " const char *path,\n"
22860 #: ../src/guestfs-actions.pod:1535
22862 "Note that this call allocates disk blocks for the file. To create a sparse "
22863 "file use C<guestfs_truncate_size> instead."
22867 #: ../src/guestfs-actions.pod:1538
22869 "The deprecated call C<guestfs_fallocate> does the same, but owing to an "
22870 "oversight it only allowed 30 bit lengths to be specified, effectively "
22871 "limiting the maximum size of files created through that call to 1GB."
22875 #: ../src/guestfs-actions.pod:1549
22876 msgid "(Added in 1.3.17)"
22880 #: ../src/guestfs-actions.pod:1551
22881 msgid "guestfs_fgrep"
22885 #: ../src/guestfs-actions.pod:1553
22889 " guestfs_fgrep (guestfs_h *g,\n"
22890 " const char *pattern,\n"
22891 " const char *path);\n"
22896 #: ../src/guestfs-actions.pod:1570
22897 msgid "guestfs_fgrepi"
22901 #: ../src/guestfs-actions.pod:1572
22905 " guestfs_fgrepi (guestfs_h *g,\n"
22906 " const char *pattern,\n"
22907 " const char *path);\n"
22912 #: ../src/guestfs-actions.pod:1589
22913 msgid "guestfs_file"
22917 #: ../src/guestfs-actions.pod:1591
22921 " guestfs_file (guestfs_h *g,\n"
22922 " const char *path);\n"
22927 #: ../src/guestfs-actions.pod:1609
22929 "See also: L<file(1)>, C<guestfs_vfs_type>, C<guestfs_lstat>, "
22930 "C<guestfs_is_file>, C<guestfs_is_blockdev> (etc), C<guestfs_is_zero>."
22934 #: ../src/guestfs-actions.pod:1617
22935 msgid "guestfs_file_architecture"
22939 #: ../src/guestfs-actions.pod:1619
22943 " guestfs_file_architecture (guestfs_h *g,\n"
22944 " const char *filename);\n"
22949 #: ../src/guestfs-actions.pod:1727 ../src/guestfs-actions.pod:1890 ../src/guestfs-actions.pod:1907 ../src/guestfs-actions.pod:2608 ../src/guestfs-actions.pod:2698 ../src/guestfs-actions.pod:2764 ../src/guestfs-actions.pod:2951 ../src/guestfs-actions.pod:2969 ../src/guestfs-actions.pod:3009 ../src/guestfs-actions.pod:3084 ../src/guestfs-actions.pod:3177 ../src/guestfs-actions.pod:3414 ../src/guestfs-actions.pod:3546
22950 msgid "(Added in 1.5.3)"
22954 #: ../src/guestfs-actions.pod:1729
22955 msgid "guestfs_filesize"
22959 #: ../src/guestfs-actions.pod:1731
22963 " guestfs_filesize (guestfs_h *g,\n"
22964 " const char *file);\n"
22969 #: ../src/guestfs-actions.pod:1737
22971 "To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>, "
22972 "C<guestfs_is_dir>, C<guestfs_is_file> etc. To get the size of block "
22973 "devices, use C<guestfs_blockdev_getsize64>."
22977 #: ../src/guestfs-actions.pod:1743
22978 msgid "(Added in 1.0.82)"
22982 #: ../src/guestfs-actions.pod:1745
22983 msgid "guestfs_fill"
22987 #: ../src/guestfs-actions.pod:1747
22991 " guestfs_fill (guestfs_h *g,\n"
22994 " const char *path);\n"
22999 #: ../src/guestfs-actions.pod:1757
23001 "To fill a file with zero bytes (sparsely), it is much more efficient to use "
23002 "C<guestfs_truncate_size>. To create a file with a pattern of repeating "
23003 "bytes use C<guestfs_fill_pattern>."
23007 #: ../src/guestfs-actions.pod:1769
23008 msgid "(Added in 1.0.79)"
23012 #: ../src/guestfs-actions.pod:1771
23013 msgid "guestfs_fill_pattern"
23017 #: ../src/guestfs-actions.pod:1773
23021 " guestfs_fill_pattern (guestfs_h *g,\n"
23022 " const char *pattern,\n"
23024 " const char *path);\n"
23029 #: ../src/guestfs-actions.pod:1779
23031 "This function is like C<guestfs_fill> except that it creates a new file of "
23032 "length C<len> containing the repeating pattern of bytes in C<pattern>. The "
23033 "pattern is truncated if necessary to ensure the length of the file is "
23034 "exactly C<len> bytes."
23038 #: ../src/guestfs-actions.pod:1791
23039 msgid "(Added in 1.3.12)"
23043 #: ../src/guestfs-actions.pod:1793
23044 msgid "guestfs_find"
23048 #: ../src/guestfs-actions.pod:1795
23052 " guestfs_find (guestfs_h *g,\n"
23053 " const char *directory);\n"
23058 #: ../src/guestfs-actions.pod:1811
23059 msgid "then the returned list from C<guestfs_find> C</tmp> would be 4 elements:"
23063 #: ../src/guestfs-actions.pod:1824
23064 msgid "See also C<guestfs_find0>."
23068 #: ../src/guestfs-actions.pod:1833 ../src/guestfs-actions.pod:4304 ../src/guestfs-actions.pod:6014
23069 msgid "(Added in 1.0.27)"
23073 #: ../src/guestfs-actions.pod:1835
23074 msgid "guestfs_find0"
23078 #: ../src/guestfs-actions.pod:1837
23082 " guestfs_find0 (guestfs_h *g,\n"
23083 " const char *directory,\n"
23084 " const char *files);\n"
23089 #: ../src/guestfs-actions.pod:1846
23091 "This command works the same way as C<guestfs_find> with the following "
23096 #: ../src/guestfs-actions.pod:1873
23097 msgid "(Added in 1.0.74)"
23101 #: ../src/guestfs-actions.pod:1875
23102 msgid "guestfs_findfs_label"
23106 #: ../src/guestfs-actions.pod:1877
23110 " guestfs_findfs_label (guestfs_h *g,\n"
23111 " const char *label);\n"
23116 #: ../src/guestfs-actions.pod:1885
23117 msgid "To find the label of a filesystem, use C<guestfs_vfs_label>."
23121 #: ../src/guestfs-actions.pod:1892
23122 msgid "guestfs_findfs_uuid"
23126 #: ../src/guestfs-actions.pod:1894
23130 " guestfs_findfs_uuid (guestfs_h *g,\n"
23131 " const char *uuid);\n"
23136 #: ../src/guestfs-actions.pod:1902
23137 msgid "To find the UUID of a filesystem, use C<guestfs_vfs_uuid>."
23141 #: ../src/guestfs-actions.pod:1909
23142 msgid "guestfs_fsck"
23146 #: ../src/guestfs-actions.pod:1911
23150 " guestfs_fsck (guestfs_h *g,\n"
23151 " const char *fstype,\n"
23152 " const char *device);\n"
23157 #: ../src/guestfs-actions.pod:1946 ../src/guestfs-actions.pod:7785
23158 msgid "(Added in 1.0.16)"
23162 #: ../src/guestfs-actions.pod:1948
23163 msgid "guestfs_get_append"
23167 #: ../src/guestfs-actions.pod:1950
23171 " guestfs_get_append (guestfs_h *g);\n"
23176 #: ../src/guestfs-actions.pod:1958
23178 "This function returns a string which may be NULL. There is no way to return "
23179 "an error from this function. The string is owned by the guest handle and "
23180 "must I<not> be freed."
23184 #: ../src/guestfs-actions.pod:1962 ../src/guestfs-actions.pod:5692 ../src/guestfs-actions.pod:6174 ../src/guestfs-actions.pod:6616 ../src/guestfs-actions.pod:6635 ../src/guestfs-actions.pod:6651 ../src/guestfs-actions.pod:6675 ../src/guestfs-actions.pod:7429 ../src/guestfs-actions.pod:7444 ../src/guestfs-actions.pod:7828
23185 msgid "(Added in 1.0.26)"
23189 #: ../src/guestfs-actions.pod:1964
23190 msgid "guestfs_get_attach_method"
23194 #: ../src/guestfs-actions.pod:1966
23198 " guestfs_get_attach_method (guestfs_h *g);\n"
23203 #: ../src/guestfs-actions.pod:1969
23204 msgid "Return the current attach method. See C<guestfs_set_attach_method>."
23208 #: ../src/guestfs-actions.pod:1974 ../src/guestfs-actions.pod:6204
23209 msgid "(Added in 1.9.8)"
23213 #: ../src/guestfs-actions.pod:1976
23214 msgid "guestfs_get_autosync"
23218 #: ../src/guestfs-actions.pod:1978
23222 " guestfs_get_autosync (guestfs_h *g);\n"
23227 #: ../src/guestfs-actions.pod:1987
23228 msgid "guestfs_get_direct"
23232 #: ../src/guestfs-actions.pod:1989
23236 " guestfs_get_direct (guestfs_h *g);\n"
23241 #: ../src/guestfs-actions.pod:1996 ../src/guestfs-actions.pod:6245
23242 msgid "(Added in 1.0.72)"
23246 #: ../src/guestfs-actions.pod:1998
23247 msgid "guestfs_get_e2label"
23251 #: ../src/guestfs-actions.pod:2000
23255 " guestfs_get_e2label (guestfs_h *g,\n"
23256 " const char *device);\n"
23261 #: ../src/guestfs-actions.pod:2010
23263 "This function is deprecated. In new code, use the L</guestfs_vfs_label> "
23268 #: ../src/guestfs-actions.pod:2017 ../src/guestfs-actions.pod:2038 ../src/guestfs-actions.pod:6263 ../src/guestfs-actions.pod:6282
23269 msgid "(Added in 1.0.15)"
23273 #: ../src/guestfs-actions.pod:2019
23274 msgid "guestfs_get_e2uuid"
23278 #: ../src/guestfs-actions.pod:2021
23282 " guestfs_get_e2uuid (guestfs_h *g,\n"
23283 " const char *device);\n"
23288 #: ../src/guestfs-actions.pod:2031
23290 "This function is deprecated. In new code, use the L</guestfs_vfs_uuid> call "
23295 #: ../src/guestfs-actions.pod:2040
23296 msgid "guestfs_get_memsize"
23300 #: ../src/guestfs-actions.pod:2042
23304 " guestfs_get_memsize (guestfs_h *g);\n"
23309 #: ../src/guestfs-actions.pod:2048
23311 "If C<guestfs_set_memsize> was not called on this handle, and if "
23312 "C<LIBGUESTFS_MEMSIZE> was not set, then this returns the compiled-in default "
23313 "value for memsize."
23317 #: ../src/guestfs-actions.pod:2057 ../src/guestfs-actions.pod:4595 ../src/guestfs-actions.pod:4804 ../src/guestfs-actions.pod:4823 ../src/guestfs-actions.pod:4842 ../src/guestfs-actions.pod:4854 ../src/guestfs-actions.pod:4871 ../src/guestfs-actions.pod:4884 ../src/guestfs-actions.pod:5917 ../src/guestfs-actions.pod:6303 ../src/guestfs-actions.pod:6583 ../src/guestfs-actions.pod:7198
23318 msgid "(Added in 1.0.55)"
23322 #: ../src/guestfs-actions.pod:2059
23323 msgid "guestfs_get_network"
23327 #: ../src/guestfs-actions.pod:2061
23331 " guestfs_get_network (guestfs_h *g);\n"
23336 #: ../src/guestfs-actions.pod:2068 ../src/guestfs-actions.pod:6322
23337 msgid "(Added in 1.5.4)"
23341 #: ../src/guestfs-actions.pod:2070
23342 msgid "guestfs_get_path"
23346 #: ../src/guestfs-actions.pod:2072
23350 " guestfs_get_path (guestfs_h *g);\n"
23355 #: ../src/guestfs-actions.pod:2080 ../src/guestfs-actions.pod:2120
23357 "This function returns a string, or NULL on error. The string is owned by "
23358 "the guest handle and must I<not> be freed."
23362 #: ../src/guestfs-actions.pod:2085
23363 msgid "guestfs_get_pgroup"
23367 #: ../src/guestfs-actions.pod:2087
23371 " guestfs_get_pgroup (guestfs_h *g);\n"
23376 #: ../src/guestfs-actions.pod:2094 ../src/guestfs-actions.pod:6358 ../src/guestfs-actions.pod:7690
23377 msgid "(Added in 1.11.18)"
23381 #: ../src/guestfs-actions.pod:2096
23382 msgid "guestfs_get_pid"
23386 #: ../src/guestfs-actions.pod:2098
23390 " guestfs_get_pid (guestfs_h *g);\n"
23395 #: ../src/guestfs-actions.pod:2108
23396 msgid "(Added in 1.0.56)"
23400 #: ../src/guestfs-actions.pod:2110
23401 msgid "guestfs_get_qemu"
23405 #: ../src/guestfs-actions.pod:2112
23409 " guestfs_get_qemu (guestfs_h *g);\n"
23414 #: ../src/guestfs-actions.pod:2123 ../src/guestfs-actions.pod:6386
23415 msgid "(Added in 1.0.6)"
23419 #: ../src/guestfs-actions.pod:2125
23420 msgid "guestfs_get_recovery_proc"
23424 #: ../src/guestfs-actions.pod:2127
23428 " guestfs_get_recovery_proc (guestfs_h *g);\n"
23433 #: ../src/guestfs-actions.pod:2134 ../src/guestfs-actions.pod:3668 ../src/guestfs-actions.pod:3999 ../src/guestfs-actions.pod:4402 ../src/guestfs-actions.pod:4434 ../src/guestfs-actions.pod:5622 ../src/guestfs-actions.pod:5965 ../src/guestfs-actions.pod:6410 ../src/guestfs-actions.pod:7101 ../src/guestfs-actions.pod:7121 ../src/guestfs-actions.pod:7313
23434 msgid "(Added in 1.0.77)"
23438 #: ../src/guestfs-actions.pod:2136
23439 msgid "guestfs_get_selinux"
23443 #: ../src/guestfs-actions.pod:2138
23447 " guestfs_get_selinux (guestfs_h *g);\n"
23452 #: ../src/guestfs-actions.pod:2141
23454 "This returns the current setting of the selinux flag which is passed to the "
23455 "appliance at boot time. See C<guestfs_set_selinux>."
23459 #: ../src/guestfs-actions.pod:2149 ../src/guestfs-actions.pod:2212 ../src/guestfs-actions.pod:6429 ../src/guestfs-actions.pod:6487
23460 msgid "(Added in 1.0.67)"
23464 #: ../src/guestfs-actions.pod:2151
23465 msgid "guestfs_get_state"
23469 #: ../src/guestfs-actions.pod:2153
23473 " guestfs_get_state (guestfs_h *g);\n"
23478 #: ../src/guestfs-actions.pod:2165
23479 msgid "guestfs_get_trace"
23483 #: ../src/guestfs-actions.pod:2167
23487 " guestfs_get_trace (guestfs_h *g);\n"
23492 #: ../src/guestfs-actions.pod:2176
23493 msgid "guestfs_get_umask"
23497 #: ../src/guestfs-actions.pod:2178
23501 " guestfs_get_umask (guestfs_h *g);\n"
23506 #: ../src/guestfs-actions.pod:2181
23508 "Return the current umask. By default the umask is C<022> unless it has been "
23509 "set by calling C<guestfs_umask>."
23513 #: ../src/guestfs-actions.pod:2188
23514 msgid "guestfs_get_verbose"
23518 #: ../src/guestfs-actions.pod:2190
23522 " guestfs_get_verbose (guestfs_h *g);\n"
23527 #: ../src/guestfs-actions.pod:2199
23528 msgid "guestfs_getcon"
23532 #: ../src/guestfs-actions.pod:2201
23536 " guestfs_getcon (guestfs_h *g);\n"
23541 #: ../src/guestfs-actions.pod:2206
23542 msgid "See the documentation about SELINUX in L<guestfs(3)>, and C<guestfs_setcon>"
23546 #: ../src/guestfs-actions.pod:2214
23547 msgid "guestfs_getxattr"
23551 #: ../src/guestfs-actions.pod:2216
23555 " guestfs_getxattr (guestfs_h *g,\n"
23556 " const char *path,\n"
23557 " const char *name,\n"
23558 " size_t *size_r);\n"
23563 #: ../src/guestfs-actions.pod:2222
23565 "Get a single extended attribute from file C<path> named C<name>. This call "
23566 "follows symlinks. If you want to lookup an extended attribute for the "
23567 "symlink itself, use C<guestfs_lgetxattr>."
23571 #: ../src/guestfs-actions.pod:2226 ../src/guestfs-actions.pod:3682
23573 "Normally it is better to get all extended attributes from a file in one go "
23574 "by calling C<guestfs_getxattrs>. However some Linux filesystem "
23575 "implementations are buggy and do not provide a way to list out attributes. "
23576 "For these filesystems (notably ntfs-3g) you have to know the names of the "
23577 "extended attributes you want in advance and call this function."
23581 #: ../src/guestfs-actions.pod:2236
23582 msgid "See also: C<guestfs_getxattrs>, C<guestfs_lgetxattr>, L<attr(5)>."
23586 #: ../src/guestfs-actions.pod:2238 ../src/guestfs-actions.pod:2429 ../src/guestfs-actions.pod:2899 ../src/guestfs-actions.pod:3694 ../src/guestfs-actions.pod:5615 ../src/guestfs-actions.pod:5641 ../src/guestfs-actions.pod:5822
23588 "This function returns a buffer, or NULL on error. The size of the returned "
23589 "buffer is written to C<*size_r>. I<The caller must free the returned buffer "
23594 #: ../src/guestfs-actions.pod:2242 ../src/guestfs-actions.pod:3698
23595 msgid "(Added in 1.7.24)"
23599 #: ../src/guestfs-actions.pod:2244
23600 msgid "guestfs_getxattrs"
23604 #: ../src/guestfs-actions.pod:2246
23607 " struct guestfs_xattr_list *\n"
23608 " guestfs_getxattrs (guestfs_h *g,\n"
23609 " const char *path);\n"
23614 #: ../src/guestfs-actions.pod:2256
23615 msgid "See also: C<guestfs_lgetxattrs>, L<attr(5)>."
23619 #: ../src/guestfs-actions.pod:2258 ../src/guestfs-actions.pod:3710 ../src/guestfs-actions.pod:4398
23621 "This function returns a C<struct guestfs_xattr_list *>, or NULL if there was "
23622 "an error. I<The caller must call C<guestfs_free_xattr_list> after use>."
23626 #: ../src/guestfs-actions.pod:2262 ../src/guestfs-actions.pod:3714 ../src/guestfs-actions.pod:3913 ../src/guestfs-actions.pod:3949 ../src/guestfs-actions.pod:5995 ../src/guestfs-actions.pod:6506 ../src/guestfs-actions.pod:7893
23627 msgid "(Added in 1.0.59)"
23631 #: ../src/guestfs-actions.pod:2264
23632 msgid "guestfs_glob_expand"
23636 #: ../src/guestfs-actions.pod:2266
23640 " guestfs_glob_expand (guestfs_h *g,\n"
23641 " const char *pattern);\n"
23646 #: ../src/guestfs-actions.pod:2285 ../src/guestfs-actions.pod:6699 ../src/guestfs-actions.pod:6716
23647 msgid "(Added in 1.0.50)"
23651 #: ../src/guestfs-actions.pod:2287
23652 msgid "guestfs_grep"
23656 #: ../src/guestfs-actions.pod:2289
23660 " guestfs_grep (guestfs_h *g,\n"
23661 " const char *regex,\n"
23662 " const char *path);\n"
23667 #: ../src/guestfs-actions.pod:2306
23668 msgid "guestfs_grepi"
23672 #: ../src/guestfs-actions.pod:2308
23676 " guestfs_grepi (guestfs_h *g,\n"
23677 " const char *regex,\n"
23678 " const char *path);\n"
23683 #: ../src/guestfs-actions.pod:2325
23684 msgid "guestfs_grub_install"
23688 #: ../src/guestfs-actions.pod:2327
23692 " guestfs_grub_install (guestfs_h *g,\n"
23693 " const char *root,\n"
23694 " const char *device);\n"
23699 #: ../src/guestfs-actions.pod:2348
23700 msgid "(Added in 1.0.17)"
23704 #: ../src/guestfs-actions.pod:2350
23705 msgid "guestfs_head"
23709 #: ../src/guestfs-actions.pod:2352
23713 " guestfs_head (guestfs_h *g,\n"
23714 " const char *path);\n"
23719 #: ../src/guestfs-actions.pod:2368
23720 msgid "guestfs_head_n"
23724 #: ../src/guestfs-actions.pod:2370
23728 " guestfs_head_n (guestfs_h *g,\n"
23730 " const char *path);\n"
23735 #: ../src/guestfs-actions.pod:2392
23736 msgid "guestfs_hexdump"
23740 #: ../src/guestfs-actions.pod:2394
23744 " guestfs_hexdump (guestfs_h *g,\n"
23745 " const char *path);\n"
23750 #: ../src/guestfs-actions.pod:2407 ../src/guestfs-actions.pod:6780 ../src/guestfs-actions.pod:6835
23751 msgid "(Added in 1.0.22)"
23755 #: ../src/guestfs-actions.pod:2409
23756 msgid "guestfs_initrd_cat"
23760 #: ../src/guestfs-actions.pod:2411
23764 " guestfs_initrd_cat (guestfs_h *g,\n"
23765 " const char *initrdpath,\n"
23766 " const char *filename,\n"
23767 " size_t *size_r);\n"
23772 #: ../src/guestfs-actions.pod:2427
23773 msgid "See also C<guestfs_initrd_list>."
23777 #: ../src/guestfs-actions.pod:2438
23778 msgid "guestfs_initrd_list"
23782 #: ../src/guestfs-actions.pod:2440
23786 " guestfs_initrd_list (guestfs_h *g,\n"
23787 " const char *path);\n"
23792 #: ../src/guestfs-actions.pod:2460
23793 msgid "guestfs_inotify_add_watch"
23797 #: ../src/guestfs-actions.pod:2462
23801 " guestfs_inotify_add_watch (guestfs_h *g,\n"
23802 " const char *path,\n"
23808 #: ../src/guestfs-actions.pod:2481
23809 msgid "guestfs_inotify_close"
23813 #: ../src/guestfs-actions.pod:2483
23817 " guestfs_inotify_close (guestfs_h *g);\n"
23822 #: ../src/guestfs-actions.pod:2494
23823 msgid "guestfs_inotify_files"
23827 #: ../src/guestfs-actions.pod:2496
23831 " guestfs_inotify_files (guestfs_h *g);\n"
23836 #: ../src/guestfs-actions.pod:2499
23838 "This function is a helpful wrapper around C<guestfs_inotify_read> which just "
23839 "returns a list of pathnames of objects that were touched. The returned "
23840 "pathnames are sorted and deduplicated."
23844 #: ../src/guestfs-actions.pod:2509
23845 msgid "guestfs_inotify_init"
23849 #: ../src/guestfs-actions.pod:2511
23853 " guestfs_inotify_init (guestfs_h *g,\n"
23854 " int maxevents);\n"
23859 #: ../src/guestfs-actions.pod:2519
23861 "C<maxevents> is the maximum number of events which will be queued up between "
23862 "calls to C<guestfs_inotify_read> or C<guestfs_inotify_files>. If this is "
23863 "passed as C<0>, then the kernel (or previously set) default is used. For "
23864 "Linux 2.6.29 the default was 16384 events. Beyond this limit, the kernel "
23865 "throws away events, but records the fact that it threw them away by setting "
23866 "a flag C<IN_Q_OVERFLOW> in the returned structure list (see "
23867 "C<guestfs_inotify_read>)."
23871 #: ../src/guestfs-actions.pod:2529
23873 "Before any events are generated, you have to add some watches to the "
23874 "internal watch list. See: C<guestfs_inotify_add_watch>, "
23875 "C<guestfs_inotify_rm_watch> and C<guestfs_inotify_watch_all>."
23879 #: ../src/guestfs-actions.pod:2535
23881 "Queued up events should be read periodically by calling "
23882 "C<guestfs_inotify_read> (or C<guestfs_inotify_files> which is just a helpful "
23883 "wrapper around C<guestfs_inotify_read>). If you don't read the events out "
23884 "often enough then you risk the internal queue overflowing."
23888 #: ../src/guestfs-actions.pod:2542
23890 "The handle should be closed after use by calling C<guestfs_inotify_close>. "
23891 "This also removes any watches automatically."
23895 #: ../src/guestfs-actions.pod:2555
23896 msgid "guestfs_inotify_read"
23900 #: ../src/guestfs-actions.pod:2557
23903 " struct guestfs_inotify_event_list *\n"
23904 " guestfs_inotify_read (guestfs_h *g);\n"
23909 #: ../src/guestfs-actions.pod:2571
23911 "This function returns a C<struct guestfs_inotify_event_list *>, or NULL if "
23912 "there was an error. I<The caller must call "
23913 "C<guestfs_free_inotify_event_list> after use>."
23917 #: ../src/guestfs-actions.pod:2577
23918 msgid "guestfs_inotify_rm_watch"
23922 #: ../src/guestfs-actions.pod:2579
23926 " guestfs_inotify_rm_watch (guestfs_h *g,\n"
23932 #: ../src/guestfs-actions.pod:2583
23934 "Remove a previously defined inotify watch. See "
23935 "C<guestfs_inotify_add_watch>."
23939 #: ../src/guestfs-actions.pod:2590
23940 msgid "guestfs_inspect_get_arch"
23944 #: ../src/guestfs-actions.pod:2592
23948 " guestfs_inspect_get_arch (guestfs_h *g,\n"
23949 " const char *root);\n"
23954 #: ../src/guestfs-actions.pod:2596
23956 "This returns the architecture of the inspected operating system. The "
23957 "possible return values are listed under C<guestfs_file_architecture>."
23961 #: ../src/guestfs-actions.pod:2610
23962 msgid "guestfs_inspect_get_distro"
23966 #: ../src/guestfs-actions.pod:2612
23970 " guestfs_inspect_get_distro (guestfs_h *g,\n"
23971 " const char *root);\n"
23976 #: ../src/guestfs-actions.pod:2700
23977 msgid "guestfs_inspect_get_drive_mappings"
23981 #: ../src/guestfs-actions.pod:2702
23985 " guestfs_inspect_get_drive_mappings (guestfs_h *g,\n"
23986 " const char *root);\n"
23991 #: ../src/guestfs-actions.pod:2731
23993 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
23994 "C<guestfs_inspect_get_mountpoints>, C<guestfs_inspect_get_filesystems>."
23998 #: ../src/guestfs-actions.pod:2735 ../src/guestfs-actions.pod:3003 ../src/guestfs-actions.pod:3801 ../src/guestfs-actions.pod:5083 ../src/guestfs-actions.pod:7137
24000 "This function returns a NULL-terminated array of strings, or NULL if there "
24001 "was an error. The array of strings will always have length C<2n+1>, where "
24002 "C<n> keys and values alternate, followed by the trailing NULL entry. I<The "
24003 "caller must free the strings and the array after use>."
24007 #: ../src/guestfs-actions.pod:2741 ../src/guestfs-actions.pod:3197
24008 msgid "(Added in 1.9.17)"
24012 #: ../src/guestfs-actions.pod:2743
24013 msgid "guestfs_inspect_get_filesystems"
24017 #: ../src/guestfs-actions.pod:2745
24021 " guestfs_inspect_get_filesystems (guestfs_h *g,\n"
24022 " const char *root);\n"
24027 #: ../src/guestfs-actions.pod:2757
24029 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24030 "C<guestfs_inspect_get_mountpoints>."
24034 #: ../src/guestfs-actions.pod:2766
24035 msgid "guestfs_inspect_get_format"
24039 #: ../src/guestfs-actions.pod:2768
24043 " guestfs_inspect_get_format (guestfs_h *g,\n"
24044 " const char *root);\n"
24049 #: ../src/guestfs-actions.pod:2802 ../src/guestfs-actions.pod:3233 ../src/guestfs-actions.pod:3249 ../src/guestfs-actions.pod:3267 ../src/guestfs-actions.pod:6033
24050 msgid "(Added in 1.9.4)"
24054 #: ../src/guestfs-actions.pod:2804
24055 msgid "guestfs_inspect_get_hostname"
24059 #: ../src/guestfs-actions.pod:2806
24063 " guestfs_inspect_get_hostname (guestfs_h *g,\n"
24064 " const char *root);\n"
24069 #: ../src/guestfs-actions.pod:2821
24070 msgid "(Added in 1.7.9)"
24074 #: ../src/guestfs-actions.pod:2823
24075 msgid "guestfs_inspect_get_icon"
24079 #: ../src/guestfs-actions.pod:2825
24083 " guestfs_inspect_get_icon (guestfs_h *g,\n"
24084 " const char *root,\n"
24085 " size_t *size_r,\n"
24091 #: ../src/guestfs-actions.pod:2836
24094 " GUESTFS_INSPECT_GET_ICON_FAVICON, int favicon,\n"
24095 " GUESTFS_INSPECT_GET_ICON_HIGHQUALITY, int highquality,\n"
24100 #: ../src/guestfs-actions.pod:2903 ../src/guestfs-actions.pod:3728 ../src/guestfs-actions.pod:4982
24101 msgid "(Added in 1.11.12)"
24105 #: ../src/guestfs-actions.pod:2905
24106 msgid "guestfs_inspect_get_icon_va"
24110 #: ../src/guestfs-actions.pod:2907
24114 " guestfs_inspect_get_icon_va (guestfs_h *g,\n"
24115 " const char *root,\n"
24116 " size_t *size_r,\n"
24117 " va_list args);\n"
24122 #: ../src/guestfs-actions.pod:2913
24123 msgid "This is the \"va_list variant\" of L</guestfs_inspect_get_icon>."
24127 #: ../src/guestfs-actions.pod:2917
24128 msgid "guestfs_inspect_get_icon_argv"
24132 #: ../src/guestfs-actions.pod:2919
24136 " guestfs_inspect_get_icon_argv (guestfs_h *g,\n"
24137 " const char *root,\n"
24138 " size_t *size_r,\n"
24139 " const struct guestfs_inspect_get_icon_argv "
24145 #: ../src/guestfs-actions.pod:2925
24146 msgid "This is the \"argv variant\" of L</guestfs_inspect_get_icon>."
24150 #: ../src/guestfs-actions.pod:2929
24151 msgid "guestfs_inspect_get_major_version"
24155 #: ../src/guestfs-actions.pod:2931
24159 " guestfs_inspect_get_major_version (guestfs_h *g,\n"
24160 " const char *root);\n"
24165 #: ../src/guestfs-actions.pod:2953
24166 msgid "guestfs_inspect_get_minor_version"
24170 #: ../src/guestfs-actions.pod:2955
24174 " guestfs_inspect_get_minor_version (guestfs_h *g,\n"
24175 " const char *root);\n"
24180 #: ../src/guestfs-actions.pod:2964
24182 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24183 "C<guestfs_inspect_get_major_version>."
24187 #: ../src/guestfs-actions.pod:2971
24188 msgid "guestfs_inspect_get_mountpoints"
24192 #: ../src/guestfs-actions.pod:2973
24196 " guestfs_inspect_get_mountpoints (guestfs_h *g,\n"
24197 " const char *root);\n"
24202 #: ../src/guestfs-actions.pod:2994
24204 "For operating systems like Windows which still use drive letters, this call "
24205 "will only return an entry for the first drive \"mounted on\" C</>. For "
24206 "information about the mapping of drive letters to partitions, see "
24207 "C<guestfs_inspect_get_drive_mappings>."
24211 #: ../src/guestfs-actions.pod:3000
24213 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24214 "C<guestfs_inspect_get_filesystems>."
24218 #: ../src/guestfs-actions.pod:3011
24219 msgid "guestfs_inspect_get_package_format"
24223 #: ../src/guestfs-actions.pod:3013
24227 " guestfs_inspect_get_package_format (guestfs_h *g,\n"
24228 " const char *root);\n"
24233 #: ../src/guestfs-actions.pod:3017
24235 "This function and C<guestfs_inspect_get_package_management> return the "
24236 "package format and package management tool used by the inspected operating "
24237 "system. For example for Fedora these functions would return C<rpm> (package "
24238 "format) and C<yum> (package management)."
24242 #: ../src/guestfs-actions.pod:3035 ../src/guestfs-actions.pod:3063
24243 msgid "(Added in 1.7.5)"
24247 #: ../src/guestfs-actions.pod:3037
24248 msgid "guestfs_inspect_get_package_management"
24252 #: ../src/guestfs-actions.pod:3039
24256 " guestfs_inspect_get_package_management (guestfs_h *g,\n"
24257 " const char *root);\n"
24262 #: ../src/guestfs-actions.pod:3043
24264 "C<guestfs_inspect_get_package_format> and this function return the package "
24265 "format and package management tool used by the inspected operating system. "
24266 "For example for Fedora these functions would return C<rpm> (package format) "
24267 "and C<yum> (package management)."
24271 #: ../src/guestfs-actions.pod:3065
24272 msgid "guestfs_inspect_get_product_name"
24276 #: ../src/guestfs-actions.pod:3067
24280 " guestfs_inspect_get_product_name (guestfs_h *g,\n"
24281 " const char *root);\n"
24286 #: ../src/guestfs-actions.pod:3086
24287 msgid "guestfs_inspect_get_product_variant"
24291 #: ../src/guestfs-actions.pod:3088
24295 " guestfs_inspect_get_product_variant (guestfs_h *g,\n"
24296 " const char *root);\n"
24301 #: ../src/guestfs-actions.pod:3111
24303 "Please read L<guestfs(3)/INSPECTION> for more details. See also "
24304 "C<guestfs_inspect_get_product_name>, C<guestfs_inspect_get_major_version>."
24308 #: ../src/guestfs-actions.pod:3118
24309 msgid "(Added in 1.9.13)"
24313 #: ../src/guestfs-actions.pod:3120
24314 msgid "guestfs_inspect_get_roots"
24318 #: ../src/guestfs-actions.pod:3122
24322 " guestfs_inspect_get_roots (guestfs_h *g);\n"
24327 #: ../src/guestfs-actions.pod:3125
24329 "This function is a convenient way to get the list of root devices, as "
24330 "returned from a previous call to C<guestfs_inspect_os>, but without redoing "
24331 "the whole inspection process."
24335 #: ../src/guestfs-actions.pod:3129
24337 "This returns an empty list if either no root devices were found or the "
24338 "caller has not called C<guestfs_inspect_os>."
24342 #: ../src/guestfs-actions.pod:3138
24343 msgid "(Added in 1.7.3)"
24347 #: ../src/guestfs-actions.pod:3140
24348 msgid "guestfs_inspect_get_type"
24352 #: ../src/guestfs-actions.pod:3142
24356 " guestfs_inspect_get_type (guestfs_h *g,\n"
24357 " const char *root);\n"
24362 #: ../src/guestfs-actions.pod:3179
24363 msgid "guestfs_inspect_get_windows_current_control_set"
24367 #: ../src/guestfs-actions.pod:3181
24371 " guestfs_inspect_get_windows_current_control_set (guestfs_h *g,\n"
24372 " const char *root);\n"
24377 #: ../src/guestfs-actions.pod:3199
24378 msgid "guestfs_inspect_get_windows_systemroot"
24382 #: ../src/guestfs-actions.pod:3201
24386 " guestfs_inspect_get_windows_systemroot (guestfs_h *g,\n"
24387 " const char *root);\n"
24392 #: ../src/guestfs-actions.pod:3217
24393 msgid "(Added in 1.5.25)"
24397 #: ../src/guestfs-actions.pod:3219
24398 msgid "guestfs_inspect_is_live"
24402 #: ../src/guestfs-actions.pod:3221
24406 " guestfs_inspect_is_live (guestfs_h *g,\n"
24407 " const char *root);\n"
24412 #: ../src/guestfs-actions.pod:3225
24414 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
24415 "disk), then this returns true if a live image was detected on the disk."
24419 #: ../src/guestfs-actions.pod:3235
24420 msgid "guestfs_inspect_is_multipart"
24424 #: ../src/guestfs-actions.pod:3237
24428 " guestfs_inspect_is_multipart (guestfs_h *g,\n"
24429 " const char *root);\n"
24434 #: ../src/guestfs-actions.pod:3241
24436 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
24437 "disk), then this returns true if the disk is part of a set."
24441 #: ../src/guestfs-actions.pod:3251
24442 msgid "guestfs_inspect_is_netinst"
24446 #: ../src/guestfs-actions.pod:3253
24450 " guestfs_inspect_is_netinst (guestfs_h *g,\n"
24451 " const char *root);\n"
24456 #: ../src/guestfs-actions.pod:3257
24458 "If C<guestfs_inspect_get_format> returns C<installer> (this is an install "
24459 "disk), then this returns true if the disk is a network installer, ie. not a "
24460 "self-contained install CD but one which is likely to require network access "
24461 "to complete the install."
24465 #: ../src/guestfs-actions.pod:3269
24466 msgid "guestfs_inspect_list_applications"
24470 #: ../src/guestfs-actions.pod:3271
24473 " struct guestfs_application_list *\n"
24474 " guestfs_inspect_list_applications (guestfs_h *g,\n"
24475 " const char *root);\n"
24480 #: ../src/guestfs-actions.pod:3277
24482 "I<Note:> This call works differently from other parts of the inspection "
24483 "API. You have to call C<guestfs_inspect_os>, then "
24484 "C<guestfs_inspect_get_mountpoints>, then mount up the disks, before calling "
24485 "this. Listing applications is a significantly more difficult operation "
24486 "which requires access to the full filesystem. Also note that unlike the "
24487 "other C<guestfs_inspect_get_*> calls which are just returning data cached in "
24488 "the libguestfs handle, this call actually reads parts of the mounted "
24489 "filesystems during the call."
24493 #: ../src/guestfs-actions.pod:3367
24495 "This function returns a C<struct guestfs_application_list *>, or NULL if "
24496 "there was an error. I<The caller must call C<guestfs_free_application_list> "
24501 #: ../src/guestfs-actions.pod:3371
24502 msgid "(Added in 1.7.8)"
24506 #: ../src/guestfs-actions.pod:3373
24507 msgid "guestfs_inspect_os"
24511 #: ../src/guestfs-actions.pod:3375
24515 " guestfs_inspect_os (guestfs_h *g);\n"
24520 #: ../src/guestfs-actions.pod:3391
24522 "You can pass the root string(s) returned to other C<guestfs_inspect_get_*> "
24523 "functions in order to query further information about each operating system, "
24524 "such as the name and version."
24528 #: ../src/guestfs-actions.pod:3396
24530 "This function uses other libguestfs features such as C<guestfs_mount_ro> and "
24531 "C<guestfs_umount_all> in order to mount and unmount filesystems and look at "
24532 "the contents. This should be called with no disks currently mounted. The "
24533 "function may also use Augeas, so any existing Augeas handle will be closed."
24537 #: ../src/guestfs-actions.pod:3408 ../src/guestfs-actions.pod:3739 ../src/guestfs-actions.pod:3821
24538 msgid "See also C<guestfs_list_filesystems>."
24542 #: ../src/guestfs-actions.pod:3416
24543 msgid "guestfs_is_blockdev"
24547 #: ../src/guestfs-actions.pod:3418
24551 " guestfs_is_blockdev (guestfs_h *g,\n"
24552 " const char *path);\n"
24557 #: ../src/guestfs-actions.pod:3425 ../src/guestfs-actions.pod:3454 ../src/guestfs-actions.pod:3484 ../src/guestfs-actions.pod:3499 ../src/guestfs-actions.pod:3515 ../src/guestfs-actions.pod:3571 ../src/guestfs-actions.pod:3586
24558 msgid "See also C<guestfs_stat>."
24562 #: ../src/guestfs-actions.pod:3429 ../src/guestfs-actions.pod:3458 ../src/guestfs-actions.pod:3503 ../src/guestfs-actions.pod:3575 ../src/guestfs-actions.pod:3590
24563 msgid "(Added in 1.5.10)"
24567 #: ../src/guestfs-actions.pod:3431
24568 msgid "guestfs_is_busy"
24572 #: ../src/guestfs-actions.pod:3433
24576 " guestfs_is_busy (guestfs_h *g);\n"
24581 #: ../src/guestfs-actions.pod:3445
24582 msgid "guestfs_is_chardev"
24586 #: ../src/guestfs-actions.pod:3447
24590 " guestfs_is_chardev (guestfs_h *g,\n"
24591 " const char *path);\n"
24596 #: ../src/guestfs-actions.pod:3460
24597 msgid "guestfs_is_config"
24601 #: ../src/guestfs-actions.pod:3462
24605 " guestfs_is_config (guestfs_h *g);\n"
24610 #: ../src/guestfs-actions.pod:3474
24611 msgid "guestfs_is_dir"
24615 #: ../src/guestfs-actions.pod:3476
24619 " guestfs_is_dir (guestfs_h *g,\n"
24620 " const char *path);\n"
24625 #: ../src/guestfs-actions.pod:3490
24626 msgid "guestfs_is_fifo"
24630 #: ../src/guestfs-actions.pod:3492
24634 " guestfs_is_fifo (guestfs_h *g,\n"
24635 " const char *path);\n"
24640 #: ../src/guestfs-actions.pod:3505
24641 msgid "guestfs_is_file"
24645 #: ../src/guestfs-actions.pod:3507
24649 " guestfs_is_file (guestfs_h *g,\n"
24650 " const char *path);\n"
24655 #: ../src/guestfs-actions.pod:3521
24656 msgid "guestfs_is_launching"
24660 #: ../src/guestfs-actions.pod:3523
24664 " guestfs_is_launching (guestfs_h *g);\n"
24669 #: ../src/guestfs-actions.pod:3535
24670 msgid "guestfs_is_lv"
24674 #: ../src/guestfs-actions.pod:3537
24678 " guestfs_is_lv (guestfs_h *g,\n"
24679 " const char *device);\n"
24684 #: ../src/guestfs-actions.pod:3548
24685 msgid "guestfs_is_ready"
24689 #: ../src/guestfs-actions.pod:3550
24693 " guestfs_is_ready (guestfs_h *g);\n"
24698 #: ../src/guestfs-actions.pod:3562
24699 msgid "guestfs_is_socket"
24703 #: ../src/guestfs-actions.pod:3564
24707 " guestfs_is_socket (guestfs_h *g,\n"
24708 " const char *path);\n"
24713 #: ../src/guestfs-actions.pod:3577
24714 msgid "guestfs_is_symlink"
24718 #: ../src/guestfs-actions.pod:3579
24722 " guestfs_is_symlink (guestfs_h *g,\n"
24723 " const char *path);\n"
24728 #: ../src/guestfs-actions.pod:3592
24729 msgid "guestfs_is_zero"
24733 #: ../src/guestfs-actions.pod:3594
24737 " guestfs_is_zero (guestfs_h *g,\n"
24738 " const char *path);\n"
24743 #: ../src/guestfs-actions.pod:3603 ../src/guestfs-actions.pod:3617
24744 msgid "(Added in 1.11.8)"
24748 #: ../src/guestfs-actions.pod:3605
24749 msgid "guestfs_is_zero_device"
24753 #: ../src/guestfs-actions.pod:3607
24757 " guestfs_is_zero_device (guestfs_h *g,\n"
24758 " const char *device);\n"
24763 #: ../src/guestfs-actions.pod:3619
24764 msgid "guestfs_kill_subprocess"
24768 #: ../src/guestfs-actions.pod:3621
24772 " guestfs_kill_subprocess (guestfs_h *g);\n"
24777 #: ../src/guestfs-actions.pod:3630
24778 msgid "guestfs_launch"
24782 #: ../src/guestfs-actions.pod:3632
24786 " guestfs_launch (guestfs_h *g);\n"
24791 #: ../src/guestfs-actions.pod:3650
24792 msgid "guestfs_lchown"
24796 #: ../src/guestfs-actions.pod:3652
24800 " guestfs_lchown (guestfs_h *g,\n"
24803 " const char *path);\n"
24808 #: ../src/guestfs-actions.pod:3658
24810 "Change the file owner to C<owner> and group to C<group>. This is like "
24811 "C<guestfs_chown> but if C<path> is a symlink then the link itself is "
24812 "changed, not the target."
24816 #: ../src/guestfs-actions.pod:3670
24817 msgid "guestfs_lgetxattr"
24821 #: ../src/guestfs-actions.pod:3672
24825 " guestfs_lgetxattr (guestfs_h *g,\n"
24826 " const char *path,\n"
24827 " const char *name,\n"
24828 " size_t *size_r);\n"
24833 #: ../src/guestfs-actions.pod:3692
24834 msgid "See also: C<guestfs_lgetxattrs>, C<guestfs_getxattr>, L<attr(5)>."
24838 #: ../src/guestfs-actions.pod:3700
24839 msgid "guestfs_lgetxattrs"
24843 #: ../src/guestfs-actions.pod:3702
24846 " struct guestfs_xattr_list *\n"
24847 " guestfs_lgetxattrs (guestfs_h *g,\n"
24848 " const char *path);\n"
24853 #: ../src/guestfs-actions.pod:3706
24855 "This is the same as C<guestfs_getxattrs>, but if C<path> is a symbolic link, "
24856 "then it returns the extended attributes of the link itself."
24860 #: ../src/guestfs-actions.pod:3716
24861 msgid "guestfs_list_9p"
24865 #: ../src/guestfs-actions.pod:3718
24869 " guestfs_list_9p (guestfs_h *g);\n"
24874 #: ../src/guestfs-actions.pod:3730
24875 msgid "guestfs_list_devices"
24879 #: ../src/guestfs-actions.pod:3732
24883 " guestfs_list_devices (guestfs_h *g);\n"
24888 #: ../src/guestfs-actions.pod:3747
24889 msgid "guestfs_list_dm_devices"
24893 #: ../src/guestfs-actions.pod:3749
24897 " guestfs_list_dm_devices (guestfs_h *g);\n"
24902 #: ../src/guestfs-actions.pod:3754
24904 "The returned list contains C</dev/mapper/*> devices, eg. ones created by a "
24905 "previous call to C<guestfs_luks_open>."
24909 #: ../src/guestfs-actions.pod:3757
24911 "Device mapper devices which correspond to logical volumes are I<not> "
24912 "returned in this list. Call C<guestfs_lvs> if you want to list logical "
24917 #: ../src/guestfs-actions.pod:3765 ../src/guestfs-actions.pod:5221
24918 msgid "(Added in 1.11.15)"
24922 #: ../src/guestfs-actions.pod:3767
24923 msgid "guestfs_list_filesystems"
24927 #: ../src/guestfs-actions.pod:3769
24931 " guestfs_list_filesystems (guestfs_h *g);\n"
24936 #: ../src/guestfs-actions.pod:3789
24938 "This command runs other libguestfs commands, which might include "
24939 "C<guestfs_mount> and C<guestfs_umount>, and therefore you should use this "
24940 "soon after launch and only when nothing is mounted."
24944 #: ../src/guestfs-actions.pod:3793
24946 "Not all of the filesystems returned will be mountable. In particular, swap "
24947 "partitions are returned in the list. Also this command does not check that "
24948 "each filesystem found is valid and mountable, and some filesystems might be "
24949 "mountable but require special options. Filesystems may not all belong to a "
24950 "single logical operating system (use C<guestfs_inspect_os> to look for "
24955 #: ../src/guestfs-actions.pod:3807 ../src/guestfs-actions.pod:5582
24956 msgid "(Added in 1.5.15)"
24960 #: ../src/guestfs-actions.pod:3809
24961 msgid "guestfs_list_partitions"
24965 #: ../src/guestfs-actions.pod:3811
24969 " guestfs_list_partitions (guestfs_h *g);\n"
24974 #: ../src/guestfs-actions.pod:3818
24976 "This does not return logical volumes. For that you will need to call "
24981 #: ../src/guestfs-actions.pod:3829
24986 #: ../src/guestfs-actions.pod:3831
24990 " guestfs_ll (guestfs_h *g,\n"
24991 " const char *directory);\n"
24996 #: ../src/guestfs-actions.pod:3846
25001 #: ../src/guestfs-actions.pod:3848
25005 " guestfs_ln (guestfs_h *g,\n"
25006 " const char *target,\n"
25007 " const char *linkname);\n"
25012 #: ../src/guestfs-actions.pod:3859
25013 msgid "guestfs_ln_f"
25017 #: ../src/guestfs-actions.pod:3861
25021 " guestfs_ln_f (guestfs_h *g,\n"
25022 " const char *target,\n"
25023 " const char *linkname);\n"
25028 #: ../src/guestfs-actions.pod:3873
25029 msgid "guestfs_ln_s"
25033 #: ../src/guestfs-actions.pod:3875
25037 " guestfs_ln_s (guestfs_h *g,\n"
25038 " const char *target,\n"
25039 " const char *linkname);\n"
25044 #: ../src/guestfs-actions.pod:3886
25045 msgid "guestfs_ln_sf"
25049 #: ../src/guestfs-actions.pod:3888
25053 " guestfs_ln_sf (guestfs_h *g,\n"
25054 " const char *target,\n"
25055 " const char *linkname);\n"
25060 #: ../src/guestfs-actions.pod:3900
25061 msgid "guestfs_lremovexattr"
25065 #: ../src/guestfs-actions.pod:3902
25069 " guestfs_lremovexattr (guestfs_h *g,\n"
25070 " const char *xattr,\n"
25071 " const char *path);\n"
25076 #: ../src/guestfs-actions.pod:3907
25078 "This is the same as C<guestfs_removexattr>, but if C<path> is a symbolic "
25079 "link, then it removes an extended attribute of the link itself."
25083 #: ../src/guestfs-actions.pod:3915
25088 #: ../src/guestfs-actions.pod:3917
25092 " guestfs_ls (guestfs_h *g,\n"
25093 " const char *directory);\n"
25098 #: ../src/guestfs-actions.pod:3925
25100 "This command is mostly useful for interactive sessions. Programs should "
25101 "probably use C<guestfs_readdir> instead."
25105 #: ../src/guestfs-actions.pod:3934
25106 msgid "guestfs_lsetxattr"
25110 #: ../src/guestfs-actions.pod:3936
25114 " guestfs_lsetxattr (guestfs_h *g,\n"
25115 " const char *xattr,\n"
25116 " const char *val,\n"
25118 " const char *path);\n"
25123 #: ../src/guestfs-actions.pod:3943
25125 "This is the same as C<guestfs_setxattr>, but if C<path> is a symbolic link, "
25126 "then it sets an extended attribute of the link itself."
25130 #: ../src/guestfs-actions.pod:3951
25131 msgid "guestfs_lstat"
25135 #: ../src/guestfs-actions.pod:3953
25138 " struct guestfs_stat *\n"
25139 " guestfs_lstat (guestfs_h *g,\n"
25140 " const char *path);\n"
25145 #: ../src/guestfs-actions.pod:3959
25147 "This is the same as C<guestfs_stat> except that if C<path> is a symbolic "
25148 "link, then the link is stat-ed, not the file it refers to."
25152 #: ../src/guestfs-actions.pod:3965 ../src/guestfs-actions.pod:6740
25154 "This function returns a C<struct guestfs_stat *>, or NULL if there was an "
25155 "error. I<The caller must call C<guestfs_free_stat> after use>."
25159 #: ../src/guestfs-actions.pod:3969 ../src/guestfs-actions.pod:6744 ../src/guestfs-actions.pod:6762 ../src/guestfs-actions.pod:7143
25160 msgid "(Added in 0.9.2)"
25164 #: ../src/guestfs-actions.pod:3971
25165 msgid "guestfs_lstatlist"
25169 #: ../src/guestfs-actions.pod:3973
25172 " struct guestfs_stat_list *\n"
25173 " guestfs_lstatlist (guestfs_h *g,\n"
25174 " const char *path,\n"
25175 " char *const *names);\n"
25180 #: ../src/guestfs-actions.pod:3978
25182 "This call allows you to perform the C<guestfs_lstat> operation on multiple "
25183 "files, where all files are in the directory C<path>. C<names> is the list "
25184 "of files from this directory."
25188 #: ../src/guestfs-actions.pod:3987
25190 "This call is intended for programs that want to efficiently list a directory "
25191 "contents without making many round-trips. See also C<guestfs_lxattrlist> "
25192 "for a similarly efficient call for getting extended attributes. Very long "
25193 "directory listings might cause the protocol message size to be exceeded, "
25194 "causing this call to fail. The caller must split up such requests into "
25195 "smaller groups of names."
25199 #: ../src/guestfs-actions.pod:3995
25201 "This function returns a C<struct guestfs_stat_list *>, or NULL if there was "
25202 "an error. I<The caller must call C<guestfs_free_stat_list> after use>."
25206 #: ../src/guestfs-actions.pod:4001
25207 msgid "guestfs_luks_add_key"
25211 #: ../src/guestfs-actions.pod:4003
25215 " guestfs_luks_add_key (guestfs_h *g,\n"
25216 " const char *device,\n"
25217 " const char *key,\n"
25218 " const char *newkey,\n"
25224 #: ../src/guestfs-actions.pod:4015
25226 "Note that if C<keyslot> already contains a key, then this command will "
25227 "fail. You have to use C<guestfs_luks_kill_slot> first to remove that key."
25231 #: ../src/guestfs-actions.pod:4021 ../src/guestfs-actions.pod:4061 ../src/guestfs-actions.pod:4084 ../src/guestfs-actions.pod:4104 ../src/guestfs-actions.pod:4139 ../src/guestfs-actions.pod:4158
25233 "This function takes a key or passphrase parameter which could contain "
25234 "sensitive material. Read the section L</KEYS AND PASSPHRASES> for more "
25239 #: ../src/guestfs-actions.pod:4025 ../src/guestfs-actions.pod:4065 ../src/guestfs-actions.pod:4088 ../src/guestfs-actions.pod:4108
25240 msgid "(Added in 1.5.2)"
25244 #: ../src/guestfs-actions.pod:4027
25245 msgid "guestfs_luks_close"
25249 #: ../src/guestfs-actions.pod:4029
25253 " guestfs_luks_close (guestfs_h *g,\n"
25254 " const char *device);\n"
25259 #: ../src/guestfs-actions.pod:4033
25261 "This closes a LUKS device that was created earlier by C<guestfs_luks_open> "
25262 "or C<guestfs_luks_open_ro>. The C<device> parameter must be the name of the "
25263 "LUKS mapping device (ie. C</dev/mapper/mapname>) and I<not> the name of the "
25264 "underlying block device."
25268 #: ../src/guestfs-actions.pod:4041 ../src/guestfs-actions.pod:4143 ../src/guestfs-actions.pod:4162 ../src/guestfs-actions.pod:4212 ../src/guestfs-actions.pod:4260
25269 msgid "(Added in 1.5.1)"
25273 #: ../src/guestfs-actions.pod:4043
25274 msgid "guestfs_luks_format"
25278 #: ../src/guestfs-actions.pod:4045
25282 " guestfs_luks_format (guestfs_h *g,\n"
25283 " const char *device,\n"
25284 " const char *key,\n"
25290 #: ../src/guestfs-actions.pod:4067
25291 msgid "guestfs_luks_format_cipher"
25295 #: ../src/guestfs-actions.pod:4069
25299 " guestfs_luks_format_cipher (guestfs_h *g,\n"
25300 " const char *device,\n"
25301 " const char *key,\n"
25303 " const char *cipher);\n"
25308 #: ../src/guestfs-actions.pod:4076
25310 "This command is the same as C<guestfs_luks_format> but it also allows you to "
25311 "set the C<cipher> used."
25315 #: ../src/guestfs-actions.pod:4090
25316 msgid "guestfs_luks_kill_slot"
25320 #: ../src/guestfs-actions.pod:4092
25324 " guestfs_luks_kill_slot (guestfs_h *g,\n"
25325 " const char *device,\n"
25326 " const char *key,\n"
25332 #: ../src/guestfs-actions.pod:4110
25333 msgid "guestfs_luks_open"
25337 #: ../src/guestfs-actions.pod:4112
25341 " guestfs_luks_open (guestfs_h *g,\n"
25342 " const char *device,\n"
25343 " const char *key,\n"
25344 " const char *mapname);\n"
25349 #: ../src/guestfs-actions.pod:4130
25351 "If this block device contains LVM volume groups, then calling "
25352 "C<guestfs_vgscan> followed by C<guestfs_vg_activate_all> will make them "
25357 #: ../src/guestfs-actions.pod:4134
25358 msgid "Use C<guestfs_list_dm_devices> to list all device mapper devices."
25362 #: ../src/guestfs-actions.pod:4145
25363 msgid "guestfs_luks_open_ro"
25367 #: ../src/guestfs-actions.pod:4147
25371 " guestfs_luks_open_ro (guestfs_h *g,\n"
25372 " const char *device,\n"
25373 " const char *key,\n"
25374 " const char *mapname);\n"
25379 #: ../src/guestfs-actions.pod:4153
25381 "This is the same as C<guestfs_luks_open> except that a read-only mapping is "
25386 #: ../src/guestfs-actions.pod:4164
25387 msgid "guestfs_lvcreate"
25391 #: ../src/guestfs-actions.pod:4166
25395 " guestfs_lvcreate (guestfs_h *g,\n"
25396 " const char *logvol,\n"
25397 " const char *volgroup,\n"
25403 #: ../src/guestfs-actions.pod:4179
25404 msgid "guestfs_lvm_canonical_lv_name"
25408 #: ../src/guestfs-actions.pod:4181
25412 " guestfs_lvm_canonical_lv_name (guestfs_h *g,\n"
25413 " const char *lvname);\n"
25418 #: ../src/guestfs-actions.pod:4192
25419 msgid "See also C<guestfs_is_lv>."
25423 #: ../src/guestfs-actions.pod:4197
25424 msgid "(Added in 1.5.24)"
25428 #: ../src/guestfs-actions.pod:4199
25429 msgid "guestfs_lvm_clear_filter"
25433 #: ../src/guestfs-actions.pod:4201
25437 " guestfs_lvm_clear_filter (guestfs_h *g);\n"
25442 #: ../src/guestfs-actions.pod:4204
25444 "This undoes the effect of C<guestfs_lvm_set_filter>. LVM will be able to "
25445 "see every block device."
25449 #: ../src/guestfs-actions.pod:4214
25450 msgid "guestfs_lvm_remove_all"
25454 #: ../src/guestfs-actions.pod:4216
25458 " guestfs_lvm_remove_all (guestfs_h *g);\n"
25463 #: ../src/guestfs-actions.pod:4229
25464 msgid "guestfs_lvm_set_filter"
25468 #: ../src/guestfs-actions.pod:4231
25472 " guestfs_lvm_set_filter (guestfs_h *g,\n"
25473 " char *const *devices);\n"
25478 #: ../src/guestfs-actions.pod:4262
25479 msgid "guestfs_lvremove"
25483 #: ../src/guestfs-actions.pod:4264
25487 " guestfs_lvremove (guestfs_h *g,\n"
25488 " const char *device);\n"
25493 #: ../src/guestfs-actions.pod:4276 ../src/guestfs-actions.pod:5679 ../src/guestfs-actions.pod:7513
25494 msgid "(Added in 1.0.13)"
25498 #: ../src/guestfs-actions.pod:4278
25499 msgid "guestfs_lvrename"
25503 #: ../src/guestfs-actions.pod:4280
25507 " guestfs_lvrename (guestfs_h *g,\n"
25508 " const char *logvol,\n"
25509 " const char *newlogvol);\n"
25514 #: ../src/guestfs-actions.pod:4289 ../src/guestfs-actions.pod:7526
25515 msgid "(Added in 1.0.83)"
25519 #: ../src/guestfs-actions.pod:4291
25520 msgid "guestfs_lvresize"
25524 #: ../src/guestfs-actions.pod:4293
25528 " guestfs_lvresize (guestfs_h *g,\n"
25529 " const char *device,\n"
25535 #: ../src/guestfs-actions.pod:4306
25536 msgid "guestfs_lvresize_free"
25540 #: ../src/guestfs-actions.pod:4308
25544 " guestfs_lvresize_free (guestfs_h *g,\n"
25545 " const char *lv,\n"
25551 #: ../src/guestfs-actions.pod:4321
25552 msgid "(Added in 1.3.3)"
25556 #: ../src/guestfs-actions.pod:4323
25557 msgid "guestfs_lvs"
25561 #: ../src/guestfs-actions.pod:4325
25565 " guestfs_lvs (guestfs_h *g);\n"
25570 #: ../src/guestfs-actions.pod:4334
25571 msgid "See also C<guestfs_lvs_full>, C<guestfs_list_filesystems>."
25575 #: ../src/guestfs-actions.pod:4342
25576 msgid "guestfs_lvs_full"
25580 #: ../src/guestfs-actions.pod:4344
25583 " struct guestfs_lvm_lv_list *\n"
25584 " guestfs_lvs_full (guestfs_h *g);\n"
25589 #: ../src/guestfs-actions.pod:4350
25591 "This function returns a C<struct guestfs_lvm_lv_list *>, or NULL if there "
25592 "was an error. I<The caller must call C<guestfs_free_lvm_lv_list> after "
25597 #: ../src/guestfs-actions.pod:4356
25598 msgid "guestfs_lvuuid"
25602 #: ../src/guestfs-actions.pod:4358
25606 " guestfs_lvuuid (guestfs_h *g,\n"
25607 " const char *device);\n"
25612 #: ../src/guestfs-actions.pod:4369
25613 msgid "guestfs_lxattrlist"
25617 #: ../src/guestfs-actions.pod:4371
25620 " struct guestfs_xattr_list *\n"
25621 " guestfs_lxattrlist (guestfs_h *g,\n"
25622 " const char *path,\n"
25623 " char *const *names);\n"
25628 #: ../src/guestfs-actions.pod:4390
25630 "This call is intended for programs that want to efficiently list a directory "
25631 "contents without making many round-trips. See also C<guestfs_lstatlist> for "
25632 "a similarly efficient call for getting standard stats. Very long directory "
25633 "listings might cause the protocol message size to be exceeded, causing this "
25634 "call to fail. The caller must split up such requests into smaller groups of "
25639 #: ../src/guestfs-actions.pod:4404
25640 msgid "guestfs_mkdir"
25644 #: ../src/guestfs-actions.pod:4406
25648 " guestfs_mkdir (guestfs_h *g,\n"
25649 " const char *path);\n"
25654 #: ../src/guestfs-actions.pod:4416
25655 msgid "guestfs_mkdir_mode"
25659 #: ../src/guestfs-actions.pod:4418
25663 " guestfs_mkdir_mode (guestfs_h *g,\n"
25664 " const char *path,\n"
25670 #: ../src/guestfs-actions.pod:4430
25671 msgid "See also C<guestfs_mkdir>, C<guestfs_umask>"
25675 #: ../src/guestfs-actions.pod:4436
25676 msgid "guestfs_mkdir_p"
25680 #: ../src/guestfs-actions.pod:4438
25684 " guestfs_mkdir_p (guestfs_h *g,\n"
25685 " const char *path);\n"
25690 #: ../src/guestfs-actions.pod:4449
25691 msgid "guestfs_mkdtemp"
25695 #: ../src/guestfs-actions.pod:4451
25699 " guestfs_mkdtemp (guestfs_h *g,\n"
25700 " const char *template);\n"
25705 #: ../src/guestfs-actions.pod:4479
25706 msgid "guestfs_mke2fs_J"
25710 #: ../src/guestfs-actions.pod:4481
25714 " guestfs_mke2fs_J (guestfs_h *g,\n"
25715 " const char *fstype,\n"
25716 " int blocksize,\n"
25717 " const char *device,\n"
25718 " const char *journal);\n"
25723 #: ../src/guestfs-actions.pod:4494
25724 msgid "See also C<guestfs_mke2journal>."
25728 #: ../src/guestfs-actions.pod:4498 ../src/guestfs-actions.pod:4516 ../src/guestfs-actions.pod:4534 ../src/guestfs-actions.pod:4550 ../src/guestfs-actions.pod:4564 ../src/guestfs-actions.pod:4578 ../src/guestfs-actions.pod:4637 ../src/guestfs-actions.pod:4914
25729 msgid "(Added in 1.0.68)"
25733 #: ../src/guestfs-actions.pod:4500
25734 msgid "guestfs_mke2fs_JL"
25738 #: ../src/guestfs-actions.pod:4502
25742 " guestfs_mke2fs_JL (guestfs_h *g,\n"
25743 " const char *fstype,\n"
25744 " int blocksize,\n"
25745 " const char *device,\n"
25746 " const char *label);\n"
25751 #: ../src/guestfs-actions.pod:4512
25752 msgid "See also C<guestfs_mke2journal_L>."
25756 #: ../src/guestfs-actions.pod:4518
25757 msgid "guestfs_mke2fs_JU"
25761 #: ../src/guestfs-actions.pod:4520
25765 " guestfs_mke2fs_JU (guestfs_h *g,\n"
25766 " const char *fstype,\n"
25767 " int blocksize,\n"
25768 " const char *device,\n"
25769 " const char *uuid);\n"
25774 #: ../src/guestfs-actions.pod:4530
25775 msgid "See also C<guestfs_mke2journal_U>."
25779 #: ../src/guestfs-actions.pod:4536
25780 msgid "guestfs_mke2journal"
25784 #: ../src/guestfs-actions.pod:4538
25788 " guestfs_mke2journal (guestfs_h *g,\n"
25789 " int blocksize,\n"
25790 " const char *device);\n"
25795 #: ../src/guestfs-actions.pod:4552
25796 msgid "guestfs_mke2journal_L"
25800 #: ../src/guestfs-actions.pod:4554
25804 " guestfs_mke2journal_L (guestfs_h *g,\n"
25805 " int blocksize,\n"
25806 " const char *label,\n"
25807 " const char *device);\n"
25812 #: ../src/guestfs-actions.pod:4566
25813 msgid "guestfs_mke2journal_U"
25817 #: ../src/guestfs-actions.pod:4568
25821 " guestfs_mke2journal_U (guestfs_h *g,\n"
25822 " int blocksize,\n"
25823 " const char *uuid,\n"
25824 " const char *device);\n"
25829 #: ../src/guestfs-actions.pod:4580
25830 msgid "guestfs_mkfifo"
25834 #: ../src/guestfs-actions.pod:4582
25838 " guestfs_mkfifo (guestfs_h *g,\n"
25840 " const char *path);\n"
25845 #: ../src/guestfs-actions.pod:4587
25847 "This call creates a FIFO (named pipe) called C<path> with mode C<mode>. It "
25848 "is just a convenient wrapper around C<guestfs_mknod>."
25852 #: ../src/guestfs-actions.pod:4597
25853 msgid "guestfs_mkfs"
25857 #: ../src/guestfs-actions.pod:4599
25861 " guestfs_mkfs (guestfs_h *g,\n"
25862 " const char *fstype,\n"
25863 " const char *device);\n"
25868 #: ../src/guestfs-actions.pod:4612
25869 msgid "guestfs_mkfs_b"
25873 #: ../src/guestfs-actions.pod:4614
25877 " guestfs_mkfs_b (guestfs_h *g,\n"
25878 " const char *fstype,\n"
25879 " int blocksize,\n"
25880 " const char *device);\n"
25885 #: ../src/guestfs-actions.pod:4620
25887 "This call is similar to C<guestfs_mkfs>, but it allows you to control the "
25888 "block size of the resulting filesystem. Supported block sizes depend on the "
25889 "filesystem type, but typically they are C<1024>, C<2048> or C<4096> only."
25893 #: ../src/guestfs-actions.pod:4630
25895 "This function is deprecated. In new code, use the L</guestfs_mkfs_opts> "
25900 #: ../src/guestfs-actions.pod:4639
25901 msgid "guestfs_mkfs_opts"
25905 #: ../src/guestfs-actions.pod:4641
25909 " guestfs_mkfs_opts (guestfs_h *g,\n"
25910 " const char *fstype,\n"
25911 " const char *device,\n"
25917 #: ../src/guestfs-actions.pod:4652
25920 " GUESTFS_MKFS_OPTS_BLOCKSIZE, int blocksize,\n"
25921 " GUESTFS_MKFS_OPTS_FEATURES, const char *features,\n"
25922 " GUESTFS_MKFS_OPTS_INODE, int inode,\n"
25923 " GUESTFS_MKFS_OPTS_SECTORSIZE, int sectorsize,\n"
25928 #: ../src/guestfs-actions.pod:4700
25929 msgid "(Added in 1.7.19)"
25933 #: ../src/guestfs-actions.pod:4702
25934 msgid "guestfs_mkfs_opts_va"
25938 #: ../src/guestfs-actions.pod:4704
25942 " guestfs_mkfs_opts_va (guestfs_h *g,\n"
25943 " const char *fstype,\n"
25944 " const char *device,\n"
25945 " va_list args);\n"
25950 #: ../src/guestfs-actions.pod:4710
25951 msgid "This is the \"va_list variant\" of L</guestfs_mkfs_opts>."
25955 #: ../src/guestfs-actions.pod:4714
25956 msgid "guestfs_mkfs_opts_argv"
25960 #: ../src/guestfs-actions.pod:4716
25964 " guestfs_mkfs_opts_argv (guestfs_h *g,\n"
25965 " const char *fstype,\n"
25966 " const char *device,\n"
25967 " const struct guestfs_mkfs_opts_argv *optargs);\n"
25972 #: ../src/guestfs-actions.pod:4722
25973 msgid "This is the \"argv variant\" of L</guestfs_mkfs_opts>."
25977 #: ../src/guestfs-actions.pod:4726
25978 msgid "guestfs_mkmountpoint"
25982 #: ../src/guestfs-actions.pod:4728
25986 " guestfs_mkmountpoint (guestfs_h *g,\n"
25987 " const char *exemptpath);\n"
25992 #: ../src/guestfs-actions.pod:4732
25994 "C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are specialized calls "
25995 "that can be used to create extra mountpoints before mounting the first "
26000 #: ../src/guestfs-actions.pod:4756
26002 "C<guestfs_mkmountpoint> is not compatible with C<guestfs_umount_all>. You "
26003 "may get unexpected errors if you try to mix these calls. It is safest to "
26004 "manually unmount filesystems and remove mountpoints after use."
26008 #: ../src/guestfs-actions.pod:4760
26010 "C<guestfs_umount_all> unmounts filesystems by sorting the paths longest "
26011 "first, so for this to work for manual mountpoints, you must ensure that the "
26012 "innermost mountpoints have the longest pathnames, as in the example code "
26017 #: ../src/guestfs-actions.pod:4767
26019 "Autosync [see C<guestfs_set_autosync>, this is set by default on handles] "
26020 "can cause C<guestfs_umount_all> to be called when the handle is closed which "
26021 "can also trigger these issues."
26025 #: ../src/guestfs-actions.pod:4773 ../src/guestfs-actions.pod:5089 ../src/guestfs-actions.pod:6099
26026 msgid "(Added in 1.0.62)"
26030 #: ../src/guestfs-actions.pod:4775
26031 msgid "guestfs_mknod"
26035 #: ../src/guestfs-actions.pod:4777
26039 " guestfs_mknod (guestfs_h *g,\n"
26043 " const char *path);\n"
26048 #: ../src/guestfs-actions.pod:4792
26050 "Note that, just like L<mknod(2)>, the mode must be bitwise OR'd with "
26051 "S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call just creates a "
26052 "regular file). These constants are available in the standard Linux header "
26053 "files, or you can use C<guestfs_mknod_b>, C<guestfs_mknod_c> or "
26054 "C<guestfs_mkfifo> which are wrappers around this command which bitwise OR in "
26055 "the appropriate constant for you."
26059 #: ../src/guestfs-actions.pod:4806
26060 msgid "guestfs_mknod_b"
26064 #: ../src/guestfs-actions.pod:4808
26068 " guestfs_mknod_b (guestfs_h *g,\n"
26072 " const char *path);\n"
26077 #: ../src/guestfs-actions.pod:4815
26079 "This call creates a block device node called C<path> with mode C<mode> and "
26080 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26081 "wrapper around C<guestfs_mknod>."
26085 #: ../src/guestfs-actions.pod:4825
26086 msgid "guestfs_mknod_c"
26090 #: ../src/guestfs-actions.pod:4827
26094 " guestfs_mknod_c (guestfs_h *g,\n"
26098 " const char *path);\n"
26103 #: ../src/guestfs-actions.pod:4834
26105 "This call creates a char device node called C<path> with mode C<mode> and "
26106 "device major/minor C<devmajor> and C<devminor>. It is just a convenient "
26107 "wrapper around C<guestfs_mknod>."
26111 #: ../src/guestfs-actions.pod:4844
26112 msgid "guestfs_mkswap"
26116 #: ../src/guestfs-actions.pod:4846
26120 " guestfs_mkswap (guestfs_h *g,\n"
26121 " const char *device);\n"
26126 #: ../src/guestfs-actions.pod:4856
26127 msgid "guestfs_mkswap_L"
26131 #: ../src/guestfs-actions.pod:4858
26135 " guestfs_mkswap_L (guestfs_h *g,\n"
26136 " const char *label,\n"
26137 " const char *device);\n"
26142 #: ../src/guestfs-actions.pod:4873
26143 msgid "guestfs_mkswap_U"
26147 #: ../src/guestfs-actions.pod:4875
26151 " guestfs_mkswap_U (guestfs_h *g,\n"
26152 " const char *uuid,\n"
26153 " const char *device);\n"
26158 #: ../src/guestfs-actions.pod:4886
26159 msgid "guestfs_mkswap_file"
26163 #: ../src/guestfs-actions.pod:4888
26167 " guestfs_mkswap_file (guestfs_h *g,\n"
26168 " const char *path);\n"
26173 #: ../src/guestfs-actions.pod:4894
26175 "This command just writes a swap file signature to an existing file. To "
26176 "create the file itself, use something like C<guestfs_fallocate>."
26180 #: ../src/guestfs-actions.pod:4901
26181 msgid "guestfs_modprobe"
26185 #: ../src/guestfs-actions.pod:4903
26189 " guestfs_modprobe (guestfs_h *g,\n"
26190 " const char *modulename);\n"
26195 #: ../src/guestfs-actions.pod:4916
26196 msgid "guestfs_mount"
26200 #: ../src/guestfs-actions.pod:4918
26204 " guestfs_mount (guestfs_h *g,\n"
26205 " const char *device,\n"
26206 " const char *mountpoint);\n"
26211 #: ../src/guestfs-actions.pod:4937
26213 "B<Important note:> When you use this call, the filesystem options C<sync> "
26214 "and C<noatime> are set implicitly. This was originally done because we "
26215 "thought it would improve reliability, but it turns out that I<-o sync> has a "
26216 "very large negative performance impact and negligible effect on "
26217 "reliability. Therefore we recommend that you avoid using C<guestfs_mount> "
26218 "in any code that needs performance, and instead use C<guestfs_mount_options> "
26219 "(use an empty string for the first parameter if you don't want any options)."
26223 #: ../src/guestfs-actions.pod:4949
26225 "This function is deprecated. In new code, use the L</guestfs_mount_options> "
26230 #: ../src/guestfs-actions.pod:4958
26231 msgid "guestfs_mount_9p"
26235 #: ../src/guestfs-actions.pod:4960
26239 " guestfs_mount_9p (guestfs_h *g,\n"
26240 " const char *mounttag,\n"
26241 " const char *mountpoint,\n"
26247 #: ../src/guestfs-actions.pod:4971
26250 " GUESTFS_MOUNT_9P_OPTIONS, const char *options,\n"
26255 #: ../src/guestfs-actions.pod:4984
26256 msgid "guestfs_mount_9p_va"
26260 #: ../src/guestfs-actions.pod:4986
26264 " guestfs_mount_9p_va (guestfs_h *g,\n"
26265 " const char *mounttag,\n"
26266 " const char *mountpoint,\n"
26267 " va_list args);\n"
26272 #: ../src/guestfs-actions.pod:4992
26273 msgid "This is the \"va_list variant\" of L</guestfs_mount_9p>."
26277 #: ../src/guestfs-actions.pod:4996
26278 msgid "guestfs_mount_9p_argv"
26282 #: ../src/guestfs-actions.pod:4998
26286 " guestfs_mount_9p_argv (guestfs_h *g,\n"
26287 " const char *mounttag,\n"
26288 " const char *mountpoint,\n"
26289 " const struct guestfs_mount_9p_argv *optargs);\n"
26294 #: ../src/guestfs-actions.pod:5004
26295 msgid "This is the \"argv variant\" of L</guestfs_mount_9p>."
26299 #: ../src/guestfs-actions.pod:5008
26300 msgid "guestfs_mount_loop"
26304 #: ../src/guestfs-actions.pod:5010
26308 " guestfs_mount_loop (guestfs_h *g,\n"
26309 " const char *file,\n"
26310 " const char *mountpoint);\n"
26315 #: ../src/guestfs-actions.pod:5023
26316 msgid "guestfs_mount_options"
26320 #: ../src/guestfs-actions.pod:5025
26324 " guestfs_mount_options (guestfs_h *g,\n"
26325 " const char *options,\n"
26326 " const char *device,\n"
26327 " const char *mountpoint);\n"
26332 #: ../src/guestfs-actions.pod:5031
26334 "This is the same as the C<guestfs_mount> command, but it allows you to set "
26335 "the mount options as for the L<mount(8)> I<-o> flag."
26339 #: ../src/guestfs-actions.pod:5041 ../src/guestfs-actions.pod:5055 ../src/guestfs-actions.pod:5072
26340 msgid "(Added in 1.0.10)"
26344 #: ../src/guestfs-actions.pod:5043
26345 msgid "guestfs_mount_ro"
26349 #: ../src/guestfs-actions.pod:5045
26353 " guestfs_mount_ro (guestfs_h *g,\n"
26354 " const char *device,\n"
26355 " const char *mountpoint);\n"
26360 #: ../src/guestfs-actions.pod:5050
26362 "This is the same as the C<guestfs_mount> command, but it mounts the "
26363 "filesystem with the read-only (I<-o ro>) flag."
26367 #: ../src/guestfs-actions.pod:5057
26368 msgid "guestfs_mount_vfs"
26372 #: ../src/guestfs-actions.pod:5059
26376 " guestfs_mount_vfs (guestfs_h *g,\n"
26377 " const char *options,\n"
26378 " const char *vfstype,\n"
26379 " const char *device,\n"
26380 " const char *mountpoint);\n"
26385 #: ../src/guestfs-actions.pod:5066
26387 "This is the same as the C<guestfs_mount> command, but it allows you to set "
26388 "both the mount options and the vfstype as for the L<mount(8)> I<-o> and "
26393 #: ../src/guestfs-actions.pod:5074
26394 msgid "guestfs_mountpoints"
26398 #: ../src/guestfs-actions.pod:5076
26402 " guestfs_mountpoints (guestfs_h *g);\n"
26407 #: ../src/guestfs-actions.pod:5079
26409 "This call is similar to C<guestfs_mounts>. That call returns a list of "
26410 "devices. This one returns a hash table (map) of device name to directory "
26411 "where the device is mounted."
26415 #: ../src/guestfs-actions.pod:5091
26416 msgid "guestfs_mounts"
26420 #: ../src/guestfs-actions.pod:5093
26424 " guestfs_mounts (guestfs_h *g);\n"
26429 #: ../src/guestfs-actions.pod:5101
26430 msgid "See also: C<guestfs_mountpoints>"
26434 #: ../src/guestfs-actions.pod:5109
26439 #: ../src/guestfs-actions.pod:5111
26443 " guestfs_mv (guestfs_h *g,\n"
26444 " const char *src,\n"
26445 " const char *dest);\n"
26450 #: ../src/guestfs-actions.pod:5123
26451 msgid "guestfs_ntfs_3g_probe"
26455 #: ../src/guestfs-actions.pod:5125
26459 " guestfs_ntfs_3g_probe (guestfs_h *g,\n"
26461 " const char *device);\n"
26466 #: ../src/guestfs-actions.pod:5144
26467 msgid "(Added in 1.0.43)"
26471 #: ../src/guestfs-actions.pod:5146
26472 msgid "guestfs_ntfsresize"
26476 #: ../src/guestfs-actions.pod:5148
26480 " guestfs_ntfsresize (guestfs_h *g,\n"
26481 " const char *device);\n"
26486 #: ../src/guestfs-actions.pod:5167 ../src/guestfs-actions.pod:5257
26488 "This function is deprecated. In new code, use the "
26489 "L</guestfs_ntfsresize_opts> call instead."
26493 #: ../src/guestfs-actions.pod:5176
26494 msgid "guestfs_ntfsresize_opts"
26498 #: ../src/guestfs-actions.pod:5178
26502 " guestfs_ntfsresize_opts (guestfs_h *g,\n"
26503 " const char *device,\n"
26509 #: ../src/guestfs-actions.pod:5188
26512 " GUESTFS_NTFSRESIZE_OPTS_SIZE, int64_t size,\n"
26513 " GUESTFS_NTFSRESIZE_OPTS_FORCE, int force,\n"
26518 #: ../src/guestfs-actions.pod:5208
26520 "After the resize operation, the filesystem is always marked as requiring a "
26521 "consistency check (for safety). You have to boot into Windows to perform "
26522 "this check and clear this condition. If you I<don't> set the C<force> "
26523 "option then it is not possible to call C<guestfs_ntfsresize_opts> multiple "
26524 "times on a single filesystem without booting into Windows between each "
26529 #: ../src/guestfs-actions.pod:5223
26530 msgid "guestfs_ntfsresize_opts_va"
26534 #: ../src/guestfs-actions.pod:5225
26538 " guestfs_ntfsresize_opts_va (guestfs_h *g,\n"
26539 " const char *device,\n"
26540 " va_list args);\n"
26545 #: ../src/guestfs-actions.pod:5230
26546 msgid "This is the \"va_list variant\" of L</guestfs_ntfsresize_opts>."
26550 #: ../src/guestfs-actions.pod:5234
26551 msgid "guestfs_ntfsresize_opts_argv"
26555 #: ../src/guestfs-actions.pod:5236
26559 " guestfs_ntfsresize_opts_argv (guestfs_h *g,\n"
26560 " const char *device,\n"
26561 " const struct guestfs_ntfsresize_opts_argv "
26567 #: ../src/guestfs-actions.pod:5241
26568 msgid "This is the \"argv variant\" of L</guestfs_ntfsresize_opts>."
26572 #: ../src/guestfs-actions.pod:5245
26573 msgid "guestfs_ntfsresize_size"
26577 #: ../src/guestfs-actions.pod:5247
26581 " guestfs_ntfsresize_size (guestfs_h *g,\n"
26582 " const char *device,\n"
26583 " int64_t size);\n"
26588 #: ../src/guestfs-actions.pod:5252
26590 "This command is the same as C<guestfs_ntfsresize> except that it allows you "
26591 "to specify the new size (in bytes) explicitly."
26595 #: ../src/guestfs-actions.pod:5264 ../src/guestfs-actions.pod:5706 ../src/guestfs-actions.pod:5779 ../src/guestfs-actions.pod:6047 ../src/guestfs-actions.pod:7670
26596 msgid "(Added in 1.3.14)"
26600 #: ../src/guestfs-actions.pod:5266
26601 msgid "guestfs_part_add"
26605 #: ../src/guestfs-actions.pod:5268
26609 " guestfs_part_add (guestfs_h *g,\n"
26610 " const char *device,\n"
26611 " const char *prlogex,\n"
26612 " int64_t startsect,\n"
26613 " int64_t endsect);\n"
26618 #: ../src/guestfs-actions.pod:5275
26620 "This command adds a partition to C<device>. If there is no partition table "
26621 "on the device, call C<guestfs_part_init> first."
26625 #: ../src/guestfs-actions.pod:5287
26627 "Creating a partition which covers the whole disk is not so easy. Use "
26628 "C<guestfs_part_disk> to do that."
26632 #: ../src/guestfs-actions.pod:5292 ../src/guestfs-actions.pod:5330 ../src/guestfs-actions.pod:5383 ../src/guestfs-actions.pod:5467 ../src/guestfs-actions.pod:5505 ../src/guestfs-actions.pod:5524 ../src/guestfs-actions.pod:5564
26633 msgid "(Added in 1.0.78)"
26637 #: ../src/guestfs-actions.pod:5294
26638 msgid "guestfs_part_del"
26642 #: ../src/guestfs-actions.pod:5296
26646 " guestfs_part_del (guestfs_h *g,\n"
26647 " const char *device,\n"
26653 #: ../src/guestfs-actions.pod:5311
26654 msgid "guestfs_part_disk"
26658 #: ../src/guestfs-actions.pod:5313
26662 " guestfs_part_disk (guestfs_h *g,\n"
26663 " const char *device,\n"
26664 " const char *parttype);\n"
26669 #: ../src/guestfs-actions.pod:5318
26671 "This command is simply a combination of C<guestfs_part_init> followed by "
26672 "C<guestfs_part_add> to create a single primary partition covering the whole "
26677 #: ../src/guestfs-actions.pod:5322
26679 "C<parttype> is the partition table type, usually C<mbr> or C<gpt>, but other "
26680 "possible values are described in C<guestfs_part_init>."
26684 #: ../src/guestfs-actions.pod:5332
26685 msgid "guestfs_part_get_bootable"
26689 #: ../src/guestfs-actions.pod:5334
26693 " guestfs_part_get_bootable (guestfs_h *g,\n"
26694 " const char *device,\n"
26700 #: ../src/guestfs-actions.pod:5342
26701 msgid "See also C<guestfs_part_set_bootable>."
26705 #: ../src/guestfs-actions.pod:5348
26706 msgid "guestfs_part_get_mbr_id"
26710 #: ../src/guestfs-actions.pod:5350
26714 " guestfs_part_get_mbr_id (guestfs_h *g,\n"
26715 " const char *device,\n"
26721 #: ../src/guestfs-actions.pod:5358 ../src/guestfs-actions.pod:5540
26723 "Note that only MBR (old DOS-style) partitions have type bytes. You will get "
26724 "undefined results for other partition table types (see "
26725 "C<guestfs_part_get_parttype>)."
26729 #: ../src/guestfs-actions.pod:5366
26730 msgid "guestfs_part_get_parttype"
26734 #: ../src/guestfs-actions.pod:5368
26738 " guestfs_part_get_parttype (guestfs_h *g,\n"
26739 " const char *device);\n"
26744 #: ../src/guestfs-actions.pod:5375
26746 "Common return values include: C<msdos> (a DOS/Windows style MBR partition "
26747 "table), C<gpt> (a GPT/EFI-style partition table). Other values are "
26748 "possible, although unusual. See C<guestfs_part_init> for a full list."
26752 #: ../src/guestfs-actions.pod:5385
26753 msgid "guestfs_part_init"
26757 #: ../src/guestfs-actions.pod:5387
26761 " guestfs_part_init (guestfs_h *g,\n"
26762 " const char *device,\n"
26763 " const char *parttype);\n"
26768 #: ../src/guestfs-actions.pod:5396
26770 "Initially there are no partitions. Following this, you should call "
26771 "C<guestfs_part_add> for each partition required."
26775 #: ../src/guestfs-actions.pod:5469
26776 msgid "guestfs_part_list"
26780 #: ../src/guestfs-actions.pod:5471
26783 " struct guestfs_partition_list *\n"
26784 " guestfs_part_list (guestfs_h *g,\n"
26785 " const char *device);\n"
26790 #: ../src/guestfs-actions.pod:5488
26792 "Start of the partition I<in bytes>. To get sectors you have to divide by "
26793 "the device's sector size, see C<guestfs_blockdev_getss>."
26797 #: ../src/guestfs-actions.pod:5501
26799 "This function returns a C<struct guestfs_partition_list *>, or NULL if there "
26800 "was an error. I<The caller must call C<guestfs_free_partition_list> after "
26805 #: ../src/guestfs-actions.pod:5507
26806 msgid "guestfs_part_set_bootable"
26810 #: ../src/guestfs-actions.pod:5509
26814 " guestfs_part_set_bootable (guestfs_h *g,\n"
26815 " const char *device,\n"
26817 " int bootable);\n"
26822 #: ../src/guestfs-actions.pod:5526
26823 msgid "guestfs_part_set_mbr_id"
26827 #: ../src/guestfs-actions.pod:5528
26831 " guestfs_part_set_mbr_id (guestfs_h *g,\n"
26832 " const char *device,\n"
26839 #: ../src/guestfs-actions.pod:5548
26840 msgid "guestfs_part_set_name"
26844 #: ../src/guestfs-actions.pod:5550
26848 " guestfs_part_set_name (guestfs_h *g,\n"
26849 " const char *device,\n"
26851 " const char *name);\n"
26856 #: ../src/guestfs-actions.pod:5566
26857 msgid "guestfs_part_to_dev"
26861 #: ../src/guestfs-actions.pod:5568
26865 " guestfs_part_to_dev (guestfs_h *g,\n"
26866 " const char *partition);\n"
26871 #: ../src/guestfs-actions.pod:5576
26873 "The named partition must exist, for example as a string returned from "
26874 "C<guestfs_list_partitions>."
26878 #: ../src/guestfs-actions.pod:5584
26879 msgid "guestfs_ping_daemon"
26883 #: ../src/guestfs-actions.pod:5586
26887 " guestfs_ping_daemon (guestfs_h *g);\n"
26892 #: ../src/guestfs-actions.pod:5598
26893 msgid "guestfs_pread"
26897 #: ../src/guestfs-actions.pod:5600
26901 " guestfs_pread (guestfs_h *g,\n"
26902 " const char *path,\n"
26904 " int64_t offset,\n"
26905 " size_t *size_r);\n"
26910 #: ../src/guestfs-actions.pod:5613
26911 msgid "See also C<guestfs_pwrite>, C<guestfs_pread_device>."
26915 #: ../src/guestfs-actions.pod:5624
26916 msgid "guestfs_pread_device"
26920 #: ../src/guestfs-actions.pod:5626
26924 " guestfs_pread_device (guestfs_h *g,\n"
26925 " const char *device,\n"
26927 " int64_t offset,\n"
26928 " size_t *size_r);\n"
26933 #: ../src/guestfs-actions.pod:5639
26934 msgid "See also C<guestfs_pread>."
26938 #: ../src/guestfs-actions.pod:5648
26939 msgid "(Added in 1.5.21)"
26943 #: ../src/guestfs-actions.pod:5650
26944 msgid "guestfs_pvcreate"
26948 #: ../src/guestfs-actions.pod:5652
26952 " guestfs_pvcreate (guestfs_h *g,\n"
26953 " const char *device);\n"
26958 #: ../src/guestfs-actions.pod:5664
26959 msgid "guestfs_pvremove"
26963 #: ../src/guestfs-actions.pod:5666
26967 " guestfs_pvremove (guestfs_h *g,\n"
26968 " const char *device);\n"
26973 #: ../src/guestfs-actions.pod:5681
26974 msgid "guestfs_pvresize"
26978 #: ../src/guestfs-actions.pod:5683
26982 " guestfs_pvresize (guestfs_h *g,\n"
26983 " const char *device);\n"
26988 #: ../src/guestfs-actions.pod:5694
26989 msgid "guestfs_pvresize_size"
26993 #: ../src/guestfs-actions.pod:5696
26997 " guestfs_pvresize_size (guestfs_h *g,\n"
26998 " const char *device,\n"
26999 " int64_t size);\n"
27004 #: ../src/guestfs-actions.pod:5701
27006 "This command is the same as C<guestfs_pvresize> except that it allows you to "
27007 "specify the new size (in bytes) explicitly."
27011 #: ../src/guestfs-actions.pod:5708
27012 msgid "guestfs_pvs"
27016 #: ../src/guestfs-actions.pod:5710
27020 " guestfs_pvs (guestfs_h *g);\n"
27025 #: ../src/guestfs-actions.pod:5719
27026 msgid "See also C<guestfs_pvs_full>."
27030 #: ../src/guestfs-actions.pod:5727
27031 msgid "guestfs_pvs_full"
27035 #: ../src/guestfs-actions.pod:5729
27038 " struct guestfs_lvm_pv_list *\n"
27039 " guestfs_pvs_full (guestfs_h *g);\n"
27044 #: ../src/guestfs-actions.pod:5735
27046 "This function returns a C<struct guestfs_lvm_pv_list *>, or NULL if there "
27047 "was an error. I<The caller must call C<guestfs_free_lvm_pv_list> after "
27052 #: ../src/guestfs-actions.pod:5741
27053 msgid "guestfs_pvuuid"
27057 #: ../src/guestfs-actions.pod:5743
27061 " guestfs_pvuuid (guestfs_h *g,\n"
27062 " const char *device);\n"
27067 #: ../src/guestfs-actions.pod:5754
27068 msgid "guestfs_pwrite"
27072 #: ../src/guestfs-actions.pod:5756
27076 " guestfs_pwrite (guestfs_h *g,\n"
27077 " const char *path,\n"
27078 " const char *content,\n"
27079 " size_t content_size,\n"
27080 " int64_t offset);\n"
27085 #: ../src/guestfs-actions.pod:5772
27086 msgid "See also C<guestfs_pread>, C<guestfs_pwrite_device>."
27090 #: ../src/guestfs-actions.pod:5781
27091 msgid "guestfs_pwrite_device"
27095 #: ../src/guestfs-actions.pod:5783
27099 " guestfs_pwrite_device (guestfs_h *g,\n"
27100 " const char *device,\n"
27101 " const char *content,\n"
27102 " size_t content_size,\n"
27103 " int64_t offset);\n"
27108 #: ../src/guestfs-actions.pod:5798
27109 msgid "See also C<guestfs_pwrite>."
27113 #: ../src/guestfs-actions.pod:5805
27114 msgid "(Added in 1.5.20)"
27118 #: ../src/guestfs-actions.pod:5807
27119 msgid "guestfs_read_file"
27123 #: ../src/guestfs-actions.pod:5809
27127 " guestfs_read_file (guestfs_h *g,\n"
27128 " const char *path,\n"
27129 " size_t *size_r);\n"
27134 #: ../src/guestfs-actions.pod:5817
27136 "Unlike C<guestfs_cat>, this function can correctly handle files that contain "
27137 "embedded ASCII NUL characters. However unlike C<guestfs_download>, this "
27138 "function is limited in the total size of file that can be handled."
27142 #: ../src/guestfs-actions.pod:5829
27143 msgid "(Added in 1.0.63)"
27147 #: ../src/guestfs-actions.pod:5831
27148 msgid "guestfs_read_lines"
27152 #: ../src/guestfs-actions.pod:5833
27156 " guestfs_read_lines (guestfs_h *g,\n"
27157 " const char *path);\n"
27162 #: ../src/guestfs-actions.pod:5842
27164 "Note that this function cannot correctly handle binary files (specifically, "
27165 "files containing C<\\0> character which is treated as end of line). For "
27166 "those you need to use the C<guestfs_read_file> function which has a more "
27167 "complex interface."
27171 #: ../src/guestfs-actions.pod:5853
27172 msgid "guestfs_readdir"
27176 #: ../src/guestfs-actions.pod:5855
27179 " struct guestfs_dirent_list *\n"
27180 " guestfs_readdir (guestfs_h *g,\n"
27181 " const char *dir);\n"
27186 #: ../src/guestfs-actions.pod:5909
27188 "This function is primarily intended for use by programs. To get a simple "
27189 "list of names, use C<guestfs_ls>. To get a printable directory for human "
27190 "consumption, use C<guestfs_ll>."
27194 #: ../src/guestfs-actions.pod:5913
27196 "This function returns a C<struct guestfs_dirent_list *>, or NULL if there "
27197 "was an error. I<The caller must call C<guestfs_free_dirent_list> after "
27202 #: ../src/guestfs-actions.pod:5919
27203 msgid "guestfs_readlink"
27207 #: ../src/guestfs-actions.pod:5921
27211 " guestfs_readlink (guestfs_h *g,\n"
27212 " const char *path);\n"
27217 #: ../src/guestfs-actions.pod:5932
27218 msgid "guestfs_readlinklist"
27222 #: ../src/guestfs-actions.pod:5934
27226 " guestfs_readlinklist (guestfs_h *g,\n"
27227 " const char *path,\n"
27228 " char *const *names);\n"
27233 #: ../src/guestfs-actions.pod:5967
27234 msgid "guestfs_realpath"
27238 #: ../src/guestfs-actions.pod:5969
27242 " guestfs_realpath (guestfs_h *g,\n"
27243 " const char *path);\n"
27248 #: ../src/guestfs-actions.pod:5981
27249 msgid "guestfs_removexattr"
27253 #: ../src/guestfs-actions.pod:5983
27257 " guestfs_removexattr (guestfs_h *g,\n"
27258 " const char *xattr,\n"
27259 " const char *path);\n"
27264 #: ../src/guestfs-actions.pod:5991
27265 msgid "See also: C<guestfs_lremovexattr>, L<attr(5)>."
27269 #: ../src/guestfs-actions.pod:5997
27270 msgid "guestfs_resize2fs"
27274 #: ../src/guestfs-actions.pod:5999
27278 " guestfs_resize2fs (guestfs_h *g,\n"
27279 " const char *device);\n"
27284 #: ../src/guestfs-actions.pod:6006
27286 "I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f> on the "
27287 "C<device> before calling this command. For unknown reasons C<resize2fs> "
27288 "sometimes gives an error about this and sometimes not. In any case, it is "
27289 "always safe to call C<guestfs_e2fsck_f> before calling this function."
27293 #: ../src/guestfs-actions.pod:6016
27294 msgid "guestfs_resize2fs_M"
27298 #: ../src/guestfs-actions.pod:6018
27302 " guestfs_resize2fs_M (guestfs_h *g,\n"
27303 " const char *device);\n"
27308 #: ../src/guestfs-actions.pod:6022
27310 "This command is the same as C<guestfs_resize2fs>, but the filesystem is "
27311 "resized to its minimum size. This works like the I<-M> option to the "
27312 "C<resize2fs> command."
27316 #: ../src/guestfs-actions.pod:6026
27318 "To get the resulting size of the filesystem you should call "
27319 "C<guestfs_tune2fs_l> and read the C<Block size> and C<Block count> values. "
27320 "These two numbers, multiplied together, give the resulting size of the "
27321 "minimal filesystem in bytes."
27325 #: ../src/guestfs-actions.pod:6035
27326 msgid "guestfs_resize2fs_size"
27330 #: ../src/guestfs-actions.pod:6037
27334 " guestfs_resize2fs_size (guestfs_h *g,\n"
27335 " const char *device,\n"
27336 " int64_t size);\n"
27341 #: ../src/guestfs-actions.pod:6042
27343 "This command is the same as C<guestfs_resize2fs> except that it allows you "
27344 "to specify the new size (in bytes) explicitly."
27348 #: ../src/guestfs-actions.pod:6049
27353 #: ../src/guestfs-actions.pod:6051
27357 " guestfs_rm (guestfs_h *g,\n"
27358 " const char *path);\n"
27363 #: ../src/guestfs-actions.pod:6061
27364 msgid "guestfs_rm_rf"
27368 #: ../src/guestfs-actions.pod:6063
27372 " guestfs_rm_rf (guestfs_h *g,\n"
27373 " const char *path);\n"
27378 #: ../src/guestfs-actions.pod:6075
27379 msgid "guestfs_rmdir"
27383 #: ../src/guestfs-actions.pod:6077
27387 " guestfs_rmdir (guestfs_h *g,\n"
27388 " const char *path);\n"
27393 #: ../src/guestfs-actions.pod:6087
27394 msgid "guestfs_rmmountpoint"
27398 #: ../src/guestfs-actions.pod:6089
27402 " guestfs_rmmountpoint (guestfs_h *g,\n"
27403 " const char *exemptpath);\n"
27408 #: ../src/guestfs-actions.pod:6093
27410 "This calls removes a mountpoint that was previously created with "
27411 "C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint> for full details."
27415 #: ../src/guestfs-actions.pod:6101
27416 msgid "guestfs_scrub_device"
27420 #: ../src/guestfs-actions.pod:6103
27424 " guestfs_scrub_device (guestfs_h *g,\n"
27425 " const char *device);\n"
27430 #: ../src/guestfs-actions.pod:6118 ../src/guestfs-actions.pod:6136 ../src/guestfs-actions.pod:6155
27431 msgid "(Added in 1.0.52)"
27435 #: ../src/guestfs-actions.pod:6120
27436 msgid "guestfs_scrub_file"
27440 #: ../src/guestfs-actions.pod:6122
27444 " guestfs_scrub_file (guestfs_h *g,\n"
27445 " const char *file);\n"
27450 #: ../src/guestfs-actions.pod:6138
27451 msgid "guestfs_scrub_freespace"
27455 #: ../src/guestfs-actions.pod:6140
27459 " guestfs_scrub_freespace (guestfs_h *g,\n"
27460 " const char *dir);\n"
27465 #: ../src/guestfs-actions.pod:6144
27467 "This command creates the directory C<dir> and then fills it with files until "
27468 "the filesystem is full, and scrubs the files as for C<guestfs_scrub_file>, "
27469 "and deletes them. The intention is to scrub any free space on the partition "
27470 "containing C<dir>."
27474 #: ../src/guestfs-actions.pod:6157
27475 msgid "guestfs_set_append"
27479 #: ../src/guestfs-actions.pod:6159
27483 " guestfs_set_append (guestfs_h *g,\n"
27484 " const char *append);\n"
27489 #: ../src/guestfs-actions.pod:6176
27490 msgid "guestfs_set_attach_method"
27494 #: ../src/guestfs-actions.pod:6178
27498 " guestfs_set_attach_method (guestfs_h *g,\n"
27499 " const char *attachmethod);\n"
27504 #: ../src/guestfs-actions.pod:6206
27505 msgid "guestfs_set_autosync"
27509 #: ../src/guestfs-actions.pod:6208
27513 " guestfs_set_autosync (guestfs_h *g,\n"
27514 " int autosync);\n"
27519 #: ../src/guestfs-actions.pod:6224
27520 msgid "guestfs_set_direct"
27524 #: ../src/guestfs-actions.pod:6226
27528 " guestfs_set_direct (guestfs_h *g,\n"
27534 #: ../src/guestfs-actions.pod:6234
27536 "One consequence of this is that log messages aren't caught by the library "
27537 "and handled by C<guestfs_set_log_message_callback>, but go straight to "
27542 #: ../src/guestfs-actions.pod:6247
27543 msgid "guestfs_set_e2label"
27547 #: ../src/guestfs-actions.pod:6249
27551 " guestfs_set_e2label (guestfs_h *g,\n"
27552 " const char *device,\n"
27553 " const char *label);\n"
27558 #: ../src/guestfs-actions.pod:6258
27560 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label> to return "
27561 "the existing label on a filesystem."
27565 #: ../src/guestfs-actions.pod:6265
27566 msgid "guestfs_set_e2uuid"
27570 #: ../src/guestfs-actions.pod:6267
27574 " guestfs_set_e2uuid (guestfs_h *g,\n"
27575 " const char *device,\n"
27576 " const char *uuid);\n"
27581 #: ../src/guestfs-actions.pod:6277
27583 "You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid> to return "
27584 "the existing UUID of a filesystem."
27588 #: ../src/guestfs-actions.pod:6284
27589 msgid "guestfs_set_memsize"
27593 #: ../src/guestfs-actions.pod:6286
27597 " guestfs_set_memsize (guestfs_h *g,\n"
27603 #: ../src/guestfs-actions.pod:6290
27605 "This sets the memory size in megabytes allocated to the qemu subprocess. "
27606 "This only has any effect if called before C<guestfs_launch>."
27610 #: ../src/guestfs-actions.pod:6305
27611 msgid "guestfs_set_network"
27615 #: ../src/guestfs-actions.pod:6307
27619 " guestfs_set_network (guestfs_h *g,\n"
27625 #: ../src/guestfs-actions.pod:6317
27627 "You must call this before calling C<guestfs_launch>, otherwise it has no "
27632 #: ../src/guestfs-actions.pod:6324
27633 msgid "guestfs_set_path"
27637 #: ../src/guestfs-actions.pod:6326
27641 " guestfs_set_path (guestfs_h *g,\n"
27642 " const char *searchpath);\n"
27647 #: ../src/guestfs-actions.pod:6341
27648 msgid "guestfs_set_pgroup"
27652 #: ../src/guestfs-actions.pod:6343
27656 " guestfs_set_pgroup (guestfs_h *g,\n"
27662 #: ../src/guestfs-actions.pod:6360
27663 msgid "guestfs_set_qemu"
27667 #: ../src/guestfs-actions.pod:6362
27671 " guestfs_set_qemu (guestfs_h *g,\n"
27672 " const char *qemu);\n"
27677 #: ../src/guestfs-actions.pod:6388
27678 msgid "guestfs_set_recovery_proc"
27682 #: ../src/guestfs-actions.pod:6390
27686 " guestfs_set_recovery_proc (guestfs_h *g,\n"
27687 " int recoveryproc);\n"
27692 #: ../src/guestfs-actions.pod:6394
27694 "If this is called with the parameter C<false> then C<guestfs_launch> does "
27695 "not create a recovery process. The purpose of the recovery process is to "
27696 "stop runaway qemu processes in the case where the main program aborts "
27701 #: ../src/guestfs-actions.pod:6399
27703 "This only has any effect if called before C<guestfs_launch>, and the default "
27708 #: ../src/guestfs-actions.pod:6412
27709 msgid "guestfs_set_selinux"
27713 #: ../src/guestfs-actions.pod:6414
27717 " guestfs_set_selinux (guestfs_h *g,\n"
27723 #: ../src/guestfs-actions.pod:6431
27724 msgid "guestfs_set_trace"
27728 #: ../src/guestfs-actions.pod:6433
27732 " guestfs_set_trace (guestfs_h *g,\n"
27738 #: ../src/guestfs-actions.pod:6447
27740 "Trace messages are normally sent to C<stderr>, unless you register a "
27741 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
27745 #: ../src/guestfs-actions.pod:6455
27746 msgid "guestfs_set_verbose"
27750 #: ../src/guestfs-actions.pod:6457
27754 " guestfs_set_verbose (guestfs_h *g,\n"
27760 #: ../src/guestfs-actions.pod:6466
27762 "Verbose messages are normally sent to C<stderr>, unless you register a "
27763 "callback to send them somewhere else (see C<guestfs_set_event_callback>)."
27767 #: ../src/guestfs-actions.pod:6474
27768 msgid "guestfs_setcon"
27772 #: ../src/guestfs-actions.pod:6476
27776 " guestfs_setcon (guestfs_h *g,\n"
27777 " const char *context);\n"
27782 #: ../src/guestfs-actions.pod:6489
27783 msgid "guestfs_setxattr"
27787 #: ../src/guestfs-actions.pod:6491
27791 " guestfs_setxattr (guestfs_h *g,\n"
27792 " const char *xattr,\n"
27793 " const char *val,\n"
27795 " const char *path);\n"
27800 #: ../src/guestfs-actions.pod:6502
27801 msgid "See also: C<guestfs_lsetxattr>, L<attr(5)>."
27805 #: ../src/guestfs-actions.pod:6508
27806 msgid "guestfs_sfdisk"
27810 #: ../src/guestfs-actions.pod:6510
27814 " guestfs_sfdisk (guestfs_h *g,\n"
27815 " const char *device,\n"
27819 " char *const *lines);\n"
27824 #: ../src/guestfs-actions.pod:6538
27825 msgid "See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>, C<guestfs_part_init>"
27829 #: ../src/guestfs-actions.pod:6546 ../src/guestfs-actions.pod:6576 ../src/guestfs-actions.pod:6609
27831 "This function is deprecated. In new code, use the L</guestfs_part_add> call "
27836 #: ../src/guestfs-actions.pod:6555
27837 msgid "guestfs_sfdiskM"
27841 #: ../src/guestfs-actions.pod:6557
27845 " guestfs_sfdiskM (guestfs_h *g,\n"
27846 " const char *device,\n"
27847 " char *const *lines);\n"
27852 #: ../src/guestfs-actions.pod:6562
27854 "This is a simplified interface to the C<guestfs_sfdisk> command, where "
27855 "partition sizes are specified in megabytes only (rounded to the nearest "
27856 "cylinder) and you don't need to specify the cyls, heads and sectors "
27857 "parameters which were rarely if ever used anyway."
27861 #: ../src/guestfs-actions.pod:6568
27863 "See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage and "
27864 "C<guestfs_part_disk>"
27868 #: ../src/guestfs-actions.pod:6585
27869 msgid "guestfs_sfdisk_N"
27873 #: ../src/guestfs-actions.pod:6587
27877 " guestfs_sfdisk_N (guestfs_h *g,\n"
27878 " const char *device,\n"
27883 " const char *line);\n"
27888 #: ../src/guestfs-actions.pod:6599
27890 "For other parameters, see C<guestfs_sfdisk>. You should usually pass C<0> "
27891 "for the cyls/heads/sectors parameters."
27895 #: ../src/guestfs-actions.pod:6602
27896 msgid "See also: C<guestfs_part_add>"
27900 #: ../src/guestfs-actions.pod:6618
27901 msgid "guestfs_sfdisk_disk_geometry"
27905 #: ../src/guestfs-actions.pod:6620
27909 " guestfs_sfdisk_disk_geometry (guestfs_h *g,\n"
27910 " const char *device);\n"
27915 #: ../src/guestfs-actions.pod:6624
27917 "This displays the disk geometry of C<device> read from the partition table. "
27918 "Especially in the case where the underlying block device has been resized, "
27919 "this can be different from the kernel's idea of the geometry (see "
27920 "C<guestfs_sfdisk_kernel_geometry>)."
27924 #: ../src/guestfs-actions.pod:6637
27925 msgid "guestfs_sfdisk_kernel_geometry"
27929 #: ../src/guestfs-actions.pod:6639
27933 " guestfs_sfdisk_kernel_geometry (guestfs_h *g,\n"
27934 " const char *device);\n"
27939 #: ../src/guestfs-actions.pod:6653
27940 msgid "guestfs_sfdisk_l"
27944 #: ../src/guestfs-actions.pod:6655
27948 " guestfs_sfdisk_l (guestfs_h *g,\n"
27949 " const char *device);\n"
27954 #: ../src/guestfs-actions.pod:6663
27955 msgid "See also: C<guestfs_part_list>"
27959 #: ../src/guestfs-actions.pod:6668
27961 "This function is deprecated. In new code, use the L</guestfs_part_list> "
27966 #: ../src/guestfs-actions.pod:6677
27971 #: ../src/guestfs-actions.pod:6679
27975 " guestfs_sh (guestfs_h *g,\n"
27976 " const char *command);\n"
27981 #: ../src/guestfs-actions.pod:6686
27982 msgid "This is like C<guestfs_command>, but passes the command to:"
27986 #: ../src/guestfs-actions.pod:6694
27987 msgid "All the provisos about C<guestfs_command> apply to this call."
27991 #: ../src/guestfs-actions.pod:6701
27992 msgid "guestfs_sh_lines"
27996 #: ../src/guestfs-actions.pod:6703
28000 " guestfs_sh_lines (guestfs_h *g,\n"
28001 " const char *command);\n"
28006 #: ../src/guestfs-actions.pod:6707
28008 "This is the same as C<guestfs_sh>, but splits the result into a list of "
28013 #: ../src/guestfs-actions.pod:6710
28014 msgid "See also: C<guestfs_command_lines>"
28018 #: ../src/guestfs-actions.pod:6718
28019 msgid "guestfs_sleep"
28023 #: ../src/guestfs-actions.pod:6720
28027 " guestfs_sleep (guestfs_h *g,\n"
28033 #: ../src/guestfs-actions.pod:6728
28034 msgid "(Added in 1.0.41)"
28038 #: ../src/guestfs-actions.pod:6730 ../src/guestfs-structs.pod:109
28039 msgid "guestfs_stat"
28043 #: ../src/guestfs-actions.pod:6732
28046 " struct guestfs_stat *\n"
28047 " guestfs_stat (guestfs_h *g,\n"
28048 " const char *path);\n"
28053 #: ../src/guestfs-actions.pod:6746 ../src/guestfs-structs.pod:135
28054 msgid "guestfs_statvfs"
28058 #: ../src/guestfs-actions.pod:6748
28061 " struct guestfs_statvfs *\n"
28062 " guestfs_statvfs (guestfs_h *g,\n"
28063 " const char *path);\n"
28068 #: ../src/guestfs-actions.pod:6758
28070 "This function returns a C<struct guestfs_statvfs *>, or NULL if there was an "
28071 "error. I<The caller must call C<guestfs_free_statvfs> after use>."
28075 #: ../src/guestfs-actions.pod:6764
28076 msgid "guestfs_strings"
28080 #: ../src/guestfs-actions.pod:6766
28084 " guestfs_strings (guestfs_h *g,\n"
28085 " const char *path);\n"
28090 #: ../src/guestfs-actions.pod:6782
28091 msgid "guestfs_strings_e"
28095 #: ../src/guestfs-actions.pod:6784
28099 " guestfs_strings_e (guestfs_h *g,\n"
28100 " const char *encoding,\n"
28101 " const char *path);\n"
28106 #: ../src/guestfs-actions.pod:6789
28108 "This is like the C<guestfs_strings> command, but allows you to specify the "
28109 "encoding of strings that are looked for in the source file C<path>."
28113 #: ../src/guestfs-actions.pod:6799
28115 "Single 7-bit-byte characters like ASCII and the ASCII-compatible parts of "
28116 "ISO-8859-X (this is what C<guestfs_strings> uses)."
28120 #: ../src/guestfs-actions.pod:6837
28121 msgid "guestfs_swapoff_device"
28125 #: ../src/guestfs-actions.pod:6839
28129 " guestfs_swapoff_device (guestfs_h *g,\n"
28130 " const char *device);\n"
28135 #: ../src/guestfs-actions.pod:6843
28137 "This command disables the libguestfs appliance swap device or partition "
28138 "named C<device>. See C<guestfs_swapon_device>."
28142 #: ../src/guestfs-actions.pod:6851
28143 msgid "guestfs_swapoff_file"
28147 #: ../src/guestfs-actions.pod:6853
28151 " guestfs_swapoff_file (guestfs_h *g,\n"
28152 " const char *file);\n"
28157 #: ../src/guestfs-actions.pod:6863
28158 msgid "guestfs_swapoff_label"
28162 #: ../src/guestfs-actions.pod:6865
28166 " guestfs_swapoff_label (guestfs_h *g,\n"
28167 " const char *label);\n"
28172 #: ../src/guestfs-actions.pod:6876
28173 msgid "guestfs_swapoff_uuid"
28177 #: ../src/guestfs-actions.pod:6878
28181 " guestfs_swapoff_uuid (guestfs_h *g,\n"
28182 " const char *uuid);\n"
28187 #: ../src/guestfs-actions.pod:6889
28188 msgid "guestfs_swapon_device"
28192 #: ../src/guestfs-actions.pod:6891
28196 " guestfs_swapon_device (guestfs_h *g,\n"
28197 " const char *device);\n"
28202 #: ../src/guestfs-actions.pod:6895
28204 "This command enables the libguestfs appliance to use the swap device or "
28205 "partition named C<device>. The increased memory is made available for all "
28206 "commands, for example those run using C<guestfs_command> or C<guestfs_sh>."
28210 #: ../src/guestfs-actions.pod:6911
28211 msgid "guestfs_swapon_file"
28215 #: ../src/guestfs-actions.pod:6913
28219 " guestfs_swapon_file (guestfs_h *g,\n"
28220 " const char *file);\n"
28225 #: ../src/guestfs-actions.pod:6917
28227 "This command enables swap to a file. See C<guestfs_swapon_device> for other "
28232 #: ../src/guestfs-actions.pod:6924
28233 msgid "guestfs_swapon_label"
28237 #: ../src/guestfs-actions.pod:6926
28241 " guestfs_swapon_label (guestfs_h *g,\n"
28242 " const char *label);\n"
28247 #: ../src/guestfs-actions.pod:6930
28249 "This command enables swap to a labeled swap partition. See "
28250 "C<guestfs_swapon_device> for other notes."
28254 #: ../src/guestfs-actions.pod:6937
28255 msgid "guestfs_swapon_uuid"
28259 #: ../src/guestfs-actions.pod:6939
28263 " guestfs_swapon_uuid (guestfs_h *g,\n"
28264 " const char *uuid);\n"
28269 #: ../src/guestfs-actions.pod:6943
28271 "This command enables swap to a swap partition with the given UUID. See "
28272 "C<guestfs_swapon_device> for other notes."
28276 #: ../src/guestfs-actions.pod:6950
28277 msgid "guestfs_sync"
28281 #: ../src/guestfs-actions.pod:6952
28285 " guestfs_sync (guestfs_h *g);\n"
28290 #: ../src/guestfs-actions.pod:6965
28291 msgid "guestfs_tail"
28295 #: ../src/guestfs-actions.pod:6967
28299 " guestfs_tail (guestfs_h *g,\n"
28300 " const char *path);\n"
28305 #: ../src/guestfs-actions.pod:6983
28306 msgid "guestfs_tail_n"
28310 #: ../src/guestfs-actions.pod:6985
28314 " guestfs_tail_n (guestfs_h *g,\n"
28316 " const char *path);\n"
28321 #: ../src/guestfs-actions.pod:7007
28322 msgid "guestfs_tar_in"
28326 #: ../src/guestfs-actions.pod:7009
28330 " guestfs_tar_in (guestfs_h *g,\n"
28331 " const char *tarfile,\n"
28332 " const char *directory);\n"
28337 #: ../src/guestfs-actions.pod:7017
28338 msgid "To upload a compressed tarball, use C<guestfs_tgz_in> or C<guestfs_txz_in>."
28342 #: ../src/guestfs-actions.pod:7022 ../src/guestfs-actions.pod:7039 ../src/guestfs-actions.pod:7055 ../src/guestfs-actions.pod:7071
28343 msgid "(Added in 1.0.3)"
28347 #: ../src/guestfs-actions.pod:7024
28348 msgid "guestfs_tar_out"
28352 #: ../src/guestfs-actions.pod:7026
28356 " guestfs_tar_out (guestfs_h *g,\n"
28357 " const char *directory,\n"
28358 " const char *tarfile);\n"
28363 #: ../src/guestfs-actions.pod:7034
28365 "To download a compressed tarball, use C<guestfs_tgz_out> or "
28366 "C<guestfs_txz_out>."
28370 #: ../src/guestfs-actions.pod:7041
28371 msgid "guestfs_tgz_in"
28375 #: ../src/guestfs-actions.pod:7043
28379 " guestfs_tgz_in (guestfs_h *g,\n"
28380 " const char *tarball,\n"
28381 " const char *directory);\n"
28386 #: ../src/guestfs-actions.pod:7051
28387 msgid "To upload an uncompressed tarball, use C<guestfs_tar_in>."
28391 #: ../src/guestfs-actions.pod:7057
28392 msgid "guestfs_tgz_out"
28396 #: ../src/guestfs-actions.pod:7059
28400 " guestfs_tgz_out (guestfs_h *g,\n"
28401 " const char *directory,\n"
28402 " const char *tarball);\n"
28407 #: ../src/guestfs-actions.pod:7067
28408 msgid "To download an uncompressed tarball, use C<guestfs_tar_out>."
28412 #: ../src/guestfs-actions.pod:7073
28413 msgid "guestfs_touch"
28417 #: ../src/guestfs-actions.pod:7075
28421 " guestfs_touch (guestfs_h *g,\n"
28422 " const char *path);\n"
28427 #: ../src/guestfs-actions.pod:7090
28428 msgid "guestfs_truncate"
28432 #: ../src/guestfs-actions.pod:7092
28436 " guestfs_truncate (guestfs_h *g,\n"
28437 " const char *path);\n"
28442 #: ../src/guestfs-actions.pod:7103
28443 msgid "guestfs_truncate_size"
28447 #: ../src/guestfs-actions.pod:7105
28451 " guestfs_truncate_size (guestfs_h *g,\n"
28452 " const char *path,\n"
28453 " int64_t size);\n"
28458 #: ../src/guestfs-actions.pod:7113
28460 "If the current file size is less than C<size> then the file is extended to "
28461 "the required size with zero bytes. This creates a sparse file (ie. disk "
28462 "blocks are not allocated for the file until you write to it). To create a "
28463 "non-sparse file of zeroes, use C<guestfs_fallocate64> instead."
28467 #: ../src/guestfs-actions.pod:7123
28468 msgid "guestfs_tune2fs_l"
28472 #: ../src/guestfs-actions.pod:7125
28476 " guestfs_tune2fs_l (guestfs_h *g,\n"
28477 " const char *device);\n"
28482 #: ../src/guestfs-actions.pod:7145
28483 msgid "guestfs_txz_in"
28487 #: ../src/guestfs-actions.pod:7147
28491 " guestfs_txz_in (guestfs_h *g,\n"
28492 " const char *tarball,\n"
28493 " const char *directory);\n"
28498 #: ../src/guestfs-actions.pod:7159
28499 msgid "guestfs_txz_out"
28503 #: ../src/guestfs-actions.pod:7161
28507 " guestfs_txz_out (guestfs_h *g,\n"
28508 " const char *directory,\n"
28509 " const char *tarball);\n"
28514 #: ../src/guestfs-actions.pod:7173
28515 msgid "guestfs_umask"
28519 #: ../src/guestfs-actions.pod:7175
28523 " guestfs_umask (guestfs_h *g,\n"
28529 #: ../src/guestfs-actions.pod:7191
28531 "See also C<guestfs_get_umask>, L<umask(2)>, C<guestfs_mknod>, "
28532 "C<guestfs_mkdir>."
28536 #: ../src/guestfs-actions.pod:7200
28537 msgid "guestfs_umount"
28541 #: ../src/guestfs-actions.pod:7202
28545 " guestfs_umount (guestfs_h *g,\n"
28546 " const char *pathordevice);\n"
28551 #: ../src/guestfs-actions.pod:7214
28552 msgid "guestfs_umount_all"
28556 #: ../src/guestfs-actions.pod:7216
28560 " guestfs_umount_all (guestfs_h *g);\n"
28565 #: ../src/guestfs-actions.pod:7227
28566 msgid "guestfs_upload"
28570 #: ../src/guestfs-actions.pod:7229
28574 " guestfs_upload (guestfs_h *g,\n"
28575 " const char *filename,\n"
28576 " const char *remotefilename);\n"
28581 #: ../src/guestfs-actions.pod:7239
28582 msgid "See also C<guestfs_download>."
28586 #: ../src/guestfs-actions.pod:7250
28587 msgid "guestfs_upload_offset"
28591 #: ../src/guestfs-actions.pod:7252
28595 " guestfs_upload_offset (guestfs_h *g,\n"
28596 " const char *filename,\n"
28597 " const char *remotefilename,\n"
28598 " int64_t offset);\n"
28603 #: ../src/guestfs-actions.pod:7268
28605 "Note that there is no limit on the amount of data that can be uploaded with "
28606 "this call, unlike with C<guestfs_pwrite>, and this call always writes the "
28607 "full amount unless an error occurs."
28611 #: ../src/guestfs-actions.pod:7273
28612 msgid "See also C<guestfs_upload>, C<guestfs_pwrite>."
28616 #: ../src/guestfs-actions.pod:7284
28617 msgid "guestfs_utimens"
28621 #: ../src/guestfs-actions.pod:7286
28625 " guestfs_utimens (guestfs_h *g,\n"
28626 " const char *path,\n"
28627 " int64_t atsecs,\n"
28628 " int64_t atnsecs,\n"
28629 " int64_t mtsecs,\n"
28630 " int64_t mtnsecs);\n"
28635 #: ../src/guestfs-actions.pod:7315 ../src/guestfs-structs.pod:175
28636 msgid "guestfs_version"
28640 #: ../src/guestfs-actions.pod:7317
28643 " struct guestfs_version *\n"
28644 " guestfs_version (guestfs_h *g);\n"
28649 #: ../src/guestfs-actions.pod:7345
28651 "I<Note:> Don't use this call to test for availability of features. In "
28652 "enterprise distributions we backport features from later versions into "
28653 "earlier versions, making this an unreliable way to test for features. Use "
28654 "C<guestfs_available> instead."
28658 #: ../src/guestfs-actions.pod:7351
28660 "This function returns a C<struct guestfs_version *>, or NULL if there was an "
28661 "error. I<The caller must call C<guestfs_free_version> after use>."
28665 #: ../src/guestfs-actions.pod:7355
28666 msgid "(Added in 1.0.58)"
28670 #: ../src/guestfs-actions.pod:7357
28671 msgid "guestfs_vfs_label"
28675 #: ../src/guestfs-actions.pod:7359
28679 " guestfs_vfs_label (guestfs_h *g,\n"
28680 " const char *device);\n"
28685 #: ../src/guestfs-actions.pod:7368
28686 msgid "To find a filesystem from the label, use C<guestfs_findfs_label>."
28690 #: ../src/guestfs-actions.pod:7373 ../src/guestfs-actions.pod:7410
28691 msgid "(Added in 1.3.18)"
28695 #: ../src/guestfs-actions.pod:7375
28696 msgid "guestfs_vfs_type"
28700 #: ../src/guestfs-actions.pod:7377
28704 " guestfs_vfs_type (guestfs_h *g,\n"
28705 " const char *device);\n"
28710 #: ../src/guestfs-actions.pod:7394
28711 msgid "guestfs_vfs_uuid"
28715 #: ../src/guestfs-actions.pod:7396
28719 " guestfs_vfs_uuid (guestfs_h *g,\n"
28720 " const char *device);\n"
28725 #: ../src/guestfs-actions.pod:7405
28726 msgid "To find a filesystem from the UUID, use C<guestfs_findfs_uuid>."
28730 #: ../src/guestfs-actions.pod:7412
28731 msgid "guestfs_vg_activate"
28735 #: ../src/guestfs-actions.pod:7414
28739 " guestfs_vg_activate (guestfs_h *g,\n"
28741 " char *const *volgroups);\n"
28746 #: ../src/guestfs-actions.pod:7431
28747 msgid "guestfs_vg_activate_all"
28751 #: ../src/guestfs-actions.pod:7433
28755 " guestfs_vg_activate_all (guestfs_h *g,\n"
28756 " int activate);\n"
28761 #: ../src/guestfs-actions.pod:7446
28762 msgid "guestfs_vgcreate"
28766 #: ../src/guestfs-actions.pod:7448
28770 " guestfs_vgcreate (guestfs_h *g,\n"
28771 " const char *volgroup,\n"
28772 " char *const *physvols);\n"
28777 #: ../src/guestfs-actions.pod:7460
28778 msgid "guestfs_vglvuuids"
28782 #: ../src/guestfs-actions.pod:7462
28786 " guestfs_vglvuuids (guestfs_h *g,\n"
28787 " const char *vgname);\n"
28792 #: ../src/guestfs-actions.pod:7469
28794 "You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid> calls to "
28795 "associate logical volumes and volume groups."
28799 #: ../src/guestfs-actions.pod:7472
28800 msgid "See also C<guestfs_vgpvuuids>."
28804 #: ../src/guestfs-actions.pod:7480
28805 msgid "guestfs_vgpvuuids"
28809 #: ../src/guestfs-actions.pod:7482
28813 " guestfs_vgpvuuids (guestfs_h *g,\n"
28814 " const char *vgname);\n"
28819 #: ../src/guestfs-actions.pod:7489
28821 "You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid> calls to "
28822 "associate physical volumes and volume groups."
28826 #: ../src/guestfs-actions.pod:7492
28827 msgid "See also C<guestfs_vglvuuids>."
28831 #: ../src/guestfs-actions.pod:7500
28832 msgid "guestfs_vgremove"
28836 #: ../src/guestfs-actions.pod:7502
28840 " guestfs_vgremove (guestfs_h *g,\n"
28841 " const char *vgname);\n"
28846 #: ../src/guestfs-actions.pod:7515
28847 msgid "guestfs_vgrename"
28851 #: ../src/guestfs-actions.pod:7517
28855 " guestfs_vgrename (guestfs_h *g,\n"
28856 " const char *volgroup,\n"
28857 " const char *newvolgroup);\n"
28862 #: ../src/guestfs-actions.pod:7528
28863 msgid "guestfs_vgs"
28867 #: ../src/guestfs-actions.pod:7530
28871 " guestfs_vgs (guestfs_h *g);\n"
28876 #: ../src/guestfs-actions.pod:7539
28877 msgid "See also C<guestfs_vgs_full>."
28881 #: ../src/guestfs-actions.pod:7547
28882 msgid "guestfs_vgs_full"
28886 #: ../src/guestfs-actions.pod:7549
28889 " struct guestfs_lvm_vg_list *\n"
28890 " guestfs_vgs_full (guestfs_h *g);\n"
28895 #: ../src/guestfs-actions.pod:7555
28897 "This function returns a C<struct guestfs_lvm_vg_list *>, or NULL if there "
28898 "was an error. I<The caller must call C<guestfs_free_lvm_vg_list> after "
28903 #: ../src/guestfs-actions.pod:7561
28904 msgid "guestfs_vgscan"
28908 #: ../src/guestfs-actions.pod:7563
28912 " guestfs_vgscan (guestfs_h *g);\n"
28917 #: ../src/guestfs-actions.pod:7573
28918 msgid "guestfs_vguuid"
28922 #: ../src/guestfs-actions.pod:7575
28926 " guestfs_vguuid (guestfs_h *g,\n"
28927 " const char *vgname);\n"
28932 #: ../src/guestfs-actions.pod:7586
28933 msgid "guestfs_wait_ready"
28937 #: ../src/guestfs-actions.pod:7588
28941 " guestfs_wait_ready (guestfs_h *g);\n"
28946 #: ../src/guestfs-actions.pod:7591
28947 msgid "This function is a no op."
28951 #: ../src/guestfs-actions.pod:7593
28953 "In versions of the API E<lt> 1.0.71 you had to call this function just after "
28954 "calling C<guestfs_launch> to wait for the launch to complete. However this "
28955 "is no longer necessary because C<guestfs_launch> now does the waiting."
28959 #: ../src/guestfs-actions.pod:7598
28961 "If you see any calls to this function in code then you can just remove them, "
28962 "unless you want to retain compatibility with older versions of the API."
28966 #: ../src/guestfs-actions.pod:7604
28968 "This function is deprecated. In new code, use the L</guestfs_launch> call "
28973 #: ../src/guestfs-actions.pod:7613
28974 msgid "guestfs_wc_c"
28978 #: ../src/guestfs-actions.pod:7615
28982 " guestfs_wc_c (guestfs_h *g,\n"
28983 " const char *path);\n"
28988 #: ../src/guestfs-actions.pod:7626
28989 msgid "guestfs_wc_l"
28993 #: ../src/guestfs-actions.pod:7628
28997 " guestfs_wc_l (guestfs_h *g,\n"
28998 " const char *path);\n"
29003 #: ../src/guestfs-actions.pod:7639
29004 msgid "guestfs_wc_w"
29008 #: ../src/guestfs-actions.pod:7641
29012 " guestfs_wc_w (guestfs_h *g,\n"
29013 " const char *path);\n"
29018 #: ../src/guestfs-actions.pod:7652
29019 msgid "guestfs_write"
29023 #: ../src/guestfs-actions.pod:7654
29027 " guestfs_write (guestfs_h *g,\n"
29028 " const char *path,\n"
29029 " const char *content,\n"
29030 " size_t content_size);\n"
29035 #: ../src/guestfs-actions.pod:7663
29036 msgid "See also C<guestfs_write_append>."
29040 #: ../src/guestfs-actions.pod:7672
29041 msgid "guestfs_write_append"
29045 #: ../src/guestfs-actions.pod:7674
29049 " guestfs_write_append (guestfs_h *g,\n"
29050 " const char *path,\n"
29051 " const char *content,\n"
29052 " size_t content_size);\n"
29057 #: ../src/guestfs-actions.pod:7683
29058 msgid "See also C<guestfs_write>."
29062 #: ../src/guestfs-actions.pod:7692
29063 msgid "guestfs_write_file"
29067 #: ../src/guestfs-actions.pod:7694
29071 " guestfs_write_file (guestfs_h *g,\n"
29072 " const char *path,\n"
29073 " const char *content,\n"
29079 #: ../src/guestfs-actions.pod:7716
29081 "This function is deprecated. In new code, use the L</guestfs_write> call "
29086 #: ../src/guestfs-actions.pod:7725
29087 msgid "guestfs_zegrep"
29091 #: ../src/guestfs-actions.pod:7727
29095 " guestfs_zegrep (guestfs_h *g,\n"
29096 " const char *regex,\n"
29097 " const char *path);\n"
29102 #: ../src/guestfs-actions.pod:7744
29103 msgid "guestfs_zegrepi"
29107 #: ../src/guestfs-actions.pod:7746
29111 " guestfs_zegrepi (guestfs_h *g,\n"
29112 " const char *regex,\n"
29113 " const char *path);\n"
29118 #: ../src/guestfs-actions.pod:7763
29119 msgid "guestfs_zero"
29123 #: ../src/guestfs-actions.pod:7765
29127 " guestfs_zero (guestfs_h *g,\n"
29128 " const char *device);\n"
29133 #: ../src/guestfs-actions.pod:7775
29135 "See also: C<guestfs_zero_device>, C<guestfs_scrub_device>, "
29136 "C<guestfs_is_zero_device>"
29140 #: ../src/guestfs-actions.pod:7787
29141 msgid "guestfs_zero_device"
29145 #: ../src/guestfs-actions.pod:7789
29149 " guestfs_zero_device (guestfs_h *g,\n"
29150 " const char *device);\n"
29155 #: ../src/guestfs-actions.pod:7793
29157 "This command writes zeroes over the entire C<device>. Compare with "
29158 "C<guestfs_zero> which just zeroes the first few blocks of a device."
29162 #: ../src/guestfs-actions.pod:7807
29163 msgid "(Added in 1.3.1)"
29167 #: ../src/guestfs-actions.pod:7809
29168 msgid "guestfs_zerofree"
29172 #: ../src/guestfs-actions.pod:7811
29176 " guestfs_zerofree (guestfs_h *g,\n"
29177 " const char *device);\n"
29182 #: ../src/guestfs-actions.pod:7830
29183 msgid "guestfs_zfgrep"
29187 #: ../src/guestfs-actions.pod:7832
29191 " guestfs_zfgrep (guestfs_h *g,\n"
29192 " const char *pattern,\n"
29193 " const char *path);\n"
29198 #: ../src/guestfs-actions.pod:7849
29199 msgid "guestfs_zfgrepi"
29203 #: ../src/guestfs-actions.pod:7851
29207 " guestfs_zfgrepi (guestfs_h *g,\n"
29208 " const char *pattern,\n"
29209 " const char *path);\n"
29214 #: ../src/guestfs-actions.pod:7868
29215 msgid "guestfs_zfile"
29219 #: ../src/guestfs-actions.pod:7870
29223 " guestfs_zfile (guestfs_h *g,\n"
29224 " const char *meth,\n"
29225 " const char *path);\n"
29230 #: ../src/guestfs-actions.pod:7880
29232 "Since 1.0.63, use C<guestfs_file> instead which can now process compressed "
29237 #: ../src/guestfs-actions.pod:7886
29239 "This function is deprecated. In new code, use the L</guestfs_file> call "
29244 #: ../src/guestfs-actions.pod:7895
29245 msgid "guestfs_zgrep"
29249 #: ../src/guestfs-actions.pod:7897
29253 " guestfs_zgrep (guestfs_h *g,\n"
29254 " const char *regex,\n"
29255 " const char *path);\n"
29260 #: ../src/guestfs-actions.pod:7914
29261 msgid "guestfs_zgrepi"
29265 #: ../src/guestfs-actions.pod:7916
29269 " guestfs_zgrepi (guestfs_h *g,\n"
29270 " const char *regex,\n"
29271 " const char *path);\n"
29276 #: ../src/guestfs-availability.pod:3
29281 #: ../src/guestfs-availability.pod:5
29283 "The following functions: L</guestfs_aug_clear> L</guestfs_aug_close> "
29284 "L</guestfs_aug_defnode> L</guestfs_aug_defvar> L</guestfs_aug_get> "
29285 "L</guestfs_aug_init> L</guestfs_aug_insert> L</guestfs_aug_load> "
29286 "L</guestfs_aug_ls> L</guestfs_aug_match> L</guestfs_aug_mv> "
29287 "L</guestfs_aug_rm> L</guestfs_aug_save> L</guestfs_aug_set>"
29291 #: ../src/guestfs-availability.pod:21
29296 #: ../src/guestfs-availability.pod:23
29297 msgid "The following functions: L</guestfs_btrfs_filesystem_resize>"
29301 #: ../src/guestfs-availability.pod:26
29306 #: ../src/guestfs-availability.pod:28
29308 "The following functions: L</guestfs_inotify_add_watch> "
29309 "L</guestfs_inotify_close> L</guestfs_inotify_files> L</guestfs_inotify_init> "
29310 "L</guestfs_inotify_read> L</guestfs_inotify_rm_watch>"
29314 #: ../src/guestfs-availability.pod:36
29315 msgid "B<linuxfsuuid>"
29319 #: ../src/guestfs-availability.pod:38
29321 "The following functions: L</guestfs_mke2fs_JU> L</guestfs_mke2journal_U> "
29322 "L</guestfs_mkswap_U> L</guestfs_swapoff_uuid> L</guestfs_swapon_uuid>"
29326 #: ../src/guestfs-availability.pod:45
29327 msgid "B<linuxmodules>"
29331 #: ../src/guestfs-availability.pod:47
29332 msgid "The following functions: L</guestfs_modprobe>"
29336 #: ../src/guestfs-availability.pod:50
29337 msgid "B<linuxxattrs>"
29341 #: ../src/guestfs-availability.pod:52
29343 "The following functions: L</guestfs_getxattr> L</guestfs_getxattrs> "
29344 "L</guestfs_lgetxattr> L</guestfs_lgetxattrs> L</guestfs_lremovexattr> "
29345 "L</guestfs_lsetxattr> L</guestfs_lxattrlist> L</guestfs_removexattr> "
29346 "L</guestfs_setxattr>"
29350 #: ../src/guestfs-availability.pod:63
29355 #: ../src/guestfs-availability.pod:65
29357 "The following functions: L</guestfs_luks_add_key> L</guestfs_luks_close> "
29358 "L</guestfs_luks_format> L</guestfs_luks_format_cipher> "
29359 "L</guestfs_luks_kill_slot> L</guestfs_luks_open> L</guestfs_luks_open_ro>"
29363 #: ../src/guestfs-availability.pod:74
29368 #: ../src/guestfs-availability.pod:76
29370 "The following functions: L</guestfs_is_lv> L</guestfs_lvcreate> "
29371 "L</guestfs_lvm_remove_all> L</guestfs_lvm_set_filter> L</guestfs_lvremove> "
29372 "L</guestfs_lvresize> L</guestfs_lvresize_free> L</guestfs_lvs> "
29373 "L</guestfs_lvs_full> L</guestfs_pvcreate> L</guestfs_pvremove> "
29374 "L</guestfs_pvresize> L</guestfs_pvresize_size> L</guestfs_pvs> "
29375 "L</guestfs_pvs_full> L</guestfs_vg_activate> L</guestfs_vg_activate_all> "
29376 "L</guestfs_vgcreate> L</guestfs_vgremove> L</guestfs_vgs> "
29377 "L</guestfs_vgs_full>"
29381 #: ../src/guestfs-availability.pod:99
29386 #: ../src/guestfs-availability.pod:101
29388 "The following functions: L</guestfs_mkfifo> L</guestfs_mknod> "
29389 "L</guestfs_mknod_b> L</guestfs_mknod_c>"
29393 #: ../src/guestfs-availability.pod:107
29398 #: ../src/guestfs-availability.pod:109
29399 msgid "The following functions: L</guestfs_ntfs_3g_probe>"
29403 #: ../src/guestfs-availability.pod:112
29404 msgid "B<ntfsprogs>"
29408 #: ../src/guestfs-availability.pod:114
29410 "The following functions: L</guestfs_ntfsresize> L</guestfs_ntfsresize_opts> "
29411 "L</guestfs_ntfsresize_size>"
29415 #: ../src/guestfs-availability.pod:119
29416 msgid "B<realpath>"
29420 #: ../src/guestfs-availability.pod:121
29421 msgid "The following functions: L</guestfs_realpath>"
29425 #: ../src/guestfs-availability.pod:124
29430 #: ../src/guestfs-availability.pod:126
29432 "The following functions: L</guestfs_scrub_device> L</guestfs_scrub_file> "
29433 "L</guestfs_scrub_freespace>"
29437 #: ../src/guestfs-availability.pod:131
29442 #: ../src/guestfs-availability.pod:133
29443 msgid "The following functions: L</guestfs_getcon> L</guestfs_setcon>"
29447 #: ../src/guestfs-availability.pod:137
29452 #: ../src/guestfs-availability.pod:139
29453 msgid "The following functions: L</guestfs_txz_in> L</guestfs_txz_out>"
29457 #: ../src/guestfs-availability.pod:143
29458 msgid "B<zerofree>"
29462 #: ../src/guestfs-availability.pod:145
29463 msgid "The following functions: L</guestfs_zerofree>"
29467 #: ../src/guestfs-structs.pod:1
29468 msgid "guestfs_int_bool"
29472 #: ../src/guestfs-structs.pod:3
29475 " struct guestfs_int_bool {\n"
29483 #: ../src/guestfs-structs.pod:8
29486 " struct guestfs_int_bool_list {\n"
29487 " uint32_t len; /* Number of elements in list. */\n"
29488 " struct guestfs_int_bool *val; /* Elements. */\n"
29494 #: ../src/guestfs-structs.pod:13
29497 " void guestfs_free_int_bool (struct guestfs_free_int_bool *);\n"
29498 " void guestfs_free_int_bool_list (struct guestfs_free_int_bool_list *);\n"
29503 #: ../src/guestfs-structs.pod:16
29504 msgid "guestfs_lvm_pv"
29508 #: ../src/guestfs-structs.pod:18
29511 " struct guestfs_lvm_pv {\n"
29512 " char *pv_name;\n"
29513 " /* The next field is NOT nul-terminated, be careful when printing it: "
29515 " char pv_uuid[32];\n"
29517 " uint64_t pv_size;\n"
29518 " uint64_t dev_size;\n"
29519 " uint64_t pv_free;\n"
29520 " uint64_t pv_used;\n"
29521 " char *pv_attr;\n"
29522 " int64_t pv_pe_count;\n"
29523 " int64_t pv_pe_alloc_count;\n"
29524 " char *pv_tags;\n"
29525 " uint64_t pe_start;\n"
29526 " int64_t pv_mda_count;\n"
29527 " uint64_t pv_mda_free;\n"
29533 #: ../src/guestfs-structs.pod:36
29536 " struct guestfs_lvm_pv_list {\n"
29537 " uint32_t len; /* Number of elements in list. */\n"
29538 " struct guestfs_lvm_pv *val; /* Elements. */\n"
29544 #: ../src/guestfs-structs.pod:41
29547 " void guestfs_free_lvm_pv (struct guestfs_free_lvm_pv *);\n"
29548 " void guestfs_free_lvm_pv_list (struct guestfs_free_lvm_pv_list *);\n"
29553 #: ../src/guestfs-structs.pod:44
29554 msgid "guestfs_lvm_vg"
29558 #: ../src/guestfs-structs.pod:46
29561 " struct guestfs_lvm_vg {\n"
29562 " char *vg_name;\n"
29563 " /* The next field is NOT nul-terminated, be careful when printing it: "
29565 " char vg_uuid[32];\n"
29567 " char *vg_attr;\n"
29568 " uint64_t vg_size;\n"
29569 " uint64_t vg_free;\n"
29570 " char *vg_sysid;\n"
29571 " uint64_t vg_extent_size;\n"
29572 " int64_t vg_extent_count;\n"
29573 " int64_t vg_free_count;\n"
29574 " int64_t max_lv;\n"
29575 " int64_t max_pv;\n"
29576 " int64_t pv_count;\n"
29577 " int64_t lv_count;\n"
29578 " int64_t snap_count;\n"
29579 " int64_t vg_seqno;\n"
29580 " char *vg_tags;\n"
29581 " int64_t vg_mda_count;\n"
29582 " uint64_t vg_mda_free;\n"
29588 #: ../src/guestfs-structs.pod:69
29591 " struct guestfs_lvm_vg_list {\n"
29592 " uint32_t len; /* Number of elements in list. */\n"
29593 " struct guestfs_lvm_vg *val; /* Elements. */\n"
29599 #: ../src/guestfs-structs.pod:74
29602 " void guestfs_free_lvm_vg (struct guestfs_free_lvm_vg *);\n"
29603 " void guestfs_free_lvm_vg_list (struct guestfs_free_lvm_vg_list *);\n"
29608 #: ../src/guestfs-structs.pod:77
29609 msgid "guestfs_lvm_lv"
29613 #: ../src/guestfs-structs.pod:79
29616 " struct guestfs_lvm_lv {\n"
29617 " char *lv_name;\n"
29618 " /* The next field is NOT nul-terminated, be careful when printing it: "
29620 " char lv_uuid[32];\n"
29621 " char *lv_attr;\n"
29622 " int64_t lv_major;\n"
29623 " int64_t lv_minor;\n"
29624 " int64_t lv_kernel_major;\n"
29625 " int64_t lv_kernel_minor;\n"
29626 " uint64_t lv_size;\n"
29627 " int64_t seg_count;\n"
29629 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
29630 " float snap_percent;\n"
29631 " /* The next field is [0..100] or -1 meaning 'not present': */\n"
29632 " float copy_percent;\n"
29633 " char *move_pv;\n"
29634 " char *lv_tags;\n"
29635 " char *mirror_log;\n"
29636 " char *modules;\n"
29642 #: ../src/guestfs-structs.pod:101
29645 " struct guestfs_lvm_lv_list {\n"
29646 " uint32_t len; /* Number of elements in list. */\n"
29647 " struct guestfs_lvm_lv *val; /* Elements. */\n"
29653 #: ../src/guestfs-structs.pod:106
29656 " void guestfs_free_lvm_lv (struct guestfs_free_lvm_lv *);\n"
29657 " void guestfs_free_lvm_lv_list (struct guestfs_free_lvm_lv_list *);\n"
29662 #: ../src/guestfs-structs.pod:111
29665 " struct guestfs_stat {\n"
29669 " int64_t nlink;\n"
29674 " int64_t blksize;\n"
29675 " int64_t blocks;\n"
29676 " int64_t atime;\n"
29677 " int64_t mtime;\n"
29678 " int64_t ctime;\n"
29684 #: ../src/guestfs-structs.pod:127
29687 " struct guestfs_stat_list {\n"
29688 " uint32_t len; /* Number of elements in list. */\n"
29689 " struct guestfs_stat *val; /* Elements. */\n"
29695 #: ../src/guestfs-structs.pod:132
29698 " void guestfs_free_stat (struct guestfs_free_stat *);\n"
29699 " void guestfs_free_stat_list (struct guestfs_free_stat_list *);\n"
29704 #: ../src/guestfs-structs.pod:137
29707 " struct guestfs_statvfs {\n"
29708 " int64_t bsize;\n"
29709 " int64_t frsize;\n"
29710 " int64_t blocks;\n"
29711 " int64_t bfree;\n"
29712 " int64_t bavail;\n"
29713 " int64_t files;\n"
29714 " int64_t ffree;\n"
29715 " int64_t favail;\n"
29718 " int64_t namemax;\n"
29724 #: ../src/guestfs-structs.pod:151
29727 " struct guestfs_statvfs_list {\n"
29728 " uint32_t len; /* Number of elements in list. */\n"
29729 " struct guestfs_statvfs *val; /* Elements. */\n"
29735 #: ../src/guestfs-structs.pod:156
29738 " void guestfs_free_statvfs (struct guestfs_free_statvfs *);\n"
29739 " void guestfs_free_statvfs_list (struct guestfs_free_statvfs_list *);\n"
29744 #: ../src/guestfs-structs.pod:159
29745 msgid "guestfs_dirent"
29749 #: ../src/guestfs-structs.pod:161
29752 " struct guestfs_dirent {\n"
29761 #: ../src/guestfs-structs.pod:167
29764 " struct guestfs_dirent_list {\n"
29765 " uint32_t len; /* Number of elements in list. */\n"
29766 " struct guestfs_dirent *val; /* Elements. */\n"
29772 #: ../src/guestfs-structs.pod:172
29775 " void guestfs_free_dirent (struct guestfs_free_dirent *);\n"
29776 " void guestfs_free_dirent_list (struct guestfs_free_dirent_list *);\n"
29781 #: ../src/guestfs-structs.pod:177
29784 " struct guestfs_version {\n"
29785 " int64_t major;\n"
29786 " int64_t minor;\n"
29787 " int64_t release;\n"
29794 #: ../src/guestfs-structs.pod:184
29797 " struct guestfs_version_list {\n"
29798 " uint32_t len; /* Number of elements in list. */\n"
29799 " struct guestfs_version *val; /* Elements. */\n"
29805 #: ../src/guestfs-structs.pod:189
29808 " void guestfs_free_version (struct guestfs_free_version *);\n"
29809 " void guestfs_free_version_list (struct guestfs_free_version_list *);\n"
29814 #: ../src/guestfs-structs.pod:192
29815 msgid "guestfs_xattr"
29819 #: ../src/guestfs-structs.pod:194
29822 " struct guestfs_xattr {\n"
29823 " char *attrname;\n"
29824 " /* The next two fields describe a byte array. */\n"
29825 " uint32_t attrval_len;\n"
29826 " char *attrval;\n"
29832 #: ../src/guestfs-structs.pod:201
29835 " struct guestfs_xattr_list {\n"
29836 " uint32_t len; /* Number of elements in list. */\n"
29837 " struct guestfs_xattr *val; /* Elements. */\n"
29843 #: ../src/guestfs-structs.pod:206
29846 " void guestfs_free_xattr (struct guestfs_free_xattr *);\n"
29847 " void guestfs_free_xattr_list (struct guestfs_free_xattr_list *);\n"
29852 #: ../src/guestfs-structs.pod:209
29853 msgid "guestfs_inotify_event"
29857 #: ../src/guestfs-structs.pod:211
29860 " struct guestfs_inotify_event {\n"
29861 " int64_t in_wd;\n"
29862 " uint32_t in_mask;\n"
29863 " uint32_t in_cookie;\n"
29864 " char *in_name;\n"
29870 #: ../src/guestfs-structs.pod:218
29873 " struct guestfs_inotify_event_list {\n"
29874 " uint32_t len; /* Number of elements in list. */\n"
29875 " struct guestfs_inotify_event *val; /* Elements. */\n"
29881 #: ../src/guestfs-structs.pod:223
29884 " void guestfs_free_inotify_event (struct guestfs_free_inotify_event *);\n"
29885 " void guestfs_free_inotify_event_list (struct "
29886 "guestfs_free_inotify_event_list *);\n"
29891 #: ../src/guestfs-structs.pod:226
29892 msgid "guestfs_partition"
29896 #: ../src/guestfs-structs.pod:228
29899 " struct guestfs_partition {\n"
29900 " int32_t part_num;\n"
29901 " uint64_t part_start;\n"
29902 " uint64_t part_end;\n"
29903 " uint64_t part_size;\n"
29909 #: ../src/guestfs-structs.pod:235
29912 " struct guestfs_partition_list {\n"
29913 " uint32_t len; /* Number of elements in list. */\n"
29914 " struct guestfs_partition *val; /* Elements. */\n"
29920 #: ../src/guestfs-structs.pod:240
29923 " void guestfs_free_partition (struct guestfs_free_partition *);\n"
29924 " void guestfs_free_partition_list (struct guestfs_free_partition_list *);\n"
29929 #: ../src/guestfs-structs.pod:243
29930 msgid "guestfs_application"
29934 #: ../src/guestfs-structs.pod:245
29937 " struct guestfs_application {\n"
29938 " char *app_name;\n"
29939 " char *app_display_name;\n"
29940 " int32_t app_epoch;\n"
29941 " char *app_version;\n"
29942 " char *app_release;\n"
29943 " char *app_install_path;\n"
29944 " char *app_trans_path;\n"
29945 " char *app_publisher;\n"
29946 " char *app_url;\n"
29947 " char *app_source_package;\n"
29948 " char *app_summary;\n"
29949 " char *app_description;\n"
29955 #: ../src/guestfs-structs.pod:260
29958 " struct guestfs_application_list {\n"
29959 " uint32_t len; /* Number of elements in list. */\n"
29960 " struct guestfs_application *val; /* Elements. */\n"
29966 #: ../src/guestfs-structs.pod:265
29969 " void guestfs_free_application (struct guestfs_free_application *);\n"
29970 " void guestfs_free_application_list (struct guestfs_free_application_list "
29976 #: ../src/guestfs.pod:5
29977 msgid "guestfs - Library for accessing and modifying virtual machine images"
29981 #: ../src/guestfs.pod:11
29984 " guestfs_h *g = guestfs_create ();\n"
29985 " guestfs_add_drive (g, \"guest.img\");\n"
29986 " guestfs_launch (g);\n"
29987 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
29988 " guestfs_touch (g, \"/hello\");\n"
29989 " guestfs_umount (g, \"/\");\n"
29990 " guestfs_close (g);\n"
29995 #: ../src/guestfs.pod:25
29997 "Libguestfs is a library for accessing and modifying guest disk images. "
29998 "Amongst the things this is good for: making batch configuration changes to "
29999 "guests, getting disk used/free statistics (see also: virt-df), migrating "
30000 "between virtualization systems (see also: virt-p2v), performing partial "
30001 "backups, performing partial guest clones, cloning guests and changing "
30002 "registry/UUID/hostname info, and much else besides."
30006 #: ../src/guestfs.pod:33
30008 "Libguestfs uses Linux kernel and qemu code, and can access any type of guest "
30009 "filesystem that Linux and qemu can, including but not limited to: ext2/3/4, "
30010 "btrfs, FAT and NTFS, LVM, many different disk partition schemes, qcow, "
30015 #: ../src/guestfs.pod:38
30017 "Libguestfs provides ways to enumerate guest storage (eg. partitions, LVs, "
30018 "what filesystem is in each LV, etc.). It can also run commands in the "
30019 "context of the guest. Also you can access filesystems over FUSE."
30023 #: ../src/guestfs.pod:43
30025 "Libguestfs is a library that can be linked with C and C++ management "
30026 "programs (or management programs written in OCaml, Perl, Python, Ruby, Java, "
30027 "PHP, Haskell or C#). You can also use it from shell scripts or the command "
30032 #: ../src/guestfs.pod:48
30034 "You don't need to be root to use libguestfs, although obviously you do need "
30035 "enough permissions to access the disk images."
30039 #: ../src/guestfs.pod:51
30041 "Libguestfs is a large API because it can do many things. For a gentle "
30042 "introduction, please read the L</API OVERVIEW> section next."
30046 #: ../src/guestfs.pod:54
30048 "There are also some example programs in the L<guestfs-examples(3)> manual "
30053 #: ../src/guestfs.pod:57
30054 msgid "API OVERVIEW"
30058 #: ../src/guestfs.pod:59
30060 "This section provides a gentler overview of the libguestfs API. We also try "
30061 "to group API calls together, where that may not be obvious from reading "
30062 "about the individual calls in the main section of this manual."
30066 #: ../src/guestfs.pod:64
30071 #: ../src/guestfs.pod:66
30073 "Before you can use libguestfs calls, you have to create a handle. Then you "
30074 "must add at least one disk image to the handle, followed by launching the "
30075 "handle, then performing whatever operations you want, and finally closing "
30076 "the handle. By convention we use the single letter C<g> for the name of the "
30077 "handle variable, although of course you can use any name you want."
30081 #: ../src/guestfs.pod:73
30082 msgid "The general structure of all libguestfs-using programs looks like this:"
30086 #: ../src/guestfs.pod:76
30089 " guestfs_h *g = guestfs_create ();\n"
30094 #: ../src/guestfs.pod:78
30097 " /* Call guestfs_add_drive additional times if there are\n"
30098 " * multiple disk images.\n"
30100 " guestfs_add_drive (g, \"guest.img\");\n"
30105 #: ../src/guestfs.pod:83
30108 " /* Most manipulation calls won't work until you've launched\n"
30109 " * the handle 'g'. You have to do this _after_ adding drives\n"
30110 " * and _before_ other commands.\n"
30112 " guestfs_launch (g);\n"
30117 #: ../src/guestfs.pod:89
30120 " /* Now you can examine what partitions, LVs etc are available.\n"
30122 " char **partitions = guestfs_list_partitions (g);\n"
30123 " char **logvols = guestfs_lvs (g);\n"
30128 #: ../src/guestfs.pod:94
30131 " /* To access a filesystem in the image, you must mount it.\n"
30133 " guestfs_mount (g, \"/dev/sda1\", \"/\");\n"
30138 #: ../src/guestfs.pod:98
30141 " /* Now you can perform filesystem actions on the guest\n"
30144 " guestfs_touch (g, \"/hello\");\n"
30149 #: ../src/guestfs.pod:103
30152 " /* This is only needed for libguestfs < 1.5.24. Since then\n"
30153 " * it is done automatically when you close the handle. See\n"
30154 " * discussion of autosync in this page.\n"
30156 " guestfs_sync (g);\n"
30161 #: ../src/guestfs.pod:109
30164 " /* Close the handle 'g'. */\n"
30165 " guestfs_close (g);\n"
30170 #: ../src/guestfs.pod:112
30172 "The code above doesn't include any error checking. In real code you should "
30173 "check return values carefully for errors. In general all functions that "
30174 "return integers return C<-1> on error, and all functions that return "
30175 "pointers return C<NULL> on error. See section L</ERROR HANDLING> below for "
30176 "how to handle errors, and consult the documentation for each function call "
30177 "below to see precisely how they return error indications. See "
30178 "L<guestfs-examples(3)> for fully worked examples."
30182 #: ../src/guestfs.pod:121
30183 msgid "DISK IMAGES"
30187 #: ../src/guestfs.pod:123
30189 "The image filename (C<\"guest.img\"> in the example above) could be a disk "
30190 "image from a virtual machine, a L<dd(1)> copy of a physical hard disk, an "
30191 "actual block device, or simply an empty file of zeroes that you have created "
30192 "through L<posix_fallocate(3)>. Libguestfs lets you do useful things to all "
30197 #: ../src/guestfs.pod:129
30199 "The call you should use in modern code for adding drives is "
30200 "L</guestfs_add_drive_opts>. To add a disk image, allowing writes, and "
30201 "specifying that the format is raw, do:"
30205 #: ../src/guestfs.pod:133
30208 " guestfs_add_drive_opts (g, filename,\n"
30209 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
30215 #: ../src/guestfs.pod:137
30216 msgid "You can add a disk read-only using:"
30220 #: ../src/guestfs.pod:139
30223 " guestfs_add_drive_opts (g, filename,\n"
30224 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"raw\",\n"
30225 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
30231 #: ../src/guestfs.pod:144
30233 "or by calling the older function L</guestfs_add_drive_ro>. In either case "
30234 "libguestfs won't modify the file."
30238 #: ../src/guestfs.pod:147
30240 "Be extremely cautious if the disk image is in use, eg. if it is being used "
30241 "by a virtual machine. Adding it read-write will almost certainly cause disk "
30242 "corruption, but adding it read-only is safe."
30246 #: ../src/guestfs.pod:151
30248 "You must add at least one disk image, and you may add multiple disk images. "
30249 "In the API, the disk images are usually referred to as C</dev/sda> (for the "
30250 "first one you added), C</dev/sdb> (for the second one you added), etc."
30254 #: ../src/guestfs.pod:156
30256 "Once L</guestfs_launch> has been called you cannot add any more images. You "
30257 "can call L</guestfs_list_devices> to get a list of the device names, in the "
30258 "order that you added them. See also L</BLOCK DEVICE NAMING> below."
30262 #: ../src/guestfs.pod:161
30267 #: ../src/guestfs.pod:163
30269 "Before you can read or write files, create directories and so on in a disk "
30270 "image that contains filesystems, you have to mount those filesystems using "
30271 "L</guestfs_mount_options> or L</guestfs_mount_ro>. If you already know that "
30272 "a disk image contains (for example) one partition with a filesystem on that "
30273 "partition, then you can mount it directly:"
30277 #: ../src/guestfs.pod:170
30280 " guestfs_mount_options (g, \"\", \"/dev/sda1\", \"/\");\n"
30285 #: ../src/guestfs.pod:172
30287 "where C</dev/sda1> means literally the first partition (C<1>) of the first "
30288 "disk image that we added (C</dev/sda>). If the disk contains Linux LVM2 "
30289 "logical volumes you could refer to those instead (eg. C</dev/VG/LV>). Note "
30290 "that these are libguestfs virtual devices, and are nothing to do with host "
30295 #: ../src/guestfs.pod:178
30297 "If you are given a disk image and you don't know what it contains then you "
30298 "have to find out. Libguestfs can do that too: use "
30299 "L</guestfs_list_partitions> and L</guestfs_lvs> to list possible partitions "
30300 "and LVs, and either try mounting each to see what is mountable, or else "
30301 "examine them with L</guestfs_vfs_type> or L</guestfs_file>. To list just "
30302 "filesystems, use L</guestfs_list_filesystems>."
30306 #: ../src/guestfs.pod:186
30308 "Libguestfs also has a set of APIs for inspection of unknown disk images (see "
30309 "L</INSPECTION> below). But you might find it easier to look at higher level "
30310 "programs built on top of libguestfs, in particular L<virt-inspector(1)>."
30314 #: ../src/guestfs.pod:191
30316 "To mount a filesystem read-only, use L</guestfs_mount_ro>. There are "
30317 "several other variations of the C<guestfs_mount_*> call."
30321 #: ../src/guestfs.pod:194
30322 msgid "FILESYSTEM ACCESS AND MODIFICATION"
30326 #: ../src/guestfs.pod:196
30328 "The majority of the libguestfs API consists of fairly low-level calls for "
30329 "accessing and modifying the files, directories, symlinks etc on mounted "
30330 "filesystems. There are over a hundred such calls which you can find listed "
30331 "in detail below in this man page, and we don't even pretend to cover them "
30332 "all in this overview."
30336 #: ../src/guestfs.pod:202
30338 "Specify filenames as full paths, starting with C<\"/\"> and including the "
30343 #: ../src/guestfs.pod:205
30345 "For example, if you mounted a filesystem at C<\"/\"> and you want to read "
30346 "the file called C<\"etc/passwd\"> then you could do:"
30350 #: ../src/guestfs.pod:208
30353 " char *data = guestfs_cat (g, \"/etc/passwd\");\n"
30358 #: ../src/guestfs.pod:210
30360 "This would return C<data> as a newly allocated buffer containing the full "
30361 "content of that file (with some conditions: see also L</DOWNLOADING> below), "
30362 "or C<NULL> if there was an error."
30366 #: ../src/guestfs.pod:214
30368 "As another example, to create a top-level directory on that filesystem "
30369 "called C<\"var\"> you would do:"
30373 #: ../src/guestfs.pod:217
30376 " guestfs_mkdir (g, \"/var\");\n"
30381 #: ../src/guestfs.pod:219
30382 msgid "To create a symlink you could do:"
30386 #: ../src/guestfs.pod:221
30389 " guestfs_ln_s (g, \"/etc/init.d/portmap\",\n"
30390 " \"/etc/rc3.d/S30portmap\");\n"
30395 #: ../src/guestfs.pod:224
30397 "Libguestfs will reject attempts to use relative paths and there is no "
30398 "concept of a current working directory."
30402 #: ../src/guestfs.pod:227
30404 "Libguestfs can return errors in many situations: for example if the "
30405 "filesystem isn't writable, or if a file or directory that you requested "
30406 "doesn't exist. If you are using the C API (documented here) you have to "
30407 "check for those error conditions after each call. (Other language bindings "
30408 "turn these errors into exceptions)."
30412 #: ../src/guestfs.pod:233
30414 "File writes are affected by the per-handle umask, set by calling "
30415 "L</guestfs_umask> and defaulting to 022. See L</UMASK>."
30419 #: ../src/guestfs.pod:236
30420 msgid "PARTITIONING"
30424 #: ../src/guestfs.pod:238
30426 "Libguestfs contains API calls to read, create and modify partition tables on "
30431 #: ../src/guestfs.pod:241
30433 "In the common case where you want to create a single partition covering the "
30434 "whole disk, you should use the L</guestfs_part_disk> call:"
30438 #: ../src/guestfs.pod:245
30441 " const char *parttype = \"mbr\";\n"
30442 " if (disk_is_larger_than_2TB)\n"
30443 " parttype = \"gpt\";\n"
30444 " guestfs_part_disk (g, \"/dev/sda\", parttype);\n"
30449 #: ../src/guestfs.pod:250
30451 "Obviously this effectively wipes anything that was on that disk image "
30456 #: ../src/guestfs.pod:253
30461 #: ../src/guestfs.pod:255
30463 "Libguestfs provides access to a large part of the LVM2 API, such as "
30464 "L</guestfs_lvcreate> and L</guestfs_vgremove>. It won't make much sense "
30465 "unless you familiarize yourself with the concepts of physical volumes, "
30466 "volume groups and logical volumes."
30470 #: ../src/guestfs.pod:260
30472 "This author strongly recommends reading the LVM HOWTO, online at "
30473 "L<http://tldp.org/HOWTO/LVM-HOWTO/>."
30477 #: ../src/guestfs.pod:263
30478 msgid "DOWNLOADING"
30482 #: ../src/guestfs.pod:265
30484 "Use L</guestfs_cat> to download small, text only files. This call is "
30485 "limited to files which are less than 2 MB and which cannot contain any ASCII "
30486 "NUL (C<\\0>) characters. However the API is very simple to use."
30490 #: ../src/guestfs.pod:269
30492 "L</guestfs_read_file> can be used to read files which contain arbitrary 8 "
30493 "bit data, since it returns a (pointer, size) pair. However it is still "
30494 "limited to \"small\" files, less than 2 MB."
30498 #: ../src/guestfs.pod:273
30500 "L</guestfs_download> can be used to download any file, with no limits on "
30501 "content or size (even files larger than 4 GB)."
30505 #: ../src/guestfs.pod:276
30506 msgid "To download multiple files, see L</guestfs_tar_out> and L</guestfs_tgz_out>."
30510 #: ../src/guestfs.pod:279
30515 #: ../src/guestfs.pod:281
30517 "It's often the case that you want to write a file or files to the disk "
30522 #: ../src/guestfs.pod:284
30524 "To write a small file with fixed content, use L</guestfs_write>. To create "
30525 "a file of all zeroes, use L</guestfs_truncate_size> (sparse) or "
30526 "L</guestfs_fallocate64> (with all disk blocks allocated). There are a "
30527 "variety of other functions for creating test files, for example "
30528 "L</guestfs_fill> and L</guestfs_fill_pattern>."
30532 #: ../src/guestfs.pod:290
30534 "To upload a single file, use L</guestfs_upload>. This call has no limits on "
30535 "file content or size (even files larger than 4 GB)."
30539 #: ../src/guestfs.pod:293
30540 msgid "To upload multiple files, see L</guestfs_tar_in> and L</guestfs_tgz_in>."
30544 #: ../src/guestfs.pod:295
30546 "However the fastest way to upload I<large numbers of arbitrary files> is to "
30547 "turn them into a squashfs or CD ISO (see L<mksquashfs(8)> and "
30548 "L<mkisofs(8)>), then attach this using L</guestfs_add_drive_ro>. If you add "
30549 "the drive in a predictable way (eg. adding it last after all other drives) "
30550 "then you can get the device name from L</guestfs_list_devices> and mount it "
30551 "directly using L</guestfs_mount_ro>. Note that squashfs images are "
30552 "sometimes non-portable between kernel versions, and they don't support "
30553 "labels or UUIDs. If you want to pre-build an image or you need to mount it "
30554 "using a label or UUID, use an ISO image instead."
30558 #: ../src/guestfs.pod:306
30563 #: ../src/guestfs.pod:308
30565 "There are various different commands for copying between files and devices "
30566 "and in and out of the guest filesystem. These are summarised in the table "
30571 #: ../src/guestfs.pod:314
30572 msgid "B<file> to B<file>"
30576 #: ../src/guestfs.pod:316
30578 "Use L</guestfs_cp> to copy a single file, or L</guestfs_cp_a> to copy "
30579 "directories recursively."
30583 #: ../src/guestfs.pod:319
30584 msgid "B<file or device> to B<file or device>"
30588 #: ../src/guestfs.pod:321
30590 "Use L</guestfs_dd> which efficiently uses L<dd(1)> to copy between files and "
30591 "devices in the guest."
30595 #: ../src/guestfs.pod:324
30596 msgid "Example: duplicate the contents of an LV:"
30600 #: ../src/guestfs.pod:326
30603 " guestfs_dd (g, \"/dev/VG/Original\", \"/dev/VG/Copy\");\n"
30608 #: ../src/guestfs.pod:328
30610 "The destination (C</dev/VG/Copy>) must be at least as large as the source "
30611 "(C</dev/VG/Original>). To copy less than the whole source device, use "
30612 "L</guestfs_copy_size>."
30616 #: ../src/guestfs.pod:332
30617 msgid "B<file on the host> to B<file or device>"
30621 #: ../src/guestfs.pod:334
30622 msgid "Use L</guestfs_upload>. See L</UPLOADING> above."
30626 #: ../src/guestfs.pod:336
30627 msgid "B<file or device> to B<file on the host>"
30631 #: ../src/guestfs.pod:338
30632 msgid "Use L</guestfs_download>. See L</DOWNLOADING> above."
30636 #: ../src/guestfs.pod:342
30637 msgid "UPLOADING AND DOWNLOADING TO PIPES AND FILE DESCRIPTORS"
30641 #: ../src/guestfs.pod:344
30643 "Calls like L</guestfs_upload>, L</guestfs_download>, L</guestfs_tar_in>, "
30644 "L</guestfs_tar_out> etc appear to only take filenames as arguments, so it "
30645 "appears you can only upload and download to files. However many Un*x-like "
30646 "hosts let you use the special device files C</dev/stdin>, C</dev/stdout>, "
30647 "C</dev/stderr> and C</dev/fd/N> to read and write from stdin, stdout, "
30648 "stderr, and arbitrary file descriptor N."
30652 #: ../src/guestfs.pod:352
30653 msgid "For example, L<virt-cat(1)> writes its output to stdout by doing:"
30657 #: ../src/guestfs.pod:355
30660 " guestfs_download (g, filename, \"/dev/stdout\");\n"
30665 #: ../src/guestfs.pod:357
30666 msgid "and you can write tar output to a file descriptor C<fd> by doing:"
30670 #: ../src/guestfs.pod:359
30673 " char devfd[64];\n"
30674 " snprintf (devfd, sizeof devfd, \"/dev/fd/%d\", fd);\n"
30675 " guestfs_tar_out (g, \"/\", devfd);\n"
30680 #: ../src/guestfs.pod:363
30681 msgid "LISTING FILES"
30685 #: ../src/guestfs.pod:365
30687 "L</guestfs_ll> is just designed for humans to read (mainly when using the "
30688 "L<guestfish(1)>-equivalent command C<ll>)."
30692 #: ../src/guestfs.pod:368
30694 "L</guestfs_ls> is a quick way to get a list of files in a directory from "
30695 "programs, as a flat list of strings."
30699 #: ../src/guestfs.pod:371
30701 "L</guestfs_readdir> is a programmatic way to get a list of files in a "
30702 "directory, plus additional information about each one. It is more "
30703 "equivalent to using the L<readdir(3)> call on a local filesystem."
30707 #: ../src/guestfs.pod:375
30709 "L</guestfs_find> and L</guestfs_find0> can be used to recursively list "
30714 #: ../src/guestfs.pod:378
30715 msgid "RUNNING COMMANDS"
30719 #: ../src/guestfs.pod:380
30721 "Although libguestfs is primarily an API for manipulating files inside guest "
30722 "images, we also provide some limited facilities for running commands inside "
30727 #: ../src/guestfs.pod:384
30728 msgid "There are many limitations to this:"
30732 #: ../src/guestfs.pod:390
30734 "The kernel version that the command runs under will be different from what "
30739 #: ../src/guestfs.pod:395
30741 "If the command needs to communicate with daemons, then most likely they "
30742 "won't be running."
30746 #: ../src/guestfs.pod:400
30747 msgid "The command will be running in limited memory."
30751 #: ../src/guestfs.pod:404
30753 "The network may not be available unless you enable it (see "
30754 "L</guestfs_set_network>)."
30758 #: ../src/guestfs.pod:409
30759 msgid "Only supports Linux guests (not Windows, BSD, etc)."
30763 #: ../src/guestfs.pod:413
30764 msgid "Architecture limitations (eg. won't work for a PPC guest on an X86 host)."
30768 #: ../src/guestfs.pod:418
30770 "For SELinux guests, you may need to enable SELinux and load policy first. "
30771 "See L</SELINUX> in this manpage."
30775 #: ../src/guestfs.pod:423
30777 "I<Security:> It is not safe to run commands from untrusted, possibly "
30778 "malicious guests. These commands may attempt to exploit your program by "
30779 "sending unexpected output. They could also try to exploit the Linux kernel "
30780 "or qemu provided by the libguestfs appliance. They could use the network "
30781 "provided by the libguestfs appliance to bypass ordinary network partitions "
30782 "and firewalls. They could use the elevated privileges or different SELinux "
30783 "context of your program to their advantage."
30787 #: ../src/guestfs.pod:432
30789 "A secure alternative is to use libguestfs to install a \"firstboot\" script "
30790 "(a script which runs when the guest next boots normally), and to have this "
30791 "script run the commands you want in the normal context of the running guest, "
30792 "network security and so on. For information about other security issues, "
30793 "see L</SECURITY>."
30797 #: ../src/guestfs.pod:440
30799 "The two main API calls to run commands are L</guestfs_command> and "
30800 "L</guestfs_sh> (there are also variations)."
30804 #: ../src/guestfs.pod:443
30806 "The difference is that L</guestfs_sh> runs commands using the shell, so any "
30807 "shell globs, redirections, etc will work."
30811 #: ../src/guestfs.pod:446
30812 msgid "CONFIGURATION FILES"
30816 #: ../src/guestfs.pod:448
30818 "To read and write configuration files in Linux guest filesystems, we "
30819 "strongly recommend using Augeas. For example, Augeas understands how to "
30820 "read and write, say, a Linux shadow password file or X.org configuration "
30821 "file, and so avoids you having to write that code."
30825 #: ../src/guestfs.pod:453
30827 "The main Augeas calls are bound through the C<guestfs_aug_*> APIs. We don't "
30828 "document Augeas itself here because there is excellent documentation on the "
30829 "L<http://augeas.net/> website."
30833 #: ../src/guestfs.pod:457
30835 "If you don't want to use Augeas (you fool!) then try calling "
30836 "L</guestfs_read_lines> to get the file as a list of lines which you can "
30841 #: ../src/guestfs.pod:461
30846 #: ../src/guestfs.pod:463
30848 "We support SELinux guests. To ensure that labeling happens correctly in "
30849 "SELinux guests, you need to enable SELinux and load the guest's policy:"
30853 #: ../src/guestfs.pod:471
30854 msgid "Before launching, do:"
30858 #: ../src/guestfs.pod:473
30861 " guestfs_set_selinux (g, 1);\n"
30866 #: ../src/guestfs.pod:477
30868 "After mounting the guest's filesystem(s), load the policy. This is best "
30869 "done by running the L<load_policy(8)> command in the guest itself:"
30873 #: ../src/guestfs.pod:481
30876 " guestfs_sh (g, \"/usr/sbin/load_policy\");\n"
30881 #: ../src/guestfs.pod:483
30883 "(Older versions of C<load_policy> require you to specify the name of the "
30888 #: ../src/guestfs.pod:488
30890 "Optionally, set the security context for the API. The correct security "
30891 "context to use can only be known by inspecting the guest. As an example:"
30895 #: ../src/guestfs.pod:492
30898 " guestfs_setcon (g, \"unconfined_u:unconfined_r:unconfined_t:s0\");\n"
30903 #: ../src/guestfs.pod:496
30904 msgid "This will work for running commands and editing existing files."
30908 #: ../src/guestfs.pod:498
30910 "When new files are created, you may need to label them explicitly, for "
30911 "example by running the external command C<restorecon pathname>."
30915 #: ../src/guestfs.pod:502
30920 #: ../src/guestfs.pod:504
30922 "Certain calls are affected by the current file mode creation mask (the "
30923 "\"umask\"). In particular ones which create files or directories, such as "
30924 "L</guestfs_touch>, L</guestfs_mknod> or L</guestfs_mkdir>. This affects "
30925 "either the default mode that the file is created with or modifies the mode "
30930 #: ../src/guestfs.pod:510
30932 "The default umask is C<022>, so files are created with modes such as C<0644> "
30933 "and directories with C<0755>."
30937 #: ../src/guestfs.pod:513
30939 "There are two ways to avoid being affected by umask. Either set umask to 0 "
30940 "(call C<guestfs_umask (g, 0)> early after launching). Or call "
30941 "L</guestfs_chmod> after creating each file or directory."
30945 #: ../src/guestfs.pod:517
30946 msgid "For more information about umask, see L<umask(2)>."
30950 #: ../src/guestfs.pod:521
30952 "Libguestfs allows you to access Linux guests which have been encrypted using "
30953 "whole disk encryption that conforms to the Linux Unified Key Setup (LUKS) "
30954 "standard. This includes nearly all whole disk encryption systems used by "
30955 "modern Linux guests."
30959 #: ../src/guestfs.pod:527
30961 "Use L</guestfs_vfs_type> to identify LUKS-encrypted block devices (it "
30962 "returns the string C<crypto_LUKS>)."
30966 #: ../src/guestfs.pod:530
30968 "Then open these devices by calling L</guestfs_luks_open>. Obviously you "
30969 "will require the passphrase!"
30973 #: ../src/guestfs.pod:533
30975 "Opening a LUKS device creates a new device mapper device called "
30976 "C</dev/mapper/mapname> (where C<mapname> is the string you supply to "
30977 "L</guestfs_luks_open>). Reads and writes to this mapper device are "
30978 "decrypted from and encrypted to the underlying block device respectively."
30982 #: ../src/guestfs.pod:539
30984 "LVM volume groups on the device can be made visible by calling "
30985 "L</guestfs_vgscan> followed by L</guestfs_vg_activate_all>. The logical "
30986 "volume(s) can now be mounted in the usual way."
30990 #: ../src/guestfs.pod:543
30992 "Use the reverse process to close a LUKS device. Unmount any logical volumes "
30993 "on it, deactivate the volume groups by caling C<guestfs_vg_activate (g, 0, "
30994 "[\"/dev/VG\"])>. Then close the mapper device by calling "
30995 "L</guestfs_luks_close> on the C</dev/mapper/mapname> device (I<not> the "
30996 "underlying encrypted block device)."
31000 #: ../src/guestfs.pod:550
31005 #: ../src/guestfs.pod:552
31007 "Libguestfs has APIs for inspecting an unknown disk image to find out if it "
31008 "contains operating systems, an install CD or a live CD. (These APIs used to "
31009 "be in a separate Perl-only library called L<Sys::Guestfs::Lib(3)> but since "
31010 "version 1.5.3 the most frequently used part of this library has been "
31011 "rewritten in C and moved into the core code)."
31015 #: ../src/guestfs.pod:559
31017 "Add all disks belonging to the unknown virtual machine and call "
31018 "L</guestfs_launch> in the usual way."
31022 #: ../src/guestfs.pod:562
31024 "Then call L</guestfs_inspect_os>. This function uses other libguestfs calls "
31025 "and certain heuristics, and returns a list of operating systems that were "
31026 "found. An empty list means none were found. A single element is the root "
31027 "filesystem of the operating system. For dual- or multi-boot guests, "
31028 "multiple roots can be returned, each one corresponding to a separate "
31029 "operating system. (Multi-boot virtual machines are extremely rare in the "
31030 "world of virtualization, but since this scenario can happen, we have built "
31031 "libguestfs to deal with it.)"
31035 #: ../src/guestfs.pod:571
31037 "For each root, you can then call various C<guestfs_inspect_get_*> functions "
31038 "to get additional details about that operating system. For example, call "
31039 "L</guestfs_inspect_get_type> to return the string C<windows> or C<linux> for "
31040 "Windows and Linux-based operating systems respectively."
31044 #: ../src/guestfs.pod:577
31046 "Un*x-like and Linux-based operating systems usually consist of several "
31047 "filesystems which are mounted at boot time (for example, a separate boot "
31048 "partition mounted on C</boot>). The inspection rules are able to detect how "
31049 "filesystems correspond to mount points. Call "
31050 "C<guestfs_inspect_get_mountpoints> to get this mapping. It might return a "
31051 "hash table like this example:"
31055 #: ../src/guestfs.pod:584
31058 " /boot => /dev/sda1\n"
31059 " / => /dev/vg_guest/lv_root\n"
31060 " /usr => /dev/vg_guest/lv_usr\n"
31065 #: ../src/guestfs.pod:588
31067 "The caller can then make calls to L</guestfs_mount_options> to mount the "
31068 "filesystems as suggested."
31072 #: ../src/guestfs.pod:591
31074 "Be careful to mount filesystems in the right order (eg. C</> before "
31075 "C</usr>). Sorting the keys of the hash by length, shortest first, should "
31080 #: ../src/guestfs.pod:595
31082 "Inspection currently only works for some common operating systems. "
31083 "Contributors are welcome to send patches for other operating systems that we "
31084 "currently cannot detect."
31088 #: ../src/guestfs.pod:599
31090 "Encrypted disks must be opened before inspection. See L</ENCRYPTED DISKS> "
31091 "for more details. The L</guestfs_inspect_os> function just ignores any "
31092 "encrypted devices."
31096 #: ../src/guestfs.pod:603
31098 "A note on the implementation: The call L</guestfs_inspect_os> performs "
31099 "inspection and caches the results in the guest handle. Subsequent calls to "
31100 "C<guestfs_inspect_get_*> return this cached information, but I<do not> "
31101 "re-read the disks. If you change the content of the guest disks, you can "
31102 "redo inspection by calling L</guestfs_inspect_os> again. "
31103 "(L</guestfs_inspect_list_applications> works a little differently from the "
31104 "other calls and does read the disks. See documentation for that function "
31109 #: ../src/guestfs.pod:612
31110 msgid "INSPECTING INSTALL DISKS"
31114 #: ../src/guestfs.pod:614
31116 "Libguestfs (since 1.9.4) can detect some install disks, install CDs, live "
31121 #: ../src/guestfs.pod:617
31123 "Call L</guestfs_inspect_get_format> to return the format of the operating "
31124 "system, which currently can be C<installed> (a regular operating system) or "
31125 "C<installer> (some sort of install disk)."
31129 #: ../src/guestfs.pod:621
31131 "Further information is available about the operating system that can be "
31132 "installed using the regular inspection APIs like "
31133 "L</guestfs_inspect_get_product_name>, L</guestfs_inspect_get_major_version> "
31138 #: ../src/guestfs.pod:626
31140 "Some additional information specific to installer disks is also available "
31141 "from the L</guestfs_inspect_is_live>, L</guestfs_inspect_is_netinst> and "
31142 "L</guestfs_inspect_is_multipart> calls."
31146 #: ../src/guestfs.pod:631
31147 msgid "SPECIAL CONSIDERATIONS FOR WINDOWS GUESTS"
31151 #: ../src/guestfs.pod:633
31153 "Libguestfs can mount NTFS partitions. It does this using the "
31154 "L<http://www.ntfs-3g.org/> driver."
31158 #: ../src/guestfs.pod:636
31159 msgid "DRIVE LETTERS AND PATHS"
31163 #: ../src/guestfs.pod:638
31165 "DOS and Windows still use drive letters, and the filesystems are always "
31166 "treated as case insensitive by Windows itself, and therefore you might find "
31167 "a Windows configuration file referring to a path like "
31168 "C<c:\\windows\\system32>. When the filesystem is mounted in libguestfs, "
31169 "that directory might be referred to as C</WINDOWS/System32>."
31173 #: ../src/guestfs.pod:644
31175 "Drive letter mappings can be found using inspection (see L</INSPECTION> and "
31176 "L</guestfs_inspect_get_drive_mappings>)"
31180 #: ../src/guestfs.pod:647
31182 "Dealing with separator characters (backslash vs forward slash) is outside "
31183 "the scope of libguestfs, but usually a simple character replacement will "
31188 #: ../src/guestfs.pod:651
31190 "To resolve the case insensitivity of paths, call "
31191 "L</guestfs_case_sensitive_path>."
31195 #: ../src/guestfs.pod:654
31196 msgid "ACCESSING THE WINDOWS REGISTRY"
31200 #: ../src/guestfs.pod:656
31202 "Libguestfs also provides some help for decoding Windows Registry \"hive\" "
31203 "files, through the library C<hivex> which is part of the libguestfs project "
31204 "although ships as a separate tarball. You have to locate and download the "
31205 "hive file(s) yourself, and then pass them to C<hivex> functions. See also "
31206 "the programs L<hivexml(1)>, L<hivexsh(1)>, L<hivexregedit(1)> and "
31207 "L<virt-win-reg(1)> for more help on this issue."
31211 #: ../src/guestfs.pod:664
31212 msgid "SYMLINKS ON NTFS-3G FILESYSTEMS"
31216 #: ../src/guestfs.pod:666
31218 "Ntfs-3g tries to rewrite \"Junction Points\" and NTFS \"symbolic links\" to "
31219 "provide something which looks like a Linux symlink. The way it tries to do "
31220 "the rewriting is described here:"
31224 #: ../src/guestfs.pod:670
31225 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/junction-points-and-symbolic-links/>"
31229 #: ../src/guestfs.pod:672
31231 "The essential problem is that ntfs-3g simply does not have enough "
31232 "information to do a correct job. NTFS links can contain drive letters and "
31233 "references to external device GUIDs that ntfs-3g has no way of resolving. "
31234 "It is almost certainly the case that libguestfs callers should ignore what "
31235 "ntfs-3g does (ie. don't use L</guestfs_readlink> on NTFS volumes)."
31239 #: ../src/guestfs.pod:679
31241 "Instead if you encounter a symbolic link on an ntfs-3g filesystem, use "
31242 "L</guestfs_lgetxattr> to read the C<system.ntfs_reparse_data> extended "
31243 "attribute, and read the raw reparse data from that (you can find the format "
31244 "documented in various places around the web)."
31248 #: ../src/guestfs.pod:684
31249 msgid "EXTENDED ATTRIBUTES ON NTFS-3G FILESYSTEMS"
31253 #: ../src/guestfs.pod:686
31255 "There are other useful extended attributes that can be read from ntfs-3g "
31256 "filesystems (using L</guestfs_getxattr>). See:"
31260 #: ../src/guestfs.pod:689
31261 msgid "L<http://www.tuxera.com/community/ntfs-3g-advanced/extended-attributes/>"
31265 #: ../src/guestfs.pod:691
31266 msgid "USING LIBGUESTFS WITH OTHER PROGRAMMING LANGUAGES"
31270 #: ../src/guestfs.pod:693
31272 "Although we don't want to discourage you from using the C API, we will "
31273 "mention here that the same API is also available in other languages."
31277 #: ../src/guestfs.pod:696
31279 "The API is broadly identical in all supported languages. This means that "
31280 "the C call C<guestfs_add_drive_ro(g,file)> is C<$g-E<gt>add_drive_ro($file)> "
31281 "in Perl, C<g.add_drive_ro(file)> in Python, and C<g#add_drive_ro file> in "
31282 "OCaml. In other words, a straightforward, predictable isomorphism between "
31287 #: ../src/guestfs.pod:702
31289 "Error messages are automatically transformed into exceptions if the language "
31294 #: ../src/guestfs.pod:705
31296 "We don't try to \"object orientify\" parts of the API in OO languages, "
31297 "although contributors are welcome to write higher level APIs above what we "
31298 "provide in their favourite languages if they wish."
31302 #: ../src/guestfs.pod:711
31307 #: ../src/guestfs.pod:713
31309 "You can use the I<guestfs.h> header file from C++ programs. The C++ API is "
31310 "identical to the C API. C++ classes and exceptions are not used."
31314 #: ../src/guestfs.pod:717
31319 #: ../src/guestfs.pod:719
31321 "The C# bindings are highly experimental. Please read the warnings at the "
31322 "top of C<csharp/Libguestfs.cs>."
31326 #: ../src/guestfs.pod:722
31331 #: ../src/guestfs.pod:724
31333 "This is the only language binding that is working but incomplete. Only "
31334 "calls which return simple integers have been bound in Haskell, and we are "
31335 "looking for help to complete this binding."
31339 #: ../src/guestfs.pod:728
31344 #: ../src/guestfs.pod:730
31346 "Full documentation is contained in the Javadoc which is distributed with "
31347 "libguestfs. For examples, see L<guestfs-java(3)>."
31351 #: ../src/guestfs.pod:733
31356 #: ../src/guestfs.pod:735
31357 msgid "See L<guestfs-ocaml(3)>."
31361 #: ../src/guestfs.pod:737
31366 #: ../src/guestfs.pod:739
31367 msgid "See L<guestfs-perl(3)> and L<Sys::Guestfs(3)>."
31371 #: ../src/guestfs.pod:741
31376 #: ../src/guestfs.pod:743
31378 "For documentation see C<README-PHP> supplied with libguestfs sources or in "
31379 "the php-libguestfs package for your distribution."
31383 #: ../src/guestfs.pod:746
31384 msgid "The PHP binding only works correctly on 64 bit machines."
31388 #: ../src/guestfs.pod:748
31393 #: ../src/guestfs.pod:750
31394 msgid "See L<guestfs-python(3)>."
31398 #: ../src/guestfs.pod:752
31403 #: ../src/guestfs.pod:754
31404 msgid "See L<guestfs-ruby(3)>."
31408 #: ../src/guestfs.pod:756
31409 msgid "B<shell scripts>"
31413 #: ../src/guestfs.pod:758
31414 msgid "See L<guestfish(1)>."
31418 #: ../src/guestfs.pod:762
31419 msgid "LIBGUESTFS GOTCHAS"
31423 #: ../src/guestfs.pod:764
31425 "L<http://en.wikipedia.org/wiki/Gotcha_(programming)>: \"A feature of a "
31426 "system [...] that works in the way it is documented but is counterintuitive "
31427 "and almost invites mistakes.\""
31431 #: ../src/guestfs.pod:768
31433 "Since we developed libguestfs and the associated tools, there are several "
31434 "things we would have designed differently, but are now stuck with for "
31435 "backwards compatibility or other reasons. If there is ever a libguestfs 2.0 "
31436 "release, you can expect these to change. Beware of them."
31440 #: ../src/guestfs.pod:776
31441 msgid "Autosync / forgetting to sync."
31445 #: ../src/guestfs.pod:778
31447 "I<Update:> Autosync is enabled by default for all API users starting from "
31448 "libguestfs 1.5.24. This section only applies to older versions."
31452 #: ../src/guestfs.pod:781
31454 "When modifying a filesystem from C or another language, you B<must> unmount "
31455 "all filesystems and call L</guestfs_sync> explicitly before you close the "
31456 "libguestfs handle. You can also call:"
31460 #: ../src/guestfs.pod:785
31463 " guestfs_set_autosync (g, 1);\n"
31468 #: ../src/guestfs.pod:787
31470 "to have the unmount/sync done automatically for you when the handle 'g' is "
31471 "closed. (This feature is called \"autosync\", L</guestfs_set_autosync> "
31476 #: ../src/guestfs.pod:791
31478 "If you forget to do this, then it is entirely possible that your changes "
31479 "won't be written out, or will be partially written, or (very rarely) that "
31480 "you'll get disk corruption."
31484 #: ../src/guestfs.pod:795
31486 "Note that in L<guestfish(3)> autosync is the default. So quick and dirty "
31487 "guestfish scripts that forget to sync will work just fine, which can make "
31488 "this very puzzling if you are trying to debug a problem."
31492 #: ../src/guestfs.pod:799
31493 msgid "Mount option C<-o sync> should not be the default."
31497 #: ../src/guestfs.pod:801
31499 "If you use L</guestfs_mount>, then C<-o sync,noatime> are added implicitly. "
31500 "However C<-o sync> does not add any reliability benefit, but does have a "
31501 "very large performance impact."
31505 #: ../src/guestfs.pod:805
31507 "The work around is to use L</guestfs_mount_options> and set the mount "
31508 "options that you actually want to use."
31512 #: ../src/guestfs.pod:808
31513 msgid "Read-only should be the default."
31517 #: ../src/guestfs.pod:810
31519 "In L<guestfish(3)>, I<--ro> should be the default, and you should have to "
31520 "specify I<--rw> if you want to make changes to the image."
31524 #: ../src/guestfs.pod:813
31525 msgid "This would reduce the potential to corrupt live VM images."
31529 #: ../src/guestfs.pod:815
31531 "Note that many filesystems change the disk when you just mount and unmount, "
31532 "even if you didn't perform any writes. You need to use "
31533 "L</guestfs_add_drive_ro> to guarantee that the disk is not changed."
31537 #: ../src/guestfs.pod:819
31538 msgid "guestfish command line is hard to use."
31542 #: ../src/guestfs.pod:821
31544 "C<guestfish disk.img> doesn't do what people expect (open C<disk.img> for "
31545 "examination). It tries to run a guestfish command C<disk.img> which doesn't "
31546 "exist, so it fails. In earlier versions of guestfish the error message was "
31547 "also unintuitive, but we have corrected this since. Like the Bourne shell, "
31548 "we should have used C<guestfish -c command> to run commands."
31552 #: ../src/guestfs.pod:828
31553 msgid "guestfish megabyte modifiers don't work right on all commands"
31557 #: ../src/guestfs.pod:830
31559 "In recent guestfish you can use C<1M> to mean 1 megabyte (and similarly for "
31560 "other modifiers). What guestfish actually does is to multiply the number "
31561 "part by the modifier part and pass the result to the C API. However this "
31562 "doesn't work for a few APIs which aren't expecting bytes, but are already "
31563 "expecting some other unit (eg. megabytes)."
31567 #: ../src/guestfs.pod:837
31568 msgid "The most common is L</guestfs_lvcreate>. The guestfish command:"
31572 #: ../src/guestfs.pod:839
31575 " lvcreate LV VG 100M\n"
31580 #: ../src/guestfs.pod:841
31582 "does not do what you might expect. Instead because L</guestfs_lvcreate> is "
31583 "already expecting megabytes, this tries to create a 100 I<terabyte> (100 "
31584 "megabytes * megabytes) logical volume. The error message you get from this "
31585 "is also a little obscure."
31589 #: ../src/guestfs.pod:846
31591 "This could be fixed in the generator by specially marking parameters and "
31592 "return values which take bytes or other units."
31596 #: ../src/guestfs.pod:849
31597 msgid "Ambiguity between devices and paths"
31601 #: ../src/guestfs.pod:851
31603 "There is a subtle ambiguity in the API between a device name "
31604 "(eg. C</dev/sdb2>) and a similar pathname. A file might just happen to be "
31605 "called C<sdb2> in the directory C</dev> (consider some non-Unix VM image)."
31609 #: ../src/guestfs.pod:856
31611 "In the current API we usually resolve this ambiguity by having two separate "
31612 "calls, for example L</guestfs_checksum> and L</guestfs_checksum_device>. "
31613 "Some API calls are ambiguous and (incorrectly) resolve the problem by "
31614 "detecting if the path supplied begins with C</dev/>."
31618 #: ../src/guestfs.pod:862
31620 "To avoid both the ambiguity and the need to duplicate some calls, we could "
31621 "make paths/devices into structured names. One way to do this would be to "
31622 "use a notation like grub (C<hd(0,0)>), although nobody really likes this "
31623 "aspect of grub. Another way would be to use a structured type, equivalent "
31624 "to this OCaml type:"
31628 #: ../src/guestfs.pod:868
31631 " type path = Path of string | Device of int | Partition of int * int\n"
31636 #: ../src/guestfs.pod:870
31637 msgid "which would allow you to pass arguments like:"
31641 #: ../src/guestfs.pod:872
31644 " Path \"/foo/bar\"\n"
31645 " Device 1 (* /dev/sdb, or perhaps /dev/sda *)\n"
31646 " Partition (1, 2) (* /dev/sdb2 (or is it /dev/sda2 or /dev/sdb3?) *)\n"
31647 " Path \"/dev/sdb2\" (* not a device *)\n"
31652 #: ../src/guestfs.pod:877
31654 "As you can see there are still problems to resolve even with this "
31655 "representation. Also consider how it might work in guestfish."
31659 #: ../src/guestfs.pod:882
31660 msgid "KEYS AND PASSPHRASES"
31664 #: ../src/guestfs.pod:884
31666 "Certain libguestfs calls take a parameter that contains sensitive key "
31667 "material, passed in as a C string."
31671 #: ../src/guestfs.pod:887
31673 "In the future we would hope to change the libguestfs implementation so that "
31674 "keys are L<mlock(2)>-ed into physical RAM, and thus can never end up in "
31675 "swap. However this is I<not> done at the moment, because of the complexity "
31676 "of such an implementation."
31680 #: ../src/guestfs.pod:892
31682 "Therefore you should be aware that any key parameter you pass to libguestfs "
31683 "might end up being written out to the swap partition. If this is a concern, "
31684 "scrub the swap partition or don't use libguestfs on encrypted devices."
31688 #: ../src/guestfs.pod:897
31689 msgid "MULTIPLE HANDLES AND MULTIPLE THREADS"
31693 #: ../src/guestfs.pod:899
31695 "All high-level libguestfs actions are synchronous. If you want to use "
31696 "libguestfs asynchronously then you must create a thread."
31700 #: ../src/guestfs.pod:902
31702 "Only use the handle from a single thread. Either use the handle exclusively "
31703 "from one thread, or provide your own mutex so that two threads cannot issue "
31704 "calls on the same handle at the same time."
31708 #: ../src/guestfs.pod:906
31710 "See the graphical program guestfs-browser for one possible architecture for "
31711 "multithreaded programs using libvirt and libguestfs."
31715 #: ../src/guestfs.pod:909
31720 #: ../src/guestfs.pod:911
31722 "Libguestfs needs a supermin appliance, which it finds by looking along an "
31727 #: ../src/guestfs.pod:914
31729 "By default it looks for these in the directory C<$libdir/guestfs> "
31730 "(eg. C</usr/local/lib/guestfs> or C</usr/lib64/guestfs>)."
31734 #: ../src/guestfs.pod:917
31736 "Use L</guestfs_set_path> or set the environment variable L</LIBGUESTFS_PATH> "
31737 "to change the directories that libguestfs will search in. The value is a "
31738 "colon-separated list of paths. The current directory is I<not> searched "
31739 "unless the path contains an empty element or C<.>. For example "
31740 "C<LIBGUESTFS_PATH=:/usr/lib/guestfs> would search the current directory and "
31741 "then C</usr/lib/guestfs>."
31745 #: ../src/guestfs.pod:924
31746 msgid "QEMU WRAPPERS"
31750 #: ../src/guestfs.pod:926
31752 "If you want to compile your own qemu, run qemu from a non-standard location, "
31753 "or pass extra arguments to qemu, then you can write a shell-script wrapper "
31758 #: ../src/guestfs.pod:930
31760 "There is one important rule to remember: you I<must C<exec qemu>> as the "
31761 "last command in the shell script (so that qemu replaces the shell and "
31762 "becomes the direct child of the libguestfs-using program). If you don't do "
31763 "this, then the qemu process won't be cleaned up correctly."
31767 #: ../src/guestfs.pod:935
31769 "Here is an example of a wrapper, where I have built my own copy of qemu from "
31774 #: ../src/guestfs.pod:938
31778 " qemudir=/home/rjones/d/qemu\n"
31779 " exec $qemudir/x86_64-softmmu/qemu-system-x86_64 -L $qemudir/pc-bios "
31785 #: ../src/guestfs.pod:942
31787 "Save this script as C</tmp/qemu.wrapper> (or wherever), C<chmod +x>, and "
31788 "then use it by setting the LIBGUESTFS_QEMU environment variable. For "
31793 #: ../src/guestfs.pod:946
31796 " LIBGUESTFS_QEMU=/tmp/qemu.wrapper guestfish\n"
31801 #: ../src/guestfs.pod:948
31803 "Note that libguestfs also calls qemu with the -help and -version options in "
31804 "order to determine features."
31808 #: ../src/guestfs.pod:951
31809 msgid "ATTACHING TO RUNNING DAEMONS"
31813 #: ../src/guestfs.pod:953
31815 "I<Note (1):> This is B<highly experimental> and has a tendency to eat "
31816 "babies. Use with caution."
31820 #: ../src/guestfs.pod:956
31822 "I<Note (2):> This section explains how to attach to a running daemon from a "
31823 "low level perspective. For most users, simply using virt tools such as "
31824 "L<guestfish(1)> with the I<--live> option will \"just work\"."
31828 #: ../src/guestfs.pod:960
31829 msgid "Using guestfs_set_attach_method"
31833 #: ../src/guestfs.pod:962
31835 "By calling L</guestfs_set_attach_method> you can change how the library "
31836 "connects to the C<guestfsd> daemon in L</guestfs_launch> (read "
31837 "L</ARCHITECTURE> for some background)."
31841 #: ../src/guestfs.pod:966
31843 "The normal attach method is C<appliance>, where a small appliance is created "
31844 "containing the daemon, and then the library connects to this."
31848 #: ../src/guestfs.pod:969
31850 "Setting attach method to C<unix:I<path>> (where I<path> is the path of a "
31851 "Unix domain socket) causes L</guestfs_launch> to connect to an existing "
31852 "daemon over the Unix domain socket."
31856 #: ../src/guestfs.pod:973
31858 "The normal use for this is to connect to a running virtual machine that "
31859 "contains a C<guestfsd> daemon, and send commands so you can read and write "
31860 "files inside the live virtual machine."
31864 #: ../src/guestfs.pod:977
31865 msgid "Using guestfs_add_domain with live flag"
31869 #: ../src/guestfs.pod:979
31871 "L</guestfs_add_domain> provides some help for getting the correct attach "
31872 "method. If you pass the C<live> option to this function, then (if the "
31873 "virtual machine is running) it will examine the libvirt XML looking for a "
31874 "virtio-serial channel to connect to:"
31878 #: ../src/guestfs.pod:985
31885 " <channel type='unix'>\n"
31886 " <source mode='bind' path='/path/to/socket'/>\n"
31887 " <target type='virtio' name='org.libguestfs.channel.0'/>\n"
31896 #: ../src/guestfs.pod:997
31898 "L</guestfs_add_domain> extracts C</path/to/socket> and sets the attach "
31899 "method to C<unix:/path/to/socket>."
31903 #: ../src/guestfs.pod:1000
31905 "Some of the libguestfs tools (including guestfish) support a I<--live> "
31906 "option which is passed through to L</guestfs_add_domain> thus allowing you "
31907 "to attach to and modify live virtual machines."
31911 #: ../src/guestfs.pod:1004
31913 "The virtual machine needs to have been set up beforehand so that it has the "
31914 "virtio-serial channel and so that guestfsd is running inside it."
31918 #: ../src/guestfs.pod:1008
31919 msgid "ABI GUARANTEE"
31923 #: ../src/guestfs.pod:1010
31925 "We guarantee the libguestfs ABI (binary interface), for public, high-level "
31926 "actions as outlined in this section. Although we will deprecate some "
31927 "actions, for example if they get replaced by newer calls, we will keep the "
31928 "old actions forever. This allows you the developer to program in confidence "
31929 "against the libguestfs API."
31933 #: ../src/guestfs.pod:1016
31934 msgid "BLOCK DEVICE NAMING"
31938 #: ../src/guestfs.pod:1018
31940 "In the kernel there is now quite a profusion of schemata for naming block "
31941 "devices (in this context, by I<block device> I mean a physical or virtual "
31942 "hard drive). The original Linux IDE driver used names starting with "
31943 "C</dev/hd*>. SCSI devices have historically used a different naming scheme, "
31944 "C</dev/sd*>. When the Linux kernel I<libata> driver became a popular "
31945 "replacement for the old IDE driver (particularly for SATA devices) those "
31946 "devices also used the C</dev/sd*> scheme. Additionally we now have virtual "
31947 "machines with paravirtualized drivers. This has created several different "
31948 "naming systems, such as C</dev/vd*> for virtio disks and C</dev/xvd*> for "
31953 #: ../src/guestfs.pod:1030
31955 "As discussed above, libguestfs uses a qemu appliance running an embedded "
31956 "Linux kernel to access block devices. We can run a variety of appliances "
31957 "based on a variety of Linux kernels."
31961 #: ../src/guestfs.pod:1034
31963 "This causes a problem for libguestfs because many API calls use device or "
31964 "partition names. Working scripts and the recipe (example) scripts that we "
31965 "make available over the internet could fail if the naming scheme changes."
31969 #: ../src/guestfs.pod:1039
31971 "Therefore libguestfs defines C</dev/sd*> as the I<standard naming scheme>. "
31972 "Internally C</dev/sd*> names are translated, if necessary, to other names as "
31973 "required. For example, under RHEL 5 which uses the C</dev/hd*> scheme, any "
31974 "device parameter C</dev/sda2> is translated to C</dev/hda2> transparently."
31978 #: ../src/guestfs.pod:1045
31980 "Note that this I<only> applies to parameters. The L</guestfs_list_devices>, "
31981 "L</guestfs_list_partitions> and similar calls return the true names of the "
31982 "devices and partitions as known to the appliance."
31986 #: ../src/guestfs.pod:1050
31987 msgid "ALGORITHM FOR BLOCK DEVICE NAME TRANSLATION"
31991 #: ../src/guestfs.pod:1052
31993 "Usually this translation is transparent. However in some (very rare) cases "
31994 "you may need to know the exact algorithm. Such cases include where you use "
31995 "L</guestfs_config> to add a mixture of virtio and IDE devices to the "
31996 "qemu-based appliance, so have a mixture of C</dev/sd*> and C</dev/vd*> "
32001 #: ../src/guestfs.pod:1058
32003 "The algorithm is applied only to I<parameters> which are known to be either "
32004 "device or partition names. Return values from functions such as "
32005 "L</guestfs_list_devices> are never changed."
32009 #: ../src/guestfs.pod:1066
32010 msgid "Is the string a parameter which is a device or partition name?"
32014 #: ../src/guestfs.pod:1070
32015 msgid "Does the string begin with C</dev/sd>?"
32019 #: ../src/guestfs.pod:1074
32021 "Does the named device exist? If so, we use that device. However if I<not> "
32022 "then we continue with this algorithm."
32026 #: ../src/guestfs.pod:1079
32027 msgid "Replace initial C</dev/sd> string with C</dev/hd>."
32031 #: ../src/guestfs.pod:1081
32032 msgid "For example, change C</dev/sda2> to C</dev/hda2>."
32036 #: ../src/guestfs.pod:1083
32037 msgid "If that named device exists, use it. If not, continue."
32041 #: ../src/guestfs.pod:1087
32042 msgid "Replace initial C</dev/sd> string with C</dev/vd>."
32046 #: ../src/guestfs.pod:1089
32047 msgid "If that named device exists, use it. If not, return an error."
32051 #: ../src/guestfs.pod:1093
32052 msgid "PORTABILITY CONCERNS WITH BLOCK DEVICE NAMING"
32056 #: ../src/guestfs.pod:1095
32058 "Although the standard naming scheme and automatic translation is useful for "
32059 "simple programs and guestfish scripts, for larger programs it is best not to "
32060 "rely on this mechanism."
32064 #: ../src/guestfs.pod:1099
32066 "Where possible for maximum future portability programs using libguestfs "
32067 "should use these future-proof techniques:"
32071 #: ../src/guestfs.pod:1106
32073 "Use L</guestfs_list_devices> or L</guestfs_list_partitions> to list actual "
32074 "device names, and then use those names directly."
32078 #: ../src/guestfs.pod:1109
32079 msgid "Since those device names exist by definition, they will never be translated."
32083 #: ../src/guestfs.pod:1114
32085 "Use higher level ways to identify filesystems, such as LVM names, UUIDs and "
32086 "filesystem labels."
32090 #: ../src/guestfs.pod:1119
32095 #: ../src/guestfs.pod:1121
32097 "This section discusses security implications of using libguestfs, "
32098 "particularly with untrusted or malicious guests or disk images."
32102 #: ../src/guestfs.pod:1124
32103 msgid "GENERAL SECURITY CONSIDERATIONS"
32107 #: ../src/guestfs.pod:1126
32109 "Be careful with any files or data that you download from a guest (by "
32110 "\"download\" we mean not just the L</guestfs_download> command but any "
32111 "command that reads files, filenames, directories or anything else from a "
32112 "disk image). An attacker could manipulate the data to fool your program "
32113 "into doing the wrong thing. Consider cases such as:"
32117 #: ../src/guestfs.pod:1136
32118 msgid "the data (file etc) not being present"
32122 #: ../src/guestfs.pod:1140
32123 msgid "being present but empty"
32127 #: ../src/guestfs.pod:1144
32128 msgid "being much larger than normal"
32132 #: ../src/guestfs.pod:1148
32133 msgid "containing arbitrary 8 bit data"
32137 #: ../src/guestfs.pod:1152
32138 msgid "being in an unexpected character encoding"
32142 #: ../src/guestfs.pod:1156
32143 msgid "containing homoglyphs."
32147 #: ../src/guestfs.pod:1160
32148 msgid "SECURITY OF MOUNTING FILESYSTEMS"
32152 #: ../src/guestfs.pod:1162
32154 "When you mount a filesystem under Linux, mistakes in the kernel filesystem "
32155 "(VFS) module can sometimes be escalated into exploits by deliberately "
32156 "creating a malicious, malformed filesystem. These exploits are very severe "
32157 "for two reasons. Firstly there are very many filesystem drivers in the "
32158 "kernel, and many of them are infrequently used and not much developer "
32159 "attention has been paid to the code. Linux userspace helps potential "
32160 "crackers by detecting the filesystem type and automatically choosing the "
32161 "right VFS driver, even if that filesystem type is obscure or unexpected for "
32162 "the administrator. Secondly, a kernel-level exploit is like a local root "
32163 "exploit (worse in some ways), giving immediate and total access to the "
32164 "system right down to the hardware level."
32168 #: ../src/guestfs.pod:1175
32170 "That explains why you should never mount a filesystem from an untrusted "
32171 "guest on your host kernel. How about libguestfs? We run a Linux kernel "
32172 "inside a qemu virtual machine, usually running as a non-root user. The "
32173 "attacker would need to write a filesystem which first exploited the kernel, "
32174 "and then exploited either qemu virtualization (eg. a faulty qemu driver) or "
32175 "the libguestfs protocol, and finally to be as serious as the host kernel "
32176 "exploit it would need to escalate its privileges to root. This multi-step "
32177 "escalation, performed by a static piece of data, is thought to be extremely "
32178 "hard to do, although we never say 'never' about security issues."
32182 #: ../src/guestfs.pod:1186
32184 "In any case callers can reduce the attack surface by forcing the filesystem "
32185 "type when mounting (use L</guestfs_mount_vfs>)."
32189 #: ../src/guestfs.pod:1189
32190 msgid "PROTOCOL SECURITY"
32194 #: ../src/guestfs.pod:1191
32196 "The protocol is designed to be secure, being based on RFC 4506 (XDR) with a "
32197 "defined upper message size. However a program that uses libguestfs must "
32198 "also take care - for example you can write a program that downloads a binary "
32199 "from a disk image and executes it locally, and no amount of protocol "
32200 "security will save you from the consequences."
32204 #: ../src/guestfs.pod:1197
32205 msgid "INSPECTION SECURITY"
32209 #: ../src/guestfs.pod:1199
32211 "Parts of the inspection API (see L</INSPECTION>) return untrusted strings "
32212 "directly from the guest, and these could contain any 8 bit data. Callers "
32213 "should be careful to escape these before printing them to a structured file "
32214 "(for example, use HTML escaping if creating a web page)."
32218 #: ../src/guestfs.pod:1205
32220 "Guest configuration may be altered in unusual ways by the administrator of "
32221 "the virtual machine, and may not reflect reality (particularly for untrusted "
32222 "or actively malicious guests). For example we parse the hostname from "
32223 "configuration files like C</etc/sysconfig/network> that we find in the "
32224 "guest, but the guest administrator can easily manipulate these files to "
32225 "provide the wrong hostname."
32229 #: ../src/guestfs.pod:1213
32231 "The inspection API parses guest configuration using two external libraries: "
32232 "Augeas (Linux configuration) and hivex (Windows Registry). Both are "
32233 "designed to be robust in the face of malicious data, although denial of "
32234 "service attacks are still possible, for example with oversized configuration "
32239 #: ../src/guestfs.pod:1219
32240 msgid "RUNNING UNTRUSTED GUEST COMMANDS"
32244 #: ../src/guestfs.pod:1221
32246 "Be very cautious about running commands from the guest. By running a "
32247 "command in the guest, you are giving CPU time to a binary that you do not "
32248 "control, under the same user account as the library, albeit wrapped in qemu "
32249 "virtualization. More information and alternatives can be found in the "
32250 "section L</RUNNING COMMANDS>."
32254 #: ../src/guestfs.pod:1227
32255 msgid "CVE-2010-3851"
32259 #: ../src/guestfs.pod:1229
32260 msgid "https://bugzilla.redhat.com/642934"
32264 #: ../src/guestfs.pod:1231
32266 "This security bug concerns the automatic disk format detection that qemu "
32267 "does on disk images."
32271 #: ../src/guestfs.pod:1234
32273 "A raw disk image is just the raw bytes, there is no header. Other disk "
32274 "images like qcow2 contain a special header. Qemu deals with this by looking "
32275 "for one of the known headers, and if none is found then assuming the disk "
32276 "image must be raw."
32280 #: ../src/guestfs.pod:1239
32282 "This allows a guest which has been given a raw disk image to write some "
32283 "other header. At next boot (or when the disk image is accessed by "
32284 "libguestfs) qemu would do autodetection and think the disk image format was, "
32285 "say, qcow2 based on the header written by the guest."
32289 #: ../src/guestfs.pod:1244
32291 "This in itself would not be a problem, but qcow2 offers many features, one "
32292 "of which is to allow a disk image to refer to another image (called the "
32293 "\"backing disk\"). It does this by placing the path to the backing disk "
32294 "into the qcow2 header. This path is not validated and could point to any "
32295 "host file (eg. \"/etc/passwd\"). The backing disk is then exposed through "
32296 "\"holes\" in the qcow2 disk image, which of course is completely under the "
32297 "control of the attacker."
32301 #: ../src/guestfs.pod:1252
32302 msgid "In libguestfs this is rather hard to exploit except under two circumstances:"
32306 #: ../src/guestfs.pod:1259
32307 msgid "You have enabled the network or have opened the disk in write mode."
32311 #: ../src/guestfs.pod:1263
32313 "You are also running untrusted code from the guest (see L</RUNNING "
32318 #: ../src/guestfs.pod:1268
32320 "The way to avoid this is to specify the expected disk format when adding "
32321 "disks (the optional C<format> option to L</guestfs_add_drive_opts>). You "
32322 "should always do this if the disk is raw format, and it's a good idea for "
32327 #: ../src/guestfs.pod:1273
32329 "For disks added from libvirt using calls like L</guestfs_add_domain>, the "
32330 "format is fetched from libvirt and passed through."
32334 #: ../src/guestfs.pod:1276
32336 "For libguestfs tools, use the I<--format> command line parameter as "
32341 #: ../src/guestfs.pod:1279
32342 msgid "CONNECTION MANAGEMENT"
32346 #: ../src/guestfs.pod:1281
32347 msgid "guestfs_h *"
32351 #: ../src/guestfs.pod:1283
32353 "C<guestfs_h> is the opaque type representing a connection handle. Create a "
32354 "handle by calling L</guestfs_create>. Call L</guestfs_close> to free the "
32355 "handle and release all resources used."
32359 #: ../src/guestfs.pod:1287
32361 "For information on using multiple handles and threads, see the section "
32362 "L</MULTIPLE HANDLES AND MULTIPLE THREADS> above."
32366 #: ../src/guestfs.pod:1290
32367 msgid "guestfs_create"
32371 #: ../src/guestfs.pod:1292
32374 " guestfs_h *guestfs_create (void);\n"
32379 #: ../src/guestfs.pod:1294
32380 msgid "Create a connection handle."
32384 #: ../src/guestfs.pod:1296
32386 "On success this returns a non-NULL pointer to a handle. On error it returns "
32391 #: ../src/guestfs.pod:1299
32393 "You have to \"configure\" the handle after creating it. This includes "
32394 "calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on the "
32395 "handle at least once."
32399 #: ../src/guestfs.pod:1303
32400 msgid "After configuring the handle, you have to call L</guestfs_launch>."
32404 #: ../src/guestfs.pod:1305
32406 "You may also want to configure error handling for the handle. See the "
32407 "L</ERROR HANDLING> section below."
32411 #: ../src/guestfs.pod:1308
32412 msgid "guestfs_close"
32416 #: ../src/guestfs.pod:1310
32419 " void guestfs_close (guestfs_h *g);\n"
32424 #: ../src/guestfs.pod:1312
32425 msgid "This closes the connection handle and frees up all resources used."
32429 #: ../src/guestfs.pod:1314
32431 "If autosync was set on the handle and the handle was launched, then this "
32432 "implicitly calls various functions to unmount filesystems and sync the "
32433 "disk. See L</guestfs_set_autosync> for more details."
32437 #: ../src/guestfs.pod:1318
32438 msgid "If a close callback was set on the handle, then it is called."
32442 #: ../src/guestfs.pod:1320
32443 msgid "ERROR HANDLING"
32447 #: ../src/guestfs.pod:1322
32449 "API functions can return errors. For example, almost all functions that "
32450 "return C<int> will return C<-1> to indicate an error."
32454 #: ../src/guestfs.pod:1325
32456 "Additional information is available for errors: an error message string and "
32457 "optionally an error number (errno) if the thing that failed was a system "
32462 #: ../src/guestfs.pod:1329
32464 "You can get at the additional information about the last error on the handle "
32465 "by calling L</guestfs_last_error>, L</guestfs_last_errno>, and/or by setting "
32466 "up an error handler with L</guestfs_set_error_handler>."
32470 #: ../src/guestfs.pod:1334
32472 "When the handle is created, a default error handler is installed which "
32473 "prints the error message string to C<stderr>. For small short-running "
32474 "command line programs it is sufficient to do:"
32478 #: ../src/guestfs.pod:1338
32481 " if (guestfs_launch (g) == -1)\n"
32482 " exit (EXIT_FAILURE);\n"
32487 #: ../src/guestfs.pod:1341
32489 "since the default error handler will ensure that an error message has been "
32490 "printed to C<stderr> before the program exits."
32494 #: ../src/guestfs.pod:1344
32496 "For other programs the caller will almost certainly want to install an "
32497 "alternate error handler or do error handling in-line like this:"
32501 #: ../src/guestfs.pod:1347
32504 " g = guestfs_create ();\n"
32509 #: ../src/guestfs.pod:1349
32512 " /* This disables the default behaviour of printing errors\n"
32514 " guestfs_set_error_handler (g, NULL, NULL);\n"
32519 #: ../src/guestfs.pod:1353
32522 " if (guestfs_launch (g) == -1) {\n"
32523 " /* Examine the error message and print it etc. */\n"
32524 " char *msg = guestfs_last_error (g);\n"
32525 " int errnum = guestfs_last_errno (g);\n"
32526 " fprintf (stderr, \"%s\\n\", msg);\n"
32533 #: ../src/guestfs.pod:1361
32535 "Out of memory errors are handled differently. The default action is to call "
32536 "L<abort(3)>. If this is undesirable, then you can set a handler using "
32537 "L</guestfs_set_out_of_memory_handler>."
32541 #: ../src/guestfs.pod:1365
32543 "L</guestfs_create> returns C<NULL> if the handle cannot be created, and "
32544 "because there is no handle if this happens there is no way to get additional "
32545 "error information. However L</guestfs_create> is supposed to be a "
32546 "lightweight operation which can only fail because of insufficient memory (it "
32547 "returns NULL in this case)."
32551 #: ../src/guestfs.pod:1371
32552 msgid "guestfs_last_error"
32556 #: ../src/guestfs.pod:1373
32559 " const char *guestfs_last_error (guestfs_h *g);\n"
32564 #: ../src/guestfs.pod:1375
32566 "This returns the last error message that happened on C<g>. If there has not "
32567 "been an error since the handle was created, then this returns C<NULL>."
32571 #: ../src/guestfs.pod:1379
32573 "The lifetime of the returned string is until the next error occurs, or "
32574 "L</guestfs_close> is called."
32578 #: ../src/guestfs.pod:1382
32579 msgid "guestfs_last_errno"
32583 #: ../src/guestfs.pod:1384
32586 " int guestfs_last_errno (guestfs_h *g);\n"
32591 #: ../src/guestfs.pod:1386
32592 msgid "This returns the last error number (errno) that happened on C<g>."
32596 #: ../src/guestfs.pod:1388
32597 msgid "If successful, an errno integer not equal to zero is returned."
32601 #: ../src/guestfs.pod:1390
32602 msgid "If no error, this returns 0. This call can return 0 in three situations:"
32606 #: ../src/guestfs.pod:1397
32607 msgid "There has not been any error on the handle."
32611 #: ../src/guestfs.pod:1401
32613 "There has been an error but the errno was meaningless. This corresponds to "
32614 "the case where the error did not come from a failed system call, but for "
32615 "some other reason."
32619 #: ../src/guestfs.pod:1407
32621 "There was an error from a failed system call, but for some reason the errno "
32622 "was not captured and returned. This usually indicates a bug in libguestfs."
32626 #: ../src/guestfs.pod:1413
32628 "Libguestfs tries to convert the errno from inside the applicance into a "
32629 "corresponding errno for the caller (not entirely trivial: the appliance "
32630 "might be running a completely different operating system from the library "
32631 "and error numbers are not standardized across Un*xen). If this could not be "
32632 "done, then the error is translated to C<EINVAL>. In practice this should "
32633 "only happen in very rare circumstances."
32637 #: ../src/guestfs.pod:1421
32638 msgid "guestfs_set_error_handler"
32642 #: ../src/guestfs.pod:1423
32645 " typedef void (*guestfs_error_handler_cb) (guestfs_h *g,\n"
32647 " const char *msg);\n"
32648 " void guestfs_set_error_handler (guestfs_h *g,\n"
32649 " guestfs_error_handler_cb cb,\n"
32650 " void *opaque);\n"
32655 #: ../src/guestfs.pod:1430
32657 "The callback C<cb> will be called if there is an error. The parameters "
32658 "passed to the callback are an opaque data pointer and the error message "
32663 #: ../src/guestfs.pod:1434
32665 "C<errno> is not passed to the callback. To get that the callback must call "
32666 "L</guestfs_last_errno>."
32670 #: ../src/guestfs.pod:1437
32672 "Note that the message string C<msg> is freed as soon as the callback "
32673 "function returns, so if you want to stash it somewhere you must make your "
32678 #: ../src/guestfs.pod:1441
32679 msgid "The default handler prints messages on C<stderr>."
32683 #: ../src/guestfs.pod:1443
32684 msgid "If you set C<cb> to C<NULL> then I<no> handler is called."
32688 #: ../src/guestfs.pod:1445
32689 msgid "guestfs_get_error_handler"
32693 #: ../src/guestfs.pod:1447
32696 " guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g,\n"
32697 " void **opaque_rtn);\n"
32702 #: ../src/guestfs.pod:1450
32703 msgid "Returns the current error handler callback."
32707 #: ../src/guestfs.pod:1452
32708 msgid "guestfs_set_out_of_memory_handler"
32712 #: ../src/guestfs.pod:1454
32715 " typedef void (*guestfs_abort_cb) (void);\n"
32716 " void guestfs_set_out_of_memory_handler (guestfs_h *g,\n"
32717 " guestfs_abort_cb);\n"
32722 #: ../src/guestfs.pod:1458
32724 "The callback C<cb> will be called if there is an out of memory situation. "
32725 "I<Note this callback must not return>."
32729 #: ../src/guestfs.pod:1461
32730 msgid "The default is to call L<abort(3)>."
32734 #: ../src/guestfs.pod:1463
32735 msgid "You cannot set C<cb> to C<NULL>. You can't ignore out of memory situations."
32739 #: ../src/guestfs.pod:1466
32740 msgid "guestfs_get_out_of_memory_handler"
32744 #: ../src/guestfs.pod:1468
32747 " guestfs_abort_fn guestfs_get_out_of_memory_handler (guestfs_h *g);\n"
32752 #: ../src/guestfs.pod:1470
32753 msgid "This returns the current out of memory handler."
32757 #: ../src/guestfs.pod:1472
32762 #: ../src/guestfs.pod:1476
32767 #: ../src/guestfs.pod:1478
32772 #: ../src/guestfs.pod:1480
32773 msgid "AVAILABILITY"
32777 #: ../src/guestfs.pod:1482
32778 msgid "GROUPS OF FUNCTIONALITY IN THE APPLIANCE"
32782 #: ../src/guestfs.pod:1484
32784 "Using L</guestfs_available> you can test availability of the following "
32785 "groups of functions. This test queries the appliance to see if the "
32786 "appliance you are currently using supports the functionality."
32790 #: ../src/guestfs.pod:1489
32791 msgid "@AVAILABILITY@"
32795 #: ../src/guestfs.pod:1491
32796 msgid "GUESTFISH supported COMMAND"
32800 #: ../src/guestfs.pod:1493
32802 "In L<guestfish(3)> there is a handy interactive command C<supported> which "
32803 "prints out the available groups and whether they are supported by this build "
32804 "of libguestfs. Note however that you have to do C<run> first."
32808 #: ../src/guestfs.pod:1498
32809 msgid "SINGLE CALLS AT COMPILE TIME"
32813 #: ../src/guestfs.pod:1500
32815 "Since version 1.5.8, C<E<lt>guestfs.hE<gt>> defines symbols for each C API "
32816 "function, such as:"
32820 #: ../src/guestfs.pod:1503
32823 " #define LIBGUESTFS_HAVE_DD 1\n"
32828 #: ../src/guestfs.pod:1505
32829 msgid "if L</guestfs_dd> is available."
32833 #: ../src/guestfs.pod:1507
32835 "Before version 1.5.8, if you needed to test whether a single libguestfs "
32836 "function is available at compile time, we recommended using build tools such "
32837 "as autoconf or cmake. For example in autotools you could use:"
32841 #: ../src/guestfs.pod:1512
32844 " AC_CHECK_LIB([guestfs],[guestfs_create])\n"
32845 " AC_CHECK_FUNCS([guestfs_dd])\n"
32850 #: ../src/guestfs.pod:1515
32852 "which would result in C<HAVE_GUESTFS_DD> being either defined or not defined "
32857 #: ../src/guestfs.pod:1518
32858 msgid "SINGLE CALLS AT RUN TIME"
32862 #: ../src/guestfs.pod:1520
32864 "Testing at compile time doesn't guarantee that a function really exists in "
32865 "the library. The reason is that you might be dynamically linked against a "
32866 "previous I<libguestfs.so> (dynamic library) which doesn't have the call. "
32867 "This situation unfortunately results in a segmentation fault, which is a "
32868 "shortcoming of the C dynamic linking system itself."
32872 #: ../src/guestfs.pod:1527
32874 "You can use L<dlopen(3)> to test if a function is available at run time, as "
32875 "in this example program (note that you still need the compile time check as "
32880 #: ../src/guestfs.pod:1531
32883 " #include <stdio.h>\n"
32884 " #include <stdlib.h>\n"
32885 " #include <unistd.h>\n"
32886 " #include <dlfcn.h>\n"
32887 " #include <guestfs.h>\n"
32892 #: ../src/guestfs.pod:1537
32897 " #ifdef LIBGUESTFS_HAVE_DD\n"
32899 " int has_function;\n"
32904 #: ../src/guestfs.pod:1543
32907 " /* Test if the function guestfs_dd is really available. */\n"
32908 " dl = dlopen (NULL, RTLD_LAZY);\n"
32910 " fprintf (stderr, \"dlopen: %s\\n\", dlerror ());\n"
32911 " exit (EXIT_FAILURE);\n"
32913 " has_function = dlsym (dl, \"guestfs_dd\") != NULL;\n"
32919 #: ../src/guestfs.pod:1552
32922 " if (!has_function)\n"
32923 " printf (\"this libguestfs.so does NOT have guestfs_dd function\\n\");\n"
32925 " printf (\"this libguestfs.so has guestfs_dd function\\n\");\n"
32926 " /* Now it's safe to call\n"
32927 " guestfs_dd (g, \"foo\", \"bar\");\n"
32931 " printf (\"guestfs_dd function was not found at compile time\\n\");\n"
32938 #: ../src/guestfs.pod:1565
32940 "You may think the above is an awful lot of hassle, and it is. There are "
32941 "other ways outside of the C linking system to ensure that this kind of "
32942 "incompatibility never arises, such as using package versioning:"
32946 #: ../src/guestfs.pod:1570
32949 " Requires: libguestfs >= 1.0.80\n"
32954 #: ../src/guestfs.pod:1572
32955 msgid "CALLS WITH OPTIONAL ARGUMENTS"
32959 #: ../src/guestfs.pod:1574
32961 "A recent feature of the API is the introduction of calls which take optional "
32962 "arguments. In C these are declared 3 ways. The main way is as a call which "
32963 "takes variable arguments (ie. C<...>), as in this example:"
32967 #: ../src/guestfs.pod:1579
32970 " int guestfs_add_drive_opts (guestfs_h *g, const char *filename, ...);\n"
32975 #: ../src/guestfs.pod:1581
32977 "Call this with a list of optional arguments, terminated by C<-1>. So to "
32978 "call with no optional arguments specified:"
32982 #: ../src/guestfs.pod:1584
32985 " guestfs_add_drive_opts (g, filename, -1);\n"
32990 #: ../src/guestfs.pod:1586
32991 msgid "With a single optional argument:"
32995 #: ../src/guestfs.pod:1588
32998 " guestfs_add_drive_opts (g, filename,\n"
32999 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33005 #: ../src/guestfs.pod:1592
33010 #: ../src/guestfs.pod:1594
33013 " guestfs_add_drive_opts (g, filename,\n"
33014 " GUESTFS_ADD_DRIVE_OPTS_FORMAT, \"qcow2\",\n"
33015 " GUESTFS_ADD_DRIVE_OPTS_READONLY, 1,\n"
33021 #: ../src/guestfs.pod:1599
33023 "and so forth. Don't forget the terminating C<-1> otherwise Bad Things will "
33028 #: ../src/guestfs.pod:1602
33029 msgid "USING va_list FOR OPTIONAL ARGUMENTS"
33033 #: ../src/guestfs.pod:1604
33035 "The second variant has the same name with the suffix C<_va>, which works the "
33036 "same way but takes a C<va_list>. See the C manual for details. For the "
33037 "example function, this is declared:"
33041 #: ../src/guestfs.pod:1608
33044 " int guestfs_add_drive_opts_va (guestfs_h *g, const char *filename,\n"
33045 " va_list args);\n"
33050 #: ../src/guestfs.pod:1611
33051 msgid "CONSTRUCTING OPTIONAL ARGUMENTS"
33055 #: ../src/guestfs.pod:1613
33057 "The third variant is useful where you need to construct these calls. You "
33058 "pass in a structure where you fill in the optional fields. The structure "
33059 "has a bitmask as the first element which you must set to indicate which "
33060 "fields you have filled in. For our example function the structure and call "
33065 #: ../src/guestfs.pod:1619
33068 " struct guestfs_add_drive_opts_argv {\n"
33069 " uint64_t bitmask;\n"
33071 " const char *format;\n"
33074 " int guestfs_add_drive_opts_argv (guestfs_h *g, const char *filename,\n"
33075 " const struct guestfs_add_drive_opts_argv *optargs);\n"
33080 #: ../src/guestfs.pod:1628
33081 msgid "You could call it like this:"
33085 #: ../src/guestfs.pod:1630
33088 " struct guestfs_add_drive_opts_argv optargs = {\n"
33089 " .bitmask = GUESTFS_ADD_DRIVE_OPTS_READONLY_BITMASK |\n"
33090 " GUESTFS_ADD_DRIVE_OPTS_FORMAT_BITMASK,\n"
33091 " .readonly = 1,\n"
33092 " .format = \"qcow2\"\n"
33098 #: ../src/guestfs.pod:1637
33101 " guestfs_add_drive_opts_argv (g, filename, &optargs);\n"
33106 #: ../src/guestfs.pod:1645
33107 msgid "The C<_BITMASK> suffix on each option name when specifying the bitmask."
33111 #: ../src/guestfs.pod:1650
33112 msgid "You do not need to fill in all fields of the structure."
33116 #: ../src/guestfs.pod:1654
33118 "There must be a one-to-one correspondence between fields of the structure "
33119 "that are filled in, and bits set in the bitmask."
33123 #: ../src/guestfs.pod:1659
33124 msgid "OPTIONAL ARGUMENTS IN OTHER LANGUAGES"
33128 #: ../src/guestfs.pod:1661
33130 "In other languages, optional arguments are expressed in the way that is "
33131 "natural for that language. We refer you to the language-specific "
33132 "documentation for more details on that."
33136 #: ../src/guestfs.pod:1665
33137 msgid "For guestfish, see L<guestfish(1)/OPTIONAL ARGUMENTS>."
33141 #: ../src/guestfs.pod:1667
33142 msgid "SETTING CALLBACKS TO HANDLE EVENTS"
33146 #: ../src/guestfs.pod:1669
33148 "B<Note:> This section documents the generic event mechanism introduced in "
33149 "libguestfs 1.10, which you should use in new code if possible. The old "
33150 "functions C<guestfs_set_log_message_callback>, "
33151 "C<guestfs_set_subprocess_quit_callback>, "
33152 "C<guestfs_set_launch_done_callback>, C<guestfs_set_close_callback> and "
33153 "C<guestfs_set_progress_callback> are no longer documented in this manual "
33154 "page. Because of the ABI guarantee, the old functions continue to work."
33158 #: ../src/guestfs.pod:1678
33160 "Handles generate events when certain things happen, such as log messages "
33161 "being generated, progress messages during long-running operations, or the "
33162 "handle being closed. The API calls described below let you register a "
33163 "callback to be called when events happen. You can register multiple "
33164 "callbacks (for the same, different or overlapping sets of events), and "
33165 "individually remove callbacks. If callbacks are not removed, then they "
33166 "remain in force until the handle is closed."
33170 #: ../src/guestfs.pod:1686
33172 "In the current implementation, events are only generated synchronously: that "
33173 "means that events (and hence callbacks) can only happen while you are in the "
33174 "middle of making another libguestfs call. The callback is called in the "
33179 #: ../src/guestfs.pod:1691
33181 "Events may contain a payload, usually nothing (void), an array of 64 bit "
33182 "unsigned integers, or a message buffer. Payloads are discussed later on."
33186 #: ../src/guestfs.pod:1695
33187 msgid "CLASSES OF EVENTS"
33191 #: ../src/guestfs.pod:1699
33192 msgid "GUESTFS_EVENT_CLOSE (payload type: void)"
33196 #: ../src/guestfs.pod:1702
33198 "The callback function will be called while the handle is being closed "
33199 "(synchronously from L</guestfs_close>)."
33203 #: ../src/guestfs.pod:1705
33205 "Note that libguestfs installs an L<atexit(3)> handler to try to clean up "
33206 "handles that are open when the program exits. This means that this callback "
33207 "might be called indirectly from L<exit(3)>, which can cause unexpected "
33208 "problems in higher-level languages (eg. if your HLL interpreter has already "
33209 "been cleaned up by the time this is called, and if your callback then jumps "
33210 "into some HLL function)."
33214 #: ../src/guestfs.pod:1712
33216 "If no callback is registered: the handle is closed without any callback "
33221 #: ../src/guestfs.pod:1715
33222 msgid "GUESTFS_EVENT_SUBPROCESS_QUIT (payload type: void)"
33226 #: ../src/guestfs.pod:1718
33228 "The callback function will be called when the child process quits, either "
33229 "asynchronously or if killed by L</guestfs_kill_subprocess>. (This "
33230 "corresponds to a transition from any state to the CONFIG state)."
33234 #: ../src/guestfs.pod:1722 ../src/guestfs.pod:1731
33235 msgid "If no callback is registered: the event is ignored."
33239 #: ../src/guestfs.pod:1724
33240 msgid "GUESTFS_EVENT_LAUNCH_DONE (payload type: void)"
33244 #: ../src/guestfs.pod:1727
33246 "The callback function will be called when the child process becomes ready "
33247 "first time after it has been launched. (This corresponds to a transition "
33248 "from LAUNCHING to the READY state)."
33252 #: ../src/guestfs.pod:1733
33253 msgid "GUESTFS_EVENT_PROGRESS (payload type: array of 4 x uint64_t)"
33257 #: ../src/guestfs.pod:1736
33259 "Some long-running operations can generate progress messages. If this "
33260 "callback is registered, then it will be called each time a progress message "
33261 "is generated (usually two seconds after the operation started, and three "
33262 "times per second thereafter until it completes, although the frequency may "
33263 "change in future versions)."
33267 #: ../src/guestfs.pod:1742
33269 "The callback receives in the payload four unsigned 64 bit numbers which are "
33270 "(in order): C<proc_nr>, C<serial>, C<position>, C<total>."
33274 #: ../src/guestfs.pod:1745
33276 "The units of C<total> are not defined, although for some operations C<total> "
33277 "may relate in some way to the amount of data to be transferred (eg. in bytes "
33278 "or megabytes), and C<position> may be the portion which has been "
33283 #: ../src/guestfs.pod:1750
33284 msgid "The only defined and stable parts of the API are:"
33288 #: ../src/guestfs.pod:1756
33290 "The callback can display to the user some type of progress bar or indicator "
33291 "which shows the ratio of C<position>:C<total>."
33295 #: ../src/guestfs.pod:1761
33296 msgid "0 E<lt>= C<position> E<lt>= C<total>"
33300 #: ../src/guestfs.pod:1765
33302 "If any progress notification is sent during a call, then a final progress "
33303 "notification is always sent when C<position> = C<total> (I<unless> the call "
33304 "fails with an error)."
33308 #: ../src/guestfs.pod:1769
33310 "This is to simplify caller code, so callers can easily set the progress "
33311 "indicator to \"100%\" at the end of the operation, without requiring special "
33312 "code to detect this case."
33316 #: ../src/guestfs.pod:1775
33318 "For some calls we are unable to estimate the progress of the call, but we "
33319 "can still generate progress messages to indicate activity. This is known as "
33320 "\"pulse mode\", and is directly supported by certain progress bar "
33321 "implementations (eg. GtkProgressBar)."
33325 #: ../src/guestfs.pod:1780
33327 "For these calls, zero or more progress messages are generated with "
33328 "C<position = 0> and C<total = 1>, followed by a final message with "
33329 "C<position = total = 1>."
33333 #: ../src/guestfs.pod:1784
33335 "As noted above, if the call fails with an error then the final message may "
33336 "not be generated."
33340 #: ../src/guestfs.pod:1789
33342 "The callback also receives the procedure number (C<proc_nr>) and serial "
33343 "number (C<serial>) of the call. These are only useful for debugging "
33344 "protocol issues, and the callback can normally ignore them. The callback "
33345 "may want to print these numbers in error messages or debugging messages."
33349 #: ../src/guestfs.pod:1795
33350 msgid "If no callback is registered: progress messages are discarded."
33354 #: ../src/guestfs.pod:1797
33355 msgid "GUESTFS_EVENT_APPLIANCE (payload type: message buffer)"
33359 #: ../src/guestfs.pod:1800
33361 "The callback function is called whenever a log message is generated by qemu, "
33362 "the appliance kernel, guestfsd (daemon), or utility programs."
33366 #: ../src/guestfs.pod:1803
33368 "If the verbose flag (L</guestfs_set_verbose>) is set before launch "
33369 "(L</guestfs_launch>) then additional debug messages are generated."
33373 #: ../src/guestfs.pod:1806 ../src/guestfs.pod:1820
33375 "If no callback is registered: the messages are discarded unless the verbose "
33376 "flag is set in which case they are sent to stderr. You can override the "
33377 "printing of verbose messages to stderr by setting up a callback."
33381 #: ../src/guestfs.pod:1811
33382 msgid "GUESTFS_EVENT_LIBRARY (payload type: message buffer)"
33386 #: ../src/guestfs.pod:1814
33388 "The callback function is called whenever a log message is generated by the "
33389 "library part of libguestfs."
33393 #: ../src/guestfs.pod:1817
33395 "If the verbose flag (L</guestfs_set_verbose>) is set then additional debug "
33396 "messages are generated."
33400 #: ../src/guestfs.pod:1825
33401 msgid "GUESTFS_EVENT_TRACE (payload type: message buffer)"
33405 #: ../src/guestfs.pod:1828
33407 "The callback function is called whenever a trace message is generated. This "
33408 "only applies if the trace flag (L</guestfs_set_trace>) is set."
33412 #: ../src/guestfs.pod:1831
33414 "If no callback is registered: the messages are sent to stderr. You can "
33415 "override the printing of trace messages to stderr by setting up a callback."
33419 #: ../src/guestfs.pod:1837
33420 msgid "guestfs_set_event_callback"
33424 #: ../src/guestfs.pod:1839
33427 " int guestfs_set_event_callback (guestfs_h *g,\n"
33428 " guestfs_event_callback cb,\n"
33429 " uint64_t event_bitmask,\n"
33431 " void *opaque);\n"
33436 #: ../src/guestfs.pod:1845
33438 "This function registers a callback (C<cb>) for all event classes in the "
33439 "C<event_bitmask>."
33443 #: ../src/guestfs.pod:1848
33445 "For example, to register for all log message events, you could call this "
33446 "function with the bitmask C<GUESTFS_EVENT_APPLIANCE|GUESTFS_EVENT_LIBRARY>. "
33447 "To register a single callback for all possible classes of events, use "
33448 "C<GUESTFS_EVENT_ALL>."
33452 #: ../src/guestfs.pod:1854
33453 msgid "C<flags> should always be passed as 0."
33457 #: ../src/guestfs.pod:1856
33459 "C<opaque> is an opaque pointer which is passed to the callback. You can use "
33460 "it for any purpose."
33464 #: ../src/guestfs.pod:1859
33466 "The return value is the event handle (an integer) which you can use to "
33467 "delete the callback (see below)."
33471 #: ../src/guestfs.pod:1862
33473 "If there is an error, this function returns C<-1>, and sets the error in the "
33474 "handle in the usual way (see L</guestfs_last_error> etc.)"
33478 #: ../src/guestfs.pod:1865
33480 "Callbacks remain in effect until they are deleted, or until the handle is "
33485 #: ../src/guestfs.pod:1868
33487 "In the case where multiple callbacks are registered for a particular event "
33488 "class, all of the callbacks are called. The order in which multiple "
33489 "callbacks are called is not defined."
33493 #: ../src/guestfs.pod:1872
33494 msgid "guestfs_delete_event_callback"
33498 #: ../src/guestfs.pod:1874
33501 " void guestfs_delete_event_callback (guestfs_h *g, int event_handle);\n"
33506 #: ../src/guestfs.pod:1876
33508 "Delete a callback that was previously registered. C<event_handle> should be "
33509 "the integer that was returned by a previous call to "
33510 "C<guestfs_set_event_callback> on the same handle."
33514 #: ../src/guestfs.pod:1880
33515 msgid "guestfs_event_callback"
33519 #: ../src/guestfs.pod:1882
33522 " typedef void (*guestfs_event_callback) (\n"
33525 " uint64_t event,\n"
33526 " int event_handle,\n"
33528 " const char *buf, size_t buf_len,\n"
33529 " const uint64_t *array, size_t array_len);\n"
33534 #: ../src/guestfs.pod:1891
33535 msgid "This is the type of the event callback function that you have to provide."
33539 #: ../src/guestfs.pod:1894
33541 "The basic parameters are: the handle (C<g>), the opaque user pointer "
33542 "(C<opaque>), the event class (eg. C<GUESTFS_EVENT_PROGRESS>), the event "
33543 "handle, and C<flags> which in the current API you should ignore."
33547 #: ../src/guestfs.pod:1898
33549 "The remaining parameters contain the event payload (if any). Each event may "
33550 "contain a payload, which usually relates to the event class, but for future "
33551 "proofing your code should be written to handle any payload for any event "
33556 #: ../src/guestfs.pod:1903
33558 "C<buf> and C<buf_len> contain a message buffer (if C<buf_len == 0>, then "
33559 "there is no message buffer). Note that this message buffer can contain "
33560 "arbitrary 8 bit data, including NUL bytes."
33564 #: ../src/guestfs.pod:1907
33566 "C<array> and C<array_len> is an array of 64 bit unsigned integers. At the "
33567 "moment this is only used for progress messages."
33571 #: ../src/guestfs.pod:1910
33572 msgid "EXAMPLE: CAPTURING LOG MESSAGES"
33576 #: ../src/guestfs.pod:1912
33578 "One motivation for the generic event API was to allow GUI programs to "
33579 "capture debug and other messages. In libguestfs E<le> 1.8 these were sent "
33580 "unconditionally to C<stderr>."
33584 #: ../src/guestfs.pod:1916
33586 "Events associated with log messages are: C<GUESTFS_EVENT_LIBRARY>, "
33587 "C<GUESTFS_EVENT_APPLIANCE> and C<GUESTFS_EVENT_TRACE>. (Note that error "
33588 "messages are not events; you must capture error messages separately)."
33592 #: ../src/guestfs.pod:1921
33594 "Programs have to set up a callback to capture the classes of events of "
33599 #: ../src/guestfs.pod:1924
33603 " guestfs_set_event_callback\n"
33604 " (g, message_callback,\n"
33605 " GUESTFS_EVENT_LIBRARY|GUESTFS_EVENT_APPLIANCE|\n"
33606 " GUESTFS_EVENT_TRACE,\n"
33607 " 0, NULL) == -1)\n"
33608 " if (eh == -1) {\n"
33609 " // handle error in the usual way\n"
33615 #: ../src/guestfs.pod:1934
33617 "The callback can then direct messages to the appropriate place. In this "
33618 "example, messages are directed to syslog:"
33622 #: ../src/guestfs.pod:1937
33626 " message_callback (\n"
33629 " uint64_t event,\n"
33630 " int event_handle,\n"
33632 " const char *buf, size_t buf_len,\n"
33633 " const uint64_t *array, size_t array_len)\n"
33635 " const int priority = LOG_USER|LOG_INFO;\n"
33636 " if (buf_len > 0)\n"
33637 " syslog (priority, \"event 0x%lx: %s\", event, buf);\n"
33643 #: ../src/guestfs.pod:1952
33644 msgid "CANCELLING LONG TRANSFERS"
33648 #: ../src/guestfs.pod:1954
33650 "Some operations can be cancelled by the caller while they are in progress. "
33651 "Currently only operations that involve uploading or downloading data can be "
33652 "cancelled (technically: operations that have C<FileIn> or C<FileOut> "
33653 "parameters in the generator)."
33657 #: ../src/guestfs.pod:1959
33658 msgid "guestfs_user_cancel"
33662 #: ../src/guestfs.pod:1961
33665 " void guestfs_user_cancel (guestfs_h *g);\n"
33670 #: ../src/guestfs.pod:1963
33671 msgid "C<guestfs_user_cancel> cancels the current upload or download operation."
33675 #: ../src/guestfs.pod:1966
33677 "Unlike most other libguestfs calls, this function is signal safe and thread "
33678 "safe. You can call it from a signal handler or from another thread, without "
33679 "needing to do any locking."
33683 #: ../src/guestfs.pod:1970
33685 "The transfer that was in progress (if there is one) will stop shortly "
33686 "afterwards, and will return an error. The errno (see "
33687 "L</guestfs_last_errno>) is set to C<EINTR>, so you can test for this to find "
33688 "out if the operation was cancelled or failed because of another error."
33692 #: ../src/guestfs.pod:1976
33694 "No cleanup is performed: for example, if a file was being uploaded then "
33695 "after cancellation there may be a partially uploaded file. It is the "
33696 "caller's responsibility to clean up if necessary."
33700 #: ../src/guestfs.pod:1980
33701 msgid "There are two common places that you might call C<guestfs_user_cancel>."
33705 #: ../src/guestfs.pod:1982
33707 "In an interactive text-based program, you might call it from a C<SIGINT> "
33708 "signal handler so that pressing C<^C> cancels the current operation. (You "
33709 "also need to call L</guestfs_set_pgroup> so that child processes don't "
33710 "receive the C<^C> signal)."
33714 #: ../src/guestfs.pod:1987
33716 "In a graphical program, when the main thread is displaying a progress bar "
33717 "with a cancel button, wire up the cancel button to call this function."
33721 #: ../src/guestfs.pod:1991
33722 msgid "PRIVATE DATA AREA"
33726 #: ../src/guestfs.pod:1993
33728 "You can attach named pieces of private data to the libguestfs handle, fetch "
33729 "them by name, and walk over them, for the lifetime of the handle. This is "
33730 "called the private data area and is only available from the C API."
33734 #: ../src/guestfs.pod:1998
33735 msgid "To attach a named piece of data, use the following call:"
33739 #: ../src/guestfs.pod:2000
33742 " void guestfs_set_private (guestfs_h *g, const char *key, void *data);\n"
33747 #: ../src/guestfs.pod:2002
33749 "C<key> is the name to associate with this data, and C<data> is an arbitrary "
33750 "pointer (which can be C<NULL>). Any previous item with the same key is "
33755 #: ../src/guestfs.pod:2006
33757 "You can use any C<key> you want, but your key should I<not> start with an "
33758 "underscore character. Keys beginning with an underscore character are "
33759 "reserved for internal libguestfs purposes (eg. for implementing language "
33760 "bindings). It is recommended that you prefix the key with some unique "
33761 "string to avoid collisions with other users."
33765 #: ../src/guestfs.pod:2012
33766 msgid "To retrieve the pointer, use:"
33770 #: ../src/guestfs.pod:2014
33773 " void *guestfs_get_private (guestfs_h *g, const char *key);\n"
33778 #: ../src/guestfs.pod:2016
33780 "This function returns C<NULL> if either no data is found associated with "
33781 "C<key>, or if the user previously set the C<key>'s C<data> pointer to "
33786 #: ../src/guestfs.pod:2020
33788 "Libguestfs does not try to look at or interpret the C<data> pointer in any "
33789 "way. As far as libguestfs is concerned, it need not be a valid pointer at "
33790 "all. In particular, libguestfs does I<not> try to free the data when the "
33791 "handle is closed. If the data must be freed, then the caller must either "
33792 "free it before calling L</guestfs_close> or must set up a close callback to "
33793 "do it (see L</GUESTFS_EVENT_CLOSE>)."
33797 #: ../src/guestfs.pod:2027
33798 msgid "To walk over all entries, use these two functions:"
33802 #: ../src/guestfs.pod:2029
33805 " void *guestfs_first_private (guestfs_h *g, const char **key_rtn);\n"
33810 #: ../src/guestfs.pod:2031
33813 " void *guestfs_next_private (guestfs_h *g, const char **key_rtn);\n"
33818 #: ../src/guestfs.pod:2033
33820 "C<guestfs_first_private> returns the first key, pointer pair (\"first\" does "
33821 "not have any particular meaning -- keys are not returned in any defined "
33822 "order). A pointer to the key is returned in C<*key_rtn> and the "
33823 "corresponding data pointer is returned from the function. C<NULL> is "
33824 "returned if there are no keys stored in the handle."
33828 #: ../src/guestfs.pod:2039
33830 "C<guestfs_next_private> returns the next key, pointer pair. The return "
33831 "value of this function is also C<NULL> is there are no further entries to "
33836 #: ../src/guestfs.pod:2043
33837 msgid "Notes about walking over entries:"
33841 #: ../src/guestfs.pod:2049
33842 msgid "You must not call C<guestfs_set_private> while walking over the entries."
33846 #: ../src/guestfs.pod:2054
33848 "The handle maintains an internal iterator which is reset when you call "
33849 "C<guestfs_first_private>. This internal iterator is invalidated when you "
33850 "call C<guestfs_set_private>."
33854 #: ../src/guestfs.pod:2060
33855 msgid "If you have set the data pointer associated with a key to C<NULL>, ie:"
33859 #: ../src/guestfs.pod:2062
33862 " guestfs_set_private (g, key, NULL);\n"
33867 #: ../src/guestfs.pod:2064
33868 msgid "then that C<key> is not returned when walking."
33872 #: ../src/guestfs.pod:2068
33874 "C<*key_rtn> is only valid until the next call to C<guestfs_first_private>, "
33875 "C<guestfs_next_private> or C<guestfs_set_private>."
33879 #: ../src/guestfs.pod:2074
33881 "The following example code shows how to print all keys and data pointers "
33882 "that are associated with the handle C<g>:"
33886 #: ../src/guestfs.pod:2077
33889 " const char *key;\n"
33890 " void *data = guestfs_first_private (g, &key);\n"
33891 " while (data != NULL)\n"
33893 " printf (\"key = %s, data = %p\\n\", key, data);\n"
33894 " data = guestfs_next_private (g, &key);\n"
33900 #: ../src/guestfs.pod:2085
33902 "More commonly you are only interested in keys that begin with an "
33903 "application-specific prefix C<foo_>. Modify the loop like so:"
33907 #: ../src/guestfs.pod:2088
33910 " const char *key;\n"
33911 " void *data = guestfs_first_private (g, &key);\n"
33912 " while (data != NULL)\n"
33914 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
33915 " printf (\"key = %s, data = %p\\n\", key, data);\n"
33916 " data = guestfs_next_private (g, &key);\n"
33922 #: ../src/guestfs.pod:2097
33924 "If you need to modify keys while walking, then you have to jump back to the "
33925 "beginning of the loop. For example, to delete all keys prefixed with "
33930 #: ../src/guestfs.pod:2101
33933 " const char *key;\n"
33936 " data = guestfs_first_private (g, &key);\n"
33937 " while (data != NULL)\n"
33939 " if (strncmp (key, \"foo_\", strlen (\"foo_\")) == 0)\n"
33941 " guestfs_set_private (g, key, NULL);\n"
33942 " /* note that 'key' pointer is now invalid, and so is\n"
33943 " the internal iterator */\n"
33946 " data = guestfs_next_private (g, &key);\n"
33952 #: ../src/guestfs.pod:2117
33954 "Note that the above loop is guaranteed to terminate because the keys are "
33955 "being deleted, but other manipulations of keys within the loop might not "
33956 "terminate unless you also maintain an indication of which keys have been "
33961 #: ../src/guestfs.pod:2122 ../src/guestfs.pod:2127
33966 #: ../src/guestfs.pod:2124
33968 "<!-- old anchor for the next section --> <a "
33969 "name=\"state_machine_and_low_level_event_api\"/>"
33973 #: ../src/guestfs.pod:2129
33974 msgid "ARCHITECTURE"
33978 #: ../src/guestfs.pod:2131
33980 "Internally, libguestfs is implemented by running an appliance (a special "
33981 "type of small virtual machine) using L<qemu(1)>. Qemu runs as a child "
33982 "process of the main program."
33986 #: ../src/guestfs.pod:2135
33989 " ___________________\n"
33991 " | main program |\n"
33993 " | | child process / appliance\n"
33994 " | | __________________________\n"
33996 " +-------------------+ RPC | +-----------------+ |\n"
33997 " | libguestfs <--------------------> guestfsd | |\n"
33998 " | | | +-----------------+ |\n"
33999 " \\___________________/ | | Linux kernel | |\n"
34000 " | +--^--------------+ |\n"
34001 " \\_________|________________/\n"
34003 " _______v______\n"
34006 " | disk image |\n"
34007 " \\______________/\n"
34012 #: ../src/guestfs.pod:2155
34014 "The library, linked to the main program, creates the child process and hence "
34015 "the appliance in the L</guestfs_launch> function."
34019 #: ../src/guestfs.pod:2158
34021 "Inside the appliance is a Linux kernel and a complete stack of userspace "
34022 "tools (such as LVM and ext2 programs) and a small controlling daemon called "
34023 "L</guestfsd>. The library talks to L</guestfsd> using remote procedure "
34024 "calls (RPC). There is a mostly one-to-one correspondence between libguestfs "
34025 "API calls and RPC calls to the daemon. Lastly the disk image(s) are "
34026 "attached to the qemu process which translates device access by the "
34027 "appliance's Linux kernel into accesses to the image."
34031 #: ../src/guestfs.pod:2167
34033 "A common misunderstanding is that the appliance \"is\" the virtual machine. "
34034 "Although the disk image you are attached to might also be used by some "
34035 "virtual machine, libguestfs doesn't know or care about this. (But you will "
34036 "care if both libguestfs's qemu process and your virtual machine are trying "
34037 "to update the disk image at the same time, since these usually results in "
34038 "massive disk corruption)."
34042 #: ../src/guestfs.pod:2174
34043 msgid "STATE MACHINE"
34047 #: ../src/guestfs.pod:2176
34048 msgid "libguestfs uses a state machine to model the child process:"
34052 #: ../src/guestfs.pod:2178
34056 " guestfs_create\n"
34064 " / | \\ \\ guestfs_launch\n"
34065 " / | _\\__V______\n"
34067 " / | | LAUNCHING |\n"
34068 " / | \\___________/\n"
34070 " / | guestfs_launch\n"
34072 " ______ / __|____V\n"
34073 " / \\ ------> / \\\n"
34074 " | BUSY | | READY |\n"
34075 " \\______/ <------ \\________/\n"
34080 #: ../src/guestfs.pod:2200
34082 "The normal transitions are (1) CONFIG (when the handle is created, but there "
34083 "is no child process), (2) LAUNCHING (when the child process is booting up), "
34084 "(3) alternating between READY and BUSY as commands are issued to, and "
34085 "carried out by, the child process."
34089 #: ../src/guestfs.pod:2205
34091 "The guest may be killed by L</guestfs_kill_subprocess>, or may die "
34092 "asynchronously at any time (eg. due to some internal error), and that causes "
34093 "the state to transition back to CONFIG."
34097 #: ../src/guestfs.pod:2209
34099 "Configuration commands for qemu such as L</guestfs_add_drive> can only be "
34100 "issued when in the CONFIG state."
34104 #: ../src/guestfs.pod:2212
34106 "The API offers one call that goes from CONFIG through LAUNCHING to READY. "
34107 "L</guestfs_launch> blocks until the child process is READY to accept "
34108 "commands (or until some failure or timeout). L</guestfs_launch> internally "
34109 "moves the state from CONFIG to LAUNCHING while it is running."
34113 #: ../src/guestfs.pod:2218
34115 "API actions such as L</guestfs_mount> can only be issued when in the READY "
34116 "state. These API calls block waiting for the command to be carried out "
34117 "(ie. the state to transition to BUSY and then back to READY). There are no "
34118 "non-blocking versions, and no way to issue more than one command per handle "
34119 "at the same time."
34123 #: ../src/guestfs.pod:2224
34125 "Finally, the child process sends asynchronous messages back to the main "
34126 "program, such as kernel log messages. You can register a callback to "
34127 "receive these messages."
34131 #: ../src/guestfs.pod:2228
34136 #: ../src/guestfs.pod:2230
34137 msgid "COMMUNICATION PROTOCOL"
34141 #: ../src/guestfs.pod:2232
34143 "Don't rely on using this protocol directly. This section documents how it "
34144 "currently works, but it may change at any time."
34148 #: ../src/guestfs.pod:2235
34150 "The protocol used to talk between the library and the daemon running inside "
34151 "the qemu virtual machine is a simple RPC mechanism built on top of XDR (RFC "
34152 "1014, RFC 1832, RFC 4506)."
34156 #: ../src/guestfs.pod:2239
34158 "The detailed format of structures is in C<src/guestfs_protocol.x> (note: "
34159 "this file is automatically generated)."
34163 #: ../src/guestfs.pod:2242
34165 "There are two broad cases, ordinary functions that don't have any C<FileIn> "
34166 "and C<FileOut> parameters, which are handled with very simple request/reply "
34167 "messages. Then there are functions that have any C<FileIn> or C<FileOut> "
34168 "parameters, which use the same request and reply messages, but they may also "
34169 "be followed by files sent using a chunked encoding."
34173 #: ../src/guestfs.pod:2249
34174 msgid "ORDINARY FUNCTIONS (NO FILEIN/FILEOUT PARAMS)"
34178 #: ../src/guestfs.pod:2251
34179 msgid "For ordinary functions, the request message is:"
34183 #: ../src/guestfs.pod:2253
34186 " total length (header + arguments,\n"
34187 " but not including the length word itself)\n"
34188 " struct guestfs_message_header (encoded as XDR)\n"
34189 " struct guestfs_<foo>_args (encoded as XDR)\n"
34194 #: ../src/guestfs.pod:2258
34196 "The total length field allows the daemon to allocate a fixed size buffer "
34197 "into which it slurps the rest of the message. As a result, the total length "
34198 "is limited to C<GUESTFS_MESSAGE_MAX> bytes (currently 4MB), which means the "
34199 "effective size of any request is limited to somewhere under this size."
34203 #: ../src/guestfs.pod:2264
34205 "Note also that many functions don't take any arguments, in which case the "
34206 "C<guestfs_I<foo>_args> is completely omitted."
34210 #: ../src/guestfs.pod:2267
34212 "The header contains the procedure number (C<guestfs_proc>) which is how the "
34213 "receiver knows what type of args structure to expect, or none at all."
34217 #: ../src/guestfs.pod:2271
34219 "For functions that take optional arguments, the optional arguments are "
34220 "encoded in the C<guestfs_I<foo>_args> structure in the same way as ordinary "
34221 "arguments. A bitmask in the header indicates which optional arguments are "
34222 "meaningful. The bitmask is also checked to see if it contains bits set "
34223 "which the daemon does not know about (eg. if more optional arguments were "
34224 "added in a later version of the library), and this causes the call to be "
34229 #: ../src/guestfs.pod:2279
34230 msgid "The reply message for ordinary functions is:"
34234 #: ../src/guestfs.pod:2281
34237 " total length (header + ret,\n"
34238 " but not including the length word itself)\n"
34239 " struct guestfs_message_header (encoded as XDR)\n"
34240 " struct guestfs_<foo>_ret (encoded as XDR)\n"
34245 #: ../src/guestfs.pod:2286
34247 "As above the C<guestfs_I<foo>_ret> structure may be completely omitted for "
34248 "functions that return no formal return values."
34252 #: ../src/guestfs.pod:2289
34253 msgid "As above the total length of the reply is limited to C<GUESTFS_MESSAGE_MAX>."
34257 #: ../src/guestfs.pod:2292
34259 "In the case of an error, a flag is set in the header, and the reply message "
34260 "is slightly changed:"
34264 #: ../src/guestfs.pod:2295
34267 " total length (header + error,\n"
34268 " but not including the length word itself)\n"
34269 " struct guestfs_message_header (encoded as XDR)\n"
34270 " struct guestfs_message_error (encoded as XDR)\n"
34275 #: ../src/guestfs.pod:2300
34277 "The C<guestfs_message_error> structure contains the error message as a "
34282 #: ../src/guestfs.pod:2303
34283 msgid "FUNCTIONS THAT HAVE FILEIN PARAMETERS"
34287 #: ../src/guestfs.pod:2305
34289 "A C<FileIn> parameter indicates that we transfer a file I<into> the guest. "
34290 "The normal request message is sent (see above). However this is followed by "
34291 "a sequence of file chunks."
34295 #: ../src/guestfs.pod:2309
34298 " total length (header + arguments,\n"
34299 " but not including the length word itself,\n"
34300 " and not including the chunks)\n"
34301 " struct guestfs_message_header (encoded as XDR)\n"
34302 " struct guestfs_<foo>_args (encoded as XDR)\n"
34303 " sequence of chunks for FileIn param #0\n"
34304 " sequence of chunks for FileIn param #1 etc.\n"
34309 #: ../src/guestfs.pod:2317
34310 msgid "The \"sequence of chunks\" is:"
34314 #: ../src/guestfs.pod:2319
34317 " length of chunk (not including length word itself)\n"
34318 " struct guestfs_chunk (encoded as XDR)\n"
34319 " length of chunk\n"
34320 " struct guestfs_chunk (encoded as XDR)\n"
34322 " length of chunk\n"
34323 " struct guestfs_chunk (with data.data_len == 0)\n"
34328 #: ../src/guestfs.pod:2327
34330 "The final chunk has the C<data_len> field set to zero. Additionally a flag "
34331 "is set in the final chunk to indicate either successful completion or early "
34336 #: ../src/guestfs.pod:2331
34338 "At time of writing there are no functions that have more than one FileIn "
34339 "parameter. However this is (theoretically) supported, by sending the "
34340 "sequence of chunks for each FileIn parameter one after another (from left to "
34345 #: ../src/guestfs.pod:2336
34347 "Both the library (sender) I<and> the daemon (receiver) may cancel the "
34348 "transfer. The library does this by sending a chunk with a special flag set "
34349 "to indicate cancellation. When the daemon sees this, it cancels the whole "
34350 "RPC, does I<not> send any reply, and goes back to reading the next request."
34354 #: ../src/guestfs.pod:2342
34356 "The daemon may also cancel. It does this by writing a special word "
34357 "C<GUESTFS_CANCEL_FLAG> to the socket. The library listens for this during "
34358 "the transfer, and if it gets it, it will cancel the transfer (it sends a "
34359 "cancel chunk). The special word is chosen so that even if cancellation "
34360 "happens right at the end of the transfer (after the library has finished "
34361 "writing and has started listening for the reply), the \"spurious\" cancel "
34362 "flag will not be confused with the reply message."
34366 #: ../src/guestfs.pod:2351
34368 "This protocol allows the transfer of arbitrary sized files (no 32 bit "
34369 "limit), and also files where the size is not known in advance (eg. from "
34370 "pipes or sockets). However the chunks are rather small "
34371 "(C<GUESTFS_MAX_CHUNK_SIZE>), so that neither the library nor the daemon need "
34372 "to keep much in memory."
34376 #: ../src/guestfs.pod:2357
34377 msgid "FUNCTIONS THAT HAVE FILEOUT PARAMETERS"
34381 #: ../src/guestfs.pod:2359
34383 "The protocol for FileOut parameters is exactly the same as for FileIn "
34384 "parameters, but with the roles of daemon and library reversed."
34388 #: ../src/guestfs.pod:2362
34391 " total length (header + ret,\n"
34392 " but not including the length word itself,\n"
34393 " and not including the chunks)\n"
34394 " struct guestfs_message_header (encoded as XDR)\n"
34395 " struct guestfs_<foo>_ret (encoded as XDR)\n"
34396 " sequence of chunks for FileOut param #0\n"
34397 " sequence of chunks for FileOut param #1 etc.\n"
34402 #: ../src/guestfs.pod:2370
34403 msgid "INITIAL MESSAGE"
34407 #: ../src/guestfs.pod:2372
34409 "When the daemon launches it sends an initial word (C<GUESTFS_LAUNCH_FLAG>) "
34410 "which indicates that the guest and daemon is alive. This is what "
34411 "L</guestfs_launch> waits for."
34415 #: ../src/guestfs.pod:2376
34416 msgid "PROGRESS NOTIFICATION MESSAGES"
34420 #: ../src/guestfs.pod:2378
34422 "The daemon may send progress notification messages at any time. These are "
34423 "distinguished by the normal length word being replaced by "
34424 "C<GUESTFS_PROGRESS_FLAG>, followed by a fixed size progress message."
34428 #: ../src/guestfs.pod:2382
34430 "The library turns them into progress callbacks (see "
34431 "L</GUESTFS_EVENT_PROGRESS>) if there is a callback registered, or discards "
34436 #: ../src/guestfs.pod:2386
34438 "The daemon self-limits the frequency of progress messages it sends (see "
34439 "C<daemon/proto.c:notify_progress>). Not all calls generate progress "
34444 #: ../src/guestfs.pod:2390
34445 msgid "LIBGUESTFS VERSION NUMBERS"
34449 #: ../src/guestfs.pod:2392
34451 "Since April 2010, libguestfs has started to make separate development and "
34452 "stable releases, along with corresponding branches in our git repository. "
34453 "These separate releases can be identified by version number:"
34457 #: ../src/guestfs.pod:2397
34460 " even numbers for stable: 1.2.x, 1.4.x, ...\n"
34461 " .-------- odd numbers for development: 1.3.x, 1.5.x, ...\n"
34467 " | `-------- sub-version\n"
34469 " `------ always '1' because we don't change the ABI\n"
34474 #: ../src/guestfs.pod:2408
34475 msgid "Thus \"1.3.5\" is the 5th update to the development branch \"1.3\"."
34479 #: ../src/guestfs.pod:2410
34481 "As time passes we cherry pick fixes from the development branch and backport "
34482 "those into the stable branch, the effect being that the stable branch should "
34483 "get more stable and less buggy over time. So the stable releases are ideal "
34484 "for people who don't need new features but would just like the software to "
34489 #: ../src/guestfs.pod:2416
34490 msgid "Our criteria for backporting changes are:"
34494 #: ../src/guestfs.pod:2422
34496 "Documentation changes which don't affect any code are backported unless the "
34497 "documentation refers to a future feature which is not in stable."
34501 #: ../src/guestfs.pod:2428
34503 "Bug fixes which are not controversial, fix obvious problems, and have been "
34504 "well tested are backported."
34508 #: ../src/guestfs.pod:2433
34510 "Simple rearrangements of code which shouldn't affect how it works get "
34511 "backported. This is so that the code in the two branches doesn't get too "
34512 "far out of step, allowing us to backport future fixes more easily."
34516 #: ../src/guestfs.pod:2439
34518 "We I<don't> backport new features, new APIs, new tools etc, except in one "
34519 "exceptional case: the new feature is required in order to implement an "
34520 "important bug fix."
34524 #: ../src/guestfs.pod:2445
34526 "A new stable branch starts when we think the new features in development are "
34527 "substantial and compelling enough over the current stable branch to warrant "
34528 "it. When that happens we create new stable and development versions 1.N.0 "
34529 "and 1.(N+1).0 [N is even]. The new dot-oh release won't necessarily be so "
34530 "stable at this point, but by backporting fixes from development, that branch "
34531 "will stabilize over time."
34535 #: ../src/guestfs.pod:2453
34536 msgid "EXTENDING LIBGUESTFS"
34540 #: ../src/guestfs.pod:2455
34541 msgid "ADDING A NEW API ACTION"
34545 #: ../src/guestfs.pod:2457
34547 "Large amounts of boilerplate code in libguestfs (RPC, bindings, "
34548 "documentation) are generated, and this makes it easy to extend the "
34553 #: ../src/guestfs.pod:2461
34554 msgid "To add a new API action there are two changes:"
34558 #: ../src/guestfs.pod:2467
34560 "You need to add a description of the call (name, parameters, return type, "
34561 "tests, documentation) to C<generator/generator_actions.ml>."
34565 #: ../src/guestfs.pod:2470
34567 "There are two sorts of API action, depending on whether the call goes "
34568 "through to the daemon in the appliance, or is serviced entirely by the "
34569 "library (see L</ARCHITECTURE> above). L</guestfs_sync> is an example of the "
34570 "former, since the sync is done in the appliance. L</guestfs_set_trace> is "
34571 "an example of the latter, since a trace flag is maintained in the handle and "
34572 "all tracing is done on the library side."
34576 #: ../src/guestfs.pod:2478
34578 "Most new actions are of the first type, and get added to the "
34579 "C<daemon_functions> list. Each function has a unique procedure number used "
34580 "in the RPC protocol which is assigned to that action when we publish "
34581 "libguestfs and cannot be reused. Take the latest procedure number and "
34586 #: ../src/guestfs.pod:2484
34588 "For library-only actions of the second type, add to the "
34589 "C<non_daemon_functions> list. Since these functions are serviced by the "
34590 "library and do not travel over the RPC mechanism to the daemon, these "
34591 "functions do not need a procedure number, and so the procedure number is set "
34596 #: ../src/guestfs.pod:2492
34597 msgid "Implement the action (in C):"
34601 #: ../src/guestfs.pod:2494
34603 "For daemon actions, implement the function C<do_E<lt>nameE<gt>> in the "
34604 "C<daemon/> directory."
34608 #: ../src/guestfs.pod:2497
34610 "For library actions, implement the function C<guestfs__E<lt>nameE<gt>> "
34611 "(note: double underscore) in the C<src/> directory."
34615 #: ../src/guestfs.pod:2500
34616 msgid "In either case, use another function as an example of what to do."
34620 #: ../src/guestfs.pod:2504
34621 msgid "After making these changes, use C<make> to compile."
34625 #: ../src/guestfs.pod:2506
34627 "Note that you don't need to implement the RPC, language bindings, manual "
34628 "pages or anything else. It's all automatically generated from the OCaml "
34633 #: ../src/guestfs.pod:2510
34634 msgid "ADDING TESTS FOR AN API ACTION"
34638 #: ../src/guestfs.pod:2512
34640 "You can supply zero or as many tests as you want per API call. The tests "
34641 "can either be added as part of the API description "
34642 "(C<generator/generator_actions.ml>), or in some rarer cases you may want to "
34643 "drop a script into C<regressions/>. Note that adding a script to "
34644 "C<regressions/> is slower, so if possible use the first method."
34648 #: ../src/guestfs.pod:2518
34650 "The following describes the test environment used when you add an API test "
34651 "in C<generator_actions.ml>."
34655 #: ../src/guestfs.pod:2521
34656 msgid "The test environment has 4 block devices:"
34660 #: ../src/guestfs.pod:2525
34661 msgid "C</dev/sda> 500MB"
34665 #: ../src/guestfs.pod:2527
34666 msgid "General block device for testing."
34670 #: ../src/guestfs.pod:2529
34671 msgid "C</dev/sdb> 50MB"
34675 #: ../src/guestfs.pod:2531
34677 "C</dev/sdb1> is an ext2 filesystem used for testing filesystem write "
34682 #: ../src/guestfs.pod:2534
34683 msgid "C</dev/sdc> 10MB"
34687 #: ../src/guestfs.pod:2536
34688 msgid "Used in a few tests where two block devices are needed."
34692 #: ../src/guestfs.pod:2538
34693 msgid "C</dev/sdd>"
34697 #: ../src/guestfs.pod:2540
34698 msgid "ISO with fixed content (see C<images/test.iso>)."
34702 #: ../src/guestfs.pod:2544
34704 "To be able to run the tests in a reasonable amount of time, the libguestfs "
34705 "appliance and block devices are reused between tests. So don't try testing "
34706 "L</guestfs_kill_subprocess> :-x"
34710 #: ../src/guestfs.pod:2548
34712 "Each test starts with an initial scenario, selected using one of the "
34713 "C<Init*> expressions, described in C<generator/generator_types.ml>. These "
34714 "initialize the disks mentioned above in a particular way as documented in "
34715 "C<generator_types.ml>. You should not assume anything about the previous "
34716 "contents of other disks that are not initialized."
34720 #: ../src/guestfs.pod:2554
34722 "You can add a prerequisite clause to any individual test. This is a "
34723 "run-time check, which, if it fails, causes the test to be skipped. Useful "
34724 "if testing a command which might not work on all variations of libguestfs "
34725 "builds. A test that has prerequisite of C<Always> means to run "
34730 #: ../src/guestfs.pod:2560
34732 "In addition, packagers can skip individual tests by setting environment "
34733 "variables before running C<make check>."
34737 #: ../src/guestfs.pod:2563
34740 " SKIP_TEST_<CMD>_<NUM>=1\n"
34745 #: ../src/guestfs.pod:2565
34746 msgid "eg: C<SKIP_TEST_COMMAND_3=1> skips test #3 of L</guestfs_command>."
34750 #: ../src/guestfs.pod:2567
34755 #: ../src/guestfs.pod:2569
34758 " SKIP_TEST_<CMD>=1\n"
34763 #: ../src/guestfs.pod:2571
34764 msgid "eg: C<SKIP_TEST_ZEROFREE=1> skips all L</guestfs_zerofree> tests."
34768 #: ../src/guestfs.pod:2573
34769 msgid "Packagers can run only certain tests by setting for example:"
34773 #: ../src/guestfs.pod:2575
34776 " TEST_ONLY=\"vfs_type zerofree\"\n"
34781 #: ../src/guestfs.pod:2577
34783 "See C<capitests/tests.c> for more details of how these environment variables "
34788 #: ../src/guestfs.pod:2580
34789 msgid "DEBUGGING NEW API ACTIONS"
34793 #: ../src/guestfs.pod:2582
34794 msgid "Test new actions work before submitting them."
34798 #: ../src/guestfs.pod:2584
34799 msgid "You can use guestfish to try out new commands."
34803 #: ../src/guestfs.pod:2586
34805 "Debugging the daemon is a problem because it runs inside a minimal "
34806 "environment. However you can fprintf messages in the daemon to stderr, and "
34807 "they will show up if you use C<guestfish -v>."
34811 #: ../src/guestfs.pod:2590
34812 msgid "FORMATTING CODE AND OTHER CONVENTIONS"
34816 #: ../src/guestfs.pod:2592
34818 "Our C source code generally adheres to some basic code-formatting "
34819 "conventions. The existing code base is not totally consistent on this "
34820 "front, but we do prefer that contributed code be formatted similarly. In "
34821 "short, use spaces-not-TABs for indentation, use 2 spaces for each "
34822 "indentation level, and other than that, follow the K&R style."
34826 #: ../src/guestfs.pod:2598
34828 "If you use Emacs, add the following to one of one of your start-up files "
34829 "(e.g., ~/.emacs), to help ensure that you get indentation right:"
34833 #: ../src/guestfs.pod:2601
34836 " ;;; In libguestfs, indent with spaces everywhere (not TABs).\n"
34837 " ;;; Exceptions: Makefile and ChangeLog modes.\n"
34838 " (add-hook 'find-file-hook\n"
34839 " '(lambda () (if (and buffer-file-name\n"
34840 " (string-match \"/libguestfs\\\\>\"\n"
34841 " (buffer-file-name))\n"
34842 " (not (string-equal mode-name \"Change Log\"))\n"
34843 " (not (string-equal mode-name \"Makefile\")))\n"
34844 " (setq indent-tabs-mode nil))))\n"
34849 #: ../src/guestfs.pod:2611
34852 " ;;; When editing C sources in libguestfs, use this style.\n"
34853 " (defun libguestfs-c-mode ()\n"
34854 " \"C mode with adjusted defaults for use with libguestfs.\"\n"
34856 " (c-set-style \"K&R\")\n"
34857 " (setq c-indent-level 2)\n"
34858 " (setq c-basic-offset 2))\n"
34859 " (add-hook 'c-mode-hook\n"
34860 " '(lambda () (if (string-match \"/libguestfs\\\\>\"\n"
34861 " (buffer-file-name))\n"
34862 " (libguestfs-c-mode))))\n"
34867 #: ../src/guestfs.pod:2623
34868 msgid "Enable warnings when compiling (and fix any problems this finds):"
34872 #: ../src/guestfs.pod:2626
34875 " ./configure --enable-gcc-warnings\n"
34880 #: ../src/guestfs.pod:2628
34881 msgid "Useful targets are:"
34885 #: ../src/guestfs.pod:2630
34888 " make syntax-check # checks the syntax of the C code\n"
34889 " make check # runs the test suite\n"
34894 #: ../src/guestfs.pod:2633
34895 msgid "DAEMON CUSTOM PRINTF FORMATTERS"
34899 #: ../src/guestfs.pod:2635
34901 "In the daemon code we have created custom printf formatters C<%Q> and C<%R>, "
34902 "which are used to do shell quoting."
34906 #: ../src/guestfs.pod:2640
34911 #: ../src/guestfs.pod:2642
34913 "Simple shell quoted string. Any spaces or other shell characters are "
34918 #: ../src/guestfs.pod:2645
34923 #: ../src/guestfs.pod:2647
34925 "Same as C<%Q> except the string is treated as a path which is prefixed by "
34930 #: ../src/guestfs.pod:2654
34933 " asprintf (&cmd, \"cat %R\", path);\n"
34938 #: ../src/guestfs.pod:2656
34939 msgid "would produce C<cat /sysroot/some\\ path\\ with\\ spaces>"
34943 #: ../src/guestfs.pod:2658
34945 "I<Note:> Do I<not> use these when you are passing parameters to the "
34946 "C<command{,r,v,rv}()> functions. These parameters do NOT need to be quoted "
34947 "because they are not passed via the shell (instead, straight to exec). You "
34948 "probably want to use the C<sysroot_path()> function however."
34952 #: ../src/guestfs.pod:2664
34953 msgid "SUBMITTING YOUR NEW API ACTIONS"
34957 #: ../src/guestfs.pod:2666
34959 "Submit patches to the mailing list: "
34960 "L<http://www.redhat.com/mailman/listinfo/libguestfs> and CC to "
34961 "L<rjones@redhat.com>."
34965 #: ../src/guestfs.pod:2670
34966 msgid "INTERNATIONALIZATION (I18N) SUPPORT"
34970 #: ../src/guestfs.pod:2672
34971 msgid "We support i18n (gettext anyhow) in the library."
34975 #: ../src/guestfs.pod:2674
34977 "However many messages come from the daemon, and we don't translate those at "
34978 "the moment. One reason is that the appliance generally has all locale files "
34979 "removed from it, because they take up a lot of space. So we'd have to readd "
34980 "some of those, as well as copying our PO files into the appliance."
34984 #: ../src/guestfs.pod:2680
34986 "Debugging messages are never translated, since they are intended for the "
34991 #: ../src/guestfs.pod:2683
34992 msgid "SOURCE CODE SUBDIRECTORIES"
34996 #: ../src/guestfs.pod:2689
34997 msgid "The libguestfs appliance, build scripts and so on."
35001 #: ../src/guestfs.pod:2691
35002 msgid "C<capitests>"
35006 #: ../src/guestfs.pod:2693
35007 msgid "Automated tests of the C API."
35011 #: ../src/guestfs.pod:2695
35016 #: ../src/guestfs.pod:2697
35018 "The L<virt-cat(1)>, L<virt-filesystems(1)> and L<virt-ls(1)> commands and "
35023 #: ../src/guestfs.pod:2700
35028 #: ../src/guestfs.pod:2702
35030 "Safety and liveness tests of components that libguestfs depends upon (not of "
35031 "libguestfs itself). Mainly this is for qemu and the kernel."
35035 #: ../src/guestfs.pod:2705
35040 #: ../src/guestfs.pod:2707
35041 msgid "Outside contributions, experimental parts."
35045 #: ../src/guestfs.pod:2709
35050 #: ../src/guestfs.pod:2711
35052 "The daemon that runs inside the libguestfs appliance and carries out "
35057 #: ../src/guestfs.pod:2714
35062 #: ../src/guestfs.pod:2716
35063 msgid "L<virt-df(1)> command and documentation."
35067 #: ../src/guestfs.pod:2718
35072 #: ../src/guestfs.pod:2720
35073 msgid "L<virt-edit(1)> command and documentation."
35077 #: ../src/guestfs.pod:2722
35078 msgid "C<examples>"
35082 #: ../src/guestfs.pod:2724
35083 msgid "C API example code."
35087 #: ../src/guestfs.pod:2726
35092 #: ../src/guestfs.pod:2728
35094 "L<guestfish(1)>, the command-line shell, and various shell scripts built on "
35095 "top such as L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
35096 "L<virt-tar-out(1)>."
35100 #: ../src/guestfs.pod:2732
35105 #: ../src/guestfs.pod:2734
35106 msgid "L<guestmount(1)>, FUSE (userspace filesystem) built on top of libguestfs."
35110 #: ../src/guestfs.pod:2736
35111 msgid "C<generator>"
35115 #: ../src/guestfs.pod:2738
35117 "The crucially important generator, used to automatically generate large "
35118 "amounts of boilerplate C code for things like RPC and bindings."
35122 #: ../src/guestfs.pod:2741
35127 #: ../src/guestfs.pod:2743
35128 msgid "Files used by the test suite."
35132 #: ../src/guestfs.pod:2745
35133 msgid "Some \"phony\" guest images which we test against."
35137 #: ../src/guestfs.pod:2747
35138 msgid "C<inspector>"
35142 #: ../src/guestfs.pod:2749
35143 msgid "L<virt-inspector(1)>, the virtual machine image inspector."
35147 #: ../src/guestfs.pod:2751
35152 #: ../src/guestfs.pod:2753
35153 msgid "Logo used on the website. The fish is called Arthur by the way."
35157 #: ../src/guestfs.pod:2755
35162 #: ../src/guestfs.pod:2757
35163 msgid "M4 macros used by autoconf."
35167 #: ../src/guestfs.pod:2759
35172 #: ../src/guestfs.pod:2761
35173 msgid "Translations of simple gettext strings."
35177 #: ../src/guestfs.pod:2763
35182 #: ../src/guestfs.pod:2765
35184 "The build infrastructure and PO files for translations of manpages and POD "
35185 "files. Eventually this will be combined with the C<po> directory, but that "
35186 "is rather complicated."
35190 #: ../src/guestfs.pod:2769
35191 msgid "C<regressions>"
35195 #: ../src/guestfs.pod:2771
35196 msgid "Regression tests."
35200 #: ../src/guestfs.pod:2773
35205 #: ../src/guestfs.pod:2775
35206 msgid "L<virt-rescue(1)> command and documentation."
35210 #: ../src/guestfs.pod:2777
35215 #: ../src/guestfs.pod:2779
35216 msgid "Source code to the C library."
35220 #: ../src/guestfs.pod:2781
35225 #: ../src/guestfs.pod:2783
35226 msgid "Command line tools written in Perl (L<virt-resize(1)> and many others)."
35230 #: ../src/guestfs.pod:2785
35231 msgid "C<test-tool>"
35235 #: ../src/guestfs.pod:2787
35237 "Test tool for end users to test if their qemu/kernel combination will work "
35242 #: ../src/guestfs.pod:2790
35247 #: ../src/guestfs.pod:2792
35252 #: ../src/guestfs.pod:2794
35257 #: ../src/guestfs.pod:2796
35262 #: ../src/guestfs.pod:2798
35267 #: ../src/guestfs.pod:2800
35272 #: ../src/guestfs.pod:2802
35277 #: ../src/guestfs.pod:2804
35282 #: ../src/guestfs.pod:2806
35283 msgid "Language bindings."
35287 #: ../src/guestfs.pod:2810
35288 msgid "MAKING A STABLE RELEASE"
35292 #: ../src/guestfs.pod:2812
35294 "When we make a stable release, there are several steps documented here. See "
35295 "L</LIBGUESTFS VERSION NUMBERS> for general information about the stable "
35300 #: ../src/guestfs.pod:2820
35301 msgid "Check C<make && make check> works on at least Fedora, Debian and Ubuntu."
35305 #: ../src/guestfs.pod:2825
35306 msgid "Finalize RELEASE-NOTES."
35310 #: ../src/guestfs.pod:2829
35311 msgid "Update ROADMAP."
35315 #: ../src/guestfs.pod:2833
35316 msgid "Run C<src/api-support/update-from-tarballs.sh>."
35320 #: ../src/guestfs.pod:2837
35321 msgid "Push and pull from Transifex."
35325 #: ../src/guestfs.pod:2839
35330 #: ../src/guestfs.pod:2841
35338 #: ../src/guestfs.pod:2843
35339 msgid "to push the latest POT files to Transifex. Then run:"
35343 #: ../src/guestfs.pod:2845
35351 #: ../src/guestfs.pod:2847
35352 msgid "which is a wrapper to pull the latest translated C<*.po> files."
35356 #: ../src/guestfs.pod:2851
35358 "Create new stable and development directories under "
35359 "L<http://libguestfs.org/download>."
35363 #: ../src/guestfs.pod:2856
35364 msgid "Create the branch in git:"
35368 #: ../src/guestfs.pod:2858
35371 " git tag -a 1.XX.0 -m \"Version 1.XX.0 (stable)\"\n"
35372 " git tag -a 1.YY.0 -m \"Version 1.YY.0 (development)\"\n"
35373 " git branch stable-1.XX\n"
35374 " git push origin tag 1.XX.0 1.YY.0 stable-1.XX\n"
35379 #: ../src/guestfs.pod:2865
35384 #: ../src/guestfs.pod:2867
35385 msgid "PROTOCOL LIMITS"
35389 #: ../src/guestfs.pod:2869
35391 "Internally libguestfs uses a message-based protocol to pass API calls and "
35392 "their responses to and from a small \"appliance\" (see L</INTERNALS> for "
35393 "plenty more detail about this). The maximum message size used by the "
35394 "protocol is slightly less than 4 MB. For some API calls you may need to be "
35395 "aware of this limit. The API calls which may be affected are individually "
35396 "documented, with a link back to this section of the documentation."
35400 #: ../src/guestfs.pod:2877
35402 "A simple call such as L</guestfs_cat> returns its result (the file data) in "
35403 "a simple string. Because this string is at some point internally encoded as "
35404 "a message, the maximum size that it can return is slightly under 4 MB. If "
35405 "the requested file is larger than this then you will get an error."
35409 #: ../src/guestfs.pod:2883
35411 "In order to transfer large files into and out of the guest filesystem, you "
35412 "need to use particular calls that support this. The sections L</UPLOADING> "
35413 "and L</DOWNLOADING> document how to do this."
35417 #: ../src/guestfs.pod:2887
35419 "You might also consider mounting the disk image using our FUSE filesystem "
35420 "support (L<guestmount(1)>)."
35424 #: ../src/guestfs.pod:2890
35425 msgid "MAXIMUM NUMBER OF DISKS"
35429 #: ../src/guestfs.pod:2892
35430 msgid "When using virtio disks (the default) the current limit is B<25> disks."
35434 #: ../src/guestfs.pod:2895
35436 "Virtio itself consumes 1 virtual PCI slot per disk, and PCI is limited to 31 "
35437 "slots. However febootstrap only understands disks with names C</dev/vda> "
35438 "through C</dev/vdz> (26 letters) and it reserves one disk for its own "
35443 #: ../src/guestfs.pod:2900
35445 "We are working to substantially raise this limit in future versions but it "
35446 "requires complex changes to qemu."
35450 #: ../src/guestfs.pod:2903
35452 "In future versions of libguestfs it should also be possible to \"hot plug\" "
35453 "disks (add and remove disks after calling L</guestfs_launch>). This also "
35454 "requires changes to qemu."
35458 #: ../src/guestfs.pod:2907
35459 msgid "MAXIMUM NUMBER OF PARTITIONS PER DISK"
35463 #: ../src/guestfs.pod:2909
35464 msgid "Virtio limits the maximum number of partitions per disk to B<15>."
35468 #: ../src/guestfs.pod:2911
35470 "This is because it reserves 4 bits for the minor device number (thus "
35471 "C</dev/vda>, and C</dev/vda1> through C</dev/vda15>)."
35475 #: ../src/guestfs.pod:2914
35477 "If you attach a disk with more than 15 partitions, the extra partitions are "
35478 "ignored by libguestfs."
35482 #: ../src/guestfs.pod:2917
35483 msgid "MAXIMUM SIZE OF A DISK"
35487 #: ../src/guestfs.pod:2919
35488 msgid "Probably the limit is between 2**63-1 and 2**64-1 bytes."
35492 #: ../src/guestfs.pod:2921
35494 "We have tested block devices up to 1 exabyte (2**60 or "
35495 "1,152,921,504,606,846,976 bytes) using sparse files backed by an XFS host "
35500 #: ../src/guestfs.pod:2925
35502 "Although libguestfs probably does not impose any limit, the underlying host "
35503 "storage will. If you store disk images on a host ext4 filesystem, then the "
35504 "maximum size will be limited by the maximum ext4 file size (currently 16 "
35505 "TB). If you store disk images as host logical volumes then you are limited "
35506 "by the maximum size of an LV."
35510 #: ../src/guestfs.pod:2931
35512 "For the hugest disk image files, we recommend using XFS on the host for "
35517 #: ../src/guestfs.pod:2934
35518 msgid "MAXIMUM SIZE OF A PARTITION"
35522 #: ../src/guestfs.pod:2936
35524 "The MBR (ie. classic MS-DOS) partitioning scheme uses 32 bit sector "
35525 "numbers. Assuming a 512 byte sector size, this means that MBR cannot "
35526 "address a partition located beyond 2 TB on the disk."
35530 #: ../src/guestfs.pod:2940
35532 "It is recommended that you use GPT partitions on disks which are larger than "
35533 "this size. GPT uses 64 bit sector numbers and so can address partitions "
35534 "which are theoretically larger than the largest disk we could support."
35538 #: ../src/guestfs.pod:2945
35539 msgid "MAXIMUM SIZE OF A FILESYSTEM, FILES, DIRECTORIES"
35543 #: ../src/guestfs.pod:2947
35545 "This depends on the filesystem type. libguestfs itself does not impose any "
35546 "known limit. Consult Wikipedia or the filesystem documentation to find out "
35547 "what these limits are."
35551 #: ../src/guestfs.pod:2951
35552 msgid "MAXIMUM UPLOAD AND DOWNLOAD"
35556 #: ../src/guestfs.pod:2953
35558 "The API functions L</guestfs_upload>, L</guestfs_download>, "
35559 "L</guestfs_tar_in>, L</guestfs_tar_out> and the like allow unlimited sized "
35560 "uploads and downloads."
35564 #: ../src/guestfs.pod:2957
35565 msgid "INSPECTION LIMITS"
35569 #: ../src/guestfs.pod:2959
35571 "The inspection code has several arbitrary limits on things like the size of "
35572 "Windows Registry hive it will read, and the length of product name. These "
35573 "are intended to stop a malicious guest from consuming arbitrary amounts of "
35574 "memory and disk space on the host, and should not be reached in practice. "
35575 "See the source code for more information."
35579 #: ../src/guestfs.pod:2985
35581 "Set C<LIBGUESTFS_DEBUG=1> to enable verbose messages. This has the same "
35582 "effect as calling C<guestfs_set_verbose (g, 1)>."
35586 #: ../src/guestfs.pod:2997
35588 "Set the path that libguestfs uses to search for a supermin appliance. See "
35589 "the discussion of paths in section L</PATH> above."
35593 #: ../src/guestfs.pod:3006
35594 msgid "See also L</QEMU WRAPPERS> above."
35598 #: ../src/guestfs.pod:3010
35600 "Set C<LIBGUESTFS_TRACE=1> to enable command traces. This has the same "
35601 "effect as calling C<guestfs_set_trace (g, 1)>."
35605 #: ../src/guestfs.pod:3028
35607 "L<guestfs-examples(3)>, L<guestfs-java(3)>, L<guestfs-ocaml(3)>, "
35608 "L<guestfs-perl(3)>, L<guestfs-python(3)>, L<guestfs-ruby(3)>, "
35609 "L<guestfish(1)>, L<guestmount(1)>, L<virt-cat(1)>, L<virt-copy-in(1)>, "
35610 "L<virt-copy-out(1)>, L<virt-df(1)>, L<virt-edit(1)>, L<virt-filesystems(1)>, "
35611 "L<virt-inspector(1)>, L<virt-list-filesystems(1)>, "
35612 "L<virt-list-partitions(1)>, L<virt-ls(1)>, L<virt-make-fs(1)>, "
35613 "L<virt-rescue(1)>, L<virt-tar(1)>, L<virt-tar-in(1)>, L<virt-tar-out(1)>, "
35614 "L<virt-win-reg(1)>, L<qemu(1)>, L<febootstrap(1)>, "
35615 "L<febootstrap-supermin-helper(8)>, L<hivex(3)>, L<http://libguestfs.org/>."
35619 #: ../src/guestfs.pod:3058
35621 "Tools with a similar purpose: L<fdisk(8)>, L<parted(8)>, L<kpartx(8)>, "
35622 "L<lvm(8)>, L<disktype(1)>."
35626 #: ../src/guestfs.pod:3065 ../tools/virt-make-fs.pl:553 ../tools/virt-win-reg.pl:761
35631 #: ../src/guestfs.pod:3067
35632 msgid "To get a list of bugs against libguestfs use this link:"
35636 #: ../src/guestfs.pod:3069
35637 msgid "L<https://bugzilla.redhat.com/buglist.cgi?component=libguestfs&product=Virtualization+Tools>"
35641 #: ../src/guestfs.pod:3071
35642 msgid "To report a new bug against libguestfs use this link:"
35646 #: ../src/guestfs.pod:3073
35647 msgid "L<https://bugzilla.redhat.com/enter_bug.cgi?component=libguestfs&product=Virtualization+Tools>"
35651 #: ../src/guestfs.pod:3075
35652 msgid "When reporting a bug, please check:"
35656 #: ../src/guestfs.pod:3081
35657 msgid "That the bug hasn't been reported already."
35661 #: ../src/guestfs.pod:3085
35662 msgid "That you are testing a recent version."
35666 #: ../src/guestfs.pod:3089
35667 msgid "Describe the bug accurately, and give a way to reproduce it."
35671 #: ../src/guestfs.pod:3093
35673 "Run libguestfs-test-tool and paste the B<complete, unedited> output into the "
35678 #: ../test-tool/libguestfs-test-tool.pod:5
35679 msgid "libguestfs-test-tool - End user tests for libguestfs"
35683 #: ../test-tool/libguestfs-test-tool.pod:9
35686 " libguestfs-test-tool [--options]\n"
35691 #: ../test-tool/libguestfs-test-tool.pod:13
35693 "libguestfs-test-tool is a test program shipped with libguestfs to end users "
35694 "and developers, to allow them to check basic libguestfs functionality is "
35695 "working. This is needed because libguestfs occasionally breaks for reasons "
35696 "beyond our control: usually because of changes in the underlying qemu or "
35697 "kernel packages, or the host environment."
35701 #: ../test-tool/libguestfs-test-tool.pod:20
35702 msgid "If you suspect a problem in libguestfs, then just run:"
35706 #: ../test-tool/libguestfs-test-tool.pod:22
35709 " libguestfs-test-tool\n"
35714 #: ../test-tool/libguestfs-test-tool.pod:24
35715 msgid "It will print lots of diagnostic messages."
35719 #: ../test-tool/libguestfs-test-tool.pod:26
35720 msgid "If it runs to completion successfully, you will see this near the end:"
35724 #: ../test-tool/libguestfs-test-tool.pod:28
35727 " ===== TEST FINISHED OK =====\n"
35732 #: ../test-tool/libguestfs-test-tool.pod:30
35733 msgid "and the test tool will exit with code 0."
35737 #: ../test-tool/libguestfs-test-tool.pod:32
35739 "If it fails (and/or exits with non-zero error code), please paste the "
35740 "B<complete, unedited> output of the test tool into a bug report. More "
35741 "information about reporting bugs can be found on the "
35742 "L<http://libguestfs.org/> website."
35746 #: ../test-tool/libguestfs-test-tool.pod:41
35751 #: ../test-tool/libguestfs-test-tool.pod:43
35752 msgid "Display short usage information and exit."
35756 #: ../test-tool/libguestfs-test-tool.pod:45
35757 msgid "I<--qemu qemu_binary>"
35761 #: ../test-tool/libguestfs-test-tool.pod:47
35763 "If you have downloaded another qemu binary, point this option at the full "
35764 "path of the binary to try it."
35768 #: ../test-tool/libguestfs-test-tool.pod:50
35769 msgid "I<--qemudir qemu_source_dir>"
35773 #: ../test-tool/libguestfs-test-tool.pod:52
35775 "If you have compiled qemu from source, point this option at the source "
35776 "directory to try it."
35780 #: ../test-tool/libguestfs-test-tool.pod:55
35781 msgid "I<--timeout N>"
35785 #: ../test-tool/libguestfs-test-tool.pod:57
35787 "Set the launch timeout to C<N> seconds. The default is 120 seconds which "
35788 "does not usually need to be adjusted unless your machine is very slow."
35792 #: ../test-tool/libguestfs-test-tool.pod:63
35793 msgid "TRYING OUT A DIFFERENT VERSION OF QEMU"
35797 #: ../test-tool/libguestfs-test-tool.pod:65
35799 "If you have compiled another version of qemu from source and would like to "
35800 "try that, then you can use the I<--qemudir> option to point to the qemu "
35801 "source directory."
35805 #: ../test-tool/libguestfs-test-tool.pod:69
35807 "If you have downloaded a qemu binary from somewhere, use the I<--qemu> "
35808 "option to point to the binary."
35812 #: ../test-tool/libguestfs-test-tool.pod:72
35814 "When using an alternate qemu with libguestfs, usually you would need to "
35815 "write a qemu wrapper script (see section I<QEMU WRAPPERS> in "
35816 "L<guestfs(3)>). libguestfs-test-tool writes a temporary qemu wrapper script "
35817 "when you use either of the I<--qemudir> or I<--qemu> options."
35821 #: ../test-tool/libguestfs-test-tool.pod:79
35823 "libguestfs-test-tool returns I<0> if the tests completed without error, or "
35824 "I<1> if there was an error."
35828 #: ../test-tool/libguestfs-test-tool.pod:84
35830 "For the full list of environment variables which may affect libguestfs, "
35831 "please see the L<guestfs(3)> manual page."
35835 #: ../test-tool/libguestfs-test-tool.pod:89
35836 msgid "L<guestfs(3)>, L<http://libguestfs.org/>, L<http://qemu.org/>."
35840 #: ../tools/virt-list-filesystems.pl:32
35841 msgid "virt-list-filesystems - List filesystems in a virtual machine or disk image"
35845 #: ../tools/virt-list-filesystems.pl:36
35848 " virt-list-filesystems [--options] domname\n"
35853 #: ../tools/virt-list-filesystems.pl:38
35856 " virt-list-filesystems [--options] disk.img [disk.img ...]\n"
35861 #: ../tools/virt-list-filesystems.pl:42 ../tools/virt-list-partitions.pl:42
35863 "This tool is obsolete. Use L<virt-filesystems(1)> as a more flexible "
35868 #: ../tools/virt-list-filesystems.pl:45
35870 "C<virt-list-filesystems> is a command line tool to list the filesystems that "
35871 "are contained in a virtual machine or disk image."
35875 #: ../tools/virt-list-filesystems.pl:49
35877 "C<virt-list-filesystems> is just a simple wrapper around L<libguestfs(3)> "
35878 "functionality. For more complex cases you should look at the "
35879 "L<guestfish(1)> tool."
35883 #: ../tools/virt-list-filesystems.pl:112
35885 "With this option, C<virt-list-filesystems> displays the type of each "
35886 "filesystem too (where \"type\" means C<ext3>, C<xfs> etc.)"
35890 #: ../tools/virt-list-filesystems.pl:119
35895 #: ../tools/virt-list-filesystems.pl:123
35897 "Normally we only show mountable filesystems. If this option is given then "
35898 "swap devices are shown too."
35902 #: ../tools/virt-list-filesystems.pl:197
35904 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-tar(1)>, "
35905 "L<virt-filesystems(1)>, L<virt-list-partitions(1)>, L<Sys::Guestfs(3)>, "
35906 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
35910 #: ../tools/virt-list-filesystems.pl:214 ../tools/virt-tar.pl:317
35911 msgid "Copyright (C) 2009 Red Hat Inc."
35915 #: ../tools/virt-list-partitions.pl:32
35916 msgid "virt-list-partitions - List partitions in a virtual machine or disk image"
35920 #: ../tools/virt-list-partitions.pl:36
35923 " virt-list-partitions [--options] domname\n"
35928 #: ../tools/virt-list-partitions.pl:38
35931 " virt-list-partitions [--options] disk.img [disk.img ...]\n"
35936 #: ../tools/virt-list-partitions.pl:45
35938 "C<virt-list-partitions> is a command line tool to list the partitions that "
35939 "are contained in a virtual machine or disk image. It is mainly useful as a "
35940 "first step to using L<virt-resize(1)>."
35944 #: ../tools/virt-list-partitions.pl:50
35946 "C<virt-list-partitions> is just a simple wrapper around L<libguestfs(3)> "
35947 "functionality. For more complex cases you should look at the "
35948 "L<guestfish(1)> tool."
35952 #: ../tools/virt-list-partitions.pl:113
35953 msgid "Show sizes in human-readable form (eg. \"1G\")."
35957 #: ../tools/virt-list-partitions.pl:123
35959 "With this option, C<virt-list-partitions> displays the type and size of each "
35960 "partition too (where \"type\" means C<ext3>, C<pv> etc.)"
35964 #: ../tools/virt-list-partitions.pl:130
35969 #: ../tools/virt-list-partitions.pl:132
35974 #: ../tools/virt-list-partitions.pl:134
35975 msgid "Display the total size of each block device (as a separate row or rows)."
35979 #: ../tools/virt-list-partitions.pl:267
35981 "L<guestfs(3)>, L<guestfish(1)>, L<virt-filesystems(1)>, "
35982 "L<virt-list-filesystems(1)>, L<virt-resize(1)>, L<Sys::Guestfs(3)>, "
35983 "L<Sys::Guestfs::Lib(3)>, L<Sys::Virt(3)>, L<http://libguestfs.org/>."
35987 #: ../tools/virt-list-partitions.pl:283
35988 msgid "Copyright (C) 2009-2010 Red Hat Inc."
35992 #: ../tools/virt-make-fs.pl:37
35993 msgid "virt-make-fs - Make a filesystem from a tar archive or files"
35997 #: ../tools/virt-make-fs.pl:41
36000 " virt-make-fs [--options] input.tar output.img\n"
36005 #: ../tools/virt-make-fs.pl:43
36008 " virt-make-fs [--options] input.tar.gz output.img\n"
36013 #: ../tools/virt-make-fs.pl:45
36016 " virt-make-fs [--options] directory output.img\n"
36021 #: ../tools/virt-make-fs.pl:49
36023 "Virt-make-fs is a command line tool for creating a filesystem from a tar "
36024 "archive or some files in a directory. It is similar to tools like "
36025 "L<mkisofs(1)>, L<genisoimage(1)> and L<mksquashfs(1)>. Unlike those tools, "
36026 "it can create common filesystem types like ext2/3 or NTFS, which can be "
36027 "useful if you want to attach these filesystems to existing virtual machines "
36028 "(eg. to import large amounts of read-only data to a VM)."
36032 #: ../tools/virt-make-fs.pl:57
36033 msgid "Basic usage is:"
36037 #: ../tools/virt-make-fs.pl:59
36040 " virt-make-fs input output\n"
36045 #: ../tools/virt-make-fs.pl:61
36047 "where C<input> is either a directory containing files that you want to add, "
36048 "or a tar archive (either uncompressed tar or gzip-compressed tar); and "
36049 "C<output> is a disk image. The input type is detected automatically. The "
36050 "output disk image defaults to a raw ext2 image unless you specify extra "
36051 "flags (see L</OPTIONS> below)."
36055 #: ../tools/virt-make-fs.pl:67
36056 msgid "EXTRA SPACE"
36060 #: ../tools/virt-make-fs.pl:69
36062 "Unlike formats such as tar and squashfs, a filesystem does not \"just fit\" "
36063 "the files that it contains, but might have extra space. Depending on how "
36064 "you are going to use the output, you might think this extra space is wasted "
36065 "and want to minimize it, or you might want to leave space so that more files "
36066 "can be added later. Virt-make-fs defaults to minimizing the extra space, "
36067 "but you can use the I<--size> flag to leave space in the filesystem if you "
36072 #: ../tools/virt-make-fs.pl:77
36074 "An alternative way to leave extra space but not make the output image any "
36075 "bigger is to use an alternative disk image format (instead of the default "
36076 "\"raw\" format). Using I<--format=qcow2> will use the native QEmu/KVM qcow2 "
36077 "image format (check your hypervisor supports this before using it). This "
36078 "allows you to choose a large I<--size> but the extra space won't actually be "
36079 "allocated in the image until you try to store something in it."
36083 #: ../tools/virt-make-fs.pl:85
36085 "Don't forget that you can also use local commands including L<resize2fs(8)> "
36086 "and L<virt-resize(1)> to resize existing filesystems, or rerun virt-make-fs "
36087 "to build another image from scratch."
36091 #: ../tools/virt-make-fs.pl:89 ../tools/virt-make-fs.pl:123 ../tools/virt-make-fs.pl:142
36096 #: ../tools/virt-make-fs.pl:91
36099 " virt-make-fs --format=qcow2 --size=+200M input output.img\n"
36104 #: ../tools/virt-make-fs.pl:93
36105 msgid "FILESYSTEM TYPE"
36109 #: ../tools/virt-make-fs.pl:95
36111 "The default filesystem type is C<ext2>. Just about any filesystem type that "
36112 "libguestfs supports can be used (but I<not> read-only formats like "
36113 "ISO9660). Here are some of the more common choices:"
36117 #: ../tools/virt-make-fs.pl:101
36122 #: ../tools/virt-make-fs.pl:103
36124 "Note that ext3 filesystems contain a journal, typically 1-32 MB in size. If "
36125 "you are not going to use the filesystem in a way that requires the journal, "
36126 "then this is just wasted overhead."
36130 #: ../tools/virt-make-fs.pl:107
36131 msgid "I<ntfs> or I<vfat>"
36135 #: ../tools/virt-make-fs.pl:109
36136 msgid "Useful if exporting data to a Windows guest."
36140 #: ../tools/virt-make-fs.pl:111
36142 "I<Note for vfat>: The tar archive or local directory must only contain files "
36143 "which are owned by root (ie. UID:GID = 0:0). The reason is that the tar "
36144 "program running within libguestfs is unable to change the ownership of "
36145 "non-root files, since vfat itself does not support this."
36149 #: ../tools/virt-make-fs.pl:116
36154 #: ../tools/virt-make-fs.pl:118
36156 "Lower overhead than C<ext2>, but certain limitations on filename length and "
36157 "total filesystem size."
36161 #: ../tools/virt-make-fs.pl:125
36164 " virt-make-fs --type=minix input minixfs.img\n"
36169 #: ../tools/virt-make-fs.pl:127
36170 msgid "TO PARTITION OR NOT TO PARTITION"
36174 #: ../tools/virt-make-fs.pl:129
36175 msgid "Optionally virt-make-fs can add a partition table to the output disk."
36179 #: ../tools/virt-make-fs.pl:131
36181 "Adding a partition can make the disk image more compatible with certain "
36182 "virtualized operating systems which don't expect to see a filesystem "
36183 "directly located on a block device (Linux doesn't care and will happily "
36184 "handle both types)."
36188 #: ../tools/virt-make-fs.pl:136
36190 "On the other hand, if you have a partition table then the output image is no "
36191 "longer a straight filesystem. For example you cannot run L<fsck(8)> "
36192 "directly on a partitioned disk image. (However libguestfs tools such as "
36193 "L<guestfish(1)> and L<virt-resize(1)> can still be used)."
36197 #: ../tools/virt-make-fs.pl:144
36198 msgid "Add an MBR partition:"
36202 #: ../tools/virt-make-fs.pl:146
36205 " virt-make-fs --partition -- input disk.img\n"
36210 #: ../tools/virt-make-fs.pl:148
36212 "If the output disk image could be terabyte-sized or larger, it's better to "
36213 "use an EFI/GPT-compatible partition table:"
36217 #: ../tools/virt-make-fs.pl:151
36220 " virt-make-fs --partition=gpt --size=+4T --format=qcow2 input disk.img\n"
36225 #: ../tools/virt-make-fs.pl:179
36226 msgid "Enable debugging information."
36230 #: ../tools/virt-make-fs.pl:185
36231 msgid "B<--size=E<lt>NE<gt>>"
36235 #: ../tools/virt-make-fs.pl:187
36236 msgid "B<--size=+E<lt>NE<gt>>"
36240 #: ../tools/virt-make-fs.pl:189
36241 msgid "B<-s E<lt>NE<gt>>"
36245 #: ../tools/virt-make-fs.pl:191
36246 msgid "B<-s +E<lt>NE<gt>>"
36250 #: ../tools/virt-make-fs.pl:193
36251 msgid "Use the I<--size> (or I<-s>) option to choose the size of the output image."
36255 #: ../tools/virt-make-fs.pl:196
36257 "If this option is I<not> given, then the output image will be just large "
36258 "enough to contain all the files, with not much wasted space."
36262 #: ../tools/virt-make-fs.pl:199
36264 "To choose a fixed size output disk, specify an absolute number followed by "
36265 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
36266 "Petabytes or Exabytes. This must be large enough to contain all the input "
36267 "files, else you will get an error."
36271 #: ../tools/virt-make-fs.pl:204
36273 "To leave extra space, specify C<+> (plus sign) and a number followed by "
36274 "b/K/M/G/T/P/E to mean bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, "
36275 "Petabytes or Exabytes. For example: I<--size=+200M> means enough space for "
36276 "the input files, and (approximately) an extra 200 MB free space."
36280 #: ../tools/virt-make-fs.pl:210
36282 "Note that virt-make-fs estimates free space, and therefore will not produce "
36283 "filesystems containing precisely the free space requested. (It is much more "
36284 "expensive and time-consuming to produce a filesystem which has precisely the "
36285 "desired free space)."
36289 #: ../tools/virt-make-fs.pl:219
36290 msgid "B<--format=E<lt>fmtE<gt>>"
36294 #: ../tools/virt-make-fs.pl:221
36295 msgid "B<-F E<lt>fmtE<gt>>"
36299 #: ../tools/virt-make-fs.pl:223
36300 msgid "Choose the output disk image format."
36304 #: ../tools/virt-make-fs.pl:225
36305 msgid "The default is C<raw> (raw disk image)."
36309 #: ../tools/virt-make-fs.pl:227
36311 "For other choices, see the L<qemu-img(1)> manpage. The only other choice "
36312 "that would really make sense here is C<qcow2>."
36316 #: ../tools/virt-make-fs.pl:234
36317 msgid "B<--type=E<lt>fsE<gt>>"
36321 #: ../tools/virt-make-fs.pl:236
36322 msgid "B<-t E<lt>fsE<gt>>"
36326 #: ../tools/virt-make-fs.pl:238
36327 msgid "Choose the output filesystem type."
36331 #: ../tools/virt-make-fs.pl:240
36332 msgid "The default is C<ext2>."
36336 #: ../tools/virt-make-fs.pl:242
36337 msgid "Any filesystem which is supported read-write by libguestfs can be used here."
36341 #: ../tools/virt-make-fs.pl:249
36342 msgid "B<--partition>"
36346 #: ../tools/virt-make-fs.pl:251
36347 msgid "B<--partition=E<lt>parttypeE<gt>>"
36351 #: ../tools/virt-make-fs.pl:253
36353 "If specified, this flag adds an MBR partition table to the output disk "
36358 #: ../tools/virt-make-fs.pl:256
36360 "You can change the partition table type, eg. I<--partition=gpt> for large "
36365 #: ../tools/virt-make-fs.pl:259
36367 "Note that if you just use a lonesome I<--partition>, the Perl option parser "
36368 "might consider the next parameter to be the partition type. For example:"
36372 #: ../tools/virt-make-fs.pl:263
36375 " virt-make-fs --partition input.tar ...\n"
36380 #: ../tools/virt-make-fs.pl:265
36382 "would cause virt-make-fs to think you wanted to use a partition type of "
36383 "C<input.tar> which is completely wrong. To avoid this, use I<--> (a double "
36384 "dash) between options and the input file argument:"
36388 #: ../tools/virt-make-fs.pl:269
36391 " virt-make-fs --partition -- input.tar ...\n"
36396 #: ../tools/virt-make-fs.pl:541
36398 "L<guestfish(1)>, L<virt-resize(1)>, L<virt-tar-in(1)>, L<mkisofs(1)>, "
36399 "L<genisoimage(1)>, L<mksquashfs(1)>, L<mke2fs(8)>, L<resize2fs(8)>, "
36400 "L<guestfs(3)>, L<Sys::Guestfs(3)>, L<http://libguestfs.org/>."
36404 #: ../tools/virt-make-fs.pl:555 ../tools/virt-win-reg.pl:763
36406 "When reporting bugs, please enable debugging and capture the I<complete> "
36411 #: ../tools/virt-make-fs.pl:558
36414 " export LIBGUESTFS_DEBUG=1\n"
36415 " virt-make-fs --debug [...] > /tmp/virt-make-fs.log 2>&1\n"
36420 #: ../tools/virt-make-fs.pl:561
36422 "Attach /tmp/virt-make-fs.log to a new bug report at "
36423 "L<https://bugzilla.redhat.com/>"
36427 #: ../tools/virt-tar.pl:33
36428 msgid "virt-tar - Extract or upload files to a virtual machine"
36432 #: ../tools/virt-tar.pl:37
36435 " virt-tar [--options] -x domname directory tarball\n"
36440 #: ../tools/virt-tar.pl:39
36443 " virt-tar [--options] -u domname tarball directory\n"
36448 #: ../tools/virt-tar.pl:41
36451 " virt-tar [--options] disk.img [disk.img ...] -x directory tarball\n"
36456 #: ../tools/virt-tar.pl:43
36459 " virt-tar [--options] disk.img [disk.img ...] -u tarball directory\n"
36464 #: ../tools/virt-tar.pl:45 ../tools/virt-win-reg.pl:88
36469 #: ../tools/virt-tar.pl:47
36471 "This tool is obsolete. Use L<virt-copy-in(1)>, L<virt-copy-out(1)>, "
36472 "L<virt-tar-in(1)>, L<virt-tar-out(1)> as replacements."
36476 #: ../tools/virt-tar.pl:52
36477 msgid "Download C</home> from the VM into a local tarball:"
36481 #: ../tools/virt-tar.pl:54
36484 " virt-tar -x domname /home home.tar\n"
36489 #: ../tools/virt-tar.pl:56
36492 " virt-tar -zx domname /home home.tar.gz\n"
36497 #: ../tools/virt-tar.pl:58
36498 msgid "Upload a local tarball and unpack it inside C</tmp> in the VM:"
36502 #: ../tools/virt-tar.pl:60
36505 " virt-tar -u domname uploadstuff.tar /tmp\n"
36510 #: ../tools/virt-tar.pl:62
36513 " virt-tar -zu domname uploadstuff.tar.gz /tmp\n"
36518 #: ../tools/virt-tar.pl:66
36520 "You must I<not> use C<virt-tar> with the I<-u> option (upload) on live "
36521 "virtual machines. If you do this, you risk disk corruption in the VM. "
36522 "C<virt-tar> tries to stop you from doing this, but doesn't catch all cases."
36526 #: ../tools/virt-tar.pl:71
36528 "You can use I<-x> (extract) on live virtual machines, but you might get "
36529 "inconsistent results or errors if there is filesystem activity inside the "
36530 "VM. If the live VM is synched and quiescent, then C<virt-tar> will usually "
36531 "work, but the only way to guarantee consistent results is if the virtual "
36532 "machine is shut down."
36536 #: ../tools/virt-tar.pl:79
36538 "C<virt-tar> is a general purpose archive tool for downloading and uploading "
36539 "parts of a guest filesystem. There are many possibilities: making backups, "
36540 "uploading data files, snooping on guest activity, fixing or customizing "
36545 #: ../tools/virt-tar.pl:84
36547 "If you want to just view a single file, use L<virt-cat(1)>. If you just "
36548 "want to edit a single file, use L<virt-edit(1)>. For more complex cases you "
36549 "should look at the L<guestfish(1)> tool."
36553 #: ../tools/virt-tar.pl:88
36555 "There are two modes of operation: I<-x> (eXtract) downloads a directory and "
36556 "its contents (recursively) from the virtual machine into a local tarball. "
36557 "I<-u> uploads from a local tarball, unpacking it into a directory inside the "
36558 "virtual machine. You cannot use these two options together."
36562 #: ../tools/virt-tar.pl:94
36564 "In addition, you may need to use the I<-z> (gZip) option to enable "
36565 "compression. When uploading, you have to specify I<-z> if the upload file "
36566 "is compressed because virt-tar won't detect this on its own."
36570 #: ../tools/virt-tar.pl:98
36572 "C<virt-tar> can only handle tar (optionally gzipped) format tarballs. For "
36573 "example it cannot do PKZip files or bzip2 compression. If you want that "
36574 "then you'll have to rebuild the tarballs yourself. (This is a limitation of "
36575 "the L<libguestfs(3)> API)."
36579 #: ../tools/virt-tar.pl:160
36580 msgid "B<--extract>"
36584 #: ../tools/virt-tar.pl:162
36585 msgid "B<--download>"
36589 #: ../tools/virt-tar.pl:164
36594 #: ../tools/virt-tar.pl:166
36595 msgid "B<--upload>"
36599 #: ../tools/virt-tar.pl:168
36601 "Use I<-x> to extract (download) a directory from a virtual machine to a "
36606 #: ../tools/virt-tar.pl:171
36608 "Use I<-u> to upload and unpack from a local tarball into a virtual machine. "
36609 "Please read the L</WARNING> section above before using this option."
36613 #: ../tools/virt-tar.pl:175
36614 msgid "You must specify exactly one of these options."
36618 #: ../tools/virt-tar.pl:181
36623 #: ../tools/virt-tar.pl:183
36628 #: ../tools/virt-tar.pl:185
36629 msgid "Specify that the input or output tarball is gzip-compressed."
36633 #: ../tools/virt-tar.pl:298
36635 "L<guestfs(3)>, L<guestfish(1)>, L<virt-cat(1)>, L<virt-edit(1)>, "
36636 "L<virt-copy-in(1)>, L<virt-copy-out(1)>, L<virt-tar-in(1)>, "
36637 "L<virt-tar-out(1)>, L<Sys::Guestfs(3)>, L<Sys::Guestfs::Lib(3)>, "
36638 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
36642 #: ../tools/virt-win-reg.pl:37
36644 "virt-win-reg - Export and merge Windows Registry entries from a Windows "
36649 #: ../tools/virt-win-reg.pl:41
36652 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey'\n"
36657 #: ../tools/virt-win-reg.pl:43
36660 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' name\n"
36665 #: ../tools/virt-win-reg.pl:45
36668 " virt-win-reg domname 'HKLM\\Path\\To\\Subkey' @\n"
36673 #: ../tools/virt-win-reg.pl:47
36676 " virt-win-reg --merge domname [input.reg ...]\n"
36681 #: ../tools/virt-win-reg.pl:49
36684 " virt-win-reg [--options] disk.img ... # instead of domname\n"
36689 #: ../tools/virt-win-reg.pl:53
36691 "You must I<not> use C<virt-win-reg> with the I<--merge> option on live "
36692 "virtual machines. If you do this, you I<will> get irreversible disk "
36693 "corruption in the VM. C<virt-win-reg> tries to stop you from doing this, "
36694 "but doesn't catch all cases."
36698 #: ../tools/virt-win-reg.pl:58
36700 "Modifying the Windows Registry is an inherently risky operation. The format "
36701 "is deliberately obscure and undocumented, and Registry changes can leave the "
36702 "system unbootable. Therefore when using the I<--merge> option, make sure "
36703 "you have a reliable backup first."
36707 #: ../tools/virt-win-reg.pl:65
36709 "This program can export and merge Windows Registry entries from a Windows "
36714 #: ../tools/virt-win-reg.pl:68
36716 "The first parameter is the libvirt guest name or the raw disk image of a "
36721 #: ../tools/virt-win-reg.pl:71
36723 "If I<--merge> is I<not> specified, then the chosen registry key is "
36724 "displayed/exported (recursively). For example:"
36728 #: ../tools/virt-win-reg.pl:74
36731 " $ virt-win-reg Windows7 'HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft'\n"
36736 #: ../tools/virt-win-reg.pl:76
36737 msgid "You can also display single values from within registry keys, for example:"
36741 #: ../tools/virt-win-reg.pl:79
36744 " $ cvkey='HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion'\n"
36745 " $ virt-win-reg Windows7 $cvkey ProductName\n"
36746 " Windows 7 Enterprise\n"
36751 #: ../tools/virt-win-reg.pl:83
36753 "With I<--merge>, you can merge a textual regedit file into the Windows "
36758 #: ../tools/virt-win-reg.pl:86
36761 " $ virt-win-reg --merge Windows7 changes.reg\n"
36766 #: ../tools/virt-win-reg.pl:90
36768 "This program is only meant for simple access to the registry. If you want "
36769 "to do complicated things with the registry, we suggest you download the "
36770 "Registry hive files from the guest using L<libguestfs(3)> or L<guestfish(1)> "
36771 "and access them locally, eg. using L<hivex(3)>, L<hivexsh(1)> or "
36772 "L<hivexregedit(1)>."
36776 #: ../tools/virt-win-reg.pl:159
36781 #: ../tools/virt-win-reg.pl:161
36783 "In merge mode, this merges a textual regedit file into the Windows Registry "
36784 "of the virtual machine. If this flag is I<not> given then virt-win-reg "
36785 "displays or exports Registry entries instead."
36789 #: ../tools/virt-win-reg.pl:165
36791 "Note that I<--merge> is I<unsafe> to use on live virtual machines, and will "
36792 "result in disk corruption. However exporting (without this flag) is always "
36797 #: ../tools/virt-win-reg.pl:173
36798 msgid "B<--encoding> UTF-16LE|ASCII"
36802 #: ../tools/virt-win-reg.pl:175
36804 "When merging (only), you may need to specify the encoding for strings to be "
36805 "used in the hive file. This is explained in detail in "
36806 "L<Win::Hivex::Regedit(3)/ENCODING STRINGS>."
36810 #: ../tools/virt-win-reg.pl:179
36812 "The default is to use UTF-16LE, which should work with recent versions of "
36817 #: ../tools/virt-win-reg.pl:186
36818 msgid "B<--unsafe-printable-strings>"
36822 #: ../tools/virt-win-reg.pl:188
36824 "When exporting (only), assume strings are UTF-16LE and print them as strings "
36825 "instead of hex sequences. Remove the final zero codepoint from strings if "
36830 #: ../tools/virt-win-reg.pl:192
36832 "This is unsafe and does not preserve the fidelity of strings in the original "
36833 "Registry for various reasons:"
36837 #: ../tools/virt-win-reg.pl:199
36839 "Assumes the original encoding is UTF-16LE. ASCII strings and strings in "
36840 "other encodings will be corrupted by this transformation."
36844 #: ../tools/virt-win-reg.pl:204
36846 "Assumes that everything which has type 1 or 2 is really a string and that "
36847 "everything else is not a string, but the type field in real Registries is "
36852 #: ../tools/virt-win-reg.pl:210
36854 "Loses information about whether a zero codepoint followed the string in the "
36859 #: ../tools/virt-win-reg.pl:215
36861 "This all happens because the Registry itself contains no information about "
36862 "how strings are encoded (see L<Win::Hivex::Regedit(3)/ENCODING STRINGS>)."
36866 #: ../tools/virt-win-reg.pl:219
36868 "You should only use this option for quick hacking and debugging of the "
36869 "Registry contents, and I<never> use it if the output is going to be passed "
36870 "into another program or stored in another Registry."
36874 #: ../tools/virt-win-reg.pl:556
36875 msgid "SUPPORTED SYSTEMS"
36879 #: ../tools/virt-win-reg.pl:558
36881 "The program currently supports Windows NT-derived guests starting with "
36882 "Windows XP through to at least Windows 7."
36886 #: ../tools/virt-win-reg.pl:561
36887 msgid "The following Registry keys are supported:"
36891 #: ../tools/virt-win-reg.pl:565
36892 msgid "C<HKEY_LOCAL_MACHINE\\SAM>"
36896 #: ../tools/virt-win-reg.pl:567
36897 msgid "C<HKEY_LOCAL_MACHINE\\SECURITY>"
36901 #: ../tools/virt-win-reg.pl:569
36902 msgid "C<HKEY_LOCAL_MACHINE\\SOFTWARE>"
36906 #: ../tools/virt-win-reg.pl:571
36907 msgid "C<HKEY_LOCAL_MACHINE\\SYSTEM>"
36911 #: ../tools/virt-win-reg.pl:573
36912 msgid "C<HKEY_USERS\\.DEFAULT>"
36916 #: ../tools/virt-win-reg.pl:575
36917 msgid "C<HKEY_USERS\\I<SID>>"
36921 #: ../tools/virt-win-reg.pl:577
36922 msgid "where I<SID> is a Windows User SID (eg. C<S-1-5-18>)."
36926 #: ../tools/virt-win-reg.pl:579
36927 msgid "C<HKEY_USERS\\I<username>>"
36931 #: ../tools/virt-win-reg.pl:581
36932 msgid "where I<username> is a local user name (this is a libguestfs extension)."
36936 #: ../tools/virt-win-reg.pl:585
36938 "You can use C<HKLM> as a shorthand for C<HKEY_LOCAL_MACHINE>, and C<HKU> for "
36943 #: ../tools/virt-win-reg.pl:588
36945 "The literal keys C<HKEY_USERS\\$SID> and C<HKEY_CURRENT_USER> are not "
36946 "supported (there is no \"current user\")."
36950 #: ../tools/virt-win-reg.pl:591
36955 #: ../tools/virt-win-reg.pl:593
36957 "C<virt-win-reg> expects that regedit files have already been reencoded in "
36958 "the local encoding. Usually on Linux hosts, this means UTF-8 with "
36959 "Unix-style line endings. Since Windows regedit files are often in UTF-16LE "
36960 "with Windows-style line endings, you may need to reencode the whole file "
36961 "before or after processing."
36965 #: ../tools/virt-win-reg.pl:599
36967 "To reencode a file from Windows format to Linux (before processing it with "
36968 "the I<--merge> option), you would do something like this:"
36972 #: ../tools/virt-win-reg.pl:602
36975 " iconv -f utf-16le -t utf-8 < win.reg | dos2unix > linux.reg\n"
36980 #: ../tools/virt-win-reg.pl:604
36982 "To go in the opposite direction, after exporting and before sending the file "
36983 "to a Windows user, do something like this:"
36987 #: ../tools/virt-win-reg.pl:607
36990 " unix2dos linux.reg | iconv -f utf-8 -t utf-16le > win.reg\n"
36995 #: ../tools/virt-win-reg.pl:609
36996 msgid "For more information about encoding, see L<Win::Hivex::Regedit(3)>."
37000 #: ../tools/virt-win-reg.pl:611
37002 "If you are unsure about the current encoding, use the L<file(1)> command. "
37003 "Recent versions of Windows regedit.exe produce a UTF-16LE file with "
37004 "Windows-style (CRLF) line endings, like this:"
37008 #: ../tools/virt-win-reg.pl:615
37011 " $ file software.reg\n"
37012 " software.reg: Little-endian UTF-16 Unicode text, with very long lines,\n"
37013 " with CRLF line terminators\n"
37018 #: ../tools/virt-win-reg.pl:619
37019 msgid "This file would need conversion before you could I<--merge> it."
37023 #: ../tools/virt-win-reg.pl:621
37024 msgid "CurrentControlSet etc."
37028 #: ../tools/virt-win-reg.pl:623
37030 "Registry keys like C<CurrentControlSet> don't really exist in the Windows "
37031 "Registry at the level of the hive file, and therefore you cannot modify "
37036 #: ../tools/virt-win-reg.pl:627
37038 "C<CurrentControlSet> is usually an alias for C<ControlSet001>. In some "
37039 "circumstances it might refer to another control set. The way to find out is "
37040 "to look at the C<HKLM\\SYSTEM\\Select> key:"
37044 #: ../tools/virt-win-reg.pl:631
37047 " # virt-win-reg WindowsGuest 'HKLM\\SYSTEM\\Select'\n"
37048 " [HKEY_LOCAL_MACHINE\\SYSTEM\\Select]\n"
37049 " \"Current\"=dword:00000001\n"
37050 " \"Default\"=dword:00000001\n"
37051 " \"Failed\"=dword:00000000\n"
37052 " \"LastKnownGood\"=dword:00000002\n"
37057 #: ../tools/virt-win-reg.pl:638
37058 msgid "\"Current\" is the one which Windows will choose when it boots."
37062 #: ../tools/virt-win-reg.pl:640
37063 msgid "Similarly, other C<Current...> keys in the path may need to be replaced."
37067 #: ../tools/virt-win-reg.pl:643
37068 msgid "WINDOWS TIPS"
37072 #: ../tools/virt-win-reg.pl:645
37074 "Note that some of these tips modify the guest disk image. The guest I<must> "
37075 "be shut off, else you will get disk corruption."
37079 #: ../tools/virt-win-reg.pl:648
37080 msgid "RUNNING A BATCH SCRIPT WHEN A USER LOGS IN"
37084 #: ../tools/virt-win-reg.pl:650
37086 "Prepare a DOS batch script, VBScript or executable. Upload this using "
37087 "L<guestfish(1)>. For this example the script is called C<test.bat> and it "
37088 "is uploaded into C<C:\\>:"
37092 #: ../tools/virt-win-reg.pl:654
37095 " guestfish -i -d WindowsGuest upload test.bat /test.bat\n"
37100 #: ../tools/virt-win-reg.pl:656
37101 msgid "Prepare a regedit file containing the registry change:"
37105 #: ../tools/virt-win-reg.pl:658
37108 " cat > test.reg <<'EOF'\n"
37109 " [HKLM\\Software\\Microsoft\\Windows\\CurrentVersion\\RunOnce]\n"
37110 " \"Test\"=\"c:\\\\test.bat\"\n"
37116 #: ../tools/virt-win-reg.pl:663
37118 "In this example we use the key C<RunOnce> which means that the script will "
37119 "run precisely once when the first user logs in. If you want it to run every "
37120 "time a user logs in, replace C<RunOnce> with C<Run>."
37124 #: ../tools/virt-win-reg.pl:667
37125 msgid "Now update the registry:"
37129 #: ../tools/virt-win-reg.pl:669
37132 " virt-win-reg --merge WindowsGuest test.reg\n"
37137 #: ../tools/virt-win-reg.pl:671
37138 msgid "INSTALLING A SERVICE"
37142 #: ../tools/virt-win-reg.pl:673
37144 "This section assumes you are familiar with Windows services, and you either "
37145 "have a program which handles the Windows Service Control Protocol directly "
37146 "or you want to run any program using a service wrapper like SrvAny or the "
37151 #: ../tools/virt-win-reg.pl:678
37153 "First upload the program and optionally the service wrapper. In this case "
37154 "the test program is called C<test.exe> and we are using the RHSrvAny "
37159 #: ../tools/virt-win-reg.pl:682
37162 " guestfish -i -d WindowsGuest <<EOF\n"
37163 " upload rhsrvany.exe /rhsrvany.exe\n"
37164 " upload test.exe /test.exe\n"
37170 #: ../tools/virt-win-reg.pl:687
37172 "Prepare a regedit file containing the registry changes. In this example, "
37173 "the first registry change is needed for the service itself or the service "
37174 "wrapper (if used). The second registry change is only needed because I am "
37175 "using the RHSrvAny service wrapper."
37179 #: ../tools/virt-win-reg.pl:692
37182 " cat > service.reg <<'EOF'\n"
37183 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny]\n"
37184 " \"Type\"=dword:00000010\n"
37185 " \"Start\"=dword:00000002\n"
37186 " \"ErrorControl\"=dword:00000001\n"
37187 " \"ImagePath\"=\"c:\\\\rhsrvany.exe\"\n"
37188 " \"DisplayName\"=\"RHSrvAny\"\n"
37189 " \"ObjectName\"=\"NetworkService\"\n"
37194 #: ../tools/virt-win-reg.pl:701
37197 " [HKLM\\SYSTEM\\ControlSet001\\services\\RHSrvAny\\Parameters]\n"
37198 " \"CommandLine\"=\"c:\\\\test.exe\"\n"
37199 " \"PWD\"=\"c:\\\\Temp\"\n"
37205 #: ../tools/virt-win-reg.pl:712
37207 "For use of C<ControlSet001> see the section above in this manual page. You "
37208 "may need to adjust this according to the control set that is in use by the "
37213 #: ../tools/virt-win-reg.pl:718
37215 "C<\"ObjectName\"> controls the privileges that the service will have. An "
37216 "alternative is C<\"ObjectName\"=\"LocalSystem\"> which would be the most "
37217 "privileged account."
37221 #: ../tools/virt-win-reg.pl:724
37223 "For the meaning of the magic numbers, see this Microsoft KB article: "
37224 "L<http://support.microsoft.com/kb/103000>."
37228 #: ../tools/virt-win-reg.pl:729
37229 msgid "Update the registry:"
37233 #: ../tools/virt-win-reg.pl:731
37236 " virt-win-reg --merge WindowsGuest service.reg\n"
37241 #: ../tools/virt-win-reg.pl:735
37243 "Be careful when passing parameters containing C<\\> (backslash) in the "
37244 "shell. Usually you will have to use 'single quotes' or double backslashes "
37245 "(but not both) to protect them from the shell."
37249 #: ../tools/virt-win-reg.pl:739
37250 msgid "Paths and value names are case-insensitive."
37254 #: ../tools/virt-win-reg.pl:748
37256 "L<hivex(3)>, L<hivexsh(1)>, L<hivexregedit(1)>, L<guestfs(3)>, "
37257 "L<guestfish(1)>, L<virt-cat(1)>, L<Sys::Guestfs(3)>, "
37258 "L<Sys::Guestfs::Lib(3)>, L<Win::Hivex(3)>, L<Win::Hivex::Regedit(3)>, "
37259 "L<Sys::Virt(3)>, L<http://libguestfs.org/>."
37263 #: ../tools/virt-win-reg.pl:766
37266 " export LIBGUESTFS_DEBUG=1\n"
37267 " virt-win-reg --debug [... rest ...] > /tmp/virt-win-reg.log 2>&1\n"
37272 #: ../tools/virt-win-reg.pl:769
37274 "Attach /tmp/virt-win-reg.log to a new bug report at "
37275 "L<https://bugzilla.redhat.com/>"